(Swift 3,4,5...) PKCS11 Import a Private Key onto the HSM

See more PKCS11 Examples

Demonstrates how to import an existing RSA private key onto the smartcard/token. The imported key is a token object, meaning it stays on the HSM and exists beyond the end of the PKCS11 session.

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

Chilkat Downloads for the Swift Programming Language MAC OS X (Cocoa) Objective-C/Swift Libs iOS Objective-C/Swift Libs

func chilkatTest() {
    // 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
    var success: Bool = pkcs11.quickSession(userType, pin: pin)
    if success == false {
        print("\(pkcs11.lastErrorText!)")
        return
    }

    // Let's import a certificate's private key onto the HSM.
    // First, we'll load the certificate from a .pfx (also known as .p12), which is a file format
    // that also includes the certificate's private key.
    let cert = CkoCert()!
    success = cert.loadPfxFile("qa_data/pfx/ehealth.fgov.be_testing.p12", password: "p12_password")
    if success == false {
        print("\(cert.lastErrorText!)")
        return
    }

    // Let's get the certificate's private key.
    var privKey: CkoPrivateKey? = cert.exportPrivateKey()
    if cert.lastMethodSuccess == false {
        print("\(cert.lastErrorText!)")
        return
    }

    // Build a PKCS11 template to provide additional information about the key to be imported.
    let jsonTemplate = CkoJsonObject()!

    // Indicate that the key is to be stored on the token.  It is NOT a session object.
    jsonTemplate.updateBool("token", value: true)

    // Indicate that the key can be used for signing.
    jsonTemplate.updateBool("sign", value: true)

    // Provide an arbitrary ID and label (anything you want).
    // The information in the ID and/or label provides one means for finding the key in future PKCS11 sessions.
    jsonTemplate.update("id_hex", value: "010203040A0B0C0D0E0F")
    jsonTemplate.update("label", value: "ehealth private key")

    // Import the key.  The private key handle is returned on success.  Otherwise 0 is returned.
    // If our only task for now is to simply import the key, we can ignore the returned handle, 
    // other than to check for success/failure.  Otherwise, the handle can be used in other PKCS11 operations.
    // This example just creates the key and does not use the returned handle.
    var keyHandle: UInt32 = pkcs11.import(privKey, jsonTemplate: jsonTemplate)
    if keyHandle == 0 {
        print("\(pkcs11.lastErrorText!)")
    }
    else {
        print("key handle = \(keyHandle)")
        print("Successfully imported a private key onto the HSM.")
    }

    privKey = nil

    pkcs11.logout()
    pkcs11.closeSession()

}