2 * attach.c: Support for attaching to the runtime from other processes.
5 * Zoltan Varga (vargaz@gmail.com)
7 * Copyright 2007-2009 Novell, Inc (http://www.novell.com)
14 #define DISABLE_ATTACH
16 #ifndef DISABLE_ATTACH
21 #include <sys/types.h>
22 #include <sys/socket.h>
25 #include <netinet/in.h>
26 #include <sys/types.h>
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-internal.h>
41 #include <mono/utils/mono-threads.h>
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.
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.
77 /*******************************************************************/
78 /* Remoting Protocol type definitions from [MS-NRBF] and [MS-NRTP] */
79 /*******************************************************************/
88 static AgentConfig config;
90 static int listen_fd, conn_fd;
92 static char *ipc_filename;
94 static char *server_uri;
96 static HANDLE receiver_thread_handle;
98 static gboolean stop_receiver_thread;
100 static gboolean needs_to_start, started;
102 #define agent_lock() mono_mutex_lock (&agent_mutex)
103 #define agent_unlock() mono_mutex_unlock (&agent_mutex)
104 static mono_mutex_t agent_mutex;
106 static void transport_connect (void);
108 static guint32 WINAPI receiver_thread (void *arg);
110 static void transport_start_receive (void);
113 * Functions to decode protocol data
116 decode_byte (guint8 *buf, guint8 **endbuf, guint8 *limit)
119 g_assert (*endbuf <= limit);
124 decode_int (guint8 *buf, guint8 **endbuf, guint8 *limit)
127 g_assert (*endbuf <= limit);
129 return (((int)buf [0]) << 0) | (((int)buf [1]) << 8) | (((int)buf [2]) << 16) | (((int)buf [3]) << 24);
133 decode_string_value (guint8 *buf, guint8 **endbuf, guint8 *limit)
140 type = decode_byte (p, &p, limit);
141 if (type == PRIM_TYPE_NULL) {
145 g_assert (type == PRIM_TYPE_STRING);
149 guint8 b = decode_byte (p, &p, limit);
157 g_assert (length < (1 << 16));
159 s = g_malloc (length + 1);
161 g_assert (p + length <= limit);
162 memcpy (s, p, length);
171 /********************************/
172 /* AGENT IMPLEMENTATION */
173 /********************************/
176 mono_attach_parse_options (char *options)
180 if (!strcmp (options, "disable"))
181 config.enabled = FALSE;
185 mono_attach_init (void)
187 mono_mutex_init_recursive (&agent_mutex);
189 config.enabled = TRUE;
195 * Start the attach mechanism if needed. This is called from a signal handler so it must be signal safe.
197 * Returns: whenever it was started.
200 mono_attach_start (void)
208 /* Check for the existence of the trigger file */
211 * We don't do anything with this file, and the only thing an attacker can do
212 * by creating it is to enable the attach mechanism if the process receives a
213 * SIGQUIT signal, which can only be sent by the owner/root.
215 snprintf (path, sizeof (path), "/tmp/.mono_attach_pid%"PRIdMAX"", (intmax_t) getpid ());
216 fd = open (path, O_RDONLY);
222 /* Act like we started */
229 * Our startup includes non signal-safe code, so ask the finalizer thread to
230 * do the actual startup.
232 needs_to_start = TRUE;
233 mono_gc_finalize_notify ();
238 /* Called by the finalizer thread when it is woken up */
240 mono_attach_maybe_start (void)
245 needs_to_start = FALSE;
247 transport_start_receive ();
254 mono_attach_cleanup (void)
259 unlink (ipc_filename);
261 stop_receiver_thread = TRUE;
263 /* This will cause receiver_thread () to break out of the read () call */
266 /* Wait for the receiver thread to exit */
267 if (receiver_thread_handle)
268 WaitForSingleObjectEx (receiver_thread_handle, 0, FALSE);
272 mono_attach_load_agent (MonoDomain *domain, char *agent, char *args, MonoObject **exc)
274 MonoAssembly *agent_assembly;
278 MonoArray *main_args;
280 MonoImageOpenStatus open_status;
282 agent_assembly = mono_assembly_open (agent, &open_status);
283 if (!agent_assembly) {
284 fprintf (stderr, "Cannot open agent assembly '%s': %s.\n", agent, mono_image_strerror (open_status));
290 * Can't use mono_jit_exec (), as it sets things which might confuse the
293 image = mono_assembly_get_image (agent_assembly);
294 entry = mono_image_get_entry_point (image);
296 g_print ("Assembly '%s' doesn't have an entry point.\n", mono_image_get_filename (image));
301 method = mono_get_method (image, entry, NULL);
303 g_print ("The entry point method of assembly '%s' could not be loaded\n", agent);
309 main_args = (MonoArray*)mono_array_new (domain, mono_defaults.string_class, 1);
310 mono_array_set (main_args, MonoString*, 0, mono_string_new (domain, args));
312 main_args = (MonoArray*)mono_array_new (domain, mono_defaults.string_class, 0);
318 mono_runtime_invoke (method, NULL, pa, exc);
326 * Create a UNIX domain socket and bind it to a file in /tmp.
328 * SECURITY: This routine is _very_ security critical since we depend on the UNIX
329 * permissions system to prevent attackers from connecting to the socket.
334 struct sockaddr_un name;
337 char *filename, *directory;
343 if (getuid () != geteuid ()) {
344 fprintf (stderr, "attach: disabled listening on an IPC socket when running in setuid mode.\n");
348 /* Create the socket. */
349 sock = socket (PF_UNIX, SOCK_STREAM, 0);
351 perror ("attach: failed to create IPC socket");
356 * For security reasons, create a directory to hold the listening socket,
357 * since there is a race between bind () and chmod () below.
359 /* FIXME: Use TMP ? */
361 #ifdef HAVE_GETPWUID_R
362 res = getpwuid_r (getuid (), &pwbuf, buf, sizeof (buf), &pw);
364 pw = getpwuid(getuid ());
365 res = pw != NULL ? 0 : 1;
368 fprintf (stderr, "attach: getpwuid_r () failed.\n");
372 directory = g_strdup_printf ("/tmp/mono-%s", pw->pw_name);
373 res = mkdir (directory, S_IRUSR | S_IWUSR | S_IXUSR);
375 if (errno == EEXIST) {
376 /* Check type and permissions */
377 res = lstat (directory, &stat);
379 perror ("attach: lstat () failed");
382 if (!S_ISDIR (stat.st_mode)) {
383 fprintf (stderr, "attach: path '%s' is not a directory.\n", directory);
386 if (stat.st_uid != getuid ()) {
387 fprintf (stderr, "attach: directory '%s' is not owned by the current user.\n", directory);
390 if ((stat.st_mode & S_IRWXG) != 0 || (stat.st_mode & S_IRWXO) || ((stat.st_mode & S_IRWXU) != (S_IRUSR | S_IWUSR | S_IXUSR))) {
391 fprintf (stderr, "attach: directory '%s' should have protection 0700.\n", directory);
395 perror ("attach: mkdir () failed");
400 filename = g_strdup_printf ("%s/.mono-%"PRIdMAX"", directory, (intmax_t) getpid ());
403 /* Bind a name to the socket. */
404 name.sun_family = AF_UNIX;
405 strcpy (name.sun_path, filename);
407 size = (offsetof (struct sockaddr_un, sun_path)
408 + strlen (name.sun_path) + 1);
410 if (bind (sock, (struct sockaddr *) &name, size) < 0) {
411 fprintf (stderr, "attach: failed to bind IPC socket '%s': %s\n", filename, strerror (errno));
416 /* Set permissions */
417 res = chmod (filename, S_IRUSR | S_IWUSR);
419 perror ("attach: failed to set permissions on IPC socket");
425 res = listen (sock, 16);
427 fprintf (stderr, "attach: listen () failed: %s\n", strerror (errno));
433 ipc_filename = g_strdup (filename);
435 server_uri = g_strdup_printf ("unix://%s/.mono-%"PRIdMAX"?/vm", directory, (intmax_t) getpid ());
442 transport_connect (void)
450 transport_send (int fd, guint8 *data, int len)
454 stats.bytes_sent += len;
455 //printf ("X: %d\n", stats.bytes_sent);
457 res = write (fd, data, len);
459 /* FIXME: What to do here ? */
466 transport_start_receive (void)
468 transport_connect ();
473 receiver_thread_handle = mono_threads_create_thread (receiver_thread, NULL, 0, 0, NULL);
474 g_assert (receiver_thread_handle);
477 static guint32 WINAPI
478 receiver_thread (void *arg)
480 int res, content_len;
485 printf ("attach: Listening on '%s'...\n", server_uri);
488 conn_fd = accept (listen_fd, NULL, NULL);
490 /* Probably closed by mono_attach_cleanup () */
493 printf ("attach: Connected.\n");
495 mono_thread_attach (mono_get_root_domain ());
496 /* Ask the runtime to not abort this thread */
497 //mono_thread_current ()->flags |= MONO_THREAD_FLAG_DONT_MANAGE;
498 /* Ask the runtime to not wait for this thread */
499 mono_thread_internal_current ()->state |= ThreadState_Background;
502 char *cmd, *agent_name, *agent_args;
506 res = read (conn_fd, buffer, 6);
508 if (res == -1 && errno == EINTR)
511 if (res == -1 || stop_receiver_thread)
517 if ((strncmp ((char*)buffer, "MONO", 4) != 0) || buffer [4] != 1 || buffer [5] != 0) {
518 fprintf (stderr, "attach: message from server has unknown header.\n");
522 /* Read content length */
523 res = read (conn_fd, buffer, 4);
530 content_len = decode_int (p, &p, p_end);
532 /* Read message body */
533 body = g_malloc (content_len);
534 res = read (conn_fd, body, content_len);
537 p_end = body + content_len;
539 cmd = decode_string_value (p, &p, p_end);
542 g_assert (!strcmp (cmd, "attach"));
544 agent_name = decode_string_value (p, &p, p_end);
545 agent_args = decode_string_value (p, &p, p_end);
547 printf ("attach: Loading agent '%s'.\n", agent_name);
548 mono_attach_load_agent (mono_domain_get (), agent_name, agent_args, &exc);
552 // FIXME: Send back a result
558 printf ("attach: Disconnected.\n");
560 if (stop_receiver_thread)
567 #else /* DISABLE_ATTACH */
570 mono_attach_parse_options (char *options)
575 mono_attach_init (void)
580 mono_attach_start (void)
586 mono_attach_maybe_start (void)
591 mono_attach_cleanup (void)
595 #endif /* DISABLE_ATTACH */