Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
ianjoneill committed Dec 22, 2024
1 parent 615fab4 commit 9c49609
Showing 3 changed files with 8 additions and 9 deletions.
10 changes: 4 additions & 6 deletions docs/dependencies.md
Original file line number Diff line number Diff line change
@@ -93,10 +93,10 @@ implementation. This is also an **optional** dependency and must be add explicit

## [ed25519-java](https://github.com/str4d/ed25519-java)

Required for supporting [ssh-ed25519](https://tools.ietf.org/html/draft-bjh21-ssh-ed25519-02) keys
and [ed25519-sha-512](https://tools.ietf.org/html/draft-josefsson-eddsa-ed25519-02) signatures. **Note:**
the required Maven module(s) are defined as `optional` so must be added as an **explicit** dependency in
order to be included in the classpath:
Can optionally be provided to support [ssh-ed25519](https://tools.ietf.org/html/draft-bjh21-ssh-ed25519-02) keys
and [ed25519-sha-512](https://tools.ietf.org/html/draft-josefsson-eddsa-ed25519-02) signatures where [Bouncy Castle](#bouncy-castle) is not suitable. **Note:**
use of this dependency is not recommended, but it can be added as an **explicit** dependency in
order to provide Ed25519 support as follows:


```xml
@@ -108,5 +108,3 @@ order to be included in the classpath:
</dependency>

```

The code contains support for reading _ed25519_ [OpenSSH formatted private keys](https://issues.apache.org/jira/browse/SSHD-703).
4 changes: 2 additions & 2 deletions docs/files-parsing.md
Original file line number Diff line number Diff line change
@@ -18,8 +18,8 @@ and `HostConfigEntry#readHostConfigEntries`.
### PEM/OpenSSH

The common code contains built-in support for parsing PEM and/or _OpenSSH_ formatted key files and using them for authentication purposes.
As mentioned previously, it can leverage _Bouncycastle_ if available, but can do most of the work without it as well. For _ed25519_ support,
one must provide the _eddsa_ artifact dependency.
As mentioned previously, it can leverage _Bouncy Castle_ if available, but can do most of the work without it as well. For _ed25519_ support,
one must provide either `net.i2p.crypto.eddsa` or _Bouncy Castle_ as a dependency; if both are present `net.i2p.crypto.eddsa` is used.

### [PUTTY](https://www.putty.org/)

3 changes: 2 additions & 1 deletion docs/standards.md
Original file line number Diff line number Diff line change
@@ -110,7 +110,8 @@ mlkem1024nistp384-sha384.
### Signatures/Keys

* ssh-dss, ssh-rsa, rsa-sha2-256, rsa-sha2-512, nistp256, nistp384, nistp521
, ssh-ed25519 (requires `eddsa` optional module), sk-ecdsa-sha2-nistp256@openssh.com, sk-ssh-ed25519@<!-- -->openssh.com
, ssh-ed25519 (requires Bouncy Castle or `net.i2p.crypto.eddsa` as an optional dependency - if both are present, `net.i2p.crypto.eddsa` is used)
, sk-ecdsa-sha2-nistp256@openssh.com, sk-ssh-ed25519@<!-- -->openssh.com
, ssh-rsa-cert-v01@<!-- -->openssh.com, ssh-dss-cert-v01<!-- -->@openssh.com, ssh-ed25519-cert-v01@<!-- -->openssh.com
, ecdsa-sha2-nistp256-cert-v01@<!-- -->openssh.com, ecdsa-sha2-nistp384-cert-v01<!-- -->@openssh.com
, ecdsa-sha2-nistp521-cert-v01<!-- -->@openssh.com

0 comments on commit 9c49609

Please sign in to comment.