Changeset 862 for trunk/server/docs/manpages/ntlm_auth.1

Timestamp:

May 13, 2014, 11:39:04 AM (11 years ago)

Author:

Silvan Scherrer

Message:

Samba Server: update trunk to 3.6.23

Location:

trunk/server

Files:

• . (modified) (1 prop)
• docs/manpages/ntlm_auth.1 (modified) (16 diffs)

trunk/server/docs/manpages/ntlm_auth.1

@@ -2 +2 @@
 .\"     Title: ntlm_auth
 .\"    Author: [see the "AUTHOR" section]
-.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\"      Date: 10/29/2012
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 09/18/2013
 .\"    Manual: User Commands
 .\"    Source: Samba 3.6
 .\"  Language: English
 .\"
-.TH "NTLM_AUTH" "1" "10/29/2012" "Samba 3\&.6" "User Commands"
+.TH "NTLM_AUTH" "1" "09/18/2013" "Samba 3\&.6" "User Commands"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
 .\" -----------------------------------------------------------------
 .\" * set default formatting
@@ -20 +29 @@
 .\" -----------------------------------------------------------------
 .SH "NAME"
-ntlm_auth \- tool to allow external access to Winbind\'s NTLM authentication function
+ntlm_auth \- tool to allow external access to Winbind\*(Aqs NTLM authentication function
 .SH "SYNOPSIS"
 .HP \w'\ 'u
@@ -55 +64 @@
 squid\-2\&.4\-basic
 .RS 4
-Server\-side helper for use with Squid 2\&.4\'s basic (plaintext) authentication\&.
+Server\-side helper for use with Squid 2\&.4\*(Aqs basic (plaintext) authentication\&.
 .RE
 .PP
 squid\-2\&.5\-basic
 .RS 4
-Server\-side helper for use with Squid 2\&.5\'s basic (plaintext) authentication\&.
+Server\-side helper for use with Squid 2\&.5\*(Aqs basic (plaintext) authentication\&.
 .RE
 .PP
 squid\-2\&.5\-ntlmssp
 .RS 4
-Server\-side helper for use with Squid 2\&.5\'s NTLMSSP authentication\&.
+Server\-side helper for use with Squid 2\&.5\*(Aqs NTLMSSP authentication\&.
 .sp
 Requires access to the directory
@@ -78 +87 @@
 ntlmssp\-client\-1
 .RS 4
-Client\-side helper for use with arbitrary external programs that may wish to use Samba\'s NTLMSSP authentication knowledge\&.
+Client\-side helper for use with arbitrary external programs that may wish to use Samba\*(Aqs 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
@@ -103 +112 @@
 ntlm\-server\-1
 .RS 4
-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\&.
+Server\-side helper protocol, intended for use by a RADIUS server or the \*(Aqwinbind\*(Aq plugin for pppd, for the provision of MSCHAP and MSCHAPv2 authentication\&.
 .sp
 This protocol consists of lines in the form:
@@ -116 +125 @@
 Username
 .RS 4
-The username, expected to be in Samba\'s
+The username, expected to be in Samba\*(Aqs
 \m[blue]\fBunix charset\fR\m[]\&.
-.PP \fBExample\ \&1.\ \&\fR Username: bob
-.PP \fBExample\ \&2.\ \&\fR Username:: Ym9i
+.PP
+Examples:
+.RS 4
+Username: bob
+.sp
+Username:: Ym9i
+.RE
 .RE
 .PP
 NT\-Domain
 .RS 4
-The user\'s domain, expected to be in Samba\'s
+The user\*(Aqs domain, expected to be in Samba\*(Aqs
 \m[blue]\fBunix charset\fR\m[]\&.
-.PP \fBExample\ \&3.\ \&\fR NT\-Domain: WORKGROUP
-.PP \fBExample\ \&4.\ \&\fR NT\-Domain:: V09SS0dST1VQ
+.PP
+Examples:
+.RS 4
+NT\-Domain: WORKGROUP
+.sp
+NT\-Domain:: V09SS0dST1VQ
+.RE
 .RE
 .PP
 Full\-Username
 .RS 4
-The fully qualified username, expected to be in Samba\'s
+The fully qualified username, expected to be in Samba\*(Aqs
 \m[blue]\fBunix charset\fR\m[]
 and qualified with the
 \m[blue]\fBwinbind separator\fR\m[]\&.
-.PP \fBExample\ \&5.\ \&\fR Full\-Username: WORKGROUP\ebob
-.PP \fBExample\ \&6.\ \&\fR Full\-Username:: V09SS0dST1VQYm9i
+.PP
+Examples:
+.RS 4
+Full\-Username: WORKGROUP\ebob
+.sp
+Full\-Username:: V09SS0dST1VQYm9i
+.RE
 .RE
 .PP
@@ -145 +169 @@
 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\-Challenge: 0102030405060708
+.PP
+Examples:
+.RS 4
+LANMAN\-Challenge: 0102030405060708
+.RE
 .RE
 .PP
@@ -152 +180 @@
 The 24 byte
 LANMAN Response
-value, calculated from the user\'s password and the supplied
+value, calculated from the user\*(Aqs password and the supplied
 LANMAN Challenge\&. Typically, this is provided over the network by a client wishing to authenticate\&.
-.PP \fBExample\ \&8.\ \&\fR LANMAN\-Response: 0102030405060708090A0B0C0D0E0F101112131415161718
+.PP
+Examples:
+.RS 4
+LANMAN\-Response: 0102030405060708090A0B0C0D0E0F101112131415161718
+.RE
 .RE
 .PP
@@ -161 +193 @@
 The >= 24 byte
 NT Response
-calculated from the user\'s password and the supplied
+calculated from the user\*(Aqs password and the supplied
 LANMAN Challenge\&. Typically, this is provided over the network by a client wishing to authenticate\&.
-.PP \fBExample\ \&9.\ \&\fR NT\-Response: 0102030405060708090A0B0C0D0E0F101112131415161718
+.PP
+Examples:
+.RS 4
+NT\-Response: 0102030405060708090A0B0C0D0E0F10111213141516171
+.RE
 .RE
 .PP
 Password
 .RS 4
-The user\'s password\&. This would be provided by a network client, if the helper is being used in a legacy situation that exposes plaintext passwords in this way\&.
-.PP \fBExample\ \&10.\ \&\fR Password: samba2
-.PP \fBExample\ \&11.\ \&\fR Password:: c2FtYmEy
+The user\*(Aqs password\&. This would be provided by a network client, if the helper is being used in a legacy situation that exposes plaintext passwords in this way\&.
+.PP
+Examples:
+.RS 4
+Password: samba2
+.sp
+Password:: c2FtYmEy
+.RE
 .RE
 .PP
@@ -176 +217 @@
 .RS 4
 Upon successful authenticaiton, return the user session key associated with the login\&.
-.PP \fBExample\ \&12.\ \&\fR Request\-User\-Session\-Key: Yes
+.PP
+Examples:
+.RS 4
+Request\-User\-Session\-Key: Yes
+.RE
 .RE
 .PP
@@ -182 +227 @@
 .RS 4
 Upon successful authenticaiton, return the LANMAN session key associated with the login\&.
-.PP \fBExample\ \&13.\ \&\fR Request\-LanMan\-Session\-Key: Yes
-.RE
+.PP
+Examples:
+.RS 4
+Request\-LanMan\-Session\-Key: Yes
+.RE
+.RE
+.RE
+.sp
 .if n \{\
 .sp
@@ -196 +247 @@
 .ps -1
 .br
-Implementers 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
-.RE
+Implementers 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
 .RE
 .RE
@@ -236 +284 @@
 \-\-password=PASSWORD
 .RS 4
-User\'s plaintext password
+User\*(Aqs plaintext password
 .sp
 If not specified on the command line, this is prompted for when required\&.
@@ -275 +323 @@
 .sp
 Note that specifying this parameter here will override the
-\m[blue]\fB\%smb.conf.5.html#\fR\m[]
+\m[blue]\fBlog level\fR\m[]
 parameter in the
 smb\&.conf
@@ -350 +398 @@
 .\}
 .nf
-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\'
+auth_param ntlm program ntlm_auth \-\-helper\-protocol=squid\-2\&.5\-ntlmssp \-\-require\-membership\-of=\*(AqWORKGROUP\eDomain Users\*(Aq
+auth_param basic program ntlm_auth \-\-helper\-protocol=squid\-2\&.5\-basic \-\-require\-membership\-of=\*(AqWORKGROUP\eDomain Users\*(Aq
 .fi
 .if n \{\
@@ -358 +406 @@
 .SH "TROUBLESHOOTING"
 .PP
-If you\'re experiencing problems with authenticating Internet Explorer running under MS Windows 9X or Millennium Edition against ntlm_auth\'s NTLMSSP authentication helper (\-\-helper\-protocol=squid\-2\&.5\-ntlmssp), then please read
+If you\*(Aqre experiencing problems with authenticating Internet Explorer running under MS Windows 9X or Millennium Edition against ntlm_auth\*(Aqs NTLMSSP authentication helper (\-\-helper\-protocol=squid\-2\&.5\-ntlmssp), then please read
 the Microsoft Knowledge Base article #239869 and follow instructions described there\&.
 .SH "VERSION"