bibisixtynine
/
Burgernotes
forked from Ailur/burgernotes-server
1
0
Fork 0
Code Pull Requests Activity

Merge pull request 'Some usefull things in the APIDOCS from my devlopement of the client' (#2) from arzumify/burgernotes:main into main 

Reviewed-on: https://codeberg.org/burger-software/burgernotes/pulls/2
This commit is contained in:
maaa 2023-08-06 17:21:05 +00:00
parent e0ce6b57f5 e8070b0323
commit a8efb6cc5e
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
APIDOCS.md
View File

@ -1,6 +1,8 @@
# Burgernotes API docs # Burgernotes API docs
Use the Burgernotes API to automate tasks, build your own client, and more! Use the Burgernotes API to automate tasks, build your own client, and more!
Headers should be: "Content-type: application/json; charset=UTF-8" for all POSTs
## Authentication ## Authentication
POST - /api/signup - provide "username" and "password". POST - /api/signup - provide "username" and "password".
@ -8,6 +10,14 @@ POST - /api/signup - provide "username" and "password".
POST - /api/login - provide "username" and "password". POST - /api/login - provide "username" and "password".
To prevent the server from knowing the encryption key, password you provide in the request must be hashed with the argon2 algorithm. To prevent the server from knowing the encryption key, password you provide in the request must be hashed with the argon2 algorithm.
Parallelism should be 1
Iterations should be 256
Memory Allocated in bytes should be 512
Length of Hash should be 32 bytes
The output should be in the encoded format, not the hashed format
The salt should be the SHA-512 of the password. The salt should be the SHA-512 of the password.
Password must be at least 14 characters, username must be under 20 characters and alphanumeric. Password must be at least 14 characters, username must be under 20 characters and alphanumeric.