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;
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 static void session_logger_iface_init (LoggerInterface *iface);
122 G_DEFINE_TYPE_WITH_CODE (Session, session, G_TYPE_OBJECT,
123 G_IMPLEMENT_INTERFACE (
124 LOGGER_TYPE, session_logger_iface_init));
129 return g_object_new (SESSION_TYPE, NULL);
133 session_set_session_type (Session *session, const gchar *session_type)
135 g_return_if_fail (session != NULL);
136 g_free (session->priv->session_type);
137 session->priv->session_type = g_strdup (session_type);
141 session_get_session_type (Session *session)
143 g_return_val_if_fail (session != NULL, NULL);
144 return session->priv->session_type;
148 session_set_pam_service (Session *session, const gchar *pam_service)
150 g_return_if_fail (session != NULL);
151 g_free (session->priv->pam_service);
152 session->priv->pam_service = g_strdup (pam_service);
156 session_set_username (Session *session, const gchar *username)
158 g_return_if_fail (session != NULL);
159 g_free (session->priv->username);
160 session->priv->username = g_strdup (username);
164 session_set_do_authenticate (Session *session, gboolean do_authenticate)
166 g_return_if_fail (session != NULL);
167 session->priv->do_authenticate = do_authenticate;
171 session_set_is_interactive (Session *session, gboolean is_interactive)
173 g_return_if_fail (session != NULL);
174 session->priv->is_interactive = is_interactive;
178 session_set_is_guest (Session *session, gboolean is_guest)
180 g_return_if_fail (session != NULL);
181 session->priv->is_guest = is_guest;
185 session_get_is_guest (Session *session)
187 g_return_val_if_fail (session != NULL, FALSE);
188 return session->priv->is_guest;
192 session_set_log_file (Session *session, const gchar *filename)
194 g_return_if_fail (session != NULL);
195 g_free (session->priv->log_filename);
196 session->priv->log_filename = g_strdup (filename);
200 session_set_display_server (Session *session, DisplayServer *display_server)
202 g_return_if_fail (session != NULL);
203 g_return_if_fail (display_server != NULL);
204 if (session->priv->display_server)
206 display_server_disconnect_session (session->priv->display_server, session);
207 g_object_unref (session->priv->display_server);
209 session->priv->display_server = g_object_ref (display_server);
213 session_get_display_server (Session *session)
215 g_return_val_if_fail (session != NULL, NULL);
216 return session->priv->display_server;
220 session_set_tty (Session *session, const gchar *tty)
222 g_return_if_fail (session != NULL);
223 g_free (session->priv->tty);
224 session->priv->tty = g_strdup (tty);
228 session_set_xdisplay (Session *session, const gchar *xdisplay)
230 g_return_if_fail (session != NULL);
231 g_free (session->priv->xdisplay);
232 session->priv->xdisplay = g_strdup (xdisplay);
236 session_set_x_authority (Session *session, XAuthority *authority, gboolean use_system_location)
238 g_return_if_fail (session != NULL);
239 if (session->priv->x_authority)
241 g_object_unref (session->priv->x_authority);
242 session->priv->x_authority = NULL;
245 session->priv->x_authority = g_object_ref (authority);
246 session->priv->x_authority_use_system_location = use_system_location;
250 session_set_remote_host_name (Session *session, const gchar *remote_host_name)
252 g_return_if_fail (session != NULL);
253 g_free (session->priv->remote_host_name);
254 session->priv->remote_host_name = g_strdup (remote_host_name);
258 find_env_entry (Session *session, const gchar *name)
262 for (link = session->priv->env; link; link = link->next)
264 const gchar *entry = link->data;
266 if (g_str_has_prefix (entry, name) && entry[strlen (name)] == '=')
274 session_set_env (Session *session, const gchar *name, const gchar *value)
279 g_return_if_fail (session != NULL);
280 g_return_if_fail (value != NULL);
282 entry = g_strdup_printf ("%s=%s", name, value);
284 link = find_env_entry (session, name);
291 session->priv->env = g_list_append (session->priv->env, entry);
295 session_unset_env (Session *session, const gchar *name)
299 g_return_if_fail (session != NULL);
301 link = find_env_entry (session, name);
306 session->priv->env = g_list_remove_link (session->priv->env, link);
310 session_set_argv (Session *session, gchar **argv)
312 g_return_if_fail (session != NULL);
313 session->priv->argv = g_strdupv (argv);
317 session_get_user (Session *session)
319 g_return_val_if_fail (session != NULL, NULL);
321 if (session->priv->username == NULL)
324 if (!session->priv->user)
325 session->priv->user = accounts_get_user_by_name (session->priv->username);
327 return session->priv->user;
331 write_data (Session *session, const void *buf, size_t count)
333 if (write (session->priv->to_child_input, buf, count) != count)
334 l_warning (session, "Error writing to session: %s", strerror (errno));
338 write_string (Session *session, const char *value)
342 length = value ? strlen (value) : -1;
343 write_data (session, &length, sizeof (length));
345 write_data (session, value, sizeof (char) * length);
349 write_xauth (Session *session, XAuthority *x_authority)
356 write_string (session, NULL);
360 write_string (session, x_authority_get_authorization_name (session->priv->x_authority));
361 family = x_authority_get_family (session->priv->x_authority);
362 write_data (session, &family, sizeof (family));
363 length = x_authority_get_address_length (session->priv->x_authority);
364 write_data (session, &length, sizeof (length));
365 write_data (session, x_authority_get_address (session->priv->x_authority), length);
366 write_string (session, x_authority_get_number (session->priv->x_authority));
367 length = x_authority_get_authorization_data_length (session->priv->x_authority);
368 write_data (session, &length, sizeof (length));
369 write_data (session, x_authority_get_authorization_data (session->priv->x_authority), length);
373 read_from_child (Session *session, void *buf, size_t count)
376 n_read = read (session->priv->from_child_output, buf, count);
378 l_warning (session, "Error reading from session: %s", strerror (errno));
383 read_string_from_child (Session *session)
388 if (read_from_child (session, &length, sizeof (length)) <= 0)
392 if (length > MAX_STRING_LENGTH)
394 l_warning (session, "Invalid string length %d from child", length);
398 value = g_malloc (sizeof (char) * (length + 1));
399 read_from_child (session, value, length);
400 value[length] = '\0';
406 session_watch_cb (GPid pid, gint status, gpointer data)
408 Session *session = data;
410 if (WIFEXITED (status))
411 l_debug (session, "Exited with return value %d", WEXITSTATUS (status));
412 else if (WIFSIGNALED (status))
413 l_debug (session, "Terminated with signal %d", WTERMSIG (status));
415 /* do this as late as possible for log messages prefix */
416 session->priv->pid = 0;
418 /* If failed during authentication then report this as an authentication failure */
419 if (session->priv->authentication_started && !session->priv->authentication_complete)
421 l_debug (session, "Failed during authentication");
422 session->priv->authentication_complete = TRUE;
423 session->priv->authentication_result = PAM_CONV_ERR;
424 g_free (session->priv->authentication_result_string);
425 session->priv->authentication_result_string = g_strdup ("Authentication stopped before completion");
426 g_signal_emit (G_OBJECT (session), signals[AUTHENTICATION_COMPLETE], 0);
429 g_signal_emit (G_OBJECT (session), signals[STOPPED], 0);
431 /* Delete account if it is a guest one */
432 if (session->priv->is_guest)
433 guest_account_cleanup (session->priv->username);
435 /* Drop our reference on the child process, it has terminated */
436 g_object_unref (session);
440 from_child_cb (GIOChannel *source, GIOCondition condition, gpointer data)
442 Session *session = data;
445 gboolean auth_complete;
447 /* Remote end gone */
448 if (condition == G_IO_HUP)
450 session->priv->from_child_watch = 0;
454 /* Get the username currently being authenticated (may change during authentication) */
455 username = read_string_from_child (session);
456 if (g_strcmp0 (username, session->priv->username) != 0)
458 g_free (session->priv->username);
459 session->priv->username = username;
460 if (session->priv->user)
461 g_object_unref (session->priv->user);
462 session->priv->user = NULL;
467 /* Check if authentication completed */
468 n_read = read_from_child (session, &auth_complete, sizeof (auth_complete));
470 l_debug (session, "Error reading from child: %s", strerror (errno));
473 session->priv->from_child_watch = 0;
479 session->priv->authentication_complete = TRUE;
480 read_from_child (session, &session->priv->authentication_result, sizeof (session->priv->authentication_result));
481 g_free (session->priv->authentication_result_string);
482 session->priv->authentication_result_string = read_string_from_child (session);
484 l_debug (session, "Authentication complete with return value %d: %s", session->priv->authentication_result, session->priv->authentication_result_string);
486 /* No longer expect any more messages */
487 session->priv->from_child_watch = 0;
489 g_signal_emit (G_OBJECT (session), signals[AUTHENTICATION_COMPLETE], 0);
497 session->priv->messages_length = 0;
498 read_from_child (session, &session->priv->messages_length, sizeof (session->priv->messages_length));
499 session->priv->messages = calloc (session->priv->messages_length, sizeof (struct pam_message));
500 for (i = 0; i < session->priv->messages_length; i++)
502 struct pam_message *m = &session->priv->messages[i];
503 read_from_child (session, &m->msg_style, sizeof (m->msg_style));
504 m->msg = read_string_from_child (session);
507 l_debug (session, "Got %d message(s) from PAM", session->priv->messages_length);
509 g_signal_emit (G_OBJECT (session), signals[GOT_MESSAGES], 0);
516 session_start (Session *session)
518 g_return_val_if_fail (session != NULL, FALSE);
519 return SESSION_GET_CLASS (session)->start (session);
523 session_get_is_started (Session *session)
525 return session->priv->pid != 0;
529 session_real_start (Session *session)
532 int to_child_pipe[2], from_child_pipe[2];
533 int to_child_output, from_child_input;
535 g_return_val_if_fail (session->priv->pid == 0, FALSE);
537 if (session->priv->display_server)
538 display_server_connect_session (session->priv->display_server, session);
540 /* Create pipes to talk to the child */
541 if (pipe (to_child_pipe) < 0 || pipe (from_child_pipe) < 0)
543 g_warning ("Failed to create pipe to communicate with session process: %s", strerror (errno));
546 to_child_output = to_child_pipe[0];
547 session->priv->to_child_input = to_child_pipe[1];
548 session->priv->from_child_output = from_child_pipe[0];
549 from_child_input = from_child_pipe[1];
550 session->priv->from_child_channel = g_io_channel_unix_new (session->priv->from_child_output);
551 session->priv->from_child_watch = g_io_add_watch (session->priv->from_child_channel, G_IO_IN | G_IO_HUP, from_child_cb, session);
553 /* Don't allow the daemon end of the pipes to be accessed in child processes */
554 fcntl (session->priv->to_child_input, F_SETFD, FD_CLOEXEC);
555 fcntl (session->priv->from_child_output, F_SETFD, FD_CLOEXEC);
557 /* Create the guest account if it is one */
558 if (session->priv->is_guest && session->priv->username == NULL)
560 session->priv->username = guest_account_setup ();
561 if (!session->priv->username)
566 session->priv->pid = fork ();
567 if (session->priv->pid < 0)
569 g_debug ("Failed to fork session child process: %s", strerror (errno));
573 if (session->priv->pid == 0)
575 /* Run us again in session child mode */
579 g_strdup_printf ("%d", to_child_output),
580 g_strdup_printf ("%d", from_child_input),
582 _exit (EXIT_FAILURE);
585 /* Hold a reference on this object until the child process terminates so we
586 * can handle the watch callback even if it is no longer used. Otherwise a
587 * zombie process will remain */
588 g_object_ref (session);
590 /* Listen for session termination */
591 session->priv->authentication_started = TRUE;
592 session->priv->child_watch = g_child_watch_add (session->priv->pid, session_watch_cb, session);
594 /* Close the ends of the pipes we don't need */
595 close (to_child_output);
596 close (from_child_input);
598 /* Indicate what version of the protocol we are using */
600 write_data (session, &version, sizeof (version));
602 /* Send configuration */
603 write_string (session, session->priv->pam_service);
604 write_string (session, session->priv->username);
605 write_data (session, &session->priv->do_authenticate, sizeof (session->priv->do_authenticate));
606 write_data (session, &session->priv->is_interactive, sizeof (session->priv->is_interactive));
607 write_string (session, NULL); /* Used to be class, now we just use the environment variable */
608 write_string (session, session->priv->tty);
609 write_string (session, session->priv->remote_host_name);
610 write_string (session, session->priv->xdisplay);
611 write_xauth (session, session->priv->x_authority);
613 l_debug (session, "Started with service '%s', username '%s'", session->priv->pam_service, session->priv->username);
619 session_get_username (Session *session)
621 g_return_val_if_fail (session != NULL, NULL);
622 return session->priv->username;
626 session_get_console_kit_cookie (Session *session)
628 g_return_val_if_fail (session != NULL, NULL);
629 return session->priv->console_kit_cookie;
633 session_respond (Session *session, struct pam_response *response)
635 int error = PAM_SUCCESS;
638 g_return_if_fail (session != NULL);
640 write_data (session, &error, sizeof (error));
641 for (i = 0; i < session->priv->messages_length; i++)
643 write_string (session, response[i].resp);
644 write_data (session, &response[i].resp_retcode, sizeof (response[i].resp_retcode));
647 /* Delete the old messages */
648 for (i = 0; i < session->priv->messages_length; i++)
649 g_free ((char *) session->priv->messages[i].msg);
650 g_free (session->priv->messages);
651 session->priv->messages = NULL;
652 session->priv->messages_length = 0;
656 session_respond_error (Session *session, int error)
658 g_return_if_fail (session != NULL);
659 g_return_if_fail (error != PAM_SUCCESS);
661 write_data (session, &error, sizeof (error));
665 session_get_messages_length (Session *session)
667 g_return_val_if_fail (session != NULL, 0);
668 return session->priv->messages_length;
671 const struct pam_message *
672 session_get_messages (Session *session)
674 g_return_val_if_fail (session != NULL, NULL);
675 return session->priv->messages;
679 session_get_is_authenticated (Session *session)
681 g_return_val_if_fail (session != NULL, FALSE);
682 return session->priv->authentication_complete && session->priv->authentication_result == PAM_SUCCESS;
686 session_get_authentication_result (Session *session)
688 g_return_val_if_fail (session != NULL, 0);
689 return session->priv->authentication_result;
693 session_get_authentication_result_string (Session *session)
695 g_return_val_if_fail (session != NULL, NULL);
696 return session->priv->authentication_result_string;
700 session_run (Session *session)
702 g_return_if_fail (session->priv->display_server != NULL);
703 return SESSION_GET_CLASS (session)->run (session);
707 session_real_run (Session *session)
710 gchar *command, *x_authority_filename;
713 g_return_if_fail (session != NULL);
714 g_return_if_fail (!session->priv->command_run);
715 g_return_if_fail (session_get_is_authenticated (session));
716 g_return_if_fail (session->priv->argv != NULL);
717 g_return_if_fail (session->priv->pid != 0);
719 display_server_connect_session (session->priv->display_server, session);
721 session->priv->command_run = TRUE;
723 command = g_strjoinv (" ", session->priv->argv);
724 l_debug (session, "Running command %s", command);
727 /* Create authority location */
728 if (session->priv->x_authority_use_system_location)
730 gchar *run_dir, *dir;
732 run_dir = config_get_string (config_get_instance (), "LightDM", "run-directory");
733 dir = g_build_filename (run_dir, session->priv->username, NULL);
736 if (g_mkdir_with_parents (dir, S_IRWXU) < 0)
737 l_warning (session, "Failed to set create system authority dir %s: %s", dir, strerror (errno));
740 if (chown (dir, user_get_uid (session_get_user (session)), user_get_gid (session_get_user (session))) < 0)
741 l_warning (session, "Failed to set ownership of user authority dir: %s", strerror (errno));
744 x_authority_filename = g_build_filename (dir, "xauthority", NULL);
748 x_authority_filename = g_build_filename (user_get_home_directory (session_get_user (session)), ".Xauthority", NULL);
750 if (session->priv->log_filename)
751 l_debug (session, "Logging to %s", session->priv->log_filename);
752 write_string (session, session->priv->log_filename);
753 write_string (session, session->priv->tty);
754 write_string (session, x_authority_filename);
755 g_free (x_authority_filename);
756 write_string (session, session->priv->xdisplay);
757 write_xauth (session, session->priv->x_authority);
758 argc = g_list_length (session->priv->env);
759 write_data (session, &argc, sizeof (argc));
760 for (link = session->priv->env; link; link = link->next)
761 write_string (session, (gchar *) link->data);
762 argc = g_strv_length (session->priv->argv);
763 write_data (session, &argc, sizeof (argc));
764 for (i = 0; i < argc; i++)
765 write_string (session, session->priv->argv[i]);
767 if (login1_is_running ())
768 session->priv->login1_session = read_string_from_child (session);
769 if (!session->priv->login1_session)
770 session->priv->console_kit_cookie = read_string_from_child (session);
774 session_lock (Session *session)
776 g_return_if_fail (session != NULL);
779 if (session->priv->login1_session)
780 login1_lock_session (session->priv->login1_session);
781 else if (session->priv->console_kit_cookie)
782 ck_lock_session (session->priv->console_kit_cookie);
787 session_unlock (Session *session)
789 g_return_if_fail (session != NULL);
792 if (session->priv->login1_session)
793 login1_unlock_session (session->priv->login1_session);
794 else if (session->priv->console_kit_cookie)
795 ck_unlock_session (session->priv->console_kit_cookie);
800 session_stop (Session *session)
802 g_return_if_fail (session != NULL);
804 if (session->priv->stopping)
806 session->priv->stopping = TRUE;
808 return SESSION_GET_CLASS (session)->stop (session);
812 session_real_stop (Session *session)
814 g_return_if_fail (session != NULL);
816 if (session->priv->pid > 0)
818 l_debug (session, "Sending SIGTERM");
819 kill (session->priv->pid, SIGTERM);
820 // FIXME: Handle timeout
823 g_signal_emit (G_OBJECT (session), signals[STOPPED], 0);
827 session_get_is_stopping (Session *session)
829 g_return_val_if_fail (session != NULL, FALSE);
830 return session->priv->stopping;
834 session_init (Session *session)
836 session->priv = G_TYPE_INSTANCE_GET_PRIVATE (session, SESSION_TYPE, SessionPrivate);
837 session->priv->log_filename = g_strdup (".xsession-errors");
841 session_finalize (GObject *object)
843 Session *self = SESSION (object);
846 g_free (self->priv->session_type);
847 if (self->priv->display_server)
848 g_object_unref (self->priv->display_server);
850 kill (self->priv->pid, SIGKILL);
851 if (self->priv->from_child_channel)
852 g_io_channel_unref (self->priv->from_child_channel);
853 if (self->priv->from_child_watch)
854 g_source_remove (self->priv->from_child_watch);
855 if (self->priv->child_watch)
856 g_source_remove (self->priv->child_watch);
857 g_free (self->priv->username);
858 if (self->priv->user)
859 g_object_unref (self->priv->user);
860 g_free (self->priv->pam_service);
861 for (i = 0; i < self->priv->messages_length; i++)
862 g_free ((char *) self->priv->messages[i].msg);
863 g_free (self->priv->messages);
864 g_free (self->priv->authentication_result_string);
865 g_free (self->priv->log_filename);
866 g_free (self->priv->tty);
867 g_free (self->priv->xdisplay);
868 if (self->priv->x_authority)
869 g_object_unref (self->priv->x_authority);
870 g_free (self->priv->remote_host_name);
871 g_free (self->priv->login1_session);
872 g_free (self->priv->console_kit_cookie);
873 g_list_free_full (self->priv->env, g_free);
874 g_strfreev (self->priv->argv);
876 G_OBJECT_CLASS (session_parent_class)->finalize (object);
880 session_class_init (SessionClass *klass)
882 GObjectClass *object_class = G_OBJECT_CLASS (klass);
884 klass->start = session_real_start;
885 klass->run = session_real_run;
886 klass->stop = session_real_stop;
887 object_class->finalize = session_finalize;
889 g_type_class_add_private (klass, sizeof (SessionPrivate));
891 signals[GOT_MESSAGES] =
892 g_signal_new ("got-messages",
893 G_TYPE_FROM_CLASS (klass),
895 G_STRUCT_OFFSET (SessionClass, got_messages),
900 signals[AUTHENTICATION_COMPLETE] =
901 g_signal_new ("authentication-complete",
902 G_TYPE_FROM_CLASS (klass),
904 G_STRUCT_OFFSET (SessionClass, authentication_complete),
910 g_signal_new ("stopped",
911 G_TYPE_FROM_CLASS (klass),
913 G_STRUCT_OFFSET (SessionClass, stopped),
920 session_real_logprefix (Logger *self, gchar *buf, gulong buflen)
922 Session *session = SESSION (self);
923 if (session->priv->pid != 0)
924 return g_snprintf (buf, buflen, "Session pid=%d: ", session->priv->pid);
926 return g_snprintf (buf, buflen, "Session: ");
930 session_logger_iface_init (LoggerInterface *iface)
932 iface->logprefix = &session_real_logprefix;