ssh_client_key_api
(ssh)-behaviour(ssh_client_key_api).
Behavior describing the API for public key handling of an SSH client. By implementing
the callbacks defined in this behavior, the public key handling of an SSH client can
be customized. By default the ssh
application implements this behavior
with help of the standard OpenSSH files,
see the ssh(6) application manual.
DATA TYPES
Type definitions that are used more than once in this module, or abstractions to indicate the intended use of the data type, or both. For more details on public key data types, refer to Section 2 Public Key Records in the public_key user's guide:
boolean() =
true | false
string() =
[byte()]
public_key() =
#'RSAPublicKey'{}| {integer(), #'Dss-Parms'{}}| term()
private_key() =
#'RSAPrivateKey'{} | #'DSAPrivateKey'{} | term()
public_key_algorithm() =
'ssh-rsa'| 'ssh-dss' | atom()
Functions
Module:add_host_key(HostNames, Key, ConnectOptions) -> ok | {error, Reason}
HostNames = string()
Key = public_key()
ConnectOptions = proplists:proplist()
Reason = term().
PublicKey
.Adds a host key to the set of trusted host keys.
Module:is_host_key(Key, Host, Algorithm, ConnectOptions) -> Result
Key = public_key()
Host = string()
Algorithm = public_key_algorithm()
ConnectOptions = proplists:proplist()
Result = boolean()
'ssh-rsa'| 'ssh-dss'
, but more algorithms
can be handled.Checks if a host key is trusted.
Module:user_key(Algorithm, ConnectOptions) -> {ok, PrivateKey} | {error, Reason}
Algorithm = public_key_algorithm()
ConnectOptions = proplists:proplist()
PrivateKey = private_key()
Reason = term()
'ssh-rsa'| 'ssh-dss'
but more algorithms
can be handled.Algorithm
.Fetches the users public key matching the Algorithm
.
Note!
The private key contains the public key.