JWT Class

Properties Methods Events Config Settings Errors

Create, Sign, Encrypt, Verify and Decrypt JSON Web Tokens (JWTs).

Syntax

class ipworksauth.JWT

Remarks

The JWT class 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 class 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)
Cert* (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
HeaderParam*
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 Cert* properties should be set to a certificate with an ECC key. The CertMgr class 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 SignerCert* properties should be set to the HMAC key or public certificate respectively. If the correct key or SignerCert* 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* properties 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)
SignerCert* (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*

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 Cert* properties. An example PEM encoded public certificate created by the CertMgr class:

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

encryption_algorithm (required)
key (conditional - required for AES)
key_password (conditional - required for PBES)
RecipientCert* (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
HeaderParam*
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 class the PEM encoded PublicKey may be used directly with the Cert* properties. An example PEM encoded public certificate created by the ECC component:

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

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	Cert*
PBES	key_password

If the correct key or Cert* is not known ahead of time the KeyId parameter of the on_recipient_info event may be used to identify the correct key.

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* properties 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:

Cert* (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*
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*

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 class the PEM encoded PrivateKey may be used directly with the Cert* properties.

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

Other Functionality

In addition to standard operations the class also supports a variety of other features including:

Adding custom header parameters with add_header_param
Enforcing algorithm restrictions when verifying by setting StrictValidation
Inspect the JWT without verifying or decrypting by calling parse

Property List

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


cert_encoded	This is the certificate (PEM/base64 encoded).
cert_store	This is 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	This is the type of certificate store for this certificate.
cert_subject	This is the subject of the certificate used for client authentication.
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 HMAC and 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_encoded	This is the certificate (PEM/base64 encoded).
recipient_cert_store	This is 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	This is the type of certificate store for this certificate.
recipient_cert_subject	This is the subject of the certificate used for client authentication.
signer_cert_encoded	This is the certificate (PEM/base64 encoded).
signer_cert_store	This is 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	This is the type of certificate store for this certificate.
signer_cert_subject	This is the subject of the certificate used for client authentication.
signing_algorithm	The algorithm used when signing.

Method List

The following is the full list of the methods of the class 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.
encrypt	Encrypts the claims with the specified algorithms.
parse	Parses the encoded JWT.
reset	Resets the class properties.
sign	Signs the payload with the specified algorithm.
verify	Verifies the signature of the encoded JWT.

Event List

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


on_claim_info	Fires once for each claim.
on_error	Information 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 class 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 indentifying 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.
MaskSensitive	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseFIPSCompliantAPI	Tells the class whether or not to use FIPS certified APIs.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.

cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

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

cert_encoded = property(get_cert_encoded, set_cert_encoded)

Default Value

Remarks

This is 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.

cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

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

cert_store = property(get_cert_store, set_cert_store)

Default Value

"MY"

Remarks

This is 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 are designations of the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

cert_store_password Property

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

Syntax

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

cert_store_password = property(get_cert_store_password, set_cert_store_password)

Default Value

Remarks

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

cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

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

cert_store_type = property(get_cert_store_type, set_cert_store_type)

Default Value

Remarks

This is the type of certificate store for this certificate.

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


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS7 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 PKCS11 interface. To use a security key the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to `cstPKCS11`, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 dll. The certificate information returned in the on_cert_list event's `CertEncoded` parameter may be saved for later use. When using a certificate, 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 `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
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.

cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

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

cert_subject = property(get_cert_subject, set_cert_subject)

Default Value

Remarks

This is the subject of the certificate used for client authentication.

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

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

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.


Field	Meaning
CN	Common Name. This is commonly a host name 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.

claim_audience Property

The audience claim.

Syntax

def get_claim_audience() -> str: ...
def set_claim_audience(value: str) -> None: ...

claim_audience = property(get_claim_audience, set_claim_audience)

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.

claim_exp Property

The expiration time claim.

Syntax

def get_claim_exp() -> str: ...
def set_claim_exp(value: str) -> None: ...

claim_exp = property(get_claim_exp, set_claim_exp)

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.

claim_issued_at Property

The claim indicating the time at which the JWT was issued.

Syntax

def get_claim_issued_at() -> str: ...
def set_claim_issued_at(value: str) -> None: ...

claim_issued_at = property(get_claim_issued_at, set_claim_issued_at)

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.

claim_issuer Property

The issuer of the JWT.

Syntax

def get_claim_issuer() -> str: ...
def set_claim_issuer(value: str) -> None: ...

claim_issuer = property(get_claim_issuer, set_claim_issuer)

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.

claim_jwt_id Property

The unique identifier for the JWT.

Syntax

def get_claim_jwt_id() -> str: ...
def set_claim_jwt_id(value: str) -> None: ...

claim_jwt_id = property(get_claim_jwt_id, set_claim_jwt_id)

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.

claim_not_before Property

The claim identifying the time before which the JWT is invalid.

Syntax

def get_claim_not_before() -> str: ...
def set_claim_not_before(value: str) -> None: ...

claim_not_before = property(get_claim_not_before, set_claim_not_before)

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.

jwt_claim_count Property

The number of records in the JWTClaim arrays.

Syntax

def get_jwt_claim_count() -> int: ...
def set_jwt_claim_count(value: int) -> None: ...

jwt_claim_count = property(get_jwt_claim_count, set_jwt_claim_count)

Default Value

Remarks

This property controls the size of the following arrays:

jwt_claim_data_type
jwt_claim_name
jwt_claim_value

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

jwt_claim_data_type Property

The data type of the claim value.

Syntax

def get_jwt_claim_data_type(jwt_claim_index: int) -> int: ...
def set_jwt_claim_data_type(jwt_claim_index: int, value: int) -> None: ...

Default Value

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

jwt_claim_name Property

The claim name.

Syntax

def get_jwt_claim_name(jwt_claim_index: int) -> str: ...
def set_jwt_claim_name(jwt_claim_index: int, value: str) -> None: ...

Default Value

Remarks

The claim name.

The jwt_claim_index parameter specifies the index of the item in the array. The size of the array is controlled by the jwt_claim_count property.

jwt_claim_value Property

The claim value.

Syntax

def get_jwt_claim_value(jwt_claim_index: int) -> str: ...
def set_jwt_claim_value(jwt_claim_index: int, value: str) -> None: ...

Default Value

Remarks

The claim value.

The jwt_claim_index parameter specifies the index of the item in the array. The size of the array is controlled by the jwt_claim_count property.

claim_subject Property

The subject identifies the principal of the JWT.

Syntax

def get_claim_subject() -> str: ...
def set_claim_subject(value: str) -> None: ...

claim_subject = property(get_claim_subject, set_claim_subject)

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.

content_encryption_algorithm Property

The algorithm used to encrypt the content.

Syntax

def get_content_encryption_algorithm() -> int: ...
def set_content_encryption_algorithm(value: int) -> None: ...

content_encryption_algorithm = property(get_content_encryption_algorithm, set_content_encryption_algorithm)

Default Value

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

encoded_jwt Property

The encoded JWT.

Syntax

def get_encoded_jwt() -> str: ...
def set_encoded_jwt(value: str) -> None: ...

encoded_jwt = property(get_encoded_jwt, set_encoded_jwt)

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.

encryption_algorithm Property

The key encryption algorithm.

Syntax

def get_encryption_algorithm() -> int: ...
def set_encryption_algorithm(value: int) -> None: ...

encryption_algorithm = property(get_encryption_algorithm, set_encryption_algorithm)

Default Value

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 RecipientCert* properties 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	RecipientCert*
1 (eaRSA_OAEP)	RSAES OAEP using default parameters	RecipientCert*
2 (eaRSA_OAEP_256)	RSAES OAEP using SHA-256 and MGF1 with SHA-256	RecipientCert*
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	RecipientCert*
8 (eaECDH_ES_A128KW)	ECDH-ES using Concat KDF and CEK wrapped with A128KW	RecipientCert*
9 (eaECDH_ES_A192KW)	ECDH-ES using Concat KDF and CEK wrapped with A192KW	RecipientCert*
10 (eaECDH_ES_A256KW)	ECDH-ES using Concat KDF and CEK wrapped with A256KW	RecipientCert*
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:

PartyUInfo
PartyVInfo

When set to a PBES algorithm the following settings are also applicable:

PBES2Count
PBES2SaltLength

header_param_count Property

The number of records in the HeaderParam arrays.

Syntax

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

header_param_count = property(get_header_param_count, set_header_param_count)

Default Value

Remarks

This property controls the size of the following arrays:

header_param_data_type
header_param_name
header_param_value

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

header_param_data_type Property

The data type of the header parameter.

Syntax

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

Default Value

Remarks

The data type of the header parameter.

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

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

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

header_param_name Property

The header parameter name.

Syntax

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

Default Value

Remarks

The header parameter name.

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

header_param_value Property

The header parameter value.

Syntax

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

Default Value

Remarks

The header parameter value.

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

key Property

The key used for HMAC and AES.

Syntax

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

key = property(get_key, set_key)

Default Value

Remarks

This property specifies the key used when signing with an HMAC algorithm or encrypting with an AES 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 is it first hashed with the same 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.

key_id Property

The Id of the key used to sign or encrypt the message.

Syntax

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

key_id = property(get_key_id, set_key_id)

Default Value

Remarks

This property optionally specifies the Id of the key used to sign the message.

Any string value may be supplied here to help the other party identify the key used to sign or encrypt the message. This may be set before calling the sign or encrypt method.

key_password Property

The key password used in the PBES algorithm.

Syntax

def get_key_password() -> str: ...
def set_key_password(value: str) -> None: ...

key_password = property(get_key_password, set_key_password)

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.

recipient_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_recipient_cert_encoded() -> bytes: ...
def set_recipient_cert_encoded(value: bytes) -> None: ...

recipient_cert_encoded = property(get_recipient_cert_encoded, set_recipient_cert_encoded)

Default Value

Remarks

This is 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.

recipient_cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_recipient_cert_store() -> bytes: ...
def set_recipient_cert_store(value: bytes) -> None: ...

recipient_cert_store = property(get_recipient_cert_store, set_recipient_cert_store)

Default Value

"MY"

Remarks

This is 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 are designations of 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.

recipient_cert_store_password Property

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

Syntax

def get_recipient_cert_store_password() -> str: ...
def set_recipient_cert_store_password(value: str) -> None: ...

recipient_cert_store_password = property(get_recipient_cert_store_password, set_recipient_cert_store_password)

Default Value

Remarks

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

recipient_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_recipient_cert_store_type() -> int: ...
def set_recipient_cert_store_type(value: int) -> None: ...

recipient_cert_store_type = property(get_recipient_cert_store_type, set_recipient_cert_store_type)

Default Value

Remarks

This is the type of certificate store for this certificate.


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 (PKCS12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS7 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 PKCS11 interface. To use a security key the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to `cstPKCS11`, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 dll. The certificate information returned in the on_cert_list event's `CertEncoded` parameter may be saved for later use. When using a certificate, 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 `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
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.

recipient_cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_recipient_cert_subject() -> str: ...
def set_recipient_cert_subject(value: str) -> None: ...

recipient_cert_subject = property(get_recipient_cert_subject, set_recipient_cert_subject)

Default Value

Remarks

This is the subject of the certificate used for client authentication.

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.


Field	Meaning
CN	Common Name. This is commonly a host name 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.

signer_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_signer_cert_encoded() -> bytes: ...
def set_signer_cert_encoded(value: bytes) -> None: ...

signer_cert_encoded = property(get_signer_cert_encoded, set_signer_cert_encoded)

Default Value

Remarks

This is 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.

signer_cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_signer_cert_store() -> bytes: ...
def set_signer_cert_store(value: bytes) -> None: ...

signer_cert_store = property(get_signer_cert_store, set_signer_cert_store)

Default Value

"MY"

Remarks

This is 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 are designations of 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.

signer_cert_store_password Property

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

Syntax

def get_signer_cert_store_password() -> str: ...
def set_signer_cert_store_password(value: str) -> None: ...

signer_cert_store_password = property(get_signer_cert_store_password, set_signer_cert_store_password)

Default Value

Remarks

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

signer_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_signer_cert_store_type() -> int: ...
def set_signer_cert_store_type(value: int) -> None: ...

signer_cert_store_type = property(get_signer_cert_store_type, set_signer_cert_store_type)

Default Value

Remarks

This is the type of certificate store for this certificate.


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 (PKCS12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS7 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 PKCS11 interface. To use a security key the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to `cstPKCS11`, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 dll. The certificate information returned in the on_cert_list event's `CertEncoded` parameter may be saved for later use. When using a certificate, 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 `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
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.

signer_cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_signer_cert_subject() -> str: ...
def set_signer_cert_subject(value: str) -> None: ...

signer_cert_subject = property(get_signer_cert_subject, set_signer_cert_subject)

Default Value

Remarks

This is the subject of the certificate used for client authentication.

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.


Field	Meaning
CN	Common Name. This is commonly a host name 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.

signing_algorithm Property

The algorithm used when signing.

Syntax

def get_signing_algorithm() -> int: ...
def set_signing_algorithm(value: int) -> None: ...

signing_algorithm = property(get_signing_algorithm, set_signing_algorithm)

Default Value

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.

add_claim Method

Adds an new claim.

Syntax

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

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

Adds additional header parameters.

Syntax

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

Remarks

This method is used to add additional header parameters before calling 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 class 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 class 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

Sets or retrieves a configuration setting.

Syntax

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

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

decrypt Method

Decrypts the encoded JWT.

Syntax

def decrypt() -> None: ...

Remarks

This method decrypts the encoded JWT.

Before calling the decrypt method set encoded_jwt to a valid compact serialized JWT string. For instance:

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	Cert*
PBES	key_password

If the correct key or Cert* is not known ahead of time the KeyId parameter of the on_recipient_info event may be used to identify the correct key.

The following properties are applicable when calling this method:

Cert* (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*
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*