PureBasic

Add Custom Claims to JWT for Google Service Account OAuth2

Demonstrates how add custom claims to the JWT when getting a Google API OAuth2 access token using a JSON service account private key. PureBasic

IncludeFile "CkSocket.pb"
IncludeFile "CkAuthGoogle.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkFileAccess.pb"

Procedure ChilkatExample()

    success.i = 0

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

    ; First load the JSON key into a string.
    fac.i = CkFileAccess::ckCreate()
    If fac.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    jsonKey.s = CkFileAccess::ckReadEntireTextFile(fac,"qa_data/googleApi/ChilkatTest-ab2ecd52ef98.json","utf-8")
    If CkFileAccess::ckLastMethodSuccess(fac) <> 1
        Debug CkFileAccess::ckLastErrorText(fac)
        CkFileAccess::ckDispose(fac)
        ProcedureReturn
    EndIf

    ; A JSON private key should look like this:

    ; 	{
    ; 	  "type": "service_account",
    ; 	  "project_id": "chilkattest-1350",
    ; 	  "private_key_id": "fa2e36ee26986eab628b59868af8bec1d1c64c38",
    ; 	  "private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvgIjFa...28N64N2n1E4FYzBZjSdy\n-----END PRIVATE KEY-----\n",
    ; 	  "client_email": "598922945226-00rb0ppfg0sndajo6bhvd4v17jtj2d3a@developer.gserviceaccount.com",
    ; 	  "client_id": "598922945226-00rb0ppfg0snd9jo7bhvd4v17jtj2d3a.apps.googleusercontent.com",
    ; 	  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
    ; 	  "token_uri": "https://accounts.google.com/o/oauth2/token",
    ; 	  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
    ; 	  "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/598922945226-00rb0ppfg0sndajo6bhvd4v17jtj2d3a%40developer.gserviceaccount.com"
    ; 	}

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

    CkAuthGoogle::setCkJsonKey(gAuth, jsonKey)

    ; Choose a scope.
    CkAuthGoogle::setCkScope(gAuth, "https://www.googleapis.com/auth/cloud-platform")

    ; Request an access token that is valid for this many seconds.
    CkAuthGoogle::setCkExpireNumSeconds(gAuth, 3600)

    ; If the application is requesting delegated access:
    ; The email address of the user for which the application is requesting delegated access,
    ; then set the email address here. (Otherwise leave it empty.)
    CkAuthGoogle::setCkSubEmailAddress(gAuth, "")

    ; --------------------------------------------------------------------------------------
    ; To add custom claims, create JSON containing the claims to be added and call AddClaims.
    moreClaims.i = CkJsonObject::ckCreate()
    If moreClaims.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(moreClaims,"claimAbc","valueAbc")
    CkJsonObject::ckUpdateString(moreClaims,"claimXyz","valueXyz")
    ; ...
    CkAuthGoogle::ckAddClaims(gAuth,moreClaims)
    ; --------------------------------------------------------------------------------------

    ; Connect to www.googleapis.com using TLS (TLS 1.2 is the default.)
    ; The Chilkat socket object is used so that the connection can be established
    ; through proxies or an SSH tunnel if desired.
    tlsSock.i = CkSocket::ckCreate()
    If tlsSock.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkSocket::ckConnect(tlsSock,"www.googleapis.com",443,1,5000)
    If success <> 1
        Debug CkSocket::ckLastErrorText(tlsSock)
        CkFileAccess::ckDispose(fac)
        CkAuthGoogle::ckDispose(gAuth)
        CkJsonObject::ckDispose(moreClaims)
        CkSocket::ckDispose(tlsSock)
        ProcedureReturn
    EndIf

    ; Send the request to obtain the access token.
    success = CkAuthGoogle::ckObtainAccessToken(gAuth,tlsSock)
    If success <> 1
        Debug CkAuthGoogle::ckLastErrorText(gAuth)
        CkFileAccess::ckDispose(fac)
        CkAuthGoogle::ckDispose(gAuth)
        CkJsonObject::ckDispose(moreClaims)
        CkSocket::ckDispose(tlsSock)
        ProcedureReturn
    EndIf

    ; Examine the access token:
    Debug "Access Token: " + CkAuthGoogle::ckAccessToken(gAuth)


    CkFileAccess::ckDispose(fac)
    CkAuthGoogle::ckDispose(gAuth)
    CkJsonObject::ckDispose(moreClaims)
    CkSocket::ckDispose(tlsSock)


    ProcedureReturn
EndProcedure