Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion data/en/all.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion data/en/functions.json

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions data/en/generatebcrypthash.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"returns":"string",
"description":"It is a password-hashing cryptographic function that takes an input and hashes it into a fixed size output./nNOTE: BCrypt input is limited to 72 bytes.",
"type":"function",
"related":["verifyBCryptHash","generateSCryptHash","verifySCryptHash","hash", "encrypt","decrypt","generateSecretKey"],
"related":["passwordhashgenerate","verifyBCryptHash","generateSCryptHash","verifySCryptHash","hash", "encrypt","decrypt","generateSecretKey"],
"params":[
{"name":"plaintext", "description":"The input string to hash.", "required":true, "default":"", "type":"string", "values":[]},
{"name":"options", "description":"A struct containing the optional values:\n--version - Version of BCrypt hash to generate ($2a,$2y or $2b). (Default is \"$2a\". The most current version is \"$2b\")\n--rounds - Number of rounds to run the hash functions. (Default is 10.)", "required":false, "default":"{\"version\":\"$2a\",\"rounds\":10}", "type":"struct", "values":["version","rounds"]}
],
"engines":{
"coldfusion":{"minimum_version":"2021","notes":"","docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/generatebcrypthash.html"},
"coldfusion":{"minimum_version":"2021","notes":"Deprecated in ColdFusion 2025 Update 8, use passwordHashGenerate(password, \"BCrypt\") instead.","docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/generatebcrypthash.html"},
"boxlang": {"minimum_version":"1.0.0", "notes":"Requires the `bx-password-encrypt` module", "docs":"https://forgebox.io/view/bx-password-encrypt"},
"rustcfml": {"minimum_version": ""}
},
Expand Down
4 changes: 2 additions & 2 deletions data/en/generatescrypthash.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"returns":"string",
"description":"It is a salted password-hashing cryptographic function that takes an input and hashes it into a fixed size output.\nNOTE: This function is less secure than BCrypt.",
"type":"function",
"related":["verifySCryptHash","generateBCryptHash","verifyBCryptHash","hash", "encrypt","decrypt","generateSecretKey"],
"related":["passwordhashgenerate","verifySCryptHash","generateBCryptHash","verifyBCryptHash","hash", "encrypt","decrypt","generateSecretKey"],
"params":[
{"name":"plaintext", "description":"The input string to hash.", "required":true, "default":"", "type":"string", "values":[]},
{"name":"options", "description":"A struct containing the optional values:\n- memorycost - Default is 8.\n- CpuCost - CPU cost of the algorithm (as defined in scrypt, this is `N`) that must be a power of 2 and greater than 1. Default is currently 16,348 or 2^14.\n- Parallel - the parallelization of the algorithm (as defined in scrypt, this is `P`). Default is currently 1.\n- Keylength - key length for the algorithm (as defined in scrypt, this is `dkLen`). Default is currently 32.\n- saltLength - length of the salt to use. Default is 8.", "required":false, "default":"{\"memorycost\":8,\"CpuCost\":16348,\"Parallel\":1,\"KeyLength\":32,\"saltLength\":8}", "type":"struct", "values":[]}
],
"engines":{
"coldfusion":{"minimum_version":"2021","notes":"","docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/generatescrypthash.html"},
"coldfusion":{"minimum_version":"2021","notes":"Deprecated in ColdFusion 2025 Update 8, use passwordHashGenerate(password, \"SCrypt\") instead.","docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/generatescrypthash.html"},
"boxlang": {"minimum_version":"1.0.0", "notes":"Requires the `bx-password-encrypt` module", "docs":"https://forgebox.io/view/bx-password-encrypt"},
"rustcfml": {"minimum_version": ""}
},
Expand Down
2 changes: 1 addition & 1 deletion data/en/index.json

Large diffs are not rendered by default.

43 changes: 43 additions & 0 deletions data/en/passwordhashgenerate.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{
"name":"passwordHashGenerate",
"type":"function",
"syntax":"passwordHashGenerate(password [, algorithm] [, options])",
"returns":"string",
"related":["passwordhashverify","generatebcrypthash","generatescrypthash","generatepbkdfkey","hash"],
"description":"Creates a secure, salted password hash with Argon2 (default, the Argon2id variant), BCrypt or SCrypt. The returned string embeds the algorithm, its cost parameters and the salt, so passwordHashVerify() can check a password against it without further information.",
"params": [
{"name":"password", "description":"The plaintext password to hash.", "required":true, "default":"", "type":"string", "values":[]},
{"name":"algorithm", "description":"The hashing algorithm.", "required":false, "default":"Argon2", "type":"string", "values":["Argon2","BCrypt","SCrypt"]},
{"name":"options", "description":"Algorithm-specific settings; secure defaults are used when omitted.\nArgon2: SALTLENGTH (16), HASHLENGTH (32), PARALLEL (1), MEMORYCOST in KB (4096), CPUCOST (3).\nBCrypt: ROUNDS (10), VERSION (\"$2a\", also \"$2b\" or \"$2y\").\nSCrypt: SALTLENGTH (16), KEYLENGTH (32), PARALLEL (1), MEMORYCOST (8), CPUCOST (16384).", "required":false, "default":"", "type":"struct", "values":[]}
],
"engines": {
"coldfusion": {"minimum_version":"2025", "notes":"Introduced in ColdFusion 2025 Update 8. Replaces the deprecated generateBCryptHash() and generateSCryptHash().", "docs":"https://guides.adobe.com/coldfusion/en/docs/install-and-configure-coldfusion/hash-and-verify-passwords-in-coldfusion.html"}
},
"links": [
{"title":"OWASP Password Storage Cheat Sheet", "description":"General advice from OWASP about how to store passwords.", "url":"https://cheatsheetseries.owasp.org/cheatsheets/Password_Storage_Cheat_Sheet.html"}
],
"examples": [
{
"title": "Hash with the default algorithm (Argon2)",
"description": "Every call produces a different hash because a random salt is generated.",
"code": "hash = passwordHashGenerate(\"userPassword123\");\nwriteOutput(hash);",
"result": "$argon2id$v=19$m=4096,t=3,p=1$cGZyNTFaNDNPaEs1TUt4Sw$CVGQlN+9KRV85Q2jOIVfmw",
"runnable": false
},
{
"title": "Hash with custom Argon2 options",
"description": "Raises the memory cost to 64 MB.",
"code": "hash = passwordHashGenerate(\"userPassword123\", \"Argon2\", {\n\tSALTLENGTH: 16,\n\tHASHLENGTH: 32,\n\tPARALLEL: 1,\n\tMEMORYCOST: 65536,\n\tCPUCOST: 3\n});",
"result": "",
"runnable": false
},
{
"title": "Hash with BCrypt",
"description": "Selects another algorithm through the second argument.",
"code": "hash = passwordHashGenerate(\"userPassword123\", \"BCrypt\");",
"result": "",
"runnable": false
}
]

}
36 changes: 36 additions & 0 deletions data/en/passwordhashverify.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
{
"name":"passwordHashVerify",
"type":"function",
"syntax":"passwordHashVerify(password, hash [, algorithm])",
"returns":"boolean",
"related":["passwordhashgenerate","verifybcrypthash","verifyscrypthash","hash"],
"description":"Verifies a plaintext password against a hash created by passwordHashGenerate(). The algorithm, cost parameters and salt are read from the hash itself. It also verifies hashes created by the deprecated generateBCryptHash() and generateSCryptHash().",
"params": [
{"name":"password", "description":"The plaintext password to verify.", "required":true, "default":"", "type":"string", "values":[]},
{"name":"hash", "description":"The stored hash to verify against.", "required":true, "default":"", "type":"string", "values":[]},
{"name":"algorithm", "description":"The algorithm the hash was created with.", "required":false, "default":"", "type":"string", "values":["Argon2","BCrypt","SCrypt"]}
],
"engines": {
"coldfusion": {"minimum_version":"2025", "notes":"Introduced in ColdFusion 2025 Update 8. Replaces the deprecated verifyBCryptHash() and verifySCryptHash().", "docs":"https://guides.adobe.com/coldfusion/en/docs/install-and-configure-coldfusion/hash-and-verify-passwords-in-coldfusion.html"}
},
"links": [
{"title":"OWASP Password Storage Cheat Sheet", "description":"General advice from OWASP about how to store passwords.", "url":"https://cheatsheetseries.owasp.org/cheatsheets/Password_Storage_Cheat_Sheet.html"}
],
"examples": [
{
"title": "Verify a password at login",
"description": "Hashes a password, then checks a correct and a wrong password against the hash.",
"code": "storedHash = passwordHashGenerate(\"mySecurePassword\");\nwriteOutput(passwordHashVerify(\"mySecurePassword\", storedHash, \"Argon2\"));\nwriteOutput(passwordHashVerify(\"wrongPassword\", storedHash, \"Argon2\"));",
"result": "YESNO",
"runnable": false
},
{
"title": "Verify a hash from the deprecated BCrypt function",
"description": "Hashes created with generateBCryptHash() can be checked with the new function.",
"code": "oldHash = generateBCryptHash(\"myPassword\");\nwriteOutput(passwordHashVerify(\"myPassword\", oldHash, \"BCrypt\"));",
"result": "YES",
"runnable": false
}
]

}
4 changes: 2 additions & 2 deletions data/en/verifybcrypthash.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"returns":"boolean",
"description":"This function compares a plaintext entry to the hashed string.\nNOTE 1:Hashing is one-way, so you can't \"decrypt\" a hashed value. You have to hash the value you want to check and then compare that to the saved hash.\nNOTE 2: The version and rounds don't need to be specified because they are included at the beginning of the hashed string.",
"type":"function",
"related":["generateBCryptHash","generateSCryptHash","verifySCryptHash","hash", "encrypt","decrypt","generateSecretKey"],
"related":["passwordhashverify","generateBCryptHash","generateSCryptHash","verifySCryptHash","hash", "encrypt","decrypt","generateSecretKey"],
"params":[
{"name":"plaintext", "description":"The unhashed string to compare.", "required":true, "default":"", "type":"string", "values":[]},
{"name":"hashedstring", "description":"The hashed string to compare.", "required":true, "default":"", "type":"string", "values":[]}
],
"engines":{
"coldfusion":{"minimum_version":"2021","notes":"","docs":"https://helpx.adobe.com/ca/coldfusion/cfml-reference/coldfusion-functions/functions-t-z/verifybcrypthash.html"},
"coldfusion":{"minimum_version":"2021","notes":"Deprecated in ColdFusion 2025 Update 8, use passwordHashVerify(password, hash, \"BCrypt\") instead.","docs":"https://helpx.adobe.com/ca/coldfusion/cfml-reference/coldfusion-functions/functions-t-z/verifybcrypthash.html"},
"rustcfml": {"minimum_version": ""}
},
"links":[
Expand Down
4 changes: 2 additions & 2 deletions data/en/verifyscrypthash.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@
"returns":"boolean",
"description":"This function compares a plaintext entry to the hashed string.\nNOTE 1:Hashing is one-way, so you can't \"decrypt\" a hashed value. You have to hash the value you want to check and then compare that to the saved hash.",
"type":"function",
"related":["generateSCryptHash","generateBCryptHash","verifyBCryptHash","hash", "encrypt","decrypt","generateSecretKey"],
"related":["passwordhashverify","generateSCryptHash","generateBCryptHash","verifyBCryptHash","hash", "encrypt","decrypt","generateSecretKey"],
"params":[
{"name":"plaintext", "description":"The unhashed string to compare.", "required":true, "default":"", "type":"string", "values":[]},
{"name":"hashedString", "description":"The hashed string to compare.", "required":true, "default":"", "type":"string", "values":[]},
{"name":"options", "description":"A struct containing the optional values:\n--memorycost - Default is 8.\n--CpuCost - CPU cost of the algorithm (as defined in scrypt, this is `N`) that must be a power of 2 and greater than 1. Default is currently 16,348 or 2^14.\n--Parallel - the parallelization of the algorithm (as defined in scrypt, this is `P`). Default is currently 1.\n--Keylength - key length for the algorithm (as defined in scrypt, this is `dkLen`). Default is currently 32.\n--saltLength - length of the salt to use. Default is 8.", "required":false, "default":"{\"memorycost\":8,\"CpuCost\":16348,\"Parallel\":1,\"KeyLength\":32,\"saltLength\":8}", "type":"struct", "values":[]}
],
"engines":{
"coldfusion":{"minimum_version":"2021","notes":"","docs":"https://helpx.adobe.com/ca/coldfusion/cfml-reference/coldfusion-functions/functions-t-z/verifyscrypthash.html"},
"coldfusion":{"minimum_version":"2021","notes":"Deprecated in ColdFusion 2025 Update 8, use passwordHashVerify(password, hash, \"SCrypt\") instead.","docs":"https://helpx.adobe.com/ca/coldfusion/cfml-reference/coldfusion-functions/functions-t-z/verifyscrypthash.html"},
"rustcfml": {"minimum_version": ""}
},
"links":[
Expand Down
Loading