D-Bus 1.13.18

dbus-credentials.h
1/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2/* dbus-credentials.h Credentials provable through authentication
3 *
4 * Copyright (C) 2007 Red Hat Inc.
5 *
6 * Licensed under the Academic Free License version 2.1
7 *
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.
12 *
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.
17 *
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
21 *
22 */
23#ifndef DBUS_CREDENTIALS_H
24#define DBUS_CREDENTIALS_H
25
26#include <dbus/dbus-macros.h>
27#include <dbus/dbus-errors.h>
28#include <dbus/dbus-string.h>
29#include <dbus/dbus-sysdeps.h>
30
31 DBUS_BEGIN_DECLS
32
33 typedef enum {
34 DBUS_CREDENTIAL_UNIX_PROCESS_ID,
35 DBUS_CREDENTIAL_UNIX_USER_ID,
36 DBUS_CREDENTIAL_UNIX_GROUP_IDS,
37 DBUS_CREDENTIAL_ADT_AUDIT_DATA_ID,
38 DBUS_CREDENTIAL_LINUX_SECURITY_LABEL,
39 DBUS_CREDENTIAL_WINDOWS_SID
40} DBusCredentialType;
41
42DBUS_PRIVATE_EXPORT
43 DBusCredentials* _dbus_credentials_new_from_current_process (void);
44DBUS_PRIVATE_EXPORT
45 DBusCredentials* _dbus_credentials_new (void);
46DBUS_PRIVATE_EXPORT
47 void _dbus_credentials_ref (DBusCredentials *credentials);
48DBUS_PRIVATE_EXPORT
49 void _dbus_credentials_unref (DBusCredentials *credentials);
50DBUS_PRIVATE_EXPORT
51 dbus_bool_t _dbus_credentials_add_pid (DBusCredentials *credentials,
52 dbus_pid_t pid);
53DBUS_PRIVATE_EXPORT
54 dbus_bool_t _dbus_credentials_add_unix_uid (DBusCredentials *credentials,
55 dbus_uid_t uid);
56DBUS_PRIVATE_EXPORT
57 void _dbus_credentials_take_unix_gids (DBusCredentials *credentials,
58 dbus_gid_t *gids,
59 size_t n_gids);
60DBUS_PRIVATE_EXPORT
61 dbus_bool_t _dbus_credentials_add_windows_sid (DBusCredentials *credentials,
62 const char *windows_sid);
63 dbus_bool_t _dbus_credentials_add_linux_security_label (DBusCredentials *credentials,
64 const char *label);
65 dbus_bool_t _dbus_credentials_add_adt_audit_data (DBusCredentials *credentials,
66 void *audit_data,
67 dbus_int32_t size);
68DBUS_PRIVATE_EXPORT
69 dbus_bool_t _dbus_credentials_include (DBusCredentials *credentials,
70 DBusCredentialType type);
71DBUS_PRIVATE_EXPORT
72 dbus_pid_t _dbus_credentials_get_pid (DBusCredentials *credentials);
73DBUS_PRIVATE_EXPORT
74 dbus_uid_t _dbus_credentials_get_unix_uid (DBusCredentials *credentials);
75DBUS_PRIVATE_EXPORT
76 dbus_bool_t _dbus_credentials_get_unix_gids (DBusCredentials *credentials,
77 const dbus_gid_t **gids,
78 size_t *n_gids);
79DBUS_PRIVATE_EXPORT
80 const char* _dbus_credentials_get_windows_sid (DBusCredentials *credentials);
81DBUS_PRIVATE_EXPORT
82 const char * _dbus_credentials_get_linux_security_label (DBusCredentials *credentials);
83 void * _dbus_credentials_get_adt_audit_data (DBusCredentials *credentials);
84dbus_int32_t _dbus_credentials_get_adt_audit_data_size (DBusCredentials *credentials);
85DBUS_PRIVATE_EXPORT
86 dbus_bool_t _dbus_credentials_are_superset (DBusCredentials *credentials,
87 DBusCredentials *possible_subset);
88DBUS_PRIVATE_EXPORT
89 dbus_bool_t _dbus_credentials_are_empty (DBusCredentials *credentials);
90DBUS_PRIVATE_EXPORT
91 dbus_bool_t _dbus_credentials_are_anonymous (DBusCredentials *credentials);
92 dbus_bool_t _dbus_credentials_add_credentials (DBusCredentials *credentials,
93 DBusCredentials *other_credentials);
94/* must silently allow 'which' to not exist */
95 dbus_bool_t _dbus_credentials_add_credential (DBusCredentials *credentials,
96 DBusCredentialType which,
97 DBusCredentials *other_credentials);
98DBUS_PRIVATE_EXPORT
99 void _dbus_credentials_clear (DBusCredentials *credentials);
100DBUS_PRIVATE_EXPORT
101 DBusCredentials* _dbus_credentials_copy (DBusCredentials *credentials);
102DBUS_PRIVATE_EXPORT
103 dbus_bool_t _dbus_credentials_same_user (DBusCredentials *credentials,
104 DBusCredentials *other_credentials);
105DBUS_PRIVATE_EXPORT
106 dbus_bool_t _dbus_credentials_to_string_append (DBusCredentials *credentials,
107 DBusString *string);
108
109 static inline void
110_dbus_clear_credentials (DBusCredentials **pointer_to_creds)
111{
112 _dbus_clear_pointer_impl (DBusCredentials, pointer_to_creds,
113 _dbus_credentials_unref);
114}
115
116 DBUS_END_DECLS
117
118#endif /* DBUS_CREDENTIALS_H */
_dbus_credentials_ref
DBUS_PRIVATE_EXPORT void _dbus_credentials_ref(DBusCredentials *credentials)
Increment refcount on credentials.
Definition: dbus-credentials.c:123
_dbus_credentials_include
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_credentials_include(DBusCredentials *credentials, DBusCredentialType type)
Checks whether the given credential is present.
Definition: dbus-credentials.c:318
_dbus_credentials_are_superset
DBUS_PRIVATE_EXPORT 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 credenti...
Definition: dbus-credentials.c:428
_dbus_credentials_same_user
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_credentials_same_user(DBusCredentials *credentials, DBusCredentials *other_credentials)
Check whether the user-identifying credentials in two credentials objects are identical.
Definition: dbus-credentials.c:645
_dbus_credentials_clear
DBUS_PRIVATE_EXPORT void _dbus_credentials_clear(DBusCredentials *credentials)
Clear all credentials in the object.
Definition: dbus-credentials.c:593
_dbus_credentials_get_unix_uid
DBUS_PRIVATE_EXPORT 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...
Definition: dbus-credentials.c:362
_dbus_credentials_copy
DBUS_PRIVATE_EXPORT DBusCredentials * _dbus_credentials_copy(DBusCredentials *credentials)
Copy a credentials object.
Definition: dbus-credentials.c:616
_dbus_credentials_new_from_current_process
DBUS_PRIVATE_EXPORT DBusCredentials * _dbus_credentials_new_from_current_process(void)
Creates a new object with the most important credentials (user ID and process ID) from the current pr...
Definition: dbus-credentials.c:100
_dbus_credentials_to_string_append
DBUS_PRIVATE_EXPORT 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 str...
Definition: dbus-credentials.c:666
_dbus_credentials_new
DBUS_PRIVATE_EXPORT DBusCredentials * _dbus_credentials_new(void)
Creates a new credentials object.
Definition: dbus-credentials.c:74
_dbus_credentials_get_adt_audit_data
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 aud...
Definition: dbus-credentials.c:401
_dbus_credentials_add_linux_security_label
dbus_bool_t _dbus_credentials_add_linux_security_label(DBusCredentials *credentials, const char *label)
Add a Linux security label, as used by LSMs such as SELinux, Smack and AppArmor, to the credentials.
Definition: dbus-credentials.c:270
_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 ...
Definition: dbus-credentials.c:495
_dbus_credentials_get_linux_security_label
DBUS_PRIVATE_EXPORT const char * _dbus_credentials_get_linux_security_label(DBusCredentials *credentials)
Gets the Linux security label (as used by LSMs) from the credentials, or NULL if the credentials obje...
Definition: dbus-credentials.c:388
_dbus_credentials_take_unix_gids
DBUS_PRIVATE_EXPORT void _dbus_credentials_take_unix_gids(DBusCredentials *credentials, dbus_gid_t *gids, size_t n_gids)
Add UNIX group IDs to the credentials, replacing any group IDs that might already have been present.
Definition: dbus-credentials.c:205
_dbus_credentials_unref
DBUS_PRIVATE_EXPORT void _dbus_credentials_unref(DBusCredentials *credentials)
Decrement refcount on credentials.
Definition: dbus-credentials.c:135
_dbus_credentials_get_unix_gids
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_credentials_get_unix_gids(DBusCredentials *credentials, const dbus_gid_t **gids, size_t *n_gids)
Get the Unix group IDs.
Definition: dbus-credentials.c:225
_dbus_credentials_are_empty
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_credentials_are_empty(DBusCredentials *credentials)
Checks whether a credentials object contains anything.
Definition: dbus-credentials.c:460
_dbus_credentials_add_unix_uid
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_credentials_add_unix_uid(DBusCredentials *credentials, dbus_uid_t uid)
Add a UNIX user ID to the credentials.
Definition: dbus-credentials.c:173
_dbus_credentials_add_windows_sid
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_credentials_add_windows_sid(DBusCredentials *credentials, const char *windows_sid)
Add a Windows user SID to the credentials.
Definition: dbus-credentials.c:246
_dbus_credentials_add_pid
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_credentials_add_pid(DBusCredentials *credentials, dbus_pid_t pid)
Add a UNIX process ID to the credentials.
Definition: dbus-credentials.c:158
_dbus_credentials_get_pid
DBUS_PRIVATE_EXPORT 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 cont...
Definition: dbus-credentials.c:349
_dbus_credentials_add_adt_audit_data
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.
Definition: dbus-credentials.c:294
_dbus_credentials_get_adt_audit_data_size
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 a...
Definition: dbus-credentials.c:414
_dbus_credentials_get_windows_sid
DBUS_PRIVATE_EXPORT 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 Win...
Definition: dbus-credentials.c:375
_dbus_credentials_add_credential
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 ob...
Definition: dbus-credentials.c:532
_dbus_credentials_are_anonymous
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_credentials_are_anonymous(DBusCredentials *credentials)
Checks whether a credentials object contains a user identity.
Definition: dbus-credentials.c:479
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
DBUS_END_DECLS
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.
dbus_uid_t
unsigned long dbus_uid_t
A user ID.
Definition: dbus-sysdeps.h:137
dbus_pid_t
unsigned long dbus_pid_t
A process ID.
Definition: dbus-sysdeps.h:135
dbus_gid_t
unsigned long dbus_gid_t
A group ID.
Definition: dbus-sysdeps.h:139
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
DBusCredentials
Definition: dbus-credentials.c:49
DBusString
Definition: dbus-string.h:43