Skip to content

Commit

Permalink
Link docs to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
szszszsz committed Aug 18, 2023
1 parent bd5320c commit 62b99ca
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
4 changes: 3 additions & 1 deletion 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
3 changes: 3 additions & 0 deletions docs/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,6 @@ malware threats by incorporating physical user presence confirmation for critica
| Secrets App Next (TBD) | (no changes) |


Other:
- do not allow to overwrite credentials - always require explicit deletion of the credential with the same name
- remove YKOATH protocol compatibility, specifically authentication through challenge-response

0 comments on commit 62b99ca

Please sign in to comment.