Repository navigation
Quick start leads with the checksummed release binary, without Go or sudo, and a release's Homebrew formula renders from its checksums.txt - #44
Merged
Conversation
…sudo, and a release's Homebrew formula renders from its checksums.txt The README's quick start opened with git clone, go build and sudo mv, so a first scan needed Go 1.25+ and sudo, while each release from 0.4.0 publishes checksummed archives. Its first block now downloads the latest release's archive for macOS on Apple silicon and checksums.txt with curl, unpacks the archive only after shasum reports it OK, and runs ./tlsanalyzer version. Run as written with no Go on PATH, the block printed "tlsanalyzer-darwin-arm64.tar.gz: OK" and version 0.4.1, and ./tlsanalyzer qramm.org then printed "TLS Security: B (76/100)" and exited 0. With a corrupted archive the check printed FAILED and tar did not run. Building from source comes second and runs the binary where it was built. docs/install.md names the archive for each platform, and a test keeps the quick start's first block a release download with no sudo in any quick start command. packaging/brewformula prints the Homebrew formula for a release from that release's checksums.txt, so each sha256 line is the published digest of the archive on the url line above it. It refuses a version that is not X.Y.Z, a line that is not a digest and a file name, an archive given two digests, and a checksums.txt without one of the four macOS and Linux archives. A test ties its archive names, and the tlsanalyzer binary at the top of each archive, to the release workflow. Rendered for v0.4.1, each of the four url lines downloaded an archive whose sha256 matched the line after it and whose only member is tlsanalyzer. Homebrew's formula loader, simulating macOS and Linux on arm and intel, resolved each to its own archive and digest at version 0.4.1. CONTRIBUTING.md adds rendering the formula to the release process; the formula is not yet in csnp/homebrew-tap.
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
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.
This pull request lands 1 commit in README.md, docs/install.md, CONTRIBUTING.md, CHANGELOG.md, cmd/tlsanalyzer and packaging/brewformula.
Included
Verified on this exact tree
go build ./...: exit 0go vet ./...: exit 0gofmt -s -l .: 0 files listedgo mod verify: all modules verifiedgit ls-files --others -- '*_test.go': 0 untracked test files;git ls-files -- '*_test.go' | wc -l: 105golangci-lint run --timeout=5m ./...(golangci-lint 2.12.2, empty cache): 0 issuesgo test -v -race -p 4 -count=1 ./...: 7 packages ok, 0 FAIL; 433 tests passed, 0 failed, 1 skipped (TestFIPSChildScanNamesTheHybridGroupsItCannotOffer, skip message "runs in the child process that TestAFIPSBuildWithoutMLKEMNamesTheHybridGroupsItCannotOffer starts"); 543 subtests passed, 0 failed, 0 skippedNot included
None
Closes
None
How to merge
Rebase and merge, so that each change stays its own commit on
main.