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