Compare commits
25 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| f3b4838cf6 | |||
| 8ed30e9960 | |||
| c7de3919b0 | |||
| 840066004a | |||
| 9fb93a3802 | |||
| ecc7e5ab1e | |||
| a934c42aa1 | |||
| 948986ba60 | |||
| 3be86573aa | |||
| e3a6355edb | |||
| 66d16acebc | |||
| fdff2e0afe | |||
| 3d9625b40b | |||
| 547a0d8f32 | |||
| 876a0a2c2b | |||
| a37d28e3d7 | |||
| ddf26e00af | |||
| e4db163efe | |||
| 571443c282 | |||
| aba5e519a4 | |||
| 5fcba0e814 | |||
| 928c643d8d | |||
| fd9f9f6d66 | |||
| a5b7727c8f | |||
| 3135c18d95 |
@@ -5,6 +5,30 @@ version: 2.1
|
||||
# Define a job to be invoked later in a workflow.
|
||||
# See: https://circleci.com/docs/2.0/configuration-reference/#jobs
|
||||
jobs:
|
||||
lint:
|
||||
working_directory: ~/repo
|
||||
docker:
|
||||
- image: cimg/go:1.22.2
|
||||
steps:
|
||||
- checkout
|
||||
- restore_cache:
|
||||
keys:
|
||||
- go-mod-v4-{{ checksum "go.sum" }}
|
||||
- run:
|
||||
name: Install Dependencies
|
||||
command: go mod download
|
||||
- save_cache:
|
||||
key: go-mod-v4-{{ checksum "go.sum" }}
|
||||
paths:
|
||||
- "/go/pkg/mod"
|
||||
- run:
|
||||
name: Install golangci-lint
|
||||
command: |
|
||||
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin
|
||||
- run:
|
||||
name: Run golangci-lint
|
||||
command: golangci-lint run --timeout=5m
|
||||
|
||||
testbuild:
|
||||
working_directory: ~/repo
|
||||
# Specify the execution environment. You can specify an image from Dockerhub or use one of our Convenience Images from CircleCI's Developer Hub.
|
||||
@@ -27,16 +51,17 @@ jobs:
|
||||
- "/go/pkg/mod"
|
||||
- run:
|
||||
name: Run tests
|
||||
command: go test ./...
|
||||
command: go test -race ./...
|
||||
- run:
|
||||
name: Run build
|
||||
command: go build ./...
|
||||
- store_test_results:
|
||||
path: /tmp/test-reports
|
||||
|
||||
# Invoke jobs via workflows
|
||||
# See: https://circleci.com/docs/2.0/configuration-reference/#workflows
|
||||
# Linting is disabled while cleanups are ongoing.
|
||||
workflows:
|
||||
testbuild:
|
||||
jobs:
|
||||
- testbuild
|
||||
# - lint
|
||||
|
||||
5
.gitignore
vendored
5
.gitignore
vendored
@@ -1,4 +1 @@
|
||||
bazel-bin
|
||||
bazel-goutils
|
||||
bazel-out
|
||||
bazel-testlogs
|
||||
.idea
|
||||
|
||||
548
.golangci.yml
548
.golangci.yml
@@ -1,87 +1,475 @@
|
||||
run:
|
||||
timeout: 5m
|
||||
tests: true
|
||||
build-tags: []
|
||||
modules-download-mode: readonly
|
||||
# This file is licensed under the terms of the MIT license https://opensource.org/license/mit
|
||||
# Copyright (c) 2021-2025 Marat Reymers
|
||||
|
||||
## Golden config for golangci-lint v2.6.2
|
||||
#
|
||||
# This is the best config for golangci-lint based on my experience and opinion.
|
||||
# It is very strict, but not extremely strict.
|
||||
# Feel free to adapt it to suit your needs.
|
||||
# If this config helps you, please consider keeping a link to this file (see the next comment).
|
||||
|
||||
# Based on https://gist.github.com/maratori/47a4d00457a92aa426dbd48a18776322
|
||||
|
||||
version: "2"
|
||||
|
||||
issues:
|
||||
# Maximum count of issues with the same text.
|
||||
# Set to 0 to disable.
|
||||
# Default: 3
|
||||
max-same-issues: 50
|
||||
|
||||
formatters:
|
||||
enable:
|
||||
- goimports # checks if the code and import statements are formatted according to the 'goimports' command
|
||||
- golines # checks if code is formatted, and fixes long lines
|
||||
|
||||
## you may want to enable
|
||||
#- gci # checks if code and import statements are formatted, with additional rules
|
||||
#- gofmt # checks if the code is formatted according to 'gofmt' command
|
||||
#- gofumpt # enforces a stricter format than 'gofmt', while being backwards compatible
|
||||
#- swaggo # formats swaggo comments
|
||||
|
||||
# All settings can be found here https://github.com/golangci/golangci-lint/blob/HEAD/.golangci.reference.yml
|
||||
settings:
|
||||
goimports:
|
||||
# A list of prefixes, which, if set, checks import paths
|
||||
# with the given prefixes are grouped after 3rd-party packages.
|
||||
# Default: []
|
||||
local-prefixes:
|
||||
- github.com/my/project
|
||||
|
||||
golines:
|
||||
# Target maximum line length.
|
||||
# Default: 100
|
||||
max-len: 120
|
||||
|
||||
linters:
|
||||
enable:
|
||||
- errcheck
|
||||
- gosimple
|
||||
- govet
|
||||
- ineffassign
|
||||
- staticcheck
|
||||
- unused
|
||||
- gofmt
|
||||
- goimports
|
||||
- misspell
|
||||
- unparam
|
||||
- unconvert
|
||||
- goconst
|
||||
- gocyclo
|
||||
- gosec
|
||||
- prealloc
|
||||
- copyloopvar
|
||||
- revive
|
||||
- typecheck
|
||||
- asasalint # checks for pass []any as any in variadic func(...any)
|
||||
- asciicheck # checks that your code does not contain non-ASCII identifiers
|
||||
- bidichk # checks for dangerous unicode character sequences
|
||||
- bodyclose # checks whether HTTP response body is closed successfully
|
||||
- canonicalheader # checks whether net/http.Header uses canonical header
|
||||
- copyloopvar # detects places where loop variables are copied (Go 1.22+)
|
||||
- cyclop # checks function and package cyclomatic complexity
|
||||
- depguard # checks if package imports are in a list of acceptable packages
|
||||
- dupl # tool for code clone detection
|
||||
- durationcheck # checks for two durations multiplied together
|
||||
- errcheck # checking for unchecked errors, these unchecked errors can be critical bugs in some cases
|
||||
- errname # checks that sentinel errors are prefixed with the Err and error types are suffixed with the Error
|
||||
- errorlint # finds code that will cause problems with the error wrapping scheme introduced in Go 1.13
|
||||
- exhaustive # checks exhaustiveness of enum switch statements
|
||||
- exptostd # detects functions from golang.org/x/exp/ that can be replaced by std functions
|
||||
- fatcontext # detects nested contexts in loops
|
||||
- forbidigo # forbids identifiers
|
||||
- funcorder # checks the order of functions, methods, and constructors
|
||||
- funlen # tool for detection of long functions
|
||||
- gocheckcompilerdirectives # validates go compiler directive comments (//go:)
|
||||
- gochecksumtype # checks exhaustiveness on Go "sum types"
|
||||
- gocognit # computes and checks the cognitive complexity of functions
|
||||
- goconst # finds repeated strings that could be replaced by a constant
|
||||
- gocritic # provides diagnostics that check for bugs, performance and style issues
|
||||
- gocyclo # computes and checks the cyclomatic complexity of functions
|
||||
- godoclint # checks Golang's documentation practice
|
||||
- godot # checks if comments end in a period
|
||||
- gomoddirectives # manages the use of 'replace', 'retract', and 'excludes' directives in go.mod
|
||||
- goprintffuncname # checks that printf-like functions are named with f at the end
|
||||
- gosec # inspects source code for security problems
|
||||
- govet # reports suspicious constructs, such as Printf calls whose arguments do not align with the format string
|
||||
- iface # checks the incorrect use of interfaces, helping developers avoid interface pollution
|
||||
- ineffassign # detects when assignments to existing variables are not used
|
||||
- intrange # finds places where for loops could make use of an integer range
|
||||
- iotamixing # checks if iotas are being used in const blocks with other non-iota declarations
|
||||
- loggercheck # checks key value pairs for common logger libraries (kitlog,klog,logr,zap)
|
||||
- makezero # finds slice declarations with non-zero initial length
|
||||
- mirror # reports wrong mirror patterns of bytes/strings usage
|
||||
- mnd # detects magic numbers
|
||||
- modernize # suggests simplifications to Go code, using modern language and library features
|
||||
- musttag # enforces field tags in (un)marshaled structs
|
||||
- nakedret # finds naked returns in functions greater than a specified function length
|
||||
- nestif # reports deeply nested if statements
|
||||
- nilerr # finds the code that returns nil even if it checks that the error is not nil
|
||||
- nilnesserr # reports that it checks for err != nil, but it returns a different nil value error (powered by nilness and nilerr)
|
||||
- nilnil # checks that there is no simultaneous return of nil error and an invalid value
|
||||
- noctx # finds sending http request without context.Context
|
||||
- nolintlint # reports ill-formed or insufficient nolint directives
|
||||
- nonamedreturns # reports all named returns
|
||||
- nosprintfhostport # checks for misuse of Sprintf to construct a host with port in a URL
|
||||
- perfsprint # checks that fmt.Sprintf can be replaced with a faster alternative
|
||||
- predeclared # finds code that shadows one of Go's predeclared identifiers
|
||||
- promlinter # checks Prometheus metrics naming via promlint
|
||||
- protogetter # reports direct reads from proto message fields when getters should be used
|
||||
- reassign # checks that package variables are not reassigned
|
||||
- recvcheck # checks for receiver type consistency
|
||||
- revive # fast, configurable, extensible, flexible, and beautiful linter for Go, drop-in replacement of golint
|
||||
- rowserrcheck # checks whether Err of rows is checked successfully
|
||||
- sloglint # ensure consistent code style when using log/slog
|
||||
- spancheck # checks for mistakes with OpenTelemetry/Census spans
|
||||
- sqlclosecheck # checks that sql.Rows and sql.Stmt are closed
|
||||
- staticcheck # is a go vet on steroids, applying a ton of static analysis checks
|
||||
- testableexamples # checks if examples are testable (have an expected output)
|
||||
- testifylint # checks usage of github.com/stretchr/testify
|
||||
- testpackage # makes you use a separate _test package
|
||||
- tparallel # detects inappropriate usage of t.Parallel() method in your Go test codes
|
||||
- unconvert # removes unnecessary type conversions
|
||||
- unparam # reports unused function parameters
|
||||
- unqueryvet # detects SELECT * in SQL queries and SQL builders, encouraging explicit column selection
|
||||
- unused # checks for unused constants, variables, functions and types
|
||||
- usestdlibvars # detects the possibility to use variables/constants from the Go standard library
|
||||
- usetesting # reports uses of functions with replacement inside the testing package
|
||||
- wastedassign # finds wasted assignment statements
|
||||
- whitespace # detects leading and trailing whitespace
|
||||
|
||||
linters-settings:
|
||||
gocyclo:
|
||||
min-complexity: 15
|
||||
|
||||
goconst:
|
||||
min-len: 3
|
||||
min-occurrences: 3
|
||||
|
||||
misspell:
|
||||
locale: US
|
||||
|
||||
revive:
|
||||
rules:
|
||||
- name: exported
|
||||
disabled: false
|
||||
- name: error-return
|
||||
- name: error-naming
|
||||
- name: if-return
|
||||
- name: var-naming
|
||||
- name: package-comments
|
||||
disabled: true
|
||||
- name: indent-error-flow
|
||||
- name: context-as-argument
|
||||
|
||||
gosec:
|
||||
excludes:
|
||||
- G304 # File path from variable (common in file utilities)
|
||||
- G404 # Use of weak random (acceptable for non-crypto use)
|
||||
## you may want to enable
|
||||
#- arangolint # opinionated best practices for arangodb client
|
||||
#- decorder # checks declaration order and count of types, constants, variables and functions
|
||||
#- exhaustruct # [highly recommend to enable] checks if all structure fields are initialized
|
||||
#- ginkgolinter # [if you use ginkgo/gomega] enforces standards of using ginkgo and gomega
|
||||
#- godox # detects usage of FIXME, TODO and other keywords inside comments
|
||||
#- goheader # checks is file header matches to pattern
|
||||
#- inamedparam # [great idea, but too strict, need to ignore a lot of cases by default] reports interfaces with unnamed method parameters
|
||||
#- interfacebloat # checks the number of methods inside an interface
|
||||
#- ireturn # accept interfaces, return concrete types
|
||||
#- noinlineerr # disallows inline error handling `if err := ...; err != nil {`
|
||||
#- prealloc # [premature optimization, but can be used in some cases] finds slice declarations that could potentially be preallocated
|
||||
#- tagalign # checks that struct tags are well aligned
|
||||
#- varnamelen # [great idea, but too many false positives] checks that the length of a variable's name matches its scope
|
||||
#- wrapcheck # checks that errors returned from external packages are wrapped
|
||||
#- zerologlint # detects the wrong usage of zerolog that a user forgets to dispatch zerolog.Event
|
||||
|
||||
issues:
|
||||
exclude-rules:
|
||||
# Exclude some linters from running on tests files
|
||||
- path: _test\.go
|
||||
linters:
|
||||
- gocyclo
|
||||
- errcheck
|
||||
- gosec
|
||||
|
||||
# Exclude embedded content from checks
|
||||
- path: ".*\\.txt$"
|
||||
linters:
|
||||
## disabled
|
||||
#- containedctx # detects struct contained context.Context field
|
||||
#- contextcheck # [too many false positives] checks the function whether use a non-inherited context
|
||||
#- dogsled # checks assignments with too many blank identifiers (e.g. x, _, _, _, := f())
|
||||
#- dupword # [useless without config] checks for duplicate words in the source code
|
||||
#- err113 # [too strict] checks the errors handling expressions
|
||||
#- errchkjson # [don't see profit + I'm against of omitting errors like in the first example https://github.com/breml/errchkjson] checks types passed to the json encoding functions. Reports unsupported types and optionally reports occasions, where the check for the returned error can be omitted
|
||||
#- forcetypeassert # [replaced by errcheck] finds forced type assertions
|
||||
#- gomodguard # [use more powerful depguard] allow and block lists linter for direct Go module dependencies
|
||||
#- gosmopolitan # reports certain i18n/l10n anti-patterns in your Go codebase
|
||||
#- grouper # analyzes expression groups
|
||||
#- importas # enforces consistent import aliases
|
||||
#- lll # [replaced by golines] reports long lines
|
||||
#- maintidx # measures the maintainability index of each function
|
||||
#- misspell # [useless] finds commonly misspelled English words in comments
|
||||
#- nlreturn # [too strict and mostly code is not more readable] checks for a new line before return and branch statements to increase code clarity
|
||||
#- paralleltest # [too many false positives] detects missing usage of t.Parallel() method in your Go test
|
||||
#- tagliatelle # checks the struct tags
|
||||
#- thelper # detects golang test helpers without t.Helper() call and checks the consistency of test helpers
|
||||
#- wsl # [too strict and mostly code is not more readable] whitespace linter forces you to use empty lines
|
||||
#- wsl_v5 # [too strict and mostly code is not more readable] add or remove empty lines
|
||||
|
||||
# All settings can be found here https://github.com/golangci/golangci-lint/blob/HEAD/.golangci.reference.yml
|
||||
settings:
|
||||
cyclop:
|
||||
# The maximal code complexity to report.
|
||||
# Default: 10
|
||||
max-complexity: 30
|
||||
# The maximal average package complexity.
|
||||
# If it's higher than 0.0 (float) the check is enabled.
|
||||
# Default: 0.0
|
||||
package-average: 10.0
|
||||
|
||||
depguard:
|
||||
# Rules to apply.
|
||||
#
|
||||
# Variables:
|
||||
# - File Variables
|
||||
# Use an exclamation mark `!` to negate a variable.
|
||||
# Example: `!$test` matches any file that is not a go test file.
|
||||
#
|
||||
# `$all` - matches all go files
|
||||
# `$test` - matches all go test files
|
||||
#
|
||||
# - Package Variables
|
||||
#
|
||||
# `$gostd` - matches all of go's standard library (Pulled from `GOROOT`)
|
||||
#
|
||||
# Default (applies if no custom rules are defined): Only allow $gostd in all files.
|
||||
rules:
|
||||
"deprecated":
|
||||
# List of file globs that will match this list of settings to compare against.
|
||||
# By default, if a path is relative, it is relative to the directory where the golangci-lint command is executed.
|
||||
# The placeholder '${base-path}' is substituted with a path relative to the mode defined with `run.relative-path-mode`.
|
||||
# The placeholder '${config-path}' is substituted with a path relative to the configuration file.
|
||||
# Default: $all
|
||||
files:
|
||||
- "$all"
|
||||
# List of packages that are not allowed.
|
||||
# Entries can be a variable (starting with $), a string prefix, or an exact match (if ending with $).
|
||||
# Default: []
|
||||
deny:
|
||||
- pkg: github.com/golang/protobuf
|
||||
desc: Use google.golang.org/protobuf instead, see https://developers.google.com/protocol-buffers/docs/reference/go/faq#modules
|
||||
- pkg: github.com/satori/go.uuid
|
||||
desc: Use github.com/google/uuid instead, satori's package is not maintained
|
||||
- pkg: github.com/gofrs/uuid$
|
||||
desc: Use github.com/gofrs/uuid/v5 or later, it was not a go module before v5
|
||||
"non-test files":
|
||||
files:
|
||||
- "!$test"
|
||||
deny:
|
||||
- pkg: math/rand$
|
||||
desc: Use math/rand/v2 instead, see https://go.dev/blog/randv2
|
||||
"non-main files":
|
||||
files:
|
||||
- "!**/main.go"
|
||||
deny:
|
||||
- pkg: log$
|
||||
desc: Use log/slog instead, see https://go.dev/blog/slog
|
||||
|
||||
embeddedstructfieldcheck:
|
||||
# Checks that sync.Mutex and sync.RWMutex are not used as embedded fields.
|
||||
# Default: false
|
||||
forbid-mutex: true
|
||||
|
||||
errcheck:
|
||||
# Report about not checking of errors in type assertions: `a := b.(MyStruct)`.
|
||||
# Such cases aren't reported by default.
|
||||
# Default: false
|
||||
check-type-assertions: true
|
||||
exclude-functions:
|
||||
- (*git.wntrmute.dev/kyle/goutils/sbuf.Buffer).Write
|
||||
|
||||
exhaustive:
|
||||
# Program elements to check for exhaustiveness.
|
||||
# Default: [ switch ]
|
||||
check:
|
||||
- switch
|
||||
- map
|
||||
|
||||
exhaustruct:
|
||||
# List of regular expressions to match type names that should be excluded from processing.
|
||||
# Anonymous structs can be matched by '<anonymous>' alias.
|
||||
# Has precedence over `include`.
|
||||
# Each regular expression must match the full type name, including package path.
|
||||
# For example, to match type `net/http.Cookie` regular expression should be `.*/http\.Cookie`,
|
||||
# but not `http\.Cookie`.
|
||||
# Default: []
|
||||
exclude:
|
||||
# std libs
|
||||
- ^net/http.Client$
|
||||
- ^net/http.Cookie$
|
||||
- ^net/http.Request$
|
||||
- ^net/http.Response$
|
||||
- ^net/http.Server$
|
||||
- ^net/http.Transport$
|
||||
- ^net/url.URL$
|
||||
- ^os/exec.Cmd$
|
||||
- ^reflect.StructField$
|
||||
# public libs
|
||||
- ^github.com/Shopify/sarama.Config$
|
||||
- ^github.com/Shopify/sarama.ProducerMessage$
|
||||
- ^github.com/mitchellh/mapstructure.DecoderConfig$
|
||||
- ^github.com/prometheus/client_golang/.+Opts$
|
||||
- ^github.com/spf13/cobra.Command$
|
||||
- ^github.com/spf13/cobra.CompletionOptions$
|
||||
- ^github.com/stretchr/testify/mock.Mock$
|
||||
- ^github.com/testcontainers/testcontainers-go.+Request$
|
||||
- ^github.com/testcontainers/testcontainers-go.FromDockerfile$
|
||||
- ^golang.org/x/tools/go/analysis.Analyzer$
|
||||
- ^google.golang.org/protobuf/.+Options$
|
||||
- ^gopkg.in/yaml.v3.Node$
|
||||
# Allows empty structures in return statements.
|
||||
# Default: false
|
||||
allow-empty-returns: true
|
||||
|
||||
funcorder:
|
||||
# Checks if the exported methods of a structure are placed before the non-exported ones.
|
||||
# Default: true
|
||||
struct-method: false
|
||||
|
||||
funlen:
|
||||
# Checks the number of lines in a function.
|
||||
# If lower than 0, disable the check.
|
||||
# Default: 60
|
||||
lines: 100
|
||||
# Checks the number of statements in a function.
|
||||
# If lower than 0, disable the check.
|
||||
# Default: 40
|
||||
statements: 50
|
||||
|
||||
gochecksumtype:
|
||||
# Presence of `default` case in switch statements satisfies exhaustiveness, if all members are not listed.
|
||||
# Default: true
|
||||
default-signifies-exhaustive: false
|
||||
|
||||
gocognit:
|
||||
# Minimal code complexity to report.
|
||||
# Default: 30 (but we recommend 10-20)
|
||||
min-complexity: 20
|
||||
|
||||
gocritic:
|
||||
# Settings passed to gocritic.
|
||||
# The settings key is the name of a supported gocritic checker.
|
||||
# The list of supported checkers can be found at https://go-critic.com/overview.
|
||||
settings:
|
||||
captLocal:
|
||||
# Whether to restrict checker to params only.
|
||||
# Default: true
|
||||
paramsOnly: false
|
||||
underef:
|
||||
# Whether to skip (*x).method() calls where x is a pointer receiver.
|
||||
# Default: true
|
||||
skipRecvDeref: false
|
||||
|
||||
godoclint:
|
||||
# List of rules to enable in addition to the default set.
|
||||
# Default: empty
|
||||
enable:
|
||||
# Assert no unused link in godocs.
|
||||
# https://github.com/godoc-lint/godoc-lint?tab=readme-ov-file#no-unused-link
|
||||
- no-unused-link
|
||||
|
||||
govet:
|
||||
# Enable all analyzers.
|
||||
# Default: false
|
||||
enable-all: true
|
||||
# Disable analyzers by name.
|
||||
# Run `GL_DEBUG=govet golangci-lint run --enable=govet` to see default, all available analyzers, and enabled analyzers.
|
||||
# Default: []
|
||||
disable:
|
||||
- fieldalignment # too strict
|
||||
# Settings per analyzer.
|
||||
settings:
|
||||
shadow:
|
||||
# Whether to be strict about shadowing; can be noisy.
|
||||
# Default: false
|
||||
strict: true
|
||||
|
||||
inamedparam:
|
||||
# Skips check for interface methods with only a single parameter.
|
||||
# Default: false
|
||||
skip-single-param: true
|
||||
|
||||
mnd:
|
||||
ignored-functions:
|
||||
- args.Error
|
||||
- flag.Arg
|
||||
- flag.Duration.*
|
||||
- flag.Float.*
|
||||
- flag.Int.*
|
||||
- flag.Uint.*
|
||||
- os.Chmod
|
||||
- os.Mkdir.*
|
||||
- os.OpenFile
|
||||
- os.WriteFile
|
||||
- prometheus.ExponentialBuckets.*
|
||||
- prometheus.LinearBuckets
|
||||
|
||||
nakedret:
|
||||
# Make an issue if func has more lines of code than this setting, and it has naked returns.
|
||||
# Default: 30
|
||||
max-func-lines: 0
|
||||
|
||||
nolintlint:
|
||||
# Exclude the following linters from requiring an explanation.
|
||||
# Default: []
|
||||
allow-no-explanation: [ funlen, gocognit, golines ]
|
||||
# Enable to require an explanation of nonzero length after each nolint directive.
|
||||
# Default: false
|
||||
require-explanation: true
|
||||
# Enable to require nolint directives to mention the specific linter being suppressed.
|
||||
# Default: false
|
||||
require-specific: true
|
||||
|
||||
perfsprint:
|
||||
# Optimizes into strings concatenation.
|
||||
# Default: true
|
||||
strconcat: false
|
||||
|
||||
reassign:
|
||||
# Patterns for global variable names that are checked for reassignment.
|
||||
# See https://github.com/curioswitch/go-reassign#usage
|
||||
# Default: ["EOF", "Err.*"]
|
||||
patterns:
|
||||
- ".*"
|
||||
|
||||
rowserrcheck:
|
||||
# database/sql is always checked.
|
||||
# Default: []
|
||||
packages:
|
||||
- github.com/jmoiron/sqlx
|
||||
|
||||
sloglint:
|
||||
# Enforce not using global loggers.
|
||||
# Values:
|
||||
# - "": disabled
|
||||
# - "all": report all global loggers
|
||||
# - "default": report only the default slog logger
|
||||
# https://github.com/go-simpler/sloglint?tab=readme-ov-file#no-global
|
||||
# Default: ""
|
||||
no-global: all
|
||||
# Enforce using methods that accept a context.
|
||||
# Values:
|
||||
# - "": disabled
|
||||
# - "all": report all contextless calls
|
||||
# - "scope": report only if a context exists in the scope of the outermost function
|
||||
# https://github.com/go-simpler/sloglint?tab=readme-ov-file#context-only
|
||||
# Default: ""
|
||||
context: scope
|
||||
|
||||
staticcheck:
|
||||
# SAxxxx checks in https://staticcheck.dev/docs/configuration/options/#checks
|
||||
# Example (to disable some checks): [ "all", "-SA1000", "-SA1001"]
|
||||
# Default: ["all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022"]
|
||||
checks:
|
||||
- all
|
||||
|
||||
# Ignore deprecation warnings in legacy code if needed
|
||||
- linters:
|
||||
- staticcheck
|
||||
text: "SA1019"
|
||||
|
||||
# Maximum issues count per one linter
|
||||
max-issues-per-linter: 0
|
||||
|
||||
# Maximum count of issues with the same text
|
||||
max-same-issues: 0
|
||||
# Incorrect or missing package comment.
|
||||
# https://staticcheck.dev/docs/checks/#ST1000
|
||||
- -ST1000
|
||||
# Use consistent method receiver names.
|
||||
# https://staticcheck.dev/docs/checks/#ST1016
|
||||
- -ST1016
|
||||
# Omit embedded fields from selector expression.
|
||||
# https://staticcheck.dev/docs/checks/#QF1008
|
||||
- -QF1008
|
||||
|
||||
output:
|
||||
formats:
|
||||
- format: colored-line-number
|
||||
path: stdout
|
||||
print-issued-lines: true
|
||||
print-linter-name: true
|
||||
usetesting:
|
||||
# Enable/disable `os.TempDir()` detections.
|
||||
# Default: false
|
||||
os-temp-dir: true
|
||||
|
||||
exclusions:
|
||||
# Log a warning if an exclusion rule is unused.
|
||||
# Default: false
|
||||
warn-unused: true
|
||||
# Predefined exclusion rules.
|
||||
# Default: []
|
||||
presets:
|
||||
- std-error-handling
|
||||
- common-false-positives
|
||||
rules:
|
||||
- path: 'ahash/ahash.go'
|
||||
linters: [ staticcheck, gosec ]
|
||||
- path: 'backoff/backoff_test.go'
|
||||
linters: [ testpackage ]
|
||||
- path: 'dbg/dbg_test.go'
|
||||
linters: [ testpackage ]
|
||||
- path: 'log/logger.go'
|
||||
linters: [ forbidigo ]
|
||||
- path: 'logging/example_test.go'
|
||||
linters: [ testableexamples ]
|
||||
- source: 'TODO'
|
||||
linters: [ godot ]
|
||||
- text: 'should have a package comment'
|
||||
linters: [ revive ]
|
||||
- text: 'exported \S+ \S+ should have comment( \(or a comment on this block\))? or be unexported'
|
||||
linters: [ revive ]
|
||||
- text: 'package comment should be of the form ".+"'
|
||||
source: '// ?(nolint|TODO)'
|
||||
linters: [ revive ]
|
||||
- text: 'comment on exported \S+ \S+ should be of the form ".+"'
|
||||
source: '// ?(nolint|TODO)'
|
||||
linters: [ revive, staticcheck ]
|
||||
- path: '_test\.go'
|
||||
linters:
|
||||
- bodyclose
|
||||
- dupl
|
||||
- errcheck
|
||||
- funlen
|
||||
- goconst
|
||||
- gosec
|
||||
- noctx
|
||||
- reassign
|
||||
- wrapcheck
|
||||
|
||||
26
.travis.yml
26
.travis.yml
@@ -1,26 +0,0 @@
|
||||
arch:
|
||||
- amd64
|
||||
- ppc64le
|
||||
sudo: false
|
||||
language: go
|
||||
go:
|
||||
- tip
|
||||
- 1.9
|
||||
jobs:
|
||||
exclude:
|
||||
- go: 1.9
|
||||
arch: amd64
|
||||
- go: 1.9
|
||||
arch: ppc64le
|
||||
script:
|
||||
- go get golang.org/x/lint/golint
|
||||
- go get golang.org/x/tools/cmd/cover
|
||||
- go get github.com/kisom/goutils/...
|
||||
- go test -cover github.com/kisom/goutils/...
|
||||
- golint github.com/kisom/goutils/...
|
||||
notifications:
|
||||
email:
|
||||
recipients:
|
||||
- coder@kyleisom.net
|
||||
on_success: change
|
||||
on_failure: change
|
||||
18
CHANGELOG
18
CHANGELOG
@@ -1,3 +1,21 @@
|
||||
Unreleased - 2025-11-15
|
||||
|
||||
"Error handling modernization" (in progress)
|
||||
|
||||
- Introduced typed, wrapped errors via certlib/certerr.Error (Source, Kind, Op, Err) with Unwrap.
|
||||
- Standardized helper constructors: DecodeError, ParsingError, VerifyError, LoadingError.
|
||||
- Preserved sentinel errors (e.g., ErrEncryptedPrivateKey, ErrInvalidPEMType, ErrEmptyCertificate) for errors.Is.
|
||||
- Refactored certlib to use certerr in key paths (CSR parsing/verification, PEM cert pool, certificate read/load).
|
||||
- Migrated logging/file.go and cmd/kgz away from github.com/pkg/errors to stdlib wrapping.
|
||||
- Removed dependency on github.com/pkg/errors; ran go mod tidy.
|
||||
- Added package docs for certerr and a README section on error handling and matching.
|
||||
- Added unit tests for certerr (Is/As and message formatting).
|
||||
|
||||
Planned next steps:
|
||||
- Continue refactoring remaining error paths for consistent wrapping.
|
||||
- Add focused tests for key flows (encrypted private key, CSR invalid PEM types, etc.).
|
||||
- Run golangci-lint (errorlint, errcheck) and address findings.
|
||||
|
||||
Release 1.2.1 - 2018-09-15
|
||||
|
||||
+ Add missing format argument to Errorf call in kgz.
|
||||
|
||||
197
LICENSE
197
LICENSE
@@ -1,19 +1,194 @@
|
||||
Copyright (c) 2015-2023 Kyle Isom <kyle@tyrfingr.is>
|
||||
Copyright 2025 K. Isom <kyle@imap.cc>
|
||||
|
||||
Permission to use, copy, modify, and distribute this software for any
|
||||
purpose with or without fee is hereby granted, provided that the above
|
||||
copyright notice and this permission notice appear in all copies.
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
=======================================================================
|
||||
|
||||
The backoff package (written during my time at Cloudflare) is released
|
||||
under the following license:
|
||||
|
||||
|
||||
40
README.md
40
README.md
@@ -78,3 +78,43 @@ Each program should have a small README in the directory with more
|
||||
information.
|
||||
|
||||
All code here is licensed under the ISC license.
|
||||
|
||||
|
||||
Error handling
|
||||
--------------
|
||||
|
||||
This repo standardizes on Go 1.13+ error wrapping and matching. Libraries and
|
||||
CLIs should:
|
||||
|
||||
- Wrap causes with context using `fmt.Errorf("context: %w", err)`.
|
||||
- Use typed, structured errors from `certlib/certerr` for certificate-related
|
||||
operations. These include a typed `*certerr.Error` with `Source` and `Kind`.
|
||||
- Match errors programmatically:
|
||||
- `errors.Is(err, certerr.ErrEncryptedPrivateKey)` to detect sentinel states.
|
||||
- `errors.As(err, &e)` (where `var e *certerr.Error`) to inspect
|
||||
`e.Source`/`e.Kind`.
|
||||
|
||||
Examples:
|
||||
|
||||
```
|
||||
cert, err := certlib.LoadCertificate(path)
|
||||
if err != nil {
|
||||
// sentinel match
|
||||
if errors.Is(err, certerr.ErrEmptyCertificate) {
|
||||
// handle empty input
|
||||
}
|
||||
|
||||
// typed error match
|
||||
var ce *certerr.Error
|
||||
if errors.As(err, &ce) {
|
||||
switch ce.Kind {
|
||||
case certerr.KindParse:
|
||||
// parse error handling
|
||||
case certerr.KindLoad:
|
||||
// file loading error handling
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Avoid including sensitive data (keys, passwords, tokens) in error messages.
|
||||
|
||||
@@ -4,8 +4,8 @@
|
||||
package ahash
|
||||
|
||||
import (
|
||||
"crypto/md5"
|
||||
"crypto/sha1"
|
||||
"crypto/md5" // #nosec G505
|
||||
"crypto/sha1" // #nosec G501
|
||||
"crypto/sha256"
|
||||
"crypto/sha512"
|
||||
"errors"
|
||||
@@ -17,34 +17,15 @@ import (
|
||||
"io"
|
||||
"sort"
|
||||
|
||||
"git.wntrmute.dev/kyle/goutils/assert"
|
||||
"golang.org/x/crypto/blake2b"
|
||||
"golang.org/x/crypto/blake2s"
|
||||
"golang.org/x/crypto/md4"
|
||||
"golang.org/x/crypto/ripemd160"
|
||||
"golang.org/x/crypto/md4" // #nosec G506
|
||||
"golang.org/x/crypto/ripemd160" // #nosec G507
|
||||
"golang.org/x/crypto/sha3"
|
||||
|
||||
"git.wntrmute.dev/kyle/goutils/assert"
|
||||
)
|
||||
|
||||
func sha224Slicer(bs []byte) []byte {
|
||||
sum := sha256.Sum224(bs)
|
||||
return sum[:]
|
||||
}
|
||||
|
||||
func sha256Slicer(bs []byte) []byte {
|
||||
sum := sha256.Sum256(bs)
|
||||
return sum[:]
|
||||
}
|
||||
|
||||
func sha384Slicer(bs []byte) []byte {
|
||||
sum := sha512.Sum384(bs)
|
||||
return sum[:]
|
||||
}
|
||||
|
||||
func sha512Slicer(bs []byte) []byte {
|
||||
sum := sha512.Sum512(bs)
|
||||
return sum[:]
|
||||
}
|
||||
|
||||
// Hash represents a generic hash function that may or may not be secure. It
|
||||
// satisfies the hash.Hash interface.
|
||||
type Hash struct {
|
||||
@@ -247,17 +228,17 @@ func init() {
|
||||
// HashList returns a sorted list of all the hash algorithms supported by the
|
||||
// package.
|
||||
func HashList() []string {
|
||||
return hashList[:]
|
||||
return hashList
|
||||
}
|
||||
|
||||
// SecureHashList returns a sorted list of all the secure (cryptographic) hash
|
||||
// algorithms supported by the package.
|
||||
func SecureHashList() []string {
|
||||
return secureHashList[:]
|
||||
return secureHashList
|
||||
}
|
||||
|
||||
// InsecureHashList returns a sorted list of all the insecure hash algorithms
|
||||
// supported by the package.
|
||||
func InsecureHashList() []string {
|
||||
return insecureHashList[:]
|
||||
return insecureHashList
|
||||
}
|
||||
|
||||
@@ -1,16 +1,18 @@
|
||||
package ahash
|
||||
package ahash_test
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/hex"
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
"git.wntrmute.dev/kyle/goutils/ahash"
|
||||
"git.wntrmute.dev/kyle/goutils/assert"
|
||||
)
|
||||
|
||||
func TestSecureHash(t *testing.T) {
|
||||
algo := "sha256"
|
||||
h, err := New(algo)
|
||||
h, err := ahash.New(algo)
|
||||
assert.NoErrorT(t, err)
|
||||
assert.BoolT(t, h.IsSecure(), algo+" should be a secure hash")
|
||||
assert.BoolT(t, h.HashAlgo() == algo, "hash returned the wrong HashAlgo")
|
||||
@@ -19,28 +21,28 @@ func TestSecureHash(t *testing.T) {
|
||||
|
||||
var data []byte
|
||||
var expected = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
|
||||
sum, err := Sum(algo, data)
|
||||
sum, err := ahash.Sum(algo, data)
|
||||
assert.NoErrorT(t, err)
|
||||
assert.BoolT(t, fmt.Sprintf("%x", sum) == expected, fmt.Sprintf("expected hash %s but have %x", expected, sum))
|
||||
assert.BoolT(t, hex.EncodeToString(sum) == expected, fmt.Sprintf("expected hash %s but have %x", expected, sum))
|
||||
|
||||
data = []byte("hello, world")
|
||||
buf := bytes.NewBuffer(data)
|
||||
expected = "09ca7e4eaa6e8ae9c7d261167129184883644d07dfba7cbfbc4c8a2e08360d5b"
|
||||
sum, err = SumReader(algo, buf)
|
||||
sum, err = ahash.SumReader(algo, buf)
|
||||
assert.NoErrorT(t, err)
|
||||
assert.BoolT(t, fmt.Sprintf("%x", sum) == expected, fmt.Sprintf("expected hash %s but have %x", expected, sum))
|
||||
assert.BoolT(t, hex.EncodeToString(sum) == expected, fmt.Sprintf("expected hash %s but have %x", expected, sum))
|
||||
|
||||
data = []byte("hello world")
|
||||
_, err = h.Write(data)
|
||||
assert.NoErrorT(t, err)
|
||||
unExpected := "09ca7e4eaa6e8ae9c7d261167129184883644d07dfba7cbfbc4c8a2e08360d5b"
|
||||
sum = h.Sum(nil)
|
||||
assert.BoolT(t, fmt.Sprintf("%x", sum) != unExpected, fmt.Sprintf("hash shouldn't have returned %x", unExpected))
|
||||
assert.BoolT(t, hex.EncodeToString(sum) != unExpected, fmt.Sprintf("hash shouldn't have returned %x", unExpected))
|
||||
}
|
||||
|
||||
func TestInsecureHash(t *testing.T) {
|
||||
algo := "md5"
|
||||
h, err := New(algo)
|
||||
h, err := ahash.New(algo)
|
||||
assert.NoErrorT(t, err)
|
||||
assert.BoolT(t, !h.IsSecure(), algo+" shouldn't be a secure hash")
|
||||
assert.BoolT(t, h.HashAlgo() == algo, "hash returned the wrong HashAlgo")
|
||||
@@ -49,28 +51,28 @@ func TestInsecureHash(t *testing.T) {
|
||||
|
||||
var data []byte
|
||||
var expected = "d41d8cd98f00b204e9800998ecf8427e"
|
||||
sum, err := Sum(algo, data)
|
||||
sum, err := ahash.Sum(algo, data)
|
||||
assert.NoErrorT(t, err)
|
||||
assert.BoolT(t, fmt.Sprintf("%x", sum) == expected, fmt.Sprintf("expected hash %s but have %x", expected, sum))
|
||||
assert.BoolT(t, hex.EncodeToString(sum) == expected, fmt.Sprintf("expected hash %s but have %x", expected, sum))
|
||||
|
||||
data = []byte("hello, world")
|
||||
buf := bytes.NewBuffer(data)
|
||||
expected = "e4d7f1b4ed2e42d15898f4b27b019da4"
|
||||
sum, err = SumReader(algo, buf)
|
||||
sum, err = ahash.SumReader(algo, buf)
|
||||
assert.NoErrorT(t, err)
|
||||
assert.BoolT(t, fmt.Sprintf("%x", sum) == expected, fmt.Sprintf("expected hash %s but have %x", expected, sum))
|
||||
assert.BoolT(t, hex.EncodeToString(sum) == expected, fmt.Sprintf("expected hash %s but have %x", expected, sum))
|
||||
|
||||
data = []byte("hello world")
|
||||
_, err = h.Write(data)
|
||||
assert.NoErrorT(t, err)
|
||||
unExpected := "e4d7f1b4ed2e42d15898f4b27b019da4"
|
||||
sum = h.Sum(nil)
|
||||
assert.BoolT(t, fmt.Sprintf("%x", sum) != unExpected, fmt.Sprintf("hash shouldn't have returned %x", unExpected))
|
||||
assert.BoolT(t, hex.EncodeToString(sum) != unExpected, fmt.Sprintf("hash shouldn't have returned %x", unExpected))
|
||||
}
|
||||
|
||||
func TestHash32(t *testing.T) {
|
||||
algo := "crc32-ieee"
|
||||
h, err := New(algo)
|
||||
h, err := ahash.New(algo)
|
||||
assert.NoErrorT(t, err)
|
||||
assert.BoolT(t, !h.IsSecure(), algo+" shouldn't be a secure hash")
|
||||
assert.BoolT(t, h.HashAlgo() == algo, "hash returned the wrong HashAlgo")
|
||||
@@ -102,7 +104,7 @@ func TestHash32(t *testing.T) {
|
||||
|
||||
func TestHash64(t *testing.T) {
|
||||
algo := "crc64"
|
||||
h, err := New(algo)
|
||||
h, err := ahash.New(algo)
|
||||
assert.NoErrorT(t, err)
|
||||
assert.BoolT(t, !h.IsSecure(), algo+" shouldn't be a secure hash")
|
||||
assert.BoolT(t, h.HashAlgo() == algo, "hash returned the wrong HashAlgo")
|
||||
@@ -133,9 +135,9 @@ func TestHash64(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestListLengthSanity(t *testing.T) {
|
||||
all := HashList()
|
||||
secure := SecureHashList()
|
||||
insecure := InsecureHashList()
|
||||
all := ahash.HashList()
|
||||
secure := ahash.SecureHashList()
|
||||
insecure := ahash.InsecureHashList()
|
||||
|
||||
assert.BoolT(t, len(all) == len(secure)+len(insecure))
|
||||
}
|
||||
@@ -146,11 +148,11 @@ func TestSumLimitedReader(t *testing.T) {
|
||||
extendedData := bytes.NewBufferString("hello, world! this is an extended message")
|
||||
expected := "09ca7e4eaa6e8ae9c7d261167129184883644d07dfba7cbfbc4c8a2e08360d5b"
|
||||
|
||||
hash, err := SumReader("sha256", data)
|
||||
hash, err := ahash.SumReader("sha256", data)
|
||||
assert.NoErrorT(t, err)
|
||||
assert.BoolT(t, fmt.Sprintf("%x", hash) == expected, fmt.Sprintf("have hash %x, want %s", hash, expected))
|
||||
assert.BoolT(t, hex.EncodeToString(hash) == expected, fmt.Sprintf("have hash %x, want %s", hash, expected))
|
||||
|
||||
extendedHash, err := SumLimitedReader("sha256", extendedData, int64(dataLen))
|
||||
extendedHash, err := ahash.SumLimitedReader("sha256", extendedData, int64(dataLen))
|
||||
assert.NoErrorT(t, err)
|
||||
|
||||
assert.BoolT(t, bytes.Equal(hash, extendedHash), fmt.Sprintf("have hash %x, want %x", extendedHash, hash))
|
||||
|
||||
@@ -9,6 +9,7 @@
|
||||
package assert
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"os"
|
||||
"runtime"
|
||||
@@ -16,11 +17,13 @@ import (
|
||||
"testing"
|
||||
)
|
||||
|
||||
const callerSkip = 2
|
||||
|
||||
// NoDebug can be set to true to cause all asserts to be ignored.
|
||||
var NoDebug bool
|
||||
|
||||
func die(what string, a ...string) {
|
||||
_, file, line, ok := runtime.Caller(2)
|
||||
_, file, line, ok := runtime.Caller(callerSkip)
|
||||
if !ok {
|
||||
panic(what)
|
||||
}
|
||||
@@ -31,30 +34,32 @@ func die(what string, a ...string) {
|
||||
s = ": " + s
|
||||
}
|
||||
panic(what + s)
|
||||
} else {
|
||||
fmt.Fprintf(os.Stderr, "%s", what)
|
||||
if len(a) > 0 {
|
||||
s := strings.Join(a, ", ")
|
||||
fmt.Fprintln(os.Stderr, ": "+s)
|
||||
} else {
|
||||
fmt.Fprintf(os.Stderr, "\n")
|
||||
}
|
||||
|
||||
fmt.Fprintf(os.Stderr, "\t%s line %d\n", file, line)
|
||||
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
fmt.Fprintf(os.Stderr, "%s", what)
|
||||
if len(a) > 0 {
|
||||
s := strings.Join(a, ", ")
|
||||
fmt.Fprintln(os.Stderr, ": "+s)
|
||||
} else {
|
||||
fmt.Fprintf(os.Stderr, "\n")
|
||||
}
|
||||
|
||||
fmt.Fprintf(os.Stderr, "\t%s line %d\n", file, line)
|
||||
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
// Bool asserts that cond is false.
|
||||
//
|
||||
// For example, this would replace
|
||||
// if x < 0 {
|
||||
// log.Fatal("x is subzero")
|
||||
// }
|
||||
//
|
||||
// if x < 0 {
|
||||
// log.Fatal("x is subzero")
|
||||
// }
|
||||
//
|
||||
// The same assertion would be
|
||||
// assert.Bool(x, "x is subzero")
|
||||
//
|
||||
// assert.Bool(x, "x is subzero")
|
||||
func Bool(cond bool, s ...string) {
|
||||
if NoDebug {
|
||||
return
|
||||
@@ -68,11 +73,12 @@ func Bool(cond bool, s ...string) {
|
||||
// Error asserts that err is not nil, e.g. that an error has occurred.
|
||||
//
|
||||
// For example,
|
||||
// if err == nil {
|
||||
// log.Fatal("call to <something> should have failed")
|
||||
// }
|
||||
// // becomes
|
||||
// assert.Error(err, "call to <something> should have failed")
|
||||
//
|
||||
// if err == nil {
|
||||
// log.Fatal("call to <something> should have failed")
|
||||
// }
|
||||
// // becomes
|
||||
// assert.Error(err, "call to <something> should have failed")
|
||||
func Error(err error, s ...string) {
|
||||
if NoDebug {
|
||||
return
|
||||
@@ -100,7 +106,7 @@ func NoError(err error, s ...string) {
|
||||
|
||||
// ErrorEq asserts that the actual error is the expected error.
|
||||
func ErrorEq(expected, actual error) {
|
||||
if NoDebug || (expected == actual) {
|
||||
if NoDebug || (errors.Is(expected, actual)) {
|
||||
return
|
||||
}
|
||||
|
||||
@@ -155,7 +161,7 @@ func NoErrorT(t *testing.T, err error) {
|
||||
// ErrorEqT compares a pair of errors, calling Fatal on it if they
|
||||
// don't match.
|
||||
func ErrorEqT(t *testing.T, expected, actual error) {
|
||||
if NoDebug || (expected == actual) {
|
||||
if NoDebug || (errors.Is(expected, actual)) {
|
||||
return
|
||||
}
|
||||
|
||||
|
||||
@@ -10,29 +10,21 @@
|
||||
// backoff is configured with a maximum duration that will not be
|
||||
// exceeded.
|
||||
//
|
||||
// The `New` function will attempt to use the system's cryptographic
|
||||
// random number generator to seed a Go math/rand random number
|
||||
// source. If this fails, the package will panic on startup.
|
||||
// This package uses math/rand/v2 for jitter, which is automatically
|
||||
// seeded from a cryptographically secure source.
|
||||
package backoff
|
||||
|
||||
import (
|
||||
"crypto/rand"
|
||||
"encoding/binary"
|
||||
"io"
|
||||
"math"
|
||||
mrand "math/rand"
|
||||
"sync"
|
||||
"math/rand/v2"
|
||||
"time"
|
||||
)
|
||||
|
||||
var prngMu sync.Mutex
|
||||
var prng *mrand.Rand
|
||||
|
||||
// DefaultInterval is used when a Backoff is initialised with a
|
||||
// zero-value Interval.
|
||||
var DefaultInterval = 5 * time.Minute
|
||||
|
||||
// DefaultMaxDuration is maximum amount of time that the backoff will
|
||||
// DefaultMaxDuration is the maximum amount of time that the backoff will
|
||||
// delay for.
|
||||
var DefaultMaxDuration = 6 * time.Hour
|
||||
|
||||
@@ -50,10 +42,9 @@ type Backoff struct {
|
||||
// interval controls the time step for backing off.
|
||||
interval time.Duration
|
||||
|
||||
// noJitter controls whether to use the "Full Jitter"
|
||||
// improvement to attempt to smooth out spikes in a high
|
||||
// contention scenario. If noJitter is set to true, no
|
||||
// jitter will be introduced.
|
||||
// noJitter controls whether to use the "Full Jitter" improvement to attempt
|
||||
// to smooth out spikes in a high-contention scenario. If noJitter is set to
|
||||
// true, no jitter will be introduced.
|
||||
noJitter bool
|
||||
|
||||
// decay controls the decay of n. If it is non-zero, n is
|
||||
@@ -65,17 +56,17 @@ type Backoff struct {
|
||||
lastTry time.Time
|
||||
}
|
||||
|
||||
// New creates a new backoff with the specified max duration and
|
||||
// New creates a new backoff with the specified maxDuration duration and
|
||||
// interval. Zero values may be used to use the default values.
|
||||
//
|
||||
// Panics if either max or interval is negative.
|
||||
func New(max time.Duration, interval time.Duration) *Backoff {
|
||||
if max < 0 || interval < 0 {
|
||||
panic("backoff: max or interval is negative")
|
||||
// Panics if either dMax or interval is negative.
|
||||
func New(dMax time.Duration, interval time.Duration) *Backoff {
|
||||
if dMax < 0 || interval < 0 {
|
||||
panic("backoff: dMax or interval is negative")
|
||||
}
|
||||
|
||||
b := &Backoff{
|
||||
maxDuration: max,
|
||||
maxDuration: dMax,
|
||||
interval: interval,
|
||||
}
|
||||
b.setup()
|
||||
@@ -84,27 +75,12 @@ func New(max time.Duration, interval time.Duration) *Backoff {
|
||||
|
||||
// NewWithoutJitter works similarly to New, except that the created
|
||||
// Backoff will not use jitter.
|
||||
func NewWithoutJitter(max time.Duration, interval time.Duration) *Backoff {
|
||||
b := New(max, interval)
|
||||
func NewWithoutJitter(dMax time.Duration, interval time.Duration) *Backoff {
|
||||
b := New(dMax, interval)
|
||||
b.noJitter = true
|
||||
return b
|
||||
}
|
||||
|
||||
func init() {
|
||||
var buf [8]byte
|
||||
var n int64
|
||||
|
||||
_, err := io.ReadFull(rand.Reader, buf[:])
|
||||
if err != nil {
|
||||
panic(err.Error())
|
||||
}
|
||||
|
||||
n = int64(binary.LittleEndian.Uint64(buf[:]))
|
||||
|
||||
src := mrand.NewSource(n)
|
||||
prng = mrand.New(src)
|
||||
}
|
||||
|
||||
func (b *Backoff) setup() {
|
||||
if b.interval == 0 {
|
||||
b.interval = DefaultInterval
|
||||
@@ -122,35 +98,44 @@ func (b *Backoff) Duration() time.Duration {
|
||||
|
||||
b.decayN()
|
||||
|
||||
t := b.duration(b.n)
|
||||
d := b.duration(b.n)
|
||||
|
||||
if b.n < math.MaxUint64 {
|
||||
b.n++
|
||||
}
|
||||
|
||||
if !b.noJitter {
|
||||
prngMu.Lock()
|
||||
t = time.Duration(prng.Int63n(int64(t)))
|
||||
prngMu.Unlock()
|
||||
d = time.Duration(rand.Int64N(int64(d))) // #nosec G404
|
||||
}
|
||||
|
||||
return t
|
||||
return d
|
||||
}
|
||||
|
||||
const maxN uint64 = 63
|
||||
|
||||
// requires b to be locked.
|
||||
func (b *Backoff) duration(n uint64) (t time.Duration) {
|
||||
// Saturate pow
|
||||
pow := time.Duration(math.MaxInt64)
|
||||
if n < 63 {
|
||||
pow = 1 << n
|
||||
func (b *Backoff) duration(n uint64) time.Duration {
|
||||
// Use left shift on the underlying integer representation to avoid
|
||||
// multiplying time.Duration by time.Duration (which is semantically
|
||||
// incorrect and flagged by linters).
|
||||
if n >= maxN {
|
||||
// Saturate when n would overflow a 64-bit shift or exceed maxDuration.
|
||||
return b.maxDuration
|
||||
}
|
||||
|
||||
t = b.interval * pow
|
||||
if t/pow != b.interval || t > b.maxDuration {
|
||||
t = b.maxDuration
|
||||
// Calculate 2^n * interval using a shift. Detect overflow by checking
|
||||
// for sign change or monotonicity loss and clamp to maxDuration.
|
||||
shifted := b.interval << n
|
||||
if shifted < 0 || shifted < b.interval {
|
||||
// Overflow occurred during the shift; clamp to maxDuration.
|
||||
return b.maxDuration
|
||||
}
|
||||
|
||||
return
|
||||
if shifted > b.maxDuration {
|
||||
return b.maxDuration
|
||||
}
|
||||
|
||||
return shifted
|
||||
}
|
||||
|
||||
// Reset resets the attempt counter of a backoff.
|
||||
@@ -174,7 +159,7 @@ func (b *Backoff) SetDecay(decay time.Duration) {
|
||||
b.decay = decay
|
||||
}
|
||||
|
||||
// requires b to be locked
|
||||
// requires b to be locked.
|
||||
func (b *Backoff) decayN() {
|
||||
if b.decay == 0 {
|
||||
return
|
||||
@@ -186,7 +171,9 @@ func (b *Backoff) decayN() {
|
||||
}
|
||||
|
||||
lastDuration := b.duration(b.n - 1)
|
||||
decayed := time.Since(b.lastTry) > lastDuration+b.decay
|
||||
// Reset when the elapsed time is at least the previous backoff plus decay.
|
||||
// Using ">=" avoids boundary flakiness in tests and real usage.
|
||||
decayed := time.Since(b.lastTry) >= lastDuration+b.decay
|
||||
b.lastTry = time.Now()
|
||||
|
||||
if !decayed {
|
||||
|
||||
@@ -9,7 +9,7 @@ import (
|
||||
|
||||
// If given New with 0's and no jitter, ensure that certain invariants are met:
|
||||
//
|
||||
// - the default max duration and interval should be used
|
||||
// - the default maxDuration duration and interval should be used
|
||||
// - noJitter should be true
|
||||
// - the RNG should not be initialised
|
||||
// - the first duration should be equal to the default interval
|
||||
@@ -17,7 +17,11 @@ func TestDefaults(t *testing.T) {
|
||||
b := NewWithoutJitter(0, 0)
|
||||
|
||||
if b.maxDuration != DefaultMaxDuration {
|
||||
t.Fatalf("expected new backoff to use the default max duration (%s), but have %s", DefaultMaxDuration, b.maxDuration)
|
||||
t.Fatalf(
|
||||
"expected new backoff to use the default maxDuration duration (%s), but have %s",
|
||||
DefaultMaxDuration,
|
||||
b.maxDuration,
|
||||
)
|
||||
}
|
||||
|
||||
if b.interval != DefaultInterval {
|
||||
@@ -44,11 +48,11 @@ func TestSetup(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// Ensure that tries incremenets as expected.
|
||||
// Ensure that tries increments as expected.
|
||||
func TestTries(t *testing.T) {
|
||||
b := NewWithoutJitter(5, 1)
|
||||
|
||||
for i := uint64(0); i < 3; i++ {
|
||||
for i := range uint64(3) {
|
||||
if b.n != i {
|
||||
t.Fatalf("want tries=%d, have tries=%d", i, b.n)
|
||||
}
|
||||
@@ -73,7 +77,7 @@ func TestTries(t *testing.T) {
|
||||
func TestReset(t *testing.T) {
|
||||
const iter = 10
|
||||
b := New(1000, 1)
|
||||
for i := 0; i < iter; i++ {
|
||||
for range iter {
|
||||
_ = b.Duration()
|
||||
}
|
||||
|
||||
@@ -88,17 +92,17 @@ func TestReset(t *testing.T) {
|
||||
}
|
||||
|
||||
const decay = 5 * time.Millisecond
|
||||
const max = 10 * time.Millisecond
|
||||
const maxDuration = 10 * time.Millisecond
|
||||
const interval = time.Millisecond
|
||||
|
||||
func TestDecay(t *testing.T) {
|
||||
const iter = 10
|
||||
|
||||
b := NewWithoutJitter(max, 1)
|
||||
b := NewWithoutJitter(maxDuration, 1)
|
||||
b.SetDecay(decay)
|
||||
|
||||
var backoff time.Duration
|
||||
for i := 0; i < iter; i++ {
|
||||
for range iter {
|
||||
backoff = b.Duration()
|
||||
}
|
||||
|
||||
@@ -127,7 +131,7 @@ func TestDecaySaturation(t *testing.T) {
|
||||
b.SetDecay(decay)
|
||||
|
||||
var duration time.Duration
|
||||
for i := 0; i <= 2; i++ {
|
||||
for range 3 {
|
||||
duration = b.Duration()
|
||||
}
|
||||
|
||||
@@ -145,7 +149,7 @@ func TestDecaySaturation(t *testing.T) {
|
||||
}
|
||||
|
||||
func ExampleBackoff_SetDecay() {
|
||||
b := NewWithoutJitter(max, interval)
|
||||
b := NewWithoutJitter(maxDuration, interval)
|
||||
b.SetDecay(decay)
|
||||
|
||||
// try 0
|
||||
|
||||
33
certlib/certerr/doc.go
Normal file
33
certlib/certerr/doc.go
Normal file
@@ -0,0 +1,33 @@
|
||||
// Package certerr provides typed errors and helpers for certificate-related
|
||||
// operations across the repository. It standardizes error construction and
|
||||
// matching so callers can reliably branch on error source/kind using the
|
||||
// Go 1.13+ `errors.Is` and `errors.As` helpers.
|
||||
//
|
||||
// Guidelines
|
||||
// - Always wrap underlying causes using the helper constructors or with
|
||||
// fmt.Errorf("context: %w", err).
|
||||
// - Do not include sensitive data (keys, passwords, tokens) in error
|
||||
// messages; add only non-sensitive, actionable context.
|
||||
// - Prefer programmatic checks via errors.Is (for sentinel errors) and
|
||||
// errors.As (to retrieve *certerr.Error) rather than relying on error
|
||||
// string contents.
|
||||
//
|
||||
// Typical usage
|
||||
//
|
||||
// if err := doParse(); err != nil {
|
||||
// return certerr.ParsingError(certerr.ErrorSourceCertificate, err)
|
||||
// }
|
||||
//
|
||||
// Callers may branch on error kinds and sources:
|
||||
//
|
||||
// var e *certerr.Error
|
||||
// if errors.As(err, &e) {
|
||||
// switch e.Kind {
|
||||
// case certerr.KindParse:
|
||||
// // handle parse error
|
||||
// }
|
||||
// }
|
||||
//
|
||||
// Sentinel errors are provided for common conditions like
|
||||
// `certerr.ErrEncryptedPrivateKey` and can be matched with `errors.Is`.
|
||||
package certerr
|
||||
@@ -37,6 +37,48 @@ const (
|
||||
ErrorSourceKeypair ErrorSourceType = 5
|
||||
)
|
||||
|
||||
// ErrorKind is a broad classification describing what went wrong.
|
||||
type ErrorKind uint8
|
||||
|
||||
const (
|
||||
KindParse ErrorKind = iota + 1
|
||||
KindDecode
|
||||
KindVerify
|
||||
KindLoad
|
||||
)
|
||||
|
||||
func (k ErrorKind) String() string {
|
||||
switch k {
|
||||
case KindParse:
|
||||
return "parse"
|
||||
case KindDecode:
|
||||
return "decode"
|
||||
case KindVerify:
|
||||
return "verify"
|
||||
case KindLoad:
|
||||
return "load"
|
||||
default:
|
||||
return "unknown"
|
||||
}
|
||||
}
|
||||
|
||||
// Error is a typed, wrapped error with structured context for programmatic checks.
|
||||
// It implements error and supports errors.Is/As via Unwrap.
|
||||
type Error struct {
|
||||
Source ErrorSourceType // which domain produced the error (certificate, private key, etc.)
|
||||
Kind ErrorKind // operation category (parse, decode, verify, load)
|
||||
Op string // optional operation or function name
|
||||
Err error // wrapped cause
|
||||
}
|
||||
|
||||
func (e *Error) Error() string {
|
||||
// Keep message format consistent with existing helpers: "failed to <kind> <source>: <err>"
|
||||
// Do not include Op by default to preserve existing output expectations.
|
||||
return fmt.Sprintf("failed to %s %s: %v", e.Kind.String(), e.Source.String(), e.Err)
|
||||
}
|
||||
|
||||
func (e *Error) Unwrap() error { return e.Err }
|
||||
|
||||
// InvalidPEMType is used to indicate that we were expecting one type of PEM
|
||||
// file, but saw another.
|
||||
type InvalidPEMType struct {
|
||||
@@ -61,19 +103,19 @@ func ErrInvalidPEMType(have string, want ...string) error {
|
||||
}
|
||||
|
||||
func LoadingError(t ErrorSourceType, err error) error {
|
||||
return fmt.Errorf("failed to load %s from disk: %w", t, err)
|
||||
return &Error{Source: t, Kind: KindLoad, Err: err}
|
||||
}
|
||||
|
||||
func ParsingError(t ErrorSourceType, err error) error {
|
||||
return fmt.Errorf("failed to parse %s: %w", t, err)
|
||||
return &Error{Source: t, Kind: KindParse, Err: err}
|
||||
}
|
||||
|
||||
func DecodeError(t ErrorSourceType, err error) error {
|
||||
return fmt.Errorf("failed to decode %s: %w", t, err)
|
||||
return &Error{Source: t, Kind: KindDecode, Err: err}
|
||||
}
|
||||
|
||||
func VerifyError(t ErrorSourceType, err error) error {
|
||||
return fmt.Errorf("failed to verify %s: %w", t, err)
|
||||
return &Error{Source: t, Kind: KindVerify, Err: err}
|
||||
}
|
||||
|
||||
var ErrEncryptedPrivateKey = errors.New("private key is encrypted")
|
||||
|
||||
55
certlib/certerr/errors_test.go
Normal file
55
certlib/certerr/errors_test.go
Normal file
@@ -0,0 +1,55 @@
|
||||
package certerr
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestTypedErrorWrappingAndFormatting(t *testing.T) {
|
||||
cause := errors.New("bad data")
|
||||
err := DecodeError(ErrorSourceCertificate, cause)
|
||||
|
||||
// Ensure we can retrieve the typed error
|
||||
var e *Error
|
||||
if !errors.As(err, &e) {
|
||||
t.Fatalf("expected errors.As to retrieve *certerr.Error, got %T", err)
|
||||
}
|
||||
if e.Kind != KindDecode {
|
||||
t.Fatalf("unexpected kind: %v", e.Kind)
|
||||
}
|
||||
if e.Source != ErrorSourceCertificate {
|
||||
t.Fatalf("unexpected source: %v", e.Source)
|
||||
}
|
||||
|
||||
// Check message format (no trailing punctuation enforced by content)
|
||||
msg := e.Error()
|
||||
if !strings.Contains(msg, "failed to decode certificate") || !strings.Contains(msg, "bad data") {
|
||||
t.Fatalf("unexpected error message: %q", msg)
|
||||
}
|
||||
}
|
||||
|
||||
func TestErrorsIsOnWrappedSentinel(t *testing.T) {
|
||||
err := DecodeError(ErrorSourcePrivateKey, ErrEncryptedPrivateKey)
|
||||
if !errors.Is(err, ErrEncryptedPrivateKey) {
|
||||
t.Fatalf("expected errors.Is to match ErrEncryptedPrivateKey")
|
||||
}
|
||||
}
|
||||
|
||||
func TestInvalidPEMTypeMessageSingle(t *testing.T) {
|
||||
err := ErrInvalidPEMType("FOO", "CERTIFICATE")
|
||||
want := "invalid PEM type: have FOO, expected CERTIFICATE"
|
||||
if err.Error() != want {
|
||||
t.Fatalf("unexpected error message: got %q, want %q", err.Error(), want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestInvalidPEMTypeMessageMultiple(t *testing.T) {
|
||||
err := ErrInvalidPEMType("FOO", "CERTIFICATE", "NEW CERTIFICATE REQUEST")
|
||||
if !strings.Contains(
|
||||
err.Error(),
|
||||
"invalid PEM type: have FOO, expected one of CERTIFICATE, NEW CERTIFICATE REQUEST",
|
||||
) {
|
||||
t.Fatalf("unexpected error message: %q", err.Error())
|
||||
}
|
||||
}
|
||||
@@ -4,7 +4,7 @@ import (
|
||||
"crypto/x509"
|
||||
"encoding/pem"
|
||||
"errors"
|
||||
"io/ioutil"
|
||||
"os"
|
||||
|
||||
"git.wntrmute.dev/kyle/goutils/certlib/certerr"
|
||||
)
|
||||
@@ -13,28 +13,31 @@ import (
|
||||
// byte slice.
|
||||
func ReadCertificate(in []byte) (cert *x509.Certificate, rest []byte, err error) {
|
||||
if len(in) == 0 {
|
||||
err = certerr.ErrEmptyCertificate
|
||||
return
|
||||
return nil, nil, certerr.ParsingError(certerr.ErrorSourceCertificate, certerr.ErrEmptyCertificate)
|
||||
}
|
||||
|
||||
if in[0] == '-' {
|
||||
p, remaining := pem.Decode(in)
|
||||
if p == nil {
|
||||
err = errors.New("certlib: invalid PEM file")
|
||||
return
|
||||
return nil, nil, certerr.ParsingError(certerr.ErrorSourceCertificate, errors.New("invalid PEM file"))
|
||||
}
|
||||
|
||||
rest = remaining
|
||||
if p.Type != "CERTIFICATE" {
|
||||
err = certerr.ErrInvalidPEMType(p.Type, "CERTIFICATE")
|
||||
return
|
||||
return nil, rest, certerr.ParsingError(
|
||||
certerr.ErrorSourceCertificate,
|
||||
certerr.ErrInvalidPEMType(p.Type, "CERTIFICATE"),
|
||||
)
|
||||
}
|
||||
|
||||
in = p.Bytes
|
||||
}
|
||||
|
||||
cert, err = x509.ParseCertificate(in)
|
||||
return
|
||||
if err != nil {
|
||||
return nil, rest, certerr.ParsingError(certerr.ErrorSourceCertificate, err)
|
||||
}
|
||||
return cert, rest, nil
|
||||
}
|
||||
|
||||
// ReadCertificates tries to read all the certificates in a
|
||||
@@ -64,9 +67,9 @@ func ReadCertificates(in []byte) (certs []*x509.Certificate, err error) {
|
||||
// the file contains multiple certificates (e.g. a chain), only the
|
||||
// first certificate is returned.
|
||||
func LoadCertificate(path string) (*x509.Certificate, error) {
|
||||
in, err := ioutil.ReadFile(path)
|
||||
in, err := os.ReadFile(path)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
return nil, certerr.LoadingError(certerr.ErrorSourceCertificate, err)
|
||||
}
|
||||
|
||||
cert, _, err := ReadCertificate(in)
|
||||
@@ -76,9 +79,9 @@ func LoadCertificate(path string) (*x509.Certificate, error) {
|
||||
// LoadCertificates tries to read all the certificates in a file,
|
||||
// returning them in the order that it found them in the file.
|
||||
func LoadCertificates(path string) ([]*x509.Certificate, error) {
|
||||
in, err := ioutil.ReadFile(path)
|
||||
in, err := os.ReadFile(path)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
return nil, certerr.LoadingError(certerr.ErrorSourceCertificate, err)
|
||||
}
|
||||
|
||||
return ReadCertificates(in)
|
||||
|
||||
@@ -65,10 +65,10 @@ const OneYear = 8760 * time.Hour
|
||||
// OneDay is a time.Duration representing a day's worth of seconds.
|
||||
const OneDay = 24 * time.Hour
|
||||
|
||||
// DelegationUsage is the OID for the DelegationUseage extensions
|
||||
// DelegationUsage is the OID for the DelegationUseage extensions.
|
||||
var DelegationUsage = asn1.ObjectIdentifier{1, 3, 6, 1, 4, 1, 44363, 44}
|
||||
|
||||
// DelegationExtension
|
||||
// DelegationExtension.
|
||||
var DelegationExtension = pkix.Extension{
|
||||
Id: DelegationUsage,
|
||||
Critical: false,
|
||||
@@ -89,24 +89,28 @@ var Jul2012 = InclusiveDate(2012, time.July, 01)
|
||||
// issuing certificates valid for more than 39 months.
|
||||
var Apr2015 = InclusiveDate(2015, time.April, 01)
|
||||
|
||||
// KeyLength returns the bit size of ECDSA or RSA PublicKey
|
||||
func KeyLength(key interface{}) int {
|
||||
if key == nil {
|
||||
// KeyLength returns the bit size of ECDSA or RSA PublicKey.
|
||||
func KeyLength(key any) int {
|
||||
switch k := key.(type) {
|
||||
case *ecdsa.PublicKey:
|
||||
if k == nil {
|
||||
return 0
|
||||
}
|
||||
return k.Curve.Params().BitSize
|
||||
case *rsa.PublicKey:
|
||||
if k == nil {
|
||||
return 0
|
||||
}
|
||||
return k.N.BitLen()
|
||||
default:
|
||||
return 0
|
||||
}
|
||||
if ecdsaKey, ok := key.(*ecdsa.PublicKey); ok {
|
||||
return ecdsaKey.Curve.Params().BitSize
|
||||
} else if rsaKey, ok := key.(*rsa.PublicKey); ok {
|
||||
return rsaKey.N.BitLen()
|
||||
}
|
||||
|
||||
return 0
|
||||
}
|
||||
|
||||
// ExpiryTime returns the time when the certificate chain is expired.
|
||||
func ExpiryTime(chain []*x509.Certificate) (notAfter time.Time) {
|
||||
if len(chain) == 0 {
|
||||
return
|
||||
return notAfter
|
||||
}
|
||||
|
||||
notAfter = chain[0].NotAfter
|
||||
@@ -115,7 +119,7 @@ func ExpiryTime(chain []*x509.Certificate) (notAfter time.Time) {
|
||||
notAfter = cert.NotAfter
|
||||
}
|
||||
}
|
||||
return
|
||||
return notAfter
|
||||
}
|
||||
|
||||
// MonthsValid returns the number of months for which a certificate is valid.
|
||||
@@ -144,109 +148,99 @@ func ValidExpiry(c *x509.Certificate) bool {
|
||||
maxMonths = 39
|
||||
case issued.After(Jul2012):
|
||||
maxMonths = 60
|
||||
case issued.Before(Jul2012):
|
||||
default:
|
||||
maxMonths = 120
|
||||
}
|
||||
|
||||
if MonthsValid(c) > maxMonths {
|
||||
return false
|
||||
}
|
||||
return true
|
||||
return MonthsValid(c) <= maxMonths
|
||||
}
|
||||
|
||||
// SignatureString returns the TLS signature string corresponding to
|
||||
// an X509 signature algorithm.
|
||||
var signatureString = map[x509.SignatureAlgorithm]string{
|
||||
x509.MD2WithRSA: "MD2WithRSA",
|
||||
x509.MD5WithRSA: "MD5WithRSA",
|
||||
x509.SHA1WithRSA: "SHA1WithRSA",
|
||||
x509.SHA256WithRSA: "SHA256WithRSA",
|
||||
x509.SHA384WithRSA: "SHA384WithRSA",
|
||||
x509.SHA512WithRSA: "SHA512WithRSA",
|
||||
x509.DSAWithSHA1: "DSAWithSHA1",
|
||||
x509.DSAWithSHA256: "DSAWithSHA256",
|
||||
x509.ECDSAWithSHA1: "ECDSAWithSHA1",
|
||||
x509.ECDSAWithSHA256: "ECDSAWithSHA256",
|
||||
x509.ECDSAWithSHA384: "ECDSAWithSHA384",
|
||||
x509.ECDSAWithSHA512: "ECDSAWithSHA512",
|
||||
}
|
||||
|
||||
// SignatureString returns the TLS signature string corresponding to
|
||||
// an X509 signature algorithm.
|
||||
func SignatureString(alg x509.SignatureAlgorithm) string {
|
||||
switch alg {
|
||||
case x509.MD2WithRSA:
|
||||
return "MD2WithRSA"
|
||||
case x509.MD5WithRSA:
|
||||
return "MD5WithRSA"
|
||||
case x509.SHA1WithRSA:
|
||||
return "SHA1WithRSA"
|
||||
case x509.SHA256WithRSA:
|
||||
return "SHA256WithRSA"
|
||||
case x509.SHA384WithRSA:
|
||||
return "SHA384WithRSA"
|
||||
case x509.SHA512WithRSA:
|
||||
return "SHA512WithRSA"
|
||||
case x509.DSAWithSHA1:
|
||||
return "DSAWithSHA1"
|
||||
case x509.DSAWithSHA256:
|
||||
return "DSAWithSHA256"
|
||||
case x509.ECDSAWithSHA1:
|
||||
return "ECDSAWithSHA1"
|
||||
case x509.ECDSAWithSHA256:
|
||||
return "ECDSAWithSHA256"
|
||||
case x509.ECDSAWithSHA384:
|
||||
return "ECDSAWithSHA384"
|
||||
case x509.ECDSAWithSHA512:
|
||||
return "ECDSAWithSHA512"
|
||||
default:
|
||||
return "Unknown Signature"
|
||||
if s, ok := signatureString[alg]; ok {
|
||||
return s
|
||||
}
|
||||
return "Unknown Signature"
|
||||
}
|
||||
|
||||
// HashAlgoString returns the hash algorithm name contains in the signature
|
||||
// method.
|
||||
var hashAlgoString = map[x509.SignatureAlgorithm]string{
|
||||
x509.MD2WithRSA: "MD2",
|
||||
x509.MD5WithRSA: "MD5",
|
||||
x509.SHA1WithRSA: "SHA1",
|
||||
x509.SHA256WithRSA: "SHA256",
|
||||
x509.SHA384WithRSA: "SHA384",
|
||||
x509.SHA512WithRSA: "SHA512",
|
||||
x509.DSAWithSHA1: "SHA1",
|
||||
x509.DSAWithSHA256: "SHA256",
|
||||
x509.ECDSAWithSHA1: "SHA1",
|
||||
x509.ECDSAWithSHA256: "SHA256",
|
||||
x509.ECDSAWithSHA384: "SHA384",
|
||||
x509.ECDSAWithSHA512: "SHA512",
|
||||
}
|
||||
|
||||
// HashAlgoString returns the hash algorithm name contains in the signature
|
||||
// method.
|
||||
func HashAlgoString(alg x509.SignatureAlgorithm) string {
|
||||
switch alg {
|
||||
case x509.MD2WithRSA:
|
||||
return "MD2"
|
||||
case x509.MD5WithRSA:
|
||||
return "MD5"
|
||||
case x509.SHA1WithRSA:
|
||||
return "SHA1"
|
||||
case x509.SHA256WithRSA:
|
||||
return "SHA256"
|
||||
case x509.SHA384WithRSA:
|
||||
return "SHA384"
|
||||
case x509.SHA512WithRSA:
|
||||
return "SHA512"
|
||||
case x509.DSAWithSHA1:
|
||||
return "SHA1"
|
||||
case x509.DSAWithSHA256:
|
||||
return "SHA256"
|
||||
case x509.ECDSAWithSHA1:
|
||||
return "SHA1"
|
||||
case x509.ECDSAWithSHA256:
|
||||
return "SHA256"
|
||||
case x509.ECDSAWithSHA384:
|
||||
return "SHA384"
|
||||
case x509.ECDSAWithSHA512:
|
||||
return "SHA512"
|
||||
default:
|
||||
return "Unknown Hash Algorithm"
|
||||
if s, ok := hashAlgoString[alg]; ok {
|
||||
return s
|
||||
}
|
||||
return "Unknown Hash Algorithm"
|
||||
}
|
||||
|
||||
// StringTLSVersion returns underlying enum values from human names for TLS
|
||||
// versions, defaults to current golang default of TLS 1.0
|
||||
// versions, defaults to current golang default of TLS 1.0.
|
||||
func StringTLSVersion(version string) uint16 {
|
||||
switch version {
|
||||
case "1.3":
|
||||
return tls.VersionTLS13
|
||||
case "1.2":
|
||||
return tls.VersionTLS12
|
||||
case "1.1":
|
||||
return tls.VersionTLS11
|
||||
case "1.0":
|
||||
return tls.VersionTLS10
|
||||
default:
|
||||
// Default to Go's historical default of TLS 1.0 for unknown values
|
||||
return tls.VersionTLS10
|
||||
}
|
||||
}
|
||||
|
||||
// EncodeCertificatesPEM encodes a number of x509 certificates to PEM
|
||||
// EncodeCertificatesPEM encodes a number of x509 certificates to PEM.
|
||||
func EncodeCertificatesPEM(certs []*x509.Certificate) []byte {
|
||||
var buffer bytes.Buffer
|
||||
for _, cert := range certs {
|
||||
pem.Encode(&buffer, &pem.Block{
|
||||
if err := pem.Encode(&buffer, &pem.Block{
|
||||
Type: "CERTIFICATE",
|
||||
Bytes: cert.Raw,
|
||||
})
|
||||
}); err != nil {
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
||||
return buffer.Bytes()
|
||||
}
|
||||
|
||||
// EncodeCertificatePEM encodes a single x509 certificates to PEM
|
||||
// EncodeCertificatePEM encodes a single x509 certificates to PEM.
|
||||
func EncodeCertificatePEM(cert *x509.Certificate) []byte {
|
||||
return EncodeCertificatesPEM([]*x509.Certificate{cert})
|
||||
}
|
||||
@@ -269,7 +263,10 @@ func ParseCertificatesPEM(certsPEM []byte) ([]*x509.Certificate, error) {
|
||||
certs = append(certs, cert...)
|
||||
}
|
||||
if len(certsPEM) > 0 {
|
||||
return nil, certerr.DecodeError(certerr.ErrorSourceCertificate, errors.New("trailing data at end of certificate"))
|
||||
return nil, certerr.DecodeError(
|
||||
certerr.ErrorSourceCertificate,
|
||||
errors.New("trailing data at end of certificate"),
|
||||
)
|
||||
}
|
||||
return certs, nil
|
||||
}
|
||||
@@ -278,29 +275,40 @@ func ParseCertificatesPEM(certsPEM []byte) ([]*x509.Certificate, error) {
|
||||
// either PKCS #7, PKCS #12, or raw x509.
|
||||
func ParseCertificatesDER(certsDER []byte, password string) (certs []*x509.Certificate, key crypto.Signer, err error) {
|
||||
certsDER = bytes.TrimSpace(certsDER)
|
||||
pkcs7data, err := pkcs7.ParsePKCS7(certsDER)
|
||||
if err != nil {
|
||||
var pkcs12data interface{}
|
||||
certs = make([]*x509.Certificate, 1)
|
||||
pkcs12data, certs[0], err = pkcs12.Decode(certsDER, password)
|
||||
if err != nil {
|
||||
certs, err = x509.ParseCertificates(certsDER)
|
||||
if err != nil {
|
||||
return nil, nil, certerr.DecodeError(certerr.ErrorSourceCertificate, err)
|
||||
}
|
||||
} else {
|
||||
key = pkcs12data.(crypto.Signer)
|
||||
}
|
||||
} else {
|
||||
|
||||
// First, try PKCS #7
|
||||
if pkcs7data, err7 := pkcs7.ParsePKCS7(certsDER); err7 == nil {
|
||||
if pkcs7data.ContentInfo != "SignedData" {
|
||||
return nil, nil, certerr.DecodeError(certerr.ErrorSourceCertificate, errors.New("can only extract certificates from signed data content info"))
|
||||
return nil, nil, certerr.DecodeError(
|
||||
certerr.ErrorSourceCertificate,
|
||||
errors.New("can only extract certificates from signed data content info"),
|
||||
)
|
||||
}
|
||||
certs = pkcs7data.Content.SignedData.Certificates
|
||||
if certs == nil {
|
||||
return nil, nil, certerr.DecodeError(certerr.ErrorSourceCertificate, errors.New("no certificates decoded"))
|
||||
}
|
||||
return certs, nil, nil
|
||||
}
|
||||
if certs == nil {
|
||||
return nil, key, certerr.DecodeError(certerr.ErrorSourceCertificate, errors.New("no certificates decoded"))
|
||||
|
||||
// Next, try PKCS #12
|
||||
if pkcs12data, cert, err12 := pkcs12.Decode(certsDER, password); err12 == nil {
|
||||
signer, ok := pkcs12data.(crypto.Signer)
|
||||
if !ok {
|
||||
return nil, nil, certerr.DecodeError(
|
||||
certerr.ErrorSourcePrivateKey,
|
||||
errors.New("PKCS12 data does not contain a private key"),
|
||||
)
|
||||
}
|
||||
return []*x509.Certificate{cert}, signer, nil
|
||||
}
|
||||
return certs, key, nil
|
||||
|
||||
// Finally, attempt to parse raw X.509 certificates
|
||||
certs, err = x509.ParseCertificates(certsDER)
|
||||
if err != nil {
|
||||
return nil, nil, certerr.DecodeError(certerr.ErrorSourceCertificate, err)
|
||||
}
|
||||
return certs, nil, nil
|
||||
}
|
||||
|
||||
// ParseSelfSignedCertificatePEM parses a PEM-encoded certificate and check if it is self-signed.
|
||||
@@ -320,17 +328,26 @@ func ParseSelfSignedCertificatePEM(certPEM []byte) (*x509.Certificate, error) {
|
||||
// can handle PEM encoded PKCS #7 structures.
|
||||
func ParseCertificatePEM(certPEM []byte) (*x509.Certificate, error) {
|
||||
certPEM = bytes.TrimSpace(certPEM)
|
||||
cert, rest, err := ParseOneCertificateFromPEM(certPEM)
|
||||
certs, rest, err := ParseOneCertificateFromPEM(certPEM)
|
||||
if err != nil {
|
||||
return nil, certerr.ParsingError(certerr.ErrorSourceCertificate, err)
|
||||
} else if cert == nil {
|
||||
return nil, certerr.DecodeError(certerr.ErrorSourceCertificate, errors.New("no certificate decoded"))
|
||||
} else if len(rest) > 0 {
|
||||
return nil, certerr.ParsingError(certerr.ErrorSourceCertificate, errors.New("the PEM file should contain only one object"))
|
||||
} else if len(cert) > 1 {
|
||||
return nil, certerr.ParsingError(certerr.ErrorSourceCertificate, errors.New("the PKCS7 object in the PEM file should contain only one certificate"))
|
||||
}
|
||||
return cert[0], nil
|
||||
if certs == nil {
|
||||
return nil, certerr.DecodeError(certerr.ErrorSourceCertificate, errors.New("no certificate decoded"))
|
||||
}
|
||||
if len(rest) > 0 {
|
||||
return nil, certerr.ParsingError(
|
||||
certerr.ErrorSourceCertificate,
|
||||
errors.New("the PEM file should contain only one object"),
|
||||
)
|
||||
}
|
||||
if len(certs) > 1 {
|
||||
return nil, certerr.ParsingError(
|
||||
certerr.ErrorSourceCertificate,
|
||||
errors.New("the PKCS7 object in the PEM file should contain only one certificate"),
|
||||
)
|
||||
}
|
||||
return certs[0], nil
|
||||
}
|
||||
|
||||
// ParseOneCertificateFromPEM attempts to parse one PEM encoded certificate object,
|
||||
@@ -338,7 +355,6 @@ func ParseCertificatePEM(certPEM []byte) (*x509.Certificate, error) {
|
||||
// multiple certificates, from the top of certsPEM, which itself may
|
||||
// contain multiple PEM encoded certificate objects.
|
||||
func ParseOneCertificateFromPEM(certsPEM []byte) ([]*x509.Certificate, []byte, error) {
|
||||
|
||||
block, rest := pem.Decode(certsPEM)
|
||||
if block == nil {
|
||||
return nil, rest, nil
|
||||
@@ -384,7 +400,7 @@ func PEMToCertPool(pemCerts []byte) (*x509.CertPool, error) {
|
||||
|
||||
certPool := x509.NewCertPool()
|
||||
if !certPool.AppendCertsFromPEM(pemCerts) {
|
||||
return nil, errors.New("failed to load cert pool")
|
||||
return nil, certerr.LoadingError(certerr.ErrorSourceCertificate, errors.New("failed to load cert pool"))
|
||||
}
|
||||
|
||||
return certPool, nil
|
||||
@@ -441,7 +457,10 @@ func ParseCSR(in []byte) (csr *x509.CertificateRequest, rest []byte, err error)
|
||||
p, rest := pem.Decode(in)
|
||||
if p != nil {
|
||||
if p.Type != "NEW CERTIFICATE REQUEST" && p.Type != "CERTIFICATE REQUEST" {
|
||||
return nil, rest, certerr.ParsingError(certerr.ErrorSourceCSR, certerr.ErrInvalidPEMType(p.Type, "NEW CERTIFICATE REQUEST", "CERTIFICATE REQUEST"))
|
||||
return nil, rest, certerr.ParsingError(
|
||||
certerr.ErrorSourceCSR,
|
||||
certerr.ErrInvalidPEMType(p.Type, "NEW CERTIFICATE REQUEST", "CERTIFICATE REQUEST"),
|
||||
)
|
||||
}
|
||||
|
||||
csr, err = x509.ParseCertificateRequest(p.Bytes)
|
||||
@@ -450,12 +469,12 @@ func ParseCSR(in []byte) (csr *x509.CertificateRequest, rest []byte, err error)
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
return nil, rest, err
|
||||
return nil, rest, certerr.ParsingError(certerr.ErrorSourceCSR, err)
|
||||
}
|
||||
|
||||
err = csr.CheckSignature()
|
||||
if err != nil {
|
||||
return nil, rest, err
|
||||
return nil, rest, certerr.VerifyError(certerr.ErrorSourceCSR, err)
|
||||
}
|
||||
|
||||
return csr, rest, nil
|
||||
@@ -472,7 +491,7 @@ func ParseCSRPEM(csrPEM []byte) (*x509.CertificateRequest, error) {
|
||||
csrObject, err := x509.ParseCertificateRequest(block.Bytes)
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
return nil, certerr.ParsingError(certerr.ErrorSourceCSR, err)
|
||||
}
|
||||
|
||||
return csrObject, nil
|
||||
@@ -509,7 +528,7 @@ func SignerAlgo(priv crypto.Signer) x509.SignatureAlgorithm {
|
||||
}
|
||||
}
|
||||
|
||||
// LoadClientCertificate load key/certificate from pem files
|
||||
// LoadClientCertificate load key/certificate from pem files.
|
||||
func LoadClientCertificate(certFile string, keyFile string) (*tls.Certificate, error) {
|
||||
if certFile != "" && keyFile != "" {
|
||||
cert, err := tls.LoadX509KeyPair(certFile, keyFile)
|
||||
@@ -521,7 +540,7 @@ func LoadClientCertificate(certFile string, keyFile string) (*tls.Certificate, e
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
// CreateTLSConfig creates a tls.Config object from certs and roots
|
||||
// CreateTLSConfig creates a tls.Config object from certs and roots.
|
||||
func CreateTLSConfig(remoteCAs *x509.CertPool, cert *tls.Certificate) *tls.Config {
|
||||
var certs []tls.Certificate
|
||||
if cert != nil {
|
||||
@@ -554,7 +573,10 @@ func DeserializeSCTList(serializedSCTList []byte) ([]ct.SignedCertificateTimesta
|
||||
return nil, err
|
||||
}
|
||||
if len(rest) != 0 {
|
||||
return nil, certerr.ParsingError(certerr.ErrorSourceSCTList, errors.New("serialized SCT list contained trailing garbage"))
|
||||
return nil, certerr.ParsingError(
|
||||
certerr.ErrorSourceSCTList,
|
||||
errors.New("serialized SCT list contained trailing garbage"),
|
||||
)
|
||||
}
|
||||
|
||||
list := make([]ct.SignedCertificateTimestamp, len(sctList.SCTList))
|
||||
@@ -565,7 +587,10 @@ func DeserializeSCTList(serializedSCTList []byte) ([]ct.SignedCertificateTimesta
|
||||
return nil, err
|
||||
}
|
||||
if len(rest) != 0 {
|
||||
return nil, certerr.ParsingError(certerr.ErrorSourceSCTList, errors.New("serialized SCT list contained trailing garbage"))
|
||||
return nil, certerr.ParsingError(
|
||||
certerr.ErrorSourceSCTList,
|
||||
errors.New("serialized SCT list contained trailing garbage"),
|
||||
)
|
||||
}
|
||||
list[i] = sct
|
||||
}
|
||||
@@ -611,20 +636,16 @@ func SCTListFromOCSPResponse(response *ocsp.Response) ([]ct.SignedCertificateTim
|
||||
// the subsequent file. If no prefix is provided, valFile is assumed to be a
|
||||
// file path.
|
||||
func ReadBytes(valFile string) ([]byte, error) {
|
||||
switch splitVal := strings.SplitN(valFile, ":", 2); len(splitVal) {
|
||||
case 1:
|
||||
prefix, rest, found := strings.Cut(valFile, ":")
|
||||
if !found {
|
||||
return os.ReadFile(valFile)
|
||||
case 2:
|
||||
switch splitVal[0] {
|
||||
case "env":
|
||||
return []byte(os.Getenv(splitVal[1])), nil
|
||||
case "file":
|
||||
return os.ReadFile(splitVal[1])
|
||||
default:
|
||||
return nil, fmt.Errorf("unknown prefix: %s", splitVal[0])
|
||||
}
|
||||
}
|
||||
switch prefix {
|
||||
case "env":
|
||||
return []byte(os.Getenv(rest)), nil
|
||||
case "file":
|
||||
return os.ReadFile(rest)
|
||||
default:
|
||||
return nil, fmt.Errorf("multiple prefixes: %s",
|
||||
strings.Join(splitVal[:len(splitVal)-1], ", "))
|
||||
return nil, fmt.Errorf("unknown prefix: %s", prefix)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -93,7 +93,7 @@ type signedData struct {
|
||||
Version int
|
||||
DigestAlgorithms asn1.RawValue
|
||||
ContentInfo asn1.RawValue
|
||||
Certificates asn1.RawValue `asn1:"optional" asn1:"tag:0"`
|
||||
Certificates asn1.RawValue `asn1:"optional"`
|
||||
Crls asn1.RawValue `asn1:"optional"`
|
||||
SignerInfos asn1.RawValue
|
||||
}
|
||||
@@ -158,63 +158,95 @@ type EncryptedContentInfo struct {
|
||||
EncryptedContent []byte `asn1:"tag:0,optional"`
|
||||
}
|
||||
|
||||
func unmarshalInit(raw []byte) (init initPKCS7, err error) {
|
||||
_, err = asn1.Unmarshal(raw, &init)
|
||||
if err != nil {
|
||||
return initPKCS7{}, certerr.ParsingError(certerr.ErrorSourceCertificate, err)
|
||||
}
|
||||
return init, nil
|
||||
}
|
||||
|
||||
func populateData(msg *PKCS7, content asn1.RawValue) error {
|
||||
msg.ContentInfo = "Data"
|
||||
_, err := asn1.Unmarshal(content.Bytes, &msg.Content.Data)
|
||||
if err != nil {
|
||||
return certerr.ParsingError(certerr.ErrorSourceCertificate, err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func populateSignedData(msg *PKCS7, contentBytes []byte) error {
|
||||
msg.ContentInfo = "SignedData"
|
||||
var sd signedData
|
||||
if _, err := asn1.Unmarshal(contentBytes, &sd); err != nil {
|
||||
return certerr.ParsingError(certerr.ErrorSourceCertificate, err)
|
||||
}
|
||||
if len(sd.Certificates.Bytes) != 0 {
|
||||
certs, err := x509.ParseCertificates(sd.Certificates.Bytes)
|
||||
if err != nil {
|
||||
return certerr.ParsingError(certerr.ErrorSourceCertificate, err)
|
||||
}
|
||||
msg.Content.SignedData.Certificates = certs
|
||||
}
|
||||
if len(sd.Crls.Bytes) != 0 {
|
||||
crl, err := x509.ParseRevocationList(sd.Crls.Bytes)
|
||||
if err != nil {
|
||||
return certerr.ParsingError(certerr.ErrorSourceCertificate, err)
|
||||
}
|
||||
msg.Content.SignedData.Crl = crl
|
||||
}
|
||||
msg.Content.SignedData.Version = sd.Version
|
||||
msg.Content.SignedData.Raw = contentBytes
|
||||
return nil
|
||||
}
|
||||
|
||||
func populateEncryptedData(msg *PKCS7, contentBytes []byte) error {
|
||||
msg.ContentInfo = "EncryptedData"
|
||||
var ed EncryptedData
|
||||
if _, err := asn1.Unmarshal(contentBytes, &ed); err != nil {
|
||||
return certerr.ParsingError(certerr.ErrorSourceCertificate, err)
|
||||
}
|
||||
if ed.Version != 0 {
|
||||
return certerr.ParsingError(
|
||||
certerr.ErrorSourceCertificate,
|
||||
errors.New("only PKCS #7 encryptedData version 0 is supported"),
|
||||
)
|
||||
}
|
||||
msg.Content.EncryptedData = ed
|
||||
return nil
|
||||
}
|
||||
|
||||
// ParsePKCS7 attempts to parse the DER encoded bytes of a
|
||||
// PKCS7 structure.
|
||||
func ParsePKCS7(raw []byte) (msg *PKCS7, err error) {
|
||||
|
||||
var pkcs7 initPKCS7
|
||||
_, err = asn1.Unmarshal(raw, &pkcs7)
|
||||
pkcs7, err := unmarshalInit(raw)
|
||||
if err != nil {
|
||||
return nil, certerr.ParsingError(certerr.ErrorSourceCertificate, err)
|
||||
return nil, err
|
||||
}
|
||||
|
||||
msg = new(PKCS7)
|
||||
msg.Raw = pkcs7.Raw
|
||||
msg.ContentInfo = pkcs7.ContentType.String()
|
||||
switch {
|
||||
case msg.ContentInfo == ObjIDData:
|
||||
msg.ContentInfo = "Data"
|
||||
_, err = asn1.Unmarshal(pkcs7.Content.Bytes, &msg.Content.Data)
|
||||
if err != nil {
|
||||
return nil, certerr.ParsingError(certerr.ErrorSourceCertificate, err)
|
||||
}
|
||||
case msg.ContentInfo == ObjIDSignedData:
|
||||
msg.ContentInfo = "SignedData"
|
||||
var signedData signedData
|
||||
_, err = asn1.Unmarshal(pkcs7.Content.Bytes, &signedData)
|
||||
if err != nil {
|
||||
return nil, certerr.ParsingError(certerr.ErrorSourceCertificate, err)
|
||||
}
|
||||
if len(signedData.Certificates.Bytes) != 0 {
|
||||
msg.Content.SignedData.Certificates, err = x509.ParseCertificates(signedData.Certificates.Bytes)
|
||||
if err != nil {
|
||||
return nil, certerr.ParsingError(certerr.ErrorSourceCertificate, err)
|
||||
}
|
||||
}
|
||||
if len(signedData.Crls.Bytes) != 0 {
|
||||
msg.Content.SignedData.Crl, err = x509.ParseRevocationList(signedData.Crls.Bytes)
|
||||
if err != nil {
|
||||
return nil, certerr.ParsingError(certerr.ErrorSourceCertificate, err)
|
||||
}
|
||||
}
|
||||
msg.Content.SignedData.Version = signedData.Version
|
||||
msg.Content.SignedData.Raw = pkcs7.Content.Bytes
|
||||
case msg.ContentInfo == ObjIDEncryptedData:
|
||||
msg.ContentInfo = "EncryptedData"
|
||||
var encryptedData EncryptedData
|
||||
_, err = asn1.Unmarshal(pkcs7.Content.Bytes, &encryptedData)
|
||||
if err != nil {
|
||||
return nil, certerr.ParsingError(certerr.ErrorSourceCertificate, err)
|
||||
}
|
||||
if encryptedData.Version != 0 {
|
||||
return nil, certerr.ParsingError(certerr.ErrorSourceCertificate, errors.New("only PKCS #7 encryptedData version 0 is supported"))
|
||||
}
|
||||
msg.Content.EncryptedData = encryptedData
|
||||
|
||||
switch msg.ContentInfo {
|
||||
case ObjIDData:
|
||||
if err := populateData(msg, pkcs7.Content); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
case ObjIDSignedData:
|
||||
if err := populateSignedData(msg, pkcs7.Content.Bytes); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
case ObjIDEncryptedData:
|
||||
if err := populateEncryptedData(msg, pkcs7.Content.Bytes); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
default:
|
||||
return nil, certerr.ParsingError(certerr.ErrorSourceCertificate, errors.New("only PKCS# 7 content of type data, signed data or encrypted data can be parsed"))
|
||||
return nil, certerr.ParsingError(
|
||||
certerr.ErrorSourceCertificate,
|
||||
errors.New("only PKCS# 7 content of type data, signed data or encrypted data can be parsed"),
|
||||
)
|
||||
}
|
||||
|
||||
return msg, nil
|
||||
|
||||
}
|
||||
|
||||
@@ -89,7 +89,7 @@ func ldapURL(url string) bool {
|
||||
// - false, false: an error was encountered while checking revocations.
|
||||
// - false, true: the certificate was checked successfully, and it is not revoked.
|
||||
// - true, true: the certificate was checked successfully, and it is revoked.
|
||||
// - true, false: failure to check revocation status causes verification to fail
|
||||
// - true, false: failure to check revocation status causes verification to fail.
|
||||
func revCheck(cert *x509.Certificate) (revoked, ok bool, err error) {
|
||||
for _, url := range cert.CRLDistributionPoints {
|
||||
if ldapURL(url) {
|
||||
@@ -154,7 +154,6 @@ func getIssuer(cert *x509.Certificate) *x509.Certificate {
|
||||
}
|
||||
|
||||
return issuer
|
||||
|
||||
}
|
||||
|
||||
// check a cert against a specific CRL. Returns the same bool pair
|
||||
@@ -222,11 +221,11 @@ func VerifyCertificateError(cert *x509.Certificate) (revoked, ok bool, err error
|
||||
if !time.Now().Before(cert.NotAfter) {
|
||||
msg := fmt.Sprintf("Certificate expired %s\n", cert.NotAfter)
|
||||
log.Info(msg)
|
||||
return true, true, fmt.Errorf(msg)
|
||||
return true, true, errors.New(msg)
|
||||
} else if !time.Now().After(cert.NotBefore) {
|
||||
msg := fmt.Sprintf("Certificate isn't valid until %s\n", cert.NotBefore)
|
||||
log.Info(msg)
|
||||
return true, true, fmt.Errorf(msg)
|
||||
return true, true, errors.New(msg)
|
||||
}
|
||||
return revCheck(cert)
|
||||
}
|
||||
@@ -343,21 +342,21 @@ func sendOCSPRequest(server string, req []byte, leaf, issuer *x509.Certificate)
|
||||
|
||||
var crlRead = io.ReadAll
|
||||
|
||||
// SetCRLFetcher sets the function to use to read from the http response body
|
||||
// SetCRLFetcher sets the function to use to read from the http response body.
|
||||
func SetCRLFetcher(fn func(io.Reader) ([]byte, error)) {
|
||||
crlRead = fn
|
||||
}
|
||||
|
||||
var remoteRead = io.ReadAll
|
||||
|
||||
// SetRemoteFetcher sets the function to use to read from the http response body
|
||||
// SetRemoteFetcher sets the function to use to read from the http response body.
|
||||
func SetRemoteFetcher(fn func(io.Reader) ([]byte, error)) {
|
||||
remoteRead = fn
|
||||
}
|
||||
|
||||
var ocspRead = io.ReadAll
|
||||
|
||||
// SetOCSPFetcher sets the function to use to read from the http response body
|
||||
// SetOCSPFetcher sets the function to use to read from the http response body.
|
||||
func SetOCSPFetcher(fn func(io.Reader) ([]byte, error)) {
|
||||
ocspRead = fn
|
||||
}
|
||||
|
||||
@@ -50,7 +50,7 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
// to indicate that this is the case.
|
||||
|
||||
// 2014/05/22 14:18:17 Certificate expired 2014-04-04 14:14:20 +0000 UTC
|
||||
// 2014/05/22 14:18:17 Revoked certificate: misc/intermediate_ca/ActalisServerAuthenticationCA.crt
|
||||
// 2014/05/22 14:18:17 Revoked certificate: misc/intermediate_ca/ActalisServerAuthenticationCA.crt.
|
||||
var expiredCert = mustParse(`-----BEGIN CERTIFICATE-----
|
||||
MIIEXTCCA8agAwIBAgIEBycURTANBgkqhkiG9w0BAQUFADB1MQswCQYDVQQGEwJV
|
||||
UzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMScwJQYDVQQLEx5HVEUgQ3liZXJU
|
||||
@@ -80,7 +80,7 @@ sESPRwHkcMUNdAp37FLweUw=
|
||||
|
||||
// 2014/05/22 14:18:31 Serial number match: intermediate is revoked.
|
||||
// 2014/05/22 14:18:31 certificate is revoked via CRL
|
||||
// 2014/05/22 14:18:31 Revoked certificate: misc/intermediate_ca/MobileArmorEnterpriseCA.crt
|
||||
// 2014/05/22 14:18:31 Revoked certificate: misc/intermediate_ca/MobileArmorEnterpriseCA.crt.
|
||||
var revokedCert = mustParse(`-----BEGIN CERTIFICATE-----
|
||||
MIIEEzCCAvugAwIBAgILBAAAAAABGMGjftYwDQYJKoZIhvcNAQEFBQAwcTEoMCYG
|
||||
A1UEAxMfR2xvYmFsU2lnbiBSb290U2lnbiBQYXJ0bmVycyBDQTEdMBsGA1UECxMU
|
||||
@@ -106,7 +106,7 @@ Kz5vh+5tmytUPKA8hUgmLWe94lMb7Uqq2wgZKsqun5DAWleKu81w7wEcOrjiiB+x
|
||||
jeBHq7OnpWm+ccTOPCE6H4ZN4wWVS7biEBUdop/8HgXBPQHWAdjL
|
||||
-----END CERTIFICATE-----`)
|
||||
|
||||
// A Comodo intermediate CA certificate with issuer url, CRL url and OCSP url
|
||||
// A Comodo intermediate CA certificate with issuer url, CRL url and OCSP url.
|
||||
var goodComodoCA = (`-----BEGIN CERTIFICATE-----
|
||||
MIIGCDCCA/CgAwIBAgIQKy5u6tl1NmwUim7bo3yMBzANBgkqhkiG9w0BAQwFADCB
|
||||
hTELMAkGA1UEBhMCR0IxGzAZBgNVBAgTEkdyZWF0ZXIgTWFuY2hlc3RlcjEQMA4G
|
||||
@@ -182,7 +182,6 @@ func TestGood(t *testing.T) {
|
||||
} else if revoked {
|
||||
t.Fatalf("good certificate should not have been marked as revoked")
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
func TestLdap(t *testing.T) {
|
||||
@@ -230,7 +229,6 @@ func TestBadCRLSet(t *testing.T) {
|
||||
t.Fatalf("key emptystring should be deleted from CRLSet")
|
||||
}
|
||||
delete(CRLSet, "")
|
||||
|
||||
}
|
||||
|
||||
func TestCachedCRLSet(t *testing.T) {
|
||||
@@ -241,13 +239,11 @@ func TestCachedCRLSet(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestRemoteFetchError(t *testing.T) {
|
||||
|
||||
badurl := ":"
|
||||
|
||||
if _, err := fetchRemote(badurl); err == nil {
|
||||
t.Fatalf("fetching bad url should result in non-nil error")
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
func TestNoOCSPServers(t *testing.T) {
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
This project is an exploration into the utility of Jetbrains' Junie
|
||||
to write smaller but tedious programs.
|
||||
|
||||
Task: build a certificate bundling tool in cmd/cert-bundler. It
|
||||
creates archives of certificates chains.
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@ import (
|
||||
"crypto/tls"
|
||||
"crypto/x509"
|
||||
"flag"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io/ioutil"
|
||||
"net"
|
||||
@@ -109,7 +110,7 @@ func checkSite(hostport string) (string, error) {
|
||||
|
||||
state := conn.ConnectionState()
|
||||
if len(state.PeerCertificates) == 0 {
|
||||
return "UNKNOWN", fmt.Errorf("no peer certificates presented")
|
||||
return "UNKNOWN", errors.New("no peer certificates presented")
|
||||
}
|
||||
return evaluateCert(state.PeerCertificates[0])
|
||||
}
|
||||
|
||||
@@ -1,74 +1,68 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"compress/flate"
|
||||
"compress/gzip"
|
||||
"flag"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
|
||||
"github.com/pkg/errors"
|
||||
"compress/flate"
|
||||
"compress/gzip"
|
||||
"flag"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
)
|
||||
|
||||
const gzipExt = ".gz"
|
||||
|
||||
func compress(path, target string, level int) error {
|
||||
sourceFile, err := os.Open(path)
|
||||
if err != nil {
|
||||
return errors.Wrap(err, "opening file for read")
|
||||
}
|
||||
sourceFile, err := os.Open(path)
|
||||
if err != nil {
|
||||
return fmt.Errorf("opening file for read: %w", err)
|
||||
}
|
||||
defer sourceFile.Close()
|
||||
|
||||
destFile, err := os.Create(target)
|
||||
if err != nil {
|
||||
return errors.Wrap(err, "opening file for write")
|
||||
}
|
||||
destFile, err := os.Create(target)
|
||||
if err != nil {
|
||||
return fmt.Errorf("opening file for write: %w", err)
|
||||
}
|
||||
defer destFile.Close()
|
||||
|
||||
gzipCompressor, err := gzip.NewWriterLevel(destFile, level)
|
||||
if err != nil {
|
||||
return errors.Wrap(err, "invalid compression level")
|
||||
}
|
||||
gzipCompressor, err := gzip.NewWriterLevel(destFile, level)
|
||||
if err != nil {
|
||||
return fmt.Errorf("invalid compression level: %w", err)
|
||||
}
|
||||
defer gzipCompressor.Close()
|
||||
|
||||
_, err = io.Copy(gzipCompressor, sourceFile)
|
||||
if err != nil {
|
||||
return errors.Wrap(err, "compressing file")
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
return errors.Wrap(err, "stat(2)ing destination file")
|
||||
}
|
||||
_, err = io.Copy(gzipCompressor, sourceFile)
|
||||
if err != nil {
|
||||
return fmt.Errorf("compressing file: %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func uncompress(path, target string) error {
|
||||
sourceFile, err := os.Open(path)
|
||||
if err != nil {
|
||||
return errors.Wrap(err, "opening file for read")
|
||||
}
|
||||
sourceFile, err := os.Open(path)
|
||||
if err != nil {
|
||||
return fmt.Errorf("opening file for read: %w", err)
|
||||
}
|
||||
defer sourceFile.Close()
|
||||
|
||||
gzipUncompressor, err := gzip.NewReader(sourceFile)
|
||||
if err != nil {
|
||||
return errors.Wrap(err, "reading gzip headers")
|
||||
}
|
||||
gzipUncompressor, err := gzip.NewReader(sourceFile)
|
||||
if err != nil {
|
||||
return fmt.Errorf("reading gzip headers: %w", err)
|
||||
}
|
||||
defer gzipUncompressor.Close()
|
||||
|
||||
destFile, err := os.Create(target)
|
||||
if err != nil {
|
||||
return errors.Wrap(err, "opening file for write")
|
||||
}
|
||||
destFile, err := os.Create(target)
|
||||
if err != nil {
|
||||
return fmt.Errorf("opening file for write: %w", err)
|
||||
}
|
||||
defer destFile.Close()
|
||||
|
||||
_, err = io.Copy(destFile, gzipUncompressor)
|
||||
if err != nil {
|
||||
return errors.Wrap(err, "uncompressing file")
|
||||
}
|
||||
_, err = io.Copy(destFile, gzipUncompressor)
|
||||
if err != nil {
|
||||
return fmt.Errorf("uncompressing file: %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
@@ -112,9 +106,9 @@ func pathForUncompressing(source, dest string) (string, error) {
|
||||
}
|
||||
|
||||
source = filepath.Base(source)
|
||||
if !strings.HasSuffix(source, gzipExt) {
|
||||
return "", errors.Errorf("%s is a not gzip-compressed file", source)
|
||||
}
|
||||
if !strings.HasSuffix(source, gzipExt) {
|
||||
return "", fmt.Errorf("%s is a not gzip-compressed file", source)
|
||||
}
|
||||
outFile := source[:len(source)-len(gzipExt)]
|
||||
outFile = filepath.Join(dest, outFile)
|
||||
return outFile, nil
|
||||
@@ -126,9 +120,9 @@ func pathForCompressing(source, dest string) (string, error) {
|
||||
}
|
||||
|
||||
source = filepath.Base(source)
|
||||
if strings.HasSuffix(source, gzipExt) {
|
||||
return "", errors.Errorf("%s is a gzip-compressed file", source)
|
||||
}
|
||||
if strings.HasSuffix(source, gzipExt) {
|
||||
return "", fmt.Errorf("%s is a gzip-compressed file", source)
|
||||
}
|
||||
|
||||
dest = filepath.Join(dest, source+gzipExt)
|
||||
return dest, nil
|
||||
|
||||
@@ -11,7 +11,7 @@ package config
|
||||
import (
|
||||
"bufio"
|
||||
"fmt"
|
||||
"log"
|
||||
"maps"
|
||||
"os"
|
||||
"sort"
|
||||
"strings"
|
||||
@@ -33,14 +33,15 @@ func SetEnvPrefix(pfx string) {
|
||||
prefix = pfx
|
||||
}
|
||||
|
||||
const keyValueSplitLength = 2
|
||||
|
||||
func addLine(line string) {
|
||||
if strings.HasPrefix(line, "#") || line == "" {
|
||||
return
|
||||
}
|
||||
|
||||
lineParts := strings.SplitN(line, "=", 2)
|
||||
if len(lineParts) != 2 {
|
||||
log.Print("skipping line: ", line)
|
||||
lineParts := strings.SplitN(line, "=", keyValueSplitLength)
|
||||
if len(lineParts) != keyValueSplitLength {
|
||||
return // silently ignore empty keys
|
||||
}
|
||||
|
||||
@@ -49,7 +50,7 @@ func addLine(line string) {
|
||||
vars[lineParts[0]] = lineParts[1]
|
||||
}
|
||||
|
||||
// LoadFile scans the file at path for key=value pairs and adds them
|
||||
// LoadFile scans the file at 'path' for key=value pairs and adds them
|
||||
// to the configuration.
|
||||
func LoadFile(path string) error {
|
||||
file, err := os.Open(path)
|
||||
@@ -67,18 +68,16 @@ func LoadFile(path string) error {
|
||||
return scanner.Err()
|
||||
}
|
||||
|
||||
// LoadFileFor scans the ini file at path, loading the default section
|
||||
// and overriding any keys found under section. If strict is true, the
|
||||
// named section must exist (i.e. to catch typos in the section name).
|
||||
// LoadFileFor scans the ini file at 'path', loading the default section
|
||||
// and overriding any keys found under 'section'. If strict is true, the
|
||||
// named section must exist (i.e., to catch typos in the section name).
|
||||
func LoadFileFor(path, section string, strict bool) error {
|
||||
cmap, err := iniconf.ParseFile(path)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
for key, value := range cmap[iniconf.DefaultSection] {
|
||||
vars[key] = value
|
||||
}
|
||||
maps.Copy(vars, cmap[iniconf.DefaultSection])
|
||||
|
||||
smap, ok := cmap[section]
|
||||
if !ok {
|
||||
@@ -88,9 +87,7 @@ func LoadFileFor(path, section string, strict bool) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
for key, value := range smap {
|
||||
vars[key] = value
|
||||
}
|
||||
maps.Copy(vars, smap)
|
||||
|
||||
return nil
|
||||
}
|
||||
@@ -107,7 +104,7 @@ func Get(key string) string {
|
||||
|
||||
// GetDefault retrieves a value from either a configuration file or
|
||||
// the environment. Note that value from a file will override
|
||||
// environment variables. If a value isn't found (e.g. Get returns an
|
||||
// environment variables. If a value isn't found (e.g., Get returns an
|
||||
// empty string), the default value will be used.
|
||||
func GetDefault(key, def string) string {
|
||||
if v := Get(key); v != "" {
|
||||
@@ -117,8 +114,7 @@ func GetDefault(key, def string) string {
|
||||
}
|
||||
|
||||
// Require retrieves a value from either a configuration file or the
|
||||
// environment. If the key isn't present, it will call log.Fatal, printing
|
||||
// the missing key.
|
||||
// environment. If the key isn't present, it will panic.
|
||||
func Require(key string) string {
|
||||
if v, ok := vars[key]; ok {
|
||||
return v
|
||||
@@ -131,7 +127,7 @@ func Require(key string) string {
|
||||
envMessage = " (note: looked for the key " + prefix + key
|
||||
envMessage += " in the local env)"
|
||||
}
|
||||
log.Fatalf("missing required configuration value %s%s", key, envMessage)
|
||||
panic(fmt.Sprintf("missing required configuration value %s%s", key, envMessage))
|
||||
}
|
||||
|
||||
return v
|
||||
@@ -139,7 +135,8 @@ func Require(key string) string {
|
||||
|
||||
// ListKeys returns a slice of the currently known keys.
|
||||
func ListKeys() []string {
|
||||
keyList := []string{}
|
||||
var keyList []string
|
||||
|
||||
for k := range vars {
|
||||
keyList = append(keyList, k)
|
||||
}
|
||||
|
||||
@@ -1,27 +1,26 @@
|
||||
package config
|
||||
package config_test
|
||||
|
||||
import (
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"git.wntrmute.dev/kyle/goutils/config"
|
||||
)
|
||||
|
||||
const (
|
||||
testFilePath = "testdata/test.env"
|
||||
|
||||
// Keys
|
||||
// Key constants.
|
||||
kOrder = "ORDER"
|
||||
kSpecies = "SPECIES"
|
||||
kName = "COMMON_NAME"
|
||||
|
||||
// Env
|
||||
eOrder = "corvus"
|
||||
eSpecies = "corvus corax"
|
||||
eName = "northern raven"
|
||||
|
||||
// File
|
||||
fOrder = "stringiformes"
|
||||
fSpecies = "strix aluco"
|
||||
// Name isn't set in the file to test fall through.
|
||||
)
|
||||
|
||||
func init() {
|
||||
@@ -31,8 +30,8 @@ func init() {
|
||||
}
|
||||
|
||||
func TestLoadEnvOnly(t *testing.T) {
|
||||
order := Get(kOrder)
|
||||
species := Get(kSpecies)
|
||||
order := config.Get(kOrder)
|
||||
species := config.Get(kSpecies)
|
||||
if order != eOrder {
|
||||
t.Errorf("want %s, have %s", eOrder, order)
|
||||
}
|
||||
@@ -43,14 +42,14 @@ func TestLoadEnvOnly(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestLoadFile(t *testing.T) {
|
||||
err := LoadFile(testFilePath)
|
||||
err := config.LoadFile(testFilePath)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
order := Get(kOrder)
|
||||
species := Get(kSpecies)
|
||||
name := Get(kName)
|
||||
order := config.Get(kOrder)
|
||||
species := config.Get(kSpecies)
|
||||
name := config.Get(kName)
|
||||
|
||||
if order != fOrder {
|
||||
t.Errorf("want %s, have %s", fOrder, order)
|
||||
|
||||
@@ -2,6 +2,7 @@ package iniconf
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
@@ -23,30 +24,31 @@ var (
|
||||
var DefaultSection = "default"
|
||||
|
||||
// ParseFile attempts to load the named config file.
|
||||
func ParseFile(fileName string) (cfg ConfigMap, err error) {
|
||||
var file *os.File
|
||||
file, err = os.Open(fileName)
|
||||
func ParseFile(fileName string) (ConfigMap, error) {
|
||||
file, err := os.Open(fileName)
|
||||
if err != nil {
|
||||
return
|
||||
return nil, err
|
||||
}
|
||||
defer file.Close()
|
||||
|
||||
return ParseReader(file)
|
||||
}
|
||||
|
||||
// ParseReader reads a configuration from an io.Reader.
|
||||
func ParseReader(r io.Reader) (cfg ConfigMap, err error) {
|
||||
cfg = ConfigMap{}
|
||||
func ParseReader(r io.Reader) (ConfigMap, error) {
|
||||
cfg := ConfigMap{}
|
||||
buf := bufio.NewReader(r)
|
||||
|
||||
var (
|
||||
line string
|
||||
longLine bool
|
||||
currentSection string
|
||||
err error
|
||||
)
|
||||
|
||||
for {
|
||||
line, longLine, err = readConfigLine(buf, line, longLine)
|
||||
if err == io.EOF {
|
||||
if errors.Is(err, io.EOF) {
|
||||
err = nil
|
||||
break
|
||||
} else if err != nil {
|
||||
@@ -62,11 +64,12 @@ func ParseReader(r io.Reader) (cfg ConfigMap, err error) {
|
||||
break
|
||||
}
|
||||
}
|
||||
return
|
||||
|
||||
return cfg, err
|
||||
}
|
||||
|
||||
// readConfigLine reads and assembles a complete configuration line, handling long lines.
|
||||
func readConfigLine(buf *bufio.Reader, currentLine string, longLine bool) (line string, stillLong bool, err error) {
|
||||
func readConfigLine(buf *bufio.Reader, currentLine string, longLine bool) (string, bool, error) {
|
||||
lineBytes, isPrefix, err := buf.ReadLine()
|
||||
if err != nil {
|
||||
return "", false, err
|
||||
@@ -94,14 +97,14 @@ func processConfigLine(cfg ConfigMap, line string, currentSection string) (strin
|
||||
return handleConfigLine(cfg, line, currentSection)
|
||||
}
|
||||
|
||||
return currentSection, fmt.Errorf("invalid config file")
|
||||
return currentSection, errors.New("invalid config file")
|
||||
}
|
||||
|
||||
// handleSectionLine processes a section header line.
|
||||
func handleSectionLine(cfg ConfigMap, line string) (string, error) {
|
||||
section := configSection.ReplaceAllString(line, "$1")
|
||||
if section == "" {
|
||||
return "", fmt.Errorf("invalid structure in file")
|
||||
return "", errors.New("invalid structure in file")
|
||||
}
|
||||
if !cfg.SectionInConfig(section) {
|
||||
cfg[section] = make(map[string]string, 0)
|
||||
@@ -139,41 +142,39 @@ func (c ConfigMap) SectionInConfig(section string) bool {
|
||||
}
|
||||
|
||||
// ListSections returns the list of sections in the config map.
|
||||
func (c ConfigMap) ListSections() (sections []string) {
|
||||
func (c ConfigMap) ListSections() []string {
|
||||
sections := make([]string, 0, len(c))
|
||||
for section := range c {
|
||||
sections = append(sections, section)
|
||||
}
|
||||
return
|
||||
return sections
|
||||
}
|
||||
|
||||
// WriteFile writes out the configuration to a file.
|
||||
func (c ConfigMap) WriteFile(filename string) (err error) {
|
||||
func (c ConfigMap) WriteFile(filename string) error {
|
||||
file, err := os.Create(filename)
|
||||
if err != nil {
|
||||
return
|
||||
return err
|
||||
}
|
||||
defer file.Close()
|
||||
|
||||
for _, section := range c.ListSections() {
|
||||
sName := fmt.Sprintf("[ %s ]\n", section)
|
||||
_, err = file.Write([]byte(sName))
|
||||
if err != nil {
|
||||
return
|
||||
if _, err = file.WriteString(sName); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
for k, v := range c[section] {
|
||||
line := fmt.Sprintf("%s = %s\n", k, v)
|
||||
_, err = file.Write([]byte(line))
|
||||
if err != nil {
|
||||
return
|
||||
if _, err = file.WriteString(line); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
_, err = file.Write([]byte{0x0a})
|
||||
if err != nil {
|
||||
return
|
||||
if _, err = file.Write([]byte{0x0a}); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
return
|
||||
return nil
|
||||
}
|
||||
|
||||
// AddSection creates a new section in the config map.
|
||||
@@ -197,27 +198,26 @@ func (c ConfigMap) AddKeyVal(section, key, val string) {
|
||||
}
|
||||
|
||||
// GetValue retrieves the value from a key map.
|
||||
func (c ConfigMap) GetValue(section, key string) (val string, present bool) {
|
||||
func (c ConfigMap) GetValue(section, key string) (string, bool) {
|
||||
if c == nil {
|
||||
return
|
||||
return "", false
|
||||
}
|
||||
|
||||
if section == "" {
|
||||
section = DefaultSection
|
||||
}
|
||||
|
||||
_, ok := c[section]
|
||||
if !ok {
|
||||
return
|
||||
if _, ok := c[section]; !ok {
|
||||
return "", false
|
||||
}
|
||||
|
||||
val, present = c[section][key]
|
||||
return
|
||||
val, present := c[section][key]
|
||||
return val, present
|
||||
}
|
||||
|
||||
// GetValueDefault retrieves the value from a key map if present,
|
||||
// otherwise the default value.
|
||||
func (c ConfigMap) GetValueDefault(section, key, value string) (val string) {
|
||||
func (c ConfigMap) GetValueDefault(section, key, value string) string {
|
||||
kval, ok := c.GetValue(section, key)
|
||||
if !ok {
|
||||
return value
|
||||
@@ -226,7 +226,7 @@ func (c ConfigMap) GetValueDefault(section, key, value string) (val string) {
|
||||
}
|
||||
|
||||
// SectionKeys returns the sections in the config map.
|
||||
func (c ConfigMap) SectionKeys(section string) (keys []string, present bool) {
|
||||
func (c ConfigMap) SectionKeys(section string) ([]string, bool) {
|
||||
if c == nil {
|
||||
return nil, false
|
||||
}
|
||||
@@ -235,13 +235,12 @@ func (c ConfigMap) SectionKeys(section string) (keys []string, present bool) {
|
||||
section = DefaultSection
|
||||
}
|
||||
|
||||
cm := c
|
||||
s, ok := cm[section]
|
||||
s, ok := c[section]
|
||||
if !ok {
|
||||
return nil, false
|
||||
}
|
||||
|
||||
keys = make([]string, 0, len(s))
|
||||
keys := make([]string, 0, len(s))
|
||||
for key := range s {
|
||||
keys = append(keys, key)
|
||||
}
|
||||
|
||||
@@ -1,18 +1,19 @@
|
||||
package iniconf
|
||||
package iniconf_test
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"os"
|
||||
"sort"
|
||||
"testing"
|
||||
|
||||
"git.wntrmute.dev/kyle/goutils/config/iniconf"
|
||||
)
|
||||
|
||||
// FailWithError is a utility for dumping errors and failing the test.
|
||||
func FailWithError(t *testing.T, err error) {
|
||||
fmt.Println("failed")
|
||||
t.Log("failed")
|
||||
if err != nil {
|
||||
fmt.Println("[!] ", err.Error())
|
||||
t.Log("[!] ", err.Error())
|
||||
}
|
||||
t.FailNow()
|
||||
}
|
||||
@@ -49,47 +50,50 @@ func stringSlicesEqual(slice1, slice2 []string) bool {
|
||||
|
||||
func TestGoodConfig(t *testing.T) {
|
||||
testFile := "testdata/test.conf"
|
||||
fmt.Printf("[+] validating known-good config... ")
|
||||
cmap, err := ParseFile(testFile)
|
||||
t.Logf("[+] validating known-good config... ")
|
||||
cmap, err := iniconf.ParseFile(testFile)
|
||||
if err != nil {
|
||||
FailWithError(t, err)
|
||||
} else if len(cmap) != 2 {
|
||||
FailWithError(t, err)
|
||||
}
|
||||
fmt.Println("ok")
|
||||
t.Log("ok")
|
||||
}
|
||||
|
||||
func TestGoodConfig2(t *testing.T) {
|
||||
testFile := "testdata/test2.conf"
|
||||
fmt.Printf("[+] validating second known-good config... ")
|
||||
cmap, err := ParseFile(testFile)
|
||||
if err != nil {
|
||||
t.Logf("[+] validating second known-good config... ")
|
||||
cmap, err := iniconf.ParseFile(testFile)
|
||||
switch {
|
||||
case err != nil:
|
||||
FailWithError(t, err)
|
||||
} else if len(cmap) != 1 {
|
||||
case len(cmap) != 1:
|
||||
FailWithError(t, err)
|
||||
} else if len(cmap["default"]) != 3 {
|
||||
case len(cmap["default"]) != 3:
|
||||
FailWithError(t, err)
|
||||
default:
|
||||
// nothing to do here
|
||||
}
|
||||
fmt.Println("ok")
|
||||
t.Log("ok")
|
||||
}
|
||||
|
||||
func TestBadConfig(t *testing.T) {
|
||||
testFile := "testdata/bad.conf"
|
||||
fmt.Printf("[+] ensure invalid config file fails... ")
|
||||
_, err := ParseFile(testFile)
|
||||
t.Logf("[+] ensure invalid config file fails... ")
|
||||
_, err := iniconf.ParseFile(testFile)
|
||||
if err == nil {
|
||||
err = fmt.Errorf("invalid config file should fail")
|
||||
err = errors.New("invalid config file should fail")
|
||||
FailWithError(t, err)
|
||||
}
|
||||
fmt.Println("ok")
|
||||
t.Log("ok")
|
||||
}
|
||||
|
||||
func TestWriteConfigFile(t *testing.T) {
|
||||
fmt.Printf("[+] ensure config file is written properly... ")
|
||||
t.Logf("[+] ensure config file is written properly... ")
|
||||
const testFile = "testdata/test.conf"
|
||||
const testOut = "testdata/test.out"
|
||||
|
||||
cmap, err := ParseFile(testFile)
|
||||
cmap, err := iniconf.ParseFile(testFile)
|
||||
if err != nil {
|
||||
FailWithError(t, err)
|
||||
}
|
||||
@@ -100,7 +104,7 @@ func TestWriteConfigFile(t *testing.T) {
|
||||
FailWithError(t, err)
|
||||
}
|
||||
|
||||
cmap2, err := ParseFile(testOut)
|
||||
cmap2, err := iniconf.ParseFile(testOut)
|
||||
if err != nil {
|
||||
FailWithError(t, err)
|
||||
}
|
||||
@@ -110,25 +114,25 @@ func TestWriteConfigFile(t *testing.T) {
|
||||
sort.Strings(sectionList1)
|
||||
sort.Strings(sectionList2)
|
||||
if !stringSlicesEqual(sectionList1, sectionList2) {
|
||||
err = fmt.Errorf("section lists don't match")
|
||||
err = errors.New("section lists don't match")
|
||||
FailWithError(t, err)
|
||||
}
|
||||
|
||||
for _, section := range sectionList1 {
|
||||
for _, k := range cmap[section] {
|
||||
if cmap[section][k] != cmap2[section][k] {
|
||||
err = fmt.Errorf("config key doesn't match")
|
||||
err = errors.New("config key doesn't match")
|
||||
FailWithError(t, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
fmt.Println("ok")
|
||||
t.Log("ok")
|
||||
}
|
||||
|
||||
func TestQuotedValue(t *testing.T) {
|
||||
testFile := "testdata/test.conf"
|
||||
fmt.Printf("[+] validating quoted value... ")
|
||||
cmap, _ := ParseFile(testFile)
|
||||
t.Logf("[+] validating quoted value... ")
|
||||
cmap, _ := iniconf.ParseFile(testFile)
|
||||
val := cmap["sectionName"]["key4"]
|
||||
if val != " space at beginning and end " {
|
||||
FailWithError(t, errors.New("Wrong value in double quotes ["+val+"]"))
|
||||
@@ -138,5 +142,5 @@ func TestQuotedValue(t *testing.T) {
|
||||
if val != " is quoted with single quotes " {
|
||||
FailWithError(t, errors.New("Wrong value in single quotes ["+val+"]"))
|
||||
}
|
||||
fmt.Println("ok")
|
||||
t.Log("ok")
|
||||
}
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
//go:build !linux
|
||||
// +build !linux
|
||||
|
||||
package config
|
||||
|
||||
|
||||
@@ -1,7 +1,11 @@
|
||||
package config
|
||||
package config_test
|
||||
|
||||
import "testing"
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"git.wntrmute.dev/kyle/goutils/config"
|
||||
)
|
||||
|
||||
func TestDefaultPath(t *testing.T) {
|
||||
t.Log(DefaultConfigPath("demoapp", "app.conf"))
|
||||
t.Log(config.DefaultConfigPath("demoapp", "app.conf"))
|
||||
}
|
||||
|
||||
@@ -47,7 +47,7 @@ func ToFile(path string) (*DebugPrinter, error) {
|
||||
}, nil
|
||||
}
|
||||
|
||||
// To sets up a new DebugPrint to an io.WriteCloser.
|
||||
// To will set up a new DebugPrint to an io.WriteCloser.
|
||||
func To(w io.WriteCloser) *DebugPrinter {
|
||||
return &DebugPrinter{
|
||||
out: w,
|
||||
@@ -55,21 +55,21 @@ func To(w io.WriteCloser) *DebugPrinter {
|
||||
}
|
||||
|
||||
// Print calls fmt.Print if Enabled is true.
|
||||
func (dbg *DebugPrinter) Print(v ...interface{}) {
|
||||
func (dbg *DebugPrinter) Print(v ...any) {
|
||||
if dbg.Enabled {
|
||||
fmt.Fprint(dbg.out, v...)
|
||||
}
|
||||
}
|
||||
|
||||
// Println calls fmt.Println if Enabled is true.
|
||||
func (dbg *DebugPrinter) Println(v ...interface{}) {
|
||||
func (dbg *DebugPrinter) Println(v ...any) {
|
||||
if dbg.Enabled {
|
||||
fmt.Fprintln(dbg.out, v...)
|
||||
}
|
||||
}
|
||||
|
||||
// Printf calls fmt.Printf if Enabled is true.
|
||||
func (dbg *DebugPrinter) Printf(format string, v ...interface{}) {
|
||||
func (dbg *DebugPrinter) Printf(format string, v ...any) {
|
||||
if dbg.Enabled {
|
||||
fmt.Fprintf(dbg.out, format, v...)
|
||||
}
|
||||
|
||||
@@ -2,7 +2,6 @@ package dbg
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"io/ioutil"
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
@@ -50,7 +49,7 @@ func TestTo(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestToFile(t *testing.T) {
|
||||
testFile, err := ioutil.TempFile("", "dbg")
|
||||
testFile, err := os.CreateTemp(t.TempDir(), "dbg")
|
||||
assert.NoErrorT(t, err)
|
||||
err = testFile.Close()
|
||||
assert.NoErrorT(t, err)
|
||||
@@ -103,7 +102,7 @@ func TestWriting(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestToFileError(t *testing.T) {
|
||||
testFile, err := ioutil.TempFile("", "dbg")
|
||||
testFile, err := os.CreateTemp(t.TempDir(), "dbg")
|
||||
assert.NoErrorT(t, err)
|
||||
err = testFile.Chmod(0400)
|
||||
assert.NoErrorT(t, err)
|
||||
|
||||
@@ -1,12 +0,0 @@
|
||||
Simple fatal utilities for Go programs.
|
||||
|
||||
```
|
||||
result, err := doSomething()
|
||||
die.If(err)
|
||||
|
||||
ok := processResult(result)
|
||||
if !ok {
|
||||
die.With("failed to process result %s", result.Name)
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
// Package die contains utilities for fatal error handling.
|
||||
// Package die contains utilities for fatal error handling. It
|
||||
// presents simple fatal utilities for Go programs.
|
||||
package die
|
||||
|
||||
import (
|
||||
@@ -15,14 +16,14 @@ func If(err error) {
|
||||
}
|
||||
|
||||
// With prints the message to stderr, appending a newline, and exits.
|
||||
func With(fstr string, args ...interface{}) {
|
||||
func With(fstr string, args ...any) {
|
||||
out := fmt.Sprintf("[!] %s\n", fstr)
|
||||
fmt.Fprintf(os.Stderr, out, args...)
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
// When prints the error to stderr and exits if cond is true.
|
||||
func When(cond bool, fstr string, args ...interface{}) {
|
||||
func When(cond bool, fstr string, args ...any) {
|
||||
if cond {
|
||||
With(fstr, args...)
|
||||
}
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
//go:build !windows
|
||||
// +build !windows
|
||||
|
||||
// Package fileutil contains common file functions.
|
||||
package fileutil
|
||||
|
||||
import (
|
||||
"math"
|
||||
"os"
|
||||
|
||||
"golang.org/x/sys/unix"
|
||||
@@ -46,5 +46,9 @@ const (
|
||||
// Access returns a boolean indicating whether the mode being checked
|
||||
// for is valid.
|
||||
func Access(path string, mode int) error {
|
||||
return unix.Access(path, uint32(mode))
|
||||
// Validate the conversion to avoid potential integer overflow (gosec G115).
|
||||
if mode < 0 || uint64(mode) > uint64(math.MaxUint32) {
|
||||
return unix.EINVAL
|
||||
}
|
||||
return unix.Access(path, uint32(mode)) // #nosec G115 - handled above.
|
||||
}
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
//go:build windows
|
||||
// +build windows
|
||||
|
||||
// Package fileutil contains common file functions.
|
||||
package fileutil
|
||||
|
||||
8
go.mod
8
go.mod
@@ -1,14 +1,13 @@
|
||||
module git.wntrmute.dev/kyle/goutils
|
||||
|
||||
go 1.22
|
||||
go 1.24.0
|
||||
|
||||
require (
|
||||
github.com/hashicorp/go-syslog v1.0.0
|
||||
github.com/kr/text v0.2.0
|
||||
github.com/pkg/errors v0.9.1
|
||||
github.com/pkg/sftp v1.12.0
|
||||
golang.org/x/crypto v0.0.0-20220314234659-1baeb1ce4c0b
|
||||
golang.org/x/sys v0.0.0-20220412211240-33da011f77ad
|
||||
golang.org/x/crypto v0.44.0
|
||||
golang.org/x/sys v0.38.0
|
||||
gopkg.in/yaml.v2 v2.4.0
|
||||
)
|
||||
|
||||
@@ -20,5 +19,6 @@ require (
|
||||
require (
|
||||
github.com/kr/fs v0.1.0 // indirect
|
||||
github.com/kr/pretty v0.1.0 // indirect
|
||||
github.com/pkg/errors v0.9.1 // indirect
|
||||
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 // indirect
|
||||
)
|
||||
|
||||
11
go.sum
11
go.sum
@@ -25,14 +25,15 @@ github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd
|
||||
github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
|
||||
golang.org/x/crypto v0.0.0-20200820211705-5c72a883971a/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
|
||||
golang.org/x/crypto v0.0.0-20220314234659-1baeb1ce4c0b h1:Qwe1rC8PSniVfAFPFJeyUkB+zcysC3RgJBAGk7eqBEU=
|
||||
golang.org/x/crypto v0.0.0-20220314234659-1baeb1ce4c0b/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
|
||||
golang.org/x/crypto v0.44.0 h1:A97SsFvM3AIwEEmTBiaxPPTYpDC47w720rdiiUvgoAU=
|
||||
golang.org/x/crypto v0.44.0/go.mod h1:013i+Nw79BMiQiMsOPcVCB5ZIJbYkerPrGnOa00tvmc=
|
||||
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/sys v0.0.0-20220412211240-33da011f77ad h1:ntjMns5wyP/fN65tdBD4g8J5w8n015+iIIs9rtjXkY0=
|
||||
golang.org/x/sys v0.0.0-20220412211240-33da011f77ad/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1 h1:v+OssWQX+hTHEmOBgwxdZxK4zHq3yOs8F9J7mk0PY8E=
|
||||
golang.org/x/sys v0.38.0 h1:3yZWxaJjBmCWXqhN1qh02AkOnCQ1poK6oF+a7xWL6Gc=
|
||||
golang.org/x/sys v0.38.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
|
||||
golang.org/x/term v0.37.0 h1:8EGAD0qCmHYZg6J17DvsMy9/wJ7/D/4pV/wfnld5lTU=
|
||||
golang.org/x/term v0.37.0/go.mod h1:5pB4lxRNYYVZuTLmy8oR2BH8dflOR+IbTYFD8fi3254=
|
||||
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
|
||||
|
||||
@@ -11,7 +11,7 @@ import (
|
||||
var progname = filepath.Base(os.Args[0])
|
||||
|
||||
// ProgName returns what lib thinks the program name is, namely the
|
||||
// basename of of argv0.
|
||||
// basename of argv0.
|
||||
//
|
||||
// It is similar to the Linux __progname function.
|
||||
func ProgName() string {
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// Package syslog is a syslog-type facility for logging.
|
||||
// Package log is a syslog-type facility for logging.
|
||||
package log
|
||||
|
||||
import (
|
||||
@@ -17,7 +17,7 @@ type logger struct {
|
||||
writeConsole bool
|
||||
}
|
||||
|
||||
func (log *logger) printf(p gsyslog.Priority, format string, args ...interface{}) {
|
||||
func (log *logger) printf(p gsyslog.Priority, format string, args ...any) {
|
||||
if !strings.HasSuffix(format, "\n") {
|
||||
format += "\n"
|
||||
}
|
||||
@@ -28,33 +28,33 @@ func (log *logger) printf(p gsyslog.Priority, format string, args ...interface{}
|
||||
}
|
||||
|
||||
if log.l != nil {
|
||||
log.l.WriteLevel(p, []byte(fmt.Sprintf(format, args...)))
|
||||
_ = log.l.WriteLevel(p, fmt.Appendf(nil, format, args...))
|
||||
}
|
||||
}
|
||||
|
||||
func (log *logger) print(p gsyslog.Priority, args ...interface{}) {
|
||||
func (log *logger) print(p gsyslog.Priority, args ...any) {
|
||||
if p <= log.p && log.writeConsole {
|
||||
fmt.Printf("%s [%s] ", prioritiev[p], timestamp())
|
||||
fmt.Print(args...)
|
||||
}
|
||||
|
||||
if log.l != nil {
|
||||
log.l.WriteLevel(p, []byte(fmt.Sprint(args...)))
|
||||
_ = log.l.WriteLevel(p, fmt.Append(nil, args...))
|
||||
}
|
||||
}
|
||||
|
||||
func (log *logger) println(p gsyslog.Priority, args ...interface{}) {
|
||||
func (log *logger) println(p gsyslog.Priority, args ...any) {
|
||||
if p <= log.p && log.writeConsole {
|
||||
fmt.Printf("%s [%s] ", prioritiev[p], timestamp())
|
||||
fmt.Println(args...)
|
||||
}
|
||||
|
||||
if log.l != nil {
|
||||
log.l.WriteLevel(p, []byte(fmt.Sprintln(args...)))
|
||||
_ = log.l.WriteLevel(p, fmt.Appendln(nil, args...))
|
||||
}
|
||||
}
|
||||
|
||||
func (log *logger) spew(args ...interface{}) {
|
||||
func (log *logger) spew(args ...any) {
|
||||
if log.p == gsyslog.LOG_DEBUG {
|
||||
spew.Dump(args...)
|
||||
}
|
||||
@@ -160,109 +160,109 @@ func Setup(opts *Options) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func Debug(args ...interface{}) {
|
||||
func Debug(args ...any) {
|
||||
log.print(gsyslog.LOG_DEBUG, args...)
|
||||
}
|
||||
|
||||
func Info(args ...interface{}) {
|
||||
func Info(args ...any) {
|
||||
log.print(gsyslog.LOG_INFO, args...)
|
||||
}
|
||||
|
||||
func Notice(args ...interface{}) {
|
||||
func Notice(args ...any) {
|
||||
log.print(gsyslog.LOG_NOTICE, args...)
|
||||
}
|
||||
|
||||
func Warning(args ...interface{}) {
|
||||
func Warning(args ...any) {
|
||||
log.print(gsyslog.LOG_WARNING, args...)
|
||||
}
|
||||
|
||||
func Err(args ...interface{}) {
|
||||
func Err(args ...any) {
|
||||
log.print(gsyslog.LOG_ERR, args...)
|
||||
}
|
||||
|
||||
func Crit(args ...interface{}) {
|
||||
func Crit(args ...any) {
|
||||
log.print(gsyslog.LOG_CRIT, args...)
|
||||
}
|
||||
|
||||
func Alert(args ...interface{}) {
|
||||
func Alert(args ...any) {
|
||||
log.print(gsyslog.LOG_ALERT, args...)
|
||||
}
|
||||
|
||||
func Emerg(args ...interface{}) {
|
||||
func Emerg(args ...any) {
|
||||
log.print(gsyslog.LOG_EMERG, args...)
|
||||
}
|
||||
|
||||
func Debugln(args ...interface{}) {
|
||||
func Debugln(args ...any) {
|
||||
log.println(gsyslog.LOG_DEBUG, args...)
|
||||
}
|
||||
|
||||
func Infoln(args ...interface{}) {
|
||||
func Infoln(args ...any) {
|
||||
log.println(gsyslog.LOG_INFO, args...)
|
||||
}
|
||||
|
||||
func Noticeln(args ...interface{}) {
|
||||
func Noticeln(args ...any) {
|
||||
log.println(gsyslog.LOG_NOTICE, args...)
|
||||
}
|
||||
|
||||
func Warningln(args ...interface{}) {
|
||||
func Warningln(args ...any) {
|
||||
log.print(gsyslog.LOG_WARNING, args...)
|
||||
}
|
||||
|
||||
func Errln(args ...interface{}) {
|
||||
func Errln(args ...any) {
|
||||
log.println(gsyslog.LOG_ERR, args...)
|
||||
}
|
||||
|
||||
func Critln(args ...interface{}) {
|
||||
func Critln(args ...any) {
|
||||
log.println(gsyslog.LOG_CRIT, args...)
|
||||
}
|
||||
|
||||
func Alertln(args ...interface{}) {
|
||||
func Alertln(args ...any) {
|
||||
log.println(gsyslog.LOG_ALERT, args...)
|
||||
}
|
||||
|
||||
func Emergln(args ...interface{}) {
|
||||
func Emergln(args ...any) {
|
||||
log.println(gsyslog.LOG_EMERG, args...)
|
||||
}
|
||||
|
||||
func Debugf(format string, args ...interface{}) {
|
||||
func Debugf(format string, args ...any) {
|
||||
log.printf(gsyslog.LOG_DEBUG, format, args...)
|
||||
}
|
||||
|
||||
func Infof(format string, args ...interface{}) {
|
||||
func Infof(format string, args ...any) {
|
||||
log.printf(gsyslog.LOG_INFO, format, args...)
|
||||
}
|
||||
|
||||
func Noticef(format string, args ...interface{}) {
|
||||
func Noticef(format string, args ...any) {
|
||||
log.printf(gsyslog.LOG_NOTICE, format, args...)
|
||||
}
|
||||
|
||||
func Warningf(format string, args ...interface{}) {
|
||||
func Warningf(format string, args ...any) {
|
||||
log.printf(gsyslog.LOG_WARNING, format, args...)
|
||||
}
|
||||
|
||||
func Errf(format string, args ...interface{}) {
|
||||
func Errf(format string, args ...any) {
|
||||
log.printf(gsyslog.LOG_ERR, format, args...)
|
||||
}
|
||||
|
||||
func Critf(format string, args ...interface{}) {
|
||||
func Critf(format string, args ...any) {
|
||||
log.printf(gsyslog.LOG_CRIT, format, args...)
|
||||
}
|
||||
|
||||
func Alertf(format string, args ...interface{}) {
|
||||
func Alertf(format string, args ...any) {
|
||||
log.printf(gsyslog.LOG_ALERT, format, args...)
|
||||
}
|
||||
|
||||
func Emergf(format string, args ...interface{}) {
|
||||
func Emergf(format string, args ...any) {
|
||||
log.printf(gsyslog.LOG_EMERG, format, args...)
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
func Fatal(args ...interface{}) {
|
||||
func Fatal(args ...any) {
|
||||
log.println(gsyslog.LOG_ERR, args...)
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
func Fatalf(format string, args ...interface{}) {
|
||||
func Fatalf(format string, args ...any) {
|
||||
log.printf(gsyslog.LOG_ERR, format, args...)
|
||||
os.Exit(1)
|
||||
}
|
||||
@@ -279,7 +279,7 @@ func FatalError(err error, message string) {
|
||||
}
|
||||
|
||||
// Spew will pretty print the args if the logger is set to DEBUG priority.
|
||||
func Spew(args ...interface{}) {
|
||||
func Spew(args ...any) {
|
||||
log.spew(args...)
|
||||
}
|
||||
|
||||
|
||||
@@ -2,14 +2,13 @@
|
||||
// consist of timestamps, an actor and event string, and a mapping of
|
||||
// string key-value attribute pairs. For example,
|
||||
//
|
||||
// log.Error("serialiser", "failed to open file",
|
||||
// map[string]string{
|
||||
// "error": err.Error(),
|
||||
// "path": "data.bin",
|
||||
// })
|
||||
// log.Error("serialiser", "failed to open file",
|
||||
// map[string]string{
|
||||
// "error": err.Error(),
|
||||
// "path": "data.bin",
|
||||
// })
|
||||
//
|
||||
// This produces the output message
|
||||
//
|
||||
// [2016-04-01T15:04:30-0700] [ERROR] [actor:serialiser event:failed to open file] error=is a directory path=data.bin
|
||||
//
|
||||
// [2016-04-01T15:04:30-0700] [ERROR] [actor:serialiser event:failed to open file] error=is a directory path=data.bin
|
||||
package logging
|
||||
|
||||
@@ -25,8 +25,8 @@ func main() {
|
||||
|
||||
log.Info("example", "filelog test", nil)
|
||||
exampleNewFromFile()
|
||||
os.Remove("example.log")
|
||||
os.Remove("example.err")
|
||||
_ = os.Remove("example.log")
|
||||
_ = os.Remove("example.err")
|
||||
}
|
||||
|
||||
func exampleNewFromFile() {
|
||||
|
||||
@@ -23,7 +23,7 @@ func Example() {
|
||||
map[string]string{"when": time.Now().String()})
|
||||
}
|
||||
|
||||
func ExampleNewFromFile() {
|
||||
func ExampleNewSplitFile() {
|
||||
flog, err := logging.NewSplitFile("example.log", "example.err", true)
|
||||
if err != nil {
|
||||
log.Fatal("filelog", "failed to open logger",
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
package logging
|
||||
|
||||
import "os"
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
)
|
||||
|
||||
// File writes its logs to file.
|
||||
type File struct {
|
||||
@@ -8,22 +11,6 @@ type File struct {
|
||||
*LogWriter
|
||||
}
|
||||
|
||||
// Close calls close on the underlying log files.
|
||||
func (fl *File) Close() error {
|
||||
if fl.fo != nil {
|
||||
if err := fl.fo.Close(); err != nil {
|
||||
return err
|
||||
}
|
||||
fl.fo = nil
|
||||
}
|
||||
|
||||
if fl.fe != nil {
|
||||
return fl.fe.Close()
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// NewFile creates a new Logger that writes all logs to the file
|
||||
// specified by path. If overwrite is specified, the log file will be
|
||||
// truncated before writing. Otherwise, the log file will be appended
|
||||
@@ -36,7 +23,7 @@ func NewFile(path string, overwrite bool) (*File, error) {
|
||||
if overwrite {
|
||||
fl.fo, err = os.Create(path)
|
||||
} else {
|
||||
fl.fo, err = os.OpenFile(path, os.O_WRONLY|os.O_APPEND, 0644)
|
||||
fl.fo, err = os.OpenFile(path, os.O_WRONLY|os.O_APPEND, 0600) // #nosec G302
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
@@ -59,7 +46,7 @@ func NewSplitFile(outpath, errpath string, overwrite bool) (*File, error) {
|
||||
if overwrite {
|
||||
fl.fo, err = os.Create(outpath)
|
||||
} else {
|
||||
fl.fo, err = os.OpenFile(outpath, os.O_WRONLY|os.O_APPEND|os.O_CREATE, 0644)
|
||||
fl.fo, err = os.OpenFile(outpath, os.O_WRONLY|os.O_APPEND|os.O_CREATE, 0600)
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
@@ -69,14 +56,51 @@ func NewSplitFile(outpath, errpath string, overwrite bool) (*File, error) {
|
||||
if overwrite {
|
||||
fl.fe, err = os.Create(errpath)
|
||||
} else {
|
||||
fl.fe, err = os.OpenFile(errpath, os.O_WRONLY|os.O_APPEND|os.O_CREATE, 0644)
|
||||
fl.fe, err = os.OpenFile(errpath, os.O_WRONLY|os.O_APPEND|os.O_CREATE, 0600)
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
fl.Close()
|
||||
return nil, err
|
||||
}
|
||||
if err != nil {
|
||||
if closeErr := fl.Close(); closeErr != nil {
|
||||
return nil, fmt.Errorf("failed to open error log: cleanup close failed: %v: %w", closeErr, err)
|
||||
}
|
||||
return nil, err
|
||||
}
|
||||
|
||||
fl.LogWriter = NewLogWriter(fl.fo, fl.fe)
|
||||
return fl, nil
|
||||
}
|
||||
|
||||
// Close calls close on the underlying log files.
|
||||
func (fl *File) Close() error {
|
||||
if fl.fo != nil {
|
||||
if err := fl.fo.Close(); err != nil {
|
||||
return err
|
||||
}
|
||||
fl.fo = nil
|
||||
}
|
||||
|
||||
if fl.fe != nil {
|
||||
return fl.fe.Close()
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (fl *File) Flush() error {
|
||||
if err := fl.fo.Sync(); err != nil {
|
||||
return err
|
||||
}
|
||||
return fl.fe.Sync()
|
||||
}
|
||||
|
||||
func (fl *File) Chmod(mode os.FileMode) error {
|
||||
if err := fl.fo.Chmod(mode); err != nil {
|
||||
return fmt.Errorf("failed to chmod output log: %w", err)
|
||||
}
|
||||
|
||||
if err := fl.fe.Chmod(mode); err != nil {
|
||||
return fmt.Errorf("failed to chmod error log: %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
@@ -32,31 +32,6 @@ const (
|
||||
// DefaultLevel is the default logging level when none is provided.
|
||||
const DefaultLevel = LevelInfo
|
||||
|
||||
// Cheap integer to fixed-width decimal ASCII. Give a negative width
|
||||
// to avoid zero-padding. (From log/log.go in the standard library).
|
||||
func itoa(i int, wid int) string {
|
||||
// Assemble decimal in reverse order.
|
||||
var b [20]byte
|
||||
bp := len(b) - 1
|
||||
for i >= 10 || wid > 1 {
|
||||
wid--
|
||||
q := i / 10
|
||||
b[bp] = byte('0' + i - q*10)
|
||||
bp--
|
||||
i = q
|
||||
}
|
||||
// i < 10
|
||||
b[bp] = byte('0' + i)
|
||||
return string(b[bp:])
|
||||
}
|
||||
|
||||
func writeToOut(level Level) bool {
|
||||
if level < LevelWarning {
|
||||
return true
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
var levelPrefix = [...]string{
|
||||
LevelDebug: "DEBUG",
|
||||
LevelInfo: "INFO",
|
||||
|
||||
105
logging/log.go
105
logging/log.go
@@ -1,6 +1,7 @@
|
||||
package logging
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
@@ -11,64 +12,64 @@ import (
|
||||
//
|
||||
// Log messages consist of four components:
|
||||
//
|
||||
// 1. The **level** attaches a notion of priority to the log message.
|
||||
// Several log levels are available:
|
||||
// 1. The **level** attaches a notion of priority to the log message.
|
||||
// Several log levels are available:
|
||||
//
|
||||
// + FATAL (32): the system is in an unsuable state, and cannot
|
||||
// continue to run. Most of the logging for this will cause the
|
||||
// program to exit with an error code.
|
||||
// + CRITICAL (16): critical conditions. The error, if uncorrected, is
|
||||
// likely to cause a fatal condition shortly. An example is running
|
||||
// out of disk space. This is something that the ops team should get
|
||||
// paged for.
|
||||
// + ERROR (8): error conditions. A single error doesn't require an
|
||||
// ops team to be paged, but repeated errors should often trigger a
|
||||
// page based on threshold triggers. An example is a network
|
||||
// failure: it might be a transient failure (these do happen), but
|
||||
// most of the time it's self-correcting.
|
||||
// + WARNING (4): warning conditions. An example of this is a bad
|
||||
// request sent to a server. This isn't an error on the part of the
|
||||
// program, but it may be indicative of other things. Like errors,
|
||||
// the ops team shouldn't be paged for errors, but a page might be
|
||||
// triggered if a certain threshold of warnings is reached (which is
|
||||
// typically much higher than errors). For example, repeated
|
||||
// warnings might be a sign that the system is under attack.
|
||||
// + INFO (2): informational message. This is a normal log message
|
||||
// that is used to deliver information, such as recording
|
||||
// requests. Ops teams are never paged for informational
|
||||
// messages. This is the default log level.
|
||||
// + DEBUG (1): debug-level message. These are only used during
|
||||
// development or if a deployed system repeatedly sees abnormal
|
||||
// errors.
|
||||
// + FATAL (32): the system is in an unusable state and cannot
|
||||
// continue to run. Most of the logging for this will cause the
|
||||
// program to exit with an error code.
|
||||
// + CRITICAL (16): critical conditions. The error, if uncorrected, is
|
||||
// likely to cause a fatal condition shortly. An example is running
|
||||
// out of disk space. This is something that the ops team should get
|
||||
// paged for.
|
||||
// + ERROR (8): error conditions. A single error doesn't require an
|
||||
// ops team to be paged, but repeated errors should often trigger a
|
||||
// page based on threshold triggers. An example is a network
|
||||
// failure: it might be a transient failure (these do happen), but
|
||||
// most of the time it's self-correcting.
|
||||
// + WARNING (4): warning conditions. An example of this is a bad
|
||||
// request sent to a server. This isn't an error on the part of the
|
||||
// program, but it may be indicative of other things. Like errors,
|
||||
// the ops team shouldn't be paged for errors, but a page might be
|
||||
// triggered if a certain threshold of warnings is reached (which is
|
||||
// typically much higher than errors). For example, repeated
|
||||
// warnings might be a sign that the system is under attack.
|
||||
// + INFO (2): informational message. This is a normal log message
|
||||
// used to deliver information, such as recording requests. Ops
|
||||
// teams are never paged for informational messages. This is the
|
||||
// default log level.
|
||||
// + DEBUG (1): debug-level message. These are only used during
|
||||
// development or if a deployed system repeatedly sees abnormal
|
||||
// errors.
|
||||
//
|
||||
// The numeric values indicate the priority of a given level.
|
||||
// The numeric values indicate the priority of a given level.
|
||||
//
|
||||
// 2. The **actor** is used to specify which component is generating
|
||||
// the log message. This could be the program name, or it could be
|
||||
// a specific component inside the system.
|
||||
// 2. The **actor** is used to specify which component is generating
|
||||
// the log message. This could be the program name, or it could be
|
||||
// a specific component inside the system.
|
||||
//
|
||||
// 3. The **event** is a short message indicating what happened. This is
|
||||
// most like the traditional log message.
|
||||
// 3. The **event** is a short message indicating what happened. This is
|
||||
// most like the traditional log message.
|
||||
//
|
||||
// 4. The **attributes** are an optional set of key-value string pairs that
|
||||
// provide additional information.
|
||||
// 4. The **attributes** are an optional set of key-value string pairs that
|
||||
// provide additional information.
|
||||
//
|
||||
// Additionally, each log message has an associated timestamp. For the
|
||||
// text-based logs, this is "%FT%T%z"; for the binary logs, this is a
|
||||
// 64-bit Unix timestamp. An example text-based timestamp might look like ::
|
||||
//
|
||||
// [2016-03-27T20:59:27-0700] [INFO] [actor:server event:request received] client=192.168.2.5 request-size=839
|
||||
// [2016-03-27T20:59:27-0700] [INFO] [actor:server event:request received] client=192.168.2.5 request-size=839
|
||||
//
|
||||
// Note that this is organised in a manner that facilitates parsing::
|
||||
//
|
||||
// /\[(\d{4}-\d{3}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{4})\] \[(\w+\)]\) \[actor:(.+?) event:(.+?)\]/
|
||||
// /\[(\d{4}-\d{3}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{4})\] \[(\w+\)]\) \[actor:(.+?) event:(.+?)\]/
|
||||
//
|
||||
// will cover the header:
|
||||
//
|
||||
// + ``$1`` contains the timestamp
|
||||
// + ``$2`` contains the level
|
||||
// + ``$3`` contains the actor
|
||||
// + ``$4`` contains the event
|
||||
// + “$1“ contains the timestamp
|
||||
// + “$2“ contains the level
|
||||
// + “$3“ contains the actor
|
||||
// + “$4“ contains the event.
|
||||
type Logger interface {
|
||||
// SetLevel sets the minimum log level.
|
||||
SetLevel(Level)
|
||||
@@ -131,7 +132,7 @@ func (lw *LogWriter) output(w io.Writer, lvl Level, actor, event string, attrs m
|
||||
}
|
||||
|
||||
// Debug emits a debug-level message. These are only used during
|
||||
// development or if a deployed system repeatedly sees abnormal
|
||||
// development, or if a deployed system repeatedly sees abnormal
|
||||
// errors.
|
||||
//
|
||||
// Actor specifies the component emitting the message; event indicates
|
||||
@@ -213,7 +214,7 @@ func (lw *LogWriter) Critical(actor, event string, attrs map[string]string) {
|
||||
lw.output(lw.we, LevelCritical, actor, event, attrs)
|
||||
}
|
||||
|
||||
// Fatal emits a message indicating that the system is in an unsuable
|
||||
// Fatal emits a message indicating that the system is in an unusable
|
||||
// state, and cannot continue to run. The program will exit with exit
|
||||
// code 1.
|
||||
//
|
||||
@@ -229,9 +230,9 @@ func (lw *LogWriter) Fatal(actor, event string, attrs map[string]string) {
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
// FatalCode emits a message indicating that the system is in an unsuable
|
||||
// FatalCode emits a message indicating that the system is in an unusable
|
||||
// state, and cannot continue to run. The program will exit with the
|
||||
// exit code speicfied in the exitcode argument.
|
||||
// exit code specified in the exitcode argument.
|
||||
//
|
||||
// Actor specifies the component emitting the message; event indicates
|
||||
// the event that caused the log message to be emitted. attrs is a map
|
||||
@@ -245,7 +246,7 @@ func (lw *LogWriter) FatalCode(exitcode int, actor, event string, attrs map[stri
|
||||
os.Exit(exitcode)
|
||||
}
|
||||
|
||||
// FatalNoDie emits a message indicating that the system is in an unsuable
|
||||
// FatalNoDie emits a message indicating that the system is in an unusable
|
||||
// state, and cannot continue to run. The program will not exit; it is
|
||||
// assumed that the caller has some final clean up to perform.
|
||||
//
|
||||
@@ -314,11 +315,17 @@ func (m *Multi) Status() error {
|
||||
}
|
||||
|
||||
func (m *Multi) Close() error {
|
||||
var errs []error
|
||||
for _, l := range m.loggers {
|
||||
l.Close()
|
||||
if err := l.Close(); err != nil {
|
||||
errs = append(errs, err)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
if len(errs) == 0 {
|
||||
return nil
|
||||
}
|
||||
return errors.Join(errs...)
|
||||
}
|
||||
|
||||
func (m *Multi) Debug(actor, event string, attrs map[string]string) {
|
||||
|
||||
@@ -1,30 +1,32 @@
|
||||
package logging
|
||||
package logging_test
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"git.wntrmute.dev/kyle/goutils/logging"
|
||||
)
|
||||
|
||||
// A list of implementations that should be tested.
|
||||
var implementations []Logger
|
||||
var implementations []logging.Logger
|
||||
|
||||
func init() {
|
||||
lw := NewLogWriter(&bytes.Buffer{}, nil)
|
||||
cw := NewConsole()
|
||||
lw := logging.NewLogWriter(&bytes.Buffer{}, nil)
|
||||
cw := logging.NewConsole()
|
||||
|
||||
implementations = append(implementations, lw)
|
||||
implementations = append(implementations, cw)
|
||||
}
|
||||
|
||||
func TestFileSetup(t *testing.T) {
|
||||
fw1, err := NewFile("fw1.log", true)
|
||||
fw1, err := logging.NewFile("fw1.log", true)
|
||||
if err != nil {
|
||||
t.Fatalf("failed to create new file logger: %v", err)
|
||||
}
|
||||
|
||||
fw2, err := NewSplitFile("fw2.log", "fw2.err", true)
|
||||
fw2, err := logging.NewSplitFile("fw2.log", "fw2.err", true)
|
||||
if err != nil {
|
||||
t.Fatalf("failed to create new split file logger: %v", err)
|
||||
}
|
||||
@@ -33,7 +35,7 @@ func TestFileSetup(t *testing.T) {
|
||||
implementations = append(implementations, fw2)
|
||||
}
|
||||
|
||||
func TestImplementations(t *testing.T) {
|
||||
func TestImplementations(_ *testing.T) {
|
||||
for _, l := range implementations {
|
||||
l.Info("TestImplementations", "Info message",
|
||||
map[string]string{"type": fmt.Sprintf("%T", l)})
|
||||
@@ -44,20 +46,30 @@ func TestImplementations(t *testing.T) {
|
||||
|
||||
func TestCloseLoggers(t *testing.T) {
|
||||
for _, l := range implementations {
|
||||
l.Close()
|
||||
if err := l.Close(); err != nil {
|
||||
t.Errorf("failed to close logger: %v", err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestDestroyLogFiles(t *testing.T) {
|
||||
os.Remove("fw1.log")
|
||||
os.Remove("fw2.log")
|
||||
os.Remove("fw2.err")
|
||||
if err := os.Remove("fw1.log"); err != nil {
|
||||
t.Errorf("failed to remove fw1.log: %v", err)
|
||||
}
|
||||
|
||||
if err := os.Remove("fw2.log"); err != nil {
|
||||
t.Errorf("failed to remove fw2.log: %v", err)
|
||||
}
|
||||
|
||||
if err := os.Remove("fw2.err"); err != nil {
|
||||
t.Errorf("failed to remove fw2.err: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestMulti(t *testing.T) {
|
||||
c1 := NewConsole()
|
||||
c2 := NewConsole()
|
||||
m := NewMulti(c1, c2)
|
||||
c1 := logging.NewConsole()
|
||||
c2 := logging.NewConsole()
|
||||
m := logging.NewMulti(c1, c2)
|
||||
if !m.Good() {
|
||||
t.Fatal("failed to set up multi logger")
|
||||
}
|
||||
|
||||
@@ -8,15 +8,15 @@ type mwc struct {
|
||||
}
|
||||
|
||||
// Write implements the Writer interface.
|
||||
func (t *mwc) Write(p []byte) (n int, err error) {
|
||||
func (t *mwc) Write(p []byte) (int, error) {
|
||||
for _, w := range t.wcs {
|
||||
n, err = w.Write(p)
|
||||
n, err := w.Write(p)
|
||||
if err != nil {
|
||||
return
|
||||
return n, err
|
||||
}
|
||||
if n != len(p) {
|
||||
err = io.ErrShortWrite
|
||||
return
|
||||
return n, err
|
||||
}
|
||||
}
|
||||
return len(p), nil
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
package mwc
|
||||
package mwc_test
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"testing"
|
||||
|
||||
"git.wntrmute.dev/kyle/goutils/assert"
|
||||
"git.wntrmute.dev/kyle/goutils/mwc"
|
||||
"git.wntrmute.dev/kyle/goutils/testio"
|
||||
)
|
||||
|
||||
@@ -12,7 +13,7 @@ func TestMWC(t *testing.T) {
|
||||
buf1 := testio.NewBufCloser(nil)
|
||||
buf2 := testio.NewBufCloser(nil)
|
||||
|
||||
mwc := MultiWriteCloser(buf1, buf2)
|
||||
mwc := mwc.MultiWriteCloser(buf1, buf2)
|
||||
|
||||
_, err := mwc.Write([]byte("hello, world"))
|
||||
assert.NoErrorT(t, err)
|
||||
@@ -30,15 +31,15 @@ func TestMWCShort(t *testing.T) {
|
||||
buf3 := testio.NewBrokenWriter(5)
|
||||
buf4 := testio.NewSilentBrokenWriter(5)
|
||||
|
||||
mwc := MultiWriteCloser(buf1, buf2, buf3)
|
||||
defer mwc.Close()
|
||||
multiWriter := mwc.MultiWriteCloser(buf1, buf2, buf3)
|
||||
defer multiWriter.Close()
|
||||
|
||||
_, err := mwc.Write([]byte("hello, world"))
|
||||
_, err := multiWriter.Write([]byte("hello, world"))
|
||||
assert.ErrorT(t, err, "expected a short write error", "but no error occurred")
|
||||
mwc.Close()
|
||||
multiWriter.Close()
|
||||
|
||||
mwc = MultiWriteCloser(buf1, buf2, buf4)
|
||||
_, err = mwc.Write([]byte("hello, world"))
|
||||
multiWriter = mwc.MultiWriteCloser(buf1, buf2, buf4)
|
||||
_, err = multiWriter.Write([]byte("hello, world"))
|
||||
assert.ErrorT(t, err, "expected a short write error", "but no error occurred")
|
||||
}
|
||||
|
||||
@@ -47,7 +48,7 @@ func TestMWCClose(t *testing.T) {
|
||||
buf2 := testio.NewBufCloser(nil)
|
||||
buf3 := testio.NewBrokenCloser(nil)
|
||||
|
||||
mwc := MultiWriteCloser(buf1, buf2, buf3)
|
||||
mwc := mwc.MultiWriteCloser(buf1, buf2, buf3)
|
||||
_, err := mwc.Write([]byte("hello, world"))
|
||||
assert.NoErrorT(t, err)
|
||||
|
||||
|
||||
49
rand/rand.go
49
rand/rand.go
@@ -1,49 +0,0 @@
|
||||
// Package rand contains utilities for interacting with math/rand, including
|
||||
// seeding from a random sed.
|
||||
package rand
|
||||
|
||||
import (
|
||||
"crypto/rand"
|
||||
"encoding/binary"
|
||||
mrand "math/rand"
|
||||
)
|
||||
|
||||
// CryptoUint64 generates a cryptographically-secure 64-bit integer.
|
||||
func CryptoUint64() (uint64, error) {
|
||||
bs := make([]byte, 8)
|
||||
_, err := rand.Read(bs)
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
|
||||
return binary.BigEndian.Uint64(bs), nil
|
||||
}
|
||||
|
||||
// Seed initialises the non-cryptographic PRNG with a random,
|
||||
// cryptographically secure value. This is done just as a good
|
||||
// way to make this random. The returned 64-bit value is the seed.
|
||||
func Seed() (uint64, error) {
|
||||
seed, err := CryptoUint64()
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
|
||||
// NB: this is permitted.
|
||||
mrand.Seed(int64(seed))
|
||||
return seed, nil
|
||||
}
|
||||
|
||||
// Int is a wrapper for math.Int so only one package needs to be imported.
|
||||
func Int() int {
|
||||
return mrand.Int()
|
||||
}
|
||||
|
||||
// Intn is a wrapper for math.Intn so only one package needs to be imported.
|
||||
func Intn(max int) int {
|
||||
return mrand.Intn(max)
|
||||
}
|
||||
|
||||
// Intn2 returns a random value between min and max, inclusive.
|
||||
func Intn2(min, max int) int {
|
||||
return Intn(max-min) + min
|
||||
}
|
||||
@@ -1,74 +0,0 @@
|
||||
package rand
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
mrand "math/rand"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestCryptoUint64(t *testing.T) {
|
||||
n1, err := CryptoUint64()
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
n2, err := CryptoUint64()
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
// This has such a low chance of occurring that it's likely to be
|
||||
// indicative of a bad CSPRNG.
|
||||
if n1 == n2 {
|
||||
t.Fatalf("repeated random uint64s: %d", n1)
|
||||
}
|
||||
}
|
||||
|
||||
func TestIntn(t *testing.T) {
|
||||
expected := []int{3081, 4887, 4847, 1059, 3081}
|
||||
mrand.Seed(1)
|
||||
for i := 0; i < 5; i++ {
|
||||
n := Intn2(1000, 5000)
|
||||
|
||||
if n != expected[i] {
|
||||
fmt.Printf("invalid sequence at %d: expected %d, have %d", i, expected[i], n)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestSeed(t *testing.T) {
|
||||
seed1, err := Seed()
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
var seed2 uint64
|
||||
n1 := Int()
|
||||
tries := 0
|
||||
|
||||
for {
|
||||
seed2, err = Seed()
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if seed1 != seed2 {
|
||||
break
|
||||
}
|
||||
|
||||
tries++
|
||||
|
||||
if tries > 3 {
|
||||
t.Fatal("can't generate two unique seeds")
|
||||
}
|
||||
}
|
||||
|
||||
n2 := Int()
|
||||
|
||||
// Again, this not impossible, merely statistically improbably and a
|
||||
// potential canary for RNG issues.
|
||||
if n1 == n2 {
|
||||
t.Fatalf("repeated integers fresh from two unique seeds: %d/%d -> %d",
|
||||
seed1, seed2, n1)
|
||||
}
|
||||
}
|
||||
21
sbuf/sbuf.go
21
sbuf/sbuf.go
@@ -15,7 +15,7 @@ func zero(in []byte, n int) {
|
||||
stop = len(in)
|
||||
}
|
||||
|
||||
for i := 0; i < stop; i++ {
|
||||
for i := range stop {
|
||||
in[i] ^= in[i]
|
||||
}
|
||||
}
|
||||
@@ -37,7 +37,10 @@ func NewBuffer(n int) *Buffer {
|
||||
// original data will be wiped.
|
||||
func NewBufferFrom(p []byte) *Buffer {
|
||||
buf := NewBuffer(len(p))
|
||||
buf.Write(p)
|
||||
_, err := buf.Write(p)
|
||||
if err != nil {
|
||||
return nil
|
||||
}
|
||||
zero(p, len(p))
|
||||
return buf
|
||||
}
|
||||
@@ -54,10 +57,7 @@ func (buf *Buffer) Read(p []byte) (int, error) {
|
||||
return 0, io.EOF
|
||||
}
|
||||
|
||||
copyLength := len(p)
|
||||
if copyLength > len(buf.buf) {
|
||||
copyLength = len(buf.buf)
|
||||
}
|
||||
copyLength := min(len(p), len(buf.buf))
|
||||
|
||||
copy(p, buf.buf)
|
||||
zero(buf.buf, len(p))
|
||||
@@ -91,10 +91,7 @@ func (buf *Buffer) Write(p []byte) (int, error) {
|
||||
r := len(buf.buf) + len(p)
|
||||
if cap(buf.buf) < r {
|
||||
l := r
|
||||
for {
|
||||
if l > r {
|
||||
break
|
||||
}
|
||||
for l <= r {
|
||||
l *= 2
|
||||
}
|
||||
buf.grow(l - cap(buf.buf))
|
||||
@@ -107,7 +104,7 @@ func (buf *Buffer) Write(p []byte) (int, error) {
|
||||
func (buf *Buffer) WriteByte(c byte) error {
|
||||
r := len(buf.buf) + 1
|
||||
if cap(buf.buf) < r {
|
||||
l := r * 2
|
||||
l := r << 1
|
||||
buf.grow(l - cap(buf.buf))
|
||||
}
|
||||
buf.buf = append(buf.buf, c)
|
||||
@@ -138,7 +135,7 @@ func (buf *Buffer) Bytes() []byte {
|
||||
}
|
||||
|
||||
p := make([]byte, buf.Len())
|
||||
buf.Read(p)
|
||||
_, _ = buf.Read(p)
|
||||
buf.Close()
|
||||
return p
|
||||
}
|
||||
|
||||
@@ -1,15 +1,16 @@
|
||||
package sbuf
|
||||
package sbuf_test
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"crypto/rand"
|
||||
"testing"
|
||||
|
||||
"git.wntrmute.dev/kyle/goutils/sbuf"
|
||||
"golang.org/x/crypto/nacl/box"
|
||||
)
|
||||
|
||||
var (
|
||||
buf = &Buffer{}
|
||||
buf = &sbuf.Buffer{}
|
||||
testMessage1 = []byte("round and round and round we go, where we stop, no one knows")
|
||||
testMessage2 = []byte("the deconstruction of falling stars")
|
||||
)
|
||||
@@ -113,23 +114,23 @@ func TestShortRead(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestNewBuffer(t *testing.T) {
|
||||
buf := NewBuffer(32)
|
||||
if len(buf.buf) != 0 {
|
||||
testBuffer := sbuf.NewBuffer(32)
|
||||
if testBuffer.Len() != 0 {
|
||||
t.Fatalf("expected new buffer length to be 0, have %d",
|
||||
len(buf.buf))
|
||||
testBuffer.Len())
|
||||
}
|
||||
|
||||
if cap(buf.buf) != 32 {
|
||||
if testBuffer.Cap() != 32 {
|
||||
t.Fatalf("expected new buffer capacity to be 0, have %d",
|
||||
cap(buf.buf))
|
||||
testBuffer.Cap())
|
||||
}
|
||||
}
|
||||
|
||||
func TestNewBufferFrom(t *testing.T) {
|
||||
p := make([]byte, len(testMessage1))
|
||||
copy(p, testMessage1)
|
||||
buf := NewBufferFrom(p)
|
||||
if !bytes.Equal(buf.buf, testMessage1) {
|
||||
testBuffer := sbuf.NewBufferFrom(p)
|
||||
if !bytes.Equal(testBuffer.Bytes(), testMessage1) {
|
||||
t.Fatal("new buffer wasn't constructed properly")
|
||||
}
|
||||
}
|
||||
@@ -137,10 +138,10 @@ func TestNewBufferFrom(t *testing.T) {
|
||||
func TestBytes(t *testing.T) {
|
||||
p := make([]byte, len(testMessage1))
|
||||
copy(p, testMessage1)
|
||||
buf := NewBufferFrom(p)
|
||||
testBuffer := sbuf.NewBufferFrom(p)
|
||||
|
||||
out := buf.Bytes()
|
||||
if buf.buf != nil {
|
||||
out := testBuffer.Bytes()
|
||||
if testBuffer.Len() != 0 {
|
||||
t.Fatal("buffer was not closed")
|
||||
}
|
||||
|
||||
@@ -148,21 +149,21 @@ func TestBytes(t *testing.T) {
|
||||
t.Fatal("buffer did not return the right data")
|
||||
}
|
||||
|
||||
out = buf.Bytes()
|
||||
out = testBuffer.Bytes()
|
||||
if out != nil {
|
||||
t.Fatal("a closed buffer should return nil for Bytes")
|
||||
}
|
||||
}
|
||||
|
||||
func TestRWByte(t *testing.T) {
|
||||
buf := NewBuffer(0)
|
||||
testBuffer := sbuf.NewBuffer(0)
|
||||
c := byte(42)
|
||||
err := buf.WriteByte(c)
|
||||
err := testBuffer.WriteByte(c)
|
||||
if err != nil {
|
||||
t.Fatalf("%v", err)
|
||||
}
|
||||
|
||||
c, err = buf.ReadByte()
|
||||
c, err = testBuffer.ReadByte()
|
||||
if err != nil {
|
||||
t.Fatalf("%v", err)
|
||||
}
|
||||
@@ -171,22 +172,21 @@ func TestRWByte(t *testing.T) {
|
||||
t.Fatalf("Expected 42, have %d", c)
|
||||
}
|
||||
|
||||
_, err = buf.ReadByte()
|
||||
_, err = testBuffer.ReadByte()
|
||||
if err == nil {
|
||||
t.Fatal("Expected EOF")
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkRead(b *testing.B) {
|
||||
b.N = 2000
|
||||
pub, priv, err := box.GenerateKey(rand.Reader)
|
||||
if err != nil {
|
||||
b.Fatalf("%v", err)
|
||||
}
|
||||
b.ReportAllocs()
|
||||
|
||||
for i := 0; i < b.N; i++ {
|
||||
_, err := buf.Write(priv[:])
|
||||
for b.Loop() {
|
||||
_, err = buf.Write(priv[:])
|
||||
if err != nil {
|
||||
b.Fatalf("%v", err)
|
||||
}
|
||||
@@ -204,11 +204,11 @@ func BenchmarkFixed(b *testing.B) {
|
||||
b.Fatalf("%v", err)
|
||||
}
|
||||
|
||||
buf = NewBuffer(64 * b.N)
|
||||
buf = sbuf.NewBuffer(64 * b.N)
|
||||
b.ReportAllocs()
|
||||
|
||||
for i := 0; i < b.N; i++ {
|
||||
_, err := buf.Write(priv[:])
|
||||
for b.Loop() {
|
||||
_, err = buf.Write(priv[:])
|
||||
if err != nil {
|
||||
b.Fatalf("%v", err)
|
||||
}
|
||||
|
||||
@@ -1,18 +1,20 @@
|
||||
package seekbuf
|
||||
package seekbuf_test
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
"git.wntrmute.dev/kyle/goutils/assert"
|
||||
"git.wntrmute.dev/kyle/goutils/seekbuf"
|
||||
)
|
||||
|
||||
func TestSeeking(t *testing.T) {
|
||||
partA := []byte("hello, ")
|
||||
partB := []byte("world!")
|
||||
|
||||
buf := New(partA)
|
||||
assert.BoolT(t, buf.Len() == len(partA), fmt.Sprintf("on init: have length %d, want length %d", buf.Len(), len(partA)))
|
||||
buf := seekbuf.New(partA)
|
||||
assert.BoolT(t, buf.Len() == len(partA),
|
||||
fmt.Sprintf("on init: have length %d, want length %d", buf.Len(), len(partA)))
|
||||
|
||||
b := make([]byte, 32)
|
||||
|
||||
@@ -32,7 +34,8 @@ func TestSeeking(t *testing.T) {
|
||||
|
||||
partsLen := len(partA) + len(partB)
|
||||
buf.Rewind()
|
||||
assert.BoolT(t, buf.Len() == partsLen, fmt.Sprintf("after rewinding: have length %d, want length %d", buf.Len(), partsLen))
|
||||
assert.BoolT(t, buf.Len() == partsLen,
|
||||
fmt.Sprintf("after rewinding: have length %d, want length %d", buf.Len(), partsLen))
|
||||
|
||||
buf.Close()
|
||||
assert.BoolT(t, buf.Len() == 0, fmt.Sprintf("after closing, have length %d, want length 0", buf.Len()))
|
||||
|
||||
48
tee/tee.go
48
tee/tee.go
@@ -17,23 +17,6 @@ type Tee struct {
|
||||
Verbose bool
|
||||
}
|
||||
|
||||
func (t *Tee) Write(p []byte) (int, error) {
|
||||
n, err := os.Stdout.Write(p)
|
||||
if err != nil {
|
||||
return n, err
|
||||
}
|
||||
|
||||
if t.f != nil {
|
||||
return t.f.Write(p)
|
||||
}
|
||||
return n, nil
|
||||
}
|
||||
|
||||
// Close calls Close on the underlying file.
|
||||
func (t *Tee) Close() error {
|
||||
return t.f.Close()
|
||||
}
|
||||
|
||||
// NewOut writes to standard output only. The file is created, not
|
||||
// appended to.
|
||||
func NewOut(logFile string) (*Tee, error) {
|
||||
@@ -48,9 +31,32 @@ func NewOut(logFile string) (*Tee, error) {
|
||||
return &Tee{f: f}, nil
|
||||
}
|
||||
|
||||
func (t *Tee) Write(p []byte) (int, error) {
|
||||
n, err := os.Stdout.Write(p)
|
||||
if err != nil {
|
||||
return n, err
|
||||
}
|
||||
|
||||
if t.f != nil {
|
||||
return t.f.Write(p)
|
||||
}
|
||||
return n, nil
|
||||
}
|
||||
|
||||
// Close calls Close on the underlying file if present.
|
||||
// It is safe to call Close on a Tee with no file; in that case, it returns nil.
|
||||
func (t *Tee) Close() error {
|
||||
if t == nil || t.f == nil {
|
||||
return nil
|
||||
}
|
||||
err := t.f.Close()
|
||||
t.f = nil
|
||||
return err
|
||||
}
|
||||
|
||||
// Printf formats according to a format specifier and writes to the
|
||||
// tee instance.
|
||||
func (t *Tee) Printf(format string, args ...interface{}) (int, error) {
|
||||
func (t *Tee) Printf(format string, args ...any) (int, error) {
|
||||
s := fmt.Sprintf(format, args...)
|
||||
n, err := os.Stdout.WriteString(s)
|
||||
if err != nil {
|
||||
@@ -66,7 +72,7 @@ func (t *Tee) Printf(format string, args ...interface{}) (int, error) {
|
||||
|
||||
// VPrintf is a variant of Printf that only prints if the Tee's
|
||||
// Verbose flag is set.
|
||||
func (t *Tee) VPrintf(format string, args ...interface{}) (int, error) {
|
||||
func (t *Tee) VPrintf(format string, args ...any) (int, error) {
|
||||
if t.Verbose {
|
||||
return t.Printf(format, args...)
|
||||
}
|
||||
@@ -87,12 +93,12 @@ func Open(logFile string) error {
|
||||
|
||||
// Printf formats according to a format specifier and writes to the
|
||||
// global tee.
|
||||
func Printf(format string, args ...interface{}) (int, error) {
|
||||
func Printf(format string, args ...any) (int, error) {
|
||||
return globalTee.Printf(format, args...)
|
||||
}
|
||||
|
||||
// VPrintf calls VPrintf on the global tee instance.
|
||||
func VPrintf(format string, args ...interface{}) (int, error) {
|
||||
func VPrintf(format string, args ...any) (int, error) {
|
||||
return globalTee.VPrintf(format, args...)
|
||||
}
|
||||
|
||||
|
||||
197
tee/tee_test.go
Normal file
197
tee/tee_test.go
Normal file
@@ -0,0 +1,197 @@
|
||||
package tee_test
|
||||
|
||||
import (
|
||||
"io"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
tee "git.wntrmute.dev/kyle/goutils/tee"
|
||||
)
|
||||
|
||||
// captureStdout redirects os.Stdout for the duration of fn and returns what was written.
|
||||
func captureStdout(t *testing.T, fn func()) string {
|
||||
t.Helper()
|
||||
r, w, err := os.Pipe()
|
||||
if err != nil {
|
||||
t.Fatalf("pipe: %v", err)
|
||||
}
|
||||
old := os.Stdout
|
||||
os.Stdout = w
|
||||
defer func() { os.Stdout = old }()
|
||||
|
||||
fn()
|
||||
|
||||
// Close writer to unblock reader and restore stdout
|
||||
_ = w.Close()
|
||||
b, _ := io.ReadAll(r)
|
||||
_ = r.Close()
|
||||
return string(b)
|
||||
}
|
||||
|
||||
func TestNewOutEmpty_WritesToStdoutOnly(t *testing.T) {
|
||||
teeInst, err := tee.NewOut("")
|
||||
if err != nil {
|
||||
t.Fatalf("NewOut: %v", err)
|
||||
}
|
||||
|
||||
out := captureStdout(t, func() {
|
||||
var n int
|
||||
if n, err = teeInst.Write([]byte("abc")); err != nil || n != 3 {
|
||||
t.Fatalf("Write got n=%d err=%v", n, err)
|
||||
}
|
||||
|
||||
if n, err = teeInst.Printf("-%d-", 7); err != nil || n != len("-7-") {
|
||||
t.Fatalf("Printf got n=%d err=%v", n, err)
|
||||
}
|
||||
})
|
||||
|
||||
if out != "abc-7-" {
|
||||
t.Fatalf("stdout = %q, want %q", out, "abc-7-")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNewOutWithFile_WritesToBoth(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
logPath := filepath.Join(dir, "log.txt")
|
||||
|
||||
teeInst, err := tee.NewOut(logPath)
|
||||
if err != nil {
|
||||
t.Fatalf("NewOut: %v", err)
|
||||
}
|
||||
defer func() { _ = teeInst.Close() }()
|
||||
|
||||
out := captureStdout(t, func() {
|
||||
if _, err = teeInst.Write([]byte("x")); err != nil {
|
||||
t.Fatalf("Write: %v", err)
|
||||
}
|
||||
if _, err = teeInst.Printf("%s", "y"); err != nil {
|
||||
t.Fatalf("Printf: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
if out != "xy" {
|
||||
t.Fatalf("stdout = %q, want %q", out, "xy")
|
||||
}
|
||||
|
||||
// Close to flush and release the file before reading
|
||||
if err = teeInst.Close(); err != nil {
|
||||
t.Fatalf("Close: %v", err)
|
||||
}
|
||||
|
||||
data, err := os.ReadFile(logPath)
|
||||
if err != nil {
|
||||
t.Fatalf("ReadFile: %v", err)
|
||||
}
|
||||
if string(data) != "xy" {
|
||||
t.Fatalf("file content = %q, want %q", string(data), "xy")
|
||||
}
|
||||
}
|
||||
|
||||
func TestVPrintf_VerboseToggle(t *testing.T) {
|
||||
teeInst := &tee.Tee{} // stdout only
|
||||
|
||||
out := captureStdout(t, func() {
|
||||
if n, err := teeInst.VPrintf("hello"); err != nil || n != 0 {
|
||||
t.Fatalf("VPrintf (quiet) got n=%d err=%v", n, err)
|
||||
}
|
||||
})
|
||||
if out != "" {
|
||||
t.Fatalf("stdout = %q, want empty when not verbose", out)
|
||||
}
|
||||
|
||||
teeInst.Verbose = true
|
||||
out = captureStdout(t, func() {
|
||||
if n, err := teeInst.VPrintf("%s", "hello"); err != nil || n != len("hello") {
|
||||
t.Fatalf("VPrintf (verbose) got n=%d err=%v", n, err)
|
||||
}
|
||||
})
|
||||
if out != "hello" {
|
||||
t.Fatalf("stdout = %q, want %q", out, "hello")
|
||||
}
|
||||
}
|
||||
|
||||
func TestWrite_StdoutErrorDoesNotWriteToFile(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
logPath := filepath.Join(dir, "log.txt")
|
||||
teeInst, err := tee.NewOut(logPath)
|
||||
if err != nil {
|
||||
t.Fatalf("NewOut: %v", err)
|
||||
}
|
||||
defer func() { _ = teeInst.Close() }()
|
||||
|
||||
// Replace stdout with a closed pipe writer to force write error.
|
||||
r, w, err := os.Pipe()
|
||||
if err != nil {
|
||||
t.Fatalf("pipe: %v", err)
|
||||
}
|
||||
old := os.Stdout
|
||||
os.Stdout = w
|
||||
_ = w.Close() // immediately close to cause EPIPE on write
|
||||
defer func() {
|
||||
os.Stdout = old
|
||||
_ = r.Close()
|
||||
}()
|
||||
|
||||
var n int
|
||||
if n, err = teeInst.Write([]byte("abc")); err == nil {
|
||||
t.Fatalf("expected error writing to closed stdout, got n=%d err=nil", n)
|
||||
}
|
||||
|
||||
// Ensure file remained empty because stdout write failed first.
|
||||
_ = teeInst.Close()
|
||||
data, err := os.ReadFile(logPath)
|
||||
if err != nil {
|
||||
t.Fatalf("ReadFile: %v", err)
|
||||
}
|
||||
if len(data) != 0 {
|
||||
t.Fatalf("file content = %q, want empty due to stdout failure", string(data))
|
||||
}
|
||||
}
|
||||
|
||||
func TestGlobal_OpenPrintfVPrintfClose(t *testing.T) {
|
||||
// Ensure a clean slate for global tee
|
||||
_ = tee.Close()
|
||||
tee.SetVerbose(false)
|
||||
|
||||
dir := t.TempDir()
|
||||
logPath := filepath.Join(dir, "glog.txt")
|
||||
|
||||
if err := tee.Open(logPath); err != nil {
|
||||
t.Fatalf("Open: %v", err)
|
||||
}
|
||||
|
||||
out := captureStdout(t, func() {
|
||||
if _, err := tee.Printf("A"); err != nil {
|
||||
t.Fatalf("Printf: %v", err)
|
||||
}
|
||||
// Not verbose yet, should not print
|
||||
if n, err := tee.VPrintf("B"); err != nil || n != 0 {
|
||||
t.Fatalf("VPrintf (quiet) n=%d err=%v", n, err)
|
||||
}
|
||||
tee.SetVerbose(true)
|
||||
if _, err := tee.VPrintf("C%d", 1); err != nil {
|
||||
t.Fatalf("VPrintf (verbose): %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
if out != "AC1" {
|
||||
t.Fatalf("stdout = %q, want %q", out, "AC1")
|
||||
}
|
||||
|
||||
if err := tee.Close(); err != nil {
|
||||
t.Fatalf("Close: %v", err)
|
||||
}
|
||||
|
||||
data, err := os.ReadFile(logPath)
|
||||
if err != nil {
|
||||
t.Fatalf("ReadFile: %v", err)
|
||||
}
|
||||
if string(data) != "AC1" {
|
||||
t.Fatalf("file content = %q, want %q", string(data), "AC1")
|
||||
}
|
||||
|
||||
// Reset global tee for other tests/packages
|
||||
_ = tee.Close()
|
||||
tee.SetVerbose(false)
|
||||
}
|
||||
@@ -169,6 +169,26 @@ type BufCloser struct {
|
||||
buf *bytes.Buffer
|
||||
}
|
||||
|
||||
// NewBufCloser creates and initializes a new BufCloser using buf as
|
||||
// its initial contents. It is intended to prepare a BufCloser to read
|
||||
// existing data. It can also be used to size the internal buffer for
|
||||
// writing. To do that, buf should have the desired capacity but a
|
||||
// length of zero.
|
||||
func NewBufCloser(buf []byte) *BufCloser {
|
||||
bc := new(BufCloser)
|
||||
bc.buf = bytes.NewBuffer(buf)
|
||||
return bc
|
||||
}
|
||||
|
||||
// NewBufCloserString creates and initializes a new Buffer using
|
||||
// string s as its initial contents. It is intended to prepare a
|
||||
// buffer to read an existing string.
|
||||
func NewBufCloserString(s string) *BufCloser {
|
||||
buf := new(BufCloser)
|
||||
buf.buf = bytes.NewBufferString(s)
|
||||
return buf
|
||||
}
|
||||
|
||||
// Write writes the data to the BufCloser.
|
||||
func (buf *BufCloser) Write(p []byte) (int, error) {
|
||||
return buf.buf.Write(p)
|
||||
@@ -199,26 +219,6 @@ func (buf *BufCloser) Len() int {
|
||||
return buf.buf.Len()
|
||||
}
|
||||
|
||||
// NewBufCloser creates and initializes a new BufCloser using buf as
|
||||
// its initial contents. It is intended to prepare a BufCloser to read
|
||||
// existing data. It can also be used to size the internal buffer for
|
||||
// writing. To do that, buf should have the desired capacity but a
|
||||
// length of zero.
|
||||
func NewBufCloser(buf []byte) *BufCloser {
|
||||
bc := new(BufCloser)
|
||||
bc.buf = bytes.NewBuffer(buf)
|
||||
return bc
|
||||
}
|
||||
|
||||
// NewBufCloserString creates and initializes a new Buffer using
|
||||
// string s as its initial contents. It is intended to prepare a
|
||||
// buffer to read an existing string.
|
||||
func NewBufCloserString(s string) *BufCloser {
|
||||
buf := new(BufCloser)
|
||||
buf.buf = bytes.NewBufferString(s)
|
||||
return buf
|
||||
}
|
||||
|
||||
// A LoggingBuffer is an io.ReadWriter that prints the hex value of
|
||||
// the data for all reads and writes.
|
||||
type LoggingBuffer struct {
|
||||
@@ -323,6 +323,26 @@ type BrokenCloser struct {
|
||||
buf *bytes.Buffer
|
||||
}
|
||||
|
||||
// NewBrokenCloser creates and initializes a new BrokenCloser using buf as
|
||||
// its initial contents. It is intended to prepare a BrokenCloser to read
|
||||
// existing data. It can also be used to size the internal buffer for
|
||||
// writing. To do that, buf should have the desired capacity but a
|
||||
// length of zero.
|
||||
func NewBrokenCloser(buf []byte) *BrokenCloser {
|
||||
bc := new(BrokenCloser)
|
||||
bc.buf = bytes.NewBuffer(buf)
|
||||
return bc
|
||||
}
|
||||
|
||||
// NewBrokenCloserString creates and initializes a new Buffer using
|
||||
// string s as its initial contents. It is intended to prepare a
|
||||
// buffer to read an existing string.
|
||||
func NewBrokenCloserString(s string) *BrokenCloser {
|
||||
buf := new(BrokenCloser)
|
||||
buf.buf = bytes.NewBufferString(s)
|
||||
return buf
|
||||
}
|
||||
|
||||
// Write writes the data to the BrokenCloser.
|
||||
func (buf *BrokenCloser) Write(p []byte) (int, error) {
|
||||
return buf.buf.Write(p)
|
||||
@@ -347,23 +367,3 @@ func (buf *BrokenCloser) Reset() {
|
||||
func (buf *BrokenCloser) Bytes() []byte {
|
||||
return buf.buf.Bytes()
|
||||
}
|
||||
|
||||
// NewBrokenCloser creates and initializes a new BrokenCloser using buf as
|
||||
// its initial contents. It is intended to prepare a BrokenCloser to read
|
||||
// existing data. It can also be used to size the internal buffer for
|
||||
// writing. To do that, buf should have the desired capacity but a
|
||||
// length of zero.
|
||||
func NewBrokenCloser(buf []byte) *BrokenCloser {
|
||||
bc := new(BrokenCloser)
|
||||
bc.buf = bytes.NewBuffer(buf)
|
||||
return bc
|
||||
}
|
||||
|
||||
// NewBrokenCloserString creates and initializes a new Buffer using
|
||||
// string s as its initial contents. It is intended to prepare a
|
||||
// buffer to read an existing string.
|
||||
func NewBrokenCloserString(s string) *BrokenCloser {
|
||||
buf := new(BrokenCloser)
|
||||
buf.buf = bytes.NewBufferString(s)
|
||||
return buf
|
||||
}
|
||||
|
||||
@@ -1,13 +1,15 @@
|
||||
package testio
|
||||
package testio_test
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"git.wntrmute.dev/kyle/goutils/testio"
|
||||
)
|
||||
|
||||
func TestBrokenWriter(t *testing.T) {
|
||||
buf := NewBrokenWriter(2)
|
||||
buf := testio.NewBrokenWriter(2)
|
||||
data := []byte{1, 2}
|
||||
|
||||
n, err := buf.Write(data)
|
||||
@@ -39,7 +41,7 @@ func TestBufCloser(t *testing.T) {
|
||||
var data = []byte{1, 2}
|
||||
var read = make([]byte, 2)
|
||||
|
||||
buf := NewBufCloser(data)
|
||||
buf := testio.NewBufCloser(data)
|
||||
_, err := buf.Read(read)
|
||||
if err != nil {
|
||||
t.Fatalf("%v", err)
|
||||
@@ -54,7 +56,7 @@ func TestBufCloser(t *testing.T) {
|
||||
buf.Reset()
|
||||
|
||||
s := "hi"
|
||||
buf = NewBufCloserString(s)
|
||||
buf = testio.NewBufCloserString(s)
|
||||
|
||||
read = buf.Bytes()
|
||||
if string(read) != s {
|
||||
@@ -65,7 +67,7 @@ func TestBufCloser(t *testing.T) {
|
||||
func TestLoggingBuffer(t *testing.T) {
|
||||
src := &bytes.Buffer{}
|
||||
data := []byte("AB")
|
||||
lb := NewLoggingBuffer(src)
|
||||
lb := testio.NewLoggingBuffer(src)
|
||||
_, err := lb.Write(data)
|
||||
if err != nil {
|
||||
t.Fatalf("%v", err)
|
||||
@@ -82,8 +84,8 @@ func TestLoggingBuffer(t *testing.T) {
|
||||
}
|
||||
|
||||
expected := "[TEST] [WRITE] 4142\n"
|
||||
if string(out.Bytes()) != expected {
|
||||
t.Fatalf("expected '%s', have '%s'", expected, string(out.Bytes()))
|
||||
if out.String() != expected {
|
||||
t.Fatalf("expected '%s', have '%s'", expected, out.String())
|
||||
}
|
||||
|
||||
out.Reset()
|
||||
@@ -96,8 +98,8 @@ func TestLoggingBuffer(t *testing.T) {
|
||||
}
|
||||
|
||||
expected = "[TEST] [READ] 4142\n"
|
||||
if string(out.Bytes()) != expected {
|
||||
t.Fatalf("expected '%s', have '%s'", expected, string(out.Bytes()))
|
||||
if out.String() != expected {
|
||||
t.Fatalf("expected '%s', have '%s'", expected, out.String())
|
||||
}
|
||||
|
||||
out.Reset()
|
||||
@@ -112,8 +114,8 @@ func TestLoggingBuffer(t *testing.T) {
|
||||
}
|
||||
|
||||
expected = "[READ] 4142\n"
|
||||
if string(out.Bytes()) != expected {
|
||||
t.Fatalf("expected '%s', have '%s'", expected, string(out.Bytes()))
|
||||
if out.String() != expected {
|
||||
t.Fatalf("expected '%s', have '%s'", expected, out.String())
|
||||
}
|
||||
|
||||
src.Reset()
|
||||
@@ -124,8 +126,8 @@ func TestLoggingBuffer(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestBrokenReadWriter(t *testing.T) {
|
||||
brw := NewBrokenReadWriter(0, 0)
|
||||
lb := NewLoggingBuffer(brw)
|
||||
brw := testio.NewBrokenReadWriter(0, 0)
|
||||
lb := testio.NewLoggingBuffer(brw)
|
||||
|
||||
var p = make([]byte, 2)
|
||||
var data = []byte("HI")
|
||||
@@ -177,7 +179,7 @@ func TestBrokenReadWriter(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestBufferConn(t *testing.T) {
|
||||
bc := NewBufferConn()
|
||||
bc := testio.NewBufferConn()
|
||||
|
||||
client := []byte("AB")
|
||||
peer := []byte("XY")
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
package testutil
|
||||
|
||||
import "io/ioutil"
|
||||
|
||||
// TempName generates a new temporary file name. The caller should
|
||||
// remove the temporary file when done.
|
||||
func TempName() (string, error) {
|
||||
tmpf, err := ioutil.TempFile("", "transport_cachedkp_")
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
name := tmpf.Name()
|
||||
tmpf.Close()
|
||||
return name, nil
|
||||
}
|
||||
Reference in New Issue
Block a user