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       Type  definitions  that  are  used  more  than  once in this module, or
19       abstractions to indicate the intended use of the data  type,  or  both.
20       For  more  details  on public key data types, refer to Section 2 Public
21       Key Records in the  public_key user's guide.
22
23         boolean() =:
24           true | false
25
26         string() =:
27           [byte()]
28
29         public_key() =:
30           #'RSAPublicKey'{}       |       {integer(),#'Dss-Parms'{}}        |
31           {#'ECPoint'{},{namedCurve,Curve::string()}}
32
33         private_key() =:
34           #'RSAPrivateKey'{} | #'DSAPrivateKey'{} | #'ECPrivateKey'{}
35
36         public_key_algorithm() =:
37           'ssh-rsa'  |  'ssh-dss'  |  'rsa-sha2-256' | 'rsa-sha2-384' | 'rsa-
38           sha2-512' | 'ecdsa-sha2-nistp256' | 'ecdsa-sha2-nistp384' | 'ecdsa-
39           sha2-nistp521'
40

EXPORTS

42       Module:host_key(Algorithm,  DaemonOptions)  -> {ok, Key} | {error, Rea‐
43       son}
44
45              Types:
46
47                 Algorithm = public_key_algorithm()
48                   Host key algorithm.
49                 DaemonOptions = proplists:proplist()
50                   Options provided to ssh:daemon/[2,3]. The option list given
51                   in  the key_cb option is available with the key key_cb_pri‐
52                   vate.
53                 Key = private_key() | crypto:engine_key_ref()
54                   Private key of the host matching the Algorithm. It may be a
55                   reference  to  a  'ssh-rsa',  rsa-sha2-*  or 'ssh-dss' (NOT
56                   ecdsa) key stored in a loaded Engine.
57                 Reason = term()
58
59              Fetches the private key of the host.
60
61       Module:is_auth_key(Key, User, DaemonOptions) -> Result
62
63              Types:
64
65                 Key = public_key()
66                   Normally an RSA, DSA or ECDSA public key, but  handling  of
67                   other public keys can be added
68                 User = string()
69                   User owning the public key.
70                 DaemonOptions = proplists:proplist()
71                   Options provided to ssh:daemon/[2,3]. The option list given
72                   in the key_cb option is available with the key  key_cb_pri‐
73                   vate.
74                 Result = boolean()
75
76              Checks if the user key is authorized.
77
78
79
80Ericsson AB                       ssh 4.6.9.4            ssh_server_key_api(3)
Impressum