Skip to content

Commit 0aab9fb

Browse files
committed
feat(cfapi): include origin-ca-issuer version
The team operating the Origin CA have requested this issuer include version information in the User-Agent to aid in debugging issues on their side and understand the rate at which updates to the issuer have been adopted. Introduces an internal "version" package where the binary version is set via LDFLAGS. Starting with Go 1.24 this information will be embedded into the binary's module, which can be queried instead.
1 parent a86cb47 commit 0aab9fb

File tree

5 files changed

+10
-5
lines changed

5 files changed

+10
-5
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ ifeq (${KERNEL},Linux)
2828
GOFLAGS ?= -buildmode=pie
2929
endif
3030

31-
GO_LDFLAGS += -w -s -X main.version=${VERSION}
31+
GO_LDFLAGS += -w -s -X github.com/cloudflare/origin-ca-issuer/internal/version.Version=${VERSION}
3232
GOFLAGS += -v
3333

3434
export CGO_ENABLED

internal/cfapi/cfapi.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ import (
88
"net/http"
99
"net/url"
1010
"time"
11+
12+
"github.com/cloudflare/origin-ca-issuer/internal/version"
1113
)
1214

1315
type Interface interface {
@@ -121,7 +123,7 @@ func (c *Client) Sign(ctx context.Context, req *SignRequest) (*SignResponse, err
121123
return nil, err
122124
}
123125

124-
r.Header.Add("User-Agent", "github.com/cloudflare/origin-ca-issuer")
126+
r.Header.Add("User-Agent", "origin-ca-issuer/"+version.Version)
125127

126128
if c.serviceKey != nil {
127129
r.Header.Add("X-Auth-User-Service-Key", string(c.serviceKey))

internal/version/version.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
package version
2+
3+
var Version = "0.0.0"

pkgs/controllers/testdata/database-failure.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ interactions:
1616
form: {}
1717
headers:
1818
User-Agent:
19-
- github.com/cloudflare/origin-ca-issuer
19+
- origin-ca-issuer/0.0.0
2020
X-Auth-User-Service-Key:
2121
- djEuMC0weDAwQkFCMTBD
2222
url: https://api.cloudflare.com/client/v4/certificates

pkgs/controllers/testdata/working.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ interactions:
1616
form: {}
1717
headers:
1818
User-Agent:
19-
- github.com/cloudflare/origin-ca-issuer
19+
- origin-ca-issuer/0.0.0
2020
X-Auth-User-Service-Key:
2121
- djEuMC0weDAwQkFCMTBD
2222
url: https://api.cloudflare.com/client/v4/certificates
@@ -62,7 +62,7 @@ interactions:
6262
form: {}
6363
headers:
6464
User-Agent:
65-
- github.com/cloudflare/origin-ca-issuer
65+
- origin-ca-issuer/0.0.0
6666
Authorization:
6767
- Bearer api-token
6868
url: https://api.cloudflare.com/client/v4/certificates

0 commit comments

Comments
 (0)