/usr/share/doc/python3-certbot/html/_modules/certbot/auth_handler.html is in python-certbot-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 | <!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.auth_handler — Certbot 0.23.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 0.23.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
</a>
<div class="version">
0.23
</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="../../intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../what.html">What is a Certificate?</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../install.html">Get Certbot</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../using.html">User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Developer Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../packaging.html">Packaging Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../resources.html">Resources</a></li>
</ul>
<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</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.auth_handler</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.auth_handler</h1><div class="highlight"><pre>
<span></span><span class="sd">"""ACME AuthHandler."""</span>
<span class="kn">import</span> <span class="nn">collections</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">time</span>
<span class="kn">import</span> <span class="nn">six</span>
<span class="kn">import</span> <span class="nn">zope.component</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">acme</span> <span class="k">import</span> <span class="n">messages</span>
<span class="kn">from</span> <span class="nn">certbot</span> <span class="k">import</span> <span class="n">achallenges</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">error_handler</span>
<span class="kn">from</span> <span class="nn">certbot</span> <span class="k">import</span> <span class="n">interfaces</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="n">AnnotatedAuthzr</span> <span class="o">=</span> <span class="n">collections</span><span class="o">.</span><span class="n">namedtuple</span><span class="p">(</span><span class="s2">"AnnotatedAuthzr"</span><span class="p">,</span> <span class="p">[</span><span class="s2">"authzr"</span><span class="p">,</span> <span class="s2">"achalls"</span><span class="p">])</span>
<span class="sd">"""Stores an authorization resource and its active annotated challenges."""</span>
<div class="viewcode-block" id="AuthHandler"><a class="viewcode-back" href="../../api/auth_handler.html#certbot.auth_handler.AuthHandler">[docs]</a><span class="k">class</span> <span class="nc">AuthHandler</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""ACME Authorization Handler for a client.</span>
<span class="sd"> :ivar auth: Authenticator capable of solving</span>
<span class="sd"> :class:`~acme.challenges.Challenge` types</span>
<span class="sd"> :type auth: :class:`certbot.interfaces.IAuthenticator`</span>
<span class="sd"> :ivar acme.client.BackwardsCompatibleClientV2 acme: ACME client API.</span>
<span class="sd"> :ivar account: Client's Account</span>
<span class="sd"> :type account: :class:`certbot.account.Account`</span>
<span class="sd"> :ivar list pref_challs: sorted user specified preferred challenges</span>
<span class="sd"> type strings with the most preferred challenge listed first</span>
<span class="sd"> """</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="n">auth</span><span class="p">,</span> <span class="n">acme</span><span class="p">,</span> <span class="n">account</span><span class="p">,</span> <span class="n">pref_challs</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">auth</span> <span class="o">=</span> <span class="n">auth</span>
<span class="bp">self</span><span class="o">.</span><span class="n">acme</span> <span class="o">=</span> <span class="n">acme</span>
<span class="bp">self</span><span class="o">.</span><span class="n">account</span> <span class="o">=</span> <span class="n">account</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pref_challs</span> <span class="o">=</span> <span class="n">pref_challs</span>
<div class="viewcode-block" id="AuthHandler.handle_authorizations"><a class="viewcode-back" href="../../api/auth_handler.html#certbot.auth_handler.AuthHandler.handle_authorizations">[docs]</a> <span class="k">def</span> <span class="nf">handle_authorizations</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">orderr</span><span class="p">,</span> <span class="n">best_effort</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""Retrieve all authorizations for challenges.</span>
<span class="sd"> :param acme.messages.OrderResource orderr: must have</span>
<span class="sd"> authorizations filled in</span>
<span class="sd"> :param bool best_effort: Whether or not all authorizations are</span>
<span class="sd"> required (this is useful in renewal)</span>
<span class="sd"> :returns: List of authorization resources</span>
<span class="sd"> :rtype: list</span>
<span class="sd"> :raises .AuthorizationError: If unable to retrieve all</span>
<span class="sd"> authorizations</span>
<span class="sd"> """</span>
<span class="n">aauthzrs</span> <span class="o">=</span> <span class="p">[</span><span class="n">AnnotatedAuthzr</span><span class="p">(</span><span class="n">authzr</span><span class="p">,</span> <span class="p">[])</span>
<span class="k">for</span> <span class="n">authzr</span> <span class="ow">in</span> <span class="n">orderr</span><span class="o">.</span><span class="n">authorizations</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_choose_challenges</span><span class="p">(</span><span class="n">aauthzrs</span><span class="p">)</span>
<span class="n">config</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">IConfig</span><span class="p">)</span>
<span class="n">notify</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">IDisplay</span><span class="p">)</span><span class="o">.</span><span class="n">notification</span>
<span class="c1"># While there are still challenges remaining...</span>
<span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">_has_challenges</span><span class="p">(</span><span class="n">aauthzrs</span><span class="p">):</span>
<span class="k">with</span> <span class="n">error_handler</span><span class="o">.</span><span class="n">ExitHandler</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_cleanup_challenges</span><span class="p">,</span> <span class="n">aauthzrs</span><span class="p">):</span>
<span class="n">resp</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_solve_challenges</span><span class="p">(</span><span class="n">aauthzrs</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">"Waiting for verification..."</span><span class="p">)</span>
<span class="k">if</span> <span class="n">config</span><span class="o">.</span><span class="n">debug_challenges</span><span class="p">:</span>
<span class="n">notify</span><span class="p">(</span><span class="s1">'Challenges loaded. Press continue to submit to CA. '</span>
<span class="s1">'Pass "-v" for more info about challenges.'</span><span class="p">,</span> <span class="n">pause</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="c1"># Send all Responses - this modifies achalls</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_respond</span><span class="p">(</span><span class="n">aauthzrs</span><span class="p">,</span> <span class="n">resp</span><span class="p">,</span> <span class="n">best_effort</span><span class="p">)</span>
<span class="c1"># Just make sure all decisions are complete.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">verify_authzr_complete</span><span class="p">(</span><span class="n">aauthzrs</span><span class="p">)</span>
<span class="c1"># Only return valid authorizations</span>
<span class="n">retVal</span> <span class="o">=</span> <span class="p">[</span><span class="n">aauthzr</span><span class="o">.</span><span class="n">authzr</span> <span class="k">for</span> <span class="n">aauthzr</span> <span class="ow">in</span> <span class="n">aauthzrs</span>
<span class="k">if</span> <span class="n">aauthzr</span><span class="o">.</span><span class="n">authzr</span><span class="o">.</span><span class="n">body</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="n">messages</span><span class="o">.</span><span class="n">STATUS_VALID</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">retVal</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">AuthorizationError</span><span class="p">(</span>
<span class="s2">"Challenges failed for all domains"</span><span class="p">)</span>
<span class="k">return</span> <span class="n">retVal</span></div>
<div class="viewcode-block" id="AuthHandler._choose_challenges"><a class="viewcode-back" href="../../api/auth_handler.html#certbot.auth_handler.AuthHandler._choose_challenges">[docs]</a> <span class="k">def</span> <span class="nf">_choose_challenges</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">aauthzrs</span><span class="p">):</span>
<span class="sd">"""Retrieve necessary challenges to satisfy server."""</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"Performing the following challenges:"</span><span class="p">)</span>
<span class="k">for</span> <span class="n">aauthzr</span> <span class="ow">in</span> <span class="n">aauthzrs</span><span class="p">:</span>
<span class="n">aauthzr_challenges</span> <span class="o">=</span> <span class="n">aauthzr</span><span class="o">.</span><span class="n">authzr</span><span class="o">.</span><span class="n">body</span><span class="o">.</span><span class="n">challenges</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">acme</span><span class="o">.</span><span class="n">acme_version</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">combinations</span> <span class="o">=</span> <span class="n">aauthzr</span><span class="o">.</span><span class="n">authzr</span><span class="o">.</span><span class="n">body</span><span class="o">.</span><span class="n">combinations</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">combinations</span> <span class="o">=</span> <span class="nb">tuple</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="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">aauthzr_challenges</span><span class="p">)))</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">gen_challenge_path</span><span class="p">(</span>
<span class="n">aauthzr_challenges</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_get_chall_pref</span><span class="p">(</span><span class="n">aauthzr</span><span class="o">.</span><span class="n">authzr</span><span class="o">.</span><span class="n">body</span><span class="o">.</span><span class="n">identifier</span><span class="o">.</span><span class="n">value</span><span class="p">),</span>
<span class="n">combinations</span><span class="p">)</span>
<span class="n">aauthzr_achalls</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_challenge_factory</span><span class="p">(</span>
<span class="n">aauthzr</span><span class="o">.</span><span class="n">authzr</span><span class="p">,</span> <span class="n">path</span><span class="p">)</span>
<span class="n">aauthzr</span><span class="o">.</span><span class="n">achalls</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">aauthzr_achalls</span><span class="p">)</span></div>
<div class="viewcode-block" id="AuthHandler._has_challenges"><a class="viewcode-back" href="../../api/auth_handler.html#certbot.auth_handler.AuthHandler._has_challenges">[docs]</a> <span class="k">def</span> <span class="nf">_has_challenges</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">aauthzrs</span><span class="p">):</span>
<span class="sd">"""Do we have any challenges to perform?"""</span>
<span class="k">return</span> <span class="nb">any</span><span class="p">(</span><span class="n">aauthzr</span><span class="o">.</span><span class="n">achalls</span> <span class="k">for</span> <span class="n">aauthzr</span> <span class="ow">in</span> <span class="n">aauthzrs</span><span class="p">)</span></div>
<div class="viewcode-block" id="AuthHandler._solve_challenges"><a class="viewcode-back" href="../../api/auth_handler.html#certbot.auth_handler.AuthHandler._solve_challenges">[docs]</a> <span class="k">def</span> <span class="nf">_solve_challenges</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">aauthzrs</span><span class="p">):</span>
<span class="sd">"""Get Responses for challenges from authenticators."""</span>
<span class="n">resp</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">all_achalls</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_all_achalls</span><span class="p">(</span><span class="n">aauthzrs</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="n">all_achalls</span><span class="p">:</span>
<span class="n">resp</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">auth</span><span class="o">.</span><span class="n">perform</span><span class="p">(</span><span class="n">all_achalls</span><span class="p">)</span>
<span class="k">except</span> <span class="n">errors</span><span class="o">.</span><span class="n">AuthorizationError</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span><span class="s2">"Failure in setting up challenges."</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">"Attempting to clean up outstanding challenges..."</span><span class="p">)</span>
<span class="k">raise</span>
<span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">all_achalls</span><span class="p">)</span>
<span class="k">return</span> <span class="n">resp</span></div>
<div class="viewcode-block" id="AuthHandler._get_all_achalls"><a class="viewcode-back" href="../../api/auth_handler.html#certbot.auth_handler.AuthHandler._get_all_achalls">[docs]</a> <span class="k">def</span> <span class="nf">_get_all_achalls</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">aauthzrs</span><span class="p">):</span>
<span class="sd">"""Return all active challenges."""</span>
<span class="n">all_achalls</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">aauthzr</span> <span class="ow">in</span> <span class="n">aauthzrs</span><span class="p">:</span>
<span class="n">all_achalls</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">aauthzr</span><span class="o">.</span><span class="n">achalls</span><span class="p">)</span>
<span class="k">return</span> <span class="n">all_achalls</span></div>
<div class="viewcode-block" id="AuthHandler._respond"><a class="viewcode-back" href="../../api/auth_handler.html#certbot.auth_handler.AuthHandler._respond">[docs]</a> <span class="k">def</span> <span class="nf">_respond</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">aauthzrs</span><span class="p">,</span> <span class="n">resp</span><span class="p">,</span> <span class="n">best_effort</span><span class="p">):</span>
<span class="sd">"""Send/Receive confirmation of all challenges.</span>
<span class="sd"> .. note:: This method also cleans up the auth_handler state.</span>
<span class="sd"> """</span>
<span class="c1"># TODO: chall_update is a dirty hack to get around acme-spec #105</span>
<span class="n">chall_update</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_send_responses</span><span class="p">(</span><span class="n">aauthzrs</span><span class="p">,</span> <span class="n">resp</span><span class="p">,</span> <span class="n">chall_update</span><span class="p">)</span>
<span class="c1"># Check for updated status...</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_poll_challenges</span><span class="p">(</span><span class="n">aauthzrs</span><span class="p">,</span> <span class="n">chall_update</span><span class="p">,</span> <span class="n">best_effort</span><span class="p">)</span></div>
<div class="viewcode-block" id="AuthHandler._send_responses"><a class="viewcode-back" href="../../api/auth_handler.html#certbot.auth_handler.AuthHandler._send_responses">[docs]</a> <span class="k">def</span> <span class="nf">_send_responses</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">aauthzrs</span><span class="p">,</span> <span class="n">resps</span><span class="p">,</span> <span class="n">chall_update</span><span class="p">):</span>
<span class="sd">"""Send responses and make sure errors are handled.</span>
<span class="sd"> :param aauthzrs: authorizations and the selected annotated challenges</span>
<span class="sd"> to try and perform</span>
<span class="sd"> :type aauthzrs: `list` of `AnnotatedAuthzr`</span>
<span class="sd"> :param resps: challenge responses from the authenticator where</span>
<span class="sd"> each response at index i corresponds to the annotated</span>
<span class="sd"> challenge at index i in the list returned by</span>
<span class="sd"> :func:`_get_all_achalls`</span>
<span class="sd"> :type resps: `collections.abc.Iterable` of</span>
<span class="sd"> :class:`~acme.challenges.ChallengeResponse` or `False` or</span>
<span class="sd"> `None`</span>
<span class="sd"> :param dict chall_update: parameter that is updated to hold</span>
<span class="sd"> aauthzr index to list of outstanding solved annotated challenges</span>
<span class="sd"> """</span>
<span class="n">active_achalls</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">resps_iter</span> <span class="o">=</span> <span class="nb">iter</span><span class="p">(</span><span class="n">resps</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">aauthzr</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">aauthzrs</span><span class="p">):</span>
<span class="k">for</span> <span class="n">achall</span> <span class="ow">in</span> <span class="n">aauthzr</span><span class="o">.</span><span class="n">achalls</span><span class="p">:</span>
<span class="c1"># This line needs to be outside of the if block below to</span>
<span class="c1"># ensure failed challenges are cleaned up correctly</span>
<span class="n">active_achalls</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">achall</span><span class="p">)</span>
<span class="n">resp</span> <span class="o">=</span> <span class="nb">next</span><span class="p">(</span><span class="n">resps_iter</span><span class="p">)</span>
<span class="c1"># Don't send challenges for None and False authenticator responses</span>
<span class="k">if</span> <span class="n">resp</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">acme</span><span class="o">.</span><span class="n">answer_challenge</span><span class="p">(</span><span class="n">achall</span><span class="o">.</span><span class="n">challb</span><span class="p">,</span> <span class="n">resp</span><span class="p">)</span>
<span class="c1"># TODO: answer_challenge returns challr, with URI,</span>
<span class="c1"># that can be used in _find_updated_challr</span>
<span class="c1"># comparisons...</span>
<span class="n">chall_update</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">achall</span><span class="p">)</span>
<span class="k">return</span> <span class="n">active_achalls</span></div>
<div class="viewcode-block" id="AuthHandler._poll_challenges"><a class="viewcode-back" href="../../api/auth_handler.html#certbot.auth_handler.AuthHandler._poll_challenges">[docs]</a> <span class="k">def</span> <span class="nf">_poll_challenges</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">aauthzrs</span><span class="p">,</span> <span class="n">chall_update</span><span class="p">,</span>
<span class="n">best_effort</span><span class="p">,</span> <span class="n">min_sleep</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">max_rounds</span><span class="o">=</span><span class="mi">15</span><span class="p">):</span>
<span class="sd">"""Wait for all challenge results to be determined."""</span>
<span class="n">indices_to_check</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">chall_update</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
<span class="n">comp_indices</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="n">rounds</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">while</span> <span class="n">indices_to_check</span> <span class="ow">and</span> <span class="n">rounds</span> <span class="o"><</span> <span class="n">max_rounds</span><span class="p">:</span>
<span class="c1"># TODO: Use retry-after...</span>
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">min_sleep</span><span class="p">)</span>
<span class="n">all_failed_achalls</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="k">for</span> <span class="n">index</span> <span class="ow">in</span> <span class="n">indices_to_check</span><span class="p">:</span>
<span class="n">comp_achalls</span><span class="p">,</span> <span class="n">failed_achalls</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_handle_check</span><span class="p">(</span>
<span class="n">aauthzrs</span><span class="p">,</span> <span class="n">index</span><span class="p">,</span> <span class="n">chall_update</span><span class="p">[</span><span class="n">index</span><span class="p">])</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">comp_achalls</span><span class="p">)</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">chall_update</span><span class="p">[</span><span class="n">index</span><span class="p">]):</span>
<span class="n">comp_indices</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">index</span><span class="p">)</span>
<span class="k">elif</span> <span class="ow">not</span> <span class="n">failed_achalls</span><span class="p">:</span>
<span class="k">for</span> <span class="n">achall</span><span class="p">,</span> <span class="n">_</span> <span class="ow">in</span> <span class="n">comp_achalls</span><span class="p">:</span>
<span class="n">chall_update</span><span class="p">[</span><span class="n">index</span><span class="p">]</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">achall</span><span class="p">)</span>
<span class="c1"># We failed some challenges... damage control</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="n">best_effort</span><span class="p">:</span>
<span class="n">comp_indices</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">index</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">"Challenge failed for domain </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span>
<span class="n">aauthzrs</span><span class="p">[</span><span class="n">index</span><span class="p">]</span><span class="o">.</span><span class="n">authzr</span><span class="o">.</span><span class="n">body</span><span class="o">.</span><span class="n">identifier</span><span class="o">.</span><span class="n">value</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">all_failed_achalls</span><span class="o">.</span><span class="n">update</span><span class="p">(</span>
<span class="n">updated</span> <span class="k">for</span> <span class="n">_</span><span class="p">,</span> <span class="n">updated</span> <span class="ow">in</span> <span class="n">failed_achalls</span><span class="p">)</span>
<span class="k">if</span> <span class="n">all_failed_achalls</span><span class="p">:</span>
<span class="n">_report_failed_challs</span><span class="p">(</span><span class="n">all_failed_achalls</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">FailedChallenges</span><span class="p">(</span><span class="n">all_failed_achalls</span><span class="p">)</span>
<span class="n">indices_to_check</span> <span class="o">-=</span> <span class="n">comp_indices</span>
<span class="n">comp_indices</span><span class="o">.</span><span class="n">clear</span><span class="p">()</span>
<span class="n">rounds</span> <span class="o">+=</span> <span class="mi">1</span></div>
<div class="viewcode-block" id="AuthHandler._handle_check"><a class="viewcode-back" href="../../api/auth_handler.html#certbot.auth_handler.AuthHandler._handle_check">[docs]</a> <span class="k">def</span> <span class="nf">_handle_check</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">aauthzrs</span><span class="p">,</span> <span class="n">index</span><span class="p">,</span> <span class="n">achalls</span><span class="p">):</span>
<span class="sd">"""Returns tuple of ('completed', 'failed')."""</span>
<span class="n">completed</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">failed</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">original_aauthzr</span> <span class="o">=</span> <span class="n">aauthzrs</span><span class="p">[</span><span class="n">index</span><span class="p">]</span>
<span class="n">updated_authzr</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">acme</span><span class="o">.</span><span class="n">poll</span><span class="p">(</span><span class="n">original_aauthzr</span><span class="o">.</span><span class="n">authzr</span><span class="p">)</span>
<span class="n">aauthzrs</span><span class="p">[</span><span class="n">index</span><span class="p">]</span> <span class="o">=</span> <span class="n">AnnotatedAuthzr</span><span class="p">(</span><span class="n">updated_authzr</span><span class="p">,</span> <span class="n">original_aauthzr</span><span class="o">.</span><span class="n">achalls</span><span class="p">)</span>
<span class="k">if</span> <span class="n">updated_authzr</span><span class="o">.</span><span class="n">body</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="n">messages</span><span class="o">.</span><span class="n">STATUS_VALID</span><span class="p">:</span>
<span class="k">return</span> <span class="n">achalls</span><span class="p">,</span> <span class="p">[]</span>
<span class="c1"># Note: if the whole authorization is invalid, the individual failed</span>
<span class="c1"># challenges will be determined here...</span>
<span class="k">for</span> <span class="n">achall</span> <span class="ow">in</span> <span class="n">achalls</span><span class="p">:</span>
<span class="n">updated_achall</span> <span class="o">=</span> <span class="n">achall</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">challb</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_find_updated_challb</span><span class="p">(</span>
<span class="n">updated_authzr</span><span class="p">,</span> <span class="n">achall</span><span class="p">))</span>
<span class="c1"># This does nothing for challenges that have yet to be decided yet.</span>
<span class="k">if</span> <span class="n">updated_achall</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="n">messages</span><span class="o">.</span><span class="n">STATUS_VALID</span><span class="p">:</span>
<span class="n">completed</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">achall</span><span class="p">,</span> <span class="n">updated_achall</span><span class="p">))</span>
<span class="k">elif</span> <span class="n">updated_achall</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="n">messages</span><span class="o">.</span><span class="n">STATUS_INVALID</span><span class="p">:</span>
<span class="n">failed</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">achall</span><span class="p">,</span> <span class="n">updated_achall</span><span class="p">))</span>
<span class="k">return</span> <span class="n">completed</span><span class="p">,</span> <span class="n">failed</span></div>
<div class="viewcode-block" id="AuthHandler._find_updated_challb"><a class="viewcode-back" href="../../api/auth_handler.html#certbot.auth_handler.AuthHandler._find_updated_challb">[docs]</a> <span class="k">def</span> <span class="nf">_find_updated_challb</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">authzr</span><span class="p">,</span> <span class="n">achall</span><span class="p">):</span> <span class="c1"># pylint: disable=no-self-use</span>
<span class="sd">"""Find updated challenge body within Authorization Resource.</span>
<span class="sd"> .. warning:: This assumes only one instance of type of challenge in</span>
<span class="sd"> each challenge resource.</span>
<span class="sd"> :param .AuthorizationResource authzr: Authorization Resource</span>
<span class="sd"> :param .AnnotatedChallenge achall: Annotated challenge for which</span>
<span class="sd"> to get status</span>
<span class="sd"> """</span>
<span class="k">for</span> <span class="n">authzr_challb</span> <span class="ow">in</span> <span class="n">authzr</span><span class="o">.</span><span class="n">body</span><span class="o">.</span><span class="n">challenges</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">authzr_challb</span><span class="o">.</span><span class="n">chall</span><span class="p">)</span> <span class="ow">is</span> <span class="nb">type</span><span class="p">(</span><span class="n">achall</span><span class="o">.</span><span class="n">challb</span><span class="o">.</span><span class="n">chall</span><span class="p">):</span> <span class="c1"># noqa</span>
<span class="k">return</span> <span class="n">authzr_challb</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">AuthorizationError</span><span class="p">(</span>
<span class="s2">"Target challenge not found in authorization resource"</span><span class="p">)</span></div>
<div class="viewcode-block" id="AuthHandler._get_chall_pref"><a class="viewcode-back" href="../../api/auth_handler.html#certbot.auth_handler.AuthHandler._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">domain</span><span class="p">):</span>
<span class="sd">"""Return list of challenge preferences.</span>
<span class="sd"> :param str domain: domain for which you are requesting preferences</span>
<span class="sd"> """</span>
<span class="n">chall_prefs</span> <span class="o">=</span> <span class="p">[]</span>
<span class="c1"># Make sure to make a copy...</span>
<span class="n">plugin_pref</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">auth</span><span class="o">.</span><span class="n">get_chall_pref</span><span class="p">(</span><span class="n">domain</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">pref_challs</span><span class="p">:</span>
<span class="n">plugin_pref_types</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">chall</span><span class="o">.</span><span class="n">typ</span> <span class="k">for</span> <span class="n">chall</span> <span class="ow">in</span> <span class="n">plugin_pref</span><span class="p">)</span>
<span class="k">for</span> <span class="n">typ</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">pref_challs</span><span class="p">:</span>
<span class="k">if</span> <span class="n">typ</span> <span class="ow">in</span> <span class="n">plugin_pref_types</span><span class="p">:</span>
<span class="n">chall_prefs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">challenges</span><span class="o">.</span><span class="n">Challenge</span><span class="o">.</span><span class="n">TYPES</span><span class="p">[</span><span class="n">typ</span><span class="p">])</span>
<span class="k">if</span> <span class="n">chall_prefs</span><span class="p">:</span>
<span class="k">return</span> <span class="n">chall_prefs</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">AuthorizationError</span><span class="p">(</span>
<span class="s2">"None of the preferred challenges "</span>
<span class="s2">"are supported by the selected plugin"</span><span class="p">)</span>
<span class="n">chall_prefs</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">plugin_pref</span><span class="p">)</span>
<span class="k">return</span> <span class="n">chall_prefs</span></div>
<div class="viewcode-block" id="AuthHandler._cleanup_challenges"><a class="viewcode-back" href="../../api/auth_handler.html#certbot.auth_handler.AuthHandler._cleanup_challenges">[docs]</a> <span class="k">def</span> <span class="nf">_cleanup_challenges</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">aauthzrs</span><span class="p">,</span> <span class="n">achalls</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Cleanup challenges.</span>
<span class="sd"> :param aauthzrs: authorizations and their selected annotated</span>
<span class="sd"> challenges</span>
<span class="sd"> :type aauthzrs: `list` of `AnnotatedAuthzr`</span>
<span class="sd"> :param achalls: annotated challenges to cleanup</span>
<span class="sd"> :type achalls: `list` of :class:`certbot.achallenges.AnnotatedChallenge`</span>
<span class="sd"> """</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"Cleaning up challenges"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">achalls</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">achalls</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_all_achalls</span><span class="p">(</span><span class="n">aauthzrs</span><span class="p">)</span>
<span class="k">if</span> <span class="n">achalls</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">auth</span><span class="o">.</span><span class="n">cleanup</span><span class="p">(</span><span class="n">achalls</span><span class="p">)</span>
<span class="k">for</span> <span class="n">achall</span> <span class="ow">in</span> <span class="n">achalls</span><span class="p">:</span>
<span class="k">for</span> <span class="n">aauthzr</span> <span class="ow">in</span> <span class="n">aauthzrs</span><span class="p">:</span>
<span class="k">if</span> <span class="n">achall</span> <span class="ow">in</span> <span class="n">aauthzr</span><span class="o">.</span><span class="n">achalls</span><span class="p">:</span>
<span class="n">aauthzr</span><span class="o">.</span><span class="n">achalls</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">achall</span><span class="p">)</span>
<span class="k">break</span></div>
<div class="viewcode-block" id="AuthHandler.verify_authzr_complete"><a class="viewcode-back" href="../../api/auth_handler.html#certbot.auth_handler.AuthHandler.verify_authzr_complete">[docs]</a> <span class="k">def</span> <span class="nf">verify_authzr_complete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">aauthzrs</span><span class="p">):</span>
<span class="sd">"""Verifies that all authorizations have been decided.</span>
<span class="sd"> :param aauthzrs: authorizations and their selected annotated</span>
<span class="sd"> challenges</span>
<span class="sd"> :type aauthzrs: `list` of `AnnotatedAuthzr`</span>
<span class="sd"> :returns: Whether all authzr are complete</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> """</span>
<span class="k">for</span> <span class="n">aauthzr</span> <span class="ow">in</span> <span class="n">aauthzrs</span><span class="p">:</span>
<span class="n">authzr</span> <span class="o">=</span> <span class="n">aauthzr</span><span class="o">.</span><span class="n">authzr</span>
<span class="k">if</span> <span class="p">(</span><span class="n">authzr</span><span class="o">.</span><span class="n">body</span><span class="o">.</span><span class="n">status</span> <span class="o">!=</span> <span class="n">messages</span><span class="o">.</span><span class="n">STATUS_VALID</span> <span class="ow">and</span>
<span class="n">authzr</span><span class="o">.</span><span class="n">body</span><span class="o">.</span><span class="n">status</span> <span class="o">!=</span> <span class="n">messages</span><span class="o">.</span><span class="n">STATUS_INVALID</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">AuthorizationError</span><span class="p">(</span><span class="s2">"Incomplete authorizations"</span><span class="p">)</span></div>
<div class="viewcode-block" id="AuthHandler._challenge_factory"><a class="viewcode-back" href="../../api/auth_handler.html#certbot.auth_handler.AuthHandler._challenge_factory">[docs]</a> <span class="k">def</span> <span class="nf">_challenge_factory</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">authzr</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
<span class="sd">"""Construct Namedtuple Challenges</span>
<span class="sd"> :param messages.AuthorizationResource authzr: authorization</span>
<span class="sd"> :param list path: List of indices from `challenges`.</span>
<span class="sd"> :returns: achalls, list of challenge type</span>
<span class="sd"> :class:`certbot.achallenges.Indexed`</span>
<span class="sd"> :rtype: list</span>
<span class="sd"> :raises .errors.Error: if challenge type is not recognized</span>
<span class="sd"> """</span>
<span class="n">achalls</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">index</span> <span class="ow">in</span> <span class="n">path</span><span class="p">:</span>
<span class="n">challb</span> <span class="o">=</span> <span class="n">authzr</span><span class="o">.</span><span class="n">body</span><span class="o">.</span><span class="n">challenges</span><span class="p">[</span><span class="n">index</span><span class="p">]</span>
<span class="n">achalls</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">challb_to_achall</span><span class="p">(</span>
<span class="n">challb</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">account</span><span class="o">.</span><span class="n">key</span><span class="p">,</span> <span class="n">authzr</span><span class="o">.</span><span class="n">body</span><span class="o">.</span><span class="n">identifier</span><span class="o">.</span><span class="n">value</span><span class="p">))</span>
<span class="k">return</span> <span class="n">achalls</span></div></div>
<div class="viewcode-block" id="challb_to_achall"><a class="viewcode-back" href="../../api/auth_handler.html#certbot.auth_handler.challb_to_achall">[docs]</a><span class="k">def</span> <span class="nf">challb_to_achall</span><span class="p">(</span><span class="n">challb</span><span class="p">,</span> <span class="n">account_key</span><span class="p">,</span> <span class="n">domain</span><span class="p">):</span>
<span class="sd">"""Converts a ChallengeBody object to an AnnotatedChallenge.</span>
<span class="sd"> :param .ChallengeBody challb: ChallengeBody</span>
<span class="sd"> :param .JWK account_key: Authorized Account Key</span>
<span class="sd"> :param str domain: Domain of the challb</span>
<span class="sd"> :returns: Appropriate AnnotatedChallenge</span>
<span class="sd"> :rtype: :class:`certbot.achallenges.AnnotatedChallenge`</span>
<span class="sd"> """</span>
<span class="n">chall</span> <span class="o">=</span> <span class="n">challb</span><span class="o">.</span><span class="n">chall</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2"> challenge for </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">chall</span><span class="o">.</span><span class="n">typ</span><span class="p">,</span> <span class="n">domain</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">chall</span><span class="p">,</span> <span class="n">challenges</span><span class="o">.</span><span class="n">KeyAuthorizationChallenge</span><span class="p">):</span>
<span class="k">return</span> <span class="n">achallenges</span><span class="o">.</span><span class="n">KeyAuthorizationAnnotatedChallenge</span><span class="p">(</span>
<span class="n">challb</span><span class="o">=</span><span class="n">challb</span><span class="p">,</span> <span class="n">domain</span><span class="o">=</span><span class="n">domain</span><span class="p">,</span> <span class="n">account_key</span><span class="o">=</span><span class="n">account_key</span><span class="p">)</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">chall</span><span class="p">,</span> <span class="n">challenges</span><span class="o">.</span><span class="n">DNS</span><span class="p">):</span>
<span class="k">return</span> <span class="n">achallenges</span><span class="o">.</span><span class="n">DNS</span><span class="p">(</span><span class="n">challb</span><span class="o">=</span><span class="n">challb</span><span class="p">,</span> <span class="n">domain</span><span class="o">=</span><span class="n">domain</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">Error</span><span class="p">(</span>
<span class="s2">"Received unsupported challenge of type: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">chall</span><span class="o">.</span><span class="n">typ</span><span class="p">)</span></div>
<div class="viewcode-block" id="gen_challenge_path"><a class="viewcode-back" href="../../api/auth_handler.html#certbot.auth_handler.gen_challenge_path">[docs]</a><span class="k">def</span> <span class="nf">gen_challenge_path</span><span class="p">(</span><span class="n">challbs</span><span class="p">,</span> <span class="n">preferences</span><span class="p">,</span> <span class="n">combinations</span><span class="p">):</span>
<span class="sd">"""Generate a plan to get authority over the identity.</span>
<span class="sd"> .. todo:: This can be possibly be rewritten to use resolved_combinations.</span>
<span class="sd"> :param tuple challbs: A tuple of challenges</span>
<span class="sd"> (:class:`acme.messages.Challenge`) from</span>
<span class="sd"> :class:`acme.messages.AuthorizationResource` to be</span>
<span class="sd"> fulfilled by the client in order to prove possession of the</span>
<span class="sd"> identifier.</span>
<span class="sd"> :param list preferences: List of challenge preferences for domain</span>
<span class="sd"> (:class:`acme.challenges.Challenge` subclasses)</span>
<span class="sd"> :param tuple combinations: A collection of sets of challenges from</span>
<span class="sd"> :class:`acme.messages.Challenge`, each of which would</span>
<span class="sd"> be sufficient to prove possession of the identifier.</span>
<span class="sd"> :returns: tuple of indices from ``challenges``.</span>
<span class="sd"> :rtype: tuple</span>
<span class="sd"> :raises certbot.errors.AuthorizationError: If a</span>
<span class="sd"> path cannot be created that satisfies the CA given the preferences and</span>
<span class="sd"> combinations.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">combinations</span><span class="p">:</span>
<span class="k">return</span> <span class="n">_find_smart_path</span><span class="p">(</span><span class="n">challbs</span><span class="p">,</span> <span class="n">preferences</span><span class="p">,</span> <span class="n">combinations</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">_find_dumb_path</span><span class="p">(</span><span class="n">challbs</span><span class="p">,</span> <span class="n">preferences</span><span class="p">)</span></div>
<div class="viewcode-block" id="_find_smart_path"><a class="viewcode-back" href="../../api/auth_handler.html#certbot.auth_handler._find_smart_path">[docs]</a><span class="k">def</span> <span class="nf">_find_smart_path</span><span class="p">(</span><span class="n">challbs</span><span class="p">,</span> <span class="n">preferences</span><span class="p">,</span> <span class="n">combinations</span><span class="p">):</span>
<span class="sd">"""Find challenge path with server hints.</span>
<span class="sd"> Can be called if combinations is included. Function uses a simple</span>
<span class="sd"> ranking system to choose the combo with the lowest cost.</span>
<span class="sd"> """</span>
<span class="n">chall_cost</span> <span class="o">=</span> <span class="p">{}</span>
<span class="n">max_cost</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">chall_cls</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">preferences</span><span class="p">):</span>
<span class="n">chall_cost</span><span class="p">[</span><span class="n">chall_cls</span><span class="p">]</span> <span class="o">=</span> <span class="n">i</span>
<span class="n">max_cost</span> <span class="o">+=</span> <span class="n">i</span>
<span class="c1"># max_cost is now equal to sum(indices) + 1</span>
<span class="n">best_combo</span> <span class="o">=</span> <span class="p">[]</span>
<span class="c1"># Set above completing all of the available challenges</span>
<span class="n">best_combo_cost</span> <span class="o">=</span> <span class="n">max_cost</span>
<span class="n">combo_total</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">for</span> <span class="n">combo</span> <span class="ow">in</span> <span class="n">combinations</span><span class="p">:</span>
<span class="k">for</span> <span class="n">challenge_index</span> <span class="ow">in</span> <span class="n">combo</span><span class="p">:</span>
<span class="n">combo_total</span> <span class="o">+=</span> <span class="n">chall_cost</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">challbs</span><span class="p">[</span>
<span class="n">challenge_index</span><span class="p">]</span><span class="o">.</span><span class="n">chall</span><span class="o">.</span><span class="vm">__class__</span><span class="p">,</span> <span class="n">max_cost</span><span class="p">)</span>
<span class="k">if</span> <span class="n">combo_total</span> <span class="o"><</span> <span class="n">best_combo_cost</span><span class="p">:</span>
<span class="n">best_combo</span> <span class="o">=</span> <span class="n">combo</span>
<span class="n">best_combo_cost</span> <span class="o">=</span> <span class="n">combo_total</span>
<span class="n">combo_total</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">best_combo</span><span class="p">:</span>
<span class="n">_report_no_chall_path</span><span class="p">(</span><span class="n">challbs</span><span class="p">)</span>
<span class="k">return</span> <span class="n">best_combo</span></div>
<div class="viewcode-block" id="_find_dumb_path"><a class="viewcode-back" href="../../api/auth_handler.html#certbot.auth_handler._find_dumb_path">[docs]</a><span class="k">def</span> <span class="nf">_find_dumb_path</span><span class="p">(</span><span class="n">challbs</span><span class="p">,</span> <span class="n">preferences</span><span class="p">):</span>
<span class="sd">"""Find challenge path without server hints.</span>
<span class="sd"> Should be called if the combinations hint is not included by the</span>
<span class="sd"> server. This function either returns a path containing all</span>
<span class="sd"> challenges provided by the CA or raises an exception.</span>
<span class="sd"> """</span>
<span class="n">path</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">challb</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">challbs</span><span class="p">):</span>
<span class="c1"># supported is set to True if the challenge type is supported</span>
<span class="n">supported</span> <span class="o">=</span> <span class="nb">next</span><span class="p">((</span><span class="kc">True</span> <span class="k">for</span> <span class="n">pref_c</span> <span class="ow">in</span> <span class="n">preferences</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">challb</span><span class="o">.</span><span class="n">chall</span><span class="p">,</span> <span class="n">pref_c</span><span class="p">)),</span> <span class="kc">False</span><span class="p">)</span>
<span class="k">if</span> <span class="n">supported</span><span class="p">:</span>
<span class="n">path</span><span class="o">.</span><span class="n">append</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="n">_report_no_chall_path</span><span class="p">(</span><span class="n">challbs</span><span class="p">)</span>
<span class="k">return</span> <span class="n">path</span></div>
<div class="viewcode-block" id="_report_no_chall_path"><a class="viewcode-back" href="../../api/auth_handler.html#certbot.auth_handler._report_no_chall_path">[docs]</a><span class="k">def</span> <span class="nf">_report_no_chall_path</span><span class="p">(</span><span class="n">challbs</span><span class="p">):</span>
<span class="sd">"""Logs and raises an error that no satisfiable chall path exists.</span>
<span class="sd"> :param challbs: challenges from the authorization that can't be satisfied</span>
<span class="sd"> """</span>
<span class="n">msg</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"Client with the currently selected authenticator does not support "</span>
<span class="s2">"any combination of challenges that will satisfy the CA."</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">challbs</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">challbs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</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">DNS01</span><span class="p">):</span>
<span class="n">msg</span> <span class="o">+=</span> <span class="p">(</span>
<span class="s2">" You may need to use an authenticator "</span>
<span class="s2">"plugin that can do challenges over DNS."</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="n">msg</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">AuthorizationError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span></div>
<span class="n">_ERROR_HELP_COMMON</span> <span class="o">=</span> <span class="p">(</span>
<span class="s2">"To fix these errors, please make sure that your domain name was entered "</span>
<span class="s2">"correctly and the DNS A/AAAA record(s) for that domain contain(s) the "</span>
<span class="s2">"right IP address."</span><span class="p">)</span>
<span class="n">_ERROR_HELP</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"connection"</span><span class="p">:</span>
<span class="n">_ERROR_HELP_COMMON</span> <span class="o">+</span> <span class="s2">" Additionally, please check that your computer "</span>
<span class="s2">"has a publicly routable IP address and that no firewalls are preventing "</span>
<span class="s2">"the server from communicating with the client. If you're using the "</span>
<span class="s2">"webroot plugin, you should also verify that you are serving files "</span>
<span class="s2">"from the webroot path you provided."</span><span class="p">,</span>
<span class="s2">"dnssec"</span><span class="p">:</span>
<span class="n">_ERROR_HELP_COMMON</span> <span class="o">+</span> <span class="s2">" Additionally, if you have DNSSEC enabled for "</span>
<span class="s2">"your domain, please ensure that the signature is valid."</span><span class="p">,</span>
<span class="s2">"malformed"</span><span class="p">:</span>
<span class="s2">"To fix these errors, please make sure that you did not provide any "</span>
<span class="s2">"invalid information to the client, and try running Certbot "</span>
<span class="s2">"again."</span><span class="p">,</span>
<span class="s2">"serverInternal"</span><span class="p">:</span>
<span class="s2">"Unfortunately, an error on the ACME server prevented you from completing "</span>
<span class="s2">"authorization. Please try again later."</span><span class="p">,</span>
<span class="s2">"tls"</span><span class="p">:</span>
<span class="n">_ERROR_HELP_COMMON</span> <span class="o">+</span> <span class="s2">" Additionally, please check that you have an "</span>
<span class="s2">"up-to-date TLS configuration that allows the server to communicate "</span>
<span class="s2">"with the Certbot client."</span><span class="p">,</span>
<span class="s2">"unauthorized"</span><span class="p">:</span> <span class="n">_ERROR_HELP_COMMON</span><span class="p">,</span>
<span class="s2">"unknownHost"</span><span class="p">:</span> <span class="n">_ERROR_HELP_COMMON</span><span class="p">,</span>
<span class="p">}</span>
<div class="viewcode-block" id="_report_failed_challs"><a class="viewcode-back" href="../../api/auth_handler.html#certbot.auth_handler._report_failed_challs">[docs]</a><span class="k">def</span> <span class="nf">_report_failed_challs</span><span class="p">(</span><span class="n">failed_achalls</span><span class="p">):</span>
<span class="sd">"""Notifies the user about failed challenges.</span>
<span class="sd"> :param set failed_achalls: A set of failed</span>
<span class="sd"> :class:`certbot.achallenges.AnnotatedChallenge`.</span>
<span class="sd"> """</span>
<span class="n">problems</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
<span class="k">for</span> <span class="n">achall</span> <span class="ow">in</span> <span class="n">failed_achalls</span><span class="p">:</span>
<span class="k">if</span> <span class="n">achall</span><span class="o">.</span><span class="n">error</span><span class="p">:</span>
<span class="n">problems</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">achall</span><span class="o">.</span><span class="n">error</span><span class="o">.</span><span class="n">typ</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">achall</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="k">for</span> <span class="n">achalls</span> <span class="ow">in</span> <span class="n">six</span><span class="o">.</span><span class="n">itervalues</span><span class="p">(</span><span class="n">problems</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="n">_generate_failed_chall_msg</span><span class="p">(</span><span class="n">achalls</span><span class="p">),</span> <span class="n">reporter</span><span class="o">.</span><span class="n">MEDIUM_PRIORITY</span><span class="p">)</span></div>
<div class="viewcode-block" id="_generate_failed_chall_msg"><a class="viewcode-back" href="../../api/auth_handler.html#certbot.auth_handler._generate_failed_chall_msg">[docs]</a><span class="k">def</span> <span class="nf">_generate_failed_chall_msg</span><span class="p">(</span><span class="n">failed_achalls</span><span class="p">):</span>
<span class="sd">"""Creates a user friendly error message about failed challenges.</span>
<span class="sd"> :param list failed_achalls: A list of failed</span>
<span class="sd"> :class:`certbot.achallenges.AnnotatedChallenge` with the same error</span>
<span class="sd"> type.</span>
<span class="sd"> :returns: A formatted error message for the client.</span>
<span class="sd"> :rtype: str</span>
<span class="sd"> """</span>
<span class="n">error</span> <span class="o">=</span> <span class="n">failed_achalls</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">error</span>
<span class="n">typ</span> <span class="o">=</span> <span class="n">error</span><span class="o">.</span><span class="n">typ</span>
<span class="k">if</span> <span class="n">messages</span><span class="o">.</span><span class="n">is_acme_error</span><span class="p">(</span><span class="n">error</span><span class="p">):</span>
<span class="n">typ</span> <span class="o">=</span> <span class="n">error</span><span class="o">.</span><span class="n">code</span>
<span class="n">msg</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"The following errors were reported by the server:"</span><span class="p">]</span>
<span class="k">for</span> <span class="n">achall</span> <span class="ow">in</span> <span class="n">failed_achalls</span><span class="p">:</span>
<span class="n">msg</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"</span><span class="se">\n\n</span><span class="s2">Domain: </span><span class="si">%s</span><span class="se">\n</span><span class="s2">Type: </span><span class="si">%s</span><span class="se">\n</span><span class="s2">Detail: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span>
<span class="n">achall</span><span class="o">.</span><span class="n">domain</span><span class="p">,</span> <span class="n">typ</span><span class="p">,</span> <span class="n">achall</span><span class="o">.</span><span class="n">error</span><span class="o">.</span><span class="n">detail</span><span class="p">))</span>
<span class="k">if</span> <span class="n">typ</span> <span class="ow">in</span> <span class="n">_ERROR_HELP</span><span class="p">:</span>
<span class="n">msg</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"</span><span class="se">\n\n</span><span class="s2">"</span><span class="p">)</span>
<span class="n">msg</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">_ERROR_HELP</span><span class="p">[</span><span class="n">typ</span><span class="p">])</span>
<span class="k">return</span> <span class="s2">""</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span></div>
</pre></div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
<span class="copyright">
© Copyright 2014-2018 - The Certbot software and documentation are licensed under the Apache 2.0 license as described at <a href="https://eff.org/cb-license">https://eff.org/cb-license</a>.
</span>
<br>
<br>
<span class="status">
<a href="https://letsencrypt.status.io/">Let's Encrypt Status</a>
</span>
</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.23.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>
|