PRIV_POLICY(9F) Kernel Functions for Drivers PRIV_POLICY(9F)

NAME

priv_policy, priv_policy_only, priv_policy_choice - check, report, and
audit privileges

SYNOPSIS

#include <sys/policy.h>

int priv_policy(const cred_t *cr, int priv, int err,
boolean_t flag, const char *msg);


boolean_t priv_policy_only(const cred_t *cr, int priv,
boolean_t flag);


boolean_t priv_policy_choice(const cred_t *cr, int priv,
boolean_t flag);

INTERFACE LEVEL

illumos DDI specific (illumos DDI).

PARAMETERS

cr
The credential to be checked.


priv
The integer value of the privilege to test.


flag
All zone privileges flag. Set to B_FALSE for most tests or B_TRUE
if the operation requires the caller to have all available
privileges in the zone.


err
The error code to return.


msg
String that is added to the privilege debugging message if one is
generated. NULL if no additional information is needed. Because
the function name is included in the output, NULL is usually the
best value to pass as a parameter.

DESCRIPTION

These functions aid in privilege checking and privilege debugging.


The priv_policy(), priv_policy_only(), and priv_policy_choice() functions
all check whether priv is asserted in the effective set of the
credential. The special value PRIV_ALL tests for all privileges.


The priv_policy() function updates the ASU accounting flag and records
the privilege used on success in the audit trail if the required
privilege was not a basic privilege.


The priv_policy_only() function checks whether a privilege is asserted
and has no side effects.


The priv_policy_choice() function behaves like priv_policy_only() but
records the successfully used non-basic privileges in the audit trail.

RETURN VALUES

On success, priv_policy() return 0. On failure it returns its parameter
err.


On success, priv_policy_choice() and priv_policy_only() return 1, on
failure both return 0.

ERRORS

EINVAL
This might be caused by any of the following:

o The flags parameter is invalid.

o The specified privilege does not exist.

o The priv parameter contains invalid
characters.


ENOMEM
There is no room to allocate another privilege.


ENAMETOOLONG
An attempt was made to allocate a privilege that was
longer than {PRIVNAME_MAX} characters.

CONTEXT

This functions can be called from user, interrupt, or kernel context.

ATTRIBUTES

See attributes(7) for a description of the following attributes:


+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Committed |
+--------------------+-----------------+

SEE ALSO

acct(3HEAD), attributes(7), privileges(7)


Writing Device Drivers

April 3, 2009 PRIV_POLICY(9F)