Rework of VFS is_offline() function to only return boolean offline/online result...
[Samba/gebeck_regimport.git] / source / smbd / dosmode.c
blobeb18f65fca9dc4541925294778c758d9e361ad24
1 /*
2 Unix SMB/CIFS implementation.
3 dos mode handling functions
4 Copyright (C) Andrew Tridgell 1992-1998
5 Copyright (C) James Peach 2006
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #include "includes.h"
23 static int set_sparse_flag(const SMB_STRUCT_STAT * const sbuf)
25 #if defined (HAVE_STAT_ST_BLOCKS) && defined(STAT_ST_BLOCKSIZE)
26 if (sbuf->st_size > sbuf->st_blocks * (SMB_OFF_T)STAT_ST_BLOCKSIZE) {
27 return FILE_ATTRIBUTE_SPARSE;
29 #endif
30 return 0;
33 /****************************************************************************
34 Change a dos mode to a unix mode.
35 Base permission for files:
36 if creating file and inheriting (i.e. parent_dir != NULL)
37 apply read/write bits from parent directory.
38 else
39 everybody gets read bit set
40 dos readonly is represented in unix by removing everyone's write bit
41 dos archive is represented in unix by the user's execute bit
42 dos system is represented in unix by the group's execute bit
43 dos hidden is represented in unix by the other's execute bit
44 if !inheriting {
45 Then apply create mask,
46 then add force bits.
48 Base permission for directories:
49 dos directory is represented in unix by unix's dir bit and the exec bit
50 if !inheriting {
51 Then apply create mask,
52 then add force bits.
54 ****************************************************************************/
56 mode_t unix_mode(connection_struct *conn, int dosmode, const char *fname,
57 const char *inherit_from_dir)
59 mode_t result = (S_IRUSR | S_IRGRP | S_IROTH | S_IWUSR | S_IWGRP | S_IWOTH);
60 mode_t dir_mode = 0; /* Mode of the inherit_from directory if
61 * inheriting. */
63 if (!lp_store_dos_attributes(SNUM(conn)) && IS_DOS_READONLY(dosmode)) {
64 result &= ~(S_IWUSR | S_IWGRP | S_IWOTH);
67 if (fname && (inherit_from_dir != NULL)
68 && lp_inherit_perms(SNUM(conn))) {
69 SMB_STRUCT_STAT sbuf;
71 DEBUG(2, ("unix_mode(%s) inheriting from %s\n", fname,
72 inherit_from_dir));
73 if (SMB_VFS_STAT(conn, inherit_from_dir, &sbuf) != 0) {
74 DEBUG(4,("unix_mode(%s) failed, [dir %s]: %s\n", fname,
75 inherit_from_dir, strerror(errno)));
76 return(0); /* *** shouldn't happen! *** */
79 /* Save for later - but explicitly remove setuid bit for safety. */
80 dir_mode = sbuf.st_mode & ~S_ISUID;
81 DEBUG(2,("unix_mode(%s) inherit mode %o\n",fname,(int)dir_mode));
82 /* Clear "result" */
83 result = 0;
86 if (IS_DOS_DIR(dosmode)) {
87 /* We never make directories read only for the owner as under DOS a user
88 can always create a file in a read-only directory. */
89 result |= (S_IFDIR | S_IWUSR);
91 if (dir_mode) {
92 /* Inherit mode of parent directory. */
93 result |= dir_mode;
94 } else {
95 /* Provisionally add all 'x' bits */
96 result |= (S_IXUSR | S_IXGRP | S_IXOTH);
98 /* Apply directory mask */
99 result &= lp_dir_mask(SNUM(conn));
100 /* Add in force bits */
101 result |= lp_force_dir_mode(SNUM(conn));
103 } else {
104 if (lp_map_archive(SNUM(conn)) && IS_DOS_ARCHIVE(dosmode))
105 result |= S_IXUSR;
107 if (lp_map_system(SNUM(conn)) && IS_DOS_SYSTEM(dosmode))
108 result |= S_IXGRP;
110 if (lp_map_hidden(SNUM(conn)) && IS_DOS_HIDDEN(dosmode))
111 result |= S_IXOTH;
113 if (dir_mode) {
114 /* Inherit 666 component of parent directory mode */
115 result |= dir_mode & (S_IRUSR | S_IRGRP | S_IROTH | S_IWUSR | S_IWGRP | S_IWOTH);
116 } else {
117 /* Apply mode mask */
118 result &= lp_create_mask(SNUM(conn));
119 /* Add in force bits */
120 result |= lp_force_create_mode(SNUM(conn));
124 DEBUG(3,("unix_mode(%s) returning 0%o\n",fname,(int)result ));
125 return(result);
128 /****************************************************************************
129 Change a unix mode to a dos mode.
130 ****************************************************************************/
132 static uint32 dos_mode_from_sbuf(connection_struct *conn, const char *path, SMB_STRUCT_STAT *sbuf)
134 int result = 0;
135 enum mapreadonly_options ro_opts = (enum mapreadonly_options)lp_map_readonly(SNUM(conn));
137 if (ro_opts == MAP_READONLY_YES) {
138 /* Original Samba method - map inverse of user "w" bit. */
139 if ((sbuf->st_mode & S_IWUSR) == 0) {
140 result |= aRONLY;
142 } else if (ro_opts == MAP_READONLY_PERMISSIONS) {
143 /* Check actual permissions for read-only. */
144 if (!can_write_to_file(conn, path, sbuf)) {
145 result |= aRONLY;
147 } /* Else never set the readonly bit. */
149 if (MAP_ARCHIVE(conn) && ((sbuf->st_mode & S_IXUSR) != 0))
150 result |= aARCH;
152 if (MAP_SYSTEM(conn) && ((sbuf->st_mode & S_IXGRP) != 0))
153 result |= aSYSTEM;
155 if (MAP_HIDDEN(conn) && ((sbuf->st_mode & S_IXOTH) != 0))
156 result |= aHIDDEN;
158 if (S_ISDIR(sbuf->st_mode))
159 result = aDIR | (result & aRONLY);
161 result |= set_sparse_flag(sbuf);
163 #ifdef S_ISLNK
164 #if LINKS_READ_ONLY
165 if (S_ISLNK(sbuf->st_mode) && S_ISDIR(sbuf->st_mode))
166 result |= aRONLY;
167 #endif
168 #endif
170 DEBUG(8,("dos_mode_from_sbuf returning "));
172 if (result & aHIDDEN) DEBUG(8, ("h"));
173 if (result & aRONLY ) DEBUG(8, ("r"));
174 if (result & aSYSTEM) DEBUG(8, ("s"));
175 if (result & aDIR ) DEBUG(8, ("d"));
176 if (result & aARCH ) DEBUG(8, ("a"));
178 DEBUG(8,("\n"));
179 return result;
182 /****************************************************************************
183 Get DOS attributes from an EA.
184 ****************************************************************************/
186 static bool get_ea_dos_attribute(connection_struct *conn, const char *path,SMB_STRUCT_STAT *sbuf, uint32 *pattr)
188 ssize_t sizeret;
189 fstring attrstr;
190 unsigned int dosattr;
192 if (!lp_store_dos_attributes(SNUM(conn))) {
193 return False;
196 /* Don't reset pattr to zero as we may already have filename-based attributes we
197 need to preserve. */
199 sizeret = SMB_VFS_GETXATTR(conn, path, SAMBA_XATTR_DOS_ATTRIB, attrstr, sizeof(attrstr));
200 if (sizeret == -1) {
201 #if defined(ENOTSUP) && defined(ENOATTR)
202 if ((errno != ENOTSUP) && (errno != ENOATTR) && (errno != EACCES) && (errno != EPERM)) {
203 DEBUG(1,("get_ea_dos_attributes: Cannot get attribute from EA on file %s: Error = %s\n",
204 path, strerror(errno) ));
205 set_store_dos_attributes(SNUM(conn), False);
207 #endif
208 return False;
210 /* Null terminate string. */
211 attrstr[sizeret] = 0;
212 DEBUG(10,("get_ea_dos_attribute: %s attrstr = %s\n", path, attrstr));
214 if (sizeret < 2 || attrstr[0] != '0' || attrstr[1] != 'x' ||
215 sscanf(attrstr, "%x", &dosattr) != 1) {
216 DEBUG(1,("get_ea_dos_attributes: Badly formed DOSATTRIB on file %s - %s\n", path, attrstr));
217 return False;
220 if (S_ISDIR(sbuf->st_mode)) {
221 dosattr |= aDIR;
223 *pattr = (uint32)(dosattr & SAMBA_ATTRIBUTES_MASK);
225 DEBUG(8,("get_ea_dos_attribute returning (0x%x)", dosattr));
227 if (dosattr & aHIDDEN) DEBUG(8, ("h"));
228 if (dosattr & aRONLY ) DEBUG(8, ("r"));
229 if (dosattr & aSYSTEM) DEBUG(8, ("s"));
230 if (dosattr & aDIR ) DEBUG(8, ("d"));
231 if (dosattr & aARCH ) DEBUG(8, ("a"));
233 DEBUG(8,("\n"));
235 return True;
238 /****************************************************************************
239 Set DOS attributes in an EA.
240 ****************************************************************************/
242 static bool set_ea_dos_attribute(connection_struct *conn, const char *path, SMB_STRUCT_STAT *sbuf, uint32 dosmode)
244 fstring attrstr;
245 files_struct *fsp = NULL;
246 bool ret = False;
248 if (!lp_store_dos_attributes(SNUM(conn))) {
249 return False;
252 snprintf(attrstr, sizeof(attrstr)-1, "0x%x", dosmode & SAMBA_ATTRIBUTES_MASK);
253 if (SMB_VFS_SETXATTR(conn, path, SAMBA_XATTR_DOS_ATTRIB, attrstr, strlen(attrstr), 0) == -1) {
254 if((errno != EPERM) && (errno != EACCES)) {
255 if (errno == ENOSYS
256 #if defined(ENOTSUP)
257 || errno == ENOTSUP) {
258 #else
260 #endif
261 set_store_dos_attributes(SNUM(conn), False);
263 return False;
266 /* We want DOS semantics, ie allow non owner with write permission to change the
267 bits on a file. Just like file_ntimes below.
270 /* Check if we have write access. */
271 if(!CAN_WRITE(conn) || !lp_dos_filemode(SNUM(conn)))
272 return False;
275 * We need to open the file with write access whilst
276 * still in our current user context. This ensures we
277 * are not violating security in doing the setxattr.
280 if (!NT_STATUS_IS_OK(open_file_fchmod(conn,path,sbuf,&fsp)))
281 return ret;
282 become_root();
283 if (SMB_VFS_SETXATTR(conn, path, SAMBA_XATTR_DOS_ATTRIB, attrstr, strlen(attrstr), 0) == 0) {
284 ret = True;
286 unbecome_root();
287 close_file_fchmod(fsp);
288 return ret;
290 DEBUG(10,("set_ea_dos_attribute: set EA %s on file %s\n", attrstr, path));
291 return True;
294 /****************************************************************************
295 Change a unix mode to a dos mode for an ms dfs link.
296 ****************************************************************************/
298 uint32 dos_mode_msdfs(connection_struct *conn, const char *path,SMB_STRUCT_STAT *sbuf)
300 uint32 result = 0;
302 DEBUG(8,("dos_mode_msdfs: %s\n", path));
304 if (!VALID_STAT(*sbuf)) {
305 return 0;
308 /* First do any modifications that depend on the path name. */
309 /* hide files with a name starting with a . */
310 if (lp_hide_dot_files(SNUM(conn))) {
311 const char *p = strrchr_m(path,'/');
312 if (p) {
313 p++;
314 } else {
315 p = path;
318 if (p[0] == '.' && p[1] != '.' && p[1] != 0) {
319 result |= aHIDDEN;
323 result |= dos_mode_from_sbuf(conn, path, sbuf);
325 /* Optimization : Only call is_hidden_path if it's not already
326 hidden. */
327 if (!(result & aHIDDEN) && IS_HIDDEN_PATH(conn,path)) {
328 result |= aHIDDEN;
331 DEBUG(8,("dos_mode_msdfs returning "));
333 if (result & aHIDDEN) DEBUG(8, ("h"));
334 if (result & aRONLY ) DEBUG(8, ("r"));
335 if (result & aSYSTEM) DEBUG(8, ("s"));
336 if (result & aDIR ) DEBUG(8, ("d"));
337 if (result & aARCH ) DEBUG(8, ("a"));
338 if (result & FILE_ATTRIBUTE_SPARSE ) DEBUG(8, ("[sparse]"));
340 DEBUG(8,("\n"));
342 return(result);
345 /****************************************************************************
346 Change a unix mode to a dos mode.
347 ****************************************************************************/
349 uint32 dos_mode(connection_struct *conn, const char *path,SMB_STRUCT_STAT *sbuf)
351 uint32 result = 0;
352 bool offline;
354 DEBUG(8,("dos_mode: %s\n", path));
356 if (!VALID_STAT(*sbuf)) {
357 return 0;
360 /* First do any modifications that depend on the path name. */
361 /* hide files with a name starting with a . */
362 if (lp_hide_dot_files(SNUM(conn))) {
363 const char *p = strrchr_m(path,'/');
364 if (p) {
365 p++;
366 } else {
367 p = path;
370 if (p[0] == '.' && p[1] != '.' && p[1] != 0) {
371 result |= aHIDDEN;
375 /* Get the DOS attributes from an EA by preference. */
376 if (get_ea_dos_attribute(conn, path, sbuf, &result)) {
377 result |= set_sparse_flag(sbuf);
378 } else {
379 result |= dos_mode_from_sbuf(conn, path, sbuf);
383 offline = SMB_VFS_IS_OFFLINE(conn, path, sbuf);
384 if (S_ISREG(sbuf->st_mode) && offline) {
385 result |= FILE_ATTRIBUTE_OFFLINE;
388 /* Optimization : Only call is_hidden_path if it's not already
389 hidden. */
390 if (!(result & aHIDDEN) && IS_HIDDEN_PATH(conn,path)) {
391 result |= aHIDDEN;
394 DEBUG(8,("dos_mode returning "));
396 if (result & aHIDDEN) DEBUG(8, ("h"));
397 if (result & aRONLY ) DEBUG(8, ("r"));
398 if (result & aSYSTEM) DEBUG(8, ("s"));
399 if (result & aDIR ) DEBUG(8, ("d"));
400 if (result & aARCH ) DEBUG(8, ("a"));
401 if (result & FILE_ATTRIBUTE_SPARSE ) DEBUG(8, ("[sparse]"));
403 DEBUG(8,("\n"));
405 return(result);
408 /*******************************************************************
409 chmod a file - but preserve some bits.
410 ********************************************************************/
412 int file_set_dosmode(connection_struct *conn, const char *fname,
413 uint32 dosmode, SMB_STRUCT_STAT *st,
414 const char *parent_dir,
415 bool newfile)
417 SMB_STRUCT_STAT st1;
418 int mask=0;
419 mode_t tmp;
420 mode_t unixmode;
421 int ret = -1, lret = -1;
423 /* We only allow READONLY|HIDDEN|SYSTEM|DIRECTORY|ARCHIVE here. */
424 dosmode &= SAMBA_ATTRIBUTES_MASK;
426 DEBUG(10,("file_set_dosmode: setting dos mode 0x%x on file %s\n", dosmode, fname));
428 if (st == NULL) {
429 SET_STAT_INVALID(st1);
430 st = &st1;
433 if (!VALID_STAT(*st)) {
434 if (SMB_VFS_STAT(conn,fname,st))
435 return(-1);
438 unixmode = st->st_mode;
440 get_acl_group_bits(conn, fname, &st->st_mode);
442 if (S_ISDIR(st->st_mode))
443 dosmode |= aDIR;
444 else
445 dosmode &= ~aDIR;
447 if (dos_mode(conn,fname,st) == dosmode) {
448 st->st_mode = unixmode;
449 return(0);
452 /* Store the DOS attributes in an EA by preference. */
453 if (set_ea_dos_attribute(conn, fname, st, dosmode)) {
454 if (!newfile) {
455 notify_fname(conn, NOTIFY_ACTION_MODIFIED,
456 FILE_NOTIFY_CHANGE_ATTRIBUTES, fname);
458 st->st_mode = unixmode;
459 return 0;
462 unixmode = unix_mode(conn,dosmode,fname, parent_dir);
464 /* preserve the s bits */
465 mask |= (S_ISUID | S_ISGID);
467 /* preserve the t bit */
468 #ifdef S_ISVTX
469 mask |= S_ISVTX;
470 #endif
472 /* possibly preserve the x bits */
473 if (!MAP_ARCHIVE(conn))
474 mask |= S_IXUSR;
475 if (!MAP_SYSTEM(conn))
476 mask |= S_IXGRP;
477 if (!MAP_HIDDEN(conn))
478 mask |= S_IXOTH;
480 unixmode |= (st->st_mode & mask);
482 /* if we previously had any r bits set then leave them alone */
483 if ((tmp = st->st_mode & (S_IRUSR|S_IRGRP|S_IROTH))) {
484 unixmode &= ~(S_IRUSR|S_IRGRP|S_IROTH);
485 unixmode |= tmp;
488 /* if we previously had any w bits set then leave them alone
489 whilst adding in the new w bits, if the new mode is not rdonly */
490 if (!IS_DOS_READONLY(dosmode)) {
491 unixmode |= (st->st_mode & (S_IWUSR|S_IWGRP|S_IWOTH));
494 if (dosmode & FILE_ATTRIBUTE_OFFLINE) {
495 lret = SMB_VFS_SET_OFFLINE(conn, fname);
496 if (lret == -1) {
497 DEBUG(0, ("set_dos_mode: client has asked to set "
498 "FILE_ATTRIBUTE_OFFLINE to %s/%s but there was "
499 "an error while setting it or it is not supported.\n",
500 parent_dir, fname));
504 ret = SMB_VFS_CHMOD(conn, fname, unixmode);
505 if (ret == 0) {
506 if(!newfile || (lret != -1)) {
507 notify_fname(conn, NOTIFY_ACTION_MODIFIED,
508 FILE_NOTIFY_CHANGE_ATTRIBUTES, fname);
510 st->st_mode = unixmode;
511 return 0;
514 if((errno != EPERM) && (errno != EACCES))
515 return -1;
517 if(!lp_dos_filemode(SNUM(conn)))
518 return -1;
520 /* We want DOS semantics, ie allow non owner with write permission to change the
521 bits on a file. Just like file_ntimes below.
524 /* Check if we have write access. */
525 if (CAN_WRITE(conn)) {
527 * We need to open the file with write access whilst
528 * still in our current user context. This ensures we
529 * are not violating security in doing the fchmod.
530 * This file open does *not* break any oplocks we are
531 * holding. We need to review this.... may need to
532 * break batch oplocks open by others. JRA.
534 files_struct *fsp;
535 if (!NT_STATUS_IS_OK(open_file_fchmod(conn,fname,st,&fsp)))
536 return -1;
537 become_root();
538 ret = SMB_VFS_FCHMOD(fsp, unixmode);
539 unbecome_root();
540 close_file_fchmod(fsp);
541 if (!newfile) {
542 notify_fname(conn, NOTIFY_ACTION_MODIFIED,
543 FILE_NOTIFY_CHANGE_ATTRIBUTES, fname);
545 if (ret == 0) {
546 st->st_mode = unixmode;
550 return( ret );
553 /*******************************************************************
554 Wrapper around the VFS ntimes that possibly allows DOS semantics rather
555 than POSIX.
556 *******************************************************************/
558 int file_ntimes(connection_struct *conn, const char *fname, const struct timespec ts[2])
560 SMB_STRUCT_STAT sbuf;
561 int ret = -1;
563 errno = 0;
564 ZERO_STRUCT(sbuf);
566 /* Don't update the time on read-only shares */
567 /* We need this as set_filetime (which can be called on
568 close and other paths) can end up calling this function
569 without the NEED_WRITE protection. Found by :
570 Leo Weppelman <leo@wau.mis.ah.nl>
573 if (!CAN_WRITE(conn)) {
574 return 0;
577 if(SMB_VFS_NTIMES(conn, fname, ts) == 0) {
578 return 0;
581 if((errno != EPERM) && (errno != EACCES)) {
582 return -1;
585 if(!lp_dos_filetimes(SNUM(conn))) {
586 return -1;
589 /* We have permission (given by the Samba admin) to
590 break POSIX semantics and allow a user to change
591 the time on a file they don't own but can write to
592 (as DOS does).
595 /* Check if we have write access. */
596 if (can_write_to_file(conn, fname, &sbuf)) {
597 /* We are allowed to become root and change the filetime. */
598 become_root();
599 ret = SMB_VFS_NTIMES(conn, fname, ts);
600 unbecome_root();
603 return ret;
606 /*******************************************************************
607 Change a filetime - possibly allowing DOS semantics.
608 *******************************************************************/
610 bool set_filetime(connection_struct *conn, const char *fname,
611 const struct timespec mtime)
613 struct timespec ts[2];
615 if (null_timespec(mtime)) {
616 return(True);
619 ts[1] = mtime; /* mtime. */
620 ts[0] = ts[1]; /* atime. */
622 if (file_ntimes(conn, fname, ts)) {
623 DEBUG(4,("set_filetime(%s) failed: %s\n",
624 fname,strerror(errno)));
625 return False;
628 notify_fname(conn, NOTIFY_ACTION_MODIFIED,
629 FILE_NOTIFY_CHANGE_LAST_WRITE, fname);
631 return true;