DataFlex

PKCS11 Find Specific Certificate on Smart Card or USB Token

See more PKCS11 Examples

This example code shows how to find a particular certificate on a smart card or USB token.

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

DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoPkcs11
    Integer iSlotID
    Boolean iReadWrite
    Integer iUserType
    String sPin
    Variant vCert
    Handle hoCert
    String sTemp1

    Move False To iSuccess

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

    Get Create (RefClass(cComChilkatPkcs11)) To hoPkcs11
    If (Not(IsComObjectCreated(hoPkcs11))) Begin
        Send CreateComObject of hoPkcs11
    End

    // Set your shared lib path -- either a full path to the DLL, .so, or .dylib,
    // or just the filename if the driver is in a location that can be automatically found. (Such as in C:\Windows\System32)
    Set ComSharedLibPath Of hoPkcs11 To "C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll"

    Get ComInitialize Of hoPkcs11 To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoPkcs11 To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Pass -1 for the slotID to open a session on the first non-empty slot.
    Move -1 To iSlotID

    // Open a session.
    Move True To iReadWrite
    Get ComOpenSession Of hoPkcs11 iSlotID iReadWrite To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoPkcs11 To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Make it an authenticated session by calling Login.
    // 
    // If we don't authenticate, then we won't be able to see the private keys, and thus
    // we won't know which certificates have an associated private key stored on the smart card.

    // The smart card PIN is passed to the Login method.
    // userType 1 indicates a "Normal User".
    Move 1 To iUserType
    Move "0000" To sPin
    Get ComLogin Of hoPkcs11 iUserType sPin To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoPkcs11 To sTemp1
        Showln sTemp1
        Get ComCloseSession Of hoPkcs11 To iSuccess
        Procedure_Return
    End

    // --------------------------------------------------------------------------
    // The FindCert method can find a particular certificate in a number of different ways.
    // I'll demonstrate some common ways..

    // 1) In many cases you'll be working with a smart card that contains one certificate that is to be used for 
    // signing, and it is the certificate that is associated with the private key also stored on the smart card (or USB token).
    // There may be other certificates on the card, but these are the issuer certificates in the chain of authentication.
    // You're just interested in getting the certificate with the private key.
    // You can do it like this:
    Get Create (RefClass(cComChilkatCert)) To hoCert
    If (Not(IsComObjectCreated(hoCert))) Begin
        Send CreateComObject of hoCert
    End
    // Pass the keyword "privateKey" in the 1st argument, and an empty string in the 2nd arg.
    // This returns the 1st certificate that has a private key.
    Get pvComObject of hoCert to vCert
    Get ComFindCert Of hoPkcs11 "privateKey" "" vCert To iSuccess
    If (iSuccess = True) Begin
        Get ComSubjectCN Of hoCert To sTemp1
        Showln "Cert with private key: " sTemp1
    End
    Else Begin
        Showln "No certificates having a private key were found."
    End

    // 2) Find a certificate by the Subject Common Name
    Get pvComObject of hoCert to vCert
    Get ComFindCert Of hoPkcs11 "subjectCN" "Chil application account (8c9be8e0-5544-4cd0-9062-290fbff353a7)" vCert To iSuccess
    If (iSuccess = True) Begin
        Get ComSubjectCN Of hoCert To sTemp1
        Showln "Found: " sTemp1
    End
    Else Begin
        Get ComSubjectCN Of hoCert To sTemp1
        Showln "Not found: " sTemp1
    End

    // 3) Find a certificate by hex serial number
    Get pvComObject of hoCert to vCert
    Get ComFindCert Of hoPkcs11 "serial" "5087bf1feda006af54a02f23a851104948acc26f" vCert To iSuccess
    If (iSuccess = True) Begin
        Get ComSerialNumber Of hoCert To sTemp1
        Showln "Found: " sTemp1
    End
    Else Begin
        Get ComSerialNumber Of hoCert To sTemp1
        Showln "Not found: " sTemp1
    End

    // 4) Find a certificate by hex serial number and Issuer Common Name
    Get pvComObject of hoCert to vCert
    Get ComFindCert Of hoPkcs11 "serial:issuerCN" "5087bf1feda006af54a02f23a851104948acc26f:Ibanity Production Third Party Application CA" vCert To iSuccess
    If (iSuccess = True) Begin
        Get ComSubjectCN Of hoCert To sTemp1
        Showln "Found: " sTemp1
    End
    Else Begin
        Get ComSubjectCN Of hoCert To sTemp1
        Showln "Not found: " sTemp1
    End

    // --------------------------------------------------------------------------

    // Revert to an unauthenticated session by calling Logout.
    Get ComLogout Of hoPkcs11 To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoPkcs11 To sTemp1
        Showln sTemp1
        Get ComCloseSession Of hoPkcs11 To iSuccess
        Procedure_Return
    End

    // When finished, close the session.
    // It is important to close the session (memory leaks will occur if the session is not properly closed).
    Get ComCloseSession Of hoPkcs11 To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoPkcs11 To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Showln "Success."


End_Procedure