socket_path_option() = {socket_path, string()}
socket_path_option() = {socket_path, string()}
Sets the socket path
for the communication with the agent.
ssh_agent
Callback module for using an SSH agent instead of the default ssh_file callback.
Module ssh_agent was introduced in OTP 23.0.
This module defines a callback handler for the communication with an SSH Agent
and can be used to replace the default callback
. This allows to issue signing requests to an agent that stores SSH private keys to perform authentication.
Ssh_agent implements the ssh_client_key_api
, to allow it to be used by setting the option key_cb
when starting a client (with for example ssh:connect
, ssh:shell
).
{key_cb, {ssh_agent, []}}
The agent communication is established through a UNIX domain socket. By default, the socket path will be fetched from the SSH_AUTH_SOCK
environment variable, which is the default socket path in the agent implementation of OpenSSH
.
In order to set a different socket path the socket_path
option can be set.
{key_cb, {ssh_agent, [{socket_path, SocketPath}]}}
The functions are Callbacks for the SSH app. They are not intended to be called from the user's code!
socket_path_option() = {socket_path, string()}
Sets the socket path
for the communication with the agent.
timeout_option() = {timeout, integer()}
Sets the time-out in milliseconds when communicating with the agent via the socket. The default value is 1000
.
call_ssh_file_option() = {call_ssh_file, atom()}
The module which the add_host_key
and is_host_key
callbacks are delegated to. Defaults to the ssh_file
module.
string()
,public_key:public_key()
,term()
}
inet:port_number()
,public_key:public_key()
, This callback is delegated to the ssh_file
module.
public_key:public_key()
,string()
,ssh:pubkey_alg()
,boolean()
public_key:public_key()
,inet:port_number()
,ssh:pubkey_alg()
,boolean()
This callback is delegated to the ssh_file
module.
ssh:pubkey_alg()
, Options) -> Result
Types and description
See the api description in ssh_client_key_api, Module:user_key/2
.
© 2010–2022 Ericsson AB
Licensed under the Apache License, Version 2.0.