2 Unix SMB/CIFS implementation.
4 Copyright (C) Andrew Tridgell 2000
5 Copyright (C) Jeremy Allison 1994-1998
6 Copyright (C) Volker Lendecke 2007
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.
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.
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/>.
23 #include "smbd/smbd.h"
24 #include "smbd/globals.h"
25 #include "../librpc/gen_ndr/ndr_notify.h"
26 #include "librpc/gen_ndr/ndr_file_id.h"
28 struct notify_change_event {
34 struct notify_change_buf {
36 * Filters for reinitializing after notifyd has been restarted
39 uint32_t subdir_filter;
42 * If no requests are pending, changes are queued here. Simple array,
47 * num_changes == -1 means that we have got a catch-all change, when
48 * asked we just return NT_STATUS_OK without specific changes.
51 struct notify_change_event *changes;
54 * If no changes are around requests are queued here. Using a linked
55 * list, because we have to append at the end and delete from the top.
57 struct notify_change_request *requests;
60 struct notify_change_request {
61 struct notify_change_request *prev, *next;
62 struct files_struct *fsp; /* backpointer for cancel by mid */
63 struct smb_request *req;
66 void (*reply_fn)(struct smb_request *req,
68 uint8_t *buf, size_t len);
69 struct notify_mid_map *mid_map;
73 static void notify_fsp(files_struct *fsp, struct timespec when,
74 uint32_t action, const char *name);
76 bool change_notify_fsp_has_changes(struct files_struct *fsp)
82 if (fsp->notify == NULL) {
86 if (fsp->notify->num_changes == 0) {
94 * For NTCancel, we need to find the notify_change_request indexed by
95 * mid. Separate list here.
98 struct notify_mid_map {
99 struct notify_mid_map *prev, *next;
100 struct notify_change_request *req;
104 static bool notify_change_record_identical(struct notify_change_event *c1,
105 struct notify_change_event *c2)
107 /* Note this is deliberately case sensitive. */
108 if (c1->action == c2->action &&
109 strcmp(c1->name, c2->name) == 0) {
115 static int compare_notify_change_events(const void *p1, const void *p2)
117 const struct notify_change_event *e1 = p1;
118 const struct notify_change_event *e2 = p2;
120 return timespec_compare(&e1->when, &e2->when);
123 static bool notify_marshall_changes(int num_changes,
125 struct notify_change_event *changes,
126 DATA_BLOB *final_blob)
130 if (num_changes == -1) {
135 * Sort the notifies by timestamp when the event happened to avoid
136 * coalescing and thus dropping events.
139 qsort(changes, num_changes,
140 sizeof(*changes), compare_notify_change_events);
142 for (i=0; i<num_changes; i++) {
143 enum ndr_err_code ndr_err;
144 struct notify_change_event *c;
145 struct FILE_NOTIFY_INFORMATION m;
149 /* Coalesce any identical records. */
150 while (i+1 < num_changes &&
151 notify_change_record_identical(&changes[i],
158 m.FileName1 = c->name;
159 m.FileNameLength = strlen_m(c->name)*2;
160 m.Action = c->action;
162 m._pad = data_blob_null;
165 * Offset to next entry, only if there is one
168 if (i == (num_changes-1)) {
169 m.NextEntryOffset = 0;
171 if ((m.FileNameLength % 4) == 2) {
172 m._pad = data_blob_const(&pad, 2);
175 ndr_size_FILE_NOTIFY_INFORMATION(&m, 0);
178 ndr_err = ndr_push_struct_blob(&blob, talloc_tos(), &m,
179 (ndr_push_flags_fn_t)ndr_push_FILE_NOTIFY_INFORMATION);
180 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
184 if (DEBUGLEVEL >= 10) {
185 NDR_PRINT_DEBUG(FILE_NOTIFY_INFORMATION, &m);
188 if (!data_blob_append(talloc_tos(), final_blob,
189 blob.data, blob.length)) {
190 data_blob_free(&blob);
194 data_blob_free(&blob);
196 if (final_blob->length > max_offset) {
197 /* Too much data for client. */
198 DEBUG(10, ("Client only wanted %d bytes, trying to "
199 "marshall %d bytes\n", (int)max_offset,
200 (int)final_blob->length));
208 /****************************************************************************
209 Setup the common parts of the return packet and send it.
210 *****************************************************************************/
212 void change_notify_reply(struct smb_request *req,
215 struct notify_change_buf *notify_buf,
216 void (*reply_fn)(struct smb_request *req,
218 uint8_t *buf, size_t len))
220 DATA_BLOB blob = data_blob_null;
222 if (!NT_STATUS_IS_OK(error_code)) {
223 reply_fn(req, error_code, NULL, 0);
227 if (max_param == 0 || notify_buf == NULL) {
228 reply_fn(req, NT_STATUS_OK, NULL, 0);
232 if (!notify_marshall_changes(notify_buf->num_changes, max_param,
233 notify_buf->changes, &blob)) {
235 * We exceed what the client is willing to accept. Send
238 data_blob_free(&blob);
241 reply_fn(req, NT_STATUS_OK, blob.data, blob.length);
243 data_blob_free(&blob);
245 TALLOC_FREE(notify_buf->changes);
246 notify_buf->num_changes = 0;
249 struct notify_fsp_state {
250 struct files_struct *notified_fsp;
251 struct timespec when;
252 const struct notify_event *e;
255 static struct files_struct *notify_fsp_cb(struct files_struct *fsp,
258 struct notify_fsp_state *state = private_data;
260 if (fsp == state->notified_fsp) {
261 DBG_DEBUG("notify_callback called for %s\n", fsp_str_dbg(fsp));
262 notify_fsp(fsp, state->when, state->e->action, state->e->path);
269 void notify_callback(struct smbd_server_connection *sconn,
270 void *private_data, struct timespec when,
271 const struct notify_event *e)
273 struct notify_fsp_state state = {
274 .notified_fsp = private_data, .when = when, .e = e
276 files_forall(sconn, notify_fsp_cb, &state);
279 NTSTATUS change_notify_create(struct files_struct *fsp, uint32_t filter,
282 size_t len = fsp_fullbasepath(fsp, NULL, 0);
283 char fullpath[len+1];
284 NTSTATUS status = NT_STATUS_NOT_IMPLEMENTED;
286 if (fsp->notify != NULL) {
287 DEBUG(1, ("change_notify_create: fsp->notify != NULL, "
288 "fname = %s\n", fsp->fsp_name->base_name));
289 return NT_STATUS_INVALID_PARAMETER;
292 if (!(fsp->notify = talloc_zero(NULL, struct notify_change_buf))) {
293 DEBUG(0, ("talloc failed\n"));
294 return NT_STATUS_NO_MEMORY;
296 fsp->notify->filter = filter;
297 fsp->notify->subdir_filter = recursive ? filter : 0;
299 fsp_fullbasepath(fsp, fullpath, sizeof(fullpath));
302 * Avoid /. at the end of the path name. notify can't deal with it.
304 if (len > 1 && fullpath[len-1] == '.' && fullpath[len-2] == '/') {
305 fullpath[len-2] = '\0';
308 if ((fsp->notify->filter != 0) ||
309 (fsp->notify->subdir_filter != 0)) {
310 status = notify_add(fsp->conn->sconn->notify_ctx,
311 fullpath, fsp->notify->filter,
312 fsp->notify->subdir_filter, fsp);
318 NTSTATUS change_notify_add_request(struct smb_request *req,
320 uint32_t filter, bool recursive,
321 struct files_struct *fsp,
322 void (*reply_fn)(struct smb_request *req,
324 uint8_t *buf, size_t len))
326 struct notify_change_request *request = NULL;
327 struct notify_mid_map *map = NULL;
328 struct smbd_server_connection *sconn = req->sconn;
330 DEBUG(10, ("change_notify_add_request: Adding request for %s: "
331 "max_param = %d\n", fsp_str_dbg(fsp), (int)max_param));
333 if (!(request = talloc(NULL, struct notify_change_request))
334 || !(map = talloc(request, struct notify_mid_map))) {
335 TALLOC_FREE(request);
336 return NT_STATUS_NO_MEMORY;
339 request->mid_map = map;
342 request->req = talloc_move(request, &req);
343 request->max_param = max_param;
344 request->filter = filter;
346 request->reply_fn = reply_fn;
347 request->backend_data = NULL;
349 DLIST_ADD_END(fsp->notify->requests, request);
351 map->mid = request->req->mid;
352 DLIST_ADD(sconn->smb1.notify_mid_maps, map);
357 static void change_notify_remove_request(struct smbd_server_connection *sconn,
358 struct notify_change_request *remove_req)
361 struct notify_change_request *req;
364 * Paranoia checks, the fsp referenced must must have the request in
365 * its list of pending requests
368 fsp = remove_req->fsp;
369 SMB_ASSERT(fsp->notify != NULL);
371 for (req = fsp->notify->requests; req; req = req->next) {
372 if (req == remove_req) {
378 smb_panic("notify_req not found in fsp's requests");
381 DLIST_REMOVE(fsp->notify->requests, req);
382 DLIST_REMOVE(sconn->smb1.notify_mid_maps, req->mid_map);
386 static void smbd_notify_cancel_by_map(struct notify_mid_map *map)
388 struct smb_request *smbreq = map->req->req;
389 struct smbd_server_connection *sconn = smbreq->sconn;
390 struct smbd_smb2_request *smb2req = smbreq->smb2req;
391 NTSTATUS notify_status = NT_STATUS_CANCELLED;
393 if (smb2req != NULL) {
396 if (smb2req->session == NULL) {
397 sstatus = NT_STATUS_USER_SESSION_DELETED;
399 sstatus = smb2req->session->status;
402 if (NT_STATUS_EQUAL(sstatus, NT_STATUS_NETWORK_SESSION_EXPIRED)) {
403 sstatus = NT_STATUS_OK;
406 if (!NT_STATUS_IS_OK(sstatus)) {
407 notify_status = STATUS_NOTIFY_CLEANUP;
408 } else if (smb2req->tcon == NULL) {
409 notify_status = STATUS_NOTIFY_CLEANUP;
410 } else if (!NT_STATUS_IS_OK(smb2req->tcon->status)) {
411 notify_status = STATUS_NOTIFY_CLEANUP;
415 change_notify_reply(smbreq, notify_status,
416 0, NULL, map->req->reply_fn);
417 change_notify_remove_request(sconn, map->req);
420 /****************************************************************************
421 Delete entries by mid from the change notify pending queue. Always send reply.
422 *****************************************************************************/
424 void remove_pending_change_notify_requests_by_mid(
425 struct smbd_server_connection *sconn, uint64_t mid)
427 struct notify_mid_map *map;
429 for (map = sconn->smb1.notify_mid_maps; map; map = map->next) {
430 if (map->mid == mid) {
439 smbd_notify_cancel_by_map(map);
442 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq)
444 struct smbd_server_connection *sconn = smbreq->sconn;
445 struct notify_mid_map *map;
447 for (map = sconn->smb1.notify_mid_maps; map; map = map->next) {
448 if (map->req->req == smbreq) {
457 smbd_notify_cancel_by_map(map);
460 static struct files_struct *smbd_notify_cancel_deleted_fn(
461 struct files_struct *fsp, void *private_data)
463 struct file_id *fid = talloc_get_type_abort(
464 private_data, struct file_id);
466 if (file_id_equal(&fsp->file_id, fid)) {
467 remove_pending_change_notify_requests_by_fid(
468 fsp, NT_STATUS_DELETE_PENDING);
473 void smbd_notify_cancel_deleted(struct messaging_context *msg,
474 void *private_data, uint32_t msg_type,
475 struct server_id server_id, DATA_BLOB *data)
477 struct smbd_server_connection *sconn = talloc_get_type_abort(
478 private_data, struct smbd_server_connection);
480 enum ndr_err_code ndr_err;
482 fid = talloc(talloc_tos(), struct file_id);
484 DEBUG(1, ("talloc failed\n"));
488 ndr_err = ndr_pull_struct_blob_all(
489 data, fid, fid, (ndr_pull_flags_fn_t)ndr_pull_file_id);
490 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
491 DEBUG(10, ("%s: ndr_pull_file_id failed: %s\n", __func__,
492 ndr_errstr(ndr_err)));
496 files_forall(sconn, smbd_notify_cancel_deleted_fn, fid);
502 static struct files_struct *smbd_notifyd_reregister(struct files_struct *fsp,
505 DBG_DEBUG("reregister %s\n", fsp->fsp_name->base_name);
507 if ((fsp->conn->sconn->notify_ctx != NULL) &&
508 (fsp->notify != NULL) &&
509 ((fsp->notify->filter != 0) ||
510 (fsp->notify->subdir_filter != 0))) {
511 size_t len = fsp_fullbasepath(fsp, NULL, 0);
512 char fullpath[len+1];
516 fsp_fullbasepath(fsp, fullpath, sizeof(fullpath));
517 if (len > 1 && fullpath[len-1] == '.' &&
518 fullpath[len-2] == '/') {
519 fullpath[len-2] = '\0';
522 status = notify_add(fsp->conn->sconn->notify_ctx,
523 fullpath, fsp->notify->filter,
524 fsp->notify->subdir_filter, fsp);
525 if (!NT_STATUS_IS_OK(status)) {
526 DBG_DEBUG("notify_add failed: %s\n",
533 void smbd_notifyd_restarted(struct messaging_context *msg,
534 void *private_data, uint32_t msg_type,
535 struct server_id server_id, DATA_BLOB *data)
537 struct smbd_server_connection *sconn = talloc_get_type_abort(
538 private_data, struct smbd_server_connection);
540 TALLOC_FREE(sconn->notify_ctx);
542 sconn->notify_ctx = notify_init(sconn, sconn->msg_ctx,
543 sconn, notify_callback);
544 if (sconn->notify_ctx == NULL) {
545 DBG_DEBUG("notify_init failed\n");
549 files_forall(sconn, smbd_notifyd_reregister, sconn->notify_ctx);
552 /****************************************************************************
553 Delete entries by fnum from the change notify pending queue.
554 *****************************************************************************/
556 void remove_pending_change_notify_requests_by_fid(files_struct *fsp,
559 if (fsp->notify == NULL) {
563 while (fsp->notify->requests != NULL) {
564 change_notify_reply(fsp->notify->requests->req,
566 fsp->notify->requests->reply_fn);
567 change_notify_remove_request(fsp->conn->sconn,
568 fsp->notify->requests);
572 void notify_fname(connection_struct *conn, uint32_t action, uint32_t filter,
575 struct notify_context *notify_ctx = conn->sconn->notify_ctx;
577 if (path[0] == '.' && path[1] == '/') {
581 notify_trigger(notify_ctx, action, filter, conn->connectpath, path);
584 static void notify_fsp(files_struct *fsp, struct timespec when,
585 uint32_t action, const char *name)
587 struct notify_change_event *change, *changes;
590 if (fsp->notify == NULL) {
592 * Nobody is waiting, don't queue
598 * Someone has triggered a notify previously, queue the change for
602 if ((fsp->notify->num_changes > 1000) || (name == NULL)) {
604 * The real number depends on the client buf, just provide a
605 * guard against a DoS here. If name == NULL the CN backend is
606 * alerting us to a problem. Possibly dropped events. Clear
607 * queued changes and send the catch-all response to the client
608 * if a request is pending.
610 TALLOC_FREE(fsp->notify->changes);
611 fsp->notify->num_changes = -1;
612 if (fsp->notify->requests != NULL) {
613 change_notify_reply(fsp->notify->requests->req,
615 fsp->notify->requests->max_param,
617 fsp->notify->requests->reply_fn);
618 change_notify_remove_request(fsp->conn->sconn,
619 fsp->notify->requests);
624 /* If we've exceeded the server side queue or received a NULL name
625 * from the underlying CN implementation, don't queue up any more
626 * requests until we can send a catch-all response to the client */
627 if (fsp->notify->num_changes == -1) {
631 if (!(changes = talloc_realloc(
632 fsp->notify, fsp->notify->changes,
633 struct notify_change_event,
634 fsp->notify->num_changes+1))) {
635 DEBUG(0, ("talloc_realloc failed\n"));
639 fsp->notify->changes = changes;
641 change = &(fsp->notify->changes[fsp->notify->num_changes]);
643 if (!(tmp = talloc_strdup(changes, name))) {
644 DEBUG(0, ("talloc_strdup failed\n"));
648 string_replace(tmp, '/', '\\');
652 change->action = action;
653 fsp->notify->num_changes += 1;
655 if (fsp->notify->requests == NULL) {
657 * Nobody is waiting, so don't send anything. The ot
662 if (action == NOTIFY_ACTION_OLD_NAME) {
664 * We have to send the two rename events in one reply. So hold
665 * the first part back.
671 * Someone is waiting for the change, trigger the reply immediately.
673 * TODO: do we have to walk the lists of requests pending?
676 change_notify_reply(fsp->notify->requests->req,
678 fsp->notify->requests->max_param,
680 fsp->notify->requests->reply_fn);
682 change_notify_remove_request(fsp->conn->sconn, fsp->notify->requests);
685 char *notify_filter_string(TALLOC_CTX *mem_ctx, uint32_t filter)
689 result = talloc_strdup(mem_ctx, "");
691 if (filter & FILE_NOTIFY_CHANGE_FILE_NAME)
692 result = talloc_asprintf_append(result, "FILE_NAME|");
693 if (filter & FILE_NOTIFY_CHANGE_DIR_NAME)
694 result = talloc_asprintf_append(result, "DIR_NAME|");
695 if (filter & FILE_NOTIFY_CHANGE_ATTRIBUTES)
696 result = talloc_asprintf_append(result, "ATTRIBUTES|");
697 if (filter & FILE_NOTIFY_CHANGE_SIZE)
698 result = talloc_asprintf_append(result, "SIZE|");
699 if (filter & FILE_NOTIFY_CHANGE_LAST_WRITE)
700 result = talloc_asprintf_append(result, "LAST_WRITE|");
701 if (filter & FILE_NOTIFY_CHANGE_LAST_ACCESS)
702 result = talloc_asprintf_append(result, "LAST_ACCESS|");
703 if (filter & FILE_NOTIFY_CHANGE_CREATION)
704 result = talloc_asprintf_append(result, "CREATION|");
705 if (filter & FILE_NOTIFY_CHANGE_EA)
706 result = talloc_asprintf_append(result, "EA|");
707 if (filter & FILE_NOTIFY_CHANGE_SECURITY)
708 result = talloc_asprintf_append(result, "SECURITY|");
709 if (filter & FILE_NOTIFY_CHANGE_STREAM_NAME)
710 result = talloc_asprintf_append(result, "STREAM_NAME|");
711 if (filter & FILE_NOTIFY_CHANGE_STREAM_SIZE)
712 result = talloc_asprintf_append(result, "STREAM_SIZE|");
713 if (filter & FILE_NOTIFY_CHANGE_STREAM_WRITE)
714 result = talloc_asprintf_append(result, "STREAM_WRITE|");
716 if (result == NULL) return NULL;
717 if (*result == '\0') return result;
719 result[strlen(result)-1] = '\0';
723 struct sys_notify_context *sys_notify_context_create(TALLOC_CTX *mem_ctx,
724 struct tevent_context *ev)
726 struct sys_notify_context *ctx;
728 if (!(ctx = talloc(mem_ctx, struct sys_notify_context))) {
729 DEBUG(0, ("talloc failed\n"));
734 ctx->private_data = NULL;