dd16465af6753b928a092e83d103b1f5913927c9
[openafs.git] / doc / man-pages / pod8 / kas_create.pod
1 =head1 NAME
2
3 kas create - Creates an entry in the Authentication Database
4
5 =head1 SYNOPSIS
6
7 B<kas create> B<-name> <I<name of user>>
8     [B<-initial_password> <I<initial password>>]
9     [B<-admin_username> <I<admin principal to use for authentication>>]
10     [B<-password_for_admin> <I<admin password>>] [B<-cell> <I<cell name>>]
11     [B<-servers> <I<explicit list of authentication servers>>+]
12     [B<-noauth>] [B<-help>]
13
14 B<kas c> B<-na> <I<name of user>> [B<-i> <I<initial password>>]
15     [B<-a> <I<admin principal to use for authentication>>]
16     [B<-p> <I<admin password>>] [B<-c> <I<cell name>>]
17     [B<-s> <I<explicit list of authentication servers>>+] [B<-no>] [B<-h>]
18
19 =head1 DESCRIPTION
20
21 The B<kas create> command creates an entry in the Authentication Database
22 for the user named by the B<-name> argument.
23
24 To avoid having the account's initial password echo visibly at the shell
25 prompt, omit the B<-initial_password> argument; the command interpreter
26 prompts for the password and does not echo it visibly.  Whether or not
27 B<-initial_password> is omitted, the Authentication Server converts the
28 password into a form suitable for use as an encryption key, and records it
29 in the entry's key field.
30
31 To alter settings in an Authentication Database entry, use the B<kas
32 setfields> command. To examine an entry, use the B<kas examine>
33 command. To list every entry in the database, use the B<kas list> command.
34
35 =head1 OPTIONS
36
37 =over 4
38
39 =item B<-name> <I<name of user>>
40
41 Names the new Authentication Database entry. Because it is the name under
42 which the user logs in, it must obey the restrictions that many operating
43 systems impose on user names (usually, to contain no more than eight
44 lowercase letters).
45
46 =item B<-initial_password> <I<initial password>>
47
48 Sets the user's password; provide a character string that can include
49 uppercase and lowercase letters, numerals and punctuation. The
50 Authentication Server scrambles the string into an octal string suitable
51 for use as an encryption key before placing it in the entry's key
52 field. If this argument is omitted, the command interpreter prompts for
53 the string and does not echo it visibly.
54
55 =item B<-admin_username> <I<admin principal>>
56
57 Specifies the user identity under which to authenticate with the
58 Authentication Server for execution of the command. For more details,
59 see L<kas(8)>.
60
61 =item B<-password_for_admin> <I<admin password>>
62
63 Specifies the password of the command's issuer. If it is omitted (as
64 recommended), the B<kas> command interpreter prompts for it and does not
65 echo it visibly. For more details, see L<kas(8)>.
66
67 =item B<-cell> <I<cell name>>
68
69 Names the cell in which to run the command. For more details, see
70 L<kas(8)>.
71
72 =item B<-servers> <I<authentication servers>>
73
74 Names each machine running an Authentication Server with which to
75 establish a connection. For more details, see L<kas(8)>.
76
77 =item B<-noauth>
78
79 Assigns the unprivileged identity C<anonymous> to the issuer. For more
80 details, see L<kas(8)>.
81
82 =item B<-help>
83
84 Prints the online help for this command. All other valid options are
85 ignored.
86
87 =back
88
89 =head1 EXAMPLES
90
91 The following example shows the prompts that appear when an administrator
92 logged in as C<admin> creates an Authentication Database entry for the
93 user C<smith>, and does not include either the B<-initial_password> or
94 B<-password_for_admin> arguments.
95
96    % kas create smith
97    Password for admin:
98    initial_password:
99    Verifying, please re-enter initial_password:
100
101 =head1 PRIVILEGE REQUIRED
102
103 The issuer must have the C<ADMIN> flag set on his or her Authentication
104 Database entry.
105
106 =head1 SEE ALSO
107
108 L<kas(8)>,
109 L<kas_examine(8)>,
110 L<kas_list(8)>,
111 L<kas_setfields(8)>
112
113 =head1 COPYRIGHT
114
115 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
116
117 This documentation is covered by the IBM Public License Version 1.0.  It was
118 converted from HTML to POD by software written by Chas Williams and Russ
119 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.