Disallow "=" in names of reloptions and foreign-data options.

We store values for these options as array elements with the syntax
"name=value", hence a name containing "=" confuses matters when
it's time to read the array back in.  Since validation of the
options is often done (long) after this conversion to array format,
that leads to confusing and off-point error messages.  We can
improve matters by rejecting names containing "=" up-front.

(Probably a better design would have involved pairs of array
elements, but it's too late now --- and anyway, there's no
evident use-case for option names like this.  We already
reject such names in some other contexts such as GUCs.)

Reported-by: Chapman Flack <jcflack@acm.org>
Author: Tom Lane <tgl@sss.pgh.pa.us>
Reviewed-by: Chapman Flack <jcflack@acm.org>
Discussion: https://postgr.es/m/6830EB30.8090904@acm.org
Backpatch-through: 13

diff --git a/contrib/file_fdw/input/file_fdw.source b/contrib/file_fdw/input/file_fdw.source
index 45b728eeb3dfead53e1ecbdd00f0a816c6d86bf2..d8101d49840f8664047321da0935560484659db3 100644 (file)
--- a/contrib/file_fdw/input/file_fdw.source
+++ b/contrib/file_fdw/input/file_fdw.source
@@ -36,6 +36,8 @@ CREATE USER MAPPING FOR regress_file_fdw_superuser SERVER file_server;
 CREATE USER MAPPING FOR regress_no_priv_user SERVER file_server;
 
 -- validator tests
+CREATE FOREIGN TABLE tbl () SERVER file_server OPTIONS (foo 'bar');  -- ERROR
+CREATE FOREIGN TABLE tbl () SERVER file_server OPTIONS ("a=b" 'true');  -- ERROR
 CREATE FOREIGN TABLE tbl () SERVER file_server OPTIONS (format 'xml');  -- ERROR
 CREATE FOREIGN TABLE tbl () SERVER file_server OPTIONS (format 'text', header 'true');      -- ERROR
 CREATE FOREIGN TABLE tbl () SERVER file_server OPTIONS (format 'text', quote ':');          -- ERROR

diff --git a/contrib/file_fdw/output/file_fdw.source b/contrib/file_fdw/output/file_fdw.source
index 52b4d5f1df7fcc5fe0d2f8b734aad8690a63a85f..dfcc833d80b71c85c4cb4d59a3f2af675eae5624 100644 (file)
--- a/contrib/file_fdw/output/file_fdw.source
+++ b/contrib/file_fdw/output/file_fdw.source
@@ -31,6 +31,11 @@ SET ROLE regress_file_fdw_superuser;
 CREATE USER MAPPING FOR regress_file_fdw_superuser SERVER file_server;
 CREATE USER MAPPING FOR regress_no_priv_user SERVER file_server;
 -- validator tests
+CREATE FOREIGN TABLE tbl () SERVER file_server OPTIONS (foo 'bar');  -- ERROR
+ERROR:  invalid option "foo"
+HINT:  Valid options in this context are: filename, program, format, header, delimiter, quote, escape, null, encoding
+CREATE FOREIGN TABLE tbl () SERVER file_server OPTIONS ("a=b" 'true');  -- ERROR
+ERROR:  invalid option name "a=b": must not contain "="
 CREATE FOREIGN TABLE tbl () SERVER file_server OPTIONS (format 'xml');  -- ERROR
 ERROR:  COPY format "xml" not recognized
 CREATE FOREIGN TABLE tbl () SERVER file_server OPTIONS (format 'text', header 'true');      -- ERROR

diff --git a/src/backend/access/common/reloptions.c b/src/backend/access/common/reloptions.c
index 543ff6975e7ef85914286ac5aac47ac1f98f339e..a6d52c92413f00f24195660127e60122bac4540b 100644 (file)
--- a/src/backend/access/common/reloptions.c
+++ b/src/backend/access/common/reloptions.c
@@ -1209,8 +1209,9 @@ transformRelOptions(Datum oldOptions, List *defList, const char *namspace,
                }
                else
                {
-                       text       *t;
+                       const char *name;
                        const char *value;
+                       text       *t;
                        Size            len;
 
                        /*
@@ -1257,11 +1258,19 @@ transformRelOptions(Datum oldOptions, List *defList, const char *namspace,
                         * have just "name", assume "name=true" is meant.  Note: the
                         * namespace is not output.
                         */
+                       name = def->defname;
                        if (def->arg != NULL)
                                value = defGetString(def);
                        else
                                value = "true";
 
+                       /* Insist that name not contain "=", else "a=b=c" is ambiguous */
+                       if (strchr(name, '=') != NULL)
+                               ereport(ERROR,
+                                               (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
+                                                errmsg("invalid option name \"%s\": must not contain \"=\"",
+                                                               name)));
+
                        /*
                         * This is not a great place for this test, but there's no other
                         * convenient place to filter the option out. As WITH (oids =
@@ -1269,7 +1278,7 @@ transformRelOptions(Datum oldOptions, List *defList, const char *namspace,
                         * amount of ugly.
                         */
                        if (acceptOidsOff && def->defnamespace == NULL &&
-                               strcmp(def->defname, "oids") == 0)
+                               strcmp(name, "oids") == 0)
                        {
                                if (defGetBoolean(def))
                                        ereport(ERROR,
@@ -1279,11 +1288,11 @@ transformRelOptions(Datum oldOptions, List *defList, const char *namspace,
                                continue;
                        }
 
-                       len = VARHDRSZ + strlen(def->defname) + 1 + strlen(value);
+                       len = VARHDRSZ + strlen(name) + 1 + strlen(value);
                        /* +1 leaves room for sprintf's trailing null */
                        t = (text *) palloc(len + 1);
                        SET_VARSIZE(t, len);
-                       sprintf(VARDATA(t), "%s=%s", def->defname, value);
+                       sprintf(VARDATA(t), "%s=%s", name, value);
 
                        astate = accumArrayResult(astate, PointerGetDatum(t),
                                                                          false, TEXTOID,

diff --git a/src/backend/commands/foreigncmds.c b/src/backend/commands/foreigncmds.c
index 852292e905ffb2fc6ae1804f215b73acc5398dc8..720aa23edd97b882d22ad3cafebfa42ae1b0ff0d 100644 (file)
--- a/src/backend/commands/foreigncmds.c
+++ b/src/backend/commands/foreigncmds.c
@@ -71,15 +71,26 @@ optionListToArray(List *options)
        foreach(cell, options)
        {
                DefElem    *def = lfirst(cell);
+               const char *name;
                const char *value;
                Size            len;
                text       *t;
 
+               name = def->defname;
                value = defGetString(def);
-               len = VARHDRSZ + strlen(def->defname) + 1 + strlen(value);
+
+               /* Insist that name not contain "=", else "a=b=c" is ambiguous */
+               if (strchr(name, '=') != NULL)
+                       ereport(ERROR,
+                                       (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
+                                        errmsg("invalid option name \"%s\": must not contain \"=\"",
+                                                       name)));
+
+               len = VARHDRSZ + strlen(name) + 1 + strlen(value);
+               /* +1 leaves room for sprintf's trailing null */
                t = palloc(len + 1);
                SET_VARSIZE(t, len);
-               sprintf(VARDATA(t), "%s=%s", def->defname, value);
+               sprintf(VARDATA(t), "%s=%s", name, value);
 
                astate = accumArrayResult(astate, PointerGetDatum(t),
                                                                  false, TEXTOID,