(PHP Extension) 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 PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

// 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

$jsonToken = new CkJsonObject();
$success = $jsonToken->LoadFile('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"
//     },
//     {
// 	...
//     }
//   ]
// }

$jsonWebKeys = new CkJsonObject();
$success = $jsonWebKeys->LoadFile('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.
// 
$jwt = new CkJwt();
$idToken = $jsonToken->stringOf('id_token');
$joseHeader = $jwt->getHeader($idToken);

print $joseHeader . "\n";
// The joseHeader contains this:   {"kid":"anSaRDPfWGOSCVNZEIZB9quCbNsdsvl5uWGBzxbudWQ","alg":"RS256"}

$json = new CkJsonObject();
$json->Load($joseHeader);
$kid = $json->stringOf('kid');
print 'kid to find: ' . $kid . "\n";

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

$sbKid = new CkStringBuilder();
$e = '';
$n = '';

$i = 0;
$count_i = $jsonWebKeys->SizeOfArray('keys');
$bFound = false;
$iMatch = 0;
while (($bFound == false) and ($i < $count_i)) {
    $jsonWebKeys->put_I($i);
    $sbKid->Clear();
    $jsonWebKeys->StringOfSb('keys[i].kid',$sbKid);
    print 'checking kid: ' . $sbKid->getAsString() . "\n";

    if ($sbKid->ContentsEqual($kid,true) == true) {
        $e = $jsonWebKeys->stringOf('keys[i].e');
        $n = $jsonWebKeys->stringOf('keys[i].n');
        // Exit the loop. 
        print 'Found matching kid.' . "\n";
        $iMatch = $i;
        $bFound = true;
    }

    $i = $i + 1;
}

if ($bFound == false) {
    print 'No matching key ID found.' . "\n";
    exit;
}

print 'Matching key:' . "\n";
print '  exponent = ' . $e . "\n";
print '  modulus = ' . $n . "\n";

// ------------------------
// Step 3: Load the RSA modulus and exponent into a Chilkat public key object.
$pubkey = new CkPublicKey();

// Get the matching JSON key from the array of keys.
$jsonWebKeys->put_I($iMatch);
// jsonWebKey is a CkJsonObject
$jsonWebKey = $jsonWebKeys->ObjectOf('keys[i]');
$success = $pubkey->LoadFromString($jsonWebKey->emit());
if ($success == false) {
    print 'Failed to load JSON web key.' . "\n";
    print $jsonWebKey->emit() . "\n";
    print $pubkey->lastErrorText() . "\n";

    exit;
}

print 'successfully loaded web key.' . "\n";

// 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.
$bVerified = $jwt->VerifyJwtPk($idToken,$pubkey);
if ($bVerified == true) {
    print 'The ID token is valid.' . "\n";
}
else {
    print 'The ID token is NOT valid.' . "\n";
}

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

$claims = $jwt->getPayload($idToken);

$jsonClaims = new CkJsonObject();
$jsonClaims->Load($claims);
$jsonClaims->put_EmitCompact(false);
print $jsonClaims->emit() . "\n";

// 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.
$dtExp = new CkDateTime();
$dtExp->SetFromUnixTime(false,$jsonClaims->IntOf('exp'));
print 'expire timestamp = ' . $dtExp->getAsTimestamp(false) . "\n";

// Check to see if this date/time expires within 0 seconds (i.e. is already past)
$bExpired = $dtExp->ExpiresWithin(0,'seconds');
print 'bExpired = ' . $bExpired . "\n";

?>