s3:smbd: Implementation of SMB2.1 and SMB3.0 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                                 DEBUG(0,("file_find_dif: file %s file_id = "
327                                          "%s, gen = %u oplock_type = %u is a "
328                                          "stat open with oplock type !\n",
329                                          fsp_str_dbg(fsp),
330                                          file_id_string_tos(&fsp->file_id),
331                                          (unsigned int)fsp->fh->gen_id,
332                                          (unsigned int)fsp->oplock_type ));
333                                 smb_panic("file_find_dif");
334                         }
335                         return fsp;
336                 }
337         }
338
339         return NULL;
340 }
341
342 /****************************************************************************
343  Find the first fsp given a device and inode.
344  We use a singleton cache here to speed up searching from getfilepathinfo
345  calls.
346 ****************************************************************************/
347
348 files_struct *file_find_di_first(struct smbd_server_connection *sconn,
349                                  struct file_id id)
350 {
351         files_struct *fsp;
352
353         if (file_id_equal(&sconn->fsp_fi_cache.id, &id)) {
354                 /* Positive or negative cache hit. */
355                 return sconn->fsp_fi_cache.fsp;
356         }
357
358         sconn->fsp_fi_cache.id = id;
359
360         for (fsp=sconn->files;fsp;fsp=fsp->next) {
361                 if (file_id_equal(&fsp->file_id, &id)) {
362                         /* Setup positive cache. */
363                         sconn->fsp_fi_cache.fsp = fsp;
364                         return fsp;
365                 }
366         }
367
368         /* Setup negative cache. */
369         sconn->fsp_fi_cache.fsp = NULL;
370         return NULL;
371 }
372
373 /****************************************************************************
374  Find the next fsp having the same device and inode.
375 ****************************************************************************/
376
377 files_struct *file_find_di_next(files_struct *start_fsp)
378 {
379         files_struct *fsp;
380
381         for (fsp = start_fsp->next;fsp;fsp=fsp->next) {
382                 if (file_id_equal(&fsp->file_id, &start_fsp->file_id)) {
383                         return fsp;
384                 }
385         }
386
387         return NULL;
388 }
389
390 struct files_struct *file_find_one_fsp_from_lease_key(
391         struct smbd_server_connection *sconn,
392         const struct smb2_lease_key *lease_key)
393 {
394         struct files_struct *fsp;
395
396         for (fsp = sconn->files; fsp; fsp=fsp->next) {
397                 if ((fsp->lease != NULL) &&
398                     (fsp->lease->lease.lease_key.data[0] ==
399                      lease_key->data[0]) &&
400                     (fsp->lease->lease.lease_key.data[1] ==
401                      lease_key->data[1])) {
402                         return fsp;
403                 }
404         }
405         return NULL;
406 }
407
408 /****************************************************************************
409  Find any fsp open with a pathname below that of an already open path.
410 ****************************************************************************/
411
412 bool file_find_subpath(files_struct *dir_fsp)
413 {
414         files_struct *fsp;
415         size_t dlen;
416         char *d_fullname = NULL;
417
418         d_fullname = talloc_asprintf(talloc_tos(), "%s/%s",
419                                      dir_fsp->conn->connectpath,
420                                      dir_fsp->fsp_name->base_name);
421
422         if (!d_fullname) {
423                 return false;
424         }
425
426         dlen = strlen(d_fullname);
427
428         for (fsp=dir_fsp->conn->sconn->files; fsp; fsp=fsp->next) {
429                 char *d1_fullname;
430
431                 if (fsp == dir_fsp) {
432                         continue;
433                 }
434
435                 d1_fullname = talloc_asprintf(talloc_tos(),
436                                         "%s/%s",
437                                         fsp->conn->connectpath,
438                                         fsp->fsp_name->base_name);
439
440                 /*
441                  * If the open file has a path that is a longer
442                  * component, then it's a subpath.
443                  */
444                 if (strnequal(d_fullname, d1_fullname, dlen) &&
445                                 (d1_fullname[dlen] == '/')) {
446                         TALLOC_FREE(d1_fullname);
447                         TALLOC_FREE(d_fullname);
448                         return true;
449                 }
450                 TALLOC_FREE(d1_fullname);
451         }
452
453         TALLOC_FREE(d_fullname);
454         return false;
455 }
456
457 /****************************************************************************
458  Sync open files on a connection.
459 ****************************************************************************/
460
461 void file_sync_all(connection_struct *conn)
462 {
463         files_struct *fsp, *next;
464
465         for (fsp=conn->sconn->files; fsp; fsp=next) {
466                 next=fsp->next;
467                 if ((conn == fsp->conn) && (fsp->fh->fd != -1)) {
468                         sync_file(conn, fsp, True /* write through */);
469                 }
470         }
471 }
472
473 /****************************************************************************
474  Free up a fsp.
475 ****************************************************************************/
476
477 void fsp_free(files_struct *fsp)
478 {
479         struct smbd_server_connection *sconn = fsp->conn->sconn;
480
481         DLIST_REMOVE(sconn->files, fsp);
482         SMB_ASSERT(sconn->num_files > 0);
483         sconn->num_files--;
484
485         TALLOC_FREE(fsp->fake_file_handle);
486
487         if (fsp->fh->ref_count == 1) {
488                 TALLOC_FREE(fsp->fh);
489         } else {
490                 fsp->fh->ref_count--;
491         }
492
493         if (fsp->lease != NULL) {
494                 if (fsp->lease->ref_count == 1) {
495                         TALLOC_FREE(fsp->lease);
496                 } else {
497                         fsp->lease->ref_count--;
498                 }
499         }
500
501         fsp->conn->num_files_open--;
502
503         /* this is paranoia, just in case someone tries to reuse the
504            information */
505         ZERO_STRUCTP(fsp);
506
507         /* fsp->fsp_name is a talloc child and is free'd automatically. */
508         TALLOC_FREE(fsp);
509 }
510
511 void file_free(struct smb_request *req, files_struct *fsp)
512 {
513         struct smbd_server_connection *sconn = fsp->conn->sconn;
514         uint64_t fnum = fsp->fnum;
515
516         if (fsp->notify) {
517                 struct notify_context *notify_ctx =
518                         fsp->conn->sconn->notify_ctx;
519                 notify_remove(notify_ctx, fsp);
520                 TALLOC_FREE(fsp->notify);
521         }
522
523         /* Ensure this event will never fire. */
524         TALLOC_FREE(fsp->update_write_time_event);
525
526         if (fsp->op != NULL) {
527                 fsp->op->compat = NULL;
528         }
529         TALLOC_FREE(fsp->op);
530
531         if ((req != NULL) && (fsp == req->chain_fsp)) {
532                 req->chain_fsp = NULL;
533         }
534
535         /*
536          * Clear all possible chained fsp
537          * pointers in the SMB2 request queue.
538          */
539         if (req != NULL && req->smb2req) {
540                 remove_smb2_chained_fsp(fsp);
541         }
542
543         /* Closing a file can invalidate the positive cache. */
544         if (fsp == sconn->fsp_fi_cache.fsp) {
545                 ZERO_STRUCT(sconn->fsp_fi_cache);
546         }
547
548         /* Drop all remaining extensions. */
549         vfs_remove_all_fsp_extensions(fsp);
550
551         fsp_free(fsp);
552
553         DEBUG(5,("freed files structure %llu (%u used)\n",
554                  (unsigned long long)fnum, (unsigned int)sconn->num_files));
555 }
556
557 /****************************************************************************
558  Get an fsp from a packet given a 16 bit fnum.
559 ****************************************************************************/
560
561 files_struct *file_fsp(struct smb_request *req, uint16 fid)
562 {
563         struct smbXsrv_open *op;
564         NTSTATUS status;
565         NTTIME now = 0;
566         files_struct *fsp;
567
568         if (req == NULL) {
569                 /*
570                  * We should never get here. req==NULL could in theory
571                  * only happen from internal opens with a non-zero
572                  * root_dir_fid. Internal opens just don't do that, at
573                  * least they are not supposed to do so. And if they
574                  * start to do so, they better fake up a smb_request
575                  * from which we get the right smbd_server_conn. While
576                  * this should never happen, let's return NULL here.
577                  */
578                 return NULL;
579         }
580
581         if (req->chain_fsp != NULL) {
582                 if (req->chain_fsp->deferred_close) {
583                         return NULL;
584                 }
585                 return req->chain_fsp;
586         }
587
588         if (req->xconn == NULL) {
589                 return NULL;
590         }
591
592         now = timeval_to_nttime(&req->request_time);
593
594         status = smb1srv_open_lookup(req->xconn,
595                                      fid, now, &op);
596         if (!NT_STATUS_IS_OK(status)) {
597                 return NULL;
598         }
599
600         fsp = op->compat;
601         if (fsp == NULL) {
602                 return NULL;
603         }
604
605         if (fsp->deferred_close) {
606                 return NULL;
607         }
608
609         req->chain_fsp = fsp;
610         return fsp;
611 }
612
613 struct files_struct *file_fsp_get(struct smbd_smb2_request *smb2req,
614                                   uint64_t persistent_id,
615                                   uint64_t volatile_id)
616 {
617         struct smbXsrv_open *op;
618         NTSTATUS status;
619         NTTIME now = 0;
620         struct files_struct *fsp;
621
622         now = timeval_to_nttime(&smb2req->request_time);
623
624         status = smb2srv_open_lookup(smb2req->xconn,
625                                      persistent_id, volatile_id,
626                                      now, &op);
627         if (!NT_STATUS_IS_OK(status)) {
628                 return NULL;
629         }
630
631         fsp = op->compat;
632         if (fsp == NULL) {
633                 return NULL;
634         }
635
636         if (smb2req->tcon == NULL) {
637                 return NULL;
638         }
639
640         if (smb2req->tcon->compat != fsp->conn) {
641                 return NULL;
642         }
643
644         if (smb2req->session == NULL) {
645                 return NULL;
646         }
647
648         if (smb2req->session->compat == NULL) {
649                 return NULL;
650         }
651
652         if (smb2req->session->compat->vuid != fsp->vuid) {
653                 return NULL;
654         }
655
656         if (fsp->deferred_close) {
657                 return NULL;
658         }
659
660         return fsp;
661 }
662
663 struct files_struct *file_fsp_smb2(struct smbd_smb2_request *smb2req,
664                                    uint64_t persistent_id,
665                                    uint64_t volatile_id)
666 {
667         struct files_struct *fsp;
668
669         if (smb2req->compat_chain_fsp != NULL) {
670                 if (smb2req->compat_chain_fsp->deferred_close) {
671                         return NULL;
672                 }
673                 return smb2req->compat_chain_fsp;
674         }
675
676         fsp = file_fsp_get(smb2req, persistent_id, volatile_id);
677         if (fsp == NULL) {
678                 return NULL;
679         }
680
681         smb2req->compat_chain_fsp = fsp;
682         return fsp;
683 }
684
685 /****************************************************************************
686  Duplicate the file handle part for a DOS or FCB open.
687 ****************************************************************************/
688
689 NTSTATUS dup_file_fsp(struct smb_request *req, files_struct *from,
690                       uint32 access_mask, uint32 share_access,
691                       uint32 create_options, files_struct *to)
692 {
693         /* this can never happen for print files */
694         SMB_ASSERT(from->print_file == NULL);
695
696         TALLOC_FREE(to->fh);
697
698         to->fh = from->fh;
699         to->fh->ref_count++;
700
701         to->file_id = from->file_id;
702         to->initial_allocation_size = from->initial_allocation_size;
703         to->file_pid = from->file_pid;
704         to->vuid = from->vuid;
705         to->open_time = from->open_time;
706         to->access_mask = access_mask;
707         to->share_access = share_access;
708         to->oplock_type = from->oplock_type;
709         to->can_lock = from->can_lock;
710         to->can_read = ((access_mask & FILE_READ_DATA) != 0);
711         to->can_write =
712                 CAN_WRITE(from->conn) &&
713                 ((access_mask & (FILE_WRITE_DATA | FILE_APPEND_DATA)) != 0);
714         to->modified = from->modified;
715         to->is_directory = from->is_directory;
716         to->aio_write_behind = from->aio_write_behind;
717
718         return fsp_set_smb_fname(to, from->fsp_name);
719 }
720
721 /**
722  * Return a jenkins hash of a pathname on a connection.
723  */
724
725 NTSTATUS file_name_hash(connection_struct *conn,
726                         const char *name, uint32_t *p_name_hash)
727 {
728         char tmpbuf[PATH_MAX];
729         char *fullpath, *to_free;
730         size_t len;
731
732         /* Set the hash of the full pathname. */
733
734         len = full_path_tos(conn->connectpath, name, tmpbuf, sizeof(tmpbuf),
735                             &fullpath, &to_free);
736         if (len == -1) {
737                 return NT_STATUS_NO_MEMORY;
738         }
739         *p_name_hash = hash(fullpath, len+1, 0);
740
741         DEBUG(10,("file_name_hash: %s hash 0x%x\n",
742                   fullpath,
743                 (unsigned int)*p_name_hash ));
744
745         TALLOC_FREE(to_free);
746         return NT_STATUS_OK;
747 }
748
749 /**
750  * The only way that the fsp->fsp_name field should ever be set.
751  */
752 NTSTATUS fsp_set_smb_fname(struct files_struct *fsp,
753                            const struct smb_filename *smb_fname_in)
754 {
755         struct smb_filename *smb_fname_new;
756
757         smb_fname_new = cp_smb_filename(fsp, smb_fname_in);
758         if (smb_fname_new == NULL) {
759                 return NT_STATUS_NO_MEMORY;
760         }
761
762         TALLOC_FREE(fsp->fsp_name);
763         fsp->fsp_name = smb_fname_new;
764
765         return file_name_hash(fsp->conn,
766                         smb_fname_str_dbg(fsp->fsp_name),
767                         &fsp->name_hash);
768 }
769
770 const struct GUID *fsp_client_guid(const files_struct *fsp)
771 {
772         return &fsp->conn->sconn->client->connections->smb2.client.guid;
773 }
774
775 uint32_t fsp_lease_type(struct files_struct *fsp)
776 {
777         if (fsp->oplock_type == LEASE_OPLOCK) {
778                 return fsp->lease->lease.lease_state;
779         }
780         return map_oplock_to_lease_type(fsp->oplock_type);
781 }