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