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 a ZitiIdentity. A ZitiIdentity can be created by enrolling with using a one-time JWT. See Ziti.enroll(_:_:). The ZitiIdentity can also be configured as part of Ziti.init(fromFile:)and other Zitiinitializers.

    Ziti uses a loop to process events, similar toFoudation‘s Runloop (though implemented using libuv). Start Ziti processing via the Ziti.run(_:) method, which enters an infinate loop processing Ziti events until Ziti.shutdown() is called. Tthe Ziti.perform(_:) method supports scheduling work to be run on this thread and can be called safely from other threads.

    See

    See also:
    See more

    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(_:,_:)
    See more

    Declaration

    Swift

    public class ZitiClaims : NSObject, Codable
  • Create ZitiConnections from an instance of Ziti and use to commuicate with services over a Ziti network

    See more

    Declaration

    Swift

    @objc
    public class ZitiConnection : NSObject, ZitiUnretained
  • Class that enroll an identity with Ziti controller using a one-time JWT file

    See more

    Declaration

    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 more

    Declaration

    Swift

    @objc
    public class ZitiEvent : NSObject
  • Class representation of host.v1 service configuration

    See more

    Declaration

    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. A ZitiIdentity is created as part of Ziti.enroll(_:_:), and can be used to initialiaze on instance of Ziti.

    See more

    Declaration

    Swift

    @objc
    open class ZitiIdentity : NSObject, Codable
  • Class representation of intercept.v1 service configuration

    See more

    Declaration

    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 more

    Declaration

    Swift

    public class ZitiKeychain : NSObject
  • Logger class that mirrors the Ziti C SDK’s logging feature

    See more

    Declaration

    Swift

    public class ZitiLog
  • Class encapsulating Ziti SDK C’s MFA Auth Query

    See more

    Declaration

    Swift

    @objc
    public class ZitiMfaAuthQuery : NSObject, Codable
  • Class encapsulating Ziti SDK C’s response to an MFA enrollment request

    See more

    Declaration

    Swift

    @objc
    public class ZitiMfaEnrollment : NSObject, Codable
  • Used for passing context among callbacks and mapping to Ziti C SDK function

    Declaration

    Swift

    @objc
    public class ZitiPostureContext : NSObject
  • Ziti can be initialized with an instance of this class that implements various posture checks, used to determine if a Ziti identity is allowed access to specific services

    See more

    Declaration

    Swift

    @objc
    open class ZitiPostureChecks : NSObject
  • Class encapsulating Ziti SDK C’s posture query

    See more

    Declaration

    Swift

    @objc
    public class ZitiPostureQuery : NSObject, Codable
  • Class encapsulating Ziti SDK C’s posture query set

    See more

    Declaration

    Swift

    @objc
    public class ZitiPostureQuerySet : NSObject, Codable
  • Class encapsulating a Ziti SDK C service

    See more

    Declaration

    Swift

    @objc
    public class ZitiService : NSObject, Codable
  • Class providing a Swift wrapper for Ziti Tunnel SDK C

    See more

    Declaration

    Swift

    public class ZitiTunnel : NSObject, ZitiUnretained
  • Class representation of ziti-tunneler-client.v1 service configuration

    See more

    Declaration

    Swift

    public class ZitiTunnelClientConfigV1 : Codable, ZitiConfig
  • Class to encapsulate a Ziti Tunneler SDK event

    See more

    Declaration

    Swift

    @objc
    public class ZitiTunnelEvent : NSObject
  • Class encapsulating Ziti Tunnel SDK C Context Event

    See more

    Declaration

    Swift

    @objc
    public class ZitiTunnelContextEvent : ZitiTunnelEvent
  • Class encapsulating Ziti Tunnel SDK C MFA Event

    See more

    Declaration

    Swift

    @objc
    public class ZitiTunnelMfaEvent : ZitiTunnelEvent
  • Class encapsulating Ziti Tunnel SDK C Service Event

    See more

    Declaration

    Swift

    @objc
    public class ZitiTunnelServiceEvent : ZitiTunnelEvent
  • Class encapsulating Ziti Tunnel SDK C API Event

    See more

    Declaration

    Swift

    @objc
    public class ZitiTunnelApiEvent : ZitiTunnelEvent
  • Class representation of ziti-tunneler-server.v1 service configuration

    See more

    Declaration

    Swift

    public class ZitiTunnelServerConfigV1 : Codable, ZitiConfig
  • Class representation of ziti-url-client.v1 service configuration

    See more

    Declaration

    Swift

    public class ZitiUrlClientConfigV1 : Codable, ZitiConfig
  • URLProtocol that intercepts HTTP and HTTPS URL requests and routes them over the Ziti overlay as configured in your Ziti controller.

    ZitiUrlProtocol should be instantiated as part of the InitCallback of Ziti.run(_:_:) to ensure Ziti is initialized before starting to intercept services.

    See more

    Declaration

    Swift

    @objc
    public class ZitiUrlProtocol : URLProtocol, ZitiUnretained