(PureBasic) Client Certificate in REST (USB Token or Smartcard)

See more REST Examples

Demonstrates how to use a client certificate with a REST connection where the certificate and private key are located on a USB token or smart card.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkSocket.pb"
IncludeFile "CkCert.pb"
IncludeFile "CkRest.pb"

Procedure ChilkatExample()

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

    ; This example shows how to use the Chilkat socket object's connection.
    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    socket.i = CkSocket::ckCreate()
    If socket.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Set the certificate to be used for mutual TLS authentication
    cert.i = CkCert::ckCreate()
    If cert.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; If the smartcard or token requires a PIN...
    CkCert::setCkSmartCardPin(cert, "000000")

    success.i = CkCert::ckLoadFromSmartcard(cert,"")
    If success <> 1
        Debug CkCert::ckLastErrorText(cert)
        CkRest::ckDispose(rest)
        CkSocket::ckDispose(socket)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    success = CkSocket::ckSetSslClientCert(socket,cert)
    If success <> 1
        Debug CkSocket::ckLastErrorText(socket)
        CkRest::ckDispose(rest)
        CkSocket::ckDispose(socket)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    ; Establish the connection using the socket object (with client certificate authentication).
    bTls.i = 1
    port.i = 443
    maxWaitMs.i = 5000
    success = CkSocket::ckConnect(socket,"www.example.com",port,bTls,maxWaitMs)
    If success <> 1
        Debug "Connect Failure Error Code: " + Str(CkSocket::ckConnectFailReason(socket))
        Debug CkSocket::ckLastErrorText(socket)
        CkRest::ckDispose(rest)
        CkSocket::ckDispose(socket)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    bAutoReconnect.i = 1

    ; Use the connection:
    success = CkRest::ckUseConnection(rest,socket,bAutoReconnect)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkSocket::ckDispose(socket)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    ; At this point we are connected and can make REST calls...
    ; For example..
    responseJson.s = CkRest::ckFullRequestNoBody(rest,"GET","/someQuery")
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkSocket::ckDispose(socket)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf



    CkRest::ckDispose(rest)
    CkSocket::ckDispose(socket)
    CkCert::ckDispose(cert)


    ProcedureReturn
EndProcedure