Lua

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

local chilkat = require("chilkat")

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

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

local success = pkcs11:initialize()
if not success then
    print(pkcs11.last_error_text)
    return
end

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

-- Open a session.
local readWrite = true
success = pkcs11:open_session(slotID, readWrite)
if not success then
    print(pkcs11.last_error_text)
    return
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".
local userType = 1
local pin = "0000"
success = pkcs11:login(userType, pin)
if not success then
    print(pkcs11.last_error_text)
    success = pkcs11:close_session()
    return
end

local cert = chilkat.Cert.new()

-- Find a certificate by the Subject Common Name
success = pkcs11:find_cert("subjectCN", "BadSSL Client Certificate", cert)
if success then
    print("Found: " .. cert.subject_cn)
else
    print("Not found: " .. cert.subject_cn)
    success = pkcs11:close_session()
    return
end

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

local http = chilkat.Http.new()

-- Provide the client certificate (linked internally to our authenticated smartcard session)
success = http:set_ssl_client_cert(cert)
if not success then
    print(http.last_error_text)
    success = pkcs11:close_session()
    return
end

local responseBody = http:quick_get_str("https://client.badssl.com/")
if not http.last_method_success then
    print(http.last_error_text)
    success = pkcs11:close_session()
    return
end

print("Response status code: " .. http.last_status)
print("Response body: ")
print(responseBody)

-- ------------------------------------------------------------------------------------------------------------
-- Revert to an unauthenticated session by calling Logout.
success = pkcs11:logout()
if not success then
    print(pkcs11.last_error_text)
    success = pkcs11:close_session()
    return
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:close_session()
if not success then
    print(pkcs11.last_error_text)
    return
end

print("Success.")