SNMPAgent Class
Properties Methods Events Config Settings Errors
The SNMPAgent class is used to implement UDP-based SNMP Agent Applications.
Syntax
SNMPAgent
Remarks
The SNMPAgent class implements a UDP-based standard SNMP Agent as specified in the SNMP RFCs. The class supports SNMP v1, v2c, and v3.
SNMP over DTLS is also supported when SSLEnabled is set to True. When acting as a client, the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the DTLS handshake. Additional SSL-related settings are also supported through the Config method. When acting as a server, the SSLCert properties are used to select a certificate for the server. When client authentication is required, the SSLAuthenticateClients property can be set to True and the SSLClientAuthentication event can be used to examine client credentials.
The class provides both encoding/decoding and transport capabilities, making the task of developing a custom SNMP agent as simple as setting a few key properties and handling a few events. SNMP data such as SNMP object id-s (OID-s) are exchanged as text strings, thus further simplifying the task of handling them.
The class is activated/deactivated by calling the Activate or Deactivate method. These methods enable or disable sending and receiving. The activation status can be found in the Active property.
The class operates asynchronously. Requests are received through events such as GetRequest, GetBulkRequest, GetNextRequest, etc. and the corresponding responses are automatically sent when the events return. Traps are sent through the SendTrap method.
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 SendSecureTrap method is used to send authenticated (secure) SNMPv3 traps.
The AddUser, RemoveUser, ShowCache, and ClearCache 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.
SNMP OIDs, types, and values are provided in the Objects collection of SNMP objects for both sent and received packets.
Other packet information is provided through corresponding event parameters, such as Community, or RequestId.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
AcceptData | Enables or disables data reception. |
Active | Indicates whether the class is active. |
LocalEngineId | The Engine Id of the SNMP Agent. |
LocalHost | This property includes 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 class listens. |
Objects | The objects in the current request. |
RequestId | The request-id to mark outgoing packets with. |
SNMPVersion | Version of SNMP used for outgoing requests (traps). |
SSLAcceptServerCert | This property instructs the class to unconditionally accept the server certificate that matches the supplied certificate. |
SSLAuthenticateClients | If set to True, the server asks the client(s) for a certificate. |
SSLCert | This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation. |
SSLEnabled | Whether DTLS is enabled. |
SSLServerCert | This property includes the server certificate for the last established connection. |
SysUpTime | Time passed since the agent was initialized (in hundredths of a second). |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Activate | Activates the class. |
AddUser | Adds a user to the internal authentication cache. |
ClearCache | Clears the internal authentication database. |
Config | Sets or retrieves a configuration setting. |
Deactivate | Deactivates the class. |
DoEvents | This method processes events from the internal message queue. |
HashPasswords | Hashes all passwords in the cache. |
RemoveUser | Removes the user specified by User from the internal authentication cache. |
Reset | Clears the object arrays. |
SendResponse | Sends a response packet to a Get, Get-Next, Get-Bulk, or Set request. |
SendSecureResponse | Sends an authenticated and/or encrypted SNMPv3 response. |
SendSecureTrap | Sends an authenticated and/or encrypted SNMPv3 trap. |
SendTrap | Sends an SNMP Trap. |
ShowCache | Lists all entries in the internal user authentication cache. |
Value | Returns the value corresponding to an OID. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
BadPacket | Fired for erroneous and/or malformed messages. |
CacheEntry | Shows in the internal cache. |
Connected | Fired immediately after a connection completes (or fails). |
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. |
GetBulkRequest | Fired when a GetBulkRequest packet is received. |
GetNextRequest | Fired when a GetNextRequest packet is received. |
GetRequest | Fired when a GetRequest packet is received. |
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. |
PacketTrace | Fired for every packet sent or received. |
ReadyToSend | Fired when the class is ready to send data. |
Report | Fired when a Report packet is received. |
SetRequest | Fired when a SetRequest packet is received. |
SSLClientAuthentication | Fired when the client presents its credentials to the server. |
SSLServerAuthentication | Fires when connecting to the server. |
SSLStatus | Shows the progress of the secure connection. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AuthenticationKey | The key to use for authentication. |
CompatibilityMode | Whether to operate the class in a specific compatibility mode. |
ContextEngineId | Sets the context engine id of the SNMP entity. |
ContextName | Sets the context name of the SNMP entity. |
DataToSend | Sends a raw packet. |
DecryptLogPackets | Whether to decrypt logged packets. |
EncryptionKey | The key to use for encryption. |
ForceLocalPort | Forces the class to bind to a specific port. |
IgnoreDiscoveryRequestType | Treats other request types as discovery requests. |
IncomingContextEngineId | The engine Id of the received packet. |
IncomingContextName | The context name of the received packet. |
MsgMaxSize | The maximum supported message size. |
RespondFromDestIP | Whether to respond from the IP address that the request was sent to. |
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). |
TrapAgentAddress | The address of the object generating the trap. |
TrapCommunity | The value of the Community parameter for SNMP traps. |
TrapEnterprise | The type of the object generating the trap. |
TrapPort | The port where SNMP traps are sent. |
CaptureIPPacketInfo | Used to capture the packet information. |
DelayHostResolution | Whether the hostname is resolved when RemoteHost is set. |
DestinationAddress | Used to get the destination address from the packet information. |
DontFragment | Used to set the Don't Fragment flag of outgoing packets. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxPacketSize | The maximum length of the packets that can be received. |
QOSDSCPValue | Used to specify an arbitrary QOS/DSCP setting (optional). |
QOSTrafficType | Used to specify QOS/DSCP settings (optional). |
ShareLocalPort | If set to True, allows more than one instance of the class to be active on the same local port. |
SourceIPAddress | Used to set the source IP address used when sending a packet. |
SourceMacAddress | Used to set the source MAC address used when sending a packet. |
UseConnection | Determines whether to use a connected socket. |
UseIPv6 | Whether or not to use IPv6. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AcceptData Property (SNMPAgent Class)
Enables or disables data reception.
Syntax
ANSI (Cross Platform) int GetAcceptData();
int SetAcceptData(int bAcceptData); Unicode (Windows) BOOL GetAcceptData();
INT SetAcceptData(BOOL bAcceptData);
int ipworkssnmp_snmpagent_getacceptdata(void* lpObj);
int ipworkssnmp_snmpagent_setacceptdata(void* lpObj, int bAcceptData);
bool GetAcceptData();
int SetAcceptData(bool bAcceptData);
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 (SNMPAgent Class)
Indicates whether the class is active.
Syntax
ANSI (Cross Platform) int GetActive();
int SetActive(int bActive); Unicode (Windows) BOOL GetActive();
INT SetActive(BOOL bActive);
int ipworkssnmp_snmpagent_getactive(void* lpObj);
int ipworkssnmp_snmpagent_setactive(void* lpObj, int bActive);
bool GetActive();
int SetActive(bool bActive);
Default Value
FALSE
Remarks
This property indicates whether the class is currently active and can send or receive data.
The class will be automatically activated if it is not already and you attempt to perform an operation which requires the class to be active.
Use the Activate and Deactivate methods to control whether the class is active.
This property is not available at design time.
Data Type
Boolean
LocalEngineId Property (SNMPAgent Class)
The Engine Id of the SNMP Agent.
Syntax
ANSI (Cross Platform) int GetLocalEngineId(char* &lpLocalEngineId, int &lenLocalEngineId);
int SetLocalEngineId(const char* lpLocalEngineId, int lenLocalEngineId); Unicode (Windows) INT GetLocalEngineId(LPSTR &lpLocalEngineId, INT &lenLocalEngineId);
INT SetLocalEngineId(LPCSTR lpLocalEngineId, INT lenLocalEngineId);
int ipworkssnmp_snmpagent_getlocalengineid(void* lpObj, char** lpLocalEngineId, int* lenLocalEngineId);
int ipworkssnmp_snmpagent_setlocalengineid(void* lpObj, const char* lpLocalEngineId, int lenLocalEngineId);
QByteArray GetLocalEngineId();
int SetLocalEngineId(QByteArray qbaLocalEngineId);
Default Value
""
Remarks
This property is only used for SNMPv3 packets (when SNMPVersion is 3).
Data Type
Binary String
LocalHost Property (SNMPAgent Class)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
ANSI (Cross Platform) char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost); Unicode (Windows) LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);
char* ipworkssnmp_snmpagent_getlocalhost(void* lpObj);
int ipworkssnmp_snmpagent_setlocalhost(void* lpObj, const char* lpszLocalHost);
QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);
Default Value
""
Remarks
The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Note: LocalHost is not persistent. You must always set it in code, and never in the property window.
Data Type
String
LocalPort Property (SNMPAgent Class)
The port in the local host where the class listens.
Syntax
ANSI (Cross Platform) int GetLocalPort();
int SetLocalPort(int iLocalPort); Unicode (Windows) INT GetLocalPort();
INT SetLocalPort(INT iLocalPort);
int ipworkssnmp_snmpagent_getlocalport(void* lpObj);
int ipworkssnmp_snmpagent_setlocalport(void* lpObj, int iLocalPort);
int GetLocalPort();
int SetLocalPort(int iLocalPort);
Default Value
161
Remarks
The LocalPort property must be set before the class is activated (Active is set to True). It instructs the class to bind to a specific port (or communication endpoint) in the local machine (default 161).
You may also set LocalPort to 0. This allows the TCP/IP stack to choose a port at random. The value chosen is provided via the LocalPort property after the class is activated through the Active property.
LocalPort cannot be changed once the class is Active. Any attempt to set the LocalPort property when the class 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
Objects Property (SNMPAgent Class)
The objects in the current request.
Syntax
IPWorksSNMPList<IPWorksSNMPSNMPObject>* GetObjects(); int SetObjects(IPWorksSNMPList<IPWorksSNMPSNMPObject>* val);
int ipworkssnmp_snmpagent_getobjcount(void* lpObj);
int ipworkssnmp_snmpagent_setobjcount(void* lpObj, int iObjCount);
int ipworkssnmp_snmpagent_getobjtype(void* lpObj, int objindex);
int ipworkssnmp_snmpagent_setobjtype(void* lpObj, int objindex, int iObjType);
char* ipworkssnmp_snmpagent_getobjid(void* lpObj, int objindex);
int ipworkssnmp_snmpagent_setobjid(void* lpObj, int objindex, const char* lpszObjId);
char* ipworkssnmp_snmpagent_getobjtypestring(void* lpObj, int objindex);
int ipworkssnmp_snmpagent_getobjvalue(void* lpObj, int objindex, char** lpObjValue, int* lenObjValue);
int ipworkssnmp_snmpagent_setobjvalue(void* lpObj, int objindex, const char* lpObjValue, int lenObjValue);
int GetObjCount();
int SetObjCount(int iObjCount); int GetObjType(int iObjIndex);
int SetObjType(int iObjIndex, int iObjType); QString GetObjId(int iObjIndex);
int SetObjId(int iObjIndex, QString qsObjId); QString GetObjTypeString(int iObjIndex); QByteArray GetObjValue(int iObjIndex);
int SetObjValue(int iObjIndex, QByteArray qbaObjValue);
Remarks
The SNMP objects being sent or received in the current request. The collection is first cleared, then populated every time an SNMP packet is received. It is also used to create outgoing SNMP packets.
Data Type
RequestId Property (SNMPAgent Class)
The request-id to mark outgoing packets with.
Syntax
ANSI (Cross Platform) int GetRequestId();
int SetRequestId(int iRequestId); Unicode (Windows) INT GetRequestId();
INT SetRequestId(INT iRequestId);
int ipworkssnmp_snmpagent_getrequestid(void* lpObj);
int ipworkssnmp_snmpagent_setrequestid(void* lpObj, int iRequestId);
int GetRequestId();
int SetRequestId(int iRequestId);
Default Value
1
Remarks
If a custom value is needed for RequestId, the property must be set before sending the request. The class increments RequestId automatically after sending each packet.
This property is not available at design time.
Data Type
Integer
SNMPVersion Property (SNMPAgent Class)
Version of SNMP used for outgoing requests (traps).
Syntax
ANSI (Cross Platform) int GetSNMPVersion();
int SetSNMPVersion(int iSNMPVersion); Unicode (Windows) INT GetSNMPVersion();
INT SetSNMPVersion(INT iSNMPVersion);
Possible Values
SNMPVER_V1(1),
SNMPVER_V2C(2),
SNMPVER_V3(3)
int ipworkssnmp_snmpagent_getsnmpversion(void* lpObj);
int ipworkssnmp_snmpagent_setsnmpversion(void* lpObj, int iSNMPVersion);
int GetSNMPVersion();
int SetSNMPVersion(int iSNMPVersion);
Default Value
2
Remarks
This property takes one of the following values:
snmpverV1 (1) | SNMP Version 1. |
snmpverV2c (2) | SNMP Version 2c. |
snmpverV3 (3) | SNMP Version 3. |
Data Type
Integer
SSLAcceptServerCert Property (SNMPAgent Class)
This property instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
IPWorksSNMPCertificate* GetSSLAcceptServerCert(); int SetSSLAcceptServerCert(IPWorksSNMPCertificate* val);
char* ipworkssnmp_snmpagent_getsslacceptservercerteffectivedate(void* lpObj);
char* ipworkssnmp_snmpagent_getsslacceptservercertexpirationdate(void* lpObj);
char* ipworkssnmp_snmpagent_getsslacceptservercertextendedkeyusage(void* lpObj);
char* ipworkssnmp_snmpagent_getsslacceptservercertfingerprint(void* lpObj);
char* ipworkssnmp_snmpagent_getsslacceptservercertfingerprintsha1(void* lpObj);
char* ipworkssnmp_snmpagent_getsslacceptservercertfingerprintsha256(void* lpObj);
char* ipworkssnmp_snmpagent_getsslacceptservercertissuer(void* lpObj);
char* ipworkssnmp_snmpagent_getsslacceptservercertprivatekey(void* lpObj);
int ipworkssnmp_snmpagent_getsslacceptservercertprivatekeyavailable(void* lpObj);
char* ipworkssnmp_snmpagent_getsslacceptservercertprivatekeycontainer(void* lpObj);
char* ipworkssnmp_snmpagent_getsslacceptservercertpublickey(void* lpObj);
char* ipworkssnmp_snmpagent_getsslacceptservercertpublickeyalgorithm(void* lpObj);
int ipworkssnmp_snmpagent_getsslacceptservercertpublickeylength(void* lpObj);
char* ipworkssnmp_snmpagent_getsslacceptservercertserialnumber(void* lpObj);
char* ipworkssnmp_snmpagent_getsslacceptservercertsignaturealgorithm(void* lpObj);
int ipworkssnmp_snmpagent_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworkssnmp_snmpagent_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);
char* ipworkssnmp_snmpagent_getsslacceptservercertstorepassword(void* lpObj);
int ipworkssnmp_snmpagent_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);
int ipworkssnmp_snmpagent_getsslacceptservercertstoretype(void* lpObj);
int ipworkssnmp_snmpagent_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);
char* ipworkssnmp_snmpagent_getsslacceptservercertsubjectaltnames(void* lpObj);
char* ipworkssnmp_snmpagent_getsslacceptservercertthumbprintmd5(void* lpObj);
char* ipworkssnmp_snmpagent_getsslacceptservercertthumbprintsha1(void* lpObj);
char* ipworkssnmp_snmpagent_getsslacceptservercertthumbprintsha256(void* lpObj);
char* ipworkssnmp_snmpagent_getsslacceptservercertusage(void* lpObj);
int ipworkssnmp_snmpagent_getsslacceptservercertusageflags(void* lpObj);
char* ipworkssnmp_snmpagent_getsslacceptservercertversion(void* lpObj);
char* ipworkssnmp_snmpagent_getsslacceptservercertsubject(void* lpObj);
int ipworkssnmp_snmpagent_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);
int ipworkssnmp_snmpagent_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworkssnmp_snmpagent_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);
QString GetSSLAcceptServerCertEffectiveDate(); QString GetSSLAcceptServerCertExpirationDate(); QString GetSSLAcceptServerCertExtendedKeyUsage(); QString GetSSLAcceptServerCertFingerprint(); QString GetSSLAcceptServerCertFingerprintSHA1(); QString GetSSLAcceptServerCertFingerprintSHA256(); QString GetSSLAcceptServerCertIssuer(); QString GetSSLAcceptServerCertPrivateKey(); bool GetSSLAcceptServerCertPrivateKeyAvailable(); QString GetSSLAcceptServerCertPrivateKeyContainer(); QString GetSSLAcceptServerCertPublicKey(); QString GetSSLAcceptServerCertPublicKeyAlgorithm(); int GetSSLAcceptServerCertPublicKeyLength(); QString GetSSLAcceptServerCertSerialNumber(); QString GetSSLAcceptServerCertSignatureAlgorithm(); QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore); QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword); int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType); QString GetSSLAcceptServerCertSubjectAltNames(); QString GetSSLAcceptServerCertThumbprintMD5(); QString GetSSLAcceptServerCertThumbprintSHA1(); QString GetSSLAcceptServerCertThumbprintSHA256(); QString GetSSLAcceptServerCertUsage(); int GetSSLAcceptServerCertUsageFlags(); QString GetSSLAcceptServerCertVersion(); QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject); QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);
Remarks
If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
Data Type
SSLAuthenticateClients Property (SNMPAgent Class)
If set to True, the server asks the client(s) for a certificate.
Syntax
ANSI (Cross Platform) int GetSSLAuthenticateClients();
int SetSSLAuthenticateClients(int bSSLAuthenticateClients); Unicode (Windows) BOOL GetSSLAuthenticateClients();
INT SetSSLAuthenticateClients(BOOL bSSLAuthenticateClients);
int ipworkssnmp_snmpagent_getsslauthenticateclients(void* lpObj);
int ipworkssnmp_snmpagent_setsslauthenticateclients(void* lpObj, int bSSLAuthenticateClients);
bool GetSSLAuthenticateClients();
int SetSSLAuthenticateClients(bool bSSLAuthenticateClients);
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
SSLCert Property (SNMPAgent Class)
This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation.
Syntax
IPWorksSNMPCertificate* GetSSLCert(); int SetSSLCert(IPWorksSNMPCertificate* val);
char* ipworkssnmp_snmpagent_getsslcerteffectivedate(void* lpObj);
char* ipworkssnmp_snmpagent_getsslcertexpirationdate(void* lpObj);
char* ipworkssnmp_snmpagent_getsslcertextendedkeyusage(void* lpObj);
char* ipworkssnmp_snmpagent_getsslcertfingerprint(void* lpObj);
char* ipworkssnmp_snmpagent_getsslcertfingerprintsha1(void* lpObj);
char* ipworkssnmp_snmpagent_getsslcertfingerprintsha256(void* lpObj);
char* ipworkssnmp_snmpagent_getsslcertissuer(void* lpObj);
char* ipworkssnmp_snmpagent_getsslcertprivatekey(void* lpObj);
int ipworkssnmp_snmpagent_getsslcertprivatekeyavailable(void* lpObj);
char* ipworkssnmp_snmpagent_getsslcertprivatekeycontainer(void* lpObj);
char* ipworkssnmp_snmpagent_getsslcertpublickey(void* lpObj);
char* ipworkssnmp_snmpagent_getsslcertpublickeyalgorithm(void* lpObj);
int ipworkssnmp_snmpagent_getsslcertpublickeylength(void* lpObj);
char* ipworkssnmp_snmpagent_getsslcertserialnumber(void* lpObj);
char* ipworkssnmp_snmpagent_getsslcertsignaturealgorithm(void* lpObj);
int ipworkssnmp_snmpagent_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworkssnmp_snmpagent_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
char* ipworkssnmp_snmpagent_getsslcertstorepassword(void* lpObj);
int ipworkssnmp_snmpagent_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
int ipworkssnmp_snmpagent_getsslcertstoretype(void* lpObj);
int ipworkssnmp_snmpagent_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
char* ipworkssnmp_snmpagent_getsslcertsubjectaltnames(void* lpObj);
char* ipworkssnmp_snmpagent_getsslcertthumbprintmd5(void* lpObj);
char* ipworkssnmp_snmpagent_getsslcertthumbprintsha1(void* lpObj);
char* ipworkssnmp_snmpagent_getsslcertthumbprintsha256(void* lpObj);
char* ipworkssnmp_snmpagent_getsslcertusage(void* lpObj);
int ipworkssnmp_snmpagent_getsslcertusageflags(void* lpObj);
char* ipworkssnmp_snmpagent_getsslcertversion(void* lpObj);
char* ipworkssnmp_snmpagent_getsslcertsubject(void* lpObj);
int ipworkssnmp_snmpagent_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
int ipworkssnmp_snmpagent_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworkssnmp_snmpagent_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);
QString GetSSLCertEffectiveDate(); QString GetSSLCertExpirationDate(); QString GetSSLCertExtendedKeyUsage(); QString GetSSLCertFingerprint(); QString GetSSLCertFingerprintSHA1(); QString GetSSLCertFingerprintSHA256(); QString GetSSLCertIssuer(); QString GetSSLCertPrivateKey(); bool GetSSLCertPrivateKeyAvailable(); QString GetSSLCertPrivateKeyContainer(); QString GetSSLCertPublicKey(); QString GetSSLCertPublicKeyAlgorithm(); int GetSSLCertPublicKeyLength(); QString GetSSLCertSerialNumber(); QString GetSSLCertSignatureAlgorithm(); QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore); QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword); int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); QString GetSSLCertSubjectAltNames(); QString GetSSLCertThumbprintMD5(); QString GetSSLCertThumbprintSHA1(); QString GetSSLCertThumbprintSHA256(); QString GetSSLCertUsage(); int GetSSLCertUsageFlags(); QString GetSSLCertVersion(); QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject); QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);
Remarks
This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.
Data Type
SSLEnabled Property (SNMPAgent Class)
Whether DTLS is enabled.
Syntax
ANSI (Cross Platform) int GetSSLEnabled();
int SetSSLEnabled(int bSSLEnabled); Unicode (Windows) BOOL GetSSLEnabled();
INT SetSSLEnabled(BOOL bSSLEnabled);
int ipworkssnmp_snmpagent_getsslenabled(void* lpObj);
int ipworkssnmp_snmpagent_setsslenabled(void* lpObj, int bSSLEnabled);
bool GetSSLEnabled();
int SetSSLEnabled(bool bSSLEnabled);
Default Value
FALSE
Remarks
This setting specifies whether DTLS is enabled in the class. When False (default) the class operates in plaintext mode. When True DTLS is enabled.
This property is not available at design time.
Data Type
Boolean
SSLServerCert Property (SNMPAgent Class)
This property includes the server certificate for the last established connection.
Syntax
IPWorksSNMPCertificate* GetSSLServerCert();
char* ipworkssnmp_snmpagent_getsslservercerteffectivedate(void* lpObj);
char* ipworkssnmp_snmpagent_getsslservercertexpirationdate(void* lpObj);
char* ipworkssnmp_snmpagent_getsslservercertextendedkeyusage(void* lpObj);
char* ipworkssnmp_snmpagent_getsslservercertfingerprint(void* lpObj);
char* ipworkssnmp_snmpagent_getsslservercertfingerprintsha1(void* lpObj);
char* ipworkssnmp_snmpagent_getsslservercertfingerprintsha256(void* lpObj);
char* ipworkssnmp_snmpagent_getsslservercertissuer(void* lpObj);
char* ipworkssnmp_snmpagent_getsslservercertprivatekey(void* lpObj);
int ipworkssnmp_snmpagent_getsslservercertprivatekeyavailable(void* lpObj);
char* ipworkssnmp_snmpagent_getsslservercertprivatekeycontainer(void* lpObj);
char* ipworkssnmp_snmpagent_getsslservercertpublickey(void* lpObj);
char* ipworkssnmp_snmpagent_getsslservercertpublickeyalgorithm(void* lpObj);
int ipworkssnmp_snmpagent_getsslservercertpublickeylength(void* lpObj);
char* ipworkssnmp_snmpagent_getsslservercertserialnumber(void* lpObj);
char* ipworkssnmp_snmpagent_getsslservercertsignaturealgorithm(void* lpObj);
int ipworkssnmp_snmpagent_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);
char* ipworkssnmp_snmpagent_getsslservercertstorepassword(void* lpObj);
int ipworkssnmp_snmpagent_getsslservercertstoretype(void* lpObj);
char* ipworkssnmp_snmpagent_getsslservercertsubjectaltnames(void* lpObj);
char* ipworkssnmp_snmpagent_getsslservercertthumbprintmd5(void* lpObj);
char* ipworkssnmp_snmpagent_getsslservercertthumbprintsha1(void* lpObj);
char* ipworkssnmp_snmpagent_getsslservercertthumbprintsha256(void* lpObj);
char* ipworkssnmp_snmpagent_getsslservercertusage(void* lpObj);
int ipworkssnmp_snmpagent_getsslservercertusageflags(void* lpObj);
char* ipworkssnmp_snmpagent_getsslservercertversion(void* lpObj);
char* ipworkssnmp_snmpagent_getsslservercertsubject(void* lpObj);
int ipworkssnmp_snmpagent_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);
QString GetSSLServerCertEffectiveDate(); QString GetSSLServerCertExpirationDate(); QString GetSSLServerCertExtendedKeyUsage(); QString GetSSLServerCertFingerprint(); QString GetSSLServerCertFingerprintSHA1(); QString GetSSLServerCertFingerprintSHA256(); QString GetSSLServerCertIssuer(); QString GetSSLServerCertPrivateKey(); bool GetSSLServerCertPrivateKeyAvailable(); QString GetSSLServerCertPrivateKeyContainer(); QString GetSSLServerCertPublicKey(); QString GetSSLServerCertPublicKeyAlgorithm(); int GetSSLServerCertPublicKeyLength(); QString GetSSLServerCertSerialNumber(); QString GetSSLServerCertSignatureAlgorithm(); QByteArray GetSSLServerCertStore(); QString GetSSLServerCertStorePassword(); int GetSSLServerCertStoreType(); QString GetSSLServerCertSubjectAltNames(); QString GetSSLServerCertThumbprintMD5(); QString GetSSLServerCertThumbprintSHA1(); QString GetSSLServerCertThumbprintSHA256(); QString GetSSLServerCertUsage(); int GetSSLServerCertUsageFlags(); QString GetSSLServerCertVersion(); QString GetSSLServerCertSubject(); QByteArray GetSSLServerCertEncoded();
Remarks
SSLServerCert contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
This property is read-only.
Data Type
SysUpTime Property (SNMPAgent Class)
Time passed since the agent was initialized (in hundredths of a second).
Syntax
ANSI (Cross Platform) int64 GetSysUpTime();
int SetSysUpTime(int64 lSysUpTime); Unicode (Windows) LONG64 GetSysUpTime();
INT SetSysUpTime(LONG64 lSysUpTime);
int64 ipworkssnmp_snmpagent_getsysuptime(void* lpObj);
int ipworkssnmp_snmpagent_setsysuptime(void* lpObj, int64 lSysUpTime);
qint64 GetSysUpTime();
int SetSysUpTime(qint64 lSysUpTime);
Default Value
0
Remarks
This property is used when sending SNMP traps, and it normally provides the time since the system was restarted in 1/100s of a second.
If another value is desired, you may set this property to a custom value. From that point on, SysUpTime will return the value set plus time elapsed.
This property is not available at design time.
Data Type
Long64
Activate Method (SNMPAgent Class)
Activates the class.
Syntax
ANSI (Cross Platform) int Activate(); Unicode (Windows) INT Activate();
int ipworkssnmp_snmpagent_activate(void* lpObj);
int Activate();
Remarks
This method activates the component and will allow it to send or receive data.
The class will be automatically activated if it is not already and you attempt to perform an operation which requires the class to be active.
Note: Use the Active property to check whether the component is active.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
AddUser Method (SNMPAgent Class)
Adds a user to the internal authentication cache.
Syntax
ANSI (Cross Platform) int AddUser(const char* lpszUser, int iAuthenticationProtocol, const char* lpszAuthenticationPassword, int iEncryptionAlgorithm, const char* lpszEncryptionPassword); Unicode (Windows) INT AddUser(LPCWSTR lpszUser, INT iAuthenticationProtocol, LPCWSTR lpszAuthenticationPassword, INT iEncryptionAlgorithm, LPCWSTR lpszEncryptionPassword);
int ipworkssnmp_snmpagent_adduser(void* lpObj, const char* lpszUser, int iAuthenticationProtocol, const char* lpszAuthenticationPassword, int iEncryptionAlgorithm, const char* lpszEncryptionPassword);
int AddUser(const QString& qsUser, int iAuthenticationProtocol, const QString& qsAuthenticationPassword, int iEncryptionAlgorithm, const QString& qsEncryptionPassword);
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. |
NOTE: Specifying an authentication protocol of 0 is a special case where the class will attempt to verify users with all valid authentication protocols.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ClearCache Method (SNMPAgent Class)
Clears the internal authentication database.
Syntax
ANSI (Cross Platform) int ClearCache(); Unicode (Windows) INT ClearCache();
int ipworkssnmp_snmpagent_clearcache(void* lpObj);
int ClearCache();
Remarks
All user records are removed from the internal authentication cache as a result of this call.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (SNMPAgent Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworkssnmp_snmpagent_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Deactivate Method (SNMPAgent Class)
Deactivates the class.
Syntax
ANSI (Cross Platform) int Deactivate(); Unicode (Windows) INT Deactivate();
int ipworkssnmp_snmpagent_deactivate(void* lpObj);
int 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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DoEvents Method (SNMPAgent Class)
This method processes events from the internal message queue.
Syntax
ANSI (Cross Platform) int DoEvents(); Unicode (Windows) INT DoEvents();
int ipworkssnmp_snmpagent_doevents(void* lpObj);
int DoEvents();
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
HashPasswords Method (SNMPAgent Class)
Hashes all passwords in the cache.
Syntax
ANSI (Cross Platform) int HashPasswords(); Unicode (Windows) INT HashPasswords();
int ipworkssnmp_snmpagent_hashpasswords(void* lpObj);
int 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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
RemoveUser Method (SNMPAgent Class)
Removes the user specified by User from the internal authentication cache.
Syntax
ANSI (Cross Platform) int RemoveUser(const char* lpszUser); Unicode (Windows) INT RemoveUser(LPCWSTR lpszUser);
int ipworkssnmp_snmpagent_removeuser(void* lpObj, const char* lpszUser);
int RemoveUser(const QString& qsUser);
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Reset Method (SNMPAgent Class)
Clears the object arrays.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int ipworkssnmp_snmpagent_reset(void* lpObj);
int 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).
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SendResponse Method (SNMPAgent Class)
Sends a response packet to a Get, Get-Next, Get-Bulk, or Set request.
Syntax
ANSI (Cross Platform) int SendResponse(const char* lpszRemoteHost, int iRemotePort, int iRequestId, const char* lpszCommunity, int iErrorStatus, int iErrorIndex); Unicode (Windows) INT SendResponse(LPCWSTR lpszRemoteHost, INT iRemotePort, INT iRequestId, LPCWSTR lpszCommunity, INT iErrorStatus, INT iErrorIndex);
int ipworkssnmp_snmpagent_sendresponse(void* lpObj, const char* lpszRemoteHost, int iRemotePort, int iRequestId, const char* lpszCommunity, int iErrorStatus, int iErrorIndex);
int SendResponse(const QString& qsRemoteHost, int iRemotePort, int iRequestId, const QString& qsCommunity, int iErrorStatus, int iErrorIndex);
Remarks
Use this method to send asynchronous response packets. A valid RequestId must be specified. SendResponse sends an unauthenticated response packet. Depending upon the value of the SNMPVersion property, the packet is constructed as an SNMPv1, SNMPv2c, or SNMPv3 (unauthenticated) response PDU. To send authenticated or encrypted SNMPv3 responses, use SendSecureResponse
The RemoteHost and RemotePort parameters are used to determine where the response is to be sent. The object identifiers, types, and values for the request are taken from the Objects collection. The RequestId, Community, ErrorStatus, and ErrorIndex parameters are used to specify other properties of the response.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SendSecureResponse Method (SNMPAgent Class)
Sends an authenticated and/or encrypted SNMPv3 response.
Syntax
ANSI (Cross Platform) int SendSecureResponse(const char* lpszRemoteHost, int iRemotePort, int iRequestId, int iMessageId, int iErrorStatus, int iErrorIndex, const char* lpszUser, int iAuthenticationProtocol, const char* lpszAuthenticationPassword, int iEncryptionAlgorithm, const char* lpszEncryptionPassword); Unicode (Windows) INT SendSecureResponse(LPCWSTR lpszRemoteHost, INT iRemotePort, INT iRequestId, INT iMessageId, INT iErrorStatus, INT iErrorIndex, LPCWSTR lpszUser, INT iAuthenticationProtocol, LPCWSTR lpszAuthenticationPassword, INT iEncryptionAlgorithm, LPCWSTR lpszEncryptionPassword);
int ipworkssnmp_snmpagent_sendsecureresponse(void* lpObj, const char* lpszRemoteHost, int iRemotePort, int iRequestId, int iMessageId, int iErrorStatus, int iErrorIndex, const char* lpszUser, int iAuthenticationProtocol, const char* lpszAuthenticationPassword, int iEncryptionAlgorithm, const char* lpszEncryptionPassword);
int SendSecureResponse(const QString& qsRemoteHost, int iRemotePort, int iRequestId, int iMessageId, int iErrorStatus, int iErrorIndex, const QString& qsUser, int iAuthenticationProtocol, const QString& qsAuthenticationPassword, int iEncryptionAlgorithm, const QString& qsEncryptionPassword);
Remarks
Similar to the SendResponse method except that User, Authentication Protocol, and AuthenticationPassword are used to authenticate the response. EncryptionAlgorithm and EncryptionPassword (if not empty) are used to encrypt the response.
The MessageId argument must match the MessageId parameter obtained from the GetRequest, GetNextRequest, SetRequest, or GetBulkRequest event.
The user and password arguments used to send the response will be added to the internal user cache. If the user is already in the cache, its passwords will be updated with those supplied.
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. |
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SendSecureTrap Method (SNMPAgent Class)
Sends an authenticated and/or encrypted SNMPv3 trap.
Syntax
ANSI (Cross Platform) int SendSecureTrap(const char* lpszRemoteHost, const char* lpszTrapOID, const char* lpszUser, int iAuthenticationProtocol, const char* lpszAuthenticationPassword, int iEncryptionAlgorithm, const char* lpszEncryptionPassword); Unicode (Windows) INT SendSecureTrap(LPCWSTR lpszRemoteHost, LPCWSTR lpszTrapOID, LPCWSTR lpszUser, INT iAuthenticationProtocol, LPCWSTR lpszAuthenticationPassword, INT iEncryptionAlgorithm, LPCWSTR lpszEncryptionPassword);
int ipworkssnmp_snmpagent_sendsecuretrap(void* lpObj, const char* lpszRemoteHost, const char* lpszTrapOID, const char* lpszUser, int iAuthenticationProtocol, const char* lpszAuthenticationPassword, int iEncryptionAlgorithm, const char* lpszEncryptionPassword);
int SendSecureTrap(const QString& qsRemoteHost, const QString& qsTrapOID, const QString& qsUser, int iAuthenticationProtocol, const QString& qsAuthenticationPassword, int iEncryptionAlgorithm, const QString& qsEncryptionPassword);
Remarks
Similar to the SendTrap method except that User, AuthenticationPassword, and Authentication Protocol are used to authenticate the trap. EncryptionPassword (if not empty) and EncryptionAlgorithm are used to encrypt the message.
The user and password arguments used to send the trap will be added to the internal user cache. If the user is already in the cache, its passwords will be updated with those supplied.
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. |
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SendTrap Method (SNMPAgent Class)
Sends an SNMP Trap.
Syntax
ANSI (Cross Platform) int SendTrap(const char* lpszRemoteHost, const char* lpszTrapOID); Unicode (Windows) INT SendTrap(LPCWSTR lpszRemoteHost, LPCWSTR lpszTrapOID);
int ipworkssnmp_snmpagent_sendtrap(void* lpObj, const char* lpszRemoteHost, const char* lpszTrapOID);
int SendTrap(const QString& qsRemoteHost, const QString& qsTrapOID);
Remarks
Depending upon the value of the SNMPVersion property, the packet is constructed as an SNMPv1 or SNMPv2 Trap PDU. The following configuration settings provide more control about how traps are generated: TrapPort, TrapAgentAddress, TrapCommunity, TrapEnterprise. The SysUpTime property provides the trap timestamp.
SendTrap sends an unauthenticated trap. The SendSecureTrap method is used to send authenticated SNMPv3 traps.
If any values are provided in the Objects collection, they are sent unchanged. In the case of an SNMPv2 or SNMPv3 Trap, if Objects has a count that is equal to 0, the following values are set: sysUpTime.0 equal to SysUpTime and snmpTrapOID.0 equal to TrapOID.
For SNMPv2 and SNMPv3 Traps, TrapOID must contain the full OID of the Trap. For SNMPv1, TrapOID must be a string of the form "generic.specific" where generic and specific are numeric values providing the Trap Generic Type and Specific Type.
For SNMPv1, TrapOID must be of the form "GenericTrap.SpecificTrap". These values are sent in the PDU header. TrapAgentAddress and TrapEnterprise are taken from the corresponding configuration settings.
Additionally, the following symbolic values are recognized and translated as follows:
Trap Name | OID (SNMPv2 and above) | SNMPv1 GenericType |
coldStart | 1.3.6.1.6.3.1.1.5.1 | 0 |
warmStart | 1.3.6.1.6.3.1.1.5.2 | 1 |
linkDown | 1.3.6.1.6.3.1.1.5.3 | 2 |
linkUp | 1.3.6.1.6.3.1.1.5.4 | 3 |
authenticationFailure | 1.3.6.1.6.3.1.1.5.5 | 4 |
egpNeighborLoss | 1.3.6.1.6.3.1.1.5.6 | 5 |
enterpriseSpecific | 1.3.6.1.6.3.1.1.5.7 | 6 |
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ShowCache Method (SNMPAgent Class)
Lists all entries in the internal user authentication cache.
Syntax
ANSI (Cross Platform) int ShowCache(); Unicode (Windows) INT ShowCache();
int ipworkssnmp_snmpagent_showcache(void* lpObj);
int ShowCache();
Remarks
A CacheEntry event is fired for every record in the internal user authentication cache.
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Value Method (SNMPAgent Class)
Returns the value corresponding to an OID.
Syntax
ANSI (Cross Platform) char* Value(const char* lpszOID); Unicode (Windows) LPWSTR Value(LPCWSTR lpszOID);
char* ipworkssnmp_snmpagent_value(void* lpObj, const char* lpszOID);
QString Value(const QString& qsOID);
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.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
BadPacket Event (SNMPAgent Class)
Fired for erroneous and/or malformed messages.
Syntax
ANSI (Cross Platform) virtual int FireBadPacket(SNMPAgentBadPacketEventParams *e);
typedef struct {
const char *Packet; int lenPacket;
const char *SourceAddress;
int SourcePort;
int ErrorCode;
const char *ErrorDescription;
int Report; int reserved; } SNMPAgentBadPacketEventParams;
Unicode (Windows) virtual INT FireBadPacket(SNMPAgentBadPacketEventParams *e);
typedef struct {
LPCSTR Packet; INT lenPacket;
LPCWSTR SourceAddress;
INT SourcePort;
INT ErrorCode;
LPCWSTR ErrorDescription;
BOOL Report; INT reserved; } SNMPAgentBadPacketEventParams;
#define EID_SNMPAGENT_BADPACKET 1 virtual INT IPWORKSSNMP_CALL FireBadPacket(LPSTR &lpPacket, INT &lenPacket, LPSTR &lpszSourceAddress, INT &iSourcePort, INT &iErrorCode, LPSTR &lpszErrorDescription, BOOL &bReport);
class SNMPAgentBadPacketEventParams { public: const QByteArray &Packet(); const QString &SourceAddress(); int SourcePort(); int ErrorCode(); const QString &ErrorDescription(); bool Report(); void SetReport(bool bReport); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BadPacket(SNMPAgentBadPacketEventParams *e);
// Or, subclass SNMPAgent and override this emitter function. virtual int FireBadPacket(SNMPAgentBadPacketEventParams *e) {...}
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 (SNMPAgent Class)
Shows in the internal cache.
Syntax
ANSI (Cross Platform) virtual int FireCacheEntry(SNMPAgentCacheEntryEventParams *e);
typedef struct {
const char *User;
const char *AuthenticationProtocol;
const char *AuthenticationPassword;
const char *EncryptionAlgorithm;
const char *EncryptionPassword; int reserved; } SNMPAgentCacheEntryEventParams;
Unicode (Windows) virtual INT FireCacheEntry(SNMPAgentCacheEntryEventParams *e);
typedef struct {
LPCWSTR User;
LPCWSTR AuthenticationProtocol;
LPCWSTR AuthenticationPassword;
LPCWSTR EncryptionAlgorithm;
LPCWSTR EncryptionPassword; INT reserved; } SNMPAgentCacheEntryEventParams;
#define EID_SNMPAGENT_CACHEENTRY 2 virtual INT IPWORKSSNMP_CALL FireCacheEntry(LPSTR &lpszUser, LPSTR &lpszAuthenticationProtocol, LPSTR &lpszAuthenticationPassword, LPSTR &lpszEncryptionAlgorithm, LPSTR &lpszEncryptionPassword);
class SNMPAgentCacheEntryEventParams { public: const QString &User(); const QString &AuthenticationProtocol(); const QString &AuthenticationPassword(); const QString &EncryptionAlgorithm(); const QString &EncryptionPassword(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void CacheEntry(SNMPAgentCacheEntryEventParams *e);
// Or, subclass SNMPAgent and override this emitter function. virtual int FireCacheEntry(SNMPAgentCacheEntryEventParams *e) {...}
Remarks
CacheEntry events are triggered by a call to ShowCache. One event is fired for each user.
Connected Event (SNMPAgent Class)
Fired immediately after a connection completes (or fails).
Syntax
ANSI (Cross Platform) virtual int FireConnected(SNMPAgentConnectedEventParams *e);
typedef struct {
const char *RemoteAddress;
int RemotePort;
int StatusCode;
const char *Description; int reserved; } SNMPAgentConnectedEventParams;
Unicode (Windows) virtual INT FireConnected(SNMPAgentConnectedEventParams *e);
typedef struct {
LPCWSTR RemoteAddress;
INT RemotePort;
INT StatusCode;
LPCWSTR Description; INT reserved; } SNMPAgentConnectedEventParams;
#define EID_SNMPAGENT_CONNECTED 3 virtual INT IPWORKSSNMP_CALL FireConnected(LPSTR &lpszRemoteAddress, INT &iRemotePort, INT &iStatusCode, LPSTR &lpszDescription);
class SNMPAgentConnectedEventParams { public: const QString &RemoteAddress(); int RemotePort(); int StatusCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Connected(SNMPAgentConnectedEventParams *e);
// Or, subclass SNMPAgent and override this emitter function. virtual int FireConnected(SNMPAgentConnectedEventParams *e) {...}
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.
Disconnected Event (SNMPAgent Class)
Fired when a connection is closed.
Syntax
ANSI (Cross Platform) virtual int FireDisconnected(SNMPAgentDisconnectedEventParams *e);
typedef struct {
const char *RemoteAddress;
int RemotePort;
int StatusCode;
const char *Description; int reserved; } SNMPAgentDisconnectedEventParams;
Unicode (Windows) virtual INT FireDisconnected(SNMPAgentDisconnectedEventParams *e);
typedef struct {
LPCWSTR RemoteAddress;
INT RemotePort;
INT StatusCode;
LPCWSTR Description; INT reserved; } SNMPAgentDisconnectedEventParams;
#define EID_SNMPAGENT_DISCONNECTED 4 virtual INT IPWORKSSNMP_CALL FireDisconnected(LPSTR &lpszRemoteAddress, INT &iRemotePort, INT &iStatusCode, LPSTR &lpszDescription);
class SNMPAgentDisconnectedEventParams { public: const QString &RemoteAddress(); int RemotePort(); int StatusCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Disconnected(SNMPAgentDisconnectedEventParams *e);
// Or, subclass SNMPAgent and override this emitter function. virtual int FireDisconnected(SNMPAgentDisconnectedEventParams *e) {...}
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 (SNMPAgent Class)
Fired when an SNMPv3 discovery packet is received.
Syntax
ANSI (Cross Platform) virtual int FireDiscoveryRequest(SNMPAgentDiscoveryRequestEventParams *e);
typedef struct {
const char *EngineId; int lenEngineId;
int EngineBoots;
int EngineTime;
const char *User;
int SecurityLevel;
const char *SourceAddress;
int SourcePort;
int Respond; int reserved; } SNMPAgentDiscoveryRequestEventParams;
Unicode (Windows) virtual INT FireDiscoveryRequest(SNMPAgentDiscoveryRequestEventParams *e);
typedef struct {
LPCSTR EngineId; INT lenEngineId;
INT EngineBoots;
INT EngineTime;
LPCWSTR User;
INT SecurityLevel;
LPCWSTR SourceAddress;
INT SourcePort;
BOOL Respond; INT reserved; } SNMPAgentDiscoveryRequestEventParams;
#define EID_SNMPAGENT_DISCOVERYREQUEST 5 virtual INT IPWORKSSNMP_CALL FireDiscoveryRequest(LPSTR &lpEngineId, INT &lenEngineId, INT &iEngineBoots, INT &iEngineTime, LPSTR &lpszUser, INT &iSecurityLevel, LPSTR &lpszSourceAddress, INT &iSourcePort, BOOL &bRespond);
class SNMPAgentDiscoveryRequestEventParams { public: const QByteArray &EngineId(); int EngineBoots(); int EngineTime(); const QString &User(); int SecurityLevel(); const QString &SourceAddress(); int SourcePort(); bool Respond(); void SetRespond(bool bRespond); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void DiscoveryRequest(SNMPAgentDiscoveryRequestEventParams *e);
// Or, subclass SNMPAgent and override this emitter function. virtual int FireDiscoveryRequest(SNMPAgentDiscoveryRequestEventParams *e) {...}
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 (SNMPAgent Class)
Fired when information is available about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(SNMPAgentErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } SNMPAgentErrorEventParams;
Unicode (Windows) virtual INT FireError(SNMPAgentErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } SNMPAgentErrorEventParams;
#define EID_SNMPAGENT_ERROR 6 virtual INT IPWORKSSNMP_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class SNMPAgentErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(SNMPAgentErrorEventParams *e);
// Or, subclass SNMPAgent and override this emitter function. virtual int FireError(SNMPAgentErrorEventParams *e) {...}
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class 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.
GetBulkRequest Event (SNMPAgent Class)
Fired when a GetBulkRequest packet is received.
Syntax
ANSI (Cross Platform) virtual int FireGetBulkRequest(SNMPAgentGetBulkRequestEventParams *e);
typedef struct {
int RequestId;
int MessageId;
int SNMPVersion;
const char *Community;
const char *User;
int SecurityLevel;
const char *SourceAddress;
int SourcePort;
int NonRepeaters;
int MaxRepetitions;
int ErrorIndex;
int ErrorStatus;
const char *ErrorDescription;
int Respond; int reserved; } SNMPAgentGetBulkRequestEventParams;
Unicode (Windows) virtual INT FireGetBulkRequest(SNMPAgentGetBulkRequestEventParams *e);
typedef struct {
INT RequestId;
INT MessageId;
INT SNMPVersion;
LPCWSTR Community;
LPCWSTR User;
INT SecurityLevel;
LPCWSTR SourceAddress;
INT SourcePort;
INT NonRepeaters;
INT MaxRepetitions;
INT ErrorIndex;
INT ErrorStatus;
LPCWSTR ErrorDescription;
BOOL Respond; INT reserved; } SNMPAgentGetBulkRequestEventParams;
#define EID_SNMPAGENT_GETBULKREQUEST 7 virtual INT IPWORKSSNMP_CALL FireGetBulkRequest(INT &iRequestId, INT &iMessageId, INT &iSNMPVersion, LPSTR &lpszCommunity, LPSTR &lpszUser, INT &iSecurityLevel, LPSTR &lpszSourceAddress, INT &iSourcePort, INT &iNonRepeaters, INT &iMaxRepetitions, INT &iErrorIndex, INT &iErrorStatus, LPSTR &lpszErrorDescription, BOOL &bRespond);
class SNMPAgentGetBulkRequestEventParams { public: int RequestId(); int MessageId(); int SNMPVersion(); const QString &Community(); const QString &User(); int SecurityLevel(); const QString &SourceAddress(); int SourcePort(); int NonRepeaters(); int MaxRepetitions(); int ErrorIndex(); void SetErrorIndex(int iErrorIndex); int ErrorStatus(); void SetErrorStatus(int iErrorStatus); const QString &ErrorDescription(); bool Respond(); void SetRespond(bool bRespond); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void GetBulkRequest(SNMPAgentGetBulkRequestEventParams *e);
// Or, subclass SNMPAgent and override this emitter function. virtual int FireGetBulkRequest(SNMPAgentGetBulkRequestEventParams *e) {...}
Remarks
This is only available for SNMP versions 2 and 3.
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 Oid, ObjectType, and Value of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.
The SourceAddress and SourcePort parameters show the address and port of the sender as reported by the TCP/IP stack.
The MessageId parameter identifies the received request.
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).
A GetBulkRequest is very similar to a GetNextRequest, the difference is that Getbulk performs a continuous GetNext operation based on the MaxRepitions value. The NonRepeaters value will determine the number of Objects for which a simple GetNext operation should be performed. For the remaining variables, a continuous GetNext operation is performed based on the MaxRepitions value.
So if you send a request containing X objects, the agent will perform N simple GetNext operations and M continuous GetNext operations X - N times. With X being the number of objects received, N being the number of NonRepeaters, and M being the number of MaxRepitions. Thus the SNMPMgr is expecting to receive N + M x (X - N) objects, assuming that each object has M successors.
GetNextRequest Event (SNMPAgent Class)
Fired when a GetNextRequest packet is received.
Syntax
ANSI (Cross Platform) virtual int FireGetNextRequest(SNMPAgentGetNextRequestEventParams *e);
typedef struct {
int RequestId;
int MessageId;
int SNMPVersion;
const char *Community;
const char *User;
int SecurityLevel;
const char *SourceAddress;
int SourcePort;
int ErrorIndex;
int ErrorStatus;
const char *ErrorDescription;
int Respond; int reserved; } SNMPAgentGetNextRequestEventParams;
Unicode (Windows) virtual INT FireGetNextRequest(SNMPAgentGetNextRequestEventParams *e);
typedef struct {
INT RequestId;
INT MessageId;
INT SNMPVersion;
LPCWSTR Community;
LPCWSTR User;
INT SecurityLevel;
LPCWSTR SourceAddress;
INT SourcePort;
INT ErrorIndex;
INT ErrorStatus;
LPCWSTR ErrorDescription;
BOOL Respond; INT reserved; } SNMPAgentGetNextRequestEventParams;
#define EID_SNMPAGENT_GETNEXTREQUEST 8 virtual INT IPWORKSSNMP_CALL FireGetNextRequest(INT &iRequestId, INT &iMessageId, INT &iSNMPVersion, LPSTR &lpszCommunity, LPSTR &lpszUser, INT &iSecurityLevel, LPSTR &lpszSourceAddress, INT &iSourcePort, INT &iErrorIndex, INT &iErrorStatus, LPSTR &lpszErrorDescription, BOOL &bRespond);
class SNMPAgentGetNextRequestEventParams { public: int RequestId(); int MessageId(); int SNMPVersion(); const QString &Community(); const QString &User(); int SecurityLevel(); const QString &SourceAddress(); int SourcePort(); int ErrorIndex(); void SetErrorIndex(int iErrorIndex); int ErrorStatus(); void SetErrorStatus(int iErrorStatus); const QString &ErrorDescription(); bool Respond(); void SetRespond(bool bRespond); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void GetNextRequest(SNMPAgentGetNextRequestEventParams *e);
// Or, subclass SNMPAgent and override this emitter function. virtual int FireGetNextRequest(SNMPAgentGetNextRequestEventParams *e) {...}
Remarks
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 Oid, ObjectType, and Value of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.
The SourceAddress and SourcePort parameters show the address and port of the sender as reported by the TCP/IP stack.
The MessageId parameter identifies the received request.
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).
GetRequest Event (SNMPAgent Class)
Fired when a GetRequest packet is received.
Syntax
ANSI (Cross Platform) virtual int FireGetRequest(SNMPAgentGetRequestEventParams *e);
typedef struct {
int RequestId;
int MessageId;
int SNMPVersion;
const char *Community;
const char *User;
int SecurityLevel;
const char *SourceAddress;
int SourcePort;
int ErrorIndex;
int ErrorStatus;
const char *ErrorDescription;
int Respond; int reserved; } SNMPAgentGetRequestEventParams;
Unicode (Windows) virtual INT FireGetRequest(SNMPAgentGetRequestEventParams *e);
typedef struct {
INT RequestId;
INT MessageId;
INT SNMPVersion;
LPCWSTR Community;
LPCWSTR User;
INT SecurityLevel;
LPCWSTR SourceAddress;
INT SourcePort;
INT ErrorIndex;
INT ErrorStatus;
LPCWSTR ErrorDescription;
BOOL Respond; INT reserved; } SNMPAgentGetRequestEventParams;
#define EID_SNMPAGENT_GETREQUEST 9 virtual INT IPWORKSSNMP_CALL FireGetRequest(INT &iRequestId, INT &iMessageId, INT &iSNMPVersion, LPSTR &lpszCommunity, LPSTR &lpszUser, INT &iSecurityLevel, LPSTR &lpszSourceAddress, INT &iSourcePort, INT &iErrorIndex, INT &iErrorStatus, LPSTR &lpszErrorDescription, BOOL &bRespond);
class SNMPAgentGetRequestEventParams { public: int RequestId(); int MessageId(); int SNMPVersion(); const QString &Community(); const QString &User(); int SecurityLevel(); const QString &SourceAddress(); int SourcePort(); int ErrorIndex(); void SetErrorIndex(int iErrorIndex); int ErrorStatus(); void SetErrorStatus(int iErrorStatus); const QString &ErrorDescription(); bool Respond(); void SetRespond(bool bRespond); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void GetRequest(SNMPAgentGetRequestEventParams *e);
// Or, subclass SNMPAgent and override this emitter function. virtual int FireGetRequest(SNMPAgentGetRequestEventParams *e) {...}
Remarks
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 Oid, ObjectType, and Value of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.
The SourceAddress and SourcePort parameters show the address and port of the sender as reported by the TCP/IP stack.
The MessageId parameter identifies the received request.
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).
GetUserPassword Event (SNMPAgent Class)
Retrieves a password associated with a user.
Syntax
ANSI (Cross Platform) virtual int FireGetUserPassword(SNMPAgentGetUserPasswordEventParams *e);
typedef struct {
int PasswordType;
const char *User;
char *Password;
int Algorithm; int reserved; } SNMPAgentGetUserPasswordEventParams;
Unicode (Windows) virtual INT FireGetUserPassword(SNMPAgentGetUserPasswordEventParams *e);
typedef struct {
INT PasswordType;
LPCWSTR User;
LPWSTR Password;
INT Algorithm; INT reserved; } SNMPAgentGetUserPasswordEventParams;
#define EID_SNMPAGENT_GETUSERPASSWORD 10 virtual INT IPWORKSSNMP_CALL FireGetUserPassword(INT &iPasswordType, LPSTR &lpszUser, LPSTR &lpszPassword, INT &iAlgorithm);
class SNMPAgentGetUserPasswordEventParams { public: int PasswordType(); const QString &User(); const QString &Password(); void SetPassword(const QString &qsPassword); int Algorithm(); void SetAlgorithm(int iAlgorithm); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void GetUserPassword(SNMPAgentGetUserPasswordEventParams *e);
// Or, subclass SNMPAgent and override this emitter function. virtual int FireGetUserPassword(SNMPAgentGetUserPasswordEventParams *e) {...}
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 (if any) 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 (SNMPAgent Class)
Sets the security level for an incoming packet.
Syntax
ANSI (Cross Platform) virtual int FireGetUserSecurityLevel(SNMPAgentGetUserSecurityLevelEventParams *e);
typedef struct {
const char *User;
const char *EngineId; int lenEngineId;
int SecurityLevel; int reserved; } SNMPAgentGetUserSecurityLevelEventParams;
Unicode (Windows) virtual INT FireGetUserSecurityLevel(SNMPAgentGetUserSecurityLevelEventParams *e);
typedef struct {
LPCWSTR User;
LPCSTR EngineId; INT lenEngineId;
INT SecurityLevel; INT reserved; } SNMPAgentGetUserSecurityLevelEventParams;
#define EID_SNMPAGENT_GETUSERSECURITYLEVEL 11 virtual INT IPWORKSSNMP_CALL FireGetUserSecurityLevel(LPSTR &lpszUser, LPSTR &lpEngineId, INT &lenEngineId, INT &iSecurityLevel);
class SNMPAgentGetUserSecurityLevelEventParams { public: const QString &User(); const QByteArray &EngineId(); int SecurityLevel(); void SetSecurityLevel(int iSecurityLevel); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void GetUserSecurityLevel(SNMPAgentGetUserSecurityLevelEventParams *e);
// Or, subclass SNMPAgent and override this emitter function. virtual int FireGetUserSecurityLevel(SNMPAgentGetUserSecurityLevelEventParams *e) {...}
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 (SNMPAgent Class)
Fired before and after a password is hashed.
Syntax
ANSI (Cross Platform) virtual int FireHashPassword(SNMPAgentHashPasswordEventParams *e);
typedef struct {
const char *Password;
int AuthAlgorithm;
char *Hash; int reserved; } SNMPAgentHashPasswordEventParams;
Unicode (Windows) virtual INT FireHashPassword(SNMPAgentHashPasswordEventParams *e);
typedef struct {
LPCWSTR Password;
INT AuthAlgorithm;
LPWSTR Hash; INT reserved; } SNMPAgentHashPasswordEventParams;
#define EID_SNMPAGENT_HASHPASSWORD 12 virtual INT IPWORKSSNMP_CALL FireHashPassword(LPSTR &lpszPassword, INT &iAuthAlgorithm, LPSTR &lpszHash);
class SNMPAgentHashPasswordEventParams { public: const QString &Password(); int AuthAlgorithm(); const QString &Hash(); void SetHash(const QString &qsHash); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void HashPassword(SNMPAgentHashPasswordEventParams *e);
// Or, subclass SNMPAgent and override this emitter function. virtual int FireHashPassword(SNMPAgentHashPasswordEventParams *e) {...}
Remarks
SNMPv3 passwords are hashed in order to obtain authentication and encryption keys. This is an expensive operation, and in certain situations it may be preferable to store the hashed passwords externally and supply them on demand.
If a hash is required, the event fires with an empty string in the Hash parameter. In this case, you can choose to supply a value for the hash and stop the class from computing the hash.
The event also fires every time a hash is computed. In this case, the Hash parameter contains the value of the computed hash.
AuthAlgorithm contains either 1 for HMAC-MD5-96, 2 for HMAC-SHA-96 or 3 for HMAC-192-SHA-256
PacketTrace Event (SNMPAgent Class)
Fired for every packet sent or received.
Syntax
ANSI (Cross Platform) virtual int FirePacketTrace(SNMPAgentPacketTraceEventParams *e);
typedef struct {
const char *Packet; int lenPacket;
int Direction;
const char *PacketAddress;
int PacketPort; int reserved; } SNMPAgentPacketTraceEventParams;
Unicode (Windows) virtual INT FirePacketTrace(SNMPAgentPacketTraceEventParams *e);
typedef struct {
LPCSTR Packet; INT lenPacket;
INT Direction;
LPCWSTR PacketAddress;
INT PacketPort; INT reserved; } SNMPAgentPacketTraceEventParams;
#define EID_SNMPAGENT_PACKETTRACE 13 virtual INT IPWORKSSNMP_CALL FirePacketTrace(LPSTR &lpPacket, INT &lenPacket, INT &iDirection, LPSTR &lpszPacketAddress, INT &iPacketPort);
class SNMPAgentPacketTraceEventParams { public: const QByteArray &Packet(); int Direction(); const QString &PacketAddress(); int PacketPort(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void PacketTrace(SNMPAgentPacketTraceEventParams *e);
// Or, subclass SNMPAgent and override this emitter function. virtual int FirePacketTrace(SNMPAgentPacketTraceEventParams *e) {...}
Remarks
The PacketTrace event shows all the packets sent or received by the class.
Packet contains the full contents of the datagram.
Direction shows the direction of the packet: 1 for incoming packets, and 2 for outgoing packets.
In the case of an incoming packet, PacketAddress and PacketPort identify the source of the packet.
In the case of an outgoing packet, PacketAddress and PacketPort identify the destination of the packet.
ReadyToSend Event (SNMPAgent Class)
Fired when the class is ready to send data.
Syntax
ANSI (Cross Platform) virtual int FireReadyToSend(SNMPAgentReadyToSendEventParams *e);
typedef struct { int reserved; } SNMPAgentReadyToSendEventParams;
Unicode (Windows) virtual INT FireReadyToSend(SNMPAgentReadyToSendEventParams *e);
typedef struct { INT reserved; } SNMPAgentReadyToSendEventParams;
#define EID_SNMPAGENT_READYTOSEND 14 virtual INT IPWORKSSNMP_CALL FireReadyToSend();
class SNMPAgentReadyToSendEventParams { public: int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ReadyToSend(SNMPAgentReadyToSendEventParams *e);
// Or, subclass SNMPAgent and override this emitter function. virtual int FireReadyToSend(SNMPAgentReadyToSendEventParams *e) {...}
Remarks
The ReadyToSend event indicates that the underlying TCP/IP subsystem is ready to accept data after a failed DataToSend(TBD. DataToSend is removed).
Report Event (SNMPAgent Class)
Fired when a Report packet is received.
Syntax
ANSI (Cross Platform) virtual int FireReport(SNMPAgentReportEventParams *e);
typedef struct {
int RequestId;
int SNMPVersion;
const char *Community;
const char *User;
int SecurityLevel;
const char *SourceAddress;
int SourcePort;
int ErrorIndex;
int ErrorStatus;
const char *ErrorDescription; int reserved; } SNMPAgentReportEventParams;
Unicode (Windows) virtual INT FireReport(SNMPAgentReportEventParams *e);
typedef struct {
INT RequestId;
INT SNMPVersion;
LPCWSTR Community;
LPCWSTR User;
INT SecurityLevel;
LPCWSTR SourceAddress;
INT SourcePort;
INT ErrorIndex;
INT ErrorStatus;
LPCWSTR ErrorDescription; INT reserved; } SNMPAgentReportEventParams;
#define EID_SNMPAGENT_REPORT 15 virtual INT IPWORKSSNMP_CALL FireReport(INT &iRequestId, INT &iSNMPVersion, LPSTR &lpszCommunity, LPSTR &lpszUser, INT &iSecurityLevel, LPSTR &lpszSourceAddress, INT &iSourcePort, INT &iErrorIndex, INT &iErrorStatus, LPSTR &lpszErrorDescription);
class SNMPAgentReportEventParams { public: int RequestId(); int SNMPVersion(); const QString &Community(); const QString &User(); int SecurityLevel(); const QString &SourceAddress(); int SourcePort(); int ErrorIndex(); int ErrorStatus(); const QString &ErrorDescription(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Report(SNMPAgentReportEventParams *e);
// Or, subclass SNMPAgent and override this emitter function. virtual int FireReport(SNMPAgentReportEventParams *e) {...}
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 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 Oid, ObjectType, and Value of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.
The SourceAddress and SourcePort parameters show the address and port of the sender as reported by the TCP/IP stack.
SetRequest Event (SNMPAgent Class)
Fired when a SetRequest packet is received.
Syntax
ANSI (Cross Platform) virtual int FireSetRequest(SNMPAgentSetRequestEventParams *e);
typedef struct {
int RequestId;
int MessageId;
int SNMPVersion;
const char *Community;
const char *User;
int SecurityLevel;
const char *SourceAddress;
int SourcePort;
int ErrorIndex;
int ErrorStatus;
const char *ErrorDescription;
int Respond; int reserved; } SNMPAgentSetRequestEventParams;
Unicode (Windows) virtual INT FireSetRequest(SNMPAgentSetRequestEventParams *e);
typedef struct {
INT RequestId;
INT MessageId;
INT SNMPVersion;
LPCWSTR Community;
LPCWSTR User;
INT SecurityLevel;
LPCWSTR SourceAddress;
INT SourcePort;
INT ErrorIndex;
INT ErrorStatus;
LPCWSTR ErrorDescription;
BOOL Respond; INT reserved; } SNMPAgentSetRequestEventParams;
#define EID_SNMPAGENT_SETREQUEST 16 virtual INT IPWORKSSNMP_CALL FireSetRequest(INT &iRequestId, INT &iMessageId, INT &iSNMPVersion, LPSTR &lpszCommunity, LPSTR &lpszUser, INT &iSecurityLevel, LPSTR &lpszSourceAddress, INT &iSourcePort, INT &iErrorIndex, INT &iErrorStatus, LPSTR &lpszErrorDescription, BOOL &bRespond);
class SNMPAgentSetRequestEventParams { public: int RequestId(); int MessageId(); int SNMPVersion(); const QString &Community(); const QString &User(); int SecurityLevel(); const QString &SourceAddress(); int SourcePort(); int ErrorIndex(); void SetErrorIndex(int iErrorIndex); int ErrorStatus(); void SetErrorStatus(int iErrorStatus); const QString &ErrorDescription(); bool Respond(); void SetRespond(bool bRespond); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SetRequest(SNMPAgentSetRequestEventParams *e);
// Or, subclass SNMPAgent and override this emitter function. virtual int FireSetRequest(SNMPAgentSetRequestEventParams *e) {...}
Remarks
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 Oid, ObjectType, and Value of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.
The SourceAddress and SourcePort parameters show the address and port of the sender as reported by the TCP/IP stack.
The MessageId parameter identifies the received request.
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).
SSLClientAuthentication Event (SNMPAgent Class)
Fired when the client presents its credentials to the server.
Syntax
ANSI (Cross Platform) virtual int FireSSLClientAuthentication(SNMPAgentSSLClientAuthenticationEventParams *e);
typedef struct {
const char *RemoteAddress;
int RemotePort;
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } SNMPAgentSSLClientAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLClientAuthentication(SNMPAgentSSLClientAuthenticationEventParams *e);
typedef struct {
LPCWSTR RemoteAddress;
INT RemotePort;
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } SNMPAgentSSLClientAuthenticationEventParams;
#define EID_SNMPAGENT_SSLCLIENTAUTHENTICATION 17 virtual INT IPWORKSSNMP_CALL FireSSLClientAuthentication(LPSTR &lpszRemoteAddress, INT &iRemotePort, LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class SNMPAgentSSLClientAuthenticationEventParams { public: const QString &RemoteAddress(); int RemotePort(); const QByteArray &CertEncoded(); const QString &CertSubject(); const QString &CertIssuer(); const QString &Status(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLClientAuthentication(SNMPAgentSSLClientAuthenticationEventParams *e);
// Or, subclass SNMPAgent and override this emitter function. virtual int FireSSLClientAuthentication(SNMPAgentSSLClientAuthenticationEventParams *e) {...}
Remarks
This event fires when a client connects to the class and presents a certificate for authentication. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK").
RemoteAddress is the IP address of the connecting client.
RemotePort is the source port of the connecting client.
CertEncoded is the base64 encoded certificate presented by the client.
CertSubject is the subject of the certificate presented by the client.
CertIssuer is the subject of the issuer of the certificate presented by the client.
Status is the stauts of the certificate.
Accept defines whether the certificate is accepted.
SSLServerAuthentication Event (SNMPAgent Class)
Fires when connecting to the server.
Syntax
ANSI (Cross Platform) virtual int FireSSLServerAuthentication(SNMPAgentSSLServerAuthenticationEventParams *e);
typedef struct {
const char *RemoteAddress;
int RemotePort;
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } SNMPAgentSSLServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLServerAuthentication(SNMPAgentSSLServerAuthenticationEventParams *e);
typedef struct {
LPCWSTR RemoteAddress;
INT RemotePort;
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } SNMPAgentSSLServerAuthenticationEventParams;
#define EID_SNMPAGENT_SSLSERVERAUTHENTICATION 18 virtual INT IPWORKSSNMP_CALL FireSSLServerAuthentication(LPSTR &lpszRemoteAddress, INT &iRemotePort, LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class SNMPAgentSSLServerAuthenticationEventParams { public: const QString &RemoteAddress(); int RemotePort(); const QByteArray &CertEncoded(); const QString &CertSubject(); const QString &CertIssuer(); const QString &Status(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLServerAuthentication(SNMPAgentSSLServerAuthenticationEventParams *e);
// Or, subclass SNMPAgent and override this emitter function. virtual int FireSSLServerAuthentication(SNMPAgentSSLServerAuthenticationEventParams *e) {...}
Remarks
This event is where the client can decide whether to continue with the connection process or not. 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"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
RemoteAddress is the IP address of the server.
RemotePort is the source port of the server.
CertEncoded is the base64 encoded certificate presented by the server.
CertSubject is the subject of the certificate presented by the server.
CertIssuer is the subject of the issuer of the certificate presented by the server.
Status is the stauts of the certificate.
Accept defines whether the certificate is accepted.
SSLStatus Event (SNMPAgent Class)
Shows the progress of the secure connection.
Syntax
ANSI (Cross Platform) virtual int FireSSLStatus(SNMPAgentSSLStatusEventParams *e);
typedef struct {
const char *RemoteAddress;
int RemotePort;
const char *Message; int reserved; } SNMPAgentSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(SNMPAgentSSLStatusEventParams *e);
typedef struct {
LPCWSTR RemoteAddress;
INT RemotePort;
LPCWSTR Message; INT reserved; } SNMPAgentSSLStatusEventParams;
#define EID_SNMPAGENT_SSLSTATUS 19 virtual INT IPWORKSSNMP_CALL FireSSLStatus(LPSTR &lpszRemoteAddress, INT &iRemotePort, LPSTR &lpszMessage);
class SNMPAgentSSLStatusEventParams { public: const QString &RemoteAddress(); int RemotePort(); const QString &Message(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLStatus(SNMPAgentSSLStatusEventParams *e);
// Or, subclass SNMPAgent and override this emitter function. virtual int FireSSLStatus(SNMPAgentSSLStatusEventParams *e) {...}
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.
Certificate Type
This is the digital certificate being used.
Syntax
IPWorksSNMPCertificate (declared in ipworkssnmp.h)
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
EffectiveDate
char* (read-only)
Default Value: ""
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
ExpirationDate
char* (read-only)
Default Value: ""
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
ExtendedKeyUsage
char* (read-only)
Default Value: ""
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
char* (read-only)
Default Value: ""
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
FingerprintSHA1
char* (read-only)
Default Value: ""
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
FingerprintSHA256
char* (read-only)
Default Value: ""
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
Issuer
char* (read-only)
Default Value: ""
This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.
PrivateKey
char* (read-only)
Default Value: ""
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.
PrivateKeyAvailable
int (read-only)
Default Value: FALSE
This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
char* (read-only)
Default Value: ""
This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
char* (read-only)
Default Value: ""
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
char* (read-only)
Default Value: ""
This field contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
PublicKeyLength
int (read-only)
Default Value: 0
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
char* (read-only)
Default Value: ""
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
SignatureAlgorithm
char* (read-only)
Default Value: ""
The field contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
Store
char*
Default Value: "MY"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field 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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StorePassword
char*
Default Value: ""
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
StoreType
int
Default Value: 0
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This field 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 class. 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 Store and set StorePassword 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. |
SubjectAltNames
char* (read-only)
Default Value: ""
This field contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
char* (read-only)
Default Value: ""
This field contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA1
char* (read-only)
Default Value: ""
This field contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA256
char* (read-only)
Default Value: ""
This field contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
Usage
char* (read-only)
Default Value: ""
This field contains the text description of UsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags
int (read-only)
Default Value: 0
This field contains the flags that show intended use for the certificate. The value of UsageFlags 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 Usage field for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
char* (read-only)
Default Value: ""
This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Subject
char*
Default Value: ""
This is 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 field 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.
Encoded
char*
Default Value: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
Constructors
Certificate()
Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.
Certificate(const char* lpEncoded, int lenEncoded)
Parses Encoded as an X.509 public key.
Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
SNMPObject Type
The current SNMP object.
Syntax
IPWorksSNMPSNMPObject (declared in ipworkssnmp.h)
Remarks
This type defines an SNMP object. Each object has an Oid, ObjectType, and Value. These values are populated by the class when incoming packets are received. You may use these fields to define objects to be used in outgoing packets.
Fields
ObjectType
int
Default Value: 5
The current object's type. The default type is NULL (5).
The corresponding object id and value are specified by the Oid and Value fields.
Possible object type values include:
otInteger (2) | 2 |
otOctetString (4) | 4 |
otNull (5) | 5 |
otObjectID (6) | 6 |
otIPAddress (64) | 64 |
otCounter32 (65) | 65 |
otGauge32 (66) | 66 |
otTimeTicks (67) | 67 |
otOpaque (68) | 68 |
otNSAP (69) | 69 |
otCounter64 (70) | 70 |
otUnsignedInteger32 (71) | 71 |
The class also supports the following artificial object values used to designate error conditions:
otNoSuchObject (128) | No such object error. |
otNoSuchInstance (129) | No such instance error. |
otEndOfMibView (130) | End of MIB View error. |
Oid
char*
Default Value: ""
The current object's id which is encoded as a string of numbers separated by periods. For instance: "1.3.6.1.2.1.1.1.0" (OID for "system description").
The corresponding object type and value (if any) are specified by the ObjectType and Value fields.
Example
SNMPControl.ObjCount = 1
SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0"
TypeString
char* (read-only)
Default Value: ""
A string representation of the current object's ObjectType.
The corresponding object id and value are specified by the Oid and Value fields.
Value
char*
Default Value: ""
The current object's value. The corresponding object id and type are specified by the Oid and ObjectType fields.
Example
SNMPControl.ObjCount = 1
SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0"
SNMPControl.ObjValue(0) = "New Value"
Constructors
SNMPObject()
SNMPObject(const char* lpszOid)
SNMPObject(const char* lpszOid, const char* lpValue, int lenValue)
SNMPObject(const char* lpszOid, const char* lpValue, int lenValue, int iObjectType)
IPWorksSNMPList Type
Syntax
IPWorksSNMPList<T> (declared in ipworkssnmp.h)
Remarks
IPWorksSNMPList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the SNMPAgent class.
Methods | |
GetCount |
This method returns the current size of the collection.
int GetCount() {}
|
SetCount |
This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection.
int SetCount() {}
|
Get |
This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified.
T* Get(int index) {}
|
Set |
This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class.
T* Set(int index, T* value) {}
|
Config Settings (SNMPAgent Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.SNMPAgent 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. |
A valid port number (a value between 1 and 65535) is required. The default value is 162.
UDP Config Settings
The default value for this setting is False.
Note: This configuration setting is available only in Windows.
The default value is false.
Note: This configuration setting is available only in Windows.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class 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.
Note: This configuration setting uses the qWAVE API and is available only on Windows 7, Windows Server 2008 R2, and later.
Note: This configuration setting uses the qWAVE API and is available only on Windows Vista and Windows Server 2008 or above.
Note: QOSTrafficType must be set before setting Active to True.
The default value for this setting is False.
Note: This configuration setting is available only in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).
Note: This configuration setting is available only in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).
The default value for this setting is False.
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 class 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 class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
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 |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (SNMPAgent Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
SNMPAgent Errors
201 | Timeout. |
301 | Bad Object Index. |
302 | Value exceeds maximum number of objects allowed. |
303 | The value must be an IP address in dotted format. |
305 | Unsupported SNMP version. |
306 | Unknown PDU type. |
307 | The class is busy performing the current action. |
308 | Verification failed. |
309 | Missing password for Verification. |
310 | Missing signature. |
311 | Missing remote time. |
312 | Missing timeout value. |
313 | Decryption Failed. |
314 | Missing password for decryption. |
315 | Not encrypted. |
316 | Security model not supported. |
317 | Defective packet |
318 | Not from bound point. |
319 | Operation not permitted in current role. |
320 | Bad packet. |
321 | Message not authenticated. |
322 | No such oid. |
323 | Missing privacy parameter. |
324 | Bad engine id. |
325 | Bad time frame. |
326 | Bad user name. |
327 | Security level was not accepted. |
328 | Discovery failed. |
329 | Incorrect key length. |
330 | No authentication password supplied. |
The class may also return one of the following error codes, which are inherited from other classes.
UDP Errors
104 | UDP is already Active. |
106 | You cannot change the LocalPort while the class is Active. |
107 | You cannot change the LocalHost at this time. A connection is in progress. |
109 | The class must be Active for this operation. |
112 | You cannot change MaxPacketSize while the class is Active. |
113 | You cannot change ShareLocalPort option while the class is Active. |
114 | You cannot change RemoteHost when UseConnection is set and the class Active. |
115 | You cannot change RemotePort when UseConnection is set and the class is Active. |
116 | RemotePort cannot be zero when UseConnection is set. Please specify a valid service port number. |
117 | You cannot change UseConnection while the class is Active. |
118 | Message cannot be longer than MaxPacketSize. |
119 | Message too short. |
434 | Unable to convert string to selected CodePage. |
SSL Errors
270 | Cannot load specified security library. |
271 | Cannot open certificate store. |
272 | Cannot find specified certificate. |
273 | Cannot acquire security credentials. |
274 | Cannot find certificate chain. |
275 | Cannot verify certificate chain. |
276 | Error during handshake. |
280 | Error verifying certificate. |
281 | Could not find client certificate. |
282 | Could not find server certificate. |
283 | Error encrypting data. |
284 | Error decrypting data. |
TCP/IP Errors
10004 | [10004] Interrupted system call. |
10009 | [10009] Bad file number. |
10013 | [10013] Access denied. |
10014 | [10014] Bad address. |
10022 | [10022] Invalid argument. |
10024 | [10024] Too many open files. |
10035 | [10035] Operation would block. |
10036 | [10036] Operation now in progress. |
10037 | [10037] Operation already in progress. |
10038 | [10038] Socket operation on nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot assign requested address. |
10050 | [10050] Network is down. |
10051 | [10051] Network is unreachable. |
10052 | [10052] Net dropped connection or reset. |
10053 | [10053] Software caused connection abort. |
10054 | [10054] Connection reset by peer. |
10055 | [10055] No buffer space available. |
10056 | [10056] Socket is already connected. |
10057 | [10057] Socket is not connected. |
10058 | [10058] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is not empty |
10067 | [10067] Too many processes. |
10068 | [10068] Too many users. |
10069 | [10069] Disc Quota Exceeded. |
10070 | [10070] Stale NFS file handle. |
10071 | [10071] Too many levels of remote in path. |
10091 | [10091] Network subsystem is unavailable. |
10092 | [10092] WINSOCK DLL Version out of range. |
10093 | [10093] Winsock is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |