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