SNMPTCPTrapMgr Control
Properties Methods Events Config Settings Errors
The SNMPTCPTrapMgr control provides a TCP-based listening point for SNMP traps.
Syntax
SNMPTCPTrapMgr
Remarks
The SNMPTCPTrapMgr control provides a TCP-based listening point for SNMP traps and informs as specified by the SNMP RFCs. The control supports v1, v2c, and v3 traps.
The control 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 control is activated/deactivated by calling the Activate or Deactivate method. These methods enable or disable sending and receiving. The activation status can be found in the Active property.
Messages are received through events such as Trap, InformRequest, or DiscoveryRequest.
SNMP OIDs, types, and values are provided in the Objects collection of SNMP objects for both sent and received packets.
SNMPv3 USM security passwords are requested through the GetUserPassword 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, RemoveUser, ShowCache, ClearCache, AddEngine, and RemoveEngine methods are used to manage an internal authentication cache. This internal cache can be used as an alternative to the GetUserPassword 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 control with short descriptions. Click on the links for further details.
| AcceptData | Enables or disables data reception. |
| Active | Indicates whether the control is active. |
| LocalEngineId | The Engine Id (for SNMPv3). |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the control is bound to. |
| ObjCount | The number of records in the Obj arrays. |
| ObjType | The current object's type. |
| ObjId | The current object's id which is encoded as a string of numbers separated by periods. |
| ObjTypeString | A string representation of the current object's ObjectType . |
| ObjValue | The current object's value. |
| RequestId | The request-id to mark outgoing packets with. |
| SSLAuthenticateClients | If set to True, the server asks the client(s) for a certificate. |
| SSLCertEffectiveDate | The date on which this certificate becomes valid. |
| SSLCertExpirationDate | The date on which the certificate expires. |
| SSLCertExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
| SSLCertFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| SSLCertFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| SSLCertFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| SSLCertIssuer | The issuer of the certificate. |
| SSLCertPrivateKey | The private key of the certificate (if available). |
| SSLCertPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
| SSLCertPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
| SSLCertPublicKey | The public key of the certificate. |
| SSLCertPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
| SSLCertPublicKeyLength | The length of the certificate's public key (in bits). |
| SSLCertSerialNumber | The serial number of the certificate encoded as a string. |
| SSLCertSignatureAlgorithm | The text description of the certificate's signature algorithm. |
| SSLCertStore | The name of the certificate store for the client certificate. |
| SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| SSLCertStoreType | The type of certificate store for this certificate. |
| SSLCertSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
| SSLCertThumbprintMD5 | The MD5 hash of the certificate. |
| SSLCertThumbprintSHA1 | The SHA-1 hash of the certificate. |
| SSLCertThumbprintSHA256 | The SHA-256 hash of the certificate. |
| SSLCertUsage | The text description of UsageFlags . |
| SSLCertUsageFlags | The flags that show intended use for the certificate. |
| SSLCertVersion | The certificate's version number. |
| SSLCertSubject | The subject of the certificate used for client authentication. |
| SSLCertEncoded | The certificate (PEM/Base64 encoded). |
| SSLEnabled | Whether TLS/SSL is enabled. |
Method List
The following is the full list of the methods of the control with short descriptions. Click on the links for further details.
| Activate | Activates the control. |
| AddEngine | Adds the engine specified by EngineId to the internal authentication cache. |
| AddUser | Adds a user for the engine specified by EngineId to the internal authentication cache. |
| ClearCache | Clears the internal authentication database. |
| Config | Sets or retrieves a configuration setting. |
| Deactivate | Deactivates the control. |
| DoEvents | This method processes events from the internal message queue. |
| HashPasswords | Hashes all passwords in the cache. |
| RemoveEngine | Removes the engine specified by EngineId from the internal authentication cache. |
| RemoveUser | Removes the user specified by User of the engine specified by EngineId from the internal authentication cache. |
| Reset | Clears the object arrays. |
| ShowCache | Lists all entries in the internal user and engine database. |
| Value | Returns the value corresponding to an OID. |
Event List
The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.
| BadPacket | Fired for erroneous and/or malformed messages. |
| CacheEntry | Shows engines and users in the internal cache. |
| CheckEngine | Fired to check engine parameters (timeliness, etc.). |
| Connected | Fired immediately after a connection completes (or fails). |
| ConnectionStatus | This event is fired to indicate changes in the connection state. |
| Disconnected | Fired when a connection is closed. |
| DiscoveryRequest | Fired when an SNMPv3 discovery packet is received. |
| Error | Fired when information is available about errors during data delivery. |
| GetUserPassword | Retrieves a password associated with a user. |
| GetUserSecurityLevel | Sets the security level for an incoming packet. |
| HashPassword | Fired before and after a password is hashed. |
| InformRequest | Fired when an InformRequest packet is received. |
| PacketTrace | Fired for every packet sent or received. |
| SSLClientAuthentication | Fired when the client presents its credentials to the server. |
| SSLStatus | Shows the progress of the secure connection. |
| Trap | Fired when a SNMP trap packet is received. |
Config Settings
The following is a list of config settings for the control with short descriptions. Click on the links for further details.
| AuthenticationKey | The key to use for authentication. |
| CompatibilityMode | Whether to operate the control in a specific compatibility mode. |
| ContextEngineId | Sets the context engine id of the SNMP entity. |
| ContextName | Sets the context name of the SNMP entity. |
| DecryptLogPackets | Whether to decrypt logged packets. |
| EncryptionKey | The key to use for encryption. |
| ForceLocalPort | Forces the control to bind to a specific port. |
| IncomingContextEngineId | The engine Id of the received packet. |
| IncomingContextName | The context name of the received packet. |
| ShowCacheForUser | Shows the cache entry for a single user. |
| SourceAddress | The source address of the received packet. |
| SourcePort | The source port of the received packet. |
| TimeWindow | The time window used for SNMPv3 timeliness checking (authentication). |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the control whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the control binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseIPv6 | Whether to use IPv6. |
| LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCACerts | A newline separated list of CA certificates to be included when performing an SSL handshake. |
| SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
| SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
| SSLNegotiatedCipher | Returns the negotiated cipher suite. |
| SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
| SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
| SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
| SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
| SSLNegotiatedVersion | Returns the negotiated protocol version. |
| SSLSecurityFlags | Flags that control certificate verification. |
| SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| MaskSensitiveData | Whether sensitive data is masked in log messages. |
| UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AcceptData Property (SNMPTCPTrapMgr Control)
Enables or disables data reception.
Syntax
snmptcptrapmgrcontrol.AcceptData[=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 not available at design time.
Data Type
Boolean
Active Property (SNMPTCPTrapMgr Control)
Indicates whether the control is active.
Syntax
snmptcptrapmgrcontrol.Active[=boolean]
Default Value
False
Remarks
This property indicates whether the control is currently active and can send or receive data.
The control will be automatically activated if it is not already and you attempt to perform an operation which requires the control to be active.
Use the Activate and Deactivate methods to control whether the control is active.
This property is not available at design time.
Data Type
Boolean
LocalEngineId Property (SNMPTCPTrapMgr Control)
The Engine Id (for SNMPv3).
Syntax
snmptcptrapmgrcontrol.LocalEngineId[=string]
Default Value
""
Remarks
This property is necessary for properly handling InformRequest packets.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .LocalEngineIdB.
Data Type
Binary String
LocalHost Property (SNMPTCPTrapMgr Control)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
snmptcptrapmgrcontrol.LocalHost[=string]
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 control initiate connections (or accept in the case of server controls) 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 control 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.
Data Type
String
LocalPort Property (SNMPTCPTrapMgr Control)
The port in the local host where the control is bound to.
Syntax
snmptcptrapmgrcontrol.LocalPort[=integer]
Default Value
162
Remarks
The LocalPort property must be set before the control is activated (Active is set to True). It instructs the control to bind to a specific port (or communication endpoint) in the local machine.
The default port is 162 (standard trap port). If that port is busy, an error will be returned, unless the ForceLocalPort configuration setting is set to False, in which case a random port will be chosen.
LocalPort cannot be changed once the control is Active. Any attempt to set the LocalPort property when the control is Active will generate an error.
Note: on macOS and iOS, root permissions are required to set LocalPort to any value below 1024.
Data Type
Integer
ObjCount Property (SNMPTCPTrapMgr Control)
The number of records in the Obj arrays.
Syntax
snmptcptrapmgrcontrol.ObjCount[=integer]
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ObjCount - 1.This property is not available at design time.
Data Type
Integer
ObjType Property (SNMPTCPTrapMgr Control)
The current object's type.
Syntax
snmptcptrapmgrcontrol.ObjType(ObjIndex)[=integer]
Possible Values
otInteger(2), otOctetString(4), otNull(5), otObjectId(6), otIPAddress(64), otCounter32(65), otGauge32(66), otTimeTicks(67), otOpaque(68), otNSAP(69), otCounter64(70), otUnsignedInteger32(71), otNoSuchObject(128), otNoSuchInstance(129), otEndOfMibView(130)
Default Value
5
Remarks
The current object's type. The default type is NULL (5).
The corresponding object id and value are specified by the ObjOid and ObjValue 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 control also supports the following artificial object values used to designate error conditions:
| otNoSuchObject (128) | No such object error. |
| otNoSuchInstance (129) | No such instance error. |
| otEndOfMibView (130) | End of MIB View error. |
The ObjIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjCount property.
This property is not available at design time.
Data Type
Integer
ObjId Property (SNMPTCPTrapMgr Control)
The current object's id which is encoded as a string of numbers separated by periods.
Syntax
snmptcptrapmgrcontrol.ObjId(ObjIndex)[=string]
Default Value
""
Remarks
The current object's id which is encoded as a string of numbers separated by periods. For instance: "1.3.6.1.2.1.1.1.0" (OID for "system description").
The corresponding object type and value (if any) are specified by the ObjectType and ObjValue properties.
Example
SNMPControl.ObjCount = 1
SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0"
The ObjIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjCount property.
This property is not available at design time.
Data Type
String
ObjTypeString Property (SNMPTCPTrapMgr Control)
A string representation of the current object's ObjectType .
Syntax
snmptcptrapmgrcontrol.ObjTypeString(ObjIndex)
Default Value
""
Remarks
A string representation of the current object's ObjectType.
The corresponding object id and value are specified by the ObjOid and ObjValue properties.
The ObjIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjCount property.
This property is read-only and not available at design time.
Data Type
String
ObjValue Property (SNMPTCPTrapMgr Control)
The current object's value.
Syntax
snmptcptrapmgrcontrol.ObjValue(ObjIndex)[=string]
Default Value
""
Remarks
The current object's value. The corresponding object id and type are specified by the ObjOid and ObjectType properties.
Example
SNMPControl.ObjCount = 1
SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0"
SNMPControl.ObjValue(0) = "New Value"
The ObjIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjCount property.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .ObjValueB.
This property is not available at design time.
Data Type
Binary String
RequestId Property (SNMPTCPTrapMgr Control)
The request-id to mark outgoing packets with.
Syntax
snmptcptrapmgrcontrol.RequestId[=integer]
Default Value
1
Remarks
If a custom value is needed for RequestId, the property must be set before sending the request. The control increments RequestId automatically after sending each packet.
This property is not available at design time.
Data Type
Integer
SSLAuthenticateClients Property (SNMPTCPTrapMgr Control)
If set to True, the server asks the client(s) for a certificate.
Syntax
snmptcptrapmgrcontrol.SSLAuthenticateClients[=boolean]
Default Value
False
Remarks
This property is used in conjunction with the SSLClientAuthentication event. Please refer to the documentation of the SSLClientAuthentication event for details.
Data Type
Boolean
SSLCertEffectiveDate Property (SNMPTCPTrapMgr Control)
The date on which this certificate becomes valid.
Syntax
snmptcptrapmgrcontrol.SSLCertEffectiveDate
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLCertExpirationDate Property (SNMPTCPTrapMgr Control)
The date on which the certificate expires.
Syntax
snmptcptrapmgrcontrol.SSLCertExpirationDate
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLCertExtendedKeyUsage Property (SNMPTCPTrapMgr Control)
A comma-delimited list of extended key usage identifiers.
Syntax
snmptcptrapmgrcontrol.SSLCertExtendedKeyUsage
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLCertFingerprint Property (SNMPTCPTrapMgr Control)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
snmptcptrapmgrcontrol.SSLCertFingerprint
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSLCertFingerprintSHA1 Property (SNMPTCPTrapMgr Control)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
snmptcptrapmgrcontrol.SSLCertFingerprintSHA1
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSLCertFingerprintSHA256 Property (SNMPTCPTrapMgr Control)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
snmptcptrapmgrcontrol.SSLCertFingerprintSHA256
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSLCertIssuer Property (SNMPTCPTrapMgr Control)
The issuer of the certificate.
Syntax
snmptcptrapmgrcontrol.SSLCertIssuer
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLCertPrivateKey Property (SNMPTCPTrapMgr Control)
The private key of the certificate (if available).
Syntax
snmptcptrapmgrcontrol.SSLCertPrivateKey
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLCertPrivateKeyAvailable Property (SNMPTCPTrapMgr Control)
Whether a PrivateKey is available for the selected certificate.
Syntax
snmptcptrapmgrcontrol.SSLCertPrivateKeyAvailable
Default Value
False
Remarks
Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLCertPrivateKeyContainer Property (SNMPTCPTrapMgr Control)
The name of the PrivateKey container for the certificate (if available).
Syntax
snmptcptrapmgrcontrol.SSLCertPrivateKeyContainer
Default Value
""
Remarks
The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLCertPublicKey Property (SNMPTCPTrapMgr Control)
The public key of the certificate.
Syntax
snmptcptrapmgrcontrol.SSLCertPublicKey
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLCertPublicKeyAlgorithm Property (SNMPTCPTrapMgr Control)
The textual description of the certificate's public key algorithm.
Syntax
snmptcptrapmgrcontrol.SSLCertPublicKeyAlgorithm
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLCertPublicKeyLength Property (SNMPTCPTrapMgr Control)
The length of the certificate's public key (in bits).
Syntax
snmptcptrapmgrcontrol.SSLCertPublicKeyLength
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLCertSerialNumber Property (SNMPTCPTrapMgr Control)
The serial number of the certificate encoded as a string.
Syntax
snmptcptrapmgrcontrol.SSLCertSerialNumber
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSLCertSignatureAlgorithm Property (SNMPTCPTrapMgr Control)
The text description of the certificate's signature algorithm.
Syntax
snmptcptrapmgrcontrol.SSLCertSignatureAlgorithm
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLCertStore Property (SNMPTCPTrapMgr Control)
The name of the certificate store for the client certificate.
Syntax
snmptcptrapmgrcontrol.SSLCertStore[=string]
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject 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).
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.
Data Type
Binary String
SSLCertStorePassword Property (SNMPTCPTrapMgr Control)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
snmptcptrapmgrcontrol.SSLCertStorePassword[=string]
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLCertStoreType Property (SNMPTCPTrapMgr Control)
The type of certificate store for this certificate.
Syntax
snmptcptrapmgrcontrol.SSLCertStoreType[=integer]
Possible Values
cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)
Default Value
0
Remarks
The type of certificate store for this certificate.
The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr control. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
Integer
SSLCertSubjectAltNames Property (SNMPTCPTrapMgr Control)
Comma-separated lists of alternative subject names for the certificate.
Syntax
snmptcptrapmgrcontrol.SSLCertSubjectAltNames
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLCertThumbprintMD5 Property (SNMPTCPTrapMgr Control)
The MD5 hash of the certificate.
Syntax
snmptcptrapmgrcontrol.SSLCertThumbprintMD5
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA1 Property (SNMPTCPTrapMgr Control)
The SHA-1 hash of the certificate.
Syntax
snmptcptrapmgrcontrol.SSLCertThumbprintSHA1
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA256 Property (SNMPTCPTrapMgr Control)
The SHA-256 hash of the certificate.
Syntax
snmptcptrapmgrcontrol.SSLCertThumbprintSHA256
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertUsage Property (SNMPTCPTrapMgr Control)
The text description of UsageFlags .
Syntax
snmptcptrapmgrcontrol.SSLCertUsage
Default Value
""
Remarks
The text description of SSLCertUsageFlags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSLCertUsageFlags Property (SNMPTCPTrapMgr Control)
The flags that show intended use for the certificate.
Syntax
snmptcptrapmgrcontrol.SSLCertUsageFlags
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of SSLCertUsageFlags 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 SSLCertUsage property for a text representation of SSLCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLCertVersion Property (SNMPTCPTrapMgr Control)
The certificate's version number.
Syntax
snmptcptrapmgrcontrol.SSLCertVersion
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLCertSubject Property (SNMPTCPTrapMgr Control)
The subject of the certificate used for client authentication.
Syntax
snmptcptrapmgrcontrol.SSLCertSubject[=string]
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
SSLCertEncoded Property (SNMPTCPTrapMgr Control)
The certificate (PEM/Base64 encoded).
Syntax
snmptcptrapmgrcontrol.SSLCertEncoded[=string]
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.
This property is not available at design time.
Data Type
Binary String
SSLEnabled Property (SNMPTCPTrapMgr Control)
Whether TLS/SSL is enabled.
Syntax
snmptcptrapmgrcontrol.SSLEnabled[=boolean]
Default Value
False
Remarks
This setting specifies whether TLS/SSL is enabled in the control. When False (default) the control operates in plaintext mode. When True TLS/SSL is enabled.
This property is not available at design time.
Data Type
Boolean
Activate Method (SNMPTCPTrapMgr Control)
Activates the control.
Syntax
snmptcptrapmgrcontrol.Activate
Remarks
This method activates the component and will allow it to send or receive data.
The control will be automatically activated if it is not already and you attempt to perform an operation which requires the control to be active.
Note: Use the Active property to check whether the component is active.
AddEngine Method (SNMPTCPTrapMgr Control)
Adds the engine specified by EngineId to the internal authentication cache.
Syntax
snmptcptrapmgrcontrol.AddEngine EngineId, EngineBoots, EngineTime
Remarks
The internal authentication cache can be used as an alternative to the GetUserPassword event, automatically checking the cache against the security parameters provided in the request signature.
The ShowCache method is used to show the contents of the internal authentication cache.
The ClearCache method can be used to completely clear the cache.
If the engine parameters are unknown, the SNMPMgr control'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.
AddUser Method (SNMPTCPTrapMgr Control)
Adds a user for the engine specified by EngineId to the internal authentication cache.
Syntax
snmptcptrapmgrcontrol.AddUser User, EngineId, AuthenticationProtocol, AuthenticationPassword, EncryptionAlgorithm, EncryptionPassword
Remarks
The internal authentication cache can be used as an alternative to the GetUserPassword event, automatically checking the cache against the security parameters provided in the request signature.
The ShowCache method is used to show the contents of the internal authentication cache.
The ClearCache 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. |
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. |
ClearCache Method (SNMPTCPTrapMgr Control)
Clears the internal authentication database.
Syntax
snmptcptrapmgrcontrol.ClearCache
Remarks
All user and engine records are removed from the internal authentication cache as a result of this call.
Config Method (SNMPTCPTrapMgr Control)
Sets or retrieves a configuration setting.
Syntax
snmptcptrapmgrcontrol.Config ConfigurationString
Remarks
Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Deactivate Method (SNMPTCPTrapMgr Control)
Deactivates the control.
Syntax
snmptcptrapmgrcontrol.Deactivate
Remarks
This method deactivates the component and will prohibit it from sending and receiving data.
Note: Use the Active property to check whether the component is active.
DoEvents Method (SNMPTCPTrapMgr Control)
This method processes events from the internal message queue.
Syntax
snmptcptrapmgrcontrol.DoEvents
Remarks
When DoEvents is called, the control processes any available events. If no events are available, it waits for a preset period of time, and then returns.
HashPasswords Method (SNMPTCPTrapMgr Control)
Hashes all passwords in the cache.
Syntax
snmptcptrapmgrcontrol.HashPasswords
Remarks
Forces computation of all passwords hashes in the cache. Used together with the HashPassword event to enable implementations of external password hash storage.
RemoveEngine Method (SNMPTCPTrapMgr Control)
Removes the engine specified by EngineId from the internal authentication cache.
Syntax
snmptcptrapmgrcontrol.RemoveEngine EngineId
Remarks
The internal authentication cache can be used as an alternative to the GetUserPassword event, automatically checking the cache against the security parameters provided in the request signature.
The ShowCache method is used to show the contents of the internal authentication cache.
The ClearCache method can be used to completely clear the cache.
RemoveUser Method (SNMPTCPTrapMgr Control)
Removes the user specified by User of the engine specified by EngineId from the internal authentication cache.
Syntax
snmptcptrapmgrcontrol.RemoveUser User, EngineId
Remarks
The internal authentication cache can be used as an alternative to the GetUserPassword event, automatically checking the cache against the security parameters provided in the request signature.
The ShowCache method is used to show the contents of the internal authentication cache.
The ClearCache method can be used to completely clear the cache.
Reset Method (SNMPTCPTrapMgr Control)
Clears the object arrays.
Syntax
snmptcptrapmgrcontrol.Reset
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).
ShowCache Method (SNMPTCPTrapMgr Control)
Lists all entries in the internal user and engine database.
Syntax
snmptcptrapmgrcontrol.ShowCache
Remarks
A CacheEntry event is fired for every record in the database.
Value Method (SNMPTCPTrapMgr Control)
Returns the value corresponding to an OID.
Syntax
snmptcptrapmgrcontrol.Value OID
Remarks
If the OID does not exist in the Objects collection, a trappable error is generated.
Please refer to the SNMPObject type for more information.
BadPacket Event (SNMPTCPTrapMgr Control)
Fired for erroneous and/or malformed messages.
Syntax
Sub snmptcptrapmgrcontrol_BadPacket(Packet As String, SourceAddress As String, SourcePort As Integer, ErrorCode As Integer, ErrorDescription As String, Report As Boolean)
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 event for more information concerning SNMPv3 authentication.
CacheEntry Event (SNMPTCPTrapMgr Control)
Shows engines and users in the internal cache.
Syntax
Sub snmptcptrapmgrcontrol_CacheEntry(EngineId As String, EngineBoots As Integer, EngineTime As Integer, User As String, AuthenticationProtocol As String, AuthenticationPassword As String, EncryptionAlgorithm As String, EncryptionPassword As String)
Remarks
CacheEntry events are triggered by a call to ShowCache. 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.
CheckEngine Event (SNMPTCPTrapMgr Control)
Fired to check engine parameters (timeliness, etc.).
Syntax
Sub snmptcptrapmgrcontrol_CheckEngine(EngineId As String, EngineBoots As Integer, EngineTime As Integer, User As String, SecurityLevel As Integer, RemoteAddress As String, RemotePort As Integer, IsNew As Boolean, Accept As Boolean)
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 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 control (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.
Connected Event (SNMPTCPTrapMgr Control)
Fired immediately after a connection completes (or fails).
Syntax
Sub snmptcptrapmgrcontrol_Connected(RemoteAddress As String, RemotePort As Integer, StatusCode As Integer, Description As String)
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.
ConnectionStatus Event (SNMPTCPTrapMgr Control)
This event is fired to indicate changes in the connection state.
Syntax
Sub snmptcptrapmgrcontrol_ConnectionStatus(ConnectionEvent As String, StatusCode As Integer, Description As String)
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. |
Description contains a description of this code. The value of StatusCode is equal to the value of the error. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.
Disconnected Event (SNMPTCPTrapMgr Control)
Fired when a connection is closed.
Syntax
Sub snmptcptrapmgrcontrol_Disconnected(RemoteAddress As String, RemotePort As Integer, StatusCode As Integer, Description As String)
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.
DiscoveryRequest Event (SNMPTCPTrapMgr Control)
Fired when an SNMPv3 discovery packet is received.
Syntax
Sub snmptcptrapmgrcontrol_DiscoveryRequest(EngineId As String, EngineBoots As Integer, EngineTime As Integer, User As String, SecurityLevel As Integer, SourceAddress As String, SourcePort As Integer, Respond As Boolean)
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. 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).
Error Event (SNMPTCPTrapMgr Control)
Fired when information is available about errors during data delivery.
Syntax
Sub snmptcptrapmgrcontrol_Error(ErrorCode As Integer, Description As String)
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.
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 section.
GetUserPassword Event (SNMPTCPTrapMgr Control)
Retrieves a password associated with a user.
Syntax
Sub snmptcptrapmgrcontrol_GetUserPassword(PasswordType As Integer, User As String, EngineId As String, Password As String, Algorithm As Integer)
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 |
| 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 event will be fired, at which point you can decide whether to report the error to the client (see the description of the BadPacket 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 event being fired, at which point you can decide whether to report the error to the client or not.
GetUserSecurityLevel Event (SNMPTCPTrapMgr Control)
Sets the security level for an incoming packet.
Syntax
Sub snmptcptrapmgrcontrol_GetUserSecurityLevel(User As String, EngineId As String, SecurityLevel As Integer)
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 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 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 event will be fired twice: first to verify the authentication password, and then to verify the privacy password. |
HashPassword Event (SNMPTCPTrapMgr Control)
Fired before and after a password is hashed.
Syntax
Sub snmptcptrapmgrcontrol_HashPassword(Password As String, AuthAlgorithm As Integer, Hash As String)
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 control 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
InformRequest Event (SNMPTCPTrapMgr Control)
Fired when an InformRequest packet is received.
Syntax
Sub snmptcptrapmgrcontrol_InformRequest(RequestId As Integer, SNMPVersion As Integer, Community As String, User As String, SecurityLevel As Integer, SourceAddress As String, SourcePort As Integer, ErrorIndex As Integer, ErrorStatus As Integer, ErrorDescription As String, Respond As Boolean)
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 method and the CheckEngine event for more information). If not, the request is rejected, and a BadPacket 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 collection. Each object is of type SNMPObject. This type describes the ObjId, ObjType, and ObjValue 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. |
Variable indexes start with 0. ErrorIndex has no meaning when ErrorStatus is 0 (no error).
PacketTrace Event (SNMPTCPTrapMgr Control)
Fired for every packet sent or received.
Syntax
Sub snmptcptrapmgrcontrol_PacketTrace(Packet As String, Direction As Integer, PacketAddress As String, PacketPort As Integer)
Remarks
The PacketTrace event shows all the packets sent or received by the control.
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.
SSLClientAuthentication Event (SNMPTCPTrapMgr Control)
Fired when the client presents its credentials to the server.
Syntax
Sub snmptcptrapmgrcontrol_SSLClientAuthentication(RemoteAddress As String, RemotePort As Integer, CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)
Remarks
This event fires when a client connects to the control and presents a certificate for authentication. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK").
RemoteAddress is the IP address of the connecting client.
RemotePort is the source port of the connecting client.
CertEncoded is the base64 encoded certificate presented by the client.
CertSubject is the subject of the certificate presented by the client.
CertIssuer is the subject of the issuer of the certificate presented by the client.
Status is the stauts of the certificate.
Accept defines whether the certificate is accepted.
SSLStatus Event (SNMPTCPTrapMgr Control)
Shows the progress of the secure connection.
Syntax
Sub snmptcptrapmgrcontrol_SSLStatus(RemoteAddress As String, RemotePort As Integer, Message As String)
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.
Trap Event (SNMPTCPTrapMgr Control)
Fired when a SNMP trap packet is received.
Syntax
Sub snmptcptrapmgrcontrol_Trap(RequestId As Integer, SNMPVersion As Integer, Community As String, User As String, SecurityLevel As Integer, TrapOID As String, TimeStamp As Long64, AgentAddress As String, SourceAddress As String, SourcePort As Integer)
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 collection. Each object is of type SNMPObject. This type describes the ObjId, ObjType, and ObjValue 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 |
Config Settings (SNMPTCPTrapMgr Control)
The control 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 control, access to these internal properties is provided through the Config method.SNMPTCPTrapMgr Config Settings
| 0 (default) | Component operates normally for greatest compatibility. |
| 1 | Component uses SNMP4j-compatible encryption (AES192 and AES256). |
| 2 | Component automatically detects whether to use SNMP4j-compatible encryption (AES192 and AES256). Note: This option is only applicable when receiving packets. If you are using SNMPMgr or sending secure traps, you will need to select either 0 or 1. |
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by controls that do not directly expose Firewall properties.
Note: This setting is provided for use by controls that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by controls that do not directly expose Firewall properties.
| 0 | No firewall (default setting). |
| 1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
| 2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
| 3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
| 10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by controls that do not directly expose Firewall properties.
Note: This setting is provided for use by controls that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the control 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.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.
If the control is connected, the LocalHost 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).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort 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.
If an EOL string is found in the input stream before 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 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 is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
| 0 | IPv4 only |
| 1 | IPv6 only |
| 2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the SSLStatus 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.
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.
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.
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".
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.
If set to True, the control 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 control is the same.
-----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-----
When set to 0 (default), the CRL check will not be performed by the control. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the control will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
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 event.
Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the control will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when 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
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), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
| TLS1.3 | 12288 (Hex 3000) |
| TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
| TLS1.1 | 768 (Hex 300) (Default - Client) |
| TLS1 | 192 (Hex C0) (Default - Client) |
| SSL3 | 48 (Hex 30) |
| SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the control will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the control 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.
This configuration setting is applicable only when SSLProvider is set to Internal.
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.
When set, the control 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 control will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
| 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.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the control 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 control fails with an error.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
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)
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"
- "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 ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
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)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control 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
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 |
| 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 |
This setting only works on these controls: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to tells the control to use the internal implementation instead of using the system security libraries.
This setting is set to by default on all platforms.
Trappable Errors (SNMPTCPTrapMgr Control)
SNMPTCPTrapMgr Errors
| 20302 | Bad Object Index. |
| 20303 | Value exceeds maximum number of objects allowed. |
| 20304 | The value must be an IP address in dotted format. |
| 20306 | Unsupported SNMP version. |
| 20307 | Unknown PDU type. |
| 20308 | The control is busy performing the current action. |
| 20309 | Verification failed. |
| 20310 | Missing password for Verification. |
| 20311 | Missing signature. |
| 20312 | Missing remote time. |
| 20313 | Missing timeout value. |
| 20314 | Decryption Failed. |
| 20315 | Missing password for decryption. |
| 20316 | Not encrypted. |
| 20317 | Security model not supported. |
| 20318 | Defective packet |
| 20319 | Not from bound point. |
| 20320 | Operation not permitted in current role. |
| 20321 | Bad packet. |
| 20322 | Message not authenticated. |
| 20323 | No such oid. |
| 20324 | Missing privacy parameter. |
| 20325 | Bad engine id. |
| 20326 | Bad time frame. |
| 20327 | Bad user name. |
| 20328 | Security level was not accepted. |
| 20329 | Discovery failed. |
| 20330 | Incorrect key length. |
The control may also return one of the following error codes, which are inherited from other controls.
TCPClient Errors
| 20101 | You cannot change the RemotePort at this time. A connection is in progress. |
| 20102 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
| 20103 | The RemoteHost address is invalid (0.0.0.0). |
| 20105 | Already connected. If you want to reconnect, close the current connection first. |
| 20107 | You cannot change the LocalPort at this time. A connection is in progress. |
| 20108 | You cannot change the LocalHost at this time. A connection is in progress. |
| 20113 | You cannot change MaxLineLength at this time. A connection is in progress. |
| 20117 | RemotePort cannot be zero. Please specify a valid service port number. |
| 20118 | You cannot change the UseConnection option while the control is active. |
| 20136 | Operation would block. |
| 20202 | Timeout. |
| 20212 | Action impossible in control's present state. |
| 20213 | Action impossible while not connected. |
| 20214 | Action impossible while listening. |
| 20302 | Timeout. |
| 20303 | Could not open file. |
| 20435 | Unable to convert string to selected CodePage. |
| 21106 | Already connecting. If you want to reconnect, close the current connection first. |
| 21118 | You need to connect first. |
| 21120 | You cannot change the LocalHost at this time. A connection is in progress. |
| 21121 | Connection dropped by remote host. |
SSL Errors
| 20271 | Cannot load specified security library. |
| 20272 | Cannot open certificate store. |
| 20273 | Cannot find specified certificate. |
| 20274 | Cannot acquire security credentials. |
| 20275 | Cannot find certificate chain. |
| 20276 | Cannot verify certificate chain. |
| 20277 | Error during handshake. |
| 20281 | Error verifying certificate. |
| 20282 | Could not find client certificate. |
| 20283 | Could not find server certificate. |
| 20284 | Error encrypting data. |
| 20285 | Error decrypting data. |
TCP/IP Errors
| 25005 | [10004] Interrupted system call. |
| 25010 | [10009] Bad file number. |
| 25014 | [10013] Access denied. |
| 25015 | [10014] Bad address. |
| 25023 | [10022] Invalid argument. |
| 25025 | [10024] Too many open files. |
| 25036 | [10035] Operation would block. |
| 25037 | [10036] Operation now in progress. |
| 25038 | [10037] Operation already in progress. |
| 25039 | [10038] Socket operation on nonsocket. |
| 25040 | [10039] Destination address required. |
| 25041 | [10040] Message is too long. |
| 25042 | [10041] Protocol wrong type for socket. |
| 25043 | [10042] Bad protocol option. |
| 25044 | [10043] Protocol is not supported. |
| 25045 | [10044] Socket type is not supported. |
| 25046 | [10045] Operation is not supported on socket. |
| 25047 | [10046] Protocol family is not supported. |
| 25048 | [10047] Address family is not supported by protocol family. |
| 25049 | [10048] Address already in use. |
| 25050 | [10049] Cannot assign requested address. |
| 25051 | [10050] Network is down. |
| 25052 | [10051] Network is unreachable. |
| 25053 | [10052] Net dropped connection or reset. |
| 25054 | [10053] Software caused connection abort. |
| 25055 | [10054] Connection reset by peer. |
| 25056 | [10055] No buffer space available. |
| 25057 | [10056] Socket is already connected. |
| 25058 | [10057] Socket is not connected. |
| 25059 | [10058] Cannot send after socket shutdown. |
| 25060 | [10059] Too many references, cannot splice. |
| 25061 | [10060] Connection timed out. |
| 25062 | [10061] Connection refused. |
| 25063 | [10062] Too many levels of symbolic links. |
| 25064 | [10063] File name is too long. |
| 25065 | [10064] Host is down. |
| 25066 | [10065] No route to host. |
| 25067 | [10066] Directory is not empty |
| 25068 | [10067] Too many processes. |
| 25069 | [10068] Too many users. |
| 25070 | [10069] Disc Quota Exceeded. |
| 25071 | [10070] Stale NFS file handle. |
| 25072 | [10071] Too many levels of remote in path. |
| 25092 | [10091] Network subsystem is unavailable. |
| 25093 | [10092] WINSOCK DLL Version out of range. |
| 25094 | [10093] Winsock is not loaded yet. |
| 26002 | [11001] Host not found. |
| 26003 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
| 26004 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
| 26005 | [11004] Valid name, no data record (check DNS setup). |