Added "Installing and configuring UNIX client machines" section
authorZhanna Tsitkov <tsitkova@mit.edu>
Thu, 30 Jun 2011 18:22:44 +0000 (18:22 +0000)
committerZhanna Tsitkov <tsitkova@mit.edu>
Thu, 30 Jun 2011 18:22:44 +0000 (18:22 +0000)
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25006 dc483132-0cff-0310-8789-dd5450dbe970

doc/rst_source/krb_admins/index.rst
doc/rst_source/krb_admins/install_appl_srv.rst
doc/rst_source/krb_admins/install_clients/cl_config.rst [new file with mode: 0644]
doc/rst_source/krb_admins/install_clients/index.rst
doc/rst_source/krb_admins/install_clients/mac_osX_config.rst [new file with mode: 0644]
doc/rst_source/krb_admins/install_kdc/index.rst

index ec83570a192fc06a62da2455bf3c95951bcf7525..1d835a2aca69cf5596ad74913bdab29dbe3da37c 100644 (file)
@@ -5,17 +5,14 @@ For administrators
 Contents:
 ---------
 
+
 .. toctree::
    :maxdepth: 1
 
    install.rst
-
-.. toctree::
-   :maxdepth: 2
-
    conf_files/index.rst
-   dns.rst
    realm_config/index.rst
+   dns.rst
    database/index.rst
    conf_ldap.rst
    appl_servers/index.rst
index d53e2912c2870fc1933da0f5375a6255a17c03d6..705ec2c386ef5ae7f914378342b7591886d60fd9 100644 (file)
@@ -8,7 +8,7 @@ If you have Kerberos V5 installed on all of your client machines, MIT recommends
 .. _kt_file_label:
 
 
-The Keytab File
+The keytab file
 ----------------------
 
 All Kerberos server machines need a *keytab* file, called */etc/krb5.keytab*, to authenticate to the KDC. The keytab file is an encrypted, local, on-disk copy of the host's key. The keytab file, like the stash file (See :ref:`create_db_label`) is a potential point-of-entry for a break-in, and if compromised, would allow unrestricted access to its host. The *keytab* file should be readable only by root, and should exist only on the machine's local disk. The file should not be part of any backup of the machine, unless access to the backup data is secured as tightly as access to the machine's root password itself.
@@ -35,7 +35,7 @@ For example, to generate a *keytab* file to allow the host *trillium.mit.edu* to
 
 If you generate the *keytab* file on another host, you need to get a copy of the *keytab* file onto the destination host (*trillium*, in the above example) without sending it unencrypted over the network.
 
-Some Advice about Secure Hosts
+Some advice about secure hosts
 --------------------------------------
 
 Kerberos V5 can protect your host from certain types of break-ins, but it is possible to install Kerberos V5 and still leave your host vulnerable to attack. Obviously an installation guide is not the place to try to include an exhaustive list of countermeasures for every possible attack, but it is worth noting some of the larger holes and how to close them.
diff --git a/doc/rst_source/krb_admins/install_clients/cl_config.rst b/doc/rst_source/krb_admins/install_clients/cl_config.rst
new file mode 100644 (file)
index 0000000..26acbb0
--- /dev/null
@@ -0,0 +1,24 @@
+Client machine configuration files
+=====================================
+
+
+Each machine running Kerberos must have a */etc/krb5.conf* file. (See :ref:`krb5_conf_label`.)
+
+Also, for most UNIX systems, you must add the appropriate Kerberos services to each client machine's */etc/services* file. If you are using the default configuration for Kerberos V5, you should be able to just insert the following code::
+
+     kerberos      88/udp    kdc    # Kerberos V5 KDC
+     kerberos      88/tcp    kdc    # Kerberos V5 KDC
+     kerberos-adm  749/tcp          # Kerberos 5 admin/changepw
+     kerberos-adm  749/udp          # Kerberos 5 admin/changepw
+     krb5_prop     754/tcp          # Kerberos slave propagation
+     krb524        4444/tcp         # Kerberos 5 to 4 ticket translator
+     
+
+------------
+
+Feedback:
+
+Please, provide your feedback or suggest a new topic at krb5-bugs@mit.edu?subject=Documentation___cl_install
+
+
+
index e41e48eaa309c0b3a60be97bdbf1f6104d4be4f7..b83ecf59510ab16a0b5deb9e6d848dda8ce41bf6 100644 (file)
@@ -1,4 +1,21 @@
-Installing and Configuring UNIX Client Machines
+Installing and configuring UNIX client machines
 =====================================================
 
+The Kerberized client programs are *kinit, klist, kdestroy, kpasswd,* and *ksu*. All of these programs are in the directory */usr/local/bin*. MIT recommends that you use login.krb5 in place of /bin/login to give your users a single-sign-on system. You will need to make sure your users know to use their Kerberos passwords when they log in.
+
+You will also need to educate your users to use the ticket management programs *kinit, klist, kdestroy,* and to use the Kerberos programs *ksu* and *kpasswd* in place of their non-Kerberos counterparts *su* and *passwd*. 
+
+.. toctree::
+   :maxdepth: 1
+
+   cl_config.rst
+   mac_osX_config.rst
+
+------------
+
+Feedback:
+
+Please, provide your feedback or suggest a new topic at krb5-bugs@mit.edu?subject=Documentation___cl_install
+
+
 
diff --git a/doc/rst_source/krb_admins/install_clients/mac_osX_config.rst b/doc/rst_source/krb_admins/install_clients/mac_osX_config.rst
new file mode 100644 (file)
index 0000000..b68425d
--- /dev/null
@@ -0,0 +1,63 @@
+Mac OS X configuration
+=======================
+
+To install Kerberos V5 on Mac OS X and Mac OS X Server, follow the directions for generic Unix-based OS's, except for the */etc/services* updates described above.
+
+Mac OS X and Mac OS X Server use a database called NetInfo to store the contents of files normally found in */etc*. Instead of modifying */etc/services*, you should run the following commands to add the Kerberos service entries to NetInfo::
+
+     $ niutil -create . /services/kerberos
+     $ niutil -createprop . /services/kerberos name kerberos kdc
+     $ niutil -createprop . /services/kerberos port 750
+     $ niutil -createprop . /services/kerberos protocol tcp udp
+     $ niutil -create . /services/krbupdate
+     $ niutil -createprop . /services/krbupdate name krbupdate kreg
+     $ niutil -createprop . /services/krbupdate port 760
+     $ niutil -createprop . /services/krbupdate protocol tcp
+     $ niutil -create . /services/kpasswd
+     $ niutil -createprop . /services/kpasswd name kpasswd kpwd
+     $ niutil -createprop . /services/kpasswd port 761
+     $ niutil -createprop . /services/kpasswd protocol tcp
+     $ niutil -create . /services/klogin
+     $ niutil -createprop . /services/klogin port 543
+     $ niutil -createprop . /services/klogin protocol tcp
+     $ niutil -create . /services/eklogin
+     $ niutil -createprop . /services/eklogin port 2105
+     $ niutil -createprop . /services/eklogin protocol tcp
+     $ niutil -create . /services/kshell
+     $ niutil -createprop . /services/kshell name kshell krcmd
+     $ niutil -createprop . /services/kshell port 544
+     $ niutil -createprop . /services/kshell protocol tcp
+     
+
+In addition to adding services to NetInfo, you must also modify the resolver configuration in NetInfo so that the machine resolves its own hostname as a FQDN (fully qualified domain name). By default, Mac OS X and Mac OS X Server machines query NetInfo to resolve hostnames before falling back to DNS. Because NetInfo has an unqualified name for all the machines in the NetInfo database, the machine's own hostname will resolve to an unqualified name. Kerberos needs a FQDN to look up keys in the machine's keytab file.
+
+Fortunately, you can change the lookupd caching order to query DNS first. Run the following NetInfo commands and reboot the machine::
+
+     $ niutil -create . /locations/lookupd/hosts
+     $ niutil -createprop . /locations/lookupd/hosts LookupOrder CacheAgent DNSAgent
+      NIAgent NILAgent
+     
+
+Once you have rebooted, you can verify that the resolver now behaves correctly. Compile the Kerberos 5 distribution and run::
+
+     $ cd .../src/tests/resolve
+     $ ./resolve
+     
+
+This will tell you whether or not your machine returns FQDNs on name lookups. If the test still fails, you can also try turning off DNS caching. Run the following commands and reboot::
+
+     $ niutil -create . /locations/lookupd/hosts
+     $ niutil -createprop . /locations/lookupd/hosts LookupOrder DNSAgent
+      CacheAgent NIAgent NILAgent
+     
+
+The remainder of the setup of a Mac OS X client machine or application server should be the same as for other UNIX-based systems.
+
+------------
+
+Feedback:
+
+Please, provide your feedback or suggest a new topic at krb5-bugs@mit.edu?subject=Documentation___cl_install
+
+
+
index eb90ef5b769b0f3c5b1f0b6e3222312db3227059..29a1a2aa24dc7c3f219ca24a6b225cb2f104b533 100644 (file)
@@ -48,7 +48,7 @@ Back on the Master KDC
 
 Now that the slave KDCs have copies of the Kerberos database, you can create stash files for them and start the krb5kdc daemon. 
 
-Finish Installing the Slave KDCs
+Finish installing the Slave KDCs
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. toctree::