Erlang -- ssh_server_key_api

User's Guide
Reference Manual
Release Notes
PDF
Top

SSH
Reference Manual
Version 4.3.2

Expand All
Contract All

Table of Contents

- SSH (App)
- ssh
  - Top of manual page
  - close/1
  - connect/3
  - connect/4
  - connect/2
  - connect/3
  - connection_info/2
  - daemon/3
  - daemon/1
  - daemon/2
  - daemon/1
  - daemon/2
  - daemon_info/1
  - default_algorithms/0
  - shell/1
  - shell/2
  - shell/3
  - shell/1
  - start/0
  - start/1
  - stop/0
  - stop_daemon/2
  - stop_daemon/1
  - stop_listener/2
  - stop_listener/1
- ssh_channel
  - Top of manual page
  - call/2
  - call/3
  - cast/2
  - enter_loop/1
  - init/1
  - reply/2
  - start/4
  - start_link/4
  - Module:code_change/3
  - Module:handle_call/3
  - Module:handle_cast/2
  - Module:handle_msg/2
  - Module:handle_ssh_msg/2
  - Module:init/1
  - Module:terminate/2
- ssh_connection
  - Top of manual page
  - adjust_window/3
  - close/2
  - exec/4
  - exit_status/3
  - ptty_alloc/3
  - ptty_alloc/4
  - reply_request/4
  - send/3
  - send/4
  - send/4
  - send/5
  - send_eof/2
  - session_channel/4
  - session_channel/2
  - setenv/5
  - shell/2
  - subsystem/4
- ssh_client_key_api
  - Top of manual page
  - Module:add_host_key/3
  - Module:is_host_key/4
  - Module:user_key/2
- ssh_server_key_api
  - Top of manual page
  - Module:host_key/2
  - Module:is_auth_key/3
- ssh_sftp
  - Top of manual page
  - apread/4
  - apwrite/4
  - aread/3
  - awrite/3
  - close/2
  - close/3
  - del_dir/2
  - del_dir/3
  - delete/2
  - delete/3
  - list_dir/2
  - list_dir/3
  - make_dir/2
  - make_dir/3
  - make_symlink/3
  - make_symlink/4
  - open/3
  - open/4
  - open_tar/3
  - open_tar/4
  - opendir/2
  - opendir/3
  - position/3
  - position/4
  - pread/4
  - pread/5
  - pwrite/4
  - pwrite/5
  - read/3
  - read/4
  - read_file/2
  - read_file/3
  - read_file_info/2
  - read_file_info/3
  - read_link/2
  - read_link/3
  - read_link_info/2
  - read_link_info/3
  - rename/3
  - rename/4
  - start_channel/1
  - start_channel/2
  - start_channel/2
  - start_channel/3
  - start_channel/1
  - start_channel/2
  - stop_channel/1
  - write/3
  - write/4
  - write_file/3
  - write_file/4
  - write_file_info/3
  - write_file_info/4
- ssh_sftpd
  - Top of manual page
  - subsystem_spec/1

# ssh_server_key_api

### MODULE

ssh_server_key_api

### MODULE SUMMARY

-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(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()

### 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.