NAME

       ssh_server_key_api -
           -behaviour(ssh_server_key_api).

DESCRIPTION

       Behaviour describing the API for public key handling of an SSH server. By implementing the
       callbacks defined in this behavior, the public key  handling  of  an  SSH  server  can  be
       customized.  By  default  the  SSH  application  implements this behavior with help of the
       standard OpenSSH files, see the  ssh(7) 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()

EXPORTS

       Module:host_key(Algorithm, DaemonOptions) -> {ok, Key} | {error, Reason}

              Types:

                 Algorithm = public_key_algorithm()
                   Host key algorithm. Is to support 'ssh-rsa' | 'ssh-dss', but  more  algorithms
                   can be handled.
                 DaemonOptions = proplists:proplist()
                   Options provided to ssh:daemon/[2,3].
                 Key = private_key()
                   Private key of the host matching the Algorithm.
                 Reason = term()

              Fetches the private key of the host.

       Module:is_auth_key(Key, User, DaemonOptions) -> Result

              Types:

                 Key = public_key()
                   Normally  an  RSA  or DSA public key, but handling of other public keys can be
                   added
                 User = string()
                   User owning the public key.
                 DaemonOptions = proplists:proplist()
                   Options provided to ssh:daemon/[2,3].
                 Result = boolean()

              Checks if the user key is authorized.