| 1 |
package writer |
| 2 |
|
| 3 |
import ( |
| 4 |
"fmt" |
| 5 |
"net/netip" |
| 6 |
"os" |
| 7 |
"path/filepath" |
| 8 |
|
| 9 |
"github.com/maxmind/mmdbwriter" |
| 10 |
"github.com/maxmind/mmdbwriter/mmdbtype" |
| 11 |
"go4.org/netipx" |
| 12 |
) |
| 13 |
|
| 14 |
// WriteBadDataDBs writes intentionally corrupt or extreme MMDB databases |
| 15 |
// for testing error handling in reader implementations. |
| 16 |
func (w *Writer) WriteBadDataDBs(target string) error { |
| 17 |
//nolint:gosec // not security sensitive. |
| 18 |
if err := os.MkdirAll(target, os.ModePerm); err != nil { |
| 19 |
return fmt.Errorf("creating bad-data directory: %w", err) |
| 20 |
} |
| 21 |
|
| 22 |
// Raw binary databases — can't use mmdbwriter because the data is |
| 23 |
// intentionally invalid or uses values mmdbwriter can't represent. |
| 24 |
for _, db := range []struct { |
| 25 |
name string |
| 26 |
data []byte |
| 27 |
}{ |
| 28 |
{"libmaxminddb-oversized-array.mmdb", buildOversizedArrayDB()}, |
| 29 |
{"libmaxminddb-oversized-map.mmdb", buildOversizedMapDB()}, |
| 30 |
{"libmaxminddb-uint64-max-epoch.mmdb", buildUint64MaxEpochDB()}, |
| 31 |
{"libmaxminddb-corrupt-search-tree.mmdb", buildCorruptSearchTreeDB()}, |
| 32 |
{"libmaxminddb-empty-map-last-in-metadata.mmdb", buildEmptyMapLastInMetadataDB()}, |
| 33 |
{"libmaxminddb-empty-array-last-in-metadata.mmdb", buildEmptyArrayLastInMetadataDB()}, |
| 34 |
} { |
| 35 |
if err := writeRawDB(target, db.name, db.data); err != nil { |
| 36 |
return fmt.Errorf("writing %s: %w", db.name, err) |
| 37 |
} |
| 38 |
} |
| 39 |
|
| 40 |
// Deep nesting uses mmdbwriter — structurally valid, just 600 levels deep. |
| 41 |
if err := writeDeepNestingDB(target); err != nil { |
| 42 |
return fmt.Errorf("writing deep nesting database: %w", err) |
| 43 |
} |
| 44 |
|
| 45 |
if err := writeDeepArrayNestingDB(target); err != nil { |
| 46 |
return fmt.Errorf("writing deep array nesting database: %w", err) |
| 47 |
} |
| 48 |
|
| 49 |
return nil |
| 50 |
} |
| 51 |
|
| 52 |
func writeRawDB(dir, name string, data []byte) error { |
| 53 |
path := filepath.Join(dir, name) |
| 54 |
if err := os.WriteFile(path, data, 0o644); err != nil { |
| 55 |
return fmt.Errorf("writing file: %w", err) |
| 56 |
} |
| 57 |
return nil |
| 58 |
} |
| 59 |
|
| 60 |
// writeDeepArrayNestingDB creates an MMDB with 600 levels of nested arrays. |
| 61 |
// This exceeds libmaxminddb's MAXIMUM_DATA_STRUCTURE_DEPTH (512) and |
| 62 |
// should trigger MMDB_INVALID_DATA_ERROR during data extraction. |
| 63 |
func writeDeepArrayNestingDB(dir string) (retErr error) { |
| 64 |
dbWriter, err := mmdbwriter.New( |
| 65 |
mmdbwriter.Options{ |
| 66 |
DatabaseType: "Test", |
| 67 |
BuildEpoch: 1_000_000_000, |
| 68 |
IPVersion: 4, |
| 69 |
RecordSize: 24, |
| 70 |
}, |
| 71 |
) |
| 72 |
if err != nil { |
| 73 |
return fmt.Errorf("creating mmdbwriter: %w", err) |
| 74 |
} |
| 75 |
|
| 76 |
// Build 600-level nested arrays: [[[... "x" ...]]] |
| 77 |
const depth = 600 |
| 78 |
var value mmdbtype.DataType = mmdbtype.String("x") |
| 79 |
for range depth { |
| 80 |
value = mmdbtype.Slice{value} |
| 81 |
} |
| 82 |
|
| 83 |
for _, cidr := range []string{"0.0.0.0/1", "128.0.0.0/1"} { |
| 84 |
prefix, err := netip.ParsePrefix(cidr) |
| 85 |
if err != nil { |
| 86 |
return fmt.Errorf("parsing prefix %s: %w", cidr, err) |
| 87 |
} |
| 88 |
if err := dbWriter.Insert(netipx.PrefixIPNet(prefix), value); err != nil { |
| 89 |
return fmt.Errorf("inserting %s: %w", cidr, err) |
| 90 |
} |
| 91 |
} |
| 92 |
|
| 93 |
path := filepath.Join(dir, "libmaxminddb-deep-array-nesting.mmdb") |
| 94 |
outputFile, err := os.Create(filepath.Clean(path)) |
| 95 |
if err != nil { |
| 96 |
return fmt.Errorf("creating file: %w", err) |
| 97 |
} |
| 98 |
defer func() { |
| 99 |
if err := outputFile.Close(); err != nil && retErr == nil { |
| 100 |
retErr = fmt.Errorf("closing file: %w", err) |
| 101 |
} |
| 102 |
}() |
| 103 |
|
| 104 |
if _, err := dbWriter.WriteTo(outputFile); err != nil { |
| 105 |
return fmt.Errorf("writing file: %w", err) |
| 106 |
} |
| 107 |
|
| 108 |
return nil |
| 109 |
} |
| 110 |
|
| 111 |
// writeDeepNestingDB creates an MMDB with 600 levels of nested maps. |
| 112 |
// This exceeds libmaxminddb's MAXIMUM_DATA_STRUCTURE_DEPTH (512) and |
| 113 |
// should trigger MMDB_INVALID_DATA_ERROR during data extraction. |
| 114 |
func writeDeepNestingDB(dir string) (retErr error) { |
| 115 |
dbWriter, err := mmdbwriter.New( |
| 116 |
mmdbwriter.Options{ |
| 117 |
DatabaseType: "Test", |
| 118 |
BuildEpoch: 1_000_000_000, |
| 119 |
IPVersion: 4, |
| 120 |
RecordSize: 24, |
| 121 |
}, |
| 122 |
) |
| 123 |
if err != nil { |
| 124 |
return fmt.Errorf("creating mmdbwriter: %w", err) |
| 125 |
} |
| 126 |
|
| 127 |
// Build 600-level nested structure: {"a": {"a": ... "x" ...}} |
| 128 |
const depth = 600 |
| 129 |
var value mmdbtype.DataType = mmdbtype.String("x") |
| 130 |
for range depth { |
| 131 |
value = mmdbtype.Map{"a": value} |
| 132 |
} |
| 133 |
|
| 134 |
// Insert for 0.0.0.0/1 and 128.0.0.0/1 to cover all IPv4 addresses. |
| 135 |
for _, cidr := range []string{"0.0.0.0/1", "128.0.0.0/1"} { |
| 136 |
prefix, err := netip.ParsePrefix(cidr) |
| 137 |
if err != nil { |
| 138 |
return fmt.Errorf("parsing prefix %s: %w", cidr, err) |
| 139 |
} |
| 140 |
if err := dbWriter.Insert(netipx.PrefixIPNet(prefix), value); err != nil { |
| 141 |
return fmt.Errorf("inserting %s: %w", cidr, err) |
| 142 |
} |
| 143 |
} |
| 144 |
|
| 145 |
path := filepath.Join(dir, "libmaxminddb-deep-nesting.mmdb") |
| 146 |
outputFile, err := os.Create(filepath.Clean(path)) |
| 147 |
if err != nil { |
| 148 |
return fmt.Errorf("creating file: %w", err) |
| 149 |
} |
| 150 |
defer func() { |
| 151 |
if err := outputFile.Close(); err != nil && retErr == nil { |
| 152 |
retErr = fmt.Errorf("closing file: %w", err) |
| 153 |
} |
| 154 |
}() |
| 155 |
|
| 156 |
if _, err := dbWriter.WriteTo(outputFile); err != nil { |
| 157 |
return fmt.Errorf("writing file: %w", err) |
| 158 |
} |
| 159 |
|
| 160 |
return nil |
| 161 |
} |