D-Bus  1.12.20
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 #ifdef HAVE_PDPLINUX
32 #include <parsec/parsec_cap.h>
33 #endif
35 
36 typedef enum {
37  DBUS_CREDENTIAL_UNIX_PROCESS_ID,
38  DBUS_CREDENTIAL_UNIX_USER_ID,
39 #ifdef HAVE_PDPLINUX
40  DBUS_CREDENTIAL_UNIX_PARSEC,
41 #endif
42  DBUS_CREDENTIAL_ADT_AUDIT_DATA_ID,
43  DBUS_CREDENTIAL_LINUX_SECURITY_LABEL,
44  DBUS_CREDENTIAL_WINDOWS_SID
45 } DBusCredentialType;
46 
47 DBUS_PRIVATE_EXPORT
49 DBUS_PRIVATE_EXPORT
51 DBUS_PRIVATE_EXPORT
52 void _dbus_credentials_ref (DBusCredentials *credentials);
53 DBUS_PRIVATE_EXPORT
54 void _dbus_credentials_unref (DBusCredentials *credentials);
55 DBUS_PRIVATE_EXPORT
57  dbus_pid_t pid);
58 DBUS_PRIVATE_EXPORT
60  dbus_uid_t uid);
61 DBUS_PRIVATE_EXPORT
63  const char *windows_sid);
65  const char *label);
67  void *audit_data,
68  dbus_int32_t size);
69 DBUS_PRIVATE_EXPORT
71  DBusCredentialType type);
72 DBUS_PRIVATE_EXPORT
74 DBUS_PRIVATE_EXPORT
76 DBUS_PRIVATE_EXPORT
77 const char* _dbus_credentials_get_windows_sid (DBusCredentials *credentials);
81 DBUS_PRIVATE_EXPORT
83  DBusCredentials *possible_subset);
84 DBUS_PRIVATE_EXPORT
86 DBUS_PRIVATE_EXPORT
89  DBusCredentials *other_credentials);
90 /* must silently allow 'which' to not exist */
92  DBusCredentialType which,
93  DBusCredentials *other_credentials);
94 DBUS_PRIVATE_EXPORT
95 void _dbus_credentials_clear (DBusCredentials *credentials);
96 DBUS_PRIVATE_EXPORT
98 DBUS_PRIVATE_EXPORT
100  DBusCredentials *other_credentials);
101 DBUS_PRIVATE_EXPORT
103  DBusString *string);
104 
105 #ifdef HAVE_PDPLINUX
106 
107 void _dbus_credentials_pdplinux_get_unix_parsec (DBusCredentials *credentials, BusPDPLinuxID** pparsecid);
108 dbus_bool_t _dbus_credentials_pdplinux_add_unix_parsec (DBusCredentials *credentials, BusPDPLinuxID* parsecid);
109 
110 #endif
111 
113 
114 #endif /* DBUS_CREDENTIALS_H */
_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:198
_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:329
_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:417
_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:616
_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:355
DBUS_END_DECLS
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.
_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:637
_dbus_credentials_copy
DBUS_PRIVATE_EXPORT DBusCredentials * _dbus_credentials_copy(DBusCredentials *credentials)
Copy a credentials object.
Definition: dbus-credentials.c:587
_dbus_credentials_ref
DBUS_PRIVATE_EXPORT void _dbus_credentials_ref(DBusCredentials *credentials)
Increment refcount on credentials.
Definition: dbus-credentials.c:125
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
_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:316
_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:368
_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:495
_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:453
DBusString
Definition: dbus-string.h:43
_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:163
_dbus_credentials_clear
DBUS_PRIVATE_EXPORT void _dbus_credentials_clear(DBusCredentials *credentials)
Clear all credentials in the object.
Definition: dbus-credentials.c:563
_dbus_credentials_new_from_current_process
DBUS_PRIVATE_EXPORT DBusCredentials * _dbus_credentials_new_from_current_process(void)
Creates a new object with credentials (user ID and process ID) from the current process.
Definition: dbus-credentials.c:102
DBusCredentials
Definition: dbus-credentials.c:48
_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:303
dbus_pid_t
unsigned long dbus_pid_t
A process ID.
Definition: dbus-sysdeps.h:132
dbus_uid_t
unsigned long dbus_uid_t
A user ID.
Definition: dbus-sysdeps.h:134
_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:270
_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:437
_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:246
_dbus_credentials_get_linux_security_label
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:342
_dbus_credentials_unref
DBUS_PRIVATE_EXPORT void _dbus_credentials_unref(DBusCredentials *credentials)
Decrement refcount on credentials.
Definition: dbus-credentials.c:137
_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:222
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
_dbus_credentials_new
DBUS_PRIVATE_EXPORT DBusCredentials * _dbus_credentials_new(void)
Creates a new credentials object.
Definition: dbus-credentials.c:75
_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:382
_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:182