docs/docbook/manpages/ntlm_auth.1.xml

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