(Objective-C) 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 Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoJsonObject.h>
#import <CkoJwt.h>
#import <NSString.h>
#import <CkoStringBuilder.h>
#import <CkoPublicKey.h>
#import <CkoDateTime.h>

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

CkoJsonObject *jsonToken = [[CkoJsonObject alloc] init];
BOOL 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"
//     },
//     {
// 	...
//     }
//   ]
// }

CkoJsonObject *jsonWebKeys = [[CkoJsonObject alloc] init];
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.
// 
CkoJwt *jwt = [[CkoJwt alloc] init];
NSString *idToken = [jsonToken StringOf: @"id_token"];
NSString *joseHeader = [jwt GetHeader: idToken];

NSLog(@"%@",joseHeader);
// The joseHeader contains this:   {"kid":"anSaRDPfWGOSCVNZEIZB9quCbNsdsvl5uWGBzxbudWQ","alg":"RS256"}

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json Load: joseHeader];
NSString *kid = [json StringOf: @"kid"];
NSLog(@"%@%@",@"kid to find: ",kid);

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

CkoStringBuilder *sbKid = [[CkoStringBuilder alloc] init];
NSString *e = @"";
NSString *n = @"";

int i = 0;
int count_i = [[jsonWebKeys SizeOfArray: @"keys"] intValue];
BOOL bFound = NO;
int iMatch = 0;
while ((bFound == NO) && (i < count_i)) {
    jsonWebKeys.I = [NSNumber numberWithInt: i];
    [sbKid Clear];
    [jsonWebKeys StringOfSb: @"keys[i].kid" sb: sbKid];
    NSLog(@"%@%@",@"checking kid: ",[sbKid GetAsString]);

    if ([sbKid ContentsEqual: kid caseSensitive: YES] == YES) {
        e = [jsonWebKeys StringOf: @"keys[i].e"];
        n = [jsonWebKeys StringOf: @"keys[i].n"];
        // Exit the loop. 
        NSLog(@"%@",@"Found matching kid.");
        iMatch = i;
        bFound = YES;
    }

    i = i + 1;
}

if (bFound == NO) {
    NSLog(@"%@",@"No matching key ID found.");
    return;
}

NSLog(@"%@",@"Matching key:");
NSLog(@"%@%@",@"  exponent = ",e);
NSLog(@"%@%@",@"  modulus = ",n);

// ------------------------
// Step 3: Load the RSA modulus and exponent into a Chilkat public key object.
CkoPublicKey *pubkey = [[CkoPublicKey alloc] init];

// Get the matching JSON key from the array of keys.
jsonWebKeys.I = [NSNumber numberWithInt: iMatch];
CkoJsonObject *jsonWebKey = [jsonWebKeys ObjectOf: @"keys[i]"];
success = [pubkey LoadFromString: [jsonWebKey Emit]];
if (success == NO) {
    NSLog(@"%@",@"Failed to load JSON web key.");
    NSLog(@"%@",[jsonWebKey Emit]);
    NSLog(@"%@",pubkey.LastErrorText);

    return;
}

NSLog(@"%@",@"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.
BOOL bVerified = [jwt VerifyJwtPk: idToken key: pubkey];
if (bVerified == YES) {
    NSLog(@"%@",@"The ID token is valid.");
}
else {
    NSLog(@"%@",@"The ID token is NOT valid.");
}

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

NSString *claims = [jwt GetPayload: idToken];

CkoJsonObject *jsonClaims = [[CkoJsonObject alloc] init];
[jsonClaims Load: claims];
jsonClaims.EmitCompact = NO;
NSLog(@"%@",[jsonClaims Emit]);

// 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.
CkoDateTime *dtExp = [[CkoDateTime alloc] init];
[dtExp SetFromUnixTime: NO t: [[jsonClaims IntOf: @"exp"] intValue]];
NSLog(@"%@%@",@"expire timestamp = ",[dtExp GetAsTimestamp: NO]);

// Check to see if this date/time expires within 0 seconds (i.e. is already past)
BOOL bExpired = [dtExp ExpiresWithin: [NSNumber numberWithInt: 0] units: @"seconds"];
NSLog(@"%@%d",@"bExpired = ",bExpired);