Blame SOURCES/0001-doc-extend-user-principal-section.patch

6b8fee
From d6d1ce2f8b1c81903115b018973c61fc71235b7b Mon Sep 17 00:00:00 2001
6b8fee
From: Sumit Bose <sbose@redhat.com>
6b8fee
Date: Fri, 29 Nov 2019 18:10:03 +0100
6b8fee
Subject: [PATCH] doc: extend user-principal section
6b8fee
6b8fee
Related to https://bugzilla.redhat.com/show_bug.cgi?id=1643814
6b8fee
---
6b8fee
 doc/manual/realm.xml       | 21 +++++++++++++++++++--
6b8fee
 doc/manual/realmd.conf.xml | 15 ++++++++++-----
6b8fee
 2 files changed, 29 insertions(+), 7 deletions(-)
6b8fee
6b8fee
diff --git a/doc/manual/realm.xml b/doc/manual/realm.xml
6b8fee
index 7b73331..55a7640 100644
6b8fee
--- a/doc/manual/realm.xml
6b8fee
+++ b/doc/manual/realm.xml
6b8fee
@@ -254,10 +254,27 @@ $ realm join --user=admin --computer-ou=OU=Special domain.example.com
6b8fee
 		</varlistentry>
6b8fee
 		<varlistentry>
6b8fee
 			<term><option>--user-principal=<parameter>host/name@REALM</parameter></option></term>
6b8fee
-			<listitem><para>Set the userPrincipalName field of the
6b8fee
+			<listitem><para>Set the
6b8fee
+			<option>userPrincipalName</option> field of the
6b8fee
 			computer account to this kerberos principal. If you omit
6b8fee
 			the value for this option, then a principal will be set
6b8fee
-			in the form of <literal>host/shortname@REALM</literal></para></listitem>
6b8fee
+			based on the defaults of the membership software.</para>
6b8fee
+			<para>AD makes a distinction between user and service
6b8fee
+			principals. Only with user principals you can request a
6b8fee
+			Kerberos Ticket-Granting-Ticket (TGT), i.e. only user
6b8fee
+			principals can be used with the <command>kinit</command>
6b8fee
+			command. By default the user principal and the canonical
6b8fee
+			principal name of an AD computer account is
6b8fee
+			shortname$@AD.DOMAIN, where shortname is
6b8fee
+			the NetBIOS name which is limited to 15 characters.</para>
6b8fee
+			<para>If there are applications which are not aware of
6b8fee
+			the AD default and are using a hard-coded default
6b8fee
+			principal the <option>--user-principal</option> can be
6b8fee
+			used to make AD aware of this principal. Please note
6b8fee
+			that <option>userPrincipalName</option> is a single
6b8fee
+			value LDAP attribute, i.e. only one alternative user
6b8fee
+			principal besides the AD default user principal can be
6b8fee
+			set.</para></listitem>
6b8fee
 		</varlistentry>
6b8fee
 	</variablelist>
6b8fee
 
6b8fee
diff --git a/doc/manual/realmd.conf.xml b/doc/manual/realmd.conf.xml
6b8fee
index f0b0879..a26a60c 100644
6b8fee
--- a/doc/manual/realmd.conf.xml
6b8fee
+++ b/doc/manual/realmd.conf.xml
6b8fee
@@ -365,12 +365,17 @@ computer-name = SERVER01
6b8fee
 	</listitem>
6b8fee
 	</varlistentry>
6b8fee
 	<varlistentry>
6b8fee
-	<term><option>user-prinicpal</option></term>
6b8fee
+	<term><option>user-principal</option></term>
6b8fee
 	<listitem>
6b8fee
-		<para>Set the <option>user-prinicpal</option> to yes
6b8fee
-		to create <option>userPrincipalName</option> attributes for the
6b8fee
-		computer account in the realm, in the form
6b8fee
-		host/computer@REALM</para>
6b8fee
+		<para>Set the <option>user-principal</option> to yes
6b8fee
+		to create <option>userPrincipalName</option> attribute for the
6b8fee
+		computer accounts in the realm. The exact value depends on the
6b8fee
+		defaults of the used membership software. To have full control
6b8fee
+		over the value please use the
6b8fee
+		<option>--user-principal</option> option of the
6b8fee
+		<command>realm</command> command, see
6b8fee
+		<citerefentry><refentrytitle>realm</refentrytitle>
6b8fee
+		<manvolnum>8</manvolnum></citerefentry> for details.</para>
6b8fee
 
6b8fee
 		<informalexample>
6b8fee
 <programlisting language="js">
6b8fee
-- 
6b8fee
2.21.0
6b8fee