summaryrefslogtreecommitdiff
path: root/docs/manpages/smbpasswd.5
blob: 0d061ef1a848a9b701d1356ffb9b88aaa279fb8a (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
.\" 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 "SMBPASSWD" "5" "17 April 2003" "" ""

.SH NAME
smbpasswd \- The Samba encrypted password file
.SH SYNOPSIS
.PP
\fIsmbpasswd\fR
.SH "DESCRIPTION"
.PP
This tool is part of the \fBSamba\fR(7) suite.
.PP
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. 
.SH "FILE FORMAT"
.PP
The format of the smbpasswd file used by Samba 2.2 
is very similar to the familiar Unix \fIpasswd(5)\fR 
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: 
.TP
\fBname\fR
This is the user name. It must be a name that 
already exists in the standard UNIX passwd file. 
.TP
\fBuid\fR
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. 
.TP
\fBLanman Password Hash\fR
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 
disabled and the user will not be able to 
log onto the Samba server. 

\fBWARNING !!\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 \fBplain text 
equivalents\fR and must \fBNOT\fR 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. 
.TP
\fBNT Password Hash\fR
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. 

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). 

\fBWARNING !!\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 \fBplain text 
equivalents\fR and must \fBNOT\fR 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. 
.TP
\fBAccount Flags\fR
This section contains flags that describe 
the attributes of the users account. In the Samba 2.2 release 
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:
.RS
.TP 0.2i
\(bu
\fBU\fR - This means 
this is a "User" account, i.e. an ordinary user. Only User 
and Workstation Trust accounts are currently supported 
in the smbpasswd file. 
.TP 0.2i
\(bu
\fBN\fR - 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 \fI   null passwords\fR parameter is set in the \fBsmb.conf\fR(5) config file. 
.TP 0.2i
\(bu
\fBD\fR - This means the account 
is disabled and no SMB/CIFS logins  will be allowed for this user. 
.TP 0.2i
\(bu
\fBW\fR - 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. 
.RE

Other flags may be added as the code is extended in future.
The rest of this field space is filled in with spaces. 
.TP
\fBLast Change Time\fR
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. 
.PP
All other colon separated fields are ignored at this time.
.SH "VERSION"
.PP
This man page is correct for version 3.0 of 
the Samba suite.
.SH "SEE ALSO"
.PP
\fBsmbpasswd\fR(8), \fBSamba\fR(7), and
the Internet RFC1321 for details on the MD4 algorithm.
.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 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  ftp://ftp.icce.rug.nl/pub/unix/ <URL: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.