src/include/utils/acl.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * acl.h
   4  *        Definition of (and support for) access control list data structures.
   5  *
   6  *
   7  * Portions Copyright (c) 1996-2008, PostgreSQL Global Development Group
   8  * Portions Copyright (c) 1994, Regents of the University of California
   9  *
  10  * $PostgreSQL$
  11  *
  12  * NOTES
  13  *        An ACL array is simply an array of AclItems, representing the union
  14  *        of the privileges represented by the individual items.  A zero-length
  15  *        array represents "no privileges".  There are no assumptions about the
  16  *        ordering of the items, but we do expect that there are no two entries
  17  *        in the array with the same grantor and grantee.
  18  *
  19  *        For backward-compatibility purposes we have to allow null ACL entries
  20  *        in system catalogs.  A null ACL will be treated as meaning "default
  21  *        protection" (i.e., whatever acldefault() returns).
  22  *-------------------------------------------------------------------------
  23  */
  24 #ifndef ACL_H
  25 #define ACL_H
  26
  27 #include "nodes/parsenodes.h"
  28 #include "utils/array.h"
  29
  30
  31 /*
  32  * typedef AclMode is declared in parsenodes.h, also the individual privilege
  33  * bit meanings are defined there
  34  */
  35
  36 #define ACL_ID_PUBLIC   0               /* placeholder for id in a PUBLIC acl item */
  37
  38 /*
  39  * AclItem
  40  *
  41  * Note: must be same size on all platforms, because the size is hardcoded
  42  * in the pg_type.h entry for aclitem.
  43  */
  44 typedef struct AclItem
  45 {
  46         Oid                     ai_grantee;             /* ID that this item grants privs to */
  47         Oid                     ai_grantor;             /* grantor of privs */
  48         AclMode         ai_privs;               /* privilege bits */
  49 } AclItem;
  50
  51 /*
  52  * The upper 16 bits of the ai_privs field of an AclItem are the grant option
  53  * bits, and the lower 16 bits are the actual privileges.  We use "rights"
  54  * to mean the combined grant option and privilege bits fields.
  55  */
  56 #define ACLITEM_GET_PRIVS(item)    ((item).ai_privs & 0xFFFF)
  57 #define ACLITEM_GET_GOPTIONS(item) (((item).ai_privs >> 16) & 0xFFFF)
  58 #define ACLITEM_GET_RIGHTS(item)   ((item).ai_privs)
  59
  60 #define ACL_GRANT_OPTION_FOR(privs) (((AclMode) (privs) & 0xFFFF) << 16)
  61 #define ACL_OPTION_TO_PRIVS(privs)      (((AclMode) (privs) >> 16) & 0xFFFF)
  62
  63 #define ACLITEM_SET_PRIVS(item,privs) \
  64   ((item).ai_privs = ((item).ai_privs & ~((AclMode) 0xFFFF)) | \
  65                                          ((AclMode) (privs) & 0xFFFF))
  66 #define ACLITEM_SET_GOPTIONS(item,goptions) \
  67   ((item).ai_privs = ((item).ai_privs & ~(((AclMode) 0xFFFF) << 16)) | \
  68                                          (((AclMode) (goptions) & 0xFFFF) << 16))
  69 #define ACLITEM_SET_RIGHTS(item,rights) \
  70   ((item).ai_privs = (AclMode) (rights))
  71
  72 #define ACLITEM_SET_PRIVS_GOPTIONS(item,privs,goptions) \
  73   ((item).ai_privs = ((AclMode) (privs) & 0xFFFF) | \
  74                                          (((AclMode) (goptions) & 0xFFFF) << 16))
  75
  76
  77 #define ACLITEM_ALL_PRIV_BITS           ((AclMode) 0xFFFF)
  78 #define ACLITEM_ALL_GOPTION_BITS        ((AclMode) 0xFFFF << 16)
  79
  80 /*
  81  * Definitions for convenient access to Acl (array of AclItem).
  82  * These are standard PostgreSQL arrays, but are restricted to have one
  83  * dimension and no nulls.      We also ignore the lower bound when reading,
  84  * and set it to one when writing.
  85  *
  86  * CAUTION: as of PostgreSQL 7.1, these arrays are toastable (just like all
  87  * other array types).  Therefore, be careful to detoast them with the
  88  * macros provided, unless you know for certain that a particular array
  89  * can't have been toasted.
  90  */
  91
  92
  93 /*
  94  * Acl                  a one-dimensional array of AclItem
  95  */
  96 typedef ArrayType Acl;
  97
  98 #define ACL_NUM(ACL)                    (ARR_DIMS(ACL)[0])
  99 #define ACL_DAT(ACL)                    ((AclItem *) ARR_DATA_PTR(ACL))
 100 #define ACL_N_SIZE(N)                   (ARR_OVERHEAD_NONULLS(1) + ((N) * sizeof(AclItem)))
 101 #define ACL_SIZE(ACL)                   ARR_SIZE(ACL)
 102
 103 /*
 104  * fmgr macros for these types
 105  */
 106 #define DatumGetAclItemP(X)                ((AclItem *) DatumGetPointer(X))
 107 #define PG_GETARG_ACLITEM_P(n)     DatumGetAclItemP(PG_GETARG_DATUM(n))
 108 #define PG_RETURN_ACLITEM_P(x)     PG_RETURN_POINTER(x)
 109
 110 #define DatumGetAclP(X)                    ((Acl *) PG_DETOAST_DATUM(X))
 111 #define DatumGetAclPCopy(X)                ((Acl *) PG_DETOAST_DATUM_COPY(X))
 112 #define PG_GETARG_ACL_P(n)                 DatumGetAclP(PG_GETARG_DATUM(n))
 113 #define PG_GETARG_ACL_P_COPY(n)    DatumGetAclPCopy(PG_GETARG_DATUM(n))
 114 #define PG_RETURN_ACL_P(x)                 PG_RETURN_POINTER(x)
 115
 116 /*
 117  * ACL modification opcodes for aclupdate
 118  */
 119 #define ACL_MODECHG_ADD                 1
 120 #define ACL_MODECHG_DEL                 2
 121 #define ACL_MODECHG_EQL                 3
 122
 123 /*
 124  * External representations of the privilege bits --- aclitemin/aclitemout
 125  * represent each possible privilege bit with a distinct 1-character code
 126  */
 127 #define ACL_INSERT_CHR                  'a'             /* formerly known as "append" */
 128 #define ACL_SELECT_CHR                  'r'             /* formerly known as "read" */
 129 #define ACL_UPDATE_CHR                  'w'             /* formerly known as "write" */
 130 #define ACL_DELETE_CHR                  'd'
 131 #define ACL_TRUNCATE_CHR                'D'             /* super-delete, as it were */
 132 #define ACL_REFERENCES_CHR              'x'
 133 #define ACL_TRIGGER_CHR                 't'
 134 #define ACL_EXECUTE_CHR                 'X'
 135 #define ACL_USAGE_CHR                   'U'
 136 #define ACL_CREATE_CHR                  'C'
 137 #define ACL_CREATE_TEMP_CHR             'T'
 138 #define ACL_CONNECT_CHR                 'c'
 139
 140 /* string holding all privilege code chars, in order by bitmask position */
 141 #define ACL_ALL_RIGHTS_STR      "arwdDxtXUCTc"
 142
 143 /*
 144  * Bitmasks defining "all rights" for each supported object type
 145  */
 146 #define ACL_ALL_RIGHTS_RELATION         (ACL_INSERT|ACL_SELECT|ACL_UPDATE|ACL_DELETE|ACL_TRUNCATE|ACL_REFERENCES|ACL_TRIGGER)
 147 #define ACL_ALL_RIGHTS_SEQUENCE         (ACL_USAGE|ACL_SELECT|ACL_UPDATE)
 148 #define ACL_ALL_RIGHTS_DATABASE         (ACL_CREATE|ACL_CREATE_TEMP|ACL_CONNECT)
 149 #define ACL_ALL_RIGHTS_FUNCTION         (ACL_EXECUTE)
 150 #define ACL_ALL_RIGHTS_LANGUAGE         (ACL_USAGE)
 151 #define ACL_ALL_RIGHTS_NAMESPACE        (ACL_USAGE|ACL_CREATE)
 152 #define ACL_ALL_RIGHTS_TABLESPACE       (ACL_CREATE)
 153
 154 /* operation codes for pg_*_aclmask */
 155 typedef enum
 156 {
 157         ACLMASK_ALL,                            /* normal case: compute all bits */
 158         ACLMASK_ANY                                     /* return when result is known nonzero */
 159 } AclMaskHow;
 160
 161 /* result codes for pg_*_aclcheck */
 162 typedef enum
 163 {
 164         ACLCHECK_OK = 0,
 165         ACLCHECK_NO_PRIV,
 166         ACLCHECK_NOT_OWNER
 167 } AclResult;
 168
 169 /* this enum covers all object types that can have privilege errors */
 170 /* currently it's only used to tell aclcheck_error what to say */
 171 typedef enum AclObjectKind
 172 {
 173         ACL_KIND_CLASS,                         /* pg_class */
 174         ACL_KIND_SEQUENCE,                      /* pg_sequence */
 175         ACL_KIND_DATABASE,                      /* pg_database */
 176         ACL_KIND_PROC,                          /* pg_proc */
 177         ACL_KIND_OPER,                          /* pg_operator */
 178         ACL_KIND_TYPE,                          /* pg_type */
 179         ACL_KIND_LANGUAGE,                      /* pg_language */
 180         ACL_KIND_NAMESPACE,                     /* pg_namespace */
 181         ACL_KIND_OPCLASS,                       /* pg_opclass */
 182         ACL_KIND_OPFAMILY,                      /* pg_opfamily */
 183         ACL_KIND_CONVERSION,            /* pg_conversion */
 184         ACL_KIND_TABLESPACE,            /* pg_tablespace */
 185         ACL_KIND_TSDICTIONARY,          /* pg_ts_dict */
 186         ACL_KIND_TSCONFIGURATION,       /* pg_ts_config */
 187         MAX_ACL_KIND                            /* MUST BE LAST */
 188 } AclObjectKind;
 189
 190 /*
 191  * The information about one Grant/Revoke statement, in internal format: object
 192  * and grantees names have been turned into Oids, the privilege list is an
 193  * AclMode bitmask.  If 'privileges' is ACL_NO_RIGHTS (the 0 value) and
 194  * all_privs is true, it will be internally turned into the right kind of
 195  * ACL_ALL_RIGHTS_*, depending on the object type (NB - this will modify the
 196  * InternalGrant struct!)
 197  */
 198 typedef struct
 199 {
 200         bool            is_grant;
 201         GrantObjectType objtype;
 202         List       *objects;
 203         bool            all_privs;
 204         AclMode         privileges;
 205         List       *grantees;
 206         bool            grant_option;
 207         DropBehavior behavior;
 208 } InternalGrant;
 209
 210 /*
 211  * routines used internally
 212  */
 213 extern Acl *acldefault(GrantObjectType objtype, Oid ownerId);
 214 extern Acl *aclupdate(const Acl *old_acl, const AclItem *mod_aip,
 215                   int modechg, Oid ownerId, DropBehavior behavior);
 216 extern Acl *aclnewowner(const Acl *old_acl, Oid oldOwnerId, Oid newOwnerId);
 217
 218 extern AclMode aclmask(const Acl *acl, Oid roleid, Oid ownerId,
 219                 AclMode mask, AclMaskHow how);
 220 extern int      aclmembers(const Acl *acl, Oid **roleids);
 221
 222 extern bool has_privs_of_role(Oid member, Oid role);
 223 extern bool is_member_of_role(Oid member, Oid role);
 224 extern bool is_member_of_role_nosuper(Oid member, Oid role);
 225 extern bool is_admin_of_role(Oid member, Oid role);
 226 extern void check_is_member_of_role(Oid member, Oid role);
 227
 228 extern void select_best_grantor(Oid roleId, AclMode privileges,
 229                                         const Acl *acl, Oid ownerId,
 230                                         Oid *grantorId, AclMode *grantOptions);
 231
 232 extern void initialize_acl(void);
 233
 234 /*
 235  * SQL functions (from acl.c)
 236  */
 237 extern Datum aclitemin(PG_FUNCTION_ARGS);
 238 extern Datum aclitemout(PG_FUNCTION_ARGS);
 239 extern Datum aclinsert(PG_FUNCTION_ARGS);
 240 extern Datum aclremove(PG_FUNCTION_ARGS);
 241 extern Datum aclcontains(PG_FUNCTION_ARGS);
 242 extern Datum makeaclitem(PG_FUNCTION_ARGS);
 243 extern Datum aclitem_eq(PG_FUNCTION_ARGS);
 244 extern Datum hash_aclitem(PG_FUNCTION_ARGS);
 245
 246 /*
 247  * prototypes for functions in aclchk.c
 248  */
 249 extern void ExecuteGrantStmt(GrantStmt *stmt);
 250 extern void ExecGrantStmt_oids(InternalGrant *istmt);
 251
 252 extern AclMode pg_class_aclmask(Oid table_oid, Oid roleid,
 253                                  AclMode mask, AclMaskHow how);
 254 extern AclMode pg_database_aclmask(Oid db_oid, Oid roleid,
 255                                         AclMode mask, AclMaskHow how);
 256 extern AclMode pg_proc_aclmask(Oid proc_oid, Oid roleid,
 257                                 AclMode mask, AclMaskHow how);
 258 extern AclMode pg_language_aclmask(Oid lang_oid, Oid roleid,
 259                                         AclMode mask, AclMaskHow how);
 260 extern AclMode pg_namespace_aclmask(Oid nsp_oid, Oid roleid,
 261                                          AclMode mask, AclMaskHow how);
 262 extern AclMode pg_tablespace_aclmask(Oid spc_oid, Oid roleid,
 263                                           AclMode mask, AclMaskHow how);
 264
 265 extern AclResult pg_class_aclcheck(Oid table_oid, Oid roleid, AclMode mode);
 266 extern AclResult pg_database_aclcheck(Oid db_oid, Oid roleid, AclMode mode);
 267 extern AclResult pg_proc_aclcheck(Oid proc_oid, Oid roleid, AclMode mode);
 268 extern AclResult pg_language_aclcheck(Oid lang_oid, Oid roleid, AclMode mode);
 269 extern AclResult pg_namespace_aclcheck(Oid nsp_oid, Oid roleid, AclMode mode);
 270 extern AclResult pg_tablespace_aclcheck(Oid spc_oid, Oid roleid, AclMode mode);
 271
 272 extern void aclcheck_error(AclResult aclerr, AclObjectKind objectkind,
 273                            const char *objectname);
 274
 275 /* ownercheck routines just return true (owner) or false (not) */
 276 extern bool pg_class_ownercheck(Oid class_oid, Oid roleid);
 277 extern bool pg_type_ownercheck(Oid type_oid, Oid roleid);
 278 extern bool pg_oper_ownercheck(Oid oper_oid, Oid roleid);
 279 extern bool pg_proc_ownercheck(Oid proc_oid, Oid roleid);
 280 extern bool pg_language_ownercheck(Oid lan_oid, Oid roleid);
 281 extern bool pg_namespace_ownercheck(Oid nsp_oid, Oid roleid);
 282 extern bool pg_tablespace_ownercheck(Oid spc_oid, Oid roleid);
 283 extern bool pg_opclass_ownercheck(Oid opc_oid, Oid roleid);
 284 extern bool pg_opfamily_ownercheck(Oid opf_oid, Oid roleid);
 285 extern bool pg_database_ownercheck(Oid db_oid, Oid roleid);
 286 extern bool pg_conversion_ownercheck(Oid conv_oid, Oid roleid);
 287 extern bool pg_ts_dict_ownercheck(Oid dict_oid, Oid roleid);
 288 extern bool pg_ts_config_ownercheck(Oid cfg_oid, Oid roleid);
 289
 290 #endif   /* ACL_H */