JWT Module
Properties Methods Events Config Settings Errors
Create, Sign, Encrypt, Verify and Decrypt JSON Web Tokens (JWTs).
Syntax
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 AddClaim. 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 SigningAlgorithm 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 EncryptionAlgorithm 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 SigningAlgorithm 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 EncodedJWT property will hold the compact serialized JWT. The following properties are applicable when calling this method:
- SigningAlgorithm (required)
- Cert* (conditional - required for ECDSA and RSA)
- Key (conditional - required for HMAC)
- ClaimAudience
- ClaimExp
- ClaimIssuedAt
- ClaimIssuer
- ClaimJWTId
- ClaimNotBefore
- HeaderParam*
- KeyId
Notes for HMAC Algorithms (HS256, HS384, HS512)
When SigningAlgorithm 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 SigningAlgorithm 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 EncodedJWT 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 SignerInfo event may be used to identify the correct key.
If this method returns without error verification was successful. If verification fails then this method . 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 HeaderParam event.
The following properties are applicable when calling this method:
- EncodedJWT (required)
- Key (conditional - required for HMAC)
- SignerCert* (conditional - required for ECDSA and RSA)
- SigningAlgorithm (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:
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:
-----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 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 ContentEncryptionAlgorithm. The content encryption key is then encrypted itself using the algorithm specified by EncryptionAlgorithm. 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 EncodedJWT. For instance:
eyJhbGciOiJBMjU2S1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2In0.4tcAnZJ00u4GY2kLOanPOL4CtvcfraZ8SIi6bOZ27qYBI2rHITPc1Q.c_9rCTdPn-saLCti2ZEyWQ.eLwqqo5BGNa70RlsvT-vTh7Gk0hjpJYY_9Zc39Vim_qEtjyMcxZygBpkfx9brzQr9rUbuiAhoCMXKip2-lKT6w.NkuLDPmWxWL4BaTWHWicIQ
The class will use the values present in the Claim* properties to build the encoded JWT. After calling this method the EncodedJWT property will hold the compact serialized JWT. The following properties are applicable when calling this method:
- EncryptionAlgorithm (required)
- Key (conditional - required for AES)
- KeyPassword (conditional - required for PBES)
- RecipientCert* (conditional - required for ECDH and RSA)
- ClaimAudience
- ClaimExp
- ClaimIssuedAt
- ClaimIssuer
- ClaimJWTId
- ClaimNotBefore
- CompressionAlgorithm
- ContentEncryptionAlgorithm
- HeaderParam*
- KeyId
Notes for AES Algorithms (A128KW, A192KW, A256KW, A128GCMKW, A192GCMKW, A256GCMKW)
When EncryptionAlgorithm 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:
-----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 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 KeyPassword property. Set KeyPassword 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 EncryptionAlgorithm is set to Direct the Key property must be set to a valid symmetric key that will be used directly by the ContentEncryptionAlgorithm. 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 ContentEncryptionAlgorithm. 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 EncodedJWT 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 | Cert* |
PBES | KeyPassword |
If this method returns without error decryption was successful. If decryption fails then this method . 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 HeaderParam event.
The following properties are applicable when calling this method:
- Cert* (conditional - required for RSA and ECDH)
- EncodedJWT
- Key (conditional - required for AES)
- ContentEncryptionAlgorithm (only if StrictValidation is True)
- EncryptionAlgorithm (only if StrictValidation is True)
- Header*
- StrictValidation
After calling this method the following properties are populated:
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 KeyPassword property. Set KeyPassword 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 ContentEncryptionAlgorithm. 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 class also supports a variety of other features including:
- Adding custom header parameters with AddHeaderParam
- Enforcing algorithm restrictions when verifying by setting StrictValidation
- Inspect the JWT without verifying or decrypting by calling Parse
Property List
The following is the full list of the properties of the module with short descriptions. Click on the links for further details.
CertEncoded | This is the certificate (PEM/base64 encoded). |
CertStore | This is the name of the certificate store for the client certificate. |
CertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
CertStoreType | This is the type of certificate store for this certificate. |
CertSubject | This is the subject of the certificate used for client authentication. |
ClaimAudience | The audience claim. |
ClaimExp | The expiration time claim. |
ClaimIssuedAt | The claim indicating the time at which the JWT was issued. |
ClaimIssuer | The issuer of the JWT. |
ClaimJWTId | The unique identifier for the JWT. |
ClaimNotBefore | The claim identifying the time before which the JWT is invalid. |
Claims | The claims in the JWT. |
ClaimSubject | The subject identifies the principal of the JWT. |
ContentEncryptionAlgorithm | The algorithm used to encrypt the content. |
EncodedJWT | The encoded JWT. |
EncryptionAlgorithm | The key encryption algorithm. |
HeaderParams | The JOSE header parameters. |
Key | The key used for HMAC and AES. |
KeyId | The Id of the key used to sign or encrypt the message. |
KeyPassword | The key password used in the PBES algorithm. |
RecipientCertEncoded | This is the certificate (PEM/base64 encoded). |
RecipientCertStore | This is the name of the certificate store for the client certificate. |
RecipientCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
RecipientCertStoreType | This is the type of certificate store for this certificate. |
RecipientCertSubject | This is the subject of the certificate used for client authentication. |
SignerCertEncoded | This is the certificate (PEM/base64 encoded). |
SignerCertStore | This is the name of the certificate store for the client certificate. |
SignerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SignerCertStoreType | This is the type of certificate store for this certificate. |
SignerCertSubject | This is the subject of the certificate used for client authentication. |
SigningAlgorithm | The algorithm used when signing. |
Method List
The following is the full list of the methods of the module with short descriptions. Click on the links for further details.
AddClaim | Adds an new claim. |
AddHeaderParam | 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 module 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 module with short descriptions. Click on the links for further details.
ClaimInfo | Fires once for each claim. |
Error | Information about errors during data delivery. |
HeaderParam | Fires once for each JOSE header parameter. |
RecipientInfo | Fired with information about the recipient key of the encrypted message. |
SignerInfo | Fires with information about the signature. |
Config Settings
The following is a list of config settings for the module 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. |
UseInternalSecurityAPI | Tells the module whether or not to use the system security libraries or an internal implementation. |
CertEncoded Property (JWT Module)
This is the certificate (PEM/base64 encoded).
Syntax
public var certEncoded: String { get {...} set {...} }
public var certEncodedB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=certEncoded,setter=setCertEncoded:) NSString* certEncoded; - (NSString*)certEncoded; - (void)setCertEncoded :(NSString*)newCertEncoded; @property (nonatomic,readwrite,assign,getter=certEncodedB,setter=setCertEncodedB:) NSData* certEncodedB; - (NSData*)certEncodedB; - (void)setCertEncodedB :(NSData*)newCertEncoded;
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The CertStore and CertSubject properties also may be used to specify a certificate.
When CertEncoded is set, a search is initiated in the current CertStore for the private key of the certificate. If the key is found, CertSubject is updated to reflect the full subject of the selected certificate; otherwise, CertSubject is set to an empty string.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setCertEncodedB(certEncoded: Data) throws public func setCertEncoded(certEncoded: String) throws
CertStore Property (JWT Module)
This is the name of the certificate store for the client certificate.
Syntax
public var certStore: String { get {...} set {...} }
public var certStoreB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=certStore,setter=setCertStore:) NSString* certStore; - (NSString*)certStore; - (void)setCertStore :(NSString*)newCertStore; @property (nonatomic,readwrite,assign,getter=certStoreB,setter=setCertStoreB:) NSData* certStoreB; - (NSData*)certStoreB; - (void)setCertStoreB :(NSData*)newCertStore;
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertStorePassword.
CertStore is used in conjunction with the CertSubject property to specify client certificates. If CertStore has a value, and CertSubject or CertEncoded is set, a search for a certificate is initiated. Please see the CertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
CertStorePassword Property (JWT Module)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
public var certStorePassword: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=certStorePassword,setter=setCertStorePassword:) NSString* certStorePassword; - (NSString*)certStorePassword; - (void)setCertStorePassword :(NSString*)newCertStorePassword;
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.
CertStoreType Property (JWT Module)
This is the type of certificate store for this certificate.
Syntax
public var certStoreType: JwtCertStoreTypes { get {...} set {...} }
public enum JwtCertStoreTypes: Int32 { case cstUser = 0 case cstMachine = 1 case cstPFXFile = 2 case cstPFXBlob = 3 case cstJKSFile = 4 case cstJKSBlob = 5 case cstPEMKeyFile = 6 case cstPEMKeyBlob = 7 case cstPublicKeyFile = 8 case cstPublicKeyBlob = 9 case cstSSHPublicKeyBlob = 10 case cstP7BFile = 11 case cstP7BBlob = 12 case cstSSHPublicKeyFile = 13 case cstPPKFile = 14 case cstPPKBlob = 15 case cstXMLFile = 16 case cstXMLBlob = 17 case cstJWKFile = 18 case cstJWKBlob = 19 case cstSecurityKey = 20 case cstBCFKSFile = 21 case cstBCFKSBlob = 22 case cstPKCS11 = 23 case cstAuto = 99 }
@property (nonatomic,readwrite,assign,getter=certStoreType,setter=setCertStoreType:) int certStoreType; - (int)certStoreType; - (void)setCertStoreType :(int)newCertStoreType;
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the CertStore and set CertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
CertSubject Property (JWT Module)
This is the subject of the certificate used for client authentication.
Syntax
public var certSubject: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=certSubject,setter=setCertSubject:) NSString* certSubject; - (NSString*)certSubject; - (void)setCertSubject :(NSString*)newCertSubject;
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setCertSubject(certSubject: String) throws
ClaimAudience Property (JWT Module)
The audience claim.
Syntax
public var claimAudience: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=claimAudience,setter=setClaimAudience:) NSString* claimAudience; - (NSString*)claimAudience; - (void)setClaimAudience :(NSString*)newClaimAudience;
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.
ClaimExp Property (JWT Module)
The expiration time claim.
Syntax
public var claimExp: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=claimExp,setter=setClaimExp:) NSString* claimExp; - (NSString*)claimExp; - (void)setClaimExp :(NSString*)newClaimExp;
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.
ClaimIssuedAt Property (JWT Module)
The claim indicating the time at which the JWT was issued.
Syntax
public var claimIssuedAt: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=claimIssuedAt,setter=setClaimIssuedAt:) NSString* claimIssuedAt; - (NSString*)claimIssuedAt; - (void)setClaimIssuedAt :(NSString*)newClaimIssuedAt;
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.
ClaimIssuer Property (JWT Module)
The issuer of the JWT.
Syntax
public var claimIssuer: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=claimIssuer,setter=setClaimIssuer:) NSString* claimIssuer; - (NSString*)claimIssuer; - (void)setClaimIssuer :(NSString*)newClaimIssuer;
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.
ClaimJWTId Property (JWT Module)
The unique identifier for the JWT.
Syntax
public var claimJWTId: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=claimJWTId,setter=setClaimJWTId:) NSString* claimJWTId; - (NSString*)claimJWTId; - (void)setClaimJWTId :(NSString*)newClaimJWTId;
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.
ClaimNotBefore Property (JWT Module)
The claim identifying the time before which the JWT is invalid.
Syntax
public var claimNotBefore: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=claimNotBefore,setter=setClaimNotBefore:) NSString* claimNotBefore; - (NSString*)claimNotBefore; - (void)setClaimNotBefore :(NSString*)newClaimNotBefore;
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.
Claims Property (JWT Module)
The claims in the JWT.
Syntax
public var claims: Array<JWTClaim> { get {...} }
@property (nonatomic,readwrite,assign,getter=JWTClaimCount,setter=setJWTClaimCount:) int JWTClaimCount; - (int)JWTClaimCount; - (void)setJWTClaimCount :(int)newJWTClaimCount; - (int)JWTClaimDataType:(int)jWTClaimIndex; - (void)setJWTClaimDataType:(int)jWTClaimIndex :(int)newJWTClaimDataType; - (NSString*)JWTClaimName:(int)jWTClaimIndex; - (void)setJWTClaimName:(int)jWTClaimIndex :(NSString*)newJWTClaimName; - (NSString*)JWTClaimValue:(int)jWTClaimIndex; - (void)setJWTClaimValue:(int)jWTClaimIndex :(NSString*)newJWTClaimValue;
Default Value
0
Remarks
This property specifies the claims within the JWT. This may be populated before calling Sign or Encrypt. This is populated with the parsed claims after calling Verify, Decrypt, or Parse.
ClaimSubject Property (JWT Module)
The subject identifies the principal of the JWT.
Syntax
public var claimSubject: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=claimSubject,setter=setClaimSubject:) NSString* claimSubject; - (NSString*)claimSubject; - (void)setClaimSubject :(NSString*)newClaimSubject;
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.
ContentEncryptionAlgorithm Property (JWT Module)
The algorithm used to encrypt the content.
Syntax
public var contentEncryptionAlgorithm: JwtContentEncryptionAlgorithms { get {...} set {...} }
public enum JwtContentEncryptionAlgorithms: Int32 { case ceaA128CBC_HS256 = 0 case ceaA192CBC_HS384 = 1 case ceaA256CBC_HS512 = 2 case ceaA128GCM = 3 case ceaA192GCM = 4 case ceaA256GCM = 5 }
@property (nonatomic,readwrite,assign,getter=contentEncryptionAlgorithm,setter=setContentEncryptionAlgorithm:) int contentEncryptionAlgorithm; - (int)contentEncryptionAlgorithm; - (void)setContentEncryptionAlgorithm :(int)newContentEncryptionAlgorithm;
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 |
EncodedJWT Property (JWT Module)
The encoded JWT.
Syntax
public var encodedJWT: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=encodedJWT,setter=setEncodedJWT:) NSString* encodedJWT; - (NSString*)encodedJWT; - (void)setEncodedJWT :(NSString*)newEncodedJWT;
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.
EncryptionAlgorithm Property (JWT Module)
The key encryption algorithm.
Syntax
public var encryptionAlgorithm: JwtEncryptionAlgorithms { get {...} set {...} }
public enum JwtEncryptionAlgorithms: Int32 { case eaRSA1_5 = 0 case eaRSA_OAEP = 1 case eaRSA_OAEP_256 = 2 case eaA128KW = 3 case eaA192KW = 4 case eaA256KW = 5 case eaDir = 6 case eaECDH_ES = 7 case eaECDH_ES_A128KW = 8 case eaECDH_ES_A192KW = 9 case eaECDH_ES_A256KW = 10 case eaA128GCMKW = 11 case eaA192GCMKW = 12 case eaA256GCMKW = 13 case eaPBES2_HS256_A128KW = 14 case eaPBES2_HS384_A192KW = 15 case eaPBES2_HS512_A256KW = 16 }
@property (nonatomic,readwrite,assign,getter=encryptionAlgorithm,setter=setEncryptionAlgorithm:) int encryptionAlgorithm; - (int)encryptionAlgorithm; - (void)setEncryptionAlgorithm :(int)newEncryptionAlgorithm;
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 RecipientCert* properties must be specified. When using a PBES algorithm the KeyPassword 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 | KeyPassword |
15 (eaPBES2_HS384_A192KW) | PBES2 with HMAC SHA-384 and A192KW | KeyPassword |
16 (eaPBES2_HS512_A256KW) | PBES2 with HMAC SHA-512 and A256KW | KeyPassword |
When set to an ECDH algorithm the following settings are also applicable:
When set to a PBES algorithm the following settings are also applicable:
HeaderParams Property (JWT Module)
The JOSE header parameters.
Syntax
public var headerParams: Array<HeaderParam> { get {...} }
@property (nonatomic,readwrite,assign,getter=headerParamCount,setter=setHeaderParamCount:) int headerParamCount; - (int)headerParamCount; - (void)setHeaderParamCount :(int)newHeaderParamCount; - (int)headerParamDataType:(int)headerParamIndex; - (void)setHeaderParamDataType:(int)headerParamIndex :(int)newHeaderParamDataType; - (NSString*)headerParamName:(int)headerParamIndex; - (void)setHeaderParamName:(int)headerParamIndex :(NSString*)newHeaderParamName; - (NSString*)headerParamValue:(int)headerParamIndex; - (void)setHeaderParamValue:(int)headerParamIndex :(NSString*)newHeaderParamValue;
Default Value
0
Remarks
This property specifies the JOSE header parameters. This may be populated before calling Sign or Encrypt. This is populated with the parsed header values after calling Verify, Decrypt, or Parse.
Key Property (JWT Module)
The key used for HMAC and AES.
Syntax
@property (nonatomic,readwrite,assign,getter=key,setter=setKey:) NSString* key; - (NSString*)key; - (void)setKey :(NSString*)newKey; @property (nonatomic,readwrite,assign,getter=keyB,setter=setKeyB:) NSData* keyB; - (NSData*)keyB; - (void)setKeyB :(NSData*)newKey;
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 SigningAlgorithm 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 EncryptionAlgorithm 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 EncryptionAlgorithm is set to Direct this key is used directly with the algorithm specified by ContentEncryptionAlgorithm and must be an appropriate size for the selected ContentEncryptionAlgorithm.
KeyId Property (JWT Module)
The Id of the key used to sign or encrypt the message.
Syntax
public var keyId: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=keyId,setter=setKeyId:) NSString* keyId; - (NSString*)keyId; - (void)setKeyId :(NSString*)newKeyId;
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.
KeyPassword Property (JWT Module)
The key password used in the PBES algorithm.
Syntax
public var keyPassword: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=keyPassword,setter=setKeyPassword:) NSString* keyPassword; - (NSString*)keyPassword; - (void)setKeyPassword :(NSString*)newKeyPassword;
Default Value
""
Remarks
This property specifies the key password used to derive a key when using a PBES EncryptionAlgorithm.
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.
RecipientCertEncoded Property (JWT Module)
This is the certificate (PEM/base64 encoded).
Syntax
public var recipientCertEncoded: String { get {...} set {...} }
public var recipientCertEncodedB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=recipientCertEncoded,setter=setRecipientCertEncoded:) NSString* recipientCertEncoded; - (NSString*)recipientCertEncoded; - (void)setRecipientCertEncoded :(NSString*)newRecipientCertEncoded; @property (nonatomic,readwrite,assign,getter=recipientCertEncodedB,setter=setRecipientCertEncodedB:) NSData* recipientCertEncodedB; - (NSData*)recipientCertEncodedB; - (void)setRecipientCertEncodedB :(NSData*)newRecipientCertEncoded;
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The RecipientCertStore and RecipientCertSubject properties also may be used to specify a certificate.
When RecipientCertEncoded is set, a search is initiated in the current RecipientCertStore for the private key of the certificate. If the key is found, RecipientCertSubject is updated to reflect the full subject of the selected certificate; otherwise, RecipientCertSubject is set to an empty string.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setRecipientCertEncodedB(recipientCertEncoded: Data) throws public func setRecipientCertEncoded(recipientCertEncoded: String) throws
RecipientCertStore Property (JWT Module)
This is the name of the certificate store for the client certificate.
Syntax
public var recipientCertStore: String { get {...} set {...} }
public var recipientCertStoreB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=recipientCertStore,setter=setRecipientCertStore:) NSString* recipientCertStore; - (NSString*)recipientCertStore; - (void)setRecipientCertStore :(NSString*)newRecipientCertStore; @property (nonatomic,readwrite,assign,getter=recipientCertStoreB,setter=setRecipientCertStoreB:) NSData* recipientCertStoreB; - (NSData*)recipientCertStoreB; - (void)setRecipientCertStoreB :(NSData*)newRecipientCertStore;
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The RecipientCertStoreType property denotes the type of the certificate store specified by RecipientCertStore. If the store is password protected, specify the password in RecipientCertStorePassword.
RecipientCertStore is used in conjunction with the RecipientCertSubject property to specify client certificates. If RecipientCertStore has a value, and RecipientCertSubject or RecipientCertEncoded is set, a search for a certificate is initiated. Please see the RecipientCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
RecipientCertStorePassword Property (JWT Module)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
public var recipientCertStorePassword: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=recipientCertStorePassword,setter=setRecipientCertStorePassword:) NSString* recipientCertStorePassword; - (NSString*)recipientCertStorePassword; - (void)setRecipientCertStorePassword :(NSString*)newRecipientCertStorePassword;
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.
RecipientCertStoreType Property (JWT Module)
This is the type of certificate store for this certificate.
Syntax
public var recipientCertStoreType: JwtRecipientCertStoreTypes { get {...} set {...} }
public enum JwtRecipientCertStoreTypes: Int32 { case cstUser = 0 case cstMachine = 1 case cstPFXFile = 2 case cstPFXBlob = 3 case cstJKSFile = 4 case cstJKSBlob = 5 case cstPEMKeyFile = 6 case cstPEMKeyBlob = 7 case cstPublicKeyFile = 8 case cstPublicKeyBlob = 9 case cstSSHPublicKeyBlob = 10 case cstP7BFile = 11 case cstP7BBlob = 12 case cstSSHPublicKeyFile = 13 case cstPPKFile = 14 case cstPPKBlob = 15 case cstXMLFile = 16 case cstXMLBlob = 17 case cstJWKFile = 18 case cstJWKBlob = 19 case cstSecurityKey = 20 case cstBCFKSFile = 21 case cstBCFKSBlob = 22 case cstPKCS11 = 23 case cstAuto = 99 }
@property (nonatomic,readwrite,assign,getter=recipientCertStoreType,setter=setRecipientCertStoreType:) int recipientCertStoreType; - (int)recipientCertStoreType; - (void)setRecipientCertStoreType :(int)newRecipientCertStoreType;
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the RecipientCertStore and set RecipientCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
RecipientCertSubject Property (JWT Module)
This is the subject of the certificate used for client authentication.
Syntax
public var recipientCertSubject: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=recipientCertSubject,setter=setRecipientCertSubject:) NSString* recipientCertSubject; - (NSString*)recipientCertSubject; - (void)setRecipientCertSubject :(NSString*)newRecipientCertSubject;
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setRecipientCertSubject(recipientCertSubject: String) throws
SignerCertEncoded Property (JWT Module)
This is the certificate (PEM/base64 encoded).
Syntax
public var signerCertEncoded: String { get {...} set {...} }
public var signerCertEncodedB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=signerCertEncoded,setter=setSignerCertEncoded:) NSString* signerCertEncoded; - (NSString*)signerCertEncoded; - (void)setSignerCertEncoded :(NSString*)newSignerCertEncoded; @property (nonatomic,readwrite,assign,getter=signerCertEncodedB,setter=setSignerCertEncodedB:) NSData* signerCertEncodedB; - (NSData*)signerCertEncodedB; - (void)setSignerCertEncodedB :(NSData*)newSignerCertEncoded;
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SignerCertStore and SignerCertSubject properties also may be used to specify a certificate.
When SignerCertEncoded is set, a search is initiated in the current SignerCertStore for the private key of the certificate. If the key is found, SignerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SignerCertSubject is set to an empty string.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setSignerCertEncodedB(signerCertEncoded: Data) throws public func setSignerCertEncoded(signerCertEncoded: String) throws
SignerCertStore Property (JWT Module)
This is the name of the certificate store for the client certificate.
Syntax
public var signerCertStore: String { get {...} set {...} }
public var signerCertStoreB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=signerCertStore,setter=setSignerCertStore:) NSString* signerCertStore; - (NSString*)signerCertStore; - (void)setSignerCertStore :(NSString*)newSignerCertStore; @property (nonatomic,readwrite,assign,getter=signerCertStoreB,setter=setSignerCertStoreB:) NSData* signerCertStoreB; - (NSData*)signerCertStoreB; - (void)setSignerCertStoreB :(NSData*)newSignerCertStore;
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SignerCertStoreType property denotes the type of the certificate store specified by SignerCertStore. If the store is password protected, specify the password in SignerCertStorePassword.
SignerCertStore is used in conjunction with the SignerCertSubject property to specify client certificates. If SignerCertStore has a value, and SignerCertSubject or SignerCertEncoded is set, a search for a certificate is initiated. Please see the SignerCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
SignerCertStorePassword Property (JWT Module)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
public var signerCertStorePassword: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=signerCertStorePassword,setter=setSignerCertStorePassword:) NSString* signerCertStorePassword; - (NSString*)signerCertStorePassword; - (void)setSignerCertStorePassword :(NSString*)newSignerCertStorePassword;
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.
SignerCertStoreType Property (JWT Module)
This is the type of certificate store for this certificate.
Syntax
public var signerCertStoreType: JwtSignerCertStoreTypes { get {...} set {...} }
public enum JwtSignerCertStoreTypes: Int32 { case cstUser = 0 case cstMachine = 1 case cstPFXFile = 2 case cstPFXBlob = 3 case cstJKSFile = 4 case cstJKSBlob = 5 case cstPEMKeyFile = 6 case cstPEMKeyBlob = 7 case cstPublicKeyFile = 8 case cstPublicKeyBlob = 9 case cstSSHPublicKeyBlob = 10 case cstP7BFile = 11 case cstP7BBlob = 12 case cstSSHPublicKeyFile = 13 case cstPPKFile = 14 case cstPPKBlob = 15 case cstXMLFile = 16 case cstXMLBlob = 17 case cstJWKFile = 18 case cstJWKBlob = 19 case cstSecurityKey = 20 case cstBCFKSFile = 21 case cstBCFKSBlob = 22 case cstPKCS11 = 23 case cstAuto = 99 }
@property (nonatomic,readwrite,assign,getter=signerCertStoreType,setter=setSignerCertStoreType:) int signerCertStoreType; - (int)signerCertStoreType; - (void)setSignerCertStoreType :(int)newSignerCertStoreType;
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SignerCertStore and set SignerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
SignerCertSubject Property (JWT Module)
This is the subject of the certificate used for client authentication.
Syntax
public var signerCertSubject: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=signerCertSubject,setter=setSignerCertSubject:) NSString* signerCertSubject; - (NSString*)signerCertSubject; - (void)setSignerCertSubject :(NSString*)newSignerCertSubject;
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setSignerCertSubject(signerCertSubject: String) throws
SigningAlgorithm Property (JWT Module)
The algorithm used when signing.
Syntax
public var signingAlgorithm: JwtSigningAlgorithms { get {...} set {...} }
public enum JwtSigningAlgorithms: Int32 { case saHS256 = 0 case saHS384 = 1 case saHS512 = 2 case saRS256 = 3 case saRS384 = 4 case saRS512 = 5 case saES256 = 6 case saES384 = 7 case saES512 = 8 case saPS256 = 9 case saPS384 = 10 case saPS512 = 11 case saES256K = 12 case saNone = 99 }
@property (nonatomic,readwrite,assign,getter=signingAlgorithm,setter=setSigningAlgorithm:) int signingAlgorithm; - (int)signingAlgorithm; - (void)setSigningAlgorithm :(int)newSigningAlgorithm;
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 SignerCert 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.
AddClaim Method (JWT Module)
Adds an new claim.
Syntax
- (void)addClaim:(NSString*)name :(NSString*)value :(int)dataType;
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)
AddHeaderParam Method (JWT Module)
Adds additional header parameters.
Syntax
- (void)addHeaderParam:(NSString*)name :(NSString*)value :(int)dataType;
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 | KeyId |
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 EncryptionAlgorithm and other properties that may be set.
Parameters Automatically Set:
Header Param | Property |
alg | EncryptionAlgorithm |
enc | ContentEncryptionAlgorithm |
kid | KeyId |
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 Module)
Sets or retrieves a configuration setting.
Syntax
- (NSString*)config:(NSString*)configurationString;
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Decrypt Method (JWT Module)
Decrypts the encoded JWT.
Syntax
public func decrypt() throws -> Void
- (void)decrypt;
Remarks
This method decrypts the encoded JWT.
Before calling the Decrypt method set EncodedJWT 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 | Cert* |
PBES | KeyPassword |
If this method returns without error decryption was successful. If decryption fails then this method . 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 HeaderParam event.
The following properties are applicable when calling this method:
- Cert* (conditional - required for RSA and ECDH)
- EncodedJWT
- Key (conditional - required for AES)
- ContentEncryptionAlgorithm (only if StrictValidation is True)
- EncryptionAlgorithm (only if StrictValidation is True)
- Header*
- StrictValidation
After calling this method the following properties are populated:
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 KeyPassword property. Set KeyPassword 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 ContentEncryptionAlgorithm. 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;
Encrypt Method (JWT Module)
Encrypts the claims with the specified algorithms.
Syntax
public func encrypt() throws -> Void
- (void)encrypt;
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 ContentEncryptionAlgorithm. The content encryption key is then encrypted itself using the algorithm specified by EncryptionAlgorithm. 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 EncodedJWT. For instance:
eyJhbGciOiJBMjU2S1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2In0.4tcAnZJ00u4GY2kLOanPOL4CtvcfraZ8SIi6bOZ27qYBI2rHITPc1Q.c_9rCTdPn-saLCti2ZEyWQ.eLwqqo5BGNa70RlsvT-vTh7Gk0hjpJYY_9Zc39Vim_qEtjyMcxZygBpkfx9brzQr9rUbuiAhoCMXKip2-lKT6w.NkuLDPmWxWL4BaTWHWicIQ
The class will use the values present in the Claim* properties to build the encoded JWT. After calling this method the EncodedJWT property will hold the compact serialized JWT. The following properties are applicable when calling this method:
- EncryptionAlgorithm (required)
- Key (conditional - required for AES)
- KeyPassword (conditional - required for PBES)
- RecipientCert* (conditional - required for ECDH and RSA)
- ClaimAudience
- ClaimExp
- ClaimIssuedAt
- ClaimIssuer
- ClaimJWTId
- ClaimNotBefore
- CompressionAlgorithm
- ContentEncryptionAlgorithm
- HeaderParam*
- KeyId
Notes for AES Algorithms (A128KW, A192KW, A256KW, A128GCMKW, A192GCMKW, A256GCMKW)
When EncryptionAlgorithm 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:
-----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 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 KeyPassword property. Set KeyPassword 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 EncryptionAlgorithm is set to Direct the Key property must be set to a valid symmetric key that will be used directly by the ContentEncryptionAlgorithm. 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 ContentEncryptionAlgorithm. 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 Module)
Parses the encoded JWT.
Syntax
public func parse() throws -> Void
- (void)parse;
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 HeaderParam and RecipientInfo events will fire and the HeaderParam* properties 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 Module)
Resets the component properties.
Syntax
public func reset() throws -> Void
- (void)reset;
Remarks
This method resets all message and key properties to their default values.
Sign Method (JWT Module)
Signs the payload with the specified algorithm.
Syntax
public func sign() throws -> Void
- (void)sign;
Remarks
This method signs the claims specified by the Claim* properties with the specified SigningAlgorithm.
Before calling the Sign method set SigningAlgorithm 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 EncodedJWT property will hold the compact serialized JWT. The following properties are applicable when calling this method:
- SigningAlgorithm (required)
- Cert* (conditional - required for ECDSA and RSA)
- Key (conditional - required for HMAC)
- ClaimAudience
- ClaimExp
- ClaimIssuedAt
- ClaimIssuer
- ClaimJWTId
- ClaimNotBefore
- HeaderParam*
- KeyId
Notes for HMAC Algorithms (HS256, HS384, HS512)
When SigningAlgorithm 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 SigningAlgorithm 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;
Verify Method (JWT Module)
Verifies the signature of the encoded JWT.
Syntax
public func verify() throws -> Void
- (void)verify;
Remarks
This method verifies the signature of the encoded JWT.
Before calling the Verify method set EncodedJWT 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 SignerInfo event may be used to identify the correct key.
If this method returns without error verification was successful. If verification fails then this method . 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 HeaderParam event.
The following properties are applicable when calling this method:
- EncodedJWT (required)
- Key (conditional - required for HMAC)
- SignerCert* (conditional - required for ECDSA and RSA)
- SigningAlgorithm (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:
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:
-----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 Cert* properties.
Jwt jwt = new Jwt();
jwt.EncodedJWT = signedData;
jwt.Verify();
string issuer = jwt.ClaimIssuer;
ClaimInfo Event (JWT Module)
Fires once for each claim.
Syntax
- (void)onClaimInfo:(NSString*)name :(NSString*)value :(int)dataType;
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)
Error Event (JWT Module)
Information about errors during data delivery.
Syntax
- (void)onError:(int)errorCode :(NSString*)description;
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class .
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
HeaderParam Event (JWT Module)
Fires once for each JOSE header parameter.
Syntax
- (void)onHeaderParam:(NSString*)name :(NSString*)value :(int)dataType;
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)
RecipientInfo Event (JWT Module)
Fired with information about the recipient key of the encrypted message.
Syntax
- (void)onRecipientInfo:(NSString*)keyId :(NSString*)algorithm;
Remarks
This event fires with information about the key used to encrypt the data. This may be used to help identify the Key or Cert* 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.
SignerInfo Event (JWT Module)
Fires with information about the signature.
Syntax
- (void)onSignerInfo:(NSString*)keyId :(NSString*)algorithm;
Remarks
This event fires with information about the signature. This may be used to help identify the Key or Cert* 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.
HeaderParam Type
The JOSE header parameter.
Remarks
This type holds the JOSE header parameters. The fields define the name, value, and data type of the parameter.
Fields
dataType
TDataTypes
Default Value: 2
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)
name
String
Default Value: ""
The header parameter name.
value
String
Default Value: ""
The header parameter value.
Constructors
public init()
Creates a new header parameter with no name or value.
public init(name: , value: )
Creates a new header parameter. The DataType of the value will be a String.
JWTClaim Type
The claim within the JWT.
Remarks
This type holds the claim information. The fields define the name, value, and data type of the claim value.
Fields
dataType
TDataTypes
Default Value: 2
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)
name
String
Default Value: ""
The claim name.
value
String
Default Value: ""
The claim value.
Constructors
public init()
Creates a new claim with no name or value.
public init(name: , value: )
Create a new claim. The DataType of the value will be a String.
Config Settings (JWT Module)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.JWT Config Settings
- HS256
- HS384
- HS512
- RS256
- RS384
- RS512
- ES256
- ES384
- ES512
- PS256
- PS384
- PS512
Example value: HS512,HS256.
When setting ClaimAudience 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 Cert* properties will automatically be included. IssuerCerts may also be set to the public issuer certificates that will be used when building the chain to include.
For instance, to include both the certificate chain and SHA-256 thumbprint of the Cert* set this to 5.
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 EncryptionAlgorithm is set to a PBES algorithm.
This setting is only applicable when EncryptionAlgorithm 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.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to tells the class to use the internal implementation instead of using the system security libraries.
This setting is set to by default on all platforms.
Trappable Errors (JWT Module)
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. |