Fix autoconf 2.70 compatibility
[platform/upstream/krb5.git] / doc / mitK5defaults.rst
1 .. _mitK5defaults:
2
3 MIT Kerberos defaults
4 =====================
5
6 General defaults
7 ----------------
8
9 ========================================== =============================  ====================
10 Description                                   Default                        Environment
11 ========================================== =============================  ====================
12 :ref:`keytab_definition` file               |keytab|                       **KRB5_KTNAME**
13 Client :ref:`keytab_definition` file        |ckeytab|                      **KRB5_CLIENT_KTNAME**
14 Kerberos config file :ref:`krb5.conf(5)`    |krb5conf|\ ``:``\             **KRB5_CONFIG**
15                                             |sysconfdir|\ ``/krb5.conf``
16 KDC config file :ref:`kdc.conf(5)`          |kdcdir|\ ``/kdc.conf``        **KRB5_KDC_PROFILE**
17 KDC database path (DB2)                     |kdcdir|\ ``/principal``
18 Master key :ref:`stash_definition`          |kdcdir|\ ``/.k5.``\ *realm*
19 Admin server ACL file :ref:`kadm5.acl(5)`   |kdcdir|\ ``/kadm5.acl``
20 OTP socket directory                        |kdcrundir|
21 Plugin base directory                       |libdir|\ ``/krb5/plugins``
22 :ref:`rcache_definition` directory          ``/var/tmp``                   **KRB5RCACHEDIR**
23 Master key default enctype                  |defmkey|
24 Default :ref:`keysalt list<Keysalt_lists>`  |defkeysalts|
25 Permitted enctypes                          |defetypes|
26 KDC default port                            88
27 Admin server port                           749
28 Password change port                        464
29 ========================================== =============================  ====================
30
31
32 Replica KDC propagation defaults
33 --------------------------------
34
35 This table shows defaults used by the :ref:`kprop(8)` and
36 :ref:`kpropd(8)` programs.
37
38 ==========================  ================================  ===========
39 Description                 Default                           Environment
40 ==========================  ================================  ===========
41 kprop database dump file    |kdcdir|\ ``/replica_datatrans``
42 kpropd temporary dump file  |kdcdir|\ ``/from_master``
43 kdb5_util location          |sbindir|\ ``/kdb5_util``
44 kprop location              |sbindir|\ ``/kprop``
45 kpropd ACL file             |kdcdir|\ ``/kpropd.acl``
46 kprop port                  754                               KPROP_PORT
47 ==========================  ================================  ===========
48
49
50 .. _paths:
51
52 Default paths for Unix-like systems
53 -----------------------------------
54
55 On Unix-like systems, some paths used by MIT krb5 depend on parameters
56 chosen at build time.  For a custom build, these paths default to
57 subdirectories of ``/usr/local``.  When MIT krb5 is integrated into an
58 operating system, the paths are generally chosen to match the
59 operating system's filesystem layout.
60
61 ==========================  =============  ===========================  ===========================
62 Description                 Symbolic name  Custom build path            Typical OS path
63 ==========================  =============  ===========================  ===========================
64 User programs               BINDIR         ``/usr/local/bin``           ``/usr/bin``
65 Libraries and plugins       LIBDIR         ``/usr/local/lib``           ``/usr/lib``
66 Parent of KDC state dir     LOCALSTATEDIR  ``/usr/local/var``           ``/var``
67 Parent of KDC runtime dir   RUNSTATEDIR    ``/usr/local/var/run``       ``/run``
68 Administrative programs     SBINDIR        ``/usr/local/sbin``          ``/usr/sbin``
69 Alternate krb5.conf dir     SYSCONFDIR     ``/usr/local/etc``           ``/etc``
70 Default ccache name         DEFCCNAME      ``FILE:/tmp/krb5cc_%{uid}``  ``FILE:/tmp/krb5cc_%{uid}``
71 Default keytab name         DEFKTNAME      ``FILE:/etc/krb5.keytab``    ``FILE:/etc/krb5.keytab``
72 ==========================  =============  ===========================  ===========================
73
74 The default client keytab name (DEFCKTNAME) typically defaults to
75 ``FILE:/usr/local/var/krb5/user/%{euid}/client.keytab`` for a custom
76 build.  A native build will typically use a path which will vary
77 according to the operating system's layout of ``/var``.