1/*-------------------------------------------------------------------------
4 * Definition of (and support for) access control list data structures.
7 * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
8 * Portions Copyright (c) 1994, Regents of the University of California
10 * src/include/utils/acl.h
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".
17 * The order of items in the array is important as client utilities (in
18 * particular, pg_dump, though possibly other clients) expect to be able
19 * to issue GRANTs in the ordering of the items in the array. The reason
20 * this matters is that GRANTs WITH GRANT OPTION must be before any GRANTs
21 * which depend on it. This happens naturally in the backend during
22 * operations as we update ACLs in-place, new items are appended, and
23 * existing entries are only removed if there's no dependency on them (no
24 * GRANT can been based on it, or, if there was, those GRANTs are also
27 * For backward-compatibility purposes we have to allow null ACL entries
28 * in system catalogs. A null ACL will be treated as meaning "default
29 * protection" (i.e., whatever acldefault() returns).
30 *-------------------------------------------------------------------------
42 * typedef AclMode is declared in parsenodes.h, also the individual privilege
43 * bit meanings are defined there
46 #define ACL_ID_PUBLIC 0 /* placeholder for id in a PUBLIC acl item */
51 * Note: must be same size on all platforms, because the size is hardcoded
52 * in the pg_type.h entry for aclitem.
62 * The upper 32 bits of the ai_privs field of an AclItem are the grant option
63 * bits, and the lower 32 bits are the actual privileges. We use "rights"
64 * to mean the combined grant option and privilege bits fields.
66 #define ACLITEM_GET_PRIVS(item) ((item).ai_privs & 0xFFFFFFFF)
67 #define ACLITEM_GET_GOPTIONS(item) (((item).ai_privs >> 32) & 0xFFFFFFFF)
68 #define ACLITEM_GET_RIGHTS(item) ((item).ai_privs)
70 #define ACL_GRANT_OPTION_FOR(privs) (((AclMode) (privs) & 0xFFFFFFFF) << 32)
71 #define ACL_OPTION_TO_PRIVS(privs) (((AclMode) (privs) >> 32) & 0xFFFFFFFF)
73 #define ACLITEM_SET_PRIVS(item,privs) \
74 ((item).ai_privs = ((item).ai_privs & ~((AclMode) 0xFFFFFFFF)) | \
75 ((AclMode) (privs) & 0xFFFFFFFF))
76 #define ACLITEM_SET_GOPTIONS(item,goptions) \
77 ((item).ai_privs = ((item).ai_privs & ~(((AclMode) 0xFFFFFFFF) << 32)) | \
78 (((AclMode) (goptions) & 0xFFFFFFFF) << 32))
79 #define ACLITEM_SET_RIGHTS(item,rights) \
80 ((item).ai_privs = (AclMode) (rights))
82 #define ACLITEM_SET_PRIVS_GOPTIONS(item,privs,goptions) \
83 ((item).ai_privs = ((AclMode) (privs) & 0xFFFFFFFF) | \
84 (((AclMode) (goptions) & 0xFFFFFFFF) << 32))
87 #define ACLITEM_ALL_PRIV_BITS ((AclMode) 0xFFFFFFFF)
88 #define ACLITEM_ALL_GOPTION_BITS ((AclMode) 0xFFFFFFFF << 32)
91 * Definitions for convenient access to Acl (array of AclItem).
92 * These are standard PostgreSQL arrays, but are restricted to have one
93 * dimension and no nulls. We also ignore the lower bound when reading,
94 * and set it to one when writing.
96 * CAUTION: as of PostgreSQL 7.1, these arrays are toastable (just like all
97 * other array types). Therefore, be careful to detoast them with the
98 * macros provided, unless you know for certain that a particular array
99 * can't have been toasted.
104 * Acl a one-dimensional array of AclItem
108 #define ACL_NUM(ACL) (ARR_DIMS(ACL)[0])
109 #define ACL_DAT(ACL) ((AclItem *) ARR_DATA_PTR(ACL))
110 #define ACL_N_SIZE(N) (ARR_OVERHEAD_NONULLS(1) + ((N) * sizeof(AclItem)))
111 #define ACL_SIZE(ACL) ARR_SIZE(ACL)
114 * fmgr macros for these types
116 #define DatumGetAclItemP(X) ((AclItem *) DatumGetPointer(X))
117 #define PG_GETARG_ACLITEM_P(n) DatumGetAclItemP(PG_GETARG_DATUM(n))
118 #define PG_RETURN_ACLITEM_P(x) PG_RETURN_POINTER(x)
120 #define DatumGetAclP(X) ((Acl *) PG_DETOAST_DATUM(X))
121 #define DatumGetAclPCopy(X) ((Acl *) PG_DETOAST_DATUM_COPY(X))
122 #define PG_GETARG_ACL_P(n) DatumGetAclP(PG_GETARG_DATUM(n))
123 #define PG_GETARG_ACL_P_COPY(n) DatumGetAclPCopy(PG_GETARG_DATUM(n))
124 #define PG_RETURN_ACL_P(x) PG_RETURN_POINTER(x)
127 * ACL modification opcodes for aclupdate
129 #define ACL_MODECHG_ADD 1
130 #define ACL_MODECHG_DEL 2
131 #define ACL_MODECHG_EQL 3
134 * External representations of the privilege bits --- aclitemin/aclitemout
135 * represent each possible privilege bit with a distinct 1-character code
137 #define ACL_INSERT_CHR 'a' /* formerly known as "append" */
138 #define ACL_SELECT_CHR 'r' /* formerly known as "read" */
139 #define ACL_UPDATE_CHR 'w' /* formerly known as "write" */
140 #define ACL_DELETE_CHR 'd'
141 #define ACL_TRUNCATE_CHR 'D' /* super-delete, as it were */
142 #define ACL_REFERENCES_CHR 'x'
143 #define ACL_TRIGGER_CHR 't'
144 #define ACL_EXECUTE_CHR 'X'
145 #define ACL_USAGE_CHR 'U'
146 #define ACL_CREATE_CHR 'C'
147 #define ACL_CREATE_TEMP_CHR 'T'
148 #define ACL_CONNECT_CHR 'c'
149 #define ACL_SET_CHR 's'
150 #define ACL_ALTER_SYSTEM_CHR 'A'
151 #define ACL_MAINTAIN_CHR 'm'
153/* string holding all privilege code chars, in order by bitmask position */
154 #define ACL_ALL_RIGHTS_STR "arwdDxtXUCTcsAm"
157 * Bitmasks defining "all rights" for each supported object type
159 #define ACL_ALL_RIGHTS_COLUMN (ACL_INSERT|ACL_SELECT|ACL_UPDATE|ACL_REFERENCES)
160 #define ACL_ALL_RIGHTS_RELATION (ACL_INSERT|ACL_SELECT|ACL_UPDATE|ACL_DELETE|ACL_TRUNCATE|ACL_REFERENCES|ACL_TRIGGER|ACL_MAINTAIN)
161 #define ACL_ALL_RIGHTS_SEQUENCE (ACL_USAGE|ACL_SELECT|ACL_UPDATE)
162 #define ACL_ALL_RIGHTS_DATABASE (ACL_CREATE|ACL_CREATE_TEMP|ACL_CONNECT)
163 #define ACL_ALL_RIGHTS_FDW (ACL_USAGE)
164 #define ACL_ALL_RIGHTS_FOREIGN_SERVER (ACL_USAGE)
165 #define ACL_ALL_RIGHTS_FUNCTION (ACL_EXECUTE)
166 #define ACL_ALL_RIGHTS_LANGUAGE (ACL_USAGE)
167 #define ACL_ALL_RIGHTS_LARGEOBJECT (ACL_SELECT|ACL_UPDATE)
168 #define ACL_ALL_RIGHTS_PARAMETER_ACL (ACL_SET|ACL_ALTER_SYSTEM)
169 #define ACL_ALL_RIGHTS_SCHEMA (ACL_USAGE|ACL_CREATE)
170 #define ACL_ALL_RIGHTS_TABLESPACE (ACL_CREATE)
171 #define ACL_ALL_RIGHTS_TYPE (ACL_USAGE)
173/* operation codes for pg_*_aclmask */
180/* result codes for pg_*_aclcheck */
190 * routines used internally
227 const Acl *acl,
Oid ownerId,
233 * prototypes for functions in aclchk.c
243/* generic functions */
270 const char *objectname);
273 const char *objectname,
const char *colname);
285/* ownercheck routines just return true (owner) or false (not) */
AclResult object_aclcheck_ext(Oid classid, Oid objectid, Oid roleid, AclMode mode, bool *is_missing)
void initialize_acl(void)
void ExecuteGrantStmt(GrantStmt *stmt)
AclResult pg_largeobject_aclcheck_snapshot(Oid lobj_oid, Oid roleid, AclMode mode, Snapshot snapshot)
void RemoveRoleFromInitPriv(Oid roleid, Oid classid, Oid objid, int32 objsubid)
bool is_admin_of_role(Oid member, Oid role)
Acl * aclconcat(const Acl *left_acl, const Acl *right_acl)
Acl * aclmerge(const Acl *left_acl, const Acl *right_acl, Oid ownerId)
bool has_bypassrls_privilege(Oid roleid)
AclResult pg_class_aclcheck_ext(Oid table_oid, Oid roleid, AclMode mode, bool *is_missing)
void aclcheck_error_col(AclResult aclerr, ObjectType objtype, const char *objectname, const char *colname)
AclResult pg_attribute_aclcheck_all_ext(Oid table_oid, Oid roleid, AclMode mode, AclMaskHow how, bool *is_missing)
void recordDependencyOnNewAcl(Oid classId, Oid objectId, int32 objsubId, Oid ownerId, Acl *acl)
Oid select_best_admin(Oid member, Oid role)
Acl * acldefault(ObjectType objtype, Oid ownerId)
Oid get_role_oid_or_public(const char *rolname)
void ExecAlterDefaultPrivilegesStmt(ParseState *pstate, AlterDefaultPrivilegesStmt *stmt)
bool aclequal(const Acl *left_acl, const Acl *right_acl)
AclResult pg_attribute_aclcheck_all(Oid table_oid, Oid roleid, AclMode mode, AclMaskHow how)
Acl * aclupdate(const Acl *old_acl, const AclItem *mod_aip, int modechg, Oid ownerId, DropBehavior behavior)
bool is_member_of_role(Oid member, Oid role)
AclResult pg_parameter_aclcheck(const char *name, Oid roleid, AclMode mode)
void ReplaceRoleInInitPriv(Oid oldroleid, Oid newroleid, Oid classid, Oid objid, int32 objsubid)
void select_best_grantor(Oid roleId, AclMode privileges, const Acl *acl, Oid ownerId, Oid *grantorId, AclMode *grantOptions)
bool is_member_of_role_nosuper(Oid member, Oid role)
bool has_privs_of_role(Oid member, Oid role)
Acl * make_empty_acl(void)
void recordExtObjInitPriv(Oid objoid, Oid classoid)
int aclmembers(const Acl *acl, Oid **roleids)
Acl * aclnewowner(const Acl *old_acl, Oid oldOwnerId, Oid newOwnerId)
bool member_can_set_role(Oid member, Oid role)
Acl * aclcopy(const Acl *orig_acl)
void aclitemsort(Acl *acl)
AclMode aclmask(const Acl *acl, Oid roleid, Oid ownerId, AclMode mask, AclMaskHow how)
void aclcheck_error(AclResult aclerr, ObjectType objtype, const char *objectname)
AclResult pg_attribute_aclcheck(Oid table_oid, AttrNumber attnum, Oid roleid, AclMode mode)
Oid get_role_oid(const char *rolname, bool missing_ok)
AclResult object_aclcheck(Oid classid, Oid objectid, Oid roleid, AclMode mode)
bool object_ownercheck(Oid classid, Oid objectid, Oid roleid)
AclResult pg_attribute_aclcheck_ext(Oid table_oid, AttrNumber attnum, Oid roleid, AclMode mode, bool *is_missing)
char * get_rolespec_name(const RoleSpec *role)
void check_can_set_role(Oid member, Oid role)
AclMode pg_class_aclmask(Oid table_oid, Oid roleid, AclMode mask, AclMaskHow how)
void check_rolespec_name(const RoleSpec *role, const char *detail_msg)
void aclcheck_error_type(AclResult aclerr, Oid typeOid)
bool has_createrole_privilege(Oid roleid)
Oid get_rolespec_oid(const RoleSpec *role, bool missing_ok)
Acl * get_user_default_acl(ObjectType objtype, Oid ownerId, Oid nsp_oid)
void RemoveRoleFromObjectACL(Oid roleid, Oid classid, Oid objid)
AclResult pg_class_aclcheck(Oid table_oid, Oid roleid, AclMode mode)
HeapTuple get_rolespec_tuple(const RoleSpec *role)
void removeExtObjInitPriv(Oid objoid, Oid classoid)
static PgChecksumMode mode