install-and-document-klog-krb5-20080627
[openafs.git] / doc / xml / AdminReference / sect1 / dpass.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry id="dpass1">
3   <refmeta>
4     <refentrytitle>dpass</refentrytitle>
5     <manvolnum>1</manvolnum>
6   </refmeta>
7   <refnamediv>
8     <refname>dpass</refname>
9     <refpurpose>Returns the DCE password for a new DCE account</refpurpose>
10   </refnamediv>
11   <refsect1>
12     <title>Synopsis</title>
13     <para><emphasis role="bold">dpass</emphasis> [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>original AFS cell name</emphasis>&gt;] [<emphasis role="bold">-help</emphasis>]</para>
14
15     <para><emphasis role="bold">dpass</emphasis> [<emphasis role="bold">-c</emphasis> &lt;<emphasis>original AFS cell name</emphasis>&gt;] [<emphasis role="bold">-h</emphasis>]</para>
16
17   </refsect1>
18   <refsect1>
19     <title>Description</title>
20     <para>The <emphasis role="bold">dpass</emphasis> command returns the DCE password that an administrator
21     assigned to the issuer when using the <emphasis role="bold">dm pass</emphasis> command to migrate AFS
22     user accounts into a DCE cell.</para>
23
24     <para>The <emphasis role="bold">dpass</emphasis> command, issued on an AFS client, requests the issuer's new
25     DCE password from the AFS cell specified with the <emphasis role="bold">-cell</emphasis> argument.</para>
26
27     <para>The issuer must be authenticated as the AFS user whose AFS account was
28     moved into DCE, and be able to provide the user's AFS password when
29     prompted by the <emphasis role="bold">dpass</emphasis> command.</para>
30
31   </refsect1>
32   <refsect1>
33     <title>Options</title>
34     <variablelist>
35       <varlistentry>
36         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
37         <listitem>
38           <para>Specifies the name of the AFS cell from which the AFS account was moved
39           into DCE and from which to fetch the new DCE password.</para>
40
41         </listitem>
42       </varlistentry>
43       <varlistentry>
44         <term><emphasis role="bold">-help</emphasis></term>
45         <listitem>
46           <para>Prints the online help for this command. All other valid options are
47           ignored.</para>
48
49         </listitem>
50       </varlistentry>
51     </variablelist>
52   </refsect1>
53   <refsect1>
54     <title>Output</title>
55     <para>By default, the dpass command writes a message similar to the following to
56     the standard output stream.</para>
57
58 <programlisting>
59    Please read the following message before entering your password.
60
61 </programlisting>
62 <programlisting>
63    This program will display your new, temporary DCE password on your
64    terminal, and you should change the assigned password as soon as
65    possible (from a DCE client).  The program assumes that the AFS cell
66    uses the AFS Authentication Server and that an administrator used the
67    utilities in the AFS/DFS Migration Toolkit to migrate the account from
68    AFS to DCE. The password you enter should be the AFS password that was
69    in effect when your DCE account was created; this is not necessarily
70    the same password you have at the moment.  The cell name (which you may
71    override with a command line option), must be the name of the AFS cell
72    from which the authentication information was taken.
73
74 </programlisting>
75         <para>To suppress this message, set the DPASS_NO_MESSAGE environment
76         variable. It is then possible to substitute a customized message if
77         desired by using a script similar to the following example:</para>
78
79 <programlisting>
80    #! /bin/csh
81    echo "I&amp;lt;Start of customized message&amp;gt;"
82    echo "I&amp;lt;Continuation of customized message&amp;gt;"
83      .
84      .
85      .
86    echo "I&amp;lt;Conclusion of customized message&amp;gt;"
87    setenv DPASS_NO_MESSAGE
88    dpass $*
89
90 </programlisting>
91           <para>After the standard or customized message, if any, the dpass command
92           generates the following prompt for the original AFS password:</para>
93
94 <programlisting>
95    Original password for AFS cell &amp;lt;cell&amp;gt;:
96    Re-enter password to verify:
97
98 </programlisting>
99             <para>If the AFS passwords match and are correct, the command reports the
100             temporary DCE password in the following message.</para>
101
102 <programlisting>
103    The new DCE password is: &amp;lt;Issuer's_temporary_DCE_password
104
105 </programlisting>
106             </refsect1>
107             <refsect1>
108               <title>Examples</title>
109               <para>The following example returns the DCE password of the issuer, whose AFS
110               account is in the <computeroutput>abc.com</computeroutput> cell. The DPASS_NO_MESSAGE variable has been
111               set to suppress the standard message.</para>
112
113 <programlisting>
114    % dpass
115    Original password for AFS cell abc.com: &amp;lt;Issuer's_AFS_password&amp;gt;
116    Re-enter password to verify: &amp;lt;Issuer's_AFS_password&amp;gt;
117    The new DCE password is: 8655--eg8e-dcdc-8157
118
119 </programlisting>
120               </refsect1>
121               <refsect1>
122                 <title>Privilege Required</title>
123                 <para>The issuer must be authenticated as the AFS user for whom to display the
124                 corresponding DCE password.</para>
125
126               </refsect1>
127               <refsect1>
128                 <title>See Also</title>
129                 <para><link linkend="dlog1">dlog(1)</link></para>
130
131                 <para><emphasis role="bold">dm pass</emphasis> reference page in <emphasis>IBM AFS/DFS Migration Toolkit
132                 Administration Guide and Reference</emphasis></para>
133
134               </refsect1>
135               <refsect1>
136                 <title>Copyright</title>
137                 <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
138
139                 <para>This documentation is covered by the IBM Public License Version 1.0.  It was
140                 converted from HTML to POD by software written by Chas Williams and Russ
141                 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
142
143               </refsect1>
144             </refentry>