<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="function.sodium-crypto-core-ristretto255-scalar-random" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>sodium_crypto_core_ristretto255_scalar_random</refname>
  <refpurpose>Generates a random key</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>sodium_crypto_core_ristretto255_scalar_random</methodname>
   <void/>
  </methodsynopsis>
  <para>
   Generates a random key.
   Available as of libsodium 1.0.18.
  </para>

  &warn.undocumented.func;
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a 32-byte random &string;.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>sodium_crypto_core_ristretto255_scalar_random</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php

$foo = sodium_crypto_core_ristretto255_scalar_random();
$bar = sodium_crypto_core_ristretto255_scalar_random();

$value = sodium_crypto_core_ristretto255_scalar_add($foo, $bar);
$value = sodium_crypto_core_ristretto255_scalar_sub($value, $bar);

var_dump(hash_equals($foo, $value));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
bool(true) 
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>sodium_crypto_core_ristretto255_scalar_add</function></member>
    <member><function>sodium_crypto_core_ristretto255_scalar_sub</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- 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
-->
