Sshd.ShellHandler behaviour (esshd v0.3.0) View Source

As incoming SSH connections are accepted, authorized, and request remote shell services; they are passed to the Sshd.ShellHandler.on_shell/4 callback.

Link to this section Summary

Types

ip_address()

method()

peer_address()

port_number()

ssh_publickey()

username()

Callbacks

on_connect( username, ip_address, port_number, method )

User function callback to perform any tasks prior to launching a shell session.

on_disconnect( username, ip_address, port_number )

User function callback to perform any tasks after a shell session. Will always be called, regardless of disconnect reason.

on_shell( username, ssh_publickey, ip_address, port_number )

User function callback to handle incoming shell requests.

Link to this section Types

ip_address()

Specs

ip_address() :: :inet.ip_address()

method()

Specs

method() :: String.t()

peer_address()

Specs

peer_address() :: {ip_address(), port_number()}

port_number()

Specs

port_number() :: :inet.port_number()

ssh_publickey()

Specs

ssh_publickey() :: binary()

username()

Specs

username() :: String.t()

Link to this section Callbacks

on_connect( username, ip_address, port_number, method )

Specs

on_connect(
  username(),
  ip_address(),
  port_number(),
  method()
) :: :ok | {:error, any()}

User function callback to perform any tasks prior to launching a shell session.

on_disconnect( username, ip_address, port_number )

Specs

on_disconnect(
  username(),
  ip_address(),
  port_number()
) :: :ok | {:error, any()}

User function callback to perform any tasks after a shell session. Will always be called, regardless of disconnect reason.

on_shell( username, ssh_publickey, ip_address, port_number )

Specs

on_shell(
  username(),
  ssh_publickey(),
  ip_address(),
  port_number()
) :: :ok | {:error, any()}

User function callback to handle incoming shell requests.