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 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916
|
/*
* snmpksm.c
*
* This code implements the Kerberos Security Model (KSM) for SNMP.
*
* Security number - 2066432
*/
#include <net-snmp/net-snmp-config.h>
#include <sys/types.h>
#include <stdio.h>
#ifdef HAVE_STDLIB_H
#include <stdlib.h>
#endif
#if TIME_WITH_SYS_TIME
# include <sys/time.h>
# include <time.h>
#else
# if HAVE_SYS_TIME_H
# include <sys/time.h>
# else
# include <time.h>
# endif
#endif
#if HAVE_STRING_H
#include <string.h>
#else
#include <strings.h>
#endif
#ifdef HAVE_NETINET_IN_H
#include <netinet/in.h>
#endif
#include <errno.h>
#ifdef NETSNMP_USE_KERBEROS_HEIMDAL
#ifndef NETSNMP_USE_KERBEROS_MIT
#define OLD_HEIMDAL
#endif /* ! NETSNMP_USE_KERBEROS_MIT */
#else
#define KRB5_DEPRECATED 1
#endif /* NETSNMP_USE_KERBEROS_HEIMDAL */
#ifdef NETSNMP_USE_KERBEROS_HEIMDAL
#define oid heimdal_oid_renamed
#endif /* NETSNMP_USE_KERBEROS_HEIMDAL */
#include <krb5.h>
#ifdef NETSNMP_USE_KERBEROS_HEIMDAL
#undef oid
#endif /* NETSNMP_USE_KERBEROS_HEIMDAL */
#ifdef NETSNMP_USE_KERBEROS_HEIMDAL
#define CHECKSUM_TYPE(x) (x)->cksumtype
#define CHECKSUM_CONTENTS(x) (x)->checksum.data
#define CHECKSUM_LENGTH(x) (x)->checksum.length
#define TICKET_CLIENT(x) (x)->client
#else /* NETSNMP_USE_KERBEROS_HEIMDAL */
#define CHECKSUM_TYPE(x) (x)->checksum_type
#define CHECKSUM_CONTENTS(x) (x)->contents
#define CHECKSUM_LENGTH(x) (x)->length
#define TICKET_CLIENT(x) (x)->enc_part2->client
#endif /* NETSNMP_USE_KERBEROS_HEIMDAL */
#if HAVE_ET_COM_ERR_H
#include <et/com_err.h>
#elif HAVE_COM_ERR_H
#include <com_err.h>
#else
static const char *error_message(int ret) { return "(?)"; }
#endif
#include <net-snmp/output_api.h>
#include <net-snmp/config_api.h>
#include <net-snmp/utilities.h>
#include <net-snmp/library/asn1.h>
#include <net-snmp/library/snmp_api.h>
#include <net-snmp/library/callback.h>
#include <net-snmp/library/keytools.h>
#include <net-snmp/library/snmpv3.h>
#include <net-snmp/library/lcd_time.h>
#include <net-snmp/library/scapi.h>
#include <net-snmp/library/callback.h>
#include <net-snmp/library/snmp_secmod.h>
#include <net-snmp/library/snmpksm.h>
static krb5_context kcontext = NULL;
static krb5_rcache rcache = NULL;
static krb5_keytab keytab = NULL;
static int keytab_setup = 0;
static char *service_name = NULL;
static char service_host[] = "host";
static u_char null_id[] = {0};
static int ksm_session_init(netsnmp_session *);
static void ksm_free_state_ref(void *);
static int ksm_free_pdu(netsnmp_pdu *);
static int ksm_clone_pdu(netsnmp_pdu *, netsnmp_pdu *);
static int ksm_insert_cache(long, krb5_auth_context, u_char *,
size_t);
static void ksm_decrement_ref_count(long);
static void ksm_increment_ref_count(long);
static struct ksm_cache_entry *ksm_get_cache(long);
#if !defined(HAVE_KRB5_AUTH_CON_GETSENDSUBKEY) /* Heimdal */
krb5_error_code krb5_auth_con_getsendsubkey(krb5_context context,
krb5_auth_context auth_context,
krb5_keyblock **keyblock)
{
return krb5_auth_con_getlocalsubkey(context, auth_context, keyblock);
}
#endif
#if !defined(HAVE_KRB5_AUTH_CON_GETRECVSUBKEY) /* Heimdal */
krb5_error_code krb5_auth_con_getrecvsubkey(krb5_context context,
krb5_auth_context auth_context,
krb5_keyblock **keyblock)
{
return krb5_auth_con_getremotesubkey(context, auth_context, keyblock);
}
#endif
#define HASHSIZE 64
/*
* Our information stored for the response PDU.
*/
struct ksm_secStateRef {
krb5_auth_context auth_context;
krb5_cksumtype cksumtype;
};
/*
* A KSM outgoing pdu cache entry
*/
struct ksm_cache_entry {
long msgid;
int refcount;
krb5_auth_context auth_context;
u_char *secName;
size_t secNameLen;
struct ksm_cache_entry *next;
};
/*
* Poor man's hash table
*/
static struct ksm_cache_entry *ksm_hash_table[HASHSIZE];
/*
* Stuff to deal with config values
* Note the conditionals that wrap these--i don't know if these are
* needed, since i don't know how library initialization and callbacks
* and stuff work
*/
static int
init_snmpksm_post_config(int majorid, int minorid, void *serverarg,
void *clientarg)
{
if (kcontext == NULL) {
/* not reached, i'd imagine */
return SNMPERR_KRB5;
}
if (service_name == NULL) {
/* always reached, i'd imagine */
char *c = netsnmp_ds_get_string(NETSNMP_DS_LIBRARY_ID,
NETSNMP_DS_LIB_KSM_SERVICE_NAME);
if (c != NULL) {
service_name = c;
}
else {
service_name = service_host;
}
}
if (keytab_setup == 0) {
/* always reached, i'd imagine */
char *c = netsnmp_ds_get_string(NETSNMP_DS_LIBRARY_ID,
NETSNMP_DS_LIB_KSM_KEYTAB);
if (c) {
krb5_error_code retval;
DEBUGMSGTL(("ksm", "Using keytab %s\n", c));
retval = krb5_kt_resolve(kcontext, c, &keytab);
if (retval) {
DEBUGMSGTL(("ksm", "krb5_kt_resolve(\"%s\") failed. KSM "
"config callback failing\n", error_message(retval)));
return SNMPERR_KRB5;
}
}
else {
DEBUGMSGTL(("ksm", "Using default keytab\n"));
}
keytab_setup = 1;
}
return SNMPERR_SUCCESS;
}
/*
* Initialize all of the state required for Kerberos (right now, just call
* krb5_init_context).
*/
void
init_ksm(void)
{
krb5_error_code retval;
struct snmp_secmod_def *def;
int i;
netsnmp_ds_register_config(ASN_OCTET_STR, "snmp", "defKSMKeytab",
NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_KSM_KEYTAB);
netsnmp_ds_register_config(ASN_OCTET_STR, "snmp", "defKSMServiceName",
NETSNMP_DS_LIBRARY_ID,
NETSNMP_DS_LIB_KSM_SERVICE_NAME);
snmp_register_callback(SNMP_CALLBACK_LIBRARY,
SNMP_CALLBACK_POST_READ_CONFIG,
init_snmpksm_post_config, NULL);
if (kcontext == NULL) {
retval = krb5_init_context(&kcontext);
if (retval) {
DEBUGMSGTL(("ksm", "krb5_init_context failed (%s), not "
"registering KSM\n", error_message(retval)));
return;
}
}
for (i = 0; i < HASHSIZE; i++)
ksm_hash_table[i] = NULL;
def = SNMP_MALLOC_STRUCT(snmp_secmod_def);
if (!def) {
DEBUGMSGTL(("ksm", "Unable to malloc snmp_secmod struct, not "
"registering KSM\n"));
return;
}
def->encode_reverse = ksm_rgenerate_out_msg;
def->decode = ksm_process_in_msg;
def->session_open = ksm_session_init;
def->pdu_free_state_ref = ksm_free_state_ref;
def->pdu_free = ksm_free_pdu;
def->pdu_clone = ksm_clone_pdu;
register_sec_mod(NETSNMP_SEC_MODEL_KSM, "ksm", def);
}
void shutdown_ksm(void)
{
}
/*
* These routines implement a simple cache for information we need to
* process responses. When we send out a request, it contains an AP_REQ;
* we get back an AP_REP, and we need the authorization context from the
* AP_REQ to decrypt the AP_REP. But because right now there's nothing
* that gets preserved across calls to rgenerate_out_msg to process_in_msg,
* we cache these internally based on the message ID (we also cache the
* passed-in security name, for reasons that are mostly stupid).
*/
static int
ksm_insert_cache(long msgid, krb5_auth_context auth_context,
u_char * secName, size_t secNameLen)
{
struct ksm_cache_entry *entry;
int bucket;
entry = SNMP_MALLOC_STRUCT(ksm_cache_entry);
if (!entry)
return SNMPERR_MALLOC;
entry->msgid = msgid;
entry->auth_context = auth_context;
entry->refcount = 1;
entry->secName = netsnmp_memdup(secName, secNameLen);
if (secName && !entry->secName) {
free(entry);
return SNMPERR_GENERR;
}
entry->secNameLen = secNameLen;
bucket = msgid % HASHSIZE;
entry->next = ksm_hash_table[bucket];
ksm_hash_table[bucket] = entry;
return SNMPERR_SUCCESS;
}
static struct ksm_cache_entry *
ksm_get_cache(long msgid)
{
struct ksm_cache_entry *entry;
int bucket;
bucket = msgid % HASHSIZE;
for (entry = ksm_hash_table[bucket]; entry != NULL;
entry = entry->next)
if (entry->msgid == msgid)
return entry;
return NULL;
}
static void
ksm_decrement_ref_count(long msgid)
{
struct ksm_cache_entry *entry, *entry1;
int bucket;
bucket = msgid % HASHSIZE;
if (ksm_hash_table[bucket] && ksm_hash_table[bucket]->msgid == msgid) {
entry = ksm_hash_table[bucket];
/*
* If the reference count is zero, then free it
*/
if (--entry->refcount <= 0) {
DEBUGMSGTL(("ksm", "Freeing entry for msgid %ld\n", msgid));
krb5_auth_con_free(kcontext, entry->auth_context);
free(entry->secName);
ksm_hash_table[bucket] = entry->next;
free(entry);
}
return;
} else if (ksm_hash_table[bucket])
for (entry1 = ksm_hash_table[bucket], entry = entry1->next;
entry != NULL; entry1 = entry, entry = entry->next)
if (entry->msgid == msgid) {
if (--entry->refcount <= 0) {
DEBUGMSGTL(("ksm", "Freeing entry for msgid %ld\n",
msgid));
krb5_auth_con_free(kcontext, entry->auth_context);
free(entry->secName);
entry1->next = entry->next;
free(entry);
}
return;
}
DEBUGMSGTL(("ksm",
"KSM: Unable to decrement cache entry for msgid %ld.\n",
msgid));
}
static void
ksm_increment_ref_count(long msgid)
{
struct ksm_cache_entry *entry = ksm_get_cache(msgid);
if (!entry) {
DEBUGMSGTL(("ksm", "Unable to find cache entry for msgid %ld "
"for increment\n", msgid));
return;
}
entry->refcount++;
}
/*
* Initialize specific session information (right now, just set up things to
* not do an engineID probe)
*/
static int
ksm_session_init(netsnmp_session * sess)
{
DEBUGMSGTL(("ksm",
"KSM: Reached our session initialization callback\n"));
sess->flags |= SNMP_FLAGS_DONT_PROBE;
return SNMPERR_SUCCESS;
}
/*
* Free our state information (this is only done on the agent side)
*/
static void
ksm_free_state_ref(void *ptr)
{
struct ksm_secStateRef *ref = (struct ksm_secStateRef *) ptr;
DEBUGMSGTL(("ksm", "KSM: Freeing state reference\n"));
krb5_auth_con_free(kcontext, ref->auth_context);
free(ref);
}
/*
* This is called when the PDU is freed; this will decrement reference counts
* for entries in our state cache.
*/
static int
ksm_free_pdu(netsnmp_pdu *pdu)
{
ksm_decrement_ref_count(pdu->msgid);
DEBUGMSGTL(("ksm", "Decrementing cache entry for PDU msgid %ld\n",
pdu->msgid));
return SNMPERR_SUCCESS;
}
/*
* This is called when a PDU is cloned (to increase reference counts)
*/
static int
ksm_clone_pdu(netsnmp_pdu *pdu, netsnmp_pdu *pdu2)
{
ksm_increment_ref_count(pdu->msgid);
DEBUGMSGTL(("ksm", "Incrementing cache entry for PDU msgid %ld\n",
pdu->msgid));
return SNMPERR_SUCCESS;
}
/****************************************************************************
*
* ksm_generate_out_msg
*
* Parameters:
* (See list below...)
*
* Returns:
* SNMPERR_GENERIC On success.
* SNMPERR_KRB5
* ... and others
*
*
* Generate an outgoing message.
*
****************************************************************************/
int
ksm_rgenerate_out_msg(struct snmp_secmod_outgoing_params *parms)
{
krb5_auth_context auth_context = NULL;
krb5_error_code retcode;
krb5_ccache cc = NULL;
int retval = SNMPERR_SUCCESS;
krb5_data outdata, ivector;
krb5_keyblock *subkey = NULL;
#ifdef NETSNMP_USE_KERBEROS_MIT
krb5_data input;
krb5_enc_data output;
unsigned int numcksumtypes;
krb5_cksumtype *cksumtype_array;
#elif defined OLD_HEIMDAL /* NETSNMP_USE_KERBEROS_MIT */
krb5_crypto heim_crypto = NULL;
#else /* NETSNMP_USE_KERBEROS_MIT */
krb5_encrypt_block eblock;
#endif /* NETSNMP_USE_KERBEROS_MIT */
#ifndef OLD_HEIMDAL
size_t blocksize;
#endif
size_t encrypted_length;
unsigned char *encrypted_data = NULL;
long zero = 0, tmp;
int i;
u_char *cksum_pointer;
krb5_cksumtype cksumtype;
krb5_checksum pdu_checksum;
u_char **wholeMsg = parms->wholeMsg;
size_t *offset = parms->wholeMsgOffset, seq_offset;
struct ksm_secStateRef *ksm_state = (struct ksm_secStateRef *)
parms->secStateRef;
#ifdef OLD_HEIMDAL
krb5_data encrypted_scoped_pdu;
#endif /* OLD_HEIMDAL */
int rc;
char *colon = NULL;
DEBUGMSGTL(("ksm", "Starting KSM processing\n"));
outdata.length = 0;
outdata.data = NULL;
ivector.length = 0;
ivector.data = NULL;
CHECKSUM_CONTENTS(&pdu_checksum) = NULL;
if (!ksm_state) {
/*
* If we've got a port number as part of the "peername", then
* suppress this (temporarily) while we build the credential info.
* XXX - what about "udp:host" style addresses?
*/
colon = strrchr(parms->session->peername, ':');
if (colon != NULL) {
*colon='\0';
}
/*
* If we don't have a ksm_state, then we're a request. Get a
* credential cache and build a ap_req.
*/
retcode = krb5_cc_default(kcontext, &cc);
if (retcode) {
DEBUGMSGTL(("ksm", "KSM: krb5_cc_default failed: %s\n",
error_message(retcode)));
snmp_set_detail(error_message(retcode));
retval = SNMPERR_KRB5;
goto error;
}
DEBUGMSGTL(("ksm", "KSM: Set credential cache successfully\n"));
/*
* This seems odd, since we don't need this until later (or earlier,
* depending on how you look at it), but because the most likely
* errors are Kerberos at this point, I'll get this now to save
* time not encoding the rest of the packet.
*
* Also, we need the subkey to encrypt the PDU (if required).
*/
retcode =
krb5_mk_req(kcontext, &auth_context,
AP_OPTS_MUTUAL_REQUIRED | AP_OPTS_USE_SUBKEY,
service_name, parms->session->peername, NULL,
cc, &outdata);
if (colon != NULL)
*colon=':';
if (retcode) {
DEBUGMSGTL(("ksm", "KSM: krb5_mk_req failed: %s\n",
error_message(retcode)));
snmp_set_detail(error_message(retcode));
retval = SNMPERR_KRB5;
goto error;
}
DEBUGMSGTL(("ksm", "KSM: ticket retrieved successfully for \"%s/%s\" "
"(may not be actual ticket sname)\n", service_name,
parms->session->peername));
} else {
/*
* Grab the auth_context from our security state reference
*/
auth_context = ksm_state->auth_context;
/*
* Bundle up an AP_REP. Note that we do this only when we
* have a security state reference (which means we're in an agent
* and we're sending a response).
*/
DEBUGMSGTL(("ksm", "KSM: Starting reply processing.\n"));
retcode = krb5_mk_rep(kcontext, auth_context, &outdata);
if (retcode) {
DEBUGMSGTL(("ksm", "KSM: krb5_mk_rep failed: %s\n",
error_message(retcode)));
snmp_set_detail(error_message(retcode));
retval = SNMPERR_KRB5;
goto error;
}
DEBUGMSGTL(("ksm", "KSM: Finished with krb5_mk_rep()\n"));
}
/*
* If we have to encrypt the PDU, do that now
*/
if (parms->secLevel == SNMP_SEC_LEVEL_AUTHPRIV) {
DEBUGMSGTL(("ksm", "KSM: Starting PDU encryption.\n"));
/*
* It's weird -
*
* If we're on the manager, it's a local subkey (because that's in
* our AP_REQ)
*
* If we're on the agent, it's a remote subkey (because that comes
* FROM the received AP_REQ).
*/
if (ksm_state)
retcode = krb5_auth_con_getrecvsubkey(kcontext, auth_context,
&subkey);
else
retcode = krb5_auth_con_getsendsubkey(kcontext, auth_context,
&subkey);
if (retcode) {
DEBUGMSGTL(("ksm",
"KSM: krb5_auth_con_getsendsubkey failed: %s\n",
error_message(retcode)));
snmp_set_detail(error_message(retcode));
retval = SNMPERR_KRB5;
goto error;
}
/*
* Note that here we need to handle different things between the
* old and new crypto APIs. First, we need to get the final encrypted
* length of the PDU.
*/
#ifdef NETSNMP_USE_KERBEROS_MIT
retcode = krb5_c_encrypt_length(kcontext, subkey->enctype,
parms->scopedPduLen,
&encrypted_length);
if (retcode) {
DEBUGMSGTL(("ksm",
"Encryption length calculation failed: %s\n",
error_message(retcode)));
snmp_set_detail(error_message(retcode));
retval = SNMPERR_KRB5;
goto error;
}
#elif defined OLD_HEIMDAL
retcode = krb5_crypto_init(kcontext, subkey, 0, &heim_crypto);
if (retcode) {
DEBUGMSGTL(("ksm", "krb5_crypto_init failed: %s\n",
error_message(retcode)));
snmp_set_detail(error_message(retcode));
retval = SNMPERR_KRB5;
goto error;
}
encrypted_length = krb5_get_wrapped_length(kcontext, heim_crypto,
parms->scopedPduLen);
#else /* NETSNMP_USE_KERBEROS_MIT */
krb5_use_enctype(kcontext, &eblock, subkey->enctype);
retcode = krb5_process_key(kcontext, &eblock, subkey);
if (retcode) {
DEBUGMSGTL(("ksm", "krb5_process_key failed: %s\n",
error_message(retcode)));
snmp_set_detail(error_message(retcode));
retval = SNMPERR_KRB5;
goto error;
}
encrypted_length = krb5_encrypt_size(parms->scopedPduLen,
eblock.crypto_entry);
#endif /* NETSNMP_USE_KERBEROS_MIT */
#ifndef OLD_HEIMDAL /* since heimdal allocs the space for us */
encrypted_data = malloc(encrypted_length);
if (!encrypted_data) {
DEBUGMSGTL(("ksm",
"KSM: Unable to malloc %d bytes for encrypt "
"buffer: %s\n", (int)parms->scopedPduLen,
strerror(errno)));
retval = SNMPERR_MALLOC;
#ifndef NETSNMP_USE_KERBEROS_MIT
krb5_finish_key(kcontext, &eblock);
#endif /* ! NETSNMP_USE_KERBEROS_MIT */
goto error;
}
#endif /* ! OLD_HEIMDAL */
/*
* We need to set up a blank initialization vector for the encryption.
* Use a block of all zero's (which is dependent on the block size
* of the encryption method).
*/
#ifdef NETSNMP_USE_KERBEROS_MIT
retcode = krb5_c_block_size(kcontext, subkey->enctype, &blocksize);
if (retcode) {
DEBUGMSGTL(("ksm",
"Unable to determine crypto block size: %s\n",
error_message(retcode)));
snmp_set_detail(error_message(retcode));
retval = SNMPERR_KRB5;
goto error;
}
#elif defined (OLD_HEIMDAL) /* NETSNMP_USE_KERBEROS_MIT */
#else /* NETSNMP_USE_KERBEROS_MIT */
blocksize =
krb5_enctype_array[subkey->enctype]->system->block_length;
#endif /* NETSNMP_USE_KERBEROS_MIT */
#ifndef OLD_HEIMDAL /* since allocs the space for us */
ivector.data = malloc(blocksize);
if (!ivector.data) {
DEBUGMSGTL(("ksm", "Unable to allocate %d bytes for ivector\n",
(int)blocksize));
retval = SNMPERR_MALLOC;
goto error;
}
ivector.length = blocksize;
memset(ivector.data, 0, blocksize);
#endif /* OLD_HEIMDAL */
/*
* Finally! Do the encryption!
*/
#ifdef NETSNMP_USE_KERBEROS_MIT
input.data = (char *) parms->scopedPdu;
input.length = parms->scopedPduLen;
output.ciphertext.data = (char *) encrypted_data;
output.ciphertext.length = encrypted_length;
retcode =
krb5_c_encrypt(kcontext, subkey, KSM_KEY_USAGE_ENCRYPTION,
&ivector, &input, &output);
#elif defined OLD_HEIMDAL /* NETSNMP_USE_KERBEROS_MIT */
krb5_data_zero(&encrypted_scoped_pdu);
retcode = krb5_encrypt(kcontext, heim_crypto, KSM_KEY_USAGE_ENCRYPTION,
parms->scopedPdu, parms->scopedPduLen,
&encrypted_scoped_pdu);
if (retcode == 0) {
encrypted_length = encrypted_scoped_pdu.length;
encrypted_data = encrypted_scoped_pdu.data;
krb5_data_zero(&encrypted_scoped_pdu);
}
#else /* NETSNMP_USE_KERBEROS_MIT */
retcode = krb5_encrypt(kcontext, (krb5_pointer) parms->scopedPdu,
(krb5_pointer) encrypted_data,
parms->scopedPduLen, &eblock, ivector.data);
krb5_finish_key(kcontext, &eblock);
#endif /* NETSNMP_USE_KERBEROS_MIT */
if (retcode) {
DEBUGMSGTL(("ksm", "KSM: krb5_encrypt failed: %s\n",
error_message(retcode)));
retval = SNMPERR_KRB5;
snmp_set_detail(error_message(retcode));
goto error;
}
*offset = 0;
rc = asn_realloc_rbuild_string(wholeMsg, parms->wholeMsgLen,
offset, 1,
(u_char) (ASN_UNIVERSAL |
ASN_PRIMITIVE |
ASN_OCTET_STR),
encrypted_data,
encrypted_length);
if (rc == 0) {
DEBUGMSGTL(("ksm", "Building encrypted payload failed.\n"));
retval = SNMPERR_TOO_LONG;
goto error;
}
DEBUGMSGTL(("ksm", "KSM: Encryption complete.\n"));
} else {
/*
* Plaintext PDU (not encrypted)
*/
if (*parms->wholeMsgLen < parms->scopedPduLen) {
DEBUGMSGTL(("ksm", "Not enough room for plaintext PDU.\n"));
retval = SNMPERR_TOO_LONG;
goto error;
}
}
/*
* Start encoding the msgSecurityParameters
*
* For now, use 0 for the response hint
*/
DEBUGMSGTL(("ksm", "KSM: scopedPdu added to payload\n"));
seq_offset = *offset;
rc = asn_realloc_rbuild_int(wholeMsg, parms->wholeMsgLen,
offset, 1,
(u_char) (ASN_UNIVERSAL |
ASN_PRIMITIVE |
ASN_INTEGER),
(long *) &zero, sizeof(zero));
if (rc == 0) {
DEBUGMSGTL(("ksm", "Building ksm security parameters failed.\n"));
retval = SNMPERR_TOO_LONG;
goto error;
}
rc = asn_realloc_rbuild_string(wholeMsg, parms->wholeMsgLen,
offset, 1,
(u_char) (ASN_UNIVERSAL |
ASN_PRIMITIVE |
ASN_OCTET_STR),
(u_char *) outdata.data,
outdata.length);
if (rc == 0) {
DEBUGMSGTL(("ksm", "Building ksm AP_REQ failed.\n"));
retval = SNMPERR_TOO_LONG;
goto error;
}
/*
* If we didn't encrypt the packet, we haven't yet got the subkey.
* Get that now.
*/
if (!subkey) {
if (ksm_state)
retcode = krb5_auth_con_getrecvsubkey(kcontext, auth_context,
&subkey);
else
retcode = krb5_auth_con_getsendsubkey(kcontext, auth_context,
&subkey);
if (retcode) {
DEBUGMSGTL(("ksm", "krb5_auth_con_getsendsubkey failed: %s\n",
error_message(retcode)));
snmp_set_detail(error_message(retcode));
retval = SNMPERR_KRB5;
goto error;
}
#ifdef OLD_HEIMDAL
retcode = krb5_crypto_init(kcontext, subkey, 0, &heim_crypto);
if (retcode) {
DEBUGMSGTL(("ksm", "krb5_crypto_init failed: %s\n",
error_message(retcode)));
snmp_set_detail(error_message(retcode));
retval = SNMPERR_KRB5;
goto error;
}
#endif /* OLD_HEIMDAL */
}
/*
* Now, we need to pick the "right" checksum algorithm. For old
* crypto, just pick CKSUMTYPE_RSA_MD5_DES; for new crypto, pick
* one of the "approved" ones.
*/
#ifdef NETSNMP_USE_KERBEROS_MIT
retcode = krb5_c_keyed_checksum_types(kcontext, subkey->enctype,
&numcksumtypes, &cksumtype_array);
if (retcode) {
DEBUGMSGTL(("ksm", "Unable to find appropriate keyed checksum: %s\n",
error_message(retcode)));
snmp_set_detail(error_message(retcode));
retval = SNMPERR_KRB5;
goto error;
}
if (numcksumtypes <= 0) {
DEBUGMSGTL(("ksm", "We received a list of zero cksumtypes for this "
"enctype (%d)\n", subkey->enctype));
snmp_set_detail("No valid checksum type for this encryption type");
retval = SNMPERR_KRB5;
goto error;
}
/*
* It's not clear to me from the API which checksum you're supposed
* to support, so I'm taking a guess at the first one
*/
cksumtype = cksumtype_array[0];
krb5_free_cksumtypes(kcontext, cksumtype_array);
DEBUGMSGTL(("ksm", "KSM: Choosing checksum type of %d (subkey type "
"of %d)\n", cksumtype, subkey->enctype));
retcode = krb5_c_checksum_length(kcontext, cksumtype, &blocksize);
if (retcode) {
DEBUGMSGTL(("ksm", "Unable to determine checksum length: %s\n",
error_message(retcode)));
snmp_set_detail(error_message(retcode));
retval = SNMPERR_KRB5;
goto error;
}
CHECKSUM_LENGTH(&pdu_checksum) = blocksize;
#else /* NETSNMP_USE_KERBEROS_MIT */
if (ksm_state)
cksumtype = ksm_state->cksumtype;
else
#ifdef OLD_HEIMDAL
{
/* no way to tell what kind of checksum to use without trying */
retval = krb5_create_checksum(kcontext, heim_crypto,
KSM_KEY_USAGE_CHECKSUM, 0,
parms->scopedPdu, parms->scopedPduLen,
&pdu_checksum);
if (retval) {
DEBUGMSGTL(("ksm", "Unable to create a checksum: %s\n",
error_message(retval)));
snmp_set_detail(error_message(retcode));
retval = SNMPERR_KRB5;
goto error;
}
cksumtype = CHECKSUM_TYPE(&pdu_checksum);
}
#else /* OLD_HEIMDAL */
cksumtype = CKSUMTYPE_RSA_MD5_DES;
#endif /* OLD_HEIMDAL */
#ifdef OLD_HEIMDAL
if (!krb5_checksum_is_keyed(kcontext, cksumtype)) {
#else /* OLD_HEIMDAL */
if (!is_keyed_cksum(cksumtype)) {
#endif /* OLD_HEIMDAL */
DEBUGMSGTL(("ksm", "Checksum type %d is not a keyed checksum\n",
cksumtype));
snmp_set_detail("Checksum is not a keyed checksum");
retval = SNMPERR_KRB5;
goto error;
}
#ifdef OLD_HEIMDAL
if (!krb5_checksum_is_collision_proof(kcontext, cksumtype)) {
#else /* OLD_HEIMDAL */
if (!is_coll_proof_cksum(cksumtype)) {
#endif /* OLD_HEIMDAL */
DEBUGMSGTL(("ksm", "Checksum type %d is not a collision-proof "
"checksum\n", cksumtype));
snmp_set_detail("Checksum is not a collision-proof checksum");
retval = SNMPERR_KRB5;
goto error;
}
#ifdef OLD_HEIMDAL
if (CHECKSUM_CONTENTS(&pdu_checksum) != NULL ) {
/* we did the bogus checksum--don't need to ask for the size again
* or initialize cksumtype; just free the bits */
free(CHECKSUM_CONTENTS(&pdu_checksum));
CHECKSUM_CONTENTS(&pdu_checksum) = NULL;
}
else {
retval = krb5_checksumsize(kcontext, cksumtype,
&CHECKSUM_LENGTH(&pdu_checksum));
if (retval) {
DEBUGMSGTL(("ksm", "Unable to determine checksum length: %s\n",
error_message(retval)));
snmp_set_detail(error_message(retcode));
retval = SNMPERR_KRB5;
goto error;
}
#else /* OLD_HEIMDAL */
CHECKSUM_LENGTH(&pdu_checksum) = krb5_checksum_size(kcontext, cksumtype);
#endif /* OLD_HEIMDAL */
CHECKSUM_TYPE(&pdu_checksum) = cksumtype;
#ifdef OLD_HEIMDAL
}
#endif /* OLD_HEIMDAL */
#endif /* NETSNMP_USE_KERBEROS_MIT */
/*
* Note that here, we're just leaving blank space for the checksum;
* we remember where that is, and we'll fill it in later.
*/
*offset += CHECKSUM_LENGTH(&pdu_checksum);
memset(*wholeMsg + *parms->wholeMsgLen - *offset, 0, CHECKSUM_LENGTH(&pdu_checksum));
cksum_pointer = *wholeMsg + *parms->wholeMsgLen - *offset;
rc = asn_realloc_rbuild_header(wholeMsg, parms->wholeMsgLen,
parms->wholeMsgOffset, 1,
(u_char) (ASN_UNIVERSAL |
ASN_PRIMITIVE |
ASN_OCTET_STR),
CHECKSUM_LENGTH(&pdu_checksum));
if (rc == 0) {
DEBUGMSGTL(("ksm", "Building ksm security parameters failed.\n"));
retval = SNMPERR_TOO_LONG;
goto error;
}
tmp = cksumtype;
rc = asn_realloc_rbuild_int(wholeMsg, parms->wholeMsgLen,
parms->wholeMsgOffset, 1,
(u_char) (ASN_UNIVERSAL |
ASN_PRIMITIVE |
ASN_INTEGER),
&tmp, sizeof(tmp));
if (rc == 0) {
DEBUGMSGTL(("ksm", "Building ksm security parameters failed.\n"));
retval = SNMPERR_TOO_LONG;
goto error;
}
rc = asn_realloc_rbuild_sequence(wholeMsg, parms->wholeMsgLen,
parms->wholeMsgOffset, 1,
(u_char) (ASN_SEQUENCE |
ASN_CONSTRUCTOR),
*offset - seq_offset);
if (rc == 0) {
DEBUGMSGTL(("ksm", "Building ksm security parameters failed.\n"));
retval = SNMPERR_TOO_LONG;
goto error;
}
rc = asn_realloc_rbuild_header(wholeMsg, parms->wholeMsgLen,
parms->wholeMsgOffset, 1,
(u_char) (ASN_UNIVERSAL |
ASN_PRIMITIVE |
ASN_OCTET_STR),
*offset - seq_offset);
if (rc == 0) {
DEBUGMSGTL(("ksm", "Building ksm security parameters failed.\n"));
retval = SNMPERR_TOO_LONG;
goto error;
}
DEBUGMSGTL(("ksm", "KSM: Security parameter encoding completed\n"));
/*
* We're done with the KSM security parameters - now we do the global
* header and wrap up the whole PDU.
*/
if (*parms->wholeMsgLen < parms->globalDataLen) {
DEBUGMSGTL(("ksm", "Building global data failed.\n"));
retval = SNMPERR_TOO_LONG;
goto error;
}
*offset += parms->globalDataLen;
memcpy(*wholeMsg + *parms->wholeMsgLen - *offset,
parms->globalData, parms->globalDataLen);
rc = asn_realloc_rbuild_sequence(wholeMsg, parms->wholeMsgLen,
offset, 1,
(u_char) (ASN_SEQUENCE |
ASN_CONSTRUCTOR),
*offset);
if (rc == 0) {
DEBUGMSGTL(("ksm", "Building master packet sequence.\n"));
retval = SNMPERR_TOO_LONG;
goto error;
}
DEBUGMSGTL(("ksm", "KSM: PDU master packet encoding complete.\n"));
/*
* Now we need to checksum the entire PDU (since it's built).
*/
#ifndef OLD_HEIMDAL /* since heimdal allocs the mem for us */
CHECKSUM_CONTENTS(&pdu_checksum) = malloc(CHECKSUM_LENGTH(&pdu_checksum));
if (!CHECKSUM_CONTENTS(&pdu_checksum)) {
DEBUGMSGTL(("ksm", "Unable to malloc %d bytes for checksum\n",
CHECKSUM_LENGTH(&pdu_checksum)));
retval = SNMPERR_MALLOC;
goto error;
}
#endif /* ! OLD_HEIMDAL */
#ifdef NETSNMP_USE_KERBEROS_MIT
input.data = (char *) (*wholeMsg + *parms->wholeMsgLen - *offset);
input.length = *offset;
retcode = krb5_c_make_checksum(kcontext, cksumtype, subkey,
KSM_KEY_USAGE_CHECKSUM, &input,
&pdu_checksum);
#elif defined(OLD_HEIMDAL) /* NETSNMP_USE_KERBEROS_MIT */
retcode = krb5_create_checksum(kcontext, heim_crypto,
KSM_KEY_USAGE_CHECKSUM, cksumtype,
*wholeMsg + *parms->wholeMsgLen
- *offset, *offset, &pdu_checksum);
#else /* NETSNMP_USE_KERBEROS_MIT */
retcode = krb5_calculate_checksum(kcontext, cksumtype, *wholeMsg +
*parms->wholeMsgLen - *offset,
*offset,
(krb5_pointer) subkey->contents,
subkey->length, &pdu_checksum);
#endif /* NETSNMP_USE_KERBEROS_MIT */
if (retcode) {
DEBUGMSGTL(("ksm", "Calculate checksum failed: %s\n",
error_message(retcode)));
retval = SNMPERR_KRB5;
snmp_set_detail(error_message(retcode));
goto error;
}
DEBUGMSGTL(("ksm", "KSM: Checksum calculation complete.\n"));
memcpy(cksum_pointer, CHECKSUM_CONTENTS(&pdu_checksum), CHECKSUM_LENGTH(&pdu_checksum));
DEBUGMSGTL(("ksm", "KSM: Writing checksum of %d bytes at offset %d\n",
(int)CHECKSUM_LENGTH(&pdu_checksum),
(int)(cksum_pointer - (*wholeMsg + 1))));
DEBUGMSGTL(("ksm", "KSM: Checksum:"));
for (i = 0; i < CHECKSUM_LENGTH(&pdu_checksum); i++)
DEBUGMSG(("ksm", " %02x",
(unsigned int) ((unsigned char *)CHECKSUM_CONTENTS(&pdu_checksum))[i]));
DEBUGMSG(("ksm", "\n"));
/*
* If we're _not_ called as part of a response (null ksm_state),
* then save the auth_context for later using our cache routines.
*/
if (!ksm_state) {
if ((retval = ksm_insert_cache(parms->pdu->msgid, auth_context,
(u_char *) parms->secName,
parms->secNameLen)) !=
SNMPERR_SUCCESS)
goto error;
auth_context = NULL;
}
DEBUGMSGTL(("ksm", "KSM processing complete!\n"));
error:
if (CHECKSUM_CONTENTS(&pdu_checksum))
#ifdef NETSNMP_USE_KERBEROS_MIT
krb5_free_checksum_contents(kcontext, &pdu_checksum);
#else /* NETSNMP_USE_KERBEROS_MIT */
free(CHECKSUM_CONTENTS(&pdu_checksum));
#endif /* NETSNMP_USE_KERBEROS_MIT */
if (ivector.data)
free(ivector.data);
if (subkey)
krb5_free_keyblock(kcontext, subkey);
#ifdef OLD_HEIMDAL /* OLD_HEIMDAL */
if (heim_crypto)
krb5_crypto_destroy(kcontext, heim_crypto);
#endif /* OLD_HEIMDAL */
if (encrypted_data)
free(encrypted_data);
if (cc)
krb5_cc_close(kcontext, cc);
if (auth_context && !ksm_state)
krb5_auth_con_free(kcontext, auth_context);
return retval;
}
/****************************************************************************
*
* ksm_process_in_msg
*
* Parameters:
* (See list below...)
*
* Returns:
* KSM_ERR_NO_ERROR On success.
* SNMPERR_KRB5
* KSM_ERR_GENERIC_ERROR
* KSM_ERR_UNSUPPORTED_SECURITY_LEVEL
*
*
* Processes an incoming message.
*
****************************************************************************/
int
ksm_process_in_msg(struct snmp_secmod_incoming_params *parms)
{
long temp;
krb5_cksumtype cksumtype;
krb5_auth_context auth_context = NULL;
krb5_error_code retcode;
krb5_checksum checksum;
krb5_data ap_req, ivector;
krb5_flags flags;
krb5_keyblock *subkey = NULL;
#ifdef NETSNMP_USE_KERBEROS_MIT
krb5_data input, output;
krb5_boolean valid;
krb5_enc_data in_crypt;
#elif defined OLD_HEIMDAL /* NETSNMP_USE_KERBEROS_MIT */
krb5_data output;
krb5_crypto heim_crypto = NULL;
#else /* NETSNMP_USE_KERBEROS_MIT */
krb5_encrypt_block eblock;
#endif /* NETSNMP_USE_KERBEROS_MIT */
krb5_ticket *ticket = NULL;
int retval = SNMPERR_SUCCESS, response = 0;
size_t length =
parms->wholeMsgLen - (u_int) (parms->secParams - parms->wholeMsg);
u_char *current = parms->secParams, type;
#ifndef OLD_HEIMDAL
size_t blocksize;
#endif
size_t cksumlength;
long hint;
char *cname;
struct ksm_secStateRef *ksm_state;
struct ksm_cache_entry *entry;
DEBUGMSGTL(("ksm", "Processing has begun\n"));
CHECKSUM_CONTENTS(&checksum) = NULL;
ap_req.data = NULL;
ivector.length = 0;
ivector.data = NULL;
/*
* First, parse the security parameters (because we need the subkey inside
* of the ticket to do anything
*/
if ((current = asn_parse_sequence(current, &length, &type,
(ASN_UNIVERSAL | ASN_PRIMITIVE |
ASN_OCTET_STR),
"ksm first octet")) == NULL) {
DEBUGMSGTL(("ksm", "Initial security paramter parsing failed\n"));
retval = SNMPERR_ASN_PARSE_ERR;
goto error;
}
if ((current = asn_parse_sequence(current, &length, &type,
(ASN_SEQUENCE | ASN_CONSTRUCTOR),
"ksm sequence")) == NULL) {
DEBUGMSGTL(("ksm",
"Security parameter sequence parsing failed\n"));
retval = SNMPERR_ASN_PARSE_ERR;
goto error;
}
if ((current = asn_parse_int(current, &length, &type, &temp,
sizeof(temp))) == NULL) {
DEBUGMSGTL(("ksm", "Security parameter checksum type parsing"
"failed\n"));
retval = SNMPERR_ASN_PARSE_ERR;
goto error;
}
cksumtype = temp;
#ifdef NETSNMP_USE_KERBEROS_MIT
if (!krb5_c_valid_cksumtype(cksumtype)) {
DEBUGMSGTL(("ksm", "Invalid checksum type (%d)\n", cksumtype));
retval = SNMPERR_KRB5;
snmp_set_detail("Invalid checksum type");
goto error;
}
if (!krb5_c_is_keyed_cksum(cksumtype)) {
DEBUGMSGTL(("ksm", "Checksum type %d is not a keyed checksum\n",
cksumtype));
snmp_set_detail("Checksum is not a keyed checksum");
retval = SNMPERR_KRB5;
goto error;
}
if (!krb5_c_is_coll_proof_cksum(cksumtype)) {
DEBUGMSGTL(("ksm", "Checksum type %d is not a collision-proof "
"checksum\n", cksumtype));
snmp_set_detail("Checksum is not a collision-proof checksum");
retval = SNMPERR_KRB5;
goto error;
}
#else /* ! NETSNMP_USE_KERBEROS_MIT */
#ifdef OLD_HEIMDAL
/* kludge */
if (krb5_checksumsize(kcontext, cksumtype, &cksumlength)) {
#else /* OLD_HEIMDAL */
if (!valid_cksumtype(cksumtype)) {
#endif /* OLD_HEIMDAL */
DEBUGMSGTL(("ksm", "Invalid checksum type (%d)\n", cksumtype));
retval = SNMPERR_KRB5;
snmp_set_detail("Invalid checksum type");
goto error;
}
#ifdef OLD_HEIMDAL
if (!krb5_checksum_is_keyed(kcontext, cksumtype)) {
#else /* OLD_HEIMDAL */
if (!is_keyed_cksum(cksumtype)) {
#endif /* OLD_HEIMDAL */
DEBUGMSGTL(("ksm", "Checksum type %d is not a keyed checksum\n",
cksumtype));
snmp_set_detail("Checksum is not a keyed checksum");
retval = SNMPERR_KRB5;
goto error;
}
#ifdef OLD_HEIMDAL
if (!krb5_checksum_is_collision_proof(kcontext, cksumtype)) {
#else /* OLD_HEIMDAL */
if (!is_coll_proof_cksum(cksumtype)) {
#endif /* OLD_HEIMDAL */
DEBUGMSGTL(("ksm", "Checksum type %d is not a collision-proof "
"checksum\n", cksumtype));
snmp_set_detail("Checksum is not a collision-proof checksum");
retval = SNMPERR_KRB5;
goto error;
}
#endif /* NETSNMP_USE_KERBEROS_MIT */
CHECKSUM_TYPE(&checksum) = cksumtype;
cksumlength = length;
if ((current = asn_parse_sequence(current, &cksumlength, &type,
(ASN_UNIVERSAL | ASN_PRIMITIVE |
ASN_OCTET_STR), "ksm checksum")) ==
NULL) {
DEBUGMSGTL(("ksm",
"Security parameter checksum parsing failed\n"));
retval = SNMPERR_ASN_PARSE_ERR;
goto error;
}
CHECKSUM_CONTENTS(&checksum) = malloc(cksumlength);
if (!CHECKSUM_CONTENTS(&checksum)) {
DEBUGMSGTL(("ksm", "Unable to malloc %d bytes for checksum.\n",
(int)cksumlength));
retval = SNMPERR_MALLOC;
goto error;
}
memcpy(CHECKSUM_CONTENTS(&checksum), current, cksumlength);
CHECKSUM_LENGTH(&checksum) = cksumlength;
CHECKSUM_TYPE(&checksum) = cksumtype;
/*
* Zero out the checksum so the validation works correctly
*/
memset(current, 0, cksumlength);
current += cksumlength;
length = parms->wholeMsgLen - (u_int) (current - parms->wholeMsg);
if ((current = asn_parse_sequence(current, &length, &type,
(ASN_UNIVERSAL | ASN_PRIMITIVE |
ASN_OCTET_STR), "ksm ap_req")) ==
NULL) {
DEBUGMSGTL(("ksm", "KSM security parameter AP_REQ/REP parsing "
"failed\n"));
retval = SNMPERR_ASN_PARSE_ERR;
goto error;
}
ap_req.length = length;
ap_req.data = malloc(length);
if (!ap_req.data) {
DEBUGMSGTL(("ksm",
"KSM unable to malloc %d bytes for AP_REQ/REP.\n",
(int)length));
retval = SNMPERR_MALLOC;
goto error;
}
memcpy(ap_req.data, current, length);
current += length;
length = parms->wholeMsgLen - (u_int) (current - parms->wholeMsg);
if ((current = asn_parse_int(current, &length, &type, &hint,
sizeof(hint))) == NULL) {
DEBUGMSGTL(("ksm",
"KSM security parameter hint parsing failed\n"));
retval = SNMPERR_ASN_PARSE_ERR;
goto error;
}
/*
* Okay! We've got it all! Now try decoding the damn ticket.
*
* But of course there's a WRINKLE! We need to figure out if we're
* processing a AP_REQ or an AP_REP. How do we do that? We're going
* to cheat, and look at the first couple of bytes (which is what
* the Kerberos library routines do anyway).
*
* If there are ever new Kerberos message formats, we'll need to fix
* this here.
*
* If it's a _response_, then we need to get the auth_context
* from our cache.
*/
if (ap_req.length
#ifndef NETSNMP_USE_KERBEROS_HEIMDAL
&& (ap_req.data[0] == 0x6e || ap_req.data[0] == 0x4e)) {
#else /* NETSNMP_USE_KERBEROS_HEIMDAL */
&& (((char *)ap_req.data)[0] == 0x6e || ((char *)ap_req.data)[0] == 0x4e)) {
#endif
/*
* We need to initalize the authorization context, and set the
* replay cache in it (and initialize the replay cache if we
* haven't already
*/
retcode = krb5_auth_con_init(kcontext, &auth_context);
if (retcode) {
DEBUGMSGTL(("ksm", "krb5_auth_con_init failed: %s\n",
error_message(retcode)));
retval = SNMPERR_KRB5;
snmp_set_detail(error_message(retcode));
goto error;
}
if (!rcache) {
krb5_data server;
server.data = service_host;
server.length = strlen(server.data);
retcode = krb5_get_server_rcache(kcontext, &server, &rcache);
if (retcode) {
DEBUGMSGTL(("ksm", "krb5_get_server_rcache failed: %s\n",
error_message(retcode)));
retval = SNMPERR_KRB5;
snmp_set_detail(error_message(retcode));
goto error;
}
}
retcode = krb5_auth_con_setrcache(kcontext, auth_context, rcache);
if (retcode) {
DEBUGMSGTL(("ksm", "krb5_auth_con_setrcache failed: %s\n",
error_message(retcode)));
retval = SNMPERR_KRB5;
snmp_set_detail(error_message(retcode));
goto error;
}
retcode = krb5_rd_req(kcontext, &auth_context, &ap_req, NULL,
keytab, &flags, &ticket);
krb5_auth_con_setrcache(kcontext, auth_context, NULL);
if (retcode) {
DEBUGMSGTL(("ksm", "krb5_rd_req() failed: %s\n",
error_message(retcode)));
retval = SNMPERR_KRB5;
snmp_set_detail(error_message(retcode));
goto error;
}
retcode =
krb5_unparse_name(kcontext, TICKET_CLIENT(ticket), &cname);
if (retcode == 0) {
DEBUGMSGTL(("ksm", "KSM authenticated principal name: %s\n",
cname));
free(cname);
}
/*
* Check to make sure AP_OPTS_MUTUAL_REQUIRED was set
*/
if (!(flags & AP_OPTS_MUTUAL_REQUIRED)) {
DEBUGMSGTL(("ksm",
"KSM MUTUAL_REQUIRED not set in request!\n"));
retval = SNMPERR_KRB5;
snmp_set_detail("MUTUAL_REQUIRED not set in message");
goto error;
}
retcode =
krb5_auth_con_getrecvsubkey(kcontext, auth_context, &subkey);
if (retcode) {
DEBUGMSGTL(("ksm", "KSM remote subkey retrieval failed: %s\n",
error_message(retcode)));
retval = SNMPERR_KRB5;
snmp_set_detail(error_message(retcode));
goto error;
}
#ifndef NETSNMP_USE_KERBEROS_HEIMDAL
} else if (ap_req.length && (ap_req.data[0] == 0x6f ||
ap_req.data[0] == 0x4f)) {
#else /* NETSNMP_USE_KERBEROS_HEIMDAL */
} else if (ap_req.length && (((char *)ap_req.data)[0] == 0x6f ||
((char *)ap_req.data)[0] == 0x4f)) {
#endif /* NETSNMP_USE_KERBEROS_HEIMDAL */
/*
* Looks like a response; let's see if we've got that auth_context
* in our cache.
*/
krb5_ap_rep_enc_part *repl = NULL;
response = 1;
entry = ksm_get_cache(parms->pdu->msgid);
if (!entry) {
DEBUGMSGTL(("ksm",
"KSM: Unable to find auth_context for PDU with "
"message ID of %ld\n", parms->pdu->msgid));
retval = SNMPERR_KRB5;
goto error;
}
auth_context = entry->auth_context;
/*
* In that case, let's call the rd_rep function
*/
retcode = krb5_rd_rep(kcontext, auth_context, &ap_req, &repl);
if (repl)
krb5_free_ap_rep_enc_part(kcontext, repl);
if (retcode) {
DEBUGMSGTL(("ksm", "KSM: krb5_rd_rep() failed: %s\n",
error_message(retcode)));
retval = SNMPERR_KRB5;
goto error;
}
DEBUGMSGTL(("ksm", "KSM: krb5_rd_rep() decoded successfully.\n"));
retcode =
krb5_auth_con_getsendsubkey(kcontext, auth_context, &subkey);
if (retcode) {
DEBUGMSGTL(("ksm", "Unable to retrieve local subkey: %s\n",
error_message(retcode)));
retval = SNMPERR_KRB5;
snmp_set_detail("Unable to retrieve local subkey");
goto error;
}
} else {
#ifndef NETSNMP_USE_KERBEROS_HEIMDAL
DEBUGMSGTL(("ksm", "Unknown Kerberos message type (%02x)\n",
ap_req.data[0]));
#else /* NETSNMP_USE_KERBEROS_HEIMDAL */
DEBUGMSGTL(("ksm", "Unknown Kerberos message type (%02x)\n",
((char *)ap_req.data)[0]));
#endif
retval = SNMPERR_KRB5;
snmp_set_detail("Unknown Kerberos message type");
goto error;
}
#ifdef NETSNMP_USE_KERBEROS_MIT
input.data = (char *) parms->wholeMsg;
input.length = parms->wholeMsgLen;
retcode =
krb5_c_verify_checksum(kcontext, subkey, KSM_KEY_USAGE_CHECKSUM,
&input, &checksum, &valid);
#elif defined(OLD_HEIMDAL) /* NETSNMP_USE_KERBEROS_MIT */
retcode = krb5_crypto_init(kcontext, subkey, 0, &heim_crypto);
if (retcode) {
DEBUGMSGTL(("ksm", "krb5_crypto_init failed: %s\n",
error_message(retcode)));
snmp_set_detail(error_message(retcode));
retval = SNMPERR_KRB5;
goto error;
}
retcode = krb5_verify_checksum(kcontext, heim_crypto,
KSM_KEY_USAGE_CHECKSUM, parms->wholeMsg,
parms->wholeMsgLen, &checksum);
#else /* NETSNMP_USE_KERBEROS_MIT */
retcode = krb5_verify_checksum(kcontext, cksumtype, &checksum,
parms->wholeMsg, parms->wholeMsgLen,
(krb5_pointer) subkey->contents,
subkey->length);
#endif /* NETSNMP_USE_KERBEROS_MIT */
if (retcode) {
DEBUGMSGTL(("ksm", "KSM checksum verification failed: %s\n",
error_message(retcode)));
retval = SNMPERR_KRB5;
snmp_set_detail(error_message(retcode));
goto error;
}
/*
* Don't ask me why they didn't simply return an error, but we have
* to check to see if "valid" is false.
*/
#ifdef NETSNMP_USE_KERBEROS_MIT
if (!valid) {
DEBUGMSGTL(("ksm", "Computed checksum did not match supplied "
"checksum!\n"));
retval = SNMPERR_KRB5;
snmp_set_detail
("Computed checksum did not match supplied checksum");
goto error;
}
#endif /* NETSNMP_USE_KERBEROS_MIT */
/*
* Handle an encrypted PDU. Note that it's an OCTET_STRING of the
* output of whatever Kerberos cryptosystem you're using (defined by
* the encryption type). Note that this is NOT the EncryptedData
* sequence - it's what goes in the "cipher" field of EncryptedData.
*/
if (parms->secLevel == SNMP_SEC_LEVEL_AUTHPRIV) {
if ((current = asn_parse_sequence(current, &length, &type,
(ASN_UNIVERSAL | ASN_PRIMITIVE |
ASN_OCTET_STR), "ksm pdu")) ==
NULL) {
DEBUGMSGTL(("ksm", "KSM sPDU octet decoding failed\n"));
retval = SNMPERR_ASN_PARSE_ERR;
goto error;
}
/*
* The PDU is now pointed at by "current", and the length is in
* "length".
*/
DEBUGMSGTL(("ksm", "KSM starting sPDU decode\n"));
/*
* We need to set up a blank initialization vector for the decryption.
* Use a block of all zero's (which is dependent on the block size
* of the encryption method).
*/
#ifdef NETSNMP_USE_KERBEROS_MIT
retcode = krb5_c_block_size(kcontext, subkey->enctype, &blocksize);
if (retcode) {
DEBUGMSGTL(("ksm",
"Unable to determine crypto block size: %s\n",
error_message(retcode)));
snmp_set_detail(error_message(retcode));
retval = SNMPERR_KRB5;
goto error;
}
#elif defined(OLD_HEIMDAL) /* NETSNMP_USE_KERBEROS_MIT */
#else /* NETSNMP_USE_KERBEROS_MIT */
blocksize =
krb5_enctype_array[subkey->enctype]->system->block_length;
#endif /* NETSNMP_USE_KERBEROS_MIT */
#ifndef OLD_HEIMDAL
ivector.data = malloc(blocksize);
if (!ivector.data) {
DEBUGMSGTL(("ksm", "Unable to allocate %d bytes for ivector\n",
(int)blocksize));
retval = SNMPERR_MALLOC;
goto error;
}
ivector.length = blocksize;
memset(ivector.data, 0, blocksize);
#ifndef NETSNMP_USE_KERBEROS_MIT
krb5_use_enctype(kcontext, &eblock, subkey->enctype);
retcode = krb5_process_key(kcontext, &eblock, subkey);
if (retcode) {
DEBUGMSGTL(("ksm", "KSM key post-processing failed: %s\n",
error_message(retcode)));
snmp_set_detail(error_message(retcode));
retval = SNMPERR_KRB5;
goto error;
}
#endif /* !NETSNMP_USE_KERBEROS_MIT */
#endif /* ! OLD_HEIMDAL */
if (length > *parms->scopedPduLen) {
DEBUGMSGTL(("ksm", "KSM not enough room - have %d bytes to "
"decrypt but only %d bytes available\n", (int)length,
(int)*parms->scopedPduLen));
retval = SNMPERR_TOO_LONG;
#ifndef NETSNMP_USE_KERBEROS_MIT
#ifndef OLD_HEIMDAL
krb5_finish_key(kcontext, &eblock);
#endif /* ! OLD_HEIMDAL */
#endif /* ! NETSNMP_USE_KERBEROS_MIT */
goto error;
}
#ifdef NETSNMP_USE_KERBEROS_MIT
in_crypt.ciphertext.data = (char *) current;
in_crypt.ciphertext.length = length;
in_crypt.enctype = subkey->enctype;
output.data = (char *) *parms->scopedPdu;
output.length = *parms->scopedPduLen;
retcode =
krb5_c_decrypt(kcontext, subkey, KSM_KEY_USAGE_ENCRYPTION,
&ivector, &in_crypt, &output);
#elif defined (OLD_HEIMDAL) /* NETSNMP_USE_KERBEROS_MIT */
retcode = krb5_decrypt(kcontext, heim_crypto, KSM_KEY_USAGE_ENCRYPTION,
current, length, &output);
if (retcode == 0) {
*parms->scopedPdu = (u_char *) output.data;
*parms->scopedPduLen = output.length;
krb5_data_zero(&output);
}
#else /* NETSNMP_USE_KERBEROS_MIT */
retcode = krb5_decrypt(kcontext, (krb5_pointer) current,
*parms->scopedPdu, length, &eblock,
ivector.data);
krb5_finish_key(kcontext, &eblock);
#endif /* NETSNMP_USE_KERBEROS_MIT */
if (retcode) {
DEBUGMSGTL(("ksm", "Decryption failed: %s\n",
error_message(retcode)));
snmp_set_detail(error_message(retcode));
retval = SNMPERR_KRB5;
goto error;
}
*parms->scopedPduLen = length;
} else {
/*
* Clear PDU
*/
*parms->scopedPdu = current;
*parms->scopedPduLen =
parms->wholeMsgLen - (current - parms->wholeMsg);
}
/*
* A HUGE GROSS HACK
*/
*parms->maxSizeResponse = parms->maxMsgSize - 200;
DEBUGMSGTL(("ksm", "KSM processing complete\n"));
/*
* Set the secName to the right value (a hack for now). But that's
* only used for when we're processing a request, not a response.
*/
if (!response) {
retcode = krb5_unparse_name(kcontext, TICKET_CLIENT(ticket),
&cname);
if (retcode) {
DEBUGMSGTL(("ksm", "KSM krb5_unparse_name failed: %s\n",
error_message(retcode)));
snmp_set_detail(error_message(retcode));
retval = SNMPERR_KRB5;
goto error;
}
if (strlen(cname) > *parms->secNameLen + 1) {
DEBUGMSGTL(("ksm",
"KSM: Principal length (%d) is too long (%d)\n",
(int)strlen(cname), (int)*parms->secNameLen));
retval = SNMPERR_TOO_LONG;
free(cname);
goto error;
}
strcpy(parms->secName, cname);
*parms->secNameLen = strlen(cname);
free(cname);
/*
* Also, if we're not a response, keep around our auth_context so we
* can encode the reply message correctly
*/
ksm_state = SNMP_MALLOC_STRUCT(ksm_secStateRef);
if (!ksm_state) {
DEBUGMSGTL(("ksm", "KSM unable to malloc memory for "
"ksm_secStateRef\n"));
retval = SNMPERR_MALLOC;
goto error;
}
ksm_state->auth_context = auth_context;
auth_context = NULL;
ksm_state->cksumtype = cksumtype;
*parms->secStateRef = ksm_state;
} else {
/*
* We _still_ have to set the secName in process_in_msg(). Do
* that now with what we were passed in before (we cached it,
* remember?)
*/
memcpy(parms->secName, entry->secName, entry->secNameLen);
*parms->secNameLen = entry->secNameLen;
}
/*
* Just in case
*/
parms->secEngineID = null_id;
*parms->secEngineIDLen = 0;
auth_context = NULL; /* So we don't try to free it on success */
error:
if (retval == SNMPERR_ASN_PARSE_ERR &&
snmp_increment_statistic(STAT_SNMPINASNPARSEERRS) == 0)
DEBUGMSGTL(("ksm", "Failed to increment statistics.\n"));
if (subkey)
krb5_free_keyblock(kcontext, subkey);
#ifdef OLD_HEIMDAL /* OLD_HEIMDAL */
if (heim_crypto)
krb5_crypto_destroy(kcontext, heim_crypto);
#endif /* OLD_HEIMDAL */
if (CHECKSUM_CONTENTS(&checksum))
free(CHECKSUM_CONTENTS(&checksum));
if (ivector.data)
free(ivector.data);
if (ticket)
krb5_free_ticket(kcontext, ticket);
if (!response && auth_context)
krb5_auth_con_free(kcontext, auth_context);
if (ap_req.data)
free(ap_req.data);
return retval;
}
|