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