1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
4 <!ENTITY % globalentities SYSTEM '../entities/global.entities'> %globalentities;
6 <refentry id="ntlm-auth.1">
9 <refentrytitle>ntlm_auth</refentrytitle>
10 <manvolnum>1</manvolnum>
15 <refname>ntlm_auth</refname>
16 <refpurpose>tool to allow external access to Winbind's NTLM authentication function</refpurpose>
21 <command>ntlm_auth</command>
22 <arg choice="opt">-d debuglevel</arg>
23 <arg choice="opt">-l logdir</arg>
24 <arg choice="opt">-s <smb config file></arg>
29 <title>DESCRIPTION</title>
31 <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
32 <manvolnum>7</manvolnum></citerefentry> suite.</para>
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 squid).
43 <title>OPERATIONAL REQUIREMENTS</title>
46 The <citerefentry><refentrytitle>winbindd</refentrytitle>
47 <manvolnum>8</manvolnum></citerefentry> daemon must be operational
48 for many of these commands to function.</para>
50 <para>Some of these commands also require access to the directory
51 <filename>winbindd_privileged</filename> in
52 <filename>$LOCKDIR</filename>. This should be done either by running
53 this command as root or providing group access
54 to the <filename>winbindd_privileged</filename> directory. For
55 security reasons, this directory should not be world-accessable. </para>
61 <title>OPTIONS</title>
65 <term>--helper-protocol=PROTO</term>
67 Operate as a stdio-based helper. Valid helper protocols are:
71 <term>squid-2.4-basic</term>
73 Server-side helper for use with Squid 2.4's basic (plaintext)
74 authentication. </para>
78 <term>squid-2.5-basic</term>
80 Server-side helper for use with Squid 2.5's basic (plaintext)
81 authentication. </para>
85 <term>squid-2.5-ntlmssp</term>
87 Server-side helper for use with Squid 2.5's NTLMSSP
88 authentication. </para>
89 <para>Requires access to the directory
90 <filename>winbindd_privileged</filename> in
91 <filename>$LOCKDIR</filename>. The protocol used is
92 described here: <ulink
93 url="http://devel.squid-cache.org/ntlm/squid_helper_protocol.html">http://devel.squid-cache.org/ntlm/squid_helper_protocol.html</ulink>
98 <term>ntlmssp-client-1</term>
100 Cleint-side helper for use with arbitary external
101 programs that may wish to use Samba's NTLMSSP
102 authentication knowlege. </para>
103 <para>This helper is a client, and as such may be run by any
104 user. The protocol used is
105 effectivly the reverse of the previous protocol.
111 <term>gss-spnego</term>
113 Server-side helper that implements GSS-SPNEGO. This
114 uses a protocol that is almost the same as
115 <command>squid-2.5-ntlmssp</command>, but has some
116 subtle differences that are undocumented outside the
117 source at this stage.
119 <para>Requires access to the directory
120 <filename>winbindd_privileged</filename> in
121 <filename>$LOCKDIR</filename>.
127 <term>gss-spnego-client</term>
129 Client-side helper that implements GSS-SPNEGO. This
130 also uses a protocol similar to the above helpers, but
131 is currently undocumented.
140 <term>--username=USERNAME</term>
142 Specify username of user to authenticate
148 <term>--domain=DOMAIN</term>
150 Specify domain of user to authenticate
155 <term>--workstation=WORKSTATION</term>
157 Specify the workstation the user authenticated from
162 <term>--challenge=STRING</term>
163 <listitem><para>NTLM challenge (in HEXADECIMAL)</para>
168 <term>--lm-response=RESPONSE</term>
169 <listitem><para>LM Response to the challenge (in HEXADECIMAL)</para></listitem>
173 <term>--nt-response=RESPONSE</term>
174 <listitem><para>NT or NTLMv2 Response to the challenge (in HEXADECIMAL)</para></listitem>
178 <term>--password=PASSWORD</term>
179 <listitem><para>User's plaintext password</para><para>If
180 not specified on the command line, this is prompted for when
181 required. </para></listitem>
185 <term>--request-lm-key</term>
186 <listitem><para>Retreive LM session key</para></listitem>
190 <term>--request-nt-key</term>
191 <listitem><para>Request NT key</para></listitem>
195 <term>--diagnostics</term>
196 <listitem><para>Perform Diagnostics on the authentication
197 chain. Uses the password from <command>--password</command>
198 or prompts for one.</para>
209 <title>EXAMPLE SETUP</title>
211 <para>To setup ntlm_auth for use by squid 2.5, with both basic and
212 NTLMSSP authentication, the following
213 should be placed in the <filename>squid.conf</filename> file.
215 auth_param ntlm program ntlm_auth --helper-protocol=squid-2.5-ntlmssp
216 auth_param basic program ntlm_auth --helper-protocol=squid-2.5-basic
217 auth_param basic children 5
218 auth_param basic realm Squid proxy-caching web server
219 auth_param basic credentialsttl 2 hours
220 </programlisting></para>
222 <note><para>This example assumes that ntlm_auth has been installed into your
223 path, and that the group permissions on
224 <filename>winbindd_privileged</filename> are as described above.</para></note>
229 <title>TROUBLESHOOTING</title>
231 <para>If you're experiencing problems with authenticating Internet Explorer running
232 under MS Windows 9X or Millenium Edition against ntlm_auth's NTLMSSP authentication
233 helper (--helper-protocol=squid-2.5-ntlmssp), then please read
234 <ulink url="http://support.microsoft.com/support/kb/articles/Q239/8/69.ASP">
235 the Microsoft Knowledge Base article #239869 and follow instructions described there</ulink>.
240 <title>VERSION</title>
242 <para>This man page is correct for version 3.0 of the Samba
247 <title>AUTHOR</title>
249 <para>The original Samba software and related utilities
250 were created by Andrew Tridgell. Samba is now developed
251 by the Samba Team as an Open Source project similar
252 to the way the Linux kernel is developed.</para>
254 <para>The ntlm_auth manpage was written by Jelmer Vernooij and
255 Andrew Bartlett.</para>