Changeset 286 for branches/samba-3.0/docs/manpages/smbpasswd.5
- Timestamp:
- Jun 24, 2009, 5:09:21 PM (16 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
branches/samba-3.0/docs/manpages/smbpasswd.5
r158 r286 1 1 .\" Title: smbpasswd 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.7 3.2<http://docbook.sf.net/>4 .\" Date: 0 8/25/20082 .\" Author: [see the "AUTHOR" section] 3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/> 4 .\" Date: 06/22/2009 5 5 .\" Manual: File Formats and Conventions 6 6 .\" Source: Samba 3.0 7 .\" Language: English 7 8 .\" 8 .TH "SMBPASSWD" "5" "08/25/2008" "Samba 3\.0" "File Formats and Conventions" 9 .TH "SMBPASSWD" "5" "06/22/2009" "Samba 3\&.0" "File Formats and Conventions" 10 .\" ----------------------------------------------------------------- 11 .\" * (re)Define some macros 12 .\" ----------------------------------------------------------------- 13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 14 .\" toupper - uppercase a string (locale-aware) 15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 16 .de toupper 17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ 18 \\$* 19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz 20 .. 21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 22 .\" SH-xref - format a cross-reference to an SH section 23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 24 .de SH-xref 25 .ie n \{\ 26 .\} 27 .toupper \\$* 28 .el \{\ 29 \\$* 30 .\} 31 .. 32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 33 .\" SH - level-one heading that works better for non-TTY output 34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 35 .de1 SH 36 .\" put an extra blank line of space above the head in non-TTY output 37 .if t \{\ 38 .sp 1 39 .\} 40 .sp \\n[PD]u 41 .nr an-level 1 42 .set-an-margin 43 .nr an-prevailing-indent \\n[IN] 44 .fi 45 .in \\n[an-margin]u 46 .ti 0 47 .HTML-TAG ".NH \\n[an-level]" 48 .it 1 an-trap 49 .nr an-no-space-flag 1 50 .nr an-break-flag 1 51 \." make the size of the head bigger 52 .ps +3 53 .ft B 54 .ne (2v + 1u) 55 .ie n \{\ 56 .\" if n (TTY output), use uppercase 57 .toupper \\$* 58 .\} 59 .el \{\ 60 .nr an-break-flag 0 61 .\" if not n (not TTY), use normal case (not uppercase) 62 \\$1 63 .in \\n[an-margin]u 64 .ti 0 65 .\" if not n (not TTY), put a border/line under subheading 66 .sp -.6 67 \l'\n(.lu' 68 .\} 69 .. 70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 71 .\" SS - level-two heading that works better for non-TTY output 72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 73 .de1 SS 74 .sp \\n[PD]u 75 .nr an-level 1 76 .set-an-margin 77 .nr an-prevailing-indent \\n[IN] 78 .fi 79 .in \\n[IN]u 80 .ti \\n[SN]u 81 .it 1 an-trap 82 .nr an-no-space-flag 1 83 .nr an-break-flag 1 84 .ps \\n[PS-SS]u 85 \." make the size of the head bigger 86 .ps +2 87 .ft B 88 .ne (2v + 1u) 89 .if \\n[.$] \&\\$* 90 .. 91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 92 .\" BB/BE - put background/screen (filled box) around block of text 93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 94 .de BB 95 .if t \{\ 96 .sp -.5 97 .br 98 .in +2n 99 .ll -2n 100 .gcolor red 101 .di BX 102 .\} 103 .. 104 .de EB 105 .if t \{\ 106 .if "\\$2"adjust-for-leading-newline" \{\ 107 .sp -1 108 .\} 109 .br 110 .di 111 .in 112 .ll 113 .gcolor 114 .nr BW \\n(.lu-\\n(.i 115 .nr BH \\n(dn+.5v 116 .ne \\n(BHu+.5v 117 .ie "\\$2"adjust-for-leading-newline" \{\ 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] 119 .\} 120 .el \{\ 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] 122 .\} 123 .in 0 124 .sp -.5v 125 .nf 126 .BX 127 .in 128 .sp .5v 129 .fi 130 .\} 131 .. 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 133 .\" BM/EM - put colored marker in margin next to block of text 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 135 .de BM 136 .if t \{\ 137 .br 138 .ll -2n 139 .gcolor red 140 .di BX 141 .\} 142 .. 143 .de EM 144 .if t \{\ 145 .br 146 .di 147 .ll 148 .gcolor 149 .nr BH \\n(dn 150 .ne \\n(BHu 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[] 152 .in 0 153 .nf 154 .BX 155 .in 156 .fi 157 .\} 158 .. 159 .\" ----------------------------------------------------------------- 160 .\" * set default formatting 161 .\" ----------------------------------------------------------------- 9 162 .\" disable hyphenation 10 163 .nh 11 164 .\" disable justification (adjust text to left margin only) 12 165 .ad l 13 .SH "NAME" 14 smbpasswd - The Samba encrypted password file 15 .SH "SYNOPSIS" 16 .PP 17 \fIsmbpasswd\fR 166 .\" ----------------------------------------------------------------- 167 .\" * MAIN CONTENT STARTS HERE * 168 .\" ----------------------------------------------------------------- 169 .SH "Name" 170 smbpasswd \- The Samba encrypted password file 171 .SH "Synopsis" 172 .PP 173 \FCsmbpasswd\F[] 18 174 .SH "DESCRIPTION" 19 175 .PP 20 176 This tool is part of the 21 177 \fBsamba\fR(7) 22 suite\ .23 .PP 24 smbpasswd is the Samba encrypted password file\ . It contains the username, Unix user id and the SMB hashed passwords of the user, as well as account flag information and the time the password was last changed\. This file format has been evolving with Samba and has had several different formats in the past\.178 suite\&. 179 .PP 180 smbpasswd is the Samba encrypted password file\&. It contains the username, Unix user id and the SMB hashed passwords of the user, as well as account flag information and the time the password was last changed\&. This file format has been evolving with Samba and has had several different formats in the past\&. 25 181 .SH "FILE FORMAT" 26 182 .PP 27 The format of the smbpasswd file used by Samba 2\ .2 is very similar to the familiar Unix28 \ fIpasswd(5)\fR29 file\ . It is an ASCII file containing one line for each user\. Each field ithin each line is separated from the next by a colon\. Any entry beginning with \'#\' is ignored\. The smbpasswd file contains the following information for each user:183 The format of the smbpasswd file used by Samba 2\&.2 is very similar to the familiar Unix 184 \FCpasswd(5)\F[] 185 file\&. It is an ASCII file containing one line for each user\&. Each field ithin each line is separated from the next by a colon\&. Any entry beginning with \'#\' is ignored\&. The smbpasswd file contains the following information for each user: 30 186 .PP 31 187 name 32 188 .RS 4 33 This is the user name\ . It must be a name that already exists in the standard UNIX passwd file\.189 This is the user name\&. It must be a name that already exists in the standard UNIX passwd file\&. 34 190 .RE 35 191 .PP 36 192 uid 37 193 .RS 4 38 This is the UNIX uid\ . It must match the uid field for the same user entry in the standard UNIX passwd file\. If this does not match then Samba will refuse to recognize this smbpasswd file entry as being valid for a user\.194 This is the UNIX uid\&. It must match the uid field for the same user entry in the standard UNIX passwd file\&. If this does not match then Samba will refuse to recognize this smbpasswd file entry as being valid for a user\&. 39 195 .RE 40 196 .PP 41 197 Lanman Password Hash 42 198 .RS 4 43 This is the LANMAN hash of the user\'s password, encoded as 32 hex digits\ . The LANMAN hash is created by DES encrypting a well known string with the user\'s password as the DES key\. This is the same password used by Windows 95/98 machines\. Note that this password hash is regarded as weak as it is vulnerable to dictionary attacks and if two users choose the same password this entry will be identical (i\.e\. the password is not "salted" as the UNIX password is)\. If the user has a null password this field will contain the characters "NO PASSWORD" as the start of the hex string\. If the hex string is equal to 32 \'X\' characters then the user\'s account is marked as199 This is the LANMAN hash of the user\'s password, encoded as 32 hex digits\&. The LANMAN hash is created by DES encrypting a well known string with the user\'s password as the DES key\&. This is the same password used by Windows 95/98 machines\&. Note that this password hash is regarded as weak as it is vulnerable to dictionary attacks and if two users choose the same password this entry will be identical (i\&.e\&. the password is not "salted" as the UNIX password is)\&. If the user has a null password this field will contain the characters "NO PASSWORD" as the start of the hex string\&. If the hex string is equal to 32 \'X\' characters then the user\'s account is marked as 44 200 \fBdisabled\fR 45 and the user will not be able to log onto the Samba server\ .201 and the user will not be able to log onto the Samba server\&. 46 202 .sp 47 203 \fIWARNING !!\fR 48 Note that, due to the challenge\-response nature of the SMB/CIFS authentication protocol, anyone with a knowledge of this password hash will be able to impersonate the user on the network\ . For this reason these hashes are known as204 Note that, due to the challenge\-response nature of the SMB/CIFS authentication protocol, anyone with a knowledge of this password hash will be able to impersonate the user on the network\&. For this reason these hashes are known as 49 205 \fIplain text equivalents\fR 50 206 and must 51 207 \fINOT\fR 52 be made available to anyone but the root user\ . To protect these passwords the smbpasswd file is placed in a directory with read and traverse access only to the root user and the smbpasswd file itself must be set to be read/write only by root, with no other access\.208 be made available to anyone but the root user\&. To protect these passwords the smbpasswd file is placed in a directory with read and traverse access only to the root user and the smbpasswd file itself must be set to be read/write only by root, with no other access\&. 53 209 .RE 54 210 .PP 55 211 NT Password Hash 56 212 .RS 4 57 This is the Windows NT hash of the user\'s password, encoded as 32 hex digits\ . The Windows NT hash is created by taking the user\'s password as represented in 16\-bit, little\-endian UNICODE and then applying the MD4 (internet rfc1321) hashing algorithm to it\.58 .sp 59 This password hash is considered more secure than the LANMAN Password Hash as it preserves the case of the password and uses a much higher quality hashing algorithm\ . However, it is still the case that if two users choose the same password this entry will be identical (i\.e\. the password is not "salted" as the UNIX password is)\.60 .sp 61 \fIWARNING !!\fR\ . Note that, due to the challenge\-response nature of the SMB/CIFS authentication protocol, anyone with a knowledge of this password hash will be able to impersonate the user on the network\. For this reason these hashes are known as213 This is the Windows NT hash of the user\'s password, encoded as 32 hex digits\&. The Windows NT hash is created by taking the user\'s password as represented in 16\-bit, little\-endian UNICODE and then applying the MD4 (internet rfc1321) hashing algorithm to it\&. 214 .sp 215 This password hash is considered more secure than the LANMAN Password Hash as it preserves the case of the password and uses a much higher quality hashing algorithm\&. However, it is still the case that if two users choose the same password this entry will be identical (i\&.e\&. the password is not "salted" as the UNIX password is)\&. 216 .sp 217 \fIWARNING !!\fR\&. Note that, due to the challenge\-response nature of the SMB/CIFS authentication protocol, anyone with a knowledge of this password hash will be able to impersonate the user on the network\&. For this reason these hashes are known as 62 218 \fIplain text equivalents\fR 63 219 and must 64 220 \fINOT\fR 65 be made available to anyone but the root user\ . To protect these passwords the smbpasswd file is placed in a directory with read and traverse access only to the root user and the smbpasswd file itself must be set to be read/write only by root, with no other access\.221 be made available to anyone but the root user\&. To protect these passwords the smbpasswd file is placed in a directory with read and traverse access only to the root user and the smbpasswd file itself must be set to be read/write only by root, with no other access\&. 66 222 .RE 67 223 .PP 68 224 Account Flags 69 225 .RS 4 70 This section contains flags that describe the attributes of the users account\ . This field is bracketed by \'[\' and \']\' characters and is always 13 characters in length (including the \'[\' and \']\' characters)\. The contents of this field may be any of the following characters:226 This section contains flags that describe the attributes of the users account\&. This field is bracketed by \'[\' and \']\' characters and is always 13 characters in length (including the \'[\' and \']\' characters)\&. The contents of this field may be any of the following characters: 71 227 .sp 72 228 .RS 4 … … 79 235 .\} 80 236 \fIU\fR 81 \- This means this is a "User" account, i\ .e\. an ordinary user\.237 \- This means this is a "User" account, i\&.e\&. an ordinary user\&. 82 238 .RE 83 239 .sp … … 91 247 .\} 92 248 \fIN\fR 93 \- This means the account has no password (the passwords in the fields LANMAN Password Hash and NT Password Hash are ignored)\ . Note that this will only allow users to log on with no password if the249 \- This means the account has no password (the passwords in the fields LANMAN Password Hash and NT Password Hash are ignored)\&. Note that this will only allow users to log on with no password if the 94 250 \fI null passwords\fR 95 251 parameter is set in the 96 252 \fBsmb.conf\fR(5) 97 config file\ .253 config file\&. 98 254 .RE 99 255 .sp … … 107 263 .\} 108 264 \fID\fR 109 \- This means the account is disabled and no SMB/CIFS logins will be allowed for this user\ .265 \- This means the account is disabled and no SMB/CIFS logins will be allowed for this user\&. 110 266 .RE 111 267 .sp … … 119 275 .\} 120 276 \fIX\fR 121 \- This means the password does not expire\ .277 \- This means the password does not expire\&. 122 278 .RE 123 279 .sp … … 131 287 .\} 132 288 \fIW\fR 133 \- This means this account is a "Workstation Trust" account\ . This kind of account is used in the Samba PDC code stream to allow Windows NT Workstations and Servers to join a Domain hosted by a Samba PDC\.134 .sp 135 .RE 136 Other flags may be added as the code is extended in future\ . The rest of this field space is filled in with spaces\. For further information regarding the flags that are supported please refer to the man page for the137 pdbedit 138 command\ .289 \- This means this account is a "Workstation Trust" account\&. This kind of account is used in the Samba PDC code stream to allow Windows NT Workstations and Servers to join a Domain hosted by a Samba PDC\&. 290 .sp 291 .RE 292 Other flags may be added as the code is extended in future\&. The rest of this field space is filled in with spaces\&. For further information regarding the flags that are supported please refer to the man page for the 293 \FCpdbedit\F[] 294 command\&. 139 295 .RE 140 296 .PP 141 297 Last Change Time 142 298 .RS 4 143 This field consists of the time the account was last modified\ . It consists of the characters \'LCT\-\' (standing for "Last Change Time") followed by a numeric encoding of the UNIX time in seconds since the epoch (1970) that the last change was made\.144 .RE 145 .PP 146 All other colon separated fields are ignored at this time\ .299 This field consists of the time the account was last modified\&. It consists of the characters \'LCT\-\' (standing for "Last Change Time") followed by a numeric encoding of the UNIX time in seconds since the epoch (1970) that the last change was made\&. 300 .RE 301 .PP 302 All other colon separated fields are ignored at this time\&. 147 303 .SH "VERSION" 148 304 .PP 149 This man page is correct for version 3\ .0 of the Samba suite\.305 This man page is correct for version 3\&.0 of the Samba suite\&. 150 306 .SH "SEE ALSO" 151 307 .PP 152 308 \fBsmbpasswd\fR(8), 153 \fBSamba\fR(7), and the Internet RFC1321 for details on the MD4 algorithm\ .309 \fBSamba\fR(7), and the Internet RFC1321 for details on the MD4 algorithm\&. 154 310 .SH "AUTHOR" 155 311 .PP 156 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\.157 .PP 158 The original Samba man pages were written by Karl Auer\ . The man page sources were converted to YODL format (another excellent piece of Open Source software, available at159 ftp://ftp\ .icce\.rug\.nl/pub/unix/) and updated for the Samba 2\.0 release by Jeremy Allison\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\.312 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\&. 313 .PP 314 The original Samba man pages were written by Karl Auer\&. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at 315 ftp://ftp\&.icce\&.rug\&.nl/pub/unix/) and updated for the Samba 2\&.0 release by Jeremy Allison\&. The conversion to DocBook for Samba 2\&.2 was done by Gerald Carter\&. The conversion to DocBook XML 4\&.2 for Samba 3\&.0 was done by Alexander Bokovoy\&.
Note:
See TracChangeset
for help on using the changeset viewer.