summaryrefslogtreecommitdiffstats
path: root/src/kdc/krb5kdc.M
diff options
context:
space:
mode:
Diffstat (limited to 'src/kdc/krb5kdc.M')
-rw-r--r--src/kdc/krb5kdc.M199
1 files changed, 0 insertions, 199 deletions
diff --git a/src/kdc/krb5kdc.M b/src/kdc/krb5kdc.M
deleted file mode 100644
index 175f1aea31..0000000000
--- a/src/kdc/krb5kdc.M
+++ /dev/null
@@ -1,199 +0,0 @@
-.\" kdc/krb5kdc.M
-.\"
-.\" Copyright 1990, 2008 by the Massachusetts Institute of Technology.
-.\"
-.\" Export of this software from the United States of America may
-.\" require a specific license from the United States Government.
-.\" It is the responsibility of any person or organization contemplating
-.\" export to obtain such a license before exporting.
-.\"
-.\" WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
-.\" distribute this software and its documentation for any purpose and
-.\" without fee is hereby granted, provided that the above copyright
-.\" notice appear in all copies and that both that copyright notice and
-.\" this permission notice appear in supporting documentation, and that
-.\" the name of M.I.T. not be used in advertising or publicity pertaining
-.\" to distribution of the software without specific, written prior
-.\" permission. Furthermore if you modify this software you must label
-.\" your software as modified software and not distribute it in such a
-.\" fashion that it might be confused with the original M.I.T. software.
-.\" M.I.T. makes no representations about the suitability of
-.\" this software for any purpose. It is provided "as is" without express
-.\" or implied warranty.
-.\" "
-.TH KRB5KDC 8
-.SH NAME
-krb5kdc \- Kerberos V5 KDC
-.SH SYNOPSIS
-.B krb5kdc
-[
-.B \-x
-.I db_args
-] [
-.B \-d
-.I dbname
-] [
-.B \-k
-.I keytype
-] [
-.B \-M
-.I mkeyname
-] [
-.B \-p
-.I portnum
-] [
-.B \-m
-] [
-.B \-r
-.I realm
-] [
-.B \-n
-] [
-.B \-w
-.I numworkers
-] [
-.B \-P
-.I pid_file
-]
-.br
-.SH DESCRIPTION
-.I krb5kdc
-is the Kerberos version 5 Authentication Service and Key Distribution
-Center (AS/KDC).
-.PP
-The
-.B \-x
-.I db_args
-option specifies the database specific arguments.
-
-Options supported for LDAP database are:
-.sp
-.nf
-.RS 8
-\-x nconns=<number_of_connections>
-.fi
-specifies the number of connections to be maintained per LDAP server.
-
-.nf
-\-x host=<ldapuri>
-specifies the LDAP server to connect to by a LDAP URI.
-
-\-x binddn=<binddn>
-.fi
-specifies the DN of the object used by the KDC server to bind to the LDAP server.
-This object should have the rights to read the realm container, principal container
-and the subtree that is referenced by the realm.
-
-\-x bindpwd=<bind_password>
-.fi
-specifies the password for the above mentioned binddn. It is recommended not to use this option.
-Instead, the password can be stashed using the stashsrvpw command of kdb5_ldap_util.
-.RE
-.fi
-.PP
-The
-.B \-r
-.I realm
-option specifies the realm for which the server should provide service;
-by default the realm returned by
-.IR krb5_default_local_realm (3)
-is used.
-.PP
-The
-.B \-d
-.I dbname
-option specifies the name under which the principal database can be found; by
-default the database is in DEFAULT_DBM_FILE.
-This option does not apply to the LDAP database.
-.PP
-The
-.B \-k
-.I keytype
-option specifies the key type of the master key to be entered manually
-as a password when \-m is given; the default is "des\-cbc\-crc".
-.PP
-The
-.B \-M
-.I mkeyname
-option specifies the principal name for the master key in the database;
-the default is KRB5_KDB_M_NAME (usually "K/M" in the KDC's realm).
-.PP
-The
-.B \-p
-.I portnum
-option specifies the default UDP port number which the KDC should listen on for
-Kerberos version 5 requests. This value is used when no port is specified in
-the KDC profile and when no port is specified in the Kerberos configuration
-file.
-If no value is available, then the value in /etc/services for service
-"kerberos" is used.
-.PP
-The
-.B \-m
-option specifies that the master database password should be fetched
-from the keyboard rather than from a file on disk.
-.PP
-The
-.B \-n
-option specifies that the KDC does not put itself in the background
-and does not disassociate itself from the terminal. In normal
-operation, you should always allow the KDC to place itself in
-the background.
-.PP
-The
-.B \-w
-.I numworkers
-option tells the KDC to fork
-.I numworkers
-processes to listen to the KDC ports and process requests in parallel.
-The top level KDC process (whose pid is recorded in the pid file if
-the
-.B \-P
-option is also given) acts as a supervisor. The supervisor will relay
-SIGHUP signals to the worker subprocesses, and will terminate the
-worker subprocess if the it is itself terminated or if any other
-worker process exits. NOTE: on operating systems which do not have
-pktinfo support, using worker processes will prevent the KDC from
-listening for UDP packets on network interfaces created after the KDC
-starts.
-.PP
-The
-.B \-P
-.I pid_file
-option tells the KDC to write its PID (followed by a newline) into
-.I pid_file
-after it starts up. This can be used to identify whether the KDC is still
-running and to allow init scripts to stop the correct process.
-.PP
-The KDC may service requests for multiple realms (maximum 32 realms). The
-realms are listed on the command line. Per-realm options that can be
-specified on the command line pertain for each realm that follows it and are
-superseded by subsequent definitions of the same option. For example,
-.PP
-.B krb5kdc
-.B \-p
-.I 2001
-.B \-r
-.I REALM1
-.B \-p
-.I 2002
-.B \-r
-.I REALM2
-.B \-r
-.I REALM3
-.PP
-specifies that the KDC listen on port 2001 for REALM1 and on port 2002 for
-REALM2 and REALM3. Additionally, per-realm parameters may be specified in the
-.I kdc.conf
-file. The location of this file may be specified by the
-.I KRB5_KDC_PROFILE
-environment variable. Parameters specified in this file take precedence over
-options specified on the command line. See the
-.I kdc.conf(5)
-description for further details.
-.SH SEE ALSO
-krb5(3), kdb5_util(8), kdc.conf(5), kdb5_ldap_util(8)
-.SH BUGS
-
-It should fork and go into the background when it finishes reading the
-master password from the terminal.