plate/telodendria
1
0
Fork 0
forked from lda/telodendria
Code Pull requests Activity Actions

Document MatrixAuthenticate and MatrixRateLimit

Browse source
This commit is contained in:
Jordan Bancino 2022-12-16 22:15:50 +00:00
parent 836b61dc42
commit 53846b0994
1 changed files with 21 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
man/man3/Matrix.3
View file

@ -12,6 +12,10 @@
.Fn MatrixErrorCreate "MatrixError" .Fn MatrixErrorCreate "MatrixError"
.Ft HashMap * .Ft HashMap *
.Fn MatrixUserInteractiveAuth "HttpServerContext *" "Db *" "HashMap *" .Fn MatrixUserInteractiveAuth "HttpServerContext *" "Db *" "HashMap *"
.Ft HashMap *
.Fn MatrixAuthenticate "HttpServerContext *" "Db *"
.Ft HashMap *
.Fn MatrixRateLimit "HttpServerContext *" "Db *"
.Sh DESCRIPTION .Sh DESCRIPTION
.Nm .Nm
provides some helper functions that bind to the provides some helper functions that bind to the
@ -87,17 +91,29 @@ convenient abstraction. Currently, it only implements a single-stage
"m.login.dummy" auth, so it's more of a formality than anything else, "m.login.dummy" auth, so it's more of a formality than anything else,
but in the future, this function may support more authentication but in the future, this function may support more authentication
flows. flows.
.Pp
.Fn MatrixAuthenticate
checks the request for a valid access token, which indicates that a
user is authenticated.
.Pp
.Fn MatrixRateLimit
determines whether or not the request should be rate limited. It is
expected that this will occur before most, if not all of the caller's
logic.
.Sh RETURN VALUES .Sh RETURN VALUES
.Pp .Pp
.Fn MatrixErrorCreate .Fn MatrixErrorCreate
returns a JSON object that represents the given error code. It can be returns a JSON object that represents the given error code. It can be
immediately returned as the HTTP response body, or modified as needed. immediately returned as the HTTP response body, or modified as needed.
.Pp .Pp
.Fn MatrixUserInteractiveAuth .Fn MatrixUserInteractiveAuth ,
returns NULL when the auth is successful. That is, if it returns NULL, .Fn MatrixAuthenticate ,
then the caller can proceed assuming that the client has done all the and
right things to authenticate itself. If this function does not return .Fn MatrixRateLimit
NULL, then the returned JSON object should be passed along to the all return NULL when they are successful. That is, if these functions
return NULL, then the caller can proceed assuming that all is well
and no further action needs to be taken. If these functions do not
return NULL, then the returned JSON object should be passed along to the
client immediately without continuing. client immediately without continuing.
.Sh SEE ALSO .Sh SEE ALSO
.Xr HttpServer 3 , .Xr HttpServer 3 ,