/usr/share/doc/python3-certbot/html/_modules/certbot/hooks.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 | <!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.hooks — 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.hooks</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.hooks</h1><div class="highlight"><pre>
<span></span><span class="sd">"""Facilities for implementing hooks that call shell commands."""</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">print_function</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">from</span> <span class="nn">subprocess</span> <span class="k">import</span> <span class="n">Popen</span><span class="p">,</span> <span class="n">PIPE</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">util</span>
<span class="kn">from</span> <span class="nn">certbot.plugins</span> <span class="k">import</span> <span class="n">util</span> <span class="k">as</span> <span class="n">plug_util</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>
<div class="viewcode-block" id="validate_hooks"><a class="viewcode-back" href="../../api/hooks.html#certbot.hooks.validate_hooks">[docs]</a><span class="k">def</span> <span class="nf">validate_hooks</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
<span class="sd">"""Check hook commands are executable."""</span>
<span class="n">validate_hook</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">pre_hook</span><span class="p">,</span> <span class="s2">"pre"</span><span class="p">)</span>
<span class="n">validate_hook</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">post_hook</span><span class="p">,</span> <span class="s2">"post"</span><span class="p">)</span>
<span class="n">validate_hook</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">deploy_hook</span><span class="p">,</span> <span class="s2">"deploy"</span><span class="p">)</span>
<span class="n">validate_hook</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">renew_hook</span><span class="p">,</span> <span class="s2">"renew"</span><span class="p">)</span></div>
<div class="viewcode-block" id="_prog"><a class="viewcode-back" href="../../api/hooks.html#certbot.hooks._prog">[docs]</a><span class="k">def</span> <span class="nf">_prog</span><span class="p">(</span><span class="n">shell_cmd</span><span class="p">):</span>
<span class="sd">"""Extract the program run by a shell command.</span>
<span class="sd"> :param str shell_cmd: command to be executed</span>
<span class="sd"> :returns: basename of command or None if the command isn't found</span>
<span class="sd"> :rtype: str or None</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">util</span><span class="o">.</span><span class="n">exe_exists</span><span class="p">(</span><span class="n">shell_cmd</span><span class="p">):</span>
<span class="n">plug_util</span><span class="o">.</span><span class="n">path_surgery</span><span class="p">(</span><span class="n">shell_cmd</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">util</span><span class="o">.</span><span class="n">exe_exists</span><span class="p">(</span><span class="n">shell_cmd</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">shell_cmd</span><span class="p">)</span></div>
<div class="viewcode-block" id="validate_hook"><a class="viewcode-back" href="../../api/hooks.html#certbot.hooks.validate_hook">[docs]</a><span class="k">def</span> <span class="nf">validate_hook</span><span class="p">(</span><span class="n">shell_cmd</span><span class="p">,</span> <span class="n">hook_name</span><span class="p">):</span>
<span class="sd">"""Check that a command provided as a hook is plausibly executable.</span>
<span class="sd"> :raises .errors.HookCommandNotFound: if the command is not found</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">shell_cmd</span><span class="p">:</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="n">shell_cmd</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="mi">1</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">_prog</span><span class="p">(</span><span class="n">cmd</span><span class="p">):</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"PATH"</span><span class="p">]</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">cmd</span><span class="p">):</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{1}</span><span class="s2">-hook command </span><span class="si">{0}</span><span class="s2"> exists, but is not executable."</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">hook_name</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s2">"Unable to find </span><span class="si">{2}</span><span class="s2">-hook command </span><span class="si">{0}</span><span class="s2"> in the PATH.</span><span class="se">\n</span><span class="s2">(PATH is </span><span class="si">{1}</span><span class="s2">)"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">cmd</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">hook_name</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">HookCommandNotFound</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span></div>
<div class="viewcode-block" id="pre_hook"><a class="viewcode-back" href="../../api/hooks.html#certbot.hooks.pre_hook">[docs]</a><span class="k">def</span> <span class="nf">pre_hook</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
<span class="sd">"""Run pre-hooks if they exist and haven't already been run.</span>
<span class="sd"> When Certbot is running with the renew subcommand, this function</span>
<span class="sd"> runs any hooks found in the config.renewal_pre_hooks_dir (if they</span>
<span class="sd"> have not already been run) followed by any pre-hook in the config.</span>
<span class="sd"> If hooks in config.renewal_pre_hooks_dir are run and the pre-hook in</span>
<span class="sd"> the config is a path to one of these scripts, it is not run twice.</span>
<span class="sd"> :param configuration.NamespaceConfig config: Certbot settings</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">config</span><span class="o">.</span><span class="n">verb</span> <span class="o">==</span> <span class="s2">"renew"</span> <span class="ow">and</span> <span class="n">config</span><span class="o">.</span><span class="n">directory_hooks</span><span class="p">:</span>
<span class="k">for</span> <span class="n">hook</span> <span class="ow">in</span> <span class="n">list_hooks</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">renewal_pre_hooks_dir</span><span class="p">):</span>
<span class="n">_run_pre_hook_if_necessary</span><span class="p">(</span><span class="n">hook</span><span class="p">)</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">pre_hook</span>
<span class="k">if</span> <span class="n">cmd</span><span class="p">:</span>
<span class="n">_run_pre_hook_if_necessary</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span></div>
<span class="n">pre_hook</span><span class="o">.</span><span class="n">already</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span> <span class="c1"># type: ignore</span>
<div class="viewcode-block" id="_run_pre_hook_if_necessary"><a class="viewcode-back" href="../../api/hooks.html#certbot.hooks._run_pre_hook_if_necessary">[docs]</a><span class="k">def</span> <span class="nf">_run_pre_hook_if_necessary</span><span class="p">(</span><span class="n">command</span><span class="p">):</span>
<span class="sd">"""Run the specified pre-hook if we haven't already.</span>
<span class="sd"> If we've already run this exact command before, a message is logged</span>
<span class="sd"> saying the pre-hook was skipped.</span>
<span class="sd"> :param str command: pre-hook to be run</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">command</span> <span class="ow">in</span> <span class="n">pre_hook</span><span class="o">.</span><span class="n">already</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">"Pre-hook command already run, skipping: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">command</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"Running pre-hook command: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">command</span><span class="p">)</span>
<span class="n">_run_hook</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
<span class="n">pre_hook</span><span class="o">.</span><span class="n">already</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">command</span><span class="p">)</span></div>
<div class="viewcode-block" id="post_hook"><a class="viewcode-back" href="../../api/hooks.html#certbot.hooks.post_hook">[docs]</a><span class="k">def</span> <span class="nf">post_hook</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
<span class="sd">"""Run post-hooks if defined.</span>
<span class="sd"> This function also registers any executables found in</span>
<span class="sd"> config.renewal_post_hooks_dir to be run when Certbot is used with</span>
<span class="sd"> the renew subcommand.</span>
<span class="sd"> If the verb is renew, we delay executing any post-hooks until</span>
<span class="sd"> :func:`run_saved_post_hooks` is called. In this case, this function</span>
<span class="sd"> registers all hooks found in config.renewal_post_hooks_dir to be</span>
<span class="sd"> called followed by any post-hook in the config. If the post-hook in</span>
<span class="sd"> the config is a path to an executable in the post-hook directory, it</span>
<span class="sd"> is not scheduled to be run twice.</span>
<span class="sd"> :param configuration.NamespaceConfig config: Certbot settings</span>
<span class="sd"> """</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">post_hook</span>
<span class="c1"># In the "renew" case, we save these up to run at the end</span>
<span class="k">if</span> <span class="n">config</span><span class="o">.</span><span class="n">verb</span> <span class="o">==</span> <span class="s2">"renew"</span><span class="p">:</span>
<span class="k">if</span> <span class="n">config</span><span class="o">.</span><span class="n">directory_hooks</span><span class="p">:</span>
<span class="k">for</span> <span class="n">hook</span> <span class="ow">in</span> <span class="n">list_hooks</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">renewal_post_hooks_dir</span><span class="p">):</span>
<span class="n">_run_eventually</span><span class="p">(</span><span class="n">hook</span><span class="p">)</span>
<span class="k">if</span> <span class="n">cmd</span><span class="p">:</span>
<span class="n">_run_eventually</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span>
<span class="c1"># certonly / run</span>
<span class="k">elif</span> <span class="n">cmd</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">"Running post-hook command: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">cmd</span><span class="p">)</span>
<span class="n">_run_hook</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span></div>
<span class="n">post_hook</span><span class="o">.</span><span class="n">eventually</span> <span class="o">=</span> <span class="p">[]</span> <span class="c1"># type: ignore</span>
<div class="viewcode-block" id="_run_eventually"><a class="viewcode-back" href="../../api/hooks.html#certbot.hooks._run_eventually">[docs]</a><span class="k">def</span> <span class="nf">_run_eventually</span><span class="p">(</span><span class="n">command</span><span class="p">):</span>
<span class="sd">"""Registers a post-hook to be run eventually.</span>
<span class="sd"> All commands given to this function will be run exactly once in the</span>
<span class="sd"> order they were given when :func:`run_saved_post_hooks` is called.</span>
<span class="sd"> :param str command: post-hook to register to be run</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">command</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">post_hook</span><span class="o">.</span><span class="n">eventually</span><span class="p">:</span>
<span class="n">post_hook</span><span class="o">.</span><span class="n">eventually</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">command</span><span class="p">)</span></div>
<div class="viewcode-block" id="run_saved_post_hooks"><a class="viewcode-back" href="../../api/hooks.html#certbot.hooks.run_saved_post_hooks">[docs]</a><span class="k">def</span> <span class="nf">run_saved_post_hooks</span><span class="p">():</span>
<span class="sd">"""Run any post hooks that were saved up in the course of the 'renew' verb"""</span>
<span class="k">for</span> <span class="n">cmd</span> <span class="ow">in</span> <span class="n">post_hook</span><span class="o">.</span><span class="n">eventually</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">"Running post-hook command: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">cmd</span><span class="p">)</span>
<span class="n">_run_hook</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span></div>
<div class="viewcode-block" id="deploy_hook"><a class="viewcode-back" href="../../api/hooks.html#certbot.hooks.deploy_hook">[docs]</a><span class="k">def</span> <span class="nf">deploy_hook</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">domains</span><span class="p">,</span> <span class="n">lineage_path</span><span class="p">):</span>
<span class="sd">"""Run post-issuance hook if defined.</span>
<span class="sd"> :param configuration.NamespaceConfig config: Certbot settings</span>
<span class="sd"> :param domains: domains in the obtained certificate</span>
<span class="sd"> :type domains: `list` of `str`</span>
<span class="sd"> :param str lineage_path: live directory path for the new cert</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">config</span><span class="o">.</span><span class="n">deploy_hook</span><span class="p">:</span>
<span class="n">_run_deploy_hook</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">deploy_hook</span><span class="p">,</span> <span class="n">domains</span><span class="p">,</span>
<span class="n">lineage_path</span><span class="p">,</span> <span class="n">config</span><span class="o">.</span><span class="n">dry_run</span><span class="p">)</span></div>
<div class="viewcode-block" id="renew_hook"><a class="viewcode-back" href="../../api/hooks.html#certbot.hooks.renew_hook">[docs]</a><span class="k">def</span> <span class="nf">renew_hook</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">domains</span><span class="p">,</span> <span class="n">lineage_path</span><span class="p">):</span>
<span class="sd">"""Run post-renewal hooks.</span>
<span class="sd"> This function runs any hooks found in</span>
<span class="sd"> config.renewal_deploy_hooks_dir followed by any renew-hook in the</span>
<span class="sd"> config. If the renew-hook in the config is a path to a script in</span>
<span class="sd"> config.renewal_deploy_hooks_dir, it is not run twice.</span>
<span class="sd"> If Certbot is doing a dry run, no hooks are run and messages are</span>
<span class="sd"> logged saying that they were skipped.</span>
<span class="sd"> :param configuration.NamespaceConfig config: Certbot settings</span>
<span class="sd"> :param domains: domains in the obtained certificate</span>
<span class="sd"> :type domains: `list` of `str`</span>
<span class="sd"> :param str lineage_path: live directory path for the new cert</span>
<span class="sd"> """</span>
<span class="n">executed_dir_hooks</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="k">if</span> <span class="n">config</span><span class="o">.</span><span class="n">directory_hooks</span><span class="p">:</span>
<span class="k">for</span> <span class="n">hook</span> <span class="ow">in</span> <span class="n">list_hooks</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">renewal_deploy_hooks_dir</span><span class="p">):</span>
<span class="n">_run_deploy_hook</span><span class="p">(</span><span class="n">hook</span><span class="p">,</span> <span class="n">domains</span><span class="p">,</span> <span class="n">lineage_path</span><span class="p">,</span> <span class="n">config</span><span class="o">.</span><span class="n">dry_run</span><span class="p">)</span>
<span class="n">executed_dir_hooks</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">hook</span><span class="p">)</span>
<span class="k">if</span> <span class="n">config</span><span class="o">.</span><span class="n">renew_hook</span><span class="p">:</span>
<span class="k">if</span> <span class="n">config</span><span class="o">.</span><span class="n">renew_hook</span> <span class="ow">in</span> <span class="n">executed_dir_hooks</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">"Skipping deploy-hook '</span><span class="si">%s</span><span class="s2">' as it was already run."</span><span class="p">,</span>
<span class="n">config</span><span class="o">.</span><span class="n">renew_hook</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">_run_deploy_hook</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">renew_hook</span><span class="p">,</span> <span class="n">domains</span><span class="p">,</span>
<span class="n">lineage_path</span><span class="p">,</span> <span class="n">config</span><span class="o">.</span><span class="n">dry_run</span><span class="p">)</span></div>
<div class="viewcode-block" id="_run_deploy_hook"><a class="viewcode-back" href="../../api/hooks.html#certbot.hooks._run_deploy_hook">[docs]</a><span class="k">def</span> <span class="nf">_run_deploy_hook</span><span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="n">domains</span><span class="p">,</span> <span class="n">lineage_path</span><span class="p">,</span> <span class="n">dry_run</span><span class="p">):</span>
<span class="sd">"""Run the specified deploy-hook (if not doing a dry run).</span>
<span class="sd"> If dry_run is True, command is not run and a message is logged</span>
<span class="sd"> saying that it was skipped. If dry_run is False, the hook is run</span>
<span class="sd"> after setting the appropriate environment variables.</span>
<span class="sd"> :param str command: command to run as a deploy-hook</span>
<span class="sd"> :param domains: domains in the obtained certificate</span>
<span class="sd"> :type domains: `list` of `str`</span>
<span class="sd"> :param str lineage_path: live directory path for the new cert</span>
<span class="sd"> :param bool dry_run: True iff Certbot is doing a dry run</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">dry_run</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">"Dry run: skipping deploy hook command: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span>
<span class="n">command</span><span class="p">)</span>
<span class="k">return</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"RENEWED_DOMAINS"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">" "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">domains</span><span class="p">)</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"RENEWED_LINEAGE"</span><span class="p">]</span> <span class="o">=</span> <span class="n">lineage_path</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"Running deploy-hook command: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">command</span><span class="p">)</span>
<span class="n">_run_hook</span><span class="p">(</span><span class="n">command</span><span class="p">)</span></div>
<div class="viewcode-block" id="_run_hook"><a class="viewcode-back" href="../../api/hooks.html#certbot.hooks._run_hook">[docs]</a><span class="k">def</span> <span class="nf">_run_hook</span><span class="p">(</span><span class="n">shell_cmd</span><span class="p">):</span>
<span class="sd">"""Run a hook command.</span>
<span class="sd"> :returns: stderr if there was any"""</span>
<span class="n">err</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">execute</span><span class="p">(</span><span class="n">shell_cmd</span><span class="p">)</span>
<span class="k">return</span> <span class="n">err</span></div>
<div class="viewcode-block" id="execute"><a class="viewcode-back" href="../../api/hooks.html#certbot.hooks.execute">[docs]</a><span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="n">shell_cmd</span><span class="p">):</span>
<span class="sd">"""Run a command.</span>
<span class="sd"> :returns: `tuple` (`str` stderr, `str` stdout)"""</span>
<span class="c1"># universal_newlines causes Popen.communicate()</span>
<span class="c1"># to return str objects instead of bytes in Python 3</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="n">Popen</span><span class="p">(</span><span class="n">shell_cmd</span><span class="p">,</span> <span class="n">shell</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">stdout</span><span class="o">=</span><span class="n">PIPE</span><span class="p">,</span>
<span class="n">stderr</span><span class="o">=</span><span class="n">PIPE</span><span class="p">,</span> <span class="n">universal_newlines</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">out</span><span class="p">,</span> <span class="n">err</span> <span class="o">=</span> <span class="n">cmd</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
<span class="n">base_cmd</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">shell_cmd</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="mi">1</span><span class="p">)[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">if</span> <span class="n">out</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="s1">'Output from </span><span class="si">%s</span><span class="s1">:</span><span class="se">\n</span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">base_cmd</span><span class="p">,</span> <span class="n">out</span><span class="p">)</span>
<span class="k">if</span> <span class="n">cmd</span><span class="o">.</span><span class="n">returncode</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s1">'Hook command "</span><span class="si">%s</span><span class="s1">" returned error code </span><span class="si">%d</span><span class="s1">'</span><span class="p">,</span>
<span class="n">shell_cmd</span><span class="p">,</span> <span class="n">cmd</span><span class="o">.</span><span class="n">returncode</span><span class="p">)</span>
<span class="k">if</span> <span class="n">err</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s1">'Error output from </span><span class="si">%s</span><span class="s1">:</span><span class="se">\n</span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">base_cmd</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
<span class="k">return</span> <span class="p">(</span><span class="n">err</span><span class="p">,</span> <span class="n">out</span><span class="p">)</span></div>
<div class="viewcode-block" id="list_hooks"><a class="viewcode-back" href="../../api/hooks.html#certbot.hooks.list_hooks">[docs]</a><span class="k">def</span> <span class="nf">list_hooks</span><span class="p">(</span><span class="n">dir_path</span><span class="p">):</span>
<span class="sd">"""List paths to all hooks found in dir_path in sorted order.</span>
<span class="sd"> :param str dir_path: directory to search</span>
<span class="sd"> :returns: `list` of `str`</span>
<span class="sd"> :rtype: sorted list of absolute paths to executables in dir_path</span>
<span class="sd"> """</span>
<span class="n">paths</span> <span class="o">=</span> <span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">dir_path</span><span class="p">,</span> <span class="n">f</span><span class="p">)</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">dir_path</span><span class="p">))</span>
<span class="k">return</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">path</span> <span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">paths</span> <span class="k">if</span> <span class="n">util</span><span class="o">.</span><span class="n">is_exe</span><span class="p">(</span><span class="n">path</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>
|