on_ssh_service_request Event

Fired when a client requests a service to be started.

Syntax

class SSHDaemonSSHServiceRequestEventParams(object):
  @property
  def connection_id() -> int: ...
  @property
  def service() -> str: ...
  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class SSHDaemon:
@property
def on_ssh_service_request() -> Callable[[SSHDaemonSSHServiceRequestEventParams], None]: ...
@on_ssh_service_request.setter
def on_ssh_service_request(event_hook: Callable[[SSHDaemonSSHServiceRequestEventParams], None]) -> None: ...

Remarks

The on_ssh_service_request event is fired when a client requests that a service be started for a particular connection, identified by ConnectionId. Service will be the name of the service the client wishes to start. If the connection is authenticated and the user has access to the service, set Accept to true to allow the SSHDaemon to accept the request.

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing SSH data until the event returns. In order to prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.