sfcc-dev-mcp 1.0.0

package/docs/dw_crypto/WeakCipher.md

@@ -0,0 +1,532 @@
+## Package: dw.crypto
+
+# Class WeakCipher
+
+## Inheritance Hierarchy
+
+- Object
+  - dw.crypto.WeakCipher
+
+## Description
+
+This API provides access to Deprecated algorithms. See Cipher for full documentation. WeakCipher is simply a drop-in replacement that only supports deprecated algorithms and key lengths. This is helpful when you need to deal with weak algorithms for backward compatibility purposes, but Cipher 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
+
+## Properties
+
+## Constructor Summary
+
+WeakCipher()
+
+## Method Summary
+
+### decrypt
+
+**Signature:** `decrypt(base64Msg : String, key : String, transformation : String, saltOrIV : String, iterations : Number) : String`
+
+Decrypts the message using the given parameters.
+
+### decrypt
+
+**Signature:** `decrypt(base64Msg : String, privateKey : KeyRef, transformation : String, saltOrIV : String, iterations : Number) : String`
+
+Alternative method to decrypt(String, String, String, String, Number), which allows using a key in the keystore for the decryption.
+
+### decrypt
+
+**Signature:** `decrypt(base64Msg : String, key : String, transformation : String, saltOrIV : String, iterations : Number) : String`
+
+Decrypts the message using the given parameters.
+
+### decrypt
+
+**Signature:** `decrypt(base64Msg : String, privateKey : KeyRef, transformation : String, saltOrIV : String, iterations : Number) : String`
+
+Alternative method to decrypt_3(String, String, String, String, Number), which allows using a key in the keystore for the decryption.
+
+### decryptBytes
+
+**Signature:** `decryptBytes(encryptedBytes : Bytes, key : String, transformation : String, saltOrIV : String, iterations : Number) : Bytes`
+
+Lower-level decryption API.
+
+### decryptBytes
+
+**Signature:** `decryptBytes(encryptedBytes : Bytes, privateKey : KeyRef, transformation : String, saltOrIV : String, iterations : Number) : Bytes`
+
+Alternative method to decryptBytes(Bytes, String, String, String, Number), which allows to use a key in the keystore for the decryption.
+
+### decryptBytes
+
+**Signature:** `decryptBytes(encryptedBytes : Bytes, key : String, transformation : String, saltOrIV : String, iterations : Number) : Bytes`
+
+Lower-level decryption API.
+
+### decryptBytes
+
+**Signature:** `decryptBytes(encryptedBytes : Bytes, privateKey : KeyRef, transformation : String, saltOrIV : String, iterations : Number) : Bytes`
+
+Alternative method to decryptBytes_3(Bytes, String, String, String, Number), which allows to use a key in the keystore for the decryption.
+
+### encrypt
+
+**Signature:** `encrypt(message : String, key : String, transformation : String, saltOrIV : String, iterations : Number) : String`
+
+Encrypt the passed message by using the specified key and applying the transformations described by the specified parameters.
+
+### encrypt
+
+**Signature:** `encrypt(message : String, publicKey : CertificateRef, transformation : String, saltOrIV : String, iterations : Number) : String`
+
+Encrypt the passed message by using the specified key and applying the transformations described by the specified parameters.
+
+### encrypt
+
+**Signature:** `encrypt(message : String, key : String, transformation : String, saltOrIV : String, iterations : Number) : String`
+
+Encrypt the passed message by using the specified key and applying the transformations described by the specified parameters.
+
+### encrypt
+
+**Signature:** `encrypt(message : String, publicKey : CertificateRef, transformation : String, saltOrIV : String, iterations : Number) : String`
+
+Encrypt the passed message by using the specified key and applying the transformations described by the specified parameters.
+
+### encryptBytes
+
+**Signature:** `encryptBytes(messageBytes : Bytes, key : String, transformation : String, saltOrIV : String, iterations : Number) : Bytes`
+
+Lower-level encryption API.
+
+### encryptBytes
+
+**Signature:** `encryptBytes(messageBytes : Bytes, publicKey : CertificateRef, transformation : String, saltOrIV : String, iterations : Number) : Bytes`
+
+Alternative method to encryptBytes(Bytes, String, String, String, Number), which allows to use a key in the keystore for the encryption.
+
+### encryptBytes
+
+**Signature:** `encryptBytes(messageBytes : Bytes, key : String, transformation : String, saltOrIV : String, iterations : Number) : Bytes`
+
+Lower-level encryption API.
+
+### encryptBytes
+
+**Signature:** `encryptBytes(messageBytes : Bytes, publicKey : CertificateRef, transformation : String, saltOrIV : String, iterations : Number) : Bytes`
+
+Alternative method to encryptBytes_3(Bytes, String, String, String, Number), which allows to use a key in the keystore for the encryption.
+
+## Constructor Detail
+
+## Method Detail
+
+## Method Details
+
+### decrypt
+
+**Signature:** `decrypt(base64Msg : String, key : String, transformation : String, saltOrIV : String, iterations : Number) : String`
+
+**Description:** Decrypts the message using the given parameters. See Cipher.decrypt(String, String, String, String, Number) for full documentation.
+
+**API Versioned:**
+
+From version 15.5. No longer available as of version 16.2. Requires Base64-encryption for the salt parameter.
+
+**Parameters:**
+
+- `base64Msg`: the base64 encoded data to decrypt
+- `key`: The decryption key
+- `transformation`: Transformation in "algorithm/mode/padding" format.
+- `saltOrIV`: Initialization value appropriate for the algorithm.
+- `iterations`: The number of passes to make when turning a passphrase into a key, if applicable
+
+**Returns:**
+
+the original plaintext message.
+
+---
+
+### decrypt
+
+**Signature:** `decrypt(base64Msg : String, privateKey : KeyRef, transformation : String, saltOrIV : String, iterations : Number) : String`
+
+**Description:** Alternative method to decrypt(String, String, String, String, Number), which allows using a key in the keystore for the decryption. See Cipher.decrypt(String, KeyRef, String, String, Number) for full documentation.
+
+**API Versioned:**
+
+From version 15.5. No longer available as of version 16.2. Requires Base64-encryption for the salt parameter.
+
+**Parameters:**
+
+- `base64Msg`: the base64 encoded data to decrypt
+- `privateKey`: A reference to a private key in the key store.
+- `transformation`: Transformation in "algorithm/mode/padding" format.
+- `saltOrIV`: Initialization value appropriate for the algorithm.
+- `iterations`: The number of passes to make when turning a passphrase into a key, if applicable
+
+**Returns:**
+
+the original plaintext message.
+
+---
+
+### decrypt
+
+**Signature:** `decrypt(base64Msg : String, key : String, transformation : String, saltOrIV : String, iterations : Number) : String`
+
+**Description:** Decrypts the message using the given parameters. See Cipher.decrypt_3(String, String, String, String, Number) for full documentation.
+
+**API Versioned:**
+
+From version 16.2. Does not use a default initialization vector.
+
+**Parameters:**
+
+- `base64Msg`: the base64 encoded data to decrypt
+- `key`: The decryption key
+- `transformation`: Transformation in "algorithm/mode/padding" format.
+- `saltOrIV`: Initialization value appropriate for the algorithm.
+- `iterations`: The number of passes to make when turning a passphrase into a key, if applicable
+
+**Returns:**
+
+the original plaintext message.
+
+---
+
+### decrypt
+
+**Signature:** `decrypt(base64Msg : String, privateKey : KeyRef, transformation : String, saltOrIV : String, iterations : Number) : String`
+
+**Description:** Alternative method to decrypt_3(String, String, String, String, Number), which allows using a key in the keystore for the decryption. See Cipher.decrypt_3(String, KeyRef, String, String, Number) for full documentation.
+
+**API Versioned:**
+
+From version 16.2. Does not use a default initialization vector.
+
+**Parameters:**
+
+- `base64Msg`: the base64 encoded data to decrypt
+- `privateKey`: A reference to a private key in the key store.
+- `transformation`: Transformation in "algorithm/mode/padding" format.
+- `saltOrIV`: Initialization value appropriate for the algorithm.
+- `iterations`: The number of passes to make when turning a passphrase into a key, if applicable
+
+**Returns:**
+
+the original plaintext message.
+
+---
+
+### decryptBytes
+
+**Signature:** `decryptBytes(encryptedBytes : Bytes, key : String, transformation : String, saltOrIV : String, iterations : Number) : Bytes`
+
+**Description:** Lower-level decryption API. Decrypts the passed bytes using the specified key and applying the transformations described by the specified parameters. See Cipher.decryptBytes(Bytes, String, String, String, Number) for full documentation.
+
+**API Versioned:**
+
+From version 15.5. No longer available as of version 16.2. Requires Base64-encryption for the salt parameter.
+
+**Parameters:**
+
+- `encryptedBytes`: The bytes to decrypt.
+- `key`: The key to use for decryption.
+- `transformation`: The transformation used to originally encrypt.
+- `saltOrIV`: the salt or IV to use.
+- `iterations`: the iterations to use.
+
+**Returns:**
+
+The decrypted bytes.
+
+**See Also:**
+
+decrypt(String, String, String, String, Number)
+
+---
+
+### decryptBytes
+
+**Signature:** `decryptBytes(encryptedBytes : Bytes, privateKey : KeyRef, transformation : String, saltOrIV : String, iterations : Number) : Bytes`
+
+**Description:** Alternative method to decryptBytes(Bytes, String, String, String, Number), which allows to use a key in the keystore for the decryption. See Cipher.decryptBytes(Bytes, KeyRef, String, String, Number) for full documentation.
+
+**API Versioned:**
+
+From version 15.5. No longer available as of version 16.2. Requires Base64-encryption for the salt parameter.
+
+**Parameters:**
+
+- `encryptedBytes`: The bytes to decrypt.
+- `privateKey`: A reference to a private key in the key store.
+- `transformation`: The transformation used to originally encrypt.
+- `saltOrIV`: the salt or IV to use.
+- `iterations`: the iterations to use.
+
+**Returns:**
+
+The decrypted bytes.
+
+---
+
+### decryptBytes
+
+**Signature:** `decryptBytes(encryptedBytes : Bytes, key : String, transformation : String, saltOrIV : String, iterations : Number) : Bytes`
+
+**Description:** Lower-level decryption API. Decrypts the passed bytes using the specified key and applying the transformations described by the specified parameters. See Cipher.decryptBytes_3(Bytes, String, String, String, Number) for full documentation.
+
+**API Versioned:**
+
+From version 16.2. Does not use a default initialization vector.
+
+**Parameters:**
+
+- `encryptedBytes`: The bytes to decrypt.
+- `key`: The key to use for decryption.
+- `transformation`: The transformation used to originally encrypt.
+- `saltOrIV`: the salt or IV to use.
+- `iterations`: the iterations to use.
+
+**Returns:**
+
+The decrypted bytes.
+
+**See Also:**
+
+decrypt_3(String, String, String, String, Number)
+
+---
+
+### decryptBytes
+
+**Signature:** `decryptBytes(encryptedBytes : Bytes, privateKey : KeyRef, transformation : String, saltOrIV : String, iterations : Number) : Bytes`
+
+**Description:** Alternative method to decryptBytes_3(Bytes, String, String, String, Number), which allows to use a key in the keystore for the decryption. See Cipher.decryptBytes_3(Bytes, KeyRef, String, String, Number) for full documentation.
+
+**API Versioned:**
+
+From version 16.2. Does not use a default initialization vector.
+
+**Parameters:**
+
+- `encryptedBytes`: The bytes to decrypt.
+- `privateKey`: A reference to a private key in the key store.
+- `transformation`: The transformation used to originally encrypt.
+- `saltOrIV`: the salt or IV to use.
+- `iterations`: the iterations to use.
+
+**Returns:**
+
+The decrypted bytes.
+
+---
+
+### encrypt
+
+**Signature:** `encrypt(message : String, key : String, transformation : String, saltOrIV : String, iterations : Number) : String`
+
+**Description:** Encrypt the passed message by using the specified key and applying the transformations described by the specified parameters. See Cipher.encrypt(String, String, String, String, Number) for full documentation.
+
+**API Versioned:**
+
+From version 15.5. No longer available as of version 16.2. Requires Base64-encryption for the salt parameter.
+
+**Parameters:**
+
+- `message`: Message to encrypt (this will be converted to UTF-8 first)
+- `key`: Key
+- `transformation`: Transformation in "algorithm/mode/padding" format
+- `saltOrIV`: Initialization value appropriate for the algorithm
+- `iterations`: The number of passes to make when turning a passphrase into a key, if applicable
+
+**Returns:**
+
+Base64-encoded encrypted data
+
+---
+
+### encrypt
+
+**Signature:** `encrypt(message : String, publicKey : CertificateRef, transformation : String, saltOrIV : String, iterations : Number) : String`
+
+**Description:** Encrypt the passed message by using the specified key and applying the transformations described by the specified parameters. See Cipher.encrypt(String, CertificateRef, String, String, Number) for full documentation.
+
+**API Versioned:**
+
+From version 15.5. No longer available as of version 16.2. Requires Base64-encryption for the salt parameter.
+
+**Parameters:**
+
+- `message`: Message to encrypt (this will be converted to UTF-8 first)
+- `publicKey`: A reference to a public key in the key store
+- `transformation`: Transformation in "algorithm/mode/padding" format
+- `saltOrIV`: Initialization value appropriate for the algorithm
+- `iterations`: The number of passes to make when turning a passphrase into a key, if applicable
+
+**Returns:**
+
+Base64-encoded encrypted data
+
+---
+
+### encrypt
+
+**Signature:** `encrypt(message : String, key : String, transformation : String, saltOrIV : String, iterations : Number) : String`
+
+**Description:** Encrypt the passed message by using the specified key and applying the transformations described by the specified parameters. See Cipher.encrypt_3(String, String, String, String, Number) for full documentation.
+
+**API Versioned:**
+
+From version 16.2. Does not use a default initialization vector.
+
+**Parameters:**
+
+- `message`: Message to encrypt (this will be converted to UTF-8 first)
+- `key`: Key
+- `transformation`: Transformation in "algorithm/mode/padding" format
+- `saltOrIV`: Initialization value appropriate for the algorithm
+- `iterations`: The number of passes to make when turning a passphrase into a key, if applicable
+
+**Returns:**
+
+Base64-encoded encrypted data
+
+---
+
+### encrypt
+
+**Signature:** `encrypt(message : String, publicKey : CertificateRef, transformation : String, saltOrIV : String, iterations : Number) : String`
+
+**Description:** Encrypt the passed message by using the specified key and applying the transformations described by the specified parameters. See Cipher.encrypt_3(String, CertificateRef, String, String, Number) for full documentation.
+
+**API Versioned:**
+
+From version 16.2. Does not use a default initialization vector.
+
+**Parameters:**
+
+- `message`: Message to encrypt (this will be converted to UTF-8 first)
+- `publicKey`: A reference to a public key in the key store
+- `transformation`: Transformation in "algorithm/mode/padding" format
+- `saltOrIV`: Initialization value appropriate for the algorithm
+- `iterations`: The number of passes to make when turning a passphrase into a key, if applicable
+
+**Returns:**
+
+Base64-encoded encrypted data
+
+---
+
+### encryptBytes
+
+**Signature:** `encryptBytes(messageBytes : Bytes, key : String, transformation : String, saltOrIV : String, iterations : Number) : Bytes`
+
+**Description:** Lower-level encryption API. Encrypts the passed bytes by using the specified key and applying the transformations described by the specified parameters. See Cipher.encryptBytes(Bytes, String, String, String, Number) for full documentation.
+
+**API Versioned:**
+
+From version 15.5. No longer available as of version 16.2. Requires Base64-encryption for the salt parameter.
+
+**Parameters:**
+
+- `messageBytes`: The bytes to encrypt.
+- `key`: The key to use for encryption.
+- `transformation`: Transformation in "algorithm/mode/padding" format.
+- `saltOrIV`: Initialization value appropriate for the algorithm.
+- `iterations`: The number of passes to make when turning a passphrase into a key.
+
+**Returns:**
+
+the encrypted bytes.
+
+**See Also:**
+
+encrypt(String, String, String, String, Number)
+
+---
+
+### encryptBytes
+
+**Signature:** `encryptBytes(messageBytes : Bytes, publicKey : CertificateRef, transformation : String, saltOrIV : String, iterations : Number) : Bytes`
+
+**Description:** Alternative method to encryptBytes(Bytes, String, String, String, Number), which allows to use a key in the keystore for the encryption. See Cipher.encryptBytes(Bytes, CertificateRef, String, String, Number) for full documentation.
+
+**API Versioned:**
+
+From version 15.5. No longer available as of version 16.2. Requires Base64-encryption for the salt parameter.
+
+**Parameters:**
+
+- `messageBytes`: The bytes to encrypt.
+- `publicKey`: A reference to a public key in the key store.
+- `transformation`: Transformation in "algorithm/mode/padding" format.
+- `saltOrIV`: Initialization value appropriate for the algorithm.
+- `iterations`: The number of passes to make when turning a passphrase into a key.
+
+**Returns:**
+
+the encrypted bytes.
+
+**See Also:**
+
+encrypt(String, CertificateRef, String, String, Number)
+
+---
+
+### encryptBytes
+
+**Signature:** `encryptBytes(messageBytes : Bytes, key : String, transformation : String, saltOrIV : String, iterations : Number) : Bytes`
+
+**Description:** Lower-level encryption API. Encrypts the passed bytes by using the specified key and applying the transformations described by the specified parameters. See Cipher.encryptBytes_3(Bytes, String, String, String, Number) for full documentation.
+
+**API Versioned:**
+
+From version 16.2. Does not use a default initialization vector.
+
+**Parameters:**
+
+- `messageBytes`: The bytes to encrypt.
+- `key`: The key to use for encryption.
+- `transformation`: Transformation in "algorithm/mode/padding" format.
+- `saltOrIV`: Initialization value appropriate for the algorithm.
+- `iterations`: The number of passes to make when turning a passphrase into a key.
+
+**Returns:**
+
+the encrypted bytes.
+
+**See Also:**
+
+encrypt_3(String, String, String, String, Number)
+
+---
+
+### encryptBytes
+
+**Signature:** `encryptBytes(messageBytes : Bytes, publicKey : CertificateRef, transformation : String, saltOrIV : String, iterations : Number) : Bytes`
+
+**Description:** Alternative method to encryptBytes_3(Bytes, String, String, String, Number), which allows to use a key in the keystore for the encryption. See Cipher.encryptBytes_3(Bytes, CertificateRef, String, String, Number) for full documentation.
+
+**API Versioned:**
+
+From version 16.2. Does not use a default initialization vector.
+
+**Parameters:**
+
+- `messageBytes`: The bytes to encrypt.
+- `publicKey`: A reference to a public key in the key store.
+- `transformation`: Transformation in "algorithm/mode/padding" format.
+- `saltOrIV`: Initialization value appropriate for the algorithm.
+- `iterations`: The number of passes to make when turning a passphrase into a key.
+
+**Returns:**
+
+the encrypted bytes.
+
+**See Also:**
+
+encrypt_3(String, CertificateRef, String, String, Number)
+
+---

package/docs/dw_crypto/WeakMac.md

@@ -0,0 +1,109 @@
+## Package: dw.crypto
+
+# Class WeakMac
+
+## Inheritance Hierarchy
+
+- Object
+  - dw.crypto.WeakMac
+
+## Description
+
+This API provides access to Deprecated algorithms. See Mac 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.
+
+## Constants
+
+## Properties
+
+## Constructor Summary
+
+WeakMac(algorithm : String) Construct a Mac encryption instance with the specified algorithm name.
+
+## Method Summary
+
+### digest
+
+**Signature:** `digest(input : String, key : String) : Bytes`
+
+Computes the hash value for the passed string input using the passed secret key.
+
+### digest
+
+**Signature:** `digest(input : String, key : Bytes) : Bytes`
+
+Computes the hash value for the passed string input using the passed secret key.
+
+### digest
+
+**Signature:** `digest(input : Bytes, key : Bytes) : Bytes`
+
+Computes the hash value for the passed bytes input using the passed secret key.
+
+## Constructor Detail
+
+## Method Detail
+
+## Method Details
+
+### digest
+
+**Signature:** `digest(input : String, key : String) : Bytes`
+
+**Description:** 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.
+
+---
+
+### digest
+
+**Signature:** `digest(input : String, key : Bytes) : Bytes`
+
+**Description:** 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
+
+**Signature:** `digest(input : Bytes, key : Bytes) : Bytes`
+
+**Description:** 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.
+
+---