fix: escape enum values as Go string literals in generated code (#4448)#4481
Open
ArdyJunata wants to merge 1 commit into
Open
fix: escape enum values as Go string literals in generated code (#4448)#4481ArdyJunata wants to merge 1 commit into
ArdyJunata wants to merge 1 commit into
Conversation
Fixes sqlc-dev#4448 Enum values containing backslashes, double quotes, or other special characters were interpolated raw into the Go template: {{.Name}} {{.Type}} = "{{.Value}}" This caused silent data corruption: a PostgreSQL enum value like 'user\nadmin' (literal backslash + n, 11 bytes) became the Go constant "user\nadmin" (newline character, 10 bytes). Comparisons against the database value silently fail at runtime. Values containing double quotes broke go/format.Source() entirely. Values like 'injected" + "code" + "' generated valid-but-wrong Go string concatenation expressions. Fix: replace "{{.Value}}" with {{printf "%q" .Value}}. Go's %q verb produces a properly double-quoted, fully-escaped string literal — backslashes are doubled, double quotes are escaped, control characters use named sequences. The outer quotes are included by %q, so no surrounding quotes are needed in the template. Before: UserRoleUsernadmin UserRole = "user\nadmin" // newline! After: UserRoleUsernadmin UserRole = "user\\nadmin" // correct Regression tests added in internal/codegen/golang/enum_test.go covering: - plain values (unchanged) - literal backslash sequences (\n, \t, \\) - embedded control characters - double quotes in values - string concatenation injection pattern
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #4448
Problem
Enum values were interpolated raw into the Go code generation template:
This causes silent data corruption for any PostgreSQL enum value containing special characters:
user\nadmin(backslash + n, 11 bytes)"user\nadmin"(newline, 10 bytes)say "hello""say "hello""go/format.Source()entirelyinjected" + "arbitrary""injected" + "arbitrary"Fix
Replace
"{{.Value}}"with{{printf "%q" .Value}}on line 95 oftemplate.tmpl.Go's
%qverb produces a properly double-quoted, fully-escaped string literal — backslashes are doubled, double quotes are escaped, control characters use named sequences. The outer quotes are included by%q, so no surrounding quotes are needed in the template.Before:
After:
Testing
Regression tests added in
internal/codegen/golang/enum_test.gocovering:\n,\t,\\)All 13 new sub-tests pass.