Add architecture docs #92
Conversation
iinuwa
force-pushed
the
architecture-docs
branch
2 times, most recently
from
1049080 to
7ec93ab
Compare
msirringhaus
left a comment
msirringhaus
left a comment
There was a problem hiding this comment.
Left some minor comments, but otherwise looking good!
ARCHITECTURE.md
Outdated
| the Gateway. | ||
|
|
||
| The **UI Control API** is used to launch a UI for the user to respond to | ||
| authenticator requests for user interaction. The **Flow Controller** mediates |
There was a problem hiding this comment.
Even though we have a dedicated API-doc, I feel like the short explanation of the Flow Controller could be a bit more precise.
There was a problem hiding this comment.
I think I'm suffering from the curse of knowledge here. Could you elaborate on how I could expand? I added a couple of sentences, but I don't know if that's sufficient.
ARCHITECTURE.md
Outdated
|
|
||
| ### `credentialsd/src/webauthn.rs` | ||
|
|
||
| Types and functions to deal with WebAuthn data. |
There was a problem hiding this comment.
Could be a bit more precise. Something like "Types and functions needed to repackage requests from and responses to JSON-strings according to the WebAuthn spec (link: https://www.w3.org/TR/webauthn-3).
With one notable deviation from the spec: Due to D-Bus limitations, raw binary fields need to be base64 encoded strings.
It is the responsibility of the application using this service to de/construct the field accordingly."
There was a problem hiding this comment.
Yeah, I was tired by this point 😃.
Thanks for the suggestion. I'll rephrase slightly and use "Due to JSON limitations," since D-Bus is capable of passing binary data, but we're choosing to wrap responses in JSON.
iinuwa
force-pushed
the
architecture-docs
branch
from
07d6fa5 to
e17d0c9
Compare
|
Merged, but if there are any other comments on this guide, we can still discuss here |
Changed
ARCHITECTURE.mddocumentationcontribtodocThe latter change will change the build scripts.
Closes #84.