pageinspect: Add more sanity checks to prevent out-of-bound reads
authorMichael Paquier <[email protected]>
Sun, 27 Mar 2022 08:54:08 +0000 (17:54 +0900)
committerMichael Paquier <[email protected]>
Sun, 27 Mar 2022 08:54:08 +0000 (17:54 +0900)
A couple of code paths use the special area on the page passed by the
function caller, expecting to find some data in it.  However, feeding
an incorrect page can lead to out-of-bound reads when trying to access
the page special area (like a heap page that has no special area,
leading PageGetSpecialPointer() to grab a pointer outside the allocated
page).

The functions used for hash and btree indexes have some protection
already against that, while some other functions using a relation OID
as argument would make sure that the access method involved is correct,
but functions taking in input a raw page without knowing the relation
the page is attached to would run into problems.

This commit improves the set of checks used in the code paths of BRIN,
btree (including one check if a leaf page is found with a non-zero
level), GIN and GiST to verify that the page given in input has a
special area size that fits with each access method, which is done
though PageGetSpecialSize(), becore calling PageGetSpecialPointer().

The scope of the checks done is limited to work with pages that one
would pass after getting a block with get_raw_page(), as it is possible
to craft byteas that could bypass existing code paths.  Having too many
checks would also impact the usability of pageinspect, as the existing
code is very useful to look at the content details in a corrupted page,
so the focus is really to avoid out-of-bound reads as this is never a
good thing even with functions whose execution is limited to
superusers.

The safest approach could be to rework the functions so as these fetch a
block using a relation OID and a block number, but there are also cases
where using a raw page is useful.

Tests are added to cover all the code paths that needed such checks, and
an error message for hash indexes is reworded to fit better with what
this commit adds.

Reported-By: Alexander Lakhin
Author: Julien Rouhaud, Michael Paquier
Discussion: https://postgr.es/m/16527-ef7606186f0610a1@postgresql.org
Discussion: https://postgr.es/m/561e187b-3549-c8d5-03f5-525c14e65bd0@postgrespro.ru
Backpatch-through: 10

12 files changed:
contrib/pageinspect/brinfuncs.c
contrib/pageinspect/btreefuncs.c
contrib/pageinspect/expected/brin.out
contrib/pageinspect/expected/btree.out
contrib/pageinspect/expected/gin.out
contrib/pageinspect/expected/hash.out
contrib/pageinspect/ginfuncs.c
contrib/pageinspect/hashfuncs.c
contrib/pageinspect/sql/brin.sql
contrib/pageinspect/sql/btree.sql
contrib/pageinspect/sql/gin.sql
contrib/pageinspect/sql/hash.sql

index 49d9820012d986cb1778d72532ce5bac8f2ea981..3472e0ebb123ecf866697b00d1f1b857332afdf5 100644 (file)
@@ -60,6 +60,15 @@ brin_page_type(PG_FUNCTION_ARGS)
 
    page = get_page_from_raw(raw_page);
 
+   /* verify the special space has the expected size */
+   if (PageGetSpecialSize(page) != MAXALIGN(sizeof(BrinSpecialSpace)))
+           ereport(ERROR,
+                   (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
+                    errmsg("input page is not a valid %s page", "BRIN"),
+                    errdetail("Expected special size %d, got %d.",
+                              (int) MAXALIGN(sizeof(BrinSpecialSpace)),
+                              (int) PageGetSpecialSize(page))));
+
    switch (BrinPageType(page))
    {
        case BRIN_PAGETYPE_META:
@@ -88,6 +97,15 @@ verify_brin_page(bytea *raw_page, uint16 type, const char *strtype)
 {
    Page        page = get_page_from_raw(raw_page);
 
+   /* verify the special space has the expected size */
+   if (PageGetSpecialSize(page) != MAXALIGN(sizeof(BrinSpecialSpace)))
+           ereport(ERROR,
+                   (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
+                    errmsg("input page is not a valid %s page", "BRIN"),
+                    errdetail("Expected special size %d, got %d.",
+                              (int) MAXALIGN(sizeof(BrinSpecialSpace)),
+                              (int) PageGetSpecialSize(page))));
+
    /* verify the special space says this page is what we want */
    if (BrinPageType(page) != type)
        ereport(ERROR,
index ea445fdf31e1e9a75725a1cf6dda0bf3342f9bae..59d1f54e2373f969f80298e2043286a3bea04961 100644 (file)
@@ -449,6 +449,15 @@ bt_page_items_bytea(PG_FUNCTION_ARGS)
 
        uargs->offset = FirstOffsetNumber;
 
+       /* verify the special space has the expected size */
+       if (PageGetSpecialSize(uargs->page) != MAXALIGN(sizeof(BTPageOpaqueData)))
+           ereport(ERROR,
+                   (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
+                    errmsg("input page is not a valid %s page", "btree"),
+                    errdetail("Expected special size %d, got %d.",
+                              (int) MAXALIGN(sizeof(BTPageOpaqueData)),
+                              (int) PageGetSpecialSize(uargs->page))));
+
        opaque = (BTPageOpaque) PageGetSpecialPointer(uargs->page);
 
        if (P_ISMETA(opaque))
@@ -456,6 +465,11 @@ bt_page_items_bytea(PG_FUNCTION_ARGS)
                    (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                     errmsg("block is a meta page")));
 
+       if (P_ISLEAF(opaque) && opaque->btpo.level != 0)
+           ereport(ERROR,
+                   (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
+                    errmsg("block is not a valid btree leaf page")));
+
        if (P_ISDELETED(opaque))
            elog(NOTICE, "page is deleted");
 
index 10cd36c1778c1035e2ed6d677f3911757b80d5dc..62ee783b604d1b08a2ee15392f1a6f6a4c682c9f 100644 (file)
@@ -52,4 +52,14 @@ SELECT * FROM brin_page_items(get_raw_page('test1_a_idx', 2), 'test1_a_idx')
 CREATE INDEX test1_a_btree ON test1 (a);
 SELECT brin_page_items(get_raw_page('test1_a_btree', 0), 'test1_a_btree');
 ERROR:  "test1_a_btree" is not a BRIN index
+-- Mask DETAIL messages as these are not portable across architectures.
+\set VERBOSITY terse
+-- Invalid special area size
+SELECT brin_page_type(get_raw_page('test1', 0));
+ERROR:  input page is not a valid BRIN page
+SELECT * FROM brin_metapage_info(get_raw_page('test1', 0));
+ERROR:  input page is not a valid BRIN page
+SELECT * FROM brin_revmap_data(get_raw_page('test1', 0));
+ERROR:  input page is not a valid BRIN page
+\set VERBOSITY default
 DROP TABLE test1;
index 85dc797104aff5056bbcfc66d0292c75ff72b021..d01d08bd7d217139c0ea211e85dd80231c9b2b9a 100644 (file)
@@ -1,5 +1,5 @@
-CREATE TABLE test1 (a int8, b text);
-INSERT INTO test1 VALUES (72057594037927937, 'text');
+CREATE TABLE test1 (a int8, b int4range);
+INSERT INTO test1 VALUES (72057594037927937, '[0,1)');
 CREATE INDEX test1_a_idx ON test1 USING btree (a);
 \x
 SELECT * FROM bt_metap('test1_a_idx');
@@ -63,11 +63,25 @@ SELECT bt_page_stats('test1_a_hash', 0);
 ERROR:  "test1_a_hash" is not a btree index
 SELECT bt_page_items('test1_a_hash', 0);
 ERROR:  "test1_a_hash" is not a btree index
--- Failure with incorrect page size
+SELECT bt_page_items(get_raw_page('test1_a_hash', 0));
+ERROR:  block is a meta page
+CREATE INDEX test1_b_gist ON test1 USING gist(b);
+-- Special area of GiST is the same as btree, this complains about inconsistent
+-- leaf data on the page.
+SELECT bt_page_items(get_raw_page('test1_b_gist', 0));
+ERROR:  block is not a valid btree leaf page
+-- Several failure modes.
 -- Suppress the DETAIL message, to allow the tests to work across various
--- page sizes.
+-- page sizes and architectures.
 \set VERBOSITY terse
+-- invalid page size
 SELECT bt_page_items('aaa'::bytea);
 ERROR:  invalid page size
+-- invalid special area size
+CREATE INDEX test1_a_brin ON test1 USING brin(a);
+SELECT bt_page_items(get_raw_page('test1', 0));
+ERROR:  input page is not a valid btree page
+SELECT bt_page_items(get_raw_page('test1_a_brin', 0));
+ERROR:  input page is not a valid btree page
 \set VERBOSITY default
 DROP TABLE test1;
index c0f759509875e9881e28f1bde8514d07524febdf..c1f93ffaa199b7ef6c07ab9b0381504327215e6e 100644 (file)
@@ -35,14 +35,22 @@ FROM gin_leafpage_items(get_raw_page('test1_y_idx',
 -[ RECORD 1 ]
 ?column? | t
 
--- Failure with incorrect page size
+-- Failure with various modes.
 -- Suppress the DETAIL message, to allow the tests to work across various
--- page sizes.
+-- page sizes and architectures.
 \set VERBOSITY terse
+-- invalid page size
 SELECT gin_leafpage_items('aaa'::bytea);
 ERROR:  invalid page size
 SELECT gin_metapage_info('bbb'::bytea);
 ERROR:  invalid page size
 SELECT gin_page_opaque_info('ccc'::bytea);
 ERROR:  invalid page size
+-- invalid special area size
+SELECT * FROM gin_metapage_info(get_raw_page('test1', 0));
+ERROR:  input page is not a valid GIN metapage
+SELECT * FROM gin_page_opaque_info(get_raw_page('test1', 0));
+ERROR:  input page is not a valid GIN data leaf page
+SELECT * FROM gin_leafpage_items(get_raw_page('test1', 0));
+ERROR:  input page is not a valid GIN data leaf page
 \set VERBOSITY default
index 12369ddfa29dede36c33599a82045a74ecb00f7c..7db8abe0998839386bcc5835081a6cbed61293fb 100644 (file)
@@ -163,10 +163,11 @@ ERROR:  page is not a hash bucket or overflow page
 CREATE INDEX test_hash_a_btree ON test_hash USING btree (a);
 SELECT hash_bitmap_info('test_hash_a_btree', 0);
 ERROR:  "test_hash_a_btree" is not a hash index
--- Failure with incorrect page size
+-- Failure with various modes.
 -- Suppress the DETAIL message, to allow the tests to work across various
--- page sizes.
+-- page sizes and architectures.
 \set VERBOSITY terse
+-- invalid page size
 SELECT hash_metapage_info('aaa'::bytea);
 ERROR:  invalid page size
 SELECT hash_page_items('bbb'::bytea);
@@ -175,5 +176,14 @@ SELECT hash_page_stats('ccc'::bytea);
 ERROR:  invalid page size
 SELECT hash_page_type('ddd'::bytea);
 ERROR:  invalid page size
+-- invalid special area size
+SELECT hash_metapage_info(get_raw_page('test_hash', 0));
+ERROR:  input page is not a valid hash page
+SELECT hash_page_items(get_raw_page('test_hash', 0));
+ERROR:  input page is not a valid hash page
+SELECT hash_page_stats(get_raw_page('test_hash', 0));
+ERROR:  input page is not a valid hash page
+SELECT hash_page_type(get_raw_page('test_hash', 0));
+ERROR:  input page is not a valid hash page
 \set VERBOSITY default
 DROP TABLE test_hash;
index f774495b6fbe7927e213561a92ea326e575f6d89..e9ed8bf8c966fe61d9b34521f8e0a77a2d67bb7f 100644 (file)
@@ -50,6 +50,14 @@ gin_metapage_info(PG_FUNCTION_ARGS)
 
    page = get_page_from_raw(raw_page);
 
+   if (PageGetSpecialSize(page) != MAXALIGN(sizeof(GinPageOpaqueData)))
+       ereport(ERROR,
+               (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
+                errmsg("input page is not a valid GIN metapage"),
+                errdetail("Expected special size %d, got %d.",
+                          (int) MAXALIGN(sizeof(GinPageOpaqueData)),
+                          (int) PageGetSpecialSize(page))));
+
    opaq = (GinPageOpaque) PageGetSpecialPointer(page);
    if (opaq->flags != GIN_META)
        ereport(ERROR,
@@ -108,6 +116,14 @@ gin_page_opaque_info(PG_FUNCTION_ARGS)
 
    page = get_page_from_raw(raw_page);
 
+   if (PageGetSpecialSize(page) != MAXALIGN(sizeof(GinPageOpaqueData)))
+       ereport(ERROR,
+               (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
+                errmsg("input page is not a valid GIN data leaf page"),
+                errdetail("Expected special size %d, got %d.",
+                          (int) MAXALIGN(sizeof(GinPageOpaqueData)),
+                          (int) PageGetSpecialSize(page))));
+
    opaq = (GinPageOpaque) PageGetSpecialPointer(page);
 
    /* Build a tuple descriptor for our result type */
@@ -188,9 +204,9 @@ gin_leafpage_items(PG_FUNCTION_ARGS)
            ereport(ERROR,
                    (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                     errmsg("input page is not a valid GIN data leaf page"),
-                    errdetail("Special size %d, expected %d",
-                              (int) PageGetSpecialSize(page),
-                              (int) MAXALIGN(sizeof(GinPageOpaqueData)))));
+                    errdetail("Expected special size %d, got %d.",
+                              (int) MAXALIGN(sizeof(GinPageOpaqueData)),
+                              (int) PageGetSpecialSize(page))));
 
        opaq = (GinPageOpaque) PageGetSpecialPointer(page);
        if (opaq->flags != (GIN_DATA | GIN_LEAF | GIN_COMPRESSED))
index 2a7aeedcecbb75f3316fc7ee7d52e059c2e1ce6f..50b0bc22c5f75aa19839bc8a3b3294dd1ff0017d 100644 (file)
@@ -65,14 +65,17 @@ verify_hash_page(bytea *raw_page, int flags)
 
        if (PageGetSpecialSize(page) != MAXALIGN(sizeof(HashPageOpaqueData)))
            ereport(ERROR,
-                   (errcode(ERRCODE_INDEX_CORRUPTED),
-                    errmsg("index table contains corrupted page")));
+                   (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
+                    errmsg("input page is not a valid %s page", "hash"),
+                    errdetail("Expected special size %d, got %d.",
+                              (int) MAXALIGN(sizeof(HashPageOpaqueData)),
+                              (int) PageGetSpecialSize(page))));
 
        pageopaque = (HashPageOpaque) PageGetSpecialPointer(page);
        if (pageopaque->hasho_page_id != HASHO_PAGE_ID)
            ereport(ERROR,
                    (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
-                    errmsg("page is not a hash page"),
+                    errmsg("input page is not a valid %s page", "hash"),
                     errdetail("Expected %08x, got %08x.",
                               HASHO_PAGE_ID, pageopaque->hasho_page_id)));
 
@@ -129,7 +132,7 @@ verify_hash_page(bytea *raw_page, int flags)
            ereport(ERROR,
                    (errcode(ERRCODE_INDEX_CORRUPTED),
                     errmsg("invalid version for metadata"),
-                    errdetail("Expected %d, got %d",
+                    errdetail("Expected %d, got %d.",
                               HASH_VERSION, metap->hashm_version)));
    }
 
index 8717229c5d2f85fdd6930578e287c8247ca3f1c6..dc5d1661b6d03c3e5ccf4aa17651e03d4df2e981 100644 (file)
@@ -19,4 +19,12 @@ SELECT * FROM brin_page_items(get_raw_page('test1_a_idx', 2), 'test1_a_idx')
 CREATE INDEX test1_a_btree ON test1 (a);
 SELECT brin_page_items(get_raw_page('test1_a_btree', 0), 'test1_a_btree');
 
+-- Mask DETAIL messages as these are not portable across architectures.
+\set VERBOSITY terse
+-- Invalid special area size
+SELECT brin_page_type(get_raw_page('test1', 0));
+SELECT * FROM brin_metapage_info(get_raw_page('test1', 0));
+SELECT * FROM brin_revmap_data(get_raw_page('test1', 0));
+\set VERBOSITY default
+
 DROP TABLE test1;
index 174814fb7a4590d87b7f63b9c460d27a802a34d0..cde0083586cb523b107209a1f228d975b2ceac29 100644 (file)
@@ -1,5 +1,5 @@
-CREATE TABLE test1 (a int8, b text);
-INSERT INTO test1 VALUES (72057594037927937, 'text');
+CREATE TABLE test1 (a int8, b int4range);
+INSERT INTO test1 VALUES (72057594037927937, '[0,1)');
 CREATE INDEX test1_a_idx ON test1 USING btree (a);
 
 \x
@@ -23,12 +23,22 @@ CREATE INDEX test1_a_hash ON test1 USING hash(a);
 SELECT bt_metap('test1_a_hash');
 SELECT bt_page_stats('test1_a_hash', 0);
 SELECT bt_page_items('test1_a_hash', 0);
+SELECT bt_page_items(get_raw_page('test1_a_hash', 0));
+CREATE INDEX test1_b_gist ON test1 USING gist(b);
+-- Special area of GiST is the same as btree, this complains about inconsistent
+-- leaf data on the page.
+SELECT bt_page_items(get_raw_page('test1_b_gist', 0));
 
--- Failure with incorrect page size
+-- Several failure modes.
 -- Suppress the DETAIL message, to allow the tests to work across various
--- page sizes.
+-- page sizes and architectures.
 \set VERBOSITY terse
+-- invalid page size
 SELECT bt_page_items('aaa'::bytea);
+-- invalid special area size
+CREATE INDEX test1_a_brin ON test1 USING brin(a);
+SELECT bt_page_items(get_raw_page('test1', 0));
+SELECT bt_page_items(get_raw_page('test1_a_brin', 0));
 \set VERBOSITY default
 
 DROP TABLE test1;
index 2a653609750f16838de86a3746c7ec4e4b03c7fd..342354a481f780a46e33680f04a88396da8828f1 100644 (file)
@@ -18,11 +18,16 @@ FROM gin_leafpage_items(get_raw_page('test1_y_idx',
                         (pg_relation_size('test1_y_idx') /
                          current_setting('block_size')::bigint)::int - 1));
 
--- Failure with incorrect page size
+-- Failure with various modes.
 -- Suppress the DETAIL message, to allow the tests to work across various
--- page sizes.
+-- page sizes and architectures.
 \set VERBOSITY terse
+-- invalid page size
 SELECT gin_leafpage_items('aaa'::bytea);
 SELECT gin_metapage_info('bbb'::bytea);
 SELECT gin_page_opaque_info('ccc'::bytea);
+-- invalid special area size
+SELECT * FROM gin_metapage_info(get_raw_page('test1', 0));
+SELECT * FROM gin_page_opaque_info(get_raw_page('test1', 0));
+SELECT * FROM gin_leafpage_items(get_raw_page('test1', 0));
 \set VERBOSITY default
index 546c780e0e4c5d4bb7d208bb439a84d953fb0ed3..8fd209c815b5f030b895dbac8ff988e5a536dab5 100644 (file)
@@ -80,14 +80,20 @@ SELECT * FROM hash_page_items(get_raw_page('test_hash_a_idx', 5));
 CREATE INDEX test_hash_a_btree ON test_hash USING btree (a);
 SELECT hash_bitmap_info('test_hash_a_btree', 0);
 
--- Failure with incorrect page size
+-- Failure with various modes.
 -- Suppress the DETAIL message, to allow the tests to work across various
--- page sizes.
+-- page sizes and architectures.
 \set VERBOSITY terse
+-- invalid page size
 SELECT hash_metapage_info('aaa'::bytea);
 SELECT hash_page_items('bbb'::bytea);
 SELECT hash_page_stats('ccc'::bytea);
 SELECT hash_page_type('ddd'::bytea);
+-- invalid special area size
+SELECT hash_metapage_info(get_raw_page('test_hash', 0));
+SELECT hash_page_items(get_raw_page('test_hash', 0));
+SELECT hash_page_stats(get_raw_page('test_hash', 0));
+SELECT hash_page_type(get_raw_page('test_hash', 0));
 \set VERBOSITY default
 
 DROP TABLE test_hash;