/usr/share/doc/python-openssl-doc/html/api/rand.html is in python-openssl-doc 0.14-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 | <!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>rand — An interface to the OpenSSL pseudo random number generator — pyOpenSSL 0.14 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.14',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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="top" title="pyOpenSSL 0.14 documentation" href="../index.html" />
<link rel="up" title="OpenSSL — Python interface to OpenSSL" href="../api.html" />
<link rel="next" title="SSL — An interface to the SSL-specific parts of OpenSSL" href="ssl.html" />
<link rel="prev" title="crypto — Generic cryptographic module" href="crypto.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="ssl.html" title="SSL — An interface to the SSL-specific parts of OpenSSL"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="crypto.html" title="crypto — Generic cryptographic module"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">pyOpenSSL 0.14 documentation</a> »</li>
<li><a href="../api.html" accesskey="U"><tt class="docutils literal"><span class="pre">OpenSSL</span></tt> — Python interface to OpenSSL</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-OpenSSL.rand">
<span id="rand-an-interface-to-the-openssl-pseudo-random-number-generator"></span><span id="openssl-rand"></span><h1><tt class="xref py py-mod docutils literal"><span class="pre">rand</span></tt> — An interface to the OpenSSL pseudo random number generator<a class="headerlink" href="#module-OpenSSL.rand" title="Permalink to this headline">¶</a></h1>
<p>This module handles the OpenSSL pseudo random number generator (PRNG) and
declares the following:</p>
<dl class="function">
<dt id="OpenSSL.rand.add">
<tt class="descclassname">OpenSSL.rand.</tt><tt class="descname">add</tt><big>(</big><em>string</em>, <em>entropy</em><big>)</big><a class="headerlink" href="#OpenSSL.rand.add" title="Permalink to this definition">¶</a></dt>
<dd><p>Mix bytes from <em>string</em> into the PRNG state. The <em>entropy</em> argument is
(the lower bound of) an estimate of how much randomness is contained in
<em>string</em>, measured in bytes. For more information, see e.g. <span class="target" id="index-0"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc1750.html"><strong>RFC 1750</strong></a>.</p>
</dd></dl>
<dl class="function">
<dt id="OpenSSL.rand.bytes">
<tt class="descclassname">OpenSSL.rand.</tt><tt class="descname">bytes</tt><big>(</big><em>num_bytes</em><big>)</big><a class="headerlink" href="#OpenSSL.rand.bytes" title="Permalink to this definition">¶</a></dt>
<dd><p>Get some random bytes from the PRNG as a string.</p>
<p>This is a wrapper for the C function <tt class="xref py py-func docutils literal"><span class="pre">RAND_bytes()</span></tt>.</p>
</dd></dl>
<dl class="function">
<dt id="OpenSSL.rand.cleanup">
<tt class="descclassname">OpenSSL.rand.</tt><tt class="descname">cleanup</tt><big>(</big><big>)</big><a class="headerlink" href="#OpenSSL.rand.cleanup" title="Permalink to this definition">¶</a></dt>
<dd><p>Erase the memory used by the PRNG.</p>
<p>This is a wrapper for the C function <tt class="xref py py-func docutils literal"><span class="pre">RAND_cleanup()</span></tt>.</p>
</dd></dl>
<dl class="function">
<dt id="OpenSSL.rand.egd">
<tt class="descclassname">OpenSSL.rand.</tt><tt class="descname">egd</tt><big>(</big><em>path</em><span class="optional">[</span>, <em>bytes</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#OpenSSL.rand.egd" title="Permalink to this definition">¶</a></dt>
<dd><p>Query the <a class="reference external" href="http://www.lothar.com/tech/crypto/">Entropy Gathering Daemon</a> on
socket <em>path</em> for <em>bytes</em> bytes of random data and uses <a class="reference internal" href="#OpenSSL.rand.add" title="OpenSSL.rand.add"><tt class="xref py py-func docutils literal"><span class="pre">add()</span></tt></a> to
seed the PRNG. The default value of <em>bytes</em> is 255.</p>
</dd></dl>
<dl class="function">
<dt id="OpenSSL.rand.load_file">
<tt class="descclassname">OpenSSL.rand.</tt><tt class="descname">load_file</tt><big>(</big><em>path</em><span class="optional">[</span>, <em>bytes</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#OpenSSL.rand.load_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Read <em>bytes</em> bytes (or all of it, if <em>bytes</em> is negative) of data from the
file <em>path</em> to seed the PRNG. The default value of <em>bytes</em> is -1.</p>
</dd></dl>
<dl class="function">
<dt id="OpenSSL.rand.screen">
<tt class="descclassname">OpenSSL.rand.</tt><tt class="descname">screen</tt><big>(</big><big>)</big><a class="headerlink" href="#OpenSSL.rand.screen" title="Permalink to this definition">¶</a></dt>
<dd><p>Add the current contents of the screen to the PRNG state.</p>
<p>Availability: Windows.</p>
</dd></dl>
<dl class="function">
<dt id="OpenSSL.rand.seed">
<tt class="descclassname">OpenSSL.rand.</tt><tt class="descname">seed</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#OpenSSL.rand.seed" title="Permalink to this definition">¶</a></dt>
<dd><p>This is equivalent to calling <a class="reference internal" href="#OpenSSL.rand.add" title="OpenSSL.rand.add"><tt class="xref py py-func docutils literal"><span class="pre">add()</span></tt></a> with <em>entropy</em> as the length
of the string.</p>
</dd></dl>
<dl class="function">
<dt id="OpenSSL.rand.status">
<tt class="descclassname">OpenSSL.rand.</tt><tt class="descname">status</tt><big>(</big><big>)</big><a class="headerlink" href="#OpenSSL.rand.status" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns true if the PRNG has been seeded with enough data, and false otherwise.</p>
</dd></dl>
<dl class="function">
<dt id="OpenSSL.rand.write_file">
<tt class="descclassname">OpenSSL.rand.</tt><tt class="descname">write_file</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#OpenSSL.rand.write_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Write a number of random bytes (currently 1024) to the file <em>path</em>. This
file can then be used with <a class="reference internal" href="#OpenSSL.rand.load_file" title="OpenSSL.rand.load_file"><tt class="xref py py-func docutils literal"><span class="pre">load_file()</span></tt></a> to seed the PRNG again.</p>
</dd></dl>
<dl class="exception">
<dt id="OpenSSL.rand.Error">
<em class="property">exception </em><tt class="descclassname">OpenSSL.rand.</tt><tt class="descname">Error</tt><a class="headerlink" href="#OpenSSL.rand.Error" title="Permalink to this definition">¶</a></dt>
<dd><p>If the current RAND method supports any errors, this is raised when needed.
The default method does not raise this when the entropy pool is depleted.</p>
<p>Whenever this exception is raised directly, it has a list of error messages
from the OpenSSL error queue, where each item is a tuple <em>(lib, function,
reason)</em>. Here <em>lib</em>, <em>function</em> and <em>reason</em> are all strings, describing
where and what the problem is. See <em class="manpage">err(3)</em> for more information.</p>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="crypto.html"
title="previous chapter"><tt class="docutils literal"><span class="pre">crypto</span></tt> — Generic cryptographic module</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="ssl.html"
title="next chapter"><tt class="docutils literal"><span class="pre">SSL</span></tt> — An interface to the SSL-specific parts of OpenSSL</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/rand.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="ssl.html" title="SSL — An interface to the SSL-specific parts of OpenSSL"
>next</a> |</li>
<li class="right" >
<a href="crypto.html" title="crypto — Generic cryptographic module"
>previous</a> |</li>
<li><a href="../index.html">pyOpenSSL 0.14 documentation</a> »</li>
<li><a href="../api.html" ><tt class="docutils literal"><span class="pre">OpenSSL</span></tt> — Python interface to OpenSSL</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2011, Jean-Paul Calderone.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>
|