SNMP

Microchip TCP/IP Stack

previous page next page

Microchip TCP/IP Stack Help

Contents | Index | Home

Previous | Up | Next

SNMP

Simple Network Management Protocol V2c (community) agent implementation of RFC 3416.

Topics

Name	Description
SNMP Public Members	Functions and variables accessible by the stack application
SNMP Internal Members	Functions and variables internal to the SNMP module
SNMP Stack Members	Functions and variables intended to be accessed only by the stack
Functions	The following table lists functions in this documentation.
Structs, Records, Enums	The following table lists structs, records, enums in this documentation.
Types	The following table lists types in this documentation.
Variables	The following table lists variables in this documentation.
Macros	The following table lists macros in this documentation.
Files	The following table lists files in this documentation.

Files

Name	Description
SNMPv3.c	Simple Network Management Protocol (SNMP) Version 3 Agent * Module for Microchip TCP/IP Stack -Provides SNMPv3 API for doing stuff * -Reference: RFCs 3410, 3411, 3412, 3413, 3414
SNMPv3.h	Simple Network Management Protocol (SNMP) Version 3 Agent * Module for Microchip TCP/IP Stack -Provides SNMPv3 API for doing stuff * -Reference: RFCs 3410, 3411, 3412, 3413, 3414
SNMPv3USM.c	Simple Network Management Protocol (SNMP) Version 3 Agent * Module for Microchip TCP/IP Stack -Provides SNMPv3 API for doing stuff * -Reference: RFCs 3410, 3411, 3412, 3413, 3414
SNMP.c	Simple Network Management Protocol (SNMP) Version 1 Agent Simple Network Management Protocol (SNMP) Version 2 community based Agent Module for Microchip TCP/IP Stack -Provides SNMP API for doing stuff * -Reference: RFC 1157 (for SNMP V1) RFC 3416 (for SNMPv2C)
SNMP.h	SNMP Defs for Microchip TCP/IP Stack *

Functions

	Name	Description
	_IsSNMPv3ValidStructure	Decode variable length structure.
	_Snmpv3IsValidAuthStructure	Decode variable length structure.
	_Snmpv3IsValidInt	Verifies variable datatype as INT and retrieves its value.
	FindOIDsFromSnmpV3Request	Finds number of varbinds in the varbind list received in a SNMPv3 pdu.
	getSnmpV2GenTrapOid	Resolves generic trap code to generic trap OID.
	IsSnmpV3ASNNull	Verifies the value type as ASN_NULL.
	IsSnmpv3ValidOID	Populates OID type, length and oid string from the received pdu.
	IsSNMPv3ValidStructure	Decode variable length structure.
	ProcessGetBulkVar	This routine process the SNMPv2c Get Bulk Request.
	ProcessGetNextVar	Retrieves next node from the MIB database.
	ProcessGetVar	Processes snmp Get request pdu.
	ProcessSnmpv3MsgData	This routine processes the snmpv3 request and parallely creates the response pdu.
	SNMPGetExactIndex	To search for exact index node in case of a Sequence variable.
	SNMPGetTrapTime	Returns trap resolve get time.
	SNMPIdRecrdValidation	Used to Restrict the access dynamic and non dynamic OID string for A perticular SNMP Version.
	SNMPIsValidSetLen	Validates the set variable data length to data type.
	Snmpv3AESDecryptRxedScopedPdu	Incoming SNMPv3 scoped PDU decryption using AES decryption protocol.
	Snmpv3AESEncryptResponseScopedPdu	outGoing SNMPv3 scoped PDU Encryption using AES encryption protocol.
	Snmpv3AuthenticateRxedPduForDataIntegrity	Authenticate an incoming SNMPV3 USM PDU using MD5 or SHA
	Snmpv3AuthenticateTxPduForDataIntegrity	Authenticate to an outgoing SNMPV3 USM PDU using MD5 or SHA
	Snmpv3AuthKeyZeroing2HmacBufLen64	Pad zero to the authentication key localized buffer.
	Snmpv3BufferPut	Copies BYTE data to dynamically allocated memory buffer.
	Snmpv3CmprTrapSecNameAndSecLvlWithUSMDb	Routine to find the index of the user name in the user data base table.
	Snmpv3ComputeHMACIpadOpadForAuthLoclzedKey	Compute HMAC inner and outer pad for authorization localized key.
	Snmpv3ComputeHmacMD5Digest	Compute HMAC - MD5 authentication code
	Snmpv3ComputeHmacShaDigest	Compute HMAC - SHA authentication code
	Snmpv3ComputeMd5HmacCode	Compute HMAC - MD5 authentication code
	Snmpv3ComputeShaHmacCode	Compute HMAC - SHA authentication code
	Snmpv3FormulateEngineID	Formulates the snmpEngineID for the SNMPV3 engine.
	Snmpv3FreeDynAllocMem	Allocated dynamic memory freeing is done by this routine.
	Snmpv3GetAuthEngineTime	Updates the snmp engine time variable 'snmpEngineTime' for the SNMPV3 engine.
	Snmpv3GetBufferData	Reads BYTE data from dynamically allocated memory buffer.
	Snmpv3GetSecurityLevel	Get Security level from authentication and Privacy type.
	Snmpv3GetTrapSecurityLevel	Routine to find the report, auth and privacy flags settings in the TRAP.
	Snmpv3Init	SNMPv3 initialization.
	Snmpv3InitializeUserDataBase	Intialize default SNMPv3 global user database.
	Snmpv3IsValidAuthStructure	Decode variable length structure.
	Snmpv3IsValidInt	Verifies variable datatype as INT and retrieves its value.
	Snmpv3MsgProcessingModelProcessPDU	This routine collects or populates the message processing model infomation from the received SNMPv3 request PDU or to the response PDU respectively.
	Snmpv3Notify	Creates and Sends SNMPv3 TRAP pdu.
	Snmpv3Pswd2LocalizedAuthKeyMD5Hashing	Convert MD5 Auth password to the localized Key using SNMPEngineID.
	Snmpv3Pswd2LocalizedAuthKeySHAHashing	Convert SHA Auth password to the localized Key using SNMPEngineID.
	Snmpv3ReportPdu	Constructs the report pdu infomration for the Report Pdu.
	Snmpv3ScopedPduProcessing	This routine collects the scoped pdu header information from the received SNMPv3 request PDU or populates to the response PDU respectively.
	Snmpv3SetErrorStatus	Set snmpv3 error status in the response pdu.
	Snmpv3TrapScopedpdu	TRAP PDU scoped pdu header construction.
	Snmpv3UserSecurityModelProcessPDU	This routine collects or populates the security model parametrs infomation from the received SNMPv3 request PDU or to the response PDU respectively.
	Snmpv3UsmAesEncryptDecryptInitVector	AES Encryption and decryption init vector.(RFC 3826 )
	Snmpv3UsmOutMsgAuthenticationParam	Both MD5 and SHA1 is used for the outgoing message authentication.
	Snmpv3USMOutMsgPrivParam	SNMP USM out message uses Privacy protocol (RFC 3826 )
	Snmpv3UsmSnmpEngnAuthPrivPswdLocalization	Convert Auth and Priv password to the localized Key using SNMPEngineID.
	Snmpv3ValidateEngineId	Validate engine ID.
	Snmpv3ValidateSecNameAndSecLvl	Vaidate security name with Security level.
	Snmpv3ValidateSecurityName	Validate SNMPV3 user name or security name.

Macros

	Name	Description
	AUTH_LOCALIZED_PASSWORD_KEY_LEN	SNMPv3 Authentication Localized passwed key lenegth size
	INVALID_INDEX	This is macro INVALID_INDEX.
	IS_SNMPV3_AUTH_STRUCTURE	This is macro IS_SNMPV3_AUTH_STRUCTURE.
	MSG_AUTHORITATIVE_HEADER_LEN	Length of SNMPv3 authoratative msg header length = Header length ( 2 + 2 bytes) + engineID ( snmpEngnIDLength bytes) engine boot( 4 bytes)+ engine time(4 bytes) +security name (securityPrimitivesOfIncomingPdu value) +authentication parameters (snmpOutMsgAuthParamLen value) +privacy parameters (snmpOutMsgAuthParamLen value)
	MSGGLOBAL_HEADER_LEN	Length of the SNMPv3 msg header(x) = Header length (2 bytes) MSGID size (type(1 byte) + length of value(1 byte)+4 bytes value) msgMAXSIZE(type + length of value +4 bytes value) msg flag(type + length of value +1 byte value) security model type(type + length of value +1 byte value)
	PRIV_LOCALIZED_PASSWORD_KEY_LEN	#define PRIV_LOCALIZED_PASSWORD_KEY_LEN 16 SNMPv3 Privacy Pasword key length size
	REPORT_RESPONSE	This is macro REPORT_RESPONSE.
	SNMP_ENGINE_MAX_MSG_SIZE	SNMP_ENGINE_MAX_MSG_SIZE is determined as the minimum of the max msg size values supported among all of the transports available to and supported by the engine.
	SNMP_MAX_MSG_SIZE	SNMP MIN and MAX message 484 bytes in size As per RFC 3411 snmpEngineMaxMessageSize and RFC 1157 ( section 4- protocol specification ) and implementation supports more than 484 whenever feasible.
	SNMP_MAX_OID_LEN_MEM_USE	This macro will be used to avoid SNMP OID memory buffer corruption
	SNMP_TRAP_COMMUNITY_MAX_LEN_MEM_USE	This macro will be used to avoid SNMP OID memory buffer corruption
	SNMP_V3	This is macro SNMP_V3.
	SNMPV3_AUTH_LOCALIZED_PASSWORD_KEY_LEN_MEM_USE	SNMPv3 authentication localized Key length for memory validation
	SNMPV3_H	This is macro SNMPV3_H.
	SNMPV3_PRIV_LOCALIZED_PASSWORD_KEY_LEN_MEM_USE	SNMPv3 privacy key length size for memory validation
	SNMPV3_USER_SECURITY_NAME_LEN_MEM_USE	User security name length for memory validation
	SNMPV3_USM_MAX_USER	User Security Model should have atleast 1 user. Default is 3. User should change as per the requirement.
	SNMPV3MSG_AUTHENTICATION_FAIL	This is macro SNMPV3MSG_AUTHENTICATION_FAIL.
	SNMPV3MSG_AUTHENTICATION_SUCCESS	This is macro SNMPV3MSG_AUTHENTICATION_SUCCESS.
	USER_SECURITY_NAME_LEN	SNMPv3 User Security Name length

Structs, Records, Enums

	Name	Description
	AccessCtrlSubSysIsAccessAllowed	Applications are the typical clients of the service(s) of the Access Control Subsystem. The following primitive is provided by the Access Control Subsystem to check if access is allowed: statusInformation = -- success or errorIndication
	dispatcherProcessPdu	Process Incoming Request or Notification PDU Dispatcher provides the following primitive to pass an incoming snmp pdu to an application.
	dispatcherStatusInfo	Generate Outgoing Request or Notification statusInformation = -- sendPduHandle if success -- errorIndication if failure
	dispathcerReturnResponsePdu	Generate Outgoing Response The PDU Dispatcher provides the following primitive for an application to return an SNMP Response PDU to the PDU Dispatcher: result = SUCCESS or FAILURE
	MsgProcModPrepareDataElements	Prepare Data Elements from an Incoming SNMP Message The Message Processing Subsystem provides this service primitive for preparing the abstract data elements from an incoming SNMP message: result = -- SUCCESS or errorIndication
	MsgProcModPrepareOutgoingMessage	Prepare Outgoing SNMP Request or Notification Message The Message Processing Subsystem provides this service primitive for preparing an outgoing SNMP Request or Notification Message
	MsgProcModPrepareResponseMessage	Prepare an Outgoing SNMP Response Message The Message Processing Subsystem provides this service primitive for preparing an outgoing SNMP Response Message: result = -- SUCCESS or FAILURE
	processResponsePdu	Process Incoming Response PDU The PDU Dispatcher provides the following primitive to pass an incoming SNMP Response PDU to an application:
	registerContextEngineID	success or errorIndication
	SecuritySysGenerateRequestMsg	This is record SecuritySysGenerateRequestMsg.
	SecuritySysGenerateResponseMsg	Generate a Response Message The Security Subsystem provides the following primitive to generate a Response message:
	StateRelease	Release State Reference Information All Subsystems which pass stateReference information also provide a primitive to release the memory that holds the referenced state information
	unregisterContextEngineID	This is record unregisterContextEngineID.

Types

	Name	Description
	INOUT_SNMP_PDU	This is type INOUT_SNMP_PDU.
	REPORT_FLAG_AND_SECURITY_LEVEL_FLAGS	This is type REPORT_FLAG_AND_SECURITY_LEVEL_FLAGS.
	SecuritySysProcessIncomingMsg	This is type SecuritySysProcessIncomingMsg.
	SNMP_ENGNID_OCTET_IDENTIFIER_VAL	The fifth octet indicates how the rest (6th and following octets) are formatted. Refer to RFC3411 section5 Page# 41
	SNMPNONMIBRECDINFO	This is type SNMPNONMIBRECDINFO.
	SNMPV3_HMAC_HASH_TYPE	Type of hash being calculated
	SNMPV3_MSG_AUTH_SEC_PARAM_RESULT	This is type SNMPV3_MSG_AUTH_SEC_PARAM_RESULT.
	SNMPV3_MSG_PRIV_SEC_PARAM_RESULT	This is type SNMPV3_MSG_PRIV_SEC_PARAM_RESULT.
	SNMPV3_PRIV_PROT_TYPE	This is type SNMPV3_PRIV_PROT_TYPE.
	SNMPV3_REQUEST_WHOLEMSG	This is type SNMPV3_REQUEST_WHOLEMSG.
	SNMPV3_RESPONSE_WHOLEMSG	This is type SNMPV3_RESPONSE_WHOLEMSG.
	snmpV3EngnUserDataBase	This is type snmpV3EngnUserDataBase.
	SNMPV3MSGDATA	SNMPv3
	snmpV3TrapConfigDataBase	snmpv3 target configuration with respect to trap.
	statusInformation	success or errorIndication
	STD_BASED_SNMP_MESSAGE_PROCESSING_MODEL	This is type STD_BASED_SNMP_MESSAGE_PROCESSING_MODEL.
	STD_BASED_SNMP_SECURITY_MODEL	Snmp Message Processing Model
	STD_BASED_SNMPV3_SECURITY_LEVEL	This is type STD_BASED_SNMPV3_SECURITY_LEVEL.
	USM_SECURITY_LEVEL	This is type USM_SECURITY_LEVEL.

Variables

	Name	Description
	authKey_iPad	This is variable authKey_iPad.
	authKey_oPad	This is variable authKey_oPad.
	authoritativeSnmpEngineBoots	The number of times that the authoritative SNMP engine has (re-)initialized itself since its snmpEngineID was last configured.
	authoritativeSnmpEngineTime	The number of seconds since the value of the authoritativeSnmpEngineBoots object last changed
	cipher_text	This is variable cipher_text.
	deciphered_text	This is variable deciphered_text.
	getZeroInstance	This variable is used for gext next request for zero instance
	gSnmpV3InPduWholeMsgBuf	Dynamic memory stub and PDU details for Incoming stored PDU
	gSnmpV3OUTPduWholeMsgBuf	Dynamic memory stub details and constructed outgoing stored PDU details
	gSNMPv3PduHeaderBuf	Response PDU construction offset details
	gSNMPv3ScopedPduDataPos	Offset to read scoped PDU data bytes for processing from dynamic memory stub
	gSNMPv3ScopedPduRequestBuf	Stored request scoped pdu details
	gSNMPv3ScopedPduResponseBuf	Processed response scoped pdu details
	gSnmpv3TrapConfigData	SNMPv3 global configuration database to be used for trap notification
	gSNMPv3TrapMsgHeaderBuf	TRAP message PDU header construction offset details
	gSnmpV3TrapOUTPduWholeMsgBuf	Dynamic memory stub details and constructed trap PDU details
	gSNMPv3TrapScopedPduResponseBuf	TRAP scoped PDU construction offset details
	gSNMPV3TrapSecurityLevel	This is variable gSNMPV3TrapSecurityLevel.
	gSnmpv3UserDBIndex	Index to the particular reference configured in User security model data base snmpV3UserDataBase.
	gUsmStatsEngineID	Global variable to find out how many times SNMPv3 engine id has been validated
	hmacAuthKeyBuf	This is variable hmacAuthKeyBuf.
	HmacMd5Digest	This is variable HmacMd5Digest.
	HmacSHADigest	This is variable HmacSHADigest.
	incomingPdu	Incoming PDU details
	incomingSnmpPDUmsgID	Retrived Incoming Msg ID value from PDU
	ivEncrptKeyOut	This is variable ivEncrptKeyOut.
	md5LocalizedAuthKey	This is variable md5LocalizedAuthKey.
	msgSecrtyParamLenOffset	This is variable msgSecrtyParamLenOffset.
	securityPrimitivesOfIncomingPdu	Incoming PDU Security primitive details.
	session_key	This is variable session_key.
	sha1LocalizedAuthKey	This is variable sha1LocalizedAuthKey.
	snmpEngineBoots	The number of times that the SNMP engine has (re-)initialized itself since snmpEngineID was last configured.
	snmpEngineID	Reserving 32 bytes for the snmpEngineID as the octet string length can vary form 5 to 32
	snmpEngineMaxMessageSize	The maximum message size the SNMP engine can handle.
	snmpEngineMsgProcessModel	Type of Message processing model used. Value Maximum range (2^31-1), RFC3411
	snmpEngineSecurityModel	Type of security model used. Value Maximum range (2^31-1), RFC3411
	snmpEngineTime	The number of seconds since the value of the snmpEngineBoots object last changed
	snmpEngineTimeOffset	Stores the time value in seconds since SNMP Engine reset
	snmpEngnIDLength	Engine ID length of the SNMP Engine
	snmpInMsgAuthParamLen	Incoming SNMPv3 msg authentication parameters string is 12 bytes long.
	snmpInMsgAuthParamStrng	Reserving 12 bytes for the incoming SNMPv3 msg authentication parameters.
	snmpInMsgPrivParamLen	Incoming SNMPv3 msg privacy parameters string is 8 bytes long.
	snmpInMsgPrvParamStrng	Reserving 8 bytes for the incoming SNMPv3 msg privacy parameters.
	snmpMsgBufSeekPos	Offset to read PDU data bytes for processing from dynamic memory stub
	snmpOutMsgAuthParamLen	Outgoing SNMPv3 msg authentication parameters string is 12 bytes long.
	snmpOutMsgAuthParamStrng	Reserving 12 bytes for the outgoing SNMPv3 msg authentication parameters.
	snmpOutMsgPrivParamLen	Outgoing SNMPv3 msg privacy parameters string is 8 bytes long.
	snmpOutMsgPrvParamStrng	Reserving 8 bytes for the outgoing SNMPv3 msg privacy parameters.
	snmpResponseSecurityFlag	Type of Security for outgoing message in response to the incoming message.
	snmpSecurityLevel	Type of security. noAuthNoPriv(0),AuthNoPriv(1),AuthPriv(3)
	snmpTrapTimer	This is variable snmpTrapTimer.
	snmpV3AesDecryptInitVector	128 Bit
	snmpV3AesEncryptInitVector	128 Bit
	snmpV3UserDataBase	This is variable snmpV3UserDataBase.

Stack API > SNMP

Contents | Index | Home

previous page start next page