source3/modules/vfs_smb_traffic_analyzer.c

   1 /*
   2  * traffic-analyzer VFS module. Measure the smb traffic users create
   3  * on the net.
   4  *
   5  * Copyright (C) Holger Hetterich, 2008
   6  * Copyright (C) Jeremy Allison, 2008
   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
  24 /* abstraction for the send_over_network function */
  25
  26 enum sock_type {INTERNET_SOCKET = 0, UNIX_DOMAIN_SOCKET};
  27
  28 #define LOCAL_PATHNAME "/var/tmp/stadsocket"
  29
  30 static int vfs_smb_traffic_analyzer_debug_level = DBGC_VFS;
  31
  32 static enum sock_type smb_traffic_analyzer_connMode(vfs_handle_struct *handle)
  33 {
  34         connection_struct *conn = handle->conn;
  35         const char *Mode;
  36         Mode=lp_parm_const_string(SNUM(conn), "smb_traffic_analyzer","mode", \
  37                         "internet_socket");
  38         if (strstr(Mode,"unix_domain_socket")) {
  39                 return UNIX_DOMAIN_SOCKET;
  40         } else {
  41                 return INTERNET_SOCKET;
  42         }
  43 }
  44
  45
  46 /* Connect to an internet socket */
  47
  48 static int smb_traffic_analyzer_connect_inet_socket(vfs_handle_struct *handle,
  49                                         const char *name, uint16_t port)
  50 {
  51         /* Create a streaming Socket */
  52         int sockfd = -1;
  53         struct addrinfo hints;
  54         struct addrinfo *ailist = NULL;
  55         struct addrinfo *res = NULL;
  56         int ret;
  57
  58         ZERO_STRUCT(hints);
  59         /* By default make sure it supports TCP. */
  60         hints.ai_socktype = SOCK_STREAM;
  61         hints.ai_flags = AI_ADDRCONFIG;
  62
  63         ret = getaddrinfo(name,
  64                         NULL,
  65                         &hints,
  66                         &ailist);
  67
  68         if (ret) {
  69                 DEBUG(3,("smb_traffic_analyzer_connect_inet_socket: "
  70                         "getaddrinfo failed for name %s [%s]\n",
  71                         name,
  72                         gai_strerror(ret) ));
  73                 return -1;
  74         }
  75
  76         DEBUG(3,("smb_traffic_analyzer: Internet socket mode. Hostname: %s,"
  77                 "Port: %i\n", name, port));
  78
  79         for (res = ailist; res; res = res->ai_next) {
  80                 struct sockaddr_storage ss;
  81
  82                 if (!res->ai_addr || res->ai_addrlen == 0) {
  83                         continue;
  84                 }
  85
  86                 ZERO_STRUCT(ss);
  87                 memcpy(&ss, res->ai_addr, res->ai_addrlen);
  88
  89                 sockfd = open_socket_out(SOCK_STREAM, &ss, port, 10000);
  90                 if (sockfd != -1) {
  91                         break;
  92                 }
  93         }
  94
  95         if (ailist) {
  96                 freeaddrinfo(ailist);
  97         }
  98
  99         if (sockfd == -1) {
 100                 DEBUG(1, ("smb_traffic_analyzer: unable to create "
 101                         "socket, error is %s",
 102                         strerror(errno)));
 103                 return -1;
 104         }
 105
 106         return sockfd;
 107 }
 108
 109 /* Connect to a unix domain socket */
 110
 111 static int smb_traffic_analyzer_connect_unix_socket(vfs_handle_struct *handle,
 112                                                 const char *name)
 113 {
 114         /* Create the socket to stad */
 115         int len, sock;
 116         struct sockaddr_un remote;
 117
 118         DEBUG(7, ("smb_traffic_analyzer_connect_unix_socket: "
 119                         "Unix domain socket mode. Using %s\n",
 120                         name ));
 121
 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"));
 126                 return -1;
 127         }
 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"));
 136                 close(sock);
 137                 return -1;
 138         }
 139         return sock;
 140 }
 141
 142 /* Private data allowing shared connection sockets. */
 143
 144 struct refcounted_sock {
 145         struct refcounted_sock *next, *prev;
 146         char *name;
 147         uint16_t port;
 148         int sock;
 149         unsigned int ref_count;
 150 };
 151
 152 /* Send data over a socket */
 153
 154 static void smb_traffic_analyzer_send_data(vfs_handle_struct *handle,
 155                                         ssize_t result,
 156                                         const char *file_name,
 157                                         bool Write)
 158 {
 159         struct refcounted_sock *rf_sock = NULL;
 160         struct timeval tv;
 161         time_t tv_sec;
 162         struct tm *tm = NULL;
 163         int seconds;
 164         char *str = NULL;
 165         char *username = NULL;
 166         const char *anon_prefix = NULL;
 167         size_t len;
 168
 169         SMB_VFS_HANDLE_GET_DATA(handle, rf_sock, struct refcounted_sock, return);
 170
 171         if (rf_sock == NULL || rf_sock->sock == -1) {
 172                 DEBUG(1, ("smb_traffic_analyzer_send_data: socket is "
 173                         "closed\n"));
 174                 return;
 175         }
 176
 177         GetTimeOfDay(&tv);
 178         tv_sec = convert_timespec_to_time_t(convert_timeval_to_timespec(tv));
 179         tm = localtime(&tv_sec);
 180         if (!tm) {
 181                 return;
 182         }
 183         seconds=(float) (tv.tv_usec / 1000);
 184
 185         /* check if anonymization is required */
 186
 187         anon_prefix=lp_parm_const_string(SNUM(handle->conn),"smb_traffic_analyzer",\
 188                                         "anonymize_prefix", NULL );
 189         if (anon_prefix!=NULL) {
 190                 username = talloc_asprintf(talloc_tos(),
 191                         "%s%i",
 192                         anon_prefix,
 193                         str_checksum(
 194                                 handle->conn->server_info->sanitized_username ) );
 195         } else {
 196                 username = handle->conn->server_info->sanitized_username;
 197         }
 198
 199         if (!username) {
 200                 return;
 201         }
 202
 203         str = talloc_asprintf(talloc_tos(),
 204                         "V1,%u,\"%s\",\"%s\",\"%c\",\"%s\",\"%s\","
 205                         "\"%04d-%02d-%02d %02d:%02d:%02d.%03d\"\n",
 206                         (unsigned int)result,
 207                         username,
 208                         pdb_get_domain(handle->conn->server_info->sam_account),
 209                         Write ? 'W' : 'R',
 210                         handle->conn->connectpath,
 211                         file_name,
 212                         tm->tm_year+1900,
 213                         tm->tm_mon+1,
 214                         tm->tm_mday,
 215                         tm->tm_hour,
 216                         tm->tm_min,
 217                         tm->tm_sec,
 218                         (int)seconds);
 219
 220         if (!str) {
 221                 return;
 222         }
 223
 224         len = strlen(str);
 225
 226         DEBUG(10, ("smb_traffic_analyzer_send_data_socket: sending %s\n",
 227                         str));
 228         if (write_data(rf_sock->sock, str, len) != len) {
 229                 DEBUG(1, ("smb_traffic_analyzer_send_data_socket: "
 230                         "error sending data to socket!\n"));
 231                 return ;
 232         }
 233 }
 234
 235 static struct refcounted_sock *sock_list;
 236
 237 static void smb_traffic_analyzer_free_data(void **pptr)
 238 {
 239         struct refcounted_sock *rf_sock = *(struct refcounted_sock **)pptr;
 240         if (rf_sock == NULL) {
 241                 return;
 242         }
 243         rf_sock->ref_count--;
 244         if (rf_sock->ref_count != 0) {
 245                 return;
 246         }
 247         if (rf_sock->sock != -1) {
 248                 close(rf_sock->sock);
 249         }
 250         DLIST_REMOVE(sock_list, rf_sock);
 251         TALLOC_FREE(rf_sock);
 252 }
 253
 254 static int smb_traffic_analyzer_connect(struct vfs_handle_struct *handle,
 255                          const char *service,
 256                          const char *user)
 257 {
 258         connection_struct *conn = handle->conn;
 259         enum sock_type st = smb_traffic_analyzer_connMode(handle);
 260         struct refcounted_sock *rf_sock = NULL;
 261         const char *name = (st == UNIX_DOMAIN_SOCKET) ? LOCAL_PATHNAME :
 262                                 lp_parm_const_string(SNUM(conn),
 263                                         "smb_traffic_analyzer",
 264                                 "host", "localhost");
 265         uint16_t port = (st == UNIX_DOMAIN_SOCKET) ? 0 :
 266                                 atoi( lp_parm_const_string(SNUM(conn),
 267                                 "smb_traffic_analyzer", "port", "9430"));
 268
 269         /* Are we already connected ? */
 270         for (rf_sock = sock_list; rf_sock; rf_sock = rf_sock->next) {
 271                 if (port == rf_sock->port &&
 272                                 (strcmp(name, rf_sock->name) == 0)) {
 273                         break;
 274                 }
 275         }
 276
 277         /* If we're connected already, just increase the
 278          * reference count. */
 279         if (rf_sock) {
 280                 rf_sock->ref_count++;
 281         } else {
 282                 /* New connection. */
 283                 rf_sock = TALLOC_ZERO_P(NULL, struct refcounted_sock);
 284                 if (rf_sock == NULL) {
 285                         errno = ENOMEM;
 286                         return -1;
 287                 }
 288                 rf_sock->name = talloc_strdup(rf_sock, name);
 289                 if (rf_sock->name == NULL) {
 290                         TALLOC_FREE(rf_sock);
 291                         errno = ENOMEM;
 292                         return -1;
 293                 }
 294                 rf_sock->port = port;
 295                 rf_sock->ref_count = 1;
 296
 297                 if (st == UNIX_DOMAIN_SOCKET) {
 298                         rf_sock->sock = smb_traffic_analyzer_connect_unix_socket(handle,
 299                                                         name);
 300                 } else {
 301
 302                         rf_sock->sock = smb_traffic_analyzer_connect_inet_socket(handle,
 303                                                         name,
 304                                                         port);
 305                 }
 306                 if (rf_sock->sock == -1) {
 307                         TALLOC_FREE(rf_sock);
 308                         return -1;
 309                 }
 310                 DLIST_ADD(sock_list, rf_sock);
 311         }
 312
 313         /* Store the private data. */
 314         SMB_VFS_HANDLE_SET_DATA(handle, rf_sock, smb_traffic_analyzer_free_data,
 315                                 struct refcounted_sock, return -1);
 316         return SMB_VFS_NEXT_CONNECT(handle, service, user);
 317 }
 318
 319 /* VFS Functions: write, read, pread, pwrite for now */
 320
 321 static ssize_t smb_traffic_analyzer_read(vfs_handle_struct *handle, \
 322                                 files_struct *fsp, void *data, size_t n)
 323 {
 324         ssize_t result;
 325
 326         result = SMB_VFS_NEXT_READ(handle, fsp, data, n);
 327         DEBUG(10, ("smb_traffic_analyzer_read: READ: %s\n", fsp->fsp_name ));
 328
 329         smb_traffic_analyzer_send_data(handle,
 330                         result,
 331                         fsp->fsp_name,
 332                         false);
 333         return result;
 334 }
 335
 336
 337 static ssize_t smb_traffic_analyzer_pread(vfs_handle_struct *handle, \
 338                 files_struct *fsp, void *data, size_t n, SMB_OFF_T offset)
 339 {
 340         ssize_t result;
 341
 342         result = SMB_VFS_NEXT_PREAD(handle, fsp, data, n, offset);
 343
 344         DEBUG(10, ("smb_traffic_analyzer_pread: PREAD: %s\n", fsp->fsp_name ));
 345
 346         smb_traffic_analyzer_send_data(handle,
 347                         result,
 348                         fsp->fsp_name,
 349                         false);
 350
 351         return result;
 352 }
 353
 354 static ssize_t smb_traffic_analyzer_write(vfs_handle_struct *handle, \
 355                         files_struct *fsp, const void *data, size_t n)
 356 {
 357         ssize_t result;
 358
 359         result = SMB_VFS_NEXT_WRITE(handle, fsp, data, n);
 360
 361         DEBUG(10, ("smb_traffic_analyzer_write: WRITE: %s\n", fsp->fsp_name ));
 362
 363         smb_traffic_analyzer_send_data(handle,
 364                         result,
 365                         fsp->fsp_name,
 366                         true);
 367         return result;
 368 }
 369
 370 static ssize_t smb_traffic_analyzer_pwrite(vfs_handle_struct *handle, \
 371              files_struct *fsp, const void *data, size_t n, SMB_OFF_T offset)
 372 {
 373         ssize_t result;
 374
 375         result = SMB_VFS_NEXT_PWRITE(handle, fsp, data, n, offset);
 376
 377         DEBUG(10, ("smb_traffic_analyzer_pwrite: PWRITE: %s\n", fsp->fsp_name ));
 378
 379         smb_traffic_analyzer_send_data(handle,
 380                         result,
 381                         fsp->fsp_name,
 382                         true);
 383         return result;
 384 }
 385
 386 /* VFS operations we use */
 387
 388 static vfs_op_tuple smb_traffic_analyzer_tuples[] = {
 389
 390         {SMB_VFS_OP(smb_traffic_analyzer_connect), SMB_VFS_OP_CONNECT,
 391          SMB_VFS_LAYER_LOGGER},
 392         {SMB_VFS_OP(smb_traffic_analyzer_read), SMB_VFS_OP_READ,
 393          SMB_VFS_LAYER_LOGGER},
 394         {SMB_VFS_OP(smb_traffic_analyzer_pread), SMB_VFS_OP_PREAD,
 395          SMB_VFS_LAYER_LOGGER},
 396         {SMB_VFS_OP(smb_traffic_analyzer_write), SMB_VFS_OP_WRITE,
 397          SMB_VFS_LAYER_LOGGER},
 398         {SMB_VFS_OP(smb_traffic_analyzer_pwrite), SMB_VFS_OP_PWRITE,
 399          SMB_VFS_LAYER_LOGGER},
 400         {SMB_VFS_OP(NULL),SMB_VFS_OP_NOOP,SMB_VFS_LAYER_NOOP}
 401 };
 402
 403 /* Module initialization */
 404
 405 NTSTATUS vfs_smb_traffic_analyzer_init(void)
 406 {
 407         NTSTATUS ret = smb_register_vfs(SMB_VFS_INTERFACE_VERSION, \
 408                 "smb_traffic_analyzer", smb_traffic_analyzer_tuples);
 409
 410         if (!NT_STATUS_IS_OK(ret)) {
 411                 return ret;
 412         }
 413
 414         vfs_smb_traffic_analyzer_debug_level =
 415                 debug_add_class("smb_traffic_analyzer");
 416
 417         if (vfs_smb_traffic_analyzer_debug_level == -1) {
 418                 vfs_smb_traffic_analyzer_debug_level = DBGC_VFS;
 419                 DEBUG(1, ("smb_traffic_analyzer_init: Couldn't register custom"
 420                          "debugging class!\n"));
 421         } else {
 422                 DEBUG(3, ("smb_traffic_analyzer_init: Debug class number of"
 423                         "'smb_traffic_analyzer': %d\n", \
 424                         vfs_smb_traffic_analyzer_debug_level));
 425         }
 426
 427         return ret;
 428 }