D-Bus  1.8.1
Functions
Credentials provable through authentication

DBusCredentials object. More...

Functions

DBusCredentials_dbus_credentials_new (void)
 Creates a new credentials object. More...
 
DBusCredentials_dbus_credentials_new_from_current_process (void)
 Creates a new object with credentials (user ID and process ID) from the current process. More...
 
void _dbus_credentials_ref (DBusCredentials *credentials)
 Increment refcount on credentials. More...
 
void _dbus_credentials_unref (DBusCredentials *credentials)
 Decrement refcount on credentials. More...
 
dbus_bool_t _dbus_credentials_add_pid (DBusCredentials *credentials, dbus_pid_t pid)
 Add a UNIX process ID to the credentials. More...
 
dbus_bool_t _dbus_credentials_add_unix_uid (DBusCredentials *credentials, dbus_uid_t uid)
 Add a UNIX user ID to the credentials. More...
 
dbus_bool_t _dbus_credentials_add_windows_sid (DBusCredentials *credentials, const char *windows_sid)
 Add a Windows user SID to the credentials. More...
 
dbus_bool_t _dbus_credentials_add_adt_audit_data (DBusCredentials *credentials, void *audit_data, dbus_int32_t size)
 Add ADT audit data to the credentials. More...
 
dbus_bool_t _dbus_credentials_include (DBusCredentials *credentials, DBusCredentialType type)
 Checks whether the given credential is present. More...
 
dbus_pid_t _dbus_credentials_get_pid (DBusCredentials *credentials)
 Gets the UNIX process ID in the credentials, or DBUS_PID_UNSET if the credentials object doesn't contain a process ID. More...
 
dbus_uid_t _dbus_credentials_get_unix_uid (DBusCredentials *credentials)
 Gets the UNIX user ID in the credentials, or DBUS_UID_UNSET if the credentials object doesn't contain a user ID. More...
 
const char * _dbus_credentials_get_windows_sid (DBusCredentials *credentials)
 Gets the Windows user SID in the credentials, or NULL if the credentials object doesn't contain a Windows user SID. More...
 
void * _dbus_credentials_get_adt_audit_data (DBusCredentials *credentials)
 Gets the ADT audit data in the credentials, or NULL if the credentials object doesn't contain ADT audit data. More...
 
dbus_int32_t _dbus_credentials_get_adt_audit_data_size (DBusCredentials *credentials)
 Gets the ADT audit data size in the credentials, or 0 if the credentials object doesn't contain ADT audit data. More...
 
dbus_bool_t _dbus_credentials_are_superset (DBusCredentials *credentials, DBusCredentials *possible_subset)
 Checks whether the first credentials object contains all the credentials found in the second credentials object. More...
 
dbus_bool_t _dbus_credentials_are_empty (DBusCredentials *credentials)
 Checks whether a credentials object contains anything. More...
 
dbus_bool_t _dbus_credentials_are_anonymous (DBusCredentials *credentials)
 Checks whether a credentials object contains a user identity. More...
 
dbus_bool_t _dbus_credentials_add_credentials (DBusCredentials *credentials, DBusCredentials *other_credentials)
 Merge all credentials found in the second object into the first object, overwriting the first object if there are any overlaps. More...
 
dbus_bool_t _dbus_credentials_add_credential (DBusCredentials *credentials, DBusCredentialType which, DBusCredentials *other_credentials)
 Merge the given credential found in the second object into the first object, overwriting the first object's value for that credential. More...
 
void _dbus_credentials_clear (DBusCredentials *credentials)
 Clear all credentials in the object. More...
 
DBusCredentials_dbus_credentials_copy (DBusCredentials *credentials)
 Copy a credentials object. More...
 
dbus_bool_t _dbus_credentials_same_user (DBusCredentials *credentials, DBusCredentials *other_credentials)
 Check whether the user-identifying credentials in two credentials objects are identical. More...
 
dbus_bool_t _dbus_credentials_to_string_append (DBusCredentials *credentials, DBusString *string)
 Convert the credentials in this object to a human-readable string format, and append to the given string. More...
 

Detailed Description

DBusCredentials object.

Credentials are what you have to prove you have in order to authenticate. The main credentials right now are a unix user account, a Windows user account, or a UNIX process ID.

Function Documentation

dbus_bool_t _dbus_credentials_add_adt_audit_data ( DBusCredentials credentials,
void *  audit_data,
dbus_int32_t  size 
)

Add ADT audit data to the credentials.

Parameters
credentialsthe object
audit_datathe audit data
sizethe length of audit data
Returns
FALSE if no memory

Definition at line 204 of file dbus-credentials.c.

References _dbus_memdup(), dbus_free(), FALSE, NULL, and TRUE.

Referenced by _dbus_credentials_add_credential(), and _dbus_read_credentials_socket().

dbus_bool_t _dbus_credentials_add_credential ( DBusCredentials credentials,
DBusCredentialType  which,
DBusCredentials other_credentials 
)

Merge the given credential found in the second object into the first object, overwriting the first object's value for that credential.

Does nothing if the second object does not contain the specified credential. i.e., will never delete a credential from the first object.

Parameters
credentialsthe object
whichthe credential to overwrite
other_credentialscredentials to merge
Returns
FALSE if no memory

Definition at line 408 of file dbus-credentials.c.

References _dbus_credentials_add_adt_audit_data(), _dbus_credentials_add_pid(), _dbus_credentials_add_unix_uid(), _dbus_credentials_add_windows_sid(), DBUS_PID_UNSET, DBUS_UID_UNSET, FALSE, NULL, and TRUE.

Referenced by _dbus_credentials_add_credentials().

dbus_bool_t _dbus_credentials_add_credentials ( DBusCredentials credentials,
DBusCredentials other_credentials 
)

Merge all credentials found in the second object into the first object, overwriting the first object if there are any overlaps.

Parameters
credentialsthe object
other_credentialscredentials to merge
Returns
FALSE if no memory

Definition at line 377 of file dbus-credentials.c.

References _dbus_credentials_add_credential().

Referenced by _dbus_auth_set_credentials(), and _dbus_credentials_copy().

dbus_bool_t _dbus_credentials_add_pid ( DBusCredentials credentials,
dbus_pid_t  pid 
)

Add a UNIX process ID to the credentials.

Parameters
credentialsthe object
pidthe process ID
Returns
FALSE if no memory

Definition at line 149 of file dbus-credentials.c.

References TRUE.

Referenced by _dbus_credentials_add_credential(), _dbus_credentials_add_from_current_process(), and _dbus_read_credentials_socket().

dbus_bool_t _dbus_credentials_add_unix_uid ( DBusCredentials credentials,
dbus_uid_t  uid 
)

Add a UNIX user ID to the credentials.

Parameters
credentialsthe object
uidthe user ID
Returns
FALSE if no memory

Definition at line 164 of file dbus-credentials.c.

References TRUE.

Referenced by _dbus_credentials_add_credential(), _dbus_credentials_add_from_current_process(), _dbus_credentials_add_from_user(), and _dbus_read_credentials_socket().

dbus_bool_t _dbus_credentials_add_windows_sid ( DBusCredentials credentials,
const char *  windows_sid 
)

Add a Windows user SID to the credentials.

Parameters
credentialsthe object
windows_sidthe user SID
Returns
FALSE if no memory

Definition at line 180 of file dbus-credentials.c.

References _dbus_strdup(), dbus_free(), FALSE, NULL, and TRUE.

Referenced by _dbus_credentials_add_credential(), _dbus_credentials_add_from_current_process(), _dbus_credentials_add_from_user(), and _dbus_read_credentials_socket().

dbus_bool_t _dbus_credentials_are_anonymous ( DBusCredentials credentials)

Checks whether a credentials object contains a user identity.

Parameters
credentialsthe object
Returns
TRUE if there are no user identities in the object

Definition at line 361 of file dbus-credentials.c.

References DBUS_UID_UNSET, and NULL.

Referenced by _dbus_append_keyring_directory_for_credentials(), _dbus_keyring_new_for_credentials(), and _dbus_transport_get_is_anonymous().

dbus_bool_t _dbus_credentials_are_empty ( DBusCredentials credentials)

Checks whether a credentials object contains anything.

Parameters
credentialsthe object
Returns
TRUE if there are no credentials in the object

Definition at line 345 of file dbus-credentials.c.

References DBUS_PID_UNSET, DBUS_UID_UNSET, and NULL.

Referenced by _dbus_auth_get_identity().

dbus_bool_t _dbus_credentials_are_superset ( DBusCredentials credentials,
DBusCredentials possible_subset 
)

Checks whether the first credentials object contains all the credentials found in the second credentials object.

Parameters
credentialsthe object
possible_subsetsee if credentials in here are also in the first arg
Returns
TRUE if second arg is contained in first

Definition at line 321 of file dbus-credentials.c.

References DBUS_PID_UNSET, DBUS_UID_UNSET, and NULL.

void _dbus_credentials_clear ( DBusCredentials credentials)

Clear all credentials in the object.

Parameters
credentialsthe object

Definition at line 446 of file dbus-credentials.c.

References dbus_free(), DBUS_PID_UNSET, DBUS_UID_UNSET, and NULL.

Referenced by _dbus_auth_set_credentials(), and _dbus_read_credentials_socket().

DBusCredentials* _dbus_credentials_copy ( DBusCredentials credentials)

Copy a credentials object.

Parameters
credentialsthe object
Returns
the copy or NULL

Definition at line 464 of file dbus-credentials.c.

References _dbus_credentials_add_credentials(), _dbus_credentials_new(), _dbus_credentials_unref(), and NULL.

Referenced by _dbus_keyring_new_for_credentials().

void* _dbus_credentials_get_adt_audit_data ( DBusCredentials credentials)

Gets the ADT audit data in the credentials, or NULL if the credentials object doesn't contain ADT audit data.

Parameters
credentialsthe object
Returns
Solaris ADT audit data

Definition at line 294 of file dbus-credentials.c.

Referenced by _dbus_transport_get_adt_audit_session_data().

dbus_int32_t _dbus_credentials_get_adt_audit_data_size ( DBusCredentials credentials)

Gets the ADT audit data size in the credentials, or 0 if the credentials object doesn't contain ADT audit data.

Parameters
credentialsthe object
Returns
Solaris ADT audit data size

Definition at line 307 of file dbus-credentials.c.

Referenced by _dbus_transport_get_adt_audit_session_data().

dbus_pid_t _dbus_credentials_get_pid ( DBusCredentials credentials)

Gets the UNIX process ID in the credentials, or DBUS_PID_UNSET if the credentials object doesn't contain a process ID.

Parameters
credentialsthe object
Returns
UNIX process ID

Definition at line 255 of file dbus-credentials.c.

Referenced by _dbus_transport_get_unix_process_id().

dbus_uid_t _dbus_credentials_get_unix_uid ( DBusCredentials credentials)

Gets the UNIX user ID in the credentials, or DBUS_UID_UNSET if the credentials object doesn't contain a user ID.

Parameters
credentialsthe object
Returns
UNIX user ID

Definition at line 268 of file dbus-credentials.c.

Referenced by _dbus_append_keyring_directory_for_credentials(), and _dbus_transport_get_unix_user().

const char* _dbus_credentials_get_windows_sid ( DBusCredentials credentials)

Gets the Windows user SID in the credentials, or NULL if the credentials object doesn't contain a Windows user SID.

Parameters
credentialsthe object
Returns
Windows user SID

Definition at line 281 of file dbus-credentials.c.

Referenced by _dbus_transport_get_windows_user().

dbus_bool_t _dbus_credentials_include ( DBusCredentials credentials,
DBusCredentialType  type 
)

Checks whether the given credential is present.

Parameters
credentialsthe object
typethe credential to check for
Returns
TRUE if the credential is present

Definition at line 228 of file dbus-credentials.c.

References _dbus_assert_not_reached, DBUS_PID_UNSET, DBUS_UID_UNSET, FALSE, and NULL.

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

DBusCredentials* _dbus_credentials_new ( void  )

Creates a new credentials object.

Returns
the new object or NULL if no memory

Definition at line 70 of file dbus-credentials.c.

References dbus_new, DBUS_PID_UNSET, DBUS_UID_UNSET, and NULL.

Referenced by _dbus_credentials_copy(), _dbus_credentials_new_from_current_process(), and _dbus_transport_init_base().

DBusCredentials* _dbus_credentials_new_from_current_process ( void  )

Creates a new object with credentials (user ID and process ID) from the current process.

Returns
the new object or NULL if no memory

Definition at line 93 of file dbus-credentials.c.

References _dbus_credentials_add_from_current_process(), _dbus_credentials_new(), _dbus_credentials_unref(), and NULL.

Referenced by _dbus_keyring_new_for_credentials().

void _dbus_credentials_ref ( DBusCredentials credentials)

Increment refcount on credentials.

Parameters
credentialsthe object

Definition at line 116 of file dbus-credentials.c.

References _dbus_assert.

dbus_bool_t _dbus_credentials_same_user ( DBusCredentials credentials,
DBusCredentials other_credentials 
)

Check whether the user-identifying credentials in two credentials objects are identical.

Credentials that are not related to the user are ignored, but any kind of user ID credentials must be the same (UNIX user ID, Windows user SID, etc.) and present in both objects for the function to return TRUE.

Parameters
credentialsthe object
other_credentialscredentials to compare
Returns
TRUE if the two credentials refer to the same user

Definition at line 493 of file dbus-credentials.c.

Referenced by _dbus_keyring_is_for_credentials().

dbus_bool_t _dbus_credentials_to_string_append ( DBusCredentials credentials,
DBusString string 
)

Convert the credentials in this object to a human-readable string format, and append to the given string.

Parameters
credentialsthe object
stringappend to this string
Returns
FALSE if no memory

Definition at line 514 of file dbus-credentials.c.

References _dbus_string_append_printf(), DBUS_PID_FORMAT, DBUS_PID_UNSET, DBUS_UID_FORMAT, DBUS_UID_UNSET, FALSE, NULL, and TRUE.

void _dbus_credentials_unref ( DBusCredentials credentials)