reactos/include/psdk/snmp.h

   1 /*
   2   snmp.h - Header file for the Windows SNMP API
   3
   4   Written by Filip Navara <xnavara@volny.cz>
   5
   6   References (2003-08-25):
   7     http://msdn.microsoft.com/library/en-us/snmp/snmp/snmp_reference.asp
   8
   9   This library is distributed in the hope that it will be useful,
  10   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  12 */
  13
  14 #ifndef _SNMP_H
  15 #define _SNMP_H
  16
  17 #ifndef _WINDOWS_H
  18 #include <windows.h>
  19 #endif
  20
  21 #include <pshpack4.h>
  22
  23 #ifndef WINSNMPAPI
  24 #define WINSNMPAPI WINAPI
  25 #endif
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 #define DEFAULT_SNMP_PORT_UDP   161
  32 #define DEFAULT_SNMP_PORT_IPX   36879
  33 #define DEFAULT_SNMPTRAP_PORT_UDP       162
  34 #define DEFAULT_SNMPTRAP_PORT_IPX       36880
  35 #ifndef _SNMP_ASN_DEFINED
  36 #define _SNMP_ASN_DEFINED
  37 #define ASN_UNIVERSAL   0x00
  38 #define ASN_PRIMITIVE   0x00
  39 #define ASN_CONSTRUCTOR 0x20
  40 #define ASN_APPLICATION 0x40
  41 #define ASN_CONTEXT     0x80
  42 #define ASN_PRIVATE     0xC0
  43 #define SNMP_PDU_GET    (ASN_CONTEXT | ASN_CONSTRUCTOR | 0)
  44 #define SNMP_PDU_GETNEXT        (ASN_CONTEXT | ASN_CONSTRUCTOR | 1)
  45 #define SNMP_PDU_RESPONSE       (ASN_CONTEXT | ASN_CONSTRUCTOR | 2)
  46 #define SNMP_PDU_SET    (ASN_CONTEXT | ASN_CONSTRUCTOR | 3)
  47 #define SNMP_PDU_GETBULK        (ASN_CONTEXT | ASN_CONSTRUCTOR | 4)
  48 #define SNMP_PDU_V1TRAP (ASN_CONTEXT | ASN_CONSTRUCTOR | 4)
  49 #define SNMP_PDU_INFORM (ASN_CONTEXT | ASN_CONSTRUCTOR | 6)
  50 #define SNMP_PDU_TRAP   (ASN_CONTEXT | ASN_CONSTRUCTOR | 7)
  51 #define SNMP_PDU_REPORT (ASN_CONTEXT | ASN_CONSTRUCTOR | 8)
  52 #endif /* _SNMP_ASN_DEFINED */
  53 #define ASN_INTEGER     (ASN_UNIVERSAL | ASN_PRIMITIVE | 2)
  54 #define ASN_BITS        (ASN_UNIVERSAL | ASN_PRIMITIVE | 3)
  55 #define ASN_OCTETSTRING (ASN_UNIVERSAL | ASN_PRIMITIVE | 4)
  56 #define ASN_NULL        (ASN_UNIVERSAL | ASN_PRIMITIVE | 5)
  57 #define ASN_OBJECTIDENTIFIER    (ASN_UNIVERSAL | ASN_PRIMITIVE | 6)
  58 #define ASN_INTEGER32   ASN_INTEGER
  59 #define ASN_SEQUENCE    (ASN_UNIVERSAL | ASN_CONSTRUCTOR | 0x10)
  60 #define ASN_SEQUENCEOF  ASN_SEQUENCE
  61 #define ASN_IPADDRESS   (ASN_APPLICATION | ASN_PRIMITIVE | 0x00)
  62 #define ASN_COUNTER32   (ASN_APPLICATION | ASN_PRIMITIVE | 0x01)
  63 #define ASN_GAUGE32     (ASN_APPLICATION | ASN_PRIMITIVE | 0x02)
  64 #define ASN_TIMETICKS   (ASN_APPLICATION | ASN_PRIMITIVE | 0x03)
  65 #define ASN_OPAQUE      (ASN_APPLICATION | ASN_PRIMITIVE | 0x04)
  66 #define ASN_COUNTER64   (ASN_APPLICATION | ASN_PRIMITIVE | 0x06)
  67 #define ASN_UNSIGNED32  (ASN_APPLICATION | ASN_PRIMITIVE | 0x07)
  68 #define SNMP_EXCEPTION_NOSUCHOBJECT     (ASN_CONTEXT | ASN_PRIMITIVE | 0x00)
  69 #define SNMP_EXCEPTION_NOSUCHINSTANCE   (ASN_CONTEXT | ASN_PRIMITIVE | 0x01)
  70 #define SNMP_EXCEPTION_ENDOFMIBVIEW     (ASN_CONTEXT | ASN_PRIMITIVE | 0x02)
  71 #define SNMP_EXTENSION_GET      SNMP_PDU_GET
  72 #define SNMP_EXTENSION_GET_NEXT SNMP_PDU_GETNEXT
  73 #define SNMP_EXTENSION_GET_BULK SNMP_PDU_GETBULK
  74 #define SNMP_EXTENSION_SET_TEST (ASN_PRIVATE | ASN_CONSTRUCTOR | 0x0)
  75 #define SNMP_EXTENSION_SET_COMMIT       SNMP_PDU_SET
  76 #define SNMP_EXTENSION_SET_UNDO (ASN_PRIVATE | ASN_CONSTRUCTOR | 0x1)
  77 #define SNMP_EXTENSION_SET_CLEANUP      (ASN_PRIVATE | ASN_CONSTRUCTOR | 0x2)
  78 #define SNMP_ERRORSTATUS_NOERROR        0
  79 #define SNMP_ERRORSTATUS_TOOBIG 1
  80 #define SNMP_ERRORSTATUS_NOSUCHNAME     2
  81 #define SNMP_ERRORSTATUS_BADVALUE       3
  82 #define SNMP_ERRORSTATUS_READONLY       4
  83 #define SNMP_ERRORSTATUS_GENERR 5
  84 #define SNMP_ERRORSTATUS_NOACCESS       6
  85 #define SNMP_ERRORSTATUS_WRONGTYPE      7
  86 #define SNMP_ERRORSTATUS_WRONGLENGTH    8
  87 #define SNMP_ERRORSTATUS_WRONGENCODING  9
  88 #define SNMP_ERRORSTATUS_WRONGVALUE     10
  89 #define SNMP_ERRORSTATUS_NOCREATION     11
  90 #define SNMP_ERRORSTATUS_INCONSISTENTVALUE      12
  91 #define SNMP_ERRORSTATUS_RESOURCEUNAVAILABLE    13
  92 #define SNMP_ERRORSTATUS_COMMITFAILED   14
  93 #define SNMP_ERRORSTATUS_UNDOFAILED     15
  94 #define SNMP_ERRORSTATUS_AUTHORIZATIONERROR     16
  95 #define SNMP_ERRORSTATUS_NOTWRITABLE    17
  96 #define SNMP_ERRORSTATUS_INCONSISTENTNAME       18
  97 #define SNMP_GENERICTRAP_COLDSTART      0
  98 #define SNMP_GENERICTRAP_WARMSTART      1
  99 #define SNMP_GENERICTRAP_LINKDOWN       2
 100 #define SNMP_GENERICTRAP_LINKUP 3
 101 #define SNMP_GENERICTRAP_AUTHFAILURE    4
 102 #define SNMP_GENERICTRAP_EGPNEIGHLOSS   5
 103 #define SNMP_GENERICTRAP_ENTERSPECIFIC  6
 104 #define SNMP_ACCESS_NONE        0
 105 #define SNMP_ACCESS_NOTIFY      1
 106 #define SNMP_ACCESS_READ_ONLY   2
 107 #define SNMP_ACCESS_READ_WRITE  3
 108 #define SNMP_ACCESS_READ_CREATE 4
 109 #define SNMPAPI_ERROR   FALSE
 110 #define SNMPAPI_NOERROR TRUE
 111 #define SNMP_LOG_SILENT 0
 112 #define SNMP_LOG_FATAL  1
 113 #define SNMP_LOG_ERROR  2
 114 #define SNMP_LOG_WARNING        3
 115 #define SNMP_LOG_TRACE  4
 116 #define SNMP_LOG_VERBOSE        5
 117 #define SNMP_OUTPUT_TO_CONSOLE  1
 118 #define SNMP_OUTPUT_TO_LOGFILE  2
 119 #define SNMP_OUTPUT_TO_EVENTLOG 4
 120 #define SNMP_OUTPUT_TO_DEBUGGER 8
 121 #define SNMP_MAX_OID_LEN        128
 122 #define SNMP_MEM_ALLOC_ERROR    1
 123 #define SNMP_BERAPI_INVALID_LENGTH      10
 124 #define SNMP_BERAPI_INVALID_TAG 11
 125 #define SNMP_BERAPI_OVERFLOW    12
 126 #define SNMP_BERAPI_SHORT_BUFFER        13
 127 #define SNMP_BERAPI_INVALID_OBJELEM     14
 128 #define SNMP_PDUAPI_UNRECOGNIZED_PDU    20
 129 #define SNMP_PDUAPI_INVALID_ES  21
 130 #define SNMP_PDUAPI_INVALID_GT  22
 131 #define SNMP_AUTHAPI_INVALID_VERSION    30
 132 #define SNMP_AUTHAPI_INVALID_MSG_TYPE   31
 133 #define SNMP_AUTHAPI_TRIV_AUTH_FAILED   32
 134
 135 #define DEFINE_SIZEOF(x)     (sizeof(x)/sizeof((x)[0]))
 136 #define DEFINE_OID(x)        { DEFINE_SIZEOF(x),(x) }
 137 #define DEFINE_NULLOID()     { 0, NULL }
 138 #define DEFINE_NULLOCTENTS() { NULL, 0, FALSE }
 139
 140 #ifndef RC_INVOKED
 141
 142 typedef INT SNMPAPI;
 143 typedef LONG AsnInteger32;
 144 typedef ULONG AsnUnsigned32;
 145 typedef ULARGE_INTEGER AsnCounter64;
 146 typedef AsnUnsigned32 AsnCounter32;
 147 typedef AsnUnsigned32 AsnGauge32;
 148 typedef AsnUnsigned32 AsnTimeticks;
 149 typedef struct {
 150         BYTE *stream;
 151         UINT length;
 152         BOOL dynamic;
 153 } AsnOctetString, AsnBits, AsnSequence, AsnImplicitSequence, AsnIPAddress, AsnNetworkAddress, AsnDisplayString, AsnOpaque;
 154 typedef struct {
 155         UINT idLength;
 156         UINT *ids;
 157 } AsnObjectIdentifier, AsnObjectName;
 158 typedef struct {
 159         BYTE asnType;
 160         union {
 161                 AsnInteger32 number;
 162                 AsnUnsigned32 unsigned32;
 163                 AsnCounter64 counter64;
 164                 AsnOctetString string;
 165                 AsnBits bits;
 166                 AsnObjectIdentifier object;
 167                 AsnSequence sequence;
 168                 AsnIPAddress address;
 169                 AsnCounter32 counter;
 170                 AsnGauge32 gauge;
 171                 AsnTimeticks ticks;
 172                 AsnOpaque arbitrary;
 173         } asnValue;
 174 } AsnAny, AsnObjectSyntax;
 175 typedef struct {
 176         AsnObjectName name;
 177         AsnObjectSyntax value;
 178 } SnmpVarBind;
 179 typedef struct {
 180         SnmpVarBind *list;
 181         UINT len;
 182 } SnmpVarBindList;
 183
 184 VOID WINSNMPAPI SnmpExtensionClose(void);
 185 BOOL WINSNMPAPI SnmpExtensionInit(DWORD,HANDLE*,AsnObjectIdentifier*);
 186 BOOL WINSNMPAPI SnmpExtensionInitEx(AsnObjectIdentifier*);
 187 BOOL WINSNMPAPI SnmpExtensionMonitor(LPVOID);
 188 BOOL WINSNMPAPI SnmpExtensionQuery(BYTE,SnmpVarBindList*,AsnInteger32*,AsnInteger32*);
 189 BOOL WINSNMPAPI SnmpExtensionQueryEx(DWORD,DWORD,SnmpVarBindList*,AsnOctetString*,AsnInteger32*,AsnInteger32*);
 190 BOOL WINSNMPAPI SnmpExtensionTrap(AsnObjectIdentifier*,AsnInteger32*,AsnInteger32*,AsnTimeticks*,SnmpVarBindList*);
 191 DWORD WINSNMPAPI SnmpSvcGetUptime(void);
 192 VOID WINSNMPAPI SnmpSvcSetLogLevel(INT);
 193 VOID WINSNMPAPI SnmpSvcSetLogType(INT);
 194 SNMPAPI WINSNMPAPI SnmpUtilAsnAnyCpy(AsnAny*,AsnAny*);
 195 VOID WINSNMPAPI SnmpUtilAsnAnyFree(AsnAny*);
 196 VOID WINSNMPAPI SnmpUtilDbgPrint(INT,LPSTR,...);
 197 LPSTR WINSNMPAPI SnmpUtilIdsToA(UINT*,UINT);
 198 LPVOID WINSNMPAPI SnmpUtilMemAlloc(UINT);
 199 VOID WINSNMPAPI SnmpUtilMemFree(LPVOID);
 200 LPVOID WINSNMPAPI SnmpUtilMemReAlloc(LPVOID,UINT);
 201 SNMPAPI WINSNMPAPI SnmpUtilOctetsCmp(AsnOctetString*,AsnOctetString*);
 202 SNMPAPI WINSNMPAPI SnmpUtilOctetsCpy(AsnOctetString*,AsnOctetString*);
 203 VOID WINSNMPAPI SnmpUtilOctetsFree(AsnOctetString*);
 204 SNMPAPI WINSNMPAPI SnmpUtilOctetsNCmp(AsnOctetString*,AsnOctetString*,UINT);
 205 SNMPAPI WINSNMPAPI SnmpUtilOidAppend(AsnObjectIdentifier*,AsnObjectIdentifier*);
 206 SNMPAPI WINSNMPAPI SnmpUtilOidCmp(AsnObjectIdentifier*,AsnObjectIdentifier*);
 207 SNMPAPI WINSNMPAPI SnmpUtilOidCpy(AsnObjectIdentifier*,AsnObjectIdentifier*);
 208 VOID WINSNMPAPI SnmpUtilOidFree(AsnObjectIdentifier*);
 209 SNMPAPI WINSNMPAPI SnmpUtilOidNCmp(AsnObjectIdentifier*,AsnObjectIdentifier*,UINT);
 210 LPSTR WINSNMPAPI SnmpUtilOidToA(AsnObjectIdentifier*);
 211 VOID WINSNMPAPI SnmpUtilPrintAsnAny(AsnAny*);
 212 VOID WINSNMPAPI SnmpUtilPrintOid(AsnObjectIdentifier*);
 213 SNMPAPI WINSNMPAPI SnmpUtilVarBindCpy(  SnmpVarBind*,SnmpVarBind*);
 214 SNMPAPI WINSNMPAPI SnmpUtilVarBindListCpy(SnmpVarBindList*,SnmpVarBindList*);
 215 VOID WINSNMPAPI SnmpUtilVarBindFree(SnmpVarBind*);
 216 VOID WINSNMPAPI SnmpUtilVarBindListFree(SnmpVarBindList*);
 217
 218 #ifndef SNMPSTRICT
 219 #define SNMP_malloc SnmpUtilMemAlloc
 220 #define SNMP_free SnmpUtilMemFree
 221 #define SNMP_realloc SnmpUtilMemReAlloc
 222 #define SNMP_DBG_malloc SnmpUtilMemAlloc
 223 #define SNMP_DBG_free SnmpUtilMemFree
 224 #define SNMP_DBG_realloc SnmpUtilMemReAlloc
 225 #define SNMP_oidappend SnmpUtilOidAppend
 226 #define SNMP_oidcmp SnmpUtilOidCmp
 227 #define SNMP_oidcpy SnmpUtilOidCpy
 228 #define SNMP_oidfree SnmpUtilOidFree
 229 #define SNMP_oidncmp SnmpUtilOidNCmp
 230 #define SNMP_printany SnmpUtilPrintAsnAny
 231 #define SNMP_CopyVarBind SnmpUtilVarBindCpy
 232 #define SNMP_CopyVarBindList SnmpUtilVarBindListCpy
 233 #define SNMP_FreeVarBind SnmpUtilVarBindFree
 234 #define SNMP_FreeVarBindList SnmpUtilVarBindListFree
 235 #define ASN_RFC1155_IPADDRESS ASN_IPADDRESS
 236 #define ASN_RFC1155_COUNTER ASN_COUNTER32
 237 #define ASN_RFC1155_GAUGE ASN_GAUGE32
 238 #define ASN_RFC1155_TIMETICKS ASN_TIMETICKS
 239 #define ASN_RFC1155_OPAQUE ASN_OPAQUE
 240 #define ASN_RFC1213_DISPSTRING ASN_OCTETSTRING
 241 #define ASN_RFC1157_GETREQUEST SNMP_PDU_GET
 242 #define ASN_RFC1157_GETNEXTREQUEST SNMP_PDU_GETNEXT
 243 #define ASN_RFC1157_GETRESPONSE SNMP_PDU_RESPONSE
 244 #define ASN_RFC1157_SETREQUEST SNMP_PDU_SET
 245 #define ASN_RFC1157_TRAP SNMP_PDU_V1TRAP
 246 #define ASN_CONTEXTSPECIFIC ASN_CONTEXT
 247 #define ASN_PRIMATIVE ASN_PRIMITIVE
 248 #define RFC1157VarBindList SnmpVarBindList
 249 #define RFC1157VarBind SnmpVarBind
 250 #define AsnInteger AsnInteger32
 251 #define AsnCounter AsnCounter32
 252 #define AsnGauge AsnGauge32
 253 #endif /* SNMPSTRICT */
 254
 255 #endif /* RC_INVOKED */
 256
 257 #ifdef __cplusplus
 258 }
 259 #endif
 260 #include <poppack.h>
 261 #endif