<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
 -  
 -  This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
 -  project.
 -  
 -  Copyright (C) 1998-2020 OpenLink Software
 -  
 -  This project is free software; you can redistribute it and/or modify it
 -  under the terms of the GNU General Public License as published by the
 -  Free Software Foundation; only version 2 of the License, dated June 1991.
 -  
 -  This program is distributed in the hope that it will be useful, but
 -  WITHOUT ANY WARRANTY; without even the implied warranty of
 -  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 -  General Public License for more details.
 -  
 -  You should have received a copy of the GNU General Public License along
 -  with this program; if not, write to the Free Software Foundation, Inc.,
 -  51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 -  
 -  
-->
<refentry id="fn_xenc_key_AES_create">
  <refmeta>
    <refentrytitle>xenc_key_AES_create</refentrytitle>
    <refmiscinfo>hash</refmiscinfo>
  </refmeta>
  <refnamediv>
    <refname>xenc_key_AES_create</refname>
    <refpurpose>Used to make a symmetric key.</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <funcsynopsis id="fsyn_xenc_key_AES_create">
      <funcprototype id="fproto_xenc_key_AES_create">
        <funcdef><function>xenc_key_AES_create</function></funcdef>
	<paramdef>in <parameter>name</parameter> varchar</paramdef>
	<paramdef>in <parameter>bits</parameter> int</paramdef>
	<paramdef>in <parameter>secret</parameter> varchar</paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>
  <refsect1 id="desc_xenc_key_AES_create">
    <title>Description</title>
    <para>Used to make a symmetric session key for AES encryption algorithm.</para>
  </refsect1>
  <refsect1 id="params_xenc_key_AES_create">
    <title>Parameters</title>
    <refsect2><title>name</title>
      <para>The name of the key.</para>
    </refsect2>
    <refsect2><title>bits</title>
	<para>Number of bits in generated key. The values supported are 128, 192 and 256 bits.</para>
    </refsect2>
    <refsect2><title>secret</title>
      <para>The shared secret for key generation.</para>
    </refsect2>
  </refsect1>
  <refsect1 id="ret_xenc_key_AES_create"><title>Return Types</title>
    <para>None.</para>
  </refsect1>
  <refsect1 id="examples_xenc_key_AES_create">
    <title>Example</title>
    <example id="ex_xenc_key_AES_create"><title>Simple Use</title>
      <screen><![CDATA[
	  xenc_key_AES_create ('ses_key', 128, 'mysecret');]]>
</screen>
    </example>
  </refsect1>
  <refsect1 id="seealso_xenc_key_AES_create">
    <title>See Also</title>
    <para><link linkend="fn_xenc_key_3DES_create"><function>xenc_key_3DES_create()</function></link></para>
    <para><link linkend="fn_xenc_key_3DES_rand_create"><function>xenc_key_3des_rand_create()</function></link></para>
    <para><link linkend="fn_xenc_key_3DES_read"><function>xenc_key_3des_read()</function></link></para>
    <para><link linkend="fn_xenc_key_AES_rand_create"><function>xenc_key_aes_rand_create()</function></link></para>
    <para><link linkend="fn_xenc_key_DSA_read"><function>xenc_key_DSA_read()</function></link></para>
    <para><link linkend="fn_xenc_key_DSA_create"><function>xenc_key_dsa_create()</function></link></para>
    <para><link linkend="fn_xenc_key_RSA_read"><function>xenc_key_RSA_read()</function></link></para>
    <para><link linkend="fn_xenc_key_create_cert"><function>xenc_key_create_cert()</function></link></para>
    <para><link linkend="fn_xenc_key_serialize"><function>xenc_key_serialize()</function></link></para>
    <para><link linkend="fn_xenc_key_remove"><function>xenc_key_remove()</function></link></para>
  </refsect1>
</refentry>
