verifier.go

package maxminddb

import (
	"runtime"
	"unicode/utf8"

	"github.com/oschwald/maxminddb-golang/v2/internal/mmdberrors"
)

type verifier struct {
	reader *Reader
}

// Verify performs comprehensive validation of the MaxMind DB file.
//
// This method validates:
//   - Metadata section: format versions, required fields, and value constraints
//   - Search tree: traverses all networks to verify tree structure integrity
//   - Data section separator: validates the 16-byte separator between tree and data
//   - Data section: verifies all data records referenced by the search tree
//
// The verifier is stricter than the MaxMind DB specification and may return
// errors on some databases that are still readable by normal operations.
// This method is useful for:
//   - Validating database files after download or generation
//   - Debugging database corruption issues
//   - Ensuring database integrity in critical applications
//
// Note: Verification traverses the entire database and may be slow on large files.
// The method is thread-safe and can be called on an active Reader.
func (r *Reader) Verify() error {
	v := verifier{r}
	if err := v.verifyMetadata(); err != nil {
		return err
	}

	err := v.verifyDatabase()
	runtime.KeepAlive(v.reader)
	return err
}

func (v *verifier) verifyMetadata() error {
	metadata := v.reader.Metadata

	if metadata.BinaryFormatMajorVersion != 2 {
		return testError(
			"binary_format_major_version",
			2,
			metadata.BinaryFormatMajorVersion,
		)
	}

	if metadata.BinaryFormatMinorVersion != 0 {
		return testError(
			"binary_format_minor_version",
			0,
			metadata.BinaryFormatMinorVersion,
		)
	}

	if metadata.DatabaseType == "" {
		return testError(
			"database_type",
			"non-empty string",
			metadata.DatabaseType,
		)
	}
	if !utf8.ValidString(metadata.DatabaseType) {
		return mmdberrors.NewInvalidDatabaseError("database_type contains invalid UTF-8")
	}
	for language, description := range metadata.Description {
		if !utf8.ValidString(language) || !utf8.ValidString(description) {
			return mmdberrors.NewInvalidDatabaseError("description contains invalid UTF-8")
		}
	}
	for _, language := range metadata.Languages {
		if !utf8.ValidString(language) {
			return mmdberrors.NewInvalidDatabaseError("languages contains invalid UTF-8")
		}
	}

	if len(metadata.Description) == 0 {
		return testError(
			"description",
			"non-empty map",
			metadata.Description,
		)
	}

	if metadata.IPVersion != 4 && metadata.IPVersion != 6 {
		return testError(
			"ip_version",
			"4 or 6",
			metadata.IPVersion,
		)
	}

	if metadata.RecordSize != 24 &&
		metadata.RecordSize != 28 &&
		metadata.RecordSize != 32 {
		return testError(
			"record_size",
			"24, 28, or 32",
			metadata.RecordSize,
		)
	}

	if metadata.NodeCount == 0 {
		return testError(
			"node_count",
			"positive integer",
			metadata.NodeCount,
		)
	}
	return nil
}

func (v *verifier) verifyDatabase() error {
	offsets, err := v.verifySearchTree()
	if err != nil {
		return err
	}

	if err := v.verifyDataSectionSeparator(); err != nil {
		return err
	}

	return v.reader.decoder.VerifyDataSection(offsets)
}

func (v *verifier) verifySearchTree() (map[uint]bool, error) {
	offsets := make(map[uint]bool)

	for result := range v.reader.Networks() {
		if err := result.Err(); err != nil {
			return nil, err
		}
		offsets[result.offset] = true
	}
	return offsets, nil
}

func (v *verifier) verifyDataSectionSeparator() error {
	separatorStart := searchTreeSizeBytes(
		v.reader.Metadata.NodeCount,
		v.reader.Metadata.RecordSize,
	)
	separatorEnd := separatorStart + dataSectionSeparatorSize
	if separatorEnd < separatorStart || separatorEnd > uint(len(v.reader.buffer)) {
		return mmdberrors.NewInvalidDatabaseError(
			"unexpected end of database while reading data section separator",
		)
	}

	separator := v.reader.buffer[separatorStart:separatorEnd]

	var zeroSeparator [16]byte
	if [16]byte(separator) != zeroSeparator {
		return mmdberrors.NewInvalidDatabaseError(
			"unexpected byte in data separator: %v",
			separator,
		)
	}
	return nil
}

func testError(
	field string,
	expected any,
	actual any,
) error {
	return mmdberrors.NewInvalidDatabaseError(
		"%v - Expected: %v Actual: %v",
		field,
		expected,
		actual,
	)
}