@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.2

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

@@ -0,0 +1,163 @@
+<!-- prettier-ignore-start -->
+# Class WeakMac
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.crypto.WeakMac](dw.crypto.WeakMac.md)
+
+This API provides access to Deprecated algorithms.
+
+
+See [Mac](dw.crypto.Mac.md) for full documentation. WeakMac is simply a drop-in replacement that **only** supports
+deprecated algorithms. This is helpful when you need to deal with weak algorithms for backward
+compatibility purposes, but Mac should always be used for new development and for anything intended to be secure.
+
+
+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. |
+
+## Constructor Summary
+
+| Constructor | Description |
+| --- | --- |
+| [WeakMac](#weakmacstring)([String](TopLevel.String.md)) | Construct a Mac encryption instance with the specified algorithm name. |
+
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [digest](dw.crypto.WeakMac.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.WeakMac.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.WeakMac.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.
+      
+      
+      This algorithm is obsolete. Do not use it for any sensitive data
+
+
+
+---
+
+### 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.
+      
+      
+      This algorithm is obsolete. Do not use it for any sensitive data
+
+
+
+---
+
+## Constructor Details
+
+### WeakMac(String)
+- WeakMac(algorithm: [String](TopLevel.String.md))
+  - : Construct a Mac encryption instance with the specified algorithm name. The
+      supported algorithms are:
+      
+      
+      - HmacMD5
+      - HmacSHA1
+
+
+    **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 -->

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

@@ -0,0 +1,220 @@
+<!-- prettier-ignore-start -->
+# Class WeakMessageDigest
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.crypto.WeakMessageDigest](dw.crypto.WeakMessageDigest.md)
+
+This API provides access to Deprecated algorithms.
+
+
+See [MessageDigest](dw.crypto.MessageDigest.md) for full documentation. WeakMessageDigest is simply a drop-in replacement that **only** supports
+deprecated algorithms. This is helpful when you need to deal with weak algorithms for backward
+compatibility purposes, but MessageDigest should always be used for new development and for anything intended to be secure.
+
+
+**Note:** this class handles sensitive security-related data.
+Pay special attention to PCI DSS v3. requirements 2, 4, and 12.
+
+
+
+## Constant Summary
+
+| Constant | Description |
+| --- | --- |
+| [DIGEST_MD2](#digest_md2): [String](TopLevel.String.md) = "MD2" | Constant representing the MD2 algorithm. |
+| [DIGEST_MD5](#digest_md5): [String](TopLevel.String.md) = "MD5" | Constant representing the MD5 algorithm. |
+| [DIGEST_SHA](#digest_sha): [String](TopLevel.String.md) = "SHA" | Constant representing the SHA algorithm. |
+| [DIGEST_SHA_1](#digest_sha_1): [String](TopLevel.String.md) = "SHA-1" | Constant representing the SHA 1 algorithm. |
+
+## Constructor Summary
+
+| Constructor | Description |
+| --- | --- |
+| [WeakMessageDigest](#weakmessagedigeststring)([String](TopLevel.String.md)) | Construct a MessageDigest with the specified algorithm name. |
+
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [digest](dw.crypto.WeakMessageDigest.md#digest)() | Completes the hash computation by performing final operations such as  padding. |
+| ~~[digest](dw.crypto.WeakMessageDigest.md#digeststring)([String](TopLevel.String.md))~~ | Digests the passed string and returns a computed hash value as a string. |
+| ~~[digest](dw.crypto.WeakMessageDigest.md#digeststring-bytes)([String](TopLevel.String.md), [Bytes](dw.util.Bytes.md))~~ | Computes the hash value for the passed array of bytes. |
+| [digestBytes](dw.crypto.WeakMessageDigest.md#digestbytesbytes)([Bytes](dw.util.Bytes.md)) | Computes the hash value for the passed [Bytes](dw.util.Bytes.md). |
+| [updateBytes](dw.crypto.WeakMessageDigest.md#updatebytesbytes)([Bytes](dw.util.Bytes.md)) | Updates the digest using the passed [Bytes](dw.util.Bytes.md). |
+
+### 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
+
+### DIGEST_MD2
+
+- DIGEST_MD2: [String](TopLevel.String.md) = "MD2"
+  - : Constant representing the MD2 algorithm.
+      
+      
+      This algorithm is obsolete. Do not use it for any sensitive data
+
+
+
+---
+
+### DIGEST_MD5
+
+- DIGEST_MD5: [String](TopLevel.String.md) = "MD5"
+  - : Constant representing the MD5 algorithm.
+      
+      
+      This algorithm is obsolete. Do not use it for any sensitive data
+
+
+
+---
+
+### DIGEST_SHA
+
+- DIGEST_SHA: [String](TopLevel.String.md) = "SHA"
+  - : Constant representing the SHA algorithm.
+      
+      
+      This algorithm is obsolete. Do not use it for any sensitive data
+
+
+
+---
+
+### DIGEST_SHA_1
+
+- DIGEST_SHA_1: [String](TopLevel.String.md) = "SHA-1"
+  - : Constant representing the SHA 1 algorithm.
+      
+      
+      This algorithm is obsolete. Do not use it for any sensitive data
+
+
+
+---
+
+## Constructor Details
+
+### WeakMessageDigest(String)
+- WeakMessageDigest(algorithm: [String](TopLevel.String.md))
+  - : Construct a MessageDigest with the specified algorithm name.
+
+    **Parameters:**
+    - algorithm - The standard name of the digest algorithm, must not be         null and must be a supported algorithm.
+
+
+---
+
+## Method Details
+
+### digest()
+- digest(): [Bytes](dw.util.Bytes.md)
+  - : Completes the hash computation by performing final operations such as
+      padding.
+      
+      The binary representation of the message is typically derived from a
+      string and the resulting hash is typically converted with base64 back
+      into a string. Example:
+      
+      `
+       Encoding.toBase64( digest() );
+       `
+
+
+    **Returns:**
+    - The resulting hash value.
+
+
+---
+
+### digest(String)
+- ~~digest(input: [String](TopLevel.String.md)): [String](TopLevel.String.md)~~
+  - : Digests the passed string and returns a computed hash value as a string.
+      The passed String is first encoded into a sequence of bytes using the
+      platform's default encoding. The digest then performs any prerequisite
+      padding, before computing the hash value. The hash is then converted into
+      a string by converting all digits to hexadecimal.
+
+
+    **Parameters:**
+    - input - The value to hash as String, must not be null.
+
+    **Returns:**
+    - The resulting hash value as hex-encoded string.
+
+    **Deprecated:**
+:::warning
+Deprecated because the conversion of the input to bytes using
+            the default platform encoding and the hex-encoded return
+            value are not generally appropriate.
+
+:::
+
+---
+
+### digest(String, Bytes)
+- ~~digest(algorithm: [String](TopLevel.String.md), input: [Bytes](dw.util.Bytes.md)): [Bytes](dw.util.Bytes.md)~~
+  - : Computes the hash value for the passed array of bytes. The algorithm
+      argument is optional. If null, then the algorithm established at
+      construction time is used.
+      
+      The binary representation of the message is typically derived from a
+      string and the resulting hash is typically converted with base64 back
+      into a string. Example:
+      
+      `
+       Encoding.toBase64( digest( "MD5", new Bytes( "my password", "UTF-8" ) ) );
+       `
+
+
+    **Parameters:**
+    - algorithm - The standard name of the digest algorithm, or null if             the algorithm passed at construction time is to be used.             The algorithm must be a supported algorithm.
+    - input - The value to hash, must not be null.
+
+    **Returns:**
+    - The resulting hash value.
+
+    **Deprecated:**
+:::warning
+Deprecated because the digest algorithm should be the one
+            set in the constructor.
+
+:::
+
+---
+
+### digestBytes(Bytes)
+- digestBytes(input: [Bytes](dw.util.Bytes.md)): [Bytes](dw.util.Bytes.md)
+  - : Computes the hash value for the passed [Bytes](dw.util.Bytes.md).
+      
+      The binary representation of the message is typically derived from a
+      string and the resulting hash is typically converted with base64 back
+      into a string. Example:
+      
+      `
+       Encoding.toBase64( digest( new Bytes( "my password", "UTF-8" ) ) );
+       `
+
+
+    **Parameters:**
+    - input - The value to hash, must not be null.
+
+    **Returns:**
+    - The resulting hash value.
+
+
+---
+
+### updateBytes(Bytes)
+- updateBytes(input: [Bytes](dw.util.Bytes.md)): void
+  - : Updates the digest using the passed [Bytes](dw.util.Bytes.md).
+
+    **Parameters:**
+    - input - The value to hash, must not be null.
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,208 @@
+<!-- prettier-ignore-start -->
+# Class WeakSignature
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.crypto.WeakSignature](dw.crypto.WeakSignature.md)
+
+This API provides access to Deprecated algorithms.
+
+
+See [Signature](dw.crypto.Signature.md) for full documentation. WeakSignature is simply a drop-in replacement that **only** supports
+deprecated algorithms. This is helpful when you need to deal with weak algorithms for backward compatibility
+purposes, but Signature should always be used for new development and for anything intended to be secure.
+
+
+
+
+This class allows access to signature services offered through the Java Cryptography Architecture (JCA). At this time
+the signature/verification implementation of the methods is based on the default RSA JCE provider of the JDK -
+sun.security.rsa.SunRsaSign
+
+
+
+
+dw.crypto.WeakSignature is an adapter to the security provider implementation and only covers one digest algorithm:
+
+- SHA1withRSA
+
+
+
+
+
+**Note:** this class handles sensitive security-related data. Pay special attention to PCI DSS v3. requirements 2,
+4, 12, and other relevant requirements.
+
+
+
+## Constructor Summary
+
+| Constructor | Description |
+| --- | --- |
+| [WeakSignature](#weaksignature)() |  |
+
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [isDigestAlgorithmSupported](dw.crypto.WeakSignature.md#isdigestalgorithmsupportedstring)([String](TopLevel.String.md)) | Checks to see if a digest algorithm is supported |
+| [sign](dw.crypto.WeakSignature.md#signstring-keyref-string)([String](TopLevel.String.md), [KeyRef](dw.crypto.KeyRef.md), [String](TopLevel.String.md)) | Signs a string and returns a string |
+| [sign](dw.crypto.WeakSignature.md#signstring-string-string)([String](TopLevel.String.md), [String](TopLevel.String.md), [String](TopLevel.String.md)) | Signs a string and returns a string |
+| [signBytes](dw.crypto.WeakSignature.md#signbytesbytes-keyref-string)([Bytes](dw.util.Bytes.md), [KeyRef](dw.crypto.KeyRef.md), [String](TopLevel.String.md)) | Signs bytes and returns bytes |
+| [signBytes](dw.crypto.WeakSignature.md#signbytesbytes-string-string)([Bytes](dw.util.Bytes.md), [String](TopLevel.String.md), [String](TopLevel.String.md)) | Signs bytes and returns bytes |
+| [verifyBytesSignature](dw.crypto.WeakSignature.md#verifybytessignaturebytes-bytes-certificateref-string)([Bytes](dw.util.Bytes.md), [Bytes](dw.util.Bytes.md), [CertificateRef](dw.crypto.CertificateRef.md), [String](TopLevel.String.md)) | Verifies a signature supplied as bytes |
+| [verifyBytesSignature](dw.crypto.WeakSignature.md#verifybytessignaturebytes-bytes-string-string)([Bytes](dw.util.Bytes.md), [Bytes](dw.util.Bytes.md), [String](TopLevel.String.md), [String](TopLevel.String.md)) | Verifies a signature supplied as bytes |
+| [verifySignature](dw.crypto.WeakSignature.md#verifysignaturestring-string-certificateref-string)([String](TopLevel.String.md), [String](TopLevel.String.md), [CertificateRef](dw.crypto.CertificateRef.md), [String](TopLevel.String.md)) | Verifies a signature supplied as string |
+| [verifySignature](dw.crypto.WeakSignature.md#verifysignaturestring-string-string-string)([String](TopLevel.String.md), [String](TopLevel.String.md), [String](TopLevel.String.md), [String](TopLevel.String.md)) | Verifies a signature supplied as 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)
+## Constructor Details
+
+### WeakSignature()
+- WeakSignature()
+  - : 
+
+
+---
+
+## Method Details
+
+### isDigestAlgorithmSupported(String)
+- isDigestAlgorithmSupported(digestAlgorithm: [String](TopLevel.String.md)): [Boolean](TopLevel.Boolean.md)
+  - : Checks to see if a digest algorithm is supported
+
+    **Parameters:**
+    - digestAlgorithm - the digest algorithm name
+
+    **Returns:**
+    - a boolean indicating success (true) or failure (false)
+
+
+---
+
+### sign(String, KeyRef, String)
+- sign(contentToSign: [String](TopLevel.String.md), privateKey: [KeyRef](dw.crypto.KeyRef.md), digestAlgorithm: [String](TopLevel.String.md)): [String](TopLevel.String.md)
+  - : Signs a string and returns a string
+
+    **Parameters:**
+    - contentToSign - base64 encoded content to sign
+    - privateKey - a reference to a private key entry in the keystore
+    - digestAlgorithm - must be one of the currently supported ones
+
+    **Returns:**
+    - the base64 encoded signature
+
+
+---
+
+### sign(String, String, String)
+- sign(contentToSign: [String](TopLevel.String.md), privateKey: [String](TopLevel.String.md), digestAlgorithm: [String](TopLevel.String.md)): [String](TopLevel.String.md)
+  - : Signs a string and returns a string
+
+    **Parameters:**
+    - contentToSign - base64 encoded content to sign
+    - privateKey - base64 encoded private key
+    - digestAlgorithm - must be one of the currently supported ones
+
+    **Returns:**
+    - the base64 encoded signature
+
+
+---
+
+### signBytes(Bytes, KeyRef, String)
+- signBytes(contentToSign: [Bytes](dw.util.Bytes.md), privateKey: [KeyRef](dw.crypto.KeyRef.md), digestAlgorithm: [String](TopLevel.String.md)): [Bytes](dw.util.Bytes.md)
+  - : Signs bytes and returns bytes
+
+    **Parameters:**
+    - contentToSign - transformed with UTF-8 encoding into a byte stream
+    - privateKey - a reference to a private key entry in the keystore
+    - digestAlgorithm - must be one of the currently supported ones
+
+    **Returns:**
+    - signature
+
+
+---
+
+### signBytes(Bytes, String, String)
+- signBytes(contentToSign: [Bytes](dw.util.Bytes.md), privateKey: [String](TopLevel.String.md), digestAlgorithm: [String](TopLevel.String.md)): [Bytes](dw.util.Bytes.md)
+  - : Signs bytes and returns bytes
+
+    **Parameters:**
+    - contentToSign - transformed with UTF-8 encoding into a byte stream
+    - privateKey - base64 encoded private key
+    - digestAlgorithm - must be one of the currently supported ones
+
+    **Returns:**
+    - signature
+
+
+---
+
+### verifyBytesSignature(Bytes, Bytes, CertificateRef, String)
+- verifyBytesSignature(signature: [Bytes](dw.util.Bytes.md), contentToVerify: [Bytes](dw.util.Bytes.md), certificate: [CertificateRef](dw.crypto.CertificateRef.md), digestAlgorithm: [String](TopLevel.String.md)): [Boolean](TopLevel.Boolean.md)
+  - : Verifies a signature supplied as bytes
+
+    **Parameters:**
+    - signature - signature to check as bytes
+    - contentToVerify - as bytes
+    - certificate - a reference to a trusted certificate
+    - digestAlgorithm - must be one of the currently supported ones
+
+    **Returns:**
+    - a boolean indicating success (true) or failure (false)
+
+
+---
+
+### verifyBytesSignature(Bytes, Bytes, String, String)
+- verifyBytesSignature(signature: [Bytes](dw.util.Bytes.md), contentToVerify: [Bytes](dw.util.Bytes.md), publicKey: [String](TopLevel.String.md), digestAlgorithm: [String](TopLevel.String.md)): [Boolean](TopLevel.Boolean.md)
+  - : Verifies a signature supplied as bytes
+
+    **Parameters:**
+    - signature - signature to check as bytes
+    - contentToVerify - as bytes
+    - publicKey - base64 encoded public key
+    - digestAlgorithm - must be one of the currently supported ones
+
+    **Returns:**
+    - a boolean indicating success (true) or failure (false)
+
+
+---
+
+### verifySignature(String, String, CertificateRef, String)
+- verifySignature(signature: [String](TopLevel.String.md), contentToVerify: [String](TopLevel.String.md), certificate: [CertificateRef](dw.crypto.CertificateRef.md), digestAlgorithm: [String](TopLevel.String.md)): [Boolean](TopLevel.Boolean.md)
+  - : Verifies a signature supplied as string
+
+    **Parameters:**
+    - signature - base64 encoded signature
+    - contentToVerify - base64 encoded content to verify
+    - certificate - a reference to a trusted certificate
+    - digestAlgorithm - must be one of the currently supported ones
+
+    **Returns:**
+    - a boolean indicating success (true) or failure (false)
+
+
+---
+
+### verifySignature(String, String, String, String)
+- verifySignature(signature: [String](TopLevel.String.md), contentToVerify: [String](TopLevel.String.md), publicKey: [String](TopLevel.String.md), digestAlgorithm: [String](TopLevel.String.md)): [Boolean](TopLevel.Boolean.md)
+  - : Verifies a signature supplied as string
+
+    **Parameters:**
+    - signature - base64 encoded signature
+    - contentToVerify - base64 encoded content to verify
+    - publicKey - base64 encoded public key
+    - digestAlgorithm - must be one of the currently supported ones
+
+    **Returns:**
+    - a boolean indicating success (true) or failure (false)
+
+
+---
+
+<!-- prettier-ignore-end -->