1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
|
/*
** Zabbix
** Copyright (C) 2001-2014 Zabbix SIA
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**/
#include "checks_snmp.h"
#include "comms.h"
#include "zbxjson.h"
#ifdef HAVE_SNMP
typedef struct
{
char *oid;
char *value;
char *idx;
zbx_uint64_t hostid;
unsigned short port;
}
zbx_snmp_index_t;
static zbx_snmp_index_t *snmpidx = NULL;
static int snmpidx_count = 0, snmpidx_alloc = 16;
static char *zbx_get_snmp_type_error(u_char type)
{
switch (type)
{
case SNMP_NOSUCHOBJECT:
return zbx_strdup(NULL, "No Such Object available on this agent at this OID");
case SNMP_NOSUCHINSTANCE:
return zbx_strdup(NULL, "No Such Instance currently exists at this OID");
case SNMP_ENDOFMIBVIEW:
return zbx_strdup(NULL, "No more variables left in this MIB View"
" (it is past the end of the MIB tree)");
default:
return zbx_dsprintf(NULL, "Value has unknown type 0x%02X", (unsigned int)type);
}
}
static int zbx_get_snmp_response_error(const struct snmp_session *ss, const DC_INTERFACE *interface, int status,
const struct snmp_pdu *response, char *error, int max_error_len)
{
int ret;
if (STAT_SUCCESS == status)
{
zbx_snprintf(error, max_error_len, "SNMP error: %s", snmp_errstring(response->errstat));
ret = NOTSUPPORTED;
}
else if (STAT_ERROR == status)
{
zbx_snprintf(error, max_error_len, "Cannot connect to \"%s:%hu\": %s.",
interface->addr, interface->port, snmp_api_errstring(ss->s_snmp_errno));
switch (ss->s_snmp_errno)
{
case SNMPERR_UNKNOWN_USER_NAME:
case SNMPERR_UNSUPPORTED_SEC_LEVEL:
case SNMPERR_AUTHENTICATION_FAILURE:
ret = NOTSUPPORTED;
break;
default:
ret = NETWORK_ERROR;
}
}
else if (STAT_TIMEOUT == status)
{
zbx_snprintf(error, max_error_len, "Timeout while connecting to \"%s:%hu\".",
interface->addr, interface->port);
ret = NETWORK_ERROR;
}
else
{
zbx_snprintf(error, max_error_len, "SNMP error: [%d]", status);
ret = NOTSUPPORTED;
}
return ret;
}
/******************************************************************************
* *
* Function: zbx_snmp_index_compare *
* *
* Purpose: compare s1 and s2 index entries *
* *
* Parameters: s1 - snmp index entry *
* s2 - snmp index entry *
* *
* Return value: -1, 0 or 1 if s1 entry is respectively less than, equal to *
* or greater than s2 *
* *
* Author: Vladimir Levijev *
* *
******************************************************************************/
static int zbx_snmp_index_compare(const zbx_snmp_index_t *s1, const zbx_snmp_index_t *s2)
{
int rc;
ZBX_RETURN_IF_NOT_EQUAL(s1->hostid, s2->hostid);
ZBX_RETURN_IF_NOT_EQUAL(s1->port, s2->port);
if (0 != (rc = strcmp(s1->oid, s2->oid)))
return rc;
return strcmp(s1->value, s2->value);
}
/******************************************************************************
* *
* Function: find nearest index for new record *
* *
* Return value: index of new record *
* *
* Author: Alexander Vladishev *
* *
******************************************************************************/
static int get_snmpidx_nearestindex(const zbx_snmp_index_t *s)
{
const char *__function_name = "get_snmpidx_nearestindex";
int first_index, last_index, index = 0, cmp_res;
zabbix_log(LOG_LEVEL_DEBUG, "In %s() hostid:" ZBX_FS_UI64 " port:%hu oid:'%s' value:'%s'",
__function_name, s->hostid, s->port, s->oid, s->value);
if (0 == snmpidx_count)
goto end;
first_index = 0;
last_index = snmpidx_count - 1;
while (1)
{
index = first_index + (last_index - first_index) / 2;
if (0 == (cmp_res = zbx_snmp_index_compare(s, &snmpidx[index])))
break;
if (last_index == first_index)
{
if (0 < cmp_res)
index++;
break;
}
if (0 < cmp_res)
first_index = index + 1;
else
last_index = index;
}
end:
zabbix_log(LOG_LEVEL_DEBUG, "End of %s():%d", __function_name, index);
return index;
}
static int cache_get_snmp_index(const DC_ITEM *item, char *oid, char *value, char **idx, size_t *idx_alloc)
{
const char *__function_name = "cache_get_snmp_index";
int i, res = FAIL;
zbx_snmp_index_t s;
size_t idx_offset = 0;
zabbix_log(LOG_LEVEL_DEBUG, "In %s() oid:'%s' value:'%s'", __function_name, oid, value);
if (NULL == snmpidx)
goto end;
s.hostid = item->host.hostid;
s.port = item->interface.port;
s.oid = oid;
s.value = value;
if (snmpidx_count > (i = get_snmpidx_nearestindex(&s)) && 0 == zbx_snmp_index_compare(&s, &snmpidx[i]))
{
zbx_strcpy_alloc(idx, idx_alloc, &idx_offset, snmpidx[i].idx);
res = SUCCEED;
}
end:
zabbix_log(LOG_LEVEL_DEBUG, "End of %s():%s idx:%s", __function_name, zbx_result_string(res),
SUCCEED == res ? *idx : "");
return res;
}
static void cache_put_snmp_index(const DC_ITEM *item, char *oid, char *value, const char *idx)
{
const char *__function_name = "cache_put_snmp_index";
int i;
zbx_snmp_index_t s;
zabbix_log(LOG_LEVEL_DEBUG, "In %s() oid:'%s' value:'%s' idx:'%s'", __function_name, oid, value, idx);
if (NULL == snmpidx)
snmpidx = zbx_malloc(snmpidx, snmpidx_alloc * sizeof(zbx_snmp_index_t));
s.hostid = item->host.hostid;
s.port = item->interface.port;
s.oid = oid;
s.value = value;
if (snmpidx_count > (i = get_snmpidx_nearestindex(&s)) && 0 == zbx_snmp_index_compare(&s, &snmpidx[i]))
goto end;
if (snmpidx_count == snmpidx_alloc)
{
snmpidx_alloc += 16;
snmpidx = zbx_realloc(snmpidx, snmpidx_alloc * sizeof(zbx_snmp_index_t));
}
memmove(&snmpidx[i + 1], &snmpidx[i], sizeof(zbx_snmp_index_t) * (snmpidx_count - i));
snmpidx[i].hostid = item->host.hostid;
snmpidx[i].port = item->interface.port;
snmpidx[i].oid = zbx_strdup(NULL, oid);
snmpidx[i].value = zbx_strdup(NULL, value);
snmpidx[i].idx = zbx_strdup(NULL, idx);
snmpidx_count++;
end:
zabbix_log(LOG_LEVEL_DEBUG, "End of %s()", __function_name);
}
static void cache_del_snmp_index_by_position(int i)
{
snmpidx_count--;
zbx_free(snmpidx[i].oid);
zbx_free(snmpidx[i].value);
zbx_free(snmpidx[i].idx);
memmove(&snmpidx[i], &snmpidx[i + 1], sizeof(zbx_snmp_index_t) * (snmpidx_count - i));
}
static void cache_del_snmp_index_subtree(const DC_ITEM *item, const char *oid)
{
const char *__function_name = "cache_del_snmp_index_subtree";
int i;
zbx_snmp_index_t s;
zabbix_log(LOG_LEVEL_DEBUG, "In %s() oid:'%s'", __function_name, oid);
if (NULL == snmpidx)
goto end;
s.hostid = item->host.hostid;
s.port = item->interface.port;
s.oid = (char *)oid;
s.value = "";
i = get_snmpidx_nearestindex(&s);
while (i < snmpidx_count)
{
if (snmpidx[i].hostid != s.hostid || snmpidx[i].port != s.port || 0 != strcmp(snmpidx[i].oid, s.oid))
break;
cache_del_snmp_index_by_position(i);
/* No need to increment 'i'. Deleting an element from cache */
/* brings the next element into position 'i'. */
}
end:
zabbix_log(LOG_LEVEL_DEBUG, "End of %s()", __function_name);
}
static struct snmp_session *zbx_snmp_open_session(const DC_ITEM *item, char *error, int max_error_len)
{
const char *__function_name = "zbx_snmp_open_session";
struct snmp_session session, *ss = NULL;
char addr[128];
#ifdef HAVE_IPV6
int family;
#endif
zabbix_log(LOG_LEVEL_DEBUG, "In %s()", __function_name);
snmp_sess_init(&session);
switch (item->type)
{
case ITEM_TYPE_SNMPv1:
session.version = SNMP_VERSION_1;
break;
case ITEM_TYPE_SNMPv2c:
session.version = SNMP_VERSION_2c;
break;
case ITEM_TYPE_SNMPv3:
session.version = SNMP_VERSION_3;
break;
default:
THIS_SHOULD_NEVER_HAPPEN;
break;
}
session.retries = 0; /* number of retries after failed attempt */
/* (net-snmp default = 5) */
session.timeout = CONFIG_TIMEOUT * 1000 * 1000; /* timeout of one attempt in microseconds */
/* (net-snmp default = 1 second) */
#ifdef HAVE_IPV6
if (SUCCEED != get_address_family(item->interface.addr, &family, error, max_error_len))
goto end;
if (PF_INET == family)
{
zbx_snprintf(addr, sizeof(addr), "%s:%hu", item->interface.addr, item->interface.port);
}
else
{
if (item->interface.useip)
zbx_snprintf(addr, sizeof(addr), "udp6:[%s]:%hu", item->interface.addr, item->interface.port);
else
zbx_snprintf(addr, sizeof(addr), "udp6:%s:%hu", item->interface.addr, item->interface.port);
}
#else
zbx_snprintf(addr, sizeof(addr), "%s:%hu", item->interface.addr, item->interface.port);
#endif
session.peername = addr;
session.remote_port = item->interface.port; /* remote_port is no longer used in latest versions of Net-SNMP */
if (SNMP_VERSION_1 == session.version || SNMP_VERSION_2c == session.version)
{
session.community = (u_char *)item->snmp_community;
session.community_len = strlen((void *)session.community);
zabbix_log(LOG_LEVEL_DEBUG, "SNMP [%s@%s]", session.community, session.peername);
}
else if (SNMP_VERSION_3 == session.version)
{
/* set the SNMPv3 user name */
session.securityName = item->snmpv3_securityname;
session.securityNameLen = strlen(session.securityName);
/* set the SNMPv3 context if specified */
if ('\0' != *item->snmpv3_contextname)
{
session.contextName = item->snmpv3_contextname;
session.contextNameLen = strlen(session.contextName);
}
/* set the security level to authenticated, but not encrypted */
switch (item->snmpv3_securitylevel)
{
case ITEM_SNMPV3_SECURITYLEVEL_NOAUTHNOPRIV:
session.securityLevel = SNMP_SEC_LEVEL_NOAUTH;
break;
case ITEM_SNMPV3_SECURITYLEVEL_AUTHNOPRIV:
session.securityLevel = SNMP_SEC_LEVEL_AUTHNOPRIV;
switch (item->snmpv3_authprotocol)
{
case ITEM_SNMPV3_AUTHPROTOCOL_MD5:
/* set the authentication protocol to MD5 */
session.securityAuthProto = usmHMACMD5AuthProtocol;
session.securityAuthProtoLen = USM_AUTH_PROTO_MD5_LEN;
break;
case ITEM_SNMPV3_AUTHPROTOCOL_SHA:
/* set the authentication protocol to SHA */
session.securityAuthProto = usmHMACSHA1AuthProtocol;
session.securityAuthProtoLen = USM_AUTH_PROTO_SHA_LEN;
break;
default:
zbx_snprintf(error, max_error_len,
"Unsupported authentication protocol [%d]",
item->snmpv3_authprotocol);
goto end;
}
session.securityAuthKeyLen = USM_AUTH_KU_LEN;
if (SNMPERR_SUCCESS != generate_Ku(session.securityAuthProto,
session.securityAuthProtoLen, (u_char *)item->snmpv3_authpassphrase,
strlen(item->snmpv3_authpassphrase), session.securityAuthKey,
&session.securityAuthKeyLen))
{
zbx_strlcpy(error, "Error generating Ku from authentication pass phrase",
max_error_len);
goto end;
}
break;
case ITEM_SNMPV3_SECURITYLEVEL_AUTHPRIV:
session.securityLevel = SNMP_SEC_LEVEL_AUTHPRIV;
switch (item->snmpv3_authprotocol)
{
case ITEM_SNMPV3_AUTHPROTOCOL_MD5:
/* set the authentication protocol to MD5 */
session.securityAuthProto = usmHMACMD5AuthProtocol;
session.securityAuthProtoLen = USM_AUTH_PROTO_MD5_LEN;
break;
case ITEM_SNMPV3_AUTHPROTOCOL_SHA:
/* set the authentication protocol to SHA */
session.securityAuthProto = usmHMACSHA1AuthProtocol;
session.securityAuthProtoLen = USM_AUTH_PROTO_SHA_LEN;
break;
default:
zbx_snprintf(error, max_error_len,
"Unsupported authentication protocol [%d]",
item->snmpv3_authprotocol);
goto end;
}
session.securityAuthKeyLen = USM_AUTH_KU_LEN;
if (SNMPERR_SUCCESS != generate_Ku(session.securityAuthProto,
session.securityAuthProtoLen, (u_char *)item->snmpv3_authpassphrase,
strlen(item->snmpv3_authpassphrase), session.securityAuthKey,
&session.securityAuthKeyLen))
{
zbx_strlcpy(error, "Error generating Ku from authentication pass phrase",
max_error_len);
goto end;
}
switch (item->snmpv3_privprotocol)
{
case ITEM_SNMPV3_PRIVPROTOCOL_DES:
/* set the privacy protocol to DES */
session.securityPrivProto = usmDESPrivProtocol;
session.securityPrivProtoLen = USM_PRIV_PROTO_DES_LEN;
break;
case ITEM_SNMPV3_PRIVPROTOCOL_AES:
/* set the privacy protocol to AES */
session.securityPrivProto = usmAESPrivProtocol;
session.securityPrivProtoLen = USM_PRIV_PROTO_AES_LEN;
break;
default:
zbx_snprintf(error, max_error_len,
"Unsupported privacy protocol [%d]",
item->snmpv3_privprotocol);
goto end;
}
session.securityPrivKeyLen = USM_PRIV_KU_LEN;
if (SNMPERR_SUCCESS != generate_Ku(session.securityAuthProto,
session.securityAuthProtoLen, (u_char *)item->snmpv3_privpassphrase,
strlen(item->snmpv3_privpassphrase), session.securityPrivKey,
&session.securityPrivKeyLen))
{
zbx_strlcpy(error, "Error generating Ku from privacy pass phrase",
max_error_len);
goto end;
}
break;
}
zabbix_log(LOG_LEVEL_DEBUG, "SNMPv3 [%s@%s]", session.securityName, session.peername);
}
#ifdef HAVE_SNMP_SESSION_LOCALNAME
if (NULL != CONFIG_SOURCE_IP)
{
/* In some cases specifying just local host (without local port) is not enough. We do */
/* not care about the port number though so we let the OS select one by specifying 0. */
/* See marc.info/?l=net-snmp-bugs&m=115624676507760 for details. */
static char localname[64];
zbx_snprintf(localname, sizeof(localname), "%s:0", CONFIG_SOURCE_IP);
session.localname = localname;
}
#endif
SOCK_STARTUP;
if (NULL == (ss = snmp_open(&session)))
{
SOCK_CLEANUP;
zbx_strlcpy(error, "Cannot open SNMP session", max_error_len);
}
end:
zabbix_log(LOG_LEVEL_DEBUG, "End of %s()", __function_name);
return ss;
}
static void zbx_snmp_close_session(struct snmp_session *session)
{
const char *__function_name = "zbx_snmp_close_session";
zabbix_log(LOG_LEVEL_DEBUG, "In %s()", __function_name);
snmp_close(session);
SOCK_CLEANUP;
zabbix_log(LOG_LEVEL_DEBUG, "End of %s()", __function_name);
}
static char *zbx_snmp_get_octet_string(const struct variable_list *var)
{
const char *__function_name = "zbx_snmp_get_octet_string";
const char *hint;
char buffer[MAX_STRING_LEN];
char *strval_dyn = NULL, is_hex = 0;
size_t offset = 0;
struct tree *subtree;
zabbix_log(LOG_LEVEL_DEBUG, "In %s()", __function_name);
/* find the subtree to get display hint */
subtree = get_tree(var->name, var->name_length, get_tree_head());
hint = (NULL != subtree ? subtree->hint : NULL);
/* we will decide if we want the value from var->val or what snprint_value() returned later */
if (-1 == snprint_value(buffer, sizeof(buffer), var->name, var->name_length, var))
goto end;
zabbix_log(LOG_LEVEL_DEBUG, "%s() full value:'%s' hint:'%s'", __function_name, buffer, ZBX_NULL2STR(hint));
/* decide if it's Hex, offset will be possibly needed later */
if (0 == strncmp(buffer, "Hex-STRING: ", 12))
{
is_hex = 1;
offset = 12;
}
/* in case of no hex and no display hint take the value from */
/* var->val, it contains unquoted and unescaped string */
if (0 == is_hex && NULL == hint)
{
strval_dyn = zbx_malloc(strval_dyn, var->val_len + 1);
memcpy(strval_dyn, var->val.string, var->val_len);
strval_dyn[var->val_len] = '\0';
}
else
{
if (0 == is_hex && 0 == strncmp(buffer, "STRING: ", 8))
offset = 8;
strval_dyn = zbx_strdup(strval_dyn, buffer + offset);
}
zbx_lrtrim(strval_dyn, ZBX_WHITESPACE);
end:
zabbix_log(LOG_LEVEL_DEBUG, "End of %s():'%s'", __function_name, ZBX_NULL2STR(strval_dyn));
return strval_dyn;
}
static int zbx_snmp_set_result(const struct variable_list *var, unsigned char value_type, unsigned char data_type,
AGENT_RESULT *result)
{
const char *__function_name = "zbx_snmp_set_result";
char *strval_dyn;
int ret = SUCCEED;
zabbix_log(LOG_LEVEL_DEBUG, "In %s() type:%d value_type:%d data_type:%d", __function_name,
(int)var->type, (int)value_type, (int)data_type);
if (ASN_OCTET_STR == var->type)
{
if (NULL == (strval_dyn = zbx_snmp_get_octet_string(var)))
{
SET_MSG_RESULT(result, zbx_strdup(NULL, "Cannot receive string value: out of memory."));
ret = NOTSUPPORTED;
}
else
{
if (SUCCEED != set_result_type(result, value_type, data_type, strval_dyn))
ret = NOTSUPPORTED;
zbx_free(strval_dyn);
}
}
#ifdef OPAQUE_SPECIAL_TYPES
else if (ASN_UINTEGER == var->type || ASN_COUNTER == var->type || ASN_UNSIGNED64 == var->type ||
ASN_TIMETICKS == var->type || ASN_GAUGE == var->type)
#else
else if (ASN_UINTEGER == var->type || ASN_COUNTER == var->type ||
ASN_TIMETICKS == var->type || ASN_GAUGE == var->type)
#endif
{
SET_UI64_RESULT(result, (unsigned long)*var->val.integer);
}
else if (ASN_COUNTER64 == var->type)
{
SET_UI64_RESULT(result, (((zbx_uint64_t)var->val.counter64->high) << 32) +
(zbx_uint64_t)var->val.counter64->low);
}
#ifdef OPAQUE_SPECIAL_TYPES
else if (ASN_INTEGER == var->type || ASN_INTEGER64 == var->type)
#else
else if (ASN_INTEGER == var->type)
#endif
{
if (ITEM_VALUE_TYPE_UINT64 == value_type && 0 > *var->val.integer)
{
SET_MSG_RESULT(result, zbx_dsprintf(NULL, "Received value [%d]"
" is not suitable for value type [%s].",
*var->val.integer, zbx_item_value_type_string(value_type)));
ret = NOTSUPPORTED;
}
else
SET_DBL_RESULT(result, *var->val.integer);
}
#ifdef OPAQUE_SPECIAL_TYPES
else if (ASN_FLOAT == var->type)
{
SET_DBL_RESULT(result, *var->val.floatVal);
}
else if (ASN_DOUBLE == var->type)
{
SET_DBL_RESULT(result, *var->val.doubleVal);
}
#endif
else if (ASN_IPADDRESS == var->type)
{
SET_STR_RESULT(result, zbx_dsprintf(NULL, "%u.%u.%u.%u",
(unsigned int)var->val.string[0],
(unsigned int)var->val.string[1],
(unsigned int)var->val.string[2],
(unsigned int)var->val.string[3]));
}
else
{
SET_MSG_RESULT(result, zbx_get_snmp_type_error(var->type));
ret = NOTSUPPORTED;
}
zabbix_log(LOG_LEVEL_DEBUG, "End of %s():%s", __function_name, zbx_result_string(ret));
return ret;
}
#define ZBX_OID_INDEX_STRING 0
#define ZBX_OID_INDEX_NUMERIC 1
static int zbx_snmp_print_oid(char *buffer, size_t buffer_len, const oid *objid, size_t objid_len, int format)
{
if (SNMPERR_SUCCESS != netsnmp_ds_set_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_DONT_BREAKDOWN_OIDS,
format))
{
zabbix_log(LOG_LEVEL_WARNING, "cannot set \"dontBreakdownOids\" option to %d for Net-SNMP", format);
return -1;
}
return snprint_objid(buffer, buffer_len, objid, objid_len);
}
static int zbx_snmp_choose_index(char *buffer, size_t buffer_len, const oid *objid, size_t objid_len,
size_t root_string_len, size_t root_numeric_len)
{
const char *__function_name = "zbx_snmp_choose_index";
oid parsed_oid[MAX_OID_LEN];
size_t parsed_oid_len = MAX_OID_LEN;
char printed_oid[MAX_STRING_LEN];
/**************************************************************************************************************/
/* */
/* When we are providing a value for {#SNMPINDEX}, we would like to provide a pretty value. This is only a */
/* concern for OIDs with string indices. For instance, suppose we are walking the following OID: */
/* */
/* SNMP-VIEW-BASED-ACM-MIB::vacmGroupName */
/* */
/* Suppose also that we are currently looking at this OID: */
/* */
/* SNMP-VIEW-BASED-ACM-MIB::vacmGroupName.3."authOnlyUser" */
/* */
/* Then, we would like to provide {#SNMPINDEX} with this value: */
/* */
/* 3."authOnlyUser" */
/* */
/* An alternative approach would be to provide {#SNMPINDEX} with numeric value. While it is equivalent to the */
/* string representation above, the string representation is more readable and thus more useful to users: */
/* */
/* 3.12.97.117.116.104.79.110.108.121.85.115.101.114 */
/* */
/* Here, 12 is the length of "authOnlyUser" and the rest is the string encoding using ASCII characters. */
/* */
/* There are two problems with always providing {#SNMPINDEX} that has an index representation as a string. */
/* */
/* The first problem is indices of type InetAddress. The Net-SNMP library has code for pretty-printing IP */
/* addresses, but no way to parse them back. As an example, consider the following OID: */
/* */
/* .1.3.6.1.2.1.4.34.1.4.1.4.192.168.3.255 */
/* */
/* Its pretty representation is like this: */
/* */
/* IP-MIB::ipAddressType.ipv4."192.168.3.255" */
/* */
/* However, when trying to parse it, it turns into this OID: */
/* */
/* .1.3.6.1.2.1.4.34.1.4.1.13.49.57.50.46.49.54.56.46.51.46.50.53.53 */
/* */
/* Apparently, this is different than the original. */
/* */
/* The second problem is indices of type OCTET STRING, which might contain unprintable characters: */
/* */
/* 1.3.6.1.2.1.17.4.3.1.1.0.0.240.122.113.21 */
/* */
/* Its pretty representation is like this (note the single quotes which stand for a fixed-length string): */
/* */
/* BRIDGE-MIB::dot1dTpFdbAddress.'...zq.' */
/* */
/* Here, '...zq.' stands for 0.0.240.122.113.21, where only 'z' (122) and 'q' (113) are printable. */
/* */
/* Apparently, this cannot be turned back into the numeric representation. */
/* */
/* So what we try to do is first print it pretty. If there is no string-looking index, return it as output. */
/* If there is such an index, we check that it can be parsed and that the result is the same as the original. */
/* */
/**************************************************************************************************************/
if (-1 == zbx_snmp_print_oid(printed_oid, sizeof(printed_oid), objid, objid_len, ZBX_OID_INDEX_STRING))
{
zabbix_log(LOG_LEVEL_DEBUG, "%s(): cannot print OID with string indices", __function_name);
goto numeric;
}
if (NULL == strchr(printed_oid, '"') && NULL == strchr(printed_oid, '\''))
{
zbx_strlcpy(buffer, printed_oid + root_string_len + 1, buffer_len);
return SUCCEED;
}
if (NULL == snmp_parse_oid(printed_oid, parsed_oid, &parsed_oid_len))
{
zabbix_log(LOG_LEVEL_DEBUG, "%s(): cannot parse OID '%s'", __function_name, printed_oid);
goto numeric;
}
if (parsed_oid_len == objid_len && 0 == memcmp(parsed_oid, objid, parsed_oid_len * sizeof(oid)))
{
zbx_strlcpy(buffer, printed_oid + root_string_len + 1, buffer_len);
return SUCCEED;
}
numeric:
if (-1 == zbx_snmp_print_oid(printed_oid, sizeof(printed_oid), objid, objid_len, ZBX_OID_INDEX_NUMERIC))
{
zabbix_log(LOG_LEVEL_DEBUG, "%s(): cannot print OID with numeric indices", __function_name);
return FAIL;
}
zbx_strlcpy(buffer, printed_oid + root_numeric_len + 1, buffer_len);
return SUCCEED;
}
/******************************************************************************
* *
* Function: zbx_snmp_walk *
* *
* Purpose: retrieve information by walking an OID tree *
* *
* Parameters: ss - [IN] SNMP session handle *
* item - [IN] configuration of Zabbix item *
* OID - [IN] OID of table with values of interest *
* mode - [IN] mode to operate in *
* result - [OUT] result structure *
* max_succeed - [OUT] value of "max_repetitions" that succeeded *
* min_fail - [OUT] value of "max_repetitions" that failed *
* max_vars - [IN] suggested value of "max_repetitions" *
* bulk - [IN] whether GetBulkRequest-PDU should be used *
* *
* Return value: NOTSUPPORTED - OID does not exist, any other critical error *
* NETWORK_ERROR - recoverable network error *
* CONFIG_ERROR - item configuration error *
* SUCCEED - if function successfully completed *
* *
* Author: Alexander Vladishev, Aleksandrs Saveljevs *
* *
* Comments: This function can operate in one of two modes. *
* *
* Mode ZBX_SNMP_WALK_MODE_CACHE is used for dynamic indices. The *
* function walks the OID tree and caches all values in the table. *
* The 'value' parameter is only used to store an error message. *
* *
* Mode ZBX_SNMP_WALK_MODE_DISCOVERY is used for low-level *
* discovery. The 'value' parameter in this case is used to *
* store JSON with discovery data. *
* *
******************************************************************************/
#define ZBX_SNMP_WALK_MODE_CACHE 0
#define ZBX_SNMP_WALK_MODE_DISCOVERY 1
static int zbx_snmp_walk(struct snmp_session *ss, const DC_ITEM *item, const char *OID, unsigned char mode,
AGENT_RESULT *result, int *max_succeed, int *min_fail, int max_vars, int bulk)
{
const char *__function_name = "zbx_snmp_walk";
struct snmp_pdu *pdu, *response;
oid anOID[MAX_OID_LEN], rootOID[MAX_OID_LEN];
size_t anOID_len = MAX_OID_LEN, rootOID_len = MAX_OID_LEN, root_string_len, root_numeric_len;
char snmp_oid[MAX_STRING_LEN], error[MAX_STRING_LEN];
struct variable_list *var;
int status, level, running, num_vars, ret = SUCCEED;
struct zbx_json j;
AGENT_RESULT snmp_result;
zabbix_log(LOG_LEVEL_DEBUG, "In %s() type:%d oid:'%s' mode:%d bulk:%d", __function_name, (int)item->type, OID,
(int)mode, bulk);
if (ITEM_TYPE_SNMPv1 == item->type) /* GetBulkRequest-PDU available since SNMPv2 */
bulk = SNMP_BULK_DISABLED;
/* create OID from string */
if (NULL == snmp_parse_oid(OID, rootOID, &rootOID_len))
{
SET_MSG_RESULT(result, zbx_dsprintf(NULL, "snmp_parse_oid(): cannot parse OID \"%s\".", OID));
ret = CONFIG_ERROR;
goto out;
}
if (-1 == zbx_snmp_print_oid(snmp_oid, sizeof(snmp_oid), rootOID, rootOID_len, ZBX_OID_INDEX_STRING))
{
SET_MSG_RESULT(result, zbx_dsprintf(NULL, "zbx_snmp_print_oid():"
" cannot print OID \"%s\" with string indices.", OID));
ret = CONFIG_ERROR;
goto out;
}
root_string_len = strlen(snmp_oid);
if (-1 == zbx_snmp_print_oid(snmp_oid, sizeof(snmp_oid), rootOID, rootOID_len, ZBX_OID_INDEX_NUMERIC))
{
SET_MSG_RESULT(result, zbx_dsprintf(NULL, "zbx_snmp_print_oid():"
" cannot print OID \"%s\" with numeric indices.", OID));
ret = CONFIG_ERROR;
goto out;
}
root_numeric_len = strlen(snmp_oid);
/* copy rootOID to anOID */
memcpy(anOID, rootOID, rootOID_len * sizeof(oid));
anOID_len = rootOID_len;
/* initialize variables */
if (ZBX_SNMP_WALK_MODE_CACHE == mode)
{
cache_del_snmp_index_subtree(item, OID);
}
else
{
zbx_json_init(&j, ZBX_JSON_STAT_BUF_LEN);
zbx_json_addarray(&j, ZBX_PROTO_TAG_DATA);
}
level = 0;
running = 1;
while (1 == running)
{
/* create PDU */
if (NULL == (pdu = snmp_pdu_create(SNMP_BULK_ENABLED == bulk ? SNMP_MSG_GETBULK : SNMP_MSG_GETNEXT)))
{
SET_MSG_RESULT(result, zbx_strdup(NULL, "snmp_pdu_create(): cannot create PDU object."));
ret = CONFIG_ERROR;
break;
}
if (NULL == snmp_add_null_var(pdu, anOID, anOID_len)) /* add OID as variable to PDU */
{
SET_MSG_RESULT(result, zbx_strdup(NULL, "snmp_add_null_var(): cannot add null variable."));
ret = CONFIG_ERROR;
snmp_free_pdu(pdu);
break;
}
if (SNMP_BULK_ENABLED == bulk)
{
pdu->non_repeaters = 0;
pdu->max_repetitions = max_vars;
}
/* communicate with agent */
status = snmp_synch_response(ss, pdu, &response);
zabbix_log(LOG_LEVEL_DEBUG, "%s() snmp_synch_response() status:%d errstat:%ld max_vars:%d",
__function_name, status, NULL == response ? (long)-1 : response->errstat, max_vars);
if (1 < max_vars &&
((STAT_SUCCESS == status && SNMP_ERR_TOOBIG == response->errstat) || STAT_TIMEOUT == status))
{
/* The logic of iteratively reducing request size here is the same as in function */
/* zbx_snmp_get_values(). Please refer to the description there for explanation. */
if (*min_fail > max_vars)
*min_fail = max_vars;
if (0 == level)
{
max_vars /= 2;
}
else if (1 == level)
{
max_vars = 1;
}
level++;
goto next;
}
else if (STAT_SUCCESS != status || SNMP_ERR_NOERROR != response->errstat)
{
ret = zbx_get_snmp_response_error(ss, &item->interface, status, response, error, sizeof(error));
SET_MSG_RESULT(result, zbx_strdup(NULL, error));
running = 0;
goto next;
}
/* process response */
for (num_vars = 0, var = response->variables; NULL != var; num_vars++, var = var->next_variable)
{
/* verify if we are in the same subtree */
if (SNMP_ENDOFMIBVIEW == var->type || var->name_length < rootOID_len ||
0 != memcmp(rootOID, var->name, rootOID_len * sizeof(oid)))
{
/* reached the end or past this subtree */
running = 0;
break;
}
else if (SNMP_NOSUCHOBJECT != var->type && SNMP_NOSUCHINSTANCE != var->type)
{
/* not an exception value */
if (0 <= snmp_oid_compare(anOID, anOID_len, var->name, var->name_length))
{
SET_MSG_RESULT(result, zbx_strdup(NULL, "OID not increasing."));
ret = NOTSUPPORTED;
running = 0;
break;
}
if (SUCCEED != zbx_snmp_choose_index(snmp_oid, sizeof(snmp_oid), var->name,
var->name_length, root_string_len, root_numeric_len))
{
SET_MSG_RESULT(result, zbx_dsprintf(NULL, "zbx_snmp_choose_index():"
" cannot choose appropriate index while walking for"
" OID \"%s\".", OID));
ret = NOTSUPPORTED;
running = 0;
break;
}
init_result(&snmp_result);
if (SUCCEED == zbx_snmp_set_result(var, ITEM_VALUE_TYPE_STR, 0, &snmp_result) &&
NULL != GET_STR_RESULT(&snmp_result))
{
if (ZBX_SNMP_WALK_MODE_CACHE == mode)
{
cache_put_snmp_index(item, (char *)OID, snmp_result.str, snmp_oid);
}
else
{
zbx_json_addobject(&j, NULL);
zbx_json_addstring(&j, "{#SNMPINDEX}", snmp_oid, ZBX_JSON_TYPE_STRING);
zbx_json_addstring(&j, "{#SNMPVALUE}", snmp_result.str,
ZBX_JSON_TYPE_STRING);
zbx_json_close(&j);
}
}
else
{
char **msg;
msg = GET_MSG_RESULT(&snmp_result);
zabbix_log(LOG_LEVEL_DEBUG, "cannot get index '%s' string value: %s",
snmp_oid, NULL != msg && NULL != *msg ? *msg : "(null)");
}
free_result(&snmp_result);
/* go to next variable */
memcpy((char *)anOID, (char *)var->name, var->name_length * sizeof(oid));
anOID_len = var->name_length;
}
else
{
/* an exception value, so stop */
SET_MSG_RESULT(result, zbx_get_snmp_type_error(var->type));
ret = NOTSUPPORTED;
running = 0;
break;
}
}
if (*max_succeed < num_vars)
*max_succeed = num_vars;
next:
if (NULL != response)
snmp_free_pdu(response);
}
if (ZBX_SNMP_WALK_MODE_DISCOVERY == mode)
{
zbx_json_close(&j);
if (SUCCEED == ret)
SET_TEXT_RESULT(result, zbx_strdup(NULL, j.buffer));
zbx_json_free(&j);
}
out:
zabbix_log(LOG_LEVEL_DEBUG, "End of %s():%s", __function_name, zbx_result_string(ret));
return ret;
}
static int zbx_snmp_get_values(struct snmp_session *ss, const DC_ITEM *items, char oids[][ITEM_SNMP_OID_LEN_MAX],
AGENT_RESULT *results, int *errcodes, unsigned char *query_and_ignore_type, int num, int level,
char *error, int max_error_len, int *max_succeed, int *min_fail)
{
const char *__function_name = "zbx_snmp_get_values";
int i, j, status, ret = SUCCEED;
int mapping[MAX_SNMP_ITEMS], mapping_num = 0;
struct snmp_pdu *pdu, *response;
struct variable_list *var;
zabbix_log(LOG_LEVEL_DEBUG, "In %s() num:%d level:%d", __function_name, num, level);
if (NULL == (pdu = snmp_pdu_create(SNMP_MSG_GET)))
{
strlcpy(error, "snmp_pdu_create(): cannot create PDU object.", max_error_len);
ret = CONFIG_ERROR;
goto out;
}
for (i = 0; i < num; i++)
{
oid anOID[MAX_OID_LEN];
size_t anOID_len = MAX_OID_LEN;
if (SUCCEED != errcodes[i])
continue;
if (NULL != query_and_ignore_type && 0 == query_and_ignore_type[i])
continue;
if (NULL == snmp_parse_oid(oids[i], anOID, &anOID_len))
{
SET_MSG_RESULT(&results[i], zbx_dsprintf(NULL, "snmp_parse_oid(): cannot parse OID \"%s\".",
oids[i]));
errcodes[i] = CONFIG_ERROR;
continue;
}
if (NULL == snmp_add_null_var(pdu, anOID, anOID_len))
{
SET_MSG_RESULT(&results[i], zbx_strdup(NULL, "snmp_add_null_var(): cannot add null variable."));
errcodes[i] = CONFIG_ERROR;
continue;
}
mapping[mapping_num++] = i;
}
if (0 == mapping_num)
{
snmp_free_pdu(pdu);
goto out;
}
retry:
status = snmp_synch_response(ss, pdu, &response);
zabbix_log(LOG_LEVEL_DEBUG, "%s() snmp_synch_response() status:%d errstat:%ld mapping_num:%d",
__function_name, status, NULL == response ? (long)-1 : response->errstat, mapping_num);
if (STAT_SUCCESS == status && SNMP_ERR_NOERROR == response->errstat)
{
if (*max_succeed < mapping_num)
*max_succeed = mapping_num;
for (i = 0, var = response->variables; NULL != var; i++, var = var->next_variable)
{
j = mapping[i];
if (NULL != query_and_ignore_type && 1 == query_and_ignore_type[j])
{
(void)zbx_snmp_set_result(var, ITEM_VALUE_TYPE_STR, 0, &results[j]);
}
else
{
errcodes[j] = zbx_snmp_set_result(var, items[j].value_type, items[j].data_type,
&results[j]);
}
}
}
else if (STAT_SUCCESS == status && SNMP_ERR_NOSUCHNAME == response->errstat && 0 != response->errindex &&
ITEM_TYPE_SNMPv1 == items[0].type)
{
/* If a request PDU contains a bad variable, the specified behavior is different between SNMPv1 and */
/* later versions. In SNMPv1, the whole PDU is rejected and "response->errindex" is set to indicate */
/* the bad variable. In SNMPv2 and later, the SNMP agent processes the PDU by filling values for the */
/* known variables and marking unknown variables individually in the variable binding list. So if we */
/* get this error with SNMPv1, we fix the PDU by removing the bad variable and retry the request. */
i = response->errindex - 1;
j = mapping[i];
zabbix_log(LOG_LEVEL_DEBUG, "%s() snmp_synch_response() errindex:%ld oid:'%s'", __function_name,
response->errindex, oids[j]);
if (NULL == query_and_ignore_type || 0 == query_and_ignore_type[j])
{
errcodes[j] = zbx_get_snmp_response_error(ss, &items[0].interface, status, response, error,
max_error_len);
SET_MSG_RESULT(&results[j], zbx_strdup(NULL, error));
*error = '\0';
}
if (1 < mapping_num)
{
if (NULL != (pdu = snmp_fix_pdu(response, SNMP_MSG_GET)))
{
memmove(mapping + i, mapping + i + 1, sizeof(int) * (mapping_num - i - 1));
mapping_num--;
snmp_free_pdu(response);
goto retry;
}
else
{
strlcpy(error, "snmp_fix_pdu(): cannot fix PDU object.", max_error_len);
ret = NOTSUPPORTED;
}
}
}
else if (1 < mapping_num &&
((STAT_SUCCESS == status && SNMP_ERR_TOOBIG == response->errstat) || STAT_TIMEOUT == status))
{
/* Since we are trying to obtain multiple values from the SNMP agent, the response that it has to */
/* generate might be too big. It seems to be required by the SNMP standard that in such cases the */
/* error status should be set to "tooBig(1)". However, some devices simply do not respond to such */
/* queries and we get a timeout. Moreover, some devices exhibit both behaviors - they either send */
/* "tooBig(1)" or do not respond at all. So what we do is halve the number of variables to query - */
/* it should work in the vast majority of cases, because, since we are now querying "num" values, */
/* we know that querying "num/2" values succeeded previously. The case where it can still fail due */
/* to exceeded maximum response size is if we are now querying values that are unusually large. So */
/* if querying with half the number of the last values does not work either, we resort to querying */
/* values one by one, and the next time configuration cache gives us items to query, it will give */
/* us less. */
if (*min_fail > mapping_num)
*min_fail = mapping_num;
if (0 == level)
{
/* halve the number of items */
int base;
ret = zbx_snmp_get_values(ss, items, oids, results, errcodes, query_and_ignore_type, num / 2,
level + 1, error, max_error_len, max_succeed, min_fail);
if (SUCCEED != ret)
goto exit;
base = num / 2;
ret = zbx_snmp_get_values(ss, items + base, oids + base, results + base, errcodes + base,
NULL == query_and_ignore_type ? NULL : query_and_ignore_type + base, num - base,
level + 1, error, max_error_len, max_succeed, min_fail);
}
else if (1 == level)
{
/* resort to querying items one by one */
for (i = 0; i < num; i++)
{
if (SUCCEED != errcodes[i])
continue;
ret = zbx_snmp_get_values(ss, items + i, oids + i, results + i, errcodes + i,
NULL == query_and_ignore_type ? NULL : query_and_ignore_type + i, 1,
level + 1, error, max_error_len, max_succeed, min_fail);
if (SUCCEED != ret)
goto exit;
}
}
}
else
ret = zbx_get_snmp_response_error(ss, &items[0].interface, status, response, error, max_error_len);
exit:
if (NULL != response)
snmp_free_pdu(response);
out:
zabbix_log(LOG_LEVEL_DEBUG, "End of %s():%s", __function_name, zbx_result_string(ret));
return ret;
}
/******************************************************************************
* *
* Function: zbx_snmp_translate *
* *
* Purpose: translate well-known object identifiers into numeric form *
* *
* Author: Alexei Vladishev *
* *
******************************************************************************/
static void zbx_snmp_translate(char *oid_translated, const char *oid, size_t max_oid_len)
{
const char *__function_name = "zbx_snmp_translate";
typedef struct
{
const size_t sz;
const char *mib;
const char *replace;
}
zbx_mib_norm_t;
#define LEN_STR(x) sizeof(x) - 1, x
static zbx_mib_norm_t mibs[] =
{
/* the most popular items first */
{LEN_STR("ifDescr"), ".1.3.6.1.2.1.2.2.1.2"},
{LEN_STR("ifInOctets"), ".1.3.6.1.2.1.2.2.1.10"},
{LEN_STR("ifOutOctets"), ".1.3.6.1.2.1.2.2.1.16"},
{LEN_STR("ifAdminStatus"), ".1.3.6.1.2.1.2.2.1.7"},
{LEN_STR("ifOperStatus"), ".1.3.6.1.2.1.2.2.1.8"},
{LEN_STR("ifIndex"), ".1.3.6.1.2.1.2.2.1.1"},
{LEN_STR("ifType"), ".1.3.6.1.2.1.2.2.1.3"},
{LEN_STR("ifMtu"), ".1.3.6.1.2.1.2.2.1.4"},
{LEN_STR("ifSpeed"), ".1.3.6.1.2.1.2.2.1.5"},
{LEN_STR("ifPhysAddress"), ".1.3.6.1.2.1.2.2.1.6"},
{LEN_STR("ifInUcastPkts"), ".1.3.6.1.2.1.2.2.1.11"},
{LEN_STR("ifInNUcastPkts"), ".1.3.6.1.2.1.2.2.1.12"},
{LEN_STR("ifInDiscards"), ".1.3.6.1.2.1.2.2.1.13"},
{LEN_STR("ifInErrors"), ".1.3.6.1.2.1.2.2.1.14"},
{LEN_STR("ifInUnknownProtos"), ".1.3.6.1.2.1.2.2.1.15"},
{LEN_STR("ifOutUcastPkts"), ".1.3.6.1.2.1.2.2.1.17"},
{LEN_STR("ifOutNUcastPkts"), ".1.3.6.1.2.1.2.2.1.18"},
{LEN_STR("ifOutDiscards"), ".1.3.6.1.2.1.2.2.1.19"},
{LEN_STR("ifOutErrors"), ".1.3.6.1.2.1.2.2.1.20"},
{LEN_STR("ifOutQLen"), ".1.3.6.1.2.1.2.2.1.21"},
{0}
};
#undef LEN_STR
int found = 0, i;
zabbix_log(LOG_LEVEL_DEBUG, "In %s() oid:'%s'", __function_name, oid);
for (i = 0; 0 != mibs[i].sz; i++)
{
if (0 == strncmp(mibs[i].mib, oid, mibs[i].sz))
{
found = 1;
zbx_snprintf(oid_translated, max_oid_len, "%s%s", mibs[i].replace, oid + mibs[i].sz);
break;
}
}
if (0 == found)
zbx_strlcpy(oid_translated, oid, max_oid_len);
zabbix_log(LOG_LEVEL_DEBUG, "End of %s() oid_translated:'%s'", __function_name, oid_translated);
}
static int zbx_snmp_process_discovery(struct snmp_session *ss, const DC_ITEM *items, AGENT_RESULT *results,
int *errcodes, int num, char *error, int max_error_len, int *max_succeed, int *min_fail, int max_vars,
int bulk)
{
const char *__function_name = "zbx_snmp_process_discovery";
int ret;
char oid_translated[ITEM_SNMP_OID_LEN_MAX];
zabbix_log(LOG_LEVEL_DEBUG, "In %s()", __function_name);
assert(1 == num);
switch (num_key_param(items[0].snmp_oid))
{
case 0:
zbx_snmp_translate(oid_translated, items[0].snmp_oid, sizeof(oid_translated));
errcodes[0] = zbx_snmp_walk(ss, &items[0], oid_translated, ZBX_SNMP_WALK_MODE_DISCOVERY,
&results[0], max_succeed, min_fail, max_vars, bulk);
break;
default:
SET_MSG_RESULT(&results[0], zbx_dsprintf(NULL, "OID \"%s\" contains unsupported parameters.",
items[0].snmp_oid));
errcodes[0] = CONFIG_ERROR;
}
if (SUCCEED != (ret = errcodes[0]))
zbx_strlcpy(error, results[0].msg, max_error_len);
zabbix_log(LOG_LEVEL_DEBUG, "End of %s():%s", __function_name, zbx_result_string(ret));
return ret;
}
static int zbx_snmp_process_dynamic(struct snmp_session *ss, const DC_ITEM *items, AGENT_RESULT *results,
int *errcodes, int num, char *error, int max_error_len, int *max_succeed, int *min_fail, int bulk)
{
const char *__function_name = "zbx_snmp_process_dynamic";
int i, j, k, ret;
int to_walk[MAX_SNMP_ITEMS], to_walk_num = 0;
int to_verify[MAX_SNMP_ITEMS], to_verify_num = 0;
char to_verify_oids[MAX_SNMP_ITEMS][ITEM_SNMP_OID_LEN_MAX];
unsigned char query_and_ignore_type[MAX_SNMP_ITEMS];
char index_oids[MAX_SNMP_ITEMS][ITEM_SNMP_OID_LEN_MAX];
char index_values[MAX_SNMP_ITEMS][ITEM_SNMP_OID_LEN_MAX];
char oids_translated[MAX_SNMP_ITEMS][ITEM_SNMP_OID_LEN_MAX];
char *idx = NULL, *pl;
size_t idx_alloc = 32;
zabbix_log(LOG_LEVEL_DEBUG, "In %s()", __function_name);
idx = zbx_malloc(idx, idx_alloc);
/* perform initial item validation */
for (i = 0; i < num; i++)
{
char method[8];
if (SUCCEED != errcodes[i])
continue;
if (3 != num_key_param(items[i].snmp_oid))
{
SET_MSG_RESULT(&results[i], zbx_dsprintf(NULL, "OID \"%s\" contains unsupported parameters.",
items[i].snmp_oid));
errcodes[i] = CONFIG_ERROR;
continue;
}
get_key_param(items[i].snmp_oid, 1, method, sizeof(method));
get_key_param(items[i].snmp_oid, 2, index_oids[i], sizeof(index_oids[i]));
get_key_param(items[i].snmp_oid, 3, index_values[i], sizeof(index_values[i]));
if (0 != strcmp("index", method))
{
SET_MSG_RESULT(&results[i], zbx_dsprintf(NULL, "Unsupported method \"%s\" in the OID \"%s\".",
method, items[i].snmp_oid));
errcodes[i] = CONFIG_ERROR;
continue;
}
zbx_snmp_translate(oids_translated[i], index_oids[i], sizeof(oids_translated[i]));
if (SUCCEED == cache_get_snmp_index(&items[i], oids_translated[i], index_values[i], &idx, &idx_alloc))
{
zbx_snprintf(to_verify_oids[i], sizeof(to_verify_oids[i]), "%s.%s", oids_translated[i], idx);
to_verify[to_verify_num++] = i;
query_and_ignore_type[i] = 1;
}
else
{
to_walk[to_walk_num++] = i;
query_and_ignore_type[i] = 0;
}
}
/* verify that cached indices are still valid */
if (0 != to_verify_num)
{
ret = zbx_snmp_get_values(ss, items, to_verify_oids, results, errcodes, query_and_ignore_type, num, 0,
error, max_error_len, max_succeed, min_fail);
if (SUCCEED != ret)
goto exit;
for (i = 0; i < to_verify_num; i++)
{
j = to_verify[i];
if (SUCCEED != errcodes[j])
continue;
if (NULL == GET_STR_RESULT(&results[j]) || 0 != strcmp(results[j].str, index_values[j]))
{
to_walk[to_walk_num++] = j;
}
else
{
/* ready to construct the final OID with index */
size_t len;
len = strlen(oids_translated[j]);
pl = strchr(items[j].snmp_oid, '[');
*pl = '\0';
zbx_snmp_translate(oids_translated[j], items[j].snmp_oid, sizeof(oids_translated[j]));
*pl = '[';
zbx_strlcat(oids_translated[j], to_verify_oids[j] + len, sizeof(oids_translated[j]));
}
free_result(&results[j]);
}
}
/* walk OID trees to build index cache for cache misses */
if (0 != to_walk_num)
{
for (i = 0; i < to_walk_num; i++)
{
int errcode;
AGENT_RESULT result;
j = to_walk[i];
/* see whether this OID tree was already walked for another item */
for (k = 0; k < i; k++)
{
if (0 == strcmp(oids_translated[to_walk[k]], oids_translated[j]))
break;
}
if (k != i)
continue;
/* walk */
init_result(&result);
errcode = zbx_snmp_walk(ss, &items[j], oids_translated[j], ZBX_SNMP_WALK_MODE_CACHE, &result,
max_succeed, min_fail, num, bulk);
if (NETWORK_ERROR == errcode)
{
/* consider a network error as relating to all items passed to */
/* this function, including those we did not just try to walk for */
strlcpy(error, result.msg, max_error_len);
ret = NETWORK_ERROR;
free_result(&result);
goto exit;
}
if (CONFIG_ERROR == errcode || NOTSUPPORTED == errcode)
{
/* consider a configuration or "not supported" error as */
/* relating only to the items we have just tried to walk for */
for (k = i; k < to_walk_num; k++)
{
if (0 == strcmp(oids_translated[to_walk[k]], oids_translated[j]))
{
SET_MSG_RESULT(&results[to_walk[k]], zbx_strdup(NULL, result.msg));
errcodes[to_walk[k]] = errcode;
}
}
}
free_result(&result);
}
for (i = 0; i < to_walk_num; i++)
{
j = to_walk[i];
if (SUCCEED != errcodes[j])
continue;
if (SUCCEED == cache_get_snmp_index(&items[j], oids_translated[j], index_values[j], &idx,
&idx_alloc))
{
/* ready to construct the final OID with index */
pl = strchr(items[j].snmp_oid, '[');
*pl = '\0';
zbx_snmp_translate(oids_translated[j], items[j].snmp_oid, sizeof(oids_translated[j]));
*pl = '[';
zbx_strlcat(oids_translated[j], ".", sizeof(oids_translated[j]));
zbx_strlcat(oids_translated[j], idx, sizeof(oids_translated[j]));
}
else
{
SET_MSG_RESULT(&results[j], zbx_dsprintf(NULL,
"Cannot find index of \"%s\" in \"%s\".",
index_values[j], index_oids[j]));
errcodes[j] = NOTSUPPORTED;
}
}
}
/* query values based on the indices verified and/or determined above */
ret = zbx_snmp_get_values(ss, items, oids_translated, results, errcodes, NULL, num, 0, error, max_error_len,
max_succeed, min_fail);
exit:
zbx_free(idx);
zabbix_log(LOG_LEVEL_DEBUG, "End of %s():%s", __function_name, zbx_result_string(ret));
return ret;
}
static int zbx_snmp_process_standard(struct snmp_session *ss, const DC_ITEM *items, AGENT_RESULT *results,
int *errcodes, int num, char *error, int max_error_len, int *max_succeed, int *min_fail)
{
const char *__function_name = "zbx_snmp_process_standard";
int i, ret;
char oids_translated[MAX_SNMP_ITEMS][ITEM_SNMP_OID_LEN_MAX];
zabbix_log(LOG_LEVEL_DEBUG, "In %s()", __function_name);
for (i = 0; i < num; i++)
{
if (SUCCEED != errcodes[i])
continue;
if (0 != num_key_param(items[i].snmp_oid))
{
SET_MSG_RESULT(&results[i], zbx_dsprintf(NULL, "OID \"%s\" contains unsupported parameters.",
items[i].snmp_oid));
errcodes[i] = CONFIG_ERROR;
continue;
}
zbx_snmp_translate(oids_translated[i], items[i].snmp_oid, sizeof(oids_translated[i]));
}
ret = zbx_snmp_get_values(ss, items, oids_translated, results, errcodes, NULL, num, 0, error, max_error_len,
max_succeed, min_fail);
zabbix_log(LOG_LEVEL_DEBUG, "End of %s():%s", __function_name, zbx_result_string(ret));
return ret;
}
int get_value_snmp(const DC_ITEM *item, AGENT_RESULT *result)
{
int errcode = SUCCEED;
get_values_snmp(item, result, &errcode, 1);
return errcode;
}
void get_values_snmp(const DC_ITEM *items, AGENT_RESULT *results, int *errcodes, int num)
{
const char *__function_name = "get_values_snmp";
struct snmp_session *ss;
char error[MAX_STRING_LEN];
int i, j, err = SUCCEED, max_succeed = 0, min_fail = MAX_SNMP_ITEMS + 1,
bulk = SNMP_BULK_ENABLED;
zabbix_log(LOG_LEVEL_DEBUG, "In %s() host:'%s' addr:'%s' num:%d",
__function_name, items[0].host.host, items[0].interface.addr, num);
for (j = 0; j < num; j++) /* locate first supported item to use as a reference */
{
if (SUCCEED == errcodes[j])
break;
}
if (j == num) /* all items already NOTSUPPORTED (with invalid key, port or SNMP parameters) */
goto out;
if (NULL == (ss = zbx_snmp_open_session(&items[j], error, sizeof(error))))
{
err = NETWORK_ERROR;
goto exit;
}
if (0 != (ZBX_FLAG_DISCOVERY_RULE & items[j].flags))
{
int max_vars;
max_vars = DCconfig_get_suggested_snmp_vars(items[j].interface.interfaceid, &bulk);
err = zbx_snmp_process_discovery(ss, items + j, results + j, errcodes + j, num - j, error, sizeof(error),
&max_succeed, &min_fail, max_vars, bulk);
}
else if (NULL != strchr(items[j].snmp_oid, '['))
{
(void)DCconfig_get_suggested_snmp_vars(items[j].interface.interfaceid, &bulk);
err = zbx_snmp_process_dynamic(ss, items + j, results + j, errcodes + j, num - j, error, sizeof(error),
&max_succeed, &min_fail, bulk);
}
else
{
err = zbx_snmp_process_standard(ss, items + j, results + j, errcodes + j, num - j, error, sizeof(error),
&max_succeed, &min_fail);
}
zbx_snmp_close_session(ss);
exit:
if (SUCCEED != err)
{
zabbix_log(LOG_LEVEL_DEBUG, "getting SNMP values failed: %s", error);
for (i = j; i < num; i++)
{
if (SUCCEED != errcodes[i])
continue;
SET_MSG_RESULT(&results[i], zbx_strdup(NULL, error));
errcodes[i] = err;
}
}
else if (SNMP_BULK_ENABLED == bulk && (0 != max_succeed || MAX_SNMP_ITEMS + 1 != min_fail))
{
DCconfig_update_interface_snmp_stats(items[j].interface.interfaceid, max_succeed, min_fail);
}
out:
zabbix_log(LOG_LEVEL_DEBUG, "End of %s()", __function_name);
}
#endif /* HAVE_SNMP */
|