@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.3

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

@@ -0,0 +1,243 @@
+<!-- prettier-ignore-start -->
+# Class MessageDigest
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.crypto.MessageDigest](dw.crypto.MessageDigest.md)
+
+This class provides the functionality of a message digest algorithm, such as
+MD5 or SHA. Message digests are secure one-way hash functions that take
+arbitrary-sized data and output a fixed-length hash value. This
+implementation offers only stateless digest() methods. A Bytes object or
+String is passed to a digest() method and the computed hash is returned.
+
+
+**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. |
+| [DIGEST_SHA_256](#digest_sha_256): [String](TopLevel.String.md) = "SHA-256" | Constant representing the SHA 256 algorithm |
+| [DIGEST_SHA_512](#digest_sha_512): [String](TopLevel.String.md) = "SHA-512" | Constant representing the SHA 512 algorithm |
+
+## Constructor Summary
+
+| Constructor | Description |
+| --- | --- |
+| [MessageDigest](#messagedigeststring)([String](TopLevel.String.md)) | Construct a MessageDigest with the specified algorithm name. |
+
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [digest](dw.crypto.MessageDigest.md#digest)() | Completes the hash computation by performing final operations such as  padding. |
+| ~~[digest](dw.crypto.MessageDigest.md#digeststring)([String](TopLevel.String.md))~~ | Digests the passed string and returns a computed hash value as a string. |
+| ~~[digest](dw.crypto.MessageDigest.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.MessageDigest.md#digestbytesbytes)([Bytes](dw.util.Bytes.md)) | Computes the hash value for the passed [Bytes](dw.util.Bytes.md). |
+| [updateBytes](dw.crypto.MessageDigest.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.
+
+    **Deprecated:**
+:::warning
+This algorithm is obsolete and and has been deprecated. Please use SHA-256 or SHA-512.
+:::
+
+---
+
+### DIGEST_MD5
+
+- ~~DIGEST_MD5: [String](TopLevel.String.md) = "MD5"~~
+  - : Constant representing the MD5 algorithm.
+
+    **Deprecated:**
+:::warning
+This algorithm is obsolete and and has been deprecated. Please use SHA-256 or SHA-512.
+:::
+
+---
+
+### DIGEST_SHA
+
+- ~~DIGEST_SHA: [String](TopLevel.String.md) = "SHA"~~
+  - : Constant representing the SHA algorithm.
+
+    **Deprecated:**
+:::warning
+This algorithm is obsolete and and has been deprecated. Please use SHA-256 or SHA-512.
+:::
+
+---
+
+### DIGEST_SHA_1
+
+- ~~DIGEST_SHA_1: [String](TopLevel.String.md) = "SHA-1"~~
+  - : Constant representing the SHA 1 algorithm.
+
+    **Deprecated:**
+:::warning
+This algorithm is obsolete and and has been deprecated. Please use SHA-256 or SHA-512.
+:::
+
+---
+
+### DIGEST_SHA_256
+
+- DIGEST_SHA_256: [String](TopLevel.String.md) = "SHA-256"
+  - : Constant representing the SHA 256 algorithm
+
+
+---
+
+### DIGEST_SHA_512
+
+- DIGEST_SHA_512: [String](TopLevel.String.md) = "SHA-512"
+  - : Constant representing the SHA 512 algorithm
+
+
+---
+
+## Constructor Details
+
+### MessageDigest(String)
+- MessageDigest(algorithm: [String](TopLevel.String.md))
+  - : Construct a MessageDigest with the specified algorithm name. The
+      supported algorithms are:
+      
+      
+      - SHA-256
+      - SHA-512
+
+
+    **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.SecureRandom.md

@@ -0,0 +1,161 @@
+<!-- prettier-ignore-start -->
+# Class SecureRandom
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.crypto.SecureRandom](dw.crypto.SecureRandom.md)
+
+The SecureRandom class provides a cryptographically strong random number generator (RNG).
+See the Internet Engineering Task Force (IETF) RFC 1750: _Randomness Recommendations for
+ Security_ for more information.]()
+
+
+ Typical callers of SecureRandom invoke the following methods to retrieve random bytes:
+
+
+```
+     Bytes bytes...
+     SecureRandom random = new SecureRandom();
+     Bytes nextBytes = random.nextBytes(bytes);
+```
+
+
+or more convenient to get a Bytes with the demanded length
+
+
+```
+     int length = 32;
+     SecureRandom random = new SecureRandom();
+     Bytes nextBytes = random.nextBytes(length);
+```
+
+
+dw.crypto.SecureRandom is intentionally an adapter for generating cryptographic hard random numbers.
+
+
+
+## Constructor Summary
+
+| Constructor | Description |
+| --- | --- |
+| [SecureRandom](#securerandom)() | Instantiates a new secure random. |
+
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [generateSeed](dw.crypto.SecureRandom.md#generateseednumber)([Number](TopLevel.Number.md)) | Returns the given number of seed bytes, computed using the seed  generation algorithm that this class uses to seed itself. |
+| [nextBytes](dw.crypto.SecureRandom.md#nextbytesnumber)([Number](TopLevel.Number.md)) | Generates a user-specified number of random bytes. |
+| [nextInt](dw.crypto.SecureRandom.md#nextint)() | Returns the next pseudorandom, uniformly distributed int value from this random number generator's sequence. |
+| [nextInt](dw.crypto.SecureRandom.md#nextintnumber)([Number](TopLevel.Number.md)) | Returns a pseudorandom, uniformly distributed int value  between 0 (inclusive) and the specified value (exclusive), drawn from  this random number generator's sequence. |
+| [nextNumber](dw.crypto.SecureRandom.md#nextnumber)() | Returns the next pseudorandom, uniformly distributed  Number value between 0.0 (inclusive) and 1.0 (exclusive) from this random number generator's sequence. |
+| [setSeed](dw.crypto.SecureRandom.md#setseedbytes)([Bytes](dw.util.Bytes.md)) | Reseeds this random object. |
+
+### 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
+
+### SecureRandom()
+- SecureRandom()
+  - : Instantiates a new secure random.
+
+
+---
+
+## Method Details
+
+### generateSeed(Number)
+- generateSeed(numBytes: [Number](TopLevel.Number.md)): [Bytes](dw.util.Bytes.md)
+  - : Returns the given number of seed bytes, computed using the seed
+      generation algorithm that this class uses to seed itself.  This
+      call may be used to seed other random number generators.
+
+
+    **Parameters:**
+    - numBytes - the number of seed bytes to generate.
+
+    **Returns:**
+    - the seed bytes.
+
+
+---
+
+### nextBytes(Number)
+- nextBytes(numBits: [Number](TopLevel.Number.md)): [Bytes](dw.util.Bytes.md)
+  - : Generates a user-specified number of random bytes.
+      
+      
+       If a call to `setSeed` had not occurred previously,
+      the first call to this method forces this SecureRandom object
+      to seed itself.  This self-seeding will not occur if
+      `setSeed` was previously called.
+
+
+    **Parameters:**
+    - numBits - the demanded number of bits
+
+    **Returns:**
+    - a randomly filled [Bytes](dw.util.Bytes.md)
+
+
+---
+
+### nextInt()
+- nextInt(): [Number](TopLevel.Number.md)
+  - : Returns the next pseudorandom, uniformly distributed int value from this random number generator's sequence. The general
+      contract of nextInt is that one int value is pseudorandomly generated and returned. All 2^32
+      possible int values are produced with (approximately) equal probability.
+
+
+    **Returns:**
+    - the next pseudorandom, uniformly distributed int value from this random number generator's sequence
+
+
+---
+
+### nextInt(Number)
+- nextInt(upperBound: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
+  - : Returns a pseudorandom, uniformly distributed int value
+      between 0 (inclusive) and the specified value (exclusive), drawn from
+      this random number generator's sequence.
+
+
+    **Parameters:**
+    - upperBound - the bound on the random number to be returned.  Must be positive.
+
+    **Returns:**
+    - the next pseudorandom, uniformly distributed int value between 0 (inclusive) and upperBound (exclusive)
+              from this random number generator's sequence
+
+
+    **Throws:**
+    - IllegalArgumentException - if n is not positive
+
+
+---
+
+### nextNumber()
+- nextNumber(): [Number](TopLevel.Number.md)
+  - : Returns the next pseudorandom, uniformly distributed
+      Number value between 0.0 (inclusive) and 1.0 (exclusive) from this random number generator's sequence.
+
+
+    **Returns:**
+    - the next pseudorandom, uniformly distributed Number
+              value between 0.0 and 1.0 from this random number generator's sequence
+
+
+
+---
+
+### setSeed(Bytes)
+- setSeed(seed: [Bytes](dw.util.Bytes.md)): void
+  - : Reseeds this random object. The given seed supplements, rather than replaces, the existing seed. Thus, repeated calls are guaranteed never to reduce randomness.
+
+    **Parameters:**
+    - seed - the seed.
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,241 @@
+<!-- prettier-ignore-start -->
+# Class Signature
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.crypto.Signature](dw.crypto.Signature.md)
+
+
+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.Signature is an adapter to the security provider implementation
+and covers several digest algorithms:
+
+- SHA1withRSA (deprecated)
+- SHA256withRSA
+- SHA384withRSA
+- SHA512withRSA
+- SHA256withRSA/PSS
+- SHA384withRSA/PSS
+- SHA512withRSA/PSS
+- SHA256withECDSA
+- SHA384withECDSA
+- SHA512withECDSA
+
+
+
+
+
+Key size generally ranges between 512 and 65536 bits (the latter of which is unnecessarily large).
+
+Default key size for RSA is 1024. SHA384withRSA and SHA512withRSA require a key with length of at least 1024 bits.
+
+For ECDSA, the following key sizes are supported:
+
+- SHA256withECDSA: 256-bit key (NIST P-256)
+- SHA384withECDSA: 384-bit key (NIST P-384)
+- SHA512withECDSA: 521-bit key (NIST P-521)
+
+When choosing a key size - beware of the tradeoff between security and processing time:
+
+The longer the key, the harder to break it but also it takes more time for the two sides to sign and verify the signature.
+
+An exception will be thrown for keys shorter than 2048 bits in this version of the API.
+
+
+**Note:** this class handles sensitive security-related data.
+Pay special attention to PCI DSS v3. requirements 2, 4, 12, and other relevant requirements.
+
+
+
+## Constant Summary
+
+| Constant | Description |
+| --- | --- |
+| [SUPPORTED_DIGEST_ALGORITHMS_AS_ARRAY](#supported_digest_algorithms_as_array): [String\[\]](TopLevel.String.md) | Supported digest algorithms exposed as a string array |
+
+## Constructor Summary
+
+| Constructor | Description |
+| --- | --- |
+| [Signature](#signature)() |  |
+
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [isDigestAlgorithmSupported](dw.crypto.Signature.md#isdigestalgorithmsupportedstring)([String](TopLevel.String.md)) | Checks to see if a digest algorithm is supported |
+| [sign](dw.crypto.Signature.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.Signature.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.Signature.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.Signature.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.Signature.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.Signature.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.Signature.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.Signature.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)
+## Constant Details
+
+### SUPPORTED_DIGEST_ALGORITHMS_AS_ARRAY
+
+- SUPPORTED_DIGEST_ALGORITHMS_AS_ARRAY: [String\[\]](TopLevel.String.md)
+  - : Supported digest algorithms exposed as a string array
+
+
+---
+
+## Constructor Details
+
+### Signature()
+- Signature()
+  - : 
+
+
+---
+
+## 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 -->