PowerBuilder

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.

PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Scmd
string ls_ReaderName
integer li_Retval
string ls_CertPart
string ls_PartValue
oleobject loo_Cert
oleobject loo_Http
string ls_ResponseBody

li_Success = 0

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

loo_Scmd = create oleobject
li_rc = loo_Scmd.ConnectToNewObject("Chilkat.ScMinidriver")
if li_rc < 0 then
    destroy loo_Scmd
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Reader names (smart card readers or USB tokens) can be discovered
// via List Readers or Find Smart Cards
ls_ReaderName = "SCM Microsystems Inc. SCR33x USB Smart Card Reader 0"
li_Success = loo_Scmd.AcquireContext(ls_ReaderName)
if li_Success = 0 then
    Write-Debug loo_Scmd.LastErrorText
    destroy loo_Scmd
    return
end if

// If successful, the name of the currently inserted smart card is available:
Write-Debug "Card name: " + loo_Scmd.CardName

// If desired, perform regular PIN authentication with the smartcard.
// For more details about smart card PIN authentication, see the Smart Card PIN Authentication Example
li_Retval = loo_Scmd.PinAuthenticate("user","000000")
if li_Retval <> 0 then
    Write-Debug "PIN Authentication failed."
end if

// 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
ls_CertPart = "subjectCN"
ls_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
loo_Cert = create oleobject
li_rc = loo_Cert.ConnectToNewObject("Chilkat.Cert")

li_Success = loo_Scmd.FindCert(ls_CertPart,ls_PartValue,loo_Cert)
if li_Success = 0 then
    Write-Debug "Failed to find the certificate."
    loo_Scmd.DeleteContext()
    destroy loo_Scmd
    destroy loo_Cert
    return
end if

Write-Debug "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.

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")

// Provide the client certificate (linked internally to our authenticated smartcard session)
li_Success = loo_Http.SetSslClientCert(loo_Cert)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    loo_Scmd.DeleteContext()
    destroy loo_Scmd
    destroy loo_Cert
    destroy loo_Http
    return
end if

ls_ResponseBody = loo_Http.QuickGetStr("https://client.badssl.com/")
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    loo_Scmd.DeleteContext()
    destroy loo_Scmd
    destroy loo_Cert
    destroy loo_Http
    return
end if

Write-Debug "Response status code: " + string(loo_Http.LastStatus)
Write-Debug "Response body: "
Write-Debug ls_ResponseBody

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

// When finished with operations that required authentication, you may if you wish, deauthenticate the session.
li_Success = loo_Scmd.PinDeauthenticate("user")
if li_Success = 0 then
    Write-Debug loo_Scmd.LastErrorText
end if

// Delete the context when finished with the card.
li_Success = loo_Scmd.DeleteContext()
if li_Success = 0 then
    Write-Debug loo_Scmd.LastErrorText
end if



destroy loo_Scmd
destroy loo_Cert
destroy loo_Http