Tcl

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

load ./chilkat.dll

set success 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.

set pkcs11 [new_CkPkcs11]

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

set success [CkPkcs11_Initialize $pkcs11]
if {$success == 0} then {
    puts [CkPkcs11_lastErrorText $pkcs11]
    delete_CkPkcs11 $pkcs11
    exit
}

# Pass -1 for the slotID to open a session on the first non-empty slot.
set slotID -1

# Open a session.
set readWrite 1
set success [CkPkcs11_OpenSession $pkcs11 $slotID $readWrite]
if {$success == 0} then {
    puts [CkPkcs11_lastErrorText $pkcs11]
    delete_CkPkcs11 $pkcs11
    exit
}

# 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".
set userType 1
set pin "0000"
set success [CkPkcs11_Login $pkcs11 $userType $pin]
if {$success == 0} then {
    puts [CkPkcs11_lastErrorText $pkcs11]
    set success [CkPkcs11_CloseSession $pkcs11]
    delete_CkPkcs11 $pkcs11
    exit
}

set cert [new_CkCert]

# Find a certificate by the Subject Common Name
set success [CkPkcs11_FindCert $pkcs11 "subjectCN" "BadSSL Client Certificate" $cert]
if {$success == 1} then {
    puts "Found: [CkCert_subjectCN $cert]"
} else {
    puts "Not found: [CkCert_subjectCN $cert]"
    set success [CkPkcs11_CloseSession $pkcs11]
    delete_CkPkcs11 $pkcs11
    delete_CkCert $cert
    exit
}

puts "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.

set http [new_CkHttp]

# Provide the client certificate (linked internally to our authenticated smartcard session)
set success [CkHttp_SetSslClientCert $http $cert]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    set success [CkPkcs11_CloseSession $pkcs11]
    delete_CkPkcs11 $pkcs11
    delete_CkCert $cert
    delete_CkHttp $http
    exit
}

set responseBody [CkHttp_quickGetStr $http "https://client.badssl.com/"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    set success [CkPkcs11_CloseSession $pkcs11]
    delete_CkPkcs11 $pkcs11
    delete_CkCert $cert
    delete_CkHttp $http
    exit
}

puts "Response status code: [CkHttp_get_LastStatus $http]"
puts "Response body: "
puts "$responseBody"

# ------------------------------------------------------------------------------------------------------------
# Revert to an unauthenticated session by calling Logout.
set success [CkPkcs11_Logout $pkcs11]
if {$success == 0} then {
    puts [CkPkcs11_lastErrorText $pkcs11]
    set success [CkPkcs11_CloseSession $pkcs11]
    delete_CkPkcs11 $pkcs11
    delete_CkCert $cert
    delete_CkHttp $http
    exit
}

# When finished, close the session.
# It is important to close the session (memory leaks will occur if the session is not properly closed).
set success [CkPkcs11_CloseSession $pkcs11]
if {$success == 0} then {
    puts [CkPkcs11_lastErrorText $pkcs11]
    delete_CkPkcs11 $pkcs11
    delete_CkCert $cert
    delete_CkHttp $http
    exit
}

puts "Success."

delete_CkPkcs11 $pkcs11
delete_CkCert $cert
delete_CkHttp $http