dbus/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
  41 DBUS_PRIVATE_EXPORT
  42 DBusCredentials* _dbus_credentials_new_from_current_process (void);
  43 DBUS_PRIVATE_EXPORT
  44 DBusCredentials* _dbus_credentials_new                      (void);
  45 DBUS_PRIVATE_EXPORT
  46 void             _dbus_credentials_ref                      (DBusCredentials    *credentials);
  47 DBUS_PRIVATE_EXPORT
  48 void             _dbus_credentials_unref                    (DBusCredentials    *credentials);
  49 DBUS_PRIVATE_EXPORT
  50 dbus_bool_t      _dbus_credentials_add_pid                  (DBusCredentials    *credentials,
  51                                                              dbus_pid_t          pid);
  52 DBUS_PRIVATE_EXPORT
  53 dbus_bool_t      _dbus_credentials_add_unix_uid             (DBusCredentials    *credentials,
  54                                                              dbus_uid_t          uid);
  55 DBUS_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);
  63 DBUS_PRIVATE_EXPORT
  64 dbus_bool_t      _dbus_credentials_include                  (DBusCredentials    *credentials,
  65                                                              DBusCredentialType  type);
  66 DBUS_PRIVATE_EXPORT
  67 dbus_pid_t       _dbus_credentials_get_pid                  (DBusCredentials    *credentials);
  68 DBUS_PRIVATE_EXPORT
  69 dbus_uid_t       _dbus_credentials_get_unix_uid             (DBusCredentials    *credentials);
  70 DBUS_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);
  75 DBUS_PRIVATE_EXPORT
  76 dbus_bool_t      _dbus_credentials_are_superset             (DBusCredentials    *credentials,
  77                                                              DBusCredentials    *possible_subset);
  78 DBUS_PRIVATE_EXPORT
  79 dbus_bool_t      _dbus_credentials_are_empty                (DBusCredentials    *credentials);
  80 DBUS_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);
  88 DBUS_PRIVATE_EXPORT
  89 void             _dbus_credentials_clear                    (DBusCredentials    *credentials);
  90 DBUS_PRIVATE_EXPORT
  91 DBusCredentials* _dbus_credentials_copy                     (DBusCredentials    *credentials);
  92 DBUS_PRIVATE_EXPORT
  93 dbus_bool_t      _dbus_credentials_same_user                (DBusCredentials    *credentials,
  94                                                              DBusCredentials    *other_credentials);
  95 DBUS_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 */