source3/smbd/notify.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    change notify handling
   4    Copyright (C) Andrew Tridgell 2000
   5    Copyright (C) Jeremy Allison 1994-1998
   6    Copyright (C) Volker Lendecke 2007
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #include "includes.h"
  23 #include "smbd/globals.h"
  24
  25 struct notify_change_request {
  26         struct notify_change_request *prev, *next;
  27         struct files_struct *fsp;       /* backpointer for cancel by mid */
  28         struct smb_request *req;
  29         uint32 filter;
  30         uint32 max_param;
  31         struct notify_mid_map *mid_map;
  32         void *backend_data;
  33 };
  34
  35 static void notify_fsp(files_struct *fsp, uint32 action, const char *name);
  36
  37 /*
  38  * For NTCancel, we need to find the notify_change_request indexed by
  39  * mid. Separate list here.
  40  */
  41
  42 struct notify_mid_map {
  43         struct notify_mid_map *prev, *next;
  44         struct notify_change_request *req;
  45         uint16 mid;
  46 };
  47
  48 static bool notify_change_record_identical(struct notify_change *c1,
  49                                         struct notify_change *c2)
  50 {
  51         /* Note this is deliberately case sensitive. */
  52         if (c1->action == c2->action &&
  53                         strcmp(c1->name, c2->name) == 0) {
  54                 return True;
  55         }
  56         return False;
  57 }
  58
  59 static bool notify_marshall_changes(int num_changes,
  60                                 uint32 max_offset,
  61                                 struct notify_change *changes,
  62                                 prs_struct *ps)
  63 {
  64         int i;
  65         UNISTR uni_name;
  66
  67         uni_name.buffer = NULL;
  68
  69         for (i=0; i<num_changes; i++) {
  70                 struct notify_change *c;
  71                 size_t namelen;
  72                 uint32 u32_tmp; /* Temp arg to prs_uint32 to avoid
  73                                  * signed/unsigned issues */
  74
  75                 /* Coalesce any identical records. */
  76                 while (i+1 < num_changes &&
  77                         notify_change_record_identical(&changes[i],
  78                                                 &changes[i+1])) {
  79                         i++;
  80                 }
  81
  82                 c = &changes[i];
  83
  84                 if (!convert_string_allocate(NULL, CH_UNIX, CH_UTF16LE,
  85                         c->name, strlen(c->name)+1, &uni_name.buffer,
  86                         &namelen, True) || (uni_name.buffer == NULL)) {
  87                         goto fail;
  88                 }
  89
  90                 namelen -= 2;   /* Dump NULL termination */
  91
  92                 /*
  93                  * Offset to next entry, only if there is one
  94                  */
  95
  96                 u32_tmp = (i == num_changes-1) ? 0 : namelen + 12;
  97                 if (!prs_uint32("offset", ps, 1, &u32_tmp)) goto fail;
  98
  99                 u32_tmp = c->action;
 100                 if (!prs_uint32("action", ps, 1, &u32_tmp)) goto fail;
 101
 102                 u32_tmp = namelen;
 103                 if (!prs_uint32("namelen", ps, 1, &u32_tmp)) goto fail;
 104
 105                 if (!prs_unistr("name", ps, 1, &uni_name)) goto fail;
 106
 107                 /*
 108                  * Not NULL terminated, decrease by the 2 UCS2 \0 chars
 109                  */
 110                 prs_set_offset(ps, prs_offset(ps)-2);
 111
 112                 SAFE_FREE(uni_name.buffer);
 113
 114                 if (prs_offset(ps) > max_offset) {
 115                         /* Too much data for client. */
 116                         DEBUG(10, ("Client only wanted %d bytes, trying to "
 117                                    "marshall %d bytes\n", (int)max_offset,
 118                                    (int)prs_offset(ps)));
 119                         return False;
 120                 }
 121         }
 122
 123         return True;
 124
 125  fail:
 126         SAFE_FREE(uni_name.buffer);
 127         return False;
 128 }
 129
 130 /****************************************************************************
 131  Setup the common parts of the return packet and send it.
 132 *****************************************************************************/
 133
 134 static void change_notify_reply_packet(connection_struct *conn,
 135                                        struct smb_request *req,
 136                                        NTSTATUS error_code)
 137 {
 138         reply_outbuf(req, 18, 0);
 139
 140         if (!NT_STATUS_IS_OK(error_code)) {
 141                 error_packet_set((char *)req->outbuf, 0, 0, error_code,
 142                                  __LINE__,__FILE__);
 143         }
 144
 145         show_msg((char *)req->outbuf);
 146         if (!srv_send_smb(smbd_server_fd(), (char *)req->outbuf,
 147                           req->encrypted, &req->pcd)) {
 148                 exit_server_cleanly("change_notify_reply_packet: srv_send_smb "
 149                                     "failed.");
 150         }
 151         TALLOC_FREE(req->outbuf);
 152 }
 153
 154 void change_notify_reply(connection_struct *conn,
 155                          struct smb_request *req, uint32 max_param,
 156                          struct notify_change_buf *notify_buf)
 157 {
 158         prs_struct ps;
 159
 160         if (notify_buf->num_changes == -1) {
 161                 change_notify_reply_packet(conn, req, NT_STATUS_OK);
 162                 notify_buf->num_changes = 0;
 163                 return;
 164         }
 165
 166         prs_init_empty(&ps, NULL, MARSHALL);
 167
 168         if (!notify_marshall_changes(notify_buf->num_changes, max_param,
 169                                         notify_buf->changes, &ps)) {
 170                 /*
 171                  * We exceed what the client is willing to accept. Send
 172                  * nothing.
 173                  */
 174                 change_notify_reply_packet(conn, req, NT_STATUS_OK);
 175                 goto done;
 176         }
 177
 178         send_nt_replies(conn, req, NT_STATUS_OK, prs_data_p(&ps),
 179                         prs_offset(&ps), NULL, 0);
 180
 181  done:
 182         prs_mem_free(&ps);
 183
 184         TALLOC_FREE(notify_buf->changes);
 185         notify_buf->num_changes = 0;
 186 }
 187
 188 static void notify_callback(void *private_data, const struct notify_event *e)
 189 {
 190         files_struct *fsp = (files_struct *)private_data;
 191         DEBUG(10, ("notify_callback called for %s\n", fsp->fsp_name));
 192         notify_fsp(fsp, e->action, e->path);
 193 }
 194
 195 NTSTATUS change_notify_create(struct files_struct *fsp, uint32 filter,
 196                               bool recursive)
 197 {
 198         char *fullpath;
 199         struct notify_entry e;
 200         NTSTATUS status;
 201
 202         SMB_ASSERT(fsp->notify == NULL);
 203
 204         if (!(fsp->notify = TALLOC_ZERO_P(NULL, struct notify_change_buf))) {
 205                 DEBUG(0, ("talloc failed\n"));
 206                 return NT_STATUS_NO_MEMORY;
 207         }
 208
 209         if (asprintf(&fullpath, "%s/%s", fsp->conn->connectpath,
 210                      fsp->fsp_name) == -1) {
 211                 DEBUG(0, ("asprintf failed\n"));
 212                 TALLOC_FREE(fsp->notify);
 213                 return NT_STATUS_NO_MEMORY;
 214         }
 215
 216         ZERO_STRUCT(e);
 217         e.path = fullpath;
 218         e.dir_fd = fsp->fh->fd;
 219         e.dir_id = fsp->file_id;
 220         e.filter = filter;
 221         e.subdir_filter = 0;
 222         if (recursive) {
 223                 e.subdir_filter = filter;
 224         }
 225
 226         status = notify_add(fsp->conn->notify_ctx, &e, notify_callback, fsp);
 227         SAFE_FREE(fullpath);
 228
 229         return status;
 230 }
 231
 232 NTSTATUS change_notify_add_request(struct smb_request *req,
 233                                 uint32 max_param,
 234                                 uint32 filter, bool recursive,
 235                                 struct files_struct *fsp)
 236 {
 237         struct notify_change_request *request = NULL;
 238         struct notify_mid_map *map = NULL;
 239
 240         DEBUG(10, ("change_notify_add_request: Adding request for %s: "
 241                    "max_param = %d\n", fsp->fsp_name, (int)max_param));
 242
 243         if (!(request = talloc(NULL, struct notify_change_request))
 244             || !(map = talloc(request, struct notify_mid_map))) {
 245                 TALLOC_FREE(request);
 246                 return NT_STATUS_NO_MEMORY;
 247         }
 248
 249         request->mid_map = map;
 250         map->req = request;
 251
 252         request->req = talloc_move(request, &req);
 253         request->max_param = max_param;
 254         request->filter = filter;
 255         request->fsp = fsp;
 256         request->backend_data = NULL;
 257
 258         DLIST_ADD_END(fsp->notify->requests, request,
 259                       struct notify_change_request *);
 260
 261         map->mid = request->req->mid;
 262         DLIST_ADD(notify_changes_by_mid, map);
 263
 264         /* Push the MID of this packet on the signing queue. */
 265         srv_defer_sign_response(request->req->mid);
 266
 267         return NT_STATUS_OK;
 268 }
 269
 270 static void change_notify_remove_request(struct notify_change_request *remove_req)
 271 {
 272         files_struct *fsp;
 273         struct notify_change_request *req;
 274
 275         /*
 276          * Paranoia checks, the fsp referenced must must have the request in
 277          * its list of pending requests
 278          */
 279
 280         fsp = remove_req->fsp;
 281         SMB_ASSERT(fsp->notify != NULL);
 282
 283         for (req = fsp->notify->requests; req; req = req->next) {
 284                 if (req == remove_req) {
 285                         break;
 286                 }
 287         }
 288
 289         if (req == NULL) {
 290                 smb_panic("notify_req not found in fsp's requests");
 291         }
 292
 293         DLIST_REMOVE(fsp->notify->requests, req);
 294         DLIST_REMOVE(notify_changes_by_mid, req->mid_map);
 295         TALLOC_FREE(req);
 296 }
 297
 298 /****************************************************************************
 299  Delete entries by mid from the change notify pending queue. Always send reply.
 300 *****************************************************************************/
 301
 302 void remove_pending_change_notify_requests_by_mid(uint16 mid)
 303 {
 304         struct notify_mid_map *map;
 305
 306         for (map = notify_changes_by_mid; map; map = map->next) {
 307                 if (map->mid == mid) {
 308                         break;
 309                 }
 310         }
 311
 312         if (map == NULL) {
 313                 return;
 314         }
 315
 316         change_notify_reply_packet(map->req->fsp->conn, map->req->req,
 317                                    NT_STATUS_CANCELLED);
 318         change_notify_remove_request(map->req);
 319 }
 320
 321 /****************************************************************************
 322  Delete entries by fnum from the change notify pending queue.
 323 *****************************************************************************/
 324
 325 void remove_pending_change_notify_requests_by_fid(files_struct *fsp,
 326                                                   NTSTATUS status)
 327 {
 328         if (fsp->notify == NULL) {
 329                 return;
 330         }
 331
 332         while (fsp->notify->requests != NULL) {
 333                 change_notify_reply_packet(
 334                         fsp->conn, fsp->notify->requests->req, status);
 335                 change_notify_remove_request(fsp->notify->requests);
 336         }
 337 }
 338
 339 struct notify_fname_state {
 340         struct notify_context *ctx;
 341         uint32_t action;
 342         uint32_t filter;
 343         char *fullpath;
 344
 345         bool do_onelevel;
 346         struct file_id fid;
 347         char *parent;
 348         const char *name;
 349 };
 350
 351 static void notify_fname_callback(struct tevent_context *ev,
 352                                   struct tevent_timer *te,
 353                                   struct timeval now,
 354                                   void *private_data)
 355 {
 356         struct notify_fname_state *state = talloc_get_type_abort(
 357                 private_data, struct notify_fname_state);
 358
 359         DEBUG(10, ("notify_fname_callback called for fullpath=%s, name=%s, "
 360                    "action=%d, filter=%d\n", state->fullpath,
 361                    state->do_onelevel ? state->name : "::no onelevel",
 362                    (int)state->action, (int)state->filter));
 363
 364         if (state->do_onelevel) {
 365                 notify_onelevel(state->ctx, state->action, state->filter,
 366                                 state->fid, state->name);
 367         }
 368         notify_trigger(state->ctx, state->action, state->filter,
 369                        state->fullpath);
 370         TALLOC_FREE(te);
 371 }
 372
 373 void notify_fname(connection_struct *conn, uint32 action, uint32 filter,
 374                   const char *path)
 375 {
 376         struct notify_fname_state *state;
 377         SMB_STRUCT_STAT sbuf;
 378         struct timed_event *te;
 379         const char *name;
 380
 381
 382         state = talloc(talloc_tos(), struct notify_fname_state);
 383         if (state == NULL) {
 384                 return;
 385         }
 386         state->ctx = conn->notify_ctx;
 387         state->action = action;
 388         state->filter = filter;
 389
 390         if (path[0] == '.' && path[1] == '/') {
 391                 path += 2;
 392         }
 393
 394         state->fullpath = talloc_asprintf(state, "%s/%s", conn->connectpath,
 395                                           path);
 396         if (state->fullpath == NULL) {
 397                 TALLOC_FREE(state);
 398                 DEBUG(0, ("talloc_asprintf failed\n"));
 399                 return;
 400         }
 401
 402         if (parent_dirname(state, path, &state->parent, &name)
 403             && (SMB_VFS_STAT(conn, state->parent, &sbuf) != -1)) {
 404                 state->do_onelevel = true;
 405                 state->name = talloc_strdup(state, name);
 406                 if (state->name == NULL) {
 407                         DEBUG(0, ("talloc_strdup failed\n"));
 408                         TALLOC_FREE(state);
 409                         return;
 410                 }
 411                 state->fid = SMB_VFS_FILE_ID_CREATE(conn, &sbuf);
 412         } else {
 413                 state->do_onelevel = false;
 414         }
 415
 416         DEBUG(10, ("notify_fname created for fullpath=%s, name=%s, "
 417                    "action=%d, filter=%d\n", state->fullpath,
 418                    state->do_onelevel ? state->name : "::no onelevel",
 419                    (int)state->action, (int)state->filter));
 420
 421         te = event_add_timed(smbd_event_context(), NULL, timeval_zero(),
 422                              notify_fname_callback, state);
 423         if (te == NULL) {
 424                 DEBUG(10, ("event_add_timed failed\n"));
 425                 TALLOC_FREE(state);
 426                 return;
 427         }
 428         state = talloc_move(te, &state);
 429 }
 430
 431 static void notify_fsp(files_struct *fsp, uint32 action, const char *name)
 432 {
 433         struct notify_change *change, *changes;
 434         char *tmp;
 435
 436         if (fsp->notify == NULL) {
 437                 /*
 438                  * Nobody is waiting, don't queue
 439                  */
 440                 return;
 441         }
 442
 443         /*
 444          * Someone has triggered a notify previously, queue the change for
 445          * later.
 446          */
 447
 448         if ((fsp->notify->num_changes > 1000) || (name == NULL)) {
 449                 /*
 450                  * The real number depends on the client buf, just provide a
 451                  * guard against a DoS here.  If name == NULL the CN backend is
 452                  * alerting us to a problem.  Possibly dropped events.  Clear
 453                  * queued changes and send the catch-all response to the client
 454                  * if a request is pending.
 455                  */
 456                 TALLOC_FREE(fsp->notify->changes);
 457                 fsp->notify->num_changes = -1;
 458                 if (fsp->notify->requests != NULL) {
 459                         change_notify_reply(fsp->conn,
 460                                             fsp->notify->requests->req,
 461                                             fsp->notify->requests->max_param,
 462                                             fsp->notify);
 463                         change_notify_remove_request(fsp->notify->requests);
 464                 }
 465                 return;
 466         }
 467
 468         /* If we've exceeded the server side queue or received a NULL name
 469          * from the underlying CN implementation, don't queue up any more
 470          * requests until we can send a catch-all response to the client */
 471         if (fsp->notify->num_changes == -1) {
 472                 return;
 473         }
 474
 475         if (!(changes = TALLOC_REALLOC_ARRAY(
 476                       fsp->notify, fsp->notify->changes,
 477                       struct notify_change, fsp->notify->num_changes+1))) {
 478                 DEBUG(0, ("talloc_realloc failed\n"));
 479                 return;
 480         }
 481
 482         fsp->notify->changes = changes;
 483
 484         change = &(fsp->notify->changes[fsp->notify->num_changes]);
 485
 486         if (!(tmp = talloc_strdup(changes, name))) {
 487                 DEBUG(0, ("talloc_strdup failed\n"));
 488                 return;
 489         }
 490
 491         string_replace(tmp, '/', '\\');
 492         change->name = tmp;
 493
 494         change->action = action;
 495         fsp->notify->num_changes += 1;
 496
 497         if (fsp->notify->requests == NULL) {
 498                 /*
 499                  * Nobody is waiting, so don't send anything. The ot
 500                  */
 501                 return;
 502         }
 503
 504         if (action == NOTIFY_ACTION_OLD_NAME) {
 505                 /*
 506                  * We have to send the two rename events in one reply. So hold
 507                  * the first part back.
 508                  */
 509                 return;
 510         }
 511
 512         /*
 513          * Someone is waiting for the change, trigger the reply immediately.
 514          *
 515          * TODO: do we have to walk the lists of requests pending?
 516          */
 517
 518         change_notify_reply(fsp->conn,
 519                             fsp->notify->requests->req,
 520                             fsp->notify->requests->max_param,
 521                             fsp->notify);
 522
 523         change_notify_remove_request(fsp->notify->requests);
 524 }
 525
 526 char *notify_filter_string(TALLOC_CTX *mem_ctx, uint32 filter)
 527 {
 528         char *result = NULL;
 529
 530         result = talloc_strdup(mem_ctx, "");
 531
 532         if (filter & FILE_NOTIFY_CHANGE_FILE_NAME)
 533                 result = talloc_asprintf_append(result, "FILE_NAME|");
 534         if (filter & FILE_NOTIFY_CHANGE_DIR_NAME)
 535                 result = talloc_asprintf_append(result, "DIR_NAME|");
 536         if (filter & FILE_NOTIFY_CHANGE_ATTRIBUTES)
 537                 result = talloc_asprintf_append(result, "ATTRIBUTES|");
 538         if (filter & FILE_NOTIFY_CHANGE_SIZE)
 539                 result = talloc_asprintf_append(result, "SIZE|");
 540         if (filter & FILE_NOTIFY_CHANGE_LAST_WRITE)
 541                 result = talloc_asprintf_append(result, "LAST_WRITE|");
 542         if (filter & FILE_NOTIFY_CHANGE_LAST_ACCESS)
 543                 result = talloc_asprintf_append(result, "LAST_ACCESS|");
 544         if (filter & FILE_NOTIFY_CHANGE_CREATION)
 545                 result = talloc_asprintf_append(result, "CREATION|");
 546         if (filter & FILE_NOTIFY_CHANGE_EA)
 547                 result = talloc_asprintf_append(result, "EA|");
 548         if (filter & FILE_NOTIFY_CHANGE_SECURITY)
 549                 result = talloc_asprintf_append(result, "SECURITY|");
 550         if (filter & FILE_NOTIFY_CHANGE_STREAM_NAME)
 551                 result = talloc_asprintf_append(result, "STREAM_NAME|");
 552         if (filter & FILE_NOTIFY_CHANGE_STREAM_SIZE)
 553                 result = talloc_asprintf_append(result, "STREAM_SIZE|");
 554         if (filter & FILE_NOTIFY_CHANGE_STREAM_WRITE)
 555                 result = talloc_asprintf_append(result, "STREAM_WRITE|");
 556
 557         if (result == NULL) return NULL;
 558         if (*result == '\0') return result;
 559
 560         result[strlen(result)-1] = '\0';
 561         return result;
 562 }
 563
 564 struct sys_notify_context *sys_notify_context_create(connection_struct *conn,
 565                                                      TALLOC_CTX *mem_ctx,
 566                                                      struct event_context *ev)
 567 {
 568         struct sys_notify_context *ctx;
 569
 570         if (!(ctx = TALLOC_P(mem_ctx, struct sys_notify_context))) {
 571                 DEBUG(0, ("talloc failed\n"));
 572                 return NULL;
 573         }
 574
 575         ctx->ev = ev;
 576         ctx->conn = conn;
 577         ctx->private_data = NULL;
 578         return ctx;
 579 }
 580
 581 NTSTATUS sys_notify_watch(struct sys_notify_context *ctx,
 582                           struct notify_entry *e,
 583                           void (*callback)(struct sys_notify_context *ctx,
 584                                            void *private_data,
 585                                            struct notify_event *ev),
 586                           void *private_data, void *handle)
 587 {
 588         return SMB_VFS_NOTIFY_WATCH(ctx->conn, ctx, e, callback, private_data,
 589                                     handle);
 590 }
 591