JWS Class
Properties Methods Events Config Settings Errors
Create, Sign and Verify JSON Web Signatures (JWS).
Syntax
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:
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 fails with an error. After calling this method the payload will be present in the OutputMessage or file specified by OutputFile and the Header* properties 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:
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.
Algorithm | The algorithm used when signing. |
CertEncoded | This is the certificate (PEM/Base64 encoded). |
CertStore | This is the name of the certificate store for the client certificate. |
CertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
CertStoreType | This is the type of certificate store for this certificate. |
CertSubject | This is the subject of the certificate used for client authentication. |
HeaderParamCount | The number of records in the HeaderParam arrays. |
HeaderParamDataType | The data type of the header parameter. |
HeaderParamName | The header parameter name. |
HeaderParamValue | The header parameter value. |
InputFile | The file to process. |
InputMessage | The message to process. |
Key | The secret key for the hash algorithm. |
KeyId | The Id of the key used to sign the message. |
OutputFile | The output file when encrypting or decrypting. |
OutputMessage | The output message after processing. |
Overwrite | Indicates whether or not the class should overwrite files. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
AddHeaderParam | Adds additional header parameters. |
Config | Sets or retrieves a configuration setting. |
Parse | Parses the compact serialized JWS string. |
Reset | Resets the class. |
SetInputStream | Sets the stream from which the class will read data. |
SetOutputStream | Sets the stream to which the class will write data. |
Sign | Signs the payload with the specified algorithm. |
Verify | Verifies the signature of the JWS token. |
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.
Error | Fired when information is available about errors during data delivery. |
HeaderParam | Fires once for each JOSE header parameter. |
SignerInfo | Fires with information about the signature. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AllowedSigningAlgorithms | Allowed signing algorithms when StrictValidation is set to True. |
IncludeCertificateFormat | The certificate values to include in the signed message (if any). |
IssuerCerts | A collection of issuer certificates used with IncludeCertificateFormat. |
KeyEncoding | The encoding of the Key value. |
RawHeader | Holds the raw JOSE header. |
SerializationType | Determines the serialization type to use when reading and writing JWS content. |
StrictValidation | Requires a specific algorithm when verifying signatures. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
Algorithm Property (JWS Class)
The algorithm used when signing.
Syntax
ANSI (Cross Platform) int GetAlgorithm();
int SetAlgorithm(int iAlgorithm); Unicode (Windows) INT GetAlgorithm();
INT SetAlgorithm(INT iAlgorithm);
Possible Values
JWS_HS256(0),
JWS_HS384(1),
JWS_HS512(2),
JWS_RS256(3),
JWS_RS384(4),
JWS_RS512(5),
JWS_ES256(6),
JWS_ES384(7),
JWS_ES512(8),
JWS_PS256(9),
JWS_PS384(10),
JWS_PS512(11),
JWS_ES256K(12),
JWS_NONE(99)
int ipworksencrypt_jws_getalgorithm(void* lpObj);
int ipworksencrypt_jws_setalgorithm(void* lpObj, int iAlgorithm);
int GetAlgorithm();
int SetAlgorithm(int iAlgorithm);
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:
Algorithm | Description | Private Key Location |
0 (jwsHS256 - default) | HMAC using SHA-256 | Key |
1 (jwsHS384) | HMAC using SHA-384 | Key |
2 (jwsHS512) | HMAC using SHA-512 | Key |
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 is enabled before calling Verify.
Data Type
Integer
CertEncoded Property (JWS Class)
This is the certificate (PEM/Base64 encoded).
Syntax
ANSI (Cross Platform) int GetCertEncoded(char* &lpCertEncoded, int &lenCertEncoded);
int SetCertEncoded(const char* lpCertEncoded, int lenCertEncoded); Unicode (Windows) INT GetCertEncoded(LPSTR &lpCertEncoded, INT &lenCertEncoded);
INT SetCertEncoded(LPCSTR lpCertEncoded, INT lenCertEncoded);
int ipworksencrypt_jws_getcertencoded(void* lpObj, char** lpCertEncoded, int* lenCertEncoded);
int ipworksencrypt_jws_setcertencoded(void* lpObj, const char* lpCertEncoded, int lenCertEncoded);
QByteArray GetCertEncoded();
int SetCertEncoded(QByteArray qbaCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The CertStore and CertSubject properties also may be used to specify a certificate.
When CertEncoded is set, a search is initiated in the current CertStore for the private key of the certificate. If the key is found, CertSubject is updated to reflect the full subject of the selected certificate; otherwise, CertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
CertStore Property (JWS Class)
This is the name of the certificate store for the client certificate.
Syntax
ANSI (Cross Platform) int GetCertStore(char* &lpCertStore, int &lenCertStore);
int SetCertStore(const char* lpCertStore, int lenCertStore); Unicode (Windows) INT GetCertStore(LPSTR &lpCertStore, INT &lenCertStore);
INT SetCertStore(LPCSTR lpCertStore, INT lenCertStore);
int ipworksencrypt_jws_getcertstore(void* lpObj, char** lpCertStore, int* lenCertStore);
int ipworksencrypt_jws_setcertstore(void* lpObj, const char* lpCertStore, int lenCertStore);
QByteArray GetCertStore();
int SetCertStore(QByteArray qbaCertStore);
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertStorePassword.
CertStore is used in conjunction with the CertSubject property to specify client certificates. If CertStore has a value, and CertSubject or CertEncoded is set, a search for a certificate is initiated. Please see the CertSubject 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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Binary String
CertStorePassword Property (JWS Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
ANSI (Cross Platform) char* GetCertStorePassword();
int SetCertStorePassword(const char* lpszCertStorePassword); Unicode (Windows) LPWSTR GetCertStorePassword();
INT SetCertStorePassword(LPCWSTR lpszCertStorePassword);
char* ipworksencrypt_jws_getcertstorepassword(void* lpObj);
int ipworksencrypt_jws_setcertstorepassword(void* lpObj, const char* lpszCertStorePassword);
QString GetCertStorePassword();
int SetCertStorePassword(QString qsCertStorePassword);
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
CertStoreType Property (JWS Class)
This is the type of certificate store for this certificate.
Syntax
ANSI (Cross Platform) int GetCertStoreType();
int SetCertStoreType(int iCertStoreType); Unicode (Windows) INT GetCertStoreType();
INT SetCertStoreType(INT iCertStoreType);
Possible Values
CST_USER(0),
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_PKCS11(23),
CST_AUTO(99)
int ipworksencrypt_jws_getcertstoretype(void* lpObj);
int ipworksencrypt_jws_setcertstoretype(void* lpObj, int iCertStoreType);
int GetCertStoreType();
int SetCertStoreType(int iCertStoreType);
Default Value
0
Remarks
This is 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:
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, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the CertStore and set CertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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
Integer
CertSubject Property (JWS Class)
This is the subject of the certificate used for client authentication.
Syntax
ANSI (Cross Platform) char* GetCertSubject();
int SetCertSubject(const char* lpszCertSubject); Unicode (Windows) LPWSTR GetCertSubject();
INT SetCertSubject(LPCWSTR lpszCertSubject);
char* ipworksencrypt_jws_getcertsubject(void* lpObj);
int ipworksencrypt_jws_setcertsubject(void* lpObj, const char* lpszCertSubject);
QString GetCertSubject();
int SetCertSubject(QString qsCertSubject);
Default Value
""
Remarks
This is 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:
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
HeaderParamCount Property (JWS Class)
The number of records in the HeaderParam arrays.
Syntax
ANSI (Cross Platform) int GetHeaderParamCount();
int SetHeaderParamCount(int iHeaderParamCount); Unicode (Windows) INT GetHeaderParamCount();
INT SetHeaderParamCount(INT iHeaderParamCount);
int ipworksencrypt_jws_getheaderparamcount(void* lpObj);
int ipworksencrypt_jws_setheaderparamcount(void* lpObj, int iHeaderParamCount);
int GetHeaderParamCount();
int SetHeaderParamCount(int iHeaderParamCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at HeaderParamCount - 1.
This property is not available at design time.
Data Type
Integer
HeaderParamDataType Property (JWS Class)
The data type of the header parameter.
Syntax
ANSI (Cross Platform) int GetHeaderParamDataType(int iHeaderParamIndex);
int SetHeaderParamDataType(int iHeaderParamIndex, int iHeaderParamDataType); Unicode (Windows) INT GetHeaderParamDataType(INT iHeaderParamIndex);
INT SetHeaderParamDataType(INT iHeaderParamIndex, INT iHeaderParamDataType);
Possible Values
DT_OBJECT(0),
DT_ARRAY(1),
DT_STRING(2),
DT_NUMBER(3),
DT_BOOL(4),
DT_NULL(5)
int ipworksencrypt_jws_getheaderparamdatatype(void* lpObj, int headerparamindex);
int ipworksencrypt_jws_setheaderparamdatatype(void* lpObj, int headerparamindex, int iHeaderParamDataType);
int GetHeaderParamDataType(int iHeaderParamIndex);
int SetHeaderParamDataType(int iHeaderParamIndex, int iHeaderParamDataType);
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 property.
This property is not available at design time.
Data Type
Integer
HeaderParamName Property (JWS Class)
The header parameter name.
Syntax
ANSI (Cross Platform) char* GetHeaderParamName(int iHeaderParamIndex);
int SetHeaderParamName(int iHeaderParamIndex, const char* lpszHeaderParamName); Unicode (Windows) LPWSTR GetHeaderParamName(INT iHeaderParamIndex);
INT SetHeaderParamName(INT iHeaderParamIndex, LPCWSTR lpszHeaderParamName);
char* ipworksencrypt_jws_getheaderparamname(void* lpObj, int headerparamindex);
int ipworksencrypt_jws_setheaderparamname(void* lpObj, int headerparamindex, const char* lpszHeaderParamName);
QString GetHeaderParamName(int iHeaderParamIndex);
int SetHeaderParamName(int iHeaderParamIndex, QString qsHeaderParamName);
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 property.
This property is not available at design time.
Data Type
String
HeaderParamValue Property (JWS Class)
The header parameter value.
Syntax
ANSI (Cross Platform) char* GetHeaderParamValue(int iHeaderParamIndex);
int SetHeaderParamValue(int iHeaderParamIndex, const char* lpszHeaderParamValue); Unicode (Windows) LPWSTR GetHeaderParamValue(INT iHeaderParamIndex);
INT SetHeaderParamValue(INT iHeaderParamIndex, LPCWSTR lpszHeaderParamValue);
char* ipworksencrypt_jws_getheaderparamvalue(void* lpObj, int headerparamindex);
int ipworksencrypt_jws_setheaderparamvalue(void* lpObj, int headerparamindex, const char* lpszHeaderParamValue);
QString GetHeaderParamValue(int iHeaderParamIndex);
int SetHeaderParamValue(int iHeaderParamIndex, QString qsHeaderParamValue);
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 property.
This property is not available at design time.
Data Type
String
InputFile Property (JWS Class)
The file to process.
Syntax
ANSI (Cross Platform) char* GetInputFile();
int SetInputFile(const char* lpszInputFile); Unicode (Windows) LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);
char* ipworksencrypt_jws_getinputfile(void* lpObj);
int ipworksencrypt_jws_setinputfile(void* lpObj, const char* lpszInputFile);
QString GetInputFile();
int SetInputFile(QString qsInputFile);
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.
Data Type
String
InputMessage Property (JWS Class)
The message to process.
Syntax
ANSI (Cross Platform) int GetInputMessage(char* &lpInputMessage, int &lenInputMessage);
int SetInputMessage(const char* lpInputMessage, int lenInputMessage); Unicode (Windows) INT GetInputMessage(LPSTR &lpInputMessage, INT &lenInputMessage);
INT SetInputMessage(LPCSTR lpInputMessage, INT lenInputMessage);
int ipworksencrypt_jws_getinputmessage(void* lpObj, char** lpInputMessage, int* lenInputMessage);
int ipworksencrypt_jws_setinputmessage(void* lpObj, const char* lpInputMessage, int lenInputMessage);
QByteArray GetInputMessage();
int SetInputMessage(QByteArray qbaInputMessage);
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.
Data Type
Binary String
Key Property (JWS Class)
The secret key for the hash algorithm.
Syntax
ANSI (Cross Platform) int GetKey(char* &lpKey, int &lenKey);
int SetKey(const char* lpKey, int lenKey); Unicode (Windows) INT GetKey(LPSTR &lpKey, INT &lenKey);
INT SetKey(LPCSTR lpKey, INT lenKey);
int ipworksencrypt_jws_getkey(void* lpObj, char** lpKey, int* lenKey);
int ipworksencrypt_jws_setkey(void* lpObj, const char* lpKey, int lenKey);
QByteArray GetKey();
int SetKey(QByteArray qbaKey);
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)
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 is it first hashed with the same algorithm.
Data Type
Binary String
KeyId Property (JWS Class)
The Id of the key used to sign the message.
Syntax
ANSI (Cross Platform) char* GetKeyId();
int SetKeyId(const char* lpszKeyId); Unicode (Windows) LPWSTR GetKeyId();
INT SetKeyId(LPCWSTR lpszKeyId);
char* ipworksencrypt_jws_getkeyid(void* lpObj);
int ipworksencrypt_jws_setkeyid(void* lpObj, const char* lpszKeyId);
QString GetKeyId();
int SetKeyId(QString qsKeyId);
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.
Data Type
String
OutputFile Property (JWS Class)
The output file when encrypting or decrypting.
Syntax
ANSI (Cross Platform) char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile); Unicode (Windows) LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);
char* ipworksencrypt_jws_getoutputfile(void* lpObj);
int ipworksencrypt_jws_setoutputfile(void* lpObj, const char* lpszOutputFile);
QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);
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:
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.
Data Type
String
OutputMessage Property (JWS Class)
The output message after processing.
Syntax
ANSI (Cross Platform) int GetOutputMessage(char* &lpOutputMessage, int &lenOutputMessage); Unicode (Windows) INT GetOutputMessage(LPSTR &lpOutputMessage, INT &lenOutputMessage);
int ipworksencrypt_jws_getoutputmessage(void* lpObj, char** lpOutputMessage, int* lenOutputMessage);
QByteArray GetOutputMessage();
Default Value
""
Remarks
This property will be populated with the output from the operation if OutputFile 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:
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.
Data Type
Binary String
Overwrite Property (JWS Class)
Indicates whether or not the class should overwrite files.
Syntax
ANSI (Cross Platform) int GetOverwrite();
int SetOverwrite(int bOverwrite); Unicode (Windows) BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);
int ipworksencrypt_jws_getoverwrite(void* lpObj);
int ipworksencrypt_jws_setoverwrite(void* lpObj, int bOverwrite);
bool GetOverwrite();
int SetOverwrite(bool bOverwrite);
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.
Data Type
Boolean
AddHeaderParam Method (JWS Class)
Adds additional header parameters.
Syntax
ANSI (Cross Platform) int AddHeaderParam(const char* lpszname, const char* lpszvalue, int idataType); Unicode (Windows) INT AddHeaderParam(LPCWSTR lpszname, LPCWSTR lpszvalue, INT idataType);
int ipworksencrypt_jws_addheaderparam(void* lpObj, const char* lpszname, const char* lpszvalue, int idataType);
int AddHeaderParam(const QString& qsname, const QString& qsvalue, int idataType);
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:
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (JWS Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworksencrypt_jws_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
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.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Parse Method (JWS Class)
Parses the compact serialized JWS string.
Syntax
ANSI (Cross Platform) int Parse(); Unicode (Windows) INT Parse();
int ipworksencrypt_jws_parse(void* lpObj);
int 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 HeaderParam* properties 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:
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Reset Method (JWS Class)
Resets the class.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int ipworksencrypt_jws_reset(void* lpObj);
int Reset();
Remarks
When called, the class will reset all of its properties to their default values.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetInputStream Method (JWS Class)
Sets the stream from which the class will read data.
Syntax
ANSI (Cross Platform) int SetInputStream(IPWorksEncryptStream* sInputStream); Unicode (Windows) INT SetInputStream(IPWorksEncryptStream* sInputStream);
int ipworksencrypt_jws_setinputstream(void* lpObj, IPWorksEncryptStream* sInputStream);
int SetInputStream(IPWorksEncryptStream* sInputStream);
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetOutputStream Method (JWS Class)
Sets the stream to which the class will write data.
Syntax
ANSI (Cross Platform) int SetOutputStream(IPWorksEncryptStream* sOutputStream); Unicode (Windows) INT SetOutputStream(IPWorksEncryptStream* sOutputStream);
int ipworksencrypt_jws_setoutputstream(void* lpObj, IPWorksEncryptStream* sOutputStream);
int SetOutputStream(IPWorksEncryptStream* sOutputStream);
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:
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Sign Method (JWS Class)
Signs the payload with the specified algorithm.
Syntax
ANSI (Cross Platform) int Sign(); Unicode (Windows) INT Sign();
int ipworksencrypt_jws_sign(void* lpObj);
int 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:
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;
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Verify Method (JWS Class)
Verifies the signature of the JWS token.
Syntax
ANSI (Cross Platform) int Verify(); Unicode (Windows) INT Verify();
int ipworksencrypt_jws_verify(void* lpObj);
int 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 fails with an error. After calling this method the payload will be present in the OutputMessage or file specified by OutputFile and the Header* properties 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:
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 Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Error Event (JWS Class)
Fired when information is available about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(JWSErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } JWSErrorEventParams;
Unicode (Windows) virtual INT FireError(JWSErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } JWSErrorEventParams;
#define EID_JWS_ERROR 1 virtual INT IPWORKSENCRYPT_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class JWSErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(JWSErrorEventParams *e);
// Or, subclass JWS and override this emitter function. virtual int FireError(JWSErrorEventParams *e) {...}
Remarks
The 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.
HeaderParam Event (JWS Class)
Fires once for each JOSE header parameter.
Syntax
ANSI (Cross Platform) virtual int FireHeaderParam(JWSHeaderParamEventParams *e);
typedef struct {
const char *Name;
const char *Value;
int DataType; int reserved; } JWSHeaderParamEventParams;
Unicode (Windows) virtual INT FireHeaderParam(JWSHeaderParamEventParams *e);
typedef struct {
LPCWSTR Name;
LPCWSTR Value;
INT DataType; INT reserved; } JWSHeaderParamEventParams;
#define EID_JWS_HEADERPARAM 2 virtual INT IPWORKSENCRYPT_CALL FireHeaderParam(LPSTR &lpszName, LPSTR &lpszValue, INT &iDataType);
class JWSHeaderParamEventParams { public: const QString &Name(); const QString &Value(); int DataType(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void HeaderParam(JWSHeaderParamEventParams *e);
// Or, subclass JWS and override this emitter function. virtual int FireHeaderParam(JWSHeaderParamEventParams *e) {...}
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
ANSI (Cross Platform) virtual int FireSignerInfo(JWSSignerInfoEventParams *e);
typedef struct {
const char *KeyId;
const char *Algorithm; int reserved; } JWSSignerInfoEventParams;
Unicode (Windows) virtual INT FireSignerInfo(JWSSignerInfoEventParams *e);
typedef struct {
LPCWSTR KeyId;
LPCWSTR Algorithm; INT reserved; } JWSSignerInfoEventParams;
#define EID_JWS_SIGNERINFO 3 virtual INT IPWORKSENCRYPT_CALL FireSignerInfo(LPSTR &lpszKeyId, LPSTR &lpszAlgorithm);
class JWSSignerInfoEventParams { public: const QString &KeyId(); const QString &Algorithm(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SignerInfo(JWSSignerInfoEventParams *e);
// Or, subclass JWS and override this emitter function. virtual int FireSignerInfo(JWSSignerInfoEventParams *e) {...}
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.
IPWorksEncryptStream Type
Syntax
IPWorksEncryptStream (declared in ipworksencrypt.h)
Remarks
The JWS class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the IPWorksEncryptStream interface and pass the JWS class an instance of that concrete class.
When implementing the IPWorksEncryptStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.
Config Settings (JWS Class)
The class 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 class, access to these internal properties is provided through the Config method.JWS Config Settings
This setting specifics a comma separated list of algorithms that are allowed when StrictValidation is set to true. This allows multiple signing algorithms to be considered acceptable during validation. This setting is only applicable when StrictValidation is set to true. Possible values:
- HS256
- HS384
- HS512
- RS256
- RS384
- RS512
- ES256
- ES384
- ES512
- PS256
- PS384
- PS512
Example value: HS512,HS256.
This setting specifies whether information about the Cert* 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 Cert* properties will automatically be included. 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 Cert* set this to 5.
This setting optionally specifies one or more issuer certificates that may be used by the class when IncludeCertificateFormat is specified. Note that the issuer certificates specified here are used as a store of potential issuer certificates. At runtime the class will inspect the Cert* values 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:
-----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-----
This setting specifies the encoding that has been applied to the Key. value prior to providing it to the class. The Key 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 class will accept the key with an encoding already applied. The class 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)
This setting may be queried after calling Sign or Verify to obtain the raw JOSE header. This returns a JSON string like:
{"alg":"ES384","kid":"myKeyId"}
This setting is used to control the serialization type the class 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.
If set to True the class will validate that the Algorithm in the JWS message matches the value specified in the Algorithm 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 VerifySignature.
Base Config Settings
When queried, this setting will return a string containing information about the product's build.
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 |
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 |
When queried, this setting will return a string containing information about the license this instance of a class 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.
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.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.
If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.
When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this configuration setting to true tells the class 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 section.
Trappable Errors (JWS Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
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. |