Name

CryptoHeaderFilter — encrypt, decrypt headers

Description

Encrypts or decrypts headers in a request or response.

Usage

{
     "name": string,
     "type": "CryptoHeaderFilter",
     "config": {
         "messageType": string,
         "operation": string,
         "algorithm": string,
         "key": string,
         "keyType": string,
         "headers": [ string, ... ]
     }
}

Properties

"messageType": string, required

Indicates the type of message in the exchange to encrypt or decrypt headers, form parameters or cookies. Must be one of: "REQUEST", "RESPONSE".

"operation": string, required

Indicates whether to encrypt or decrypt. Must be one of: "ENCRYPT", "DECRYPT".

"algorithm": string, required

Algorithm used for encryption and decryption. Defaults to DES/ECB/NoPadding.

"key": string, required

Base64 encoded key value.

"headers": array of strings, optional

The names of header fields to encrypt or decrypt.

Example

{
     "name": "DecryptReplayPasswordFilter",
     "type": "CryptoHeaderFilter",
     "config": {
         "messageType": "REQUEST",
         "operation": "DECRYPT",
         "algorithm": "DES/ECB/NoPadding",
         "keyType": "DES",
         "key": "oqdP3DJdE1Q=",
         "headers": [ "replaypassword" ]
}

Javadoc

org.forgerock.openig.filter.CryptoHeaderFilter