diff --git a/.claude/claude-security-guidance.md b/.claude/claude-security-guidance.md new file mode 100644 index 0000000..11d0703 --- /dev/null +++ b/.claude/claude-security-guidance.md @@ -0,0 +1,29 @@ +# Security guidance for this repo + + + +## What this repo is + +- Type: library (Go client for the rypt API, encryption as a service in front of Google Cloud KMS) +- Languages: go +- Exposure: imported by other programs; it makes outbound HTTPS calls to https://api.rypt.dev (or a caller-chosen base URL) and listens on nothing + +## Trust boundaries + +- Untrusted input enters through: API responses (status, headers such as Retry-After, and JSON bodies, including server text copied into errors), and caller arguments to exported functions (ids interpolated into URL paths, base URL, HTTP client, plaintexts and data keys) +- Secrets come from: the caller, who passes an API token or console session token to `NewClient` and plaintexts and data keys as byte slices; the examples and integration tests read `RYPT_TOKEN` and `RYPT_KEY_ID` from the environment; never from the repo + +## Rules + +- Every query that touches tenant data filters by tenant ID. +- Every external input is validated before use in SQL, shell, file paths, or templates. +- Cryptography uses the standard library or a vetted library; no custom primitives. +- Errors returned to clients never include stack traces, SQL, or secrets. +- The token is sent only to the configured base URL over https (plain http only to a loopback host), and redirects are never followed. +- Server-supplied text in an error has control and format characters removed and any copy of the token redacted before it is kept. +- Plaintexts, data keys and request/response bodies that carry them stay byte slices, and the client clears its own copies when a call ends. + +## Known exceptions + +- The tenant-ID rule does not apply here: the library has no data store, and the API enforces tenancy through the token's container. diff --git a/.claude/repo-setup.json b/.claude/repo-setup.json new file mode 100644 index 0000000..fe45651 --- /dev/null +++ b/.claude/repo-setup.json @@ -0,0 +1,15 @@ +{ + "rules_version": 1, + "claude_commits": true, + "config_in_git": true, + "github_config": true, + "repo_type": ["library"], + "languages": ["go"], + "check_command": "make check", + "sbom": true, + "default_branch": "main", + "taskd_project": "rypt", + "required_checks": ["test", "lint", "vulncheck"], + "ruleset_include": ["~DEFAULT_BRANCH", "refs/heads/development"], + "security_scan": { "initial": "pending" } +} diff --git a/.claude/settings.json b/.claude/settings.json new file mode 100644 index 0000000..bb2f629 --- /dev/null +++ b/.claude/settings.json @@ -0,0 +1,26 @@ +{ + "permissions": { + "allow": [ + "Bash(git commit *)", + "Bash(git push *)", + "Bash(gh pr create *)", + "Bash(gh pr view *)", + "Bash(gh pr checks *)" + ], + "deny": [ + "Bash(git push *--receive-pack*)", + "Bash(git push *--exec*)", + "Bash(git push *--force*)", + "Bash(git push *--delete*)", + "Bash(git push -d *)", + "Bash(git push * -d *)", + "Bash(git push *--mirror*)", + "Bash(git push *--prune*)", + "Bash(git push *:*)", + "Bash(git commit *--no-verify*)" + ] + }, + "enabledPlugins": { + "gopls-lsp@claude-plugins-official": true + } +} diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 2fbf423..acdab51 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -23,6 +23,17 @@ jobs: cache: false - run: make vet race + # A CycloneDX SBOM of the module: its version and the modules it + # requires. It is made before the release, so that a release never + # goes out without one. + - name: Make the SBOM + env: + TAG: ${{ github.ref_name }} + run: | + go run github.com/CycloneDX/cyclonedx-gomod/cmd/cyclonedx-gomod@v1.12.0 \ + mod -type library -json -licenses -assert-licenses -short-purls \ + -output "rypt-${TAG}.cdx.json" + # A tag with a pre-release suffix, such as v1.2.0-rc.1, is published # as a pre-release. - name: Publish the GitHub release @@ -32,7 +43,8 @@ jobs: run: | prerelease= case "$TAG" in *-*) prerelease=--prerelease ;; esac - gh release create "$TAG" --repo "$GITHUB_REPOSITORY" --verify-tag --generate-notes $prerelease + gh release create "$TAG" "rypt-${TAG}.cdx.json" --repo "$GITHUB_REPOSITORY" \ + --verify-tag --generate-notes $prerelease # Ask the Go module proxy for the new version, so that it and # pkg.go.dev list it without waiting for someone to request it. The diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..b1a5711 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,21 @@ + +## Repo facts + +- Repo type: library +- Languages: go +- Check command: `make check` +- Versioning: SemVer tags `vMAJOR.MINOR.PATCH` +- Default branch: `main` +- Claude may commit: yes +- taskd project: rypt + + +## Branching + +This repo does not use plain GitHub Flow. It overrides the global branching +rules as follows; [CONTRIBUTING.md](CONTRIBUTING.md) has the details. + +- Feature branches start from `development`, not `main`. +- Pull requests target `development`: run `gh pr create --base development`. +- A release is a pull request from `development` into `main`, then a `v*` + tag on the merge commit. Hotfixes branch from `main` as `hotfix/...`. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ed2dacf..2be5717 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -84,8 +84,9 @@ From v2 on, the module path must end in `/v2`. Pushing a `v*` tag runs [.github/workflows/release.yml](.github/workflows/release.yml), which tests the tagged commit, publishes a GitHub release with notes -generated from the pull requests since the previous tag, and asks the Go -module proxy for the new version so that pkg.go.dev lists it. A tag with a +generated from the pull requests since the previous tag and a CycloneDX +SBOM (`rypt-.cdx.json`) of the module and its requirements, and asks +the Go module proxy for the new version so that pkg.go.dev lists it. A tag with a pre-release suffix, such as `v0.2.0-rc.1`, is published as a pre-release. Never move or delete a tag once it is pushed: the Go module proxy and diff --git a/Makefile b/Makefile index 28c52dc..8cd0a15 100644 --- a/Makefile +++ b/Makefile @@ -1,9 +1,12 @@ GO ?= go -.PHONY: all test race vet cover fuzz integration +.PHONY: all check test race vet cover fuzz integration all: vet test +# check is what runs before every commit. +check: vet test + test: $(GO) test ./...