This file is indexed.

/usr/share/doc/python3-pgpy/html/index.html is in python3-pgpy-doc 0.4.3-3.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>PGPy Documentation &#8212; PGPy 0.4.3 documentation</title>
    <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" href="_static/progress.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '0.4.3',
        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>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Installation" href="installation.html" />
   
  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head>
  <body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="pgpy-documentation">
<h1>PGPy Documentation<a class="headerlink" href="#pgpy-documentation" title="Permalink to this headline"></a></h1>
<p><code class="docutils literal"><span class="pre">PGPy</span></code> is a Python (2 and 3) implementation of the OpenPGP specification, as described in <a class="reference external" href="https://tools.ietf.org/html/rfc4880">RFC 4880</a>.</p>
<p>It aims to be easy to use above all else, but also to eventually embody a complete,
compliant implementation of the specification.</p>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#platform-specific-notes">Platform Specific Notes</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#id1">Installation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples.html#keys">Keys</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#messages">Messages</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#actions">Actions</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#exporting-pgp-objects">Exporting PGP* Objects</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/index.html">API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/index.html#exceptions">Exceptions</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/index.html#constants">Constants</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/index.html#classes">Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/index.html#other-objects">Other Objects</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="progress.html">OpenPGP Implementation Progress</a><ul>
<li class="toctree-l2"><a class="reference internal" href="progress.html#openpgp-rfcs">OpenPGP RFCs</a></li>
<li class="toctree-l2"><a class="reference internal" href="progress.html#non-rfc-extensions">Non-RFC Extensions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-4-3">v0.4.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-4-2">v0.4.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-4-1">v0.4.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-4-0">v0.4.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-3-0">v0.3.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-2-3">v0.2.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-2-2">v0.2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-2-1">v0.2.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-2-0">v0.2.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-1-0">v0.1.0</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h2>
<div class="section" id="platform-specific-notes">
<h3>Platform Specific Notes<a class="headerlink" href="#platform-specific-notes" title="Permalink to this headline"></a></h3>
<div class="section" id="windows">
<h4>Windows<a class="headerlink" href="#windows" title="Permalink to this headline"></a></h4>
<p>PGPy has not been formally tested on Windows. I see no reason why it wouldn’t work, but your mileage may vary.
If you try it out and run into any issues, please submit bug reports on the <a class="reference external" href="https://github.com/SecurityInnovation/PGPy/issues">issue tracker</a>!</p>
</div>
<div class="section" id="linux">
<h4>Linux<a class="headerlink" href="#linux" title="Permalink to this headline"></a></h4>
<div class="section" id="debian">
<h5>Debian<a class="headerlink" href="#debian" title="Permalink to this headline"></a></h5>
<p>PGPy is now in <a class="reference external" href="https://packages.debian.org/sid/python3-pgpy">Debian Sid</a>, and can be installed simply:</p>
<div class="highlight-console"><div class="highlight"><pre><span></span><span class="gp">$</span> sudo apt install python3-pgpy
</pre></div>
</div>
</div>
<div class="section" id="arch-linux">
<h5>Arch Linux<a class="headerlink" href="#arch-linux" title="Permalink to this headline"></a></h5>
<p>PGPy is available on the <a class="reference external" href="https://aur.archlinux.org/packages/python-pgpy/">AUR</a></p>
</div>
<div class="section" id="gentoo">
<h5>Gentoo<a class="headerlink" href="#gentoo" title="Permalink to this headline"></a></h5>
<p>There are gentoo ebuilds available in the <a class="reference external" href="https://github.com/SecurityInnovation/PGPy/tree/gentoo">gentoo branch</a></p>
</div>
<div class="section" id="redhat-centos">
<h5>RedHat/CentOS<a class="headerlink" href="#redhat-centos" title="Permalink to this headline"></a></h5>
<p>Coming Soon!</p>
</div>
<div class="section" id="other-linux">
<h5>Other Linux<a class="headerlink" href="#other-linux" title="Permalink to this headline"></a></h5>
<p>Building PGPy on Linux requires a C compiler, headers for Python, headers for OpenSSL, and libffi, to support building Cryptography.</p>
<p>For Debian/Ubuntu, these requirements can be installed like so:</p>
<div class="highlight-console"><div class="highlight"><pre><span></span><span class="gp">$</span> sudo apt install build-essential libssl-dev libffi-dev python-dev
</pre></div>
</div>
<p>You may need to install <code class="docutils literal"><span class="pre">python3-dev</span></code> if you are using PGPy on Python 3.</p>
<p>For Fedora/RHEL derivatives, the build requirements can be installed like so:</p>
<div class="highlight-console"><div class="highlight"><pre><span></span><span class="gp">$</span> sudo yum install gcc libffi-devel python-devel openssl-devel
</pre></div>
</div>
</div>
</div>
<div class="section" id="mac-os-x">
<h4>Mac OS X<a class="headerlink" href="#mac-os-x" title="Permalink to this headline"></a></h4>
<p>If you are on Mac OS, you may experience more limited functionality without installing a more capable version of OpenSSL.</p>
<p>You may refer to Cryptography’s documentation on <a class="reference external" href="https://cryptography.io/en/latest/installation/#building-cryptography-on-os-x">Building cryptography on OS X</a> for information on how to do so.</p>
</div>
</div>
<div class="section" id="id1">
<h3>Installation<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
<p>Once you have the prerequisites specified above, PGPy can be installed from PyPI using pip, like so:</p>
<div class="highlight-console"><div class="highlight"><pre><span></span><span class="gp">$</span> pip install PGPy
</pre></div>
</div>
</div>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="#">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">PGPy Documentation</a><ul>
<li><a class="reference internal" href="#installation">Installation</a><ul>
<li><a class="reference internal" href="#platform-specific-notes">Platform Specific Notes</a><ul>
<li><a class="reference internal" href="#windows">Windows</a></li>
<li><a class="reference internal" href="#linux">Linux</a><ul>
<li><a class="reference internal" href="#debian">Debian</a></li>
<li><a class="reference internal" href="#arch-linux">Arch Linux</a></li>
<li><a class="reference internal" href="#gentoo">Gentoo</a></li>
<li><a class="reference internal" href="#redhat-centos">RedHat/CentOS</a></li>
<li><a class="reference internal" href="#other-linux">Other Linux</a></li>
</ul>
</li>
<li><a class="reference internal" href="#mac-os-x">Mac OS X</a></li>
</ul>
</li>
<li><a class="reference internal" href="#id1">Installation</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="#">Documentation overview</a><ul>
      <li>Next: <a href="installation.html" title="next chapter">Installation</a></li>
  </ul></li>
</ul>
</div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/index.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2018, Michael Greene.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.7</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
      
      |
      <a href="_sources/index.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>