2 * traffic-analyzer VFS module. Measure the smb traffic users create
5 * Copyright (C) Holger Hetterich, 2008
6 * Copyright (C) Jeremy Allison, 2008
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 "../lib/crypto/crypto.h"
24 #include "vfs_smb_traffic_analyzer.h"
26 /* abstraction for the send_over_network function */
27 enum sock_type {INTERNET_SOCKET = 0, UNIX_DOMAIN_SOCKET};
29 #define LOCAL_PATHNAME "/var/tmp/stadsocket"
31 static int vfs_smb_traffic_analyzer_debug_level = DBGC_VFS;
33 static enum sock_type smb_traffic_analyzer_connMode(vfs_handle_struct *handle)
35 connection_struct *conn = handle->conn;
37 Mode=lp_parm_const_string(SNUM(conn), "smb_traffic_analyzer","mode", \
39 if (strstr(Mode,"unix_domain_socket")) {
40 return UNIX_DOMAIN_SOCKET;
42 return INTERNET_SOCKET;
47 /* Connect to an internet socket */
48 static int smb_traffic_analyzer_connect_inet_socket(vfs_handle_struct *handle,
49 const char *name, uint16_t port)
51 /* Create a streaming Socket */
53 struct addrinfo hints;
54 struct addrinfo *ailist = NULL;
55 struct addrinfo *res = NULL;
59 /* By default make sure it supports TCP. */
60 hints.ai_socktype = SOCK_STREAM;
61 hints.ai_flags = AI_ADDRCONFIG;
63 ret = getaddrinfo(name,
69 DEBUG(3,("smb_traffic_analyzer_connect_inet_socket: "
70 "getaddrinfo failed for name %s [%s]\n",
76 DEBUG(3,("smb_traffic_analyzer: Internet socket mode. Hostname: %s,"
77 "Port: %i\n", name, port));
79 for (res = ailist; res; res = res->ai_next) {
80 struct sockaddr_storage ss;
83 if (!res->ai_addr || res->ai_addrlen == 0) {
88 memcpy(&ss, res->ai_addr, res->ai_addrlen);
90 status = open_socket_out(&ss, port, 10000, &sockfd);
91 if (NT_STATUS_IS_OK(status)) {
101 DEBUG(1, ("smb_traffic_analyzer: unable to create "
102 "socket, error is %s",
110 /* Connect to a unix domain socket */
111 static int smb_traffic_analyzer_connect_unix_socket(vfs_handle_struct *handle,
114 /* Create the socket to stad */
116 struct sockaddr_un remote;
118 DEBUG(7, ("smb_traffic_analyzer_connect_unix_socket: "
119 "Unix domain socket mode. Using %s\n",
122 if ((sock = socket(AF_UNIX, SOCK_STREAM, 0)) == -1) {
123 DEBUG(1, ("smb_traffic_analyzer_connect_unix_socket: "
124 "Couldn't create socket, "
125 "make sure stad is running!\n"));
128 remote.sun_family = AF_UNIX;
129 strlcpy(remote.sun_path, name,
130 sizeof(remote.sun_path));
131 len=strlen(remote.sun_path) + sizeof(remote.sun_family);
132 if (connect(sock, (struct sockaddr *)&remote, len) == -1 ) {
133 DEBUG(1, ("smb_traffic_analyzer_connect_unix_socket: "
134 "Could not connect to "
135 "socket, make sure\nstad is running!\n"));
142 /* Private data allowing shared connection sockets. */
143 struct refcounted_sock {
144 struct refcounted_sock *next, *prev;
148 unsigned int ref_count;
152 /* The marshaller for the protocol version 2. */
153 static char *smb_traffic_analyzer_create_string( struct tm *tm, \
154 int seconds, vfs_handle_struct *handle, \
155 char *username, int vfs_operation, int count, ... )
163 char *timestr = NULL;
166 char *userstr = NULL;
167 char *usersid = NULL;
168 const char *total_anonymization = NULL;
169 const char *anon_prefix = NULL;
171 * first create the data that is transfered with any VFS op
172 * These are, in the following order:
173 * number of data to come [6 in v2.0]
174 * 1.vfs_operation identifier
177 * 4.affected file + full path
182 opstr = talloc_asprintf(talloc_tos(), "%i", vfs_operation);
184 buf = talloc_asprintf(talloc_tos(), "%04u%s", len, opstr);
187 * Handle anonymization. In protocol v2, we have to anonymize
188 * both the SID and the username.
190 total_anonymization=lp_parm_const_string(SNUM(handle->conn),
191 "smb_traffic_analyzer",
192 "total_anonymization", NULL);
194 anon_prefix=lp_parm_const_string(SNUM(handle->conn),
195 "smb_traffic_analyzer",
196 "anonymize_prefix", NULL );
197 usersid = dom_sid_string(talloc_tos(),
198 &handle->conn->server_info->ptok->user_sids[0]);
199 if (anon_prefix != NULL) {
200 if (total_anonymization != NULL) {
201 userstr = talloc_asprintf(talloc_tos(), "%s",
203 sidstr = talloc_asprintf(talloc_tos(), "%s",
206 userstr = talloc_asprintf(talloc_tos(), "%s%i",
208 str_checksum(username));
209 sidstr = talloc_asprintf(talloc_tos(), "%s%i",
211 str_checksum(usersid));
218 len = strlen( userstr );
219 buf = talloc_asprintf_append(buf, "%04u%s", len, userstr);
220 len = strlen( sidstr );
221 buf = talloc_asprintf_append(buf, "%04u%s", len, sidstr);
222 len = strlen( handle->conn->connectpath );
223 buf = talloc_asprintf_append( buf, "%04u%s", len, \
224 handle->conn->connectpath );
225 len = strlen( pdb_get_domain(handle->conn->server_info->sam_account) );
226 buf = talloc_asprintf_append( buf, "%04u%s", len, \
227 pdb_get_domain(handle->conn->server_info->sam_account) );
228 timestr = talloc_asprintf(talloc_tos(), \
229 "%04d-%02d-%02d %02d:%02d:%02d.%03d", \
237 len = strlen( timestr );
238 buf = talloc_asprintf_append( buf, "%04u%s", len, timestr);
240 va_start( ap, count );
242 arg = va_arg( ap, char * );
244 * protocol v2 sends a four byte string
245 * as a header to each block, including
246 * the numbers of bytes to come in the
250 buf = talloc_asprintf_append( buf, "%04u%s", len, arg);
256 static void smb_traffic_analyzer_send_data(vfs_handle_struct *handle,
258 enum vfs_id vfs_operation )
260 struct refcounted_sock *rf_sock = NULL;
263 struct tm *tm = NULL;
266 char *username = NULL;
268 const char *anon_prefix = NULL;
269 const char *total_anonymization = NULL;
270 const char *protocol_version = NULL;
273 char state_flags[9] = "000000\0";
275 SMB_VFS_HANDLE_GET_DATA(handle, rf_sock, struct refcounted_sock, return);
277 if (rf_sock == NULL || rf_sock->sock == -1) {
278 DEBUG(1, ("smb_traffic_analyzer_send_data: socket is "
284 tv_sec = convert_timespec_to_time_t(convert_timeval_to_timespec(tv));
285 tm = localtime(&tv_sec);
289 seconds=(float) (tv.tv_usec / 1000);
292 * Check if anonymization is required, and if yes do this only if
293 * we run on protocol version 1. Anonynization for protocol v2 is
294 * handled in it's marshaller function.
296 total_anonymization=lp_parm_const_string(SNUM(handle->conn),"smb_traffic_analyzer",
297 "total_anonymization", NULL);
299 anon_prefix=lp_parm_const_string(SNUM(handle->conn),"smb_traffic_analyzer",\
300 "anonymize_prefix", NULL );
302 protocol_version = lp_parm_const_string(SNUM(handle->conn),
303 "smb_traffic_analyzer",
304 "protocol_version", NULL );
306 if (anon_prefix!=NULL && strcmp(protocol_version,"V2") != 0) {
307 if (total_anonymization!=NULL) {
308 username = talloc_asprintf(talloc_tos(),
312 username = talloc_asprintf(talloc_tos(),
316 handle->conn->server_info->sanitized_username ) );
320 username = handle->conn->server_info->sanitized_username;
327 if ( protocol_version == NULL || strcmp( protocol_version,"V1") == 0) {
329 struct rw_data *s_data = (struct rw_data *) data;
332 * in case of protocol v1, ignore any vfs operations
333 * except read,pread,write,pwrite, and set the "Write"
334 * bool accordingly, send data and return.
336 if ( vfs_operation > vfs_id_pwrite ) return;
338 if ( vfs_operation <= vfs_id_pread ) Write=false;
341 str = talloc_asprintf(talloc_tos(),
342 "V1,%u,\"%s\",\"%s\",\"%c\",\"%s\",\"%s\","
343 "\"%04d-%02d-%02d %02d:%02d:%02d.%03d\"\n",
344 (unsigned int) s_data->len,
346 pdb_get_domain(handle->conn->server_info->sam_account),
348 handle->conn->connectpath,
357 if (write_data(rf_sock->sock, str, len) != len) {
358 DEBUG(1, ("smb_traffic_analyzer_send_data_socket: "
359 "error sending V1 protocol data to socket!\n"));
363 } else if ( strcmp( protocol_version, "V2") == 0) {
365 switch( vfs_operation ) {
367 str = smb_traffic_analyzer_create_string( tm, \
368 seconds, handle, username, vfs_id_mkdir, 3,\
369 ((struct mkdir_data *) data)->path, \
370 talloc_asprintf( talloc_tos(), "%u", \
371 ((struct mkdir_data *) data)->mode), \
372 talloc_asprintf( talloc_tos(), "%u", \
373 ((struct mkdir_data *) data)->result ));
376 str = smb_traffic_analyzer_create_string( tm, \
377 seconds, handle, username, vfs_id_rmdir, 2,\
378 ((struct rmdir_data *) data)->path, \
379 talloc_asprintf( talloc_tos(), "%u", \
380 ((struct rmdir_data *) data)->result ));
382 case vfs_id_rename: ;
383 str = smb_traffic_analyzer_create_string( tm, \
384 seconds, handle, username, vfs_id_rename, 3,\
385 ((struct rename_data *) data)->src, \
386 ((struct rename_data *) data)->dst,
387 talloc_asprintf(talloc_tos(), "%u", \
388 ((struct rename_data *) data)->result));
391 str = smb_traffic_analyzer_create_string( tm, \
392 seconds, handle, username, vfs_id_chdir, 2,\
393 ((struct chdir_data *) data)->path, \
394 talloc_asprintf(talloc_tos(), "%u", \
395 ((struct chdir_data *) data)->result));
402 str = smb_traffic_analyzer_create_string( tm, \
403 seconds, handle, username, vfs_operation, 2,\
404 ((struct rw_data *) data)->filename, \
405 talloc_asprintf(talloc_tos(), "%u", \
406 ((struct rw_data *) data)->len));
409 DEBUG(1, ("smb_traffic_analyzer: error! "
410 "wrong VFS operation id detected!\n"));
415 DEBUG(1, ("smb_traffic_analyzer_send_data_socket: "
416 "error, unkown protocol given!\n"));
421 DEBUG(1, ("smb_traffic_analyzer_send_data: "
422 "unable to create string to send!\n"));
428 * If configured, optain the key and run AES encryption
433 char *akey = (char *) secrets_fetch("smb_traffic_analyzer_key", &size);
435 if ( akey != NULL ) {
436 char crypted[18], *filler, *output;
438 state_flags[2] = 'E';
439 DEBUG(10, ("smb_traffic_analyzer_send_data_socket: a key was"
440 " found, encrypting data!\n"));
442 samba_AES_set_encrypt_key(akey, 128, &key);
444 s1 = strlen(str) / 16;
445 s2 = strlen(str) % 16;
446 DEBUG(10, ("smb_traffic_analyzer_send_data_socket: found %i"
447 " blocks, %i missing bytes.\n",
449 filler = talloc_asprintf( talloc_tos(), "................" );
450 for (h = 0; h < s2; h++) {
451 *(filler+h)=*(str+(s1*16)+h);
453 DEBUG(10, ("smb_traffic_analyzer_send_data_socket: created %s"
454 " as filling block.\n", filler));
455 output = talloc_array(talloc_tos(), char, (s1*16)+17 );
457 for (h = 0; h < s1; h++) {
458 samba_AES_encrypt(str+(16*h), crypted, &key);
459 for (d = 0; d<16; d++) output[d+(16*h)]=crypted[d];
461 samba_AES_encrypt( str+(16*h), filler, &key );
462 for (d = 0;d < 16; d++) output[d+(16*h)]=*(filler+d);
464 header = talloc_asprintf( talloc_tos(), "V2.%s%017u",
467 DEBUG(10, ("smb_traffic_analyzer_send_data_socket:"
468 " header created for crypted data: %s\n", header));
469 len = strlen(header);
470 if (write_data(rf_sock->sock, header, len) != len) {
471 DEBUG(1, ("smb_traffic_analyzer_send_data_socket: "
472 "error sending the header"
473 " over the socket!\n"));
476 if (write_data(rf_sock->sock, output, len) != len) {
477 DEBUG(1, ("smb_traffic_analyzer_send_data_socket: "
478 "error sending crypted data to socket!\n"));
484 header = talloc_asprintf(talloc_tos(), "V2.%s%017u", state_flags, len);
485 DEBUG(10, ("smb_traffic_analyzer_send_data_socket: header created:"
487 len = strlen(header);
488 if (write_data(rf_sock->sock, header, len) != len) {
489 DEBUG(1, ("smb_traffic_analyzer_send_data_socket: error "
490 "sending the header over the socket!\n"));
493 DEBUG(10, ("smb_traffic_analyzer_send_data_socket: going to send "
494 "data block: %s\n",str));
495 if (write_data(rf_sock->sock, str, len) != len) {
496 DEBUG(1, ("smb_traffic_analyzer_send_data_socket: "
497 "error sending data to socket!\n"));
502 static struct refcounted_sock *sock_list;
504 static void smb_traffic_analyzer_free_data(void **pptr)
506 struct refcounted_sock *rf_sock = *(struct refcounted_sock **)pptr;
507 if (rf_sock == NULL) {
510 rf_sock->ref_count--;
511 if (rf_sock->ref_count != 0) {
514 if (rf_sock->sock != -1) {
515 close(rf_sock->sock);
517 DLIST_REMOVE(sock_list, rf_sock);
518 TALLOC_FREE(rf_sock);
521 static int smb_traffic_analyzer_connect(struct vfs_handle_struct *handle,
525 connection_struct *conn = handle->conn;
526 enum sock_type st = smb_traffic_analyzer_connMode(handle);
527 struct refcounted_sock *rf_sock = NULL;
528 const char *name = (st == UNIX_DOMAIN_SOCKET) ? LOCAL_PATHNAME :
529 lp_parm_const_string(SNUM(conn),
530 "smb_traffic_analyzer",
531 "host", "localhost");
532 uint16_t port = (st == UNIX_DOMAIN_SOCKET) ? 0 :
533 atoi( lp_parm_const_string(SNUM(conn),
534 "smb_traffic_analyzer", "port", "9430"));
535 int ret = SMB_VFS_NEXT_CONNECT(handle, service, user);
541 /* Are we already connected ? */
542 for (rf_sock = sock_list; rf_sock; rf_sock = rf_sock->next) {
543 if (port == rf_sock->port &&
544 (strcmp(name, rf_sock->name) == 0)) {
549 /* If we're connected already, just increase the
550 * reference count. */
552 rf_sock->ref_count++;
554 /* New connection. */
555 rf_sock = TALLOC_ZERO_P(NULL, struct refcounted_sock);
556 if (rf_sock == NULL) {
557 SMB_VFS_NEXT_DISCONNECT(handle);
561 rf_sock->name = talloc_strdup(rf_sock, name);
562 if (rf_sock->name == NULL) {
563 SMB_VFS_NEXT_DISCONNECT(handle);
564 TALLOC_FREE(rf_sock);
568 rf_sock->port = port;
569 rf_sock->ref_count = 1;
571 if (st == UNIX_DOMAIN_SOCKET) {
572 rf_sock->sock = smb_traffic_analyzer_connect_unix_socket(handle,
576 rf_sock->sock = smb_traffic_analyzer_connect_inet_socket(handle,
580 if (rf_sock->sock == -1) {
581 SMB_VFS_NEXT_DISCONNECT(handle);
582 TALLOC_FREE(rf_sock);
585 DLIST_ADD(sock_list, rf_sock);
588 /* Store the private data. */
589 SMB_VFS_HANDLE_SET_DATA(handle, rf_sock, smb_traffic_analyzer_free_data,
590 struct refcounted_sock, return -1);
595 static int smb_traffic_analyzer_chdir(vfs_handle_struct *handle, \
598 struct chdir_data s_data;
599 s_data.result = SMB_VFS_NEXT_CHDIR(handle, path);
601 DEBUG(10, ("smb_traffic_analyzer_chdir: CHDIR: %s\n", path));
602 smb_traffic_analyzer_send_data(handle, &s_data, vfs_id_chdir);
603 return s_data.result;
606 static int smb_traffic_analyzer_rename(vfs_handle_struct *handle, \
607 const struct smb_filename *smb_fname_src,
608 const struct smb_filename *smb_fname_dst)
610 struct rename_data s_data;
611 s_data.result = SMB_VFS_NEXT_RENAME(handle, smb_fname_src, \
613 s_data.src = smb_fname_src->base_name;
614 s_data.dst = smb_fname_dst->base_name;
615 DEBUG(10, ("smb_traffic_analyzer_rename: RENAME: %s / %s\n",
616 smb_fname_src->base_name,
617 smb_fname_dst->base_name));
618 smb_traffic_analyzer_send_data(handle, &s_data, vfs_id_rename);
619 return s_data.result;
622 static int smb_traffic_analyzer_rmdir(vfs_handle_struct *handle, \
625 struct rmdir_data s_data;
626 s_data.result = SMB_VFS_NEXT_RMDIR(handle, path);
628 DEBUG(10, ("smb_traffic_analyzer_rmdir: RMDIR: %s\n", path));
629 smb_traffic_analyzer_send_data(handle, &s_data, vfs_id_rmdir);
630 return s_data.result;
633 static int smb_traffic_analyzer_mkdir(vfs_handle_struct *handle, \
634 const char *path, mode_t mode)
636 struct mkdir_data s_data;
637 s_data.result = SMB_VFS_NEXT_MKDIR(handle, path, mode);
640 DEBUG(10, ("smb_traffic_analyzer_mkdir: MKDIR: %s\n", path));
641 smb_traffic_analyzer_send_data(handle,
644 return s_data.result;
647 static ssize_t smb_traffic_analyzer_read(vfs_handle_struct *handle, \
648 files_struct *fsp, void *data, size_t n)
650 struct rw_data s_data;
652 s_data.len = SMB_VFS_NEXT_READ(handle, fsp, data, n);
653 s_data.filename = fsp->fsp_name->base_name;
654 DEBUG(10, ("smb_traffic_analyzer_read: READ: %s\n", fsp_str_dbg(fsp)));
656 smb_traffic_analyzer_send_data(handle,
663 static ssize_t smb_traffic_analyzer_pread(vfs_handle_struct *handle, \
664 files_struct *fsp, void *data, size_t n, SMB_OFF_T offset)
666 struct rw_data s_data;
668 s_data.len = SMB_VFS_NEXT_PREAD(handle, fsp, data, n, offset);
669 s_data.filename = fsp->fsp_name->base_name;
670 DEBUG(10, ("smb_traffic_analyzer_pread: PREAD: %s\n",
673 smb_traffic_analyzer_send_data(handle,
680 static ssize_t smb_traffic_analyzer_write(vfs_handle_struct *handle, \
681 files_struct *fsp, const void *data, size_t n)
683 struct rw_data s_data;
685 s_data.len = SMB_VFS_NEXT_WRITE(handle, fsp, data, n);
686 s_data.filename = fsp->fsp_name->base_name;
687 DEBUG(10, ("smb_traffic_analyzer_write: WRITE: %s\n",
690 smb_traffic_analyzer_send_data(handle,
696 static ssize_t smb_traffic_analyzer_pwrite(vfs_handle_struct *handle, \
697 files_struct *fsp, const void *data, size_t n, SMB_OFF_T offset)
699 struct rw_data s_data;
701 s_data.len = SMB_VFS_NEXT_PWRITE(handle, fsp, data, n, offset);
702 s_data.filename = fsp->fsp_name->base_name;
703 DEBUG(10, ("smb_traffic_analyzer_pwrite: PWRITE: %s\n", \
706 smb_traffic_analyzer_send_data(handle,
712 static struct vfs_fn_pointers vfs_smb_traffic_analyzer_fns = {
713 .connect_fn = smb_traffic_analyzer_connect,
714 .vfs_read = smb_traffic_analyzer_read,
715 .pread = smb_traffic_analyzer_pread,
716 .write = smb_traffic_analyzer_write,
717 .pwrite = smb_traffic_analyzer_pwrite,
718 .mkdir = smb_traffic_analyzer_mkdir,
719 .rename = smb_traffic_analyzer_rename,
720 .chdir = smb_traffic_analyzer_chdir
723 /* Module initialization */
724 NTSTATUS vfs_smb_traffic_analyzer_init(void)
726 NTSTATUS ret = smb_register_vfs(SMB_VFS_INTERFACE_VERSION,
727 "smb_traffic_analyzer",
728 &vfs_smb_traffic_analyzer_fns);
730 if (!NT_STATUS_IS_OK(ret)) {
734 vfs_smb_traffic_analyzer_debug_level =
735 debug_add_class("smb_traffic_analyzer");
737 if (vfs_smb_traffic_analyzer_debug_level == -1) {
738 vfs_smb_traffic_analyzer_debug_level = DBGC_VFS;
739 DEBUG(1, ("smb_traffic_analyzer_init: Couldn't register custom"
740 "debugging class!\n"));
742 DEBUG(3, ("smb_traffic_analyzer_init: Debug class number of"
743 "'smb_traffic_analyzer': %d\n", \
744 vfs_smb_traffic_analyzer_debug_level));