Initial import
[samba] / docs / manpages / smbpasswd.5
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "SMBPASSWD" 5 "" "" ""
21 .SH NAME
22 smbpasswd \- The Samba encrypted password file
23 .SH "SYNOPSIS"
24
25 .PP
26 \fIsmbpasswd\fR
27
28 .SH "DESCRIPTION"
29
30 .PP
31 This tool is part of the \fBsamba\fR(7) suite\&.
32
33 .PP
34 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\&.
35
36 .SH "FILE FORMAT"
37
38 .PP
39 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:
40
41 .TP
42 name
43 This is the user name\&. It must be a name that already exists in the standard UNIX passwd file\&.
44
45 .TP
46 uid
47 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\&.
48
49 .TP
50 Lanman Password Hash
51 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\fBdisabled\fR and the user will not be able to log onto the Samba server\&.
52
53 \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\&.
54
55 .TP
56 NT Password Hash
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
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
61 \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\&.
62
63 .TP
64 Account Flags
65 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:
66
67
68 .RS
69 .TP 3
70 \(bu
71 \fBU\fR \- This means this is a "User" account, i\&.e\&. an ordinary user\&.
72 .TP
73 \(bu
74 \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\&.
75 .TP
76 \(bu
77 \fBD\fR \- This means the account is disabled and no SMB/CIFS logins will be allowed for this user\&.
78 .TP
79 \(bu
80 \fBX\fR \- This means the password does not expire\&.
81 .TP
82 \(bu
83 \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\&.
84 .LP
85 .RE
86 .IP
87 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 \fBpdbedit\fR command\&.
88
89 .TP
90 Last Change Time
91 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\&.
92
93 .PP
94 All other colon separated fields are ignored at this time\&.
95
96 .SH "VERSION"
97
98 .PP
99 This man page is correct for version 3\&.0 of the Samba suite\&.
100
101 .SH "SEE ALSO"
102
103 .PP
104 \fBsmbpasswd\fR(8), \fBSamba\fR(7), and the Internet RFC1321 for details on the MD4 algorithm\&.
105
106 .SH "AUTHOR"
107
108 .PP
109 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\&.
110
111 .PP
112 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/) 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\&.
113