PowerShell

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

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

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

$pkcs11 = New-Object Chilkat.Pkcs11

# 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.Initialize()
if ($success -eq $false) {
    $($pkcs11.LastErrorText)
    exit
}

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

# Open a session.
$readWrite = $true
$success = $pkcs11.OpenSession($slotID,$readWrite)
if ($success -eq $false) {
    $($pkcs11.LastErrorText)
    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".
$userType = 1
$pin = "0000"
$success = $pkcs11.Login($userType,$pin)
if ($success -eq $false) {
    $($pkcs11.LastErrorText)
    $success = $pkcs11.CloseSession()
    exit
}

$cert = New-Object Chilkat.Cert

# Find a certificate by the Subject Common Name
$success = $pkcs11.FindCert("subjectCN","BadSSL Client Certificate",$cert)
if ($success -eq $true) {
    $("Found: " + $cert.SubjectCN)
}
else {
    $("Not found: " + $cert.SubjectCN)
    $success = $pkcs11.CloseSession()
    exit
}

$("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 = New-Object Chilkat.Http

# Provide the client certificate (linked internally to our authenticated smartcard session)
$success = $http.SetSslClientCert($cert)
if ($success -eq $false) {
    $($http.LastErrorText)
    $success = $pkcs11.CloseSession()
    exit
}

$responseBody = $http.QuickGetStr("https://client.badssl.com/")
if ($http.LastMethodSuccess -eq $false) {
    $($http.LastErrorText)
    $success = $pkcs11.CloseSession()
    exit
}

$("Response status code: " + $http.LastStatus)
$("Response body: ")
$($responseBody)

# ------------------------------------------------------------------------------------------------------------
# Revert to an unauthenticated session by calling Logout.
$success = $pkcs11.Logout()
if ($success -eq $false) {
    $($pkcs11.LastErrorText)
    $success = $pkcs11.CloseSession()
    exit
}

# 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 -eq $false) {
    $($pkcs11.LastErrorText)
    exit
}

$("Success.")