2005-07-27 01:24:02 +02:00
|
|
|
<!--
|
2010-09-20 22:08:53 +02:00
|
|
|
doc/src/sgml/ref/create_role.sgml
|
2005-07-27 01:24:02 +02:00
|
|
|
PostgreSQL documentation
|
|
|
|
-->
|
|
|
|
|
|
|
|
<refentry id="SQL-CREATEROLE">
|
2014-02-24 03:25:35 +01:00
|
|
|
<indexterm zone="sql-createrole">
|
|
|
|
<primary>CREATE ROLE</primary>
|
|
|
|
</indexterm>
|
|
|
|
|
2005-07-27 01:24:02 +02:00
|
|
|
<refmeta>
|
2010-04-03 09:23:02 +02:00
|
|
|
<refentrytitle>CREATE ROLE</refentrytitle>
|
2008-11-14 11:22:48 +01:00
|
|
|
<manvolnum>7</manvolnum>
|
2005-07-27 01:24:02 +02:00
|
|
|
<refmiscinfo>SQL - Language Statements</refmiscinfo>
|
|
|
|
</refmeta>
|
|
|
|
|
|
|
|
<refnamediv>
|
|
|
|
<refname>CREATE ROLE</refname>
|
|
|
|
<refpurpose>define a new database role</refpurpose>
|
|
|
|
</refnamediv>
|
|
|
|
|
|
|
|
<refsynopsisdiv>
|
|
|
|
<synopsis>
|
|
|
|
CREATE ROLE <replaceable class="PARAMETER">name</replaceable> [ [ WITH ] <replaceable class="PARAMETER">option</replaceable> [ ... ] ]
|
|
|
|
|
2009-09-18 07:00:42 +02:00
|
|
|
<phrase>where <replaceable class="PARAMETER">option</replaceable> can be:</phrase>
|
2010-11-23 21:27:50 +01:00
|
|
|
|
2005-07-27 01:24:02 +02:00
|
|
|
SUPERUSER | NOSUPERUSER
|
|
|
|
| CREATEDB | NOCREATEDB
|
|
|
|
| CREATEROLE | NOCREATEROLE
|
|
|
|
| INHERIT | NOINHERIT
|
|
|
|
| LOGIN | NOLOGIN
|
2010-12-29 11:05:03 +01:00
|
|
|
| REPLICATION | NOREPLICATION
|
Row-Level Security Policies (RLS)
Building on the updatable security-barrier views work, add the
ability to define policies on tables to limit the set of rows
which are returned from a query and which are allowed to be added
to a table. Expressions defined by the policy for filtering are
added to the security barrier quals of the query, while expressions
defined to check records being added to a table are added to the
with-check options of the query.
New top-level commands are CREATE/ALTER/DROP POLICY and are
controlled by the table owner. Row Security is able to be enabled
and disabled by the owner on a per-table basis using
ALTER TABLE .. ENABLE/DISABLE ROW SECURITY.
Per discussion, ROW SECURITY is disabled on tables by default and
must be enabled for policies on the table to be used. If no
policies exist on a table with ROW SECURITY enabled, a default-deny
policy is used and no records will be visible.
By default, row security is applied at all times except for the
table owner and the superuser. A new GUC, row_security, is added
which can be set to ON, OFF, or FORCE. When set to FORCE, row
security will be applied even for the table owner and superusers.
When set to OFF, row security will be disabled when allowed and an
error will be thrown if the user does not have rights to bypass row
security.
Per discussion, pg_dump sets row_security = OFF by default to ensure
that exports and backups will have all data in the table or will
error if there are insufficient privileges to bypass row security.
A new option has been added to pg_dump, --enable-row-security, to
ask pg_dump to export with row security enabled.
A new role capability, BYPASSRLS, which can only be set by the
superuser, is added to allow other users to be able to bypass row
security using row_security = OFF.
Many thanks to the various individuals who have helped with the
design, particularly Robert Haas for his feedback.
Authors include Craig Ringer, KaiGai Kohei, Adam Brightwell, Dean
Rasheed, with additional changes and rework by me.
Reviewers have included all of the above, Greg Smith,
Jeff McCormick, and Robert Haas.
2014-09-19 17:18:35 +02:00
|
|
|
| BYPASSRLS | NOBYPASSRLS
|
2005-07-31 19:19:22 +02:00
|
|
|
| CONNECTION LIMIT <replaceable class="PARAMETER">connlimit</replaceable>
|
Remove support for password_encryption='off' / 'plain'.
Storing passwords in plaintext hasn't been a good idea for a very long
time, if ever. Now seems like a good time to finally forbid it, since we're
messing with this in PostgreSQL 10 anyway.
Remove the CREATE/ALTER USER UNENCRYPTED PASSSWORD 'foo' syntax, since
storing passwords unencrypted is no longer supported. ENCRYPTED PASSWORD
'foo' is still accepted, but ENCRYPTED is now just a noise-word, it does
the same as just PASSWORD 'foo'.
Likewise, remove the --unencrypted option from createuser, but accept
--encrypted as a no-op for backward compatibility. AFAICS, --encrypted was
a no-op even before this patch, because createuser encrypted the password
before sending it to the server even if --encrypted was not specified. It
added the ENCRYPTED keyword to the SQL command, but since the password was
already in encrypted form, it didn't make any difference. The documentation
was not clear on whether that was intended or not, but it's moot now.
Also, while password_encryption='on' is still accepted as an alias for
'md5', it is now marked as hidden, so that it is not listed as an accepted
value in error hints, for example. That's not directly related to removing
'plain', but it seems better this way.
Reviewed by Michael Paquier
Discussion: https://www.postgresql.org/message-id/16e9b768-fd78-0b12-cfc1-7b6b7f238fde@iki.fi
2017-05-08 10:26:07 +02:00
|
|
|
| [ ENCRYPTED ] PASSWORD '<replaceable class="PARAMETER">password</replaceable>'
|
2010-11-23 21:27:50 +01:00
|
|
|
| VALID UNTIL '<replaceable class="PARAMETER">timestamp</replaceable>'
|
2009-09-19 12:23:27 +02:00
|
|
|
| IN ROLE <replaceable class="PARAMETER">role_name</replaceable> [, ...]
|
|
|
|
| IN GROUP <replaceable class="PARAMETER">role_name</replaceable> [, ...]
|
|
|
|
| ROLE <replaceable class="PARAMETER">role_name</replaceable> [, ...]
|
|
|
|
| ADMIN <replaceable class="PARAMETER">role_name</replaceable> [, ...]
|
|
|
|
| USER <replaceable class="PARAMETER">role_name</replaceable> [, ...]
|
2010-11-23 21:27:50 +01:00
|
|
|
| SYSID <replaceable class="PARAMETER">uid</replaceable>
|
2005-07-27 01:24:02 +02:00
|
|
|
</synopsis>
|
|
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Description</title>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
<command>CREATE ROLE</command> adds a new role to a
|
|
|
|
<productname>PostgreSQL</productname> database cluster. A role is
|
|
|
|
an entity that can own database objects and have database privileges;
|
|
|
|
a role can be considered a <quote>user</>, a <quote>group</>, or both
|
|
|
|
depending on how it is used. Refer to
|
|
|
|
<xref linkend="user-manag"> and <xref
|
|
|
|
linkend="client-authentication"> for information about managing
|
|
|
|
users and authentication. You must have <literal>CREATEROLE</>
|
|
|
|
privilege or be a database superuser to use this command.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
Note that roles are defined at the database cluster
|
|
|
|
level, and so are valid in all databases in the cluster.
|
|
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Parameters</title>
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
|
|
<term><replaceable class="parameter">name</replaceable></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The name of the new role.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>SUPERUSER</literal></term>
|
|
|
|
<term><literal>NOSUPERUSER</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
These clauses determine whether the new role is a <quote>superuser</>,
|
|
|
|
who can override all access restrictions within the database.
|
|
|
|
Superuser status is dangerous and should be used only when really
|
|
|
|
needed. You must yourself be a superuser to create a new superuser.
|
|
|
|
If not specified,
|
|
|
|
<literal>NOSUPERUSER</literal> is the default.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>CREATEDB</></term>
|
|
|
|
<term><literal>NOCREATEDB</></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
These clauses define a role's ability to create databases. If
|
|
|
|
<literal>CREATEDB</literal> is specified, the role being
|
|
|
|
defined will be allowed to create new databases. Specifying
|
|
|
|
<literal>NOCREATEDB</literal> will deny a role the ability to
|
|
|
|
create databases. If not specified,
|
|
|
|
<literal>NOCREATEDB</literal> is the default.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>CREATEROLE</literal></term>
|
|
|
|
<term><literal>NOCREATEROLE</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
These clauses determine whether a role will be permitted to
|
2005-11-03 01:51:43 +01:00
|
|
|
create new roles (that is, execute <command>CREATE ROLE</command>).
|
2005-07-27 01:24:02 +02:00
|
|
|
A role with <literal>CREATEROLE</literal> privilege can also alter
|
|
|
|
and drop other roles.
|
|
|
|
If not specified,
|
|
|
|
<literal>NOCREATEROLE</literal> is the default.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>INHERIT</literal></term>
|
|
|
|
<term><literal>NOINHERIT</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
These clauses determine whether a role <quote>inherits</> the
|
|
|
|
privileges of roles it is a member of.
|
2005-08-15 01:35:38 +02:00
|
|
|
A role with the <literal>INHERIT</literal> attribute can automatically
|
2005-07-27 01:24:02 +02:00
|
|
|
use whatever database privileges have been granted to all roles
|
|
|
|
it is directly or indirectly a member of.
|
|
|
|
Without <literal>INHERIT</literal>, membership in another role
|
|
|
|
only grants the ability to <command>SET ROLE</> to that other role;
|
|
|
|
the privileges of the other role are only available after having
|
|
|
|
done so.
|
|
|
|
If not specified,
|
|
|
|
<literal>INHERIT</literal> is the default.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>LOGIN</literal></term>
|
|
|
|
<term><literal>NOLOGIN</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
These clauses determine whether a role is allowed to log in;
|
|
|
|
that is, whether the role can be given as the initial session
|
|
|
|
authorization name during client connection. A role having
|
2005-08-15 01:35:38 +02:00
|
|
|
the <literal>LOGIN</literal> attribute can be thought of as a user.
|
2005-07-27 01:24:02 +02:00
|
|
|
Roles without this attribute are useful for managing database
|
|
|
|
privileges, but are not users in the usual sense of the word.
|
|
|
|
If not specified,
|
|
|
|
<literal>NOLOGIN</literal> is the default, except when
|
2007-11-07 13:24:24 +01:00
|
|
|
<command>CREATE ROLE</> is invoked through its alternative spelling
|
2011-10-10 19:38:32 +02:00
|
|
|
<xref linkend="sql-createuser">.
|
2005-07-27 01:24:02 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2010-12-29 11:05:03 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><literal>REPLICATION</literal></term>
|
|
|
|
<term><literal>NOREPLICATION</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
These clauses determine whether a role is allowed to initiate
|
|
|
|
streaming replication or put the system in and out of backup mode.
|
|
|
|
A role having the <literal>REPLICATION</> attribute is a very
|
|
|
|
highly privileged role, and should only be used on roles actually
|
2010-12-30 21:15:55 +01:00
|
|
|
used for replication. If not specified,
|
2012-01-14 17:22:16 +01:00
|
|
|
<literal>NOREPLICATION</literal> is the default.
|
2010-12-29 11:05:03 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
Row-Level Security Policies (RLS)
Building on the updatable security-barrier views work, add the
ability to define policies on tables to limit the set of rows
which are returned from a query and which are allowed to be added
to a table. Expressions defined by the policy for filtering are
added to the security barrier quals of the query, while expressions
defined to check records being added to a table are added to the
with-check options of the query.
New top-level commands are CREATE/ALTER/DROP POLICY and are
controlled by the table owner. Row Security is able to be enabled
and disabled by the owner on a per-table basis using
ALTER TABLE .. ENABLE/DISABLE ROW SECURITY.
Per discussion, ROW SECURITY is disabled on tables by default and
must be enabled for policies on the table to be used. If no
policies exist on a table with ROW SECURITY enabled, a default-deny
policy is used and no records will be visible.
By default, row security is applied at all times except for the
table owner and the superuser. A new GUC, row_security, is added
which can be set to ON, OFF, or FORCE. When set to FORCE, row
security will be applied even for the table owner and superusers.
When set to OFF, row security will be disabled when allowed and an
error will be thrown if the user does not have rights to bypass row
security.
Per discussion, pg_dump sets row_security = OFF by default to ensure
that exports and backups will have all data in the table or will
error if there are insufficient privileges to bypass row security.
A new option has been added to pg_dump, --enable-row-security, to
ask pg_dump to export with row security enabled.
A new role capability, BYPASSRLS, which can only be set by the
superuser, is added to allow other users to be able to bypass row
security using row_security = OFF.
Many thanks to the various individuals who have helped with the
design, particularly Robert Haas for his feedback.
Authors include Craig Ringer, KaiGai Kohei, Adam Brightwell, Dean
Rasheed, with additional changes and rework by me.
Reviewers have included all of the above, Greg Smith,
Jeff McCormick, and Robert Haas.
2014-09-19 17:18:35 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><literal>BYPASSRLS</literal></term>
|
|
|
|
<term><literal>NOBYPASSRLS</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2015-10-04 02:19:57 +02:00
|
|
|
These clauses determine whether a role bypasses every row-level
|
|
|
|
security (RLS) policy. <literal>NOBYPASSRLS</literal> is the default.
|
Row-Level Security Policies (RLS)
Building on the updatable security-barrier views work, add the
ability to define policies on tables to limit the set of rows
which are returned from a query and which are allowed to be added
to a table. Expressions defined by the policy for filtering are
added to the security barrier quals of the query, while expressions
defined to check records being added to a table are added to the
with-check options of the query.
New top-level commands are CREATE/ALTER/DROP POLICY and are
controlled by the table owner. Row Security is able to be enabled
and disabled by the owner on a per-table basis using
ALTER TABLE .. ENABLE/DISABLE ROW SECURITY.
Per discussion, ROW SECURITY is disabled on tables by default and
must be enabled for policies on the table to be used. If no
policies exist on a table with ROW SECURITY enabled, a default-deny
policy is used and no records will be visible.
By default, row security is applied at all times except for the
table owner and the superuser. A new GUC, row_security, is added
which can be set to ON, OFF, or FORCE. When set to FORCE, row
security will be applied even for the table owner and superusers.
When set to OFF, row security will be disabled when allowed and an
error will be thrown if the user does not have rights to bypass row
security.
Per discussion, pg_dump sets row_security = OFF by default to ensure
that exports and backups will have all data in the table or will
error if there are insufficient privileges to bypass row security.
A new option has been added to pg_dump, --enable-row-security, to
ask pg_dump to export with row security enabled.
A new role capability, BYPASSRLS, which can only be set by the
superuser, is added to allow other users to be able to bypass row
security using row_security = OFF.
Many thanks to the various individuals who have helped with the
design, particularly Robert Haas for his feedback.
Authors include Craig Ringer, KaiGai Kohei, Adam Brightwell, Dean
Rasheed, with additional changes and rework by me.
Reviewers have included all of the above, Greg Smith,
Jeff McCormick, and Robert Haas.
2014-09-19 17:18:35 +02:00
|
|
|
Note that pg_dump will set <literal>row_security</literal> to
|
|
|
|
<literal>OFF</literal> by default, to ensure all contents of a table are
|
|
|
|
dumped out. If the user running pg_dump does not have appropriate
|
|
|
|
permissions, an error will be returned. The superuser and owner of the
|
2015-10-04 02:19:57 +02:00
|
|
|
table being dumped always bypass RLS.
|
Row-Level Security Policies (RLS)
Building on the updatable security-barrier views work, add the
ability to define policies on tables to limit the set of rows
which are returned from a query and which are allowed to be added
to a table. Expressions defined by the policy for filtering are
added to the security barrier quals of the query, while expressions
defined to check records being added to a table are added to the
with-check options of the query.
New top-level commands are CREATE/ALTER/DROP POLICY and are
controlled by the table owner. Row Security is able to be enabled
and disabled by the owner on a per-table basis using
ALTER TABLE .. ENABLE/DISABLE ROW SECURITY.
Per discussion, ROW SECURITY is disabled on tables by default and
must be enabled for policies on the table to be used. If no
policies exist on a table with ROW SECURITY enabled, a default-deny
policy is used and no records will be visible.
By default, row security is applied at all times except for the
table owner and the superuser. A new GUC, row_security, is added
which can be set to ON, OFF, or FORCE. When set to FORCE, row
security will be applied even for the table owner and superusers.
When set to OFF, row security will be disabled when allowed and an
error will be thrown if the user does not have rights to bypass row
security.
Per discussion, pg_dump sets row_security = OFF by default to ensure
that exports and backups will have all data in the table or will
error if there are insufficient privileges to bypass row security.
A new option has been added to pg_dump, --enable-row-security, to
ask pg_dump to export with row security enabled.
A new role capability, BYPASSRLS, which can only be set by the
superuser, is added to allow other users to be able to bypass row
security using row_security = OFF.
Many thanks to the various individuals who have helped with the
design, particularly Robert Haas for his feedback.
Authors include Craig Ringer, KaiGai Kohei, Adam Brightwell, Dean
Rasheed, with additional changes and rework by me.
Reviewers have included all of the above, Greg Smith,
Jeff McCormick, and Robert Haas.
2014-09-19 17:18:35 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2005-07-31 19:19:22 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><literal>CONNECTION LIMIT</literal> <replaceable class="parameter">connlimit</replaceable></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
If role can log in, this specifies how many concurrent connections
|
2017-02-01 23:52:35 +01:00
|
|
|
the role can make. -1 (the default) means no limit. Note that only
|
|
|
|
normal connections are counted towards this limit. Neither prepared
|
|
|
|
transactions nor background worker connections are counted towards
|
|
|
|
this limit.
|
2005-07-31 19:19:22 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2005-07-27 01:24:02 +02:00
|
|
|
<varlistentry>
|
Remove support for password_encryption='off' / 'plain'.
Storing passwords in plaintext hasn't been a good idea for a very long
time, if ever. Now seems like a good time to finally forbid it, since we're
messing with this in PostgreSQL 10 anyway.
Remove the CREATE/ALTER USER UNENCRYPTED PASSSWORD 'foo' syntax, since
storing passwords unencrypted is no longer supported. ENCRYPTED PASSWORD
'foo' is still accepted, but ENCRYPTED is now just a noise-word, it does
the same as just PASSWORD 'foo'.
Likewise, remove the --unencrypted option from createuser, but accept
--encrypted as a no-op for backward compatibility. AFAICS, --encrypted was
a no-op even before this patch, because createuser encrypted the password
before sending it to the server even if --encrypted was not specified. It
added the ENCRYPTED keyword to the SQL command, but since the password was
already in encrypted form, it didn't make any difference. The documentation
was not clear on whether that was intended or not, but it's moot now.
Also, while password_encryption='on' is still accepted as an alias for
'md5', it is now marked as hidden, so that it is not listed as an accepted
value in error hints, for example. That's not directly related to removing
'plain', but it seems better this way.
Reviewed by Michael Paquier
Discussion: https://www.postgresql.org/message-id/16e9b768-fd78-0b12-cfc1-7b6b7f238fde@iki.fi
2017-05-08 10:26:07 +02:00
|
|
|
<term>[ <literal>ENCRYPTED</> ] <literal>PASSWORD</> <replaceable class="parameter">password</replaceable></term>
|
2005-07-27 01:24:02 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Sets the role's password. (A password is only of use for
|
2005-12-23 17:46:39 +01:00
|
|
|
roles having the <literal>LOGIN</literal> attribute, but you
|
|
|
|
can nonetheless define one for roles without it.) If you do
|
|
|
|
not plan to use password authentication you can omit this
|
|
|
|
option. If no password is specified, the password will be set
|
|
|
|
to null and password authentication will always fail for that
|
|
|
|
user. A null password can optionally be written explicitly as
|
|
|
|
<literal>PASSWORD NULL</literal>.
|
2005-07-27 01:24:02 +02:00
|
|
|
</para>
|
|
|
|
<para>
|
Remove support for password_encryption='off' / 'plain'.
Storing passwords in plaintext hasn't been a good idea for a very long
time, if ever. Now seems like a good time to finally forbid it, since we're
messing with this in PostgreSQL 10 anyway.
Remove the CREATE/ALTER USER UNENCRYPTED PASSSWORD 'foo' syntax, since
storing passwords unencrypted is no longer supported. ENCRYPTED PASSWORD
'foo' is still accepted, but ENCRYPTED is now just a noise-word, it does
the same as just PASSWORD 'foo'.
Likewise, remove the --unencrypted option from createuser, but accept
--encrypted as a no-op for backward compatibility. AFAICS, --encrypted was
a no-op even before this patch, because createuser encrypted the password
before sending it to the server even if --encrypted was not specified. It
added the ENCRYPTED keyword to the SQL command, but since the password was
already in encrypted form, it didn't make any difference. The documentation
was not clear on whether that was intended or not, but it's moot now.
Also, while password_encryption='on' is still accepted as an alias for
'md5', it is now marked as hidden, so that it is not listed as an accepted
value in error hints, for example. That's not directly related to removing
'plain', but it seems better this way.
Reviewed by Michael Paquier
Discussion: https://www.postgresql.org/message-id/16e9b768-fd78-0b12-cfc1-7b6b7f238fde@iki.fi
2017-05-08 10:26:07 +02:00
|
|
|
The password is always stored encrypted in the system catalogs. The
|
|
|
|
<literal>ENCRYPTED</> keyword has no effect, but is accepted for
|
|
|
|
backwards compatibility. The method of encryption is determined
|
|
|
|
by the configuration parameter <xref linkend="guc-password-encryption">.
|
|
|
|
If the presented password string is already in MD5-encrypted or
|
|
|
|
SCRAM-encrypted format, then it is stored as-is regardless of
|
|
|
|
<varname>password_encryption</> (since the system cannot decrypt
|
|
|
|
the specified encrypted password string, to encrypt it in a
|
|
|
|
different format). This allows reloading of encrypted passwords
|
Support SCRAM-SHA-256 authentication (RFC 5802 and 7677).
This introduces a new generic SASL authentication method, similar to the
GSS and SSPI methods. The server first tells the client which SASL
authentication mechanism to use, and then the mechanism-specific SASL
messages are exchanged in AuthenticationSASLcontinue and PasswordMessage
messages. Only SCRAM-SHA-256 is supported at the moment, but this allows
adding more SASL mechanisms in the future, without changing the overall
protocol.
Support for channel binding, aka SCRAM-SHA-256-PLUS is left for later.
The SASLPrep algorithm, for pre-processing the password, is not yet
implemented. That could cause trouble, if you use a password with
non-ASCII characters, and a client library that does implement SASLprep.
That will hopefully be added later.
Authorization identities, as specified in the SCRAM-SHA-256 specification,
are ignored. SET SESSION AUTHORIZATION provides more or less the same
functionality, anyway.
If a user doesn't exist, perform a "mock" authentication, by constructing
an authentic-looking challenge on the fly. The challenge is derived from
a new system-wide random value, "mock authentication nonce", which is
created at initdb, and stored in the control file. We go through these
motions, in order to not give away the information on whether the user
exists, to unauthenticated users.
Bumps PG_CONTROL_VERSION, because of the new field in control file.
Patch by Michael Paquier and Heikki Linnakangas, reviewed at different
stages by Robert Haas, Stephen Frost, David Steele, Aleksander Alekseev,
and many others.
Discussion: https://www.postgresql.org/message-id/CAB7nPqRbR3GmFYdedCAhzukfKrgBLTLtMvENOmPrVWREsZkF8g%40mail.gmail.com
Discussion: https://www.postgresql.org/message-id/CAB7nPqSMXU35g%3DW9X74HVeQp0uvgJxvYOuA4A-A3M%2B0wfEBv-w%40mail.gmail.com
Discussion: https://www.postgresql.org/message-id/55192AFE.6080106@iki.fi
2017-03-07 13:25:40 +01:00
|
|
|
during dump/restore.
|
|
|
|
</para>
|
2005-07-27 01:24:02 +02:00
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>VALID UNTIL</literal> '<replaceable class="parameter">timestamp</replaceable>'</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The <literal>VALID UNTIL</literal> clause sets a date and
|
|
|
|
time after which the role's password is no longer valid. If
|
|
|
|
this clause is omitted the password will be valid for all time.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2009-09-19 12:23:27 +02:00
|
|
|
<term><literal>IN ROLE</> <replaceable class="parameter">role_name</replaceable></term>
|
2005-07-27 01:24:02 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The <literal>IN ROLE</literal> clause lists one or more existing
|
|
|
|
roles to which the new role will be immediately added as a new
|
|
|
|
member. (Note that there is no option to add the new role as an
|
|
|
|
administrator; use a separate <command>GRANT</> command to do that.)
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2009-09-19 12:23:27 +02:00
|
|
|
<term><literal>IN GROUP</> <replaceable class="parameter">role_name</replaceable></term>
|
2005-07-27 01:24:02 +02:00
|
|
|
<listitem>
|
2011-08-07 09:49:45 +02:00
|
|
|
<para><literal>IN GROUP</literal> is an obsolete spelling of
|
2005-07-27 01:24:02 +02:00
|
|
|
<literal>IN ROLE</>.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2009-09-19 12:23:27 +02:00
|
|
|
<term><literal>ROLE</> <replaceable class="parameter">role_name</replaceable></term>
|
2005-07-27 01:24:02 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The <literal>ROLE</literal> clause lists one or more existing
|
|
|
|
roles which are automatically added as members of the new role.
|
|
|
|
(This in effect makes the new role a <quote>group</>.)
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2009-09-19 12:23:27 +02:00
|
|
|
<term><literal>ADMIN</> <replaceable class="parameter">role_name</replaceable></term>
|
2005-07-27 01:24:02 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The <literal>ADMIN</literal> clause is like <literal>ROLE</literal>,
|
|
|
|
but the named roles are added to the new role <literal>WITH ADMIN
|
|
|
|
OPTION</>, giving them the right to grant membership in this role
|
|
|
|
to others.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2009-09-19 12:23:27 +02:00
|
|
|
<term><literal>USER</> <replaceable class="parameter">role_name</replaceable></term>
|
2005-07-27 01:24:02 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The <literal>USER</literal> clause is an obsolete spelling of
|
|
|
|
the <literal>ROLE</> clause.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>SYSID</> <replaceable class="parameter">uid</replaceable></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The <literal>SYSID</literal> clause is ignored, but is accepted
|
|
|
|
for backwards compatibility.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
2010-11-23 21:27:50 +01:00
|
|
|
</refsect1>
|
2005-07-27 01:24:02 +02:00
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Notes</title>
|
|
|
|
|
|
|
|
<para>
|
2010-04-03 09:23:02 +02:00
|
|
|
Use <xref linkend="SQL-ALTERROLE"> to
|
|
|
|
change the attributes of a role, and <xref linkend="SQL-DROPROLE">
|
|
|
|
to remove a role. All the attributes
|
2005-07-27 01:24:02 +02:00
|
|
|
specified by <command>CREATE ROLE</> can be modified by later
|
|
|
|
<command>ALTER ROLE</> commands.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
The preferred way to add and remove members of roles that are being
|
|
|
|
used as groups is to use
|
2010-04-03 09:23:02 +02:00
|
|
|
<xref linkend="SQL-GRANT"> and
|
|
|
|
<xref linkend="SQL-REVOKE">.
|
2005-07-27 01:24:02 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
The <literal>VALID UNTIL</> clause defines an expiration time for a
|
|
|
|
password only, not for the role <foreignphrase>per se</>. In
|
|
|
|
particular, the expiration time is not enforced when logging in using
|
|
|
|
a non-password-based authentication method.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2005-08-15 01:35:38 +02:00
|
|
|
The <literal>INHERIT</> attribute governs inheritance of grantable
|
|
|
|
privileges (that is, access privileges for database objects and role
|
|
|
|
memberships). It does not apply to the special role attributes set by
|
|
|
|
<command>CREATE ROLE</> and <command>ALTER ROLE</>. For example, being
|
|
|
|
a member of a role with <literal>CREATEDB</> privilege does not immediately
|
|
|
|
grant the ability to create databases, even if <literal>INHERIT</> is set;
|
|
|
|
it would be necessary to become that role via
|
2010-04-03 09:23:02 +02:00
|
|
|
<xref linkend="SQL-SET-ROLE"> before
|
2005-08-15 01:35:38 +02:00
|
|
|
creating a database.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
The <literal>INHERIT</> attribute is the default for reasons of backwards
|
2005-07-27 01:24:02 +02:00
|
|
|
compatibility: in prior releases of <productname>PostgreSQL</productname>,
|
|
|
|
users always had access to all privileges of groups they were members of.
|
|
|
|
However, <literal>NOINHERIT</> provides a closer match to the semantics
|
|
|
|
specified in the SQL standard.
|
|
|
|
</para>
|
|
|
|
|
2006-03-03 04:06:05 +01:00
|
|
|
<para>
|
|
|
|
Be careful with the <literal>CREATEROLE</> privilege. There is no concept of
|
|
|
|
inheritance for the privileges of a <literal>CREATEROLE</>-role. That
|
|
|
|
means that even if a role does not have a certain privilege but is allowed
|
|
|
|
to create other roles, it can easily create another role with different
|
|
|
|
privileges than its own (except for creating roles with superuser
|
|
|
|
privileges). For example, if the role <quote>user</> has the
|
|
|
|
<literal>CREATEROLE</> privilege but not the <literal>CREATEDB</> privilege,
|
|
|
|
nonetheless it can create a new role with the <literal>CREATEDB</>
|
|
|
|
privilege. Therefore, regard roles that have the <literal>CREATEROLE</>
|
|
|
|
privilege as almost-superuser-roles.
|
|
|
|
</para>
|
|
|
|
|
2005-07-27 01:24:02 +02:00
|
|
|
<para>
|
|
|
|
<productname>PostgreSQL</productname> includes a program <xref
|
2010-04-03 09:23:02 +02:00
|
|
|
linkend="APP-CREATEUSER"> that has
|
2005-07-27 01:24:02 +02:00
|
|
|
the same functionality as <command>CREATE ROLE</command> (in fact,
|
|
|
|
it calls this command) but can be run from the command shell.
|
|
|
|
</para>
|
2005-07-31 19:19:22 +02:00
|
|
|
|
|
|
|
<para>
|
|
|
|
The <literal>CONNECTION LIMIT</> option is only enforced approximately;
|
|
|
|
if two new sessions start at about the same time when just one
|
|
|
|
connection <quote>slot</> remains for the role, it is possible that
|
|
|
|
both will fail. Also, the limit is never enforced for superusers.
|
|
|
|
</para>
|
2005-12-18 03:17:16 +01:00
|
|
|
|
|
|
|
<para>
|
|
|
|
Caution must be exercised when specifying an unencrypted password
|
|
|
|
with this command. The password will be transmitted to the server
|
|
|
|
in cleartext, and it might also be logged in the client's command
|
|
|
|
history or the server log. The command <xref
|
2010-04-03 09:23:02 +02:00
|
|
|
linkend="APP-CREATEUSER">, however, transmits
|
|
|
|
the password encrypted. Also, <xref linkend="app-psql">
|
|
|
|
contains a command
|
2005-12-18 03:17:16 +01:00
|
|
|
<command>\password</command> that can be used to safely change the
|
|
|
|
password later.
|
|
|
|
</para>
|
2005-07-27 01:24:02 +02:00
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Examples</title>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
Create a role that can log in, but don't give it a password:
|
|
|
|
<programlisting>
|
|
|
|
CREATE ROLE jonathan LOGIN;
|
|
|
|
</programlisting>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
Create a role with a password:
|
|
|
|
<programlisting>
|
|
|
|
CREATE USER davide WITH PASSWORD 'jw8s0F4';
|
|
|
|
</programlisting>
|
2005-11-03 01:51:43 +01:00
|
|
|
(<command>CREATE USER</> is the same as <command>CREATE ROLE</> except
|
2005-07-27 01:24:02 +02:00
|
|
|
that it implies <literal>LOGIN</>.)
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
Create a role with a password that is valid until the end of 2004.
|
|
|
|
After one second has ticked in 2005, the password is no longer
|
|
|
|
valid.
|
|
|
|
|
|
|
|
<programlisting>
|
|
|
|
CREATE ROLE miriam WITH LOGIN PASSWORD 'jw8s0F4' VALID UNTIL '2005-01-01';
|
|
|
|
</programlisting>
|
|
|
|
</para>
|
|
|
|
|
2010-11-23 21:27:50 +01:00
|
|
|
<para>
|
2005-07-27 01:24:02 +02:00
|
|
|
Create a role that can create databases and manage roles:
|
|
|
|
<programlisting>
|
|
|
|
CREATE ROLE admin WITH CREATEDB CREATEROLE;
|
2011-08-07 09:49:45 +02:00
|
|
|
</programlisting></para>
|
2005-07-27 01:24:02 +02:00
|
|
|
</refsect1>
|
2010-11-23 21:27:50 +01:00
|
|
|
|
2005-07-27 01:24:02 +02:00
|
|
|
<refsect1>
|
|
|
|
<title>Compatibility</title>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
The <command>CREATE ROLE</command> statement is in the SQL standard,
|
|
|
|
but the standard only requires the syntax
|
|
|
|
<synopsis>
|
2009-09-19 12:23:27 +02:00
|
|
|
CREATE ROLE <replaceable class="PARAMETER">name</> [ WITH ADMIN <replaceable class="PARAMETER">role_name</> ]
|
2005-07-27 01:24:02 +02:00
|
|
|
</synopsis>
|
|
|
|
Multiple initial administrators, and all the other options of
|
|
|
|
<command>CREATE ROLE</command>, are
|
|
|
|
<productname>PostgreSQL</productname> extensions.
|
|
|
|
</para>
|
2010-11-23 21:27:50 +01:00
|
|
|
|
2005-07-27 01:24:02 +02:00
|
|
|
<para>
|
|
|
|
The SQL standard defines the concepts of users and roles, but it
|
|
|
|
regards them as distinct concepts and leaves all commands defining
|
|
|
|
users to be specified by each database implementation. In
|
|
|
|
<productname>PostgreSQL</productname> we have chosen to unify
|
|
|
|
users and roles into a single kind of entity. Roles therefore
|
|
|
|
have many more optional attributes than they do in the standard.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
The behavior specified by the SQL standard is most closely approximated
|
|
|
|
by giving users the <literal>NOINHERIT</> attribute, while roles are
|
|
|
|
given the <literal>INHERIT</> attribute.
|
|
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>See Also</title>
|
|
|
|
|
|
|
|
<simplelist type="inline">
|
2010-04-03 09:23:02 +02:00
|
|
|
<member><xref linkend="sql-set-role"></member>
|
|
|
|
<member><xref linkend="sql-alterrole"></member>
|
|
|
|
<member><xref linkend="sql-droprole"></member>
|
|
|
|
<member><xref linkend="sql-grant"></member>
|
|
|
|
<member><xref linkend="sql-revoke"></member>
|
2005-07-27 01:24:02 +02:00
|
|
|
<member><xref linkend="app-createuser"></member>
|
|
|
|
</simplelist>
|
|
|
|
</refsect1>
|
|
|
|
</refentry>
|