D-Bus 1.12.4

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_ADT_AUDIT_DATA_ID,
37 DBUS_CREDENTIAL_LINUX_SECURITY_LABEL,
38 DBUS_CREDENTIAL_WINDOWS_SID
39} DBusCredentialType;
40
41DBUS_PRIVATE_EXPORT
42 DBusCredentials* _dbus_credentials_new_from_current_process (void);
43DBUS_PRIVATE_EXPORT
44 DBusCredentials* _dbus_credentials_new (void);
45DBUS_PRIVATE_EXPORT
46 void _dbus_credentials_ref (DBusCredentials *credentials);
47DBUS_PRIVATE_EXPORT
48 void _dbus_credentials_unref (DBusCredentials *credentials);
49DBUS_PRIVATE_EXPORT
50 dbus_bool_t _dbus_credentials_add_pid (DBusCredentials *credentials,
51 dbus_pid_t pid);
52DBUS_PRIVATE_EXPORT
53 dbus_bool_t _dbus_credentials_add_unix_uid (DBusCredentials *credentials,
54 dbus_uid_t uid);
55DBUS_PRIVATE_EXPORT
56 dbus_bool_t _dbus_credentials_add_windows_sid (DBusCredentials *credentials,
57 const char *windows_sid);
58 dbus_bool_t _dbus_credentials_add_linux_security_label (DBusCredentials *credentials,
59 const char *label);
60 dbus_bool_t _dbus_credentials_add_adt_audit_data (DBusCredentials *credentials,
61 void *audit_data,
62 dbus_int32_t size);
63DBUS_PRIVATE_EXPORT
64 dbus_bool_t _dbus_credentials_include (DBusCredentials *credentials,
65 DBusCredentialType type);
66DBUS_PRIVATE_EXPORT
67 dbus_pid_t _dbus_credentials_get_pid (DBusCredentials *credentials);
68DBUS_PRIVATE_EXPORT
69 dbus_uid_t _dbus_credentials_get_unix_uid (DBusCredentials *credentials);
70DBUS_PRIVATE_EXPORT
71 const char* _dbus_credentials_get_windows_sid (DBusCredentials *credentials);
72 const char * _dbus_credentials_get_linux_security_label (DBusCredentials *credentials);
73 void * _dbus_credentials_get_adt_audit_data (DBusCredentials *credentials);
74 dbus_int32_t _dbus_credentials_get_adt_audit_data_size (DBusCredentials *credentials);
75DBUS_PRIVATE_EXPORT
76 dbus_bool_t _dbus_credentials_are_superset (DBusCredentials *credentials,
77 DBusCredentials *possible_subset);
78DBUS_PRIVATE_EXPORT
79 dbus_bool_t _dbus_credentials_are_empty (DBusCredentials *credentials);
80DBUS_PRIVATE_EXPORT
81 dbus_bool_t _dbus_credentials_are_anonymous (DBusCredentials *credentials);
82 dbus_bool_t _dbus_credentials_add_credentials (DBusCredentials *credentials,
83 DBusCredentials *other_credentials);
84/* must silently allow 'which' to not exist */
85 dbus_bool_t _dbus_credentials_add_credential (DBusCredentials *credentials,
86 DBusCredentialType which,
87 DBusCredentials *other_credentials);
88DBUS_PRIVATE_EXPORT
89 void _dbus_credentials_clear (DBusCredentials *credentials);
90DBUS_PRIVATE_EXPORT
91 DBusCredentials* _dbus_credentials_copy (DBusCredentials *credentials);
92DBUS_PRIVATE_EXPORT
93 dbus_bool_t _dbus_credentials_same_user (DBusCredentials *credentials,
94 DBusCredentials *other_credentials);
95DBUS_PRIVATE_EXPORT
96 dbus_bool_t _dbus_credentials_to_string_append (DBusCredentials *credentials,
97 DBusString *string);
98
99 DBUS_END_DECLS
100
101#endif /* DBUS_CREDENTIALS_H */
_dbus_credentials_ref
DBUS_PRIVATE_EXPORT void _dbus_credentials_ref(DBusCredentials *credentials)
Increment refcount on credentials.
Definition: dbus-credentials.c:118
_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:255
_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:363
_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:552
_dbus_credentials_clear
DBUS_PRIVATE_EXPORT void _dbus_credentials_clear(DBusCredentials *credentials)
Clear all credentials in the object.
Definition: dbus-credentials.c:503
_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:297
_dbus_credentials_copy
DBUS_PRIVATE_EXPORT DBusCredentials * _dbus_credentials_copy(DBusCredentials *credentials)
Copy a credentials object.
Definition: dbus-credentials.c:523
_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:95
_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:573
_dbus_credentials_new
DBUS_PRIVATE_EXPORT DBusCredentials * _dbus_credentials_new(void)
Creates a new credentials object.
Definition: dbus-credentials.c:71
_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:336
_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:207
_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:424
_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:323
_dbus_credentials_unref
DBUS_PRIVATE_EXPORT void _dbus_credentials_unref(DBusCredentials *credentials)
Decrement refcount on credentials.
Definition: dbus-credentials.c:130
_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:391
_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:167
_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:183
_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:152
_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:284
_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:231
_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:349
_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:310
_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:458
_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:408
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:108
dbus_pid_t
unsigned long dbus_pid_t
A process ID.
Definition: dbus-sysdeps.h:106
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
dbus_int32_t
int dbus_int32_t
A 32-bit signed integer on all platforms.
Definition: dbus-arch-deps.h:42
DBusCredentials
Definition: dbus-credentials.c:48
DBusString
Definition: dbus-string.h:43