Core API Reference - Authorization Contraints

enum PolKitAuthorizationConstraintType

typedef enum {
        POLKIT_AUTHORIZATION_CONSTRAINT_TYPE_REQUIRE_LOCAL,
        POLKIT_AUTHORIZATION_CONSTRAINT_TYPE_REQUIRE_ACTIVE,
        POLKIT_AUTHORIZATION_CONSTRAINT_TYPE_REQUIRE_EXE,
        POLKIT_AUTHORIZATION_CONSTRAINT_TYPE_REQUIRE_SELINUX_CONTEXT,
} PolKitAuthorizationConstraintType;

This enumeration describes the type of the authorization constraint.

PolKitAuthorizationConstraint

typedef struct _PolKitAuthorizationConstraint PolKitAuthorizationConstraint;

Instances of this class are used to represent conditions that must be satisfied in order for an authorization to apply.

Since 0.7

polkit_authorization_constraint_get_require_local ()

PolKitAuthorizationConstraint* polkit_authorization_constraint_get_require_local
                                                        (void);

Get a PolKitAuthorizationConstraint object that represents the constraint that the session or caller must be local.

Since 0.7

polkit_authorization_constraint_get_require_active ()

PolKitAuthorizationConstraint* polkit_authorization_constraint_get_require_active
                                                        (void);

Get a PolKitAuthorizationConstraint object that represents the constraint that the session or caller must be active.

Since 0.7

polkit_authorization_constraint_get_require_exe ()

PolKitAuthorizationConstraint* polkit_authorization_constraint_get_require_exe
                                                        (const char *path);

Get a PolKitAuthorizationConstraint object that represents the constraint that the caller must be a specific program

Since 0.8

polkit_authorization_constraint_get_require_selinux_context ()

PolKitAuthorizationConstraint* polkit_authorization_constraint_get_require_selinux_context
                                                        (const char *context);

Get a PolKitAuthorizationConstraint object that represents the constraint that the caller must be in a specific SELinux context.

Since 0.8

polkit_authorization_constraint_ref ()

PolKitAuthorizationConstraint* polkit_authorization_constraint_ref
                                                        (PolKitAuthorizationConstraint *authc);

Increase reference count.

Since 0.7

polkit_authorization_constraint_unref ()

void                polkit_authorization_constraint_unref
                                                        (PolKitAuthorizationConstraint *authc);

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.

Since 0.7

polkit_authorization_constraint_debug ()

void                polkit_authorization_constraint_debug
                                                        (PolKitAuthorizationConstraint *authc);

Print debug details

Since 0.7

polkit_authorization_constraint_validate ()

polkit_bool_t       polkit_authorization_constraint_validate
                                                        (PolKitAuthorizationConstraint *authc);

Validate the object

Since 0.7

polkit_authorization_constraint_type ()

PolKitAuthorizationConstraintType polkit_authorization_constraint_type
                                                        (PolKitAuthorizationConstraint *authc);

Describe the constraint; this is only useful when inspecting an authorization to present information to the user (e.g. as polkit-auth(1) does).

Since 0.7

polkit_authorization_constraint_get_exe ()

const char*         polkit_authorization_constraint_get_exe
                                                        (PolKitAuthorizationConstraint *authc);

Get the exe path for the constraint.

Since 0.8

polkit_authorization_constraint_get_selinux_context ()

const char*         polkit_authorization_constraint_get_selinux_context
                                                        (PolKitAuthorizationConstraint *authc);

Get the SELinux context for the constraint.

Since 0.8

polkit_authorization_constraint_check_session ()

polkit_bool_t       polkit_authorization_constraint_check_session
                                                        (PolKitAuthorizationConstraint *authc,
                                                         PolKitSession *session);

Determine if the given session satisfies the conditions imposed by the given constraint.

Since 0.7

polkit_authorization_constraint_check_caller ()

polkit_bool_t       polkit_authorization_constraint_check_caller
                                                        (PolKitAuthorizationConstraint *authc,
                                                         PolKitCaller *caller);

Determine if the given caller satisfies the conditions imposed by the given constraint

Since 0.7

polkit_authorization_constraint_to_string ()

size_t              polkit_authorization_constraint_to_string
                                                        (PolKitAuthorizationConstraint *authc,
                                                         char *out_buf,
                                                         size_t buf_size);

Get a textual representation of the constraint; this is only useful for serializing; it's a machine, not human, readable string.

Since 0.7

polkit_authorization_constraint_from_string ()

PolKitAuthorizationConstraint* polkit_authorization_constraint_from_string
                                                        (const char *str);

Construct a constraint from a textual representation as returned by polkit_authorization_constraint_to_string().

polkit_authorization_constraint_get_from_caller ()

int                 polkit_authorization_constraint_get_from_caller
                                                        (PolKitCaller *caller,
                                                         PolKitAuthorizationConstraint **out_array,
                                                         size_t array_size);

Given a caller, return the set of most restrictive constraints possible. For example, if the caller is local and active, a set constraints requiring this will be returned.

This function is typically used when the caller obtains an authorization through authentication; the goal is to put constraints on the authorization such that it's only valid when the caller is in the context as where she obtained it.

The caller must unref all the created objects using polkit_authorization_constraint_unref().

Since 0.7

polkit_authorization_constraint_equal ()

polkit_bool_t       polkit_authorization_constraint_equal
                                                        (PolKitAuthorizationConstraint *a,
                                                         PolKitAuthorizationConstraint *b);

Determines if two constraints are equal

Since 0.7