D-Bus 1.13.18

Macros | Functions
Authentication
D-Bus secret internal implementation details

DBusAuth object. More...

## Macros
#define | DBUS_AUTH_IN_END_STATE(auth) ((auth)->state->handler == NULL)

## Functions
DBusAuth * | _dbus_auth_server_new (const DBusString *guid)
| Creates a new auth conversation object for the server side. More...
DBusAuth * | _dbus_auth_client_new (void)
| Creates a new auth conversation object for the client side. More...
DBusAuth * | _dbus_auth_ref (DBusAuth *auth)
| Increments the refcount of an auth object. More...
void | _dbus_auth_unref (DBusAuth *auth)
| Decrements the refcount of an auth object. More...
dbus_bool_t | _dbus_auth_set_mechanisms (DBusAuth *auth, const char **mechanisms)
| Sets an array of authentication mechanism names that we are willing to use. More...
DBusAuthState | _dbus_auth_do_work (DBusAuth *auth)
| Analyzes buffered input and moves the auth conversation forward, returning the new state of the auth conversation. More...
dbus_bool_t | _dbus_auth_get_bytes_to_send (DBusAuth *auth, const DBusString **str)
| Gets bytes that need to be sent to the peer we're conversing with. More...
void | _dbus_auth_bytes_sent (DBusAuth *auth, int bytes_sent)
| Notifies the auth conversation object that the given number of bytes of the outgoing buffer have been written out. More...
void | _dbus_auth_get_buffer (DBusAuth *auth, DBusString **buffer)
| Get a buffer to be used for reading bytes from the peer we're conversing with. More...
void | _dbus_auth_return_buffer (DBusAuth *auth, DBusString *buffer)
| Returns a buffer with new data read into it. More...
void | _dbus_auth_get_unused_bytes (DBusAuth *auth, const DBusString **str)
| Returns leftover bytes that were not used as part of the auth conversation. More...
void | _dbus_auth_delete_unused_bytes (DBusAuth *auth)
| Gets rid of unused bytes returned by _dbus_auth_get_unused_bytes() after we've gotten them and successfully moved them elsewhere. More...
dbus_bool_t | _dbus_auth_needs_encoding (DBusAuth *auth)
| Called post-authentication, indicates whether we need to encode the message stream with _dbus_auth_encode_data() prior to sending it to the peer. More...
dbus_bool_t | _dbus_auth_encode_data (DBusAuth *auth, const DBusString *plaintext, DBusString *encoded)
| Called post-authentication, encodes a block of bytes for sending to the peer. More...
dbus_bool_t | _dbus_auth_needs_decoding (DBusAuth *auth)
| Called post-authentication, indicates whether we need to decode the message stream with _dbus_auth_decode_data() after receiving it from the peer. More...
dbus_bool_t | _dbus_auth_decode_data (DBusAuth *auth, const DBusString *encoded, DBusString *plaintext)
| Called post-authentication, decodes a block of bytes received from the peer. More...
dbus_bool_t | _dbus_auth_set_credentials (DBusAuth *auth, DBusCredentials *credentials)
| Sets credentials received via reliable means from the operating system. More...
DBusCredentials * | _dbus_auth_get_identity (DBusAuth *auth)
| Gets the identity we authorized the client as. More...
const char * | _dbus_auth_get_guid_from_server (DBusAuth *auth)
| Gets the GUID from the server if we've authenticated; gets NULL otherwise. More...
dbus_bool_t | _dbus_auth_set_context (DBusAuth *auth, const DBusString *context)
| Sets the "authentication context" which scopes cookies with the DBUS_COOKIE_SHA1 auth mechanism for example. More...
void | _dbus_auth_set_unix_fd_possible (DBusAuth *auth, dbus_bool_t b)
| Sets whether unix fd passing is potentially on the transport and hence shall be negotiated. More...
dbus_bool_t | _dbus_auth_get_unix_fd_negotiated (DBusAuth *auth)
| Queries whether unix fd passing was successfully negotiated. More...
dbus_bool_t | _dbus_auth_is_supported_mechanism (DBusString *name)
| Queries whether the given auth mechanism is supported. More...
dbus_bool_t | _dbus_auth_dump_supported_mechanisms (DBusString *buffer)
| Return a human-readable string containing all supported auth mechanisms. More...

## Detailed Description

DBusAuth object.

DBusAuth manages the authentication negotiation when a connection is first established, and also manages any encryption used over a connection.

Todo:
  some SASL profiles require sending the empty string as a challenge/response, but we don't currently allow that in our protocol.

Todo:
  right now sometimes both ends will block waiting for input from the other end, e.g. if there's an error during DBUS_COOKIE_SHA1.

Todo:
  the cookie keyring needs to be cached globally not just per-auth (which raises threadsafety issues too)

Todo:
  grep FIXME in dbus-auth.c

## Macro Definition Documentation

## ◆ DBUS_AUTH_IN_END_STATE

#define DBUS_AUTH_IN_END_STATE | ( |  | auth | ) | ((auth)->state->handler == NULL)

Parameters

  auth | the auth conversation object

Returns
  TRUE if we're in a final state

Definition at line 2529 of file dbus-auth.c.

## Function Documentation

## ◆ _dbus_auth_bytes_sent()

void _dbus_auth_bytes_sent | ( | DBusAuth * | auth,
|  | int | bytes_sent
| ) |  |

Notifies the auth conversation object that the given number of bytes of the outgoing buffer have been written out.

Parameters

  auth | the auth conversation
  bytes_sent | number of bytes written out

Definition at line 2607 of file dbus-auth.c.

References _dbus_string_delete(), DBUS_AUTH_NAME, and outgoing.

## ◆ _dbus_auth_client_new()

DBusAuth* _dbus_auth_client_new | ( | void |  | ) |

Creates a new auth conversation object for the client side.

See http://dbus.freedesktop.org/doc/dbus-specification.html#auth-protocol for full details on what this object does.

Returns
  the new object or NULL if no memory

Definition at line 2400 of file dbus-auth.c.

References _dbus_string_init(), and NULL.

Referenced by _dbus_transport_init_base().

## ◆ _dbus_auth_decode_data()

dbus_bool_t _dbus_auth_decode_data | ( | DBusAuth * | auth,
|  | const DBusString * | encoded,
|  | DBusString * | plaintext
| ) |  |

Called post-authentication, decodes a block of bytes received from the peer.

If no encoding was negotiated, just copies the bytes (you can avoid this by checking _dbus_auth_needs_decoding()).

Todo:
  1.0? We need to be able to distinguish "out of memory" error from "the data is hosed" error.

Parameters

  auth | the auth conversation
  encoded | the encoded data
  plaintext | initialized string where decoded data is appended

Returns
  TRUE if we had enough memory and successfully decoded

Definition at line 2788 of file dbus-auth.c.

References _dbus_assert, and state.

## ◆ _dbus_auth_delete_unused_bytes()

void _dbus_auth_delete_unused_bytes | ( | DBusAuth * | auth | ) |

Gets rid of unused bytes returned by _dbus_auth_get_unused_bytes() after we've gotten them and successfully moved them elsewhere.

Parameters

  auth | the auth conversation

Definition at line 2681 of file dbus-auth.c.

References _dbus_string_set_length(), DBUS_AUTH_IN_END_STATE, and incoming.

## ◆ _dbus_auth_do_work()

DBusAuthState _dbus_auth_do_work | ( | DBusAuth * | auth | ) |

Analyzes buffered input and moves the auth conversation forward, returning the new state of the auth conversation.

Parameters

  auth | the auth conversation

Returns
  the new state

Definition at line 2538 of file dbus-auth.c.

References DBUS_AUTH_IN_END_STATE, FALSE, incoming, needed_memory, and outgoing.

Referenced by _dbus_transport_get_dispatch_status(), and _dbus_transport_try_to_authenticate().

## ◆ _dbus_auth_dump_supported_mechanisms()

dbus_bool_t _dbus_auth_dump_supported_mechanisms | ( | DBusString * | buffer | ) |

Return a human-readable string containing all supported auth mechanisms.

Parameters

  string | to hold the supported auth mechanisms

Returns
  FALSE on oom

Definition at line 2934 of file dbus-auth.c.

References _dbus_assert, and NULL.

## ◆ _dbus_auth_encode_data()

dbus_bool_t _dbus_auth_encode_data | ( | DBusAuth * | auth,
|  | const DBusString * | plaintext,
|  | DBusString * | encoded
| ) |  |

Called post-authentication, encodes a block of bytes for sending to the peer.

If no encoding was negotiated, just copies the bytes (you can avoid this by checking _dbus_auth_needs_encoding()).

Parameters

  auth | the auth conversation
  plaintext | the plain text data
  encoded | initialized string to where encoded data is appended

Returns
  TRUE if we had enough memory and successfully encoded

Definition at line 2725 of file dbus-auth.c.

References _dbus_assert, and state.

## ◆ _dbus_auth_get_buffer()

void _dbus_auth_get_buffer | ( | DBusAuth * | auth,
|  | DBusString ** | buffer
| ) |  |

Get a buffer to be used for reading bytes from the peer we're conversing with.

Bytes should be appended to this buffer.

Parameters

  auth | the auth conversation
  buffer | return location for buffer to append bytes to

Definition at line 2627 of file dbus-auth.c.

References _dbus_assert, buffer_outstanding, incoming, NULL, and TRUE.

## ◆ _dbus_auth_get_bytes_to_send()

dbus_bool_t _dbus_auth_get_bytes_to_send | ( | DBusAuth * | auth,
|  | const DBusString ** | str
| ) |  |

Gets bytes that need to be sent to the peer we're conversing with.

After writing some bytes, _dbus_auth_bytes_sent() must be called to notify the auth object that they were written.

Parameters

  auth | the auth conversation
  str | return location for a ref to the buffer to send

Returns
  FALSE if nothing to send

Definition at line 2582 of file dbus-auth.c.

References _dbus_assert, FALSE, NULL, outgoing, and TRUE.

## ◆ _dbus_auth_get_guid_from_server()

const char* _dbus_auth_get_guid_from_server | ( | DBusAuth * | auth | ) |

Gets the GUID from the server if we've authenticated; gets NULL otherwise.

Parameters

  auth | the auth object

Returns
  the GUID in ASCII hex format

Definition at line 2862 of file dbus-auth.c.

References _dbus_assert, DBUS_AUTH_IS_CLIENT, and state.

Referenced by _dbus_transport_get_server_id(), and _dbus_transport_try_to_authenticate().

## ◆ _dbus_auth_get_identity()

DBusCredentials* _dbus_auth_get_identity | ( | DBusAuth * | auth | ) |

Gets the identity we authorized the client as.

Apps may have different policies as to what identities they allow.

Returned credentials are not a copy and should not be modified

Parameters

  auth | the auth conversation

Returns
  the credentials we've authorized BY REFERENCE do not modify

Definition at line 2838 of file dbus-auth.c.

References state.

Referenced by _dbus_transport_get_adt_audit_session_data(), _dbus_transport_get_credentials(), _dbus_transport_get_is_anonymous(), _dbus_transport_get_unix_process_id(), _dbus_transport_get_unix_user(), _dbus_transport_get_windows_user(), and _dbus_transport_try_to_authenticate().

## ◆ _dbus_auth_get_unix_fd_negotiated()

dbus_bool_t _dbus_auth_get_unix_fd_negotiated | ( | DBusAuth * | auth | ) |

Queries whether unix fd passing was successfully negotiated.

Parameters

  auth | the auth conversion

Returns
  TRUE when unix fd passing was negotiated.

Definition at line 2908 of file dbus-auth.c.

References unix_fd_negotiated.

## ◆ _dbus_auth_get_unused_bytes()

void _dbus_auth_get_unused_bytes | ( | DBusAuth * | auth,
|  | const DBusString ** | str
| ) |  |

Returns leftover bytes that were not used as part of the auth conversation.

These bytes will be part of the message stream instead. This function may not be called until authentication has succeeded.

Parameters

  auth | the auth conversation
  str | return location for pointer to string of unused bytes

Definition at line 2664 of file dbus-auth.c.

References DBUS_AUTH_IN_END_STATE, and incoming.

## ◆ _dbus_auth_is_supported_mechanism()

dbus_bool_t _dbus_auth_is_supported_mechanism | ( | DBusString * | name | ) |

Queries whether the given auth mechanism is supported.

Parameters

  auth | the auth mechanism to query for

Returns
  TRUE when auth mechanism is supported

Definition at line 2920 of file dbus-auth.c.

References _dbus_assert, and NULL.

## ◆ _dbus_auth_needs_decoding()

dbus_bool_t _dbus_auth_needs_decoding | ( | DBusAuth * | auth | ) |

Called post-authentication, indicates whether we need to decode the message stream with _dbus_auth_decode_data() after receiving it from the peer.

Parameters

  auth | the auth conversation

Returns
  TRUE if we need to encode the stream

Definition at line 2757 of file dbus-auth.c.

References state.

## ◆ _dbus_auth_needs_encoding()

dbus_bool_t _dbus_auth_needs_encoding | ( | DBusAuth * | auth | ) |

Called post-authentication, indicates whether we need to encode the message stream with _dbus_auth_encode_data() prior to sending it to the peer.

Parameters

  auth | the auth conversation

Returns
  TRUE if we need to encode the stream

Definition at line 2698 of file dbus-auth.c.

References state.

## ◆ _dbus_auth_ref()

DBusAuth* _dbus_auth_ref | ( | DBusAuth * | auth | ) |

Increments the refcount of an auth object.

Parameters

  auth | the auth conversation

Returns
  the auth conversation

Definition at line 2438 of file dbus-auth.c.

References _dbus_assert, NULL, and refcount.

## ◆ _dbus_auth_return_buffer()

void _dbus_auth_return_buffer | ( | DBusAuth * | auth,
|  | DBusString * | buffer
| ) |  |

Returns a buffer with new data read into it.

Parameters

  auth | the auth conversation
  buffer | the buffer being returned

Definition at line 2645 of file dbus-auth.c.

References _dbus_assert, buffer_outstanding, FALSE, and incoming.

## ◆ _dbus_auth_server_new()

DBusAuth* _dbus_auth_server_new | ( | const DBusString * | guid | ) |

Creates a new auth conversation object for the server side.

See http://dbus.freedesktop.org/doc/dbus-specification.html#auth-protocol for full details on what this object does.

Returns
  the new object or NULL if no memory

Definition at line 2354 of file dbus-auth.c.

References _dbus_string_copy(), _dbus_string_free(), _dbus_string_init(), and NULL.

Referenced by _dbus_transport_init_base().

## ◆ _dbus_auth_set_context()

dbus_bool_t _dbus_auth_set_context | ( | DBusAuth * | auth,
|  | const DBusString * | context
| ) |  |

Sets the "authentication context" which scopes cookies with the DBUS_COOKIE_SHA1 auth mechanism for example.

Parameters

  auth | the auth conversation
  context | the context

Returns
  FALSE if no memory

Definition at line 2881 of file dbus-auth.c.

References _dbus_string_replace_len(), and context.

## ◆ _dbus_auth_set_credentials()

dbus_bool_t _dbus_auth_set_credentials | ( | DBusAuth * | auth,
|  | DBusCredentials * | credentials
| ) |  |

Sets credentials received via reliable means from the operating system.

Parameters

  auth | the auth conversation
  credentials | the credentials received

Returns
  FALSE on OOM

Definition at line 2820 of file dbus-auth.c.

References _dbus_credentials_add_credentials(), _dbus_credentials_clear(), and credentials.

## ◆ _dbus_auth_set_mechanisms()

dbus_bool_t _dbus_auth_set_mechanisms | ( | DBusAuth * | auth,
|  | const char ** | mechanisms
| ) |  |

Sets an array of authentication mechanism names that we are willing to use.

Parameters

  auth | the auth conversation
  mechanisms | NULL-terminated array of mechanism names

Returns
  FALSE if no memory

Definition at line 2503 of file dbus-auth.c.

Referenced by _dbus_transport_set_auth_mechanisms().

## ◆ _dbus_auth_set_unix_fd_possible()

void _dbus_auth_set_unix_fd_possible | ( | DBusAuth * | auth,
|  | dbus_bool_t | b
| ) |  |

Sets whether unix fd passing is potentially on the transport and hence shall be negotiated.

Parameters

  auth | the auth conversation
  b | TRUE when unix fd passing shall be negotiated, otherwise FALSE

Definition at line 2896 of file dbus-auth.c.

References unix_fd_possible.

## ◆ _dbus_auth_unref()

void _dbus_auth_unref | ( | DBusAuth * | auth | ) |

Decrements the refcount of an auth object.

Parameters

  auth | the auth conversation

Definition at line 2453 of file dbus-auth.c.

References _dbus_assert, NULL, and refcount.

Referenced by _dbus_transport_finalize_base(), and _dbus_transport_init_base().