# JWE Component Create, Encrypt and Decrypt JSON Web Encryption (JWE) messages. ## Syntax ```text nsoftware.IPWorksEncrypt.JWE ``` ## Remarks The JWE component supports encrypting and decrypting JSON Web Encryption (JWE) messages. Specify any payload via input properties and use [Encrypt](#encrypt-method-jwe-component) to create a JWE message using a variety of algorithms including ECDH, RSA, and AES. Use [Decrypt](#decrypt-method-jwe-component) to decrypt the payload of any received JWE message. The following algorithms are supported: - RSA1_5 - RSA-OAEP - RSA-OAEP-256 - A128KW - A192KW - A256KW - Direct - ECDH-ES - ECDH-ES+A128KW - ECDH-ES+A192KW - ECDH-ES+A256KW - A128GCMKW - A192GCMKW - A256GCMKW - PBES2-HS256+A128KW - PBES2-HS384+A192KW - PBES2-HS512+A256KW See [EncryptionAlgorithm](#encryptionalgorithm-property-jwe-component) for more details about supported algorithms. ## Encrypting The [Encrypt](#encrypt-method-jwe-component) method may be used to encrypt a payload with a variety of algorithms. JSON Web Encryption (JWE) is performed by first generating a random key used to encrypt the content. The content encryption key is used to encrypt the content using the algorithm specified by [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwe-component). The content encryption key is then encrypted itself using the algorithm specified by [EncryptionAlgorithm](#encryptionalgorithm-property-jwe-component). The content encryption key is not directly exposed in the API as it is randomly generated. After calling this method the compact serialized JWE string is written to the specified output location. For instance: *eyJhbGciOiJBMjU2R0NNS1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiaXYiOiJMa0tNeTZ5Qlpfbzh6QW92IiwidGFnIjoiSmpMTkRsV3l3bWt3V2pMa0NLU0xxQSJ9.wiwySYm6fXZre-3IdT1tb_02KMQDrMICwUawVf7Gjhc.k84s7ne8J41QnA5BQ31k_A.kjIveRjjNYV4x92CVE9Agw.uAygkyeO2KWeFQIy9JLU0A* The component is agnostic of the payload that is encrypted. Any value may be encrypted. [KeyId](#keyid-property-jwe-component) may be set to include an identifier to help the receiving party identify the key or certificate used to encrypt the data. The following properties are applicable when calling this method: - [EncryptionAlgorithm](#encryptionalgorithm-property-jwe-component) (required) - [Key](#key-property-jwe-component) (conditional - required for AES) - [KeyPassword](#keypassword-property-jwe-component) (conditional - required for PBES) - [Certificate](#certificate-property-jwe-component) (conditional - required for ECDH and RSA) - [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwe-component) - [CompressionAlgorithm](#CompressionAlgorithm) - [HeaderParams](#headerparams-property-jwe-component) - [Overwrite](#overwrite-property-jwe-component) **Input and Output Properties** The component will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [SetInputStream](#setinputstream-method-jwe-component) - [InputFile](#inputfile-property-jwe-component) - [InputMessage](#inputmessage-property-jwe-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-jwe-component) - [OutputFile](#outputfile-property-jwe-component) - [OutputMessage](#outputmessage-property-jwe-component): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). **Notes for AES Algorithms (A128KW, A192KW, A256KW, A128GCMKW, A192GCMKW, A256GCMKW)** When [EncryptionAlgorithm](#encryptionalgorithm-property-jwe-component) is set to a AES algorithm [Key](#key-property-jwe-component) must be set to a key of appropriate length for the algorithm. For instance a 256 bit key would be used for A256KW. The example below uses the [EzRand](EzRand.md#EzRand) component to generate a key, but the key may be created using any method. The key must be known by both parties in order for encryption and decryption to take place. ```csharp //Generate a 256 bit (32 byte) key Ezrand rand = new Ezrand(); rand.RandBytesLength = 32; rand.GetNextBytes(); byte[] key = rand.RandBytesB; //Encrypt the payload using A256KW Jwe jwe = new Jwe(); jwe.KeyB = key; jwe.InputMessage = "test data"; jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaA256KW; jwe.Encrypt(); string encryptedData = jwe.OutputMessage; ``` To use an existing AES key provide the bytes to the [Key](#key-property-jwe-component) property. For instance: ```csharp byte[] key = new byte[] { 164, 60, 194, 0, 161, 189, 41, 38, 130, 89, 141, 164, 45, 170, 159, 209, 69, 137, 243, 216, 191, 131, 47, 250, 32, 107, 231, 117, 37, 158, 225, 234 }; //Encrypt the payload using A256KW Jwe jwe = new Jwe(); jwe.KeyB = key; jwe.InputMessage = "test data"; jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaA256KW; jwe.Encrypt(); string encryptedData = jwe.OutputMessage; ``` **Notes for RSA Algorithms (RSA1_5, RSA-OEAP, RSA-OAEP-256)** The RSA based algorithms use asymmetric encryption. Encrypting is done with a public key and decryption is done with a private key. The public certificate should be in PEM (base64) format. For instance: ```csharp Jwe jwe = new Jwe(); jwe.Certificate = new Certificate("..\\recipient.cer"); jwe.InputMessage = "test data"; jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaRSA_OAEP; jwe.Encrypt(); string encryptedData = jwe.OutputMessage; ``` **Notes for ECDH Algorithms (ECDH-ES, ECDH-ES+A128KW, ECDH-ES+A192KW, ECDH-ES+A256KW)** ECDH algorithms require a valid ECC public key to encrypt the message. If the key was originally created with the ECC component the PEM encoded *PublicKey* may be used directly with the [Certificate](#certificate-property-jwe-component) property. An example PEM encoded public certificate created by the ECC component: ```text -----BEGIN PUBLIC KEY----- MIIBMjCB7AYHKoZIzj0CATCB4AIBATAsBgcqhkjOPQEBAiEA/////wAAAAEAAAAAAAAAAAAA AAD///////////////8wRAQg/////wAAAAEAAAAAAAAAAAAAAAD///////////////wEIFrG NdiqOpPns+u9VXaYhrxlHQawzFOw9jvOPD4n0mBLBEEEaxfR8uEsQkf4vOblY6RA8ncDfYEt 6zOg9KE5RdiYwpZP40Li/hp/m47n60p8D54WK84zV2sxXs7LtkBoN79R9QIhAP////8AAAAA //////////+85vqtpxeehPO5ysL8YyVRAgEBA0EEIC5rbLp11Mnz6cBXLLriaDIov3rm8RAY x/OR0bOKiff0cQy+sLVaxjseqFk/+Xvl4ORSv5Z6HdHv5GyEpA0UoA== -----END PUBLIC KEY----- ``` ```csharp Jwe jwe = new Jwe(); jwe.Certificate = new Certificate(CertStoreTypes.cstPublicKeyFile, pubKeyFile, "", "*"); jwe.InputMessage = "test data"; jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaECDH_ES_A256KW; jwe.Encrypt(); string encryptedData = jwe.OutputMessage; ``` To use an ECC public key created by other means the ECC component may be used to import the key parameters. Populate the *Rx* and *Ry* properties of the ECC component first to obtain the PEM formatted public key. For instance: ```csharp byte[] x_bytes = new byte[] { 171, 170, 196, 151, 94, 196, 231, 12, 128, 232, 17, 61, 45, 105, 41, 209, 192, 187, 112, 242, 110, 178, 95, 240, 36, 55, 83, 171, 190, 176, 78, 13 }; byte[] y_bytes = new byte[] { 197, 75, 134, 245, 245, 28, 199, 9, 7, 117, 1, 54, 49, 178, 135, 252, 62, 89, 35, 180, 117, 80, 231, 23, 110, 250, 28, 124, 219, 253, 224, 156 }; Ecc ecc = new Ecc(); ecc.Key.RxB = x_bytes; ecc.Key.RyB = y_bytes; string pubKey = ecc.Key.PublicKey; Jwe jwe = new Jwe(); jwe.Certificate = new Certificate(CertStoreTypes.cstPublicKeyFile, pubKey, "", "*"); jwe.InputMessage = "test data"; jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaECDH_ES_A256KW; jwe.Encrypt(); string encryptedData = jwe.OutputMessage; ``` **Notes for PBES Algorithms (PBES2-HS256+A128KW, PBES2-HS384+A192KW, PBES2-HS512+A256KW** PBES algorithms derive a content encryption key from the [KeyPassword](#keypassword-property-jwe-component) property. Set [KeyPassword](#keypassword-property-jwe-component) to a shared secret. ```csharp Jwe jwe = new Jwe(); jwe.KeyPassword = "secret"; jwe.InputMessage = "test data"; jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaPBES2_HS512_A256KW; jwe.Encrypt(); string encryptedData = jwe.OutputMessage; ``` **Notes for Direct Shared Keys** When [EncryptionAlgorithm](#encryptionalgorithm-property-jwe-component) is set to *Direct* the [Key](#key-property-jwe-component) property must be set to a valid symmetric key that will be used directly by the [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwe-component). In this case a content encryption key is not generated randomly, the [Key](#key-property-jwe-component) is used instead. The length of the specified [Key](#key-property-jwe-component) must be valid for the selected [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwe-component). For instance: ```csharp //Generate a 256 bit (32 byte) key Ezrand rand = new Ezrand(); rand.RandBytesLength = 32; rand.GetNextBytes(); byte[] key = rand.RandBytesB; Jwe jwe = new Jwe(); jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaDir; jwe.ContentEncryptionAlgorithm = JweContentEncryptionAlgorithms.ceaA256GCM; jwe.KeyB = key; jwe.InputMessage = "test data"; jwe.Encrypt(); string encryptedData = jwe.OutputMessage; ``` ## Decrypting The [Decrypt](#decrypt-method-jwe-component) method may be used to decrypt a received JWE message. Before calling the [Decrypt](#decrypt-method-jwe-component) method set [InputMessage](#inputmessage-property-jwe-component) or [InputFile](#inputfile-property-jwe-component) to a valid compact serialized JWE string. For instance: *eyJhbGciOiJBMjU2R0NNS1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiaXYiOiJMa0tNeTZ5Qlpfbzh6QW92IiwidGFnIjoiSmpMTkRsV3l3bWt3V2pMa0NLU0xxQSJ9.wiwySYm6fXZre-3IdT1tb_02KMQDrMICwUawVf7Gjhc.k84s7ne8J41QnA5BQ31k_A.kjIveRjjNYV4x92CVE9Agw.uAygkyeO2KWeFQIy9JLU0A* The type and format of the private key depends on the algorithm used to encrypt the data. The following table summarizes the relationship: | | | | --- | --- | | Algorithm | Private Key Location | | AES | [Key](#key-property-jwe-component) | | RSA and ECDH | [Certificate](#certificate-property-jwe-component) | | PBES | [KeyPassword](#keypassword-property-jwe-component) | If the correct [Key](#key-property-jwe-component) or [Certificate](#certificate-property-jwe-component) is not known ahead of time the *KeyId* parameter of the [RecipientInfo](#recipientinfo-event-jwe-component) event may be used to identify the correct key. If this method returns without error decryption was successful. If decryption fails then this method throws an exception. After calling this method the payload will be present in the [OutputMessage](#outputmessage-property-jwe-component) or file specified by [OutputFile](#outputfile-property-jwe-component) and the [HeaderParams](#headerparams-property-jwe-component) property will contain the headers. Headers of the parsed message are also available through the [HeaderParam](#headerparam-event-jwe-component) event. The following properties are applicable when calling this method: - [Certificate](#certificate-property-jwe-component) (conditional - required for RSA and ECDH) - [Key](#key-property-jwe-component) (conditional - required for AES) - [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwe-component) (only if [StrictValidation](#StrictValidation) is True) - [EncryptionAlgorithm](#encryptionalgorithm-property-jwe-component) (only if [StrictValidation](#StrictValidation) is True) - [HeaderParams](#headerparams-property-jwe-component) - [Overwrite](#overwrite-property-jwe-component) - [StrictValidation](#StrictValidation) **Input and Output Properties** The component will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [SetInputStream](#setinputstream-method-jwe-component) - [InputFile](#inputfile-property-jwe-component) - [InputMessage](#inputmessage-property-jwe-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-jwe-component) - [OutputFile](#outputfile-property-jwe-component) - [OutputMessage](#outputmessage-property-jwe-component): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). **Notes for AES Algorithms (A128KW, A192KW, A256KW, A128GCMKW, A192GCMKW, A256GCMKW)** To decrypt messages that use AES encryption [Key](#key-property-jwe-component) must be set to a key of appropriate length for the algorithm. For instance a 256 bit key would be used for A256KW. The key must be known by both parties in order for encryption and decryption to take place. ```csharp byte[] key = new byte[] { 164, 60, 194, 0, 161, 189, 41, 38, 130, 89, 141, 164, 45, 170, 159, 209, 69, 137, 243, 216, 191, 131, 47, 250, 32, 107, 231, 117, 37, 158, 225, 234 }; Jwe jwe = new Jwe(); jwe.KeyB = key; jwe.InputMessage = encryptedData; jwe.Decrypt(); string decryptedData = jwe.OutputMessage; ``` **Notes for RSA Algorithms (RSA1_5, RSA-OEAP, RSA-OAEP-256)** The RSA based algorithms use asymmetric encryption. Encrypting is done with a public key and decryption is done with a private key. The certificate with private key must be specified. For instance: ```csharp Jwe jwe = new Jwe(); jwe.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "..\\jwt.pfx", "password", "*"); jwe.InputMessage = encryptedData; jwe.Decrypt(); string decryptedData = jwe.OutputMessage; ``` **Notes for ECDH Algorithms (ECDH-ES, ECDH-ES+A128KW, ECDH-ES+A192KW, ECDH-ES+A256KW)** ECDH algorithms require a valid ECC private key to decrypt the message. If the key was originally created with the ECC component the PEM encoded *PrivateKey* may be used directly with the [Certificate](#certificate-property-jwe-component) property. ```csharp Jwe jwe = new Jwe(); jwe.Certificate = new Certificate(CertStoreTypes.cstPEMKeyFile, privKeyFile, "", "*"); jwe.InputMessage = encryptedData; jwe.Decrypt(); string decryptedData = jwe.OutputMessage; ``` To use an ECC private key created by other means the ECC component may be used to import the key parameters. Populate the *Rx*, *Ry*, and *KB* properties of the ECC component first to obtain the PEM formatted public key. For instance: ```csharp Ecc ecc = new Ecc(); byte[] x_bytes = new byte[] { 171, 170, 196, 151, 94, 196, 231, 12, 128, 232, 17, 61, 45, 105, 41, 209, 192, 187, 112, 242, 110, 178, 95, 240, 36, 55, 83, 171, 190, 176, 78, 13 }; byte[] y_bytes = new byte[] { 197, 75, 134, 245, 245, 28, 199, 9, 7, 117, 1, 54, 49, 178, 135, 252, 62, 89, 35, 180, 117, 80, 231, 23, 110, 250, 28, 124, 219, 253, 224, 156 }; byte[] k_bytes = new byte[] { 81, 65, 201, 24, 235, 249, 162, 148, 169, 150, 109, 181, 61, 238, 145, 122, 31, 30, 151, 94, 239, 90, 222, 217, 63, 103, 54, 2, 176, 232, 248, 168 }; ecc.Key.RxB = x_bytes; ecc.Key.RyB = y_bytes; ecc.Key.KB = k_bytes; string privKey = ecc.Key.PrivateKey; Jwe jwe = new Jwe(); jwe.Certificate = new Certificate(CertStoreTypes.cstPEMKeyBlob, privKey, "", "*"); jwe.InputMessage = encryptedData; jwe.Decrypt(); string decryptedData = jwe.OutputMessage; ``` **Notes for PBES Algorithms (PBES2-HS256+A128KW, PBES2-HS384+A192KW, PBES2-HS512+A256KW** PBES algorithms derive a content encryption key from the [KeyPassword](#keypassword-property-jwe-component) property. Set [KeyPassword](#keypassword-property-jwe-component) to the shared secret. ```csharp Jwe jwe = new Jwe(); jwe.KeyPassword = "secret"; jwe.InputMessage = encryptedData; jwe.Decrypt(); string decryptedData = jwe.OutputMessage; ``` **Notes for Direct Shared Keys** When Direct encryption is used the [Key](#key-property-jwe-component) property must be set to a valid symmetric key that will be used directly by the [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwe-component). For instance: ```csharp byte[] key = new byte[] { 164, 60, 194, 0, 161, 189, 41, 38, 130, 89, 141, 164, 45, 170, 159, 209, 69, 137, 243, 216, 191, 131, 47, 250, 32, 107, 231, 117, 37, 158, 225, 234 }; Jwe jwe = new Jwe(); jwe.KeyB = key; jwe.InputMessage = encryptedData; jwe.Decrypt(); string decryptedData = jwe.OutputMessage; ``` ## Other Functionality In addition to standard encrypting and decrypting the component also supports a variety of other features including: - Adding custom header parameters with [AddHeaderParam](#addheaderparam-method-jwe-component) - Enforcing algorithm restrictions when decrypting by setting [StrictValidation](#StrictValidation) - Inspect the JWE headers without decrypting by calling [Parse](#parse-method-jwe-component) ## Property List *The following is the full list of the properties of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Certificate](#certificate-property-jwe-component) | The certificate used for encryption or decryption. | | [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwe-component) | The algorithm used to encrypt the content. | | [EncryptionAlgorithm](#encryptionalgorithm-property-jwe-component) | The key encryption algorithm. | | [HeaderParams](#headerparams-property-jwe-component) | The JOSE header parameters. | | [InputFile](#inputfile-property-jwe-component) | The file to process. | | [InputMessage](#inputmessage-property-jwe-component) | The message to process. | | [Key](#key-property-jwe-component) | The secret key for the AES algorithm. | | [KeyId](#keyid-property-jwe-component) | The Id of the key used to encrypt the message. | | [KeyPassword](#keypassword-property-jwe-component) | The key password used in the PBES algorithm. | | [OutputFile](#outputfile-property-jwe-component) | The output file when encrypting or decrypting. | | [OutputMessage](#outputmessage-property-jwe-component) | The output message after processing. | | [Overwrite](#overwrite-property-jwe-component) | Indicates whether or not the component should overwrite files. | ## Method List *The following is the full list of the methods of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AddHeaderParam](#addheaderparam-method-jwe-component) | Adds additional header parameters. | | [Config](#config-method-jwe-component) | Sets or retrieves a configuration setting. | | [Decrypt](#decrypt-method-jwe-component) | Decrypts the payload. | | [Encrypt](#encrypt-method-jwe-component) | Encrypts the payload with the specified algorithms. | | [Parse](#parse-method-jwe-component) | Parses the compact serialized JWE string. | | [Reset](#reset-method-jwe-component) | Resets the component. | | [SetInputStream](#setinputstream-method-jwe-component) | Sets the stream from which the component will read data. | | [SetOutputStream](#setoutputstream-method-jwe-component) | Sets the stream to which the component will write data. | ## Event List *The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Error](#error-event-jwe-component) | Fired when information is available about errors during data delivery. | | [HeaderParam](#headerparam-event-jwe-component) | Fires once for each JOSE header parameter. | | [RecipientInfo](#recipientinfo-event-jwe-component) | Fired with information about the recipient key of the encrypted message. | ## Config Settings *The following is a list of config settings for the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [CloseInputStreamAfterProcess](#CloseInputStreamAfterProcess) | Whether to close the input stream after processing. | | [CloseOutputStreamAfterProcess](#CloseOutputStreamAfterProcess) | Whether to close the output stream after processing. | | [CompressionAlgorithm](#CompressionAlgorithm) | The compression algorithm to use. | | [PartyUInfo](#PartyUInfo) | Information about the producer of the message. | | [PartyVInfo](#PartyVInfo) | Information about the recipient of the message. | | [PBES2Count](#PBES2Count) | The PBKDF2 iteration count. | | [PBES2SaltLength](#PBES2SaltLength) | The salt input value length. | | [RawHeader](#RawHeader) | Holds the raw JOSE header. | | [StrictValidation](#StrictValidation) | Requires specific algorithm when decrypting. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the component whether or not to use FIPS certified APIs. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # Certificate Property ([JWE](#jwe-component) Component) The certificate used for encryption or decryption. ## Syntax ```text public Certificate Certificate { get; set; } ``` ## Remarks This property specifies a certificate for encryption or decryption. When calling [Encrypt](#encrypt-method-jwe-component) and [EncryptionAlgorithm](#encryptionalgorithm-property-jwe-component) is set to an RSA or ECDH algorithm this property must be set to a public certificate of the recipient. When calling [Decrypt](#decrypt-method-jwe-component) and the message was encrypted using an RSA or ECDH [EncryptionAlgorithm](#encryptionalgorithm-property-jwe-component) this property specifies the certificate with private key used to decrypt the message. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # ContentEncryptionAlgorithm Property ([JWE](#jwe-component) Component) The algorithm used to encrypt the content. ## Syntax ```text public JWEContentEncryptionAlgorithms ContentEncryptionAlgorithm { get; set; } enum JWEContentEncryptionAlgorithms { ceaA128CBC_HS256, ceaA192CBC_HS384, ceaA256CBC_HS512, ceaA128GCM, ceaA192GCM, ceaA256GCM } ``` ## Default Value 0 ## Remarks This property specifies the algorithm used to encrypt the content. The following values are supported. | Algorithm | Description | | --- | --- | | 0 (ceaA128CBC_HS256 - default) | AES_128_CBC_HMAC_SHA_256 authenticated encryption algorithm | | 1 (ceaA192CBC_HS384) | AES_192_CBC_HMAC_SHA_384 authenticated encryption algorithm | | 2 (ceaA256CBC_HS512) | AES_256_CBC_HMAC_SHA_512 authenticated encryption algorithm | | 3 (ceaA128GCM) | AES GCM using 128-bit key | | 4 (ceaA192GCM) | AES GCM using 192-bit key | | 5 (ceaA256GCM) | AES GCM using 256-bit key | # EncryptionAlgorithm Property ([JWE](#jwe-component) Component) The key encryption algorithm. ## Syntax ```text public JWEEncryptionAlgorithms EncryptionAlgorithm { get; set; } enum JWEEncryptionAlgorithms { 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](#key-property-jwe-component) must be specified. When using an RSA or ECDH algorithm [Certificate](#certificate-property-jwe-component) must be specified. When using a PBES algorithm [KeyPassword](#keypassword-property-jwe-component) must be specified;. Possible values are: | Algorithm | Description | Key Location | | --- | --- | --- | | 0 (eaRSA1_5 - default) | RSAES-PKCS1-v1_5 | [Certificate](#certificate-property-jwe-component) | | 1 (eaRSA_OAEP) | RSAES OAEP using default parameters | [Certificate](#certificate-property-jwe-component) | | 2 (eaRSA_OAEP_256) | RSAES OAEP using SHA-256 and MGF1 with SHA-256 | [Certificate](#certificate-property-jwe-component) | | 3 (eaA128KW) | AES Key Wrap with default initial using 128-bit key | [Key](#key-property-jwe-component) | | 4 (eaA192KW) | AES Key Wrap with default initial using 192-bit key | [Key](#key-property-jwe-component) | | 5 (eaA256KW) | AES Key Wrap with default initial using 256-bit key | [Key](#key-property-jwe-component) | | 6 (eaDir) | Direct use of a shared symmetric key as the CEK | [Key](#key-property-jwe-component) | | 7 (eaECDH_ES) | Elliptic Curve Ephemeral Static key agreement using Concat KDF | [Certificate](#certificate-property-jwe-component) | | 8 (eaECDH_ES_A128KW) | ECDH-ES using Concat KDF and CEK wrapped with A128KW | [Certificate](#certificate-property-jwe-component) | | 9 (eaECDH_ES_A192KW) | ECDH-ES using Concat KDF and CEK wrapped with A192KW | [Certificate](#certificate-property-jwe-component) | | 10 (eaECDH_ES_A256KW) | ECDH-ES using Concat KDF and CEK wrapped with A256KW | [Certificate](#certificate-property-jwe-component) | | 11 (eaA128GCMKW) | Key wrapping with AES GCM using 128-bit key | [Key](#key-property-jwe-component) | | 12 (eaA192GCMKW) | Key wrapping with AES GCM using 192-bit key | [Key](#key-property-jwe-component) | | 13 (eaA256GCMKW) | Key wrapping with AES GCM using 256-bit key | [Key](#key-property-jwe-component) | | 14 (eaPBES2_HS256_A128KW) | PBES2 with HMAC SHA-256 and A128KW | [KeyPassword](#keypassword-property-jwe-component) | | 15 (eaPBES2_HS384_A192KW) | PBES2 with HMAC SHA-384 and A192KW | [KeyPassword](#keypassword-property-jwe-component) | | 16 (eaPBES2_HS512_A256KW) | PBES2 with HMAC SHA-512 and A256KW | [KeyPassword](#keypassword-property-jwe-component) | When set to an ECDH algorithm the following settings are also applicable: - [PartyUInfo](#PartyUInfo) - [PartyVInfo](#PartyVInfo) When set to a PBES algorithm the following settings are also applicable: - [PBES2Count](#PBES2Count) - [PBES2SaltLength](#PBES2SaltLength) # HeaderParams Property ([JWE](#jwe-component) Component) The JOSE header parameters. ## Syntax ```text public HeaderParamList HeaderParams { get; } ``` ## Remarks This property specifies the JOSE header parameters. This may be populated before calling Sign or [Encrypt](#encrypt-method-jwe-component). This is populated with the parsed header values after calling Verify, [Decrypt](#decrypt-method-jwe-component), or [Parse](#parse-method-jwe-component). This property is not available at design time. Please refer to the [HeaderParam](#headerparam-type) type for a complete list of fields. # InputFile Property ([JWE](#jwe-component) Component) The file to process. ## Syntax ```text public string InputFile { get; set; } ``` ## Default Value "" ## Remarks This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed. **Input and Output Properties** The component will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [SetInputStream](#setinputstream-method-jwe-component) - InputFile - [InputMessage](#inputmessage-property-jwe-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-jwe-component) - [OutputFile](#outputfile-property-jwe-component) - [OutputMessage](#outputmessage-property-jwe-component): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). # InputMessage Property ([JWE](#jwe-component) Component) The message to process. ## Syntax ```text public string InputMessage { get; set; } public byte[] InputMessageB { get; set; } ``` ## Default Value "" ## Remarks This property specifies the message to be processed. **Input and Output Properties** The component will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [SetInputStream](#setinputstream-method-jwe-component) - [InputFile](#inputfile-property-jwe-component) - InputMessage When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-jwe-component) - [OutputFile](#outputfile-property-jwe-component) - [OutputMessage](#outputmessage-property-jwe-component): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). # Key Property ([JWE](#jwe-component) Component) The secret key for the AES algorithm. ## Syntax ```text public string Key { get; set; } public byte[] KeyB { get; set; } ``` ## Default Value "" ## Remarks This property specifies the key used for AES encryption and decryption. When [EncryptionAlgorithm](#encryptionalgorithm-property-jwe-component) is set to an AES algorithm this property must hold the symmetric key used for encryption and decryption. The size of the key must match the size of the algorithm. For instance when selecting the algorithm *A256GCMKW* (AES 256) the size of the key must also be 256 bits (32 bytes). In the case where [EncryptionAlgorithm](#encryptionalgorithm-property-jwe-component) is set to *Direct* this key is used directly with the algorithm specified by [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwe-component) and must be an appropriate size for the selected [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwe-component). # KeyId Property ([JWE](#jwe-component) Component) The Id of the key used to encrypt the message. ## Syntax ```text public string KeyId { get; set; } ``` ## Default Value "" ## Remarks This property optionally specifies the Id of the key used to encrypt the message. Any string value may be supplied here to help the other party identify the key used to encrypt the message. This may be set before calling the [Encrypt](#encrypt-method-jwe-component) method. # KeyPassword Property ([JWE](#jwe-component) Component) The key password used in the PBES algorithm. ## Syntax ```text public string KeyPassword { get; set; } ``` ## Default Value "" ## Remarks This property specifies the key password used to derive a key when using a PBES [EncryptionAlgorithm](#encryptionalgorithm-property-jwe-component). This is only applicable to PBES algorithms and must be set before calling [Encrypt](#encrypt-method-jwe-component) or [Decrypt](#decrypt-method-jwe-component). # OutputFile Property ([JWE](#jwe-component) Component) The output file when encrypting or decrypting. ## Syntax ```text public string OutputFile { get; set; } ``` ## Default Value "" ## Remarks This property specifies the file to which the output will be written when [Encrypt](#encrypt-method-jwe-component) or [Decrypt](#decrypt-method-jwe-component) is called. This may be set to an absolute or relative path. This property is only applicable to [Encrypt](#encrypt-method-jwe-component) and [Decrypt](#decrypt-method-jwe-component). **Input and Output Properties** The component will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [SetInputStream](#setinputstream-method-jwe-component) - [InputFile](#inputfile-property-jwe-component) - [InputMessage](#inputmessage-property-jwe-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-jwe-component) - OutputFile - [OutputMessage](#outputmessage-property-jwe-component): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). # OutputMessage Property ([JWE](#jwe-component) Component) The output message after processing. ## Syntax ```text public string OutputMessage { get; } public byte[] OutputMessageB { get; } ``` ## Default Value "" ## Remarks This property will be populated with the output from the operation if [OutputFile](#outputfile-property-jwe-component) and [SetOutputStream](#setoutputstream-method-jwe-component) are not set. **Input and Output Properties** The component will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [SetInputStream](#setinputstream-method-jwe-component) - [InputFile](#inputfile-property-jwe-component) - [InputMessage](#inputmessage-property-jwe-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-jwe-component) - [OutputFile](#outputfile-property-jwe-component) - OutputMessage: The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). This property is read-only and not available at design time. # Overwrite Property ([JWE](#jwe-component) Component) Indicates whether or not the component should overwrite files. ## Syntax ```text public bool Overwrite { get; set; } ``` ## Default Value False ## Remarks This property indicates whether or not the component will overwrite [OutputFile](#outputfile-property-jwe-component). If Overwrite is False, an error will be thrown whenever [OutputFile](#outputfile-property-jwe-component) exists before an operation. The default value is False. # AddHeaderParam Method ([JWE](#jwe-component) Component) Adds additional header parameters. ## Syntax ```text public void AddHeaderParam(string name, string value, int dataType); Async Version public async Task AddHeaderParam(string name, string value, int dataType); public async Task AddHeaderParam(string name, string value, int dataType, CancellationToken cancellationToken); ``` ## Remarks This method is used to add additional header parameters before calling [Encrypt](#encrypt-method-jwe-component). The *Name* and *Value* parameters define the name and value of the parameter respectively. The *DataType* parameter specifies the JSON data type of the value. Possible values for *DataType* are: - 0 (Object) - 1 (Array) - 2 (String) - 3 (Number) - 4 (Bool) - 5 (Null) To add additional parameters to the JOSE header use this method. For instance to create this header: ```text { "alg": "A256GCMKW", "crit": [ "exp" ], "enc": "A128CBC-HS256", "exp": 12345687, "iv": "SFZ9o0KKN8qF8yod", "tag": "tREHGKuViLo7s3QpRTulkg", "type": "JWT" } ``` The following code can be used: ```csharp Jwe jwe = new Jwe(); jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaA256GCMKW; jwe.KeyB = key; jwe.AddHeaderParam("type", "JWT", 2); jwe.AddHeaderParam("crit", "[\"exp\"]", 1); jwe.AddHeaderParam("exp", "12345687", 3); jwe.InputMessage = "test"; jwe.Encrypt(); string encryptedData = jwe.OutputMessage; ``` Note: When calling [Encrypt](#encrypt-method-jwe-component) the component will automatically add headers based on the selected [EncryptionAlgorithm](#encryptionalgorithm-property-jwe-component) and other properties that may be set. **Parameters Automatically Set:** | Header Param | Property | | --- | --- | | alg | [EncryptionAlgorithm](#encryptionalgorithm-property-jwe-component) | | enc | [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwe-component) | | kid | [KeyId](#keyid-property-jwe-component) | | zip | [CompressionAlgorithm](#CompressionAlgorithm) | | p2c | [PBES2Count](#PBES2Count) (PBES Algorithms Only) | | apu | [PartyUInfo](#PartyUInfo) (ECDH Algorithms Only) | | apv | [PartyVInfo](#PartyVInfo) (ECDH Algorithms Only) | | iv | N/A - Automatically Generated (AES Algorithms Only) | | tag | N/A - Automatically Generated (AES Algorithms Only) | | p2s | N/A - Automatically Generated (PBES Algorithms Only) | | epk | N/A - Automatically Generated (ECDH Algorithms Only) | # Config Method ([JWE](#jwe-component) Component) Sets or retrieves a configuration setting. ## Syntax ```text public string Config(string configurationString); Async Version public async Task Config(string configurationString); public async Task Config(string configurationString, CancellationToken cancellationToken); ``` ## Remarks Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-jwe-component) for the component. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-jwe-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # Decrypt Method ([JWE](#jwe-component) Component) Decrypts the payload. ## Syntax ```text public void Decrypt(); Async Version public async Task Decrypt(); public async Task Decrypt(CancellationToken cancellationToken); ``` ## Remarks This method decrypts the input data. Before calling the Decrypt method set [InputMessage](#inputmessage-property-jwe-component) or [InputFile](#inputfile-property-jwe-component) to a valid compact serialized JWE string. For instance: *eyJhbGciOiJBMjU2R0NNS1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiaXYiOiJMa0tNeTZ5Qlpfbzh6QW92IiwidGFnIjoiSmpMTkRsV3l3bWt3V2pMa0NLU0xxQSJ9.wiwySYm6fXZre-3IdT1tb_02KMQDrMICwUawVf7Gjhc.k84s7ne8J41QnA5BQ31k_A.kjIveRjjNYV4x92CVE9Agw.uAygkyeO2KWeFQIy9JLU0A* The type and format of the private key depends on the algorithm used to encrypt the data. The following table summarizes the relationship: | | | | --- | --- | | Algorithm | Private Key Location | | AES | [Key](#key-property-jwe-component) | | RSA and ECDH | [Certificate](#certificate-property-jwe-component) | | PBES | [KeyPassword](#keypassword-property-jwe-component) | If the correct [Key](#key-property-jwe-component) or [Certificate](#certificate-property-jwe-component) is not known ahead of time the *KeyId* parameter of the [RecipientInfo](#recipientinfo-event-jwe-component) event may be used to identify the correct key. If this method returns without error decryption was successful. If decryption fails then this method throws an exception. After calling this method the payload will be present in the [OutputMessage](#outputmessage-property-jwe-component) or file specified by [OutputFile](#outputfile-property-jwe-component) and the [HeaderParams](#headerparams-property-jwe-component) property will contain the headers. Headers of the parsed message are also available through the [HeaderParam](#headerparam-event-jwe-component) event. The following properties are applicable when calling this method: - [Certificate](#certificate-property-jwe-component) (conditional - required for RSA and ECDH) - [Key](#key-property-jwe-component) (conditional - required for AES) - [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwe-component) (only if [StrictValidation](#StrictValidation) is True) - [EncryptionAlgorithm](#encryptionalgorithm-property-jwe-component) (only if [StrictValidation](#StrictValidation) is True) - [HeaderParams](#headerparams-property-jwe-component) - [Overwrite](#overwrite-property-jwe-component) - [StrictValidation](#StrictValidation) **Input and Output Properties** The component will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [SetInputStream](#setinputstream-method-jwe-component) - [InputFile](#inputfile-property-jwe-component) - [InputMessage](#inputmessage-property-jwe-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-jwe-component) - [OutputFile](#outputfile-property-jwe-component) - [OutputMessage](#outputmessage-property-jwe-component): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). **Notes for AES Algorithms (A128KW, A192KW, A256KW, A128GCMKW, A192GCMKW, A256GCMKW)** To decrypt messages that use AES encryption [Key](#key-property-jwe-component) must be set to a key of appropriate length for the algorithm. For instance a 256 bit key would be used for A256KW. The key must be known by both parties in order for encryption and decryption to take place. ```csharp byte[] key = new byte[] { 164, 60, 194, 0, 161, 189, 41, 38, 130, 89, 141, 164, 45, 170, 159, 209, 69, 137, 243, 216, 191, 131, 47, 250, 32, 107, 231, 117, 37, 158, 225, 234 }; Jwe jwe = new Jwe(); jwe.KeyB = key; jwe.InputMessage = encryptedData; jwe.Decrypt(); string decryptedData = jwe.OutputMessage; ``` **Notes for RSA Algorithms (RSA1_5, RSA-OEAP, RSA-OAEP-256)** The RSA based algorithms use asymmetric encryption. Encrypting is done with a public key and decryption is done with a private key. The certificate with private key must be specified. For instance: ```csharp Jwe jwe = new Jwe(); jwe.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "..\\jwt.pfx", "password", "*"); jwe.InputMessage = encryptedData; jwe.Decrypt(); string decryptedData = jwe.OutputMessage; ``` **Notes for ECDH Algorithms (ECDH-ES, ECDH-ES+A128KW, ECDH-ES+A192KW, ECDH-ES+A256KW)** ECDH algorithms require a valid ECC private key to decrypt the message. If the key was originally created with the ECC component the PEM encoded *PrivateKey* may be used directly with the [Certificate](#certificate-property-jwe-component) property. ```csharp Jwe jwe = new Jwe(); jwe.Certificate = new Certificate(CertStoreTypes.cstPEMKeyFile, privKeyFile, "", "*"); jwe.InputMessage = encryptedData; jwe.Decrypt(); string decryptedData = jwe.OutputMessage; ``` To use an ECC private key created by other means the ECC component may be used to import the key parameters. Populate the *Rx*, *Ry*, and *KB* properties of the ECC component first to obtain the PEM formatted public key. For instance: ```csharp Ecc ecc = new Ecc(); byte[] x_bytes = new byte[] { 171, 170, 196, 151, 94, 196, 231, 12, 128, 232, 17, 61, 45, 105, 41, 209, 192, 187, 112, 242, 110, 178, 95, 240, 36, 55, 83, 171, 190, 176, 78, 13 }; byte[] y_bytes = new byte[] { 197, 75, 134, 245, 245, 28, 199, 9, 7, 117, 1, 54, 49, 178, 135, 252, 62, 89, 35, 180, 117, 80, 231, 23, 110, 250, 28, 124, 219, 253, 224, 156 }; byte[] k_bytes = new byte[] { 81, 65, 201, 24, 235, 249, 162, 148, 169, 150, 109, 181, 61, 238, 145, 122, 31, 30, 151, 94, 239, 90, 222, 217, 63, 103, 54, 2, 176, 232, 248, 168 }; ecc.Key.RxB = x_bytes; ecc.Key.RyB = y_bytes; ecc.Key.KB = k_bytes; string privKey = ecc.Key.PrivateKey; Jwe jwe = new Jwe(); jwe.Certificate = new Certificate(CertStoreTypes.cstPEMKeyBlob, privKey, "", "*"); jwe.InputMessage = encryptedData; jwe.Decrypt(); string decryptedData = jwe.OutputMessage; ``` **Notes for PBES Algorithms (PBES2-HS256+A128KW, PBES2-HS384+A192KW, PBES2-HS512+A256KW** PBES algorithms derive a content encryption key from the [KeyPassword](#keypassword-property-jwe-component) property. Set [KeyPassword](#keypassword-property-jwe-component) to the shared secret. ```csharp Jwe jwe = new Jwe(); jwe.KeyPassword = "secret"; jwe.InputMessage = encryptedData; jwe.Decrypt(); string decryptedData = jwe.OutputMessage; ``` **Notes for Direct Shared Keys** When Direct encryption is used the [Key](#key-property-jwe-component) property must be set to a valid symmetric key that will be used directly by the [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwe-component). For instance: ```csharp byte[] key = new byte[] { 164, 60, 194, 0, 161, 189, 41, 38, 130, 89, 141, 164, 45, 170, 159, 209, 69, 137, 243, 216, 191, 131, 47, 250, 32, 107, 231, 117, 37, 158, 225, 234 }; Jwe jwe = new Jwe(); jwe.KeyB = key; jwe.InputMessage = encryptedData; jwe.Decrypt(); string decryptedData = jwe.OutputMessage; ``` # Encrypt Method ([JWE](#jwe-component) Component) Encrypts the payload with the specified algorithms. ## Syntax ```text public void Encrypt(); Async Version public async Task Encrypt(); public async Task Encrypt(CancellationToken cancellationToken); ``` ## Remarks This method encrypts the input data using the specified algorithms. JSON Web Encryption (JWE) is performed by first generating a random key used to encrypt the content. The content encryption key is used to encrypt the content using the algorithm specified by [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwe-component). The content encryption key is then encrypted itself using the algorithm specified by [EncryptionAlgorithm](#encryptionalgorithm-property-jwe-component). The content encryption key is not directly exposed in the API as it is randomly generated. After calling this method the compact serialized JWE string is written to the specified output location. For instance: *eyJhbGciOiJBMjU2R0NNS1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiaXYiOiJMa0tNeTZ5Qlpfbzh6QW92IiwidGFnIjoiSmpMTkRsV3l3bWt3V2pMa0NLU0xxQSJ9.wiwySYm6fXZre-3IdT1tb_02KMQDrMICwUawVf7Gjhc.k84s7ne8J41QnA5BQ31k_A.kjIveRjjNYV4x92CVE9Agw.uAygkyeO2KWeFQIy9JLU0A* The component is agnostic of the payload that is encrypted. Any value may be encrypted. [KeyId](#keyid-property-jwe-component) may be set to include an identifier to help the receiving party identify the key or certificate used to encrypt the data. The following properties are applicable when calling this method: - [EncryptionAlgorithm](#encryptionalgorithm-property-jwe-component) (required) - [Key](#key-property-jwe-component) (conditional - required for AES) - [KeyPassword](#keypassword-property-jwe-component) (conditional - required for PBES) - [Certificate](#certificate-property-jwe-component) (conditional - required for ECDH and RSA) - [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwe-component) - [CompressionAlgorithm](#CompressionAlgorithm) - [HeaderParams](#headerparams-property-jwe-component) - [Overwrite](#overwrite-property-jwe-component) **Input and Output Properties** The component will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [SetInputStream](#setinputstream-method-jwe-component) - [InputFile](#inputfile-property-jwe-component) - [InputMessage](#inputmessage-property-jwe-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-jwe-component) - [OutputFile](#outputfile-property-jwe-component) - [OutputMessage](#outputmessage-property-jwe-component): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). **Notes for AES Algorithms (A128KW, A192KW, A256KW, A128GCMKW, A192GCMKW, A256GCMKW)** When [EncryptionAlgorithm](#encryptionalgorithm-property-jwe-component) is set to a AES algorithm [Key](#key-property-jwe-component) must be set to a key of appropriate length for the algorithm. For instance a 256 bit key would be used for A256KW. The example below uses the [EzRand](EzRand.md#EzRand) component to generate a key, but the key may be created using any method. The key must be known by both parties in order for encryption and decryption to take place. ```csharp //Generate a 256 bit (32 byte) key Ezrand rand = new Ezrand(); rand.RandBytesLength = 32; rand.GetNextBytes(); byte[] key = rand.RandBytesB; //Encrypt the payload using A256KW Jwe jwe = new Jwe(); jwe.KeyB = key; jwe.InputMessage = "test data"; jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaA256KW; jwe.Encrypt(); string encryptedData = jwe.OutputMessage; ``` To use an existing AES key provide the bytes to the [Key](#key-property-jwe-component) property. For instance: ```csharp byte[] key = new byte[] { 164, 60, 194, 0, 161, 189, 41, 38, 130, 89, 141, 164, 45, 170, 159, 209, 69, 137, 243, 216, 191, 131, 47, 250, 32, 107, 231, 117, 37, 158, 225, 234 }; //Encrypt the payload using A256KW Jwe jwe = new Jwe(); jwe.KeyB = key; jwe.InputMessage = "test data"; jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaA256KW; jwe.Encrypt(); string encryptedData = jwe.OutputMessage; ``` **Notes for RSA Algorithms (RSA1_5, RSA-OEAP, RSA-OAEP-256)** The RSA based algorithms use asymmetric encryption. Encrypting is done with a public key and decryption is done with a private key. The public certificate should be in PEM (base64) format. For instance: ```csharp Jwe jwe = new Jwe(); jwe.Certificate = new Certificate("..\\recipient.cer"); jwe.InputMessage = "test data"; jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaRSA_OAEP; jwe.Encrypt(); string encryptedData = jwe.OutputMessage; ``` **Notes for ECDH Algorithms (ECDH-ES, ECDH-ES+A128KW, ECDH-ES+A192KW, ECDH-ES+A256KW)** ECDH algorithms require a valid ECC public key to encrypt the message. If the key was originally created with the ECC component the PEM encoded *PublicKey* may be used directly with the [Certificate](#certificate-property-jwe-component) property. An example PEM encoded public certificate created by the ECC component: ```text -----BEGIN PUBLIC KEY----- MIIBMjCB7AYHKoZIzj0CATCB4AIBATAsBgcqhkjOPQEBAiEA/////wAAAAEAAAAAAAAAAAAA AAD///////////////8wRAQg/////wAAAAEAAAAAAAAAAAAAAAD///////////////wEIFrG NdiqOpPns+u9VXaYhrxlHQawzFOw9jvOPD4n0mBLBEEEaxfR8uEsQkf4vOblY6RA8ncDfYEt 6zOg9KE5RdiYwpZP40Li/hp/m47n60p8D54WK84zV2sxXs7LtkBoN79R9QIhAP////8AAAAA //////////+85vqtpxeehPO5ysL8YyVRAgEBA0EEIC5rbLp11Mnz6cBXLLriaDIov3rm8RAY x/OR0bOKiff0cQy+sLVaxjseqFk/+Xvl4ORSv5Z6HdHv5GyEpA0UoA== -----END PUBLIC KEY----- ``` ```csharp Jwe jwe = new Jwe(); jwe.Certificate = new Certificate(CertStoreTypes.cstPublicKeyFile, pubKeyFile, "", "*"); jwe.InputMessage = "test data"; jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaECDH_ES_A256KW; jwe.Encrypt(); string encryptedData = jwe.OutputMessage; ``` To use an ECC public key created by other means the ECC component may be used to import the key parameters. Populate the *Rx* and *Ry* properties of the ECC component first to obtain the PEM formatted public key. For instance: ```csharp byte[] x_bytes = new byte[] { 171, 170, 196, 151, 94, 196, 231, 12, 128, 232, 17, 61, 45, 105, 41, 209, 192, 187, 112, 242, 110, 178, 95, 240, 36, 55, 83, 171, 190, 176, 78, 13 }; byte[] y_bytes = new byte[] { 197, 75, 134, 245, 245, 28, 199, 9, 7, 117, 1, 54, 49, 178, 135, 252, 62, 89, 35, 180, 117, 80, 231, 23, 110, 250, 28, 124, 219, 253, 224, 156 }; Ecc ecc = new Ecc(); ecc.Key.RxB = x_bytes; ecc.Key.RyB = y_bytes; string pubKey = ecc.Key.PublicKey; Jwe jwe = new Jwe(); jwe.Certificate = new Certificate(CertStoreTypes.cstPublicKeyFile, pubKey, "", "*"); jwe.InputMessage = "test data"; jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaECDH_ES_A256KW; jwe.Encrypt(); string encryptedData = jwe.OutputMessage; ``` **Notes for PBES Algorithms (PBES2-HS256+A128KW, PBES2-HS384+A192KW, PBES2-HS512+A256KW** PBES algorithms derive a content encryption key from the [KeyPassword](#keypassword-property-jwe-component) property. Set [KeyPassword](#keypassword-property-jwe-component) to a shared secret. ```csharp Jwe jwe = new Jwe(); jwe.KeyPassword = "secret"; jwe.InputMessage = "test data"; jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaPBES2_HS512_A256KW; jwe.Encrypt(); string encryptedData = jwe.OutputMessage; ``` **Notes for Direct Shared Keys** When [EncryptionAlgorithm](#encryptionalgorithm-property-jwe-component) is set to *Direct* the [Key](#key-property-jwe-component) property must be set to a valid symmetric key that will be used directly by the [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwe-component). In this case a content encryption key is not generated randomly, the [Key](#key-property-jwe-component) is used instead. The length of the specified [Key](#key-property-jwe-component) must be valid for the selected [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwe-component). For instance: ```csharp //Generate a 256 bit (32 byte) key Ezrand rand = new Ezrand(); rand.RandBytesLength = 32; rand.GetNextBytes(); byte[] key = rand.RandBytesB; Jwe jwe = new Jwe(); jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaDir; jwe.ContentEncryptionAlgorithm = JweContentEncryptionAlgorithms.ceaA256GCM; jwe.KeyB = key; jwe.InputMessage = "test data"; jwe.Encrypt(); string encryptedData = jwe.OutputMessage; ``` # Parse Method ([JWE](#jwe-component) Component) Parses the compact serialized JWE string. ## Syntax ```text public void Parse(); Async Version public async Task Parse(); public async Task Parse(CancellationToken cancellationToken); ``` ## Remarks This method parses, but does not decrypt, the JWE string. Take care when using this method as no decryption is performed. This method may be helpful in cases where only header information is desired. If decryption is desired, use [Decrypt](#decrypt-method-jwe-component) instead. It is not necessary to call this method before calling [Decrypt](#decrypt-method-jwe-component). [Decrypt](#decrypt-method-jwe-component) will both parse and decrypt the message. When calling this method the headers are parsed. The [HeaderParam](#headerparam-event-jwe-component) and [RecipientInfo](#recipientinfo-event-jwe-component) events will fire and the [HeaderParams](#headerparams-property-jwe-component) property will be populated. # Reset Method ([JWE](#jwe-component) Component) Resets the component. ## Syntax ```text public void Reset(); Async Version public async Task Reset(); public async Task Reset(CancellationToken cancellationToken); ``` ## Remarks When called, the component will reset all of its properties to their default values. # SetInputStream Method ([JWE](#jwe-component) Component) Sets the stream from which the component will read data. ## Syntax ```text public void SetInputStream(System.IO.Stream inputStream); Async Version public async Task SetInputStream(System.IO.Stream inputStream); public async Task SetInputStream(System.IO.Stream inputStream, CancellationToken cancellationToken); ``` ## Remarks This method may be used to set a stream from which data will be read. **Input and Output Properties** The component will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - SetInputStream - [InputFile](#inputfile-property-jwe-component) - [InputMessage](#inputmessage-property-jwe-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-jwe-component) - [OutputFile](#outputfile-property-jwe-component) - [OutputMessage](#outputmessage-property-jwe-component): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). # SetOutputStream Method ([JWE](#jwe-component) Component) Sets the stream to which the component will write data. ## Syntax ```text public void SetOutputStream(System.IO.Stream outputStream); Async Version public async Task SetOutputStream(System.IO.Stream outputStream); public async Task SetOutputStream(System.IO.Stream outputStream, CancellationToken cancellationToken); ``` ## Remarks This method may be used to specify a stream to which data will be written. **Input and Output Properties** The component will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [SetInputStream](#setinputstream-method-jwe-component) - [InputFile](#inputfile-property-jwe-component) - [InputMessage](#inputmessage-property-jwe-component) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - SetOutputStream - [OutputFile](#outputfile-property-jwe-component) - [OutputMessage](#outputmessage-property-jwe-component): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). # Error Event ([JWE](#jwe-component) Component) Fired when information is available about errors during data delivery. ## Syntax ```text public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, JWEErrorEventArgs e); public class JWEErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } } ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception. The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-jwe-component) section. # HeaderParam Event ([JWE](#jwe-component) Component) Fires once for each JOSE header parameter. ## Syntax ```text public event OnHeaderParamHandler OnHeaderParam; public delegate void OnHeaderParamHandler(object sender, JWEHeaderParamEventArgs e); public class JWEHeaderParamEventArgs : EventArgs { public string Name { get; } public string Value { get; } public int DataType { get; } } ``` ## Remarks When [Decrypt](#decrypt-method-jwe-component) or [Parse](#parse-method-jwe-component) is called this event will fire once for each JOSE header parameter. *Name* is the name of the parameter. *Value* is the value of the parameter. *DataType* specifies the JSON data type of the value. Possible values are: - 0 (Object) - 1 (Array) - 2 (String) - 3 (Number) - 4 (Bool) - 5 (Null) # RecipientInfo Event ([JWE](#jwe-component) Component) Fired with information about the recipient key of the encrypted message. ## Syntax ```text public event OnRecipientInfoHandler OnRecipientInfo; public delegate void OnRecipientInfoHandler(object sender, JWERecipientInfoEventArgs e); public class JWERecipientInfoEventArgs : EventArgs { public string KeyId { get; } public string Algorithm { get; } } ``` ## Remarks This event fires with information about the key used to encrypt the data. This may be used to help identify the [Key](#key-property-jwe-component) or [Certificate](#certificate-property-jwe-component) to load in order to decrypt the message. This event fires when [Decrypt](#decrypt-method-jwe-component) or [Parse](#parse-method-jwe-component) is called. *KeyId* is the Id of the key as supplied by the entity that created the message. This may be empty. *Algorithm* is the encryption algorithm used to encrypt the data. # Certificate Type This is the digital certificate being used. ## Remarks This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates. The following fields are available: - [EffectiveDate](#Certificate_f_EffectiveDate) - [ExpirationDate](#Certificate_f_ExpirationDate) - [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage) - [Fingerprint](#Certificate_f_Fingerprint) - [FingerprintSHA1](#Certificate_f_FingerprintSHA1) - [FingerprintSHA256](#Certificate_f_FingerprintSHA256) - [Issuer](#Certificate_f_Issuer) - [PrivateKey](#Certificate_f_PrivateKey) - [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) - [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer) - [PublicKey](#Certificate_f_PublicKey) - [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm) - [PublicKeyLength](#Certificate_f_PublicKeyLength) - [SerialNumber](#Certificate_f_SerialNumber) - [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm) - [Store](#Certificate_f_Store) - [StorePassword](#Certificate_f_StorePassword) - [StoreType](#Certificate_f_StoreType) - [SubjectAltNames](#Certificate_f_SubjectAltNames) - [ThumbprintMD5](#Certificate_f_ThumbprintMD5) - [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1) - [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256) - [Usage](#Certificate_f_Usage) - [UsageFlags](#Certificate_f_UsageFlags) - [Version](#Certificate_f_Version) - [Subject](#Certificate_f_Subject) - [Encoded](#Certificate_f_Encoded) ## Fields **EffectiveDate** *string (read-only)* Default: "" The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. **ExpirationDate** *string (read-only)* Default: "" The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. **ExtendedKeyUsage** *string (read-only)* Default: "" A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **Fingerprint** *string (read-only)* Default: "" The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* **FingerprintSHA1** *string (read-only)* Default: "" The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* **FingerprintSHA256** *string (read-only)* Default: "" The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* **Issuer** *string (read-only)* Default: "" The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate. **PrivateKey** *string (read-only)* Default: "" The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string. **PrivateKeyAvailable** *bool (read-only)* Default: False Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication). **PrivateKeyContainer** *string (read-only)* Default: "" The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms. **PublicKey** *string (read-only)* Default: "" The public key of the certificate. The key is provided as PEM/Base64-encoded data. **PublicKeyAlgorithm** *string (read-only)* Default: "" The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. **PublicKeyLength** *int (read-only)* Default: 0 The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **SerialNumber** *string (read-only)* Default: "" The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. **SignatureAlgorithm** *string (read-only)* Default: "" The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. **Store** *string* Default: "MY" The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StoreB** *byte []* Default: "MY" The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StorePassword** *string* Default: "" If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store. **StoreType** *CertStoreTypes* Default: 0 The type of certificate store for this certificate. The component supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the component will automatically determine the type. This field can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) component by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | **SubjectAltNames** *string (read-only)* Default: "" Comma-separated lists of alternative subject names for the certificate. **ThumbprintMD5** *string (read-only)* Default: "" The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **ThumbprintSHA1** *string (read-only)* Default: "" The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **ThumbprintSHA256** *string (read-only)* Default: "" The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **Usage** *string (read-only)* Default: "" The text description of [UsageFlags](#Certificate_f_UsageFlags). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. **UsageFlags** *int (read-only)* Default: 0 The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [Usage](#Certificate_f_Usage) field for a text representation of [UsageFlags](#Certificate_f_UsageFlags). This functionality currently is not available when the provider is OpenSSL. **Version** *string (read-only)* Default: "" The certificate's version number. The possible values are the strings "V1", "V2", and "V3". **Subject** *string* Default: "" The subject of the certificate used for client authentication. This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. **Encoded** *string* Default: "" The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. **EncodedB** *byte []* Default: "" The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. ## Constructors ```text public Certificate(); ``` Creates a instance whose properties can be set. ```text public Certificate(string certificateFile); ``` Opens * CertificateFile * and reads out the contents as an X.509 public key. ```text public Certificate(byte[] encoded); ``` Parses * Encoded * as an X.509 public key. ```text public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. * ConfigurationString * is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * cstUser * , * cstMachine * , * cstPublicKeyFile * , and * cstPFXFile * store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. ```text public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. # HeaderParam Type The JOSE header parameter. ## Remarks This type holds the JOSE header parameters. The fields define the name, value, and data type of the parameter. The following fields are available: - [DataType](#HeaderParam_f_DataType) - [Name](#HeaderParam_f_Name) - [Value](#HeaderParam_f_Value) ## Fields **DataType** *TDataTypes* Default: 2 The data type of the header parameter. This field specifies the JSON type of the header parameter value. Possible values are: - 0 (Object) - 1 (Array) - 2 (String) - 3 (Number) - 4 (Bool) - 5 (Null) **Name** *string* Default: "" The header parameter name. **Value** *string* Default: "" The header parameter value. ## Constructors ```text public HeaderParam(); ``` Creates a new header parameter with no name or value. ```text public HeaderParam(string name, string value); ``` Creates a new header parameter. The DataType of the value will be a String. ```text public HeaderParam(string name, string value, int dataType); ``` Creates a new header parameter with the specified DataType. # Config Settings ([JWE](#jwe-component) Component) The component accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these *internal properties* is provided through the [Config](#config-method-jwe-component) method. ### JWE Config Settings **CloseInputStreamAfterProcess**: Whether to close the input stream after processing.This setting specifies whether the stream set by [SetInputStream](#setinputstream-method-jwe-component) is closed after processing the message. The default value is *True*. **CloseOutputStreamAfterProcess**: Whether to close the output stream after processing.This setting specifies whether the stream set by [SetOutputStream](#setoutputstream-method-jwe-component) is closed after processing the message. The default value is *True*. **CompressionAlgorithm**: The compression algorithm to use.This setting specifies the compression algorithm to use (if any). If set the content will be compressed using the specified algorithm. Possible values are: - 0 (none - default) - 1 (deflate) **PartyUInfo**: Information about the producer of the message.This setting may optionally be set when Algorithm is set to an ECDH algorithm before calling [Encrypt](#encrypt-method-jwe-component). When calling [Decrypt](#decrypt-method-jwe-component) this setting is populated and also accessible from within the [RecipientInfo](#recipientinfo-event-jwe-component) event. The value may be any string. To specify a base64url encoded value directly prefix the string with *[b64]*. For instance the following lines both set the same value: ```csharp jwe.Config("PartyUInfo=Alice"); jwe.Config("PartyUInfo=[b64]QWxpY2U="); //Equivalent to above line ``` **PartyVInfo**: Information about the recipient of the message.This setting may optionally be set when Algorithm is set to an ECDH algorithm before calling [Encrypt](#encrypt-method-jwe-component). When calling [Decrypt](#decrypt-method-jwe-component) this setting is populated and also accessible from within the [RecipientInfo](#recipientinfo-event-jwe-component) event. The value may be any string. To specify a base64url encoded value directly prefix the string with *[b64]*. For instance the following lines both set the same value: ```csharp jwe.Config("PartyUInfo=Bob"); jwe.Config("PartyUInfo=[b64]Qm9i"); //Equivalent to above line ``` **PBES2Count**: The PBKDF2 iteration count.This setting specifies the PBDKF2 iteration count. A minimum value of *1000* is recommended. The default value is *1000*. This setting is only applicable when [EncryptionAlgorithm](#encryptionalgorithm-property-jwe-component) is set to a PBES algorithm. **PBES2SaltLength**: The salt input value length.This setting specifies the length in bytes of the salt input value, which is used as part of the PBKDF2 salt value. The default value is *16*. This setting is only applicable when [EncryptionAlgorithm](#encryptionalgorithm-property-jwe-component) is set to a PBES algorithm. **RawHeader**: Holds the raw JOSE header.This setting may be queried after calling [Encrypt](#encrypt-method-jwe-component) or [Decrypt](#decrypt-method-jwe-component) to obtain the raw JOSE header. This returns a JSON string like: *{"alg":"A128GCMKW","enc":"A256CBC-HS512","iv":"oSqGqGiA48O1uD9b","tag":"0WNBx27Z5aL5uvsd01d1Tw"}* **StrictValidation**: Requires specific algorithm when decrypting.If set to True the component will validate the that algorithms used in the JWE message match the values specified in [EncryptionAlgorithm](#encryptionalgorithm-property-jwe-component) and [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwe-component). If either algorithms do not match the component throws an exception. By default this setting is False and the algorithms are read automatically from the encrypted JWE message. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **GUIAvailable**: Whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation. In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting [GUIAvailable](#GUIAvailable) to *false* will ensure that the component does not attempt to process external events. **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseFIPSCompliantAPI**: Tells the component whether or not to use FIPS certified APIs.When set to *true*, the component will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries. FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *true*. This is a static setting that applies to all instances of all components of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior. For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article. NOTE: This setting is applicable only on Windows. NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to *true*. Setting this configuration setting to *true* tells the component to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default. NOTE: This setting is static. The value set is applicable to all components used in the application. When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file. # Trappable Errors ([JWE](#jwe-component) Component) ### JWE Errors | | | | --- | --- | | 101 | Invalid JWE message. See message for details. | | 102 | Unsupported compression algorithm. | | 103 | Unsupported content encryption algorithm. | | 104 | Unsupported key encryption algorithm. | | 105 | A required header for decryption was not found. See message for details. | | 106 | The specified key is not a valid length for the algorithm. | | 107 | OutputFile already exists and Overwrite is False. | | 108 | KeyPassword must be set for the selected algorithm. | | 109 | Key must be set for the selected algorithm. | | 110 | Certificate must be set for the selected algorithm. | | 111 | A header parameter defined to be critical is not present. | | 112 | Error writing data. | | 113 | Error reading data. Check message for details. | | 114 | Error encrypting. Check message for details. | | 115 | Error decrypting. Check message for details. |