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

This file is indexed.

/usr/share/doc/python3-certbot-apache/html/_modules/certbot_apache/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
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
<!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="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-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>
<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-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="../index.html">Module code</a> &raquo;</li>
        
      <li>certbot_apache.obj</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_apache.obj</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;Module contains classes used by the Apache Configurator.&quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">re</span>

<span class="kn">from</span> <span class="nn">certbot.plugins</span> <span class="k">import</span> <span class="n">common</span>


<div class="viewcode-block" id="Addr"><a class="viewcode-back" href="../../api/obj.html#certbot_apache.obj.Addr">[docs]</a><span class="k">class</span> <span class="nc">Addr</span><span class="p">(</span><span class="n">common</span><span class="o">.</span><span class="n">Addr</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Represents an Apache address.&quot;&quot;&quot;</span>

    <span class="k">def</span> <span class="nf">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;This is defined as equivalent within Apache.</span>

<span class="sd">        ip_addr:* == ip_addr</span>

<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="p">):</span>
            <span class="k">return</span> <span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">tup</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">tup</span><span class="p">)</span> <span class="ow">or</span>
                    <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tup</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">tup</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">and</span>
                     <span class="bp">self</span><span class="o">.</span><span class="n">is_wildcard</span><span class="p">()</span> <span class="ow">and</span> <span class="n">other</span><span class="o">.</span><span class="n">is_wildcard</span><span class="p">()))</span>
        <span class="k">return</span> <span class="kc">False</span>

    <span class="k">def</span> <span class="nf">__ne__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
        <span class="k">return</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="fm">__eq__</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>

    <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="k">return</span> <span class="s2">&quot;certbot_apache.obj.Addr(&quot;</span> <span class="o">+</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tup</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot;)&quot;</span>

    <span class="k">def</span> <span class="nf">__hash__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="c1"># Python 3 requires explicit overridden for __hash__ if __eq__ or</span>
        <span class="c1"># __cmp__ is overridden. See https://bugs.python.org/issue2235</span>
        <span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">Addr</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__hash__</span><span class="p">()</span>

<div class="viewcode-block" id="Addr._addr_less_specific"><a class="viewcode-back" href="../../api/obj.html#certbot_apache.obj.Addr._addr_less_specific">[docs]</a>    <span class="k">def</span> <span class="nf">_addr_less_specific</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">addr</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Returns if addr.get_addr() is more specific than self.get_addr().&quot;&quot;&quot;</span>
        <span class="c1"># pylint: disable=protected-access</span>
        <span class="k">return</span> <span class="n">addr</span><span class="o">.</span><span class="n">_rank_specific_addr</span><span class="p">()</span> <span class="o">&gt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">_rank_specific_addr</span><span class="p">()</span></div>

<div class="viewcode-block" id="Addr._rank_specific_addr"><a class="viewcode-back" href="../../api/obj.html#certbot_apache.obj.Addr._rank_specific_addr">[docs]</a>    <span class="k">def</span> <span class="nf">_rank_specific_addr</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Returns numerical rank for get_addr()</span>

<span class="sd">        :returns: 2 - FQ, 1 - wildcard, 0 - _default_</span>
<span class="sd">        :rtype: int</span>

<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_addr</span><span class="p">()</span> <span class="o">==</span> <span class="s2">&quot;_default_&quot;</span><span class="p">:</span>
            <span class="k">return</span> <span class="mi">0</span>
        <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_addr</span><span class="p">()</span> <span class="o">==</span> <span class="s2">&quot;*&quot;</span><span class="p">:</span>
            <span class="k">return</span> <span class="mi">1</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="k">return</span> <span class="mi">2</span></div>

<div class="viewcode-block" id="Addr.conflicts"><a class="viewcode-back" href="../../api/obj.html#certbot_apache.obj.Addr.conflicts">[docs]</a>    <span class="k">def</span> <span class="nf">conflicts</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">addr</span><span class="p">):</span>
        <span class="sa">r</span><span class="sd">&quot;&quot;&quot;Returns if address could conflict with correct function of self.</span>

<span class="sd">        Could addr take away service provided by self within Apache?</span>

<span class="sd">        .. note::IP Address is more important than wildcard.</span>
<span class="sd">            Connection from 127.0.0.1:80 with choices of *:80 and 127.0.0.1:*</span>
<span class="sd">            chooses 127.0.0.1:\*</span>

<span class="sd">        .. todo:: Handle domain name addrs...</span>

<span class="sd">        Examples:</span>

<span class="sd">        =========================================  =====</span>
<span class="sd">        ``127.0.0.1:\*.conflicts(127.0.0.1:443)``  True</span>
<span class="sd">        ``127.0.0.1:443.conflicts(127.0.0.1:\*)``  False</span>
<span class="sd">        ``\*:443.conflicts(\*:80)``                False</span>
<span class="sd">        ``_default_:443.conflicts(\*:443)``        True</span>
<span class="sd">        =========================================  =====</span>

<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_addr_less_specific</span><span class="p">(</span><span class="n">addr</span><span class="p">):</span>
            <span class="k">return</span> <span class="kc">True</span>
        <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_addr</span><span class="p">()</span> <span class="o">==</span> <span class="n">addr</span><span class="o">.</span><span class="n">get_addr</span><span class="p">():</span>
            <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_wildcard</span><span class="p">()</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_port</span><span class="p">()</span> <span class="o">==</span> <span class="n">addr</span><span class="o">.</span><span class="n">get_port</span><span class="p">():</span>
                <span class="k">return</span> <span class="kc">True</span>
        <span class="k">return</span> <span class="kc">False</span></div>

<div class="viewcode-block" id="Addr.is_wildcard"><a class="viewcode-back" href="../../api/obj.html#certbot_apache.obj.Addr.is_wildcard">[docs]</a>    <span class="k">def</span> <span class="nf">is_wildcard</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Returns if address has a wildcard port.&quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">tup</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s2">&quot;*&quot;</span> <span class="ow">or</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">tup</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span></div>

<div class="viewcode-block" id="Addr.get_sni_addr"><a class="viewcode-back" href="../../api/obj.html#certbot_apache.obj.Addr.get_sni_addr">[docs]</a>    <span class="k">def</span> <span class="nf">get_sni_addr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">port</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Returns the least specific address that resolves on the port.</span>

<span class="sd">        Examples:</span>

<span class="sd">        - ``1.2.3.4:443`` -&gt; ``1.2.3.4:&lt;port&gt;``</span>
<span class="sd">        - ``1.2.3.4:*`` -&gt; ``1.2.3.4:*``</span>

<span class="sd">        :param str port: Desired port</span>

<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_wildcard</span><span class="p">():</span>
            <span class="k">return</span> <span class="bp">self</span>

        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_addr_obj</span><span class="p">(</span><span class="n">port</span><span class="p">)</span></div></div>


<div class="viewcode-block" id="VirtualHost"><a class="viewcode-back" href="../../api/obj.html#certbot_apache.obj.VirtualHost">[docs]</a><span class="k">class</span> <span class="nc">VirtualHost</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>  <span class="c1"># pylint: disable=too-few-public-methods</span>
    <span class="sd">&quot;&quot;&quot;Represents an Apache Virtualhost.</span>

<span class="sd">    :ivar str filep: file path of VH</span>
<span class="sd">    :ivar str path: Augeas path to virtual host</span>
<span class="sd">    :ivar set addrs: Virtual Host addresses (:class:`set` of</span>
<span class="sd">        :class:`common.Addr`)</span>
<span class="sd">    :ivar str name: ServerName of VHost</span>
<span class="sd">    :ivar list aliases: Server aliases of vhost</span>
<span class="sd">        (:class:`list` of :class:`str`)</span>

<span class="sd">    :ivar bool ssl: SSLEngine on in vhost</span>
<span class="sd">    :ivar bool enabled: Virtual host is enabled</span>
<span class="sd">    :ivar bool modmacro: VirtualHost is using mod_macro</span>
<span class="sd">    :ivar VirtualHost ancestor: A non-SSL VirtualHost this is based on</span>

<span class="sd">    https://httpd.apache.org/docs/2.4/vhosts/details.html</span>

<span class="sd">    .. todo:: Any vhost that includes the magic _default_ wildcard is given the</span>
<span class="sd">              same ServerName as the main server.</span>

<span class="sd">    &quot;&quot;&quot;</span>
    <span class="c1"># ?: is used for not returning enclosed characters</span>
    <span class="n">strip_name</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;^(?:.+://)?([^ :$]*)&quot;</span><span class="p">)</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="n">filep</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">addrs</span><span class="p">,</span> <span class="n">ssl</span><span class="p">,</span> <span class="n">enabled</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                 <span class="n">aliases</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">modmacro</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">ancestor</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>

        <span class="c1"># pylint: disable=too-many-arguments</span>
        <span class="sd">&quot;&quot;&quot;Initialize a VH.&quot;&quot;&quot;</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">filep</span> <span class="o">=</span> <span class="n">filep</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">path</span> <span class="o">=</span> <span class="n">path</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">addrs</span> <span class="o">=</span> <span class="n">addrs</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">aliases</span> <span class="o">=</span> <span class="n">aliases</span> <span class="k">if</span> <span class="n">aliases</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="nb">set</span><span class="p">()</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">ssl</span> <span class="o">=</span> <span class="n">ssl</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">enabled</span> <span class="o">=</span> <span class="n">enabled</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">modmacro</span> <span class="o">=</span> <span class="n">modmacro</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">ancestor</span> <span class="o">=</span> <span class="n">ancestor</span>

<div class="viewcode-block" id="VirtualHost.get_names"><a class="viewcode-back" href="../../api/obj.html#certbot_apache.obj.VirtualHost.get_names">[docs]</a>    <span class="k">def</span> <span class="nf">get_names</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Return a set of all names.&quot;&quot;&quot;</span>
        <span class="n">all_names</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
        <span class="n">all_names</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">aliases</span><span class="p">)</span>
        <span class="c1"># Strip out any scheme:// and &lt;port&gt; field from servername</span>
        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
            <span class="n">all_names</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">VirtualHost</span><span class="o">.</span><span class="n">strip_name</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)[</span><span class="mi">0</span><span class="p">])</span>

        <span class="k">return</span> <span class="n">all_names</span></div>

    <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="k">return</span> <span class="p">(</span>
            <span class="s2">&quot;File: </span><span class="si">{filename}</span><span class="se">\n</span><span class="s2">&quot;</span>
            <span class="s2">&quot;Vhost path: </span><span class="si">{vhpath}</span><span class="se">\n</span><span class="s2">&quot;</span>
            <span class="s2">&quot;Addresses: </span><span class="si">{addrs}</span><span class="se">\n</span><span class="s2">&quot;</span>
            <span class="s2">&quot;Name: </span><span class="si">{name}</span><span class="se">\n</span><span class="s2">&quot;</span>
            <span class="s2">&quot;Aliases: </span><span class="si">{aliases}</span><span class="se">\n</span><span class="s2">&quot;</span>
            <span class="s2">&quot;TLS Enabled: </span><span class="si">{tls}</span><span class="se">\n</span><span class="s2">&quot;</span>
            <span class="s2">&quot;Site Enabled: </span><span class="si">{active}</span><span class="se">\n</span><span class="s2">&quot;</span>
            <span class="s2">&quot;mod_macro Vhost: </span><span class="si">{modmacro}</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
                <span class="n">filename</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">filep</span><span class="p">,</span>
                <span class="n">vhpath</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span>
                <span class="n">addrs</span><span class="o">=</span><span class="s2">&quot;, &quot;</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">addr</span><span class="p">)</span> <span class="k">for</span> <span class="n">addr</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">addrs</span><span class="p">),</span>
                <span class="n">name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
                <span class="n">aliases</span><span class="o">=</span><span class="s2">&quot;, &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">name</span> <span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">aliases</span><span class="p">),</span>
                <span class="n">tls</span><span class="o">=</span><span class="s2">&quot;Yes&quot;</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">ssl</span> <span class="k">else</span> <span class="s2">&quot;No&quot;</span><span class="p">,</span>
                <span class="n">active</span><span class="o">=</span><span class="s2">&quot;Yes&quot;</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">enabled</span> <span class="k">else</span> <span class="s2">&quot;No&quot;</span><span class="p">,</span>
                <span class="n">modmacro</span><span class="o">=</span><span class="s2">&quot;Yes&quot;</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">modmacro</span> <span class="k">else</span> <span class="s2">&quot;No&quot;</span><span class="p">))</span>

<div class="viewcode-block" id="VirtualHost.display_repr"><a class="viewcode-back" href="../../api/obj.html#certbot_apache.obj.VirtualHost.display_repr">[docs]</a>    <span class="k">def</span> <span class="nf">display_repr</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Return a representation of VHost to be used in dialog&quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="p">(</span>
            <span class="s2">&quot;File: </span><span class="si">{filename}</span><span class="se">\n</span><span class="s2">&quot;</span>
            <span class="s2">&quot;Addresses: </span><span class="si">{addrs}</span><span class="se">\n</span><span class="s2">&quot;</span>
            <span class="s2">&quot;Names: </span><span class="si">{names}</span><span class="se">\n</span><span class="s2">&quot;</span>
            <span class="s2">&quot;HTTPS: </span><span class="si">{https}</span><span class="se">\n</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
                <span class="n">filename</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">filep</span><span class="p">,</span>
                <span class="n">addrs</span><span class="o">=</span><span class="s2">&quot;, &quot;</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">addr</span><span class="p">)</span> <span class="k">for</span> <span class="n">addr</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">addrs</span><span class="p">),</span>
                <span class="n">names</span><span class="o">=</span><span class="s2">&quot;, &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_names</span><span class="p">()),</span>
                <span class="n">https</span><span class="o">=</span><span class="s2">&quot;Yes&quot;</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">ssl</span> <span class="k">else</span> <span class="s2">&quot;No&quot;</span><span class="p">))</span></div>


    <span class="k">def</span> <span class="nf">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="p">):</span>
            <span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">filep</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">filep</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">path</span> <span class="ow">and</span>
                    <span class="bp">self</span><span class="o">.</span><span class="n">addrs</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">addrs</span> <span class="ow">and</span>
                    <span class="bp">self</span><span class="o">.</span><span class="n">get_names</span><span class="p">()</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">get_names</span><span class="p">()</span> <span class="ow">and</span>
                    <span class="bp">self</span><span class="o">.</span><span class="n">ssl</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">ssl</span> <span class="ow">and</span>
                    <span class="bp">self</span><span class="o">.</span><span class="n">enabled</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">enabled</span> <span class="ow">and</span>
                    <span class="bp">self</span><span class="o">.</span><span class="n">modmacro</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">modmacro</span><span class="p">)</span>

        <span class="k">return</span> <span class="kc">False</span>

    <span class="k">def</span> <span class="nf">__ne__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
        <span class="k">return</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="fm">__eq__</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>

    <span class="k">def</span> <span class="nf">__hash__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="k">return</span> <span class="nb">hash</span><span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">filep</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span>
                     <span class="nb">tuple</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">addrs</span><span class="p">),</span> <span class="nb">tuple</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_names</span><span class="p">()),</span>
                     <span class="bp">self</span><span class="o">.</span><span class="n">ssl</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">enabled</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">modmacro</span><span class="p">))</span>

<div class="viewcode-block" id="VirtualHost.conflicts"><a class="viewcode-back" href="../../api/obj.html#certbot_apache.obj.VirtualHost.conflicts">[docs]</a>    <span class="k">def</span> <span class="nf">conflicts</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">addrs</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;See if vhost conflicts with any of the addrs.</span>

<span class="sd">        This determines whether or not these addresses would/could overwrite</span>
<span class="sd">        the vhost addresses.</span>

<span class="sd">        :param addrs: Iterable Addresses</span>
<span class="sd">        :type addrs: Iterable :class:~obj.Addr</span>

<span class="sd">        :returns: If addresses conflicts with vhost</span>
<span class="sd">        :rtype: bool</span>

<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">for</span> <span class="n">pot_addr</span> <span class="ow">in</span> <span class="n">addrs</span><span class="p">:</span>
            <span class="k">for</span> <span class="n">addr</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">addrs</span><span class="p">:</span>
                <span class="k">if</span> <span class="n">addr</span><span class="o">.</span><span class="n">conflicts</span><span class="p">(</span><span class="n">pot_addr</span><span class="p">):</span>
                    <span class="k">return</span> <span class="kc">True</span>
        <span class="k">return</span> <span class="kc">False</span></div>

<div class="viewcode-block" id="VirtualHost.same_server"><a class="viewcode-back" href="../../api/obj.html#certbot_apache.obj.VirtualHost.same_server">[docs]</a>    <span class="k">def</span> <span class="nf">same_server</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vhost</span><span class="p">,</span> <span class="n">generic</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Determines if the vhost is the same &#39;server&#39;.</span>

<span class="sd">        Used in redirection - indicates whether or not the two virtual hosts</span>
<span class="sd">        serve on the exact same IP combinations, but different ports.</span>
<span class="sd">        The generic flag indicates that that we&#39;re trying to match to a</span>
<span class="sd">        default or generic vhost</span>

<span class="sd">        .. todo:: Handle _default_</span>

<span class="sd">        &quot;&quot;&quot;</span>

        <span class="k">if</span> <span class="ow">not</span> <span class="n">generic</span><span class="p">:</span>
            <span class="k">if</span> <span class="n">vhost</span><span class="o">.</span><span class="n">get_names</span><span class="p">()</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_names</span><span class="p">():</span>
                <span class="k">return</span> <span class="kc">False</span>

            <span class="c1"># If equal and set is not empty... assume same server</span>
            <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">aliases</span><span class="p">:</span>
                <span class="k">return</span> <span class="kc">True</span>
        <span class="c1"># If we&#39;re looking for a generic vhost,</span>
        <span class="c1"># don&#39;t return one with a ServerName</span>
        <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">:</span>
            <span class="k">return</span> <span class="kc">False</span>

        <span class="c1"># Both sets of names are empty.</span>

        <span class="c1"># Make conservative educated guess... this is very restrictive</span>
        <span class="c1"># Consider adding more safety checks.</span>
        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">vhost</span><span class="o">.</span><span class="n">addrs</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">addrs</span><span class="p">):</span>
            <span class="k">return</span> <span class="kc">False</span>

        <span class="c1"># already_found acts to keep everything very conservative.</span>
        <span class="c1"># Don&#39;t allow multiple ip:ports in same set.</span>
        <span class="n">already_found</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>

        <span class="k">for</span> <span class="n">addr</span> <span class="ow">in</span> <span class="n">vhost</span><span class="o">.</span><span class="n">addrs</span><span class="p">:</span>
            <span class="k">for</span> <span class="n">local_addr</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">addrs</span><span class="p">:</span>
                <span class="k">if</span> <span class="p">(</span><span class="n">local_addr</span><span class="o">.</span><span class="n">get_addr</span><span class="p">()</span> <span class="o">==</span> <span class="n">addr</span><span class="o">.</span><span class="n">get_addr</span><span class="p">()</span> <span class="ow">and</span>
                        <span class="n">local_addr</span> <span class="o">!=</span> <span class="n">addr</span> <span class="ow">and</span>
                        <span class="n">local_addr</span><span class="o">.</span><span class="n">get_addr</span><span class="p">()</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">already_found</span><span class="p">):</span>

                    <span class="c1"># This intends to make sure we aren&#39;t double counting...</span>
                    <span class="c1"># e.g. 127.0.0.1:* - We require same number of addrs</span>
                    <span class="c1">#  currently</span>
                    <span class="n">already_found</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">local_addr</span><span class="o">.</span><span class="n">get_addr</span><span class="p">())</span>
                    <span class="k">break</span>
            <span class="k">else</span><span class="p">:</span>
                <span class="k">return</span> <span class="kc">False</span>

        <span class="k">return</span> <span class="kc">True</span></div></div>
</pre></div>

           </div>
           <div class="articleComments">
            
           </div>
          </div>
          <footer>
  

  <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.