Lua

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.

Lua

local chilkat = require("chilkat")

-- This example requires the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.

local scmd = chilkat.ScMinidriver.new()

-- Reader names (smart card readers or USB tokens) can be discovered
-- via List Readers or Find Smart Cards
local readerName = "SCM Microsystems Inc. SCR33x USB Smart Card Reader 0"
local success = scmd:acquire_context(readerName)
if not success then
    print(scmd.last_error_text)
    return
end

-- If successful, the name of the currently inserted smart card is available:
print("Card name: " .. scmd.card_name)

-- If desired, perform regular PIN authentication with the smartcard.
-- For more details about smart card PIN authentication, see the Smart Card PIN Authentication Example
local retval = scmd:pin_authenticate("user", "000000")
if retval ~= 0 then
    print("PIN Authentication failed.")
end

-- 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
local certPart = "subjectCN"
local 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
local cert = chilkat.Cert.new()
success = scmd:find_cert(certPart, partValue, cert)
if not success then
    print("Failed to find the certificate.")
    scmd:delete_context()
    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 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.

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)
    scmd:delete_context()
    return
end

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

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

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

-- When finished with operations that required authentication, you may if you wish, deauthenticate the session.
success = scmd:pin_deauthenticate("user")
if not success then
    print(scmd.last_error_text)
end

-- Delete the context when finished with the card.
success = scmd:delete_context()
if not success then
    print(scmd.last_error_text)
end