PureBasic

(PKCS11) Use a Smart Card Certificate + Private Key for SSL/TLS Authentication

See more ScMinidriver Examples

Demonstrates how to use a certificate + private key located on a smart card for the TLS client certificate in an HTTPS request. PureBasic

IncludeFile "CkPkcs11.pb"
IncludeFile "CkCert.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

    success.i = 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.

    pkcs11.i = CkPkcs11::ckCreate()
    If pkcs11.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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)
    CkPkcs11::setCkSharedLibPath(pkcs11, "C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll")

    success = CkPkcs11::ckInitialize(pkcs11)
    If success = 0
        Debug CkPkcs11::ckLastErrorText(pkcs11)
        CkPkcs11::ckDispose(pkcs11)
        ProcedureReturn
    EndIf

    ; Pass -1 for the slotID to open a session on the first non-empty slot.
    slotID.i = -1

    ; Open a session.
    readWrite.i = 1
    success = CkPkcs11::ckOpenSession(pkcs11,slotID,readWrite)
    If success = 0
        Debug CkPkcs11::ckLastErrorText(pkcs11)
        CkPkcs11::ckDispose(pkcs11)
        ProcedureReturn
    EndIf

    ; 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".
    userType.i = 1
    pin.s = "0000"
    success = CkPkcs11::ckLogin(pkcs11,userType,pin)
    If success = 0
        Debug CkPkcs11::ckLastErrorText(pkcs11)
        success = CkPkcs11::ckCloseSession(pkcs11)
        CkPkcs11::ckDispose(pkcs11)
        ProcedureReturn
    EndIf

    cert.i = CkCert::ckCreate()
    If cert.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Find a certificate by the Subject Common Name
    success = CkPkcs11::ckFindCert(pkcs11,"subjectCN","BadSSL Client Certificate",cert)
    If success = 1
        Debug "Found: " + CkCert::ckSubjectCN(cert)
    Else
        Debug "Not found: " + CkCert::ckSubjectCN(cert)
        success = CkPkcs11::ckCloseSession(pkcs11)
        CkPkcs11::ckDispose(pkcs11)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    Debug "Successfully loaded the cert object from the smart card / USB token."

    ; Note: When successful, the cert object is internally linked to the Pkcs11 object's authenticated session.
    ; The cert object can now be used to sign or do other cryptographic operations that occur on the smart card / USB token.

    ; ------------------------------------------------------------------------------------------------------------

    ; Send an HTTPS request to https://client.badssl.com
    ; https://client.badssl.com (part of the badssl.com service) lets you test authentication using client SSL certificates. 
    ; The client certificate can be downloaded from https://badssl.com/download/.
    ; This server returns 200 OK if the correct client certificate is provided, and 400 Bad Request otherwise.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Provide the client certificate (linked internally to our authenticated smartcard session)
    success = CkHttp::ckSetSslClientCert(http,cert)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        success = CkPkcs11::ckCloseSession(pkcs11)
        CkPkcs11::ckDispose(pkcs11)
        CkCert::ckDispose(cert)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    responseBody.s = CkHttp::ckQuickGetStr(http,"https://client.badssl.com/")
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        success = CkPkcs11::ckCloseSession(pkcs11)
        CkPkcs11::ckDispose(pkcs11)
        CkCert::ckDispose(cert)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    Debug "Response status code: " + Str(CkHttp::ckLastStatus(http))
    Debug "Response body: "
    Debug responseBody

    ; ------------------------------------------------------------------------------------------------------------
    ; Revert to an unauthenticated session by calling Logout.
    success = CkPkcs11::ckLogout(pkcs11)
    If success = 0
        Debug CkPkcs11::ckLastErrorText(pkcs11)
        success = CkPkcs11::ckCloseSession(pkcs11)
        CkPkcs11::ckDispose(pkcs11)
        CkCert::ckDispose(cert)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    ; When finished, close the session.
    ; It is important to close the session (memory leaks will occur if the session is not properly closed).
    success = CkPkcs11::ckCloseSession(pkcs11)
    If success = 0
        Debug CkPkcs11::ckLastErrorText(pkcs11)
        CkPkcs11::ckDispose(pkcs11)
        CkCert::ckDispose(cert)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    Debug "Success."


    CkPkcs11::ckDispose(pkcs11)
    CkCert::ckDispose(cert)
    CkHttp::ckDispose(http)


    ProcedureReturn
EndProcedure