1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-transport.c DBusTransport object (internal to D-Bus implementation)
4 * Copyright (C) 2002, 2003 Red Hat Inc.
6 * Licensed under the Academic Free License version 2.1
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 #include "dbus-transport-protected.h"
26 #include "dbus-transport-unix.h"
27 #include "dbus-transport-socket.h"
28 #include "dbus-connection-internal.h"
29 #include "dbus-watch.h"
30 #include "dbus-auth.h"
31 #include "dbus-address.h"
32 #include "dbus-credentials.h"
33 #include "dbus-mainloop.h"
34 #include "dbus-message.h"
35 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
36 #include "dbus-server-debug-pipe.h"
40 * @defgroup DBusTransport DBusTransport object
41 * @ingroup DBusInternals
42 * @brief "Backend" for a DBusConnection.
44 * Types and functions related to DBusTransport. A transport is an
45 * abstraction that can send and receive data via various kinds of
46 * network connections or other IPC mechanisms.
52 * @typedef DBusTransport
54 * Opaque object representing a way message stream.
55 * DBusTransport abstracts various kinds of actual
56 * transport mechanism, such as different network protocols,
57 * or encryption schemes.
61 live_messages_notify (DBusCounter *counter,
64 DBusTransport *transport = user_data;
66 _dbus_transport_ref (transport);
69 _dbus_verbose ("Size counter value is now %d\n",
70 (int) _dbus_counter_get_size_value (counter));
71 _dbus_verbose ("Unix FD counter value is now %d\n",
72 (int) _dbus_counter_get_unix_fd_value (counter));
75 /* disable or re-enable the read watch for the transport if
78 if (transport->vtable->live_messages_changed)
80 _dbus_connection_lock (transport->connection);
81 (* transport->vtable->live_messages_changed) (transport);
82 _dbus_connection_unlock (transport->connection);
85 _dbus_transport_unref (transport);
89 * Initializes the base class members of DBusTransport. Chained up to
90 * by subclasses in their constructor. The server GUID is the
91 * globally unique ID for the server creating this connection
92 * and will be #NULL for the client side of a connection. The GUID
95 * @param transport the transport being created.
96 * @param vtable the subclass vtable.
97 * @param server_guid non-#NULL if this transport is on the server side of a connection
98 * @param address the address of the transport
99 * @returns #TRUE on success.
102 _dbus_transport_init_base (DBusTransport *transport,
103 const DBusTransportVTable *vtable,
104 const DBusString *server_guid,
105 const DBusString *address)
107 DBusMessageLoader *loader;
109 DBusCounter *counter;
111 DBusCredentials *creds;
113 loader = _dbus_message_loader_new ();
118 auth = _dbus_auth_server_new (server_guid);
120 auth = _dbus_auth_client_new ();
123 _dbus_message_loader_unref (loader);
127 counter = _dbus_counter_new ();
130 _dbus_auth_unref (auth);
131 _dbus_message_loader_unref (loader);
135 creds = _dbus_credentials_new ();
138 _dbus_counter_unref (counter);
139 _dbus_auth_unref (auth);
140 _dbus_message_loader_unref (loader);
146 _dbus_assert (address == NULL);
151 _dbus_assert (address != NULL);
153 if (!_dbus_string_copy_data (address, &address_copy))
155 _dbus_credentials_unref (creds);
156 _dbus_counter_unref (counter);
157 _dbus_auth_unref (auth);
158 _dbus_message_loader_unref (loader);
163 transport->refcount = 1;
164 transport->vtable = vtable;
165 transport->loader = loader;
166 transport->auth = auth;
167 transport->live_messages = counter;
168 transport->authenticated = FALSE;
169 transport->disconnected = FALSE;
170 transport->is_server = (server_guid != NULL);
171 transport->send_credentials_pending = !transport->is_server;
172 transport->receive_credentials_pending = transport->is_server;
173 transport->address = address_copy;
175 transport->unix_user_function = NULL;
176 transport->unix_user_data = NULL;
177 transport->free_unix_user_data = NULL;
179 transport->windows_user_function = NULL;
180 transport->windows_user_data = NULL;
181 transport->free_windows_user_data = NULL;
183 transport->expected_guid = NULL;
185 /* Try to default to something that won't totally hose the system,
186 * but doesn't impose too much of a limitation.
188 transport->max_live_messages_size = _DBUS_ONE_MEGABYTE * 63;
190 /* On Linux RLIMIT_NOFILE defaults to 1024, so allowing 4096 fds live
191 should be more than enough */
192 transport->max_live_messages_unix_fds = 4096;
194 /* credentials read from socket if any */
195 transport->credentials = creds;
197 _dbus_counter_set_notify (transport->live_messages,
198 transport->max_live_messages_size,
199 transport->max_live_messages_unix_fds,
200 live_messages_notify,
203 if (transport->address)
204 _dbus_verbose ("Initialized transport on address %s\n", transport->address);
210 * Finalizes base class members of DBusTransport.
211 * Chained up to from subclass finalizers.
213 * @param transport the transport.
216 _dbus_transport_finalize_base (DBusTransport *transport)
218 if (!transport->disconnected)
219 _dbus_transport_disconnect (transport);
221 if (transport->free_unix_user_data != NULL)
222 (* transport->free_unix_user_data) (transport->unix_user_data);
224 if (transport->free_windows_user_data != NULL)
225 (* transport->free_windows_user_data) (transport->windows_user_data);
227 _dbus_message_loader_unref (transport->loader);
228 _dbus_auth_unref (transport->auth);
229 _dbus_counter_set_notify (transport->live_messages,
231 _dbus_counter_unref (transport->live_messages);
232 dbus_free (transport->address);
233 dbus_free (transport->expected_guid);
234 if (transport->credentials)
235 _dbus_credentials_unref (transport->credentials);
240 * Verifies if a given D-Bus address is a valid address
241 * by attempting to connect to it. If it is, returns the
242 * opened DBusTransport object. If it isn't, returns #NULL
245 * @param address the address to be checked.
246 * @param error address where an error can be returned.
247 * @returns a new transport, or #NULL on failure.
249 static DBusTransport*
250 check_address (const char *address, DBusError *error)
252 DBusAddressEntry **entries;
253 DBusTransport *transport = NULL;
256 _dbus_assert (address != NULL);
258 if (!dbus_parse_address (address, &entries, &len, error))
259 return NULL; /* not a valid address */
261 for (i = 0; i < len; i++)
263 transport = _dbus_transport_open (entries[i], error);
264 if (transport != NULL)
268 dbus_address_entries_free (entries);
273 * Creates a new transport for the "autostart" method.
274 * This creates a client-side of a transport.
276 * @param scope scope of autolaunch (Windows only)
277 * @param error address where an error can be returned.
278 * @returns a new transport, or #NULL on failure.
280 static DBusTransport*
281 _dbus_transport_new_for_autolaunch (const char *scope, DBusError *error)
284 DBusTransport *result = NULL;
286 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
288 if (!_dbus_string_init (&address))
290 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
294 if (!_dbus_get_autolaunch_address (scope, &address, error))
296 _DBUS_ASSERT_ERROR_IS_SET (error);
300 result = check_address (_dbus_string_get_const_data (&address), error);
302 _DBUS_ASSERT_ERROR_IS_SET (error);
304 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
307 _dbus_string_free (&address);
311 static DBusTransportOpenResult
312 _dbus_transport_open_autolaunch (DBusAddressEntry *entry,
313 DBusTransport **transport_p,
318 method = dbus_address_entry_get_method (entry);
319 _dbus_assert (method != NULL);
321 if (strcmp (method, "autolaunch") == 0)
323 const char *scope = dbus_address_entry_get_value (entry, "scope");
325 *transport_p = _dbus_transport_new_for_autolaunch (scope, error);
327 if (*transport_p == NULL)
329 _DBUS_ASSERT_ERROR_IS_SET (error);
330 return DBUS_TRANSPORT_OPEN_DID_NOT_CONNECT;
334 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
335 return DBUS_TRANSPORT_OPEN_OK;
340 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
341 return DBUS_TRANSPORT_OPEN_NOT_HANDLED;
345 static const struct {
346 DBusTransportOpenResult (* func) (DBusAddressEntry *entry,
347 DBusTransport **transport_p,
350 { _dbus_transport_open_socket },
351 { _dbus_transport_open_platform_specific },
352 { _dbus_transport_open_autolaunch }
353 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
354 , { _dbus_transport_open_debug_pipe }
359 * Try to open a new transport for the given address entry. (This
360 * opens a client-side-of-the-connection transport.)
362 * @param entry the address entry
363 * @param error location to store reason for failure.
364 * @returns new transport of #NULL on failure.
367 _dbus_transport_open (DBusAddressEntry *entry,
370 DBusTransport *transport;
371 const char *expected_guid_orig;
374 DBusError tmp_error = DBUS_ERROR_INIT;
376 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
379 expected_guid_orig = dbus_address_entry_get_value (entry, "guid");
380 expected_guid = _dbus_strdup (expected_guid_orig);
382 if (expected_guid_orig != NULL && expected_guid == NULL)
384 _DBUS_SET_OOM (error);
388 for (i = 0; i < (int) _DBUS_N_ELEMENTS (open_funcs); ++i)
390 DBusTransportOpenResult result;
392 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
393 result = (* open_funcs[i].func) (entry, &transport, &tmp_error);
397 case DBUS_TRANSPORT_OPEN_OK:
398 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
401 case DBUS_TRANSPORT_OPEN_NOT_HANDLED:
402 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
403 /* keep going through the loop of open funcs */
405 case DBUS_TRANSPORT_OPEN_BAD_ADDRESS:
406 _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
409 case DBUS_TRANSPORT_OPEN_DID_NOT_CONNECT:
410 _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
418 if (transport == NULL)
420 if (!dbus_error_is_set (&tmp_error))
421 _dbus_set_bad_address (&tmp_error,
423 "Unknown address type (examples of valid types are \"tcp\" and on UNIX \"unix\")");
425 _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
426 dbus_move_error(&tmp_error, error);
427 dbus_free (expected_guid);
431 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
433 /* In the case of autostart the initial guid is NULL
434 * and the autostart transport recursively calls
435 * _dbus_open_transport wich returns a transport
436 * with a guid. That guid is the definitive one.
438 * FIXME: if more transports are added they may have
439 * an effect on the expected_guid semantics (i.e.
440 * expected_guid and transport->expected_guid may
441 * both have values). This is very unlikely though
442 * we should either throw asserts here for those
443 * corner cases or refactor the code so it is
444 * clearer on what is expected and what is not
447 transport->expected_guid = expected_guid;
454 * Increments the reference count for the transport.
456 * @param transport the transport.
457 * @returns the transport.
460 _dbus_transport_ref (DBusTransport *transport)
462 _dbus_assert (transport->refcount > 0);
464 transport->refcount += 1;
470 * Decrements the reference count for the transport.
471 * Disconnects and finalizes the transport if
472 * the reference count reaches zero.
474 * @param transport the transport.
477 _dbus_transport_unref (DBusTransport *transport)
479 _dbus_assert (transport != NULL);
480 _dbus_assert (transport->refcount > 0);
482 transport->refcount -= 1;
483 if (transport->refcount == 0)
485 _dbus_verbose ("finalizing\n");
487 _dbus_assert (transport->vtable->finalize != NULL);
489 (* transport->vtable->finalize) (transport);
494 * Closes our end of the connection to a remote application. Further
495 * attempts to use this transport will fail. Only the first call to
496 * _dbus_transport_disconnect() will have an effect.
498 * @param transport the transport.
502 _dbus_transport_disconnect (DBusTransport *transport)
504 _dbus_verbose ("start\n");
506 _dbus_assert (transport->vtable->disconnect != NULL);
508 if (transport->disconnected)
511 (* transport->vtable->disconnect) (transport);
513 transport->disconnected = TRUE;
515 _dbus_verbose ("end\n");
519 * Returns #TRUE if the transport has not been disconnected.
520 * Disconnection can result from _dbus_transport_disconnect()
521 * or because the server drops its end of the connection.
523 * @param transport the transport.
524 * @returns whether we're connected
527 _dbus_transport_get_is_connected (DBusTransport *transport)
529 return !transport->disconnected;
533 auth_via_unix_user_function (DBusTransport *transport)
535 DBusCredentials *auth_identity;
537 DBusConnection *connection;
538 DBusAllowUnixUserFunction unix_user_function;
539 void *unix_user_data;
542 /* Dropping the lock here probably isn't that safe. */
544 auth_identity = _dbus_auth_get_identity (transport->auth);
545 _dbus_assert (auth_identity != NULL);
547 connection = transport->connection;
548 unix_user_function = transport->unix_user_function;
549 unix_user_data = transport->unix_user_data;
550 uid = _dbus_credentials_get_unix_uid (auth_identity);
552 _dbus_verbose ("unlock\n");
553 _dbus_connection_unlock (connection);
555 allow = (* unix_user_function) (connection,
559 _dbus_verbose ("lock post unix user function\n");
560 _dbus_connection_lock (connection);
564 _dbus_verbose ("Client UID "DBUS_UID_FORMAT" authorized\n", uid);
568 _dbus_verbose ("Client UID "DBUS_UID_FORMAT
569 " was rejected, disconnecting\n",
570 _dbus_credentials_get_unix_uid (auth_identity));
571 _dbus_transport_disconnect (transport);
578 auth_via_windows_user_function (DBusTransport *transport)
580 DBusCredentials *auth_identity;
582 DBusConnection *connection;
583 DBusAllowWindowsUserFunction windows_user_function;
584 void *windows_user_data;
587 /* Dropping the lock here probably isn't that safe. */
589 auth_identity = _dbus_auth_get_identity (transport->auth);
590 _dbus_assert (auth_identity != NULL);
592 connection = transport->connection;
593 windows_user_function = transport->windows_user_function;
594 windows_user_data = transport->unix_user_data;
595 windows_sid = _dbus_strdup (_dbus_credentials_get_windows_sid (auth_identity));
597 if (windows_sid == NULL)
603 _dbus_verbose ("unlock\n");
604 _dbus_connection_unlock (connection);
606 allow = (* windows_user_function) (connection,
610 _dbus_verbose ("lock post windows user function\n");
611 _dbus_connection_lock (connection);
615 _dbus_verbose ("Client SID '%s' authorized\n", windows_sid);
619 _dbus_verbose ("Client SID '%s' was rejected, disconnecting\n",
620 _dbus_credentials_get_windows_sid (auth_identity));
621 _dbus_transport_disconnect (transport);
628 auth_via_default_rules (DBusTransport *transport)
630 DBusCredentials *auth_identity;
631 DBusCredentials *our_identity;
634 auth_identity = _dbus_auth_get_identity (transport->auth);
635 _dbus_assert (auth_identity != NULL);
637 /* By default, connection is allowed if the client is 1) root or 2)
638 * has the same UID as us or 3) anonymous is allowed.
641 our_identity = _dbus_credentials_new_from_current_process ();
642 if (our_identity == NULL)
648 if (transport->allow_anonymous ||
649 _dbus_credentials_get_unix_uid (auth_identity) == 0 ||
650 _dbus_credentials_same_user (our_identity,
653 if (_dbus_credentials_include(our_identity,DBUS_CREDENTIAL_WINDOWS_SID))
654 _dbus_verbose ("Client authorized as SID '%s'"
655 "matching our SID '%s'\n",
656 _dbus_credentials_get_windows_sid(auth_identity),
657 _dbus_credentials_get_windows_sid(our_identity));
659 _dbus_verbose ("Client authorized as UID "DBUS_UID_FORMAT
660 " matching our UID "DBUS_UID_FORMAT"\n",
661 _dbus_credentials_get_unix_uid(auth_identity),
662 _dbus_credentials_get_unix_uid(our_identity));
663 /* We have authenticated! */
668 if (_dbus_credentials_include(our_identity,DBUS_CREDENTIAL_WINDOWS_SID))
669 _dbus_verbose ("Client authorized as SID '%s'"
670 " but our SID is '%s', disconnecting\n",
671 (_dbus_credentials_get_windows_sid(auth_identity) ?
672 _dbus_credentials_get_windows_sid(auth_identity) : "<null>"),
673 (_dbus_credentials_get_windows_sid(our_identity) ?
674 _dbus_credentials_get_windows_sid(our_identity) : "<null>"));
676 _dbus_verbose ("Client authorized as UID "DBUS_UID_FORMAT
677 " but our UID is "DBUS_UID_FORMAT", disconnecting\n",
678 _dbus_credentials_get_unix_uid(auth_identity),
679 _dbus_credentials_get_unix_uid(our_identity));
680 _dbus_transport_disconnect (transport);
684 _dbus_credentials_unref (our_identity);
690 * Returns #TRUE if we have been authenticated. It will return #TRUE even if
691 * the transport is now disconnected, but was ever authenticated before
694 * This replaces the older _dbus_transport_get_is_authenticated() which
697 * @param transport the transport
698 * @returns whether we're authenticated
701 _dbus_transport_peek_is_authenticated (DBusTransport *transport)
703 return transport->authenticated;
707 * Returns #TRUE if we have been authenticated. It will return #TRUE even if
708 * the transport is now disconnected, but was ever authenticated before
711 * If we have not finished authenticating, but we have enough buffered input
712 * to finish the job, then this function will do so before it returns.
714 * This used to be called _dbus_transport_get_is_authenticated(), but that
715 * name seems inappropriate for a function with side-effects.
717 * @todo we drop connection->mutex when calling the unix_user_function,
718 * and windows_user_function, which may not be safe really.
720 * @param transport the transport
721 * @returns whether we're authenticated
724 _dbus_transport_try_to_authenticate (DBusTransport *transport)
726 if (transport->authenticated)
730 dbus_bool_t maybe_authenticated;
732 if (transport->disconnected)
735 /* paranoia ref since we call user callbacks sometimes */
736 _dbus_connection_ref_unlocked (transport->connection);
738 maybe_authenticated =
739 (!(transport->send_credentials_pending ||
740 transport->receive_credentials_pending));
742 if (maybe_authenticated)
744 switch (_dbus_auth_do_work (transport->auth))
746 case DBUS_AUTH_STATE_AUTHENTICATED:
747 /* leave as maybe_authenticated */
750 maybe_authenticated = FALSE;
754 /* If we're the client, verify the GUID
756 if (maybe_authenticated && !transport->is_server)
758 const char *server_guid;
760 server_guid = _dbus_auth_get_guid_from_server (transport->auth);
761 _dbus_assert (server_guid != NULL);
763 if (transport->expected_guid &&
764 strcmp (transport->expected_guid, server_guid) != 0)
766 _dbus_verbose ("Client expected GUID '%s' and we got '%s' from the server\n",
767 transport->expected_guid, server_guid);
768 _dbus_transport_disconnect (transport);
769 _dbus_connection_unref_unlocked (transport->connection);
774 /* If we're the server, see if we want to allow this identity to proceed.
776 if (maybe_authenticated && transport->is_server)
779 DBusCredentials *auth_identity;
781 auth_identity = _dbus_auth_get_identity (transport->auth);
782 _dbus_assert (auth_identity != NULL);
784 /* If we have an auth'd user and a user function, delegate
785 * deciding whether auth credentials are good enough to the
786 * app; otherwise, use our default decision process.
788 if (transport->unix_user_function != NULL &&
789 _dbus_credentials_include (auth_identity, DBUS_CREDENTIAL_UNIX_USER_ID))
791 allow = auth_via_unix_user_function (transport);
793 else if (transport->windows_user_function != NULL &&
794 _dbus_credentials_include (auth_identity, DBUS_CREDENTIAL_WINDOWS_SID))
796 allow = auth_via_windows_user_function (transport);
800 allow = auth_via_default_rules (transport);
804 maybe_authenticated = FALSE;
807 transport->authenticated = maybe_authenticated;
809 _dbus_connection_unref_unlocked (transport->connection);
810 return maybe_authenticated;
815 * See dbus_connection_get_is_anonymous().
817 * @param transport the transport
818 * @returns #TRUE if not authenticated or authenticated as anonymous
821 _dbus_transport_get_is_anonymous (DBusTransport *transport)
823 DBusCredentials *auth_identity;
825 if (!transport->authenticated)
828 auth_identity = _dbus_auth_get_identity (transport->auth);
830 if (_dbus_credentials_are_anonymous (auth_identity))
837 * Returns TRUE if the transport supports sending unix fds.
839 * @param transport the transport
840 * @returns #TRUE if TRUE it is possible to send unix fds across the transport.
843 _dbus_transport_can_pass_unix_fd(DBusTransport *transport)
845 return DBUS_TRANSPORT_CAN_SEND_UNIX_FD(transport);
849 * Gets the address of a transport. It will be
850 * #NULL for a server-side transport.
852 * @param transport the transport
853 * @returns transport's address
856 _dbus_transport_get_address (DBusTransport *transport)
858 return transport->address;
862 * Gets the id of the server we are connected to (see
863 * dbus_server_get_id()). Only works on client side.
865 * @param transport the transport
866 * @returns transport's server's id or #NULL if we are the server side
869 _dbus_transport_get_server_id (DBusTransport *transport)
871 if (transport->is_server)
873 else if (transport->authenticated)
874 return _dbus_auth_get_guid_from_server (transport->auth);
876 return transport->expected_guid;
880 * Handles a watch by reading data, writing data, or disconnecting
881 * the transport, as appropriate for the given condition.
883 * @param transport the transport.
884 * @param watch the watch.
885 * @param condition the current state of the watched file descriptor.
886 * @returns #FALSE if not enough memory to fully handle the watch
889 _dbus_transport_handle_watch (DBusTransport *transport,
891 unsigned int condition)
895 _dbus_assert (transport->vtable->handle_watch != NULL);
897 if (transport->disconnected)
900 if (dbus_watch_get_socket (watch) < 0)
902 _dbus_warn_check_failed ("Tried to handle an invalidated watch; this watch should have been removed\n");
906 _dbus_watch_sanitize_condition (watch, &condition);
908 _dbus_transport_ref (transport);
909 _dbus_watch_ref (watch);
910 retval = (* transport->vtable->handle_watch) (transport, watch, condition);
911 _dbus_watch_unref (watch);
912 _dbus_transport_unref (transport);
918 * Sets the connection using this transport. Allows the transport
919 * to add watches to the connection, queue incoming messages,
920 * and pull outgoing messages.
922 * @param transport the transport.
923 * @param connection the connection.
924 * @returns #FALSE if not enough memory
927 _dbus_transport_set_connection (DBusTransport *transport,
928 DBusConnection *connection)
930 _dbus_assert (transport->vtable->connection_set != NULL);
931 _dbus_assert (transport->connection == NULL);
933 transport->connection = connection;
935 _dbus_transport_ref (transport);
936 if (!(* transport->vtable->connection_set) (transport))
937 transport->connection = NULL;
938 _dbus_transport_unref (transport);
940 return transport->connection != NULL;
944 * Get the socket file descriptor, if any.
946 * @param transport the transport
947 * @param fd_p pointer to fill in with the descriptor
948 * @returns #TRUE if a descriptor was available
951 _dbus_transport_get_socket_fd (DBusTransport *transport,
956 if (transport->vtable->get_socket_fd == NULL)
959 if (transport->disconnected)
962 _dbus_transport_ref (transport);
964 retval = (* transport->vtable->get_socket_fd) (transport,
967 _dbus_transport_unref (transport);
973 * Performs a single poll()/select() on the transport's file
974 * descriptors and then reads/writes data as appropriate,
975 * queueing incoming messages and sending outgoing messages.
976 * This is the backend for _dbus_connection_do_iteration().
977 * See _dbus_connection_do_iteration() for full details.
979 * @param transport the transport.
980 * @param flags indicates whether to read or write, and whether to block.
981 * @param timeout_milliseconds if blocking, timeout or -1 for no timeout.
984 _dbus_transport_do_iteration (DBusTransport *transport,
986 int timeout_milliseconds)
988 _dbus_assert (transport->vtable->do_iteration != NULL);
990 _dbus_verbose ("Transport iteration flags 0x%x timeout %d connected = %d\n",
991 flags, timeout_milliseconds, !transport->disconnected);
993 if ((flags & (DBUS_ITERATION_DO_WRITING |
994 DBUS_ITERATION_DO_READING)) == 0)
995 return; /* Nothing to do */
997 if (transport->disconnected)
1000 _dbus_transport_ref (transport);
1001 (* transport->vtable->do_iteration) (transport, flags,
1002 timeout_milliseconds);
1003 _dbus_transport_unref (transport);
1005 _dbus_verbose ("end\n");
1009 recover_unused_bytes (DBusTransport *transport)
1011 if (_dbus_auth_needs_decoding (transport->auth))
1013 DBusString plaintext;
1014 const DBusString *encoded;
1018 if (!_dbus_string_init (&plaintext))
1021 _dbus_auth_get_unused_bytes (transport->auth,
1024 if (!_dbus_auth_decode_data (transport->auth,
1025 encoded, &plaintext))
1027 _dbus_string_free (&plaintext);
1031 _dbus_message_loader_get_buffer (transport->loader,
1034 orig_len = _dbus_string_get_length (buffer);
1036 if (!_dbus_string_move (&plaintext, 0, buffer,
1039 _dbus_string_free (&plaintext);
1043 _dbus_verbose (" %d unused bytes sent to message loader\n",
1044 _dbus_string_get_length (buffer) -
1047 _dbus_message_loader_return_buffer (transport->loader,
1049 _dbus_string_get_length (buffer) -
1052 _dbus_auth_delete_unused_bytes (transport->auth);
1054 _dbus_string_free (&plaintext);
1058 const DBusString *bytes;
1061 dbus_bool_t succeeded;
1063 _dbus_message_loader_get_buffer (transport->loader,
1066 orig_len = _dbus_string_get_length (buffer);
1068 _dbus_auth_get_unused_bytes (transport->auth,
1072 if (!_dbus_string_copy (bytes, 0, buffer, _dbus_string_get_length (buffer)))
1075 _dbus_verbose (" %d unused bytes sent to message loader\n",
1076 _dbus_string_get_length (buffer) -
1079 _dbus_message_loader_return_buffer (transport->loader,
1081 _dbus_string_get_length (buffer) -
1085 _dbus_auth_delete_unused_bytes (transport->auth);
1093 _dbus_verbose ("Not enough memory to transfer unused bytes from auth conversation\n");
1098 * Reports our current dispatch status (whether there's buffered
1099 * data to be queued as messages, or not, or we need memory).
1101 * @param transport the transport
1102 * @returns current status
1105 _dbus_transport_get_dispatch_status (DBusTransport *transport)
1107 if (_dbus_counter_get_size_value (transport->live_messages) >= transport->max_live_messages_size ||
1108 _dbus_counter_get_unix_fd_value (transport->live_messages) >= transport->max_live_messages_unix_fds)
1109 return DBUS_DISPATCH_COMPLETE; /* complete for now */
1111 if (!_dbus_transport_try_to_authenticate (transport))
1113 if (_dbus_auth_do_work (transport->auth) ==
1114 DBUS_AUTH_STATE_WAITING_FOR_MEMORY)
1115 return DBUS_DISPATCH_NEED_MEMORY;
1116 else if (!_dbus_transport_try_to_authenticate (transport))
1117 return DBUS_DISPATCH_COMPLETE;
1120 if (!transport->unused_bytes_recovered &&
1121 !recover_unused_bytes (transport))
1122 return DBUS_DISPATCH_NEED_MEMORY;
1124 transport->unused_bytes_recovered = TRUE;
1126 if (!_dbus_message_loader_queue_messages (transport->loader))
1127 return DBUS_DISPATCH_NEED_MEMORY;
1129 if (_dbus_message_loader_peek_message (transport->loader) != NULL)
1130 return DBUS_DISPATCH_DATA_REMAINS;
1132 return DBUS_DISPATCH_COMPLETE;
1136 * Processes data we've read while handling a watch, potentially
1137 * converting some of it to messages and queueing those messages on
1140 * @param transport the transport
1141 * @returns #TRUE if we had enough memory to queue all messages
1144 _dbus_transport_queue_messages (DBusTransport *transport)
1146 DBusDispatchStatus status;
1149 _dbus_verbose ("_dbus_transport_queue_messages()\n");
1152 /* Queue any messages */
1153 while ((status = _dbus_transport_get_dispatch_status (transport)) == DBUS_DISPATCH_DATA_REMAINS)
1155 DBusMessage *message;
1158 link = _dbus_message_loader_pop_message_link (transport->loader);
1159 _dbus_assert (link != NULL);
1161 message = link->data;
1163 _dbus_verbose ("queueing received message %p\n", message);
1165 if (!_dbus_message_add_counter (message, transport->live_messages))
1167 _dbus_message_loader_putback_message_link (transport->loader,
1169 status = DBUS_DISPATCH_NEED_MEMORY;
1174 /* We didn't call the notify function when we added the counter, so
1175 * catch up now. Since we have the connection's lock, it's desirable
1176 * that we bypass the notify function and call this virtual method
1178 if (transport->vtable->live_messages_changed)
1179 (* transport->vtable->live_messages_changed) (transport);
1181 /* pass ownership of link and message ref to connection */
1182 _dbus_connection_queue_received_message_link (transport->connection,
1187 if (_dbus_message_loader_get_is_corrupted (transport->loader))
1189 _dbus_verbose ("Corrupted message stream, disconnecting\n");
1190 _dbus_transport_disconnect (transport);
1193 return status != DBUS_DISPATCH_NEED_MEMORY;
1197 * See dbus_connection_set_max_message_size().
1199 * @param transport the transport
1200 * @param size the max size of a single message
1203 _dbus_transport_set_max_message_size (DBusTransport *transport,
1206 _dbus_message_loader_set_max_message_size (transport->loader, size);
1210 * See dbus_connection_set_max_message_unix_fds().
1212 * @param transport the transport
1213 * @param n the max number of unix fds of a single message
1216 _dbus_transport_set_max_message_unix_fds (DBusTransport *transport,
1219 _dbus_message_loader_set_max_message_unix_fds (transport->loader, n);
1223 * See dbus_connection_get_max_message_size().
1225 * @param transport the transport
1226 * @returns max message size
1229 _dbus_transport_get_max_message_size (DBusTransport *transport)
1231 return _dbus_message_loader_get_max_message_size (transport->loader);
1235 * See dbus_connection_get_max_message_unix_fds().
1237 * @param transport the transport
1238 * @returns max message unix fds
1241 _dbus_transport_get_max_message_unix_fds (DBusTransport *transport)
1243 return _dbus_message_loader_get_max_message_unix_fds (transport->loader);
1247 * See dbus_connection_set_max_received_size().
1249 * @param transport the transport
1250 * @param size the max size of all incoming messages
1253 _dbus_transport_set_max_received_size (DBusTransport *transport,
1256 transport->max_live_messages_size = size;
1257 _dbus_counter_set_notify (transport->live_messages,
1258 transport->max_live_messages_size,
1259 transport->max_live_messages_unix_fds,
1260 live_messages_notify,
1265 * See dbus_connection_set_max_received_unix_fds().
1267 * @param transport the transport
1268 * @param n the max unix fds of all incoming messages
1271 _dbus_transport_set_max_received_unix_fds (DBusTransport *transport,
1274 transport->max_live_messages_unix_fds = n;
1275 _dbus_counter_set_notify (transport->live_messages,
1276 transport->max_live_messages_size,
1277 transport->max_live_messages_unix_fds,
1278 live_messages_notify,
1283 * See dbus_connection_get_max_received_size().
1285 * @param transport the transport
1286 * @returns max bytes for all live messages
1289 _dbus_transport_get_max_received_size (DBusTransport *transport)
1291 return transport->max_live_messages_size;
1295 * See dbus_connection_set_max_received_unix_fds().
1297 * @param transport the transport
1298 * @returns max unix fds for all live messages
1301 _dbus_transport_get_max_received_unix_fds (DBusTransport *transport)
1303 return transport->max_live_messages_unix_fds;
1307 * See dbus_connection_get_unix_user().
1309 * @param transport the transport
1310 * @param uid return location for the user ID
1311 * @returns #TRUE if uid is filled in with a valid user ID
1314 _dbus_transport_get_unix_user (DBusTransport *transport,
1317 DBusCredentials *auth_identity;
1319 *uid = _DBUS_INT32_MAX; /* better than some root or system user in
1320 * case of bugs in the caller. Caller should
1321 * never use this value on purpose, however.
1324 if (!transport->authenticated)
1327 auth_identity = _dbus_auth_get_identity (transport->auth);
1329 if (_dbus_credentials_include (auth_identity,
1330 DBUS_CREDENTIAL_UNIX_USER_ID))
1332 *uid = _dbus_credentials_get_unix_uid (auth_identity);
1340 * See dbus_connection_get_unix_process_id().
1342 * @param transport the transport
1343 * @param pid return location for the process ID
1344 * @returns #TRUE if uid is filled in with a valid process ID
1347 _dbus_transport_get_unix_process_id (DBusTransport *transport,
1350 DBusCredentials *auth_identity;
1352 *pid = DBUS_PID_UNSET; /* Caller should never use this value on purpose,
1353 * but we set it to a safe number, INT_MAX,
1354 * just to root out possible bugs in bad callers.
1357 if (!transport->authenticated)
1360 auth_identity = _dbus_auth_get_identity (transport->auth);
1362 if (_dbus_credentials_include (auth_identity,
1363 DBUS_CREDENTIAL_UNIX_PROCESS_ID))
1365 *pid = _dbus_credentials_get_pid (auth_identity);
1373 * See dbus_connection_get_adt_audit_session_data().
1375 * @param transport the transport
1376 * @param data return location for the ADT audit data
1377 * @param data_size return length of audit data
1378 * @returns #TRUE if audit data is filled in with a valid ucred
1381 _dbus_transport_get_adt_audit_session_data (DBusTransport *transport,
1385 DBusCredentials *auth_identity;
1390 if (!transport->authenticated)
1393 auth_identity = _dbus_auth_get_identity (transport->auth);
1395 if (_dbus_credentials_include (auth_identity,
1396 DBUS_CREDENTIAL_ADT_AUDIT_DATA_ID))
1398 *data = (void *) _dbus_credentials_get_adt_audit_data (auth_identity);
1399 *data_size = _dbus_credentials_get_adt_audit_data_size (auth_identity);
1407 * See dbus_connection_set_unix_user_function().
1409 * @param transport the transport
1410 * @param function the predicate
1411 * @param data data to pass to the predicate
1412 * @param free_data_function function to free the data
1413 * @param old_data the old user data to be freed
1414 * @param old_free_data_function old free data function to free it with
1417 _dbus_transport_set_unix_user_function (DBusTransport *transport,
1418 DBusAllowUnixUserFunction function,
1420 DBusFreeFunction free_data_function,
1422 DBusFreeFunction *old_free_data_function)
1424 *old_data = transport->unix_user_data;
1425 *old_free_data_function = transport->free_unix_user_data;
1427 transport->unix_user_function = function;
1428 transport->unix_user_data = data;
1429 transport->free_unix_user_data = free_data_function;
1433 * See dbus_connection_get_windows_user().
1435 * @param transport the transport
1436 * @param windows_sid_p return location for the user ID
1437 * @returns #TRUE if user is available; the returned value may still be #NULL if no memory to copy it
1440 _dbus_transport_get_windows_user (DBusTransport *transport,
1441 char **windows_sid_p)
1443 DBusCredentials *auth_identity;
1445 *windows_sid_p = NULL;
1447 if (!transport->authenticated)
1450 auth_identity = _dbus_auth_get_identity (transport->auth);
1452 if (_dbus_credentials_include (auth_identity,
1453 DBUS_CREDENTIAL_WINDOWS_SID))
1455 /* If no memory, we are supposed to return TRUE and set NULL */
1456 *windows_sid_p = _dbus_strdup (_dbus_credentials_get_windows_sid (auth_identity));
1465 * See dbus_connection_set_windows_user_function().
1467 * @param transport the transport
1468 * @param function the predicate
1469 * @param data data to pass to the predicate
1470 * @param free_data_function function to free the data
1471 * @param old_data the old user data to be freed
1472 * @param old_free_data_function old free data function to free it with
1476 _dbus_transport_set_windows_user_function (DBusTransport *transport,
1477 DBusAllowWindowsUserFunction function,
1479 DBusFreeFunction free_data_function,
1481 DBusFreeFunction *old_free_data_function)
1483 *old_data = transport->windows_user_data;
1484 *old_free_data_function = transport->free_windows_user_data;
1486 transport->windows_user_function = function;
1487 transport->windows_user_data = data;
1488 transport->free_windows_user_data = free_data_function;
1492 * Sets the SASL authentication mechanisms supported by this transport.
1494 * @param transport the transport
1495 * @param mechanisms the #NULL-terminated array of mechanisms
1497 * @returns #FALSE if no memory
1500 _dbus_transport_set_auth_mechanisms (DBusTransport *transport,
1501 const char **mechanisms)
1503 return _dbus_auth_set_mechanisms (transport->auth, mechanisms);
1507 * See dbus_connection_set_allow_anonymous()
1509 * @param transport the transport
1510 * @param value #TRUE to allow anonymous connection
1513 _dbus_transport_set_allow_anonymous (DBusTransport *transport,
1516 transport->allow_anonymous = value != FALSE;
1519 #ifdef DBUS_ENABLE_STATS
1521 _dbus_transport_get_stats (DBusTransport *transport,
1522 dbus_uint32_t *queue_bytes,
1523 dbus_uint32_t *queue_fds,
1524 dbus_uint32_t *peak_queue_bytes,
1525 dbus_uint32_t *peak_queue_fds)
1527 if (queue_bytes != NULL)
1528 *queue_bytes = _dbus_counter_get_size_value (transport->live_messages);
1530 if (queue_fds != NULL)
1531 *queue_fds = _dbus_counter_get_unix_fd_value (transport->live_messages);
1533 if (peak_queue_bytes != NULL)
1534 *peak_queue_bytes = _dbus_counter_get_peak_size_value (transport->live_messages);
1536 if (peak_queue_fds != NULL)
1537 *peak_queue_fds = _dbus_counter_get_peak_unix_fd_value (transport->live_messages);
1539 #endif /* DBUS_ENABLE_STATS */