python-certbot-apache-doc 0.23.0-1 / usr / share / doc / python3-certbot-apache / html / api / obj.html

This file is indexed.

/usr/share/doc/python3-certbot-apache/html/api/obj.html is in python-certbot-apache-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
<!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_apache.obj &mdash; certbot-apache 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-apache 0 documentation" href="../index.html"/>
        <link rel="up" title="API Documentation" href="../api.html"/>
        <link rel="next" title="certbot_apache.parser" href="parser.html"/>
        <link rel="prev" title="certbot_apache.display_ops" href="display_ops.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-apache
          

          
          </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"><a class="reference internal" href="augeas_configurator.html"><code class="docutils literal"><span class="pre">certbot_apache.augeas_configurator</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="configurator.html"><code class="docutils literal"><span class="pre">certbot_apache.configurator</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="display_ops.html"><code class="docutils literal"><span class="pre">certbot_apache.display_ops</span></code></a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">certbot_apache.obj</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="parser.html"><code class="docutils literal"><span class="pre">certbot_apache.parser</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="tls_sni_01.html"><code class="docutils literal"><span class="pre">certbot_apache.tls_sni_01</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-apache</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> &raquo;</li>
        
          <li><a href="../api.html">API Documentation</a> &raquo;</li>
        
      <li><code class="docutils literal"><span class="pre">certbot_apache.obj</span></code></li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="../_sources/api/obj.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_apache.obj">
<span id="certbot-apache-obj"></span><h1><a class="reference internal" href="#module-certbot_apache.obj" title="certbot_apache.obj"><code class="xref py py-mod docutils literal"><span class="pre">certbot_apache.obj</span></code></a><a class="headerlink" href="#module-certbot_apache.obj" title="Permalink to this headline"></a></h1>
<p>Module contains classes used by the Apache Configurator.</p>
<dl class="class">
<dt id="certbot_apache.obj.Addr">
<em class="property">class </em><code class="descclassname">certbot_apache.obj.</code><code class="descname">Addr</code><span class="sig-paren">(</span><em>tup</em>, <em>ipv6=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_apache/obj.html#Addr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_apache.obj.Addr" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">certbot.plugins.common.Addr</span></code></p>
<p>Represents an Apache address.</p>
<dl class="method">
<dt id="certbot_apache.obj.Addr._addr_less_specific">
<code class="descname">_addr_less_specific</code><span class="sig-paren">(</span><em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_apache/obj.html#Addr._addr_less_specific"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_apache.obj.Addr._addr_less_specific" title="Permalink to this definition"></a></dt>
<dd><p>Returns if addr.get_addr() is more specific than self.get_addr().</p>
</dd></dl>

<dl class="method">
<dt id="certbot_apache.obj.Addr._rank_specific_addr">
<code class="descname">_rank_specific_addr</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_apache/obj.html#Addr._rank_specific_addr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_apache.obj.Addr._rank_specific_addr" title="Permalink to this definition"></a></dt>
<dd><p>Returns numerical rank for get_addr()</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">Returns:</th><td class="field-body">2 - FQ, 1 - wildcard, 0 - _default_</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="certbot_apache.obj.Addr.conflicts">
<code class="descname">conflicts</code><span class="sig-paren">(</span><em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_apache/obj.html#Addr.conflicts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_apache.obj.Addr.conflicts" title="Permalink to this definition"></a></dt>
<dd><p>Returns if address could conflict with correct function of self.</p>
<p>Could addr take away service provided by self within Apache?</p>
<div class="admonition-todo admonition" id="index-0">
<p class="first admonition-title">Todo</p>
<p class="last">Handle domain name addrs…</p>
</div>
<p>Examples:</p>
<table border="1" class="docutils">
<colgroup>
<col width="89%" />
<col width="11%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">127.0.0.1:\*.conflicts(127.0.0.1:443)</span></code></td>
<td>True</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">127.0.0.1:443.conflicts(127.0.0.1:\*)</span></code></td>
<td>False</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">\*:443.conflicts(\*:80)</span></code></td>
<td>False</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">_default_:443.conflicts(\*:443)</span></code></td>
<td>True</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="certbot_apache.obj.Addr.is_wildcard">
<code class="descname">is_wildcard</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_apache/obj.html#Addr.is_wildcard"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_apache.obj.Addr.is_wildcard" title="Permalink to this definition"></a></dt>
<dd><p>Returns if address has a wildcard port.</p>
</dd></dl>

<dl class="method">
<dt id="certbot_apache.obj.Addr.get_sni_addr">
<code class="descname">get_sni_addr</code><span class="sig-paren">(</span><em>port</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_apache/obj.html#Addr.get_sni_addr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_apache.obj.Addr.get_sni_addr" title="Permalink to this definition"></a></dt>
<dd><p>Returns the least specific address that resolves on the port.</p>
<p>Examples:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">1.2.3.4:443</span></code> -&gt; <code class="docutils literal"><span class="pre">1.2.3.4:&lt;port&gt;</span></code></li>
<li><code class="docutils literal"><span class="pre">1.2.3.4:*</span></code> -&gt; <code class="docutils literal"><span class="pre">1.2.3.4:*</span></code></li>
</ul>
<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>port</strong> (<em>str</em>) – Desired port</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="certbot_apache.obj.VirtualHost">
<em class="property">class </em><code class="descclassname">certbot_apache.obj.</code><code class="descname">VirtualHost</code><span class="sig-paren">(</span><em>filep</em>, <em>path</em>, <em>addrs</em>, <em>ssl</em>, <em>enabled</em>, <em>name=None</em>, <em>aliases=None</em>, <em>modmacro=False</em>, <em>ancestor=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_apache/obj.html#VirtualHost"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_apache.obj.VirtualHost" 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>Represents an Apache Virtualhost.</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">Variables:</th><td class="field-body"><ul class="first last simple">
<li><strong>filep</strong> (<em>str</em>) – file path of VH</li>
<li><strong>path</strong> (<em>str</em>) – Augeas path to virtual host</li>
<li><strong>addrs</strong> (<em>set</em>) – Virtual Host addresses (<code class="xref py py-class docutils literal"><span class="pre">set</span></code> of
<code class="xref py py-class docutils literal"><span class="pre">common.Addr</span></code>)</li>
<li><strong>name</strong> (<em>str</em>) – ServerName of VHost</li>
<li><strong>aliases</strong> (<em>list</em>) – Server aliases of vhost
(<code class="xref py py-class docutils literal"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal"><span class="pre">str</span></code>)</li>
<li><strong>ssl</strong> (<em>bool</em>) – SSLEngine on in vhost</li>
<li><strong>enabled</strong> (<em>bool</em>) – Virtual host is enabled</li>
<li><strong>modmacro</strong> (<em>bool</em>) – VirtualHost is using mod_macro</li>
<li><strong>ancestor</strong> (<a class="reference internal" href="#certbot_apache.obj.VirtualHost" title="certbot_apache.obj.VirtualHost"><em>VirtualHost</em></a>) – A non-SSL VirtualHost this is based on</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p><a class="reference external" href="https://httpd.apache.org/docs/2.4/vhosts/details.html">https://httpd.apache.org/docs/2.4/vhosts/details.html</a></p>
<div class="admonition-todo admonition" id="index-1">
<p class="first admonition-title">Todo</p>
<p class="last">Any vhost that includes the magic _default_ wildcard is given the
same ServerName as the main server.</p>
</div>
<dl class="method">
<dt id="certbot_apache.obj.VirtualHost.get_names">
<code class="descname">get_names</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_apache/obj.html#VirtualHost.get_names"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_apache.obj.VirtualHost.get_names" title="Permalink to this definition"></a></dt>
<dd><p>Return a set of all names.</p>
</dd></dl>

<dl class="method">
<dt id="certbot_apache.obj.VirtualHost.display_repr">
<code class="descname">display_repr</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_apache/obj.html#VirtualHost.display_repr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_apache.obj.VirtualHost.display_repr" title="Permalink to this definition"></a></dt>
<dd><p>Return a representation of VHost to be used in dialog</p>
</dd></dl>

<dl class="method">
<dt id="certbot_apache.obj.VirtualHost.conflicts">
<code class="descname">conflicts</code><span class="sig-paren">(</span><em>addrs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_apache/obj.html#VirtualHost.conflicts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_apache.obj.VirtualHost.conflicts" title="Permalink to this definition"></a></dt>
<dd><p>See if vhost conflicts with any of the addrs.</p>
<p>This determines whether or not these addresses would/could overwrite
the vhost addresses.</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>addrs</strong> (<em>Iterable :class:~obj.Addr</em>) – Iterable Addresses</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">If addresses conflicts with vhost</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="certbot_apache.obj.VirtualHost.same_server">
<code class="descname">same_server</code><span class="sig-paren">(</span><em>vhost</em>, <em>generic=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/certbot_apache/obj.html#VirtualHost.same_server"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#certbot_apache.obj.VirtualHost.same_server" title="Permalink to this definition"></a></dt>
<dd><p>Determines if the vhost is the same ‘server’.</p>
<p>Used in redirection - indicates whether or not the two virtual hosts
serve on the exact same IP combinations, but different ports.
The generic flag indicates that that we’re trying to match to a
default or generic vhost</p>
<div class="admonition-todo admonition" id="index-2">
<p class="first admonition-title">Todo</p>
<p class="last">Handle _default_</p>
</div>
</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="parser.html" class="btn btn-neutral float-right" title="certbot_apache.parser" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="display_ops.html" class="btn btn-neutral" title="certbot_apache.display_ops" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2014-2018, Let&#39;s Encrypt 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>

APT Browse - Built by Thomas Orozco.