summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJelmer Vernooij <jelmer@samba.org>2003-03-31 20:53:18 +0000
committerJelmer Vernooij <jelmer@samba.org>2003-03-31 20:53:18 +0000
commit53ff901f95f64cb5cf2368257a9ef57669aa68a1 (patch)
treec98e499565438e34edf5d97be3a409d20ae6e6fd /docs
parent353b10b900d6cb3f200c1a14243866bc2c9c19aa (diff)
downloadsamba-53ff901f95f64cb5cf2368257a9ef57669aa68a1.tar.gz
samba-53ff901f95f64cb5cf2368257a9ef57669aa68a1.tar.bz2
samba-53ff901f95f64cb5cf2368257a9ef57669aa68a1.zip
Add very basic documentation for ntlm_auth
(This used to be commit e09a6fe276f01890604f4af327a91a373a886d2c)
Diffstat (limited to 'docs')
-rw-r--r--docs/docbook/Makefile.in2
-rw-r--r--docs/docbook/manpages/ntlm_auth.1.sgml136
2 files changed, 137 insertions, 1 deletions
diff --git a/docs/docbook/Makefile.in b/docs/docbook/Makefile.in
index 66266196d5..94987ff3a2 100644
--- a/docs/docbook/Makefile.in
+++ b/docs/docbook/Makefile.in
@@ -22,7 +22,7 @@ MANPAGES_NAMES=findsmb.1 smbclient.1 \
smb.conf.5 wbinfo.1 pdbedit.8 \
smbcacls.1 smbsh.1 winbindd.8 \
smbgroupedit.8 vfstest.1 \
- profiles.1 smbtree.1
+ profiles.1 smbtree.1 ntlm_auth.1
## This part contains only rules. You shouldn't need to change it
## if you are adding docs
diff --git a/docs/docbook/manpages/ntlm_auth.1.sgml b/docs/docbook/manpages/ntlm_auth.1.sgml
new file mode 100644
index 0000000000..52ab1db9e4
--- /dev/null
+++ b/docs/docbook/manpages/ntlm_auth.1.sgml
@@ -0,0 +1,136 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+<!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 for executing client side
+ MS-RPC functions</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ntlm_auth</command>
+ <arg choice="opt">-A authfile</arg>
+ <arg choice="opt">-c &lt;command string&gt;</arg>
+ <arg choice="opt">-d debuglevel</arg>
+ <arg choice="opt">-h</arg>
+ <arg choice="opt">-l logfile</arg>
+ <arg choice="opt">-N</arg>
+ <arg choice="opt">-s &lt;smb config file&gt;</arg>
+ <arg choice="opt">-U username[%password]</arg>
+ <arg choice="opt">-W workgroup</arg>
+ <arg choice="opt">-N</arg>
+ <arg choice="opt">-I destinationIP</arg>
+ <arg choice="req">server</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>
+
+ <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 workstation of user to authenticate
+ </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>