Merge pull request #2221 from hagau/ssh_api_lib_doc

Improve sshauthentication-api documentation
This commit is contained in:
Dominik Schürmann 2017-11-27 13:25:50 +01:00 committed by GitHub
commit 560834410b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 0 deletions

View file

@ -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)

View file

@ -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";