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

       daemon_key_cb_options(T) =
           [{key_cb_private, [T]} | ssh:daemon_option()]

              Options provided to ssh:daemon/2,3.

              The option list given in the key_cb option is available with the key key_cb_private.

EXPORTS

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

              Types:

                 Algorithm = ssh:pubkey_alg()
                   Host key algorithm.
                 DaemonOptions = daemon_key_cb_options()
                 PrivateKey = public_key:private_key() | crypto:engine_key_ref()
                   Private key of the host matching the Algorithm. It may be a reference to  a  'ssh-rsa',  rsa-
                   sha2-* or 'ssh-dss' (NOT ecdsa) key stored in a loaded Engine.
                 Reason = term()

              Fetches the private key of the host.

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

              Types:

                 PublicUserKey = public_key:public_key()
                   Normally an RSA, DSA or ECDSA public key, but handling of other public keys can be added
                 User = string()
                   User owning the public key.
                 DaemonOptions = daemon_key_cb_options()
                 Result = boolean()

              Checks if the user key is authorized.