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
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 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_3DES_read">
<refmeta>
<refentrytitle>xenc_key_3DES_read</refentrytitle>
<refmiscinfo>hash</refmiscinfo>
</refmeta>
<refnamediv>
<refname>xenc_key_3DES_read</refname>
<refpurpose>Importing a triple-des key into user's repository</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_xenc_key_3DES_read">
<funcprototype id="fproto_xenc_key_3DES_read">
<funcdef><function>xenc_key_3DES_read</function></funcdef>
<paramdef>in <parameter>name</parameter> varchar</paramdef>
<paramdef>in <parameter>key_data</parameter> varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_xenc_key_3DES_read">
<title>Description</title>
<para>
This function is used to import a triple-des serialized key
into user's repository and register it with a name supplied.
</para>
<para>
Note that key will not be persisted. It is loaded in the
memory only.
</para>
</refsect1>
<refsect1 id="params_xenc_key_3DES_read">
<title>Parameters</title>
<refsect2><title>name</title>
<para>Name of the key to register</para>
</refsect2>
<refsect2><title>key_data</title>
<para>The base64 encoded binary data with key material</para>
</refsect2>
</refsect1>
<refsect1 id="ret_xenc_key_3DES_read"><title>Return Types</title>
<para>No return value.</para>
</refsect1>
<refsect1 id="examples_xenc_key_3DES_read">
<title>Examples</title>
<example id="ex_xenc_key_3DES_read"><title>Loading a shared secret</title>
<screen><![CDATA[
xenc_key_3DES_read ('Sample Symmetric Key', 'EE/uaFF5N3ZNJWUTR8DYe+OEbwaKQnso');
]]>
</screen>
</example>
</refsect1>
<refsect1 id="seealso_xenc_key_3DES_read">
<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_AES_create"><function>xenc_key_aes_create</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>
|