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 };
43 /* Display server running on */
44 DisplayServer *display_server;
46 /* PID of child process */
49 /* Pipes to talk to child */
51 int from_child_output;
52 GIOChannel *from_child_channel;
53 guint from_child_watch;
56 /* User to authenticate as */
59 /* TRUE if is a guest account */
62 /* User object that matches the current username */
65 /* PAM service to use */
68 /* TRUE if should run PAM authentication phase */
69 gboolean do_authenticate;
71 /* TRUE if can handle PAM prompts */
72 gboolean is_interactive;
74 /* Messages being requested by PAM */
76 struct pam_message *messages;
78 /* Authentication result from PAM */
79 gboolean authentication_started;
80 gboolean authentication_complete;
81 int authentication_result;
82 gchar *authentication_result_string;
90 /* tty this session is running on */
93 /* X display connected to */
95 XAuthority *x_authority;
96 gboolean x_authority_use_system_location;
98 /* Remote host this session is being controlled from */
99 gchar *remote_host_name;
101 /* Console kit cookie */
102 gchar *console_kit_cookie;
105 gchar *login1_session;
107 /* Environment to set in child */
110 /* Command to run in child */
113 /* True if have run command */
114 gboolean command_run;
116 /* TRUE if stopping this session */
120 /* Maximum length of a string to pass between daemon and session */
121 #define MAX_STRING_LENGTH 65535
123 G_DEFINE_TYPE (Session, session, G_TYPE_OBJECT);
128 return g_object_new (SESSION_TYPE, NULL);
132 session_set_session_type (Session *session, const gchar *session_type)
134 g_return_if_fail (session != NULL);
135 g_free (session->priv->session_type);
136 session->priv->session_type = g_strdup (session_type);
140 session_get_session_type (Session *session)
142 g_return_val_if_fail (session != NULL, NULL);
143 return session->priv->session_type;
147 session_set_pam_service (Session *session, const gchar *pam_service)
149 g_return_if_fail (session != NULL);
150 g_free (session->priv->pam_service);
151 session->priv->pam_service = g_strdup (pam_service);
155 session_set_username (Session *session, const gchar *username)
157 g_return_if_fail (session != NULL);
158 g_free (session->priv->username);
159 session->priv->username = g_strdup (username);
163 session_set_do_authenticate (Session *session, gboolean do_authenticate)
165 g_return_if_fail (session != NULL);
166 session->priv->do_authenticate = do_authenticate;
170 session_set_is_interactive (Session *session, gboolean is_interactive)
172 g_return_if_fail (session != NULL);
173 session->priv->is_interactive = is_interactive;
177 session_set_is_guest (Session *session, gboolean is_guest)
179 g_return_if_fail (session != NULL);
180 session->priv->is_guest = is_guest;
184 session_get_is_guest (Session *session)
186 g_return_val_if_fail (session != NULL, FALSE);
187 return session->priv->is_guest;
191 session_set_log_file (Session *session, const gchar *filename)
193 g_return_if_fail (session != NULL);
194 g_free (session->priv->log_filename);
195 session->priv->log_filename = g_strdup (filename);
199 session_set_class (Session *session, const gchar *class)
201 g_return_if_fail (session != NULL);
202 g_free (session->priv->class);
203 session->priv->class = g_strdup (class);
207 session_set_display_server (Session *session, DisplayServer *display_server)
209 g_return_if_fail (session != NULL);
210 g_return_if_fail (display_server != NULL);
211 if (session->priv->display_server)
212 g_object_unref (session->priv->display_server);
213 session->priv->display_server = g_object_ref (display_server);
217 session_get_display_server (Session *session)
219 g_return_val_if_fail (session != NULL, NULL);
220 return session->priv->display_server;
224 session_set_tty (Session *session, const gchar *tty)
226 g_return_if_fail (session != NULL);
227 g_free (session->priv->tty);
228 session->priv->tty = g_strdup (tty);
232 session_set_xdisplay (Session *session, const gchar *xdisplay)
234 g_return_if_fail (session != NULL);
235 g_free (session->priv->xdisplay);
236 session->priv->xdisplay = g_strdup (xdisplay);
240 session_set_x_authority (Session *session, XAuthority *authority, gboolean use_system_location)
242 g_return_if_fail (session != NULL);
243 if (session->priv->x_authority)
245 g_object_unref (session->priv->x_authority);
246 session->priv->x_authority = NULL;
249 session->priv->x_authority = g_object_ref (authority);
250 session->priv->x_authority_use_system_location = use_system_location;
254 session_set_remote_host_name (Session *session, const gchar *remote_host_name)
256 g_return_if_fail (session != NULL);
257 g_free (session->priv->remote_host_name);
258 session->priv->remote_host_name = g_strdup (remote_host_name);
262 session_set_env (Session *session, const gchar *name, const gchar *value)
264 g_return_if_fail (session != NULL);
265 session->priv->env = g_list_append (session->priv->env, g_strdup_printf ("%s=%s", name, value));
269 session_set_argv (Session *session, gchar **argv)
271 g_return_if_fail (session != NULL);
272 session->priv->argv = g_strdupv (argv);
276 session_get_user (Session *session)
278 g_return_val_if_fail (session != NULL, NULL);
280 if (session->priv->username == NULL)
283 if (!session->priv->user)
284 session->priv->user = accounts_get_user_by_name (session->priv->username);
286 return session->priv->user;
290 write_data (Session *session, const void *buf, size_t count)
292 if (write (session->priv->to_child_input, buf, count) != count)
293 g_warning ("Error writing to session: %s", strerror (errno));
297 write_string (Session *session, const char *value)
301 length = value ? strlen (value) : -1;
302 write_data (session, &length, sizeof (length));
304 write_data (session, value, sizeof (char) * length);
308 write_xauth (Session *session, XAuthority *x_authority)
315 write_string (session, NULL);
319 write_string (session, x_authority_get_authorization_name (session->priv->x_authority));
320 family = x_authority_get_family (session->priv->x_authority);
321 write_data (session, &family, sizeof (family));
322 length = x_authority_get_address_length (session->priv->x_authority);
323 write_data (session, &length, sizeof (length));
324 write_data (session, x_authority_get_address (session->priv->x_authority), length);
325 write_string (session, x_authority_get_number (session->priv->x_authority));
326 length = x_authority_get_authorization_data_length (session->priv->x_authority);
327 write_data (session, &length, sizeof (length));
328 write_data (session, x_authority_get_authorization_data (session->priv->x_authority), length);
332 read_from_child (Session *session, void *buf, size_t count)
335 n_read = read (session->priv->from_child_output, buf, count);
337 g_warning ("Error reading from session: %s", strerror (errno));
342 read_string_from_child (Session *session)
347 if (read_from_child (session, &length, sizeof (length)) <= 0)
351 if (length > MAX_STRING_LENGTH)
353 g_warning ("Invalid string length %d from child", length);
357 value = g_malloc (sizeof (char) * (length + 1));
358 read_from_child (session, value, length);
359 value[length] = '\0';
365 session_watch_cb (GPid pid, gint status, gpointer data)
367 Session *session = data;
369 session->priv->pid = 0;
371 if (WIFEXITED (status))
372 g_debug ("Session %d exited with return value %d", pid, WEXITSTATUS (status));
373 else if (WIFSIGNALED (status))
374 g_debug ("Session %d terminated with signal %d", pid, WTERMSIG (status));
376 /* If failed during authentication then report this as an authentication failure */
377 if (session->priv->authentication_started && !session->priv->authentication_complete)
379 g_debug ("Session %d failed during authentication", pid);
380 session->priv->authentication_complete = TRUE;
381 session->priv->authentication_result = PAM_CONV_ERR;
382 g_free (session->priv->authentication_result_string);
383 session->priv->authentication_result_string = g_strdup ("Authentication stopped before completion");
384 g_signal_emit (G_OBJECT (session), signals[AUTHENTICATION_COMPLETE], 0);
387 g_signal_emit (G_OBJECT (session), signals[STOPPED], 0);
389 /* Delete account if it is a guest one */
390 if (session->priv->is_guest)
391 guest_account_cleanup (session->priv->username);
393 /* Drop our reference on the child process, it has terminated */
394 g_object_unref (session);
398 from_child_cb (GIOChannel *source, GIOCondition condition, gpointer data)
400 Session *session = data;
403 gboolean auth_complete;
405 /* Remote end gone */
406 if (condition == G_IO_HUP)
408 session->priv->from_child_watch = 0;
412 /* Get the username currently being authenticated (may change during authentication) */
413 username = read_string_from_child (session);
414 if (g_strcmp0 (username, session->priv->username) != 0)
416 g_free (session->priv->username);
417 session->priv->username = username;
418 if (session->priv->user)
419 g_object_unref (session->priv->user);
420 session->priv->user = NULL;
425 /* Check if authentication completed */
426 n_read = read_from_child (session, &auth_complete, sizeof (auth_complete));
428 g_debug ("Error reading from child: %s", strerror (errno));
431 session->priv->from_child_watch = 0;
437 session->priv->authentication_complete = TRUE;
438 read_from_child (session, &session->priv->authentication_result, sizeof (session->priv->authentication_result));
439 g_free (session->priv->authentication_result_string);
440 session->priv->authentication_result_string = read_string_from_child (session);
442 g_debug ("Session %d authentication complete with return value %d: %s", session->priv->pid, session->priv->authentication_result, session->priv->authentication_result_string);
444 /* No longer expect any more messages */
445 session->priv->from_child_watch = 0;
447 g_signal_emit (G_OBJECT (session), signals[AUTHENTICATION_COMPLETE], 0);
455 session->priv->messages_length = 0;
456 read_from_child (session, &session->priv->messages_length, sizeof (session->priv->messages_length));
457 session->priv->messages = calloc (session->priv->messages_length, sizeof (struct pam_message));
458 for (i = 0; i < session->priv->messages_length; i++)
460 struct pam_message *m = &session->priv->messages[i];
461 read_from_child (session, &m->msg_style, sizeof (m->msg_style));
462 m->msg = read_string_from_child (session);
465 g_debug ("Session %d got %d message(s) from PAM", session->priv->pid, session->priv->messages_length);
467 g_signal_emit (G_OBJECT (session), signals[GOT_MESSAGES], 0);
474 session_start (Session *session)
476 g_return_val_if_fail (session != NULL, FALSE);
477 g_return_val_if_fail (session->priv->display_server != NULL, FALSE);
478 return SESSION_GET_CLASS (session)->start (session);
482 session_get_is_started (Session *session)
484 return session->priv->pid != 0;
488 session_real_start (Session *session)
491 int to_child_pipe[2], from_child_pipe[2];
492 int to_child_output, from_child_input;
494 g_return_val_if_fail (session->priv->pid == 0, FALSE);
496 display_server_setup_session (session->priv->display_server, session);
498 /* Create pipes to talk to the child */
499 if (pipe (to_child_pipe) < 0 || pipe (from_child_pipe) < 0)
501 g_warning ("Failed to create pipe to communicate with session process: %s", strerror (errno));
504 to_child_output = to_child_pipe[0];
505 session->priv->to_child_input = to_child_pipe[1];
506 session->priv->from_child_output = from_child_pipe[0];
507 from_child_input = from_child_pipe[1];
508 session->priv->from_child_channel = g_io_channel_unix_new (session->priv->from_child_output);
509 session->priv->from_child_watch = g_io_add_watch (session->priv->from_child_channel, G_IO_IN | G_IO_HUP, from_child_cb, session);
511 /* Don't allow the daemon end of the pipes to be accessed in child processes */
512 fcntl (session->priv->to_child_input, F_SETFD, FD_CLOEXEC);
513 fcntl (session->priv->from_child_output, F_SETFD, FD_CLOEXEC);
515 /* Create the guest account if it is one */
516 if (session->priv->is_guest && session->priv->username == NULL)
518 session->priv->username = guest_account_setup ();
519 if (!session->priv->username)
524 session->priv->pid = fork ();
525 if (session->priv->pid < 0)
527 g_debug ("Failed to fork session child process: %s", strerror (errno));
531 if (session->priv->pid == 0)
533 /* Run us again in session child mode */
537 g_strdup_printf ("%d", to_child_output),
538 g_strdup_printf ("%d", from_child_input),
540 _exit (EXIT_FAILURE);
543 /* Hold a reference on this object until the child process terminates so we
544 * can handle the watch callback even if it is no longer used. Otherwise a
545 * zombie process will remain */
546 g_object_ref (session);
548 /* Listen for session termination */
549 session->priv->authentication_started = TRUE;
550 session->priv->child_watch = g_child_watch_add (session->priv->pid, session_watch_cb, session);
552 /* Close the ends of the pipes we don't need */
553 close (to_child_output);
554 close (from_child_input);
556 /* Indicate what version of the protocol we are using */
558 write_data (session, &version, sizeof (version));
560 /* Send configuration */
561 write_string (session, session->priv->pam_service);
562 write_string (session, session->priv->username);
563 write_data (session, &session->priv->do_authenticate, sizeof (session->priv->do_authenticate));
564 write_data (session, &session->priv->is_interactive, sizeof (session->priv->is_interactive));
565 write_string (session, session->priv->class);
566 write_string (session, session->priv->tty);
567 write_string (session, session->priv->remote_host_name);
568 write_string (session, session->priv->xdisplay);
569 write_xauth (session, session->priv->x_authority);
571 g_debug ("Started session %d with service '%s', username '%s'", session->priv->pid, session->priv->pam_service, session->priv->username);
577 session_get_username (Session *session)
579 g_return_val_if_fail (session != NULL, NULL);
580 return session->priv->username;
584 session_get_console_kit_cookie (Session *session)
586 g_return_val_if_fail (session != NULL, NULL);
587 return session->priv->console_kit_cookie;
591 session_respond (Session *session, struct pam_response *response)
593 int error = PAM_SUCCESS;
596 g_return_if_fail (session != NULL);
598 write_data (session, &error, sizeof (error));
599 for (i = 0; i < session->priv->messages_length; i++)
601 write_string (session, response[i].resp);
602 write_data (session, &response[i].resp_retcode, sizeof (response[i].resp_retcode));
605 /* Delete the old messages */
606 for (i = 0; i < session->priv->messages_length; i++)
607 g_free ((char *) session->priv->messages[i].msg);
608 g_free (session->priv->messages);
609 session->priv->messages = NULL;
610 session->priv->messages_length = 0;
614 session_respond_error (Session *session, int error)
616 g_return_if_fail (session != NULL);
617 g_return_if_fail (error != PAM_SUCCESS);
619 write_data (session, &error, sizeof (error));
623 session_get_messages_length (Session *session)
625 g_return_val_if_fail (session != NULL, 0);
626 return session->priv->messages_length;
629 const struct pam_message *
630 session_get_messages (Session *session)
632 g_return_val_if_fail (session != NULL, NULL);
633 return session->priv->messages;
637 session_get_is_authenticated (Session *session)
639 g_return_val_if_fail (session != NULL, FALSE);
640 return session->priv->authentication_complete && session->priv->authentication_result == PAM_SUCCESS;
644 session_get_authentication_result (Session *session)
646 g_return_val_if_fail (session != NULL, 0);
647 return session->priv->authentication_result;
651 session_get_authentication_result_string (Session *session)
653 g_return_val_if_fail (session != NULL, NULL);
654 return session->priv->authentication_result_string;
658 session_run (Session *session)
660 g_return_if_fail (session->priv->display_server != NULL);
661 return SESSION_GET_CLASS (session)->run (session);
665 session_real_run (Session *session)
668 gchar *command, *x_authority_filename;
671 g_return_if_fail (session != NULL);
672 g_return_if_fail (!session->priv->command_run);
673 g_return_if_fail (session_get_is_authenticated (session));
674 g_return_if_fail (session->priv->argv != NULL);
675 g_return_if_fail (session->priv->pid != 0);
677 display_server_setup_session (session->priv->display_server, session);
679 session->priv->command_run = TRUE;
681 command = g_strjoinv (" ", session->priv->argv);
682 g_debug ("Session %d running command %s", session->priv->pid, command);
685 /* Create authority location */
686 if (session->priv->x_authority_use_system_location)
688 gchar *run_dir, *dir;
690 run_dir = config_get_string (config_get_instance (), "LightDM", "run-directory");
691 dir = g_build_filename (run_dir, session->priv->username, NULL);
694 if (g_mkdir_with_parents (dir, S_IRWXU) < 0)
695 g_warning ("Failed to set create system authority dir %s: %s", dir, strerror (errno));
698 if (chown (dir, user_get_uid (session_get_user (session)), user_get_gid (session_get_user (session))) < 0)
699 g_warning ("Failed to set ownership of user authority dir: %s", strerror (errno));
702 x_authority_filename = g_build_filename (dir, "xauthority", NULL);
706 x_authority_filename = g_build_filename (user_get_home_directory (session_get_user (session)), ".Xauthority", NULL);
708 write_string (session, session->priv->log_filename);
709 write_string (session, session->priv->tty);
710 write_string (session, x_authority_filename);
711 g_free (x_authority_filename);
712 write_string (session, session->priv->xdisplay);
713 write_xauth (session, session->priv->x_authority);
714 argc = g_list_length (session->priv->env);
715 write_data (session, &argc, sizeof (argc));
716 for (link = session->priv->env; link; link = link->next)
717 write_string (session, (gchar *) link->data);
718 argc = g_strv_length (session->priv->argv);
719 write_data (session, &argc, sizeof (argc));
720 for (i = 0; i < argc; i++)
721 write_string (session, session->priv->argv[i]);
723 if (login1_is_running ())
724 session->priv->login1_session = read_string_from_child (session);
725 if (!session->priv->login1_session)
726 session->priv->console_kit_cookie = read_string_from_child (session);
730 session_lock (Session *session)
732 g_return_if_fail (session != NULL);
735 if (login1_is_running ())
736 login1_lock_session (session->priv->login1_session);
737 if (!session->priv->login1_session)
738 ck_lock_session (session->priv->console_kit_cookie);
743 session_unlock (Session *session)
745 g_return_if_fail (session != NULL);
748 if (login1_is_running ())
749 login1_unlock_session (session->priv->login1_session);
750 if (!session->priv->login1_session)
751 ck_unlock_session (session->priv->console_kit_cookie);
756 session_stop (Session *session)
758 g_return_if_fail (session != NULL);
760 if (session->priv->stopping)
762 session->priv->stopping = TRUE;
764 return SESSION_GET_CLASS (session)->stop (session);
768 session_real_stop (Session *session)
770 g_return_if_fail (session != NULL);
772 if (session->priv->pid > 0)
774 g_debug ("Session %d: Sending SIGTERM", session->priv->pid);
775 kill (session->priv->pid, SIGTERM);
776 // FIXME: Handle timeout
779 g_signal_emit (G_OBJECT (session), signals[STOPPED], 0);
783 session_get_is_stopping (Session *session)
785 g_return_val_if_fail (session != NULL, FALSE);
786 return session->priv->stopping;
790 session_init (Session *session)
792 session->priv = G_TYPE_INSTANCE_GET_PRIVATE (session, SESSION_TYPE, SessionPrivate);
793 session->priv->log_filename = g_strdup (".xsession-errors");
797 session_finalize (GObject *object)
799 Session *self = SESSION (object);
802 g_free (self->priv->session_type);
803 if (self->priv->display_server)
804 g_object_unref (self->priv->display_server);
806 kill (self->priv->pid, SIGKILL);
807 if (self->priv->from_child_channel)
808 g_io_channel_unref (self->priv->from_child_channel);
809 if (self->priv->from_child_watch)
810 g_source_remove (self->priv->from_child_watch);
811 if (self->priv->child_watch)
812 g_source_remove (self->priv->child_watch);
813 g_free (self->priv->username);
814 if (self->priv->user)
815 g_object_unref (self->priv->user);
816 g_free (self->priv->pam_service);
817 for (i = 0; i < self->priv->messages_length; i++)
818 g_free ((char *) self->priv->messages[i].msg);
819 g_free (self->priv->messages);
820 g_free (self->priv->authentication_result_string);
821 g_free (self->priv->log_filename);
822 g_free (self->priv->class);
823 g_free (self->priv->tty);
824 g_free (self->priv->xdisplay);
825 if (self->priv->x_authority)
826 g_object_unref (self->priv->x_authority);
827 g_free (self->priv->remote_host_name);
828 g_free (self->priv->login1_session);
829 g_free (self->priv->console_kit_cookie);
830 g_list_free_full (self->priv->env, g_free);
831 g_strfreev (self->priv->argv);
833 G_OBJECT_CLASS (session_parent_class)->finalize (object);
837 session_class_init (SessionClass *klass)
839 GObjectClass *object_class = G_OBJECT_CLASS (klass);
841 klass->start = session_real_start;
842 klass->run = session_real_run;
843 klass->stop = session_real_stop;
844 object_class->finalize = session_finalize;
846 g_type_class_add_private (klass, sizeof (SessionPrivate));
848 signals[GOT_MESSAGES] =
849 g_signal_new ("got-messages",
850 G_TYPE_FROM_CLASS (klass),
852 G_STRUCT_OFFSET (SessionClass, got_messages),
857 signals[AUTHENTICATION_COMPLETE] =
858 g_signal_new ("authentication-complete",
859 G_TYPE_FROM_CLASS (klass),
861 G_STRUCT_OFFSET (SessionClass, authentication_complete),
867 g_signal_new ("stopped",
868 G_TYPE_FROM_CLASS (klass),
870 G_STRUCT_OFFSET (SessionClass, stopped),