diff options
author | Technion <technion@lolware.net> | 2013-06-06 06:07:48 -0400 |
---|---|---|
committer | Technion <technion@lolware.net> | 2013-06-06 06:07:48 -0400 |
commit | 300ad52ec76905dff7aa8b20a28c0673cb311982 (patch) | |
tree | 57bd5b6505e1af22573d35d5f3960c713a835590 /README.md | |
parent | f1dab123746babe78370e652bc8e52e2acadd6a3 (diff) |
Documentation
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 9 |
1 files changed, 9 insertions, 0 deletions
@@ -21,8 +21,11 @@ Sane constants have been created for N, r and p so you can create a has like thi Output stored in "outbuf" is stored in a standardised MCF form, which means includes the randomly created, 128 bit salt, all N, r and p values, and a BASE64 encoded version of the hash. The entire MCF can be stored in a database, and compared for use as below: > retval = scrypt_check(mcf, "pleasefailme"); + > retval < 0 error + > retval = 0 password incorrect + > retval > 0 pass mcf should be defined as at least SCRYPT_MCF_LEN in size. @@ -30,3 +33,9 @@ mcf should be defined as at least SCRYPT_MCF_LEN in size. A number of internal functions are exposed, and users wishing to create more complex use cases should consult the header file, which is aimed at documenting the API fully. The test reference is also aimed at providing a well documented use case. + +Notes on Code Development +------------------------ + +Once declared "stable", the master branch will always be "stable" and development will be done on branches. +The reference machines are CentOS, Raspbian and FreeBSD, and the code is expected to compile and run on all of these before being moved to stable branch. |