SNMPTCPAgent Class

Properties   Methods   Events   Configuration Settings   Errors  

The SNMPTCPAgent class is used to implement TCP-based SNMP Agent Applications.

Class Name

IPWorksSNMP_SNMPTCPAgent

Procedural Interface

 ipworkssnmp_snmptcpagent_open();
 ipworkssnmp_snmptcpagent_close($res);
 ipworkssnmp_snmptcpagent_register_callback($res, $id, $function);
 ipworkssnmp_snmptcpagent_get_last_error($res);
 ipworkssnmp_snmptcpagent_get_last_error_code($res);
 ipworkssnmp_snmptcpagent_set($res, $id, $index, $value);
 ipworkssnmp_snmptcpagent_get($res, $id, $index);
 ipworkssnmp_snmptcpagent_do_adduser($res, $user, $authenticationprotocol, $authenticationpassword, $encryptionalgorithm, $encryptionpassword);
 ipworkssnmp_snmptcpagent_do_clearcache($res);
 ipworkssnmp_snmptcpagent_do_config($res, $configurationstring);
 ipworkssnmp_snmptcpagent_do_doevents($res);
 ipworkssnmp_snmptcpagent_do_hashpasswords($res);
 ipworkssnmp_snmptcpagent_do_removeuser($res, $user);
 ipworkssnmp_snmptcpagent_do_reset($res);
 ipworkssnmp_snmptcpagent_do_sendresponse($res, $remotehost, $remoteport, $requestid, $community, $errorstatus, $errorindex);
 ipworkssnmp_snmptcpagent_do_sendsecureresponse($res, $remotehost, $remoteport, $requestid, $messageid, $errorstatus, $errorindex, $user, $authenticationprotocol, $authenticationpassword, $encryptionalgorithm, $encryptionpassword);
 ipworkssnmp_snmptcpagent_do_sendsecuretrap($res, $remotehost, $trapoid, $user, $authenticationprotocol, $authenticationpassword, $encryptionalgorithm, $encryptionpassword);
 ipworkssnmp_snmptcpagent_do_sendtrap($res, $remotehost, $trapoid);
 ipworkssnmp_snmptcpagent_do_showcache($res);
 ipworkssnmp_snmptcpagent_do_value($res, $oid);

Remarks

The SNMPTCPAgent class implements a TCP-based standard SNMP Agent as specified in the SNMP RFCs. The class supports SNMP v1, v2c, and v3.

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 setting the Active property. This property enables or disables sending and receiving.

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.

AcceptDataEnables or disables data reception.
ActiveEnables or disables sending and receiving of SNMP packets.
LocalEngineIdThe Engine Id of the SNMP Agent.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThe port in the local host where the class listens.
ObjCountThe number of records in the Obj arrays.
ObjTypeThe current object's type.
ObjIdThe current object's id which is encoded as a string of numbers separated by periods.
ObjTypeStringA string representation of the current object's ObjectType .
ObjValueThe current object's value.
RequestIdThe request-id to mark outgoing packets with.
SNMPVersionVersion of SNMP used for outgoing requests (traps).
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLAuthenticateClientsIf true, the server asks the client(s) for a certificate.
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLEnabledWhether TLS/SSL is enabled.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
SysUpTimeTime 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.

AddUserAdds a user to the internal authentication cache.
ClearCacheClears the internal authentication database.
ConfigSets or retrieves a configuration setting.
DoEventsProcesses events from the internal message queue.
HashPasswordsHashes all passwords in the cache.
RemoveUserRemoves the user specified by User from the internal authentication cache.
ResetClears the object arrays.
SendResponseSends a response packet to a Get, Get-Next, Get-Bulk, or Set request.
SendSecureResponseSends an authenticated and/or encrypted SNMPv3 response.
SendSecureTrapSends an authenticated and/or encrypted SNMPv3 trap.
SendTrapSends an SNMP Trap.
ShowCacheLists all entries in the internal user authentication cache.
ValueReturns 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.

BadPacketFired for erroneous and/or malformed messages.
CacheEntryShows in the internal cache.
ConnectedFired immediately after a connection completes (or fails).
ConnectionStatusTBD.
DisconnectedTBD.
DiscoveryRequestFired when an SNMPv3 discovery packet is received.
ErrorInformation about errors during data delivery.
GetBulkRequestFired when a GetBulkRequest packet is received.
GetNextRequestFired when a GetNextRequest packet is received.
GetRequestFired when a GetRequest packet is received.
GetUserPasswordRetrieves a password associated with a user.
GetUserSecurityLevelSets the security level for an incoming packet.
HashPasswordFired before and after a password is hashed.
PacketTraceFired for every packet sent or received.
ReadyToSendFired when the class is ready to send data.
ReportFired when a Report packet is received.
SetRequestFired when a SetRequest packet is received.
SSLClientAuthenticationFired when the client presents its credentials to the server.
SSLServerAuthenticationFires when connecting to the server.
SSLStatusShows the progress of the secure connection.

Configuration Settings


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

AuthenticationKeyThe key to use for authentication.
CompatibilityModeWhether to operate the class in a specific compatibility mode.
ContextEngineIdSets the context engine id of the SNMP entity.
ContextNameSets the context name of the SNMP entity.
EncryptionKeyThe key to use for encryption.
ForceLocalPortForces the class to bind to a specific port.
MsgMaxSizeThe maximum supported message size.
RespondFromDestIPWhether to respond from the IP address that the request was sent to.
SourceAddressThe source address of the received packet.
SourcePortThe source port of the received packet.
TimeWindowThe time window used for SNMPv3 timeliness checking (authentication).
TrapAgentAddressThe address of the object generating the trap.
TrapCommunityThe value of the Community parameter for SNMP traps.
TrapEnterpriseThe type of the object generating the trap.
TrapPortThe port where SNMP traps are sent.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks SNMP 2020 PHP Edition - Version 20.0 [Build 7941]