From 15a614fc59504bdaee9cf224b1a8021cfa8820f5 Mon Sep 17 00:00:00 2001 From: Christian Hagau Date: Wed, 22 Nov 2017 00:00:00 +0000 Subject: [PATCH] - Add a README.md to sshauthentication-api - Add a note regarding the use of the hash algorithm parameter for EdDSA signatures --- sshauthentication-api/README.md | 11 +++++++++++ .../ssh/authentication/SshAuthenticationApi.java | 2 ++ 2 files changed, 13 insertions(+) create mode 100644 sshauthentication-api/README.md diff --git a/sshauthentication-api/README.md b/sshauthentication-api/README.md new file mode 100644 index 000000000..24d465a96 --- /dev/null +++ b/sshauthentication-api/README.md @@ -0,0 +1,11 @@ +# SSH authentication API library + +The SSH authentication API library provides an interface to using an external authentication provider in the SSH authentication layer. + +### License +[Apache License v2](https://github.com/open-keychain/openpgp-api/blob/master/LICENSE) + +### API +For a basic rundown of the API design see the OpenPGP API library's [README.md](https://github.com/open-keychain/openpgp-api/blob/master/README.md). +For a description of the supported methods see [``org.openintents.ssh.authentication.SshAuthenticationApi``](https://github.com/open-keychain/open-keychain/blob/master/sshauthentication-api/src/main/java/org/openintents/ssh/authentication/SshAuthenticationApi.java) + diff --git a/sshauthentication-api/src/main/java/org/openintents/ssh/authentication/SshAuthenticationApi.java b/sshauthentication-api/src/main/java/org/openintents/ssh/authentication/SshAuthenticationApi.java index adce16718..0da5d5fdf 100644 --- a/sshauthentication-api/src/main/java/org/openintents/ssh/authentication/SshAuthenticationApi.java +++ b/sshauthentication-api/src/main/java/org/openintents/ssh/authentication/SshAuthenticationApi.java @@ -49,6 +49,8 @@ public class SshAuthenticationApi { * * returned extras: * byte[] EXTRA_SIGNATURE + * + * Note: for EdDSA the hash algorithm is ignored, PureEdDSA has to be implemented */ public static final String ACTION_SIGN = "org.openintents.ssh.action.SIGN"; public static final String EXTRA_CHALLENGE = "challenge";