s3:smbd: if a fsp has fsp->deferred_close, clients shouldn't be able to use it
[kai/samba-autobuild/.git] / source3 / smbd / files.c
1 /* 
2    Unix SMB/CIFS implementation.
3    Files[] structure handling
4    Copyright (C) Andrew Tridgell 1998
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #include "includes.h"
21 #include "smbd/smbd.h"
22 #include "smbd/globals.h"
23 #include "libcli/security/security.h"
24 #include "util_tdb.h"
25 #include <ccan/hash/hash.h>
26 #include "lib/util/bitmap.h"
27
28 #define FILE_HANDLE_OFFSET 0x1000
29
30 /**
31  * create new fsp to be used for file_new or a durable handle reconnect
32  */
33 NTSTATUS fsp_new(struct connection_struct *conn, TALLOC_CTX *mem_ctx,
34                  files_struct **result)
35 {
36         NTSTATUS status = NT_STATUS_NO_MEMORY;
37         files_struct *fsp = NULL;
38         struct smbd_server_connection *sconn = conn->sconn;
39
40         fsp = talloc_zero(mem_ctx, struct files_struct);
41         if (fsp == NULL) {
42                 goto fail;
43         }
44
45         /*
46          * This can't be a child of fsp because the file_handle can be ref'd
47          * when doing a dos/fcb open, which will then share the file_handle
48          * across multiple fsps.
49          */
50         fsp->fh = talloc_zero(mem_ctx, struct fd_handle);
51         if (fsp->fh == NULL) {
52                 goto fail;
53         }
54
55         fsp->fh->ref_count = 1;
56         fsp->fh->fd = -1;
57
58         fsp->fnum = FNUM_FIELD_INVALID;
59         fsp->conn = conn;
60
61         DLIST_ADD(sconn->files, fsp);
62         sconn->num_files += 1;
63
64         conn->num_files_open++;
65
66         *result = fsp;
67         return NT_STATUS_OK;
68
69 fail:
70         if (fsp != NULL) {
71                 TALLOC_FREE(fsp->fh);
72         }
73         TALLOC_FREE(fsp);
74
75         return status;
76 }
77
78 /****************************************************************************
79  Find first available file slot.
80 ****************************************************************************/
81
82 NTSTATUS file_new(struct smb_request *req, connection_struct *conn,
83                   files_struct **result)
84 {
85         struct smbd_server_connection *sconn = conn->sconn;
86         files_struct *fsp;
87         NTSTATUS status;
88
89         status = fsp_new(conn, conn, &fsp);
90         if (!NT_STATUS_IS_OK(status)) {
91                 return status;
92         }
93
94         GetTimeOfDay(&fsp->open_time);
95
96         if (sconn->conn) {
97                 struct smbXsrv_open *op = NULL;
98                 NTTIME now = timeval_to_nttime(&fsp->open_time);
99
100                 status = smbXsrv_open_create(sconn->conn,
101                                              conn->session_info,
102                                              now, &op);
103                 if (!NT_STATUS_IS_OK(status)) {
104                         file_free(NULL, fsp);
105                         return status;
106                 }
107                 fsp->op = op;
108                 op->compat = fsp;
109                 fsp->fnum = op->local_id;
110                 fsp->fh->gen_id = smbXsrv_open_hash(op);
111         }
112
113         /*
114          * Create an smb_filename with "" for the base_name.  There are very
115          * few NULL checks, so make sure it's initialized with something. to
116          * be safe until an audit can be done.
117          */
118         status = create_synthetic_smb_fname(fsp, "", NULL, NULL,
119                                             &fsp->fsp_name);
120         if (!NT_STATUS_IS_OK(status)) {
121                 file_free(NULL, fsp);
122                 return status;
123         }
124
125         DEBUG(5,("allocated file structure %s (%u used)\n",
126                  fsp_fnum_dbg(fsp), (unsigned int)sconn->num_files));
127
128         if (req != NULL) {
129                 fsp->mid = req->mid;
130                 req->chain_fsp = fsp;
131         }
132
133         /* A new fsp invalidates the positive and
134           negative fsp_fi_cache as the new fsp is pushed
135           at the start of the list and we search from
136           a cache hit to the *end* of the list. */
137
138         ZERO_STRUCT(sconn->fsp_fi_cache);
139
140         *result = fsp;
141         return NT_STATUS_OK;
142 }
143
144 /****************************************************************************
145  Close all open files for a connection.
146 ****************************************************************************/
147
148 void file_close_conn(connection_struct *conn)
149 {
150         files_struct *fsp, *next;
151
152         for (fsp=conn->sconn->files; fsp; fsp=next) {
153                 next = fsp->next;
154                 if (fsp->conn == conn) {
155                         close_file(NULL, fsp, SHUTDOWN_CLOSE);
156                 }
157         }
158 }
159
160 /****************************************************************************
161  Close all open files for a pid and a vuid.
162 ****************************************************************************/
163
164 void file_close_pid(struct smbd_server_connection *sconn, uint16 smbpid,
165                     uint64_t vuid)
166 {
167         files_struct *fsp, *next;
168
169         for (fsp=sconn->files;fsp;fsp=next) {
170                 next = fsp->next;
171                 if ((fsp->file_pid == smbpid) && (fsp->vuid == vuid)) {
172                         close_file(NULL, fsp, SHUTDOWN_CLOSE);
173                 }
174         }
175 }
176
177 /****************************************************************************
178  Initialise file structures.
179 ****************************************************************************/
180
181 static int files_max_open_fds;
182
183 bool file_init_global(void)
184 {
185         int request_max = lp_max_open_files();
186         int real_lim;
187         int real_max;
188
189         if (files_max_open_fds != 0) {
190                 return true;
191         }
192
193         /*
194          * Set the max_open files to be the requested
195          * max plus a fudgefactor to allow for the extra
196          * fd's we need such as log files etc...
197          */
198         real_lim = set_maxfiles(request_max + MAX_OPEN_FUDGEFACTOR);
199
200         real_max = real_lim - MAX_OPEN_FUDGEFACTOR;
201
202         if (real_max + FILE_HANDLE_OFFSET + MAX_OPEN_PIPES > 65536) {
203                 real_max = 65536 - FILE_HANDLE_OFFSET - MAX_OPEN_PIPES;
204         }
205
206         if (real_max != request_max) {
207                 DEBUG(1, ("file_init_global: Information only: requested %d "
208                           "open files, %d are available.\n",
209                           request_max, real_max));
210         }
211
212         SMB_ASSERT(real_max > 100);
213
214         files_max_open_fds = real_max;
215         return true;
216 }
217
218 bool file_init(struct smbd_server_connection *sconn)
219 {
220         bool ok;
221
222         ok = file_init_global();
223         if (!ok) {
224                 return false;
225         }
226
227         sconn->real_max_open_files = files_max_open_fds;
228
229         return true;
230 }
231
232 /****************************************************************************
233  Close files open by a specified vuid.
234 ****************************************************************************/
235
236 void file_close_user(struct smbd_server_connection *sconn, uint64_t vuid)
237 {
238         files_struct *fsp, *next;
239
240         for (fsp=sconn->files; fsp; fsp=next) {
241                 next=fsp->next;
242                 if (fsp->vuid == vuid) {
243                         close_file(NULL, fsp, SHUTDOWN_CLOSE);
244                 }
245         }
246 }
247
248 /*
249  * Walk the files table until "fn" returns non-NULL
250  */
251
252 struct files_struct *files_forall(
253         struct smbd_server_connection *sconn,
254         struct files_struct *(*fn)(struct files_struct *fsp,
255                                    void *private_data),
256         void *private_data)
257 {
258         struct files_struct *fsp, *next;
259
260         for (fsp = sconn->files; fsp; fsp = next) {
261                 struct files_struct *ret;
262                 next = fsp->next;
263                 ret = fn(fsp, private_data);
264                 if (ret != NULL) {
265                         return ret;
266                 }
267         }
268         return NULL;
269 }
270
271 /****************************************************************************
272  Find a fsp given a file descriptor.
273 ****************************************************************************/
274
275 files_struct *file_find_fd(struct smbd_server_connection *sconn, int fd)
276 {
277         int count=0;
278         files_struct *fsp;
279
280         for (fsp=sconn->files; fsp; fsp=fsp->next,count++) {
281                 if (fsp->fh->fd == fd) {
282                         if (count > 10) {
283                                 DLIST_PROMOTE(sconn->files, fsp);
284                         }
285                         return fsp;
286                 }
287         }
288
289         return NULL;
290 }
291
292 /****************************************************************************
293  Find a fsp given a device, inode and file_id.
294 ****************************************************************************/
295
296 files_struct *file_find_dif(struct smbd_server_connection *sconn,
297                             struct file_id id, unsigned long gen_id)
298 {
299         int count=0;
300         files_struct *fsp;
301
302         if (gen_id == 0) {
303                 return NULL;
304         }
305
306         for (fsp=sconn->files; fsp; fsp=fsp->next,count++) {
307                 /* We can have a fsp->fh->fd == -1 here as it could be a stat open. */
308                 if (file_id_equal(&fsp->file_id, &id) &&
309                     fsp->fh->gen_id == gen_id ) {
310                         if (count > 10) {
311                                 DLIST_PROMOTE(sconn->files, fsp);
312                         }
313                         /* Paranoia check. */
314                         if ((fsp->fh->fd == -1) &&
315                             (fsp->oplock_type != NO_OPLOCK) &&
316                             (fsp->oplock_type != FAKE_LEVEL_II_OPLOCK)) {
317                                 DEBUG(0,("file_find_dif: file %s file_id = "
318                                          "%s, gen = %u oplock_type = %u is a "
319                                          "stat open with oplock type !\n",
320                                          fsp_str_dbg(fsp),
321                                          file_id_string_tos(&fsp->file_id),
322                                          (unsigned int)fsp->fh->gen_id,
323                                          (unsigned int)fsp->oplock_type ));
324                                 smb_panic("file_find_dif");
325                         }
326                         return fsp;
327                 }
328         }
329
330         return NULL;
331 }
332
333 /****************************************************************************
334  Find the first fsp given a device and inode.
335  We use a singleton cache here to speed up searching from getfilepathinfo
336  calls.
337 ****************************************************************************/
338
339 files_struct *file_find_di_first(struct smbd_server_connection *sconn,
340                                  struct file_id id)
341 {
342         files_struct *fsp;
343
344         if (file_id_equal(&sconn->fsp_fi_cache.id, &id)) {
345                 /* Positive or negative cache hit. */
346                 return sconn->fsp_fi_cache.fsp;
347         }
348
349         sconn->fsp_fi_cache.id = id;
350
351         for (fsp=sconn->files;fsp;fsp=fsp->next) {
352                 if (file_id_equal(&fsp->file_id, &id)) {
353                         /* Setup positive cache. */
354                         sconn->fsp_fi_cache.fsp = fsp;
355                         return fsp;
356                 }
357         }
358
359         /* Setup negative cache. */
360         sconn->fsp_fi_cache.fsp = NULL;
361         return NULL;
362 }
363
364 /****************************************************************************
365  Find the next fsp having the same device and inode.
366 ****************************************************************************/
367
368 files_struct *file_find_di_next(files_struct *start_fsp)
369 {
370         files_struct *fsp;
371
372         for (fsp = start_fsp->next;fsp;fsp=fsp->next) {
373                 if (file_id_equal(&fsp->file_id, &start_fsp->file_id)) {
374                         return fsp;
375                 }
376         }
377
378         return NULL;
379 }
380
381 /****************************************************************************
382  Find any fsp open with a pathname below that of an already open path.
383 ****************************************************************************/
384
385 bool file_find_subpath(files_struct *dir_fsp)
386 {
387         files_struct *fsp;
388         size_t dlen;
389         char *d_fullname = NULL;
390
391         d_fullname = talloc_asprintf(talloc_tos(), "%s/%s",
392                                      dir_fsp->conn->connectpath,
393                                      dir_fsp->fsp_name->base_name);
394
395         if (!d_fullname) {
396                 return false;
397         }
398
399         dlen = strlen(d_fullname);
400
401         for (fsp=dir_fsp->conn->sconn->files; fsp; fsp=fsp->next) {
402                 char *d1_fullname;
403
404                 if (fsp == dir_fsp) {
405                         continue;
406                 }
407
408                 d1_fullname = talloc_asprintf(talloc_tos(),
409                                         "%s/%s",
410                                         fsp->conn->connectpath,
411                                         fsp->fsp_name->base_name);
412
413                 /*
414                  * If the open file has a path that is a longer
415                  * component, then it's a subpath.
416                  */
417                 if (strnequal(d_fullname, d1_fullname, dlen) &&
418                                 (d1_fullname[dlen] == '/')) {
419                         TALLOC_FREE(d1_fullname);
420                         TALLOC_FREE(d_fullname);
421                         return true;
422                 }
423                 TALLOC_FREE(d1_fullname);
424         }
425
426         TALLOC_FREE(d_fullname);
427         return false;
428 }
429
430 /****************************************************************************
431  Sync open files on a connection.
432 ****************************************************************************/
433
434 void file_sync_all(connection_struct *conn)
435 {
436         files_struct *fsp, *next;
437
438         for (fsp=conn->sconn->files; fsp; fsp=next) {
439                 next=fsp->next;
440                 if ((conn == fsp->conn) && (fsp->fh->fd != -1)) {
441                         sync_file(conn, fsp, True /* write through */);
442                 }
443         }
444 }
445
446 /****************************************************************************
447  Free up a fsp.
448 ****************************************************************************/
449
450 void fsp_free(files_struct *fsp)
451 {
452         struct smbd_server_connection *sconn = fsp->conn->sconn;
453
454         DLIST_REMOVE(sconn->files, fsp);
455         SMB_ASSERT(sconn->num_files > 0);
456         sconn->num_files--;
457
458         TALLOC_FREE(fsp->fake_file_handle);
459
460         if (fsp->fh->ref_count == 1) {
461                 TALLOC_FREE(fsp->fh);
462         } else {
463                 fsp->fh->ref_count--;
464         }
465
466         fsp->conn->num_files_open--;
467
468         /* this is paranoia, just in case someone tries to reuse the
469            information */
470         ZERO_STRUCTP(fsp);
471
472         /* fsp->fsp_name is a talloc child and is free'd automatically. */
473         TALLOC_FREE(fsp);
474 }
475
476 void file_free(struct smb_request *req, files_struct *fsp)
477 {
478         struct smbd_server_connection *sconn = fsp->conn->sconn;
479         uint64_t fnum = fsp->fnum;
480
481         if (fsp->notify) {
482                 struct notify_context *notify_ctx =
483                         fsp->conn->sconn->notify_ctx;
484                 notify_remove(notify_ctx, fsp);
485                 TALLOC_FREE(fsp->notify);
486         }
487
488         /* Ensure this event will never fire. */
489         TALLOC_FREE(fsp->update_write_time_event);
490
491         if (fsp->op != NULL) {
492                 fsp->op->compat = NULL;
493         }
494         TALLOC_FREE(fsp->op);
495
496         if ((req != NULL) && (fsp == req->chain_fsp)) {
497                 req->chain_fsp = NULL;
498         }
499
500         /*
501          * Clear all possible chained fsp
502          * pointers in the SMB2 request queue.
503          */
504         if (req != NULL && req->smb2req) {
505                 remove_smb2_chained_fsp(fsp);
506         }
507
508         /* Closing a file can invalidate the positive cache. */
509         if (fsp == sconn->fsp_fi_cache.fsp) {
510                 ZERO_STRUCT(sconn->fsp_fi_cache);
511         }
512
513         /* Drop all remaining extensions. */
514         vfs_remove_all_fsp_extensions(fsp);
515
516         fsp_free(fsp);
517
518         DEBUG(5,("freed files structure %llu (%u used)\n",
519                  (unsigned long long)fnum, (unsigned int)sconn->num_files));
520 }
521
522 /****************************************************************************
523  Get an fsp from a packet given a 16 bit fnum.
524 ****************************************************************************/
525
526 files_struct *file_fsp(struct smb_request *req, uint16 fid)
527 {
528         struct smbXsrv_open *op;
529         NTSTATUS status;
530         NTTIME now = 0;
531         files_struct *fsp;
532
533         if (req == NULL) {
534                 /*
535                  * We should never get here. req==NULL could in theory
536                  * only happen from internal opens with a non-zero
537                  * root_dir_fid. Internal opens just don't do that, at
538                  * least they are not supposed to do so. And if they
539                  * start to do so, they better fake up a smb_request
540                  * from which we get the right smbd_server_conn. While
541                  * this should never happen, let's return NULL here.
542                  */
543                 return NULL;
544         }
545
546         if (req->chain_fsp != NULL) {
547                 if (req->chain_fsp->deferred_close) {
548                         return NULL;
549                 }
550                 return req->chain_fsp;
551         }
552
553         if (req->sconn->conn == NULL) {
554                 return NULL;
555         }
556
557         now = timeval_to_nttime(&req->request_time);
558
559         status = smb1srv_open_lookup(req->sconn->conn,
560                                      fid, now, &op);
561         if (!NT_STATUS_IS_OK(status)) {
562                 return NULL;
563         }
564
565         fsp = op->compat;
566         if (fsp == NULL) {
567                 return NULL;
568         }
569
570         if (fsp->deferred_close) {
571                 return NULL;
572         }
573
574         req->chain_fsp = fsp;
575         return fsp;
576 }
577
578 struct files_struct *file_fsp_smb2(struct smbd_smb2_request *smb2req,
579                                    uint64_t persistent_id,
580                                    uint64_t volatile_id)
581 {
582         struct smbXsrv_open *op;
583         NTSTATUS status;
584         NTTIME now = 0;
585         struct files_struct *fsp;
586
587         if (smb2req->compat_chain_fsp != NULL) {
588                 if (smb2req->compat_chain_fsp->deferred_close) {
589                         return NULL;
590                 }
591                 return smb2req->compat_chain_fsp;
592         }
593
594         now = timeval_to_nttime(&smb2req->request_time);
595
596         status = smb2srv_open_lookup(smb2req->sconn->conn,
597                                      persistent_id, volatile_id,
598                                      now, &op);
599         if (!NT_STATUS_IS_OK(status)) {
600                 return NULL;
601         }
602
603         fsp = op->compat;
604         if (fsp == NULL) {
605                 return NULL;
606         }
607
608         if (smb2req->tcon == NULL) {
609                 return NULL;
610         }
611
612         if (smb2req->tcon->compat != fsp->conn) {
613                 return NULL;
614         }
615
616         if (smb2req->session == NULL) {
617                 return NULL;
618         }
619
620         if (smb2req->session->compat == NULL) {
621                 return NULL;
622         }
623
624         if (smb2req->session->compat->vuid != fsp->vuid) {
625                 return NULL;
626         }
627
628         if (fsp->deferred_close) {
629                 return NULL;
630         }
631
632         smb2req->compat_chain_fsp = fsp;
633         return fsp;
634 }
635
636 /****************************************************************************
637  Duplicate the file handle part for a DOS or FCB open.
638 ****************************************************************************/
639
640 NTSTATUS dup_file_fsp(struct smb_request *req, files_struct *from,
641                       uint32 access_mask, uint32 share_access,
642                       uint32 create_options, files_struct *to)
643 {
644         /* this can never happen for print files */
645         SMB_ASSERT(from->print_file == NULL);
646
647         TALLOC_FREE(to->fh);
648
649         to->fh = from->fh;
650         to->fh->ref_count++;
651
652         to->file_id = from->file_id;
653         to->initial_allocation_size = from->initial_allocation_size;
654         to->file_pid = from->file_pid;
655         to->vuid = from->vuid;
656         to->open_time = from->open_time;
657         to->access_mask = access_mask;
658         to->share_access = share_access;
659         to->oplock_type = from->oplock_type;
660         to->can_lock = from->can_lock;
661         to->can_read = ((access_mask & FILE_READ_DATA) != 0);
662         to->can_write =
663                 CAN_WRITE(from->conn) &&
664                 ((access_mask & (FILE_WRITE_DATA | FILE_APPEND_DATA)) != 0);
665         to->modified = from->modified;
666         to->is_directory = from->is_directory;
667         to->aio_write_behind = from->aio_write_behind;
668
669         return fsp_set_smb_fname(to, from->fsp_name);
670 }
671
672 /**
673  * Return a jenkins hash of a pathname on a connection.
674  */
675
676 NTSTATUS file_name_hash(connection_struct *conn,
677                         const char *name, uint32_t *p_name_hash)
678 {
679         char *fullpath = NULL;
680
681         /* Set the hash of the full pathname. */
682         fullpath = talloc_asprintf(talloc_tos(),
683                         "%s/%s",
684                         conn->connectpath,
685                         name);
686         if (!fullpath) {
687                 return NT_STATUS_NO_MEMORY;
688         }
689         *p_name_hash = hash(fullpath, talloc_get_size(fullpath), 0);
690
691         DEBUG(10,("file_name_hash: %s hash 0x%x\n",
692                 fullpath,
693                 (unsigned int)*p_name_hash ));
694
695         TALLOC_FREE(fullpath);
696         return NT_STATUS_OK;
697 }
698
699 /**
700  * The only way that the fsp->fsp_name field should ever be set.
701  */
702 NTSTATUS fsp_set_smb_fname(struct files_struct *fsp,
703                            const struct smb_filename *smb_fname_in)
704 {
705         NTSTATUS status;
706         struct smb_filename *smb_fname_new;
707
708         status = copy_smb_filename(fsp, smb_fname_in, &smb_fname_new);
709         if (!NT_STATUS_IS_OK(status)) {
710                 return status;
711         }
712
713         TALLOC_FREE(fsp->fsp_name);
714         fsp->fsp_name = smb_fname_new;
715
716         return file_name_hash(fsp->conn,
717                         smb_fname_str_dbg(fsp->fsp_name),
718                         &fsp->name_hash);
719 }