Skip to content

v3.1.5 cumulative: C-string, user tuning, BER #60 hardening, #64 snmpTrapOID.0 RFC3416 fix #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
syntax1269 wants to merge 1 commit into from
Closed

v3.1.5 cumulative: C-string, user tuning, BER #60 hardening, #64 snmpTrapOID.0 RFC3416 fix #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
195 changes: 182 additions & 13 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

31 changes: 24 additions & 7 deletions examples/ESP32_SNMP/ESP32_SNMP.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,27 @@
#if defined (ESP8266)
#include <ESP8266WiFi.h> // ESP8266 Core WiFi Library
#include <ESP8266WiFi.h> // ESP8266 Core WiFi Library
#else
#include <WiFi.h> // ESP32 Core WiFi Library
#include <WiFi.h> // ESP32 Core WiFi Library
#endif

/* -------------------------------------------------------------------------- *
* COMPILE-TIME TUNING (optional, BEFORE #include <SNMP_Agent.h>)
*
* All SNMP size constants in src/include/defs.h are wrapped with
* `#ifndef ... #endif` so a sketch-side #define placed here wins over the
* library defaults. Good targets for ESP-01 1 MB / 80 KB RAM sensors:
*
* #define SNMP_MAX_COMPLEX_CHILDREN 8
* #define SNMP_MAX_VARBINDS 4
* #define SNMP_MAX_CALLBACKS_PER_AGENT 16
* #define SNMP_MAX_TRAPS_INFLIGHT 4
* #define SNMP_POOL_ASN_OBJECTS 32
* #define SNMP_POOL_VARBIND_OBJECTS 12
*
* Saves ~25 KB BSS (ASNPool halves: (64 - 32) * 768 B = 24,576 B) and a
* few KB more from smaller fixed callback/varbind arrays.
* -------------------------------------------------------------------------- */

#include <WiFiUdp.h>
#include <SNMP_Agent.h>
#include <SNMPTrap.h>
Expand All @@ -21,19 +39,20 @@ int settableNumber = 0;
uint32_t tensOfMillisCounter = 0;

// arbitrary data will be stored here to act as an OPAQUE data-type
uint8_t* stuff = 0;
uint8_t stuff[4];


// If we want to change the functionaality of an OID callback later, store them here.
ValueCallback* changingNumberOID;
ValueCallback* settableNumberOID;
TimestampCallback* timestampCallbackOID;

std::string staticString = "This value will never change";
char staticString[] = "This value will never change";

// Setup an SNMPTrap for later use
SNMPTrap* settableNumberTrap = new SNMPTrap("public", SNMP_VERSION_2C);
char* changingString;
char _changingStringBuf[25];
char* changingString = _changingStringBuf;

void setup(){
Serial.begin(115200);
Expand All @@ -57,7 +76,6 @@ void setup(){
snmp.begin();

// setup our OPAQUE data-type
stuff = (uint8_t*)malloc(4);
stuff[0] = 1;
stuff[1] = 2;
stuff[2] = 24;
Expand All @@ -80,7 +98,6 @@ void setup(){
snmp.addReadOnlyStaticStringHandler(".1.3.6.1.4.1.5.11", staticString);

// Setup read/write string
changingString = (char*)malloc(25 * sizeof(char));
snprintf(changingString, 25, "This is changeable");
snmp.addReadWriteStringHandler(".1.3.6.1.4.1.5.12", &changingString, 25, true);

Expand Down
182 changes: 118 additions & 64 deletions examples/SNMP_Sensor/SNMP_Sensor.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,61 @@
#include <WiFi.h> // ESP32 Core WiFi Library
#endif

/* -------------------------------------------------------------------------- *
* COMPILE-TIME TUNING (optional, BEFORE #include <SNMP_Agent.h>)
*
* SNMP v3.1.3+ auto-tunes itself for ESP8266: on ESP8266 the library
* activates a "_SNMP_ESP8266_TINY" profile that shrinks all static pool
* sizes so that WiFi + LittleFS + ArduinoJson + SNMP fit into 80 KB DRAM
* with headroom (~ -28 KB BSS vs the generic defaults). This sketch
* registers 34 OID callbacks, well within the ESP8266 profile budget of
* 24 callbacks + 24 ASN pool slots + 8 VarBind slots.
*
* All SNMP size constants live in src/include/defs.h and are wrapped with
* `#ifndef ... #endif`. To OVERRIDE library or auto-tune values from
* your sketch, put a #define HERE (before SNMP_Agent.h). Examples:
*
* // Reclaim capacity on bigger ESP8266 modules or ESP32 sketches:
* #define SNMP_MAX_CALLBACKS_PER_AGENT 64
* #define SNMP_POOL_ASN_OBJECTS 32
* #define SNMP_MAX_VARBINDS 16
* #define SNMP_MAX_COMPLEX_CHILDREN 16
*
* // Opt OUT of ESP8266 auto-tune entirely (use generic defaults):
* #define SNMP_SKIP_ESP8266_AUTOTUNE 1
*
* // Drop max OctetString/Opaque payload size further for tiny sensors:
* #define OCTET_TYPE_MAX_LENGTH 128
*
* Snapshot of the on-by-default ESP8266 auto-tune profile applied by
* SNMP_Agent v3.1.3+ (NOT a sketch-side define, just shown for reference):
* MAX_SNMP_PACKET_LENGTH 1024
* OCTET_TYPE_MAX_LENGTH 256
* SNMP_MAX_OID_STR_LEN 192
* SNMP_MAX_COMPLEX_CHILDREN 8
* SNMP_MAX_VARBINDS 6
* SNMP_MAX_CALLBACKS_PER_AGENT 24
* SNMP_MAX_TRAPS_INFLIGHT 4
* SNMP_MAX_CALLBACKS_PER_TRAP 8
* SNMP_POOL_ASN_OBJECTS 24
* SNMP_POOL_VARBIND_OBJECTS 8
* SNMP_POOL_SLOT_SIZE 640
* -------------------------------------------------------------------------- */

#include <WiFiUdp.h>
#include <SNMP_Agent.h>

#include <LITTLEFS.h> // For storing and retreiving previous values or states (note: SPIFFS is deprecated and replaced by LittleFS)
#include <LittleFS.h>
#define FILESYSTEM LittleFS

#if defined(ESP8266)
#define FS_BEGIN() FILESYSTEM.begin()
#define SNMP_RAND() ((uint32_t)os_random())
#elif defined(ESP32) || defined(ARDUINO_ARCH_ESP32)
#define FS_BEGIN() FILESYSTEM.begin(FORMAT_LITTLEFS_IF_FAILED)
#define SNMP_RAND() esp_random()
#endif

#include <ArduinoJson.h> // Saved data will be stored in JSON

#define FORMAT_LITTLEFS_IF_FAILED true // Be careful, this will wipe all the data stored. So you may want to set this to false once used once.
Expand All @@ -26,88 +77,88 @@ const char* rocommunity = "public"; // Read only community string
const char* rwcommunity = "private"; // Read Write community string for set commands

// RFC1213-MIB (System)
char* oidSysDescr = ".1.3.6.1.2.1.1.1.0"; // OctetString SysDescr
char* oidSysObjectID = ".1.3.6.1.2.1.1.2.0"; // OctetString SysObjectID
char* oidSysUptime = ".1.3.6.1.2.1.1.3.0"; // TimeTicks sysUptime (hundredths of seconds)
char* oidSysContact = ".1.3.6.1.2.1.1.4.0"; // OctetString SysContact
char* oidSysName = ".1.3.6.1.2.1.1.5.0"; // OctetString SysName
char* oidSysLocation = ".1.3.6.1.2.1.1.6.0"; // OctetString SysLocation
char* oidSysServices = ".1.3.6.1.2.1.1.7.0"; // Integer sysServices

std::string sysDescr = "SNMP Agent";
std::string sysObjectID = "";
int sysUptime = 0;
const char* oidSysDescr = ".1.3.6.1.2.1.1.1.0"; // OctetString SysDescr
const char* oidSysObjectID = ".1.3.6.1.2.1.1.2.0"; // OctetString SysObjectID
const char* oidSysUptime = ".1.3.6.1.2.1.1.3.0"; // TimeTicks sysUptime (hundredths of seconds)
const char* oidSysContact = ".1.3.6.1.2.1.1.4.0"; // OctetString SysContact
const char* oidSysName = ".1.3.6.1.2.1.1.5.0"; // OctetString SysName
const char* oidSysLocation = ".1.3.6.1.2.1.1.6.0"; // OctetString SysLocation
const char* oidSysServices = ".1.3.6.1.2.1.1.7.0"; // Integer sysServices

char sysDescr[] = "SNMP Agent";
char sysObjectID[] = "";
uint32_t sysUptime = 0;
char sysContactValue[255];
char *sysContact = sysContactValue;
char sysNameValue[255];
char *sysName = sysNameValue;
char sysLocationValue[255];
char *sysLocation = sysLocationValue;
int sysServices = 65; // Physical and Application
int sysServices = 65;

// ENTITY-MIB .1.3.6.1.2.1.47 - Needs to be implemented to support ENTITY-SENSOR-MIB
// An entry would be required per sensor. This is index 1.

// entityPhysicalTable
char* oidentPhysicalIndex_1 = ".1.3.6.1.2.1.47.1.1.1.1.1.1";
char* oidentPhysicalDescr_1 = ".1.3.6.1.2.1.47.1.1.1.1.2.1";
char* oidentPhysicalVendorType_1 = ".1.3.6.1.2.1.47.1.1.1.1.3.1";
char* oidentPhysicalContainedIn_1 = ".1.3.6.1.2.1.47.1.1.1.1.4.1";
char* oidentPhysicalClass_1 = ".1.3.6.1.2.1.47.1.1.1.1.5.1";
char* oidentPhysicalParentRelPos_1 = ".1.3.6.1.2.1.47.1.1.1.1.6.1";
char* oidentPhysicalName_1 = ".1.3.6.1.2.1.47.1.1.1.1.7.1";
char* oidentPhysicalHardwareRev_1 = ".1.3.6.1.2.1.47.1.1.1.1.8.1";
char* oidentPhysicalFirmwareRev_1 = ".1.3.6.1.2.1.47.1.1.1.1.9.1";
char* oidentPhysicalSoftwareRev_1 = ".1.3.6.1.2.1.47.1.1.1.1.10.1";
char* oidentPhysicalSerialNum_1 = ".1.3.6.1.2.1.47.1.1.1.1.11.1";
char* oidentPhysicalMfgName_1 = ".1.3.6.1.2.1.47.1.1.1.1.12.1";
char* oidentPhysicalModelName_1 = ".1.3.6.1.2.1.47.1.1.1.1.13.1";
char* oidentPhysicalAlias_1 = ".1.3.6.1.2.1.47.1.1.1.1.14.1";
char* oidentPhysicalAssetID_1 = ".1.3.6.1.2.1.47.1.1.1.1.15.1";
char* oidentPhysicalIsFRU_1 = ".1.3.6.1.2.1.47.1.1.1.1.16.1";
char* oidentPhysicalMfgDate_1 = ".1.3.6.1.2.1.47.1.1.1.1.17.1";
char* oidentPhysicalUris_1 = ".1.3.6.1.2.1.47.1.1.1.1.18.1";
const char* oidentPhysicalIndex_1 = ".1.3.6.1.2.1.47.1.1.1.1.1.1";
const char* oidentPhysicalDescr_1 = ".1.3.6.1.2.1.47.1.1.1.1.2.1";
const char* oidentPhysicalVendorType_1 = ".1.3.6.1.2.1.47.1.1.1.1.3.1";
const char* oidentPhysicalContainedIn_1 = ".1.3.6.1.2.1.47.1.1.1.1.4.1";
const char* oidentPhysicalClass_1 = ".1.3.6.1.2.1.47.1.1.1.1.5.1";
const char* oidentPhysicalParentRelPos_1 = ".1.3.6.1.2.1.47.1.1.1.1.6.1";
const char* oidentPhysicalName_1 = ".1.3.6.1.2.1.47.1.1.1.1.7.1";
const char* oidentPhysicalHardwareRev_1 = ".1.3.6.1.2.1.47.1.1.1.1.8.1";
const char* oidentPhysicalFirmwareRev_1 = ".1.3.6.1.2.1.47.1.1.1.1.9.1";
const char* oidentPhysicalSoftwareRev_1 = ".1.3.6.1.2.1.47.1.1.1.1.10.1";
const char* oidentPhysicalSerialNum_1 = ".1.3.6.1.2.1.47.1.1.1.1.11.1";
const char* oidentPhysicalMfgName_1 = ".1.3.6.1.2.1.47.1.1.1.1.12.1";
const char* oidentPhysicalModelName_1 = ".1.3.6.1.2.1.47.1.1.1.1.13.1";
const char* oidentPhysicalAlias_1 = ".1.3.6.1.2.1.47.1.1.1.1.14.1";
const char* oidentPhysicalAssetID_1 = ".1.3.6.1.2.1.47.1.1.1.1.15.1";
const char* oidentPhysicalIsFRU_1 = ".1.3.6.1.2.1.47.1.1.1.1.16.1";
const char* oidentPhysicalMfgDate_1 = ".1.3.6.1.2.1.47.1.1.1.1.17.1";
const char* oidentPhysicalUris_1 = ".1.3.6.1.2.1.47.1.1.1.1.18.1";

int entPhysicalIndex_1 = 1;
std::string entPhysicalDescr_1 = "Fake Temperature Sensor";
std::string entPhysicalVendorType_1 = "";
char entPhysicalDescr_1[] = "Fake Temperature Sensor";
char entPhysicalVendorType_1[] = "";
int entPhysicalContainedIn_1 = 0;
int entPhysicalClass_1 = 8; // Sensor
int entPhysicalClass_1 = 8;
int entPhysicalParentRelPos_1 = -1;
std::string entPhysicalName_1 = "";
std::string entPhysicalHardwareRev_1 = "";
std::string entPhysicalFirmwareRev_1 = "";
std::string entPhysicalSoftwareRev_1 = "";
std::string entPhysicalSerialNum_1 = "";
std::string entPhysicalMfgName_1 = "";
std::string entPhysicalModelName_11 = "";
std::string entPhysicalAlias_1 = "";
std::string entPhysicalAssetID_1 = "";
char entPhysicalName_1[] = "";
char entPhysicalHardwareRev_1[] = "";
char entPhysicalFirmwareRev_1[] = "";
char entPhysicalSoftwareRev_1[] = "";
char entPhysicalSerialNum_1[] = "";
char entPhysicalMfgName_1[] = "";
char entPhysicalModelName_11[] = "";
char entPhysicalAlias_1[] = "";
char entPhysicalAssetID_1[] = "";
int entPhysicalIsFRU_1 = 0;
std::string entPhysicalMfgDate_1 = "'0000000000000000'H"; // Special value, not sure it's correct. Or meant to be a Hex string?
std::string entPhysicalUris_1 = "";
char entPhysicalMfgDate_1[] = "'0000000000000000'H";
char entPhysicalUris_1[] = "";

// EntityPhysicalGroup

// ENTITY-SENSOR-MIB .1.3.6.1.2.1.99
// An entry would be required per sensor. This is index 1.
// Must match index in ENTITY-MIB
char* oidentPhySensorType_1 = ".1.3.6.1.2.1.99.1.1.1.1.1";
char* oidentPhySensorScale_1 = ".1.3.6.1.2.1.99.1.1.1.2.1";
char* oidentPhySensorPrecision_1 = ".1.3.6.1.2.1.99.1.1.1.3.1";
char* oidentPhySensorValue_1 = ".1.3.6.1.2.1.99.1.1.1.4.1";
char* oidentPhySensorOperStatus_1 = ".1.3.6.1.2.1.99.1.1.1.5.1";
char* oidentPhySensorUnitsDisplay_1 = ".1.3.6.1.2.1.99.1.1.1.6.1";
char* oidentPhySensorValueTimeStamp_1 = ".1.3.6.1.2.1.99.1.1.1.7.1";
char* oidentPhySensorValueUpdateRate_1 = ".1.3.6.1.2.1.99.1.1.1.8.1";
const char* oidentPhySensorType_1 = ".1.3.6.1.2.1.99.1.1.1.1.1";
const char* oidentPhySensorScale_1 = ".1.3.6.1.2.1.99.1.1.1.2.1";
const char* oidentPhySensorPrecision_1 = ".1.3.6.1.2.1.99.1.1.1.3.1";
const char* oidentPhySensorValue_1 = ".1.3.6.1.2.1.99.1.1.1.4.1";
const char* oidentPhySensorOperStatus_1 = ".1.3.6.1.2.1.99.1.1.1.5.1";
const char* oidentPhySensorUnitsDisplay_1 = ".1.3.6.1.2.1.99.1.1.1.6.1";
const char* oidentPhySensorValueTimeStamp_1 = ".1.3.6.1.2.1.99.1.1.1.7.1";
const char* oidentPhySensorValueUpdateRate_1 = ".1.3.6.1.2.1.99.1.1.1.8.1";

int entPhySensorType_1 = 8; // Celsius
int entPhySensorScale_1 = 9; // Units
int entPhySensorPrecision_1 = 0;
int entPhySensorValue_1 = 0; // Value to be updated
int entPhySensorOperStatus_1 = 1; // OK
std::string entPhySensorUnitsDisplay_1 = "Celsius";
int entPhySensorValueTimeStamp_1 = 0;
char entPhySensorUnitsDisplay_1[] = "Celsius";
uint32_t entPhySensorValueTimeStamp_1 = 0;
int entPhySensorValueUpdateRate_1 = 0; // Unknown at declaration, set later.
//************************************

Expand Down Expand Up @@ -143,9 +194,9 @@ void printFile(const char* filename);
void setup()
{
Serial.begin(115200);
if (!LITTLEFS.begin(FORMAT_LITTLEFS_IF_FAILED))
if (!FS_BEGIN())
{
Serial.println("LITTLEFS Mount Failed");
Serial.println("LittleFS Mount Failed");
return;
}
WiFi.begin(ssid, password);
Expand Down Expand Up @@ -210,7 +261,7 @@ int readFakeSensor()
{
int min = -50;
int max = 100;
return min + esp_random() % ((max + 1) - min);
return min + (int)(SNMP_RAND() % (uint32_t)((max + 1) - min));
}

#if defined(ESP32)
Expand Down Expand Up @@ -240,7 +291,7 @@ int getUptime()
void printFile(const char* filename)
{
// Open file for reading
File file = LITTLEFS.open(filename, "r");
File file = FILESYSTEM.open(filename, "r");
if (!file)
{
Serial.println(F("Failed to read file"));
Expand All @@ -258,7 +309,7 @@ void printFile(const char* filename)

bool loadSNMPValues()
{
File file = LITTLEFS.open(savedValuesFile, "r");
File file = FILESYSTEM.open(savedValuesFile, "r");
if (!file)
{
Serial.println(F("Failed to read saved values file"));
Expand Down Expand Up @@ -292,7 +343,7 @@ bool loadSNMPValues()
bool saveSNMPValues()
{

File file = LITTLEFS.open(savedValuesFile, "w");
File file = FILESYSTEM.open(savedValuesFile, "w");
if (!file)
{
Serial.println(F("Failed to open saved values file for writing"));
Expand Down Expand Up @@ -324,9 +375,12 @@ void addRFC1213MIBHandler()
snmp.addIntegerHandler(oidSysServices, &sysServices);
snmp.addTimestampHandler(oidSysUptime, &sysUptime);
// Add Settable Handlers
snmp.addReadWriteStringHandler(oidSysContact, &sysContact, 25, true);
snmp.addReadWriteStringHandler(oidSysName, &sysName, 25, true);
snmp.addReadWriteStringHandler(oidSysLocation, &sysLocation, 25, true);
// NOTE: maxLength = sizeof(_buf) matches the 255-byte storage declared above,
// so SET operations via SNMP and strlcpy() from persistent storage agree on the
// same maximum string length.
snmp.addReadWriteStringHandler(oidSysContact, &sysContact, sizeof(sysContactValue), true);
snmp.addReadWriteStringHandler(oidSysName, &sysName, sizeof(sysNameValue), true);
snmp.addReadWriteStringHandler(oidSysLocation, &sysLocation, sizeof(sysLocationValue), true);
}

void addENTITYMIBHandler()
Expand Down
Loading
Loading