Allow pg_dumpall to dump roles w/o user passwords

Add new option --no-role-passwords which dumps roles without passwords.
Since we don’t need passwords, we choose to use pg_roles in preference
to pg_authid since access may be restricted for security reasons in
some configrations.

Robins Tharakan and Simon Riggs
This commit is contained in:
Simon Riggs 2017-03-07 22:00:54 +08:00
parent 55acfcbffd
commit 9a83d56b38
2 changed files with 97 additions and 48 deletions

View File

@ -332,6 +332,19 @@ PostgreSQL documentation
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--no-role-passwords</option></term>
<listitem>
<para>
Do not dump passwords for roles. When restored, roles will have a NULL
password and authentication will always fail until the password is reset.
Since password values aren't needed when this option is specified we
use the catalog view pg_roles in preference to pg_authid, since access
to pg_authid may be restricted by security policy.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>--no-security-labels</option></term> <term><option>--no-security-labels</option></term>
<listitem> <listitem>

View File

@ -74,8 +74,13 @@ static int no_tablespaces = 0;
static int use_setsessauth = 0; static int use_setsessauth = 0;
static int no_security_labels = 0; static int no_security_labels = 0;
static int no_unlogged_table_data = 0; static int no_unlogged_table_data = 0;
static int no_role_passwords = 0;
static int server_version; static int server_version;
static char role_catalog[10];
#define PG_AUTHID "pg_authid"
#define PG_ROLES "pg_roles "
static FILE *OPF; static FILE *OPF;
static char *filename = NULL; static char *filename = NULL;
@ -123,6 +128,7 @@ main(int argc, char *argv[])
{"use-set-session-authorization", no_argument, &use_setsessauth, 1}, {"use-set-session-authorization", no_argument, &use_setsessauth, 1},
{"no-security-labels", no_argument, &no_security_labels, 1}, {"no-security-labels", no_argument, &no_security_labels, 1},
{"no-unlogged-table-data", no_argument, &no_unlogged_table_data, 1}, {"no-unlogged-table-data", no_argument, &no_unlogged_table_data, 1},
{"no-role-passwords", no_argument, &no_role_passwords, 1},
{NULL, 0, NULL, 0} {NULL, 0, NULL, 0}
}; };
@ -342,6 +348,25 @@ main(int argc, char *argv[])
exit_nicely(1); exit_nicely(1);
} }
if (no_role_passwords && binary_upgrade)
{
fprintf(stderr, _("%s: options --no-role-passwords and --binary-upgrade cannot be used together\n"),
progname);
fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
progname);
exit_nicely(1);
}
/*
* If password values are not required in the dump, switch to
* using pg_roles which is equally useful, just more likely
* to have unrestricted access than pg_authid.
*/
if (no_role_passwords)
sprintf(role_catalog, "%s", PG_ROLES);
else
sprintf(role_catalog, "%s", PG_AUTHID);
/* Add long options to the pg_dump argument list */ /* Add long options to the pg_dump argument list */
if (binary_upgrade) if (binary_upgrade)
appendPQExpBufferStr(pgdumpopts, " --binary-upgrade"); appendPQExpBufferStr(pgdumpopts, " --binary-upgrade");
@ -563,6 +588,7 @@ help(void)
printf(_(" --no-security-labels do not dump security label assignments\n")); printf(_(" --no-security-labels do not dump security label assignments\n"));
printf(_(" --no-tablespaces do not dump tablespace assignments\n")); printf(_(" --no-tablespaces do not dump tablespace assignments\n"));
printf(_(" --no-unlogged-table-data do not dump unlogged table data\n")); printf(_(" --no-unlogged-table-data do not dump unlogged table data\n"));
printf(_(" --no-role-passwords do not dump passwords for roles\n"));
printf(_(" --quote-all-identifiers quote all identifiers, even if not key words\n")); printf(_(" --quote-all-identifiers quote all identifiers, even if not key words\n"));
printf(_(" --use-set-session-authorization\n" printf(_(" --use-set-session-authorization\n"
" use SET SESSION AUTHORIZATION commands instead of\n" " use SET SESSION AUTHORIZATION commands instead of\n"
@ -590,23 +616,24 @@ help(void)
static void static void
dropRoles(PGconn *conn) dropRoles(PGconn *conn)
{ {
PQExpBuffer buf = createPQExpBuffer();
PGresult *res; PGresult *res;
int i_rolname; int i_rolname;
int i; int i;
if (server_version >= 90600) if (server_version >= 90600)
res = executeQuery(conn, printfPQExpBuffer(buf,
"SELECT rolname " "SELECT rolname "
"FROM pg_authid " "FROM %s "
"WHERE rolname !~ '^pg_' " "WHERE rolname !~ '^pg_' "
"ORDER BY 1"); "ORDER BY 1", role_catalog);
else if (server_version >= 80100) else if (server_version >= 80100)
res = executeQuery(conn, printfPQExpBuffer(buf,
"SELECT rolname " "SELECT rolname "
"FROM pg_authid " "FROM %s "
"ORDER BY 1"); "ORDER BY 1", role_catalog);
else else
res = executeQuery(conn, printfPQExpBuffer(buf,
"SELECT usename as rolname " "SELECT usename as rolname "
"FROM pg_shadow " "FROM pg_shadow "
"UNION " "UNION "
@ -614,6 +641,8 @@ dropRoles(PGconn *conn)
"FROM pg_group " "FROM pg_group "
"ORDER BY 1"); "ORDER BY 1");
res = executeQuery(conn, buf->data);
i_rolname = PQfnumber(res, "rolname"); i_rolname = PQfnumber(res, "rolname");
if (PQntuples(res) > 0) if (PQntuples(res) > 0)
@ -631,6 +660,7 @@ dropRoles(PGconn *conn)
} }
PQclear(res); PQclear(res);
destroyPQExpBuffer(buf);
fprintf(OPF, "\n\n"); fprintf(OPF, "\n\n");
} }
@ -666,21 +696,21 @@ dumpRoles(PGconn *conn)
"rolcreaterole, rolcreatedb, " "rolcreaterole, rolcreatedb, "
"rolcanlogin, rolconnlimit, rolpassword, " "rolcanlogin, rolconnlimit, rolpassword, "
"rolvaliduntil, rolreplication, rolbypassrls, " "rolvaliduntil, rolreplication, rolbypassrls, "
"pg_catalog.shobj_description(oid, 'pg_authid') as rolcomment, " "pg_catalog.shobj_description(oid, '%s') as rolcomment, "
"rolname = current_user AS is_current_user " "rolname = current_user AS is_current_user "
"FROM pg_authid " "FROM %s "
"WHERE rolname !~ '^pg_' " "WHERE rolname !~ '^pg_' "
"ORDER BY 2"); "ORDER BY 2", role_catalog, role_catalog);
else if (server_version >= 90500) else if (server_version >= 90500)
printfPQExpBuffer(buf, printfPQExpBuffer(buf,
"SELECT oid, rolname, rolsuper, rolinherit, " "SELECT oid, rolname, rolsuper, rolinherit, "
"rolcreaterole, rolcreatedb, " "rolcreaterole, rolcreatedb, "
"rolcanlogin, rolconnlimit, rolpassword, " "rolcanlogin, rolconnlimit, rolpassword, "
"rolvaliduntil, rolreplication, rolbypassrls, " "rolvaliduntil, rolreplication, rolbypassrls, "
"pg_catalog.shobj_description(oid, 'pg_authid') as rolcomment, " "pg_catalog.shobj_description(oid, '%s') as rolcomment, "
"rolname = current_user AS is_current_user " "rolname = current_user AS is_current_user "
"FROM pg_authid " "FROM %s "
"ORDER BY 2"); "ORDER BY 2", role_catalog, role_catalog);
else if (server_version >= 90100) else if (server_version >= 90100)
printfPQExpBuffer(buf, printfPQExpBuffer(buf,
"SELECT oid, rolname, rolsuper, rolinherit, " "SELECT oid, rolname, rolsuper, rolinherit, "
@ -688,10 +718,10 @@ dumpRoles(PGconn *conn)
"rolcanlogin, rolconnlimit, rolpassword, " "rolcanlogin, rolconnlimit, rolpassword, "
"rolvaliduntil, rolreplication, " "rolvaliduntil, rolreplication, "
"false as rolbypassrls, " "false as rolbypassrls, "
"pg_catalog.shobj_description(oid, 'pg_authid') as rolcomment, " "pg_catalog.shobj_description(oid, '%s') as rolcomment, "
"rolname = current_user AS is_current_user " "rolname = current_user AS is_current_user "
"FROM pg_authid " "FROM %s "
"ORDER BY 2"); "ORDER BY 2", role_catalog, role_catalog);
else if (server_version >= 80200) else if (server_version >= 80200)
printfPQExpBuffer(buf, printfPQExpBuffer(buf,
"SELECT oid, rolname, rolsuper, rolinherit, " "SELECT oid, rolname, rolsuper, rolinherit, "
@ -699,10 +729,10 @@ dumpRoles(PGconn *conn)
"rolcanlogin, rolconnlimit, rolpassword, " "rolcanlogin, rolconnlimit, rolpassword, "
"rolvaliduntil, false as rolreplication, " "rolvaliduntil, false as rolreplication, "
"false as rolbypassrls, " "false as rolbypassrls, "
"pg_catalog.shobj_description(oid, 'pg_authid') as rolcomment, " "pg_catalog.shobj_description(oid, '%s') as rolcomment, "
"rolname = current_user AS is_current_user " "rolname = current_user AS is_current_user "
"FROM pg_authid " "FROM %s "
"ORDER BY 2"); "ORDER BY 2", role_catalog, role_catalog);
else if (server_version >= 80100) else if (server_version >= 80100)
printfPQExpBuffer(buf, printfPQExpBuffer(buf,
"SELECT oid, rolname, rolsuper, rolinherit, " "SELECT oid, rolname, rolsuper, rolinherit, "
@ -712,8 +742,8 @@ dumpRoles(PGconn *conn)
"false as rolbypassrls, " "false as rolbypassrls, "
"null as rolcomment, " "null as rolcomment, "
"rolname = current_user AS is_current_user " "rolname = current_user AS is_current_user "
"FROM pg_authid " "FROM %s "
"ORDER BY 2"); "ORDER BY 2", role_catalog);
else else
printfPQExpBuffer(buf, printfPQExpBuffer(buf,
"SELECT 0 as oid, usename as rolname, " "SELECT 0 as oid, usename as rolname, "
@ -846,7 +876,8 @@ dumpRoles(PGconn *conn)
appendPQExpBuffer(buf, " CONNECTION LIMIT %s", appendPQExpBuffer(buf, " CONNECTION LIMIT %s",
PQgetvalue(res, i, i_rolconnlimit)); PQgetvalue(res, i, i_rolconnlimit));
if (!PQgetisnull(res, i, i_rolpassword))
if (!PQgetisnull(res, i, i_rolpassword) && !no_role_passwords)
{ {
appendPQExpBufferStr(buf, " PASSWORD "); appendPQExpBufferStr(buf, " PASSWORD ");
appendStringLiteralConn(buf, PQgetvalue(res, i, i_rolpassword), conn); appendStringLiteralConn(buf, PQgetvalue(res, i, i_rolpassword), conn);
@ -897,19 +928,21 @@ dumpRoles(PGconn *conn)
static void static void
dumpRoleMembership(PGconn *conn) dumpRoleMembership(PGconn *conn)
{ {
PQExpBuffer buf = createPQExpBuffer();
PGresult *res; PGresult *res;
int i; int i;
res = executeQuery(conn, "SELECT ur.rolname AS roleid, " printfPQExpBuffer(buf, "SELECT ur.rolname AS roleid, "
"um.rolname AS member, " "um.rolname AS member, "
"a.admin_option, " "a.admin_option, "
"ug.rolname AS grantor " "ug.rolname AS grantor "
"FROM pg_auth_members a " "FROM pg_auth_members a "
"LEFT JOIN pg_authid ur on ur.oid = a.roleid " "LEFT JOIN %s ur on ur.oid = a.roleid "
"LEFT JOIN pg_authid um on um.oid = a.member " "LEFT JOIN %s um on um.oid = a.member "
"LEFT JOIN pg_authid ug on ug.oid = a.grantor " "LEFT JOIN %s ug on ug.oid = a.grantor "
"WHERE NOT (ur.rolname ~ '^pg_' AND um.rolname ~ '^pg_')" "WHERE NOT (ur.rolname ~ '^pg_' AND um.rolname ~ '^pg_')"
"ORDER BY 1,2,3"); "ORDER BY 1,2,3", role_catalog, role_catalog, role_catalog);
res = executeQuery(conn, buf->data);
if (PQntuples(res) > 0) if (PQntuples(res) > 0)
fprintf(OPF, "--\n-- Role memberships\n--\n\n"); fprintf(OPF, "--\n-- Role memberships\n--\n\n");
@ -939,6 +972,7 @@ dumpRoleMembership(PGconn *conn)
} }
PQclear(res); PQclear(res);
destroyPQExpBuffer(buf);
fprintf(OPF, "\n\n"); fprintf(OPF, "\n\n");
} }
@ -1298,9 +1332,9 @@ dumpCreateDB(PGconn *conn)
* databases. * databases.
*/ */
if (server_version >= 90600) if (server_version >= 90600)
res = executeQuery(conn, printfPQExpBuffer(buf,
"SELECT datname, " "SELECT datname, "
"coalesce(rolname, (select rolname from pg_authid where oid=(select datdba from pg_database where datname='template0'))), " "coalesce(rolname, (select rolname from %s where oid=(select datdba from pg_database where datname='template0'))), "
"pg_encoding_to_char(d.encoding), " "pg_encoding_to_char(d.encoding), "
"datcollate, datctype, datfrozenxid, datminmxid, " "datcollate, datctype, datfrozenxid, datminmxid, "
"datistemplate, " "datistemplate, "
@ -1314,43 +1348,43 @@ dumpCreateDB(PGconn *conn)
"AS rdatacl, " "AS rdatacl, "
"datconnlimit, " "datconnlimit, "
"(SELECT spcname FROM pg_tablespace t WHERE t.oid = d.dattablespace) AS dattablespace " "(SELECT spcname FROM pg_tablespace t WHERE t.oid = d.dattablespace) AS dattablespace "
"FROM pg_database d LEFT JOIN pg_authid u ON (datdba = u.oid) " "FROM pg_database d LEFT JOIN %s u ON (datdba = u.oid) "
"WHERE datallowconn ORDER BY 1"); "WHERE datallowconn ORDER BY 1", role_catalog, role_catalog);
else if (server_version >= 90300) else if (server_version >= 90300)
res = executeQuery(conn, printfPQExpBuffer(buf,
"SELECT datname, " "SELECT datname, "
"coalesce(rolname, (select rolname from pg_authid where oid=(select datdba from pg_database where datname='template0'))), " "coalesce(rolname, (select rolname from %s where oid=(select datdba from pg_database where datname='template0'))), "
"pg_encoding_to_char(d.encoding), " "pg_encoding_to_char(d.encoding), "
"datcollate, datctype, datfrozenxid, datminmxid, " "datcollate, datctype, datfrozenxid, datminmxid, "
"datistemplate, datacl, '' as rdatacl, " "datistemplate, datacl, '' as rdatacl, "
"datconnlimit, " "datconnlimit, "
"(SELECT spcname FROM pg_tablespace t WHERE t.oid = d.dattablespace) AS dattablespace " "(SELECT spcname FROM pg_tablespace t WHERE t.oid = d.dattablespace) AS dattablespace "
"FROM pg_database d LEFT JOIN pg_authid u ON (datdba = u.oid) " "FROM pg_database d LEFT JOIN %s u ON (datdba = u.oid) "
"WHERE datallowconn ORDER BY 1"); "WHERE datallowconn ORDER BY 1", role_catalog, role_catalog);
else if (server_version >= 80400) else if (server_version >= 80400)
res = executeQuery(conn, printfPQExpBuffer(buf,
"SELECT datname, " "SELECT datname, "
"coalesce(rolname, (select rolname from pg_authid where oid=(select datdba from pg_database where datname='template0'))), " "coalesce(rolname, (select rolname from %s where oid=(select datdba from pg_database where datname='template0'))), "
"pg_encoding_to_char(d.encoding), " "pg_encoding_to_char(d.encoding), "
"datcollate, datctype, datfrozenxid, 0 AS datminmxid, " "datcollate, datctype, datfrozenxid, 0 AS datminmxid, "
"datistemplate, datacl, '' as rdatacl, " "datistemplate, datacl, '' as rdatacl, "
"datconnlimit, " "datconnlimit, "
"(SELECT spcname FROM pg_tablespace t WHERE t.oid = d.dattablespace) AS dattablespace " "(SELECT spcname FROM pg_tablespace t WHERE t.oid = d.dattablespace) AS dattablespace "
"FROM pg_database d LEFT JOIN pg_authid u ON (datdba = u.oid) " "FROM pg_database d LEFT JOIN %s u ON (datdba = u.oid) "
"WHERE datallowconn ORDER BY 1"); "WHERE datallowconn ORDER BY 1", role_catalog, role_catalog);
else if (server_version >= 80100) else if (server_version >= 80100)
res = executeQuery(conn, printfPQExpBuffer(buf,
"SELECT datname, " "SELECT datname, "
"coalesce(rolname, (select rolname from pg_authid where oid=(select datdba from pg_database where datname='template0'))), " "coalesce(rolname, (select rolname from %s where oid=(select datdba from pg_database where datname='template0'))), "
"pg_encoding_to_char(d.encoding), " "pg_encoding_to_char(d.encoding), "
"null::text AS datcollate, null::text AS datctype, datfrozenxid, 0 AS datminmxid, " "null::text AS datcollate, null::text AS datctype, datfrozenxid, 0 AS datminmxid, "
"datistemplate, datacl, '' as rdatacl, " "datistemplate, datacl, '' as rdatacl, "
"datconnlimit, " "datconnlimit, "
"(SELECT spcname FROM pg_tablespace t WHERE t.oid = d.dattablespace) AS dattablespace " "(SELECT spcname FROM pg_tablespace t WHERE t.oid = d.dattablespace) AS dattablespace "
"FROM pg_database d LEFT JOIN pg_authid u ON (datdba = u.oid) " "FROM pg_database d LEFT JOIN %s u ON (datdba = u.oid) "
"WHERE datallowconn ORDER BY 1"); "WHERE datallowconn ORDER BY 1", role_catalog, role_catalog);
else else
res = executeQuery(conn, printfPQExpBuffer(buf,
"SELECT datname, " "SELECT datname, "
"coalesce(usename, (select usename from pg_shadow where usesysid=(select datdba from pg_database where datname='template0'))), " "coalesce(usename, (select usename from pg_shadow where usesysid=(select datdba from pg_database where datname='template0'))), "
"pg_encoding_to_char(d.encoding), " "pg_encoding_to_char(d.encoding), "
@ -1361,6 +1395,8 @@ dumpCreateDB(PGconn *conn)
"FROM pg_database d LEFT JOIN pg_shadow u ON (datdba = usesysid) " "FROM pg_database d LEFT JOIN pg_shadow u ON (datdba = usesysid) "
"WHERE datallowconn ORDER BY 1"); "WHERE datallowconn ORDER BY 1");
res = executeQuery(conn, buf->data);
for (i = 0; i < PQntuples(res); i++) for (i = 0; i < PQntuples(res); i++)
{ {
char *dbname = PQgetvalue(res, i, 0); char *dbname = PQgetvalue(res, i, 0);
@ -1557,9 +1593,9 @@ dumpUserConfig(PGconn *conn, const char *username)
if (server_version >= 90000) if (server_version >= 90000)
printfPQExpBuffer(buf, "SELECT setconfig[%d] FROM pg_db_role_setting WHERE " printfPQExpBuffer(buf, "SELECT setconfig[%d] FROM pg_db_role_setting WHERE "
"setdatabase = 0 AND setrole = " "setdatabase = 0 AND setrole = "
"(SELECT oid FROM pg_authid WHERE rolname = ", count); "(SELECT oid FROM %s WHERE rolname = ", count, role_catalog);
else if (server_version >= 80100) else if (server_version >= 80100)
printfPQExpBuffer(buf, "SELECT rolconfig[%d] FROM pg_authid WHERE rolname = ", count); printfPQExpBuffer(buf, "SELECT rolconfig[%d] FROM %s WHERE rolname = ", count, role_catalog);
else else
printfPQExpBuffer(buf, "SELECT useconfig[%d] FROM pg_shadow WHERE usename = ", count); printfPQExpBuffer(buf, "SELECT useconfig[%d] FROM pg_shadow WHERE usename = ", count);
appendStringLiteralConn(buf, username, conn); appendStringLiteralConn(buf, username, conn);
@ -1597,8 +1633,8 @@ dumpDbRoleConfig(PGconn *conn)
int i; int i;
printfPQExpBuffer(buf, "SELECT rolname, datname, unnest(setconfig) " printfPQExpBuffer(buf, "SELECT rolname, datname, unnest(setconfig) "
"FROM pg_db_role_setting, pg_authid, pg_database " "FROM pg_db_role_setting, %s u, pg_database "
"WHERE setrole = pg_authid.oid AND setdatabase = pg_database.oid"); "WHERE setrole = u.oid AND setdatabase = pg_database.oid", role_catalog);
res = executeQuery(conn, buf->data); res = executeQuery(conn, buf->data);
if (PQntuples(res) > 0) if (PQntuples(res) > 0)