ntlm_auth.1.xml   [plain text]

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
				  
<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
]>
<refentry id="ntlm-auth.1">

<refmeta>
	<refentrytitle>ntlm_auth</refentrytitle>
	<manvolnum>1</manvolnum>
</refmeta>


<refnamediv>
	<refname>ntlm_auth</refname>
	<refpurpose>tool to allow external access to Winbind's NTLM authentication function</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis>
		<command>ntlm_auth</command>
		<arg choice="opt">-d debuglevel</arg>
		<arg choice="opt">-l logfile</arg>
		<arg choice="opt">-s &lt;smb config file&gt;</arg>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
	<manvolnum>7</manvolnum></citerefentry> suite.</para>

	<para><command>ntlm_auth</command> 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).
	</para>
</refsect1>


<refsect1>
	<title>OPTIONS</title>

	<variablelist>
	<varlistentry>
	<term>--helper-protocol=PROTO</term>
	<listitem><para>
	Operate as a stdio-based helper
	</para></listitem>
	</varlistentry>

	<varlistentry>
	<term>--username=USERNAME</term>
	<listitem><para>
	Specify username of user to authenticate
	</para></listitem>
	</varlistentry>

	<varlistentry>
	<term>--domain=DOMAIN</term>
	<listitem><para>
	Specify domain of user to authenticate
	</para></listitem>
	</varlistentry>

	<varlistentry>
	<term>--workstation=WORKSTATION</term>
	<listitem><para>
	Specify the workstation the user authenticated from
	</para></listitem>
	</varlistentry>

	<varlistentry>
	<term>--challenge=STRING</term>
	<listitem><para>challenge (HEX encoded)</para></listitem>
	</varlistentry>

	<varlistentry>
	<term>--lm-response=RESPONSE</term>
	<listitem><para>LM Response to the challenge (HEX encoded)</para></listitem>
	</varlistentry>

	<varlistentry>
	<term>--nt-response=RESPONSE</term>
	<listitem><para>NT or NTLMv2 Response to the challenge (HEX encoded)</para></listitem>
	</varlistentry>

	<varlistentry>
	<term>--password=PASSWORD</term>
	<listitem><para>User's plaintext password</para></listitem>
	</varlistentry>

	<varlistentry>
	<term>--request-lm-key</term>
	<listitem><para>Retreive LM session key</para></listitem>
	</varlistentry>

	<varlistentry>
	<term>--request-nt-key</term>
	<listitem><para>Request NT key</para></listitem>
	</varlistentry>

	  &popt.common.samba;
	  &stdarg.help;
	
	</variablelist>
</refsect1>

<refsect1>
	<title>VERSION</title>

	<para>This man page is correct for version 3.0 of the Samba 
	suite.</para>
</refsect1>

<refsect1>
	<title>AUTHOR</title>
	
	<para>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.</para>
	
	<para>The ntlm_auth manpage was written by Jelmer Vernooij.</para>
</refsect1>

</refentry>