bus/bus.h

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2 /* bus.h  message bus context object
   3  *
   4  * Copyright (C) 2003 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
  24 #ifndef BUS_BUS_H
  25 #define BUS_BUS_H
  26
  27 #include <dbus/dbus.h>
  28 #include <dbus/dbus-string.h>
  29 #include <dbus/dbus-mainloop.h>
  30 #include <dbus/dbus-pipe.h>
  31 #include <dbus/dbus-sysdeps.h>
  32
  33 typedef struct BusActivation    BusActivation;
  34 typedef struct BusConnections   BusConnections;
  35 typedef struct BusContext       BusContext;
  36 typedef struct BusPolicy        BusPolicy;
  37 typedef struct BusClientPolicy  BusClientPolicy;
  38 typedef struct BusPolicyRule    BusPolicyRule;
  39 typedef struct BusRegistry      BusRegistry;
  40 typedef struct BusSELinuxID     BusSELinuxID;
  41 typedef struct BusAppArmorConfinement BusAppArmorConfinement;
  42 typedef struct BusService       BusService;
  43 typedef struct BusOwner         BusOwner;
  44 typedef struct BusTransaction   BusTransaction;
  45 typedef struct BusMatchmaker    BusMatchmaker;
  46 typedef struct BusMatchRule     BusMatchRule;
  47 typedef struct BusActivationEntry BusActivationEntry;
  48 typedef struct BusCheck           BusCheck;
  49 typedef struct BusDeferredMessage BusDeferredMessage;
  50 typedef struct BusCynara          BusCynara;
  51
  52 /**
  53  * This uses BUS_RESULT_TRUE = 0 != TRUE intentionally, to trigger
  54  * runtime failures where code uses a simple boolean check or
  55  * comparison with TRUE/FALSE or returns TRUE/FALSE when it should use
  56  * one of these enums. Such broken code unfortunately does not trigger
  57  * compile time errors in C.
  58  */
  59 typedef enum {
  60   /** operation allowed or succeeded */
  61   BUS_RESULT_TRUE,
  62   /** operation denied or failed */
  63   BUS_RESULT_FALSE,
  64   /** no result yet, ask again later */
  65   BUS_RESULT_LATER
  66 } BusResult;
  67
  68 typedef struct
  69 {
  70   long max_incoming_bytes;          /**< How many incoming message bytes for a single connection */
  71   long max_incoming_unix_fds;       /**< How many incoming message unix fds for a single connection */
  72   long max_outgoing_bytes;          /**< How many outgoing bytes can be queued for a single connection */
  73   long max_outgoing_unix_fds;       /**< How many outgoing unix fds can be queued for a single connection */
  74   long max_message_size;            /**< Max size of a single message in bytes */
  75   long max_message_unix_fds;        /**< Max number of unix fds of a single message*/
  76   int activation_timeout;           /**< How long to wait for an activation to time out */
  77   int auth_timeout;                 /**< How long to wait for an authentication to time out */
  78   int pending_fd_timeout;           /**< How long to wait for a D-Bus message with a fd to time out */
  79   int max_completed_connections;    /**< Max number of authorized connections */
  80   int max_incomplete_connections;   /**< Max number of incomplete connections */
  81   int max_connections_per_user;     /**< Max number of connections auth'd as same user */
  82   int max_pending_activations;      /**< Max number of pending activations for the entire bus */
  83   int max_services_per_connection;  /**< Max number of owned services for a single connection */
  84   int max_match_rules_per_connection; /**< Max number of match rules for a single connection */
  85   int max_replies_per_connection;     /**< Max number of replies that can be pending for each connection */
  86   int reply_timeout;                  /**< How long to wait before timing out a reply */
  87 } BusLimits;
  88
  89 typedef enum
  90 {
  91   BUS_CONTEXT_FLAG_NONE = 0,
  92   BUS_CONTEXT_FLAG_FORK_ALWAYS = (1 << 1),
  93   BUS_CONTEXT_FLAG_FORK_NEVER = (1 << 2),
  94   BUS_CONTEXT_FLAG_WRITE_PID_FILE = (1 << 3),
  95   BUS_CONTEXT_FLAG_SYSTEMD_ACTIVATION = (1 << 4),
  96   BUS_CONTEXT_FLAG_SYSLOG_ALWAYS = (1 << 5),
  97   BUS_CONTEXT_FLAG_SYSLOG_NEVER = (1 << 6),
  98   BUS_CONTEXT_FLAG_SYSLOG_ONLY = (1 << 7)
  99 } BusContextFlags;
 100
 101 BusContext*       bus_context_new                                (const DBusString *config_file,
 102                                                                   BusContextFlags   flags,
 103                                                                   DBusPipe         *print_addr_pipe,
 104                                                                   DBusPipe         *print_pid_pipe,
 105                                                                   const DBusString *address,
 106                                                                   DBusError        *error);
 107 dbus_bool_t       bus_context_reload_config                      (BusContext       *context,
 108                                                                   DBusError        *error);
 109 void              bus_context_shutdown                           (BusContext       *context);
 110 BusContext*       bus_context_ref                                (BusContext       *context);
 111 void              bus_context_unref                              (BusContext       *context);
 112 dbus_bool_t       bus_context_get_id                             (BusContext       *context,
 113                                                                   DBusString       *uuid);
 114 const char*       bus_context_get_type                           (BusContext       *context);
 115 const char*       bus_context_get_address                        (BusContext       *context);
 116 const char*       bus_context_get_servicehelper                  (BusContext       *context);
 117 dbus_bool_t       bus_context_get_systemd_activation             (BusContext       *context);
 118 BusRegistry*      bus_context_get_registry                       (BusContext       *context);
 119 BusConnections*   bus_context_get_connections                    (BusContext       *context);
 120 BusActivation*    bus_context_get_activation                     (BusContext       *context);
 121 BusMatchmaker*    bus_context_get_matchmaker                     (BusContext       *context);
 122 DBusLoop*         bus_context_get_loop                           (BusContext       *context);
 123 BusCheck *        bus_context_get_check                          (BusContext       *context);
 124 dbus_bool_t       bus_context_allow_unix_user                    (BusContext       *context,
 125                                                                   unsigned long     uid);
 126 dbus_bool_t       bus_context_allow_windows_user                 (BusContext       *context,
 127                                                                   const char       *windows_sid);
 128 BusPolicy*        bus_context_get_policy                         (BusContext       *context);
 129
 130 BusClientPolicy*  bus_context_create_client_policy               (BusContext       *context,
 131                                                                   DBusConnection   *connection,
 132                                                                   DBusError        *error);
 133 int               bus_context_get_activation_timeout             (BusContext       *context);
 134 int               bus_context_get_auth_timeout                   (BusContext       *context);
 135 int               bus_context_get_pending_fd_timeout             (BusContext       *context);
 136 int               bus_context_get_max_completed_connections      (BusContext       *context);
 137 int               bus_context_get_max_incomplete_connections     (BusContext       *context);
 138 int               bus_context_get_max_connections_per_user       (BusContext       *context);
 139 int               bus_context_get_max_pending_activations        (BusContext       *context);
 140 int               bus_context_get_max_services_per_connection    (BusContext       *context);
 141 int               bus_context_get_max_match_rules_per_connection (BusContext       *context);
 142 int               bus_context_get_max_replies_per_connection     (BusContext       *context);
 143 int               bus_context_get_reply_timeout                  (BusContext       *context);
 144 DBusRLimit *      bus_context_get_initial_fd_limit               (BusContext       *context);
 145 dbus_bool_t       bus_context_get_using_syslog                   (BusContext       *context);
 146 void              bus_context_log                                (BusContext       *context,
 147                                                                   DBusSystemLogSeverity severity,
 148                                                                   const char       *msg,
 149                                                                   ...) _DBUS_GNUC_PRINTF (3, 4);
 150 void              bus_context_log_literal                        (BusContext       *context,
 151                                                                   DBusSystemLogSeverity severity,
 152                                                                   const char       *msg);
 153 void              bus_context_log_and_set_error                  (BusContext       *context,
 154                                                                   DBusSystemLogSeverity severity,
 155                                                                   DBusError        *error,
 156                                                                   const char       *name,
 157                                                                   const char       *msg,
 158                                                                   ...) _DBUS_GNUC_PRINTF (5, 6);
 159 BusResult         bus_context_check_security_policy              (BusContext          *context,
 160                                                                   BusTransaction      *transaction,
 161                                                                   DBusConnection      *sender,
 162                                                                   DBusConnection      *addressed_recipient,
 163                                                                   DBusConnection      *proposed_recipient,
 164                                                                   DBusMessage         *message,
 165                                                                   BusActivationEntry  *activation_entry,
 166                                                                   DBusError           *error,
 167                                                                   BusDeferredMessage **deferred_message);
 168 void              bus_context_check_all_watches                  (BusContext       *context);
 169
 170 dbus_bool_t       bus_context_check_recipient_message_limits     (BusContext *context,
 171                                                                   DBusConnection *recipient,
 172                                                                   DBusConnection *sender,
 173                                                                   DBusMessage *message,
 174                                                                   dbus_bool_t requested_reply,
 175                                                                   DBusError *error);
 176 void              bus_context_complain_about_message             (BusContext     *context,
 177                                                                   const char     *error_name,
 178                                                                   const char     *complaint,
 179                                                                   int             matched_rules,
 180                                                                   DBusMessage    *message,
 181                                                                   DBusConnection *sender,
 182                                                                   DBusConnection *proposed_recipient,
 183                                                                   dbus_bool_t     requested_reply,
 184                                                                   dbus_bool_t     log,
 185                                                                   const char     *privilege,
 186                                                                   DBusError      *error);
 187
 188
 189 #endif /* BUS_BUS_H */