s3: smbd: leases - losen paranoia check. Stat opens can grant leases.
[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 (req) {
97                 struct smbXsrv_connection *xconn = req->xconn;
98                 struct smbXsrv_open *op = NULL;
99                 NTTIME now = timeval_to_nttime(&fsp->open_time);
100
101                 status = smbXsrv_open_create(xconn,
102                                              conn->session_info,
103                                              now, &op);
104                 if (!NT_STATUS_IS_OK(status)) {
105                         file_free(NULL, fsp);
106                         return status;
107                 }
108                 fsp->op = op;
109                 op->compat = fsp;
110                 fsp->fnum = op->local_id;
111                 fsp->fh->gen_id = smbXsrv_open_hash(op);
112         } else {
113                 DEBUG(10, ("%s: req==NULL, INTERNAL_OPEN_ONLY, smbXsrv_open "
114                            "allocated\n", __func__));
115         }
116
117         /*
118          * Create an smb_filename with "" for the base_name.  There are very
119          * few NULL checks, so make sure it's initialized with something. to
120          * be safe until an audit can be done.
121          */
122         fsp->fsp_name = synthetic_smb_fname(fsp, "", NULL, NULL);
123         if (fsp->fsp_name == NULL) {
124                 file_free(NULL, fsp);
125                 return NT_STATUS_NO_MEMORY;
126         }
127
128         DEBUG(5,("allocated file structure %s (%u used)\n",
129                  fsp_fnum_dbg(fsp), (unsigned int)sconn->num_files));
130
131         if (req != NULL) {
132                 fsp->mid = req->mid;
133                 req->chain_fsp = fsp;
134         }
135
136         /* A new fsp invalidates the positive and
137           negative fsp_fi_cache as the new fsp is pushed
138           at the start of the list and we search from
139           a cache hit to the *end* of the list. */
140
141         ZERO_STRUCT(sconn->fsp_fi_cache);
142
143         *result = fsp;
144         return NT_STATUS_OK;
145 }
146
147 /****************************************************************************
148  Close all open files for a connection.
149 ****************************************************************************/
150
151 void file_close_conn(connection_struct *conn)
152 {
153         files_struct *fsp, *next;
154
155         for (fsp=conn->sconn->files; fsp; fsp=next) {
156                 next = fsp->next;
157                 if (fsp->conn != conn) {
158                         continue;
159                 }
160                 if (fsp->op != NULL && fsp->op->global->durable) {
161                         /*
162                          * A tree disconnect closes a durable handle
163                          */
164                         fsp->op->global->durable = false;
165                 }
166                 close_file(NULL, fsp, SHUTDOWN_CLOSE);
167         }
168 }
169
170 /****************************************************************************
171  Close all open files for a pid and a vuid.
172 ****************************************************************************/
173
174 void file_close_pid(struct smbd_server_connection *sconn, uint16 smbpid,
175                     uint64_t vuid)
176 {
177         files_struct *fsp, *next;
178
179         for (fsp=sconn->files;fsp;fsp=next) {
180                 next = fsp->next;
181                 if ((fsp->file_pid == smbpid) && (fsp->vuid == vuid)) {
182                         close_file(NULL, fsp, SHUTDOWN_CLOSE);
183                 }
184         }
185 }
186
187 /****************************************************************************
188  Initialise file structures.
189 ****************************************************************************/
190
191 static int files_max_open_fds;
192
193 bool file_init_global(void)
194 {
195         int request_max = lp_max_open_files();
196         int real_lim;
197         int real_max;
198
199         if (files_max_open_fds != 0) {
200                 return true;
201         }
202
203         /*
204          * Set the max_open files to be the requested
205          * max plus a fudgefactor to allow for the extra
206          * fd's we need such as log files etc...
207          */
208         real_lim = set_maxfiles(request_max + MAX_OPEN_FUDGEFACTOR);
209
210         real_max = real_lim - MAX_OPEN_FUDGEFACTOR;
211
212         if (real_max + FILE_HANDLE_OFFSET + MAX_OPEN_PIPES > 65536) {
213                 real_max = 65536 - FILE_HANDLE_OFFSET - MAX_OPEN_PIPES;
214         }
215
216         if (real_max != request_max) {
217                 DEBUG(1, ("file_init_global: Information only: requested %d "
218                           "open files, %d are available.\n",
219                           request_max, real_max));
220         }
221
222         SMB_ASSERT(real_max > 100);
223
224         files_max_open_fds = real_max;
225         return true;
226 }
227
228 bool file_init(struct smbd_server_connection *sconn)
229 {
230         bool ok;
231
232         ok = file_init_global();
233         if (!ok) {
234                 return false;
235         }
236
237         sconn->real_max_open_files = files_max_open_fds;
238
239         return true;
240 }
241
242 /****************************************************************************
243  Close files open by a specified vuid.
244 ****************************************************************************/
245
246 void file_close_user(struct smbd_server_connection *sconn, uint64_t vuid)
247 {
248         files_struct *fsp, *next;
249
250         for (fsp=sconn->files; fsp; fsp=next) {
251                 next=fsp->next;
252                 if (fsp->vuid == vuid) {
253                         close_file(NULL, fsp, SHUTDOWN_CLOSE);
254                 }
255         }
256 }
257
258 /*
259  * Walk the files table until "fn" returns non-NULL
260  */
261
262 struct files_struct *files_forall(
263         struct smbd_server_connection *sconn,
264         struct files_struct *(*fn)(struct files_struct *fsp,
265                                    void *private_data),
266         void *private_data)
267 {
268         struct files_struct *fsp, *next;
269
270         for (fsp = sconn->files; fsp; fsp = next) {
271                 struct files_struct *ret;
272                 next = fsp->next;
273                 ret = fn(fsp, private_data);
274                 if (ret != NULL) {
275                         return ret;
276                 }
277         }
278         return NULL;
279 }
280
281 /****************************************************************************
282  Find a fsp given a file descriptor.
283 ****************************************************************************/
284
285 files_struct *file_find_fd(struct smbd_server_connection *sconn, int fd)
286 {
287         int count=0;
288         files_struct *fsp;
289
290         for (fsp=sconn->files; fsp; fsp=fsp->next,count++) {
291                 if (fsp->fh->fd == fd) {
292                         if (count > 10) {
293                                 DLIST_PROMOTE(sconn->files, fsp);
294                         }
295                         return fsp;
296                 }
297         }
298
299         return NULL;
300 }
301
302 /****************************************************************************
303  Find a fsp given a device, inode and file_id.
304 ****************************************************************************/
305
306 files_struct *file_find_dif(struct smbd_server_connection *sconn,
307                             struct file_id id, unsigned long gen_id)
308 {
309         int count=0;
310         files_struct *fsp;
311
312         if (gen_id == 0) {
313                 return NULL;
314         }
315
316         for (fsp=sconn->files; fsp; fsp=fsp->next,count++) {
317                 /* We can have a fsp->fh->fd == -1 here as it could be a stat open. */
318                 if (file_id_equal(&fsp->file_id, &id) &&
319                     fsp->fh->gen_id == gen_id ) {
320                         if (count > 10) {
321                                 DLIST_PROMOTE(sconn->files, fsp);
322                         }
323                         /* Paranoia check. */
324                         if ((fsp->fh->fd == -1) &&
325                             (fsp->oplock_type != NO_OPLOCK &&
326                              fsp->oplock_type != LEASE_OPLOCK)) {
327                                 DEBUG(0,("file_find_dif: file %s file_id = "
328                                          "%s, gen = %u oplock_type = %u is a "
329                                          "stat open with oplock type !\n",
330                                          fsp_str_dbg(fsp),
331                                          file_id_string_tos(&fsp->file_id),
332                                          (unsigned int)fsp->fh->gen_id,
333                                          (unsigned int)fsp->oplock_type ));
334                                 smb_panic("file_find_dif");
335                         }
336                         return fsp;
337                 }
338         }
339
340         return NULL;
341 }
342
343 /****************************************************************************
344  Find the first fsp given a device and inode.
345  We use a singleton cache here to speed up searching from getfilepathinfo
346  calls.
347 ****************************************************************************/
348
349 files_struct *file_find_di_first(struct smbd_server_connection *sconn,
350                                  struct file_id id)
351 {
352         files_struct *fsp;
353
354         if (file_id_equal(&sconn->fsp_fi_cache.id, &id)) {
355                 /* Positive or negative cache hit. */
356                 return sconn->fsp_fi_cache.fsp;
357         }
358
359         sconn->fsp_fi_cache.id = id;
360
361         for (fsp=sconn->files;fsp;fsp=fsp->next) {
362                 if (file_id_equal(&fsp->file_id, &id)) {
363                         /* Setup positive cache. */
364                         sconn->fsp_fi_cache.fsp = fsp;
365                         return fsp;
366                 }
367         }
368
369         /* Setup negative cache. */
370         sconn->fsp_fi_cache.fsp = NULL;
371         return NULL;
372 }
373
374 /****************************************************************************
375  Find the next fsp having the same device and inode.
376 ****************************************************************************/
377
378 files_struct *file_find_di_next(files_struct *start_fsp)
379 {
380         files_struct *fsp;
381
382         for (fsp = start_fsp->next;fsp;fsp=fsp->next) {
383                 if (file_id_equal(&fsp->file_id, &start_fsp->file_id)) {
384                         return fsp;
385                 }
386         }
387
388         return NULL;
389 }
390
391 struct files_struct *file_find_one_fsp_from_lease_key(
392         struct smbd_server_connection *sconn,
393         const struct smb2_lease_key *lease_key)
394 {
395         struct files_struct *fsp;
396
397         for (fsp = sconn->files; fsp; fsp=fsp->next) {
398                 if ((fsp->lease != NULL) &&
399                     (fsp->lease->lease.lease_key.data[0] ==
400                      lease_key->data[0]) &&
401                     (fsp->lease->lease.lease_key.data[1] ==
402                      lease_key->data[1])) {
403                         return fsp;
404                 }
405         }
406         return NULL;
407 }
408
409 /****************************************************************************
410  Find any fsp open with a pathname below that of an already open path.
411 ****************************************************************************/
412
413 bool file_find_subpath(files_struct *dir_fsp)
414 {
415         files_struct *fsp;
416         size_t dlen;
417         char *d_fullname = NULL;
418
419         d_fullname = talloc_asprintf(talloc_tos(), "%s/%s",
420                                      dir_fsp->conn->connectpath,
421                                      dir_fsp->fsp_name->base_name);
422
423         if (!d_fullname) {
424                 return false;
425         }
426
427         dlen = strlen(d_fullname);
428
429         for (fsp=dir_fsp->conn->sconn->files; fsp; fsp=fsp->next) {
430                 char *d1_fullname;
431
432                 if (fsp == dir_fsp) {
433                         continue;
434                 }
435
436                 d1_fullname = talloc_asprintf(talloc_tos(),
437                                         "%s/%s",
438                                         fsp->conn->connectpath,
439                                         fsp->fsp_name->base_name);
440
441                 /*
442                  * If the open file has a path that is a longer
443                  * component, then it's a subpath.
444                  */
445                 if (strnequal(d_fullname, d1_fullname, dlen) &&
446                                 (d1_fullname[dlen] == '/')) {
447                         TALLOC_FREE(d1_fullname);
448                         TALLOC_FREE(d_fullname);
449                         return true;
450                 }
451                 TALLOC_FREE(d1_fullname);
452         }
453
454         TALLOC_FREE(d_fullname);
455         return false;
456 }
457
458 /****************************************************************************
459  Sync open files on a connection.
460 ****************************************************************************/
461
462 void file_sync_all(connection_struct *conn)
463 {
464         files_struct *fsp, *next;
465
466         for (fsp=conn->sconn->files; fsp; fsp=next) {
467                 next=fsp->next;
468                 if ((conn == fsp->conn) && (fsp->fh->fd != -1)) {
469                         sync_file(conn, fsp, True /* write through */);
470                 }
471         }
472 }
473
474 /****************************************************************************
475  Free up a fsp.
476 ****************************************************************************/
477
478 void fsp_free(files_struct *fsp)
479 {
480         struct smbd_server_connection *sconn = fsp->conn->sconn;
481
482         DLIST_REMOVE(sconn->files, fsp);
483         SMB_ASSERT(sconn->num_files > 0);
484         sconn->num_files--;
485
486         TALLOC_FREE(fsp->fake_file_handle);
487
488         if (fsp->fh->ref_count == 1) {
489                 TALLOC_FREE(fsp->fh);
490         } else {
491                 fsp->fh->ref_count--;
492         }
493
494         if (fsp->lease != NULL) {
495                 if (fsp->lease->ref_count == 1) {
496                         TALLOC_FREE(fsp->lease);
497                 } else {
498                         fsp->lease->ref_count--;
499                 }
500         }
501
502         fsp->conn->num_files_open--;
503
504         /* this is paranoia, just in case someone tries to reuse the
505            information */
506         ZERO_STRUCTP(fsp);
507
508         /* fsp->fsp_name is a talloc child and is free'd automatically. */
509         TALLOC_FREE(fsp);
510 }
511
512 void file_free(struct smb_request *req, files_struct *fsp)
513 {
514         struct smbd_server_connection *sconn = fsp->conn->sconn;
515         uint64_t fnum = fsp->fnum;
516
517         if (fsp->notify) {
518                 struct notify_context *notify_ctx =
519                         fsp->conn->sconn->notify_ctx;
520                 notify_remove(notify_ctx, fsp);
521                 TALLOC_FREE(fsp->notify);
522         }
523
524         /* Ensure this event will never fire. */
525         TALLOC_FREE(fsp->update_write_time_event);
526
527         if (fsp->op != NULL) {
528                 fsp->op->compat = NULL;
529         }
530         TALLOC_FREE(fsp->op);
531
532         if ((req != NULL) && (fsp == req->chain_fsp)) {
533                 req->chain_fsp = NULL;
534         }
535
536         /*
537          * Clear all possible chained fsp
538          * pointers in the SMB2 request queue.
539          */
540         if (req != NULL && req->smb2req) {
541                 remove_smb2_chained_fsp(fsp);
542         }
543
544         /* Closing a file can invalidate the positive cache. */
545         if (fsp == sconn->fsp_fi_cache.fsp) {
546                 ZERO_STRUCT(sconn->fsp_fi_cache);
547         }
548
549         /* Drop all remaining extensions. */
550         vfs_remove_all_fsp_extensions(fsp);
551
552         fsp_free(fsp);
553
554         DEBUG(5,("freed files structure %llu (%u used)\n",
555                  (unsigned long long)fnum, (unsigned int)sconn->num_files));
556 }
557
558 /****************************************************************************
559  Get an fsp from a packet given a 16 bit fnum.
560 ****************************************************************************/
561
562 files_struct *file_fsp(struct smb_request *req, uint16 fid)
563 {
564         struct smbXsrv_open *op;
565         NTSTATUS status;
566         NTTIME now = 0;
567         files_struct *fsp;
568
569         if (req == NULL) {
570                 /*
571                  * We should never get here. req==NULL could in theory
572                  * only happen from internal opens with a non-zero
573                  * root_dir_fid. Internal opens just don't do that, at
574                  * least they are not supposed to do so. And if they
575                  * start to do so, they better fake up a smb_request
576                  * from which we get the right smbd_server_conn. While
577                  * this should never happen, let's return NULL here.
578                  */
579                 return NULL;
580         }
581
582         if (req->chain_fsp != NULL) {
583                 if (req->chain_fsp->deferred_close) {
584                         return NULL;
585                 }
586                 return req->chain_fsp;
587         }
588
589         if (req->xconn == NULL) {
590                 return NULL;
591         }
592
593         now = timeval_to_nttime(&req->request_time);
594
595         status = smb1srv_open_lookup(req->xconn,
596                                      fid, now, &op);
597         if (!NT_STATUS_IS_OK(status)) {
598                 return NULL;
599         }
600
601         fsp = op->compat;
602         if (fsp == NULL) {
603                 return NULL;
604         }
605
606         if (fsp->deferred_close) {
607                 return NULL;
608         }
609
610         req->chain_fsp = fsp;
611         return fsp;
612 }
613
614 struct files_struct *file_fsp_get(struct smbd_smb2_request *smb2req,
615                                   uint64_t persistent_id,
616                                   uint64_t volatile_id)
617 {
618         struct smbXsrv_open *op;
619         NTSTATUS status;
620         NTTIME now = 0;
621         struct files_struct *fsp;
622
623         now = timeval_to_nttime(&smb2req->request_time);
624
625         status = smb2srv_open_lookup(smb2req->xconn,
626                                      persistent_id, volatile_id,
627                                      now, &op);
628         if (!NT_STATUS_IS_OK(status)) {
629                 return NULL;
630         }
631
632         fsp = op->compat;
633         if (fsp == NULL) {
634                 return NULL;
635         }
636
637         if (smb2req->tcon == NULL) {
638                 return NULL;
639         }
640
641         if (smb2req->tcon->compat != fsp->conn) {
642                 return NULL;
643         }
644
645         if (smb2req->session == NULL) {
646                 return NULL;
647         }
648
649         if (smb2req->session->compat == NULL) {
650                 return NULL;
651         }
652
653         if (smb2req->session->compat->vuid != fsp->vuid) {
654                 return NULL;
655         }
656
657         if (fsp->deferred_close) {
658                 return NULL;
659         }
660
661         return fsp;
662 }
663
664 struct files_struct *file_fsp_smb2(struct smbd_smb2_request *smb2req,
665                                    uint64_t persistent_id,
666                                    uint64_t volatile_id)
667 {
668         struct files_struct *fsp;
669
670         if (smb2req->compat_chain_fsp != NULL) {
671                 if (smb2req->compat_chain_fsp->deferred_close) {
672                         return NULL;
673                 }
674                 return smb2req->compat_chain_fsp;
675         }
676
677         fsp = file_fsp_get(smb2req, persistent_id, volatile_id);
678         if (fsp == NULL) {
679                 return NULL;
680         }
681
682         smb2req->compat_chain_fsp = fsp;
683         return fsp;
684 }
685
686 /****************************************************************************
687  Duplicate the file handle part for a DOS or FCB open.
688 ****************************************************************************/
689
690 NTSTATUS dup_file_fsp(struct smb_request *req, files_struct *from,
691                       uint32 access_mask, uint32 share_access,
692                       uint32 create_options, files_struct *to)
693 {
694         /* this can never happen for print files */
695         SMB_ASSERT(from->print_file == NULL);
696
697         TALLOC_FREE(to->fh);
698
699         to->fh = from->fh;
700         to->fh->ref_count++;
701
702         to->file_id = from->file_id;
703         to->initial_allocation_size = from->initial_allocation_size;
704         to->file_pid = from->file_pid;
705         to->vuid = from->vuid;
706         to->open_time = from->open_time;
707         to->access_mask = access_mask;
708         to->share_access = share_access;
709         to->oplock_type = from->oplock_type;
710         to->can_lock = from->can_lock;
711         to->can_read = ((access_mask & FILE_READ_DATA) != 0);
712         to->can_write =
713                 CAN_WRITE(from->conn) &&
714                 ((access_mask & (FILE_WRITE_DATA | FILE_APPEND_DATA)) != 0);
715         to->modified = from->modified;
716         to->is_directory = from->is_directory;
717         to->aio_write_behind = from->aio_write_behind;
718
719         return fsp_set_smb_fname(to, from->fsp_name);
720 }
721
722 /**
723  * Return a jenkins hash of a pathname on a connection.
724  */
725
726 NTSTATUS file_name_hash(connection_struct *conn,
727                         const char *name, uint32_t *p_name_hash)
728 {
729         char tmpbuf[PATH_MAX];
730         char *fullpath, *to_free;
731         ssize_t len;
732
733         /* Set the hash of the full pathname. */
734
735         len = full_path_tos(conn->connectpath, name, tmpbuf, sizeof(tmpbuf),
736                             &fullpath, &to_free);
737         if (len == -1) {
738                 return NT_STATUS_NO_MEMORY;
739         }
740         *p_name_hash = hash(fullpath, len+1, 0);
741
742         DEBUG(10,("file_name_hash: %s hash 0x%x\n",
743                   fullpath,
744                 (unsigned int)*p_name_hash ));
745
746         TALLOC_FREE(to_free);
747         return NT_STATUS_OK;
748 }
749
750 /**
751  * The only way that the fsp->fsp_name field should ever be set.
752  */
753 NTSTATUS fsp_set_smb_fname(struct files_struct *fsp,
754                            const struct smb_filename *smb_fname_in)
755 {
756         struct smb_filename *smb_fname_new;
757
758         smb_fname_new = cp_smb_filename(fsp, smb_fname_in);
759         if (smb_fname_new == NULL) {
760                 return NT_STATUS_NO_MEMORY;
761         }
762
763         TALLOC_FREE(fsp->fsp_name);
764         fsp->fsp_name = smb_fname_new;
765
766         return file_name_hash(fsp->conn,
767                         smb_fname_str_dbg(fsp->fsp_name),
768                         &fsp->name_hash);
769 }
770
771 const struct GUID *fsp_client_guid(const files_struct *fsp)
772 {
773         return &fsp->conn->sconn->client->connections->smb2.client.guid;
774 }
775
776 uint32_t fsp_lease_type(struct files_struct *fsp)
777 {
778         if (fsp->oplock_type == LEASE_OPLOCK) {
779                 return fsp->lease->lease.lease_state;
780         }
781         return map_oplock_to_lease_type(fsp->oplock_type);
782 }