docs: publish password hashing APIs
This commit is contained in:
@@ -14,3 +14,6 @@ hmac_sha256
|
||||
hmac_sha256_hex
|
||||
random_bytes
|
||||
crypto_equal
|
||||
password_hash
|
||||
password_verify
|
||||
password_needs_rehash
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
:sig
|
||||
String password_hash(String password)
|
||||
|
||||
:params
|
||||
password : password bytes to hash
|
||||
return value : self-contained scrypt encoding, or an empty string on failure
|
||||
|
||||
:content
|
||||
Creates a password credential with a cryptographically random salt and UCE's current bounded scrypt parameters. Store the returned encoding exactly as produced. An empty result means hashing failed; abort the credential write and report an operational error instead of storing it.
|
||||
|
||||
:example
|
||||
String encoded = password_hash("correct horse battery staple");
|
||||
print(encoded != "" && password_verify("correct horse battery staple", encoded) ? "valid" : "failed", "\n");
|
||||
|
||||
:see
|
||||
>sys
|
||||
password_verify
|
||||
password_needs_rehash
|
||||
@@ -0,0 +1,18 @@
|
||||
:sig
|
||||
bool password_needs_rehash(String encoded)
|
||||
|
||||
:params
|
||||
encoded : stored password credential
|
||||
return value : true when the encoding is malformed or does not use UCE's current parameters
|
||||
|
||||
:content
|
||||
Checks whether a stored UCE password encoding should be replaced. Call it only after successful verification, then hash the known-correct password again and atomically replace the old credential. Non-UCE legacy formats are reported as needing rehash but must be verified by the application before upgrade.
|
||||
|
||||
:example
|
||||
String old = "$uce$scrypt$16384$8$1$00112233445566778899aabbccddeeff$29fdfb3d991961e926a19c1136a07e252afa5fdb8d3a0fb74cdcfa5016956f34";
|
||||
print(password_verify("legacy password", old) && password_needs_rehash(old) ? "upgrade" : "keep", "\n");
|
||||
|
||||
:see
|
||||
>sys
|
||||
password_hash
|
||||
password_verify
|
||||
@@ -0,0 +1,20 @@
|
||||
:sig
|
||||
bool password_verify(String password, String encoded)
|
||||
|
||||
:params
|
||||
password : candidate password bytes
|
||||
encoded : self-contained `$uce$scrypt$...` credential
|
||||
return value : true only when the password matches a structurally valid, bounded encoding
|
||||
|
||||
:content
|
||||
Derives the candidate with the parameters embedded in `encoded` and compares the result in constant time. Malformed encodings and parameters above UCE's accepted memory/work policy are rejected before derivation. Apply application-level password length limits and rate limiting around public authentication endpoints.
|
||||
|
||||
:example
|
||||
String encoded = password_hash("correct horse battery staple");
|
||||
print(password_verify("correct horse battery staple", encoded) ? "valid" : "invalid", " / ");
|
||||
print(password_verify("wrong password", encoded) ? "valid" : "invalid", "\n");
|
||||
|
||||
:see
|
||||
>sys
|
||||
password_hash
|
||||
password_needs_rehash
|
||||
Reference in New Issue
Block a user