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