Ruby

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

require 'chilkat'

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 = Chilkat::CkPkcs11.new()

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

success = pkcs11.Initialize()
if (success == false)
    print pkcs11.lastErrorText() + "\n";
    exit
end

# 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 == false)
    print pkcs11.lastErrorText() + "\n";
    exit
end

# 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 == false)
    print pkcs11.lastErrorText() + "\n";
    success = pkcs11.CloseSession()
    exit
end

cert = Chilkat::CkCert.new()

# Find a certificate by the Subject Common Name
success = pkcs11.FindCert("subjectCN","BadSSL Client Certificate",cert)
if (success == true)
    print "Found: " + cert.subjectCN() + "\n";
else
    print "Not found: " + cert.subjectCN() + "\n";
    success = pkcs11.CloseSession()
    exit
end

print "Successfully loaded the cert object from the smart card / USB token." + "\n";

# 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 = Chilkat::CkHttp.new()

# Provide the client certificate (linked internally to our authenticated smartcard session)
success = http.SetSslClientCert(cert)
if (success == false)
    print http.lastErrorText() + "\n";
    success = pkcs11.CloseSession()
    exit
end

responseBody = http.quickGetStr("https://client.badssl.com/")
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    success = pkcs11.CloseSession()
    exit
end

print "Response status code: " + http.get_LastStatus().to_s() + "\n";
print "Response body: " + "\n";
print responseBody + "\n";

# ------------------------------------------------------------------------------------------------------------
# Revert to an unauthenticated session by calling Logout.
success = pkcs11.Logout()
if (success == false)
    print pkcs11.lastErrorText() + "\n";
    success = pkcs11.CloseSession()
    exit
end

# 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)
    print pkcs11.lastErrorText() + "\n";
    exit
end

print "Success." + "\n";