summaryrefslogtreecommitdiff
path: root/docs/manpages/ntlm_auth.1
diff options
context:
space:
mode:
authorGerald Carter <jerry@samba.org>2003-07-01 14:40:47 +0000
committerGerald Carter <jerry@samba.org>2003-07-01 14:40:47 +0000
commit4ef35ae91af666801bc5391e45372328cf1d47a1 (patch)
tree3797a02991a429be1fd4e18de7434556d97e9000 /docs/manpages/ntlm_auth.1
parenta3fdb5536c3938453b3b56c02bfaf8fab3913619 (diff)
downloadsamba-4ef35ae91af666801bc5391e45372328cf1d47a1.tar.gz
starting to sync for 3.0beta2
Diffstat (limited to 'docs/manpages/ntlm_auth.1')
-rw-r--r--docs/manpages/ntlm_auth.1135
1 files changed, 135 insertions, 0 deletions
diff --git a/docs/manpages/ntlm_auth.1 b/docs/manpages/ntlm_auth.1
new file mode 100644
index 00000000000..082d9422c80
--- /dev/null
+++ b/docs/manpages/ntlm_auth.1
@@ -0,0 +1,135 @@
+.\"Generated by db2man.xsl. Don't modify this, modify the source.
+.de Sh \" Subsection
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
+.br
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "NTLM_AUTH" 1 "" "" ""
+.SH NAME
+ntlm_auth \- tool to allow external access to Winbind's NTLM authentication function
+.SH "SYNOPSIS"
+
+.nf
+\fBntlm_auth\fR [-d debuglevel] [-l logfile] [-s <smb config file>]
+.fi
+
+.SH "DESCRIPTION"
+
+.PP
+This tool is part of the \fBSamba\fR(7) suite\&.
+
+.PP
+\fBntlm_auth\fR 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)\&.
+
+.SH "OPTIONS"
+
+.TP
+--helper-protocol=PROTO
+Operate as a stdio-based helper
+
+
+.TP
+--username=USERNAME
+Specify username of user to authenticate
+
+
+.TP
+--domain=DOMAIN
+Specify domain of user to authenticate
+
+
+.TP
+--workstation=WORKSTATION
+Specify the workstation the user authenticated from
+
+
+.TP
+--challenge=STRING
+challenge (HEX encoded)
+
+
+.TP
+--lm-response=RESPONSE
+LM Response to the challenge (HEX encoded)
+
+
+.TP
+--nt-response=RESPONSE
+NT or NTLMv2 Response to the challenge (HEX encoded)
+
+
+.TP
+--password=PASSWORD
+User's plaintext password
+
+
+.TP
+--request-lm-key
+Retreive LM session key
+
+
+.TP
+--request-nt-key
+Request NT key
+
+
+.TP
+-V
+Prints the version number for \fBsmbd\fR\&.
+
+
+.TP
+-s <configuration file>
+The file specified contains the configuration details required by the server\&. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\&. See \fI smb\&.conf(5)\fR for more information\&. The default configuration file name is determined at compile time\&.
+
+
+.TP
+-d|--debug=debuglevel
+\fIdebuglevel\fR is an integer from 0 to 10\&. The default value if this parameter is not specified is zero\&.
+
+
+The higher this value, the more detail will be logged to the log files about the activities of the server\&. At level 0, only critical errors and serious warnings will be logged\&. Level 1 is a reasonable level for day to day running - it generates a small amount of information about operations carried out\&.
+
+
+Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\&. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\&.
+
+
+Note that specifying this parameter here will override the log level parameter in the \fIsmb\&.conf(5)\fR file\&.
+
+
+.TP
+-l|--logfile=logbasename
+File name for log/debug files\&. The extension \fB"\&.client"\fR will be appended\&. The log file is never removed by the client\&.
+
+
+.TP
+-h|--help
+Print a summary of command line options\&.
+
+
+.SH "VERSION"
+
+.PP
+This man page is correct for version 3\&.0 of the Samba suite\&.
+
+.SH "AUTHOR"
+
+.PP
+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\&.
+
+.PP
+The ntlm_auth manpage was written by Jelmer Vernooij\&.
+