Swift

PKCS11 Import an Existing AES Key onto the HSM

See more PKCS11 Examples

Demonstrates how to import an existing AES symmetric encrytion key onto the smartcard/token. The imported AES key is a session object, and only exists for the duration of the PKCS11 session. (AES keys are typically used for wrapping/unwrapping RSA and EC keys.)

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
    }

    // Generate a 256-bit AES key.
    // (32 bytes is 256 bits)
    // Append 32 bytes of random data in the base64 encoding.
    let sbAesKey = CkoStringBuilder()!
    sbAesKey.appendRandom(numBytes: 32, encoding: "base64")

    let attrs = CkoJsonObject()!
    // Specify the type of object, and the type of key.
    attrs.updateString(jsonPath: "class", value: "CKO_SECRET_KEY")
    attrs.updateString(jsonPath: "key_type", value: "CKK_AES")
    // Add an optional label if desired.
    attrs.updateString(jsonPath: "label", value: "My AES wrapping/unwrapping key")
    // Allow the key to be use for wrapping and unwrapping operations.
    attrs.updateBool(jsonPath: "wrap", value: true)
    attrs.updateBool(jsonPath: "unwrap", value: true)

    // Provide the AES key material.
    attrs.updateString(jsonPath: "value", value: sbAesKey.getAsString())

    // Create the object (i.e. create the AES key with the given key material.)
    // Returns the PKCS11 object handle of the created AES session key.
    var objHandle: UInt32 = pkcs11.createObject(attrs: attrs)
    if objHandle == 0 {
        print("\(pkcs11.lastErrorText!)")
        print("Failed.")
    }
    else {
        print("PKCS11 object handle = \(objHandle)")
        print("Successfully created a 256-bit AES session key.")
    }

    // Typically, you would do other things in the PKCS11 session that use the handle of AES key we just created.
    // ...
    // ...

    pkcs11.logout()
    pkcs11.closeSession()

}