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