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 These definitions correspond with the "storid" argument to the API
69        */
70       #define NETSNMP_DS_LIBRARY_ID     0
71       #define NETSNMP_DS_APPLICATION_ID 1
72       #define NETSNMP_DS_TOKEN_ID       2
73
74           /*
75            * These definitions correspond with the "which" argument to the API,
76            * when the storeid argument is NETSNMP_DS_LIBRARY_ID
77            */
78           /*
79            * library booleans
80            */
81       #define NETSNMP_DS_LIB_MIB_ERRORS          0
82       #define NETSNMP_DS_LIB_SAVE_MIB_DESCRS     1
83       #define NETSNMP_DS_LIB_MIB_COMMENT_TERM    2
84       #define NETSNMP_DS_LIB_MIB_PARSE_LABEL     3
85       #define NETSNMP_DS_LIB_DUMP_PACKET         4
86       #define NETSNMP_DS_LIB_LOG_TIMESTAMP       5
87       #define NETSNMP_DS_LIB_DONT_READ_CONFIGS   6    /* don't read normal config files */
88       #define NETSNMP_DS_LIB_DISABLE_CONFIG_LOAD      NETSNMP_DS_LIB_DONT_READ_CONFIGS
89       #define NETSNMP_DS_LIB_MIB_REPLACE         7    /* replace objects from latest module */
90       #define NETSNMP_DS_LIB_PRINT_NUMERIC_ENUM  8    /* print only numeric enum values */
91       #define NETSNMP_DS_LIB_PRINT_NUMERIC_OIDS  9    /* print only numeric enum values */
92       #define NETSNMP_DS_LIB_DONT_BREAKDOWN_OIDS 10   /* dont print oid indexes specially */
93       #define NETSNMP_DS_LIB_ALARM_DONT_USE_SIG  11   /* don't use the alarm() signal */
94       #define NETSNMP_DS_LIB_PRINT_FULL_OID      12   /* print fully qualified oids */
95       #define NETSNMP_DS_LIB_QUICK_PRINT         13   /* print very brief output for parsing */
96       #define NETSNMP_DS_LIB_RANDOM_ACCESS       14   /* random access to oid labels */
97       #define NETSNMP_DS_LIB_REGEX_ACCESS        15   /* regex matching to oid labels */
98       #define NETSNMP_DS_LIB_DONT_CHECK_RANGE    16   /* don't check values for ranges on send */
99       #define NETSNMP_DS_LIB_NO_TOKEN_WARNINGS   17   /* no warn about unknown config tokens */
100       #define NETSNMP_DS_LIB_NUMERIC_TIMETICKS   18   /* print timeticks as a number */
101       #define NETSNMP_DS_LIB_ESCAPE_QUOTES       19   /* shell escape quote marks in oids */
102       #define NETSNMP_DS_LIB_REVERSE_ENCODE      20   /* encode packets from back to front */
103       #define NETSNMP_DS_LIB_PRINT_BARE_VALUE    21   /* just print value (not OID = value) */
104       #define NETSNMP_DS_LIB_EXTENDED_INDEX      22   /* print extended index format [x1][x2] */
105       #define NETSNMP_DS_LIB_PRINT_HEX_TEXT      23   /* print ASCII text along with hex strings */
106       #define NETSNMP_DS_LIB_PRINT_UCD_STYLE_OID 24   /* print OID's using the UCD-style prefix suppression */
107       #define NETSNMP_DS_LIB_READ_UCD_STYLE_OID  25   /* require top-level OIDs to be prefixed with a dot */
108       #define NETSNMP_DS_LIB_HAVE_READ_PREMIB_CONFIG 26       /* have the pre-mib parsing config tokens been processed */
109       #define NETSNMP_DS_LIB_HAVE_READ_CONFIG    27   /* have the config tokens been processed */
110       #define NETSNMP_DS_LIB_QUICKE_PRINT        28
111       #define NETSNMP_DS_LIB_DONT_PRINT_UNITS    29 /* don't print UNITS suffix */
112       #define NETSNMP_DS_LIB_NO_DISPLAY_HINT     30 /* don't apply DISPLAY-HINTs */
113       #define NETSNMP_DS_LIB_16BIT_IDS           31   /* restrict requestIDs, etc to 16-bit values */
114       #define NETSNMP_DS_LIB_DONT_PERSIST_STATE  32     /* don't load config and don't load/save persistent file */
115       #define NETSNMP_DS_LIB_2DIGIT_HEX_OUTPUT   33     /* print a leading 0 on hex values <= 'f' */
116       #define NETSNMP_DS_LIB_IGNORE_NO_COMMUNITY 34     /* don't complain if no community is specified in the command arguments */
117       #define NETSNMP_DS_LIB_DISABLE_PERSISTENT_LOAD  35 /* don't load persistent file */
118       #define NETSNMP_DS_LIB_DISABLE_PERSISTENT_SAVE  36 /* don't save persistent file */
119       #define NETSNMP_DS_LIB_APPEND_LOGFILES     37 /* append, don't overwrite, log files */
120       #define NETSNMP_DS_LIB_NO_DISCOVERY        38 /* don't support RFC5343 contextEngineID discovery */
121       #define NETSNMP_DS_LIB_TSM_USE_PREFIX      39 /* TSM's simple security name mapping */
122       #define NETSNMP_DS_LIB_ALLOW_SELF_SIGNED   40 /* Certs for DTLS */
123       #define NETSNMP_DS_LIB_CLIENT_ADDR_USES_PORT 42 /* NETSNMP_DS_LIB_CLIENT_ADDR includes address and also port */
124
125           /*
126            * library integers
127            */
128       #define NETSNMP_DS_LIB_MIB_WARNINGS         0
129       #define NETSNMP_DS_LIB_SECLEVEL             1
130       #define NETSNMP_DS_LIB_SNMPVERSION          2
131       #define NETSNMP_DS_LIB_DEFAULT_PORT         3
132       #define NETSNMP_DS_LIB_OID_OUTPUT_FORMAT    4
133       #define NETSNMP_DS_LIB_PRINT_SUFFIX_ONLY    NETSNMP_DS_LIB_OID_OUTPUT_FORMAT
134       #define NETSNMP_DS_LIB_STRING_OUTPUT_FORMAT 5
135       #define NETSNMP_DS_LIB_HEX_OUTPUT_LENGTH    6
136       #define NETSNMP_DS_LIB_SERVERSENDBUF        7 /* send buffer (server) */
137       #define NETSNMP_DS_LIB_SERVERRECVBUF        8 /* receive buffer (server) */
138       #define NETSNMP_DS_LIB_CLIENTSENDBUF        9 /* send buffer (client) */
139       #define NETSNMP_DS_LIB_CLIENTRECVBUF       10 /* receive buffer (client) */
140       #define NETSNMP_DS_SSHDOMAIN_SOCK_PERM     11
141       #define NETSNMP_DS_SSHDOMAIN_DIR_PERM      12
142       #define NETSNMP_DS_SSHDOMAIN_SOCK_USER     12
143       #define NETSNMP_DS_SSHDOMAIN_SOCK_GROUP    13
144
145           /*
146            * special meanings for the default SNMP version slot (NETSNMP_DS_LIB_SNMPVERSION)
147            */
148       #ifndef NETSNMP_DISABLE_SNMPV1
149       #define NETSNMP_DS_SNMP_VERSION_1    128        /* bogus */
150       #endif
151       #ifndef NETSNMP_DISABLE_SNMPV2C
152       #define NETSNMP_DS_SNMP_VERSION_2c   1  /* real */
153       #endif
154       #define NETSNMP_DS_SNMP_VERSION_3    3  /* real */
155
156
157           /*
158            * library strings
159            */
160       #define NETSNMP_DS_LIB_SECNAME           0
161       #define NETSNMP_DS_LIB_CONTEXT           1
162       #define NETSNMP_DS_LIB_PASSPHRASE        2
163       #define NETSNMP_DS_LIB_AUTHPASSPHRASE    3
164       #define NETSNMP_DS_LIB_PRIVPASSPHRASE    4
165       #define NETSNMP_DS_LIB_OPTIONALCONFIG    5
166       #define NETSNMP_DS_LIB_APPTYPE           6
167       #define NETSNMP_DS_LIB_COMMUNITY         7
168       #define NETSNMP_DS_LIB_PERSISTENT_DIR    8
169       #define NETSNMP_DS_LIB_CONFIGURATION_DIR 9
170       #define NETSNMP_DS_LIB_SECMODEL          10
171       #define NETSNMP_DS_LIB_MIBDIRS           11
172       #define NETSNMP_DS_LIB_OIDSUFFIX         12
173       #define NETSNMP_DS_LIB_OIDPREFIX         13
174       #define NETSNMP_DS_LIB_CLIENT_ADDR       14
175       #define NETSNMP_DS_LIB_TEMP_FILE_PATTERN 15
176       #define NETSNMP_DS_LIB_AUTHMASTERKEY     16
177       #define NETSNMP_DS_LIB_PRIVMASTERKEY     17
178       #define NETSNMP_DS_LIB_AUTHLOCALIZEDKEY  18
179       #define NETSNMP_DS_LIB_PRIVLOCALIZEDKEY  19
180       #define NETSNMP_DS_LIB_APPTYPES          20
181       #define NETSNMP_DS_LIB_KSM_KEYTAB        21
182       #define NETSNMP_DS_LIB_KSM_SERVICE_NAME  22
183       /* for the client */
184       #define NETSNMP_DS_LIB_X509_CLIENT_PUB   23
185       #define NETSNMP_DS_LIB_X509_CLIENT_PRIV  24
186       #define NETSNMP_DS_LIB_X509_SERVER_CERTS 25
187       /* for the server */
188       #define NETSNMP_DS_LIB_X509_SERVER_PUB   26
189       #define NETSNMP_DS_LIB_X509_SERVER_PRIV  27
190       #define NETSNMP_DS_LIB_X509_CLIENT_CERTS 28
191       #define NETSNMP_DS_LIB_SSHTOSNMP_SOCKET  29
192
193           /*
194

FUNCTIONS

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

SEE ALSO

266       snmp_config(5), read_config(3)
267
268
269
270
2714.2 Berkeley Distribution         25 Jun 2002                 DEFAULT_STORE(3)
Impressum