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/globals.h"
24 #include "../librpc/gen_ndr/notify.h"
26 struct notify_change_request {
27 struct notify_change_request *prev, *next;
28 struct files_struct *fsp; /* backpointer for cancel by mid */
29 struct smb_request *req;
32 void (*reply_fn)(struct smb_request *req,
34 uint8_t *buf, size_t len);
35 struct notify_mid_map *mid_map;
39 static void notify_fsp(files_struct *fsp, uint32 action, const char *name);
42 * For NTCancel, we need to find the notify_change_request indexed by
43 * mid. Separate list here.
46 struct notify_mid_map {
47 struct notify_mid_map *prev, *next;
48 struct notify_change_request *req;
52 static bool notify_change_record_identical(struct notify_change *c1,
53 struct notify_change *c2)
55 /* Note this is deliberately case sensitive. */
56 if (c1->action == c2->action &&
57 strcmp(c1->name, c2->name) == 0) {
63 static bool notify_marshall_changes(int num_changes,
65 struct notify_change *changes,
71 if (num_changes == -1) {
75 uni_name.buffer = NULL;
77 for (i=0; i<num_changes; i++) {
78 struct notify_change *c;
80 uint32 u32_tmp; /* Temp arg to prs_uint32 to avoid
81 * signed/unsigned issues */
83 /* Coalesce any identical records. */
84 while (i+1 < num_changes &&
85 notify_change_record_identical(&changes[i],
92 if (!convert_string_talloc(talloc_tos(), CH_UNIX, CH_UTF16LE,
93 c->name, strlen(c->name)+1, &uni_name.buffer,
94 &namelen, True) || (uni_name.buffer == NULL)) {
98 namelen -= 2; /* Dump NULL termination */
101 * Offset to next entry, only if there is one
104 u32_tmp = (i == num_changes-1) ? 0 : namelen + 12;
105 if (!prs_uint32("offset", ps, 1, &u32_tmp)) goto fail;
108 if (!prs_uint32("action", ps, 1, &u32_tmp)) goto fail;
111 if (!prs_uint32("namelen", ps, 1, &u32_tmp)) goto fail;
113 if (!prs_unistr("name", ps, 1, &uni_name)) goto fail;
116 * Not NULL terminated, decrease by the 2 UCS2 \0 chars
118 prs_set_offset(ps, prs_offset(ps)-2);
120 TALLOC_FREE(uni_name.buffer);
122 if (prs_offset(ps) > max_offset) {
123 /* Too much data for client. */
124 DEBUG(10, ("Client only wanted %d bytes, trying to "
125 "marshall %d bytes\n", (int)max_offset,
126 (int)prs_offset(ps)));
134 TALLOC_FREE(uni_name.buffer);
138 /****************************************************************************
139 Setup the common parts of the return packet and send it.
140 *****************************************************************************/
142 void change_notify_reply(connection_struct *conn,
143 struct smb_request *req,
146 struct notify_change_buf *notify_buf,
147 void (*reply_fn)(struct smb_request *req,
149 uint8_t *buf, size_t len))
153 if (!NT_STATUS_IS_OK(error_code)) {
154 reply_fn(req, error_code, NULL, 0);
158 if (max_param == 0 || notify_buf == NULL) {
159 reply_fn(req, NT_STATUS_OK, NULL, 0);
163 prs_init_empty(&ps, NULL, MARSHALL);
165 if (!notify_marshall_changes(notify_buf->num_changes, max_param,
166 notify_buf->changes, &ps)) {
168 * We exceed what the client is willing to accept. Send
172 prs_init_empty(&ps, NULL, MARSHALL);
175 reply_fn(req, NT_STATUS_OK, (uint8_t *)prs_data_p(&ps), prs_offset(&ps));
179 TALLOC_FREE(notify_buf->changes);
180 notify_buf->num_changes = 0;
183 static void notify_callback(void *private_data, const struct notify_event *e)
185 files_struct *fsp = (files_struct *)private_data;
186 DEBUG(10, ("notify_callback called for %s\n", fsp_str_dbg(fsp)));
187 notify_fsp(fsp, e->action, e->path);
190 NTSTATUS change_notify_create(struct files_struct *fsp, uint32 filter,
194 struct notify_entry e;
197 SMB_ASSERT(fsp->notify == NULL);
199 if (!(fsp->notify = TALLOC_ZERO_P(NULL, struct notify_change_buf))) {
200 DEBUG(0, ("talloc failed\n"));
201 return NT_STATUS_NO_MEMORY;
204 /* Do notify operations on the base_name. */
205 if (asprintf(&fullpath, "%s/%s", fsp->conn->connectpath,
206 fsp->fsp_name->base_name) == -1) {
207 DEBUG(0, ("asprintf failed\n"));
208 TALLOC_FREE(fsp->notify);
209 return NT_STATUS_NO_MEMORY;
214 e.dir_fd = fsp->fh->fd;
215 e.dir_id = fsp->file_id;
219 e.subdir_filter = filter;
222 status = notify_add(fsp->conn->notify_ctx, &e, notify_callback, fsp);
228 NTSTATUS change_notify_add_request(struct smb_request *req,
230 uint32 filter, bool recursive,
231 struct files_struct *fsp,
232 void (*reply_fn)(struct smb_request *req,
234 uint8_t *buf, size_t len))
236 struct notify_change_request *request = NULL;
237 struct notify_mid_map *map = NULL;
238 struct smbd_server_connection *sconn = smbd_server_conn;
240 DEBUG(10, ("change_notify_add_request: Adding request for %s: "
241 "max_param = %d\n", fsp_str_dbg(fsp), (int)max_param));
243 if (!(request = talloc(NULL, struct notify_change_request))
244 || !(map = talloc(request, struct notify_mid_map))) {
245 TALLOC_FREE(request);
246 return NT_STATUS_NO_MEMORY;
249 request->mid_map = map;
252 request->req = talloc_move(request, &req);
253 request->max_param = max_param;
254 request->filter = filter;
256 request->reply_fn = reply_fn;
257 request->backend_data = NULL;
259 DLIST_ADD_END(fsp->notify->requests, request,
260 struct notify_change_request *);
262 map->mid = request->req->mid;
263 DLIST_ADD(sconn->smb1.notify_mid_maps, map);
268 static void change_notify_remove_request(struct notify_change_request *remove_req)
271 struct notify_change_request *req;
272 struct smbd_server_connection *sconn = smbd_server_conn;
275 * Paranoia checks, the fsp referenced must must have the request in
276 * its list of pending requests
279 fsp = remove_req->fsp;
280 SMB_ASSERT(fsp->notify != NULL);
282 for (req = fsp->notify->requests; req; req = req->next) {
283 if (req == remove_req) {
289 smb_panic("notify_req not found in fsp's requests");
292 DLIST_REMOVE(fsp->notify->requests, req);
293 DLIST_REMOVE(sconn->smb1.notify_mid_maps, req->mid_map);
297 /****************************************************************************
298 Delete entries by mid from the change notify pending queue. Always send reply.
299 *****************************************************************************/
301 void remove_pending_change_notify_requests_by_mid(uint64_t mid)
303 struct notify_mid_map *map;
304 struct smbd_server_connection *sconn = smbd_server_conn;
306 for (map = sconn->smb1.notify_mid_maps; map; map = map->next) {
307 if (map->mid == mid) {
316 change_notify_reply(map->req->fsp->conn, map->req->req,
317 NT_STATUS_CANCELLED, 0, NULL, map->req->reply_fn);
318 change_notify_remove_request(map->req);
321 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq)
323 struct smbd_server_connection *sconn = smbreq->sconn;
324 struct notify_mid_map *map;
326 for (map = sconn->smb1.notify_mid_maps; map; map = map->next) {
327 if (map->req->req == smbreq) {
336 change_notify_reply(map->req->fsp->conn, map->req->req,
337 NT_STATUS_CANCELLED, 0, NULL, map->req->reply_fn);
338 change_notify_remove_request(map->req);
341 /****************************************************************************
342 Delete entries by fnum from the change notify pending queue.
343 *****************************************************************************/
345 void remove_pending_change_notify_requests_by_fid(files_struct *fsp,
348 if (fsp->notify == NULL) {
352 while (fsp->notify->requests != NULL) {
353 change_notify_reply(fsp->conn, fsp->notify->requests->req,
355 fsp->notify->requests->reply_fn);
356 change_notify_remove_request(fsp->notify->requests);
360 void notify_fname(connection_struct *conn, uint32 action, uint32 filter,
367 if (path[0] == '.' && path[1] == '/') {
370 if (parent_dirname(talloc_tos(), path, &parent, &name)) {
371 struct smb_filename smb_fname_parent;
373 ZERO_STRUCT(smb_fname_parent);
374 smb_fname_parent.base_name = parent;
376 if (SMB_VFS_STAT(conn, &smb_fname_parent) != -1) {
377 notify_onelevel(conn->notify_ctx, action, filter,
378 SMB_VFS_FILE_ID_CREATE(conn, &smb_fname_parent.st),
383 fullpath = talloc_asprintf(talloc_tos(), "%s/%s", conn->connectpath,
385 if (fullpath == NULL) {
386 DEBUG(0, ("asprintf failed\n"));
389 notify_trigger(conn->notify_ctx, action, filter, fullpath);
390 TALLOC_FREE(fullpath);
393 static void notify_fsp(files_struct *fsp, uint32 action, const char *name)
395 struct notify_change *change, *changes;
398 if (fsp->notify == NULL) {
400 * Nobody is waiting, don't queue
406 * Someone has triggered a notify previously, queue the change for
410 if ((fsp->notify->num_changes > 1000) || (name == NULL)) {
412 * The real number depends on the client buf, just provide a
413 * guard against a DoS here. If name == NULL the CN backend is
414 * alerting us to a problem. Possibly dropped events. Clear
415 * queued changes and send the catch-all response to the client
416 * if a request is pending.
418 TALLOC_FREE(fsp->notify->changes);
419 fsp->notify->num_changes = -1;
420 if (fsp->notify->requests != NULL) {
421 change_notify_reply(fsp->conn,
422 fsp->notify->requests->req,
424 fsp->notify->requests->max_param,
426 fsp->notify->requests->reply_fn);
427 change_notify_remove_request(fsp->notify->requests);
432 /* If we've exceeded the server side queue or received a NULL name
433 * from the underlying CN implementation, don't queue up any more
434 * requests until we can send a catch-all response to the client */
435 if (fsp->notify->num_changes == -1) {
439 if (!(changes = TALLOC_REALLOC_ARRAY(
440 fsp->notify, fsp->notify->changes,
441 struct notify_change, fsp->notify->num_changes+1))) {
442 DEBUG(0, ("talloc_realloc failed\n"));
446 fsp->notify->changes = changes;
448 change = &(fsp->notify->changes[fsp->notify->num_changes]);
450 if (!(tmp = talloc_strdup(changes, name))) {
451 DEBUG(0, ("talloc_strdup failed\n"));
455 string_replace(tmp, '/', '\\');
458 change->action = action;
459 fsp->notify->num_changes += 1;
461 if (fsp->notify->requests == NULL) {
463 * Nobody is waiting, so don't send anything. The ot
468 if (action == NOTIFY_ACTION_OLD_NAME) {
470 * We have to send the two rename events in one reply. So hold
471 * the first part back.
477 * Someone is waiting for the change, trigger the reply immediately.
479 * TODO: do we have to walk the lists of requests pending?
482 change_notify_reply(fsp->conn,
483 fsp->notify->requests->req,
485 fsp->notify->requests->max_param,
487 fsp->notify->requests->reply_fn);
489 change_notify_remove_request(fsp->notify->requests);
492 char *notify_filter_string(TALLOC_CTX *mem_ctx, uint32 filter)
496 result = talloc_strdup(mem_ctx, "");
498 if (filter & FILE_NOTIFY_CHANGE_FILE_NAME)
499 result = talloc_asprintf_append(result, "FILE_NAME|");
500 if (filter & FILE_NOTIFY_CHANGE_DIR_NAME)
501 result = talloc_asprintf_append(result, "DIR_NAME|");
502 if (filter & FILE_NOTIFY_CHANGE_ATTRIBUTES)
503 result = talloc_asprintf_append(result, "ATTRIBUTES|");
504 if (filter & FILE_NOTIFY_CHANGE_SIZE)
505 result = talloc_asprintf_append(result, "SIZE|");
506 if (filter & FILE_NOTIFY_CHANGE_LAST_WRITE)
507 result = talloc_asprintf_append(result, "LAST_WRITE|");
508 if (filter & FILE_NOTIFY_CHANGE_LAST_ACCESS)
509 result = talloc_asprintf_append(result, "LAST_ACCESS|");
510 if (filter & FILE_NOTIFY_CHANGE_CREATION)
511 result = talloc_asprintf_append(result, "CREATION|");
512 if (filter & FILE_NOTIFY_CHANGE_EA)
513 result = talloc_asprintf_append(result, "EA|");
514 if (filter & FILE_NOTIFY_CHANGE_SECURITY)
515 result = talloc_asprintf_append(result, "SECURITY|");
516 if (filter & FILE_NOTIFY_CHANGE_STREAM_NAME)
517 result = talloc_asprintf_append(result, "STREAM_NAME|");
518 if (filter & FILE_NOTIFY_CHANGE_STREAM_SIZE)
519 result = talloc_asprintf_append(result, "STREAM_SIZE|");
520 if (filter & FILE_NOTIFY_CHANGE_STREAM_WRITE)
521 result = talloc_asprintf_append(result, "STREAM_WRITE|");
523 if (result == NULL) return NULL;
524 if (*result == '\0') return result;
526 result[strlen(result)-1] = '\0';
530 struct sys_notify_context *sys_notify_context_create(connection_struct *conn,
532 struct event_context *ev)
534 struct sys_notify_context *ctx;
536 if (!(ctx = TALLOC_P(mem_ctx, struct sys_notify_context))) {
537 DEBUG(0, ("talloc failed\n"));
543 ctx->private_data = NULL;
547 NTSTATUS sys_notify_watch(struct sys_notify_context *ctx,
548 struct notify_entry *e,
549 void (*callback)(struct sys_notify_context *ctx,
551 struct notify_event *ev),
552 void *private_data, void *handle)
554 return SMB_VFS_NOTIFY_WATCH(ctx->conn, ctx, e, callback, private_data,