# SNMPAgent Control The SNMPAgent control is used to implement UDP-based SNMP Agent Applications. ## Syntax **SNMPAgent** ## Remarks The SNMPAgent control implements a UDP-based standard SNMP Agent as specified in the SNMP RFCs. The control supports SNMP v1, v2c, and v3. SNMP over DTLS is also supported when [SSLEnabled](#sslenabled-property-snmpagent-control) is set to True. When acting as a client, the [SSLServerAuthentication](#sslserverauthentication-event-snmpagent-control) event allows you to check the server identity and other security attributes. The [SSLStatus](#sslstatus-event-snmpagent-control) event provides information about the DTLS handshake. Additional SSL-related settings are also supported through the [Config](#config-method-snmpagent-control) 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](#sslauthenticateclients-property-snmpagent-control) property can be set to True and the [SSLClientAuthentication](#sslclientauthentication-event-snmpagent-control) event can be used to examine client credentials. The control 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 control is activated/deactivated by calling the [Activate](#activate-method-snmpagent-control) or [Deactivate](#deactivate-method-snmpagent-control) method. These methods enable or disable sending and receiving. The activation status can be found in the [Active](#active-property-snmpagent-control) property. The control operates asynchronously. Requests are received through events such as [GetRequest](#getrequest-event-snmpagent-control), [GetBulkRequest](#getbulkrequest-event-snmpagent-control), [GetNextRequest](#getnextrequest-event-snmpagent-control), etc. and the corresponding responses are automatically sent when the events return. Traps are sent through the [SendTrap](#sendtrap-method-snmpagent-control) method. SNMPv3 USM security passwords are requested through the [GetUserPassword](#getuserpassword-event-snmpagent-control) 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](#sendsecuretrap-method-snmpagent-control) method is used to send authenticated (secure) SNMPv3 traps. The [AddUser](#adduser-method-snmpagent-control), [RemoveUser](#removeuser-method-snmpagent-control), [ShowCache](#showcache-method-snmpagent-control), and [ClearCache](#clearcache-method-snmpagent-control) methods are used to manage an internal authentication cache. This internal cache can be used as an alternative to the [GetUserPassword](#getuserpassword-event-snmpagent-control) 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 control with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AcceptData](#acceptdata-property-snmpagent-control) | Enables or disables data reception. | | [Active](#active-property-snmpagent-control) | Indicates whether the control is active. | | [LocalEngineId](#localengineid-property-snmpagent-control) | The Engine Id of the SNMP Agent. | | [LocalHost](#localhost-property-snmpagent-control) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [LocalPort](#localport-property-snmpagent-control) | The port in the local host where the control listens. | | [ObjCount](#objcount-property-snmpagent-control) | The number of records in the Obj arrays. | | [ObjId](#objid-property-snmpagent-control) | The current object's id which is encoded as a string of numbers separated by periods. | | [ObjType](#objtype-property-snmpagent-control) | The current object's type. | | [ObjTypeString](#objtypestring-property-snmpagent-control) | A string representation of the current object's ObjectType . | | [ObjValue](#objvalue-property-snmpagent-control) | The current object's value. | | [RequestId](#requestid-property-snmpagent-control) | The request-id to mark outgoing packets with. | | [SNMPVersion](#snmpversion-property-snmpagent-control) | Version of SNMP used for outgoing requests (traps). | | [SSLAcceptServerCertEffectiveDate](#sslacceptservercerteffectivedate-property-snmpagent-control) | The date on which this certificate becomes valid. | | [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-snmpagent-control) | The certificate (PEM/Base64 encoded). | | [SSLAcceptServerCertExpirationDate](#sslacceptservercertexpirationdate-property-snmpagent-control) | The date on which the certificate expires. | | [SSLAcceptServerCertExtendedKeyUsage](#sslacceptservercertextendedkeyusage-property-snmpagent-control) | A comma-delimited list of extended key usage identifiers. | | [SSLAcceptServerCertFingerprint](#sslacceptservercertfingerprint-property-snmpagent-control) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SSLAcceptServerCertFingerprintSHA1](#sslacceptservercertfingerprintsha1-property-snmpagent-control) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SSLAcceptServerCertFingerprintSHA256](#sslacceptservercertfingerprintsha256-property-snmpagent-control) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SSLAcceptServerCertIssuer](#sslacceptservercertissuer-property-snmpagent-control) | The issuer of the certificate. | | [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-snmpagent-control) | The private key of the certificate (if available). | | [SSLAcceptServerCertPrivateKeyAvailable](#sslacceptservercertprivatekeyavailable-property-snmpagent-control) | Whether a PrivateKey is available for the selected certificate. | | [SSLAcceptServerCertPrivateKeyContainer](#sslacceptservercertprivatekeycontainer-property-snmpagent-control) | The name of the PrivateKey container for the certificate (if available). | | [SSLAcceptServerCertPublicKey](#sslacceptservercertpublickey-property-snmpagent-control) | The public key of the certificate. | | [SSLAcceptServerCertPublicKeyAlgorithm](#sslacceptservercertpublickeyalgorithm-property-snmpagent-control) | The textual description of the certificate's public key algorithm. | | [SSLAcceptServerCertPublicKeyLength](#sslacceptservercertpublickeylength-property-snmpagent-control) | The length of the certificate's public key (in bits). | | [SSLAcceptServerCertSerialNumber](#sslacceptservercertserialnumber-property-snmpagent-control) | The serial number of the certificate encoded as a string. | | [SSLAcceptServerCertSignatureAlgorithm](#sslacceptservercertsignaturealgorithm-property-snmpagent-control) | The text description of the certificate's signature algorithm. | | [SSLAcceptServerCertStore](#sslacceptservercertstore-property-snmpagent-control) | The name of the certificate store for the client certificate. | | [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-snmpagent-control) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-snmpagent-control) | The type of certificate store for this certificate. | | [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-snmpagent-control) | The subject of the certificate used for client authentication. | | [SSLAcceptServerCertSubjectAltNames](#sslacceptservercertsubjectaltnames-property-snmpagent-control) | Comma-separated lists of alternative subject names for the certificate. | | [SSLAcceptServerCertThumbprintMD5](#sslacceptservercertthumbprintmd5-property-snmpagent-control) | The MD5 hash of the certificate. | | [SSLAcceptServerCertThumbprintSHA1](#sslacceptservercertthumbprintsha1-property-snmpagent-control) | The SHA-1 hash of the certificate. | | [SSLAcceptServerCertThumbprintSHA256](#sslacceptservercertthumbprintsha256-property-snmpagent-control) | The SHA-256 hash of the certificate. | | [SSLAcceptServerCertUsage](#sslacceptservercertusage-property-snmpagent-control) | The text description of UsageFlags . | | [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-snmpagent-control) | The flags that show intended use for the certificate. | | [SSLAcceptServerCertVersion](#sslacceptservercertversion-property-snmpagent-control) | The certificate's version number. | | [SSLAuthenticateClients](#sslauthenticateclients-property-snmpagent-control) | If set to True, the server asks the client(s) for a certificate. | | [SSLCertEffectiveDate](#sslcerteffectivedate-property-snmpagent-control) | The date on which this certificate becomes valid. | | [SSLCertEncoded](#sslcertencoded-property-snmpagent-control) | The certificate (PEM/Base64 encoded). | | [SSLCertExpirationDate](#sslcertexpirationdate-property-snmpagent-control) | The date on which the certificate expires. | | [SSLCertExtendedKeyUsage](#sslcertextendedkeyusage-property-snmpagent-control) | A comma-delimited list of extended key usage identifiers. | | [SSLCertFingerprint](#sslcertfingerprint-property-snmpagent-control) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SSLCertFingerprintSHA1](#sslcertfingerprintsha1-property-snmpagent-control) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SSLCertFingerprintSHA256](#sslcertfingerprintsha256-property-snmpagent-control) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SSLCertIssuer](#sslcertissuer-property-snmpagent-control) | The issuer of the certificate. | | [SSLCertPrivateKey](#sslcertprivatekey-property-snmpagent-control) | The private key of the certificate (if available). | | [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-snmpagent-control) | Whether a PrivateKey is available for the selected certificate. | | [SSLCertPrivateKeyContainer](#sslcertprivatekeycontainer-property-snmpagent-control) | The name of the PrivateKey container for the certificate (if available). | | [SSLCertPublicKey](#sslcertpublickey-property-snmpagent-control) | The public key of the certificate. | | [SSLCertPublicKeyAlgorithm](#sslcertpublickeyalgorithm-property-snmpagent-control) | The textual description of the certificate's public key algorithm. | | [SSLCertPublicKeyLength](#sslcertpublickeylength-property-snmpagent-control) | The length of the certificate's public key (in bits). | | [SSLCertSerialNumber](#sslcertserialnumber-property-snmpagent-control) | The serial number of the certificate encoded as a string. | | [SSLCertSignatureAlgorithm](#sslcertsignaturealgorithm-property-snmpagent-control) | The text description of the certificate's signature algorithm. | | [SSLCertStore](#sslcertstore-property-snmpagent-control) | The name of the certificate store for the client certificate. | | [SSLCertStorePassword](#sslcertstorepassword-property-snmpagent-control) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SSLCertStoreType](#sslcertstoretype-property-snmpagent-control) | The type of certificate store for this certificate. | | [SSLCertSubject](#sslcertsubject-property-snmpagent-control) | The subject of the certificate used for client authentication. | | [SSLCertSubjectAltNames](#sslcertsubjectaltnames-property-snmpagent-control) | Comma-separated lists of alternative subject names for the certificate. | | [SSLCertThumbprintMD5](#sslcertthumbprintmd5-property-snmpagent-control) | The MD5 hash of the certificate. | | [SSLCertThumbprintSHA1](#sslcertthumbprintsha1-property-snmpagent-control) | The SHA-1 hash of the certificate. | | [SSLCertThumbprintSHA256](#sslcertthumbprintsha256-property-snmpagent-control) | The SHA-256 hash of the certificate. | | [SSLCertUsage](#sslcertusage-property-snmpagent-control) | The text description of UsageFlags . | | [SSLCertUsageFlags](#sslcertusageflags-property-snmpagent-control) | The flags that show intended use for the certificate. | | [SSLCertVersion](#sslcertversion-property-snmpagent-control) | The certificate's version number. | | [SSLEnabled](#sslenabled-property-snmpagent-control) | Whether DTLS is enabled. | | [SSLServerCertEffectiveDate](#sslservercerteffectivedate-property-snmpagent-control) | The date on which this certificate becomes valid. | | [SSLServerCertEncoded](#sslservercertencoded-property-snmpagent-control) | The certificate (PEM/Base64 encoded). | | [SSLServerCertExpirationDate](#sslservercertexpirationdate-property-snmpagent-control) | The date on which the certificate expires. | | [SSLServerCertExtendedKeyUsage](#sslservercertextendedkeyusage-property-snmpagent-control) | A comma-delimited list of extended key usage identifiers. | | [SSLServerCertFingerprint](#sslservercertfingerprint-property-snmpagent-control) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SSLServerCertFingerprintSHA1](#sslservercertfingerprintsha1-property-snmpagent-control) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SSLServerCertFingerprintSHA256](#sslservercertfingerprintsha256-property-snmpagent-control) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SSLServerCertIssuer](#sslservercertissuer-property-snmpagent-control) | The issuer of the certificate. | | [SSLServerCertPrivateKey](#sslservercertprivatekey-property-snmpagent-control) | The private key of the certificate (if available). | | [SSLServerCertPrivateKeyAvailable](#sslservercertprivatekeyavailable-property-snmpagent-control) | Whether a PrivateKey is available for the selected certificate. | | [SSLServerCertPrivateKeyContainer](#sslservercertprivatekeycontainer-property-snmpagent-control) | The name of the PrivateKey container for the certificate (if available). | | [SSLServerCertPublicKey](#sslservercertpublickey-property-snmpagent-control) | The public key of the certificate. | | [SSLServerCertPublicKeyAlgorithm](#sslservercertpublickeyalgorithm-property-snmpagent-control) | The textual description of the certificate's public key algorithm. | | [SSLServerCertPublicKeyLength](#sslservercertpublickeylength-property-snmpagent-control) | The length of the certificate's public key (in bits). | | [SSLServerCertSerialNumber](#sslservercertserialnumber-property-snmpagent-control) | The serial number of the certificate encoded as a string. | | [SSLServerCertSignatureAlgorithm](#sslservercertsignaturealgorithm-property-snmpagent-control) | The text description of the certificate's signature algorithm. | | [SSLServerCertStore](#sslservercertstore-property-snmpagent-control) | The name of the certificate store for the client certificate. | | [SSLServerCertStorePassword](#sslservercertstorepassword-property-snmpagent-control) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SSLServerCertStoreType](#sslservercertstoretype-property-snmpagent-control) | The type of certificate store for this certificate. | | [SSLServerCertSubject](#sslservercertsubject-property-snmpagent-control) | The subject of the certificate used for client authentication. | | [SSLServerCertSubjectAltNames](#sslservercertsubjectaltnames-property-snmpagent-control) | Comma-separated lists of alternative subject names for the certificate. | | [SSLServerCertThumbprintMD5](#sslservercertthumbprintmd5-property-snmpagent-control) | The MD5 hash of the certificate. | | [SSLServerCertThumbprintSHA1](#sslservercertthumbprintsha1-property-snmpagent-control) | The SHA-1 hash of the certificate. | | [SSLServerCertThumbprintSHA256](#sslservercertthumbprintsha256-property-snmpagent-control) | The SHA-256 hash of the certificate. | | [SSLServerCertUsage](#sslservercertusage-property-snmpagent-control) | The text description of UsageFlags . | | [SSLServerCertUsageFlags](#sslservercertusageflags-property-snmpagent-control) | The flags that show intended use for the certificate. | | [SSLServerCertVersion](#sslservercertversion-property-snmpagent-control) | The certificate's version number. | | [SysUpTime](#sysuptime-property-snmpagent-control) | 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 control with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Activate](#activate-method-snmpagent-control) | Activates the control. | | [AddUser](#adduser-method-snmpagent-control) | Adds a user to the internal authentication cache. | | [ClearCache](#clearcache-method-snmpagent-control) | Clears the internal authentication database. | | [Config](#config-method-snmpagent-control) | Sets or retrieves a configuration setting. | | [Deactivate](#deactivate-method-snmpagent-control) | Deactivates the control. | | [DoEvents](#doevents-method-snmpagent-control) | This method processes events from the internal message queue. | | [HashPasswords](#hashpasswords-method-snmpagent-control) | Hashes all passwords in the cache. | | [PauseData](#pausedata-method-snmpagent-control) | This method pauses data reception. | | [ProcessData](#processdata-method-snmpagent-control) | This method reenables data reception after a call to PauseData . | | [RemoveUser](#removeuser-method-snmpagent-control) | Removes the user specified by User from the internal authentication cache. | | [Reset](#reset-method-snmpagent-control) | Clears the object arrays. | | [SendResponse](#sendresponse-method-snmpagent-control) | Sends a response packet to a Get, Get-Next, Get-Bulk, or Set request. | | [SendSecureResponse](#sendsecureresponse-method-snmpagent-control) | Sends an authenticated and/or encrypted SNMPv3 response. | | [SendSecureTrap](#sendsecuretrap-method-snmpagent-control) | Sends an authenticated and/or encrypted SNMPv3 trap. | | [SendTrap](#sendtrap-method-snmpagent-control) | Sends an SNMP Trap. | | [ShowCache](#showcache-method-snmpagent-control) | Lists all entries in the internal user authentication cache. | | [Value](#value-method-snmpagent-control) | Returns the value corresponding to an OID. | ## Event List *The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.* | | | | --- | --- | | [BadPacket](#badpacket-event-snmpagent-control) | Fired for erroneous and/or malformed messages. | | [CacheEntry](#cacheentry-event-snmpagent-control) | Shows in the internal cache. | | [Connected](#connected-event-snmpagent-control) | Fired immediately after a connection completes (or fails). | | [Disconnected](#disconnected-event-snmpagent-control) | Fired when a connection is closed. | | [DiscoveryRequest](#discoveryrequest-event-snmpagent-control) | Fired when an SNMPv3 discovery packet is received. | | [Error](#error-event-snmpagent-control) | Fired when information is available about errors during data delivery. | | [GetBulkRequest](#getbulkrequest-event-snmpagent-control) | Fired when a GetBulkRequest packet is received. | | [GetNextRequest](#getnextrequest-event-snmpagent-control) | Fired when a GetNextRequest packet is received. | | [GetRequest](#getrequest-event-snmpagent-control) | Fired when a GetRequest packet is received. | | [GetUserPassword](#getuserpassword-event-snmpagent-control) | Retrieves a password associated with a user. | | [GetUserSecurityLevel](#getusersecuritylevel-event-snmpagent-control) | Sets the security level for an incoming packet. | | [HashPassword](#hashpassword-event-snmpagent-control) | Fired before and after a password is hashed. | | [PacketTrace](#packettrace-event-snmpagent-control) | Fired for every packet sent or received. | | [ReadyToSend](#readytosend-event-snmpagent-control) | Fired when the control is ready to send data. | | [Report](#report-event-snmpagent-control) | Fired when a Report packet is received. | | [SetRequest](#setrequest-event-snmpagent-control) | Fired when a SetRequest packet is received. | | [SSLClientAuthentication](#sslclientauthentication-event-snmpagent-control) | Fired when the client presents its credentials to the server. | | [SSLServerAuthentication](#sslserverauthentication-event-snmpagent-control) | Fires when connecting to the server. | | [SSLStatus](#sslstatus-event-snmpagent-control) | Shows the progress of the secure connection. | ## Config Settings *The following is a list of config settings for the control with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AuthenticationKey](#AuthenticationKey) | The key to use for authentication. | | [CompatibilityMode](#CompatibilityMode) | Whether to operate the control in a specific compatibility mode. | | [ContextEngineId](#ContextEngineId) | Sets the context engine id of the SNMP entity. | | [ContextName](#ContextName) | Sets the context name of the SNMP entity. | | [DataToSend](#DataToSend) | Sends a raw packet. | | [DecryptLogPackets](#DecryptLogPackets) | Whether to decrypt logged packets. | | [EncryptionKey](#EncryptionKey) | The key to use for encryption. | | [ForceLocalPort](#ForceLocalPort) | Forces the control to bind to a specific port. | | [IgnoreDiscoveryRequestType](#IgnoreDiscoveryRequestType) | Treats other request types as discovery requests. | | [IncomingContextEngineId](#IncomingContextEngineId) | The engine Id of the received packet. | | [IncomingContextName](#IncomingContextName) | The context name of the received packet. | | [MsgMaxSize](#MsgMaxSize) | The maximum supported message size. | | [RespondFromDestIP](#RespondFromDestIP) | Whether to respond from the IP address that the request was sent to. | | [SourceAddress](#SourceAddress) | The source address of the received packet. | | [SourcePort](#SourcePort) | The source port of the received packet. | | [TimeWindow](#TimeWindow) | The time window used for SNMPv3 timeliness checking (authentication). | | [TrapAgentAddress](#TrapAgentAddress) | The address of the object generating the trap. | | [TrapCommunity](#TrapCommunity) | The value of the Community parameter for SNMP traps. | | [TrapEnterprise](#TrapEnterprise) | The type of the object generating the trap. | | [TrapPort](#TrapPort) | The port where SNMP traps are sent. | | [CaptureIPPacketInfo](#CaptureIPPacketInfo) | Used to capture the packet information. | | [DelayHostResolution](#DelayHostResolution) | Whether the hostname is resolved when RemoteHost is set. | | [DestinationAddress](#DestinationAddress) | Used to get the destination address from the packet information. | | [DontFragment](#DontFragment) | Used to set the Don't Fragment flag of outgoing packets. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the control binds. | | [MaxPacketSize](#MaxPacketSize) | The maximum length of the packets that can be received. | | [QOSDSCPValue](#QOSDSCPValue) | Used to specify an arbitrary QOS/DSCP setting (optional). | | [QOSTrafficType](#QOSTrafficType) | Used to specify QOS/DSCP settings (optional). | | [ShareLocalPort](#ShareLocalPort) | If set to True, allows more than one instance of the control to be active on the same local port. | | [UseConnection](#UseConnection) | Determines whether to use a connected socket. | | [UseIPv6](#UseIPv6) | Whether or not to use IPv6. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # AcceptData Property ([SNMPAgent](#snmpagent-control) Control) Enables or disables data reception. ## Syntax ```text snmpagentcontrol.AcceptData ``` ## Default Value True ## Remarks Setting the property to False temporarily disables data reception. Setting the property to True re-enables data reception. This property is read-only and not available at design time. ## Data Type Boolean # Active Property ([SNMPAgent](#snmpagent-control) Control) Indicates whether the control is active. ## Syntax ```text snmpagentcontrol.Active ``` ## Default Value False ## Remarks This property indicates whether the control is currently active and can send or receive data. The control will be automatically activated if it is not already and you attempt to perform an operation which requires the control to be active. Use the [Activate](#activate-method-snmpagent-control) and [Deactivate](#deactivate-method-snmpagent-control) methods to control whether the control is active. This property is read-only and not available at design time. ## Data Type Boolean # LocalEngineId Property ([SNMPAgent](#snmpagent-control) Control) The Engine Id of the SNMP Agent. ## Syntax ```text snmpagentcontrol.LocalEngineId[=string] ``` ## Default Value "" ## Remarks This property is only used for SNMPv3 packets (when [SNMPVersion](#snmpversion-property-snmpagent-control) is 3). To read or write binary data to the property, a Variant (Byte Array) version is provided in **.LocalEngineIdB**. ## Data Type Binary String # LocalHost Property ([SNMPAgent](#snmpagent-control) Control) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax ```text snmpagentcontrol.LocalHost[=string] ``` ## Default Value "" ## Remarks This property contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used. If the control is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window. ## Data Type String # LocalPort Property ([SNMPAgent](#snmpagent-control) Control) The port in the local host where the control listens. ## Syntax ```text snmpagentcontrol.LocalPort[=integer] ``` ## Default Value 161 ## Remarks The LocalPort property must be set before the control is activated ([Active](#active-property-snmpagent-control) is set to True). It instructs the control 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 control is activated through the [Active](#active-property-snmpagent-control) property. LocalPort cannot be changed once the control is [Active](#active-property-snmpagent-control). Any attempt to set the LocalPort property when the control is [Active](#active-property-snmpagent-control) will generate an error. NOTE: on macOS and iOS, root permissions are required to set LocalPort to any value below 1024. ## Data Type Integer # ObjCount Property ([SNMPAgent](#snmpagent-control) Control) The number of records in the Obj arrays. ## Syntax ```text snmpagentcontrol.ObjCount[=integer] ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [ObjId](#objid-property-snmpagent-control) - [ObjType](#objtype-property-snmpagent-control) - [ObjTypeString](#objtypestring-property-snmpagent-control) - [ObjValue](#objvalue-property-snmpagent-control) The array indices start at *0* and end at *ObjCount - 1*. This property is not available at design time. ## Data Type Integer # ObjId Property ([SNMPAgent](#snmpagent-control) Control) The current object's id which is encoded as a string of numbers separated by periods. ## Syntax ```text snmpagentcontrol.ObjId(ObjIndex)[=string] ``` ## Default Value "" ## Remarks The current object's id which is encoded as a string of numbers separated by periods. For instance: "1.3.6.1.2.1.1.1.0" (OID for "system description"). The corresponding object type and value (if any) are specified by the [ObjectType](#SNMPAgent_p_ObjectType) and [ObjValue](#objvalue-property-snmpagent-control) properties. **Example** ```text SNMPControl.ObjCount = 1 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0" ``` The *ObjIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ObjCount](#objcount-property-snmpagent-control) property. This property is not available at design time. ## Data Type String # ObjType Property ([SNMPAgent](#snmpagent-control) Control) The current object's type. ## Syntax ```text snmpagentcontrol.ObjType(ObjIndex)[=integer] ``` ## Possible Values ```text otInteger(2), otOctetString(4), otNull(5), otObjectId(6), otIPAddress(64), otCounter32(65), otGauge32(66), otTimeTicks(67), otOpaque(68), otNSAP(69), otCounter64(70), otUnsignedInteger32(71), otNoSuchObject(128), otNoSuchInstance(129), otEndOfMibView(130) ``` ## Default Value 5 ## Remarks The current object's type. The default type is NULL (5). The corresponding object id and value are specified by the [ObjOid](#SNMPAgent_p_ObjOid) and [ObjValue](#objvalue-property-snmpagent-control) properties. Possible object type values include: | | | | --- | --- | | otInteger (2) | 2 | | otOctetString (4) | 4 | | otNull (5) | 5 | | otObjectID (6) | 6 | | otIPAddress (64) | 64 | | otCounter32 (65) | 65 | | otGauge32 (66) | 66 | | otTimeTicks (67) | 67 | | otOpaque (68) | 68 | | otNSAP (69) | 69 | | otCounter64 (70) | 70 | | otUnsignedInteger32 (71) | 71 | The control also supports the following artificial object values used to designate error conditions: | | | | --- | --- | | otNoSuchObject (128) | No such object error. | | otNoSuchInstance (129) | No such instance error. | | otEndOfMibView (130) | End of MIB View error. | The *ObjIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ObjCount](#objcount-property-snmpagent-control) property. This property is not available at design time. ## Data Type Integer # ObjTypeString Property ([SNMPAgent](#snmpagent-control) Control) A string representation of the current object's ObjectType . ## Syntax ```text snmpagentcontrol.ObjTypeString(ObjIndex) ``` ## Default Value "" ## Remarks A string representation of the current object's [ObjectType](#SNMPAgent_p_ObjectType). The corresponding object id and value are specified by the [ObjOid](#SNMPAgent_p_ObjOid) and [ObjValue](#objvalue-property-snmpagent-control) properties. The *ObjIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ObjCount](#objcount-property-snmpagent-control) property. This property is read-only and not available at design time. ## Data Type String # ObjValue Property ([SNMPAgent](#snmpagent-control) Control) The current object's value. ## Syntax ```text snmpagentcontrol.ObjValue(ObjIndex)[=string] ``` ## Default Value "" ## Remarks The current object's value. The corresponding object id and type are specified by the [ObjOid](#SNMPAgent_p_ObjOid) and [ObjectType](#SNMPAgent_p_ObjectType) properties. **Example** ```text SNMPControl.ObjCount = 1 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0" SNMPControl.ObjValue(0) = "New Value" ``` The *ObjIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ObjCount](#objcount-property-snmpagent-control) property. To read or write binary data to the property, a Variant (Byte Array) version is provided in **.ObjValueB**. This property is not available at design time. ## Data Type Binary String # RequestId Property ([SNMPAgent](#snmpagent-control) Control) The request-id to mark outgoing packets with. ## Syntax ```text snmpagentcontrol.RequestId[=integer] ``` ## Default Value 1 ## Remarks If a custom value is needed for RequestId, the property must be set before sending the request. The control increments RequestId automatically after sending each packet. This property is not available at design time. ## Data Type Integer # SNMPVersion Property ([SNMPAgent](#snmpagent-control) Control) Version of SNMP used for outgoing requests (traps). ## Syntax ```text snmpagentcontrol.SNMPVersion[=integer] ``` ## Possible Values ```text snmpverV1(1), snmpverV2c(2), snmpverV3(3) ``` ## 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 # SSLAcceptServerCertEffectiveDate Property ([SNMPAgent](#snmpagent-control) Control) The date on which this certificate becomes valid. ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertEffectiveDate ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type String # SSLAcceptServerCertEncoded Property ([SNMPAgent](#snmpagent-control) Control) The certificate (PEM/Base64 encoded). ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertEncoded[=string] ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLAcceptServerCertStore](#sslacceptservercertstore-property-snmpagent-control) and [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-snmpagent-control) properties also may be used to specify a certificate. When [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-snmpagent-control) is set, a search is initiated in the current [SSLAcceptServerCertStore](#sslacceptservercertstore-property-snmpagent-control) for the private key of the certificate. If the key is found, [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-snmpagent-control) is updated to reflect the full subject of the selected certificate; otherwise, [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-snmpagent-control) is set to an empty string. To read or write binary data to the property, a Variant (Byte Array) version is provided in **.SSLAcceptServerCertEncodedB**. This property is not available at design time. ## Data Type Binary String # SSLAcceptServerCertExpirationDate Property ([SNMPAgent](#snmpagent-control) Control) The date on which the certificate expires. ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertExpirationDate ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type String # SSLAcceptServerCertExtendedKeyUsage Property ([SNMPAgent](#snmpagent-control) Control) A comma-delimited list of extended key usage identifiers. ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertExtendedKeyUsage ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type String # SSLAcceptServerCertFingerprint Property ([SNMPAgent](#snmpagent-control) Control) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertFingerprint ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type String # SSLAcceptServerCertFingerprintSHA1 Property ([SNMPAgent](#snmpagent-control) Control) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertFingerprintSHA1 ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type String # SSLAcceptServerCertFingerprintSHA256 Property ([SNMPAgent](#snmpagent-control) Control) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertFingerprintSHA256 ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type String # SSLAcceptServerCertIssuer Property ([SNMPAgent](#snmpagent-control) Control) The issuer of the certificate. ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertIssuer ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type String # SSLAcceptServerCertPrivateKey Property ([SNMPAgent](#snmpagent-control) Control) The private key of the certificate (if available). ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertPrivateKey ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-snmpagent-control) may be available but not exportable. In this case, [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-snmpagent-control) returns an empty string. This property is read-only. ## Data Type String # SSLAcceptServerCertPrivateKeyAvailable Property ([SNMPAgent](#snmpagent-control) Control) Whether a PrivateKey is available for the selected certificate. ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertPrivateKeyAvailable ``` ## Default Value False ## Remarks Whether a [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-snmpagent-control) is available for the selected certificate. If [SSLAcceptServerCertPrivateKeyAvailable](#sslacceptservercertprivatekeyavailable-property-snmpagent-control) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type Boolean # SSLAcceptServerCertPrivateKeyContainer Property ([SNMPAgent](#snmpagent-control) Control) The name of the PrivateKey container for the certificate (if available). ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertPrivateKeyContainer ``` ## Default Value "" ## Remarks The name of the [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-snmpagent-control) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # SSLAcceptServerCertPublicKey Property ([SNMPAgent](#snmpagent-control) Control) The public key of the certificate. ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertPublicKey ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type String # SSLAcceptServerCertPublicKeyAlgorithm Property ([SNMPAgent](#snmpagent-control) Control) The textual description of the certificate's public key algorithm. ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertPublicKeyAlgorithm ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # SSLAcceptServerCertPublicKeyLength Property ([SNMPAgent](#snmpagent-control) Control) The length of the certificate's public key (in bits). ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertPublicKeyLength ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type Integer # SSLAcceptServerCertSerialNumber Property ([SNMPAgent](#snmpagent-control) Control) The serial number of the certificate encoded as a string. ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertSerialNumber ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type String # SSLAcceptServerCertSignatureAlgorithm Property ([SNMPAgent](#snmpagent-control) Control) The text description of the certificate's signature algorithm. ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertSignatureAlgorithm ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # SSLAcceptServerCertStore Property ([SNMPAgent](#snmpagent-control) Control) The name of the certificate store for the client certificate. ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertStore[=string] ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-snmpagent-control) property denotes the type of the certificate store specified by [SSLAcceptServerCertStore](#sslacceptservercertstore-property-snmpagent-control). If the store is password-protected, specify the password in [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-snmpagent-control). [SSLAcceptServerCertStore](#sslacceptservercertstore-property-snmpagent-control) is used in conjunction with the [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-snmpagent-control) property to specify client certificates. If [SSLAcceptServerCertStore](#sslacceptservercertstore-property-snmpagent-control) has a value, and [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-snmpagent-control) or [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-snmpagent-control) is set, a search for a certificate is initiated. Please see the [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-snmpagent-control) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). To read or write binary data to the property, a Variant (Byte Array) version is provided in **.SSLAcceptServerCertStoreB**. ## Data Type Binary String # SSLAcceptServerCertStorePassword Property ([SNMPAgent](#snmpagent-control) Control) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertStorePassword[=string] ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Data Type String # SSLAcceptServerCertStoreType Property ([SNMPAgent](#snmpagent-control) Control) The type of certificate store for this certificate. ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertStoreType[=integer] ``` ## Possible Values ```text cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99) ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The control supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the control will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-snmpagent-control), the full path of the PKCS#11 DLL as the [SSLAcceptServerCertStore](#sslacceptservercertstore-property-snmpagent-control), and the PIN as the [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-snmpagent-control). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) control by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLAcceptServerCertStore](#sslacceptservercertstore-property-snmpagent-control) and set [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-snmpagent-control) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type Integer # SSLAcceptServerCertSubject Property ([SNMPAgent](#snmpagent-control) Control) The subject of the certificate used for client authentication. ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertSubject[=string] ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. ## Data Type String # SSLAcceptServerCertSubjectAltNames Property ([SNMPAgent](#snmpagent-control) Control) Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertSubjectAltNames ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # SSLAcceptServerCertThumbprintMD5 Property ([SNMPAgent](#snmpagent-control) Control) The MD5 hash of the certificate. ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertThumbprintMD5 ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # SSLAcceptServerCertThumbprintSHA1 Property ([SNMPAgent](#snmpagent-control) Control) The SHA-1 hash of the certificate. ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertThumbprintSHA1 ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # SSLAcceptServerCertThumbprintSHA256 Property ([SNMPAgent](#snmpagent-control) Control) The SHA-256 hash of the certificate. ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertThumbprintSHA256 ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # SSLAcceptServerCertUsage Property ([SNMPAgent](#snmpagent-control) Control) The text description of UsageFlags . ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertUsage ``` ## Default Value "" ## Remarks The text description of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-snmpagent-control). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type String # SSLAcceptServerCertUsageFlags Property ([SNMPAgent](#snmpagent-control) Control) The flags that show intended use for the certificate. ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertUsageFlags ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-snmpagent-control) 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 [SSLAcceptServerCertUsage](#sslacceptservercertusage-property-snmpagent-control) property for a text representation of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-snmpagent-control). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type Integer # SSLAcceptServerCertVersion Property ([SNMPAgent](#snmpagent-control) Control) The certificate's version number. ## Syntax ```text snmpagentcontrol.SSLAcceptServerCertVersion ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type String # SSLAuthenticateClients Property ([SNMPAgent](#snmpagent-control) Control) If set to True, the server asks the client(s) for a certificate. ## Syntax ```text snmpagentcontrol.SSLAuthenticateClients[=boolean] ``` ## Default Value False ## Remarks This property is used in conjunction with the [SSLClientAuthentication](#sslclientauthentication-event-snmpagent-control) event. Please refer to the documentation of the [SSLClientAuthentication](#sslclientauthentication-event-snmpagent-control) event for details. ## Data Type Boolean # SSLCertEffectiveDate Property ([SNMPAgent](#snmpagent-control) Control) The date on which this certificate becomes valid. ## Syntax ```text snmpagentcontrol.SSLCertEffectiveDate ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type String # SSLCertEncoded Property ([SNMPAgent](#snmpagent-control) Control) The certificate (PEM/Base64 encoded). ## Syntax ```text snmpagentcontrol.SSLCertEncoded[=string] ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLCertStore](#sslcertstore-property-snmpagent-control) and [SSLCertSubject](#sslcertsubject-property-snmpagent-control) properties also may be used to specify a certificate. When [SSLCertEncoded](#sslcertencoded-property-snmpagent-control) is set, a search is initiated in the current [SSLCertStore](#sslcertstore-property-snmpagent-control) for the private key of the certificate. If the key is found, [SSLCertSubject](#sslcertsubject-property-snmpagent-control) is updated to reflect the full subject of the selected certificate; otherwise, [SSLCertSubject](#sslcertsubject-property-snmpagent-control) is set to an empty string. To read or write binary data to the property, a Variant (Byte Array) version is provided in **.SSLCertEncodedB**. This property is not available at design time. ## Data Type Binary String # SSLCertExpirationDate Property ([SNMPAgent](#snmpagent-control) Control) The date on which the certificate expires. ## Syntax ```text snmpagentcontrol.SSLCertExpirationDate ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type String # SSLCertExtendedKeyUsage Property ([SNMPAgent](#snmpagent-control) Control) A comma-delimited list of extended key usage identifiers. ## Syntax ```text snmpagentcontrol.SSLCertExtendedKeyUsage ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type String # SSLCertFingerprint Property ([SNMPAgent](#snmpagent-control) Control) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text snmpagentcontrol.SSLCertFingerprint ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type String # SSLCertFingerprintSHA1 Property ([SNMPAgent](#snmpagent-control) Control) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text snmpagentcontrol.SSLCertFingerprintSHA1 ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type String # SSLCertFingerprintSHA256 Property ([SNMPAgent](#snmpagent-control) Control) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text snmpagentcontrol.SSLCertFingerprintSHA256 ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type String # SSLCertIssuer Property ([SNMPAgent](#snmpagent-control) Control) The issuer of the certificate. ## Syntax ```text snmpagentcontrol.SSLCertIssuer ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type String # SSLCertPrivateKey Property ([SNMPAgent](#snmpagent-control) Control) The private key of the certificate (if available). ## Syntax ```text snmpagentcontrol.SSLCertPrivateKey ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SSLCertPrivateKey](#sslcertprivatekey-property-snmpagent-control) may be available but not exportable. In this case, [SSLCertPrivateKey](#sslcertprivatekey-property-snmpagent-control) returns an empty string. This property is read-only. ## Data Type String # SSLCertPrivateKeyAvailable Property ([SNMPAgent](#snmpagent-control) Control) Whether a PrivateKey is available for the selected certificate. ## Syntax ```text snmpagentcontrol.SSLCertPrivateKeyAvailable ``` ## Default Value False ## Remarks Whether a [SSLCertPrivateKey](#sslcertprivatekey-property-snmpagent-control) is available for the selected certificate. If [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-snmpagent-control) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type Boolean # SSLCertPrivateKeyContainer Property ([SNMPAgent](#snmpagent-control) Control) The name of the PrivateKey container for the certificate (if available). ## Syntax ```text snmpagentcontrol.SSLCertPrivateKeyContainer ``` ## Default Value "" ## Remarks The name of the [SSLCertPrivateKey](#sslcertprivatekey-property-snmpagent-control) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # SSLCertPublicKey Property ([SNMPAgent](#snmpagent-control) Control) The public key of the certificate. ## Syntax ```text snmpagentcontrol.SSLCertPublicKey ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type String # SSLCertPublicKeyAlgorithm Property ([SNMPAgent](#snmpagent-control) Control) The textual description of the certificate's public key algorithm. ## Syntax ```text snmpagentcontrol.SSLCertPublicKeyAlgorithm ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # SSLCertPublicKeyLength Property ([SNMPAgent](#snmpagent-control) Control) The length of the certificate's public key (in bits). ## Syntax ```text snmpagentcontrol.SSLCertPublicKeyLength ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type Integer # SSLCertSerialNumber Property ([SNMPAgent](#snmpagent-control) Control) The serial number of the certificate encoded as a string. ## Syntax ```text snmpagentcontrol.SSLCertSerialNumber ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type String # SSLCertSignatureAlgorithm Property ([SNMPAgent](#snmpagent-control) Control) The text description of the certificate's signature algorithm. ## Syntax ```text snmpagentcontrol.SSLCertSignatureAlgorithm ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # SSLCertStore Property ([SNMPAgent](#snmpagent-control) Control) The name of the certificate store for the client certificate. ## Syntax ```text snmpagentcontrol.SSLCertStore[=string] ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SSLCertStoreType](#sslcertstoretype-property-snmpagent-control) property denotes the type of the certificate store specified by [SSLCertStore](#sslcertstore-property-snmpagent-control). If the store is password-protected, specify the password in [SSLCertStorePassword](#sslcertstorepassword-property-snmpagent-control). [SSLCertStore](#sslcertstore-property-snmpagent-control) is used in conjunction with the [SSLCertSubject](#sslcertsubject-property-snmpagent-control) property to specify client certificates. If [SSLCertStore](#sslcertstore-property-snmpagent-control) has a value, and [SSLCertSubject](#sslcertsubject-property-snmpagent-control) or [SSLCertEncoded](#sslcertencoded-property-snmpagent-control) is set, a search for a certificate is initiated. Please see the [SSLCertSubject](#sslcertsubject-property-snmpagent-control) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). To read or write binary data to the property, a Variant (Byte Array) version is provided in **.SSLCertStoreB**. ## Data Type Binary String # SSLCertStorePassword Property ([SNMPAgent](#snmpagent-control) Control) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text snmpagentcontrol.SSLCertStorePassword[=string] ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Data Type String # SSLCertStoreType Property ([SNMPAgent](#snmpagent-control) Control) The type of certificate store for this certificate. ## Syntax ```text snmpagentcontrol.SSLCertStoreType[=integer] ``` ## Possible Values ```text cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99) ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The control supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the control will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLCertStoreType](#sslcertstoretype-property-snmpagent-control), the full path of the PKCS#11 DLL as the [SSLCertStore](#sslcertstore-property-snmpagent-control), and the PIN as the [SSLCertStorePassword](#sslcertstorepassword-property-snmpagent-control). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) control by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLCertStore](#sslcertstore-property-snmpagent-control) and set [SSLCertStorePassword](#sslcertstorepassword-property-snmpagent-control) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type Integer # SSLCertSubject Property ([SNMPAgent](#snmpagent-control) Control) The subject of the certificate used for client authentication. ## Syntax ```text snmpagentcontrol.SSLCertSubject[=string] ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. ## Data Type String # SSLCertSubjectAltNames Property ([SNMPAgent](#snmpagent-control) Control) Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text snmpagentcontrol.SSLCertSubjectAltNames ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # SSLCertThumbprintMD5 Property ([SNMPAgent](#snmpagent-control) Control) The MD5 hash of the certificate. ## Syntax ```text snmpagentcontrol.SSLCertThumbprintMD5 ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # SSLCertThumbprintSHA1 Property ([SNMPAgent](#snmpagent-control) Control) The SHA-1 hash of the certificate. ## Syntax ```text snmpagentcontrol.SSLCertThumbprintSHA1 ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # SSLCertThumbprintSHA256 Property ([SNMPAgent](#snmpagent-control) Control) The SHA-256 hash of the certificate. ## Syntax ```text snmpagentcontrol.SSLCertThumbprintSHA256 ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # SSLCertUsage Property ([SNMPAgent](#snmpagent-control) Control) The text description of UsageFlags . ## Syntax ```text snmpagentcontrol.SSLCertUsage ``` ## Default Value "" ## Remarks The text description of [SSLCertUsageFlags](#sslcertusageflags-property-snmpagent-control). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type String # SSLCertUsageFlags Property ([SNMPAgent](#snmpagent-control) Control) The flags that show intended use for the certificate. ## Syntax ```text snmpagentcontrol.SSLCertUsageFlags ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SSLCertUsageFlags](#sslcertusageflags-property-snmpagent-control) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [SSLCertUsage](#sslcertusage-property-snmpagent-control) property for a text representation of [SSLCertUsageFlags](#sslcertusageflags-property-snmpagent-control). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type Integer # SSLCertVersion Property ([SNMPAgent](#snmpagent-control) Control) The certificate's version number. ## Syntax ```text snmpagentcontrol.SSLCertVersion ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type String # SSLEnabled Property ([SNMPAgent](#snmpagent-control) Control) Whether DTLS is enabled. ## Syntax ```text snmpagentcontrol.SSLEnabled[=boolean] ``` ## Default Value False ## Remarks This setting specifies whether DTLS is enabled in the control. When False (default) the control operates in plaintext mode. When True DTLS is enabled. This property is not available at design time. ## Data Type Boolean # SSLServerCertEffectiveDate Property ([SNMPAgent](#snmpagent-control) Control) The date on which this certificate becomes valid. ## Syntax ```text snmpagentcontrol.SSLServerCertEffectiveDate ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type String # SSLServerCertEncoded Property ([SNMPAgent](#snmpagent-control) Control) The certificate (PEM/Base64 encoded). ## Syntax ```text snmpagentcontrol.SSLServerCertEncoded ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLServerCertStore](#sslservercertstore-property-snmpagent-control) and [SSLServerCertSubject](#sslservercertsubject-property-snmpagent-control) properties also may be used to specify a certificate. When [SSLServerCertEncoded](#sslservercertencoded-property-snmpagent-control) is set, a search is initiated in the current [SSLServerCertStore](#sslservercertstore-property-snmpagent-control) for the private key of the certificate. If the key is found, [SSLServerCertSubject](#sslservercertsubject-property-snmpagent-control) is updated to reflect the full subject of the selected certificate; otherwise, [SSLServerCertSubject](#sslservercertsubject-property-snmpagent-control) is set to an empty string. To read or write binary data to the property, a Variant (Byte Array) version is provided in **.SSLServerCertEncodedB**. This property is read-only and not available at design time. ## Data Type Binary String # SSLServerCertExpirationDate Property ([SNMPAgent](#snmpagent-control) Control) The date on which the certificate expires. ## Syntax ```text snmpagentcontrol.SSLServerCertExpirationDate ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type String # SSLServerCertExtendedKeyUsage Property ([SNMPAgent](#snmpagent-control) Control) A comma-delimited list of extended key usage identifiers. ## Syntax ```text snmpagentcontrol.SSLServerCertExtendedKeyUsage ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type String # SSLServerCertFingerprint Property ([SNMPAgent](#snmpagent-control) Control) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text snmpagentcontrol.SSLServerCertFingerprint ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type String # SSLServerCertFingerprintSHA1 Property ([SNMPAgent](#snmpagent-control) Control) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text snmpagentcontrol.SSLServerCertFingerprintSHA1 ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type String # SSLServerCertFingerprintSHA256 Property ([SNMPAgent](#snmpagent-control) Control) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text snmpagentcontrol.SSLServerCertFingerprintSHA256 ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type String # SSLServerCertIssuer Property ([SNMPAgent](#snmpagent-control) Control) The issuer of the certificate. ## Syntax ```text snmpagentcontrol.SSLServerCertIssuer ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type String # SSLServerCertPrivateKey Property ([SNMPAgent](#snmpagent-control) Control) The private key of the certificate (if available). ## Syntax ```text snmpagentcontrol.SSLServerCertPrivateKey ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SSLServerCertPrivateKey](#sslservercertprivatekey-property-snmpagent-control) may be available but not exportable. In this case, [SSLServerCertPrivateKey](#sslservercertprivatekey-property-snmpagent-control) returns an empty string. This property is read-only. ## Data Type String # SSLServerCertPrivateKeyAvailable Property ([SNMPAgent](#snmpagent-control) Control) Whether a PrivateKey is available for the selected certificate. ## Syntax ```text snmpagentcontrol.SSLServerCertPrivateKeyAvailable ``` ## Default Value False ## Remarks Whether a [SSLServerCertPrivateKey](#sslservercertprivatekey-property-snmpagent-control) is available for the selected certificate. If [SSLServerCertPrivateKeyAvailable](#sslservercertprivatekeyavailable-property-snmpagent-control) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type Boolean # SSLServerCertPrivateKeyContainer Property ([SNMPAgent](#snmpagent-control) Control) The name of the PrivateKey container for the certificate (if available). ## Syntax ```text snmpagentcontrol.SSLServerCertPrivateKeyContainer ``` ## Default Value "" ## Remarks The name of the [SSLServerCertPrivateKey](#sslservercertprivatekey-property-snmpagent-control) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # SSLServerCertPublicKey Property ([SNMPAgent](#snmpagent-control) Control) The public key of the certificate. ## Syntax ```text snmpagentcontrol.SSLServerCertPublicKey ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type String # SSLServerCertPublicKeyAlgorithm Property ([SNMPAgent](#snmpagent-control) Control) The textual description of the certificate's public key algorithm. ## Syntax ```text snmpagentcontrol.SSLServerCertPublicKeyAlgorithm ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # SSLServerCertPublicKeyLength Property ([SNMPAgent](#snmpagent-control) Control) The length of the certificate's public key (in bits). ## Syntax ```text snmpagentcontrol.SSLServerCertPublicKeyLength ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type Integer # SSLServerCertSerialNumber Property ([SNMPAgent](#snmpagent-control) Control) The serial number of the certificate encoded as a string. ## Syntax ```text snmpagentcontrol.SSLServerCertSerialNumber ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type String # SSLServerCertSignatureAlgorithm Property ([SNMPAgent](#snmpagent-control) Control) The text description of the certificate's signature algorithm. ## Syntax ```text snmpagentcontrol.SSLServerCertSignatureAlgorithm ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # SSLServerCertStore Property ([SNMPAgent](#snmpagent-control) Control) The name of the certificate store for the client certificate. ## Syntax ```text snmpagentcontrol.SSLServerCertStore ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SSLServerCertStoreType](#sslservercertstoretype-property-snmpagent-control) property denotes the type of the certificate store specified by [SSLServerCertStore](#sslservercertstore-property-snmpagent-control). If the store is password-protected, specify the password in [SSLServerCertStorePassword](#sslservercertstorepassword-property-snmpagent-control). [SSLServerCertStore](#sslservercertstore-property-snmpagent-control) is used in conjunction with the [SSLServerCertSubject](#sslservercertsubject-property-snmpagent-control) property to specify client certificates. If [SSLServerCertStore](#sslservercertstore-property-snmpagent-control) has a value, and [SSLServerCertSubject](#sslservercertsubject-property-snmpagent-control) or [SSLServerCertEncoded](#sslservercertencoded-property-snmpagent-control) is set, a search for a certificate is initiated. Please see the [SSLServerCertSubject](#sslservercertsubject-property-snmpagent-control) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). To read or write binary data to the property, a Variant (Byte Array) version is provided in **.SSLServerCertStoreB**. This property is read-only. ## Data Type Binary String # SSLServerCertStorePassword Property ([SNMPAgent](#snmpagent-control) Control) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text snmpagentcontrol.SSLServerCertStorePassword ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. This property is read-only. ## Data Type String # SSLServerCertStoreType Property ([SNMPAgent](#snmpagent-control) Control) The type of certificate store for this certificate. ## Syntax ```text snmpagentcontrol.SSLServerCertStoreType ``` ## Possible Values ```text cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99) ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The control supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the control will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLServerCertStoreType](#sslservercertstoretype-property-snmpagent-control), the full path of the PKCS#11 DLL as the [SSLServerCertStore](#sslservercertstore-property-snmpagent-control), and the PIN as the [SSLServerCertStorePassword](#sslservercertstorepassword-property-snmpagent-control). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) control by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLServerCertStore](#sslservercertstore-property-snmpagent-control) and set [SSLServerCertStorePassword](#sslservercertstorepassword-property-snmpagent-control) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | This property is read-only. ## Data Type Integer # SSLServerCertSubject Property ([SNMPAgent](#snmpagent-control) Control) The subject of the certificate used for client authentication. ## Syntax ```text snmpagentcontrol.SSLServerCertSubject ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. This property is read-only. ## Data Type String # SSLServerCertSubjectAltNames Property ([SNMPAgent](#snmpagent-control) Control) Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text snmpagentcontrol.SSLServerCertSubjectAltNames ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # SSLServerCertThumbprintMD5 Property ([SNMPAgent](#snmpagent-control) Control) The MD5 hash of the certificate. ## Syntax ```text snmpagentcontrol.SSLServerCertThumbprintMD5 ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # SSLServerCertThumbprintSHA1 Property ([SNMPAgent](#snmpagent-control) Control) The SHA-1 hash of the certificate. ## Syntax ```text snmpagentcontrol.SSLServerCertThumbprintSHA1 ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # SSLServerCertThumbprintSHA256 Property ([SNMPAgent](#snmpagent-control) Control) The SHA-256 hash of the certificate. ## Syntax ```text snmpagentcontrol.SSLServerCertThumbprintSHA256 ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # SSLServerCertUsage Property ([SNMPAgent](#snmpagent-control) Control) The text description of UsageFlags . ## Syntax ```text snmpagentcontrol.SSLServerCertUsage ``` ## Default Value "" ## Remarks The text description of [SSLServerCertUsageFlags](#sslservercertusageflags-property-snmpagent-control). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type String # SSLServerCertUsageFlags Property ([SNMPAgent](#snmpagent-control) Control) The flags that show intended use for the certificate. ## Syntax ```text snmpagentcontrol.SSLServerCertUsageFlags ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SSLServerCertUsageFlags](#sslservercertusageflags-property-snmpagent-control) 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 [SSLServerCertUsage](#sslservercertusage-property-snmpagent-control) property for a text representation of [SSLServerCertUsageFlags](#sslservercertusageflags-property-snmpagent-control). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type Integer # SSLServerCertVersion Property ([SNMPAgent](#snmpagent-control) Control) The certificate's version number. ## Syntax ```text snmpagentcontrol.SSLServerCertVersion ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type String # SysUpTime Property ([SNMPAgent](#snmpagent-control) Control) Time passed since the agent was initialized (in hundredths of a second). ## Syntax ```text snmpagentcontrol.SysUpTime[=long64] ``` ## 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](#snmpagent-control) Control) Activates the control. ## Syntax ```text snmpagentcontrol.Activate ``` ## Remarks This method activates the component and will allow it to send or receive data. The control will be automatically activated if it is not already and you attempt to perform an operation which requires the control to be active. NOTE: Use the [Active](#active-property-snmpagent-control) property to check whether the component is active. # AddUser Method ([SNMPAgent](#snmpagent-control) Control) Adds a user to the internal authentication cache. ## Syntax ```text snmpagentcontrol.AddUser User, AuthenticationProtocol, AuthenticationPassword, EncryptionAlgorithm, EncryptionPassword ``` ## Remarks The internal authentication cache can be used as an alternative to the [GetUserPassword](#getuserpassword-event-snmpagent-control) event, automatically checking the cache against the security parameters provided in the request signature. The [ShowCache](#showcache-method-snmpagent-control) method is used to show the contents of the internal authentication cache. The [ClearCache](#clearcache-method-snmpagent-control) method can be used to completely clear the cache. Valid Authentication Protocols are: | | | | --- | --- | | HMAC-MD5-96 (1) | Message-Digest algorithm 5. | | HMAC-SHA-96 (2) | Secure Hash Algorithm. | | HMAC-192-SHA-256 (3) | Secure Hash Algorithm. | | HMAC-384-SHA-512 (4) | Secure Hash Algorithm. | | HMAC-128-SHA-224 (5) | Secure Hash Algorithm. | | HMAC-256-SHA-384 (6) | Secure Hash Algorithm. | Valid Encryption Algorithms are: | | | | --- | --- | | DES (1) | Data Encryption Standard. | | AES (2) | Advanced Encryption Standard with key length of 128. | | 3DES (3) | Triple Data Encryption Standard. | | AES192 (4) | Advanced Encryption Standard with key length of 192. | | AES256 (5) | Advanced Encryption Standard with key length of 256. | NOTE: Specifying an authentication protocol of 0 is a special case where the control will attempt to verify users with all valid authentication protocols. # ClearCache Method ([SNMPAgent](#snmpagent-control) Control) Clears the internal authentication database. ## Syntax ```text snmpagentcontrol.ClearCache ``` ## Remarks All user records are removed from the internal authentication cache as a result of this call. # Config Method ([SNMPAgent](#snmpagent-control) Control) Sets or retrieves a configuration setting. ## Syntax ```text snmpagentcontrol.Config ConfigurationString ``` ## Remarks Config is a generic method available in every control. It is used to set and retrieve [configuration settings](#config-settings-snmpagent-control) for the control. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-snmpagent-control), you must call *Config("PROPERTY")*. The value will be returned as a string. # Deactivate Method ([SNMPAgent](#snmpagent-control) Control) Deactivates the control. ## Syntax ```text snmpagentcontrol.Deactivate ``` ## Remarks This method deactivates the component and will prohibit it from sending and receiving data. NOTE: Use the [Active](#active-property-snmpagent-control) property to check whether the component is active. # DoEvents Method ([SNMPAgent](#snmpagent-control) Control) This method processes events from the internal message queue. ## Syntax ```text snmpagentcontrol.DoEvents ``` ## Remarks When DoEvents is called, the control processes any available events. If no events are available, it waits for a preset period of time, and then returns. # HashPasswords Method ([SNMPAgent](#snmpagent-control) Control) Hashes all passwords in the cache. ## Syntax ```text snmpagentcontrol.HashPasswords ``` ## Remarks Forces computation of all passwords hashes in the cache. Used together with the [HashPassword](#hashpassword-event-snmpagent-control) event to enable implementations of external password hash storage. # PauseData Method ([SNMPAgent](#snmpagent-control) Control) This method pauses data reception. ## Syntax ```text snmpagentcontrol.PauseData ``` ## Remarks This method pauses data reception when called. While data reception is paused, the DataIn event will not fire. Call [ProcessData](#processdata-method-snmpagent-control) to reenable data reception. # ProcessData Method ([SNMPAgent](#snmpagent-control) Control) This method reenables data reception after a call to PauseData . ## Syntax ```text snmpagentcontrol.ProcessData ``` ## Remarks This method reenables data reception after a previous call to [PauseData](#pausedata-method-snmpagent-control). When [PauseData](#pausedata-method-snmpagent-control) is called, the DataIn event will not fire. To reenable data reception and allow DataIn to fire, call this method. NOTE: This method is used only after previously calling [PauseData](#pausedata-method-snmpagent-control). It does not need to be called to process incoming data by default. # RemoveUser Method ([SNMPAgent](#snmpagent-control) Control) Removes the user specified by User from the internal authentication cache. ## Syntax ```text snmpagentcontrol.RemoveUser User ``` ## Remarks The internal authentication cache can be used as an alternative to the [GetUserPassword](#getuserpassword-event-snmpagent-control) event, automatically checking the cache against the security parameters provided in the request signature. The [ShowCache](#showcache-method-snmpagent-control) method is used to show the contents of the internal authentication cache. The [ClearCache](#clearcache-method-snmpagent-control) method can be used to completely clear the cache. # Reset Method ([SNMPAgent](#snmpagent-control) Control) Clears the object arrays. ## Syntax ```text snmpagentcontrol.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](#snmpversion-property-snmpagent-control) will be reset to **snmpverV2c (2)**. # SendResponse Method ([SNMPAgent](#snmpagent-control) Control) Sends a response packet to a Get, Get-Next, Get-Bulk, or Set request. ## Syntax ```text snmpagentcontrol.SendResponse RemoteHost, RemotePort, RequestId, Community, ErrorStatus, ErrorIndex ``` ## 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](#snmpversion-property-snmpagent-control) property, the packet is constructed as an SNMPv1, SNMPv2c, or SNMPv3 (unauthenticated) response PDU. To send authenticated or encrypted SNMPv3 responses, use [SendSecureResponse](#sendsecureresponse-method-snmpagent-control) 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. # SendSecureResponse Method ([SNMPAgent](#snmpagent-control) Control) Sends an authenticated and/or encrypted SNMPv3 response. ## Syntax ```text snmpagentcontrol.SendSecureResponse RemoteHost, RemotePort, RequestId, MessageId, ErrorStatus, ErrorIndex, User, AuthenticationProtocol, AuthenticationPassword, EncryptionAlgorithm, EncryptionPassword ``` ## Remarks Similar to the [SendResponse](#sendresponse-method-snmpagent-control) 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](#getrequest-event-snmpagent-control), [GetNextRequest](#getnextrequest-event-snmpagent-control), [SetRequest](#setrequest-event-snmpagent-control), or [GetBulkRequest](#getbulkrequest-event-snmpagent-control) 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. | | HMAC-128-SHA-224 (5) | Secure Hash Algorithm. | | HMAC-256-SHA-384 (6) | Secure Hash Algorithm. | Valid Encryption Algorithms are: | | | | --- | --- | | DES (1) | Data Encryption Standard. | | AES (2) | Advanced Encryption Standard with key length of 128. | | 3DES (3) | Triple Data Encryption Standard. | | AES192 (4) | Advanced Encryption Standard with key length of 192. | | AES256 (5) | Advanced Encryption Standard with key length of 256. | # SendSecureTrap Method ([SNMPAgent](#snmpagent-control) Control) Sends an authenticated and/or encrypted SNMPv3 trap. ## Syntax ```text snmpagentcontrol.SendSecureTrap RemoteHost, TrapOID, User, AuthenticationProtocol, AuthenticationPassword, EncryptionAlgorithm, EncryptionPassword ``` ## Remarks Similar to the [SendTrap](#sendtrap-method-snmpagent-control) 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. | | HMAC-128-SHA-224 (5) | Secure Hash Algorithm. | | HMAC-256-SHA-384 (6) | Secure Hash Algorithm. | Valid Encryption Algorithms are: | | | | --- | --- | | DES (1) | Data Encryption Standard. | | AES (2) | Advanced Encryption Standard with key length of 128. | | 3DES (3) | Triple Data Encryption Standard. | | AES192 (4) | Advanced Encryption Standard with key length of 192. | | AES256 (5) | Advanced Encryption Standard with key length of 256. | # SendTrap Method ([SNMPAgent](#snmpagent-control) Control) Sends an SNMP Trap. ## Syntax ```text snmpagentcontrol.SendTrap RemoteHost, TrapOID ``` ## Remarks Depending upon the value of the [SNMPVersion](#snmpversion-property-snmpagent-control) 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](#TrapPort), [TrapAgentAddress](#TrapAgentAddress), [TrapCommunity](#TrapCommunity), [TrapEnterprise](#TrapEnterprise). The [SysUpTime](#sysuptime-property-snmpagent-control) property provides the trap timestamp. SendTrap sends an unauthenticated trap. The [SendSecureTrap](#sendsecuretrap-method-snmpagent-control) 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](#sysuptime-property-snmpagent-control) 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](#TrapAgentAddress) and [TrapEnterprise](#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 | # ShowCache Method ([SNMPAgent](#snmpagent-control) Control) Lists all entries in the internal user authentication cache. ## Syntax ```text snmpagentcontrol.ShowCache ``` ## Remarks A [CacheEntry](#cacheentry-event-snmpagent-control) 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](#getuserpassword-event-snmpagent-control) 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](#clearcache-method-snmpagent-control) method can be used to completely clear the cache. # Value Method ([SNMPAgent](#snmpagent-control) Control) Returns the value corresponding to an OID. ## Syntax ```text snmpagentcontrol.Value OID ``` ## Remarks If the OID does not exist in the Objects collection, a trappable error is generated. Please refer to the SNMPObject type for more information. # BadPacket Event ([SNMPAgent](#snmpagent-control) Control) Fired for erroneous and/or malformed messages. ## Syntax ```text Sub snmpagentcontrol_BadPacket(Packet As String, SourceAddress As String, SourcePort As Integer, ErrorCode As Integer, ErrorDescription As String, Report As Boolean) ``` ## Remarks The full message is provided in the *Packet* parameter. The BadPacket event is also fired when authentication fails for received packets due to a bad password or other reasons. If the *Report* parameter is set to True, an unauthenticated error report will be sent to the client, otherwise the packet will be silently ignored. Please refer to the [GetUserPassword](#getuserpassword-event-snmpagent-control) event for more information concerning SNMPv3 authentication. # CacheEntry Event ([SNMPAgent](#snmpagent-control) Control) Shows in the internal cache. ## Syntax ```text Sub snmpagentcontrol_CacheEntry(User As String, AuthenticationProtocol As String, AuthenticationPassword As String, EncryptionAlgorithm As String, EncryptionPassword As String) ``` ## Remarks CacheEntry events are triggered by a call to [ShowCache](#showcache-method-snmpagent-control). One event is fired for each user. # Connected Event ([SNMPAgent](#snmpagent-control) Control) Fired immediately after a connection completes (or fails). ## Syntax ```text Sub snmpagentcontrol_Connected(RemoteAddress As String, RemotePort As Integer, StatusCode As Integer, Description As String) ``` ## Remarks This event fires after a connection completes or fails. *StatusCode* is the value returned by the system TCP/IP stack. This will be 0 if the connection was successful. *Description* contains a human readable description of the status. This will be "OK" if the connection was successful. *RemoteAddress* is the IP address of the remote host. *RemotePort* is the port on the remote host. # Disconnected Event ([SNMPAgent](#snmpagent-control) Control) Fired when a connection is closed. ## Syntax ```text Sub snmpagentcontrol_Disconnected(RemoteAddress As String, RemotePort As Integer, StatusCode As Integer, Description As String) ``` ## Remarks This event fires after a connection is broken. *StatusCode* is the value returned by the system TCP/IP stack. This will be 0 if the connection was broken normally. *Description* contains a human readable description of the status. This will be "OK" if the connection was broken normally. *RemoteAddress* is the IP address of the remote host. *RemotePort* is the port on the remote host. # DiscoveryRequest Event ([SNMPAgent](#snmpagent-control) Control) Fired when an SNMPv3 discovery packet is received. ## Syntax ```text Sub snmpagentcontrol_DiscoveryRequest(EngineId As String, EngineBoots As Integer, EngineTime As Integer, User As String, SecurityLevel As Integer, SourceAddress As String, SourcePort As Integer, Respond As Boolean) ``` ## Remarks *EngineId*, *EngineBoots*, *EngineTime*, and *User* are the values received from *SourceAddress*. For SNMPv3, the *User* parameter shows the user that was supplied with the packet. This parameter *MUST* be used together with the *SecurityLevel* parameter which shows the level of security in the message. The *SecurityLevel* parameter shows whether the request has been authenticated. If *SecurityLevel* is 0, the request has *NOT* been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, *SecurityLevel* is 1. For an authenticated and encrypted request, *SecurityLevel* is 2. *Respond* is True by default, and will automatically send a response using the value in [LocalEngineId](#localengineid-property-snmpagent-control). 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](#snmpagent-control) Control) Fired when information is available about errors during data delivery. ## Syntax ```text Sub snmpagentcontrol_Error(ErrorCode As Integer, Description As String) ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error. The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-snmpagent-control) section. # GetBulkRequest Event ([SNMPAgent](#snmpagent-control) Control) Fired when a GetBulkRequest packet is received. ## Syntax ```text Sub snmpagentcontrol_GetBulkRequest(RequestId As Integer, MessageId As Integer, SNMPVersion As Integer, Community As String, User As String, SecurityLevel As Integer, SourceAddress As String, SourcePort As Integer, NonRepeaters As Integer, MaxRepetitions As Integer, ErrorIndex As Integer, ErrorStatus As Integer, ErrorDescription As String, Respond As Boolean) ``` ## 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 [ObjId](#objid-property-snmpagent-control), [ObjType](#objtype-property-snmpagent-control), and [ObjValue](#objvalue-property-snmpagent-control) of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events. The *SourceAddress* and *SourcePort* parameters show the address and port of the sender as reported by the TCP/IP stack. The *MessageId* parameter identifies the received request. For SNMPv3, the *User* parameter shows the user that was supplied with the packet. This parameter *MUST* be used together with the *SecurityLevel* parameter which shows the level of security in the message. The *SecurityLevel* parameter shows whether the request has been authenticated. If *SecurityLevel* is 0, the request has *NOT* been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, *SecurityLevel* is 1. For an authenticated and encrypted request, *SecurityLevel* is 2. To send a response, the *Respond* parameter must be set to true. By default, this value is false, which means no response will be sent. The *ErrorStatus* parameter may also be set to a valid SNMP status code (the default value is 0, which represents no error). The following is a list of valid SNMP status code values: | | | | --- | --- | | 0 (noError) | No error. | | 1 (tooBig) | The response cannot fit in a single SNMP message. | | 2 (noSuchName) | Variable does not exist. | | 3 (badValue) | Invalid value or syntax. | | 4 (readOnly) | Variable is read-only. | | 5 (genError) | Other error (SNMPv1). | | 6 (noAccess) | Access denied. | | 7 (wrongType) | Wrong object type. | | 8 (wrongLength) | Wrong length. | | 9 (wrongEncoding) | Wrong encoding. | | 10 (wrongValue) | Wrong value. | | 11 (noCreation) | No creation. | | 12 (inconsistentValue) | Inconsistent value. | | 13 (resourceUnavailable) | Resource unavailable. | | 14 (commitFailed) | Commit failed. | | 15 (undoFailed) | Undo failed. | | 16 (authorizationError) | Authorization error. | | 17 (notWritable) | Variable is not writable. | | 18 (inconsistentName) | Inconsistent name. | The *ErrorIndex* parameter indicates the index of the first variable (object) that caused an error. The default value is 0. Variable indexes start with 0. *ErrorIndex* has no meaning when *ErrorStatus* is 0 (no error). A GetBulkRequest is very similar to a GetNextRequest, the difference is that Getbulk performs a continuous GetNext operation based on the *MaxRepetitions* 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 *MaxRepetitions* 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 *MaxRepetitions*. Thus the SNMPMgr is expecting to receive N + M x (X - N) objects, assuming that each object has M successors. # GetNextRequest Event ([SNMPAgent](#snmpagent-control) Control) Fired when a GetNextRequest packet is received. ## Syntax ```text Sub snmpagentcontrol_GetNextRequest(RequestId As Integer, MessageId As Integer, SNMPVersion As Integer, Community As String, User As String, SecurityLevel As Integer, SourceAddress As String, SourcePort As Integer, ErrorIndex As Integer, ErrorStatus As Integer, ErrorDescription As String, Respond As Boolean) ``` ## Remarks The list of variables in the SNMP packet, including optional values and types, is provided through the Objects collection. Each object is of type SNMPObject. This type describes the [ObjId](#objid-property-snmpagent-control), [ObjType](#objtype-property-snmpagent-control), and [ObjValue](#objvalue-property-snmpagent-control) of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events. The *SourceAddress* and *SourcePort* parameters show the address and port of the sender as reported by the TCP/IP stack. The *MessageId* parameter identifies the received request. For SNMPv3, the *User* parameter shows the user that was supplied with the packet. This parameter *MUST* be used together with the *SecurityLevel* parameter which shows the level of security in the message. The *SecurityLevel* parameter shows whether the request has been authenticated. If *SecurityLevel* is 0, the request has *NOT* been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, *SecurityLevel* is 1. For an authenticated and encrypted request, *SecurityLevel* is 2. To send a response, the *Respond* parameter must be set to true. By default, this value is false, which means no response will be sent. The *ErrorStatus* parameter may also be set to a valid SNMP status code (the default value is 0, which represents no error). The following is a list of valid SNMP status code values: | | | | --- | --- | | 0 (noError) | No error. | | 1 (tooBig) | The response cannot fit in a single SNMP message. | | 2 (noSuchName) | Variable does not exist. | | 3 (badValue) | Invalid value or syntax. | | 4 (readOnly) | Variable is read-only. | | 5 (genError) | Other error (SNMPv1). | | 6 (noAccess) | Access denied. | | 7 (wrongType) | Wrong object type. | | 8 (wrongLength) | Wrong length. | | 9 (wrongEncoding) | Wrong encoding. | | 10 (wrongValue) | Wrong value. | | 11 (noCreation) | No creation. | | 12 (inconsistentValue) | Inconsistent value. | | 13 (resourceUnavailable) | Resource unavailable. | | 14 (commitFailed) | Commit failed. | | 15 (undoFailed) | Undo failed. | | 16 (authorizationError) | Authorization error. | | 17 (notWritable) | Variable is not writable. | | 18 (inconsistentName) | Inconsistent name. | The *ErrorIndex* parameter indicates the index of the first variable (object) that caused an error. The default value is 0. Variable indexes start with 0. *ErrorIndex* has no meaning when *ErrorStatus* is 0 (no error). # GetRequest Event ([SNMPAgent](#snmpagent-control) Control) Fired when a GetRequest packet is received. ## Syntax ```text Sub snmpagentcontrol_GetRequest(RequestId As Integer, MessageId As Integer, SNMPVersion As Integer, Community As String, User As String, SecurityLevel As Integer, SourceAddress As String, SourcePort As Integer, ErrorIndex As Integer, ErrorStatus As Integer, ErrorDescription As String, Respond As Boolean) ``` ## Remarks The list of variables in the SNMP packet, including optional values and types, is provided through the Objects collection. Each object is of type SNMPObject. This type describes the [ObjId](#objid-property-snmpagent-control), [ObjType](#objtype-property-snmpagent-control), and [ObjValue](#objvalue-property-snmpagent-control) of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events. The *SourceAddress* and *SourcePort* parameters show the address and port of the sender as reported by the TCP/IP stack. The *MessageId* parameter identifies the received request. For SNMPv3, the *User* parameter shows the user that was supplied with the packet. This parameter *MUST* be used together with the *SecurityLevel* parameter which shows the level of security in the message. The *SecurityLevel* parameter shows whether the request has been authenticated. If *SecurityLevel* is 0, the request has *NOT* been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, *SecurityLevel* is 1. For an authenticated and encrypted request, *SecurityLevel* is 2. To send a response, the *Respond* parameter must be set to true. By default, this value is false, which means no response will be sent. The *ErrorStatus* parameter may also be set to a valid SNMP status code (the default value is 0, which represents no error). The following is a list of valid SNMP status code values: | | | | --- | --- | | 0 (noError) | No error. | | 1 (tooBig) | The response cannot fit in a single SNMP message. | | 2 (noSuchName) | Variable does not exist. | | 3 (badValue) | Invalid value or syntax. | | 4 (readOnly) | Variable is read-only. | | 5 (genError) | Other error (SNMPv1). | | 6 (noAccess) | Access denied. | | 7 (wrongType) | Wrong object type. | | 8 (wrongLength) | Wrong length. | | 9 (wrongEncoding) | Wrong encoding. | | 10 (wrongValue) | Wrong value. | | 11 (noCreation) | No creation. | | 12 (inconsistentValue) | Inconsistent value. | | 13 (resourceUnavailable) | Resource unavailable. | | 14 (commitFailed) | Commit failed. | | 15 (undoFailed) | Undo failed. | | 16 (authorizationError) | Authorization error. | | 17 (notWritable) | Variable is not writable. | | 18 (inconsistentName) | Inconsistent name. | The *ErrorIndex* parameter indicates the index of the first variable (object) that caused an error. The default value is 0. Variable indexes start with 0. *ErrorIndex* has no meaning when *ErrorStatus* is 0 (no error). # GetUserPassword Event ([SNMPAgent](#snmpagent-control) Control) Retrieves a password associated with a user. ## Syntax ```text Sub snmpagentcontrol_GetUserPassword(PasswordType As Integer, User As String, Password As String, Algorithm As Integer) ``` ## Remarks The GetUserPassword event is fired after initial inspection of SNMPv3 requests. The type of password required is provided in the *PasswordType* parameter: 1 for authentication, and 2 for encryption (privacy). The password corresponding to *User* (if any) must be provided in the *Password* parameter. If the password is valid, processing will continue to other events such as [GetRequest](#getrequest-event-snmpagent-control), [SetRequest](#setrequest-event-snmpagent-control), etc. If the *PasswordType* parameter is 1 (authentication is used), the *Algorithm* parameter can be set. Possible values are: | | | | --- | --- | | Value | Authentication Algorithm | | 0 (default) | Any | | 1 | MD5 | | 2 | SHA1 | | 3 | SHA256 | | 4 | SHA512 | If the *PasswordType* parameter is 2 (encryption is used), the *Algorithm* parameter must also be set. Possible values are: | | | | --- | --- | | Value | Encryption Algorithm | | 1 (default) | DES | | 2 | AES | | 3 | 3DES | | 4 | AES192 | | 5 | AES256 | If the password does not match the signature in the request, a [BadPacket](#badpacket-event-snmpagent-control) event will be fired, at which point you can decide whether to report the error to the client (see the description of the [BadPacket](#badpacket-event-snmpagent-control) 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](#badpacket-event-snmpagent-control) event being fired, at which point you can decide whether to report the error to the client or not. # GetUserSecurityLevel Event ([SNMPAgent](#snmpagent-control) Control) Sets the security level for an incoming packet. ## Syntax ```text Sub snmpagentcontrol_GetUserSecurityLevel(User As String, EngineId As String, SecurityLevel As Integer) ``` ## Remarks The GetUserSecurityLevel event is fired after the first inspection of each SNMPv3 request. The *SecurityLevel* parameter determines the level of security for the message. On entry, the *SecurityLevel* parameter contains the default security level for *User* if the user is located in the internal cache, or if the *User* is not found in the cache, the *SecurityLevel* will be -1. The value of *SecurityLevel* upon exiting the event, determines how the message will be processed: | | | | --- | --- | | -1 | The message will be ignored and a [BadPacket](#badpacket-event-snmpagent-control) 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](#getuserpassword-event-snmpagent-control) 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](#getuserpassword-event-snmpagent-control) event will be fired twice: first to verify the authentication password, and then to verify the privacy password. | # HashPassword Event ([SNMPAgent](#snmpagent-control) Control) Fired before and after a password is hashed. ## Syntax ```text Sub snmpagentcontrol_HashPassword(Password As String, AuthAlgorithm As Integer, Hash As String) ``` ## Remarks SNMPv3 passwords are hashed in order to obtain authentication and encryption keys. This is an expensive operation, and in certain situations it may be preferable to store the hashed passwords externally and supply them on demand. If a hash is required, the event fires with an empty string in the *Hash* parameter. In this case, you can choose to supply a value for the hash and stop the control from computing the hash. The event also fires every time a hash is computed. In this case, the *Hash* parameter contains the value of the computed hash. *AuthAlgorithm* contains either 1 for HMAC-MD5-96, 2 for HMAC-SHA-96 or 3 for HMAC-192-SHA-256 # PacketTrace Event ([SNMPAgent](#snmpagent-control) Control) Fired for every packet sent or received. ## Syntax ```text Sub snmpagentcontrol_PacketTrace(Packet As String, Direction As Integer, PacketAddress As String, PacketPort As Integer) ``` ## Remarks The PacketTrace event shows all the packets sent or received by the control. *Packet* contains the full contents of the datagram. *Direction* shows the direction of the packet: 1 for incoming packets, and 2 for outgoing packets. In the case of an incoming packet, *PacketAddress* and *PacketPort* identify the source of the packet. In the case of an outgoing packet, *PacketAddress* and *PacketPort* identify the destination of the packet. # ReadyToSend Event ([SNMPAgent](#snmpagent-control) Control) Fired when the control is ready to send data. ## Syntax ```text Sub snmpagentcontrol_ReadyToSend() ``` ## 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](#snmpagent-control) Control) Fired when a Report packet is received. ## Syntax ```text Sub snmpagentcontrol_Report(RequestId As Integer, SNMPVersion As Integer, Community As String, User As String, SecurityLevel As Integer, SourceAddress As String, SourcePort As Integer, ErrorIndex As Integer, ErrorStatus As Integer, ErrorDescription As String) ``` ## 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 [ObjId](#objid-property-snmpagent-control), [ObjType](#objtype-property-snmpagent-control), and [ObjValue](#objvalue-property-snmpagent-control) 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](#snmpagent-control) Control) Fired when a SetRequest packet is received. ## Syntax ```text Sub snmpagentcontrol_SetRequest(RequestId As Integer, MessageId As Integer, SNMPVersion As Integer, Community As String, User As String, SecurityLevel As Integer, SourceAddress As String, SourcePort As Integer, ErrorIndex As Integer, ErrorStatus As Integer, ErrorDescription As String, Respond As Boolean) ``` ## Remarks The list of variables in the SNMP packet, including optional values and types, is provided through the Objects collection. Each object is of type SNMPObject. This type describes the [ObjId](#objid-property-snmpagent-control), [ObjType](#objtype-property-snmpagent-control), and [ObjValue](#objvalue-property-snmpagent-control) of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events. The *SourceAddress* and *SourcePort* parameters show the address and port of the sender as reported by the TCP/IP stack. The *MessageId* parameter identifies the received request. For SNMPv3, the *User* parameter shows the user that was supplied with the packet. This parameter *MUST* be used together with the *SecurityLevel* parameter which shows the level of security in the message. The *SecurityLevel* parameter shows whether the request has been authenticated. If *SecurityLevel* is 0, the request has *NOT* been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, *SecurityLevel* is 1. For an authenticated and encrypted request, *SecurityLevel* is 2. To send a response, the *Respond* parameter must be set to true. By default, this value is false, which means no response will be sent. The *ErrorStatus* parameter may also be set to a valid SNMP status code (the default value is 0, which represents no error). The following is a list of valid SNMP status code values: | | | | --- | --- | | 0 (noError) | No error. | | 1 (tooBig) | The response cannot fit in a single SNMP message. | | 2 (noSuchName) | Variable does not exist. | | 3 (badValue) | Invalid value or syntax. | | 4 (readOnly) | Variable is read-only. | | 5 (genError) | Other error (SNMPv1). | | 6 (noAccess) | Access denied. | | 7 (wrongType) | Wrong object type. | | 8 (wrongLength) | Wrong length. | | 9 (wrongEncoding) | Wrong encoding. | | 10 (wrongValue) | Wrong value. | | 11 (noCreation) | No creation. | | 12 (inconsistentValue) | Inconsistent value. | | 13 (resourceUnavailable) | Resource unavailable. | | 14 (commitFailed) | Commit failed. | | 15 (undoFailed) | Undo failed. | | 16 (authorizationError) | Authorization error. | | 17 (notWritable) | Variable is not writable. | | 18 (inconsistentName) | Inconsistent name. | The *ErrorIndex* parameter indicates the index of the first variable (object) that caused an error. The default value is 0. Variable indexes start with 0. *ErrorIndex* has no meaning when *ErrorStatus* is 0 (no error). # SSLClientAuthentication Event ([SNMPAgent](#snmpagent-control) Control) Fired when the client presents its credentials to the server. ## Syntax ```text Sub snmpagentcontrol_SSLClientAuthentication(RemoteAddress As String, RemotePort As Integer, CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean) ``` ## Remarks This event fires when a client connects to the control and presents a certificate for authentication. The *Accept* parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not. When *Accept* is False, *Status* shows why the verification failed (otherwise, *Status* contains the string "OK"). *RemoteAddress* is the IP address of the connecting client. *RemotePort* is the source port of the connecting client. *CertEncoded* is the base64 encoded certificate presented by the client. *CertSubject* is the subject of the certificate presented by the client. *CertIssuer* is the subject of the issuer of the certificate presented by the client. *Status* is the status of the certificate. *Accept* defines whether the certificate is accepted. # SSLServerAuthentication Event ([SNMPAgent](#snmpagent-control) Control) Fires when connecting to the server. ## Syntax ```text Sub snmpagentcontrol_SSLServerAuthentication(RemoteAddress As String, RemotePort As Integer, CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean) ``` ## 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 status of the certificate. *Accept* defines whether the certificate is accepted. # SSLStatus Event ([SNMPAgent](#snmpagent-control) Control) Shows the progress of the secure connection. ## Syntax ```text Sub snmpagentcontrol_SSLStatus(RemoteAddress As String, RemotePort As Integer, Message As String) ``` ## Remarks The event is fired for informational and logging purposes only. It is used to track the progress of the connection. *RemoteAddress* is the IP address of the remote machine. *RemotePort* is the port of the remote machine. *Message* is the log message. # Config Settings ([SNMPAgent](#snmpagent-control) Control) The control accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these *internal properties* is provided through the [Config](#config-method-snmpagent-control) method. ### SNMPAgent Config Settings **AuthenticationKey**: The key to use for authentication.This setting takes the hex-encoded key for authentication and may be set before calling [SendSecureTrap](#sendsecuretrap-method-snmpagent-control). **CompatibilityMode**: Whether to operate the component in a specific compatibility mode.This setting will cause the component to operate in a manner different than normal so that it is compatible with third-party products and libraries. The following table lists the possible values for this setting: | | | | --- | --- | | 0 (default) | Component operates normally for greatest compatibility. | | 1 | Component uses SNMP4j-compatible encryption (AES192 and AES256). | | 2 | Component automatically detects whether to use SNMP4j-compatible encryption (AES192 and AES256). Note: This option is only applicable when receiving packets. If you are using [SNMPMgr](SNMPMgr.md#SNMPMgr) or sending secure traps, you will need to select either 0 or 1. | **ContextEngineId**: Sets the context engine id of the SNMP entity. If set, the context engine id included in the PDU will be set. **ContextName**: Sets the context name of the SNMP entity. If set, the context name included in the PDU will be set. **DataToSend**: Sends a raw packet.This should be set to the hexadecimal representation of a packet. When set the represented packet is sent. **DecryptLogPackets**: Whether to decrypt logged packets.When set to *True* this setting will cause the control to decrypt packets logged in [PacketTrace](#packettrace-event-snmpagent-control). This only applies when using SNMP Version 3. The default is *False*. **EncryptionKey**: The key to use for encryption.This setting takes the hex-encoded key for encryption and may be set before calling [SendSecureTrap](#sendsecuretrap-method-snmpagent-control). **ForceLocalPort**: Forces the control to bind to a specific port. The default value is True, which makes the control throw an error if [LocalPort](#localport-property-snmpagent-control) is busy. When [ForceLocalPort](#ForceLocalPort) is set to False and the port is busy, the control silently chooses another random port. **IgnoreDiscoveryRequestType**: Treats other request types as discovery requests.When *True* tells the control to treat any request with an empty *EngineID* and *varBindList* as a discovery request. The default is *False*. **IncomingContextEngineId**: The engine Id of the received packet.This setting holds the engine Id of the received packet. This may be queried at any time, including from within an event, and returns the engine Id of the received packet. This is not needed in most cases, but can be used to store the incoming engine Id to send an asynchronous response later. This value is read-only. **IncomingContextName**: The context name of the received packet.This setting holds the context name of the received packet. This may be queried at any time, including from within an event, and returns the context name of the received packet. This is not needed in most cases, but can be used to store the incoming context name to send an asynchronous response later. This value is read-only. **MsgMaxSize**: The maximum supported message size.This setting specifies the maximum supported message size in bytes. This is only applicable when [SNMPVersion](#snmpversion-property-snmpagent-control) is set to 3. This corresponds to the "msgMaxSize" field in the request. The default maximum message size is *16384* bytes. **RespondFromDestIP**: Whether to respond from the IP address that the request was sent to.By default the control will always respond from the interface defined by [LocalHost](#localhost-property-snmpagent-control). In the case where aliases have been defined on the system, incoming traffic may have a different value for the destination. This setting tells the control to respond using a source address that matches the destination address of the received packet. This setting should only be set to True if there is a specific reason to do so. **SourceAddress**: The source address of the received packet.This setting holds the source address of the received packet. This may be queried at any time, including from within an event, and returns the source address of the received packet. This value is read-only. **SourcePort**: The source port of the received packet.This setting holds the source port of the received packet. This may be queried at any time, including from within an event, and returns the source port of the received packet. This value is read-only. **TimeWindow**: The time window used for SNMPv3 timeliness checking (authentication).The default value is 150 (seconds). **TrapAgentAddress**: The address of the object generating the trap.This setting is used to specify the agent-addr field when sending V1 Traps. The default value is the address of the localhost. This value must be an IPv4 address. **TrapCommunity**: The value of the Community parameter for SNMP traps.Typical values are "public" or "private". The default value is "public". **TrapEnterprise**: The type of the object generating the trap.This setting specifies the type of object generating the SNMP Trap. The default value is "1.3.6.1.6.3.1.1.5" (i.e. SNMPv2-MIB::snmpTraps). **TrapPort**: The port where SNMP traps are sent. The *TrapPort* is the UDP port where SNMP traps are sent. A valid port number (a value between 1 and 65535) is required. The default value is 162. ### UDP Config Settings **CaptureIPPacketInfo**: Used to capture the packet information.If this is set to True, the component will capture the IP packet information. The default value for this setting is False. NOTE: This configuration setting is available only in Windows. **DelayHostResolution**: Whether the hostname is resolved when RemoteHost is set.This configuration setting specifies whether a hostname is resolved immediately when RemoteHost is set. If *True* the control will resolve the hostname and the IP address will be present in the RemoteHost property. If *False*, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, ResolveRemoteHost may be called to manually resolve the value in RemoteHost at any time. The default value is *False*. **DestinationAddress**: Used to get the destination address from the packet information.If [CaptureIPPacketInfo](#CaptureIPPacketInfo) is set to True, then this will be populated with the packet's destination address when a packet is received. This information will be accessible in the DataIn event. NOTE: This configuration setting is available only in Windows. **DontFragment**: Used to set the Don't Fragment flag of outgoing packets.When set to True, packets sent by the control will have the Don't Fragment flag set. The default value is False. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-snmpagent-control) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface. If the control is connected, the [LocalHost](#localhost-property-snmpagent-control) setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). **LocalPort**: The port in the local host where the control binds. This configuration setting must be set before a connection is attempted. It instructs the control to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by [LocalPort](#localport-property-snmpagent-control) after the connection is established. [LocalPort](#localport-property-snmpagent-control) 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. **MaxPacketSize**: The maximum length of the packets that can be received.This configuration setting specifies the maximum size of the datagrams that the control will accept without truncation. **QOSDSCPValue**: Used to specify an arbitrary QOS/DSCP setting (optional).[UseConnection](#UseConnection) must be True to use this configuration setting. This option allows you to specify an arbitrary DSCP value between 0 and 63. The default is 0. When set to the default value, the component will not set a DSCP value. NOTE: This configuration setting uses the qWAVE API and is available only on Windows 7, Windows Server 2008 R2, and later. **QOSTrafficType**: Used to specify QOS/DSCP settings (optional).[UseConnection](#UseConnection) must be True to use this setting. You may specify either the text or integer values: BestEffort (0), Background (1), ExcellentEffort (2), AudioVideo (3), Voice (4), and Control (5). 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](#active-property-snmpagent-control) to True. **ShareLocalPort**: If set to True, allows more than one instance of the control to be active on the same local port.This option must be set before the control is activated through the [Active](#active-property-snmpagent-control) property or it will have no effect. The default value for this setting is False. **UseConnection**: Determines whether to use a connected socket.[UseConnection](#UseConnection) specifies whether or not the control should use a connected socket. The connection is defined as an association in between the local address/port and the remote address/port. As such, this is not a connection in the traditional Transmission Control Protocol (TCP) sense. It means only that the control will send and receive data to and from the specified destination. The default value for this setting is False. **UseIPv6**: Whether or not to use IPv6.By default, the component expects an IPv4 address for local and remote host properties, and it will create an IPv4 socket. To use IPv6 instead, set this to True. ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within Timeout seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### Base Config Settings **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *True* to mask sensitive data. The default is *True*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *False*, the control will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *True* tells the control to use the internal implementation instead of using the system security libraries. This setting is set to *False* by default on all platforms. # Trappable Errors ([SNMPAgent](#snmpagent-control) Control) ### SNMPAgent Errors | | | | --- | --- | | 20202 | Timeout. | | 20302 | Bad Object Index. | | 20303 | Value exceeds maximum number of objects allowed. | | 20304 | The value must be an IP address in dotted format. | | 20306 | Unsupported SNMP version. | | 20307 | Unknown PDU type. | | 20308 | The control is busy performing the current action. | | 20309 | Verification failed. | | 20310 | Missing password for Verification. | | 20311 | Missing signature. | | 20312 | Missing remote time. | | 20313 | Missing timeout value. | | 20314 | Decryption Failed. | | 20315 | Missing password for decryption. | | 20316 | Not encrypted. | | 20317 | Security model not supported. | | 20318 | Defective packet | | 20319 | Not from bound point. | | 20320 | Operation not permitted in current role. | | 20321 | Bad packet. | | 20322 | Message not authenticated. | | 20323 | No such oid. | | 20324 | Missing privacy parameter. | | 20325 | Bad engine id. | | 20326 | Bad time frame. | | 20327 | Bad user name. | | 20328 | Security level was not accepted. | | 20329 | Discovery failed. | | 20330 | Incorrect key length. | | 20331 | No authentication password supplied. | The control may also return one of the following error codes, which are inherited from other controls. ### UDP Errors | | | | --- | --- | | 20105 | UDP is already [Active](#active-property-snmpagent-control). | | 20107 | You cannot change the [LocalPort](#localport-property-snmpagent-control) while the control is [Active](#active-property-snmpagent-control). | | 20108 | You cannot change the [LocalHost](#localhost-property-snmpagent-control) at this time. A connection is in progress. | | 20110 | The control must be [Active](#active-property-snmpagent-control) for this operation. | | 20113 | You cannot change [MaxPacketSize](#MaxPacketSize) while the control is [Active](#active-property-snmpagent-control). | | 20114 | You cannot change [ShareLocalPort](#ShareLocalPort) option while the control is [Active](#active-property-snmpagent-control). | | 20115 | You cannot change RemoteHost when [UseConnection](#UseConnection) is set and the control [Active](#active-property-snmpagent-control). | | 20116 | You cannot change RemotePort when [UseConnection](#UseConnection) is set and the control is [Active](#active-property-snmpagent-control). | | 20117 | RemotePort cannot be zero when [UseConnection](#UseConnection) is set. Please specify a valid service port number. | | 20118 | You cannot change [UseConnection](#UseConnection) while the control is [Active](#active-property-snmpagent-control). | | 20119 | Message cannot be longer than [MaxPacketSize](#MaxPacketSize). | | 20120 | Message too short. | | 20435 | Unable to convert string to selected CodePage. | ### SSL Errors | | | | --- | --- | | 20271 | Cannot load specified security library. | | 20272 | Cannot open certificate store. | | 20273 | Cannot find specified certificate. | | 20274 | Cannot acquire security credentials. | | 20275 | Cannot find certificate chain. | | 20276 | Cannot verify certificate chain. | | 20277 | Error during handshake. | | 20281 | Error verifying certificate. | | 20282 | Could not find client certificate. | | 20283 | Could not find server certificate. | | 20284 | Error encrypting data. | | 20285 | Error decrypting data. | ### TCP/IP Errors | | | | --- | --- | | 25005 | [10004] Interrupted system call. | | 25010 | [10009] Bad file number. | | 25014 | [10013] Access denied. | | 25015 | [10014] Bad address. | | 25023 | [10022] Invalid argument. | | 25025 | [10024] Too many open files. | | 25036 | [10035] Operation would block. | | 25037 | [10036] Operation now in progress. | | 25038 | [10037] Operation already in progress. | | 25039 | [10038] Socket operation on nonsocket. | | 25040 | [10039] Destination address required. | | 25041 | [10040] Message is too long. | | 25042 | [10041] Protocol wrong type for socket. | | 25043 | [10042] Bad protocol option. | | 25044 | [10043] Protocol is not supported. | | 25045 | [10044] Socket type is not supported. | | 25046 | [10045] Operation is not supported on socket. | | 25047 | [10046] Protocol family is not supported. | | 25048 | [10047] Address family is not supported by protocol family. | | 25049 | [10048] Address already in use. | | 25050 | [10049] Cannot assign requested address. | | 25051 | [10050] Network is down. | | 25052 | [10051] Network is unreachable. | | 25053 | [10052] Net dropped connection or reset. | | 25054 | [10053] Software caused connection abort. | | 25055 | [10054] Connection reset by peer. | | 25056 | [10055] No buffer space available. | | 25057 | [10056] Socket is already connected. | | 25058 | [10057] Socket is not connected. | | 25059 | [10058] Cannot send after socket shutdown. | | 25060 | [10059] Too many references, cannot splice. | | 25061 | [10060] Connection timed out. | | 25062 | [10061] Connection refused. | | 25063 | [10062] Too many levels of symbolic links. | | 25064 | [10063] File name is too long. | | 25065 | [10064] Host is down. | | 25066 | [10065] No route to host. | | 25067 | [10066] Directory is not empty | | 25068 | [10067] Too many processes. | | 25069 | [10068] Too many users. | | 25070 | [10069] Disc Quota Exceeded. | | 25071 | [10070] Stale NFS file handle. | | 25072 | [10071] Too many levels of remote in path. | | 25092 | [10091] Network subsystem is unavailable. | | 25093 | [10092] WINSOCK DLL Version out of range. | | 25094 | [10093] Winsock is not loaded yet. | | 26002 | [11001] Host not found. | | 26003 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 26004 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 26005 | [11004] Valid name, no data record (check DNS setup). |