Returns the index of the PIN inside the card.

Returns the associated token.

Gets the PIN label. Can be undefined if the card has a single PIN without explicit defined label.

Returns if the PIN is initialized and ready to be used.

Returns if the PIN needs to be changed before use.

Returns if the PIN is blocked.

Returns if the PIN try counter is lower than the maximum (an unsuccessful verification attempt has been made).

Returns if the PIN try counter shows only one remaining attempt.

Returns if the PIN has been successfully verified (access to the private objects is granted).

Returns the number of remaining tries for the PIN verification. Can be undefined if the information is unavailable.

Returns a CredentialState object with the current token infos for the requestCredential(pinProperties:state:readerName:cardLabel:env:completionHandler:) function.

Returns a NSDictionary which contains the credential properties for this PIN slot.

The returned object is used in the requestCredential(pinProperties:state:readerName:cardLabel:env:completionHandler:) function in order to provide information that will be displayed in the PIN dialog.

The returned NSDictionary has the following structure:

• pinLabel: a String that represents the PIN label, can be obtained by using getLabel() function.

• methods: a NSDictionary with the following attributes:

  • facialBio: true if the PIN supports the facial biometry process.
  • fingerBio: true if the PIN supports the fingerprint biometry process.

Verifies the PIN.

Example:

pin.login(value: "****") { error in
    if let error = error {
        print("login failed: " + error.localizedDescription)
    }
    else {
        // if login is succesfull you can get private key objects for instance
        token.getObjects(){ objects, error in
            if let error = error {
                print("error reason: " + error.localizedDescription)
            }
            else {
                // now `objects` contains also private keys
            }
        }
}

Verifies the PIN after getting CredentialValue object by using requestCredential(pinProperties:state:readerName:cardLabel:env:completionHandler:) function.

Example:

// getting first the `credential` object by using requestCredential function
pin.login(credential.?getValue()) { error in
    if let error = error{
        print("login failed: " + error.localizedDescription)
    }
    else {
        // if login is succesfull you can get private key objects for instance
        token.getObjects(){ objects, error in
            if let error = error {
                print("error reason: " + error.localizedDescription)
            }
            else {
                // now `objects` contains also private keys
            }
        }
}

Reinitializes the PIN value (eventually unblocking it, if required). The operation can only be made against the user PIN, and requires the security officer PIN to be verified with loginSo(value:completionHandler:).

Example:

pinSO.loginSo(value: "********") { error in
    if let error = error {
        print("fail to login: " + error.localizedDescription)
    }
    else {
        pinUser.initPin("****") { error in
            if let error = error {
                print("fail to init pin : " + error.localizedDescription)
            }
            else {
                print("sucessfully init pin")
            }
        }
    }
}

Verifies the security officer (administrator or unblocking) PIN.

Example:

pinSO.loginSo(value: "********") { error in
    if let error = error {
        print("fail to login on SO user" + error.localizedDescription)
    }
    else {
        pinUser.initPin("****"){ error in
            if let error = error {
                print("fai to init pin : " + error.localizedDescription)
            }
            else {
                print("sucessfully init pin");
            }
        }
    }
}

Changes the PIN value. The operation can only be made against the user PIN.

Resets the verified status of the PIN.

Gets the format constraints of the PIN as an Array of PinConstraint.

Example :

func checkPinMinLength(pin:Pin, pinValue: String) -> Bool {
    var isPinOk = false
    // make the call synchronous
    let group = DispatchGroup()
    group.enter()
    DispatchQueue.global(qos: .background).async {
        pin.getConstraints { constraints, error in
            if let constraints = constraints {
                for constraint in constraints {
                    // check if `pinValue` verifies this `constraint`
                }
            }
            else {
                print("fail to get constraints: " + error!.localizedDescription)
            }
        }
    }
    group.wait()
    return isPinOk
}

Opens a PIN dialog webview in order to enter PIN value or use facial biometry. It is then possible to perform a login operation with returned (encrypted) credential value.

Example:

let readerName: String = "..."; // or "null" to not display this information.
let cardLabel: String = "...";  // or "null" to not diplay this information.

let pinProperties: NSDictionary = ["pinLabel": "...",
    "methods": ["facialBio": false, "fingerBio": false]];

let state: CredentialState = CredentialState();

Pin.requestCredential(pinProperties: pinProperties, state: state, readerName: readerName, cardLabel: cardLabel,
    completionHandler: { credValue, error in
    pin.login(credential) {
        //...
    }
});