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
24 #include <../config.h>
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 #include "dbus-transport-kdbus.h"
36 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
37 #include "dbus-server-debug-pipe.h"
41 * @defgroup DBusTransport DBusTransport object
42 * @ingroup DBusInternals
43 * @brief "Backend" for a DBusConnection.
45 * Types and functions related to DBusTransport. A transport is an
46 * abstraction that can send and receive data via various kinds of
47 * network connections or other IPC mechanisms.
53 * @typedef DBusTransport
55 * Opaque object representing a way message stream.
56 * DBusTransport abstracts various kinds of actual
57 * transport mechanism, such as different network protocols,
58 * or encryption schemes.
62 live_messages_notify (DBusCounter *counter,
65 DBusTransport *transport = user_data;
67 _dbus_transport_ref (transport);
70 _dbus_verbose ("Size counter value is now %d\n",
71 (int) _dbus_counter_get_size_value (counter));
72 _dbus_verbose ("Unix FD counter value is now %d\n",
73 (int) _dbus_counter_get_unix_fd_value (counter));
76 /* disable or re-enable the read watch for the transport if
79 if (transport->vtable->live_messages_changed)
81 _dbus_connection_lock (transport->connection);
82 (* transport->vtable->live_messages_changed) (transport);
83 _dbus_connection_unlock (transport->connection);
86 _dbus_transport_unref (transport);
90 * Initializes the base class members of DBusTransport. Chained up to
91 * by subclasses in their constructor. The server GUID is the
92 * globally unique ID for the server creating this connection
93 * and will be #NULL for the client side of a connection. The GUID
96 * @param transport the transport being created.
97 * @param vtable the subclass vtable.
98 * @param server_guid non-#NULL if this transport is on the server side of a connection
99 * @param address the address of the transport
100 * @returns #TRUE on success.
103 _dbus_transport_init_base (DBusTransport *transport,
104 const DBusTransportVTable *vtable,
105 const DBusString *server_guid,
106 const DBusString *address)
108 DBusMessageLoader *loader;
110 DBusCounter *counter;
112 DBusCredentials *creds;
114 loader = _dbus_message_loader_new ();
119 auth = _dbus_auth_server_new (server_guid);
122 _dbus_assert (address != NULL);
123 if (!_dbus_string_copy_data (address, &address_copy))
125 _dbus_message_loader_unref (loader);
128 if(address_copy == strstr(address_copy, "kdbus:path="))
129 auth = _dbus_auth_client_new_kdbus();
131 auth = _dbus_auth_client_new ();
136 _dbus_message_loader_unref (loader);
140 counter = _dbus_counter_new ();
143 _dbus_auth_unref (auth);
144 _dbus_message_loader_unref (loader);
148 creds = _dbus_credentials_new ();
151 _dbus_counter_unref (counter);
152 _dbus_auth_unref (auth);
153 _dbus_message_loader_unref (loader);
159 _dbus_assert (address == NULL);
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_kdbus },
353 { _dbus_transport_open_autolaunch }
354 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
355 , { _dbus_transport_open_debug_pipe }
360 * Try to open a new transport for the given address entry. (This
361 * opens a client-side-of-the-connection transport.)
363 * @param entry the address entry
364 * @param error location to store reason for failure.
365 * @returns new transport of #NULL on failure.
368 _dbus_transport_open (DBusAddressEntry *entry,
371 DBusTransport *transport;
372 const char *expected_guid_orig;
375 DBusError tmp_error = DBUS_ERROR_INIT;
377 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
380 expected_guid_orig = dbus_address_entry_get_value (entry, "guid");
381 expected_guid = _dbus_strdup (expected_guid_orig);
383 if (expected_guid_orig != NULL && expected_guid == NULL)
385 _DBUS_SET_OOM (error);
389 for (i = 0; i < (int) _DBUS_N_ELEMENTS (open_funcs); ++i)
391 DBusTransportOpenResult result;
393 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
394 result = (* open_funcs[i].func) (entry, &transport, &tmp_error);
398 case DBUS_TRANSPORT_OPEN_OK:
399 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
402 case DBUS_TRANSPORT_OPEN_NOT_HANDLED:
403 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
404 /* keep going through the loop of open funcs */
406 case DBUS_TRANSPORT_OPEN_BAD_ADDRESS:
407 _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
410 case DBUS_TRANSPORT_OPEN_DID_NOT_CONNECT:
411 _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
419 if (transport == NULL)
421 if (!dbus_error_is_set (&tmp_error))
422 _dbus_set_bad_address (&tmp_error,
424 "Unknown address type (examples of valid types are \"tcp\" and on UNIX \"unix\")");
426 _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
427 dbus_move_error(&tmp_error, error);
428 dbus_free (expected_guid);
432 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
434 /* In the case of autostart the initial guid is NULL
435 * and the autostart transport recursively calls
436 * _dbus_open_transport wich returns a transport
437 * with a guid. That guid is the definitive one.
439 * FIXME: if more transports are added they may have
440 * an effect on the expected_guid semantics (i.e.
441 * expected_guid and transport->expected_guid may
442 * both have values). This is very unlikely though
443 * we should either throw asserts here for those
444 * corner cases or refactor the code so it is
445 * clearer on what is expected and what is not
448 transport->expected_guid = expected_guid;
455 * Increments the reference count for the transport.
457 * @param transport the transport.
458 * @returns the transport.
461 _dbus_transport_ref (DBusTransport *transport)
463 _dbus_assert (transport->refcount > 0);
465 transport->refcount += 1;
471 * Decrements the reference count for the transport.
472 * Disconnects and finalizes the transport if
473 * the reference count reaches zero.
475 * @param transport the transport.
478 _dbus_transport_unref (DBusTransport *transport)
480 _dbus_assert (transport != NULL);
481 _dbus_assert (transport->refcount > 0);
483 transport->refcount -= 1;
484 if (transport->refcount == 0)
486 _dbus_verbose ("finalizing\n");
488 _dbus_assert (transport->vtable->finalize != NULL);
490 (* transport->vtable->finalize) (transport);
495 * Closes our end of the connection to a remote application. Further
496 * attempts to use this transport will fail. Only the first call to
497 * _dbus_transport_disconnect() will have an effect.
499 * @param transport the transport.
503 _dbus_transport_disconnect (DBusTransport *transport)
505 _dbus_verbose ("start\n");
507 _dbus_assert (transport->vtable->disconnect != NULL);
509 if (transport->disconnected)
512 (* transport->vtable->disconnect) (transport);
514 transport->disconnected = TRUE;
516 _dbus_verbose ("end\n");
520 * Returns #TRUE if the transport has not been disconnected.
521 * Disconnection can result from _dbus_transport_disconnect()
522 * or because the server drops its end of the connection.
524 * @param transport the transport.
525 * @returns whether we're connected
528 _dbus_transport_get_is_connected (DBusTransport *transport)
530 return !transport->disconnected;
534 auth_via_unix_user_function (DBusTransport *transport)
536 DBusCredentials *auth_identity;
538 DBusConnection *connection;
539 DBusAllowUnixUserFunction unix_user_function;
540 void *unix_user_data;
543 /* Dropping the lock here probably isn't that safe. */
545 auth_identity = _dbus_auth_get_identity (transport->auth);
546 _dbus_assert (auth_identity != NULL);
548 connection = transport->connection;
549 unix_user_function = transport->unix_user_function;
550 unix_user_data = transport->unix_user_data;
551 uid = _dbus_credentials_get_unix_uid (auth_identity);
553 _dbus_verbose ("unlock\n");
554 _dbus_connection_unlock (connection);
556 allow = (* unix_user_function) (connection,
560 _dbus_verbose ("lock post unix user function\n");
561 _dbus_connection_lock (connection);
565 _dbus_verbose ("Client UID "DBUS_UID_FORMAT" authorized\n", uid);
569 _dbus_verbose ("Client UID "DBUS_UID_FORMAT
570 " was rejected, disconnecting\n",
571 _dbus_credentials_get_unix_uid (auth_identity));
572 _dbus_transport_disconnect (transport);
579 auth_via_windows_user_function (DBusTransport *transport)
581 DBusCredentials *auth_identity;
583 DBusConnection *connection;
584 DBusAllowWindowsUserFunction windows_user_function;
585 void *windows_user_data;
588 /* Dropping the lock here probably isn't that safe. */
590 auth_identity = _dbus_auth_get_identity (transport->auth);
591 _dbus_assert (auth_identity != NULL);
593 connection = transport->connection;
594 windows_user_function = transport->windows_user_function;
595 windows_user_data = transport->unix_user_data;
596 windows_sid = _dbus_strdup (_dbus_credentials_get_windows_sid (auth_identity));
598 if (windows_sid == NULL)
604 _dbus_verbose ("unlock\n");
605 _dbus_connection_unlock (connection);
607 allow = (* windows_user_function) (connection,
611 _dbus_verbose ("lock post windows user function\n");
612 _dbus_connection_lock (connection);
616 _dbus_verbose ("Client SID '%s' authorized\n", windows_sid);
620 _dbus_verbose ("Client SID '%s' was rejected, disconnecting\n",
621 _dbus_credentials_get_windows_sid (auth_identity));
622 _dbus_transport_disconnect (transport);
629 auth_via_default_rules (DBusTransport *transport)
631 DBusCredentials *auth_identity;
632 DBusCredentials *our_identity;
635 auth_identity = _dbus_auth_get_identity (transport->auth);
636 _dbus_assert (auth_identity != NULL);
638 /* By default, connection is allowed if the client is 1) root or 2)
639 * has the same UID as us or 3) anonymous is allowed.
642 our_identity = _dbus_credentials_new_from_current_process ();
643 if (our_identity == NULL)
649 if (transport->allow_anonymous ||
650 _dbus_credentials_get_unix_uid (auth_identity) == 0 ||
651 _dbus_credentials_same_user (our_identity,
654 if (_dbus_credentials_include(our_identity,DBUS_CREDENTIAL_WINDOWS_SID))
655 _dbus_verbose ("Client authorized as SID '%s'"
656 "matching our SID '%s'\n",
657 _dbus_credentials_get_windows_sid(auth_identity),
658 _dbus_credentials_get_windows_sid(our_identity));
660 _dbus_verbose ("Client authorized as UID "DBUS_UID_FORMAT
661 " matching our UID "DBUS_UID_FORMAT"\n",
662 _dbus_credentials_get_unix_uid(auth_identity),
663 _dbus_credentials_get_unix_uid(our_identity));
664 /* We have authenticated! */
669 if (_dbus_credentials_include(our_identity,DBUS_CREDENTIAL_WINDOWS_SID))
670 _dbus_verbose ("Client authorized as SID '%s'"
671 " but our SID is '%s', disconnecting\n",
672 (_dbus_credentials_get_windows_sid(auth_identity) ?
673 _dbus_credentials_get_windows_sid(auth_identity) : "<null>"),
674 (_dbus_credentials_get_windows_sid(our_identity) ?
675 _dbus_credentials_get_windows_sid(our_identity) : "<null>"));
677 _dbus_verbose ("Client authorized as UID "DBUS_UID_FORMAT
678 " but our UID is "DBUS_UID_FORMAT", disconnecting\n",
679 _dbus_credentials_get_unix_uid(auth_identity),
680 _dbus_credentials_get_unix_uid(our_identity));
681 _dbus_transport_disconnect (transport);
685 _dbus_credentials_unref (our_identity);
691 * Returns #TRUE if we have been authenticated. It will return #TRUE even if
692 * the transport is now disconnected, but was ever authenticated before
695 * This replaces the older _dbus_transport_get_is_authenticated() which
698 * @param transport the transport
699 * @returns whether we're authenticated
702 _dbus_transport_peek_is_authenticated (DBusTransport *transport)
704 return transport->authenticated;
708 * Returns #TRUE if we have been authenticated. It will return #TRUE even if
709 * the transport is now disconnected, but was ever authenticated before
712 * If we have not finished authenticating, but we have enough buffered input
713 * to finish the job, then this function will do so before it returns.
715 * This used to be called _dbus_transport_get_is_authenticated(), but that
716 * name seems inappropriate for a function with side-effects.
718 * @todo we drop connection->mutex when calling the unix_user_function,
719 * and windows_user_function, which may not be safe really.
721 * @param transport the transport
722 * @returns whether we're authenticated
725 _dbus_transport_try_to_authenticate (DBusTransport *transport)
727 if (transport->authenticated)
731 dbus_bool_t maybe_authenticated;
733 if (transport->disconnected)
736 /* paranoia ref since we call user callbacks sometimes */
737 _dbus_connection_ref_unlocked (transport->connection);
739 maybe_authenticated =
740 (!(transport->send_credentials_pending ||
741 transport->receive_credentials_pending));
743 if (maybe_authenticated)
745 switch (_dbus_auth_do_work (transport->auth))
747 case DBUS_AUTH_STATE_AUTHENTICATED:
748 /* leave as maybe_authenticated */
751 maybe_authenticated = FALSE;
755 /* If we're the client, verify the GUID
757 if (maybe_authenticated && !transport->is_server)
759 const char *server_guid;
761 server_guid = _dbus_auth_get_guid_from_server (transport->auth);
762 _dbus_assert (server_guid != NULL);
764 if (transport->expected_guid &&
765 strcmp (transport->expected_guid, server_guid) != 0)
767 _dbus_verbose ("Client expected GUID '%s' and we got '%s' from the server\n",
768 transport->expected_guid, server_guid);
769 _dbus_transport_disconnect (transport);
770 _dbus_connection_unref_unlocked (transport->connection);
775 /* If we're the server, see if we want to allow this identity to proceed.
777 if (maybe_authenticated && transport->is_server)
780 DBusCredentials *auth_identity;
782 auth_identity = _dbus_auth_get_identity (transport->auth);
783 _dbus_assert (auth_identity != NULL);
785 /* If we have an auth'd user and a user function, delegate
786 * deciding whether auth credentials are good enough to the
787 * app; otherwise, use our default decision process.
789 if (transport->unix_user_function != NULL &&
790 _dbus_credentials_include (auth_identity, DBUS_CREDENTIAL_UNIX_USER_ID))
792 allow = auth_via_unix_user_function (transport);
794 else if (transport->windows_user_function != NULL &&
795 _dbus_credentials_include (auth_identity, DBUS_CREDENTIAL_WINDOWS_SID))
797 allow = auth_via_windows_user_function (transport);
801 allow = auth_via_default_rules (transport);
805 maybe_authenticated = FALSE;
808 transport->authenticated = maybe_authenticated;
810 _dbus_connection_unref_unlocked (transport->connection);
811 return maybe_authenticated;
816 * See dbus_connection_get_is_anonymous().
818 * @param transport the transport
819 * @returns #TRUE if not authenticated or authenticated as anonymous
822 _dbus_transport_get_is_anonymous (DBusTransport *transport)
824 DBusCredentials *auth_identity;
826 if (!transport->authenticated)
829 auth_identity = _dbus_auth_get_identity (transport->auth);
831 if (_dbus_credentials_are_anonymous (auth_identity))
838 * Returns TRUE if the transport supports sending unix fds.
840 * @param transport the transport
841 * @returns #TRUE if TRUE it is possible to send unix fds across the transport.
844 _dbus_transport_can_pass_unix_fd(DBusTransport *transport)
846 return DBUS_TRANSPORT_CAN_SEND_UNIX_FD(transport);
850 * Gets the address of a transport. It will be
851 * #NULL for a server-side transport.
853 * @param transport the transport
854 * @returns transport's address
857 _dbus_transport_get_address (DBusTransport *transport)
859 return transport->address;
863 * Gets the id of the server we are connected to (see
864 * dbus_server_get_id()). Only works on client side.
866 * @param transport the transport
867 * @returns transport's server's id or #NULL if we are the server side
870 _dbus_transport_get_server_id (DBusTransport *transport)
872 if (transport->is_server)
874 else if (transport->authenticated)
875 return _dbus_auth_get_guid_from_server (transport->auth);
877 return transport->expected_guid;
881 * Handles a watch by reading data, writing data, or disconnecting
882 * the transport, as appropriate for the given condition.
884 * @param transport the transport.
885 * @param watch the watch.
886 * @param condition the current state of the watched file descriptor.
887 * @returns #FALSE if not enough memory to fully handle the watch
890 _dbus_transport_handle_watch (DBusTransport *transport,
892 unsigned int condition)
896 _dbus_assert (transport->vtable->handle_watch != NULL);
898 if (transport->disconnected)
901 if (dbus_watch_get_socket (watch) < 0)
903 _dbus_warn_check_failed ("Tried to handle an invalidated watch; this watch should have been removed\n");
907 _dbus_watch_sanitize_condition (watch, &condition);
909 _dbus_transport_ref (transport);
910 _dbus_watch_ref (watch);
911 retval = (* transport->vtable->handle_watch) (transport, watch, condition);
912 _dbus_watch_unref (watch);
913 _dbus_transport_unref (transport);
919 * Sets the connection using this transport. Allows the transport
920 * to add watches to the connection, queue incoming messages,
921 * and pull outgoing messages.
923 * @param transport the transport.
924 * @param connection the connection.
925 * @returns #FALSE if not enough memory
928 _dbus_transport_set_connection (DBusTransport *transport,
929 DBusConnection *connection)
931 _dbus_assert (transport->vtable->connection_set != NULL);
932 _dbus_assert (transport->connection == NULL);
934 transport->connection = connection;
936 _dbus_transport_ref (transport);
937 if (!(* transport->vtable->connection_set) (transport))
938 transport->connection = NULL;
939 _dbus_transport_unref (transport);
941 return transport->connection != NULL;
945 * Get the socket file descriptor, if any.
947 * @param transport the transport
948 * @param fd_p pointer to fill in with the descriptor
949 * @returns #TRUE if a descriptor was available
952 _dbus_transport_get_socket_fd (DBusTransport *transport,
957 if (transport->vtable->get_socket_fd == NULL)
960 if (transport->disconnected)
963 _dbus_transport_ref (transport);
965 retval = (* transport->vtable->get_socket_fd) (transport,
968 _dbus_transport_unref (transport);
974 * Performs a single poll()/select() on the transport's file
975 * descriptors and then reads/writes data as appropriate,
976 * queueing incoming messages and sending outgoing messages.
977 * This is the backend for _dbus_connection_do_iteration().
978 * See _dbus_connection_do_iteration() for full details.
980 * @param transport the transport.
981 * @param flags indicates whether to read or write, and whether to block.
982 * @param timeout_milliseconds if blocking, timeout or -1 for no timeout.
985 _dbus_transport_do_iteration (DBusTransport *transport,
987 int timeout_milliseconds)
989 _dbus_assert (transport->vtable->do_iteration != NULL);
991 _dbus_verbose ("Transport iteration flags 0x%x timeout %d connected = %d\n",
992 flags, timeout_milliseconds, !transport->disconnected);
994 if ((flags & (DBUS_ITERATION_DO_WRITING |
995 DBUS_ITERATION_DO_READING)) == 0)
996 return; /* Nothing to do */
998 if (transport->disconnected)
1001 _dbus_transport_ref (transport);
1002 (* transport->vtable->do_iteration) (transport, flags,
1003 timeout_milliseconds);
1004 _dbus_transport_unref (transport);
1006 _dbus_verbose ("end\n");
1010 recover_unused_bytes (DBusTransport *transport)
1012 if (_dbus_auth_needs_decoding (transport->auth))
1014 DBusString plaintext;
1015 const DBusString *encoded;
1019 if (!_dbus_string_init (&plaintext))
1022 _dbus_auth_get_unused_bytes (transport->auth,
1025 if (!_dbus_auth_decode_data (transport->auth,
1026 encoded, &plaintext))
1028 _dbus_string_free (&plaintext);
1032 _dbus_message_loader_get_buffer (transport->loader,
1035 orig_len = _dbus_string_get_length (buffer);
1037 if (!_dbus_string_move (&plaintext, 0, buffer,
1040 _dbus_string_free (&plaintext);
1044 _dbus_verbose (" %d unused bytes sent to message loader\n",
1045 _dbus_string_get_length (buffer) -
1048 _dbus_message_loader_return_buffer (transport->loader,
1050 _dbus_string_get_length (buffer) -
1053 _dbus_auth_delete_unused_bytes (transport->auth);
1055 _dbus_string_free (&plaintext);
1059 const DBusString *bytes;
1062 dbus_bool_t succeeded;
1064 _dbus_message_loader_get_buffer (transport->loader,
1067 orig_len = _dbus_string_get_length (buffer);
1069 _dbus_auth_get_unused_bytes (transport->auth,
1073 if (!_dbus_string_copy (bytes, 0, buffer, _dbus_string_get_length (buffer)))
1076 _dbus_verbose (" %d unused bytes sent to message loader\n",
1077 _dbus_string_get_length (buffer) -
1080 _dbus_message_loader_return_buffer (transport->loader,
1082 _dbus_string_get_length (buffer) -
1086 _dbus_auth_delete_unused_bytes (transport->auth);
1094 _dbus_verbose ("Not enough memory to transfer unused bytes from auth conversation\n");
1099 * Reports our current dispatch status (whether there's buffered
1100 * data to be queued as messages, or not, or we need memory).
1102 * @param transport the transport
1103 * @returns current status
1106 _dbus_transport_get_dispatch_status (DBusTransport *transport)
1108 if (_dbus_counter_get_size_value (transport->live_messages) >= transport->max_live_messages_size ||
1109 _dbus_counter_get_unix_fd_value (transport->live_messages) >= transport->max_live_messages_unix_fds)
1110 return DBUS_DISPATCH_COMPLETE; /* complete for now */
1112 if (!_dbus_transport_try_to_authenticate (transport))
1114 if (_dbus_auth_do_work (transport->auth) ==
1115 DBUS_AUTH_STATE_WAITING_FOR_MEMORY)
1116 return DBUS_DISPATCH_NEED_MEMORY;
1117 else if (!_dbus_transport_try_to_authenticate (transport))
1118 return DBUS_DISPATCH_COMPLETE;
1121 if (!transport->unused_bytes_recovered &&
1122 !recover_unused_bytes (transport))
1123 return DBUS_DISPATCH_NEED_MEMORY;
1125 transport->unused_bytes_recovered = TRUE;
1127 if (!_dbus_message_loader_queue_messages (transport->loader))
1128 return DBUS_DISPATCH_NEED_MEMORY;
1130 if (_dbus_message_loader_peek_message (transport->loader) != NULL)
1131 return DBUS_DISPATCH_DATA_REMAINS;
1133 return DBUS_DISPATCH_COMPLETE;
1137 * Processes data we've read while handling a watch, potentially
1138 * converting some of it to messages and queueing those messages on
1141 * @param transport the transport
1142 * @returns #TRUE if we had enough memory to queue all messages
1145 _dbus_transport_queue_messages (DBusTransport *transport)
1147 DBusDispatchStatus status;
1150 _dbus_verbose ("_dbus_transport_queue_messages()\n");
1153 /* Queue any messages */
1154 while ((status = _dbus_transport_get_dispatch_status (transport)) == DBUS_DISPATCH_DATA_REMAINS)
1156 DBusMessage *message;
1159 link = _dbus_message_loader_pop_message_link (transport->loader);
1160 _dbus_assert (link != NULL);
1162 message = link->data;
1164 _dbus_verbose ("queueing received message %p\n", message);
1166 if (!_dbus_message_add_counter (message, transport->live_messages))
1168 _dbus_message_loader_putback_message_link (transport->loader,
1170 status = DBUS_DISPATCH_NEED_MEMORY;
1175 /* We didn't call the notify function when we added the counter, so
1176 * catch up now. Since we have the connection's lock, it's desirable
1177 * that we bypass the notify function and call this virtual method
1179 if (transport->vtable->live_messages_changed)
1180 (* transport->vtable->live_messages_changed) (transport);
1182 /* pass ownership of link and message ref to connection */
1183 _dbus_connection_queue_received_message_link (transport->connection,
1188 if (_dbus_message_loader_get_is_corrupted (transport->loader))
1190 _dbus_verbose ("Corrupted message stream, disconnecting\n");
1191 _dbus_transport_disconnect (transport);
1194 return status != DBUS_DISPATCH_NEED_MEMORY;
1198 * See dbus_connection_set_max_message_size().
1200 * @param transport the transport
1201 * @param size the max size of a single message
1204 _dbus_transport_set_max_message_size (DBusTransport *transport,
1207 _dbus_message_loader_set_max_message_size (transport->loader, size);
1211 * See dbus_connection_set_max_message_unix_fds().
1213 * @param transport the transport
1214 * @param n the max number of unix fds of a single message
1217 _dbus_transport_set_max_message_unix_fds (DBusTransport *transport,
1220 _dbus_message_loader_set_max_message_unix_fds (transport->loader, n);
1224 * See dbus_connection_get_max_message_size().
1226 * @param transport the transport
1227 * @returns max message size
1230 _dbus_transport_get_max_message_size (DBusTransport *transport)
1232 return _dbus_message_loader_get_max_message_size (transport->loader);
1236 * See dbus_connection_get_max_message_unix_fds().
1238 * @param transport the transport
1239 * @returns max message unix fds
1242 _dbus_transport_get_max_message_unix_fds (DBusTransport *transport)
1244 return _dbus_message_loader_get_max_message_unix_fds (transport->loader);
1248 * See dbus_connection_set_max_received_size().
1250 * @param transport the transport
1251 * @param size the max size of all incoming messages
1254 _dbus_transport_set_max_received_size (DBusTransport *transport,
1257 transport->max_live_messages_size = size;
1258 _dbus_counter_set_notify (transport->live_messages,
1259 transport->max_live_messages_size,
1260 transport->max_live_messages_unix_fds,
1261 live_messages_notify,
1266 * See dbus_connection_set_max_received_unix_fds().
1268 * @param transport the transport
1269 * @param n the max unix fds of all incoming messages
1272 _dbus_transport_set_max_received_unix_fds (DBusTransport *transport,
1275 transport->max_live_messages_unix_fds = n;
1276 _dbus_counter_set_notify (transport->live_messages,
1277 transport->max_live_messages_size,
1278 transport->max_live_messages_unix_fds,
1279 live_messages_notify,
1284 * See dbus_connection_get_max_received_size().
1286 * @param transport the transport
1287 * @returns max bytes for all live messages
1290 _dbus_transport_get_max_received_size (DBusTransport *transport)
1292 return transport->max_live_messages_size;
1296 * See dbus_connection_set_max_received_unix_fds().
1298 * @param transport the transport
1299 * @returns max unix fds for all live messages
1302 _dbus_transport_get_max_received_unix_fds (DBusTransport *transport)
1304 return transport->max_live_messages_unix_fds;
1308 * See dbus_connection_get_unix_user().
1310 * @param transport the transport
1311 * @param uid return location for the user ID
1312 * @returns #TRUE if uid is filled in with a valid user ID
1315 _dbus_transport_get_unix_user (DBusTransport *transport,
1318 DBusCredentials *auth_identity;
1320 *uid = _DBUS_INT32_MAX; /* better than some root or system user in
1321 * case of bugs in the caller. Caller should
1322 * never use this value on purpose, however.
1325 if (!transport->authenticated)
1328 auth_identity = _dbus_auth_get_identity (transport->auth);
1330 if (_dbus_credentials_include (auth_identity,
1331 DBUS_CREDENTIAL_UNIX_USER_ID))
1333 *uid = _dbus_credentials_get_unix_uid (auth_identity);
1341 * See dbus_connection_get_unix_process_id().
1343 * @param transport the transport
1344 * @param pid return location for the process ID
1345 * @returns #TRUE if uid is filled in with a valid process ID
1348 _dbus_transport_get_unix_process_id (DBusTransport *transport,
1351 DBusCredentials *auth_identity;
1353 *pid = DBUS_PID_UNSET; /* Caller should never use this value on purpose,
1354 * but we set it to a safe number, INT_MAX,
1355 * just to root out possible bugs in bad callers.
1358 if (!transport->authenticated)
1361 auth_identity = _dbus_auth_get_identity (transport->auth);
1363 if (_dbus_credentials_include (auth_identity,
1364 DBUS_CREDENTIAL_UNIX_PROCESS_ID))
1366 *pid = _dbus_credentials_get_pid (auth_identity);
1374 * See dbus_connection_get_adt_audit_session_data().
1376 * @param transport the transport
1377 * @param data return location for the ADT audit data
1378 * @param data_size return length of audit data
1379 * @returns #TRUE if audit data is filled in with a valid ucred
1382 _dbus_transport_get_adt_audit_session_data (DBusTransport *transport,
1386 DBusCredentials *auth_identity;
1391 if (!transport->authenticated)
1394 auth_identity = _dbus_auth_get_identity (transport->auth);
1396 if (_dbus_credentials_include (auth_identity,
1397 DBUS_CREDENTIAL_ADT_AUDIT_DATA_ID))
1399 *data = (void *) _dbus_credentials_get_adt_audit_data (auth_identity);
1400 *data_size = _dbus_credentials_get_adt_audit_data_size (auth_identity);
1408 * See dbus_connection_set_unix_user_function().
1410 * @param transport the transport
1411 * @param function the predicate
1412 * @param data data to pass to the predicate
1413 * @param free_data_function function to free the data
1414 * @param old_data the old user data to be freed
1415 * @param old_free_data_function old free data function to free it with
1418 _dbus_transport_set_unix_user_function (DBusTransport *transport,
1419 DBusAllowUnixUserFunction function,
1421 DBusFreeFunction free_data_function,
1423 DBusFreeFunction *old_free_data_function)
1425 *old_data = transport->unix_user_data;
1426 *old_free_data_function = transport->free_unix_user_data;
1428 transport->unix_user_function = function;
1429 transport->unix_user_data = data;
1430 transport->free_unix_user_data = free_data_function;
1434 * See dbus_connection_get_windows_user().
1436 * @param transport the transport
1437 * @param windows_sid_p return location for the user ID
1438 * @returns #TRUE if user is available; the returned value may still be #NULL if no memory to copy it
1441 _dbus_transport_get_windows_user (DBusTransport *transport,
1442 char **windows_sid_p)
1444 DBusCredentials *auth_identity;
1446 *windows_sid_p = NULL;
1448 if (!transport->authenticated)
1451 auth_identity = _dbus_auth_get_identity (transport->auth);
1453 if (_dbus_credentials_include (auth_identity,
1454 DBUS_CREDENTIAL_WINDOWS_SID))
1456 /* If no memory, we are supposed to return TRUE and set NULL */
1457 *windows_sid_p = _dbus_strdup (_dbus_credentials_get_windows_sid (auth_identity));
1466 * See dbus_connection_set_windows_user_function().
1468 * @param transport the transport
1469 * @param function the predicate
1470 * @param data data to pass to the predicate
1471 * @param free_data_function function to free the data
1472 * @param old_data the old user data to be freed
1473 * @param old_free_data_function old free data function to free it with
1477 _dbus_transport_set_windows_user_function (DBusTransport *transport,
1478 DBusAllowWindowsUserFunction function,
1480 DBusFreeFunction free_data_function,
1482 DBusFreeFunction *old_free_data_function)
1484 *old_data = transport->windows_user_data;
1485 *old_free_data_function = transport->free_windows_user_data;
1487 transport->windows_user_function = function;
1488 transport->windows_user_data = data;
1489 transport->free_windows_user_data = free_data_function;
1493 * Sets the SASL authentication mechanisms supported by this transport.
1495 * @param transport the transport
1496 * @param mechanisms the #NULL-terminated array of mechanisms
1498 * @returns #FALSE if no memory
1501 _dbus_transport_set_auth_mechanisms (DBusTransport *transport,
1502 const char **mechanisms)
1504 return _dbus_auth_set_mechanisms (transport->auth, mechanisms);
1508 * See dbus_connection_set_allow_anonymous()
1510 * @param transport the transport
1511 * @param value #TRUE to allow anonymous connection
1514 _dbus_transport_set_allow_anonymous (DBusTransport *transport,
1517 transport->allow_anonymous = value != FALSE;
1520 #ifdef DBUS_ENABLE_STATS
1522 _dbus_transport_get_stats (DBusTransport *transport,
1523 dbus_uint32_t *queue_bytes,
1524 dbus_uint32_t *queue_fds,
1525 dbus_uint32_t *peak_queue_bytes,
1526 dbus_uint32_t *peak_queue_fds)
1528 if (queue_bytes != NULL)
1529 *queue_bytes = _dbus_counter_get_size_value (transport->live_messages);
1531 if (queue_fds != NULL)
1532 *queue_fds = _dbus_counter_get_unix_fd_value (transport->live_messages);
1534 if (peak_queue_bytes != NULL)
1535 *peak_queue_bytes = _dbus_counter_get_peak_size_value (transport->live_messages);
1537 if (peak_queue_fds != NULL)
1538 *peak_queue_fds = _dbus_counter_get_peak_unix_fd_value (transport->live_messages);
1540 #endif /* DBUS_ENABLE_STATS */