/usr/share/doc/python3-certbot-apache/html/_modules/certbot_apache/configurator.html is in python-certbot-apache-doc 0.23.0-1.
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 | <!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>certbot_apache.configurator — certbot-apache 0 documentation</title>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="../../genindex.html"/>
<link rel="search" title="Search" href="../../search.html"/>
<link rel="top" title="certbot-apache 0 documentation" href="../../index.html"/>
<link rel="up" title="Module code" href="../index.html"/>
<script src="../../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../../index.html" class="icon icon-home"> certbot-apache
</a>
<div class="version">
0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../api.html">API Documentation</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">certbot-apache</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html">Docs</a> »</li>
<li><a href="../index.html">Module code</a> »</li>
<li>certbot_apache.configurator</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for certbot_apache.configurator</h1><div class="highlight"><pre>
<span></span><span class="sd">"""Apache Configuration based off of Augeas Configurator."""</span>
<span class="c1"># pylint: disable=too-many-lines</span>
<span class="kn">import</span> <span class="nn">fnmatch</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">pkg_resources</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">import</span> <span class="nn">six</span>
<span class="kn">import</span> <span class="nn">socket</span>
<span class="kn">import</span> <span class="nn">time</span>
<span class="kn">import</span> <span class="nn">zope.component</span>
<span class="kn">import</span> <span class="nn">zope.interface</span>
<span class="kn">from</span> <span class="nn">acme</span> <span class="k">import</span> <span class="n">challenges</span>
<span class="kn">from</span> <span class="nn">certbot</span> <span class="k">import</span> <span class="n">errors</span>
<span class="kn">from</span> <span class="nn">certbot</span> <span class="k">import</span> <span class="n">interfaces</span>
<span class="kn">from</span> <span class="nn">certbot</span> <span class="k">import</span> <span class="n">util</span>
<span class="kn">from</span> <span class="nn">certbot.plugins</span> <span class="k">import</span> <span class="n">common</span>
<span class="kn">from</span> <span class="nn">certbot.plugins.util</span> <span class="k">import</span> <span class="n">path_surgery</span>
<span class="kn">from</span> <span class="nn">certbot_apache</span> <span class="k">import</span> <span class="n">apache_util</span>
<span class="kn">from</span> <span class="nn">certbot_apache</span> <span class="k">import</span> <span class="n">augeas_configurator</span>
<span class="kn">from</span> <span class="nn">certbot_apache</span> <span class="k">import</span> <span class="n">constants</span>
<span class="kn">from</span> <span class="nn">certbot_apache</span> <span class="k">import</span> <span class="n">display_ops</span>
<span class="kn">from</span> <span class="nn">certbot_apache</span> <span class="k">import</span> <span class="n">http_01</span>
<span class="kn">from</span> <span class="nn">certbot_apache</span> <span class="k">import</span> <span class="n">obj</span>
<span class="kn">from</span> <span class="nn">certbot_apache</span> <span class="k">import</span> <span class="n">parser</span>
<span class="kn">from</span> <span class="nn">certbot_apache</span> <span class="k">import</span> <span class="n">tls_sni_01</span>
<span class="kn">from</span> <span class="nn">collections</span> <span class="k">import</span> <span class="n">defaultdict</span>
<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
<span class="c1"># TODO: Augeas sections ie. <VirtualHost>, <IfModule> beginning and closing</span>
<span class="c1"># tags need to be the same case, otherwise Augeas doesn't recognize them.</span>
<span class="c1"># This is not able to be completely remedied by regular expressions because</span>
<span class="c1"># Augeas views <VirtualHost> </Virtualhost> as an error. This will just</span>
<span class="c1"># require another check_parsing_errors() after all files are included...</span>
<span class="c1"># (after a find_directive search is executed currently). It can be a one</span>
<span class="c1"># time check however because all of LE's transactions will ensure</span>
<span class="c1"># only properly formed sections are added.</span>
<span class="c1"># Note: This protocol works for filenames with spaces in it, the sites are</span>
<span class="c1"># properly set up and directives are changed appropriately, but Apache won't</span>
<span class="c1"># recognize names in sites-enabled that have spaces. These are not added to the</span>
<span class="c1"># Apache configuration. It may be wise to warn the user if they are trying</span>
<span class="c1"># to use vhost filenames that contain spaces and offer to change ' ' to '_'</span>
<span class="c1"># Note: FILEPATHS and changes to files are transactional. They are copied</span>
<span class="c1"># over before the updates are made to the existing files. NEW_FILES is</span>
<span class="c1"># transactional due to the use of register_file_creation()</span>
<span class="c1"># TODO: Verify permissions on configuration root... it is easier than</span>
<span class="c1"># checking permissions on each of the relative directories and less error</span>
<span class="c1"># prone.</span>
<span class="c1"># TODO: Write a server protocol finder. Listen <port> <protocol> or</span>
<span class="c1"># Protocol <protocol>. This can verify partial setups are correct</span>
<span class="c1"># TODO: Add directives to sites-enabled... not sites-available.</span>
<span class="c1"># sites-available doesn't allow immediate find_dir search even with save()</span>
<span class="c1"># and load()</span>
<div class="viewcode-block" id="ApacheConfigurator"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator">[docs]</a><span class="nd">@zope</span><span class="o">.</span><span class="n">interface</span><span class="o">.</span><span class="n">implementer</span><span class="p">(</span><span class="n">interfaces</span><span class="o">.</span><span class="n">IAuthenticator</span><span class="p">,</span> <span class="n">interfaces</span><span class="o">.</span><span class="n">IInstaller</span><span class="p">)</span>
<span class="nd">@zope</span><span class="o">.</span><span class="n">interface</span><span class="o">.</span><span class="n">provider</span><span class="p">(</span><span class="n">interfaces</span><span class="o">.</span><span class="n">IPluginFactory</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">ApacheConfigurator</span><span class="p">(</span><span class="n">augeas_configurator</span><span class="o">.</span><span class="n">AugeasConfigurator</span><span class="p">):</span>
<span class="c1"># pylint: disable=too-many-instance-attributes,too-many-public-methods</span>
<span class="sd">"""Apache configurator.</span>
<span class="sd"> State of Configurator: This code has been been tested and built for Ubuntu</span>
<span class="sd"> 14.04 Apache 2.4 and it works for Ubuntu 12.04 Apache 2.2</span>
<span class="sd"> :ivar config: Configuration.</span>
<span class="sd"> :type config: :class:`~certbot.interfaces.IConfig`</span>
<span class="sd"> :ivar parser: Handles low level parsing</span>
<span class="sd"> :type parser: :class:`~certbot_apache.parser`</span>
<span class="sd"> :ivar tup version: version of Apache</span>
<span class="sd"> :ivar list vhosts: All vhosts found in the configuration</span>
<span class="sd"> (:class:`list` of :class:`~certbot_apache.obj.VirtualHost`)</span>
<span class="sd"> :ivar dict assoc: Mapping between domains and vhosts</span>
<span class="sd"> """</span>
<span class="n">description</span> <span class="o">=</span> <span class="s2">"Apache Web Server plugin - Beta"</span>
<span class="n">OS_DEFAULTS</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
<span class="n">server_root</span><span class="o">=</span><span class="s2">"/etc/apache2"</span><span class="p">,</span>
<span class="n">vhost_root</span><span class="o">=</span><span class="s2">"/etc/apache2/sites-available"</span><span class="p">,</span>
<span class="n">vhost_files</span><span class="o">=</span><span class="s2">"*"</span><span class="p">,</span>
<span class="n">logs_root</span><span class="o">=</span><span class="s2">"/var/log/apache2"</span><span class="p">,</span>
<span class="n">version_cmd</span><span class="o">=</span><span class="p">[</span><span class="s1">'apache2ctl'</span><span class="p">,</span> <span class="s1">'-v'</span><span class="p">],</span>
<span class="n">apache_cmd</span><span class="o">=</span><span class="s2">"apache2ctl"</span><span class="p">,</span>
<span class="n">restart_cmd</span><span class="o">=</span><span class="p">[</span><span class="s1">'apache2ctl'</span><span class="p">,</span> <span class="s1">'graceful'</span><span class="p">],</span>
<span class="n">conftest_cmd</span><span class="o">=</span><span class="p">[</span><span class="s1">'apache2ctl'</span><span class="p">,</span> <span class="s1">'configtest'</span><span class="p">],</span>
<span class="n">enmod</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">dismod</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">le_vhost_ext</span><span class="o">=</span><span class="s2">"-le-ssl.conf"</span><span class="p">,</span>
<span class="n">handle_mods</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="n">handle_sites</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="n">challenge_location</span><span class="o">=</span><span class="s2">"/etc/apache2"</span><span class="p">,</span>
<span class="n">MOD_SSL_CONF_SRC</span><span class="o">=</span><span class="n">pkg_resources</span><span class="o">.</span><span class="n">resource_filename</span><span class="p">(</span>
<span class="s2">"certbot_apache"</span><span class="p">,</span> <span class="s2">"options-ssl-apache.conf"</span><span class="p">)</span>
<span class="p">)</span>
<div class="viewcode-block" id="ApacheConfigurator.constant"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.constant">[docs]</a> <span class="k">def</span> <span class="nf">constant</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
<span class="sd">"""Get constant for OS_DEFAULTS"""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">OS_DEFAULTS</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">)</span></div>
<span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">add_parser_arguments</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">add</span><span class="p">):</span>
<span class="n">add</span><span class="p">(</span><span class="s2">"enmod"</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="bp">cls</span><span class="o">.</span><span class="n">OS_DEFAULTS</span><span class="p">[</span><span class="s2">"enmod"</span><span class="p">],</span>
<span class="n">help</span><span class="o">=</span><span class="s2">"Path to the Apache 'a2enmod' binary."</span><span class="p">)</span>
<span class="n">add</span><span class="p">(</span><span class="s2">"dismod"</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="bp">cls</span><span class="o">.</span><span class="n">OS_DEFAULTS</span><span class="p">[</span><span class="s2">"dismod"</span><span class="p">],</span>
<span class="n">help</span><span class="o">=</span><span class="s2">"Path to the Apache 'a2dismod' binary."</span><span class="p">)</span>
<span class="n">add</span><span class="p">(</span><span class="s2">"le-vhost-ext"</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="bp">cls</span><span class="o">.</span><span class="n">OS_DEFAULTS</span><span class="p">[</span><span class="s2">"le_vhost_ext"</span><span class="p">],</span>
<span class="n">help</span><span class="o">=</span><span class="s2">"SSL vhost configuration extension."</span><span class="p">)</span>
<span class="n">add</span><span class="p">(</span><span class="s2">"server-root"</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="bp">cls</span><span class="o">.</span><span class="n">OS_DEFAULTS</span><span class="p">[</span><span class="s2">"server_root"</span><span class="p">],</span>
<span class="n">help</span><span class="o">=</span><span class="s2">"Apache server root directory."</span><span class="p">)</span>
<span class="n">add</span><span class="p">(</span><span class="s2">"vhost-root"</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s2">"Apache server VirtualHost configuration root"</span><span class="p">)</span>
<span class="n">add</span><span class="p">(</span><span class="s2">"logs-root"</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="bp">cls</span><span class="o">.</span><span class="n">OS_DEFAULTS</span><span class="p">[</span><span class="s2">"logs_root"</span><span class="p">],</span>
<span class="n">help</span><span class="o">=</span><span class="s2">"Apache server logs directory"</span><span class="p">)</span>
<span class="n">add</span><span class="p">(</span><span class="s2">"challenge-location"</span><span class="p">,</span>
<span class="n">default</span><span class="o">=</span><span class="bp">cls</span><span class="o">.</span><span class="n">OS_DEFAULTS</span><span class="p">[</span><span class="s2">"challenge_location"</span><span class="p">],</span>
<span class="n">help</span><span class="o">=</span><span class="s2">"Directory path for challenge configuration."</span><span class="p">)</span>
<span class="n">add</span><span class="p">(</span><span class="s2">"handle-modules"</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="bp">cls</span><span class="o">.</span><span class="n">OS_DEFAULTS</span><span class="p">[</span><span class="s2">"handle_mods"</span><span class="p">],</span>
<span class="n">help</span><span class="o">=</span><span class="s2">"Let installer handle enabling required modules for you."</span> <span class="o">+</span>
<span class="s2">"(Only Ubuntu/Debian currently)"</span><span class="p">)</span>
<span class="n">add</span><span class="p">(</span><span class="s2">"handle-sites"</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="bp">cls</span><span class="o">.</span><span class="n">OS_DEFAULTS</span><span class="p">[</span><span class="s2">"handle_sites"</span><span class="p">],</span>
<span class="n">help</span><span class="o">=</span><span class="s2">"Let installer handle enabling sites for you."</span> <span class="o">+</span>
<span class="s2">"(Only Ubuntu/Debian currently)"</span><span class="p">)</span>
<span class="n">util</span><span class="o">.</span><span class="n">add_deprecated_argument</span><span class="p">(</span><span class="n">add</span><span class="p">,</span> <span class="n">argument_name</span><span class="o">=</span><span class="s2">"ctl"</span><span class="p">,</span> <span class="n">nargs</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
<span class="n">util</span><span class="o">.</span><span class="n">add_deprecated_argument</span><span class="p">(</span>
<span class="n">add</span><span class="p">,</span> <span class="n">argument_name</span><span class="o">=</span><span class="s2">"init-script"</span><span class="p">,</span> <span class="n">nargs</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""Initialize an Apache Configurator.</span>
<span class="sd"> :param tup version: version of Apache as a tuple (2, 4, 7)</span>
<span class="sd"> (used mostly for unittesting)</span>
<span class="sd"> """</span>
<span class="n">version</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"version"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="nb">super</span><span class="p">(</span><span class="n">ApacheConfigurator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="c1"># Add name_server association dict</span>
<span class="bp">self</span><span class="o">.</span><span class="n">assoc</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
<span class="c1"># Outstanding challenges</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_chall_out</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="c1"># List of vhosts configured per wildcard domain on this run.</span>
<span class="c1"># used by deploy_cert() and enhance()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_wildcard_vhosts</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
<span class="c1"># Maps enhancements to vhosts we've enabled the enhancement for</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_enhanced_vhosts</span> <span class="o">=</span> <span class="n">defaultdict</span><span class="p">(</span><span class="nb">set</span><span class="p">)</span>
<span class="c1"># These will be set in the prepare function</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">version</span> <span class="o">=</span> <span class="n">version</span>
<span class="bp">self</span><span class="o">.</span><span class="n">vhosts</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">vhostroot</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_enhance_func</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"redirect"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">_enable_redirect</span><span class="p">,</span>
<span class="s2">"ensure-http-header"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">_set_http_header</span><span class="p">,</span>
<span class="s2">"staple-ocsp"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">_enable_ocsp_stapling</span><span class="p">}</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">mod_ssl_conf</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Full absolute path to SSL configuration file."""</span>
<span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">config_dir</span><span class="p">,</span>
<span class="n">constants</span><span class="o">.</span><span class="n">MOD_SSL_CONF_DEST</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">updated_mod_ssl_conf_digest</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Full absolute path to digest of updated SSL configuration file."""</span>
<span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">config_dir</span><span class="p">,</span> <span class="n">constants</span><span class="o">.</span><span class="n">UPDATED_MOD_SSL_CONF_DIGEST</span><span class="p">)</span>
<div class="viewcode-block" id="ApacheConfigurator.prepare"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.prepare">[docs]</a> <span class="k">def</span> <span class="nf">prepare</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Prepare the authenticator/installer.</span>
<span class="sd"> :raises .errors.NoInstallationError: If Apache configs cannot be found</span>
<span class="sd"> :raises .errors.MisconfigurationError: If Apache is misconfigured</span>
<span class="sd"> :raises .errors.NotSupportedError: If Apache version is not supported</span>
<span class="sd"> :raises .errors.PluginError: If there is any other error</span>
<span class="sd"> """</span>
<span class="c1"># Perform the actual Augeas initialization to be able to react</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">init_augeas</span><span class="p">()</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">NoInstallationError</span><span class="p">(</span><span class="s2">"Problem in Augeas installation"</span><span class="p">)</span>
<span class="c1"># Verify Apache is installed</span>
<span class="n">restart_cmd</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">constant</span><span class="p">(</span><span class="s2">"restart_cmd"</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">util</span><span class="o">.</span><span class="n">exe_exists</span><span class="p">(</span><span class="n">restart_cmd</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">path_surgery</span><span class="p">(</span><span class="n">restart_cmd</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">NoInstallationError</span><span class="p">(</span>
<span class="s1">'Cannot find Apache control command </span><span class="si">{0}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">restart_cmd</span><span class="p">))</span>
<span class="c1"># Make sure configuration is valid</span>
<span class="bp">self</span><span class="o">.</span><span class="n">config_test</span><span class="p">()</span>
<span class="c1"># Set Version</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">version</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">version</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_version</span><span class="p">()</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'Apache version is </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span>
<span class="s1">'.'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">i</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">version</span><span class="p">))</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">version</span> <span class="o"><</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">NotSupportedError</span><span class="p">(</span>
<span class="s2">"Apache Version </span><span class="si">%s</span><span class="s2"> not supported."</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">version</span><span class="p">))</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_check_aug_version</span><span class="p">():</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">NotSupportedError</span><span class="p">(</span>
<span class="s2">"Apache plugin support requires libaugeas0 and augeas-lenses "</span>
<span class="s2">"version 1.2.0 or higher, please make sure you have you have "</span>
<span class="s2">"those installed."</span><span class="p">)</span>
<span class="c1"># Parse vhost-root if defined on cli</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">conf</span><span class="p">(</span><span class="s2">"vhost-root"</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">vhostroot</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">constant</span><span class="p">(</span><span class="s2">"vhost_root"</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">vhostroot</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">conf</span><span class="p">(</span><span class="s2">"vhost-root"</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_parser</span><span class="p">()</span>
<span class="c1"># Check for errors in parsing files with Augeas</span>
<span class="bp">self</span><span class="o">.</span><span class="n">check_parsing_errors</span><span class="p">(</span><span class="s2">"httpd.aug"</span><span class="p">)</span>
<span class="c1"># Get all of the available vhosts</span>
<span class="bp">self</span><span class="o">.</span><span class="n">vhosts</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_virtual_hosts</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">install_ssl_options_conf</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">mod_ssl_conf</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">updated_mod_ssl_conf_digest</span><span class="p">)</span>
<span class="c1"># Prevent two Apache plugins from modifying a config at once</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">util</span><span class="o">.</span><span class="n">lock_dir_until_exit</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">conf</span><span class="p">(</span><span class="s2">"server-root"</span><span class="p">))</span>
<span class="k">except</span> <span class="p">(</span><span class="ne">OSError</span><span class="p">,</span> <span class="n">errors</span><span class="o">.</span><span class="n">LockError</span><span class="p">):</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"Encountered error:"</span><span class="p">,</span> <span class="n">exc_info</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span>
<span class="s2">"Unable to lock </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">conf</span><span class="p">(</span><span class="s2">"server-root"</span><span class="p">))</span></div>
<div class="viewcode-block" id="ApacheConfigurator._check_aug_version"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._check_aug_version">[docs]</a> <span class="k">def</span> <span class="nf">_check_aug_version</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""" Checks that we have recent enough version of libaugeas.</span>
<span class="sd"> If augeas version is recent enough, it will support case insensitive</span>
<span class="sd"> regexp matching"""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">"/test/path/testing/arg"</span><span class="p">,</span> <span class="s2">"aRgUMeNT"</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">matches</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">match</span><span class="p">(</span>
<span class="s2">"/test//*[self::arg=~regexp('argument', 'i')]"</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">RuntimeError</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="s2">"/test/path"</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="s2">"/test/path"</span><span class="p">)</span>
<span class="k">return</span> <span class="n">matches</span></div>
<div class="viewcode-block" id="ApacheConfigurator.get_parser"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.get_parser">[docs]</a> <span class="k">def</span> <span class="nf">get_parser</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Initializes the ApacheParser"""</span>
<span class="k">return</span> <span class="n">parser</span><span class="o">.</span><span class="n">ApacheParser</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">conf</span><span class="p">(</span><span class="s2">"server-root"</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">conf</span><span class="p">(</span><span class="s2">"vhost-root"</span><span class="p">),</span>
<span class="bp">self</span><span class="o">.</span><span class="n">version</span><span class="p">,</span> <span class="n">configurator</span><span class="o">=</span><span class="bp">self</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheConfigurator._wildcard_domain"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._wildcard_domain">[docs]</a> <span class="k">def</span> <span class="nf">_wildcard_domain</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">domain</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Checks if domain is a wildcard domain</span>
<span class="sd"> :param str domain: Domain to check</span>
<span class="sd"> :returns: If the domain is wildcard domain</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">domain</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">text_type</span><span class="p">):</span>
<span class="n">wildcard_marker</span> <span class="o">=</span> <span class="sa">u</span><span class="s2">"*."</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">wildcard_marker</span> <span class="o">=</span> <span class="sa">b</span><span class="s2">"*."</span>
<span class="k">return</span> <span class="n">domain</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">wildcard_marker</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheConfigurator.deploy_cert"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.deploy_cert">[docs]</a> <span class="k">def</span> <span class="nf">deploy_cert</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">domain</span><span class="p">,</span> <span class="n">cert_path</span><span class="p">,</span> <span class="n">key_path</span><span class="p">,</span>
<span class="n">chain_path</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">fullchain_path</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Deploys certificate to specified virtual host.</span>
<span class="sd"> Currently tries to find the last directives to deploy the certificate</span>
<span class="sd"> in the VHost associated with the given domain. If it can't find the</span>
<span class="sd"> directives, it searches the "included" confs. The function verifies</span>
<span class="sd"> that it has located the three directives and finally modifies them</span>
<span class="sd"> to point to the correct destination. After the certificate is</span>
<span class="sd"> installed, the VirtualHost is enabled if it isn't already.</span>
<span class="sd"> .. todo:: Might be nice to remove chain directive if none exists</span>
<span class="sd"> This shouldn't happen within certbot though</span>
<span class="sd"> :raises errors.PluginError: When unable to deploy certificate due to</span>
<span class="sd"> a lack of directives</span>
<span class="sd"> """</span>
<span class="n">vhosts</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">choose_vhosts</span><span class="p">(</span><span class="n">domain</span><span class="p">)</span>
<span class="k">for</span> <span class="n">vhost</span> <span class="ow">in</span> <span class="n">vhosts</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_deploy_cert</span><span class="p">(</span><span class="n">vhost</span><span class="p">,</span> <span class="n">cert_path</span><span class="p">,</span> <span class="n">key_path</span><span class="p">,</span> <span class="n">chain_path</span><span class="p">,</span> <span class="n">fullchain_path</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheConfigurator.choose_vhosts"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.choose_vhosts">[docs]</a> <span class="k">def</span> <span class="nf">choose_vhosts</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">domain</span><span class="p">,</span> <span class="n">create_if_no_ssl</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Finds VirtualHosts that can be used with the provided domain</span>
<span class="sd"> :param str domain: Domain name to match VirtualHosts to</span>
<span class="sd"> :param bool create_if_no_ssl: If found VirtualHost doesn't have a HTTPS</span>
<span class="sd"> counterpart, should one get created</span>
<span class="sd"> :returns: List of VirtualHosts or None</span>
<span class="sd"> :rtype: `list` of :class:`~certbot_apache.obj.VirtualHost`</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_wildcard_domain</span><span class="p">(</span><span class="n">domain</span><span class="p">):</span>
<span class="k">if</span> <span class="n">domain</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_wildcard_vhosts</span><span class="p">:</span>
<span class="c1"># Vhosts for a wildcard domain were already selected</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_wildcard_vhosts</span><span class="p">[</span><span class="n">domain</span><span class="p">]</span>
<span class="c1"># Ask user which VHosts to support.</span>
<span class="c1"># Returned objects are guaranteed to be ssl vhosts</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_choose_vhosts_wildcard</span><span class="p">(</span><span class="n">domain</span><span class="p">,</span> <span class="n">create_if_no_ssl</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">choose_vhost</span><span class="p">(</span><span class="n">domain</span><span class="p">)]</span></div>
<div class="viewcode-block" id="ApacheConfigurator._vhosts_for_wildcard"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._vhosts_for_wildcard">[docs]</a> <span class="k">def</span> <span class="nf">_vhosts_for_wildcard</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">domain</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Get VHost objects for every VirtualHost that the user wants to handle</span>
<span class="sd"> with the wildcard certificate.</span>
<span class="sd"> """</span>
<span class="c1"># Collect all vhosts that match the name</span>
<span class="n">matched</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="k">for</span> <span class="n">vhost</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">vhosts</span><span class="p">:</span>
<span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">vhost</span><span class="o">.</span><span class="n">get_names</span><span class="p">():</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_in_wildcard_scope</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">domain</span><span class="p">):</span>
<span class="n">matched</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">vhost</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">matched</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheConfigurator._in_wildcard_scope"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._in_wildcard_scope">[docs]</a> <span class="k">def</span> <span class="nf">_in_wildcard_scope</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">domain</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Helper method for _vhosts_for_wildcard() that makes sure that the domain</span>
<span class="sd"> is in the scope of wildcard domain.</span>
<span class="sd"> eg. in scope: domain = *.wild.card, name = 1.wild.card</span>
<span class="sd"> not in scope: domain = *.wild.card, name = 1.2.wild.card</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"."</span><span class="p">))</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">domain</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"."</span><span class="p">)):</span>
<span class="k">return</span> <span class="n">fnmatch</span><span class="o">.</span><span class="n">fnmatch</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">domain</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheConfigurator._choose_vhosts_wildcard"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._choose_vhosts_wildcard">[docs]</a> <span class="k">def</span> <span class="nf">_choose_vhosts_wildcard</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">domain</span><span class="p">,</span> <span class="n">create_ssl</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">"""Prompts user to choose vhosts to install a wildcard certificate for"""</span>
<span class="c1"># Get all vhosts that are covered by the wildcard domain</span>
<span class="n">vhosts</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_vhosts_for_wildcard</span><span class="p">(</span><span class="n">domain</span><span class="p">)</span>
<span class="c1"># Go through the vhosts, making sure that we cover all the names</span>
<span class="c1"># present, but preferring the SSL vhosts</span>
<span class="n">filtered_vhosts</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
<span class="k">for</span> <span class="n">vhost</span> <span class="ow">in</span> <span class="n">vhosts</span><span class="p">:</span>
<span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">vhost</span><span class="o">.</span><span class="n">get_names</span><span class="p">():</span>
<span class="k">if</span> <span class="n">vhost</span><span class="o">.</span><span class="n">ssl</span><span class="p">:</span>
<span class="c1"># Always prefer SSL vhosts</span>
<span class="n">filtered_vhosts</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">vhost</span>
<span class="k">elif</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">filtered_vhosts</span> <span class="ow">and</span> <span class="n">create_ssl</span><span class="p">:</span>
<span class="c1"># Add if not in list previously</span>
<span class="n">filtered_vhosts</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">vhost</span>
<span class="c1"># Only unique VHost objects</span>
<span class="n">dialog_input</span> <span class="o">=</span> <span class="nb">set</span><span class="p">([</span><span class="n">vhost</span> <span class="k">for</span> <span class="n">vhost</span> <span class="ow">in</span> <span class="n">filtered_vhosts</span><span class="o">.</span><span class="n">values</span><span class="p">()])</span>
<span class="c1"># Ask the user which of names to enable, expect list of names back</span>
<span class="n">dialog_output</span> <span class="o">=</span> <span class="n">display_ops</span><span class="o">.</span><span class="n">select_vhost_multiple</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">dialog_input</span><span class="p">))</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">dialog_output</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span>
<span class="s2">"No vhost exists with servername or alias for domain </span><span class="si">%s</span><span class="s2">. "</span>
<span class="s2">"No vhost was selected. Please specify ServerName or ServerAlias "</span>
<span class="s2">"in the Apache config."</span><span class="p">,</span>
<span class="n">domain</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span><span class="s2">"No vhost selected"</span><span class="p">)</span>
<span class="c1"># Make sure we create SSL vhosts for the ones that are HTTP only</span>
<span class="c1"># if requested.</span>
<span class="n">return_vhosts</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
<span class="k">for</span> <span class="n">vhost</span> <span class="ow">in</span> <span class="n">dialog_output</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">vhost</span><span class="o">.</span><span class="n">ssl</span><span class="p">:</span>
<span class="n">return_vhosts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">make_vhost_ssl</span><span class="p">(</span><span class="n">vhost</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">return_vhosts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">vhost</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_wildcard_vhosts</span><span class="p">[</span><span class="n">domain</span><span class="p">]</span> <span class="o">=</span> <span class="n">return_vhosts</span>
<span class="k">return</span> <span class="n">return_vhosts</span></div>
<div class="viewcode-block" id="ApacheConfigurator._deploy_cert"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._deploy_cert">[docs]</a> <span class="k">def</span> <span class="nf">_deploy_cert</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vhost</span><span class="p">,</span> <span class="n">cert_path</span><span class="p">,</span> <span class="n">key_path</span><span class="p">,</span> <span class="n">chain_path</span><span class="p">,</span> <span class="n">fullchain_path</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Helper function for deploy_cert() that handles the actual deployment</span>
<span class="sd"> this exists because we might want to do multiple deployments per</span>
<span class="sd"> domain originally passed for deploy_cert(). This is especially true</span>
<span class="sd"> with wildcard certificates</span>
<span class="sd"> """</span>
<span class="c1"># This is done first so that ssl module is enabled and cert_path,</span>
<span class="c1"># cert_key... can all be parsed appropriately</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prepare_server_https</span><span class="p">(</span><span class="s2">"443"</span><span class="p">)</span>
<span class="c1"># Add directives and remove duplicates</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_dummy_ssl_directives</span><span class="p">(</span><span class="n">vhost</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_clean_vhost</span><span class="p">(</span><span class="n">vhost</span><span class="p">)</span>
<span class="n">path</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"cert_path"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span><span class="s2">"SSLCertificateFile"</span><span class="p">,</span>
<span class="kc">None</span><span class="p">,</span> <span class="n">vhost</span><span class="o">.</span><span class="n">path</span><span class="p">),</span>
<span class="s2">"cert_key"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span><span class="s2">"SSLCertificateKeyFile"</span><span class="p">,</span>
<span class="kc">None</span><span class="p">,</span> <span class="n">vhost</span><span class="o">.</span><span class="n">path</span><span class="p">)}</span>
<span class="c1"># Only include if a certificate chain is specified</span>
<span class="k">if</span> <span class="n">chain_path</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">path</span><span class="p">[</span><span class="s2">"chain_path"</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span>
<span class="s2">"SSLCertificateChainFile"</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="n">vhost</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
<span class="c1"># Handle errors when certificate/key directives cannot be found</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">path</span><span class="p">[</span><span class="s2">"cert_path"</span><span class="p">]:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span>
<span class="s2">"Cannot find an SSLCertificateFile directive in </span><span class="si">%s</span><span class="s2">. "</span>
<span class="s2">"VirtualHost was not modified"</span><span class="p">,</span> <span class="n">vhost</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span>
<span class="s2">"Unable to find an SSLCertificateFile directive"</span><span class="p">)</span>
<span class="k">elif</span> <span class="ow">not</span> <span class="n">path</span><span class="p">[</span><span class="s2">"cert_key"</span><span class="p">]:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span>
<span class="s2">"Cannot find an SSLCertificateKeyFile directive for "</span>
<span class="s2">"certificate in </span><span class="si">%s</span><span class="s2">. VirtualHost was not modified"</span><span class="p">,</span> <span class="n">vhost</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span>
<span class="s2">"Unable to find an SSLCertificateKeyFile directive for "</span>
<span class="s2">"certificate"</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"Deploying Certificate to VirtualHost </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">vhost</span><span class="o">.</span><span class="n">filep</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">version</span> <span class="o"><</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">8</span><span class="p">)</span> <span class="ow">or</span> <span class="p">(</span><span class="n">chain_path</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">fullchain_path</span><span class="p">):</span>
<span class="c1"># install SSLCertificateFile, SSLCertificateKeyFile,</span>
<span class="c1"># and SSLCertificateChainFile directives</span>
<span class="n">set_cert_path</span> <span class="o">=</span> <span class="n">cert_path</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">path</span><span class="p">[</span><span class="s2">"cert_path"</span><span class="p">][</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="n">cert_path</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">path</span><span class="p">[</span><span class="s2">"cert_key"</span><span class="p">][</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="n">key_path</span><span class="p">)</span>
<span class="k">if</span> <span class="n">chain_path</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">add_dir</span><span class="p">(</span><span class="n">vhost</span><span class="o">.</span><span class="n">path</span><span class="p">,</span>
<span class="s2">"SSLCertificateChainFile"</span><span class="p">,</span> <span class="n">chain_path</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span><span class="s2">"--chain-path is required for your "</span>
<span class="s2">"version of Apache"</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">fullchain_path</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span><span class="s2">"Please provide the --fullchain-path "</span>
<span class="s2">"option pointing to your full chain file"</span><span class="p">)</span>
<span class="n">set_cert_path</span> <span class="o">=</span> <span class="n">fullchain_path</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">path</span><span class="p">[</span><span class="s2">"cert_path"</span><span class="p">][</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="n">fullchain_path</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">path</span><span class="p">[</span><span class="s2">"cert_key"</span><span class="p">][</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="n">key_path</span><span class="p">)</span>
<span class="c1"># Enable the new vhost if needed</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">vhost</span><span class="o">.</span><span class="n">enabled</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">enable_site</span><span class="p">(</span><span class="n">vhost</span><span class="p">)</span>
<span class="c1"># Save notes about the transaction that took place</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save_notes</span> <span class="o">+=</span> <span class="p">(</span><span class="s2">"Changed vhost at </span><span class="si">%s</span><span class="s2"> with addresses of </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span>
<span class="s2">"</span><span class="se">\t</span><span class="s2">SSLCertificateFile </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span>
<span class="s2">"</span><span class="se">\t</span><span class="s2">SSLCertificateKeyFile </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">vhost</span><span class="o">.</span><span class="n">filep</span><span class="p">,</span>
<span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">addr</span><span class="p">)</span> <span class="k">for</span> <span class="n">addr</span> <span class="ow">in</span> <span class="n">vhost</span><span class="o">.</span><span class="n">addrs</span><span class="p">),</span>
<span class="n">set_cert_path</span><span class="p">,</span> <span class="n">key_path</span><span class="p">))</span>
<span class="k">if</span> <span class="n">chain_path</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save_notes</span> <span class="o">+=</span> <span class="s2">"</span><span class="se">\t</span><span class="s2">SSLCertificateChainFile </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">chain_path</span></div>
<div class="viewcode-block" id="ApacheConfigurator.choose_vhost"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.choose_vhost">[docs]</a> <span class="k">def</span> <span class="nf">choose_vhost</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">target_name</span><span class="p">,</span> <span class="n">temp</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""Chooses a virtual host based on the given domain name.</span>
<span class="sd"> If there is no clear virtual host to be selected, the user is prompted</span>
<span class="sd"> with all available choices.</span>
<span class="sd"> The returned vhost is guaranteed to have TLS enabled unless temp is</span>
<span class="sd"> True. If temp is True, there is no such guarantee and the result is</span>
<span class="sd"> not cached.</span>
<span class="sd"> :param str target_name: domain name</span>
<span class="sd"> :param bool temp: whether the vhost is only used temporarily</span>
<span class="sd"> :returns: ssl vhost associated with name</span>
<span class="sd"> :rtype: :class:`~certbot_apache.obj.VirtualHost`</span>
<span class="sd"> :raises .errors.PluginError: If no vhost is available or chosen</span>
<span class="sd"> """</span>
<span class="c1"># Allows for domain names to be associated with a virtual host</span>
<span class="k">if</span> <span class="n">target_name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">assoc</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">assoc</span><span class="p">[</span><span class="n">target_name</span><span class="p">]</span>
<span class="c1"># Try to find a reasonable vhost</span>
<span class="n">vhost</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_find_best_vhost</span><span class="p">(</span><span class="n">target_name</span><span class="p">)</span>
<span class="k">if</span> <span class="n">vhost</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="n">temp</span><span class="p">:</span>
<span class="k">return</span> <span class="n">vhost</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">vhost</span><span class="o">.</span><span class="n">ssl</span><span class="p">:</span>
<span class="n">vhost</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">make_vhost_ssl</span><span class="p">(</span><span class="n">vhost</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_servername_alias</span><span class="p">(</span><span class="n">target_name</span><span class="p">,</span> <span class="n">vhost</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">assoc</span><span class="p">[</span><span class="n">target_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">vhost</span>
<span class="k">return</span> <span class="n">vhost</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_choose_vhost_from_list</span><span class="p">(</span><span class="n">target_name</span><span class="p">,</span> <span class="n">temp</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">_choose_vhost_from_list</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">target_name</span><span class="p">,</span> <span class="n">temp</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="c1"># Select a vhost from a list</span>
<span class="n">vhost</span> <span class="o">=</span> <span class="n">display_ops</span><span class="o">.</span><span class="n">select_vhost</span><span class="p">(</span><span class="n">target_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">vhosts</span><span class="p">)</span>
<span class="k">if</span> <span class="n">vhost</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span>
<span class="s2">"No vhost exists with servername or alias of </span><span class="si">%s</span><span class="s2">. "</span>
<span class="s2">"No vhost was selected. Please specify ServerName or ServerAlias "</span>
<span class="s2">"in the Apache config."</span><span class="p">,</span>
<span class="n">target_name</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span><span class="s2">"No vhost selected"</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">temp</span><span class="p">:</span>
<span class="k">return</span> <span class="n">vhost</span>
<span class="k">elif</span> <span class="ow">not</span> <span class="n">vhost</span><span class="o">.</span><span class="n">ssl</span><span class="p">:</span>
<span class="n">addrs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_proposed_addrs</span><span class="p">(</span><span class="n">vhost</span><span class="p">,</span> <span class="s2">"443"</span><span class="p">)</span>
<span class="c1"># TODO: Conflicts is too conservative</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">any</span><span class="p">(</span><span class="n">vhost</span><span class="o">.</span><span class="n">enabled</span> <span class="ow">and</span> <span class="n">vhost</span><span class="o">.</span><span class="n">conflicts</span><span class="p">(</span><span class="n">addrs</span><span class="p">)</span> <span class="k">for</span>
<span class="n">vhost</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">vhosts</span><span class="p">):</span>
<span class="n">vhost</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">make_vhost_ssl</span><span class="p">(</span><span class="n">vhost</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span>
<span class="s2">"The selected vhost would conflict with other HTTPS "</span>
<span class="s2">"VirtualHosts within Apache. Please select another "</span>
<span class="s2">"vhost or add ServerNames to your configuration."</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span>
<span class="s2">"VirtualHost not able to be selected."</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_servername_alias</span><span class="p">(</span><span class="n">target_name</span><span class="p">,</span> <span class="n">vhost</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">assoc</span><span class="p">[</span><span class="n">target_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">vhost</span>
<span class="k">return</span> <span class="n">vhost</span>
<div class="viewcode-block" id="ApacheConfigurator.included_in_wildcard"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.included_in_wildcard">[docs]</a> <span class="k">def</span> <span class="nf">included_in_wildcard</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">names</span><span class="p">,</span> <span class="n">target_name</span><span class="p">):</span>
<span class="sd">"""Is target_name covered by a wildcard?</span>
<span class="sd"> :param names: server aliases</span>
<span class="sd"> :type names: `collections.Iterable` of `str`</span>
<span class="sd"> :param str target_name: name to compare with wildcards</span>
<span class="sd"> :returns: True if target_name is covered by a wildcard,</span>
<span class="sd"> otherwise, False</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> """</span>
<span class="c1"># use lowercase strings because fnmatch can be case sensitive</span>
<span class="n">target_name</span> <span class="o">=</span> <span class="n">target_name</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">names</span><span class="p">:</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">name</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="c1"># fnmatch treats "[seq]" specially and [ or ] characters aren't</span>
<span class="c1"># valid in Apache but Apache doesn't error out if they are present</span>
<span class="k">if</span> <span class="s2">"["</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">name</span> <span class="ow">and</span> <span class="n">fnmatch</span><span class="o">.</span><span class="n">fnmatch</span><span class="p">(</span><span class="n">target_name</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">return</span> <span class="kc">False</span></div>
<div class="viewcode-block" id="ApacheConfigurator.find_best_http_vhost"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.find_best_http_vhost">[docs]</a> <span class="k">def</span> <span class="nf">find_best_http_vhost</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">target</span><span class="p">,</span> <span class="n">filter_defaults</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="s2">"80"</span><span class="p">):</span>
<span class="sd">"""Returns non-HTTPS vhost objects found from the Apache config</span>
<span class="sd"> :param str target: Domain name of the desired VirtualHost</span>
<span class="sd"> :param bool filter_defaults: whether _default_ vhosts should be</span>
<span class="sd"> included if it is the best match</span>
<span class="sd"> :param str port: port number the vhost should be listening on</span>
<span class="sd"> :returns: VirtualHost object that's the best match for target name</span>
<span class="sd"> :rtype: `obj.VirtualHost` or None</span>
<span class="sd"> """</span>
<span class="n">filtered_vhosts</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">vhost</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">vhosts</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">any</span><span class="p">(</span><span class="n">a</span><span class="o">.</span><span class="n">is_wildcard</span><span class="p">()</span> <span class="ow">or</span> <span class="n">a</span><span class="o">.</span><span class="n">get_port</span><span class="p">()</span> <span class="o">==</span> <span class="n">port</span> <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">vhost</span><span class="o">.</span><span class="n">addrs</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">vhost</span><span class="o">.</span><span class="n">ssl</span><span class="p">:</span>
<span class="n">filtered_vhosts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">vhost</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_find_best_vhost</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="n">filtered_vhosts</span><span class="p">,</span> <span class="n">filter_defaults</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheConfigurator._find_best_vhost"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._find_best_vhost">[docs]</a> <span class="k">def</span> <span class="nf">_find_best_vhost</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">target_name</span><span class="p">,</span> <span class="n">vhosts</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">filter_defaults</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">"""Finds the best vhost for a target_name.</span>
<span class="sd"> This does not upgrade a vhost to HTTPS... it only finds the most</span>
<span class="sd"> appropriate vhost for the given target_name.</span>
<span class="sd"> :param str target_name: domain handled by the desired vhost</span>
<span class="sd"> :param vhosts: vhosts to consider</span>
<span class="sd"> :type vhosts: `collections.Iterable` of :class:`~certbot_apache.obj.VirtualHost`</span>
<span class="sd"> :param bool filter_defaults: whether a vhost with a _default_</span>
<span class="sd"> addr is acceptable</span>
<span class="sd"> :returns: VHost or None</span>
<span class="sd"> """</span>
<span class="c1"># Points 6 - Servername SSL</span>
<span class="c1"># Points 5 - Wildcard SSL</span>
<span class="c1"># Points 4 - Address name with SSL</span>
<span class="c1"># Points 3 - Servername no SSL</span>
<span class="c1"># Points 2 - Wildcard no SSL</span>
<span class="c1"># Points 1 - Address name with no SSL</span>
<span class="n">best_candidate</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">best_points</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">if</span> <span class="n">vhosts</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">vhosts</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">vhosts</span>
<span class="k">for</span> <span class="n">vhost</span> <span class="ow">in</span> <span class="n">vhosts</span><span class="p">:</span>
<span class="k">if</span> <span class="n">vhost</span><span class="o">.</span><span class="n">modmacro</span> <span class="ow">is</span> <span class="kc">True</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">names</span> <span class="o">=</span> <span class="n">vhost</span><span class="o">.</span><span class="n">get_names</span><span class="p">()</span>
<span class="k">if</span> <span class="n">target_name</span> <span class="ow">in</span> <span class="n">names</span><span class="p">:</span>
<span class="n">points</span> <span class="o">=</span> <span class="mi">3</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">included_in_wildcard</span><span class="p">(</span><span class="n">names</span><span class="p">,</span> <span class="n">target_name</span><span class="p">):</span>
<span class="n">points</span> <span class="o">=</span> <span class="mi">2</span>
<span class="k">elif</span> <span class="nb">any</span><span class="p">(</span><span class="n">addr</span><span class="o">.</span><span class="n">get_addr</span><span class="p">()</span> <span class="o">==</span> <span class="n">target_name</span> <span class="k">for</span> <span class="n">addr</span> <span class="ow">in</span> <span class="n">vhost</span><span class="o">.</span><span class="n">addrs</span><span class="p">):</span>
<span class="n">points</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># No points given if names can't be found.</span>
<span class="c1"># This gets hit but doesn't register</span>
<span class="k">continue</span> <span class="c1"># pragma: no cover</span>
<span class="k">if</span> <span class="n">vhost</span><span class="o">.</span><span class="n">ssl</span><span class="p">:</span>
<span class="n">points</span> <span class="o">+=</span> <span class="mi">3</span>
<span class="k">if</span> <span class="n">points</span> <span class="o">></span> <span class="n">best_points</span><span class="p">:</span>
<span class="n">best_points</span> <span class="o">=</span> <span class="n">points</span>
<span class="n">best_candidate</span> <span class="o">=</span> <span class="n">vhost</span>
<span class="c1"># No winners here... is there only one reasonable vhost?</span>
<span class="k">if</span> <span class="n">best_candidate</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="n">filter_defaults</span><span class="p">:</span>
<span class="n">vhosts</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_non_default_vhosts</span><span class="p">(</span><span class="n">vhosts</span><span class="p">)</span>
<span class="c1"># remove mod_macro hosts from reasonable vhosts</span>
<span class="n">reasonable_vhosts</span> <span class="o">=</span> <span class="p">[</span><span class="n">vh</span> <span class="k">for</span> <span class="n">vh</span>
<span class="ow">in</span> <span class="n">vhosts</span> <span class="k">if</span> <span class="n">vh</span><span class="o">.</span><span class="n">modmacro</span> <span class="ow">is</span> <span class="kc">False</span><span class="p">]</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">reasonable_vhosts</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">best_candidate</span> <span class="o">=</span> <span class="n">reasonable_vhosts</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">return</span> <span class="n">best_candidate</span></div>
<div class="viewcode-block" id="ApacheConfigurator._non_default_vhosts"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._non_default_vhosts">[docs]</a> <span class="k">def</span> <span class="nf">_non_default_vhosts</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vhosts</span><span class="p">):</span>
<span class="sd">"""Return all non _default_ only vhosts."""</span>
<span class="k">return</span> <span class="p">[</span><span class="n">vh</span> <span class="k">for</span> <span class="n">vh</span> <span class="ow">in</span> <span class="n">vhosts</span> <span class="k">if</span> <span class="ow">not</span> <span class="nb">all</span><span class="p">(</span>
<span class="n">addr</span><span class="o">.</span><span class="n">get_addr</span><span class="p">()</span> <span class="o">==</span> <span class="s2">"_default_"</span> <span class="k">for</span> <span class="n">addr</span> <span class="ow">in</span> <span class="n">vh</span><span class="o">.</span><span class="n">addrs</span>
<span class="p">)]</span></div>
<div class="viewcode-block" id="ApacheConfigurator.get_all_names"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.get_all_names">[docs]</a> <span class="k">def</span> <span class="nf">get_all_names</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Returns all names found in the Apache Configuration.</span>
<span class="sd"> :returns: All ServerNames, ServerAliases, and reverse DNS entries for</span>
<span class="sd"> virtual host addresses</span>
<span class="sd"> :rtype: set</span>
<span class="sd"> """</span>
<span class="n">all_names</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="n">vhost_macro</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">vhost</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">vhosts</span><span class="p">:</span>
<span class="n">all_names</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">vhost</span><span class="o">.</span><span class="n">get_names</span><span class="p">())</span>
<span class="k">if</span> <span class="n">vhost</span><span class="o">.</span><span class="n">modmacro</span><span class="p">:</span>
<span class="n">vhost_macro</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">vhost</span><span class="o">.</span><span class="n">filep</span><span class="p">)</span>
<span class="k">for</span> <span class="n">addr</span> <span class="ow">in</span> <span class="n">vhost</span><span class="o">.</span><span class="n">addrs</span><span class="p">:</span>
<span class="k">if</span> <span class="n">common</span><span class="o">.</span><span class="n">hostname_regex</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">addr</span><span class="o">.</span><span class="n">get_addr</span><span class="p">()):</span>
<span class="n">all_names</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">addr</span><span class="o">.</span><span class="n">get_addr</span><span class="p">())</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_name_from_ip</span><span class="p">(</span><span class="n">addr</span><span class="p">)</span>
<span class="k">if</span> <span class="n">name</span><span class="p">:</span>
<span class="n">all_names</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">vhost_macro</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
<span class="n">zope</span><span class="o">.</span><span class="n">component</span><span class="o">.</span><span class="n">getUtility</span><span class="p">(</span><span class="n">interfaces</span><span class="o">.</span><span class="n">IDisplay</span><span class="p">)</span><span class="o">.</span><span class="n">notification</span><span class="p">(</span>
<span class="s2">"Apache mod_macro seems to be in use in file(s):</span><span class="se">\n</span><span class="si">{0}</span><span class="s2">"</span>
<span class="s2">"</span><span class="se">\n\n</span><span class="s2">Unfortunately mod_macro is not yet supported"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="s2">"</span><span class="se">\n</span><span class="s2"> "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">vhost_macro</span><span class="p">)),</span> <span class="n">force_interactive</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">return</span> <span class="n">util</span><span class="o">.</span><span class="n">get_filtered_names</span><span class="p">(</span><span class="n">all_names</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheConfigurator.get_name_from_ip"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.get_name_from_ip">[docs]</a> <span class="k">def</span> <span class="nf">get_name_from_ip</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">addr</span><span class="p">):</span> <span class="c1"># pylint: disable=no-self-use</span>
<span class="sd">"""Returns a reverse dns name if available.</span>
<span class="sd"> :param addr: IP Address</span>
<span class="sd"> :type addr: ~.common.Addr</span>
<span class="sd"> :returns: name or empty string if name cannot be determined</span>
<span class="sd"> :rtype: str</span>
<span class="sd"> """</span>
<span class="c1"># If it isn't a private IP, do a reverse DNS lookup</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">common</span><span class="o">.</span><span class="n">private_ips_regex</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">addr</span><span class="o">.</span><span class="n">get_addr</span><span class="p">()):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">socket</span><span class="o">.</span><span class="n">inet_aton</span><span class="p">(</span><span class="n">addr</span><span class="o">.</span><span class="n">get_addr</span><span class="p">())</span>
<span class="k">return</span> <span class="n">socket</span><span class="o">.</span><span class="n">gethostbyaddr</span><span class="p">(</span><span class="n">addr</span><span class="o">.</span><span class="n">get_addr</span><span class="p">())[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">except</span> <span class="p">(</span><span class="n">socket</span><span class="o">.</span><span class="n">error</span><span class="p">,</span> <span class="n">socket</span><span class="o">.</span><span class="n">herror</span><span class="p">,</span> <span class="n">socket</span><span class="o">.</span><span class="n">timeout</span><span class="p">):</span>
<span class="k">pass</span>
<span class="k">return</span> <span class="s2">""</span></div>
<div class="viewcode-block" id="ApacheConfigurator._get_vhost_names"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._get_vhost_names">[docs]</a> <span class="k">def</span> <span class="nf">_get_vhost_names</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
<span class="sd">"""Helper method for getting the ServerName and</span>
<span class="sd"> ServerAlias values from vhost in path</span>
<span class="sd"> :param path: Path to read ServerName and ServerAliases from</span>
<span class="sd"> :returns: Tuple including ServerName and `list` of ServerAlias strings</span>
<span class="sd"> """</span>
<span class="n">servername_match</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span>
<span class="s2">"ServerName"</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="n">path</span><span class="p">,</span> <span class="n">exclude</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="n">serveralias_match</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span>
<span class="s2">"ServerAlias"</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="n">path</span><span class="p">,</span> <span class="n">exclude</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="n">serveraliases</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">alias</span> <span class="ow">in</span> <span class="n">serveralias_match</span><span class="p">:</span>
<span class="n">serveralias</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">get_arg</span><span class="p">(</span><span class="n">alias</span><span class="p">)</span>
<span class="n">serveraliases</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">serveralias</span><span class="p">)</span>
<span class="n">servername</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="n">servername_match</span><span class="p">:</span>
<span class="c1"># Get last ServerName as each overwrites the previous</span>
<span class="n">servername</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">get_arg</span><span class="p">(</span><span class="n">servername_match</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span>
<span class="k">return</span> <span class="p">(</span><span class="n">servername</span><span class="p">,</span> <span class="n">serveraliases</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheConfigurator._add_servernames"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._add_servernames">[docs]</a> <span class="k">def</span> <span class="nf">_add_servernames</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">host</span><span class="p">):</span>
<span class="sd">"""Helper function for get_virtual_hosts().</span>
<span class="sd"> :param host: In progress vhost whose names will be added</span>
<span class="sd"> :type host: :class:`~certbot_apache.obj.VirtualHost`</span>
<span class="sd"> """</span>
<span class="n">servername</span><span class="p">,</span> <span class="n">serveraliases</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_vhost_names</span><span class="p">(</span><span class="n">host</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
<span class="k">for</span> <span class="n">alias</span> <span class="ow">in</span> <span class="n">serveraliases</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">host</span><span class="o">.</span><span class="n">modmacro</span><span class="p">:</span>
<span class="n">host</span><span class="o">.</span><span class="n">aliases</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">alias</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">host</span><span class="o">.</span><span class="n">modmacro</span><span class="p">:</span>
<span class="n">host</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">servername</span></div>
<div class="viewcode-block" id="ApacheConfigurator._create_vhost"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._create_vhost">[docs]</a> <span class="k">def</span> <span class="nf">_create_vhost</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
<span class="sd">"""Used by get_virtual_hosts to create vhost objects</span>
<span class="sd"> :param str path: Augeas path to virtual host</span>
<span class="sd"> :returns: newly created vhost</span>
<span class="sd"> :rtype: :class:`~certbot_apache.obj.VirtualHost`</span>
<span class="sd"> """</span>
<span class="n">addrs</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">args</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">path</span> <span class="o">+</span> <span class="s2">"/arg"</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">RuntimeError</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">"Encountered a problem while parsing file: </span><span class="si">%s</span><span class="s2">, skipping"</span><span class="p">,</span> <span class="n">path</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">args</span><span class="p">:</span>
<span class="n">addrs</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">obj</span><span class="o">.</span><span class="n">Addr</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">get_arg</span><span class="p">(</span><span class="n">arg</span><span class="p">)))</span>
<span class="n">is_ssl</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span><span class="s2">"SSLEngine"</span><span class="p">,</span> <span class="s2">"on"</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="n">path</span><span class="p">,</span> <span class="n">exclude</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="n">is_ssl</span> <span class="o">=</span> <span class="kc">True</span>
<span class="c1"># "SSLEngine on" might be set outside of <VirtualHost></span>
<span class="c1"># Treat vhosts with port 443 as ssl vhosts</span>
<span class="k">for</span> <span class="n">addr</span> <span class="ow">in</span> <span class="n">addrs</span><span class="p">:</span>
<span class="k">if</span> <span class="n">addr</span><span class="o">.</span><span class="n">get_port</span><span class="p">()</span> <span class="o">==</span> <span class="s2">"443"</span><span class="p">:</span>
<span class="n">is_ssl</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">filename</span> <span class="o">=</span> <span class="n">apache_util</span><span class="o">.</span><span class="n">get_file_path</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"/augeas/files</span><span class="si">%s</span><span class="s2">/path"</span> <span class="o">%</span> <span class="n">apache_util</span><span class="o">.</span><span class="n">get_file_path</span><span class="p">(</span><span class="n">path</span><span class="p">)))</span>
<span class="k">if</span> <span class="n">filename</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="n">macro</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">if</span> <span class="s2">"/macro/"</span> <span class="ow">in</span> <span class="n">path</span><span class="o">.</span><span class="n">lower</span><span class="p">():</span>
<span class="n">macro</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">vhost_enabled</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">parsed_in_original</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
<span class="n">vhost</span> <span class="o">=</span> <span class="n">obj</span><span class="o">.</span><span class="n">VirtualHost</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">addrs</span><span class="p">,</span> <span class="n">is_ssl</span><span class="p">,</span>
<span class="n">vhost_enabled</span><span class="p">,</span> <span class="n">modmacro</span><span class="o">=</span><span class="n">macro</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_servernames</span><span class="p">(</span><span class="n">vhost</span><span class="p">)</span>
<span class="k">return</span> <span class="n">vhost</span></div>
<div class="viewcode-block" id="ApacheConfigurator.get_virtual_hosts"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.get_virtual_hosts">[docs]</a> <span class="k">def</span> <span class="nf">get_virtual_hosts</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Returns list of virtual hosts found in the Apache configuration.</span>
<span class="sd"> :returns: List of :class:`~certbot_apache.obj.VirtualHost`</span>
<span class="sd"> objects found in configuration</span>
<span class="sd"> :rtype: list</span>
<span class="sd"> """</span>
<span class="c1"># Search base config, and all included paths for VirtualHosts</span>
<span class="n">file_paths</span> <span class="o">=</span> <span class="p">{}</span>
<span class="n">internal_paths</span> <span class="o">=</span> <span class="n">defaultdict</span><span class="p">(</span><span class="nb">set</span><span class="p">)</span>
<span class="n">vhs</span> <span class="o">=</span> <span class="p">[]</span>
<span class="c1"># Make a list of parser paths because the parser_paths</span>
<span class="c1"># dictionary may be modified during the loop.</span>
<span class="k">for</span> <span class="n">vhost_path</span> <span class="ow">in</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">parser_paths</span><span class="p">):</span>
<span class="n">paths</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">match</span><span class="p">(</span>
<span class="p">(</span><span class="s2">"/files</span><span class="si">%s</span><span class="s2">//*[label()=~regexp('</span><span class="si">%s</span><span class="s2">')]"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">vhost_path</span><span class="p">,</span> <span class="n">parser</span><span class="o">.</span><span class="n">case_i</span><span class="p">(</span><span class="s2">"VirtualHost"</span><span class="p">))))</span>
<span class="n">paths</span> <span class="o">=</span> <span class="p">[</span><span class="n">path</span> <span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">paths</span> <span class="k">if</span>
<span class="s2">"virtualhost"</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">path</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()]</span>
<span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">paths</span><span class="p">:</span>
<span class="n">new_vhost</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_create_vhost</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">new_vhost</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">internal_path</span> <span class="o">=</span> <span class="n">apache_util</span><span class="o">.</span><span class="n">get_internal_aug_path</span><span class="p">(</span><span class="n">new_vhost</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
<span class="n">realpath</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">realpath</span><span class="p">(</span><span class="n">new_vhost</span><span class="o">.</span><span class="n">filep</span><span class="p">)</span>
<span class="k">if</span> <span class="n">realpath</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">file_paths</span><span class="p">:</span>
<span class="n">file_paths</span><span class="p">[</span><span class="n">realpath</span><span class="p">]</span> <span class="o">=</span> <span class="n">new_vhost</span><span class="o">.</span><span class="n">filep</span>
<span class="n">internal_paths</span><span class="p">[</span><span class="n">realpath</span><span class="p">]</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">internal_path</span><span class="p">)</span>
<span class="n">vhs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">new_vhost</span><span class="p">)</span>
<span class="k">elif</span> <span class="p">(</span><span class="n">realpath</span> <span class="o">==</span> <span class="n">new_vhost</span><span class="o">.</span><span class="n">filep</span> <span class="ow">and</span>
<span class="n">realpath</span> <span class="o">!=</span> <span class="n">file_paths</span><span class="p">[</span><span class="n">realpath</span><span class="p">]):</span>
<span class="c1"># Prefer "real" vhost paths instead of symlinked ones</span>
<span class="c1"># ex: sites-enabled/vh.conf -> sites-available/vh.conf</span>
<span class="c1"># remove old (most likely) symlinked one</span>
<span class="n">new_vhs</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">vhs</span><span class="p">:</span>
<span class="k">if</span> <span class="n">v</span><span class="o">.</span><span class="n">filep</span> <span class="o">==</span> <span class="n">file_paths</span><span class="p">[</span><span class="n">realpath</span><span class="p">]:</span>
<span class="n">internal_paths</span><span class="p">[</span><span class="n">realpath</span><span class="p">]</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span>
<span class="n">apache_util</span><span class="o">.</span><span class="n">get_internal_aug_path</span><span class="p">(</span><span class="n">v</span><span class="o">.</span><span class="n">path</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">new_vhs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="n">vhs</span> <span class="o">=</span> <span class="n">new_vhs</span>
<span class="n">file_paths</span><span class="p">[</span><span class="n">realpath</span><span class="p">]</span> <span class="o">=</span> <span class="n">realpath</span>
<span class="n">internal_paths</span><span class="p">[</span><span class="n">realpath</span><span class="p">]</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">internal_path</span><span class="p">)</span>
<span class="n">vhs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">new_vhost</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">internal_path</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">internal_paths</span><span class="p">[</span><span class="n">realpath</span><span class="p">]:</span>
<span class="n">internal_paths</span><span class="p">[</span><span class="n">realpath</span><span class="p">]</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">internal_path</span><span class="p">)</span>
<span class="n">vhs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">new_vhost</span><span class="p">)</span>
<span class="k">return</span> <span class="n">vhs</span></div>
<div class="viewcode-block" id="ApacheConfigurator.is_name_vhost"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.is_name_vhost">[docs]</a> <span class="k">def</span> <span class="nf">is_name_vhost</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">target_addr</span><span class="p">):</span>
<span class="sd">"""Returns if vhost is a name based vhost</span>
<span class="sd"> NameVirtualHost was deprecated in Apache 2.4 as all VirtualHosts are</span>
<span class="sd"> now NameVirtualHosts. If version is earlier than 2.4, check if addr</span>
<span class="sd"> has a NameVirtualHost directive in the Apache config</span>
<span class="sd"> :param certbot_apache.obj.Addr target_addr: vhost address</span>
<span class="sd"> :returns: Success</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> """</span>
<span class="c1"># Mixed and matched wildcard NameVirtualHost with VirtualHost</span>
<span class="c1"># behavior is undefined. Make sure that an exact match exists</span>
<span class="c1"># search for NameVirtualHost directive for ip_addr</span>
<span class="c1"># note ip_addr can be FQDN although Apache does not recommend it</span>
<span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">version</span> <span class="o">>=</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span> <span class="ow">or</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span><span class="s2">"NameVirtualHost"</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">target_addr</span><span class="p">)))</span></div>
<div class="viewcode-block" id="ApacheConfigurator.add_name_vhost"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.add_name_vhost">[docs]</a> <span class="k">def</span> <span class="nf">add_name_vhost</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">addr</span><span class="p">):</span>
<span class="sd">"""Adds NameVirtualHost directive for given address.</span>
<span class="sd"> :param addr: Address that will be added as NameVirtualHost directive</span>
<span class="sd"> :type addr: :class:`~certbot_apache.obj.Addr`</span>
<span class="sd"> """</span>
<span class="n">loc</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">get_aug_path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s2">"name"</span><span class="p">])</span>
<span class="k">if</span> <span class="n">addr</span><span class="o">.</span><span class="n">get_port</span><span class="p">()</span> <span class="o">==</span> <span class="s2">"443"</span><span class="p">:</span>
<span class="n">path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">add_dir_to_ifmodssl</span><span class="p">(</span>
<span class="n">loc</span><span class="p">,</span> <span class="s2">"NameVirtualHost"</span><span class="p">,</span> <span class="p">[</span><span class="nb">str</span><span class="p">(</span><span class="n">addr</span><span class="p">)])</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">add_dir</span><span class="p">(</span><span class="n">loc</span><span class="p">,</span> <span class="s2">"NameVirtualHost"</span><span class="p">,</span> <span class="p">[</span><span class="nb">str</span><span class="p">(</span><span class="n">addr</span><span class="p">)])</span>
<span class="n">msg</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"Setting </span><span class="si">%s</span><span class="s2"> to be NameBasedVirtualHost</span><span class="se">\n</span><span class="s2">"</span>
<span class="s2">"</span><span class="se">\t</span><span class="s2">Directive added to </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">addr</span><span class="p">,</span> <span class="n">path</span><span class="p">))</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save_notes</span> <span class="o">+=</span> <span class="n">msg</span></div>
<div class="viewcode-block" id="ApacheConfigurator.prepare_server_https"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.prepare_server_https">[docs]</a> <span class="k">def</span> <span class="nf">prepare_server_https</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">temp</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""Prepare the server for HTTPS.</span>
<span class="sd"> Make sure that the ssl_module is loaded and that the server</span>
<span class="sd"> is appropriately listening on port.</span>
<span class="sd"> :param str port: Port to listen on</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prepare_https_modules</span><span class="p">(</span><span class="n">temp</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ensure_listen</span><span class="p">(</span><span class="n">port</span><span class="p">,</span> <span class="n">https</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheConfigurator.ensure_listen"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.ensure_listen">[docs]</a> <span class="k">def</span> <span class="nf">ensure_listen</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">https</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""Make sure that Apache is listening on the port. Checks if the</span>
<span class="sd"> Listen statement for the port already exists, and adds it to the</span>
<span class="sd"> configuration if necessary.</span>
<span class="sd"> :param str port: Port number to check and add Listen for if not in</span>
<span class="sd"> place already</span>
<span class="sd"> :param bool https: If the port will be used for HTTPS</span>
<span class="sd"> """</span>
<span class="c1"># If HTTPS requested for nonstandard port, add service definition</span>
<span class="k">if</span> <span class="n">https</span> <span class="ow">and</span> <span class="n">port</span> <span class="o">!=</span> <span class="s2">"443"</span><span class="p">:</span>
<span class="n">port_service</span> <span class="o">=</span> <span class="s2">"</span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">port</span><span class="p">,</span> <span class="s2">"https"</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">port_service</span> <span class="o">=</span> <span class="n">port</span>
<span class="c1"># Check for Listen <port></span>
<span class="c1"># Note: This could be made to also look for ip:443 combo</span>
<span class="n">listens</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">get_arg</span><span class="p">(</span><span class="n">x</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span>
<span class="n">x</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span><span class="s2">"Listen"</span><span class="p">)]</span>
<span class="c1"># Listen already in place</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_has_port_already</span><span class="p">(</span><span class="n">listens</span><span class="p">,</span> <span class="n">port</span><span class="p">):</span>
<span class="k">return</span>
<span class="n">listen_dirs</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">listens</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">listens</span><span class="p">:</span>
<span class="n">listen_dirs</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">port_service</span><span class="p">)</span>
<span class="k">for</span> <span class="n">listen</span> <span class="ow">in</span> <span class="n">listens</span><span class="p">:</span>
<span class="c1"># For any listen statement, check if the machine also listens on</span>
<span class="c1"># the given port. If not, add such a listen statement.</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">listen</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">":"</span><span class="p">))</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="c1"># Its listening to all interfaces</span>
<span class="k">if</span> <span class="n">port</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">listen_dirs</span> <span class="ow">and</span> <span class="n">port_service</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">listen_dirs</span><span class="p">:</span>
<span class="n">listen_dirs</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">port_service</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># The Listen statement specifies an ip</span>
<span class="n">_</span><span class="p">,</span> <span class="n">ip</span> <span class="o">=</span> <span class="n">listen</span><span class="p">[::</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">":"</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="n">ip</span> <span class="o">=</span> <span class="n">ip</span><span class="p">[::</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="k">if</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">:</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">ip</span><span class="p">,</span> <span class="n">port_service</span><span class="p">)</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">listen_dirs</span> <span class="ow">and</span> <span class="p">(</span>
<span class="s2">"</span><span class="si">%s</span><span class="s2">:</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">ip</span><span class="p">,</span> <span class="n">port_service</span><span class="p">)</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">listen_dirs</span><span class="p">):</span>
<span class="n">listen_dirs</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2">:</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">ip</span><span class="p">,</span> <span class="n">port_service</span><span class="p">))</span>
<span class="k">if</span> <span class="n">https</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_listens_https</span><span class="p">(</span><span class="n">listen_dirs</span><span class="p">,</span> <span class="n">listens</span><span class="p">,</span> <span class="n">port</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_listens_http</span><span class="p">(</span><span class="n">listen_dirs</span><span class="p">,</span> <span class="n">listens</span><span class="p">,</span> <span class="n">port</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheConfigurator._add_listens_http"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._add_listens_http">[docs]</a> <span class="k">def</span> <span class="nf">_add_listens_http</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">listens</span><span class="p">,</span> <span class="n">listens_orig</span><span class="p">,</span> <span class="n">port</span><span class="p">):</span>
<span class="sd">"""Helper method for ensure_listen to figure out which new</span>
<span class="sd"> listen statements need adding for listening HTTP on port</span>
<span class="sd"> :param set listens: Set of all needed Listen statements</span>
<span class="sd"> :param list listens_orig: List of existing listen statements</span>
<span class="sd"> :param string port: Port number we're adding</span>
<span class="sd"> """</span>
<span class="n">new_listens</span> <span class="o">=</span> <span class="n">listens</span><span class="o">.</span><span class="n">difference</span><span class="p">(</span><span class="n">listens_orig</span><span class="p">)</span>
<span class="k">if</span> <span class="n">port</span> <span class="ow">in</span> <span class="n">new_listens</span><span class="p">:</span>
<span class="c1"># We have wildcard, skip the rest</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">add_dir</span><span class="p">(</span><span class="n">parser</span><span class="o">.</span><span class="n">get_aug_path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s2">"listen"</span><span class="p">]),</span>
<span class="s2">"Listen"</span><span class="p">,</span> <span class="n">port</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save_notes</span> <span class="o">+=</span> <span class="s2">"Added Listen </span><span class="si">%s</span><span class="s2"> directive to </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span>
<span class="n">port</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s2">"listen"</span><span class="p">])</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">for</span> <span class="n">listen</span> <span class="ow">in</span> <span class="n">new_listens</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">add_dir</span><span class="p">(</span><span class="n">parser</span><span class="o">.</span><span class="n">get_aug_path</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s2">"listen"</span><span class="p">]),</span> <span class="s2">"Listen"</span><span class="p">,</span> <span class="n">listen</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">" "</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save_notes</span> <span class="o">+=</span> <span class="p">(</span><span class="s2">"Added Listen </span><span class="si">%s</span><span class="s2"> directive to "</span>
<span class="s2">"</span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="p">(</span><span class="n">listen</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s2">"listen"</span><span class="p">])</span></div>
<div class="viewcode-block" id="ApacheConfigurator._add_listens_https"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._add_listens_https">[docs]</a> <span class="k">def</span> <span class="nf">_add_listens_https</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">listens</span><span class="p">,</span> <span class="n">listens_orig</span><span class="p">,</span> <span class="n">port</span><span class="p">):</span>
<span class="sd">"""Helper method for ensure_listen to figure out which new</span>
<span class="sd"> listen statements need adding for listening HTTPS on port</span>
<span class="sd"> :param set listens: Set of all needed Listen statements</span>
<span class="sd"> :param list listens_orig: List of existing listen statements</span>
<span class="sd"> :param string port: Port number we're adding</span>
<span class="sd"> """</span>
<span class="c1"># Add service definition for non-standard ports</span>
<span class="k">if</span> <span class="n">port</span> <span class="o">!=</span> <span class="s2">"443"</span><span class="p">:</span>
<span class="n">port_service</span> <span class="o">=</span> <span class="s2">"</span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">port</span><span class="p">,</span> <span class="s2">"https"</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">port_service</span> <span class="o">=</span> <span class="n">port</span>
<span class="n">new_listens</span> <span class="o">=</span> <span class="n">listens</span><span class="o">.</span><span class="n">difference</span><span class="p">(</span><span class="n">listens_orig</span><span class="p">)</span>
<span class="k">if</span> <span class="n">port</span> <span class="ow">in</span> <span class="n">new_listens</span> <span class="ow">or</span> <span class="n">port_service</span> <span class="ow">in</span> <span class="n">new_listens</span><span class="p">:</span>
<span class="c1"># We have wildcard, skip the rest</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">add_dir_to_ifmodssl</span><span class="p">(</span>
<span class="n">parser</span><span class="o">.</span><span class="n">get_aug_path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s2">"listen"</span><span class="p">]),</span>
<span class="s2">"Listen"</span><span class="p">,</span> <span class="n">port_service</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">" "</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save_notes</span> <span class="o">+=</span> <span class="s2">"Added Listen </span><span class="si">%s</span><span class="s2"> directive to </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span>
<span class="n">port_service</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s2">"listen"</span><span class="p">])</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">for</span> <span class="n">listen</span> <span class="ow">in</span> <span class="n">new_listens</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">add_dir_to_ifmodssl</span><span class="p">(</span>
<span class="n">parser</span><span class="o">.</span><span class="n">get_aug_path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s2">"listen"</span><span class="p">]),</span>
<span class="s2">"Listen"</span><span class="p">,</span> <span class="n">listen</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">" "</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save_notes</span> <span class="o">+=</span> <span class="p">(</span><span class="s2">"Added Listen </span><span class="si">%s</span><span class="s2"> directive to "</span>
<span class="s2">"</span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span> <span class="o">%</span> <span class="p">(</span><span class="n">listen</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s2">"listen"</span><span class="p">])</span></div>
<div class="viewcode-block" id="ApacheConfigurator._has_port_already"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._has_port_already">[docs]</a> <span class="k">def</span> <span class="nf">_has_port_already</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">listens</span><span class="p">,</span> <span class="n">port</span><span class="p">):</span>
<span class="sd">"""Helper method for prepare_server_https to find out if user</span>
<span class="sd"> already has an active Listen statement for the port we need</span>
<span class="sd"> :param list listens: List of listen variables</span>
<span class="sd"> :param string port: Port in question</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">port</span> <span class="ow">in</span> <span class="n">listens</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="c1"># Check if Apache is already listening on a specific IP</span>
<span class="k">for</span> <span class="n">listen</span> <span class="ow">in</span> <span class="n">listens</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">listen</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">":"</span><span class="p">))</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
<span class="c1"># Ugly but takes care of protocol def, eg: 1.1.1.1:443 https</span>
<span class="k">if</span> <span class="n">listen</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">":"</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">" "</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="n">port</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="ApacheConfigurator.prepare_https_modules"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.prepare_https_modules">[docs]</a> <span class="k">def</span> <span class="nf">prepare_https_modules</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">temp</span><span class="p">):</span>
<span class="sd">"""Helper method for prepare_server_https, taking care of enabling</span>
<span class="sd"> needed modules</span>
<span class="sd"> :param boolean temp: If the change is temporary</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">conf</span><span class="p">(</span><span class="s2">"handle-modules"</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">version</span> <span class="o">>=</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span> <span class="ow">and</span> <span class="p">(</span><span class="s2">"socache_shmcb_module"</span> <span class="ow">not</span> <span class="ow">in</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">modules</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">enable_mod</span><span class="p">(</span><span class="s2">"socache_shmcb"</span><span class="p">,</span> <span class="n">temp</span><span class="o">=</span><span class="n">temp</span><span class="p">)</span>
<span class="k">if</span> <span class="s2">"ssl_module"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">modules</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">enable_mod</span><span class="p">(</span><span class="s2">"ssl"</span><span class="p">,</span> <span class="n">temp</span><span class="o">=</span><span class="n">temp</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheConfigurator.make_addrs_sni_ready"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.make_addrs_sni_ready">[docs]</a> <span class="k">def</span> <span class="nf">make_addrs_sni_ready</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">addrs</span><span class="p">):</span>
<span class="sd">"""Checks to see if the server is ready for SNI challenges.</span>
<span class="sd"> :param addrs: Addresses to check SNI compatibility</span>
<span class="sd"> :type addrs: :class:`~certbot_apache.obj.Addr`</span>
<span class="sd"> """</span>
<span class="c1"># Version 2.4 and later are automatically SNI ready.</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">version</span> <span class="o">>=</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">4</span><span class="p">):</span>
<span class="k">return</span>
<span class="k">for</span> <span class="n">addr</span> <span class="ow">in</span> <span class="n">addrs</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_name_vhost</span><span class="p">(</span><span class="n">addr</span><span class="p">):</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"Setting VirtualHost at </span><span class="si">%s</span><span class="s2"> to be a name "</span>
<span class="s2">"based virtual host"</span><span class="p">,</span> <span class="n">addr</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add_name_vhost</span><span class="p">(</span><span class="n">addr</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheConfigurator.make_vhost_ssl"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.make_vhost_ssl">[docs]</a> <span class="k">def</span> <span class="nf">make_vhost_ssl</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nonssl_vhost</span><span class="p">):</span> <span class="c1"># pylint: disable=too-many-locals</span>
<span class="sd">"""Makes an ssl_vhost version of a nonssl_vhost.</span>
<span class="sd"> Duplicates vhost and adds default ssl options</span>
<span class="sd"> New vhost will reside as (nonssl_vhost.path) +</span>
<span class="sd"> ``self.constant("le_vhost_ext")``</span>
<span class="sd"> .. note:: This function saves the configuration</span>
<span class="sd"> :param nonssl_vhost: Valid VH that doesn't have SSLEngine on</span>
<span class="sd"> :type nonssl_vhost: :class:`~certbot_apache.obj.VirtualHost`</span>
<span class="sd"> :returns: SSL vhost</span>
<span class="sd"> :rtype: :class:`~certbot_apache.obj.VirtualHost`</span>
<span class="sd"> :raises .errors.PluginError: If more than one virtual host is in</span>
<span class="sd"> the file or if plugin is unable to write/read vhost files.</span>
<span class="sd"> """</span>
<span class="n">avail_fp</span> <span class="o">=</span> <span class="n">nonssl_vhost</span><span class="o">.</span><span class="n">filep</span>
<span class="n">ssl_fp</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_ssl_vhost_path</span><span class="p">(</span><span class="n">avail_fp</span><span class="p">)</span>
<span class="n">orig_matches</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s2">"/files</span><span class="si">%s</span><span class="s2">//* [label()=~regexp('</span><span class="si">%s</span><span class="s2">')]"</span> <span class="o">%</span>
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_escape</span><span class="p">(</span><span class="n">ssl_fp</span><span class="p">),</span>
<span class="n">parser</span><span class="o">.</span><span class="n">case_i</span><span class="p">(</span><span class="s2">"VirtualHost"</span><span class="p">)))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_copy_create_ssl_vhost_skeleton</span><span class="p">(</span><span class="n">nonssl_vhost</span><span class="p">,</span> <span class="n">ssl_fp</span><span class="p">)</span>
<span class="c1"># Reload augeas to take into account the new vhost</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="c1"># Get Vhost augeas path for new vhost</span>
<span class="n">new_matches</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s2">"/files</span><span class="si">%s</span><span class="s2">//* [label()=~regexp('</span><span class="si">%s</span><span class="s2">')]"</span> <span class="o">%</span>
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_escape</span><span class="p">(</span><span class="n">ssl_fp</span><span class="p">),</span>
<span class="n">parser</span><span class="o">.</span><span class="n">case_i</span><span class="p">(</span><span class="s2">"VirtualHost"</span><span class="p">)))</span>
<span class="n">vh_p</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_new_vh_path</span><span class="p">(</span><span class="n">orig_matches</span><span class="p">,</span> <span class="n">new_matches</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">vh_p</span><span class="p">:</span>
<span class="c1"># The vhost was not found on the currently parsed paths</span>
<span class="c1"># Make Augeas aware of the new vhost</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">parse_file</span><span class="p">(</span><span class="n">ssl_fp</span><span class="p">)</span>
<span class="c1"># Try to search again</span>
<span class="n">new_matches</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">match</span><span class="p">(</span>
<span class="s2">"/files</span><span class="si">%s</span><span class="s2">//* [label()=~regexp('</span><span class="si">%s</span><span class="s2">')]"</span> <span class="o">%</span>
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_escape</span><span class="p">(</span><span class="n">ssl_fp</span><span class="p">),</span>
<span class="n">parser</span><span class="o">.</span><span class="n">case_i</span><span class="p">(</span><span class="s2">"VirtualHost"</span><span class="p">)))</span>
<span class="n">vh_p</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_new_vh_path</span><span class="p">(</span><span class="n">orig_matches</span><span class="p">,</span> <span class="n">new_matches</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">vh_p</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span>
<span class="s2">"Could not reverse map the HTTPS VirtualHost to the original"</span><span class="p">)</span>
<span class="c1"># Update Addresses</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_update_ssl_vhosts_addrs</span><span class="p">(</span><span class="n">vh_p</span><span class="p">)</span>
<span class="c1"># Log actions and create save notes</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"Created an SSL vhost at </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">ssl_fp</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save_notes</span> <span class="o">+=</span> <span class="s2">"Created ssl vhost at </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">ssl_fp</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
<span class="c1"># We know the length is one because of the assertion above</span>
<span class="c1"># Create the Vhost object</span>
<span class="n">ssl_vhost</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_create_vhost</span><span class="p">(</span><span class="n">vh_p</span><span class="p">)</span>
<span class="n">ssl_vhost</span><span class="o">.</span><span class="n">ancestor</span> <span class="o">=</span> <span class="n">nonssl_vhost</span>
<span class="bp">self</span><span class="o">.</span><span class="n">vhosts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">ssl_vhost</span><span class="p">)</span>
<span class="c1"># NOTE: Searches through Augeas seem to ruin changes to directives</span>
<span class="c1"># The configuration must also be saved before being searched</span>
<span class="c1"># for the new directives; For these reasons... this is tacked</span>
<span class="c1"># on after fully creating the new vhost</span>
<span class="c1"># Now check if addresses need to be added as NameBasedVhost addrs</span>
<span class="c1"># This is for compliance with versions of Apache < 2.4</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_name_vhost_if_necessary</span><span class="p">(</span><span class="n">ssl_vhost</span><span class="p">)</span>
<span class="k">return</span> <span class="n">ssl_vhost</span></div>
<div class="viewcode-block" id="ApacheConfigurator._get_new_vh_path"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._get_new_vh_path">[docs]</a> <span class="k">def</span> <span class="nf">_get_new_vh_path</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">orig_matches</span><span class="p">,</span> <span class="n">new_matches</span><span class="p">):</span>
<span class="sd">""" Helper method for make_vhost_ssl for matching augeas paths. Returns</span>
<span class="sd"> VirtualHost path from new_matches that's not present in orig_matches.</span>
<span class="sd"> Paths are normalized, because augeas leaves indices out for paths</span>
<span class="sd"> with only single directive with a similar key """</span>
<span class="n">orig_matches</span> <span class="o">=</span> <span class="p">[</span><span class="n">i</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"[1]"</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">orig_matches</span><span class="p">]</span>
<span class="k">for</span> <span class="n">match</span> <span class="ow">in</span> <span class="n">new_matches</span><span class="p">:</span>
<span class="k">if</span> <span class="n">match</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"[1]"</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">orig_matches</span><span class="p">:</span>
<span class="c1"># Return the unmodified path</span>
<span class="k">return</span> <span class="n">match</span>
<span class="k">return</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="ApacheConfigurator._get_ssl_vhost_path"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._get_ssl_vhost_path">[docs]</a> <span class="k">def</span> <span class="nf">_get_ssl_vhost_path</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">non_ssl_vh_fp</span><span class="p">):</span>
<span class="sd">""" Get a file path for SSL vhost, uses user defined path as priority,</span>
<span class="sd"> but if the value is invalid or not defined, will fall back to non-ssl</span>
<span class="sd"> vhost filepath.</span>
<span class="sd"> :param str non_ssl_vh_fp: Filepath of non-SSL vhost</span>
<span class="sd"> :returns: Filepath for SSL vhost</span>
<span class="sd"> :rtype: str</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">conf</span><span class="p">(</span><span class="s2">"vhost-root"</span><span class="p">)</span> <span class="ow">and</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">conf</span><span class="p">(</span><span class="s2">"vhost-root"</span><span class="p">)):</span>
<span class="c1"># Defined by user on CLI</span>
<span class="n">fp</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">realpath</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">vhostroot</span><span class="p">),</span>
<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">non_ssl_vh_fp</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Use non-ssl filepath</span>
<span class="n">fp</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">realpath</span><span class="p">(</span><span class="n">non_ssl_vh_fp</span><span class="p">)</span>
<span class="k">if</span> <span class="n">fp</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">".conf"</span><span class="p">):</span>
<span class="k">return</span> <span class="n">fp</span><span class="p">[:</span><span class="o">-</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="s2">".conf"</span><span class="p">))]</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">conf</span><span class="p">(</span><span class="s2">"le_vhost_ext"</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">fp</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">conf</span><span class="p">(</span><span class="s2">"le_vhost_ext"</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheConfigurator._sift_rewrite_rule"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._sift_rewrite_rule">[docs]</a> <span class="k">def</span> <span class="nf">_sift_rewrite_rule</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">line</span><span class="p">):</span>
<span class="sd">"""Decides whether a line should be copied to a SSL vhost.</span>
<span class="sd"> A canonical example of when sifting a line is required:</span>
<span class="sd"> When the http vhost contains a RewriteRule that unconditionally</span>
<span class="sd"> redirects any request to the https version of the same site.</span>
<span class="sd"> e.g:</span>
<span class="sd"> RewriteRule ^ https://%{SERVER_NAME}%{REQUEST_URI} [L,QSA,R=permanent]</span>
<span class="sd"> Copying the above line to the ssl vhost would cause a</span>
<span class="sd"> redirection loop.</span>
<span class="sd"> :param str line: a line extracted from the http vhost.</span>
<span class="sd"> :returns: True - don't copy line from http vhost to SSL vhost.</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">line</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">lstrip</span><span class="p">()</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"rewriterule"</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="c1"># According to: http://httpd.apache.org/docs/2.4/rewrite/flags.html</span>
<span class="c1"># The syntax of a RewriteRule is:</span>
<span class="c1"># RewriteRule pattern target [Flag1,Flag2,Flag3]</span>
<span class="c1"># i.e. target is required, so it must exist.</span>
<span class="n">target</span> <span class="o">=</span> <span class="n">line</span><span class="o">.</span><span class="n">split</span><span class="p">()[</span><span class="mi">2</span><span class="p">]</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="c1"># target may be surrounded with quotes</span>
<span class="k">if</span> <span class="n">target</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"'"</span><span class="p">,</span> <span class="s1">'"'</span><span class="p">)</span> <span class="ow">and</span> <span class="n">target</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="n">target</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]:</span>
<span class="n">target</span> <span class="o">=</span> <span class="n">target</span><span class="p">[</span><span class="mi">1</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="c1"># Sift line if it redirects the request to a HTTPS site</span>
<span class="k">return</span> <span class="n">target</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"https://"</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheConfigurator._copy_create_ssl_vhost_skeleton"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._copy_create_ssl_vhost_skeleton">[docs]</a> <span class="k">def</span> <span class="nf">_copy_create_ssl_vhost_skeleton</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vhost</span><span class="p">,</span> <span class="n">ssl_fp</span><span class="p">):</span>
<span class="sd">"""Copies over existing Vhost with IfModule mod_ssl.c> skeleton.</span>
<span class="sd"> :param obj.VirtualHost vhost: Original VirtualHost object</span>
<span class="sd"> :param str ssl_fp: Full path where the new ssl_vhost will reside.</span>
<span class="sd"> A new file is created on the filesystem.</span>
<span class="sd"> """</span>
<span class="c1"># First register the creation so that it is properly removed if</span>
<span class="c1"># configuration is rolled back</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">ssl_fp</span><span class="p">):</span>
<span class="n">notes</span> <span class="o">=</span> <span class="s2">"Appended new VirtualHost directive to file </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">ssl_fp</span>
<span class="n">files</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="n">files</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">ssl_fp</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">reverter</span><span class="o">.</span><span class="n">add_to_checkpoint</span><span class="p">(</span><span class="n">files</span><span class="p">,</span> <span class="n">notes</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">reverter</span><span class="o">.</span><span class="n">register_file_creation</span><span class="p">(</span><span class="kc">False</span><span class="p">,</span> <span class="n">ssl_fp</span><span class="p">)</span>
<span class="n">sift</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">orig_contents</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_vhost_block</span><span class="p">(</span><span class="n">vhost</span><span class="p">)</span>
<span class="n">ssl_vh_contents</span><span class="p">,</span> <span class="n">sift</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sift_rewrite_rules</span><span class="p">(</span><span class="n">orig_contents</span><span class="p">)</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">ssl_fp</span><span class="p">,</span> <span class="s2">"a"</span><span class="p">)</span> <span class="k">as</span> <span class="n">new_file</span><span class="p">:</span>
<span class="n">new_file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"<IfModule mod_ssl.c></span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="n">new_file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">ssl_vh_contents</span><span class="p">))</span>
<span class="c1"># The content does not include the closing tag, so add it</span>
<span class="n">new_file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"</VirtualHost></span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="n">new_file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"</IfModule></span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="c1"># Add new file to augeas paths if we're supposed to handle</span>
<span class="c1"># activation (it's not included as default)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">parsed_in_current</span><span class="p">(</span><span class="n">ssl_fp</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">parse_file</span><span class="p">(</span><span class="n">ssl_fp</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">IOError</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">fatal</span><span class="p">(</span><span class="s2">"Error writing/reading to file in make_vhost_ssl"</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span><span class="s2">"Unable to write/read in make_vhost_ssl"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">sift</span><span class="p">:</span>
<span class="n">reporter</span> <span class="o">=</span> <span class="n">zope</span><span class="o">.</span><span class="n">component</span><span class="o">.</span><span class="n">getUtility</span><span class="p">(</span><span class="n">interfaces</span><span class="o">.</span><span class="n">IReporter</span><span class="p">)</span>
<span class="n">reporter</span><span class="o">.</span><span class="n">add_message</span><span class="p">(</span>
<span class="s2">"Some rewrite rules copied from </span><span class="si">{0}</span><span class="s2"> were disabled in the "</span>
<span class="s2">"vhost for your HTTPS site located at </span><span class="si">{1}</span><span class="s2"> because they have "</span>
<span class="s2">"the potential to create redirection loops."</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">vhost</span><span class="o">.</span><span class="n">filep</span><span class="p">,</span> <span class="n">ssl_fp</span><span class="p">),</span> <span class="n">reporter</span><span class="o">.</span><span class="n">MEDIUM_PRIORITY</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">"/augeas/files</span><span class="si">%s</span><span class="s2">/mtime"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_escape</span><span class="p">(</span><span class="n">ssl_fp</span><span class="p">)),</span> <span class="s2">"0"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">"/augeas/files</span><span class="si">%s</span><span class="s2">/mtime"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_escape</span><span class="p">(</span><span class="n">vhost</span><span class="o">.</span><span class="n">filep</span><span class="p">)),</span> <span class="s2">"0"</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheConfigurator._sift_rewrite_rules"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._sift_rewrite_rules">[docs]</a> <span class="k">def</span> <span class="nf">_sift_rewrite_rules</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">contents</span><span class="p">):</span>
<span class="sd">""" Helper function for _copy_create_ssl_vhost_skeleton to prepare the</span>
<span class="sd"> new HTTPS VirtualHost contents. Currently disabling the rewrites """</span>
<span class="n">result</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">sift</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">contents</span> <span class="o">=</span> <span class="nb">iter</span><span class="p">(</span><span class="n">contents</span><span class="p">)</span>
<span class="n">comment</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"# Some rewrite rules in this file were "</span>
<span class="s2">"disabled on your HTTPS site,</span><span class="se">\n</span><span class="s2">"</span>
<span class="s2">"# because they have the potential to create "</span>
<span class="s2">"redirection loops.</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">contents</span><span class="p">:</span>
<span class="n">A</span> <span class="o">=</span> <span class="n">line</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">lstrip</span><span class="p">()</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"rewritecond"</span><span class="p">)</span>
<span class="n">B</span> <span class="o">=</span> <span class="n">line</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">lstrip</span><span class="p">()</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"rewriterule"</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">A</span> <span class="ow">or</span> <span class="n">B</span><span class="p">):</span>
<span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
<span class="k">continue</span>
<span class="c1"># A RewriteRule that doesn't need filtering</span>
<span class="k">if</span> <span class="n">B</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sift_rewrite_rule</span><span class="p">(</span><span class="n">line</span><span class="p">):</span>
<span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
<span class="k">continue</span>
<span class="c1"># A RewriteRule that does need filtering</span>
<span class="k">if</span> <span class="n">B</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sift_rewrite_rule</span><span class="p">(</span><span class="n">line</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">sift</span><span class="p">:</span>
<span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">comment</span><span class="p">)</span>
<span class="n">sift</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"# "</span> <span class="o">+</span> <span class="n">line</span><span class="p">)</span>
<span class="k">continue</span>
<span class="c1"># We save RewriteCond(s) and their corresponding</span>
<span class="c1"># RewriteRule in 'chunk'.</span>
<span class="c1"># We then decide whether we comment out the entire</span>
<span class="c1"># chunk based on its RewriteRule.</span>
<span class="n">chunk</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="n">A</span><span class="p">:</span>
<span class="n">chunk</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
<span class="n">line</span> <span class="o">=</span> <span class="nb">next</span><span class="p">(</span><span class="n">contents</span><span class="p">)</span>
<span class="c1"># RewriteCond(s) must be followed by one RewriteRule</span>
<span class="k">while</span> <span class="ow">not</span> <span class="n">line</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">lstrip</span><span class="p">()</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"rewriterule"</span><span class="p">):</span>
<span class="n">chunk</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
<span class="n">line</span> <span class="o">=</span> <span class="nb">next</span><span class="p">(</span><span class="n">contents</span><span class="p">)</span>
<span class="c1"># Now, current line must start with a RewriteRule</span>
<span class="n">chunk</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sift_rewrite_rule</span><span class="p">(</span><span class="n">line</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">sift</span><span class="p">:</span>
<span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">comment</span><span class="p">)</span>
<span class="n">sift</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
<span class="p">[</span><span class="s1">'# '</span> <span class="o">+</span> <span class="n">l</span> <span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">chunk</span><span class="p">]))</span>
<span class="k">continue</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">chunk</span><span class="p">))</span>
<span class="k">continue</span>
<span class="k">return</span> <span class="n">result</span><span class="p">,</span> <span class="n">sift</span></div>
<div class="viewcode-block" id="ApacheConfigurator._get_vhost_block"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._get_vhost_block">[docs]</a> <span class="k">def</span> <span class="nf">_get_vhost_block</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vhost</span><span class="p">):</span>
<span class="sd">""" Helper method to get VirtualHost contents from the original file.</span>
<span class="sd"> This is done with help of augeas span, which returns the span start and</span>
<span class="sd"> end positions</span>
<span class="sd"> :returns: `list` of VirtualHost block content lines without closing tag</span>
<span class="sd"> """</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">span_val</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">span</span><span class="p">(</span><span class="n">vhost</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">fatal</span><span class="p">(</span><span class="s2">"Error while reading the VirtualHost </span><span class="si">%s</span><span class="s2"> from "</span>
<span class="s2">"file </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">vhost</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">vhost</span><span class="o">.</span><span class="n">filep</span><span class="p">,</span> <span class="n">exc_info</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span><span class="s2">"Unable to read VirtualHost from file"</span><span class="p">)</span>
<span class="n">span_filep</span> <span class="o">=</span> <span class="n">span_val</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">span_start</span> <span class="o">=</span> <span class="n">span_val</span><span class="p">[</span><span class="mi">5</span><span class="p">]</span>
<span class="n">span_end</span> <span class="o">=</span> <span class="n">span_val</span><span class="p">[</span><span class="mi">6</span><span class="p">]</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">span_filep</span><span class="p">,</span> <span class="s1">'r'</span><span class="p">)</span> <span class="k">as</span> <span class="n">fh</span><span class="p">:</span>
<span class="n">fh</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="n">span_start</span><span class="p">)</span>
<span class="n">vh_contents</span> <span class="o">=</span> <span class="n">fh</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">span_end</span><span class="o">-</span><span class="n">span_start</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_remove_closing_vhost_tag</span><span class="p">(</span><span class="n">vh_contents</span><span class="p">)</span>
<span class="k">return</span> <span class="n">vh_contents</span></div>
<div class="viewcode-block" id="ApacheConfigurator._remove_closing_vhost_tag"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._remove_closing_vhost_tag">[docs]</a> <span class="k">def</span> <span class="nf">_remove_closing_vhost_tag</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vh_contents</span><span class="p">):</span>
<span class="sd">"""Removes the closing VirtualHost tag if it exists.</span>
<span class="sd"> This method modifies vh_contents directly to remove the closing</span>
<span class="sd"> tag. If the closing vhost tag is found, everything on the line</span>
<span class="sd"> after it is also removed. Whether or not this tag is included</span>
<span class="sd"> in the result of span depends on the Augeas version.</span>
<span class="sd"> :param list vh_contents: VirtualHost block contents to check</span>
<span class="sd"> """</span>
<span class="k">for</span> <span class="n">offset</span><span class="p">,</span> <span class="n">line</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="nb">reversed</span><span class="p">(</span><span class="n">vh_contents</span><span class="p">)):</span>
<span class="k">if</span> <span class="n">line</span><span class="p">:</span>
<span class="n">line_index</span> <span class="o">=</span> <span class="n">line</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s2">"</virtualhost>"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">line_index</span> <span class="o">!=</span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span>
<span class="n">content_index</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">vh_contents</span><span class="p">)</span> <span class="o">-</span> <span class="n">offset</span> <span class="o">-</span> <span class="mi">1</span>
<span class="n">vh_contents</span><span class="p">[</span><span class="n">content_index</span><span class="p">]</span> <span class="o">=</span> <span class="n">line</span><span class="p">[:</span><span class="n">line_index</span><span class="p">]</span>
<span class="k">break</span></div>
<span class="k">def</span> <span class="nf">_update_ssl_vhosts_addrs</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vh_path</span><span class="p">):</span>
<span class="n">ssl_addrs</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="n">ssl_addr_p</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">vh_path</span> <span class="o">+</span> <span class="s2">"/arg"</span><span class="p">)</span>
<span class="k">for</span> <span class="n">addr</span> <span class="ow">in</span> <span class="n">ssl_addr_p</span><span class="p">:</span>
<span class="n">old_addr</span> <span class="o">=</span> <span class="n">obj</span><span class="o">.</span><span class="n">Addr</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span>
<span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">get_arg</span><span class="p">(</span><span class="n">addr</span><span class="p">)))</span>
<span class="n">ssl_addr</span> <span class="o">=</span> <span class="n">old_addr</span><span class="o">.</span><span class="n">get_addr_obj</span><span class="p">(</span><span class="s2">"443"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">addr</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">ssl_addr</span><span class="p">))</span>
<span class="n">ssl_addrs</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">ssl_addr</span><span class="p">)</span>
<span class="k">return</span> <span class="n">ssl_addrs</span>
<span class="k">def</span> <span class="nf">_clean_vhost</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vhost</span><span class="p">):</span>
<span class="c1"># remove duplicated or conflicting ssl directives</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_deduplicate_directives</span><span class="p">(</span><span class="n">vhost</span><span class="o">.</span><span class="n">path</span><span class="p">,</span>
<span class="p">[</span><span class="s2">"SSLCertificateFile"</span><span class="p">,</span>
<span class="s2">"SSLCertificateKeyFile"</span><span class="p">])</span>
<span class="c1"># remove all problematic directives</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_remove_directives</span><span class="p">(</span><span class="n">vhost</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="p">[</span><span class="s2">"SSLCertificateChainFile"</span><span class="p">])</span>
<span class="k">def</span> <span class="nf">_deduplicate_directives</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vh_path</span><span class="p">,</span> <span class="n">directives</span><span class="p">):</span>
<span class="k">for</span> <span class="n">directive</span> <span class="ow">in</span> <span class="n">directives</span><span class="p">:</span>
<span class="k">while</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span><span class="n">directive</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">vh_path</span><span class="p">,</span> <span class="kc">False</span><span class="p">))</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
<span class="n">directive_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span><span class="n">directive</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">vh_path</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">"/\w*$"</span><span class="p">,</span> <span class="s2">""</span><span class="p">,</span> <span class="n">directive_path</span><span class="p">[</span><span class="mi">0</span><span class="p">]))</span>
<span class="k">def</span> <span class="nf">_remove_directives</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vh_path</span><span class="p">,</span> <span class="n">directives</span><span class="p">):</span>
<span class="k">for</span> <span class="n">directive</span> <span class="ow">in</span> <span class="n">directives</span><span class="p">:</span>
<span class="k">while</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span><span class="n">directive</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">vh_path</span><span class="p">,</span> <span class="kc">False</span><span class="p">))</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
<span class="n">directive_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span><span class="n">directive</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">vh_path</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">"/\w*$"</span><span class="p">,</span> <span class="s2">""</span><span class="p">,</span> <span class="n">directive_path</span><span class="p">[</span><span class="mi">0</span><span class="p">]))</span>
<span class="k">def</span> <span class="nf">_add_dummy_ssl_directives</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vh_path</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">add_dir</span><span class="p">(</span><span class="n">vh_path</span><span class="p">,</span> <span class="s2">"SSLCertificateFile"</span><span class="p">,</span>
<span class="s2">"insert_cert_file_path"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">add_dir</span><span class="p">(</span><span class="n">vh_path</span><span class="p">,</span> <span class="s2">"SSLCertificateKeyFile"</span><span class="p">,</span>
<span class="s2">"insert_key_file_path"</span><span class="p">)</span>
<span class="c1"># Only include the TLS configuration if not already included</span>
<span class="n">existing_inc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span><span class="s2">"Include"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">mod_ssl_conf</span><span class="p">,</span> <span class="n">vh_path</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">existing_inc</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">add_dir</span><span class="p">(</span><span class="n">vh_path</span><span class="p">,</span> <span class="s2">"Include"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">mod_ssl_conf</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_add_servername_alias</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">target_name</span><span class="p">,</span> <span class="n">vhost</span><span class="p">):</span>
<span class="n">vh_path</span> <span class="o">=</span> <span class="n">vhost</span><span class="o">.</span><span class="n">path</span>
<span class="n">sname</span><span class="p">,</span> <span class="n">saliases</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_vhost_names</span><span class="p">(</span><span class="n">vh_path</span><span class="p">)</span>
<span class="k">if</span> <span class="n">target_name</span> <span class="o">==</span> <span class="n">sname</span> <span class="ow">or</span> <span class="n">target_name</span> <span class="ow">in</span> <span class="n">saliases</span><span class="p">:</span>
<span class="k">return</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_has_matching_wildcard</span><span class="p">(</span><span class="n">vh_path</span><span class="p">,</span> <span class="n">target_name</span><span class="p">):</span>
<span class="k">return</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span><span class="s2">"ServerName"</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">start</span><span class="o">=</span><span class="n">vh_path</span><span class="p">,</span> <span class="n">exclude</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">add_dir</span><span class="p">(</span><span class="n">vh_path</span><span class="p">,</span> <span class="s2">"ServerName"</span><span class="p">,</span> <span class="n">target_name</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">add_dir</span><span class="p">(</span><span class="n">vh_path</span><span class="p">,</span> <span class="s2">"ServerAlias"</span><span class="p">,</span> <span class="n">target_name</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_servernames</span><span class="p">(</span><span class="n">vhost</span><span class="p">)</span>
<div class="viewcode-block" id="ApacheConfigurator._has_matching_wildcard"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._has_matching_wildcard">[docs]</a> <span class="k">def</span> <span class="nf">_has_matching_wildcard</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vh_path</span><span class="p">,</span> <span class="n">target_name</span><span class="p">):</span>
<span class="sd">"""Is target_name already included in a wildcard in the vhost?</span>
<span class="sd"> :param str vh_path: Augeas path to the vhost</span>
<span class="sd"> :param str target_name: name to compare with wildcards</span>
<span class="sd"> :returns: True if there is a wildcard covering target_name in</span>
<span class="sd"> the vhost in vhost_path, otherwise, False</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> """</span>
<span class="n">matches</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span>
<span class="s2">"ServerAlias"</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="n">vh_path</span><span class="p">,</span> <span class="n">exclude</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="n">aliases</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">match</span><span class="p">)</span> <span class="k">for</span> <span class="n">match</span> <span class="ow">in</span> <span class="n">matches</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">included_in_wildcard</span><span class="p">(</span><span class="n">aliases</span><span class="p">,</span> <span class="n">target_name</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheConfigurator._add_name_vhost_if_necessary"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._add_name_vhost_if_necessary">[docs]</a> <span class="k">def</span> <span class="nf">_add_name_vhost_if_necessary</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vhost</span><span class="p">):</span>
<span class="sd">"""Add NameVirtualHost Directives if necessary for new vhost.</span>
<span class="sd"> NameVirtualHosts was a directive in Apache < 2.4</span>
<span class="sd"> https://httpd.apache.org/docs/2.2/mod/core.html#namevirtualhost</span>
<span class="sd"> :param vhost: New virtual host that was recently created.</span>
<span class="sd"> :type vhost: :class:`~certbot_apache.obj.VirtualHost`</span>
<span class="sd"> """</span>
<span class="n">need_to_save</span> <span class="o">=</span> <span class="kc">False</span>
<span class="c1"># See if the exact address appears in any other vhost</span>
<span class="c1"># Remember 1.1.1.1:* == 1.1.1.1 -> hence any()</span>
<span class="k">for</span> <span class="n">addr</span> <span class="ow">in</span> <span class="n">vhost</span><span class="o">.</span><span class="n">addrs</span><span class="p">:</span>
<span class="c1"># In Apache 2.2, when a NameVirtualHost directive is not</span>
<span class="c1"># set, "*" and "_default_" will conflict when sharing a port</span>
<span class="n">addrs</span> <span class="o">=</span> <span class="nb">set</span><span class="p">((</span><span class="n">addr</span><span class="p">,))</span>
<span class="k">if</span> <span class="n">addr</span><span class="o">.</span><span class="n">get_addr</span><span class="p">()</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"*"</span><span class="p">,</span> <span class="s2">"_default_"</span><span class="p">):</span>
<span class="n">addrs</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">obj</span><span class="o">.</span><span class="n">Addr</span><span class="p">((</span><span class="n">a</span><span class="p">,</span> <span class="n">addr</span><span class="o">.</span><span class="n">get_port</span><span class="p">(),))</span>
<span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"*"</span><span class="p">,</span> <span class="s2">"_default_"</span><span class="p">))</span>
<span class="k">for</span> <span class="n">test_vh</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">vhosts</span><span class="p">:</span>
<span class="k">if</span> <span class="p">(</span><span class="n">vhost</span><span class="o">.</span><span class="n">filep</span> <span class="o">!=</span> <span class="n">test_vh</span><span class="o">.</span><span class="n">filep</span> <span class="ow">and</span>
<span class="nb">any</span><span class="p">(</span><span class="n">test_addr</span> <span class="ow">in</span> <span class="n">addrs</span> <span class="k">for</span>
<span class="n">test_addr</span> <span class="ow">in</span> <span class="n">test_vh</span><span class="o">.</span><span class="n">addrs</span><span class="p">)</span> <span class="ow">and</span>
<span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_name_vhost</span><span class="p">(</span><span class="n">addr</span><span class="p">)):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add_name_vhost</span><span class="p">(</span><span class="n">addr</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"Enabling NameVirtualHosts on </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">addr</span><span class="p">)</span>
<span class="n">need_to_save</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">break</span>
<span class="k">if</span> <span class="n">need_to_save</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save</span><span class="p">()</span></div>
<span class="k">def</span> <span class="nf">_escape</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fp</span><span class="p">):</span>
<span class="n">fp</span> <span class="o">=</span> <span class="n">fp</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">","</span><span class="p">,</span> <span class="s2">"</span><span class="se">\\</span><span class="s2">,"</span><span class="p">)</span>
<span class="n">fp</span> <span class="o">=</span> <span class="n">fp</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"["</span><span class="p">,</span> <span class="s2">"</span><span class="se">\\</span><span class="s2">["</span><span class="p">)</span>
<span class="n">fp</span> <span class="o">=</span> <span class="n">fp</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"]"</span><span class="p">,</span> <span class="s2">"</span><span class="se">\\</span><span class="s2">]"</span><span class="p">)</span>
<span class="n">fp</span> <span class="o">=</span> <span class="n">fp</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"|"</span><span class="p">,</span> <span class="s2">"</span><span class="se">\\</span><span class="s2">|"</span><span class="p">)</span>
<span class="n">fp</span> <span class="o">=</span> <span class="n">fp</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"="</span><span class="p">,</span> <span class="s2">"</span><span class="se">\\</span><span class="s2">="</span><span class="p">)</span>
<span class="n">fp</span> <span class="o">=</span> <span class="n">fp</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"("</span><span class="p">,</span> <span class="s2">"</span><span class="se">\\</span><span class="s2">("</span><span class="p">)</span>
<span class="n">fp</span> <span class="o">=</span> <span class="n">fp</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">")"</span><span class="p">,</span> <span class="s2">"</span><span class="se">\\</span><span class="s2">)"</span><span class="p">)</span>
<span class="n">fp</span> <span class="o">=</span> <span class="n">fp</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"!"</span><span class="p">,</span> <span class="s2">"</span><span class="se">\\</span><span class="s2">!"</span><span class="p">)</span>
<span class="k">return</span> <span class="n">fp</span>
<span class="c1">######################################################################</span>
<span class="c1"># Enhancements</span>
<span class="c1">######################################################################</span>
<div class="viewcode-block" id="ApacheConfigurator.supported_enhancements"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.supported_enhancements">[docs]</a> <span class="k">def</span> <span class="nf">supported_enhancements</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="c1"># pylint: disable=no-self-use</span>
<span class="sd">"""Returns currently supported enhancements."""</span>
<span class="k">return</span> <span class="p">[</span><span class="s2">"redirect"</span><span class="p">,</span> <span class="s2">"ensure-http-header"</span><span class="p">,</span> <span class="s2">"staple-ocsp"</span><span class="p">]</span></div>
<div class="viewcode-block" id="ApacheConfigurator.enhance"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.enhance">[docs]</a> <span class="k">def</span> <span class="nf">enhance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">domain</span><span class="p">,</span> <span class="n">enhancement</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Enhance configuration.</span>
<span class="sd"> :param str domain: domain to enhance</span>
<span class="sd"> :param str enhancement: enhancement type defined in</span>
<span class="sd"> :const:`~certbot.constants.ENHANCEMENTS`</span>
<span class="sd"> :param options: options for the enhancement</span>
<span class="sd"> See :const:`~certbot.constants.ENHANCEMENTS`</span>
<span class="sd"> documentation for appropriate parameter.</span>
<span class="sd"> :raises .errors.PluginError: If Enhancement is not supported, or if</span>
<span class="sd"> there is any other problem with the enhancement.</span>
<span class="sd"> """</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">func</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_enhance_func</span><span class="p">[</span><span class="n">enhancement</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span>
<span class="s2">"Unsupported enhancement: </span><span class="si">{0}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">enhancement</span><span class="p">))</span>
<span class="n">vhosts</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">choose_vhosts</span><span class="p">(</span><span class="n">domain</span><span class="p">,</span> <span class="n">create_if_no_ssl</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">for</span> <span class="n">vhost</span> <span class="ow">in</span> <span class="n">vhosts</span><span class="p">:</span>
<span class="n">func</span><span class="p">(</span><span class="n">vhost</span><span class="p">,</span> <span class="n">options</span><span class="p">)</span>
<span class="k">except</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">"Failed </span><span class="si">%s</span><span class="s2"> for </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">enhancement</span><span class="p">,</span> <span class="n">domain</span><span class="p">)</span>
<span class="k">raise</span></div>
<div class="viewcode-block" id="ApacheConfigurator._enable_ocsp_stapling"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._enable_ocsp_stapling">[docs]</a> <span class="k">def</span> <span class="nf">_enable_ocsp_stapling</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ssl_vhost</span><span class="p">,</span> <span class="n">unused_options</span><span class="p">):</span>
<span class="sd">"""Enables OCSP Stapling</span>
<span class="sd"> In OCSP, each client (e.g. browser) would have to query the</span>
<span class="sd"> OCSP Responder to validate that the site certificate was not revoked.</span>
<span class="sd"> Enabling OCSP Stapling, would allow the web-server to query the OCSP</span>
<span class="sd"> Responder, and staple its response to the offered certificate during</span>
<span class="sd"> TLS. i.e. clients would not have to query the OCSP responder.</span>
<span class="sd"> OCSP Stapling enablement on Apache implicitly depends on</span>
<span class="sd"> SSLCertificateChainFile being set by other code.</span>
<span class="sd"> .. note:: This function saves the configuration</span>
<span class="sd"> :param ssl_vhost: Destination of traffic, an ssl enabled vhost</span>
<span class="sd"> :type ssl_vhost: :class:`~certbot_apache.obj.VirtualHost`</span>
<span class="sd"> :param unused_options: Not currently used</span>
<span class="sd"> :type unused_options: Not Available</span>
<span class="sd"> :returns: Success, general_vhost (HTTP vhost)</span>
<span class="sd"> :rtype: (bool, :class:`~certbot_apache.obj.VirtualHost`)</span>
<span class="sd"> """</span>
<span class="n">min_apache_ver</span> <span class="o">=</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_version</span><span class="p">()</span> <span class="o"><</span> <span class="n">min_apache_ver</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span>
<span class="s2">"Unable to set OCSP directives.</span><span class="se">\n</span><span class="s2">"</span>
<span class="s2">"Apache version is below 2.3.3."</span><span class="p">)</span>
<span class="k">if</span> <span class="s2">"socache_shmcb_module"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">modules</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">enable_mod</span><span class="p">(</span><span class="s2">"socache_shmcb"</span><span class="p">)</span>
<span class="c1"># Check if there's an existing SSLUseStapling directive on.</span>
<span class="n">use_stapling_aug_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span><span class="s2">"SSLUseStapling"</span><span class="p">,</span>
<span class="s2">"on"</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="n">ssl_vhost</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">use_stapling_aug_path</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">add_dir</span><span class="p">(</span><span class="n">ssl_vhost</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="s2">"SSLUseStapling"</span><span class="p">,</span> <span class="s2">"on"</span><span class="p">)</span>
<span class="n">ssl_vhost_aug_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_escape</span><span class="p">(</span><span class="n">parser</span><span class="o">.</span><span class="n">get_aug_path</span><span class="p">(</span><span class="n">ssl_vhost</span><span class="o">.</span><span class="n">filep</span><span class="p">))</span>
<span class="c1"># Check if there's an existing SSLStaplingCache directive.</span>
<span class="n">stapling_cache_aug_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span><span class="s1">'SSLStaplingCache'</span><span class="p">,</span>
<span class="kc">None</span><span class="p">,</span> <span class="n">ssl_vhost_aug_path</span><span class="p">)</span>
<span class="c1"># We'll simply delete the directive, so that we'll have a</span>
<span class="c1"># consistent OCSP cache path.</span>
<span class="k">if</span> <span class="n">stapling_cache_aug_path</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span>
<span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">"/\w*$"</span><span class="p">,</span> <span class="s2">""</span><span class="p">,</span> <span class="n">stapling_cache_aug_path</span><span class="p">[</span><span class="mi">0</span><span class="p">]))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">add_dir_to_ifmodssl</span><span class="p">(</span><span class="n">ssl_vhost_aug_path</span><span class="p">,</span>
<span class="s2">"SSLStaplingCache"</span><span class="p">,</span>
<span class="p">[</span><span class="s2">"shmcb:/var/run/apache2/stapling_cache(128000)"</span><span class="p">])</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s2">"OCSP Stapling was enabled on SSL Vhost: </span><span class="si">%s</span><span class="s2">.</span><span class="se">\n</span><span class="s2">"</span><span class="o">%</span><span class="p">(</span>
<span class="n">ssl_vhost</span><span class="o">.</span><span class="n">filep</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save_notes</span> <span class="o">+=</span> <span class="n">msg</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheConfigurator._set_http_header"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._set_http_header">[docs]</a> <span class="k">def</span> <span class="nf">_set_http_header</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ssl_vhost</span><span class="p">,</span> <span class="n">header_substring</span><span class="p">):</span>
<span class="sd">"""Enables header that is identified by header_substring on ssl_vhost.</span>
<span class="sd"> If the header identified by header_substring is not already set,</span>
<span class="sd"> a new Header directive is placed in ssl_vhost's configuration with</span>
<span class="sd"> arguments from: constants.HTTP_HEADER[header_substring]</span>
<span class="sd"> .. note:: This function saves the configuration</span>
<span class="sd"> :param ssl_vhost: Destination of traffic, an ssl enabled vhost</span>
<span class="sd"> :type ssl_vhost: :class:`~certbot_apache.obj.VirtualHost`</span>
<span class="sd"> :param header_substring: string that uniquely identifies a header.</span>
<span class="sd"> e.g: Strict-Transport-Security, Upgrade-Insecure-Requests.</span>
<span class="sd"> :type str</span>
<span class="sd"> :returns: Success, general_vhost (HTTP vhost)</span>
<span class="sd"> :rtype: (bool, :class:`~certbot_apache.obj.VirtualHost`)</span>
<span class="sd"> :raises .errors.PluginError: If no viable HTTP host can be created or</span>
<span class="sd"> set with header header_substring.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="s2">"headers_module"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">modules</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">enable_mod</span><span class="p">(</span><span class="s2">"headers"</span><span class="p">)</span>
<span class="c1"># Check if selected header is already set</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_verify_no_matching_http_header</span><span class="p">(</span><span class="n">ssl_vhost</span><span class="p">,</span> <span class="n">header_substring</span><span class="p">)</span>
<span class="c1"># Add directives to server</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">add_dir</span><span class="p">(</span><span class="n">ssl_vhost</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="s2">"Header"</span><span class="p">,</span>
<span class="n">constants</span><span class="o">.</span><span class="n">HEADER_ARGS</span><span class="p">[</span><span class="n">header_substring</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save_notes</span> <span class="o">+=</span> <span class="p">(</span><span class="s2">"Adding </span><span class="si">%s</span><span class="s2"> header to ssl vhost in </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">header_substring</span><span class="p">,</span> <span class="n">ssl_vhost</span><span class="o">.</span><span class="n">filep</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"Adding </span><span class="si">%s</span><span class="s2"> header to ssl vhost in </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">header_substring</span><span class="p">,</span>
<span class="n">ssl_vhost</span><span class="o">.</span><span class="n">filep</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheConfigurator._verify_no_matching_http_header"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._verify_no_matching_http_header">[docs]</a> <span class="k">def</span> <span class="nf">_verify_no_matching_http_header</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ssl_vhost</span><span class="p">,</span> <span class="n">header_substring</span><span class="p">):</span>
<span class="sd">"""Checks to see if an there is an existing Header directive that</span>
<span class="sd"> contains the string header_substring.</span>
<span class="sd"> :param ssl_vhost: vhost to check</span>
<span class="sd"> :type vhost: :class:`~certbot_apache.obj.VirtualHost`</span>
<span class="sd"> :param header_substring: string that uniquely identifies a header.</span>
<span class="sd"> e.g: Strict-Transport-Security, Upgrade-Insecure-Requests.</span>
<span class="sd"> :type str</span>
<span class="sd"> :returns: boolean</span>
<span class="sd"> :rtype: (bool)</span>
<span class="sd"> :raises errors.PluginEnhancementAlreadyPresent When header</span>
<span class="sd"> header_substring exists</span>
<span class="sd"> """</span>
<span class="n">header_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span><span class="s2">"Header"</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">start</span><span class="o">=</span><span class="n">ssl_vhost</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
<span class="k">if</span> <span class="n">header_path</span><span class="p">:</span>
<span class="c1"># "Existing Header directive for virtualhost"</span>
<span class="n">pat</span> <span class="o">=</span> <span class="s1">'(?:[ "]|^)(</span><span class="si">%s</span><span class="s1">)(?:[ "]|$)'</span> <span class="o">%</span> <span class="p">(</span><span class="n">header_substring</span><span class="o">.</span><span class="n">lower</span><span class="p">())</span>
<span class="k">for</span> <span class="n">match</span> <span class="ow">in</span> <span class="n">header_path</span><span class="p">:</span>
<span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">pat</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">match</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()):</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginEnhancementAlreadyPresent</span><span class="p">(</span>
<span class="s2">"Existing </span><span class="si">%s</span><span class="s2"> header"</span> <span class="o">%</span> <span class="p">(</span><span class="n">header_substring</span><span class="p">))</span></div>
<div class="viewcode-block" id="ApacheConfigurator._enable_redirect"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._enable_redirect">[docs]</a> <span class="k">def</span> <span class="nf">_enable_redirect</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ssl_vhost</span><span class="p">,</span> <span class="n">unused_options</span><span class="p">):</span>
<span class="sd">"""Redirect all equivalent HTTP traffic to ssl_vhost.</span>
<span class="sd"> .. todo:: This enhancement should be rewritten and will</span>
<span class="sd"> unfortunately require lots of debugging by hand.</span>
<span class="sd"> Adds Redirect directive to the port 80 equivalent of ssl_vhost</span>
<span class="sd"> First the function attempts to find the vhost with equivalent</span>
<span class="sd"> ip addresses that serves on non-ssl ports</span>
<span class="sd"> The function then adds the directive</span>
<span class="sd"> .. note:: This function saves the configuration</span>
<span class="sd"> :param ssl_vhost: Destination of traffic, an ssl enabled vhost</span>
<span class="sd"> :type ssl_vhost: :class:`~certbot_apache.obj.VirtualHost`</span>
<span class="sd"> :param unused_options: Not currently used</span>
<span class="sd"> :type unused_options: Not Available</span>
<span class="sd"> :raises .errors.PluginError: If no viable HTTP host can be created or</span>
<span class="sd"> used for the redirect.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="s2">"rewrite_module"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">modules</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">enable_mod</span><span class="p">(</span><span class="s2">"rewrite"</span><span class="p">)</span>
<span class="n">general_vh</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_http_vhost</span><span class="p">(</span><span class="n">ssl_vhost</span><span class="p">)</span>
<span class="k">if</span> <span class="n">general_vh</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># Add virtual_server with redirect</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"Did not find http version of ssl virtual host "</span>
<span class="s2">"attempting to create"</span><span class="p">)</span>
<span class="n">redirect_addrs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_proposed_addrs</span><span class="p">(</span><span class="n">ssl_vhost</span><span class="p">)</span>
<span class="k">for</span> <span class="n">vhost</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">vhosts</span><span class="p">:</span>
<span class="k">if</span> <span class="n">vhost</span><span class="o">.</span><span class="n">enabled</span> <span class="ow">and</span> <span class="n">vhost</span><span class="o">.</span><span class="n">conflicts</span><span class="p">(</span><span class="n">redirect_addrs</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span>
<span class="s2">"Unable to find corresponding HTTP vhost; "</span>
<span class="s2">"Unable to create one as intended addresses conflict; "</span>
<span class="s2">"Current configuration does not support automated "</span>
<span class="s2">"redirection"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_create_redirect_vhost</span><span class="p">(</span><span class="n">ssl_vhost</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="n">general_vh</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_enhanced_vhosts</span><span class="p">[</span><span class="s2">"redirect"</span><span class="p">]:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"Already enabled redirect for this vhost"</span><span class="p">)</span>
<span class="k">return</span>
<span class="c1"># Check if Certbot redirection already exists</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_verify_no_certbot_redirect</span><span class="p">(</span><span class="n">general_vh</span><span class="p">)</span>
<span class="c1"># Note: if code flow gets here it means we didn't find the exact</span>
<span class="c1"># certbot RewriteRule config for redirection. Finding</span>
<span class="c1"># another RewriteRule is likely to be fine in most or all cases,</span>
<span class="c1"># but redirect loops are possible in very obscure cases; see #1620</span>
<span class="c1"># for reasoning.</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_is_rewrite_exists</span><span class="p">(</span><span class="n">general_vh</span><span class="p">):</span>
<span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">"Added an HTTP->HTTPS rewrite in addition to "</span>
<span class="s2">"other RewriteRules; you may wish to check for "</span>
<span class="s2">"overall consistency."</span><span class="p">)</span>
<span class="c1"># Add directives to server</span>
<span class="c1"># Note: These are not immediately searchable in sites-enabled</span>
<span class="c1"># even with save() and load()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_is_rewrite_engine_on</span><span class="p">(</span><span class="n">general_vh</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">add_dir</span><span class="p">(</span><span class="n">general_vh</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="s2">"RewriteEngine"</span><span class="p">,</span> <span class="s2">"on"</span><span class="p">)</span>
<span class="n">names</span> <span class="o">=</span> <span class="n">ssl_vhost</span><span class="o">.</span><span class="n">get_names</span><span class="p">()</span>
<span class="k">for</span> <span class="n">idx</span><span class="p">,</span> <span class="n">name</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">names</span><span class="p">):</span>
<span class="n">args</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"%</span><span class="si">{SERVER_NAME}</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"=</span><span class="si">{0}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">name</span><span class="p">),</span> <span class="s2">"[OR]"</span><span class="p">]</span>
<span class="k">if</span> <span class="n">idx</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">names</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">args</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">add_dir</span><span class="p">(</span><span class="n">general_vh</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="s2">"RewriteCond"</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_set_https_redirection_rewrite_rule</span><span class="p">(</span><span class="n">general_vh</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save_notes</span> <span class="o">+=</span> <span class="p">(</span><span class="s2">"Redirecting host in </span><span class="si">%s</span><span class="s2"> to ssl vhost in </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">general_vh</span><span class="o">.</span><span class="n">filep</span><span class="p">,</span> <span class="n">ssl_vhost</span><span class="o">.</span><span class="n">filep</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_enhanced_vhosts</span><span class="p">[</span><span class="s2">"redirect"</span><span class="p">]</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">general_vh</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"Redirecting vhost in </span><span class="si">%s</span><span class="s2"> to ssl vhost in </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span>
<span class="n">general_vh</span><span class="o">.</span><span class="n">filep</span><span class="p">,</span> <span class="n">ssl_vhost</span><span class="o">.</span><span class="n">filep</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">_set_https_redirection_rewrite_rule</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vhost</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_version</span><span class="p">()</span> <span class="o">>=</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">9</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">add_dir</span><span class="p">(</span><span class="n">vhost</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="s2">"RewriteRule"</span><span class="p">,</span>
<span class="n">constants</span><span class="o">.</span><span class="n">REWRITE_HTTPS_ARGS_WITH_END</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">add_dir</span><span class="p">(</span><span class="n">vhost</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="s2">"RewriteRule"</span><span class="p">,</span>
<span class="n">constants</span><span class="o">.</span><span class="n">REWRITE_HTTPS_ARGS</span><span class="p">)</span>
<div class="viewcode-block" id="ApacheConfigurator._verify_no_certbot_redirect"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._verify_no_certbot_redirect">[docs]</a> <span class="k">def</span> <span class="nf">_verify_no_certbot_redirect</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vhost</span><span class="p">):</span>
<span class="sd">"""Checks to see if a redirect was already installed by certbot.</span>
<span class="sd"> Checks to see if virtualhost already contains a rewrite rule that is</span>
<span class="sd"> identical to Certbot's redirection rewrite rule.</span>
<span class="sd"> For graceful transition to new rewrite rules for HTTPS redireciton we</span>
<span class="sd"> delete certbot's old rewrite rules and set the new one instead.</span>
<span class="sd"> :param vhost: vhost to check</span>
<span class="sd"> :type vhost: :class:`~certbot_apache.obj.VirtualHost`</span>
<span class="sd"> :raises errors.PluginEnhancementAlreadyPresent: When the exact</span>
<span class="sd"> certbot redirection WriteRule exists in virtual host.</span>
<span class="sd"> """</span>
<span class="n">rewrite_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span>
<span class="s2">"RewriteRule"</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="n">vhost</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
<span class="c1"># There can be other RewriteRule directive lines in vhost config.</span>
<span class="c1"># rewrite_args_dict keys are directive ids and the corresponding value</span>
<span class="c1"># for each is a list of arguments to that directive.</span>
<span class="n">rewrite_args_dict</span> <span class="o">=</span> <span class="n">defaultdict</span><span class="p">(</span><span class="nb">list</span><span class="p">)</span>
<span class="n">pat</span> <span class="o">=</span> <span class="sa">r</span><span class="s1">'(.*directive\[\d+\]).*'</span>
<span class="k">for</span> <span class="n">match</span> <span class="ow">in</span> <span class="n">rewrite_path</span><span class="p">:</span>
<span class="n">m</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">pat</span><span class="p">,</span> <span class="n">match</span><span class="p">)</span>
<span class="k">if</span> <span class="n">m</span><span class="p">:</span>
<span class="n">dir_path</span> <span class="o">=</span> <span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="n">rewrite_args_dict</span><span class="p">[</span><span class="n">dir_path</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">match</span><span class="p">)</span>
<span class="k">if</span> <span class="n">rewrite_args_dict</span><span class="p">:</span>
<span class="n">redirect_args</span> <span class="o">=</span> <span class="p">[</span><span class="n">constants</span><span class="o">.</span><span class="n">REWRITE_HTTPS_ARGS</span><span class="p">,</span>
<span class="n">constants</span><span class="o">.</span><span class="n">REWRITE_HTTPS_ARGS_WITH_END</span><span class="p">]</span>
<span class="k">for</span> <span class="n">dir_path</span><span class="p">,</span> <span class="n">args_paths</span> <span class="ow">in</span> <span class="n">rewrite_args_dict</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">arg_vals</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">args_paths</span><span class="p">]</span>
<span class="c1"># Search for past redirection rule, delete it, set the new one</span>
<span class="k">if</span> <span class="n">arg_vals</span> <span class="ow">in</span> <span class="n">constants</span><span class="o">.</span><span class="n">OLD_REWRITE_HTTPS_ARGS</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">dir_path</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_set_https_redirection_rewrite_rule</span><span class="p">(</span><span class="n">vhost</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginEnhancementAlreadyPresent</span><span class="p">(</span>
<span class="s2">"Certbot has already enabled redirection"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">arg_vals</span> <span class="ow">in</span> <span class="n">redirect_args</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginEnhancementAlreadyPresent</span><span class="p">(</span>
<span class="s2">"Certbot has already enabled redirection"</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheConfigurator._is_rewrite_exists"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._is_rewrite_exists">[docs]</a> <span class="k">def</span> <span class="nf">_is_rewrite_exists</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vhost</span><span class="p">):</span>
<span class="sd">"""Checks if there exists a RewriteRule directive in vhost</span>
<span class="sd"> :param vhost: vhost to check</span>
<span class="sd"> :type vhost: :class:`~certbot_apache.obj.VirtualHost`</span>
<span class="sd"> :returns: True if a RewriteRule directive exists.</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> """</span>
<span class="n">rewrite_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span>
<span class="s2">"RewriteRule"</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="n">vhost</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="n">rewrite_path</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheConfigurator._is_rewrite_engine_on"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._is_rewrite_engine_on">[docs]</a> <span class="k">def</span> <span class="nf">_is_rewrite_engine_on</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vhost</span><span class="p">):</span>
<span class="sd">"""Checks if a RewriteEngine directive is on</span>
<span class="sd"> :param vhost: vhost to check</span>
<span class="sd"> :type vhost: :class:`~certbot_apache.obj.VirtualHost`</span>
<span class="sd"> """</span>
<span class="n">rewrite_engine_path_list</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span><span class="s2">"RewriteEngine"</span><span class="p">,</span> <span class="s2">"on"</span><span class="p">,</span>
<span class="n">start</span><span class="o">=</span><span class="n">vhost</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
<span class="k">if</span> <span class="n">rewrite_engine_path_list</span><span class="p">:</span>
<span class="k">for</span> <span class="n">re_path</span> <span class="ow">in</span> <span class="n">rewrite_engine_path_list</span><span class="p">:</span>
<span class="c1"># A RewriteEngine directive may also be included in per</span>
<span class="c1"># directory .htaccess files. We only care about the VirtualHost.</span>
<span class="k">if</span> <span class="s1">'virtualhost'</span> <span class="ow">in</span> <span class="n">re_path</span><span class="o">.</span><span class="n">lower</span><span class="p">():</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">get_arg</span><span class="p">(</span><span class="n">re_path</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">False</span></div>
<div class="viewcode-block" id="ApacheConfigurator._create_redirect_vhost"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._create_redirect_vhost">[docs]</a> <span class="k">def</span> <span class="nf">_create_redirect_vhost</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ssl_vhost</span><span class="p">):</span>
<span class="sd">"""Creates an http_vhost specifically to redirect for the ssl_vhost.</span>
<span class="sd"> :param ssl_vhost: ssl vhost</span>
<span class="sd"> :type ssl_vhost: :class:`~certbot_apache.obj.VirtualHost`</span>
<span class="sd"> :returns: tuple of the form</span>
<span class="sd"> (`success`, :class:`~certbot_apache.obj.VirtualHost`)</span>
<span class="sd"> :rtype: tuple</span>
<span class="sd"> """</span>
<span class="n">text</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_redirect_config_str</span><span class="p">(</span><span class="n">ssl_vhost</span><span class="p">)</span>
<span class="n">redirect_filepath</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_write_out_redirect</span><span class="p">(</span><span class="n">ssl_vhost</span><span class="p">,</span> <span class="n">text</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="c1"># Make a new vhost data structure and add it to the lists</span>
<span class="n">new_vhost</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_create_vhost</span><span class="p">(</span><span class="n">parser</span><span class="o">.</span><span class="n">get_aug_path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_escape</span><span class="p">(</span><span class="n">redirect_filepath</span><span class="p">)))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">vhosts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">new_vhost</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_enhanced_vhosts</span><span class="p">[</span><span class="s2">"redirect"</span><span class="p">]</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">new_vhost</span><span class="p">)</span>
<span class="c1"># Finally create documentation for the change</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save_notes</span> <span class="o">+=</span> <span class="p">(</span><span class="s2">"Created a port 80 vhost, </span><span class="si">%s</span><span class="s2">, for redirection to "</span>
<span class="s2">"ssl vhost </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">new_vhost</span><span class="o">.</span><span class="n">filep</span><span class="p">,</span> <span class="n">ssl_vhost</span><span class="o">.</span><span class="n">filep</span><span class="p">))</span></div>
<span class="k">def</span> <span class="nf">_get_redirect_config_str</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ssl_vhost</span><span class="p">):</span>
<span class="c1"># get servernames and serveraliases</span>
<span class="n">serveralias</span> <span class="o">=</span> <span class="s2">""</span>
<span class="n">servername</span> <span class="o">=</span> <span class="s2">""</span>
<span class="k">if</span> <span class="n">ssl_vhost</span><span class="o">.</span><span class="n">name</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">servername</span> <span class="o">=</span> <span class="s2">"ServerName "</span> <span class="o">+</span> <span class="n">ssl_vhost</span><span class="o">.</span><span class="n">name</span>
<span class="k">if</span> <span class="n">ssl_vhost</span><span class="o">.</span><span class="n">aliases</span><span class="p">:</span>
<span class="n">serveralias</span> <span class="o">=</span> <span class="s2">"ServerAlias "</span> <span class="o">+</span> <span class="s2">" "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">ssl_vhost</span><span class="o">.</span><span class="n">aliases</span><span class="p">)</span>
<span class="n">rewrite_rule_args</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_version</span><span class="p">()</span> <span class="o">>=</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">9</span><span class="p">):</span>
<span class="n">rewrite_rule_args</span> <span class="o">=</span> <span class="n">constants</span><span class="o">.</span><span class="n">REWRITE_HTTPS_ARGS_WITH_END</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">rewrite_rule_args</span> <span class="o">=</span> <span class="n">constants</span><span class="o">.</span><span class="n">REWRITE_HTTPS_ARGS</span>
<span class="k">return</span> <span class="p">(</span><span class="s2">"<VirtualHost </span><span class="si">%s</span><span class="s2">></span><span class="se">\n</span><span class="s2">"</span>
<span class="s2">"</span><span class="si">%s</span><span class="s2"> </span><span class="se">\n</span><span class="s2">"</span>
<span class="s2">"</span><span class="si">%s</span><span class="s2"> </span><span class="se">\n</span><span class="s2">"</span>
<span class="s2">"ServerSignature Off</span><span class="se">\n</span><span class="s2">"</span>
<span class="s2">"</span><span class="se">\n</span><span class="s2">"</span>
<span class="s2">"RewriteEngine On</span><span class="se">\n</span><span class="s2">"</span>
<span class="s2">"RewriteRule </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span>
<span class="s2">"</span><span class="se">\n</span><span class="s2">"</span>
<span class="s2">"ErrorLog </span><span class="si">%s</span><span class="s2">/redirect.error.log</span><span class="se">\n</span><span class="s2">"</span>
<span class="s2">"LogLevel warn</span><span class="se">\n</span><span class="s2">"</span>
<span class="s2">"</VirtualHost></span><span class="se">\n</span><span class="s2">"</span>
<span class="o">%</span> <span class="p">(</span><span class="s2">" "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">addr</span><span class="p">)</span> <span class="k">for</span>
<span class="n">addr</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_proposed_addrs</span><span class="p">(</span><span class="n">ssl_vhost</span><span class="p">)),</span>
<span class="n">servername</span><span class="p">,</span> <span class="n">serveralias</span><span class="p">,</span>
<span class="s2">" "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">rewrite_rule_args</span><span class="p">),</span>
<span class="bp">self</span><span class="o">.</span><span class="n">conf</span><span class="p">(</span><span class="s2">"logs-root"</span><span class="p">)))</span>
<span class="k">def</span> <span class="nf">_write_out_redirect</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ssl_vhost</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
<span class="c1"># This is the default name</span>
<span class="n">redirect_filename</span> <span class="o">=</span> <span class="s2">"le-redirect.conf"</span>
<span class="c1"># See if a more appropriate name can be applied</span>
<span class="k">if</span> <span class="n">ssl_vhost</span><span class="o">.</span><span class="n">name</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># make sure servername doesn't exceed filename length restriction</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">ssl_vhost</span><span class="o">.</span><span class="n">name</span><span class="p">)</span> <span class="o"><</span> <span class="p">(</span><span class="mi">255</span> <span class="o">-</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">redirect_filename</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)):</span>
<span class="n">redirect_filename</span> <span class="o">=</span> <span class="s2">"le-redirect-</span><span class="si">%s</span><span class="s2">.conf"</span> <span class="o">%</span> <span class="n">ssl_vhost</span><span class="o">.</span><span class="n">name</span>
<span class="n">redirect_filepath</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">vhostroot</span><span class="p">,</span>
<span class="n">redirect_filename</span><span class="p">)</span>
<span class="c1"># Register the new file that will be created</span>
<span class="c1"># Note: always register the creation before writing to ensure file will</span>
<span class="c1"># be removed in case of unexpected program exit</span>
<span class="bp">self</span><span class="o">.</span><span class="n">reverter</span><span class="o">.</span><span class="n">register_file_creation</span><span class="p">(</span><span class="kc">False</span><span class="p">,</span> <span class="n">redirect_filepath</span><span class="p">)</span>
<span class="c1"># Write out file</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">redirect_filepath</span><span class="p">,</span> <span class="s2">"w"</span><span class="p">)</span> <span class="k">as</span> <span class="n">redirect_file</span><span class="p">:</span>
<span class="n">redirect_file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
<span class="c1"># Add new include to configuration if it doesn't exist yet</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">parsed_in_current</span><span class="p">(</span><span class="n">redirect_filepath</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">parse_file</span><span class="p">(</span><span class="n">redirect_filepath</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"Created redirect file: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">redirect_filename</span><span class="p">)</span>
<span class="k">return</span> <span class="n">redirect_filepath</span>
<div class="viewcode-block" id="ApacheConfigurator._get_http_vhost"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._get_http_vhost">[docs]</a> <span class="k">def</span> <span class="nf">_get_http_vhost</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ssl_vhost</span><span class="p">):</span>
<span class="sd">"""Find appropriate HTTP vhost for ssl_vhost."""</span>
<span class="c1"># First candidate vhosts filter</span>
<span class="k">if</span> <span class="n">ssl_vhost</span><span class="o">.</span><span class="n">ancestor</span><span class="p">:</span>
<span class="k">return</span> <span class="n">ssl_vhost</span><span class="o">.</span><span class="n">ancestor</span>
<span class="n">candidate_http_vhs</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">vhost</span> <span class="k">for</span> <span class="n">vhost</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">vhosts</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">vhost</span><span class="o">.</span><span class="n">ssl</span>
<span class="p">]</span>
<span class="c1"># Second filter - check addresses</span>
<span class="k">for</span> <span class="n">http_vh</span> <span class="ow">in</span> <span class="n">candidate_http_vhs</span><span class="p">:</span>
<span class="k">if</span> <span class="n">http_vh</span><span class="o">.</span><span class="n">same_server</span><span class="p">(</span><span class="n">ssl_vhost</span><span class="p">):</span>
<span class="k">return</span> <span class="n">http_vh</span>
<span class="c1"># Third filter - if none with same names, return generic</span>
<span class="k">for</span> <span class="n">http_vh</span> <span class="ow">in</span> <span class="n">candidate_http_vhs</span><span class="p">:</span>
<span class="k">if</span> <span class="n">http_vh</span><span class="o">.</span><span class="n">same_server</span><span class="p">(</span><span class="n">ssl_vhost</span><span class="p">,</span> <span class="n">generic</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="k">return</span> <span class="n">http_vh</span>
<span class="k">return</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="ApacheConfigurator._get_proposed_addrs"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._get_proposed_addrs">[docs]</a> <span class="k">def</span> <span class="nf">_get_proposed_addrs</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vhost</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="s2">"80"</span><span class="p">):</span>
<span class="sd">"""Return all addrs of vhost with the port replaced with the specified.</span>
<span class="sd"> :param obj.VirtualHost ssl_vhost: Original Vhost</span>
<span class="sd"> :param str port: Desired port for new addresses</span>
<span class="sd"> :returns: `set` of :class:`~obj.Addr`</span>
<span class="sd"> """</span>
<span class="n">redirects</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="k">for</span> <span class="n">addr</span> <span class="ow">in</span> <span class="n">vhost</span><span class="o">.</span><span class="n">addrs</span><span class="p">:</span>
<span class="n">redirects</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">addr</span><span class="o">.</span><span class="n">get_addr_obj</span><span class="p">(</span><span class="n">port</span><span class="p">))</span>
<span class="k">return</span> <span class="n">redirects</span></div>
<div class="viewcode-block" id="ApacheConfigurator.enable_site"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.enable_site">[docs]</a> <span class="k">def</span> <span class="nf">enable_site</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vhost</span><span class="p">):</span>
<span class="sd">"""Enables an available site, Apache reload required.</span>
<span class="sd"> .. note:: Does not make sure that the site correctly works or that all</span>
<span class="sd"> modules are enabled appropriately.</span>
<span class="sd"> .. note:: The distribution specific override replaces functionality</span>
<span class="sd"> of this method where available.</span>
<span class="sd"> :param vhost: vhost to enable</span>
<span class="sd"> :type vhost: :class:`~certbot_apache.obj.VirtualHost`</span>
<span class="sd"> :raises .errors.NotSupportedError: If filesystem layout is not</span>
<span class="sd"> supported.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">vhost</span><span class="o">.</span><span class="n">enabled</span><span class="p">:</span>
<span class="k">return</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">parsed_in_original</span><span class="p">(</span><span class="n">vhost</span><span class="o">.</span><span class="n">filep</span><span class="p">):</span>
<span class="c1"># Add direct include to root conf</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"Enabling site </span><span class="si">%s</span><span class="s2"> by adding Include to root configuration"</span><span class="p">,</span>
<span class="n">vhost</span><span class="o">.</span><span class="n">filep</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save_notes</span> <span class="o">+=</span> <span class="s2">"Enabled site </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">vhost</span><span class="o">.</span><span class="n">filep</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">add_include</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s2">"default"</span><span class="p">],</span> <span class="n">vhost</span><span class="o">.</span><span class="n">filep</span><span class="p">)</span>
<span class="n">vhost</span><span class="o">.</span><span class="n">enabled</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">return</span></div>
<div class="viewcode-block" id="ApacheConfigurator.enable_mod"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.enable_mod">[docs]</a> <span class="k">def</span> <span class="nf">enable_mod</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mod_name</span><span class="p">,</span> <span class="n">temp</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> <span class="c1"># pylint: disable=unused-argument</span>
<span class="sd">"""Enables module in Apache.</span>
<span class="sd"> Both enables and reloads Apache so module is active.</span>
<span class="sd"> :param str mod_name: Name of the module to enable. (e.g. 'ssl')</span>
<span class="sd"> :param bool temp: Whether or not this is a temporary action.</span>
<span class="sd"> .. note:: The distribution specific override replaces functionality</span>
<span class="sd"> of this method where available.</span>
<span class="sd"> :raises .errors.MisconfigurationError: We cannot enable modules in</span>
<span class="sd"> generic fashion.</span>
<span class="sd"> """</span>
<span class="n">mod_message</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"Apache needs to have module </span><span class="se">\"</span><span class="si">{0}</span><span class="se">\"</span><span class="s2"> active for the "</span> <span class="o">+</span>
<span class="s2">"requested installation options. Unfortunately Certbot is unable "</span> <span class="o">+</span>
<span class="s2">"to install or enable it for you. Please install the module, and "</span> <span class="o">+</span>
<span class="s2">"run Certbot again."</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">MisconfigurationError</span><span class="p">(</span><span class="n">mod_message</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">mod_name</span><span class="p">))</span></div>
<div class="viewcode-block" id="ApacheConfigurator.restart"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.restart">[docs]</a> <span class="k">def</span> <span class="nf">restart</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Runs a config test and reloads the Apache server.</span>
<span class="sd"> :raises .errors.MisconfigurationError: If either the config test</span>
<span class="sd"> or reload fails.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">config_test</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_reload</span><span class="p">()</span></div>
<div class="viewcode-block" id="ApacheConfigurator._reload"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator._reload">[docs]</a> <span class="k">def</span> <span class="nf">_reload</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Reloads the Apache server.</span>
<span class="sd"> :raises .errors.MisconfigurationError: If reload fails</span>
<span class="sd"> """</span>
<span class="n">error</span> <span class="o">=</span> <span class="s2">""</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">util</span><span class="o">.</span><span class="n">run_script</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">constant</span><span class="p">(</span><span class="s2">"restart_cmd"</span><span class="p">))</span>
<span class="k">except</span> <span class="n">errors</span><span class="o">.</span><span class="n">SubprocessError</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"Unable to restart apache using </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">constant</span><span class="p">(</span><span class="s2">"restart_cmd"</span><span class="p">))</span>
<span class="n">alt_restart</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">constant</span><span class="p">(</span><span class="s2">"restart_cmd_alt"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">alt_restart</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"Trying alternative restart command: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span>
<span class="n">alt_restart</span><span class="p">)</span>
<span class="c1"># There is an alternative restart command available</span>
<span class="c1"># This usually is "restart" verb while original is "graceful"</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">util</span><span class="o">.</span><span class="n">run_script</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">constant</span><span class="p">(</span>
<span class="s2">"restart_cmd_alt"</span><span class="p">))</span>
<span class="k">return</span>
<span class="k">except</span> <span class="n">errors</span><span class="o">.</span><span class="n">SubprocessError</span> <span class="k">as</span> <span class="n">secerr</span><span class="p">:</span>
<span class="n">error</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">secerr</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">error</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">err</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">MisconfigurationError</span><span class="p">(</span><span class="n">error</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheConfigurator.config_test"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.config_test">[docs]</a> <span class="k">def</span> <span class="nf">config_test</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="c1"># pylint: disable=no-self-use</span>
<span class="sd">"""Check the configuration of Apache for errors.</span>
<span class="sd"> :raises .errors.MisconfigurationError: If config_test fails</span>
<span class="sd"> """</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">util</span><span class="o">.</span><span class="n">run_script</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">constant</span><span class="p">(</span><span class="s2">"conftest_cmd"</span><span class="p">))</span>
<span class="k">except</span> <span class="n">errors</span><span class="o">.</span><span class="n">SubprocessError</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">MisconfigurationError</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">err</span><span class="p">))</span></div>
<div class="viewcode-block" id="ApacheConfigurator.get_version"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.get_version">[docs]</a> <span class="k">def</span> <span class="nf">get_version</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Return version of Apache Server.</span>
<span class="sd"> Version is returned as tuple. (ie. 2.4.7 = (2, 4, 7))</span>
<span class="sd"> :returns: version</span>
<span class="sd"> :rtype: tuple</span>
<span class="sd"> :raises .PluginError: if unable to find Apache version</span>
<span class="sd"> """</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">stdout</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">util</span><span class="o">.</span><span class="n">run_script</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">constant</span><span class="p">(</span><span class="s2">"version_cmd"</span><span class="p">))</span>
<span class="k">except</span> <span class="n">errors</span><span class="o">.</span><span class="n">SubprocessError</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span>
<span class="s2">"Unable to run </span><span class="si">%s</span><span class="s2"> -v"</span> <span class="o">%</span>
<span class="bp">self</span><span class="o">.</span><span class="n">constant</span><span class="p">(</span><span class="s2">"version_cmd"</span><span class="p">))</span>
<span class="n">regex</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="sa">r</span><span class="s2">"Apache/([0-9\.]*)"</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">IGNORECASE</span><span class="p">)</span>
<span class="n">matches</span> <span class="o">=</span> <span class="n">regex</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="n">stdout</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">matches</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span><span class="s2">"Unable to find Apache version"</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">tuple</span><span class="p">([</span><span class="nb">int</span><span class="p">(</span><span class="n">i</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">matches</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"."</span><span class="p">)])</span></div>
<div class="viewcode-block" id="ApacheConfigurator.more_info"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.more_info">[docs]</a> <span class="k">def</span> <span class="nf">more_info</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Human-readable string to help understand the module"""</span>
<span class="k">return</span> <span class="p">(</span>
<span class="s2">"Configures Apache to authenticate and install HTTPS.</span><span class="si">{0}</span><span class="s2">"</span>
<span class="s2">"Server root: </span><span class="si">{root}{0}</span><span class="s2">"</span>
<span class="s2">"Version: </span><span class="si">{version}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">os</span><span class="o">.</span><span class="n">linesep</span><span class="p">,</span> <span class="n">root</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s2">"root"</span><span class="p">],</span>
<span class="n">version</span><span class="o">=</span><span class="s2">"."</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">i</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">version</span><span class="p">))</span>
<span class="p">)</span></div>
<span class="c1">###########################################################################</span>
<span class="c1"># Challenges Section</span>
<span class="c1">###########################################################################</span>
<div class="viewcode-block" id="ApacheConfigurator.get_chall_pref"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.get_chall_pref">[docs]</a> <span class="k">def</span> <span class="nf">get_chall_pref</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">unused_domain</span><span class="p">):</span> <span class="c1"># pylint: disable=no-self-use</span>
<span class="sd">"""Return list of challenge preferences."""</span>
<span class="k">return</span> <span class="p">[</span><span class="n">challenges</span><span class="o">.</span><span class="n">TLSSNI01</span><span class="p">,</span> <span class="n">challenges</span><span class="o">.</span><span class="n">HTTP01</span><span class="p">]</span></div>
<div class="viewcode-block" id="ApacheConfigurator.perform"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.perform">[docs]</a> <span class="k">def</span> <span class="nf">perform</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">achalls</span><span class="p">):</span>
<span class="sd">"""Perform the configuration related challenge.</span>
<span class="sd"> This function currently assumes all challenges will be fulfilled.</span>
<span class="sd"> If this turns out not to be the case in the future. Cleanup and</span>
<span class="sd"> outstanding challenges will have to be designed better.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_chall_out</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">achalls</span><span class="p">)</span>
<span class="n">responses</span> <span class="o">=</span> <span class="p">[</span><span class="kc">None</span><span class="p">]</span> <span class="o">*</span> <span class="nb">len</span><span class="p">(</span><span class="n">achalls</span><span class="p">)</span>
<span class="n">http_doer</span> <span class="o">=</span> <span class="n">http_01</span><span class="o">.</span><span class="n">ApacheHttp01</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">sni_doer</span> <span class="o">=</span> <span class="n">tls_sni_01</span><span class="o">.</span><span class="n">ApacheTlsSni01</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">achall</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">achalls</span><span class="p">):</span>
<span class="c1"># Currently also have chall_doer hold associated index of the</span>
<span class="c1"># challenge. This helps to put all of the responses back together</span>
<span class="c1"># when they are all complete.</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">achall</span><span class="o">.</span><span class="n">chall</span><span class="p">,</span> <span class="n">challenges</span><span class="o">.</span><span class="n">HTTP01</span><span class="p">):</span>
<span class="n">http_doer</span><span class="o">.</span><span class="n">add_chall</span><span class="p">(</span><span class="n">achall</span><span class="p">,</span> <span class="n">i</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span> <span class="c1"># tls-sni-01</span>
<span class="n">sni_doer</span><span class="o">.</span><span class="n">add_chall</span><span class="p">(</span><span class="n">achall</span><span class="p">,</span> <span class="n">i</span><span class="p">)</span>
<span class="n">http_response</span> <span class="o">=</span> <span class="n">http_doer</span><span class="o">.</span><span class="n">perform</span><span class="p">()</span>
<span class="n">sni_response</span> <span class="o">=</span> <span class="n">sni_doer</span><span class="o">.</span><span class="n">perform</span><span class="p">()</span>
<span class="k">if</span> <span class="n">http_response</span> <span class="ow">or</span> <span class="n">sni_response</span><span class="p">:</span>
<span class="c1"># Must reload in order to activate the challenges.</span>
<span class="c1"># Handled here because we may be able to load up other challenge</span>
<span class="c1"># types</span>
<span class="bp">self</span><span class="o">.</span><span class="n">restart</span><span class="p">()</span>
<span class="c1"># TODO: Remove this dirty hack. We need to determine a reliable way</span>
<span class="c1"># of identifying when the new configuration is being used.</span>
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_update_responses</span><span class="p">(</span><span class="n">responses</span><span class="p">,</span> <span class="n">http_response</span><span class="p">,</span> <span class="n">http_doer</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_update_responses</span><span class="p">(</span><span class="n">responses</span><span class="p">,</span> <span class="n">sni_response</span><span class="p">,</span> <span class="n">sni_doer</span><span class="p">)</span>
<span class="k">return</span> <span class="n">responses</span></div>
<span class="k">def</span> <span class="nf">_update_responses</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">responses</span><span class="p">,</span> <span class="n">chall_response</span><span class="p">,</span> <span class="n">chall_doer</span><span class="p">):</span>
<span class="c1"># Go through all of the challenges and assign them to the proper</span>
<span class="c1"># place in the responses return value. All responses must be in the</span>
<span class="c1"># same order as the original challenges.</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">resp</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">chall_response</span><span class="p">):</span>
<span class="n">responses</span><span class="p">[</span><span class="n">chall_doer</span><span class="o">.</span><span class="n">indices</span><span class="p">[</span><span class="n">i</span><span class="p">]]</span> <span class="o">=</span> <span class="n">resp</span>
<div class="viewcode-block" id="ApacheConfigurator.cleanup"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.cleanup">[docs]</a> <span class="k">def</span> <span class="nf">cleanup</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">achalls</span><span class="p">):</span>
<span class="sd">"""Revert all challenges."""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_chall_out</span><span class="o">.</span><span class="n">difference_update</span><span class="p">(</span><span class="n">achalls</span><span class="p">)</span>
<span class="c1"># If all of the challenges have been finished, clean up everything</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_chall_out</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">revert_challenge_config</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">restart</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">reset_modules</span><span class="p">()</span></div>
<div class="viewcode-block" id="ApacheConfigurator.install_ssl_options_conf"><a class="viewcode-back" href="../../api/configurator.html#certbot_apache.configurator.ApacheConfigurator.install_ssl_options_conf">[docs]</a> <span class="k">def</span> <span class="nf">install_ssl_options_conf</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">options_ssl</span><span class="p">,</span> <span class="n">options_ssl_digest</span><span class="p">):</span>
<span class="sd">"""Copy Certbot's SSL options file into the system's config dir if required."""</span>
<span class="c1"># XXX if we ever try to enforce a local privilege boundary (eg, running</span>
<span class="c1"># certbot for unprivileged users via setuid), this function will need</span>
<span class="c1"># to be modified.</span>
<span class="k">return</span> <span class="n">common</span><span class="o">.</span><span class="n">install_version_controlled_file</span><span class="p">(</span><span class="n">options_ssl</span><span class="p">,</span> <span class="n">options_ssl_digest</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">constant</span><span class="p">(</span><span class="s2">"MOD_SSL_CONF_SRC"</span><span class="p">),</span> <span class="n">constants</span><span class="o">.</span><span class="n">ALL_SSL_OPTIONS_HASHES</span><span class="p">)</span></div></div>
</pre></div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2014-2018, Let's Encrypt Project.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
|