2007-06-09 Havoc Pennington <hp@redhat.com>
[platform/upstream/dbus.git] / dbus / dbus-credentials.h
1 /* -*- mode: C; c-file-style: "gnu" -*- */
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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_WINDOWS_SID
37 } DBusCredentialType;
38
39 DBusCredentials* _dbus_credentials_new_from_current_process (void);
40 DBusCredentials* _dbus_credentials_new                      (void);
41 void             _dbus_credentials_ref                      (DBusCredentials    *credentials);
42 void             _dbus_credentials_unref                    (DBusCredentials    *credentials);
43 dbus_bool_t      _dbus_credentials_add_unix_pid             (DBusCredentials    *credentials,
44                                                              dbus_pid_t          pid);
45 dbus_bool_t      _dbus_credentials_add_unix_uid             (DBusCredentials    *credentials,
46                                                              dbus_uid_t          uid);
47 dbus_bool_t      _dbus_credentials_add_windows_sid          (DBusCredentials    *credentials,
48                                                              const char         *windows_sid);
49 dbus_bool_t      _dbus_credentials_include                  (DBusCredentials    *credentials,
50                                                              DBusCredentialType  type);
51 dbus_pid_t       _dbus_credentials_get_unix_pid             (DBusCredentials    *credentials);
52 dbus_uid_t       _dbus_credentials_get_unix_uid             (DBusCredentials    *credentials);
53 const char*      _dbus_credentials_get_windows_sid          (DBusCredentials    *credentials);
54 dbus_bool_t      _dbus_credentials_are_superset             (DBusCredentials    *credentials,
55                                                              DBusCredentials    *possible_subset);
56 dbus_bool_t      _dbus_credentials_are_empty                (DBusCredentials    *credentials);
57 dbus_bool_t      _dbus_credentials_add_credentials          (DBusCredentials    *credentials,
58                                                              DBusCredentials    *other_credentials);
59 /* must silently allow 'which' to not exist */
60 dbus_bool_t      _dbus_credentials_add_credential           (DBusCredentials    *credentials,
61                                                              DBusCredentialType  which,
62                                                              DBusCredentials    *other_credentials);
63 void             _dbus_credentials_clear                    (DBusCredentials    *credentials);
64 DBusCredentials* _dbus_credentials_copy                     (DBusCredentials    *credentials);
65 dbus_bool_t      _dbus_credentials_same_user                (DBusCredentials    *credentials,
66                                                              DBusCredentials    *other_credentials);
67
68
69 DBUS_END_DECLS
70
71 #endif /* DBUS_CREDENTIALS_H */