/usr/share/doc/python3-certbot-dns-rfc2136/html/api/dns_rfc2136.html is in python-certbot-dns-rfc2136-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 | <!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_rfc2136.dns_rfc2136 — certbot-dns-rfc2136 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-rfc2136 0 documentation" href="../index.html"/>
<link rel="up" title="API Documentation" href="../api.html"/>
<link rel="prev" title="API Documentation" href="../api.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-rfc2136
</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 class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Documentation</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">certbot_dns_rfc2136.dns_rfc2136</span></code></a></li>
</ul>
</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-rfc2136</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="../api.html">API Documentation</a> »</li>
<li><code class="docutils literal"><span class="pre">certbot_dns_rfc2136.dns_rfc2136</span></code></li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/api/dns_rfc2136.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-certbot_dns_rfc2136.dns_rfc2136">
<span id="certbot-dns-rfc2136-dns-rfc2136"></span><h1><a class="reference internal" href="#module-certbot_dns_rfc2136.dns_rfc2136" title="certbot_dns_rfc2136.dns_rfc2136"><code class="xref py py-mod docutils literal"><span class="pre">certbot_dns_rfc2136.dns_rfc2136</span></code></a><a class="headerlink" href="#module-certbot_dns_rfc2136.dns_rfc2136" title="Permalink to this headline">¶</a></h1>
<p>DNS Authenticator using RFC 2136 Dynamic Updates.</p>
<dl class="class">
<dt id="certbot_dns_rfc2136.dns_rfc2136.Authenticator">
<em class="property">class </em><code class="descclassname">certbot_dns_rfc2136.dns_rfc2136.</code><code class="descname">Authenticator</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_dns_rfc2136/dns_rfc2136.html#Authenticator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_dns_rfc2136.dns_rfc2136.Authenticator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">certbot.plugins.dns_common.DNSAuthenticator</span></code></p>
<p>DNS Authenticator using RFC 2136 Dynamic Updates</p>
<p>This Authenticator uses RFC 2136 Dynamic Updates to fulfull a dns-01 challenge.</p>
</dd></dl>
<dl class="class">
<dt id="certbot_dns_rfc2136.dns_rfc2136._RFC2136Client">
<em class="property">class </em><code class="descclassname">certbot_dns_rfc2136.dns_rfc2136.</code><code class="descname">_RFC2136Client</code><span class="sig-paren">(</span><em>server</em>, <em>key_name</em>, <em>key_secret</em>, <em>key_algorithm</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_dns_rfc2136/dns_rfc2136.html#_RFC2136Client"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_dns_rfc2136.dns_rfc2136._RFC2136Client" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Encapsulates all communication with the target DNS server.</p>
<dl class="method">
<dt id="certbot_dns_rfc2136.dns_rfc2136._RFC2136Client.add_txt_record">
<code class="descname">add_txt_record</code><span class="sig-paren">(</span><em>record_name</em>, <em>record_content</em>, <em>record_ttl</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_dns_rfc2136/dns_rfc2136.html#_RFC2136Client.add_txt_record"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_dns_rfc2136.dns_rfc2136._RFC2136Client.add_txt_record" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a TXT record using the supplied information.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>record_name</strong> (<em>str</em>) – The record name (typically beginning with ‘_acme-challenge.’).</li>
<li><strong>record_content</strong> (<em>str</em>) – The record content (typically the challenge validation).</li>
<li><strong>record_ttl</strong> (<em>int</em>) – The record TTL (number of seconds that the record may be cached).</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><strong>certbot.errors.PluginError</strong> – if an error occurs communicating with the DNS server</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="certbot_dns_rfc2136.dns_rfc2136._RFC2136Client.del_txt_record">
<code class="descname">del_txt_record</code><span class="sig-paren">(</span><em>record_name</em>, <em>record_content</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_dns_rfc2136/dns_rfc2136.html#_RFC2136Client.del_txt_record"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_dns_rfc2136.dns_rfc2136._RFC2136Client.del_txt_record" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete a TXT record using the supplied information.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>record_name</strong> (<em>str</em>) – The record name (typically beginning with ‘_acme-challenge.’).</li>
<li><strong>record_content</strong> (<em>str</em>) – The record content (typically the challenge validation).</li>
<li><strong>record_ttl</strong> (<em>int</em>) – The record TTL (number of seconds that the record may be cached).</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><strong>certbot.errors.PluginError</strong> – if an error occurs communicating with the DNS server</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="certbot_dns_rfc2136.dns_rfc2136._RFC2136Client._find_domain">
<code class="descname">_find_domain</code><span class="sig-paren">(</span><em>record_name</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_dns_rfc2136/dns_rfc2136.html#_RFC2136Client._find_domain"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_dns_rfc2136.dns_rfc2136._RFC2136Client._find_domain" title="Permalink to this definition">¶</a></dt>
<dd><p>Find the closest domain with an SOA record for a given domain name.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>record_name</strong> (<em>str</em>) – The record name for which to find the closest SOA record.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The domain, if found.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>certbot.errors.PluginError</strong> – if no SOA record can be found.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="certbot_dns_rfc2136.dns_rfc2136._RFC2136Client._query_soa">
<code class="descname">_query_soa</code><span class="sig-paren">(</span><em>domain_name</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_dns_rfc2136/dns_rfc2136.html#_RFC2136Client._query_soa"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_dns_rfc2136.dns_rfc2136._RFC2136Client._query_soa" title="Permalink to this definition">¶</a></dt>
<dd><p>Query a domain name for an authoritative SOA record.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>domain_name</strong> (<em>str</em>) – The domain name to query for an SOA record.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if found, False otherwise.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>certbot.errors.PluginError</strong> – if no response is received.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../api.html" class="btn btn-neutral" title="API Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<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>
|