Passing End User Attributes to the Backend

There can be scenarios where a backend service needs to make different decisions or respond with different data, depending on the application end-user that consumes an API. To achieve this the backend service needs to have access to the respective end-user's data at the time an API call takes place.

This can be facilitated by the Gateway by sending the end user attributes that are defined in the respective user store, in a JWT via an HTTP header, to the backend service when the API call is being forwarded.

How does it work?

The backend JSON Web Token (JWT) contains the claims that are transferred between two parties, such as the end-user and the backend. A claim is an attribute of the user that is mapped to the underlying user store. A set of claims is referred to as a dialect (e.g., http://wso2.org/claims).

If you enable backend JWT generation in the Gateway, each API request will carry a digitally signed JWT, which is in the following format to the backend service.

{token header}.{claims list}.{signature}

When the request goes through the Gateway, the backend JWT is appended as a transport header to the outgoing message. The backend service fetches the JWT and retrieves the required information about the user, application, or token.

Sample JWT

The following is an example of a JWT:

{
    "typ":"JWT",
    "alg":"NONE"
    }{
    "iss":"wso2.org/products/am",
    "exp":1345183492181,
    "http://wso2.org/claims/subscriber":"admin",
    "http://wso2.org/claims/applicationname":"app2",
    "http://wso2.org/claims/apicontext":"/placeFinder",
    "http://wso2.org/claims/version":"1.0.0",
    "http://wso2.org/claims/tier":"Silver",
    "http://wso2.org/claims/enduser":"sumedha"
    }

The above JSON Web Token (JWT) contains the following information.

JWT Header : The header section declares that the encoded object is a JWT access token and the JWT is in plain text, that is not signed using any encryption algorithm.

JWT Claims set :

  • "iss" - The issuer of the JWT
  • "exp" - The token expiration time
  • "http://wso2.org/claims/subscriber" - Subscriber to the API, usually the app developer
  • " http://wso2.org/claims/applicationname" - Application through which API invocation is done
  • " http://wso2.org/claims/apicontext" - Context of the API
  • " http://wso2.org/claims/version " - API version
  • " http://wso2.org/claims/tier" - Tier/price band for the subscription
  • " http://wso2.org/claims/enduser" - End-user of the app who's action invoked the AP

Changing the JWT encoding to Base64URL encoding

The default backend JWT generator, org.wso2.carbon.apimgt.impl.token.JWTGenerator, encodes the value of the JWT using Base64 encoding. However, for certain apps you might need to have it in Base64URL encoding.

Use the following format to encode the JWT using Base64URL encoding, by adding the base64url in the apim.jwt.encoding element, which is in the <API-M_HOME>/repository/conf/deployment.toml file.

[apim.jwt]
...
encoding = "base64url"

Expiry time of the JWT

The JWT expiry time depends directly on whether caching is enabled in the Gateway Manager or Key Manager. The WSO2 API-M Gateway caching is enabled by default. However, if required, you can enable or disable the caching for the Gateway Manager or the Key Manager using the apim.cache.gateway_token.enable or apim.cache.km_token.enable elements respectively in the <API-M_HOME>/repository/conf/deployment.toml file. If caching is enabled for the Gateway Manager or the Key Manager, the JWT expiry time will be the same as the default cache expiry time.

The claims that are retrieved for the JWT access token generation are cached. You can set the expiry time of these JWT claims by setting the apim.cache.jwt_claim.expiry_time in the <API-M_HOME>/repository/conf/deployment.toml file:

[apim.cache.jwt_claim]
enable = true
expiry_time = "900"

Enabling the default backend JWT generator

Before passing end user attributes, you need to enable and configure the JWT implementation, as mentioned below in the default API Gateway.

  1. Navigate to the <API-M_HOME>/resources/conf/config.toml file.

  2. Enable and configure the JWT implementation.

    For more information, see JWT generation configuration details.

  3. Start WSO2 API Manager.

    This will start WSO2 API Manager in the all-in-one mode, which includes the default Gateway as well.

Enabling a customized backend JWT generator

Note

WSO2 API Manager comes with the default JWT generator. This JWT generator will generate specific claims based on the specifications and the user demands at the time the product is released. When you update the products, you will need to add/change some of the claims based on the specification updates. This means that even with the given released version, standard claims that come from the API Manager are subjected to change. Therefore, if you have planned to use specific claims in the backend, it is always recommended to implement a custom JWT generator with mandatory claims you wish to consume at your backend

Customizing the JWT Generation completely

The JWT that is generated by default (see example above) has predefined attributes that are passed to the backend. These include basic application-specific details, subscription details, and user information that are defined in the JWT generation class that comes with WSO2 API Manager by the name org.wso2.carbon.apimgt.keymgt.token.JWTGenerator

Follow the instructions below if you want to pass additional attributes to the backend with the JWT or completely change the default JWT generation logic:

  1. Write your own custom JWT implementation class by extending the default JWTGenerator class.

    A typical example of implementing your own claim generator is given below. It implements the populateCustomClaims() method to generate some custom claims and adds them to the JWT.

    import org.wso2.carbon.apimgt.keymgt.APIConstants;
    import org.wso2.carbon.apimgt.keymgt.dto.APIKeyValidationInfoDTO;
    import org.wso2.carbon.apimgt.keymgt.token.JWTGenerator;
    import org.wso2.carbon.apimgt.api.*;
    
    import java.util.Map;
    
    public class CustomTokenGenerator extends JWTGenerator {
        public Map<String, String> populateStandardClaims(TokenValidationContext validationContext)
                throws APIManagementException {
            Map<String, String> claims = super.populateStandardClaims(validationContext);
            boolean isApplicationToken =
                    validationContext.getValidationInfoDTO().getUserType().equalsIgnoreCase(APIConstants.ACCESS_TOKEN_USER_TYPE_APPLICATION) ? true : false;
            String dialect = getDialectURI();
            if (claims.get(dialect + "/enduser") != null) {
                if (isApplicationToken) {
                    claims.put(dialect + "/enduser", "null");
                    claims.put(dialect + "/enduserTenantId", "null");
                } else {
                    String enduser = claims.get(dialect + "/enduser");
                    if (enduser.endsWith("@carbon.super")) {
                        enduser = enduser.replace("@carbon.super", "");
                        claims.put(dialect + "/enduser", enduser);
                    }
                }
            }
            return claims;
        }
    
        public Map<String, String> populateCustomClaims(TokenValidationContext tokenValidationContext) throws APIManagementException {
            Long time = System.currentTimeMillis();
            String text = "This is custom JWT";
            Map map = new HashMap();
            map.put("current_timestamp", time.toString());
            map.put("messge" , text);
            return map;
        }
    }

    Click here for a sample Custom JWT Generator.

  2. Build your class and add the JAR file to the <API-M_HOME>/repository/components/lib directory where the node works as the Key Manager node.

  3. Add your class in the apim.jwt.generator_impl element of the <API-M_HOME>/repository/conf/deployment.toml file.

    [apim.jwt]
    ...
    generator_impl = "org.wso2.carbon.test.CustomTokenGenerator"
  4. Set the apim.jwt.enable element to true in the deployment.toml file.

  5. Start WSO2 API Manager.

    This will start WSO2 API Manager in the all-in-one mode, which includes the default Gateway as well.

The JWT contains the list of user claims added when you enable the apim.jwt.enable_user_claims to true via the user store.

Follow the instructions below to change the existing functionality of retrieving end user related claims to the JWT:

  1. Write your own Claim Retriever implementation by implmenting org.wso2.carbon.apimgt.impl.token.ClaimsRetriever.

    package org.wso2.carbon.test;
    
    import org.wso2.carbon.apimgt.api.APIManagementException;
    import org.wso2.carbon.apimgt.impl.token.ClaimsRetriever;
    
    import java.util.SortedMap;
    import java.util.TreeMap;
    import java.util.UUID;
    
    public class CustomClaimRetriever implements ClaimsRetriever {
    
        public void init() throws APIManagementException {
        //  Todo : initialize any variable for Claim retriever.
        }
    
        public SortedMap<String, String> getClaims(String endUserName) throws APIManagementException {
    
            SortedMap<String, String> claimsMap = new TreeMap();
            claimsMap.put("token-uuid", UUID.randomUUID().toString());
            if ("user1".equals(endUserName)){
                claimsMap.put("privileged", "true");
            }
            return claimsMap;
        }
    
        public String getDialectURI(String s) throws APIManagementException {
    
            return "http://wso2.org/claims";
        }
    }

    Click here for a sample Custom Claim Retriever.

  2. Build your class and JAR file in the <API-M_HOME>/repository/components/lib directory where the node works as the Key Manager node.

  3. Set the apim.jwt.claims_extractor_impl to you class name.

    [apim.jwt]
    ....
    claims_extractor_impl="org.wso2.carbon.test.CustomClaimRetriever"
    ....

  4. Start WSO2 API Manager.

    This will start WSO2 API Manager in the all-in-one mode, which includes the default Gateway as well.

Backend JWT generator configuration details

Note

Enable JWT in all Gateway nodes. For more information on setting up a distributed deployment of API Manager, see Deploying WSO2 API-M in a Distributed Setup

Element Description Default Value
apim.jwt.enable
Uncomment this property and set this value to true to enable JWT. false
apim.jwt.header
The name of the HTTP header to which the JWT is attached. X-JWT-Assertion
apim.jwt.enable_user_claims
Uncomment this property and set this value to true to enable user claims in JWT in opaque Token false
apim.jwt.claims_extractor_impl
Uncomment this configuration and configure custom Claim Retriever to add custom claims into JWT when invocation token in opaque mode. org.wso2.carbon.apimgt.impl.token.DefaultClaimsRetriever
apim.jwt.claim_dialect

The dialect URI under which the user's claims are be looked for. Only works with the default value of the apim.jwt.claims_extractor_impl element defined above.

The JWT access token contains all claims that are defined in the apim.jwt.claim_dialect element. The default value of this element is http://wso2.org/claims. To get the list of a specific user's claims that need to be included in the JWT, simply uncomment this element after enabling the JWT. It will include all claims in http://wso2.org/claims to the JWT access token.

http://wso2.org/claims
apim.jwt.convert_dialect

In the Authorization code grant flow, backend JWT token contains claims from OIDC dialect even though apim.jwt.claim_dialect has been configured with the value http://wso2.org/claims. The reason is that claims are taken from AuthorizationGrantCache, which contains the OIDC claim dialect values. And this is happening due to a modification done to avoid the getUserClaimValues call to WSO2 user store during JWT generation. So, AuthorizationGrantCache is used for retrieving user claims.

In order to remap the OIDC claims into the configured dialect (by apim.jwt.claim_dialect value ), the apim.jwt.convert_dialect configuration value should be set to true.

false
apim.jwt.signing_algorithm

The signing algorithm used to sign the JWT. The general format of the JWT is {token infor}.{claims list}.{signature}. When NONE is specified as the algorithm, signing is turned off and the JWT looks as {token infor}.{claims list} with two strings delimited by a period and a period at the end.

This element can have only two values - the default values are `SHA256withRSA` or `NONE`.

SHA256withRSA
apim.jwt.gateway_generator.impl

Fully qualified custom JWT generator to used in JWT(Self Contained) Access Tokens

org.wso2.carbon.apimgt.gateway.handlers.security.jwt.generator.APIMgtGatewayJWTGeneratorImpl
apim.jwt.gateway_generator.excluded_claims

List of claims that are not supposed to be included in the Backend JWT when using JWT (Self Contained) Access Tokens

N/A

Tip

You can use TCPMon or API Gateway debug logs to capture the JWT access token header with end user details. Follow the instructions below to enable the Gateway DEBUG logs for wire messages:

  1. Go to the <APIM_GATEWAY>/repository/conf directory and open the log4j2.properties file with a text editor.
  2. Add these two loggers to the list of loggers:
    loggers = AUDIT_LOG, trace-messages,... , synapse-headers, synapse-wire

See Also

If you want to learn how you can pass end user attributes to the backend when working with Choreo Connect, see Passing Enduser Attributes to the Backend, which is under the Choreo Connect documentation section.

Top