github.com/jackc/pgx/v5 v5.10.0: pgproto3.SSLRequest

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify github.com/jackc/pgx/v5/pgproto3.SSLRequest in pkg:golang/github.com/jackc/pgx/v5@v5.10.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/github.com/jackc/pgx/v5@v5.10.0
Demonstrate these symbols/APIs:
  - github.com/jackc/pgx/v5/pgproto3.SSLRequest

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:68afcddee57b81edb794463e48a5eb1101f885f31ff3ecc1081fea90f46a8a77","contract":["pgproto3.SSLRequest implements pgproto3.FrontendMessage","SSLRequest.Encode produces 8 bytes with length 8 and code 80877103","SSLRequest.Decode successfully parses valid 4-byte payload 80877103","SSLRequest.Decode returns an error when payload is shorter than 4 bytes","SSLRequest.Decode returns an error when payload code is not 80877103","SSLRequest.MarshalJSON serializes to JSON with Type SSLRequest"],"goal":"verify github.com/jackc/pgx/v5/pgproto3.SSLRequest in pkg:golang/github.com/jackc/pgx/v5@v5.10.0","kind":"HOW","packages":["pkg:golang/github.com/jackc/pgx/v5@v5.10.0"],"schemaVersion":1,"symbols":["github.com/jackc/pgx/v5/pgproto3.SSLRequest"]},"contractCommand":["go","run","./test"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"golang","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"go","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/github.com/jackc/pgx/v5@v5.10.0"],"schemaVersion":1,"subject":"pkg:golang/github.com/jackc/pgx/v5@v5.10.0","symbols":["github.com/jackc/pgx/v5/pgproto3.SSLRequest"],"verifierAdapter":"golang@1"}

module sample

go 1.26.6

require github.com/jackc/pgx/v5 v5.10.0

github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsIM=
github.com/jackc/pgpassfile v1.0.0/go.mod h1:CEx0iS5ambNFdcRtxPj5JhEz+xB6uRky5eyVu/W2HEg=
github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 h1:iCEnooe7UlwOQYpKFhBabPMi4aNAfoODPEFNiAnClxo=
github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761/go.mod h1:5TJZWKEWniPve33vlWYSoGYefn3gLQRzjfDlhSJ9ZKM=
github.com/jackc/pgx/v5 v5.10.0 h1:VhSvgU2jSli8o3AqIEOTJr7rZwAEUVo4E4XhR94Zfr0=
github.com/jackc/pgx/v5 v5.10.0/go.mod h1:mal1tBGAFfLHvZzaYh77YS/eC6IX9OWbRV1QIIM0Jn4=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
golang.org/x/text v0.29.0 h1:1neNs90w9YzJ9BocxfsQNHKuAT4pkghyXc4nhZ6sJvk=
golang.org/x/text v0.29.0/go.mod h1:7MhJOA9CD2qZyOKYazxdYMF85OwPdEr9jTtBpO7ydH4=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

{
  "schemaVersion": 1,
  "goal": "verify github.com/jackc/pgx/v5/pgproto3.SSLRequest in pkg:golang/github.com/jackc/pgx/v5@v5.10.0",
  "kind": "HOW",
  "packages": [
    "pkg:golang/github.com/jackc/pgx/v5@v5.10.0"
  ],
  "symbols": [
    "github.com/jackc/pgx/v5/pgproto3.SSLRequest"
  ]
}

package sample

import (
	"fmt"

	"github.com/jackc/pgx/v5/pgproto3"
)

// SSLRequestCode is the PostgreSQL protocol SSL request code (80877103 or 1234.5679).
const SSLRequestCode uint32 = 80877103

// NewSSLRequest creates a new pgproto3.SSLRequest frontend message.
func NewSSLRequest() *pgproto3.SSLRequest {
	return &pgproto3.SSLRequest{}
}

// EncodeSSLRequest encodes an SSLRequest message into wire protocol bytes.
func EncodeSSLRequest(req *pgproto3.SSLRequest) ([]byte, error) {
	if req == nil {
		return nil, fmt.Errorf("ssl request is nil")
	}
	return req.Encode(nil)
}

// DecodeSSLRequest decodes wire protocol body bytes into an SSLRequest message.
func DecodeSSLRequest(src []byte) (*pgproto3.SSLRequest, error) {
	req := &pgproto3.SSLRequest{}
	if err := req.Decode(src); err != nil {
		return nil, err
	}
	return req, nil
}

// AsFrontendMessage verifies that SSLRequest implements the pgproto3.FrontendMessage interface.
func AsFrontendMessage(req *pgproto3.SSLRequest) pgproto3.FrontendMessage {
	return req
}

package main

import (
	"bytes"
	"encoding/binary"
	"fmt"
	"os"

	"github.com/jackc/pgx/v5/pgproto3"
	"sample"
)

func main() {
	// Assertion 1: pgproto3.SSLRequest instance creation and FrontendMessage interface
	req := sample.NewSSLRequest()
	if req == nil {
		fmt.Fprintf(os.Stderr, "expected non-nil SSLRequest\n")
		os.Exit(1)
	}

	var frontendMsg pgproto3.FrontendMessage = sample.AsFrontendMessage(req)
	if frontendMsg == nil {
		fmt.Fprintf(os.Stderr, "expected SSLRequest to implement pgproto3.FrontendMessage\n")
		os.Exit(1)
	}

	// Assertion 2: Encode produces 8 bytes with length 8 and SSL request code 80877103
	encoded, err := sample.EncodeSSLRequest(req)
	if err != nil {
		fmt.Fprintf(os.Stderr, "failed to encode SSLRequest: %v\n", err)
		os.Exit(1)
	}
	if len(encoded) != 8 {
		fmt.Fprintf(os.Stderr, "expected encoded length 8, got %d\n", len(encoded))
		os.Exit(1)
	}

	msgLen := binary.BigEndian.Uint32(encoded[0:4])
	if msgLen != 8 {
		fmt.Fprintf(os.Stderr, "expected message length 8, got %d\n", msgLen)
		os.Exit(1)
	}

	code := binary.BigEndian.Uint32(encoded[4:8])
	if code != sample.SSLRequestCode {
		fmt.Fprintf(os.Stderr, "expected SSL code %d, got %d\n", sample.SSLRequestCode, code)
		os.Exit(1)
	}

	// Assertion 3: Decode successfully parses valid 4-byte SSL request payload
	payload := encoded[4:8]
	decoded, err := sample.DecodeSSLRequest(payload)
	if err != nil {
		fmt.Fprintf(os.Stderr, "failed to decode valid payload: %v\n", err)
		os.Exit(1)
	}
	if decoded == nil {
		fmt.Fprintf(os.Stderr, "expected non-nil decoded SSLRequest\n")
		os.Exit(1)
	}

	// Assertion 4: Decode rejects payload shorter than 4 bytes
	shortPayload := []byte{0x04, 0xd2}
	if _, err := sample.DecodeSSLRequest(shortPayload); err == nil {
		fmt.Fprintf(os.Stderr, "expected error decoding short payload, got nil\n")
		os.Exit(1)
	}

	// Assertion 5: Decode rejects payload with invalid SSL request code
	invalidPayload := []byte{0x00, 0x00, 0x00, 0x01}
	if _, err := sample.DecodeSSLRequest(invalidPayload); err == nil {
		fmt.Fprintf(os.Stderr, "expected error decoding invalid code, got nil\n")
		os.Exit(1)
	}

	// Assertion 6: MarshalJSON returns valid JSON representation
	jsonBytes, err := req.MarshalJSON()
	if err != nil {
		fmt.Fprintf(os.Stderr, "failed to marshal SSLRequest to JSON: %v\n", err)
		os.Exit(1)
	}
	if !bytes.Contains(jsonBytes, []byte(`"Type":"SSLRequest"`)) {
		fmt.Fprintf(os.Stderr, "expected JSON to contain Type SSLRequest, got %s\n", string(jsonBytes))
		os.Exit(1)
	}

	fmt.Println("All github.com/jackc/pgx/v5/pgproto3.SSLRequest contract assertions passed.")
}