IPWorks Auth 2020 JavaScript Edition

Questions / Feedback?

EncryptionAlgorithm Property

The key encryption algorithm.

Syntax


 getEncryptionAlgorithm(): JwtEncryptionAlgorithms;

 setEncryptionAlgorithm(encryptionAlgorithm: JwtEncryptionAlgorithms): void;

enum JwtEncryptionAlgorithms { eaRSA1_5, eaRSA_OAEP, eaRSA_OAEP_256, eaA128KW, eaA192KW, eaA256KW, eaDir, eaECDH_ES, eaECDH_ES_A128KW, eaECDH_ES_A192KW, eaECDH_ES_A256KW, eaA128GCMKW, eaA192GCMKW, eaA256GCMKW, eaPBES2_HS256_A128KW, eaPBES2_HS384_A192KW, eaPBES2_HS512_A256KW }

Default Value

0

Remarks

This property specifies the algorithm used to encrypt the randomly generated content encryption key.

When using an AES algorithm Key must be specified. When using an RSA or ECDH algorithm RecipientCert must be specified. When using a PBES algorithm KeyPassword must be specified;. Possible values are:

AlgorithmDescriptionKey Location
0 (eaRSA1_5 - default) RSAES-PKCS1-v1_5 Certificate
1 (eaRSA_OAEP) RSAES OAEP using default parameters Certificate
2 (eaRSA_OAEP_256) RSAES OAEP using SHA-256 and MGF1 with SHA-256 Certificate
3 (eaA128KW) AES Key Wrap with default initial using 128-bit key Key
4 (eaA192KW) AES Key Wrap with default initial using 192-bit key Key
5 (eaA256KW) AES Key Wrap with default initial using 256-bit key Key
6 (eaDir) Direct use of a shared symmetric key as the CEK Key
7 (eaECDH_ES) Elliptic Curve Ephemeral Static key agreement using Concat KDF Certificate
8 (eaECDH_ES_A128KW) ECDH-ES using Concat KDF and CEK wrapped with A128KW Certificate
9 (eaECDH_ES_A192KW) ECDH-ES using Concat KDF and CEK wrapped with A192KW Certificate
10 (eaECDH_ES_A256KW) ECDH-ES using Concat KDF and CEK wrapped with A256KW Certificate
11 (eaA128GCMKW) Key wrapping with AES GCM using 128-bit key Key
12 (eaA192GCMKW) Key wrapping with AES GCM using 192-bit key Key
13 (eaA256GCMKW) Key wrapping with AES GCM using 256-bit key Key
14 (eaPBES2_HS256_A128KW) PBES2 with HMAC SHA-256 and A128KW KeyPassword
15 (eaPBES2_HS384_A192KW) PBES2 with HMAC SHA-384 and A192KW KeyPassword
16 (eaPBES2_HS512_A256KW) PBES2 with HMAC SHA-512 and A256KW KeyPassword

When set to an ECDH algorithm the following settings are also applicable:

When set to a PBES algorithm the following settings are also applicable:

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks Auth 2020 JavaScript Edition - Version 20.0 [Build 7721]