1/*-------------------------------------------------------------------------
2 *
3 * acl.h
4 * Definition of (and support for) access control list data structures.
5 *
6 *
7 * Portions Copyright (c) 1996-2019, 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/array.h"
39#include "utils/snapshot.h"
40
41
42/*
43 * typedef AclMode is declared in parsenodes.h, also the individual privilege
44 * bit meanings are defined there
45 */
46
47#define ACL_ID_PUBLIC 0 /* placeholder for id in a PUBLIC acl item */
48
49/*
50 * AclItem
51 *
52 * Note: must be same size on all platforms, because the size is hardcoded
53 * in the pg_type.h entry for aclitem.
54 */
55typedef struct AclItem
56{
57 Oid ai_grantee; /* ID that this item grants privs to */
58 Oid ai_grantor; /* grantor of privs */
59 AclMode ai_privs; /* privilege bits */
60} AclItem;
61
62/*
63 * The upper 16 bits of the ai_privs field of an AclItem are the grant option
64 * bits, and the lower 16 bits are the actual privileges. We use "rights"
65 * to mean the combined grant option and privilege bits fields.
66 */
67#define ACLITEM_GET_PRIVS(item) ((item).ai_privs & 0xFFFF)
68#define ACLITEM_GET_GOPTIONS(item) (((item).ai_privs >> 16) & 0xFFFF)
69#define ACLITEM_GET_RIGHTS(item) ((item).ai_privs)
70
71#define ACL_GRANT_OPTION_FOR(privs) (((AclMode) (privs) & 0xFFFF) << 16)
72#define ACL_OPTION_TO_PRIVS(privs) (((AclMode) (privs) >> 16) & 0xFFFF)
73
74#define ACLITEM_SET_PRIVS(item,privs) \
75 ((item).ai_privs = ((item).ai_privs & ~((AclMode) 0xFFFF)) | \
76 ((AclMode) (privs) & 0xFFFF))
77#define ACLITEM_SET_GOPTIONS(item,goptions) \
78 ((item).ai_privs = ((item).ai_privs & ~(((AclMode) 0xFFFF) << 16)) | \
79 (((AclMode) (goptions) & 0xFFFF) << 16))
80#define ACLITEM_SET_RIGHTS(item,rights) \
81 ((item).ai_privs = (AclMode) (rights))
82
83#define ACLITEM_SET_PRIVS_GOPTIONS(item,privs,goptions) \
84 ((item).ai_privs = ((AclMode) (privs) & 0xFFFF) | \
85 (((AclMode) (goptions) & 0xFFFF) << 16))
86
87
88#define ACLITEM_ALL_PRIV_BITS ((AclMode) 0xFFFF)
89#define ACLITEM_ALL_GOPTION_BITS ((AclMode) 0xFFFF << 16)
90
91/*
92 * Definitions for convenient access to Acl (array of AclItem).
93 * These are standard PostgreSQL arrays, but are restricted to have one
94 * dimension and no nulls. We also ignore the lower bound when reading,
95 * and set it to one when writing.
96 *
97 * CAUTION: as of PostgreSQL 7.1, these arrays are toastable (just like all
98 * other array types). Therefore, be careful to detoast them with the
99 * macros provided, unless you know for certain that a particular array
100 * can't have been toasted.
101 */
102
103
104/*
105 * Acl a one-dimensional array of AclItem
106 */
107typedef ArrayType Acl;
108
109#define ACL_NUM(ACL) (ARR_DIMS(ACL)[0])
110#define ACL_DAT(ACL) ((AclItem *) ARR_DATA_PTR(ACL))
111#define ACL_N_SIZE(N) (ARR_OVERHEAD_NONULLS(1) + ((N) * sizeof(AclItem)))
112#define ACL_SIZE(ACL) ARR_SIZE(ACL)
113
114/*
115 * fmgr macros for these types
116 */
117#define DatumGetAclItemP(X) ((AclItem *) DatumGetPointer(X))
118#define PG_GETARG_ACLITEM_P(n) DatumGetAclItemP(PG_GETARG_DATUM(n))
119#define PG_RETURN_ACLITEM_P(x) PG_RETURN_POINTER(x)
120
121#define DatumGetAclP(X) ((Acl *) PG_DETOAST_DATUM(X))
122#define DatumGetAclPCopy(X) ((Acl *) PG_DETOAST_DATUM_COPY(X))
123#define PG_GETARG_ACL_P(n) DatumGetAclP(PG_GETARG_DATUM(n))
124#define PG_GETARG_ACL_P_COPY(n) DatumGetAclPCopy(PG_GETARG_DATUM(n))
125#define PG_RETURN_ACL_P(x) PG_RETURN_POINTER(x)
126
127/*
128 * ACL modification opcodes for aclupdate
129 */
130#define ACL_MODECHG_ADD 1
131#define ACL_MODECHG_DEL 2
132#define ACL_MODECHG_EQL 3
133
134/*
135 * External representations of the privilege bits --- aclitemin/aclitemout
136 * represent each possible privilege bit with a distinct 1-character code
137 */
138#define ACL_INSERT_CHR 'a' /* formerly known as "append" */
139#define ACL_SELECT_CHR 'r' /* formerly known as "read" */
140#define ACL_UPDATE_CHR 'w' /* formerly known as "write" */
141#define ACL_DELETE_CHR 'd'
142#define ACL_TRUNCATE_CHR 'D' /* super-delete, as it were */
143#define ACL_REFERENCES_CHR 'x'
144#define ACL_TRIGGER_CHR 't'
145#define ACL_EXECUTE_CHR 'X'
146#define ACL_USAGE_CHR 'U'
147#define ACL_CREATE_CHR 'C'
148#define ACL_CREATE_TEMP_CHR 'T'
149#define ACL_CONNECT_CHR 'c'
150
151/* string holding all privilege code chars, in order by bitmask position */
152#define ACL_ALL_RIGHTS_STR "arwdDxtXUCTc"
153
154/*
155 * Bitmasks defining "all rights" for each supported object type
156 */
157#define ACL_ALL_RIGHTS_COLUMN (ACL_INSERT|ACL_SELECT|ACL_UPDATE|ACL_REFERENCES)
158#define ACL_ALL_RIGHTS_RELATION (ACL_INSERT|ACL_SELECT|ACL_UPDATE|ACL_DELETE|ACL_TRUNCATE|ACL_REFERENCES|ACL_TRIGGER)
159#define ACL_ALL_RIGHTS_SEQUENCE (ACL_USAGE|ACL_SELECT|ACL_UPDATE)
160#define ACL_ALL_RIGHTS_DATABASE (ACL_CREATE|ACL_CREATE_TEMP|ACL_CONNECT)
161#define ACL_ALL_RIGHTS_FDW (ACL_USAGE)
162#define ACL_ALL_RIGHTS_FOREIGN_SERVER (ACL_USAGE)
163#define ACL_ALL_RIGHTS_FUNCTION (ACL_EXECUTE)
164#define ACL_ALL_RIGHTS_LANGUAGE (ACL_USAGE)
165#define ACL_ALL_RIGHTS_LARGEOBJECT (ACL_SELECT|ACL_UPDATE)
166#define ACL_ALL_RIGHTS_SCHEMA (ACL_USAGE|ACL_CREATE)
167#define ACL_ALL_RIGHTS_TABLESPACE (ACL_CREATE)
168#define ACL_ALL_RIGHTS_TYPE (ACL_USAGE)
169
170/* operation codes for pg_*_aclmask */
171typedef enum
172{
173 ACLMASK_ALL, /* normal case: compute all bits */
174 ACLMASK_ANY /* return when result is known nonzero */
175} AclMaskHow;
176
177/* result codes for pg_*_aclcheck */
178typedef enum
179{
180 ACLCHECK_OK = 0,
181 ACLCHECK_NO_PRIV,
182 ACLCHECK_NOT_OWNER
183} AclResult;
184
185
186/*
187 * routines used internally
188 */
189extern Acl *acldefault(ObjectType objtype, Oid ownerId);
190extern Acl *get_user_default_acl(ObjectType objtype, Oid ownerId,
191 Oid nsp_oid);
192extern void recordDependencyOnNewAcl(Oid classId, Oid objectId, int32 objsubId,
193 Oid ownerId, Acl *acl);
194
195extern Acl *aclupdate(const Acl *old_acl, const AclItem *mod_aip,
196 int modechg, Oid ownerId, DropBehavior behavior);
197extern Acl *aclnewowner(const Acl *old_acl, Oid oldOwnerId, Oid newOwnerId);
198extern Acl *make_empty_acl(void);
199extern Acl *aclcopy(const Acl *orig_acl);
200extern Acl *aclconcat(const Acl *left_acl, const Acl *right_acl);
201extern Acl *aclmerge(const Acl *left_acl, const Acl *right_acl, Oid ownerId);
202extern void aclitemsort(Acl *acl);
203extern bool aclequal(const Acl *left_acl, const Acl *right_acl);
204
205extern AclMode aclmask(const Acl *acl, Oid roleid, Oid ownerId,
206 AclMode mask, AclMaskHow how);
207extern int aclmembers(const Acl *acl, Oid **roleids);
208
209extern bool has_privs_of_role(Oid member, Oid role);
210extern bool is_member_of_role(Oid member, Oid role);
211extern bool is_member_of_role_nosuper(Oid member, Oid role);
212extern bool is_admin_of_role(Oid member, Oid role);
213extern void check_is_member_of_role(Oid member, Oid role);
214extern Oid get_role_oid(const char *rolename, bool missing_ok);
215extern Oid get_role_oid_or_public(const char *rolename);
216extern Oid get_rolespec_oid(const RoleSpec *role, bool missing_ok);
217extern void check_rolespec_name(const RoleSpec *role, const char *detail_msg);
218extern HeapTuple get_rolespec_tuple(const RoleSpec *role);
219extern char *get_rolespec_name(const RoleSpec *role);
220
221extern void select_best_grantor(Oid roleId, AclMode privileges,
222 const Acl *acl, Oid ownerId,
223 Oid *grantorId, AclMode *grantOptions);
224
225extern void initialize_acl(void);
226
227/*
228 * prototypes for functions in aclchk.c
229 */
230extern void ExecuteGrantStmt(GrantStmt *stmt);
231extern void ExecAlterDefaultPrivilegesStmt(ParseState *pstate, AlterDefaultPrivilegesStmt *stmt);
232
233extern void RemoveRoleFromObjectACL(Oid roleid, Oid classid, Oid objid);
234extern void RemoveDefaultACLById(Oid defaclOid);
235
236extern AclMode pg_attribute_aclmask(Oid table_oid, AttrNumber attnum,
237 Oid roleid, AclMode mask, AclMaskHow how);
238extern AclMode pg_class_aclmask(Oid table_oid, Oid roleid,
239 AclMode mask, AclMaskHow how);
240extern AclMode pg_database_aclmask(Oid db_oid, Oid roleid,
241 AclMode mask, AclMaskHow how);
242extern AclMode pg_proc_aclmask(Oid proc_oid, Oid roleid,
243 AclMode mask, AclMaskHow how);
244extern AclMode pg_language_aclmask(Oid lang_oid, Oid roleid,
245 AclMode mask, AclMaskHow how);
246extern AclMode pg_largeobject_aclmask_snapshot(Oid lobj_oid, Oid roleid,
247 AclMode mask, AclMaskHow how, Snapshot snapshot);
248extern AclMode pg_namespace_aclmask(Oid nsp_oid, Oid roleid,
249 AclMode mask, AclMaskHow how);
250extern AclMode pg_tablespace_aclmask(Oid spc_oid, Oid roleid,
251 AclMode mask, AclMaskHow how);
252extern AclMode pg_foreign_data_wrapper_aclmask(Oid fdw_oid, Oid roleid,
253 AclMode mask, AclMaskHow how);
254extern AclMode pg_foreign_server_aclmask(Oid srv_oid, Oid roleid,
255 AclMode mask, AclMaskHow how);
256extern AclMode pg_type_aclmask(Oid type_oid, Oid roleid,
257 AclMode mask, AclMaskHow how);
258
259extern AclResult pg_attribute_aclcheck(Oid table_oid, AttrNumber attnum,
260 Oid roleid, AclMode mode);
261extern AclResult pg_attribute_aclcheck_all(Oid table_oid, Oid roleid,
262 AclMode mode, AclMaskHow how);
263extern AclResult pg_class_aclcheck(Oid table_oid, Oid roleid, AclMode mode);
264extern AclResult pg_database_aclcheck(Oid db_oid, Oid roleid, AclMode mode);
265extern AclResult pg_proc_aclcheck(Oid proc_oid, Oid roleid, AclMode mode);
266extern AclResult pg_language_aclcheck(Oid lang_oid, Oid roleid, AclMode mode);
267extern AclResult pg_largeobject_aclcheck_snapshot(Oid lang_oid, Oid roleid,
268 AclMode mode, Snapshot snapshot);
269extern AclResult pg_namespace_aclcheck(Oid nsp_oid, Oid roleid, AclMode mode);
270extern AclResult pg_tablespace_aclcheck(Oid spc_oid, Oid roleid, AclMode mode);
271extern AclResult pg_foreign_data_wrapper_aclcheck(Oid fdw_oid, Oid roleid, AclMode mode);
272extern AclResult pg_foreign_server_aclcheck(Oid srv_oid, Oid roleid, AclMode mode);
273extern AclResult pg_type_aclcheck(Oid type_oid, Oid roleid, AclMode mode);
274
275extern void aclcheck_error(AclResult aclerr, ObjectType objtype,
276 const char *objectname);
277
278extern void aclcheck_error_col(AclResult aclerr, ObjectType objtype,
279 const char *objectname, const char *colname);
280
281extern void aclcheck_error_type(AclResult aclerr, Oid typeOid);
282
283extern void recordExtObjInitPriv(Oid objoid, Oid classoid);
284extern void removeExtObjInitPriv(Oid objoid, Oid classoid);
285
286
287/* ownercheck routines just return true (owner) or false (not) */
288extern bool pg_class_ownercheck(Oid class_oid, Oid roleid);
289extern bool pg_type_ownercheck(Oid type_oid, Oid roleid);
290extern bool pg_oper_ownercheck(Oid oper_oid, Oid roleid);
291extern bool pg_proc_ownercheck(Oid proc_oid, Oid roleid);
292extern bool pg_language_ownercheck(Oid lan_oid, Oid roleid);
293extern bool pg_largeobject_ownercheck(Oid lobj_oid, Oid roleid);
294extern bool pg_namespace_ownercheck(Oid nsp_oid, Oid roleid);
295extern bool pg_tablespace_ownercheck(Oid spc_oid, Oid roleid);
296extern bool pg_opclass_ownercheck(Oid opc_oid, Oid roleid);
297extern bool pg_opfamily_ownercheck(Oid opf_oid, Oid roleid);
298extern bool pg_database_ownercheck(Oid db_oid, Oid roleid);
299extern bool pg_collation_ownercheck(Oid coll_oid, Oid roleid);
300extern bool pg_conversion_ownercheck(Oid conv_oid, Oid roleid);
301extern bool pg_ts_dict_ownercheck(Oid dict_oid, Oid roleid);
302extern bool pg_ts_config_ownercheck(Oid cfg_oid, Oid roleid);
303extern bool pg_foreign_data_wrapper_ownercheck(Oid srv_oid, Oid roleid);
304extern bool pg_foreign_server_ownercheck(Oid srv_oid, Oid roleid);
305extern bool pg_event_trigger_ownercheck(Oid et_oid, Oid roleid);
306extern bool pg_extension_ownercheck(Oid ext_oid, Oid roleid);
307extern bool pg_publication_ownercheck(Oid pub_oid, Oid roleid);
308extern bool pg_subscription_ownercheck(Oid sub_oid, Oid roleid);
309extern bool pg_statistics_object_ownercheck(Oid stat_oid, Oid roleid);
310extern bool has_createrole_privilege(Oid roleid);
311extern bool has_bypassrls_privilege(Oid roleid);
312
313#endif /* ACL_H */
314