projects / krb5.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: fc493f6)
pull up r19000 from trunk
authorTom Yu <tlyu@mit.edu>
Thu, 21 Dec 2006 22:07:20 +0000 (22:07 +0000)
committerTom Yu <tlyu@mit.edu>
Thu, 21 Dec 2006 22:07:20 +0000 (22:07 +0000)
 r19000@cathode-dark-space:  raeburn | 2006-12-20 16:12:35 -0500
 ticket: 5116

 Merge r18962 to trunk, with minor tweaks; ready to merge to 1.6 branch.

 Changes fix up some sample names used, remove some options described
 from certain commands, and fix filling in man pages.

  r18962:  rsavitha | 2006-12-18 10:04:18 -0500
  Changed paths:
    M  /mirror/krb5/users/rsavitha/ldap_plugin_patch/src/kadmin/cli/kadmin.M
    M  /mirror/krb5/users/rsavitha/ldap_plugin_patch/src/kadmin/server/kadmind.M
    M  /mirror/krb5/users/rsavitha/ldap_plugin_patch/src/kdc/krb5kdc.M
    M  /mirror/krb5/users/rsavitha/ldap_plugin_patch/src/plugins/kdb/ldap/ldap_util/kdb5_ldap_util.M

  ticket: new
  subject: minor ldap specific changes in man page
  Target_Version: 1.6
  Tags: pullup

  Updated the man pages with some ldap specific changes

ticket: 5116
version_fixed: 1.6

git-svn-id: svn://anonsvn.mit.edu/krb5/branches/krb5-1-6@19004 dc483132-0cff-0310-8789-dd5450dbe970

src/kadmin/cli/kadmin.M patch | blob | history
src/kadmin/server/kadmind.M patch | blob | history
src/kdc/krb5kdc.M patch | blob | history
src/plugins/kdb/ldap/ldap_util/kdb5_ldap_util.M patch | blob | history

diff --git a/src/kadmin/cli/kadmin.M b/src/kadmin/cli/kadmin.M
index 6706083e61a185cd7e7887decba3a76131907375..20958e88e6b73608bd669e36b816fa5b11d291f5 100644 (file)
--- a/src/kadmin/cli/kadmin.M
+++ b/src/kadmin/cli/kadmin.M
@@ -162,11 +162,13 @@ Options supported for LDAP database are:
 specifies the LDAP server to connect to by a LDAP URI.
 .TP
 \-x binddn=<bind_dn>
+.fi
 specifies the DN of the object used by the administration server to bind to the LDAP server.
-This object should have the read rights on the realm container and write rights on the subtree
-that is referenced by the realm.
+This object should have the read and write rights on the realm container, principal container
+and the subtree that is referenced by the realm.
 .TP
 \-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
@@ -227,8 +229,9 @@ Specifies the LDAP object that will contain the Kerberos principal being
 created.
 .TP
 \-x linkdn=<dn>
+.fi
 Specifies the LDAP object to which the newly created Kerberos principal object
- will point to.
+will point to.
 .TP
 \-x containerdn=<container_dn>
 Specifies the container object under which the Kerberos principal is to be created. 
@@ -475,8 +478,9 @@ Denotes the database specific options. The options for LDAP database are:
 Associates a ticket policy to the Kerberos principal.
 .TP
 \-x linkdn=<dn>
+.fi
 Associates a Kerberos principal with a LDAP object. This option is honored only
- if the Kerberos principal is not already associated with a LDAP object. 
+if the Kerberos principal is not already associated with a LDAP object. 
 .RE
 .TP
 ERRORS:
diff --git a/src/kadmin/server/kadmind.M b/src/kadmin/server/kadmind.M
index dbe4ee86be2b19e52f27d1b3e9e9e3a4f02a399d..ad810e6f2da46faf6a51e172631113f1df14aafe 100644 (file)
--- a/src/kadmin/server/kadmind.M
+++ b/src/kadmin/server/kadmind.M
@@ -64,17 +64,21 @@ Options supported for LDAP database are:
 .nf 
 .RS 12
 \-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 administration server to bind to the LDAP server. 
-This object should have the read rights on the realm container and write rights on the subtree
-that is referenced by the realm.
+This object should have the read and write rights on 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
diff --git a/src/kdc/krb5kdc.M b/src/kdc/krb5kdc.M
index c9ff75b9126c50013167a2e7d83d16ded8bc3254..2056eecd9f27db8b930a9780fd8b2f87e3cbf2e2 100644 (file)
--- a/src/kdc/krb5kdc.M
+++ b/src/kdc/krb5kdc.M
@@ -68,17 +68,21 @@ Options supported for LDAP database are:
 .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 and the subtree that is referenced
-by the realm.
+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
diff --git a/src/plugins/kdb/ldap/ldap_util/kdb5_ldap_util.M b/src/plugins/kdb/ldap/ldap_util/kdb5_ldap_util.M
index 0aa9f9462533740a6f18c9a4820122914a568c26..3fad89136fed564d0a101ea8afc4404bbc39b4ee 100644 (file)
--- a/src/plugins/kdb/ldap/ldap_util/kdb5_ldap_util.M
+++ b/src/plugins/kdb/ldap/ldap_util/kdb5_ldap_util.M
@@ -25,12 +25,12 @@ This option is not recommended.
 Specifies the URI of the LDAP server.
 .SH COMMANDS
 .TP
-\fBcreate\fP [\fB\-subtrees\fP\ \fIsubtree_dn_list\fP] [\fB\-sscope\fP\ \fIsearch_scope\fP] [\fB\-containerref\fP\ \fIcontainer_reference_dn\fP] [\fB\-k\fP\ \fImkeytype\fP] [\fB\-m\fP|\fB\-P\fP\ \fIpassword\fP|\fB\-sf\fP\ \fIstashfilename\fP] [\fB\-s\fP] [\fB\-r\fP\ \fIrealm\fP] [\fB\-kdcdn\fP\ \fIkdc_service_list\fP] [\fB\-admindn\fP\ \fIadmin_service_list\fP] [\fB\-pwddn\fP\ \fIpasswd_service_list\fP] [\fB\-maxtktlife\fP\ \fImax_ticket_life\fP] [\fB\-maxrenewlife\fP\ \fImax_renewable_ticket_life\fP] [\fIticket_flags\fP]
+\fBcreate\fP [\fB\-subtrees\fP\ \fIsubtree_dn_list\fP] [\fB\-sscope\fP\ \fIsearch_scope\fP] [\fB\-containerref\fP\ \fIcontainer_reference_dn\fP] [\fB\-k\fP\ \fImkeytype\fP] [\fB\-m\fP|\fB\-P\fP\ \fIpassword\fP|\fB\-sf\fP\ \fIstashfilename\fP] [\fB\-s\fP] [\fB\-r\fP\ \fIrealm\fP] [\fB\-kdcdn\fP\ \fIkdc_service_list\fP] [\fB\-admindn\fP\ \fIadmin_service_list\fP] [\fB\-maxtktlife\fP\ \fImax_ticket_life\fP] [\fB\-maxrenewlife\fP\ \fImax_renewable_ticket_life\fP] [\fIticket_flags\fP]
 Creates realm in directory. Options:
 .RS
 .TP
-\fB\-subtrees\fP\ \fIsubtree_dn_list\fP 
-Specifies the list of subtrees containing principals and other Kerberos objects of a realm. The list contains the DNs of the subtree
+\fB\-subtrees\fP\ \fIsubtree_dn_list\fP
+Specifies the list of subtrees containing the principals of a realm. The list contains the DNs of the subtree
 objects separated by colon(:).
 .TP
 \fB\-sscope\fP\ \fIsearch_scope\fP
@@ -207,10 +207,6 @@ service objects separated by colon(:).
 Specifies the list of Administration service objects serving the realm. The list contains the DNs
 of the Administration service objects separated by colon(:).
 .TP
-\fB\-pwddn\fP\ \fIpasswd_service_list\fP
-Specifies the list of Password service objects serving the realm. The list contains the DNs of the
-Password service objects separated by colon(:).
-.TP
 EXAMPLE:
 \fBkdb5_ldap_util -D cn=admin,o=org -H ldaps://ldap-server1.mit.edu
 create -subtrees o=org -sscope SUB
@@ -226,14 +222,14 @@ Re-enter KDC database master key to verify:
 .RE
 
 .TP
-\fBmodify\fP [\fB\-subtrees\fP\ \fIsubtree_dn_list\fP] [\fB\-sscope\fP\ \fIsearch_scope\fP] [\fB\-containerref\fP\ \fIcontainer_reference_dn\fP] [\fB\-r\fP\ \fIrealm\fP] [\fB\-kdcdn\fP\ \fIkdc_service_list\fP | [\fB\-clearkdcdn\fP\ \fIkdc_service_list\fP] [\fB\-addkdcdn\fP\ \fIkdc_service_list\fP]] [\fB\-admindn\fP\ \fIadmin_service_list\fP | [\fB\-clearadmindn\fP\ \fIadmin_service_list\fP] [\fB\-addadmindn\fP\ \fIadmin_service_list\fP]] [\fB\-pwddn\fP\ \fIpasswd_service_list\fP | [\fB\-clearpwddn\fP\ \fIpasswd_service_list\fP] [\fB\-addpwddn\fP\ \fIpasswd_service_list\fP]] [\fB\-maxtktlife\fP\ \fImax_ticket_life\fP] [\fB\-maxrenewlife\fP\ \fImax_renewable_ticket_life\fP] [\fIticket_flags\fP]
+\fBmodify\fP [\fB\-subtrees\fP\ \fIsubtree_dn_list\fP] [\fB\-sscope\fP\ \fIsearch_scope\fP] [\fB\-containerref\fP\ \fIcontainer_reference_dn\fP] [\fB\-r\fP\ \fIrealm\fP] [\fB\-kdcdn\fP\ \fIkdc_service_list\fP | [\fB\-clearkdcdn\fP\ \fIkdc_service_list\fP] [\fB\-addkdcdn\fP\ \fIkdc_service_list\fP]] [\fB\-admindn\fP\ \fIadmin_service_list\fP | [\fB\-clearadmindn\fP\ \fIadmin_service_list\fP] [\fB\-addadmindn\fP\ \fIadmin_service_list\fP]] [\fB\-maxtktlife\fP\ \fImax_ticket_life\fP] [\fB\-maxrenewlife\fP\ \fImax_renewable_ticket_life\fP] [\fIticket_flags\fP]
 
 Modifies the attributes of a realm. Options:
 .RS
 .TP
 \fB\-subtrees\fP\ \fIsubtree_dn_list\fP
-Specifies the list of subtrees containing principals and other Kerberos objects 
-in the realm.  The list contains the DNs of the subtree objects separated by 
+Specifies the list of subtrees containing the principals of a realm.
+The list contains the DNs of the subtree objects separated by 
 colon(:). This list replaces the existing list.
 .TP
 \fB\-sscope\fP\ \fIsearch_scope\fP
@@ -387,7 +383,7 @@ is used.
 .TP
 \fB\-kdcdn\fP\ \fIkdc_service_list\fP
 Specifies the list of KDC service objects serving the realm. The list contains the DNs of the KDC
-service objects separated by a colon (:).
+service objects separated by a colon (:). This list replaces the existing list.
 .TP
 \fB\-clearkdcdn\fP\ \fIkdc_service_list\fP
 Specifies the list of KDC service objects that need to be removed from the existing list. The list contains
@@ -399,7 +395,7 @@ DNs of the KDC service objects separated by a colon (:).
 .TP
 \fB\-admindn\fP\ \fIadmin_service_list\fP
 Specifies the list of Administration service objects serving the realm. The list contains the DNs
-of the Administration service objects separated by a colon (:).
+of the Administration service objects separated by a colon (:). This list replaces the existing list.
 .TP
 \fB\-clearadmindn\fP\ \fIadmin_service_list\fP
 Specifies the list of Administration service objects that need to be removed from the existing list. The list
@@ -409,18 +405,6 @@ contains the DNs of the Administration service objects separated by a colon (:).
 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 (:).
 .TP
-\fB\-pwddn\fP\ \fIpasswd_service_list\fP
-Specifies the list of Password service objects serving the realm. The list contains the DNs of the
-Password service objects separated by a colon (:).
-.TP
-\fB\-clearpwddn\fP\ \fIpasswd_service_list\fP
-Specifies the list of Password service objects that need to be removed from the existing list. The list
-contains the DNs of the Password service objects separated by a colon (:).
-.TP
-\fB\-addpwddn\fP\ \fIpasswd_service_list\fP
-Specifies the list of Password service objects that need to be added to the existing list. The list contains
-the DNs of the Password service objects separated by a colon (:).
-.TP
 EXAMPLE:
 \fBkdb5_ldap_util -D cn=admin,o=org -H ldaps://ldap-server1.mit.edu modify 
 +requires_preauth -r ATHENA.MIT.EDU \fP
@@ -486,14 +470,14 @@ EXAMPLE:
 \fBkdb5_ldap_util -D cn=admin,o=org -H ldaps://ldap-server1.mit.edu list\fP
 Password for "cn=admin,o=org":
 ATHENA.MIT.EDU
-MYREALM
+OPENLDAP.MIT.EDU
 MEDIA-LAB.MIT.EDU
 .fi
 .RE
 .TP
 \fBstashsrvpw\fP [\fB\-f\fP\ \fIfilename\fP] \fIservicedn\fP
-Allows an administrator to store the password for service object in a file so that KDC, Administration, and 
-Password server can use it to authenticate to the LDAP server. Options:
+Allows an administrator to store the password for service object in a file so that KDC and Administration
+server can use it to authenticate to the LDAP server. Options:
 .RS
 .TP
 \fB\-f\fP\ \fIfilename\fP
@@ -655,7 +639,7 @@ flag on principals in the database.
 Specifies the name of the ticket policy.
 .TP
 EXAMPLE:
-\fBkdb5_ldap_util -D cn=admin,o=org -H ldaps://ldap-server1.mit.edu create_policy -r ATHENA.MIT.EDU -maxtktlife "1 day" -maxrenewlife "1 week" -allow_postdated +needchange -allow_forwardable newpolicy\fP
+\fBkdb5_ldap_util -D cn=admin,o=org -H ldaps://ldap-server1.mit.edu create_policy -r ATHENA.MIT.EDU -maxtktlife "1 day" -maxrenewlife "1 week" -allow_postdated +needchange -allow_forwardable tktpolicy\fP
 .nf
 Password for "cn=admin,o=org":
 .fi
@@ -673,7 +657,7 @@ returned by
 is used.
 .TP
 EXAMPLE:
-\fBkdb5_ldap_util -D cn=admin,o=org -H ldaps://ldap-server1.mit.edu modify_policy -r ATHENA.MIT.EDU -maxtktlife "60 minutes" -maxrenewlife "10 hours" +allow_postdated -requires_preauth policy1\fP
+\fBkdb5_ldap_util -D cn=admin,o=org -H ldaps://ldap-server1.mit.edu modify_policy -r ATHENA.MIT.EDU -maxtktlife "60 minutes" -maxrenewlife "10 hours" +allow_postdated -requires_preauth tktpolicy\fP
 .nf
 Password for "cn=admin,o=org":
 .fi
@@ -684,13 +668,13 @@ Displays the attributes of a ticket policy. Options:
 .RS
 .TP
 \fIpolicy_name\fP
-Specifies Distinguished name (DN) of the policy.
+Specifies the name of the ticket policy.
 .TP
 EXAMPLE:
-\fBkdb5_ldap_util -D cn=admin,o=org -H ldaps://ldap-server1.mit.edu view_policy -r ATHENA.MIT.EDU policy1\fP
+\fBkdb5_ldap_util -D cn=admin,o=org -H ldaps://ldap-server1.mit.edu view_policy -r ATHENA.MIT.EDU tktpolicy\fP
 .nf
 Password for "cn=admin,o=org":
-            Ticket policy: policy1
+            Ticket policy: tktpolicy
       Maximum ticket life: 0 days 01:00:00
    Maximum renewable life: 0 days 10:00:00
              Ticket flags: DISALLOW_FORWARDABLE REQUIRES_PWCHANGE
@@ -713,15 +697,15 @@ Forces the deletion of the policy object. If not specified, will be prompted for
 to confirm the deletion.
 .TP
 \fIpolicy_name\fP
-Specifies Distinguished name (DN) of the policy.
+Specifies the name of the ticket policy.
 .TP
 EXAMPLE:
-\fBkdb5_ldap_util -D cn=admin,o=org -H ldaps://ldap-server1.mit.edu destroy_policy -r ATHENA.MIT.EDU policy1\fP
+\fBkdb5_ldap_util -D cn=admin,o=org -H ldaps://ldap-server1.mit.edu destroy_policy -r ATHENA.MIT.EDU tktpolicy\fP
 .nf
 Password for "cn=admin,o=org":
-This will delete the policy object 'policy1', are you sure?
+This will delete the policy object 'tktpolicy', are you sure?
 (type 'yes' to confirm)? yes
-** policy object 'policy1' deleted.
+** policy object 'tktpolicy' deleted.
 .fi
 .RE
 .TP
@@ -739,9 +723,9 @@ EXAMPLE:
 \fBkdb5_ldap_util -D cn=admin,o=org -H ldaps://ldap-server1.mit.edu list_policy -r ATHENA.MIT.EDU\fP
 .nf
 Password for "cn=admin,o=org":
-newpolicy
-policy1
-policy2
+tktpolicy
+tmppolicy
+userpolicy
 .fi
 .RE
 
@@ -749,7 +733,7 @@ policy2
 .B Commands Specific to eDirectory
 .TP
 \fBsetsrvpw\fP [\fB\-randpw\fP|\fB\-fileonly\fP] [\fB\-f\fP\ \fIfilename\fP] \fIservice_dn\fP
-Allows an administrator to set password for service objects such as KDC, Administration, and Password server in
+Allows an administrator to set password for service objects such as KDC and Administration server in
 eDirectory and store them in a file. The 
 .I -fileonly 
 option stores the password in a file and not in the eDirectory object. Options:
@@ -785,7 +769,7 @@ Re-enter password for "cn=service-kdc,o=org":
 .fi
 .RE
 .TP
-\fBcreate_service\fP {\fB\-kdc|\-admin|\-pwd\fP} [\fB\-servicehost\fP\ \fIservice_host_list\fP] [\fB\-realm\fP\ \fIrealm_list\fP] [\fB\-randpw|\-fileonly\fP] [\fB\-f\fP\ \fIfilename\fP] \fIservice_dn\fP
+\fBcreate_service\fP {\fB\-kdc|\-admin\fP} [\fB\-servicehost\fP\ \fIservice_host_list\fP] [\fB\-realm\fP\ \fIrealm_list\fP] [\fB\-randpw|\-fileonly\fP] [\fB\-f\fP\ \fIfilename\fP] \fIservice_dn\fP
 Creates a service in directory and assigns appropriate rights. Options:
 .RS
 .TP
@@ -795,9 +779,6 @@ Specifies the service is a KDC service
 \fB\-admin\fP
 Specifies the service is a Administration service
 .TP
-\fB\-pwd\fP
-Specifies the service is a Password service
-.TP
 \fB\-servicehost\fP\ \fIservice_host_list\fP
 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
@@ -806,22 +787,22 @@ For example,
 server1#tcp#88:server2#udp#89.
 .TP
 \fB\-realm\fP\ \fIrealm_list\fP
-Specifies the list of realms that can be serviced by Kerberos. The list contains the name of the realms
+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 (:).
 .TP
 \fB\-randpw \fP
-Generates and sets a random password. This options can be specified to store the password both in eDirectory and a file. The 
+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. The 
 .I -fileonly 
 option can not be used if 
 .I -randpw
-option is already specified.
+option is specified.
 .TP
 \fB\-fileonly\fP
 Stores the password only in a file and not in eDirectory. The 
 .I -randpw
 option can not be used when 
 .I -fileonly
-options is specified.
+option is specified.
 .TP
 \fB\-f\fP\ \fIfilename\fP
 Specifies the complete path of the file where the service object password is stashed.
@@ -859,8 +840,8 @@ server hosting the service, transport protocol, and port number of the service
 separated by a pound sign (#).
 .TP
 \fB\-realm\fP\ \fIrealm_list\fP
-Specifies the list of realms that are associated with this service. The list contains the name of
-the realms separated by a colon (:).
+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.
 .TP
 \fB\-clearrealm\fP\ \fIrealm_list\fP
 Specifies the list of realms to be removed from the existing list. The list contains the name of
@@ -930,7 +911,7 @@ Lists the name of services under a given base in directory. Options:
 .RS
 .TP
 \fB\-basedn\fP\ \fIbase_dn\fP
-Specifies the base DN for searching the policies, limiting the search to a particular subtree. If this option
+Specifies the base DN for searching the service objects, limiting the search to a particular subtree. If this option
 is not provided, LDAP Server specific search base will be used. 
 For eg, in the case of OpenLDAP, value of 
 .B defaultsearchbase
MIT implementation of the Kerberos network authentication protocol. This repo may be rebased, so don't base your work on it. Use git://github.com/krb5/krb5 instead.