Proof Portal

Projects

jsonparser

ProbeLabs23 findings · 123 requirements

The fastest JSON parser for Go — formally verified with ReqProof (real library, master).

All requirements
RequirementSYS-REQ-115SystemApproved

When a Config with AllowSingleQuotes=true is provided, the parser shall accept single-quoted strings (delimited by ' instead of ") using the same escape rules as double-quoted strings.

3/4 obligations satisfied, automated checks pass.
PriorityshallTypeguaranteeCategoryfunctionalComponentparserAssuranceBFindingsnone open

Specification

The requirement exactly as authored — its complete prose text and, where present, the formal FRETish sentence it compiles to.

Description

When a Config with AllowSingleQuotes=true is provided, the parser shall accept single-quoted strings (delimited by ' instead of ") using the same escape rules as double-quoted strings. When AllowUnknownEscapes=true, unknown escape sequences shall be passed through literally instead of returning an error. The default Config shall remain strict (RFC 8259 only).

FRETish formula
the parser shall always satisfy config_lenient_modes_are_opt_in_and_default_remains_strict
View full formal model

Rationale & tags

Why this requirement exists, and how it is categorised.

v1.5.0 introduces explicit opt-in compatibility modes for common non-RFC JSON emitted by external systems while preserving the strict behavior and API contracts of every existing package-level function.

configlenientsingle_quotesescapesnominalmalformed_inputencoding_safety

Verification & provenance

How this requirement was checked: the review trail, edit history, and the machine-analysis status terms (each ⓘ explains what it means).

Assurance levelB
Formalizationvalid
Realizabilityrealizable
Vacuitychecked_ok
Strategyfretish

Review

Status
approved
Reviewer
Buger · lead_engineer
Reviewed
Jul 28, 2026, 13:58 UTC
v1.5.0: Config + lenient parsing (SYS-REQ-115), streaming ReaderParser (SYS-REQ-116)

History

Created
Jul 28, 2026, 00:00 UTC · Codex · AI agent
Modified
Jul 28, 2026, 13:58 UTC · Buger

Change history

Every recorded revision of this requirement's source file — newest first, each with its commit message and the diff for that change.

Every recorded revision of this object's source — newest first, each with the commit message and its file-level diff.

Obligations

What this requirement must witness to be considered satisfied — the required evidence, and the tests that discharge each one.

3 obligations · 2 discharged · 1 not yet witnessed

Browse the catalogue
Discharged

Happy-path behavior with valid inputs.

If it were violatedMedium

A Config with AllowSingleQuotes enabled fails to recognize matching single-quoted keys or values, returns incorrect offsets, or lets a quote/bracket inside a single-quoted string terminate the surrounding container early.

Discharging evidence1/1 required witnessed
  • nominalrequiredpresent
    Covered by 5 tests
1/2 witnessed

Behavior when inputs are syntactically or structurally invalid.

Worst case if violatedMedium

DefaultConfig or an existing package-level function silently accepts single-quoted input or unknown escapes, weakening the established strict contract for callers that rely on malformed-input rejection.

Discharging evidence1/2 required witnessed
  • negativerequirednot yet witnessed
    Required evidence not yet witnessed — no covering test recorded.
  • nominalrequiredpresent
    Covered by 2 tests
Discharged

Behavior specified for encoding and decoding round-trips.

If it were violatedMedium

AllowUnknownEscapes drops or duplicates bytes, consumes a malformed Unicode escape as an unknown escape, or emits a different literal value than the escaped input represents.

Discharging evidence1/1 required witnessed
  • nominalrequiredpresent
    Covered by 1 test

Formula evidence

The formal formula behind this requirement, the variables it is written over, and the tests that exercise it (each term is explained inline).

FRETish formula

the parser shall always satisfy config_lenient_modes_are_opt_in_and_default_remains_strict

Variables

NameTypeDirectionDescription
config_lenient_modes_are_opt_in_and_default_remains_strictTrue when Config accepts single-quoted strings only with AllowSingleQuotes, passes unknown escape bytes through literally only with AllowUnknownEscapes, and the zero/default Config plus package-level functions retain strict RFC 8259 behavior.

Witnesses· 2 scenarios total

  • TestMCDC_SYS_REQ_115_Row2_LenientConfigParsesSingleQuotes
    exercises 1 condition scenario
  • TestMCDC_SYS_REQ_115_Row1_StrictConfigRejectsSingleQuotes
    exercises 1 condition scenario

MC/DC truth table· 2 rows

Each row assigns the formula's conditions (T/F) and shows the Result— the formula's value for that input row, not a test pass/fail. A row proves a condition when flipping only that condition flips the outcome. The test that covers each row is linked.

Covereda test exercises this rowExempteda reviewed mcdc:ignoreNo-actionfalse-result row satisfied by designUncoveredneeds a covering test
#config_lenient_modes_are_opt_in_and_default_remains_strictResultProvesCovering test
1FFconfig_lenient_modes_are_opt_in_and_default_remains_strict
2TTconfig_lenient_modes_are_opt_in_and_default_remains_strict

Its place

This requirement shown inside its trace neighbourhood — the parents it satisfies, the code and tests attached to it, and its findings.

Loading graph…

Trace evidence

The concrete artifacts linked to this requirement — implementing code, verifying tests, documents, and the findings raised against it.

Impact

Blast radius — if you change this requirement, what else may need re-checking, and what it in turn depends on.

If you change this

Requirements
0
Files
3
Tests
2
At-risk contracts
0

Files to re-check (3)

  • config.goconfig.go
  • escape.goescape.go
  • parser.goparser.go

Tests to re-run (2)

  • config_test.goconfig_test.go
  • v150_mcdc_witness_test.gov150_mcdc_witness_test.go

What this rests on

Changes

Semantic changes that move or scope this requirement — the intended work touching it. Each links to the full change.

Discussions

Discuss this with the proof team. Nothing changes in your audit automatically — you open a request and a staff member records any outcome inside the thread.

Sign in to discuss this with the proof team.Sign in