/usr/share/doc/python3-certbot/html/_modules/certbot/plugins/manual.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 | <!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.plugins.manual — 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.plugins.manual</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.plugins.manual</h1><div class="highlight"><pre>
<span></span><span class="sd">"""Manual authenticator plugin"""</span>
<span class="kn">import</span> <span class="nn">os</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">interfaces</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">hooks</span>
<span class="kn">from</span> <span class="nn">certbot</span> <span class="k">import</span> <span class="n">reverter</span>
<span class="kn">from</span> <span class="nn">certbot.plugins</span> <span class="k">import</span> <span class="n">common</span>
<div class="viewcode-block" id="ManualTlsSni01"><a class="viewcode-back" href="../../../api/plugins/manual.html#certbot.plugins.manual.ManualTlsSni01">[docs]</a><span class="k">class</span> <span class="nc">ManualTlsSni01</span><span class="p">(</span><span class="n">common</span><span class="o">.</span><span class="n">TLSSNI01</span><span class="p">):</span>
<span class="sd">"""TLS-SNI-01 authenticator for the Manual plugin</span>
<span class="sd"> :ivar configurator: Authenticator object</span>
<span class="sd"> :type configurator: :class:`~certbot.plugins.manual.Authenticator`</span>
<span class="sd"> :ivar list achalls: Annotated</span>
<span class="sd"> class:`~certbot.achallenges.KeyAuthorizationAnnotatedChallenge`</span>
<span class="sd"> challenges</span>
<span class="sd"> :param list indices: Meant to hold indices of challenges in a</span>
<span class="sd"> larger array. NginxTlsSni01 is capable of solving many challenges</span>
<span class="sd"> at once which causes an indexing issue within NginxConfigurator</span>
<span class="sd"> who must return all responses in order. Imagine NginxConfigurator</span>
<span class="sd"> maintaining state about where all of the http-01 Challenges,</span>
<span class="sd"> TLS-SNI-01 Challenges belong in the response array. This is an</span>
<span class="sd"> optional utility.</span>
<span class="sd"> :param str challenge_conf: location of the challenge config file</span>
<span class="sd"> """</span>
<div class="viewcode-block" id="ManualTlsSni01.perform"><a class="viewcode-back" href="../../../api/plugins/manual.html#certbot.plugins.manual.ManualTlsSni01.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="sd">"""Create the SSL certificates and private keys"""</span>
<span class="k">for</span> <span class="n">achall</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">achalls</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_setup_challenge_cert</span><span class="p">(</span><span class="n">achall</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="Authenticator"><a class="viewcode-back" href="../../../api/plugins/manual.html#certbot.plugins.manual.Authenticator">[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="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">Authenticator</span><span class="p">(</span><span class="n">common</span><span class="o">.</span><span class="n">Plugin</span><span class="p">):</span>
<span class="sd">"""Manual authenticator</span>
<span class="sd"> This plugin allows the user to perform the domain validation</span>
<span class="sd"> challenge(s) themselves. This either be done manually by the user or</span>
<span class="sd"> through shell scripts provided to Certbot.</span>
<span class="sd"> """</span>
<span class="n">description</span> <span class="o">=</span> <span class="s1">'Manual configuration or run your own shell scripts'</span>
<span class="n">hidden</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">long_description</span> <span class="o">=</span> <span class="p">(</span>
<span class="s1">'Authenticate through manual configuration or custom shell scripts. '</span>
<span class="s1">'When using shell scripts, an authenticator script must be provided. '</span>
<span class="s1">'The environment variables available to this script depend on the '</span>
<span class="s1">'type of challenge. $CERTBOT_DOMAIN will always contain the domain '</span>
<span class="s1">'being authenticated. For HTTP-01 and DNS-01, $CERTBOT_VALIDATION '</span>
<span class="s1">'is the validation string, and $CERTBOT_TOKEN is the filename of the '</span>
<span class="s1">'resource requested when performing an HTTP-01 challenge. When '</span>
<span class="s1">'performing a TLS-SNI-01 challenge, $CERTBOT_SNI_DOMAIN will contain '</span>
<span class="s1">'the SNI name for which the ACME server expects to be presented with '</span>
<span class="s1">'the self-signed certificate located at $CERTBOT_CERT_PATH. The '</span>
<span class="s1">'secret key needed to complete the TLS handshake is located at '</span>
<span class="s1">'$CERTBOT_KEY_PATH. An additional cleanup script can also be '</span>
<span class="s1">'provided and can use the additional variable $CERTBOT_AUTH_OUTPUT '</span>
<span class="s1">'which contains the stdout output from the auth script.'</span><span class="p">)</span>
<span class="n">_DNS_INSTRUCTIONS</span> <span class="o">=</span> <span class="s2">"""</span><span class="se">\</span>
<span class="s2">Please deploy a DNS TXT record under the name</span>
<span class="si">{domain}</span><span class="s2"> with the following value:</span>
<span class="si">{validation}</span><span class="s2"></span>
<span class="s2">Before continuing, verify the record is deployed."""</span>
<span class="n">_HTTP_INSTRUCTIONS</span> <span class="o">=</span> <span class="s2">"""</span><span class="se">\</span>
<span class="s2">Create a file containing just this data:</span>
<span class="si">{validation}</span><span class="s2"></span>
<span class="s2">And make it available on your web server at this URL:</span>
<span class="si">{uri}</span><span class="s2"></span>
<span class="s2">"""</span>
<span class="n">_TLSSNI_INSTRUCTIONS</span> <span class="o">=</span> <span class="s2">"""</span><span class="se">\</span>
<span class="s2">Configure the service listening on port </span><span class="si">{port}</span><span class="s2"> to present the certificate</span>
<span class="si">{cert}</span><span class="s2"></span>
<span class="s2">using the secret key</span>
<span class="si">{key}</span><span class="s2"></span>
<span class="s2">when it receives a TLS ClientHello with the SNI extension set to</span>
<span class="si">{sni_domain}</span><span class="s2"></span>
<span class="s2">"""</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="nb">super</span><span class="p">(</span><span class="n">Authenticator</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="bp">self</span><span class="o">.</span><span class="n">reverter</span> <span class="o">=</span> <span class="n">reverter</span><span class="o">.</span><span class="n">Reverter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</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">recovery_routine</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">env</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">tls_sni_01</span> <span class="o">=</span> <span class="kc">None</span>
<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="s1">'auth-hook'</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s1">'Path or command to execute for the authentication script'</span><span class="p">)</span>
<span class="n">add</span><span class="p">(</span><span class="s1">'cleanup-hook'</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s1">'Path or command to execute for the cleanup script'</span><span class="p">)</span>
<span class="n">add</span><span class="p">(</span><span class="s1">'public-ip-logging-ok'</span><span class="p">,</span> <span class="n">action</span><span class="o">=</span><span class="s1">'store_true'</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s1">'Automatically allows public IP logging (default: Ask)'</span><span class="p">)</span>
<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="c1"># pylint: disable=missing-docstring</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">noninteractive_mode</span> <span class="ow">and</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="s1">'auth-hook'</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="s1">'An authentication script must be provided with --</span><span class="si">{0}</span><span class="s1"> when '</span>
<span class="s1">'using the manual plugin non-interactively.'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">option_name</span><span class="p">(</span><span class="s1">'auth-hook'</span><span class="p">)))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_validate_hooks</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">_validate_hooks</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">validate_hooks</span><span class="p">:</span>
<span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'auth-hook'</span><span class="p">,</span> <span class="s1">'cleanup-hook'</span><span class="p">):</span>
<span class="n">hook</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="n">name</span><span class="p">)</span>
<span class="k">if</span> <span class="n">hook</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">hook_prefix</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">option_name</span><span class="p">(</span><span class="n">name</span><span class="p">)[:</span><span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="s1">'-hook'</span><span class="p">)]</span>
<span class="n">hooks</span><span class="o">.</span><span class="n">validate_hook</span><span class="p">(</span><span class="n">hook</span><span class="p">,</span> <span class="n">hook_prefix</span><span class="p">)</span>
<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="c1"># pylint: disable=missing-docstring,no-self-use</span>
<span class="k">return</span> <span class="p">(</span>
<span class="s1">'This plugin allows the user to customize setup for domain '</span>
<span class="s1">'validation challenges either through shell scripts provided by '</span>
<span class="s1">'the user or by performing the setup manually.'</span><span class="p">)</span>
<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="c1"># pylint: disable=missing-docstring,no-self-use,unused-argument</span>
<span class="k">return</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">challenges</span><span class="o">.</span><span class="n">DNS01</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="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="c1"># pylint: disable=missing-docstring</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_verify_ip_logging_ok</span><span class="p">()</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="s1">'auth-hook'</span><span class="p">):</span>
<span class="n">perform_achall</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_perform_achall_with_script</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">perform_achall</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_perform_achall_manually</span>
<span class="n">responses</span> <span class="o">=</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">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">TLSSNI01</span><span class="p">):</span>
<span class="c1"># Make a new ManualTlsSni01 instance for each challenge</span>
<span class="c1"># because the manual plugin deals with one challenge at a time.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">tls_sni_01</span> <span class="o">=</span> <span class="n">ManualTlsSni01</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">tls_sni_01</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="bp">self</span><span class="o">.</span><span class="n">tls_sni_01</span><span class="o">.</span><span class="n">perform</span><span class="p">()</span>
<span class="n">perform_achall</span><span class="p">(</span><span class="n">achall</span><span class="p">)</span>
<span class="n">responses</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">achall</span><span class="o">.</span><span class="n">response</span><span class="p">(</span><span class="n">achall</span><span class="o">.</span><span class="n">account_key</span><span class="p">))</span>
<span class="k">return</span> <span class="n">responses</span>
<span class="k">def</span> <span class="nf">_verify_ip_logging_ok</span><span class="p">(</span><span class="bp">self</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">conf</span><span class="p">(</span><span class="s1">'public-ip-logging-ok'</span><span class="p">):</span>
<span class="n">cli_flag</span> <span class="o">=</span> <span class="s1">'--</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="bp">self</span><span class="o">.</span><span class="n">option_name</span><span class="p">(</span><span class="s1">'public-ip-logging-ok'</span><span class="p">))</span>
<span class="n">msg</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'NOTE: The IP of this machine will be publicly logged as '</span>
<span class="s2">"having requested this certificate. If you're running "</span>
<span class="s1">'certbot in manual mode on a machine that is not your '</span>
<span class="s2">"server, please ensure you're okay with that.</span><span class="se">\n\n</span><span class="s2">"</span>
<span class="s1">'Are you OK with your IP being logged?'</span><span class="p">)</span>
<span class="n">display</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="k">if</span> <span class="n">display</span><span class="o">.</span><span class="n">yesno</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">cli_flag</span><span class="o">=</span><span class="n">cli_flag</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="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dest</span><span class="p">(</span><span class="s1">'public-ip-logging-ok'</span><span class="p">),</span> <span class="kc">True</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="s1">'Must agree to IP logging to proceed'</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_perform_achall_with_script</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">achall</span><span class="p">):</span>
<span class="n">env</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">CERTBOT_DOMAIN</span><span class="o">=</span><span class="n">achall</span><span class="o">.</span><span class="n">domain</span><span class="p">,</span>
<span class="n">CERTBOT_VALIDATION</span><span class="o">=</span><span class="n">achall</span><span class="o">.</span><span class="n">validation</span><span class="p">(</span><span class="n">achall</span><span class="o">.</span><span class="n">account_key</span><span class="p">))</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">env</span><span class="p">[</span><span class="s1">'CERTBOT_TOKEN'</span><span class="p">]</span> <span class="o">=</span> <span class="n">achall</span><span class="o">.</span><span class="n">chall</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'token'</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">'CERTBOT_TOKEN'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</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">TLSSNI01</span><span class="p">):</span>
<span class="n">env</span><span class="p">[</span><span class="s1">'CERTBOT_CERT_PATH'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">tls_sni_01</span><span class="o">.</span><span class="n">get_cert_path</span><span class="p">(</span><span class="n">achall</span><span class="p">)</span>
<span class="n">env</span><span class="p">[</span><span class="s1">'CERTBOT_KEY_PATH'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">tls_sni_01</span><span class="o">.</span><span class="n">get_key_path</span><span class="p">(</span><span class="n">achall</span><span class="p">)</span>
<span class="n">env</span><span class="p">[</span><span class="s1">'CERTBOT_SNI_DOMAIN'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">tls_sni_01</span><span class="o">.</span><span class="n">get_z_domain</span><span class="p">(</span><span class="n">achall</span><span class="p">)</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">'CERTBOT_VALIDATION'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="n">env</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">'CERTBOT_VALIDATION'</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">'CERTBOT_CERT_PATH'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">'CERTBOT_KEY_PATH'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">'CERTBOT_SNI_DOMAIN'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
<span class="n">_</span><span class="p">,</span> <span class="n">out</span> <span class="o">=</span> <span class="n">hooks</span><span class="o">.</span><span class="n">execute</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="s1">'auth-hook'</span><span class="p">))</span>
<span class="n">env</span><span class="p">[</span><span class="s1">'CERTBOT_AUTH_OUTPUT'</span><span class="p">]</span> <span class="o">=</span> <span class="n">out</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="p">[</span><span class="n">achall</span><span class="p">]</span> <span class="o">=</span> <span class="n">env</span>
<span class="k">def</span> <span class="nf">_perform_achall_manually</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">achall</span><span class="p">):</span>
<span class="n">validation</span> <span class="o">=</span> <span class="n">achall</span><span class="o">.</span><span class="n">validation</span><span class="p">(</span><span class="n">achall</span><span class="o">.</span><span class="n">account_key</span><span class="p">)</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">msg</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_HTTP_INSTRUCTIONS</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">achall</span><span class="o">=</span><span class="n">achall</span><span class="p">,</span> <span class="n">encoded_token</span><span class="o">=</span><span class="n">achall</span><span class="o">.</span><span class="n">chall</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'token'</span><span class="p">),</span>
<span class="n">port</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http01_port</span><span class="p">,</span>
<span class="n">uri</span><span class="o">=</span><span class="n">achall</span><span class="o">.</span><span class="n">chall</span><span class="o">.</span><span class="n">uri</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">validation</span><span class="o">=</span><span class="n">validation</span><span class="p">)</span>
<span class="k">elif</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">DNS01</span><span class="p">):</span>
<span class="n">msg</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_DNS_INSTRUCTIONS</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">domain</span><span class="o">=</span><span class="n">achall</span><span class="o">.</span><span class="n">validation_domain_name</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">validation</span><span class="o">=</span><span class="n">validation</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">assert</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">TLSSNI01</span><span class="p">)</span>
<span class="n">msg</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_TLSSNI_INSTRUCTIONS</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">cert</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">tls_sni_01</span><span class="o">.</span><span class="n">get_cert_path</span><span class="p">(</span><span class="n">achall</span><span class="p">),</span>
<span class="n">key</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">tls_sni_01</span><span class="o">.</span><span class="n">get_key_path</span><span class="p">(</span><span class="n">achall</span><span class="p">),</span>
<span class="n">port</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">tls_sni_01_port</span><span class="p">,</span>
<span class="n">sni_domain</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">tls_sni_01</span><span class="o">.</span><span class="n">get_z_domain</span><span class="p">(</span><span class="n">achall</span><span class="p">))</span>
<span class="n">display</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="n">display</span><span class="o">.</span><span class="n">notification</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">wrap</span><span class="o">=</span><span class="kc">False</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">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="c1"># pylint: disable=missing-docstring</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="s1">'cleanup-hook'</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="n">env</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">achall</span><span class="p">)</span>
<span class="k">if</span> <span class="s1">'CERTBOT_TOKEN'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">env</span><span class="p">:</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">'CERTBOT_TOKEN'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
<span class="n">hooks</span><span class="o">.</span><span class="n">execute</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="s1">'cleanup-hook'</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">recovery_routine</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>
|