/usr/share/gsoap/plugin/wsse2api.c is in gsoap 2.8.17-1+deb8u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 | /*
wsse2api.c
WS-Security plugin (2002 version)
See wsseapi.c for details
gSOAP XML Web services tools
Copyright (C) 2000-2010, Robert van Engelen, Genivia Inc., All Rights Reserved.
This part of the software is released under one of the following licenses:
GPL, the gSOAP public license, or Genivia's license for commercial use.
--------------------------------------------------------------------------------
gSOAP public license.
The contents of this file are subject to the gSOAP Public License Version 1.3
(the "License"); you may not use this file except in compliance with the
License. You may obtain a copy of the License at
http://www.cs.fsu.edu/~engelen/soaplicense.html
Software distributed under the License is distributed on an "AS IS" basis,
WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
for the specific language governing rights and limitations under the License.
The Initial Developer of the Original Code is Robert A. van Engelen.
Copyright (C) 2000-2010, Robert van Engelen, Genivia Inc., All Rights Reserved.
--------------------------------------------------------------------------------
GPL license.
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., 59 Temple
Place, Suite 330, Boston, MA 02111-1307 USA
Author contact information:
engelen@genivia.com / engelen@acm.org
This program is released under the GPL with the additional exemption that
compiling, linking, and/or using OpenSSL is allowed.
--------------------------------------------------------------------------------
A commercial use license is available from Genivia, Inc., contact@genivia.com
--------------------------------------------------------------------------------
*/
#include "wsse2api.h"
#include "smdevp.h"
#include "mecevp.h"
#include "threads.h" /* only need threads to enable mutex for MT */
#if defined(SOAP_WSA_2003) || defined(SOAP_WSA_2004) || defined(SOAP_WSA_200408) || defined(SOAP_WSA_2005)
#include "wsaapi.h"
#endif
#ifdef __cplusplus
extern "C" {
#endif
/** Plugin identification for plugin registry */
const char soap_wsse_id[14] = SOAP_WSSE_ID;
/** Maximum number of SignedInfo References */
#define SOAP_WSSE_MAX_REF (100)
/** Clock skew between machines (in sec) to fit message expiration in window */
#define SOAP_WSSE_CLKSKEW (300)
/** Size of the random nonce */
#define SOAP_WSSE_NONCELEN (20)
/** Digest authentication accepts messages that are not older than creation time + SOAP_WSSE_NONCETIME */
#define SOAP_WSSE_NONCETIME (SOAP_WSSE_CLKSKEW + 240)
/******************************************************************************\
*
* Common URIs
*
\******************************************************************************/
const char *wsse_PasswordTextURI = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText";
const char *wsse_PasswordDigestURI = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest";
const char *wsse_Base64BinaryURI = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary";
const char *wsse_X509v3URI = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3";
const char *wsse_X509v3SubjectKeyIdentifierURI = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509SubjectKeyIdentifier";
const char *ds_sha1URI = "http://www.w3.org/2000/09/xmldsig#sha1";
const char *ds_sha256URI = "http://www.w3.org/2001/04/xmlenc#sha256";
const char *ds_sha512URI = "http://www.w3.org/2001/04/xmlenc#sha512";
const char *ds_hmac_sha1URI = "http://www.w3.org/2000/09/xmldsig#hmac-sha1";
const char *ds_hmac_sha256URI = "http://www.w3.org/2001/04/xmldsig-more#hmac-sha256";
const char *ds_hmac_sha512URI = "http://www.w3.org/2001/04/xmldsig-more#hmac-sha512";
const char *ds_dsa_sha1URI = "http://www.w3.org/2000/09/xmldsig#dsa-sha1";
const char *ds_rsa_sha1URI = "http://www.w3.org/2000/09/xmldsig#rsa-sha1";
const char *ds_rsa_sha256URI = "http://www.w3.org/2001/04/xmldsig-more#rsa-sha256";
const char *ds_rsa_sha512URI = "http://www.w3.org/2001/04/xmldsig-more#rsa-sha512";
const char *xenc_rsa15URI = "http://www.w3.org/2001/04/xmlenc#rsa-1_5";
const char *xenc_rsaesURI = "http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p";
const char *xenc_3desURI = "http://www.w3.org/2001/04/xmlenc#tripledes-cbc";
const char *xenc_aes128URI = "http://www.w3.org/2001/04/xmlenc#aes128-cbc";
const char *xenc_aes192URI = "http://www.w3.org/2001/04/xmlenc#aes192-cbc";
const char *xenc_aes256URI = "http://www.w3.org/2001/04/xmlenc#aes256-cbc";
const char *xenc_aes512URI = "http://www.w3.org/2001/04/xmlenc#aes512-cbc";
const char *xenc_elementURI = "http://www.w3.org/2001/04/xmlenc#Element";
const char *xenc_contentURI = "http://www.w3.org/2001/04/xmlenc#Content";
const char *ds_URI = "http://www.w3.org/2000/09/xmldsig#";
const char *c14n_URI = "http://www.w3.org/2001/10/xml-exc-c14n#";
const char *wsu_URI = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd";
/******************************************************************************\
*
* Digest authentication session
*
\******************************************************************************/
/**
@struct soap_wsse_session
@brief Digest authentication session data
*/
struct soap_wsse_session
{ struct soap_wsse_session *next; /**< Next session in list */
time_t expired; /**< Session expiration */
char hash[SOAP_SMD_SHA1_SIZE]; /**< SHA1 digest */
char nonce[1]; /**< Nonce string flows into region below this struct */
};
/** The digest authentication session database */
static struct soap_wsse_session *soap_wsse_session = NULL;
/** Lock for digest authentication session database exclusive access */
static MUTEX_TYPE soap_wsse_session_lock = MUTEX_INITIALIZER;
static char* soap_wsse_ids(struct soap *soap, const char *tags);
static int soap_wsse_session_verify(struct soap *soap, const char hash[SOAP_SMD_SHA1_SIZE], const char *created, const char *nonce);
static void soap_wsse_session_cleanup(struct soap *soap);
static void calc_digest(struct soap *soap, const char *created, const char *nonce, int noncelen, const char *password, char hash[SOAP_SMD_SHA1_SIZE]);
static void calc_nonce(struct soap *soap, char nonce[SOAP_WSSE_NONCELEN]);
static int soap_wsse_init(struct soap *soap, struct soap_wsse_data *data, const void *(*arg)(struct soap*, int*, const char*, int*));
static int soap_wsse_copy(struct soap *soap, struct soap_plugin *dst, struct soap_plugin *src);
static void soap_wsse_delete(struct soap *soap, struct soap_plugin *p);
static int soap_wsse_preparesend(struct soap *soap, const char *buf, size_t len);
static int soap_wsse_preparefinalsend(struct soap *soap);
static void soap_wsse_preparecleanup(struct soap *soap, struct soap_wsse_data *data);
static int soap_wsse_preparefinalrecv(struct soap *soap);
static int soap_wsse_header(struct soap *soap);
static int soap_wsse_element_begin_in(struct soap *soap, const char *tag);
static int soap_wsse_element_end_in(struct soap *soap, const char *tag1, const char *tag2);
static int soap_wsse_element_begin_out(struct soap *soap, const char *tag);
static int soap_wsse_element_end_out(struct soap *soap, const char *tag);
static size_t soap_wsse_verify_nested(struct soap *soap, struct soap_dom_element *dom, const char *URI, const char *tag);
/******************************************************************************\
*
* wsse:Security header element
*
\******************************************************************************/
/**
@fn _wsse__Security* soap_wsse_add_Security(struct soap *soap)
@brief Adds Security header element.
@param soap context
@return _wsse__Security object
*/
struct _wsse__Security*
soap_wsse_add_Security(struct soap *soap)
{ DBGFUN("soap_wsse_add_Security");
/* if we don't have a SOAP Header, create one */
soap_header(soap);
/* if we don't have a wsse:Security element in the SOAP Header, create one */
if (!soap->header->wsse__Security)
{ soap->header->wsse__Security = (_wsse__Security*)soap_malloc(soap, sizeof(_wsse__Security));
if (!soap->header->wsse__Security)
return NULL;
soap_default__wsse__Security(soap, soap->header->wsse__Security);
}
return soap->header->wsse__Security;
}
/**
@fn _wsse__Security* soap_wsse_add_Security_actor(struct soap *soap, const char *actor)
@brief Adds Security header element with actor or role attribute.
@param soap context
@param actor string
@return _wsse__Security object
*/
struct _wsse__Security*
soap_wsse_add_Security_actor(struct soap *soap, const char *actor)
{ _wsse__Security *security = soap_wsse_add_Security(soap);
DBGFUN1("soap_wsse_add_Security_actor", "actor=%s", actor);
if (soap->namespaces && !strcmp(soap->namespaces[0].ns, "http://schemas.xmlsoap.org/soap/envelope/"))
security->SOAP_ENV__actor = soap_strdup(soap, actor);
else
security->SOAP_ENV__role = soap_strdup(soap, actor);
return security;
}
/**
@fn void soap_wsse_delete_Security(struct soap *soap)
@brief Deletes Security header element.
@param soap context
*/
void
soap_wsse_delete_Security(struct soap *soap)
{ DBGFUN("soap_wsse_delete_Security");
if (soap->header)
soap->header->wsse__Security = NULL;
}
/**
@fn _wsse__Security* soap_wsse_Security(struct soap *soap)
@brief Returns Security header element if present.
@param soap context
@return _wsse__Security object or NULL
*/
struct _wsse__Security*
soap_wsse_Security(struct soap *soap)
{ if (soap->header)
return soap->header->wsse__Security;
return NULL;
}
/******************************************************************************\
*
* wsse:Security/ds:Signature header element
*
\******************************************************************************/
/**
@fn ds__SignatureType* soap_wsse_add_Signature(struct soap *soap)
@brief Adds Signature header element.
@param soap context
@return ds__SignatureType object
*/
struct ds__SignatureType*
soap_wsse_add_Signature(struct soap *soap)
{ _wsse__Security *security = soap_wsse_add_Security(soap);
DBGFUN("soap_wsse_add_Signature");
/* if we don't have a ds:Signature, create one */
if (!security->ds__Signature)
{ security->ds__Signature = (ds__SignatureType*)soap_malloc(soap, sizeof(ds__SignatureType));
if (!security->ds__Signature)
return NULL;
soap_default_ds__SignatureType(soap, security->ds__Signature);
}
return security->ds__Signature;
}
/**
@fn void soap_wsse_delete_Signature(struct soap *soap)
@brief Deletes Signature header element.
@param soap context
*/
void
soap_wsse_delete_Signature(struct soap *soap)
{ _wsse__Security *security = soap_wsse_Security(soap);
DBGFUN("soap_wsse_delete_Signature");
if (security)
security->ds__Signature = NULL;
}
/**
@fn ds__SignatureType* soap_wsse_Signature(struct soap *soap)
@brief Returns Signature header element if present.
@param soap context
@return ds__SignatureType object or NULL
*/
struct ds__SignatureType*
soap_wsse_Signature(struct soap *soap)
{ _wsse__Security *security = soap_wsse_Security(soap);
if (security)
return security->ds__Signature;
return NULL;
}
/******************************************************************************\
*
* wsse:Security/wsu:Timestamp header element
*
\******************************************************************************/
/**
@fn int soap_wsse_add_Timestamp(struct soap *soap, const char *id, time_t lifetime)
@brief Adds Timestamp element with optional expiration date+time (lifetime).
@param[in] soap context
@param[in] id for signature referencing or NULL
@param[in] lifetime expressed in time_t units, or 0 for no expiration
@return SOAP_OK
*/
int
soap_wsse_add_Timestamp(struct soap *soap, const char *id, time_t lifetime)
{ _wsse__Security *security = soap_wsse_add_Security(soap);
time_t now = time(NULL);
char *created = soap_strdup(soap, soap_dateTime2s(soap, now));
char *expired = lifetime ? soap_strdup(soap, soap_dateTime2s(soap, now + lifetime)) : NULL;
DBGFUN1("soap_wsse_add_Timestamp", "id=%s", id?id:"");
/* allocate a Timestamp if we don't have one already */
if (!security->wsu__Timestamp)
{ security->wsu__Timestamp = (_wsu__Timestamp*)soap_malloc(soap, sizeof(_wsu__Timestamp));
if (!security->wsu__Timestamp)
return soap->error = SOAP_EOM;
}
soap_default__wsu__Timestamp(soap, security->wsu__Timestamp);
/* populate the wsu:Timestamp element */
security->wsu__Timestamp->wsu__Id = soap_strdup(soap, id);
security->wsu__Timestamp->Created = created;
security->wsu__Timestamp->Expires = expired;
return SOAP_OK;
}
/**
@fn _wsu__Timestamp *soap_wsse_Timestamp(struct soap *soap)
@brief Returns Timestamp element if present.
@param soap context
@return _wsu__Timestamp object or NULL
*/
struct _wsu__Timestamp*
soap_wsse_Timestamp(struct soap *soap)
{ _wsse__Security *security = soap_wsse_Security(soap);
if (security)
return security->wsu__Timestamp;
return NULL;
}
/**
@fn int soap_wsse_verify_Timestamp(struct soap *soap)
@brief Verifies the Timestamp/Expires element against the current time.
@param soap context
@return SOAP_OK or SOAP_FAULT with wsse:FailedAuthentication fault
Sets wsse:FailedAuthentication fault if wsu:Timestamp is expired. The
SOAP_WSSE_CLKSKEW value is used as a margin to mitigate clock skew. Keeps
silent when no timestamp is supplied or no expiration date is included in the
wsu:Timestamp element.
*/
int
soap_wsse_verify_Timestamp(struct soap *soap)
{ _wsu__Timestamp *timestamp = soap_wsse_Timestamp(soap);
DBGFUN("soap_wsse_verify_Timestamp");
/* if we have a timestamp with an expiration date, check it */
if (timestamp && timestamp->Expires)
{ time_t now = time(NULL), expired;
soap_s2dateTime(soap, timestamp->Expires, &expired);
if (expired + SOAP_WSSE_CLKSKEW <= now)
{ const char *code = soap_wsu__tTimestampFault2s(soap, wsu__MessageExpired);
return soap_wsse_sender_fault_subcode(soap, code, "Message has expired", timestamp->Expires);
}
}
return SOAP_OK;
}
/******************************************************************************\
*
* wsse:Security/UsernameToken header element
*
\******************************************************************************/
/**
@fn int soap_wsse_add_UsernameTokenText(struct soap *soap, const char *id, const char *username, const char *password)
@brief Adds UsernameToken element with optional clear-text password.
@param soap context
@param[in] id string for signature referencing or NULL
@param[in] username string
@param[in] password string or NULL to omit the password
@return SOAP_OK
Passwords are sent in the clear, so transport-level encryption is required.
Note: this release supports the use of at most one UsernameToken in the header.
*/
int
soap_wsse_add_UsernameTokenText(struct soap *soap, const char *id, const char *username, const char *password)
{ _wsse__Security *security = soap_wsse_add_Security(soap);
DBGFUN2("soap_wsse_add_UsernameTokenText", "id=%s", id?id:"", "username=%s", username?username:"");
/* allocate a UsernameToken if we don't have one already */
if (!security->UsernameToken)
{ if (!(security->UsernameToken = (_wsse__UsernameToken*)soap_malloc(soap, sizeof(_wsse__UsernameToken))))
return soap->error = SOAP_EOM;
}
soap_default__wsse__UsernameToken(soap, security->UsernameToken);
/* populate the UsernameToken */
security->UsernameToken->wsu__Id = soap_strdup(soap, id);
security->UsernameToken->Username = soap_strdup(soap, username);
/* allocate and populate the Password */
if (password)
{ if (!(security->UsernameToken->Password = (_wsse__Password*)soap_malloc(soap, sizeof(_wsse__Password))))
return soap->error = SOAP_EOM;
soap_default__wsse__Password(soap, security->UsernameToken->Password);
security->UsernameToken->Password->Type = (char*)wsse_PasswordTextURI;
security->UsernameToken->Password->__item = soap_strdup(soap, password);
}
return SOAP_OK;
}
/**
@fn int soap_wsse_add_UsernameTokenDigest(struct soap *soap, const char *id, const char *username, const char *password)
@brief Adds UsernameToken element for digest authentication.
@param soap context
@param[in] id string for signature referencing or NULL
@param[in] username string
@param[in] password string
@return SOAP_OK
Computes SHA1 digest of the time stamp, a nonce, and the password. The digest
provides the authentication credentials. Passwords are NOT sent in the clear.
Note: this release supports the use of at most one UsernameToken in the header.
*/
int
soap_wsse_add_UsernameTokenDigest(struct soap *soap, const char *id, const char *username, const char *password)
{ _wsse__Security *security = soap_wsse_add_Security(soap);
time_t now = time(NULL);
const char *created = soap_dateTime2s(soap, now);
char HA[SOAP_SMD_SHA1_SIZE], HABase64[29];
char nonce[SOAP_WSSE_NONCELEN], *nonceBase64;
DBGFUN2("soap_wsse_add_UsernameTokenDigest", "id=%s", id?id:"", "username=%s", username?username:"");
/* generate a nonce */
calc_nonce(soap, nonce);
nonceBase64 = soap_s2base64(soap, (unsigned char*)nonce, NULL, SOAP_WSSE_NONCELEN);
/* The specs are not clear: compute digest over binary nonce or base64 nonce? */
/* compute SHA1(created, nonce, password) */
calc_digest(soap, created, nonce, SOAP_WSSE_NONCELEN, password, HA);
/* Hm...?
calc_digest(soap, created, nonceBase64, strlen(nonceBase64), password, HA);
*/
soap_s2base64(soap, (unsigned char*)HA, HABase64, SOAP_SMD_SHA1_SIZE);
/* populate the UsernameToken with digest */
soap_wsse_add_UsernameTokenText(soap, id, username, HABase64);
/* populate the remainder of the password, nonce, and created */
security->UsernameToken->Password->Type = (char*)wsse_PasswordDigestURI;
security->UsernameToken->Nonce = nonceBase64;
security->UsernameToken->wsu__Created = soap_strdup(soap, created);
return SOAP_OK;
}
/**
@fn _wsse__UsernameToken* soap_wsse_UsernameToken(struct soap *soap, const char *id)
@brief Returns UsernameToken element if present.
@param soap context
@param[in] id string of UsernameToken or NULL
@return _wsse__UsernameToken object or NULL
Note: this release supports the use of at most one UsernameToken in the header.
*/
struct _wsse__UsernameToken*
soap_wsse_UsernameToken(struct soap *soap, const char *id)
{ _wsse__Security *security = soap_wsse_Security(soap);
if (security
&& security->UsernameToken
&& (!id || (security->UsernameToken->wsu__Id
&& !strcmp(security->UsernameToken->wsu__Id, id))))
return security->UsernameToken;
return NULL;
}
/**
@fn const char* soap_wsse_get_Username(struct soap *soap)
@brief Returns UsernameToken/username string or wsse:FailedAuthentication fault.
@param soap context
@return UsernameToken/username string or NULL with wsse:FailedAuthentication fault error set
@see soap_wsse_verify_Password
The returned username should be used to lookup the user's password in a
dictionary or database for server-side authentication with
soap_wsse_verify_Password.
*/
const char*
soap_wsse_get_Username(struct soap *soap)
{ _wsse__UsernameToken *token = soap_wsse_UsernameToken(soap, NULL);
DBGFUN("soap_wsse_get_Username");
if (token)
return token->Username;
soap_wsse_fault(soap, wsse__FailedAuthentication, "Username authentication required");
return NULL;
}
/**
@fn int soap_wsse_verify_Password(struct soap *soap, const char *password)
@brief Verifies the supplied password or sets wsse:FailedAuthentication fault.
@param soap context
@param[in] password string to verify against
@return SOAP_OK (authorized) or SOAP_FAULT with wsse:FailedAuthentication fault
The verification supports both clear-text password verification and digest
password authentication. For digest authentication a history mechanism with a
digest authentication session database ensures protection against replay
attacks.
Note: this release supports the use of at most one UsernameToken in the header.
*/
int
soap_wsse_verify_Password(struct soap *soap, const char *password)
{ _wsse__UsernameToken *token = soap_wsse_UsernameToken(soap, NULL);
DBGFUN("soap_wsse_verify_Password");
/* if we have a UsernameToken with a Password, check it */
if (token && token->Password)
{ /* password digest or text? */
if (token->Password->Type
&& !strcmp(token->Password->Type, wsse_PasswordDigestURI))
{ /* check password digest: compute SHA1(created, nonce, password) */
if (token->Nonce
&& token->wsu__Created
&& strlen(token->Password->__item) == 28) /* digest pw len = 28 */
{ char HA1[SOAP_SMD_SHA1_SIZE], HA2[SOAP_SMD_SHA1_SIZE];
/* The specs are not clear: compute digest over binary nonce or base64 nonce? The formet appears to be the case: */
int noncelen;
const char *nonce = soap_base642s(soap, token->Nonce, NULL, 0, &noncelen);
/* compute HA1 = SHA1(created, nonce, password) */
calc_digest(soap, token->wsu__Created, nonce, noncelen, password, HA1);
/*
calc_digest(soap, token->wsu__Created, token->Nonce, strlen(token->Nonce), password, HA1);
*/
/* get HA2 = supplied digest from base64 Password */
soap_base642s(soap, token->Password->__item, HA2, SOAP_SMD_SHA1_SIZE, NULL);
/* compare HA1 to HA2 */
if (!memcmp(HA1, HA2, SOAP_SMD_SHA1_SIZE))
{ /* authorize if HA1 and HA2 identical and not replay attack */
if (!soap_wsse_session_verify(soap, HA1, token->wsu__Created, token->Nonce))
return SOAP_OK;
return soap->error;
}
}
}
else
{ /* check password text */
if (!strcmp(token->Password->__item, password))
return SOAP_OK;
}
}
return soap_wsse_fault(soap, wsse__FailedAuthentication, NULL);
}
/******************************************************************************\
*
* wsse:Security/BinarySecurityToken header element
*
\******************************************************************************/
/**
@fn int soap_wsse_add_BinarySecurityToken(struct soap *soap, const char *id, const char *valueType, const unsigned char *data, int size)
@brief Adds BinarySecurityToken element.
@param soap context
@param[in] id string for signature referencing or NULL
@param[in] valueType string
@param[in] data points to binary token data
@param[in] size is length of binary token
@return SOAP_OK
*/
int
soap_wsse_add_BinarySecurityToken(struct soap *soap, const char *id, const char *valueType, const unsigned char *data, int size)
{ _wsse__Security *security = soap_wsse_add_Security(soap);
DBGFUN2("wsse_add_BinarySecurityToken", "id=%s", id?id:"", "valueType=%s", valueType?valueType:"");
/* allocate BinarySecurityToken if we don't already have one */
if (!security->BinarySecurityToken)
{ if (!(security->BinarySecurityToken = (_wsse__BinarySecurityToken*)soap_malloc(soap, sizeof(_wsse__BinarySecurityToken))))
return soap->error = SOAP_EOM;
}
soap_default__wsse__BinarySecurityToken(soap, security->BinarySecurityToken);
/* populate the BinarySecurityToken */
security->BinarySecurityToken->wsu__Id = soap_strdup(soap, id);
security->BinarySecurityToken->ValueType = soap_strdup(soap, valueType);
security->BinarySecurityToken->EncodingType = (char*)wsse_Base64BinaryURI;
security->BinarySecurityToken->__item = soap_s2base64(soap, data, NULL, size);
return SOAP_OK;
}
/**
@fn int soap_wsse_add_BinarySecurityTokenX509(struct soap *soap, const char *id, X509 *cert)
@brief Adds BinarySecurityToken element with X509 certificate.
@param soap context
@param[in] id string for signature reference
@param[in] cert points to the X509 certificate
@return SOAP_OK or SOAP_EOM
This function uses i2d_X509 from the the OpenSSL library to convert an X509
object to binary DER format.
*/
int
soap_wsse_add_BinarySecurityTokenX509(struct soap *soap, const char *id, X509 *cert)
{ int derlen;
unsigned char *der, *s;
if (!cert)
return soap_wsse_fault(soap, wsse__InvalidSecurityToken, "Missing certificate");
/* determine the storage requirement */
derlen = i2d_X509(cert, NULL);
if (derlen < 0)
return soap_wsse_fault(soap, wsse__InvalidSecurityToken, "Invalid certificate");
/* use the gSOAP engine's look-aside buffer to temporarily hold the cert */
if (soap_store_lab(soap, NULL, derlen))
return SOAP_EOM;
s = der = (unsigned char*)soap->labbuf;
/* store in DER format */
i2d_X509(cert, &s);
/* populate the BinarySecurityToken with base64 certificate data */
return soap_wsse_add_BinarySecurityToken(soap, id, wsse_X509v3URI, der, derlen);
}
/**
@fn int soap_wsse_add_BinarySecurityTokenPEM(struct soap *soap, const char *id, const char *filename)
@brief Adds BinarySecurityToken element from a PEM file.
@param soap context
@param[in] id string for signature reference
@param[in] filename
@return SOAP_OK or SOAP_FAULT with wsse__InvalidSecurity fault when file cannot be read or does not contain a valid certificate
This function uses PEM_read_X509 from the the OpenSSL library to read a
certificate from a PEM formatted file.
*/
int
soap_wsse_add_BinarySecurityTokenPEM(struct soap *soap, const char *id, const char *filename)
{ FILE *fd;
DBGFUN2("soap_wsse_add_BinarySecurityTokenPEM", "id=%s", id?id:"", "filename=%s", filename?filename:"");
if ((fd = fopen(filename, "r")))
{ /* read the certificate */
X509 *cert = PEM_read_X509(fd, NULL, NULL, NULL);
fclose(fd);
/* if okay, populate the BinarySecurityToken element */
if (cert)
{ int err = soap_wsse_add_BinarySecurityTokenX509(soap, id, cert);
X509_free(cert);
return err;
}
}
return soap_wsse_fault(soap, wsse__InvalidSecurityToken, "Missing certificate");
}
/**
@fn _wsse__BinarySecurityToken* soap_wsse_BinarySecurityToken(struct soap *soap, const char *id)
@brief Returns BinarySecurityToken element if present.
@param soap context
@param[in] id string of token to get or NULL
@return _wsse__BinarySecurityToken object or NULL
*/
struct _wsse__BinarySecurityToken*
soap_wsse_BinarySecurityToken(struct soap *soap, const char *id)
{ _wsse__Security *security = soap_wsse_Security(soap);
if (security
&& security->BinarySecurityToken
&& (!id || (security->BinarySecurityToken->wsu__Id
&& !strcmp(security->BinarySecurityToken->wsu__Id, id))))
return security->BinarySecurityToken;
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "No BinarySecurityToken id=%s, pointer=%p to token found\n", id, security->BinarySecurityToken));
return NULL;
}
/**
@fn int soap_wsse_get_BinarySecurityToken(struct soap *soap, const char *id, char **valueType, unsigned char **data, int *size)
@brief Get wsse:BinarySecurityToken element token data in binary form.
@param soap context
@param[in] id string of token to get or NULL
@param[out] valueType string
@param[out] data points to binary token data
@param[out] size is length of binary token
@return SOAP_OK or SOAP_FAULT with wsse:SecurityTokenUnavailable fault
*/
int
soap_wsse_get_BinarySecurityToken(struct soap *soap, const char *id, char **valueType, unsigned char **data, int *size)
{ _wsse__BinarySecurityToken *token = soap_wsse_BinarySecurityToken(soap, id);
DBGFUN1("soap_wsse_get_BinarySecurityToken", "id=%s", id?id:"");
if (token)
{ *valueType = token->ValueType;
/* it appears we don't need HexBinary after all
if (token->EncodingType && !strcmp(token->EncodingType, wsse_HexBinaryURI))
*data = (unsigned char*)soap_hex2s(soap, token->__item, NULL, 0, size);
else
*/
/* assume token is represented in base64 by default */
*data = (unsigned char*)soap_base642s(soap, token->__item, NULL, 0, size);
if (*data)
return SOAP_OK;
}
return soap_wsse_fault(soap, wsse__SecurityTokenUnavailable, "BinarySecurityToken required");
}
/**
@fn X509* soap_wsse_get_BinarySecurityTokenX509(struct soap *soap, const char *id)
@brief Get X509 wsse:BinarySecurityToken certificate and verify its content.
@param soap context
@param[in] id string of token to get or NULL
@return X509 certificate (dynamically allocated) or NULL with wsse:SecurityTokenUnavailable fault
*/
X509*
soap_wsse_get_BinarySecurityTokenX509(struct soap *soap, const char *id)
{ X509 *cert = NULL;
char *valueType = NULL;
#if (OPENSSL_VERSION_NUMBER >= 0x0090800fL)
const unsigned char *data;
#else
unsigned char *data;
#endif
int size;
DBGFUN1("soap_wsse_get_BinarySecurityTokenX509", "id=%s", id?id:"");
if (!soap_wsse_get_BinarySecurityToken(soap, id, &valueType, (unsigned char**)&data, &size)
&& valueType
&& !strcmp(valueType, wsse_X509v3URI))
cert = d2i_X509(NULL, &data, size);
/* verify the certificate */
if (!cert || soap_wsse_verify_X509(soap, cert))
return NULL;
return cert;
}
/**
@fn int soap_wsse_verify_X509(struct soap *soap, X509 *cert)
@brief Verifies X509 certificate against soap->cafile, soap->capath, and soap->crlfile
@param soap context
@param[in] cert X509 certificate
@return SOAP_OK or fault
This is an expensive operation. Whenever a new soap context is created, the
cafile and objects are loaded into that context each time we need to verify a
certificate.
*/
int
soap_wsse_verify_X509(struct soap *soap, X509 *cert)
{ struct soap_wsse_data *data = (struct soap_wsse_data*)soap_lookup_plugin(soap, soap_wsse_id);
X509_STORE_CTX *verify;
DBGFUN("soap_wsse_verify_X509");
if (!data)
return soap_set_receiver_error(soap, "soap_wsse_sign", "Plugin not registered", SOAP_PLUGIN_ERROR);
if (!cert)
return soap_wsse_sender_fault(soap, "soap_wsse_verify_X509", "No certificate");
if (!data->store)
{ if (!(data->store = X509_STORE_new()))
return soap_wsse_receiver_fault(soap, "soap_wsse_verify_X509", "Could not create X509_STORE object");
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Setting up a new X509 store\n"));
X509_STORE_set_verify_cb_func(data->store, soap->fsslverify);
if (soap->cafile || soap->capath)
{ if (X509_STORE_load_locations(data->store, soap->cafile, soap->capath) != 1)
return soap_wsse_receiver_fault(soap, "soap_wsse_verify_X509", "Could not load CA file or path");
}
#if (OPENSSL_VERSION_NUMBER > 0x00907000L)
if (soap->crlfile)
{ X509_LOOKUP *lookup;
if (!(lookup = X509_STORE_add_lookup(data->store, X509_LOOKUP_file())))
return soap_wsse_receiver_fault(soap, "soap_wsse_verify_X509", "Could not create X509_LOOKUP object");
if (X509_load_crl_file(lookup, soap->crlfile, X509_FILETYPE_PEM) != 1)
return soap_wsse_receiver_fault(soap, "soap_wsse_verify_X509", "Could not read the CRL file");
X509_STORE_set_flags(data->store, X509_V_FLAG_CRL_CHECK | X509_V_FLAG_CRL_CHECK_ALL);
}
#endif
}
if (!(verify = X509_STORE_CTX_new()))
return soap_wsse_receiver_fault(soap, "soap_wsse_verify_X509", "Could not create X509_STORE_CTX object");
#if (OPENSSL_VERSION_NUMBER > 0x00907000L)
if (X509_STORE_CTX_init(verify, data->store, cert, NULL) != 1)
{ X509_STORE_CTX_free(verify);
return soap_wsse_receiver_fault(soap, "soap_wsse_verify_X509", "Could not initialize X509_STORE_CTX object");
}
#else
X509_STORE_CTX_init(verify, data->store, cert, NULL);
#endif
if (X509_verify_cert(verify) != 1)
{ X509_STORE_CTX_free(verify);
return soap_wsse_sender_fault(soap, "soap_wsse_verify_X509", "Invalid certificate");
}
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Certificate is valid\n"));
#ifdef SOAP_DEBUG
{ char buf[1024];
X509_NAME_oneline(X509_get_issuer_name(cert), buf, sizeof(buf));
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "certificate issuer %s\n", buf));
X509_NAME_oneline(X509_get_subject_name(cert), buf, sizeof(buf));
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "certificate subject %s\n", buf));
}
#endif
X509_STORE_CTX_free(verify);
return SOAP_OK;
}
/******************************************************************************\
*
* wsc:SecurityContextToken
*
\******************************************************************************/
/**
@fn int soap_wsse_add_SecurityContextToken(struct soap *soap, const char *id, const char *identifier)
@brief Adds wsc:SecurityContextToken/Identifier and SecurityTokenReference to it
@param soap context
@param[in] id string for signature reference (required)
@param[in] identifier wsc:Identifier value (required)
@return SOAP_OK or error code
*/
int
soap_wsse_add_SecurityContextToken(struct soap *soap, const char *id, const char *identifier)
{ char *URI;
_wsse__Security *security = soap_wsse_add_Security(soap);
DBGFUN2("soap_wsse_add_SecurityContextToken", "id=%s", id, "identifier=%s", identifier?identifier:"");
/* allocate wsc:SecurityContextToken if we don't already have one */
if (!security->wsc__SecurityContextToken)
{ if (!(security->wsc__SecurityContextToken = (struct wsc__SecurityContextTokenType*)soap_malloc(soap, sizeof(struct wsc__SecurityContextTokenType))))
return soap->error = SOAP_EOM;
}
soap_default_wsc__SecurityContextTokenType(soap, security->wsc__SecurityContextToken);
/* populate the wsc:SecurityContextToken */
if (!(URI = (char*)soap_malloc(soap, strlen(id) + 2)))
return soap->error = SOAP_EOM;
*URI = '#';
security->wsc__SecurityContextToken->wsu__Id = strcpy(URI + 1, id);
security->wsc__SecurityContextToken->Identifier = soap_strdup(soap, identifier);
/* set SecurityTokenReference */
return soap_wsse_add_KeyInfo_SecurityTokenReferenceURI(soap, URI, NULL);
}
/**
@fn const char *soap_wsse_get_SecurityContextToken(struct soap *soap)
@brief Returns wsc:SecurityContextToken/Identifier string value or NULL
@param soap context
@return wsc:SecurityContextToken/Identifier string value value or NULL
*/
const char *
soap_wsse_get_SecurityContextToken(struct soap *soap)
{ _wsse__Security *security = soap_wsse_Security(soap);
DBGFUN("soap_wsse_SecurityContextToken");
if (security->wsc__SecurityContextToken && security->wsc__SecurityContextToken->wsu__Id)
{ const char *URI = soap_wsse_get_KeyInfo_SecurityTokenReferenceURI(soap);
if (URI && !strcmp(URI, security->wsc__SecurityContextToken->wsu__Id))
return security->wsc__SecurityContextToken->Identifier;
}
return NULL;
}
/******************************************************************************\
*
* ds:Signature/SignedInfo
*
\******************************************************************************/
/**
@fn ds__SignedInfoType* soap_wsse_add_SignedInfo(struct soap *soap)
@brief Adds SignedInfo element.
@param soap context
@return ds__SignedInfoType object
*/
struct ds__SignedInfoType*
soap_wsse_add_SignedInfo(struct soap *soap)
{ ds__SignatureType *signature = soap_wsse_add_Signature(soap);
if (!signature->SignedInfo)
{ signature->SignedInfo = (ds__SignedInfoType*)soap_malloc(soap, sizeof(ds__SignedInfoType));
if (!signature->SignedInfo)
return NULL;
soap_default_ds__SignedInfoType(soap, signature->SignedInfo);
}
return signature->SignedInfo;
}
/**
@fn int soap_wsse_add_SignedInfo_Reference(struct soap *soap, const char *URI, const char *transform, const char *inclusiveNamespaces, int alg, const char *HA)
@brief Adds SignedInfo element with Reference URI, transform algorithm used, and digest value.
@param soap context
@param[in] URI reference
@param[in] transform string should be c14n_URI for exc-c14n or NULL
@param[in] inclusiveNamespaces used by the exc-c14n transform or NULL
@param[in] alg is the digest algorithm used
@param[in] HA is the digest in binary form
@return SOAP_OK or SOAP_EOM when references exceed SOAP_WSSE_MAX_REF
This function can be called to add more references to the wsse:SignedInfo
element. A maximum number of SOAP_WSSE_MAX_REF references can be added. The
digest method is always SHA1.
Note: XPath transforms cannot be specified in this release.
*/
int
soap_wsse_add_SignedInfo_Reference(struct soap *soap, const char *URI, const char *transform, const char *inclusiveNamespaces, int alg, const char *HA)
{ ds__SignedInfoType *signedInfo = soap_wsse_add_SignedInfo(soap);
ds__ReferenceType *reference;
DBGFUN3("soap_wsse_add_SignedInfo_Reference", "URI=%s", URI?URI:"", "transform=%s", transform?transform:"", "alg=%x", alg);
/* if this is the first reference, allocate SOAP_WSSE_MAX_REF references */
if (signedInfo->__sizeReference == 0)
signedInfo->Reference = (ds__ReferenceType**)soap_malloc(soap, SOAP_WSSE_MAX_REF*sizeof(ds__ReferenceType*));
else
{ /* maximum number of references exceeded? */
if (signedInfo->__sizeReference >= SOAP_WSSE_MAX_REF)
return soap->error = SOAP_EOM;
}
/* allocate fresh new reference */
reference = (ds__ReferenceType*)soap_malloc(soap, sizeof(ds__ReferenceType));
if (!reference)
return soap->error = SOAP_EOM;
soap_default_ds__ReferenceType(soap, reference);
/* populate the URI */
reference->URI = soap_strdup(soap, URI);
/* if a transform algorithm was used, populate the Transforms element */
if (transform)
{ reference->Transforms = (ds__TransformsType*)soap_malloc(soap, sizeof(ds__TransformsType));
if (!reference->Transforms)
return soap->error = SOAP_EOM;
soap_default_ds__TransformsType(soap, reference->Transforms);
/* only one transform */
reference->Transforms->__sizeTransform = 1;
reference->Transforms->Transform = (ds__TransformType*)soap_malloc(soap, sizeof(ds__TransformType));
soap_default_ds__TransformType(soap, reference->Transforms->Transform);
reference->Transforms->Transform->Algorithm = (char*)transform;
/* populate the c14n:InclusiveNamespaces element */
if (inclusiveNamespaces && *inclusiveNamespaces)
{ reference->Transforms->Transform->c14n__InclusiveNamespaces = (_c14n__InclusiveNamespaces*)soap_malloc(soap, sizeof(_c14n__InclusiveNamespaces));
if (!reference->Transforms->Transform->c14n__InclusiveNamespaces)
return soap->error = SOAP_EOM;
soap_default__c14n__InclusiveNamespaces(soap, reference->Transforms->Transform->c14n__InclusiveNamespaces);
reference->Transforms->Transform->c14n__InclusiveNamespaces->PrefixList = soap_strdup(soap, inclusiveNamespaces);
}
}
/* populate the DigestMethod element */
reference->DigestMethod = (ds__DigestMethodType*)soap_malloc(soap, sizeof(ds__DigestMethodType));
if (!reference->DigestMethod)
return soap->error = SOAP_EOM;
soap_default_ds__DigestMethodType(soap, reference->DigestMethod);
/* the DigestMethod algorithm SHA1, SHA256, SHA512 */
switch (alg & SOAP_SMD_HASH)
{ case SOAP_SMD_SHA1:
reference->DigestMethod->Algorithm = (char*)ds_sha1URI;
break;
case SOAP_SMD_SHA256:
reference->DigestMethod->Algorithm = (char*)ds_sha256URI;
break;
case SOAP_SMD_SHA512:
reference->DigestMethod->Algorithm = (char*)ds_sha512URI;
break;
}
/* populate the DigestValue element */
reference->DigestValue = soap_s2base64(soap, (unsigned char*)HA, NULL, soap_smd_size(alg, NULL));
if (!reference->DigestValue)
return soap->error;
/* add the fresh new reference to the array */
signedInfo->Reference[signedInfo->__sizeReference] = reference;
signedInfo->__sizeReference++;
return SOAP_OK;
}
/**
@fn int soap_wsse_add_SignedInfo_SignatureMethod(struct soap *soap, const char *method, int canonical)
@brief Adds SignedInfo element with SignatureMethod.
@param soap context
@param[in] method is the URI of the signature algorithm (e.g. ds_rsa_sha1)
@param[in] canonical flag indicating that SignedInfo is signed in exc-c14n form
@return SOAP_OK
Note: the c14n:InclusiveNamespaces/PrefixList is set to "SOAP-ENV wsse".
*/
int
soap_wsse_add_SignedInfo_SignatureMethod(struct soap *soap, const char *method, int canonical)
{ ds__SignedInfoType *signedInfo = soap_wsse_add_SignedInfo(soap);
DBGFUN2("soap_wsse_add_SignedInfo_SignatureMethod", "method=%s", method?method:"", "canonical=%d", canonical);
/* if signed in exc-c14n form, populate CanonicalizationMethod element */
signedInfo->CanonicalizationMethod = (ds__CanonicalizationMethodType*)soap_malloc(soap, sizeof(ds__CanonicalizationMethodType));
if (!signedInfo->CanonicalizationMethod)
return soap->error = SOAP_EOM;
soap_default_ds__CanonicalizationMethodType(soap, signedInfo->CanonicalizationMethod);
if (canonical)
{ signedInfo->CanonicalizationMethod->Algorithm = (char*)c14n_URI;
/*
signedInfo->CanonicalizationMethod->c14n__InclusiveNamespaces = (_c14n__InclusiveNamespaces*)soap_malloc(soap, sizeof(_c14n__InclusiveNamespaces));
soap_default__c14n__InclusiveNamespaces(soap, signedInfo->CanonicalizationMethod->c14n__InclusiveNamespaces);
signedInfo->CanonicalizationMethod->c14n__InclusiveNamespaces->PrefixList = "SOAP-ENV wsse";
*/
}
/* populate SignatureMethod element */
signedInfo->SignatureMethod = (ds__SignatureMethodType*)soap_malloc(soap, sizeof(ds__SignatureMethodType));
if (!signedInfo->SignatureMethod)
return soap->error = SOAP_EOM;
soap_default_ds__SignatureMethodType(soap, signedInfo->SignatureMethod);
signedInfo->SignatureMethod->Algorithm = (char*)method;
return SOAP_OK;
}
/**
@fn ds__SignedInfoType* soap_wsse_SignedInfo(struct soap *soap)
@brief Returns SignedInfo element if present.
@param soap context
@return ds__SignedInfoType object or NULL
*/
struct ds__SignedInfoType*
soap_wsse_SignedInfo(struct soap *soap)
{ ds__SignatureType *signature = soap_wsse_Signature(soap);
if (signature)
return signature->SignedInfo;
return NULL;
}
/**
@fn int soap_wsse_get_SignedInfo_SignatureMethod(struct soap *soap, int *alg)
@brief Get SignatureMethod algorithm
@param soap context
@param[out] alg is a signature algorithm, such as SOAP_SMD_HMAC_SHA1, SOAP_SMD_VRFY_DSA_SHA1, or SOAP_SMD_VRFY_RSA_SHA1
@return SOAP_OK or SOAP_FAULT with wsse:UnsupportedAlgorithm or wsse:FailedCheck fault
*/
int
soap_wsse_get_SignedInfo_SignatureMethod(struct soap *soap, int *alg)
{ ds__SignedInfoType *signedInfo = soap_wsse_SignedInfo(soap);
DBGFUN("soap_wsse_get_SignedInfo_SignatureMethod");
*alg = SOAP_SMD_NONE;
/* if we have a SignedInfo element, get the algorithm */
if (signedInfo
&& signedInfo->SignatureMethod
&& signedInfo->SignatureMethod->Algorithm)
{ const char *method = signedInfo->SignatureMethod->Algorithm;
if (!strcmp(method, ds_hmac_sha1URI))
*alg = SOAP_SMD_HMAC_SHA1;
else if (!strcmp(method, ds_hmac_sha256URI))
*alg = SOAP_SMD_HMAC_SHA256;
else if (!strcmp(method, ds_hmac_sha512URI))
*alg = SOAP_SMD_HMAC_SHA512;
else if (!strcmp(method, ds_dsa_sha1URI))
*alg = SOAP_SMD_VRFY_DSA_SHA1;
else if (!strcmp(method, ds_rsa_sha1URI))
*alg = SOAP_SMD_VRFY_RSA_SHA1;
else if (!strcmp(method, ds_rsa_sha256URI))
*alg = SOAP_SMD_VRFY_RSA_SHA256;
else if (!strcmp(method, ds_rsa_sha512URI))
*alg = SOAP_SMD_VRFY_RSA_SHA512;
else
return soap_wsse_fault(soap, wsse__UnsupportedAlgorithm, method);
return SOAP_OK;
}
return soap_wsse_fault(soap, wsse__FailedCheck, "Signature required");
}
/******************************************************************************\
*
* ds:Signature/SignatureValue
*
\******************************************************************************/
/**
@fn int soap_wsse_add_SignatureValue(struct soap *soap, int alg, const void *key, int keylen)
@brief Adds SignedInfo/SignatureMethod element, signs the SignedInfo element, and adds the resulting SignatureValue element.
@param soap context
@param[in] alg is SOAP_SMD_HMAC_SHA1, SOAP_SMD_SIGN_DSA_SHA1, or SOAP_SMD_SIGN_RSA_SHA1
@param[in] key to use to sign (HMAC or EVP_PKEY)
@param[in] keylen length of HMAC key
@return SOAP_OK, SOAP_EOM, or fault
To sign the SignedInfo element with this function, populate SignedInfo with
Reference elements first using soap_wsse_add_SignedInfo_Reference. The
SignedInfo element must not be modified after signing.
The SOAP_XML_INDENT and SOAP_XML_CANONICAL flags are used to serialize the
SignedInfo to compute the signature.
*/
int
soap_wsse_add_SignatureValue(struct soap *soap, int alg, const void *key, int keylen)
{ ds__SignatureType *signature = soap_wsse_add_Signature(soap);
const char *method = NULL;
char *sig;
int siglen;
int err;
DBGFUN1("soap_wsse_add_SignatureValue", "alg=%x", alg);
/* determine signature algorithm to use */
switch (alg)
{ case SOAP_SMD_HMAC_SHA1:
method = ds_hmac_sha1URI;
break;
case SOAP_SMD_HMAC_SHA256:
method = ds_hmac_sha256URI;
break;
case SOAP_SMD_HMAC_SHA512:
method = ds_hmac_sha512URI;
break;
case SOAP_SMD_SIGN_DSA_SHA1:
method = ds_dsa_sha1URI;
break;
case SOAP_SMD_SIGN_RSA_SHA1:
method = ds_rsa_sha1URI;
break;
case SOAP_SMD_SIGN_RSA_SHA256:
method = ds_rsa_sha256URI;
break;
case SOAP_SMD_SIGN_RSA_SHA512:
method = ds_rsa_sha512URI;
break;
default:
return soap_wsse_fault(soap, wsse__UnsupportedAlgorithm, NULL);
}
/* populate SignedInfo/SignatureMethod based on SOAP_XML_CANONICAL flag */
soap_wsse_add_SignedInfo_SignatureMethod(soap, method, (soap->mode & SOAP_XML_CANONICAL));
/* use the gSOAP engine's look-aside buffer to temporarily hold the sig */
if (soap_store_lab(soap, NULL, soap_smd_size(alg, key)))
return soap->error = SOAP_EOM;
sig = soap->labbuf;
/* we will serialize SignedInfo as it appears exactly in the SOAP Header */
/* set indent level for XML SignedInfo as it appears in the SOAP Header */
soap->level = 4;
/* prevent xmlns:ds namespace inclusion when non-exclusive is used */
if (!(soap->mode & SOAP_XML_CANONICAL))
soap_push_namespace(soap, "ds", ds_URI);
/* use smdevp engine to sign SignedInfo */
err = soap_smd_begin(soap, alg, key, keylen);
if (!err)
err = soap_out_ds__SignedInfoType(soap, "ds:SignedInfo", 0, signature->SignedInfo, NULL);
if (soap_smd_end(soap, sig, &siglen) || err)
return soap_wsse_fault(soap, wsse__InvalidSecurity, "Could not sign");
/* populate the SignatureValue element */
signature->SignatureValue = soap_s2base64(soap, (unsigned char*)sig, NULL, siglen);
if (!signature->SignatureValue)
return soap->error;
return SOAP_OK;
}
/**
@fn int soap_wsse_verify_SignatureValue(struct soap *soap, int alg, const void *key, int keylen)
@brief Verifies the SignatureValue of a SignedInfo element.
@param soap context
@param[in] alg is a signature algorith, such as SOAP_SMD_HMAC_SHA1, SOAP_SMD_VRFY_DSA_SHA1, or SOAP_SMD_VRFY_RSA_SHA1 determined by the SignedInfo/SignatureMethod
@param[in] key to use to verify (HMAC or EVP_PKEY)
@param[in] keylen length of HMAC key
@return SOAP_OK, SOAP_EOM, or fault
This function searches for the SignedInfo element in the soap->dom DOM tree to
verify the signature in the SignatureValue element. Using the DOM ensures we
will verify the signature of a SignedInfo as it was exactly received by the
parser, by using the -DWITH_DOM compile flag and SOAP_XML_DOM runtime flag. If
there is no DOM, it verifies the signature of the deserialized SignedInfo
element in the SOAP Header. However, serializing deserialized data may change
the octet stream that was signed, unless we're using gSOAP as producers and
consumers (with the SOAP_XML_INDENT flag reset).
*/
int
soap_wsse_verify_SignatureValue(struct soap *soap, int alg, const void *key, int keylen)
{ ds__SignatureType *signature = soap_wsse_Signature(soap);
DBGFUN1("soap_wsse_verify_SignatureValue", "alg=%x", alg);
/* always need an HMAC secret key or DSA/RSA public key to verify */
if (!key)
return soap_wsse_fault(soap, wsse__SecurityTokenUnavailable, NULL);
/* verify the SignedInfo element with the SignatureValue element */
if (signature
&& signature->SignedInfo
&& signature->SignatureValue)
{ char *sig;
const char *sigval;
int method, siglen, sigvallen;
/* check that we are using the intended signature algorithm */
if (soap_wsse_get_SignedInfo_SignatureMethod(soap, &method))
return soap->error;
if (alg != method)
return soap_wsse_fault(soap, wsse__FailedCheck, "Incorrect signature algorithm used");
/* retrieve the signature */
sigval = soap_base642s(soap, signature->SignatureValue, NULL, 0, &sigvallen);
/* search the DOM for SignedInfo */
if (soap->dom)
{ struct soap_dom_element *elt;
/* traverse the DOM while searching for SignedInfo in the ds namespace */
for (elt = soap->dom; elt; elt = soap_dom_next_element(elt))
{ if (elt->name
&& elt->nstr
&& !strcmp(elt->nstr, ds_URI)
&& (!strcmp(elt->name, "SignedInfo") || !soap_tag_cmp(elt->name, "*:SignedInfo")))
break;
}
/* found it? */
if (elt)
{ int err = SOAP_OK;
/* should not include leading whitespace in signature verification */
elt->head = NULL;
/* use smdevp engine to verify SignedInfo */
if ((alg & SOAP_SMD_ALGO) == SOAP_SMD_HMAC)
sig = (char*)soap_malloc(soap, soap_smd_size(alg, key));
else
{ sig = (char*)sigval;
siglen = sigvallen;
}
if (signature->SignedInfo->CanonicalizationMethod
&& signature->SignedInfo->CanonicalizationMethod->Algorithm
&& !strcmp(signature->SignedInfo->CanonicalizationMethod->Algorithm, c14n_URI))
{ struct soap_dom_element *prt;
struct soap_dom_attribute *att;
/* recanonicalize DOM while keeping content "as is" */
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Verifying signed canonicalized DOM\n"));
soap->mode &= ~SOAP_XML_DOM;
soap->mode |= SOAP_XML_CANONICAL | SOAP_DOM_ASIS;
err = soap_smd_begin(soap, alg, key, keylen);
/* emit all xmlns attributes of ancestors */
while (soap->nlist)
{ register struct soap_nlist *np = soap->nlist->next;
SOAP_FREE(soap, soap->nlist);
soap->nlist = np;
}
/* TODO: consider moving this into dom.cpp */
for (prt = elt->prnt; prt; prt = prt->prnt)
{ for (att = prt->atts; att; att = att->next)
if (!strncmp(att->name, "xmlns:", 6) && !soap_lookup_ns(soap, att->name + 6, strlen(att->name + 6)))
soap_attribute(soap, att->name, att->data);
}
for (prt = elt->prnt; prt; prt = prt->prnt)
{ for (att = prt->atts; att; att = att->next)
if (!strcmp(att->name, "xmlns"))
{ soap_attribute(soap, att->name, att->data);
break;
}
}
}
else
{ /* compute digest over DOM "as is" */
soap->mode &= ~(SOAP_XML_CANONICAL | SOAP_XML_DOM);
soap->mode |= SOAP_DOM_ASIS;
err = soap_smd_begin(soap, alg, key, keylen);
}
/* do not dump namespace table xmlns bindings */
soap->ns = 2;
/* compute digest */
soap->feltbegout = NULL;
soap->feltendout = NULL;
if (!err)
err = soap_out_xsd__anyType(soap, NULL, 0, elt, NULL);
if (soap_smd_end(soap, sig, &siglen) || err)
return soap_wsse_fault(soap, wsse__FailedCheck, "The signed SignedInfo SignatureValue is invalid");
if ((alg & SOAP_SMD_ALGO) == SOAP_SMD_HMAC)
{ if (siglen != sigvallen || memcmp(sig, sigval, siglen))
return soap_wsse_fault(soap, wsse__FailedCheck, "The HMAC-signed SignedInfo is invalid");
}
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Signature in DOM is valid\n"));
return SOAP_OK;
}
}
else
{ int err = SOAP_OK;
const char *c14nexclude;
soap_mode mode;
/* serialize the SignedInfo element as it appeared in the SOAP Header */
soap->level = 4;
c14nexclude = soap->c14nexclude;
soap->c14nexclude = "ds";
mode = soap->mode;
if (signature->SignedInfo->CanonicalizationMethod)
soap->mode |= SOAP_XML_CANONICAL;
else
soap->mode &= ~SOAP_XML_CANONICAL;
if ((alg & SOAP_SMD_ALGO) == SOAP_SMD_HMAC)
sig = (char*)soap_malloc(soap, soap_smd_size(alg, key));
else
{ sig = (char*)sigval;
siglen = sigvallen;
}
err = soap_smd_begin(soap, alg, key, keylen);
if (!err)
err = soap_out_ds__SignedInfoType(soap, "ds:SignedInfo", 0, signature->SignedInfo, NULL);
soap->mode = mode;
soap->c14nexclude = c14nexclude;
if (soap_smd_end(soap, sig, &siglen) || err)
return soap_wsse_fault(soap, wsse__FailedCheck, "The signed serialized SignedInfo SignatureValue is invalid");
if ((alg & SOAP_SMD_ALGO) == SOAP_SMD_HMAC)
{ if (siglen != sigvallen || memcmp(sig, sigval, siglen))
return soap_wsse_fault(soap, wsse__FailedCheck, "The HMAC-signed serialized SignedInfo is invalid");
}
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Signature is valid\n"));
return SOAP_OK;
}
}
return soap_wsse_fault(soap, wsse__FailedCheck, "SignedInfo required");
}
/**
@fn int soap_wsse_verify_SignedInfo(struct soap *soap)
@brief Verifies the digest values of the XML elements referenced by the SignedInfo References.
@param soap context
@return SOAP_OK or fault
This function searches for the SignedInfo element in the soap->dom DOM tree to
verify the digests contained therein. Using the DOM ensures we will verify the
digests of the locally signed elements as they were exactly received by the
parser, by using the -DWITH_DOM compile flag and SOAP_XML_DOM runtime flag. If
there is no DOM, the function fails.
*/
int
soap_wsse_verify_SignedInfo(struct soap *soap)
{ ds__SignedInfoType *signedInfo = soap_wsse_SignedInfo(soap);
DBGFUN("soap_wsse_verify_SignedInfo");
if (signedInfo)
{ int i;
/* must have at least one reference element */
if (signedInfo->__sizeReference == 0)
return soap_wsse_fault(soap, wsse__InvalidSecurity, "Missing SignedInfo/Reference");
/* As an alternative to the current implementatin, this might be a good place to re-canonicalize the entire DOM to improve interop. Two DOMs can be used: one with non-c14n XML and one with c14n XML so we can handle multiple different transforms. */
/* for each reference element, check the digest */
for (i = 0; i < signedInfo->__sizeReference; i++)
{ ds__ReferenceType *reference = signedInfo->Reference[i];
/* reference element is complete? */
if (!reference->URI
|| !reference->DigestMethod
|| !reference->DigestMethod->Algorithm
|| !reference->DigestValue)
return soap_wsse_fault(soap, wsse__InvalidSecurity, "Incomplete SignedInfo/Reference");
/* reference is local? */
if (*reference->URI == '#')
{ int alg, canonical;
unsigned char hash[SOAP_SMD_MAX_SIZE];
/* digest algorithm */
if (!strcmp(reference->DigestMethod->Algorithm, ds_sha1URI))
alg = SOAP_SMD_DGST_SHA1;
else if (!strcmp(reference->DigestMethod->Algorithm, ds_sha256URI))
alg = SOAP_SMD_DGST_SHA256;
else if (!strcmp(reference->DigestMethod->Algorithm, ds_sha512URI))
alg = SOAP_SMD_DGST_SHA512;
else
return soap_wsse_fault(soap, wsse__UnsupportedAlgorithm, reference->DigestMethod->Algorithm);
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Verifying digest of locally referenced data %s alg=%x\n", reference->URI, alg));
/* if reference has a transform, it should be an exc-c14n transform */
if (reference->Transforms)
{ if (reference->Transforms->__sizeTransform != 1
|| !reference->Transforms->Transform[0].Algorithm
|| strcmp(reference->Transforms->Transform[0].Algorithm, c14n_URI))
return soap_wsse_fault(soap, wsse__UnsupportedAlgorithm, reference->Transforms->Transform[0].Algorithm);
canonical = 1;
}
else
canonical = 0;
/* convert base64 digest to binary */
soap_base642s(soap, reference->DigestValue, (char*)hash, SOAP_SMD_MAX_SIZE, NULL);
/* verify the digest of a locally signed element */
if (soap_wsse_verify_digest(soap, alg, canonical, reference->URI + 1, hash))
return soap->error;
}
}
return SOAP_OK;
}
return soap_wsse_fault(soap, wsse__InvalidSecurity, "Missing SignedInfo");
}
/**
@fn int soap_wsse_verify_digest(struct soap *soap, int alg, int canonical, const char *id, unsigned char hash[SOAP_SMD_MAX_SIZE])
@brief Verifies the digest value of an XML element referenced by id against the hash.
@param soap context
@param[in] alg digest algorithm
@param[in] canonical flag indicating that element is signed in exc-c14n form
@param[in] id string of the XML element to verify
@param[in] hash digest value to verify against
@return SOAP_OK or fault
*/
int
soap_wsse_verify_digest(struct soap *soap, int alg, int canonical, const char *id, unsigned char hash[SOAP_SMD_MAX_SIZE])
{ struct soap_wsse_data *data = (struct soap_wsse_data*)soap_lookup_plugin(soap, soap_wsse_id);
struct soap_dom_element *elt, *dom = NULL;
DBGFUN3("soap_wsse_verify_digest", "alg=%x", alg, "canonical=%d", canonical, "id=%s", id);
if (!data)
return soap_set_receiver_error(soap, "soap_wsse_verify_digest", "Plugin not registered", SOAP_PLUGIN_ERROR);
/* traverse the DOM to find the element with matching wsu:Id or ds:Id */
for (elt = soap->dom; elt; elt = soap_dom_next_element(elt))
{ struct soap_dom_attribute *att;
for (att = elt->atts; att; att = att->next)
{ /* check attribute */
if (att->name
&& att->nstr
&& (!strcmp(att->nstr, wsu_URI) || !strcmp(att->nstr, ds_URI))
&& (!strcmp(att->name, "Id") || !soap_tag_cmp(att->name, "*:Id")))
{ /* found a match, compare attribute value with id */
if (att->data && !strcmp(att->data, id))
{ if (dom)
return soap_wsse_fault(soap, wsse__FailedCheck, "SignedInfo duplicate Id");
dom = elt;
/* elt = NULL; break; */ /* improves speed but skips duplicate Id check */
}
}
}
}
if (dom)
{ unsigned char HA[SOAP_SMD_MAX_SIZE];
int len, err = SOAP_OK;
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Computing digest for Id=%s\n", id));
/* do not hash leading whitespace */
dom->head = NULL;
/* canonical or as-is? */
if (canonical)
{ struct soap_dom_element *prt;
struct soap_dom_attribute *att;
soap->mode |= SOAP_XML_CANONICAL | SOAP_DOM_ASIS;
err = soap_smd_begin(soap, alg, NULL, 0);
/* emit all xmlns attributes of ancestors */
while (soap->nlist)
{ register struct soap_nlist *np = soap->nlist->next;
SOAP_FREE(soap, soap->nlist);
soap->nlist = np;
}
/* TODO: consider moving this into dom.cpp */
for (prt = dom->prnt; prt; prt = prt->prnt)
{ for (att = prt->atts; att; att = att->next)
{ if (!strncmp(att->name, "xmlns:", 6) && !soap_lookup_ns(soap, att->name + 6, strlen(att->name + 6)))
{ DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Attribute=%s\n", att->name));
soap_attribute(soap, att->name, att->data);
}
}
}
for (prt = dom->prnt; prt; prt = prt->prnt)
{ for (att = prt->atts; att; att = att->next)
{ if (!strcmp(att->name, "xmlns"))
{ soap_attribute(soap, att->name, att->data);
break;
}
}
}
}
else
{ /* compute digest over DOM "as is" */
soap->mode &= ~SOAP_XML_CANONICAL;
soap->mode |= SOAP_DOM_ASIS;
err = soap_smd_begin(soap, alg, NULL, 0);
}
/* do not dump namespace table xmlns bindings */
soap->ns = 2;
/* compute digest */
soap->feltbegout = NULL;
soap->feltendout = NULL;
if (!err)
err = soap_out_xsd__anyType(soap, NULL, 0, dom, NULL);
if (soap_smd_end(soap, (char*)HA, &len) || err)
return soap_wsse_fault(soap, wsse__FailedCheck, "Digest computation failed");
/* compare digests, success if identical */
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Comparing digest hashes\n"));
DBGHEX(TEST, hash, len);
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "\n--\n"));
DBGHEX(TEST, HA, len);
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "\n"));
if (!memcmp(hash, HA, (size_t)len))
return SOAP_OK;
return soap_wsse_fault(soap, wsse__FailedCheck, NULL);
}
if (data->vrfy_alg & SOAP_WSSE_IGNORE_EXTRA_REFS)
return SOAP_OK;
return soap_wsse_fault(soap, wsse__FailedCheck, "SignedInfo reference URI target not found");
}
/******************************************************************************\
*
* ds:Signature/KeyInfo
*
\******************************************************************************/
/**
@fn ds__KeyInfoType* soap_wsse_add_KeyInfo(struct soap *soap)
@brief Adds KeyInfo element.
@param soap context
@return ds__KeyInfo object
*/
struct ds__KeyInfoType*
soap_wsse_add_KeyInfo(struct soap *soap)
{ ds__SignatureType *signature = soap_wsse_add_Signature(soap);
if (!signature->KeyInfo)
{ signature->KeyInfo = (ds__KeyInfoType*)soap_malloc(soap, sizeof(ds__KeyInfoType));
if (!signature->KeyInfo)
return NULL;
}
soap_default_ds__KeyInfoType(soap, signature->KeyInfo);
return signature->KeyInfo;
}
/**
@fn ds__KeyInfoType* soap_wsse_KeyInfo(struct soap *soap)
@brief Returns KeyInfo element if present.
@param soap context
@return ds__KeyInfo object or NULL
*/
struct ds__KeyInfoType*
soap_wsse_KeyInfo(struct soap *soap)
{ ds__SignatureType *signature = soap_wsse_Signature(soap);
if (signature)
return signature->KeyInfo;
return NULL;
}
/******************************************************************************\
*
* ds:Signature/KeyInfo/KeyName
*
\******************************************************************************/
/**
@fn int soap_wsse_add_KeyInfo_KeyName(struct soap *soap, const char *name)
@brief Adds KeyName element.
@param soap context
@param[in] name string of the KeyName
@return SOAP_OK
Note: the recommended method to add Key information is to utilize KeyIdentifier
instead of KeyName. A KeyName is useful mainly for internal use.
*/
int
soap_wsse_add_KeyInfo_KeyName(struct soap *soap, const char *name)
{ ds__KeyInfoType *keyInfo = soap_wsse_add_KeyInfo(soap);
DBGFUN1("soap_wsse_add_KeyInfo_KeyName", "name=%s", name);
/* populate the KeyName element */
keyInfo->KeyName = soap_strdup(soap, name);
return SOAP_OK;
}
/**
@fn int soap_wsse_get_KeyInfo_KeyName(struct soap *soap)
@brief Returns KeyName element if present.
@param soap context
@return string or NULL
*/
const char*
soap_wsse_get_KeyInfo_KeyName(struct soap *soap)
{ ds__KeyInfoType *keyInfo = soap_wsse_KeyInfo(soap);
DBGFUN("soap_wsse_get_KeyInfo_KeyName");
if (!keyInfo)
return NULL;
return keyInfo->KeyName;
}
/******************************************************************************\
*
* ds:Signature/KeyInfo/wsse:SecurityTokenReference/Reference/@URI
*
\******************************************************************************/
/**
@fn int soap_wsse_add_KeyInfo_SecurityTokenReferenceURI(struct soap *soap, const char *URI, const char *valueType)
@brief Adds KeyInfo element with SecurityTokenReference URI.
@param soap context
@param[in] URI string referencing a security token
@param[in] valueType string or NULL
@return SOAP_OK
*/
int
soap_wsse_add_KeyInfo_SecurityTokenReferenceURI(struct soap *soap, const char *URI, const char *valueType)
{ ds__KeyInfoType *keyInfo = soap_wsse_add_KeyInfo(soap);
DBGFUN2("soap_wsse_add_KeyInfo_SecurityTokenReferenceURI", "URI=%s", URI?URI:"", "valueType=%s", valueType?valueType:"");
/* allocate SecurityTokenReference element if we don't have one already */
if (!keyInfo->wsse__SecurityTokenReference)
{ keyInfo->wsse__SecurityTokenReference = (_wsse__SecurityTokenReference*)soap_malloc(soap, sizeof(_wsse__SecurityTokenReference));
if (!keyInfo->wsse__SecurityTokenReference)
return soap->error = SOAP_EOM;
}
soap_default__wsse__SecurityTokenReference(soap, keyInfo->wsse__SecurityTokenReference);
/* allocate Reference element */
keyInfo->wsse__SecurityTokenReference->Reference = (_wsse__Reference*)soap_malloc(soap, sizeof(_wsse__Reference));
soap_default__wsse__Reference(soap, keyInfo->wsse__SecurityTokenReference->Reference);
/* populate the Reference element */
keyInfo->wsse__SecurityTokenReference->Reference->URI = soap_strdup(soap, URI);
keyInfo->wsse__SecurityTokenReference->Reference->ValueType = soap_strdup(soap, valueType);
return SOAP_OK;
}
/**
@fn int soap_wsse_add_KeyInfo_SecurityTokenReferenceX509(struct soap *soap, const char *URI)
@brief Adds KeyInfo element with SecurityTokenReference URI to an X509 cert.
@param soap context
@param[in] URI string referencing an X509 certificate
@return SOAP_OK
*/
int
soap_wsse_add_KeyInfo_SecurityTokenReferenceX509(struct soap *soap, const char *URI)
{ return soap_wsse_add_KeyInfo_SecurityTokenReferenceURI(soap, URI, wsse_X509v3URI);
}
/**
@fn const char* soap_wsse_get_KeyInfo_SecurityTokenReferenceURI(struct soap *soap)
@brief Returns a SecurityTokenReference URI if present.
@param soap context
@return string or NULL
*/
const char*
soap_wsse_get_KeyInfo_SecurityTokenReferenceURI(struct soap *soap)
{ ds__KeyInfoType *keyInfo = soap_wsse_KeyInfo(soap);
if (keyInfo
&& keyInfo->wsse__SecurityTokenReference
&& keyInfo->wsse__SecurityTokenReference->Reference)
return keyInfo->wsse__SecurityTokenReference->Reference->URI;
return NULL;
}
/**
@fn const char* soap_wsse_get_KeyInfo_SecurityTokenReferenceValueType(struct soap *soap)
@brief Returns a SecurityTokenReference ValueType if present.
@param soap context
@return string or NULL
*/
const char*
soap_wsse_get_KeyInfo_SecurityTokenReferenceValueType(struct soap *soap)
{ ds__KeyInfoType *keyInfo = soap_wsse_KeyInfo(soap);
if (keyInfo
&& keyInfo->wsse__SecurityTokenReference
&& keyInfo->wsse__SecurityTokenReference->Reference)
return keyInfo->wsse__SecurityTokenReference->Reference->ValueType;
return NULL;
}
/**
@fn X509* soap_wsse_get_KeyInfo_SecurityTokenReferenceX509(struct soap *soap)
@brief Returns a X509 certificate if present as a BinarySecurity token.
@param soap context
@return X509 object or NULL with wsse:SecurityTokenUnavailable fault
*/
X509*
soap_wsse_get_KeyInfo_SecurityTokenReferenceX509(struct soap *soap)
{ const char *URI = soap_wsse_get_KeyInfo_SecurityTokenReferenceURI(soap);
X509 *cert = NULL;
DBGFUN("soap_wsse_get_KeyInfo_SecurityTokenReferenceX509");
if (URI && *URI == '#')
{ const char *valueType;
valueType = soap_wsse_get_KeyInfo_SecurityTokenReferenceValueType(soap);
if (!valueType || !strcmp(valueType, wsse_X509v3URI))
cert = soap_wsse_get_BinarySecurityTokenX509(soap, URI + 1);
}
return cert;
}
/**
@fn struct ds__X509IssuerSerialType *soap_wsse_get_KeyInfo_SecurityTokenReferenceX509Data(struct soap *soap)
@brief Returns ds__X509IssuerSerialType with non-NULL X509IssuerName and non-NULL X509SerialNumber of a X509Data element when present and set.
@param soap context
@return pointer to ds__X509IssuerSerialType struct or NULL
*/
struct ds__X509IssuerSerialType *
soap_wsse_get_KeyInfo_SecurityTokenReferenceX509Data(struct soap *soap)
{ ds__KeyInfoType *keyInfo = soap_wsse_KeyInfo(soap);
if (keyInfo
&& keyInfo->wsse__SecurityTokenReference
&& keyInfo->wsse__SecurityTokenReference->ds__X509Data
&& keyInfo->wsse__SecurityTokenReference->ds__X509Data->X509IssuerSerial
&& keyInfo->wsse__SecurityTokenReference->ds__X509Data->X509IssuerSerial->X509IssuerName
&& keyInfo->wsse__SecurityTokenReference->ds__X509Data->X509IssuerSerial->X509SerialNumber)
return keyInfo->wsse__SecurityTokenReference->ds__X509Data->X509IssuerSerial;
return NULL;
}
/******************************************************************************\
*
* ds:Signature/KeyInfo/wsse:SecurityTokenReference/Reference/KeyIdentifier
*
\******************************************************************************/
/**
@fn int soap_wsse_add_KeyInfo_SecurityTokenReferenceKeyIdentifier(struct soap *soap, const char *id, const char *valueType, unsigned char *data, int size)
@brief Adds KeyInfo element with SecurityTokenReference/KeyIdentifier binary data
@param soap context
@param[in] id string for signature reference
@param[in] valueType string
@param[in] data binary data
@param[in] size of binary data
@return SOAP_OK
*/
int
soap_wsse_add_KeyInfo_SecurityTokenReferenceKeyIdentifier(struct soap *soap, const char *id, const char *valueType, unsigned char *data, int size)
{ ds__KeyInfoType *keyInfo = soap_wsse_add_KeyInfo(soap);
DBGFUN2("soap_wsse_add_KeyInfo_SecurityTokenReferenceKeyIdentifier", "id=%s", id?id:"", "valueType=%s", valueType?valueType:"");
/* allocate SecurityTokenReference if we don't have one already */
if (!keyInfo->wsse__SecurityTokenReference)
{ keyInfo->wsse__SecurityTokenReference = (_wsse__SecurityTokenReference*)soap_malloc(soap, sizeof(_wsse__SecurityTokenReference));
if (!keyInfo->wsse__SecurityTokenReference)
return soap->error = SOAP_EOM;
}
soap_default__wsse__SecurityTokenReference(soap, keyInfo->wsse__SecurityTokenReference);
/* allocate KeyIdentifier */
keyInfo->wsse__SecurityTokenReference->KeyIdentifier = (_wsse__KeyIdentifier*)soap_malloc(soap, sizeof(_wsse__KeyIdentifier));
if (!keyInfo->wsse__SecurityTokenReference->KeyIdentifier)
return soap->error = SOAP_EOM;
soap_default__wsse__KeyIdentifier(soap, keyInfo->wsse__SecurityTokenReference->KeyIdentifier);
/* populate KeyIdentifier */
keyInfo->wsse__SecurityTokenReference->KeyIdentifier->wsu__Id = soap_strdup(soap, id);
keyInfo->wsse__SecurityTokenReference->KeyIdentifier->ValueType = soap_strdup(soap, valueType);
keyInfo->wsse__SecurityTokenReference->KeyIdentifier->EncodingType = (char*)wsse_Base64BinaryURI;
keyInfo->wsse__SecurityTokenReference->KeyIdentifier->__item = soap_s2base64(soap, data, NULL, size);
return SOAP_OK;
}
/**
@fn const char* soap_wsse_get_KeyInfo_SecurityTokenReferenceKeyIdentifierValueType(struct soap *soap)
@brief Returns KeyInfo/SecurityTokenReference/KeyIdentifier/ValueType if present
@param soap context
@return string or NULL
*/
const char*
soap_wsse_get_KeyInfo_SecurityTokenReferenceKeyIdentifierValueType(struct soap *soap)
{ ds__KeyInfoType *keyInfo = soap_wsse_KeyInfo(soap);
DBGFUN("soap_wsse_get_KeyInfo_SecurityTokenReferenceKeyIdentifierValueType");
if (!keyInfo
|| !keyInfo->wsse__SecurityTokenReference
|| !keyInfo->wsse__SecurityTokenReference->KeyIdentifier)
return NULL;
return keyInfo->wsse__SecurityTokenReference->KeyIdentifier->ValueType;
}
/**
@fn const unsigned char* soap_wsse_get_KeyInfo_SecurityTokenReferenceKeyIdentifier(struct soap *soap, int *size)
@brief Returns KeyInfo/SecurityTokenReference/KeyIdentifier binary data
@param soap context
@param[out] size is set to the size of the decoded data
@return data or NULL
*/
const unsigned char*
soap_wsse_get_KeyInfo_SecurityTokenReferenceKeyIdentifier(struct soap *soap, int *size)
{ ds__KeyInfoType *keyInfo = soap_wsse_KeyInfo(soap);
DBGFUN("soap_wsse_get_KeyInfo_SecurityTokenReferenceKeyIdentifier");
if (!keyInfo
|| !keyInfo->wsse__SecurityTokenReference
|| !keyInfo->wsse__SecurityTokenReference->KeyIdentifier)
return NULL;
return (unsigned char*)soap_base642s(soap, keyInfo->wsse__SecurityTokenReference->KeyIdentifier->__item, NULL, 0, size);
}
/******************************************************************************\
*
* ds:Signature/KeyInfo/wsse:SecurityTokenReference/Reference/Embedded
*
\******************************************************************************/
/**
@fn int soap_wsse_add_KeyInfo_SecurityTokenReferenceEmbedded(struct soap *soap, const char *id, const char *valueType)
@brief Adds KeyInfo element with Embedded SecurityTokenReference.
@param soap context
@param[in] id string for signature reference
@param[in] valueType string
@return SOAP_OK
Note: this function does not add embedded tokens automatically. See code for comments.
*/
int
soap_wsse_add_KeyInfo_SecurityTokenReferenceEmbedded(struct soap *soap, const char *id, const char *valueType)
{ ds__KeyInfoType *keyInfo = soap_wsse_add_KeyInfo(soap);
DBGFUN("soap_wsse_get_KeyInfo_SecurityTokenReferenceEmbedded");
/* allocate SecurityTokenReference if we don't have one already */
if (!keyInfo->wsse__SecurityTokenReference)
{ keyInfo->wsse__SecurityTokenReference = (_wsse__SecurityTokenReference*)soap_malloc(soap, sizeof(_wsse__SecurityTokenReference));
if (!keyInfo->wsse__SecurityTokenReference)
return soap->error = SOAP_EOM;
}
soap_default__wsse__SecurityTokenReference(soap, keyInfo->wsse__SecurityTokenReference);
/* allocate Embedded element */
keyInfo->wsse__SecurityTokenReference->Embedded = (_wsse__Embedded*)soap_malloc(soap, sizeof(_wsse__Embedded));
if (!keyInfo->wsse__SecurityTokenReference->Embedded)
return soap->error = SOAP_EOM;
soap_default__wsse__Embedded(soap, keyInfo->wsse__SecurityTokenReference->Embedded);
/* populate Embedded element */
keyInfo->wsse__SecurityTokenReference->Embedded->wsu__Id = soap_strdup(soap, id);
keyInfo->wsse__SecurityTokenReference->Embedded->ValueType = soap_strdup(soap, valueType);
/* TODO: Add embedded tokens and assertions. Could use DOM here?
keyInfo->wsse__SecurityTokenReference->Embedded->xyz = ...;
*/
return SOAP_OK;
}
/******************************************************************************\
*
* wsse:Security/xenc:EncryptedKey header element
*
\******************************************************************************/
/**
@fn int soap_wsse_add_EncryptedKey(struct soap *soap, int alg, const char *URI, X509 *cert, const char *subjectkeyid, const char *issuer, const char *serial)
@brief Adds EncryptedKey header element and initiates the encryption of the
SOAP Body.
@param soap context
@param[in] alg algorithm to use, SOAP_MEC_ENV_ENC_DES_CBC or SOAP_MEC_ENV_ENC_AEAS256_CBC
@param[in] URI a unique identifier for the key, required for interoperability
@param[in] cert the X509 certificate with public key or NULL
@param[in] subjectkeyid string identification of the subject which when set to non-NULL is used instead of embedding the public key in the message
@param[in] issuer string to include SecurityTokenReference/X509Data
@param[in] serial string to include SecurityTokenReference/X509Data
@return SOAP_OK or error code
This function adds the encrypted key or subject key ID to the WS-Security
header and initiates encryption of the SOAP Body. An X509 certificate may be
provided, or the subjectkeyid, or the issuer and serial number. The certificate
is embedded in the WS-Security EncryptedKey header. If the subjectkeyid string
is non-NULL the subject key ID is used in the EncryptedKey header instead of
the X509 certificate content.
*/
int
soap_wsse_add_EncryptedKey(struct soap *soap, int alg, const char *URI, X509 *cert, const char *subjectkeyid, const char *issuer, const char *serial)
{ return soap_wsse_add_EncryptedKey_encrypt_only(soap, alg, URI, cert, subjectkeyid, issuer, serial, NULL);
}
/**
@fn int soap_wsse_add_EncryptedKey_encrypt_only(struct soap *soap, int alg, const char *URI, X509 *cert, const char *subjectkeyid, const char *issuer, const char *serial, const char *tags)
@brief Adds EncryptedKey header element and initiates encryption of the given
XML elements specified in the tags string. Should be used in combination with
soap_wsse_set_wsu_id to set wsu:Id for given XML element tags.
@param soap context
@param[in] alg algorithm to use, SOAP_MEC_ENV_ENC_DES_CBC or SOAP_MEC_ENV_ENC_AEAS256_CBC
@param[in] URI a unique identifier for the key, required for interoperability
@param[in] cert the X509 certificate with public key or NULL
@param[in] subjectkeyid string identification of the subject which when set to non-NULL is used instead of embedding the public key in the message
@param[in] issuer string to include SecurityTokenReference/X509Data
@param[in] serial string to include SecurityTokenReference/X509Data
@param[in] tags space-separated string of element tag names to encrypt
@return xenc__EncryptedKeyType object
This function adds the encrypted key or subject key ID to the WS-Security
header and initiates encryption of the SOAP Body. An X509 certificate may be
provided, or the subjectkeyid, or the issuer and serial number. The certificate
is embedded in the WS-Security EncryptedKey header. If the subjectkeyid string
is non-NULL the subject key ID is used in the EncryptedKey header instead of
the X509 certificate content. Only the XML elements given in the 'tags' string
as wsu:Id attributed elements are encrypted.
WARNING:
Use @ref soap_wsse_add_EncryptedKey_encrypt_only only in combination with
@ref soap_wsse_set_wsu_id with the tag names of the elements to be encrypted.
OTHERWISE THE GIVEN XML ELEMENTS ARE NOT ENCRYPTED AND WILL BE SENT IN THE
CLEAR.
WARNING:
The elements identified with @ref soap_wsse_set_wsu_id to encrypt MUST occur
EXACTLY ONCE in the SOAP Body.
WARNING:
Encryption/decryption of elements with simple content (CDATA content) IS NOT
SUPPORTED. This means that elements you want to encrypt with this function must
have complex content. That is, only encrypt elements with sub elements or
encrypt the entire SOAP Body.
*/
int
soap_wsse_add_EncryptedKey_encrypt_only(struct soap *soap, int alg, const char *URI, X509 *cert, const char *subjectkeyid, const char *issuer, const char *serial, const char *tags)
{ EVP_PKEY *pubk;
unsigned char *key;
int keylen;
_wsse__Security *security;
struct soap_wsse_data *data = (struct soap_wsse_data*)soap_lookup_plugin(soap, soap_wsse_id);
DBGFUN("soap_wsse_add_EncryptedKey");
if (!data)
return soap_set_receiver_error(soap, "soap_wsse_add_EncryptedKey", "Plugin not registered", SOAP_PLUGIN_ERROR);
security = soap_wsse_add_Security(soap);
/* if we don't have a xenc:EncryptedKey, create one */
if (!security->xenc__EncryptedKey)
{ if (!(security->xenc__EncryptedKey = (xenc__EncryptedKeyType*)soap_malloc(soap, sizeof(xenc__EncryptedKeyType))))
return soap->error = SOAP_EOM;
}
soap_default_xenc__EncryptedKeyType(soap, security->xenc__EncryptedKey);
security->xenc__EncryptedKey->Id = soap_strdup(soap, URI);
if (!(security->xenc__EncryptedKey->EncryptionMethod = (xenc__EncryptionMethodType*)soap_malloc(soap, sizeof(struct xenc__EncryptionMethodType))))
return soap->error = SOAP_EOM;
soap_default_xenc__EncryptionMethodType(soap, security->xenc__EncryptedKey->EncryptionMethod);
/* RSA Version 1.5 or RSA-OAEP */
alg |= (SOAP_MEC_ENV | SOAP_MEC_ENC);
if (alg & SOAP_MEC_OAEP)
{ security->xenc__EncryptedKey->EncryptionMethod->Algorithm = (char*)xenc_rsaesURI;
security->xenc__EncryptedKey->EncryptionMethod->OAEPparams = NULL;
if (!(security->xenc__EncryptedKey->EncryptionMethod->ds__DigestMethod = (struct ds__DigestMethodType*)soap_malloc(soap, sizeof(struct ds__DigestMethodType))))
return soap->error = SOAP_EOM;
soap_default_ds__DigestMethodType(soap, security->xenc__EncryptedKey->EncryptionMethod->ds__DigestMethod);
security->xenc__EncryptedKey->EncryptionMethod->ds__DigestMethod->Algorithm = (char*)ds_sha1URI;
}
else
security->xenc__EncryptedKey->EncryptionMethod->Algorithm = (char*)xenc_rsa15URI;
/* KeyInfo */
if (!(security->xenc__EncryptedKey->ds__KeyInfo = (_ds__KeyInfo*)soap_malloc(soap, sizeof(_ds__KeyInfo))))
return soap->error = SOAP_EOM;
soap_default__ds__KeyInfo(soap, security->xenc__EncryptedKey->ds__KeyInfo);
/* allocate SecurityTokenReference */
if (!(security->xenc__EncryptedKey->ds__KeyInfo->wsse__SecurityTokenReference = (_wsse__SecurityTokenReference*)soap_malloc(soap, sizeof(_wsse__SecurityTokenReference))))
return soap->error = SOAP_EOM;
soap_default__wsse__SecurityTokenReference(soap, security->xenc__EncryptedKey->ds__KeyInfo->wsse__SecurityTokenReference);
if (issuer && serial)
{ if (!(security->xenc__EncryptedKey->ds__KeyInfo->wsse__SecurityTokenReference->ds__X509Data = (struct ds__X509DataType*)soap_malloc(soap, sizeof(struct ds__X509DataType))))
return soap->error = SOAP_EOM;
soap_default_ds__X509DataType(soap, security->xenc__EncryptedKey->ds__KeyInfo->wsse__SecurityTokenReference->ds__X509Data);
if (!(security->xenc__EncryptedKey->ds__KeyInfo->wsse__SecurityTokenReference->ds__X509Data->X509IssuerSerial = (struct ds__X509IssuerSerialType*)soap_malloc(soap, sizeof(struct ds__X509IssuerSerialType))))
return soap->error = SOAP_EOM;
soap_default_ds__X509IssuerSerialType(soap, security->xenc__EncryptedKey->ds__KeyInfo->wsse__SecurityTokenReference->ds__X509Data->X509IssuerSerial);
security->xenc__EncryptedKey->ds__KeyInfo->wsse__SecurityTokenReference->ds__X509Data->X509IssuerSerial->X509IssuerName = soap_strdup(soap, issuer);
security->xenc__EncryptedKey->ds__KeyInfo->wsse__SecurityTokenReference->ds__X509Data->X509IssuerSerial->X509SerialNumber = soap_strdup(soap, serial);
}
else
{ /* allocate KeyIdentifier */
if (!(security->xenc__EncryptedKey->ds__KeyInfo->wsse__SecurityTokenReference->KeyIdentifier = (_wsse__KeyIdentifier*)soap_malloc(soap, sizeof(_wsse__KeyIdentifier))))
return soap->error = SOAP_EOM;
soap_default__wsse__KeyIdentifier(soap, security->xenc__EncryptedKey->ds__KeyInfo->wsse__SecurityTokenReference->KeyIdentifier);
/* populate KeyIdentifier */
security->xenc__EncryptedKey->ds__KeyInfo->wsse__SecurityTokenReference->KeyIdentifier->EncodingType = (char*)wsse_Base64BinaryURI;
if (subjectkeyid)
{ security->xenc__EncryptedKey->ds__KeyInfo->wsse__SecurityTokenReference->KeyIdentifier->ValueType = (char*)wsse_X509v3SubjectKeyIdentifierURI;
security->xenc__EncryptedKey->ds__KeyInfo->wsse__SecurityTokenReference->KeyIdentifier->__item = soap_s2base64(soap, (unsigned char*)subjectkeyid, NULL, strlen(subjectkeyid));
}
else if (cert)
{ unsigned char *der, *s;
int derlen;
security->xenc__EncryptedKey->ds__KeyInfo->wsse__SecurityTokenReference->KeyIdentifier->ValueType = (char*)wsse_X509v3URI;
/* determine the storage requirement */
derlen = i2d_X509(cert, NULL);
if (derlen < 0)
return soap_wsse_fault(soap, wsse__InvalidSecurityToken, "Invalid certificate passed to soap_wsse_add_EncryptedKey_encrypt_only");
/* use the gSOAP engine's look-aside buffer to temporarily hold the cert */
if (soap_store_lab(soap, NULL, derlen))
return SOAP_EOM;
s = der = (unsigned char*)soap->labbuf;
/* store in DER format */
i2d_X509(cert, &s);
security->xenc__EncryptedKey->ds__KeyInfo->wsse__SecurityTokenReference->KeyIdentifier->__item = soap_s2base64(soap, der, NULL, derlen);
}
}
/* CipherData */
if (!(security->xenc__EncryptedKey->CipherData = (xenc__CipherDataType*)soap_malloc(soap, sizeof(struct xenc__CipherDataType))))
return soap->error = SOAP_EOM;
soap_default_xenc__CipherDataType(soap, security->xenc__EncryptedKey->CipherData);
/* get the public key */
pubk = X509_get_pubkey(cert);
if (!pubk)
return soap_wsse_fault(soap, wsse__InvalidSecurityToken, "Invalid certificate passed to soap_wsse_add_EncryptedKey_encrypt_only");
/* start encryption engine, get the encrypted secret key */
key = (unsigned char*)soap_malloc(soap, soap_mec_size(alg, pubk));
if (data->mec)
soap_mec_cleanup(soap, data->mec);
else
data->mec = (struct soap_mec_data*)SOAP_MALLOC(soap, sizeof(struct soap_mec_data));
if (soap_mec_begin(soap, data->mec, alg, pubk, key, &keylen))
{ EVP_PKEY_free(pubk);
return soap->error;
}
EVP_PKEY_free(pubk);
data->enco_alg = alg;
data->enco_keyname = NULL;
data->enco_key = key;
data->enco_keylen = keylen;
if (!(security->xenc__EncryptedKey->CipherData->CipherValue = soap_s2base64(soap, key, NULL, keylen)))
return soap->error = SOAP_EOM;
data->encid = soap_strdup(soap, tags);
if (!tags)
{ soap->omode |= SOAP_SEC_WSUID;
if (soap_wsse_add_EncryptedKey_DataReferenceURI(soap, "#Body"))
return soap->error;
}
else
{ char *s, *t;
/* make space to insert # to each id converted from a tag name */
t = (char*)soap_malloc(soap, strlen(tags) + 2);
if (!t)
return soap->error = SOAP_EOM;
*t = '#';
strcpy(t + 1, tags);
s = soap_wsse_ids(soap, t);
if (!s)
return soap->error = SOAP_EOM;
s++;
do
{ t = strchr(s, ' ');
if (t)
{ *t = '\0';
while (*++t == ' ')
;
}
*--s = '#';
if (soap_wsse_add_EncryptedKey_DataReferenceURI(soap, s))
return soap->error;
s = t;
} while (s);
}
soap->feltbegout = soap_wsse_element_begin_out;
soap->feltendout = soap_wsse_element_end_out;
return SOAP_OK;
}
/**
@fn int soap_wsse_verify_EncryptedKey(struct soap *soap)
@brief Verifies the EncryptedKey header information (certificate validity
requires soap->cacert to be set). Retrieves the decryption key from the token
handler callback to decrypt the decryption key.
@param soap context
@return SOAP_OK or error code
*/
int
soap_wsse_verify_EncryptedKey(struct soap *soap)
{ _wsse__Security *security = soap_wsse_Security(soap);
struct soap_wsse_data *data = (struct soap_wsse_data*)soap_lookup_plugin(soap, soap_wsse_id);
DBGFUN("soap_wsse_verify_EncryptedKey");
if (!data)
return soap_set_receiver_error(soap, "soap_wsse_verify_EncryptedKey", "Plugin not registered", SOAP_PLUGIN_ERROR);
/* if we have a xenc:EncryptedKey, check it and start envelope decryption */
if (security && security->xenc__EncryptedKey)
{ if (!security->xenc__EncryptedKey->EncryptionMethod
|| !security->xenc__EncryptedKey->EncryptionMethod->Algorithm)
return soap_wsse_fault(soap, wsse__InvalidSecurity, "Invalid Encryption algorithm or key");
/* verify encrypted key */
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Verify EncryptedKey alg=%x\n", data->deco_alg));
if (security->xenc__EncryptedKey->ds__KeyInfo)
{ int keylen;
if (security->xenc__EncryptedKey->ds__KeyInfo->wsse__SecurityTokenReference
&& security->xenc__EncryptedKey->ds__KeyInfo->wsse__SecurityTokenReference->KeyIdentifier
&& security->xenc__EncryptedKey->ds__KeyInfo->wsse__SecurityTokenReference->KeyIdentifier->ValueType
&& security->xenc__EncryptedKey->ds__KeyInfo->wsse__SecurityTokenReference->KeyIdentifier->__item)
{ if (!strcmp(security->xenc__EncryptedKey->ds__KeyInfo->wsse__SecurityTokenReference->KeyIdentifier->ValueType, wsse_X509v3URI))
{ X509 *cert = NULL;
const unsigned char *der;
int derlen;
der = (unsigned char*)soap_base642s(soap, security->xenc__EncryptedKey->ds__KeyInfo->wsse__SecurityTokenReference->KeyIdentifier->__item, NULL, 0, &derlen);
if (!der)
return soap_wsse_fault(soap, wsse__InvalidSecurity, "Invalid Encryption algorithm or key");
cert = d2i_X509(&cert, &der, derlen);
if (soap_wsse_verify_X509(soap, cert))
{ if (cert)
X509_free(cert);
return soap->error;
}
/* get the private key from subject name of cert, if not set */
if (!data->deco_key && data->security_token_handler)
{ char buf[1024];
data->deco_alg = SOAP_MEC_ENV_DEC_DES_CBC;
data->deco_key = data->security_token_handler(soap, &data->deco_alg, X509_NAME_oneline(X509_get_subject_name(cert), buf, sizeof(buf)), &keylen);
data->deco_keylen = 0;
}
if (cert)
X509_free(cert);
}
else if (!data->deco_key && data->security_token_handler && !strcmp(security->xenc__EncryptedKey->ds__KeyInfo->wsse__SecurityTokenReference->KeyIdentifier->ValueType, wsse_X509v3SubjectKeyIdentifierURI))
{ int subjectkeyidlen;
const char *subjectkeyid = (char*)soap_base642s(soap, security->xenc__EncryptedKey->ds__KeyInfo->wsse__SecurityTokenReference->KeyIdentifier->__item, NULL, 0, &subjectkeyidlen);
/* get the private key from subject key id */
data->deco_alg = SOAP_MEC_ENV_DEC_DES_CBC;
data->deco_key = data->security_token_handler(soap, &data->deco_alg, subjectkeyid, &keylen);
data->deco_keylen = 0;
}
}
else if (!data->deco_key && data->security_token_handler)
{ const char *name = NULL;
/* get the private key from key name or subject name */
if (security->xenc__EncryptedKey->ds__KeyInfo->KeyName)
name = security->xenc__EncryptedKey->ds__KeyInfo->KeyName;
else if (security->xenc__EncryptedKey->ds__KeyInfo->X509Data && security->xenc__EncryptedKey->ds__KeyInfo->X509Data->X509SubjectName)
name = security->xenc__EncryptedKey->ds__KeyInfo->X509Data->X509SubjectName;
if (name)
{ data->deco_alg = SOAP_MEC_ENV_DEC_DES_CBC;
data->deco_key = data->security_token_handler(soap, &data->deco_alg, name, &keylen);
data->deco_keylen = 0;
}
}
}
/* start decryption */
if (data->deco_key && security->xenc__EncryptedKey->CipherData && security->xenc__EncryptedKey->CipherData->CipherValue)
{ int keylen;
unsigned char *key = (unsigned char*)soap_base642s(soap, security->xenc__EncryptedKey->CipherData->CipherValue, NULL, 0, &keylen);
if (!strcmp(security->xenc__EncryptedKey->EncryptionMethod->Algorithm, xenc_rsaesURI))
data->deco_alg |= SOAP_MEC_OAEP;
else if (strcmp(security->xenc__EncryptedKey->EncryptionMethod->Algorithm, xenc_rsa15URI))
return soap_wsse_fault(soap, wsse__InvalidSecurity, "Invalid Encryption algorithm or key");
if (data->mec)
soap_mec_cleanup(soap, data->mec);
else
data->mec = (struct soap_mec_data*)SOAP_MALLOC(soap, sizeof(struct soap_mec_data));
if (soap_mec_begin(soap, data->mec, data->deco_alg, (SOAP_MEC_KEY_TYPE*)data->deco_key, key, &keylen))
return soap_wsse_fault(soap, wsse__FailedCheck, NULL);
}
/* do not process EncryptedKey again */
security->xenc__EncryptedKey = NULL;
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Verified EncryptedKey alg=%x\n", data->deco_alg));
}
return SOAP_OK;
}
/**
@fn void soap_wsse_delete_EncryptedKey(struct soap *soap)
@brief Deletes EncryptedKey header element.
@param soap context
*/
void
soap_wsse_delete_EncryptedKey(struct soap *soap)
{ _wsse__Security *security = soap_wsse_Security(soap);
DBGFUN("soap_wsse_delete_EncryptedKey");
if (security)
security->xenc__EncryptedKey = NULL;
}
/**
@fn xenc__EncryptedKeyType* soap_wsse_EncryptedKey(struct soap *soap)
@brief Returns EncryptedKey header element if present.
@param soap context
@return xenc__EncryptedKeyType object or NULL
*/
struct xenc__EncryptedKeyType*
soap_wsse_EncryptedKey(struct soap *soap)
{ _wsse__Security *security = soap_wsse_Security(soap);
if (security)
return security->xenc__EncryptedKey;
return NULL;
}
/******************************************************************************\
*
* wsse:Security/xenc:EncryptedKey/ReferenceList/DataReference
*
\******************************************************************************/
/**
@fn int soap_wsse_add_EncryptedKey_DataReferenceURI(struct soap *soap, const char *URI)
@brief Adds a DataReference URI to the EncryptedKey header element.
@param soap context
@param[in] URI value of the URI ID
@return SOAP_OK or error code
*/
int
soap_wsse_add_EncryptedKey_DataReferenceURI(struct soap *soap, const char *URI)
{ _wsse__Security *security = soap_wsse_add_Security(soap);
_xenc__ReferenceList *ref;
int k, n = 0;
DBGFUN1("soap_wsse_add_EncryptedKey_DataReferenceURI", "URI=%s", URI?URI:"");
if (!security->xenc__EncryptedKey)
{ if (!(security->xenc__EncryptedKey = (xenc__EncryptedKeyType*)soap_malloc(soap, sizeof(xenc__EncryptedKeyType))))
return soap->error = SOAP_EOM;
soap_default_xenc__EncryptedKeyType(soap, security->xenc__EncryptedKey);
}
if (!security->xenc__EncryptedKey->ReferenceList)
{ if (!(security->xenc__EncryptedKey->ReferenceList = (struct _xenc__ReferenceList*)soap_malloc(soap, sizeof(struct _xenc__ReferenceList))))
return soap->error = SOAP_EOM;
soap_default__xenc__ReferenceList(soap, security->xenc__EncryptedKey->ReferenceList);
}
ref = security->xenc__EncryptedKey->ReferenceList;
k = ref->__size_ReferenceList++;
/* need to increase space? */
if (k < 0)
return soap->error = SOAP_EOM;
if (k == 0)
n = 1;
else if (k >= 1 && (k & (k - 1)) == 0)
n = 2 * k;
/* yes we do */
if (n)
{ struct __xenc__union_ReferenceList *tmp = (struct __xenc__union_ReferenceList*)soap_malloc(soap, n * sizeof(struct __xenc__union_ReferenceList));
int i;
if (!tmp)
return soap->error = SOAP_EOM;
for (i = 0; i < k; i++)
tmp[i] = ref->__union_ReferenceList[i];
security->xenc__EncryptedKey->ReferenceList->__union_ReferenceList = tmp;
ref = security->xenc__EncryptedKey->ReferenceList;
}
/* add entry */
soap_default___xenc__union_ReferenceList(soap, &ref->__union_ReferenceList[k]);
if (!(ref->__union_ReferenceList[k].DataReference = (struct xenc__ReferenceType*)soap_malloc(soap, sizeof(struct xenc__ReferenceType))))
return soap->error = SOAP_EOM;
soap_default_xenc__ReferenceType(soap, ref->__union_ReferenceList[k].DataReference);
ref->__union_ReferenceList[k].DataReference->URI = soap_strdup(soap, URI);
return SOAP_OK;
}
/**
@fn int soap_wsse_add_DataReferenceURI(struct soap *soap, const char *URI)
@brief Adds a DataReference URI to the WS-Security header element.
@param soap context
@param[in] URI value of the URI ID
@return SOAP_OK or error code
*/
int
soap_wsse_add_DataReferenceURI(struct soap *soap, const char *URI)
{ _wsse__Security *security = soap_wsse_add_Security(soap);
_xenc__ReferenceList *ref;
int k, n = 0;
DBGFUN1("soap_wsse_add_DataReferenceURI", "URI=%s", URI?URI:"");
/* initial alloc */
if (!security->xenc__ReferenceList)
{ if (!(security->xenc__ReferenceList = (struct _xenc__ReferenceList*)soap_malloc(soap, sizeof(struct _xenc__ReferenceList))))
return soap->error = SOAP_EOM;
soap_default__xenc__ReferenceList(soap, security->xenc__ReferenceList);
}
ref = security->xenc__ReferenceList;
k = ref->__size_ReferenceList++;
/* need to increase space? */
if (k < 0)
return soap->error = SOAP_EOM;
if (k == 0)
n = 1;
else if (k >= 1 && (k & (k - 1)) == 0)
n = 2 * k;
/* yes we do */
if (n)
{ struct __xenc__union_ReferenceList *tmp = (struct __xenc__union_ReferenceList*)soap_malloc(soap, n * sizeof(struct __xenc__union_ReferenceList));
int i;
if (!tmp)
return soap->error = SOAP_EOM;
for (i = 0; i < k; i++)
tmp[i] = ref->__union_ReferenceList[i];
security->xenc__ReferenceList->__union_ReferenceList = tmp;
ref = security->xenc__ReferenceList;
}
/* add entry */
soap_default___xenc__union_ReferenceList(soap, &ref->__union_ReferenceList[k]);
if (!(ref->__union_ReferenceList[k].DataReference = (struct xenc__ReferenceType*)soap_malloc(soap, sizeof(struct xenc__ReferenceType))))
return soap->error = SOAP_EOM;
soap_default_xenc__ReferenceType(soap, ref->__union_ReferenceList[k].DataReference);
ref->__union_ReferenceList[k].DataReference->URI = soap_strdup(soap, URI);
return SOAP_OK;
}
/******************************************************************************\
*
* xenc:EncryptedData
*
\******************************************************************************/
/**
@fn int soap_wsse_add_EncryptedData_KeyInfo_KeyName(struct soap *soap, const char *keyname)
@brief Adds EncryptedData/ds:KeyInfo/Keyname elements.
@param soap context
@param[in] keyname name of the key
@return SOAP_OK or error code
This function adds the name of the key to each EncryptedData element to
identify the shared secret key used for encryption.
*/
int
soap_wsse_add_EncryptedData_KeyInfo_KeyName(struct soap *soap, const char *keyname)
{ struct soap_wsse_data *data = (struct soap_wsse_data*)soap_lookup_plugin(soap, soap_wsse_id);
DBGFUN("soap_wsse_add_EncryptedData_KeyInfo_KeyName");
if (!data)
return soap_set_receiver_error(soap, "soap_wsse_add_EncryptedData_KeyInfo_KeyName", "Plugin not registered", SOAP_PLUGIN_ERROR);
data->enco_keyname = soap_strdup(soap, keyname);
return SOAP_OK;
}
/******************************************************************************\
*
* Faults
*
\******************************************************************************/
/**
@fn int soap_wsse_sender_fault_subcode(struct soap *soap, const char *faultsubcode, const char *faultstring, const char *faultdetail)
@brief Sets sender SOAP Fault (sub)code for server fault response.
@param soap context
@param[in] faultsubcode sub code string
@param[in] faultstring fault string
@param[in] faultdetail detail string
@return SOAP_FAULT
*/
int
soap_wsse_sender_fault_subcode(struct soap *soap, const char *faultsubcode, const char *faultstring, const char *faultdetail)
{
#if defined(SOAP_WSA_2003) || defined(SOAP_WSA_2004) || defined(SOAP_WSA_200408) || defined(SOAP_WSA_2005)
return soap_wsa_sender_fault_subcode(soap, faultsubcode, faultstring, faultdetail);
#else
return soap_sender_fault_subcode(soap, faultsubcode, faultstring, faultdetail);
#endif
}
/**
@fn int soap_wsse_receiver_fault_subcode(struct soap *soap, const char *faultsubcode, const char *faultstring, const char *faultdetail)
@brief Sets receiver SOAP Fault (sub)code for server fault response.
@param soap context
@param[in] faultsubcode sub code string
@param[in] faultstring fault string
@param[in] faultdetail detail string
@return SOAP_FAULT
*/
int
soap_wsse_receiver_fault_subcode(struct soap *soap, const char *faultsubcode, const char *faultstring, const char *faultdetail)
{
#if defined(SOAP_WSA_2003) || defined(SOAP_WSA_2004) || defined(SOAP_WSA_200408) || defined(SOAP_WSA_2005)
return soap_wsa_receiver_fault_subcode(soap, faultsubcode, faultstring, faultdetail);
#else
return soap_receiver_fault_subcode(soap, faultsubcode, faultstring, faultdetail);
#endif
}
/**
@fn int soap_wsse_sender_fault(struct soap *soap, const char *faultstring, const char *faultdetail)
@brief Sets sender SOAP Fault for server fault response.
@param soap context
@param[in] faultstring fault string
@param[in] faultdetail detail string
@return SOAP_FAULT
*/
int
soap_wsse_sender_fault(struct soap *soap, const char *faultstring, const char *faultdetail)
{ return soap_wsse_sender_fault_subcode(soap, NULL, faultstring, faultdetail);
}
/**
@fn int soap_wsse_receiver_fault(struct soap *soap, const char *faultstring, const char *faultdetail)
@brief Sets receiver SOAP Fault for server fault response.
@param soap context
@param[in] faultstring fault string
@param[in] faultdetail detail string
@return SOAP_FAULT
*/
int
soap_wsse_receiver_fault(struct soap *soap, const char *faultstring, const char *faultdetail)
{ return soap_wsse_receiver_fault_subcode(soap, NULL, faultstring, faultdetail);
}
/**
@fn int soap_wsse_fault(struct soap *soap, wsse__FaultcodeEnum fault, const char *detail)
@brief Sets SOAP Fault (sub)code for server response.
@param soap context
@param[in] fault is one of wsse:FaultcodeEnum
@param[in] detail string with optional text message
@return SOAP_FAULT
*/
int
soap_wsse_fault(struct soap *soap, wsse__FaultcodeEnum fault, const char *detail)
{ const char *code = soap_wsse__FaultcodeEnum2s(soap, fault);
DBGFUN2("soap_wsse_fault", "fault=%s", code?code:"", "detail=%s", detail?detail:"");
/* remove incorrect or incomplete Security header */
soap_wsse_delete_Security(soap);
/* populate the SOAP Fault as per WS-Security spec */
/* detail = NULL; */ /* uncomment when detail text not recommended */
/* use WSA to populate the SOAP Header when WSA is used */
switch (fault)
{ case wsse__UnsupportedSecurityToken:
return soap_wsse_sender_fault_subcode(soap, code, "An unsupported token was provided", detail);
case wsse__UnsupportedAlgorithm:
return soap_wsse_sender_fault_subcode(soap, code, "An unsupported signature or encryption algorithm was used", detail);
case wsse__InvalidSecurity:
return soap_wsse_sender_fault_subcode(soap, code, "An error was discovered processing the <wsse:Security> header", detail);
case wsse__InvalidSecurityToken:
return soap_wsse_sender_fault_subcode(soap, code, "An invalid security token was provided", detail);
case wsse__FailedAuthentication:
return soap_wsse_sender_fault_subcode(soap, code, "The security token could not be authenticated or authorized", detail);
case wsse__FailedCheck:
return soap_wsse_sender_fault_subcode(soap, code, "The signature or decryption was invalid", detail);
case wsse__SecurityTokenUnavailable:
return soap_wsse_sender_fault_subcode(soap, code, "Referenced security token could not be retrieved", detail);
}
return SOAP_FAULT;
}
/******************************************************************************\
*
* Digest authentication session management
*
\******************************************************************************/
/**
@fn static int soap_wsse_session_verify(struct soap *soap, const char hash[SOAP_SMD_SHA1_SIZE], const char *created, const char *nonce)
@brief Verifies and updates the digest, nonce, and creation time against the digest authentication session database to prevent replay attacks.
@param soap context
@param[in] hash binary digest value of PasswordDigest
@param[in] created string
@param[in] nonce string (base64)
@return SOAP_OK or SOAP_FAULT
*/
static int
soap_wsse_session_verify(struct soap *soap, const char hash[SOAP_SMD_SHA1_SIZE], const char *created, const char *nonce)
{ struct soap_wsse_session *session;
time_t expired, now = time(NULL);
DBGFUN("soap_wsse_session_verify");
soap_s2dateTime(soap, created, &expired);
/* creation time in the future? */
if (expired > now + SOAP_WSSE_CLKSKEW)
return soap_wsse_fault(soap, wsse__FailedAuthentication, "Authorization request in future");
expired += SOAP_WSSE_NONCETIME;
/* expired? */
if (expired <= now)
return soap_wsse_fault(soap, wsse__FailedAuthentication, "Authentication expired");
/* purge expired messages, but don't do this all the time to improve efficiency */
if (now % 10 == 0)
soap_wsse_session_cleanup(soap);
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Verifying session nonce=%s\n", nonce));
/* enter mutex to check and update session */
MUTEX_LOCK(soap_wsse_session_lock);
for (session = soap_wsse_session; session; session = session->next)
{ if (!memcmp(session->hash, hash, SOAP_SMD_SHA1_SIZE) && !strcmp(session->nonce, nonce))
break;
}
/* if not found, allocate new session data */
if (!session)
{ session = (struct soap_wsse_session*)malloc(sizeof(struct soap_wsse_session) + strlen(nonce));
if (session)
{ session->next = soap_wsse_session;
session->expired = expired;
memcpy(session->hash, hash, SOAP_SMD_SHA1_SIZE);
strcpy(session->nonce, nonce);
soap_wsse_session = session;
}
session = NULL;
}
/* exit mutex */
MUTEX_UNLOCK(soap_wsse_session_lock);
/* if replay attack, return non-descript failure */
if (session)
return soap_wsse_fault(soap, wsse__FailedAuthentication, NULL);
return SOAP_OK;
}
/**
@fn static void soap_wsse_session_cleanup(struct soap *soap)
@brief Removes expired authentication data from the digest authentication session database.
@param soap context
*/
static void
soap_wsse_session_cleanup(struct soap *soap)
{ struct soap_wsse_session **session;
time_t now = time(NULL);
DBGFUN("soap_wsse_session_cleanup");
/* enter mutex to purge expired session data */
MUTEX_LOCK(soap_wsse_session_lock);
session = &soap_wsse_session;
while (*session)
{ if ((*session)->expired < now)
{ struct soap_wsse_session *p = *session;
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Deleting session nonce=%s\n", p->nonce));
*session = p->next;
free(p);
}
else
session = &(*session)->next;
}
/* exit mutex */
MUTEX_UNLOCK(soap_wsse_session_lock);
}
/******************************************************************************\
*
* Calculate SHA1(created, nonce, password) digest
*
\******************************************************************************/
/**
@fn static void calc_digest(struct soap *soap, const char *created, const char *nonce, int noncelen, const char *password, char hash[SOAP_SMD_SHA1_SIZE])
@brief Calculates digest value SHA1(created, nonce, password)
@param soap context
@param[in] created string (XSD dateTime format)
@param[in] nonce value
@param[in] noncelen length of nonce value
@param[in] password string
@param[out] hash SHA1 digest
*/
static void
calc_digest(struct soap *soap, const char *created, const char *nonce, int noncelen, const char *password, char hash[SOAP_SMD_SHA1_SIZE])
{ struct soap_smd_data context;
/* use smdevp engine */
soap_smd_init(soap, &context, SOAP_SMD_DGST_SHA1, NULL, 0);
soap_smd_update(soap, &context, nonce, noncelen);
soap_smd_update(soap, &context, created, strlen(created));
soap_smd_update(soap, &context, password, strlen(password));
soap_smd_final(soap, &context, hash, NULL);
}
/******************************************************************************\
*
* Calculate randomized hex nonce
*
\******************************************************************************/
/**
@fn static void calc_nonce(struct soap *soap, char nonce[SOAP_WSSE_NONCELEN])
@brief Calculates randomized nonce (also uses time() in case a poorly seeded PRNG is used)
@param soap context
@param[out] nonce value
*/
static void
calc_nonce(struct soap *soap, char nonce[SOAP_WSSE_NONCELEN])
{ int i;
time_t r = time(NULL);
memcpy(nonce, &r, 4);
for (i = 4; i < SOAP_WSSE_NONCELEN; i += 4)
{ r = soap_random;
memcpy(nonce + i, &r, 4);
}
}
/******************************************************************************\
*
* Plugin registry functions
*
\******************************************************************************/
/**
@fn int soap_wsse(struct soap *soap, struct soap_plugin *p, void *arg)
@brief Plugin registry function, used with soap_register_plugin.
@param soap context
@param[in,out] p plugin created in registry
@param[in] arg passed from soap_register_plugin_arg is an optional security token handler callback
@return SOAP_OK
*/
int
soap_wsse(struct soap *soap, struct soap_plugin *p, void *arg)
{ static int done = 0;
DBGFUN("soap_wsse");
p->id = soap_wsse_id;
p->data = (void*)SOAP_MALLOC(soap, sizeof(struct soap_wsse_data));
p->fcopy = soap_wsse_copy;
p->fdelete = soap_wsse_delete;
if (p->data)
{ if (soap_wsse_init(soap, (struct soap_wsse_data*)p->data, (const void *(*)(struct soap*, int*, const char*, int*))arg))
{ SOAP_FREE(soap, p->data);
return SOAP_EOM;
}
}
if (!done)
{
#if 0
#ifdef WIN32
/* now uses CreateMutex() for static lock initialization */
static volatile long spinlock = 0;
DWORD s = 0;
/* Initialize soap_wsse_session_lock with a spinlock */
while (InterlockedExchange(&spinlock, 1) == 1)
{ Sleep(s);
s = !s;
}
if (!done)
MUTEX_SETUP(soap_wsse_session_lock);
done = 1;
spinlock = 0;
#else
done = 1;
#endif
#endif
#ifdef WITH_OPENSSL
/* moved to stdsoap2.c
MUTEX_LOCK(soap_wsse_session_lock);
OpenSSL_add_all_digests();
OpenSSL_add_all_algorithms();
MUTEX_UNLOCK(soap_wsse_session_lock);
*/
#endif
}
return SOAP_OK;
}
/**
@fn int soap_wsse_init(struct soap *soap, struct soap_wsse_data *data, const void *(*arg)(struct soap*, int*, const char*, int*))
@brief Initializes plugin data.
@param soap context
@param[in,out] data plugin data
@param arg security token handler callback
@return SOAP_OK
*/
static int
soap_wsse_init(struct soap *soap, struct soap_wsse_data *data, const void *(*arg)(struct soap*, int *alg, const char *keyname, int *keylen))
{ DBGFUN("soap_wsse_init");
data->sigid = NULL;
data->encid = NULL;
data->sign_alg = SOAP_SMD_NONE;
data->sign_key = NULL;
data->sign_keylen = 0;
data->vrfy_alg = SOAP_SMD_NONE;
data->vrfy_key = NULL;
data->vrfy_keylen = 0;
data->enco_alg = SOAP_MEC_NONE;
data->enco_keyname = NULL;
data->enco_key = NULL;
data->enco_keylen = 0;
data->deco_alg = SOAP_MEC_NONE;
data->deco_key = NULL;
data->deco_keylen = 0;
data->digest = NULL;
data->fpreparesend = NULL;
data->fpreparefinalsend = NULL;
data->fpreparefinalrecv = NULL;
data->fheader = soap->fheader;
soap->fheader = soap_wsse_header;
data->mec = NULL;
data->store = NULL;
data->security_token_handler = arg;
soap->feltbegin = soap_wsse_element_begin_in;
soap->feltendin = soap_wsse_element_end_in;
return SOAP_OK;
}
/**
@fn int soap_wsse_copy(struct soap *soap, struct soap_plugin *dst, struct soap_plugin *src)
@brief Copies plugin data to localize plugin data for threads.
@param soap context
@param[out] dst target plugin
@param[in] src source plugin
@return SOAP_OK
*/
static int
soap_wsse_copy(struct soap *soap, struct soap_plugin *dst, struct soap_plugin *src)
{ DBGFUN("soap_wsse_copy");
*dst = *src;
dst->data = (void*)SOAP_MALLOC(soap, sizeof(struct soap_wsse_data));
soap_wsse_init(soap, (struct soap_wsse_data*)dst->data, ((struct soap_wsse_data*)src->data)->security_token_handler);
return SOAP_OK;
}
/**
@fn void soap_wsse_delete(struct soap *soap, struct soap_plugin *p)
@brief Deletes plugin data.
@param soap context
@param[in,out] p plugin
@return SOAP_OK
*/
static void
soap_wsse_delete(struct soap *soap, struct soap_plugin *p)
{ struct soap_wsse_data *data = (struct soap_wsse_data*)soap_lookup_plugin(soap, soap_wsse_id);
DBGFUN("soap_wsse_delete");
if (data)
{ soap_wsse_preparecleanup(soap, data);
if (data->mec)
{ soap_mec_cleanup(soap, data->mec);
SOAP_FREE(soap, data->mec);
data->mec = NULL;
}
if (data->store)
{ X509_STORE_free(data->store);
data->store = NULL;
}
SOAP_FREE(soap, data);
}
}
/******************************************************************************\
*
* Plugin-specific functions
*
\******************************************************************************/
/**
@fn int soap_wsse_set_wsu_id(struct soap *soap, const char *tags)
@brief Sets the elements that are to be extended with wsu:Id attributes. The
wsu:Id attribute values are set to the string value of the tag's QName by
replacing colons with hyphens to produce an xsd:ID value.
@param soap context
@param[in] tags string of space-separated qualified and unqualified element tag names
@return SOAP_OK
*/
int
soap_wsse_set_wsu_id(struct soap *soap, const char *tags)
{ DBGFUN1("soap_wsse_set_wsu_id", "tags=%s", tags?tags:"(null)");
soap->wsuid = soap_strdup(soap, tags);
return SOAP_OK;
}
/**
@fn int soap_wsse_sign_only(struct soap *soap, const char *tags)
@brief Filters only the specified wsu:Id names for signing. Can be used with soap_wsse_set_wsu_id() and if so should use the element tag names.
@param soap context
@param[in] tags string of space-separated qualified and unqualified tag names
@return SOAP_OK
*/
int
soap_wsse_sign_only(struct soap *soap, const char *tags)
{ struct soap_wsse_data *data = (struct soap_wsse_data*)soap_lookup_plugin(soap, soap_wsse_id);
DBGFUN1("soap_wsse_sign_only", "tags=%s", tags?tags:"(null)");
if (data)
data->sigid = soap_wsse_ids(soap, tags);
return SOAP_OK;
}
/**
@fn static char* soap_wsse_ids(struct soap *soap, const char *tags)
@brief converts tag name(s) to id name(s)
@param soap context
@param[in] tags string of space-separated (un)qualified tag names
@return string of ids
*/
static char*
soap_wsse_ids(struct soap *soap, const char *tags)
{ char *s, *t;
s = t = soap_strdup(soap, tags);
while (s && *s)
{ if (*s == ':')
*s = '-';
s++;
}
return t;
}
/**
@fn int soap_wsse_sign(struct soap *soap, int alg, const void *key, int keylen)
@brief Uses the wsse plugin to sign all wsu:Id attributed elements.
@param soap context
@param[in] alg is the signature algorithm, such as SOAP_SMD_HMAC_SHA1, SOAP_SMD_SIGN_DSA_SHA1, or SOAP_SMD_SIGN_RSA_SHA1
@param[in] key is the HMAC secret key or DSA/RSA private EVP_PKEY
@param[in] keylen is the HMAC key length
@return SOAP_OK or fault
This function does not actually sign the message, but initiates the plugin's
signature algorithm to sign the message upon message transfer.
*/
int
soap_wsse_sign(struct soap *soap, int alg, const void *key, int keylen)
{ struct soap_wsse_digest *digest, *next;
struct soap_wsse_data *data = (struct soap_wsse_data*)soap_lookup_plugin(soap, soap_wsse_id);
DBGFUN1("soap_wsse_sign", "alg=%x", alg);
if (!data)
return soap_set_receiver_error(soap, "soap_wsse_sign", "Plugin not registered", SOAP_PLUGIN_ERROR);
if (!alg || !key)
return soap_wsse_fault(soap, wsse__InvalidSecurity, "Invalid signature algorithm or key");
/* store alg and key in plugin data */
data->sign_alg = alg;
data->sign_key = key;
data->sign_keylen = keylen;
/* save and set the plugin's callbacks to preprocess outbound messages */
if (soap->fpreparesend != soap_wsse_preparesend)
{ data->fpreparesend = soap->fpreparesend;
data->fpreparefinalsend = soap->fpreparefinalsend;
}
if (soap->fpreparefinalsend != soap_wsse_preparefinalsend)
{ soap->fpreparesend = soap_wsse_preparesend;
soap->fpreparefinalsend = soap_wsse_preparefinalsend;
}
/* support HTTP compression only with HTTP chunking to allow signing XML */
if ((soap->omode & SOAP_ENC_ZLIB))
soap->omode = (soap->omode & ~SOAP_IO) | SOAP_IO_CHUNK;
else if ((soap->omode & SOAP_IO) == SOAP_IO_STORE) /* no store buffering */
soap->omode = (soap->omode & ~SOAP_IO) | SOAP_IO_BUFFER;
/* cleanup the digest data */
for (digest = data->digest; digest; digest = next)
{ next = digest->next;
SOAP_FREE(soap, digest);
}
data->digest = NULL;
return SOAP_OK;
}
/**
@fn int soap_wsse_sign_body(struct soap *soap, int alg, const void *key, int keylen)
@brief Uses the wsse plugin to sign all wsu:Id attributed elements, including the SOAP Body (by adding a wsu:Id="Body" attribute).
@param soap context
@param[in] alg is the signature algorithm, such as SOAP_SMD_HMAC_SHA1, SOAP_SMD_SIGN_DSA_SHA1, or SOAP_SMD_SIGN_RSA_SHA1
@param[in] key is the HMAC secret key or DSA/RSA private EVP_PKEY
@param[in] keylen is the HMAC key length
@return SOAP_OK
This function does not actually sign the message, but initiates the plugin's
signature algorithm to sign the message upon message transfer.
*/
int
soap_wsse_sign_body(struct soap *soap, int alg, const void *key, int keylen)
{ DBGFUN1("soap_wsse_sign_body", "alg=%x", alg);
soap_wsse_add_Security(soap);
soap->omode |= SOAP_SEC_WSUID;
return soap_wsse_sign(soap, alg, key, keylen);
}
/**
@fn int soap_wsse_verify_init(struct soap *soap)
@brief Uses the wsse plugin to initiate the verification of the signature and SignedInfo Reference digests.
@param soap context
@return SOAP_OK
This function does not actually verify the message, but initiates the plugin's
data to store the message in a DOM to verify the signature. The signature and
digests in the DOM must be verified manually.
*/
int
soap_wsse_verify_init(struct soap *soap)
{ DBGFUN("soap_wsse_verify_init");
/* deserialize inbound message to DOM */
soap->imode |= SOAP_XML_DOM;
return SOAP_OK;
}
/**
@fn int soap_wsse_verify_auto(struct soap *soap, int alg, const void *key, size_t keylen)
@brief Uses the wsse plugin to initiate the automatic verification of the signature and SignedInfo Reference digests.
@param soap context
@param[in] alg to verify signature if signature has no secret or public key, use SOAP_SMD_NONE to omit
@param[in] key is HMAC key or EVP_PKEY or NULL
@param[in] keylen is HMAC key length or 0
@return SOAP_OK
This function does not actually verify the message, but initiates the plugin's
algorithm to store the message in a DOM to automatically verify the signature
and digests. If the message does not contain a key to verify the signature,
the alg, key, and keylen parameters are used. It is important that the X509
certificate used to verify the signature, which requires soap->cafile and/or
soap->capath to be set.
*/
int
soap_wsse_verify_auto(struct soap *soap, int alg, const void *key, size_t keylen)
{ struct soap_wsse_data *data = (struct soap_wsse_data*)soap_lookup_plugin(soap, soap_wsse_id);
DBGFUN("soap_wsse_verify_auto");
if (!data)
return soap_set_receiver_error(soap, "soap_wsse_verify_auto", "Plugin not registered", SOAP_PLUGIN_ERROR);
data->vrfy_alg = alg;
data->vrfy_key = key;
data->vrfy_keylen = keylen;
if (soap->fpreparefinalrecv != soap_wsse_preparefinalrecv)
{ data->fpreparefinalrecv = soap->fpreparefinalrecv;
soap->fpreparefinalrecv = soap_wsse_preparefinalrecv;
}
return soap_wsse_verify_init(soap);
}
/**
@fn int soap_wsse_verify_done(struct soap *soap)
@brief Terminates the automatic verification of signatures.
@param soap context
@return SOAP_OK
*/
int
soap_wsse_verify_done(struct soap *soap)
{ struct soap_wsse_data *data = (struct soap_wsse_data*)soap_lookup_plugin(soap, soap_wsse_id);
DBGFUN("soap_wsse_verify_done");
if (!data)
return soap_set_receiver_error(soap, "soap_wsse_verify_done", "Plugin not registered", SOAP_PLUGIN_ERROR);
soap->imode &= ~SOAP_XML_DOM;
soap->omode &= ~SOAP_SEC_WSUID;
if (soap->fpreparefinalrecv == soap_wsse_preparefinalrecv)
soap->fpreparefinalrecv = data->fpreparefinalrecv;
return SOAP_OK;
}
/**
@fn size_t soap_wsse_verify_element(struct soap *soap, const char *URI, const char *tag)
@brief Post-checks the presence of signed element(s). Does not verify the
signature of these elements, which is done with @ref soap_wsse_verify_auto.
@param soap context
@param URI namespace of element(s)
@param tag name of element(s)
@return number of matching elements signed.
This function does not actually verify the signature of each element, but
checks whether the elements are signed and thus their integrity is preserved.
Signed element nesting rules are obeyed, so if the matching element is a
descendent of a signed element, it is signed as well. Thus, the verification
process follows nesting rules.
Client should call this function after invocation. Services should call this
function inside a service operation. This function traverses the entire DOM, so
performance is determined by the size of a message.
To check the SOAP Body (either using SOAP 1.1 or 1.2), @ref soap_wsse_verify_element(soap, namespaces[0].ns, "Body"). To check whether the Timestamp was signed (assuming it is present and message expiration checked with @ref soap_wsse_verify_Timestamp), use @ref soap_wsse_verify_element(soap, "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Timestamp").
Note: for future releases XPath queries (or forms of these) will be considered.
*/
size_t
soap_wsse_verify_element(struct soap *soap, const char *URI, const char *tag)
{ ds__SignedInfoType *signedInfo = soap_wsse_SignedInfo(soap);
size_t count = 0;
DBGFUN("soap_wsse_verify_element");
if (signedInfo && soap->dom)
{ struct soap_dom_element *elt;
/* traverse the DOM */
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "SignedInfo and DOM found\n"));
elt = soap->dom;
while (elt)
{ /* find wsu:Id or ds:Id and check for Id in signedInfo */
int ok = 0;
struct soap_dom_attribute *att;
for (att = elt->atts; att; att = att->next)
{ if (att->name
&& att->nstr
&& (!strcmp(att->nstr, wsu_URI) || !strcmp(att->nstr, ds_URI))
&& (!strcmp(att->name, "Id") || !soap_tag_cmp(att->name, "*:Id")))
{ /* Id attribute found, search Id value in ds:Reference/@URI */
int i;
for (i = 0; i < signedInfo->__sizeReference; i++)
{ ds__ReferenceType *reference = signedInfo->Reference[i];
if (reference->URI && *reference->URI == '#' && !strcmp(reference->URI + 1, att->data))
{ ok = 1;
break;
}
}
if (ok)
break;
}
}
/* the current element is signed, count this and the matching nested */
if (ok)
{ count += soap_wsse_verify_nested(soap, elt, URI, tag);
/* go to next sibling or back up */
if (elt->next)
elt = elt->next;
else
{ do elt = elt->prnt;
while (elt && !elt->next);
if (elt)
elt = elt->next;
}
}
else
elt = soap_dom_next_element(elt);
}
}
return count;
}
/**
@fn size_t soap_wsse_verify_nested(struct soap *soap, struct soap_dom_element *dom, const char *URI, const char *tag)
@brief Counts signed matching elements from the dom node and down
@param soap context
@param dom node to check and down
@param URI namespace of element(s)
@param tag name of element(s)
@return number of matching elements.
*/
static size_t
soap_wsse_verify_nested(struct soap *soap, struct soap_dom_element *dom, const char *URI, const char *tag)
{ size_t count = 0;
/* search the DOM node and descendants for matching elements */
struct soap_dom_element *elt = dom;
for (elt = dom; elt && elt != dom->next && elt != dom->prnt; elt = soap_dom_next_element(elt))
{ if (elt->name && ((!elt->nstr && !URI) || (elt->nstr && URI && !strcmp(elt->nstr, URI))))
{ const char *s = strchr(elt->name, ':');
if (s)
s++;
else
s = elt->name;
/* found element? */
if (!strcmp(s, tag))
count++;
}
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Element '%s' (\"%s\":%s) is signed\n", elt->name, elt->nstr, elt->name));
}
return count;
}
/**
@fn int soap_wsse_verify_body(struct soap *soap)
@brief Post-checks the presence of signed SOAP Body. Does not verify the
signature of the Body, which is done with @ref soap_wsse_verify_auto.
@param soap context
@return SOAP_OK (signed) or SOAP_FAULT
This function does not actually verify the signature of the Body. It checks
whether the Body is signed and thus its integrity is preserved. Clients should
call this function after invocation. Services should call this function inside
a service operation. This function traverses the entire DOM, so performance is
determined by the size of a message.
*/
int
soap_wsse_verify_body(struct soap *soap)
{ const char *ns = NULL;
/* Are we using SOAP 1.1 or 1.2? Check first row of namespace table */
if (soap->local_namespaces)
{ if (soap->local_namespaces->out)
ns = soap->local_namespaces->out;
else if (soap->local_namespaces->ns)
ns = soap->local_namespaces->ns;
}
/* We don't know if we're using SOAP 1.1 or 1.2, so assume it is 1.2 */
if (!ns)
ns = "http://www.w3.org/2003/05/soap-envelope";
if (soap_wsse_verify_element(soap, ns, "Body") > 0)
return SOAP_OK;
return soap_wsse_sender_fault(soap, "Message body not signed", NULL);
}
/**
@fn int soap_wsse_encrypt_body(struct soap *soap, int alg, const void *key, int keylen)
@brief Initiates the encryption of the SOAP Body. The algorithm should be
SOAP_MEC_ENC_DES_CBC or one of SOAP_MEC_ENC_AESxxx_CBC for symmetric
encryption. Use soap_wsse_add_EncryptedKey for public key encryption.
@param soap context
@param[in] alg the encryption algorithm, should be SOAP_MEC_ENC_DES_CBC or one
of SOAP_MEC_ENC_AESxxx_CBC
@param[in] key a certificate with public key for encryption, a DES CBC 160-bit key or AES key
@param[in] keylen the symmetric encryption key length, 20 bytes for a DES CBC 160-bit key
@return SOAP_OK or error code
This function initiates the encryption of the SOAP Body using an RSA public key
or a symmetric shared secret key. No WS-Security EncryptedKey header will be
set. Use soap_wsse_add_EncryptedKey instead for public key encryption.
*/
int
soap_wsse_encrypt_body(struct soap *soap, int alg, const void *key, int keylen)
{ struct soap_wsse_data *data;
DBGFUN1("soap_wsse_encrypt_body", "alg=%x", alg);
data = (struct soap_wsse_data*)soap_lookup_plugin(soap, soap_wsse_id);
if (!data)
return soap_set_receiver_error(soap, "soap_wsse_encrypt_body", "Plugin not registered", SOAP_PLUGIN_ERROR);
data->encid = NULL;
soap->omode |= SOAP_SEC_WSUID;
soap_wsse_add_DataReferenceURI(soap, "#Body");
return soap_wsse_encrypt(soap, alg, key, keylen);
}
/**
@fn int soap_wsse_encrypt_only(struct soap *soap, int alg, const void *key, int keylen, const char *tags)
@brief Initiates the encryption of XML elements specified in the tags string.
Should be used in combination with soap_wsse_set_wsu_id to set wsu:Id for given
XML element tags. The algorithm should be SOAP_MEC_ENC_DES_CBC or one of
SOAP_MEC_ENC_AESxxx_CBC for symmetric encryption. Use
soap_wsse_add_EncryptedKey_encrypt_only for public key encryption.
@param soap context
@param[in] alg the encryption algorithm, should be SOAP_MEC_ENC_DES_CBC or one
of SOAP_MEC_ENC_AESxxx_CBC
@param[in] key a certificate with public key for encryption, a DES CBC 160-bit key or AES key
@param[in] keylen the symmetric encryption key length, 20 bytes for a DES CBC 160-bit key
@param[in] tags string of space-separated qualified and unqualified tag names
@return SOAP_OK or error code
This function initiates the encryption using an RSA public key or a symmetric
shared secret key. No WS-Security EncryptedKey header will be set. Use
soap_wsse_add_EncryptedKey instead for public key encryption.
WARNING:
Use @ref soap_wsse_add_EncryptedKey_encrypt_only only in combination with
@ref soap_wsse_set_wsu_id with the tag names of the elements to be encrypted.
OTHERWISE THE GIVEN XML ELEMENTS ARE NOT ENCRYPTED AND WILL BE SENT IN THE
CLEAR.
WARNING:
The elements identified with @ref soap_wsse_set_wsu_id to encrypt MUST occur
EXACTLY ONCE in the SOAP Body.
WARNING:
Encryption/decryption of elements with simple content (CDATA content) IS NOT
SUPPORTED. This means that elements you want to encrypt with this function must
have complex content. That is, only encrypt elements with sub elements or
encrypt the entire SOAP Body.
*/
int
soap_wsse_encrypt_only(struct soap *soap, int alg, const void *key, int keylen, const char *tags)
{ struct soap_wsse_data *data = (struct soap_wsse_data*)soap_lookup_plugin(soap, soap_wsse_id);
DBGFUN2("soap_wsse_encrypt_only", "alg=%x", alg, "tags=%s", tags?tags:"(null)");
if (!data)
return soap_set_receiver_error(soap, "soap_wsse_encrypt_only", "Plugin not registered", SOAP_PLUGIN_ERROR);
data->encid = soap_strdup(soap, tags);
if (tags)
{ char *s, *t;
/* make space to insert # to each id converted from a tag name */
t = (char*)soap_malloc(soap, strlen(tags) + 2);
if (!t)
return soap->error = SOAP_EOM;
*t = '#';
strcpy(t + 1, tags);
s = soap_wsse_ids(soap, t);
if (!s)
return soap->error = SOAP_EOM;
s++;
do
{ t = strchr(s, ' ');
if (t)
*t = '\0';
s--;
*s = '#';
if (soap_wsse_add_DataReferenceURI(soap, s))
return soap->error;
s = t;
while (s && *s == ' ')
s++;
} while (s);
}
return soap_wsse_encrypt(soap, alg, key, keylen);
}
/**
@fn int soap_wsse_encrypt(struct soap *soap, int alg, const void *key, int keylen)
@brief Start encryption. This function is supposed to be used internally only.
The algorithm should be SOAP_MEC_ENC_DES_CBC or one of SOAP_MEC_ENC_AESxxx_CBC
for symmetric encryption. Use soap_wsse_add_EncryptedKey for public key
encryption.
@param soap context
@param[in] alg the encryption algorithm, should be SOAP_MEC_ENC_DES_CBC or one
of SOAP_MEC_ENC_AESxxx_CBC
@param[in] key a certificate with public key for encryption, a DES CBC 160-bit key or AES key
@param[in] keylen the symmetric encryption key length, 20 bytes for a DES CBC 160-bit key
@return SOAP_OK or error code
*/
int
soap_wsse_encrypt(struct soap *soap, int alg, const void *key, int keylen)
{ struct soap_wsse_data *data;
DBGFUN1("soap_wsse_encrypt", "alg=%x", alg);
data = (struct soap_wsse_data*)soap_lookup_plugin(soap, soap_wsse_id);
if (!data)
return soap_set_receiver_error(soap, "soap_wsse_encrypt", "Plugin not registered", SOAP_PLUGIN_ERROR);
if (!alg || !key)
return soap_wsse_fault(soap, wsse__UnsupportedAlgorithm, "An unsupported signature or encryption algorithm was used");
if (alg & SOAP_MEC_ENV)
return soap_wsse_add_EncryptedKey(soap, alg, NULL, (X509*)key, NULL, NULL, NULL);
/* store alg and key in plugin data */
data->enco_alg = (alg | SOAP_MEC_ENC);
data->enco_key = key;
data->enco_keylen = keylen;
if (data->mec)
soap_mec_cleanup(soap, data->mec);
else
data->mec = (struct soap_mec_data*)SOAP_MALLOC(soap, sizeof(struct soap_mec_data));
if (soap_mec_begin(soap, data->mec, alg, NULL, (unsigned char*)key, &keylen))
return soap->error;
soap->feltbegout = soap_wsse_element_begin_out;
soap->feltendout = soap_wsse_element_end_out;
return SOAP_OK;
}
/**
@fn int soap_wsse_decrypt_auto(struct soap *soap, int alg, const void *key, int keylen)
@brief Start automatic decryption when needed using the specified key. This
function should be used just once. The algorithm should be
SOAP_MEC_ENV_DEC_DES_CBC for public key encryption/decryption and
SOAP_MEC_DEC_DES_CBC for symmetric shared secret keys.
@param soap context
@param[in] alg the decryption algorithm,
@param[in] key a persistent decryption key for the algorithm, a private RSA key or a shared symmetric secret key
@param[in] keylen use 0 for public-key encryption/decryption
or the shared secret decryption key length, 20 bytes for a DES CBC 160-bit key
@return SOAP_OK or error code
This function can be called once before multiple messages are received with
WS-Security encrypted content, where only one key is used for encryption
(public key or shared secret key). The default decryption key is set. If
multiple decryption keys should be used, do NOT use this function but set the
security_token_handler callback of the wsse plugin. See @ref wsse_9_2. Use a
NULL key to remove the default decryption key.
*/
int
soap_wsse_decrypt_auto(struct soap *soap, int alg, const void *key, int keylen)
{ struct soap_wsse_data *data = (struct soap_wsse_data*)soap_lookup_plugin(soap, soap_wsse_id);
DBGFUN1("soap_wsse_decrypt_auto", "alg=%x", alg);
if (!data)
return soap_set_receiver_error(soap, "soap_wsse_decrypt_auto", "Plugin not registered", SOAP_PLUGIN_ERROR);
/* store alg and key in plugin data */
data->deco_alg = (alg & ~SOAP_MEC_ENC);
/* TODO add? data->enco_alg = (alg & ~(SOAP_MEC_ENC|SOAP_MEC_ENV)); */
data->deco_key = key;
data->deco_keylen = keylen;
return SOAP_OK;
}
/**
@fn int soap_wsse_encrypt_begin(struct soap *soap, const char *id, int alg, const char *URI, const char *keyname, const unsigned char *key)
@brief Emit XML encryption tags and start encryption of the XML element content.
@param soap context
@param[in] id string for the EncryptedData element Id attribute
@param[in] alg algorithm used, or SOAP_MEC_NONE to ignore
@param[in] URI string for the encrypted element wsu:Id attribute
@param[in] keyname optional subject key name
@param[in] key optional DES/AES key for encryption (to override the current key)
@return SOAP_OK or error code
*/
int
soap_wsse_encrypt_begin(struct soap *soap, const char *id, int alg, const char *URI, const char *keyname, const unsigned char *key)
{ int event;
const char *algURI = NULL;
DBGFUN("soap_wsse_encrypt_begin");
if ((soap->mode & SOAP_IO_LENGTH) && (soap->mode & SOAP_IO) == SOAP_IO_CHUNK)
return SOAP_OK;
/* disable digest */
event = soap->event;
soap->event = 0;
if (soap_set_attr(soap, "Id", id, 1)
|| soap_set_attr(soap, "Type", xenc_contentURI, 1)
|| soap_element(soap, "xenc:EncryptedData", 0, NULL)
|| soap_element_start_end_out(soap, NULL))
return soap->error;
switch (alg & SOAP_MEC_MASK & ~SOAP_MEC_ENV)
{ case SOAP_MEC_ENC_DES_CBC:
algURI = xenc_3desURI;
break;
case SOAP_MEC_ENC_AES128_CBC:
algURI = xenc_aes128URI;
break;
case SOAP_MEC_ENC_AES192_CBC:
algURI = xenc_aes192URI;
break;
case SOAP_MEC_ENC_AES256_CBC:
algURI = xenc_aes256URI;
break;
case SOAP_MEC_ENC_AES512_CBC:
algURI = xenc_aes512URI;
break;
}
if (algURI)
{ if (soap_set_attr(soap, "Algorithm", algURI, 1)
|| soap_element(soap, "xenc:EncryptionMethod", 0, NULL)
|| soap_element_start_end_out(soap, "xenc:EncryptionMethod"))
return soap->error;
}
if (URI)
{ if (soap_element(soap, "ds:KeyInfo", 0, NULL)
|| soap_element_start_end_out(soap, NULL)
|| soap_element(soap, "wsse:SecurityTokenReference", 0, NULL)
|| soap_element_start_end_out(soap, NULL)
|| soap_set_attr(soap, "URI", URI, 1)
|| soap_element(soap, "wsse:Reference", 0, NULL)
|| soap_element_start_end_out(soap, NULL)
|| soap_element_end_out(soap, "wsse:Reference")
|| soap_element_end_out(soap, "wsse:SecurityTokenReference")
|| soap_element_end_out(soap, "ds:KeyInfo"))
return soap->error;
}
else if (keyname)
{ if (soap_element(soap, "ds:KeyInfo", 0, NULL)
|| soap_element_start_end_out(soap, NULL)
|| soap_element(soap, "ds:KeyName", 0, NULL)
|| soap_element_start_end_out(soap, NULL)
|| soap_string_out(soap, keyname, 0)
|| soap_element_end_out(soap, "ds:KeyName")
|| soap_element_end_out(soap, "ds:KeyInfo"))
return soap->error;
}
if (soap_element(soap, "xenc:CipherData", 0, NULL)
|| soap_element_start_end_out(soap, NULL)
|| soap_element(soap, "xenc:CipherValue", 0, NULL)
|| soap_element_start_end_out(soap, NULL))
return soap->error;
/* re-enable digest */
soap->event = event;
/* adjust level, hiding xenc elements */
soap->level -= 3;
return soap_mec_start(soap, key);
}
/**
@fn int soap_wsse_encrypt_end(struct soap *soap)
@brief Emit XML encryption end tags and stop encryption of the XML element content.
@param soap context
@return SOAP_OK or error code
*/
int
soap_wsse_encrypt_end(struct soap *soap)
{ int event;
DBGFUN("soap_wsse_encrypt_end");
if ((soap->mode & SOAP_IO_LENGTH) && (soap->mode & SOAP_IO) == SOAP_IO_CHUNK)
return SOAP_OK;
/* disable digest */
event = soap->event;
soap->event = 0;
/* adjust level, hiding xenc elements */
soap->level += 3;
if (soap_mec_stop(soap)
|| soap_element_end_out(soap, "xenc:CipherValue")
|| soap_element_end_out(soap, "xenc:CipherData")
|| soap_element_end_out(soap, "xenc:EncryptedData"))
return soap->error;
/* re-enable digest */
soap->event = event;
return SOAP_OK;
}
/**
@fn int soap_wsse_decrypt_begin(struct soap *soap, const unsigned char *key)
@brief Check for XML encryption tags and start decryption of the XML element
content. If the KeyInfo element is present, the security_token_handler callback
will be used to obtain a decryption key based on the key name. Otherwise the
current decryption key will be used.
@param soap context
@param[in] key optional triple DES key for decryption (to override the current key)
@return SOAP_OK or error code
*/
int
soap_wsse_decrypt_begin(struct soap *soap, const unsigned char *key)
{ struct soap_wsse_data *data = (struct soap_wsse_data*)soap_lookup_plugin(soap, soap_wsse_id);
struct ds__KeyInfoType info;
struct xenc__EncryptionMethodType meth;
int alg;
int keylen;
DBGFUN("soap_wsse_decrypt_begin");
if (!data)
return soap_set_receiver_error(soap, "soap_wsse_decrypt_begin", "Plugin not registered", SOAP_PLUGIN_ERROR);
if (soap_wsse_verify_EncryptedKey(soap))
return soap->error;
alg = data->deco_alg;
keylen = data->deco_keylen;
if (soap_element_begin_in(soap, "xenc:EncryptedData", 0, NULL))
return soap->error;
/* TODO: use Type attribute */
soap_default_xenc__EncryptionMethodType(soap, &meth);
if (soap_in_xenc__EncryptionMethodType(soap, "xenc:EncryptionMethod", &meth, NULL))
{ if (meth.Algorithm)
{ if (!strcmp(meth.Algorithm, xenc_3desURI))
alg = (alg & (~SOAP_MEC_MASK | SOAP_MEC_ENV)) | SOAP_MEC_DEC_DES_CBC;
else if (!strcmp(meth.Algorithm, xenc_aes128URI))
alg = (alg & (~SOAP_MEC_MASK | SOAP_MEC_ENV)) | SOAP_MEC_DEC_AES128_CBC;
else if (!strcmp(meth.Algorithm, xenc_aes192URI))
alg = (alg & (~SOAP_MEC_MASK | SOAP_MEC_ENV)) | SOAP_MEC_DEC_AES192_CBC;
else if (!strcmp(meth.Algorithm, xenc_aes256URI))
alg = (alg & (~SOAP_MEC_MASK | SOAP_MEC_ENV)) | SOAP_MEC_DEC_AES256_CBC;
else if (!strcmp(meth.Algorithm, xenc_aes512URI))
alg = (alg & (~SOAP_MEC_MASK | SOAP_MEC_ENV)) | SOAP_MEC_DEC_AES512_CBC;
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "EncryptionMethod alg=%x\n", alg));
}
}
if (soap_in_ds__KeyInfoType(soap, "ds:KeyInfo", &info, NULL))
{ if (data->security_token_handler && info.KeyName)
{ /* retrieve key from token handler callback */
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Getting shared secret key '%s' through security_token_handler callback\n", info.KeyName));
key = (const unsigned char*)data->security_token_handler(soap, &alg, info.KeyName, &keylen);
}
}
if (soap_element_begin_in(soap, "xenc:CipherData", 0, NULL)
|| soap_element_begin_in(soap, "xenc:CipherValue", 0, NULL))
return soap->error;
/* if non-envelope decryption and default secret key is set, use it */
if (!(alg & SOAP_MEC_ENV))
{ if (alg != data->deco_alg)
{ if (data->security_token_handler)
{ /* retrieve key from token handler callback */
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Getting shared secret key for alg=%x through security_token_handler callback\n", alg));
data->deco_key = (const unsigned char*)data->security_token_handler(soap, &alg, NULL, &keylen);
}
}
if (!key)
key = (const unsigned char*)data->deco_key;
if (key)
{ if (data->mec)
soap_mec_cleanup(soap, data->mec);
else
data->mec = (struct soap_mec_data*)SOAP_MALLOC(soap, sizeof(struct soap_mec_data));
if (soap_mec_begin(soap, data->mec, alg, NULL, (unsigned char*)key, &keylen))
return soap_wsse_fault(soap, wsse__FailedCheck, NULL);
}
}
data->deco_alg = alg;
data->deco_keylen = keylen;
if (soap_mec_start_alg(soap, alg, key))
return soap_wsse_fault(soap, wsse__FailedCheck, NULL);
return SOAP_OK;
}
/**
@fn int soap_wsse_decrypt_end(struct soap *soap)
@brief Check for XML encryption ending tags and stop decryption of the XML
element content.
@param soap context
@return SOAP_OK or error code
*/
int
soap_wsse_decrypt_end(struct soap *soap)
{ DBGFUN("soap_wsse_decrypt_end");
if (soap_mec_stop(soap)
|| soap_element_end_in(soap, "xenc:CipherValue")
|| soap_element_end_in(soap, "xenc:CipherData")
|| soap_element_end_in(soap, "xenc:EncryptedData"))
return soap_wsse_fault(soap, wsse__FailedCheck, NULL);
return SOAP_OK;
}
/******************************************************************************\
*
* Callbacks registered by plugin
*
\******************************************************************************/
/**
@fn int soap_wsse_header(struct soap *soap)
@brief This callback is invoked as soon as the SOAP Header is received, we need
to obtain the encrypted key when the message is encrypted to start decryption.
@param soap context
@return SOAP_OK or error code
*/
static int
soap_wsse_header(struct soap *soap)
{ /* look for encrypted elements in Body */
/* soap->feltbegin = soap_wsse_element_begin_in; Moved, now always set */
/* soap->feltendin = soap_wsse_element_end_in; Moved, now always set */
/* get the encrypted key, if present */
return soap_wsse_verify_EncryptedKey(soap);
}
/**
@fn int soap_wsse_element_begin_in(struct soap *soap, const char *tag)
@brief This callback is invoked as soon as a starting tag of an element is
received by the XML parser.
@param soap context
@param[in] tag name of the element parsed
@return SOAP_OK or error code
*/
static int
soap_wsse_element_begin_in(struct soap *soap, const char *tag)
{ /* make sure we always have a header allocated */
if (soap->part == SOAP_IN_ENVELOPE)
soap_header(soap);
if (!soap_match_tag(soap, tag, "xenc:EncryptedData"))
{ struct soap_dom_element *dom = soap->dom;
/* disable DOM */
soap->dom = NULL;
/* parse encryption tags */
if (soap_wsse_decrypt_begin(soap, NULL))
return soap->error;
/* adjust DOM tree to skip encryption elements */
soap->dom = dom->prnt;
soap->dom->elts = NULL;
/* adjust nesting level */
soap->level -= 3;
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Decryption started, parsing decrypted XML\n"));
soap->event = SOAP_SEC_DECRYPT;
return soap_peek_element(soap);
}
return SOAP_OK;
}
/**
@fn int soap_wsse_element_end_in(struct soap *soap, const char *tag1, const char *tag2)
@brief This callback is invoked as soon as an ending tag of an element is
received by the XML parser.
@param soap context
@param[in] tag1 name of the element parsed
@param[in] tag2 name of the element that was expected by the parser's state, or NULL
@return SOAP_OK or error code
*/
static int
soap_wsse_element_end_in(struct soap *soap, const char *tag1, const char *tag2)
{ if (soap->event == SOAP_SEC_DECRYPT
&& soap->dom
&& soap->dom->elts
&& !soap_match_tag(soap, tag1, ":CipherValue"))
{ struct soap_dom_element *dom = soap->dom->elts;
soap->event = 0;
/* disable DOM */
soap->dom = NULL;
/* adjust nesting level */
soap->level += 3;
/* parse ending tags */
if (soap_mec_stop(soap)
|| soap_element_end_in(soap, ":CipherData")
|| soap_element_end_in(soap, ":EncryptedData"))
return soap_wsse_fault(soap, wsse__FailedCheck, NULL);
/* adjust DOM tree to skip encryption elements */
while (dom->next)
dom = dom->next;
soap->dom = dom;
return soap_element_end_in(soap, tag2);
}
return SOAP_OK;
}
/**
@fn int soap_wsse_element_begin_out(struct soap *soap, const char *tag)
@brief This callback is invoked as soon as a starting tag of an element is
to be sent by the XML generator.
@param soap context
@param[in] tag name of the element
@return SOAP_OK or error code
*/
static int
soap_wsse_element_begin_out(struct soap *soap, const char *tag)
{ struct soap_wsse_data *data = (struct soap_wsse_data*)soap_lookup_plugin(soap, soap_wsse_id);
if (data && !data->encid && !strcmp(tag, "SOAP-ENV:Body"))
{ _wsse__Security *security = soap_wsse_Security(soap);
char *URI = NULL;
if (security && security->xenc__EncryptedKey && security->xenc__EncryptedKey->Id)
{ const char *Id = security->xenc__EncryptedKey->Id;
if (!(URI = (char*)soap_malloc(soap, strlen(Id) + 1)))
return soap->error = SOAP_EOM;
*URI = '#';
strcpy(URI + 1, Id);
}
/* this only encrypts the Body, so stop the callback */
if (!(soap->mode & SOAP_IO_LENGTH))
soap->feltbegout = NULL;
return soap_wsse_encrypt_begin(soap, "Body", data->enco_alg, URI, data->enco_keyname, NULL);
}
else if (data && data->encid && soap_tagsearch(data->encid, tag))
{ _wsse__Security *security = soap_wsse_Security(soap);
char *URI = NULL;
if (security && security->xenc__EncryptedKey && security->xenc__EncryptedKey->Id)
{ const char *Id = security->xenc__EncryptedKey->Id;
if (!(URI = (char*)soap_malloc(soap, strlen(Id) + 1)))
return soap->error = SOAP_EOM;
*URI = '#';
strcpy(URI + 1, Id);
}
return soap_wsse_encrypt_begin(soap, soap_wsse_ids(soap, tag), data->enco_alg, URI, data->enco_keyname, NULL);
}
return SOAP_OK;
}
/**
@fn int soap_wsse_element_end_out(struct soap *soap, const char *tag)
@brief This callback is invoked as soon as an ending tag of an element is
to be sent by the XML generator.
@param soap context
@param[in] tag name of the element
@return SOAP_OK or error code
*/
static int
soap_wsse_element_end_out(struct soap *soap, const char *tag)
{ struct soap_wsse_data *data = (struct soap_wsse_data*)soap_lookup_plugin(soap, soap_wsse_id);
if (data && !data->encid && !strcmp(tag, "SOAP-ENV:Body"))
{ if (soap_wsse_encrypt_end(soap))
return soap->error;
/* this version only encrypts Body, so stop the callback */
if (!(soap->mode & SOAP_IO_LENGTH))
soap->feltendout = NULL;
}
else if (data && data->encid && soap_tagsearch(data->encid, tag))
{ if (soap_wsse_encrypt_end(soap))
return soap->error;
}
return SOAP_OK;
}
/**
@fn int soap_wsse_preparesend(struct soap *soap, const char *buf, size_t len)
@brief Takes a piece of the XML message (tokenized) to compute digest.
@param soap context
@param[in] buf string (XML "tokenized") to be sent
@param[in] len buf length
@return SOAP_OK or fault
This callback is invoked to analyze a message (usually during the HTTP content
length phase). Note: nested elements with wsu:Id attributes cannot be
individually signed.
*/
static int
soap_wsse_preparesend(struct soap *soap, const char *buf, size_t len)
{ struct soap_wsse_data *data = (struct soap_wsse_data*)soap_lookup_plugin(soap, soap_wsse_id);
DBGFUN("soap_wsse_preparesend");
if (!data)
return SOAP_PLUGIN_ERROR;
/* the gSOAP engine signals the start of a wsu:Id element */
if (soap->event == SOAP_SEC_BEGIN)
{ int alg;
/* start new digest or continue? */
if (data->digest && data->digest->level)
soap->event = SOAP_SEC_SIGN;
else if (!data->sigid || soap_tagsearch(data->sigid, soap->id))
{ soap->event = SOAP_SEC_SIGN;
/* initialize smdevp engine */
struct soap_wsse_digest *digest;
digest = (struct soap_wsse_digest*)SOAP_MALLOC(soap, sizeof(struct soap_wsse_digest) + strlen(soap->id) + 1);
digest->next = data->digest;
digest->level = soap->level;
/* digest hash strength is same as signature strength */
alg = (SOAP_SMD_DGST | (data->sign_alg & SOAP_SMD_HASH));
soap_smd_init(soap, &digest->smd, alg, NULL, 0);
memset(digest->hash, 0, sizeof(digest->hash));
digest->id[0] = '#';
strcpy(digest->id + 1, soap->id);
data->digest = digest;
/* omit indent for indented XML (next time around, we will catch '<') */
if (*buf != '<')
goto end;
}
}
if (soap->event == SOAP_SEC_SIGN)
{ /* update smdevp engine */
if (data->digest && data->digest->level)
{ soap_smd_update(soap, &data->digest->smd, buf, len);
if (soap->level < data->digest->level)
{ soap->event = 0;
soap_smd_final(soap, &data->digest->smd, (char*)data->digest->hash, NULL);
data->digest->level = 0;
}
}
}
end:
if (data->fpreparesend)
return data->fpreparesend(soap, buf, len);
return SOAP_OK;
}
/**
@fn int soap_wsse_preparefinalsend(struct soap *soap)
@brief Collects the digests of all the wsu:Id elements and populates the SignedInfo.
@param soap context
@return SOAP_OK or fault
This callback is invoked just before the message is sent.
*/
static int
soap_wsse_preparefinalsend(struct soap *soap)
{ struct soap_wsse_data *data = (struct soap_wsse_data*)soap_lookup_plugin(soap, soap_wsse_id);
DBGFUN("soap_wsse_preparefinalsend");
if (!data)
return SOAP_PLUGIN_ERROR;
if (data->digest)
{ ds__SignatureType *signature = soap_wsse_Signature(soap);
struct soap_wsse_digest *digest;
const char *transform;
int alg, signature_added = 0;
/* if message is canonicalized populate transform element accordingly */
if (soap->mode & SOAP_XML_CANONICAL)
transform = c14n_URI;
else
transform = NULL;
/* to increase the message length counter we need to emit the Signature,
SignedInfo and SignatureValue elements. However, this does not work if
we already populated the wsse:Signature with SignedInfo and should never
happen! */
if (!signature)
{ signature = soap_wsse_add_Signature(soap);
signature_added = 1;
}
else if (signature->SignedInfo)
return soap_set_receiver_error(soap, "wsse error", "Cannot use soap_wsse_sign with populated SignedInfo", SOAP_SSL_ERROR);
/* digest hash strength is same as signature strength */
alg = (SOAP_SMD_DGST | (data->sign_alg & SOAP_SMD_HASH));
/* add the SignedInfo/Reference elements for each digest */
for (digest = data->digest; digest; digest = digest->next)
if (soap_wsse_add_SignedInfo_Reference(soap, digest->id, transform, NULL, alg, (char*)digest->hash))
return soap->error;
/* then compute the signature and add it */
if (soap_wsse_add_SignatureValue(soap, data->sign_alg, data->sign_key, data->sign_keylen))
return soap->error;
/* Reset the callbacks and cleanup digests */
soap_wsse_preparecleanup(soap, data);
/* if non-chunked, adjust content length */
if ((soap->mode & SOAP_IO) != SOAP_IO_CHUNK)
{ /* the code below ensures we increase the HTTP length counter */
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Counting the size of additional SOAP Header elements, mode=0x%x\n", soap->mode));
if (signature_added)
{ soap->level = 3; /* indent level for XML Signature */
if (soap->mode & SOAP_XML_CANONICAL && soap->mode & SOAP_XML_INDENT)
{ soap->ns = 0; /* need namespaces for canonicalization */
soap->count += 4; /* correction for soap->ns = 0: add \n+indent */
}
soap_out_ds__SignatureType(soap, "ds:Signature", 0, signature, NULL);
}
else
{ const char *c14nexclude = soap->c14nexclude;
soap->c14nexclude = "ds"; /* don't add xmlns:ds to count msg len */
soap->level = 4; /* indent level for XML SignedInfo */
if (soap->mode & SOAP_XML_CANONICAL && soap->mode & SOAP_XML_INDENT)
{ soap->ns = 0; /* need namespaces for canonicalization */
soap->count += 5; /* correction for soap->ns = 0: add \n+indent */
}
soap_out_ds__SignedInfoType(soap, "ds:SignedInfo", 0, signature->SignedInfo, NULL);
soap_outstring(soap, "ds:SignatureValue", 0, &signature->SignatureValue, NULL, 0);
soap->c14nexclude = c14nexclude;
}
}
}
else /* Reset the callbacks and cleanup digests */
soap_wsse_preparecleanup(soap, data);
if (soap->fpreparefinalsend)
return soap->fpreparefinalsend(soap);
return SOAP_OK;
}
/**
@fn void soap_wsse_preparecleanup(struct soap *soap, struct soap_wsse_data *data)
@brief Restores engine state.
@param soap context
@param[in,out] data plugin data
*/
static void
soap_wsse_preparecleanup(struct soap *soap, struct soap_wsse_data *data)
{ struct soap_wsse_digest *digest, *next;
DBGFUN("soap_wsse_preparecleanup");
data->sign_alg = SOAP_SMD_NONE;
data->sign_key = NULL;
data->sign_keylen = 0;
if (soap->fpreparesend == soap_wsse_preparesend)
soap->fpreparesend = data->fpreparesend;
if (soap->fpreparefinalsend == soap_wsse_preparefinalsend)
soap->fpreparefinalsend = data->fpreparefinalsend;
data->fpreparesend = NULL;
data->fpreparefinalsend = NULL;
for (digest = data->digest; digest; digest = next)
{ next = digest->next;
SOAP_FREE(soap, digest);
}
data->digest = NULL;
}
/**
@fn int soap_wsse_preparefinalrecv(struct soap *soap)
@brief Verify signature and SignedInfo digests initiated with soap_wsse_verify_auto.
@param soap context
@return SOAP_OK or fault
@see soap_wsse_verify_auto
This callback is invoked just after a message was received.
*/
static int
soap_wsse_preparefinalrecv(struct soap *soap)
{ struct soap_wsse_data *data = (struct soap_wsse_data*)soap_lookup_plugin(soap, soap_wsse_id);
ds__SignedInfoType *signedInfo = soap_wsse_SignedInfo(soap);
soap->omode &= ~SOAP_SEC_WSUID;
data->sigid = NULL; /* so we must set again before next send */
data->encid = NULL; /* so we must set again before next send */
DBGFUN("soap_wsse_preparefinalrecv");
if (!data)
return SOAP_PLUGIN_ERROR;
if (data->deco_alg != SOAP_MEC_NONE && data->mec)
if (soap_mec_end(soap, data->mec))
return soap_wsse_fault(soap, wsse__FailedCheck, NULL);
data->deco_alg = SOAP_MEC_NONE;
if (signedInfo)
{ int err = SOAP_OK, alg, keylen = 0;
EVP_PKEY *pkey = NULL;
const void *key = NULL;
/* determine which signature algorithm was used */
if (soap_wsse_get_SignedInfo_SignatureMethod(soap, &alg))
return soap->error;
/* for HMAC-SHA1, the secret key might be stored in the KeyIdentifier */
if ((alg & SOAP_SMD_ALGO) == SOAP_SMD_HMAC)
{ const char *valueType = soap_wsse_get_KeyInfo_SecurityTokenReferenceKeyIdentifierValueType(soap);
/* if in the KeyIdentifier, retrieve it */
if (valueType && !strcmp(valueType, ds_hmac_sha1URI))
{ DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Using HMAC key from KeyIdentifier to verify signature\n"));
key = soap_wsse_get_KeyInfo_SecurityTokenReferenceKeyIdentifier(soap, &keylen);
}
/* next, try the plugin's security token handler */
if (!key)
{ if (data->security_token_handler)
{ DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Getting HMAC key through security_token_handler callback\n"));
key = data->security_token_handler(soap, &alg, NULL, &keylen);
}
}
/* still no key: try to get it from the plugin */
if (!key && alg == (data->vrfy_alg & SOAP_SMD_MASK))
{ /* get the HMAC secret key from the plugin */
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Using HMAC key from plugin to verify signature\n"));
key = data->vrfy_key;
keylen = data->vrfy_keylen;
}
}
else
{ /* get the certificate from the KeyInfo reference */
X509 *cert, *cert1;
cert = cert1 = soap_wsse_get_KeyInfo_SecurityTokenReferenceX509(soap);
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Got cert=%p\n", cert));
/* next, try the plugin's security token handler */
if (!cert)
{ if (data->security_token_handler)
{ DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Getting certificate through security_token_handler callback\n"));
cert = (X509*)data->security_token_handler(soap, &alg, NULL, &keylen);
}
}
/* obtain the public key from the cert */
if (cert)
{ pkey = X509_get_pubkey((X509*)cert);
key = (void*)pkey;
}
else if (alg == (data->vrfy_alg & SOAP_SMD_MASK))
{ /* get the public key from the plugin */
DBGLOG(TEST, SOAP_MESSAGE(fdebug, "Using public key from plugin to verify signature\n"));
key = data->vrfy_key;
soap->error = SOAP_OK;
}
if (cert1)
X509_free(cert1);
}
/* if still no key, fault */
if (!key)
err = soap_wsse_fault(soap, wsse__SecurityTokenUnavailable, NULL);
/* verify SignedInfo with signature and check digests of local elements */
else if (soap_wsse_verify_SignatureValue(soap, alg, key, keylen)
|| soap_wsse_verify_SignedInfo(soap))
err = soap->error;
if (pkey)
EVP_PKEY_free(pkey);
if (err)
return err;
if (data->fpreparefinalrecv && data->fpreparefinalrecv != soap_wsse_preparefinalrecv)
return data->fpreparefinalrecv(soap);
}
else if (!soap->fault)
return soap_wsse_fault(soap, wsse__FailedCheck, "Signature required");
return SOAP_OK;
}
#ifdef __cplusplus
}
#endif
|