Richard Hansen 2020-09-02 17:16:02 -04:00 committed by John McLear
parent 9962be2450
commit 2bf076043f
3 changed files with 15 additions and 27 deletions

View file

@ -30,10 +30,12 @@ var authLogger = log4js.getLogger("auth");
* This function controlls the access to a pad, it checks if the user can access a pad.
* @param padID the pad the user wants to access
* @param sessionCookie the session the user has (set via api)
* @param token a random token representing the author, of the form
* t.randomstring_of_lenght_20. The random string is generated by
* the client.
* @param token A random token representing the author, of the form t.randomstring_of_length_20.
* The random string is generated by the client.
* Used for every pad in the web UI. Not used for the HTTP API.
* If there is not already an author associated with this token, and access is not
* denied, an author object will be created (including generating an author ID) and
* saved in the DB.
* @param password the password the user has given to access this pad, can be null
* @return {accessStatus: grant|deny|wrongPassword|needPassword, authorID: a.xxxxxx})
*/