summaryrefslogtreecommitdiff
path: root/docs/manpages/ntlm_auth.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/manpages/ntlm_auth.1')
-rw-r--r--docs/manpages/ntlm_auth.1109
1 files changed, 109 insertions, 0 deletions
diff --git a/docs/manpages/ntlm_auth.1 b/docs/manpages/ntlm_auth.1
new file mode 100644
index 0000000000..bb562fe964
--- /dev/null
+++ b/docs/manpages/ntlm_auth.1
@@ -0,0 +1,109 @@
+.\" This manpage has been automatically generated by docbook2man
+.\" from a DocBook document. This tool can be found at:
+.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
+.\" Please send any bug reports, improvements, comments, patches,
+.\" etc. to Steve Cheng <steve@ggi-project.org>.
+.TH "NTLM_AUTH" "1" "17 April 2003" "" ""
+
+.SH NAME
+ntlm_auth \- tool to allow external access to Winbind's NTLM authentication function
+.SH SYNOPSIS
+
+\fBntlm_auth\fR [ \fB-d debuglevel\fR ] [ \fB-l logfile\fR ] [ \fB-s <smb config file>\fR ]
+
+.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
+\fB--helper-protocol=PROTO\fR
+Operate as a stdio-based helper
+.TP
+\fB--username=USERNAME\fR
+Specify username of user to authenticate
+.TP
+\fB--domain=DOMAIN\fR
+Specify domain of user to authenticate
+.TP
+\fB--workstation=WORKSTATION\fR
+Specify the workstation the user authenticated from
+.TP
+\fB--challenge=STRING\fR
+challenge (HEX encoded)
+.TP
+\fB--lm-response=RESPONSE\fR
+LM Response to the challenge (HEX encoded)
+.TP
+\fB--nt-response=RESPONSE\fR
+NT or NTLMv2 Response to the challenge (HEX encoded)
+.TP
+\fB--password=PASSWORD\fR
+User's plaintext password
+.TP
+\fB--request-lm-key\fR
+Retreive LM session key
+.TP
+\fB--request-nt-key\fR
+Request NT key
+.TP
+\fB-V\fR
+Prints the version number for
+\fBsmbd\fR.
+.TP
+\fB-s <configuration file>\fR
+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 \fIsmb.conf(5)\fR for more information.
+The default configuration file name is determined at
+compile time.
+.TP
+\fB-d|--debug=debuglevel\fR
+\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 file.
+.TP
+\fB-l|--logfile=logbasename\fR
+File name for log/debug files. The extension
+".client" will be appended. The log file is
+never removed by the client.
+.TP
+\fB-h|--help\fR
+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.