# Struct ipworksencrypt::JWS

Create, Sign and Verify JSON Web Signatures (JWS).

## Syntax

```text
ipworksencrypt::JWS
```

## Remarks

The JWS struct supports signing and verifying JSON Web Signatures (JWS).

Specify any payload via input properties and use [sign](#sign-method-jws-struct) to create a JWS message using a variety of algorithms including HMAC, RSA, and ECDSA. Use [verify](#verify-method-jws-struct) to verify the signature of any received JWS message. The following algorithms are supported:

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

See [algorithm](#algorithm-property-jws-struct) for more details about supported algorithms.

## Signing

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

*eyJhbGciOiJIUzI1NiJ9.dGVzdA.o_JihJlCwvBO1AgY_Ao3_VBivdFmj3ufv3ZWAqYF4Ow*

The struct is agnostic of the payload that is signed. Any value may be signed. [key_id](#key_id-property-jws-struct) may be set to include an identifier to help the receiving party identify the key used to sign the message. The following properties are applicable when calling this method:

- [algorithm](#algorithm-property-jws-struct) (required)
- certificate (conditional - required for ECDSA and RSA)
- [key](#key-property-jws-struct) (conditional - required for HMAC)
- header_params
- [key_id](#key_id-property-jws-struct)
- [overwrite](#overwrite-property-jws-struct)

**Input and Output Properties**

The struct will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

- [input_file](#input_file-property-jws-struct)
- [input_message](#input_message-property-jws-struct)

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

- [output_file](#output_file-property-jws-struct)
- [output_message](#output_message-property-jws-struct): The output data is written to this property if no other destination is specified.

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

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

The example code below uses the [EzRand](EzRand.md#EzRand) struct to generate a key, but the key may be created using any means. The key must be known by both parties in order for signing and verification to take place.

```csharp
//Generate a 256 bit (32 byte) key
Ezrand ezrand = new Ezrand();
ezrand.RandBytesLength = 32;
ezrand.GetNextBytes();
byte[] key = ezrand.RandBytesB;

//Sign the payload using HS256
Jws jws = new Jws();
jws.Algorithm = JwsAlgorithms.jwsHS256;
jws.InputMessage = "test data";
jws.KeyB = key;
jws.Sign();

string signedData = jws.OutputMessage;
```

To use an existing HMAC key provide the bytes to the [key](#key-property-jws-struct) 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
Jws jws = new Jws();
jws.Algorithm = JwsAlgorithms.jwsHS256;
jws.InputMessage = "test data";
jws.KeyB = key;
jws.Sign();

string signedData = jws.OutputMessage;
```

**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
Jws jws = new Jws();
jws.Algorithm = JwsAlgorithms.jwsRS256;
jws.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "..\\jwt.pfx", "test", "*");
jws.InputMessage = "test";
jws.Sign();

string signedMessage = jws.OutputMessage;
```

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

ECDSA algorithms require a valid ECC private key to sign. The [ECC](ECC.md#ECC) struct can be used to create or import an ECC key into the *Certificate* format accepted by the *JWS* struct.

```csharp
//Create an ECC key with SHA-256
Ecc ecc = new Ecc();
ecc.HashAlgorithm = EccHashAlgorithms.ehaSHA256;
ecc.CreateKey();

string privKey = ecc.Key.PrivateKey;

//Sign the payload using ES256
Jws jws = new Jws();
jws.Algorithm = JwsAlgorithms.jwsES256;
jws.Certificate = new Certificate(CertStoreTypes.cstPEMKeyBlob, privKey, "", "*");
jws.InputMessage = "test";
jws.Sign();

string signedMessage = jws.OutputMessage;
```

To use an existing ECC Key populate the *Rx*, *Ry*, and *K* values of *Key* property in the [ECC](ECC.md#ECC) struct first. For instance:

```csharp
//Import an existing ECC private key
Ecc ecc = new Ecc();

byte[] x_bytes = new byte[] { 171, 170, 196, 151, 94, 196, 231, 12, 128, 232, 17, 61, 45, 105, 41, 209, 192, 187, 112, 242, 110, 178, 95, 240, 36, 55, 83, 171, 190, 176, 78, 13 };
byte[] y_bytes = new byte[] { 197, 75, 134, 245, 245, 28, 199, 9, 7, 117, 1, 54, 49, 178, 135, 252, 62, 89, 35, 180, 117, 80, 231, 23, 110, 250, 28, 124, 219, 253, 224, 156 };
byte[] k_bytes = new byte[] { 81, 65, 201, 24, 235, 249, 162, 148, 169, 150, 109, 181, 61, 238, 145, 122, 31, 30, 151, 94, 239, 90, 222, 217, 63, 103, 54, 2, 176, 232, 248, 168 };

ecc.Key.RxB = x_bytes;
ecc.Key.RyB = y_bytes;
ecc.Key.KB = k_bytes;

string privKey = ecc.Key.PrivateKey;

//Sign the payload using ES256
Jws jws = new Jws();
jws.Algorithm = JwsAlgorithms.jwsES256;
jws.Certificate = new Certificate(CertStoreTypes.cstPEMKeyBlob, privKey, "", "*");
jws.InputMessage = "test";
jws.Sign();

string signedMessage = jws.OutputMessage;
```

**Notes for Unsecured (none)**

To create a JWS token without any security set [algorithm](#algorithm-property-jws-struct) to *jwsNone*.

```csharp
Jws jws = new Jws();
jws.Algorithm = JwsAlgorithms.jwsNone;
jws.InputMessage = "test";
jws.Sign();

string unsecuredMessage = jws.OutputMessage;
```

## Signature Verification

The [verify](#verify-method-jws-struct) method may be used to verify a received JWS message. Before calling the [verify](#verify-method-jws-struct) method set [input_message](#input_message-property-jws-struct) or [input_file](#input_file-property-jws-struct) to a valid compact serialized JWS string. For instance:

*eyJhbGciOiJIUzI1NiJ9.dGVzdA.o_JihJlCwvBO1AgY_Ao3_VBivdFmj3ufv3ZWAqYF4Ow*

[key](#key-property-jws-struct) or certificate should be set to the HMAC key or public certificate respectively. If the correct [key](#key-property-jws-struct) or certificate is not known ahead of time the *KeyId* parameter of the [on_signer_info](#on_signer_info-event-jws-struct) event may be used to identify the correct key.

If this method returns without error verification was successful. If verification fails then this method fails with an error. After calling this method the payload will be present in the [output_message](#output_message-property-jws-struct) or file specified by [output_file](#output_file-property-jws-struct) and the header_params property will contain the headers. Headers of the parsed message are also available through the [on_header_param](#on_header_param-event-jws-struct) event.

The following properties are applicable when calling this method:

- [key](#key-property-jws-struct) (conditional - required for HMAC)
- certificate (conditional - required for ECDSA and RSA)
- [algorithm](#algorithm-property-jws-struct) (only if [StrictValidation](#StrictValidation) is True)
- [overwrite](#overwrite-property-jws-struct)
- [StrictValidation](#StrictValidation)

**Input and Output Properties**

The struct will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

- [input_file](#input_file-property-jws-struct)
- [input_message](#input_message-property-jws-struct)

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

- [output_file](#output_file-property-jws-struct)
- [output_message](#output_message-property-jws-struct): The output data is written to this property if no other destination is specified.

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

When verifying a message originally signed with a HMAC algorithm [key](#key-property-jws-struct) 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 };

Jws jws = new Jws();
jws.KeyB = key;
jws.InputMessage = signedData;
jws.Verify();

string verifiedPayload = jws.OutputMessage;
```

**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
Jws jws = new Jws();
jws.Certificate = new Certificate("..\\jwt.cer");
jws.InputMessage = signedData;
jws.Verify();

string verifiedPayload = jws.OutputMessage;
```

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

ECDSA algorithms require a valid ECC public key to verify the message. If the key was originally created with the [ECC](ECC.md#ECC) struct the PEM encoded *PublicKey* may be used directly with the certificate property. An example PEM encoded public certificate created by the [ECC](ECC.md#ECC) struct:

```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
Jws jws = new Jws();
jws.Certificate = new Certificate(CertStoreTypes.cstPublicKeyFile, pubKey, "", "*");
jws.InputMessage = signedData;
jws.Verify();

string verifiedPayload = jws.OutputMessage;
```

To use an ECC public key created by other means the [ECC](ECC.md#ECC) struct may be used to import the key parameters. Populate the *Rx* and *Ry* of the [ECC](ECC.md#ECC) struct first to obtain the PEM formatted public key. For instance:

```csharp
//Import an existing ECC public key
Ecc ecc = new Ecc();

byte[] x_bytes = new byte[] { 171, 170, 196, 151, 94, 196, 231, 12, 128, 232, 17, 61, 45, 105, 41, 209, 192, 187, 112, 242, 110, 178, 95, 240, 36, 55, 83, 171, 190, 176, 78, 13 };
byte[] y_bytes = new byte[] { 197, 75, 134, 245, 245, 28, 199, 9, 7, 117, 1, 54, 49, 178, 135, 252, 62, 89, 35, 180, 117, 80, 231, 23, 110, 250, 28, 124, 219, 253, 224, 156 };

ecc.Key.RxB = x_bytes;
ecc.Key.RyB = y_bytes;

string pubKey = ecc.Key.PublicKey;

Jws jws = new Jws();
jws.Certificate = new Certificate(CertStoreTypes.cstPublicKeyFile, pubKey, "", "*");
jws.InputMessage = signedData;
jws.Verify();

string verifiedPayload = jws.OutputMessage;
```

**Notes for Unsecured (none)**

To parse a JWS token without any security call the [sign](#sign-method-jws-struct) method without setting [key](#key-property-jws-struct) or certificate.

```csharp
Jws jws = new Jws();
jws.InputMessage = signedData;
jws.Verify();

string unsecuredPayload = jws.OutputMessage;
```

## Other Functionality

In addition to standard signing and verifying the struct also supports a variety of other features including:

- Adding custom header parameters with [add_header_param](#add_header_param-method-jws-struct)
- Enforcing algorithm restrictions when verifying by setting [StrictValidation](#StrictValidation)
- Inspect the JWS without verifying by calling [parse](#parse-method-jws-struct)

### Object Lifetime

 The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksEncrypt. Due to this, the JWS struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of JWS when you have finished using the instance.

## Property List

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

|  |  |
| --- | --- |
| [algorithm](#algorithm-property-jws-struct) | The algorithm used when signing. |
| [cert_effective_date](#cert_effective_date-property-jws-struct) | The date on which this certificate becomes valid. |
| [cert_expiration_date](#cert_expiration_date-property-jws-struct) | The date on which the certificate expires. |
| [cert_extended_key_usage](#cert_extended_key_usage-property-jws-struct) | A comma-delimited list of extended key usage identifiers. |
| [cert_fingerprint](#cert_fingerprint-property-jws-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [cert_fingerprint_sha1](#cert_fingerprint_sha1-property-jws-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [cert_fingerprint_sha256](#cert_fingerprint_sha256-property-jws-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [cert_issuer](#cert_issuer-property-jws-struct) | The issuer of the certificate. |
| [cert_private_key](#cert_private_key-property-jws-struct) | The private key of the certificate (if available). |
| [cert_private_key_available](#cert_private_key_available-property-jws-struct) | Whether a PrivateKey is available for the selected certificate. |
| [cert_private_key_container](#cert_private_key_container-property-jws-struct) | The name of the PrivateKey container for the certificate (if available). |
| [cert_public_key](#cert_public_key-property-jws-struct) | The public key of the certificate. |
| [cert_public_key_algorithm](#cert_public_key_algorithm-property-jws-struct) | The textual description of the certificate's public key algorithm. |
| [cert_public_key_length](#cert_public_key_length-property-jws-struct) | The length of the certificate's public key (in bits). |
| [cert_serial_number](#cert_serial_number-property-jws-struct) | The serial number of the certificate encoded as a string. |
| [cert_signature_algorithm](#cert_signature_algorithm-property-jws-struct) | The text description of the certificate's signature algorithm. |
| [cert_store](#cert_store-property-jws-struct) | The name of the certificate store for the client certificate. |
| [cert_store_password](#cert_store_password-property-jws-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [cert_store_type](#cert_store_type-property-jws-struct) | The type of certificate store for this certificate. |
| [cert_subject_alt_names](#cert_subject_alt_names-property-jws-struct) | Comma-separated lists of alternative subject names for the certificate. |
| [cert_thumbprint_md5](#cert_thumbprint_md5-property-jws-struct) | The MD5 hash of the certificate. |
| [cert_thumbprint_sha1](#cert_thumbprint_sha1-property-jws-struct) | The SHA-1 hash of the certificate. |
| [cert_thumbprint_sha256](#cert_thumbprint_sha256-property-jws-struct) | The SHA-256 hash of the certificate. |
| [cert_usage](#cert_usage-property-jws-struct) | The text description of UsageFlags . |
| [cert_usage_flags](#cert_usage_flags-property-jws-struct) | The flags that show intended use for the certificate. |
| [cert_version](#cert_version-property-jws-struct) | The certificate's version number. |
| [cert_subject](#cert_subject-property-jws-struct) | The subject of the certificate used for client authentication. |
| [cert_encoded](#cert_encoded-property-jws-struct) | The certificate (PEM/Base64 encoded). |
| [header_param_count](#header_param_count-property-jws-struct) | The number of records in the HeaderParam arrays. |
| [header_param_data_type](#header_param_data_type-property-jws-struct) | The data type of the header parameter. |
| [header_param_name](#header_param_name-property-jws-struct) | The header parameter name. |
| [header_param_value](#header_param_value-property-jws-struct) | The header parameter value. |
| [input_file](#input_file-property-jws-struct) | The file to process. |
| [input_message](#input_message-property-jws-struct) | The message to process. |
| [key](#key-property-jws-struct) | The secret key for the hash algorithm. |
| [key_id](#key_id-property-jws-struct) | The Id of the key used to sign the message. |
| [output_file](#output_file-property-jws-struct) | The output file when encrypting or decrypting. |
| [output_message](#output_message-property-jws-struct) | The output message after processing. |
| [overwrite](#overwrite-property-jws-struct) | Indicates whether or not the struct should overwrite files. |

## Method List

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

|  |  |
| --- | --- |
| [add_header_param](#add_header_param-method-jws-struct) | Adds additional header parameters. |
| [config](#config-method-jws-struct) | Sets or retrieves a configuration setting. |
| [parse](#parse-method-jws-struct) | Parses the compact serialized JWS string. |
| [reset](#reset-method-jws-struct) | Resets the struct. |
| [sign](#sign-method-jws-struct) | Signs the payload with the specified algorithm. |
| [verify](#verify-method-jws-struct) | Verifies the signature of the JWS token. |

## Event List

*The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [on_error](#on_error-event-jws-struct) | Fired when information is available about errors during data delivery. |
| [on_header_param](#on_header_param-event-jws-struct) | Fires once for each JOSE header parameter. |
| [on_signer_info](#on_signer_info-event-jws-struct) | Fires with information about the signature. |

## Config Settings

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

|  |  |
| --- | --- |
| [AllowedSigningAlgorithms](#AllowedSigningAlgorithms) | Allowed signing algorithms when StrictValidation is set to True. |
| [IncludeCertificateFormat](#IncludeCertificateFormat) | The certificate values to include in the signed message (if any). |
| [IssuerCerts](#IssuerCerts) | A collection of issuer certificates used with IncludeCertificateFormat. |
| [KeyEncoding](#KeyEncoding) | The encoding of the Key value. |
| [RawHeader](#RawHeader) | Holds the raw JOSE header. |
| [SerializationType](#SerializationType) | Determines the serialization type to use when reading and writing JWS content. |
| [StrictValidation](#StrictValidation) | Requires a specific algorithm when verifying signatures. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# algorithm property ([JWS](#struct-ipworksencryptjws) Struct)

The algorithm used when signing.

## Syntax

*Rust Syntax*

```text
fn algorithm(&self ) -> Result<i32, IPWorksEncryptError> fn set_algorithm(&self, value : i32) ->  Option<IPWorksEncryptError>
```

## Possible Values

```text
0   // HS2561   // HS3842   // HS5123   // RS2564   // RS3845   // RS5126   // ES2567   // ES3848   // ES5129   // PS25610   // PS38411   // PS51212   // ES256K99   // None
```

## Default Value

0

## Remarks

This property specifies the algorithm to use when signing.

When signing with an HMAC algorithm [key](#key-property-jws-struct) must be specified. When an RSA or ECDSA algorithm is selected certificate must be set before calling [sign](#sign-method-jws-struct) and certificate must be set before calling [verify](#verify-method-jws-struct). The following values are supported:

| Algorithm | Description | Private Key Location |
| --- | --- | --- |
| 0 (jwsHS256 - default) | HMAC using SHA-256 | [key](#key-property-jws-struct) |
| 1 (jwsHS384) | HMAC using SHA-384 | [key](#key-property-jws-struct) |
| 2 (jwsHS512) | HMAC using SHA-512 | [key](#key-property-jws-struct) |
| 3 (jwsRS256) | RSASSA-PKCS1-v1_5 using SHA-256 | certificate |
| 4 (jwsRS384) | RSASSA-PKCS1-v1_5 using SHA-384 | certificate |
| 5 (jwsRS512) | RSASSA-PKCS1-v1_5 using SHA-512 | certificate |
| 6 (jwsPS256) | RSASSA-PSS using SHA-256 and MGF1 with SHA-256 | certificate |
| 7 (jwsPS384) | RSASSA-PSS using SHA-384 and MGF1 with SHA-384 | certificate |
| 8 (jwsPS512) | RSASSA-PSS using SHA-512 and MGF1 with SHA-512 | certificate |
| 9 (jwsES256) | ECDSA using P-256 and SHA-256 | certificate |
| 10 (jwsES384) | ECDSA using P-384 and SHA-384 | certificate |
| 11 (jwsES512) | ECDSA using P-521 and SHA-512 | certificate |
| 12 (jwsES256K) | ECDSA using secp256k1 curve and SHA-256 | certificate |
| 99 (jwsNone) | None (unprotected) | Not Applicable |

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

## Data Type

i32

# cert_effective_date property ([JWS](#struct-ipworksencryptjws) Struct)

The date on which this certificate becomes valid.

## Syntax

*Rust Syntax*

```text
fn cert_effective_date(&self ) -> Result<String, IPWorksEncryptError>
```

## Default Value

""

## Remarks

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.

This property is read-only.

## Data Type

String

# cert_expiration_date property ([JWS](#struct-ipworksencryptjws) Struct)

The date on which the certificate expires.

## Syntax

*Rust Syntax*

```text
fn cert_expiration_date(&self ) -> Result<String, IPWorksEncryptError>
```

## Default Value

""

## Remarks

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.

This property is read-only.

## Data Type

String

# cert_extended_key_usage property ([JWS](#struct-ipworksencryptjws) Struct)

A comma-delimited list of extended key usage identifiers.

## Syntax

*Rust Syntax*

```text
fn cert_extended_key_usage(&self ) -> Result<String, IPWorksEncryptError>
```

## Default Value

""

## Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

## Data Type

String

# cert_fingerprint property ([JWS](#struct-ipworksencryptjws) Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

## Syntax

*Rust Syntax*

```text
fn cert_fingerprint(&self ) -> Result<String, IPWorksEncryptError>
```

## Default Value

""

## Remarks

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*

This property is read-only.

## Data Type

String

# cert_fingerprint_sha1 property ([JWS](#struct-ipworksencryptjws) Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

## Syntax

*Rust Syntax*

```text
fn cert_fingerprint_sha1(&self ) -> Result<String, IPWorksEncryptError>
```

## Default Value

""

## Remarks

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*

This property is read-only.

## Data Type

String

# cert_fingerprint_sha256 property ([JWS](#struct-ipworksencryptjws) Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

## Syntax

*Rust Syntax*

```text
fn cert_fingerprint_sha256(&self ) -> Result<String, IPWorksEncryptError>
```

## Default Value

""

## Remarks

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*

This property is read-only.

## Data Type

String

# cert_issuer property ([JWS](#struct-ipworksencryptjws) Struct)

The issuer of the certificate.

## Syntax

*Rust Syntax*

```text
fn cert_issuer(&self ) -> Result<String, IPWorksEncryptError>
```

## Default Value

""

## Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

## Data Type

String

# cert_private_key property ([JWS](#struct-ipworksencryptjws) Struct)

The private key of the certificate (if available).

## Syntax

*Rust Syntax*

```text
fn cert_private_key(&self ) -> Result<String, IPWorksEncryptError>
```

## Default Value

""

## Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The [cert_private_key](#cert_private_key-property-jws-struct) may be available but not exportable. In this case, [cert_private_key](#cert_private_key-property-jws-struct) returns an empty string.

This property is read-only.

## Data Type

String

# cert_private_key_available property ([JWS](#struct-ipworksencryptjws) Struct)

Whether a PrivateKey is available for the selected certificate.

## Syntax

*Rust Syntax*

```text
fn cert_private_key_available(&self ) -> Result<bool, IPWorksEncryptError>
```

## Default Value

false

## Remarks

Whether a [cert_private_key](#cert_private_key-property-jws-struct) is available for the selected certificate. If [cert_private_key_available](#cert_private_key_available-property-jws-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

## Data Type

bool

# cert_private_key_container property ([JWS](#struct-ipworksencryptjws) Struct)

The name of the PrivateKey container for the certificate (if available).

## Syntax

*Rust Syntax*

```text
fn cert_private_key_container(&self ) -> Result<String, IPWorksEncryptError>
```

## Default Value

""

## Remarks

The name of the [cert_private_key](#cert_private_key-property-jws-struct) container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

## Data Type

String

# cert_public_key property ([JWS](#struct-ipworksencryptjws) Struct)

The public key of the certificate.

## Syntax

*Rust Syntax*

```text
fn cert_public_key(&self ) -> Result<String, IPWorksEncryptError>
```

## Default Value

""

## Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

## Data Type

String

# cert_public_key_algorithm property ([JWS](#struct-ipworksencryptjws) Struct)

The textual description of the certificate's public key algorithm.

## Syntax

*Rust Syntax*

```text
fn cert_public_key_algorithm(&self ) -> Result<String, IPWorksEncryptError>
```

## Default Value

""

## Remarks

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.

This property is read-only.

## Data Type

String

# cert_public_key_length property ([JWS](#struct-ipworksencryptjws) Struct)

The length of the certificate's public key (in bits).

## Syntax

*Rust Syntax*

```text
fn cert_public_key_length(&self ) -> Result<i32, IPWorksEncryptError>
```

## Default Value

0

## Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

## Data Type

i32

# cert_serial_number property ([JWS](#struct-ipworksencryptjws) Struct)

The serial number of the certificate encoded as a string.

## Syntax

*Rust Syntax*

```text
fn cert_serial_number(&self ) -> Result<String, IPWorksEncryptError>
```

## Default Value

""

## Remarks

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.

This property is read-only.

## Data Type

String

# cert_signature_algorithm property ([JWS](#struct-ipworksencryptjws) Struct)

The text description of the certificate's signature algorithm.

## Syntax

*Rust Syntax*

```text
fn cert_signature_algorithm(&self ) -> Result<String, IPWorksEncryptError>
```

## Default Value

""

## Remarks

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.

This property is read-only.

## Data Type

String

# cert_store property ([JWS](#struct-ipworksencryptjws) Struct)

The name of the certificate store for the client certificate.

## Syntax

*Rust Syntax*

```text
fn cert_store(&self ) -> Result<Vec<u8>, IPWorksEncryptError> fn set_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError>
fn set_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError>
```

## Default Value

"MY"

## Remarks

The name of the certificate store for the client certificate.

The [cert_store_type](#cert_store_type-property-jws-struct) property denotes the type of the certificate store specified by [cert_store](#cert_store-property-jws-struct). If the store is password-protected, specify the password in [cert_store_password](#cert_store_password-property-jws-struct).

[cert_store](#cert_store-property-jws-struct) is used in conjunction with the [cert_subject](#cert_subject-property-jws-struct) property to specify client certificates. If [cert_store](#cert_store-property-jws-struct) has a value, and [cert_subject](#cert_subject-property-jws-struct) or [cert_encoded](#cert_encoded-property-jws-struct) is set, a search for a certificate is initiated. Please see the [cert_subject](#cert_subject-property-jws-struct) property 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).

## Data Type

Vec

# cert_store_password property ([JWS](#struct-ipworksencryptjws) Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

## Syntax

*Rust Syntax*

```text
fn cert_store_password(&self ) -> Result<String, IPWorksEncryptError> fn set_cert_store_password(&self, value : &str) ->  Option<IPWorksEncryptError>
fn set_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

## Data Type

String

# cert_store_type property ([JWS](#struct-ipworksencryptjws) Struct)

The type of certificate store for this certificate.

## Syntax

*Rust Syntax*

```text
fn cert_store_type(&self ) -> Result<i32, IPWorksEncryptError> fn set_cert_store_type(&self, value : i32) ->  Option<IPWorksEncryptError>
```

## Possible Values

```text
0   // User1   // Machine2   // PFXFile3   // PFXBlob4   // JKSFile5   // JKSBlob6   // PEMKeyFile7   // PEMKeyBlob8   // PublicKeyFile9   // PublicKeyBlob10   // SSHPublicKeyBlob11   // P7BFile12   // P7BBlob13   // SSHPublicKeyFile14   // PPKFile15   // PPKBlob16   // XMLFile17   // XMLBlob18   // JWKFile19   // JWKBlob20   // SecurityKey21   // BCFKSFile22   // BCFKSBlob23   // PKCS1199   // Auto
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

 The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property 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](#Type_Certificate) object and pass cstPKCS11 as the [cert_store_type](#cert_store_type-property-jws-struct), the full path of the PKCS#11 DLL as the [cert_store](#cert_store-property-jws-struct), and the PIN as the [cert_store_password](#cert_store_password-property-jws-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#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 [cert_store](#cert_store-property-jws-struct) and set [cert_store_password](#cert_store_password-property-jws-struct) 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. |

## Data Type

i32

# cert_subject_alt_names property ([JWS](#struct-ipworksencryptjws) Struct)

Comma-separated lists of alternative subject names for the certificate.

## Syntax

*Rust Syntax*

```text
fn cert_subject_alt_names(&self ) -> Result<String, IPWorksEncryptError>
```

## Default Value

""

## Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

## Data Type

String

# cert_thumbprint_md5 property ([JWS](#struct-ipworksencryptjws) Struct)

The MD5 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn cert_thumbprint_md5(&self ) -> Result<String, IPWorksEncryptError>
```

## Default Value

""

## Remarks

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.

This property is read-only.

## Data Type

String

# cert_thumbprint_sha1 property ([JWS](#struct-ipworksencryptjws) Struct)

The SHA-1 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn cert_thumbprint_sha1(&self ) -> Result<String, IPWorksEncryptError>
```

## Default Value

""

## Remarks

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.

This property is read-only.

## Data Type

String

# cert_thumbprint_sha256 property ([JWS](#struct-ipworksencryptjws) Struct)

The SHA-256 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn cert_thumbprint_sha256(&self ) -> Result<String, IPWorksEncryptError>
```

## Default Value

""

## Remarks

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.

This property is read-only.

## Data Type

String

# cert_usage property ([JWS](#struct-ipworksencryptjws) Struct)

The text description of UsageFlags .

## Syntax

*Rust Syntax*

```text
fn cert_usage(&self ) -> Result<String, IPWorksEncryptError>
```

## Default Value

""

## Remarks

The text description of [cert_usage_flags](#cert_usage_flags-property-jws-struct).

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.

This property is read-only.

## Data Type

String

# cert_usage_flags property ([JWS](#struct-ipworksencryptjws) Struct)

The flags that show intended use for the certificate.

## Syntax

*Rust Syntax*

```text
fn cert_usage_flags(&self ) -> Result<i32, IPWorksEncryptError>
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [cert_usage_flags](#cert_usage_flags-property-jws-struct) 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 [cert_usage](#cert_usage-property-jws-struct) property for a text representation of [cert_usage_flags](#cert_usage_flags-property-jws-struct).

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

## Data Type

i32

# cert_version property ([JWS](#struct-ipworksencryptjws) Struct)

The certificate's version number.

## Syntax

*Rust Syntax*

```text
fn cert_version(&self ) -> Result<String, IPWorksEncryptError>
```

## Default Value

""

## Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

## Data Type

String

# cert_subject property ([JWS](#struct-ipworksencryptjws) Struct)

The subject of the certificate used for client authentication.

## Syntax

*Rust Syntax*

```text
fn cert_subject(&self ) -> Result<String, IPWorksEncryptError> fn set_cert_subject(&self, value : &str) ->  Option<IPWorksEncryptError>
fn set_cert_subject_ref(&self, value : &String) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

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.

## Data Type

String

# cert_encoded property ([JWS](#struct-ipworksencryptjws) Struct)

The certificate (PEM/Base64 encoded).

## Syntax

*Rust Syntax*

```text
fn cert_encoded(&self ) -> Result<Vec<u8>, IPWorksEncryptError> fn set_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError>
fn set_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [cert_store](#cert_store-property-jws-struct) and [cert_subject](#cert_subject-property-jws-struct) properties also may be used to specify a certificate.

When [cert_encoded](#cert_encoded-property-jws-struct) is set, a search is initiated in the current [cert_store](#cert_store-property-jws-struct) for the private key of the certificate. If the key is found, [cert_subject](#cert_subject-property-jws-struct) is updated to reflect the full subject of the selected certificate; otherwise, [cert_subject](#cert_subject-property-jws-struct) is set to an empty string.

## Data Type

Vec

# header_param_count property ([JWS](#struct-ipworksencryptjws) Struct)

The number of records in the HeaderParam arrays.

## Syntax

*Rust Syntax*

```text
fn header_param_count(&self ) -> Result<i32, IPWorksEncryptError> fn set_header_param_count(&self, value : i32) ->  Option<IPWorksEncryptError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [header_param_data_type](#header_param_data_type-property-jws-struct)
- [header_param_name](#header_param_name-property-jws-struct)
- [header_param_value](#header_param_value-property-jws-struct)

The array indices start at *0* and end at *header_param_count - 1*.

## Data Type

i32

# header_param_data_type property ([JWS](#struct-ipworksencryptjws) Struct)

The data type of the header parameter.

## Syntax

*Rust Syntax*

```text
fn header_param_data_type(&self , HeaderParamIndex : i32) -> Result<i32, IPWorksEncryptError> fn set_header_param_data_type(&self, HeaderParamIndex : i32, value : i32) ->  Option<IPWorksEncryptError>
```

## Possible Values

```text
0   // Object1   // Array2   // String3   // Number4   // Bool5   // Null
```

## Default Value

2

## Remarks

The data type of the header parameter.

This property specifies the JSON type of the header parameter value. Possible values are:

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

The *HeaderParamIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [HeaderParamCount](#header_param_count-property-jws-struct) property.

## Data Type

i32

# header_param_name property ([JWS](#struct-ipworksencryptjws) Struct)

The header parameter name.

## Syntax

*Rust Syntax*

```text
fn header_param_name(&self , HeaderParamIndex : i32) -> Result<String, IPWorksEncryptError> fn set_header_param_name(&self, HeaderParamIndex : i32, value : &str) ->  Option<IPWorksEncryptError>
fn set_header_param_name_ref(&self, HeaderParamIndex : i32, value : &String) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

The header parameter name.

The *HeaderParamIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [HeaderParamCount](#header_param_count-property-jws-struct) property.

## Data Type

String

# header_param_value property ([JWS](#struct-ipworksencryptjws) Struct)

The header parameter value.

## Syntax

*Rust Syntax*

```text
fn header_param_value(&self , HeaderParamIndex : i32) -> Result<String, IPWorksEncryptError> fn set_header_param_value(&self, HeaderParamIndex : i32, value : &str) ->  Option<IPWorksEncryptError>
fn set_header_param_value_ref(&self, HeaderParamIndex : i32, value : &String) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

The header parameter value.

The *HeaderParamIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [HeaderParamCount](#header_param_count-property-jws-struct) property.

## Data Type

String

# input_file property ([JWS](#struct-ipworksencryptjws) Struct)

The file to process.

## Syntax

*Rust Syntax*

```text
fn input_file(&self ) -> Result<String, IPWorksEncryptError> fn set_input_file(&self, value : &str) ->  Option<IPWorksEncryptError>
fn set_input_file_ref(&self, value : &String) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

**Input and Output Properties**

The struct will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

- input_file
- [input_message](#input_message-property-jws-struct)

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

- [output_file](#output_file-property-jws-struct)
- [output_message](#output_message-property-jws-struct): The output data is written to this property if no other destination is specified.

## Data Type

String

# input_message property ([JWS](#struct-ipworksencryptjws) Struct)

The message to process.

## Syntax

*Rust Syntax*

```text
fn input_message(&self ) -> Result<Vec<u8>, IPWorksEncryptError> fn set_input_message(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError>
fn set_input_message_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

This property specifies the message to be processed.

**Input and Output Properties**

The struct will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

- [input_file](#input_file-property-jws-struct)
- input_message

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

- [output_file](#output_file-property-jws-struct)
- [output_message](#output_message-property-jws-struct): The output data is written to this property if no other destination is specified.

## Data Type

Vec

# key property ([JWS](#struct-ipworksencryptjws) Struct)

The secret key for the hash algorithm.

## Syntax

*Rust Syntax*

```text
fn key(&self ) -> Result<Vec<u8>, IPWorksEncryptError> fn set_key(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError>
fn set_key_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

This property holds the secret key used when creating the hash. The key can be arbitrarily long.

Note: This property is only applicable when [algorithm](#algorithm-property-jws-struct) 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.

## Data Type

Vec

# key_id property ([JWS](#struct-ipworksencryptjws) Struct)

The Id of the key used to sign the message.

## Syntax

*Rust Syntax*

```text
fn key_id(&self ) -> Result<String, IPWorksEncryptError> fn set_key_id(&self, value : &str) ->  Option<IPWorksEncryptError>
fn set_key_id_ref(&self, value : &String) ->  Option<IPWorksEncryptError>
```

## 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 the message. This may be set before calling the [sign](#sign-method-jws-struct) method.

## Data Type

String

# output_file property ([JWS](#struct-ipworksencryptjws) Struct)

The output file when encrypting or decrypting.

## Syntax

*Rust Syntax*

```text
fn output_file(&self ) -> Result<String, IPWorksEncryptError> fn set_output_file(&self, value : &str) ->  Option<IPWorksEncryptError>
fn set_output_file_ref(&self, value : &String) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

This property specifies the file to which the output will be written when encrypt or decrypt is called. This may be set to an absolute or relative path.

This property is only applicable to encrypt and decrypt.

**Input and Output Properties**

The struct will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

- [input_file](#input_file-property-jws-struct)
- [input_message](#input_message-property-jws-struct)

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

- output_file
- [output_message](#output_message-property-jws-struct): The output data is written to this property if no other destination is specified.

## Data Type

String

# output_message property ([JWS](#struct-ipworksencryptjws) Struct)

The output message after processing.

## Syntax

*Rust Syntax*

```text
fn output_message(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
```

## Default Value

""

## Remarks

This property will be populated with the output from the operation if [output_file](#output_file-property-jws-struct) is not set.

**Input and Output Properties**

The struct will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

- [input_file](#input_file-property-jws-struct)
- [input_message](#input_message-property-jws-struct)

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

- [output_file](#output_file-property-jws-struct)
- output_message: The output data is written to this property if no other destination is specified.

This property is read-only.

## Data Type

Vec

# overwrite property ([JWS](#struct-ipworksencryptjws) Struct)

Indicates whether or not the struct should overwrite files.

## Syntax

*Rust Syntax*

```text
fn overwrite(&self ) -> Result<bool, IPWorksEncryptError> fn set_overwrite(&self, value : bool) ->  Option<IPWorksEncryptError>
```

## Default Value

false

## Remarks

This property indicates whether or not the struct will overwrite [output_file](#output_file-property-jws-struct). If overwrite is False, an error will be thrown whenever [output_file](#output_file-property-jws-struct) exists before an operation. The default value is False.

## Data Type

bool

# add_header_param method ([JWS](#struct-ipworksencryptjws) Struct)

Adds additional header parameters.

## Syntax

*Rust Syntax*

```text
fn add_header_param(&self, name : &str, value : &str, data_type : i32) -> Result<(), IPWorksEncryptError>
```

## Remarks

This method is used to add additional header parameters before calling [sign](#sign-method-jws-struct).

The *Name* and *Value* parameters define the name and value of the parameter respectively. The *DataType* parameter specifies the JSON data type of the value. Possible values for *DataType* are:

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

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

```text
{
  "alg": "HS512",
  "crit": [
    "exp"
  ],
  "exp": 12345687,
  "kid": "myKeyId",
  "type": "JWT"
}
```

The following code can be used:

```csharp
jws.Algorithm = JwsAlgorithms.jwsHS512;
jws.KeyId = "myKeyId";
jws.KeyB = key;
jws.AddHeaderParam("type", "JWT", 2);
jws.AddHeaderParam("crit", "[\"exp\"]", 1);
jws.AddHeaderParam("exp", "12345687", 3);
jws.InputMessage = "test";
jws.Sign();
string signedData = jws.OutputMessage;
```

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

**Parameters Automatically Set:**

| Header Param | Property |
| --- | --- |
| alg | [algorithm](#algorithm-property-jws-struct) |
| kid | [key_id](#key_id-property-jws-struct) |

# config method ([JWS](#struct-ipworksencryptjws) Struct)

Sets or retrieves a configuration setting.

## Syntax

*Rust Syntax*

```text
fn config(&self, configuration_string : &str) ->  Result<String, IPWorksEncryptError>
```

## Remarks

config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-jws-struct) for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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-jws-struct), you must call *Config("PROPERTY")*. The value will be returned as a string.

# parse method ([JWS](#struct-ipworksencryptjws) Struct)

Parses the compact serialized JWS string.

## Syntax

*Rust Syntax*

```text
fn parse(&self) -> Result<(), IPWorksEncryptError>
```

## Remarks

This method parses, but does not verify, the JWS string.

Take care when using this method as no signature verification is performed. This method may be helpful in cases where information about the signature is contained within the payload, or for any other reason where the signature is not important.

If verification is desired, use [verify](#verify-method-jws-struct) instead. It is not necessary to call this method before calling [verify](#verify-method-jws-struct). [verify](#verify-method-jws-struct) will both parse and verify the message.

When calling this method the headers and payload are parsed. The [on_header_param](#on_header_param-event-jws-struct) and [on_signer_info](#on_signer_info-event-jws-struct) events will fire and the header_params property will be populated. The payload will be written to the specified output location.

**Input and Output Properties**

The struct will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

- [input_file](#input_file-property-jws-struct)
- [input_message](#input_message-property-jws-struct)

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

- [output_file](#output_file-property-jws-struct)
- [output_message](#output_message-property-jws-struct): The output data is written to this property if no other destination is specified.

# reset method ([JWS](#struct-ipworksencryptjws) Struct)

Resets the struct.

## Syntax

*Rust Syntax*

```text
fn reset(&self) -> Result<(), IPWorksEncryptError>
```

## Remarks

When called, the struct will reset all of its properties to their default values.

# sign method ([JWS](#struct-ipworksencryptjws) Struct)

Signs the payload with the specified algorithm.

## Syntax

*Rust Syntax*

```text
fn sign(&self) -> Result<(), IPWorksEncryptError>
```

## Remarks

This method signs the input with the specified [algorithm](#algorithm-property-jws-struct).

Before calling the sign method set [algorithm](#algorithm-property-jws-struct) to the algorithm which will be used to sign the message. The result of signing is a compact serialized JWS string. For instance:

*eyJhbGciOiJIUzI1NiJ9.dGVzdA.o_JihJlCwvBO1AgY_Ao3_VBivdFmj3ufv3ZWAqYF4Ow*

The struct is agnostic of the payload that is signed. Any value may be signed. [key_id](#key_id-property-jws-struct) may be set to include an identifier to help the receiving party identify the key used to sign the message. The following properties are applicable when calling this method:

- [algorithm](#algorithm-property-jws-struct) (required)
- certificate (conditional - required for ECDSA and RSA)
- [key](#key-property-jws-struct) (conditional - required for HMAC)
- header_params
- [key_id](#key_id-property-jws-struct)
- [overwrite](#overwrite-property-jws-struct)

**Input and Output Properties**

The struct will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

- [input_file](#input_file-property-jws-struct)
- [input_message](#input_message-property-jws-struct)

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

- [output_file](#output_file-property-jws-struct)
- [output_message](#output_message-property-jws-struct): The output data is written to this property if no other destination is specified.

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

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

The example code below uses the [EzRand](EzRand.md#EzRand) struct to generate a key, but the key may be created using any means. The key must be known by both parties in order for signing and verification to take place.

```csharp
//Generate a 256 bit (32 byte) key
Ezrand ezrand = new Ezrand();
ezrand.RandBytesLength = 32;
ezrand.GetNextBytes();
byte[] key = ezrand.RandBytesB;

//Sign the payload using HS256
Jws jws = new Jws();
jws.Algorithm = JwsAlgorithms.jwsHS256;
jws.InputMessage = "test data";
jws.KeyB = key;
jws.Sign();

string signedData = jws.OutputMessage;
```

To use an existing HMAC key provide the bytes to the [key](#key-property-jws-struct) 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
Jws jws = new Jws();
jws.Algorithm = JwsAlgorithms.jwsHS256;
jws.InputMessage = "test data";
jws.KeyB = key;
jws.Sign();

string signedData = jws.OutputMessage;
```

**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
Jws jws = new Jws();
jws.Algorithm = JwsAlgorithms.jwsRS256;
jws.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "..\\jwt.pfx", "test", "*");
jws.InputMessage = "test";
jws.Sign();

string signedMessage = jws.OutputMessage;
```

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

ECDSA algorithms require a valid ECC private key to sign. The [ECC](ECC.md#ECC) struct can be used to create or import an ECC key into the *Certificate* format accepted by the *JWS* struct.

```csharp
//Create an ECC key with SHA-256
Ecc ecc = new Ecc();
ecc.HashAlgorithm = EccHashAlgorithms.ehaSHA256;
ecc.CreateKey();

string privKey = ecc.Key.PrivateKey;

//Sign the payload using ES256
Jws jws = new Jws();
jws.Algorithm = JwsAlgorithms.jwsES256;
jws.Certificate = new Certificate(CertStoreTypes.cstPEMKeyBlob, privKey, "", "*");
jws.InputMessage = "test";
jws.Sign();

string signedMessage = jws.OutputMessage;
```

To use an existing ECC Key populate the *Rx*, *Ry*, and *K* values of *Key* property in the [ECC](ECC.md#ECC) struct first. For instance:

```csharp
//Import an existing ECC private key
Ecc ecc = new Ecc();

byte[] x_bytes = new byte[] { 171, 170, 196, 151, 94, 196, 231, 12, 128, 232, 17, 61, 45, 105, 41, 209, 192, 187, 112, 242, 110, 178, 95, 240, 36, 55, 83, 171, 190, 176, 78, 13 };
byte[] y_bytes = new byte[] { 197, 75, 134, 245, 245, 28, 199, 9, 7, 117, 1, 54, 49, 178, 135, 252, 62, 89, 35, 180, 117, 80, 231, 23, 110, 250, 28, 124, 219, 253, 224, 156 };
byte[] k_bytes = new byte[] { 81, 65, 201, 24, 235, 249, 162, 148, 169, 150, 109, 181, 61, 238, 145, 122, 31, 30, 151, 94, 239, 90, 222, 217, 63, 103, 54, 2, 176, 232, 248, 168 };

ecc.Key.RxB = x_bytes;
ecc.Key.RyB = y_bytes;
ecc.Key.KB = k_bytes;

string privKey = ecc.Key.PrivateKey;

//Sign the payload using ES256
Jws jws = new Jws();
jws.Algorithm = JwsAlgorithms.jwsES256;
jws.Certificate = new Certificate(CertStoreTypes.cstPEMKeyBlob, privKey, "", "*");
jws.InputMessage = "test";
jws.Sign();

string signedMessage = jws.OutputMessage;
```

**Notes for Unsecured (none)**

To create a JWS token without any security set [algorithm](#algorithm-property-jws-struct) to *jwsNone*.

```csharp
Jws jws = new Jws();
jws.Algorithm = JwsAlgorithms.jwsNone;
jws.InputMessage = "test";
jws.Sign();

string unsecuredMessage = jws.OutputMessage;
```

# verify method ([JWS](#struct-ipworksencryptjws) Struct)

Verifies the signature of the JWS token.

## Syntax

*Rust Syntax*

```text
fn verify(&self) -> Result<(), IPWorksEncryptError>
```

## Remarks

This method verifies the signature of the JWS token.

Before calling the verify method set [input_message](#input_message-property-jws-struct) or [input_file](#input_file-property-jws-struct) to a valid compact serialized JWS string. For instance:

*eyJhbGciOiJIUzI1NiJ9.dGVzdA.o_JihJlCwvBO1AgY_Ao3_VBivdFmj3ufv3ZWAqYF4Ow*

[key](#key-property-jws-struct) or certificate should be set to the HMAC key or public certificate respectively. If the correct [key](#key-property-jws-struct) or certificate is not known ahead of time the *KeyId* parameter of the [on_signer_info](#on_signer_info-event-jws-struct) event may be used to identify the correct key.

If this method returns without error verification was successful. If verification fails then this method fails with an error. After calling this method the payload will be present in the [output_message](#output_message-property-jws-struct) or file specified by [output_file](#output_file-property-jws-struct) and the header_params property will contain the headers. Headers of the parsed message are also available through the [on_header_param](#on_header_param-event-jws-struct) event.

The following properties are applicable when calling this method:

- [key](#key-property-jws-struct) (conditional - required for HMAC)
- certificate (conditional - required for ECDSA and RSA)
- [algorithm](#algorithm-property-jws-struct) (only if [StrictValidation](#StrictValidation) is True)
- [overwrite](#overwrite-property-jws-struct)
- [StrictValidation](#StrictValidation)

**Input and Output Properties**

The struct will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

- [input_file](#input_file-property-jws-struct)
- [input_message](#input_message-property-jws-struct)

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

- [output_file](#output_file-property-jws-struct)
- [output_message](#output_message-property-jws-struct): The output data is written to this property if no other destination is specified.

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

When verifying a message originally signed with a HMAC algorithm [key](#key-property-jws-struct) 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 };

Jws jws = new Jws();
jws.KeyB = key;
jws.InputMessage = signedData;
jws.Verify();

string verifiedPayload = jws.OutputMessage;
```

**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
Jws jws = new Jws();
jws.Certificate = new Certificate("..\\jwt.cer");
jws.InputMessage = signedData;
jws.Verify();

string verifiedPayload = jws.OutputMessage;
```

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

ECDSA algorithms require a valid ECC public key to verify the message. If the key was originally created with the [ECC](ECC.md#ECC) struct the PEM encoded *PublicKey* may be used directly with the certificate property. An example PEM encoded public certificate created by the [ECC](ECC.md#ECC) struct:

```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
Jws jws = new Jws();
jws.Certificate = new Certificate(CertStoreTypes.cstPublicKeyFile, pubKey, "", "*");
jws.InputMessage = signedData;
jws.Verify();

string verifiedPayload = jws.OutputMessage;
```

To use an ECC public key created by other means the [ECC](ECC.md#ECC) struct may be used to import the key parameters. Populate the *Rx* and *Ry* of the [ECC](ECC.md#ECC) struct first to obtain the PEM formatted public key. For instance:

```csharp
//Import an existing ECC public key
Ecc ecc = new Ecc();

byte[] x_bytes = new byte[] { 171, 170, 196, 151, 94, 196, 231, 12, 128, 232, 17, 61, 45, 105, 41, 209, 192, 187, 112, 242, 110, 178, 95, 240, 36, 55, 83, 171, 190, 176, 78, 13 };
byte[] y_bytes = new byte[] { 197, 75, 134, 245, 245, 28, 199, 9, 7, 117, 1, 54, 49, 178, 135, 252, 62, 89, 35, 180, 117, 80, 231, 23, 110, 250, 28, 124, 219, 253, 224, 156 };

ecc.Key.RxB = x_bytes;
ecc.Key.RyB = y_bytes;

string pubKey = ecc.Key.PublicKey;

Jws jws = new Jws();
jws.Certificate = new Certificate(CertStoreTypes.cstPublicKeyFile, pubKey, "", "*");
jws.InputMessage = signedData;
jws.Verify();

string verifiedPayload = jws.OutputMessage;
```

**Notes for Unsecured (none)**

To parse a JWS token without any security call the [sign](#sign-method-jws-struct) method without setting [key](#key-property-jws-struct) or certificate.

```csharp
Jws jws = new Jws();
jws.InputMessage = signedData;
jws.Verify();

string unsecuredPayload = jws.OutputMessage;
```

# on_error event ([JWS](#struct-ipworksencryptjws) Struct)

Fired when information is available about errors during data delivery.

## Syntax

*Rust Syntax*

```text
// JWSErrorEventArgs carries the JWS Error event's parameters.
pub struct JWSErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// JWSErrorEvent defines the signature of the JWS Error event's handler function.
pub trait JWSErrorEvent {
  fn on_error(&self, sender : JWS, e : &mut JWSErrorEventArgs);
}

impl <'a> JWS<'a> {
  pub fn on_error(&self) -> &'a dyn JWSErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn JWSErrorEvent);
  ...
}
```

## Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

The *error_code* 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-jws-struct) section.

# on_header_param event ([JWS](#struct-ipworksencryptjws) Struct)

Fires once for each JOSE header parameter.

## Syntax

*Rust Syntax*

```text
// JWSHeaderParamEventArgs carries the JWS HeaderParam event's parameters.
pub struct JWSHeaderParamEventArgs {
  fn name(&self) -> &String
  fn value(&self) -> &String
  fn data_type(&self) -> i32
}

// JWSHeaderParamEvent defines the signature of the JWS HeaderParam event's handler function.
pub trait JWSHeaderParamEvent {
  fn on_header_param(&self, sender : JWS, e : &mut JWSHeaderParamEventArgs);
}

impl <'a> JWS<'a> {
  pub fn on_header_param(&self) -> &'a dyn JWSHeaderParamEvent;
  pub fn set_on_header_param(&mut self, value : &'a dyn JWSHeaderParamEvent);
  ...
}
```

## Remarks

When [verify](#verify-method-jws-struct) or [parse](#parse-method-jws-struct) 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)

# on_signer_info event ([JWS](#struct-ipworksencryptjws) Struct)

Fires with information about the signature.

## Syntax

*Rust Syntax*

```text
// JWSSignerInfoEventArgs carries the JWS SignerInfo event's parameters.
pub struct JWSSignerInfoEventArgs {
  fn key_id(&self) -> &String
  fn algorithm(&self) -> &String
}

// JWSSignerInfoEvent defines the signature of the JWS SignerInfo event's handler function.
pub trait JWSSignerInfoEvent {
  fn on_signer_info(&self, sender : JWS, e : &mut JWSSignerInfoEventArgs);
}

impl <'a> JWS<'a> {
  pub fn on_signer_info(&self) -> &'a dyn JWSSignerInfoEvent;
  pub fn set_on_signer_info(&mut self, value : &'a dyn JWSSignerInfoEvent);
  ...
}
```

## Remarks

This event fires with information about the signature. This may be used to help identify the [key](#key-property-jws-struct) or certificate to load in order to verify the signature. This event fires when [verify](#verify-method-jws-struct) or [parse](#parse-method-jws-struct) 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.

# Config Settings ([JWS](#struct-ipworksencryptjws) Struct)

 The struct 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 struct, access to these *internal properties* is provided through the [config](#config-method-jws-struct) method.

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

**IncludeCertificateFormat**: The certificate values to include in the signed message (if any).This setting specifies whether information about the certificate 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 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 set this to *5*.

**IssuerCerts**: A collection of issuer certificates used with IncludeCertificateFormat.This setting optionally specifies one or more issuer certificates that may be used by the struct when [IncludeCertificateFormat](#IncludeCertificateFormat) is specified. Note that the issuer certificates specified here are used as a store of potential issuer certificates. At runtime the struct will inspect the certificate 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-jws-struct). value prior to providing it to the struct. The [key](#key-property-jws-struct) 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 struct will accept the key with an encoding already applied. The struct 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)

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

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

**SerializationType**: Determines the serialization type to use when reading and writing JWS content.This setting is used to control the serialization type the struct uses when reading and writing JWS content. Possible values are:

- *0* *(default)*: Compact serialization (content is serialized as a single base64url-encoded string).
- *1*: Standard JSON serialization.
- *2*: Flattened JSON serialization.

**StrictValidation**: Requires a specific algorithm when verifying signatures.If set to True the struct will validate that the Algorithm in the JWS message matches the value specified in the [algorithm](#algorithm-property-jws-struct) property. If it does not an error is thrown. By default this is False and the algorithm is read and used automatically from the message. Enabling this setting provides a way to require a specific algorithm when calling verify_signature.

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

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a struct 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*.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the struct 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.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([JWS](#struct-ipworksencryptjws) Struct)

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