PureBasic

Create JWS Using Private Key on a Smart Card

See more JSON Web Signatures (JWS) Examples

Creates and validates a JSON Web Signature (JWS) using the private key associated with a certificate on a smart card. PureBasic

IncludeFile "CkJws.pb"
IncludeFile "CkCert.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkPublicKey.pb"

Procedure ChilkatExample()

    success.i = 0

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

    ; Load the certificate from a smart card.
    cert.i = CkCert::ckCreate()
    If cert.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Set the smarcard PIN prior to loading
    CkCert::setCkSmartCardPin(cert, "123456")

    ; Detect the connected smartcard or USB security token and load the default certificate.
    success = CkCert::ckLoadFromSmartcard(cert,"")
    If success = 0
        Debug CkCert::ckLastErrorText(cert)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    ; Note: Chilkat provides many different ways to load a certificate from a smartcard or USB token,
    ; such as selecting a certificate if the card contains multiple certificates with private keys,
    ; or working with lower-level PKCS11 or ScMinidriver API's (both of which Chilkat provides).

    ; Create the JWS Protected Header
    jwsProtHdr.i = CkJsonObject::ckCreate()
    If jwsProtHdr.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    If CkCert::ckIsEcdsa(cert) = 1
        CkJsonObject::ckAppendString(jwsProtHdr,"alg","ES256")
    Else
        CkJsonObject::ckAppendString(jwsProtHdr,"alg","RS256")
    EndIf

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

    ; Set the protected header:
    signatureIndex.i = 0
    CkJws::ckSetProtectedHeader(jws,signatureIndex,jwsProtHdr)

    ; Provide the private key via the certificate.
    ; This requires Chilkat v11.5.0 or greater.
    CkJws::ckSetSigningCert(jws,signatureIndex,cert)

    ; Set the payload.
    bIncludeBom.i = 0
    payloadStr.s = "In our village, folks say God crumbles up the old moon into stars."
    CkJws::ckSetPayload(jws,payloadStr,"utf-8",bIncludeBom)

    ; Create the JWS
    ; By default, the compact serialization is used.
    jwsCompact.s = CkJws::ckCreateJws(jws)
    If CkJws::ckLastMethodSuccess(jws) = 0
        Debug CkJws::ckLastErrorText(jws)
        CkCert::ckDispose(cert)
        CkJsonObject::ckDispose(jwsProtHdr)
        CkJws::ckDispose(jws)
        ProcedureReturn
    EndIf

    Debug "JWS: " + jwsCompact

    ; sample output:
    ; JWS: eyJhbGciOiJQUzI1NiJ9.SW4gb3VyIHZpbGxhZ2UsIGZvbGtzIHNheSBHb2QgY3J1bWJsZXMgdXAgdGhlIG9sZCBtb29uIGludG8gc3RhcnMu.TRWhwRo5dMv9-8OzrInfJTwmUGYgjLfHk8lqF072ND-FmLWEBnUTOpY8oJXp8FdWw2SalbdOeNlrtlJjwk4XK8Ql2iJ_2qMCtxsvLPhKBOqFoAF4aBvTOEDVJDxf0DaBSiydEEtfTVV2iwBcjWabu5J2XieR5y7QZQtuHsn7T3qKBvCcCejN3Y2oqAT3qMHvu1fTms1r_91wBn_K7Wjd9UkZ1n02qQcUHJznR_OF2BgN7_KWIDAF9ZS9keoju2NPpPelO4yxa2XUPnehY3G7dHKoCxUEQR4d2Xc5voqDASTVCDqQS4PVOZdvT3Ein6-SanAlCwbWBbkvT8g6-5PImQ

    ; Now load the JWS, validate, and recover the original text.
    jws2.i = CkJws::ckCreate()
    If jws2.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Load the JWS.
    success = CkJws::ckLoadJws(jws2,jwsCompact)

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

    CkCert::ckGetPublicKey(cert,pubKey)

    ; Set the public key used for validation.
    signatureIndex = 0
    CkJws::ckSetPublicKey(jws2,signatureIndex,pubKey)

    ; Validate the 1st (and only) signature at index 0..
    v.i = CkJws::ckValidate(jws2,signatureIndex)
    If v < 0
        ; Perhaps Chilkat was not unlocked or the trial expired..
        Debug "Method call failed for some other reason."
        Debug CkJws::ckLastErrorText(jws2)
        CkCert::ckDispose(cert)
        CkJsonObject::ckDispose(jwsProtHdr)
        CkJws::ckDispose(jws)
        CkJws::ckDispose(jws2)
        CkPublicKey::ckDispose(pubKey)
        ProcedureReturn
    EndIf

    If v = 0
        Debug "Invalid signature.  The key was incorrect, the JWS was invalid, or both."
        CkCert::ckDispose(cert)
        CkJsonObject::ckDispose(jwsProtHdr)
        CkJws::ckDispose(jws)
        CkJws::ckDispose(jws2)
        CkPublicKey::ckDispose(pubKey)
        ProcedureReturn
    EndIf

    ; If we get here, the signature was validated..
    Debug "Signature validated."

    ; Recover the original content:
    Debug CkJws::ckGetPayload(jws2,"utf-8")

    ; Examine the protected header:

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

    success = CkJws::ckGetProtectedH(jws2,signatureIndex,joseHeader)
    If success = 0
        Debug CkJws::ckLastErrorText(jws2)
        CkCert::ckDispose(cert)
        CkJsonObject::ckDispose(jwsProtHdr)
        CkJws::ckDispose(jws)
        CkJws::ckDispose(jws2)
        CkPublicKey::ckDispose(pubKey)
        CkJsonObject::ckDispose(joseHeader)
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(joseHeader, 0)

    Debug "Protected (JOSE) header:"
    Debug CkJsonObject::ckEmit(joseHeader)

    ; Output:

    ; 	Signature validated.
    ; 	In our village, folks say God crumbles up the old moon into stars.
    ; 	Protected (JOSE) header:
    ; 	{ 
    ; 	  "alg": "RS256"
    ; 	}


    CkCert::ckDispose(cert)
    CkJsonObject::ckDispose(jwsProtHdr)
    CkJws::ckDispose(jws)
    CkJws::ckDispose(jws2)
    CkPublicKey::ckDispose(pubKey)
    CkJsonObject::ckDispose(joseHeader)


    ProcedureReturn
EndProcedure