initial-html-documentation-20010606
[openafs.git] / doc / html / AdminReference / auarf196.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
2 <HTML><HEAD>
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
10 </HEAD><BODY>
11 <!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
12 <BODY bgcolor="ffffff"> 
13 <!-- End Header Records  ============================================ -->
14 <A NAME="Top_Of_Page"></A>
15 <H1>Administration Reference</H1>
16 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf195.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf197.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
17 <P>
18 <H2><A NAME="HDRKAS_STRINGTOKEY" HREF="auarf002.htm#ToC_210">kas stringtokey</A></H2>
19 <A NAME="IDX5161"></A>
20 <A NAME="IDX5162"></A>
21 <A NAME="IDX5163"></A>
22 <A NAME="IDX5164"></A>
23 <A NAME="IDX5165"></A>
24 <A NAME="IDX5166"></A>
25 <P><STRONG>Purpose</STRONG>
26 <P>Converts a character string into an octal key
27 <P><STRONG>Synopsis</STRONG>
28 <PRE><B>kas stringtokey -string</B> &lt;<VAR>password&nbsp;string</VAR>>  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-help</B>]
29       
30 <B>kas str -s</B> &lt;<VAR>password&nbsp;string</VAR>>  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-h</B>]
31 </PRE>
32 <P><STRONG>Description</STRONG>
33 <P>The <B>kas stringtokey</B> command converts the character string
34 specified with the <B>-string</B> argument into an octal string suitable
35 for use as an encryption key.
36 <P>The <B>kas</B> command interpreter generates the octal key by using an
37 encryption algorithm on the combination of the specified string and the name
38 of the local cell (as recorded in the local <B>/usr/vice/etc/ThisCell</B>
39 file). Use the <B>-cell</B> argument to convert a string into a key
40 appropriate for a cell other than the local one.
41 <P><STRONG>Cautions</STRONG>
42 <P>This command writes the key to the standard output stream, on which it can
43 possibly be intercepted by third parties. It is not very secure to use
44 the key in an actual Authentication Database entry.
45 <P><STRONG>Options</STRONG>
46 <DL>
47 <P><DT><B>-string
48 </B><DD>Specifies the character string to convert into an octal key.
49 <P><DT><B>-cell
50 </B><DD>Specifies the complete Internet domain name of the cell to combine with
51 the password string while generating the key. If this argument is
52 omitted, the <B>kas</B> command interpreter determines the name of the
53 local cell by consulting: 
54 <UL>
55 <P><LI>First, the value of the environment variable AFSCELL.
56 <P><LI>Second, the cellname in the <B>/usr/vice/etc/ThisCell</B> file on the
57 local machine.
58 </UL>
59 <P><DT><B>-help
60 </B><DD>Prints the online help for this command. All other valid options
61 are ignored.
62 </DL>
63 <P><STRONG>Output</STRONG>
64 <P>The output is of the following form:
65 <PRE>   Converting <VAR>password string</VAR> in realm '<VAR>cell_name</VAR>' yields key='<VAR>key</VAR>'.
66    
67 </PRE>
68 <P><STRONG>Examples</STRONG>
69 <P>The following example shows the octal key equivalent of the string
70 <B>new_pswd</B> in the ABC Corporation cell.
71 <PRE>   %<B> kas stringtokey new_pswd</B>
72    Converting new_pswd in realm 'ABC.COM' yields
73        key='\346\307\364\320\263\233\342\354'.
74    
75 </PRE>
76 <P><STRONG>Privilege Required</STRONG>
77 <P>None, and no password is required.
78 <P><STRONG>Related Information</STRONG>
79 <P><A HREF="auarf032.htm#HDRCLI_THISCELL">ThisCell (client version)</A>
80 <P><A HREF="auarf181.htm#HDRKAS_INTRO">kas</A>
81 <P>
82 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf195.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf197.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
83 <!-- Begin Footer Records  ========================================== -->
84 <P><HR><B> 
85 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
86 </B> 
87 <!-- End Footer Records  ============================================ -->
88 <A NAME="Bot_Of_Page"></A>
89 </BODY></HTML>