Tcl

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.

Note: This example only works on Windows. ScMinidriver is a Windows-specific smart card and USB token minidriver that enables smart card authentication and cryptographic operations within Windows operating systems.

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.

set scmd [new_CkScMinidriver]

# Reader names (smart card readers or USB tokens) can be discovered
# via List Readers or Find Smart Cards
set readerName "SCM Microsystems Inc. SCR33x USB Smart Card Reader 0"
set success [CkScMinidriver_AcquireContext $scmd $readerName]
if {$success == 0} then {
    puts [CkScMinidriver_lastErrorText $scmd]
    delete_CkScMinidriver $scmd
    exit
}

# If successful, the name of the currently inserted smart card is available:
puts "Card name: [CkScMinidriver_cardName $scmd]"

# If desired, perform regular PIN authentication with the smartcard.
# For more details about smart card PIN authentication, see the Smart Card PIN Authentication Example
set retval [CkScMinidriver_PinAuthenticate $scmd "user" "000000"]
if {$retval != 0} then {
    puts "PIN Authentication failed."
}

# You can find a cerficate using any of the following certificate parts:
# "subjectDN" -- The full distinguished name of the cert.
# "subjectDN_withTags" -- Same as above, but in a format that includes the subject part tags, such as the "CN=" in "CN=something"
# "subjectCN" -- The common name part (CN) of the certificate's subject.
# "serial" -- The certificate serial number.
# "serial:issuerCN" -- The certificate serial number + the issuer's common name, delimited with a colon char.
# These are the same certificate parts that can be retrieved by listing certificates on the smart card (or USB token).
# See List Certificates on Smart Card Example
set certPart "subjectCN"
set partValue "BadSSL Client Certificate"

# If the certificate is found, it is loaded into the cert object.
# Note: We imported this certificate from a .p12/.pfx using this Example to Import a .pfx/.p12 onto a Smart Card
set cert [new_CkCert]

set success [CkScMinidriver_FindCert $scmd $certPart $partValue $cert]
if {$success == 0} then {
    puts "Failed to find the certificate."
    CkScMinidriver_DeleteContext $scmd
    delete_CkScMinidriver $scmd
    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 ScMinidriver 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.
# If your application calls PinDeauthenticate or DeleteContext, the cert will no longer be able to sign on the smart card
# because the smart card ScMinidriver session will no longer be authenticated or deleted.

# ------------------------------------------------------------------------------------------------------------

# 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]
    CkScMinidriver_DeleteContext $scmd
    delete_CkScMinidriver $scmd
    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]
    CkScMinidriver_DeleteContext $scmd
    delete_CkScMinidriver $scmd
    delete_CkCert $cert
    delete_CkHttp $http
    exit
}

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

# ------------------------------------------------------------------------------------------------------------
# Cleanup our ScMinidriver session...

# When finished with operations that required authentication, you may if you wish, deauthenticate the session.
set success [CkScMinidriver_PinDeauthenticate $scmd "user"]
if {$success == 0} then {
    puts [CkScMinidriver_lastErrorText $scmd]
}

# Delete the context when finished with the card.
set success [CkScMinidriver_DeleteContext $scmd]
if {$success == 0} then {
    puts [CkScMinidriver_lastErrorText $scmd]
}


delete_CkScMinidriver $scmd
delete_CkCert $cert
delete_CkHttp $http