EMProvisioningConfiguration

Objective-C


@interface EMProvisioningConfiguration : NSObject

Swift

class EMProvisioningConfiguration : NSObject

The provisioning configuration

  • Wipes internal state of secure container objects.

    Declaration

    Objective-C

    - (void)wipe;

    Swift

    func wipe()
  • Creates EMProvisioningConfiguration. This instance is used for creation of clear text secret token import.

    Since

    4.0

    Declaration

    Objective-C

    + (EMProvisioningConfiguration *)
        clearTextSeedImportConfigurationWithPin:(id<EMPinAuthInput>)pin
                                         secret:(id<EMSecureByteArray>)secret
                             optionalParameters:
                                 (void (^)(
                                     EMClearTextSecretTokenConfigurationBuilder *))
                                     optionalParameters;

    Swift

    class func clearTextSeedImport(withPin pin: (any EMPinAuthInput)!, secret: (any EMSecureByteArray)!, optionalParameters: ((EMClearTextSecretTokenConfigurationBuilder?) -> Void)!) -> EMProvisioningConfiguration!

    Parameters

    pin

    The pin to be used for wrapping the secret. The value stored in this array will be wiped by the constructor if ‘wipePinAndSecret’ is set to ‘YES’.

    secret

    The clear text secret seed or key to be provisioned in the SDK. The value stored in this array will be wiped by the constructor if in optionalParameters'wipePinAndSecret’ is set to ‘YES’.

    optionalParameters

    Block where optional parameters set. See the EMClearTextSecretTokenConfigurationBuilder class for more details about the parameters and there optiona values.

    Return Value

    EMProvisioningConfiguration instance.

  • Creates EMProvisioningConfiguration. This instance to modify Eps configuration.

    Warning

    This API does not support Mobile Provisioning Protocol version 5
    • http(s)://<host>:<port>/EnrolmentServlet/GetAppCredentials for EPS 1.x

    • http(s)://<host>:<port>/provisioner/api/provisioning/pp for EPS 2.x

    Since

    4.0

    Declaration

    Objective-C

    + (EMProvisioningConfiguration *)
        epsConfigurationWithURL:(NSURL *)url
                       rsaKeyId:(NSString *)rsaKeyId
                    rsaExponent:(NSData *)rsaExponent
                     rsaModulus:(NSData *)rsaModulus
               registrationCode:(id<EMSecureString>)registrationCode
           provisioningProtocol:(EMMobileProvisioningProtocol)provisioningProtocol
             optionalParameters:
                 (void (^)(EMEpsConfigurationBuilder *))optionalParameters;

    Swift

    class func epsConfiguration(with url: URL!, rsaKeyId: String!, rsaExponent: Data!, rsaModulus: Data!, registrationCode: (any EMSecureString)!, provisioningProtocol: EMMobileProvisioningProtocol, optionalParameters: ((EMEpsConfigurationBuilder?) -> Void)!) -> EMProvisioningConfiguration!

    Parameters

    url

    The URL of the Enrollment API endpoint, e.g:

    rsaKeyId

    Identifier for the EPS server’s public RSA key.

    rsaExponent

    The RSA exponent of the EPS public key (on provisioning protocol level, not transport level).

    rsaModulus

    The RSA modulus of the EPS public key (on provisioning protocol level, not transport level).

    registrationCode

    The registration code. Minimum registration code length is 2, and maximum registration code length is 14.

    provisioningProtocol

    The provisioning protocol to use when decoding the credentials.

    optionalParameters

    Block where optional parameters set. See the EMEpsConfigurationBuilder class for more details about the parameters and there optional values.

    Return Value

    EMProvisioningConfiguration instance.

  • Creates EMProvisioningConfiguration. This instance to modify Eps configuration. Use this API for Mobile Provisioning Protocol version 5

    • http(s)://<host>:<port>/EnrolmentServlet/GetAppCredentials for EPS 1.x

    • http(s)://<host>:<port>/provisioner/api/provisioning/pp for EPS 2.x

    • http(s)://<host>:<port>/provisioner/domains/DomainName/provision for EPS 3.x with PPv5

    Since

    5.0

    Declaration

    Objective-C

    + (EMProvisioningConfiguration *)
        epsConfigurationWithURL:(NSURL *)url
                         domain:(NSString *)domain
                       rsaKeyId:(NSString *)rsaKeyId
                    rsaExponent:(NSData *)rsaExponent
                     rsaModulus:(NSData *)rsaModulus
               registrationCode:(id<EMSecureString>)registrationCode
           provisioningProtocol:(EMMobileProvisioningProtocol)provisioningProtocol
             optionalParameters:
                 (void (^)(EMEpsConfigurationBuilder *))optionalParameters;

    Swift

    class func epsConfiguration(with url: URL!, domain: String!, rsaKeyId: String!, rsaExponent: Data!, rsaModulus: Data!, registrationCode: (any EMSecureString)!, provisioningProtocol: EMMobileProvisioningProtocol, optionalParameters: ((EMEpsConfigurationBuilder?) -> Void)!) -> EMProvisioningConfiguration!

    Parameters

    url

    The URL of the Enrollment API endpoint, e.g:

    domain

    for EPS. This domain can only be use when EMMobileProvisioningProtocol set to EMMobileProvisioningProtocolVersion5 and above as well as when EPS that is being use is version 3 and above. Otherwise, this domain can be put nil or empty.

    rsaKeyId

    Identifier for the EPS server’s public RSA key.

    rsaExponent

    The RSA exponent of the EPS public key (on provisioning protocol level, not transport level).

    rsaModulus

    The RSA modulus of the EPS public key (on provisioning protocol level, not transport level).

    registrationCode

    The registration code. Minimum registration code length is 2, and maximum registration code length is 14.

    provisioningProtocol

    The provisioning protocol to use when decoding the credentials.

    optionalParameters

    Block where optional parameters set. See the EMEpsConfigurationBuilder class for more details about the parameters and there optional values.

    Return Value

    EMProvisioningConfiguration instance.

  • Creates EMProvisioningConfiguration. This configuration is used for DSKPP provisioning.

    Since

    4.1

    Declaration

    Objective-C

    + (EMProvisioningConfiguration *)
          dskppConfigurationWithUrl:(NSURL *)url
                                uid:(id<EMSecureString>)uid
                           password:(id<EMSecureString>)password
                      dskppCallback:(EMDskppProvisioningCallback *)dskppCallback
               provisioningProtocol:
                   (EMDskppProvisioningProtocol)provisioningProtocol
        shouldWipeUserIdAndPassword:(BOOL)shouldWipe
                 optionalParameters:
                     (void (^)(EMDskppConfigurationBuilder *))optionalParameters;

    Swift

    class func dskppConfiguration(with url: URL!, uid: (any EMSecureString)!, password: (any EMSecureString)!, dskppCallback: EMDskppProvisioningCallback!, provisioningProtocol: EMDskppProvisioningProtocol, shouldWipeUserIdAndPassword shouldWipe: Bool, optionalParameters: ((EMDskppConfigurationBuilder?) -> Void)!) -> EMProvisioningConfiguration!

    Parameters

    url

    The URL of the Enrollment API endpoint.

    uid

    User identifier for DSKPP provisioning.

    password

    Password for DSKPP provisioning.

    dskppCallback

    The callback to be called during stages of DKSPP provisioning. All the callbacks will be invoked in the main thread.

    provisioningProtocol

    The provisioning protocol to use when decoding the credentials.

    shouldWipe

    If YES, user identifier and password will be wiped upon completion.

    optionalParameters

    Block where optional parameters set. See the EMDskppConfigurationBuilder class for more details about the parameters and there optiona values.

    Return Value

    EMProvisioningConfiguration instance.

  • Creates EMProvisioningConfiguration. This configuration is used for DSKPP provisioning.

    Since

    4.1

    Declaration

    Objective-C

    + (EMProvisioningConfiguration *)
        dskppConfigurationWithBase64:(id<EMSecureString>)base64
                       dskppCallback:(EMDskppProvisioningCallback *)dskppCallback
                provisioningProtocol:
                    (EMDskppProvisioningProtocol)provisioningProtocol
                shouldWipeBase64Data:(BOOL)shouldWipe
                  optionalParameters:
                      (void (^)(EMDskppConfigurationBuilder *))optionalParameters;

    Swift

    class func dskppConfiguration(withBase64 base64: (any EMSecureString)!, dskppCallback: EMDskppProvisioningCallback!, provisioningProtocol: EMDskppProvisioningProtocol, shouldWipeBase64Data shouldWipe: Bool, optionalParameters: ((EMDskppConfigurationBuilder?) -> Void)!) -> EMProvisioningConfiguration!

    Parameters

    base64

    The base64 string for DKSPP provisioning. Contains url uid, and password.

    dskppCallback

    The callback to be called during stages of DKSPP provisioning. All the callbacks will be invoked in the main thread.

    provisioningProtocol

    The provisioning protocol to use when decoding the credentials.

    shouldWipe

    If YES, base64 string will be wiped upon completion.

    optionalParameters

    Block where optional parameters set. See the EMDskppConfigurationBuilder class for more details about the parameters and there optiona values.

    Return Value

    EMProvisioningConfiguration instance.