User Commands NTLMAUTH(1)
NAME
ntlmauth - tool to allow external access to Winbind's NTLM
authentication function
SYNOPSIS
ntlmauth [-d debuglevel] [-l logdir] [-s ]
DESCRIPTION
This tool is part of the samba(7) suite.
ntlmauth is a helper utility that authenticates users using
NT/LM authentication. It returns 0 if the users is
authenticated successfully and 1 if access was denied.
ntlmauth uses winbind to access the user and authentication
data for a domain. This utility is only indended to be used
by other programs (currently Squid and modntlmwinbind)
OPERATIONAL REQUIREMENTS
The winbindd(1M) daemon must be operational for many of
these commands to function.
Some of these commands also require access to the directory
winbinddprivileged in $LOCKDIR. This should be done either
by running this command as root or providing group access to
the winbinddprivileged directory. For security reasons,
this directory should not be world-accessable.
OPTIONS
--helper-protocol=PROTO
Operate as a stdio-based helper. Valid helper protocols
are:
squid-2.4-basic
Server-side helper for use with Squid 2.4's basic
(plaintext) authentication.
squid-2.5-basic
Server-side helper for use with Squid 2.5's basic
(plaintext) authentication.
squid-2.5-ntlmssp
Server-side helper for use with Squid 2.5's NTLMSP
authentication.
Requires access to the directory winbinddprivileged
in $LOCKDIR. The protocol used is described here:
http:/devel.squid-cache.org/ntlm/squidhelperprotocol.html.
This protocol has been extended to allow the NTLMSP
Negotiate packet to be included as an argument to
the YR command. (Thus avoiding loss of information
in the protocol exchange).
Samba 3.0 Last change: 01/19/2009 1
User Commands NTLMAUTH(1)
ntlmssp-client-1
Client-side helper for use with arbitrary external
programs that may wish to use Samba's NTLMSP
authentication knowledge.
This helper is a client, and as such may be run by
any user. The protocol used is effectively the
reverse of the previous protocol. A YR command
(without any arguments) starts the authentication
exchange.
gss-spnego
Server-side helper that implements GS-SPNEGO. This
uses a protocol that is almost the same as
squid-2.5-ntlmssp, but has some subtle differences
that are undocumented outside the source at this
stage.
Requires access to the directory winbinddprivileged
in $LOCKDIR.
gss-spnego-client
Client-side helper that implements GS-SPNEGO. This
also uses a protocol similar to the above helpers,
but is currently undocumented.
ntlm-server-1
Server-side helper protocol, intended for use by a
RADIUS server or the 'winbind' plugin for pppd, for
the provision of MSCHAP and MSCHAPv2 authentication.
This protocol consists of lines in the form:
Parameter: value and Parameter:: Base64-encode
value. The presence of a single period indicates
that one side has finished supplying data to the
other. (Which in turn could cause the helper to
authenticate the user).
Curently implemented parameters from the external
program to the helper are:
Username
The username, expected to be in Samba's unix
charset.
Username
The user's domain, expected to be in Samba's
unix charset.
Full-Username
The fully qualified username, expected to be in
Samba's unix charset and qualified with the
Samba 3.0 Last change: 01/19/2009 2
User Commands NTLMAUTH(1)
winbind separator.
LANMAN-Challenge
The 8 byte LANMAN Challenge value, generated
randomly by the server, or (in cases such as
MSCHAPv2) generated in some way by both the
server and the client.
LANMAN-Response
The 24 byte LANMAN Response value, calculated
from the user's password and the supplied LANMAN
Challenge. Typically, this is provided over the
network by a client wishing to authenticate.
NT-Response
The >= 24 byte NT Response calculated from the
user's password and the supplied LANMAN
Challenge. Typically, this is provided over the
network by a client wishing to authenticate.
Password
The user's password. This would be provided by a
network client, if the helper is being used in a
legacy situation that exposes plaintext
passwords in this way.
Request-User-Session-Key
Apon sucessful authenticaiton, return the user
session key associated with the login.
Request-LanMan-Session-Key
Apon sucessful authenticaiton, return the LANMAN
session key associated with the login.
Warning Implementors should take care to base64
encode any data (such as
usernames/passwords) that may contain malicous user
data, such as a newline. They may also
need to decode strings from the helper,
which likewise may have been base64 encoded.
--username=USERNAME
Specify username of user to authenticate
--domain=DOMAIN
Specify domain of user to authenticate
--workstation=WORKSTATION
Specify the workstation the user authenticated from
--challenge=STRING
NTLM challenge (in HEXADECIMAL)
Samba 3.0 Last change: 01/19/2009 3
User Commands NTLMAUTH(1)
--lm-response=RESPONSE
LM Response to the challenge (in HEXADECIMAL)
--nt-response=RESPONSE
NT or NTLMv2 Response to the challenge (in HEXADECIMAL)
--password=PASWORD
User's plaintext password
If not specified on the command line, this is prompted
for when required.
For the NTLMSP based server roles, this parameter
specifies the expected password, allowing testing
without winbindd operational.
--request-lm-key
Retreive LM session key
--request-nt-key
Request NT key
--diagnostics
Perform Diagnostics on the authentication chain. Uses
the password from --password or prompts for one.
--require-membership-of={SIDName}
Require that a user be a member of specified group
(either name or SID) for authentication to succeed.
-d--debuglevel=level
level is an integer from 0 to 10. The default value if
this parameter is not specified is 0.
The higher this value, the more detail will be logged to
the log files about the activities of the server. At
level 0, only critical errors and serious warnings will
be logged. Level 1 is a reasonable level for day-to-day
running - it generates a small amount of information
about operations carried out.
Levels above 1 will generate considerable amounts of log
data, and should only be used when investigating a
problem. Levels above 3 are designed for use only by
developers and generate HUGE amounts of log data, most
of which is extremely cryptic.
Note that specifying this parameter here will override
the log level parameter in the smb.conf file.
-V
Prints the program version number.
Samba 3.0 Last change: 01/19/2009 4
User Commands NTLMAUTH(1)
-s
The file specified contains the configuration details
required by the server. The information in this file
includes server-specific information such as what
printcap file to use, as well as descriptions of all the
services that the server is to provide. See smb.conf for
more information. The default configuration file name is
determined at compile time.
-l--log-basename=logdirectory
Base directory name for log/debug files. The extension
".progname" will be appended (e.g. log.smbclient,
log.smbd, etc...). The log file is never removed by the
client.
-h--help
Print a summary of command line options.
EXAMPLE SETUP
To setup ntlmauth for use by squid 2.5, with both basic and
NTLMSP authentication, the following should be placed in
the squid.conf file.
authparam ntlm program ntlmauth --helper-protocol=squid-2.5-ntlmssp
authparam basic program ntlmauth --helper-protocol=squid-2.5-basic
authparam basic children 5
authparam basic realm Squid proxy-caching web server
authparam basic credentialsttl 2 hours
Note
This example assumes that ntlmauth has been installed into
your path, and that the group permissions on
winbinddprivileged are as described above.
To setup ntlmauth for use by squid 2.5 with group
limitation in addition to the above example, the following
should be added to the squid.conf file.
authparam ntlm program ntlmauth --helper-protocol=squid-2.5-ntlmssp --require-membership-of='WORKGROUP\Domain Users'
authparam basic program ntlmauth --helper-protocol=squid-2.5-basic --require-membership-of='WORKGROUP\Domain Users'
TROUBLESHOTING
If you're experiencing problems with authenticating Internet
Explorer running under MS Windows 9X or Millenium Edition
against ntlmauth's NTLMSP authentication helper
(--helper-protocol=squid-2.5-ntlmssp), then please read the
Microsoft Knowledge Base article #239869 and follow
instructions described there.
VERSION
Samba 3.0 Last change: 01/19/2009 5
User Commands NTLMAUTH(1)
This man page is correct for version 3.0 of the Samba suite.
AUTHOR
The original Samba software and related utilities were
created by Andrew Tridgell. Samba is now developed by the
Samba Team as an Open Source project similar to the way the
Linux kernel is developed.
The ntlmauth manpage was written by Jelmer Vernooij and
Andrew Bartlett.
ATRIBUTES
See attributes(5) for descriptions of the following
attributes:
ATRIBUTE TYPE ATRIBUTE VALUE
Availability SUNWsmbar, SUNWsmbau
Interface Stability External
NOTES
Source for Samba is available on http:/opensolaris.org.
Samba(7) delivers the set of four SMF(5) services as can be
seen from the following example:
$ svcs samba wins winbind swat
STATE STIME FMRI
disabled Apr21 svc:/network/samba:default
disabled Apr21 svc:/network/winbind:default
disabled Apr21 svc:/network/wins:default
disabled Apr21 svc:/network/swat:default
where the services are:
"samba"
runs the smbd daemon managing the CIFS sessions
"wins"
runs the nmbd daemon enabling the browsing (WINS)
"winbind"
runs the winbindd daemon making the domain idmap
"swat"
Samba Web Administration Tool is a service providing
access to browser-based Samba administration interface
and on-line documentation. The service runs on software
loopback network interface on port 901/tcp, i.e. opening
Samba 3.0 Last change: 01/19/2009 6
User Commands NTLMAUTH(1)
"http:/localhost:901/" in browser will access the SWAT
service on local machine.
Please note: SWAT uses HTP Basic Authentication scheme
where user name and passwords are sent over the network in
clear text. In the SWAT case the user name is root.
Transferring such sensitive data is advisable only on the
software loopback network interface or over secure networks.
Samba 3.0 Last change: 01/19/2009 7
|
