1ssh_server_key_api(3)      Erlang Module Definition      ssh_server_key_api(3)
2
3
4

NAME

6       ssh_server_key_api -
7           -behaviour(ssh_server_key_api).
8
9

DESCRIPTION

11       Behaviour  describing the API for public key handling of an SSH server.
12       By implementing the callbacks defined in this behavior, the public  key
13       handling  of an SSH server can be customized. By default the SSH appli‐
14       cation implements this behavior  with  help  of  the  standard  OpenSSH
15       files, see the  ssh(6) application manual.
16

DATA TYPES

18       daemon_key_cb_options() =
19           [{key_cb_private, term()} | ssh:daemon_option()]
20
21              Options provided to ssh:daemon/2,3.
22
23              The option list given in the key_cb option is available with the
24              key key_cb_private.
25

EXPORTS

27       Module:host_key(Algorithm, DaemonOptions) -> {ok, Key} |  {error,  Rea‐
28       son}
29
30              Types:
31
32                 Algorithm = ssh:pubkey_alg()
33                   Host key algorithm.
34                 DaemonOptions = daemon_key_cb_options()
35                 PrivateKey         =        public_key:private_key()        |
36                 crypto:engine_key_ref()
37                   Private key of the host matching the Algorithm. It may be a
38                   reference  to  a  'ssh-rsa',  rsa-sha2-*  or 'ssh-dss' (NOT
39                   ecdsa) key stored in a loaded Engine.
40                 Reason = term()
41
42              Fetches the private key of the host.
43
44       Module:is_auth_key(PublicUserKey, User, DaemonOptions) -> Result
45
46              Types:
47
48                 PublicUserKey = public_key:public_key()
49                   Normally an RSA, DSA or ECDSA public key, but  handling  of
50                   other public keys can be added
51                 User = string()
52                   User owning the public key.
53                 DaemonOptions = daemon_key_cb_options()
54                 Result = boolean()
55
56              Checks if the user key is authorized.
57
58
59
60Ericsson AB                         ssh 4.9              ssh_server_key_api(3)
Impressum