Skip to content

Commit 377fe57

Browse files
committed
Config credentials: privilege -> permission
1 parent 8ce794e commit 377fe57

File tree

5 files changed

+83
-83
lines changed

5 files changed

+83
-83
lines changed

doc/book/admin/access_control.rst

Lines changed: 60 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -111,13 +111,13 @@ Privileges
111111

112112
The privileges granted to a user determine which operations the user can perform, for example:
113113

114-
* The ``read`` and ``write`` privileges granted to the ``space`` :ref:`object <access_control_concepts_objects>` allow a user to read or modify data in the specified space.
115-
* The ``create`` privilege granted to the ``space`` object allows a user to create new spaces.
116-
* The ``execute`` privilege granted to the ``function`` object allows a user to execute the specified function.
117-
* The ``session`` privilege granted to a user allows connecting to an instance over IPROTO.
114+
* The ``read`` and ``write`` permissions granted to the ``space`` :ref:`object <access_control_concepts_objects>` allow a user to read or modify data in the specified space.
115+
* The ``create`` permission granted to the ``space`` object allows a user to create new spaces.
116+
* The ``execute`` permission granted to the ``function`` object allows a user to execute the specified function.
117+
* The ``session`` permission granted to a user allows connecting to an instance over IPROTO.
118118

119119
Note that some privileges might require read and write access to certain system spaces.
120-
For example, the ``create`` privilege granted to the ``space`` object requires ``read`` and ``write`` privileges to the :ref:`_space <box_space-space>` system space.
120+
For example, the ``create`` permission granted to the ``space`` object requires ``read`` and ``write`` permissions to the :ref:`_space <box_space-space>` system space.
121121
Similarly, granting the ability to create functions requires ``read`` and ``write`` access to the :ref:`_func <box_space-func>` space.
122122

123123
.. NOTE::
@@ -286,7 +286,7 @@ Granting privileges to a user
286286
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
287287

288288
To grant the specified privileges to a user, use the :ref:`box.schema.user.grant() <box_schema-user_grant>` function.
289-
In the example below, ``testuser`` gets read privileges to the ``writers`` space and read/write privileges to the ``books`` space:
289+
In the example below, ``testuser`` gets read permissions to the ``writers`` space and read/write permissions to the ``books`` space:
290290

291291
.. literalinclude:: /code_snippets/test/access_control/grant_user_privileges_test.lua
292292
:language: lua
@@ -337,18 +337,18 @@ To get information about privileges granted to a user, call :ref:`box.schema.use
337337
338338
In the example above, ``testuser`` has the following privileges:
339339

340-
* The ``execute`` privilege to the ``public`` role means that this role is :ref:`assigned to the user <access_control_roles_granting_user>`.
340+
* The ``execute`` permission to the ``public`` role means that this role is :ref:`assigned to the user <access_control_roles_granting_user>`.
341341

342-
* The ``read`` privilege to the ``writers`` space means that the user can read data from this space.
342+
* The ``read`` permission to the ``writers`` space means that the user can read data from this space.
343343

344-
* The ``read,write`` privileges to the ``books`` space mean that the user can read and modify data in this space.
344+
* The ``read,write`` permissions to the ``books`` space mean that the user can read and modify data in this space.
345345

346-
* The ``session,usage`` privileges to ``universe`` mean the following:
346+
* The ``session,usage`` permissions to ``universe`` mean the following:
347347

348348
* ``session``: the user can authenticate over an IPROTO connection.
349349
* ``usage``: lets the user use their privileges on database objects (for example, read and modify data in a space).
350350

351-
* The ``alter`` privilege lets ``testuser`` modify its own settings, for example, a password.
351+
* The ``alter`` permission lets ``testuser`` modify its own settings, for example, a password.
352352

353353

354354

@@ -366,7 +366,7 @@ In the example below, write access to the ``books`` space is revoked:
366366
:end-before: End: Revoke space reading
367367
:dedent:
368368

369-
Revoking the ``session`` privilege from ``universe`` can be used to disallow a user to connect to a Tarantool instance:
369+
Revoking the ``session`` permission from ``universe`` can be used to disallow a user to connect to a Tarantool instance:
370370

371371
.. literalinclude:: /code_snippets/test/access_control/grant_user_privileges_test.lua
372372
:language: lua
@@ -455,15 +455,15 @@ Granting privileges to a role
455455
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
456456

457457
To grant the specified privileges to a role, use the :ref:`box.schema.role.grant() <box_schema-role_grant>` function.
458-
In the example below, the ``books_space_manager`` role gets read and write privileges to the ``books`` space:
458+
In the example below, the ``books_space_manager`` role gets read and write permissions to the ``books`` space:
459459

460460
.. literalinclude:: /code_snippets/test/access_control/grant_roles_test.lua
461461
:language: lua
462462
:start-after: Grant read/write privileges to a role
463463
:end-before: Grant write privileges to a role
464464
:dedent:
465465

466-
The ``writers_space_reader`` role gets read privileges to the ``writers`` space:
466+
The ``writers_space_reader`` role gets read permissions to the ``writers`` space:
467467

468468
.. literalinclude:: /code_snippets/test/access_control/grant_roles_test.lua
469469
:language: lua
@@ -534,7 +534,7 @@ To get information about privileges granted to a role, call :ref:`box.schema.rol
534534
- books
535535
--]]
536536
537-
If a role has the ``execute`` privilege to other roles, this means that these roles are :ref:`granted to this parent role <access_control_roles_granting_role>`:
537+
If a role has the ``execute`` permission to other roles, this means that these roles are :ref:`granted to this parent role <access_control_roles_granting_role>`:
538538

539539
.. code-block:: lua
540540
@@ -594,21 +594,21 @@ For example, the ``box.schema.user.grant()`` signature looks as follows:
594594

595595
.. code-block:: lua
596596
597-
box.schema.user.grant(username, privileges, object-type, object-name[, {options}])
597+
box.schema.user.grant(username, permissions, object-type, object-name[, {options}])
598598
599599
* ``username``: the name of the user that gets the specified privileges.
600-
* ``privileges``: a string value that represents :ref:`privileges <access_control_list_privileges>` granted to the user. If there are several privileges, they should be separated by commas without a space.
601-
* ``object-type``: a type of :ref:`object <access_control_list_objects>` to which privileges are granted.
602-
* ``object-name``: the name of the object to which privileges are granted.
603-
An empty string (``""``) or ``nil`` provided instead of ``object-name`` grants the specified privileges to all objects of the specified type.
600+
* ``permissions``: a string value that represents :ref:`permissions <access_control_list_privileges>` granted to the user. If there are several permissions, they should be separated by commas without a space.
601+
* ``object-type``: a type of :ref:`object <access_control_list_objects>` to which permissions are granted.
602+
* ``object-name``: the name of the object to which permissions are granted.
603+
An empty string (``""``) or ``nil`` provided instead of ``object-name`` grants the specified permissions to all objects of the specified type.
604604

605605
.. NOTE::
606606

607-
``object-name`` is ignored for the following combinations of privileges and object types:
607+
``object-name`` is ignored for the following combinations of permissions and object types:
608608

609-
* Any privilege granted to ``universe``.
610-
* The ``create`` and ``drop`` privileges for the following object types: ``user``, ``role``, ``space``, ``function``, ``sequence``.
611-
* The ``execute`` privilege for the following object types: ``lua_eval``, ``lua_call``, ``sql``.
609+
* Any permission granted to ``universe``.
610+
* The ``create`` and ``drop`` permissions for the following object types: ``user``, ``role``, ``space``, ``function``, ``sequence``.
611+
* The ``execute`` permission for the following object types: ``lua_eval``, ``lua_call``, ``sql``.
612612

613613

614614
.. _access_control_grant_creating_any_obj:
@@ -678,8 +678,8 @@ In the example below, ``testuser`` gets privileges allowing them to create :ref:
678678
box.schema.user.grant('testuser','read,write','space','_space_sequence')
679679
box.schema.user.grant('testuser','write', 'space', '_index')
680680
681-
To allow ``testuser`` to alter indexes in the 'writers' space, grant the privileges below.
682-
This example assumes that indexes in the 'writers' space are not created by ``testuser``.
681+
To allow ``testuser`` to alter indexes in the ``writers`` space, grant the permissions below.
682+
This example assumes that indexes in the ``writers`` space are not created by ``testuser``.
683683

684684
.. code-block:: lua
685685
@@ -689,7 +689,7 @@ This example assumes that indexes in the 'writers' space are not created by ``te
689689
box.schema.user.grant('testuser','read','space','_space_sequence')
690690
box.schema.user.grant('testuser','write','space','_index')
691691
692-
If ``testuser`` created indexes in the 'writers' space, granting the following privileges is enough to alter indexes:
692+
If ``testuser`` created indexes in the ``writers`` space, granting the following permissions is enough to alter indexes:
693693

694694
.. code-block:: lua
695695
@@ -791,7 +791,7 @@ To let ``testuser`` drop a function, grant them the following privileges:
791791
Executing functions
792792
*******************
793793

794-
To give the ability to execute a function named 'sum', grant the following privileges:
794+
To give the ability to execute a function named 'sum', grant the following permissions:
795795

796796
.. code-block:: lua
797797
@@ -899,8 +899,8 @@ Whenever ``public_user`` calls the function, it is executed on behalf of its cre
899899

900900
.. _access_control_list:
901901

902-
All object types and privileges
903-
-------------------------------
902+
All object types and permissions
903+
--------------------------------
904904

905905
.. _access_control_list_objects:
906906

@@ -938,48 +938,48 @@ Object types
938938

939939
.. _access_control_list_privileges:
940940

941-
Privileges
942-
~~~~~~~~~~
941+
Permissions
942+
~~~~~~~~~~~
943943

944944
.. container:: table
945945

946946
.. list-table::
947947
:header-rows: 1
948948
:widths: 15 15 15 55
949949

950-
* - Privilege
950+
* - Permission
951951
- Object type
952952
- Granted to roles
953953
- Description
954954
* - ``read``
955955
- All
956956
- Yes
957957
- Allows reading data of the specified object.
958-
For example, this privilege can be used to allow a user to select data from the specified space.
958+
For example, this permission can be used to allow a user to select data from the specified space.
959959
* - ``write``
960960
- All
961961
- Yes
962962
- Allows updating data of the specified object.
963-
For example, this privilege can be used to allow a user to modify data in the specified space.
963+
For example, this permission can be used to allow a user to modify data in the specified space.
964964
* - ``create``
965965
- All
966966
- Yes
967967
- Allows creating objects of the specified type.
968-
For example, this privilege can be used to allow a user to create new spaces.
968+
For example, this permission can be used to allow a user to create new spaces.
969969

970-
Note that this privilege requires read and write access to certain system spaces.
970+
Note that this permission requires read and write access to certain system spaces.
971971
* - ``alter``
972972
- All
973973
- Yes
974974
- Allows altering objects of the specified type.
975975

976-
Note that this privilege requires read and write access to certain system spaces.
976+
Note that this permission requires read and write access to certain system spaces.
977977
* - ``drop``
978978
- All
979979
- Yes
980980
- Allows dropping objects of the specified type.
981981

982-
Note that this privilege requires read and write access to certain system spaces.
982+
Note that this permission requires read and write access to certain system spaces.
983983
* - ``execute``
984984
- ``role``, ``universe``, ``function``, ``lua_eval``, ``lua_call``, ``sql``
985985
- Yes
@@ -997,8 +997,8 @@ Privileges
997997

998998
.. _access_control_list_objects_and_privileges:
999999

1000-
Object types and privileges
1001-
~~~~~~~~~~~~~~~~~~~~~~~~~~~
1000+
Object types and permissions
1001+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10021002

10031003
.. container:: table
10041004

@@ -1015,58 +1015,58 @@ Object types and privileges
10151015
* ``session``: Allows a user to connect to an instance over IPROTO.
10161016
* ``usage``: Allows a user to use their privileges on database objects (for example, read, write, and alter space).
10171017
* ``create``: Allows creating users, roles, functions, spaces, and sequences.
1018-
This privilege requires read and write access to certain system spaces.
1018+
This permission requires read and write access to certain system spaces.
10191019
* ``drop``: Allows creating users, roles, functions, spaces, and sequences.
1020-
This privilege requires read and write access to certain system spaces.
1020+
This permission requires read and write access to certain system spaces.
10211021
* ``alter``: Allows altering user settings or space objects.
10221022
* - ``user``
10231023
- * ``alter``: Allows modifying a user description, for example, change the password.
10241024
* ``create``: Allows creating new users.
1025-
This privilege requires read and write access to the ``_user`` system space.
1025+
This permission requires read and write access to the ``_user`` system space.
10261026
* ``drop``: Allows dropping users.
1027-
This privilege requires read and write access to the ``_user`` system space.
1027+
This permission requires read and write access to the ``_user`` system space.
10281028
* - ``role``
10291029
- * ``execute``: Indicates that a role is assigned to the user or another role.
10301030
* ``create``: Allows creating new roles.
1031-
This privilege requires read and write access to the ``_user`` system space.
1031+
This permission requires read and write access to the ``_user`` system space.
10321032
* ``drop``: Allows dropping roles.
1033-
This privilege requires read and write access to the ``_user`` system space.
1033+
This permission requires read and write access to the ``_user`` system space.
10341034
* - ``space``
10351035
- * ``read``: Allows selecting data from a space.
10361036
* ``write``: Allows modifying data in a space.
10371037
* ``create``: Allows creating new spaces.
1038-
This privilege requires read and write access to the ``_space`` system space.
1038+
This permission requires read and write access to the ``_space`` system space.
10391039
* ``drop``: Allows dropping spaces.
1040-
This privilege requires read and write access to the ``_space`` system space.
1040+
This permission requires read and write access to the ``_space`` system space.
10411041
* ``alter``: Allows modifying spaces.
1042-
This privilege requires read and write access to the ``_space`` system space.
1042+
This permission requires read and write access to the ``_space`` system space.
10431043

1044-
If a space is created by a user, they can read and write it without granting explicit privileges.
1044+
If a space is created by a user, they can read and write it without granting explicit permission.
10451045
* - ``function``
10461046
- * ``execute``: Allows calling a function.
10471047
* ``create``: Allows creating a function.
1048-
This privilege requires read and write access to the ``_func`` system space.
1048+
This permission requires read and write access to the ``_func`` system space.
10491049

1050-
If a function is created by a user, they can execute it without granting explicit privileges.
1050+
If a function is created by a user, they can execute it without granting explicit permission.
10511051
* ``drop``: Allows dropping a function.
1052-
This privilege requires read and write access to the ``_func`` system space.
1052+
This permission requires read and write access to the ``_func`` system space.
10531053
* - ``sequence``
10541054
- * ``read``: Allows using sequences in ``space_obj:create_index()``.
10551055
* ``write``: Allows all operations for a sequence object.
10561056

1057-
``seq_obj:drop()`` requires a write privilege to the ``_priv`` system space.
1057+
``seq_obj:drop()`` requires a write permission to the ``_priv`` system space.
10581058
* ``create``: Allows creating sequences.
1059-
This privilege requires read and write access to the ``_sequence`` system space.
1059+
This permission requires read and write access to the ``_sequence`` system space.
10601060

1061-
If a sequence is created by a user, they can read/write it without explicit privilege.
1061+
If a sequence is created by a user, they can read/write it without explicit permission.
10621062
* ``drop``: Allows dropping sequences.
1063-
This privilege requires read and write access to the ``_sequence`` system space.
1063+
This permission requires read and write access to the ``_sequence`` system space.
10641064
* ``alter``: Has no effect.
1065-
``seq_obj:alter()`` and other methods require the ``write`` privilege.
1065+
``seq_obj:alter()`` and other methods require the ``write`` permission.
10661066
* - ``lua_eval``
10671067
- * ``execute``: Allows executing arbitrary Lua code using the IPROTO_EVAL request.
10681068
* - ``lua_call``
10691069
- * ``execute``: Allows executing any user-defined function using the IPROTO_CALL request.
1070-
This privilege doesn't allow a user to call built-in Lua functions (for example, ``loadstring()`` or ``box.session.su()``) and functions defined in the ``_func`` system space.
1070+
This permission doesn't allow a user to call built-in Lua functions (for example, ``loadstring()`` or ``box.session.su()``) and functions defined in the ``_func`` system space.
10711071
* - ``sql``
10721072
- * ``execute``: Allows executing arbitrary SQL expression using the IPROTO_PREPARE and IPROTO_EXECUTE requests.

0 commit comments

Comments
 (0)