Jws Perl Reference Documentation
CkJws
Current Version: 10.1.2
An API for JSON Web Signature (JWS). Provides the ability to create and verify JWSs.
Object Creation
$obj = chilkat::CkJws->new();
Properties
DebugLogFilePath
# $ckStr is a CkString
$jws->get_DebugLogFilePath($ckStr);
$strVal = $jws->debugLogFilePath();
$jws->put_DebugLogFilePath($strVal);
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
LastErrorHtml
# $ckStr is a CkString
$jws->get_LastErrorHtml($ckStr);
$strVal = $jws->lastErrorHtml();
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
# $ckStr is a CkString
$jws->get_LastErrorText($ckStr);
$strVal = $jws->lastErrorText();
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
# $ckStr is a CkString
$jws->get_LastErrorXml($ckStr);
$strVal = $jws->lastErrorXml();
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
$boolVal = $jws->get_LastMethodSuccess();
$jws->put_LastMethodSuccess($boolVal);
Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.
topNumSignatures
$intVal = $jws->get_NumSignatures();
The number of signatures contained in this JWS.
topPreferCompact
$boolVal = $jws->get_PreferCompact();
$jws->put_PreferCompact($boolVal);
Controls whether to use the JWS Compact Serialization or JWS JSON Serialization when creating JWSs. The default value is 1, which is to choose the compact serialization when possible. If multiple signatures exist, or if any unprotected headers exist, then JWS JSON Serialization is used regardless of this property setting.
topPreferFlattened
$boolVal = $jws->get_PreferFlattened();
$jws->put_PreferFlattened($boolVal);
Controls whether to use the flattened or general JWE JSON Serialization when creating JWSs. The default value is 1, which is to choose the flattened serialization when possible. If multiple signatures exist, then the general (non-flattened) JWS JSON Serialization is used regardless of this property setting.
topUncommonOptions
# $ckStr is a CkString
$jws->get_UncommonOptions($ckStr);
$strVal = $jws->uncommonOptions();
$jws->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 = $jws->get_Utf8();
$jws->put_Utf8($boolVal);
When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.
topVerboseLogging
$boolVal = $jws->get_VerboseLogging();
$jws->put_VerboseLogging($boolVal);
If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
topVersion
Methods
CreateJws
Creates and returns the JWS containing one or more signatures according to the previously set payload, headers, and keys.
Returns 1 for success, 0 for failure.
CreateJwsSb
Creates and returns the JWS by appending it to the contents of sbJws.
Returns 1 for success, 0 for failure.
topGetPayload
# $outStr is a CkString (output)
$status = $jws->GetPayload($charset, $outStr);
$retStr = $jws->getPayload($charset);
Returns the JWS payload. The charset specifies the byte representation to be used in interpreting the bytes of the payload. (For example, "utf-8", "windows-1252", "utf-16", etc.)
Returns 1 for success, 0 for failure.
GetPayloadBd
GetPayloadSb
# $sbPayload is a CkStringBuilder
$status = $jws->GetPayloadSb($charset, $sbPayload);
Returns the JWS payload by appending it to the sbPayload. The charset specifies the byte representation to be used in interpreting the bytes of the payload. (For example, "utf-8", "windows-1252", "utf-16", etc.)
Returns 1 for success, 0 for failure.
topGetProtectedHeader
Returns the protected header for the Nth signature. The index is the index of the signature. The 1st signature is at index 0. In most cases, a JWS contains a single signature at index 0.
Returns null on failure
GetUnprotectedHeader
# $index is an integer
$ret_jsonObject = $jws->GetUnprotectedHeader($index);
Returns the optional unprotected header for the Nth signature. The index is the index of the signature. The 1st signature is at index 0. In most cases, a JWS contains a single signature at index 0.
Returns null on failure
topLoadJws
$status = $jws->LoadJws($jwsStr);
Loads a JWS contained in jwsStr.
Returns 1 for success, 0 for failure.
LoadJwsSb
Loads a JWS from the contents of sbJws.
Returns 1 for success, 0 for failure.
SetMacKey
# $key is a string
# $encoding is a string
$status = $jws->SetMacKey($index, $key, $encoding);
Sets the MAC key to be used for creating or validating a signature for the algorithms "HS256", "HS384", or "HS512". The key is an encoded string representation of the MAC key bytes. The encoding is an encoding, such as "base64url", "base64", "hex", etc. The 1st signature is at index 0. (Most JWSs only contain a single signature.)
Returns 1 for success, 0 for failure.
SetMacKeyBd
Sets the MAC key to be used for creating or validating a signature for the algorithms "HS256", "HS384", or "HS512". The key contains the binary bytes of the MAC key for the Nth signature. The 1st signature is at index 0.
Returns 1 for success, 0 for failure.
topSetPayload
# $charset is a string
# $includeBom is a boolean
$status = $jws->SetPayload($payload, $charset, $includeBom);
Sets the JWS payload from the contents of payload. The charset specifies the byte representation to be used for the string that is to be the payload. (For example, "utf-8", "windows-1252", "utf-16", etc.). If includeBom is 1, then the byte-order-mark (BOM), also known as preamble, if one exists for the given charset, is included in the payload. Normally, includeBom should be set to 0.
Returns 1 for success, 0 for failure.
SetPayloadBd
SetPayloadSb
# $charset is a string
# $includeBom is a boolean
$status = $jws->SetPayloadSb($sbPayload, $charset, $includeBom);
Sets the JWS payload from the contents of sbPayload. The charset specifies the byte representation to be used for the string that is to be the payload. (For example, "utf-8", "windows-1252", "utf-16", etc.). If includeBom is 1, then the byte-order-mark (BOM), also known as preamble, if one exists for the given charset, is included in the payload. Normally, includeBom should be set to 0.
Returns 1 for success, 0 for failure.
topSetPrivateKey
# $privKey is a CkPrivateKey
$status = $jws->SetPrivateKey($index, $privKey);
Sets the private key (ECC or RSA) to be used in creating a signature for the following algorithms:
RS256 RS384 RS512 ES256 ES384 ES512 PS256 PS384 PS512The JWS algorithms are described in RFC 7518, section 3.1. Here is a summary:
+--------------+-------------------------------+--------------------+ | "alg" Param | Digital Signature or MAC | Implementation | | Value | Algorithm | Requirements | +--------------+-------------------------------+--------------------+ | HS256 | HMAC using SHA-256 | Required | | HS384 | HMAC using SHA-384 | Optional | | HS512 | HMAC using SHA-512 | Optional | | RS256 | RSASSA-PKCS1-v1_5 using | Recommended | | | SHA-256 | | | RS384 | RSASSA-PKCS1-v1_5 using | Optional | | | SHA-384 | | | RS512 | RSASSA-PKCS1-v1_5 using | Optional | | | SHA-512 | | | ES256 | ECDSA using P-256 and SHA-256 | Recommended+ | | ES384 | ECDSA using P-384 and SHA-384 | Optional | | ES512 | ECDSA using P-521 and SHA-512 | Optional | | PS256 | RSASSA-PSS using SHA-256 and | Optional | | | MGF1 with SHA-256 | | | PS384 | RSASSA-PSS using SHA-384 and | Optional | | | MGF1 with SHA-384 | | | PS512 | RSASSA-PSS using SHA-512 and | Optional | | | MGF1 with SHA-512 | | | none | No digital signature or MAC | Optional | | | performed | | +--------------+-------------------------------+--------------------+
Returns 1 for success, 0 for failure.
topSetProtectedHeader
Sets a signature's protected header. The index is the index of the signature. The 1st signature is at index 0. In most cases, a JWS contains a single signature at index 0.
Returns 1 for success, 0 for failure.
SetPublicKey
Sets the public key (ECC or RSA) to be used in validating a signature for the following algorithms:
RS256 RS384 RS512 ES256 ES384 ES512 PS256 PS384 PS512
Returns 1 for success, 0 for failure.
topSetUnprotectedHeader
# $json is a CkJsonObject
$status = $jws->SetUnprotectedHeader($index, $json);
Sets a signature's optional unprotected header. The index is the index of the signature. The 1st signature is at index 0. In most cases, a JWS contains a single signature at index 0.
Returns 1 for success, 0 for failure.
topValidate
$retInt = $jws->Validate($index);
Validates the Nth signature or MAC using the Nth public key or MAC key.
Returns 1 if the signature was validated, thus verifying that the signer used the same MAC key or the matching private key.
Returns 0 if the incorrect public key or MAC key was provided.
Returns -1 for any other error, such as if no public key or MAC key was previously set for the given index.
Prior to calling this method, a program should provide the public key or MAC key via the SetPublicKey, SetMacKey, or SetMacKeyBd methods.