sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_crypto/WeakMessageDigest.md

@@ -1,163 +0,0 @@
-## Package: dw.crypto
-
-# Class WeakMessageDigest
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.crypto.WeakMessageDigest
-
-## Description
-
-This API provides access to Deprecated algorithms. See MessageDigest 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.
-
-## Constants
-
-### DIGEST_MD2
-
-**Type:** String = "MD2"
-
-Constant representing the MD2 algorithm. This algorithm is obsolete. Do not use it for any sensitive data
-
-### DIGEST_MD5
-
-**Type:** String = "MD5"
-
-Constant representing the MD5 algorithm. This algorithm is obsolete. Do not use it for any sensitive data
-
-### DIGEST_SHA
-
-**Type:** String = "SHA"
-
-Constant representing the SHA algorithm. This algorithm is obsolete. Do not use it for any sensitive data
-
-### DIGEST_SHA_1
-
-**Type:** String = "SHA-1"
-
-Constant representing the SHA 1 algorithm. This algorithm is obsolete. Do not use it for any sensitive data
-
-## Properties
-
-## Constructor Summary
-
-WeakMessageDigest(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/WeakSignature.md

@@ -1,242 +0,0 @@
-## Package: dw.crypto
-
-# Class WeakSignature
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.crypto.WeakSignature
-
-## Description
-
-This API provides access to Deprecated algorithms. See Signature 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
-
-WeakSignature()
-
-## 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)
-
----

package/docs/dw_crypto/X509Certificate.md

@@ -1,193 +0,0 @@
-## Package: dw.crypto
-
-# Class X509Certificate
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.crypto.CertificateRef
-  - dw.crypto.X509Certificate
-
-## Description
-
-Represents an X.509 public key certificate as defined in RFC 5280. It provides access to the standard fields of an X.509 certificate including version, serial number, validity period, distinguished names, and signature algorithm.
-
-## Properties
-
-### issuerDN
-
-**Type:** String (Read Only)
-
-The X.500 distinguished name of the entity that signed this certificate.
-
-### notAfter
-
-**Type:** Date (Read Only)
-
-The end date of the certificate validity period.
-
-### notBefore
-
-**Type:** Date (Read Only)
-
-The start date of the certificate validity period.
-
-### serialNumber
-
-**Type:** String (Read Only)
-
-The certificate serial number in string format. The serial number is a unique positive integer assigned
- by the CA to each certificate.
-
-### sigAlgName
-
-**Type:** String (Read Only)
-
-The algorithm used to sign this certificate. The name follows the format defined in RFC 5280 (e.g.,
- "SHA256withRSA", "SHA384withECDSA").
-
-### subjectDN
-
-**Type:** String (Read Only)
-
-The X.500 distinguished name of the entity this certificate belongs to.
-
-### version
-
-**Type:** Number (Read Only)
-
-The X.509 certificate version number.
-
-## Constructor Summary
-
-## Method Summary
-
-### getIssuerDN
-
-**Signature:** `getIssuerDN() : String`
-
-Returns the X.500 distinguished name of the entity that signed this certificate.
-
-### getNotAfter
-
-**Signature:** `getNotAfter() : Date`
-
-Returns the end date of the certificate validity period.
-
-### getNotBefore
-
-**Signature:** `getNotBefore() : Date`
-
-Returns the start date of the certificate validity period.
-
-### getSerialNumber
-
-**Signature:** `getSerialNumber() : String`
-
-Returns the certificate serial number in string format.
-
-### getSigAlgName
-
-**Signature:** `getSigAlgName() : String`
-
-Returns the algorithm used to sign this certificate.
-
-### getSubjectDN
-
-**Signature:** `getSubjectDN() : String`
-
-Returns the X.500 distinguished name of the entity this certificate belongs to.
-
-### getVersion
-
-**Signature:** `getVersion() : Number`
-
-Returns the X.509 certificate version number.
-
-## Method Detail
-
-## Method Details
-
-### getIssuerDN
-
-**Signature:** `getIssuerDN() : String`
-
-**Description:** Returns the X.500 distinguished name of the entity that signed this certificate.
-
-**Returns:**
-
-the issuer's X.500 distinguished name
-
----
-
-### getNotAfter
-
-**Signature:** `getNotAfter() : Date`
-
-**Description:** Returns the end date of the certificate validity period.
-
-**Returns:**
-
-the date after which this certificate is not valid
-
----
-
-### getNotBefore
-
-**Signature:** `getNotBefore() : Date`
-
-**Description:** Returns the start date of the certificate validity period.
-
-**Returns:**
-
-the date before which this certificate is not valid
-
----
-
-### getSerialNumber
-
-**Signature:** `getSerialNumber() : String`
-
-**Description:** Returns the certificate serial number in string format. The serial number is a unique positive integer assigned by the CA to each certificate.
-
-**Returns:**
-
-the certificate serial number as a string
-
----
-
-### getSigAlgName
-
-**Signature:** `getSigAlgName() : String`
-
-**Description:** Returns the algorithm used to sign this certificate. The name follows the format defined in RFC 5280 (e.g., "SHA256withRSA", "SHA384withECDSA").
-
-**Returns:**
-
-the signature algorithm name
-
----
-
-### getSubjectDN
-
-**Signature:** `getSubjectDN() : String`
-
-**Description:** Returns the X.500 distinguished name of the entity this certificate belongs to.
-
-**Returns:**
-
-the subject's X.500 distinguished name
-
----
-
-### getVersion
-
-**Signature:** `getVersion() : Number`
-
-**Description:** Returns the X.509 certificate version number.
-
-**Returns:**
-
-certificate version (typically 1, 2, or 3)
-
----