1 \input texinfo-suppl.tex % contains @doubleleftarrow{} definition
2 % this line must come *before* \input texinfo
3 \input texinfo @c -*-texinfo-*-
6 @setfilename krb5-admin.info
7 @settitle Kerberos V5 System Administrator's Guide
8 @setchapternewpage odd @c chapter begins on next odd page
9 @c @setchapternewpage on @c chapter begins on next page
10 @c @smallbook @c Format for 7" X 9.25" paper
19 * krb5-admin: (krb5-admin). Kerberos V5 Administrator's Guide
22 @include definitions.texinfo
24 @set UPDATED June 14, 2007
26 @finalout @c don't print black warning boxes
29 @title @value{PRODUCT} System Administrator's Guide
30 @subtitle Release: @value{RELEASE}
31 @subtitle Document Edition: @value{EDITION}
32 @subtitle Last updated: @value{UPDATED}
33 @author @value{COMPANY}
36 @vskip 0pt plus 1filll
40 @comment node-name, next, previous, up
41 @node Top, Copyright, (dir), (dir)
44 This document describes how to administrate a @value{PRODUCT}
48 @c The master menu is updated using emacs19's M-x texinfo-all-menus-update
49 @c function. Don't forget to run M-x texinfo-every-node-update after
50 @c you add a new section or subsection, or after you've rearranged the
51 @c order of sections or subsections. Also, don't forget to add an @node
52 @c comand before each @section or @subsection! All you need to enter
55 @c @node New Section Name
56 @c @section New Section Name
58 @c M-x texinfo-every-node-update will take care of calculating the
59 @c node's forward and back pointers.
61 @c ---------------------------------------------------------------------
66 * How Kerberos Works::
67 * Configuration Files::
69 * Administrating the Kerberos Database::
70 * Configuring Kerberos with OpenLDAP back-end::
71 * Application Servers::
72 * Backups of Secure Hosts::
77 @node Copyright, Introduction, Top, Top
79 @include copyright.texinfo
82 @node Introduction, How Kerberos Works, Copyright, Top
86 * Why Should I use Kerberos?::
87 * Documentation for Kerberos V5::
88 * Overview of This Guide::
91 @node Why Should I use Kerberos?, Documentation for Kerberos V5, Introduction, Introduction
92 @section Why Should I use Kerberos?
94 Since Kerberos negotiates authenticated, and optionally encrypted,
95 communications between two points anywhere on the internet, it provides
96 a layer of security that is not dependent on which side of a firewall
97 either client is on. Since studies have shown that half of the computer
98 security breaches in industry happen from @i{inside} firewalls,
99 @value{PRODUCT} from @value{COMPANY} will play a vital role in the
100 security of your network.
102 @node Documentation for Kerberos V5, Overview of This Guide, Why Should I use Kerberos?, Introduction
103 @section Documentation for @value{PRODUCT}
105 @include document-list.texinfo
107 @node Overview of This Guide, , Documentation for Kerberos V5, Introduction
108 @section Overview of This Guide
110 The next chapter describes how Kerberos works.
112 Chapter three describes administration of the principals in the Kerberos
115 Chapter four describes how you can use DNS in configuring your Kerberos realm.
117 Chapter five describes administrative programs for manipulating the
118 Kerberos database as a whole.
120 Chapter six describes OpenLDAP Configuration steps.
122 Chapter seven describes issues to consider when adding an application
123 server to the database.
125 Chapter eight describes our problem reporting system.
127 The appendices include the list of Kerberos error messages, and a
128 complete list of the time zones understood by @code{kadmin}.
130 @node How Kerberos Works, Configuration Files, Introduction, Top
131 @chapter How Kerberos Works
133 This section provides a simplified description of a general user's
134 interaction with the Kerberos system. This interaction happens
135 transparently---users don't need to know and probably don't care about
136 what's going on---but Kerberos administrators might find a schematic
137 description of the process useful. This description glosses over a lot
138 of details; for more information, see @i{Kerberos: An Authentication
139 Service for Open Network Systems}, a paper presented at Winter USENIX
140 1988, in Dallas, Texas. This paper can be retreived by FTP from
141 @code{athena-dist.mit.edu}, in the location:
142 @code{/pub/ATHENA/kerberos/doc/usenix.PS}.
145 * Network Services and Their Client Programs::
147 * The Kerberos Database::
149 * The Ticket-Granting Ticket::
150 * Network Services and the Master Database::
151 * The User/Kerberos Interaction::
155 @node Network Services and Their Client Programs, Kerberos Tickets, How Kerberos Works, How Kerberos Works
156 @section Network Services and Their Client Programs
158 In an environment that provides network services, you use @dfn{client}
159 programs to request @dfn{services} from @dfn{server} programs that are
160 somewhere on the network. Suppose you have logged in to a workstation
161 and you want to @samp{rlogin} to a typical UNIX host. You use the local
162 @samp{rlogin} client program to contact the remote machine's
163 @samp{rlogind} daemon.
165 @node Kerberos Tickets, The Kerberos Database, Network Services and Their Client Programs, How Kerberos Works
166 @section Kerberos Tickets
168 Under Kerberos, the @samp{klogind} daemon allows you to login to a
169 remote machine if you can provide @samp{klogind} a Kerberos ticket
170 which proves your identity. In addition to the ticket, you must also
171 have possession of the corresponding ticket session key. The
172 combination of a ticket and the ticket's session key is known as a credential.
174 Typically, a client program automatically obtains credentials
175 identifying the person using the client program. The credentials are
176 obtained from a Kerberos server that resides somewhere on the network.
177 A Kerberos server maintains a database of user, server, and password
180 @node The Kerberos Database, Kerberos Realms, Kerberos Tickets, How Kerberos Works
181 @section The Kerberos Database
183 Kerberos will give you credentials only if you have an entry in the
184 Kerberos server's @dfn{Kerberos database}. Your database entry includes
185 your Kerberos @dfn{principal} (an identifying string, which is often
186 just your username), and your Kerberos password. Every Kerberos user
187 must have an entry in this database.
189 @node Kerberos Realms, The Ticket-Granting Ticket, The Kerberos Database, How Kerberos Works
190 @section Kerberos Realms
192 Each administrative domain will have its own Kerberos database, which
193 contains information about the users and services for that particular
194 site or administrative domain. This administrative domain is the
195 @dfn{Kerberos realm}.
197 Each Kerberos realm will have at least one Kerberos server, where the
198 master Kerberos database for that site or administrative domain is
199 stored. A Kerberos realm may also have one or more @dfn{slave servers},
200 which have read-only copies of the Kerberos database that are
201 periodically propagated from the master server. For more details on how
202 this is done, see the ``Set Up the Slave KDCs for Database Propagation''
203 and ``Propagate the Database to Each Slave KDC'' sections of the
204 @value{PRODUCT} Installation Guide.
206 @node The Ticket-Granting Ticket, Network Services and the Master Database, Kerberos Realms, How Kerberos Works
207 @section The Ticket-Granting Ticket
209 The @samp{kinit} command prompts for your password. If you enter it
210 successfully, you will obtain a @dfn{ticket-granting ticket} and a
211 @dfn{ticket session key} which gives you the right to use the ticket.
212 This combination of the ticket and its associated key is known as your
213 @dfn{credentials}. As illustrated below, client programs use your
214 ticket-granting ticket credentials in order to obtain client-specific
215 credentials as needed.
217 Your credentials are stored in a @dfn{credentials cache}, which is often
218 just a file in @code{/tmp}. The credentials cache is also called the
219 @dfn{ticket file}, especially in Kerberos V4 documentation. Note,
220 however, that a credentials cache does not have to be stored in a file.
222 @node Network Services and the Master Database, The User/Kerberos Interaction, The Ticket-Granting Ticket, How Kerberos Works
223 @section Network Services and the Master Database
225 The master database also contains entries for all network services that
226 require Kerberos authentication. Suppose that your site has a machine,
227 @samp{laughter.@value{PRIMARYDOMAIN}}, that requires Kerberos
228 authentication from anyone who wants to @samp{rlogin} to it. The host's
229 Kerberos realm is @samp{@value{PRIMARYREALM}}.
231 This service must be registered in the Kerberos database, using the
232 proper service name, which in this case is the @dfn{principal}:
235 host/laughter.@value{PRIMARYDOMAIN}@@@value{PRIMARYREALM}
239 The @samp{/} character separates the Kerberos @dfn{primary} (in this
240 case, @samp{host}) from the @dfn{instance} (in this case,
241 @samp{laughter.@value{PRIMARYDOMAIN}}); the @samp{@@} character separates
242 the realm name (in this case, @samp{@value{PRIMARYREALM}}) from the rest
243 of the principal. The primary, @samp{host}, denotes the name or type of
244 the service that is being offered: generic host-level access to the
245 machine. The instance, @samp{laughter.@value{PRIMARYDOMAIN}}, names the
246 specific machine that is offering this service. There will generally be
247 many different machines, each offering one particular type of service,
248 and the instance serves to give each one of these servers a different
255 @node The Keytab File, , Network Services and the Master Database, Network Services and the Master Database
256 @subsection The Keytab File
258 For each service, there must also be a @dfn{service key} known only by
259 Kerberos and the service. On the Kerberos server, the service key is
260 stored in the Kerberos database.
262 On the server host, these service keys are stored in @dfn{key tables},
263 which are files known as @dfn{keytabs}.@footnote{Keytabs were called
264 @dfn{srvtabs} in Kerberos V4.} For example, the service keys used by
265 services that run as root are usually stored in the keytab file
266 @code{/etc/krb5.keytab}. @b{N.B.:} This service key is the equivalent
267 of the service's password, and must be kept secure. Data which is meant
268 to be read only by the service is encrypted using this key.
270 @node The User/Kerberos Interaction, Definitions, Network Services and the Master Database, How Kerberos Works
271 @section The User/Kerberos Interaction
273 Suppose that you walk up to a host intending to login to it, and then
274 @samp{rlogin} to the machine @samp{laughter}. Here's what happens:
278 You login to the workstation and use the @samp{kinit} command to get a
279 ticket-granting ticket. This command prompts you for your Kerberos
280 password. (On systems running the @value{PRODUCT} @samp{login} program,
281 this may be done as part of the login process, not requiring the user to
282 run a separate program.)
286 The @samp{kinit} command sends your request to the Kerberos master
287 server machine. The server software looks for your principal name's
288 entry in the Kerberos database.
291 If this entry exists, the Kerberos server creates and returns a
292 ticket-granting ticket and the key which allows you to use it, encrypted
293 by your password. If @samp{kinit} can decrypt the Kerberos reply using
294 the password you provide, it stores this ticket in a credentials cache
295 on your local machine for later use. The name of the credentials cache
296 can be specified in the @samp{KRB5CCNAME} environment variable. If this
297 variable is not set, the name of the file will be
298 @file{/tmp/krb5cc_<uid>}, where <uid> is your UNIX user-id, represented
304 Now you use the @samp{rlogin} client to access the machine
308 host% @b{rlogin laughter}
313 The @samp{rlogin} client checks your ticket file to see if you have a
314 ticket for the @samp{host} service for @samp{laughter}. You don't, so
315 @samp{rlogin} uses the credential cache's ticket-granting ticket to make
316 a request to the master server's ticket-granting service.
319 This ticket-granting service receives the request for a ticket for
320 @samp{host/laughter.@value{PRIMARYDOMAIN}}, and looks in the master
321 database for an entry for @samp{host/laughter.@value{PRIMARYDOMAIN}}.
322 If the entry exists, the ticket-granting service issues you a ticket for
323 that service. That ticket is also cached in your credentials cache.
326 The @samp{rlogin} client now sends that ticket to the @samp{laughter}
327 @samp{klogind} service program. The service program checks the ticket
328 by using its own service key. If the ticket is valid, it now knows your
329 identity. If you are allowed to login to @samp{laughter} (because your
330 username matches one in /etc/passwd, or your Kerberos principal is in
331 the appropriate @file{.k5login} file), @code{klogind} will let you
336 @node Definitions, , The User/Kerberos Interaction, How Kerberos Works
339 Following are definitions of some of the Kerberos terminology.
341 @include glossary.texinfo
343 @node Configuration Files, Using DNS, How Kerberos Works, Top
344 @chapter Configuration Files
347 * Supported Encryption Types::
353 @node Supported Encryption Types, Salts, Configuration Files, Configuration Files
354 @section Supported Encryption Types
356 Any tag in the configuration files which requires a list of encryption
357 types can be set to some combination of the following strings.
358 Encryption types marked as ``weak'' are available for compatibility
359 but not recommended for use.
361 @include support-enc.texinfo
363 The string DEFAULT can be used to refer to the default set of types for
364 the variable in question. Types or families can be removed from the
365 current list by prefixing them with a minus sign (``-''). Types or
366 families can be prefixed with a plus sign (``+'') for symmetry; it has
367 the same meaning as just listing the type or family. For example,
368 ``DEFAULT -des'' would be the default set of encryption types with DES
369 types removed, and ``des3 DEFAULT'' would be the default set of
370 encryption types with triple DES types moved to the front.
372 While aes128-cts and aes256-cts are supported for all Kerberos
373 operations, they are not supported by older versions of our GSSAPI
374 implementation (krb5-1.3.1 and earlier).
376 By default, AES is enabled in this release. Sites wishing to use AES
377 encryption types on their KDCs need to be careful not to give GSSAPI
378 services AES keys if the servers have not been updated. If older
379 GSSAPI services are given AES keys, then services may fail when
380 clients supporting AES for GSSAPI are used. Sites may wish to use AES
381 for user keys and for the ticket granting ticket key, although doing
382 so requires specifying what encryption types are used as each
383 principal is created.
385 If all GSSAPI-based services have been updated before or with the KDC,
386 this is not an issue.
388 @node Salts, krb5.conf, Supported Encryption Types, Configuration Files
391 Your Kerberos key is derived from your password. To ensure that people
392 who happen to pick the same password do not have the same key, Kerberos
393 5 incorporates more information into the key using something called a
394 salt. The supported values for salts are as follows.
396 @include salts.texinfo
398 @node krb5.conf, kdc.conf, Salts, Configuration Files
401 @include krb5conf.texinfo
407 * realms (krb5.conf)::
413 * pkinit client options::
414 * Sample krb5.conf File::
417 @node libdefaults, appdefaults, krb5.conf, krb5.conf
418 @subsection [libdefaults]
420 The @code{libdefaults} section may contain any of the following
424 @itemx default_keytab_name
425 This relation specifies the default keytab name to be used by
426 application servers such as telnetd and rlogind. The default is
427 @value{DefaultDefaultKeytabName}.
430 Identifies the default Kerberos realm for the client. Set its value to
431 your Kerberos realm. If this is not specified and the TXT record
432 lookup is enabled (see @ref{Using DNS}), then that information will be
433 used to determine the default realm. If this tag is not set in this
434 configuration file and there is no DNS information found, then an error
437 @itemx default_tgs_enctypes
438 Identifies the supported list of session key encryption types that
439 should be returned by the KDC. The list may be delimited with commas
440 or whitespace. Kerberos supports many different encryption types, and
441 support for more is planned in the future. (see @ref{Supported Encryption
442 Types} for a list of the accepted values for this tag). The default
443 value is @value{DefaultDefaultTgsEnctypes}.
445 @itemx default_tkt_enctypes
446 Identifies the supported list of session key encryption types that
447 should be requested by the client. The format is the same as for
448 @emph{default_tgs_enctypes}. The default value for this tag is
449 @value{DefaultDefaultTktEnctypes}.
451 @itemx permitted_enctypes
452 Identifies all encryption types that are permitted for use in session
453 key encryption. The default value for this tag is
454 @value{DefaultPermittedEnctypes}.
456 @itemx allow_weak_crypto
457 If this is set to 0 (for false), then weak encryption types will be
458 filtered out of the previous three lists (as noted in @ref{Supported
459 Encryption Types}). The default value for this tag is false, which
460 may cause authentication failures in existing Kerberos infrastructures
461 that do not support strong crypto. Users in affected environments
462 should set this tag to true until their infrastructure adopts stronger
466 Sets the maximum allowable amount of clockskew in seconds that the
467 library will tolerate before assuming that a Kerberos message is
468 invalid. The default value is @value{DefaultClockskew}.
471 If this is set to 1 (for true), then client machines will compute the
472 difference between their time and the time returned by the KDC in the
473 timestamps in the tickets and use this value to correct for an
474 inaccurate system clock. This corrective factor is only used by the
475 Kerberos library. The default is @value{DefaultKDCTimesync}.
477 @itemx kdc_req_checksum_type
479 @itemx ap_req_checksum_type
481 @itemx safe_checksum_type
482 An integer which specifies the type of checksum to use. Used for
483 compatability with DCE security servers which do not support the
484 default @value{DefaultChecksumType} used by this version of Kerberos.
486 kdc_req_checksum_type is only used for DES keys. The ap_req_checksum_type defaults to the preferred checksum for the encryption type being used if unset. If set, then the selected checksum is used regardless of the type of key being used. The possible values and their meanings are as follows.
488 @comment taken from krb5/src/include/krb5.h[in]
507 Microsoft MD5 HMAC checksum type
510 @comment see lib/krb5/ccache/fcc.h
512 Use this parameter on systems which are DCE clients, to specify the
513 type of cache to be created by kinit, or when forwarded tickets are
514 received. DCE and Kerberos can share the cache, but some versions of
515 DCE do not support the default cache as created by this version of
516 Kerberos. Use a value of 1 on DCE 1.0.3a systems, and a value of 2 on
517 DCE 1.1 systems. The default value is @value{DefaultCcacheType}.
519 @itemx dns_lookup_kdc
520 Indicate whether DNS SRV records should be used to locate the KDCs and
521 other servers for a realm, if they are not listed in the information for
522 the realm. (Note that the @samp{admin_server} entry must be in the
523 file, because the DNS implementation for it is incomplete.)
525 Enabling this option does open up a type of denial-of-service attack, if
526 someone spoofs the DNS records and redirects you to another server.
527 However, it's no worse than a denial of service, because that fake KDC
528 will be unable to decode anything you send it (besides the initial
529 ticket request, which has no encrypted data), and anything the fake KDC
530 sends will not be trusted without verification using some secret that it
533 If this option is not specified but @samp{dns_fallback} is, that value
534 will be used instead. If neither option is specified, the behavior
535 depends on configure-time options; if none were given, the default is to
536 enable this option. If the DNS support is not compiled in, this entry
539 @itemx dns_lookup_realm
540 Indicate whether DNS TXT records should be used to determine the
541 Kerberos realm of a host.
543 Enabling this option may permit a redirection attack, where spoofed DNS
544 replies persuade a client to authenticate to the wrong realm, when
545 talking to the wrong host (either by spoofing yet more DNS records or by
546 intercepting the net traffic). Depending on how the client software
547 manages hostnames, however, it could already be vulnerable to such
548 attacks. We are looking at possible ways to minimize or eliminate this
549 exposure. For now, we encourage more adventurous sites to try using
552 If this option is not specified but @samp{dns_fallback} is, that value
553 will be used instead. If neither option is specified, the behavior
554 depends on configure-time options; if none were given, the default is to
555 disable this option. If the DNS support is not compiled in, this entry
559 General flag controlling the use of DNS for Kerberos information. If
560 both of the preceding options are specified, this option has no effect.
562 @itemx extra_addresses
563 This allows a computer to use multiple local addresses, in order to
564 allow Kerberos to work in a network that uses NATs. The addresses
565 should be in a comma-separated list.
567 @itemx udp_preference_limit
568 When sending a message to the KDC, the library will try using TCP before
569 UDP if the size of the message is above @code{udp_preference_list}.
570 If the message is smaller than @code{udp_preference_list}, then UDP
571 will be tried before TCP. Regardless of the size, both protocols will
572 be tried if the first attempt fails.
574 @itemx verify_ap_req_nofail
575 If this flag is set, then an attempt to get initial credentials will
576 fail if the client machine does not have a keytab. The default for the
577 flag is @value{DefaultVerifyApReqNofail}.
579 @itemx ticket_lifetime
580 The value of this tag is the default lifetime for
581 initial tickets. The default value for the tag is
582 @value{DefaultTktLifetime}.
584 @itemx renew_lifetime
585 The value of this tag is the default renewable lifetime for
586 initial tickets. The default value for the tag is
587 @value{DefaultRenewLifetime}.
590 Setting this flag causes the initial Kerberos ticket to be addressless.
591 The default for the flag is @value{DefaultNoaddresses}.
594 If this flag is set, initial tickets by default will be forwardable.
595 The default value for this flag is @value{DefaultForwardable}.
598 If this flag is set, initial tickets by default will be proxiable.
599 The default value for this flag is @value{DefaultProxiable}.
605 @node appdefaults, login, libdefaults, krb5.conf
606 @subsection [appdefaults]
608 Each tag in the [appdefaults] section names a Kerberos V5 application
609 or an option that is used by some Kerberos V5 application[s]. The
610 value of the tag defines the default behaviors for that application.
618 @value{PRIMARYREALM} = @{
626 @value{PRIMARYREALM} = @{
634 The above four ways of specifying the value of an option are shown
635 in order of decreasing precedence. In this example, if telnet is
636 running in the realm @value{SECONDREALM}, it should, by default, have
637 option1 and option2 set to true. However, a telnet program in the realm
638 @value{PRIMARYREALM} should have option1 set to false and option2 set
639 to true. Any other programs in @value{PRIMARYREALM} should have option2
640 set to false by default. Any programs running in other realms should
641 have option2 set to true.
643 The list of specifiable options for each application may be found in
644 that application's man pages. The application defaults specified here
645 are overridden by those specified in the [realms] section.
648 @node login, realms (krb5.conf), appdefaults, krb5.conf
651 Each tag in the [login] section of the file is an option for
652 login.krb5. This section may contain any of the following relations:
655 @itemx krb5_get_tickets
656 Indicate whether or not to use a user's password to get V5 tickets.
657 The default value is @value{DefaultKrb5GetTickets}.
660 Indicate whether or not to run aklog. The default value is
661 @value{DefaultKrbRunAklog}.
664 Indicate where to find aklog. The default value is
665 @value{DefaultAklogPath}.
668 A true value will cause login not to accept plaintext passwords. The
669 default value is @value{DefaultAcceptPasswd}. This is not yet
673 @node realms (krb5.conf), domain_realm, login, krb5.conf
676 Each tag in the [realms] section of the file is the name of a Kerberos
677 realm. The value of the tag is a subsection with relations that define
678 the properties of that particular realm. For each realm, the following
679 tags may be specified in the realm's subsection:
683 The name or address of a host running a KDC for that realm. An optional
684 port number, separated from the hostname by a colon, may be included.
685 If the name or address contains colons (for example, if it is an IPv6
686 address), enclose it in square brackets to distinguish the colon from a
687 port separator. For your computer to be able to communicate with the
688 KDC for each realm, this tag must be given a value in each realm
689 subsection in the configuration file, or there must be DNS SRV records
690 specifying the KDCs (see @ref{Using DNS}).
693 Identifies the master KDC(s). Currently, this tag is used in only one
694 case: If an attempt to get credentials fails because of an invalid
695 password, the client software will attempt to contact the master KDC,
696 in case the user's password has just been changed, and the updated
697 database has not been propagated to the slave servers yet.
699 @itemx database_module
701 This relation indicates the name of the configuration section under [dbmodules] for database specific parameters used by the loadable database library.
705 Identifies the host where the administration server is running.
706 Typically, this is the master Kerberos server. This tag must be given
707 a value in order to communicate with the kadmin server for the realm.
710 this doesn't seem to be used in the code
711 @itemx application defaults
712 Application defaults that are specific to a particular realm may be
713 specified within that realm's tag. Realm-specific application defaults
714 override the global defaults specified in the [appdefaults] section.
717 @itemx default_domain
718 This tag is used for Kerberos 4 compatibility. Kerberos 4 does not
719 require the entire hostname of a server to be in its principal like
720 Kerberos 5 does. This tag provides the domain name needed to produce a
721 full hostname when translating V4 principal names into V5 principal
722 names. All servers in this realm are assumed to be in the domain given
723 as the value of this tag
725 @itemx v4_instance_convert
726 This subsection allows the administrator to configure exceptions to the
727 default_domain mapping rule. It contains V4 instances (the tag name)
728 which should be translated to some specific hostname (the tag value) as
729 the second component in a Kerberos V5 principal name.
732 This relation is used by the krb524 library routines when converting a
733 V5 principal name to a V4 principal name. It is used when the V4 realm
734 name and the V5 realm name are not the same, but still share the same
735 principal names and passwords. The tag value is the Kerberos V4 realm
738 @itemx auth_to_local_names
739 This subsection allows you to set explicit mappings from principal
740 names to local user names. The tag is the mapping name, and the value
741 is the corresponding local user name.
744 This tag allows you to set a general rule for mapping principal names
745 to local user names. It will be used if there is not an explicit
746 mapping for the principal name that is being translated. The possible
751 @item DB:@i{filename}
752 The principal will be looked up in the database @i{filename}. Support
753 for this is not currently compiled in by default.
756 The local name will be formulated from @i{exp}.
758 The format for @i{exp} is
759 @code{[@i{n}:$@i{d}..@i{string}](@i{regexp})s/@i{pattern}/@i{replacement}/g}.
760 The integer @i{n} indicates how many components the target principal
761 should have. If this matches, then a string will be formed by putting
762 together the components of the principal in the order indicated by each
763 integer @i{d}, and the arbitrary string @i{string} (i.e. if the
764 principal was @value{RANDOMUSER}/admin then [2:$2$1foo] would result in
765 the string "admin@value{RANDOMUSER}foo". If this string matches
766 @i{regexp}, then the @code{s//[g]} substitution command will be run over the
767 string. The optional g will cause the substitution to be global over
768 the string, instead of replacing only the first match in the string.
771 The principal name will be used as the local user name. If the
772 principal has more than one component or is not in the default realm,
773 this rule is not applicable and the conversion will fail.
782 @value{PRIMARYREALM} = @{
784 RULE:[2:$1](@value{RANDOMUSER})s/^.*$/guest/
785 RULE:[2:$1;$2](^.*;admin$)s/;admin$//
786 RULE:[2:$2](^.*;root)s/^.*$/root/
793 would result in any principal without @code{root} or @code{admin} as
794 the second component to be translated with the default rule. A
795 principal with a second component of @code{admin} will become its first
796 component. @code{root} will be used as the local name for any
797 principal with a second component of @code{root}. The exception to
798 these two rules are any principals @value{RANDOMUSER}/*, which will
799 always get the local name @code{guest}.
803 @node domain_realm, logging, realms (krb5.conf), krb5.conf
804 @subsection [domain_realm]
806 The [domain_realm] section provides a translation from a domain name or
807 hostname to a Kerberos realm name. The tag name can be a host name, or
808 a domain name, where domain names are indicated by a prefix of a period
809 (@samp{.}). The value of the relation is the Kerberos realm name for
810 that particular host or domain. Host names and domain names should be
813 If no translation entry applies, the host's realm is considered to be
814 the hostname's domain portion converted to upper case. For example, the
815 following [domain_realm] section:
821 .mit.edu = ATHENA.MIT.EDU
823 @value{PRIMARYDOMAIN} = @value{PRIMARYREALM}
824 crash.@value{PRIMARYDOMAIN} = TEST.@value{PRIMARYREALM}
825 @value{SECONDDOMAIN} = @value{SECONDREALM}
830 maps crash.@value{PRIMARYDOMAIN} into the TEST.@value{PRIMARYREALM}
831 realm. All other hosts in the @value{PRIMARYDOMAIN} domain will map by
832 default to the @value{PRIMARYREALM} realm, and all hosts in the
833 @value{SECONDDOMAIN} domain will map by default into the
834 @value{SECONDREALM} realm. Note the entries for the hosts
835 @value{PRIMARYDOMAIN} and @value{SECONDDOMAIN}. Without these entries,
837 these hosts would be mapped into the Kerberos realms @samp{COM} and
840 these hosts would be mapped into the Kerberos realms @samp{EDU} and
842 @samp{ORG}, respectively.
844 @node logging, capaths, domain_realm, krb5.conf
845 @subsection [logging]
846 The [logging] section indicates how a particular entity is to perform
847 its logging. The relations in this section assign one or more values to
848 the entity name. Currently, the following entities are used:
853 These entries specify how the KDC is to perform its logging.
856 These entries specify how the administrative server
857 is to perform its logging.
860 These entries specify how to perform logging in the
861 absence of explicit specifications otherwise.
864 Values are of the following forms:
867 @itemx FILE=<filename>
869 @itemx FILE:<filename>
870 This value causes the entity's logging messages to go to the specified
871 file. If the @samp{=} form is used, the file is overwritten. If the
872 @samp{:} form is used, the file is appended to.
875 This value causes the entity's logging messages to go to its standard
879 This value causes the entity's logging messages to go to the console, if
880 the system supports it.
882 @itemx DEVICE=<devicename>
883 This causes the entity's logging messages to go to the specified device.
885 @itemx SYSLOG[:<severity>[:<facility>]]
886 This causes the entity's logging messages to go to the system log.
888 The @dfn{severity} argument specifies the default severity of system log
889 messages. This may be any of the following severities supported by the
890 @code{syslog(3)} call, minus the LOG_ prefix: LOG_EMERG, LOG_ALERT,
891 LOG_CRIT, LOG_ERR, LOG_WARNING, LOG_NOTICE, LOG_INFO, and LOG_DEBUG.
892 For example, a value of @samp{CRIT} would specify LOG_CRIT severity.
894 The facility argument specifies the facility under which the messages
895 are logged. This may be any of the following facilities supported by
896 the syslog(3) call minus the LOG_ prefix: LOG_KERN, LOG_USER, LOG_MAIL,
897 LOG_DAEMON, LOG_AUTH, LOG_LPR, LOG_NEWS, LOG_UUCP, LOG_CRON, and
898 LOG_LOCAL0 through LOG_LOCAL7.
900 If no severity is specified, the default is ERR. If no facility is
901 specified, the default is AUTH.
904 In the following example, the logging messages from the KDC will go to
905 the console and to the system log under the facility LOG_DAEMON with
906 default severity of LOG_INFO; and the logging messages from the
907 administrative server will be appended to the file /var/adm/kadmin.log
908 and sent to the device /dev/tty04.
914 kdc = SYSLOG:INFO:DAEMON
915 admin_server = FILE:/var/adm/kadmin.log
916 admin_server = DEVICE=/dev/tty04
920 @node capaths, dbdefaults, logging, krb5.conf
921 @subsection [capaths]
923 In order to perform direct (non-hierarchical) cross-realm
924 authentication, a database is needed to construct the authentication
925 paths between the realms. This section defines that database.
927 A client will use this section to find the authentication path between
928 its realm and the realm of the server. The server will use this section
929 to verify the authentication path used by the client, by checking the
930 transited field of the received ticket.
932 There is a tag for each participating realm, and each tag has subtags
933 for each of the realms. The value of the subtags is an intermediate
934 realm which may participate in the cross-realm authentication. The
935 subtags may be repeated if there is more then one intermediate realm. A
936 value of "." means that the two realms share keys directly, and no
937 intermediate realms should be allowed to participate.
939 There are n**2 possible entries in this table, but only those entries
940 which will be needed on the client or the server need to be present.
941 The client needs a tag for its local realm, with subtags for all the
942 realms of servers it will need to authenticate with. A server needs a
943 tag for each realm of the clients it will serve.
945 For example, ANL.GOV, PNL.GOV, and NERSC.GOV all wish to use the ES.NET
946 realm as an intermediate realm. ANL has a sub realm of TEST.ANL.GOV
947 which will authenticate with NERSC.GOV but not PNL.GOV. The [capaths]
948 section for ANL.GOV systems would look like this:
974 The [capaths] section of the configuration file used on NERSC.GOV systems
975 would look like this:
982 TEST.ANL.GOV = ES.NET
983 TEST.ANL.GOV = ANL.GOV
1003 In the above examples, the ordering is not important, except when the
1004 same subtag name is used more then once. The client will use this to
1005 determine the path. (It is not important to the server, since the
1006 transited field is not sorted.)
1008 This feature is not currently supported by DCE. DCE security servers
1009 can be used with Kerberized clients and servers, but versions prior to
1010 DCE 1.1 did not fill in the transited field, and should be used with
1013 @node dbdefaults, dbmodules, capaths, krb5.conf
1014 @subsection [dbdefaults]
1016 The [dbdefaults] section provides default values for the database specific parameters. It can also specify the configuration section under [dbmodules] section for database specific parameters used by the database library.(@pxref{dbmodules}).
1018 The following tags are used in this section:
1021 @itemx database_module
1022 This relation indicates the name of the configuration section under the [dbmodules] for database specific parameters used by the loadable database library.
1024 @itemx ldap_kerberos_container_dn
1025 This LDAP specific tag indicates the DN of the container object where the realm objects will be located. This value is used if the container object is not mentioned in the configuration section under [dbmodules].
1028 This LDAP specific tag indicates the default bind DN for the KDC server. The KDC server does a login to the directory as this object. This object should have the rights to read the Kerberos data in the LDAP database. This value is used if the bind DN for the KDC is not mentioned in the configuration section under [dbmodules].
1030 @itemx ldap_kadmind_dn
1031 This LDAP specific tag indicates the default bind DN for the Administration server. The administration server does a login to the directory as this object. This object should have the rights to read and write the Kerberos data in the LDAP database. This value is used if the bind DN for the Administration server is not mentioned in the configuration section under [dbmodules].
1033 @itemx ldap_service_password_file
1035 This LDAP specific tag indicates the file containing the stashed passwords (created by @code{kdb5_ldap_util stashsrvpw}) for the objects used by the Kerberos servers to bind to the LDAP server. This file must be kept secure. This value is used if no service password file is mentioned in the configuration section under [dbmodules].
1039 This LDAP specific tag indicates the list of LDAP servers that the Kerberos servers can connect to. The list of LDAP servers is whitespace-separated. The LDAP server is specified by a LDAP URI. This value is used if no LDAP servers are mentioned in the configuration section under [dbmodules]. It is recommended to use the ldapi:// or ldaps:// interface and not to use ldap:// interface.
1041 @itemx ldap_conns_per_server
1042 This LDAP specific tag indicates the number of connections to be maintained per LDAP server. This value is used if the number of connections per LDAP server are not mentioned in the configuration section under [dbmodules]. The default value is 5.
1045 @node dbmodules, pkinit client options, dbdefaults, krb5.conf
1046 @subsection [dbmodules]
1048 Contains database specific parameters used by the database library. Each tag in the [dbmodules] section of the file names a configuration section for database specific parameters that can be referred to by a realm. The value of the tag is a subsection where the relations in that subsection define the database specific parameters.
1050 For each section, the following tags may be specified in the subsection:
1054 This tag indicates the name of the loadable database library. The value should be @samp{db2} for DB2 database and @samp{kldap} for LDAP database.
1056 @itemx ldap_kerberos_container_dn
1057 This LDAP specific tag indicates the DN of the container object where the realm objects will be located.
1060 This LDAP specific tag indicates the default bind DN for the KDC server. The KDC server does a login to the directory as this object. This object should have the rights to read the Kerberos data in the LDAP database.
1062 @itemx ldap_kadmind_dn
1063 This LDAP specific tag indicates the default bind DN for the Administration server. The administration server does a login to the directory as this object. This object should have the rights to read and write the Kerberos data in the LDAP database.
1065 @itemx ldap_service_password_file
1066 This LDAP specific tag indicates the file containing the stashed passwords (created by @code{kdb5_ldap_util stashsrvpw}) for the objects used by the Kerberos servers to bind to the LDAP server. This file must be kept secure.
1069 This LDAP specific tag indicates the list of LDAP servers that the Kerberos servers can connect to. The list of LDAP servers is whitespace-separated. The LDAP server is specified by a LDAP URI. It is recommended to use ldapi:// or ldaps:// interface to connect to the LDAP server.
1071 @itemx ldap_conns_per_server
1072 This LDAP specific tags indicates the number of connections to be maintained per LDAP server.
1076 @node pkinit client options, Sample krb5.conf File, dbmodules, krb5.conf
1077 @subsection pkinit options
1080 * pkinit identity syntax::
1081 * pkinit krb5.conf options::
1084 The following are @b{pkinit-specific} options.
1085 Note that these values may be specified in @code{[libdefaults]}
1087 or within a realm-specific subsection of @code{[libdefaults]},
1088 or may be specified as realm-specific values in the
1089 @code{[realms]} section.
1090 Also note that a realm-specific value over-rides, does not add to,
1091 a generic @code{[libdefaults]} specification.
1092 The search order is:
1094 @item realm-specific subsection of @code{[libdefaults]}
1099 pkinit_anchors = FILE:/usr/local/example.com.crt
1104 @item realm-specific value in the @code{[realms]} section,
1109 pkinit_anchors = FILE:/usr/local/otherrealm.org.crt
1114 @item generic value in the @code{[libdefaults]} section.
1118 pkinit_anchors = DIR:/usr/local/generic_trusted_cas/
1124 @node pkinit identity syntax, pkinit krb5.conf options, pkinit client options, pkinit client options
1125 @subsubsection Specifying pkinit identity information
1127 The syntax for specifying Public Key identity, trust, and revocation
1128 information for pkinit is as follows:
1131 @item FILE:@i{file-name}[,@i{key-file-name}]
1132 This option has context-specific behavior.
1134 @item pkinit_identity
1135 @itemx pkinit_identities
1136 @i{file-name} specifies the name of a PEM-format file
1137 containing the user's certificate. If @i{key-file-name} is
1138 not specified, the user's private key is expected to be
1139 in @i{file-name} as well. Otherwise, @i{key-file-name}
1140 is the name of the file containing the private key.
1141 @item pkinit_anchors
1143 @i{file-name} is assumed to be the name of an OpenSSL-style
1147 @item DIR:@i{directory-name}
1148 This option has context-specific behavior.
1150 @item pkinit_identity
1151 @itemx pkinit_identities
1152 @i{directory-name} specifies a directory with files named
1153 @code{*.crt} and @code{*.key}, where the first part of the
1154 file name is the same for matching pairs of certificate and
1155 private key files. When a file with a name ending with @code{.crt}
1156 is found, a matching file ending with @code{.key} is assumed
1157 to contain the private key. If no such file is found, then
1158 the certificate in the @code{.crt} is not used.
1159 @item pkinit_anchors
1161 @i{directory-name} is assumed to be an OpenSSL-style hashed CA directory
1162 where each CA cert is stored in a file named @i{hash-of-ca-cert}.@i{#}.
1163 This infrastructure is encouraged, but all files in the directory
1164 will be examined and if they contain certificates (in PEM format),
1167 @i{directory-name} is assumed to be an OpenSSL-style hashed CA directory
1168 where each revocation list is stored in a file named @i{hash-of-ca-cert}.@b{r}@i{#}.
1169 This infrastructure is encouraged, but all files in the directory
1170 will be examined and if they contain a revocation list (in PEM format),
1174 @item PKCS12:@i{pkcs12-file-name}
1175 @i{pkcs12-file-name} is the name of a @code{PKCS #12} format file, containing
1176 the user's certificate and private key.
1178 @item PKCS11:[@b{module_name=}]@i{module-name}[@b{:slotid=}@i{slot-id}][@b{:token=}@i{token-label}][@b{:certid=}@i{cert-id}][@b{:certlabel=}@i{cert-label}]
1179 All keyword/values are optional.
1180 @i{module-name} specifies the location of a library implementing
1181 @code{PKCS #11}. If a value is encountered with no keyword, it
1182 is assumed to be the @i{module-name}. If no @i{module-name} is
1183 specified, the default is @code{opensc-pkcs11.so}.
1184 @b{slotid=} and/or @b{token=} may be specified to force the use of a
1185 particular smard card reader or token if there is more than one
1187 @b{certid=} and/or @b{certlabel=} may be specified to force the selection
1188 of a particular certificate on the device. See the @code{pkinit_cert_match}
1189 configuration option for more ways to select a particular certificate to
1192 @item ENV:@i{environment-variable-name}
1193 @i{environment-variable-name} specifies the name of an environment
1194 variable which has been set to a value conforming to one of the
1195 previous values. For example, @code{ENV:X509_PROXY}, where environment
1196 variable @code{X509_PROXY} has been set to @code{FILE:/tmp/my_proxy.pem}.
1199 @node pkinit krb5.conf options, , pkinit identity syntax, pkinit client options
1200 @subsubsection pkinit krb5.conf options
1203 @item pkinit_identities
1204 Specifies the location(s) to be used to find the user's X.509 identity
1205 information. This option may be specified multiple times.
1206 Each value is attempted in order until identity information is found
1207 and authentication is attempted. Note that these values are @b{not}
1208 used if the user specifies @b{X509_user_identity} on the command line.
1210 @item pkinit_anchors
1211 Specifies the location of trusted anchor (root) certificates which
1212 the client trusts to sign KDC certificates. This option may be
1213 specified multiple times. These values from the config file are
1214 @b{not} used if the user specifies @b{X509_anchors} on the command line.
1217 Specifies the location of intermediate certificates which may be
1218 used by the client to complete the trust chain between a KDC
1219 certificate and a trusted anchor. This option may be specified
1223 Specifies the location of Certificate Revocation List (CRL) information
1224 to be used by the client when verifying the validity of the KDC
1225 certificate presented. This option may be specified multiple times.
1227 @item pkinit_require_crl_checking
1228 The default certificate verification process will always check
1229 the available revocation information to see if a certificate has
1230 been revoked. If a match is found for the certificate in a CRL,
1231 verification fails. If the certificate being verified is not listed
1232 in a CRL, or there is no CRL present for its issuing CA,
1233 and @code{pkinit_require_crl_checking} is @code{false},
1234 then verification succeeds.
1236 However, if @code{pkinit_require_crl_checking} is @code{true} and
1237 there is no CRL information available for the issuing CA,
1238 then verification fails.
1240 @code{pkinit_require_crl_checking} should be set to @code{true}
1241 if the policy is such that up-to-date CRLs @b{must} be present for
1244 @item pkinit_dh_min_bits
1245 Specifies the size of the Diffie-Hellman key the client will
1246 attempt to use. The acceptable values are currently 1024, 2048,
1247 and 4096. The default is 2048.
1250 This flag specifies whether the target realm is assumed
1251 to support only the @i{old}, pre-RFC version of the protocol.
1252 The default is false.
1254 @item pkinit_win2k_require_binding
1255 If this flag is set to true, it expects that the target
1256 KDC is patched to return a reply with a checksum rather than a
1257 nonce. The default is false.
1259 @item pkinit_eku_checking
1260 This option specifies what Extended Key Usage value the KDC certificate
1261 presented to the client must contain.
1262 (@b{Note} that if the KDC certificate has the pkinit
1263 SubjectAlternativeName encoded as the Kerberos TGS name, EKU checking
1264 is not necessary since the issuing CA has certified this as a KDC
1266 The values recognized in the @code{krb5.conf} file are:
1269 This is the default value and specifies that the KDC must have the
1270 id-pkinit-KPKdc EKU as defined in RFC4556.
1272 If @code{kpServerAuth} is specified, a KDC certificate with the
1273 id-kp-serverAuth EKU as used by Microsoft will be accepted.
1275 If @code{none} is specified, then the KDC certificate will not be
1276 checked to verify it has an acceptable EKU. The use of this option
1277 is @b{not recommended}.
1280 @item pkinit_kdc_hostname
1281 The presense of this option indicates that the client is willing to
1282 accept a KDC certificate with a dNSName SAN (Subject Alternative Name)
1283 rather than requiring the id-pkinit-san as defined in RFC4556. This
1284 option may be specified multiple times. Its value should contain
1285 the acceptable hostname for the KDC (as contained in its certificate).
1287 @item pkinit_cert_match
1288 Specifies matching rules that the client certificate must match before
1289 it is used to attempt pkinit authentication. If a user has multiple
1290 certificates available (on a smart card, or via other media), there
1291 must be exactly one certificate chosen before attempting pkinit
1292 authentication. This option may be specified multiple times. All the
1293 available certificates are checked against each rule in order until
1294 there is a match of exactly one certificate.
1296 The Subject and Issuer comparison strings are the RFC2253 string
1297 representations from the certificate Subject DN and Issuer DN values.
1299 The syntax of the matching rules is:
1301 [@i{relation-operator}]@i{component-rule} @code{...}
1305 @item relation-operator
1306 can be either @code{&&}, meaning all component rules must match,
1307 or @code{||}, meaning only one component rule must match.
1308 The default is @code{&&} if not specified.
1310 @item component-rule
1311 can be one of the following. Note that there is no punctuation
1312 or whitespace between component rules.
1314 @item @code{<SUBJECT>}@i{regular-expression}
1315 @item @code{<ISSUER>}@i{regular-expression}
1316 @item @code{<SAN>}@i{regular-expression}
1317 @item @code{<EKU>}@i{extended-key-usage-list}
1318 where @i{extended-key-usage-list} is a comma-separated list of
1319 required Extended Key Usage values. All values in the list must
1320 be present in the certificate.
1326 @code{emailProtection}
1329 @item @code{<KU>}@i{key-usage-list}
1330 where @i{key-usage-list} is a comma-separated list of required
1331 Key Usage values. All values in the list must be present in
1335 @code{digitalSignature}
1336 @code{keyEncipherment}
1343 pkinit_cert_match = ||<SUBJECT>.*DoE.*<SAN>.*@@EXAMPLE.COM
1344 pkinit_cert_match = &&<EKU>msScLogin,clientAuth<ISSUER>.*DoE.*
1345 pkinit_cert_match = <EKU>msScLogin,clientAuth<KU>digitalSignature
1349 @node Sample krb5.conf File, , pkinit client options, krb5.conf
1350 @subsection Sample krb5.conf File
1352 Here is an example of a generic @code{krb5.conf} file:
1357 default_realm = @value{PRIMARYREALM}
1358 default_tkt_enctypes = des3-hmac-sha1 des-cbc-crc
1359 default_tgs_enctypes = des3-hmac-sha1 des-cbc-crc
1360 dns_lookup_kdc = true
1361 dns_lookup_realm = false
1364 @value{PRIMARYREALM} = @{
1365 kdc = @value{KDCSERVER}.@value{PRIMARYDOMAIN}
1366 kdc = @value{KDCSLAVE1}.@value{PRIMARYDOMAIN}
1367 kdc = @value{KDCSLAVE2}.@value{PRIMARYDOMAIN}:750
1368 admin_server = @value{KDCSERVER}.@value{PRIMARYDOMAIN}
1369 master_kdc = @value{KDCSERVER}.@value{PRIMARYDOMAIN}
1370 default_domain = @value{PRIMARYDOMAIN}
1372 @value{SECONDREALM} = @{
1373 kdc = @value{KDCSERVER}.@value{SECONDDOMAIN}
1374 kdc = @value{KDCSLAVE1}.@value{SECONDDOMAIN}
1375 admin_server = @value{KDCSERVER}.@value{SECONDDOMAIN}
1377 OPENLDAP.MIT.EDU = @{
1378 kdc = @value{KDCSERVER}.@value{PRIMARYDOMAIN}
1379 admin_server = @value{KDCSERVER}.@value{PRIMARYDOMAIN}
1380 database_module = openldap_ldapconf
1385 .mit.edu = ATHENA.MIT.EDU
1387 @value{PRIMARYDOMAIN} = @value{PRIMARYREALM}
1390 @value{PRIMARYREALM} = @{
1391 @value{SECONDREALM} = .
1393 @value{SECONDREALM} = @{
1394 @value{PRIMARYREALM} = .
1399 admin_server = FILE=/var/kadm5.log
1401 ldap_kerberos_container_dn = cn=krbcontainer,dc=example,dc=com
1403 openldap_ldapconf = @{
1405 ldap_kerberos_container_dn = cn=krbcontainer,dc=example,dc=com
1406 ldap_kdc_dn = "cn=krbadmin,dc=example,dc=com"
1407 # this object needs to have read rights on
1408 # the realm container and principal subtrees
1409 ldap_kadmind_dn = "cn=krbadmin,dc=example,dc=com"
1410 # this object needs to have read and write rights on
1411 # the realm container and principal subtrees
1412 ldap_service_password_file = /etc/kerberos/service.keyfile
1413 ldap_servers = ldaps://kerberos.mit.edu
1414 ldap_conns_per_server = 5
1426 @node kdc.conf, , krb5.conf, Configuration Files
1429 @include kdcconf.texinfo
1433 * realms (kdc.conf)::
1434 * pkinit kdc options::
1435 * Sample kdc.conf File::
1438 @node kdcdefaults, realms (kdc.conf), kdc.conf, kdc.conf
1439 @subsection [kdcdefaults]
1441 The following relation is defined in the [kdcdefaults] section:
1445 This relation lists the ports on which the Kerberos server should
1446 listen for UDP requests by default. This list is a comma separated
1448 If this relation is not specified, the compiled-in default is
1449 @value{DefaultKdcPorts}, the first being the assigned Kerberos port
1450 and the second which was used by Kerberos V4.
1452 @itemx kdc_tcp_ports
1453 This relation lists the ports on which the Kerberos server should
1454 listen for TCP connections by default. This list is a comma separated
1456 If this relation is not specified, the compiled-in default is not to
1457 listen for TCP connections at all.
1459 If you wish to change this (which we do not recommend, because the
1460 current implementation has little protection against denial-of-service
1461 attacks), the standard port number assigned for Kerberos TCP traffic
1465 @node realms (kdc.conf), pkinit kdc options, kdcdefaults, kdc.conf
1466 @subsection [realms]
1468 Each tag in the [realms] section of the file names a Kerberos realm.
1469 The value of the tag is a subsection where the relations in that
1470 subsection define KDC parameters for that particular realm.
1472 For each realm, the following tags may be specified in the [realms]
1477 (String.) Location of the access control list (acl) file that kadmin
1478 uses to determine which principals are allowed which permissions on the
1479 database. The default is @code{@value{DefaultAclFile}}.
1482 (String.) Location of the keytab file that the legacy administration
1483 daemons @code{kadmind4} and @code{v5passwdd} use to authenticate to
1484 the database. The default is @code{@value{DefaultAdminKeytab}}.
1486 @itemx database_name
1487 (String.) Location of the Kerberos database for this realm. The
1488 default is @* @code{@value{DefaultDatabaseName}}.
1490 @itemx default_principal_expiration
1491 (Absolute time string.) Specifies the default expiration date of
1492 principals created in this realm. The default value for this tag is
1493 @value{DefaultDefaultPrincipalExpiration}.
1495 @itemx default_principal_flags
1496 (Flag string.) Specifies the default attributes of principals created
1497 in this realm. The format for this string is a comma-separated list of
1498 flags, with '+' before each flag that should be enabled and '-' before
1499 each flag that should be disabled. The default is
1500 @value{DefaultDefaultPrincipalFlags}.
1502 There are a number of possible flags:
1506 Enabling this flag allows the principal to obtain postdateable tickets.
1509 Enabling this flag allows the principal to obtain forwardable tickets.
1512 Enabling this flag allows a principal to obtain tickets based on a
1513 ticket-granting-ticket, rather than repeating the authentication
1514 process that was used to obtain the TGT.
1517 Enabling this flag allows the principal to obtain renewable tickets.
1520 Enabling this flag allows the principal to obtain proxy tickets.
1523 Enabling this flag allows the principal to obtain a session key for
1524 another user, permitting user-to-user authentication for this principal.
1526 @itemx allow-tickets
1527 Enabling this flag means that the KDC will issue tickets for this
1528 principal. Disabling this flag essentially deactivates the principal
1532 If this flag is enabled on a client principal, then that principal is
1533 required to preauthenticate to the KDC before receiving any tickets.
1534 On a service principal, enabling this flag means that service tickets
1535 for this principal will only be issued to clients with a TGT that has
1536 the preauthenticated ticket set.
1539 If this flag is enabled, then the principal is required to
1540 preauthenticate using a hardware device before receiving any tickets.
1543 Enabling this flag forces a password change for this principal.
1546 Enabling this flag allows the the KDC to issue service tickets for this
1550 If this flag is enabled, it marks this principal as a password change
1551 service. This should only be used in special cases, for example, if a
1552 user's password has expired, then the user has to get tickets for that
1553 principal without going through the normal password authentication in
1554 order to be able to change the password.
1559 (String.) Location of the dictionary file containing strings that are
1560 not allowed as passwords. If none is specified or if there is no
1561 policy assigned to the principal, no dictionary checks of passwords
1565 (Port number.) Specifies the port on which the kadmind daemon is to
1566 listen for this realm. The assigned port for kadmind is
1567 @value{DefaultKadmindPort}.
1570 (Port number.) Specifies the port on which the kpasswd daemon is to
1571 listen for this realm. The default is @value{DefaultKpasswdPort}.
1573 @itemx key_stash_file
1574 (String.) Specifies the location where the master key has been stored
1575 (via @code{kdb5_util stash}). The default is
1576 @code{@value{DefaultKeyStashFileStub}@i{REALM}}, where @i{REALM} is the
1580 (String.) Specifies the list of ports that the KDC is to listen to
1581 for UDP requests for this realm. By default, the value of kdc_ports
1582 as specified in the [kdcdefaults] section is used.
1584 @itemx kdc_tcp_ports
1585 (String.) Specifies the list of ports that the KDC is to listen to
1586 for TCP requests for this realm. By default, the value of
1587 kdc_tcp_ports as specified in the [kdcdefaults] section is used.
1589 @itemx master_key_name
1590 (String.) Specifies the name of the principal associated with the
1591 master key. The default is @value{DefaultMasterKeyName}.
1593 @itemx master_key_type
1594 (Key type string.) Specifies the master key's key type. The default
1595 value for this is @value{DefaultMasterKeyType}. For a list of all
1596 possible values, see @ref{Supported Encryption Types}.
1599 (Delta time string.) Specifes the maximum time period for which a
1600 ticket may be valid in this realm. The default value is
1601 @value{DefaultMaxLife}.
1603 @itemx max_renewable_life
1604 (Delta time string.) Specifies the maximum time period during which a
1605 valid ticket may be renewed in this realm. The default value is
1606 @value{DefaultMaxRenewableLife}.
1608 @itemx supported_enctypes
1609 List of key:salt strings. Specifies the default key/salt combinations of
1610 principals for this realm. Any principals created through @code{kadmin}
1611 will have keys of these types. The default value for this tag is
1612 @value{DefaultSupportedEnctypes}. For lists of possible values, see
1613 @ref{Supported Encryption Types} and @ref{Salts}.
1615 @itemx reject_bad_transit
1616 A boolean value (@code{true}, @code{false}). If set to @code{true}, the
1617 KDC will check the list of transited realms for cross-realm tickets
1618 against the transit path computed from the realm names and the
1619 @code{capaths} section of its @code{krb5.conf} file; if the path in the
1620 ticket to be issued contains any realms not in the computed path, the
1621 ticket will not be issued, and an error will be returned to the client
1622 instead. If this value is set to @code{false}, such tickets will be
1623 issued anyways, and it will be left up to the application server to
1624 validate the realm transit path.
1626 If the @code{disable-transited-check} flag is set in the incoming
1627 request, this check is not performed at all. Having the
1628 @code{reject_bad_transit} option will cause such ticket requests to be
1631 This transit path checking and config file option currently apply only
1634 Earlier versions of the MIT release (before 1.2.3) had bugs in the
1635 application server support such that the server-side checks may not be
1636 performed correctly. We recommend turning this option on, unless you
1637 know that all application servers in this realm have been updated to
1638 fixed versions of the software, and for whatever reason, you don't want
1639 the KDC to do the validation.
1641 This is a per-realm option so that multiple-realm KDCs may control it
1642 separately for each realm, in case (for example) one realm has had the
1643 software on its application servers updated but another has not.
1645 This option defaults to @code{true}.
1649 @node pkinit kdc options, Sample kdc.conf File, realms (kdc.conf), kdc.conf
1650 @subsection pkinit options
1653 * pkinit kdc.conf options::
1656 The following are @b{pkinit-specific} options.
1657 Note that these values may be specified in @code{[kdcdefaults]}
1659 or within a realm-specific subsection of @code{[realms]}.
1660 Also note that a realm-specific value over-rides, does not add to,
1661 a generic @code{[kdcdefaults]} specification.
1662 The search order is:
1664 @item realm-specific subsection of @code{[realms]}
1669 pkinit_anchors = FILE:/usr/local/example.com.crt
1674 @item generic value in the @code{[kdcdefaults]} section.
1678 pkinit_anchors = DIR:/usr/local/generic_trusted_cas/
1683 @node pkinit kdc.conf options, , pkinit kdc options, pkinit kdc options
1684 @subsubsection pkinit kdc.conf options
1686 For information about the syntax of some of these options,
1687 see @xref{pkinit identity syntax}.
1690 @item pkinit_identity
1691 Specifies the location of the KDC's X.509 identity information.
1692 This option is @b{required} if pkinit is to be supported by the
1695 @item pkinit_anchors
1696 Specifies the location of trusted anchor (root) certificates
1697 which the KDC trusts to sign client certificates.
1698 This option is @b{required} if pkinit is to be supported by the
1700 This option may be specified multiple times.
1703 Specifies the location of intermediate certificates which may be
1704 used by the KDC to complete the trust chain between a client's
1705 certificate and a trusted anchor.
1706 This option may be specified multiple times.
1709 Specifies the location of Certificate Revocation List (CRL)
1710 information to be used by the KDC when verifying the validity
1711 of client certificates.
1712 This option may be specified multiple times.
1714 @item pkinit_require_crl_checking
1715 The default certificate verification process will always check
1716 the available revocation information to see if a certificate has
1717 been revoked. If a match is found for the certificate in a CRL,
1718 verification fails. If the certificate being verified is not listed
1719 in a CRL, or there is no CRL present for its issuing CA,
1720 and @code{pkinit_require_crl_checking} is @code{false},
1721 then verification succeeds.
1723 However, if @code{pkinit_require_crl_checking} is @code{true} and
1724 there is no CRL information available for the issuing CA,
1725 then verification fails.
1727 @code{pkinit_require_crl_checking} should be set to @code{true}
1728 if the policy is such that up-to-date CRLs @b{must} be present for
1731 @item pkinit_dh_min_bits
1732 Specifies the minimum number of bits the KDC is willing to accept
1733 for a client's Diffie-Hellman key. The default is 2048.
1735 @item pkinit_allow_upn
1736 Specifies that the KDC is willing to accept client certificates with
1737 the Microsoft UserPrincipalName (UPN) Subject Alternative Name
1738 (SAN). This means the KDC accepts the binding of the UPN in the
1739 certificate to the Kerberos principal name.
1741 The default is false.
1743 Without this option, the KDC will only
1744 accept certificates with the id-pkinit-san as defined in RFC4556.
1745 There is currently no option to disable SAN checking in the KDC.
1747 @item pkinit_eku_checking
1748 This option specifies what Extended Key Usage (EKU) values the
1749 KDC is willing to accept in client certificates.
1750 The values recognized in the @code{kdc.conf} file are:
1753 This is the default value and specifies that client certificates must
1754 have the id-pkinit-KPClientAuth EKU as defined in RFC4556.
1756 If @code{scLogin} is specified, client certificates with the
1757 Microsoft Smart Card Login EKU (id-ms-kp-sc-logon) will be accepted.
1759 If @code{none} is specified, then client certificates will not be
1760 checked to verify they have an acceptable EKU.
1761 The use of this option is @b{not recommended}.
1765 @node Sample kdc.conf File, , pkinit kdc options, kdc.conf
1766 @subsection Sample kdc.conf File
1768 Here's an example of a @code{kdc.conf} file:
1776 @value{PRIMARYREALM} = @{
1778 max_life = 12h 0m 0s
1779 max_renewable_life = 7d 0h 0m 0s
1780 master_key_type = des3-hmac-sha1
1781 supported_enctypes = des3-hmac-sha1:normal des-cbc-crc:normal des-cbc-crc:v4
1785 kdc = FILE:@value{ROOTDIR}/var/krb5kdc/kdc.log
1786 admin_server = FILE:@value{ROOTDIR}/var/krb5kdc/kadmin.log
1791 @node Using DNS, Administrating the Kerberos Database, Configuration Files, Top
1795 * Mapping Hostnames onto Kerberos Realms::
1796 * Hostnames for KDCs::
1799 @node Mapping Hostnames onto Kerberos Realms, Hostnames for KDCs, Using DNS, Using DNS
1800 @section Mapping Hostnames onto Kerberos Realms
1802 @include dnstxt.texinfo
1804 @node Hostnames for KDCs, , Mapping Hostnames onto Kerberos Realms, Using DNS
1805 @section Hostnames for KDCs
1807 @include dnssrv.texinfo
1809 @node Administrating the Kerberos Database, Configuring Kerberos with OpenLDAP back-end, Using DNS, Top
1810 @chapter Administrating the Kerberos Database
1812 Your Kerberos database contains all of your realm's Kerberos principals,
1813 their passwords, and other administrative information about each
1814 principal. For the most part, you will use the @code{kdb5_util} program
1815 to manipulate the Kerberos database as a whole, and the @code{kadmin}
1816 program to make changes to the entries in the database. (One notable
1817 exception is that users will use the @code{kpasswd} program to change
1818 their own passwords.) The @code{kadmin} program has its own
1819 command-line interface, to which you type the database administrating
1822 @code{Kdb5_util} provides a means to create, delete, load, or dump a
1823 Kerberos database. It also includes a command to stash a copy of the
1824 master database key in a file on a KDC, so that the KDC can authenticate
1825 itself to the @code{kadmind} and @code{krb5kdc} daemons at boot time.
1827 @code{Kadmin} provides for the maintenance of Kerberos principals, KADM5
1828 policies, and service key tables (keytabs). It exists as both a
1829 Kerberos client, @code{kadmin}, using Kerberos authentication and an
1830 RPC, to operate securely from anywhere on the network, and as a local
1831 client, @code{kadmin.local}, intended to run directly on the KDC without
1832 Kerberos authentication. @code{kadmin.local} need not run on the kdc if
1833 the database is LDAP. Other than the fact that the remote client uses
1834 Kerberos to authenticate the person using it, the functionalities of the two
1835 versions are identical. The local version is necessary to enable you to set up
1836 enough of the database to be able to use the remote version.
1837 It replaces the now obsolete @code{kdb5_edit} (except for
1838 database dump and load, which are provided by @code{kdb5_util}).
1840 The remote version authenticates to the KADM5 server using the service
1841 principal @code{kadmin/admin}. If the credentials cache contains a
1842 ticket for the @code{kadmin/admin} principal, and the @samp{-c ccache}
1843 option is specified, that ticket is used to authenticate to KADM5.
1844 Otherwise, the @samp{-p} and @samp{-k} options are used to specify the
1845 client Kerberos principal name used to authenticate. Once kadmin has
1846 determined the principal name, it requests a @code{kadmin/admin}
1847 Kerberos service ticket from the KDC, and uses that service ticket to
1848 authenticate to KADM5.
1855 * Global Operations on the Kerberos Database::
1856 * Global Operations on the Kerberos LDAP Database::
1857 * Cross-realm Authentication::
1858 * Changing the krbtgt Key::
1861 @node Kadmin Options, Date Format, Administrating the Kerberos Database, Administrating the Kerberos Database
1862 @section Kadmin Options
1864 You can invoke @code{kadmin} or @code{kadmin.local} with any of the
1868 @item @b{-r} @i{REALM}
1869 Use @i{REALM} as the default Kerberos realm for the database.
1871 @item @b{-p} @i{principal}
1872 Use the Kerberos principal @i{principal} to authenticate to Kerberos.
1873 If this option is not given, @code{kadmin} will append @code{admin} to
1874 either the primary principal name, the environment variable USER, or to
1875 the username obtained from @code{getpwuid}, in order of preference.
1877 @item @b{-q} @i{query}
1878 Pass @i{query} directly to @code{kadmin}. This is useful for writing
1879 scripts that pass specific queries to @code{kadmin}.
1882 You can invoke @code{kadmin} with any of the following options:
1884 @item @b{-k} [@b{-t} @i{keytab}]
1885 Use the keytab @i{keytab} to decrypt the KDC response instead of
1886 prompting for a password on the TTY. In this case, the principal will
1887 be @samp{host/@i{hostname}}. If @b{-t} is not used to specify a keytab,
1888 then the default keytab will be used.
1890 @item @b{-c} @i{credentials cache}
1891 Use @i{credentials_cache} as the credentials cache. The credentials
1892 cache should contain a service ticket for the @code{kadmin/admin}
1893 service, which can be acquired with the @code{kinit} program. If this
1894 option is not specified, @code{kadmin} requests a new service ticket
1895 from the KDC, and stores it in its own temporary ccache.
1897 @item @b{-w} @i{password}
1898 Use @i{password} as the password instead of prompting for one on the
1899 TTY. Note: placing the password for a Kerberos principal with
1900 administration access into a shell script can be dangerous if
1901 unauthorized users gain read access to the script.
1903 @item @b{-x} @i{db_args}
1904 Specifies the database specific arguments.
1906 @item @b{-x} @i{host=<hostname>}
1907 Specifies the LDAP server to connect to by a LDAP URI. It is recommend to use
1908 ldapi:// or ldaps:// interface to connect to the LDAP server.
1910 @item @b{-x} @i{binddn=<bind_dn>}
1911 Specifies the Distinguished Name (DN) of the object used by the administration server to bind to the LDAP server. This object should have the read and write rights on the realm container, principal container and realm subtree.
1913 @item @b{-x} @i{bindpwd=<bind_password>}
1914 Specifies the password for the above mentioned binddn. It is recommended not to
1915 use this option. Instead, the password can be stashed using the
1916 stashsrvpw command of kdb5_ldap_util.
1918 Note: This database specific argument is applicable only to kadmin.local
1919 and the KADM5 server.
1921 @item @b{-s} @i{admin_server[:port]}
1922 Specifies the admin server that kadmin should contact.
1925 You can invoke @code{kadmin.local} with an of the follwing options:
1927 @item @b{-d_ @i{dbname}}
1928 Specifies the name of the Kerberos database.
1930 @item @b{-e} @i{"enctypes ..."}
1931 Sets the list of cryptosystem and salt types to be used for any new
1932 keys created. See @ref{Supported Encryption Types} and @ref{Salts} for
1936 Do not authenticate using a keytab. This option will cause kadmin to
1937 prompt for the master database password.
1941 @node Date Format, Principals, Kadmin Options, Administrating the Kerberos Database
1942 @section Date Format
1944 Many of the @code{kadmin} commands take a duration or time as an
1945 argument. The date can appear in a wide variety of formats, such as:
1962 "3/31/1992 10:00:07 PST"
1963 "January 23, 2007 10:05pm"
1968 Note that if the date specification contains spaces, you must enclose it
1969 in double quotes. Note also that you cannot use a number without a
1970 unit. (I.e., ``"60 seconds"'' is correct, but ``60'' is incorrect.)
1971 All keywords are case-insensitive. The following is a list of all of
1972 the allowable keywords.
1976 january, jan, february, feb, march, mar, april, apr, may, june, jun,
1977 july, jul, august, aug, september, sep, sept, october, oct, november,
1981 sunday, sun, monday, mon, tuesday, tues, tue, wednesday, wednes, wed,
1982 thursday, thurs, thur, thu, friday, fri, saturday, sat
1985 year, month, fortnight, week, day, hour, minute, min, second, sec
1988 tomorrow, yesterday, today, now, last, this, next, first, second,
1989 third, fourth, fifth, sixth, seventh, eighth, ninth, tenth, eleventh,
1993 @code{kadmin} recognizes abbreviations for most of the world's time
1994 zones. A complete listing appears in @ref{kadmin Time Zones}.
1996 @item 12-hour Time Delimiters
2000 @node Principals, Policies, Date Format, Administrating the Kerberos Database
2003 Each entry in the Kerberos database contains a Kerberos principal
2004 (@pxref{Definitions}) and the attributes and policies associated with
2008 * Retrieving Information About a Principal::
2010 * Adding or Modifying Principals::
2011 * Deleting Principals::
2012 * Changing Passwords::
2015 @node Retrieving Information About a Principal, Privileges, Principals, Principals
2016 @subsection Retrieving Information About a Principal
2020 * Retrieving a List of Principals::
2023 @node Attributes, Retrieving a List of Principals, Retrieving Information About a Principal, Retrieving Information About a Principal
2024 @subsubsection Attributes
2026 To retrieve a listing of the attributes and/or policies associated with
2027 a principal, use the @code{kadmin} @code{get_principal} command, which
2028 requires the ``inquire'' administrative privilege. The syntax is:
2031 @b{get_principal} @i{principal}
2035 The @code{get_principal} command has the alias @code{getprinc}.
2037 For example, suppose you wanted to view the attributes of the
2038 principal @* @code{@value{RANDOMUSER1}/root@@@value{PRIMARYREALM}}.
2044 @b{kadmin:} getprinc @value{RANDOMUSER1}/root
2045 @b{Principal: @value{RANDOMUSER1}/root@@@value{PRIMARYREALM}
2046 Expiration date: [never]
2047 Last password change: Mon Jan 31 02:06:40 EDT 2002
2048 Password Expiration date: [none]
2049 Maximum ticket life: 0 days 10:00:00
2050 Maximum renewable life: 7 days 00:00:00
2051 Last modified: Wed Jul 24 14:46:25 EDT 2002 (@value{ADMINUSER}/admin@@@value{PRIMARYREALM})
2052 Last successful authentication: Mon Jul 29 18:20:17 EDT 2002
2053 Last failed authentication: Mon Jul 29 18:18:54 EDT 2002
2054 Failed password attempts: 3
2056 Key: vno 2, Triple DES cbc mode with HMAC/sha1, no salt
2057 Key: vno 2, DES cbc mode with CRC-32, no salt
2058 Attributes: DISALLOW_FORWARDABLE, DISALLOW_PROXIABLE
2064 The @code{get_principal} command has a @code{-terse} option, which lists
2065 the fields as a quoted, tab-separated string. For example:
2069 @b{kadmin:} getprinc -terse @value{RANDOMUSER1}/root
2070 @b{@value{RANDOMUSER1}/root@@@value{PRIMARYREALM} 0 1027458564
2071 0 36000 (@value{ADMINUSER}/admin@@@value{PRIMARYREALM}
2072 1027536385 18 2 0 [none] 604800 1027980137
2073 1027980054 3 2 1 2 16 0 1
2079 @node Retrieving a List of Principals, , Attributes, Retrieving Information About a Principal
2080 @subsubsection Retrieving a List of Principals
2082 To generate a listing of principals, use the @code{kadmin}
2083 @code{list_principals} command, which requires the ``list'' privilege.
2087 @b{list_principals} [@i{expression}]
2090 @noindent where @i{expression} is a shell-style glob expression that
2091 can contain the characters @samp{*}, @samp{?}, @samp{[}, and @samp{]}.
2092 All policy names matching the expression are displayed. The
2093 @code{list_principals} command has the aliases @code{listprincs},
2094 @code{get_principals}, and @code{getprincs}. For example:
2098 @b{kadmin:} listprincs test*
2099 @b{test3@@@value{PRIMARYREALM}
2100 test2@@@value{PRIMARYREALM}
2101 test1@@@value{PRIMARYREALM}
2102 testuser@@@value{PRIMARYREALM}
2108 If no expression is provided, all principals are printed.
2110 @node Privileges, Adding or Modifying Principals, Retrieving Information About a Principal, Principals
2111 @subsection Privileges
2113 Administrative privileges for the Kerberos database are stored in the
2114 file @code{kadm5.acl}.
2116 @include kadm5acl.texinfo
2118 @node Adding or Modifying Principals, Deleting Principals, Privileges, Principals
2119 @subsection Adding or Modifying Principals
2121 To add a principal to the database, use the kadmin @code{add_principal}
2122 command, which requires the ``add'' administrative privilege. This
2123 function creates the new principal, prompting twice for a password, and,
2124 if neither the -policy nor -clearpolicy options are specified and the
2125 policy ``default'' exists, assigns it that policy. The syntax is:
2128 @b{kadmin:} add_principal [@i{options}] @i{principal}
2131 To modify attributes of a principal, use the kadmin
2132 @code{modify_principal} command, which requires the ``modify''
2133 administrative privilege. The syntax is:
2136 @b{kadmin:} modify_principal [@i{options}] @i{principal}
2140 @code{add_principal} has the aliases @code{addprinc} and
2141 @code{ank}@footnote{@code{ank} was the short form of the equivalent
2142 command using the deprecated @code{kadmin5} database administrative tool.
2143 It has been kept}. @code{modify_principal} has the alias @code{modprinc}.
2145 The @code{add_principal} and @code{modify_principal} commands take the
2149 @item @b{-x} @i{db_princ_args}
2150 Denotes the database specific options.
2152 The options for LDAP database are:
2154 @item @b{-x} @i{dn=<dn>}
2155 Specifies the LDAP object that will contain the Kerberos principal being created.
2157 @item @b{-x} @i{linkdn=<dn>}
2158 Specifies the LDAP object to which the newly created Kerberos principal object will point to.
2160 @item @b{-x} @i{containerdn=<container_dn>}
2161 Specifies the container object under which the Kerberos principal is to be created.
2163 @item @b{-x} @i{tktpolicy=<policy>}
2164 Associates a ticket policy to the Kerberos principal. Specifying an empty string
2165 value clears the ticket policy associated with the principal.
2169 * dn and containerdn options are not valid while modifying the principal.
2171 * containerdn and linkdn options cannot be specified with dn option.
2173 * If dn or containerdn options are not specified while adding the principal, the principals are created
2174 under the prinicipal container configured in the realm or the realm container.
2175 * dn and containerdn should be within the subtrees or principal container configured in the realm.
2178 @item -expire @i{date}
2179 Sets the expiration date of the principal to @i{date}.
2181 @item -pwexpire @i{date}
2182 Sets the expiration date of the password to @i{date}.
2184 @item -maxlife @i{maxlife}
2185 Sets the maximum ticket life of the principal to @i{maxlife}.
2187 @item -maxrenewlife @i{maxrenewlife}
2188 Sets the maximum renewable life of tickets for the principal to
2191 @item -kvno @i{number}
2192 Explicity sets the key version number to @i{number}. @value{COMPANY}
2193 does not recommend doing this unless there is a specific reason.
2195 @item -policy @i{policy}
2196 Sets the policy used by this principal. (@xref{Policies}.) With
2197 @code{modify_principal}, the current policy assigned to the principal is
2198 set or changed. With @code{add_principal}, if this option is not
2199 supplied, the -clearpolicy is not specified, and the policy ``default''
2200 exists, that policy is assigned. If a principal is created with no
2201 policy, @code{kadmin} will print a warning message.
2204 For @code{modify_principal}, removes the current policy from a
2205 principal. For @code{add_principal}, suppresses the automatic
2206 assignment of the policy ``default''.
2208 @item @{-|+@}allow_postdated
2209 The ``-allow_postdated'' option prohibits this principal from obtaining
2210 postdated tickets. ``+allow_postdated'' clears this flag. In effect,
2211 ``-allow_postdated'' sets the KRB5_KDB_DISALLOW_POSTDATED flag on the
2212 principal in the database.
2214 @item @{-|+@}allow_forwardable
2215 The ``-allow_forwardable'' option prohibits this principal from
2216 obtaining forwardable tickets. ``+allow_forwardable'' clears this flag.
2217 In effect, ``-allow_forwardable'' sets the KRB5_KDB_DISALLOW_FORWARDABLE
2218 flag on the principal in the database.
2220 @item @{-|+@}allow_renewable
2221 The ``-allow_renewable'' option prohibits this principal from obtaining
2222 renewable tickets. ``+allow_renewable'' clears this flag. In effect,
2223 ``-allow_renewable'' sets the KRB5_KDB_DISALLOW_RENEWABLE flag on the
2224 principal in the database.
2226 @item @{-|+@}allow_proxiable
2227 The ``-allow_proxiable'' option prohibits this principal from obtaining
2228 proxiable tickets. ``+allow_proxiable'' clears this flag. In effect,
2229 ``-allow_proxiable'' sets the @* KRB5_KDB_DISALLOW_PROXIABLE flag. on
2230 the principal in the database.
2232 @item @{-|+@}allow_dup_skey
2233 The ``-allow_dup_skey'' option disables user-to-user authentication for
2234 this principal by prohibiting this principal from obtaining a session
2235 key for another user. ``+allow_dup_skey'' clears this flag. In effect,
2236 ``-allow_dup_skey'' sets the @* KRB5_KDB_DISALLOW_DUP_SKEY flag on the
2237 principal in the database.
2239 @item @{-|+@}requires_preauth
2240 The ``+requires_preauth'' option requires this principal to
2241 preauthenticate before being allowed to kinit. -requires_preauth clears
2242 this flag. In effect, +requires_preauth sets the
2243 KRB5_KDB_REQUIRES_PRE_AUTH flag on the principal in the database.
2245 @item @{-|+@}requires_hwauth
2246 The ``+requires_hwauth'' flag requires the principal to preauthenticate
2247 using a hardware device before being allowed to kinit.
2248 ``-requires_hwauth'' clears this flag. In effect, ``+requires_hwauth''
2249 sets the KRB5_KDB_REQUIRES_HW_AUTH flag on the principal in the
2252 @item @{-|+@}allow_svr
2253 The ``-allow_svr'' flag prohibits the issuance of service tickets for
2254 this principal. ``+allow_svr'' clears this flag. In effect,
2255 ``-allow_svr'' sets the @* KRB5_KDB_DISALLOW_SVR flag on the principal
2258 @item @{-|+@}allow_tgs_req
2259 The ``-allow_tgs_req'' option specifies that a Ticket-Granting Service
2260 (TGS) request for a service ticket for this principal is not permitted.
2261 You will probably never need to use this option. ``+allow_tgs_req''
2262 clears this flag. The default is ``+allow_tgs_req''. In effect,
2263 ``-allow_tgs_req'' sets the KRB5_KDB_DISALLOW_TGT_BASED flag on the
2264 principal in the database.
2266 @item @{-|+@}allow_tix
2267 The ``-allow_tix'' option forbids the issuance of any tickets for this
2268 principal. ``+allow_tix'' clears this flag. The default is
2269 ``+allow_tix''. In effect, ``-allow_tix'' sets the @*
2270 KRB5_KDB_DISALLOW_ALL_TIX flag on the principal in the database.
2272 @item @{-|+@}needchange
2273 The ``+needchange'' option sets a flag in attributes field to force a
2274 password change; ``-needchange'' clears it. The default is
2275 ``-needchange''. In effect, ``+needchange'' sets the
2276 KRB5_KDB_REQUIRES_PWCHANGE flag on the principal in the database.
2278 @item @{-|+@}password_changing_service
2279 The ``+password_changing_service'' option sets a flag in the attributes
2280 field marking this principal as a password change service. (Again, you
2281 will probably never need to use this option.)
2282 ``-password_changing_service'' clears the flag. The default is
2283 ``-password_changing_service''. In effect, the
2284 ``+password_changing_service'' option sets the KRB5_KDB_PWCHANGE_SERVICE
2285 flag on the principal in the database.
2287 @item @{-|+@}ok_as_delegate
2288 The ``+ok_as_delegate'' option sets a flag in tickets issued for the
2289 service principal. Some client programs may recognize this flag as
2290 indicating that it is okay to delegate credentials to the service. If
2291 ok_as_delegate is set on a cross-realm TGT, it indicates that the
2292 foreign realm's ok_as_delegate flags should be honored by clients in
2293 the local realm. The default is ``-ok_as_delegate''.
2296 Sets the key for the principal to a random value (@code{add_principal}
2297 only). @value{COMPANY} recommends using this option for host keys.
2299 @item -pw @i{password}
2300 Sets the key of the principal to the specified string and does not
2301 prompt for a password (@code{add_principal} only). @value{COMPANY} does
2302 not recommend using this option.
2304 @item -e @i{enc:salt...}
2305 Uses the specified list of enctype-salttype pairs for setting the key
2306 of the principal. The quotes are necessary if there are multiple
2307 enctype-salttype pairs. This will not function against kadmin daemons
2308 earlier than krb5-1.2. See @ref{Supported Encryption Types} and
2309 @ref{Salts} for available types.
2312 If you want to just use the default values, all you need to do is:
2316 @b{kadmin:} addprinc @value{RANDOMUSER1}
2317 @b{WARNING: no policy specified for "@value{RANDOMUSER1}@@@value{PRIMARYREALM}";
2318 defaulting to no policy.}
2320 @b{Enter password for principal @value{RANDOMUSER1}@@@value{PRIMARYREALM}:} @i{@doubleleftarrow{} Type the password.}
2321 @b{Re-enter password for principal @value{RANDOMUSER1}@@@value{PRIMARYREALM}:} @i{@doubleleftarrow{} Type it again.}
2324 @b{Enter password for principal @value{RANDOMUSER1}@@@value{PRIMARYREALM}:} @i{<= Type the password.}
2325 @b{Re-enter password for principal @value{RANDOMUSER1}@@@value{PRIMARYREALM}:} @i{<=Type it again.}
2328 @b{Enter password for principal @value{RANDOMUSER1}@@@value{PRIMARYREALM}:} @i{<= Type the password.}
2329 @b{Re-enter password for principal @value{RANDOMUSER1}@@@value{PRIMARYREALM}:} @i{<=Type it again.}
2331 @b{Principal "@value{RANDOMUSER1}@@@value{PRIMARYREALM}" created.
2336 If you want to create a principal which is contained by a LDAP object, all you need to do is:
2340 @b{kadmin:} addprinc -x dn=cn=@value{RANDOMUSER1},dc=example,dc=com @value{RANDOMUSER1}
2341 @b{WARNING: no policy specified for "@value{RANDOMUSER1}@@@value{PRIMARYREALM}";
2342 defaulting to no policy.}
2344 @b{Enter password for principal @value{RANDOMUSER1}@@@value{PRIMARYREALM}:} @i{@doubleleftarrow{} Type the password.}
2345 @b{Re-enter password for principal @value{RANDOMUSER1}@@@value{PRIMARYREALM}:} @i{@doubleleftarrow{} Type it again.}
2348 @b{Enter password for principal @value{RANDOMUSER1}@@@value{PRIMARYREALM}:} @i{<= Type the password.}
2349 @b{Re-enter password for principal @value{RANDOMUSER1}@@@value{PRIMARYREALM}:} @i{<=Type it again.}
2352 @b{Enter password for principal @value{RANDOMUSER1}@@@value{PRIMARYREALM}:} @i{<= Type the password.}
2353 @b{Re-enter password for principal @value{RANDOMUSER1}@@@value{PRIMARYREALM}:} @i{<=Type it again.}
2355 @b{Principal "@value{RANDOMUSER1}@@@value{PRIMARYREALM}" created.
2360 If you want to create a principal under a specific LDAP container and link to an existing LDAP object, all you need to do is:
2364 @b{kadmin:} addprinc -x containerdn=dc=example,dc=com -x linkdn=cn=@value{RANDOMUSER2},dc=example,dc=com @value{RANDOMUSER2}
2365 @b{WARNING: no policy specified for "@value{RANDOMUSER2}@@@value{PRIMARYREALM}";
2366 defaulting to no policy.}
2368 @b{Enter password for principal @value{RANDOMUSER2}@@@value{PRIMARYREALM}:} @i{@doubleleftarrow{} Type the password.}
2369 @b{Re-enter password for principal @value{RANDOMUSER2}@@@value{PRIMARYREALM}:} @i{@doubleleftarrow{} Type it again.}
2372 @b{Enter password for principal @value{RANDOMUSER2}@@@value{PRIMARYREALM}:} @i{<= Type the password.}
2373 @b{Re-enter password for principal @value{RANDOMUSER2}@@@value{PRIMARYREALM}:} @i{<=Type it again.}
2376 @b{Enter password for principal @value{RANDOMUSER2}@@@value{PRIMARYREALM}:} @i{<= Type the password.}
2377 @b{Re-enter password for principal @value{RANDOMUSER2}@@@value{PRIMARYREALM}:} @i{<=Type it again.}
2379 @b{Principal "@value{RANDOMUSER2}@@@value{PRIMARYREALM}" created.
2384 If you want to associate a ticket policy to a principal, all you need to do is:
2388 @b{kadmin:} modprinc -x tktpolicy=userpolicy @value{RANDOMUSER2}
2389 @b{Principal "@value{RANDOMUSER2}@@@value{PRIMARYREALM}" modified.
2394 If, on the other hand, you want to set up an account that expires on
2395 January 1, 2000, that uses a policy called ``stduser'', with a temporary
2396 password (which you want the user to change immediately), you would type
2397 the following. (Note: each line beginning with @result{} is a
2398 continuation of the previous line.)
2403 @b{kadmin:} addprinc @value{RANDOMUSER2} -expire "1/1/2000 12:01am EST" -policy stduser
2404 @result{} +needchange
2406 @b{Enter password for principal @value{RANDOMUSER2}@@@value{PRIMARYREALM}:} @i{@doubleleftarrow{} Type the password.}
2407 @b{Re-enter password for principal
2408 @value{RANDOMUSER2}@@@value{PRIMARYREALM}:} @i{@doubleleftarrow{} Type it again.}
2411 @b{Enter password for principal @value{RANDOMUSER2}@@@value{PRIMARYREALM}:} @i{<= Type the password.}
2412 @b{Re-enter password for principal
2413 @value{RANDOMUSER2}@@@value{PRIMARYREALM}:} @i{<= Type it again.}
2416 @b{Enter password for principal @value{RANDOMUSER2}@@@value{PRIMARYREALM}:} @i{<= Type the password.}
2417 @b{Re-enter password for principal
2418 @value{RANDOMUSER2}@@@value{PRIMARYREALM}:} @i{<= Type it again.}
2420 @b{Principal "@value{RANDOMUSER2}@@@value{PRIMARYREALM}" created.
2426 If you will need cross-realm authentication, you need to add principals
2427 for the other realm's TGT to each realm. For example, if you need to
2428 do cross-realm authentication between the realms @value{PRIMARYREALM}
2429 and @value{SECONDREALM}, you would need to add the principals @*
2430 @samp{krbtgt/@value{SECONDREALM}@@@value{PRIMARYREALM}} and
2431 @samp{krbtgt/@value{PRIMARYREALM}@@@value{SECONDREALM}} to both
2432 databases. You need to be sure the passwords and the key version
2433 numbers (kvno) are the same in both databases. This may require
2434 explicitly setting the kvno with the @samp{-kvno} option. See
2435 @ref{Cross-realm Authentication} for more details.
2437 @node Deleting Principals, Changing Passwords, Adding or Modifying Principals, Principals
2438 @subsection Deleting Principals
2440 To delete a principal, use the kadmin @code{delete_principal} command,
2441 which requires the ``delete'' administrative privilege. The syntax is:
2444 @b{delete_principal} [@b{-force}] @i{principal}
2447 @noindent @code{delete_principal} has the alias @code{delprinc}. The
2448 @code{-force} option causes @code{delete_principal} not to ask if you're
2453 @b{kadmin:} delprinc @value{RANDOMUSER1}
2454 @b{Are you sure you want to delete the principal
2455 "@value{RANDOMUSER1}@@@value{PRIMARYREALM}"? (yes/no):} yes
2456 @b{Principal "@value{RANDOMUSER1}@@@value{PRIMARYREALM}" deleted.
2457 Make sure that you have removed this principal from
2458 all ACLs before reusing.
2463 @node Changing Passwords, , Deleting Principals, Principals
2464 @subsection Changing Passwords
2466 To change a principal's password use the kadmin @code{change_password}
2467 command, which requires the ``modify'' administrative privilege (unless
2468 the principal is changing his/her own password). The syntax is:
2471 @b{change_password} [@i{options}] @i{principal}
2474 @noindent The @code{change_password} option has the alias @code{cpw}.
2475 @code{change_password} takes the following options:
2479 Sets the key of the principal to a random value.
2481 @item @b{-pw} @i{password}
2482 Sets the password to the string @i{password}. @value{COMPANY} does not
2483 recommend using this option.
2485 @item @b{-e} @i{"enc:salt..."}
2486 Uses the specified list of enctype-salttype pairs for setting the key
2487 of the principal. The quotes are necessary if there are multiple
2488 enctype-salttype pairs. This will not function against kadmin daemons
2489 earlier than krb5-1.2. See @ref{Supported Encryption Types} and
2490 @ref{Salts} for possible values.
2493 Keeps the previous kvno's keys around. There is no easy way to delete
2494 the old keys, and this flag is usually not necessary except perhaps for
2495 TGS keys. Don't use this flag unless you know what you're doing. This
2496 option is not supported for the LDAP database
2506 @b{kadmin:} cpw @value{RANDOMUSER2}
2508 @b{Enter password for principal @value{RANDOMUSER2}@@@value{PRIMARYREALM}:} @i{@doubleleftarrow{} Type the new password.}
2509 @b{Re-enter password for principal @value{RANDOMUSER2}@@@value{PRIMARYREALM}:} @i{@doubleleftarrow{} Type it again.}
2512 @b{Enter password for principal @value{RANDOMUSER2}@@@value{PRIMARYREALM}:} @i{<= Type the new password.}
2513 @b{Re-enter password for principal @value{RANDOMUSER2}@@@value{PRIMARYREALM}:} @i{<= Type it again.}
2516 @b{Enter password for principal @value{RANDOMUSER2}@@@value{PRIMARYREALM}:} @i{<= Type the new password.}
2517 @b{Re-enter password for principal @value{RANDOMUSER2}@@@value{PRIMARYREALM}:} @i{<= Type it again.}
2519 @b{Password for @value{RANDOMUSER2}@@@value{PRIMARYREALM} changed.
2524 Note that @code{change_password} will not let you change the password to
2525 one that is in the principal's password history.
2527 @node Policies, Global Operations on the Kerberos Database, Principals, Administrating the Kerberos Database
2530 A policy is a set of rules governing passwords. Policies can dictate
2531 minimum and maximum password lifetimes, minimum number of characters and
2532 character classes a password must contain, and the number of old
2533 passwords kept in the database.
2536 * Retrieving Policies::
2537 * Retrieving the List of Policies::
2538 * Adding or Modifying Policies::
2539 * Deleting Policies::
2540 * Updating the History Key::
2543 @node Retrieving Policies, Retrieving the List of Policies, Policies, Policies
2544 @subsection Retrieving Policies
2546 To retrieve a policy, use the kadmin @code{get_policy} command, which
2547 requires the ``inquire'' administrative privilege. The syntax is:
2550 @b{get_policy} [@b{-terse}] @i{policy}
2553 The @code{get_policy} command has the alias @code{getpol}. For example:
2557 @b{kadmin:} get_policy admin
2559 Maximum password life: 180 days 00:00:00
2560 Minimum password life: 00:00:00
2561 Minimum password length: 6
2562 Minimum number of password character classes: 2
2563 Number of old keys kept: 5
2569 @noindent The @dfn{reference count} is the number of principals using
2572 The @code{get_policy} command has a @code{-terse} option, which lists
2573 each field as a quoted, tab-separated string. For example:
2577 @b{kadmin:} get_policy -terse admin
2578 @b{admin 15552000 0 6 2 5 17
2583 @node Retrieving the List of Policies, Adding or Modifying Policies, Retrieving Policies, Policies
2584 @subsection Retrieving the List of Policies
2586 You can retrieve the list of policies with the kadmin
2587 @code{list_policies} command, which requires the ``list'' privilege. The
2591 @b{list_policies} [@i{expression}]
2594 @noindent where @i{expression} is a shell-style glob expression that can
2595 contain the characters *, ?, and []. All policy names matching the
2596 expression are displayed. The @code{list_policies} command has the aliases
2597 @code{listpols}, @code{get_policies}, and @code{getpols}. For example:
2601 @b{kadmin:} listpols
2607 @b{kadmin:} listpols t*
2615 @node Adding or Modifying Policies, Deleting Policies, Retrieving the List of Policies, Policies
2616 @subsection Adding or Modifying Policies
2618 To add a new policy, use the kadmin @code{add_policy} command, which
2619 requires the ``add'' administrative privilege. The syntax is:
2622 @b{add_policy} [@i{options}] @i{policy_name}
2625 To modify attributes of a principal, use the kadmin @code{modify_policy}
2626 command, which requires the ``modify'' administrative privilege. The
2630 @b{modify_policy} [@i{options}] @i{policy_name}
2633 @noindent @code{add_policy} has the alias @code{addpol}.
2634 @code{modify_poilcy} has the alias @code{modpol}.
2636 The @code{add_policy} and @code{modify_policy} commands take the
2640 @item -maxlife @i{time}
2641 Sets the maximum lifetime of a password to @i{time}.
2643 @item -minlife @i{time}
2644 Sets the minimum lifetime of a password to @i{time}.
2646 @item -minlength @i{length}
2647 Sets the minimum length of a password to @i{length} characters.
2649 @item -minclasses @i{number}
2650 Requires at least @i{number} of character classes in a password.
2652 @item -history @i{number}
2653 Sets the number of past keys kept for a principal to @i{number}. This option is not supported for LDAP database.
2655 @c **** An example here would be nice. ****
2658 Note: The policies are created under realm container in the LDAP database.
2660 @node Deleting Policies, Updating the History Key, Adding or Modifying Policies, Policies
2661 @subsection Deleting Policies
2663 To delete a policy, use the @code{kadmin} @code{delete_policy} command,
2664 which requires the ``delete'' administrative privilege. The syntax is:
2667 @b{delete_policy [-force]} @i{policy_name}
2670 @noindent The @code{delete_policy} command has the alias @code{delpol}.
2671 It prompts for confirmation before deletion.
2676 @b{kadmin:} delete_policy guests
2677 @b{Are you sure you want to delete the policy "guests"?
2683 Note that you must cancel the policy from all principals before deleting
2684 it. The @code{delete_policy} command will fail if it is in use by any
2687 @node Updating the History Key, , Deleting Policies, Policies
2689 If a policy specifies a number of old keys kept of two or more, the
2690 stored old keys are encrypted in a history key, which is found in the
2691 key data of the kadmin/history principal.
2693 Currently there is no support for proper rollover of the history key,
2694 but you can change the history key (for example, to use a better
2695 encryption type) at the cost of invalidating currently stored old keys.
2696 To change the history key, run:
2700 @b{kadmin:} change_password -randkey kadmin/history
2704 This command will fail if you specify the @b{-keepold} flag. Only one
2705 new history key will be created, even if you specify multiple key/salt
2708 In the future, we plan to migrate towards encrypting old keys in the
2709 master key instead of the history key, and implementing proper rollover
2710 support for stored old keys.
2712 @node Global Operations on the Kerberos Database, Global Operations on the Kerberos LDAP Database, Policies, Administrating the Kerberos Database
2713 @section Global Operations on the Kerberos Database
2716 * Dumping a Kerberos Database to a File::
2717 * Restoring a Kerberos Database from a Dump File::
2718 * Creating a Stash File::
2719 * Creating and Destroying a Kerberos Database::
2722 The @code{kdb5_util} command is the primary tool for administrating the
2723 Kerberos database. The syntax is:
2726 @b{kdb5_util} @i{command} [@i{kdb5_util_options}] [@i{command_options}]
2729 The @code{kdb5_util} command takes the following options, which override
2730 the defaults specified in the configuration files:
2734 specifies the the Kerberos realm of the database.
2736 @itemx -d @i{database_name}
2737 specifies the name under which the principal database is stored.
2739 @itemx -k @i{master_key_type}
2740 specifies the key type of the master key in the database.
2742 @itemx -M @i{master_key_name}
2743 specifies the principal name of the master key in the database.
2746 indicates that the master database password should be read from the TTY
2747 rather than fetched from a file on disk.
2749 @itemx -sf @i{stash_file}
2750 specifies the stash file of the master database password
2752 @itemx -P @i{password}
2753 specifies the master database password. @value{COMPANY} does not
2754 recommend using this option.
2758 @node Dumping a Kerberos Database to a File, Restoring a Kerberos Database from a Dump File, Global Operations on the Kerberos Database, Global Operations on the Kerberos Database
2759 @subsection Dumping a Kerberos Database to a File
2761 To dump a Kerberos database into a file, use the @code{kdb5_util}
2762 @code{dump} command on one of the KDCs. The syntax is:
2765 @b{kdb5_util dump} [@b{-old}] [@b{-b6}] [@b{-b7}] [@b{-ov}]
2766 [@b{-verbose}] [-mkey_convert] [-new_mkey_file] [@i{filename}
2767 [@i{principals...}]]
2770 The @code{kdb5_util dump} command takes the following options:
2774 causes the dump to be in the Kerberos 5 Beta 5 and earlier dump format
2775 (``kdb5_edit load_dump version 2.0'').
2777 causes the dump to be in the Kerberos 5 Beta 6 format (``kdb5_edit
2778 load_dump version 3.0'').
2780 causes the dump to be in the Kerberos 5 Beta 7 format (``kdbt_edit
2781 load_dump version 4'').
2783 causes the dump to be in ovsec_adm_export format. Currently, the only
2784 way to preserve per-principal policy information is to use this in
2785 conjunction with a normal dump.
2787 causes the name of each principal and policy to be printed as it is
2789 @itemx -mkey_convert
2790 prompts for a new master password, and then dumps the database with
2791 all keys reencrypted in this new master key
2792 @itemx -new_mkey_file
2793 reads a new key from the default keytab and then dumps the database
2794 with all keys reencrypted in this new master key
2801 @b{shell%} kdb5_util dump dumpfile
2808 @b{shell%} kbd5_util dump -verbose dumpfile
2809 @b{kadmin/admin@@@value{PRIMARYREALM}
2810 krbtgt/@value{PRIMARYREALM}@@@value{PRIMARYREALM}
2811 kadmin/history@@@value{PRIMARYREALM}
2812 K/M@@@value{PRIMARYREALM}
2813 kadmin/changepw@@@value{PRIMARYREALM}
2819 If you specify which principals to dump, you must use the full
2820 principal, as in the following example. (The line beginning with
2821 @result{} is a continuation of the previous line.):
2825 @b{shell%} kdb5_util dump -verbose dumpfile K/M@@@value{PRIMARYREALM}
2826 @result{} kadmin/admin@@@value{PRIMARYREALM}
2827 @b{kadmin/admin@@@value{PRIMARYREALM}
2828 K/M@@@value{PRIMARYREALM}
2834 Otherwise, the principals will not match those in the database and will
2839 @b{shell%} kdb5_util dump -verbose dumpfile K/M kadmin/admin
2845 If you do not specify a dump file, @code{kdb5_util} will dump the
2846 database to the standard output.
2848 There is currently a bug where the default dump format omits the
2849 per-principal policy information. In order to dump all the data
2850 contained in the Kerberos database, you must perform a normal dump (with
2851 no option flags) and an additional dump using the ``-ov'' flag to a
2854 @node Restoring a Kerberos Database from a Dump File, Creating a Stash File, Dumping a Kerberos Database to a File, Global Operations on the Kerberos Database
2855 @subsection Restoring a Kerberos Database from a Dump File
2857 To restore a Kerberos database dump from a file, use the
2858 @code{kdb5_util} @code{load} command on one of the KDCs. The syntax
2862 @b{kdb5_util load} [@b{-old}] [@b{-b6}] [@b{-b7}] [@b{-ov}] [@b{-verbose}]
2863 [@b{-update}] [@b{-hash}] @i{dumpfilename} @i{dbname} [@i{admin_dbname}]
2866 The @code{kdb5_util load} command takes the following options:
2870 requires the dump to be in the Kerberos 5 Beta 5 and earlier dump format
2871 (``kdb5_edit load_dump version 2.0'').
2873 requires the dump to be in the Kerberos 5 Beta 6 format (``kdb5_edit
2874 load_dump version 3.0'').
2876 requires the dump to be in the Kerberos 5 Beta 7 format (``kdb5_edit
2877 load_dump version 4'').
2879 requires the dump to be in ovsec_adm_export format.
2881 causes the name of each principal and policy to be printed as it is
2884 causes records from the dump file to be updated in or added to the
2885 existing database. This is useful in conjunction with an
2886 ovsec_adm_export format dump if you want to preserve per-principal
2887 policy information, since the current default format does not contain
2890 causes the database to be stored as a hash rather than a binary tree.
2897 @b{shell%} kdb5_util load dumpfile principal
2904 @b{shell%} kdb5_util load -update dumpfile principal
2910 If the database file exists, and the @b{-update} flag was not given,
2911 @code{kdb5_util} will overwrite the existing database.
2913 @node Creating a Stash File, Creating and Destroying a Kerberos Database, Restoring a Kerberos Database from a Dump File, Global Operations on the Kerberos Database
2914 @subsection Creating a Stash File
2916 A stash file allows a KDC to authenticate itself to the database
2917 utilities, such as @code{kadmin}, @code{kadmind}, @code{krb5kdc}, and
2920 To create a stash file, use the @code{kdb5_util} @code{stash} command.
2924 @b{kdb5_util stash} [@b{-f} @i{keyfile}]
2931 @b{shell%} kdb5_util stash
2932 @b{kdb5_util: Cannot find/read stored master key while reading master key
2933 kdb5_util: Warning: proceeding without master key}
2935 @b{Enter KDC database master key:} @i{@doubleleftarrow{} Type the KDC database master password.}
2938 @b{Enter KDC database master key:} @i{<= Type the KDC database master password.}
2941 @b{Enter KDC database master key:} @i{<= Type the KDC database master password.}
2948 If you do not specify a stash file, @code{kdb5_util} will stash the key
2949 in the file specified in your @code{kdc.conf} file.
2951 @node Creating and Destroying a Kerberos Database, , Creating a Stash File, Global Operations on the Kerberos Database
2952 @subsection Creating and Destroying a Kerberos Database
2954 If you need to create a new Kerberos database, use the @code{kdb5_util}
2955 @code{create} command. The syntax is:
2958 @b{kdb5_util create} [@b{-s}]
2961 If you specify the @samp{-s} option, @code{kdb5_util} will stash a copy
2962 of the master key in a stash file. (@xref{Creating a Stash File}.) For
2967 @b{shell%} @value{ROOTDIR}/sbin/kdb5_util -r @value{PRIMARYREALM} create -s
2968 @b{kdb5_util: No such file or directory while setting active database to
2969 @result{} '@value{ROOTDIR}/var/krb5kdc/principal'
2970 Initializing database '@value{ROOTDIR}/var/krb5kdc/principal' for
2971 @result{} realm '@value{PRIMARYREALM}',
2972 master key name 'K/M@@@value{PRIMARYREALM}'
2973 You will be prompted for the database Master Password.
2974 It is important that you NOT FORGET this password.}
2976 @b{Enter KDC database master key:} @i{@doubleleftarrow{} Type the master password.}
2977 @b{Re-enter KDC database master key to verify:} @i{@doubleleftarrow{} Type it again.}
2980 @b{Enter KDC database master key:} @i{<= Type the master password.}
2981 @b{Re-enter KDC database master key to verify:} @i{<= Type it again.}
2984 @b{Enter KDC database master key:} @i{<= Type the master password.}
2985 @b{Re-enter KDC database master key to verify:} @i{<= Type it again.}
2991 If you need to destroy the current Kerberos database, use the
2992 @code{kdb5_util} @code{destroy} command. The syntax is:
2995 @b{kdb5_util destroy} [@b{-f}]
2998 The @code{destroy} command destroys the database, first overwriting the
2999 disk sectors and then unlinking the files. If you specify the
3000 @samp{-f} option, @code{kdb5_util} will not prompt you for a
3001 confirmation before destroying the database.
3005 @b{shell%} @value{ROOTDIR}/sbin/kdb5_util -r @value{PRIMARYREALM} destroy
3007 @b{kdb5_util: Deleting KDC database stored in @value{DefaultDatabaseName}, are you sure
3008 (type yes to confirm)?} @i{@doubleleftarrow{}yes}
3011 @b{kdb5_util: Deleting KDC database stored in @value{DefaultDatabaseName}, are you sure
3012 (type yes to confirm)?} @i{<== yes}
3015 @b{kdb5_util: Deleting KDC database stored in @value{DefaultDatabaseName}, are you sure
3016 (type yes to confirm)?} @i{<== yes}
3018 @b{OK, deleting database '@value{DefaultDatabaseName}'...}
3024 @node Global Operations on the Kerberos LDAP Database, Cross-realm Authentication, Global Operations on the Kerberos Database, Administrating the Kerberos Database
3025 @section Global Operations on the Kerberos LDAP Database
3028 The @code{kdb5_ldap_util} is the primary tool for administrating the Kerberos LDAP database. It allows an administrator to manage realms, Kerberos services ( KDC and Admin Server) and ticket policies.
3032 @b{kdb5_ldap_util} [@b{-D user_dn} [@i{-w passwd]}] [@b{-H} @i{ldap_uri}] command @i{[command_options]}
3036 @itemx -D @i{user_dn}
3037 Specifies the Distinguished Name (DN) of the user who has sufficient rights to perform the operation on the LDAP server.
3038 @itemx @b{-w} @i{passwd}
3039 Specifies the password of user_dn. This option is not recommended.
3040 @itemx @b{-H} @i{ldap_uri}
3041 Specifies the URI of the LDAP server. It is recommended to use ldapi:// or ldaps:// to connect to the LDAP server.
3044 * Creating a Kerberos Realm::
3045 * Modifying a Kerberos Realm::
3046 * Retrieving Information about a Kerberos Realm::
3047 * Destroying a Kerberos Realm::
3048 * Listing available Kerberos Realms::
3049 * Stashing Service Object's Password::
3050 * Creating and Modifying a Ticket Policy::
3051 * Retrieving Information About a Ticket Policy::
3052 * Destroying a Ticket Policy::
3053 * Listing available Ticket Policies::
3054 * Creating a Service Object (eDirectory)::
3055 * Modifying a Service Object (eDirectory)::
3056 * Retrieving Service Object Information (eDirectory)::
3057 * Destroying a Service Object (eDirectory)::
3058 * Listing Available Service Objects (eDirectory)::
3059 * Passwords for Service Objects (eDirectory)::
3062 @node Creating a Kerberos Realm, Modifying a Kerberos Realm, Global Operations on the Kerberos LDAP Database, Global Operations on the Kerberos LDAP Database
3063 @subsection Creating a Kerberos Realm
3065 If you need to create a new realm, use the command as follows:
3068 @b{create} [@b{-r} @i{realm}] [@b{-subtrees} @i{subtree_dn_list}] [@b{-sscope} @i{search_scope}] [@b{-containerref} @i{container_reference_dn}]
3069 [@b{-k} @i{ mkeytype}] [@b{-m}|@b{-P} @i{password}][@b{-sf} @i{stashlename}] [@b{-s}] [@b{-maxtktlife} @i{max_ticket_life}]
3070 [@b{-maxrenewlife} @i{ max_renewable_ticket_life}] [@b{ticket_flags}]
3075 Options to create realm in directory are as follows:
3079 @itemx @b{-r} @i{realm}
3080 Specifies the Kerberos realm of the database; by default the realm returned by @samp{krb5_default_local_realm} (3) is used.
3082 @itemx @b{-subtrees} @i{subtree_dn_list}
3083 Specifies the list of subtrees containing principals of a realm. The list contains the DN of the subtree objects separated by colon(:).
3085 @itemx @b{-sscope} @i{search_scope}
3086 Specifies the scope for searching the principals under the subtree. The possible values are 1 or one (one level), 2 or sub (subtree).
3088 @itemx @b{-containerref} @i{container_reference_dn}
3089 Specfies the DN of the container object in which the principals of a realm will be created. If the container reference is not configured for a realm, the principals will be created in the realm container.
3091 @itemx @b{-k} @i{mkeytype}
3092 Specifies the key type of the master key in the database; the default
3093 is that given in @file{kdc.conf}.
3096 Specifies that the master database password should be read from the TTY rather than fetched from a file on disk.
3098 @itemx @b{-p} @i{password}
3099 Specifies the master database password. This option is not recommended.
3101 @itemx @b{-sf} @i{stashfilename}
3102 Specifies the stash file of the master database password.
3105 Specifies that the stash file is to be created.
3107 @itemx @b{-maxtktlife} @i{max_ticket_life}
3108 Specifies maximum ticket life for principals in this realm. This value is used, if it is not set on the principal.
3110 @itemx @b{-maxrenewlife} @i{max_renewable_ticket_life}
3111 Specifies maximum renewable life of tickets for principals in this realm. This value is used, if it is not set on the principal.
3113 @itemx @b{ticket_flags} @i{}
3114 Specifies the ticket flags. If this option is not specified, by default, none of the flags are set. This means all the ticket options will be allowed and no restriction will be set. This value is used, if it is not set on the principal.
3117 The various flags are:
3120 @itemx @{-|+@}allow_postdated
3121 @code{-allow_postdated} prohibits principals from obtaining postdated tickets. (Sets the @samp{KRB5_KDB_DISALLOW_POSTDATED} flag.).@code{+allow_postdated} clears this flag.
3123 @itemx @{-|+@}allow_forwardable
3124 @code{-allow_forwardable} prohibits principals from obtaining forwardable tickets. (Sets the
3125 @samp{KRB5_KDB_DISALLOW_FORWARDABLE} flag.) @code{+allow_forwardable} clears this flag.
3127 @itemx @{-|+@}allow_renewable
3128 @code{-allow_renewable} prohibits principals from obtaining renewable tickets. (Sets the @samp{KRB5_KDB_DISALLOW_RENEWABLE} flag.) @code{+allow_renewable} clears this flag.
3130 @itemx @{-|+@}allow_proxiable
3131 @code{-allow_proxiable} prohibits principals from obtaining proxiable tickets. (Sets the @samp{KRB5_KDB_DISALLOW_PROXABLE} flag.) @code{+allow_proxiable} clears this flag.
3133 @itemx @{-|+@}allow_dup_skey
3134 @code{-allow_dup_skey} disables user-to-user authentication for
3135 principals by prohibiting principals from obtaining a sessions key for
3136 another user. (Sets the @samp{KRB5_KDB_DISALLOW_DUP_SKEY} flag.)
3137 @code{+allow_dup_skey} clears this flag.
3139 @itemx @{-|+@}requires_preauth
3140 @code{+requires_preauth} requires principals to preauthenticate before being allowed to kinit. (Sets the @samp{KRB5_KDB_REQURES_PRE_AUTH} flag.) @code{-requires_preauth} clears this flag.
3142 @itemx @{-|+@}requires_hwauth
3143 @code{+requires_hwauth} requires principals to preauthenticate using a
3144 hardware device before being allowed to kinit. (Sets the
3145 @samp{KRB5_KDB_REQURES_HW_AUTH} flag.) @code{-requires_hwauth} clears
3148 @itemx @{-|+@}ok_as_delegate
3149 @code{+ok_as_delegate} sets the OK-AS-DELEGATE flag on tickets issued for use
3150 with this principal as the service, which clients may use as a hint that
3151 credentials can and should be delegated when authenticating to the service.
3152 (Sets the @samp{KRB5_KDB_OK_AS_DELEGATE} flag.) @code{-ok_as_delegate} clears
3155 @itemx @{-|+@}allow_svr
3156 @code{-allow_svr} prohibits the issuance of service tickets for principals. (Sets the @samp{KRB5_KDB_DISALLOW_SVR} flag.) @code{+allow_svr} clears this flag.
3158 @itemx @{-|+@}allow_tgs_req
3159 @code{-allow_tgs_req} specifies that a @dfn{Ticket-Granting Service
3160 (TGS)} request for a service ticket for principals is not
3161 permitted. This option is useless for most
3162 things.@code{+allow_tgs_req} clears this flag. The default is
3163 @code{+allow_tgs_req}. In effect, @code{-allow_tgs_req} sets the
3164 @samp{KRB5_KDB_DISALLOW_TGT_BASED} flag on principals in the
3167 @itemx @{-|+@}allow_tix
3168 @code{-allow_tix} forbids the issuance of any tickets for
3169 principals. @code{+allow_tix} clears this flag. The default is
3170 @code{+allow_tix}. In effect, @code{-allow_tix} sets the
3171 @samp{KRB5_KDB_DISALLOW_ALL_TIX} flag on principals in the database.
3173 @itemx @{-|+@}needchange
3174 @code{+needchange} sets a flag in attributes field to force a password change;
3175 @code{-needchange} clears it. The default is @code{-needchange}. In effect,
3176 @code{+needchange} sets the @samp{KRB5_KDB_REQURES_PWCHANGE} flag on
3177 principals in the database.
3179 @itemx @{-|+@}password_changing_service
3180 @code{+password_changing_service} sets a flag in the attributes field
3181 marking principal as a password change service principal (useless for
3182 most things). @code{-password_changing_service} clears the flag. This
3183 flag intentionally has a long name. The default is
3184 @code{-password_changing_service}. In effect,
3185 @code{+password_changing_service} sets the
3186 @samp{KRB5_KDB_PWCHANGE_SERVICE} flag on principals in the database.
3194 shell% kdb5_ldap_util -D cn=admin,dc=example,dc=com -H ldaps://ldap-server1.mit.edu create -sscope 2
3195 -subtree ou=users,dc=example,dc=com -r ATHENA.MIT.EDU
3196 @b{Password for "cn=admin,dc=example,dc=com":}
3197 @b{Initializing database for realm 'ATHENA.MIT.EDU'}
3198 @b{You will be prompted for the database Master Password.}
3199 @b{It is important that you NOT FORGET this password.}
3200 @b{Enter KDC database master key:}
3201 @b{Re-enter KDC database master key to verify:}
3206 * eDirectory Options (Creating a Kerberos Realm)::
3208 @node eDirectory Options (Creating a Kerberos Realm), , Creating a Kerberos Realm, Creating a Kerberos Realm
3210 @subsubsection eDirectory Options
3213 @itemx @b{-kdcdn} @i{kdc_servce_list}
3214 Specifies the list of KDC service objects serving the realm. The list contains the DNs of the KDC service objects separated by colon(:).
3216 @itemx @b{-admindn} @i{admin_service_list}
3217 Specifies the list of Administration service objects serving the realm. The list contains the DNs of the Administration service objects separated by colon(:).
3222 shell% kdb5_ldap_util -D cn=admin,dc=example,dc=com -H ldaps://ldap-server1.mit.edu create -sscope 2
3223 -subtree ou=users,dc=example,dc=com -kdcdn cn=krbkdc,dc=example,dc=com -admindn cn=krbadmin,dc=example,dc=com -r ATHENA.MIT.EDU
3224 @b{Password for "cn=admin,dc=example,dc=com":}
3225 @b{Initializing database for realm 'ATHENA.MIT.EDU'}
3226 @b{You will be prompted for the database Master Password.}
3227 @b{It is important that you NOT FORGET this password.}
3228 @b{Enter KDC database master key:}
3229 @b{Re-enter KDC database master key to verify:}
3234 @node Modifying a Kerberos Realm, Retrieving Information about a Kerberos Realm, Creating a Kerberos Realm, Global Operations on the Kerberos LDAP Database
3235 @subsection Modifying a Kerberos Realm
3237 If you need to modify a realm, use the command as follows:
3241 @b{modify} [@b{-r} @i{realm}] [@b{-subtrees} @i{subtree_dn}] [@b{-sscope} @i{search_scope}][@b{-containerref} @i{container_reference_dn}]
3242 [@b{-maxtktlife}@i{max_ticket_life}][@b{-maxrenewlife} @i{max_renewable_ticket_life}] [@b{-ticket_flags}]
3245 Options to modify realm in directory are as follows:
3249 @itemx @b{-r} @i{realm}
3250 Specifies the Kerberos realm of the database; by default the realm returned by krb5_default_local_realm (3) is used.
3252 @itemx @b{-subtrees} @i{subtree_dn_list}
3253 Specifies the list of subtrees containing principal objects in the realm.The list contains the DN of the subtree objects separated by colon(:). This list replaces the existing list.
3255 @itemx @b{-sscope} @i{search_scope}
3256 Specifies the scope for searching the principals under the subtrees. The possible values are 1 or one (one level), 2 or sub (subtrees).
3258 @itemx @b{-containerref} @i{container_reference_dn}
3259 Specifies the Distinguished Name (DN) of the container object in which the principals of a realm will be created.
3261 @itemx @b{-maxtktlife} @i{max_ticket_life}
3262 Specifies maximum ticket life for principals in this realm. This value is used, if it is not set on the principal.
3264 @itemx @b{-maxrenewlife} @i{max_renewable_ticket_life}
3265 Specifies maximum renewable life of tickets for principals in this realm. This value is used, if it is not set on the principal.
3267 @itemx @b{-ticket_flags} @i{}
3268 Specifies the ticket flags. If this option is not specified, by default, none of the flags are set. This means all the ticket options will be allowed and no restriction will be set. This value is used, if it is not set on the principal.
3271 The various flags are:
3274 @itemx @{-|+@}allow_postdated
3275 @code{-allow_postdated} prohibits principals from obtaining postdated tickets. (Sets the @samp{KRB5_KDB_DISALLOW_POSTDATED} flag.).@code{+allow_postdated} clears this flag.
3276 @itemx @{-|+@}allow_forwardable
3277 @code{-allow_forwardable} prohibits principals from obtaining forwardable tickets.
3278 (Sets the @samp{KRB5_KDB_DISALLOW_FORWARDABLE} flag.) @code{+allow_forwardable} clears this flag.
3279 @itemx @{-|+@}allow_renewable
3280 @code{-allow_renewable} prohibits principals from obtaining renewable tickets. (Sets the @samp{KRB5_KDB_DISALLOW_RENEWABLE} flag.) @code{+allow_renewable} clears this flag.
3281 @itemx @{-|+@}allow_proxiable
3282 @code{-allow_proxiable} prohibits principals from obtaining proxiable tickets. (Sets the @samp{KRB5_KDB_DISALLOW_PROXABLE} flag.) @code{+allow_proxiable} clears this flag.
3283 @itemx @{-|+@}allow_dup_skey
3284 @code{-allow_dup_skey} Disables user-to-user authentication for principals by prohibiting principals from obtaining a sessions key for another user. (Sets the @samp{KRB5_KDB_DISALLOW_DUP_SKEY} flag.). @code{+allow_dup_skey} clears This flag.
3285 @itemx @{-|+@}requires_preauth
3286 @code{+requires_preauth} requires principals to preauthenticate before being allowed to kinit. Sets the
3287 @samp{KRB5_KDB_REQURES_PRE_AUTH} flag.@code{-requires_preauth} clears this flag.
3288 @itemx @{-|+@}requires_hwauth
3289 @code{+requires_hwauth} requires principals to preauthenticate using a hardware device before being allowed to kinit. (Sets the
3290 @samp{KRB5_KDB_REQURES_HW_AUTH} flag.)@code{-requires_hwauth} clears this flag.
3291 @itemx @{-|+@}allow_svr
3292 @code{-allow_svr} prohibits the issuance of service tickets for principals. (Sets the @samp{KRB5_KDB_DISALLOW_SVR} flag.) @code{+allow_svr} clears This flag.
3293 @itemx @{-|+@}allow_tgs_req
3294 @code{-allow_tgs_req} specifies that a @dfn{Ticket-Granting Service (TGS)} request for a service ticket for principals is not permitted. This option is useless for most things.@code{+allow_tgs_req} clears this flag.
3295 The default is. @code{+allow_tgs_req}. In effect,
3296 @code{-allow_tgs_req} sets the @samp{KRB5_KDB_DISALLOW_TGT_BASED} flag
3297 on principals in the database.
3298 @itemx @{-|+@}allow_tix
3299 @code{-allow_tix} forbids the issuance of any tickets for
3300 principals. @code{+allow_tix} clears this flag. The default is
3301 @code{+allow_tix}. In effect, @code{-allow_tix} sets the
3302 @samp{KRB5_KDB_DISALLOW_ALL_TIX} flag on principals in the database.
3303 @itemx @{-|+@}needchange
3304 @code{+needchange} sets a flag in attributes field to force a password change; @code{-needchange} clears it.
3305 The default is @code{-needchange}. In effect,@code{+needchange} sets
3306 the @samp{KRB5_KDB_REQURES_PWCHANGE} flag on principals in the
3308 @itemx @{-|+@}password_changing_service
3309 @code{+password_changing_service} sets a flag in the attributes field marking principal as a password change service principal (useless for most things).@code{-password_changing_service} clears the flag. This flag intentionally has a long name. The default is @code{-password_changing_service}
3310 In effect, @code{+password_changing_service} sets the @samp{KRB5_KDB_PWCHANGE_SERVICE} flag on principals in the database.
3319 shell% kdb5_ldap_util -D cn=admin,dc=example,dc=com -H ldaps://ldap-server1.mit.edu
3320 modify -r ATHENA.MIT.EDU +requires_preauth
3321 @b{Password for "cn=admin,dc=example,dc=com":}
3327 * eDirectory Options (Modifying a Kerberos Realm)::
3332 @node eDirectory Options (Modifying a Kerberos Realm), , Modifying a Kerberos Realm, Modifying a Kerberos Realm
3333 @subsubsection eDirectory Options
3336 @itemx @b{-kdcdn} @i{kdc_service_list}
3337 Specifies the list of KDC service objects serving the realm. The list contains the DNs of the KDC service objects separated by a colon (:). This list replaces the existing list.
3339 @itemx @b{-clearkdcdn} @i{kdc_service_list}
3340 Specifies the list of KDC service objects that need to be removed from the existing list. The list contains the DNs of the KDC service objects separated by a colon (:).
3342 @itemx @b{-addkdcdn} @i{kdc_service_list}
3343 Specifies the list of KDC service objects that need to be added to the existing list. The list contains the DNs of the KDC service objects separated by a colon (:).
3345 @itemx @b{-admindn} @i{admin_service_list}
3346 Specifies the list of Administration service objects serving the realm. The list contains the DNs of the Administration service objects separated by a colon (:). This list replaces the existing list.
3348 @itemx @b{-clearadmindn} @i{admin_service_list}
3349 Specifies the list of Administration service objects that need to be removed from the existing list. The list contains the DNs of the Administration service objects separated by a colon (:).
3351 @itemx @b{-addadmindn} @i{admin_service_list}
3352 Specifies the list of Administration service objects that need to be added to the existing list. The list contains the DNs of the Administration service objects separated by a colon (:).
3356 @node Retrieving Information about a Kerberos Realm, Destroying a Kerberos Realm, Modifying a Kerberos Realm, Global Operations on the Kerberos LDAP Database
3357 @subsection Retrieving Information about a Kerberos Realm
3360 @itemx @b{view} [@b{-r} @i{realm}]
3361 Displays the attributes of a realm. Option is as follows:
3362 @itemx @b{-r} @i{realm}
3363 specifies the Kerberos realm of the database; by default the realm returned by krb5_default_local_realm (3)is used.
3369 shell% kdb5_ldap_util -D cn=admin,dc=example,dc=com -H ldaps://ldap-server1.mit.edu view -r ATHENA.MIT.EDU
3370 @b{Password for "cn=admin,dc=example,dc=com":}
3371 @b{Realm Name: ATHENA.MIT.EDU}
3372 @b{Subtree: ou=users,dc=example,dc=com}
3373 @b{Subtree: ou=servers,dc=example,dc=com}
3374 @b{SearchScope: ONE}
3375 @b{Maximum ticket life: 0 days 01:00:00}
3376 @b{Maximum renewable life: 0 days 10:00:00}
3377 @b{Ticket flags: DISALLOW_FORWARDABLE}
3383 @node Destroying a Kerberos Realm, Listing available Kerberos Realms, Retrieving Information about a Kerberos Realm, Global Operations on the Kerberos LDAP Database
3384 @subsection Destroying a Kerberos Realm
3387 @itemx destroy @b{[-f]} [@i{-r} @b{realm}]
3388 Destroys an existing realm. Options are as follows:
3391 If specified, will not prompt the user for confirmation.
3392 @itemx @b{-r} @i{realm}
3393 specifies the Kerberos realm of the database; by default the realm returned by
3394 @samp{krb5_default_local_realm} (3)is used.
3402 shell% kdb5_ldap_util -D cn=admin,dc=example,dc=com -H ldap-server1.mit.edu destroy -r ATHENA.MIT.EDU
3403 @b{Password for "cn=admin,dc=example,dc=com":}
3404 @b{Deleting KDC database of 'ATHENA.MIT.EDU', are you sure?}
3405 @b{type 'yes' to confirm)? Yes}
3406 @b{OK, deleting database of 'ATHENA.MIT.EDU'...}
3411 @node Listing available Kerberos Realms, Stashing Service Object's Password, Destroying a Kerberos Realm, Global Operations on the Kerberos LDAP Database
3412 @subsection Listing available Kerberos Realms
3416 This option lists the name of the realms.
3422 shell% kdb5_ldap_util -D cn=admin,dc=example,dc=com -H ldaps://ldap-server1.mit.edu list
3423 @b{Password for "cn=admin,dc=example,dc=com":}
3425 @b{OPENLDAP.MIT.EDU}
3426 @b{MEDIA-LAB.MIT.EDU}
3431 @node Stashing Service Object's Password, Creating and Modifying a Ticket Policy, Listing available Kerberos Realms, Global Operations on the Kerberos LDAP Database
3432 @subsection Stashing Service Object's Password
3434 @b{stashsrvpw} [@b{-f} @i{filename}] @b{servicedn}
3436 This command allows an administrator to store the password of service object in a file. The KDC and Administration server uses this password to authenticate to the LDAP server.
3438 Options are as follows:
3441 @itemx @b{-f} @i{filename}
3442 Specifies the complete path of the service password file. By default, @code{/usr/local/var/service_passwd} is used.
3444 Specifies the Distinguished Name (DN) of the service object whose password is to be stored in file.
3450 shell% kdb5_ldap_util stashsrvpw -f /home/andrew/conf_keyle cn=service-kdc,dc=example,dc=com
3451 @b{Password for "cn=service-kdc,dc=example,dc=com"}:
3452 @b{Re-enter password for "cn=service-kdc,dc=example,dc=com"}:
3457 @node Creating and Modifying a Ticket Policy, Retrieving Information About a Ticket Policy, Stashing Service Object's Password, Global Operations on the Kerberos LDAP Database
3458 @subsection Creating and Modifying a Ticket Policy
3460 This command creates a ticket policy in directory.
3463 @b{create_policy} [@b{-r} @i{realm}] [@b{-maxrenewlife} @i{max_renewable_ticket_life}] [@b{ticket_flags}] @b{policy_name}
3465 Ticket policy objects are created under the realm container.
3467 This command modifies a ticket policy in directory.
3469 @b{modify_policy} [@b{-r} @i{realm}] [@b{-maxrenewlife} @i{max_renewable_ticket_life}] [@b{ticket_flags}] @b{policy_name}
3472 Options are as follows:
3476 @itemx @b{-r} @i{realm}
3477 Specifies the Kerberos realm of the database; by default the realm returned by krb5_default_local_realm(3) is used.
3478 @itemx @b{-maxtktlife} @i{max_ticket_life}
3479 specifies maximum ticket life for principals.
3480 @itemx @b{-maxrenewlife} @i{max_renewable_ticket_life}
3481 specifies maximum renewable life of tickets for principals.
3483 @itemx @b{ticket_flags}
3484 Specifies the ticket flags. If this option is not specified, by default, none of the flags are set. This means all the ticket options will be allowed and no restriction will be set.
3487 The various flags are:
3489 @itemx @{-|+@}allow_postdated
3490 @code{-allow_postdated} prohibits principals from obtaining postdated tickets. (Sets the @samp{KRB5_KDB_DISALLOW_POSTDATED} flag.).@code{+allow_postdated} clears this flag.
3492 @itemx @{-|+@}allow_forwardable
3494 @code{-allow_forwardable} prohibits principals from obtaining forwardable tickets. (Sets the
3495 @samp{KRB5_KDB_DISALLOW_FORWARDABLE} flag.) @code{+allow_forwardable} clears this flag.
3497 @itemx @{-|+@}allow_renewable
3498 @code{-allow_renewable} prohibits principals from obtaining renewable tickets. (Sets the @samp{KRB5_KDB_DISALLOW_RENEWABLE} flag.) @code{+allow_renewable} clears this flag.
3499 @itemx @{-|+@}allow_proxiable
3500 @code{-allow_proxiable} prohibits principals from obtaining proxiable tickets. (Sets the @samp{KRB5_KDB_DISALLOW_PROXABLE} flag.) @code{+allow_proxiable} clears this flag.
3501 @itemx @{-|+@}allow_dup_skey
3502 @code{-allow_dup_skey} Disables user-to-user authentication for principals by prohibiting principals from obtaining a sessions key for another user. (Sets the @samp{KRB5_KDB_DISALLOW_DUP_SKEY} flag.). @code{+allow_dup_skey} clears This flag.
3503 @itemx @{-|+@}requires_preauth
3504 @code{+requires_preauth} requires principals to preauthenticate before being allowed to kinit. (Sets the @samp{KRB5_KDB_REQURES_PRE_AUTH} flag.)
3505 @code{-requires_preauth} clears this flag.
3507 @itemx @{-|+@}requires_hwauth
3508 @code{+requires_hwauth} requires principals to preauthenticate using a
3509 hardware device before being allowed to kinit. (Sets the
3510 @samp{KRB5_KDB_REQURES_HW_AUTH} flag.) @code{-requires_hwauth} clears
3513 @itemx @{-|+@}allow_svr
3514 @code{-allow_svr} prohibits the issuance of service tickets for principals. (Sets the @samp{KRB5_KDB_DISALLOW_SVR} flag.) @code{+allow_svr} clears This flag.
3515 @itemx @{-|+@}allow_tgs_req
3516 @code{-allow_tgs_req} specifies that a @dfn{Ticket-Granting Service (TGS)} request for a service ticket for principals is not permitted. This option is useless for most things.@code{+allow_tgs_req} clears this flag.
3517 The default is @code{+allow_tgs_req}. In effect,
3518 @code{-allow_tgs_req} sets the @samp{KRB5_KDB_DISALLOW_TGT_BASED} flag
3519 on principals in the database.
3521 @itemx @{-|+@}allow_tix
3522 @code{-allow_tix} forbids the issuance of any tickets for
3523 principals. @code{+allow_tix} clears this flag. The default is
3524 @code{+allow_tix}. In effect, @code{-allow_tix} sets the
3525 @samp{KRB5_KDB_DISALLOW_ALL_TIX} flag on principals in the database.
3527 @itemx @{-|+@}needchange
3528 @code{+needchange} sets a flag in attributes field to force a password change;
3529 @code{-needchange} clears it. The default is @code{-needchange}. In
3530 effect, @code{+needchange} sets the @samp{KRB5_KDB_REQURES_PWCHANGE}
3531 flag on principals in the database.
3533 @itemx @{-|+@}password_changing_service
3534 @code{+password_changing_service} sets a flag in the attributes field
3535 marking principal as a password change service principal (useless for
3536 most things). @code{-password_changing_service} clears the flag.
3537 This flag intentionally has a long name. The default is
3538 @code{-password_changing_service}. In effect,
3539 @code{+password_changing_service} sets the
3540 @samp{KRB5_KDB_PWCHANGE_SERVICE} flag on principals in the database.
3544 Specifies the name of the ticket policy.
3551 shell% kdb5_ldap_util -D cn=admin,dc=example,dc=com -H ldaps://ldap-server1.mit.edu create_policy
3552 -r ATHENA.MIT.EDU -maxtktlife "1 day" -maxrenewlife "1 week" -allow_forwardable usertktpolicy
3553 @b{Password for "cn=admin,dc=example,dc=com":}
3558 @node Retrieving Information About a Ticket Policy, Destroying a Ticket Policy, Creating and Modifying a Ticket Policy, Global Operations on the Kerberos LDAP Database
3559 @subsection Retrieving Information About a Ticket Policy
3562 @b{view_policy} [@b{-r} @i{realm}] @b{policy_name}
3565 This option displays the attributes of a ticket policy. Option is as follows:
3567 @itemx @b{-r} @i{realm}
3568 Specifies the Kerberos realm of the database; by default the realm returned by krb5_default_local_realm(3) is used.
3570 Specifies the name of the ticket policy.
3576 shell% kdb5_ldap_util -D cn=admin,dc=example,dc=com -H ldaps://ldap-server1.mit.edu view_policy
3577 -r ATHENA.MIT.EDU usertktpolicy
3578 @b{Password for "cn=admin,dc=example,dc=com":}
3579 @b{Ticket policy: usertktpolicy}
3580 @b{Maxmum ticket life: 0 days 01:00:00}
3581 @b{Maxmum renewable life: 0 days 10:00:00}
3582 @b{Ticket flags: DISALLOW_FORWARDABLE REQUIRES_PWCHANGE}
3588 @node Destroying a Ticket Policy, Listing available Ticket Policies, Retrieving Information About a Ticket Policy, Global Operations on the Kerberos LDAP Database
3589 @subsection Destroying a Ticket Policy
3592 @itemx @b{destroy_policy} @b{[-force]} @b{[-r} @i{realm}@b{]} @b{policy_name}
3593 Destroys an existing ticket policy. Options are as follows:
3598 Forces the deletion of the policy object. If not specified, will be prompted for confirmation while deleting the policy. Enter yes to confirm the deletion.
3601 Specifies the Kerberos realm of the database; by default the realm returned by krb5_default_local_realm(3) is used.
3604 Specifies the name of the ticket policy.
3611 shell% kdb5_ldap_util -D cn=admin,dc=example,dc=com -H ldaps://ldap-server1.mit.edu
3612 destroy_policy -r ATHENA.MIT.EDU usertktpolicy
3613 @b{Password for "cn=admin,dc=example,dc=com":}
3614 @b{This will delete the policy object 'usertktpolicy', are you sure?}
3615 @b{(type 'yes' to confirm)? Yes}
3616 @b{** policy object 'usertktpolicy' deleted.}
3621 @node Listing available Ticket Policies, Creating a Service Object (eDirectory), Destroying a Ticket Policy, Global Operations on the Kerberos LDAP Database
3622 @subsection Listing available Ticket Policies
3626 @itemx @b{list_policy} [@b{-r} @i{realm}]
3627 Lists the name of ticket policies in a realm.
3629 Option are as follows:
3632 Specifies the Kerberos realm of the database; by default the realm returned by krb5_default_local_realm(3) is used.
3640 shell% kdb5_ldap_util -D cn=admin,dc=example,dc=com -H ldaps://ldap-server1.mit.edu list_policy -r ATHENA.MIT.EDU
3641 @b{Password for "cn=admin,dc=example,dc=com":}
3643 @b{tempusertktpolicy}
3649 @node Creating a Service Object (eDirectory), Modifying a Service Object (eDirectory), Listing available Ticket Policies, Global Operations on the Kerberos LDAP Database
3650 @subsection Creating a Service Object (eDirectory)
3652 @b{create_service} @i{-kdc|-admin|-pwd} [@b{-servicehost} @i{service_host_list}] [@b{-realm} @i{realm_list}] [@b{-randpw}|
3653 @i{-fileonly}] [@i{-filename}] @b{service_dn}
3656 Creates a service object in directory and assigns appropriate rights on the container holding kerberos data.
3658 Options are as follows:
3662 Specifies the KDC service
3664 Specifies the Administration service
3666 Specifies the Password service
3668 @itemx @b{-servicehost} @i{service_host_list}
3669 Specifies the list of entries separated by a colon (:). Each entry consists of the hostname or IP address of the server hosting the service, transport protocol and the port number of the service separated by a pound sign (#).
3673 server1#tcp#88:server2#udp#89.
3675 @itemx @b{-realm} @i{realm_list}
3676 Specifies the list of realms that are to be associated with this service. The list contains the name of the realms separated by a colon (:).
3678 Generates and sets a random password. This option is used to set the random password for the service object in directory and also to store it in the file. @code{-fileonly} option cannot be used with @code{-randpw} option.
3681 Stores the password only in a file and not in directory. The @code{-randpw} option can not be used when @code{-fileonly} option is specified.
3682 @itemx @i{-f} @b{filename}
3683 Specifies the complete path of the file where the service object password is stashed. If this option is not specified, the default file will be /usr/local/var/service_passwd
3685 Specifies the Distinguished Name (DN) of the Kerberos service to be created.
3691 shell% kdb5_ldap_util -D cn=admin,dc=example,dc=com -H ldaps://ldap-server1.mit.edu
3692 create_service -kdc -randpw -f /home/andrew/service_passwd cn=service-kdc,dc=example,dc=com
3693 @b{Password for "cn=admin,dc=example,dc=com":}
3694 @b{File does not exist. Creating the file /home/andrew/service_passwd...}
3700 @node Modifying a Service Object (eDirectory), Retrieving Service Object Information (eDirectory), Creating a Service Object (eDirectory), Global Operations on the Kerberos LDAP Database
3701 @subsection Modifying a Service Object (eDirectory)
3703 @b{modify_service} [@b{-servicehost} @i{service_host_list} |[@b{-clearservicehost} @i{service_host_list}] [@b{-addservicehost} @i{service_host_list}]] [@b{-realm} @i{realm_list} | [@b{-clearrealm} @i{realm_list}] [@b{-addrealm} @i{realm_list}]] service_dn
3706 Modifies the attributes of a service and assigns appropriate rights, if realm associations are changed.
3708 Options are as follows:
3711 @itemx @b{-servicehost} @i{service_host_list}
3712 List of entries separated by a colon (:) where each entry consists of host name or IP address of the server hosting the service, transport protocol, and port number of the service separated by a pound sign (#). This list replaces the existing list.
3715 server1#tcp#88:server2#udp#89
3717 @itemx @b{-clearservicehost} @i{service_host_list}
3718 Specifies the list of servicehost entries to be removed from the existing list. This is a colon separated list.
3719 @itemx @b{-addservicehost} @i{service_host_list}
3720 Specifies the list of servicehost entries to be added to the existing list. This is a colon separated list.
3721 @itemx @b{-realm} @i{realm_list}
3722 Specifies the list of realms that are to be associated with this service. The list contains the name of the realms separated by a colon (:). This list replaces the existing list.
3723 @itemx @b{-clearrealm} @i{realm_list}
3724 Specifies the list of realms to be removed from the existing list. The list contains the name of the realms separated by a colon (:).
3725 @itemx @b{-addrealm} @i{realm_list}
3726 Specifies the list of realms to be added to the existing list. The list contains the name of the realms separated by a colon (:).
3728 Specifies the Distinguished Name (DN) of the Kerberos service to be modified.
3737 shell% kdb5_ldap_util -D cn=admin,dc=example,dc=com -H ldaps://ldap-server1.mit.edu
3738 modify_service -realm ATHENA.MIT.EDU cn=service-kdc,dc=example,dc=com
3739 @b{Password for "cn=admin,dc=example,dc=com":}
3740 @b{Changing rights for the service object. Please wait ... done}
3744 @node Retrieving Service Object Information (eDirectory), Destroying a Service Object (eDirectory), Modifying a Service Object (eDirectory), Global Operations on the Kerberos LDAP Database
3745 @subsection Retrieving Service Object Information (eDirectory)
3748 @itemx view_service service_dn
3749 Displays the attributes of a service. Options are as follows:
3752 Specifies the Distinguished name (DN) of the Kerberos service to be viewed.
3758 shell% kdb5_ldap_util -D cn=admin,dc=example,dc=com -H ldaps://ldap-server1.mit.edu
3759 view_service cn=service-kdc,dc=example,dc=com
3760 @b{Password for "cn=admin,dc=example,dc=com":}
3761 @b{Service dn: cn=service-kdc,dc=example,dc=com}
3762 @b{Service type: kdc}
3763 @b{Service host list:}
3764 @b{Realm DN list: cn=ATHENA.MIT.EDU,cn=Kerberos,dc=example,dc=com}
3769 @node Destroying a Service Object (eDirectory), Listing Available Service Objects (eDirectory), Retrieving Service Object Information (eDirectory), Global Operations on the Kerberos LDAP Database
3770 @subsection Destroying a Service Object (eDirectory)
3772 @b{destroy_service} [@b{-force}] [@b{-f} @i{stashfilename}] service_dn
3775 Destroys an existing service. Options are as follows :
3779 If specified, will not prompt for user's confirmation, instead will force destruction of service.
3780 @itemx @b{-f} @i{stashfilename}
3781 Complete path of the service password file from where the entry corresponding to the service_dn needs to be removed.
3783 Distinguished Name (DN) of the Kerberos service to be destroyed.
3789 shell% kdb5_ldap_util -D cn=admin,dc=example,dc=com -H ldaps://ldap-server1.mit.edu
3790 destroy_service cn=service-kdc,dc=example,dc=com
3791 @b{Password for "cn=admin,dc=example,dc=com":}
3792 @b{This will delete the service object 'cn=service-kdc,dc=example,dc=com', are you sure?}
3793 @b{(type 'yes' to confirm)? Yes}
3794 @b{** service object 'cn=service-kdc,dc=example,dc=com' deleted.}
3799 @node Listing Available Service Objects (eDirectory), Passwords for Service Objects (eDirectory), Destroying a Service Object (eDirectory), Global Operations on the Kerberos LDAP Database
3800 @subsection Listing Available Service Objects (eDirectory)
3803 @itemx list_service [-basedn base_dn]
3804 Lists the name of services under a given base in directory. Options is as follows:
3806 @itemx @b{-basedn} @i{base_dn}
3807 Specifies the base DN for searching the policies, limiting the search to a particular subtree. If this option is not provided, LDAP Server specific search base will be used. For e.g., in the case of OpenLDAP, value of @code{defaultsearchbase} from @file{slapd.conf} file will be used, where as in the case of eDirectory, the default value for the base DN is Root.
3814 shell% kdb5_ldap_util -D cn=admin,dc=example,dc=com -H ldaps://ldap-server1.mit.edu list_service
3815 @b{Password for "cn=admin,dc=example,dc=com":}
3816 @b{cn=service-kdc,dc=example,dc=com}
3817 @b{cn=service-adm,dc=example,dc=com}
3818 @b{cn=service-pwd,dc=example,dc=com}
3823 @node Passwords for Service Objects (eDirectory), , Listing Available Service Objects (eDirectory), Global Operations on the Kerberos LDAP Database
3824 @subsection Passwords for Service Objects (eDirectory)
3826 @b{setsrvpw} @b{[-randpw|-fileonly]}@b{[-f} @i{ filename}@b{]} @b{service_dn}
3828 Allows an administrator to set password for service objects such as KDC and Administration server in eDirectory and store them in a file. The
3829 @code{-fileonly} command stores the password in a file and not in the eDirectory object.
3830 Options are as follows:
3833 Generates and sets a random password on the directory object and stores it in the file. The @code{-fileonly} option can not be used if @code{-randpw} option is already specified.
3834 @itemx @b{-fileonly}
3835 Stores the password only in a file and not in eDirectory. The @code{-randpw} option can not be used when @code{-fileonly} option is specified.
3836 @itemx @b{-f} @i{filename}
3837 Specifies the complete path of the file where the service object password is stashed. If this option is not specified, the default file will be /usr/local/var/service_passwd.
3839 Specifies the Distinguished Name (DN) of the service object whose password is to be set.
3849 shell% kdb5_ldap_util setsrvpw -D cn=admin,dc=example,dc=com -H ldaps://ldap-server1.mit.edu
3850 setsrvpw -f /home/andrew/conf_keyfile cn=service-kdc,dc=example,dc=com
3851 @b{Password for "cn=admin,dc=example,dc=com":}
3852 @b{Password for "cn=service-kdc,dc=example,dc=com":}
3853 @b{Re-enter password for "cn=service-kdc,dc=example,dc=com":}
3859 @c @node The KDC Logs, , GLobal operations on the Kerberos LDAP Database, Administrating the Kerberos Database
3860 @c @section The KDC Logs
3862 This will have to wait until the next release. *sigh*
3865 @node Cross-realm Authentication, Changing the krbtgt Key, Global Operations on the Kerberos LDAP Database, Administrating the Kerberos Database
3866 @section Cross-realm Authentication
3868 In order for a KDC in one realm to authenticate Kerberos users in a
3869 different realm, it must share a key with the KDC in the other realm.
3870 In both databases, there must be krbtgt service principals for realms.
3871 These principals should all have the same passwords, key version
3872 numbers, and encryption types. For example, if the administrators of
3873 @value{PRIMARYREALM} and @value{SECONDREALM} wanted to authenticate
3874 across the realms, they would run the following commands on the KDCs in
3879 @b{shell%:} kadmin.local -e "des3-hmac-sha1:normal des-cbc-crc:v4"
3880 @b{kadmin:} addprinc -requires_preauth krbtgt/@value{PRIMARYREALM}@@@value{SECONDREALM}
3881 @b{Enter password for principal krbtgt/@value{PRIMARYREALM}@@@value{SECONDREALM}:}
3882 @b{Re-enter password for principal krbtgt/@value{PRIMARYREALM}@@@value{SECONDREALM}:}
3883 @b{kadmin:} addprinc -requires_preauth krbtgt/@value{SECONDREALM}@@@value{PRIMARYREALM}
3884 @b{Enter password for principal krbtgt/@value{SECONDREALM}@@@value{PRIMARYREALM}:}
3885 @b{Enter password for principal krbtgt/@value{SECONDREALM}@@@value{PRIMARYREALM}:}
3890 Even if most principals in a realm are generally created with the
3891 requires_preauth flag enabled, this flag is not desirable on
3892 cross-realm authentication keys because doing so makes it impossible to
3893 disable preauthentication on a service-by-service basis. Disabling it
3894 as in the example above is recommended.
3896 It is also very important that these principals have good passwords.
3897 @value{COMPANY} recommends that TGT principal passwords be at least 26
3898 characters of random ASCII text.
3900 @node Changing the krbtgt Key, , Cross-realm Authentication, Administrating the Kerberos Database
3901 @section Changing the krbtgt Key
3903 A Kerberos Ticket Granting Ticket (TGT) is a service ticket for the
3904 principal krbtgt/@i{REALM}. The key for this principal is created when
3905 the Kerberos database is initialized and need not be changed. However,
3906 it will only have the encryption types supported by the KDC at the time
3907 of the initial database creation. To allow use of newer encryption
3908 types for the TGT, this key has to be changed.
3910 Changing this key using the normal @code{kadmin change_password} command
3911 would invalidate any previously issued TGTs. Therefore, when changing
3912 this key, normally one should use the @b{-keepold} flag to
3913 @code{change_password} to retain the previous key in the database as
3914 well as the new key. For example:
3918 @b{kadmin:} change_password -randkey -keepold krbtgt/@value{PRIMARYREALM}@@@value{PRIMARYREALM}
3922 There is currently no way to remove the old key without running
3923 @code{change_password} without the @b{-keepold} flag (and thereby
3924 invalidating all existing TGTs). After issuing this command, the old
3925 key is still valid and is still vulnerable to (for instance) brute force
3926 attacks. To completely retire an old key or encryption type, it's
3927 therefore currently necessary to declare a flag day, run
3928 @code{change_password} without the @b{-keepold} flag, and force all
3929 users to acquire new tickets.
3931 @node Configuring Kerberos with OpenLDAP back-end, Application Servers, Administrating the Kerberos Database, Top
3932 @chapter Configuring Kerberos with OpenLDAP back-end
3936 Set up SSL on the OpenLDAP server and client to ensure secure
3937 communication when the KDC service and LDAP server are on different
3938 machines. @code{ldapi://} can be used if the LDAP server and KDC
3939 service are running on the same machine.
3943 Setting up SSL on the OpenLDAP server:
3947 Get a CA certificate using OpenSSL tools
3950 Configure OpenLDAP server for using SSL/TLS
3953 For the latter, you need to specify the location of CA certificate location in slapd.conf file.
3956 Refer to the following link for more information:
3959 @uref{http://www.openldap.org/doc/admin23/tls.html}
3963 Setting up SSL on OpenLDAP Client:
3967 For the KDC and Admin Server, you need to do the client-side configuration in ldap.conf.
3972 TLS_CACERT @code{/etc/openldap/certs/cacert.pem}
3978 Include the Kerberos schema file (kerberos.schema) in the
3979 configuration file (slapd.conf) on the LDAP Server, by providing the
3980 location where it is stored.
3983 include @code{/etc/openldap/schema/kerberos.schema}
3987 Choose DNs for the KDC and kadmin servers to bind to the LDAP server,
3988 and create them if necessary. These DNs will be specified with the
3989 @code{ldap_kdc_dn} and @code{ldap_kadmind_dn} directives in krb5.conf;
3990 their passwords can be stashed with @code{kdb5_ldap_util stashsrvpw}
3991 and the resulting file specified with the
3992 @code{ldap_service_password_file} directive.
3995 Choose a DN for the global Kerberos container entry (but do not create
3996 the entry at this time). This DN will be specified with the
3997 @code{ldap_kerberos_container_dn} directive in krb5.conf. Realm
3998 container entries will be created underneath this DN. Principal
3999 entries may exist either underneath the realm container (the default)
4000 or in separate trees referenced from the realm container.
4003 Configure the LDAP server ACLs to enable the KDC and kadmin server DNs
4004 to read and write the Kerberos data.
4007 Sample access control information
4010 access to dn.base=""
4013 access to dn.base="cn=Subschema"
4016 access to attrs=userPassword,userPKCS12
4020 access to attrs=shadowLastChange
4024 # Providing access to realm container
4025 access to @code{dn.subtree}= @i{"cn=EXAMPLE.COM,cn=krbcontainer,dc=example,dc=com"}
4026 by @code{dn.exact}=@i{"cn=kdc-service,dc=example,dc=com"} read
4027 by @code{dn.exact}=@i{"cn=adm-service,dc=example,dc=com"} write
4030 # Providing access to principals, if not underneath realm container
4031 access to @code{dn.subtree}= @i{"ou=users,dc=example,dc=com"}
4032 by @code{dn.exact}=@i{"cn=kdc-service,dc=example,dc=com"} read
4033 by @code{dn.exact}=@i{"cn=adm-service,dc=example,dc=com"} write
4041 If the locations of the container and principals or the DNs of the
4042 service objects for a realm are changed then this information should
4046 Start the LDAP server as follows:
4048 slapd -h "ldapi:/// ldaps:///"
4052 Modify the krb5.conf file to include LDAP specific items listed below:
4055 @noindent @samp{database_module}
4058 @noindent @samp{db_library}
4059 @noindent @samp{db_module_dir}
4060 @noindent @samp{ldap_kdc_dn}
4061 @noindent @samp{ldap_kadmind_dn}
4062 @noindent @samp{ldap_service_password_file}
4063 @noindent @samp{ldap_servers}
4064 @noindent @samp{ldap_conns_per_server}
4068 For the sample @file{krb5.conf} file, refer to @ref{Sample krb5.conf File}.
4070 For more details, refer to the section @file{krb5.conf}
4073 Create the realm using @samp{kdb5_ldap_util}.
4076 @b{kdb5_ldap_util} @b{-D} @i{cn=admin,dc=example,dc=com} create @b{-subtrees} @i{ou=users,dc=example,dc=com} @b{-r} @i{EXAMPLE.COM} @b{-s}
4080 Use the @code{-subtrees} option if the principals are to exist in a separate subtree from the realm container. Before executing the command, make sure that the subtree mentioned above @samp{(ou=users,dc=example,dc=com)} exists. If the principals will exist underneath the realm container, omit the @code{-subtrees} option and do not worry about creating the principal subtree.
4082 For more information, refer to the section @dfn{Global Operations on the Kerberos LDAP Database}.
4085 The realm object is created under the ldap_kerberos_container_dn specified in the configuration file. This operation will also create the Kerberos container, if not present already. This will be used to store information related to all realms.
4088 Stash the password of the service object used by the KDC and
4089 Administration service to bind to the LDAP server using the stashsrvpw
4090 command of kdb5_ldap_util. The object DN should be the same as
4091 ldap_kdc_dn and ldap_kadmind_dn values specified in the krb5.conf
4095 @b{kdb5_ldap_util} @b{-D} @i{cn=admin,dc=example,dc=com} @i{stashsrvpw} @b{-f} @code{/etc/kerberos/service.keyfile} @i{cn=krbadmin,dc=example,dc=com}
4099 Add krb5principalname to the indexes in slapd.conf to speed up the access.
4102 With the LDAP back end it is possible to provide aliases for principal
4103 entries. Currently we provide no mechanism provided for creating
4104 aliases, so it must be done by direct manipulation of the LDAP
4107 An entry with aliases contains multiple values of the krbPrincipalName
4108 attribute. Since LDAP attribute values are not ordered, it is
4109 necessary to specify which principal name is canonical, by using the
4110 krbCanonicalName attribute. Therefore, to create aliases for an
4111 entry, first set the krbCanonicalName attribute of the entry to the
4112 canonical principal name (which should be identical to the
4113 pre-existing krbPrincipalName value), and then add additional
4114 krbPrincipalName attributes for the aliases.
4116 Principal aliases are only returned by the KDC when the client
4117 requests canonicalization. Canonicalization is normally requested for
4118 service principals; for client principals, an explicit flag is often
4119 required (e.g. @code{kinit -C}) and canonicalization is only performed
4120 for initial ticket requests.
4122 @node Application Servers, Backups of Secure Hosts, Configuring Kerberos with OpenLDAP back-end, Top
4123 @chapter Application Servers
4125 If you need to install the @value{PRODUCT} programs on an application
4126 server, please refer to the @value{PRODUCT} Installation Guide. Once
4127 you have installed the software, you need to add that host to the
4128 Kerberos database (@pxref{Adding or Modifying Principals}), and generate
4129 a @dfn{keytab} for that host, that contains the host's key. You also
4130 need to make sure the host's clock is within your maximum clock skew of
4136 * Getting DNS Information Correct::
4137 * Configuring Your Firewall to Work With Kerberos V5::
4140 @node Keytabs, Clock Skew, Application Servers, Application Servers
4143 A @dfn{keytab} is a host's copy of its own keylist, which is analogous
4144 to a user's password. An application server that needs to authenticate
4145 itself to the KDC has to have a keytab that contains its own principal
4146 and key. Just as it is important for users to protect their passwords,
4147 it is equally important for hosts to protect their keytabs. You should
4148 always store keytab files on local disk, and make them readable only by
4149 root, and you should never send a keytab file over a network in the
4150 clear. Ideally, you should run the @code{kadmin} command to extract a
4151 keytab on the host on which the keytab is to reside.
4154 * Adding Principals to Keytabs::
4155 * Removing Principals from Keytabs::
4158 @node Adding Principals to Keytabs, Removing Principals from Keytabs, Keytabs, Keytabs
4159 @subsection Adding Principals to Keytabs
4161 To generate a keytab, or to add a principal to an existing keytab, use
4162 the @code{ktadd} command from @code{kadmin}, which requires the
4163 ``inquire'' administrative privilege. (If you use the @b{-glob}
4164 @i{princ_exp} option, it also requires the ``list'' administrative
4165 privilege.) The syntax is:
4168 @b{ktadd} [@b{-k[eytab]} @i{keytab}] [@b{-q}] [@b{-e}
4169 @i{key:salt_list}] [@i{principal} | @b{-glob} @i{princ_exp}]
4173 The @code{ktadd} command takes the following switches:
4176 @item -k[eytab] @i{keytab}
4177 use @i{keytab} as the keytab file. Otherwise, @code{ktadd} will use the
4178 default keytab file (@code{@value{DefaultDefaultKeytabName}}).
4180 @item @b{-e} @i{"enc:salt..."}
4181 Uses the specified list of enctype-salttype pairs for setting the key
4182 of the principal. The quotes are necessary if there are multiple
4183 enctype-salttype pairs. This will not function against kadmin daemons
4184 earlier than krb5-1.2. See @ref{Supported Encryption Types} and
4185 @ref{Salts} for all possible values.
4188 run in quiet mode. This causes @code{ktadd} to display less verbose
4191 @item @i{principal} | -glob @i{principal expression}
4192 add @i{principal}, or all principals matching @i{principal expression}
4193 to the keytab. The rules for @i{principal expression} are the same as
4194 for the kadmin @code{list_principals} (@pxref{Retrieving a List of
4195 Principals}) command.
4198 Here is a sample session, using configuration files that enable only
4199 @samp{des-cbc-crc} encryption. (The line beginning with @result{} is a
4200 continuation of the previous line.)
4204 @b{kadmin:} ktadd host/@value{RANDOMHOST1}.@value{PRIMARYDOMAIN}@@@value{PRIMARYREALM}
4205 @b{kadmin: Entry for principal host/@value{RANDOMHOST1}.@value{PRIMARYDOMAIN}@@@value{PRIMARYREALM} with
4206 kvno 2, encryption type DES-CBC-CRC added to keytab
4207 WRFILE:/etc/krb5.keytab.
4214 @b{kadmin:} ktadd -k @value{ROOTDIR}/var/krb5kdc/kadmind.keytab
4215 @result{} kadmin/admin kadmin/changepw
4216 @b{kadmin: Entry for principal kadmin/admin@@@value{PRIMARYREALM} with
4217 kvno 3, encryption type DES-CBC-CRC added to keytab
4218 WRFILE:@value{ROOTDIR}/var/krb5kdc/kadmind.keytab.
4223 @node Removing Principals from Keytabs, , Adding Principals to Keytabs, Keytabs
4224 @subsection Removing Principals from Keytabs
4226 To remove a principal from an existing keytab, use the kadmin
4227 @code{ktremove} command. The syntax is:
4230 @b{ktremove} [@b{-k[eytab]} @i{keytab}] [@b{-q}] @i{principal} [@i{kvno} | @b{all} | @b{old}]
4233 The @code{ktremove} command takes the following switches:
4236 @item -k[eytab] @i{keytab}
4237 use @i{keytab} as the keytab file. Otherwise, @code{ktremove} will use
4238 the default keytab file (@code{/etc/krb5.keytab}).
4241 run in quiet mode. This causes @code{ktremove} to display less verbose
4245 the principal to remove from the keytab. (Required.)
4248 remove all entries for the specified principal whose Key Version Numbers
4252 remove all entries for the specified principal
4255 remove all entries for the specified principal except those with the
4263 @b{kadmin:} ktremove -k @value{ROOTDIR}/var/krb5kdc/kadmind.keytab kadmin/admin
4264 @b{kadmin: Entry for principal kadmin/admin with kvno 3 removed
4265 from keytab WRFILE:@value{ROOTDIR}/var/krb5kdc/kadmind.keytab.
4270 @node Clock Skew, Getting DNS Information Correct, Keytabs, Application Servers
4273 In order to prevent intruders from resetting their system clocks in
4274 order to continue to use expired tickets, @value{PRODUCT} is set up to
4275 reject ticket requests from any host whose clock is not within the
4276 specified maximum clock skew of the KDC (as specified in the
4277 @code{kdc.conf} file). Similarly, hosts are configured to reject
4278 responses from any KDC whose clock is not within the specified maximum
4279 clock skew of the host (as specified in the @code{krb5.conf} file). The
4280 default value for maximum clock skew is @value{DefaultClockskew}.
4282 @value{COMPANY} suggests that you add a line to client machines'
4283 @code{/etc/rc} files to synchronize the machine's clock to your KDC at
4284 boot time. On UNIX hosts, assuming you had a kdc called
4285 @code{@value{KDCSERVER}} in your realm, this would be:
4288 gettime -s @value{KDCSERVER}
4291 If the host is not likely to be rebooted frequently, you may also want
4292 to set up a cron job that adjusts the time on a regular basis.
4294 @node Getting DNS Information Correct, Configuring Your Firewall to Work With Kerberos V5, Clock Skew, Application Servers
4295 @section Getting DNS Information Correct
4297 Several aspects of Kerberos rely on name service. In order for Kerberos
4298 to provide its high level of security, it is less forgiving of name
4299 service problems than some other parts of your network. It is important
4300 that your Domain Name System (DNS) entries and your hosts have the
4301 correct information.
4303 Each host's canonical name must be the fully-qualified host name
4304 (including the domain), and each host's IP address must reverse-resolve
4305 to the canonical name.
4307 Other than the @code{localhost} entry, make all entries in each
4308 machine's @code{/etc/hosts} file in the following form:
4311 IP address fully-qualified hostname aliases
4314 Here is a sample @code{/etc/hosts} file:
4319 127.0.0.1 localhost localhost@@@value{PRIMARYDOMAIN}
4320 @value{RANDOMHOST1IP} @value{RANDOMHOST1}.@value{PRIMARYDOMAIN} trillium wake-robin
4324 Additionally, on Solaris machines, you need to be sure the ``hosts''
4325 entry in the file @* @code{/etc/nsswitch.conf} includes the source
4326 ``dns'' as well as ``file''.
4328 Finally, each host's keytab file must include a host/key pair for the
4329 host's canonical name. You can list the keys in a keytab file by
4330 issuing the command @code{klist -k}. For example:
4335 Keytab name: /etc/krb5.keytab
4337 ---- ------------------------------------------------------------
4338 1 host/@value{RANDOMHOST1}.@value{PRIMARYDOMAIN}@@@value{PRIMARYREALM}
4342 If you telnet to the host with a fresh credentials cache (ticket file),
4343 and then @code{klist}, the host's service principal should be
4344 @i{host/fully-qualified-hostname@@REALM_NAME}.
4346 @node Configuring Your Firewall to Work With Kerberos V5, , Getting DNS Information Correct, Application Servers
4347 @section Configuring Your Firewall to Work With @value{PRODUCT}
4349 If you need off-site users to be able to get Kerberos tickets in your
4350 realm, they must be able to get to your KDC. This requires either that
4351 you have a slave KDC outside your firewall, or you configure your
4352 firewall to allow UDP requests into at least one of your KDCs, on
4353 whichever port the KDC is running. (The default is port
4354 @value{DefaultPort}; other ports may be specified in the KDC's kdc.conf
4355 file.) Similarly, if you need off-site users to be able to change
4356 their passwords in your realm, they must be able to get to your
4357 Kerberos admin server. The default port for the admin server is
4358 @value{DefaultKadmindPort}.
4360 If your on-site users inside your firewall will need to get to KDCs in
4361 other realms, you will also need to configure your firewall to allow
4362 outgoing TCP and UDP requests to port @value{DefaultPort}.
4363 Additionally, if they will need to get to any Kerberos V4 KDCs, you may
4364 also need to allow TCP and UDP requests to port
4365 @value{DefaultSecondPort}. If your on-site users inside your firewall
4366 will need to get to Kerberos admin servers in other realms, you will
4367 also need to allow outgoing TCP and UDP requests to port
4368 @value{DefaultKadmindPort}.
4370 If any of your KDCs are outside your firewall, you will need to allow
4371 @code{kprop} requests to get through to the remote KDC. @code{Kprop}
4372 uses the krb5_prop service on port @value{DefaultKrbPropPort} (tcp).
4374 If you need your off-site users to have access to machines inside your
4375 firewall, you need to allow TCP connections from their off-site hosts on
4376 the appropriate ports for the programs they will be using. The
4377 following lines from @code{/etc/services} show the default port numbers
4378 for the @value{PRODUCT} programs:
4382 ftp @value{DefaultFTPPort}/tcp # Kerberos ftp and telnet use the
4383 telnet @value{DefaultTelnetPort}/tcp # default ports
4384 kerberos @value{DefaultPort}/udp kdc # Kerberos V5 KDC
4385 kerberos @value{DefaultPort}/tcp kdc # Kerberos V5 KDC
4386 klogin @value{DefaultKloginPort}/tcp # Kerberos authenticated rlogin
4387 kshell @value{DefaultKshellPort}/tcp cmd # and remote shell
4388 kerberos-adm @value{DefaultKadmindPort}/tcp # Kerberos 5 admin/changepw
4389 kerberos-adm @value{DefaultKadmindPort}/udp # Kerberos 5 admin/changepw
4390 krb5_prop @value{DefaultKrbPropPort}/tcp # Kerberos slave propagation
4391 @c kpop 1109/tcp # Pop with Kerberos
4392 eklogin @value{DefaultEkloginPort}/tcp # Kerberos auth. & encrypted rlogin
4396 By default, @value{PRODUCT} @code{telnet} and @code{ftp} use the same
4397 ports as the standard @code{telnet} and @code{ftp} programs, so if you
4398 already allow telnet and ftp connections through your firewall, the
4399 @value{PRODUCT} versions will get through as well. If you do not
4400 already allow telnet and ftp connections through your firewall, but need
4401 your users to be able to use @value{PRODUCT} telnet and ftp, you can
4402 either allow ftp and telnet connections on the standard ports, or switch
4403 these programs to non-default port numbers and allow ftp and telnet
4404 connections on those ports to get through.
4406 @value{PRODUCT} @code{rlogin} uses the @code{klogin} service, which by
4407 default uses port @value{DefaultKloginPort}. Encrypted @value{PRODUCT}
4408 rlogin uses the @code{eklogin} service, which by default uses port
4409 @value{DefaultEkloginPort}.
4411 @value{PRODUCT} @code{rsh} uses the @code{kshell} service, which by
4412 default uses port @value{DefaultKshellPort}. However, the server must
4413 be able to make a TCP connection from the kshell port to an arbitrary
4414 port on the client, so if your users are to be able to use @code{rsh}
4415 from outside your firewall, the server they connect to must be able to
4416 send outgoing packets to arbitrary port numbers. Similarly, if your
4417 users need to run @code{rsh} from inside your firewall to hosts outside
4418 your firewall, the outside server needs to be able to connect to an
4419 arbitrary port on the machine inside your firewall. Because
4420 @value{PRODUCT} @code{rcp} uses @code{rsh}, the same issues apply. If
4421 you need to use @code{rsh} (or @code{rcp}) through your firewall and
4422 are concerned with the security implications of allowing connections to
4423 arbitrary ports, @value{COMPANY} suggests that you have rules that
4424 specifically name these applications and, if possible, list the allowed
4427 The book @cite{UNIX System Security}, by David Curry, is a good
4428 starting point for learning to configure firewalls.
4431 @c @node Enabling Users to Connect from Off-Site, , Configuring Your Firewall to Work With @value{PRODUCT}, Application Servers
4432 @c @section Enabling Users to Connect from Off-Site
4434 This will have to wait until the next release. *sigh*
4437 @node Backups of Secure Hosts, Bug Reporting, Application Servers, Top
4438 @chapter Backups of Secure Hosts
4440 When you back up a secure host, you should exclude the host's keytab
4441 file from the backup. If someone obtained a copy of the keytab from a
4442 backup, that person could make any host masquerade as the host whose
4443 keytab was compromised. This could be particularly dangerous if the
4444 compromised keytab was from one of your KDCs. If the machine has a disk
4445 crash and the keytab file is lost, it is easy to generate another keytab
4446 file. (@xref{Adding Principals to Keytabs}.) If you are unable to
4447 exclude particular files from backups, you should ensure that the
4448 backups are kept as secure as the host's root password.
4451 * Backing Up the Kerberos Database::
4454 @node Backing Up the Kerberos Database, , Backups of Secure Hosts, Backups of Secure Hosts
4455 @section Backing Up the Kerberos Database
4457 As with any file, it is possible that your Kerberos database could
4458 become corrupted. If this happens on one of the slave KDCs, you might
4459 never notice, since the next automatic propagation of the database would
4460 install a fresh copy. However, if it happens to the master KDC, the
4461 corrupted database would be propagated to all of the slaves during the
4462 next propagation. For this reason, @value{COMPANY} recommends that you
4463 back up your Kerberos database regularly. Because the master KDC is
4464 continuously dumping the database to a file in order to propagate it to
4465 the slave KDCs, it is a simple matter to have a cron job periodically
4466 copy the dump file to a secure machine elsewhere on your network. (Of
4467 course, it is important to make the host where these backups are stored
4468 as secure as your KDCs, and to encrypt its transmission across your
4469 network.) Then if your database becomes corrupted, you can load the
4470 most recent dump onto the master KDC. (@xref{Restoring a Kerberos
4471 Database from a Dump File}.)
4473 @node Bug Reporting, Appendix, Backups of Secure Hosts, Top
4474 @chapter Bug Reporting
4476 @include send-pr.texinfo
4478 @node Appendix, , Bug Reporting, Top
4483 * kadmin Time Zones::
4486 @node Errors, kadmin Time Zones, Appendix, Appendix
4487 @appendixsec Kerberos Error Messages
4490 * Kerberos V5 Library Error Codes::
4491 * Kerberos V5 Database Library Error Codes::
4492 * Kerberos V5 Magic Numbers Error Codes::
4493 * ASN.1 Error Codes::
4494 * GSSAPI Error Codes::
4497 @node Kerberos V5 Library Error Codes, Kerberos V5 Database Library Error Codes, Errors, Errors
4498 @appendixsubsec Kerberos V5 Library Error Codes
4500 This is the Kerberos v5 library error code table. Protocol error codes
4501 are @* ERROR_TABLE_BASE_krb5 + the protocol error code number; other
4502 error codes start at ERROR_TABLE_BASE_krb5 + 128.
4504 @c error table numbering starts at 0
4507 KRB5KDC_ERR_NONE: No error
4509 KRB5KDC_ERR_NAME_EXP: Client's entry in database has expired
4511 KRB5KDC_ERR_SERVICE_EXP: Server's entry in database has expired
4513 KRB5KDC_ERR_BAD_PVNO: Requested protocol version not supported
4515 KRB5KDC_ERR_C_OLD_MAST_KVNO: Client's key is encrypted in an old master
4518 KRB5KDC_ERR_S_OLD_MAST_KVNO: Server's key is encrypted in an old master
4521 KRB5KDC_ERR_C_PRINCIPAL_UNKNOWN: Client not found in Kerberos database
4523 KRB5KDC_ERR_S_PRINCIPAL_UNKNOWN: Server not found in Kerberos database
4525 KRB5KDC_ERR_PRINCIPAL_NOT_UNIQUE: Principal has multiple entries in
4528 KRB5KDC_ERR_NULL_KEY: Client or server has a null key
4530 KRB5KDC_ERR_CANNOT_POSTDATE: Ticket is ineligible for postdating
4532 KRB5KDC_ERR_NEVER_VALID: Requested effective lifetime is negative or
4535 KRB5KDC_ERR_POLICY: KDC policy rejects request
4537 KRB5KDC_ERR_BADOPTION: KDC can't fulfill requested option
4539 KRB5KDC_ERR_ETYPE_NOSUPP: KDC has no support for encryption type
4541 KRB5KDC_ERR_SUMTYPE_NOSUPP: KDC has no support for checksum type
4543 KRB5KDC_ERR_PADATA_TYPE_NOSUPP: KDC has no support for padata type
4545 KRB5KDC_ERR_TRTYPE_NOSUPP: KDC has no support for transited type
4547 KRB5KDC_ERR_CLIENT_REVOKED: Clients credentials have been revoked
4549 KRB5KDC_ERR_SERVICE_REVOKED: Credentials for server have been revoked
4551 KRB5KDC_ERR_TGT_REVOKED: TGT has been revoked
4553 KRB5KDC_ERR_CLIENT_NOTYET: Client not yet valid - try again later
4555 KRB5KDC_ERR_SERVICE_NOTYET: Server not yet valid - try again later
4557 KRB5KDC_ERR_KEY_EXP: Password has expired
4559 KRB5KDC_ERR_PREAUTH_FAILED: Preauthentication failed
4561 KRB5KDC_ERR_PREAUTH_REQUIRED: Additional pre-auth@-en@-ti@-ca@-tion required
4563 KRB5KDC_ERR_SERVER_NOMATCH: Requested server and ticket don't match
4565 KRB5PLACEHOLD_27: KRB5 error code 27
4567 KRB5PLACEHOLD_28: KRB5 error code 28
4569 KRB5PLACEHOLD_29: KRB5 error code 29
4571 KRB5PLACEHOLD_30: KRB5 error code 30
4573 KRB5KRB_AP_ERR_BAD_INTEGRITY: Decrypt integrity check failed
4575 KRB5KRB_AP_ERR_TKT_EXPIRED: Ticket expired
4577 KRB5KRB_AP_ERR_TKT_NYV: Ticket not yet valid
4579 KRB5KRB_AP_ERR_REPEAT: Request is a replay
4581 KRB5KRB_AP_ERR_NOT_US: The ticket isn't for us
4583 KRB5KRB_AP_ERR_BADMATCH: Ticket/authenticator don't match
4585 KRB5KRB_AP_ERR_SKEW: Clock skew too great
4587 KRB5KRB_AP_ERR_BADADDR: Incorrect net address
4589 KRB5KRB_AP_ERR_BADVERSION: Protocol version mismatch
4591 KRB5KRB_AP_ERR_MSG_TYPE: Invalid message type
4593 KRB5KRB_AP_ERR_MODIFIED: Message stream modified
4595 KRB5KRB_AP_ERR_BADORDER: Message out of order
4597 KRB5KRB_AP_ERR_ILL_CR_TKT: Illegal cross-realm ticket
4599 KRB5KRB_AP_ERR_BADKEYVER: Key version is not available
4601 KRB5KRB_AP_ERR_NOKEY: Service key not available
4603 KRB5KRB_AP_ERR_MUT_FAIL: Mutual authentication failed
4605 KRB5KRB_AP_ERR_BADDIRECTION: Incorrect message direction
4607 KRB5KRB_AP_ERR_METHOD: Alternative authentication method required
4609 KRB5KRB_AP_ERR_BADSEQ: Incorrect sequence number in message
4611 KRB5KRB_AP_ERR_INAPP_CKSUM: Inappropriate type of checksum in message
4613 KRB5KRB_AP_PATH_NOT_ACCEPTED: Policy rejects transited path
4615 KRB5KRB_ERR_RESPONSE_TOO_BIG: Response too big for UDP, retry with TCP
4617 KRB5PLACEHOLD_53: KRB5 error code 53
4619 KRB5PLACEHOLD_54: KRB5 error code 54
4621 KRB5PLACEHOLD_55: KRB5 error code 55
4623 KRB5PLACEHOLD_56: KRB5 error code 56
4625 KRB5PLACEHOLD_57: KRB5 error code 57
4627 KRB5PLACEHOLD_58: KRB5 error code 58
4629 KRB5PLACEHOLD_59: KRB5 error code 59
4631 KRB5KRB_ERR_GENERIC: Generic error (see e-text)
4633 KRB5KRB_ERR_FIELD_TOOLONG: Field is too long for this implementation
4635 KRB5PLACEHOLD_62: KRB5 error code 62
4637 KRB5PLACEHOLD_63: KRB5 error code 63
4639 KRB5PLACEHOLD_64: KRB5 error code 64
4641 KRB5PLACEHOLD_65: KRB5 error code 65
4643 KRB5PLACEHOLD_66: KRB5 error code 66
4645 KRB5PLACEHOLD_67: KRB5 error code 67
4647 KRB5PLACEHOLD_68: KRB5 error code 68
4649 KRB5PLACEHOLD_69: KRB5 error code 69
4651 KRB5PLACEHOLD_70: KRB5 error code 70
4653 KRB5PLACEHOLD_71: KRB5 error code 71
4655 KRB5PLACEHOLD_72: KRB5 error code 72
4657 KRB5PLACEHOLD_73: KRB5 error code 73
4659 KRB5PLACEHOLD_74: KRB5 error code 74
4661 KRB5PLACEHOLD_75: KRB5 error code 75
4663 KRB5PLACEHOLD_76: KRB5 error code 76
4665 KRB5PLACEHOLD_77: KRB5 error code 77
4667 KRB5PLACEHOLD_78: KRB5 error code 78
4669 KRB5PLACEHOLD_79: KRB5 error code 79
4671 KRB5PLACEHOLD_80: KRB5 error code 80
4673 KRB5PLACEHOLD_81: KRB5 error code 81
4675 KRB5PLACEHOLD_82: KRB5 error code 82
4677 KRB5PLACEHOLD_83: KRB5 error code 83
4679 KRB5PLACEHOLD_84: KRB5 error code 84
4681 KRB5PLACEHOLD_85: KRB5 error code 85
4683 KRB5PLACEHOLD_86: KRB5 error code 86
4685 KRB5PLACEHOLD_87: KRB5 error code 87
4687 KRB5PLACEHOLD_88: KRB5 error code 88
4689 KRB5PLACEHOLD_89: KRB5 error code 89
4691 KRB5PLACEHOLD_90: KRB5 error code 90
4693 KRB5PLACEHOLD_91: KRB5 error code 91
4695 KRB5PLACEHOLD_92: KRB5 error code 92
4697 KRB5PLACEHOLD_93: KRB5 error code 93
4699 KRB5PLACEHOLD_94: KRB5 error code 94
4701 KRB5PLACEHOLD_95: KRB5 error code 95
4703 KRB5PLACEHOLD_96: KRB5 error code 96
4705 KRB5PLACEHOLD_97: KRB5 error code 97
4707 KRB5PLACEHOLD_98: KRB5 error code 98
4709 KRB5PLACEHOLD_99: KRB5 error code 99
4711 KRB5PLACEHOLD_100: KRB5 error code 100
4713 KRB5PLACEHOLD_101: KRB5 error code 101
4715 KRB5PLACEHOLD_102: KRB5 error code 102
4717 KRB5PLACEHOLD_103: KRB5 error code 103
4719 KRB5PLACEHOLD_104: KRB5 error code 104
4721 KRB5PLACEHOLD_105: KRB5 error code 105
4723 KRB5PLACEHOLD_106: KRB5 error code 106
4725 KRB5PLACEHOLD_107: KRB5 error code 107
4727 KRB5PLACEHOLD_108: KRB5 error code 108
4729 KRB5PLACEHOLD_109: KRB5 error code 109
4731 KRB5PLACEHOLD_110: KRB5 error code 110
4733 KRB5PLACEHOLD_111: KRB5 error code 111
4735 KRB5PLACEHOLD_112: KRB5 error code 112
4737 KRB5PLACEHOLD_113: KRB5 error code 113
4739 KRB5PLACEHOLD_114: KRB5 error code 114
4741 KRB5PLACEHOLD_115: KRB5 error code 115
4743 KRB5PLACEHOLD_116: KRB5 error code 116
4745 KRB5PLACEHOLD_117: KRB5 error code 117
4747 KRB5PLACEHOLD_118: KRB5 error code 118
4749 KRB5PLACEHOLD_119: KRB5 error code 119
4751 KRB5PLACEHOLD_120: KRB5 error code 120
4753 KRB5PLACEHOLD_121: KRB5 error code 121
4755 KRB5PLACEHOLD_122: KRB5 error code 122
4757 KRB5PLACEHOLD_123: KRB5 error code 123
4759 KRB5PLACEHOLD_124: KRB5 error code 124
4761 KRB5PLACEHOLD_125: KRB5 error code 125
4763 KRB5PLACEHOLD_126: KRB5 error code 126
4765 KRB5PLACEHOLD_127: KRB5 error code 127
4767 KRB5_ERR_RCSID: (RCS Id string for the krb5 error table)
4769 KRB5_LIBOS_BADLOCKFLAG: Invalid flag for file lock mode
4771 KRB5_LIBOS_CANTREADPWD: Cannot read password
4773 KRB5_LIBOS_BADPWDMATCH: Password mismatch
4775 KRB5_LIBOS_PWDINTR: Password read interrupted
4777 KRB5_PARSE_ILLCHAR: Illegal character in component name
4779 KRB5_PARSE_MALFORMED: Malformed representation of principal
4781 KRB5_CONFIG_CANTOPEN: Can't open/find Kerberos configuration file
4783 KRB5_CONFIG_BADFORMAT: Improper format of Kerberos configuration file
4785 KRB5_CONFIG_NOTENUFSPACE: Insufficient space to return complete
4788 KRB5_BADMSGTYPE: Invalid message type specified for encoding
4790 KRB5_CC_BADNAME: Credential cache name malformed
4792 KRB5_CC_UNKNOWN_TYPE: Unknown credential cache type
4794 KRB5_CC_NOTFOUND: Matching credential not found
4796 KRB5_CC_END: End of credential cache reached
4798 KRB5_NO_TKT_SUPPLIED: Request did not supply a ticket
4800 KRB5KRB_AP_WRONG_PRINC: Wrong principal in request
4802 KRB5KRB_AP_ERR_TKT_INVALID: Ticket has invalid flag set
4804 KRB5_PRINC_NOMATCH: Requested principal and ticket don't match
4806 KRB5_KDCREP_MODIFIED: KDC reply did not match expectations
4808 KRB5_KDCREP_SKEW: Clock skew too great in KDC reply
4810 KRB5_IN_TKT_REALM_MISMATCH: Client/server realm mismatch in initial
4813 KRB5_PROG_ETYPE_NOSUPP: Program lacks support for encryption type
4815 KRB5_PROG_KEYTYPE_NOSUPP: Program lacks support for key type
4817 KRB5_WRONG_ETYPE: Requested encryption type not used in message
4819 KRB5_PROG_SUMTYPE_NOSUPP: Program lacks support for checksum type
4821 KRB5_REALM_UNKNOWN: Cannot find KDC for requested realm
4823 KRB5_SERVICE_UNKNOWN: Kerberos service unknown
4825 KRB5_KDC_UNREACH: Cannot contact any KDC for requested realm
4827 KRB5_NO_LOCALNAME: No local name found for principal name
4829 KRB5_MUTUAL_FAILED: Mutual authentication failed
4831 KRB5_RC_TYPE_EXISTS: Replay cache type is already registered
4833 KRB5_RC_MALLOC: No more memory to allocate (in replay cache code)
4835 KRB5_RC_TYPE_NOTFOUND: Replay cache type is unknown
4837 KRB5_RC_UNKNOWN: Generic unknown RC error
4839 KRB5_RC_REPLAY: Message is a replay
4841 KRB5_RC_IO: Replay I/O operation failed XXX
4843 KRB5_RC_NOIO: Replay cache type does not support non-volatile storage
4845 KRB5_RC_PARSE: Replay cache name parse/format error
4847 KRB5_RC_IO_EOF: End-of-file on replay cache I/O
4849 KRB5_RC_IO_MALLOC: No more memory to allocate (in replay cache I/O
4852 KRB5_RC_IO_PERM: Permission denied in replay cache code
4854 KRB5_RC_IO_IO: I/O error in replay cache i/o code
4856 KRB5_RC_IO_UNKNOWN: Generic unknown RC/IO error
4858 KRB5_RC_IO_SPACE: Insufficient system space to store replay information
4860 KRB5_TRANS_CANTOPEN: Can't open/find realm translation file
4862 KRB5_TRANS_BADFORMAT: Improper format of realm translation file
4864 KRB5_LNAME_CANTOPEN: Can't open/find lname translation database
4866 KRB5_LNAME_NOTRANS: No translation available for requested principal
4868 KRB5_LNAME_BADFORMAT: Improper format of translation database entry
4870 KRB5_CRYPTO_INTERNAL: Cryptosystem internal error
4872 KRB5_KT_BADNAME: Key table name malformed
4874 KRB5_KT_UNKNOWN_TYPE: Unknown Key table type
4876 KRB5_KT_NOTFOUND: Key table entry not found
4878 KRB5_KT_END: End of key table reached
4880 KRB5_KT_NOWRITE: Cannot write to specified key table
4882 KRB5_KT_IOERR: Error writing to key table
4884 KRB5_NO_TKT_IN_RLM: Cannot find ticket for requested realm
4886 KRB5DES_BAD_KEYPAR: DES key has bad parity
4888 KRB5DES_WEAK_KEY: DES key is a weak key
4890 KRB5_BAD_ENCTYPE: Bad encryption type
4892 KRB5_BAD_KEYSIZE: Key size is incompatible with encryption type
4894 KRB5_BAD_MSIZE: Message size is incompatible with encryption type
4896 KRB5_CC_TYPE_EXISTS: Credentials cache type is already registered.
4898 KRB5_KT_TYPE_EXISTS: Key table type is already registered.
4900 KRB5_CC_IO: Credentials cache I/O operation failed XXX
4902 KRB5_FCC_PERM: Credentials cache file permissions incorrect
4904 KRB5_FCC_NOFILE: No credentials cache found
4906 KRB5_FCC_INTERNAL: Internal credentials cache error
4908 KRB5_CC_WRITE: Error writing to credentials cache
4910 KRB5_CC_NOMEM: No more memory to allocate (in credentials cache code)
4912 KRB5_CC_FORMAT: Bad format in credentials cache
4914 KRB5_INVALID_FLAGS: Invalid KDC option combination (library internal
4915 error) [for dual tgt library calls]
4917 KRB5_NO_2ND_TKT: Request missing second ticket [for dual tgt library
4920 KRB5_NOCREDS_SUPPLIED: No credentials supplied to library routine
4922 KRB5_SENDAUTH_BADAUTHVERS: Bad sendauth version was sent
4924 KRB5_SENDAUTH_BADAPPLVERS: Bad application version was sent (via
4927 KRB5_SENDAUTH_BADRESPONSE: Bad response (during sendauth exchange)
4929 KRB5_SENDAUTH_REJECTED: Server rejected authentication (during sendauth
4932 KRB5_PREAUTH_BAD_TYPE: Unsupported preauthentication type
4934 KRB5_PREAUTH_NO_KEY: Required preauthentication key not supplied
4936 KRB5_PREAUTH_FAILED: Generic preauthentication failure
4938 KRB5_RCACHE_BADVNO: Unsupported replay cache format version number
4940 KRB5_CCACHE_BADVNO: Unsupported credentials cache format version number
4942 KRB5_KEYTAB_BADVNO: Unsupported key table format version number
4944 KRB5_PROG_ATYPE_NOSUPP: Program lacks support for address type
4946 KRB5_RC_REQUIRED: Message replay detection requires rcache parameter
4948 KRB5_ERR_BAD_HOSTNAME: Hostname cannot be canonicalized
4950 KRB5_ERR_HOST_REALM_UNKNOWN: Cannot determine realm for host
4952 KRB5_SNAME_UNSUPP_NAMETYPE: Conversion to service principal undefined
4955 KRB5KRB_AP_ERR_V4_REPLY: Initial Ticket response appears to be Version
4958 KRB5_REALM_CANT_RESOLVE: Cannot resolve KDC for requested realm
4960 KRB5_TKT_NOT_FORWARDABLE: Requesting ticket can't get forwardable
4963 KRB5_FWD_BAD_PRINCIPAL: Bad principal name while trying to forward
4966 KRB5_GET_IN_TKT_LOOP: Looping detected inside krb5_get_in_tkt
4968 KRB5_CONFIG_NODEFREALM: Configuration file does not specify default realm
4970 KRB5_SAM_UNSUPPORTED: Bad SAM flags in obtain_sam_padata
4972 KRB5_KT_NAME_TOOLONG: Keytab name too long
4974 KRB5_KT_KVNONOTFOUND: Key version number for principal in key table is incorrect
4976 KRB5_APPL_EXPIRED: This application has expired
4978 KRB5_LIB_EXPIRED: This Krb5 library has expired
4980 KRB5_CHPW_PWDNULL: New password cannot be zero length
4982 KRB5_CHPW_FAIL: Password change failed
4984 KRB5_KT_FORMAT: Bad format in keytab
4986 KRB5_NOPERM_ETYPE: Encryption type not permitted
4988 KRB5_CONFIG_ETYPE_NOSUPP: No supported encryption types (config file error?)
4990 KRB5_OBSOLETE_FN: Program called an obsolete, deleted function
4992 KRB5_EAI_FAIL: unknown getaddrinfo failure
4994 KRB5_EAI_NODATA: no data available for host/domain name
4996 KRB5_EAI_NONAME: host/domain name not found
4998 KRB5_EAI_SERVICE: service name unknown
5000 KRB5_ERR_NUMERIC_REALM: Cannot determine realm for numeric host address
5003 @node Kerberos V5 Database Library Error Codes, Kerberos V5 Magic Numbers Error Codes, Kerberos V5 Library Error Codes, Errors
5004 @appendixsubsec Kerberos V5 Database Library Error Codes
5006 This is the Kerberos v5 database library error code table.
5008 @c error table numbering starts at 0
5011 KRB5_KDB_RCSID: (RCS Id string for the kdb error table)
5013 KRB5_KDB_INUSE: Entry already exists in database
5015 KRB5_KDB_UK_SERROR: Database store error
5017 KRB5_KDB_UK_RERROR: Database read error
5019 KRB5_KDB_UNAUTH: Insufficient access to perform requested operation
5021 KRB5_KDB_NOENTRY: No such entry in the database
5023 KRB5_KDB_ILL_WILDCARD: Illegal use of wildcard
5025 KRB5_KDB_DB_INUSE: Database is locked or in use--try again later
5027 KRB5_KDB_DB_CHANGED: Database was modified during read
5029 KRB5_KDB_TRUNCATED_RECORD: Database record is incomplete or corrupted
5031 KRB5_KDB_RECURSIVELOCK: Attempt to lock database twice
5033 KRB5_KDB_NOTLOCKED: Attempt to unlock database when not locked
5035 KRB5_KDB_BADLOCKMODE: Invalid kdb lock mode
5037 KRB5_KDB_DBNOTINITED: Database has not been initialized
5039 KRB5_KDB_DBINITED: Database has already been initialized
5041 KRB5_KDB_ILLDIRECTION: Bad direction for converting keys
5043 KRB5_KDB_NOMASTERKEY: Cannot find master key record in database
5045 KRB5_KDB_BADMASTERKEY: Master key does not match database
5047 KRB5_KDB_INVALIDKEYSIZE: Key size in database is invalid
5049 KRB5_KDB_CANTREAD_STORED: Cannot find/read stored master key
5051 KRB5_KDB_BADSTORED_MKEY: Stored master key is corrupted
5053 KRB5_KDB_CANTLOCK_DB: Insufficient access to lock database
5055 KRB5_KDB_DB_CORRUPT: Database format error
5057 KRB5_KDB_BAD_VERSION: Unsupported version in database entry
5059 KRB5_KDB_BAD_SALTTYPE: Unsupported salt type
5061 KRB5_KDB_BAD_ENCTYPE: Unsupported encryption type
5063 KRB5_KDB_BAD_CREATEFLAGS: Bad database creation flags
5065 KRB5_KDB_NO_PERMITTED_KEY: No matching key in entry having a permitted enc type
5067 KRB5_KDB_NO_MATCHING_KEY: No matching key in entry
5069 KRB5_KDB_SERVER_INTERNAL_ERR: Server error
5071 KRB5_KDB_ACCESS_ERROR: Unable to access Kerberos database
5073 KRB5_KDB_INTERNAL_ERROR:Kerberos database internal error
5075 KRB5_KDB_CONSTRAINT_VIOLATION:Kerberos database constraints violated
5078 @node Kerberos V5 Magic Numbers Error Codes, ASN.1 Error Codes, Kerberos V5 Database Library Error Codes, Errors
5079 @appendixsubsec Kerberos V5 Magic Numbers Error Codes
5081 This is the Kerberos v5 magic numbers error code table.
5083 @c error table numbering starts at 0
5086 KV5M_NONE: Kerberos V5 magic number table
5088 KV5M_PRINCIPAL: Bad magic number for krb5_principal structure
5090 KV5M_DATA: Bad magic number for krb5_data structure
5092 KV5M_KEYBLOCK: Bad magic number for krb5_keyblock structure
5094 KV5M_CHECKSUM: Bad magic number for krb5_checksum structure
5096 KV5M_ENCRYPT_BLOCK: Bad magic number for krb5_encrypt_block structure
5098 KV5M_ENC_DATA: Bad magic number for krb5_enc_data structure
5100 KV5M_CRYPTOSYSTEM_ENTRY: Bad magic number for krb5_cryp@-to@-sys@-tem_entry
5103 KV5M_CS_TABLE_ENTRY: Bad magic number for krb5_cs_table_entry structure
5105 KV5M_CHECKSUM_ENTRY: Bad magic number for krb5_check@-sum_en@-try structure
5107 KV5M_AUTHDATA: Bad magic number for krb5_authdata structure
5109 KV5M_TRANSITED: Bad magic number for krb5_transited structure
5111 KV5M_ENC_TKT_PART: Bad magic number for krb5_enc_tkt_part structure
5113 KV5M_TICKET: Bad magic number for krb5_ticket structure
5115 KV5M_AUTHENTICATOR: Bad magic number for krb5_authenticator structure
5117 KV5M_TKT_AUTHENT: Bad magic number for krb5_tkt_authent structure
5119 KV5M_CREDS: Bad magic number for krb5_creds structure
5121 KV5M_LAST_REQ_ENTRY: Bad magic number for krb5_last_req_entry structure
5123 KV5M_PA_DATA: Bad magic number for krb5_pa_data structure
5125 KV5M_KDC_REQ: Bad magic number for krb5_kdc_req structure
5127 KV5M_ENC_KDC_REP_PART: Bad magic number for @*
5128 krb5_enc_kdc_rep_part structure
5130 KV5M_KDC_REP: Bad magic number for krb5_kdc_rep structure
5132 KV5M_ERROR: Bad magic number for krb5_error structure
5134 KV5M_AP_REQ: Bad magic number for krb5_ap_req structure
5136 KV5M_AP_REP: Bad magic number for krb5_ap_rep structure
5138 KV5M_AP_REP_ENC_PART: Bad magic number for @*
5139 krb5_ap_rep_enc_part structure
5141 KV5M_RESPONSE: Bad magic number for krb5_response structure
5143 KV5M_SAFE: Bad magic number for krb5_safe structure
5145 KV5M_PRIV: Bad magic number for krb5_priv structure
5147 KV5M_PRIV_ENC_PART: Bad magic number for krb5_priv_enc_part structure
5149 KV5M_CRED: Bad magic number for krb5_cred structure
5151 KV5M_CRED_INFO: Bad magic number for krb5_cred_info structure
5153 KV5M_CRED_ENC_PART: Bad magic number for krb5_cred_enc_part structure
5155 KV5M_PWD_DATA: Bad magic number for krb5_pwd_data structure
5157 KV5M_ADDRESS: Bad magic number for krb5_address structure
5159 KV5M_KEYTAB_ENTRY: Bad magic number for krb5_keytab_entry structure
5161 KV5M_CONTEXT: Bad magic number for krb5_context structure
5163 KV5M_OS_CONTEXT: Bad magic number for krb5_os_context structure
5165 KV5M_ALT_METHOD: Bad magic number for krb5_alt_method structure
5167 KV5M_ETYPE_INFO_ENTRY: Bad magic number for @*
5168 krb5_etype_info_entry structure
5170 KV5M_DB_CONTEXT: Bad magic number for krb5_db_context structure
5172 KV5M_AUTH_CONTEXT: Bad magic number for krb5_auth_context structure
5174 KV5M_KEYTAB: Bad magic number for krb5_keytab structure
5176 KV5M_RCACHE: Bad magic number for krb5_rcache structure
5178 KV5M_CCACHE: Bad magic number for krb5_ccache structure
5180 KV5M_PREAUTH_OPS: Bad magic number for krb5_preauth_ops
5182 KV5M_SAM_CHALLENGE: Bad magic number for krb5_sam_challenge
5184 KV5M_SAM_KEY: Bad magic number for krb5_sam_key
5186 KV5M_ENC_SAM_RESPONSE_ENC: Bad magic number for @*
5187 krb5_enc_sam_response_enc
5189 KV5M_SAM_RESPONSE: Bad magic number for krb5_sam_response
5191 KV5M_PREDICTED_SAM_RESPONSE: Bad magic number for
5192 krb5_predicted_sam_response
5194 KV5M_PASSWD_PHRASE_ELEMENT: Bad magic number for passwd_phrase_element
5196 KV5M_GSS_OID: Bad magic number for GSSAPI OID
5198 KV5M_GSS_QUEUE: Bad magic number for GSSAPI QUEUE
5201 @node ASN.1 Error Codes, GSSAPI Error Codes, Kerberos V5 Magic Numbers Error Codes, Errors
5202 @appendixsubsec ASN.1 Error Codes
5204 @c error table numbering starts at 0
5207 ASN1_BAD_TIMEFORMAT: ASN.1 failed call to system time library
5209 ASN1_MISSING_FIELD: ASN.1 structure is missing a required field
5211 ASN1_MISPLACED_FIELD: ASN.1 unexpected field number
5213 ASN1_TYPE_MISMATCH: ASN.1 type numbers are inconsistent
5215 ASN1_OVERFLOW: ASN.1 value too large
5217 ASN1_OVERRUN: ASN.1 encoding ended unexpectedly
5219 ASN1_BAD_ID: ASN.1 identifier doesn't match expected value
5221 ASN1_BAD_LENGTH: ASN.1 length doesn't match expected value
5223 ASN1_BAD_FORMAT: ASN.1 badly-formatted encoding
5225 ASN1_PARSE_ERROR: ASN.1 parse error
5227 ASN1_BAD_GMTIME: ASN.1 bad return from gmtime
5229 ASN1_MISMATCH_INDEF: ASN.1 non-constructed indefinite encoding
5231 ASN1_MISSING_EOC: ASN.1 missing expected EOC
5234 @node GSSAPI Error Codes, , ASN.1 Error Codes, Errors
5235 @appendixsubsec GSSAPI Error Codes
5237 Generic GSSAPI Errors:
5239 @c error table numbering starts at 0
5242 G_BAD_SERVICE_NAME: No @ in SERVICE-NAME name string
5244 G_BAD_STRING_UID: STRING-UID-NAME contains nondigits
5246 G_NOUSER: UID does not resolve to username
5248 G_VALIDATE_FAILED: Validation error
5250 G_BUFFER_ALLOC: Couldn't allocate gss_buffer_t data
5252 G_BAD_MSG_CTX: Message context invalid
5254 G_WRONG_SIZE: Buffer is the wrong size
5256 G_BAD_USAGE: Credential usage type is unknown
5258 G_UNKNOWN_QOP: Unknown quality of protection specified
5260 G_BAD_HOSTNAME: Hostname in SERVICE-NAME string could not be
5263 G_WRONG_MECH: Mechanism is incorrect
5265 G_BAD_TOK_HEADER: Token header is malformed or corrupt
5267 G_BAD_DIRECTION: Packet was replayed in wrong direction
5269 G_TOK_TRUNC: Token is missing data
5271 G_REFLECT: Token was reflected
5273 G_WRONG_TOKID: Received token ID does not match expected token ID
5276 Kerberos 5 GSSAPI Errors:
5278 @c error table numbering starts at 0
5281 KG_CCACHE_NOMATCH: Principal in credential cache does not match desired
5284 KG_KEYTAB_NOMATCH: No principal in keytab matches desired name
5286 KG_TGT_MISSING: Credential cache has no TGT
5288 KG_NO_SUBKEY: Authenticator has no subkey
5290 KG_CONTEXT_ESTABLISHED: Context is already fully established
5292 KG_BAD_SIGN_TYPE: Unknown signature type in token
5294 KG_BAD_LENGTH: Invalid field length in token
5296 KG_CTX_INCOMPLETE: Attempt to use incomplete security context
5298 KG_CONTEXT: Bad magic number for krb5_gss_ctx_id_t
5300 KG_CRED: Bad magic number for krb5_gss_cred_id_t
5302 KG_ENC_DESC: Bad magic number for krb5_gss_enc_desc
5304 KG_BAD_SEQ: Sequence number in token is corrupt
5306 KG_EMPTY_CCACHE: Credential cache is empty
5308 KG_NO_CTYPES: Acceptor and Initiator share no checksum types
5311 @node kadmin Time Zones, , Errors, Appendix
5312 @appendixsec kadmin Time Zones
5314 This is a complete listing of the time zones recognized by the
5315 @code{kadmin} command.
5321 Universal Time (Coordinated).
5323 Western European Time. (Same as GMT.)
5325 British Summer Time. (1 hour ahead of GMT.)
5327 West Africa Time. (1 hour behind GMT.)
5329 Azores Time. (2 hours behind GMT.)
5331 Brazil Standard Time. (3 hours behind GMT.) Note that the abbreviation
5332 BST also stands for British Summer Time.
5334 Greenland Standard Time. (3 hours behind GMT.) Note that the
5335 abbreviation GST also stands for Guam Standard Time.
5337 Newfoundland Time. (3.5 hours behind GMT.)
5339 Newfoundland Standard Time. (3.5 hours behind GMT.)
5341 Newfoundland Daylight Time. (2.5 hours behind GMT.)
5343 Atlantic Standard Time. (4 hours behind GMT.)
5345 Atlantic Daylight Time. (3 hours behind GMT.)
5347 Eastern Standard Time. (5 hours behind GMT.)
5349 Eastern Daylight Time. (4 hours behind GMT.)
5351 Central Standard Time. (6 hours behind GMT.)
5353 Central Daylight Time. (5 hours behind GMT.)
5355 Mountain Standard Time. (7 hours behind GMT.)
5357 Mountain Daylight Time. (6 hours behind GMT.)
5359 Pacific Standard Time. (8 hours behind GMT.)
5361 Pacific Daylight Time. (7 hours behind GMT.)
5363 Yukon Standard Time. (9 hours behind GMT.)
5365 Yukon Daylight Time. (8 hours behind GMT.)
5367 Hawaii Standard Time. (10 hours behind GMT.)
5369 Hawaii Daylight Time. (9 hours behind GMT.)
5371 Central Alaska Time. (10 hours behind GMT.)
5373 Alaska-Hawaii Standard Time. (10 hours behind GMT.)
5375 Nome Time. (11 hours behind GMT.)
5377 International Date Line West Time. (12 hours behind GMT.)
5379 Central European Time. (1 hour ahead of GMT.)
5381 Middle European Time. (1 hour ahead of GMT.)
5383 Middle European Winter Time. (1 hour ahead of GMT.)
5385 Middle European Summer Time. (2 hours ahead of GMT.)
5387 Swedish Winter Time. (1 hour ahead of GMT.)
5389 Swedish Summer Time. (1 hours ahead of GMT.)
5391 French Winter Time. (1 hour ahead of GMT.)
5393 French Summer Time. (2 hours ahead of GMT.)
5395 Eastern Europe Time; Russia Zone 1. (2 hours ahead of GMT.)
5397 Baghdad Time; Russia Zone 2. (3 hours ahead of GMT.)
5399 Iran Time. (3.5 hours ahead of GMT.)
5401 Russia Zone 3. (4 hours ahead of GMT.)
5403 Russia Zone 4. (5 hours ahead of GMT.)
5405 Indian Standard Time. (5.5 hours ahead of GMT.)
5407 Russia Zone 5. (6 hours ahead of GMT.)
5409 North Sumatra Time. (6.5 hours ahead of GMT.) Note that the
5410 abbreviation NST is also used for Newfoundland Stanard Time.
5412 South Sumatra Time; Russia Zone 6. (7 hours ahead of GMT.) Note that
5413 SST is also Swedish Summer Time.
5415 West Australian Standard Time. (7 hours ahead of GMT.)
5417 West Australian Daylight Time. (8 hours ahead of GMT.)
5419 Java Time. (7.5 hours ahead of GMT.)
5421 China Coast Time; Russia Zone 7. (8 hours ahead of GMT.)
5423 Japan Standard time; Russia Zone 8. (9 hours ahead of GMT.)
5425 Korean Standard Time. (9 hours ahead of GMT.)
5427 Central Australian Standard Time. (9.5 hours ahead of GMT.)
5429 Central Australian Daylight Time. (10.5 hours ahead of GMT.)
5431 Eastern Australian Standard Time. (10 hours ahead of GMT.)
5433 Eastern Australian Daylight Time. (11 hours ahead of GMT.)
5435 Guam Standard Time; Russia Zone 9. (10 hours ahead of GMT.)
5437 Korean Daylight Time. (10 hours ahead of GMT.)
5439 New Zealand Time. (12 hours ahead of GMT.)
5441 New Zealand Standard Time. (12 hours ahead of GMT.)
5443 New Zealand Daylight Time. (13 hours ahead of GMT.)
5445 International Date Line East. (12 hours ahead of GMT.)