B4X

(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. B4X

Dim success As Boolean = 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.

Dim pkcs11 As ChilkatPkcs11
pkcs11.Initialize

'  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)
pkcs11.SharedLibPath = "C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll"

success = pkcs11.InitializeLibrary
If success = False Then
    Log(pkcs11.LastErrorText)
    Return
End If


'  Pass -1 for the slotID to open a session on the first non-empty slot.
Dim slotID As Int = -1

'  Open a session.
Dim readWrite As Boolean = True
success = pkcs11.OpenSession(slotID, readWrite)
If success = False Then
    Log(pkcs11.LastErrorText)
    Return
End If


'  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".
Dim userType As Int = 1
Dim pin As String = "0000"
success = pkcs11.Login(userType, pin)
If success = False Then
    Log(pkcs11.LastErrorText)
    success = pkcs11.CloseSession
    Return
End If


Dim cert As ChilkatCert
cert.Initialize("cert")

'  Find a certificate by the Subject Common Name
success = pkcs11.FindCert("subjectCN", "BadSSL Client Certificate", cert)
If success = True Then
    Log("Found: " & cert.SubjectCN)
Else
    Log("Not found: " & cert.SubjectCN)
    success = pkcs11.CloseSession
    Return
End If


Log("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.

Dim http As ChilkatHttp
http.Initialize("http")

'  Provide the client certificate (linked internally to our authenticated smartcard session)
success = http.SetSslClientCert(cert)
If success = False Then
    Log(http.LastErrorText)
    success = pkcs11.CloseSession
    Return
End If


Dim responseBody As String = http.QuickGetStr("https://client.badssl.com/")
If http.LastMethodSuccess = False Then
    Log(http.LastErrorText)
    success = pkcs11.CloseSession
    Return
End If


Log("Response status code: " & http.LastStatus)
Log("Response body: ")
Log(responseBody)

'  ------------------------------------------------------------------------------------------------------------
'  Revert to an unauthenticated session by calling Logout.
success = pkcs11.Logout
If success = False Then
    Log(pkcs11.LastErrorText)
    success = pkcs11.CloseSession
    Return
End If


'  When finished, close the session.
'  It is important to close the session (memory leaks will occur if the session is not properly closed).
success = pkcs11.CloseSession
If success = False Then
    Log(pkcs11.LastErrorText)
    Return
End If


Log("Success.")