D-Bus 1.15.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 * SPDX-License-Identifier: AFL-2.1 OR GPL-2.0-or-later
7 *
8 * Licensed under the Academic Free License version 2.1
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 *
24 */
25#ifndef DBUS_CREDENTIALS_H
26#define DBUS_CREDENTIALS_H
27
28#include <dbus/dbus-macros.h>
29#include <dbus/dbus-errors.h>
30#include <dbus/dbus-string.h>
31#include <dbus/dbus-sysdeps.h>
32
34
35typedef enum {
36 DBUS_CREDENTIAL_UNIX_PROCESS_ID,
37 DBUS_CREDENTIAL_UNIX_USER_ID,
38 DBUS_CREDENTIAL_UNIX_GROUP_IDS,
39 DBUS_CREDENTIAL_ADT_AUDIT_DATA_ID,
40 DBUS_CREDENTIAL_LINUX_SECURITY_LABEL,
41 DBUS_CREDENTIAL_WINDOWS_SID
42} DBusCredentialType;
43
44DBUS_PRIVATE_EXPORT
46DBUS_PRIVATE_EXPORT
48DBUS_PRIVATE_EXPORT
49void _dbus_credentials_ref (DBusCredentials *credentials);
50DBUS_PRIVATE_EXPORT
52DBUS_PRIVATE_EXPORT
54 dbus_pid_t pid);
55DBUS_PRIVATE_EXPORT
57 dbus_uid_t uid);
58DBUS_PRIVATE_EXPORT
60 dbus_gid_t *gids,
61 size_t n_gids);
62DBUS_PRIVATE_EXPORT
64 const char *windows_sid);
66 const char *label);
68 void *audit_data,
69 dbus_int32_t size);
70DBUS_PRIVATE_EXPORT
72 DBusCredentialType type);
73DBUS_PRIVATE_EXPORT
75DBUS_PRIVATE_EXPORT
77DBUS_PRIVATE_EXPORT
79 const dbus_gid_t **gids,
80 size_t *n_gids);
81DBUS_PRIVATE_EXPORT
82const char* _dbus_credentials_get_windows_sid (DBusCredentials *credentials);
83DBUS_PRIVATE_EXPORT
87DBUS_PRIVATE_EXPORT
89 DBusCredentials *possible_subset);
90DBUS_PRIVATE_EXPORT
92DBUS_PRIVATE_EXPORT
95 DBusCredentials *other_credentials);
96/* must silently allow 'which' to not exist */
98 DBusCredentialType which,
99 DBusCredentials *other_credentials);
100DBUS_PRIVATE_EXPORT
101void _dbus_credentials_clear (DBusCredentials *credentials);
102DBUS_PRIVATE_EXPORT
104DBUS_PRIVATE_EXPORT
106 DBusCredentials *other_credentials);
107DBUS_PRIVATE_EXPORT
109 DBusString *string);
110
111static inline void
112_dbus_clear_credentials (DBusCredentials **pointer_to_creds)
113{
114 _dbus_clear_pointer_impl (DBusCredentials, pointer_to_creds,
116}
117
119
120#endif /* DBUS_CREDENTIALS_H */
DBUS_PRIVATE_EXPORT void _dbus_credentials_ref(DBusCredentials *credentials)
Increment refcount on credentials.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_credentials_include(DBusCredentials *credentials, DBusCredentialType type)
Checks whether the given credential is present.
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...
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.
DBUS_PRIVATE_EXPORT void _dbus_credentials_clear(DBusCredentials *credentials)
Clear all credentials in the object.
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...
DBUS_PRIVATE_EXPORT DBusCredentials * _dbus_credentials_copy(DBusCredentials *credentials)
Copy a credentials object.
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...
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...
DBUS_PRIVATE_EXPORT DBusCredentials * _dbus_credentials_new(void)
Creates a new credentials object.
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...
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.
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 ...
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...
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.
DBUS_PRIVATE_EXPORT void _dbus_credentials_unref(DBusCredentials *credentials)
Decrement refcount on credentials.
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.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_credentials_are_empty(DBusCredentials *credentials)
Checks whether a credentials object contains anything.
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.
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.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_credentials_add_pid(DBusCredentials *credentials, dbus_pid_t pid)
Add a UNIX process ID to the credentials.
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...
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.
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...
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...
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...
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_credentials_are_anonymous(DBusCredentials *credentials)
Checks whether a credentials object contains a user identity.
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.
unsigned long dbus_uid_t
A user ID.
Definition: dbus-sysdeps.h:137
unsigned long dbus_pid_t
A process ID.
Definition: dbus-sysdeps.h:135
unsigned long dbus_gid_t
A group ID.
Definition: dbus-sysdeps.h:139
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:37
int dbus_int32_t
A 32-bit signed integer on all platforms.