Skip to content

Commit

Permalink
Merge pull request #100 from Nitrokey/update-documentation
Browse files Browse the repository at this point in the history
Update documentation
  • Loading branch information
szszszsz authored Aug 18, 2023
2 parents 6e1c0d3 + 98c458b commit 210e8ec
Show file tree
Hide file tree
Showing 5 changed files with 362 additions and 277 deletions.
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

0 comments on commit 210e8ec

Please sign in to comment.