summaryrefslogtreecommitdiff
path: root/doc/src/sgml/user-manag.sgml
diff options
context:
space:
mode:
authorTom Lane2019-08-27 22:03:09 +0000
committerTom Lane2019-08-27 22:03:09 +0000
commit458f01e254e0f0b1ccab8e4589aa8495781a933a (patch)
treeeb3d98d38f97a50bb4320be9c22536cd7b0ef8d6 /doc/src/sgml/user-manag.sgml
parentc9bd7f4f2b0fc3b8291914a45cbf2a5270877ee6 (diff)
Doc: improve documentation of pg_signal_backend default role.
Give it an explanatory para like the other default roles have. Don't imply that it can send any signal whatever. In passing, reorder the table entries and explanatory paras for the default roles into some semblance of consistency. Ian Barwick, tweaked a bit by me. Discussion: https://postgr.es/m/[email protected]
Diffstat (limited to 'doc/src/sgml/user-manag.sgml')
-rw-r--r--doc/src/sgml/user-manag.sgml49
1 files changed, 29 insertions, 20 deletions
diff --git a/doc/src/sgml/user-manag.sgml b/doc/src/sgml/user-manag.sgml
index 6106244d324..66f162703dd 100644
--- a/doc/src/sgml/user-manag.sgml
+++ b/doc/src/sgml/user-manag.sgml
@@ -531,8 +531,15 @@ DROP ROLE doomed_role;
potentially for a long time.</entry>
</row>
<row>
+ <entry>pg_monitor</entry>
+ <entry>Read/execute various monitoring views and functions.
+ This role is a member of <literal>pg_read_all_settings</literal>,
+ <literal>pg_read_all_stats</literal> and
+ <literal>pg_stat_scan_tables</literal>.</entry>
+ </row>
+ <row>
<entry>pg_signal_backend</entry>
- <entry>Send signals to other backends (eg: cancel query, terminate).</entry>
+ <entry>Signal another backend to cancel a query or terminate its session.</entry>
</row>
<row>
<entry>pg_read_server_files</entry>
@@ -549,28 +556,11 @@ DROP ROLE doomed_role;
<entry>Allow executing programs on the database server as the user the database runs as with
COPY and other functions which allow executing a server-side program.</entry>
</row>
- <row>
- <entry>pg_monitor</entry>
- <entry>Read/execute various monitoring views and functions.
- This role is a member of <literal>pg_read_all_settings</literal>,
- <literal>pg_read_all_stats</literal> and
- <literal>pg_stat_scan_tables</literal>.</entry>
- </row>
</tbody>
</tgroup>
</table>
<para>
- The <literal>pg_read_server_files</literal>, <literal>pg_write_server_files</literal> and
- <literal>pg_execute_server_program</literal> roles are intended to allow administrators to have
- trusted, but non-superuser, roles which are able to access files and run programs on the
- database server as the user the database runs as. As these roles are able to access any file on
- the server file system, they bypass all database-level permission checks when accessing files
- directly and they could be used to gain superuser-level access, therefore care should be taken
- when granting these roles to users.
- </para>
-
- <para>
The <literal>pg_monitor</literal>, <literal>pg_read_all_settings</literal>,
<literal>pg_read_all_stats</literal> and <literal>pg_stat_scan_tables</literal>
roles are intended to allow administrators to easily configure a role for the
@@ -580,14 +570,33 @@ DROP ROLE doomed_role;
</para>
<para>
+ The <literal>pg_signal_backend</literal> role is intended to allow
+ administrators to enable trusted, but non-superuser, roles to send signals
+ to other backends. Currently this role enables sending of signals for
+ canceling a query on another backend or terminating its session. A user
+ granted this role cannot however send signals to a backend owned by a
+ superuser. See <xref linkend="functions-admin-signal"/>.
+ </para>
+
+ <para>
+ The <literal>pg_read_server_files</literal>, <literal>pg_write_server_files</literal> and
+ <literal>pg_execute_server_program</literal> roles are intended to allow administrators to have
+ trusted, but non-superuser, roles which are able to access files and run programs on the
+ database server as the user the database runs as. As these roles are able to access any file on
+ the server file system, they bypass all database-level permission checks when accessing files
+ directly and they could be used to gain superuser-level access, therefore
+ great care should be taken when granting these roles to users.
+ </para>
+
+ <para>
Care should be taken when granting these roles to ensure they are only used where
needed and with the understanding that these roles grant access to privileged
information.
</para>
<para>
- Administrators can grant access to these roles to users using the GRANT
- command:
+ Administrators can grant access to these roles to users using the
+ <xref linkend="sql-grant"/> command, for example:
<programlisting>
GRANT pg_signal_backend TO admin_user;