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
|
<?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_get_key_identifier">
<refmeta>
<refentrytitle>xenc_get_key_identifier</refentrytitle>
<refmiscinfo>hash</refmiscinfo>
</refmeta>
<refnamediv>
<refname>xenc_get_key_identifier</refname>
<refpurpose>Determine a key identifier</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_xenc_get_key_identifier">
<funcprototype id="fproto_xenc_get_key_identifier">
<funcdef>varchar <function>xenc_get_key_identifier</function></funcdef>
<paramdef>in <parameter>key_name</parameter> varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_xenc_get_key_identifier">
<title>Description</title>
<para>The function returns key identifier.</para>
</refsect1>
<refsect1 id="params_xenc_get_key_identifier">
<title>Parameters</title>
<refsect2><title>key_name</title>
<para>Name of the key</para>
</refsect2>
</refsect1>
<refsect1 id="ret_xenc_get_key_identifier"><title>Return Types</title>
<para>The function returns a base64 encoded string containing the key identifier.
If key identifier is not available (the key has no identifier or key does not exist),
a NULL will be returned.
</para>
</refsect1>
<refsect1 id="examples_xenc_get_key_identifier">
<title>Examples</title>
<example id="ex_xenc_get_key_identifier"><title>Determine the key identifier</title>
<screen><![CDATA[
SQL> select xenc_get_key_identifier ('myKey');
callret
VARCHAR
_______________________________________________________________________________
LtVJHvVXJFFvzRnfrCaKmdxQaGQ=
]]>
</screen>
</example>
</refsect1>
<refsect1 id="seealso_xenc_get_key_identifier">
<title>See Also</title>
<para><link linkend="fn_xenc_get_key_algo"><function>xenc_get_key_algo()</function></link></para>
<para><link linkend="fn_get_certificate_info"><function>get_certificate_info()</function></link></para>
</refsect1>
</refentry>
|