summaryrefslogtreecommitdiff
path: root/docs/htmldocs/ntlm_auth.1.html
blob: 95558aae38fe964df76d5f598f867ffa7e6258f2 (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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML
><HEAD
><TITLE
>ntlm_auth</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><H1
><A
NAME="NTLM-AUTH.1"
></A
>ntlm_auth</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5"
></A
><H2
>Name</H2
>ntlm_auth&nbsp;--&nbsp;tool to allow external access to Winbind's NTLM authentication function</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN8"
></A
><H2
>Synopsis</H2
><P
><B
CLASS="COMMAND"
>ntlm_auth</B
>  [-d debuglevel] [-l logfile] [-s &#60;smb config file&#62;]</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN14"
></A
><H2
>DESCRIPTION</H2
><P
>This tool is part of the <SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>Samba</SPAN
>(7)</SPAN
> suite.</P
><P
><B
CLASS="COMMAND"
>ntlm_auth</B
> 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).
	</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN22"
></A
><H2
>OPTIONS</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>--helper-protocol=PROTO</DT
><DD
><P
>	Operate as a stdio-based helper
	</P
></DD
><DT
>--username=USERNAME</DT
><DD
><P
>	Specify username of user to authenticate
	</P
></DD
><DT
>--domain=DOMAIN</DT
><DD
><P
>	Specify domain of user to authenticate
	</P
></DD
><DT
>--workstation=WORKSTATION</DT
><DD
><P
>	Specify the workstation the user authenticated from
	</P
></DD
><DT
>--challenge=STRING</DT
><DD
><P
>challenge (HEX encoded)</P
></DD
><DT
>--lm-response=RESPONSE</DT
><DD
><P
>LM Response to the challenge (HEX encoded)</P
></DD
><DT
>--nt-response=RESPONSE</DT
><DD
><P
>NT or NTLMv2 Response to the challenge (HEX encoded)</P
></DD
><DT
>--password=PASSWORD</DT
><DD
><P
>User's plaintext password</P
></DD
><DT
>--request-lm-key</DT
><DD
><P
>Retreive LM session key</P
></DD
><DT
>--request-nt-key</DT
><DD
><P
>Request NT key</P
></DD
><DT
>-V</DT
><DD
><P
>Prints the version number for 
<B
CLASS="COMMAND"
>smbd</B
>.</P
></DD
><DT
>-s &#60;configuration file&#62;</DT
><DD
><P
>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 <A
HREF="smb.conf.5.html"
TARGET="_top"
><TT
CLASS="FILENAME"
>smb.conf(5)</TT
></A
> for more information.
The default configuration file name is determined at 
compile time.</P
></DD
><DT
>-d|--debug=debuglevel</DT
><DD
><P
><VAR
CLASS="REPLACEABLE"
>debuglevel</VAR
> is an integer 
from 0 to 10.  The default value if this parameter is 
not specified is zero.</P
><P
>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.</P
><P
>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.</P
><P
>Note that specifying this parameter here will 
override the <A
HREF="smb.conf.5.html#loglevel"
TARGET="_top"
>log
level</A
> parameter in the <A
HREF="smb.conf.5.html"
TARGET="_top"
><TT
CLASS="FILENAME"
>smb.conf(5)</TT
></A
> file.</P
></DD
><DT
>-l|--logfile=logbasename</DT
><DD
><P
>File name for log/debug files. The extension
<CODE
CLASS="CONSTANT"
>".client"</CODE
> will be appended. The log file is
never removed by the client.</P
></DD
><DT
>-h|--help</DT
><DD
><P
>Print a summary of command line options.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN96"
></A
><H2
>VERSION</H2
><P
>This man page is correct for version 3.0 of the Samba 
	suite.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN99"
></A
><H2
>AUTHOR</H2
><P
>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.</P
><P
>The ntlm_auth manpage was written by Jelmer Vernooij.</P
></DIV
></BODY
></HTML
>