Erlang -- ssh_client_key_api

SSH

Reference Manual

Version 4.7.1

- User's Guide
- Reference Manual
- Release Notes
- PDF
- Top

- 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/1
  - daemon/2
  - daemon/3
  - daemon_info/1
  - default_algorithms/0
  - shell/1
  - shell/2
  - shell/3
  - start/0
  - start/1
  - stop/0
  - stop_daemon/1
  - stop_daemon/2
  - stop_daemon/3
  - stop_listener/1
  - stop_listener/2
  - stop_listener/3
- ssh_client_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_server_channel
  - Top of manual page
  - 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/2
  - session_channel/4
  - 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_client_key_api

### Module

ssh_client_key_api

### Module Summary

-behaviour(ssh_client_key_api).

### Description

Behavior describing the API for public key handling of an SSH client. By implementing the callbacks defined in this behavior, the public key handling of an SSH client 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

client_key_cb_options() =
[{key_cb_private, term()} | ssh:client_option()]

Options provided to ssh:connect/[3,4].

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

### Exports

Module:add_host_key(HostNames, PublicHostKey, ConnectOptions) -> ok | {error, Reason}

### Types

HostNames = string()
Description of the host that owns the PublicHostKey.
PublicHostKey = public_key:public_key()
Of ECDSA keys, only the Normally an RSA, DSA or ECDSA public key, but handling of other public keys can be added.
ConnectOptions = client_key_cb_options()

Adds a host key to the set of trusted host keys.

Module:is_host_key(Key, Host, Algorithm, ConnectOptions) -> Result

### Types

Key = public_key:public_key()
Normally an RSA, DSA or ECDSA public key, but handling of other public keys can be added.
Host = string()
Description of the host.
Algorithm = ssh:pubkey_alg()
Host key algorithm.
ConnectOptions = client_key_cb_options()
Result = boolean()

Checks if a host key is trusted.

Module:user_key(Algorithm, ConnectOptions) -> {ok, PrivateKey} | {error, Reason}

### Types

Algorithm = ssh:pubkey_alg()
Host key algorithm.
ConnectOptions = client_key_cb_options()
PrivateKey = public_key:private_key()
Private key of the user matching the Algorithm.
Reason = term()

Fetches the users public key matching the Algorithm.

Note

The private key contains the public key.