]> git.ipfire.org Git - thirdparty/squid.git/blob - src/snmp_core.cc
Merged Postfix-Prefix branch: refactor inc/decrement operators from postfix to prefix...
[thirdparty/squid.git] / src / snmp_core.cc
1 /*
2 * DEBUG: section 49 SNMP support
3 * AUTHOR: Glenn Chisholm
4 *
5 * SQUID Web Proxy Cache http://www.squid-cache.org/
6 * ----------------------------------------------------------
7 *
8 * Squid is the result of efforts by numerous individuals from
9 * the Internet community; see the CONTRIBUTORS file for full
10 * details. Many organizations have provided support for Squid's
11 * development; see the SPONSORS file for full details. Squid is
12 * Copyrighted (C) 2001 by the Regents of the University of
13 * California; see the COPYRIGHT file for full details. Squid
14 * incorporates software developed and/or copyrighted by other
15 * sources; see the CREDITS file for full details.
16 *
17 * This program is free software; you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation; either version 2 of the License, or
20 * (at your option) any later version.
21 *
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
26 *
27 * You should have received a copy of the GNU General Public License
28 * along with this program; if not, write to the Free Software
29 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
30 *
31 */
32 #include "squid-old.h"
33 #include "acl/FilledChecklist.h"
34 #include "base/CbcPointer.h"
35 #include "comm.h"
36 #include "comm/Connection.h"
37 #include "comm/Loops.h"
38 #include "comm/UdpOpenDialer.h"
39 #include "ip/Address.h"
40 #include "ip/tools.h"
41 #include "snmp_core.h"
42 #include "snmp/Forwarder.h"
43
44 static void snmpPortOpened(const Comm::ConnectionPointer &conn, int errNo);
45
46 mib_tree_entry *mib_tree_head;
47 mib_tree_entry *mib_tree_last;
48
49 Comm::ConnectionPointer snmpIncomingConn;
50 Comm::ConnectionPointer snmpOutgoingConn;
51
52 static mib_tree_entry * snmpAddNodeStr(const char *base_str, int o, oid_ParseFn * parsefunction, instance_Fn * instancefunction, AggrType aggrType = atNone);
53 static mib_tree_entry *snmpAddNode(oid * name, int len, oid_ParseFn * parsefunction, instance_Fn * instancefunction, AggrType aggrType, int children,...);
54 static oid *snmpCreateOid(int length,...);
55 mib_tree_entry * snmpLookupNodeStr(mib_tree_entry *entry, const char *str);
56 int snmpCreateOidFromStr(const char *str, oid **name, int *nl);
57 SQUIDCEXTERN void (*snmplib_debug_hook) (int, char *);
58 static oid *static_Inst(oid * name, snint * len, mib_tree_entry * current, oid_ParseFn ** Fn);
59 static oid *time_Inst(oid * name, snint * len, mib_tree_entry * current, oid_ParseFn ** Fn);
60 static oid *peer_Inst(oid * name, snint * len, mib_tree_entry * current, oid_ParseFn ** Fn);
61 static oid *client_Inst(oid * name, snint * len, mib_tree_entry * current, oid_ParseFn ** Fn);
62 static void snmpDecodePacket(snmp_request_t * rq);
63 static void snmpConstructReponse(snmp_request_t * rq);
64
65 static oid_ParseFn *snmpTreeNext(oid * Current, snint CurrentLen, oid ** Next, snint * NextLen);
66 static oid_ParseFn *snmpTreeGet(oid * Current, snint CurrentLen);
67 static mib_tree_entry *snmpTreeEntry(oid entry, snint len, mib_tree_entry * current);
68 static mib_tree_entry *snmpTreeSiblingEntry(oid entry, snint len, mib_tree_entry * current);
69 extern "C" void snmpSnmplibDebug(int lvl, char *buf);
70
71 /*
72 * The functions used during startup:
73 * snmpInit
74 * snmpConnectionOpen
75 * snmpConnectionClose
76 */
77
78 /*
79 * Turns the MIB into a Tree structure. Called during the startup process.
80 */
81 void
82 snmpInit(void)
83 {
84 debugs(49, 5, "snmpInit: Building SNMP mib tree structure");
85
86 snmplib_debug_hook = snmpSnmplibDebug;
87
88 /*
89 * This following bit of evil is to get the final node in the "squid" mib
90 * without having a "search" function. A search function should be written
91 * to make this and the other code much less evil.
92 */
93 mib_tree_head = snmpAddNode(snmpCreateOid(1, 1), 1, NULL, NULL, atNone, 0);
94
95 assert(mib_tree_head);
96 debugs(49, 5, "snmpInit: root is " << mib_tree_head);
97 snmpAddNodeStr("1", 3, NULL, NULL);
98
99 snmpAddNodeStr("1.3", 6, NULL, NULL);
100
101 snmpAddNodeStr("1.3.6", 1, NULL, NULL);
102 snmpAddNodeStr("1.3.6.1", 4, NULL, NULL);
103 snmpAddNodeStr("1.3.6.1.4", 1, NULL, NULL);
104 snmpAddNodeStr("1.3.6.1.4.1", 3495, NULL, NULL);
105 mib_tree_entry *m2 = snmpAddNodeStr("1.3.6.1.4.1.3495", 1, NULL, NULL);
106
107 mib_tree_entry *n = snmpLookupNodeStr(NULL, "1.3.6.1.4.1.3495.1");
108 assert(m2 == n);
109
110 /* SQ_SYS - 1.3.6.1.4.1.3495.1.1 */
111 snmpAddNodeStr("1.3.6.1.4.1.3495.1", 1, NULL, NULL);
112 snmpAddNodeStr("1.3.6.1.4.1.3495.1.1", SYSVMSIZ, snmp_sysFn, static_Inst, atSum);
113 snmpAddNodeStr("1.3.6.1.4.1.3495.1.1", SYSSTOR, snmp_sysFn, static_Inst, atSum);
114 snmpAddNodeStr("1.3.6.1.4.1.3495.1.1", SYS_UPTIME, snmp_sysFn, static_Inst, atMax);
115
116 /* SQ_CONF - 1.3.6.1.4.1.3495.1.2 */
117 snmpAddNodeStr("1.3.6.1.4.1.3495.1", 2, NULL, NULL);
118 snmpAddNodeStr("1.3.6.1.4.1.3495.1.2", CONF_ADMIN, snmp_confFn, static_Inst);
119 snmpAddNodeStr("1.3.6.1.4.1.3495.1.2", CONF_VERSION, snmp_confFn, static_Inst);
120 snmpAddNodeStr("1.3.6.1.4.1.3495.1.2", CONF_VERSION_ID, snmp_confFn, static_Inst);
121 snmpAddNodeStr("1.3.6.1.4.1.3495.1.2", CONF_LOG_FAC, snmp_confFn, static_Inst);
122
123 /* SQ_CONF + CONF_STORAGE - 1.3.6.1.4.1.3495.1.5 */
124 snmpAddNodeStr("1.3.6.1.4.1.3495.1.2", CONF_STORAGE, NULL, NULL);
125 snmpAddNodeStr("1.3.6.1.4.1.3495.1.2.5", CONF_ST_MMAXSZ, snmp_confFn, static_Inst, atSum);
126 snmpAddNodeStr("1.3.6.1.4.1.3495.1.2.5", CONF_ST_SWMAXSZ, snmp_confFn, static_Inst, atSum);
127 snmpAddNodeStr("1.3.6.1.4.1.3495.1.2.5", CONF_ST_SWHIWM, snmp_confFn, static_Inst, atMin);
128 snmpAddNodeStr("1.3.6.1.4.1.3495.1.2.5", CONF_ST_SWLOWM, snmp_confFn, static_Inst, atMin);
129
130 snmpAddNodeStr("1.3.6.1.4.1.3495.1.2", CONF_UNIQNAME, snmp_confFn, static_Inst);
131
132 /* SQ_PRF - 1.3.6.1.4.1.3495.1.3 */
133 snmpAddNodeStr("1.3.6.1.4.1.3495.1", 3, NULL, NULL); /* SQ_PRF */
134
135 /* PERF_SYS - 1.3.6.1.4.1.3495.1.3.1 */
136 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3", PERF_SYS, NULL, NULL);
137 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.1", PERF_SYS_PF, snmp_prfSysFn, static_Inst, atSum);
138 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.1", PERF_SYS_NUMR, snmp_prfSysFn, static_Inst, atSum);
139 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.1", PERF_SYS_MEMUSAGE, snmp_prfSysFn, static_Inst, atSum);
140 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.1", PERF_SYS_CPUTIME, snmp_prfSysFn, static_Inst, atSum);
141 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.1", PERF_SYS_CPUUSAGE, snmp_prfSysFn, static_Inst, atSum);
142 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.1", PERF_SYS_MAXRESSZ, snmp_prfSysFn, static_Inst, atSum);
143 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.1", PERF_SYS_NUMOBJCNT, snmp_prfSysFn, static_Inst, atSum);
144 /*
145 Amos comments:
146 The meaning of LRU is "oldest timestamped object in cache, if LRU algorithm is
147 used"...
148 What this SMP support needs to do is aggregate via a special filter equivalent to
149 min() to retain the semantic oldest-object meaning. A special one is needed that
150 works as unsigned and ignores '0' values.
151 */
152 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.1", PERF_SYS_CURLRUEXP, snmp_prfSysFn, static_Inst);
153 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.1", PERF_SYS_CURUNLREQ, snmp_prfSysFn, static_Inst, atSum);
154 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.1", PERF_SYS_CURUNUSED_FD, snmp_prfSysFn, static_Inst, atSum);
155 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.1", PERF_SYS_CURRESERVED_FD, snmp_prfSysFn, static_Inst, atSum);
156 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.1", PERF_SYS_CURUSED_FD, snmp_prfSysFn, static_Inst, atSum);
157 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.1", PERF_SYS_CURMAX_FD, snmp_prfSysFn, static_Inst, atMax);
158
159 /* PERF_PROTO - 1.3.6.1.4.1.3495.1.3.2 */
160 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3", PERF_PROTO, NULL, NULL);
161 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2", PERF_PROTOSTAT_AGGR, NULL, NULL);
162 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.1", PERF_PROTOSTAT_AGGR_HTTP_REQ, snmp_prfProtoFn, static_Inst, atSum);
163 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.1", PERF_PROTOSTAT_AGGR_HTTP_HITS, snmp_prfProtoFn, static_Inst, atSum);
164 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.1", PERF_PROTOSTAT_AGGR_HTTP_ERRORS, snmp_prfProtoFn, static_Inst, atSum);
165 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.1", PERF_PROTOSTAT_AGGR_HTTP_KBYTES_IN, snmp_prfProtoFn, static_Inst, atSum);
166 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.1", PERF_PROTOSTAT_AGGR_HTTP_KBYTES_OUT, snmp_prfProtoFn, static_Inst, atSum);
167 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.1", PERF_PROTOSTAT_AGGR_ICP_S, snmp_prfProtoFn, static_Inst, atSum);
168 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.1", PERF_PROTOSTAT_AGGR_ICP_R, snmp_prfProtoFn, static_Inst, atSum);
169 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.1", PERF_PROTOSTAT_AGGR_ICP_SKB, snmp_prfProtoFn, static_Inst, atSum);
170 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.1", PERF_PROTOSTAT_AGGR_ICP_RKB, snmp_prfProtoFn, static_Inst, atSum);
171 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.1", PERF_PROTOSTAT_AGGR_REQ, snmp_prfProtoFn, static_Inst, atSum);
172 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.1", PERF_PROTOSTAT_AGGR_ERRORS, snmp_prfProtoFn, static_Inst, atSum);
173 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.1", PERF_PROTOSTAT_AGGR_KBYTES_IN, snmp_prfProtoFn, static_Inst, atSum);
174 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.1", PERF_PROTOSTAT_AGGR_KBYTES_OUT, snmp_prfProtoFn, static_Inst, atSum);
175 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.1", PERF_PROTOSTAT_AGGR_CURSWAP, snmp_prfProtoFn, static_Inst, atSum);
176 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.1", PERF_PROTOSTAT_AGGR_CLIENTS, snmp_prfProtoFn, static_Inst, atSum);
177
178 /* Note this is time-series rather than 'static' */
179 /* cacheMedianSvcTable */
180 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2", PERF_PROTOSTAT_MEDIAN, NULL, NULL);
181
182 /* cacheMedianSvcEntry */
183 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.2", 1, NULL, NULL);
184 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.2.1", PERF_MEDIAN_TIME, snmp_prfProtoFn, time_Inst, atAverage);
185 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.2.1", PERF_MEDIAN_HTTP_ALL, snmp_prfProtoFn, time_Inst, atAverage);
186 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.2.1", PERF_MEDIAN_HTTP_MISS, snmp_prfProtoFn, time_Inst, atAverage);
187 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.2.1", PERF_MEDIAN_HTTP_NM, snmp_prfProtoFn, time_Inst, atAverage);
188 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.2.1", PERF_MEDIAN_HTTP_HIT, snmp_prfProtoFn, time_Inst, atAverage);
189 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.2.1", PERF_MEDIAN_ICP_QUERY, snmp_prfProtoFn, time_Inst, atAverage);
190 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.2.1", PERF_MEDIAN_ICP_REPLY, snmp_prfProtoFn, time_Inst, atAverage);
191 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.2.1", PERF_MEDIAN_DNS, snmp_prfProtoFn, time_Inst, atAverage);
192 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.2.1", PERF_MEDIAN_RHR, snmp_prfProtoFn, time_Inst, atAverage);
193 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.2.1", PERF_MEDIAN_BHR, snmp_prfProtoFn, time_Inst, atAverage);
194 snmpAddNodeStr("1.3.6.1.4.1.3495.1.3.2.2.1", PERF_MEDIAN_HTTP_NH, snmp_prfProtoFn, time_Inst, atAverage);
195
196 /* SQ_NET - 1.3.6.1.4.1.3495.1.4 */
197 snmpAddNodeStr("1.3.6.1.4.1.3495.1", 4, NULL, NULL);
198
199 snmpAddNodeStr("1.3.6.1.4.1.3495.1.4", NET_IP_CACHE, NULL, NULL);
200 snmpAddNodeStr("1.3.6.1.4.1.3495.1.4.1", IP_ENT, snmp_netIpFn, static_Inst, atSum);
201 snmpAddNodeStr("1.3.6.1.4.1.3495.1.4.1", IP_REQ, snmp_netIpFn, static_Inst, atSum);
202 snmpAddNodeStr("1.3.6.1.4.1.3495.1.4.1", IP_HITS, snmp_netIpFn, static_Inst, atSum);
203 snmpAddNodeStr("1.3.6.1.4.1.3495.1.4.1", IP_PENDHIT, snmp_netIpFn, static_Inst, atSum);
204 snmpAddNodeStr("1.3.6.1.4.1.3495.1.4.1", IP_NEGHIT, snmp_netIpFn, static_Inst, atSum);
205 snmpAddNodeStr("1.3.6.1.4.1.3495.1.4.1", IP_MISS, snmp_netIpFn, static_Inst, atSum);
206 snmpAddNodeStr("1.3.6.1.4.1.3495.1.4.1", IP_GHBN, snmp_netIpFn, static_Inst, atSum);
207 snmpAddNodeStr("1.3.6.1.4.1.3495.1.4.1", IP_LOC, snmp_netIpFn, static_Inst, atSum);
208
209 snmpAddNodeStr("1.3.6.1.4.1.3495.1.4", NET_FQDN_CACHE, NULL, NULL);
210 snmpAddNodeStr("1.3.6.1.4.1.3495.1.4.2", FQDN_ENT, snmp_netFqdnFn, static_Inst, atSum);
211 snmpAddNodeStr("1.3.6.1.4.1.3495.1.4.2", FQDN_REQ, snmp_netFqdnFn, static_Inst, atSum);
212 snmpAddNodeStr("1.3.6.1.4.1.3495.1.4.2", FQDN_HITS, snmp_netFqdnFn, static_Inst, atSum);
213 snmpAddNodeStr("1.3.6.1.4.1.3495.1.4.2", FQDN_PENDHIT, snmp_netFqdnFn, static_Inst, atSum);
214 snmpAddNodeStr("1.3.6.1.4.1.3495.1.4.2", FQDN_NEGHIT, snmp_netFqdnFn, static_Inst, atSum);
215 snmpAddNodeStr("1.3.6.1.4.1.3495.1.4.2", FQDN_MISS, snmp_netFqdnFn, static_Inst, atSum);
216 snmpAddNodeStr("1.3.6.1.4.1.3495.1.4.2", FQDN_GHBN, snmp_netFqdnFn, static_Inst, atSum);
217
218 snmpAddNodeStr("1.3.6.1.4.1.3495.1.4", NET_DNS_CACHE, NULL, NULL);
219 snmpAddNodeStr("1.3.6.1.4.1.3495.1.4.3", DNS_REQ, snmp_netDnsFn, static_Inst, atSum);
220 snmpAddNodeStr("1.3.6.1.4.1.3495.1.4.3", DNS_REP, snmp_netDnsFn, static_Inst, atSum);
221 snmpAddNodeStr("1.3.6.1.4.1.3495.1.4.3", DNS_SERVERS, snmp_netDnsFn, static_Inst, atSum);
222
223 /* SQ_MESH - 1.3.6.1.4.1.3495.1.5 */
224 snmpAddNodeStr("1.3.6.1.4.1.3495.1", 5, NULL, NULL);
225
226 /* cachePeerTable - 1.3.6.1.4.1.3495.1.5.1 */
227 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5", MESH_PTBL, NULL, NULL);
228
229 /* CachePeerTableEntry (version 3) - 1.3.6.1.4.1.3495.1.5.1.3 */
230 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.1", 3, NULL, NULL);
231 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.1.3", MESH_PTBL_INDEX, snmp_meshPtblFn, peer_Inst);
232 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.1.3", MESH_PTBL_NAME, snmp_meshPtblFn, peer_Inst);
233 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.1.3", MESH_PTBL_ADDR_TYPE, snmp_meshPtblFn, peer_Inst);
234 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.1.3", MESH_PTBL_ADDR, snmp_meshPtblFn, peer_Inst);
235 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.1.3", MESH_PTBL_HTTP, snmp_meshPtblFn, peer_Inst);
236 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.1.3", MESH_PTBL_ICP, snmp_meshPtblFn, peer_Inst);
237 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.1.3", MESH_PTBL_TYPE, snmp_meshPtblFn, peer_Inst);
238 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.1.3", MESH_PTBL_STATE, snmp_meshPtblFn, peer_Inst);
239 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.1.3", MESH_PTBL_SENT, snmp_meshPtblFn, peer_Inst);
240 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.1.3", MESH_PTBL_PACKED, snmp_meshPtblFn, peer_Inst);
241 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.1.3", MESH_PTBL_FETCHES, snmp_meshPtblFn, peer_Inst);
242 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.1.3", MESH_PTBL_RTT, snmp_meshPtblFn, peer_Inst);
243 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.1.3", MESH_PTBL_IGN, snmp_meshPtblFn, peer_Inst);
244 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.1.3", MESH_PTBL_KEEPAL_S, snmp_meshPtblFn, peer_Inst);
245 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.1.3", MESH_PTBL_KEEPAL_R, snmp_meshPtblFn, peer_Inst);
246
247 /* cacheClientTable - 1.3.6.1.4.1.3495.1.5.2 */
248 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5", MESH_CTBL, NULL, NULL);
249
250 /* BUG 2811: we NEED to create a reliable index for the client DB and make version 3 of the table. */
251 /* for now we have version 2 table with OID capable of mixed IPv4 / IPv6 clients and upgraded address text format. */
252
253 /* cacheClientEntry - 1.3.6.1.4.1.3495.1.5.2.2 */
254 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.2", 2, NULL, NULL);
255 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.2.2", MESH_CTBL_ADDR_TYPE, snmp_meshCtblFn, client_Inst);
256 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.2.2", MESH_CTBL_ADDR, snmp_meshCtblFn, client_Inst);
257 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.2.2", MESH_CTBL_HTREQ, snmp_meshCtblFn, client_Inst);
258 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.2.2", MESH_CTBL_HTBYTES, snmp_meshCtblFn, client_Inst);
259 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.2.2", MESH_CTBL_HTHITS, snmp_meshCtblFn, client_Inst);
260 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.2.2", MESH_CTBL_HTHITBYTES, snmp_meshCtblFn, client_Inst);
261 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.2.2", MESH_CTBL_ICPREQ, snmp_meshCtblFn, client_Inst);
262 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.2.2", MESH_CTBL_ICPBYTES, snmp_meshCtblFn, client_Inst);
263 snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.2.2", MESH_CTBL_ICPHITS, snmp_meshCtblFn, client_Inst);
264 mib_tree_last = snmpAddNodeStr("1.3.6.1.4.1.3495.1.5.2.2", MESH_CTBL_ICPHITBYTES, snmp_meshCtblFn, client_Inst);
265
266 debugs(49, 9, "snmpInit: Completed SNMP mib tree structure");
267 }
268
269 void
270 snmpOpenPorts(void)
271 {
272 debugs(49, 5, "snmpConnectionOpen: Called");
273
274 if (Config.Port.snmp <= 0)
275 return;
276
277 snmpIncomingConn = new Comm::Connection;
278 snmpIncomingConn->local = Config.Addrs.snmp_incoming;
279 snmpIncomingConn->local.SetPort(Config.Port.snmp);
280
281 if (!Ip::EnableIpv6 && !snmpIncomingConn->local.SetIPv4()) {
282 debugs(49, DBG_CRITICAL, "ERROR: IPv6 is disabled. " << snmpIncomingConn->local << " is not an IPv4 address.");
283 fatal("SNMP port cannot be opened.");
284 }
285 /* split-stack for now requires IPv4-only SNMP */
286 if (Ip::EnableIpv6&IPV6_SPECIAL_SPLITSTACK && snmpIncomingConn->local.IsAnyAddr()) {
287 snmpIncomingConn->local.SetIPv4();
288 }
289
290 AsyncCall::Pointer call = asyncCall(49, 2, "snmpIncomingConnectionOpened",
291 Comm::UdpOpenDialer(&snmpPortOpened));
292 Ipc::StartListening(SOCK_DGRAM, IPPROTO_UDP, snmpIncomingConn, Ipc::fdnInSnmpSocket, call);
293
294 if (!Config.Addrs.snmp_outgoing.IsNoAddr()) {
295 snmpOutgoingConn = new Comm::Connection;
296 snmpOutgoingConn->local = Config.Addrs.snmp_outgoing;
297 snmpOutgoingConn->local.SetPort(Config.Port.snmp);
298
299 if (!Ip::EnableIpv6 && !snmpOutgoingConn->local.SetIPv4()) {
300 debugs(49, DBG_CRITICAL, "ERROR: IPv6 is disabled. " << snmpOutgoingConn->local << " is not an IPv4 address.");
301 fatal("SNMP port cannot be opened.");
302 }
303 /* split-stack for now requires IPv4-only SNMP */
304 if (Ip::EnableIpv6&IPV6_SPECIAL_SPLITSTACK && snmpOutgoingConn->local.IsAnyAddr()) {
305 snmpOutgoingConn->local.SetIPv4();
306 }
307 AsyncCall::Pointer call = asyncCall(49, 2, "snmpOutgoingConnectionOpened",
308 Comm::UdpOpenDialer(&snmpPortOpened));
309 Ipc::StartListening(SOCK_DGRAM, IPPROTO_UDP, snmpOutgoingConn, Ipc::fdnOutSnmpSocket, call);
310 } else {
311 snmpOutgoingConn = snmpIncomingConn;
312 debugs(1, DBG_IMPORTANT, "Sending SNMP messages from " << snmpOutgoingConn->local);
313 }
314 }
315
316 static void
317 snmpPortOpened(const Comm::ConnectionPointer &conn, int errNo)
318 {
319 if (!Comm::IsConnOpen(conn))
320 fatalf("Cannot open SNMP %s Port",(conn->fd == snmpIncomingConn->fd?"receiving":"sending"));
321
322 Comm::SetSelect(conn->fd, COMM_SELECT_READ, snmpHandleUdp, NULL, 0);
323
324 if (conn->fd == snmpIncomingConn->fd)
325 debugs(1, DBG_IMPORTANT, "Accepting SNMP messages on " << snmpIncomingConn->local);
326 else if (conn->fd == snmpOutgoingConn->fd)
327 debugs(1, DBG_IMPORTANT, "Sending SNMP messages from " << snmpOutgoingConn->local);
328 else
329 fatalf("Lost SNMP port (%d) on FD %d", (int)conn->local.GetPort(), conn->fd);
330 }
331
332 void
333 snmpClosePorts(void)
334 {
335 if (Comm::IsConnOpen(snmpIncomingConn)) {
336 debugs(49, DBG_IMPORTANT, "Closing SNMP receiving port " << snmpIncomingConn->local);
337 snmpIncomingConn->close();
338 }
339 snmpIncomingConn = NULL;
340
341 if (Comm::IsConnOpen(snmpOutgoingConn) && snmpIncomingConn != snmpOutgoingConn) {
342 // Perform OUT port closure so as not to step on IN port when sharing a conn.
343 debugs(49, DBG_IMPORTANT, "Closing SNMP sending port " << snmpOutgoingConn->local);
344 snmpOutgoingConn->close();
345 }
346 snmpOutgoingConn = NULL;
347 }
348
349 /*
350 * Functions for handling the requests.
351 */
352
353 /*
354 * Accept the UDP packet
355 */
356 void
357 snmpHandleUdp(int sock, void *not_used)
358 {
359 LOCAL_ARRAY(char, buf, SNMP_REQUEST_SIZE);
360 Ip::Address from;
361 snmp_request_t *snmp_rq;
362 int len;
363
364 debugs(49, 5, "snmpHandleUdp: Called.");
365
366 Comm::SetSelect(sock, COMM_SELECT_READ, snmpHandleUdp, NULL, 0);
367
368 memset(buf, '\0', SNMP_REQUEST_SIZE);
369
370 len = comm_udp_recvfrom(sock,
371 buf,
372 SNMP_REQUEST_SIZE,
373 0,
374 from);
375
376 if (len > 0) {
377 buf[len] = '\0';
378 debugs(49, 3, "snmpHandleUdp: FD " << sock << ": received " << len << " bytes from " << from << ".");
379
380 snmp_rq = (snmp_request_t *)xcalloc(1, sizeof(snmp_request_t));
381 snmp_rq->buf = (u_char *) buf;
382 snmp_rq->len = len;
383 snmp_rq->sock = sock;
384 snmp_rq->outbuf = (unsigned char *)xmalloc(snmp_rq->outlen = SNMP_REQUEST_SIZE);
385 snmp_rq->from = from;
386 snmpDecodePacket(snmp_rq);
387 xfree(snmp_rq->outbuf);
388 xfree(snmp_rq);
389 } else {
390 debugs(49, 1, "snmpHandleUdp: FD " << sock << " recvfrom: " << xstrerror());
391 }
392 }
393
394 /*
395 * Turn SNMP packet into a PDU, check available ACL's
396 */
397 static void
398 snmpDecodePacket(snmp_request_t * rq)
399 {
400 struct snmp_pdu *PDU;
401 u_char *Community;
402 u_char *buf = rq->buf;
403 int len = rq->len;
404 allow_t allow = ACCESS_DENIED;
405
406 if (!Config.accessList.snmp) {
407 debugs(49, DBG_IMPORTANT, "WARNING: snmp_access not configured. agent query DENIED from : " << rq->from);
408 return;
409 }
410
411 debugs(49, 5, HERE << "Called.");
412 PDU = snmp_pdu_create(0);
413 /* Allways answer on SNMPv1 */
414 rq->session.Version = SNMP_VERSION_1;
415 Community = snmp_parse(&rq->session, PDU, buf, len);
416
417 /* Check if we have explicit permission to access SNMP data.
418 * default (set above) is to deny all */
419 if (Community) {
420 ACLFilledChecklist checklist(Config.accessList.snmp, NULL, NULL);
421 checklist.src_addr = rq->from;
422 checklist.snmp_community = (char *) Community;
423 allow = checklist.fastCheck();
424
425 if (allow == ACCESS_ALLOWED && (snmp_coexist_V2toV1(PDU))) {
426 rq->community = Community;
427 rq->PDU = PDU;
428 debugs(49, 5, "snmpAgentParse: reqid=[" << PDU->reqid << "]");
429 snmpConstructReponse(rq);
430 } else {
431 debugs(49, DBG_IMPORTANT, "WARNING: SNMP agent query DENIED from : " << rq->from);
432 }
433 xfree(Community);
434
435 } else {
436 debugs(49, DBG_IMPORTANT, "WARNING: Failed SNMP agent query from : " << rq->from);
437 snmp_free_pdu(PDU);
438 }
439 }
440
441 /*
442 * Packet OK, ACL Check OK, Create reponse.
443 */
444 static void
445 snmpConstructReponse(snmp_request_t * rq)
446 {
447
448 struct snmp_pdu *RespPDU;
449
450 debugs(49, 5, "snmpConstructReponse: Called.");
451
452 if (UsingSmp() && IamWorkerProcess()) {
453 AsyncJob::Start(new Snmp::Forwarder(static_cast<Snmp::Pdu&>(*rq->PDU),
454 static_cast<Snmp::Session&>(rq->session), rq->sock, rq->from));
455 snmp_free_pdu(rq->PDU);
456 return;
457 }
458
459 RespPDU = snmpAgentResponse(rq->PDU);
460 snmp_free_pdu(rq->PDU);
461
462 if (RespPDU != NULL) {
463 snmp_build(&rq->session, RespPDU, rq->outbuf, &rq->outlen);
464 comm_udp_sendto(rq->sock, rq->from, rq->outbuf, rq->outlen);
465 snmp_free_pdu(RespPDU);
466 }
467 }
468
469 /*
470 * Decide how to respond to the request, construct a response and
471 * return the response to the requester.
472 */
473
474 struct snmp_pdu *
475 snmpAgentResponse(struct snmp_pdu *PDU) {
476
477 struct snmp_pdu *Answer = NULL;
478
479 debugs(49, 5, "snmpAgentResponse: Called.");
480
481 if ((Answer = snmp_pdu_create(SNMP_PDU_RESPONSE))) {
482 Answer->reqid = PDU->reqid;
483 Answer->errindex = 0;
484
485 if (PDU->command == SNMP_PDU_GET || PDU->command == SNMP_PDU_GETNEXT) {
486 /* Indirect way */
487 int get_next = (PDU->command == SNMP_PDU_GETNEXT);
488 variable_list *VarPtr_;
489 variable_list **RespVars = &(Answer->variables);
490 oid_ParseFn *ParseFn;
491 int index = 0;
492 /* Loop through all variables */
493
494 for (VarPtr_ = PDU->variables; VarPtr_; VarPtr_ = VarPtr_->next_variable) {
495 variable_list *VarPtr = VarPtr_;
496 variable_list *VarNew = NULL;
497 oid *NextOidName = NULL;
498 snint NextOidNameLen = 0;
499
500 ++index;
501
502 if (get_next)
503 ParseFn = snmpTreeNext(VarPtr->name, VarPtr->name_length, &NextOidName, &NextOidNameLen);
504 else
505 ParseFn = snmpTreeGet(VarPtr->name, VarPtr->name_length);
506
507 if (ParseFn == NULL) {
508 Answer->errstat = SNMP_ERR_NOSUCHNAME;
509 debugs(49, 5, "snmpAgentResponse: No such oid. ");
510 } else {
511 if (get_next) {
512 VarPtr = snmp_var_new(NextOidName, NextOidNameLen);
513 xfree(NextOidName);
514 }
515
516 int * errstatTmp = &(Answer->errstat);
517
518 VarNew = (*ParseFn) (VarPtr, (snint *) errstatTmp);
519
520 if (get_next)
521 snmp_var_free(VarPtr);
522 }
523
524 if ((Answer->errstat != SNMP_ERR_NOERROR) || (VarNew == NULL)) {
525 Answer->errindex = index;
526 debugs(49, 5, "snmpAgentResponse: error.");
527
528 if (VarNew)
529 snmp_var_free(VarNew);
530
531 while ((VarPtr = Answer->variables) != NULL) {
532 Answer->variables = VarPtr->next_variable;
533 snmp_var_free(VarPtr);
534 }
535
536 /* Steal the original PDU list of variables for the error response */
537 Answer->variables = PDU->variables;
538
539 PDU->variables = NULL;
540
541 return (Answer);
542 }
543
544 /* No error. Insert this var at the end, and move on to the next.
545 */
546 *RespVars = VarNew;
547
548 RespVars = &(VarNew->next_variable);
549 }
550 }
551 }
552
553 return (Answer);
554 }
555
556 static oid_ParseFn *
557 snmpTreeGet(oid * Current, snint CurrentLen)
558 {
559 oid_ParseFn *Fn = NULL;
560 mib_tree_entry *mibTreeEntry = NULL;
561 int count = 0;
562
563 debugs(49, 5, "snmpTreeGet: Called");
564
565 MemBuf tmp;
566 debugs(49, 6, "snmpTreeGet: Current : " << snmpDebugOid(Current, CurrentLen, tmp) );
567
568 mibTreeEntry = mib_tree_head;
569
570 if (Current[count] == mibTreeEntry->name[count]) {
571 ++count;
572
573 while ((mibTreeEntry) && (count < CurrentLen) && (!mibTreeEntry->parsefunction)) {
574 mibTreeEntry = snmpTreeEntry(Current[count], count, mibTreeEntry);
575 ++count;
576 }
577 }
578
579 if (mibTreeEntry && mibTreeEntry->parsefunction)
580 Fn = mibTreeEntry->parsefunction;
581
582 debugs(49, 5, "snmpTreeGet: return");
583
584 return (Fn);
585 }
586
587 AggrType
588 snmpAggrType(oid* Current, snint CurrentLen)
589 {
590 debugs(49, 5, HERE);
591
592 mib_tree_entry* mibTreeEntry = mib_tree_head;
593 AggrType type = atNone;
594 int count = 0;
595
596 if (Current[count] == mibTreeEntry->name[count]) {
597 ++count;
598
599 while (mibTreeEntry != NULL && count < CurrentLen) {
600 mibTreeEntry = snmpTreeEntry(Current[count], count, mibTreeEntry);
601 if (mibTreeEntry != NULL)
602 type = mibTreeEntry->aggrType;
603 ++count;
604 }
605 }
606
607 return type;
608 }
609
610 static oid_ParseFn *
611 snmpTreeNext(oid * Current, snint CurrentLen, oid ** Next, snint * NextLen)
612 {
613 oid_ParseFn *Fn = NULL;
614 mib_tree_entry *mibTreeEntry = NULL, *nextoid = NULL;
615 int count = 0;
616
617 debugs(49, 5, "snmpTreeNext: Called");
618
619 MemBuf tmp;
620 debugs(49, 6, "snmpTreeNext: Current : " << snmpDebugOid(Current, CurrentLen, tmp));
621
622 mibTreeEntry = mib_tree_head;
623
624 if (Current[count] == mibTreeEntry->name[count]) {
625 ++count;
626
627 while ((mibTreeEntry) && (count < CurrentLen) && (!mibTreeEntry->parsefunction)) {
628 mib_tree_entry *nextmibTreeEntry = snmpTreeEntry(Current[count], count, mibTreeEntry);
629
630 if (!nextmibTreeEntry)
631 break;
632 else
633 mibTreeEntry = nextmibTreeEntry;
634
635 ++count;
636 }
637 debugs(49, 5, "snmpTreeNext: Recursed down to requested object");
638 } else {
639 return NULL;
640 }
641
642 if (mibTreeEntry == mib_tree_last)
643 return (Fn);
644
645
646 if ((mibTreeEntry) && (mibTreeEntry->parsefunction)) {
647 *NextLen = CurrentLen;
648 *Next = (*mibTreeEntry->instancefunction) (Current, NextLen, mibTreeEntry, &Fn);
649 if (*Next) {
650 MemBuf tmp;
651 debugs(49, 6, "snmpTreeNext: Next : " << snmpDebugOid(*Next, *NextLen, tmp));
652 return (Fn);
653 }
654 }
655
656 if ((mibTreeEntry) && (mibTreeEntry->parsefunction)) {
657 --count;
658 nextoid = snmpTreeSiblingEntry(Current[count], count, mibTreeEntry->parent);
659 if (nextoid) {
660 debugs(49, 5, "snmpTreeNext: Next OID found for sibling" << nextoid );
661 mibTreeEntry = nextoid;
662 ++count;
663 } else {
664 debugs(49, 5, "snmpTreeNext: Attempting to recurse up for next object");
665
666 while (!nextoid) {
667 --count;
668
669 if (mibTreeEntry->parent->parent) {
670 nextoid = mibTreeEntry->parent;
671 mibTreeEntry = snmpTreeEntry(Current[count] + 1, count, nextoid->parent);
672
673 if (!mibTreeEntry) {
674 mibTreeEntry = nextoid;
675 nextoid = NULL;
676 }
677 } else {
678 nextoid = mibTreeEntry;
679 mibTreeEntry = NULL;
680 }
681 }
682 }
683 }
684 while ((mibTreeEntry) && (!mibTreeEntry->parsefunction)) {
685 mibTreeEntry = mibTreeEntry->leaves[0];
686 }
687
688 if (mibTreeEntry) {
689 *NextLen = mibTreeEntry->len;
690 *Next = (*mibTreeEntry->instancefunction) (mibTreeEntry->name, NextLen, mibTreeEntry, &Fn);
691 }
692
693 if (*Next) {
694 MemBuf tmp;
695 debugs(49, 6, "snmpTreeNext: Next : " << snmpDebugOid(*Next, *NextLen, tmp));
696 return (Fn);
697 } else
698 return NULL;
699 }
700
701 static oid *
702 static_Inst(oid * name, snint * len, mib_tree_entry * current, oid_ParseFn ** Fn)
703 {
704 oid *instance = NULL;
705 if (*len <= current->len) {
706 instance = (oid *)xmalloc(sizeof(name) * (*len + 1));
707 memcpy(instance, name, (sizeof(name) * *len));
708 instance[*len] = 0;
709 *len += 1;
710 }
711 *Fn = current->parsefunction;
712 return (instance);
713 }
714
715 static oid *
716 time_Inst(oid * name, snint * len, mib_tree_entry * current, oid_ParseFn ** Fn)
717 {
718 oid *instance = NULL;
719 int identifier = 0, loop = 0;
720 int index[TIME_INDEX_LEN] = {TIME_INDEX};
721
722 if (*len <= current->len) {
723 instance = (oid *)xmalloc(sizeof(name) * (*len + 1));
724 memcpy(instance, name, (sizeof(name) * *len));
725 instance[*len] = *index;
726 *len += 1;
727 } else {
728 identifier = name[*len - 1];
729
730 while ((loop < TIME_INDEX_LEN) && (identifier != index[loop]))
731 ++loop;
732
733 if (loop < (TIME_INDEX_LEN - 1)) {
734 instance = (oid *)xmalloc(sizeof(name) * (*len));
735 memcpy(instance, name, (sizeof(name) * *len));
736 instance[*len - 1] = index[++loop];
737 }
738 }
739
740 *Fn = current->parsefunction;
741 return (instance);
742 }
743
744
745 static oid *
746 peer_Inst(oid * name, snint * len, mib_tree_entry * current, oid_ParseFn ** Fn)
747 {
748 oid *instance = NULL;
749 peer *peers = Config.peers;
750
751 if (peers == NULL) {
752 debugs(49, 6, "snmp peer_Inst: No Peers.");
753 current = current->parent->parent->parent->leaves[1];
754 while ((current) && (!current->parsefunction))
755 current = current->leaves[0];
756
757 instance = client_Inst(current->name, len, current, Fn);
758 } else if (*len <= current->len) {
759 debugs(49, 6, "snmp peer_Inst: *len <= current->len ???");
760 instance = (oid *)xmalloc(sizeof(name) * ( *len + 1));
761 memcpy(instance, name, (sizeof(name) * *len));
762 instance[*len] = 1 ;
763 *len += 1;
764 } else {
765 int no = name[current->len] ;
766 int i;
767 // Note: This works because the Config.peers keeps its index according to its position.
768 for ( i=0 ; peers && (i < no) ; peers = peers->next , ++i ) ;
769
770 if (peers) {
771 debugs(49, 6, "snmp peer_Inst: Encode peer #" << i);
772 instance = (oid *)xmalloc(sizeof(name) * (current->len + 1 ));
773 memcpy(instance, name, (sizeof(name) * current->len ));
774 instance[current->len] = no + 1 ; // i.e. the next index on cache_peeer table.
775 } else {
776 debugs(49, 6, "snmp peer_Inst: We have " << i << " peers. Can't find #" << no);
777 return (instance);
778 }
779 }
780 *Fn = current->parsefunction;
781 return (instance);
782 }
783
784 static oid *
785 client_Inst(oid * name, snint * len, mib_tree_entry * current, oid_ParseFn ** Fn)
786 {
787 oid *instance = NULL;
788 Ip::Address laddr;
789 Ip::Address *aux;
790 int size = 0;
791 int newshift = 0;
792
793 if (*len <= current->len) {
794 aux = client_entry(NULL);
795 if (aux)
796 laddr = *aux;
797 else
798 laddr.SetAnyAddr();
799
800 if (laddr.IsIPv4())
801 size = sizeof(in_addr);
802 else
803 size = sizeof(in6_addr);
804
805 debugs(49, 6, HERE << "len" << *len << ", current-len" << current->len << ", addr=" << laddr << ", size=" << size);
806
807 instance = (oid *)xmalloc(sizeof(name) * (*len + size ));
808 memcpy(instance, name, (sizeof(name) * (*len)));
809
810 if ( !laddr.IsAnyAddr() ) {
811 addr2oid(laddr, &instance[ *len]); // the addr
812 *len += size ;
813 }
814 } else {
815 int shift = *len - current->len ; // i.e 4 or 16
816 oid2addr(&name[*len - shift], laddr,shift);
817 aux = client_entry(&laddr);
818 if (aux)
819 laddr = *aux;
820 else
821 laddr.SetAnyAddr();
822
823 if (!laddr.IsAnyAddr()) {
824 if (laddr.IsIPv4())
825 newshift = sizeof(in_addr);
826 else
827 newshift = sizeof(in6_addr);
828
829 debugs(49, 6, HERE << "len" << *len << ", current-len" << current->len << ", addr=" << laddr << ", newshift=" << newshift);
830
831 instance = (oid *)xmalloc(sizeof(name) * (current->len + newshift));
832 memcpy(instance, name, (sizeof(name) * (current->len)));
833 addr2oid(laddr, &instance[current->len]); // the addr.
834 *len = current->len + newshift ;
835 }
836 }
837
838 *Fn = current->parsefunction;
839 return (instance);
840 }
841
842 /*
843 * Utility functions
844 */
845
846 /*
847 * Tree utility functions.
848 */
849
850 /*
851 * Returns a sibling object for the requested child object or NULL
852 * if it does not exit
853 */
854 static mib_tree_entry *
855 snmpTreeSiblingEntry(oid entry, snint len, mib_tree_entry * current)
856 {
857 mib_tree_entry *next = NULL;
858 int count = 0;
859
860 while ((!next) && (count < current->children)) {
861 if (current->leaves[count]->name[len] == entry) {
862 next = current->leaves[count];
863 }
864
865 ++count;
866 }
867
868 /* Exactly the sibling on right */
869 if (count < current->children) {
870 next = current->leaves[count];
871 } else {
872 next = NULL;
873 }
874
875 return (next);
876 }
877
878 /*
879 * Returns the requested child object or NULL if it does not exist
880 */
881 static mib_tree_entry *
882 snmpTreeEntry(oid entry, snint len, mib_tree_entry * current)
883 {
884 mib_tree_entry *next = NULL;
885 int count = 0;
886
887 while ((!next) && current && (count < current->children)) {
888 if (current->leaves[count]->name[len] == entry) {
889 next = current->leaves[count];
890 }
891
892 ++count;
893 }
894
895 return (next);
896 }
897
898 void
899 snmpAddNodeChild(mib_tree_entry *entry, mib_tree_entry *child)
900 {
901 debugs(49, 5, "snmpAddNodeChild: assigning " << child << " to parent " << entry);
902 entry->leaves = (mib_tree_entry **)xrealloc(entry->leaves, sizeof(mib_tree_entry *) * (entry->children + 1));
903 entry->leaves[entry->children] = child;
904 entry->leaves[entry->children]->parent = entry;
905 ++ entry->children;
906 }
907
908 mib_tree_entry *
909 snmpLookupNodeStr(mib_tree_entry *root, const char *str)
910 {
911 oid *name;
912 int namelen;
913 mib_tree_entry *e;
914
915 if (root)
916 e = root;
917 else
918 e = mib_tree_head;
919
920 if (! snmpCreateOidFromStr(str, &name, &namelen))
921 return NULL;
922
923 /* I wish there were some kind of sensible existing tree traversal
924 * routine to use. I'll worry about that later */
925 if (namelen <= 1) {
926 xfree(name);
927 return e; /* XXX it should only be this? */
928 }
929
930 int i, r = 1;
931 while (r < namelen) {
932
933 /* Find the child node which matches this */
934 for (i = 0; i < e->children && e->leaves[i]->name[r] != name[r]; ++i) ; // seek-loop
935
936 /* Are we pointing to that node? */
937 if (i >= e->children)
938 break;
939 assert(e->leaves[i]->name[r] == name[r]);
940
941 /* Skip to that node! */
942 e = e->leaves[i];
943 ++r;
944 }
945
946 xfree(name);
947 return e;
948 }
949
950 int
951 snmpCreateOidFromStr(const char *str, oid **name, int *nl)
952 {
953 char const *delim = ".";
954 char *p;
955
956 *name = NULL;
957 *nl = 0;
958 char *s = xstrdup(str);
959 char *s_ = s;
960
961 /* Parse the OID string into oid bits */
962 while ( (p = strsep(&s_, delim)) != NULL) {
963 *name = (oid*)xrealloc(*name, sizeof(oid) * ((*nl) + 1));
964 (*name)[*nl] = atoi(p);
965 ++(*nl);
966 }
967
968 xfree(s);
969 return 1;
970 }
971
972 /*
973 * Create an entry. Return a pointer to the newly created node, or NULL
974 * on failure.
975 */
976 static mib_tree_entry *
977 snmpAddNodeStr(const char *base_str, int o, oid_ParseFn * parsefunction, instance_Fn * instancefunction, AggrType aggrType)
978 {
979 mib_tree_entry *m, *b;
980 oid *n;
981 int nl;
982 char s[1024];
983
984 /* Find base node */
985 b = snmpLookupNodeStr(mib_tree_head, base_str);
986 if (! b)
987 return NULL;
988 debugs(49, 5, "snmpAddNodeStr: " << base_str << ": -> " << b);
989
990 /* Create OID string for new entry */
991 snprintf(s, 1024, "%s.%d", base_str, o);
992 if (! snmpCreateOidFromStr(s, &n, &nl))
993 return NULL;
994
995 /* Create a node */
996 m = snmpAddNode(n, nl, parsefunction, instancefunction, aggrType, 0);
997
998 /* Link it into the existing tree */
999 snmpAddNodeChild(b, m);
1000
1001 /* Return the node */
1002 return m;
1003 }
1004
1005
1006 /*
1007 * Adds a node to the MIB tree structure and adds the appropriate children
1008 */
1009 static mib_tree_entry *
1010 snmpAddNode(oid * name, int len, oid_ParseFn * parsefunction, instance_Fn * instancefunction, AggrType aggrType, int children,...)
1011 {
1012 va_list args;
1013 int loop;
1014 mib_tree_entry *entry = NULL;
1015 va_start(args, children);
1016
1017 MemBuf tmp;
1018 debugs(49, 6, "snmpAddNode: Children : " << children << ", Oid : " << snmpDebugOid(name, len, tmp));
1019
1020 va_start(args, children);
1021 entry = (mib_tree_entry *)xmalloc(sizeof(mib_tree_entry));
1022 entry->name = name;
1023 entry->len = len;
1024 entry->parsefunction = parsefunction;
1025 entry->instancefunction = instancefunction;
1026 entry->children = children;
1027 entry->leaves = NULL;
1028 entry->aggrType = aggrType;
1029
1030 if (children > 0) {
1031 entry->leaves = (mib_tree_entry **)xmalloc(sizeof(mib_tree_entry *) * children);
1032
1033 for (loop = 0; loop < children; ++loop) {
1034 entry->leaves[loop] = va_arg(args, mib_tree_entry *);
1035 entry->leaves[loop]->parent = entry;
1036 }
1037 }
1038
1039 return (entry);
1040 }
1041 /* End of tree utility functions */
1042
1043 /*
1044 * Returns the list of parameters in an oid
1045 */
1046 static oid *
1047 snmpCreateOid(int length,...)
1048 {
1049 va_list args;
1050 oid *new_oid;
1051 int loop;
1052 va_start(args, length);
1053
1054 new_oid = (oid *)xmalloc(sizeof(oid) * length);
1055
1056 if (length > 0) {
1057 for (loop = 0; loop < length; ++loop) {
1058 new_oid[loop] = va_arg(args, int);
1059 }
1060 }
1061
1062 return (new_oid);
1063 }
1064
1065 /*
1066 * Debug calls, prints out the OID for debugging purposes.
1067 */
1068 const char *
1069 snmpDebugOid(oid * Name, snint Len, MemBuf &outbuf)
1070 {
1071 char mbuf[16];
1072 int x;
1073 if (outbuf.isNull())
1074 outbuf.init(16, MAX_IPSTRLEN);
1075
1076 for (x = 0; x < Len; ++x) {
1077 size_t bytes = snprintf(mbuf, sizeof(mbuf), ".%u", (unsigned int) Name[x]);
1078 outbuf.append(mbuf, bytes);
1079 }
1080 return outbuf.content();
1081 }
1082
1083 void
1084 snmpSnmplibDebug(int lvl, char *buf)
1085 {
1086 debugs(49, lvl, buf);
1087 }
1088
1089
1090
1091 /*
1092 IPv4 address: 10.10.0.9 ==>
1093 oid == 10.10.0.9
1094 IPv6 adress : 20:01:32:ef:a2:21:fb:32:00:00:00:00:00:00:00:00:OO:01 ==>
1095 oid == 32.1.50.239.162.33.251.20.50.0.0.0.0.0.0.0.0.0.1
1096 */
1097 void
1098 addr2oid(Ip::Address &addr, oid * Dest)
1099 {
1100 u_int i ;
1101 u_char *cp = NULL;
1102 struct in_addr i4addr;
1103 struct in6_addr i6addr;
1104 oid code = addr.IsIPv6()? INETADDRESSTYPE_IPV6 : INETADDRESSTYPE_IPV4 ;
1105 u_int size = (code == INETADDRESSTYPE_IPV4) ? sizeof(struct in_addr):sizeof(struct in6_addr);
1106 // Dest[0] = code ;
1107 if ( code == INETADDRESSTYPE_IPV4 ) {
1108 addr.GetInAddr(i4addr);
1109 cp = (u_char *) &(i4addr.s_addr);
1110 } else {
1111 addr.GetInAddr(i6addr);
1112 cp = (u_char *) &i6addr;
1113 }
1114 for ( i=0 ; i < size ; ++i) {
1115 // OID's are in network order
1116 Dest[i] = *cp;
1117 ++cp;
1118 }
1119 MemBuf tmp;
1120 debugs(49, 7, "addr2oid: Dest : " << snmpDebugOid(Dest, size, tmp));
1121 }
1122
1123 /*
1124 oid == 10.10.0.9 ==>
1125 IPv4 address: 10.10.0.9
1126 oid == 32.1.50.239.162.33.251.20.50.0.0.0.0.0.0.0.0.0.1 ==>
1127 IPv6 adress : 20:01:32:ef:a2:21:fb:32:00:00:00:00:00:00:00:00:OO:01
1128 */
1129 void
1130 oid2addr(oid * id, Ip::Address &addr, u_int size)
1131 {
1132 struct in_addr i4addr;
1133 struct in6_addr i6addr;
1134 u_int i;
1135 u_char *cp;
1136 if ( size == sizeof(struct in_addr) )
1137 cp = (u_char *) &(i4addr.s_addr);
1138 else
1139 cp = (u_char *) &(i6addr);
1140 MemBuf tmp;
1141 debugs(49, 7, "oid2addr: id : " << snmpDebugOid(id, size, tmp) );
1142 for (i=0 ; i<size; ++i) {
1143 cp[i] = id[i];
1144 }
1145 if ( size == sizeof(struct in_addr) )
1146 addr = i4addr;
1147 else
1148 addr = i6addr;
1149 }
1150
1151 /* SNMP checklists */
1152 #include "acl/Strategy.h"
1153 #include "acl/Strategised.h"
1154 #include "acl/StringData.h"
1155
1156 class ACLSNMPCommunityStrategy : public ACLStrategy<char const *>
1157 {
1158
1159 public:
1160 virtual int match (ACLData<MatchType> * &, ACLFilledChecklist *);
1161 static ACLSNMPCommunityStrategy *Instance();
1162 /* Not implemented to prevent copies of the instance. */
1163 /* Not private to prevent brain dead g++ warnings about
1164 * private constructors with no friends */
1165 ACLSNMPCommunityStrategy(ACLSNMPCommunityStrategy const &);
1166
1167 private:
1168 static ACLSNMPCommunityStrategy Instance_;
1169 ACLSNMPCommunityStrategy() {}
1170
1171 ACLSNMPCommunityStrategy&operator=(ACLSNMPCommunityStrategy const &);
1172 };
1173
1174 class ACLSNMPCommunity
1175 {
1176
1177 private:
1178 static ACL::Prototype RegistryProtoype;
1179 static ACLStrategised<char const *> RegistryEntry_;
1180 };
1181
1182 ACL::Prototype ACLSNMPCommunity::RegistryProtoype(&ACLSNMPCommunity::RegistryEntry_, "snmp_community");
1183 ACLStrategised<char const *> ACLSNMPCommunity::RegistryEntry_(new ACLStringData, ACLSNMPCommunityStrategy::Instance(), "snmp_community");
1184
1185 int
1186 ACLSNMPCommunityStrategy::match (ACLData<MatchType> * &data, ACLFilledChecklist *checklist)
1187 {
1188 return data->match (checklist->snmp_community);
1189 }
1190
1191 ACLSNMPCommunityStrategy *
1192 ACLSNMPCommunityStrategy::Instance()
1193 {
1194 return &Instance_;
1195 }
1196
1197 ACLSNMPCommunityStrategy ACLSNMPCommunityStrategy::Instance_;