pkg/vault/kv/builder.go

// Licensed to Elasticsearch B.V. under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Elasticsearch B.V. licenses this file to you 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
//
//     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.

package kv

import (
	"fmt"

	"github.com/hashicorp/vault/api"

	vpath "github.com/elastic/harp/pkg/vault/path"
)

// Option defines the functional option pattern.
type Option func(opts *Options)

// Options defiens the default option value.
type Options struct {
	useCustomMetadata bool
}

// WithVaultMetatadata enable/disable the custom metadata storage strategy (requires Vault >=1.9).
func WithVaultMetatadata(value bool) Option {
	return func(opts *Options) {
		opts.useCustomMetadata = value
	}
}

// New build a KV service according to mountPath version.
func New(client *api.Client, path string, opts ...Option) (Service, error) {
	// Sanitize path
	secretPath := vpath.SanitizePath(path)

	// Detect mount path
	mountPath, v2, err := isKVv2(secretPath, client)
	if err != nil {
		return nil, fmt.Errorf("vault: unable to detect k/v backend version: %w", err)
	}

	// Defines default flag.
	dopts := &Options{
		useCustomMetadata: false,
	}

	// Apply option function.
	for _, o := range opts {
		o(dopts)
	}

	// Build the service according to mountPath version
	var s Service
	if v2 {
		s = V2(client.Logical(), mountPath, dopts.useCustomMetadata)
	} else {
		s = V1(client.Logical(), mountPath)
	}

	// No error
	return s, nil
}