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
  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, 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(request_buf, NT_STATUS_OK);
 175                 goto done;
 176         }
 177
 178         buflen = smb_size+38+prs_offset(&ps) + 4 /* padding */;
 179
 180         if (!(outbuf = SMB_MALLOC_ARRAY(char, buflen))) {
 181                 change_notify_reply_packet(request_buf, NT_STATUS_NO_MEMORY);
 182                 goto done;
 183         }
 184
 185         construct_reply_common(request_buf, outbuf);
 186
 187         if (send_nt_replies(request_buf, outbuf, buflen, NT_STATUS_OK, prs_data_p(&ps),
 188                             prs_offset(&ps), NULL, 0) == -1) {
 189                 exit_server("change_notify_reply_packet: send_smb failed.");
 190         }
 191
 192  done:
 193         SAFE_FREE(outbuf);
 194         prs_mem_free(&ps);
 195
 196         TALLOC_FREE(notify_buf->changes);
 197         notify_buf->num_changes = 0;
 198 }
 199
 200 static void notify_callback(void *private_data, const struct notify_event *e)
 201 {
 202         files_struct *fsp = (files_struct *)private_data;
 203         DEBUG(10, ("notify_callback called for %s\n", fsp->fsp_name));
 204         notify_fsp(fsp, e->action, e->path);
 205 }
 206
 207 NTSTATUS change_notify_create(struct files_struct *fsp, uint32 filter,
 208                               BOOL recursive)
 209 {
 210         char *fullpath;
 211         struct notify_entry e;
 212         NTSTATUS status;
 213
 214         SMB_ASSERT(fsp->notify == NULL);
 215
 216         if (!(fsp->notify = TALLOC_ZERO_P(NULL, struct notify_change_buf))) {
 217                 DEBUG(0, ("talloc failed\n"));
 218                 return NT_STATUS_NO_MEMORY;
 219         }
 220
 221         if (asprintf(&fullpath, "%s/%s", fsp->conn->connectpath,
 222                      fsp->fsp_name) == -1) {
 223                 DEBUG(0, ("asprintf failed\n"));
 224                 return NT_STATUS_NO_MEMORY;
 225         }
 226
 227         e.path = fullpath;
 228         e.filter = filter;
 229         e.subdir_filter = 0;
 230         if (recursive) {
 231                 e.subdir_filter = filter;
 232         }
 233
 234         status = notify_add(fsp->conn->notify_ctx, &e, notify_callback, fsp);
 235         SAFE_FREE(fullpath);
 236
 237         return status;
 238 }
 239
 240 NTSTATUS change_notify_add_request(const char *inbuf, uint32 max_param,
 241                                    uint32 filter, BOOL recursive,
 242                                    struct files_struct *fsp)
 243 {
 244         struct notify_change_request *request = NULL;
 245         struct notify_mid_map *map = NULL;
 246
 247         if (!(request = SMB_MALLOC_P(struct notify_change_request))
 248             || !(map = SMB_MALLOC_P(struct notify_mid_map))) {
 249                 SAFE_FREE(request);
 250                 return NT_STATUS_NO_MEMORY;
 251         }
 252
 253         request->mid_map = map;
 254         map->req = request;
 255
 256         memcpy(request->request_buf, inbuf, sizeof(request->request_buf));
 257         request->max_param = max_param;
 258         request->filter = filter;
 259         request->fsp = fsp;
 260         request->backend_data = NULL;
 261
 262         DLIST_ADD_END(fsp->notify->requests, request,
 263                       struct notify_change_request *);
 264
 265         map->mid = SVAL(inbuf, smb_mid);
 266         DLIST_ADD(notify_changes_by_mid, map);
 267
 268         /* Push the MID of this packet on the signing queue. */
 269         srv_defer_sign_response(SVAL(inbuf,smb_mid));
 270
 271         return NT_STATUS_OK;
 272 }
 273
 274 static void change_notify_remove_request(struct notify_change_request *remove_req)
 275 {
 276         files_struct *fsp;
 277         struct notify_change_request *req;
 278
 279         /*
 280          * Paranoia checks, the fsp referenced must must have the request in
 281          * its list of pending requests
 282          */
 283
 284         fsp = remove_req->fsp;
 285         SMB_ASSERT(fsp->notify != NULL);
 286
 287         for (req = fsp->notify->requests; req; req = req->next) {
 288                 if (req == remove_req) {
 289                         break;
 290                 }
 291         }
 292
 293         if (req == NULL) {
 294                 smb_panic("notify_req not found in fsp's requests");
 295         }
 296
 297         DLIST_REMOVE(fsp->notify->requests, req);
 298         DLIST_REMOVE(notify_changes_by_mid, req->mid_map);
 299         SAFE_FREE(req->mid_map);
 300         TALLOC_FREE(req->backend_data);
 301         SAFE_FREE(req);
 302 }
 303
 304 /****************************************************************************
 305  Delete entries by mid from the change notify pending queue. Always send reply.
 306 *****************************************************************************/
 307
 308 void remove_pending_change_notify_requests_by_mid(uint16 mid)
 309 {
 310         struct notify_mid_map *map;
 311
 312         for (map = notify_changes_by_mid; map; map = map->next) {
 313                 if (map->mid == mid) {
 314                         break;
 315                 }
 316         }
 317
 318         if (map == NULL) {
 319                 return;
 320         }
 321
 322         change_notify_reply_packet(map->req->request_buf, NT_STATUS_CANCELLED);
 323         change_notify_remove_request(map->req);
 324 }
 325
 326 /****************************************************************************
 327  Delete entries by fnum from the change notify pending queue.
 328 *****************************************************************************/
 329
 330 void remove_pending_change_notify_requests_by_fid(files_struct *fsp,
 331                                                   NTSTATUS status)
 332 {
 333         if (fsp->notify == NULL) {
 334                 return;
 335         }
 336
 337         while (fsp->notify->requests != NULL) {
 338                 change_notify_reply_packet(
 339                         fsp->notify->requests->request_buf, status);
 340                 change_notify_remove_request(fsp->notify->requests);
 341         }
 342 }
 343
 344 void notify_fname(connection_struct *conn, uint32 action, uint32 filter,
 345                   const char *path)
 346 {
 347         char *fullpath;
 348
 349         if (asprintf(&fullpath, "%s/%s", conn->connectpath, path) == -1) {
 350                 DEBUG(0, ("asprintf failed\n"));
 351                 return;
 352         }
 353
 354         notify_trigger(conn->notify_ctx, action, filter, fullpath);
 355         SAFE_FREE(fullpath);
 356 }
 357
 358 static void notify_fsp(files_struct *fsp, uint32 action, const char *name)
 359 {
 360         struct notify_change *change, *changes;
 361         char *tmp;
 362
 363         if (fsp->notify == NULL) {
 364                 /*
 365                  * Nobody is waiting, don't queue
 366                  */
 367                 return;
 368         }
 369
 370         /*
 371          * Someone has triggered a notify previously, queue the change for
 372          * later.
 373          */
 374
 375         if ((fsp->notify->num_changes > 1000) || (name == NULL)) {
 376                 /*
 377                  * The real number depends on the client buf, just provide a
 378                  * guard against a DoS here.
 379                  */
 380                 TALLOC_FREE(fsp->notify->changes);
 381                 fsp->notify->num_changes = -1;
 382                 return;
 383         }
 384
 385         if (fsp->notify->num_changes == -1) {
 386                 return;
 387         }
 388
 389         if (!(changes = TALLOC_REALLOC_ARRAY(
 390                       fsp->notify, fsp->notify->changes,
 391                       struct notify_change, fsp->notify->num_changes+1))) {
 392                 DEBUG(0, ("talloc_realloc failed\n"));
 393                 return;
 394         }
 395
 396         fsp->notify->changes = changes;
 397
 398         change = &(fsp->notify->changes[fsp->notify->num_changes]);
 399
 400         if (!(tmp = talloc_strdup(changes, name))) {
 401                 DEBUG(0, ("talloc_strdup failed\n"));
 402                 return;
 403         }
 404
 405         string_replace(tmp, '/', '\\');
 406         change->name = tmp;
 407
 408         change->action = action;
 409         fsp->notify->num_changes += 1;
 410
 411         if (fsp->notify->requests == NULL) {
 412                 /*
 413                  * Nobody is waiting, so don't send anything. The ot
 414                  */
 415                 return;
 416         }
 417
 418         if (action == NOTIFY_ACTION_OLD_NAME) {
 419                 /*
 420                  * We have to send the two rename events in one reply. So hold
 421                  * the first part back.
 422                  */
 423                 return;
 424         }
 425
 426         /*
 427          * Someone is waiting for the change, trigger the reply immediately.
 428          *
 429          * TODO: do we have to walk the lists of requests pending?
 430          */
 431
 432         change_notify_reply(fsp->notify->requests->request_buf,
 433                             fsp->notify->requests->max_param,
 434                             fsp->notify);
 435
 436         change_notify_remove_request(fsp->notify->requests);
 437 }
 438
 439 char *notify_filter_string(TALLOC_CTX *mem_ctx, uint32 filter)
 440 {
 441         char *result = NULL;
 442
 443         result = talloc_strdup(mem_ctx, "");
 444
 445         if (filter & FILE_NOTIFY_CHANGE_FILE_NAME)
 446                 result = talloc_asprintf_append(result, "FILE_NAME|");
 447         if (filter & FILE_NOTIFY_CHANGE_DIR_NAME)
 448                 result = talloc_asprintf_append(result, "DIR_NAME|");
 449         if (filter & FILE_NOTIFY_CHANGE_ATTRIBUTES)
 450                 result = talloc_asprintf_append(result, "ATTRIBUTES|");
 451         if (filter & FILE_NOTIFY_CHANGE_SIZE)
 452                 result = talloc_asprintf_append(result, "SIZE|");
 453         if (filter & FILE_NOTIFY_CHANGE_LAST_WRITE)
 454                 result = talloc_asprintf_append(result, "LAST_WRITE|");
 455         if (filter & FILE_NOTIFY_CHANGE_LAST_ACCESS)
 456                 result = talloc_asprintf_append(result, "LAST_ACCESS|");
 457         if (filter & FILE_NOTIFY_CHANGE_CREATION)
 458                 result = talloc_asprintf_append(result, "CREATION|");
 459         if (filter & FILE_NOTIFY_CHANGE_EA)
 460                 result = talloc_asprintf_append(result, "EA|");
 461         if (filter & FILE_NOTIFY_CHANGE_SECURITY)
 462                 result = talloc_asprintf_append(result, "SECURITY|");
 463         if (filter & FILE_NOTIFY_CHANGE_STREAM_NAME)
 464                 result = talloc_asprintf_append(result, "STREAM_NAME|");
 465         if (filter & FILE_NOTIFY_CHANGE_STREAM_SIZE)
 466                 result = talloc_asprintf_append(result, "STREAM_SIZE|");
 467         if (filter & FILE_NOTIFY_CHANGE_STREAM_WRITE)
 468                 result = talloc_asprintf_append(result, "STREAM_WRITE|");
 469
 470         if (result == NULL) return NULL;
 471         if (*result == '\0') return result;
 472
 473         result[strlen(result)-1] = '\0';
 474         return result;
 475 }
 476
 477 struct sys_notify_context *sys_notify_context_create(connection_struct *conn,
 478                                                      TALLOC_CTX *mem_ctx,
 479                                                      struct event_context *ev)
 480 {
 481         struct sys_notify_context *ctx;
 482
 483         if (!(ctx = TALLOC_P(mem_ctx, struct sys_notify_context))) {
 484                 DEBUG(0, ("talloc failed\n"));
 485                 return NULL;
 486         }
 487
 488         ctx->ev = ev;
 489         ctx->conn = conn;
 490         ctx->private_data = NULL;
 491         return ctx;
 492 }
 493
 494 NTSTATUS sys_notify_watch(struct sys_notify_context *ctx,
 495                           struct notify_entry *e,
 496                           void (*callback)(struct sys_notify_context *ctx,
 497                                            void *private_data,
 498                                            struct notify_event *ev),
 499                           void *private_data, void *handle)
 500 {
 501         return SMB_VFS_NOTIFY_WATCH(ctx->conn, ctx, e, callback, private_data,
 502                                     handle);
 503 }
 504