docs-xml/manpages-3/ntlm_auth.1.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="ntlm-auth.1">
   4
   5 <refmeta>
   6         <refentrytitle>ntlm_auth</refentrytitle>
   7         <manvolnum>1</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">User Commands</refmiscinfo>
  10         <refmiscinfo class="version">3.2</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>ntlm_auth</refname>
  16         <refpurpose>tool to allow external access to Winbind's NTLM authentication function</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <cmdsynopsis>
  21                 <command>ntlm_auth</command>
  22                 <arg choice="opt">-d debuglevel</arg>
  23                 <arg choice="opt">-l logdir</arg>
  24                 <arg choice="opt">-s &lt;smb config file&gt;</arg>
  25         </cmdsynopsis>
  26 </refsynopsisdiv>
  27
  28 <refsect1>
  29         <title>DESCRIPTION</title>
  30
  31         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  32         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  33
  34         <para><command>ntlm_auth</command> is a helper utility that authenticates
  35         users using NT/LM authentication. It returns 0 if the users is authenticated
  36         successfully and 1 if access was denied. ntlm_auth uses winbind to access
  37         the user and authentication data for a domain.  This utility
  38         is only indended to be used by other programs (currently
  39         <ulink url="http://www.squid-cache.org/">Squid</ulink>
  40         and <ulink url="http://download.samba.org/ftp/unpacked/lorikeet/trunk/mod_ntlm_winbind/">mod_ntlm_winbind</ulink>)
  41         </para>
  42 </refsect1>
  43
  44 <refsect1>
  45         <title>OPERATIONAL REQUIREMENTS</title>
  46
  47     <para>
  48     The <citerefentry><refentrytitle>winbindd</refentrytitle>
  49     <manvolnum>8</manvolnum></citerefentry> daemon must be operational
  50     for many of these commands to function.</para>
  51
  52     <para>Some of these commands also require access to the directory
  53     <filename>winbindd_privileged</filename> in
  54     <filename>$LOCKDIR</filename>.  This should be done either by running
  55     this command as root or providing group access
  56     to the <filename>winbindd_privileged</filename> directory.  For
  57     security reasons, this directory should not be world-accessable. </para>
  58
  59 </refsect1>
  60
  61
  62 <refsect1>
  63         <title>OPTIONS</title>
  64
  65         <variablelist>
  66         <varlistentry>
  67         <term>--helper-protocol=PROTO</term>
  68         <listitem><para>
  69         Operate as a stdio-based helper.  Valid helper protocols are:
  70         </para>
  71         <variablelist>
  72               <varlistentry>
  73                 <term>squid-2.4-basic</term>
  74                 <listitem><para>
  75                 Server-side helper for use with Squid 2.4's basic (plaintext)
  76                 authentication.  </para>
  77                 </listitem>
  78                 </varlistentry>
  79               <varlistentry>
  80                 <term>squid-2.5-basic</term>
  81                 <listitem><para>
  82                 Server-side helper for use with Squid 2.5's basic (plaintext)
  83                 authentication. </para>
  84                 </listitem>
  85                 </varlistentry>
  86               <varlistentry>
  87                 <term>squid-2.5-ntlmssp</term>
  88                 <listitem><para>
  89                 Server-side helper for use with Squid 2.5's NTLMSSP
  90                 authentication. </para>
  91                   <para>Requires access to the directory
  92                 <filename>winbindd_privileged</filename> in
  93                 <filename>$LOCKDIR</filename>.  The protocol used is
  94                 described here: <ulink
  95                 url="http://devel.squid-cache.org/ntlm/squid_helper_protocol.html">http://devel.squid-cache.org/ntlm/squid_helper_protocol.html</ulink>.
  96                 This protocol has been extended to allow the
  97                 NTLMSSP Negotiate packet to be included as an argument
  98                 to the <command>YR</command> command. (Thus avoiding
  99                 loss of information in the protocol exchange).
 100                 </para>
 101                 </listitem>
 102               </varlistentry>
 103               <varlistentry>
 104                 <term>ntlmssp-client-1</term>
 105                 <listitem><para>
 106                 Client-side helper for use with arbitrary external
 107                 programs that may wish to use Samba's NTLMSSP
 108                 authentication knowledge. </para>
 109                   <para>This helper is a client, and as such may be run by any
 110                 user.  The protocol used is
 111                 effectively the reverse of the previous protocol.  A
 112                 <command>YR</command> command (without any arguments)
 113                 starts the authentication exchange.
 114                 </para>
 115                 </listitem>
 116               </varlistentry>
 117
 118               <varlistentry>
 119                 <term>gss-spnego</term>
 120                 <listitem><para>
 121                 Server-side helper that implements GSS-SPNEGO.  This
 122                 uses a protocol that is almost the same as
 123                 <command>squid-2.5-ntlmssp</command>, but has some
 124                 subtle differences that are undocumented outside the
 125                 source at this stage.
 126                 </para>
 127                   <para>Requires access to the directory
 128                 <filename>winbindd_privileged</filename> in
 129                 <filename>$LOCKDIR</filename>.
 130                </para>
 131                 </listitem>
 132                 </varlistentry>
 133
 134                 <varlistentry>
 135                                 <term>gss-spnego-client</term>
 136                 <listitem><para>
 137                 Client-side helper that implements GSS-SPNEGO.  This
 138                 also uses a protocol similar to the above helpers, but
 139                 is currently undocumented.
 140                 </para>
 141                 </listitem>
 142                 </varlistentry>
 143
 144                 <varlistentry>
 145                                 <term>ntlm-server-1</term>
 146                 <listitem><para>
 147                 Server-side helper protocol, intended for use by a
 148                 RADIUS server or the 'winbind' plugin for pppd, for
 149                 the provision of MSCHAP and MSCHAPv2 authentication.
 150                 </para>
 151                 <para>This protocol consists of lines in the form:
 152                 <command>Parameter: value</command> and <command>Parameter::
 153                 Base64-encode value</command>.  The presence of a single
 154                 period <command>.</command> indicates that one side has
 155                 finished supplying data to the other.  (Which in turn
 156                 could cause the helper to authenticate the
 157                 user). </para>
 158
 159                 <para>Curently implemented parameters from the
 160                 external program to the helper are:</para>
 161                 <variablelist>
 162                   <varlistentry>
 163                   <term>Username</term>
 164
 165                 <listitem><para>The username, expected to be in
 166                 Samba's <smbconfoption name="unix charset"/>.
 167                 </para>
 168
 169                       <para><example>Username: bob</example></para>
 170                       <para><example>Username:: Ym9i</example></para>
 171                     </listitem></varlistentry>
 172
 173                   <varlistentry>
 174                   <term>Username</term>
 175                 <listitem><para>The user's domain, expected to be in
 176                 Samba's <smbconfoption name="unix charset"/>.
 177                 </para>
 178
 179                       <para><example>Domain: WORKGROUP</example></para>
 180                       <para><example>Domain:: V09SS0dST1VQ</example></para>
 181                     </listitem></varlistentry>
 182
 183                   <varlistentry>
 184                   <term>Full-Username</term>
 185                 <listitem><para>The fully qualified username, expected to be in
 186                 Samba's <smbconfoption><name>unix
 187                 charset</name></smbconfoption> and qualified with the
 188                 <smbconfoption name="winbind separator"/>.
 189                 </para>
 190
 191                       <para><example>Full-Username: WORKGROUP\bob</example></para>
 192                       <para><example>Full-Username:: V09SS0dST1VQYm9i</example></para>
 193                     </listitem></varlistentry>
 194
 195                   <varlistentry>
 196                   <term>LANMAN-Challenge</term>
 197
 198                 <listitem><para>The 8 byte <command>LANMAN Challenge</command> value,
 199                 generated randomly by the server, or (in cases such as
 200                 MSCHAPv2) generated in some way by both the server and
 201                 the client.
 202                 </para>
 203                       <para><example>LANMAN-Challege: 0102030405060708</example></para>
 204                     </listitem></varlistentry>
 205
 206                   <varlistentry>
 207                   <term>LANMAN-Response</term>
 208
 209                 <listitem><para>The 24 byte <command>LANMAN Response</command> value,
 210                 calculated from the user's password and the supplied
 211                 <command>LANMAN Challenge</command>.  Typically, this
 212                 is provided over the network by a client wishing to authenticate.
 213                 </para>
 214                       <para><example>LANMAN-Response: 0102030405060708090A0B0C0D0E0F101112131415161718</example></para>
 215
 216                     </listitem></varlistentry>
 217
 218                   <varlistentry>
 219                   <term>NT-Response</term>
 220                 <listitem><para>The >= 24 byte <command>NT Response</command>
 221                 calculated from the user's password and the supplied
 222                 <command>LANMAN Challenge</command>.  Typically, this is
 223                 provided over the network by a client wishing to authenticate.
 224                  </para>
 225                       <para><example>NT-Response: 0102030405060708090A0B0C0D0E0F101112131415161718</example></para>
 226
 227                     </listitem></varlistentry>
 228
 229                   <varlistentry>
 230                   <term>Password</term>
 231                 <listitem><para>The user's password.  This would be
 232                 provided by a network client, if the helper is being
 233                 used in a legacy situation that exposes plaintext
 234                 passwords in this way.
 235                  </para>
 236                       <para><example>Password: samba2</example></para>
 237                       <para><example>Password:: c2FtYmEy</example></para>
 238
 239                     </listitem></varlistentry>
 240
 241                   <varlistentry>
 242                   <term>Request-User-Session-Key</term>
 243                 <listitem><para>Apon sucessful authenticaiton, return
 244                 the user session key associated with the login.
 245                  </para>
 246                       <para><example>Request-User-Session-Key: Yes</example></para>
 247
 248                     </listitem></varlistentry>
 249
 250                   <varlistentry>
 251                   <term>Request-LanMan-Session-Key</term>
 252                 <listitem><para>Apon sucessful authenticaiton, return
 253                 the LANMAN session key associated with the login.
 254                  </para>
 255                       <para><example>Request-LanMan-Session-Key: Yes</example></para>
 256
 257                     </listitem></varlistentry>
 258
 259                 <para><warning>Implementors should take care to base64 encode
 260                 any data (such as usernames/passwords) that may contain malicous user data, such as
 261                 a newline.  They may also need to decode strings from
 262                 the helper, which likewise may have been base64 encoded.</warning></para>
 263         </variablelist>
 264
 265                 </listitem>
 266                 </varlistentry>
 267         </variablelist>
 268         </listitem>
 269       </varlistentry>
 270
 271       <varlistentry>
 272         <term>--username=USERNAME</term>
 273         <listitem><para>
 274         Specify username of user to authenticate
 275         </para></listitem>
 276
 277       </varlistentry>
 278
 279       <varlistentry>
 280         <term>--domain=DOMAIN</term>
 281         <listitem><para>
 282         Specify domain of user to authenticate
 283         </para></listitem>
 284       </varlistentry>
 285
 286       <varlistentry>
 287         <term>--workstation=WORKSTATION</term>
 288         <listitem><para>
 289         Specify the workstation the user authenticated from
 290         </para></listitem>
 291       </varlistentry>
 292
 293         <varlistentry>
 294         <term>--challenge=STRING</term>
 295         <listitem><para>NTLM challenge (in HEXADECIMAL)</para>
 296         </listitem>
 297         </varlistentry>
 298
 299         <varlistentry>
 300         <term>--lm-response=RESPONSE</term>
 301         <listitem><para>LM Response to the challenge (in HEXADECIMAL)</para></listitem>
 302         </varlistentry>
 303
 304         <varlistentry>
 305         <term>--nt-response=RESPONSE</term>
 306         <listitem><para>NT or NTLMv2 Response to the challenge (in HEXADECIMAL)</para></listitem>
 307         </varlistentry>
 308
 309         <varlistentry>
 310         <term>--password=PASSWORD</term>
 311         <listitem><para>User's plaintext password</para><para>If
 312         not specified on the command line, this is prompted for when
 313         required.  </para>
 314
 315           <para>For the NTLMSSP based server roles, this parameter
 316           specifies the expected password, allowing testing without
 317           winbindd operational.</para>
 318         </listitem>
 319         </varlistentry>
 320
 321         <varlistentry>
 322         <term>--request-lm-key</term>
 323         <listitem><para>Retreive LM session key</para></listitem>
 324         </varlistentry>
 325
 326         <varlistentry>
 327         <term>--request-nt-key</term>
 328         <listitem><para>Request NT key</para></listitem>
 329         </varlistentry>
 330
 331       <varlistentry>
 332         <term>--diagnostics</term>
 333         <listitem><para>Perform Diagnostics on the authentication
 334         chain.  Uses the password from <command>--password</command>
 335         or prompts for one.</para>
 336         </listitem>
 337         </varlistentry>
 338
 339         <varlistentry>
 340             <term>--require-membership-of={SID|Name}</term>
 341             <listitem><para>Require that a user be a member of specified
 342             group (either name or SID) for authentication to succeed.</para>
 343             </listitem>
 344         </varlistentry>
 345
 346           &stdarg.server.debug;
 347           &popt.common.samba;
 348           &stdarg.help;
 349
 350         </variablelist>
 351 </refsect1>
 352
 353 <refsect1>
 354         <title>EXAMPLE SETUP</title>
 355
 356         <para>To setup ntlm_auth for use by squid 2.5, with both basic and
 357         NTLMSSP authentication, the following
 358         should be placed in the <filename>squid.conf</filename> file.
 359 <programlisting>
 360 auth_param ntlm program ntlm_auth --helper-protocol=squid-2.5-ntlmssp
 361 auth_param basic program ntlm_auth --helper-protocol=squid-2.5-basic
 362 auth_param basic children 5
 363 auth_param basic realm Squid proxy-caching web server
 364 auth_param basic credentialsttl 2 hours
 365 </programlisting></para>
 366
 367 <note><para>This example assumes that ntlm_auth has been installed into your
 368       path, and that the group permissions on
 369       <filename>winbindd_privileged</filename> are as described above.</para></note>
 370
 371         <para>To setup ntlm_auth for use by squid 2.5 with group limitation in addition to the above
 372         example, the following should be added to the <filename>squid.conf</filename> file.
 373 <programlisting>
 374 auth_param ntlm program ntlm_auth --helper-protocol=squid-2.5-ntlmssp --require-membership-of='WORKGROUP\Domain Users'
 375 auth_param basic program ntlm_auth --helper-protocol=squid-2.5-basic --require-membership-of='WORKGROUP\Domain Users'
 376 </programlisting></para>
 377
 378 </refsect1>
 379
 380 <refsect1>
 381         <title>TROUBLESHOOTING</title>
 382
 383         <para>If you're experiencing problems with authenticating Internet Explorer running
 384         under MS Windows 9X or Millenium Edition against ntlm_auth's NTLMSSP authentication
 385         helper (--helper-protocol=squid-2.5-ntlmssp), then please read
 386         <ulink url="http://support.microsoft.com/support/kb/articles/Q239/8/69.ASP">
 387         the Microsoft Knowledge Base article #239869 and follow instructions described there</ulink>.
 388         </para>
 389 </refsect1>
 390
 391 <refsect1>
 392         <title>VERSION</title>
 393
 394         <para>This man page is correct for version 3.0 of the Samba
 395         suite.</para>
 396 </refsect1>
 397
 398 <refsect1>
 399         <title>AUTHOR</title>
 400
 401         <para>The original Samba software and related utilities
 402         were created by Andrew Tridgell. Samba is now developed
 403         by the Samba Team as an Open Source project similar
 404         to the way the Linux kernel is developed.</para>
 405
 406         <para>The ntlm_auth manpage was written by Jelmer Vernooij and
 407         Andrew Bartlett.</para>
 408 </refsect1>
 409
 410 </refentry>