(Tcl) Verify Okta ID Token Locally

This example demonstrates how to validate an Okta ID token using Chilkat's JWT class.

For more information, see https://developer.okta.com/docs/guides/validate-id-tokens/overview/

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

# This example begins with two JSON files:
# 
# 1. The access + id token obtained from Okta as shown in one fo these examples:  
#    Get Okta Token using Resource Owner Password Flow
# 
# 2. The Okta web keys obtained by this example:  Get Okta Web Keys
# 
# 

# ----------------------------------------------------------------
# Note: The very last step of this example is where the claims, such as iss, aud, iat, exp, and nonce
# are extracted from the ID token and examined.
# ----------------------------------------------------------------

# Load the access/id token to be verified.
# It contains JSON that looks like this:
# {
#   "access_token": "eyJraWQiOiJhb ... O_eVu-kBp6g",
#   "token_type": "Bearer",
#   "expires_in": 3600,
#   "scope": "openid",
#   "id_token": "eyJraWQi ... FrL9WOuwbQtUg"
# }
# This example verifies the id_token.  (The access_token is verified in this example:  Verify Okta Access Token

set jsonToken [new_CkJsonObject]

set success [CkJsonObject_LoadFile $jsonToken "qa_data/tokens/okta_access_token.json"]

# Load the public keys (Okta web keys), one of which is needed to validate.
# The web keys JSON looks like this:
# {
#   "keys": [
#     {
#       "kty": "RSA",
#       "alg": "RS256",
#       "kid": "anSaRDPfWGOSCVNZEIZB9quCbNsdsvl5uWGBzxbudWQ",
#       "use": "sig",
#       "e": "AQAB",
#       "n": "jT8uAgd5w ... euLB1HaVw"
#     },
#     {
# 	...
#     }
#   ]
# }

set jsonWebKeys [new_CkJsonObject]

set success [CkJsonObject_LoadFile $jsonWebKeys "qa_data/tokens/okta_web_keys.json"]

# ------------------------
# Step 1: Get the JOSE header from the JWT.  The JOSE header contains JSON.  One of the JSON members will be the key ID "kid" which identifies the web key to be used for validation.
# 
set jwt [new_CkJwt]

set idToken [CkJsonObject_stringOf $jsonToken "id_token"]
set joseHeader [CkJwt_getHeader $jwt $idToken]

puts "$joseHeader"
# The joseHeader contains this:   {"kid":"anSaRDPfWGOSCVNZEIZB9quCbNsdsvl5uWGBzxbudWQ","alg":"RS256"}

set json [new_CkJsonObject]

CkJsonObject_Load $json $joseHeader
set kid [CkJsonObject_stringOf $json "kid"]
puts "kid to find: $kid"

# ------------------------
# Step 2: Find the key with the same "kid" in the Okta web keys.

set sbKid [new_CkStringBuilder]

set e ""
set n ""

set i 0
set count_i [CkJsonObject_SizeOfArray $jsonWebKeys "keys"]
set bFound 0
set iMatch 0
while {expr [$bFound == 0]  &&  [$i < $count_i]} {
    CkJsonObject_put_I $jsonWebKeys $i
    CkStringBuilder_Clear $sbKid
    CkJsonObject_StringOfSb $jsonWebKeys "keys[i].kid" $sbKid
    puts "checking kid: [CkStringBuilder_getAsString $sbKid]"

    if {[CkStringBuilder_ContentsEqual $sbKid $kid 1] == 1} then {
        set e [CkJsonObject_stringOf $jsonWebKeys "keys[i].e"]
        set n [CkJsonObject_stringOf $jsonWebKeys "keys[i].n"]
        # Exit the loop. 
        puts "Found matching kid."
        set iMatch $i
        set bFound 1
    }

    set i [expr $i + 1]
}

if {$bFound == 0} then {
    puts "No matching key ID found."
    delete_CkJsonObject $jsonToken
    delete_CkJsonObject $jsonWebKeys
    delete_CkJwt $jwt
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbKid
    exit
}

puts "Matching key:"
puts "  exponent = $e"
puts "  modulus = $n"

# ------------------------
# Step 3: Load the RSA modulus and exponent into a Chilkat public key object.
set pubkey [new_CkPublicKey]

# Get the matching JSON key from the array of keys.
CkJsonObject_put_I $jsonWebKeys $iMatch
# jsonWebKey is a CkJsonObject
set jsonWebKey [CkJsonObject_ObjectOf $jsonWebKeys "keys[i]"]
set success [CkPublicKey_LoadFromString $pubkey [CkJsonObject_emit $jsonWebKey]]
if {$success == 0} then {
    puts "Failed to load JSON web key."
    puts [CkJsonObject_emit $jsonWebKey]
    puts [CkPublicKey_lastErrorText $pubkey]
    delete_CkJsonObject $jsonWebKey

    delete_CkJsonObject $jsonToken
    delete_CkJsonObject $jsonWebKeys
    delete_CkJwt $jwt
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbKid
    delete_CkPublicKey $pubkey
    exit
}

delete_CkJsonObject $jsonWebKey

puts "successfully loaded web key."

# OK.. we have the desired JSON web key loaded into our public key object.
# Now we can verify the access token.

# ------------------------
# Step 4: Verify the access token.
set bVerified [CkJwt_VerifyJwtPk $jwt $idToken $pubkey]
if {$bVerified == 1} then {
    puts "The ID token is valid."
} else {
    puts "The ID token is NOT valid."
}

# ------------------------
# Step 5: Extract the claims (payload) from the ID token and examine them..

set claims [CkJwt_getPayload $jwt $idToken]

set jsonClaims [new_CkJsonObject]

CkJsonObject_Load $jsonClaims $claims
CkJsonObject_put_EmitCompact $jsonClaims 0
puts [CkJsonObject_emit $jsonClaims]

# Sample claims:
# {
#   "sub": "00utrr8ehubooPhjj356",
#   "ver": 1,
#   "iss": "https://dev-765951.okta.com/oauth2/default",
#   "aud": "0oatrr20vPYgVDlGr356",
#   "iat": 1562190727,
#   "exp": 1562194327,
#   "jti": "ID.JvlMhlnCj5ZqqGjk-jlgcOxHEyVUwIl9_Kpz69U2D_4",
#   "amr": [
#     "pwd"
#   ],
#   "idp": "00os29azljkqyx99Q356",
#   "auth_time": 1562190726,
#   "at_hash": "SLMiVeyNWWEDaZ-O32nKMg"
# }

# The exp (expiry time) claim is the time at which this token will expire., expressed in Unix time. You should make sure that this time has not already passed.
set dtExp [new_CkDateTime]

CkDateTime_SetFromUnixTime $dtExp 0 [CkJsonObject_IntOf $jsonClaims "exp"]
puts "expire timestamp = [CkDateTime_getAsTimestamp $dtExp 0]"

# Check to see if this date/time expires within 0 seconds (i.e. is already past)
set bExpired [CkDateTime_ExpiresWithin $dtExp 0 "seconds"]
puts "bExpired = $bExpired"

delete_CkJsonObject $jsonToken
delete_CkJsonObject $jsonWebKeys
delete_CkJwt $jwt
delete_CkJsonObject $json
delete_CkStringBuilder $sbKid
delete_CkPublicKey $pubkey
delete_CkJsonObject $jsonClaims
delete_CkDateTime $dtExp