mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
73 lines
2 KiB
XML
73 lines
2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.sodium-crypto-kx-client-session-keys" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>sodium_crypto_kx_client_session_keys</refname>
|
|
<refpurpose>Calculate the client-side session keys.</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>sodium_crypto_kx_client_session_keys</methodname>
|
|
<methodparam><type>string</type><parameter>client_key_pair</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>server_key</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Calculate the client-side session keys, using the X25519 + BLAKE2b key-exchange method.
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>client_key_pair</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A crypto_kx keypair, such as one generated by <function>sodium_crypto_kx_keypair</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>server_key</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A crypto_kx public key.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
An array consisting of two strings. The first should be used for receiving data
|
|
from the server. The second should be used for sending data to the server.
|
|
</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
|
|
-->
|