sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_crypto/MessageDigest.md

@@ -1,175 +0,0 @@
-## Package: dw.crypto
-
-# Class MessageDigest
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.crypto.MessageDigest
-
-## Description
-
-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.
-
-## Constants
-
-### DIGEST_MD2
-
-**Type:** String = "MD2"
-
-Constant representing the MD2 algorithm.
-
-### DIGEST_MD5
-
-**Type:** String = "MD5"
-
-Constant representing the MD5 algorithm.
-
-### DIGEST_SHA
-
-**Type:** String = "SHA"
-
-Constant representing the SHA algorithm.
-
-### DIGEST_SHA_1
-
-**Type:** String = "SHA-1"
-
-Constant representing the SHA 1 algorithm.
-
-### DIGEST_SHA_256
-
-**Type:** String = "SHA-256"
-
-Constant representing the SHA 256 algorithm
-
-### DIGEST_SHA_512
-
-**Type:** String = "SHA-512"
-
-Constant representing the SHA 512 algorithm
-
-## Properties
-
-## Constructor Summary
-
-MessageDigest(algorithm : String) Construct a MessageDigest with the specified algorithm name.
-
-## Method Summary
-
-### digest
-
-**Signature:** `digest(input : String) : String`
-
-Digests the passed string and returns a computed hash value as a string.
-
-### digest
-
-**Signature:** `digest(algorithm : String, input : Bytes) : Bytes`
-
-Computes the hash value for the passed array of bytes.
-
-### digest
-
-**Signature:** `digest() : Bytes`
-
-Completes the hash computation by performing final operations such as padding.
-
-### digestBytes
-
-**Signature:** `digestBytes(input : Bytes) : Bytes`
-
-Computes the hash value for the passed Bytes.
-
-### updateBytes
-
-**Signature:** `updateBytes(input : Bytes) : void`
-
-Updates the digest using the passed Bytes.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### digest
-
-**Signature:** `digest(input : String) : String`
-
-**Description:** 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.
-
-**Deprecated:**
-
-Deprecated because the conversion of the input to bytes using the default platform encoding and the hex-encoded return value are not generally appropriate.
-
-**Parameters:**
-
-- `input`: The value to hash as String, must not be null.
-
-**Returns:**
-
-The resulting hash value as hex-encoded string.
-
----
-
-### digest
-
-**Signature:** `digest(algorithm : String, input : Bytes) : Bytes`
-
-**Description:** 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" ) ) );
-
-**Deprecated:**
-
-Deprecated because the digest algorithm should be the one set in the constructor.
-
-**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.
-
----
-
-### digest
-
-**Signature:** `digest() : Bytes`
-
-**Description:** 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.
-
----
-
-### digestBytes
-
-**Signature:** `digestBytes(input : Bytes) : Bytes`
-
-**Description:** Computes the hash value for the passed Bytes. 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
-
-**Signature:** `updateBytes(input : Bytes) : void`
-
-**Description:** Updates the digest using the passed Bytes.
-
-**Parameters:**
-
-- `input`: The value to hash, must not be null.
-
----

package/docs/dw_crypto/SecureRandom.md

@@ -1,148 +0,0 @@
-## Package: dw.crypto
-
-# Class SecureRandom
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.crypto.SecureRandom
-
-## Description
-
-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
-
-SecureRandom() Instantiates a new secure random.
-
-## Method Summary
-
-### generateSeed
-
-**Signature:** `generateSeed(numBytes : Number) : Bytes`
-
-Returns the given number of seed bytes, computed using the seed generation algorithm that this class uses to seed itself.
-
-### nextBytes
-
-**Signature:** `nextBytes(numBits : Number) : Bytes`
-
-Generates a user-specified number of random bytes.
-
-### nextInt
-
-**Signature:** `nextInt() : Number`
-
-Returns the next pseudorandom, uniformly distributed int value from this random number generator's sequence.
-
-### nextInt
-
-**Signature:** `nextInt(upperBound : Number) : Number`
-
-Returns a pseudorandom, uniformly distributed int value between 0 (inclusive) and the specified value (exclusive), drawn from this random number generator's sequence.
-
-### nextNumber
-
-**Signature:** `nextNumber() : Number`
-
-Returns the next pseudorandom, uniformly distributed Number value between 0.0 (inclusive) and 1.0 (exclusive) from this random number generator's sequence.
-
-### setSeed
-
-**Signature:** `setSeed(seed : Bytes) : void`
-
-Reseeds this random object.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### generateSeed
-
-**Signature:** `generateSeed(numBytes : Number) : Bytes`
-
-**Description:** 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
-
-**Signature:** `nextBytes(numBits : Number) : Bytes`
-
-**Description:** 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
-
----
-
-### nextInt
-
-**Signature:** `nextInt() : Number`
-
-**Description:** 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
-
-**Signature:** `nextInt(upperBound : Number) : Number`
-
-**Description:** 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
-
-**Signature:** `nextNumber() : Number`
-
-**Description:** 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
-
-**Signature:** `setSeed(seed : Bytes) : void`
-
-**Description:** 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.
-
----

package/docs/dw_crypto/Signature.md

@@ -1,252 +0,0 @@
-## Package: dw.crypto
-
-# Class Signature
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.crypto.Signature
-
-## Description
-
-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.
-
-## Constants
-
-### SUPPORTED_DIGEST_ALGORITHMS_AS_ARRAY
-
-**Type:** String
-
-Supported digest algorithms exposed as a string array
-
-## Properties
-
-## Constructor Summary
-
-Signature()
-
-## Method Summary
-
-### isDigestAlgorithmSupported
-
-**Signature:** `isDigestAlgorithmSupported(digestAlgorithm : String) : boolean`
-
-Checks to see if a digest algorithm is supported
-
-### sign
-
-**Signature:** `sign(contentToSign : String, privateKey : String, digestAlgorithm : String) : String`
-
-Signs a string and returns a string
-
-### sign
-
-**Signature:** `sign(contentToSign : String, privateKey : KeyRef, digestAlgorithm : String) : String`
-
-Signs a string and returns a string
-
-### signBytes
-
-**Signature:** `signBytes(contentToSign : Bytes, privateKey : String, digestAlgorithm : String) : Bytes`
-
-Signs bytes and returns bytes
-
-### signBytes
-
-**Signature:** `signBytes(contentToSign : Bytes, privateKey : KeyRef, digestAlgorithm : String) : Bytes`
-
-Signs bytes and returns bytes
-
-### verifyBytesSignature
-
-**Signature:** `verifyBytesSignature(signature : Bytes, contentToVerify : Bytes, publicKey : String, digestAlgorithm : String) : boolean`
-
-Verifies a signature supplied as bytes
-
-### verifyBytesSignature
-
-**Signature:** `verifyBytesSignature(signature : Bytes, contentToVerify : Bytes, certificate : CertificateRef, digestAlgorithm : String) : boolean`
-
-Verifies a signature supplied as bytes
-
-### verifySignature
-
-**Signature:** `verifySignature(signature : String, contentToVerify : String, publicKey : String, digestAlgorithm : String) : boolean`
-
-Verifies a signature supplied as string
-
-### verifySignature
-
-**Signature:** `verifySignature(signature : String, contentToVerify : String, certificate : CertificateRef, digestAlgorithm : String) : boolean`
-
-Verifies a signature supplied as string
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### isDigestAlgorithmSupported
-
-**Signature:** `isDigestAlgorithmSupported(digestAlgorithm : String) : boolean`
-
-**Description:** 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
-
-**Signature:** `sign(contentToSign : String, privateKey : String, digestAlgorithm : String) : String`
-
-**Description:** 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
-
----
-
-### sign
-
-**Signature:** `sign(contentToSign : String, privateKey : KeyRef, digestAlgorithm : String) : String`
-
-**Description:** 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
-
----
-
-### signBytes
-
-**Signature:** `signBytes(contentToSign : Bytes, privateKey : String, digestAlgorithm : String) : Bytes`
-
-**Description:** 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
-
----
-
-### signBytes
-
-**Signature:** `signBytes(contentToSign : Bytes, privateKey : KeyRef, digestAlgorithm : String) : Bytes`
-
-**Description:** 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
-
----
-
-### verifyBytesSignature
-
-**Signature:** `verifyBytesSignature(signature : Bytes, contentToVerify : Bytes, publicKey : String, digestAlgorithm : String) : boolean`
-
-**Description:** 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)
-
----
-
-### verifyBytesSignature
-
-**Signature:** `verifyBytesSignature(signature : Bytes, contentToVerify : Bytes, certificate : CertificateRef, digestAlgorithm : String) : boolean`
-
-**Description:** 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)
-
----
-
-### verifySignature
-
-**Signature:** `verifySignature(signature : String, contentToVerify : String, publicKey : String, digestAlgorithm : String) : boolean`
-
-**Description:** 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)
-
----
-
-### verifySignature
-
-**Signature:** `verifySignature(signature : String, contentToVerify : String, certificate : CertificateRef, digestAlgorithm : String) : boolean`
-
-**Description:** 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)
-
----