docs/htmldocs/ntlm_auth.1.html

   1 <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.59.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 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>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">Samba(7)</a> suite.</p><p><b>ntlm_auth</b> is a helper utility that authenticates
   2         users using NT/LM authentication. It returns 0 if the users is authenticated
   3         successfully and 1 if access was denied. ntlm_auth uses winbind to access
   4         the user and authentication data for a domain. This utility
   5         is only to be used by other programs (currently squid).
   6         </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>
   7         Operate as a stdio-based helper
   8         </p></dd><dt><span class="term">--username=USERNAME</span></dt><dd><p>
   9         Specify username of user to authenticate
  10         </p></dd><dt><span class="term">--domain=DOMAIN</span></dt><dd><p>
  11         Specify domain of user to authenticate
  12         </p></dd><dt><span class="term">--workstation=WORKSTATION</span></dt><dd><p>
  13         Specify the workstation the user authenticated from
  14         </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
  15 <b>smbd</b>.</p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the
  16 configuration details required by the server.  The
  17 information in this file includes server-specific
  18 information such as what printcap file to use, as well
  19 as descriptions of all the services that the server is
  20 to provide. See <a href="smb.conf.5.html" target="_top"><tt>
  21 smb.conf(5)</tt></a> for more information.
  22 The default configuration file name is determined at
  23 compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i><tt>debuglevel</tt></i> is an integer
  24 from 0 to 10.  The default value if this parameter is
  25 not specified is zero.</p><p>The higher this value, the more detail will be
  26 logged to the log files about the activities of the
  27 server. At level 0, only critical errors and serious
  28 warnings will be logged. Level 1 is a reasonable level for
  29 day to day running - it generates a small amount of
  30 information about operations carried out.</p><p>Levels above 1 will generate considerable
  31 amounts of log data, and should only be used when
  32 investigating a problem. Levels above 3 are designed for
  33 use only by developers and generate HUGE amounts of log
  34 data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will
  35 override the <a href="smb.conf.5.html#loglevel" target="_top">log
  36 level</a> parameter in the <a href="smb.conf.5.html" target="_top">
  37 <tt>smb.conf(5)</tt></a> file.</p></dd><dt><span class="term">-l|--logfile=logbasename</span></dt><dd><p>File name for log/debug files. The extension
  38 <tt>&quot;.client&quot;</tt> will be appended. The log file is
  39 never removed by the client.
  40 </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
  41 </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
  42         suite.</p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities
  43         were created by Andrew Tridgell. Samba is now developed
  44         by the Samba Team as an Open Source project similar
  45         to the way the Linux kernel is developed.</p><p>The ntlm_auth manpage was written by Jelmer Vernooij.</p></div></div></body></html>