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