14.5. Statements for Granting Privileges
A GRANT
statement is used for granting privileges — including roles — to users and other database objects.
14.5.1. GRANT
Grants privileges and assigns roles
Available inDSQL, ESQL
Syntax (granting privileges)
|
GRANT <privileges>
| TO <grantee_list>
| [WITH GRANT OPTION]
| [{GRANTED BY | AS} [USER] grantor]
|
|<privileges> ::=
| <table_privileges> | <execute_privilege>
| | <usage_privilege> | <ddl_privileges>
| | <db_ddl_privilege>
|
|<table_privileges> ::=
| {ALL [PRIVILEGES] | <table_privilege_list> }
| ON [TABLE] {table_name | view_name}
|
|<table_privilege_list> ::=
| <table_privilege> [, <tableprivilege> ...]
|
|<table_privilege> ::=
| SELECT | DELETE | INSERT
| | UPDATE [(col [, col ...])]
| | REFERENCES [(col [, col ...)]
|
|<execute_privilege> ::= EXECUTE ON
| { PROCEDURE proc_name | FUNCTION func_name
| | PACKAGE package_name }
|
|<usage_privilege> ::= USAGE ON
| { EXCEPTION exception_name
| | {GENERATOR | SEQUENCE} sequence_name }
|
|<ddl_privileges> ::=
| {ALL [PRIVILEGES] | <ddl_privilege_list>} <object_type>
|
|<ddl_privilege_list> ::=
| <ddl_privilege> [, <ddl_privilege> ...]
|
|<ddl_privilege> ::= CREATE | ALTER ANY | DROP ANY
|
|<object_type> ::=
| CHARACTER SET | COLLATION | DOMAIN | EXCEPTION
| | FILTER | FUNCTION | GENERATOR | PACKAGE
| | PROCEDURE | ROLE | SEQUENCE | TABLE | VIEW
|
|<db_ddl_privileges> ::=
| {ALL [PRIVILEGES] | <db_ddl_privilege_list>} {DATABASE | SCHEMA}
|
|<db_ddl_privilege_list> ::=
| <db_ddl_privilege> [, <db_ddl_privilege> ...]
|
|<db_ddl_privilege> ::= CREATE | ALTER | DROP
|
|<grantee_list> ::= <grantee> [, <grantee> ...]
|
|<grantee> ::=
| PROCEDURE proc_name | FUNCTION func_name
| | PACKAGE package_name | TRIGGER trig_name
| | VIEW view_name | ROLE role_name
| | [USER] username | GROUP Unix_group
| | SYSTEM PRIVILEGE <sys_privilege>
|
|<sys_privilege> ::=
| !! See
CREATE ROLE
!!
Syntax (granting roles)
|
GRANT <role_granted_list>
| TO <role_grantee_list>
| [WITH ADMIN OPTION]
| [{GRANTED BY | AS} [USER] grantor]
|
|<role_granted_list> ::=
| <role_granted> [, <role_granted ...]
|
|<role_granted> ::= [DEFAULT] role_name
|
|<role_grantee_list> ::=
| <role_grantee> [, <role_grantee> ...]
|
|<role_grantee> ::=
| user_or_role_name
| | USER username
| | ROLE role_name
GRANT
Statement ParametersParameter | Description |
---|---|
grantor | The user granting the privilege(s) |
table_name | The name of a table |
view_name | The name of a view |
col | The name of table column |
proc_name | The name of a stored procedure |
func_name | The name of a stored function (or UDF) |
package_name | The name of a package |
exception_name | The name of an exception |
sequence_name | The name of a sequence (generator) |
object_type | The type of metadata object |
trig_name | The name of a trigger |
role_name | Role name |
username | The username to which the privileges are granted to or to which the role is assigned.
If the |
Unix_group | The name of a user group in a POSIX operating system |
sys_privilege | A system privilege |
user_or_role_name | Name of a user or role |
The GRANT
statement grants one or more privileges on database objects to users, roles, or other database objects.
A regular, authenticated user has no privileges on any database object until they are explicitly granted to that individual user, to a role granted to the user as a default role, or to all users bundled as the user PUBLIC
.
When an object is created, only its creator (the owner) and administrators have privileges to it, and can grant privileges to other users, roles, or objects.
Different sets of privileges apply to different types of metadata objects. The different types of privileges will be described separately later in this section.
SCHEMA
is currently a synonym for DATABASE
;
this may change in a future version, so we recommend to always use DATABASE
14.5.1.1. The TO
Clause
The TO
clause specifies the users, roles, and other database objects that are to be granted the privileges enumerated in privileges.
The clause is mandatory.
The optional USER
keyword in the TO
clause allow you to specify exactly who or what is granted the privilege.
If a USER
(or ROLE
) keyword is not specified, the server first checks for a role with this name and, if there is no such role, the privileges are granted to the user with that name without further checking.
It is recommended to always explicitly specify USER
and ROLE
to avoid ambiguity.
Future versions of Firebird may make USER
mandatory.
When a
GRANT
statement is executed, the security database is not checked for the existence of the grantee user. This is not a bug: SQL permissions are concerned with controlling data access for authenticated users, both native and trusted, and trusted operating system users are not stored in the security database.When granting a privilege to a database object other than user or role, such as a procedure, trigger or view, you must specify the object type.
Although the
USER
keyword is optional, it is advisable to use it, to avoid ambiguity with roles.Privileges granted to a system privilege will be applied when the user is logged in with a role that has that system privilege.
14.5.1.1.1. Packaging Privileges in a ROLE
Object
A role is a container
object that can be used to package a collection of privileges.
Use of the role is then granted to each user or role that requires those privileges.
A role can also be granted to a list of users or roles.
The role must exist before privileges can be granted to it.
See CREATE ROLE
for the syntax and rules.
The role is maintained by granting privileges to it and, when required, revoking privileges from it.
When a role is dropped — see DROP ROLE
— all users lose the privileges acquired through the role.
Any privileges that were granted additionally to an affected user by way of a different grant statement are retained.
Unless the role is granted as a default role, a user that is granted a role must explicitly specify that role, either with their login credentials or activating it using SET ROLE
, to exercise the associated privileges.
Any other privileges granted to the user or received through default roles are not affected by explicitly specifying a role.
More than one role can be granted to the same user. Although only one role can be explicitly specified, multiple roles can be active for a user, either as default roles, or as roles granted to the current role.
A role can be granted to a user or to another role.
14.5.1.1.2. Cumulative Roles
The ability to grant roles to other roles and default roles results in so-called cumulative roles. Multiple roles can be active for a user, and the user receives the cumulative privileges of all those roles.
When a role is explicitly specified on connect or using SET ROLE
, the user will assume all privileges granted to that role, including those privileges granted to the secondary roles (including roles granted on that secondary role, etc).
Or in other words, when the primary role is explicitly specified, the secondary roles are also activated.
The function RDB$ROLE_IN_USE
can be used to check if a role is currently active.
See also Section 14.5.1.1.3, “Default Roles” for the effects of DEFAULT
with cumulative roles, and Section 14.5.1.10.1, “The WITH ADMIN OPTION
Clause” for effects on granting.
14.5.1.1.3. Default Roles
A role can be granted as a default role by prefixing the role with DEFAULT
in the GRANT
statement.
Granting roles as a default role to users simplifies management of privileges, as this makes it possible to group privileges on a role and granting that group of privileges to a user without requiring the user to explicitly specify the role.
Users can receive multiple default roles, granting them all privileges of those default roles.
The effects of a default role depend on whether the role is granted to a user or to another role:
When a role is granted to a user as a default role, the role will be activated automatically, and its privileges will be applied to the user without the need to explicitly specify the role.
Roles that are active by default are not returned from
CURRENT_ROLE
, but the functionRDB$ROLE_IN_USE
can be used to check if a role is currently active.When a role is granted to another role as a default role, the rights of that role will only be automatically applied to the user if the primary role is granted as a default role to the user, otherwise the primary role needs to be specified explicitly (in other words, it behaves the same as when the secondary role was granted without the
DEFAULT
clause).For a linked list of granted roles, all roles need to be granted as a default role for them to be applied automatically. That is, for
GRANT DEFAULT ROLEA TO ROLE ROLEB
,GRANT ROLEB TO ROLE ROLEC
,GRANT DEFAULT ROLEC TO USER USER1
onlyROLEC
is active by default forUSER1
. To assume the privileges ofROLEA
andROLEB
,ROLEC
needs to be explicitly specified, orROLEB
needs to be grantedDEFAULT
toROLEC
.
14.5.1.1.4. The User PUBLIC
Firebird has a predefined user named PUBLIC
, that represents all users.
Privileges for operations on a particular object that are granted to the user PUBLIC
can be exercised by any authenticated user.
If privileges are granted to the user PUBLIC
, they should be revoked from the user PUBLIC
as well.
14.5.1.2. The WITH GRANT OPTION
Clause
The optional WITH GRANT OPTION
clause allows the users specified in the user list to grant the privileges specified in the privilege list to other users.
It is possible to assign this option to the user PUBLIC
.
Do not do this!
14.5.1.3. The GRANTED BY
Clause
By default, when privileges are granted in a database, the current user is recorded as the grantor.
The GRANTED BY
clause enables the current user to grant those privileges as another user.
When using the REVOKE
statement, it will fail if the current user is not the user that was named in the GRANTED BY
clause.
The GRANTED BY
(and AS
) clause can be used only by the database owner and other administrators.
The object owner cannot use GRANTED BY
unless they also have administrator privileges.
14.5.1.3.1. Alternative Syntax Using AS username
The non-standard AS
clause is supported as a synonym of the GRANTED BY
clause to simplify migration from other database systems.
14.5.1.4. Privileges on Tables and Views
For tables and views, unlike other metadata objects, it is possible to grant several privileges at once.
SELECT
Permits the user or object to
SELECT
data from the table or viewINSERT
Permits the user or object to
INSERT
rows into the table or viewDELETE
Permits the user or object to
DELETE
rows from the table or viewUPDATE
Permits the user or object to
UPDATE
rows in the table or view, optionally restricted to specific columnsREFERENCES
Permits the user or object to reference the table via a foreign key, optionally restricted to the specified columns. If the primary or unique key referenced by the foreign key of the other table is composite then all columns of the key must be specified.
ALL [PRIVILEGES]
Combines
SELECT
,INSERT
,UPDATE
,DELETE
andREFERENCES
privileges in a single package
14.5.1.4.1. Examples of GRANT <privilege>
on Tables
SELECT
andINSERT
privileges to the userALEX
:|
GRANT SELECT, INSERT ON TABLE SALES
|TO USER ALEX;
The
SELECT
privilege to theMANAGER
,ENGINEER
roles and to the userIVAN
:|
GRANT SELECT ON TABLE CUSTOMER
|TO ROLE MANAGER, ROLE ENGINEER, USER IVAN;
All privileges to the
ADMINISTRATOR
role, together with the authority to grant the same privileges to others:|
GRANT ALL ON TABLE CUSTOMER
|TO ROLE ADMINISTRATOR
|WITH GRANT OPTION;
The
SELECT
andREFERENCES
privileges on theNAME
column to all users and objects:|
GRANT SELECT, REFERENCES (NAME) ON TABLE COUNTRY
|TO PUBLIC;
The
SELECT
privilege being granted to the userIVAN
by the userALEX
:|
GRANT SELECT ON TABLE EMPLOYEE
|TO USER IVAN
|GRANTED BY ALEX;
Granting the
UPDATE
privilege on theFIRST_NAME
,LAST_NAME
columns:|
GRANT UPDATE (FIRST_NAME, LAST_NAME) ON TABLE EMPLOYEE
|TO USER IVAN;
Granting the
INSERT
privilege to the stored procedureADD_EMP_PROJ
:|
GRANT INSERT ON EMPLOYEE_PROJECT
|TO PROCEDURE ADD_EMP_PROJ;
14.5.1.5. The EXECUTE
Privilege
The EXECUTE
privilege applies to stored procedures, stored functions (including UDFs), and packages.
It allows the grantee to execute the specified object, and, if applicable, to retrieve its output.
In the case of selectable stored procedures, it acts somewhat like a SELECT
privilege, insofar as this style of stored procedure is executed in response to a SELECT
statement.
For packages, the EXECUTE
privilege can only be granted for the package as a whole, not for individual subroutines.
14.5.1.5.1. Examples of Granting the EXECUTE
Privilege
Granting the
EXECUTE
privilege on a stored procedure to a role:|
GRANT EXECUTE ON PROCEDURE ADD_EMP_PROJ
|TO ROLE MANAGER;
Granting the
EXECUTE
privilege on a stored function to a role:|
GRANT EXECUTE ON FUNCTION GET_BEGIN_DATE
|TO ROLE MANAGER;
Granting the
EXECUTE
privilege on a package to userPUBLIC
:|
GRANT EXECUTE ON PACKAGE APP_VAR
|TO USER PUBLIC;
Granting the
EXECUTE
privilege on a function to a package:|
GRANT EXECUTE ON FUNCTION GET_BEGIN_DATE
|TO PACKAGE APP_VAR;
14.5.1.6. The USAGE
Privilege
To be able to use metadata objects other than tables, views, stored procedures or functions, triggers and packages, it is necessary to grant the user (or database object like trigger, procedure or function) the USAGE
privilege on these objects.
By default, Firebird executes PSQL modules with the privileges of the caller, so it is necessary that either the user or otherwise the routine itself has been granted the USAGE
privilege.
This can be changed with the SQL SECURITY
clause of the DDL statements of those objects.
The USAGE
privilege is currently only available for exceptions and sequences (in gen_id(gen_name, n)
or next value for gen_name
).
Support for the USAGE
privilege for other metadata objects may be added in future releases.
For sequences (generators), the USAGE
privilege only grants the right to increment the sequence using the GEN_ID
function or NEXT VALUE FOR
.
The SET GENERATOR
statement is a synonym for ALTER SEQUENCE … RESTART WITH …
, and is considered a DDL statement.
By default, only the owner of the sequence and administrators have the rights to such operations.
The right to set the initial value of any sequence can be granted with GRANT ALTER ANY SEQUENCE
, which is not recommend for general users.
14.5.1.6.1. Examples of Granting the USAGE
Privilege
Granting the
USAGE
privilege on a sequence to a role:|
GRANT USAGE ON SEQUENCE GEN_AGE
|TO ROLE MANAGER;
Granting the
USAGE
privilege on a sequence to a trigger:|
GRANT USAGE ON SEQUENCE GEN_AGE
|TO TRIGGER TR_AGE_BI;
Granting the
USAGE
privilege on an exception to a package:|
GRANT USAGE ON EXCEPTION
|TO PACKAGE PKG_BILL;
14.5.1.7. DDL Privileges
By default, only administrators can create new metadata objects. Altering or dropping these objects is restricted to the owner of the object (its creator) and administrators. DDL privileges can be used to grant privileges for these operations to other users.
CREATE
Allows creation of an object of the specified type
ALTER ANY
Allows modification of any object of the specified type
DROP ANY
Allows deletion of any object of the specified type
ALL [PRIVILEGES]
Combines the
CREATE
,ALTER ANY
andDROP ANY
privileges for the specified type
There are no separate DDL privileges for triggers and indexes.
The necessary privileges are inherited from the table or view.
Creating, altering or dropping a trigger or index requires the ALTER ANY TABLE
or ALTER ANY VIEW
privilege.
14.5.1.7.1. Examples of Granting DDL Privileges
Allow user
JOE
to create tables|
GRANT CREATE TABLE
|TO USER Joe;
Allow user
JOE
to alter any procedure|
GRANT ALTER ANY PROCEDURE
|TO USER Joe;
14.5.1.8. Database DDL Privileges
The syntax for granting privileges to create, alter or drop a database deviates from the normal syntax of granting DDL privileges for other object types.
CREATE
Allows creation of a database
ALTER
Allows modification of the current database
DROP
Allows deletion of the current database
ALL [PRIVILEGES]
Combines the
ALTER
andDROP
privileges.ALL
does not include theCREATE
privilege.
The ALTER DATABASE
and DROP DATABASE
privileges apply only to the current database, whereas DDL privileges ALTER ANY
and DROP ANY
on other object types apply to all objects of the specified type in the current database.
The privilege to alter or drop the current database can only be granted by administrators.
The CREATE DATABASE
privilege is a special kind of privilege as it is saved in the security database.
A list of users with the CREATE DATABASE
privilege is available from the virtual table SEC$DB_CREATORS
.
Only administrators in the security database can grant the privilege to create a new database.
SCHEMA
is currently a synonym for DATABASE
;
this may change in a future version, so we recommend to always use DATABASE
14.5.1.9. Examples of Granting Database DDL Privileges
Granting
SUPERUSER
the privilege to create databases:|
GRANT CREATE DATABASE
|TO USER Superuser;
Granting
JOE
the privilege to executeALTER DATABASE
for the current database:|
GRANT ALTER DATABASE
|TO USER Joe;
Granting
FEDOR
the privilege to drop the current database:|
GRANT DROP DATABASE
|TO USER Fedor;
14.5.1.10. Assigning Roles
Assigning a role is similar to granting a privilege.
One or more roles can be assigned to one or more users, including the user PUBLIC
, using one GRANT
statement.
14.5.1.10.1. The WITH ADMIN OPTION
Clause
The optional WITH ADMIN OPTION
clause allows the users specified in the user list to grant the role(s) specified to other users or roles.
It is possible to assign this option to PUBLIC
.
Do not do this!
For cumulative roles, a user can only exercise the WITH ADMIN OPTION
of a secondary role if all intermediate roles are also granted WITH ADMIN OPTION
.
That is, GRANT ROLEA TO ROLE ROLEB WITH ADMIN OPTION
, GRANT ROLEB TO ROLE ROLEC
, GRANT ROLEC TO USER USER1 WITH ADMIN OPTION
only allows USER1
to grant ROLEC
to other users or roles, while using GRANT ROLEB TO ROLE ROLEC WITH ADMIN OPTION
allows USER1
to grant ROLEA
, ROLEB
and ROLEC
to other users.
14.5.1.10.2. Examples of Role Assignment
Assigning the
DIRECTOR
andMANAGER
roles to the userIVAN
:|
GRANT DIRECTOR, MANAGER
|TO USER IVAN;
Assigning the
MANAGER
role to the userALEX
with the authority to assign this role to other users:|
GRANT MANAGER
|TO USER ALEX WITH ADMIN OPTION;
Assigning the
DIRECTOR
role to userALEX
as a default role:|
GRANT DEFAULT DIRECTOR
|TO USER ALEX;
Assigning the
MANAGER
role to roleDIRECTOR
:|
GRANT MANAGER
|TO ROLE DIRECTOR;
See alsoREVOKE