1DEFAULT_STORE(3)                   Net-SNMP                   DEFAULT_STORE(3)
2
3
4

NAME

6       default_store - generic storage of global data.
7

SYNOPSIS

9       #include <net-snmp/net-snmp-config.h>
10       #include <net-snmp/config_api.h>
11
12       int netsnmp_ds_set_boolean(int store, int which, int val);
13       int netsnmp_ds_get_boolean(int store, int which);
14       int netsnmp_ds_set_int(int store, int which, int val);
15       int netsnmp_ds_get_int(int store, int which);
16       int netsnmp_ds_set_string(int store, int which,
17                                 const char *val);
18       char *netsnmp_ds_get_string(int store, int which);
19       int netsnmp_ds_register_config(u_char type,
20                                      const char *ftype,
21                                      const char *token,
22                                      int store, int which);
23       int netsnmp_ds_register_premib(u_char type,
24                                      const char *ftype,
25                                      const char *token,
26                                      int store, int which);
27       void netsnmp_ds_shutdown(void);
28

DESCRIPTION

30       The purpose of the default storage is three-fold:
31
32       1)     To  create a global storage space without creating a whole bunch
33              of globally accessible variables or  a  whole  bunch  of  access
34              functions to work with more privately restricted variables.
35
36       2)     To  provide  a single location where the thread locking needs to
37              be implemented. At the time of  this  writing,  however,  thread
38              locking is not yet in place.
39
40       3)     To  reduce  the number of cross dependencies between code pieces
41              that may or may not be linked together in  the  long  run.  This
42              provides  for a single location in which configuration data, for
43              example, can be stored for a separate section of code  that  may
44              not be linked in to the application in question.
45
46       The functions defined here implement these goals.
47
48       Currently,  three  data  types  are  supported: booleans, integers, and
49       strings. Each of these data types  have  separate  storage  spaces.  In
50       addition,  the  storage  space for each data type is divided further by
51       the application level.   Currently, there are two storage  spaces.  The
52       first  is  reserved for the SNMP library itself. The second is intended
53       for use in applications and is not modified or checked by the  library,
54       and, therefore, this is the space usable by you.
55
56       You can think of these storage spaces as being 3 arrays, something like
57       bool_storage[storeid][which],     int_storage[storeid][which],      and
58       string_storage[storeid][which].   The data is then accessed through the
59       functions defined below.  For data you wish to store, you should use  a
60       store parameter of NETSNMP_DS_APPLICATION_ID.
61
62       The storage space used by the library (for which the store parameter is
63       NETSNMP_DS_LIBRARY_ID) is defined in the  default_store.h  file,  which
64       currently contains the following defines:
65
66            */
67       /**
68        * @def NETSNMP_DS_LIBRARY_ID
69        * These definitions correspond with the "storid" argument to the API.
70        */
71       #define NETSNMP_DS_LIBRARY_ID     0
72       #define NETSNMP_DS_APPLICATION_ID 1
73       #define NETSNMP_DS_TOKEN_ID       2
74
75           /*
76            * These definitions correspond with the "which" argument to the API,
77            * when the storeid argument is NETSNMP_DS_LIBRARY_ID
78            */
79           /*
80            * library booleans
81            */
82       #define NETSNMP_DS_LIB_MIB_ERRORS          0
83       #define NETSNMP_DS_LIB_SAVE_MIB_DESCRS     1
84       #define NETSNMP_DS_LIB_MIB_COMMENT_TERM    2
85       #define NETSNMP_DS_LIB_MIB_PARSE_LABEL     3
86       #define NETSNMP_DS_LIB_DUMP_PACKET         4
87       #define NETSNMP_DS_LIB_LOG_TIMESTAMP       5
88       #define NETSNMP_DS_LIB_DONT_READ_CONFIGS   6    /* don't read normal config files */
89       #define NETSNMP_DS_LIB_DISABLE_CONFIG_LOAD      NETSNMP_DS_LIB_DONT_READ_CONFIGS
90       #define NETSNMP_DS_LIB_MIB_REPLACE         7    /* replace objects from latest module */
91       #define NETSNMP_DS_LIB_PRINT_NUMERIC_ENUM  8    /* print only numeric enum values */
92       #define NETSNMP_DS_LIB_PRINT_NUMERIC_OIDS  9    /* print only numeric enum values */
93       #define NETSNMP_DS_LIB_DONT_BREAKDOWN_OIDS 10   /* dont print oid indexes specially */
94       #define NETSNMP_DS_LIB_ALARM_DONT_USE_SIG  11   /* don't use the alarm() signal */
95       #define NETSNMP_DS_LIB_PRINT_FULL_OID      12   /* print fully qualified oids */
96       #define NETSNMP_DS_LIB_QUICK_PRINT         13   /* print very brief output for parsing */
97       #define NETSNMP_DS_LIB_RANDOM_ACCESS       14   /* random access to oid labels */
98       #define NETSNMP_DS_LIB_REGEX_ACCESS        15   /* regex matching to oid labels */
99       #define NETSNMP_DS_LIB_DONT_CHECK_RANGE    16   /* don't check values for ranges on send */
100       #define NETSNMP_DS_LIB_NO_TOKEN_WARNINGS   17   /* no warn about unknown config tokens */
101       #define NETSNMP_DS_LIB_NUMERIC_TIMETICKS   18   /* print timeticks as a number */
102       #define NETSNMP_DS_LIB_ESCAPE_QUOTES       19   /* shell escape quote marks in oids */
103       #define NETSNMP_DS_LIB_REVERSE_ENCODE      20   /* encode packets from back to front */
104       #define NETSNMP_DS_LIB_PRINT_BARE_VALUE    21   /* just print value (not OID = value) */
105       #define NETSNMP_DS_LIB_EXTENDED_INDEX      22   /* print extended index format [x1][x2] */
106       #define NETSNMP_DS_LIB_PRINT_HEX_TEXT      23   /* print ASCII text along with hex strings */
107       #define NETSNMP_DS_LIB_PRINT_UCD_STYLE_OID 24   /* print OID's using the UCD-style prefix suppression */
108       #define NETSNMP_DS_LIB_READ_UCD_STYLE_OID  25   /* require top-level OIDs to be prefixed with a dot */
109       #define NETSNMP_DS_LIB_HAVE_READ_PREMIB_CONFIG 26       /* have the pre-mib parsing config tokens been processed */
110       #define NETSNMP_DS_LIB_HAVE_READ_CONFIG    27   /* have the config tokens been processed */
111       #define NETSNMP_DS_LIB_QUICKE_PRINT        28
112       #define NETSNMP_DS_LIB_DONT_PRINT_UNITS    29 /* don't print UNITS suffix */
113       #define NETSNMP_DS_LIB_NO_DISPLAY_HINT     30 /* don't apply DISPLAY-HINTs */
114       #define NETSNMP_DS_LIB_16BIT_IDS           31   /* restrict requestIDs, etc to 16-bit values */
115       #define NETSNMP_DS_LIB_DONT_PERSIST_STATE  32     /* don't load config and don't load/save persistent file */
116       #define NETSNMP_DS_LIB_2DIGIT_HEX_OUTPUT   33     /* print a leading 0 on hex values <= 'f' */
117       #define NETSNMP_DS_LIB_IGNORE_NO_COMMUNITY 34     /* don't complain if no community is specified in the command arguments */
118       #define NETSNMP_DS_LIB_DISABLE_PERSISTENT_LOAD  35 /* don't load persistent file */
119       #define NETSNMP_DS_LIB_DISABLE_PERSISTENT_SAVE  36 /* don't save persistent file */
120       #define NETSNMP_DS_LIB_APPEND_LOGFILES     37 /* append, don't overwrite, log files */
121       #define NETSNMP_DS_LIB_NO_DISCOVERY        38 /* don't support RFC5343 contextEngineID discovery */
122       #define NETSNMP_DS_LIB_TSM_USE_PREFIX      39 /* TSM's simple security name mapping */
123       #define NETSNMP_DS_LIB_DONT_LOAD_HOST_FILES 40 /* don't read host.conf files */
124       #define NETSNMP_DS_LIB_DNSSEC_WARN_ONLY     41 /* tread DNSSEC errors as warnings */
125       #define NETSNMP_DS_LIB_CLIENT_ADDR_USES_PORT 42 /* NETSNMP_DS_LIB_CLIENT_ADDR includes address and also port */
126       #define NETSNMP_DS_LIB_DISABLE_V1          43 /* disable SNMPv1 */
127       #define NETSNMP_DS_LIB_DISABLE_V2c         44 /* disable SNMPv2c */
128       #define NETSNMP_DS_LIB_DISABLE_V3          45 /* disable SNMPv3 */
129       #define NETSNMP_DS_LIB_FILTER_SOURCE       46 /* filter pkt by source IP */
130       #define NETSNMP_DS_LIB_MAX_BOOL_ID         48 /* match NETSNMP_DS_MAX_SUBIDS */
131
132           /*
133            * library integers
134            */
135       #define NETSNMP_DS_LIB_MIB_WARNINGS         0
136       #define NETSNMP_DS_LIB_SECLEVEL             1
137       #define NETSNMP_DS_LIB_SNMPVERSION          2
138       #define NETSNMP_DS_LIB_DEFAULT_PORT         3
139       #define NETSNMP_DS_LIB_OID_OUTPUT_FORMAT    4
140       #define NETSNMP_DS_LIB_PRINT_SUFFIX_ONLY    NETSNMP_DS_LIB_OID_OUTPUT_FORMAT
141       #define NETSNMP_DS_LIB_STRING_OUTPUT_FORMAT 5
142       #define NETSNMP_DS_LIB_HEX_OUTPUT_LENGTH    6
143       #define NETSNMP_DS_LIB_SERVERSENDBUF        7 /* send buffer (server) */
144       #define NETSNMP_DS_LIB_SERVERRECVBUF        8 /* receive buffer (server) */
145       #define NETSNMP_DS_LIB_CLIENTSENDBUF        9 /* send buffer (client) */
146       #define NETSNMP_DS_LIB_CLIENTRECVBUF       10 /* receive buffer (client) */
147       #define NETSNMP_DS_SSHDOMAIN_SOCK_PERM     11
148       #define NETSNMP_DS_SSHDOMAIN_DIR_PERM      12
149       #define NETSNMP_DS_SSHDOMAIN_SOCK_USER     12
150       #define NETSNMP_DS_SSHDOMAIN_SOCK_GROUP    13
151       #define NETSNMP_DS_LIB_TIMEOUT             14
152       #define NETSNMP_DS_LIB_RETRIES             15
153       #define NETSNMP_DS_LIB_MSG_SEND_MAX        16 /* global max response size */
154       #define NETSNMP_DS_LIB_FILTER_TYPE         17 /* 0=NONE, 1=whitelist, -1=blacklist */
155       #define NETSNMP_DS_LIB_MAX_INT_ID          48 /* match NETSNMP_DS_MAX_SUBIDS */
156
157           /*
158            * special meanings for the default SNMP version slot (NETSNMP_DS_LIB_SNMPVERSION)
159            */
160       #ifndef NETSNMP_DISABLE_SNMPV1
161       #define NETSNMP_DS_SNMP_VERSION_1    128        /* bogus */
162       #endif
163       #ifndef NETSNMP_DISABLE_SNMPV2C
164       #define NETSNMP_DS_SNMP_VERSION_2c   1  /* real */
165       #endif
166       #define NETSNMP_DS_SNMP_VERSION_3    3  /* real */
167
168
169           /*
170            * library strings
171            */
172       #define NETSNMP_DS_LIB_SECNAME           0
173       #define NETSNMP_DS_LIB_CONTEXT           1
174       #define NETSNMP_DS_LIB_PASSPHRASE        2
175       #define NETSNMP_DS_LIB_AUTHPASSPHRASE    3
176       #define NETSNMP_DS_LIB_PRIVPASSPHRASE    4
177       #define NETSNMP_DS_LIB_OPTIONALCONFIG    5
178       #define NETSNMP_DS_LIB_APPTYPE           6
179       #define NETSNMP_DS_LIB_COMMUNITY         7
180       #define NETSNMP_DS_LIB_PERSISTENT_DIR    8
181       #define NETSNMP_DS_LIB_CONFIGURATION_DIR 9
182       #define NETSNMP_DS_LIB_SECMODEL          10
183       #define NETSNMP_DS_LIB_MIBDIRS           11
184       #define NETSNMP_DS_LIB_OIDSUFFIX         12
185       #define NETSNMP_DS_LIB_OIDPREFIX         13
186       #define NETSNMP_DS_LIB_CLIENT_ADDR       14
187       #define NETSNMP_DS_LIB_TEMP_FILE_PATTERN 15
188       #define NETSNMP_DS_LIB_AUTHMASTERKEY     16
189       #define NETSNMP_DS_LIB_PRIVMASTERKEY     17
190       #define NETSNMP_DS_LIB_AUTHLOCALIZEDKEY  18
191       #define NETSNMP_DS_LIB_PRIVLOCALIZEDKEY  19
192       #define NETSNMP_DS_LIB_APPTYPES          20
193       #define NETSNMP_DS_LIB_KSM_KEYTAB        21
194       #define NETSNMP_DS_LIB_KSM_SERVICE_NAME  22
195       #define NETSNMP_DS_LIB_X509_CLIENT_PUB   23
196       #define NETSNMP_DS_LIB_X509_SERVER_PUB   24
197       #define NETSNMP_DS_LIB_SSHTOSNMP_SOCKET  25
198       #define NETSNMP_DS_LIB_CERT_EXTRA_SUBDIR 26
199       #define NETSNMP_DS_LIB_HOSTNAME          27
200       #define NETSNMP_DS_LIB_X509_CRL_FILE     28
201       #define NETSNMP_DS_LIB_TLS_ALGORITMS     29
202       #define NETSNMP_DS_LIB_TLS_LOCAL_CERT    30
203       #define NETSNMP_DS_LIB_TLS_PEER_CERT     31
204       #define NETSNMP_DS_LIB_SSH_USERNAME      32
205       #define NETSNMP_DS_LIB_SSH_PUBKEY        33
206       #define NETSNMP_DS_LIB_SSH_PRIVKEY       34
207       #define NETSNMP_DS_LIB_OUTPUT_PRECISION  35
208       #define NETSNMP_DS_LIB_MAX_STR_ID        48 /* match NETSNMP_DS_MAX_SUBIDS */
209
210           /*
211

FUNCTIONS

213       int netsnmp_ds_set_boolean(int store, int which, int val);
214              Stores  TRUE  if  val  !=  0  or  else FALSE into the bool_stor‐
215              age[store][which] slot.  Returns SNMPERR_GENERR if the store and
216              which  parameters  do  not  correspond  to a valid slot, or SNM‐
217              PERR_SUCCESS otherwise.
218
219       int netsnmp_ds_get_boolean(int store, int which);
220              Returns 1 if bool_storage[store][which] is TRUE  or  0  if  not.
221              May also return SNMPERR_GENERR if the store and which parameters
222              do not correspond to a valid slot.
223
224       int netsnmp_ds_set_string(int store, int which, const char *val);
225              Stores val into the string_storage[store][which] slot.   Returns
226              SNMPERR_SUCCESS  normally,  or  SNMPERR_GENERR  if the store and
227              which parameters do not correspond to a valid slot.
228
229       char *netsnmp_ds_get_string(int store, int which);
230              Returns the string which has been  stored  in  the  string_stor‐
231              age[store][which]  slot,  or NULL if the store and which parame‐
232              ters do not correspond to a valid slot.
233
234       netsnmp_ds_set_int(int store, int which, int val);
235              Stores val into  the  int_storage[store][which]  slot.   Returns
236              SNMPERR_GENERR  if  the store and which parameters do not corre‐
237              spond to a valid slot, or SNMPERR_SUCCESS otherwise.
238
239       int netsnmp_ds_get_int(int store, int which);
240              Returns the integer which  has  been  stored  in  the  int_stor‐
241              age[store][which] slot, or SNMPERR_GENERR if the store and which
242              parameters do not correspond to a valid slot.
243
244       void netsnmp_ds_shutdown(void);
245              Reclaims memory  used  to  hold  information  gathered  by  net‐
246              snmp_ds_register_config and netsnmp_ds_register_premib.
247
248       int  netsnmp_ds_register_config(u_char  type,  const char *ftype, const
249       char *token, int store, int which);
250              Registers a configuration file directive token and  attaches  it
251              to  a  default  storage  type and slot.  Specifically, store and
252              which indicate the storage slot in the data  type  indicated  by
253              type, where type is one of the following constants: ASN_BOOLEAN,
254              ASN_INTEGER, or ASN_OCTET_STR.  The ftype variable indicates the
255              file name base string searched for the token keyword.  For exam‐
256              ple, the following call:
257
258                     netsnmp_ds_register_config(ASN_INTEGER, "snmp",  "testto‐
259                     ken", DS_APPLICATION_ID, 5)
260
261              would  indicate  that  when the snmp.conf file(s) were found and
262              parsed, that any line beginning with the word "testtoken" should
263              be  read  and  the value after "testtoken" should be stored into
264              the int_storage[DS_APPLICATION_ID][5]  slot.   For  example  the
265              following line in the configuration file:
266
267                     testtoken 502
268
269              would  set  int_storage[DS_APPLICATION_ID][5] = 502.  This func‐
270              tion returns SNMPERR_SUCCESS if the registration was  made  suc‐
271              cessfully,  or  SNMPERR_GENERR  if the registration was not made
272              (perhaps because the store and which parameters  do  not  corre‐
273              spond  to  a valid slot, or because of a memory allocation fail‐
274              ure).
275
276       int netsnmp_ds_register_premib(u_char type, const  char  *ftype,  const
277       char *token, int store, int which);
278              Analogous  to the preceding function, but the token is processed
279              before MIBs are read (this is therefore useful  for  controlling
280              MIB processing options).
281

SEE ALSO

283       snmp_config(5), netsnmp_config_api(3)
284
285
286
287
288V5.8                              25 Jun 2002                 DEFAULT_STORE(3)
Impressum