CkJwt Ruby Reference Documentation
CkJwt
Current Version: 10.1.0
A class for signing and verifying JWT's (JSON Web Tokens).
Object Creation
obj = Chilkat::CkJwt.new()
Properties
AutoCompact
boolVal = jwt.get_AutoCompact();
jwt.put_AutoCompact(boolVal);
If true, the JSON passed to CreateJwt and CreateJwtPk will be compacted to remove unnecessary whitespace. This will result in the smallest possible JWT. The default value is true.
topDebugLogFilePath
# ckStr is a CkString
jwt.get_DebugLogFilePath(ckStr);
strVal = jwt.debugLogFilePath();
jwt.put_DebugLogFilePath(strVal);
If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.
This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
LastErrorHtml
# ckStr is a CkString
jwt.get_LastErrorHtml(ckStr);
strVal = jwt.lastErrorHtml();
Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
topLastErrorText
# ckStr is a CkString
jwt.get_LastErrorText(ckStr);
strVal = jwt.lastErrorText();
Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
LastErrorXml
# ckStr is a CkString
jwt.get_LastErrorXml(ckStr);
strVal = jwt.lastErrorXml();
Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
topLastMethodSuccess
boolVal = jwt.get_LastMethodSuccess();
jwt.put_LastMethodSuccess(boolVal);
Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:
- Any method that returns a string.
- Any method returning a Chilkat object, binary bytes, or a date/time.
- Any method returning a standard boolean status value where success = true and failure = false.
- Any method returning an integer where failure is defined by a return value less than zero.
Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.
topUncommonOptions
# ckStr is a CkString
jwt.get_UncommonOptions(ckStr);
strVal = jwt.uncommonOptions();
jwt.put_UncommonOptions(strVal);
This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.
topUtf8
boolVal = jwt.get_Utf8();
jwt.put_Utf8(boolVal);
When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.
topVerboseLogging
boolVal = jwt.get_VerboseLogging();
jwt.put_VerboseLogging(boolVal);
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
topVersion
Methods
CreateJwt
# payload is a string
# password is a string
# outStr is a CkString (output)
status = jwt.CreateJwt(header, payload, password, outStr);
retStr = jwt.createJwt(header, payload, password);
Creates a JWT. The header is the JOSE JSON header. It can be the full JOSE JSON, or it can be a shorthand string such as "HS256", "HS384", or "HS512", in which case the standard JOSE header for the given algorithm will be used.
The payload is the JSON payload that contains the claims. The password is the secret. Given that the secret is a shared passwod string, this method should only be called for creating JWT's where the JOSE header's "alg" is HS256, HS384, or HS512. For RS256, RS384, RS512, ES256, ES384, and ES512, call CreateJwtPk instead.
When successful, this method returns a JWT with the format xxxxx.yyyyy.zzzzz, where xxxxx is the base64url encoded JOSE header, yyyyy is the base64url encoded payload, and zzzzz is the base64url signature.
Returns true for success, false for failure.
CreateJwtCert
# payload is a string
# cert is a CkCert
# outStr is a CkString (output)
status = jwt.CreateJwtCert(header, payload, cert, outStr);
retStr = jwt.createJwtCert(header, payload, cert);
Creates a JWT using a certificate's private key. The header is the JOSE JSON header. It can be the full JOSE JSON, or it can be a shorthand string such as "RS256", "RS384", "RS512", "PS256", "PS384", "PS512", "ES256", "ES384", or "ES512", in which case the standard JOSE header for the given algorithm will be used.
The payload is the JSON payload that contains the claims. The cert is the certificate with private key. This method should only be called for creating JWT's where the JOSE header's "alg" is RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, or ES512. If the secret is a shared password string, then call CreateJwt instead.
When successful, this method returns a JWT with the format xxxxx.yyyyy.zzzzz, where xxxxx is the base64url encoded JOSE header, yyyyy is the base64url encoded payload, and zzzzz is the base64url signature.
Note: Support for the PS256, PS384, PS512 algorithms was added in Chilkat v10.0.0.
Returns true for success, false for failure.
CreateJwtPk
# payload is a string
# key is a CkPrivateKey
# outStr is a CkString (output)
status = jwt.CreateJwtPk(header, payload, key, outStr);
retStr = jwt.createJwtPk(header, payload, key);
Creates a JWT using an RSA or ECC private key. The header is the JOSE JSON header. It can be the full JOSE JSON, or it can be a shorthand string such as "RS256", "RS384", "RS512", "PS256", "PS384", "PS512", "ES256", "ES384", or "ES512", in which case the standard JOSE header for the given algorithm will be used.
The payload is the JSON payload that contains the claims. The key is the private key. This method should only be called for creating JWT's where the JOSE header's "alg" is RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, or ES512. If the secret is a shared password string, then call CreateJwt instead.
When successful, this method returns a JWT with the format xxxxx.yyyyy.zzzzz, where xxxxx is the base64url encoded JOSE header, yyyyy is the base64url encoded payload, and zzzzz is the base64url signature.
Note: Support for the PS256, PS384, PS512 algorithms was added in Chilkat v10.0.0.
Returns true for success, false for failure.
GenNumericDate
retInt = jwt.GenNumericDate(numSecOffset);
Generates a JSON numeric value representing the number of seconds from 1970-01-01T00:00:00Z UTC until the specified UTC date/time, ignoring leap seconds. The date/time generated is equal to the current system time plus the number of seconds specified by numSecOffset. The numSecOffset can be negative.
GetHeader
# outStr is a CkString (output)
status = jwt.GetHeader(token, outStr);
retStr = jwt.getHeader(token);
Decodes the first part of a JWT (the "xxxxx" part of the "xxxxx.yyyyy.zzzzz" JWT) and returns the JSON string. This is the JOSE header of the JWT.
Returns true for success, false for failure.
GetPayload
# outStr is a CkString (output)
status = jwt.GetPayload(token, outStr);
retStr = jwt.getPayload(token);
Decodes the second part of a JWT (the "yyyyy" part of the "xxxxx.yyyyy.zzzzz" JWT) and returns the JSON string. This is the claims payload of the JWT.
Returns true for success, false for failure.
IsTimeValid
# leeway is an integer
retBool = jwt.IsTimeValid(jwt, leeway);
Verifies the "exp" and/or "nbf" claims and returns true if the current system date/time is within range. Returns false if the current system date/time is outside the allowed range of time. The leeway may be set to a non-zero number of seconds to allow for some small leeway (usually no more than a few minutes) to account for clock skew.
VerifyJwt
# password is a string
status = jwt.VerifyJwt(token, password);
Verifies a JWT that requires a shared password string for verification. The token should be a JWT with the format xxxxx.yyyyy.zzzzz. This method should only be called for JWT's using the HS256, HS384, or HS512 algorithms. The VerifyJwtPk method should be called for verifying JWT's requiring an RSA or ECC key.
Returns true if the signature was verified. Returns false if the signature was not successfully verified.
Note: This method will return false if the "alg" in the JOSE header is anything other than the algorithms specifically for HMAC, namely "hs256, "hs384", and "hs512". For example, if the "alg" is "none", then this method immediately returns a failed status.
Further Explanation: This method calculates the signature using the password provided by the application, and compares it against the signature found in the JWT. If the signatures are equal, then the password is correct, and true is returned.
Returns true for success, false for failure.
VerifyJwtPk
Verifies a JWT that requires an RSA or ECC public key for verification. The token should be a JWT with the format xxxxx.yyyyy.zzzzz. This method should only be called for JWT's using the RS256, RS384, RS512, ES256, ES384, or ES512 algorithms.
Returns true if the signature was verified. Returns false if the signature was not successfully verified.
Note: This method will return false if the "alg" in the JOSE header is anything other than the algorithms specifically for RSA and ECC. For example, if the "alg" is "none", then this method immediately returns a failed status.
Further Explanation: This method calculates the signature using the key provided by the application, and compares it against the signature found in the JWT. If the signatures are equal, then the key corresponds to the private key used to sign, and true is returned.
Returns true for success, false for failure.