Struct ipworksauth::JWT
Properties Methods Events Config Settings Errors
Create, Sign, Encrypt, Verify and Decrypt JSON Web Tokens (JWTs).
Syntax
ipworksauth::JWT
Remarks
The JWT struct supports signing, encrypting, decrypting and verifying JSON Web Tokens (JWTs).
Specify a set of claims via the Claim* properties or add your own claims with add_claim. Call sign to create a signed JWT using a variety of signing algorithms including HMAC, RSA, and ECDSA. Use verify to verify the signature of any received JWT. See signing_algorithm for more details about supported algorithms.
Use encrypt to create an encrypted JWT using a variety of algorithms including ECDH, RSA, and AES. Use decrypt to decrypt the payload of any received JWT. See encryption_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 signing_algorithm to the algorithm which will be used to sign the message. The result of signing is a compact serialized JWT string. For instance:
eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOlsiYXVkaWVuY2UiXSwiaXNzIjoiaXNzdWVyIn0.mlFETSma4WUcUSjNSUWA1n9QBcQHCkHN-y4zeBsCVqI
The struct will use the values present in the Claim* properties to build the encoded JWT. After calling this method the encoded_jwt property will hold the compact serialized JWT. The following properties are applicable when calling this method:
- signing_algorithm (required)
- certificate (conditional - required for ECDSA and RSA)
- key (conditional - required for HMAC)
- claim_audience
- claim_exp
- claim_issued_at
- claim_issuer
- claim_jwt_id
- claim_not_before
- header_params
- key_id
Notes for HMAC Algorithms (HS256, HS384, HS512)
When signing_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 key must be known by both parties in order for signing and verification to take place. To use an existing HMAC key provide the bytes to the key 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
Jwt jwt = new Jwt();
jwt.SigningAlgorithm = JwtSigningAlgorithms.saHS256;
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.KeyB = key;
jwt.Sign();
string signedData = jwt.EncodedJWT;
Notes for RSA Algorithms (RS256, RS384, RS512, PS256, PS384, PS512)
The RSA based algorithms use asymmetric encryption. Signing is done with a private key and verification is done with a public key. The private key may be in PFX or PEM format.
Jwt jwt = new Jwt();
jwt.SigningAlgorithm = JwtSigningAlgorithms.saRS256;
jwt.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "..\\jwt.pfx", "test", "*");
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.Sign();
string signedMessage = jwt.EncodedJWT;
Notes for ECDSA Algorithms (ES256, ES384, ES512)
ECDSA algorithms require a valid ECC private key in order to sign data. The certificate property should be set to a certificate with an ECC key. The CertMgr struct can be used to create a certificate with an ECC key.
//Create an ECC key with SHA-256
Certmgr mgr = new Certmgr();
mgr.Config("CertPublicKeyAlgorithm=ECDSA_P256");
mgr.CertStoreType = CertStoreTypes.cstPEMKeyFile;
mgr.CertStore = "C:\\temp\\ecdsa.pem";
mgr.CreateCertificate("CN=ecdsa", 123);
//Sign the payload using ES256
Jwt jwt = new Jwt();
jwt.SigningAlgorithm = JwtSigningAlgorithms.saES256;
jwt.Certificate = new Certificate(CertStoreTypes.cstPEMKeyFile, "C:\\temp\\ecdsa.pem", "", "*");
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.Sign();
string signedMessage = jwt.EncodedJWT;
Notes for Unsecured (none)
To create a JWS token without any security set signing_algorithm to jwtNone.
Jwt jwt = new Jwt();
jwt.SigningAlgorithm = JwtSigningAlgorithms.saNone;
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.Sign();
string unsecuredMessage = jwt.EncodedJWT;
Signature Verification
The verify method may be used to verify a received JWS message. Before calling the verify method set encoded_jwt to a valid compact serialized JWT. For instance:
eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOlsiYXVkaWVuY2UiXSwiaXNzIjoiaXNzdWVyIn0.mlFETSma4WUcUSjNSUWA1n9QBcQHCkHN-y4zeBsCVqI
The key or signer_cert properties should be set to the HMAC key or public certificate respectively. If the correct key or signer_cert is not known ahead of time the KeyId parameter of the on_signer_info event may be used to identify the correct key.
If this method returns without error verification was successful. If verification fails then this method fails with an error. After calling this method the claims will be parsed and the Claim* properties will be populated. The the header_params property will contain the headers. Headers of the parsed message are also available through the on_header_param event.
The following properties are applicable when calling this method:
- encoded_jwt (required)
- key (conditional - required for HMAC)
- signer_cert (conditional - required for ECDSA and RSA)
- signing_algorithm (only if StrictValidation is True)
- StrictValidation
- ExpectedAudience (optional)
- ExpectedExp (optional)
- ExpectedIssuedAt (optional)
- ExpectedIssuer (optional)
- ExpectedJWTId (optional)
- ExpectedNotBefore (optional)
- ExpectedSubject (optional)
After calling this method the following properties are populated:
- claim_audience
- claim_exp
- claim_issued_at
- claim_issuer
- claim_jwt_id
- claim_not_before
- claim_subject
- header_params
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 };
Jwt jwt = new Jwt();
jwt.KeyB = key;
jwt.EncodedJWT = signedData;
jwt.Verify();
string issuer = jwt.ClaimIssuer;
Notes for RSA Algorithms (RS256, RS384, RS512, PS256, PS384, PS512)
The RSA based algorithms use asymmetric encryption. Signing is done with a private key and verification is done with a public key. The public key is typically in PEM format.
Jwt jwt = new Jwt();
jwt.SignerCert = new Certificate("..\\jwt.cer");
jwt.EncodedJWT = signedData;
jwt.Verify();
string issuer = jwt.ClaimIssuer;
Notes for ECDSA Algorithms (ES256, ES384, ES512)
ECDSA algorithms require a valid ECC public key to verify the message. The PEM encoded public key may be used directly with the certificate property. An example PEM encoded public certificate created by the CertMgr struct:
-----BEGIN CERTIFICATE----- MIIBETCBtaADAgECAgF7MAwGCCqGSM49BAMCBQAwEDEOMAwGA1UEAxMFZWNkc2EwHhcNMjMw NzAzMTcwMjU3WhcNMjQwNzAyMTcwMjU3WjAQMQ4wDAYDVQQDEwVlY2RzYTBZMBMGByqGSM49 AgEGCCqGSM49AwEHA0IABGJv251JI7ITcq+fac9Z2yYkhTLSRhWGzBw1wEJZbs/8AZbVmvcy 4BzKSZEaTfBsCHIt3FLNgRLdugI+B65eQDYwDAYIKoZIzj0EAwIFAANJADBGAiEAzmH5LKKn r4iy9kJvIlCslpcBHM/8k0XQaj13Zwhm2ocCIQD/cSiC4EuqRkxT4IKET7ko3iI5YUS+J5W5 /0xnxxxIpQ== -----END CERTIFICATE-----
Jwt jwt = new Jwt();
jwt.SignerCert = new Certificate(CertStoreTypes.cstPublicKeyBlob, pubKey, "", "*");
jwt.EncodedJWT = signedData;
jwt.Verify();
string issuer = jwt.ClaimIssuer;
Notes for Unsecured (none)
To parse a JWS token without any security call the sign method without setting the key or certificate properties.
Jwt jwt = new Jwt();
jwt.EncodedJWT = signedData;
jwt.Verify();
string issuer = jwt.ClaimIssuer;
Encrypting
The encrypt method may be used to encrypt a payload with a variety of algorithms. To create an encrypted JWT JSON Web Encryption (JWE) is performed by first generating a random key used to encrypt the content. The content encryption key is used to encrypt the content using the algorithm specified by content_encryption_algorithm. The content encryption key is then encrypted itself using the algorithm specified by encryption_algorithm. The content encryption key is not directly exposed in the API as it is randomly generated.
After calling this method the compact serialized JWT is written to encoded_jwt. For instance:
eyJhbGciOiJBMjU2S1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2In0.4tcAnZJ00u4GY2kLOanPOL4CtvcfraZ8SIi6bOZ27qYBI2rHITPc1Q.c_9rCTdPn-saLCti2ZEyWQ.eLwqqo5BGNa70RlsvT-vTh7Gk0hjpJYY_9Zc39Vim_qEtjyMcxZygBpkfx9brzQr9rUbuiAhoCMXKip2-lKT6w.NkuLDPmWxWL4BaTWHWicIQ
The struct will use the values present in the Claim* properties to build the encoded JWT. After calling this method the encoded_jwt property will hold the compact serialized JWT. The following properties are applicable when calling this method:
- encryption_algorithm (required)
- key (conditional - required for AES)
- key_password (conditional - required for PBES)
- recipient_cert (conditional - required for ECDH and RSA)
- claim_audience
- claim_exp
- claim_issued_at
- claim_issuer
- claim_jwt_id
- claim_not_before
- CompressionAlgorithm
- content_encryption_algorithm
- header_params
- key_id
Notes for AES Algorithms (A128KW, A192KW, A256KW, A128GCMKW, A192GCMKW, A256GCMKW)
When encryption_algorithm is set to a AES algorithm key must be set to a key of appropriate length for the algorithm. For instance a 256 bit key would be used for A256KW.
To use an existing AES key provide the bytes to the key property. For instance:
byte[] key = new byte[] { 164, 60, 194, 0, 161, 189, 41, 38, 130, 89, 141, 164, 45, 170, 159, 209, 69, 137, 243, 216, 191, 131, 47, 250, 32, 107, 231, 117, 37, 158, 225, 234 };
//Encrypt the payload using A256KW
Jwt jwt = new Jwt();
jwt.KeyB = key;
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaA256KW;
jwt.Encrypt();
string encryptedData = jwt.EncodedJWT;
Notes for RSA Algorithms (RSA1_5, RSA-OEAP, RSA-OAEP-256)
The RSA based algorithms use asymmetric encryption. Encrypting is done with a public key and decryption is done with a private key. The public certificate should be in PEM (base64) format. For instance:
Jwt jwt = new Jwt();
jwt.Certificate = new Certificate("..\\recipient.cer");
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaRSA_OAEP;
jwt.Encrypt();
string encryptedData = jwt.EncodedJWT;
Notes for ECDH Algorithms (ECDH-ES, ECDH-ES+A128KW, ECDH-ES+A192KW, ECDH-ES+A256KW)
ECDH algorithms require a valid ECC public key to encrypt the message. If the key was originally created with the ECC struct the PEM encoded PublicKey may be used directly with the certificate property. An example PEM encoded public certificate created by the ECC component:
-----BEGIN PUBLIC KEY----- MIIBMjCB7AYHKoZIzj0CATCB4AIBATAsBgcqhkjOPQEBAiEA/////wAAAAEAAAAAAAAAAAAA AAD///////////////8wRAQg/////wAAAAEAAAAAAAAAAAAAAAD///////////////wEIFrG NdiqOpPns+u9VXaYhrxlHQawzFOw9jvOPD4n0mBLBEEEaxfR8uEsQkf4vOblY6RA8ncDfYEt 6zOg9KE5RdiYwpZP40Li/hp/m47n60p8D54WK84zV2sxXs7LtkBoN79R9QIhAP////8AAAAA //////////+85vqtpxeehPO5ysL8YyVRAgEBA0EEIC5rbLp11Mnz6cBXLLriaDIov3rm8RAY x/OR0bOKiff0cQy+sLVaxjseqFk/+Xvl4ORSv5Z6HdHv5GyEpA0UoA== -----END PUBLIC KEY-----
Jwt jwt = new Jwt();
jwt.Certificate = new Certificate(CertStoreTypes.cstPublicKeyFile, pubKeyFile, "", "*");
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaECDH_ES_A256KW;
jwt.Encrypt();
string encryptedData = jwt.EncodedJWT;
To use an ECC public key created by other means the ECC struct may be used to import the key parameters. Populate the Rx and Ry properties of the ECC component first to obtain the PEM formatted public key. For instance:
byte[] x_bytes = new byte[] { 171, 170, 196, 151, 94, 196, 231, 12, 128, 232, 17, 61, 45, 105, 41, 209, 192, 187, 112, 242, 110, 178, 95, 240, 36, 55, 83, 171, 190, 176, 78, 13 };
byte[] y_bytes = new byte[] { 197, 75, 134, 245, 245, 28, 199, 9, 7, 117, 1, 54, 49, 178, 135, 252, 62, 89, 35, 180, 117, 80, 231, 23, 110, 250, 28, 124, 219, 253, 224, 156 };
nsoftware.IPWorksEncrypt.Ecc ecc = new nsoftware.IPWorksEncrypt.Ecc();
ecc.Key.RxB = x_bytes;
ecc.Key.RyB = y_bytes;
string pubKey = ecc.Key.PublicKey;
Jwt jwt = new Jwt();
jwt.Certificate = new Certificate(CertStoreTypes.cstPublicKeyFile, pubKey, "", "*");
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaECDH_ES_A256KW;
jwt.Encrypt();
string encryptedData = jwt.EncodedJWT;
Notes for PBES Algorithms (PBES2-HS256+A128KW, PBES2-HS384+A192KW, PBES2-HS512+A256KW
PBES algorithms derive a content encryption key from the key_password property. Set key_password to a shared secret.
Jwt jwt = new Jwt();
jwt.KeyPassword = "secret";
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaPBES2_HS512_A256KW;
jwt.Encrypt();
string encryptedData = jwt.EncodedJWT;
Notes for Direct Shared Keys
When encryption_algorithm is set to Direct the key property must be set to a valid symmetric key that will be used directly by the content_encryption_algorithm. In this case a content encryption key is not generated randomly, the key is used instead. The length of the specified key must be valid for the selected content_encryption_algorithm. For instance:
byte[] key = new byte[] { 164, 62, 191, 60, 161, 189, 41, 38, 130, 89, 141, 164, 45, 170, 159, 209, 69, 137, 243, 216, 191, 131, 47, 250, 32, 107, 231, 117, 37, 158, 225, 234 };
Jwt jwt = new Jwt();
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaDir;
jwt.ContentEncryptionAlgorithm = JwtContentEncryptionAlgorithms.ceaA256GCM;
jwt.KeyB = key;
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.Encrypt();
string encryptedData = jwt.EncodedJWT;
Decrypting
The decrypt method may be used to decrypt a received JWE message. Before calling the decrypt method set encoded_jwt to a valid compact serialized JWT string. For instance:
eyJhbGciOiJBMjU2S1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2In0.4tcAnZJ00u4GY2kLOanPOL4CtvcfraZ8SIi6bOZ27qYBI2rHITPc1Q.c_9rCTdPn-saLCti2ZEyWQ.eLwqqo5BGNa70RlsvT-vTh7Gk0hjpJYY_9Zc39Vim_qEtjyMcxZygBpkfx9brzQr9rUbuiAhoCMXKip2-lKT6w.NkuLDPmWxWL4BaTWHWicIQ
The type and format of the private key depends on the algorithm used to encrypt the data. The following table summarizes the relationship:
| Algorithm | Private Key Location |
| AES | key |
| RSA and ECDH | certificate |
| PBES | key_password |
If this method returns without error decryption was successful. If decryption fails then this method fails with an error. After calling this method the payload will be present in the Claim* properties and the header_params property will contain the headers. Headers of the parsed message are also available through the on_header_param event.
The following properties are applicable when calling this method:
- certificate (conditional - required for RSA and ECDH)
- encoded_jwt
- key (conditional - required for AES)
- content_encryption_algorithm (only if StrictValidation is True)
- encryption_algorithm (only if StrictValidation is True)
- header_params
- StrictValidation
After calling this method the following properties are populated:
- claim_audience
- claim_exp
- claim_issued_at
- claim_issuer
- claim_jwt_id
- claim_not_before
- claim_subject
- header_params
Notes for AES Algorithms (A128KW, A192KW, A256KW, A128GCMKW, A192GCMKW, A256GCMKW)
To decrypt messages that use AES encryption key must be set to a key of appropriate length for the algorithm. For instance a 256 bit key would be used for A256KW.
The key must be known by both parties in order for encryption and decryption to take place.
byte[] key = new byte[] { 164, 60, 194, 0, 161, 189, 41, 38, 130, 89, 141, 164, 45, 170, 159, 209, 69, 137, 243, 216, 191, 131, 47, 250, 32, 107, 231, 117, 37, 158, 225, 234 };
Jwt jwt = new Jwt();
jwt.KeyB = key;
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();
string issuer = jwt.ClaimIssuer;
Notes for RSA Algorithms (RSA1_5, RSA-OEAP, RSA-OAEP-256)
The RSA based algorithms use asymmetric encryption. Encrypting is done with a public key and decryption is done with a private key. The certificate with private key must be specified. For instance:
Jwt jwt = new Jwt();
jwt.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "..\\jwt.pfx", "password", "*");
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();
string issuer = jwt.ClaimIssuer;
Notes for ECDH Algorithms (ECDH-ES, ECDH-ES+A128KW, ECDH-ES+A192KW, ECDH-ES+A256KW)
ECDH algorithms require a valid ECC private key to decrypt the message. If the key was originally created with the ECC struct the PEM encoded PrivateKey may be used directly with the certificate property.
Jwt jwt = new Jwt();
jwt.Certificate = new Certificate(CertStoreTypes.cstPEMKeyFile, privKeyFile, "", "*");
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();
string issuer = jwt.ClaimIssuer;
To use an ECC private key created by other means the ECC struct may be used to import the key parameters. Populate the Rx, Ry, and KB properties of the ECC component first to obtain the PEM formatted public key. For instance:
nsoftware.IPWorksEncrypt.Ecc ecc = new nsoftware.IPWorksEncrypt.Ecc();
byte[] x_bytes = new byte[] { 171, 170, 196, 151, 94, 196, 231, 12, 128, 232, 17, 61, 45, 105, 41, 209, 192, 187, 112, 242, 110, 178, 95, 240, 36, 55, 83, 171, 190, 176, 78, 13 };
byte[] y_bytes = new byte[] { 197, 75, 134, 245, 245, 28, 199, 9, 7, 117, 1, 54, 49, 178, 135, 252, 62, 89, 35, 180, 117, 80, 231, 23, 110, 250, 28, 124, 219, 253, 224, 156 };
byte[] k_bytes = new byte[] { 81, 65, 201, 24, 235, 249, 162, 148, 169, 150, 109, 181, 61, 238, 145, 122, 31, 30, 151, 94, 239, 90, 222, 217, 63, 103, 54, 2, 176, 232, 248, 168 };
ecc.Key.RxB = x_bytes;
ecc.Key.RyB = y_bytes;
ecc.Key.KB = k_bytes;
string privKey = ecc.Key.PrivateKey;
Jwt jwt = new Jwt();
jwt.Certificate = new Certificate(CertStoreTypes.cstPEMKeyBlob, privKey, "", "*");
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();
string issuer = jwt.ClaimIssuer;
Notes for PBES Algorithms (PBES2-HS256+A128KW, PBES2-HS384+A192KW, PBES2-HS512+A256KW
PBES algorithms derive a content encryption key from the key_password property. Set key_password to the shared secret.
Jwt jwt = new Jwt();
jwt.KeyPassword = "secret";
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();
string issuer = jwt.ClaimIssuer;
Notes for Direct Shared Keys
When Direct encryption is used the key property must be set to a valid symmetric key that will be used directly by the content_encryption_algorithm. For instance:
byte[] key = new byte[] { 164, 60, 194, 0, 161, 189, 41, 38, 130, 89, 141, 164, 45, 170, 159, 209, 69, 137, 243, 216, 191, 131, 47, 250, 32, 107, 231, 117, 37, 158, 225, 234 };
Jwt jwt = new Jwt();
jwt.KeyB = key;
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();
string issuer = jwt.ClaimIssuer;
Other Functionality
In addition to standard operations the struct also supports a variety of other features including:
- Adding custom header parameters with add_header_param
- Enforcing algorithm restrictions when verifying by setting StrictValidation
- Inspect the JWT without verifying or decrypting by calling parse
Object Lifetime
The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksAuth. Due to this, the JWT struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of JWT when you have finished using the instance.
Property List
The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.
| cert_effective_date | The date on which this certificate becomes valid. |
| cert_expiration_date | The date on which the certificate expires. |
| cert_extended_key_usage | A comma-delimited list of extended key usage identifiers. |
| cert_fingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| cert_fingerprint_sha1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| cert_fingerprint_sha256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| cert_issuer | The issuer of the certificate. |
| cert_private_key | The private key of the certificate (if available). |
| cert_private_key_available | Whether a PrivateKey is available for the selected certificate. |
| cert_private_key_container | The name of the PrivateKey container for the certificate (if available). |
| cert_public_key | The public key of the certificate. |
| cert_public_key_algorithm | The textual description of the certificate's public key algorithm. |
| cert_public_key_length | The length of the certificate's public key (in bits). |
| cert_serial_number | The serial number of the certificate encoded as a string. |
| cert_signature_algorithm | The text description of the certificate's signature algorithm. |
| cert_store | The name of the certificate store for the client certificate. |
| cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| cert_store_type | The type of certificate store for this certificate. |
| cert_subject_alt_names | Comma-separated lists of alternative subject names for the certificate. |
| cert_thumbprint_md5 | The MD5 hash of the certificate. |
| cert_thumbprint_sha1 | The SHA-1 hash of the certificate. |
| cert_thumbprint_sha256 | The SHA-256 hash of the certificate. |
| cert_usage | The text description of UsageFlags . |
| cert_usage_flags | The flags that show intended use for the certificate. |
| cert_version | The certificate's version number. |
| cert_subject | The subject of the certificate used for client authentication. |
| cert_encoded | The certificate (PEM/Base64 encoded). |
| claim_audience | The audience claim. |
| claim_exp | The expiration time claim. |
| claim_issued_at | The claim indicating the time at which the JWT was issued. |
| claim_issuer | The issuer of the JWT. |
| claim_jwt_id | The unique identifier for the JWT. |
| claim_not_before | The claim identifying the time before which the JWT is invalid. |
| jwt_claim_count | The number of records in the JWTClaim arrays. |
| jwt_claim_data_type | The data type of the claim value. |
| jwt_claim_name | The claim name. |
| jwt_claim_value | The claim value. |
| claim_subject | The subject identifies the principal of the JWT. |
| content_encryption_algorithm | The algorithm used to encrypt the content. |
| encoded_jwt | The encoded JWT. |
| encryption_algorithm | The key encryption algorithm. |
| header_param_count | The number of records in the HeaderParam arrays. |
| header_param_data_type | The data type of the header parameter. |
| header_param_name | The header parameter name. |
| header_param_value | The header parameter value. |
| key | The key used for AES. |
| key_id | The Id of the key used to sign or encrypt the message. |
| key_password | The key password used in the PBES algorithm. |
| recipient_cert_effective_date | The date on which this certificate becomes valid. |
| recipient_cert_expiration_date | The date on which the certificate expires. |
| recipient_cert_extended_key_usage | A comma-delimited list of extended key usage identifiers. |
| recipient_cert_fingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| recipient_cert_fingerprint_sha1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| recipient_cert_fingerprint_sha256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| recipient_cert_issuer | The issuer of the certificate. |
| recipient_cert_private_key | The private key of the certificate (if available). |
| recipient_cert_private_key_available | Whether a PrivateKey is available for the selected certificate. |
| recipient_cert_private_key_container | The name of the PrivateKey container for the certificate (if available). |
| recipient_cert_public_key | The public key of the certificate. |
| recipient_cert_public_key_algorithm | The textual description of the certificate's public key algorithm. |
| recipient_cert_public_key_length | The length of the certificate's public key (in bits). |
| recipient_cert_serial_number | The serial number of the certificate encoded as a string. |
| recipient_cert_signature_algorithm | The text description of the certificate's signature algorithm. |
| recipient_cert_store | The name of the certificate store for the client certificate. |
| recipient_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| recipient_cert_store_type | The type of certificate store for this certificate. |
| recipient_cert_subject_alt_names | Comma-separated lists of alternative subject names for the certificate. |
| recipient_cert_thumbprint_md5 | The MD5 hash of the certificate. |
| recipient_cert_thumbprint_sha1 | The SHA-1 hash of the certificate. |
| recipient_cert_thumbprint_sha256 | The SHA-256 hash of the certificate. |
| recipient_cert_usage | The text description of UsageFlags . |
| recipient_cert_usage_flags | The flags that show intended use for the certificate. |
| recipient_cert_version | The certificate's version number. |
| recipient_cert_subject | The subject of the certificate used for client authentication. |
| recipient_cert_encoded | The certificate (PEM/Base64 encoded). |
| signer_cert_effective_date | The date on which this certificate becomes valid. |
| signer_cert_expiration_date | The date on which the certificate expires. |
| signer_cert_extended_key_usage | A comma-delimited list of extended key usage identifiers. |
| signer_cert_fingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| signer_cert_fingerprint_sha1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| signer_cert_fingerprint_sha256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| signer_cert_issuer | The issuer of the certificate. |
| signer_cert_private_key | The private key of the certificate (if available). |
| signer_cert_private_key_available | Whether a PrivateKey is available for the selected certificate. |
| signer_cert_private_key_container | The name of the PrivateKey container for the certificate (if available). |
| signer_cert_public_key | The public key of the certificate. |
| signer_cert_public_key_algorithm | The textual description of the certificate's public key algorithm. |
| signer_cert_public_key_length | The length of the certificate's public key (in bits). |
| signer_cert_serial_number | The serial number of the certificate encoded as a string. |
| signer_cert_signature_algorithm | The text description of the certificate's signature algorithm. |
| signer_cert_store | The name of the certificate store for the client certificate. |
| signer_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| signer_cert_store_type | The type of certificate store for this certificate. |
| signer_cert_subject_alt_names | Comma-separated lists of alternative subject names for the certificate. |
| signer_cert_thumbprint_md5 | The MD5 hash of the certificate. |
| signer_cert_thumbprint_sha1 | The SHA-1 hash of the certificate. |
| signer_cert_thumbprint_sha256 | The SHA-256 hash of the certificate. |
| signer_cert_usage | The text description of UsageFlags . |
| signer_cert_usage_flags | The flags that show intended use for the certificate. |
| signer_cert_version | The certificate's version number. |
| signer_cert_subject | The subject of the certificate used for client authentication. |
| signer_cert_encoded | The certificate (PEM/Base64 encoded). |
| signing_algorithm | The algorithm used when signing. |
| signing_key | The key used for HMAC. |
Method List
The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.
| add_claim | Adds an new claim. |
| add_header_param | Adds additional header parameters. |
| config | Sets or retrieves a configuration setting. |
| decrypt | Decrypts the encoded JWT. |
| decrypt_and_verify | Decrypts the encoded JWT, and verifies the signature. |
| encrypt | Encrypts the claims with the specified algorithms. |
| parse | Parses the encoded JWT. |
| reset | Resets the struct properties. |
| sign | Signs the payload with the specified algorithm. |
| sign_and_encrypt | Signs the payload with the specified algorithm, and encrypts the result of signing. |
| verify | Verifies the signature of the encoded JWT. |
Event List
The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.
| on_claim_info | Fires once for each claim. |
| on_error | Fired when information is available about errors during data delivery. |
| on_header_param | Fires once for each JOSE header parameter. |
| on_recipient_info | Fired with information about the recipient key of the encrypted message. |
| on_signer_info | Fires with information about the signature. |
Config Settings
The following is a list of config settings for the struct with short descriptions. Click on the links for further details.
| AllowedSigningAlgorithms | Allowed signing algorithms when StrictValidation is set to True. |
| AudienceDelimiter | Defines the character to separate audience values. |
| CompressionAlgorithm | The compression algorithm to use. |
| ExpectedAudience | The expected audience claim. |
| ExpectedExp | The expected expiration time claim. |
| ExpectedIssuedAt | The expected time at which the JWT was issued. |
| ExpectedIssuer | The expected issuer of the JWT. |
| ExpectedJWTId | The expected unique identifier for the JWT. |
| ExpectedNotBefore | The expected claim identifying the time before which the JWT is invalid. |
| ExpectedSubject | The expected subject identifying the principal of the JWT. |
| IncludeCertificateFormat | The certificate values to include in the signed message (if any). |
| InputMessage | The raw input to process. |
| IsEncrypted | Indicates whether the EncodedJWT is encrypted. |
| IsSigned | Indicates whether the EncodedJWT is signed. |
| IssuerCerts | A collection of issuer certificates used with IncludeCertificateFormat. |
| KeyEncoding | The encoding of the Key value. |
| OutputMessage | The raw output of the operation. |
| PartyUInfo | Information about the producer of the message. |
| PartyVInfo | Information about the recipient of the message. |
| PBES2Count | The PBKDF2 iteration count. |
| PBES2SaltLength | The salt input value length. |
| RawHeader | Holds the raw JOSE header. |
| StrictValidation | Requires specific algorithms when processing. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| MaskSensitiveData | Whether sensitive data is masked in log messages. |
| UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
cert_effective_date property (JWT Struct)
The date on which this certificate becomes valid.
Syntax
fn cert_effective_date(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
cert_expiration_date property (JWT Struct)
The date on which the certificate expires.
Syntax
fn cert_expiration_date(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
cert_extended_key_usage property (JWT Struct)
A comma-delimited list of extended key usage identifiers.
Syntax
fn cert_extended_key_usage(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
cert_fingerprint property (JWT Struct)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
fn cert_fingerprint(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
cert_fingerprint_sha1 property (JWT Struct)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
fn cert_fingerprint_sha1(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
cert_fingerprint_sha256 property (JWT Struct)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
fn cert_fingerprint_sha256(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
cert_issuer property (JWT Struct)
The issuer of the certificate.
Syntax
fn cert_issuer(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
cert_private_key property (JWT Struct)
The private key of the certificate (if available).
Syntax
fn cert_private_key(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
NOTE: The cert_private_key may be available but not exportable. In this case, cert_private_key returns an empty string.
This property is read-only.
Data Type
String
cert_private_key_available property (JWT Struct)
Whether a PrivateKey is available for the selected certificate.
Syntax
fn cert_private_key_available(&self ) -> Result<bool, IPWorksAuthError>
Default Value
false
Remarks
Whether a cert_private_key is available for the selected certificate. If cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
bool
cert_private_key_container property (JWT Struct)
The name of the PrivateKey container for the certificate (if available).
Syntax
fn cert_private_key_container(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The name of the cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
cert_public_key property (JWT Struct)
The public key of the certificate.
Syntax
fn cert_public_key(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
cert_public_key_algorithm property (JWT Struct)
The textual description of the certificate's public key algorithm.
Syntax
fn cert_public_key_algorithm(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
cert_public_key_length property (JWT Struct)
The length of the certificate's public key (in bits).
Syntax
fn cert_public_key_length(&self ) -> Result<i32, IPWorksAuthError>
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
i32
cert_serial_number property (JWT Struct)
The serial number of the certificate encoded as a string.
Syntax
fn cert_serial_number(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
cert_signature_algorithm property (JWT Struct)
The text description of the certificate's signature algorithm.
Syntax
fn cert_signature_algorithm(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
cert_store property (JWT Struct)
The name of the certificate store for the client certificate.
Syntax
fn cert_store(&self ) -> Result<Vec<u8>, IPWorksAuthError>
fn set_cert_store(&self, value : Vec<u8>) -> Option<IPWorksAuthError> fn set_cert_store_ref(&self, value : &[u8]) -> Option<IPWorksAuthError>
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The cert_store_type property denotes the type of the certificate store specified by cert_store. If the store is password-protected, specify the password in cert_store_password.
cert_store is used in conjunction with the cert_subject property to specify client certificates. If cert_store has a value, and cert_subject or cert_encoded is set, a search for a certificate is initiated. Please see the cert_subject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Vec
cert_store_password property (JWT Struct)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
fn cert_store_password(&self ) -> Result<String, IPWorksAuthError>
fn set_cert_store_password(&self, value : &str) -> Option<IPWorksAuthError> fn set_cert_store_password_ref(&self, value : &String) -> Option<IPWorksAuthError>
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
cert_store_type property (JWT Struct)
The type of certificate store for this certificate.
Syntax
fn cert_store_type(&self ) -> Result<i32, IPWorksAuthError>
fn set_cert_store_type(&self, value : i32) -> Option<IPWorksAuthError>
Possible Values
0 // User
1 // Machine
2 // PFXFile
3 // PFXBlob
4 // JKSFile
5 // JKSBlob
6 // PEMKeyFile
7 // PEMKeyBlob
8 // PublicKeyFile
9 // PublicKeyBlob
10 // SSHPublicKeyBlob
11 // P7BFile
12 // P7BBlob
13 // SSHPublicKeyFile
14 // PPKFile
15 // PPKBlob
16 // XMLFile
17 // XMLBlob
18 // JWKFile
19 // JWKBlob
20 // SecurityKey
21 // BCFKSFile
22 // BCFKSBlob
23 // PKCS11
99 // Auto
Default Value
0
Remarks
The type of certificate store for this certificate.
The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, create a new Certificate object and pass cstPKCS11 as the cert_store_type, the full path of the PKCS#11 DLL as the cert_store, and the PIN as the cert_store_password. Code Example. SSH Authentication with Security Key (without CertMgr):
Alternatively, collect the necessary data using the CertMgr struct by calling the list_store_certificates method after setting the corresponding properties accordingly. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the cert_store and set cert_store_password to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr):
|
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
i32
cert_subject_alt_names property (JWT Struct)
Comma-separated lists of alternative subject names for the certificate.
Syntax
fn cert_subject_alt_names(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
cert_thumbprint_md5 property (JWT Struct)
The MD5 hash of the certificate.
Syntax
fn cert_thumbprint_md5(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
cert_thumbprint_sha1 property (JWT Struct)
The SHA-1 hash of the certificate.
Syntax
fn cert_thumbprint_sha1(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
cert_thumbprint_sha256 property (JWT Struct)
The SHA-256 hash of the certificate.
Syntax
fn cert_thumbprint_sha256(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
cert_usage property (JWT Struct)
The text description of UsageFlags .
Syntax
fn cert_usage(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The text description of cert_usage_flags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
cert_usage_flags property (JWT Struct)
The flags that show intended use for the certificate.
Syntax
fn cert_usage_flags(&self ) -> Result<i32, IPWorksAuthError>
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of cert_usage_flags is a combination of the following flags:
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |
Please see the cert_usage property for a text representation of cert_usage_flags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
i32
cert_version property (JWT Struct)
The certificate's version number.
Syntax
fn cert_version(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
cert_subject property (JWT Struct)
The subject of the certificate used for client authentication.
Syntax
fn cert_subject(&self ) -> Result<String, IPWorksAuthError>
fn set_cert_subject(&self, value : &str) -> Option<IPWorksAuthError> fn set_cert_subject_ref(&self, value : &String) -> Option<IPWorksAuthError>
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
cert_encoded property (JWT Struct)
The certificate (PEM/Base64 encoded).
Syntax
fn cert_encoded(&self ) -> Result<Vec<u8>, IPWorksAuthError>
fn set_cert_encoded(&self, value : Vec<u8>) -> Option<IPWorksAuthError> fn set_cert_encoded_ref(&self, value : &[u8]) -> Option<IPWorksAuthError>
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The cert_store and cert_subject properties also may be used to specify a certificate.
When cert_encoded is set, a search is initiated in the current cert_store for the private key of the certificate. If the key is found, cert_subject is updated to reflect the full subject of the selected certificate; otherwise, cert_subject is set to an empty string.
Data Type
Vec
claim_audience property (JWT Struct)
The audience claim.
Syntax
fn claim_audience(&self ) -> Result<String, IPWorksAuthError>
fn set_claim_audience(&self, value : &str) -> Option<IPWorksAuthError> fn set_claim_audience_ref(&self, value : &String) -> Option<IPWorksAuthError>
Default Value
""
Remarks
This property holds the audience claim. The audience claim identifies the recipients that the JWT is intended for. The values specified here are case sensitive.
Multiple audience values are supported and should be separated by a semicolon. See AudienceDelimiter for details.
This property corresponds to the aud JSON property.
Data Type
String
claim_exp property (JWT Struct)
The expiration time claim.
Syntax
fn claim_exp(&self ) -> Result<String, IPWorksAuthError>
fn set_claim_exp(&self, value : &str) -> Option<IPWorksAuthError> fn set_claim_exp_ref(&self, value : &String) -> Option<IPWorksAuthError>
Default Value
""
Remarks
This property holds the expiration time claim. The expiration time claim identifies the expiration time on or after which the JWT must not be accepted. This value corresponds to the exp JSON property.
This value is represented as a numeric value containing the number of seconds since the epoch (January 1st 1970). For instance 1498599163.
Data Type
String
claim_issued_at property (JWT Struct)
The claim indicating the time at which the JWT was issued.
Syntax
fn claim_issued_at(&self ) -> Result<String, IPWorksAuthError>
fn set_claim_issued_at(&self, value : &str) -> Option<IPWorksAuthError> fn set_claim_issued_at_ref(&self, value : &String) -> Option<IPWorksAuthError>
Default Value
""
Remarks
This property holds the time at which the JWT was issued. This value corresponds to the iat JSON property.
This value is represented as a numeric value containing the number of seconds since the epoch (January 1st 1970). For instance 1498599163.
Data Type
String
claim_issuer property (JWT Struct)
The issuer of the JWT.
Syntax
fn claim_issuer(&self ) -> Result<String, IPWorksAuthError>
fn set_claim_issuer(&self, value : &str) -> Option<IPWorksAuthError> fn set_claim_issuer_ref(&self, value : &String) -> Option<IPWorksAuthError>
Default Value
""
Remarks
This property holds the issuer of the JWT. The value is a case-sensitive string.
This property corresponds to the iss JSON property.
Data Type
String
claim_jwt_id property (JWT Struct)
The unique identifier for the JWT.
Syntax
fn claim_jwt_id(&self ) -> Result<String, IPWorksAuthError>
fn set_claim_jwt_id(&self, value : &str) -> Option<IPWorksAuthError> fn set_claim_jwt_id_ref(&self, value : &String) -> Option<IPWorksAuthError>
Default Value
""
Remarks
This property holds the unique identifier for the JWT. The value is a case-sensitive string.
This property corresponds to the jti JSON property.
Data Type
String
claim_not_before property (JWT Struct)
The claim identifying the time before which the JWT is invalid.
Syntax
fn claim_not_before(&self ) -> Result<String, IPWorksAuthError>
fn set_claim_not_before(&self, value : &str) -> Option<IPWorksAuthError> fn set_claim_not_before_ref(&self, value : &String) -> Option<IPWorksAuthError>
Default Value
""
Remarks
This property identifies the time before which the JWT is invalid. This value corresponds to the nbf JSON property.
This value is represented as a numeric value containing the number of seconds since the epoch (January 1st 1970). For instance 1498599163.
Data Type
String
jwt_claim_count property (JWT Struct)
The number of records in the JWTClaim arrays.
Syntax
fn jwt_claim_count(&self ) -> Result<i32, IPWorksAuthError>
fn set_jwt_claim_count(&self, value : i32) -> Option<IPWorksAuthError>
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at jwt_claim_count - 1.Data Type
i32
jwt_claim_data_type property (JWT Struct)
The data type of the claim value.
Syntax
fn jwt_claim_data_type(&self , JWTClaimIndex : i32) -> Result<i32, IPWorksAuthError>
fn set_jwt_claim_data_type(&self, JWTClaimIndex : i32, value : i32) -> Option<IPWorksAuthError>
Possible Values
0 // Object
1 // Array
2 // String
3 // Number
4 // Bool
5 // Null
Default Value
2
Remarks
The data type of the claim value.
This property specifies the JSON type of the claim value. Possible values are:
- 0 (Object)
- 1 (Array)
- 2 (String)
- 3 (Number)
- 4 (Bool)
- 5 (Null)
The JWTClaimIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JWTClaimCount property.
Data Type
i32
jwt_claim_name property (JWT Struct)
The claim name.
Syntax
fn jwt_claim_name(&self , JWTClaimIndex : i32) -> Result<String, IPWorksAuthError>
fn set_jwt_claim_name(&self, JWTClaimIndex : i32, value : &str) -> Option<IPWorksAuthError> fn set_jwt_claim_name_ref(&self, JWTClaimIndex : i32, value : &String) -> Option<IPWorksAuthError>
Default Value
""
Remarks
The claim name.
The JWTClaimIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JWTClaimCount property.
Data Type
String
jwt_claim_value property (JWT Struct)
The claim value.
Syntax
fn jwt_claim_value(&self , JWTClaimIndex : i32) -> Result<String, IPWorksAuthError>
fn set_jwt_claim_value(&self, JWTClaimIndex : i32, value : &str) -> Option<IPWorksAuthError> fn set_jwt_claim_value_ref(&self, JWTClaimIndex : i32, value : &String) -> Option<IPWorksAuthError>
Default Value
""
Remarks
The claim value.
The JWTClaimIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JWTClaimCount property.
Data Type
String
claim_subject property (JWT Struct)
The subject identifies the principal of the JWT.
Syntax
fn claim_subject(&self ) -> Result<String, IPWorksAuthError>
fn set_claim_subject(&self, value : &str) -> Option<IPWorksAuthError> fn set_claim_subject_ref(&self, value : &String) -> Option<IPWorksAuthError>
Default Value
""
Remarks
This property holds the subject which identifies the principal of the JWT. The value is a case-sensitive string.
This property corresponds to the sub JSON property.
Data Type
String
content_encryption_algorithm property (JWT Struct)
The algorithm used to encrypt the content.
Syntax
fn content_encryption_algorithm(&self ) -> Result<i32, IPWorksAuthError>
fn set_content_encryption_algorithm(&self, value : i32) -> Option<IPWorksAuthError>
Possible Values
0 // A128CBC_HS256
1 // A192CBC_HS384
2 // A256CBC_HS512
3 // A128GCM
4 // A192GCM
5 // A256GCM
Default Value
0
Remarks
This property specifies the algorithm used to encrypt the content.
The following values are supported.
| Algorithm | Description |
| 0 (ceaA128CBC_HS256 - default) | AES_128_CBC_HMAC_SHA_256 authenticated encryption algorithm |
| 1 (ceaA192CBC_HS384) | AES_192_CBC_HMAC_SHA_384 authenticated encryption algorithm |
| 2 (ceaA256CBC_HS512) | AES_256_CBC_HMAC_SHA_512 authenticated encryption algorithm |
| 3 (ceaA128GCM) | AES GCM using 128-bit key |
| 4 (ceaA192GCM) | AES GCM using 192-bit key |
| 5 (ceaA256GCM) | AES GCM using 256-bit key |
Data Type
i32
encoded_jwt property (JWT Struct)
The encoded JWT.
Syntax
fn encoded_jwt(&self ) -> Result<String, IPWorksAuthError>
fn set_encoded_jwt(&self, value : &str) -> Option<IPWorksAuthError> fn set_encoded_jwt_ref(&self, value : &String) -> Option<IPWorksAuthError>
Default Value
""
Remarks
This property holds the encoded JWT. This is populated after calling sign or encrypt.
This must be set to a valid JWT before calling verify, decrypt or parse.
Data Type
String
encryption_algorithm property (JWT Struct)
The key encryption algorithm.
Syntax
fn encryption_algorithm(&self ) -> Result<i32, IPWorksAuthError>
fn set_encryption_algorithm(&self, value : i32) -> Option<IPWorksAuthError>
Possible Values
0 // RSA1_5
1 // RSA_OAEP
2 // RSA_OAEP_256
3 // A128KW
4 // A192KW
5 // A256KW
6 // Dir
7 // ECDH_ES
8 // ECDH_ES_A128KW
9 // ECDH_ES_A192KW
10 // ECDH_ES_A256KW
11 // A128GCMKW
12 // A192GCMKW
13 // A256GCMKW
14 // PBES2_HS256_A128KW
15 // PBES2_HS384_A192KW
16 // PBES2_HS512_A256KW
Default Value
0
Remarks
This property specifies the algorithm used to encrypt the randomly generated content encryption key.
When using an AES algorithm the key property must be specified. When using an RSA or ECDH algorithm the recipient_cert property must be specified. When using a PBES algorithm the key_password property must be specified;. Possible values are:
| Algorithm | Description | Key Location |
| 0 (eaRSA1_5 - default) | RSAES-PKCS1-v1_5 | recipient_cert |
| 1 (eaRSA_OAEP) | RSAES OAEP using default parameters | recipient_cert |
| 2 (eaRSA_OAEP_256) | RSAES OAEP using SHA-256 and MGF1 with SHA-256 | recipient_cert |
| 3 (eaA128KW) | AES Key Wrap with default initial using 128-bit key | key |
| 4 (eaA192KW) | AES Key Wrap with default initial using 192-bit key | key |
| 5 (eaA256KW) | AES Key Wrap with default initial using 256-bit key | key |
| 6 (eaDir) | Direct use of a shared symmetric key as the CEK | key |
| 7 (eaECDH_ES) | Elliptic Curve Ephemeral Static key agreement using Concat KDF | recipient_cert |
| 8 (eaECDH_ES_A128KW) | ECDH-ES using Concat KDF and CEK wrapped with A128KW | recipient_cert |
| 9 (eaECDH_ES_A192KW) | ECDH-ES using Concat KDF and CEK wrapped with A192KW | recipient_cert |
| 10 (eaECDH_ES_A256KW) | ECDH-ES using Concat KDF and CEK wrapped with A256KW | recipient_cert |
| 11 (eaA128GCMKW) | Key wrapping with AES GCM using 128-bit key | key |
| 12 (eaA192GCMKW) | Key wrapping with AES GCM using 192-bit key | key |
| 13 (eaA256GCMKW) | Key wrapping with AES GCM using 256-bit key | key |
| 14 (eaPBES2_HS256_A128KW) | PBES2 with HMAC SHA-256 and A128KW | key_password |
| 15 (eaPBES2_HS384_A192KW) | PBES2 with HMAC SHA-384 and A192KW | key_password |
| 16 (eaPBES2_HS512_A256KW) | PBES2 with HMAC SHA-512 and A256KW | key_password |
When set to an ECDH algorithm the following settings are also applicable:
When set to a PBES algorithm the following settings are also applicable:
Data Type
i32
header_param_count property (JWT Struct)
The number of records in the HeaderParam arrays.
Syntax
fn header_param_count(&self ) -> Result<i32, IPWorksAuthError>
fn set_header_param_count(&self, value : i32) -> Option<IPWorksAuthError>
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at header_param_count - 1.Data Type
i32
header_param_data_type property (JWT Struct)
The data type of the header parameter.
Syntax
fn header_param_data_type(&self , HeaderParamIndex : i32) -> Result<i32, IPWorksAuthError>
fn set_header_param_data_type(&self, HeaderParamIndex : i32, value : i32) -> Option<IPWorksAuthError>
Possible Values
0 // Object
1 // Array
2 // String
3 // Number
4 // Bool
5 // Null
Default Value
2
Remarks
The data type of the header parameter.
This property specifies the JSON type of the header parameter value. Possible values are:
- 0 (Object)
- 1 (Array)
- 2 (String)
- 3 (Number)
- 4 (Bool)
- 5 (Null)
The HeaderParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the HeaderParamCount property.
Data Type
i32
header_param_name property (JWT Struct)
The header parameter name.
Syntax
fn header_param_name(&self , HeaderParamIndex : i32) -> Result<String, IPWorksAuthError>
fn set_header_param_name(&self, HeaderParamIndex : i32, value : &str) -> Option<IPWorksAuthError> fn set_header_param_name_ref(&self, HeaderParamIndex : i32, value : &String) -> Option<IPWorksAuthError>
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.
Data Type
String
header_param_value property (JWT Struct)
The header parameter value.
Syntax
fn header_param_value(&self , HeaderParamIndex : i32) -> Result<String, IPWorksAuthError>
fn set_header_param_value(&self, HeaderParamIndex : i32, value : &str) -> Option<IPWorksAuthError> fn set_header_param_value_ref(&self, HeaderParamIndex : i32, value : &String) -> Option<IPWorksAuthError>
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.
Data Type
String
key property (JWT Struct)
The key used for AES.
Syntax
fn key(&self ) -> Result<Vec<u8>, IPWorksAuthError>
fn set_key(&self, value : Vec<u8>) -> Option<IPWorksAuthError> fn set_key_ref(&self, value : &[u8]) -> Option<IPWorksAuthError>
Default Value
""
Remarks
This property specifies the key used when encrypting with an AES algorithm.
Encrypting
When encryption_algorithm is set to an AES algorithm this property must hold the symmetric key used for encryption and decryption. The size of the key must match the size of the algorithm. For instance when selecting the algorithm A256GCMKW (AES 256) the size of the key must also be 256 bits (32 bytes).
In the case where encryption_algorithm is set to Direct this key is used directly with the algorithm specified by content_encryption_algorithm and must be an appropriate size for the selected content_encryption_algorithm.
Data Type
Vec
key_id property (JWT Struct)
The Id of the key used to sign or encrypt the message.
Syntax
fn key_id(&self ) -> Result<String, IPWorksAuthError>
fn set_key_id(&self, value : &str) -> Option<IPWorksAuthError> fn set_key_id_ref(&self, value : &String) -> Option<IPWorksAuthError>
Default Value
""
Remarks
This property optionally specifies the Id of the key used to sign the message.
Any string value may be supplied here to help the other party identify the key used to sign or encrypt the message. This may be set before calling the sign or encrypt method.
Data Type
String
key_password property (JWT Struct)
The key password used in the PBES algorithm.
Syntax
fn key_password(&self ) -> Result<String, IPWorksAuthError>
fn set_key_password(&self, value : &str) -> Option<IPWorksAuthError> fn set_key_password_ref(&self, value : &String) -> Option<IPWorksAuthError>
Default Value
""
Remarks
This property specifies the key password used to derive a key when using a PBES encryption_algorithm.
This is only applicable to PBES algorithms and must be set before calling encrypt or decrypt.
This property does not apply when calling sign or verify.
Data Type
String
recipient_cert_effective_date property (JWT Struct)
The date on which this certificate becomes valid.
Syntax
fn recipient_cert_effective_date(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
recipient_cert_expiration_date property (JWT Struct)
The date on which the certificate expires.
Syntax
fn recipient_cert_expiration_date(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
recipient_cert_extended_key_usage property (JWT Struct)
A comma-delimited list of extended key usage identifiers.
Syntax
fn recipient_cert_extended_key_usage(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
recipient_cert_fingerprint property (JWT Struct)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
fn recipient_cert_fingerprint(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
recipient_cert_fingerprint_sha1 property (JWT Struct)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
fn recipient_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
recipient_cert_fingerprint_sha256 property (JWT Struct)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
fn recipient_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
recipient_cert_issuer property (JWT Struct)
The issuer of the certificate.
Syntax
fn recipient_cert_issuer(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
recipient_cert_private_key property (JWT Struct)
The private key of the certificate (if available).
Syntax
fn recipient_cert_private_key(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
NOTE: The recipient_cert_private_key may be available but not exportable. In this case, recipient_cert_private_key returns an empty string.
This property is read-only.
Data Type
String
recipient_cert_private_key_available property (JWT Struct)
Whether a PrivateKey is available for the selected certificate.
Syntax
fn recipient_cert_private_key_available(&self ) -> Result<bool, IPWorksAuthError>
Default Value
false
Remarks
Whether a recipient_cert_private_key is available for the selected certificate. If recipient_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
bool
recipient_cert_private_key_container property (JWT Struct)
The name of the PrivateKey container for the certificate (if available).
Syntax
fn recipient_cert_private_key_container(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The name of the recipient_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
recipient_cert_public_key property (JWT Struct)
The public key of the certificate.
Syntax
fn recipient_cert_public_key(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
recipient_cert_public_key_algorithm property (JWT Struct)
The textual description of the certificate's public key algorithm.
Syntax
fn recipient_cert_public_key_algorithm(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
recipient_cert_public_key_length property (JWT Struct)
The length of the certificate's public key (in bits).
Syntax
fn recipient_cert_public_key_length(&self ) -> Result<i32, IPWorksAuthError>
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
i32
recipient_cert_serial_number property (JWT Struct)
The serial number of the certificate encoded as a string.
Syntax
fn recipient_cert_serial_number(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
recipient_cert_signature_algorithm property (JWT Struct)
The text description of the certificate's signature algorithm.
Syntax
fn recipient_cert_signature_algorithm(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
recipient_cert_store property (JWT Struct)
The name of the certificate store for the client certificate.
Syntax
fn recipient_cert_store(&self ) -> Result<Vec<u8>, IPWorksAuthError>
fn set_recipient_cert_store(&self, value : Vec<u8>) -> Option<IPWorksAuthError> fn set_recipient_cert_store_ref(&self, value : &[u8]) -> Option<IPWorksAuthError>
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The recipient_cert_store_type property denotes the type of the certificate store specified by recipient_cert_store. If the store is password-protected, specify the password in recipient_cert_store_password.
recipient_cert_store is used in conjunction with the recipient_cert_subject property to specify client certificates. If recipient_cert_store has a value, and recipient_cert_subject or recipient_cert_encoded is set, a search for a certificate is initiated. Please see the recipient_cert_subject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Vec
recipient_cert_store_password property (JWT Struct)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
fn recipient_cert_store_password(&self ) -> Result<String, IPWorksAuthError>
fn set_recipient_cert_store_password(&self, value : &str) -> Option<IPWorksAuthError> fn set_recipient_cert_store_password_ref(&self, value : &String) -> Option<IPWorksAuthError>
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
recipient_cert_store_type property (JWT Struct)
The type of certificate store for this certificate.
Syntax
fn recipient_cert_store_type(&self ) -> Result<i32, IPWorksAuthError>
fn set_recipient_cert_store_type(&self, value : i32) -> Option<IPWorksAuthError>
Possible Values
0 // User
1 // Machine
2 // PFXFile
3 // PFXBlob
4 // JKSFile
5 // JKSBlob
6 // PEMKeyFile
7 // PEMKeyBlob
8 // PublicKeyFile
9 // PublicKeyBlob
10 // SSHPublicKeyBlob
11 // P7BFile
12 // P7BBlob
13 // SSHPublicKeyFile
14 // PPKFile
15 // PPKBlob
16 // XMLFile
17 // XMLBlob
18 // JWKFile
19 // JWKBlob
20 // SecurityKey
21 // BCFKSFile
22 // BCFKSBlob
23 // PKCS11
99 // Auto
Default Value
0
Remarks
The type of certificate store for this certificate.
The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, create a new Certificate object and pass cstPKCS11 as the recipient_cert_store_type, the full path of the PKCS#11 DLL as the recipient_cert_store, and the PIN as the recipient_cert_store_password. Code Example. SSH Authentication with Security Key (without CertMgr):
Alternatively, collect the necessary data using the CertMgr struct by calling the list_store_certificates method after setting the corresponding properties accordingly. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the recipient_cert_store and set recipient_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr):
|
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
i32
recipient_cert_subject_alt_names property (JWT Struct)
Comma-separated lists of alternative subject names for the certificate.
Syntax
fn recipient_cert_subject_alt_names(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
recipient_cert_thumbprint_md5 property (JWT Struct)
The MD5 hash of the certificate.
Syntax
fn recipient_cert_thumbprint_md5(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
recipient_cert_thumbprint_sha1 property (JWT Struct)
The SHA-1 hash of the certificate.
Syntax
fn recipient_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
recipient_cert_thumbprint_sha256 property (JWT Struct)
The SHA-256 hash of the certificate.
Syntax
fn recipient_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
recipient_cert_usage property (JWT Struct)
The text description of UsageFlags .
Syntax
fn recipient_cert_usage(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The text description of recipient_cert_usage_flags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
recipient_cert_usage_flags property (JWT Struct)
The flags that show intended use for the certificate.
Syntax
fn recipient_cert_usage_flags(&self ) -> Result<i32, IPWorksAuthError>
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of recipient_cert_usage_flags is a combination of the following flags:
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |
Please see the recipient_cert_usage property for a text representation of recipient_cert_usage_flags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
i32
recipient_cert_version property (JWT Struct)
The certificate's version number.
Syntax
fn recipient_cert_version(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
recipient_cert_subject property (JWT Struct)
The subject of the certificate used for client authentication.
Syntax
fn recipient_cert_subject(&self ) -> Result<String, IPWorksAuthError>
fn set_recipient_cert_subject(&self, value : &str) -> Option<IPWorksAuthError> fn set_recipient_cert_subject_ref(&self, value : &String) -> Option<IPWorksAuthError>
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
recipient_cert_encoded property (JWT Struct)
The certificate (PEM/Base64 encoded).
Syntax
fn recipient_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksAuthError>
fn set_recipient_cert_encoded(&self, value : Vec<u8>) -> Option<IPWorksAuthError> fn set_recipient_cert_encoded_ref(&self, value : &[u8]) -> Option<IPWorksAuthError>
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The recipient_cert_store and recipient_cert_subject properties also may be used to specify a certificate.
When recipient_cert_encoded is set, a search is initiated in the current recipient_cert_store for the private key of the certificate. If the key is found, recipient_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, recipient_cert_subject is set to an empty string.
Data Type
Vec
signer_cert_effective_date property (JWT Struct)
The date on which this certificate becomes valid.
Syntax
fn signer_cert_effective_date(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
signer_cert_expiration_date property (JWT Struct)
The date on which the certificate expires.
Syntax
fn signer_cert_expiration_date(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
signer_cert_extended_key_usage property (JWT Struct)
A comma-delimited list of extended key usage identifiers.
Syntax
fn signer_cert_extended_key_usage(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
signer_cert_fingerprint property (JWT Struct)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
fn signer_cert_fingerprint(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
signer_cert_fingerprint_sha1 property (JWT Struct)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
fn signer_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
signer_cert_fingerprint_sha256 property (JWT Struct)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
fn signer_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
signer_cert_issuer property (JWT Struct)
The issuer of the certificate.
Syntax
fn signer_cert_issuer(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
signer_cert_private_key property (JWT Struct)
The private key of the certificate (if available).
Syntax
fn signer_cert_private_key(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
NOTE: The signer_cert_private_key may be available but not exportable. In this case, signer_cert_private_key returns an empty string.
This property is read-only.
Data Type
String
signer_cert_private_key_available property (JWT Struct)
Whether a PrivateKey is available for the selected certificate.
Syntax
fn signer_cert_private_key_available(&self ) -> Result<bool, IPWorksAuthError>
Default Value
false
Remarks
Whether a signer_cert_private_key is available for the selected certificate. If signer_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
bool
signer_cert_private_key_container property (JWT Struct)
The name of the PrivateKey container for the certificate (if available).
Syntax
fn signer_cert_private_key_container(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The name of the signer_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
signer_cert_public_key property (JWT Struct)
The public key of the certificate.
Syntax
fn signer_cert_public_key(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
signer_cert_public_key_algorithm property (JWT Struct)
The textual description of the certificate's public key algorithm.
Syntax
fn signer_cert_public_key_algorithm(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
signer_cert_public_key_length property (JWT Struct)
The length of the certificate's public key (in bits).
Syntax
fn signer_cert_public_key_length(&self ) -> Result<i32, IPWorksAuthError>
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
i32
signer_cert_serial_number property (JWT Struct)
The serial number of the certificate encoded as a string.
Syntax
fn signer_cert_serial_number(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
signer_cert_signature_algorithm property (JWT Struct)
The text description of the certificate's signature algorithm.
Syntax
fn signer_cert_signature_algorithm(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
signer_cert_store property (JWT Struct)
The name of the certificate store for the client certificate.
Syntax
fn signer_cert_store(&self ) -> Result<Vec<u8>, IPWorksAuthError>
fn set_signer_cert_store(&self, value : Vec<u8>) -> Option<IPWorksAuthError> fn set_signer_cert_store_ref(&self, value : &[u8]) -> Option<IPWorksAuthError>
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The signer_cert_store_type property denotes the type of the certificate store specified by signer_cert_store. If the store is password-protected, specify the password in signer_cert_store_password.
signer_cert_store is used in conjunction with the signer_cert_subject property to specify client certificates. If signer_cert_store has a value, and signer_cert_subject or signer_cert_encoded is set, a search for a certificate is initiated. Please see the signer_cert_subject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Vec
signer_cert_store_password property (JWT Struct)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
fn signer_cert_store_password(&self ) -> Result<String, IPWorksAuthError>
fn set_signer_cert_store_password(&self, value : &str) -> Option<IPWorksAuthError> fn set_signer_cert_store_password_ref(&self, value : &String) -> Option<IPWorksAuthError>
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
signer_cert_store_type property (JWT Struct)
The type of certificate store for this certificate.
Syntax
fn signer_cert_store_type(&self ) -> Result<i32, IPWorksAuthError>
fn set_signer_cert_store_type(&self, value : i32) -> Option<IPWorksAuthError>
Possible Values
0 // User
1 // Machine
2 // PFXFile
3 // PFXBlob
4 // JKSFile
5 // JKSBlob
6 // PEMKeyFile
7 // PEMKeyBlob
8 // PublicKeyFile
9 // PublicKeyBlob
10 // SSHPublicKeyBlob
11 // P7BFile
12 // P7BBlob
13 // SSHPublicKeyFile
14 // PPKFile
15 // PPKBlob
16 // XMLFile
17 // XMLBlob
18 // JWKFile
19 // JWKBlob
20 // SecurityKey
21 // BCFKSFile
22 // BCFKSBlob
23 // PKCS11
99 // Auto
Default Value
0
Remarks
The type of certificate store for this certificate.
The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, create a new Certificate object and pass cstPKCS11 as the signer_cert_store_type, the full path of the PKCS#11 DLL as the signer_cert_store, and the PIN as the signer_cert_store_password. Code Example. SSH Authentication with Security Key (without CertMgr):
Alternatively, collect the necessary data using the CertMgr struct by calling the list_store_certificates method after setting the corresponding properties accordingly. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the signer_cert_store and set signer_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr):
|
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
i32
signer_cert_subject_alt_names property (JWT Struct)
Comma-separated lists of alternative subject names for the certificate.
Syntax
fn signer_cert_subject_alt_names(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
signer_cert_thumbprint_md5 property (JWT Struct)
The MD5 hash of the certificate.
Syntax
fn signer_cert_thumbprint_md5(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
signer_cert_thumbprint_sha1 property (JWT Struct)
The SHA-1 hash of the certificate.
Syntax
fn signer_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
signer_cert_thumbprint_sha256 property (JWT Struct)
The SHA-256 hash of the certificate.
Syntax
fn signer_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
signer_cert_usage property (JWT Struct)
The text description of UsageFlags .
Syntax
fn signer_cert_usage(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The text description of signer_cert_usage_flags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
signer_cert_usage_flags property (JWT Struct)
The flags that show intended use for the certificate.
Syntax
fn signer_cert_usage_flags(&self ) -> Result<i32, IPWorksAuthError>
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of signer_cert_usage_flags is a combination of the following flags:
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |
Please see the signer_cert_usage property for a text representation of signer_cert_usage_flags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
i32
signer_cert_version property (JWT Struct)
The certificate's version number.
Syntax
fn signer_cert_version(&self ) -> Result<String, IPWorksAuthError>
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
signer_cert_subject property (JWT Struct)
The subject of the certificate used for client authentication.
Syntax
fn signer_cert_subject(&self ) -> Result<String, IPWorksAuthError>
fn set_signer_cert_subject(&self, value : &str) -> Option<IPWorksAuthError> fn set_signer_cert_subject_ref(&self, value : &String) -> Option<IPWorksAuthError>
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
signer_cert_encoded property (JWT Struct)
The certificate (PEM/Base64 encoded).
Syntax
fn signer_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksAuthError>
fn set_signer_cert_encoded(&self, value : Vec<u8>) -> Option<IPWorksAuthError> fn set_signer_cert_encoded_ref(&self, value : &[u8]) -> Option<IPWorksAuthError>
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The signer_cert_store and signer_cert_subject properties also may be used to specify a certificate.
When signer_cert_encoded is set, a search is initiated in the current signer_cert_store for the private key of the certificate. If the key is found, signer_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, signer_cert_subject is set to an empty string.
Data Type
Vec
signing_algorithm property (JWT Struct)
The algorithm used when signing.
Syntax
fn signing_algorithm(&self ) -> Result<i32, IPWorksAuthError>
fn set_signing_algorithm(&self, value : i32) -> Option<IPWorksAuthError>
Possible Values
0 // HS256
1 // HS384
2 // HS512
3 // RS256
4 // RS384
5 // RS512
6 // ES256
7 // ES384
8 // ES512
9 // PS256
10 // PS384
11 // PS512
12 // ES256K
99 // None
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 signer_cert must be set before calling verify. The following values are supported:
| Algorithm | Description | Private Key Location |
| 0 (saHS256 - default) | HMAC using SHA-256 | key |
| 1 (saHS384) | HMAC using SHA-384 | key |
| 2 (saHS512) | HMAC using SHA-512 | key |
| 3 (saRS256) | RSASSA-PKCS1-v1_5 using SHA-256 | certificate |
| 4 (saRS384) | RSASSA-PKCS1-v1_5 using SHA-384 | certificate |
| 5 (saRS512) | RSASSA-PKCS1-v1_5 using SHA-512 | certificate |
| 6 (saPS256) | RSASSA-PSS using SHA-256 and MGF1 with SHA-256 | certificate |
| 7 (saPS384) | RSASSA-PSS using SHA-384 and MGF1 with SHA-384 | certificate |
| 8 (saPS512) | RSASSA-PSS using SHA-512 and MGF1 with SHA-512 | certificate |
| 9 (saES256) | ECDSA using P-256 and SHA-256 | certificate |
| 10 (saES384) | ECDSA using P-384 and SHA-384 | certificate |
| 11 (saES512) | ECDSA using P-521 and SHA-512 | certificate |
| 12 (saES256K) | ECDSA using secp256k1 curve and SHA-256 | certificate |
| 99 (saNone) | None (unprotected) | Not Applicable |
Note: This setting is also applicable when StrictValidation is enabled before calling verify.
Data Type
i32
signing_key property (JWT Struct)
The key used for HMAC.
Syntax
fn signing_key(&self ) -> Result<Vec<u8>, IPWorksAuthError>
fn set_signing_key(&self, value : Vec<u8>) -> Option<IPWorksAuthError> fn set_signing_key_ref(&self, value : &[u8]) -> Option<IPWorksAuthError>
Default Value
""
Remarks
This property specifies the key used when signing with an HMAC algorithm.
Signing
This property is applicable when signing_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 it is first hashed with the same algorithm.
Data Type
Vec
add_claim method (JWT Struct)
Adds an new claim.
Syntax
fn add_claim(&self, name : &str, value : &str, data_type : i32) -> Result<(), IPWorksAuthError>
Remarks
This method adds a claim to the existing claims. Use this method to add claims that are not already supported directly via properties.
The Name parameter defines the name of the claim. The Value parameter is the value, represented as a string. The JSON data type of the value is defined by the DataType parameter. Possible DataType values are:
- 0 (Object)
- 1 (Array)
- 2 (String)
- 3 (Number)
- 4 (Bool)
- 5 (Null)
add_header_param method (JWT Struct)
Adds additional header parameters.
Syntax
fn add_header_param(&self, name : &str, value : &str, data_type : i32) -> Result<(), IPWorksAuthError>
Remarks
This method is used to add additional header parameters before calling encrypt or 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)
Signing
To add additional parameters to the JOSE header use this method. For instance to create this header:
{
"alg": "HS256",
"crit": [
"myheader"
],
"myheader": "testvalue"
}
The following code can be used:
byte[] key = new byte[] { 170, 171, 221, 209, 7, 181, 48, 178, 48, 118, 242, 132, 36, 218, 74, 140, 216, 165, 161, 70, 11, 42, 246, 205, 235, 231, 19, 48, 87, 141, 122, 10 };
//Sign the payload using HS256
Jwt jwt = new Jwt();
jwt.SigningAlgorithm = JwtSigningAlgorithms.saHS256;
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.AddHeaderParam("crit", "[\"myheader\"]", 1);
jwt.AddHeaderParam("myheader", "testvalue", 2);
jwt.KeyB = key;
jwt.Sign();
string signedData = jwt.EncodedJWT;
Note: when calling sign the struct will automatically add some headers based on properties that are set.
Parameters Automatically Set:
| Header Param | Property |
| alg | algorithm |
| kid | key_id |
Encrypting
To add additional parameters to the JOSE header use this method. For instance to create this header:
{
"alg": "A256GCMKW",
"enc": "A128CBC-HS256",
"iv": "cPTXlBL7aMiv-Dnf",
"tag": "r5tmS-tXmfFngrybpnnt5g",
"crit": [
"myheader"
],
"myheader": "testvalue"
}
The following code can be used:
byte[] key = new byte[] { 164, 60, 194, 0, 161, 189, 41, 38, 130, 89, 141, 164, 45, 170, 159, 209, 69, 137, 243, 216, 191, 131, 47, 250, 32, 107, 231, 117, 37, 158, 225, 234 };
Jwt jwt = new Jwt();
jwt.KeyB = key;
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.AddHeaderParam("crit", "[\"myheader\"]",1);
jwt.AddHeaderParam("myheader", "testvalue",2);
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaA256GCMKW;
jwt.Encrypt();
string encryptedData = jwt.EncodedJWT;
Note: When calling encrypt the struct will automatically add headers based on the selected encryption_algorithm and other properties that may be set.
Parameters Automatically Set:
| Header Param | Property |
| alg | encryption_algorithm |
| enc | content_encryption_algorithm |
| kid | key_id |
| zip | CompressionAlgorithm |
| p2c | PBES2Count (PBES Algorithms Only) |
| apu | PartyUInfo (ECDH Algorithms Only) |
| apv | PartyVInfo (ECDH Algorithms Only) |
| iv | N/A - Automatically Generated (AES Algorithms Only) |
| tag | N/A - Automatically Generated (AES Algorithms Only) |
| p2s | N/A - Automatically Generated (PBES Algorithms Only) |
| epk | N/A - Automatically Generated (ECDH Algorithms Only) |
config method (JWT Struct)
Sets or retrieves a configuration setting.
Syntax
fn config(&self, configuration_string : &str) -> Result<String, IPWorksAuthError>
Remarks
config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
decrypt method (JWT Struct)
Decrypts the encoded JWT.
Syntax
fn decrypt(&self) -> Result<(), IPWorksAuthError>
Remarks
This method decrypts the encoded JWT.
Before calling the decrypt method set encoded_jwt to a valid compact serialized JWT string. For instance:
eyJhbGciOiJBMjU2S1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2In0.4tcAnZJ00u4GY2kLOanPOL4CtvcfraZ8SIi6bOZ27qYBI2rHITPc1Q.c_9rCTdPn-saLCti2ZEyWQ.eLwqqo5BGNa70RlsvT-vTh7Gk0hjpJYY_9Zc39Vim_qEtjyMcxZygBpkfx9brzQr9rUbuiAhoCMXKip2-lKT6w.NkuLDPmWxWL4BaTWHWicIQ
The type and format of the private key depends on the algorithm used to encrypt the data. The following table summarizes the relationship:
| Algorithm | Private Key Location |
| AES | key |
| RSA and ECDH | certificate |
| PBES | key_password |
If this method returns without error decryption was successful. If decryption fails then this method fails with an error. After calling this method the payload will be present in the Claim* properties and the header_params property will contain the headers. Headers of the parsed message are also available through the on_header_param event.
The following properties are applicable when calling this method:
- certificate (conditional - required for RSA and ECDH)
- encoded_jwt
- key (conditional - required for AES)
- content_encryption_algorithm (only if StrictValidation is True)
- encryption_algorithm (only if StrictValidation is True)
- header_params
- StrictValidation
After calling this method the following properties are populated:
- claim_audience
- claim_exp
- claim_issued_at
- claim_issuer
- claim_jwt_id
- claim_not_before
- claim_subject
- header_params
Notes for AES Algorithms (A128KW, A192KW, A256KW, A128GCMKW, A192GCMKW, A256GCMKW)
To decrypt messages that use AES encryption key must be set to a key of appropriate length for the algorithm. For instance a 256 bit key would be used for A256KW.
The key must be known by both parties in order for encryption and decryption to take place.
byte[] key = new byte[] { 164, 60, 194, 0, 161, 189, 41, 38, 130, 89, 141, 164, 45, 170, 159, 209, 69, 137, 243, 216, 191, 131, 47, 250, 32, 107, 231, 117, 37, 158, 225, 234 };
Jwt jwt = new Jwt();
jwt.KeyB = key;
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();
string issuer = jwt.ClaimIssuer;
Notes for RSA Algorithms (RSA1_5, RSA-OEAP, RSA-OAEP-256)
The RSA based algorithms use asymmetric encryption. Encrypting is done with a public key and decryption is done with a private key. The certificate with private key must be specified. For instance:
Jwt jwt = new Jwt();
jwt.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "..\\jwt.pfx", "password", "*");
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();
string issuer = jwt.ClaimIssuer;
Notes for ECDH Algorithms (ECDH-ES, ECDH-ES+A128KW, ECDH-ES+A192KW, ECDH-ES+A256KW)
ECDH algorithms require a valid ECC private key to decrypt the message. If the key was originally created with the ECC struct the PEM encoded PrivateKey may be used directly with the certificate property.
Jwt jwt = new Jwt();
jwt.Certificate = new Certificate(CertStoreTypes.cstPEMKeyFile, privKeyFile, "", "*");
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();
string issuer = jwt.ClaimIssuer;
To use an ECC private key created by other means the ECC struct may be used to import the key parameters. Populate the Rx, Ry, and KB properties of the ECC component first to obtain the PEM formatted public key. For instance:
nsoftware.IPWorksEncrypt.Ecc ecc = new nsoftware.IPWorksEncrypt.Ecc();
byte[] x_bytes = new byte[] { 171, 170, 196, 151, 94, 196, 231, 12, 128, 232, 17, 61, 45, 105, 41, 209, 192, 187, 112, 242, 110, 178, 95, 240, 36, 55, 83, 171, 190, 176, 78, 13 };
byte[] y_bytes = new byte[] { 197, 75, 134, 245, 245, 28, 199, 9, 7, 117, 1, 54, 49, 178, 135, 252, 62, 89, 35, 180, 117, 80, 231, 23, 110, 250, 28, 124, 219, 253, 224, 156 };
byte[] k_bytes = new byte[] { 81, 65, 201, 24, 235, 249, 162, 148, 169, 150, 109, 181, 61, 238, 145, 122, 31, 30, 151, 94, 239, 90, 222, 217, 63, 103, 54, 2, 176, 232, 248, 168 };
ecc.Key.RxB = x_bytes;
ecc.Key.RyB = y_bytes;
ecc.Key.KB = k_bytes;
string privKey = ecc.Key.PrivateKey;
Jwt jwt = new Jwt();
jwt.Certificate = new Certificate(CertStoreTypes.cstPEMKeyBlob, privKey, "", "*");
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();
string issuer = jwt.ClaimIssuer;
Notes for PBES Algorithms (PBES2-HS256+A128KW, PBES2-HS384+A192KW, PBES2-HS512+A256KW
PBES algorithms derive a content encryption key from the key_password property. Set key_password to the shared secret.
Jwt jwt = new Jwt();
jwt.KeyPassword = "secret";
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();
string issuer = jwt.ClaimIssuer;
Notes for Direct Shared Keys
When Direct encryption is used the key property must be set to a valid symmetric key that will be used directly by the content_encryption_algorithm. For instance:
byte[] key = new byte[] { 164, 60, 194, 0, 161, 189, 41, 38, 130, 89, 141, 164, 45, 170, 159, 209, 69, 137, 243, 216, 191, 131, 47, 250, 32, 107, 231, 117, 37, 158, 225, 234 };
Jwt jwt = new Jwt();
jwt.KeyB = key;
jwt.EncodedJWT = encryptedData;
jwt.Decrypt();
string issuer = jwt.ClaimIssuer;
decrypt_and_verify method (JWT Struct)
Decrypts the encoded JWT, and verifies the signature.
Syntax
fn decrypt_and_verify(&self) -> Result<(), IPWorksAuthError>
Remarks
TBD.
encrypt method (JWT Struct)
Encrypts the claims with the specified algorithms.
Syntax
fn encrypt(&self) -> Result<(), IPWorksAuthError>
Remarks
This method encrypts the claims using the specified algorithms.
To create an encrypted JWT JSON Web Encryption (JWE) is performed by first generating a random key used to encrypt the content. The content encryption key is used to encrypt the content using the algorithm specified by content_encryption_algorithm. The content encryption key is then encrypted itself using the algorithm specified by encryption_algorithm. The content encryption key is not directly exposed in the API as it is randomly generated.
After calling this method the compact serialized JWT is written to encoded_jwt. For instance:
eyJhbGciOiJBMjU2S1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2In0.4tcAnZJ00u4GY2kLOanPOL4CtvcfraZ8SIi6bOZ27qYBI2rHITPc1Q.c_9rCTdPn-saLCti2ZEyWQ.eLwqqo5BGNa70RlsvT-vTh7Gk0hjpJYY_9Zc39Vim_qEtjyMcxZygBpkfx9brzQr9rUbuiAhoCMXKip2-lKT6w.NkuLDPmWxWL4BaTWHWicIQ
The struct will use the values present in the Claim* properties to build the encoded JWT. After calling this method the encoded_jwt property will hold the compact serialized JWT. The following properties are applicable when calling this method:
- encryption_algorithm (required)
- key (conditional - required for AES)
- key_password (conditional - required for PBES)
- recipient_cert (conditional - required for ECDH and RSA)
- claim_audience
- claim_exp
- claim_issued_at
- claim_issuer
- claim_jwt_id
- claim_not_before
- CompressionAlgorithm
- content_encryption_algorithm
- header_params
- key_id
Notes for AES Algorithms (A128KW, A192KW, A256KW, A128GCMKW, A192GCMKW, A256GCMKW)
When encryption_algorithm is set to a AES algorithm key must be set to a key of appropriate length for the algorithm. For instance a 256 bit key would be used for A256KW.
To use an existing AES key provide the bytes to the key property. For instance:
byte[] key = new byte[] { 164, 60, 194, 0, 161, 189, 41, 38, 130, 89, 141, 164, 45, 170, 159, 209, 69, 137, 243, 216, 191, 131, 47, 250, 32, 107, 231, 117, 37, 158, 225, 234 };
//Encrypt the payload using A256KW
Jwt jwt = new Jwt();
jwt.KeyB = key;
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaA256KW;
jwt.Encrypt();
string encryptedData = jwt.EncodedJWT;
Notes for RSA Algorithms (RSA1_5, RSA-OEAP, RSA-OAEP-256)
The RSA based algorithms use asymmetric encryption. Encrypting is done with a public key and decryption is done with a private key. The public certificate should be in PEM (base64) format. For instance:
Jwt jwt = new Jwt();
jwt.Certificate = new Certificate("..\\recipient.cer");
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaRSA_OAEP;
jwt.Encrypt();
string encryptedData = jwt.EncodedJWT;
Notes for ECDH Algorithms (ECDH-ES, ECDH-ES+A128KW, ECDH-ES+A192KW, ECDH-ES+A256KW)
ECDH algorithms require a valid ECC public key to encrypt the message. If the key was originally created with the ECC struct the PEM encoded PublicKey may be used directly with the certificate property. An example PEM encoded public certificate created by the ECC component:
-----BEGIN PUBLIC KEY----- MIIBMjCB7AYHKoZIzj0CATCB4AIBATAsBgcqhkjOPQEBAiEA/////wAAAAEAAAAAAAAAAAAA AAD///////////////8wRAQg/////wAAAAEAAAAAAAAAAAAAAAD///////////////wEIFrG NdiqOpPns+u9VXaYhrxlHQawzFOw9jvOPD4n0mBLBEEEaxfR8uEsQkf4vOblY6RA8ncDfYEt 6zOg9KE5RdiYwpZP40Li/hp/m47n60p8D54WK84zV2sxXs7LtkBoN79R9QIhAP////8AAAAA //////////+85vqtpxeehPO5ysL8YyVRAgEBA0EEIC5rbLp11Mnz6cBXLLriaDIov3rm8RAY x/OR0bOKiff0cQy+sLVaxjseqFk/+Xvl4ORSv5Z6HdHv5GyEpA0UoA== -----END PUBLIC KEY-----
Jwt jwt = new Jwt();
jwt.Certificate = new Certificate(CertStoreTypes.cstPublicKeyFile, pubKeyFile, "", "*");
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaECDH_ES_A256KW;
jwt.Encrypt();
string encryptedData = jwt.EncodedJWT;
To use an ECC public key created by other means the ECC struct may be used to import the key parameters. Populate the Rx and Ry properties of the ECC component first to obtain the PEM formatted public key. For instance:
byte[] x_bytes = new byte[] { 171, 170, 196, 151, 94, 196, 231, 12, 128, 232, 17, 61, 45, 105, 41, 209, 192, 187, 112, 242, 110, 178, 95, 240, 36, 55, 83, 171, 190, 176, 78, 13 };
byte[] y_bytes = new byte[] { 197, 75, 134, 245, 245, 28, 199, 9, 7, 117, 1, 54, 49, 178, 135, 252, 62, 89, 35, 180, 117, 80, 231, 23, 110, 250, 28, 124, 219, 253, 224, 156 };
nsoftware.IPWorksEncrypt.Ecc ecc = new nsoftware.IPWorksEncrypt.Ecc();
ecc.Key.RxB = x_bytes;
ecc.Key.RyB = y_bytes;
string pubKey = ecc.Key.PublicKey;
Jwt jwt = new Jwt();
jwt.Certificate = new Certificate(CertStoreTypes.cstPublicKeyFile, pubKey, "", "*");
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaECDH_ES_A256KW;
jwt.Encrypt();
string encryptedData = jwt.EncodedJWT;
Notes for PBES Algorithms (PBES2-HS256+A128KW, PBES2-HS384+A192KW, PBES2-HS512+A256KW
PBES algorithms derive a content encryption key from the key_password property. Set key_password to a shared secret.
Jwt jwt = new Jwt();
jwt.KeyPassword = "secret";
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaPBES2_HS512_A256KW;
jwt.Encrypt();
string encryptedData = jwt.EncodedJWT;
Notes for Direct Shared Keys
When encryption_algorithm is set to Direct the key property must be set to a valid symmetric key that will be used directly by the content_encryption_algorithm. In this case a content encryption key is not generated randomly, the key is used instead. The length of the specified key must be valid for the selected content_encryption_algorithm. For instance:
byte[] key = new byte[] { 164, 62, 191, 60, 161, 189, 41, 38, 130, 89, 141, 164, 45, 170, 159, 209, 69, 137, 243, 216, 191, 131, 47, 250, 32, 107, 231, 117, 37, 158, 225, 234 };
Jwt jwt = new Jwt();
jwt.EncryptionAlgorithm = JwtEncryptionAlgorithms.eaDir;
jwt.ContentEncryptionAlgorithm = JwtContentEncryptionAlgorithms.ceaA256GCM;
jwt.KeyB = key;
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.Encrypt();
string encryptedData = jwt.EncodedJWT;
parse method (JWT Struct)
Parses the encoded JWT.
Syntax
fn parse(&self) -> Result<(), IPWorksAuthError>
Remarks
This method parses, but does not verify the encoded JWT.
Take care when using this method as no verification or decryption is performed. This method may be helpful in cases where only header information is desired.
If verification or decryption is desired, use verify or decrypt instead. It is not necessary to call this method before calling verify or decrypt. verify or decrypt will both parse and decrypt the message.
When calling this method the headers are parsed. The on_header_param and on_recipient_info events will fire and the header_params property will be populated.
If the message is signed (not encrypted) the claims will also be parsed and the Claim* properties will be populated.
reset method (JWT Struct)
Resets the struct properties.
Syntax
fn reset(&self) -> Result<(), IPWorksAuthError>
Remarks
This method resets all message and key properties to their default values.
sign method (JWT Struct)
Signs the payload with the specified algorithm.
Syntax
fn sign(&self) -> Result<(), IPWorksAuthError>
Remarks
This method signs the claims specified by the Claim* properties with the specified signing_algorithm.
Before calling the sign method set signing_algorithm to the algorithm which will be used to sign the message. The result of signing is a compact serialized JWT string. For instance:
eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOlsiYXVkaWVuY2UiXSwiaXNzIjoiaXNzdWVyIn0.mlFETSma4WUcUSjNSUWA1n9QBcQHCkHN-y4zeBsCVqI
The struct will use the values present in the Claim* properties to build the encoded JWT. After calling this method the encoded_jwt property will hold the compact serialized JWT. The following properties are applicable when calling this method:
- signing_algorithm (required)
- certificate (conditional - required for ECDSA and RSA)
- key (conditional - required for HMAC)
- claim_audience
- claim_exp
- claim_issued_at
- claim_issuer
- claim_jwt_id
- claim_not_before
- header_params
- key_id
Notes for HMAC Algorithms (HS256, HS384, HS512)
When signing_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 key must be known by both parties in order for signing and verification to take place. To use an existing HMAC key provide the bytes to the key 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
Jwt jwt = new Jwt();
jwt.SigningAlgorithm = JwtSigningAlgorithms.saHS256;
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.KeyB = key;
jwt.Sign();
string signedData = jwt.EncodedJWT;
Notes for RSA Algorithms (RS256, RS384, RS512, PS256, PS384, PS512)
The RSA based algorithms use asymmetric encryption. Signing is done with a private key and verification is done with a public key. The private key may be in PFX or PEM format.
Jwt jwt = new Jwt();
jwt.SigningAlgorithm = JwtSigningAlgorithms.saRS256;
jwt.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "..\\jwt.pfx", "test", "*");
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.Sign();
string signedMessage = jwt.EncodedJWT;
Notes for ECDSA Algorithms (ES256, ES384, ES512)
ECDSA algorithms require a valid ECC private key in order to sign data. The certificate property should be set to a certificate with an ECC key. The CertMgr struct can be used to create a certificate with an ECC key.
//Create an ECC key with SHA-256
Certmgr mgr = new Certmgr();
mgr.Config("CertPublicKeyAlgorithm=ECDSA_P256");
mgr.CertStoreType = CertStoreTypes.cstPEMKeyFile;
mgr.CertStore = "C:\\temp\\ecdsa.pem";
mgr.CreateCertificate("CN=ecdsa", 123);
//Sign the payload using ES256
Jwt jwt = new Jwt();
jwt.SigningAlgorithm = JwtSigningAlgorithms.saES256;
jwt.Certificate = new Certificate(CertStoreTypes.cstPEMKeyFile, "C:\\temp\\ecdsa.pem", "", "*");
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.Sign();
string signedMessage = jwt.EncodedJWT;
Notes for Unsecured (none)
To create a JWS token without any security set signing_algorithm to jwtNone.
Jwt jwt = new Jwt();
jwt.SigningAlgorithm = JwtSigningAlgorithms.saNone;
jwt.ClaimAudience = "audience";
jwt.ClaimIssuer = "issuer";
jwt.ClaimExp = "1498508071";
jwt.Sign();
string unsecuredMessage = jwt.EncodedJWT;
sign_and_encrypt method (JWT Struct)
Signs the payload with the specified algorithm, and encrypts the result of signing.
Syntax
fn sign_and_encrypt(&self) -> Result<(), IPWorksAuthError>
Remarks
TBD.
verify method (JWT Struct)
Verifies the signature of the encoded JWT.
Syntax
fn verify(&self) -> Result<(), IPWorksAuthError>
Remarks
This method verifies the signature of the encoded JWT.
Before calling the verify method set encoded_jwt to a valid compact serialized JWT. For instance:
eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOlsiYXVkaWVuY2UiXSwiaXNzIjoiaXNzdWVyIn0.mlFETSma4WUcUSjNSUWA1n9QBcQHCkHN-y4zeBsCVqI
The key or signer_cert properties should be set to the HMAC key or public certificate respectively. If the correct key or signer_cert is not known ahead of time the KeyId parameter of the on_signer_info event may be used to identify the correct key.
If this method returns without error verification was successful. If verification fails then this method fails with an error. After calling this method the claims will be parsed and the Claim* properties will be populated. The the header_params property will contain the headers. Headers of the parsed message are also available through the on_header_param event.
The following properties are applicable when calling this method:
- encoded_jwt (required)
- key (conditional - required for HMAC)
- signer_cert (conditional - required for ECDSA and RSA)
- signing_algorithm (only if StrictValidation is True)
- StrictValidation
- ExpectedAudience (optional)
- ExpectedExp (optional)
- ExpectedIssuedAt (optional)
- ExpectedIssuer (optional)
- ExpectedJWTId (optional)
- ExpectedNotBefore (optional)
- ExpectedSubject (optional)
After calling this method the following properties are populated:
- claim_audience
- claim_exp
- claim_issued_at
- claim_issuer
- claim_jwt_id
- claim_not_before
- claim_subject
- header_params
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 };
Jwt jwt = new Jwt();
jwt.KeyB = key;
jwt.EncodedJWT = signedData;
jwt.Verify();
string issuer = jwt.ClaimIssuer;
Notes for RSA Algorithms (RS256, RS384, RS512, PS256, PS384, PS512)
The RSA based algorithms use asymmetric encryption. Signing is done with a private key and verification is done with a public key. The public key is typically in PEM format.
Jwt jwt = new Jwt();
jwt.SignerCert = new Certificate("..\\jwt.cer");
jwt.EncodedJWT = signedData;
jwt.Verify();
string issuer = jwt.ClaimIssuer;
Notes for ECDSA Algorithms (ES256, ES384, ES512)
ECDSA algorithms require a valid ECC public key to verify the message. The PEM encoded public key may be used directly with the certificate property. An example PEM encoded public certificate created by the CertMgr struct:
-----BEGIN CERTIFICATE----- MIIBETCBtaADAgECAgF7MAwGCCqGSM49BAMCBQAwEDEOMAwGA1UEAxMFZWNkc2EwHhcNMjMw NzAzMTcwMjU3WhcNMjQwNzAyMTcwMjU3WjAQMQ4wDAYDVQQDEwVlY2RzYTBZMBMGByqGSM49 AgEGCCqGSM49AwEHA0IABGJv251JI7ITcq+fac9Z2yYkhTLSRhWGzBw1wEJZbs/8AZbVmvcy 4BzKSZEaTfBsCHIt3FLNgRLdugI+B65eQDYwDAYIKoZIzj0EAwIFAANJADBGAiEAzmH5LKKn r4iy9kJvIlCslpcBHM/8k0XQaj13Zwhm2ocCIQD/cSiC4EuqRkxT4IKET7ko3iI5YUS+J5W5 /0xnxxxIpQ== -----END CERTIFICATE-----
Jwt jwt = new Jwt();
jwt.SignerCert = new Certificate(CertStoreTypes.cstPublicKeyBlob, pubKey, "", "*");
jwt.EncodedJWT = signedData;
jwt.Verify();
string issuer = jwt.ClaimIssuer;
Notes for Unsecured (none)
To parse a JWS token without any security call the sign method without setting the key or certificate properties.
Jwt jwt = new Jwt();
jwt.EncodedJWT = signedData;
jwt.Verify();
string issuer = jwt.ClaimIssuer;
on_claim_info event (JWT Struct)
Fires once for each claim.
Syntax
// JWTClaimInfoEventArgs carries the JWT ClaimInfo event's parameters.
pub struct JWTClaimInfoEventArgs {
fn name(&self) -> &String
fn value(&self) -> &String
fn data_type(&self) -> i32
}
// JWTClaimInfoEvent defines the signature of the JWT ClaimInfo event's handler function.
pub trait JWTClaimInfoEvent {
fn on_claim_info(&self, sender : JWT, e : &mut JWTClaimInfoEventArgs);
}
impl <'a> JWT<'a> {
pub fn on_claim_info(&self) -> &'a dyn JWTClaimInfoEvent;
pub fn set_on_claim_info(&mut self, value : &'a dyn JWTClaimInfoEvent);
...
}
Remarks
When decrypt, verify or parse is called this event will fire once for each claim in the JWT.
Name is the name of the claim.
Value is the value of the claim.
DataType specifies the JSON data type of the value. Possible values are:
- 0 (Object)
- 1 (Array)
- 2 (String)
- 3 (Number)
- 4 (Bool)
- 5 (Null)
on_error event (JWT Struct)
Fired when information is available about errors during data delivery.
Syntax
// JWTErrorEventArgs carries the JWT Error event's parameters.
pub struct JWTErrorEventArgs {
fn error_code(&self) -> i32
fn description(&self) -> &String
}
// JWTErrorEvent defines the signature of the JWT Error event's handler function.
pub trait JWTErrorEvent {
fn on_error(&self, sender : JWT, e : &mut JWTErrorEventArgs);
}
impl <'a> JWT<'a> {
pub fn on_error(&self) -> &'a dyn JWTErrorEvent;
pub fn set_on_error(&mut self, value : &'a dyn JWTErrorEvent);
...
}
Remarks
The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.
The error_code parameter contains an error code, and the description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
on_header_param event (JWT Struct)
Fires once for each JOSE header parameter.
Syntax
// JWTHeaderParamEventArgs carries the JWT HeaderParam event's parameters.
pub struct JWTHeaderParamEventArgs {
fn name(&self) -> &String
fn value(&self) -> &String
fn data_type(&self) -> i32
}
// JWTHeaderParamEvent defines the signature of the JWT HeaderParam event's handler function.
pub trait JWTHeaderParamEvent {
fn on_header_param(&self, sender : JWT, e : &mut JWTHeaderParamEventArgs);
}
impl <'a> JWT<'a> {
pub fn on_header_param(&self) -> &'a dyn JWTHeaderParamEvent;
pub fn set_on_header_param(&mut self, value : &'a dyn JWTHeaderParamEvent);
...
}
Remarks
When decrypt, verify or parse is called this event will fire once for each JOSE header parameter.
Name is the name of the parameter.
Value is the value of the parameter.
DataType specifies the JSON data type of the value. Possible values are:
- 0 (Object)
- 1 (Array)
- 2 (String)
- 3 (Number)
- 4 (Bool)
- 5 (Null)
on_recipient_info event (JWT Struct)
Fired with information about the recipient key of the encrypted message.
Syntax
// JWTRecipientInfoEventArgs carries the JWT RecipientInfo event's parameters.
pub struct JWTRecipientInfoEventArgs {
fn key_id(&self) -> &String
fn algorithm(&self) -> &String
}
// JWTRecipientInfoEvent defines the signature of the JWT RecipientInfo event's handler function.
pub trait JWTRecipientInfoEvent {
fn on_recipient_info(&self, sender : JWT, e : &mut JWTRecipientInfoEventArgs);
}
impl <'a> JWT<'a> {
pub fn on_recipient_info(&self) -> &'a dyn JWTRecipientInfoEvent;
pub fn set_on_recipient_info(&mut self, value : &'a dyn JWTRecipientInfoEvent);
...
}
Remarks
This event fires with information about the key used to encrypt the data. This may be used to help identify the key or certificate properties to load in order to decrypt the message. This event fires when decrypt or parse is called.
KeyId is the Id of the key as supplied by the entity that created the message. This may be empty.
Algorithm is the encryption algorithm used to encrypt the data.
on_signer_info event (JWT Struct)
Fires with information about the signature.
Syntax
// JWTSignerInfoEventArgs carries the JWT SignerInfo event's parameters.
pub struct JWTSignerInfoEventArgs {
fn key_id(&self) -> &String
fn algorithm(&self) -> &String
}
// JWTSignerInfoEvent defines the signature of the JWT SignerInfo event's handler function.
pub trait JWTSignerInfoEvent {
fn on_signer_info(&self, sender : JWT, e : &mut JWTSignerInfoEventArgs);
}
impl <'a> JWT<'a> {
pub fn on_signer_info(&self) -> &'a dyn JWTSignerInfoEvent;
pub fn set_on_signer_info(&mut self, value : &'a dyn JWTSignerInfoEvent);
...
}
Remarks
This event fires with information about the signature. This may be used to help identify the key or certificate properties 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.
Config Settings (JWT Struct)
The struct accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.JWT Config Settings
- HS256
- HS384
- HS512
- RS256
- RS384
- RS512
- ES256
- ES384
- ES512
- PS256
- PS384
- PS512
Example value: HS512,HS256.
When setting claim_audience that contains multiple audiences specify multiple value separated by the character set here. For instance:
jwt.ClaimAudience = "aud1;aud2";
- 0 (none - default)
- 1 (deflate)
Multiple formats may be included in the signed message. The value specified should be the binary 'OR' of one or more of the following values:
| Value | Description | JWS Header Param |
| 0 (0x00 - default) | None | |
| 1 (0x01) | X.509 Certificate Chain | x5c |
| 2 (0x02) | X.509 Certificate SHA-1 Thumbprint (Base64-URL encoded) | x5t |
| 4 (0x04) | X.509 Certificate SHA-256 Thumbprint (Base64-URL encoded) | x5t#S256 |
Note: When including the certificate chain (0x01) the public certificate of certificate property will automatically be included. IssuerCerts may also be set to the public issuer certificates that will be used when building the chain to include.
For instance, to include both the certificate chain and SHA-256 thumbprint of the certificate set this to 5.
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-----
- 0 (none - default)
- 1 (Base64)
- 2 (Hex)
- 3 (Base64URL)
jwe.Config("PartyUInfo=Alice");
jwe.Config("PartyUInfo=[b64]QWxpY2U="); //Equivalent to above line
jwe.Config("PartyUInfo=Bob");
jwe.Config("PartyUInfo=[b64]Qm9i"); //Equivalent to above line
This setting is only applicable when encryption_algorithm is set to a PBES algorithm.
This setting is only applicable when encryption_algorithm is set to a PBES algorithm.
{"alg":"ES384","kid":"myKeyId"}
By default this is False and the algorithms are read automatically from the encoded JWT.
Base Config Settings
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 |
- 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.
Setting this configuration setting to true tells the struct to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (JWT Struct)
JWT Errors
| 301 | EncodedJWT is not set. The input is not valid. |
| 302 | Failed to parse claims. See error message for details. |
| 303 | Claim is not within its validity period. |
| 304 | Failed to verify an expected claim value. See error message for details. |
JWS Errors
| 201 | Invalid JWS value. Not recognized as a compact serialized JWS string. |
| 202 | Signature verification failed. |
| 203 | Key must be specified before attempting this operation. |
| 204 | The specified key is too short for the selected algorithm. |
| 205 | Certificate must be specified before attempting this operation. |
| 206 | Unsupported algorithm. |
| 207 | OutputFile already exists and Overwrite is False. |
| 208 | Error writing data. See error message for details. |
JWE Errors
| 101 | Invalid JWE message. See message for details. |
| 102 | Unsupported compression algorithm. |
| 103 | Unsupported content encryption algorithm. |
| 104 | Unsupported key encryption algorithm. |
| 105 | A required header for decryption was not found. See message for details. |
| 106 | The specified key is not a valid length for the algorithm. |
| 107 | OutputFile already exists and Overwrite is False. |
| 108 | KeyPassword must be set for the selected algorithm. |
| 109 | Key must be set for the selected algorithm. |
| 110 | Certificate must be set for the selected algorithm. |
| 111 | A header parameter defined to be critical is not present. |
| 112 | Error writing data. |
| 113 | Error reading data. Check message for details. |
| 114 | Error encrypting. Check message for details. |
| 115 | Error decrypting. Check message for details. |