JWT Authentication in the Apollo Router

The Apollo Router supports request authentication and key rotation via the JSON Web Token (JWT) and JSON Web Key (JWK) standards. This support is compatible with popular identity providers (IdPs) like Okta and Auth0.

By enabling JWT authentication, you can block malicious traffic at the edge of your graph instead of relying on header forwarding to propagate tokens to your subgraphs.

To use this feature:

• You must have an identity provider (IdP) or similar service that issues JWTs to authenticated clients using one of the signature algorithms supported by the jsonwebtoken Rust library (most popular signing algorithms are supported).
• You must have a GraphOS Enterprise plan and connect your router to GraphOS.

If you issue JWTs via a popular third-party IdP (Auth0, Okta, PingOne, etc.), adding JWT authentication to your router is comparatively straightforward. If you use your own custom IdP, advanced configuration is required.

How it works

These are the high-level steps of JWT-based authentication with the Apollo Router:

1. Whenever a client authenticates with your system, your IdP issues that client a valid JSON Web Token (JWT).

2. In its subsequent requests to your router, the authenticated client provides its JWT in a designated HTTP header.

3. Whenever your router receives a client request, it extracts the JWT from the designated header (if present).

   • If no JWT is present, the request proceeds. You can reject requests with no accompanying JWT at a later phase (see below).

4. Your router validates the extracted JWT using a corresponding JSON Web Key (JWK).

   • Your router obtains all of its known JWKs from URLs that you specify in its configuration file. Each URL provides its keys within a single JSON object called a JWK Set (or a JWKS).
   • If validation fails, the router rejects the request. This can occur if the JWT is malformed, or if it's been expired for more than 60 seconds (this window accounts for synchronization issues).

5. The router extracts all claims from the validated JWT and includes them in the request's context, making them available to your router customizations, such as Rhai scripts.

6. Your customizations can handle the request differently depending on the details of the extracted claims, and/or you can propagate the claims to subgraphs to enable more granular access control.

   • For examples, see below.

Turning it on

You enable JWT authentication for your router with the following steps:

1. Set configuration options for JWT authentication in your router's YAML config file, under the authentication key:

   YAML

   router.yaml

   1
   authentication:
   2
     router:
   3
       jwt:
   4
         jwks: # This key is required.
   5
           - url: https://dev-zzp5enui.us.auth0.com/.well-known/jwks.json
   6
             issuer: <optional name of issuer>
   7
   
   8
         # These keys are optional. Default values are shown.
   9
         header_name: Authorization
   10
         header_value_prefix: Bearer

   Copy

   These options are documented below.

2. Pass all of the following to the router executable on startup:

   • The path to the router's YAML configuration file (via the --config option)
   • The graph ref for the GraphOS variant your router should use (via the APOLLO_GRAPH_REF environment variable)
   • A graph API key that enables the router to authenticate with GraphOS to fetch its supergraph schema (via the APOLLO_KEY environment variable)
   Bash

   1
   APOLLO_GRAPH_REF=docs-example-graph@main APOLLO_KEY="..." ./router --config router.yaml

   Copy

When the router starts up, it displays a log message that confirms which jwks are in use:

1
2023-02-03T14:05:28.018932Z  INFO JWT authentication using JWKSets from jwks=[{ url: "file:///router/jwks.json" }]

Configuration options

The following configuration options are supported:

Working with JWT claims

After the Apollo Router validates a client request's JWT, it adds that token's claims to the request's context at this key: apollo_authentication::JWT::claims

If unauthenticated requests should be rejected, the router can be configured like this:

1
authorization:
2
  require_authentication: true

Claims are the individual details of a JWT's scope. They might include details like the ID of the associated user, any roles assigned to that user, and the JWT's expiration time. See the spec.

Because claims are added to the context, you can define custom logic for handling each request based on the details of its claims. You can define this logic within a Rhai script or external coprocessor at the supergraph service level (for more on these options, see Customizations for the Apollo Router).

Below are 2 example Rhai script customizations that demonstrate actions the router can perform based on a request's claims.

Example: Forwarding claims to subgraphs as headers

Below is an example Rhai script that forwards a JWT's claims to individual subgraphs via HTTP headers (one header for each claim). This enables each subgraph to define logic to handle (or potentially reject) incoming requests based on claim details. This function should be imported and run in your main.rhai file.

1
fn process_request(request) {
2
    let claims = request.context[Router.APOLLO_AUTHENTICATION_JWT_CLAIMS];
3
    if claims ==() {
4
      throw #{
5
        status: 401
6
      };
7
    }
8
    // Add each claim key-value pair as a separate HTTP header.
9
    // Note that that claims that are not present in the JWT will be added as empty strings.
10
    let claim_names = ["claim_1", "claim_2", "claim_3"];
11
    for claim_name in claim_names {
12
      let claim = claims[claim_name];
13
      claim = if claim == () {""} else {claim};
14
      request.subgraph.headers[claim_name] = claim;
15
    }
16
}

Example: Forwarding claims to subgraphs as GraphQL extensions

Below is an example Rhai script that forwards a JWT's claims to individual subgraphs via GraphQL extension. This enables each subgraph to define logic to handle (or potentially reject) incoming requests based on claim details. This function should be imported and run in your main.rhai file.

1
fn process_request(request) {
2
    let claims = request.context[Router.APOLLO_AUTHENTICATION_JWT_CLAIMS];
3
    if claims ==() {
4
      throw #{
5
        status: 401
6
      };
7
    }
8
    request.subgraph.body.extensions["claims"] = claims;
9
}

Example: Throwing errors for invalid claims

Below is an example Rhai script that throws distinct errors for different invalid JWT claim details. This function should be imported and run in your main.rhai file.

1
fn process_request(request) {
2
    // Router.APOLLO_AUTHENTICATION_JWT_CLAIMS is a Rhai-scope
3
    // constant with value `apollo_authentication::JWT::claims`
4
    let claims = request.context[Router.APOLLO_AUTHENTICATION_JWT_CLAIMS];
5
    if claims == () || !claims.contains("iss") || claims["iss"] != "https://idp.local" {
6
        throw #{
7
            status: 401,
8
            message: "Unauthorized"
9
        };
10
    }
11
    // Happy path: We have valid claims from the correct idP.
12
}

Example main.rhai

In order to use the above Rhai examples, you must import them into your main.rhai like this:

1
import "claims_validation" as claims_validation;
2
import "claims_forwarding" as claims_forwarding;
3

4
fn supergraph_service(service) {
5
    let request_callback = |request| {
6
        claims_validation::process_request(request);
7
    };
8

9
    service.map_request(request_callback);
10
}
11

12
fn subgraph_service(service, subgraph) {
13
    let request_callback = |request| {
14
        claims_forwarding::process_request(request);
15
    };
16

17
    service.map_request(request_callback);
18
}

Claim augmentation via coprocessors

You may require information beyond what your JSON web tokens provide. For example, a token's claims may include user IDs, which you then use to look up user roles. For situations like this, you can augment the claims from your JSON web tokens with coprocessors.

1
authentication:
2
  router:
3
    jwt:
4
      jwks:
5
        - url: "file:///etc/router/jwks.json"
6

7
coprocessor:
8
  url: http://127.0.0.1:8081
9
  router:
10
    request:
11
      context: true

1
{
2
    "version": 1,
3
    "stage": "RouterRequest",
4
    "control": "continue",
5
    "id": "d0a8245df0efe8aa38a80dba1147fb2e",
6
    "context": {
7
        "entries": {
8
            "apollo_authentication::JWT::claims": {
9
                "exp": 10000000000,
10
                "sub": "457f6bb6-789c-4e8b-8560-f3943a09e72a"
11
            }
12
        }
13
    },
14
    "method": "POST"
15
}

1
{
2
    "version": 1,
3
    "stage": "RouterRequest",
4
    "control": "continue",
5
    "id": "d0a8245df0efe8aa38a80dba1147fb2e",
6
    "context": {
7
        "entries": {
8
            "apollo_authentication::JWT::claims": {
9
                "exp": 10000000000,
10
                "sub": "457f6bb6-789c-4e8b-8560-f3943a09e72a",
11
                "scope": "profile:read profile:write"
12
            }
13
        }
14
    }
15
}

Creating your own JWKS (advanced)

The Apollo Router obtains each JSON Web Key (JWK) that it uses from the URLs that you specify via the jwks configuration option. Each URL must provide a set of valid JWKs in a single JSON object called a JWK Set (or JWKS).

To provide a JWKS to your router, configure your IdP service to do the following whenever its collection of valid JWKs changes (such as when a JWK expires or is rotated):

1. Generate a valid JWKS object that includes the details of every JWK that the router requires to perform token validation.
2. Write the JWKS object to a location that your router can reach via a file:// or https:// URL.
   • ⚠️ If any of your JWKs uses a symmetric signature algorithm (such as HS256), always use a file:// URL. Symmetric signature algorithms use a shared key that should never be accessible over the network.

Again, make sure the IdP is configured to perform these steps every time its collection of JWKs changes!

JWKS format

A JWKS is a JSON object with a single top-level property: keys. The value of keys is an array of objects that each represent a single JWK:

1
{
2
  "keys": [
3
    {
4
      // These JWK properties are explained below.
5
      "kty": "RSA",
6
      "alg": "RS256",
7
      "kid": "abc123",
8
      "use": "sig",
9
      "n": "0vx7agoebGcQSuu...",
10
      "e": "AQAB"
11
    }
12
  ]
13
}

It's common for the keys array to contain only a single JWK, or sometimes two if your IdP is in the process of rotating a key.

JWK object reference

JWK object properties fall into two categories:

• Universal properties. You include these in your JWK objects regardless of which signature algorithm you use.
• Algorithm-specific properties. You include these only for JWK objects that use a corresponding signature algorithm.

Universal properties

These properties apply to any JWK:

Algorithm-specific properties

RSA

1
{
2
  // Universal properties
3
  "kty": "RSA",
4
  "alg": "RS256",
5
  "kid": "abc123",
6

7
  // Algorithm-specific properties
8
  "n": "0vx7agoebGcQSuu...", // Shortened for readability
9
  "e": "AQAB"
10
}

EC (elliptic curve)

1
{
2
  // Universal properties
3
  "kty": "EC",
4
  "alg": "ES256",
5
  "kid": "afda85e09a320cf748177874592de64d",
6
  "use": "sig",
7

8
  // Algorithm-specific properties
9
  "crv": "P-256",
10
  "x": "opFUViwCYVZLmsbG2cJTA9uPvOF5Gg8W7uNhrcorGhI",
11
  "y": "bPxvCFKmlqTdEFc34OekvpviUUyelGrbi020dlgIsqo"
12
}

Symmetric key algorithms (such as HMAC)

1
{
2
  // Universal properties
3
  "kty": "oct",
4
  "alg": "HS256",
5
  "kid": "key1",
6
  "use": "sig",
7

8
  // Symmetric-algorithm-specific property
9
  "k": "c2VjcmV0Cg==" // ⚠️ This is a base64-encoded shared secret! ⚠️
10
}

JWK matching

To match an incoming JWT with its corresponding JWK, the router proceeds through descending "specificity levels" of match criteria until it identifies the first compatible JWK from its JWK Sets:

1. The JWT and JWK match both kid and alg exactly.
2. The JWT and JWK match kid, and the JWT's alg is compatible with the JWK's kty.
3. The JWT and JWK match alg exactly.
4. The JWT's alg is compatible with the JWK's kty.

This matching strategy is necessary because some identity providers (IdPs) don't specify alg or kid values in their JWKS. However, they always specify a kty, because that value is required by the JWK specification.

Forwarding JWTs to subgraphs

Because the Apollo Router handles validating incoming JWTs, you rarely need to pass those JWTs to individual subgraphs in their entirety. Instead, you usually want to pass JWT claims to subgraphs to enable fine-grained access control.

If you do need to pass entire JWTs to subgraphs, you can do so via the Apollo Router's general-purpose HTTP header propagation settings.

Observability

If your router enables tracing, the JWT authentication plugin has its own tracing span: authentication_plugin

If your router enables metrics collection via Prometheus, the JWT authentication plugin provides and exports the following metrics:

• apollo_authentication_failure_count
• apollo_authentication_success_count

Those metrics have the following shapes:

1
# HELP apollo_authentication_failure_count apollo_authentication_failure_count
2
# TYPE apollo_authentication_failure_count counter
3
apollo_authentication_failure_count{kind="JWT",service_name="apollo-router"} 1
4

5
# HELP apollo_authentication_success_count apollo_authentication_success_count
6
# TYPE apollo_authentication_success_count counter
7
apollo_authentication_success_count{kind="JWT",service_name="apollo-router"} 11