encrypt

Encrypts a value with the given algorithm and key. The result will contain "data" and "iv".

Field Configurations

Key	Type	Description	Default Value
"params" (required)	Object	undefined	null

Parameters

Key	Type	Description	Default Value
"algorithm" (required)	String	The algorithm to use for this encryption.	null
"async"	Boolean	Specifies whether the action should perform asynchronously.	null
"input" (required)	String	The input to encrypt.	null
"inputEncoding" (required)	String	The encoding of the input.	null
"key" (required)	String	The key to use for this encryption.	null
"keyEncoding"	String	The encoding of the key.	null
"onError"	String	Event that will be fired if the encryption was successfull.	null
"onErrorType"	OnErrorType	Type of event that will be fired on error.	null
"onSuccess"	String	Event that will be fired if the encryption was successfull.	null
"onSuccessType"	OnSuccessType	Type of event that will be fired on success.	null
"outputEncoding"	String	The encoding for the output.	null
"useDefaultSalt"	Boolean	Determines if the default key salt should be used for the key. If not, the key must be a valid AES key.	null

Inherited

From Base Action

Base Action

Field Configurations

Key	Type	Description	Default Value
"dynamicParams"	Object	Dynamic params to retrieve data from a specific context e.g. a userSetting.	null
"leadingDelimiter"	String	The leading mustache delimiter to use.	null
"params"	Object,Array	Object containing the properties of the action.	null
"trailingDelimiter"	String	The trailing mustache delimiter to use.	null
"type"	String	Type name of the action.	null

Examples

Example 1: Encrypt text with a password

Show ExampleHide Example

Goal: Encrypt text, like a JWT, with a password to savely store it.

Enrypt the given text using the password. On success, the encrypted text is stored base64 encoded in encryptedData.data and the IV is stored base64 encoded in encryptedData.iv.

{
  "type": "encrypt",
  "leadingDelimiter": "{$",
  "trailingDelimiter": "$}",
  "dynamicParams": {
    "jwt": {
      "context": "variable",
      "field": "jwt"
    },
    "password": {
      "context": "namedForm",
      "field": "login:password"
    }
  },
  "params": {
    "algorithm": "AES",
    "input": "{$jwt$}",
    "key": "${password$}",
    "inputEncoding": "utf8",
    "keyEncoding": "utf8",
    "useDefaultSalt": true,
    "outputEncoding": "base64",
    "onSuccessType": "return",
    "onSuccess": "encryptedData"
  }
}