JWS Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

class ipworksencrypt.JWS

Remarks

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

Specify any payload via input properties and use sign to create a JWS message using a variety of algorithms including HMAC, RSA, and ECDSA. Use verify 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 for more details about supported algorithms.

Signing

The sign method may be used to sign a payload with a variety of algorithms. Before calling the sign method set algorithm 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 class is agnostic of the payload that is signed. Any value may be signed. key_id 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 (required)
• certificate (conditional - required for ECDSA and RSA)
• key (conditional - required for HMAC)
• header_params
• key_id
• overwrite

Input and Output Properties

The class 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

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: The output data is written to this property if no other destination is specified.

Notes for HMAC Algorithms (HS256, HS384, HS512)

When algorithm is set to a HMAC algorithm key must be set to a key of appropriate length for the algorithm. The key 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 class 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.

//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 property. For instance:

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

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 class can be used to create or import an ECC key into the Certificate format accepted by the JWS class.

//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 class first. For instance:

//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 to jwsNone.

Jws jws = new Jws(); jws.Algorithm = JwsAlgorithms.jwsNone; jws.InputMessage = "test"; jws.Sign(); string unsecuredMessage = jws.OutputMessage;

Signature Verification

The verify method may be used to verify a received JWS message. Before calling the verify method set input_message or input_file to a valid compact serialized JWS string. For instance:

eyJhbGciOiJIUzI1NiJ9.dGVzdA.o_JihJlCwvBO1AgY_Ao3_VBivdFmj3ufv3ZWAqYF4Ow

key or certificate should be set to the HMAC key or public certificate respectively. If the correct key or certificate is not known ahead of time the KeyId parameter of the on_signer_info 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 or file specified by output_file and the header_params property will contain the headers. Headers of the parsed message are also available through the on_header_param event.

The following properties are applicable when calling this method:

• key (conditional - required for HMAC)
• certificate (conditional - required for ECDSA and RSA)
• algorithm (only if StrictValidation is True)
• overwrite
• StrictValidation

Input and Output Properties

The class 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

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

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.

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 class the PEM encoded PublicKey may be used directly with the certificate property. An example PEM encoded public certificate created by the ECC class:

-----BEGIN PUBLIC KEY-----
MIIBMjCB7AYHKoZIzj0CATCB4AIBATAsBgcqhkjOPQEBAiEA/////wAAAAEAAAAAAAAAAAAA
AAD///////////////8wRAQg/////wAAAAEAAAAAAAAAAAAAAAD///////////////wEIFrG
NdiqOpPns+u9VXaYhrxlHQawzFOw9jvOPD4n0mBLBEEEaxfR8uEsQkf4vOblY6RA8ncDfYEt
6zOg9KE5RdiYwpZP40Li/hp/m47n60p8D54WK84zV2sxXs7LtkBoN79R9QIhAP////8AAAAA
//////////+85vqtpxeehPO5ysL8YyVRAgEBA0EEIC5rbLp11Mnz6cBXLLriaDIov3rm8RAY
x/OR0bOKiff0cQy+sLVaxjseqFk/+Xvl4ORSv5Z6HdHv5GyEpA0UoA==
-----END PUBLIC KEY-----

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 class may be used to import the key parameters. Populate the Rx and Ry of the ECC class first to obtain the PEM formatted public key. For instance:

//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 method without setting key or certificate.

Jws jws = new Jws(); jws.InputMessage = signedData; jws.Verify(); string unsecuredPayload = jws.OutputMessage;

Other Functionality

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

• Adding custom header parameters with add_header_param
• Enforcing algorithm restrictions when verifying by setting StrictValidation
• Inspect the JWS without verifying by calling parse

Property List

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

Method List

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

Event List

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

Config Settings

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

algorithm Property

The algorithm used when signing.

Syntax

def get_algorithm() -> int: ...
def set_algorithm(value: int) -> None: ...

algorithm = property(get_algorithm, set_algorithm)

Default Value

0

Remarks

This property specifies the algorithm to use when signing.

When signing with an HMAC algorithm key must be specified. When an RSA or ECDSA algorithm is selected certificate must be set before calling sign and certificate must be set before calling verify. The following values are supported:

Note: This setting is also applicable when StrictValidation is enabled before calling verify.

cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_cert_effective_date() -> str: ...

cert_effective_date = property(get_cert_effective_date, None)

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.

cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_cert_expiration_date() -> str: ...

cert_expiration_date = property(get_cert_expiration_date, None)

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.

cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_cert_extended_key_usage() -> str: ...

cert_extended_key_usage = property(get_cert_extended_key_usage, None)

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.

cert_fingerprint Property

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

Syntax

def get_cert_fingerprint() -> str: ...

cert_fingerprint = property(get_cert_fingerprint, None)

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.

cert_fingerprint_sha1 Property

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

Syntax

def get_cert_fingerprint_sha1() -> str: ...

cert_fingerprint_sha1 = property(get_cert_fingerprint_sha1, None)

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.

cert_fingerprint_sha256 Property

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

Syntax

def get_cert_fingerprint_sha256() -> str: ...

cert_fingerprint_sha256 = property(get_cert_fingerprint_sha256, None)

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.

cert_issuer Property

The issuer of the certificate.

Syntax

def get_cert_issuer() -> str: ...

cert_issuer = property(get_cert_issuer, None)

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.

cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_cert_private_key() -> str: ...

cert_private_key = property(get_cert_private_key, None)

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 may be available but not exportable. In this case, cert_private_key returns an empty string.

This property is read-only.

cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_cert_private_key_available() -> bool: ...

cert_private_key_available = property(get_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a cert_private_key is available for the selected certificate. If cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

cert_private_key_container Property

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

Syntax

def get_cert_private_key_container() -> str: ...

cert_private_key_container = property(get_cert_private_key_container, None)

Default Value

""

Remarks

The name of the cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

cert_public_key Property

The public key of the certificate.

Syntax

def get_cert_public_key() -> str: ...

cert_public_key = property(get_cert_public_key, None)

Default Value

""

Remarks

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

This property is read-only.

cert_public_key_algorithm Property

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

Syntax

def get_cert_public_key_algorithm() -> str: ...

cert_public_key_algorithm = property(get_cert_public_key_algorithm, None)

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.

cert_public_key_length Property

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

Syntax

def get_cert_public_key_length() -> int: ...

cert_public_key_length = property(get_cert_public_key_length, None)

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.

cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_cert_serial_number() -> str: ...

cert_serial_number = property(get_cert_serial_number, None)

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.

cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_cert_signature_algorithm() -> str: ...

cert_signature_algorithm = property(get_cert_signature_algorithm, None)

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.

cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_cert_store() -> bytes: ...
def set_cert_store(value: bytes) -> None: ...

cert_store = property(get_cert_store, set_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The cert_store_type property denotes the type of the certificate store specified by cert_store. If the store is password-protected, specify the password in cert_store_password.

cert_store is used in conjunction with the cert_subject property to specify client certificates. If cert_store has a value, and cert_subject or cert_encoded is set, a search for a certificate is initiated. Please see the cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

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

cert_store_password Property

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

Syntax

def get_cert_store_password() -> str: ...
def set_cert_store_password(value: str) -> None: ...

cert_store_password = property(get_cert_store_password, set_cert_store_password)

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.

cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_cert_store_type() -> int: ...
def set_cert_store_type(value: int) -> None: ...

cert_store_type = property(get_cert_store_type, set_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

cert_subject_alt_names Property

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

Syntax

def get_cert_subject_alt_names() -> str: ...

cert_subject_alt_names = property(get_cert_subject_alt_names, None)

Default Value

""

Remarks

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

This property is read-only.

cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_cert_thumbprint_md5() -> str: ...

cert_thumbprint_md5 = property(get_cert_thumbprint_md5, None)

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.

cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_cert_thumbprint_sha1() -> str: ...

cert_thumbprint_sha1 = property(get_cert_thumbprint_sha1, None)

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.

cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_cert_thumbprint_sha256() -> str: ...

cert_thumbprint_sha256 = property(get_cert_thumbprint_sha256, None)

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.

cert_usage Property

The text description of UsageFlags .

Syntax

def get_cert_usage() -> str: ...

cert_usage = property(get_cert_usage, None)

Default Value

""

Remarks

The text description of cert_usage_flags.

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.

cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_cert_usage_flags() -> int: ...

cert_usage_flags = property(get_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of cert_usage_flags is a combination of the following flags:

Please see the cert_usage property for a text representation of cert_usage_flags.

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

This property is read-only.

cert_version Property

The certificate's version number.

Syntax

def get_cert_version() -> str: ...

cert_version = property(get_cert_version, None)

Default Value

""

Remarks

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

This property is read-only.

cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_cert_subject() -> str: ...
def set_cert_subject(value: str) -> None: ...

cert_subject = property(get_cert_subject, set_cert_subject)

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=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_cert_encoded() -> bytes: ...
def set_cert_encoded(value: bytes) -> None: ...

cert_encoded = property(get_cert_encoded, set_cert_encoded)

Default Value

""

Remarks

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

When cert_encoded is set, a search is initiated in the current cert_store for the private key of the certificate. If the key is found, cert_subject is updated to reflect the full subject of the selected certificate; otherwise, cert_subject is set to an empty string.

header_param_count Property

The number of records in the HeaderParam arrays.

Syntax

def get_header_param_count() -> int: ...
def set_header_param_count(value: int) -> None: ...

header_param_count = property(get_header_param_count, set_header_param_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• header_param_data_type
• header_param_name
• header_param_value

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

header_param_data_type Property

The data type of the header parameter.

Syntax

def get_header_param_data_type(header_param_index: int) -> int: ...
def set_header_param_data_type(header_param_index: int, value: int) -> None: ...

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 header_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the header_param_count property.

header_param_name Property

The header parameter name.

Syntax

def get_header_param_name(header_param_index: int) -> str: ...
def set_header_param_name(header_param_index: int, value: str) -> None: ...

Default Value

""

Remarks

The header parameter name.

The header_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the header_param_count property.

header_param_value Property

The header parameter value.

Syntax

def get_header_param_value(header_param_index: int) -> str: ...
def set_header_param_value(header_param_index: int, value: str) -> None: ...

Default Value

""

Remarks

The header parameter value.

The header_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the header_param_count property.

input_file Property

The file to process.

Syntax

def get_input_file() -> str: ...
def set_input_file(value: str) -> None: ...

input_file = property(get_input_file, set_input_file)

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 class 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

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: The output data is written to this property if no other destination is specified.

input_message Property

The message to process.

Syntax

def get_input_message() -> bytes: ...
def set_input_message(value: bytes) -> None: ...

input_message = property(get_input_message, set_input_message)

Default Value

""

Remarks

This property specifies the message to be processed.

Input and Output Properties

The class 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

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: The output data is written to this property if no other destination is specified.

key Property

The secret key for the hash algorithm.

Syntax

def get_key() -> bytes: ...
def set_key(value: bytes) -> None: ...

key = property(get_key, set_key)

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

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 is it first hashed with the same algorithm.

key_id Property

The Id of the key used to sign the message.

Syntax

def get_key_id() -> str: ...
def set_key_id(value: str) -> None: ...

key_id = property(get_key_id, set_key_id)

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

output_file Property

The output file when encrypting or decrypting.

Syntax

def get_output_file() -> str: ...
def set_output_file(value: str) -> None: ...

output_file = property(get_output_file, set_output_file)

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 class 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

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: The output data is written to this property if no other destination is specified.

output_message Property

The output message after processing.

Syntax

def get_output_message() -> bytes: ...

output_message = property(get_output_message, None)

Default Value

""

Remarks

This property will be populated with the output from the operation if output_file is not set.

Input and Output Properties

The class 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

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: The output data is written to this property if no other destination is specified.

This property is read-only.

overwrite Property

Indicates whether or not the class should overwrite files.

Syntax

def get_overwrite() -> bool: ...
def set_overwrite(value: bool) -> None: ...

overwrite = property(get_overwrite, set_overwrite)

Default Value

FALSE

Remarks

This property indicates whether or not the class will overwrite output_file. If overwrite is False, an error will be thrown whenever output_file exists before an operation. The default value is False.

add_header_param Method

Adds additional header parameters.

Syntax

def add_header_param(name: str, value: str, data_type: int) -> None: ...

Remarks

This method is used to add additional header parameters before calling sign.

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)

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

The following code can be used:

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 the class will automatically add some headers based on properties that are set.

Parameters Automatically Set:

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

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

parse Method

Parses the compact serialized JWS string.

Syntax

def parse() -> None: ...

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 instead. It is not necessary to call this method before calling verify. verify will both parse and verify the message.

When calling this method the headers and payload are parsed. The on_header_param and on_signer_info 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 class 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

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: The output data is written to this property if no other destination is specified.

reset Method

Resets the class.

Syntax

def reset() -> None: ...

Remarks

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

sign Method

Signs the payload with the specified algorithm.

Syntax

def sign() -> None: ...

Remarks

This method signs the input with the specified algorithm.

Before calling the sign method set algorithm 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 class is agnostic of the payload that is signed. Any value may be signed. key_id 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 (required)
• certificate (conditional - required for ECDSA and RSA)
• key (conditional - required for HMAC)
• header_params
• key_id
• overwrite

Input and Output Properties

The class 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

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: The output data is written to this property if no other destination is specified.

Notes for HMAC Algorithms (HS256, HS384, HS512)

When algorithm is set to a HMAC algorithm key must be set to a key of appropriate length for the algorithm. The key 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 class 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.

//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 property. For instance:

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

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 class can be used to create or import an ECC key into the Certificate format accepted by the JWS class.

//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 class first. For instance:

//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 to jwsNone.

Jws jws = new Jws(); jws.Algorithm = JwsAlgorithms.jwsNone; jws.InputMessage = "test"; jws.Sign(); string unsecuredMessage = jws.OutputMessage;

verify Method

Verifies the signature of the JWS token.

Syntax

def verify() -> None: ...

Remarks

This method verifies the signature of the JWS token.

Before calling the verify method set input_message or input_file to a valid compact serialized JWS string. For instance:

eyJhbGciOiJIUzI1NiJ9.dGVzdA.o_JihJlCwvBO1AgY_Ao3_VBivdFmj3ufv3ZWAqYF4Ow

key or certificate should be set to the HMAC key or public certificate respectively. If the correct key or certificate is not known ahead of time the KeyId parameter of the on_signer_info 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 or file specified by output_file and the header_params property will contain the headers. Headers of the parsed message are also available through the on_header_param event.

The following properties are applicable when calling this method:

• key (conditional - required for HMAC)
• certificate (conditional - required for ECDSA and RSA)
• algorithm (only if StrictValidation is True)
• overwrite
• StrictValidation

Input and Output Properties

The class 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

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

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.

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 class the PEM encoded PublicKey may be used directly with the certificate property. An example PEM encoded public certificate created by the ECC class:

-----BEGIN PUBLIC KEY-----
MIIBMjCB7AYHKoZIzj0CATCB4AIBATAsBgcqhkjOPQEBAiEA/////wAAAAEAAAAAAAAAAAAA
AAD///////////////8wRAQg/////wAAAAEAAAAAAAAAAAAAAAD///////////////wEIFrG
NdiqOpPns+u9VXaYhrxlHQawzFOw9jvOPD4n0mBLBEEEaxfR8uEsQkf4vOblY6RA8ncDfYEt
6zOg9KE5RdiYwpZP40Li/hp/m47n60p8D54WK84zV2sxXs7LtkBoN79R9QIhAP////8AAAAA
//////////+85vqtpxeehPO5ysL8YyVRAgEBA0EEIC5rbLp11Mnz6cBXLLriaDIov3rm8RAY
x/OR0bOKiff0cQy+sLVaxjseqFk/+Xvl4ORSv5Z6HdHv5GyEpA0UoA==
-----END PUBLIC KEY-----

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 class may be used to import the key parameters. Populate the Rx and Ry of the ECC class first to obtain the PEM formatted public key. For instance:

//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 method without setting key or certificate.

Jws jws = new Jws(); jws.InputMessage = signedData; jws.Verify(); string unsecuredPayload = jws.OutputMessage;

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class JWSErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class JWS:
@property
def on_error() -> Callable[[JWSErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[JWSErrorEventParams], None]) -> None: ...

Remarks

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

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

on_header_param Event

Fires once for each JOSE header parameter.

Syntax

class JWSHeaderParamEventParams(object):
  @property
  def name() -> str: ...

  @property
  def value() -> str: ...

  @property
  def data_type() -> int: ...

# In class JWS:
@property
def on_header_param() -> Callable[[JWSHeaderParamEventParams], None]: ...
@on_header_param.setter
def on_header_param(event_hook: Callable[[JWSHeaderParamEventParams], None]) -> None: ...

Remarks

When verify or parse 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

Fires with information about the signature.

Syntax

class JWSSignerInfoEventParams(object):
  @property
  def key_id() -> str: ...

  @property
  def algorithm() -> str: ...

# In class JWS:
@property
def on_signer_info() -> Callable[[JWSSignerInfoEventParams], None]: ...
@on_signer_info.setter
def on_signer_info(event_hook: Callable[[JWSSignerInfoEventParams], None]) -> None: ...

Remarks

This event fires with information about the signature. This may be used to help identify the key or certificate to load in order to verify the signature. This event fires when verify or parse 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.

JWS Config Settings

JWS Config Settings

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

Base Config Settings

JWS Errors

JWS Errors