GApplication: More documentation tweaks
[glib.git] / gio / gdbusauth.c
blobeb8ebfd3bf8687fc66869c06563d8d802bd16f2a
1 /* GDBus - GLib D-Bus Library
3 * Copyright (C) 2008-2010 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: David Zeuthen <davidz@redhat.com>
23 #include "config.h"
25 #include "gdbusauth.h"
27 #include "gdbusauthmechanismanon.h"
28 #include "gdbusauthmechanismexternal.h"
29 #include "gdbusauthmechanismsha1.h"
30 #include "gdbusauthobserver.h"
32 #include "gdbuserror.h"
33 #include "gdbusutils.h"
34 #include "gioenumtypes.h"
35 #include "gcredentials.h"
36 #include "gdbusprivate.h"
37 #include "giostream.h"
38 #include "gdatainputstream.h"
39 #include "gdataoutputstream.h"
41 #ifdef G_OS_UNIX
42 #include <sys/types.h>
43 #include <sys/socket.h>
44 #include "gunixconnection.h"
45 #include "gunixcredentialsmessage.h"
46 #endif
48 #include "glibintl.h"
50 static void
51 debug_print (const gchar *message, ...)
53 if (G_UNLIKELY (_g_dbus_debug_authentication ()))
55 gchar *s;
56 GString *str;
57 va_list var_args;
58 guint n;
60 _g_dbus_debug_print_lock ();
62 va_start (var_args, message);
63 s = g_strdup_vprintf (message, var_args);
64 va_end (var_args);
66 str = g_string_new (NULL);
67 for (n = 0; s[n] != '\0'; n++)
69 if (G_UNLIKELY (s[n] == '\r'))
70 g_string_append (str, "\\r");
71 else if (G_UNLIKELY (s[n] == '\n'))
72 g_string_append (str, "\\n");
73 else
74 g_string_append_c (str, s[n]);
76 g_print ("GDBus-debug:Auth: %s\n", str->str);
77 g_string_free (str, TRUE);
78 g_free (s);
80 _g_dbus_debug_print_unlock ();
84 typedef struct
86 const gchar *name;
87 gint priority;
88 GType gtype;
89 } Mechanism;
91 static void mechanism_free (Mechanism *m);
93 struct _GDBusAuthPrivate
95 GIOStream *stream;
97 /* A list of available Mechanism, sorted according to priority */
98 GList *available_mechanisms;
101 enum
103 PROP_0,
104 PROP_STREAM
107 G_DEFINE_TYPE (GDBusAuth, _g_dbus_auth, G_TYPE_OBJECT);
109 /* ---------------------------------------------------------------------------------------------------- */
111 static void
112 _g_dbus_auth_finalize (GObject *object)
114 GDBusAuth *auth = G_DBUS_AUTH (object);
116 if (auth->priv->stream != NULL)
117 g_object_unref (auth->priv->stream);
118 g_list_foreach (auth->priv->available_mechanisms, (GFunc) mechanism_free, NULL);
119 g_list_free (auth->priv->available_mechanisms);
121 if (G_OBJECT_CLASS (_g_dbus_auth_parent_class)->finalize != NULL)
122 G_OBJECT_CLASS (_g_dbus_auth_parent_class)->finalize (object);
125 static void
126 _g_dbus_auth_get_property (GObject *object,
127 guint prop_id,
128 GValue *value,
129 GParamSpec *pspec)
131 GDBusAuth *auth = G_DBUS_AUTH (object);
133 switch (prop_id)
135 case PROP_STREAM:
136 g_value_set_object (value, auth->priv->stream);
137 break;
139 default:
140 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
141 break;
145 static void
146 _g_dbus_auth_set_property (GObject *object,
147 guint prop_id,
148 const GValue *value,
149 GParamSpec *pspec)
151 GDBusAuth *auth = G_DBUS_AUTH (object);
153 switch (prop_id)
155 case PROP_STREAM:
156 auth->priv->stream = g_value_dup_object (value);
157 break;
159 default:
160 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
161 break;
165 static void
166 _g_dbus_auth_class_init (GDBusAuthClass *klass)
168 GObjectClass *gobject_class;
170 g_type_class_add_private (klass, sizeof (GDBusAuthPrivate));
172 gobject_class = G_OBJECT_CLASS (klass);
173 gobject_class->get_property = _g_dbus_auth_get_property;
174 gobject_class->set_property = _g_dbus_auth_set_property;
175 gobject_class->finalize = _g_dbus_auth_finalize;
177 g_object_class_install_property (gobject_class,
178 PROP_STREAM,
179 g_param_spec_object ("stream",
180 P_("IO Stream"),
181 P_("The underlying GIOStream used for I/O"),
182 G_TYPE_IO_STREAM,
183 G_PARAM_READABLE |
184 G_PARAM_WRITABLE |
185 G_PARAM_CONSTRUCT_ONLY |
186 G_PARAM_STATIC_NAME |
187 G_PARAM_STATIC_BLURB |
188 G_PARAM_STATIC_NICK));
191 static void
192 mechanism_free (Mechanism *m)
194 g_free (m);
197 static void
198 add_mechanism (GDBusAuth *auth,
199 GType mechanism_type)
201 Mechanism *m;
203 m = g_new0 (Mechanism, 1);
204 m->name = _g_dbus_auth_mechanism_get_name (mechanism_type);
205 m->priority = _g_dbus_auth_mechanism_get_priority (mechanism_type);
206 m->gtype = mechanism_type;
208 auth->priv->available_mechanisms = g_list_prepend (auth->priv->available_mechanisms, m);
211 static gint
212 mech_compare_func (Mechanism *a, Mechanism *b)
214 gint ret;
215 /* ensure deterministic order */
216 ret = b->priority - a->priority;
217 if (ret == 0)
218 ret = g_strcmp0 (b->name, a->name);
219 return ret;
222 static void
223 _g_dbus_auth_init (GDBusAuth *auth)
225 auth->priv = G_TYPE_INSTANCE_GET_PRIVATE (auth, G_TYPE_DBUS_AUTH, GDBusAuthPrivate);
227 /* TODO: trawl extension points */
228 add_mechanism (auth, G_TYPE_DBUS_AUTH_MECHANISM_ANON);
229 add_mechanism (auth, G_TYPE_DBUS_AUTH_MECHANISM_SHA1);
230 add_mechanism (auth, G_TYPE_DBUS_AUTH_MECHANISM_EXTERNAL);
232 auth->priv->available_mechanisms = g_list_sort (auth->priv->available_mechanisms,
233 (GCompareFunc) mech_compare_func);
236 static GType
237 find_mech_by_name (GDBusAuth *auth,
238 const gchar *name)
240 GType ret;
241 GList *l;
243 ret = (GType) 0;
245 for (l = auth->priv->available_mechanisms; l != NULL; l = l->next)
247 Mechanism *m = l->data;
248 if (g_strcmp0 (name, m->name) == 0)
250 ret = m->gtype;
251 goto out;
255 out:
256 return ret;
259 GDBusAuth *
260 _g_dbus_auth_new (GIOStream *stream)
262 return g_object_new (G_TYPE_DBUS_AUTH,
263 "stream", stream,
264 NULL);
267 /* ---------------------------------------------------------------------------------------------------- */
268 /* like g_data_input_stream_read_line() but sets error if there's no content to read */
269 static gchar *
270 _my_g_data_input_stream_read_line (GDataInputStream *dis,
271 gsize *out_line_length,
272 GCancellable *cancellable,
273 GError **error)
275 gchar *ret;
277 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
279 ret = g_data_input_stream_read_line (dis,
280 out_line_length,
281 cancellable,
282 error);
283 if (ret == NULL && error != NULL && *error == NULL)
285 g_set_error_literal (error,
286 G_IO_ERROR,
287 G_IO_ERROR_FAILED,
288 _("Unexpected lack of content trying to read a line"));
291 return ret;
294 /* This function is to avoid situations like this
296 * BEGIN\r\nl\0\0\1...
298 * e.g. where we read into the first D-Bus message while waiting for
299 * the final line from the client (TODO: file bug against gio for
300 * this)
302 static gchar *
303 _my_g_input_stream_read_line_safe (GInputStream *i,
304 gsize *out_line_length,
305 GCancellable *cancellable,
306 GError **error)
308 GString *str;
309 gchar c;
310 gssize num_read;
311 gboolean last_was_cr;
313 str = g_string_new (NULL);
315 last_was_cr = FALSE;
316 while (TRUE)
318 num_read = g_input_stream_read (i,
321 cancellable,
322 error);
323 if (num_read == -1)
324 goto fail;
325 if (num_read == 0)
327 if (error != NULL && *error == NULL)
329 g_set_error_literal (error,
330 G_IO_ERROR,
331 G_IO_ERROR_FAILED,
332 _("Unexpected lack of content trying to (safely) read a line"));
334 goto fail;
337 g_string_append_c (str, (gint) c);
338 if (last_was_cr)
340 if (c == 0x0a)
342 g_assert (str->len >= 2);
343 g_string_set_size (str, str->len - 2);
344 goto out;
347 last_was_cr = (c == 0x0d);
350 out:
351 if (out_line_length != NULL)
352 *out_line_length = str->len;
353 return g_string_free (str, FALSE);
355 fail:
356 g_assert (error == NULL || *error != NULL);
357 g_string_free (str, TRUE);
358 return NULL;
361 /* ---------------------------------------------------------------------------------------------------- */
363 static void
364 append_nibble (GString *s, gint val)
366 g_string_append_c (s, val >= 10 ? ('a' + val - 10) : ('0' + val));
369 static gchar *
370 hexdecode (const gchar *str,
371 gsize *out_len,
372 GError **error)
374 gchar *ret;
375 GString *s;
376 guint n;
378 ret = NULL;
379 s = g_string_new (NULL);
381 for (n = 0; str[n] != '\0'; n += 2)
383 gint upper_nibble;
384 gint lower_nibble;
385 guint value;
387 upper_nibble = g_ascii_xdigit_value (str[n]);
388 lower_nibble = g_ascii_xdigit_value (str[n + 1]);
389 if (upper_nibble == -1 || lower_nibble == -1)
391 g_set_error (error,
392 G_IO_ERROR,
393 G_IO_ERROR_FAILED,
394 "Error hexdecoding string `%s' around position %d",
395 str, n);
396 goto out;
398 value = (upper_nibble<<4) | lower_nibble;
399 g_string_append_c (s, value);
402 ret = g_string_free (s, FALSE);
403 s = NULL;
405 out:
406 if (s != NULL)
407 g_string_free (s, TRUE);
408 return ret;
411 /* TODO: take len */
412 static gchar *
413 hexencode (const gchar *str)
415 guint n;
416 GString *s;
418 s = g_string_new (NULL);
419 for (n = 0; str[n] != '\0'; n++)
421 gint val;
422 gint upper_nibble;
423 gint lower_nibble;
425 val = ((const guchar *) str)[n];
426 upper_nibble = val >> 4;
427 lower_nibble = val & 0x0f;
429 append_nibble (s, upper_nibble);
430 append_nibble (s, lower_nibble);
433 return g_string_free (s, FALSE);
436 /* ---------------------------------------------------------------------------------------------------- */
438 static GDBusAuthMechanism *
439 client_choose_mech_and_send_initial_response (GDBusAuth *auth,
440 GCredentials *credentials_that_were_sent,
441 const gchar* const *supported_auth_mechs,
442 GPtrArray *attempted_auth_mechs,
443 GDataOutputStream *dos,
444 GCancellable *cancellable,
445 GError **error)
447 GDBusAuthMechanism *mech;
448 GType auth_mech_to_use_gtype;
449 guint n;
450 guint m;
451 gchar *initial_response;
452 gsize initial_response_len;
453 gchar *encoded;
454 gchar *s;
456 again:
457 mech = NULL;
459 debug_print ("CLIENT: Trying to choose mechanism");
461 /* find an authentication mechanism to try, if any */
462 auth_mech_to_use_gtype = (GType) 0;
463 for (n = 0; supported_auth_mechs[n] != NULL; n++)
465 gboolean attempted_already;
466 attempted_already = FALSE;
467 for (m = 0; m < attempted_auth_mechs->len; m++)
469 if (g_strcmp0 (supported_auth_mechs[n], attempted_auth_mechs->pdata[m]) == 0)
471 attempted_already = TRUE;
472 break;
475 if (!attempted_already)
477 auth_mech_to_use_gtype = find_mech_by_name (auth, supported_auth_mechs[n]);
478 if (auth_mech_to_use_gtype != (GType) 0)
479 break;
483 if (auth_mech_to_use_gtype == (GType) 0)
485 guint n;
486 gchar *available;
487 GString *tried_str;
489 debug_print ("CLIENT: Exhausted all available mechanisms");
491 available = g_strjoinv (", ", (gchar **) supported_auth_mechs);
493 tried_str = g_string_new (NULL);
494 for (n = 0; n < attempted_auth_mechs->len; n++)
496 if (n > 0)
497 g_string_append (tried_str, ", ");
498 g_string_append (tried_str, attempted_auth_mechs->pdata[n]);
500 g_set_error (error,
501 G_IO_ERROR,
502 G_IO_ERROR_FAILED,
503 _("Exhausted all available authentication mechanisms (tried: %s) (available: %s)"),
504 tried_str->str,
505 available);
506 g_string_free (tried_str, TRUE);
507 g_free (available);
508 goto out;
511 /* OK, decided on a mechanism - let's do this thing */
512 mech = g_object_new (auth_mech_to_use_gtype,
513 "stream", auth->priv->stream,
514 "credentials", credentials_that_were_sent,
515 NULL);
516 debug_print ("CLIENT: Trying mechanism `%s'", _g_dbus_auth_mechanism_get_name (auth_mech_to_use_gtype));
517 g_ptr_array_add (attempted_auth_mechs, (gpointer) _g_dbus_auth_mechanism_get_name (auth_mech_to_use_gtype));
519 /* the auth mechanism may not be supported
520 * (for example, EXTERNAL only works if credentials were exchanged)
522 if (!_g_dbus_auth_mechanism_is_supported (mech))
524 debug_print ("CLIENT: Mechanism `%s' says it is not supported", _g_dbus_auth_mechanism_get_name (auth_mech_to_use_gtype));
525 g_object_unref (mech);
526 mech = NULL;
527 goto again;
530 initial_response_len = -1;
531 initial_response = _g_dbus_auth_mechanism_client_initiate (mech,
532 &initial_response_len);
533 #if 0
534 g_printerr ("using auth mechanism with name `%s' of type `%s' with initial response `%s'\n",
535 _g_dbus_auth_mechanism_get_name (auth_mech_to_use_gtype),
536 g_type_name (G_TYPE_FROM_INSTANCE (mech)),
537 initial_response);
538 #endif
539 if (initial_response != NULL)
541 //g_printerr ("initial_response = `%s'\n", initial_response);
542 encoded = hexencode (initial_response);
543 s = g_strdup_printf ("AUTH %s %s\r\n",
544 _g_dbus_auth_mechanism_get_name (auth_mech_to_use_gtype),
545 encoded);
546 g_free (initial_response);
547 g_free (encoded);
549 else
551 s = g_strdup_printf ("AUTH %s\r\n", _g_dbus_auth_mechanism_get_name (auth_mech_to_use_gtype));
553 debug_print ("CLIENT: writing `%s'", s);
554 if (!g_data_output_stream_put_string (dos, s, cancellable, error))
556 g_object_unref (mech);
557 mech = NULL;
558 g_free (s);
559 goto out;
561 g_free (s);
563 out:
564 return mech;
568 /* ---------------------------------------------------------------------------------------------------- */
570 typedef enum
572 CLIENT_STATE_WAITING_FOR_DATA,
573 CLIENT_STATE_WAITING_FOR_OK,
574 CLIENT_STATE_WAITING_FOR_REJECT,
575 CLIENT_STATE_WAITING_FOR_AGREE_UNIX_FD
576 } ClientState;
578 gchar *
579 _g_dbus_auth_run_client (GDBusAuth *auth,
580 GDBusCapabilityFlags offered_capabilities,
581 GDBusCapabilityFlags *out_negotiated_capabilities,
582 GCancellable *cancellable,
583 GError **error)
585 gchar *s;
586 GDataInputStream *dis;
587 GDataOutputStream *dos;
588 GCredentials *credentials;
589 gchar *ret_guid;
590 gchar *line;
591 gsize line_length;
592 gchar **supported_auth_mechs;
593 GPtrArray *attempted_auth_mechs;
594 GDBusAuthMechanism *mech;
595 ClientState state;
596 GDBusCapabilityFlags negotiated_capabilities;
598 debug_print ("CLIENT: initiating");
600 ret_guid = NULL;
601 supported_auth_mechs = NULL;
602 attempted_auth_mechs = g_ptr_array_new ();
603 mech = NULL;
604 negotiated_capabilities = 0;
605 credentials = NULL;
607 dis = G_DATA_INPUT_STREAM (g_data_input_stream_new (g_io_stream_get_input_stream (auth->priv->stream)));
608 dos = G_DATA_OUTPUT_STREAM (g_data_output_stream_new (g_io_stream_get_output_stream (auth->priv->stream)));
609 g_filter_input_stream_set_close_base_stream (G_FILTER_INPUT_STREAM (dis), FALSE);
610 g_filter_output_stream_set_close_base_stream (G_FILTER_OUTPUT_STREAM (dos), FALSE);
612 g_data_input_stream_set_newline_type (dis, G_DATA_STREAM_NEWLINE_TYPE_CR_LF);
614 #ifdef G_OS_UNIX
615 if (G_IS_UNIX_CONNECTION (auth->priv->stream) && g_unix_credentials_message_is_supported ())
617 credentials = g_credentials_new ();
618 if (!g_unix_connection_send_credentials (G_UNIX_CONNECTION (auth->priv->stream),
619 cancellable,
620 error))
621 goto out;
623 else
625 if (!g_data_output_stream_put_byte (dos, '\0', cancellable, error))
626 goto out;
628 #else
629 if (!g_data_output_stream_put_byte (dos, '\0', cancellable, error))
630 goto out;
631 #endif
633 if (credentials != NULL)
635 if (G_UNLIKELY (_g_dbus_debug_authentication ()))
637 s = g_credentials_to_string (credentials);
638 debug_print ("CLIENT: sent credentials `%s'", s);
639 g_free (s);
642 else
644 debug_print ("CLIENT: didn't send any credentials");
647 /* TODO: to reduce roundtrips, try to pick an auth mechanism to start with */
649 /* Get list of supported authentication mechanisms */
650 s = "AUTH\r\n";
651 debug_print ("CLIENT: writing `%s'", s);
652 if (!g_data_output_stream_put_string (dos, s, cancellable, error))
653 goto out;
654 state = CLIENT_STATE_WAITING_FOR_REJECT;
656 while (TRUE)
658 switch (state)
660 case CLIENT_STATE_WAITING_FOR_REJECT:
661 debug_print ("CLIENT: WaitingForReject");
662 line = _my_g_data_input_stream_read_line (dis, &line_length, cancellable, error);
663 if (line == NULL)
664 goto out;
665 debug_print ("CLIENT: WaitingForReject, read '%s'", line);
666 foobar:
667 if (!g_str_has_prefix (line, "REJECTED "))
669 g_set_error (error,
670 G_IO_ERROR,
671 G_IO_ERROR_FAILED,
672 "In WaitingForReject: Expected `REJECTED am1 am2 ... amN', got `%s'",
673 line);
674 g_free (line);
675 goto out;
677 if (supported_auth_mechs == NULL)
679 supported_auth_mechs = g_strsplit (line + sizeof ("REJECTED ") - 1, " ", 0);
680 #if 0
681 for (n = 0; supported_auth_mechs != NULL && supported_auth_mechs[n] != NULL; n++)
682 g_printerr ("supported_auth_mechs[%d] = `%s'\n", n, supported_auth_mechs[n]);
683 #endif
685 g_free (line);
686 mech = client_choose_mech_and_send_initial_response (auth,
687 credentials,
688 (const gchar* const *) supported_auth_mechs,
689 attempted_auth_mechs,
690 dos,
691 cancellable,
692 error);
693 if (mech == NULL)
694 goto out;
695 if (_g_dbus_auth_mechanism_client_get_state (mech) == G_DBUS_AUTH_MECHANISM_STATE_WAITING_FOR_DATA)
696 state = CLIENT_STATE_WAITING_FOR_DATA;
697 else
698 state = CLIENT_STATE_WAITING_FOR_OK;
699 break;
701 case CLIENT_STATE_WAITING_FOR_OK:
702 debug_print ("CLIENT: WaitingForOK");
703 line = _my_g_data_input_stream_read_line (dis, &line_length, cancellable, error);
704 if (line == NULL)
705 goto out;
706 debug_print ("CLIENT: WaitingForOK, read `%s'", line);
707 if (g_str_has_prefix (line, "OK "))
709 if (!g_dbus_is_guid (line + 3))
711 g_set_error (error,
712 G_IO_ERROR,
713 G_IO_ERROR_FAILED,
714 "Invalid OK response `%s'",
715 line);
716 g_free (line);
717 goto out;
719 ret_guid = g_strdup (line + 3);
720 g_free (line);
722 if (offered_capabilities & G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING)
724 s = "NEGOTIATE_UNIX_FD\r\n";
725 debug_print ("CLIENT: writing `%s'", s);
726 if (!g_data_output_stream_put_string (dos, s, cancellable, error))
727 goto out;
728 state = CLIENT_STATE_WAITING_FOR_AGREE_UNIX_FD;
730 else
732 s = "BEGIN\r\n";
733 debug_print ("CLIENT: writing `%s'", s);
734 if (!g_data_output_stream_put_string (dos, s, cancellable, error))
735 goto out;
736 /* and we're done! */
737 goto out;
740 else if (g_str_has_prefix (line, "REJECTED "))
742 goto foobar;
744 else
746 /* TODO: handle other valid responses */
747 g_set_error (error,
748 G_IO_ERROR,
749 G_IO_ERROR_FAILED,
750 "In WaitingForOk: unexpected response `%s'",
751 line);
752 g_free (line);
753 goto out;
755 break;
757 case CLIENT_STATE_WAITING_FOR_AGREE_UNIX_FD:
758 debug_print ("CLIENT: WaitingForAgreeUnixFD");
759 line = _my_g_data_input_stream_read_line (dis, &line_length, cancellable, error);
760 if (line == NULL)
761 goto out;
762 debug_print ("CLIENT: WaitingForAgreeUnixFD, read=`%s'", line);
763 if (g_strcmp0 (line, "AGREE_UNIX_FD") == 0)
765 g_free (line);
766 negotiated_capabilities |= G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING;
767 s = "BEGIN\r\n";
768 debug_print ("CLIENT: writing `%s'", s);
769 if (!g_data_output_stream_put_string (dos, s, cancellable, error))
770 goto out;
771 /* and we're done! */
772 goto out;
774 else if (g_str_has_prefix (line, "ERROR") && (line[5] == 0 || g_ascii_isspace (line[5])))
776 //g_strstrip (line + 5); g_debug ("bah, no unix_fd: `%s'", line + 5);
777 g_free (line);
778 s = "BEGIN\r\n";
779 debug_print ("CLIENT: writing `%s'", s);
780 if (!g_data_output_stream_put_string (dos, s, cancellable, error))
781 goto out;
782 /* and we're done! */
783 goto out;
785 else
787 /* TODO: handle other valid responses */
788 g_set_error (error,
789 G_IO_ERROR,
790 G_IO_ERROR_FAILED,
791 "In WaitingForAgreeUnixFd: unexpected response `%s'",
792 line);
793 g_free (line);
794 goto out;
796 break;
798 case CLIENT_STATE_WAITING_FOR_DATA:
799 debug_print ("CLIENT: WaitingForData");
800 line = _my_g_data_input_stream_read_line (dis, &line_length, cancellable, error);
801 if (line == NULL)
802 goto out;
803 debug_print ("CLIENT: WaitingForData, read=`%s'", line);
804 if (g_str_has_prefix (line, "DATA "))
806 gchar *encoded;
807 gchar *decoded_data;
808 gsize decoded_data_len = 0;
810 encoded = g_strdup (line + 5);
811 g_free (line);
812 g_strstrip (encoded);
813 decoded_data = hexdecode (encoded, &decoded_data_len, error);
814 g_free (encoded);
815 if (decoded_data == NULL)
817 g_prefix_error (error, "DATA response is malformed: ");
818 /* invalid encoding, disconnect! */
819 goto out;
821 _g_dbus_auth_mechanism_client_data_receive (mech, decoded_data, decoded_data_len);
822 g_free (decoded_data);
824 if (_g_dbus_auth_mechanism_client_get_state (mech) == G_DBUS_AUTH_MECHANISM_STATE_HAVE_DATA_TO_SEND)
826 gchar *data;
827 gsize data_len;
828 gchar *encoded_data;
829 data = _g_dbus_auth_mechanism_client_data_send (mech, &data_len);
830 encoded_data = hexencode (data);
831 s = g_strdup_printf ("DATA %s\r\n", encoded_data);
832 g_free (encoded_data);
833 g_free (data);
834 debug_print ("CLIENT: writing `%s'", s);
835 if (!g_data_output_stream_put_string (dos, s, cancellable, error))
837 g_free (s);
838 goto out;
840 g_free (s);
842 state = CLIENT_STATE_WAITING_FOR_OK;
844 else
846 g_set_error (error,
847 G_IO_ERROR,
848 G_IO_ERROR_FAILED,
849 "In WaitingForData: unexpected response `%s'",
850 line);
851 g_free (line);
852 goto out;
854 break;
856 default:
857 g_assert_not_reached ();
858 break;
861 }; /* main authentication client loop */
863 out:
864 if (mech != NULL)
865 g_object_unref (mech);
866 g_ptr_array_unref (attempted_auth_mechs);
867 g_strfreev (supported_auth_mechs);
868 g_object_unref (dis);
869 g_object_unref (dos);
871 /* ensure return value is NULL if error is set */
872 if (error != NULL && *error != NULL)
874 g_free (ret_guid);
875 ret_guid = NULL;
878 if (ret_guid != NULL)
880 if (out_negotiated_capabilities != NULL)
881 *out_negotiated_capabilities = negotiated_capabilities;
884 if (credentials != NULL)
885 g_object_unref (credentials);
887 debug_print ("CLIENT: Done, authenticated=%d", ret_guid != NULL);
889 return ret_guid;
892 /* ---------------------------------------------------------------------------------------------------- */
894 static gchar *
895 get_auth_mechanisms (GDBusAuth *auth,
896 gboolean allow_anonymous,
897 const gchar *prefix,
898 const gchar *suffix,
899 const gchar *separator)
901 GList *l;
902 GString *str;
903 gboolean need_sep;
905 str = g_string_new (prefix);
906 need_sep = FALSE;
907 for (l = auth->priv->available_mechanisms; l != NULL; l = l->next)
909 Mechanism *m = l->data;
911 if (!allow_anonymous && g_strcmp0 (m->name, "ANONYMOUS") == 0)
912 continue;
914 if (need_sep)
915 g_string_append (str, separator);
916 g_string_append (str, m->name);
917 need_sep = TRUE;
920 g_string_append (str, suffix);
921 return g_string_free (str, FALSE);
925 typedef enum
927 SERVER_STATE_WAITING_FOR_AUTH,
928 SERVER_STATE_WAITING_FOR_DATA,
929 SERVER_STATE_WAITING_FOR_BEGIN
930 } ServerState;
932 gboolean
933 _g_dbus_auth_run_server (GDBusAuth *auth,
934 GDBusAuthObserver *observer,
935 const gchar *guid,
936 gboolean allow_anonymous,
937 GDBusCapabilityFlags offered_capabilities,
938 GDBusCapabilityFlags *out_negotiated_capabilities,
939 GCredentials **out_received_credentials,
940 GCancellable *cancellable,
941 GError **error)
943 gboolean ret;
944 ServerState state;
945 GDataInputStream *dis;
946 GDataOutputStream *dos;
947 GError *local_error;
948 guchar byte;
949 gchar *line;
950 gsize line_length;
951 GDBusAuthMechanism *mech;
952 gchar *s;
953 GDBusCapabilityFlags negotiated_capabilities;
954 GCredentials *credentials;
956 debug_print ("SERVER: initiating");
958 ret = FALSE;
959 dis = NULL;
960 dos = NULL;
961 mech = NULL;
962 negotiated_capabilities = 0;
963 credentials = NULL;
965 if (!g_dbus_is_guid (guid))
967 g_set_error (error,
968 G_IO_ERROR,
969 G_IO_ERROR_FAILED,
970 "The given guid `%s' is not valid",
971 guid);
972 goto out;
975 dis = G_DATA_INPUT_STREAM (g_data_input_stream_new (g_io_stream_get_input_stream (auth->priv->stream)));
976 dos = G_DATA_OUTPUT_STREAM (g_data_output_stream_new (g_io_stream_get_output_stream (auth->priv->stream)));
977 g_filter_input_stream_set_close_base_stream (G_FILTER_INPUT_STREAM (dis), FALSE);
978 g_filter_output_stream_set_close_base_stream (G_FILTER_OUTPUT_STREAM (dos), FALSE);
980 g_data_input_stream_set_newline_type (dis, G_DATA_STREAM_NEWLINE_TYPE_CR_LF);
982 /* first read the NUL-byte (TODO: read credentials if using a unix domain socket) */
983 #ifdef G_OS_UNIX
984 if (G_IS_UNIX_CONNECTION (auth->priv->stream) && g_unix_credentials_message_is_supported ())
986 local_error = NULL;
987 credentials = g_unix_connection_receive_credentials (G_UNIX_CONNECTION (auth->priv->stream),
988 cancellable,
989 &local_error);
990 if (credentials == NULL)
992 g_propagate_error (error, local_error);
993 goto out;
996 else
998 local_error = NULL;
999 byte = g_data_input_stream_read_byte (dis, cancellable, &local_error);
1000 if (local_error != NULL)
1002 g_propagate_error (error, local_error);
1003 goto out;
1006 #else
1007 local_error = NULL;
1008 byte = g_data_input_stream_read_byte (dis, cancellable, &local_error);
1009 if (local_error != NULL)
1011 g_propagate_error (error, local_error);
1012 goto out;
1014 #endif
1015 if (credentials != NULL)
1017 if (G_UNLIKELY (_g_dbus_debug_authentication ()))
1019 s = g_credentials_to_string (credentials);
1020 debug_print ("SERVER: received credentials `%s'", s);
1021 g_free (s);
1024 else
1026 debug_print ("SERVER: didn't receive any credentials");
1029 state = SERVER_STATE_WAITING_FOR_AUTH;
1030 while (TRUE)
1032 switch (state)
1034 case SERVER_STATE_WAITING_FOR_AUTH:
1035 debug_print ("SERVER: WaitingForAuth");
1036 line = _my_g_data_input_stream_read_line (dis, &line_length, cancellable, error);
1037 debug_print ("SERVER: WaitingForAuth, read `%s'", line);
1038 if (line == NULL)
1039 goto out;
1040 if (g_strcmp0 (line, "AUTH") == 0)
1042 s = get_auth_mechanisms (auth, allow_anonymous, "REJECTED ", "\r\n", " ");
1043 debug_print ("SERVER: writing `%s'", s);
1044 if (!g_data_output_stream_put_string (dos, s, cancellable, error))
1046 g_free (s);
1047 goto out;
1049 g_free (s);
1050 g_free (line);
1052 else if (g_str_has_prefix (line, "AUTH "))
1054 gchar **tokens;
1055 const gchar *encoded;
1056 const gchar *mech_name;
1057 GType auth_mech_to_use_gtype;
1059 tokens = g_strsplit (line, " ", 0);
1060 g_free (line);
1062 switch (g_strv_length (tokens))
1064 case 2:
1065 /* no initial response */
1066 mech_name = tokens[1];
1067 encoded = NULL;
1068 break;
1070 case 3:
1071 /* initial response */
1072 mech_name = tokens[1];
1073 encoded = tokens[2];
1074 break;
1076 default:
1077 g_set_error (error,
1078 G_IO_ERROR,
1079 G_IO_ERROR_FAILED,
1080 "Unexpected line `%s' while in WaitingForAuth state",
1081 line);
1082 g_strfreev (tokens);
1083 goto out;
1086 /* TODO: record that the client has attempted to use this mechanism */
1087 //g_debug ("client is trying `%s'", mech_name);
1089 auth_mech_to_use_gtype = find_mech_by_name (auth, mech_name);
1090 if ((auth_mech_to_use_gtype == (GType) 0) ||
1091 (!allow_anonymous && g_strcmp0 (mech_name, "ANONYMOUS") == 0))
1093 /* We don't support this auth mechanism */
1094 g_strfreev (tokens);
1095 s = get_auth_mechanisms (auth, allow_anonymous, "REJECTED ", "\r\n", " ");
1096 debug_print ("SERVER: writing `%s'", s);
1097 if (!g_data_output_stream_put_string (dos, s, cancellable, error))
1099 g_free (s);
1100 goto out;
1102 g_free (s);
1104 /* stay in WAITING FOR AUTH */
1105 state = SERVER_STATE_WAITING_FOR_AUTH;
1107 else
1109 gchar *initial_response;
1110 gsize initial_response_len;
1112 mech = g_object_new (auth_mech_to_use_gtype,
1113 "stream", auth->priv->stream,
1114 "credentials", credentials,
1115 NULL);
1117 initial_response = NULL;
1118 initial_response_len = 0;
1119 if (encoded != NULL)
1121 initial_response = hexdecode (encoded, &initial_response_len, error);
1122 if (initial_response == NULL)
1124 g_prefix_error (error, "Initial response is malformed: ");
1125 /* invalid encoding, disconnect! */
1126 g_strfreev (tokens);
1127 goto out;
1131 _g_dbus_auth_mechanism_server_initiate (mech,
1132 initial_response,
1133 initial_response_len);
1134 g_free (initial_response);
1135 g_strfreev (tokens);
1137 change_state:
1138 switch (_g_dbus_auth_mechanism_server_get_state (mech))
1140 case G_DBUS_AUTH_MECHANISM_STATE_ACCEPTED:
1141 if (observer != NULL &&
1142 !g_dbus_auth_observer_authorize_authenticated_peer (observer,
1143 auth->priv->stream,
1144 credentials))
1146 /* disconnect */
1147 g_set_error_literal (error,
1148 G_IO_ERROR,
1149 G_IO_ERROR_FAILED,
1150 _("Cancelled via GDBusAuthObserver::authorize-authenticated-peer"));
1151 goto out;
1153 else
1155 s = g_strdup_printf ("OK %s\r\n", guid);
1156 debug_print ("SERVER: writing `%s'", s);
1157 if (!g_data_output_stream_put_string (dos, s, cancellable, error))
1159 g_free (s);
1160 goto out;
1162 g_free (s);
1163 state = SERVER_STATE_WAITING_FOR_BEGIN;
1165 break;
1167 case G_DBUS_AUTH_MECHANISM_STATE_REJECTED:
1168 s = get_auth_mechanisms (auth, allow_anonymous, "REJECTED ", "\r\n", " ");
1169 debug_print ("SERVER: writing `%s'", s);
1170 if (!g_data_output_stream_put_string (dos, s, cancellable, error))
1172 g_free (s);
1173 goto out;
1175 g_free (s);
1176 state = SERVER_STATE_WAITING_FOR_AUTH;
1177 break;
1179 case G_DBUS_AUTH_MECHANISM_STATE_WAITING_FOR_DATA:
1180 state = SERVER_STATE_WAITING_FOR_DATA;
1181 break;
1183 case G_DBUS_AUTH_MECHANISM_STATE_HAVE_DATA_TO_SEND:
1185 gchar *data;
1186 gsize data_len;
1187 gchar *encoded_data;
1188 data = _g_dbus_auth_mechanism_server_data_send (mech, &data_len);
1189 encoded_data = hexencode (data);
1190 s = g_strdup_printf ("DATA %s\r\n", encoded_data);
1191 g_free (encoded_data);
1192 g_free (data);
1193 debug_print ("SERVER: writing `%s'", s);
1194 if (!g_data_output_stream_put_string (dos, s, cancellable, error))
1196 g_free (s);
1197 goto out;
1199 g_free (s);
1201 goto change_state;
1202 break;
1204 default:
1205 /* TODO */
1206 g_assert_not_reached ();
1207 break;
1211 else
1213 g_set_error (error,
1214 G_IO_ERROR,
1215 G_IO_ERROR_FAILED,
1216 "Unexpected line `%s' while in WaitingForAuth state",
1217 line);
1218 g_free (line);
1219 goto out;
1221 break;
1223 case SERVER_STATE_WAITING_FOR_DATA:
1224 debug_print ("SERVER: WaitingForData");
1225 line = _my_g_data_input_stream_read_line (dis, &line_length, cancellable, error);
1226 debug_print ("SERVER: WaitingForData, read `%s'", line);
1227 if (line == NULL)
1228 goto out;
1229 if (g_str_has_prefix (line, "DATA "))
1231 gchar *encoded;
1232 gchar *decoded_data;
1233 gsize decoded_data_len = 0;
1235 encoded = g_strdup (line + 5);
1236 g_free (line);
1237 g_strstrip (encoded);
1238 decoded_data = hexdecode (encoded, &decoded_data_len, error);
1239 g_free (encoded);
1240 if (decoded_data == NULL)
1242 g_prefix_error (error, "DATA response is malformed: ");
1243 /* invalid encoding, disconnect! */
1244 goto out;
1246 _g_dbus_auth_mechanism_server_data_receive (mech, decoded_data, decoded_data_len);
1247 g_free (decoded_data);
1248 /* oh man, this goto-crap is so ugly.. really need to rewrite the state machine */
1249 goto change_state;
1251 else
1253 g_set_error (error,
1254 G_IO_ERROR,
1255 G_IO_ERROR_FAILED,
1256 "Unexpected line `%s' while in WaitingForData state",
1257 line);
1258 g_free (line);
1260 goto out;
1262 case SERVER_STATE_WAITING_FOR_BEGIN:
1263 debug_print ("SERVER: WaitingForBegin");
1264 /* Use extremely slow (but reliable) line reader - this basically
1265 * does a recvfrom() system call per character
1267 * (the problem with using GDataInputStream's read_line is that because of
1268 * buffering it might start reading into the first D-Bus message that
1269 * appears after "BEGIN\r\n"....)
1271 line = _my_g_input_stream_read_line_safe (g_io_stream_get_input_stream (auth->priv->stream),
1272 &line_length,
1273 cancellable,
1274 error);
1275 debug_print ("SERVER: WaitingForBegin, read `%s'", line);
1276 if (line == NULL)
1277 goto out;
1278 if (g_strcmp0 (line, "BEGIN") == 0)
1280 /* YAY, done! */
1281 ret = TRUE;
1282 g_free (line);
1283 goto out;
1285 else if (g_strcmp0 (line, "NEGOTIATE_UNIX_FD") == 0)
1287 g_free (line);
1288 if (offered_capabilities & G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING)
1290 negotiated_capabilities |= G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING;
1291 s = "AGREE_UNIX_FD\r\n";
1292 debug_print ("SERVER: writing `%s'", s);
1293 if (!g_data_output_stream_put_string (dos, s, cancellable, error))
1294 goto out;
1296 else
1298 s = "ERROR \"fd passing not offered\"\r\n";
1299 debug_print ("SERVER: writing `%s'", s);
1300 if (!g_data_output_stream_put_string (dos, s, cancellable, error))
1301 goto out;
1304 else
1306 g_debug ("Unexpected line `%s' while in WaitingForBegin state", line);
1307 g_free (line);
1308 s = "ERROR \"Unknown Command\"\r\n";
1309 debug_print ("SERVER: writing `%s'", s);
1310 if (!g_data_output_stream_put_string (dos, s, cancellable, error))
1311 goto out;
1313 break;
1315 default:
1316 g_assert_not_reached ();
1317 break;
1322 g_set_error_literal (error,
1323 G_IO_ERROR,
1324 G_IO_ERROR_FAILED,
1325 "Not implemented (server)");
1327 out:
1328 if (mech != NULL)
1329 g_object_unref (mech);
1330 if (dis != NULL)
1331 g_object_unref (dis);
1332 if (dos != NULL)
1333 g_object_unref (dos);
1335 /* ensure return value is FALSE if error is set */
1336 if (error != NULL && *error != NULL)
1338 ret = FALSE;
1341 if (ret)
1343 if (out_negotiated_capabilities != NULL)
1344 *out_negotiated_capabilities = negotiated_capabilities;
1345 if (out_received_credentials != NULL)
1346 *out_received_credentials = credentials != NULL ? g_object_ref (credentials) : NULL;
1349 if (credentials != NULL)
1350 g_object_unref (credentials);
1352 debug_print ("SERVER: Done, authenticated=%d", ret);
1354 return ret;
1357 /* ---------------------------------------------------------------------------------------------------- */