mono/metadata/attach.c

   1 /*
   2  * attach.c: Support for attaching to the runtime from other processes.
   3  *
   4  * Author:
   5  *   Zoltan Varga (vargaz@gmail.com)
   6  *
   7  * Copyright 2007-2009 Novell, Inc (http://www.novell.com)
   8  */
   9
  10 #include <config.h>
  11 #include <glib.h>
  12
  13 #ifdef HOST_WIN32
  14 #define DISABLE_ATTACH
  15 #endif
  16 #ifndef DISABLE_ATTACH
  17
  18 #include <stdio.h>
  19 #include <stdlib.h>
  20 #include <string.h>
  21 #include <sys/types.h>
  22 #include <sys/socket.h>
  23 #include <sys/stat.h>
  24 #include <sys/un.h>
  25 #include <netinet/in.h>
  26 #include <sys/types.h>
  27 #include <sys/stat.h>
  28 #include <fcntl.h>
  29 #include <inttypes.h>
  30 #include <pwd.h>
  31 #include <errno.h>
  32 #include <netdb.h>
  33 #include <unistd.h>
  34
  35 #include <mono/metadata/assembly.h>
  36 #include <mono/metadata/metadata.h>
  37 #include <mono/metadata/class-internals.h>
  38 #include <mono/metadata/object-internals.h>
  39 #include <mono/metadata/threads-types.h>
  40 #include <mono/metadata/gc-internals.h>
  41 #include <mono/utils/mono-threads.h>
  42 #include "attach.h"
  43
  44 /*
  45  * This module enables other processes to attach to a running mono process and
  46  * load agent assemblies.
  47  * Communication is done through a UNIX Domain Socket located at
  48  * /tmp/mono-<USER>/.mono-<PID>.
  49  * We use a simplified version of the .net remoting protocol.
  50  * To increase security, and to avoid spinning up a listener thread on startup,
  51  * we follow the java implementation, and only start up the attach mechanism
  52  * when we receive a QUIT signal and there is a file named
  53  * '.mono_attach_pid<PID>' in /tmp.
  54  *
  55  * SECURITY:
  56  * - This module allows loading of arbitrary code into a running mono runtime, so
  57  *   it is security critical.
  58  * - Security is based on controlling access to the unix file to which the unix
  59  *   domain socket is bound. Permissions/ownership are set such that only the owner
  60  *   of the process can access the socket.
  61  * - As an additional measure, the socket is only created when the process receives
  62  *   a SIGQUIT signal, which only its owner/root can send.
  63  * - The socket is kept in a directory whose ownership is checked before creating
  64  *   the socket. This could allow an attacker a kind of DOS attack by creating the
  65  *   directory with the wrong permissions/ownership. However, the only thing such
  66  *   an attacker could prevent is the attaching of agents to the mono runtime.
  67  */
  68
  69 typedef struct {
  70         gboolean enabled;
  71 } AgentConfig;
  72
  73 typedef struct {
  74         int bytes_sent;
  75 } AgentStats;
  76
  77 /*******************************************************************/
  78 /* Remoting Protocol type definitions from [MS-NRBF] and [MS-NRTP] */
  79 /*******************************************************************/
  80
  81 typedef enum {
  82         PRIM_TYPE_INT32 = 8,
  83         PRIM_TYPE_INT64 = 9,
  84         PRIM_TYPE_NULL = 17,
  85         PRIM_TYPE_STRING = 18
  86 } PrimitiveType;
  87
  88 static AgentConfig config;
  89
  90 static int listen_fd, conn_fd;
  91
  92 static char *ipc_filename;
  93
  94 static char *server_uri;
  95
  96 static HANDLE receiver_thread_handle;
  97
  98 static gboolean stop_receiver_thread;
  99
 100 static gboolean needs_to_start, started;
 101
 102 static void transport_connect (void);
 103
 104 static guint32 WINAPI receiver_thread (void *arg);
 105
 106 static void transport_start_receive (void);
 107
 108 /*
 109  * Functions to decode protocol data
 110  */
 111 static inline int
 112 decode_byte (guint8 *buf, guint8 **endbuf, guint8 *limit)
 113 {
 114         *endbuf = buf + 1;
 115         g_assert (*endbuf <= limit);
 116         return buf [0];
 117 }
 118
 119 static inline int
 120 decode_int (guint8 *buf, guint8 **endbuf, guint8 *limit)
 121 {
 122         *endbuf = buf + 4;
 123         g_assert (*endbuf <= limit);
 124
 125         return (((int)buf [0]) << 0) | (((int)buf [1]) << 8) | (((int)buf [2]) << 16) | (((int)buf [3]) << 24);
 126 }
 127
 128 static char*
 129 decode_string_value (guint8 *buf, guint8 **endbuf, guint8 *limit)
 130 {
 131         int type;
 132     gint32 length;
 133         guint8 *p = buf;
 134         char *s;
 135
 136         type = decode_byte (p, &p, limit);
 137         if (type == PRIM_TYPE_NULL) {
 138                 *endbuf = p;
 139                 return NULL;
 140         }
 141         g_assert (type == PRIM_TYPE_STRING);
 142
 143         length = 0;
 144         while (TRUE) {
 145                 guint8 b = decode_byte (p, &p, limit);
 146
 147                 length <<= 8;
 148                 length += b;
 149                 if (b <= 0x7f)
 150                         break;
 151         }
 152
 153         g_assert (length < (1 << 16));
 154
 155         s = g_malloc (length + 1);
 156
 157         g_assert (p + length <= limit);
 158         memcpy (s, p, length);
 159         s [length] = '\0';
 160         p += length;
 161
 162         *endbuf = p;
 163
 164         return s;
 165 }
 166
 167 /********************************/
 168 /*    AGENT IMPLEMENTATION      */
 169 /********************************/
 170
 171 void
 172 mono_attach_parse_options (char *options)
 173 {
 174         if (!options)
 175                 return;
 176         if (!strcmp (options, "disable"))
 177                 config.enabled = FALSE;
 178 }
 179
 180 void
 181 mono_attach_init (void)
 182 {
 183         config.enabled = TRUE;
 184 }
 185
 186 /**
 187  * mono_attach_start:
 188  *
 189  * Start the attach mechanism if needed.  This is called from a signal handler so it must be signal safe.
 190  *
 191  * Returns: whenever it was started.
 192  */
 193 gboolean
 194 mono_attach_start (void)
 195 {
 196         char path [256];
 197         int fd;
 198
 199         if (started)
 200                 return FALSE;
 201
 202         /* Check for the existence of the trigger file */
 203
 204         /*
 205          * We don't do anything with this file, and the only thing an attacker can do
 206          * by creating it is to enable the attach mechanism if the process receives a
 207          * SIGQUIT signal, which can only be sent by the owner/root.
 208          */
 209         snprintf (path, sizeof (path), "/tmp/.mono_attach_pid%"PRIdMAX"", (intmax_t) getpid ());
 210         fd = open (path, O_RDONLY);
 211         if (fd == -1)
 212                 return FALSE;
 213         close (fd);
 214
 215         if (!config.enabled)
 216                 /* Act like we started */
 217                 return TRUE;
 218
 219         if (started)
 220                 return FALSE;
 221
 222         /*
 223          * Our startup includes non signal-safe code, so ask the finalizer thread to
 224          * do the actual startup.
 225          */
 226         needs_to_start = TRUE;
 227         mono_gc_finalize_notify ();
 228
 229         return TRUE;
 230 }
 231
 232 /* Called by the finalizer thread when it is woken up */
 233 void
 234 mono_attach_maybe_start (void)
 235 {
 236         if (!needs_to_start)
 237                 return;
 238
 239         needs_to_start = FALSE;
 240         if (!started) {
 241                 transport_start_receive ();
 242
 243                 started = TRUE;
 244         }
 245 }
 246
 247 void
 248 mono_attach_cleanup (void)
 249 {
 250         if (listen_fd)
 251                 close (listen_fd);
 252         if (ipc_filename)
 253                 unlink (ipc_filename);
 254
 255         stop_receiver_thread = TRUE;
 256         if (conn_fd)
 257                 /* This will cause receiver_thread () to break out of the read () call */
 258                 close (conn_fd);
 259
 260         /* Wait for the receiver thread to exit */
 261         if (receiver_thread_handle)
 262                 WaitForSingleObjectEx (receiver_thread_handle, 0, FALSE);
 263 }
 264
 265 static int
 266 mono_attach_load_agent (MonoDomain *domain, char *agent, char *args, MonoObject **exc)
 267 {
 268         MonoAssembly *agent_assembly;
 269         MonoImage *image;
 270         MonoMethod *method;
 271         guint32 entry;
 272         MonoArray *main_args;
 273         gpointer pa [1];
 274         MonoImageOpenStatus open_status;
 275
 276         agent_assembly = mono_assembly_open (agent, &open_status);
 277         if (!agent_assembly) {
 278                 fprintf (stderr, "Cannot open agent assembly '%s': %s.\n", agent, mono_image_strerror (open_status));
 279                 g_free (agent);
 280                 return 2;
 281         }
 282
 283         /*
 284          * Can't use mono_jit_exec (), as it sets things which might confuse the
 285          * real Main method.
 286          */
 287         image = mono_assembly_get_image (agent_assembly);
 288         entry = mono_image_get_entry_point (image);
 289         if (!entry) {
 290                 g_print ("Assembly '%s' doesn't have an entry point.\n", mono_image_get_filename (image));
 291                 g_free (agent);
 292                 return 1;
 293         }
 294
 295         method = mono_get_method (image, entry, NULL);
 296         if (method == NULL){
 297                 g_print ("The entry point method of assembly '%s' could not be loaded\n", agent);
 298                 g_free (agent);
 299                 return 1;
 300         }
 301
 302         if (args) {
 303                 main_args = (MonoArray*)mono_array_new (domain, mono_defaults.string_class, 1);
 304                 mono_array_set (main_args, MonoString*, 0, mono_string_new (domain, args));
 305         } else {
 306                 main_args = (MonoArray*)mono_array_new (domain, mono_defaults.string_class, 0);
 307         }
 308
 309         g_free (agent);
 310
 311         pa [0] = main_args;
 312         mono_runtime_invoke (method, NULL, pa, exc);
 313
 314         return 0;
 315 }
 316
 317 /*
 318  * ipc_connect:
 319  *
 320  *   Create a UNIX domain socket and bind it to a file in /tmp.
 321  *
 322  * SECURITY: This routine is _very_ security critical since we depend on the UNIX
 323  * permissions system to prevent attackers from connecting to the socket.
 324  */
 325 static void
 326 ipc_connect (void)
 327 {
 328         struct sockaddr_un name;
 329         int sock, res;
 330         size_t size;
 331         char *filename, *directory;
 332         struct stat stat;
 333         struct passwd pwbuf;
 334         char buf [1024];
 335         struct passwd *pw;
 336
 337         if (getuid () != geteuid ()) {
 338                 fprintf (stderr, "attach: disabled listening on an IPC socket when running in setuid mode.\n");
 339                 return;
 340         }
 341
 342         /* Create the socket.   */
 343         sock = socket (PF_UNIX, SOCK_STREAM, 0);
 344         if (sock < 0) {
 345                 perror ("attach: failed to create IPC socket");
 346                 return;
 347         }
 348
 349         /*
 350          * For security reasons, create a directory to hold the listening socket,
 351          * since there is a race between bind () and chmod () below.
 352          */
 353         /* FIXME: Use TMP ? */
 354         pw = NULL;
 355 #ifdef HAVE_GETPWUID_R
 356         res = getpwuid_r (getuid (), &pwbuf, buf, sizeof (buf), &pw);
 357 #else
 358         pw = getpwuid(getuid ());
 359         res = pw != NULL ? 0 : 1;
 360 #endif
 361         if (res != 0) {
 362                 fprintf (stderr, "attach: getpwuid_r () failed.\n");
 363                 return;
 364         }
 365         g_assert (pw);
 366         directory = g_strdup_printf ("/tmp/mono-%s", pw->pw_name);
 367         res = mkdir (directory, S_IRUSR | S_IWUSR | S_IXUSR);
 368         if (res != 0) {
 369                 if (errno == EEXIST) {
 370                         /* Check type and permissions */
 371                         res = lstat (directory, &stat);
 372                         if (res != 0) {
 373                                 perror ("attach: lstat () failed");
 374                                 return;
 375                         }
 376                         if (!S_ISDIR (stat.st_mode)) {
 377                                 fprintf (stderr, "attach: path '%s' is not a directory.\n", directory);
 378                                 return;
 379                         }
 380                         if (stat.st_uid != getuid ()) {
 381                                 fprintf (stderr, "attach: directory '%s' is not owned by the current user.\n", directory);
 382                                 return;
 383                         }
 384                         if ((stat.st_mode & S_IRWXG) != 0 || (stat.st_mode & S_IRWXO) || ((stat.st_mode & S_IRWXU) != (S_IRUSR | S_IWUSR | S_IXUSR))) {
 385                                 fprintf (stderr, "attach: directory '%s' should have protection 0700.\n", directory);
 386                                 return;
 387                         }
 388                 } else {
 389                         perror ("attach: mkdir () failed");
 390                         return;
 391                 }
 392         }
 393
 394         filename = g_strdup_printf ("%s/.mono-%"PRIdMAX"", directory, (intmax_t) getpid ());
 395         unlink (filename);
 396
 397         /* Bind a name to the socket.   */
 398         name.sun_family = AF_UNIX;
 399         strcpy (name.sun_path, filename);
 400
 401         size = (offsetof (struct sockaddr_un, sun_path)
 402                         + strlen (name.sun_path) + 1);
 403
 404         if (bind (sock, (struct sockaddr *) &name, size) < 0) {
 405                 fprintf (stderr, "attach: failed to bind IPC socket '%s': %s\n", filename, strerror (errno));
 406                 close (sock);
 407                 return;
 408         }
 409
 410         /* Set permissions */
 411         res = chmod (filename, S_IRUSR | S_IWUSR);
 412         if (res != 0) {
 413                 perror ("attach: failed to set permissions on IPC socket");
 414                 close (sock);
 415                 unlink (filename);
 416                 return;
 417         }
 418
 419         res = listen (sock, 16);
 420         if (res != 0) {
 421                 fprintf (stderr, "attach: listen () failed: %s\n", strerror (errno));
 422                 exit (1);
 423         }
 424
 425         listen_fd = sock;
 426
 427         ipc_filename = g_strdup (filename);
 428
 429         server_uri = g_strdup_printf ("unix://%s/.mono-%"PRIdMAX"?/vm", directory, (intmax_t) getpid ());
 430
 431         g_free (filename);
 432         g_free (directory);
 433 }
 434
 435 static void
 436 transport_connect (void)
 437 {
 438         ipc_connect ();
 439 }
 440
 441 #if 0
 442
 443 static void
 444 transport_send (int fd, guint8 *data, int len)
 445 {
 446         int res;
 447
 448         stats.bytes_sent += len;
 449         //printf ("X: %d\n", stats.bytes_sent);
 450
 451         res = write (fd, data, len);
 452         if (res != len) {
 453                 /* FIXME: What to do here ? */
 454         }
 455 }
 456
 457 #endif
 458
 459 static void
 460 transport_start_receive (void)
 461 {
 462         transport_connect ();
 463
 464         if (!listen_fd)
 465                 return;
 466
 467         receiver_thread_handle = mono_threads_create_thread (receiver_thread, NULL, 0, 0, NULL);
 468         g_assert (receiver_thread_handle);
 469 }
 470
 471 static guint32 WINAPI
 472 receiver_thread (void *arg)
 473 {
 474         int res, content_len;
 475         guint8 buffer [256];
 476         guint8 *p, *p_end;
 477         MonoObject *exc;
 478
 479         printf ("attach: Listening on '%s'...\n", server_uri);
 480
 481         while (TRUE) {
 482                 conn_fd = accept (listen_fd, NULL, NULL);
 483                 if (conn_fd == -1)
 484                         /* Probably closed by mono_attach_cleanup () */
 485                         return 0;
 486
 487                 printf ("attach: Connected.\n");
 488
 489                 mono_thread_attach (mono_get_root_domain ());
 490                 /* Ask the runtime to not abort this thread */
 491                 //mono_thread_current ()->flags |= MONO_THREAD_FLAG_DONT_MANAGE;
 492                 /* Ask the runtime to not wait for this thread */
 493                 mono_thread_internal_current ()->state |= ThreadState_Background;
 494
 495                 while (TRUE) {
 496                         char *cmd, *agent_name, *agent_args;
 497                         guint8 *body;
 498
 499                         /* Read Header */
 500                         res = read (conn_fd, buffer, 6);
 501
 502                         if (res == -1 && errno == EINTR)
 503                                 continue;
 504
 505                         if (res == -1 || stop_receiver_thread)
 506                                 break;
 507
 508                         if (res != 6)
 509                                 break;
 510
 511                         if ((strncmp ((char*)buffer, "MONO", 4) != 0) || buffer [4] != 1 || buffer [5] != 0) {
 512                                 fprintf (stderr, "attach: message from server has unknown header.\n");
 513                                 break;
 514                         }
 515
 516                         /* Read content length */
 517                         res = read (conn_fd, buffer, 4);
 518                         if (res != 4)
 519                                 break;
 520
 521                         p = buffer;
 522                         p_end = p + 8;
 523
 524                         content_len = decode_int (p, &p, p_end);
 525
 526                         /* Read message body */
 527                         body = g_malloc (content_len);
 528                         res = read (conn_fd, body, content_len);
 529
 530                         p = body;
 531                         p_end = body + content_len;
 532
 533                         cmd = decode_string_value (p, &p, p_end);
 534                         if (cmd == NULL)
 535                                 break;
 536                         g_assert (!strcmp (cmd, "attach"));
 537
 538                         agent_name = decode_string_value (p, &p, p_end);
 539                         agent_args = decode_string_value (p, &p, p_end);
 540
 541                         printf ("attach: Loading agent '%s'.\n", agent_name);
 542                         mono_attach_load_agent (mono_domain_get (), agent_name, agent_args, &exc);
 543
 544                         g_free (body);
 545
 546                         // FIXME: Send back a result
 547                 }
 548
 549                 close (conn_fd);
 550                 conn_fd = 0;
 551
 552                 printf ("attach: Disconnected.\n");
 553
 554                 if (stop_receiver_thread)
 555                         break;
 556         }
 557
 558         return 0;
 559 }
 560
 561 #else /* DISABLE_ATTACH */
 562
 563 void
 564 mono_attach_parse_options (char *options)
 565 {
 566 }
 567
 568 void
 569 mono_attach_init (void)
 570 {
 571 }
 572
 573 gboolean
 574 mono_attach_start (void)
 575 {
 576         return FALSE;
 577 }
 578
 579 void
 580 mono_attach_maybe_start (void)
 581 {
 582 }
 583
 584 void
 585 mono_attach_cleanup (void)
 586 {
 587 }
 588
 589 #endif /* DISABLE_ATTACH */