/usr/share/doc/python3-certbot-dns-route53/html/_modules/certbot_dns_route53/dns_route53.html is in python-certbot-dns-route53-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 | <!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_dns_route53.dns_route53 — certbot-dns-route53 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-dns-route53 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-dns-route53
</a>
<div class="version">
0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../api.html">API Documentation</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">certbot-dns-route53</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_dns_route53.dns_route53</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_dns_route53.dns_route53</h1><div class="highlight"><pre>
<span></span><span class="sd">"""Certbot Route53 authenticator plugin."""</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">boto3</span>
<span class="kn">import</span> <span class="nn">zope.interface</span>
<span class="kn">from</span> <span class="nn">botocore.exceptions</span> <span class="k">import</span> <span class="n">NoCredentialsError</span><span class="p">,</span> <span class="n">ClientError</span>
<span class="kn">from</span> <span class="nn">certbot</span> <span class="k">import</span> <span class="n">errors</span>
<span class="kn">from</span> <span class="nn">certbot</span> <span class="k">import</span> <span class="n">interfaces</span>
<span class="kn">from</span> <span class="nn">certbot.plugins</span> <span class="k">import</span> <span class="n">dns_common</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">INSTRUCTIONS</span> <span class="o">=</span> <span class="p">(</span>
<span class="s2">"To use certbot-dns-route53, configure credentials as described at "</span>
<span class="s2">"https://boto3.readthedocs.io/en/latest/guide/configuration.html#best-practices-for-configuring-credentials "</span> <span class="c1"># pylint: disable=line-too-long</span>
<span class="s2">"and add the necessary permissions for Route53 access."</span><span class="p">)</span>
<div class="viewcode-block" id="Authenticator"><a class="viewcode-back" href="../../api/dns_route53.html#certbot_dns_route53.dns_route53.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">dns_common</span><span class="o">.</span><span class="n">DNSAuthenticator</span><span class="p">):</span>
<span class="sd">"""Route53 Authenticator</span>
<span class="sd"> This authenticator solves a DNS01 challenge by uploading the answer to AWS</span>
<span class="sd"> Route53.</span>
<span class="sd"> """</span>
<span class="n">description</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"Obtain certificates using a DNS TXT record (if you are using AWS Route53 for "</span>
<span class="s2">"DNS)."</span><span class="p">)</span>
<span class="n">ttl</span> <span class="o">=</span> <span class="mi">10</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">r53</span> <span class="o">=</span> <span class="n">boto3</span><span class="o">.</span><span class="n">client</span><span class="p">(</span><span class="s2">"route53"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_resource_records</span> <span class="o">=</span> <span class="n">collections</span><span class="o">.</span><span class="n">defaultdict</span><span class="p">(</span><span class="nb">list</span><span class="p">)</span>
<span class="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="s2">"Solve a DNS01 challenge using AWS Route53"</span>
<span class="k">def</span> <span class="nf">_setup_credentials</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">pass</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">domain</span><span class="p">,</span> <span class="n">validation_domain_name</span><span class="p">,</span> <span class="n">validation</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">change_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_change_txt_record</span><span class="p">(</span><span class="s2">"UPSERT"</span><span class="p">,</span> <span class="n">validation_domain_name</span><span class="p">,</span> <span class="n">validation</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_wait_for_change</span><span class="p">(</span><span class="n">change_id</span><span class="p">)</span>
<span class="k">except</span> <span class="p">(</span><span class="n">NoCredentialsError</span><span class="p">,</span> <span class="n">ClientError</span><span class="p">)</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'Encountered error during perform: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">e</span><span class="p">,</span> <span class="n">exc_info</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">),</span> <span class="n">INSTRUCTIONS</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">domain</span><span class="p">,</span> <span class="n">validation_domain_name</span><span class="p">,</span> <span class="n">validation</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_change_txt_record</span><span class="p">(</span><span class="s2">"DELETE"</span><span class="p">,</span> <span class="n">validation_domain_name</span><span class="p">,</span> <span class="n">validation</span><span class="p">)</span>
<span class="k">except</span> <span class="p">(</span><span class="n">NoCredentialsError</span><span class="p">,</span> <span class="n">ClientError</span><span class="p">)</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'Encountered error during cleanup: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">e</span><span class="p">,</span> <span class="n">exc_info</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<div class="viewcode-block" id="Authenticator._find_zone_id_for_domain"><a class="viewcode-back" href="../../api/dns_route53.html#certbot_dns_route53.dns_route53.Authenticator._find_zone_id_for_domain">[docs]</a> <span class="k">def</span> <span class="nf">_find_zone_id_for_domain</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">domain</span><span class="p">):</span>
<span class="sd">"""Find the zone id responsible a given FQDN.</span>
<span class="sd"> That is, the id for the zone whose name is the longest parent of the</span>
<span class="sd"> domain.</span>
<span class="sd"> """</span>
<span class="n">paginator</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">r53</span><span class="o">.</span><span class="n">get_paginator</span><span class="p">(</span><span class="s2">"list_hosted_zones"</span><span class="p">)</span>
<span class="n">zones</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">target_labels</span> <span class="o">=</span> <span class="n">domain</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s2">"."</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"."</span><span class="p">)</span>
<span class="k">for</span> <span class="n">page</span> <span class="ow">in</span> <span class="n">paginator</span><span class="o">.</span><span class="n">paginate</span><span class="p">():</span>
<span class="k">for</span> <span class="n">zone</span> <span class="ow">in</span> <span class="n">page</span><span class="p">[</span><span class="s2">"HostedZones"</span><span class="p">]:</span>
<span class="k">if</span> <span class="n">zone</span><span class="p">[</span><span class="s2">"Config"</span><span class="p">][</span><span class="s2">"PrivateZone"</span><span class="p">]:</span>
<span class="k">continue</span>
<span class="n">candidate_labels</span> <span class="o">=</span> <span class="n">zone</span><span class="p">[</span><span class="s2">"Name"</span><span class="p">]</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s2">"."</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"."</span><span class="p">)</span>
<span class="k">if</span> <span class="n">candidate_labels</span> <span class="o">==</span> <span class="n">target_labels</span><span class="p">[</span><span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="n">candidate_labels</span><span class="p">):]:</span>
<span class="n">zones</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">zone</span><span class="p">[</span><span class="s2">"Name"</span><span class="p">],</span> <span class="n">zone</span><span class="p">[</span><span class="s2">"Id"</span><span class="p">]))</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">zones</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span>
<span class="s2">"Unable to find a Route53 hosted zone for </span><span class="si">{0}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">domain</span><span class="p">)</span>
<span class="p">)</span>
<span class="c1"># Order the zones that are suffixes for our desired to domain by</span>
<span class="c1"># length, this puts them in an order like:</span>
<span class="c1"># ["foo.bar.baz.com", "bar.baz.com", "baz.com", "com"]</span>
<span class="c1"># And then we choose the first one, which will be the most specific.</span>
<span class="n">zones</span><span class="o">.</span><span class="n">sort</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="k">lambda</span> <span class="n">z</span><span class="p">:</span> <span class="nb">len</span><span class="p">(</span><span class="n">z</span><span class="p">[</span><span class="mi">0</span><span class="p">]),</span> <span class="n">reverse</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">return</span> <span class="n">zones</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">1</span><span class="p">]</span></div>
<span class="k">def</span> <span class="nf">_change_txt_record</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">action</span><span class="p">,</span> <span class="n">validation_domain_name</span><span class="p">,</span> <span class="n">validation</span><span class="p">):</span>
<span class="n">zone_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_find_zone_id_for_domain</span><span class="p">(</span><span class="n">validation_domain_name</span><span class="p">)</span>
<span class="n">rrecords</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_resource_records</span><span class="p">[</span><span class="n">validation_domain_name</span><span class="p">]</span>
<span class="n">challenge</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"Value"</span><span class="p">:</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="n">validation</span><span class="p">)}</span>
<span class="k">if</span> <span class="n">action</span> <span class="o">==</span> <span class="s2">"DELETE"</span><span class="p">:</span>
<span class="c1"># Remove the record being deleted from the list of tracked records</span>
<span class="n">rrecords</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">challenge</span><span class="p">)</span>
<span class="k">if</span> <span class="n">rrecords</span><span class="p">:</span>
<span class="c1"># Need to update instead, as we're not deleting the rrset</span>
<span class="n">action</span> <span class="o">=</span> <span class="s2">"UPSERT"</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Create a new list containing the record to use with DELETE</span>
<span class="n">rrecords</span> <span class="o">=</span> <span class="p">[</span><span class="n">challenge</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">rrecords</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">challenge</span><span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">r53</span><span class="o">.</span><span class="n">change_resource_record_sets</span><span class="p">(</span>
<span class="n">HostedZoneId</span><span class="o">=</span><span class="n">zone_id</span><span class="p">,</span>
<span class="n">ChangeBatch</span><span class="o">=</span><span class="p">{</span>
<span class="s2">"Comment"</span><span class="p">:</span> <span class="s2">"certbot-dns-route53 certificate validation "</span> <span class="o">+</span> <span class="n">action</span><span class="p">,</span>
<span class="s2">"Changes"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">"Action"</span><span class="p">:</span> <span class="n">action</span><span class="p">,</span>
<span class="s2">"ResourceRecordSet"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"Name"</span><span class="p">:</span> <span class="n">validation_domain_name</span><span class="p">,</span>
<span class="s2">"Type"</span><span class="p">:</span> <span class="s2">"TXT"</span><span class="p">,</span>
<span class="s2">"TTL"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">ttl</span><span class="p">,</span>
<span class="s2">"ResourceRecords"</span><span class="p">:</span> <span class="n">rrecords</span><span class="p">,</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">response</span><span class="p">[</span><span class="s2">"ChangeInfo"</span><span class="p">][</span><span class="s2">"Id"</span><span class="p">]</span>
<div class="viewcode-block" id="Authenticator._wait_for_change"><a class="viewcode-back" href="../../api/dns_route53.html#certbot_dns_route53.dns_route53.Authenticator._wait_for_change">[docs]</a> <span class="k">def</span> <span class="nf">_wait_for_change</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">change_id</span><span class="p">):</span>
<span class="sd">"""Wait for a change to be propagated to all Route53 DNS servers.</span>
<span class="sd"> https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html</span>
<span class="sd"> """</span>
<span class="k">for</span> <span class="n">unused_n</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">120</span><span class="p">):</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">r53</span><span class="o">.</span><span class="n">get_change</span><span class="p">(</span><span class="n">Id</span><span class="o">=</span><span class="n">change_id</span><span class="p">)</span>
<span class="k">if</span> <span class="n">response</span><span class="p">[</span><span class="s2">"ChangeInfo"</span><span class="p">][</span><span class="s2">"Status"</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"INSYNC"</span><span class="p">:</span>
<span class="k">return</span>
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span>
<span class="s2">"Timed out waiting for Route53 change. Current status: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span>
<span class="n">response</span><span class="p">[</span><span class="s2">"ChangeInfo"</span><span class="p">][</span><span class="s2">"Status"</span><span class="p">])</span></div></div>
</pre></div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2018, Certbot Project.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
|