Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 40 additions & 4 deletions src/dbbackup/engines/postgres.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,14 @@ def conninfo_dbname(db: str) -> str:
return "dbname='" + db.replace("\\", "\\\\").replace("'", "\\'") + "'"


_ROLE_STATEMENT = re.compile(r'^(?:CREATE|ALTER|COMMENT ON) ROLE ("(?:[^"]|"")*"|[^\s;]+)')
_ROLE_NAME = r'("(?:[^"]|"")*"|[^\s;]+)'
_ROLE_STATEMENT = re.compile(rf"^(?:CREATE|ALTER|COMMENT ON) ROLE {_ROLE_NAME}")
_ROLE_ATTRIBUTES = re.compile(rf"^ALTER ROLE {_ROLE_NAME} WITH (.*);$")
_GRANTED_BY = re.compile(rf"^(GRANT .+?) GRANTED BY {_ROLE_NAME};$")


def _role_name(token: str) -> str:
return token[1:-1].replace('""', '"') if token.startswith('"') else token


def without_roles(sql: str, existing: set[str]) -> tuple[str, set[str]]:
Expand All @@ -40,15 +47,41 @@ def without_roles(sql: str, existing: set[str]) -> tuple[str, set[str]]:
skipped = set()
for line in sql.splitlines():
if m := _ROLE_STATEMENT.match(line):
name = m.group(1)
role = name[1:-1].replace('""', '"') if name.startswith('"') else name
role = _role_name(m.group(1))
if role in existing:
skipped.add(role)
continue
kept.append(line)
return "\n".join(kept) + "\n", skipped


def without_superuser_grantors(sql: str) -> tuple[str, set[str]]:
"""Drop ``GRANTED BY`` from the memberships in a globals dump that a superuser granted.

Since PostgreSQL 16, a superuser's grants are recorded as made by the bootstrap
superuser (the one initdb created), so a dump names that role as grantor. On a
server whose bootstrap superuser has another name, the same role is an ordinary
superuser, which can't be named as grantor of a role it has no ADMIN option on.
Without the clause, the grant is recorded as made by this server's bootstrap
superuser instead, just as it was on the original.

Returns the rewritten SQL, and the grantors that were dropped.
"""
superusers = set()
for line in sql.splitlines():
if m := _ROLE_ATTRIBUTES.match(line):
if "SUPERUSER" in m.group(2).split(" PASSWORD ")[0].split():
superusers.add(_role_name(m.group(1)))
lines = []
dropped = set()
for line in sql.splitlines():
if (m := _GRANTED_BY.match(line)) and _role_name(m.group(2)) in superusers:
dropped.add(_role_name(m.group(2)))
line = m.group(1) + ";"
lines.append(line)
return "\n".join(lines) + "\n", dropped


class PostgresEngine(Engine):
type = "postgres"
min_version = (18,)
Expand Down Expand Up @@ -245,7 +278,10 @@ def _restore_globals(self, path: Path) -> list[str]:
# restoring as) are left exactly as they are: replaying their ALTER ROLE
# ... PASSWORD would reset their passwords to the backed-up server's.
existing = {r[0] for r in self.query("SELECT rolname FROM pg_roles")}
sql, skipped = without_roles(proc.run(["zstd", "-q", "-dc", str(path)]).stdout, existing)
sql, grantors = without_superuser_grantors(proc.run(["zstd", "-q", "-dc", str(path)]).stdout)
if grantors:
log.info("%s: grants by superuser %s attributed to this server's own superuser", self.target.name, ", ".join(sorted(grantors)))
sql, skipped = without_roles(sql, existing)
if skipped:
log.info("%s: left existing role(s) as they are: %s", self.target.name, ", ".join(sorted(skipped)))
cmd = ["psql", "-X", "-q", "-v", "ON_ERROR_STOP=0", *self._conn_args(), "-d", conninfo_dbname(self.target.maintenance_db)]
Expand Down
25 changes: 24 additions & 1 deletion tests/test_engines.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
from dbbackup.engines.base import EngineError, safe_filename, version_tuple
from dbbackup.engines.mariadb import option_file_value, statement_account, without_accounts
from dbbackup.engines.mongodb import _ns_escape
from dbbackup.engines.postgres import conninfo_dbname, without_roles
from dbbackup.engines.postgres import conninfo_dbname, without_roles, without_superuser_grantors

SECRET = "pa ss'w\"o#rd\\"

Expand Down Expand Up @@ -179,6 +179,29 @@ def test_postgres_without_roles():
assert kept == "CREATE ROLE app;\nALTER ROLE app WITH LOGIN PASSWORD 'x';\nGRANT reporting TO postgres;\n"


def test_postgres_without_superuser_grantors():
sql = "\n".join(
[
"CREATE ROLE memlord;",
"ALTER ROLE memlord WITH SUPERUSER INHERIT CREATEROLE CREATEDB LOGIN PASSWORD 'SCRAM-SUPERUSER';",
'ALTER ROLE "Admin ""X""" WITH SUPERUSER LOGIN;',
"ALTER ROLE manager WITH NOSUPERUSER CREATEROLE LOGIN PASSWORD 'SUPERUSER';",
"GRANT pg_read_all_data TO dbbackup WITH INHERIT TRUE GRANTED BY memlord;",
'GRANT reporting TO app GRANTED BY "Admin ""X""";',
"GRANT reporting TO reader WITH INHERIT TRUE GRANTED BY manager;",
"GRANT reporting TO other;",
]
)
kept, dropped = without_superuser_grantors(sql)
assert dropped == {"memlord", 'Admin "X"'}
assert kept.splitlines()[4:] == [
"GRANT pg_read_all_data TO dbbackup WITH INHERIT TRUE;",
"GRANT reporting TO app;",
"GRANT reporting TO reader WITH INHERIT TRUE GRANTED BY manager;", # not a superuser: kept
"GRANT reporting TO other;",
]


@pytest.mark.parametrize(
"name, expected",
[("app1", "app1"), ("odd.name/db", "odd%2Ename%2Fdb"), ("..", "%2E%2E"), ("wiki-db", "wiki-db"), ("ünï", "%C3%BCn%C3%AF")],
Expand Down
Loading