man1-editing-pass-20051209
[openafs.git] / doc / man-pages / pod8 / kas_stringtokey.pod
1 =head1 NAME
2
3 kas stringtokey - Converts a character string into an octal key
4
5 =head1 SYNOPSIS
6
7 B<kas stringtokey -string> <I<password string>>  [B<-cell> <I<cell name>>]  [-help]
8
9 B<kas str -s> <I<password string>>  [B<-c> <I<cell name>>]  [-h]
10
11 =head1 DESCRIPTION
12
13 The kas stringtokey command converts the character string
14 specified with the B<-string> argument into an octal string suitable
15 for use as an encryption key.
16
17 The kas command interpreter generates the octal key by using an
18 encryption algorithm on the combination of the specified string and the name
19 of the local cell (as recorded in the local B</usr/vice/etc/ThisCell>
20 file). Use the B<-cell> argument to convert a string into a key
21 appropriate for a cell other than the local one.
22
23 =head1 CAUTIONS
24
25 This command writes the key to the standard output stream, on which it can
26 possibly be intercepted by third parties. It is not very secure to use
27 the key in an actual Authentication Database entry.
28
29 =head1 OPTIONS
30
31 =over 4
32
33 =item -string
34
35 Specifies the character string to convert into an octal key.
36
37 =item -cell
38
39 Specifies the complete Internet domain name of the cell to combine with
40 the password string while generating the key. If this argument is
41 omitted, the B<kas> command interpreter determines the name of the
42 local cell by consulting: 
43
44 =over 4
45
46 =item *
47
48 First, the value of the environment variable AFSCELL.
49
50
51 =item *
52
53 Second, the cellname in the /usr/vice/etc/ThisCell file on the
54 local machine.
55
56
57 =back
58
59 =item -help
60
61 Prints the online help for this command. All other valid options
62 are ignored.
63
64 =back
65
66 =head1 OUTPUT
67
68 The output is of the following form:
69
70    Converting I<password string> in realm 'I<cell_name>' yields key='I<key>'.
71
72 =head1 EXAMPLES
73
74 The following example shows the octal key equivalent of the string
75 B<new_pswd> in the ABC Corporation cell.
76
77    % kas stringtokey new_pswd
78    Converting new_pswd in realm 'ABC.COM' yields
79        key='\346\307\364\320\263\233\342\354'.
80
81 =head1 PRIVILEGE REQUIRED
82
83 None, and no password is required.
84
85 =head1 SEE ALSO
86
87 L<ThisCell (client version)(1)>
88
89 L<kas(1)>
90
91 =head1 COPYRIGHT
92
93 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
94
95 This documentation is covered by the IBM Public License Version 1.0.  It was
96 converted from HTML to POD by software written by Chas Williams and Russ
97 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.