random.engine.secure.xml

<?xml version="1.0" encoding="utf-8"?>
<reference xml:id="class.random-engine-secure" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
 <title>The Random\Engine\Secure class</title>
 <titleabbrev>Random\Engine\Secure</titleabbrev>

 <partintro>

<!-- {{{ Random\Engine\Secure intro -->
  <section xml:id="random-engine-secure.intro">
   &reftitle.intro;
   <para>
    Generates cryptographically secure randomness using the operating system&rsquo;s <acronym>CSPRNG</acronym>.
   </para>
   <para>
    The randomness generated by this <classname>Random\Engine</classname> is suitable
    for all applications, including the generation of long-term secrets, such as
    encryption keys.
   </para>
   <para>
    The <classname>Random\Engine\Secure</classname> engine is the recommended safe default choice,
    unless the application requires either reproducible sequences or very high performance.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="random-engine-secure.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis class="class">
    <ooclass>
     <modifier>final</modifier>
     <classname>Random\Engine\Secure</classname>
    </ooclass>

    <oointerface>
     <modifier>implements</modifier>
     <interfacename>Random\CryptoSafeEngine</interfacename>
    </oointerface>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.random-engine-secure')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='Random\\Engine\\Secure'])">
     <xi:fallback/>
    </xi:include>
   </classsynopsis>
<!-- }}} -->

  </section>

 </partintro>

 &reference.random.random.engine.entities.secure;

</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->