golang.org/x/crypto v0.0.0-20191117063200-497ca9f6d64f: bcrypt.CompareHashAndPassword, bcrypt.Cost, bcrypt.GenerateFromPassword

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 pkg:golang/golang.org/x/crypto@v0.0.0-20191117063200-497ca9f6d64f
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/golang.org/x/crypto@v0.0.0-20191117063200-497ca9f6d64f

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:8e22937705d636b4ff629f1138e06e32e49a9531627f9571495b5be883d457cf","contract":["bcrypt.GenerateFromPassword generates a valid $2a$ bcrypt hash with MinCost","bcrypt.GenerateFromPassword with cost \u003c MinCost defaults to DefaultCost","bcrypt.Cost extracts the integer cost from a valid bcrypt hash","bcrypt.CompareHashAndPassword returns nil when password matches hash","bcrypt.CompareHashAndPassword returns ErrMismatchedHashAndPassword when password does not match","bcrypt.CompareHashAndPassword returns ErrHashTooShort when hash is shorter than 59 bytes","bcrypt.GenerateFromPassword rejects cost exceeding MaxCost with InvalidCostError","bcrypt.CompareHashAndPassword returns InvalidHashPrefixError when hash does not start with '$'"],"goal":"verify pkg:golang/golang.org/x/crypto@v0.0.0-20191117063200-497ca9f6d64f","kind":"HOW","packages":["pkg:golang/golang.org/x/crypto@v0.0.0-20191117063200-497ca9f6d64f"],"schemaVersion":1,"symbols":["bcrypt.CompareHashAndPassword","bcrypt.Cost","bcrypt.GenerateFromPassword"]},"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/golang.org/x/crypto@v0.0.0-20191117063200-497ca9f6d64f"],"schemaVersion":1,"subject":"pkg:golang/golang.org/x/crypto@v0.0.0-20191117063200-497ca9f6d64f","symbols":["bcrypt.CompareHashAndPassword","bcrypt.Cost","bcrypt.GenerateFromPassword"],"verifierAdapter":"golang@1"}

module example.com/sample

go 1.21

require golang.org/x/crypto v0.0.0-20191117063200-497ca9f6d64f

golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/crypto v0.0.0-20191117063200-497ca9f6d64f h1:kz4KIr+xcPUsI3VMoqWfPMvtnJ6MGfiVwsWSVzphMO4=
golang.org/x/crypto v0.0.0-20191117063200-497ca9f6d64f/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=

package main

import (
	"errors"
	"fmt"
	"log"

	"golang.org/x/crypto/bcrypt"
)

func main() {
	pass := []byte("sample-passphrase-2019")

	hash, err := bcrypt.GenerateFromPassword(pass, bcrypt.MinCost)
	if err != nil {
		log.Fatalf("GenerateFromPassword failed: %v", err)
	}
	fmt.Printf("Hash prefix: %s\n", string(hash[:4]))

	cost, err := bcrypt.Cost(hash)
	if err != nil {
		log.Fatalf("Cost failed: %v", err)
	}
	fmt.Printf("Hash cost: %d\n", cost)

	if err := bcrypt.CompareHashAndPassword(hash, pass); err != nil {
		log.Fatalf("CompareHashAndPassword failed: %v", err)
	}

	if err := bcrypt.CompareHashAndPassword(hash, []byte("invalid-passphrase")); !errors.Is(err, bcrypt.ErrMismatchedHashAndPassword) {
		log.Fatalf("Expected ErrMismatchedHashAndPassword, got: %v", err)
	}
	fmt.Println("Verification complete.")
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:golang/golang.org/x/crypto@v0.0.0-20191117063200-497ca9f6d64f",
  "kind": "HOW",
  "packages": [
    "pkg:golang/golang.org/x/crypto@v0.0.0-20191117063200-497ca9f6d64f"
  ]
}

package main

import (
	"bytes"
	"errors"
	"fmt"
	"os"

	"golang.org/x/crypto/bcrypt"
)

func main() {
	secret := []byte("correct-passphrase-verify")

	// 1. bcrypt.GenerateFromPassword generates a valid $2a$ bcrypt hash with MinCost
	minHash, err := bcrypt.GenerateFromPassword(secret, bcrypt.MinCost)
	if err != nil {
		fmt.Fprintf(os.Stderr, "GenerateFromPassword(MinCost) failed: %v\n", err)
		os.Exit(1)
	}
	if !bytes.HasPrefix(minHash, []byte("$2a$")) {
		fmt.Fprintf(os.Stderr, "expected $2a$ prefix, got: %s\n", string(minHash))
		os.Exit(1)
	}

	// 2. bcrypt.GenerateFromPassword with cost < MinCost defaults to DefaultCost
	defHash, err := bcrypt.GenerateFromPassword(secret, 0)
	if err != nil {
		fmt.Fprintf(os.Stderr, "GenerateFromPassword(0) failed: %v\n", err)
		os.Exit(1)
	}
	defCost, err := bcrypt.Cost(defHash)
	if err != nil || defCost != bcrypt.DefaultCost {
		fmt.Fprintf(os.Stderr, "expected DefaultCost %d, got %d (err: %v)\n", bcrypt.DefaultCost, defCost, err)
		os.Exit(1)
	}

	// 3. bcrypt.Cost extracts the integer cost from a valid bcrypt hash
	extractedCost, err := bcrypt.Cost(minHash)
	if err != nil || extractedCost != bcrypt.MinCost {
		fmt.Fprintf(os.Stderr, "expected MinCost %d, got %d (err: %v)\n", bcrypt.MinCost, extractedCost, err)
		os.Exit(1)
	}

	// 4. bcrypt.CompareHashAndPassword returns nil when password matches hash
	if err := bcrypt.CompareHashAndPassword(minHash, secret); err != nil {
		fmt.Fprintf(os.Stderr, "CompareHashAndPassword failed on valid password: %v\n", err)
		os.Exit(1)
	}

	// 5. bcrypt.CompareHashAndPassword returns ErrMismatchedHashAndPassword when password does not match
	if err := bcrypt.CompareHashAndPassword(minHash, []byte("wrong-passphrase")); !errors.Is(err, bcrypt.ErrMismatchedHashAndPassword) {
		fmt.Fprintf(os.Stderr, "expected ErrMismatchedHashAndPassword, got: %v\n", err)
		os.Exit(1)
	}

	// 6. bcrypt.CompareHashAndPassword returns ErrHashTooShort when hash is shorter than 59 bytes
	if err := bcrypt.CompareHashAndPassword([]byte("$2a$04$short"), secret); !errors.Is(err, bcrypt.ErrHashTooShort) {
		fmt.Fprintf(os.Stderr, "expected ErrHashTooShort, got: %v\n", err)
		os.Exit(1)
	}

	// 7. bcrypt.GenerateFromPassword rejects cost exceeding MaxCost with InvalidCostError
	var costErr bcrypt.InvalidCostError
	if _, err := bcrypt.GenerateFromPassword(secret, bcrypt.MaxCost+1); !errors.As(err, &costErr) {
		fmt.Fprintf(os.Stderr, "expected InvalidCostError, got: %v\n", err)
		os.Exit(1)
	}

	// 8. bcrypt.CompareHashAndPassword returns InvalidHashPrefixError when hash does not start with '$'
	var prefixErr bcrypt.InvalidHashPrefixError
	badPrefix := []byte("2a$04$012345678901234567890123456789012345678901234567890123456789")
	if err := bcrypt.CompareHashAndPassword(badPrefix, secret); !errors.As(err, &prefixErr) {
		fmt.Fprintf(os.Stderr, "expected InvalidHashPrefixError, got: %v\n", err)
		os.Exit(1)
	}

	fmt.Println("Contract passed.")
}