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.

Sign up for GitHub

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

Jump to bottom

Update USAGE.md and README.md to reflect newly supported devices and algorithms #107

Merged
merged 2 commits into from
Jan 31, 2023
Merged

Update USAGE.md and README.md to reflect newly supported devices and algorithms #107

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e10ea0a
Update USAGE.md and README.md to reflect newly supported devices and …
sosthene-nitrokey Jan 31, 2023
7645615
Point to firmware alpha releases
sosthene-nitrokey Jan 31, 2023
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
14 changes: 11 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,17 @@ is not guaranteed.
## Features

`opcard` currently supports the basic OpenPGP Card functionality (key generation,
key import, signing, decrypting, card administration) for Curve25519 and NIST
P-256. See the [issues for the v1.0.0 milestone][v1.0.0 milestone] for all
missing features for a first stable release.
key import, signing, decrypting, card administration).

Here are the currently supported algorithms:

- RSA-2048
- RSA-4096 (no key generation, key import only)
- EcDSA and ECDH for P256
- EdDSA and ECDH for Curve25519

See the [issues for the v1.0.0 milestone][v1.0.0 milestone] for all missing
features for a first stable release.

[v1.0.0 milestone]: https://github.com/Nitrokey/opcard-rs/milestone/2

Expand Down
8 changes: 3 additions & 5 deletions USAGE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,9 @@ is not guaranteed.

## Installation

Currently only available for the Nitrokey 3A Mini.

Download the latest compiled [release](https://github.com/Nitrokey/opcard-rs/releases) ZIP file.
Plug your Nitrokey 3A Mini and use [nitropy](https://docs.nitrokey.com/software/nitropy/) to install it with
`nitropy nk3 update <path/to/release/zip/file>`
Download the latest compiled [release](https://github.com/Nitrokey/opcard-rs/releases).
Plug your Nitrokey 3 and use [nitropy](https://docs.nitrokey.com/software/nitropy/) to install it with
`nitropy nk3 update <path/to/release/file>`
robin-nitrokey marked this conversation as resolved.
Show resolved Hide resolved

## Generating keys

Expand Down