Swift

PKCS11 Generate Secret Key (such as AES)

See more PKCS11 Examples

Generates a symmetric secret key such as AES on the HSM.

Note: This example requires Chilkat v9.5.0.96 or later.

Swift

func chilkatTest() {
    var success: Bool = false

    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    // Note: Chilkat's PKCS11 implementation runs on Windows, Linux, Mac OS X, and other supported operating systems.

    let pkcs11 = CkoPkcs11()!

    // Use the PKCS11 driver (.dll, .so, .dylib) for your particular HSM.
    // (The format of the path will change with the operating system.  Obviously, "C:/" is not used on non-Windows systems.
    pkcs11.sharedLibPath = "C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll"

    // Establish a logged-on session.
    var pin: String? = "0000"
    var userType: Int = 1
    success = pkcs11.quickSession(userType: userType, pin: pin)
    if success == false {
        print("\(pkcs11.lastErrorText!)")
        return
    }

    // Let's generate a 256-bit AES key on the token, which will exist for the duration of this session.
    // Symmetric keys, such as AES keys, are typically created (or imported) and used during a single session.

    // Other possible values for keyType are "AES XTS", "Blowfish", "Twofish", "ChaCha20", and others. 
    // In virtually all cases, you'll want to create an AES key.
    var keyType: String? = "AES"

    // Specify attributes and abilities (how this key can be used) by providing a JSON template.
    let json = CkoJsonObject()!

    // The key can be extracted or wrapped.
    json.updateBool(jsonPath: "extractable", value: true)

    // Allow the key to be used for encryption, decryption, wrapping other keys, and unwrapping other keys.
    json.updateBool(jsonPath: "encrypt", value: true)
    json.updateBool(jsonPath: "decrypt", value: true)
    json.updateBool(jsonPath: "wrap", value: true)
    json.updateBool(jsonPath: "unwrap", value: true)

    // Indicate a 256-bit AES key is to be generated by setting the value_len attribute equal to the key size in bytes.
    // (32 bytes * 8 bits/byte = 256 bits)
    json.updateInt(jsonPath: "value_len", value: 32)

    var keyHandle: UInt32 = pkcs11.genSecretKey(keyType: keyType, jsonTemplate: json)
    if keyHandle == 0 {
        print("\(pkcs11.lastErrorText!)")
        print("Failed to generate an AES key.")
    }
    else {
        print("key handle = \(keyHandle)")
        print("Success.")
    }

    pkcs11.logout()
    pkcs11.closeSession()

}