diff options
author | bubulle <bubulle@alioth.debian.org> | 2011-03-07 19:04:15 +0000 |
---|---|---|
committer | bubulle <bubulle@alioth.debian.org> | 2011-03-07 19:04:15 +0000 |
commit | 4d16e8d5702fb98dda73c5c0f3404d662ae62df6 (patch) | |
tree | fc3a71a0b741cbcc6a5a892f91cc0f2218dfe656 /docs/manpages/ntlm_auth.1 | |
parent | 9fbd7973837d958b90261b85fafff36ac194ba58 (diff) | |
download | samba-4d16e8d5702fb98dda73c5c0f3404d662ae62df6.tar.gz |
Load samba-3.5.8 into branches/samba/upstream.upstream/3.5.8_dfsg
git-svn-id: svn://svn.debian.org/svn/pkg-samba/branches/samba/upstream@3691 fc4039ab-9d04-0410-8cac-899223bdd6b0
Diffstat (limited to 'docs/manpages/ntlm_auth.1')
-rw-r--r-- | docs/manpages/ntlm_auth.1 | 246 |
1 files changed, 32 insertions, 214 deletions
diff --git a/docs/manpages/ntlm_auth.1 b/docs/manpages/ntlm_auth.1 index 959e1dd19c..ae708291c9 100644 --- a/docs/manpages/ntlm_auth.1 +++ b/docs/manpages/ntlm_auth.1 @@ -1,161 +1,13 @@ +'\" t .\" Title: ntlm_auth .\" Author: [see the "AUTHOR" section] -.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/> -.\" Date: 06/18/2010 +.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> +.\" Date: 03/06/2011 .\" Manual: User Commands .\" Source: Samba 3.5 .\" Language: English .\" -.TH "NTLM_AUTH" "1" "06/18/2010" "Samba 3\&.5" "User Commands" -.\" ----------------------------------------------------------------- -.\" * (re)Define some macros -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" toupper - uppercase a string (locale-aware) -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de toupper -.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ -\\$* -.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" SH-xref - format a cross-reference to an SH section -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de SH-xref -.ie n \{\ -.\} -.toupper \\$* -.el \{\ -\\$* -.\} -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" SH - level-one heading that works better for non-TTY output -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de1 SH -.\" put an extra blank line of space above the head in non-TTY output -.if t \{\ -.sp 1 -.\} -.sp \\n[PD]u -.nr an-level 1 -.set-an-margin -.nr an-prevailing-indent \\n[IN] -.fi -.in \\n[an-margin]u -.ti 0 -.HTML-TAG ".NH \\n[an-level]" -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -\." make the size of the head bigger -.ps +3 -.ft B -.ne (2v + 1u) -.ie n \{\ -.\" if n (TTY output), use uppercase -.toupper \\$* -.\} -.el \{\ -.nr an-break-flag 0 -.\" if not n (not TTY), use normal case (not uppercase) -\\$1 -.in \\n[an-margin]u -.ti 0 -.\" if not n (not TTY), put a border/line under subheading -.sp -.6 -\l'\n(.lu' -.\} -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" SS - level-two heading that works better for non-TTY output -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de1 SS -.sp \\n[PD]u -.nr an-level 1 -.set-an-margin -.nr an-prevailing-indent \\n[IN] -.fi -.in \\n[IN]u -.ti \\n[SN]u -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.ps \\n[PS-SS]u -\." make the size of the head bigger -.ps +2 -.ft B -.ne (2v + 1u) -.if \\n[.$] \&\\$* -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" BB/BE - put background/screen (filled box) around block of text -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de BB -.if t \{\ -.sp -.5 -.br -.in +2n -.ll -2n -.gcolor red -.di BX -.\} -.. -.de EB -.if t \{\ -.if "\\$2"adjust-for-leading-newline" \{\ -.sp -1 -.\} -.br -.di -.in -.ll -.gcolor -.nr BW \\n(.lu-\\n(.i -.nr BH \\n(dn+.5v -.ne \\n(BHu+.5v -.ie "\\$2"adjust-for-leading-newline" \{\ -\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] -.\} -.el \{\ -\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] -.\} -.in 0 -.sp -.5v -.nf -.BX -.in -.sp .5v -.fi -.\} -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" BM/EM - put colored marker in margin next to block of text -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de BM -.if t \{\ -.br -.ll -2n -.gcolor red -.di BX -.\} -.. -.de EM -.if t \{\ -.br -.di -.ll -.gcolor -.nr BH \\n(dn -.ne \\n(BHu -\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[] -.in 0 -.nf -.BX -.in -.fi -.\} -.. +.TH "NTLM_AUTH" "1" "03/06/2011" "Samba 3\&.5" "User Commands" .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -166,20 +18,18 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- -.SH "Name" +.SH "NAME" ntlm_auth \- tool to allow external access to Winbind\'s NTLM authentication function -.SH "Synopsis" -.fam C +.SH "SYNOPSIS" .HP \w'\ 'u -\FCntlm_auth\F[] [\-d\ debuglevel] [\-l\ logdir] [\-s\ <smb\ config\ file>] -.fam +ntlm_auth [\-d\ debuglevel] [\-l\ logdir] [\-s\ <smb\ config\ file>] .SH "DESCRIPTION" .PP This tool is part of the \fBsamba\fR(7) suite\&. .PP -\FCntlm_auth\F[] +ntlm_auth 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 intended to be used by other programs (currently Squid and @@ -191,10 +41,10 @@ The daemon must be operational for many of these commands to function\&. .PP Some of these commands also require access to the directory -\FCwinbindd_privileged\F[] +winbindd_privileged in -\FC$LOCKDIR\F[]\&. This should be done either by running this command as root or providing group access to the -\FCwinbindd_privileged\F[] +$LOCKDIR\&. This should be done either by running this command as root or providing group access to the +winbindd_privileged directory\&. For security reasons, this directory should not be world\-accessable\&. .SH "OPTIONS" .PP @@ -217,11 +67,11 @@ squid\-2\&.5\-ntlmssp Server\-side helper for use with Squid 2\&.5\'s NTLMSSP authentication\&. .sp Requires access to the directory -\FCwinbindd_privileged\F[] +winbindd_privileged in -\FC$LOCKDIR\F[]\&. The protocol used is described here: +$LOCKDIR\&. The protocol used is described here: http://devel\&.squid\-cache\&.org/ntlm/squid_helper_protocol\&.html\&. This protocol has been extended to allow the NTLMSSP Negotiate packet to be included as an argument to the -\FCYR\F[] +YR command\&. (Thus avoiding loss of information in the protocol exchange)\&. .RE .PP @@ -230,19 +80,19 @@ ntlmssp\-client\-1 Client\-side helper for use with arbitrary external programs that may wish to use Samba\'s NTLMSSP authentication knowledge\&. .sp This helper is a client, and as such may be run by any user\&. The protocol used is effectively the reverse of the previous protocol\&. A -\FCYR\F[] +YR command (without any arguments) starts the authentication exchange\&. .RE .PP gss\-spnego .RS 4 Server\-side helper that implements GSS\-SPNEGO\&. This uses a protocol that is almost the same as -\FCsquid\-2\&.5\-ntlmssp\F[], but has some subtle differences that are undocumented outside the source at this stage\&. +squid\-2\&.5\-ntlmssp, but has some subtle differences that are undocumented outside the source at this stage\&. .sp Requires access to the directory -\FCwinbindd_privileged\F[] +winbindd_privileged in -\FC$LOCKDIR\F[]\&. +$LOCKDIR\&. .RE .PP gss\-spnego\-client @@ -255,10 +105,10 @@ ntlm\-server\-1 Server\-side helper protocol, intended for use by a RADIUS server or the \'winbind\' plugin for pppd, for the provision of MSCHAP and MSCHAPv2 authentication\&. .sp This protocol consists of lines in the form: -\FCParameter: value\F[] +Parameter: value and -\FCParameter:: Base64\-encode value\F[]\&. The presence of a single period -\FC\&.\F[] +Parameter:: Base64\-encode value\&. The presence of a single period +\&. indicates that one side has finished supplying data to the other\&. (Which in turn could cause the helper to authenticate the user)\&. .sp Curently implemented parameters from the external program to the helper are: @@ -292,7 +142,7 @@ and qualified with the LANMAN\-Challenge .RS 4 The 8 byte -\FCLANMAN Challenge\F[] +LANMAN Challenge value, generated randomly by the server, or (in cases such as MSCHAPv2) generated in some way by both the server and the client\&. .PP \fBExample\ \&7.\ \&\fR LANMAN\-Challege: 0102030405060708 .RE @@ -300,18 +150,18 @@ value, generated randomly by the server, or (in cases such as MSCHAPv2) generate LANMAN\-Response .RS 4 The 24 byte -\FCLANMAN Response\F[] +LANMAN Response value, calculated from the user\'s password and the supplied -\FCLANMAN Challenge\F[]\&. Typically, this is provided over the network by a client wishing to authenticate\&. +LANMAN Challenge\&. Typically, this is provided over the network by a client wishing to authenticate\&. .PP \fBExample\ \&8.\ \&\fR LANMAN\-Response: 0102030405060708090A0B0C0D0E0F101112131415161718 .RE .PP NT\-Response .RS 4 The >= 24 byte -\FCNT Response\F[] +NT Response calculated from the user\'s password and the supplied -\FCLANMAN Challenge\F[]\&. Typically, this is provided over the network by a client wishing to authenticate\&. +LANMAN Challenge\&. Typically, this is provided over the network by a client wishing to authenticate\&. .PP \fBExample\ \&9.\ \&\fR NT\-Response: 0102030405060708090A0B0C0D0E0F101112131415161718 .RE .PP @@ -337,7 +187,6 @@ Apon sucessful authenticaiton, return the LANMAN session key associated with the .sp .\} .RS 4 -.BM yellow .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 @@ -350,7 +199,6 @@ Implementors should take care to base64 encode any data (such as usernames/passwords) that may contain malicous user data, such as a newline\&. They may also need to decode strings from the helper, which likewise may have been base64 encoded\&..sp .5v -.EM yellow .RE .RE .RE @@ -407,7 +255,7 @@ Request NT key \-\-diagnostics .RS 4 Perform Diagnostics on the authentication chain\&. Uses the password from -\FC\-\-password\F[] +\-\-password or prompts for one\&. .RE .PP @@ -428,7 +276,7 @@ Levels above 1 will generate considerable amounts of log data, and should only b Note that specifying this parameter here will override the \m[blue]\fB\%smb.conf.5.html#\fR\m[] parameter in the -\FCsmb\&.conf\F[] +smb\&.conf file\&. .RE .PP @@ -440,7 +288,7 @@ Prints the program version number\&. \-s|\-\-configfile <configuration file> .RS 4 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 -\FCsmb\&.conf\F[] +smb\&.conf for more information\&. The default configuration file name is determined at compile time\&. .RE .PP @@ -458,33 +306,19 @@ Print a summary of command line options\&. .SH "EXAMPLE SETUP" .PP To setup ntlm_auth for use by squid 2\&.5, with both basic and NTLMSSP authentication, the following should be placed in the -\FCsquid\&.conf\F[] +squid\&.conf file\&. .sp .if n \{\ .RS 4 .\} -.fam C -.ps -1 .nf -.if t \{\ -.sp -1 -.\} -.BB lightgray adjust-for-leading-newline -.sp -1 - auth_param ntlm program ntlm_auth \-\-helper\-protocol=squid\-2\&.5\-ntlmssp auth_param basic program ntlm_auth \-\-helper\-protocol=squid\-2\&.5\-basic auth_param basic children 5 auth_param basic realm Squid proxy\-caching web server auth_param basic credentialsttl 2 hours -.EB lightgray adjust-for-leading-newline -.if t \{\ -.sp 1 -.\} .fi -.fam -.ps +1 .if n \{\ .RE .\} @@ -492,7 +326,6 @@ auth_param basic credentialsttl 2 hours .sp .\} .RS 4 -.BM yellow .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 @@ -503,37 +336,22 @@ auth_param basic credentialsttl 2 hours .br .PP This example assumes that ntlm_auth has been installed into your path, and that the group permissions on -\FCwinbindd_privileged\F[] +winbindd_privileged are as described above\&. .sp .5v -.EM yellow .RE .PP To setup ntlm_auth for use by squid 2\&.5 with group limitation in addition to the above example, the following should be added to the -\FCsquid\&.conf\F[] +squid\&.conf file\&. .sp .if n \{\ .RS 4 .\} -.fam C -.ps -1 .nf -.if t \{\ -.sp -1 -.\} -.BB lightgray adjust-for-leading-newline -.sp -1 - auth_param ntlm program ntlm_auth \-\-helper\-protocol=squid\-2\&.5\-ntlmssp \-\-require\-membership\-of=\'WORKGROUP\eDomain Users\' auth_param basic program ntlm_auth \-\-helper\-protocol=squid\-2\&.5\-basic \-\-require\-membership\-of=\'WORKGROUP\eDomain Users\' -.EB lightgray adjust-for-leading-newline -.if t \{\ -.sp 1 -.\} .fi -.fam -.ps +1 .if n \{\ .RE .\} |