certmagic.Storage changed in 2.5.0-rc1?

Hendrik_Visage · April 18, 2022, 1:17pm

Problem building against 2.5.0-rc1 / Master

opened 10:23AM - 18 Apr 22 UTC

Using `xcaddy build master --with github.com/ss098/certmagic-s3` I get the error… below (seems to be also happening for redistls storage module). Building against 2.4.6 everything seems fine. ``` 2022/04/18 10:19:02 [INFO] exec (timeout=0s): /usr/bin/go get -d -v 2022/04/18 10:19:05 [INFO] Build environment ready 2022/04/18 10:19:05 [INFO] Building Caddy 2022/04/18 10:19:05 [INFO] exec (timeout=0s): /usr/bin/go mod tidy 2022/04/18 10:19:05 [INFO] exec (timeout=0s): /usr/bin/go build -o /root/caddy/caddy -ldflags -w -s -trimpath # github.com/ss098/certmagic-s3 /root/go/pkg/mod/github.com/ss098/certmagic-s3@v0.0.0-20211201134104-efad3a48d4ed/s3.go:127:2: cannot use s3 (type S3) as type certmagic.Storage in return argument: S3 does not implement certmagic.Storage (wrong type for Delete method) have Delete(string) error want Delete(context.Context, string) error 2022/04/18 10:19:09 [INFO] Cleaning up temporary folder: /tmp/buildenv_2022-04-18-1018.2928695872 2022/04/18 10:19:09 [FATAL] exit status 2 root@apt-cacher:~/caddy# go version go version go1.17.8 linux/amd64 ```

Busy looking at a shared certificates for a “cluster” of Caddy, I ran into the above for 2.5.0-rc1 / master today, even though it builds fine using 2.4.6 & 2.5.0-beta.1

for RedisTLS the exact same error: xcaddy build v2.5.0-rc.1 --with github.com/gamalan/caddy-tlsredis 2>&1 | plik

2022/04/18 13:16:03 [INFO] Temporary folder: /tmp/buildenv_2022-04-18-1316.2381718657
2022/04/18 13:16:03 [INFO] Writing main module: /tmp/buildenv_2022-04-18-1316.2381718657/main.go
package main

import (
	caddycmd "github.com/caddyserver/caddy/v2/cmd"

	// plug in Caddy modules here
	_ "github.com/caddyserver/caddy/v2/modules/standard"
	_ "github.com/gamalan/caddy-tlsredis"
)

func main() {
	caddycmd.Main()
}
2022/04/18 13:16:03 [INFO] Initializing Go module
2022/04/18 13:16:03 [INFO] exec (timeout=10s): /usr/bin/go mod init caddy 
go: creating new go.mod: module caddy
go: to add module requirements and sums:
	go mod tidy
2022/04/18 13:16:03 [INFO] Pinning versions
2022/04/18 13:16:03 [INFO] exec (timeout=0s): /usr/bin/go get -d -v github.com/caddyserver/caddy/v2@v2.5.0-rc.1 
go get: added github.com/beorn7/perks v1.0.1
go get: added github.com/caddyserver/caddy/v2 v2.5.0-rc.1
go get: added github.com/caddyserver/certmagic v0.16.0
go get: added github.com/cespare/xxhash/v2 v2.1.2
go get: added github.com/cheekybits/genny v1.0.0
go get: added github.com/fsnotify/fsnotify v1.5.1
go get: added github.com/go-task/slim-sprig v0.0.0-20210107165309-348f09dbbbc0
go get: added github.com/golang/protobuf v1.5.2
go get: added github.com/google/uuid v1.3.0
go get: added github.com/klauspost/cpuid/v2 v2.0.11
go get: added github.com/libdns/libdns v0.2.1
go get: added github.com/lucas-clemente/quic-go v0.26.0
go get: added github.com/marten-seemann/qpack v0.2.1
go get: added github.com/marten-seemann/qtls-go1-16 v0.1.5
go get: added github.com/marten-seemann/qtls-go1-17 v0.1.1
go get: added github.com/marten-seemann/qtls-go1-18 v0.1.1
go get: added github.com/matttproud/golang_protobuf_extensions v1.0.1
go get: added github.com/mholt/acmez v1.0.2
go get: added github.com/miekg/dns v1.1.46
go get: added github.com/nxadm/tail v1.4.8
go get: added github.com/onsi/ginkgo v1.16.4
go get: added github.com/prometheus/client_golang v1.12.1
go get: added github.com/prometheus/client_model v0.2.0
go get: added github.com/prometheus/common v0.32.1
go get: added github.com/prometheus/procfs v0.7.3
go get: added go.uber.org/atomic v1.7.0
go get: added go.uber.org/multierr v1.6.0
go get: added go.uber.org/zap v1.21.0
go get: added golang.org/x/crypto v0.0.0-20220210151621-f4118a5b28e2
go get: added golang.org/x/mod v0.4.2
go get: added golang.org/x/net v0.0.0-20220127200216-cd36cc0744dd
go get: added golang.org/x/sys v0.0.0-20220209214540-3681064d5158
go get: added golang.org/x/term v0.0.0-20210927222741-03fcf44c2211
go get: added golang.org/x/text v0.3.8-0.20211004125949-5bd84dd9b33b
go get: added golang.org/x/tools v0.1.7
go get: added golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1
go get: added google.golang.org/protobuf v1.27.1
go get: added gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7
2022/04/18 13:16:05 [INFO] exec (timeout=0s): /usr/bin/go get -d -v github.com/gamalan/caddy-tlsredis github.com/caddyserver/caddy/v2@v2.5.0-rc.1 
go get: added github.com/bsm/redislock v0.7.0
go get: added github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f
go get: added github.com/gamalan/caddy-tlsredis v0.2.8
go get: added github.com/go-redis/redis/v8 v8.11.0
2022/04/18 13:16:06 [INFO] exec (timeout=0s): /usr/bin/go get -d -v  
2022/04/18 13:16:08 [INFO] Build environment ready
2022/04/18 13:16:08 [INFO] Building Caddy
2022/04/18 13:16:08 [INFO] exec (timeout=0s): /usr/bin/go mod tidy 
2022/04/18 13:16:09 [INFO] exec (timeout=0s): /usr/bin/go build -o /root/caddy/caddy -ldflags -w -s -trimpath 
# github.com/gamalan/caddy-tlsredis
/root/go/pkg/mod/github.com/gamalan/caddy-tlsredis@v0.2.8/storageredis.go:159:2: cannot use rd (type *RedisStorage) as type certmagic.Storage in return argument:
	*RedisStorage does not implement certmagic.Storage (wrong type for Delete method)
		have Delete(string) error
		want Delete(context.Context, string) error
/root/go/pkg/mod/github.com/gamalan/caddy-tlsredis@v0.2.8/storageredis.go:484:15: undefined: certmagic.ErrNotExist
2022/04/18 13:16:10 [INFO] Cleaning up temporary folder: /tmp/buildenv_2022-04-18-1316.2381718657
2022/04/18 13:16:10 [FATAL] exit status 2

matt · April 18, 2022, 2:21pm

Yes, the Storage interface had a breaking change (note that CertMagic is not yet stable 1.0 – but we’re close):

github.com/caddyserver/certmagic

Propagate context in the Storage interface methods

caddyserver:master ← hairyhenderson:add-context-to-storage-interface-154

opened 09:58PM - 14 Dec 21 UTC

hairyhenderson

+188 -158

Fixes #154 This adds a `context.Context` as the first argument to each method… in the `Storage` and `Locker` interfaces, and propagates existing contexts as much as possible. All uses of `context.TODO()` are replaced. Instead of changing the `HTTPS` function's signature, I've added an `HTTPSWithContext` as it's a breaking change and that's likely the most-used function. I'm not sure if I should add a `TLSWithContext` and `ListenWithContext` too, or change those, or leave them as-is... 🤔 Signed-off-by: Dave Henderson <dhenderson@gmail.com>

The caddy-tlsredis plugin was updated already and should build fine once a new version is tagged by @gamalan:

github.com/gamalan/caddy-tlsredis

Update storageredis.go

gamalan:master ← mholt:patch-1

opened 08:32PM - 08 Mar 22 UTC

mholt

+9 -8

[Recent changes](https://github.com/caddyserver/certmagic/compare/v0.15.4...mast…er) (not yet tagged) in CertMagic add `context.Context` to the Storage interface methods, as well as make use of the new [`fs.ErrNotExist`](https://pkg.go.dev/io/fs#pkg-variables) error value. Because it's a breaking change in CertMagic (which is not yet a stable 1.0), I'm submitting this PR as a courtesy. It's a quick edit I made manually in the browser, so it may need a little massaging if I missed something. Let me know if you have any questions! (I see you have a different way of getting context. You may want to consider using the more local context passed into these methods. I just made your signatures compatible so they satisfy the updated interfaces.)

In the meantime, you can specify the latest version by using @master after the package name in your xcaddy and go commands.

Also note that the S3 plugin you’re building is not safe in terms of CA rate limits because it does not implement the Lock or Unlock methods properly (they are simply no-ops). And as far as I know, S3 does not support atomic operations (sigh), so I highly recommend not using S3 for a storage backend.

system · May 18, 2022, 1:17pm

This topic was automatically closed after 30 days. New replies are no longer allowed.