summaryrefslogtreecommitdiffstats
path: root/docs/htmldocs/ntlm_auth.1.html
blob: 3fe48ac02d70e9c714b484684ee1177e23d9ec45 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ntlm_auth</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="ntlm-auth.1"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>ntlm_auth &#8212; tool to allow external access to Winbind's NTLM authentication function</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">ntlm_auth</tt>  [-d debuglevel] [-l logfile] [-s &lt;smb config file&gt;]</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html"><span class="citerefentry"><span class="refentrytitle">Samba</span>(7)</span></a> suite.</p><p><b class="command">ntlm_auth</b> 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. ntlm_auth uses winbind to access 
	the user and authentication data for a domain. This utility 
	is only to be used by other programs (currently squid).
	</p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">--helper-protocol=PROTO</span></dt><dd><p>
	Operate as a stdio-based helper
	</p></dd><dt><span class="term">--username=USERNAME</span></dt><dd><p>
	Specify username of user to authenticate
	</p></dd><dt><span class="term">--domain=DOMAIN</span></dt><dd><p>
	Specify domain of user to authenticate
	</p></dd><dt><span class="term">--workstation=WORKSTATION</span></dt><dd><p>
	Specify the workstation the user authenticated from
	</p></dd><dt><span class="term">--challenge=STRING</span></dt><dd><p>challenge (HEX encoded)</p></dd><dt><span class="term">--lm-response=RESPONSE</span></dt><dd><p>LM Response to the challenge (HEX encoded)</p></dd><dt><span class="term">--nt-response=RESPONSE</span></dt><dd><p>NT or NTLMv2 Response to the challenge (HEX encoded)</p></dd><dt><span class="term">--password=PASSWORD</span></dt><dd><p>User's plaintext password</p></dd><dt><span class="term">--request-lm-key</span></dt><dd><p>Retreive LM session key</p></dd><dt><span class="term">--request-nt-key</span></dt><dd><p>Request NT key</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the version number for 
<b class="command">smbd</b>.</p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></dt><dd><p>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 <tt class="filename">smb.conf</tt> for more information.
The default configuration file name is determined at 
compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i class="replaceable"><tt>debuglevel</tt></i> is an integer 
from 0 to 10.  The default value if this parameter is 
not specified is zero.</p><p>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.</p><p>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.</p><p>Note that specifying this parameter here will 
override the <a class="indexterm" name="id2796757"></a><i class="parameter"><tt>log level</tt></i> parameter
in the <tt class="filename">smb.conf</tt> file.</p></dd><dt><span class="term">-l|--logfile=logbasename</span></dt><dd><p>File name for log/debug files. The extension
<tt class="constant">&quot;.client&quot;</tt> will be appended. The log file is
never removed by the client.
</p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
</p></dd></dl></div></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba 
	suite.</p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>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.</p><p>The ntlm_auth manpage was written by Jelmer Vernooij.</p></div></div></body></html>