Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation #100

Merged
merged 8 commits into from
Aug 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,13 @@ Secrets App supports the following features:
- Touch-button protected use per credential.

The pynitrokey library can be used to communicate with this application over CTAPHID, and nitropy provides the CLI using
it.
it. See [ctaphid.md](docs/ctaphid.md) for the details.

CCID transport is also available, and while not supported in the mentioned library yet, it can be potentially used by
the protocol-compatible applications, like the mentioned KeepassXC.

See [design.md](docs/design.md) for the UX design choices.

[RFC4226]: https://www.rfc-editor.org/rfc/rfc4226

[RFC6238]: https://www.rfc-editor.org/rfc/rfc6238
Expand Down Expand Up @@ -99,7 +101,7 @@ e.g. due to being taken by other services, or requiring Administrator
privileges). A CTAPHID vendor command number was selected to use (`0x70`), thus allowing for a compatible extension of
any FIDO compliant device.

See [CTAPHID](ctaphid.md) for the further documentation regarding the NLnet funded CTAPHID extension.
See [CTAPHID](docs/ctaphid.md) for the further documentation regarding the NLnet funded CTAPHID extension.

### Further work

Expand All @@ -119,6 +121,8 @@ Tasks and features still discussed to be done:

### Development

See [design](docs/design.md) document to see decisions taken to make the solution cohesive.

Use `dangerous_disable_encryption` Rust flag to disable data encryption for the debug purposes. E.g.:

```text
Expand Down
265 changes: 0 additions & 265 deletions ctaphid.md

This file was deleted.

Loading