According to the linux kernel coding styleguide, it's better to
[Samba/nascimento.git] / source3 / modules / vfs_smb_traffic_analyzer.c
blob26b7dc64cc3a4e5080bd81e1aa2bfb9c03e40f45
1 /*
2 * traffic-analyzer VFS module. Measure the smb traffic users create
3 * on the net.
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/>.
22 #include "includes.h"
23 #include "../lib/crypto/crypto.h"
25 /* abstraction for the send_over_network function */
26 enum sock_type {INTERNET_SOCKET = 0, UNIX_DOMAIN_SOCKET};
28 #define LOCAL_PATHNAME "/var/tmp/stadsocket"
30 /* VFS Functions identifier table. In protocol version 2, every vfs */
31 /* function is given a unique id. */
32 enum vfs_id {
33 /* care for the order here, required for compatibility */
34 /* with protocol version 1. */
35 vfs_id_read,
36 vfs_id_pread,
37 vfs_id_write,
38 vfs_id_pwrite,
39 /* end of protocol version 1 identifiers. */
40 vfs_id_mkdir,
41 vfs_id_rmdir,
42 vfs_id_rename,
43 vfs_id_chdir
46 /* Specific data sets for the VFS functions. */
48 struct mkdir_data {
49 const char *path;
50 mode_t mode;
51 int result;
54 struct rmdir_data {
55 const char *path;
56 int result;
59 struct rename_data {
60 const char *src;
61 const char *dst;
62 int result;
65 struct chdir_data {
66 const char *path;
67 int result;
70 /* rw_data used for read/write/pread/pwrite */
71 struct rw_data {
72 char *filename;
73 size_t len;
77 static int vfs_smb_traffic_analyzer_debug_level = DBGC_VFS;
79 static enum sock_type smb_traffic_analyzer_connMode(vfs_handle_struct *handle)
81 connection_struct *conn = handle->conn;
82 const char *Mode;
83 Mode=lp_parm_const_string(SNUM(conn), "smb_traffic_analyzer","mode", \
84 "internet_socket");
85 if (strstr(Mode,"unix_domain_socket")) {
86 return UNIX_DOMAIN_SOCKET;
87 } else {
88 return INTERNET_SOCKET;
93 /* Connect to an internet socket */
95 static int smb_traffic_analyzer_connect_inet_socket(vfs_handle_struct *handle,
96 const char *name, uint16_t port)
98 /* Create a streaming Socket */
99 int sockfd = -1;
100 struct addrinfo hints;
101 struct addrinfo *ailist = NULL;
102 struct addrinfo *res = NULL;
103 int ret;
105 ZERO_STRUCT(hints);
106 /* By default make sure it supports TCP. */
107 hints.ai_socktype = SOCK_STREAM;
108 hints.ai_flags = AI_ADDRCONFIG;
110 ret = getaddrinfo(name,
111 NULL,
112 &hints,
113 &ailist);
115 if (ret) {
116 DEBUG(3,("smb_traffic_analyzer_connect_inet_socket: "
117 "getaddrinfo failed for name %s [%s]\n",
118 name,
119 gai_strerror(ret) ));
120 return -1;
123 DEBUG(3,("smb_traffic_analyzer: Internet socket mode. Hostname: %s,"
124 "Port: %i\n", name, port));
126 for (res = ailist; res; res = res->ai_next) {
127 struct sockaddr_storage ss;
128 NTSTATUS status;
130 if (!res->ai_addr || res->ai_addrlen == 0) {
131 continue;
134 ZERO_STRUCT(ss);
135 memcpy(&ss, res->ai_addr, res->ai_addrlen);
137 status = open_socket_out(&ss, port, 10000, &sockfd);
138 if (NT_STATUS_IS_OK(status)) {
139 break;
143 if (ailist) {
144 freeaddrinfo(ailist);
147 if (sockfd == -1) {
148 DEBUG(1, ("smb_traffic_analyzer: unable to create "
149 "socket, error is %s",
150 strerror(errno)));
151 return -1;
154 return sockfd;
157 /* Connect to a unix domain socket */
159 static int smb_traffic_analyzer_connect_unix_socket(vfs_handle_struct *handle,
160 const char *name)
162 /* Create the socket to stad */
163 int len, sock;
164 struct sockaddr_un remote;
166 DEBUG(7, ("smb_traffic_analyzer_connect_unix_socket: "
167 "Unix domain socket mode. Using %s\n",
168 name ));
170 if ((sock = socket(AF_UNIX, SOCK_STREAM, 0)) == -1) {
171 DEBUG(1, ("smb_traffic_analyzer_connect_unix_socket: "
172 "Couldn't create socket, "
173 "make sure stad is running!\n"));
174 return -1;
176 remote.sun_family = AF_UNIX;
177 strlcpy(remote.sun_path, name,
178 sizeof(remote.sun_path));
179 len=strlen(remote.sun_path) + sizeof(remote.sun_family);
180 if (connect(sock, (struct sockaddr *)&remote, len) == -1 ) {
181 DEBUG(1, ("smb_traffic_analyzer_connect_unix_socket: "
182 "Could not connect to "
183 "socket, make sure\nstad is running!\n"));
184 close(sock);
185 return -1;
187 return sock;
190 /* Private data allowing shared connection sockets. */
192 struct refcounted_sock {
193 struct refcounted_sock *next, *prev;
194 char *name;
195 uint16_t port;
196 int sock;
197 unsigned int ref_count;
201 /* The marshaller for the protocol version 2. */
202 static char *smb_traffic_analyzer_create_string( struct tm *tm, \
203 int seconds, vfs_handle_struct *handle, \
204 char *username, int count, ... )
207 va_list ap;
208 char *arg = NULL;
209 char *str = NULL;
210 int len;
211 char *header = NULL;
212 char *buf = NULL;
213 char *timestr = NULL;
215 /* first create the data that is transfered with any VFS op */
216 len = strlen( username );
217 buf = talloc_asprintf(talloc_tos(),"%04u%s", len, username);
218 len = strlen( handle->conn->connectpath );
219 buf = talloc_asprintf_append( buf, "%04u%s", len, \
220 handle->conn->connectpath );
221 len = strlen( pdb_get_domain(handle->conn->server_info->sam_account) );
222 buf = talloc_asprintf_append( buf, "%04u%s", len, \
223 pdb_get_domain(handle->conn->server_info->sam_account) );
224 timestr = talloc_asprintf(talloc_tos(), \
225 "%04d-%02d-%02d %02d:%02d:%02d.%03d", \
226 tm->tm_year+1900, \
227 tm->tm_mon+1, \
228 tm->tm_mday, \
229 tm->tm_hour, \
230 tm->tm_min, \
231 tm->tm_sec, \
232 (int)seconds);
233 len = strlen( timestr );
234 buf = talloc_asprintf_append( buf, "%04u%s", len, timestr);
236 va_start( ap, count );
237 while ( count-- ) {
238 arg = va_arg( ap, char * );
239 /* protocol v2 sends a four byte string */
240 /* as a header to each block, including */
241 /* the numbers of bytes to come in the */
242 /* next string. */
243 len = strlen( arg );
244 buf = talloc_asprintf_append( buf, "%04u%s", len, arg);
246 va_end( ap );
248 /* now create the protocol v2 header. */
249 len = strlen( buf );
250 str = talloc_asprintf_append( str, "V2,%017u%s", len, buf);
251 DEBUG(10, ("smb_traffic_analyzer_create_string: %s\n",str));
252 return str;
255 static void smb_traffic_analyzer_send_data(vfs_handle_struct *handle,
256 void *data,
257 enum vfs_id vfs_operation )
259 struct refcounted_sock *rf_sock = NULL;
260 struct timeval tv;
261 time_t tv_sec;
262 struct tm *tm = NULL;
263 int seconds;
264 char *str = NULL;
265 char *username = NULL;
266 const char *anon_prefix = NULL;
267 const char *total_anonymization = NULL;
268 const char *protocol_version = NULL;
269 bool Write = false;
270 size_t len;
272 SMB_VFS_HANDLE_GET_DATA(handle, rf_sock, struct refcounted_sock, return);
274 if (rf_sock == NULL || rf_sock->sock == -1) {
275 DEBUG(1, ("smb_traffic_analyzer_send_data: socket is "
276 "closed\n"));
277 return;
280 GetTimeOfDay(&tv);
281 tv_sec = convert_timespec_to_time_t(convert_timeval_to_timespec(tv));
282 tm = localtime(&tv_sec);
283 if (!tm) {
284 return;
286 seconds=(float) (tv.tv_usec / 1000);
288 /* check if anonymization is required */
290 total_anonymization=lp_parm_const_string(SNUM(handle->conn),"smb_traffic_analyzer",
291 "total_anonymization", NULL);
293 anon_prefix=lp_parm_const_string(SNUM(handle->conn),"smb_traffic_analyzer",\
294 "anonymize_prefix", NULL );
295 if (anon_prefix!=NULL) {
296 if (total_anonymization!=NULL) {
297 username = talloc_asprintf(talloc_tos(),
298 "%s",
299 anon_prefix);
300 } else {
301 username = talloc_asprintf(talloc_tos(),
302 "%s%i",
303 anon_prefix,
304 str_checksum(
305 handle->conn->server_info->sanitized_username ) );
308 } else {
309 username = handle->conn->server_info->sanitized_username;
312 if (!username) {
313 return;
316 protocol_version = lp_parm_const_string(SNUM(handle->conn),
317 "smb_traffic_analyzer",
318 "protocol_version", NULL );
320 if ( protocol_version == NULL || strcmp( protocol_version,"V1") == 0) {
322 struct rw_data *s_data = (struct rw_data *) data;
324 /* in case of protocol v1, ignore any vfs operations */
325 /* except read,pread,write,pwrite, and set the "Write" */
326 /* bool accordingly. */
328 if ( vfs_operation > vfs_id_pwrite ) return;
330 if ( vfs_operation <= vfs_id_pread ) Write=false;
331 else Write=true;
333 str = talloc_asprintf(talloc_tos(),
334 "V1,%u,\"%s\",\"%s\",\"%c\",\"%s\",\"%s\","
335 "\"%04d-%02d-%02d %02d:%02d:%02d.%03d\"\n",
336 (unsigned int) s_data->len,
337 username,
338 pdb_get_domain(handle->conn->server_info->sam_account),
339 Write ? 'W' : 'R',
340 handle->conn->connectpath,
341 s_data->filename,
342 tm->tm_year+1900,
343 tm->tm_mon+1,
344 tm->tm_mday,
345 tm->tm_hour,
346 tm->tm_min,
347 tm->tm_sec,
348 (int)seconds);
349 } else if ( strcmp( protocol_version, "V2") == 0) {
351 switch( vfs_operation ) {
352 case vfs_id_mkdir: ;
353 str = smb_traffic_analyzer_create_string( tm, \
354 seconds, handle, username, 3,\
355 ((struct mkdir_data *) data)->path, \
356 talloc_asprintf( talloc_tos(), "%u", \
357 ((struct mkdir_data *) data)->mode), \
358 talloc_asprintf( talloc_tos(), "%u", \
359 ((struct mkdir_data *) data)->result ));
360 break;
361 case vfs_id_rmdir: ;
362 str = smb_traffic_analyzer_create_string( tm, \
363 seconds, handle, username, 2,\
364 ((struct rmdir_data *) data)->path, \
365 talloc_asprintf( talloc_tos(), "%u", \
366 ((struct rmdir_data *) data)->result ));
367 break;
368 case vfs_id_rename: ;
369 str = smb_traffic_analyzer_create_string( tm, \
370 seconds, handle, username, 3,\
371 ((struct rename_data *) data)->src, \
372 ((struct rename_data *) data)->dst,
373 talloc_asprintf(talloc_tos(), "%u", \
374 ((struct rename_data *) data)->result));
375 break;
376 case vfs_id_chdir: ;
377 str = smb_traffic_analyzer_create_string( tm, \
378 seconds, handle, username, 2,\
379 ((struct chdir_data *) data)->path, \
380 talloc_asprintf(talloc_tos(), "%u", \
381 ((struct chdir_data *) data)->result));
382 break;
384 case vfs_id_write:
385 case vfs_id_pwrite:
386 case vfs_id_read:
387 case vfs_id_pread: ;
388 str = smb_traffic_analyzer_create_string( tm, \
389 seconds, handle, username, 2,\
390 ((struct rw_data *) data)->filename, \
391 talloc_asprintf(talloc_tos(), "%u", \
392 ((struct rw_data *) data)->len));
393 break;
394 default:
395 DEBUG(1, ("smb_traffic_analyzer: error! "
396 "wrong VFS operation id detected!\n"));
397 return;
400 } else {
401 DEBUG(1, ("smb_traffic_analyzer_send_data_socket: "
402 "error, unkown protocol given!\n"));
403 return;
406 if (!str) {
407 DEBUG(1, ("smb_traffic_analyzer_send_data: "
408 "unable to create string to send!\n"));
409 return;
412 len = strlen(str);
414 DEBUG(10, ("smb_traffic_analyzer_send_data_socket: going to send "
415 "%s\n", str));
416 /* If configured, optain the key and run AES encryption */
417 /* over the data. */
418 size_t size;
419 char *akey = secrets_fetch("smb_traffic_analyzer_key", &size);
420 if ( akey != NULL ) {
421 char *crypted;
422 DEBUG(10, ("smb_traffic_analyzer: a key was found, encrypting "
423 "data!"));
424 AES_KEY *key;
425 samba_AES_set_encrypt_key(akey, 128, key);
426 samba_AES_encrypt( str, crypted, key );
427 len = strlen( crypted );
428 if (write_data(rf_sock->sock, crypted, len) != len) {
429 DEBUG(1, ("smb_traffic_analyzer_send_data_socket: "
430 "error sending crypted data to socket!\n"));
431 free( crypted );
432 return ;
435 if (write_data(rf_sock->sock, str, len) != len) {
436 DEBUG(1, ("smb_traffic_analyzer_send_data_socket: "
437 "error sending data to socket!\n"));
438 return ;
442 static struct refcounted_sock *sock_list;
444 static void smb_traffic_analyzer_free_data(void **pptr)
446 struct refcounted_sock *rf_sock = *(struct refcounted_sock **)pptr;
447 if (rf_sock == NULL) {
448 return;
450 rf_sock->ref_count--;
451 if (rf_sock->ref_count != 0) {
452 return;
454 if (rf_sock->sock != -1) {
455 close(rf_sock->sock);
457 DLIST_REMOVE(sock_list, rf_sock);
458 TALLOC_FREE(rf_sock);
461 static int smb_traffic_analyzer_connect(struct vfs_handle_struct *handle,
462 const char *service,
463 const char *user)
465 connection_struct *conn = handle->conn;
466 enum sock_type st = smb_traffic_analyzer_connMode(handle);
467 struct refcounted_sock *rf_sock = NULL;
468 const char *name = (st == UNIX_DOMAIN_SOCKET) ? LOCAL_PATHNAME :
469 lp_parm_const_string(SNUM(conn),
470 "smb_traffic_analyzer",
471 "host", "localhost");
472 uint16_t port = (st == UNIX_DOMAIN_SOCKET) ? 0 :
473 atoi( lp_parm_const_string(SNUM(conn),
474 "smb_traffic_analyzer", "port", "9430"));
475 int ret = SMB_VFS_NEXT_CONNECT(handle, service, user);
477 if (ret < 0) {
478 return ret;
481 /* Are we already connected ? */
482 for (rf_sock = sock_list; rf_sock; rf_sock = rf_sock->next) {
483 if (port == rf_sock->port &&
484 (strcmp(name, rf_sock->name) == 0)) {
485 break;
489 /* If we're connected already, just increase the
490 * reference count. */
491 if (rf_sock) {
492 rf_sock->ref_count++;
493 } else {
494 /* New connection. */
495 rf_sock = TALLOC_ZERO_P(NULL, struct refcounted_sock);
496 if (rf_sock == NULL) {
497 SMB_VFS_NEXT_DISCONNECT(handle);
498 errno = ENOMEM;
499 return -1;
501 rf_sock->name = talloc_strdup(rf_sock, name);
502 if (rf_sock->name == NULL) {
503 SMB_VFS_NEXT_DISCONNECT(handle);
504 TALLOC_FREE(rf_sock);
505 errno = ENOMEM;
506 return -1;
508 rf_sock->port = port;
509 rf_sock->ref_count = 1;
511 if (st == UNIX_DOMAIN_SOCKET) {
512 rf_sock->sock = smb_traffic_analyzer_connect_unix_socket(handle,
513 name);
514 } else {
516 rf_sock->sock = smb_traffic_analyzer_connect_inet_socket(handle,
517 name,
518 port);
520 if (rf_sock->sock == -1) {
521 SMB_VFS_NEXT_DISCONNECT(handle);
522 TALLOC_FREE(rf_sock);
523 return -1;
525 DLIST_ADD(sock_list, rf_sock);
528 /* Store the private data. */
529 SMB_VFS_HANDLE_SET_DATA(handle, rf_sock, smb_traffic_analyzer_free_data,
530 struct refcounted_sock, return -1);
531 return 0;
534 /* VFS Functions */
535 static int smb_traffic_analyzer_chdir(vfs_handle_struct *handle, \
536 const char *path)
538 struct chdir_data s_data;
539 s_data.result = SMB_VFS_NEXT_CHDIR(handle, path);
540 s_data.path = path;
541 DEBUG(10, ("smb_traffic_analyzer_chdir: CHDIR: %s\n", path));
542 smb_traffic_analyzer_send_data(handle, &s_data, vfs_id_chdir);
543 return s_data.result;
546 static int smb_traffic_analyzer_rename(vfs_handle_struct *handle, \
547 const struct smb_filename *smb_fname_src,
548 const struct smb_filename *smb_fname_dst)
550 struct rename_data s_data;
551 s_data.result = SMB_VFS_NEXT_RENAME(handle, smb_fname_src, \
552 smb_fname_dst);
553 s_data.src = smb_fname_src->base_name;
554 s_data.dst = smb_fname_dst->base_name;
555 DEBUG(10, ("smb_traffic_analyzer_rename: RENAME: %s / %s\n",
556 smb_fname_src->base_name,
557 smb_fname_dst->base_name));
558 smb_traffic_analyzer_send_data(handle, &s_data, vfs_id_rename);
559 return s_data.result;
562 static int smb_traffic_analyzer_rmdir(vfs_handle_struct *handle, \
563 const char *path)
565 struct rmdir_data s_data;
566 s_data.result = SMB_VFS_NEXT_RMDIR(handle, path);
567 s_data.path = path;
568 DEBUG(10, ("smb_traffic_analyzer_rmdir: RMDIR: %s\n", path));
569 smb_traffic_analyzer_send_data(handle, &s_data, vfs_id_rmdir);
570 return s_data.result;
573 static int smb_traffic_analyzer_mkdir(vfs_handle_struct *handle, \
574 const char *path, mode_t mode)
576 struct mkdir_data s_data;
577 s_data.result = SMB_VFS_NEXT_MKDIR(handle, path, mode);
578 s_data.path = path;
579 s_data.mode = mode;
580 DEBUG(10, ("smb_traffic_analyzer_mkdir: MKDIR: %s\n", path));
581 smb_traffic_analyzer_send_data(handle,
582 &s_data,
583 vfs_id_mkdir);
584 return s_data.result;
587 static ssize_t smb_traffic_analyzer_read(vfs_handle_struct *handle, \
588 files_struct *fsp, void *data, size_t n)
590 struct rw_data s_data;
592 s_data.len = SMB_VFS_NEXT_READ(handle, fsp, data, n);
593 s_data.filename = fsp->fsp_name->base_name;
594 DEBUG(10, ("smb_traffic_analyzer_read: READ: %s\n", fsp_str_dbg(fsp)));
596 smb_traffic_analyzer_send_data(handle,
597 &s_data,
598 vfs_id_read);
599 return s_data.len;
603 static ssize_t smb_traffic_analyzer_pread(vfs_handle_struct *handle, \
604 files_struct *fsp, void *data, size_t n, SMB_OFF_T offset)
606 struct rw_data s_data;
608 s_data.len = SMB_VFS_NEXT_PREAD(handle, fsp, data, n, offset);
609 s_data.filename = fsp->fsp_name->base_name;
610 DEBUG(10, ("smb_traffic_analyzer_pread: PREAD: %s\n",
611 fsp_str_dbg(fsp)));
613 smb_traffic_analyzer_send_data(handle,
614 &s_data,
615 vfs_id_pread);
617 return s_data.len;
620 static ssize_t smb_traffic_analyzer_write(vfs_handle_struct *handle, \
621 files_struct *fsp, const void *data, size_t n)
623 struct rw_data s_data;
625 s_data.len = SMB_VFS_NEXT_WRITE(handle, fsp, data, n);
626 s_data.filename = fsp->fsp_name->base_name;
627 DEBUG(10, ("smb_traffic_analyzer_write: WRITE: %s\n",
628 fsp_str_dbg(fsp)));
630 smb_traffic_analyzer_send_data(handle,
631 &s_data,
632 vfs_id_write);
633 return s_data.len;
636 static ssize_t smb_traffic_analyzer_pwrite(vfs_handle_struct *handle, \
637 files_struct *fsp, const void *data, size_t n, SMB_OFF_T offset)
639 struct rw_data s_data;
641 s_data.len = SMB_VFS_NEXT_PWRITE(handle, fsp, data, n, offset);
642 s_data.filename = fsp->fsp_name->base_name;
643 DEBUG(10, ("smb_traffic_analyzer_pwrite: PWRITE: %s\n", \
644 fsp_str_dbg(fsp)));
646 smb_traffic_analyzer_send_data(handle,
647 &s_data,
648 vfs_id_pwrite);
649 return s_data.len;
652 static struct vfs_fn_pointers vfs_smb_traffic_analyzer_fns = {
653 .connect_fn = smb_traffic_analyzer_connect,
654 .vfs_read = smb_traffic_analyzer_read,
655 .pread = smb_traffic_analyzer_pread,
656 .write = smb_traffic_analyzer_write,
657 .pwrite = smb_traffic_analyzer_pwrite,
658 .mkdir = smb_traffic_analyzer_mkdir,
659 .rename = smb_traffic_analyzer_rename,
660 .chdir = smb_traffic_analyzer_chdir
663 /* Module initialization */
665 NTSTATUS vfs_smb_traffic_analyzer_init(void)
667 NTSTATUS ret = smb_register_vfs(SMB_VFS_INTERFACE_VERSION,
668 "smb_traffic_analyzer",
669 &vfs_smb_traffic_analyzer_fns);
671 if (!NT_STATUS_IS_OK(ret)) {
672 return ret;
675 vfs_smb_traffic_analyzer_debug_level =
676 debug_add_class("smb_traffic_analyzer");
678 if (vfs_smb_traffic_analyzer_debug_level == -1) {
679 vfs_smb_traffic_analyzer_debug_level = DBGC_VFS;
680 DEBUG(1, ("smb_traffic_analyzer_init: Couldn't register custom"
681 "debugging class!\n"));
682 } else {
683 DEBUG(3, ("smb_traffic_analyzer_init: Debug class number of"
684 "'smb_traffic_analyzer': %d\n", \
685 vfs_smb_traffic_analyzer_debug_level));
688 return ret;