Mercurial > repos > rliterman > csp2

comparison CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/man/man1/kinit.1 @ 68:5028fdace37b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 16:23:26 -0400
parents
children
comparison
equal deleted inserted replaced
67:0e9998148a16 68:5028fdace37b
1 .\" Man page generated from reStructuredText.
2 .
3 .TH "KINIT" "1" " " "1.20.1" "MIT Kerberos"
4 .SH NAME
5 kinit \- obtain and cache Kerberos ticket-granting ticket
6 .
7 .nr rst2man-indent-level 0
8 .
9 .de1 rstReportMargin
10 \\$1 \\n[an-margin]
11 level \\n[rst2man-indent-level]
12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
13 -
14 \\n[rst2man-indent0]
15 \\n[rst2man-indent1]
16 \\n[rst2man-indent2]
17 ..
18 .de1 INDENT
19 .\" .rstReportMargin pre:
20 . RS \\$1
21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
22 . nr rst2man-indent-level +1
23 .\" .rstReportMargin post:
24 ..
25 .de UNINDENT
26 . RE
27 .\" indent \\n[an-margin]
28 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .nr rst2man-indent-level -1
30 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
31 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
32 ..
33 .SH SYNOPSIS
34 .sp
35 \fBkinit\fP
36 [\fB\-V\fP]
37 [\fB\-l\fP \fIlifetime\fP]
38 [\fB\-s\fP \fIstart_time\fP]
39 [\fB\-r\fP \fIrenewable_life\fP]
40 [\fB\-p\fP | \-\fBP\fP]
41 [\fB\-f\fP | \-\fBF\fP]
42 [\fB\-a\fP]
43 [\fB\-A\fP]
44 [\fB\-C\fP]
45 [\fB\-E\fP]
46 [\fB\-v\fP]
47 [\fB\-R\fP]
48 [\fB\-k\fP [\fB\-i\fP | \-\fBt\fP \fIkeytab_file\fP]]
49 [\fB\-c\fP \fIcache_name\fP]
50 [\fB\-n\fP]
51 [\fB\-S\fP \fIservice_name\fP]
52 [\fB\-I\fP \fIinput_ccache\fP]
53 [\fB\-T\fP \fIarmor_ccache\fP]
54 [\fB\-X\fP \fIattribute\fP[=\fIvalue\fP]]
55 [\fB\-\-request\-pac\fP | \fB\-\-no\-request\-pac\fP]
56 [\fIprincipal\fP]
57 .SH DESCRIPTION
58 .sp
59 kinit obtains and caches an initial ticket\-granting ticket for
60 \fIprincipal\fP\&. If \fIprincipal\fP is absent, kinit chooses an appropriate
61 principal name based on existing credential cache contents or the
62 local username of the user invoking kinit. Some options modify the
63 choice of principal name.
64 .SH OPTIONS
65 .INDENT 0.0
66 .TP
67 \fB\-V\fP
68 display verbose output.
69 .TP
70 \fB\-l\fP \fIlifetime\fP
71 (duration string.) Requests a ticket with the lifetime
72 \fIlifetime\fP\&.
73 .sp
74 For example, \fBkinit \-l 5:30\fP or \fBkinit \-l 5h30m\fP\&.
75 .sp
76 If the \fB\-l\fP option is not specified, the default ticket lifetime
77 (configured by each site) is used. Specifying a ticket lifetime
78 longer than the maximum ticket lifetime (configured by each site)
79 will not override the configured maximum ticket lifetime.
80 .TP
81 \fB\-s\fP \fIstart_time\fP
82 (duration string.) Requests a postdated ticket. Postdated
83 tickets are issued with the \fBinvalid\fP flag set, and need to be
84 resubmitted to the KDC for validation before use.
85 .sp
86 \fIstart_time\fP specifies the duration of the delay before the ticket
87 can become valid.
88 .TP
89 \fB\-r\fP \fIrenewable_life\fP
90 (duration string.) Requests renewable tickets, with a total
91 lifetime of \fIrenewable_life\fP\&.
92 .TP
93 \fB\-f\fP
94 requests forwardable tickets.
95 .TP
96 \fB\-F\fP
97 requests non\-forwardable tickets.
98 .TP
99 \fB\-p\fP
100 requests proxiable tickets.
101 .TP
102 \fB\-P\fP
103 requests non\-proxiable tickets.
104 .TP
105 \fB\-a\fP
106 requests tickets restricted to the host\(aqs local address[es].
107 .TP
108 \fB\-A\fP
109 requests tickets not restricted by address.
110 .TP
111 \fB\-C\fP
112 requests canonicalization of the principal name, and allows the
113 KDC to reply with a different client principal from the one
114 requested.
115 .TP
116 \fB\-E\fP
117 treats the principal name as an enterprise name.
118 .TP
119 \fB\-v\fP
120 requests that the ticket\-granting ticket in the cache (with the
121 \fBinvalid\fP flag set) be passed to the KDC for validation. If the
122 ticket is within its requested time range, the cache is replaced
123 with the validated ticket.
124 .TP
125 \fB\-R\fP
126 requests renewal of the ticket\-granting ticket. Note that an
127 expired ticket cannot be renewed, even if the ticket is still
128 within its renewable life.
129 .sp
130 Note that renewable tickets that have expired as reported by
131 klist(1) may sometimes be renewed using this option,
132 because the KDC applies a grace period to account for client\-KDC
133 clock skew. See krb5.conf(5) \fBclockskew\fP setting.
134 .TP
135 \fB\-k\fP [\fB\-i\fP | \fB\-t\fP \fIkeytab_file\fP]
136 requests a ticket, obtained from a key in the local host\(aqs keytab.
137 The location of the keytab may be specified with the \fB\-t\fP
138 \fIkeytab_file\fP option, or with the \fB\-i\fP option to specify the use
139 of the default client keytab; otherwise the default keytab will be
140 used. By default, a host ticket for the local host is requested,
141 but any principal may be specified. On a KDC, the special keytab
142 location \fBKDB:\fP can be used to indicate that kinit should open
143 the KDC database and look up the key directly. This permits an
144 administrator to obtain tickets as any principal that supports
145 authentication based on the key.
146 .TP
147 \fB\-n\fP
148 Requests anonymous processing. Two types of anonymous principals
149 are supported.
150 .sp
151 For fully anonymous Kerberos, configure pkinit on the KDC and
152 configure \fBpkinit_anchors\fP in the client\(aqs krb5.conf(5)\&.
153 Then use the \fB\-n\fP option with a principal of the form \fB@REALM\fP
154 (an empty principal name followed by the at\-sign and a realm
155 name). If permitted by the KDC, an anonymous ticket will be
156 returned.
157 .sp
158 A second form of anonymous tickets is supported; these
159 realm\-exposed tickets hide the identity of the client but not the
160 client\(aqs realm. For this mode, use \fBkinit \-n\fP with a normal
161 principal name. If supported by the KDC, the principal (but not
162 realm) will be replaced by the anonymous principal.
163 .sp
164 As of release 1.8, the MIT Kerberos KDC only supports fully
165 anonymous operation.
166 .UNINDENT
167 .sp
168 \fB\-I\fP \fIinput_ccache\fP
169 .INDENT 0.0
170 .INDENT 3.5
171 Specifies the name of a credentials cache that already contains a
172 ticket. When obtaining that ticket, if information about how that
173 ticket was obtained was also stored to the cache, that information
174 will be used to affect how new credentials are obtained, including
175 preselecting the same methods of authenticating to the KDC.
176 .UNINDENT
177 .UNINDENT
178 .INDENT 0.0
179 .TP
180 \fB\-T\fP \fIarmor_ccache\fP
181 Specifies the name of a credentials cache that already contains a
182 ticket. If supported by the KDC, this cache will be used to armor
183 the request, preventing offline dictionary attacks and allowing
184 the use of additional preauthentication mechanisms. Armoring also
185 makes sure that the response from the KDC is not modified in
186 transit.
187 .TP
188 \fB\-c\fP \fIcache_name\fP
189 use \fIcache_name\fP as the Kerberos 5 credentials (ticket) cache
190 location. If this option is not used, the default cache location
191 is used.
192 .sp
193 The default cache location may vary between systems. If the
194 \fBKRB5CCNAME\fP environment variable is set, its value is used to
195 locate the default cache. If a principal name is specified and
196 the type of the default cache supports a collection (such as the
197 DIR type), an existing cache containing credentials for the
198 principal is selected or a new one is created and becomes the new
199 primary cache. Otherwise, any existing contents of the default
200 cache are destroyed by kinit.
201 .TP
202 \fB\-S\fP \fIservice_name\fP
203 specify an alternate service name to use when getting initial
204 tickets.
205 .TP
206 \fB\-X\fP \fIattribute\fP[=\fIvalue\fP]
207 specify a pre\-authentication \fIattribute\fP and \fIvalue\fP to be
208 interpreted by pre\-authentication modules. The acceptable
209 attribute and value values vary from module to module. This
210 option may be specified multiple times to specify multiple
211 attributes. If no value is specified, it is assumed to be "yes".
212 .sp
213 The following attributes are recognized by the PKINIT
214 pre\-authentication mechanism:
215 .INDENT 7.0
216 .TP
217 \fBX509_user_identity\fP=\fIvalue\fP
218 specify where to find user\(aqs X509 identity information
219 .TP
220 \fBX509_anchors\fP=\fIvalue\fP
221 specify where to find trusted X509 anchor information
222 .TP
223 \fBflag_RSA_PROTOCOL\fP[\fB=yes\fP]
224 specify use of RSA, rather than the default Diffie\-Hellman
225 protocol
226 .TP
227 \fBdisable_freshness\fP[\fB=yes\fP]
228 disable sending freshness tokens (for testing purposes only)
229 .UNINDENT
230 .TP
231 \fB\-\-request\-pac\fP | \fB\-\-no\-request\-pac\fP
232 mutually exclusive. If \fB\-\-request\-pac\fP is set, ask the KDC to
233 include a PAC in authdata; if \fB\-\-no\-request\-pac\fP is set, ask the
234 KDC not to include a PAC; if neither are set, the KDC will follow
235 its default, which is typically is to include a PAC if doing so is
236 supported.
237 .UNINDENT
238 .SH ENVIRONMENT
239 .sp
240 See kerberos(7) for a description of Kerberos environment
241 variables.
242 .SH FILES
243 .INDENT 0.0
244 .TP
245 .B \fBFILE:/tmp/krb5cc_%{uid}\fP
246 default location of Kerberos 5 credentials cache
247 .TP
248 .B \fBFILE:/etc/krb5.keytab\fP
249 default location for the local host\(aqs keytab.
250 .UNINDENT
251 .SH SEE ALSO
252 .sp
253 klist(1), kdestroy(1), kerberos(7)
254 .SH AUTHOR
255 MIT
256 .SH COPYRIGHT
257 1985-2022, MIT
258 .\" Generated by docutils manpage writer.
259 .