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 *x_authority;
93 gboolean x_authority_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_pam_service (Session *session, const gchar *pam_service)
131 g_return_if_fail (session != NULL);
132 g_free (session->priv->pam_service);
133 session->priv->pam_service = g_strdup (pam_service);
137 session_set_username (Session *session, const gchar *username)
139 g_return_if_fail (session != NULL);
140 g_free (session->priv->username);
141 session->priv->username = g_strdup (username);
145 session_set_do_authenticate (Session *session, gboolean do_authenticate)
147 g_return_if_fail (session != NULL);
148 session->priv->do_authenticate = do_authenticate;
152 session_set_is_interactive (Session *session, gboolean is_interactive)
154 g_return_if_fail (session != NULL);
155 session->priv->is_interactive = is_interactive;
159 session_set_is_guest (Session *session, gboolean is_guest)
161 g_return_if_fail (session != NULL);
162 session->priv->is_guest = is_guest;
166 session_get_is_guest (Session *session)
168 g_return_val_if_fail (session != NULL, FALSE);
169 return session->priv->is_guest;
173 session_set_log_file (Session *session, const gchar *filename)
175 g_return_if_fail (session != NULL);
176 g_free (session->priv->log_filename);
177 session->priv->log_filename = g_strdup (filename);
181 session_set_class (Session *session, const gchar *class)
183 g_return_if_fail (session != NULL);
184 g_free (session->priv->class);
185 session->priv->class = g_strdup (class);
189 session_set_display_server (Session *session, DisplayServer *display_server)
191 g_return_if_fail (session != NULL);
192 g_return_if_fail (display_server != NULL);
193 if (session->priv->display_server)
194 g_object_unref (session->priv->display_server);
195 session->priv->display_server = g_object_ref (display_server);
199 session_get_display_server (Session *session)
201 g_return_val_if_fail (session != NULL, NULL);
202 return session->priv->display_server;
206 session_set_tty (Session *session, const gchar *tty)
208 g_return_if_fail (session != NULL);
209 g_free (session->priv->tty);
210 session->priv->tty = g_strdup (tty);
214 session_set_xdisplay (Session *session, const gchar *xdisplay)
216 g_return_if_fail (session != NULL);
217 g_free (session->priv->xdisplay);
218 session->priv->xdisplay = g_strdup (xdisplay);
222 session_set_x_authority (Session *session, XAuthority *authority, gboolean use_system_location)
224 g_return_if_fail (session != NULL);
225 if (session->priv->x_authority)
227 g_object_unref (session->priv->x_authority);
228 session->priv->x_authority = NULL;
231 session->priv->x_authority = g_object_ref (authority);
232 session->priv->x_authority_use_system_location = use_system_location;
236 session_set_remote_host_name (Session *session, const gchar *remote_host_name)
238 g_return_if_fail (session != NULL);
239 g_free (session->priv->remote_host_name);
240 session->priv->remote_host_name = g_strdup (remote_host_name);
244 session_set_env (Session *session, const gchar *name, const gchar *value)
246 g_return_if_fail (session != NULL);
247 session->priv->env = g_list_append (session->priv->env, g_strdup_printf ("%s=%s", name, value));
251 session_set_argv (Session *session, gchar **argv)
253 g_return_if_fail (session != NULL);
254 session->priv->argv = g_strdupv (argv);
258 session_get_user (Session *session)
260 g_return_val_if_fail (session != NULL, NULL);
262 if (session->priv->username == NULL)
265 if (!session->priv->user)
266 session->priv->user = accounts_get_user_by_name (session->priv->username);
268 return session->priv->user;
272 write_data (Session *session, const void *buf, size_t count)
274 if (write (session->priv->to_child_input, buf, count) != count)
275 g_warning ("Error writing to session: %s", strerror (errno));
279 write_string (Session *session, const char *value)
283 length = value ? strlen (value) : -1;
284 write_data (session, &length, sizeof (length));
286 write_data (session, value, sizeof (char) * length);
290 write_xauth (Session *session, XAuthority *x_authority)
297 write_string (session, NULL);
301 write_string (session, x_authority_get_authorization_name (session->priv->x_authority));
302 family = x_authority_get_family (session->priv->x_authority);
303 write_data (session, &family, sizeof (family));
304 length = x_authority_get_address_length (session->priv->x_authority);
305 write_data (session, &length, sizeof (length));
306 write_data (session, x_authority_get_address (session->priv->x_authority), length);
307 write_string (session, x_authority_get_number (session->priv->x_authority));
308 length = x_authority_get_authorization_data_length (session->priv->x_authority);
309 write_data (session, &length, sizeof (length));
310 write_data (session, x_authority_get_authorization_data (session->priv->x_authority), length);
314 read_from_child (Session *session, void *buf, size_t count)
317 n_read = read (session->priv->from_child_output, buf, count);
319 g_warning ("Error reading from session: %s", strerror (errno));
324 read_string_from_child (Session *session)
329 if (read_from_child (session, &length, sizeof (length)) <= 0)
333 if (length > MAX_STRING_LENGTH)
335 g_warning ("Invalid string length %d from child", length);
339 value = g_malloc (sizeof (char) * (length + 1));
340 read_from_child (session, value, length);
341 value[length] = '\0';
347 session_watch_cb (GPid pid, gint status, gpointer data)
349 Session *session = data;
351 session->priv->pid = 0;
353 if (WIFEXITED (status))
354 g_debug ("Session %d exited with return value %d", pid, WEXITSTATUS (status));
355 else if (WIFSIGNALED (status))
356 g_debug ("Session %d terminated with signal %d", pid, WTERMSIG (status));
358 /* If failed during authentication then report this as an authentication failure */
359 if (session->priv->authentication_started && !session->priv->authentication_complete)
361 g_debug ("Session %d failed during authentication", pid);
362 session->priv->authentication_complete = TRUE;
363 session->priv->authentication_result = PAM_CONV_ERR;
364 g_free (session->priv->authentication_result_string);
365 session->priv->authentication_result_string = g_strdup ("Authentication stopped before completion");
366 g_signal_emit (G_OBJECT (session), signals[AUTHENTICATION_COMPLETE], 0);
369 g_signal_emit (G_OBJECT (session), signals[STOPPED], 0);
371 /* Delete account if it is a guest one */
372 if (session->priv->is_guest)
373 guest_account_cleanup (session->priv->username);
375 /* Drop our reference on the child process, it has terminated */
376 g_object_unref (session);
380 from_child_cb (GIOChannel *source, GIOCondition condition, gpointer data)
382 Session *session = data;
385 gboolean auth_complete;
387 /* Remote end gone */
388 if (condition == G_IO_HUP)
390 session->priv->from_child_watch = 0;
394 /* Get the username currently being authenticated (may change during authentication) */
395 username = read_string_from_child (session);
396 if (g_strcmp0 (username, session->priv->username) != 0)
398 g_free (session->priv->username);
399 session->priv->username = username;
400 if (session->priv->user)
401 g_object_unref (session->priv->user);
402 session->priv->user = NULL;
407 /* Check if authentication completed */
408 n_read = read_from_child (session, &auth_complete, sizeof (auth_complete));
410 g_debug ("Error reading from child: %s", strerror (errno));
413 session->priv->from_child_watch = 0;
419 session->priv->authentication_complete = TRUE;
420 read_from_child (session, &session->priv->authentication_result, sizeof (session->priv->authentication_result));
421 g_free (session->priv->authentication_result_string);
422 session->priv->authentication_result_string = read_string_from_child (session);
424 g_debug ("Session %d authentication complete with return value %d: %s", session->priv->pid, session->priv->authentication_result, session->priv->authentication_result_string);
426 /* No longer expect any more messages */
427 session->priv->from_child_watch = 0;
429 g_signal_emit (G_OBJECT (session), signals[AUTHENTICATION_COMPLETE], 0);
437 session->priv->messages_length = 0;
438 read_from_child (session, &session->priv->messages_length, sizeof (session->priv->messages_length));
439 session->priv->messages = calloc (session->priv->messages_length, sizeof (struct pam_message));
440 for (i = 0; i < session->priv->messages_length; i++)
442 struct pam_message *m = &session->priv->messages[i];
443 read_from_child (session, &m->msg_style, sizeof (m->msg_style));
444 m->msg = read_string_from_child (session);
447 g_debug ("Session %d got %d message(s) from PAM", session->priv->pid, session->priv->messages_length);
449 g_signal_emit (G_OBJECT (session), signals[GOT_MESSAGES], 0);
456 session_start (Session *session)
458 g_return_val_if_fail (session != NULL, FALSE);
459 g_return_val_if_fail (session->priv->display_server != NULL, FALSE);
460 return SESSION_GET_CLASS (session)->start (session);
464 session_get_is_started (Session *session)
466 return session->priv->pid != 0;
470 session_real_start (Session *session)
473 int to_child_pipe[2], from_child_pipe[2];
474 int to_child_output, from_child_input;
476 g_return_val_if_fail (session->priv->pid == 0, FALSE);
478 display_server_setup_session (session->priv->display_server, session);
480 /* Create pipes to talk to the child */
481 if (pipe (to_child_pipe) < 0 || pipe (from_child_pipe) < 0)
483 g_warning ("Failed to create pipe to communicate with session process: %s", strerror (errno));
486 to_child_output = to_child_pipe[0];
487 session->priv->to_child_input = to_child_pipe[1];
488 session->priv->from_child_output = from_child_pipe[0];
489 from_child_input = from_child_pipe[1];
490 session->priv->from_child_channel = g_io_channel_unix_new (session->priv->from_child_output);
491 session->priv->from_child_watch = g_io_add_watch (session->priv->from_child_channel, G_IO_IN | G_IO_HUP, from_child_cb, session);
493 /* Don't allow the daemon end of the pipes to be accessed in child processes */
494 fcntl (session->priv->to_child_input, F_SETFD, FD_CLOEXEC);
495 fcntl (session->priv->from_child_output, F_SETFD, FD_CLOEXEC);
497 /* Create the guest account if it is one */
498 if (session->priv->is_guest && session->priv->username == NULL)
500 session->priv->username = guest_account_setup ();
501 if (!session->priv->username)
506 session->priv->pid = fork ();
507 if (session->priv->pid < 0)
509 g_debug ("Failed to fork session child process: %s", strerror (errno));
513 if (session->priv->pid == 0)
515 /* Run us again in session child mode */
519 g_strdup_printf ("%d", to_child_output),
520 g_strdup_printf ("%d", from_child_input),
522 _exit (EXIT_FAILURE);
525 /* Hold a reference on this object until the child process terminates so we
526 * can handle the watch callback even if it is no longer used. Otherwise a
527 * zombie process will remain */
528 g_object_ref (session);
530 /* Listen for session termination */
531 session->priv->authentication_started = TRUE;
532 session->priv->child_watch = g_child_watch_add (session->priv->pid, session_watch_cb, session);
534 /* Close the ends of the pipes we don't need */
535 close (to_child_output);
536 close (from_child_input);
538 /* Indicate what version of the protocol we are using */
540 write_data (session, &version, sizeof (version));
542 /* Send configuration */
543 write_string (session, session->priv->pam_service);
544 write_string (session, session->priv->username);
545 write_data (session, &session->priv->do_authenticate, sizeof (session->priv->do_authenticate));
546 write_data (session, &session->priv->is_interactive, sizeof (session->priv->is_interactive));
547 write_string (session, session->priv->class);
548 write_string (session, session->priv->tty);
549 write_string (session, session->priv->remote_host_name);
550 write_string (session, session->priv->xdisplay);
551 write_xauth (session, session->priv->x_authority);
553 g_debug ("Started session %d with service '%s', username '%s'", session->priv->pid, session->priv->pam_service, session->priv->username);
559 session_get_username (Session *session)
561 g_return_val_if_fail (session != NULL, NULL);
562 return session->priv->username;
566 session_get_console_kit_cookie (Session *session)
568 g_return_val_if_fail (session != NULL, NULL);
569 return session->priv->console_kit_cookie;
573 session_respond (Session *session, struct pam_response *response)
575 int error = PAM_SUCCESS;
578 g_return_if_fail (session != NULL);
580 write_data (session, &error, sizeof (error));
581 for (i = 0; i < session->priv->messages_length; i++)
583 write_string (session, response[i].resp);
584 write_data (session, &response[i].resp_retcode, sizeof (response[i].resp_retcode));
587 /* Delete the old messages */
588 for (i = 0; i < session->priv->messages_length; i++)
589 g_free ((char *) session->priv->messages[i].msg);
590 g_free (session->priv->messages);
591 session->priv->messages = NULL;
592 session->priv->messages_length = 0;
596 session_respond_error (Session *session, int error)
598 g_return_if_fail (session != NULL);
599 g_return_if_fail (error != PAM_SUCCESS);
601 write_data (session, &error, sizeof (error));
605 session_get_messages_length (Session *session)
607 g_return_val_if_fail (session != NULL, 0);
608 return session->priv->messages_length;
611 const struct pam_message *
612 session_get_messages (Session *session)
614 g_return_val_if_fail (session != NULL, NULL);
615 return session->priv->messages;
619 session_get_is_authenticated (Session *session)
621 g_return_val_if_fail (session != NULL, FALSE);
622 return session->priv->authentication_complete && session->priv->authentication_result == PAM_SUCCESS;
626 session_get_authentication_result (Session *session)
628 g_return_val_if_fail (session != NULL, 0);
629 return session->priv->authentication_result;
633 session_get_authentication_result_string (Session *session)
635 g_return_val_if_fail (session != NULL, NULL);
636 return session->priv->authentication_result_string;
640 session_run (Session *session)
642 g_return_if_fail (session->priv->display_server != NULL);
643 return SESSION_GET_CLASS (session)->run (session);
647 session_real_run (Session *session)
650 gchar *command, *x_authority_filename;
653 g_return_if_fail (session != NULL);
654 g_return_if_fail (!session->priv->command_run);
655 g_return_if_fail (session_get_is_authenticated (session));
656 g_return_if_fail (session->priv->argv != NULL);
657 g_return_if_fail (session->priv->pid != 0);
659 display_server_setup_session (session->priv->display_server, session);
661 session->priv->command_run = TRUE;
663 command = g_strjoinv (" ", session->priv->argv);
664 g_debug ("Session %d running command %s", session->priv->pid, command);
667 /* Create authority location */
668 if (session->priv->x_authority_use_system_location)
670 gchar *run_dir, *dir;
672 run_dir = config_get_string (config_get_instance (), "LightDM", "run-directory");
673 dir = g_build_filename (run_dir, session->priv->username, NULL);
676 if (g_mkdir_with_parents (dir, S_IRWXU) < 0)
677 g_warning ("Failed to set create system authority dir %s: %s", dir, strerror (errno));
680 if (chown (dir, user_get_uid (session_get_user (session)), user_get_gid (session_get_user (session))) < 0)
681 g_warning ("Failed to set ownership of user authority dir: %s", strerror (errno));
684 x_authority_filename = g_build_filename (dir, "xauthority", NULL);
688 x_authority_filename = g_build_filename (user_get_home_directory (session_get_user (session)), ".Xauthority", NULL);
690 write_string (session, session->priv->log_filename);
691 write_string (session, session->priv->tty);
692 write_string (session, x_authority_filename);
693 g_free (x_authority_filename);
694 write_string (session, session->priv->xdisplay);
695 write_xauth (session, session->priv->x_authority);
696 argc = g_list_length (session->priv->env);
697 write_data (session, &argc, sizeof (argc));
698 for (link = session->priv->env; link; link = link->next)
699 write_string (session, (gchar *) link->data);
700 argc = g_strv_length (session->priv->argv);
701 write_data (session, &argc, sizeof (argc));
702 for (i = 0; i < argc; i++)
703 write_string (session, session->priv->argv[i]);
705 if (login1_is_running ())
706 session->priv->login1_session = read_string_from_child (session);
707 if (!session->priv->login1_session)
708 session->priv->console_kit_cookie = read_string_from_child (session);
712 session_lock (Session *session)
714 g_return_if_fail (session != NULL);
717 if (login1_is_running ())
718 login1_lock_session (session->priv->login1_session);
719 if (!session->priv->login1_session)
720 ck_lock_session (session->priv->console_kit_cookie);
725 session_unlock (Session *session)
727 g_return_if_fail (session != NULL);
730 if (login1_is_running ())
731 login1_unlock_session (session->priv->login1_session);
732 if (!session->priv->login1_session)
733 ck_unlock_session (session->priv->console_kit_cookie);
738 session_stop (Session *session)
740 g_return_if_fail (session != NULL);
742 if (session->priv->stopping)
744 session->priv->stopping = TRUE;
746 return SESSION_GET_CLASS (session)->stop (session);
750 session_real_stop (Session *session)
752 g_return_if_fail (session != NULL);
754 if (session->priv->pid > 0)
756 g_debug ("Session %d: Sending SIGTERM", session->priv->pid);
757 kill (session->priv->pid, SIGTERM);
758 // FIXME: Handle timeout
761 g_signal_emit (G_OBJECT (session), signals[STOPPED], 0);
765 session_get_is_stopping (Session *session)
767 g_return_val_if_fail (session != NULL, FALSE);
768 return session->priv->stopping;
772 session_init (Session *session)
774 session->priv = G_TYPE_INSTANCE_GET_PRIVATE (session, SESSION_TYPE, SessionPrivate);
775 session->priv->log_filename = g_strdup (".xsession-errors");
779 session_finalize (GObject *object)
781 Session *self = SESSION (object);
784 if (self->priv->display_server)
785 g_object_unref (self->priv->display_server);
787 kill (self->priv->pid, SIGKILL);
788 if (self->priv->from_child_channel)
789 g_io_channel_unref (self->priv->from_child_channel);
790 if (self->priv->from_child_watch)
791 g_source_remove (self->priv->from_child_watch);
792 if (self->priv->child_watch)
793 g_source_remove (self->priv->child_watch);
794 g_free (self->priv->username);
795 if (self->priv->user)
796 g_object_unref (self->priv->user);
797 g_free (self->priv->pam_service);
798 for (i = 0; i < self->priv->messages_length; i++)
799 g_free ((char *) self->priv->messages[i].msg);
800 g_free (self->priv->messages);
801 g_free (self->priv->authentication_result_string);
802 g_free (self->priv->log_filename);
803 g_free (self->priv->class);
804 g_free (self->priv->tty);
805 g_free (self->priv->xdisplay);
806 if (self->priv->x_authority)
807 g_object_unref (self->priv->x_authority);
808 g_free (self->priv->remote_host_name);
809 g_free (self->priv->login1_session);
810 g_free (self->priv->console_kit_cookie);
811 g_list_free_full (self->priv->env, g_free);
812 g_strfreev (self->priv->argv);
814 G_OBJECT_CLASS (session_parent_class)->finalize (object);
818 session_class_init (SessionClass *klass)
820 GObjectClass *object_class = G_OBJECT_CLASS (klass);
822 klass->start = session_real_start;
823 klass->run = session_real_run;
824 klass->stop = session_real_stop;
825 object_class->finalize = session_finalize;
827 g_type_class_add_private (klass, sizeof (SessionPrivate));
829 signals[GOT_MESSAGES] =
830 g_signal_new ("got-messages",
831 G_TYPE_FROM_CLASS (klass),
833 G_STRUCT_OFFSET (SessionClass, got_messages),
838 signals[AUTHENTICATION_COMPLETE] =
839 g_signal_new ("authentication-complete",
840 G_TYPE_FROM_CLASS (klass),
842 G_STRUCT_OFFSET (SessionClass, authentication_complete),
848 g_signal_new ("stopped",
849 G_TYPE_FROM_CLASS (klass),
851 G_STRUCT_OFFSET (SessionClass, stopped),