Encrypting OAuth2 Tokens

MWARE ESB provides the capability to encrypt OAuth2 tokens (OAuth2 access tokens, refresh tokens, consumer secrets, authorization codes, or any other OAuth2 key) using the primary keystore. The result is encoded in Base64 and stored in the database.

Info

Symmetric Encryption is a form of encryption where the same key is used to encrypt and decrypt the message along with a mathematical algorithm. As long as both sender and recipient know the secret key, they can encrypt and decrypt all messages that use this key.

Warning

It is recommended to switch this configuration on/off before any keys have been generated in your system . Once token encryption is switched on, the system encrypts all sensitive OAuth2.0 data such as Access Tokens, Consumer Secrets, etc. When reading that information, the system assumes that they are in the encrypted format and attempts to decrypt them. Therefore, switching this configuration on after any keys are created would break the system, unless the data is converted back into plain text.

Follow the steps below to enable OAuth2 token encryption

  1. Stop the ESB server if it is already running.

  2. Open the <API-M_HOME>/repository/conf/deployment.toml file, uncomment the following configuration and set the enable_token_encryption value to be true. 

    [apim.oauth_config]
enable_token_encryption = true

    Note

    By default, MWARE ESB uses RSA/ECB/OAEPwithSHA1andMGF1Padding algorithm for token encryption. If you want to change the algorithm, please add following configuration to deployment.toml, specifying the preferred algorithm.

    [system.parameter]
"org.wso2.CipherTransformation" = "<Algorithm>"

  3. Start the server.

  4. Follow the Generate Application Keys guide to create a new application, generate application consumer keys, and to obtain an access token.

    Tip

Top