Skip to content

Commit d611814

Browse files
authored
README.md: clarify SSH vs OpenSSH formats (#206)
Several OpenSSH-specific formats were previously described as "SSH". This commit changes the ones that are only in OpenSSH to be "OpenSSH", and only uses "SSH" for formats with pre-OpenSSH support.
1 parent 8a2d9ee commit d611814

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

ssh-key/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,13 @@ respective SSH key algorithm.
3333

3434
- [x] Constant-time Base64 decoder/encoder using `base64ct`/`pem-rfc7468` crates
3535
- [x] OpenSSH-compatible decoder/encoders for the following formats:
36-
- [x] SSH public keys
37-
- [x] SSH private keys (i.e. `BEGIN OPENSSH PRIVATE KEY`)
38-
- [x] SSH certificates
39-
- [x] SSH signatures (a.k.a. "sshsig")
36+
- [x] OpenSSH public keys
37+
- [x] OpenSSH private keys (i.e. `BEGIN OPENSSH PRIVATE KEY`)
38+
- [x] OpenSSH certificates
39+
- [x] OpenSSH signatures (a.k.a. "sshsig")
4040
- [x] OpenSSH certificate support
41-
- [x] Certificate validation
42-
- [x] Certificate authority (CA) support i.e. cert builder/signer
41+
- [x] OpenSSH certificate validation
42+
- [x] OpenSSH certificate authority (CA) support i.e. cert builder/signer
4343
- [x] Private key encryption/decryption (`bcrypt-pbkdf` + `aes256-ctr` only)
4444
- [x] Private key generation support: DSA, Ed25519, ECDSA (P-256/P-384/P-521),
4545
and RSA
@@ -56,10 +56,10 @@ respective SSH key algorithm.
5656

5757
- [ ] FIDO/U2F signature support
5858
- [ ] Legacy (pre-OpenSSH) SSH key format support
59-
- [ ] PKCS#1
60-
- [ ] PKCS#8
61-
- [ ] [RFC4716] public keys
62-
- [ ] SEC1
59+
- [ ] PKCS#1 SSH private keys (i.e. RSA-only)
60+
- [ ] PKCS#8 SSH private keys
61+
- [ ] [RFC4716] SSH public keys
62+
- [ ] SEC1 SSH public keys
6363

6464
### Supported Signature Algorithms
6565

@@ -74,7 +74,7 @@ respective SSH key algorithm.
7474
| `sk‑ecdsa‑sha2‑[email protected]` ||||| ⛔️ | ✅️ || `alloc` |
7575
| `sk‑ssh‑[email protected]` ||||| ⛔️ | ✅️️ | `ed25519` | `alloc` |
7676

77-
By default *no algorithms are enabled* and you will get an
77+
By default *no SSH signature algorithms are enabled* and you will get an
7878
`Error::AlgorithmUnsupported` error if you try to use them.
7979

8080
Enable the `crypto` feature or the "Feature" for specific algorithms in the

0 commit comments

Comments
 (0)