Struct ipworkssnmp::SNMPTCPTrapMgr

Properties Methods Events Config Settings Errors

The SNMPTCPTrapMgr struct provides a TCP-based listening point for SNMP traps.

Syntax

ipworkssnmp::SNMPTCPTrapMgr

Remarks

The SNMPTCPTrapMgr struct provides a TCP-based listening point for SNMP traps and informs as specified by the SNMP RFCs. The struct supports v1, v2c, and v3 traps.

The struct provides both encoding/decoding and transport capabilities, making the task of developing a custom SNMP Trap manager as simple as setting a few key properties and handling a few events. SNMP data, such as for instance SNMP object id-s (OID-s) are exchanged as text strings, thus further simplifying the task of handling them.

The struct is activated/deactivated by calling the activate or deactivate method. These methods enable or disable sending and receiving. The activation status can be found in the active property.

Messages are received through events such as on_trap, on_inform_request, or on_discovery_request.

SNMP OIDs, types, and values are provided in the objects collection of SNMP objects for both sent and received packets.

SNMPv3 USM security passwords are requested through the on_get_user_password event, and event parameters such as User and SecurityLevel provide information about the security attributes of received requests, and enable granular decision capability about what to provide and what not to provide.

The add_user, remove_user, show_cache, clear_cache, add_engine, and remove_engine methods are used to manage an internal authentication cache. This internal cache can be used as an alternative to the on_get_user_password event, automatically checking the cache against the security parameters provided in the request signature.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksSNMP. Due to this, the SNMPTCPTrapMgr struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of SNMPTCPTrapMgr when you have finished using the instance.

Property List

The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.


accept_data	Enables or disables data reception.
active	Indicates whether the struct is active.
local_engine_id	The Engine Id (for SNMPv3).
local_host	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
local_port	The port in the local host where the struct is bound to.
obj_count	The number of records in the Obj arrays.
obj_type	The current object's type.
obj_id	The current object's id which is encoded as a string of numbers separated by periods.
obj_type_string	A string representation of the current object's ObjectType .
obj_value	The current object's value.
request_id	The request-id to mark outgoing packets with.
ssl_authenticate_clients	If set to True, the server asks the client(s) for a certificate.
ssl_cert_effective_date	The date on which this certificate becomes valid.
ssl_cert_expiration_date	The date on which the certificate expires.
ssl_cert_extended_key_usage	A comma-delimited list of extended key usage identifiers.
ssl_cert_fingerprint	The hex-encoded, 16-byte MD5 fingerprint of the certificate.
ssl_cert_fingerprint_sha1	The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
ssl_cert_fingerprint_sha256	The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
ssl_cert_issuer	The issuer of the certificate.
ssl_cert_private_key	The private key of the certificate (if available).
ssl_cert_private_key_available	Whether a PrivateKey is available for the selected certificate.
ssl_cert_private_key_container	The name of the PrivateKey container for the certificate (if available).
ssl_cert_public_key	The public key of the certificate.
ssl_cert_public_key_algorithm	The textual description of the certificate's public key algorithm.
ssl_cert_public_key_length	The length of the certificate's public key (in bits).
ssl_cert_serial_number	The serial number of the certificate encoded as a string.
ssl_cert_signature_algorithm	The text description of the certificate's signature algorithm.
ssl_cert_store	The name of the certificate store for the client certificate.
ssl_cert_store_password	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
ssl_cert_store_type	The type of certificate store for this certificate.
ssl_cert_subject_alt_names	Comma-separated lists of alternative subject names for the certificate.
ssl_cert_thumbprint_md5	The MD5 hash of the certificate.
ssl_cert_thumbprint_sha1	The SHA-1 hash of the certificate.
ssl_cert_thumbprint_sha256	The SHA-256 hash of the certificate.
ssl_cert_usage	The text description of UsageFlags .
ssl_cert_usage_flags	The flags that show intended use for the certificate.
ssl_cert_version	The certificate's version number.
ssl_cert_subject	The subject of the certificate used for client authentication.
ssl_cert_encoded	The certificate (PEM/Base64 encoded).
ssl_enabled	Whether TLS/SSL is enabled.

Method List

The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.


activate	Activates the struct.
add_engine	Adds the engine specified by EngineId to the internal authentication cache.
add_user	Adds a user for the engine specified by EngineId to the internal authentication cache.
clear_cache	Clears the internal authentication database.
config	Sets or retrieves a configuration setting.
deactivate	Deactivates the struct.
do_events	This method processes events from the internal message queue.
hash_passwords	Hashes all passwords in the cache.
remove_engine	Removes the engine specified by EngineId from the internal authentication cache.
remove_user	Removes the user specified by User of the engine specified by EngineId from the internal authentication cache.
reset	Clears the object arrays.
show_cache	Lists all entries in the internal user and engine database.
value	Returns the value corresponding to an OID.

Event List

The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.


on_bad_packet	Fired for erroneous and/or malformed messages.
on_cache_entry	Shows engines and users in the internal cache.
on_check_engine	Fired to check engine parameters (timeliness, etc.).
on_connected	Fired immediately after a connection completes (or fails).
on_connection_status	This event is fired to indicate changes in the connection state.
on_disconnected	Fired when a connection is closed.
on_discovery_request	Fired when an SNMPv3 discovery packet is received.
on_error	Fired when information is available about errors during data delivery.
on_get_user_password	Retrieves a password associated with a user.
on_get_user_security_level	Sets the security level for an incoming packet.
on_hash_password	Fired before and after a password is hashed.
on_inform_request	Fired when an InformRequest packet is received.
on_packet_trace	Fired for every packet sent or received.
on_ssl_client_authentication	Fired when the client presents its credentials to the server.
on_ssl_status	Shows the progress of the secure connection.
on_trap	Fired when a SNMP trap packet is received.

Config Settings

The following is a list of config settings for the struct with short descriptions. Click on the links for further details.


AuthenticationKey	The key to use for authentication.
CompatibilityMode	Whether to operate the struct in a specific compatibility mode.
ContextEngineId	Sets the context engine id of the SNMP entity.
ContextName	Sets the context name of the SNMP entity.
DecryptLogPackets	Whether to decrypt logged packets.
EncryptionKey	The key to use for encryption.
ForceLocalPort	Forces the struct to bind to a specific port.
IncomingContextEngineId	The engine Id of the received packet.
IncomingContextName	The context name of the received packet.
ShowCacheForUser	Shows the cache entry for a single user.
SourceAddress	The source address of the received packet.
SourcePort	The source port of the received packet.
TimeWindow	The time window used for SNMPv3 timeliness checking (authentication).
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
EnableFallback	Whether to try the other addresses the remote host resolves to when a connection attempt fails.
FallbackTimeout	The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled.
FirewallAutoDetect	Tells the struct whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallHTTPVersion	The HTTP version to be used when connecting through a tunneling proxy.
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the struct binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
UseNTLMv2	Whether to use NTLM V2.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACerts	A newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSP	Whether to use OCSP to check the status of the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLClientCACerts	A newline separated list of CA certificates to use during SSL client certificate validation.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated cipher suite.
SSLNegotiatedCipherStrength	Returns the negotiated cipher suite strength.
SSLNegotiatedCipherSuite	Returns the negotiated cipher suite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificates to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitiveData	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

accept_data property (SNMPTCPTrapMgr Struct)

Enables or disables data reception.

Syntax

fn accept_data(&self ) -> Result<bool, IPWorksSNMPError>

Default Value

true

Remarks

Setting the property to False temporarily disables data reception. Setting the property to True re-enables data reception.

This property is read-only.

Data Type

bool

active property (SNMPTCPTrapMgr Struct)

Indicates whether the struct is active.

Syntax

fn active(&self ) -> Result<bool, IPWorksSNMPError>

Default Value

false

Remarks

This property indicates whether the struct is currently active and can send or receive data.

The struct will be automatically activated if it is not already and you attempt to perform an operation which requires the struct to be active.

Use the activate and deactivate methods to control whether the struct is active.

This property is read-only.

Data Type

bool

local_engine_id property (SNMPTCPTrapMgr Struct)

The Engine Id (for SNMPv3).

Syntax

fn local_engine_id(&self ) -> Result<Vec<u8>, IPWorksSNMPError> 
fn set_local_engine_id(&self, value : Vec<u8>) ->  Option<IPWorksSNMPError> 
fn set_local_engine_id_ref(&self, value : &[u8]) ->  Option<IPWorksSNMPError>

Default Value

Remarks

This property is necessary for properly handling on_inform_request packets.

Data Type

Vec

local_host property (SNMPTCPTrapMgr Struct)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

fn local_host(&self ) -> Result<String, IPWorksSNMPError> 
fn set_local_host(&self, value : &str) ->  Option<IPWorksSNMPError> 
fn set_local_host_ref(&self, value : &String) ->  Option<IPWorksSNMPError>

Default Value

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the struct is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

NOTE: local_host is not persistent. You must always set it in code, and never in the property window.

Data Type

String

local_port property (SNMPTCPTrapMgr Struct)

The port in the local host where the struct is bound to.

Syntax

fn local_port(&self ) -> Result<i32, IPWorksSNMPError> 
fn set_local_port(&self, value : i32) ->  Option<IPWorksSNMPError>

Default Value

162

Remarks

The local_port property must be set before the struct is activated (active is set to True). It instructs the struct to bind to a specific port (or communication endpoint) in the local machine.

The default port is 162 (standard trap port). If that port is busy, an error will be returned, unless the ForceLocalPort configuration setting is set to False, in which case a random port will be chosen.

local_port cannot be changed once the struct is active. Any attempt to set the local_port property when the struct is active will generate an error.

NOTE: on macOS and iOS, root permissions are required to set local_port to any value below 1024.

Data Type

i32

obj_count property (SNMPTCPTrapMgr Struct)

The number of records in the Obj arrays.

Syntax

fn obj_count(&self ) -> Result<i32, IPWorksSNMPError> 
fn set_obj_count(&self, value : i32) ->  Option<IPWorksSNMPError>

Default Value

Remarks

This property controls the size of the following arrays:

obj_id
obj_type
obj_type_string
obj_value

The array indices start at 0 and end at obj_count - 1.

Data Type

i32

obj_type property (SNMPTCPTrapMgr Struct)

The current object's type.

Syntax

fn obj_type(&self , ObjIndex : i32) -> Result<i32, IPWorksSNMPError> 
fn set_obj_type(&self, ObjIndex : i32, value : i32) ->  Option<IPWorksSNMPError>

Possible Values

2   // Integer
4   // OctetString
5   // Null
6   // ObjectId
64   // IPAddress
65   // Counter32
66   // Gauge32
67   // TimeTicks
68   // Opaque
69   // NSAP
70   // Counter64
71   // UnsignedInteger32
128   // NoSuchObject
129   // NoSuchInstance
130   // EndOfMibView

Default Value

Remarks

The current object's type. The default type is NULL (5).

The corresponding object id and value are specified by the obj_oid and obj_value properties.

Possible object type values include:


otInteger (2)	2
otOctetString (4)	4
otNull (5)	5
otObjectID (6)	6
otIPAddress (64)	64
otCounter32 (65)	65
otGauge32 (66)	66
otTimeTicks (67)	67
otOpaque (68)	68
otNSAP (69)	69
otCounter64 (70)	70
otUnsignedInteger32 (71)	71

The struct also supports the following artificial object values used to designate error conditions:


otNoSuchObject (128)	No such object error.
otNoSuchInstance (129)	No such instance error.
otEndOfMibView (130)	End of MIB View error.

The ObjIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjCount property.

Data Type

i32

obj_id property (SNMPTCPTrapMgr Struct)

The current object's id which is encoded as a string of numbers separated by periods.

Syntax

fn obj_id(&self , ObjIndex : i32) -> Result<String, IPWorksSNMPError> 
fn set_obj_id(&self, ObjIndex : i32, value : &str) ->  Option<IPWorksSNMPError> 
fn set_obj_id_ref(&self, ObjIndex : i32, value : &String) ->  Option<IPWorksSNMPError>

Default Value

Remarks

The current object's id which is encoded as a string of numbers separated by periods. For instance: "1.3.6.1.2.1.1.1.0" (OID for "system description").

The corresponding object type and value (if any) are specified by the obj_object_type and obj_value properties.

Example

SNMPControl.ObjCount = 1 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0"

The ObjIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjCount property.

Data Type

String

obj_type_string property (SNMPTCPTrapMgr Struct)

A string representation of the current object's ObjectType .

Syntax

fn obj_type_string(&self , ObjIndex : i32) -> Result<String, IPWorksSNMPError>

Default Value

Remarks

A string representation of the current object's obj_object_type.

The corresponding object id and value are specified by the obj_oid and obj_value properties.

The ObjIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjCount property.

This property is read-only.

Data Type

String

obj_value property (SNMPTCPTrapMgr Struct)

The current object's value.

Syntax

fn obj_value(&self , ObjIndex : i32) -> Result<Vec<u8>, IPWorksSNMPError> 
fn set_obj_value(&self, ObjIndex : i32, value : Vec<u8>) ->  Option<IPWorksSNMPError> 
fn set_obj_value_ref(&self, ObjIndex : i32, value : &[u8]) ->  Option<IPWorksSNMPError>

Default Value

Remarks

The current object's value. The corresponding object id and type are specified by the obj_oid and obj_object_type properties.

Example

SNMPControl.ObjCount = 1 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0" SNMPControl.ObjValue(0) = "New Value"

The ObjIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjCount property.

Data Type

Vec

request_id property (SNMPTCPTrapMgr Struct)

The request-id to mark outgoing packets with.

Syntax

fn request_id(&self ) -> Result<i32, IPWorksSNMPError> 
fn set_request_id(&self, value : i32) ->  Option<IPWorksSNMPError>

Default Value

Remarks

If a custom value is needed for request_id, the property must be set before sending the request. The struct increments request_id automatically after sending each packet.

Data Type

i32

ssl_authenticate_clients property (SNMPTCPTrapMgr Struct)

If set to True, the server asks the client(s) for a certificate.

Syntax

fn ssl_authenticate_clients(&self ) -> Result<bool, IPWorksSNMPError> 
fn set_ssl_authenticate_clients(&self, value : bool) ->  Option<IPWorksSNMPError>

Default Value

false

Remarks

This property is used in conjunction with the on_ssl_client_authentication event. Please refer to the documentation of the on_ssl_client_authentication event for details.

Data Type

bool

ssl_cert_effective_date property (SNMPTCPTrapMgr Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_cert_effective_date(&self ) -> Result<String, IPWorksSNMPError>

Default Value

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_expiration_date property (SNMPTCPTrapMgr Struct)

The date on which the certificate expires.

Syntax

fn ssl_cert_expiration_date(&self ) -> Result<String, IPWorksSNMPError>

Default Value

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_extended_key_usage property (SNMPTCPTrapMgr Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_cert_extended_key_usage(&self ) -> Result<String, IPWorksSNMPError>

Default Value

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_cert_fingerprint property (SNMPTCPTrapMgr Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint(&self ) -> Result<String, IPWorksSNMPError>

Default Value

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha1 property (SNMPTCPTrapMgr Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksSNMPError>

Default Value

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha256 property (SNMPTCPTrapMgr Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksSNMPError>

Default Value

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_cert_issuer property (SNMPTCPTrapMgr Struct)

The issuer of the certificate.

Syntax

fn ssl_cert_issuer(&self ) -> Result<String, IPWorksSNMPError>

Default Value

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_cert_private_key property (SNMPTCPTrapMgr Struct)

The private key of the certificate (if available).

Syntax

fn ssl_cert_private_key(&self ) -> Result<String, IPWorksSNMPError>

Default Value

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_cert_private_key_available property (SNMPTCPTrapMgr Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_cert_private_key_available(&self ) -> Result<bool, IPWorksSNMPError>

Default Value

false

Remarks

Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_cert_private_key_container property (SNMPTCPTrapMgr Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_cert_private_key_container(&self ) -> Result<String, IPWorksSNMPError>

Default Value

Remarks

The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_cert_public_key property (SNMPTCPTrapMgr Struct)

The public key of the certificate.

Syntax

fn ssl_cert_public_key(&self ) -> Result<String, IPWorksSNMPError>

Default Value

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_cert_public_key_algorithm property (SNMPTCPTrapMgr Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_cert_public_key_algorithm(&self ) -> Result<String, IPWorksSNMPError>

Default Value

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_public_key_length property (SNMPTCPTrapMgr Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_cert_public_key_length(&self ) -> Result<i32, IPWorksSNMPError>

Default Value

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_cert_serial_number property (SNMPTCPTrapMgr Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_cert_serial_number(&self ) -> Result<String, IPWorksSNMPError>

Default Value

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_cert_signature_algorithm property (SNMPTCPTrapMgr Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_cert_signature_algorithm(&self ) -> Result<String, IPWorksSNMPError>

Default Value

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_store property (SNMPTCPTrapMgr Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_cert_store(&self ) -> Result<Vec<u8>, IPWorksSNMPError> 
fn set_ssl_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksSNMPError> 
fn set_ssl_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksSNMPError>

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

ssl_cert_store_password property (SNMPTCPTrapMgr Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_cert_store_password(&self ) -> Result<String, IPWorksSNMPError> 
fn set_ssl_cert_store_password(&self, value : &str) ->  Option<IPWorksSNMPError> 
fn set_ssl_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksSNMPError>

Default Value

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

ssl_cert_store_type property (SNMPTCPTrapMgr Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_cert_store_type(&self ) -> Result<i32, IPWorksSNMPError> 
fn set_ssl_cert_store_type(&self, value : i32) ->  Option<IPWorksSNMPError>

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new Certificate object and pass `cstPKCS11` as the ssl_cert_store_type, the full path of the PKCS#11 DLL as the ssl_cert_store, and the PIN as the ssl_cert_store_password. Code Example. SSH Authentication with Security Key (without CertMgr): `sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);` Alternatively, collect the necessary data using the CertMgr struct by calling the list_store_certificates method after setting the corresponding properties accordingly. The certificate information returned in the on_cert_list event's `CertEncoded` parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

i32

ssl_cert_subject_alt_names property (SNMPTCPTrapMgr Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_cert_subject_alt_names(&self ) -> Result<String, IPWorksSNMPError>

Default Value

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_md5 property (SNMPTCPTrapMgr Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_md5(&self ) -> Result<String, IPWorksSNMPError>

Default Value

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha1 property (SNMPTCPTrapMgr Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksSNMPError>

Default Value

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha256 property (SNMPTCPTrapMgr Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksSNMPError>

Default Value

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_usage property (SNMPTCPTrapMgr Struct)

The text description of UsageFlags .

Syntax

fn ssl_cert_usage(&self ) -> Result<String, IPWorksSNMPError>

Default Value

Remarks

The text description of ssl_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

Digital Signature
Non-Repudiation
Key Encipherment
Data Encipherment
Key Agreement
Certificate Signing
CRL Signing
Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_cert_usage_flags property (SNMPTCPTrapMgr Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_cert_usage_flags(&self ) -> Result<i32, IPWorksSNMPError>

Default Value

Remarks

The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:


0x80	Digital Signature
0x40	Non-Repudiation
0x20	Key Encipherment
0x10	Data Encipherment
0x08	Key Agreement
0x04	Certificate Signing
0x02	CRL Signing
0x01	Encipher Only

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_cert_version property (SNMPTCPTrapMgr Struct)

The certificate's version number.

Syntax

fn ssl_cert_version(&self ) -> Result<String, IPWorksSNMPError>

Default Value

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_cert_subject property (SNMPTCPTrapMgr Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_cert_subject(&self ) -> Result<String, IPWorksSNMPError> 
fn set_ssl_cert_subject(&self, value : &str) ->  Option<IPWorksSNMPError> 
fn set_ssl_cert_subject_ref(&self, value : &String) ->  Option<IPWorksSNMPError>

Default Value

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:


Field	Meaning
CN	Common Name. This is commonly a hostname like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma, it must be quoted.

Data Type

String

ssl_cert_encoded property (SNMPTCPTrapMgr Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksSNMPError> 
fn set_ssl_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksSNMPError> 
fn set_ssl_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksSNMPError>

Default Value

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

Data Type

Vec

ssl_enabled property (SNMPTCPTrapMgr Struct)

Whether TLS/SSL is enabled.

Syntax

fn ssl_enabled(&self ) -> Result<bool, IPWorksSNMPError> 
fn set_ssl_enabled(&self, value : bool) ->  Option<IPWorksSNMPError>

Default Value

false

Remarks

This setting specifies whether TLS/SSL is enabled in the struct. When False (default) the struct operates in plaintext mode. When True TLS/SSL is enabled.

Data Type

bool

activate method (SNMPTCPTrapMgr Struct)

Activates the struct.

Syntax

fn activate(&self) -> Result<(), IPWorksSNMPError>

Remarks

This method activates the component and will allow it to send or receive data.

The struct will be automatically activated if it is not already and you attempt to perform an operation which requires the struct to be active.

NOTE: Use the active property to check whether the component is active.

add_engine method (SNMPTCPTrapMgr Struct)

Adds the engine specified by EngineId to the internal authentication cache.

Syntax

fn add_engine(&self, engine_id : &[u8], engine_boots : i32, engine_time : i32) -> Result<(), IPWorksSNMPError>

Remarks

The internal authentication cache can be used as an alternative to the on_get_user_password event, automatically checking the cache against the security parameters provided in the request signature.

The show_cache method is used to show the contents of the internal authentication cache.

The clear_cache method can be used to completely clear the cache.

If the engine parameters are unknown, the SNMPMgr struct's Discover method can be used to perform a discovery with the agent. The RemoteEngineId, RemoteEngineTime, and RemoteEngineBoots properties will hold the values that can then be passed to this method.

add_user method (SNMPTCPTrapMgr Struct)

Adds a user for the engine specified by EngineId to the internal authentication cache.

Syntax

fn add_user(&self, user : &str, engine_id : &[u8], authentication_protocol : i32, authentication_password : &str, encryption_algorithm : i32, encryption_password : &str) -> Result<(), IPWorksSNMPError>

Remarks

The internal authentication cache can be used as an alternative to the on_get_user_password event, automatically checking the cache against the security parameters provided in the request signature.

The show_cache method is used to show the contents of the internal authentication cache.

The clear_cache method can be used to completely clear the cache.

Valid Authentication Protocols are:


HMAC-MD5-96 (1)	Message-Digest algorithm 5.
HMAC-SHA-96 (2)	Secure Hash Algorithm.
HMAC-192-SHA-256 (3)	Secure Hash Algorithm.
HMAC-384-SHA-512 (4)	Secure Hash Algorithm.
HMAC-128-SHA-224 (5)	Secure Hash Algorithm.
HMAC-256-SHA-384 (6)	Secure Hash Algorithm.

Valid Encryption Algorithms are:


DES (1)	Data Encryption Standard.
AES (2)	Advanced Encryption Standard with key length of 128.
3DES (3)	Triple Data Encryption Standard.
AES192 (4)	Advanced Encryption Standard with key length of 192.
AES256 (5)	Advanced Encryption Standard with key length of 256.

clear_cache method (SNMPTCPTrapMgr Struct)

Clears the internal authentication database.

Syntax

fn clear_cache(&self) -> Result<(), IPWorksSNMPError>

Remarks

All user and engine records are removed from the internal authentication cache as a result of this call.

config method (SNMPTCPTrapMgr Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, IPWorksSNMPError>

Remarks

config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

deactivate method (SNMPTCPTrapMgr Struct)

Deactivates the struct.

Syntax

fn deactivate(&self) -> Result<(), IPWorksSNMPError>

Remarks

This method deactivates the component and will prohibit it from sending and receiving data.

NOTE: Use the active property to check whether the component is active.

do_events method (SNMPTCPTrapMgr Struct)

This method processes events from the internal message queue.

Syntax

fn do_events(&self) -> Result<(), IPWorksSNMPError>

Remarks

When do_events is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns.

hash_passwords method (SNMPTCPTrapMgr Struct)

Hashes all passwords in the cache.

Syntax

fn hash_passwords(&self) -> Result<(), IPWorksSNMPError>

Remarks

Forces computation of all passwords hashes in the cache. Used together with the on_hash_password event to enable implementations of external password hash storage.

remove_engine method (SNMPTCPTrapMgr Struct)

Removes the engine specified by EngineId from the internal authentication cache.

Syntax

fn remove_engine(&self, engine_id : &[u8]) -> Result<(), IPWorksSNMPError>

Remarks

The internal authentication cache can be used as an alternative to the on_get_user_password event, automatically checking the cache against the security parameters provided in the request signature.

The show_cache method is used to show the contents of the internal authentication cache.

The clear_cache method can be used to completely clear the cache.

remove_user method (SNMPTCPTrapMgr Struct)

Removes the user specified by User of the engine specified by EngineId from the internal authentication cache.

Syntax

fn remove_user(&self, user : &str, engine_id : &[u8]) -> Result<(), IPWorksSNMPError>

Remarks

The internal authentication cache can be used as an alternative to the on_get_user_password event, automatically checking the cache against the security parameters provided in the request signature.

The show_cache method is used to show the contents of the internal authentication cache.

The clear_cache method can be used to completely clear the cache.

reset method (SNMPTCPTrapMgr Struct)

Clears the object arrays.

Syntax

fn reset(&self) -> Result<(), IPWorksSNMPError>

Remarks

Clears the object arrays, and sets the trap and error properties to their default values. This is useful for reinitializing all the properties that are used to create outgoing packets before building a new packet.

Note: snmp_version will be reset to snmpverV2c (2).

show_cache method (SNMPTCPTrapMgr Struct)

Lists all entries in the internal user and engine database.

Syntax

fn show_cache(&self) -> Result<(), IPWorksSNMPError>

Remarks

A on_cache_entry event is fired for every record in the database.

value method (SNMPTCPTrapMgr Struct)

Returns the value corresponding to an OID.

Syntax

fn value(&self, oid : &str) ->  Result<String, IPWorksSNMPError>

Remarks

If the OID does not exist in the objects collection, a trappable error is generated.

Please refer to the SNMPObject type for more information.

on_bad_packet event (SNMPTCPTrapMgr Struct)

Fired for erroneous and/or malformed messages.

Syntax

// SNMPTCPTrapMgrBadPacketEventArgs carries the SNMPTCPTrapMgr BadPacket event's parameters.
pub struct SNMPTCPTrapMgrBadPacketEventArgs {
  fn packet(&self) -> &[u8]
  fn source_address(&self) -> &String
  fn source_port(&self) -> i32
  fn error_code(&self) -> i32
  fn error_description(&self) -> &String
  fn report(&self) -> bool
  fn set_report(&self, value : bool)
}

// SNMPTCPTrapMgrBadPacketEvent defines the signature of the SNMPTCPTrapMgr BadPacket event's handler function.
pub trait SNMPTCPTrapMgrBadPacketEvent {
  fn on_bad_packet(&self, sender : SNMPTCPTrapMgr, e : &mut SNMPTCPTrapMgrBadPacketEventArgs);
}

impl <'a> SNMPTCPTrapMgr<'a> {
  pub fn on_bad_packet(&self) -> &'a dyn SNMPTCPTrapMgrBadPacketEvent;
  pub fn set_on_bad_packet(&mut self, value : &'a dyn SNMPTCPTrapMgrBadPacketEvent);
  ...
}

Remarks

The full message is provided in the Packet parameter.

The on_bad_packet event is also fired when authentication fails for received packets due to a bad password or other reasons.

If the Report parameter is set to True, an unauthenticated error report will be sent to the client, otherwise the packet will be silently ignored.

Please refer to the on_get_user_password event for more information concerning SNMPv3 authentication.

on_cache_entry event (SNMPTCPTrapMgr Struct)

Shows engines and users in the internal cache.

Syntax

// SNMPTCPTrapMgrCacheEntryEventArgs carries the SNMPTCPTrapMgr CacheEntry event's parameters.
pub struct SNMPTCPTrapMgrCacheEntryEventArgs {
  fn engine_id(&self) -> &[u8]
  fn engine_boots(&self) -> i32
  fn engine_time(&self) -> i32
  fn user(&self) -> &String
  fn authentication_protocol(&self) -> &String
  fn authentication_password(&self) -> &String
  fn encryption_algorithm(&self) -> &String
  fn encryption_password(&self) -> &String
}

// SNMPTCPTrapMgrCacheEntryEvent defines the signature of the SNMPTCPTrapMgr CacheEntry event's handler function.
pub trait SNMPTCPTrapMgrCacheEntryEvent {
  fn on_cache_entry(&self, sender : SNMPTCPTrapMgr, e : &mut SNMPTCPTrapMgrCacheEntryEventArgs);
}

impl <'a> SNMPTCPTrapMgr<'a> {
  pub fn on_cache_entry(&self) -> &'a dyn SNMPTCPTrapMgrCacheEntryEvent;
  pub fn set_on_cache_entry(&mut self, value : &'a dyn SNMPTCPTrapMgrCacheEntryEvent);
  ...
}

Remarks

on_cache_entry events are triggered by a call to show_cache. One event is fired for each user and engine. If there are no users for a particular engine, a single event is fired with the engine information, but empty values for user information.

on_check_engine event (SNMPTCPTrapMgr Struct)

Fired to check engine parameters (timeliness, etc.).

Syntax

// SNMPTCPTrapMgrCheckEngineEventArgs carries the SNMPTCPTrapMgr CheckEngine event's parameters.
pub struct SNMPTCPTrapMgrCheckEngineEventArgs {
  fn engine_id(&self) -> &[u8]
  fn engine_boots(&self) -> i32
  fn engine_time(&self) -> i32
  fn user(&self) -> &String
  fn security_level(&self) -> i32
  fn remote_address(&self) -> &String
  fn remote_port(&self) -> i32
  fn is_new(&self) -> bool
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// SNMPTCPTrapMgrCheckEngineEvent defines the signature of the SNMPTCPTrapMgr CheckEngine event's handler function.
pub trait SNMPTCPTrapMgrCheckEngineEvent {
  fn on_check_engine(&self, sender : SNMPTCPTrapMgr, e : &mut SNMPTCPTrapMgrCheckEngineEventArgs);
}

impl <'a> SNMPTCPTrapMgr<'a> {
  pub fn on_check_engine(&self) -> &'a dyn SNMPTCPTrapMgrCheckEngineEvent;
  pub fn set_on_check_engine(&mut self, value : &'a dyn SNMPTCPTrapMgrCheckEngineEvent);
  ...
}

Remarks

The Accept parameter determines if the engine will be accepted or not. If you set Accept to False prior to exiting the event, the processing on the message will stop and a on_bad_packet event will be fired.

The default value of Accept is True if and only if:

a) the engine already exists in the internal authentication cache (the IsNew parameter is False) and the timeliness has been verified;

b) the engine does not exist in the internal authentication cache (the IsNew parameter is True), but the packet has been authenticated by the struct (SecurityLevel >= 1).

In all other cases, the default value for Accept is False, and you are responsible for accepting or not accepting the engine based on other considerations.

If Accept is true upon event exit, then:

a) if the engine already exists in the internal authentication cache, its time is updated to reflect the new time and the processing of the packet continues;

b) if the engine does not exist in the internal authentication cache, it is added there and if User is authenticated, the User will be added too.

on_connected event (SNMPTCPTrapMgr Struct)

Fired immediately after a connection completes (or fails).

Syntax

// SNMPTCPTrapMgrConnectedEventArgs carries the SNMPTCPTrapMgr Connected event's parameters.
pub struct SNMPTCPTrapMgrConnectedEventArgs {
  fn remote_address(&self) -> &String
  fn remote_port(&self) -> i32
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// SNMPTCPTrapMgrConnectedEvent defines the signature of the SNMPTCPTrapMgr Connected event's handler function.
pub trait SNMPTCPTrapMgrConnectedEvent {
  fn on_connected(&self, sender : SNMPTCPTrapMgr, e : &mut SNMPTCPTrapMgrConnectedEventArgs);
}

impl <'a> SNMPTCPTrapMgr<'a> {
  pub fn on_connected(&self) -> &'a dyn SNMPTCPTrapMgrConnectedEvent;
  pub fn set_on_connected(&mut self, value : &'a dyn SNMPTCPTrapMgrConnectedEvent);
  ...
}

Remarks

This event fires after a connection completes or fails.

StatusCode is the value returned by the system TCP/IP stack. This will be 0 if the connection was successful.

Description contains a human readable description of the status. This will be "OK" if the connection was successful.

RemoteAddress is the IP address of the remote host.

RemotePort is the port on the remote host.

on_connection_status event (SNMPTCPTrapMgr Struct)

This event is fired to indicate changes in the connection state.

Syntax

// SNMPTCPTrapMgrConnectionStatusEventArgs carries the SNMPTCPTrapMgr ConnectionStatus event's parameters.
pub struct SNMPTCPTrapMgrConnectionStatusEventArgs {
  fn connection_event(&self) -> &String
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// SNMPTCPTrapMgrConnectionStatusEvent defines the signature of the SNMPTCPTrapMgr ConnectionStatus event's handler function.
pub trait SNMPTCPTrapMgrConnectionStatusEvent {
  fn on_connection_status(&self, sender : SNMPTCPTrapMgr, e : &mut SNMPTCPTrapMgrConnectionStatusEventArgs);
}

impl <'a> SNMPTCPTrapMgr<'a> {
  pub fn on_connection_status(&self) -> &'a dyn SNMPTCPTrapMgrConnectionStatusEvent;
  pub fn set_on_connection_status(&mut self, value : &'a dyn SNMPTCPTrapMgrConnectionStatusEvent);
  ...
}

Remarks

The on_connection_status event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:


	Firewall connection complete.
	Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable).
	Remote host connection complete.
	Remote host disconnected.
	SSL or S/Shell connection broken.
	Firewall host disconnected.

StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack.

Description contains a description of this code. The value of StatusCode is equal to the value of the error.

on_disconnected event (SNMPTCPTrapMgr Struct)

Fired when a connection is closed.

Syntax

// SNMPTCPTrapMgrDisconnectedEventArgs carries the SNMPTCPTrapMgr Disconnected event's parameters.
pub struct SNMPTCPTrapMgrDisconnectedEventArgs {
  fn remote_address(&self) -> &String
  fn remote_port(&self) -> i32
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// SNMPTCPTrapMgrDisconnectedEvent defines the signature of the SNMPTCPTrapMgr Disconnected event's handler function.
pub trait SNMPTCPTrapMgrDisconnectedEvent {
  fn on_disconnected(&self, sender : SNMPTCPTrapMgr, e : &mut SNMPTCPTrapMgrDisconnectedEventArgs);
}

impl <'a> SNMPTCPTrapMgr<'a> {
  pub fn on_disconnected(&self) -> &'a dyn SNMPTCPTrapMgrDisconnectedEvent;
  pub fn set_on_disconnected(&mut self, value : &'a dyn SNMPTCPTrapMgrDisconnectedEvent);
  ...
}

Remarks

This event fires after a connection is broken.

StatusCode is the value returned by the system TCP/IP stack. This will be 0 if the connection was broken normally.

Description contains a human readable description of the status. This will be "OK" if the connection was broken normally.

RemoteAddress is the IP address of the remote host.

RemotePort is the port on the remote host.

on_discovery_request event (SNMPTCPTrapMgr Struct)

Fired when an SNMPv3 discovery packet is received.

Syntax

// SNMPTCPTrapMgrDiscoveryRequestEventArgs carries the SNMPTCPTrapMgr DiscoveryRequest event's parameters.
pub struct SNMPTCPTrapMgrDiscoveryRequestEventArgs {
  fn engine_id(&self) -> &[u8]
  fn engine_boots(&self) -> i32
  fn engine_time(&self) -> i32
  fn user(&self) -> &String
  fn security_level(&self) -> i32
  fn source_address(&self) -> &String
  fn source_port(&self) -> i32
  fn respond(&self) -> bool
  fn set_respond(&self, value : bool)
}

// SNMPTCPTrapMgrDiscoveryRequestEvent defines the signature of the SNMPTCPTrapMgr DiscoveryRequest event's handler function.
pub trait SNMPTCPTrapMgrDiscoveryRequestEvent {
  fn on_discovery_request(&self, sender : SNMPTCPTrapMgr, e : &mut SNMPTCPTrapMgrDiscoveryRequestEventArgs);
}

impl <'a> SNMPTCPTrapMgr<'a> {
  pub fn on_discovery_request(&self) -> &'a dyn SNMPTCPTrapMgrDiscoveryRequestEvent;
  pub fn set_on_discovery_request(&mut self, value : &'a dyn SNMPTCPTrapMgrDiscoveryRequestEvent);
  ...
}

Remarks

EngineId, EngineBoots, EngineTime, and User are the values received from SourceAddress.

For SNMPv3, the User parameter shows the user that was supplied with the packet. This parameter MUST be used together with the SecurityLevel parameter which shows the level of security in the message.

The SecurityLevel parameter shows whether the request has been authenticated. If SecurityLevel is 0, the request has NOT been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, SecurityLevel is 1. For an authenticated and encrypted request, SecurityLevel is 2.

Respond is True by default, and will automatically send a response using the value in local_engine_id. To suppress the response, set Respond to False.

The value returned to SourceAddress for EngineBoots is always 0, and EngineTime is the number of seconds since January 1st, 1970 (GMT).

on_error event (SNMPTCPTrapMgr Struct)

Fired when information is available about errors during data delivery.

Syntax

// SNMPTCPTrapMgrErrorEventArgs carries the SNMPTCPTrapMgr Error event's parameters.
pub struct SNMPTCPTrapMgrErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// SNMPTCPTrapMgrErrorEvent defines the signature of the SNMPTCPTrapMgr Error event's handler function.
pub trait SNMPTCPTrapMgrErrorEvent {
  fn on_error(&self, sender : SNMPTCPTrapMgr, e : &mut SNMPTCPTrapMgrErrorEventArgs);
}

impl <'a> SNMPTCPTrapMgr<'a> {
  pub fn on_error(&self) -> &'a dyn SNMPTCPTrapMgrErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn SNMPTCPTrapMgrErrorEvent);
  ...
}

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

The error_code parameter contains an error code, and the description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_get_user_password event (SNMPTCPTrapMgr Struct)

Retrieves a password associated with a user.

Syntax

// SNMPTCPTrapMgrGetUserPasswordEventArgs carries the SNMPTCPTrapMgr GetUserPassword event's parameters.
pub struct SNMPTCPTrapMgrGetUserPasswordEventArgs {
  fn password_type(&self) -> i32
  fn user(&self) -> &String
  fn engine_id(&self) -> &[u8]
  fn password(&self) -> &String
  fn set_password(&self, value : &str)
  fn set_password_ref(&self, value : &String)
  fn algorithm(&self) -> i32
  fn set_algorithm(&self, value : i32)
}

// SNMPTCPTrapMgrGetUserPasswordEvent defines the signature of the SNMPTCPTrapMgr GetUserPassword event's handler function.
pub trait SNMPTCPTrapMgrGetUserPasswordEvent {
  fn on_get_user_password(&self, sender : SNMPTCPTrapMgr, e : &mut SNMPTCPTrapMgrGetUserPasswordEventArgs);
}

impl <'a> SNMPTCPTrapMgr<'a> {
  pub fn on_get_user_password(&self) -> &'a dyn SNMPTCPTrapMgrGetUserPasswordEvent;
  pub fn set_on_get_user_password(&mut self, value : &'a dyn SNMPTCPTrapMgrGetUserPasswordEvent);
  ...
}

Remarks

The on_get_user_password event is fired after initial inspection of SNMPv3 requests.

The type of password required is provided in the PasswordType parameter: 1 for authentication, and 2 for encryption (privacy).

The password corresponding to User and EngineId must be provided in the Password parameter. If the password is valid, processing will continue to other events such as on_get_request, on_set_request, etc.

If the PasswordType parameter is 1 (authentication is used), the Algorithm parameter can be set. Possible values are:


Value	Authentication Algorithm
0 (default)	Any
1	MD5
2	SHA1
3	SHA256
4	SHA512

If the PasswordType parameter is 2 (encryption is used), the Algorithm parameter must also be set. Possible values are:


Value	Encryption Algorithm
1 (default)	DES
2	AES
3	3DES
4	AES192
5	AES256

If the password does not match the signature in the request, a on_bad_packet event will be fired, at which point you can decide whether to report the error to the client (see the description of the on_bad_packet event for more information).

If the User is invalid or unknown, set the password to empty string (default) to ignore the request. This will result in a on_bad_packet event being fired, at which point you can decide whether to report the error to the client or not.

on_get_user_security_level event (SNMPTCPTrapMgr Struct)

Sets the security level for an incoming packet.

Syntax

// SNMPTCPTrapMgrGetUserSecurityLevelEventArgs carries the SNMPTCPTrapMgr GetUserSecurityLevel event's parameters.
pub struct SNMPTCPTrapMgrGetUserSecurityLevelEventArgs {
  fn user(&self) -> &String
  fn engine_id(&self) -> &[u8]
  fn security_level(&self) -> i32
  fn set_security_level(&self, value : i32)
}

// SNMPTCPTrapMgrGetUserSecurityLevelEvent defines the signature of the SNMPTCPTrapMgr GetUserSecurityLevel event's handler function.
pub trait SNMPTCPTrapMgrGetUserSecurityLevelEvent {
  fn on_get_user_security_level(&self, sender : SNMPTCPTrapMgr, e : &mut SNMPTCPTrapMgrGetUserSecurityLevelEventArgs);
}

impl <'a> SNMPTCPTrapMgr<'a> {
  pub fn on_get_user_security_level(&self) -> &'a dyn SNMPTCPTrapMgrGetUserSecurityLevelEvent;
  pub fn set_on_get_user_security_level(&mut self, value : &'a dyn SNMPTCPTrapMgrGetUserSecurityLevelEvent);
  ...
}

Remarks

The on_get_user_security_level event is fired after the first inspection of each SNMPv3 request. The SecurityLevel parameter determines the level of security for the message.

On entry, the SecurityLevel parameter contains the default security level for User if the user is located in the internal cache, or if the User is not found in the cache, the SecurityLevel will be -1.

The value of SecurityLevel upon exiting the event, determines how the message will be processed:


-1	The message will be ignored and a on_bad_packet event will be fired.
0	No security. The message will be processed without any authentication and/or encryption.
1	Authentication only. The message will be checked for a valid signature and the on_get_user_password event will be fired to verify the authentication password.
2	Authentication and Privacy. The message will be checked for a valid signature and the on_get_user_password event will be fired twice: first to verify the authentication password, and then to verify the privacy password.

on_hash_password event (SNMPTCPTrapMgr Struct)

Fired before and after a password is hashed.

Syntax

// SNMPTCPTrapMgrHashPasswordEventArgs carries the SNMPTCPTrapMgr HashPassword event's parameters.
pub struct SNMPTCPTrapMgrHashPasswordEventArgs {
  fn password(&self) -> &String
  fn auth_algorithm(&self) -> i32
  fn hash(&self) -> &String
  fn set_hash(&self, value : &str)
  fn set_hash_ref(&self, value : &String)
}

// SNMPTCPTrapMgrHashPasswordEvent defines the signature of the SNMPTCPTrapMgr HashPassword event's handler function.
pub trait SNMPTCPTrapMgrHashPasswordEvent {
  fn on_hash_password(&self, sender : SNMPTCPTrapMgr, e : &mut SNMPTCPTrapMgrHashPasswordEventArgs);
}

impl <'a> SNMPTCPTrapMgr<'a> {
  pub fn on_hash_password(&self) -> &'a dyn SNMPTCPTrapMgrHashPasswordEvent;
  pub fn set_on_hash_password(&mut self, value : &'a dyn SNMPTCPTrapMgrHashPasswordEvent);
  ...
}

Remarks

SNMPv3 passwords are hashed in order to obtain authentication and encryption keys. This is an expensive operation, and in certain situations it may be preferable to store the hashed passwords externally and supply them on demand.

If a hash is required, the event fires with an empty string in the Hash parameter. In this case, you can choose to supply a value for the hash and stop the struct from computing the hash.

The event also fires every time a hash is computed. In this case, the Hash parameter contains the value of the computed hash.

AuthAlgorithm contains either 1 for HMAC-MD5-96, 2 for HMAC-SHA-96 or 3 for HMAC-192-SHA-256

on_inform_request event (SNMPTCPTrapMgr Struct)

Fired when an InformRequest packet is received.

Syntax

// SNMPTCPTrapMgrInformRequestEventArgs carries the SNMPTCPTrapMgr InformRequest event's parameters.
pub struct SNMPTCPTrapMgrInformRequestEventArgs {
  fn request_id(&self) -> i32
  fn snmp_version(&self) -> i32
  fn community(&self) -> &String
  fn user(&self) -> &String
  fn security_level(&self) -> i32
  fn source_address(&self) -> &String
  fn source_port(&self) -> i32
  fn error_index(&self) -> i32
  fn set_error_index(&self, value : i32)
  fn error_status(&self) -> i32
  fn set_error_status(&self, value : i32)
  fn error_description(&self) -> &String
  fn respond(&self) -> bool
  fn set_respond(&self, value : bool)
}

// SNMPTCPTrapMgrInformRequestEvent defines the signature of the SNMPTCPTrapMgr InformRequest event's handler function.
pub trait SNMPTCPTrapMgrInformRequestEvent {
  fn on_inform_request(&self, sender : SNMPTCPTrapMgr, e : &mut SNMPTCPTrapMgrInformRequestEventArgs);
}

impl <'a> SNMPTCPTrapMgr<'a> {
  pub fn on_inform_request(&self) -> &'a dyn SNMPTCPTrapMgrInformRequestEvent;
  pub fn set_on_inform_request(&mut self, value : &'a dyn SNMPTCPTrapMgrInformRequestEvent);
  ...
}

Remarks

The user in an InformRequest packet (SNMPv3) must be a valid user in the internal authentication cache (see the add_user method and the on_check_engine event for more information). If not, the request is rejected, and a on_bad_packet event is fired before on_inform_request is fired.

The list of variables in the SNMP packet, including optional values and types, is provided through the objects collection. Each object is of type SNMPObject. This type describes the obj_id, obj_type, and obj_value of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.

The SourceAddress and SourcePort parameters show the address and port of the sender as reported by the TCP/IP stack.

The MessageId parameter identifies the received request.

To send a response, the Respond parameter must be set to true. By default, this value is false, which means no response will be sent. The ErrorStatus parameter may also be set to a valid SNMP status code (the default value is 0, which represents no error).

The following is a list of valid SNMP status code values:


0 (noError)	No error.
1 (tooBig)	The response cannot fit in a single SNMP message.
2 (noSuchName)	Variable does not exist.
3 (badValue)	Invalid value or syntax.
4 (readOnly)	Variable is read-only.
5 (genError)	Other error (SNMPv1).
6 (noAccess)	Access denied.
7 (wrongType)	Wrong object type.
8 (wrongLength)	Wrong length.
9 (wrongEncoding)	Wrong encoding.
10 (wrongValue)	Wrong value.
11 (noCreation)	No creation.
12 (inconsistentValue)	Inconsistent value.
13 (resourceUnavailable)	Resource unavailable.
14 (commitFailed)	Commit failed.
15 (undoFailed)	Undo failed.
16 (authorizationError)	Authorization error.
17 (notWritable)	Variable is not writable.
18 (inconsistentName)	Inconsistent name.

The ErrorIndex parameter indicates the index of the first variable (object) that caused an error. The default value is 0.

Variable indexes start with 0. ErrorIndex has no meaning when ErrorStatus is 0 (no error).

on_packet_trace event (SNMPTCPTrapMgr Struct)

Fired for every packet sent or received.

Syntax

// SNMPTCPTrapMgrPacketTraceEventArgs carries the SNMPTCPTrapMgr PacketTrace event's parameters.
pub struct SNMPTCPTrapMgrPacketTraceEventArgs {
  fn packet(&self) -> &[u8]
  fn direction(&self) -> i32
  fn packet_address(&self) -> &String
  fn packet_port(&self) -> i32
}

// SNMPTCPTrapMgrPacketTraceEvent defines the signature of the SNMPTCPTrapMgr PacketTrace event's handler function.
pub trait SNMPTCPTrapMgrPacketTraceEvent {
  fn on_packet_trace(&self, sender : SNMPTCPTrapMgr, e : &mut SNMPTCPTrapMgrPacketTraceEventArgs);
}

impl <'a> SNMPTCPTrapMgr<'a> {
  pub fn on_packet_trace(&self) -> &'a dyn SNMPTCPTrapMgrPacketTraceEvent;
  pub fn set_on_packet_trace(&mut self, value : &'a dyn SNMPTCPTrapMgrPacketTraceEvent);
  ...
}

Remarks

The on_packet_trace event shows all the packets sent or received by the struct.

Packet contains the full contents of the datagram.

Direction shows the direction of the packet: 1 for incoming packets, and 2 for outgoing packets.

In the case of an incoming packet, PacketAddress and PacketPort identify the source of the packet.

In the case of an outgoing packet, PacketAddress and PacketPort identify the destination of the packet.

on_ssl_client_authentication event (SNMPTCPTrapMgr Struct)

Fired when the client presents its credentials to the server.

Syntax

// SNMPTCPTrapMgrSSLClientAuthenticationEventArgs carries the SNMPTCPTrapMgr SSLClientAuthentication event's parameters.
pub struct SNMPTCPTrapMgrSSLClientAuthenticationEventArgs {
  fn remote_address(&self) -> &String
  fn remote_port(&self) -> i32
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn status(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// SNMPTCPTrapMgrSSLClientAuthenticationEvent defines the signature of the SNMPTCPTrapMgr SSLClientAuthentication event's handler function.
pub trait SNMPTCPTrapMgrSSLClientAuthenticationEvent {
  fn on_ssl_client_authentication(&self, sender : SNMPTCPTrapMgr, e : &mut SNMPTCPTrapMgrSSLClientAuthenticationEventArgs);
}

impl <'a> SNMPTCPTrapMgr<'a> {
  pub fn on_ssl_client_authentication(&self) -> &'a dyn SNMPTCPTrapMgrSSLClientAuthenticationEvent;
  pub fn set_on_ssl_client_authentication(&mut self, value : &'a dyn SNMPTCPTrapMgrSSLClientAuthenticationEvent);
  ...
}

Remarks

This event fires when a client connects to the struct 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 status of the certificate.

Accept defines whether the certificate is accepted.

on_ssl_status event (SNMPTCPTrapMgr Struct)

Shows the progress of the secure connection.

Syntax

// SNMPTCPTrapMgrSSLStatusEventArgs carries the SNMPTCPTrapMgr SSLStatus event's parameters.
pub struct SNMPTCPTrapMgrSSLStatusEventArgs {
  fn remote_address(&self) -> &String
  fn remote_port(&self) -> i32
  fn message(&self) -> &String
}

// SNMPTCPTrapMgrSSLStatusEvent defines the signature of the SNMPTCPTrapMgr SSLStatus event's handler function.
pub trait SNMPTCPTrapMgrSSLStatusEvent {
  fn on_ssl_status(&self, sender : SNMPTCPTrapMgr, e : &mut SNMPTCPTrapMgrSSLStatusEventArgs);
}

impl <'a> SNMPTCPTrapMgr<'a> {
  pub fn on_ssl_status(&self) -> &'a dyn SNMPTCPTrapMgrSSLStatusEvent;
  pub fn set_on_ssl_status(&mut self, value : &'a dyn SNMPTCPTrapMgrSSLStatusEvent);
  ...
}

Remarks

The event is fired for informational and logging purposes only. It is used to track the progress of the connection.

RemoteAddress is the IP address of the remote machine.

RemotePort is the port of the remote machine.

Message is the log message.

on_trap event (SNMPTCPTrapMgr Struct)

Fired when a SNMP trap packet is received.

Syntax

// SNMPTCPTrapMgrTrapEventArgs carries the SNMPTCPTrapMgr Trap event's parameters.
pub struct SNMPTCPTrapMgrTrapEventArgs {
  fn request_id(&self) -> i32
  fn snmp_version(&self) -> i32
  fn community(&self) -> &String
  fn user(&self) -> &String
  fn security_level(&self) -> i32
  fn trap_oid(&self) -> &String
  fn time_stamp(&self) -> i64
  fn agent_address(&self) -> &String
  fn source_address(&self) -> &String
  fn source_port(&self) -> i32
}

// SNMPTCPTrapMgrTrapEvent defines the signature of the SNMPTCPTrapMgr Trap event's handler function.
pub trait SNMPTCPTrapMgrTrapEvent {
  fn on_trap(&self, sender : SNMPTCPTrapMgr, e : &mut SNMPTCPTrapMgrTrapEventArgs);
}

impl <'a> SNMPTCPTrapMgr<'a> {
  pub fn on_trap(&self) -> &'a dyn SNMPTCPTrapMgrTrapEvent;
  pub fn set_on_trap(&mut self, value : &'a dyn SNMPTCPTrapMgrTrapEvent);
  ...
}

Remarks

The TrapOID and TimeStamp parameters contain the Trap OID and TimeStamp. In the case of an SNMPv1 trap, there are two possible scenarios:

First, if the enterprise of the trap is "1.3.6.1.6.3.1.1.5", TrapOID will be a concatenation of TrapEnterprise and GenericTrap + 1. For instance a TrapOID of "1.3.6.1.6.3.1.1.5.5" has a TrapEnterprise of "1.3.6.1.6.3.1.1.5" and a GenericTrap of "4".

Second, In all other cases TrapOID will be a concatenation of the values for TrapEnterprise, GenericTrap, and SpecificTrap, separated by '.'.

For SNMPv2 and above, they are read from the variable-value list (if available).

The SourceAddress and SourcePort parameters show the address and port of the sender as reported by the TCP/IP stack.

Some parameters are only applicable depending on the SNMPVersion value. The table below shows which parameters are applicable to which SNMP versions.


	SNMPv1	SNMPv2	SNMPv3
AgentAddress	X
Community	X	X
RequestId		X	X
SecurityLevel			X
User			X
SNMPVersion	X	X	X
SourceAddress	X	X	X
SourcePort	X	X	X
TimeStamp	X	X	X
TrapOID	X	X	X

Config Settings (SNMPTCPTrapMgr Struct)

The struct accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

SNMPTCPTrapMgr Config Settings

AuthenticationKey: The key to use for authentication.

This setting takes the hex-encoded key for authentication and may be set inside on_get_user_password.

CompatibilityMode: Whether to operate the component in a specific compatibility mode.

This setting will cause the component to operate in a manner different than normal so that it is compatible with third-party products and libraries. The following table lists the possible values for this setting:


0 (default)	Component operates normally for greatest compatibility.
1	Component uses SNMP4j-compatible encryption (AES192 and AES256).
2	Component automatically detects whether to use SNMP4j-compatible encryption (AES192 and AES256). Note: This option is only applicable when receiving packets. If you are using SNMPMgr or sending secure traps, you will need to select either 0 or 1.

ContextEngineId: Sets the context engine id of the SNMP entity.

If set, the context engine id included in the PDU will be set.

ContextName: Sets the context name of the SNMP entity.

If set, the context name included in the PDU will be set.

DecryptLogPackets: Whether to decrypt logged packets.

When set to true this setting will cause the struct to decrypt packets logged in on_packet_trace. This only applies when using SNMP Version 3. The default is false.

EncryptionKey: The key to use for encryption.

This setting takes the hex-encoded key for encryption and may be set inside on_get_user_password.

ForceLocalPort: Forces the struct to bind to a specific port.

The default value is True, which makes the struct throw an error if local_port is busy. When ForceLocalPort is set to False and the port is busy, the struct silently chooses another random port.

IncomingContextEngineId: The engine Id of the received packet.

This setting holds the engine Id of the received packet. This may be queried at any time, including from within an event, and returns the engine Id of the received packet. This is not needed in most cases, but can be used to store the incoming engine Id to send an asynchronous response later. This value is read-only.

IncomingContextName: The context name of the received packet.

This setting holds the context name of the received packet. This may be queried at any time, including from within an event, and returns the context name of the received packet. This is not needed in most cases, but can be used to store the incoming context name to send an asynchronous response later. This value is read-only.

ShowCacheForUser: Shows the cache entry for a single user.

This configuration setting causes the struct to call ShowCache internally, and only fire the CacheEntry event for the user specified.

SourceAddress: The source address of the received packet.

This setting holds the source address of the received packet. This may be queried at any time, including from within an event, and returns the source address of the received packet. This value is read-only.

SourcePort: The source port of the received packet.

This setting holds the source port of the received packet. This may be queried at any time, including from within an event, and returns the source port of the received packet. This value is read-only.

TimeWindow: The time window used for SNMPv3 timeliness checking (authentication).

The default value is 150 (seconds).

TCPClient Config Settings

ConnectionTimeout: Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the struct will use timeout for establishing a connection and transmitting/receiving data.

EnableFallback:

FallbackTimeout:

FirewallAutoDetect: Tells the struct whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by structs that do not directly expose Firewall properties.

FirewallHost: Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This setting is provided for use by structs that do not directly expose Firewall properties.

FirewallHTTPVersion: The HTTP version to be used when connecting through a tunneling proxy.

When FirewallType is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting.

FirewallPassword: Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error.

NOTE: This setting is provided for use by structs that do not directly expose Firewall properties.

FirewallPort: The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

NOTE: This configuration setting is provided for use by structs that do not directly expose Firewall properties.

FirewallType: Determines the type of firewall to connect through.

Possible values are as follows:


0	No firewall (default setting).
1	Connect through a tunneling proxy. FirewallPort is set to 80.
2	Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3	Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10	Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

NOTE: This setting is provided for use by structs that do not directly expose Firewall properties.

FirewallUser: A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the struct fails with an error.

NOTE: This setting is provided for use by structs that do not directly expose Firewall properties.

KeepAliveInterval: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

NOTE: This value is not applicable in macOS.

KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger: When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the struct returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime: Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost: The name of the local host through which connections are initiated or accepted.

The local_host setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface.

If the struct is connected, the local_host setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

LocalPort: The port in the local host where the struct binds.

This configuration setting must be set before a connection is attempted. It instructs the struct to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established.

local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength: The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an eol string.

If an eol string is found in the input stream before MaxLineLength bytes are received, the on_data_in event is fired with the EOL parameter set to True, and the buffer is reset.

If no eol is found, and MaxLineLength bytes are accumulated in the buffer, the on_data_in event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate: The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList: A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.example.com

TCPKeepAlive: Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

NOTE: This value is not applicable in Java.

TcpNoDelay: Whether or not to delay when sending packets.

When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

UseIPv6: Whether to use IPv6.

When set to 0 (default), the struct will use IPv4 exclusively. When set to 1, the struct will use IPv6 exclusively. To instruct the struct to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are as follows:


0	IPv4 only
1	IPv6 only
2	IPv6 with IPv4 fallback

UseNTLMv2: Whether to use NTLM V2.

When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1.

SSL Config Settings

LogSSLPackets: Controls whether SSL packets are logged when using the internal security API.

When ssl_provider is set to Internal, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is False, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the on_ssl_status event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if ssl_provider is set to Platform.

OpenSSLCADir: The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile: Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList: A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData: The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession: Determines if the SSL session is reused.

If set to True, the struct will reuse the context if and only if the following criteria are met:

The target host name is the same.
The system cache entry has not expired (default timeout is 10 hours).
The application process that calls the function is the same.
The logon session is the same.
The instance of the struct is the same.

SSLCACerts: A newline separated list of CA certificates to be included when performing an SSL handshake.

When ssl_provider is set to Internal, this configuration setting specifies one or more CA certificates to be included with the ssl_cert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLCheckCRL: Whether to check the Certificate Revocation List for the server certificate.

This configuration setting specifies whether the struct will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the struct will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The struct will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the struct fails with an error.

When set to 0 (default), the CRL check will not be performed by the struct. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

SSLCheckOCSP: Whether to use OCSP to check the status of the server certificate.

This configuration setting specifies whether the struct will use OCSP to check the validity of the server certificate. If set to 1 or 2, the struct will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The struct will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the struct fails with an error.

When set to 0 (default), the struct will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the on_ssl_status event.

Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.

SSLClientCACerts: A newline separated list of CA certificates to use during SSL client certificate validation.

This configuration setting is only applicable to server components (e.g., TCPServer) see SSLServerCACerts for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when ssl_authenticate_clients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLEnabledCipherSuites: The cipher suite to be used in an SSL negotiation.

This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the struct will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when ssl_provider is set to Platform include the following: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when ssl_provider is set to Platform include the following:

CALG_3DES
CALG_3DES_112
CALG_AES
CALG_AES_128
CALG_AES_192
CALG_AES_256
CALG_AGREEDKEY_ANY
CALG_CYLINK_MEK
CALG_DES
CALG_DESX
CALG_DH_EPHEM
CALG_DH_SF
CALG_DSS_SIGN
CALG_ECDH
CALG_ECDH_EPHEM
CALG_ECDSA
CALG_ECMQV
CALG_HASH_REPLACE_OWF
CALG_HUGHES_MD5
CALG_HMAC
CALG_KEA_KEYX
CALG_MAC
CALG_MD2
CALG_MD4
CALG_MD5
CALG_NO_SIGN
CALG_OID_INFO_CNG_ONLY
CALG_OID_INFO_PARAMETERS
CALG_PCT1_MASTER
CALG_RC2
CALG_RC4
CALG_RC5
CALG_RSA_KEYX
CALG_RSA_SIGN
CALG_SCHANNEL_ENC_KEY
CALG_SCHANNEL_MAC_KEY
CALG_SCHANNEL_MASTER_HASH
CALG_SEAL
CALG_SHA
CALG_SHA1
CALG_SHA_256
CALG_SHA_384
CALG_SHA_512
CALG_SKIPJACK
CALG_SSL2_MASTER
CALG_SSL3_MASTER
CALG_SSL3_SHAMD5
CALG_TEK
CALG_TLS1_MASTER
CALG_TLS1PRF

Example values when ssl_provider is set to Internalinclude the following:

obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");

Possible values when ssl_provider is set to Internal include the following:

TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:

TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols: Used to enable/disable the supported security protocols.

This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:


TLS1.3	12288 (Hex 3000)
TLS1.2	3072 (Hex C00) (Default - Client and Server)
TLS1.1	768 (Hex 300) (Default - Client)
TLS1	192 (Hex C0) (Default - Client)
SSL3	48 (Hex 30)
SSL2	12 (Hex 0C)

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:

By default when TLS 1.3 is enabled, the struct will first try to use the platform TLS 1.3 implementation when the ssl_provider is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

In editions that are designed to run on Windows, ssl_provider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider), please be aware of the following notes:

The platform provider is available only on Windows 11/Windows Server 2022 and up.
SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the struct when the ssl_provider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and ssl_provider needs to be set to platform.

SSLEnableRenegotiation: Whether the renegotiation_info SSL extension is supported.

This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is false by default, but it can be set to true to enable the extension.

This configuration setting is applicable only when ssl_provider is set to Internal.

SSLIncludeCertChain: Whether the entire certificate chain is included in the SSLServerAuthentication event.

This configuration setting specifies whether the Encoded parameter of the on_ssl_server_authentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the on_ssl_server_authentication event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the on_ssl_server_authentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile: The location of a file where per-session secrets are written for debugging purposes.

This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the struct will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the struct will only append, it will not overwrite previous values.

NOTE: This configuration setting is applicable only when ssl_provider is set to Internal.

SSLNegotiatedCipher: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength: Returns the negotiated cipher suite strength.

This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange: Returns the negotiated key exchange algorithm.

This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength: Returns the negotiated key exchange algorithm strength.

This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

SSLNegotiatedVersion: Returns the negotiated protocol version.

This configuration setting returns the protocol version negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags: Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:


0x00000001	Ignore time validity status of certificate.
0x00000002	Ignore time validity status of CTL.
0x00000004	Ignore non-nested certificate times.
0x00000010	Allow unknown certificate authority.
0x00000020	Ignore wrong certificate usage.
0x00000100	Ignore unknown certificate revocation status.
0x00000200	Ignore unknown CTL signer revocation status.
0x00000400	Ignore unknown certificate authority revocation status.
0x00000800	Ignore unknown root revocation status.
0x00008000	Allow test root certificate.
0x00004000	Trust test root certificate.
0x80000000	Ignore non-matching CN (certificate CN non-matching server name).

This functionality is currently not available when the provider is OpenSSL.

SSLServerCACerts: A newline separated list of CA certificates to use during SSL server certificate validation.

This configuration setting is only used by client components (e.g., TCPClient) see SSLClientCACerts for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

TLS12SignatureAlgorithms: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This configuration setting specifies the allowed server certificate signature algorithms when ssl_provider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the struct will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the struct fails with an error.

The format of this value is a comma-separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups: The supported groups for ECC.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and ssl_provider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.

NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448"
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1"
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096"
"ffdhe_6144"
"ffdhe_8192"

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

"ed25519" (default)
"ed448" (default)
"ecdsa_secp256r1_sha256" (default)
"ecdsa_secp384r1_sha384" (default)
"ecdsa_secp521r1_sha512" (default)
"rsa_pkcs1_sha256" (default)
"rsa_pkcs1_sha384" (default)
"rsa_pkcs1_sha512" (default)
"rsa_pss_sha256" (default)
"rsa_pss_sha384" (default)
"rsa_pss_sha512" (default)

The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This configuration setting is applicable only when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448" (default)
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096" (default)
"ffdhe_6144" (default)
"ffdhe_8192" (default)
"mlkem_512" (default)
"mlkem_768" (default)
"mlkem_1024" (default)
"x25519_mlkem_768" (default)
"secp256r1_mlkem_768" (default)

Post-quantum algorithms (mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported:

Windows Server 2025
Windows 11 24H2
Windows 11 25H2

Socket Config Settings

AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method that does not complete within timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

NOTE: This option is not valid for User Datagram Protocol (UDP) ports.

FirewallData: Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

InBufferSize: The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the InBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize: The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the OutBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:


Identifier	Name
037	IBM EBCDIC - U.S./Canada
437	OEM - United States
500	IBM EBCDIC - International
708	Arabic - ASMO 708
709	Arabic - ASMO 449+, BCON V4
710	Arabic - Transparent Arabic
720	Arabic - Transparent ASMO
737	OEM - Greek (formerly 437G)
775	OEM - Baltic
850	OEM - Multilingual Latin I
852	OEM - Latin II
855	OEM - Cyrillic (primarily Russian)
857	OEM - Turkish
858	OEM - Multilingual Latin I + Euro symbol
860	OEM - Portuguese
861	OEM - Icelandic
862	OEM - Hebrew
863	OEM - Canadian-French
864	OEM - Arabic
865	OEM - Nordic
866	OEM - Russian
869	OEM - Modern Greek
870	IBM EBCDIC - Multilingual/ROECE (Latin-2)
874	ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875	IBM EBCDIC - Modern Greek
932	ANSI/OEM - Japanese, Shift-JIS
936	ANSI/OEM - Simplified Chinese (PRC, Singapore)
949	ANSI/OEM - Korean (Unified Hangul Code)
950	ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026	IBM EBCDIC - Turkish (Latin-5)
1047	IBM EBCDIC - Latin 1/Open System
1140	IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141	IBM EBCDIC - Germany (20273 + Euro symbol)
1142	IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143	IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144	IBM EBCDIC - Italy (20280 + Euro symbol)
1145	IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146	IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147	IBM EBCDIC - France (20297 + Euro symbol)
1148	IBM EBCDIC - International (500 + Euro symbol)
1149	IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200	Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201	Unicode UCS-2 Big-Endian
1250	ANSI - Central European
1251	ANSI - Cyrillic
1252	ANSI - Latin I
1253	ANSI - Greek
1254	ANSI - Turkish
1255	ANSI - Hebrew
1256	ANSI - Arabic
1257	ANSI - Baltic
1258	ANSI/OEM - Vietnamese
1361	Korean (Johab)
10000	MAC - Roman
10001	MAC - Japanese
10002	MAC - Traditional Chinese (Big5)
10003	MAC - Korean
10004	MAC - Arabic
10005	MAC - Hebrew
10006	MAC - Greek I
10007	MAC - Cyrillic
10008	MAC - Simplified Chinese (GB 2312)
10010	MAC - Romania
10017	MAC - Ukraine
10021	MAC - Thai
10029	MAC - Latin II
10079	MAC - Icelandic
10081	MAC - Turkish
10082	MAC - Croatia
12000	Unicode UCS-4 Little-Endian
12001	Unicode UCS-4 Big-Endian
20000	CNS - Taiwan
20001	TCA - Taiwan
20002	Eten - Taiwan
20003	IBM5550 - Taiwan
20004	TeleText - Taiwan
20005	Wang - Taiwan
20105	IA5 IRV International Alphabet No. 5 (7-bit)
20106	IA5 German (7-bit)
20107	IA5 Swedish (7-bit)
20108	IA5 Norwegian (7-bit)
20127	US-ASCII (7-bit)
20261	T.61
20269	ISO 6937 Non-Spacing Accent
20273	IBM EBCDIC - Germany
20277	IBM EBCDIC - Denmark/Norway
20278	IBM EBCDIC - Finland/Sweden
20280	IBM EBCDIC - Italy
20284	IBM EBCDIC - Latin America/Spain
20285	IBM EBCDIC - United Kingdom
20290	IBM EBCDIC - Japanese Katakana Extended
20297	IBM EBCDIC - France
20420	IBM EBCDIC - Arabic
20423	IBM EBCDIC - Greek
20424	IBM EBCDIC - Hebrew
20833	IBM EBCDIC - Korean Extended
20838	IBM EBCDIC - Thai
20866	Russian - KOI8-R
20871	IBM EBCDIC - Icelandic
20880	IBM EBCDIC - Cyrillic (Russian)
20905	IBM EBCDIC - Turkish
20924	IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932	JIS X 0208-1990 & 0121-1990
20936	Simplified Chinese (GB2312)
21025	IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027	Extended Alpha Lowercase
21866	Ukrainian (KOI8-U)
28591	ISO 8859-1 Latin I
28592	ISO 8859-2 Central Europe
28593	ISO 8859-3 Latin 3
28594	ISO 8859-4 Baltic
28595	ISO 8859-5 Cyrillic
28596	ISO 8859-6 Arabic
28597	ISO 8859-7 Greek
28598	ISO 8859-8 Hebrew
28599	ISO 8859-9 Latin 5
28605	ISO 8859-15 Latin 9
29001	Europa 3
38598	ISO 8859-8 Hebrew
50220	ISO 2022 Japanese with no halfwidth Katakana
50221	ISO 2022 Japanese with halfwidth Katakana
50222	ISO 2022 Japanese JIS X 0201-1989
50225	ISO 2022 Korean
50227	ISO 2022 Simplified Chinese
50229	ISO 2022 Traditional Chinese
50930	Japanese (Katakana) Extended
50931	US/Canada and Japanese
50933	Korean Extended and Korean
50935	Simplified Chinese Extended and Simplified Chinese
50936	Simplified Chinese
50937	US/Canada and Traditional Chinese
50939	Japanese (Latin) Extended and Japanese
51932	EUC - Japanese
51936	EUC - Simplified Chinese
51949	EUC - Korean
51950	EUC - Traditional Chinese
52936	HZ-GB2312 Simplified Chinese
54936	Windows XP: GB18030 Simplified Chinese (4 Byte)
57002	ISCII Devanagari
57003	ISCII Bengali
57004	ISCII Tamil
57005	ISCII Telugu
57006	ISCII Assamese
57007	ISCII Oriya
57008	ISCII Kannada
57009	ISCII Malayalam
57010	ISCII Gujarati
57011	ISCII Punjabi
65000	Unicode UTF-7
65001	Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a struct is using. It will return the following information:

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitiveData: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to false, the struct will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the struct to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (SNMPTCPTrapMgr Struct)

SNMPTCPTrapMgr Errors

301	Bad Object Index.
302	Value exceeds maximum number of objects allowed.
303	The value must be an IP address in dotted format.
305	Unsupported SNMP version.
306	Unknown PDU type.
307	The struct is busy performing the current action.
308	Verification failed.
309	Missing password for Verification.
310	Missing signature.
311	Missing remote time.
312	Missing timeout value.
313	Decryption Failed.
314	Missing password for decryption.
315	Not encrypted.
316	Security model not supported.
317	Defective packet
318	Not from bound point.
319	Operation not permitted in current role.
320	Bad packet.
321	Message not authenticated.
322	No such oid.
323	Missing privacy parameter.
324	Bad engine id.
325	Bad time frame.
326	Bad user name.
327	Security level was not accepted.
328	Discovery failed.
329	Incorrect key length.

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

100	You cannot change the remote_port at this time. A connection is in progress.
101	You cannot change the remote_host (Server) at this time. A connection is in progress.
102	The remote_host address is invalid (0.0.0.0).
104	Already connected. If you want to reconnect, close the current connection first.
106	You cannot change the local_port at this time. A connection is in progress.
107	You cannot change the local_host at this time. A connection is in progress.
112	You cannot change MaxLineLength at this time. A connection is in progress.
116	remote_port cannot be zero. Please specify a valid service port number.
117	You cannot change the UseConnection option while the struct is active.
135	Operation would block.
201	Timeout.
211	Action impossible in control's present state.
212	Action impossible while not connected.
213	Action impossible while listening.
301	Timeout.
302	Could not open file.
434	Unable to convert string to selected CodePage.
1105	Already connecting. If you want to reconnect, close the current connection first.
1117	You need to connect first.
1119	You cannot change the LocalHost at this time. A connection is in progress.
1120	Connection dropped by remote host.

SSL Errors

270	Cannot load specified security library.
271	Cannot open certificate store.
272	Cannot find specified certificate.
273	Cannot acquire security credentials.
274	Cannot find certificate chain.
275	Cannot verify certificate chain.
276	Error during handshake.
280	Error verifying certificate.
281	Could not find client certificate.
282	Could not find server certificate.
283	Error encrypting data.
284	Error decrypting data.

TCP/IP Errors

10004	[10004] Interrupted system call.
10009	[10009] Bad file number.
10013	[10013] Access denied.
10014	[10014] Bad address.
10022	[10022] Invalid argument.
10024	[10024] Too many open files.
10035	[10035] Operation would block.
10036	[10036] Operation now in progress.
10037	[10037] Operation already in progress.
10038	[10038] Socket operation on nonsocket.
10039	[10039] Destination address required.
10040	[10040] Message is too long.
10041	[10041] Protocol wrong type for socket.
10042	[10042] Bad protocol option.
10043	[10043] Protocol is not supported.
10044	[10044] Socket type is not supported.
10045	[10045] Operation is not supported on socket.
10046	[10046] Protocol family is not supported.
10047	[10047] Address family is not supported by protocol family.
10048	[10048] Address already in use.
10049	[10049] Cannot assign requested address.
10050	[10050] Network is down.
10051	[10051] Network is unreachable.
10052	[10052] Net dropped connection or reset.
10053	[10053] Software caused connection abort.
10054	[10054] Connection reset by peer.
10055	[10055] No buffer space available.
10056	[10056] Socket is already connected.
10057	[10057] Socket is not connected.
10058	[10058] Cannot send after socket shutdown.
10059	[10059] Too many references, cannot splice.
10060	[10060] Connection timed out.
10061	[10061] Connection refused.
10062	[10062] Too many levels of symbolic links.
10063	[10063] File name is too long.
10064	[10064] Host is down.
10065	[10065] No route to host.
10066	[10066] Directory is not empty
10067	[10067] Too many processes.
10068	[10068] Too many users.
10069	[10069] Disc Quota Exceeded.
10070	[10070] Stale NFS file handle.
10071	[10071] Too many levels of remote in path.
10091	[10091] Network subsystem is unavailable.
10092	[10092] WINSOCK DLL Version out of range.
10093	[10093] Winsock is not loaded yet.
11001	[11001] Host not found.
11002	[11002] Nonauthoritative 'Host not found' (try again or check DNS setup).
11003	[11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP.
11004	[11004] Valid name, no data record (check DNS setup).