PostgreSQL Source Code  git master
acl.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * acl.h
4  * Definition of (and support for) access control list data structures.
5  *
6  *
7  * Portions Copyright (c) 1996-2022, PostgreSQL Global Development Group
8  * Portions Copyright (c) 1994, Regents of the University of California
9  *
10  * src/include/utils/acl.h
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".
16  *
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
25  * removed).
26  *
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  *-------------------------------------------------------------------------
31  */
32 #ifndef ACL_H
33 #define ACL_H
34 
35 #include "access/htup.h"
36 #include "nodes/parsenodes.h"
37 #include "parser/parse_node.h"
38 #include "utils/snapshot.h"
39 
40 
41 /*
42  * typedef AclMode is declared in parsenodes.h, also the individual privilege
43  * bit meanings are defined there
44  */
45 
46 #define ACL_ID_PUBLIC 0 /* placeholder for id in a PUBLIC acl item */
47 
48 /*
49  * AclItem
50  *
51  * Note: must be same size on all platforms, because the size is hardcoded
52  * in the pg_type.h entry for aclitem.
53  */
54 typedef struct AclItem
55 {
56  Oid ai_grantee; /* ID that this item grants privs to */
57  Oid ai_grantor; /* grantor of privs */
58  AclMode ai_privs; /* privilege bits */
60 
61 /*
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.
65  */
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)
69 
70 #define ACL_GRANT_OPTION_FOR(privs) (((AclMode) (privs) & 0xFFFFFFFF) << 32)
71 #define ACL_OPTION_TO_PRIVS(privs) (((AclMode) (privs) >> 32) & 0xFFFFFFFF)
72 
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))
81 
82 #define ACLITEM_SET_PRIVS_GOPTIONS(item,privs,goptions) \
83  ((item).ai_privs = ((AclMode) (privs) & 0xFFFFFFFF) | \
84  (((AclMode) (goptions) & 0xFFFFFFFF) << 32))
85 
86 
87 #define ACLITEM_ALL_PRIV_BITS ((AclMode) 0xFFFFFFFF)
88 #define ACLITEM_ALL_GOPTION_BITS ((AclMode) 0xFFFFFFFF << 32)
89 
90 /*
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.
95  *
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.
100  */
101 
102 
103 /*
104  * Acl a one-dimensional array of AclItem
105  */
106 typedef struct ArrayType Acl;
107 
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)
112 
113 /*
114  * fmgr macros for these types
115  */
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)
119 
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)
125 
126 /*
127  * ACL modification opcodes for aclupdate
128  */
129 #define ACL_MODECHG_ADD 1
130 #define ACL_MODECHG_DEL 2
131 #define ACL_MODECHG_EQL 3
132 
133 /*
134  * External representations of the privilege bits --- aclitemin/aclitemout
135  * represent each possible privilege bit with a distinct 1-character code
136  */
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_VACUUM_CHR 'v'
152 #define ACL_ANALYZE_CHR 'z'
153 
154 /* string holding all privilege code chars, in order by bitmask position */
155 #define ACL_ALL_RIGHTS_STR "arwdDxtXUCTcsAvz"
156 
157 /*
158  * Bitmasks defining "all rights" for each supported object type
159  */
160 #define ACL_ALL_RIGHTS_COLUMN (ACL_INSERT|ACL_SELECT|ACL_UPDATE|ACL_REFERENCES)
161 #define ACL_ALL_RIGHTS_RELATION (ACL_INSERT|ACL_SELECT|ACL_UPDATE|ACL_DELETE|ACL_TRUNCATE|ACL_REFERENCES|ACL_TRIGGER|ACL_VACUUM|ACL_ANALYZE)
162 #define ACL_ALL_RIGHTS_SEQUENCE (ACL_USAGE|ACL_SELECT|ACL_UPDATE)
163 #define ACL_ALL_RIGHTS_DATABASE (ACL_CREATE|ACL_CREATE_TEMP|ACL_CONNECT)
164 #define ACL_ALL_RIGHTS_FDW (ACL_USAGE)
165 #define ACL_ALL_RIGHTS_FOREIGN_SERVER (ACL_USAGE)
166 #define ACL_ALL_RIGHTS_FUNCTION (ACL_EXECUTE)
167 #define ACL_ALL_RIGHTS_LANGUAGE (ACL_USAGE)
168 #define ACL_ALL_RIGHTS_LARGEOBJECT (ACL_SELECT|ACL_UPDATE)
169 #define ACL_ALL_RIGHTS_PARAMETER_ACL (ACL_SET|ACL_ALTER_SYSTEM)
170 #define ACL_ALL_RIGHTS_SCHEMA (ACL_USAGE|ACL_CREATE)
171 #define ACL_ALL_RIGHTS_TABLESPACE (ACL_CREATE)
172 #define ACL_ALL_RIGHTS_TYPE (ACL_USAGE)
173 
174 /* operation codes for pg_*_aclmask */
175 typedef enum
176 {
177  ACLMASK_ALL, /* normal case: compute all bits */
178  ACLMASK_ANY /* return when result is known nonzero */
180 
181 /* result codes for pg_*_aclcheck */
182 typedef enum
183 {
188 
189 
190 /*
191  * routines used internally
192  */
193 extern Acl *acldefault(ObjectType objtype, Oid ownerId);
194 extern Acl *get_user_default_acl(ObjectType objtype, Oid ownerId,
195  Oid nsp_oid);
196 extern void recordDependencyOnNewAcl(Oid classId, Oid objectId, int32 objsubId,
197  Oid ownerId, Acl *acl);
198 
199 extern Acl *aclupdate(const Acl *old_acl, const AclItem *mod_aip,
200  int modechg, Oid ownerId, DropBehavior behavior);
201 extern Acl *aclnewowner(const Acl *old_acl, Oid oldOwnerId, Oid newOwnerId);
202 extern Acl *make_empty_acl(void);
203 extern Acl *aclcopy(const Acl *orig_acl);
204 extern Acl *aclconcat(const Acl *left_acl, const Acl *right_acl);
205 extern Acl *aclmerge(const Acl *left_acl, const Acl *right_acl, Oid ownerId);
206 extern void aclitemsort(Acl *acl);
207 extern bool aclequal(const Acl *left_acl, const Acl *right_acl);
208 
209 extern AclMode aclmask(const Acl *acl, Oid roleid, Oid ownerId,
210  AclMode mask, AclMaskHow how);
211 extern int aclmembers(const Acl *acl, Oid **roleids);
212 
213 extern bool has_privs_of_role(Oid member, Oid role);
214 extern bool member_can_set_role(Oid member, Oid role);
215 extern void check_can_set_role(Oid member, Oid role);
216 extern bool is_member_of_role(Oid member, Oid role);
217 extern bool is_member_of_role_nosuper(Oid member, Oid role);
218 extern bool is_admin_of_role(Oid member, Oid role);
219 extern Oid select_best_admin(Oid member, Oid role);
220 extern Oid get_role_oid(const char *rolname, bool missing_ok);
221 extern Oid get_role_oid_or_public(const char *rolname);
222 extern Oid get_rolespec_oid(const RoleSpec *role, bool missing_ok);
223 extern void check_rolespec_name(const RoleSpec *role, const char *detail_msg);
224 extern HeapTuple get_rolespec_tuple(const RoleSpec *role);
225 extern char *get_rolespec_name(const RoleSpec *role);
226 
227 extern void select_best_grantor(Oid roleId, AclMode privileges,
228  const Acl *acl, Oid ownerId,
229  Oid *grantorId, AclMode *grantOptions);
230 
231 extern void initialize_acl(void);
232 
233 /*
234  * prototypes for functions in aclchk.c
235  */
236 extern void ExecuteGrantStmt(GrantStmt *stmt);
238 
239 extern void RemoveRoleFromObjectACL(Oid roleid, Oid classid, Oid objid);
240 
241 extern AclMode pg_class_aclmask(Oid table_oid, Oid roleid,
242  AclMode mask, AclMaskHow how);
243 
244 /* generic function */
245 extern AclResult object_aclcheck(Oid classid, Oid objectid, Oid roleid, AclMode mode);
246 
247 /* special cases */
249  Oid roleid, AclMode mode);
251  Oid roleid, AclMode mode,
252  bool *is_missing);
253 extern AclResult pg_attribute_aclcheck_all(Oid table_oid, Oid roleid,
254  AclMode mode, AclMaskHow how);
255 extern AclResult pg_class_aclcheck(Oid table_oid, Oid roleid, AclMode mode);
256 extern AclResult pg_class_aclcheck_ext(Oid table_oid, Oid roleid,
257  AclMode mode, bool *is_missing);
258 extern AclResult pg_parameter_aclcheck(const char *name, Oid roleid,
259  AclMode mode);
260 extern AclResult pg_largeobject_aclcheck_snapshot(Oid lobj_oid, Oid roleid,
261  AclMode mode, Snapshot snapshot);
262 
263 extern void aclcheck_error(AclResult aclerr, ObjectType objtype,
264  const char *objectname);
265 
266 extern void aclcheck_error_col(AclResult aclerr, ObjectType objtype,
267  const char *objectname, const char *colname);
268 
269 extern void aclcheck_error_type(AclResult aclerr, Oid typeOid);
270 
271 extern void recordExtObjInitPriv(Oid objoid, Oid classoid);
272 extern void removeExtObjInitPriv(Oid objoid, Oid classoid);
273 
274 
275 /* ownercheck routines just return true (owner) or false (not) */
276 extern bool object_ownercheck(Oid classid, Oid objectid, Oid roleid);
277 extern bool has_createrole_privilege(Oid roleid);
278 extern bool has_bypassrls_privilege(Oid roleid);
279 
280 #endif /* ACL_H */
void initialize_acl(void)
Definition: acl.c:4759
void ExecuteGrantStmt(GrantStmt *stmt)
Definition: aclchk.c:386
AclResult pg_largeobject_aclcheck_snapshot(Oid lobj_oid, Oid roleid, AclMode mode, Snapshot snapshot)
Definition: aclchk.c:4785
Acl * aclupdate(const Acl *old_acl, const AclItem *mod_aip, int modechg, Oid ownerId, DropBehavior behavior)
Definition: acl.c:944
bool is_admin_of_role(Oid member, Oid role)
Definition: acl.c:5079
bool has_bypassrls_privilege(Oid roleid)
Definition: aclchk.c:4899
AclResult pg_class_aclcheck_ext(Oid table_oid, Oid roleid, AclMode mode, bool *is_missing)
Definition: aclchk.c:4758
void aclcheck_error_col(AclResult aclerr, ObjectType objtype, const char *objectname, const char *colname)
Definition: aclchk.c:3774
void recordDependencyOnNewAcl(Oid classId, Oid objectId, int32 objsubId, Oid ownerId, Acl *acl)
Definition: aclchk.c:5034
char * get_rolespec_name(const RoleSpec *role)
Definition: acl.c:5354
Oid select_best_admin(Oid member, Oid role)
Definition: acl.c:5104
Oid get_role_oid_or_public(const char *rolname)
Definition: acl.c:5253
void ExecAlterDefaultPrivilegesStmt(ParseState *pstate, AlterDefaultPrivilegesStmt *stmt)
Definition: aclchk.c:970
bool aclequal(const Acl *left_acl, const Acl *right_acl)
Definition: acl.c:516
AclResult
Definition: acl.h:183
@ ACLCHECK_NO_PRIV
Definition: acl.h:185
@ ACLCHECK_OK
Definition: acl.h:184
@ ACLCHECK_NOT_OWNER
Definition: acl.h:186
AclResult pg_attribute_aclcheck_all(Oid table_oid, Oid roleid, AclMode mode, AclMaskHow how)
Definition: aclchk.c:4661
struct AclItem AclItem
bool is_member_of_role(Oid member, Oid role)
Definition: acl.c:5029
AclResult pg_parameter_aclcheck(const char *name, Oid roleid, AclMode mode)
Definition: aclchk.c:4773
void select_best_grantor(Oid roleId, AclMode privileges, const Acl *acl, Oid ownerId, Oid *grantorId, AclMode *grantOptions)
Definition: acl.c:5159
bool is_member_of_role_nosuper(Oid member, Oid role)
Definition: acl.c:5057
bool has_privs_of_role(Oid member, Oid role)
Definition: acl.c:4949
void recordExtObjInitPriv(Oid objoid, Oid classoid)
Definition: aclchk.c:5064
int aclmembers(const Acl *acl, Oid **roleids)
Definition: acl.c:1486
Acl * aclconcat(const Acl *left_acl, const Acl *right_acl)
Definition: acl.c:434
Acl * aclcopy(const Acl *orig_acl)
Definition: acl.c:414
bool member_can_set_role(Oid member, Oid role)
Definition: acl.c:4983
void aclitemsort(Acl *acl)
Definition: acl.c:502
AclMode aclmask(const Acl *acl, Oid roleid, Oid ownerId, AclMode mask, AclMaskHow how)
Definition: acl.c:1334
Acl * acldefault(ObjectType objtype, Oid ownerId)
Definition: acl.c:755
Acl * make_empty_acl(void)
Definition: acl.c:405
void aclcheck_error(AclResult aclerr, ObjectType objtype, const char *objectname)
Definition: aclchk.c:3485
Acl * aclnewowner(const Acl *old_acl, Oid oldOwnerId, Oid newOwnerId)
Definition: acl.c:1065
AclResult pg_attribute_aclcheck(Oid table_oid, AttrNumber attnum, Oid roleid, AclMode mode)
Definition: aclchk.c:4617
Oid get_role_oid(const char *rolname, bool missing_ok)
Definition: acl.c:5235
AclResult object_aclcheck(Oid classid, Oid objectid, Oid roleid, AclMode mode)
Definition: aclchk.c:4598
Acl * get_user_default_acl(ObjectType objtype, Oid ownerId, Oid nsp_oid)
Definition: aclchk.c:4958
bool object_ownercheck(Oid classid, Oid objectid, Oid roleid)
Definition: aclchk.c:4799
AclResult pg_attribute_aclcheck_ext(Oid table_oid, AttrNumber attnum, Oid roleid, AclMode mode, bool *is_missing)
Definition: aclchk.c:4631
void check_can_set_role(Oid member, Oid role)
Definition: acl.c:5006
AclMode pg_class_aclmask(Oid table_oid, Oid roleid, AclMode mask, AclMaskHow how)
Definition: aclchk.c:4081
void check_rolespec_name(const RoleSpec *role, const char *detail_msg)
Definition: acl.c:5376
void aclcheck_error_type(AclResult aclerr, Oid typeOid)
Definition: aclchk.c:3804
bool has_createrole_privilege(Oid roleid)
Definition: aclchk.c:4880
AclMaskHow
Definition: acl.h:176
@ ACLMASK_ANY
Definition: acl.h:178
@ ACLMASK_ALL
Definition: acl.h:177
Oid get_rolespec_oid(const RoleSpec *role, bool missing_ok)
Definition: acl.c:5269
void RemoveRoleFromObjectACL(Oid roleid, Oid classid, Oid objid)
Definition: aclchk.c:1448
AclResult pg_class_aclcheck(Oid table_oid, Oid roleid, AclMode mode)
Definition: aclchk.c:4746
Acl * aclmerge(const Acl *left_acl, const Acl *right_acl, Oid ownerId)
Definition: acl.c:458
HeapTuple get_rolespec_tuple(const RoleSpec *role)
Definition: acl.c:5308
void removeExtObjInitPriv(Oid objoid, Oid classoid)
Definition: aclchk.c:5362
int16 AttrNumber
Definition: attnum.h:21
signed int int32
Definition: c.h:430
const char * name
Definition: encode.c:561
uint64 AclMode
Definition: parsenodes.h:81
DropBehavior
Definition: parsenodes.h:1934
ObjectType
Definition: parsenodes.h:1861
int16 attnum
Definition: pg_attribute.h:83
NameData rolname
Definition: pg_authid.h:34
static PgChecksumMode mode
Definition: pg_checksums.c:65
unsigned int Oid
Definition: postgres_ext.h:31
Definition: acl.h:55
Oid ai_grantee
Definition: acl.h:56
AclMode ai_privs
Definition: acl.h:58
Oid ai_grantor
Definition: acl.h:57