@salesforce/b2c-tooling-sdk 0.0.0-nightly.20260119053920

package/data/script-api/dw.crypto.JWS.md

@@ -0,0 +1,260 @@
+<!-- prettier-ignore-start -->
+# Class JWS
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.crypto.JWS](dw.crypto.JWS.md)
+
+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.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [algorithm](#algorithm): [String](TopLevel.String.md) `(read-only)` | Get the algorithm (`alg`) from the header. |
+| [header](#header): [JWSHeader](dw.crypto.JWSHeader.md) `(read-only)` | Get a copy of the JWS header. |
+| [headerMap](#headermap): [Map](dw.util.Map.md) `(read-only)` | Get a copy of the JWS header as a Map. |
+| [payload](#payload): [String](TopLevel.String.md) `(read-only)` | Get the payload from this object. |
+
+## Constructor Summary
+
+| Constructor | Description |
+| --- | --- |
+| [JWS](#jwsjwsheader-string)([JWSHeader](dw.crypto.JWSHeader.md), [String](TopLevel.String.md)) | Construct a new JWS for signing. |
+| [JWS](#jwsjwsheader-bytes)([JWSHeader](dw.crypto.JWSHeader.md), [Bytes](dw.util.Bytes.md)) | Construct a new JWS for signing. |
+
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getAlgorithm](dw.crypto.JWS.md#getalgorithm)() | Get the algorithm (`alg`) from the header. |
+| [getHeader](dw.crypto.JWS.md#getheader)() | Get a copy of the JWS header. |
+| [getHeaderMap](dw.crypto.JWS.md#getheadermap)() | Get a copy of the JWS header as a Map. |
+| [getPayload](dw.crypto.JWS.md#getpayload)() | Get the payload from this object. |
+| static [parse](dw.crypto.JWS.md#parsestring)([String](TopLevel.String.md)) | Parse a JSON Web Signature (JWS) object from its compact serialization format. |
+| static [parse](dw.crypto.JWS.md#parsestring-bytes)([String](TopLevel.String.md), [Bytes](dw.util.Bytes.md)) | Parse a JSON Web Signature (JWS) object from its compact serialization format. |
+| static [parse](dw.crypto.JWS.md#parsestring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Parse a JSON Web Signature (JWS) object from its compact serialization format. |
+| [serialize](dw.crypto.JWS.md#serializeboolean)([Boolean](TopLevel.Boolean.md)) | Get this JWS in compact serialization form. |
+| [sign](dw.crypto.JWS.md#signkeyref)([KeyRef](dw.crypto.KeyRef.md)) | Sign the payload using the given private key. |
+| [verify](dw.crypto.JWS.md#verifycertificateref)([CertificateRef](dw.crypto.CertificateRef.md)) | Verifies the signature of the payload. |
+
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Property Details
+
+### algorithm
+- algorithm: [String](TopLevel.String.md) `(read-only)`
+  - : Get the algorithm (`alg`) from the header.
+
+
+---
+
+### header
+- header: [JWSHeader](dw.crypto.JWSHeader.md) `(read-only)`
+  - : Get a copy of the JWS header.
+
+
+---
+
+### headerMap
+- headerMap: [Map](dw.util.Map.md) `(read-only)`
+  - : Get a copy of the JWS header as a Map.
+
+
+---
+
+### payload
+- payload: [String](TopLevel.String.md) `(read-only)`
+  - : Get the payload from this object.
+      
+      
+      This is available even if the signature has not been verified.
+
+
+
+---
+
+## Constructor Details
+
+### JWS(JWSHeader, String)
+- JWS(header: [JWSHeader](dw.crypto.JWSHeader.md), payload: [String](TopLevel.String.md))
+  - : Construct a new JWS for signing.
+
+    **Parameters:**
+    - header - JWS header. This must include a valid algorithm (`alg`). See      [verify(CertificateRef)](dw.crypto.JWS.md#verifycertificateref) for a list of supported algorithms.
+    - payload - Content that will be signed.
+
+
+---
+
+### JWS(JWSHeader, Bytes)
+- JWS(header: [JWSHeader](dw.crypto.JWSHeader.md), payload: [Bytes](dw.util.Bytes.md))
+  - : Construct a new JWS for signing.
+
+    **Parameters:**
+    - header - JWS header. This must include a valid algorithm (`alg`). See      [verify(CertificateRef)](dw.crypto.JWS.md#verifycertificateref) for a list of supported algorithms.
+    - payload - Content that will be signed.
+
+
+---
+
+## Method Details
+
+### getAlgorithm()
+- getAlgorithm(): [String](TopLevel.String.md)
+  - : Get the algorithm (`alg`) from the header.
+
+    **Returns:**
+    - Value of the algorithm or null if missing.
+
+
+---
+
+### getHeader()
+- getHeader(): [JWSHeader](dw.crypto.JWSHeader.md)
+  - : Get a copy of the JWS header.
+
+    **Returns:**
+    - Copy of the JWS header.
+
+
+---
+
+### getHeaderMap()
+- getHeaderMap(): [Map](dw.util.Map.md)
+  - : Get a copy of the JWS header as a Map.
+
+    **Returns:**
+    - Copy of the JWS header.
+
+
+---
+
+### getPayload()
+- getPayload(): [String](TopLevel.String.md)
+  - : Get the payload from this object.
+      
+      
+      This is available even if the signature has not been verified.
+
+
+    **Returns:**
+    - UTF-8 encoded payload.
+
+
+---
+
+### parse(String)
+- static parse(jws: [String](TopLevel.String.md)): [JWS](dw.crypto.JWS.md)
+  - : Parse a JSON Web Signature (JWS) object from its compact serialization format.
+
+    **Parameters:**
+    - jws - JWS in compact serialization format.
+
+    **Returns:**
+    - JWS object.
+
+
+---
+
+### parse(String, Bytes)
+- static parse(jws: [String](TopLevel.String.md), payload: [Bytes](dw.util.Bytes.md)): [JWS](dw.crypto.JWS.md)
+  - : 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(String, String)
+- static parse(jws: [String](TopLevel.String.md), payload: [String](TopLevel.String.md)): [JWS](dw.crypto.JWS.md)
+  - : 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(Boolean)
+- serialize(detachPayload: [Boolean](TopLevel.Boolean.md)): [String](TopLevel.String.md)
+  - : 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(KeyRef)
+- sign(keyRef: [KeyRef](dw.crypto.KeyRef.md)): void
+  - : 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(CertificateRef)
+- verify(certificateRef: [CertificateRef](dw.crypto.CertificateRef.md)): [Boolean](TopLevel.Boolean.md)
+  - : 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.
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.crypto.JWSHeader.md

@@ -0,0 +1,128 @@
+<!-- prettier-ignore-start -->
+# Class JWSHeader
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.crypto.JWSHeader](dw.crypto.JWSHeader.md)
+
+This class represents an immutable header of a JWS (JSON Web Signature) object.
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [algorithm](#algorithm): [String](TopLevel.String.md) `(read-only)` | Get the value of the algorithm parameter (`alg`). |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getAlgorithm](dw.crypto.JWSHeader.md#getalgorithm)() | Get the value of the algorithm parameter (`alg`). |
+| static [parse](dw.crypto.JWSHeader.md#parseobject)([Object](TopLevel.Object.md)) | Convert the given Map or JavaScript object into a JWS header. |
+| static [parseEncoded](dw.crypto.JWSHeader.md#parseencodedstring)([String](TopLevel.String.md)) | Parse the given string as a Base64URL-encoded JWS header. |
+| static [parseJSON](dw.crypto.JWSHeader.md#parsejsonstring)([String](TopLevel.String.md)) | Parse the given string as a JWS header. |
+| [toMap](dw.crypto.JWSHeader.md#tomap)() | Get a copy of these headers as a Map. |
+| [toString](dw.crypto.JWSHeader.md#tostring)() | Get the content of the headers as a JSON String. |
+
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Property Details
+
+### algorithm
+- algorithm: [String](TopLevel.String.md) `(read-only)`
+  - : Get the value of the algorithm parameter (`alg`).
+
+
+---
+
+## Method Details
+
+### getAlgorithm()
+- getAlgorithm(): [String](TopLevel.String.md)
+  - : Get the value of the algorithm parameter (`alg`).
+
+    **Returns:**
+    - Algorithm parameter from this header.
+
+
+---
+
+### parse(Object)
+- static parse(map: [Object](TopLevel.Object.md)): [JWSHeader](dw.crypto.JWSHeader.md)
+  - : 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)](dw.crypto.JWS.md#verifycertificateref) for supported values.
+
+
+    **Parameters:**
+    - map - Map or object data to convert.
+
+    **Returns:**
+    - JWS Header.
+
+
+---
+
+### parseEncoded(String)
+- static parseEncoded(base64encoded: [String](TopLevel.String.md)): [JWSHeader](dw.crypto.JWSHeader.md)
+  - : Parse the given string as a Base64URL-encoded JWS header.
+      
+      
+      The algorithm parameter (`alg`) is required. See [JWS.verify(CertificateRef)](dw.crypto.JWS.md#verifycertificateref) for supported
+      values.
+
+
+    **Parameters:**
+    - base64encoded - Base64URL string to parse.
+
+    **Returns:**
+    - JWS Header.
+
+
+---
+
+### parseJSON(String)
+- static parseJSON(json: [String](TopLevel.String.md)): [JWSHeader](dw.crypto.JWSHeader.md)
+  - : Parse the given string as a JWS header.
+      
+      
+      The algorithm parameter (`alg`) is required. See [JWS.verify(CertificateRef)](dw.crypto.JWS.md#verifycertificateref) for supported
+      values.
+
+
+    **Parameters:**
+    - json - JSON string to parse.
+
+    **Returns:**
+    - JWS Header.
+
+
+---
+
+### toMap()
+- toMap(): [Map](dw.util.Map.md)
+  - : Get a copy of these headers as a Map.
+
+    **Returns:**
+    - Copy of the JWS headers.
+
+
+---
+
+### toString()
+- toString(): [String](TopLevel.String.md)
+  - : Get the content of the headers as a JSON String.
+
+    **Returns:**
+    - JSON String.
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.crypto.KeyRef.md

@@ -0,0 +1,77 @@
+<!-- prettier-ignore-start -->
+# Class KeyRef
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.crypto.KeyRef](dw.crypto.KeyRef.md)
+
+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
+
+| Constructor | Description |
+| --- | --- |
+| [KeyRef](#keyrefstring)([String](TopLevel.String.md)) | Creates a `KeyRef` from the passed alias. |
+| ~~[KeyRef](#keyrefstring-string)([String](TopLevel.String.md), [String](TopLevel.String.md))~~ | Creates a `KeyRef` from the passed alias. |
+
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [toString](dw.crypto.KeyRef.md#tostring)() | Returns the string representation of this KeyRef. |
+
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Constructor Details
+
+### KeyRef(String)
+- KeyRef(alias: [String](TopLevel.String.md))
+  - : Creates a `KeyRef` from the passed alias. No check
+      is made whether the alias is actually referring to a key in the keystore,
+      this check is made when the `KeyRef` is used.
+
+
+    **Parameters:**
+    - alias - an alias that should refer to a key in the keystore.
+
+
+---
+
+### KeyRef(String, String)
+- ~~KeyRef(alias: [String](TopLevel.String.md), password: [String](TopLevel.String.md))~~
+  - : Creates a `KeyRef` from the passed alias. No check
+      is made whether the alias is actually referring to a key in the keystore,
+      this check is made when the `KeyRef` is used.
+
+
+    **Parameters:**
+    - alias - an alias that should refer to a key in the keystore.
+    - password - the password that should be used to get the key from the keystore.
+
+    **Deprecated:**
+:::warning
+use [KeyRef(String)](dw.crypto.KeyRef.md#keyrefstring) instead
+:::
+
+---
+
+## Method Details
+
+### toString()
+- toString(): [String](TopLevel.String.md)
+  - : Returns the string representation of this KeyRef.
+
+    **Returns:**
+    - The string representation of this KeyRef.
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.crypto.Mac.md

@@ -0,0 +1,191 @@
+<!-- prettier-ignore-start -->
+# Class Mac
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.crypto.Mac](dw.crypto.Mac.md)
+
+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.
+
+
+
+## Constant Summary
+
+| Constant | Description |
+| --- | --- |
+| ~~[HMAC_MD5](#hmac_md5): [String](TopLevel.String.md) = "HmacMD5"~~ | Constant representing the HMAC-MD5 keyed-hashing algorithm as defined in RFC 2104 "HMAC: Keyed-Hashing for Message Authentication" (February 1997). |
+| ~~[HMAC_SHA_1](#hmac_sha_1): [String](TopLevel.String.md) = "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](#hmac_sha_256): [String](TopLevel.String.md) = "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](#hmac_sha_384): [String](TopLevel.String.md) = "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](#hmac_sha_512): [String](TopLevel.String.md) = "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. |
+
+## Constructor Summary
+
+| Constructor | Description |
+| --- | --- |
+| [Mac](#macstring)([String](TopLevel.String.md)) | Construct a Mac encryption instance with the specified algorithm name. |
+
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [digest](dw.crypto.Mac.md#digestbytes-bytes)([Bytes](dw.util.Bytes.md), [Bytes](dw.util.Bytes.md)) | Computes the hash value for the passed bytes input using the passed secret key. |
+| [digest](dw.crypto.Mac.md#digeststring-bytes)([String](TopLevel.String.md), [Bytes](dw.util.Bytes.md)) | Computes the hash value for the passed string input using the passed secret key. |
+| [digest](dw.crypto.Mac.md#digeststring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Computes the hash value for the passed string input using the passed secret key. |
+
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Constant Details
+
+### HMAC_MD5
+
+- ~~HMAC_MD5: [String](TopLevel.String.md) = "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.
+
+
+    **Deprecated:**
+:::warning
+This algorithm is obsolete and and has been deprecated. Please use HmacSHA256, HmacSHA384 or HmacSHA512.
+:::
+
+---
+
+### HMAC_SHA_1
+
+- ~~HMAC_SHA_1: [String](TopLevel.String.md) = "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.
+
+
+    **Deprecated:**
+:::warning
+This algorithm is obsolete and and has been deprecated. Please use HmacSHA256, HmacSHA384 or HmacSHA512.
+:::
+
+---
+
+### HMAC_SHA_256
+
+- HMAC_SHA_256: [String](TopLevel.String.md) = "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
+
+- HMAC_SHA_384: [String](TopLevel.String.md) = "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
+
+- HMAC_SHA_512: [String](TopLevel.String.md) = "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.
+
+
+
+---
+
+## Constructor Details
+
+### Mac(String)
+- Mac(algorithm: [String](TopLevel.String.md))
+  - : Construct a Mac encryption instance with the specified algorithm name. The
+      supported algorithms are:
+      
+      
+      - SHA 256
+      - SHA 384
+      - SHA 512
+
+
+    **Parameters:**
+    - algorithm - the standard name of the digest algorithm, must not be             null.
+
+    **Throws:**
+    - NullArgumentException - if algorithm is null.
+    - IllegalArgumentException - if the specified algorithm name is not              supported.
+
+
+---
+
+## Method Details
+
+### digest(Bytes, Bytes)
+- digest(input: [Bytes](dw.util.Bytes.md), key: [Bytes](dw.util.Bytes.md)): [Bytes](dw.util.Bytes.md)
+  - : 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.
+
+
+---
+
+### digest(String, Bytes)
+- digest(input: [String](TopLevel.String.md), key: [Bytes](dw.util.Bytes.md)): [Bytes](dw.util.Bytes.md)
+  - : 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(String, String)
+- digest(input: [String](TopLevel.String.md), key: [String](TopLevel.String.md)): [Bytes](dw.util.Bytes.md)
+  - : 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.
+
+
+---
+
+<!-- prettier-ignore-end -->