JWS Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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. KeyId 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)
• HeaderParams
• KeyId
• 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:

• SetInputStream
• InputFile
• InputMessage

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

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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 InputMessage or InputFile 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 SignerInfo event may be used to identify the correct key.

If this method returns without error verification was successful. If verification fails then this method throws an exception. After calling this method the payload will be present in the OutputMessage or file specified by OutputFile and the HeaderParams property will contain the headers. Headers of the parsed message are also available through the HeaderParam 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:

• SetInputStream
• InputFile
• InputMessage

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

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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 AddHeaderParam
• 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 (JWS Class)

The algorithm used when signing.

Syntax

public int getAlgorithm();


public void setAlgorithm(int algorithm);


Enumerated values:
  public final static int jwsHS256 = 0;
  public final static int jwsHS384 = 1;
  public final static int jwsHS512 = 2;
  public final static int jwsRS256 = 3;
  public final static int jwsRS384 = 4;
  public final static int jwsRS512 = 5;
  public final static int jwsES256 = 6;
  public final static int jwsES384 = 7;
  public final static int jwsES512 = 8;
  public final static int jwsPS256 = 9;
  public final static int jwsPS384 = 10;
  public final static int jwsPS512 = 11;
  public final static int jwsES256K = 12;
  public final static int jwsNone = 99;

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.

Certificate Property (JWS Class)

The certificate used for signing or verification.

Syntax

public Certificate getCertificate();


public void setCertificate(Certificate certificate);

Remarks

This property specifies a certificate used for signing or verification.

When calling Sign and Algorithm is set to an RSA or ECDSA algorithm this property must be set to a certificate with private key.

When calling Verify and the algorithm used is RSA or ECDSA this property must be set to the public certificate of the signer.

HeaderParams Property (JWS Class)

The JOSE header parameters.

Syntax

public HeaderParamList getHeaderParams();


public void setHeaderParams(HeaderParamList headerParams);

Remarks

This property specifies the JOSE header parameters. This may be populated before calling Sign or Encrypt. This is populated with the parsed header values after calling Verify, Decrypt, or Parse.

This property is not available at design time.

InputFile Property (JWS Class)

The file to process.

Syntax

public String getInputFile();


public void setInputFile(String inputFile);

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:

• SetInputStream
• InputFile
• InputMessage

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

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

InputMessage Property (JWS Class)

The message to process.

Syntax

public byte[] getInputMessage();


public void setInputMessage(byte[] inputMessage);

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:

• SetInputStream
• InputFile
• InputMessage

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

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Key Property (JWS Class)

The secret key for the hash algorithm.

Syntax

public byte[] getKey();


public void setKey(byte[] 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.

KeyId Property (JWS Class)

The Id of the key used to sign the message.

Syntax

public String getKeyId();


public void setKeyId(String keyId);

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.

OutputFile Property (JWS Class)

The output file when encrypting or decrypting.

Syntax

public String getOutputFile();


public void setOutputFile(String outputFile);

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:

• SetInputStream
• InputFile
• InputMessage

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

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

OutputMessage Property (JWS Class)

The output message after processing.

Syntax

public byte[] getOutputMessage();

Default Value

""

Remarks

This property will be populated with the output from the operation if OutputFile and SetOutputStream are 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:

• SetInputStream
• InputFile
• InputMessage

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

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

This property is read-only and not available at design time.

Overwrite Property (JWS Class)

Indicates whether or not the class should overwrite files.

Syntax

public boolean isOverwrite();


public void setOverwrite(boolean overwrite);

Default Value

False

Remarks

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

AddHeaderParam Method (Jws Class)

Adds additional header parameters.

Syntax

public void addHeaderParam(String name, String value, int dataType);

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 (Jws Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

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 (Jws Class)

Parses the compact serialized JWS string.

Syntax

public void parse();

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 HeaderParam and SignerInfo events will fire and the HeaderParams 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:

• SetInputStream
• InputFile
• InputMessage

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

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Reset Method (Jws Class)

Resets the class.

Syntax

public void reset();

Remarks

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

SetInputStream Method (Jws Class)

Sets the stream from which the class will read data.

Syntax

public void setInputStream(java.io.InputStream inputStream);

Remarks

This method may be used to set a stream from which data will be read.

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:

• SetInputStream
• InputFile
• InputMessage

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

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

SetOutputStream Method (Jws Class)

Sets the stream to which the class will write data.

Syntax

public void setOutputStream(java.io.OutputStream outputStream);

Remarks

This method may be used to specify a stream to which data will be written.

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:

• SetInputStream
• InputFile
• InputMessage

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

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Sign Method (Jws Class)

Signs the payload with the specified algorithm.

Syntax

public void sign();

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. KeyId 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)
• HeaderParams
• KeyId
• 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:

• SetInputStream
• InputFile
• InputMessage

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

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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 (Jws Class)

Verifies the signature of the JWS token.

Syntax

public void verify();

Remarks

This method verifies the signature of the JWS token.

Before calling the Verify method set InputMessage or InputFile 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 SignerInfo event may be used to identify the correct key.

If this method returns without error verification was successful. If verification fails then this method throws an exception. After calling this method the payload will be present in the OutputMessage or file specified by OutputFile and the HeaderParams property will contain the headers. Headers of the parsed message are also available through the HeaderParam 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:

• SetInputStream
• InputFile
• InputMessage

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

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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;

Error Event (Jws Class)

Information about errors during data delivery.

Syntax

public class DefaultJwsEventListener implements JwsEventListener {
  ...
  public void error(JwsErrorEvent e) {}
  ...
}

public class JwsErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

HeaderParam Event (Jws Class)

Fires once for each JOSE header parameter.

Syntax

public class DefaultJwsEventListener implements JwsEventListener {
  ...
  public void headerParam(JwsHeaderParamEvent e) {}
  ...
}

public class JwsHeaderParamEvent {
  public String name;
  public String value;
  public int dataType;
}

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)

SignerInfo Event (Jws Class)

Fires with information about the signature.

Syntax

public class DefaultJwsEventListener implements JwsEventListener {
  ...
  public void signerInfo(JwsSignerInfoEvent e) {}
  ...
}

public class JwsSignerInfoEvent {
  public String keyId;
  public String algorithm;
}

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.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

public Certificate();

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate( certificateFile);

Opens CertificateFile and reads out the contents as an X509 public key.

public Certificate( certificateData);

Parses CertificateData as an X509 public key.

public Certificate( certStoreType,  store,  storePassword,  subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  subject,  configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

public Certificate( certStoreType,  storeBlob,  storePassword,  subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  subject,  configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

HeaderParam Type

The JOSE header parameter.

Remarks

This type holds the JOSE header parameters. The fields define the name, value, and data type of the parameter.

Fields

Constructors

public HeaderParam();

Creates a new header parameter with no name or value.

public HeaderParam( name,  value);

Creates a new header parameter. The DataType of the value will be a String.

public HeaderParam( name,  value,  dataType);

Creates a new header parameter with the specified DataType.

Config Settings (Jws Class)

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

Trappable Errors (Jws Class)

JWS Errors