Classes
The following classes are available globally.
-
This is the main entry point for interacting with Ziti, and provides a Swift-friendly way to access the Ziti C SDK
Configure
Ziti
with aZitiIdentity
. AZitiIdentity
can be created by enrolling with using a one-time JWT. SeeZiti.enroll(_:_:)
. TheZitiIdentity
can also be configured as part ofZiti.init(fromFile:)
and otherZiti
initializers.Ziti
uses a loop to process events, similar toFoudation
‘sRunloop
(though implemented usinglibuv
). StartZiti
processing via theZiti.run(_:)
method, which enters an infinate loop processingZiti
events untilZiti.shutdown()
is called. TtheZiti.perform(_:)
method supports scheduling work to be run on this thread and can be called safely from other threads.See
See also:ZitiIdentity
required to configure Ziti accessZiti.enroll(_:_:)
create aZitiIdentity
by enrolling using a one-time JWTZiti.init(fromFile:)
create aZitiIdentity
by loading from a JSON file.ZitiConnection
for accessing or providing Ziti servicesZitiUrlProtocol
for registering aURLProtocol
for intercepting HTTP and HTTPS calls make using theURLSession
framework and routing them over aZiti
network.
Declaration
Swift
@objc public class Ziti : NSObject, ZitiUnretained
-
Class that encapsulate the claims of a Ziti one-time JWT file.
Claims are verified as part of the enrollment process.
See
See also:Ziti.enroll(_:,_:)
Declaration
Swift
public class ZitiClaims : NSObject, Codable
-
Class that enroll an identity with Ziti controller using a one-time JWT file
See moreDeclaration
Swift
@objc public class ZitiEnroller : NSObject, ZitiUnretained
-
Class used for passing information about error conditions encountered while using Ziti
Declaration
Swift
public class ZitiError : NSError
-
Class encapsulating Swft representations of Ziti SDK C events
See moreDeclaration
Swift
@objc public class ZitiEvent : NSObject
-
Class representation of host.v1 service configuration
See moreDeclaration
Swift
public class ZitiHostConfigV1 : Codable, ZitiConfig
-
Identity information for interacting with Ziti
Objects of these types are
Codable
so can easiliy be converted to/from JSON and stored on disk. AZitiIdentity
is created as part ofZiti.enroll(_:_:)
, and can be used to initialiaze on instance ofZiti
.See
See Also:Declaration
Swift
@objc open class ZitiIdentity : NSObject, Codable
-
Class representation of intercept.v1 service configuration
See moreDeclaration
Swift
public class ZitiInterceptConfigV1 : Codable, ZitiConfig
-
This class manages access to the Keychain, creating and storing keys and certificates needed to access a Ziti network.
This is primarily an internally used class, though certain methods are marked public in order to support senarios where the enrollment is provided by an application other than the one that needs to access Ziti using this identity (which will require the end user to provide their credentials to configure the keychain to allow the application access to the keys and certificates).
See moreDeclaration
Swift
public class ZitiKeychain : NSObject
-
Logger class that mirrors the Ziti C SDK’s logging feature
See moreDeclaration
Swift
public class ZitiLog
-
Class encapsulating Ziti SDK C’s MFA Auth Query
See moreDeclaration
Swift
@objc public class ZitiMfaAuthQuery : NSObject, Codable
-
Class encapsulating Ziti SDK C’s response to an MFA enrollment request
See moreDeclaration
Swift
@objc public class ZitiMfaEnrollment : NSObject, Codable
-
Used for passing context among callbacks and mapping to
Ziti
C SDK functionDeclaration
Swift
@objc public class ZitiPostureContext : NSObject
-
Class encapsulating Ziti SDK C’s posture query
See moreDeclaration
Swift
@objc public class ZitiPostureQuery : NSObject, Codable
-
Class encapsulating Ziti SDK C’s posture query set
See moreDeclaration
Swift
@objc public class ZitiPostureQuerySet : NSObject, Codable
-
Class encapsulating a Ziti SDK C service
See moreDeclaration
Swift
@objc public class ZitiService : NSObject, Codable
-
Class providing a Swift wrapper for Ziti Tunnel SDK C
See moreDeclaration
Swift
public class ZitiTunnel : NSObject, ZitiUnretained
-
Class representation of ziti-tunneler-client.v1 service configuration
See moreDeclaration
Swift
public class ZitiTunnelClientConfigV1 : Codable, ZitiConfig
-
Class to encapsulate a Ziti Tunneler SDK event
See moreDeclaration
Swift
@objc public class ZitiTunnelEvent : NSObject
-
Class encapsulating Ziti Tunnel SDK C Context Event
See moreDeclaration
Swift
@objc public class ZitiTunnelContextEvent : ZitiTunnelEvent
-
Class encapsulating Ziti Tunnel SDK C MFA Event
See moreDeclaration
Swift
@objc public class ZitiTunnelMfaEvent : ZitiTunnelEvent
-
Class encapsulating Ziti Tunnel SDK C Service Event
See moreDeclaration
Swift
@objc public class ZitiTunnelServiceEvent : ZitiTunnelEvent
-
Class encapsulating Ziti Tunnel SDK C API Event
See moreDeclaration
Swift
@objc public class ZitiTunnelApiEvent : ZitiTunnelEvent
-
Class representation of ziti-tunneler-server.v1 service configuration
See moreDeclaration
Swift
public class ZitiTunnelServerConfigV1 : Codable, ZitiConfig
-
Class representation of ziti-url-client.v1 service configuration
See moreDeclaration
Swift
public class ZitiUrlClientConfigV1 : Codable, ZitiConfig
-
URLProtocol
that interceptsHTTP
andHTTPS
URL requests and routes them over the Ziti overlay as configured in your Ziti controller.
See moreZitiUrlProtocol
should be instantiated as part of theInitCallback
ofZiti.run(_:_:)
to ensure Ziti is initialized before starting to intercept services.Declaration
Swift
@objc public class ZitiUrlProtocol : URLProtocol, ZitiUnretained