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">
6 <refentrytitle>ntlm_auth</refentrytitle>
7 <manvolnum>1</manvolnum>
12 <refname>ntlm_auth</refname>
13 <refpurpose>tool to allow external access to Winbind's NTLM authentication function</refpurpose>
18 <command>ntlm_auth</command>
19 <arg choice="opt">-d debuglevel</arg>
20 <arg choice="opt">-l logdir</arg>
21 <arg choice="opt">-s <smb config file></arg>
26 <title>DESCRIPTION</title>
28 <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
29 <manvolnum>7</manvolnum></citerefentry> suite.</para>
31 <para><command>ntlm_auth</command> is a helper utility that authenticates
32 users using NT/LM authentication. It returns 0 if the users is authenticated
33 successfully and 1 if access was denied. ntlm_auth uses winbind to access
34 the user and authentication data for a domain. This utility
35 is only indended to be used by other programs (currently squid).
40 <title>OPERATIONAL REQUIREMENTS</title>
43 The <citerefentry><refentrytitle>winbindd</refentrytitle>
44 <manvolnum>8</manvolnum></citerefentry> daemon must be operational
45 for many of these commands to function.</para>
47 <para>Some of these commands also require access to the directory
48 <filename>winbindd_privileged</filename> in
49 <filename>$LOCKDIR</filename>. This should be done either by running
50 this command as root or providing group access
51 to the <filename>winbindd_privileged</filename> directory. For
52 security reasons, this directory should not be world-accessable. </para>
58 <title>OPTIONS</title>
62 <term>--helper-protocol=PROTO</term>
64 Operate as a stdio-based helper. Valid helper protocols are:
68 <term>squid-2.4-basic</term>
70 Server-side helper for use with Squid 2.4's basic (plaintext)
71 authentication. </para>
75 <term>squid-2.5-basic</term>
77 Server-side helper for use with Squid 2.5's basic (plaintext)
78 authentication. </para>
82 <term>squid-2.5-ntlmssp</term>
84 Server-side helper for use with Squid 2.5's NTLMSSP
85 authentication. </para>
86 <para>Requires access to the directory
87 <filename>winbindd_privileged</filename> in
88 <filename>$LOCKDIR</filename>. The protocol used is
89 described here: <ulink
90 url="http://devel.squid-cache.org/ntlm/squid_helper_protocol.html">http://devel.squid-cache.org/ntlm/squid_helper_protocol.html</ulink>
95 <term>ntlmssp-client-1</term>
97 Cleint-side helper for use with arbitary external
98 programs that may wish to use Samba's NTLMSSP
99 authentication knowlege. </para>
100 <para>This helper is a client, and as such may be run by any
101 user. The protocol used is
102 effectivly the reverse of the previous protocol.
108 <term>gss-spnego</term>
110 Server-side helper that implements GSS-SPNEGO. This
111 uses a protocol that is almost the same as
112 <command>squid-2.5-ntlmssp</command>, but has some
113 subtle differences that are undocumented outside the
114 source at this stage.
116 <para>Requires access to the directory
117 <filename>winbindd_privileged</filename> in
118 <filename>$LOCKDIR</filename>.
124 <term>gss-spnego-client</term>
126 Client-side helper that implements GSS-SPNEGO. This
127 also uses a protocol similar to the above helpers, but
128 is currently undocumented.
137 <term>--username=USERNAME</term>
139 Specify username of user to authenticate
145 <term>--domain=DOMAIN</term>
147 Specify domain of user to authenticate
152 <term>--workstation=WORKSTATION</term>
154 Specify the workstation the user authenticated from
159 <term>--challenge=STRING</term>
160 <listitem><para>NTLM challenge (in HEXADECIMAL)</para>
165 <term>--lm-response=RESPONSE</term>
166 <listitem><para>LM Response to the challenge (in HEXADECIMAL)</para></listitem>
170 <term>--nt-response=RESPONSE</term>
171 <listitem><para>NT or NTLMv2 Response to the challenge (in HEXADECIMAL)</para></listitem>
175 <term>--password=PASSWORD</term>
176 <listitem><para>User's plaintext password</para><para>If
177 not specified on the command line, this is prompted for when
178 required. </para></listitem>
182 <term>--request-lm-key</term>
183 <listitem><para>Retreive LM session key</para></listitem>
187 <term>--request-nt-key</term>
188 <listitem><para>Request NT key</para></listitem>
192 <term>--diagnostics</term>
193 <listitem><para>Perform Diagnostics on the authentication
194 chain. Uses the password from <command>--password</command>
195 or prompts for one.</para>
200 <term>--require-membership-of={SID|Name}</term>
201 <listitem><para>Require that a user be a member of specified
202 group (either name or SID) for authentication to succeed.</para>
213 <title>EXAMPLE SETUP</title>
215 <para>To setup ntlm_auth for use by squid 2.5, with both basic and
216 NTLMSSP authentication, the following
217 should be placed in the <filename>squid.conf</filename> file.
219 auth_param ntlm program ntlm_auth --helper-protocol=squid-2.5-ntlmssp
220 auth_param basic program ntlm_auth --helper-protocol=squid-2.5-basic
221 auth_param basic children 5
222 auth_param basic realm Squid proxy-caching web server
223 auth_param basic credentialsttl 2 hours
224 </programlisting></para>
226 <note><para>This example assumes that ntlm_auth has been installed into your
227 path, and that the group permissions on
228 <filename>winbindd_privileged</filename> are as described above.</para></note>
230 <para>To setup ntlm_auth for use by squid 2.5 with group limitation in addition to the above
231 example, the following should be added to the <filename>squid.conf</filename> file.
233 auth_param ntlm program ntlm_auth --helper-protocol=squid-2.5-ntlmssp --require-membership-of='WORKGROUP\Domain Users'
234 auth_param basic program ntlm_auth --helper-protocol=squid-2.5-basic --require-membership-of='WORKGROUP\Domain Users'
235 </programlisting></para>
240 <title>TROUBLESHOOTING</title>
242 <para>If you're experiencing problems with authenticating Internet Explorer running
243 under MS Windows 9X or Millenium Edition against ntlm_auth's NTLMSSP authentication
244 helper (--helper-protocol=squid-2.5-ntlmssp), then please read
245 <ulink url="http://support.microsoft.com/support/kb/articles/Q239/8/69.ASP">
246 the Microsoft Knowledge Base article #239869 and follow instructions described there</ulink>.
251 <title>VERSION</title>
253 <para>This man page is correct for version 3.0 of the Samba
258 <title>AUTHOR</title>
260 <para>The original Samba software and related utilities
261 were created by Andrew Tridgell. Samba is now developed
262 by the Samba Team as an Open Source project similar
263 to the way the Linux kernel is developed.</para>
265 <para>The ntlm_auth manpage was written by Jelmer Vernooij and
266 Andrew Bartlett.</para>