Xbase++

PKCS11 Find Private Key by Label

See more PKCS11 Examples

Demonstrates how to find a private key based on a user-specified label.

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

Xbase++

LOCAL nSuccess
LOCAL oPkcs11
LOCAL cPin
LOCAL nUserType
LOCAL oJsonTemplate
LOCAL nPrivKeyHandle

nSuccess := 0

//  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.

oPkcs11 := CreateObject("Chilkat.Pkcs11")

//  Use the PKCS11 driver (.dll, .so, .dylib) for your particular HSM.
//  For example:
oPkcs11:SharedLibPath := "C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS11.dll"

//  Use your HSM's PIN.
cPin := "0000"

//  Normal user = 1
nUserType := 1

//  Establish a logged-on user session with the HSM.
nSuccess := oPkcs11:QuickSession(nUserType, cPin)
IF (nSuccess == 0)
    ? oPkcs11:LastErrorText
    oPkcs11:destroy()
    RETURN
ENDIF

//  Provide a template to find a PKCS11 object.
oJsonTemplate := CreateObject("Chilkat.JsonObject")

//  Find an RSA private key with the label "MySshKey".
//  Here's an example of how the key was originally imported: 
//  PKCS11 Import SSH Key
oJsonTemplate:UpdateString("class", "private_key")
oJsonTemplate:UpdateString("key_type", "rsa")
oJsonTemplate:UpdateString("label", "MySshKey")

nPrivKeyHandle := oPkcs11:FindObject(oJsonTemplate)
IF (nPrivKeyHandle == 0)
    ? oPkcs11:LastErrorText
    oPkcs11:destroy()
    oJsonTemplate:destroy()
    RETURN
ENDIF

//  The private key handle is only valid during the PKCS11 session.
//  If you wish to use the private key in another PKCS11 session,
//  you'll first need to find it.  See:  
? "private key handle: " + Str(nPrivKeyHandle)

//  Do whatever you wish with the private key handle...
//  ...
//  ...

oPkcs11:Logout()
oPkcs11:CloseSession()

oPkcs11:destroy()
oJsonTemplate:destroy()