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 /* 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 };
  42
  43
  44 static int vfs_smb_traffic_analyzer_debug_level = DBGC_VFS;
  45
  46 static enum sock_type smb_traffic_analyzer_connMode(vfs_handle_struct *handle)
  47 {
  48         connection_struct *conn = handle->conn;
  49         const char *Mode;
  50         Mode=lp_parm_const_string(SNUM(conn), "smb_traffic_analyzer","mode", \
  51                         "internet_socket");
  52         if (strstr(Mode,"unix_domain_socket")) {
  53                 return UNIX_DOMAIN_SOCKET;
  54         } else {
  55                 return INTERNET_SOCKET;
  56         }
  57 }
  58
  59
  60 /* Connect to an internet socket */
  61
  62 static int smb_traffic_analyzer_connect_inet_socket(vfs_handle_struct *handle,
  63                                         const char *name, uint16_t port)
  64 {
  65         /* Create a streaming Socket */
  66         int sockfd = -1;
  67         struct addrinfo hints;
  68         struct addrinfo *ailist = NULL;
  69         struct addrinfo *res = NULL;
  70         int ret;
  71
  72         ZERO_STRUCT(hints);
  73         /* By default make sure it supports TCP. */
  74         hints.ai_socktype = SOCK_STREAM;
  75         hints.ai_flags = AI_ADDRCONFIG;
  76
  77         ret = getaddrinfo(name,
  78                         NULL,
  79                         &hints,
  80                         &ailist);
  81
  82         if (ret) {
  83                 DEBUG(3,("smb_traffic_analyzer_connect_inet_socket: "
  84                         "getaddrinfo failed for name %s [%s]\n",
  85                         name,
  86                         gai_strerror(ret) ));
  87                 return -1;
  88         }
  89
  90         DEBUG(3,("smb_traffic_analyzer: Internet socket mode. Hostname: %s,"
  91                 "Port: %i\n", name, port));
  92
  93         for (res = ailist; res; res = res->ai_next) {
  94                 struct sockaddr_storage ss;
  95                 NTSTATUS status;
  96
  97                 if (!res->ai_addr || res->ai_addrlen == 0) {
  98                         continue;
  99                 }
 100
 101                 ZERO_STRUCT(ss);
 102                 memcpy(&ss, res->ai_addr, res->ai_addrlen);
 103
 104                 status = open_socket_out(&ss, port, 10000, &sockfd);
 105                 if (NT_STATUS_IS_OK(status)) {
 106                         break;
 107                 }
 108         }
 109
 110         if (ailist) {
 111                 freeaddrinfo(ailist);
 112         }
 113
 114         if (sockfd == -1) {
 115                 DEBUG(1, ("smb_traffic_analyzer: unable to create "
 116                         "socket, error is %s",
 117                         strerror(errno)));
 118                 return -1;
 119         }
 120
 121         return sockfd;
 122 }
 123
 124 /* Connect to a unix domain socket */
 125
 126 static int smb_traffic_analyzer_connect_unix_socket(vfs_handle_struct *handle,
 127                                                 const char *name)
 128 {
 129         /* Create the socket to stad */
 130         int len, sock;
 131         struct sockaddr_un remote;
 132
 133         DEBUG(7, ("smb_traffic_analyzer_connect_unix_socket: "
 134                         "Unix domain socket mode. Using %s\n",
 135                         name ));
 136
 137         if ((sock = socket(AF_UNIX, SOCK_STREAM, 0)) == -1) {
 138                 DEBUG(1, ("smb_traffic_analyzer_connect_unix_socket: "
 139                         "Couldn't create socket, "
 140                         "make sure stad is running!\n"));
 141                 return -1;
 142         }
 143         remote.sun_family = AF_UNIX;
 144         strlcpy(remote.sun_path, name,
 145                     sizeof(remote.sun_path));
 146         len=strlen(remote.sun_path) + sizeof(remote.sun_family);
 147         if (connect(sock, (struct sockaddr *)&remote, len) == -1 ) {
 148                 DEBUG(1, ("smb_traffic_analyzer_connect_unix_socket: "
 149                         "Could not connect to "
 150                         "socket, make sure\nstad is running!\n"));
 151                 close(sock);
 152                 return -1;
 153         }
 154         return sock;
 155 }
 156
 157 /* Private data allowing shared connection sockets. */
 158
 159 struct refcounted_sock {
 160         struct refcounted_sock *next, *prev;
 161         char *name;
 162         uint16_t port;
 163         int sock;
 164         unsigned int ref_count;
 165 };
 166
 167 /* Send data over a socket */
 168
 169 static void smb_traffic_analyzer_send_data(vfs_handle_struct *handle,
 170                                         ssize_t result,
 171                                         const char *file_name,
 172                                         enum vfs_id vfs_operation )
 173 {
 174         struct refcounted_sock *rf_sock = NULL;
 175         struct timeval tv;
 176         time_t tv_sec;
 177         struct tm *tm = NULL;
 178         int seconds;
 179         char *str = NULL;
 180         char *username = NULL;
 181         const char *anon_prefix = NULL;
 182         const char *total_anonymization = NULL;
 183         const char *protocol_version = NULL;
 184         bool Write = false;
 185         size_t len;
 186
 187         SMB_VFS_HANDLE_GET_DATA(handle, rf_sock, struct refcounted_sock, return);
 188
 189         if (rf_sock == NULL || rf_sock->sock == -1) {
 190                 DEBUG(1, ("smb_traffic_analyzer_send_data: socket is "
 191                         "closed\n"));
 192                 return;
 193         }
 194
 195         GetTimeOfDay(&tv);
 196         tv_sec = convert_timespec_to_time_t(convert_timeval_to_timespec(tv));
 197         tm = localtime(&tv_sec);
 198         if (!tm) {
 199                 return;
 200         }
 201         seconds=(float) (tv.tv_usec / 1000);
 202
 203         /* check if anonymization is required */
 204
 205         total_anonymization=lp_parm_const_string(SNUM(handle->conn),"smb_traffic_analyzer",
 206                                         "total_anonymization", NULL);
 207
 208         anon_prefix=lp_parm_const_string(SNUM(handle->conn),"smb_traffic_analyzer",\
 209                                         "anonymize_prefix", NULL );
 210         if (anon_prefix!=NULL) {
 211                 if (total_anonymization!=NULL) {
 212                         username = talloc_asprintf(talloc_tos(),
 213                                 "%s",
 214                                 anon_prefix);
 215                 } else {
 216                         username = talloc_asprintf(talloc_tos(),
 217                                 "%s%i",
 218                                 anon_prefix,
 219                                 str_checksum(
 220                                         handle->conn->server_info->sanitized_username ) );
 221                 }
 222
 223         } else {
 224                 username = handle->conn->server_info->sanitized_username;
 225         }
 226
 227         if (!username) {
 228                 return;
 229         }
 230
 231         protocol_version = lp_parm_const_string(SNUM(handle->conn),
 232                 "smb_traffic_analyzer",
 233                 "protocol_version", NULL );
 234
 235         if ( protocol_version == NULL || strcmp( protocol_version,"V1") == 0) {
 236
 237                 /* in case of protocol v1, ignore any vfs operations    */
 238                 /* except read,pread,write,pwrite, and set the "Write"  */
 239                 /* bool accordingly.                                    */
 240
 241                 if ( vfs_operation > vfs_id_pwrite ) return;
 242
 243                 if ( vfs_operation <= vfs_id_pread ) Write=false;
 244                         else Write=true;
 245
 246                 str = talloc_asprintf(talloc_tos(),
 247                         "V1,%u,\"%s\",\"%s\",\"%c\",\"%s\",\"%s\","
 248                         "\"%04d-%02d-%02d %02d:%02d:%02d.%03d\"\n",
 249                         (unsigned int)result,
 250                         username,
 251                         pdb_get_domain(handle->conn->server_info->sam_account),
 252                         Write ? 'W' : 'R',
 253                         handle->conn->connectpath,
 254                         file_name,
 255                         tm->tm_year+1900,
 256                         tm->tm_mon+1,
 257                         tm->tm_mday,
 258                         tm->tm_hour,
 259                         tm->tm_min,
 260                         tm->tm_sec,
 261                         (int)seconds);
 262         } else if ( strcmp( protocol_version, "V2") == 0) {
 263                 /* protocol version 2   */
 264                 /* in development       */
 265         } else {
 266                 DEBUG(1, ("smb_traffic_analyzer_send_data_socket: "
 267                         "error, unkown protocol given!\n"));
 268                 return;
 269         }
 270
 271         if (!str) {
 272                 DEBUG(1, ("smb_traffic_analyzer_send_data: "
 273                         "unable to create string to send!\n"));
 274                 return;
 275         }
 276
 277         len = strlen(str);
 278
 279         DEBUG(10, ("smb_traffic_analyzer_send_data_socket: sending %s\n",
 280                         str));
 281         if (write_data(rf_sock->sock, str, len) != len) {
 282                 DEBUG(1, ("smb_traffic_analyzer_send_data_socket: "
 283                         "error sending data to socket!\n"));
 284                 return ;
 285         }
 286 }
 287
 288 static struct refcounted_sock *sock_list;
 289
 290 static void smb_traffic_analyzer_free_data(void **pptr)
 291 {
 292         struct refcounted_sock *rf_sock = *(struct refcounted_sock **)pptr;
 293         if (rf_sock == NULL) {
 294                 return;
 295         }
 296         rf_sock->ref_count--;
 297         if (rf_sock->ref_count != 0) {
 298                 return;
 299         }
 300         if (rf_sock->sock != -1) {
 301                 close(rf_sock->sock);
 302         }
 303         DLIST_REMOVE(sock_list, rf_sock);
 304         TALLOC_FREE(rf_sock);
 305 }
 306
 307 static int smb_traffic_analyzer_connect(struct vfs_handle_struct *handle,
 308                          const char *service,
 309                          const char *user)
 310 {
 311         connection_struct *conn = handle->conn;
 312         enum sock_type st = smb_traffic_analyzer_connMode(handle);
 313         struct refcounted_sock *rf_sock = NULL;
 314         const char *name = (st == UNIX_DOMAIN_SOCKET) ? LOCAL_PATHNAME :
 315                                 lp_parm_const_string(SNUM(conn),
 316                                         "smb_traffic_analyzer",
 317                                 "host", "localhost");
 318         uint16_t port = (st == UNIX_DOMAIN_SOCKET) ? 0 :
 319                                 atoi( lp_parm_const_string(SNUM(conn),
 320                                 "smb_traffic_analyzer", "port", "9430"));
 321         int ret = SMB_VFS_NEXT_CONNECT(handle, service, user);
 322
 323         if (ret < 0) {
 324                 return ret;
 325         }
 326
 327         /* Are we already connected ? */
 328         for (rf_sock = sock_list; rf_sock; rf_sock = rf_sock->next) {
 329                 if (port == rf_sock->port &&
 330                                 (strcmp(name, rf_sock->name) == 0)) {
 331                         break;
 332                 }
 333         }
 334
 335         /* If we're connected already, just increase the
 336          * reference count. */
 337         if (rf_sock) {
 338                 rf_sock->ref_count++;
 339         } else {
 340                 /* New connection. */
 341                 rf_sock = TALLOC_ZERO_P(NULL, struct refcounted_sock);
 342                 if (rf_sock == NULL) {
 343                         SMB_VFS_NEXT_DISCONNECT(handle);
 344                         errno = ENOMEM;
 345                         return -1;
 346                 }
 347                 rf_sock->name = talloc_strdup(rf_sock, name);
 348                 if (rf_sock->name == NULL) {
 349                         SMB_VFS_NEXT_DISCONNECT(handle);
 350                         TALLOC_FREE(rf_sock);
 351                         errno = ENOMEM;
 352                         return -1;
 353                 }
 354                 rf_sock->port = port;
 355                 rf_sock->ref_count = 1;
 356
 357                 if (st == UNIX_DOMAIN_SOCKET) {
 358                         rf_sock->sock = smb_traffic_analyzer_connect_unix_socket(handle,
 359                                                         name);
 360                 } else {
 361
 362                         rf_sock->sock = smb_traffic_analyzer_connect_inet_socket(handle,
 363                                                         name,
 364                                                         port);
 365                 }
 366                 if (rf_sock->sock == -1) {
 367                         SMB_VFS_NEXT_DISCONNECT(handle);
 368                         TALLOC_FREE(rf_sock);
 369                         return -1;
 370                 }
 371                 DLIST_ADD(sock_list, rf_sock);
 372         }
 373
 374         /* Store the private data. */
 375         SMB_VFS_HANDLE_SET_DATA(handle, rf_sock, smb_traffic_analyzer_free_data,
 376                                 struct refcounted_sock, return -1);
 377         return 0;
 378 }
 379
 380 /* VFS Functions */
 381
 382 static int smb_traffic_analyzer_mkdir(vfs_handle_struct *handle, \
 383                         const char *path, mode_t mode)
 384 {
 385         int result;
 386         result = SMB_VFS_NEXT_MKDIR(handle, path, mode);
 387         DEBUG(10, ("smb_traffic_analyzer_mkdir: MKDIR: %s\n", path));
 388         smb_traffic_analyzer_send_data(handle,
 389                         result,
 390                         path,
 391                         vfs_id_mkdir);
 392         return result;
 393 }
 394
 395 static ssize_t smb_traffic_analyzer_read(vfs_handle_struct *handle, \
 396                                 files_struct *fsp, void *data, size_t n)
 397 {
 398         ssize_t result;
 399
 400         result = SMB_VFS_NEXT_READ(handle, fsp, data, n);
 401         DEBUG(10, ("smb_traffic_analyzer_read: READ: %s\n", fsp_str_dbg(fsp)));
 402
 403         smb_traffic_analyzer_send_data(handle,
 404                         result,
 405                         fsp->fsp_name->base_name,
 406                         vfs_id_read);
 407         return result;
 408 }
 409
 410
 411 static ssize_t smb_traffic_analyzer_pread(vfs_handle_struct *handle, \
 412                 files_struct *fsp, void *data, size_t n, SMB_OFF_T offset)
 413 {
 414         ssize_t result;
 415
 416         result = SMB_VFS_NEXT_PREAD(handle, fsp, data, n, offset);
 417
 418         DEBUG(10, ("smb_traffic_analyzer_pread: PREAD: %s\n",
 419                    fsp_str_dbg(fsp)));
 420
 421         smb_traffic_analyzer_send_data(handle,
 422                         result,
 423                         fsp->fsp_name->base_name,
 424                         vfs_id_pread);
 425
 426         return result;
 427 }
 428
 429 static ssize_t smb_traffic_analyzer_write(vfs_handle_struct *handle, \
 430                         files_struct *fsp, const void *data, size_t n)
 431 {
 432         ssize_t result;
 433
 434         result = SMB_VFS_NEXT_WRITE(handle, fsp, data, n);
 435
 436         DEBUG(10, ("smb_traffic_analyzer_write: WRITE: %s\n",
 437                    fsp_str_dbg(fsp)));
 438
 439         smb_traffic_analyzer_send_data(handle,
 440                         result,
 441                         fsp->fsp_name->base_name,
 442                         vfs_id_write);
 443         return result;
 444 }
 445
 446 static ssize_t smb_traffic_analyzer_pwrite(vfs_handle_struct *handle, \
 447              files_struct *fsp, const void *data, size_t n, SMB_OFF_T offset)
 448 {
 449         ssize_t result;
 450
 451         result = SMB_VFS_NEXT_PWRITE(handle, fsp, data, n, offset);
 452
 453         DEBUG(10, ("smb_traffic_analyzer_pwrite: PWRITE: %s\n", fsp_str_dbg(fsp)));
 454
 455         smb_traffic_analyzer_send_data(handle,
 456                         result,
 457                         fsp->fsp_name->base_name,
 458                         vfs_id_pwrite);
 459         return result;
 460 }
 461
 462 static struct vfs_fn_pointers vfs_smb_traffic_analyzer_fns = {
 463         .connect_fn = smb_traffic_analyzer_connect,
 464         .vfs_read = smb_traffic_analyzer_read,
 465         .pread = smb_traffic_analyzer_pread,
 466         .write = smb_traffic_analyzer_write,
 467         .pwrite = smb_traffic_analyzer_pwrite,
 468         .mkdir = smb_traffic_analyzer_mkdir
 469 };
 470
 471 /* Module initialization */
 472
 473 NTSTATUS vfs_smb_traffic_analyzer_init(void)
 474 {
 475         NTSTATUS ret = smb_register_vfs(SMB_VFS_INTERFACE_VERSION,
 476                                         "smb_traffic_analyzer",
 477                                         &vfs_smb_traffic_analyzer_fns);
 478
 479         if (!NT_STATUS_IS_OK(ret)) {
 480                 return ret;
 481         }
 482
 483         vfs_smb_traffic_analyzer_debug_level =
 484                 debug_add_class("smb_traffic_analyzer");
 485
 486         if (vfs_smb_traffic_analyzer_debug_level == -1) {
 487                 vfs_smb_traffic_analyzer_debug_level = DBGC_VFS;
 488                 DEBUG(1, ("smb_traffic_analyzer_init: Couldn't register custom"
 489                          "debugging class!\n"));
 490         } else {
 491                 DEBUG(3, ("smb_traffic_analyzer_init: Debug class number of"
 492                         "'smb_traffic_analyzer': %d\n", \
 493                         vfs_smb_traffic_analyzer_debug_level));
 494         }
 495
 496         return ret;
 497 }