From 61bdb411e6c7b979df7b8ff5ee8245f06219444e Mon Sep 17 00:00:00 2001 From: Jelte Fennema-Nio Date: Fri, 4 Oct 2024 22:34:51 +0200 Subject: [PATCH v6] Add support for extensions with an owned schema Writing the sql migration scripts that are run by CREATE EXTENSION and ALTER EXTENSION UPDATE are security minefields for extension authors. One big reason for this is that search_path is set to the schema of the extension while running these scripts, and thus if a user with lower privileges can create functions or operators in that schema they can do all kinds of search_path confusion attacks if not every function and operator that is used in the script is schema qualified. While doing such schema qualification is possible, it relies on the author to never make a mistake in any of the sql files. And sadly humans have a tendency to make mistakes. This patch adds a new "owned_schema" option to the extension control file that can be set to true to indicate that this extension wants to own the schema in which it is installed. What that means is that the schema should not exist before creating the extension, and will be created during extension creation. This thus gives the extension author an easy way to use a safe search_path, while still allowing all objects to be grouped together in a schema. The implementation also has the pleasant side effect that the schema will be automatically dropped when the extension is dropped. --- doc/src/sgml/extend.sgml | 34 ++ doc/src/sgml/ref/create_extension.sgml | 6 +- src/backend/commands/extension.c | 363 +++++++++++++----- src/backend/utils/adt/pg_upgrade_support.c | 45 ++- src/bin/pg_dump/pg_dump.c | 54 ++- src/bin/pg_dump/pg_dump.h | 1 + src/include/catalog/pg_extension.h | 1 + src/include/catalog/pg_proc.dat | 2 +- src/include/commands/extension.h | 4 +- src/test/modules/test_extensions/Makefile | 7 +- .../expected/test_extensions.out | 54 +++ src/test/modules/test_extensions/meson.build | 4 + .../test_extensions/sql/test_extensions.sql | 27 ++ .../test_ext_owned_schema--1.0.sql | 2 + .../test_ext_owned_schema.control | 5 + ...test_ext_owned_schema_relocatable--1.0.sql | 2 + .../test_ext_owned_schema_relocatable.control | 4 + src/test/modules/test_pg_dump/t/001_base.pl | 32 ++ 18 files changed, 517 insertions(+), 130 deletions(-) create mode 100644 src/test/modules/test_extensions/test_ext_owned_schema--1.0.sql create mode 100644 src/test/modules/test_extensions/test_ext_owned_schema.control create mode 100644 src/test/modules/test_extensions/test_ext_owned_schema_relocatable--1.0.sql create mode 100644 src/test/modules/test_extensions/test_ext_owned_schema_relocatable.control diff --git a/doc/src/sgml/extend.sgml b/doc/src/sgml/extend.sgml index 63c5ec6d1eb..ddfb4ebfbf5 100644 --- a/doc/src/sgml/extend.sgml +++ b/doc/src/sgml/extend.sgml @@ -814,6 +814,40 @@ RETURNS anycompatible AS ... + + owned_schema (boolean) + + + An extension should set owned_schema to + true in its control file if the extension wants a + dedicated schema for its objects. Such a schema should not exist yet at + the time of extension creation, and will be created automatically by + CREATE EXTENSION. The default is + false, i.e., the extension can be installed into an + existing schema. + + + Having a schema owned by the extension can make it much easier to + reason about possible search_path injection attacks. + For instance with an owned schema, it is generally safe to set the + search_path of a SECURITY DEFINER + function to the schema of the extension. While without an owned schema + it might not be safe to do so, because a malicious user could insert + objects in that schema and thus cause malicious to be executed + as superuser. Similarly, having an owned schema can make it safe + by default to execute general-purpose SQL in the extension script, + because the search_path now only contains trusted schemas. Without an + owned schema it's + recommended to manually change the search_path. + + + Apart from the security considerations, having an owned schema can help + prevent naming conflicts between objects of different extensions. + + + + schema (string) diff --git a/doc/src/sgml/ref/create_extension.sgml b/doc/src/sgml/ref/create_extension.sgml index 713abd9c494..ab125d56263 100644 --- a/doc/src/sgml/ref/create_extension.sgml +++ b/doc/src/sgml/ref/create_extension.sgml @@ -104,7 +104,11 @@ CREATE EXTENSION [ IF NOT EXISTS ] extension_name The name of the schema in which to install the extension's objects, given that the extension allows its contents to be - relocated. The named schema must already exist. + relocated. Whether this schema should already exist or not depends on + the value of owned_schema in the extensions control + file: If it's true, the schema must + not exist; if it's false it + must exist. If not specified, and the extension's control file does not specify a schema either, the current default object creation schema is used. diff --git a/src/backend/commands/extension.c b/src/backend/commands/extension.c index e6f9ab6dfd6..b42c25a7630 100644 --- a/src/backend/commands/extension.c +++ b/src/backend/commands/extension.c @@ -92,6 +92,8 @@ typedef struct ExtensionControlFile * MODULE_PATHNAME */ char *comment; /* comment, if any */ char *schema; /* target schema (allowed if !relocatable) */ + bool owned_schema; /* if the schema should be owned by the + * extension */ bool relocatable; /* is ALTER EXTENSION SET SCHEMA supported? */ bool superuser; /* must be superuser to install? */ bool trusted; /* allow becoming superuser on the fly? */ @@ -613,6 +615,14 @@ parse_extension_control_file(ExtensionControlFile *control, { control->schema = pstrdup(item->value); } + else if (strcmp(item->name, "owned_schema") == 0) + { + if (!parse_bool(item->value, &control->owned_schema)) + ereport(ERROR, + (errcode(ERRCODE_INVALID_PARAMETER_VALUE), + errmsg("parameter \"%s\" requires a Boolean value", + item->name))); + } else if (strcmp(item->name, "relocatable") == 0) { if (!parse_bool(item->value, &control->relocatable)) @@ -1643,6 +1653,164 @@ find_install_path(List *evi_list, ExtensionVersionInfo *evi_target, return evi_start; } +/* + * Create a schema with the given name, as part of CREATE EXTENSION. + */ +static Oid +CreateSchemaForExtension(char *schemaName) +{ + + CreateSchemaStmt *csstmt = makeNode(CreateSchemaStmt); + + csstmt->schemaname = schemaName; + csstmt->authrole = NULL; /* will be created by current user */ + csstmt->schemaElts = NIL; + csstmt->if_not_exists = false; + CreateSchemaCommand(csstmt, "(generated CREATE SCHEMA command)", + -1, -1); + + /* + * CreateSchemaCommand includes CommandCounterIncrement, so new schema is + * now visible. + */ + return get_namespace_oid(schemaName, false); +} + +/* + * Create a owned schema with the given name, as part of CREATE EXTENSION, and + * fails if the schema already exist. + */ +static Oid +CreateOwnedSchemaForExtension(char *schemaName) +{ + /* Find or create the schema in case it does not exist. */ + Oid schemaOid = get_namespace_oid(schemaName, true); + + if (OidIsValid(schemaOid)) + { + ereport(ERROR, + (errcode(ERRCODE_DUPLICATE_SCHEMA), + errmsg("schema \"%s\" already exists", + schemaName), + errhint("Drop schema \"%s\" or specify another schema using CREATE EXTENSION ... SCHEMA ...", schemaName))); + } + + return CreateSchemaForExtension(schemaName); +} + +/* + * Gets or creates the schema than an extension should be created in. + * + * Returns the OID of the schema and updates schemaName to the name of the schema. + */ +static Oid +GetOrCreateSchemaForExtension(char **schemaName, ExtensionControlFile *control, bool cascade) +{ + /* + * The simplest case is when the user provides a schema name. + */ + if (*schemaName) + { + Oid schemaOid; + + if (!control->owned_schema) + { + /* + * For non-owned schemas, this schema must already exist. We want + * to check this now, so it fails even if we bail out of this + * block due to the CASCADE logic. + */ + schemaOid = get_namespace_oid(*schemaName, true); + } + + if (control->schema && strcmp(control->schema, *schemaName) != 0) + { + /* + * The extension is not relocatable and the author gave us a + * schema for it. + * + * Unless CASCADE parameter was given, it's an error to give a + * schema different from control->schema if control->schema is + * specified. + */ + if (!cascade) + { + ereport(ERROR, + (errcode(ERRCODE_FEATURE_NOT_SUPPORTED), + errmsg("extension \"%s\" must be installed in schema \"%s\"", + control->name, + control->schema), + errhint("Do not specify SCHEMA when running CREATE EXTENSION for extension \"%s\"", control->name))); + } + + /* + * If the schema mismatches and CASCADE was given, we pretend the + * user did not specify a schema and use the normal logic below to + * get or create the schema from the control file. + */ + } + else if (control->owned_schema) + { + return CreateOwnedSchemaForExtension(*schemaName); + } + else + { + return schemaOid; + } + } + + if (control->schema) + { + Oid schemaOid; + + *schemaName = control->schema; + + if (control->owned_schema) + { + return CreateOwnedSchemaForExtension(control->schema); + } + + /* Find or create the schema in case it does not exist. */ + schemaOid = get_namespace_oid(control->schema, true); + if (OidIsValid(schemaOid)) + { + return schemaOid; + } + return CreateSchemaForExtension(control->schema); + } + + if (control->owned_schema) + { + ereport(ERROR, + (errcode(ERRCODE_UNDEFINED_SCHEMA), + errmsg("no schema has been selected to create in"))); + } + + { + /* + * Neither user nor author of the extension specified schema; use the + * current default creation namespace, which is the first explicit + * entry in the search_path. + */ + List *search_path = fetch_search_path(false); + Oid schemaOid; + + if (search_path == NIL) /* nothing valid in search_path? */ + ereport(ERROR, + (errcode(ERRCODE_UNDEFINED_SCHEMA), + errmsg("no schema has been selected to create in"))); + schemaOid = linitial_oid(search_path); + *schemaName = get_namespace_name(schemaOid); + if (*schemaName == NULL) /* recently-deleted namespace? */ + ereport(ERROR, + (errcode(ERRCODE_UNDEFINED_SCHEMA), + errmsg("no schema has been selected to create in"))); + + list_free(search_path); + return schemaOid; + } +} + /* * CREATE EXTENSION worker * @@ -1739,78 +1907,7 @@ CreateExtensionInternal(char *extensionName, */ control = read_extension_aux_control_file(pcontrol, versionName); - /* - * Determine the target schema to install the extension into - */ - if (schemaName) - { - /* If the user is giving us the schema name, it must exist already. */ - schemaOid = get_namespace_oid(schemaName, false); - } - - if (control->schema != NULL) - { - /* - * The extension is not relocatable and the author gave us a schema - * for it. - * - * Unless CASCADE parameter was given, it's an error to give a schema - * different from control->schema if control->schema is specified. - */ - if (schemaName && strcmp(control->schema, schemaName) != 0 && - !cascade) - ereport(ERROR, - (errcode(ERRCODE_FEATURE_NOT_SUPPORTED), - errmsg("extension \"%s\" must be installed in schema \"%s\"", - control->name, - control->schema))); - - /* Always use the schema from control file for current extension. */ - schemaName = control->schema; - - /* Find or create the schema in case it does not exist. */ - schemaOid = get_namespace_oid(schemaName, true); - - if (!OidIsValid(schemaOid)) - { - CreateSchemaStmt *csstmt = makeNode(CreateSchemaStmt); - - csstmt->schemaname = schemaName; - csstmt->authrole = NULL; /* will be created by current user */ - csstmt->schemaElts = NIL; - csstmt->if_not_exists = false; - CreateSchemaCommand(csstmt, "(generated CREATE SCHEMA command)", - -1, -1); - - /* - * CreateSchemaCommand includes CommandCounterIncrement, so new - * schema is now visible. - */ - schemaOid = get_namespace_oid(schemaName, false); - } - } - else if (!OidIsValid(schemaOid)) - { - /* - * Neither user nor author of the extension specified schema; use the - * current default creation namespace, which is the first explicit - * entry in the search_path. - */ - List *search_path = fetch_search_path(false); - - if (search_path == NIL) /* nothing valid in search_path? */ - ereport(ERROR, - (errcode(ERRCODE_UNDEFINED_SCHEMA), - errmsg("no schema has been selected to create in"))); - schemaOid = linitial_oid(search_path); - schemaName = get_namespace_name(schemaOid); - if (schemaName == NULL) /* recently-deleted namespace? */ - ereport(ERROR, - (errcode(ERRCODE_UNDEFINED_SCHEMA), - errmsg("no schema has been selected to create in"))); - - list_free(search_path); - } + schemaOid = GetOrCreateSchemaForExtension(&schemaName, control, cascade); /* * Make note if a temporary namespace has been accessed in this @@ -1856,6 +1953,7 @@ CreateExtensionInternal(char *extensionName, */ address = InsertExtensionTuple(control->name, extowner, schemaOid, control->relocatable, + control->owned_schema, versionName, PointerGetDatum(NULL), PointerGetDatum(NULL), @@ -2061,7 +2159,8 @@ CreateExtension(ParseState *pstate, CreateExtensionStmt *stmt) */ ObjectAddress InsertExtensionTuple(const char *extName, Oid extOwner, - Oid schemaOid, bool relocatable, const char *extVersion, + Oid schemaOid, bool relocatable, bool ownedSchema, + const char *extVersion, Datum extConfig, Datum extCondition, List *requiredExtensions) { @@ -2091,6 +2190,7 @@ InsertExtensionTuple(const char *extName, Oid extOwner, values[Anum_pg_extension_extowner - 1] = ObjectIdGetDatum(extOwner); values[Anum_pg_extension_extnamespace - 1] = ObjectIdGetDatum(schemaOid); values[Anum_pg_extension_extrelocatable - 1] = BoolGetDatum(relocatable); + values[Anum_pg_extension_extownedschema - 1] = BoolGetDatum(ownedSchema); values[Anum_pg_extension_extversion - 1] = CStringGetTextDatum(extVersion); if (extConfig == PointerGetDatum(NULL)) @@ -2135,6 +2235,17 @@ InsertExtensionTuple(const char *extName, Oid extOwner, record_object_address_dependencies(&myself, refobjs, DEPENDENCY_NORMAL); free_object_addresses(refobjs); + if (ownedSchema) + { + ObjectAddress schemaAddress = { + .classId = NamespaceRelationId, + .objectId = schemaOid, + }; + + recordDependencyOn(&schemaAddress, &myself, DEPENDENCY_EXTENSION); + } + + /* Post creation hook for new extension */ InvokeObjectPostCreateHook(ExtensionRelationId, extensionOid, 0); @@ -3035,12 +3146,16 @@ extension_config_remove(Oid extensionoid, Oid tableoid) /* * Execute ALTER EXTENSION SET SCHEMA + * + * For owned schemas, this boils down to changing the name of its schema. For + * non-owned schemas this requires moving all the member objects into the new + * schema. */ ObjectAddress AlterExtensionNamespace(const char *extensionName, const char *newschema, Oid *oldschema) { Oid extensionOid; - Oid nspOid; + Oid nspOid = InvalidOid; Oid oldNspOid; AclResult aclresult; Relation extRel; @@ -3053,11 +3168,10 @@ AlterExtensionNamespace(const char *extensionName, const char *newschema, Oid *o HeapTuple depTup; ObjectAddresses *objsMoved; ObjectAddress extAddr; + bool ownedSchema; extensionOid = get_extension_oid(extensionName, false); - nspOid = LookupCreationNamespace(newschema); - /* * Permission check: must own extension. Note that we don't bother to * check ownership of the individual member objects ... @@ -3066,22 +3180,6 @@ AlterExtensionNamespace(const char *extensionName, const char *newschema, Oid *o aclcheck_error(ACLCHECK_NOT_OWNER, OBJECT_EXTENSION, extensionName); - /* Permission check: must have creation rights in target namespace */ - aclresult = object_aclcheck(NamespaceRelationId, nspOid, GetUserId(), ACL_CREATE); - if (aclresult != ACLCHECK_OK) - aclcheck_error(aclresult, OBJECT_SCHEMA, newschema); - - /* - * If the schema is currently a member of the extension, disallow moving - * the extension into the schema. That would create a dependency loop. - */ - if (getExtensionOfObject(NamespaceRelationId, nspOid) == extensionOid) - ereport(ERROR, - (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE), - errmsg("cannot move extension \"%s\" into schema \"%s\" " - "because the extension contains the schema", - extensionName, newschema))); - /* Locate the pg_extension tuple */ extRel = table_open(ExtensionRelationId, RowExclusiveLock); @@ -3105,14 +3203,43 @@ AlterExtensionNamespace(const char *extensionName, const char *newschema, Oid *o systable_endscan(extScan); + ownedSchema = extForm->extownedschema; + /* - * If the extension is already in the target schema, just silently do - * nothing. + * For non-owned schemas, we should now evaluate if the target schema is a + * valid target. For owned schemas, no such checks are needed, because + * we'll simply rename the existing schema. */ - if (extForm->extnamespace == nspOid) + if (!ownedSchema) { - table_close(extRel, RowExclusiveLock); - return InvalidObjectAddress; + nspOid = LookupCreationNamespace(newschema); + + /* Permission check: must have creation rights in target namespace */ + aclresult = object_aclcheck(NamespaceRelationId, nspOid, GetUserId(), ACL_CREATE); + if (aclresult != ACLCHECK_OK) + aclcheck_error(aclresult, OBJECT_SCHEMA, newschema); + + /* + * If the schema is currently a member of the extension, disallow + * moving the extension into the schema. That would create a + * dependency loop. + */ + if (getExtensionOfObject(NamespaceRelationId, nspOid) == extensionOid) + ereport(ERROR, + (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE), + errmsg("cannot move extension \"%s\" into schema \"%s\" " + "because the extension contains the schema", + extensionName, newschema))); + + /* + * If the extension is already in the target schema, just silently do + * nothing. + */ + if (extForm->extnamespace == nspOid) + { + table_close(extRel, RowExclusiveLock); + return InvalidObjectAddress; + } } /* Check extension is supposed to be relocatable */ @@ -3185,6 +3312,13 @@ AlterExtensionNamespace(const char *extensionName, const char *newschema, Oid *o } } + /* + * We don't actually move any objects for owned schemas because we + * simply rename the schema that these objects are already in. + */ + if (ownedSchema) + continue; + /* * Otherwise, ignore non-membership dependencies. (Currently, the * only other case we could see here is a normal dependency from @@ -3228,18 +3362,35 @@ AlterExtensionNamespace(const char *extensionName, const char *newschema, Oid *o relation_close(depRel, AccessShareLock); - /* Now adjust pg_extension.extnamespace */ - extForm->extnamespace = nspOid; + /* Now actually update the schema of the extension. */ + if (ownedSchema) + { + /* + * For owned schemas, we simply rename the schema. This means that we + * don't need to update the extension its catalog entry, because the + * oid of the schema will stay the same. + */ + RenameSchema(get_namespace_name(oldNspOid), newschema); + table_close(extRel, RowExclusiveLock); + } + else + { + /* + * For non-owned schemas, we now have to update the extension's schema + * entry, and also update the dependencies. + */ + extForm->extnamespace = nspOid; - CatalogTupleUpdate(extRel, &extTup->t_self, extTup); + CatalogTupleUpdate(extRel, &extTup->t_self, extTup); - table_close(extRel, RowExclusiveLock); + table_close(extRel, RowExclusiveLock); - /* update dependency to point to the new schema */ - if (changeDependencyFor(ExtensionRelationId, extensionOid, - NamespaceRelationId, oldNspOid, nspOid) != 1) - elog(ERROR, "could not change schema dependency for extension %s", - NameStr(extForm->extname)); + /* update dependency to point to the new schema */ + if (changeDependencyFor(ExtensionRelationId, extensionOid, + NamespaceRelationId, oldNspOid, nspOid) != 1) + elog(ERROR, "could not change schema dependency for extension %s", + NameStr(extForm->extname)); + } InvokeObjectPostAlterHook(ExtensionRelationId, extensionOid, 0); diff --git a/src/backend/utils/adt/pg_upgrade_support.c b/src/backend/utils/adt/pg_upgrade_support.c index a4f8b4faa90..15bd265375c 100644 --- a/src/backend/utils/adt/pg_upgrade_support.c +++ b/src/backend/utils/adt/pg_upgrade_support.c @@ -19,6 +19,7 @@ #include "catalog/pg_subscription_rel.h" #include "catalog/pg_type.h" #include "commands/extension.h" +#include "commands/schemacmds.h" #include "miscadmin.h" #include "replication/logical.h" #include "replication/logicallauncher.h" @@ -185,12 +186,14 @@ Datum binary_upgrade_create_empty_extension(PG_FUNCTION_ARGS) { text *extName; - text *schemaName; + char *schemaName; bool relocatable; + bool ownedschema; text *extVersion; Datum extConfig; Datum extCondition; List *requiredExtensions; + Oid schemaOid; CHECK_IS_BINARY_UPGRADE; @@ -198,28 +201,30 @@ binary_upgrade_create_empty_extension(PG_FUNCTION_ARGS) if (PG_ARGISNULL(0) || PG_ARGISNULL(1) || PG_ARGISNULL(2) || - PG_ARGISNULL(3)) + PG_ARGISNULL(3) || + PG_ARGISNULL(4)) elog(ERROR, "null argument to binary_upgrade_create_empty_extension is not allowed"); extName = PG_GETARG_TEXT_PP(0); - schemaName = PG_GETARG_TEXT_PP(1); + schemaName = text_to_cstring(PG_GETARG_TEXT_PP(1)); relocatable = PG_GETARG_BOOL(2); - extVersion = PG_GETARG_TEXT_PP(3); + ownedschema = PG_GETARG_BOOL(3); + extVersion = PG_GETARG_TEXT_PP(4); - if (PG_ARGISNULL(4)) + if (PG_ARGISNULL(5)) extConfig = PointerGetDatum(NULL); else - extConfig = PG_GETARG_DATUM(4); + extConfig = PG_GETARG_DATUM(5); - if (PG_ARGISNULL(5)) + if (PG_ARGISNULL(6)) extCondition = PointerGetDatum(NULL); else - extCondition = PG_GETARG_DATUM(5); + extCondition = PG_GETARG_DATUM(6); requiredExtensions = NIL; - if (!PG_ARGISNULL(6)) + if (!PG_ARGISNULL(7)) { - ArrayType *textArray = PG_GETARG_ARRAYTYPE_P(6); + ArrayType *textArray = PG_GETARG_ARRAYTYPE_P(7); Datum *textDatums; int ndatums; int i; @@ -234,10 +239,28 @@ binary_upgrade_create_empty_extension(PG_FUNCTION_ARGS) } } + if (ownedschema) + { + CreateSchemaStmt *csstmt = makeNode(CreateSchemaStmt); + + csstmt->schemaname = schemaName; + csstmt->authrole = NULL; /* will be created by current user */ + csstmt->schemaElts = NIL; + csstmt->if_not_exists = false; + schemaOid = CreateSchemaCommand(csstmt, "(generated CREATE SCHEMA command)", + -1, -1); + + } + else + { + schemaOid = get_namespace_oid(schemaName, false); + } + InsertExtensionTuple(text_to_cstring(extName), GetUserId(), - get_namespace_oid(text_to_cstring(schemaName), false), + schemaOid, relocatable, + ownedschema, text_to_cstring(extVersion), extConfig, extCondition, diff --git a/src/bin/pg_dump/pg_dump.c b/src/bin/pg_dump/pg_dump.c index fc7a6639163..a8c25cb3f44 100644 --- a/src/bin/pg_dump/pg_dump.c +++ b/src/bin/pg_dump/pg_dump.c @@ -1921,6 +1921,19 @@ checkExtensionMembership(DumpableObject *dobj, Archive *fout) if (ext == NULL) return false; + /* + * If this is the "owned_schema" of the extension, then we don't want to + * create it manually, because it gets created together with the + * extension. + */ + if (dobj->objType == DO_NAMESPACE && + ext->ownedschema && strcmp(ext->namespace, dobj->name) == 0) + { + NamespaceInfo *nsinfo = (NamespaceInfo *) dobj; + + nsinfo->create = false; + } + dobj->ext_member = true; /* Record dependency so that getDependencies needn't deal with that */ @@ -5855,7 +5868,7 @@ binary_upgrade_extension_member(PQExpBuffer upgrade_buffer, const char *objname, const char *objnamespace) { - DumpableObject *extobj = NULL; + ExtensionInfo *ext = NULL; int i; if (!dobj->ext_member) @@ -5869,19 +5882,33 @@ binary_upgrade_extension_member(PQExpBuffer upgrade_buffer, */ for (i = 0; i < dobj->nDeps; i++) { - extobj = findObjectByDumpId(dobj->dependencies[i]); + DumpableObject *extobj = findObjectByDumpId(dobj->dependencies[i]); + if (extobj && extobj->objType == DO_EXTENSION) + { + ext = (ExtensionInfo *) extobj; break; - extobj = NULL; + } } - if (extobj == NULL) + if (ext == NULL) pg_fatal("could not find parent extension for %s %s", objtype, objname); + /* + * If the object is the "owned_schema" of the extension, we don't need to + * add it to the extension because it was already made a member of the + * extension when the extension was created. + */ + if (dobj->objType == DO_NAMESPACE && + ext->ownedschema && strcmp(ext->namespace, dobj->name) == 0) + { + return; + } + appendPQExpBufferStr(upgrade_buffer, "\n-- For binary upgrade, handle extension membership the hard way\n"); appendPQExpBuffer(upgrade_buffer, "ALTER EXTENSION %s ADD %s ", - fmtId(extobj->name), + fmtId(ext->dobj.name), objtype); if (objnamespace && *objnamespace) appendPQExpBuffer(upgrade_buffer, "%s.", fmtId(objnamespace)); @@ -6038,6 +6065,7 @@ getExtensions(Archive *fout, int *numExtensions) int i_extname; int i_nspname; int i_extrelocatable; + int i_extownedschema; int i_extversion; int i_extconfig; int i_extcondition; @@ -6046,7 +6074,14 @@ getExtensions(Archive *fout, int *numExtensions) appendPQExpBufferStr(query, "SELECT x.tableoid, x.oid, " "x.extname, n.nspname, x.extrelocatable, x.extversion, x.extconfig, x.extcondition " - "FROM pg_extension x " + ); + + if (fout->remoteVersion >= 180000) + appendPQExpBufferStr(query, ", x.extownedschema "); + else + appendPQExpBufferStr(query, ", false AS extownedschema "); + + appendPQExpBufferStr(query, "FROM pg_extension x " "JOIN pg_namespace n ON n.oid = x.extnamespace"); res = ExecuteSqlQuery(fout, query->data, PGRES_TUPLES_OK); @@ -6062,6 +6097,7 @@ getExtensions(Archive *fout, int *numExtensions) i_extname = PQfnumber(res, "extname"); i_nspname = PQfnumber(res, "nspname"); i_extrelocatable = PQfnumber(res, "extrelocatable"); + i_extownedschema = PQfnumber(res, "extownedschema"); i_extversion = PQfnumber(res, "extversion"); i_extconfig = PQfnumber(res, "extconfig"); i_extcondition = PQfnumber(res, "extcondition"); @@ -6075,6 +6111,7 @@ getExtensions(Archive *fout, int *numExtensions) extinfo[i].dobj.name = pg_strdup(PQgetvalue(res, i, i_extname)); extinfo[i].namespace = pg_strdup(PQgetvalue(res, i, i_nspname)); extinfo[i].relocatable = *(PQgetvalue(res, i, i_extrelocatable)) == 't'; + extinfo[i].ownedschema = *(PQgetvalue(res, i, i_extownedschema)) == 't'; extinfo[i].extversion = pg_strdup(PQgetvalue(res, i, i_extversion)); extinfo[i].extconfig = pg_strdup(PQgetvalue(res, i, i_extconfig)); extinfo[i].extcondition = pg_strdup(PQgetvalue(res, i, i_extcondition)); @@ -11782,9 +11819,9 @@ dumpNamespace(Archive *fout, const NamespaceInfo *nspinfo) { /* see selectDumpableNamespace() */ appendPQExpBufferStr(delq, - "-- *not* dropping schema, since initdb creates it\n"); + "-- *not* dropping schema, since initdb or CREATE EXTENSION creates it\n"); appendPQExpBufferStr(q, - "-- *not* creating schema, since initdb creates it\n"); + "-- *not* creating schema, since initdb or CREATE EXTENSION creates it\n"); } if (dopt->binary_upgrade) @@ -11896,6 +11933,7 @@ dumpExtension(Archive *fout, const ExtensionInfo *extinfo) appendStringLiteralAH(q, extinfo->namespace, fout); appendPQExpBufferStr(q, ", "); appendPQExpBuffer(q, "%s, ", extinfo->relocatable ? "true" : "false"); + appendPQExpBuffer(q, "%s, ", extinfo->ownedschema ? "true" : "false"); appendStringLiteralAH(q, extinfo->extversion, fout); appendPQExpBufferStr(q, ", "); diff --git a/src/bin/pg_dump/pg_dump.h b/src/bin/pg_dump/pg_dump.h index dde85ed156c..ebd391b447e 100644 --- a/src/bin/pg_dump/pg_dump.h +++ b/src/bin/pg_dump/pg_dump.h @@ -195,6 +195,7 @@ typedef struct _extensionInfo DumpableObject dobj; char *namespace; /* schema containing extension's objects */ bool relocatable; + bool ownedschema; char *extversion; char *extconfig; /* info about configuration tables */ char *extcondition; diff --git a/src/include/catalog/pg_extension.h b/src/include/catalog/pg_extension.h index 9214ebedafa..022bd6dd92b 100644 --- a/src/include/catalog/pg_extension.h +++ b/src/include/catalog/pg_extension.h @@ -34,6 +34,7 @@ CATALOG(pg_extension,3079,ExtensionRelationId) Oid extnamespace BKI_LOOKUP(pg_namespace); /* namespace of * contained objects */ bool extrelocatable; /* if true, allow ALTER EXTENSION SET SCHEMA */ + bool extownedschema; /* if true, schema is owned by extension */ #ifdef CATALOG_VARLEN /* variable-length fields start here */ /* extversion may never be null, but the others can be. */ diff --git a/src/include/catalog/pg_proc.dat b/src/include/catalog/pg_proc.dat index 118d6da1ace..e47c087cd9b 100644 --- a/src/include/catalog/pg_proc.dat +++ b/src/include/catalog/pg_proc.dat @@ -11761,7 +11761,7 @@ { oid => '3591', descr => 'for use by pg_upgrade', proname => 'binary_upgrade_create_empty_extension', proisstrict => 'f', provolatile => 'v', proparallel => 'u', prorettype => 'void', - proargtypes => 'text text bool text _oid _text _text', + proargtypes => 'text text bool bool text _oid _text _text', prosrc => 'binary_upgrade_create_empty_extension' }, { oid => '4083', descr => 'for use by pg_upgrade', proname => 'binary_upgrade_set_record_init_privs', provolatile => 'v', diff --git a/src/include/commands/extension.h b/src/include/commands/extension.h index 24419bfb5c9..205c5c7245f 100644 --- a/src/include/commands/extension.h +++ b/src/include/commands/extension.h @@ -38,7 +38,9 @@ extern ObjectAddress CreateExtension(ParseState *pstate, CreateExtensionStmt *st extern void RemoveExtensionById(Oid extId); extern ObjectAddress InsertExtensionTuple(const char *extName, Oid extOwner, - Oid schemaOid, bool relocatable, const char *extVersion, + Oid schemaOid, bool relocatable, + bool ownedSchema, + const char *extVersion, Datum extConfig, Datum extCondition, List *requiredExtensions); diff --git a/src/test/modules/test_extensions/Makefile b/src/test/modules/test_extensions/Makefile index a3591bf3d2f..a6594c19d7e 100644 --- a/src/test/modules/test_extensions/Makefile +++ b/src/test/modules/test_extensions/Makefile @@ -9,7 +9,8 @@ EXTENSION = test_ext1 test_ext2 test_ext3 test_ext4 test_ext5 test_ext6 \ test_ext_extschema \ test_ext_evttrig \ test_ext_set_schema \ - test_ext_req_schema1 test_ext_req_schema2 test_ext_req_schema3 + test_ext_req_schema1 test_ext_req_schema2 test_ext_req_schema3 \ + test_ext_owned_schema test_ext_owned_schema_relocatable DATA = test_ext1--1.0.sql test_ext2--1.0.sql test_ext3--1.0.sql \ test_ext4--1.0.sql test_ext5--1.0.sql test_ext6--1.0.sql \ @@ -25,7 +26,9 @@ DATA = test_ext1--1.0.sql test_ext2--1.0.sql test_ext3--1.0.sql \ test_ext_set_schema--1.0.sql \ test_ext_req_schema1--1.0.sql \ test_ext_req_schema2--1.0.sql \ - test_ext_req_schema3--1.0.sql + test_ext_req_schema3--1.0.sql \ + test_ext_owned_schema--1.0.sql \ + test_ext_owned_schema_relocatable--1.0.sql REGRESS = test_extensions test_extdepend TAP_TESTS = 1 diff --git a/src/test/modules/test_extensions/expected/test_extensions.out b/src/test/modules/test_extensions/expected/test_extensions.out index 72bae1bf254..bf9fc295280 100644 --- a/src/test/modules/test_extensions/expected/test_extensions.out +++ b/src/test/modules/test_extensions/expected/test_extensions.out @@ -9,6 +9,7 @@ CREATE EXTENSION test_ext1 SCHEMA test_ext; ERROR: schema "test_ext" does not exist CREATE EXTENSION test_ext1 SCHEMA has$dollar; ERROR: extension "test_ext1" must be installed in schema "test_ext1" +HINT: Do not specify SCHEMA when running CREATE EXTENSION for extension "test_ext1" -- finally success CREATE EXTENSION test_ext1 SCHEMA has$dollar CASCADE; NOTICE: installing required extension "test_ext2" @@ -668,3 +669,56 @@ SELECT test_s_dep.dep_req2(); DROP EXTENSION test_ext_req_schema1 CASCADE; NOTICE: drop cascades to extension test_ext_req_schema2 +-- +-- Test owned schema extensions +-- +CREATE SCHEMA test_ext_owned_schema; +-- Fails for an already existing schema to be provided +CREATE EXTENSION test_ext_owned_schema SCHEMA test_ext_owned_schema; +ERROR: schema "test_ext_owned_schema" already exists but the extension needs to create it +HINT: Drop schema "test_ext_owned_schema" or specify another schema using CREATE EXTENSION ... SCHEMA ... +-- Fails because a different schema is set in control file +CREATE EXTENSION test_ext_owned_schema SCHEMA test_schema; +ERROR: extension "test_ext_owned_schema" must be installed in schema "test_ext_owned_schema" +HINT: Do not specify SCHEMA when running CREATE EXTENSION for extension "test_ext_owned_schema" +DROP SCHEMA test_ext_owned_schema; +CREATE EXTENSION test_ext_owned_schema; +\dx+ test_ext_owned_schema; +Objects in extension "test_ext_owned_schema" + Object description +----------------------------------------- + function test_ext_owned_schema.owned1() + schema test_ext_owned_schema +(2 rows) + +DROP EXTENSION test_ext_owned_schema; +CREATE SCHEMA already_existing; +-- Fails for an already existing schema to be provided +CREATE EXTENSION test_ext_owned_schema_relocatable SCHEMA already_existing; +ERROR: schema "already_existing" already exists but the extension needs to create it +HINT: Drop schema "already_existing" or specify another schema using CREATE EXTENSION ... SCHEMA ... +-- Fails because no schema is set in control file +CREATE EXTENSION test_ext_owned_schema_relocatable; +ERROR: no schema has been selected to create in +CREATE EXTENSION test_ext_owned_schema_relocatable SCHEMA test_schema; +\dx+ test_ext_owned_schema_relocatable +Objects in extension "test_ext_owned_schema_relocatable" + Object description +------------------------------- + function test_schema.owned2() + schema test_schema +(2 rows) + +-- Fails because schema already exists +ALTER EXTENSION test_ext_owned_schema_relocatable SET SCHEMA already_existing; +ERROR: schema "already_existing" already exists +ALTER EXTENSION test_ext_owned_schema_relocatable SET SCHEMA some_other_name; +\dx+ test_ext_owned_schema_relocatable +Objects in extension "test_ext_owned_schema_relocatable" + Object description +----------------------------------- + function some_other_name.owned2() + schema some_other_name +(2 rows) + +DROP EXTENSION test_ext_owned_schema_relocatable; diff --git a/src/test/modules/test_extensions/meson.build b/src/test/modules/test_extensions/meson.build index 3c7e378bf35..c4913fb9c86 100644 --- a/src/test/modules/test_extensions/meson.build +++ b/src/test/modules/test_extensions/meson.build @@ -44,6 +44,10 @@ test_install_data += files( 'test_ext_req_schema3.control', 'test_ext_set_schema--1.0.sql', 'test_ext_set_schema.control', + 'test_ext_owned_schema--1.0.sql', + 'test_ext_owned_schema.control', + 'test_ext_owned_schema_relocatable--1.0.sql', + 'test_ext_owned_schema_relocatable.control', ) tests += { diff --git a/src/test/modules/test_extensions/sql/test_extensions.sql b/src/test/modules/test_extensions/sql/test_extensions.sql index b5878f6f80f..a97866d00ea 100644 --- a/src/test/modules/test_extensions/sql/test_extensions.sql +++ b/src/test/modules/test_extensions/sql/test_extensions.sql @@ -303,3 +303,30 @@ ALTER EXTENSION test_ext_req_schema1 SET SCHEMA test_s_dep2; -- now ok SELECT test_s_dep2.dep_req1(); SELECT test_s_dep.dep_req2(); DROP EXTENSION test_ext_req_schema1 CASCADE; + +-- +-- Test owned schema extensions +-- + +CREATE SCHEMA test_ext_owned_schema; +-- Fails for an already existing schema to be provided +CREATE EXTENSION test_ext_owned_schema SCHEMA test_ext_owned_schema; +-- Fails because a different schema is set in control file +CREATE EXTENSION test_ext_owned_schema SCHEMA test_schema; +DROP SCHEMA test_ext_owned_schema; +CREATE EXTENSION test_ext_owned_schema; +\dx+ test_ext_owned_schema; +DROP EXTENSION test_ext_owned_schema; + +CREATE SCHEMA already_existing; +-- Fails for an already existing schema to be provided +CREATE EXTENSION test_ext_owned_schema_relocatable SCHEMA already_existing; +-- Fails because no schema is set in control file +CREATE EXTENSION test_ext_owned_schema_relocatable; +CREATE EXTENSION test_ext_owned_schema_relocatable SCHEMA test_schema; +\dx+ test_ext_owned_schema_relocatable +-- Fails because schema already exists +ALTER EXTENSION test_ext_owned_schema_relocatable SET SCHEMA already_existing; +ALTER EXTENSION test_ext_owned_schema_relocatable SET SCHEMA some_other_name; +\dx+ test_ext_owned_schema_relocatable +DROP EXTENSION test_ext_owned_schema_relocatable; diff --git a/src/test/modules/test_extensions/test_ext_owned_schema--1.0.sql b/src/test/modules/test_extensions/test_ext_owned_schema--1.0.sql new file mode 100644 index 00000000000..672ab8e607f --- /dev/null +++ b/src/test/modules/test_extensions/test_ext_owned_schema--1.0.sql @@ -0,0 +1,2 @@ +CREATE FUNCTION owned1() RETURNS text +LANGUAGE SQL AS $$ SELECT 1 $$; diff --git a/src/test/modules/test_extensions/test_ext_owned_schema.control b/src/test/modules/test_extensions/test_ext_owned_schema.control new file mode 100644 index 00000000000..531c38daefd --- /dev/null +++ b/src/test/modules/test_extensions/test_ext_owned_schema.control @@ -0,0 +1,5 @@ +comment = 'Test extension with an owned schema' +default_version = '1.0' +relocatable = false +schema = test_ext_owned_schema +owned_schema = true diff --git a/src/test/modules/test_extensions/test_ext_owned_schema_relocatable--1.0.sql b/src/test/modules/test_extensions/test_ext_owned_schema_relocatable--1.0.sql new file mode 100644 index 00000000000..bfccaf4af82 --- /dev/null +++ b/src/test/modules/test_extensions/test_ext_owned_schema_relocatable--1.0.sql @@ -0,0 +1,2 @@ +CREATE FUNCTION owned2() RETURNS text +LANGUAGE SQL AS $$ SELECT 1 $$; diff --git a/src/test/modules/test_extensions/test_ext_owned_schema_relocatable.control b/src/test/modules/test_extensions/test_ext_owned_schema_relocatable.control new file mode 100644 index 00000000000..3cda1e12341 --- /dev/null +++ b/src/test/modules/test_extensions/test_ext_owned_schema_relocatable.control @@ -0,0 +1,4 @@ +comment = 'Test extension with an owned schema' +default_version = '1.0' +relocatable = true +owned_schema = true diff --git a/src/test/modules/test_pg_dump/t/001_base.pl b/src/test/modules/test_pg_dump/t/001_base.pl index adcaa419616..bb7d414da16 100644 --- a/src/test/modules/test_pg_dump/t/001_base.pl +++ b/src/test/modules/test_pg_dump/t/001_base.pl @@ -381,6 +381,38 @@ my %tests = ( }, }, + 'CREATE EXTENSION test_ext_owned_schema' => { + create_order => 1, + create_sql => 'CREATE EXTENSION test_ext_owned_schema;', + regexp => qr/^ + \QCREATE EXTENSION IF NOT EXISTS test_ext_owned_schema WITH SCHEMA test_ext_owned_schema;\E + \n/xm, + like => { + %full_runs, + schema_only => 1, + section_pre_data => 1, + }, + unlike => { + binary_upgrade => 1, + with_extension => 1, + without_extension => 1 + } + }, + + 'CREATE SCHEMA test_ext_owned_schema' => { + regexp => qr/^ + \QCREATE SCHEMA test_ext_owned_schema;\E + \n/xm, + like => {}, + }, + + 'ALTER EXTENSION test_ext_owned_schema ADD SCHEMA test_ext_owned_schema' => { + regexp => qr/^ + \QALTER EXTENSION test_ext_owned_schema ADD SCHEMA test_ext_owned_schema;\E + \n/xm, + like => {}, + }, + 'CREATE ROLE regress_dump_test_role' => { create_order => 1, create_sql => 'CREATE ROLE regress_dump_test_role;', base-commit: 36aed19fd99021ad9f727e4fd4bceb086a7cf54d -- 2.51.0