Ailur
/
burgernotes-server
3
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Update APIDOCS.md

This commit is contained in:
Tracker-Friendly 2024-02-25 19:38:36 +00:00
parent f78cef790e
commit c474b62d16
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
APIDOCS.md
View File

@ -13,21 +13,29 @@ To prevent the server from knowing the encryption key, the password you provide
If you wish to change the user's password, set "changepassword" to "yes" and "newpass" to the new hash. If you wish to change the user's password, set "changepassword" to "yes" and "newpass" to the new hash.
Some users use the legacy argon2id mode (by which i mean about 8), and to implement argon2id functionality, you hash like this:
Some users use the legacy argon2id mode (by which i mean about 8, so only implement if you feel like it), and to implement argon2id functionality, you hash like this:
Parallelism should be 1 Parallelism should be 1
Iterations should be 256 Iterations should be 256
Memory Allocated in bytes should be 512 Memory Allocated in bytes should be 512
Length of Hash should be 32 bytes Length of Hash should be 32 bytes
The output should be in the encoded format, not the hashed format The output should be in the encoded format, not the hashed format
Salt should be the SHA512 of the password Salt should be the SHA512 of the password
(Yes i know this is really bad practice, guess why we are replacing it) (Yes i know this is really bad practice, guess why we are replacing it)
To test if SHA-3 or argon2 is used, just try the SHA-3 and if 422 gets returned try argon2. To test if SHA-3 or argon2 is used, just try the SHA-3 and if 422 gets returned try argon2.
(For the sake of all of us, change the password to the SHA-3 hash) (For the sake of all of us, change the password to the SHA-3 hash)
Password should be at least 8 characters, username must be under 20 characters and alphanumeric. Password should be at least 8 characters, username must be under 20 characters and alphanumeric.
If username is taken, error code 422 will return. If username is taken, error code 422 will return.