source/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
  24 struct notify_change_request {
  25         struct notify_change_request *prev, *next;
  26         struct files_struct *fsp;       /* backpointer for cancel by mid */
  27         char request_buf[smb_size];
  28         uint32 filter;
  29         uint32 max_param;
  30         struct notify_mid_map *mid_map;
  31         void *backend_data;
  32 };
  33
  34 static void notify_fsp(files_struct *fsp, uint32 action, const char *name);
  35
  36 static struct notify_mid_map *notify_changes_by_mid;
  37
  38 /*
  39  * For NTCancel, we need to find the notify_change_request indexed by
  40  * mid. Separate list here.
  41  */
  42
  43 struct notify_mid_map {
  44         struct notify_mid_map *prev, *next;
  45         struct notify_change_request *req;
  46         uint16 mid;
  47 };
  48
  49 static BOOL notify_change_record_identical(struct notify_change *c1,
  50                                         struct notify_change *c2)
  51 {
  52         /* Note this is deliberately case sensitive. */
  53         if (c1->action == c2->action &&
  54                         strcmp(c1->name, c2->name) == 0) {
  55                 return True;
  56         }
  57         return False;
  58 }
  59
  60 static BOOL notify_marshall_changes(int num_changes,
  61                                 uint32 max_offset,
  62                                 struct notify_change *changes,
  63                                 prs_struct *ps)
  64 {
  65         int i;
  66         UNISTR uni_name;
  67
  68         for (i=0; i<num_changes; i++) {
  69                 struct notify_change *c;
  70                 size_t namelen;
  71                 uint32 u32_tmp; /* Temp arg to prs_uint32 to avoid
  72                                  * signed/unsigned issues */
  73
  74                 /* Coalesce any identical records. */
  75                 while (i+1 < num_changes &&
  76                         notify_change_record_identical(&changes[i],
  77                                                 &changes[i+1])) {
  78                         i++;
  79                 }
  80
  81                 c = &changes[i];
  82
  83                 namelen = convert_string_allocate(
  84                         NULL, CH_UNIX, CH_UTF16LE, c->name, strlen(c->name)+1,
  85                         &uni_name.buffer, True);
  86                 if ((namelen == -1) || (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                         return False;
 117                 }
 118         }
 119
 120         return True;
 121
 122  fail:
 123         SAFE_FREE(uni_name.buffer);
 124         return False;
 125 }
 126
 127 /****************************************************************************
 128  Setup the common parts of the return packet and send it.
 129 *****************************************************************************/
 130
 131 static void change_notify_reply_packet(const char *request_buf,
 132                                        NTSTATUS error_code)
 133 {
 134         const char *inbuf = request_buf;
 135         char outbuf[smb_size+38];
 136
 137         memset(outbuf, '\0', sizeof(outbuf));
 138         construct_reply_common(request_buf, outbuf);
 139
 140         ERROR_NT(error_code);
 141
 142         /*
 143          * Seems NT needs a transact command with an error code
 144          * in it. This is a longer packet than a simple error.
 145          */
 146         set_message(inbuf,outbuf,18,0,False);
 147
 148         show_msg(outbuf);
 149         if (!send_smb(smbd_server_fd(),outbuf))
 150                 exit_server_cleanly("change_notify_reply_packet: send_smb "
 151                                     "failed.");
 152 }
 153
 154 void change_notify_reply(const char *request_buf, uint32 max_param,
 155                          struct notify_change_buf *notify_buf)
 156 {
 157         char *outbuf = NULL;
 158         prs_struct ps;
 159         size_t buflen;
 160
 161         if (notify_buf->num_changes == -1) {
 162                 change_notify_reply_packet(request_buf, NT_STATUS_OK);
 163                 return;
 164         }
 165
 166         prs_init(&ps, 0, NULL, False);
 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(request_buf, NT_STATUS_OK);
 175                 goto done;
 176         }
 177
 178         if (!(outbuf = SMB_MALLOC_ARRAY(char, buflen))) {
 179                 change_notify_reply_packet(request_buf, NT_STATUS_NO_MEMORY);
 180                 goto done;
 181         }
 182
 183         construct_reply_common(request_buf, outbuf);
 184
 185         if (send_nt_replies(request_buf, outbuf, buflen, NT_STATUS_OK, prs_data_p(&ps),
 186                             prs_offset(&ps), NULL, 0) == -1) {
 187                 exit_server("change_notify_reply_packet: send_smb failed.");
 188         }
 189
 190  done:
 191         SAFE_FREE(outbuf);
 192         prs_mem_free(&ps);
 193
 194         TALLOC_FREE(notify_buf->changes);
 195         notify_buf->num_changes = 0;
 196 }
 197
 198 static void notify_callback(void *private_data, const struct notify_event *e)
 199 {
 200         files_struct *fsp = (files_struct *)private_data;
 201         DEBUG(10, ("notify_callback called for %s\n", fsp->fsp_name));
 202         notify_fsp(fsp, e->action, e->path);
 203 }
 204
 205 NTSTATUS change_notify_create(struct files_struct *fsp, uint32 filter,
 206                               BOOL recursive)
 207 {
 208         char *fullpath;
 209         struct notify_entry e;
 210         NTSTATUS status;
 211
 212         SMB_ASSERT(fsp->notify == NULL);
 213
 214         if (!(fsp->notify = TALLOC_ZERO_P(NULL, struct notify_change_buf))) {
 215                 DEBUG(0, ("talloc failed\n"));
 216                 return NT_STATUS_NO_MEMORY;
 217         }
 218
 219         if (asprintf(&fullpath, "%s/%s", fsp->conn->connectpath,
 220                      fsp->fsp_name) == -1) {
 221                 DEBUG(0, ("asprintf failed\n"));
 222                 return NT_STATUS_NO_MEMORY;
 223         }
 224
 225         e.path = fullpath;
 226         e.filter = filter;
 227         e.subdir_filter = 0;
 228         if (recursive) {
 229                 e.subdir_filter = filter;
 230         }
 231
 232         status = notify_add(fsp->conn->notify_ctx, &e, notify_callback, fsp);
 233         SAFE_FREE(fullpath);
 234
 235         return status;
 236 }
 237
 238 NTSTATUS change_notify_add_request(const char *inbuf, uint32 max_param,
 239                                    uint32 filter, BOOL recursive,
 240                                    struct files_struct *fsp)
 241 {
 242         struct notify_change_request *request = NULL;
 243         struct notify_mid_map *map = NULL;
 244
 245         if (!(request = SMB_MALLOC_P(struct notify_change_request))
 246             || !(map = SMB_MALLOC_P(struct notify_mid_map))) {
 247                 SAFE_FREE(request);
 248                 return NT_STATUS_NO_MEMORY;
 249         }
 250
 251         request->mid_map = map;
 252         map->req = request;
 253
 254         memcpy(request->request_buf, inbuf, sizeof(request->request_buf));
 255         request->max_param = max_param;
 256         request->filter = filter;
 257         request->fsp = fsp;
 258         request->backend_data = NULL;
 259
 260         DLIST_ADD_END(fsp->notify->requests, request,
 261                       struct notify_change_request *);
 262
 263         map->mid = SVAL(inbuf, smb_mid);
 264         DLIST_ADD(notify_changes_by_mid, map);
 265
 266         /* Push the MID of this packet on the signing queue. */
 267         srv_defer_sign_response(SVAL(inbuf,smb_mid));
 268
 269         return NT_STATUS_OK;
 270 }
 271
 272 static void change_notify_remove_request(struct notify_change_request *remove_req)
 273 {
 274         files_struct *fsp;
 275         struct notify_change_request *req;
 276
 277         /*
 278          * Paranoia checks, the fsp referenced must must have the request in
 279          * its list of pending requests
 280          */
 281
 282         fsp = remove_req->fsp;
 283         SMB_ASSERT(fsp->notify != NULL);
 284
 285         for (req = fsp->notify->requests; req; req = req->next) {
 286                 if (req == remove_req) {
 287                         break;
 288                 }
 289         }
 290
 291         if (req == NULL) {
 292                 smb_panic("notify_req not found in fsp's requests");
 293         }
 294
 295         DLIST_REMOVE(fsp->notify->requests, req);
 296         DLIST_REMOVE(notify_changes_by_mid, req->mid_map);
 297         SAFE_FREE(req->mid_map);
 298         TALLOC_FREE(req->backend_data);
 299         SAFE_FREE(req);
 300 }
 301
 302 /****************************************************************************
 303  Delete entries by mid from the change notify pending queue. Always send reply.
 304 *****************************************************************************/
 305
 306 void remove_pending_change_notify_requests_by_mid(uint16 mid)
 307 {
 308         struct notify_mid_map *map;
 309
 310         for (map = notify_changes_by_mid; map; map = map->next) {
 311                 if (map->mid == mid) {
 312                         break;
 313                 }
 314         }
 315
 316         if (map == NULL) {
 317                 return;
 318         }
 319
 320         change_notify_reply_packet(map->req->request_buf, NT_STATUS_CANCELLED);
 321         change_notify_remove_request(map->req);
 322 }
 323
 324 /****************************************************************************
 325  Delete entries by fnum from the change notify pending queue.
 326 *****************************************************************************/
 327
 328 void remove_pending_change_notify_requests_by_fid(files_struct *fsp,
 329                                                   NTSTATUS status)
 330 {
 331         if (fsp->notify == NULL) {
 332                 return;
 333         }
 334
 335         while (fsp->notify->requests != NULL) {
 336                 change_notify_reply_packet(
 337                         fsp->notify->requests->request_buf, status);
 338                 change_notify_remove_request(fsp->notify->requests);
 339         }
 340 }
 341
 342 void notify_fname(connection_struct *conn, uint32 action, uint32 filter,
 343                   const char *path)
 344 {
 345         char *fullpath;
 346
 347         if (asprintf(&fullpath, "%s/%s", conn->connectpath, path) == -1) {
 348                 DEBUG(0, ("asprintf failed\n"));
 349                 return;
 350         }
 351
 352         notify_trigger(conn->notify_ctx, action, filter, fullpath);
 353         SAFE_FREE(fullpath);
 354 }
 355
 356 static void notify_fsp(files_struct *fsp, uint32 action, const char *name)
 357 {
 358         struct notify_change *change, *changes;
 359         char *tmp;
 360
 361         if (fsp->notify == NULL) {
 362                 /*
 363                  * Nobody is waiting, don't queue
 364                  */
 365                 return;
 366         }
 367
 368         /*
 369          * Someone has triggered a notify previously, queue the change for
 370          * later.
 371          */
 372
 373         if ((fsp->notify->num_changes > 1000) || (name == NULL)) {
 374                 /*
 375                  * The real number depends on the client buf, just provide a
 376                  * guard against a DoS here.
 377                  */
 378                 TALLOC_FREE(fsp->notify->changes);
 379                 fsp->notify->num_changes = -1;
 380                 return;
 381         }
 382
 383         if (fsp->notify->num_changes == -1) {
 384                 return;
 385         }
 386
 387         if (!(changes = TALLOC_REALLOC_ARRAY(
 388                       fsp->notify, fsp->notify->changes,
 389                       struct notify_change, fsp->notify->num_changes+1))) {
 390                 DEBUG(0, ("talloc_realloc failed\n"));
 391                 return;
 392         }
 393
 394         fsp->notify->changes = changes;
 395
 396         change = &(fsp->notify->changes[fsp->notify->num_changes]);
 397
 398         if (!(tmp = talloc_strdup(changes, name))) {
 399                 DEBUG(0, ("talloc_strdup failed\n"));
 400                 return;
 401         }
 402
 403         string_replace(tmp, '/', '\\');
 404         change->name = tmp;
 405
 406         change->action = action;
 407         fsp->notify->num_changes += 1;
 408
 409         if (fsp->notify->requests == NULL) {
 410                 /*
 411                  * Nobody is waiting, so don't send anything. The ot
 412                  */
 413                 return;
 414         }
 415
 416         if (action == NOTIFY_ACTION_OLD_NAME) {
 417                 /*
 418                  * We have to send the two rename events in one reply. So hold
 419                  * the first part back.
 420                  */
 421                 return;
 422         }
 423
 424         /*
 425          * Someone is waiting for the change, trigger the reply immediately.
 426          *
 427          * TODO: do we have to walk the lists of requests pending?
 428          */
 429
 430         change_notify_reply(fsp->notify->requests->request_buf,
 431                             fsp->notify->requests->max_param,
 432                             fsp->notify);
 433
 434         change_notify_remove_request(fsp->notify->requests);
 435 }
 436
 437 char *notify_filter_string(TALLOC_CTX *mem_ctx, uint32 filter)
 438 {
 439         char *result = NULL;
 440
 441         result = talloc_strdup(mem_ctx, "");
 442
 443         if (filter & FILE_NOTIFY_CHANGE_FILE_NAME)
 444                 result = talloc_asprintf_append(result, "FILE_NAME|");
 445         if (filter & FILE_NOTIFY_CHANGE_DIR_NAME)
 446                 result = talloc_asprintf_append(result, "DIR_NAME|");
 447         if (filter & FILE_NOTIFY_CHANGE_ATTRIBUTES)
 448                 result = talloc_asprintf_append(result, "ATTRIBUTES|");
 449         if (filter & FILE_NOTIFY_CHANGE_SIZE)
 450                 result = talloc_asprintf_append(result, "SIZE|");
 451         if (filter & FILE_NOTIFY_CHANGE_LAST_WRITE)
 452                 result = talloc_asprintf_append(result, "LAST_WRITE|");
 453         if (filter & FILE_NOTIFY_CHANGE_LAST_ACCESS)
 454                 result = talloc_asprintf_append(result, "LAST_ACCESS|");
 455         if (filter & FILE_NOTIFY_CHANGE_CREATION)
 456                 result = talloc_asprintf_append(result, "CREATION|");
 457         if (filter & FILE_NOTIFY_CHANGE_EA)
 458                 result = talloc_asprintf_append(result, "EA|");
 459         if (filter & FILE_NOTIFY_CHANGE_SECURITY)
 460                 result = talloc_asprintf_append(result, "SECURITY|");
 461         if (filter & FILE_NOTIFY_CHANGE_STREAM_NAME)
 462                 result = talloc_asprintf_append(result, "STREAM_NAME|");
 463         if (filter & FILE_NOTIFY_CHANGE_STREAM_SIZE)
 464                 result = talloc_asprintf_append(result, "STREAM_SIZE|");
 465         if (filter & FILE_NOTIFY_CHANGE_STREAM_WRITE)
 466                 result = talloc_asprintf_append(result, "STREAM_WRITE|");
 467
 468         if (result == NULL) return NULL;
 469         if (*result == '\0') return result;
 470
 471         result[strlen(result)-1] = '\0';
 472         return result;
 473 }
 474
 475 struct sys_notify_context *sys_notify_context_create(connection_struct *conn,
 476                                                      TALLOC_CTX *mem_ctx,
 477                                                      struct event_context *ev)
 478 {
 479         struct sys_notify_context *ctx;
 480
 481         if (!(ctx = TALLOC_P(mem_ctx, struct sys_notify_context))) {
 482                 DEBUG(0, ("talloc failed\n"));
 483                 return NULL;
 484         }
 485
 486         ctx->ev = ev;
 487         ctx->conn = conn;
 488         ctx->private_data = NULL;
 489         return ctx;
 490 }
 491
 492 NTSTATUS sys_notify_watch(struct sys_notify_context *ctx,
 493                           struct notify_entry *e,
 494                           void (*callback)(struct sys_notify_context *ctx,
 495                                            void *private_data,
 496                                            struct notify_event *ev),
 497                           void *private_data, void *handle)
 498 {
 499         return SMB_VFS_NOTIFY_WATCH(ctx->conn, ctx, e, callback, private_data,
 500                                     handle);
 501 }
 502