# JWT Component

Create, Sign, Encrypt, Verify and Decrypt JSON Web Tokens (JWTs).

## Syntax

```text
nsoftware.IPWorksEncrypt.JWT
```

## Remarks

The JWT component supports signing, encrypting, decrypting and verifying JSON Web Tokens (JWTs).

Specify a set of claims via the **Claim*** properties or add your own claims with [AddClaim](#addclaim-method-jwt-component). Call [Sign](#sign-method-jwt-component) to create a signed JWT using a variety of signing algorithms including HMAC, RSA, and ECDSA. Use [Verify](#verify-method-jwt-component) to verify the signature of any received JWT. See [SigningAlgorithm](#signingalgorithm-property-jwt-component) for more details about supported algorithms.

Use [Encrypt](#encrypt-method-jwt-component) to create an encrypted JWT using a variety of algorithms including ECDH, RSA, and AES. Use [Decrypt](#decrypt-method-jwt-component) to decrypt the payload of any received JWT. See [EncryptionAlgorithm](#encryptionalgorithm-property-jwt-component) for more details about supported algorithms.

## Signing

The [Sign](#sign-method-jwt-component) method may be used to sign a payload with a variety of algorithms. Before calling the [Sign](#sign-method-jwt-component) method set [SigningAlgorithm](#signingalgorithm-property-jwt-component) to the algorithm which will be used to sign the message. The result of signing is a compact serialized JWT string. For instance:

*eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOlsiYXVkaWVuY2UiXSwiaXNzIjoiaXNzdWVyIn0.mlFETSma4WUcUSjNSUWA1n9QBcQHCkHN-y4zeBsCVqI*

The component will use the values present in the **Claim*** properties to build the encoded JWT. After calling this method the [EncodedJWT](#encodedjwt-property-jwt-component) property will hold the compact serialized JWT. The following properties are applicable when calling this method:

- [SigningAlgorithm](#signingalgorithm-property-jwt-component) (required)
- [Certificate](#certificate-property-jwt-component) (conditional - required for ECDSA and RSA)
- [Key](#key-property-jwt-component) (conditional - required for HMAC)
- [ClaimAudience](#claimaudience-property-jwt-component)
- [ClaimExp](#claimexp-property-jwt-component)
- [ClaimIssuedAt](#claimissuedat-property-jwt-component)
- [ClaimIssuer](#claimissuer-property-jwt-component)
- [ClaimJWTId](#claimjwtid-property-jwt-component)
- [ClaimNotBefore](#claimnotbefore-property-jwt-component)
- [Claims](#claims-property-jwt-component)
- [HeaderParams](#headerparams-property-jwt-component)
- [KeyId](#keyid-property-jwt-component)

**Notes for HMAC Algorithms (HS256, HS384, HS512)**

When [SigningAlgorithm](#signingalgorithm-property-jwt-component) is set to a HMAC algorithm [Key](#key-property-jwt-component) must be set to a key of appropriate length for the algorithm. The [Key](#key-property-jwt-component) should be the same number of bits as the algorithm being used. For instance a 256 bit key would be used for HS256.

The key must be known by both parties in order for signing and verification to take place. To use an existing HMAC key provide the bytes to the [Key](#key-property-jwt-component) property. For instance:

```csharp
//HMAC SHA-256 Key
byte[] key = new byte[] { 170, 171, 221, 209, 7, 181, 48, 178, 48, 118, 242, 132, 36, 218, 74, 140, 216, 165, 161, 70, 11, 42, 246, 205, 235, 231, 19, 48, 87, 141, 122, 10 };

//Sign the payload using HS256
Jwt jwt = new Jwt();
jwt.SigningAlgorithm = JwtSigningAlgorithms.saHS256;
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.KeyB = key;
jwt.Sign();

string signedData = jwt.EncodedJWT;
```

**Notes for RSA Algorithms (RS256, RS384, RS512, PS256, PS384, PS512)**

The RSA based algorithms use asymmetric encryption. Signing is done with a private key and verification is done with a public key. The private key may be in PFX or PEM format.

```csharp
Jwt jwt = new Jwt();
jwt.SigningAlgorithm = JwtSigningAlgorithms.saRS256;
jwt.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "..\\jwt.pfx", "test", "*");
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.Sign();

string signedMessage = jwt.EncodedJWT;
```

**Notes for ECDSA Algorithms (ES256, ES384, ES512)**

ECDSA algorithms require a valid ECC private key in order to sign data. The [Certificate](#certificate-property-jwt-component) property should be set to a certificate with an ECC key. The [CertMgr](CertMgr.md#CertMgr) component can be used to create a certificate with an ECC key.

```csharp
//Create an ECC key with SHA-256
Certmgr mgr = new Certmgr();
mgr.Config("CertPublicKeyAlgorithm=ECDSA_P256");
mgr.CertStoreType = CertStoreTypes.cstPEMKeyFile;
mgr.CertStore = "C:\\temp\\ecdsa.pem";
mgr.CreateCertificate("CN=ecdsa", 123);

//Sign the payload using ES256
Jwt jwt = new Jwt();
jwt.SigningAlgorithm = JwtSigningAlgorithms.saES256;
jwt.Certificate = new Certificate(CertStoreTypes.cstPEMKeyFile, "C:\\temp\\ecdsa.pem", "", "*");
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.Sign();

string signedMessage = jwt.EncodedJWT;
```

**Notes for Unsecured (none)**

To create a JWS token without any security set [SigningAlgorithm](#signingalgorithm-property-jwt-component) to *jwtNone*.

```csharp
Jwt jwt = new Jwt();
jwt.SigningAlgorithm = JwtSigningAlgorithms.saNone;
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.Sign();

string unsecuredMessage = jwt.EncodedJWT;
```

## Signature Verification

The [Verify](#verify-method-jwt-component) method may be used to verify a received JWS message. Before calling the [Verify](#verify-method-jwt-component) method set [EncodedJWT](#encodedjwt-property-jwt-component) to a valid compact serialized JWT. For instance:

*eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOlsiYXVkaWVuY2UiXSwiaXNzIjoiaXNzdWVyIn0.mlFETSma4WUcUSjNSUWA1n9QBcQHCkHN-y4zeBsCVqI*

The [Key](#key-property-jwt-component) or [SignerCert](#signercert-property-jwt-component) properties should be set to the HMAC key or public certificate respectively. If the correct [Key](#key-property-jwt-component) or [SignerCert](#signercert-property-jwt-component) is not known ahead of time the *KeyId* parameter of the [SignerInfo](#signerinfo-event-jwt-component) event may be used to identify the correct key.

If this method returns without error verification was successful. If verification fails then this method throws an exception. After calling this method the claims will be parsed and the **Claim*** properties will be populated. The the [HeaderParams](#headerparams-property-jwt-component) property will contain the headers. Headers of the parsed message are also available through the [HeaderParam](#headerparam-event-jwt-component) event.

The following properties are applicable when calling this method:

- [EncodedJWT](#encodedjwt-property-jwt-component) (required)
- [Key](#key-property-jwt-component) (conditional - required for HMAC)
- [SignerCert](#signercert-property-jwt-component) (conditional - required for ECDSA and RSA)
- [SigningAlgorithm](#signingalgorithm-property-jwt-component) (only if [StrictValidation](#StrictValidation) is True)
- [StrictValidation](#StrictValidation)
- [ExpectedAudience](#ExpectedAudience) (optional)
- [ExpectedExp](#ExpectedExp) (optional)
- [ExpectedIssuedAt](#ExpectedIssuedAt) (optional)
- [ExpectedIssuer](#ExpectedIssuer) (optional)
- [ExpectedJWTId](#ExpectedJWTId) (optional)
- [ExpectedNotBefore](#ExpectedNotBefore) (optional)
- [ExpectedSubject](#ExpectedSubject) (optional)

After calling this method the following properties are populated:

- [ClaimAudience](#claimaudience-property-jwt-component)
- [ClaimExp](#claimexp-property-jwt-component)
- [ClaimIssuedAt](#claimissuedat-property-jwt-component)
- [ClaimIssuer](#claimissuer-property-jwt-component)
- [ClaimJWTId](#claimjwtid-property-jwt-component)
- [ClaimNotBefore](#claimnotbefore-property-jwt-component)
- [Claims](#claims-property-jwt-component)
- [ClaimSubject](#claimsubject-property-jwt-component)
- [HeaderParams](#headerparams-property-jwt-component)

**Notes for HMAC Algorithms (HS256, HS384, HS512)**

When verifying a message originally signed with a HMAC algorithm [Key](#key-property-jwt-component) must be set to the same key used during signing. The key must be known by both parties in order for signing and verification to take place.

```csharp
byte[] key = new byte[] { 170, 171, 221, 209, 7, 181, 48, 178, 48, 118, 242, 132, 36, 218, 74, 140, 216, 165, 161, 70, 11, 42, 246, 205, 235, 231, 19, 48, 87, 141, 122, 10 };

Jwt jwt = new Jwt();
jwt.KeyB = key;
jwt.EncodedJWT = signedData;
jwt.Verify();

string issuer = jwt.ClaimIssuer;
```

**Notes for RSA Algorithms (RS256, RS384, RS512, PS256, PS384, PS512)**

The RSA based algorithms use asymmetric encryption. Signing is done with a private key and verification is done with a public key. The public key is typically in PEM format.

```csharp
Jwt jwt = new Jwt();
jwt.SignerCert = new Certificate("..\\jwt.cer");
jwt.EncodedJWT = signedData;
jwt.Verify();

string issuer = jwt.ClaimIssuer;
```

**Notes for ECDSA Algorithms (ES256, ES384, ES512)**

ECDSA algorithms require a valid ECC public key to verify the message. The PEM encoded public key may be used directly with the [Certificate](#certificate-property-jwt-component) property. An example PEM encoded public certificate created by the [CertMgr](CertMgr.md#CertMgr) component:

```text
-----BEGIN CERTIFICATE-----
MIIBETCBtaADAgECAgF7MAwGCCqGSM49BAMCBQAwEDEOMAwGA1UEAxMFZWNkc2EwHhcNMjMw
NzAzMTcwMjU3WhcNMjQwNzAyMTcwMjU3WjAQMQ4wDAYDVQQDEwVlY2RzYTBZMBMGByqGSM49
AgEGCCqGSM49AwEHA0IABGJv251JI7ITcq+fac9Z2yYkhTLSRhWGzBw1wEJZbs/8AZbVmvcy
4BzKSZEaTfBsCHIt3FLNgRLdugI+B65eQDYwDAYIKoZIzj0EAwIFAANJADBGAiEAzmH5LKKn
r4iy9kJvIlCslpcBHM/8k0XQaj13Zwhm2ocCIQD/cSiC4EuqRkxT4IKET7ko3iI5YUS+J5W5
/0xnxxxIpQ==
-----END CERTIFICATE-----
```

```csharp
Jwt jwt = new Jwt();
jwt.SignerCert = new Certificate(CertStoreTypes.cstPublicKeyBlob, pubKey, "", "*");
jwt.EncodedJWT = signedData;
jwt.Verify();

string issuer = jwt.ClaimIssuer;
```

**Notes for Unsecured (none)**

To parse a JWS token without any security call the [Sign](#sign-method-jwt-component) method without setting the [Key](#key-property-jwt-component) or [Certificate](#certificate-property-jwt-component) properties.

```csharp
Jwt jwt = new Jwt();
jwt.EncodedJWT = signedData;
jwt.Verify();

string issuer = jwt.ClaimIssuer;
```

## Encrypting

The [Encrypt](#encrypt-method-jwt-component) method may be used to encrypt a payload with a variety of algorithms. To create an encrypted JWT 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-jwt-component). The content encryption key is then encrypted itself using the algorithm specified by [EncryptionAlgorithm](#encryptionalgorithm-property-jwt-component). The content encryption key is not directly exposed in the API as it is randomly generated.

After calling this method the compact serialized JWT is written to [EncodedJWT](#encodedjwt-property-jwt-component). For instance:

*eyJhbGciOiJBMjU2S1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2In0.4tcAnZJ00u4GY2kLOanPOL4CtvcfraZ8SIi6bOZ27qYBI2rHITPc1Q.c_9rCTdPn-saLCti2ZEyWQ.eLwqqo5BGNa70RlsvT-vTh7Gk0hjpJYY_9Zc39Vim_qEtjyMcxZygBpkfx9brzQr9rUbuiAhoCMXKip2-lKT6w.NkuLDPmWxWL4BaTWHWicIQ*

The component will use the values present in the **Claim*** properties to build the encoded JWT. After calling this method the [EncodedJWT](#encodedjwt-property-jwt-component) property will hold the compact serialized JWT. The following properties are applicable when calling this method:

- [EncryptionAlgorithm](#encryptionalgorithm-property-jwt-component) (required)
- [Key](#key-property-jwt-component) (conditional - required for AES)
- [KeyPassword](#keypassword-property-jwt-component) (conditional - required for PBES)
- [RecipientCert](#recipientcert-property-jwt-component) (conditional - required for ECDH and RSA)
- [ClaimAudience](#claimaudience-property-jwt-component)
- [ClaimExp](#claimexp-property-jwt-component)
- [ClaimIssuedAt](#claimissuedat-property-jwt-component)
- [ClaimIssuer](#claimissuer-property-jwt-component)
- [ClaimJWTId](#claimjwtid-property-jwt-component)
- [ClaimNotBefore](#claimnotbefore-property-jwt-component)
- [Claims](#claims-property-jwt-component)
- [CompressionAlgorithm](#CompressionAlgorithm)
- [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwt-component)
- [HeaderParams](#headerparams-property-jwt-component)
- [KeyId](#keyid-property-jwt-component)

**Notes for AES Algorithms (A128KW, A192KW, A256KW, A128GCMKW, A192GCMKW, A256GCMKW)**

When [EncryptionAlgorithm](#encryptionalgorithm-property-jwt-component) is set to a AES algorithm [Key](#key-property-jwt-component) must be set to a key of appropriate length for the algorithm. For instance a 256 bit key would be used for A256KW.

To use an existing AES key provide the bytes to the [Key](#key-property-jwt-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
Jwt jwt = new Jwt();
jwt.KeyB = key;
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaA256KW;
jwt.Encrypt();

string encryptedData = jwt.EncodedJWT;
```

**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
Jwt jwt = new Jwt();
jwt.Certificate = new Certificate("..\\recipient.cer");
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaRSA_OAEP;
jwt.Encrypt();

string encryptedData = jwt.EncodedJWT;
```

**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-jwt-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
Jwt jwt = new Jwt();
jwt.Certificate = new Certificate(CertStoreTypes.cstPublicKeyFile, pubKeyFile, "", "*");
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaECDH_ES_A256KW;
jwt.Encrypt();

string encryptedData = jwt.EncodedJWT;
```

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 };

nsoftware.IPWorksEncrypt.Ecc ecc = new nsoftware.IPWorksEncrypt.Ecc();
ecc.Key.RxB = x_bytes;
ecc.Key.RyB = y_bytes;

string pubKey = ecc.Key.PublicKey;

Jwt jwt = new Jwt();
jwt.Certificate = new Certificate(CertStoreTypes.cstPublicKeyFile, pubKey, "", "*");
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaECDH_ES_A256KW;
jwt.Encrypt();

string encryptedData = jwt.EncodedJWT;
```

**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-jwt-component) property. Set [KeyPassword](#keypassword-property-jwt-component) to a shared secret.

```csharp
Jwt jwt = new Jwt();
jwt.KeyPassword = "secret";
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaPBES2_HS512_A256KW;
jwt.Encrypt();

string encryptedData = jwt.EncodedJWT;
```

**Notes for Direct Shared Keys**

When [EncryptionAlgorithm](#encryptionalgorithm-property-jwt-component) is set to *Direct* the [Key](#key-property-jwt-component) property must be set to a valid symmetric key that will be used directly by the [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwt-component). In this case a content encryption key is not generated randomly, the [Key](#key-property-jwt-component) is used instead. The length of the specified [Key](#key-property-jwt-component) must be valid for the selected [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwt-component). For instance:

```csharp
byte[] key = new byte[] { 164, 62, 191, 60, 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 };

Jwt jwt = new Jwt();
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaDir;
jwt.ContentEncryptionAlgorithm = JwtContentEncryptionAlgorithms.ceaA256GCM;
jwt.KeyB = key;
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.Encrypt();

string encryptedData = jwt.EncodedJWT;
```

## Decrypting

The [Decrypt](#decrypt-method-jwt-component) method may be used to decrypt a received JWE message. Before calling the [Decrypt](#decrypt-method-jwt-component) method set [EncodedJWT](#encodedjwt-property-jwt-component) to a valid compact serialized JWT string. For instance:

```plaintext
eyJhbGciOiJBMjU2S1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2In0.4tcAnZJ00u4GY2kLOanPOL4CtvcfraZ8SIi6bOZ27qYBI2rHITPc1Q.c_9rCTdPn-saLCti2ZEyWQ.eLwqqo5BGNa70RlsvT-vTh7Gk0hjpJYY_9Zc39Vim_qEtjyMcxZygBpkfx9brzQr9rUbuiAhoCMXKip2-lKT6w.NkuLDPmWxWL4BaTWHWicIQ
```

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-jwt-component) |
| RSA and ECDH | [Certificate](#certificate-property-jwt-component) |
| PBES | [KeyPassword](#keypassword-property-jwt-component) |

 If the correct [Key](#key-property-jwt-component) or [Certificate](#certificate-property-jwt-component) is not known ahead of time the *KeyId* parameter of the [RecipientInfo](#recipientinfo-event-jwt-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 **Claim*** properties and the [HeaderParams](#headerparams-property-jwt-component) property will contain the headers. Headers of the parsed message are also available through the [HeaderParam](#headerparam-event-jwt-component) event.

The following properties are applicable when calling this method:

- [Certificate](#certificate-property-jwt-component) (conditional - required for RSA and ECDH)
- [EncodedJWT](#encodedjwt-property-jwt-component)
- [Key](#key-property-jwt-component) (conditional - required for AES)
- [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwt-component) (only if [StrictValidation](#StrictValidation) is True)
- [EncryptionAlgorithm](#encryptionalgorithm-property-jwt-component) (only if [StrictValidation](#StrictValidation) is True)
- [HeaderParams](#headerparams-property-jwt-component)
- [StrictValidation](#StrictValidation)

After calling this method the following properties are populated:

- [ClaimAudience](#claimaudience-property-jwt-component)
- [ClaimExp](#claimexp-property-jwt-component)
- [ClaimIssuedAt](#claimissuedat-property-jwt-component)
- [ClaimIssuer](#claimissuer-property-jwt-component)
- [ClaimJWTId](#claimjwtid-property-jwt-component)
- [ClaimNotBefore](#claimnotbefore-property-jwt-component)
- [Claims](#claims-property-jwt-component)
- [ClaimSubject](#claimsubject-property-jwt-component)
- [HeaderParams](#headerparams-property-jwt-component)

**Notes for AES Algorithms (A128KW, A192KW, A256KW, A128GCMKW, A192GCMKW, A256GCMKW)**

To decrypt messages that use AES encryption [Key](#key-property-jwt-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 };

Jwt jwt = new Jwt();
jwt.KeyB = key;
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();

string issuer = jwt.ClaimIssuer;
```

**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
Jwt jwt = new Jwt();
jwt.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "..\\jwt.pfx", "password", "*");
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();

string issuer = jwt.ClaimIssuer;
```

**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-jwt-component) property.

```csharp
Jwt jwt = new Jwt();
jwt.Certificate = new Certificate(CertStoreTypes.cstPEMKeyFile, privKeyFile, "", "*");
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();

string issuer = jwt.ClaimIssuer;
```

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
nsoftware.IPWorksEncrypt.Ecc ecc = new nsoftware.IPWorksEncrypt.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;

Jwt jwt = new Jwt();
jwt.Certificate = new Certificate(CertStoreTypes.cstPEMKeyBlob, privKey, "", "*");
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();

string issuer = jwt.ClaimIssuer;
```

**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-jwt-component) property. Set [KeyPassword](#keypassword-property-jwt-component) to the shared secret.

```csharp
Jwt jwt = new Jwt();
jwt.KeyPassword = "secret";
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();

string issuer = jwt.ClaimIssuer;
```

**Notes for Direct Shared Keys**

When Direct encryption is used the [Key](#key-property-jwt-component) property must be set to a valid symmetric key that will be used directly by the [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwt-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 };

Jwt jwt = new Jwt();
jwt.KeyB = key;
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();

string issuer = jwt.ClaimIssuer;
```

## Other Functionality

In addition to standard operations the component also supports a variety of other features including:

- Adding custom header parameters with [AddHeaderParam](#addheaderparam-method-jwt-component)
- Enforcing algorithm restrictions when verifying by setting [StrictValidation](#StrictValidation)
- Inspect the JWT without verifying or decrypting by calling [Parse](#parse-method-jwt-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-jwt-component) | The certificate used for signing or decrypting. |
| [ClaimAudience](#claimaudience-property-jwt-component) | The audience claim. |
| [ClaimExp](#claimexp-property-jwt-component) | The expiration time claim. |
| [ClaimIssuedAt](#claimissuedat-property-jwt-component) | The claim indicating the time at which the JWT was issued. |
| [ClaimIssuer](#claimissuer-property-jwt-component) | The issuer of the JWT. |
| [ClaimJWTId](#claimjwtid-property-jwt-component) | The unique identifier for the JWT. |
| [ClaimNotBefore](#claimnotbefore-property-jwt-component) | The claim identifying the time before which the JWT is invalid. |
| [Claims](#claims-property-jwt-component) | The claims in the JWT. |
| [ClaimSubject](#claimsubject-property-jwt-component) | The subject identifies the principal of the JWT. |
| [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwt-component) | The algorithm used to encrypt the content. |
| [EncodedJWT](#encodedjwt-property-jwt-component) | The encoded JWT. |
| [EncryptionAlgorithm](#encryptionalgorithm-property-jwt-component) | The key encryption algorithm. |
| [HeaderParams](#headerparams-property-jwt-component) | The JOSE header parameters. |
| [Key](#key-property-jwt-component) | The key used for AES. |
| [KeyId](#keyid-property-jwt-component) | The Id of the key used to sign or encrypt the message. |
| [KeyPassword](#keypassword-property-jwt-component) | The key password used in the PBES algorithm. |
| [RecipientCert](#recipientcert-property-jwt-component) | The certificate used for encryption. |
| [SignerCert](#signercert-property-jwt-component) | The certificate used for signature verification. |
| [SigningAlgorithm](#signingalgorithm-property-jwt-component) | The algorithm used when signing. |
| [SigningKey](#signingkey-property-jwt-component) | The key used for HMAC. |

## Method List

*The following is the full list of the methods of the component with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [AddClaim](#addclaim-method-jwt-component) | Adds an new claim. |
| [AddHeaderParam](#addheaderparam-method-jwt-component) | Adds additional header parameters. |
| [Config](#config-method-jwt-component) | Sets or retrieves a configuration setting. |
| [Decrypt](#decrypt-method-jwt-component) | Decrypts the encoded JWT. |
| [DecryptAndVerify](#decryptandverify-method-jwt-component) | Decrypts the encoded JWT, and verifies the signature. |
| [Encrypt](#encrypt-method-jwt-component) | Encrypts the claims with the specified algorithms. |
| [Parse](#parse-method-jwt-component) | Parses the encoded JWT. |
| [Reset](#reset-method-jwt-component) | Resets the component properties. |
| [Sign](#sign-method-jwt-component) | Signs the payload with the specified algorithm. |
| [SignAndEncrypt](#signandencrypt-method-jwt-component) | Signs the payload with the specified algorithm, and encrypts the result of signing. |
| [Verify](#verify-method-jwt-component) | Verifies the signature of the encoded JWT. |

## 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.*

|  |  |
| --- | --- |
| [ClaimInfo](#claiminfo-event-jwt-component) | Fires once for each claim. |
| [Error](#error-event-jwt-component) | Fired when information is available about errors during data delivery. |
| [HeaderParam](#headerparam-event-jwt-component) | Fires once for each JOSE header parameter. |
| [RecipientInfo](#recipientinfo-event-jwt-component) | Fired with information about the recipient key of the encrypted message. |
| [SignerInfo](#signerinfo-event-jwt-component) | Fires with information about the signature. |

## Config Settings

*The following is a list of config settings for the component with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [AllowedSigningAlgorithms](#AllowedSigningAlgorithms) | Allowed signing algorithms when StrictValidation is set to True. |
| [AudienceDelimiter](#AudienceDelimiter) | Defines the character to separate audience values. |
| [CompressionAlgorithm](#CompressionAlgorithm) | The compression algorithm to use. |
| [ExpectedAudience](#ExpectedAudience) | The expected audience claim. |
| [ExpectedExp](#ExpectedExp) | The expected expiration time claim. |
| [ExpectedIssuedAt](#ExpectedIssuedAt) | The expected time at which the JWT was issued. |
| [ExpectedIssuer](#ExpectedIssuer) | The expected issuer of the JWT. |
| [ExpectedJWTId](#ExpectedJWTId) | The expected unique identifier for the JWT. |
| [ExpectedNotBefore](#ExpectedNotBefore) | The expected claim identifying the time before which the JWT is invalid. |
| [ExpectedSubject](#ExpectedSubject) | The expected subject identifying the principal of the JWT. |
| [IncludeCertificateFormat](#IncludeCertificateFormat) | The certificate values to include in the signed message (if any). |
| [InputMessage](#InputMessage) | The raw input to process. |
| [IsEncrypted](#IsEncrypted) | Indicates whether the EncodedJWT is encrypted. |
| [IsSigned](#IsSigned) | Indicates whether the EncodedJWT is signed. |
| [IssuerCerts](#IssuerCerts) | A collection of issuer certificates used with IncludeCertificateFormat. |
| [KeyEncoding](#KeyEncoding) | The encoding of the Key value. |
| [OutputMessage](#OutputMessage) | The raw output of the operation. |
| [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 algorithms when processing. |
| [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 ([JWT](#jwt-component) Component)

The certificate used for signing or decrypting.

## Syntax

```text
public Certificate Certificate { get; set; }
```

## Remarks

This property specifies a certificate with private key.

When calling [Sign](#sign-method-jwt-component) and [SigningAlgorithm](#signingalgorithm-property-jwt-component) is set to an RSA or ECDSA algorithm this property must be set to a certificate with private key.

When calling [Decrypt](#decrypt-method-jwt-component) and the message was encrypted using an RSA or ECDH [EncryptionAlgorithm](#encryptionalgorithm-property-jwt-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.

# ClaimAudience Property ([JWT](#jwt-component) Component)

The audience claim.

## Syntax

```text
public string ClaimAudience { get; set; }
```

## Default Value

""

## Remarks

This property holds the audience claim. The audience claim identifies the recipients that the JWT is intended for. The values specified here are case sensitive.

Multiple audience values are supported and should be separated by a semicolon. See [AudienceDelimiter](#AudienceDelimiter) for details.

This property corresponds to the *aud* JSON property.

# ClaimExp Property ([JWT](#jwt-component) Component)

The expiration time claim.

## Syntax

```text
public string ClaimExp { get; set; }
```

## Default Value

""

## Remarks

This property holds the expiration time claim. The expiration time claim identifies the expiration time on or after which the JWT must not be accepted. This value corresponds to the *exp* JSON property.

This value is represented as a numeric value containing the number of seconds since the epoch (January 1st 1970). For instance *1498599163*.

# ClaimIssuedAt Property ([JWT](#jwt-component) Component)

The claim indicating the time at which the JWT was issued.

## Syntax

```text
public string ClaimIssuedAt { get; set; }
```

## Default Value

""

## Remarks

This property holds the time at which the JWT was issued. This value corresponds to the *iat* JSON property.

This value is represented as a numeric value containing the number of seconds since the epoch (January 1st 1970). For instance *1498599163*.

# ClaimIssuer Property ([JWT](#jwt-component) Component)

The issuer of the JWT.

## Syntax

```text
public string ClaimIssuer { get; set; }
```

## Default Value

""

## Remarks

This property holds the issuer of the JWT. The value is a case-sensitive string.

This property corresponds to the *iss* JSON property.

# ClaimJWTId Property ([JWT](#jwt-component) Component)

The unique identifier for the JWT.

## Syntax

```text
public string ClaimJWTId { get; set; }
```

## Default Value

""

## Remarks

This property holds the unique identifier for the JWT. The value is a case-sensitive string.

This property corresponds to the *jti* JSON property.

# ClaimNotBefore Property ([JWT](#jwt-component) Component)

The claim identifying the time before which the JWT is invalid.

## Syntax

```text
public string ClaimNotBefore { get; set; }
```

## Default Value

""

## Remarks

This property identifies the time before which the JWT is invalid. This value corresponds to the *nbf* JSON property.

This value is represented as a numeric value containing the number of seconds since the epoch (January 1st 1970). For instance *1498599163*.

# Claims Property ([JWT](#jwt-component) Component)

The claims in the JWT.

## Syntax

```text
public JWTClaimList Claims { get; }
```

## Remarks

This property specifies the claims within the JWT. This may be populated before calling [Sign](#sign-method-jwt-component) or [Encrypt](#encrypt-method-jwt-component). This is populated with the parsed claims after calling [Verify](#verify-method-jwt-component), [Decrypt](#decrypt-method-jwt-component), or [Parse](#parse-method-jwt-component).

This property is not available at design time.

 Please refer to the [JWTClaim](#jwtclaim-type) type for a complete list of fields.

# ClaimSubject Property ([JWT](#jwt-component) Component)

The subject identifies the principal of the JWT.

## Syntax

```text
public string ClaimSubject { get; set; }
```

## Default Value

""

## Remarks

This property holds the subject which identifies the principal of the JWT. The value is a case-sensitive string.

This property corresponds to the *sub* JSON property.

# ContentEncryptionAlgorithm Property ([JWT](#jwt-component) Component)

The algorithm used to encrypt the content.

## Syntax

```text
public JWTContentEncryptionAlgorithms ContentEncryptionAlgorithm { get; set; }
enum JWTContentEncryptionAlgorithms {
  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 |

# EncodedJWT Property ([JWT](#jwt-component) Component)

The encoded JWT.

## Syntax

```text
public string EncodedJWT { get; set; }
```

## Default Value

""

## Remarks

This property holds the encoded JWT. This is populated after calling [Sign](#sign-method-jwt-component) or [Encrypt](#encrypt-method-jwt-component).

This must be set to a valid JWT before calling [Verify](#verify-method-jwt-component), [Decrypt](#decrypt-method-jwt-component) or [Parse](#parse-method-jwt-component).

# EncryptionAlgorithm Property ([JWT](#jwt-component) Component)

The key encryption algorithm.

## Syntax

```text
public JWTEncryptionAlgorithms EncryptionAlgorithm { get; set; }
enum JWTEncryptionAlgorithms {
  eaRSA1_5,
  eaRSA_OAEP,
  eaRSA_OAEP_256,
  eaA128KW,
  eaA192KW,
  eaA256KW,
  eaDir,
  eaECDH_ES,
  eaECDH_ES_A128KW,
  eaECDH_ES_A192KW,
  eaECDH_ES_A256KW,
  eaA128GCMKW,
  eaA192GCMKW,
  eaA256GCMKW,
  eaPBES2_HS256_A128KW,
  eaPBES2_HS384_A192KW,
  eaPBES2_HS512_A256KW
}
```

## Default Value

0

## Remarks

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

When using an AES algorithm the [Key](#key-property-jwt-component) property must be specified. When using an RSA or ECDH algorithm the [RecipientCert](#recipientcert-property-jwt-component) property must be specified. When using a PBES algorithm the [KeyPassword](#keypassword-property-jwt-component) property must be specified;. Possible values are:

| Algorithm | Description | Key Location |
| --- | --- | --- |
| 0 (eaRSA1_5 - default) | RSAES-PKCS1-v1_5 | [Certificate](#certificate-property-jwt-component) |
| 1 (eaRSA_OAEP) | RSAES OAEP using default parameters | [Certificate](#certificate-property-jwt-component) |
| 2 (eaRSA_OAEP_256) | RSAES OAEP using SHA-256 and MGF1 with SHA-256 | [Certificate](#certificate-property-jwt-component) |
| 3 (eaA128KW) | AES Key Wrap with default initial using 128-bit key | [Key](#key-property-jwt-component) |
| 4 (eaA192KW) | AES Key Wrap with default initial using 192-bit key | [Key](#key-property-jwt-component) |
| 5 (eaA256KW) | AES Key Wrap with default initial using 256-bit key | [Key](#key-property-jwt-component) |
| 6 (eaDir) | Direct use of a shared symmetric key as the CEK | [Key](#key-property-jwt-component) |
| 7 (eaECDH_ES) | Elliptic Curve Ephemeral Static key agreement using Concat KDF | [Certificate](#certificate-property-jwt-component) |
| 8 (eaECDH_ES_A128KW) | ECDH-ES using Concat KDF and CEK wrapped with A128KW | [Certificate](#certificate-property-jwt-component) |
| 9 (eaECDH_ES_A192KW) | ECDH-ES using Concat KDF and CEK wrapped with A192KW | [Certificate](#certificate-property-jwt-component) |
| 10 (eaECDH_ES_A256KW) | ECDH-ES using Concat KDF and CEK wrapped with A256KW | [Certificate](#certificate-property-jwt-component) |
| 11 (eaA128GCMKW) | Key wrapping with AES GCM using 128-bit key | [Key](#key-property-jwt-component) |
| 12 (eaA192GCMKW) | Key wrapping with AES GCM using 192-bit key | [Key](#key-property-jwt-component) |
| 13 (eaA256GCMKW) | Key wrapping with AES GCM using 256-bit key | [Key](#key-property-jwt-component) |
| 14 (eaPBES2_HS256_A128KW) | PBES2 with HMAC SHA-256 and A128KW | [KeyPassword](#keypassword-property-jwt-component) |
| 15 (eaPBES2_HS384_A192KW) | PBES2 with HMAC SHA-384 and A192KW | [KeyPassword](#keypassword-property-jwt-component) |
| 16 (eaPBES2_HS512_A256KW) | PBES2 with HMAC SHA-512 and A256KW | [KeyPassword](#keypassword-property-jwt-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 ([JWT](#jwt-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](#sign-method-jwt-component) or [Encrypt](#encrypt-method-jwt-component). This is populated with the parsed header values after calling [Verify](#verify-method-jwt-component), [Decrypt](#decrypt-method-jwt-component), or [Parse](#parse-method-jwt-component).

This property is not available at design time.

 Please refer to the [HeaderParam](#headerparam-type) type for a complete list of fields.

# Key Property ([JWT](#jwt-component) Component)

The key used for AES.

## Syntax

```text
public string Key { get; set; }
public byte[] KeyB { get; set; }
```

## Default Value

""

## Remarks

This property specifies the key used when encrypting with an AES algorithm.

**Encrypting**

When [EncryptionAlgorithm](#encryptionalgorithm-property-jwt-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-jwt-component) is set to *Direct* this key is used directly with the algorithm specified by [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwt-component) and must be an appropriate size for the selected [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwt-component).

# KeyId Property ([JWT](#jwt-component) Component)

The Id of the key used to sign or encrypt the message.

## Syntax

```text
public string KeyId { get; set; }
```

## Default Value

""

## Remarks

This property optionally specifies the Id of the key used to sign the message.

Any string value may be supplied here to help the other party identify the key used to sign or encrypt the message. This may be set before calling the [Sign](#sign-method-jwt-component) or [Encrypt](#encrypt-method-jwt-component) method.

# KeyPassword Property ([JWT](#jwt-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-jwt-component).

This is only applicable to PBES algorithms and must be set before calling [Encrypt](#encrypt-method-jwt-component) or [Decrypt](#decrypt-method-jwt-component).

# RecipientCert Property ([JWT](#jwt-component) Component)

The certificate used for encryption.

## Syntax

```text
public Certificate RecipientCert { get; set; }
```

## Remarks

When calling [Encrypt](#encrypt-method-jwt-component) and [EncryptionAlgorithm](#encryptionalgorithm-property-jwt-component) is set to an RSA or ECDH algorithm this property must be set to a public certificate of the recipient.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# SignerCert Property ([JWT](#jwt-component) Component)

The certificate used for signature verification.

## Syntax

```text
public Certificate SignerCert { get; set; }
```

## Remarks

When calling [Verify](#verify-method-jwt-component) and the algorithm used is RSA or ECDSA this property must be set to the public certificate of the signer.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# SigningAlgorithm Property ([JWT](#jwt-component) Component)

The algorithm used when signing.

## Syntax

```text
public JWTSigningAlgorithms SigningAlgorithm { get; set; }
enum JWTSigningAlgorithms {
  saHS256,
  saHS384,
  saHS512,
  saRS256,
  saRS384,
  saRS512,
  saES256,
  saES384,
  saES512,
  saPS256,
  saPS384,
  saPS512,
  saES256K,
  saNone
}
```

## Default Value

0

## Remarks

This property specifies the algorithm to use when signing.

When signing with an HMAC algorithm [Key](#key-property-jwt-component) must be specified. When an RSA or ECDSA algorithm is selected [Certificate](#certificate-property-jwt-component) must be set before calling [Sign](#sign-method-jwt-component) and [SignerCert](#signercert-property-jwt-component) must be set before calling [Verify](#verify-method-jwt-component). The following values are supported:

| Algorithm | Description | Private Key Location |
| --- | --- | --- |
| 0 (saHS256 - default) | HMAC using SHA-256 | [Key](#key-property-jwt-component) |
| 1 (saHS384) | HMAC using SHA-384 | [Key](#key-property-jwt-component) |
| 2 (saHS512) | HMAC using SHA-512 | [Key](#key-property-jwt-component) |
| 3 (saRS256) | RSASSA-PKCS1-v1_5 using SHA-256 | [Certificate](#certificate-property-jwt-component) |
| 4 (saRS384) | RSASSA-PKCS1-v1_5 using SHA-384 | [Certificate](#certificate-property-jwt-component) |
| 5 (saRS512) | RSASSA-PKCS1-v1_5 using SHA-512 | [Certificate](#certificate-property-jwt-component) |
| 6 (saPS256) | RSASSA-PSS using SHA-256 and MGF1 with SHA-256 | [Certificate](#certificate-property-jwt-component) |
| 7 (saPS384) | RSASSA-PSS using SHA-384 and MGF1 with SHA-384 | [Certificate](#certificate-property-jwt-component) |
| 8 (saPS512) | RSASSA-PSS using SHA-512 and MGF1 with SHA-512 | [Certificate](#certificate-property-jwt-component) |
| 9 (saES256) | ECDSA using P-256 and SHA-256 | [Certificate](#certificate-property-jwt-component) |
| 10 (saES384) | ECDSA using P-384 and SHA-384 | [Certificate](#certificate-property-jwt-component) |
| 11 (saES512) | ECDSA using P-521 and SHA-512 | [Certificate](#certificate-property-jwt-component) |
| 12 (saES256K) | ECDSA using secp256k1 curve and SHA-256 | [Certificate](#certificate-property-jwt-component) |
| 99 (saNone) | None (unprotected) | Not Applicable |

Note: This setting is also applicable when [StrictValidation](#StrictValidation) is enabled before calling [Verify](#verify-method-jwt-component).

# SigningKey Property ([JWT](#jwt-component) Component)

The key used for HMAC.

## Syntax

```text
public string SigningKey { get; set; }
public byte[] SigningKeyB { get; set; }
```

## Default Value

""

## Remarks

This property specifies the key used when signing with an HMAC algorithm.

**Signing**

This property is applicable when [SigningAlgorithm](#signingalgorithm-property-jwt-component) is set to an HMAC algorithm.

It is recommended that the length of the key be equal to or larger than the hash size of the algorithm. Use of keys shorter than the hash size is discouraged.

**Sizes (in bytes)**

|  |  |  |  |  |  |  |  |
| --- | --- | --- | --- | --- | --- | --- | --- |
|  | SHA1 | SHA224 | SHA256 | SHA384 | SHA512 | MD5 | RIPEMD160 |
| Recommended Key Size | 20 | 28 | 32 | 48 | 64 | 16 | 20 |
| Hash Size | 20 | 28 | 32 | 48 | 64 | 16 | 20 |
| Block Size | 64 | 64 | 64 | 128 | 128 | 64 | 64 |

**Key Length Details**

As mentioned above it is recommended to use a key size equal to the hash size. Use of keys larger than the hash size does not typically significantly increase the function strength. Keys of any length are technically valid however see the below processing rules to understand how keys of varying lengths are treated:

- If the key length is equal to the hash size (recommended) it is used without modification.
- If the key length is less than the hash size it is used without modification.
- If the key length is less than or equal to the block size it is used without modification.
- If the key length is larger than the block size it is first hashed with the same algorithm.

# AddClaim Method ([JWT](#jwt-component) Component)

Adds an new claim.

## Syntax

```text
public void AddClaim(string name, string value, int dataType);

Async Version
public async Task AddClaim(string name, string value, int dataType);
public async Task AddClaim(string name, string value, int dataType, CancellationToken cancellationToken);
```

## Remarks

This method adds a claim to the existing claims. Use this method to add claims that are not already supported directly via properties.

The *Name* parameter defines the name of the claim. The *Value* parameter is the value, represented as a string. The JSON data type of the value is defined by the *DataType* parameter. Possible DataType values are:

- 0 (Object)
- 1 (Array)
- 2 (String)
- 3 (Number)
- 4 (Bool)
- 5 (Null)

# AddHeaderParam Method ([JWT](#jwt-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-jwt-component) or [Sign](#sign-method-jwt-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)

**Signing**

To add additional parameters to the JOSE header use this method. For instance to create this header:

```text
{
	"alg": "HS256",
	"crit": [
		"myheader"
	],
	"myheader": "testvalue"
}
```

The following code can be used:

```csharp
byte[] key = new byte[] { 170, 171, 221, 209, 7, 181, 48, 178, 48, 118, 242, 132, 36, 218, 74, 140, 216, 165, 161, 70, 11, 42, 246, 205, 235, 231, 19, 48, 87, 141, 122, 10 };

//Sign the payload using HS256
Jwt jwt = new Jwt();
jwt.SigningAlgorithm = JwtSigningAlgorithms.saHS256;
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.AddHeaderParam("crit", "[\"myheader\"]", 1);
jwt.AddHeaderParam("myheader", "testvalue", 2);
jwt.KeyB = key;
jwt.Sign();

string signedData = jwt.EncodedJWT;
```

Note: when calling [Sign](#sign-method-jwt-component) the component will automatically add some headers based on properties that are set.

**Parameters Automatically Set:**

| Header Param | Property |
| --- | --- |
| alg | Algorithm |
| kid | [KeyId](#keyid-property-jwt-component) |

**Encrypting**

To add additional parameters to the JOSE header use this method. For instance to create this header:

```text
{
	"alg": "A256GCMKW",
	"enc": "A128CBC-HS256",
	"iv": "cPTXlBL7aMiv-Dnf",
	"tag": "r5tmS-tXmfFngrybpnnt5g",
	"crit": [
		"myheader"
	],
	"myheader": "testvalue"
}
```

The following code can be used:

```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 };

Jwt jwt = new Jwt();
jwt.KeyB = key;
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.AddHeaderParam("crit", "[\"myheader\"]",1);
jwt.AddHeaderParam("myheader", "testvalue",2);
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaA256GCMKW;
jwt.Encrypt();

string encryptedData = jwt.EncodedJWT;
```

Note: When calling [Encrypt](#encrypt-method-jwt-component) the component will automatically add headers based on the selected [EncryptionAlgorithm](#encryptionalgorithm-property-jwt-component) and other properties that may be set.

**Parameters Automatically Set:**

| Header Param | Property |
| --- | --- |
| alg | [EncryptionAlgorithm](#encryptionalgorithm-property-jwt-component) |
| enc | [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwt-component) |
| kid | [KeyId](#keyid-property-jwt-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 ([JWT](#jwt-component) Component)

Sets or retrieves a configuration setting.

## Syntax

```text
public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> 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-jwt-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-jwt-component), you must call *Config("PROPERTY")*. The value will be returned as a string.

# Decrypt Method ([JWT](#jwt-component) Component)

Decrypts the encoded JWT.

## Syntax

```text
public void Decrypt();

Async Version
public async Task Decrypt();
public async Task Decrypt(CancellationToken cancellationToken);
```

## Remarks

This method decrypts the encoded JWT.

Before calling the Decrypt method set [EncodedJWT](#encodedjwt-property-jwt-component) to a valid compact serialized JWT string. For instance:

```plaintext
eyJhbGciOiJBMjU2S1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2In0.4tcAnZJ00u4GY2kLOanPOL4CtvcfraZ8SIi6bOZ27qYBI2rHITPc1Q.c_9rCTdPn-saLCti2ZEyWQ.eLwqqo5BGNa70RlsvT-vTh7Gk0hjpJYY_9Zc39Vim_qEtjyMcxZygBpkfx9brzQr9rUbuiAhoCMXKip2-lKT6w.NkuLDPmWxWL4BaTWHWicIQ
```

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-jwt-component) |
| RSA and ECDH | [Certificate](#certificate-property-jwt-component) |
| PBES | [KeyPassword](#keypassword-property-jwt-component) |

 If the correct [Key](#key-property-jwt-component) or [Certificate](#certificate-property-jwt-component) is not known ahead of time the *KeyId* parameter of the [RecipientInfo](#recipientinfo-event-jwt-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 **Claim*** properties and the [HeaderParams](#headerparams-property-jwt-component) property will contain the headers. Headers of the parsed message are also available through the [HeaderParam](#headerparam-event-jwt-component) event.

The following properties are applicable when calling this method:

- [Certificate](#certificate-property-jwt-component) (conditional - required for RSA and ECDH)
- [EncodedJWT](#encodedjwt-property-jwt-component)
- [Key](#key-property-jwt-component) (conditional - required for AES)
- [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwt-component) (only if [StrictValidation](#StrictValidation) is True)
- [EncryptionAlgorithm](#encryptionalgorithm-property-jwt-component) (only if [StrictValidation](#StrictValidation) is True)
- [HeaderParams](#headerparams-property-jwt-component)
- [StrictValidation](#StrictValidation)

After calling this method the following properties are populated:

- [ClaimAudience](#claimaudience-property-jwt-component)
- [ClaimExp](#claimexp-property-jwt-component)
- [ClaimIssuedAt](#claimissuedat-property-jwt-component)
- [ClaimIssuer](#claimissuer-property-jwt-component)
- [ClaimJWTId](#claimjwtid-property-jwt-component)
- [ClaimNotBefore](#claimnotbefore-property-jwt-component)
- [Claims](#claims-property-jwt-component)
- [ClaimSubject](#claimsubject-property-jwt-component)
- [HeaderParams](#headerparams-property-jwt-component)

**Notes for AES Algorithms (A128KW, A192KW, A256KW, A128GCMKW, A192GCMKW, A256GCMKW)**

To decrypt messages that use AES encryption [Key](#key-property-jwt-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 };

Jwt jwt = new Jwt();
jwt.KeyB = key;
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();

string issuer = jwt.ClaimIssuer;
```

**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
Jwt jwt = new Jwt();
jwt.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "..\\jwt.pfx", "password", "*");
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();

string issuer = jwt.ClaimIssuer;
```

**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-jwt-component) property.

```csharp
Jwt jwt = new Jwt();
jwt.Certificate = new Certificate(CertStoreTypes.cstPEMKeyFile, privKeyFile, "", "*");
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();

string issuer = jwt.ClaimIssuer;
```

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
nsoftware.IPWorksEncrypt.Ecc ecc = new nsoftware.IPWorksEncrypt.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;

Jwt jwt = new Jwt();
jwt.Certificate = new Certificate(CertStoreTypes.cstPEMKeyBlob, privKey, "", "*");
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();

string issuer = jwt.ClaimIssuer;
```

**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-jwt-component) property. Set [KeyPassword](#keypassword-property-jwt-component) to the shared secret.

```csharp
Jwt jwt = new Jwt();
jwt.KeyPassword = "secret";
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();

string issuer = jwt.ClaimIssuer;
```

**Notes for Direct Shared Keys**

When Direct encryption is used the [Key](#key-property-jwt-component) property must be set to a valid symmetric key that will be used directly by the [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwt-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 };

Jwt jwt = new Jwt();
jwt.KeyB = key;
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();

string issuer = jwt.ClaimIssuer;
```

# DecryptAndVerify Method ([JWT](#jwt-component) Component)

Decrypts the encoded JWT, and verifies the signature.

## Syntax

```text
public void DecryptAndVerify();

Async Version
public async Task DecryptAndVerify();
public async Task DecryptAndVerify(CancellationToken cancellationToken);
```

## Remarks

TBD.

# Encrypt Method ([JWT](#jwt-component) Component)

Encrypts the claims 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 claims using the specified algorithms.

To create an encrypted JWT 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-jwt-component). The content encryption key is then encrypted itself using the algorithm specified by [EncryptionAlgorithm](#encryptionalgorithm-property-jwt-component). The content encryption key is not directly exposed in the API as it is randomly generated.

After calling this method the compact serialized JWT is written to [EncodedJWT](#encodedjwt-property-jwt-component). For instance:

*eyJhbGciOiJBMjU2S1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2In0.4tcAnZJ00u4GY2kLOanPOL4CtvcfraZ8SIi6bOZ27qYBI2rHITPc1Q.c_9rCTdPn-saLCti2ZEyWQ.eLwqqo5BGNa70RlsvT-vTh7Gk0hjpJYY_9Zc39Vim_qEtjyMcxZygBpkfx9brzQr9rUbuiAhoCMXKip2-lKT6w.NkuLDPmWxWL4BaTWHWicIQ*

The component will use the values present in the **Claim*** properties to build the encoded JWT. After calling this method the [EncodedJWT](#encodedjwt-property-jwt-component) property will hold the compact serialized JWT. The following properties are applicable when calling this method:

- [EncryptionAlgorithm](#encryptionalgorithm-property-jwt-component) (required)
- [Key](#key-property-jwt-component) (conditional - required for AES)
- [KeyPassword](#keypassword-property-jwt-component) (conditional - required for PBES)
- [RecipientCert](#recipientcert-property-jwt-component) (conditional - required for ECDH and RSA)
- [ClaimAudience](#claimaudience-property-jwt-component)
- [ClaimExp](#claimexp-property-jwt-component)
- [ClaimIssuedAt](#claimissuedat-property-jwt-component)
- [ClaimIssuer](#claimissuer-property-jwt-component)
- [ClaimJWTId](#claimjwtid-property-jwt-component)
- [ClaimNotBefore](#claimnotbefore-property-jwt-component)
- [Claims](#claims-property-jwt-component)
- [CompressionAlgorithm](#CompressionAlgorithm)
- [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwt-component)
- [HeaderParams](#headerparams-property-jwt-component)
- [KeyId](#keyid-property-jwt-component)

**Notes for AES Algorithms (A128KW, A192KW, A256KW, A128GCMKW, A192GCMKW, A256GCMKW)**

When [EncryptionAlgorithm](#encryptionalgorithm-property-jwt-component) is set to a AES algorithm [Key](#key-property-jwt-component) must be set to a key of appropriate length for the algorithm. For instance a 256 bit key would be used for A256KW.

To use an existing AES key provide the bytes to the [Key](#key-property-jwt-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
Jwt jwt = new Jwt();
jwt.KeyB = key;
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaA256KW;
jwt.Encrypt();

string encryptedData = jwt.EncodedJWT;
```

**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
Jwt jwt = new Jwt();
jwt.Certificate = new Certificate("..\\recipient.cer");
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaRSA_OAEP;
jwt.Encrypt();

string encryptedData = jwt.EncodedJWT;
```

**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-jwt-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
Jwt jwt = new Jwt();
jwt.Certificate = new Certificate(CertStoreTypes.cstPublicKeyFile, pubKeyFile, "", "*");
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaECDH_ES_A256KW;
jwt.Encrypt();

string encryptedData = jwt.EncodedJWT;
```

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 };

nsoftware.IPWorksEncrypt.Ecc ecc = new nsoftware.IPWorksEncrypt.Ecc();
ecc.Key.RxB = x_bytes;
ecc.Key.RyB = y_bytes;

string pubKey = ecc.Key.PublicKey;

Jwt jwt = new Jwt();
jwt.Certificate = new Certificate(CertStoreTypes.cstPublicKeyFile, pubKey, "", "*");
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaECDH_ES_A256KW;
jwt.Encrypt();

string encryptedData = jwt.EncodedJWT;
```

**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-jwt-component) property. Set [KeyPassword](#keypassword-property-jwt-component) to a shared secret.

```csharp
Jwt jwt = new Jwt();
jwt.KeyPassword = "secret";
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaPBES2_HS512_A256KW;
jwt.Encrypt();

string encryptedData = jwt.EncodedJWT;
```

**Notes for Direct Shared Keys**

When [EncryptionAlgorithm](#encryptionalgorithm-property-jwt-component) is set to *Direct* the [Key](#key-property-jwt-component) property must be set to a valid symmetric key that will be used directly by the [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwt-component). In this case a content encryption key is not generated randomly, the [Key](#key-property-jwt-component) is used instead. The length of the specified [Key](#key-property-jwt-component) must be valid for the selected [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwt-component). For instance:

```csharp
byte[] key = new byte[] { 164, 62, 191, 60, 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 };

Jwt jwt = new Jwt();
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaDir;
jwt.ContentEncryptionAlgorithm = JwtContentEncryptionAlgorithms.ceaA256GCM;
jwt.KeyB = key;
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.Encrypt();

string encryptedData = jwt.EncodedJWT;
```

# Parse Method ([JWT](#jwt-component) Component)

Parses the encoded JWT.

## Syntax

```text
public void Parse();

Async Version
public async Task Parse();
public async Task Parse(CancellationToken cancellationToken);
```

## Remarks

This method parses, but does not verify the encoded JWT.

Take care when using this method as no verification or decryption is performed. This method may be helpful in cases where only header information is desired.

If verification or decryption is desired, use [Verify](#verify-method-jwt-component) or [Decrypt](#decrypt-method-jwt-component) instead. It is not necessary to call this method before calling [Verify](#verify-method-jwt-component) or [Decrypt](#decrypt-method-jwt-component). [Verify](#verify-method-jwt-component) or [Decrypt](#decrypt-method-jwt-component) will both parse and decrypt the message.

When calling this method the headers are parsed. The [HeaderParam](#headerparam-event-jwt-component) and [RecipientInfo](#recipientinfo-event-jwt-component) events will fire and the [HeaderParams](#headerparams-property-jwt-component) property will be populated.

If the message is signed (not encrypted) the claims will also be parsed and the **Claim*** properties will be populated.

# Reset Method ([JWT](#jwt-component) Component)

Resets the component properties.

## Syntax

```text
public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);
```

## Remarks

This method resets all message and key properties to their default values.

# Sign Method ([JWT](#jwt-component) Component)

Signs the payload with the specified algorithm.

## Syntax

```text
public void Sign();

Async Version
public async Task Sign();
public async Task Sign(CancellationToken cancellationToken);
```

## Remarks

This method signs the claims specified by the **Claim*** properties with the specified [SigningAlgorithm](#signingalgorithm-property-jwt-component).

Before calling the Sign method set [SigningAlgorithm](#signingalgorithm-property-jwt-component) to the algorithm which will be used to sign the message. The result of signing is a compact serialized JWT string. For instance:

*eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOlsiYXVkaWVuY2UiXSwiaXNzIjoiaXNzdWVyIn0.mlFETSma4WUcUSjNSUWA1n9QBcQHCkHN-y4zeBsCVqI*

The component will use the values present in the **Claim*** properties to build the encoded JWT. After calling this method the [EncodedJWT](#encodedjwt-property-jwt-component) property will hold the compact serialized JWT. The following properties are applicable when calling this method:

- [SigningAlgorithm](#signingalgorithm-property-jwt-component) (required)
- [Certificate](#certificate-property-jwt-component) (conditional - required for ECDSA and RSA)
- [Key](#key-property-jwt-component) (conditional - required for HMAC)
- [ClaimAudience](#claimaudience-property-jwt-component)
- [ClaimExp](#claimexp-property-jwt-component)
- [ClaimIssuedAt](#claimissuedat-property-jwt-component)
- [ClaimIssuer](#claimissuer-property-jwt-component)
- [ClaimJWTId](#claimjwtid-property-jwt-component)
- [ClaimNotBefore](#claimnotbefore-property-jwt-component)
- [Claims](#claims-property-jwt-component)
- [HeaderParams](#headerparams-property-jwt-component)
- [KeyId](#keyid-property-jwt-component)

**Notes for HMAC Algorithms (HS256, HS384, HS512)**

When [SigningAlgorithm](#signingalgorithm-property-jwt-component) is set to a HMAC algorithm [Key](#key-property-jwt-component) must be set to a key of appropriate length for the algorithm. The [Key](#key-property-jwt-component) should be the same number of bits as the algorithm being used. For instance a 256 bit key would be used for HS256.

The key must be known by both parties in order for signing and verification to take place. To use an existing HMAC key provide the bytes to the [Key](#key-property-jwt-component) property. For instance:

```csharp
//HMAC SHA-256 Key
byte[] key = new byte[] { 170, 171, 221, 209, 7, 181, 48, 178, 48, 118, 242, 132, 36, 218, 74, 140, 216, 165, 161, 70, 11, 42, 246, 205, 235, 231, 19, 48, 87, 141, 122, 10 };

//Sign the payload using HS256
Jwt jwt = new Jwt();
jwt.SigningAlgorithm = JwtSigningAlgorithms.saHS256;
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.KeyB = key;
jwt.Sign();

string signedData = jwt.EncodedJWT;
```

**Notes for RSA Algorithms (RS256, RS384, RS512, PS256, PS384, PS512)**

The RSA based algorithms use asymmetric encryption. Signing is done with a private key and verification is done with a public key. The private key may be in PFX or PEM format.

```csharp
Jwt jwt = new Jwt();
jwt.SigningAlgorithm = JwtSigningAlgorithms.saRS256;
jwt.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "..\\jwt.pfx", "test", "*");
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.Sign();

string signedMessage = jwt.EncodedJWT;
```

**Notes for ECDSA Algorithms (ES256, ES384, ES512)**

ECDSA algorithms require a valid ECC private key in order to sign data. The [Certificate](#certificate-property-jwt-component) property should be set to a certificate with an ECC key. The [CertMgr](CertMgr.md#CertMgr) component can be used to create a certificate with an ECC key.

```csharp
//Create an ECC key with SHA-256
Certmgr mgr = new Certmgr();
mgr.Config("CertPublicKeyAlgorithm=ECDSA_P256");
mgr.CertStoreType = CertStoreTypes.cstPEMKeyFile;
mgr.CertStore = "C:\\temp\\ecdsa.pem";
mgr.CreateCertificate("CN=ecdsa", 123);

//Sign the payload using ES256
Jwt jwt = new Jwt();
jwt.SigningAlgorithm = JwtSigningAlgorithms.saES256;
jwt.Certificate = new Certificate(CertStoreTypes.cstPEMKeyFile, "C:\\temp\\ecdsa.pem", "", "*");
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.Sign();

string signedMessage = jwt.EncodedJWT;
```

**Notes for Unsecured (none)**

To create a JWS token without any security set [SigningAlgorithm](#signingalgorithm-property-jwt-component) to *jwtNone*.

```csharp
Jwt jwt = new Jwt();
jwt.SigningAlgorithm = JwtSigningAlgorithms.saNone;
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.Sign();

string unsecuredMessage = jwt.EncodedJWT;
```

# SignAndEncrypt Method ([JWT](#jwt-component) Component)

Signs the payload with the specified algorithm, and encrypts the result of signing.

## Syntax

```text
public void SignAndEncrypt();

Async Version
public async Task SignAndEncrypt();
public async Task SignAndEncrypt(CancellationToken cancellationToken);
```

## Remarks

TBD.

# Verify Method ([JWT](#jwt-component) Component)

Verifies the signature of the encoded JWT.

## Syntax

```text
public void Verify();

Async Version
public async Task Verify();
public async Task Verify(CancellationToken cancellationToken);
```

## Remarks

This method verifies the signature of the encoded JWT.

Before calling the Verify method set [EncodedJWT](#encodedjwt-property-jwt-component) to a valid compact serialized JWT. For instance:

*eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOlsiYXVkaWVuY2UiXSwiaXNzIjoiaXNzdWVyIn0.mlFETSma4WUcUSjNSUWA1n9QBcQHCkHN-y4zeBsCVqI*

The [Key](#key-property-jwt-component) or [SignerCert](#signercert-property-jwt-component) properties should be set to the HMAC key or public certificate respectively. If the correct [Key](#key-property-jwt-component) or [SignerCert](#signercert-property-jwt-component) is not known ahead of time the *KeyId* parameter of the [SignerInfo](#signerinfo-event-jwt-component) event may be used to identify the correct key.

If this method returns without error verification was successful. If verification fails then this method throws an exception. After calling this method the claims will be parsed and the **Claim*** properties will be populated. The the [HeaderParams](#headerparams-property-jwt-component) property will contain the headers. Headers of the parsed message are also available through the [HeaderParam](#headerparam-event-jwt-component) event.

The following properties are applicable when calling this method:

- [EncodedJWT](#encodedjwt-property-jwt-component) (required)
- [Key](#key-property-jwt-component) (conditional - required for HMAC)
- [SignerCert](#signercert-property-jwt-component) (conditional - required for ECDSA and RSA)
- [SigningAlgorithm](#signingalgorithm-property-jwt-component) (only if [StrictValidation](#StrictValidation) is True)
- [StrictValidation](#StrictValidation)
- [ExpectedAudience](#ExpectedAudience) (optional)
- [ExpectedExp](#ExpectedExp) (optional)
- [ExpectedIssuedAt](#ExpectedIssuedAt) (optional)
- [ExpectedIssuer](#ExpectedIssuer) (optional)
- [ExpectedJWTId](#ExpectedJWTId) (optional)
- [ExpectedNotBefore](#ExpectedNotBefore) (optional)
- [ExpectedSubject](#ExpectedSubject) (optional)

After calling this method the following properties are populated:

- [ClaimAudience](#claimaudience-property-jwt-component)
- [ClaimExp](#claimexp-property-jwt-component)
- [ClaimIssuedAt](#claimissuedat-property-jwt-component)
- [ClaimIssuer](#claimissuer-property-jwt-component)
- [ClaimJWTId](#claimjwtid-property-jwt-component)
- [ClaimNotBefore](#claimnotbefore-property-jwt-component)
- [Claims](#claims-property-jwt-component)
- [ClaimSubject](#claimsubject-property-jwt-component)
- [HeaderParams](#headerparams-property-jwt-component)

**Notes for HMAC Algorithms (HS256, HS384, HS512)**

When verifying a message originally signed with a HMAC algorithm [Key](#key-property-jwt-component) must be set to the same key used during signing. The key must be known by both parties in order for signing and verification to take place.

```csharp
byte[] key = new byte[] { 170, 171, 221, 209, 7, 181, 48, 178, 48, 118, 242, 132, 36, 218, 74, 140, 216, 165, 161, 70, 11, 42, 246, 205, 235, 231, 19, 48, 87, 141, 122, 10 };

Jwt jwt = new Jwt();
jwt.KeyB = key;
jwt.EncodedJWT = signedData;
jwt.Verify();

string issuer = jwt.ClaimIssuer;
```

**Notes for RSA Algorithms (RS256, RS384, RS512, PS256, PS384, PS512)**

The RSA based algorithms use asymmetric encryption. Signing is done with a private key and verification is done with a public key. The public key is typically in PEM format.

```csharp
Jwt jwt = new Jwt();
jwt.SignerCert = new Certificate("..\\jwt.cer");
jwt.EncodedJWT = signedData;
jwt.Verify();

string issuer = jwt.ClaimIssuer;
```

**Notes for ECDSA Algorithms (ES256, ES384, ES512)**

ECDSA algorithms require a valid ECC public key to verify the message. The PEM encoded public key may be used directly with the [Certificate](#certificate-property-jwt-component) property. An example PEM encoded public certificate created by the [CertMgr](CertMgr.md#CertMgr) component:

```text
-----BEGIN CERTIFICATE-----
MIIBETCBtaADAgECAgF7MAwGCCqGSM49BAMCBQAwEDEOMAwGA1UEAxMFZWNkc2EwHhcNMjMw
NzAzMTcwMjU3WhcNMjQwNzAyMTcwMjU3WjAQMQ4wDAYDVQQDEwVlY2RzYTBZMBMGByqGSM49
AgEGCCqGSM49AwEHA0IABGJv251JI7ITcq+fac9Z2yYkhTLSRhWGzBw1wEJZbs/8AZbVmvcy
4BzKSZEaTfBsCHIt3FLNgRLdugI+B65eQDYwDAYIKoZIzj0EAwIFAANJADBGAiEAzmH5LKKn
r4iy9kJvIlCslpcBHM/8k0XQaj13Zwhm2ocCIQD/cSiC4EuqRkxT4IKET7ko3iI5YUS+J5W5
/0xnxxxIpQ==
-----END CERTIFICATE-----
```

```csharp
Jwt jwt = new Jwt();
jwt.SignerCert = new Certificate(CertStoreTypes.cstPublicKeyBlob, pubKey, "", "*");
jwt.EncodedJWT = signedData;
jwt.Verify();

string issuer = jwt.ClaimIssuer;
```

**Notes for Unsecured (none)**

To parse a JWS token without any security call the [Sign](#sign-method-jwt-component) method without setting the [Key](#key-property-jwt-component) or [Certificate](#certificate-property-jwt-component) properties.

```csharp
Jwt jwt = new Jwt();
jwt.EncodedJWT = signedData;
jwt.Verify();

string issuer = jwt.ClaimIssuer;
```

# ClaimInfo Event ([JWT](#jwt-component) Component)

Fires once for each claim.

## Syntax

```text
public event OnClaimInfoHandler OnClaimInfo;

public delegate void OnClaimInfoHandler(object sender, JWTClaimInfoEventArgs e);

public class JWTClaimInfoEventArgs : EventArgs {
  public string Name { get; }
  public string Value { get; }
  public int DataType { get; }
}
```

## Remarks

When [Decrypt](#decrypt-method-jwt-component), [Verify](#verify-method-jwt-component) or [Parse](#parse-method-jwt-component) is called this event will fire once for each claim in the JWT.

*Name* is the name of the claim.

*Value* is the value of the claim.

*DataType* specifies the JSON data type of the value. Possible values are:

- 0 (Object)
- 1 (Array)
- 2 (String)
- 3 (Number)
- 4 (Bool)
- 5 (Null)

# Error Event ([JWT](#jwt-component) Component)

Fired when information is available about errors during data delivery.

## Syntax

```text
public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, JWTErrorEventArgs e);

public class JWTErrorEventArgs : 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-jwt-component) section.

# HeaderParam Event ([JWT](#jwt-component) Component)

Fires once for each JOSE header parameter.

## Syntax

```text
public event OnHeaderParamHandler OnHeaderParam;

public delegate void OnHeaderParamHandler(object sender, JWTHeaderParamEventArgs e);

public class JWTHeaderParamEventArgs : EventArgs {
  public string Name { get; }
  public string Value { get; }
  public int DataType { get; }
}
```

## Remarks

When [Decrypt](#decrypt-method-jwt-component), [Verify](#verify-method-jwt-component) or [Parse](#parse-method-jwt-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 ([JWT](#jwt-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, JWTRecipientInfoEventArgs e);

public class JWTRecipientInfoEventArgs : 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-jwt-component) or [Certificate](#certificate-property-jwt-component) properties to load in order to decrypt the message. This event fires when [Decrypt](#decrypt-method-jwt-component) or [Parse](#parse-method-jwt-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.

# SignerInfo Event ([JWT](#jwt-component) Component)

Fires with information about the signature.

## Syntax

```text
public event OnSignerInfoHandler OnSignerInfo;

public delegate void OnSignerInfoHandler(object sender, JWTSignerInfoEventArgs e);

public class JWTSignerInfoEventArgs : EventArgs {
  public string KeyId { get; }
  public string Algorithm { get; }
}
```

## Remarks

This event fires with information about the signature. This may be used to help identify the [Key](#key-property-jwt-component) or [Certificate](#certificate-property-jwt-component) properties to load in order to verify the signature. This event fires when [Verify](#verify-method-jwt-component) or [Parse](#parse-method-jwt-component) is called.

*KeyId* is the Id of the key as supplied by the signer that created the message. This may be empty.

*Algorithm* is the signature algorithm used to sign the message.

# 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.

# JWTClaim Type

The claim within the JWT.

## Remarks

This type holds the claim information. The fields define the name, value, and data type of the claim value.

The following fields are available:

- [DataType](#JWTClaim_f_DataType)

- [Name](#JWTClaim_f_Name)

- [Value](#JWTClaim_f_Value)

## Fields

 **DataType** *TDataTypes*
Default: 2

The data type of the claim value.

This field specifies the JSON type of the claim value. Possible values are:

- 0 (Object)
- 1 (Array)
- 2 (String)
- 3 (Number)
- 4 (Bool)
- 5 (Null)

 **Name** *string*
Default: ""

The claim name.

 **Value** *string*
Default: ""

The claim value.

## Constructors

```text
public JWTClaim();
```

 Creates a new claim with no name or value.

```text
public JWTClaim(string name, string value);
```

 Create a new claim. The DataType of the value will be a String.

```text
public JWTClaim(string name, string value, int dataType);
```

 Creates a new claim with the specified DataType.

# Config Settings ([JWT](#jwt-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-jwt-component) method.

### JWT Config Settings

**AllowedSigningAlgorithms**: Allowed signing algorithms when StrictValidation is set to True.This setting specifics a comma separated list of algorithms that are allowed when [StrictValidation](#StrictValidation) is set to *true*. This allows multiple signing algorithms to be considered acceptable during validation. This setting is only applicable when [StrictValidation](#StrictValidation) is set to *true*. Possible values:

- *HS256*
- *HS384*
- *HS512*
- *RS256*
- *RS384*
- *RS512*
- *ES256*
- *ES384*
- *ES512*
- *PS256*
- *PS384*
- *PS512*

Example value: *HS512,HS256*.

**AudienceDelimiter**: Defines the character to separate audience values.This setting specifies the character to used to separate multiple audience values. [ClaimAudience](#claimaudience-property-jwt-component) may contain multiple values. When multiple values are present they will be separated by this character. The default value is *;*.

When setting [ClaimAudience](#claimaudience-property-jwt-component) that contains multiple audiences specify multiple value separated by the character set here. For instance:

```csharp
jwt.ClaimAudience = "aud1;aud2";
```

**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)

**ExpectedAudience**: The expected audience claim.This setting specifies the expected audience claim. When set prior to calling the [Verify](#verify-method-jwt-component) method, the component will compare the audience claim from the [EncodedJWT](#encodedjwt-property-jwt-component) with this value.

**ExpectedExp**: The expected expiration time claim.This setting specifies the expected expiration time claim. When set prior to calling the [Verify](#verify-method-jwt-component) method, the component will compare the expiration time claim from the [EncodedJWT](#encodedjwt-property-jwt-component) with this value.

**ExpectedIssuedAt**: The expected time at which the JWT was issued.This setting specifies the expected issued at claim. When set prior to calling the [Verify](#verify-method-jwt-component) method, the component will compare the issued at claim from the [EncodedJWT](#encodedjwt-property-jwt-component) with this value.

**ExpectedIssuer**: The expected issuer of the JWT.This setting specifies the expected issuer of the JWT. When set prior to calling the [Verify](#verify-method-jwt-component) method, the component will compare the issuer of the [EncodedJWT](#encodedjwt-property-jwt-component) with this value.

**ExpectedJWTId**: The expected unique identifier for the JWT.This setting specifies the expected ID of the JWT. When set prior to calling the [Verify](#verify-method-jwt-component) method, the component will compare the JWT ID of the [EncodedJWT](#encodedjwt-property-jwt-component) with this value.

**ExpectedNotBefore**: The expected claim identifying the time before which the JWT is invalid.This setting specifies the expected not before claim of the JWT. When set prior to calling the [Verify](#verify-method-jwt-component) method, the component will compare the not before of claim of the [EncodedJWT](#encodedjwt-property-jwt-component) with this value.

**ExpectedSubject**: The expected subject identifying the principal of the JWT.This setting specifies the expected subject claim of the JWT. When set prior to calling the [Verify](#verify-method-jwt-component) method, the component will compare the subject claim of the [EncodedJWT](#encodedjwt-property-jwt-component) with this value.

**IncludeCertificateFormat**: The certificate values to include in the signed message (if any).This setting specifies whether information about the [Certificate](#certificate-property-jwt-component) is included in the signed message. When specified, the value here determines the format of the included certificate information. The certificate information is included as a standard JWS header parameter.

Multiple formats may be included in the signed message. The value specified should be the binary 'OR' of one or more of the following values:

| Value | Description | JWS Header Param |
| --- | --- | --- |
| 0 (0x00 - default) | None |  |
| 1 (0x01) | X.509 Certificate Chain | x5c |
| 2 (0x02) | X.509 Certificate SHA-1 Thumbprint (Base64-URL encoded) | x5t |
| 4 (0x04) | X.509 Certificate SHA-256 Thumbprint (Base64-URL encoded) | x5t#S256 |

Note: When including the certificate chain (*0x01*) the public certificate of [Certificate](#certificate-property-jwt-component) property will automatically be included. [IssuerCerts](#IssuerCerts) may also be set to the public issuer certificates that will be used when building the chain to include.

For instance, to include both the certificate chain and SHA-256 thumbprint of the [Certificate](#certificate-property-jwt-component) set this to *5*.

**InputMessage**: The raw input to process.This setting optionally specifies the pay payload to process. When calling [Sign](#sign-method-jwt-component) or [Encrypt](#encrypt-method-jwt-component) input is taken from this setting if specified. If a value is set here the **Claim*** properties are ignored.

**IsEncrypted**: Indicates whether the EncodedJWT is encrypted.This setting may be queried after calling [Parse](#parse-method-jwt-component) to determine if the [EncodedJWT](#encodedjwt-property-jwt-component) is encrypted.

**IsSigned**: Indicates whether the EncodedJWT is signed.This setting may be queried after calling [Parse](#parse-method-jwt-component) to determine if the [EncodedJWT](#encodedjwt-property-jwt-component) is signed.

**IssuerCerts**: A collection of issuer certificates used with IncludeCertificateFormat.This setting optionally specifies one or more issuer certificates that may be used by the component when [IncludeCertificateFormat](#IncludeCertificateFormat) is specified. Note that the issuer certificates specified here are used as a store of potential issuer certificates. At runtime the component will inspect the [Certificate](#certificate-property-jwt-component) value and add the relevant issuer certificates that are present in this property.

The format of the value must be one or more PEM encoded certificates with headers and footers. For instance to include 2 issuer certificates the value may be:

```text
-----BEGIN CERTIFICATE-----
MIIBujCCASOgAwIBAgICA+kwDQYJKoZIhvcNAQELBQAwHTEbMBkGA1UEAxMSbnVuaXRDZXJ0
Q2hhaW5Sb290MCAXDTE4MTAxNTA5MDAxN1oYDzIxMTgwOTIxMDkwMDE3WjAmMSQwIgYDVQQD
...
Tr+wi0ouNo7ifWRcE83Z15PhfGn1nkfxMYj4rya5n+V0RVVcgFUdiolCI5o/sYq503a7kH16
JSF5Zw+TiMz/COM8R94=
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIBsTCCARqgAwIBAgICA+gwDQYJKoZIhvcNAQELBQAwHTEbMBkGA1UEAxMSbnVuaXRDZXJ0
Q2hhaW5Sb290MCAXDTE4MTAxNTA5MDAxN1oYDzIxMTgwOTIxMDkwMDE3WjAdMRswGQYDVQQD
...
5u2K9PuJ3ySgL7AvYsqbB/e0/gw8j253SOU+gNTpFahOJsLGEJ43CRtaowkLnWEzs+OPnRfw
iQmqruw=
-----END CERTIFICATE-----
```

**KeyEncoding**: The encoding of the Key value.This setting specifies the encoding that has been applied to the [Key](#key-property-jwt-component). value prior to providing it to the component. The [Key](#key-property-jwt-component) is typically represented as an array of bytes, however in some cases the key value may have been encoded. As a matter of convenience the component will accept the key with an encoding already applied. The component will decode the key value according the to the value specified here before processing. Possible values are:

- 0 (none - default)
- 1 (Base64)
- 2 (Hex)
- 3 (Base64URL)

**OutputMessage**: The raw output of the operation.After calling [Verify](#verify-method-jwt-component) or [Decrypt](#decrypt-method-jwt-component) this holds the raw JSON payload. This may be useful for debugging or logging purposes when the JSON payload is desired.

**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-jwt-component). When calling [Decrypt](#decrypt-method-jwt-component) this setting is populated and also accessible from within the [RecipientInfo](#recipientinfo-event-jwt-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-jwt-component). When calling [Decrypt](#decrypt-method-jwt-component) this setting is populated and also accessible from within the [RecipientInfo](#recipientinfo-event-jwt-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-jwt-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-jwt-component) is set to a PBES algorithm.

**RawHeader**: Holds the raw JOSE header.This setting may be queried after calling [Sign](#sign-method-jwt-component) or [Verify](#verify-method-jwt-component) to obtain the raw JOSE header. This returns a JSON string like:

*{"alg":"ES384","kid":"myKeyId"}*

**StrictValidation**: Requires specific algorithms when processing.If set to True the component will validate that the algorithm used in the JWT matches the values specified in [EncryptionAlgorithm](#encryptionalgorithm-property-jwt-component), [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-jwt-component), and [SigningAlgorithm](#signingalgorithm-property-jwt-component). This is applicable when calling [Decrypt](#decrypt-method-jwt-component) and [Verify](#verify-method-jwt-component).

By default this is False and the algorithms are read automatically from the encoded JWT.

### 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 ([JWT](#jwt-component) Component)

### JWT Errors

|  |  |
| --- | --- |
| 301 | EncodedJWT is not set. The input is not valid. |
| 302 | Failed to parse claims. See error message for details. |
| 303 | Claim is not within its validity period. |
| 304 | Failed to verify an expected claim value. See error message for details. |

### JWS Errors

|  |  |
| --- | --- |
| 201 | Invalid JWS value. Not recognized as a compact serialized JWS string. |
| 202 | Signature verification failed. |
| 203 | Key must be specified before attempting this operation. |
| 204 | The specified key is too short for the selected algorithm. |
| 205 | Certificate must be specified before attempting this operation. |
| 206 | Unsupported algorithm. |
| 207 | OutputFile already exists and Overwrite is False. |
| 208 | Error writing data. See error message for details. |

### 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. |