summaryrefslogtreecommitdiff
path: root/source3/smbd/notify.c
blob: 49a516b907d018d8cf3630e62829817656d746a8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
/*
   Unix SMB/CIFS implementation.
   change notify handling
   Copyright (C) Andrew Tridgell 2000
   Copyright (C) Jeremy Allison 1994-1998

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#include "includes.h"

static struct cnotify_fns *cnotify;
static struct notify_mid_map *notify_changes_by_mid;

/****************************************************************************
 This is the structure to queue to implement NT change
 notify. It consists of smb_size bytes stored from the
 transact command (to keep the mid, tid etc around).
 Plus the fid to examine and notify private data.
*****************************************************************************/

struct change_notify {
	struct change_notify *next, *prev;
	files_struct *fsp;
	uint32 flags;
	uint32 max_param_count;
	char request_buf[smb_size];
	void *change_data;
};

static struct change_notify *change_notify_list;

static BOOL notify_marshall_changes(unsigned num_changes,
				    struct notify_change *changes,
				    prs_struct *ps)
{
	int i;
	UNISTR uni_name;

	for (i=0; i<num_changes; i++) {
		struct notify_change *c = &changes[i];
		size_t namelen;
		uint32 u32_tmp;	/* Temp arg to prs_uint32 to avoid
				 * signed/unsigned issues */

		namelen = convert_string_allocate(
			NULL, CH_UNIX, CH_UTF16LE, c->name, strlen(c->name)+1,
			&uni_name.buffer, True);
		if ((namelen == -1) || (uni_name.buffer == NULL)) {
			goto fail;
		}

		namelen -= 2;	/* Dump NULL termination */

		/*
		 * Offset to next entry, only if there is one
		 */

		u32_tmp = (i == num_changes-1) ? 0 : namelen + 12;
		if (!prs_uint32("offset", ps, 1, &u32_tmp)) goto fail;

		u32_tmp = c->action;
		if (!prs_uint32("action", ps, 1, &u32_tmp)) goto fail;

		u32_tmp = namelen;
		if (!prs_uint32("namelen", ps, 1, &u32_tmp)) goto fail;

		if (!prs_unistr("name", ps, 1, &uni_name)) goto fail;

		/*
		 * Not NULL terminated, decrease by the 2 UCS2 \0 chars
		 */
		prs_set_offset(ps, prs_offset(ps)-2);

		SAFE_FREE(uni_name.buffer);
	}

	return True;

 fail:
	SAFE_FREE(uni_name.buffer);
	return False;
}

/****************************************************************************
 Setup the common parts of the return packet and send it.
*****************************************************************************/

void change_notify_reply_packet(const char *request_buf, NTSTATUS error_code)
{
	char outbuf[smb_size+38];

	memset(outbuf, '\0', sizeof(outbuf));
	construct_reply_common(request_buf, outbuf);

	ERROR_NT(error_code);

	/*
	 * Seems NT needs a transact command with an error code
	 * in it. This is a longer packet than a simple error.
	 */
	set_message(outbuf,18,0,False);

	show_msg(outbuf);
	if (!send_smb(smbd_server_fd(),outbuf))
		exit_server_cleanly("change_notify_reply_packet: send_smb failed.");
}

void change_notify_reply(const char *request_buf, uint32 max_param_count,
			 unsigned num_changes, struct notify_change *changes)
{
	char *outbuf = NULL;
	prs_struct ps;
	size_t buflen = smb_size+38+max_param_count;

	if (!prs_init(&ps, 0, NULL, False)
	    || !notify_marshall_changes(num_changes, changes, &ps)) {
		change_notify_reply_packet(request_buf, NT_STATUS_NO_MEMORY);
		goto done;
	}

	if (prs_offset(&ps) > max_param_count) {
		/*
		 * We exceed what the client is willing to accept. Send
		 * nothing.
		 */
		change_notify_reply_packet(request_buf, NT_STATUS_OK);
		goto done;
	}

	if (!(outbuf = SMB_MALLOC_ARRAY(char, buflen))) {
		change_notify_reply_packet(request_buf, NT_STATUS_NO_MEMORY);
		goto done;
	}

	construct_reply_common(request_buf, outbuf);

	if (send_nt_replies(outbuf, buflen, NT_STATUS_OK, prs_data_p(&ps),
			    prs_offset(&ps), NULL, 0) == -1) {
		exit_server("change_notify_reply_packet: send_smb failed.");
	}

 done:
	SAFE_FREE(outbuf);
	prs_mem_free(&ps);
}

/****************************************************************************
 Remove an entry from the list and free it, also closing any
 directory handle if necessary.
*****************************************************************************/

static void change_notify_remove(struct change_notify *cnbp)
{
	cnotify->remove_notify(cnbp->change_data);
	DLIST_REMOVE(change_notify_list, cnbp);
	ZERO_STRUCTP(cnbp);
	SAFE_FREE(cnbp);
}

NTSTATUS change_notify_add_request(const char *inbuf, uint32 max_param_count,
				   struct files_struct *fsp)
{
	struct notify_change_request *request = NULL;
	struct notify_mid_map *map = NULL;

	if (!(request = SMB_MALLOC_P(struct notify_change_request))
	    || !(map = SMB_MALLOC_P(struct notify_mid_map))) {
		SAFE_FREE(request);
		return NT_STATUS_NO_MEMORY;
	}

	request->mid_map = map;
	map->req = request;

	memcpy(request->request_buf, inbuf, sizeof(request->request_buf));
	request->max_param_count = max_param_count;
	request->fsp = fsp;
	DLIST_ADD_END(fsp->notify->requests, request,
		      struct notify_change_request *);

	map->mid = SVAL(inbuf, smb_mid);
	DLIST_ADD(notify_changes_by_mid, map);

	/* Push the MID of this packet on the signing queue. */
	srv_defer_sign_response(SVAL(inbuf,smb_mid));

	return NT_STATUS_OK;
}

static void change_notify_remove_request(struct notify_change_request *remove_req)
{
	files_struct *fsp;
	struct notify_change_request *req;

	/*
	 * Paranoia checks, the fsp referenced must must have the request in
	 * its list of pending requests
	 */

	fsp = remove_req->fsp;
	SMB_ASSERT(fsp->notify != NULL);

	for (req = fsp->notify->requests; req; req = req->next) {
		if (req == remove_req) {
			break;
		}
	}
	SMB_ASSERT(req != NULL);

	DLIST_REMOVE(fsp->notify->requests, req);
	DLIST_REMOVE(notify_changes_by_mid, req->mid_map);
	SAFE_FREE(req->mid_map);
	SAFE_FREE(req);
}

/****************************************************************************
 Delete entries by mid from the change notify pending queue. Always send reply.
*****************************************************************************/

void remove_pending_change_notify_requests_by_mid(uint16 mid)
{
	struct notify_mid_map *map;

	for (map = notify_changes_by_mid; map; map = map->next) {
		if (map->mid == mid) {
			break;
		}
	}

	if (map == NULL) {
		return;
	}

	change_notify_reply_packet(map->req->request_buf, NT_STATUS_CANCELLED);
	change_notify_remove_request(map->req);
}

/****************************************************************************
 Delete entries by fnum from the change notify pending queue.
*****************************************************************************/

void remove_pending_change_notify_requests_by_fid(files_struct *fsp,
						  NTSTATUS status)
{
	if (fsp->notify == NULL) {
		return;
	}

	while (fsp->notify->requests != NULL) {
		change_notify_reply_packet(
			fsp->notify->requests->request_buf, status);
		change_notify_remove_request(fsp->notify->requests);
	}
}

/****************************************************************************
 Delete entries by filename and cnum from the change notify pending queue.
 Always send reply.
*****************************************************************************/

void remove_pending_change_notify_requests_by_filename(files_struct *fsp, NTSTATUS status)
{
	struct change_notify *cnbp, *next;

	for (cnbp=change_notify_list; cnbp; cnbp=next) {
		next=cnbp->next;
		/*
		 * We know it refers to the same directory if the connection number and
		 * the filename are identical.
		 */
		if((cnbp->fsp->conn == fsp->conn) && strequal(cnbp->fsp->fsp_name,fsp->fsp_name)) {
			change_notify_reply_packet(cnbp->request_buf, status);
			change_notify_remove(cnbp);
		}
	}
}

/****************************************************************************
 Set the current change notify timeout to the lowest value across all service
 values.
****************************************************************************/

void set_change_notify_timeout(int val)
{
	if (val > 0) {
		cnotify->select_time = MIN(cnotify->select_time, val);
	}
}

/****************************************************************************
 Longest time to sleep for before doing a change notify scan.
****************************************************************************/

int change_notify_timeout(void)
{
	return cnotify->select_time;
}

/****************************************************************************
 Process the change notify queue. Note that this is only called as root.
 Returns True if there are still outstanding change notify requests on the
 queue.
*****************************************************************************/

BOOL process_pending_change_notify_queue(time_t t)
{
	struct change_notify *cnbp, *next;
	uint16 vuid;

	for (cnbp=change_notify_list; cnbp; cnbp=next) {
		next=cnbp->next;

		vuid = (lp_security() == SEC_SHARE) ? UID_FIELD_INVALID : SVAL(cnbp->request_buf,smb_uid);

		if (cnbp->fsp->notify->num_changes != 0) {
			DEBUG(10,("process_pending_change_notify_queue: %s "
				  "has %d changes!\n", cnbp->fsp->fsp_name,
				  cnbp->fsp->notify->num_changes));
			change_notify_reply(cnbp->request_buf,
					    cnbp->max_param_count,
					    cnbp->fsp->notify->num_changes,
					    cnbp->fsp->notify->changes);
			change_notify_remove(cnbp);
			continue;
		}

		if (cnotify->check_notify(cnbp->fsp->conn, vuid,
					  cnbp->fsp->fsp_name, cnbp->flags,
					  cnbp->change_data, t)) {
			DEBUG(10,("process_pending_change_notify_queue: dir "
				  "%s changed !\n", cnbp->fsp->fsp_name ));
			change_notify_reply(cnbp->request_buf,
					    cnbp->max_param_count,
					    cnbp->fsp->notify->num_changes,
					    cnbp->fsp->notify->changes);
			change_notify_remove(cnbp);
		}
	}

	return (change_notify_list != NULL);
}

/****************************************************************************
 Now queue an entry on the notify change list.
 We only need to save smb_size bytes from this incoming packet
 as we will always by returning a 'read the directory yourself'
 error.
****************************************************************************/

BOOL change_notify_set(char *inbuf, files_struct *fsp, connection_struct *conn,
		       uint32 flags, uint32 max_param_count)
{
	struct change_notify *cnbp;

	if((cnbp = SMB_MALLOC_P(struct change_notify)) == NULL) {
		DEBUG(0,("change_notify_set: malloc fail !\n" ));
		return False;
	}

	ZERO_STRUCTP(cnbp);

	memcpy(cnbp->request_buf, inbuf, smb_size);
	cnbp->fsp = fsp;
	cnbp->flags = flags;
	cnbp->max_param_count = max_param_count;
	cnbp->change_data = cnotify->register_notify(conn, fsp->fsp_name,
						     flags);
	
	if (!cnbp->change_data) {
		SAFE_FREE(cnbp);
		return False;
	}

	DLIST_ADD(change_notify_list, cnbp);

	/* Push the MID of this packet on the signing queue. */
	srv_defer_sign_response(SVAL(inbuf,smb_mid));

	return True;
}

int change_notify_fd(void)
{
	if (cnotify) {
		return cnotify->notification_fd;
	}

	return -1;
}

/* notify message definition

Offset  Data			length.
0	SMB_DEV_T dev		8
8	SMB_INO_T inode		8
16	uint32 action		4
20..	name
*/

#define MSG_NOTIFY_MESSAGE_SIZE 21 /* Includes at least the '\0' terminator */

struct notify_message {
	SMB_DEV_T dev;
	SMB_INO_T inode;
	uint32_t action;
	char *name;
};

static DATA_BLOB notify_message_to_buf(const struct notify_message *msg)
{
	DATA_BLOB result;
	size_t len;

	len = strlen(msg->name);

	result = data_blob(NULL, MSG_NOTIFY_MESSAGE_SIZE + len);
	if (!result.data) {
		return result;
	}

	SDEV_T_VAL(result.data, 0, msg->dev);
	SINO_T_VAL(result.data, 8, msg->inode);
	SIVAL(result.data, 16, msg->action);
	memcpy(result.data+20, msg->name, len+1);

	return result;
}

static BOOL buf_to_notify_message(void *buf, size_t len,
				  struct notify_message *msg)
{
	if (len < MSG_NOTIFY_MESSAGE_SIZE) {
		DEBUG(0, ("Got invalid notify message of len %d\n",
			  (int)len));
		return False;
	}

	msg->dev     = DEV_T_VAL(buf, 0);
	msg->inode   = INO_T_VAL(buf, 8);
	msg->action  = IVAL(buf, 16);
	msg->name    = ((char *)buf)+20;
	return True;
}

void notify_action(connection_struct *conn, const char *parent,
		   const char *name, uint32_t action)
{
	struct share_mode_lock *lck;
	SMB_STRUCT_STAT sbuf;
	int i;
	struct notify_message msg;
	DATA_BLOB blob;

	struct process_id *pids;
	int num_pids;

	DEBUG(10, ("notify_action: parent=%s, name=%s, action=%u\n",
		   parent, name, (unsigned)action));

	if (SMB_VFS_STAT(conn, parent, &sbuf) != 0) {
		/*
		 * Not 100% critical, ignore failure
		 */
		return;
	}

	if (!(lck = get_share_mode_lock(NULL, sbuf.st_dev, sbuf.st_ino,
					NULL, NULL))) {
		return;
	}

	msg.dev = sbuf.st_dev;
	msg.inode = sbuf.st_ino;
	msg.action = action;
	msg.name = CONST_DISCARD(char *, name);

	blob = notify_message_to_buf(&msg);
	if (blob.data == NULL) {
		DEBUG(0, ("notify_message_to_buf failed\n"));
		return;
	}

	pids = NULL;
	num_pids = 0;

	become_root_uid_only();

	for (i=0; i<lck->num_share_modes; i++) {
		struct share_mode_entry *e = &lck->share_modes[i];
		int j;
		struct process_id *tmp;

		for (j=0; j<num_pids; j++) {
			if (procid_equal(&e->pid, &pids[j])) {
				break;
			}
		}

		if (j < num_pids) {
			/*
			 * Already sent to that process, skip it
			 */
			continue;
		}

		message_send_pid(lck->share_modes[i].pid, MSG_SMB_NOTIFY,
				 blob.data, blob.length, True);

		if (!(tmp = TALLOC_REALLOC_ARRAY(lck, pids, struct process_id,
						 num_pids+1))) {
			DEBUG(0, ("realloc failed\n"));
			break;
		}
		pids = tmp;
		pids[num_pids] = e->pid;
		num_pids += 1;
	}

	unbecome_root_uid_only();

	data_blob_free(&blob);
	TALLOC_FREE(lck);
}

static void notify_fsp(files_struct *fsp, struct notify_message *msg)
{
	struct notify_change *change, *changes;

	if (fsp->notify == NULL) {
		/*
		 * Nobody is waiting, don't queue
		 */
		return;
	}

	if (fsp->notify->requests != NULL) {
		/*
		 * Someone is waiting for the change, trigger the reply
		 * immediately
		 */

		struct notify_change_request *req = fsp->notify->requests;
		struct notify_change onechange;

		onechange.action = msg->action;
		onechange.name = msg->name;

		change_notify_reply(req->request_buf, req->max_param_count,
				    1, &onechange);

		DLIST_REMOVE(fsp->notify->requests, req);
		SAFE_FREE(req);
		return;
	}

	/*
	 * Someone has triggered a notify previously, queue the change for
	 * later. TODO: Limit the number of changes queued.
	 */

	if (!(changes = TALLOC_REALLOC_ARRAY(
		      fsp->notify, fsp->notify->changes,
		      struct notify_change, fsp->notify->num_changes+1))) {
		DEBUG(0, ("talloc_realloc failed\n"));
		return;
	}

	fsp->notify->changes = changes;

	change = &(fsp->notify->changes[fsp->notify->num_changes]);

	if (!(change->name = talloc_strdup(changes, msg->name))) {
		DEBUG(0, ("talloc_strdup failed\n"));
		return;
	}
	change->action = msg->action;
	fsp->notify->num_changes += 1;

	return;
}

static void notify_message_callback(int msgtype, struct process_id pid,
				    void *buf, size_t len)
{
	struct notify_message msg;
	files_struct *fsp;

	if (!buf_to_notify_message(buf, len, &msg)) {
		return;
	}

	DEBUG(10, ("Received notify_message for 0x%x/%.0f: %d\n",
		   (unsigned)msg.dev, (double)msg.inode, msg.action));

	for(fsp = fsp_find_di_first(msg.dev, msg.inode); fsp;
	    fsp = fsp_find_di_next(fsp)) {
		notify_fsp(fsp, &msg);
	}
}

/****************************************************************************
 Initialise the change notify subsystem.
****************************************************************************/

BOOL init_change_notify(void)
{
	cnotify = NULL;

#if HAVE_KERNEL_CHANGE_NOTIFY
	if (cnotify == NULL && lp_kernel_change_notify())
		cnotify = kernel_notify_init();
#endif
#if HAVE_FAM_CHANGE_NOTIFY
	if (cnotify == NULL && lp_fam_change_notify())
		cnotify = fam_notify_init();
#endif
	if (!cnotify) cnotify = hash_notify_init();
	
	if (!cnotify) {
		DEBUG(0,("Failed to init change notify system\n"));
		return False;
	}

	message_register(MSG_SMB_NOTIFY, notify_message_callback);

	return True;
}