snmp_agent_message.h

 
#ifndef _SNMP_AGENT_MESSAGE_H
#define _SNMP_AGENT_MESSAGE_H
 
//Dependencies
#include "core/net.h"
#include "snmp/snmp_agent.h"
 
//SNMPv1 message header overhead
#define SNMP_V1_MSG_HEADER_OVERHEAD 48
//SNMPv2c message header overhead
#define SNMP_V2C_MSG_HEADER_OVERHEAD 37
//SNMPv3 message header overhead
#define SNMP_V3_MSG_HEADER_OVERHEAD 105
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
 
typedef struct
{
   uint8_t buffer[SNMP_MAX_MSG_SIZE]; 
   size_t bufferLen;                  
   uint8_t *pos;                      
   size_t length;                     
   int32_t version;                   
#if (SNMP_V1_SUPPORT == ENABLED || SNMP_V2C_SUPPORT == ENABLED)
   const char_t *community;           
   size_t communityLen;               
#endif
#if (SNMP_V3_SUPPORT == ENABLED)
   int32_t msgId;                     
   int32_t msgMaxSize;                
   uint8_t msgFlags;                  
   int32_t msgSecurityModel;          
   const uint8_t *msgAuthEngineId;    
   size_t msgAuthEngineIdLen;         
   int32_t msgAuthEngineBoots;        
   int32_t msgAuthEngineTime;         
   const char_t *msgUserName;         
   size_t msgUserNameLen;             
   uint8_t *msgAuthParameters;        
   size_t msgAuthParametersLen;       
   const uint8_t *msgPrivParameters;  
   size_t msgPrivParametersLen;       
   const uint8_t *contextEngineId;    
   size_t contextEngineIdLen;         
   const char_t *contextName;         
   size_t contextNameLen;             
#endif
   SnmpPduType pduType;               
   int32_t requestId;                 
   int32_t errorStatus;               
   int32_t errorIndex;                
#if (SNMP_V1_SUPPORT == ENABLED)
   const uint8_t *enterpriseOid;      
   size_t enterpriseOidLen;           
   Ipv4Addr agentAddr;                
   int32_t genericTrapType;           
   int32_t specificTrapCode;          
   uint32_t timestamp;                
#endif
#if (SNMP_V2C_SUPPORT == ENABLED || SNMP_V3_SUPPORT == ENABLED)
   int32_t nonRepeaters;              
   int32_t maxRepetitions;            
#endif
   uint8_t *varBindList;              
   size_t varBindListLen;             
   size_t varBindListMaxLen;          
   size_t oidLen;                     
} SnmpMessage;
 
 
typedef struct
{
   const uint8_t *oid;
   size_t oidLen;
   uint_t objClass;
   uint_t objType;
   const uint8_t *value;
   size_t valueLen;
} SnmpVarBind;
 
 
//SNMP related functions
void snmpInitMessage(SnmpMessage *message);
error_t snmpInitResponse(SnmpAgentContext *context);
 
error_t snmpComputeMessageOverhead(SnmpMessage *message);
 
error_t snmpParseMessageHeader(SnmpMessage *message);
error_t snmpWriteMessageHeader(SnmpMessage *message);
 
error_t snmpParseCommunity(SnmpMessage *message);
error_t snmpWriteCommunity(SnmpMessage *message);
 
error_t snmpParseGlobalData(SnmpMessage *message);
error_t snmpWriteGlobalData(SnmpMessage *message);
 
error_t snmpParseSecurityParameters(SnmpMessage *message);
error_t snmpWriteSecurityParameters(SnmpMessage *message);
 
error_t snmpParseScopedPdu(SnmpMessage *message);
error_t snmpWriteScopedPdu(SnmpMessage *message);
 
error_t snmpParsePduHeader(SnmpMessage *message);
error_t snmpWritePduHeader(SnmpMessage *message);
 
error_t snmpEncodeInt32(int32_t value, uint8_t *dest, size_t *length);
error_t snmpEncodeUnsignedInt32(uint32_t value, uint8_t *dest, size_t *length);
error_t snmpEncodeUnsignedInt64(uint64_t value, uint8_t *dest, size_t *length);
 
error_t snmpDecodeInt32(const uint8_t *src, size_t length, int32_t *value);
error_t snmpDecodeUnsignedInt32(const uint8_t *src, size_t length, uint32_t *value);
error_t snmpDecodeUnsignedInt64(const uint8_t *src, size_t length, uint64_t *value);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif