feat(secret-engines): bws as a secretengine.v1 extension

This commit is contained in:
sam committed 2026-10-04 00:43:02 +10:00
commit 22b4262b01
11 files changed
+753

No files matched your search

+1
View File
@@ -0,0 +1 @@
/bin/
+27
View File
@@ -0,0 +1,27 @@
# archipelago
The archie-core marketplace. One directory per extension surface; each surface
directory holds one subdirectory per extension.
```
secret-engines/<name>/ package.yaml + Go source, served over secretengine.v1
sdk/ generated surface stubs and the Serve helper
scripts/pack.sh build one package and push it to a registry
```
A surface's contract is the gRPC service in archie-core's `proto/<surface>/v1`.
Regenerate `sdk/` from it with `buf generate ../archie-core/proto --path
../archie-core/proto/<surface>`. An extension can be written in any language;
the Go SDK is a convenience.
## Publish and install
```
scripts/pack.sh secret-engines/bws localhost:5001/bws:1.0.0 # prints the digest
```
Install the printed digest through archie-core's package store, accept the
authority the package declares, then enable it in `extension-settings`. An
extension runs only while all three hold.
Platform: linux/amd64.
+14
View File
@@ -0,0 +1,14 @@
version: v2
clean: true
managed:
enabled: true
override:
- file_option: go_package_prefix
value: github.com/samcharles93/archipelago/sdk
plugins:
- local: protoc-gen-go
out: sdk
opt: paths=source_relative
- local: protoc-gen-go-grpc
out: sdk
opt: paths=source_relative
+23
View File
@@ -0,0 +1,23 @@
module github.com/samcharles93/archipelago
go 1.27
require (
github.com/hashicorp/go-plugin v1.8.0
google.golang.org/grpc v1.84.0
google.golang.org/protobuf v1.36.12
)
require (
github.com/fatih/color v1.13.0 // indirect
github.com/golang/protobuf v1.5.4 // indirect
github.com/hashicorp/go-hclog v1.6.3 // indirect
github.com/hashicorp/yamux v0.1.2 // indirect
github.com/mattn/go-colorable v0.1.12 // indirect
github.com/mattn/go-isatty v0.0.17 // indirect
github.com/oklog/run v1.1.0 // indirect
golang.org/x/net v0.57.0 // indirect
golang.org/x/sys v0.47.0 // indirect
golang.org/x/text v0.40.0 // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20260706201446-f0a921348800 // indirect
)
+56
View File
@@ -0,0 +1,56 @@
github.com/bufbuild/protocompile v0.14.1 h1:iA73zAf/fyljNjQKwYzUHD6AD4R8KMasmwa/FBatYVw=
github.com/bufbuild/protocompile v0.14.1/go.mod h1:ppVdAIhbr2H8asPk6k4pY7t9zB1OU5DoEw9xY/FUi1c=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/fatih/color v1.13.0 h1:8LOYc1KYPPmyKMuN8QV2DNRWNbLo6LZ0iLs8+mlH53w=
github.com/fatih/color v1.13.0/go.mod h1:kLAiJbzzSOZDVNGyDpeOxJ47H46qBXwg5ILebYFFOfk=
github.com/golang/protobuf v1.5.4 h1:i7eJL8qZTpSEXOPTxNKhASYpMn+8e5Q6AdndVa1dWek=
github.com/golang/protobuf v1.5.4/go.mod h1:lnTiLA8Wa4RWRcIUkrtSVa5nRhsEGBg48fD6rSs7xps=
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
github.com/hashicorp/go-hclog v1.6.3 h1:Qr2kF+eVWjTiYmU7Y31tYlP1h0q/X3Nl3tPGdaB11/k=
github.com/hashicorp/go-hclog v1.6.3/go.mod h1:W4Qnvbt70Wk/zYJryRzDRU/4r0kIg0PVHBcfoyhpF5M=
github.com/hashicorp/go-plugin v1.8.0 h1:ie8S6RRY8RvB2usYZv+AAZ/wBvx2AU5p5QeP5j/FORs=
github.com/hashicorp/go-plugin v1.8.0/go.mod h1:BExt6KEaIYx804z8k4gRzRLEvxKVb+kn0NMcihqOqb8=
github.com/hashicorp/yamux v0.1.2 h1:XtB8kyFOyHXYVFnwT5C3+Bdo8gArse7j2AQ0DA0Uey8=
github.com/hashicorp/yamux v0.1.2/go.mod h1:C+zze2n6e/7wshOZep2A70/aQU6QBRWJO/G6FT1wIns=
github.com/jhump/protoreflect v1.17.0 h1:qOEr613fac2lOuTgWN4tPAtLL7fUSbuJL5X5XumQh94=
github.com/jhump/protoreflect v1.17.0/go.mod h1:h9+vUUL38jiBzck8ck+6G/aeMX8Z4QUY/NiJPwPNi+8=
github.com/mattn/go-colorable v0.1.9/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc=
github.com/mattn/go-colorable v0.1.12 h1:jF+Du6AlPIjs2BiUiQlKOX0rt3SujHxPnksPKZbaA40=
github.com/mattn/go-colorable v0.1.12/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4=
github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94=
github.com/mattn/go-isatty v0.0.17 h1:BTarxUcIeDqL27Mc+vyvdWYSL28zpIhv3RoTdsLMPng=
github.com/mattn/go-isatty v0.0.17/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
github.com/oklog/run v1.1.0 h1:GEenZ1cK0+q0+wsJew9qUg/DyD8k3JzYsZAi5gYi2mA=
github.com/oklog/run v1.1.0/go.mod h1:sVPdnTZT1zYwAJeCMu2Th4T21pA3FPOQRfWjQlk7DVU=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.7.2 h1:4jaiDzPyXQvSd7D0EjG45355tLlV3VOECpq10pLC+8s=
github.com/stretchr/testify v1.7.2/go.mod h1:R6va5+xMeoiuVRoj+gSkQ7d3FALtqAAGI1FQKckRals=
golang.org/x/net v0.57.0 h1:K5+3DljvIuDG9/Jv9rvyMywYNFCQ9RSUY6OOTTkT+tE=
golang.org/x/net v0.57.0/go.mod h1:KpXc8iv+r3XplLAG/f7Jsf9RPszJzdR0f58q9vGOuEU=
golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220503163025-988cb79eb6c6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.47.0 h1:o7XGOvZQCADBQQ4Y7VNq2dRWQR7JmOUW8Kxx4ZsNgWs=
golang.org/x/sys v0.47.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
golang.org/x/text v0.40.0 h1:Ub2Z6/xjgF1WrYQz2nuITOEegKFtiIy+rieRJ5lHZKs=
golang.org/x/text v0.40.0/go.mod h1:hpnzDAfGV753zIKo+wk3u1bVKCGPbrnF7+7LBF/UHVY=
gonum.org/v1/gonum v0.17.0 h1:VbpOemQlsSMrYmn7T2OUvQ4dqxQXU+ouZFQsZOx50z4=
gonum.org/v1/gonum v0.17.0/go.mod h1:El3tOrEuMpv2UdMrbNlKEh9vd86bmQ6vqIcDwxEOc1E=
google.golang.org/genproto/googleapis/rpc v0.0.0-20260706201446-f0a921348800 h1:qEHAMpSaUhtD0p3NbEEI83HwNGFxEwaSJ1G9PLnCBZE=
google.golang.org/genproto/googleapis/rpc v0.0.0-20260706201446-f0a921348800/go.mod h1:4Hqkh8ycfw05ld/3BWL7rJOSfebL2Q+DVDeRgYgxUU8=
google.golang.org/grpc v1.84.0 h1:soMyaPJ8pAak5PIQ0DGBUir0XRo2fRoMqhNWMLlLxO0=
google.golang.org/grpc v1.84.0/go.mod h1:ljCht0DrxQrXBDRTZp52Qxh3Ffk8CdYm2sj4O2QN2C0=
google.golang.org/protobuf v1.36.12 h1:pJOKDDOyeXErUroCihFAd5LQuwXBSpVnKGrj5o/fwxc=
google.golang.org/protobuf v1.36.12/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+42
View File
@@ -0,0 +1,42 @@
#!/usr/bin/env bash
# Build one package and push it to a registry as an archie-core store package.
# scripts/pack.sh secret-engines/bws localhost:5001/bws:1.0.0
# Prints the manifest digest, the pin archie-core installs by.
set -euo pipefail
dir=${1:?package directory, e.g. secret-engines/bws}
ref=${2:?registry reference, e.g. localhost:5001/bws:1.0.0}
root=$(cd "$(dirname "$0")/.." && pwd)
work=$(mktemp -d)
trap 'rm -rf "$work"' EXIT
mkdir -p "$work/stage/bin" "$work/oci/blobs/sha256"
(cd "$root" && CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -trimpath -ldflags='-s -w' \
-o "$work/stage/bin/$(basename "$dir")" "./$dir")
chmod 0755 "$work/stage/bin/$(basename "$dir")"
tar --owner=0 --group=0 --numeric-owner --sort=name -C "$work/stage" -czf "$work/layer.tgz" "bin/$(basename "$dir")"
blob() { local d; d=$(sha256sum "$1" | cut -d' ' -f1); cp "$1" "$work/oci/blobs/sha256/$d"; echo "sha256:$d"; }
printf '{}' >"$work/config.json"
config=$(blob "$work/config.json")
layer=$(blob "$work/layer.tgz")
jq -n --arg config "$config" --arg layer "$layer" \
--argjson layersize "$(stat -c %s "$work/layer.tgz")" \
--rawfile descriptor "$root/$dir/package.yaml" '{
schemaVersion: 2,
mediaType: "application/vnd.oci.image.manifest.v1+json",
config: {mediaType: "application/vnd.oci.empty.v1+json", digest: $config, size: 2},
layers: [{mediaType: "application/vnd.oci.image.layer.v1.tar+gzip", digest: $layer, size: $layersize}],
annotations: {"dev.archie.package.v1": $descriptor}
}' | tr -d '\n' >"$work/manifest.json"
manifest=$(blob "$work/manifest.json")
printf '{"imageLayoutVersion":"1.0.0"}' >"$work/oci/oci-layout"
jq -n --arg d "$manifest" --argjson s "$(stat -c %s "$work/manifest.json")" \
'{schemaVersion: 2, manifests: [{mediaType: "application/vnd.oci.image.manifest.v1+json", digest: $d, size: $s}]}' \
>"$work/oci/index.json"
skopeo copy --preserve-digests --dest-tls-verify=false "oci:$work/oci" "docker://$ref" >&2
echo "$manifest"
+43
View File
@@ -0,0 +1,43 @@
// Package secretengine is what a Go secret-engine extension builds on: the
// generated secretengine.v1 contract and the handshake archie-core launches
// extensions with.
package secretengine
import (
"context"
goplugin "github.com/hashicorp/go-plugin"
"google.golang.org/grpc"
secretenginev1 "github.com/samcharles93/archipelago/sdk/secretengine/v1"
)
const surface = "secretengine"
type plugin struct {
goplugin.NetRPCUnsupportedPlugin
impl secretenginev1.SecretEngineServiceServer
}
func (p *plugin) GRPCServer(_ *goplugin.GRPCBroker, s *grpc.Server) error {
secretenginev1.RegisterSecretEngineServiceServer(s, p.impl)
return nil
}
func (*plugin) GRPCClient(context.Context, *goplugin.GRPCBroker, *grpc.ClientConn) (any, error) {
return nil, nil
}
// Serve runs impl as the extension process. It returns when archie-core stops
// the extension.
func Serve(impl secretenginev1.SecretEngineServiceServer) {
goplugin.Serve(&goplugin.ServeConfig{
HandshakeConfig: goplugin.HandshakeConfig{
ProtocolVersion: 1,
MagicCookieKey: "ARCHIE_EXTENSION",
MagicCookieValue: "archie",
},
Plugins: goplugin.PluginSet{surface: &plugin{impl: impl}},
GRPCServer: goplugin.DefaultGRPCServer,
})
}
+267
View File
@@ -0,0 +1,267 @@
// Code generated by protoc-gen-go. DO NOT EDIT.
// versions:
// protoc-gen-go v1.36.11
// protoc (unknown)
// source: secretengine/v1/secretengine.proto
package secretenginev1
import (
protoreflect "google.golang.org/protobuf/reflect/protoreflect"
protoimpl "google.golang.org/protobuf/runtime/protoimpl"
reflect "reflect"
sync "sync"
unsafe "unsafe"
)
const (
// Verify that this generated code is sufficiently up-to-date.
_ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)
// Verify that runtime/protoimpl is sufficiently up-to-date.
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
type ConfigureRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
Settings map[string]string `protobuf:"bytes,1,rep,name=settings,proto3" json:"settings,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
}
func (x *ConfigureRequest) Reset() {
*x = ConfigureRequest{}
mi := &file_secretengine_v1_secretengine_proto_msgTypes[0]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
func (x *ConfigureRequest) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*ConfigureRequest) ProtoMessage() {}
func (x *ConfigureRequest) ProtoReflect() protoreflect.Message {
mi := &file_secretengine_v1_secretengine_proto_msgTypes[0]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use ConfigureRequest.ProtoReflect.Descriptor instead.
func (*ConfigureRequest) Descriptor() ([]byte, []int) {
return file_secretengine_v1_secretengine_proto_rawDescGZIP(), []int{0}
}
func (x *ConfigureRequest) GetSettings() map[string]string {
if x != nil {
return x.Settings
}
return nil
}
type ConfigureResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
}
func (x *ConfigureResponse) Reset() {
*x = ConfigureResponse{}
mi := &file_secretengine_v1_secretengine_proto_msgTypes[1]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
func (x *ConfigureResponse) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*ConfigureResponse) ProtoMessage() {}
func (x *ConfigureResponse) ProtoReflect() protoreflect.Message {
mi := &file_secretengine_v1_secretengine_proto_msgTypes[1]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use ConfigureResponse.ProtoReflect.Descriptor instead.
func (*ConfigureResponse) Descriptor() ([]byte, []int) {
return file_secretengine_v1_secretengine_proto_rawDescGZIP(), []int{1}
}
type ResolveRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
}
func (x *ResolveRequest) Reset() {
*x = ResolveRequest{}
mi := &file_secretengine_v1_secretengine_proto_msgTypes[2]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
func (x *ResolveRequest) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*ResolveRequest) ProtoMessage() {}
func (x *ResolveRequest) ProtoReflect() protoreflect.Message {
mi := &file_secretengine_v1_secretengine_proto_msgTypes[2]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use ResolveRequest.ProtoReflect.Descriptor instead.
func (*ResolveRequest) Descriptor() ([]byte, []int) {
return file_secretengine_v1_secretengine_proto_rawDescGZIP(), []int{2}
}
func (x *ResolveRequest) GetKey() string {
if x != nil {
return x.Key
}
return ""
}
type ResolveResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
}
func (x *ResolveResponse) Reset() {
*x = ResolveResponse{}
mi := &file_secretengine_v1_secretengine_proto_msgTypes[3]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
func (x *ResolveResponse) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*ResolveResponse) ProtoMessage() {}
func (x *ResolveResponse) ProtoReflect() protoreflect.Message {
mi := &file_secretengine_v1_secretengine_proto_msgTypes[3]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use ResolveResponse.ProtoReflect.Descriptor instead.
func (*ResolveResponse) Descriptor() ([]byte, []int) {
return file_secretengine_v1_secretengine_proto_rawDescGZIP(), []int{3}
}
func (x *ResolveResponse) GetValue() string {
if x != nil {
return x.Value
}
return ""
}
var File_secretengine_v1_secretengine_proto protoreflect.FileDescriptor
const file_secretengine_v1_secretengine_proto_rawDesc = "" +
"\n" +
"\"secretengine/v1/secretengine.proto\x12\x0fsecretengine.v1\"\x9c\x01\n" +
"\x10ConfigureRequest\x12K\n" +
"\bsettings\x18\x01 \x03(\v2/.secretengine.v1.ConfigureRequest.SettingsEntryR\bsettings\x1a;\n" +
"\rSettingsEntry\x12\x10\n" +
"\x03key\x18\x01 \x01(\tR\x03key\x12\x14\n" +
"\x05value\x18\x02 \x01(\tR\x05value:\x028\x01\"\x13\n" +
"\x11ConfigureResponse\"\"\n" +
"\x0eResolveRequest\x12\x10\n" +
"\x03key\x18\x01 \x01(\tR\x03key\"'\n" +
"\x0fResolveResponse\x12\x14\n" +
"\x05value\x18\x01 \x01(\tR\x05value2\xb7\x01\n" +
"\x13SecretEngineService\x12R\n" +
"\tConfigure\x12!.secretengine.v1.ConfigureRequest\x1a\".secretengine.v1.ConfigureResponse\x12L\n" +
"\aResolve\x12\x1f.secretengine.v1.ResolveRequest\x1a .secretengine.v1.ResolveResponseB\xcd\x01\n" +
"\x13com.secretengine.v1B\x11SecretengineProtoP\x01ZFgithub.com/samcharles93/archipelago/sdk/secretengine/v1;secretenginev1\xa2\x02\x03SXX\xaa\x02\x0fSecretengine.V1\xca\x02\x0fSecretengine\\V1\xe2\x02\x1bSecretengine\\V1\\GPBMetadata\xea\x02\x10Secretengine::V1b\x06proto3"
var (
file_secretengine_v1_secretengine_proto_rawDescOnce sync.Once
file_secretengine_v1_secretengine_proto_rawDescData []byte
)
func file_secretengine_v1_secretengine_proto_rawDescGZIP() []byte {
file_secretengine_v1_secretengine_proto_rawDescOnce.Do(func() {
file_secretengine_v1_secretengine_proto_rawDescData = protoimpl.X.CompressGZIP(unsafe.Slice(unsafe.StringData(file_secretengine_v1_secretengine_proto_rawDesc), len(file_secretengine_v1_secretengine_proto_rawDesc)))
})
return file_secretengine_v1_secretengine_proto_rawDescData
}
var file_secretengine_v1_secretengine_proto_msgTypes = make([]protoimpl.MessageInfo, 5)
var file_secretengine_v1_secretengine_proto_goTypes = []any{
(*ConfigureRequest)(nil), // 0: secretengine.v1.ConfigureRequest
(*ConfigureResponse)(nil), // 1: secretengine.v1.ConfigureResponse
(*ResolveRequest)(nil), // 2: secretengine.v1.ResolveRequest
(*ResolveResponse)(nil), // 3: secretengine.v1.ResolveResponse
nil, // 4: secretengine.v1.ConfigureRequest.SettingsEntry
}
var file_secretengine_v1_secretengine_proto_depIdxs = []int32{
4, // 0: secretengine.v1.ConfigureRequest.settings:type_name -> secretengine.v1.ConfigureRequest.SettingsEntry
0, // 1: secretengine.v1.SecretEngineService.Configure:input_type -> secretengine.v1.ConfigureRequest
2, // 2: secretengine.v1.SecretEngineService.Resolve:input_type -> secretengine.v1.ResolveRequest
1, // 3: secretengine.v1.SecretEngineService.Configure:output_type -> secretengine.v1.ConfigureResponse
3, // 4: secretengine.v1.SecretEngineService.Resolve:output_type -> secretengine.v1.ResolveResponse
3, // [3:5] is the sub-list for method output_type
1, // [1:3] is the sub-list for method input_type
1, // [1:1] is the sub-list for extension type_name
1, // [1:1] is the sub-list for extension extendee
0, // [0:1] is the sub-list for field type_name
}
func init() { file_secretengine_v1_secretengine_proto_init() }
func file_secretengine_v1_secretengine_proto_init() {
if File_secretengine_v1_secretengine_proto != nil {
return
}
type x struct{}
out := protoimpl.TypeBuilder{
File: protoimpl.DescBuilder{
GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
RawDescriptor: unsafe.Slice(unsafe.StringData(file_secretengine_v1_secretengine_proto_rawDesc), len(file_secretengine_v1_secretengine_proto_rawDesc)),
NumEnums: 0,
NumMessages: 5,
NumExtensions: 0,
NumServices: 1,
},
GoTypes: file_secretengine_v1_secretengine_proto_goTypes,
DependencyIndexes: file_secretengine_v1_secretengine_proto_depIdxs,
MessageInfos: file_secretengine_v1_secretengine_proto_msgTypes,
}.Build()
File_secretengine_v1_secretengine_proto = out.File
file_secretengine_v1_secretengine_proto_goTypes = nil
file_secretengine_v1_secretengine_proto_depIdxs = nil
}
+175
View File
@@ -0,0 +1,175 @@
// Code generated by protoc-gen-go-grpc. DO NOT EDIT.
// versions:
// - protoc-gen-go-grpc v1.6.2
// - protoc (unknown)
// source: secretengine/v1/secretengine.proto
package secretenginev1
import (
context "context"
grpc "google.golang.org/grpc"
codes "google.golang.org/grpc/codes"
status "google.golang.org/grpc/status"
)
// This is a compile-time assertion to ensure that this generated file
// is compatible with the grpc package it is being compiled against.
// Requires gRPC-Go v1.64.0 or later.
const _ = grpc.SupportPackageIsVersion9
const (
SecretEngineService_Configure_FullMethodName = "/secretengine.v1.SecretEngineService/Configure"
SecretEngineService_Resolve_FullMethodName = "/secretengine.v1.SecretEngineService/Resolve"
)
// SecretEngineServiceClient is the client API for SecretEngineService service.
//
// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
//
// SecretEngineService is the surface a secret-engine extension serves. The
// host launches one plugin process per enabled engine and resolves every
// SecretRef naming that engine through it.
type SecretEngineServiceClient interface {
// Configure hands the engine its settings once, right after launch and
// before any Resolve. It is the only channel for configuration: the plugin
// process does not inherit the host environment.
Configure(ctx context.Context, in *ConfigureRequest, opts ...grpc.CallOption) (*ConfigureResponse, error)
// Resolve returns the value for key. An unknown key is NOT_FOUND.
Resolve(ctx context.Context, in *ResolveRequest, opts ...grpc.CallOption) (*ResolveResponse, error)
}
type secretEngineServiceClient struct {
cc grpc.ClientConnInterface
}
func NewSecretEngineServiceClient(cc grpc.ClientConnInterface) SecretEngineServiceClient {
return &secretEngineServiceClient{cc}
}
func (c *secretEngineServiceClient) Configure(ctx context.Context, in *ConfigureRequest, opts ...grpc.CallOption) (*ConfigureResponse, error) {
cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
out := new(ConfigureResponse)
err := c.cc.Invoke(ctx, SecretEngineService_Configure_FullMethodName, in, out, cOpts...)
if err != nil {
return nil, err
}
return out, nil
}
func (c *secretEngineServiceClient) Resolve(ctx context.Context, in *ResolveRequest, opts ...grpc.CallOption) (*ResolveResponse, error) {
cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
out := new(ResolveResponse)
err := c.cc.Invoke(ctx, SecretEngineService_Resolve_FullMethodName, in, out, cOpts...)
if err != nil {
return nil, err
}
return out, nil
}
// SecretEngineServiceServer is the server API for SecretEngineService service.
// All implementations must embed UnimplementedSecretEngineServiceServer
// for forward compatibility.
//
// SecretEngineService is the surface a secret-engine extension serves. The
// host launches one plugin process per enabled engine and resolves every
// SecretRef naming that engine through it.
type SecretEngineServiceServer interface {
// Configure hands the engine its settings once, right after launch and
// before any Resolve. It is the only channel for configuration: the plugin
// process does not inherit the host environment.
Configure(context.Context, *ConfigureRequest) (*ConfigureResponse, error)
// Resolve returns the value for key. An unknown key is NOT_FOUND.
Resolve(context.Context, *ResolveRequest) (*ResolveResponse, error)
mustEmbedUnimplementedSecretEngineServiceServer()
}
// UnimplementedSecretEngineServiceServer must be embedded to have
// forward compatible implementations.
//
// NOTE: this should be embedded by value instead of pointer to avoid a nil
// pointer dereference when methods are called.
type UnimplementedSecretEngineServiceServer struct{}
func (UnimplementedSecretEngineServiceServer) Configure(context.Context, *ConfigureRequest) (*ConfigureResponse, error) {
return nil, status.Error(codes.Unimplemented, "method Configure not implemented")
}
func (UnimplementedSecretEngineServiceServer) Resolve(context.Context, *ResolveRequest) (*ResolveResponse, error) {
return nil, status.Error(codes.Unimplemented, "method Resolve not implemented")
}
func (UnimplementedSecretEngineServiceServer) mustEmbedUnimplementedSecretEngineServiceServer() {}
func (UnimplementedSecretEngineServiceServer) testEmbeddedByValue() {}
// UnsafeSecretEngineServiceServer may be embedded to opt out of forward compatibility for this service.
// Use of this interface is not recommended, as added methods to SecretEngineServiceServer will
// result in compilation errors.
type UnsafeSecretEngineServiceServer interface {
mustEmbedUnimplementedSecretEngineServiceServer()
}
func RegisterSecretEngineServiceServer(s grpc.ServiceRegistrar, srv SecretEngineServiceServer) {
// If the following call panics, it indicates UnimplementedSecretEngineServiceServer was
// embedded by pointer and is nil. This will cause panics if an
// unimplemented method is ever invoked, so we test this at initialization
// time to prevent it from happening at runtime later due to I/O.
if t, ok := srv.(interface{ testEmbeddedByValue() }); ok {
t.testEmbeddedByValue()
}
s.RegisterService(&SecretEngineService_ServiceDesc, srv)
}
func _SecretEngineService_Configure_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
in := new(ConfigureRequest)
if err := dec(in); err != nil {
return nil, err
}
if interceptor == nil {
return srv.(SecretEngineServiceServer).Configure(ctx, in)
}
info := &grpc.UnaryServerInfo{
Server: srv,
FullMethod: SecretEngineService_Configure_FullMethodName,
}
handler := func(ctx context.Context, req interface{}) (interface{}, error) {
return srv.(SecretEngineServiceServer).Configure(ctx, req.(*ConfigureRequest))
}
return interceptor(ctx, in, info, handler)
}
func _SecretEngineService_Resolve_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
in := new(ResolveRequest)
if err := dec(in); err != nil {
return nil, err
}
if interceptor == nil {
return srv.(SecretEngineServiceServer).Resolve(ctx, in)
}
info := &grpc.UnaryServerInfo{
Server: srv,
FullMethod: SecretEngineService_Resolve_FullMethodName,
}
handler := func(ctx context.Context, req interface{}) (interface{}, error) {
return srv.(SecretEngineServiceServer).Resolve(ctx, req.(*ResolveRequest))
}
return interceptor(ctx, in, info, handler)
}
// SecretEngineService_ServiceDesc is the grpc.ServiceDesc for SecretEngineService service.
// It's only intended for direct use with grpc.RegisterService,
// and not to be introspected or modified (even as a copy)
var SecretEngineService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "secretengine.v1.SecretEngineService",
HandlerType: (*SecretEngineServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "Configure",
Handler: _SecretEngineService_Configure_Handler,
},
{
MethodName: "Resolve",
Handler: _SecretEngineService_Resolve_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "secretengine/v1/secretengine.proto",
}
+91
View File
@@ -0,0 +1,91 @@
// bws serves Bitwarden Secrets Manager as an archie-core secret engine. It
// wraps the bws CLI, which must be installed on the host, and reads
// BWS_ACCESS_TOKEN from the environment archie-core passes it.
package main
import (
"context"
"encoding/json"
"errors"
"fmt"
"io"
"os"
"os/exec"
"path/filepath"
"sync"
"time"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"github.com/samcharles93/archipelago/sdk/secretengine"
secretenginev1 "github.com/samcharles93/archipelago/sdk/secretengine/v1"
)
const listTimeout = 30 * time.Second
type engine struct {
secretenginev1.UnimplementedSecretEngineServiceServer
once sync.Once
secrets map[string]string
err error
}
func (*engine) Configure(context.Context, *secretenginev1.ConfigureRequest) (*secretenginev1.ConfigureResponse, error) {
return &secretenginev1.ConfigureResponse{}, nil
}
func (e *engine) Resolve(ctx context.Context, r *secretenginev1.ResolveRequest) (*secretenginev1.ResolveResponse, error) {
e.once.Do(func() { e.secrets, e.err = list(ctx) })
if e.err != nil {
return nil, status.Error(codes.Unavailable, e.err.Error())
}
value, ok := e.secrets[r.GetKey()]
if !ok {
return nil, status.Errorf(codes.NotFound, "bws secret %q not found", r.GetKey())
}
return &secretenginev1.ResolveResponse{Value: value}, nil
}
func list(ctx context.Context) (map[string]string, error) {
command, err := find()
if err != nil {
return nil, err
}
ctx, cancel := context.WithTimeout(ctx, listTimeout)
defer cancel()
cmd := exec.CommandContext(ctx, command, "secret", "list", "--output", "json")
cmd.Env = os.Environ()
cmd.Stderr = io.Discard
raw, err := cmd.Output()
if err != nil {
return nil, fmt.Errorf("list bws secrets: %w", err)
}
var records []struct{ Key, Value string }
if err := json.Unmarshal(raw, &records); err != nil {
return nil, fmt.Errorf("decode bws secrets: %w", err)
}
secrets := make(map[string]string, len(records))
for _, record := range records {
if record.Key != "" && record.Value != "" {
secrets[record.Key] = record.Value
}
}
return secrets, nil
}
func find() (string, error) {
if command, err := exec.LookPath("bws"); err == nil {
return command, nil
}
if home, err := os.UserHomeDir(); err == nil {
command := filepath.Join(home, ".local", "bin", "bws")
if info, statErr := os.Stat(command); statErr == nil && !info.IsDir() && info.Mode()&0o111 != 0 {
return command, nil
}
}
return "", errors.New("bws executable not found")
}
func main() { secretengine.Serve(&engine{}) }
+14
View File
@@ -0,0 +1,14 @@
apiVersion: dev.archie.package.v1
displayName: Bitwarden Secrets Manager
description: Resolve secret references from Bitwarden Secrets Manager through the bws CLI.
version: 1.0.0
contributes:
extensions:
- surface: secretengine
path: bin/bws
authority:
env:
- BWS_ACCESS_TOKEN
files:
- path: bin/bws
mode: 493