doc/xml/AdminReference/sect8/kas_stringtokey.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="kas_stringtokey8">
   3   <refmeta>
   4     <refentrytitle>kas stringtokey</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>kas stringtokey</refname>
   9     <refpurpose>Converts a character string into an octal key</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">kas stringtokey</emphasis> <emphasis role="bold">-string</emphasis> &lt;<emphasis>password string</emphasis>&gt;
  14         [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-help</emphasis>]</para>
  15
  16     <para><emphasis role="bold">kas str</emphasis> <emphasis role="bold">-s</emphasis> &lt;<emphasis>password string</emphasis>&gt; [<emphasis role="bold">-c</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-h</emphasis>]</para>
  17
  18   </refsect1>
  19   <refsect1>
  20     <title>Description</title>
  21     <para>The <emphasis role="bold">kas stringtokey</emphasis> command converts the character string specified
  22     with the <emphasis role="bold">-string</emphasis> argument into an octal string suitable for use as an
  23     encryption key.</para>
  24
  25     <para>The <emphasis role="bold">kas</emphasis> command interpreter generates the octal key by using an
  26     encryption algorithm on the combination of the specified string and the
  27     name of the local cell (as recorded in the local <replaceable>/usr/vice/etc/ThisCell</replaceable>
  28     file). Use the <emphasis role="bold">-cell</emphasis> argument to convert a string into a key
  29     appropriate for a cell other than the local one.</para>
  30
  31   </refsect1>
  32   <refsect1>
  33     <title>Cautions</title>
  34     <para>This command writes the key to the standard output stream, on which it can
  35     possibly be intercepted by third parties. It is not very secure to use the
  36     key in an actual Authentication Database entry.</para>
  37
  38   </refsect1>
  39   <refsect1>
  40     <title>Options</title>
  41     <variablelist>
  42       <varlistentry>
  43         <term><emphasis role="bold">-string</emphasis> &lt;<emphasis>password string</emphasis>&gt;</term>
  44         <listitem>
  45           <para>Specifies the character string to convert into an octal key.</para>
  46
  47         </listitem>
  48       </varlistentry>
  49       <varlistentry>
  50         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
  51         <listitem>
  52           <para>Specifies the complete Internet domain name of the cell to combine with
  53           the password string while generating the key. If this argument is omitted,
  54           the <emphasis role="bold">kas</emphasis> command interpreter determines the name of the local cell by
  55           consulting:</para>
  56
  57           <itemizedlist>
  58             <listitem>
  59               <para>First, the value of the environment variable AFSCELL.</para>
  60
  61             </listitem>
  62             <listitem>
  63               <para>Second, the cellname in the <replaceable>/usr/vice/etc/ThisCell</replaceable> file on the local
  64               machine.</para>
  65
  66             </listitem>
  67           </itemizedlist>
  68         </listitem>
  69       </varlistentry>
  70       <varlistentry>
  71         <term><emphasis role="bold">-help</emphasis></term>
  72         <listitem>
  73           <para>Prints the online help for this command. All other valid options are
  74           ignored.</para>
  75
  76         </listitem>
  77       </varlistentry>
  78     </variablelist>
  79   </refsect1>
  80   <refsect1>
  81     <title>Output</title>
  82     <para>The output is of the following form:</para>
  83
  84 <programlisting>
  85    Converting I&amp;lt;password string&amp;gt; in realm 'I&amp;lt;cell_name&amp;gt;' yields key='I&amp;lt;key&amp;gt;'.
  86
  87 </programlisting>
  88     </refsect1>
  89     <refsect1>
  90       <title>Examples</title>
  91       <para>The following example shows the octal key equivalent of the string
  92       <computeroutput>new_pswd</computeroutput> in the ABC Corporation cell.</para>
  93
  94 <programlisting>
  95    % kas stringtokey new_pswd
  96    Converting new_pswd in realm 'ABC.COM' yields
  97        key='\346\307\364\320\263\233\342\354'.
  98
  99 </programlisting>
 100       </refsect1>
 101       <refsect1>
 102         <title>Privilege Required</title>
 103         <para>None, and no password is required.</para>
 104
 105       </refsect1>
 106       <refsect1>
 107         <title>See Also</title>
 108         <para><link linkend="ThisCell5">ThisCell(5)</link>,
 109         <link linkend="kas8">kas(8)</link></para>
 110
 111       </refsect1>
 112       <refsect1>
 113         <title>Copyright</title>
 114         <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 115
 116         <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 117         converted from HTML to POD by software written by Chas Williams and Russ
 118         Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 119
 120       </refsect1>
 121     </refentry>