on_ssl_client_authentication Event

Fired when the client presents its credentials to the server.

Syntax

class SNMPTCPMgrSSLClientAuthenticationEventParams(object):
  @property
  def remote_address() -> str: ...
  @property
  def remote_port() -> int: ...
  @property
  def cert_encoded() -> bytes: ...
  @property
  def cert_subject() -> str: ...
  @property
  def cert_issuer() -> str: ...
  @property
  def status() -> str: ...
  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class SNMPTCPMgr:
@property
def on_ssl_client_authentication() -> Callable[[SNMPTCPMgrSSLClientAuthenticationEventParams], None]: ...
@on_ssl_client_authentication.setter
def on_ssl_client_authentication(event_hook: Callable[[SNMPTCPMgrSSLClientAuthenticationEventParams], None]) -> None: ...

Remarks

This event fires when a client connects to the class and presents a certificate for authentication. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK").

RemoteAddress is the IP address of the connecting client.

RemotePort is the source port of the connecting client.

CertEncoded is the base64 encoded certificate presented by the client.

CertSubject is the subject of the certificate presented by the client.

CertIssuer is the subject of the issuer of the certificate presented by the client.

Status is the stauts of the certificate.

Accept defines whether the certificate is accepted.