summaryrefslogtreecommitdiff
path: root/docs/manpages/ntlm_auth.1
blob: 8cc6061ebb50958b5616068fb03abcfed93406aa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
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" "19 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.