FabInfra-Mirror/api.fabaccess-api
1
0
Fork 0
mirror of https://gitlab.com/fabinfra/fabaccess/fabaccess-api.git synced 2025-03-12 14:51:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

Adds auth comments

Browse Source
This commit is contained in:
Gregor Reitzenstein 2020-10-26 14:08:32 +01:00
parent 25effe2626
commit 2b242d4f5c
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
auth.capnp
View File

@ -34,16 +34,22 @@ interface Authentication {
start @1 ( request :Request ) -> ( response :Response ); start @1 ( request :Request ) -> ( response :Response );
# Initiate an authentication exchange # Initiate an authentication exchange
# NOTE: Calling start() after an authentication exchange has already
# finished is undefined behaviour. If you want to double-authenticate call
# auth() from connection.capnp again to get a fresh capability you can use.
# This may however return NULL if you are not allowed to authenticate twice.
step @2 ( response :Data ) -> ( response :Response ); step @2 ( response :Data ) -> ( response :Response );
# Respond to a challenge with more data # Respond to a challenge with more data
# NOTE: As with start() calling this after having received an outcome is
# undefined behaviour.
abort @3 () -> (); abort @3 () -> ();
# Abort the current exchange. This may be sent by both client and server # Abort the current exchange. This may be sent by both client and server
# at any point during the exchange. It MUST not be sent by a server # at any point during the exchange. It MUST not be sent by a server
# after sending an outcome or by a client after receiving an outcome. # after sending an outcome or by a client after receiving an outcome.
# A server receiving an abort after sending an outcome but before # A server receiving an abort after sending an outcome but before
# receiving any non-authentication message MUST respect the abort. # receiving any other message MUST respect the abort.
} }
struct Request { struct Request {