docs/docbook/manpages/ntlm_auth.1.xml

   1 <?xml version="1.0" encoding="iso8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3                   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
   4
   5 <!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
   6 ]>
   7 <refentry id="ntlm-auth.1">
   8
   9 <refmeta>
  10         <refentrytitle>ntlm_auth</refentrytitle>
  11         <manvolnum>1</manvolnum>
  12 </refmeta>
  13
  14
  15 <refnamediv>
  16         <refname>ntlm_auth</refname>
  17         <refpurpose>tool to allow external access to Winbind's NTLM authentication function</refpurpose>
  18 </refnamediv>
  19
  20 <refsynopsisdiv>
  21         <cmdsynopsis>
  22                 <command>ntlm_auth</command>
  23                 <arg choice="opt">-d debuglevel</arg>
  24                 <arg choice="opt">-l logfile</arg>
  25                 <arg choice="opt">-s &lt;smb config file&gt;</arg>
  26         </cmdsynopsis>
  27 </refsynopsisdiv>
  28
  29 <refsect1>
  30         <title>DESCRIPTION</title>
  31
  32         <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
  33         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  34
  35         <para><command>ntlm_auth</command> is a helper utility that authenticates
  36         users using NT/LM authentication. It returns 0 if the users is authenticated
  37         successfully and 1 if access was denied. ntlm_auth uses winbind to access
  38         the user and authentication data for a domain. This utility
  39         is only to be used by other programs (currently squid).
  40         </para>
  41 </refsect1>
  42
  43
  44 <refsect1>
  45         <title>OPTIONS</title>
  46
  47         <variablelist>
  48         <varlistentry>
  49         <term>--helper-protocol=PROTO</term>
  50         <listitem><para>
  51         Operate as a stdio-based helper
  52         </para></listitem>
  53         </varlistentry>
  54
  55         <varlistentry>
  56         <term>--username=USERNAME</term>
  57         <listitem><para>
  58         Specify username of user to authenticate
  59         </para></listitem>
  60         </varlistentry>
  61
  62         <varlistentry>
  63         <term>--domain=DOMAIN</term>
  64         <listitem><para>
  65         Specify domain of user to authenticate
  66         </para></listitem>
  67         </varlistentry>
  68
  69         <varlistentry>
  70         <term>--workstation=WORKSTATION</term>
  71         <listitem><para>
  72         Specify the workstation the user authenticated from
  73         </para></listitem>
  74         </varlistentry>
  75
  76         <varlistentry>
  77         <term>--challenge=STRING</term>
  78         <listitem><para>challenge (HEX encoded)</para></listitem>
  79         </varlistentry>
  80
  81         <varlistentry>
  82         <term>--lm-response=RESPONSE</term>
  83         <listitem><para>LM Response to the challenge (HEX encoded)</para></listitem>
  84         </varlistentry>
  85
  86         <varlistentry>
  87         <term>--nt-response=RESPONSE</term>
  88         <listitem><para>NT or NTLMv2 Response to the challenge (HEX encoded)</para></listitem>
  89         </varlistentry>
  90
  91         <varlistentry>
  92         <term>--password=PASSWORD</term>
  93         <listitem><para>User's plaintext password</para></listitem>
  94         </varlistentry>
  95
  96         <varlistentry>
  97         <term>--request-lm-key</term>
  98         <listitem><para>Retreive LM session key</para></listitem>
  99         </varlistentry>
 100
 101         <varlistentry>
 102         <term>--request-nt-key</term>
 103         <listitem><para>Request NT key</para></listitem>
 104         </varlistentry>
 105
 106           &popt.common.samba;
 107           &stdarg.help;
 108
 109         </variablelist>
 110 </refsect1>
 111
 112 <refsect1>
 113         <title>VERSION</title>
 114
 115         <para>This man page is correct for version 3.0 of the Samba
 116         suite.</para>
 117 </refsect1>
 118
 119 <refsect1>
 120         <title>AUTHOR</title>
 121
 122         <para>The original Samba software and related utilities
 123         were created by Andrew Tridgell. Samba is now developed
 124         by the Samba Team as an Open Source project similar
 125         to the way the Linux kernel is developed.</para>
 126
 127         <para>The ntlm_auth manpage was written by Jelmer Vernooij.</para>
 128 </refsect1>
 129
 130 </refentry>