snmp_agent.h

Go to the documentation of this file.

 
#ifndef _SNMP_AGENT_H
#define _SNMP_AGENT_H
 
//Forward declaration of SnmpAgentContext structure
struct _SnmpAgentContext;
#define SnmpAgentContext struct _SnmpAgentContext
 
//Dependencies
#include "core/net.h"
#include "snmp/snmp_common.h"
#include "snmp/snmp_agent_message.h"
#include "snmp/snmp_agent_trap.h"
#include "snmp/snmp_agent_inform.h"
#include "snmp/snmp_agent_usm.h"
#include "snmp/snmp_agent_vacm.h"
#include "mibs/mib_common.h"
 
//SNMP agent support
#ifndef SNMP_AGENT_SUPPORT
   #define SNMP_AGENT_SUPPORT DISABLED
#elif (SNMP_AGENT_SUPPORT != ENABLED && SNMP_AGENT_SUPPORT != DISABLED)
   #error SNMP_AGENT_SUPPORT parameter is not valid
#endif
 
//Stack size required to run the SNMP agent
#ifndef SNMP_AGENT_STACK_SIZE
   #define SNMP_AGENT_STACK_SIZE 550
#elif (SNMP_AGENT_STACK_SIZE < 1)
   #error SNMP_AGENT_STACK_SIZE parameter is not valid
#endif
 
//Priority at which the SNMP agent should run
#ifndef SNMP_AGENT_PRIORITY
   #define SNMP_AGENT_PRIORITY OS_TASK_PRIORITY_NORMAL
#endif
 
//Maximum number of MIBs
#ifndef SNMP_AGENT_MAX_MIBS
   #define SNMP_AGENT_MAX_MIBS 8
#elif (SNMP_AGENT_MAX_MIBS < 1)
   #error SNMP_AGENT_MAX_MIBS parameter is not valid
#endif
 
//Maximum number of community strings
#ifndef SNMP_AGENT_MAX_COMMUNITIES
   #define SNMP_AGENT_MAX_COMMUNITIES 3
#elif (SNMP_AGENT_MAX_COMMUNITIES < 1)
   #error SNMP_AGENT_MAX_COMMUNITIES parameter is not valid
#endif
 
//Maximum number of users
#ifndef SNMP_AGENT_MAX_USERS
   #define SNMP_AGENT_MAX_USERS 8
#elif (SNMP_AGENT_MAX_USERS < 1)
   #error SNMP_AGENT_MAX_USERS parameter is not valid
#endif
 
//Size of the group table
#ifndef SNMP_AGENT_GROUP_TABLE_SIZE
   #define SNMP_AGENT_GROUP_TABLE_SIZE 8
#elif (SNMP_AGENT_GROUP_TABLE_SIZE < 1)
   #error SNMP_AGENT_GROUP_TABLE_SIZE parameter is not valid
#endif
 
//Size of the access table
#ifndef SNMP_AGENT_ACCESS_TABLE_SIZE
   #define SNMP_AGENT_ACCESS_TABLE_SIZE 8
#elif (SNMP_AGENT_ACCESS_TABLE_SIZE < 1)
   #error SNMP_AGENT_ACCESS_TABLE_SIZE parameter is not valid
#endif
 
//Size of the view table
#ifndef SNMP_AGENT_VIEW_TABLE_SIZE
   #define SNMP_AGENT_VIEW_TABLE_SIZE 8
#elif (SNMP_AGENT_VIEW_TABLE_SIZE < 1)
   #error SNMP_AGENT_VIEW_TABLE_SIZE parameter is not valid
#endif
 
//Application specific context
#ifndef SNMP_AGENT_PRIVATE_CONTEXT
   #define SNMP_AGENT_PRIVATE_CONTEXT
#endif
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
 
typedef error_t (*SnmpAgentRandCallback)(uint8_t *data, size_t length);
 
 
typedef struct
{
   NetInterface *interface;                        
   SnmpVersion versionMin;                         
   SnmpVersion versionMax;                         
   uint16_t port;                                  
   uint16_t trapPort;                              
   SnmpAgentRandCallback randCallback;             
} SnmpAgentSettings;
 
 
struct _SnmpAgentContext
{
   SnmpAgentSettings settings;                                
   bool_t running;                                            
   bool_t stop;                                               
   OsMutex mutex;                                             
   OsEvent event;                                             
   OsTaskId taskId;                                           
#if (OS_STATIC_TASK_SUPPORT == ENABLED)
   OsTaskTcb taskTcb;                                         
   OsStackType taskStack[SNMP_AGENT_STACK_SIZE];              
#endif
   uint8_t enterpriseOid[SNMP_MAX_OID_SIZE];                  
   size_t enterpriseOidLen;                                   
   const MibModule *mibTable[SNMP_AGENT_MAX_MIBS];            
#if (SNMP_V1_SUPPORT == ENABLED || SNMP_V2C_SUPPORT == ENABLED)
   SnmpUserEntry communityTable[SNMP_AGENT_MAX_COMMUNITIES];  
#endif
#if (SNMP_V3_SUPPORT == ENABLED)
   SnmpUserEntry userTable[SNMP_AGENT_MAX_USERS];             
#endif
#if (SNMP_AGENT_VACM_SUPPORT == ENABLED)
   SnmpGroupEntry groupTable[SNMP_AGENT_GROUP_TABLE_SIZE];    
   SnmpAccessEntry accessTable[SNMP_AGENT_ACCESS_TABLE_SIZE]; 
   SnmpViewEntry viewTable[SNMP_AGENT_VIEW_TABLE_SIZE];       
#endif
   Socket *socket;                                            
   NetInterface *localInterface;                              
   IpAddr localIpAddr;                                        
   IpAddr remoteIpAddr;                                       
   uint16_t remotePort;                                       
   int32_t requestId;                                         
   SnmpMessage request;                                       
   SnmpMessage response;                                      
   SnmpUserEntry user;                                        
#if (SNMP_V3_SUPPORT == ENABLED)
   uint8_t contextEngine[SNMP_MAX_CONTEXT_ENGINE_SIZE];       
   size_t contextEngineLen;                                   
   char_t contextName[SNMP_MAX_CONTEXT_NAME_LEN + 1];         
   systime_t systemTime;                                      
   int32_t engineBoots;                                       
   int32_t engineTime;                                        
   int32_t msgId;                                             
   uint64_t salt;                                             
   uint8_t privParameters[8];                                 
#endif
#if (SNMP_AGENT_INFORM_SUPPORT == ENABLED)
   SnmpAgentState informState;                                
   int32_t informRequestId;                                   
   systime_t informTimestamp;                                 
   uint_t informRetransmitCount;                              
   OsEvent informEvent;                                       
#if (SNMP_V3_SUPPORT == ENABLED)
   uint8_t informContextEngine[SNMP_MAX_CONTEXT_ENGINE_SIZE]; 
   size_t informContextEngineLen;                             
   int32_t informEngineBoots;                                 
   int32_t informEngineTime;                                  
   int32_t informMsgId;                                       
#endif
#endif
   SNMP_AGENT_PRIVATE_CONTEXT                                 
};
 
 
//SNMP agent related functions
void snmpAgentGetDefaultSettings(SnmpAgentSettings *settings);
 
error_t snmpAgentInit(SnmpAgentContext *context,
   const SnmpAgentSettings *settings);
 
error_t snmpAgentStart(SnmpAgentContext *context);
error_t snmpAgentStop(SnmpAgentContext *context);
 
error_t snmpAgentLoadMib(SnmpAgentContext *context, const MibModule *module);
error_t snmpAgentUnloadMib(SnmpAgentContext *context, const MibModule *module);
 
error_t snmpAgentSetVersion(SnmpAgentContext *context,
   SnmpVersion versionMin, SnmpVersion versionMax);
 
error_t snmpAgentSetEngineBoots(SnmpAgentContext *context, int32_t engineBoots);
error_t snmpAgentGetEngineBoots(SnmpAgentContext *context, int32_t *engineBoots);
 
error_t snmpAgentSetEnterpriseOid(SnmpAgentContext *context,
   const uint8_t *enterpriseOid, size_t enterpriseOidLen);
 
error_t snmpAgentSetContextEngine(SnmpAgentContext *context,
   const void *contextEngine, size_t contextEngineLen);
 
error_t snmpAgentSetContextName(SnmpAgentContext *context,
   const char_t *contextName);
 
error_t snmpAgentCreateCommunity(SnmpAgentContext *context,
   const char_t *community, SnmpAccess mode);
 
error_t snmpAgentDeleteCommunity(SnmpAgentContext *context,
   const char_t *community);
 
error_t snmpAgentCreateUser(SnmpAgentContext *context,
   const char_t *userName, SnmpAccess mode, SnmpKeyFormat keyFormat,
   SnmpAuthProtocol authProtocol, const void *authKey,
   SnmpPrivProtocol privProtocol, const void *privKey);
 
error_t snmpAgentDeleteUser(SnmpAgentContext *context, const char_t *userName);
 
error_t snmpAgentJoinGroup(SnmpAgentContext *context, const char_t *userName,
   SnmpSecurityModel securityModel, const char_t *groupName);
 
error_t snmpAgentLeaveGroup(SnmpAgentContext *context,
   const char_t *userName, SnmpSecurityModel securityModel);
 
error_t snmpAgentCreateAccess(SnmpAgentContext *context,
   const char_t *groupName, SnmpSecurityModel securityModel,
   SnmpSecurityLevel securityLevel, const char_t *contextPrefix,
   SnmpContextMatch contextMatch, const char_t *readViewName,
   const char_t *writeViewName, const char_t *notifyViewName);
 
error_t snmpAgentDeleteAccess(SnmpAgentContext *context,
   const char_t *groupName, SnmpSecurityModel securityModel,
   SnmpSecurityLevel securityLevel, const char_t *contextPrefix);
 
error_t snmpAgentCreateView(SnmpAgentContext *context,
   const char_t *viewName, const uint8_t *subtree, size_t subtreeLen,
   const uint8_t *mask, size_t maskLen, SnmpViewType type);
 
error_t snmpAgentDeleteView(SnmpAgentContext *context,
   const char_t *viewName, const uint8_t *subtree, size_t subtreeLen);
 
error_t snmpAgentSendTrap(SnmpAgentContext *context,
   const IpAddr *destIpAddr, SnmpVersion version, const char_t *userName,
   uint_t genericTrapType, uint_t specificTrapCode,
   const SnmpTrapObject *objectList, uint_t objectListSize);
 
error_t snmpAgentSendInform(SnmpAgentContext *context,
   const IpAddr *destIpAddr, SnmpVersion version, const char_t *userName,
   uint_t genericTrapType, uint_t specificTrapCode,
   const SnmpTrapObject *objectList, uint_t objectListSize);
 
void snmpAgentTask(SnmpAgentContext *context);
 
void snmpAgentDeinit(SnmpAgentContext *context);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif