# SNMPTCPTrapMgr Class The SNMPTCPTrapMgr class provides a TCP-based listening point for SNMP traps. ## Syntax **ipworkssnmp.snmptcptrapmgr()** ## Remarks The SNMPTCPTrapMgr class provides a TCP-based listening point for SNMP traps and informs as specified by the SNMP RFCs. The class supports v1, v2c, and v3 traps. The class 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 class is activated/deactivated by calling the [Activate](#snmptcptrapmgractivate-method) or [Deactivate](#snmptcptrapmgrdeactivate-method) method. These methods enable or disable sending and receiving. The activation status can be found in the [Active](#snmptcptrapmgractive-property) property. Messages are received through events such as [Trap](#snmptcptrapmgrtrap-event), [InformRequest](#snmptcptrapmgrinformrequest-event), or [DiscoveryRequest](#snmptcptrapmgrdiscoveryrequest-event). SNMP OIDs, types, and values are provided in the [Objects](#snmptcptrapmgrobjects-property) collection of SNMP objects for both sent and received packets. SNMPv3 USM security passwords are requested through the [GetUserPassword](#snmptcptrapmgrgetuserpassword-event) 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 [AddUser](#snmptcptrapmgradduser-method), [RemoveUser](#snmptcptrapmgrremoveuser-method), [ShowCache](#snmptcptrapmgrshowcache-method), [ClearCache](#snmptcptrapmgrclearcache-method), [AddEngine](#snmptcptrapmgraddengine-method), and [RemoveEngine](#snmptcptrapmgrremoveengine-method) methods are used to manage an internal authentication cache. This internal cache can be used as an alternative to the [GetUserPassword](#snmptcptrapmgrgetuserpassword-event) event, automatically checking the cache against the security parameters provided in the request signature. ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AcceptData](#snmptcptrapmgracceptdata-property) | Enables or disables data reception. | | [Active](#snmptcptrapmgractive-property) | Indicates whether the class is active. | | [LocalEngineId](#snmptcptrapmgrlocalengineid-property) | The Engine Id (for SNMPv3). | | [LocalHost](#snmptcptrapmgrlocalhost-property) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [LocalPort](#snmptcptrapmgrlocalport-property) | The port in the local host where the class is bound to. | | [Objects](#snmptcptrapmgrobjects-property) | The objects in the current request. | | [RequestId](#snmptcptrapmgrrequestid-property) | The request-id to mark outgoing packets with. | | [SSLAuthenticateClients](#snmptcptrapmgrsslauthenticateclients-property) | If set to True, the server asks the client(s) for a certificate. | | [SSLCert](#snmptcptrapmgrsslcert-property) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. | | [SSLEnabled](#snmptcptrapmgrsslenabled-property) | Whether TLS/SSL is enabled. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Activate](#snmptcptrapmgractivate-method) | Activates the class. | | [AddEngine](#snmptcptrapmgraddengine-method) | Adds the engine specified by EngineId to the internal authentication cache. | | [AddUser](#snmptcptrapmgradduser-method) | Adds a user for the engine specified by EngineId to the internal authentication cache. | | [ClearCache](#snmptcptrapmgrclearcache-method) | Clears the internal authentication database. | | [Config](#snmptcptrapmgrconfig-method) | Sets or retrieves a configuration setting. | | [Deactivate](#snmptcptrapmgrdeactivate-method) | Deactivates the class. | | [DoEvents](#snmptcptrapmgrdoevents-method) | This method processes events from the internal message queue. | | [HashPasswords](#snmptcptrapmgrhashpasswords-method) | Hashes all passwords in the cache. | | [RemoveEngine](#snmptcptrapmgrremoveengine-method) | Removes the engine specified by EngineId from the internal authentication cache. | | [RemoveUser](#snmptcptrapmgrremoveuser-method) | Removes the user specified by User of the engine specified by EngineId from the internal authentication cache. | | [Reset](#snmptcptrapmgrreset-method) | Clears the object arrays. | | [ShowCache](#snmptcptrapmgrshowcache-method) | Lists all entries in the internal user and engine database. | | [Value](#snmptcptrapmgrvalue-method) | Returns the value corresponding to an OID. | ## Event List *The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [BadPacket](#snmptcptrapmgrbadpacket-event) | Fired for erroneous and/or malformed messages. | | [CacheEntry](#snmptcptrapmgrcacheentry-event) | Shows engines and users in the internal cache. | | [CheckEngine](#snmptcptrapmgrcheckengine-event) | Fired to check engine parameters (timeliness, etc.). | | [Connected](#snmptcptrapmgrconnected-event) | Fired immediately after a connection completes (or fails). | | [ConnectionStatus](#snmptcptrapmgrconnectionstatus-event) | This event is fired to indicate changes in the connection state. | | [Disconnected](#snmptcptrapmgrdisconnected-event) | Fired when a connection is closed. | | [DiscoveryRequest](#snmptcptrapmgrdiscoveryrequest-event) | Fired when an SNMPv3 discovery packet is received. | | [Error](#snmptcptrapmgrerror-event) | Fired when information is available about errors during data delivery. | | [GetUserPassword](#snmptcptrapmgrgetuserpassword-event) | Retrieves a password associated with a user. | | [GetUserSecurityLevel](#snmptcptrapmgrgetusersecuritylevel-event) | Sets the security level for an incoming packet. | | [HashPassword](#snmptcptrapmgrhashpassword-event) | Fired before and after a password is hashed. | | [InformRequest](#snmptcptrapmgrinformrequest-event) | Fired when an InformRequest packet is received. | | [PacketTrace](#snmptcptrapmgrpackettrace-event) | Fired for every packet sent or received. | | [SSLClientAuthentication](#snmptcptrapmgrsslclientauthentication-event) | Fired when the client presents its credentials to the server. | | [SSLStatus](#snmptcptrapmgrsslstatus-event) | Shows the progress of the secure connection. | | [Trap](#snmptcptrapmgrtrap-event) | Fired when a SNMP trap packet is received. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AuthenticationKey](#AuthenticationKey) | The key to use for authentication. | | [CompatibilityMode](#CompatibilityMode) | Whether to operate the class in a specific compatibility mode. | | [ContextEngineId](#ContextEngineId) | Sets the context engine id of the SNMP entity. | | [ContextName](#ContextName) | Sets the context name of the SNMP entity. | | [DecryptLogPackets](#DecryptLogPackets) | Whether to decrypt logged packets. | | [EncryptionKey](#EncryptionKey) | The key to use for encryption. | | [ForceLocalPort](#ForceLocalPort) | Forces the class to bind to a specific port. | | [IncomingContextEngineId](#IncomingContextEngineId) | The engine Id of the received packet. | | [IncomingContextName](#IncomingContextName) | The context name of the received packet. | | [ShowCacheForUser](#ShowCacheForUser) | Shows the cache entry for a single user. | | [SourceAddress](#SourceAddress) | The source address of the received packet. | | [SourcePort](#SourcePort) | The source port of the received packet. | | [TimeWindow](#TimeWindow) | The time window used for SNMPv3 timeliness checking (authentication). | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [EnableFallback](#EnableFallback) | Whether to try the other addresses the remote host resolves to when a connection attempt fails. | | [FallbackTimeout](#FallbackTimeout) | The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the class whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the class binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. | | [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. | | [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. | | [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLAcceptAnyServerCert](#SSLAcceptAnyServerCert) | Whether to trust any certificate presented by the server. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).AcceptData Property Enables or disables data reception. ## Syntax ```text isAcceptData(): boolean; ``` ## 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 and not available at design time. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).Active Property Indicates whether the class is active. ## Syntax ```text isActive(): boolean; ``` ## Default Value FALSE ## Remarks This property indicates whether the class is currently active and can send or receive data. The class will be automatically activated if it is not already and you attempt to perform an operation which requires the class to be active. Use the [Activate](#snmptcptrapmgractivate-method) and [Deactivate](#snmptcptrapmgrdeactivate-method) methods to control whether the class is active. This property is read-only and not available at design time. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).LocalEngineId Property The Engine Id (for SNMPv3). ## Syntax ```text getLocalEngineId(): Uint8Array; setLocalEngineId(localEngineId: Uint8Array): void; ``` ## Default Value "" ## Remarks This property is necessary for properly handling [InformRequest](#snmptcptrapmgrinformrequest-event) packets. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).LocalHost Property The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax ```text getLocalHost(): string; setLocalHost(localHost: string): void; ``` ## 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 class initiate connections (or accept in the case of server classes) 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 class is connected, the LocalHost 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: LocalHost is not persistent. You must always set it in code, and never in the property window. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).LocalPort Property The port in the local host where the class is bound to. ## Syntax ```text getLocalPort(): number; setLocalPort(localPort: number): void; ``` ## Default Value 162 ## Remarks The LocalPort property must be set before the class is activated ([Active](#snmptcptrapmgractive-property) is set to True). It instructs the class 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](#ForceLocalPort) configuration setting is set to False, in which case a random port will be chosen. LocalPort cannot be changed once the class is [Active](#snmptcptrapmgractive-property). Any attempt to set the LocalPort property when the class is [Active](#snmptcptrapmgractive-property) will generate an error. NOTE: on macOS and iOS, root permissions are required to set LocalPort to any value below 1024. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).Objects Property The objects in the current request. ## Syntax ```text getObjects(): SNMPObjectList; ``` ## Default Value ## Remarks The SNMP objects being sent or received in the current request. The collection is first cleared, then populated every time an SNMP packet is received. It is also used to create outgoing SNMP packets. Please refer to the [SNMPObject](#snmpobject-type) type for a complete list of fields. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).RequestId Property The request-id to mark outgoing packets with. ## Syntax ```text getRequestId(): number; setRequestId(requestId: number): void; ``` ## Default Value 1 ## Remarks If a custom value is needed for RequestId, the property must be set before sending the request. The class increments RequestId automatically after sending each packet. This property is not available at design time. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).SSLAuthenticateClients Property If set to True, the server asks the client(s) for a certificate. ## Syntax ```text isSSLAuthenticateClients(): boolean; setSSLAuthenticateClients(SSLAuthenticateClients: boolean): void; ``` ## Default Value FALSE ## Remarks This property is used in conjunction with the [SSLClientAuthentication](#snmptcptrapmgrsslclientauthentication-event) event. Please refer to the documentation of the [SSLClientAuthentication](#snmptcptrapmgrsslclientauthentication-event) event for details. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).SSLCert Property The certificate to be used during Secure Sockets Layer (SSL) negotiation. ## Syntax ```text getSSLCert(): Certificate; setSSLCert(SSLCert: Certificate): void; ``` ## Default Value ## Remarks This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the store and subject fields. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).SSLEnabled Property Whether TLS/SSL is enabled. ## Syntax ```text isSSLEnabled(): boolean; setSSLEnabled(SSLEnabled: boolean): void; ``` ## Default Value FALSE ## Remarks This setting specifies whether TLS/SSL is enabled in the class. When False (default) the class operates in plaintext mode. When True TLS/SSL is enabled. This property is not available at design time. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).activate Method Activates the class. ## Syntax ```text async snmptcptrapmgr.activate(): Promise< void> ``` ## Remarks This method activates the component and will allow it to send or receive data. The class will be automatically activated if it is not already and you attempt to perform an operation which requires the class to be active. NOTE: Use the [Active](#snmptcptrapmgractive-property) property to check whether the component is active. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).addEngine Method Adds the engine specified by EngineId to the internal authentication cache. ## Syntax ```text async snmptcptrapmgr.addEngine(engineId : Uint8Array, engineBoots : number, engineTime : number): Promise< void> ``` ## Remarks The internal authentication cache can be used as an alternative to the [GetUserPassword](#snmptcptrapmgrgetuserpassword-event) event, automatically checking the cache against the security parameters provided in the request signature. The [ShowCache](#snmptcptrapmgrshowcache-method) method is used to show the contents of the internal authentication cache. The [ClearCache](#snmptcptrapmgrclearcache-method) method can be used to completely clear the cache. If the engine parameters are unknown, the [SNMPMgr](SNMPMgr.md#SNMPMgr) class'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. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).addUser Method Adds a user for the engine specified by EngineId to the internal authentication cache. ## Syntax ```text async snmptcptrapmgr.addUser(user : string, engineId : Uint8Array, authenticationProtocol : number, authenticationPassword : string, encryptionAlgorithm : number, encryptionPassword : string): Promise< void> ``` ## Remarks The internal authentication cache can be used as an alternative to the [GetUserPassword](#snmptcptrapmgrgetuserpassword-event) event, automatically checking the cache against the security parameters provided in the request signature. The [ShowCache](#snmptcptrapmgrshowcache-method) method is used to show the contents of the internal authentication cache. The [ClearCache](#snmptcptrapmgrclearcache-method) 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. | # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).clearCache Method Clears the internal authentication database. ## Syntax ```text async snmptcptrapmgr.clearCache(): Promise< void> ``` ## Remarks All user and engine records are removed from the internal authentication cache as a result of this call. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).config Method Sets or retrieves a configuration setting. ## Syntax ```text async snmptcptrapmgr.config(configurationString : string): Promise< string> ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-class-ipworkssnmpsnmptcptrapmgr) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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](#config-settings-class-ipworkssnmpsnmptcptrapmgr), you must call *Config("PROPERTY")*. The value will be returned as a string. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).deactivate Method Deactivates the class. ## Syntax ```text async snmptcptrapmgr.deactivate(): Promise< void> ``` ## Remarks This method deactivates the component and will prohibit it from sending and receiving data. NOTE: Use the [Active](#snmptcptrapmgractive-property) property to check whether the component is active. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).doEvents Method This method processes events from the internal message queue. ## Syntax ```text async snmptcptrapmgr.doEvents(): Promise< void> ``` ## Remarks When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).hashPasswords Method Hashes all passwords in the cache. ## Syntax ```text async snmptcptrapmgr.hashPasswords(): Promise< void> ``` ## Remarks Forces computation of all passwords hashes in the cache. Used together with the [HashPassword](#snmptcptrapmgrhashpassword-event) event to enable implementations of external password hash storage. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).removeEngine Method Removes the engine specified by EngineId from the internal authentication cache. ## Syntax ```text async snmptcptrapmgr.removeEngine(engineId : Uint8Array): Promise< void> ``` ## Remarks The internal authentication cache can be used as an alternative to the [GetUserPassword](#snmptcptrapmgrgetuserpassword-event) event, automatically checking the cache against the security parameters provided in the request signature. The [ShowCache](#snmptcptrapmgrshowcache-method) method is used to show the contents of the internal authentication cache. The [ClearCache](#snmptcptrapmgrclearcache-method) method can be used to completely clear the cache. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).removeUser Method Removes the user specified by User of the engine specified by EngineId from the internal authentication cache. ## Syntax ```text async snmptcptrapmgr.removeUser(user : string, engineId : Uint8Array): Promise< void> ``` ## Remarks The internal authentication cache can be used as an alternative to the [GetUserPassword](#snmptcptrapmgrgetuserpassword-event) event, automatically checking the cache against the security parameters provided in the request signature. The [ShowCache](#snmptcptrapmgrshowcache-method) method is used to show the contents of the internal authentication cache. The [ClearCache](#snmptcptrapmgrclearcache-method) method can be used to completely clear the cache. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).reset Method Clears the object arrays. ## Syntax ```text async snmptcptrapmgr.reset(): Promise< void> ``` ## 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: SNMPVersion will be reset to **snmpverV2c (2)**. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).showCache Method Lists all entries in the internal user and engine database. ## Syntax ```text async snmptcptrapmgr.showCache(): Promise< void> ``` ## Remarks A [CacheEntry](#snmptcptrapmgrcacheentry-event) event is fired for every record in the database. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).value Method Returns the value corresponding to an OID. ## Syntax ```text async snmptcptrapmgr.value(OID : string): Promise< string> ``` ## Remarks If the OID does not exist in the [Objects](#snmptcptrapmgrobjects-property) collection, a trappable error is generated. Please refer to the [SNMPObject](#snmpobject-type) type for more information. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).BadPacket Event Fired for erroneous and/or malformed messages. ## Syntax ```text snmptcptrapmgr.on('BadPacket', listener: (e: {readonly packet: string, readonly packetB: Uint8Array, readonly sourceAddress: string, readonly sourcePort: number, readonly errorCode: number, readonly errorDescription: string, report: boolean}) => void ) ``` ## Remarks The full message is provided in the *Packet* parameter. The BadPacket 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 [GetUserPassword](#snmptcptrapmgrgetuserpassword-event) event for more information concerning SNMPv3 authentication. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).CacheEntry Event Shows engines and users in the internal cache. ## Syntax ```text snmptcptrapmgr.on('CacheEntry', listener: (e: {readonly engineId: string, readonly engineIdB: Uint8Array, readonly engineBoots: number, readonly engineTime: number, readonly user: string, readonly authenticationProtocol: string, readonly authenticationPassword: string, readonly encryptionAlgorithm: string, readonly encryptionPassword: string}) => void ) ``` ## Remarks CacheEntry events are triggered by a call to [ShowCache](#snmptcptrapmgrshowcache-method). 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. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).CheckEngine Event Fired to check engine parameters (timeliness, etc.). ## Syntax ```text snmptcptrapmgr.on('CheckEngine', listener: (e: {readonly engineId: string, readonly engineIdB: Uint8Array, readonly engineBoots: number, readonly engineTime: number, readonly user: string, readonly securityLevel: number, readonly remoteAddress: string, readonly remotePort: number, readonly isNew: boolean, accept: boolean}) => void ) ``` ## 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 [BadPacket](#snmptcptrapmgrbadpacket-event) 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 class (*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. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).Connected Event Fired immediately after a connection completes (or fails). ## Syntax ```text snmptcptrapmgr.on('Connected', listener: (e: {readonly remoteAddress: string, readonly remotePort: number, readonly statusCode: number, readonly description: string}) => void ) ``` ## 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. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).ConnectionStatus Event This event is fired to indicate changes in the connection state. ## Syntax ```text snmptcptrapmgr.on('ConnectionStatus', listener: (e: {readonly connectionEvent: string, readonly statusCode: number, readonly description: string}) => void ) ``` ## Remarks The ConnectionStatus 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. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).Disconnected Event Fired when a connection is closed. ## Syntax ```text snmptcptrapmgr.on('Disconnected', listener: (e: {readonly remoteAddress: string, readonly remotePort: number, readonly statusCode: number, readonly description: string}) => void ) ``` ## 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. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).DiscoveryRequest Event Fired when an SNMPv3 discovery packet is received. ## Syntax ```text snmptcptrapmgr.on('DiscoveryRequest', listener: (e: {readonly engineId: string, readonly engineIdB: Uint8Array, readonly engineBoots: number, readonly engineTime: number, readonly user: string, readonly securityLevel: number, readonly sourceAddress: string, readonly sourcePort: number, respond: boolean}) => void ) ``` ## 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 [LocalEngineId](#snmptcptrapmgrlocalengineid-property). 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). # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).Error Event Fired when information is available about errors during data delivery. ## Syntax ```text snmptcptrapmgr.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void ) ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the class . The *ErrorCode* 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](#trappable-errors-class-ipworkssnmpsnmptcptrapmgr) section. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).GetUserPassword Event Retrieves a password associated with a user. ## Syntax ```text snmptcptrapmgr.on('GetUserPassword', listener: (e: {readonly passwordType: number, readonly user: string, readonly engineId: string, readonly engineIdB: Uint8Array, password: string, algorithm: number}) => void ) ``` ## Remarks The GetUserPassword 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 GetRequest, SetRequest, 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 [BadPacket](#snmptcptrapmgrbadpacket-event) event will be fired, at which point you can decide whether to report the error to the client (see the description of the [BadPacket](#snmptcptrapmgrbadpacket-event) 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 [BadPacket](#snmptcptrapmgrbadpacket-event) event being fired, at which point you can decide whether to report the error to the client or not. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).GetUserSecurityLevel Event Sets the security level for an incoming packet. ## Syntax ```text snmptcptrapmgr.on('GetUserSecurityLevel', listener: (e: {readonly user: string, readonly engineId: string, readonly engineIdB: Uint8Array, securityLevel: number}) => void ) ``` ## Remarks The GetUserSecurityLevel 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 [BadPacket](#snmptcptrapmgrbadpacket-event) 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 [GetUserPassword](#snmptcptrapmgrgetuserpassword-event) event will be fired to verify the authentication password. | | 2 | Authentication and Privacy. The message will be checked for a valid signature and the [GetUserPassword](#snmptcptrapmgrgetuserpassword-event) event will be fired twice: first to verify the authentication password, and then to verify the privacy password. | # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).HashPassword Event Fired before and after a password is hashed. ## Syntax ```text snmptcptrapmgr.on('HashPassword', listener: (e: {readonly password: string, readonly authAlgorithm: number, hash: string}) => void ) ``` ## 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 class 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 # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).InformRequest Event Fired when an InformRequest packet is received. ## Syntax ```text snmptcptrapmgr.on('InformRequest', listener: (e: {readonly requestId: number, readonly SNMPVersion: number, readonly community: string, readonly user: string, readonly securityLevel: number, readonly sourceAddress: string, readonly sourcePort: number, errorIndex: number, errorStatus: number, readonly errorDescription: string, respond: boolean}) => void ) ``` ## Remarks 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. The user in an InformRequest packet (SNMPv3) must be a valid user in the internal authentication cache (see the [AddUser](#snmptcptrapmgradduser-method) method and the [CheckEngine](#snmptcptrapmgrcheckengine-event) event for more information). If not, the request is rejected, and a [BadPacket](#snmptcptrapmgrbadpacket-event) event is fired before InformRequest is fired. The list of variables in the SNMP packet, including optional values and types, is provided through the [Objects](#snmptcptrapmgrobjects-property) collection. Each object is of type [SNMPObject](#snmpobject-type). This type describes the ObjectsOid, ObjectsObjectType, and ObjectsValue 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. 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. 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). # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).PacketTrace Event Fired for every packet sent or received. ## Syntax ```text snmptcptrapmgr.on('PacketTrace', listener: (e: {readonly packet: string, readonly packetB: Uint8Array, readonly direction: number, readonly packetAddress: string, readonly packetPort: number}) => void ) ``` ## Remarks The PacketTrace event shows all the packets sent or received by the class. *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. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).SSLClientAuthentication Event Fired when the client presents its credentials to the server. ## Syntax ```text snmptcptrapmgr.on('SSLClientAuthentication', listener: (e: {readonly remoteAddress: string, readonly remotePort: number, readonly certEncoded: string, readonly certEncodedB: Uint8Array, readonly certSubject: string, readonly certIssuer: string, readonly status: string, accept: boolean}) => void ) ``` ## Remarks This event fires when a client connects to the class and presents a certificate for authentication. The *Accept* parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not. When *Accept* is False, *Status* shows why the verification failed (otherwise, *Status* contains the string "OK"). *RemoteAddress* is the IP address of the connecting client. *RemotePort* is the source port of the connecting client. *CertEncoded* is the base64 encoded certificate presented by the client. *CertSubject* is the subject of the certificate presented by the client. *CertIssuer* is the subject of the issuer of the certificate presented by the client. *Status* is the status of the certificate. *Accept* defines whether the certificate is accepted. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).SSLStatus Event Shows the progress of the secure connection. ## Syntax ```text snmptcptrapmgr.on('SSLStatus', listener: (e: {readonly remoteAddress: string, readonly remotePort: number, readonly message: string}) => void ) ``` ## 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. # [SNMPTCPTrapMgr](#snmptcptrapmgr-class).Trap Event Fired when a SNMP trap packet is received. ## Syntax ```text snmptcptrapmgr.on('Trap', listener: (e: {readonly requestId: number, readonly SNMPVersion: number, readonly community: string, readonly user: string, readonly securityLevel: number, readonly trapOID: string, readonly timeStamp: number, readonly agentAddress: string, readonly sourceAddress: string, readonly sourcePort: number}) => void ) ``` ## 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). 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. The list of variables in the SNMP packet, including optional values and types, is provided through the [Objects](#snmptcptrapmgrobjects-property) collection. Each object is of type [SNMPObject](#snmpobject-type). This type describes the ObjectsOid, ObjectsObjectType, and ObjectsValue 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. 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 | # Certificate Type This is the digital certificate being used. ## Remarks This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates. The following fields are available: - [EffectiveDate](#Certificate_f_EffectiveDate) - [ExpirationDate](#Certificate_f_ExpirationDate) - [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage) - [Fingerprint](#Certificate_f_Fingerprint) - [FingerprintSHA1](#Certificate_f_FingerprintSHA1) - [FingerprintSHA256](#Certificate_f_FingerprintSHA256) - [Issuer](#Certificate_f_Issuer) - [KeyPassword](#Certificate_f_KeyPassword) - [PrivateKey](#Certificate_f_PrivateKey) - [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) - [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer) - [PublicKey](#Certificate_f_PublicKey) - [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm) - [PublicKeyLength](#Certificate_f_PublicKeyLength) - [SerialNumber](#Certificate_f_SerialNumber) - [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm) - [Store](#Certificate_f_Store) - [StorePassword](#Certificate_f_StorePassword) - [StoreType](#Certificate_f_StoreType) - [SubjectAltNames](#Certificate_f_SubjectAltNames) - [ThumbprintMD5](#Certificate_f_ThumbprintMD5) - [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1) - [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256) - [Usage](#Certificate_f_Usage) - [UsageFlags](#Certificate_f_UsageFlags) - [Version](#Certificate_f_Version) - [Subject](#Certificate_f_Subject) - [Encoded](#Certificate_f_Encoded) ## Fields **EffectiveDate** *string (read-only)* *Default Value: ""* 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. **ExpirationDate** *string (read-only)* *Default Value: ""* 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. **ExtendedKeyUsage** *string (read-only)* *Default Value: ""* A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **Fingerprint** *string (read-only)* *Default Value: ""* 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* **FingerprintSHA1** *string (read-only)* *Default Value: ""* 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* **FingerprintSHA256** *string (read-only)* *Default Value: ""* 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* **Issuer** *string (read-only)* *Default Value: ""* The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. **KeyPassword** *string* *Default Value: ""* The password for the certificate's private key (if any). Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the . This property can be used to read such password-protected private keys. NOTE: This property defaults to the value of . To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling . **PrivateKey** *string (read-only)* *Default Value: ""* The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The may be available but not exportable. In this case, returns an empty string. **PrivateKeyAvailable** *boolean (read-only)* *Default Value: False* Whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication). **PrivateKeyContainer** *string (read-only)* *Default Value: ""* The name of the container for the certificate (if available). This functionality is available only on Windows platforms. **PublicKey** *string (read-only)* *Default Value: ""* The public key of the certificate. The key is provided as PEM/Base64-encoded data. **PublicKeyAlgorithm** *string (read-only)* *Default Value: ""* 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. **PublicKeyLength** *number (read-only)* *Default Value: 0* The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **SerialNumber** *string (read-only)* *Default Value: ""* 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. **SignatureAlgorithm** *string (read-only)* *Default Value: ""* 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. **Store** *string* *Default Value: "MY"* The name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the 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). **StoreB** *Uint8Array* *Default Value: "MY"* The name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the 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). **StorePassword** *string* *Default Value: ""* If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. **StoreType** *CertStoreTypes* *Default Value: 0* The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```csharp 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); ``` ```csharp 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); ``` | | | | --- | --- | | 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](#certificate-type) object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) 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 [](#f_Store) and set [](#f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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. | **SubjectAltNames** *string (read-only)* *Default Value: ""* Comma-separated lists of alternative subject names for the certificate. **ThumbprintMD5** *string (read-only)* *Default Value: ""* 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. **ThumbprintSHA1** *string (read-only)* *Default Value: ""* 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. **ThumbprintSHA256** *string (read-only)* *Default Value: ""* 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. **Usage** *string (read-only)* *Default Value: ""* The text description of . 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. **UsageFlags** *number (read-only)* *Default Value: 0* The flags that show intended use for the certificate. The value of 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 property for a text representation of . This functionality currently is not available when the provider is OpenSSL. **Version** *string (read-only)* *Default Value: ""* The certificate's version number. The possible values are the strings "V1", "V2", and "V3". **Subject** *string* *Default Value: ""* 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. **Encoded** *string* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string. **EncodedB** *Uint8Array* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string. ## Constructors ```text public Certificate(); ``` Creates a instance whose properties can be set. ```text public Certificate(String certificateFile); ``` Opens * CertificateFile * and reads out the contents as an X.509 public key. ```text public Certificate(byte[] encoded); ``` Parses * Encoded * as an X.509 public key. ```text public Certificate(int storeType, String store, String storePassword, String subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, String store, String storePassword, String subject, String configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. * ConfigurationString * is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * cstUser * , * cstMachine * , * cstPublicKeyFile * , and * cstPFXFile * store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, String store, String storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. ```text public Certificate(int storeType, byte[] store, String storePassword, String subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. # SNMPObject Type The current SNMP object. ## Remarks This type defines an SNMP object. Each object has an , , and . These values are populated by the class when incoming packets are received. You may use these fields to define objects to be used in outgoing packets. The following fields are available: - [ObjectType](#SNMPObject_f_ObjectType) - [Oid](#SNMPObject_f_Oid) - [TypeString](#SNMPObject_f_TypeString) - [Value](#SNMPObject_f_Value) ## Fields **ObjectType** *SNMPObjectTypes* *Default Value: 5* The current object's type. The default type is NULL (5). The corresponding object id and value are specified by the and 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 class 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. | **Oid** *string* *Default Value: ""* 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 and properties. **Example** ```text SNMPControl.ObjCount = 1 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0" ``` **TypeString** *string (read-only)* *Default Value: ""* A string representation of the current object's . The corresponding object id and value are specified by the and properties. **Value** *string* *Default Value: ""* The current object's value. The corresponding object id and type are specified by the and properties. **Example** ```text SNMPControl.ObjCount = 1 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0" SNMPControl.ObjValue(0) = "New Value" ``` **ValueB** *Uint8Array* *Default Value: ""* The current object's value. The corresponding object id and type are specified by the and properties. **Example** ```text SNMPControl.ObjCount = 1 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0" SNMPControl.ObjValue(0) = "New Value" ``` ## Constructors ```text public SNMPObject(); ``` ```text public SNMPObject(String oid); ``` ```text public SNMPObject(String oid, byte[] value); ``` ```text public SNMPObject(String oid, byte[] value, int objectType); ``` # Config Settings (*class *ipworkssnmp.[snmptcptrapmgr](#snmptcptrapmgr-class)) The class 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 class, access to these *internal properties* is provided through the [Config](#snmptcptrapmgrconfig-method) 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 [GetUserPassword](#snmptcptrapmgrgetuserpassword-event). **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](SNMPMgr.md#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 class to decrypt packets logged in [PacketTrace](#snmptcptrapmgrpackettrace-event). 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 [GetUserPassword](#snmptcptrapmgrgetuserpassword-event). **ForceLocalPort**: Forces the class to bind to a specific port. The default value is True, which makes the class throw an error if [LocalPort](#snmptcptrapmgrlocalport-property) is busy. When [ForceLocalPort](#ForceLocalPort) is set to False and the port is busy, the class 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 class 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 class will use Timeout for establishing a connection and transmitting/receiving data. **EnableFallback**: **FallbackTimeout**: **FirewallAutoDetect**: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#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 classes that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#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](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the class . NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by classes 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](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the class . NOTE: This setting is provided for use by classes 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](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#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](#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](#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](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#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 class 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 [LocalHost](#snmptcptrapmgrlocalhost-property) 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 class initiate connections (or accept in the case of server classes) only through that interface. If the class is connected, the [LocalHost](#snmptcptrapmgrlocalhost-property) 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 class binds. This configuration setting must be set before a connection is attempted. It instructs the class 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 [LocalPort](#snmptcptrapmgrlocalport-property) after the connection is established. [LocalPort](#snmptcptrapmgrlocalport-property) 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](#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](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset. If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset. The minimum value for [MaxLineLength](#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](#KeepAliveTime) and [KeepAliveInterval](#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 class will use IPv4 exclusively. When set to *1*, the class will use IPv6 exclusively. To instruct the class 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 SSLProvider 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 [SSLStatus](#snmptcptrapmgrsslstatus-event) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if SSLProvider 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 class 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 class is the same. **SSLAcceptAnyServerCert**: Whether to trust any certificate presented by the server.This configuration setting disables all certificate verification when set to *True*. This configuration setting must be enabled to trust a self-signed certificate. It is not recommended to enable this configuration setting in a production environment. The default value is False. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When SSLProvider is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#snmptcptrapmgrsslcert-property) 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: ```text -----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----- ``` **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 [SSLStatus](#snmptcptrapmgrsslstatus-event) 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](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#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](#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 [SSLAuthenticateClients](#snmptcptrapmgrsslauthenticateclients-property) 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: ```text -----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 class will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#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 SSLProvider is set to *Platform* include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); ``` Possible values when SSLProvider 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 SSLProvider is set to *Internal*include the following: ```text 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 SSLProvider 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](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#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:** In the JavaScript edition, the platform implementation is used when TLS 1.3 is enabled and [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. **SSLEnabledProtocols: SSL2 and SSL3 Notes: ** SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider 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 SSLProvider 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 SSLServerAuthentication 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 SSLServerAuthentication event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication 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 class 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 class will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when SSLProvider 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: ```csharp 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: ```csharp 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: ```csharp 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: ```csharp 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. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **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: ```csharp 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](#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: ```text -----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 SSLProvider is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the class 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 class . The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp 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 SSLProvider 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](#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](#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 class 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 class 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 class 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 class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries. This setting is set to *false* by default on all platforms. # Trappable Errors (*class *ipworkssnmp.[snmptcptrapmgr](#snmptcptrapmgr-class)) ### 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 class 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. | ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the RemotePort at this time. A connection is in progress. | | 101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. | | 102 | The RemoteHost 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 [LocalPort](#snmptcptrapmgrlocalport-property) at this time. A connection is in progress. | | 107 | You cannot change the [LocalHost](#snmptcptrapmgrlocalhost-property) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | RemotePort cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the class 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). |