struct PolKitContext

struct PolKitContext;

Context object for users of PolicyKit.

PolKitContextConfigChangedCB ()

void                (*PolKitContextConfigChangedCB)     (PolKitContext *pk_context,
                                                         void *user_data);

The type of the callback function for when configuration changes. Mechanisms should use this callback to e.g. reconfigure all permissions / acl's they have set in response to policy decisions made from information provided by PolicyKit.

Note that this function may be called many times within a short interval due to how file monitoring works if e.g. the user is editing a configuration file (editors typically create back-up files). Mechanisms should use a "cool-off" timer (of, say, one second) to avoid doing many expensive operations (such as reconfiguring all ACL's for all devices) within a very short timeframe.

enum PolKitContextFileMonitorEvent

typedef enum
{
        POLKIT_CONTEXT_FILE_MONITOR_EVENT_NONE    = 1 << 0,
        POLKIT_CONTEXT_FILE_MONITOR_EVENT_ACCESS  = 1 << 1,
        POLKIT_CONTEXT_FILE_MONITOR_EVENT_CREATE  = 1 << 2,
        POLKIT_CONTEXT_FILE_MONITOR_EVENT_DELETE  = 1 << 3,
        POLKIT_CONTEXT_FILE_MONITOR_EVENT_CHANGE  = 1 << 4,
} PolKitContextFileMonitorEvent;

File monitoring events.

PolKitContextFileMonitorNotifyFunc ()

void                (*PolKitContextFileMonitorNotifyFunc)
                                                        (PolKitContext *pk_context,
                                                         PolKitContextFileMonitorEvent event_mask,
                                                         const char *path,
                                                         void *user_data);

Callback when an event happens on a file that is monitored.

PolKitContextFileMonitorAddWatch ()

int                 (*PolKitContextFileMonitorAddWatch) (PolKitContext *pk_context,
                                                         const char *path,
                                                         PolKitContextFileMonitorEvent event_mask,
                                                         PolKitContextFileMonitorNotifyFunc notify_cb,
                                                         void *user_data);

The type of a function that PolicyKit can use to watch file events. This function must call the supplied notify_cb function (and pass path and user_data) on events

PolKitContextFileMonitorRemoveWatch ()

void                (*PolKitContextFileMonitorRemoveWatch)
                                                        (PolKitContext *pk_context,
                                                         int watch_id);

The type of a function that PolicyKit can use to stop monitoring file events. Pass the handle obtained from the supplied function of type PolKitContextFileMonitorAddWatch.

polkit_context_new ()

PolKitContext*      polkit_context_new                  (void);

Create a new context

polkit_context_set_config_changed ()

void                polkit_context_set_config_changed   (PolKitContext *pk_context,
                                                         PolKitContextConfigChangedCB cb,
                                                         void *user_data);

Register the callback function for when configuration changes. Mechanisms should use this callback to e.g. reconfigure all permissions / acl's they have set in response to policy decisions made from information provided by PolicyKit.

Note that this function may be called many times within a short interval due to how file monitoring works if e.g. the user is editing a configuration file (editors typically create back-up files). Mechanisms should use a "cool-off" timer (of, say, one second) to avoid doing many expensive operations (such as reconfiguring all ACL's for all devices) within a very short timeframe.

This method must be called before polkit_context_init().

polkit_context_set_file_monitor ()

void                polkit_context_set_file_monitor     (PolKitContext *pk_context,
                                                         PolKitContextFileMonitorAddWatch add_watch_func,
                                                         PolKitContextFileMonitorRemoveWatch remove_watch_func);

Register a functions that PolicyKit can use for watching files.

This method must be called before polkit_context_init().

polkit_context_set_load_descriptions ()

void                polkit_context_set_load_descriptions
                                                        (PolKitContext *pk_context);

Set whether policy descriptions should be loaded. By default these are not loaded to keep memory use down.

This method must be called before polkit_context_init().

polkit_context_init ()

polkit_bool_t       polkit_context_init                 (PolKitContext *pk_context,
                                                         PolKitError **error);

Initializes a new context; loads PolicyKit files from /etc/PolicyKit/policy unless the environment variable $POLKIT_POLICY_DIR points to a location.

polkit_context_ref ()

PolKitContext*      polkit_context_ref                  (PolKitContext *pk_context);

Increase reference count.

polkit_context_unref ()

void                polkit_context_unref                (PolKitContext *pk_context);

Decreases the reference count of the object. If it becomes zero, the object is freed. Before freeing, reference counts on embedded objects are decresed by one.

polkit_context_get_policy_cache ()

PolKitPolicyCache*  polkit_context_get_policy_cache     (PolKitContext *pk_context);

Get the PolKitPolicyCache object that holds all the defined policies as well as their defaults.

polkit_context_can_session_do_action ()

PolKitResult        polkit_context_can_session_do_action
                                                        (PolKitContext *pk_context,
                                                         PolKitAction *action,
                                                         PolKitSession *session);

Determine if a given session can do a given action.

polkit_context_can_caller_do_action ()

PolKitResult        polkit_context_can_caller_do_action (PolKitContext *pk_context,
                                                         PolKitAction *action,
                                                         PolKitCaller *caller);

Determine if a given caller can do a given action.