Returns the index of the PIN inside the card.

Returns the associated token.

Returns the PIN 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.

Returns the number of maximum tries for the PIN verification.

Returns a bit field indicating availability of each PUK, with the LSB for 1st PUK. A bit at 1 indicates that the corresponding PUK is still available.

Returns a CredentialState object with the current token infos for the requestCredential(properties:state:environment:completionHandler:) function.

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

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

The returned Dictionary has the following structure:

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

• methods: a Dictionary with the following attributes:

  • facialBio: true if the PIN supports the facial biometry process, false otherwise.

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(properties:state:environment:completionHandler:) function.

Example:

// getting first the `credential` object by using requestCredential function
pin.login(value: credential, state: state) { 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
}

Displays a standalone PIN dialog that allows the user to enter the PIN value or use biometry process, in order to get the necessary credential for a login(value:state:completionHandler:) process.

Example:

let NO_CRITICAL_ERRORS: [SCMError] = [
    .CKR_PIN_INVALID,
    .CKR_PIN_INCORRECT,
    .CKR_PIN_LEN_RANGE
]

var properties: [String: Any]
var state     = CredentialState()

func loginLoop() {
    // assuming `environment` object is correctly defined
    Pin.requestCredential(properties: properties, state: state, environment: environment) { credential, error in
        if let credential = credential {
            // assuming a `pin` object has been retrieved from a token
            pin.login(value: credential, state: state) { loginError in
                if loginError != nil {
                    print("failed to login")
                    // on no fatal errors, retry requesting credential/login process
                    if let scmError = loginError?.scmError {
                        if NO_CRITICAL_ERRORS.contains(scmError) {
                            loginLoop()
                            return
                        }
                    }
                }
                else {
                    print("login is successful")
                }
            }
        }
        else {
            print("failed to request credential")
        }
    })
}

// Use case 1: no token has been previously read
properties = [
    "pinLabel": "My PIN label",
    "methods": [
        "facialBio": false
    ]
]
state      = CredentialState()

loginLoop()



// Use case 2: a token has been previously read and a `pin` object is defined
properties = pin.getCredentialProperties()
state      = pin.initCredentialState()

loginLoop()