sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_crypto/JWS.md

@@ -1,264 +0,0 @@
-## Package: dw.crypto
-
-# Class JWS
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.crypto.JWS
-
-## Description
-
-This class represents a JSON Web Signature (JWS) object. Note: this class handles sensitive security-related data. Pay special attention to PCI DSS v3 requirements 2, 4, and 12.
-
-## Properties
-
-### algorithm
-
-**Type:** String (Read Only)
-
-Get the algorithm (alg) from the header.
-
-### header
-
-**Type:** JWSHeader (Read Only)
-
-Get a copy of the JWS header.
-
-### headerMap
-
-**Type:** Map (Read Only)
-
-Get a copy of the JWS header as a Map.
-
-### payload
-
-**Type:** String (Read Only)
-
-Get the payload from this object.
- 
- This is available even if the signature has not been verified.
-
-## Constructor Summary
-
-JWS(header : JWSHeader, payload : String) Construct a new JWS for signing.
-
-JWS(header : JWSHeader, payload : Bytes) Construct a new JWS for signing.
-
-## Method Summary
-
-### getAlgorithm
-
-**Signature:** `getAlgorithm() : String`
-
-Get the algorithm (alg) from the header.
-
-### getHeader
-
-**Signature:** `getHeader() : JWSHeader`
-
-Get a copy of the JWS header.
-
-### getHeaderMap
-
-**Signature:** `getHeaderMap() : Map`
-
-Get a copy of the JWS header as a Map.
-
-### getPayload
-
-**Signature:** `getPayload() : String`
-
-Get the payload from this object.
-
-### parse
-
-**Signature:** `static parse(jws : String) : JWS`
-
-Parse a JSON Web Signature (JWS) object from its compact serialization format.
-
-### parse
-
-**Signature:** `static parse(jws : String, payload : String) : JWS`
-
-Parse a JSON Web Signature (JWS) object from its compact serialization format.
-
-### parse
-
-**Signature:** `static parse(jws : String, payload : Bytes) : JWS`
-
-Parse a JSON Web Signature (JWS) object from its compact serialization format.
-
-### serialize
-
-**Signature:** `serialize(detachPayload : boolean) : String`
-
-Get this JWS in compact serialization form.
-
-### sign
-
-**Signature:** `sign(keyRef : KeyRef) : void`
-
-Sign the payload using the given private key.
-
-### verify
-
-**Signature:** `verify(certificateRef : CertificateRef) : boolean`
-
-Verifies the signature of the payload.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### getAlgorithm
-
-**Signature:** `getAlgorithm() : String`
-
-**Description:** Get the algorithm (alg) from the header.
-
-**Returns:**
-
-Value of the algorithm or null if missing.
-
----
-
-### getHeader
-
-**Signature:** `getHeader() : JWSHeader`
-
-**Description:** Get a copy of the JWS header.
-
-**Returns:**
-
-Copy of the JWS header.
-
----
-
-### getHeaderMap
-
-**Signature:** `getHeaderMap() : Map`
-
-**Description:** Get a copy of the JWS header as a Map.
-
-**Returns:**
-
-Copy of the JWS header.
-
----
-
-### getPayload
-
-**Signature:** `getPayload() : String`
-
-**Description:** Get the payload from this object. This is available even if the signature has not been verified.
-
-**Returns:**
-
-UTF-8 encoded payload.
-
----
-
-### parse
-
-**Signature:** `static parse(jws : String) : JWS`
-
-**Description:** Parse a JSON Web Signature (JWS) object from its compact serialization format.
-
-**Parameters:**
-
-- `jws`: JWS in compact serialization format.
-
-**Returns:**
-
-JWS object.
-
----
-
-### parse
-
-**Signature:** `static parse(jws : String, payload : String) : JWS`
-
-**Description:** Parse a JSON Web Signature (JWS) object from its compact serialization format.
-
-**Parameters:**
-
-- `jws`: JWS without a payload in compact serialization format.
-- `payload`: Detached payload
-
-**Returns:**
-
-JWS object.
-
----
-
-### parse
-
-**Signature:** `static parse(jws : String, payload : Bytes) : JWS`
-
-**Description:** Parse a JSON Web Signature (JWS) object from its compact serialization format.
-
-**Parameters:**
-
-- `jws`: JWS without a payload in compact serialization format.
-- `payload`: Detached payload
-
-**Returns:**
-
-JWS object.
-
----
-
-### serialize
-
-**Signature:** `serialize(detachPayload : boolean) : String`
-
-**Description:** Get this JWS in compact serialization form.
-
-**Parameters:**
-
-- `detachPayload`: true for a detached payload compliant with RFC-7797, or false to serialize the payload too.
-
-**Returns:**
-
-Compact serialized object.
-
----
-
-### sign
-
-**Signature:** `sign(keyRef : KeyRef) : void`
-
-**Description:** Sign the payload using the given private key. The key type and size must match the algorithm given in the JWS header.
-
-**Parameters:**
-
-- `keyRef`: Reference to the private key.
-
-**Throws:**
-
-Exception - if there is an error while signing the payload.
-
----
-
-### verify
-
-**Signature:** `verify(certificateRef : CertificateRef) : boolean`
-
-**Description:** Verifies the signature of the payload. If the x5c header parameter is present, then that certificate chain will be used to verify the signature and the given certificateRef must be its root certificate. If this parameter is not present then the given certificateRef will be used to directly verify the signature. The following algorithms are supported: ES256 ES256K ES384 ES512 RS256 RS384 RS512 PS256 PS384 PS512
-
-**Parameters:**
-
-- `certificateRef`: Reference to the certificate to use for verification.
-
-**Returns:**
-
-a boolean indicating success (true) or failure (false).
-
-**Throws:**
-
-Exception - if there is an error while processing the certificate (for example if the x5c is not signed by the given certificate) or the algorithm is unsupported.
-
----

package/docs/dw_crypto/JWSHeader.md

@@ -1,148 +0,0 @@
-## Package: dw.crypto
-
-# Class JWSHeader
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.crypto.JWSHeader
-
-## Description
-
-This class represents an immutable header of a JWS (JSON Web Signature) object.
-
-## Properties
-
-### algorithm
-
-**Type:** String (Read Only)
-
-Get the value of the algorithm parameter (alg).
-
-## Constructor Summary
-
-## Method Summary
-
-### getAlgorithm
-
-**Signature:** `getAlgorithm() : String`
-
-Get the value of the algorithm parameter (alg).
-
-### parse
-
-**Signature:** `static parse(map : Object) : JWSHeader`
-
-Convert the given Map or JavaScript object into a JWS header.
-
-### parseEncoded
-
-**Signature:** `static parseEncoded(base64encoded : String) : JWSHeader`
-
-Parse the given string as a Base64URL-encoded JWS header.
-
-### parseJSON
-
-**Signature:** `static parseJSON(json : String) : JWSHeader`
-
-Parse the given string as a JWS header.
-
-### toMap
-
-**Signature:** `toMap() : Map`
-
-Get a copy of these headers as a Map.
-
-### toString
-
-**Signature:** `toString() : String`
-
-Get the content of the headers as a JSON String.
-
-## Method Detail
-
-## Method Details
-
-### getAlgorithm
-
-**Signature:** `getAlgorithm() : String`
-
-**Description:** Get the value of the algorithm parameter (alg).
-
-**Returns:**
-
-Algorithm parameter from this header.
-
----
-
-### parse
-
-**Signature:** `static parse(map : Object) : JWSHeader`
-
-**Description:** Convert the given Map or JavaScript object into a JWS header. All keys correspond to JWS parameters. The algorithm parameter (alg) is required. See JWS.verify(CertificateRef) for supported values.
-
-**Parameters:**
-
-- `map`: Map or object data to convert.
-
-**Returns:**
-
-JWS Header.
-
----
-
-### parseEncoded
-
-**Signature:** `static parseEncoded(base64encoded : String) : JWSHeader`
-
-**Description:** Parse the given string as a Base64URL-encoded JWS header. The algorithm parameter (alg) is required. See JWS.verify(CertificateRef) for supported values.
-
-**Parameters:**
-
-- `base64encoded`: Base64URL string to parse.
-
-**Returns:**
-
-JWS Header.
-
----
-
-### parseJSON
-
-**Signature:** `static parseJSON(json : String) : JWSHeader`
-
-**Description:** Parse the given string as a JWS header. The algorithm parameter (alg) is required. See JWS.verify(CertificateRef) for supported values.
-
-**Parameters:**
-
-- `json`: JSON string to parse.
-
-**Returns:**
-
-JWS Header.
-
----
-
-### toMap
-
-**Signature:** `toMap() : Map`
-
-**Description:** Get a copy of these headers as a Map.
-
-**Returns:**
-
-Copy of the JWS headers.
-
----
-
-### toString
-
-**Signature:** `toString() : String`
-
-**Description:** Get the content of the headers as a JSON String.
-
-**Returns:**
-
-JSON String.
-
----

package/docs/dw_crypto/KeyRef.md

@@ -1,44 +0,0 @@
-## Package: dw.crypto
-
-# Class KeyRef
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.crypto.KeyRef
-
-## Description
-
-This class is used as a reference to a private key in the keystore which can be managed in the Business Manager. Note: this class handles sensitive security-related data. Pay special attention to PCI DSS v3. requirements 2, 4, and 12.
-
-## Constructor Summary
-
-KeyRef(alias : String) Creates a KeyRef from the passed alias.
-
-KeyRef(alias : String, password : String) Creates a KeyRef from the passed alias.
-
-## Method Summary
-
-### toString
-
-**Signature:** `toString() : String`
-
-Returns the string representation of this KeyRef.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### toString
-
-**Signature:** `toString() : String`
-
-**Description:** Returns the string representation of this KeyRef.
-
-**Returns:**
-
-The string representation of this KeyRef.
-
----

package/docs/dw_crypto/Mac.md

@@ -1,139 +0,0 @@
-## Package: dw.crypto
-
-# Class Mac
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.crypto.Mac
-
-## Description
-
-This class provides the functionality of a "Message Authentication Code" (MAC) algorithm. A MAC provides a way to check the integrity of information transmitted over or stored in an unreliable medium, based on a secret key. Typically, message authentication codes are used between two parties that share a secret key in order to validate information transmitted between these parties. A MAC mechanism that is based on cryptographic hash functions is referred to as HMAC. HMAC can be used with any cryptographic hash function, e.g., SHA256, in combination with a secret shared key. HMAC is specified in RFC 2104. Note: this class handles sensitive security-related data. Pay special attention to PCI DSS v3. requirements 2, 4, and 12.
-
-## Constants
-
-### HMAC_MD5
-
-**Type:** String = "HmacMD5"
-
-Constant representing the HMAC-MD5 keyed-hashing algorithm as defined in RFC 2104 "HMAC: Keyed-Hashing for Message Authentication" (February 1997). This algorithm uses as MD5 cryptographic hash function.
-
-### HMAC_SHA_1
-
-**Type:** String = "HmacSHA1"
-
-Constant representing the HmacSHA1 algorithms as defined in RFC 2104 "HMAC: Keyed-Hashing for Message Authentication" (February 1997) with SHA-1 as the message digest algorithm.
-
-### HMAC_SHA_256
-
-**Type:** String = "HmacSHA256"
-
-Constant representing the HmacSHA256 algorithms as defined in RFC 2104 "HMAC: Keyed-Hashing for Message Authentication" (February 1997) with SHA-256 as the message digest algorithm.
-
-### HMAC_SHA_384
-
-**Type:** String = "HmacSHA384"
-
-Constant representing the HmacSHA384 algorithms as defined in RFC 2104 "HMAC: Keyed-Hashing for Message Authentication" (February 1997) with SHA-384 as the message digest algorithm.
-
-### HMAC_SHA_512
-
-**Type:** String = "HmacSHA512"
-
-Constant representing the HmacSHA512 algorithms as defined in RFC 2104 "HMAC: Keyed-Hashing for Message Authentication" (February 1997) with SHA-512 as the message digest algorithm.
-
-## Properties
-
-## Constructor Summary
-
-Mac(algorithm : String) Construct a Mac encryption instance with the specified algorithm name.
-
-## Method Summary
-
-### digest
-
-**Signature:** `digest(input : String, key : String) : Bytes`
-
-Computes the hash value for the passed string input using the passed secret key.
-
-### digest
-
-**Signature:** `digest(input : String, key : Bytes) : Bytes`
-
-Computes the hash value for the passed string input using the passed secret key.
-
-### digest
-
-**Signature:** `digest(input : Bytes, key : Bytes) : Bytes`
-
-Computes the hash value for the passed bytes input using the passed secret key.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### digest
-
-**Signature:** `digest(input : String, key : String) : Bytes`
-
-**Description:** Computes the hash value for the passed string input using the passed secret key. Given input and the given key will be first converted with UTF-8 encoding into a byte array. The resulting hash is typically converted with base64 back into a string.
-
-**Parameters:**
-
-- `input`: A string to calculate a RFC 2104 compliant HMAC hash value for.
-- `key`: The secret key ready for use with the algorithm. The key's format depends on the chosen algorithm and the keys are assumed to be correctly formulated for the algorithm used, for example that the lengths are correct. Keys are not checked for validity. Only such keys that have no key parameters associated with them.
-
-**Returns:**
-
-The resulting hash value as bytes.
-
-**Throws:**
-
-IllegalArgumentException - if algorithm is not null and the specified algorithm name is not supported.
-
----
-
-### digest
-
-**Signature:** `digest(input : String, key : Bytes) : Bytes`
-
-**Description:** Computes the hash value for the passed string input using the passed secret key. Given input will be first converted with UTF-8 encoding into a byte array. The resulting hash is typically converted with base64 back into a string.
-
-**Parameters:**
-
-- `input`: A string to calculate a RFC 2104 compliant HMAC hash value for.
-- `key`: The secret key as bytes ready for use with the algorithm. The key's format depends on the chosen algorithm and the keys are assumed to be correctly formulated for the algorithm used, for example that the lengths are correct. Keys are not checked for validity. Only such keys that have no key parameters associated with them.
-
-**Returns:**
-
-The resulting hash value as bytes.
-
-**Throws:**
-
-IllegalArgumentException - if algorithm is not null and the specified algorithm name is not supported.
-
----
-
-### digest
-
-**Signature:** `digest(input : Bytes, key : Bytes) : Bytes`
-
-**Description:** Computes the hash value for the passed bytes input using the passed secret key.
-
-**Parameters:**
-
-- `input`: The bytes to calculate a RFC 2104 compliant HMAC hash value.
-- `key`: The secret key as byte array ready for use with the algorithm. The key's format depends on the chosen algorithm and the keys are assumed to be correctly formulated for the algorithm used, for example that the lengths are correct. Keys are not checked for validity. Only such keys that have no key parameters associated with them.
-
-**Returns:**
-
-The resulting hash value as bytes.
-
-**Throws:**
-
-IllegalArgumentException - if algorithm is not null and the specified algorithm name is not supported.
-
----