2 * Copyright (C) 2010-2011 Robert Ancell.
3 * Author: Robert Ancell <robert.ancell@canonical.com>
5 * This program is free software: you can redistribute it and/or modify it under
6 * the terms of the GNU General Public License as published by the Free Software
7 * Foundation, either version 3 of the License, or (at your option) any later
8 * version. See http://www.gnu.org/copyleft/gpl.html the full text of the
20 #include <glib/gstdio.h>
25 #include "configuration.h"
26 #include "console-kit.h"
28 #include "guest-account.h"
32 AUTHENTICATION_COMPLETE,
36 static guint signals[LAST_SIGNAL] = { 0 };
40 /* Display server running on */
41 DisplayServer *display_server;
43 /* PID of child process */
46 /* Pipes to talk to child */
48 int from_child_output;
49 GIOChannel *from_child_channel;
50 guint from_child_watch;
53 /* User to authenticate as */
56 /* TRUE if is a guest account */
59 /* User object that matches the current username */
62 /* PAM service to use */
65 /* TRUE if should run PAM authentication phase */
66 gboolean do_authenticate;
68 /* TRUE if can handle PAM prompts */
69 gboolean is_interactive;
71 /* Messages being requested by PAM */
73 struct pam_message *messages;
75 /* Authentication result from PAM */
76 gboolean authentication_started;
77 gboolean authentication_complete;
78 int authentication_result;
79 gchar *authentication_result_string;
87 /* tty this session is running on */
90 /* X display connected to */
92 XAuthority *xauthority;
93 gboolean xauth_use_system_location;
95 /* Remote host this session is being controlled from */
96 gchar *remote_host_name;
98 /* Console kit cookie */
99 gchar *console_kit_cookie;
102 gchar *login1_session;
104 /* Environment to set in child */
107 /* Command to run in child */
110 /* True if have run command */
111 gboolean command_run;
113 /* TRUE if stopping this session */
117 /* Maximum length of a string to pass between daemon and session */
118 #define MAX_STRING_LENGTH 65535
120 G_DEFINE_TYPE (Session, session, G_TYPE_OBJECT);
125 return g_object_new (SESSION_TYPE, NULL);
129 session_set_session_type (Session *session, const gchar *session_type)
134 session_get_session_type (Session *session)
136 g_return_val_if_fail (session != NULL, NULL);
141 session_set_pam_service (Session *session, const gchar *pam_service)
143 g_return_if_fail (session != NULL);
144 g_free (session->priv->pam_service);
145 session->priv->pam_service = g_strdup (pam_service);
149 session_set_username (Session *session, const gchar *username)
151 g_return_if_fail (session != NULL);
152 g_free (session->priv->username);
153 session->priv->username = g_strdup (username);
157 session_set_do_authenticate (Session *session, gboolean do_authenticate)
159 g_return_if_fail (session != NULL);
160 session->priv->do_authenticate = do_authenticate;
164 session_set_is_interactive (Session *session, gboolean is_interactive)
166 g_return_if_fail (session != NULL);
167 session->priv->is_interactive = is_interactive;
171 session_set_is_guest (Session *session, gboolean is_guest)
173 g_return_if_fail (session != NULL);
174 session->priv->is_guest = is_guest;
178 session_get_is_guest (Session *session)
180 g_return_val_if_fail (session != NULL, FALSE);
181 return session->priv->is_guest;
185 session_set_log_file (Session *session, const gchar *filename)
187 g_return_if_fail (session != NULL);
188 g_free (session->priv->log_filename);
189 session->priv->log_filename = g_strdup (filename);
193 session_set_class (Session *session, const gchar *class)
195 g_return_if_fail (session != NULL);
196 g_free (session->priv->class);
197 session->priv->class = g_strdup (class);
201 session_set_display_server (Session *session, DisplayServer *display_server)
203 g_return_if_fail (session != NULL);
204 g_return_if_fail (display_server != NULL);
205 if (session->priv->display_server)
206 g_object_unref (session->priv->display_server);
207 session->priv->display_server = g_object_ref (display_server);
211 session_get_display_server (Session *session)
213 g_return_val_if_fail (session != NULL, NULL);
214 return session->priv->display_server;
218 session_set_tty (Session *session, const gchar *tty)
220 g_return_if_fail (session != NULL);
221 g_free (session->priv->tty);
222 session->priv->tty = g_strdup (tty);
226 session_set_xdisplay (Session *session, const gchar *xdisplay)
228 g_return_if_fail (session != NULL);
229 g_free (session->priv->xdisplay);
230 session->priv->xdisplay = g_strdup (xdisplay);
234 session_set_xauthority (Session *session, XAuthority *authority, gboolean use_system_location)
236 g_return_if_fail (session != NULL);
237 if (session->priv->xauthority)
239 g_object_unref (session->priv->xauthority);
240 session->priv->xauthority = NULL;
243 session->priv->xauthority = g_object_ref (authority);
244 session->priv->xauth_use_system_location = use_system_location;
248 session_set_remote_host_name (Session *session, const gchar *remote_host_name)
250 g_return_if_fail (session != NULL);
251 g_free (session->priv->remote_host_name);
252 session->priv->remote_host_name = g_strdup (remote_host_name);
256 session_set_env (Session *session, const gchar *name, const gchar *value)
258 g_return_if_fail (session != NULL);
259 session->priv->env = g_list_append (session->priv->env, g_strdup_printf ("%s=%s", name, value));
263 session_set_argv (Session *session, gchar **argv)
265 g_return_if_fail (session != NULL);
266 session->priv->argv = g_strdupv (argv);
270 session_get_user (Session *session)
272 g_return_val_if_fail (session != NULL, NULL);
274 if (session->priv->username == NULL)
277 if (!session->priv->user)
278 session->priv->user = accounts_get_user_by_name (session->priv->username);
280 return session->priv->user;
284 write_data (Session *session, const void *buf, size_t count)
286 if (write (session->priv->to_child_input, buf, count) != count)
287 g_warning ("Error writing to session: %s", strerror (errno));
291 write_string (Session *session, const char *value)
295 length = value ? strlen (value) : -1;
296 write_data (session, &length, sizeof (length));
298 write_data (session, value, sizeof (char) * length);
302 write_xauth (Session *session, XAuthority *xauthority)
309 write_string (session, NULL);
313 write_string (session, xauth_get_authorization_name (session->priv->xauthority));
314 family = xauth_get_family (session->priv->xauthority);
315 write_data (session, &family, sizeof (family));
316 length = xauth_get_address_length (session->priv->xauthority);
317 write_data (session, &length, sizeof (length));
318 write_data (session, xauth_get_address (session->priv->xauthority), length);
319 write_string (session, xauth_get_number (session->priv->xauthority));
320 length = xauth_get_authorization_data_length (session->priv->xauthority);
321 write_data (session, &length, sizeof (length));
322 write_data (session, xauth_get_authorization_data (session->priv->xauthority), length);
326 read_from_child (Session *session, void *buf, size_t count)
329 n_read = read (session->priv->from_child_output, buf, count);
331 g_warning ("Error reading from session: %s", strerror (errno));
336 read_string_from_child (Session *session)
341 if (read_from_child (session, &length, sizeof (length)) <= 0)
345 if (length > MAX_STRING_LENGTH)
347 g_warning ("Invalid string length %d from child", length);
351 value = g_malloc (sizeof (char) * (length + 1));
352 read_from_child (session, value, length);
353 value[length] = '\0';
359 session_watch_cb (GPid pid, gint status, gpointer data)
361 Session *session = data;
363 session->priv->pid = 0;
365 if (WIFEXITED (status))
366 g_debug ("Session %d exited with return value %d", pid, WEXITSTATUS (status));
367 else if (WIFSIGNALED (status))
368 g_debug ("Session %d terminated with signal %d", pid, WTERMSIG (status));
370 /* If failed during authentication then report this as an authentication failure */
371 if (session->priv->authentication_started && !session->priv->authentication_complete)
373 g_debug ("Session %d failed during authentication", pid);
374 session->priv->authentication_complete = TRUE;
375 session->priv->authentication_result = PAM_CONV_ERR;
376 g_free (session->priv->authentication_result_string);
377 session->priv->authentication_result_string = g_strdup ("Authentication stopped before completion");
378 g_signal_emit (G_OBJECT (session), signals[AUTHENTICATION_COMPLETE], 0);
381 g_signal_emit (G_OBJECT (session), signals[STOPPED], 0);
383 /* Delete account if it is a guest one */
384 if (session->priv->is_guest)
385 guest_account_cleanup (session->priv->username);
387 /* Drop our reference on the child process, it has terminated */
388 g_object_unref (session);
392 from_child_cb (GIOChannel *source, GIOCondition condition, gpointer data)
394 Session *session = data;
397 gboolean auth_complete;
399 /* Remote end gone */
400 if (condition == G_IO_HUP)
402 session->priv->from_child_watch = 0;
406 /* Get the username currently being authenticated (may change during authentication) */
407 username = read_string_from_child (session);
408 if (g_strcmp0 (username, session->priv->username) != 0)
410 g_free (session->priv->username);
411 session->priv->username = username;
412 if (session->priv->user)
413 g_object_unref (session->priv->user);
414 session->priv->user = NULL;
419 /* Check if authentication completed */
420 n_read = read_from_child (session, &auth_complete, sizeof (auth_complete));
422 g_debug ("Error reading from child: %s", strerror (errno));
425 session->priv->from_child_watch = 0;
431 session->priv->authentication_complete = TRUE;
432 read_from_child (session, &session->priv->authentication_result, sizeof (session->priv->authentication_result));
433 g_free (session->priv->authentication_result_string);
434 session->priv->authentication_result_string = read_string_from_child (session);
436 g_debug ("Session %d authentication complete with return value %d: %s", session->priv->pid, session->priv->authentication_result, session->priv->authentication_result_string);
438 /* No longer expect any more messages */
439 session->priv->from_child_watch = 0;
441 g_signal_emit (G_OBJECT (session), signals[AUTHENTICATION_COMPLETE], 0);
449 session->priv->messages_length = 0;
450 read_from_child (session, &session->priv->messages_length, sizeof (session->priv->messages_length));
451 session->priv->messages = calloc (session->priv->messages_length, sizeof (struct pam_message));
452 for (i = 0; i < session->priv->messages_length; i++)
454 struct pam_message *m = &session->priv->messages[i];
455 read_from_child (session, &m->msg_style, sizeof (m->msg_style));
456 m->msg = read_string_from_child (session);
459 g_debug ("Session %d got %d message(s) from PAM", session->priv->pid, session->priv->messages_length);
461 g_signal_emit (G_OBJECT (session), signals[GOT_MESSAGES], 0);
468 session_start (Session *session)
470 g_return_val_if_fail (session != NULL, FALSE);
471 g_return_val_if_fail (session->priv->display_server != NULL, FALSE);
472 return SESSION_GET_CLASS (session)->start (session);
476 session_get_is_started (Session *session)
478 return session->priv->pid != 0;
482 session_real_start (Session *session)
485 int to_child_pipe[2], from_child_pipe[2];
486 int to_child_output, from_child_input;
488 g_return_val_if_fail (session->priv->pid == 0, FALSE);
490 display_server_setup_session (session->priv->display_server, session);
492 /* Create pipes to talk to the child */
493 if (pipe (to_child_pipe) < 0 || pipe (from_child_pipe) < 0)
495 g_warning ("Failed to create pipe to communicate with session process: %s", strerror (errno));
498 to_child_output = to_child_pipe[0];
499 session->priv->to_child_input = to_child_pipe[1];
500 session->priv->from_child_output = from_child_pipe[0];
501 from_child_input = from_child_pipe[1];
502 session->priv->from_child_channel = g_io_channel_unix_new (session->priv->from_child_output);
503 session->priv->from_child_watch = g_io_add_watch (session->priv->from_child_channel, G_IO_IN | G_IO_HUP, from_child_cb, session);
505 /* Don't allow the daemon end of the pipes to be accessed in child processes */
506 fcntl (session->priv->to_child_input, F_SETFD, FD_CLOEXEC);
507 fcntl (session->priv->from_child_output, F_SETFD, FD_CLOEXEC);
509 /* Create the guest account if it is one */
510 if (session->priv->is_guest && session->priv->username == NULL)
512 session->priv->username = guest_account_setup ();
513 if (!session->priv->username)
518 session->priv->pid = fork ();
519 if (session->priv->pid < 0)
521 g_debug ("Failed to fork session child process: %s", strerror (errno));
525 if (session->priv->pid == 0)
527 /* Run us again in session child mode */
531 g_strdup_printf ("%d", to_child_output),
532 g_strdup_printf ("%d", from_child_input),
534 _exit (EXIT_FAILURE);
537 /* Hold a reference on this object until the child process terminates so we
538 * can handle the watch callback even if it is no longer used. Otherwise a
539 * zombie process will remain */
540 g_object_ref (session);
542 /* Listen for session termination */
543 session->priv->authentication_started = TRUE;
544 session->priv->child_watch = g_child_watch_add (session->priv->pid, session_watch_cb, session);
546 /* Close the ends of the pipes we don't need */
547 close (to_child_output);
548 close (from_child_input);
550 /* Indicate what version of the protocol we are using */
552 write_data (session, &version, sizeof (version));
554 /* Send configuration */
555 write_string (session, session->priv->pam_service);
556 write_string (session, session->priv->username);
557 write_data (session, &session->priv->do_authenticate, sizeof (session->priv->do_authenticate));
558 write_data (session, &session->priv->is_interactive, sizeof (session->priv->is_interactive));
559 write_string (session, session->priv->class);
560 write_string (session, session->priv->tty);
561 write_string (session, session->priv->remote_host_name);
562 write_string (session, session->priv->xdisplay);
563 write_xauth (session, session->priv->xauthority);
565 g_debug ("Started session %d with service '%s', username '%s'", session->priv->pid, session->priv->pam_service, session->priv->username);
571 session_get_username (Session *session)
573 g_return_val_if_fail (session != NULL, NULL);
574 return session->priv->username;
578 session_get_console_kit_cookie (Session *session)
580 g_return_val_if_fail (session != NULL, NULL);
581 return session->priv->console_kit_cookie;
585 session_respond (Session *session, struct pam_response *response)
587 int error = PAM_SUCCESS;
590 g_return_if_fail (session != NULL);
592 write_data (session, &error, sizeof (error));
593 for (i = 0; i < session->priv->messages_length; i++)
595 write_string (session, response[i].resp);
596 write_data (session, &response[i].resp_retcode, sizeof (response[i].resp_retcode));
599 /* Delete the old messages */
600 for (i = 0; i < session->priv->messages_length; i++)
601 g_free ((char *) session->priv->messages[i].msg);
602 g_free (session->priv->messages);
603 session->priv->messages = NULL;
604 session->priv->messages_length = 0;
608 session_respond_error (Session *session, int error)
610 g_return_if_fail (session != NULL);
611 g_return_if_fail (error != PAM_SUCCESS);
613 write_data (session, &error, sizeof (error));
617 session_get_messages_length (Session *session)
619 g_return_val_if_fail (session != NULL, 0);
620 return session->priv->messages_length;
623 const struct pam_message *
624 session_get_messages (Session *session)
626 g_return_val_if_fail (session != NULL, NULL);
627 return session->priv->messages;
631 session_get_is_authenticated (Session *session)
633 g_return_val_if_fail (session != NULL, FALSE);
634 return session->priv->authentication_complete && session->priv->authentication_result == PAM_SUCCESS;
638 session_get_authentication_result (Session *session)
640 g_return_val_if_fail (session != NULL, 0);
641 return session->priv->authentication_result;
645 session_get_authentication_result_string (Session *session)
647 g_return_val_if_fail (session != NULL, NULL);
648 return session->priv->authentication_result_string;
652 session_run (Session *session)
654 g_return_if_fail (session->priv->display_server != NULL);
655 return SESSION_GET_CLASS (session)->run (session);
659 session_real_run (Session *session)
662 gchar *command, *xauth_filename;
665 g_return_if_fail (session != NULL);
666 g_return_if_fail (!session->priv->command_run);
667 g_return_if_fail (session_get_is_authenticated (session));
668 g_return_if_fail (session->priv->argv != NULL);
669 g_return_if_fail (session->priv->pid != 0);
671 display_server_setup_session (session->priv->display_server, session);
673 session->priv->command_run = TRUE;
675 command = g_strjoinv (" ", session->priv->argv);
676 g_debug ("Session %d running command %s", session->priv->pid, command);
679 /* Create authority location */
680 if (session->priv->xauth_use_system_location)
682 gchar *run_dir, *dir;
684 run_dir = config_get_string (config_get_instance (), "LightDM", "run-directory");
685 dir = g_build_filename (run_dir, session->priv->username, NULL);
688 if (g_mkdir_with_parents (dir, S_IRWXU) < 0)
689 g_warning ("Failed to set create system authority dir %s: %s", dir, strerror (errno));
692 if (chown (dir, user_get_uid (session_get_user (session)), user_get_gid (session_get_user (session))) < 0)
693 g_warning ("Failed to set ownership of user authority dir: %s", strerror (errno));
696 xauth_filename = g_build_filename (dir, "xauthority", NULL);
700 xauth_filename = g_build_filename (user_get_home_directory (session_get_user (session)), ".Xauthority", NULL);
702 write_string (session, session->priv->log_filename);
703 write_string (session, session->priv->tty);
704 write_string (session, xauth_filename);
705 g_free (xauth_filename);
706 write_string (session, session->priv->xdisplay);
707 write_xauth (session, session->priv->xauthority);
708 argc = g_list_length (session->priv->env);
709 write_data (session, &argc, sizeof (argc));
710 for (link = session->priv->env; link; link = link->next)
711 write_string (session, (gchar *) link->data);
712 argc = g_strv_length (session->priv->argv);
713 write_data (session, &argc, sizeof (argc));
714 for (i = 0; i < argc; i++)
715 write_string (session, session->priv->argv[i]);
717 if (login1_is_running ())
718 session->priv->login1_session = read_string_from_child (session);
719 if (!session->priv->login1_session)
720 session->priv->console_kit_cookie = read_string_from_child (session);
724 session_lock (Session *session)
726 g_return_if_fail (session != NULL);
729 if (login1_is_running ())
730 login1_lock_session (session->priv->login1_session);
731 if (!session->priv->login1_session)
732 ck_lock_session (session->priv->console_kit_cookie);
737 session_unlock (Session *session)
739 g_return_if_fail (session != NULL);
742 if (login1_is_running ())
743 login1_unlock_session (session->priv->login1_session);
744 if (!session->priv->login1_session)
745 ck_unlock_session (session->priv->console_kit_cookie);
750 session_stop (Session *session)
752 g_return_if_fail (session != NULL);
754 if (session->priv->stopping)
756 session->priv->stopping = TRUE;
758 return SESSION_GET_CLASS (session)->stop (session);
762 session_real_stop (Session *session)
764 g_return_if_fail (session != NULL);
766 if (session->priv->pid > 0)
768 g_debug ("Session %d: Sending SIGTERM", session->priv->pid);
769 kill (session->priv->pid, SIGTERM);
770 // FIXME: Handle timeout
773 g_signal_emit (G_OBJECT (session), signals[STOPPED], 0);
777 session_get_is_stopping (Session *session)
779 g_return_val_if_fail (session != NULL, FALSE);
780 return session->priv->stopping;
784 session_init (Session *session)
786 session->priv = G_TYPE_INSTANCE_GET_PRIVATE (session, SESSION_TYPE, SessionPrivate);
787 session->priv->log_filename = g_strdup (".xsession-errors");
791 session_finalize (GObject *object)
793 Session *self = SESSION (object);
796 if (self->priv->display_server)
797 g_object_unref (self->priv->display_server);
799 kill (self->priv->pid, SIGKILL);
800 if (self->priv->from_child_channel)
801 g_io_channel_unref (self->priv->from_child_channel);
802 if (self->priv->from_child_watch)
803 g_source_remove (self->priv->from_child_watch);
804 if (self->priv->child_watch)
805 g_source_remove (self->priv->child_watch);
806 g_free (self->priv->username);
807 if (self->priv->user)
808 g_object_unref (self->priv->user);
809 g_free (self->priv->pam_service);
810 for (i = 0; i < self->priv->messages_length; i++)
811 g_free ((char *) self->priv->messages[i].msg);
812 g_free (self->priv->messages);
813 g_free (self->priv->authentication_result_string);
814 g_free (self->priv->log_filename);
815 g_free (self->priv->class);
816 g_free (self->priv->tty);
817 g_free (self->priv->xdisplay);
818 if (self->priv->xauthority)
819 g_object_unref (self->priv->xauthority);
820 g_free (self->priv->remote_host_name);
821 g_free (self->priv->login1_session);
822 g_free (self->priv->console_kit_cookie);
823 g_list_free_full (self->priv->env, g_free);
824 g_strfreev (self->priv->argv);
826 G_OBJECT_CLASS (session_parent_class)->finalize (object);
830 session_class_init (SessionClass *klass)
832 GObjectClass *object_class = G_OBJECT_CLASS (klass);
834 klass->start = session_real_start;
835 klass->run = session_real_run;
836 klass->stop = session_real_stop;
837 object_class->finalize = session_finalize;
839 g_type_class_add_private (klass, sizeof (SessionPrivate));
841 signals[GOT_MESSAGES] =
842 g_signal_new ("got-messages",
843 G_TYPE_FROM_CLASS (klass),
845 G_STRUCT_OFFSET (SessionClass, got_messages),
850 signals[AUTHENTICATION_COMPLETE] =
851 g_signal_new ("authentication-complete",
852 G_TYPE_FROM_CLASS (klass),
854 G_STRUCT_OFFSET (SessionClass, authentication_complete),
860 g_signal_new ("stopped",
861 G_TYPE_FROM_CLASS (klass),
863 G_STRUCT_OFFSET (SessionClass, stopped),