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