Files
seaweedfs/weed/kms/openbao/openbao_kms.go
T
Denis 3db54ee7e5 kms/openbao: refresh the AppRole token before it expires (#12734)
* kms/openbao: refresh the AppRole token before it expires

The provider logged in with AppRole once, when it was created, and
never renewed the token. After the token's TTL every SSE-KMS upload,
and every read of an SSE-KMS object whose data key was not cached,
failed with "permission denied" (HTTP 500 to the client) until the S3
server was restarted.

With AppRole authentication the provider now logs in again in the
background once two thirds of the token's TTL have passed, and retries
a failed login every 5 s. Each login is bounded by the client's
timeout, or by 30 s when request_timeout is not positive. Close stops
the refresh. A static token, or an AppRole token without a TTL, is left
as it is.

* kms: keep the OpenBao token refresh across configuration reloads

- AddKMSProvider and InitializeGlobalKMS create a provider instance of
  their own with the new NewProvider instead of the registry's cached
  one: a reload closed the cached instance and then got it back, which
  now stopped its token refresh. The new instance is created before the
  old one is closed, so a configuration that fails leaves the current
  provider working
- openbao: time each refresh from the start of the login that issued
  the token, since its TTL runs from then rather than from the response
- tests: a reload gives a new instance and closes the old one, a failed
  reload keeps the old one; the refresh survives a reload; a slow login
  response

* kms: create a replacement provider outside the manager lock

AddKMSProvider ran the provider factory, which for OpenBao is a login
that may wait for its timeout, while holding the manager lock, so every
lookup, also of unrelated providers, waited for it. The new provider is
now created before the lock is taken; the lock covers only the swap, and
the replaced provider is closed after it. Test: a lookup while another
provider is being created.
2026-11-18 11:07:09 -08:00

462 lines
15 KiB
Go

package openbao
import (
"context"
"crypto/rand"
"encoding/base64"
"encoding/json"
"fmt"
"strings"
"time"
vault "github.com/hashicorp/vault/api"
"github.com/seaweedfs/seaweedfs/weed/glog"
seaweedkms "github.com/seaweedfs/seaweedfs/weed/kms"
"github.com/seaweedfs/seaweedfs/weed/util"
)
func init() {
// Register the OpenBao/Vault KMS provider
seaweedkms.RegisterProvider("openbao", NewOpenBaoKMSProvider)
seaweedkms.RegisterProvider("vault", NewOpenBaoKMSProvider) // Alias for compatibility
}
// OpenBaoKMSProvider implements the KMSProvider interface using OpenBao/Vault Transit engine
type OpenBaoKMSProvider struct {
client *vault.Client
transitPath string // Transit engine mount path (default: "transit")
address string
stopRefresh context.CancelFunc // stops the AppRole token refresh; nil without one
refreshDone chan struct{}
}
// refreshRetryInterval is how soon a failed AppRole login is tried again.
// Variables so that tests can shorten them.
var (
refreshRetryInterval = 5 * time.Second
refreshLoginTimeout = 30 * time.Second // when request_timeout leaves the client without one
)
// OpenBaoKMSConfig contains configuration for the OpenBao/Vault KMS provider
type OpenBaoKMSConfig struct {
Address string `json:"address"` // Vault address (e.g., "http://localhost:8200")
Token string `json:"token"` // Vault token for authentication
RoleID string `json:"role_id"` // AppRole role ID (alternative to token)
SecretID string `json:"secret_id"` // AppRole secret ID (alternative to token)
TransitPath string `json:"transit_path"` // Transit engine mount path (default: "transit")
TLSSkipVerify bool `json:"tls_skip_verify"` // Skip TLS verification (for testing)
CACert string `json:"ca_cert"` // Path to CA certificate
ClientCert string `json:"client_cert"` // Path to client certificate
ClientKey string `json:"client_key"` // Path to client private key
RequestTimeout int `json:"request_timeout"` // Request timeout in seconds (default: 30)
}
// NewOpenBaoKMSProvider creates a new OpenBao/Vault KMS provider
func NewOpenBaoKMSProvider(config util.Configuration) (seaweedkms.KMSProvider, error) {
if config == nil {
return nil, fmt.Errorf("OpenBao/Vault KMS configuration is required")
}
// Extract configuration
address := config.GetString("address")
if address == "" {
address = "http://localhost:8200" // Default OpenBao address
}
token := config.GetString("token")
roleID := config.GetString("role_id")
secretID := config.GetString("secret_id")
transitPath := config.GetString("transit_path")
if transitPath == "" {
transitPath = "transit" // Default transit path
}
tlsSkipVerify := config.GetBool("tls_skip_verify")
caCert := config.GetString("ca_cert")
clientCert := config.GetString("client_cert")
clientKey := config.GetString("client_key")
requestTimeout := config.GetInt("request_timeout")
if requestTimeout == 0 {
requestTimeout = 30 // Default 30 seconds
}
// Create Vault client configuration
vaultConfig := vault.DefaultConfig()
vaultConfig.Address = address
vaultConfig.Timeout = time.Duration(requestTimeout) * time.Second
// Configure TLS
if tlsSkipVerify || caCert != "" || (clientCert != "" && clientKey != "") {
tlsConfig := &vault.TLSConfig{
Insecure: tlsSkipVerify,
}
if caCert != "" {
tlsConfig.CACert = caCert
}
if clientCert != "" && clientKey != "" {
tlsConfig.ClientCert = clientCert
tlsConfig.ClientKey = clientKey
}
if err := vaultConfig.ConfigureTLS(tlsConfig); err != nil {
return nil, fmt.Errorf("failed to configure TLS: %w", err)
}
}
// Create Vault client
client, err := vault.NewClient(vaultConfig)
if err != nil {
return nil, fmt.Errorf("failed to create OpenBao/Vault client: %w", err)
}
// Authenticate
var ttl time.Duration
loginStart := time.Now() // the token's TTL runs from when OpenBao issues it, not from its response
if token != "" {
client.SetToken(token)
glog.V(1).Infof("OpenBao KMS: Using token authentication")
} else if roleID != "" && secretID != "" {
if ttl, err = authenticateAppRole(context.Background(), client, roleID, secretID); err != nil {
return nil, fmt.Errorf("failed to authenticate with AppRole: %w", err)
}
glog.V(1).Infof("OpenBao KMS: Using AppRole authentication")
} else {
return nil, fmt.Errorf("either token or role_id+secret_id must be provided")
}
provider := &OpenBaoKMSProvider{
client: client,
transitPath: transitPath,
address: address,
}
if ttl > 0 {
ctx, stop := context.WithCancel(context.Background())
provider.stopRefresh = stop
provider.refreshDone = make(chan struct{})
go provider.refreshAppRoleToken(ctx, roleID, secretID, loginStart, ttl)
}
glog.V(1).Infof("OpenBao/Vault KMS provider initialized at %s", address)
return provider, nil
}
// authenticateAppRole authenticates using AppRole method and returns the token's TTL
func authenticateAppRole(ctx context.Context, client *vault.Client, roleID, secretID string) (time.Duration, error) {
data := map[string]interface{}{
"role_id": roleID,
"secret_id": secretID,
}
secret, err := client.Logical().WriteWithContext(ctx, "auth/approle/login", data)
if err != nil {
return 0, fmt.Errorf("AppRole authentication failed: %w", err)
}
if secret == nil || secret.Auth == nil {
return 0, fmt.Errorf("AppRole authentication returned empty token")
}
client.SetToken(secret.Auth.ClientToken)
return time.Duration(secret.Auth.LeaseDuration) * time.Second, nil
}
// refreshAppRoleToken logs in again once two thirds of the token's TTL have passed since the
// login that issued it started, and retries a failed login every refreshRetryInterval, until
// ctx is cancelled. Nothing renews an AppRole token, so without this every request fails
// once it expires.
func (p *OpenBaoKMSProvider) refreshAppRoleToken(ctx context.Context, roleID, secretID string, issued time.Time, ttl time.Duration) {
defer close(p.refreshDone)
timeout := p.client.ClientTimeout()
if timeout <= 0 {
timeout = refreshLoginTimeout
}
timer := time.NewTimer(time.Until(issued.Add(ttl * 2 / 3)))
defer timer.Stop()
for {
select {
case <-ctx.Done():
return
case <-timer.C:
}
loginCtx, cancel := context.WithTimeout(ctx, timeout)
issued = time.Now()
newTTL, err := authenticateAppRole(loginCtx, p.client, roleID, secretID)
cancel()
switch {
case err != nil:
if ctx.Err() != nil {
return
}
glog.Warningf("OpenBao KMS: refreshing the AppRole token failed, retrying in %v: %v", refreshRetryInterval, err)
timer.Reset(refreshRetryInterval)
case newTTL <= 0:
return // the new token does not expire
default:
timer.Reset(time.Until(issued.Add(newTTL * 2 / 3)))
}
}
}
// GenerateDataKey generates a new data encryption key using OpenBao/Vault Transit
func (p *OpenBaoKMSProvider) GenerateDataKey(ctx context.Context, req *seaweedkms.GenerateDataKeyRequest) (*seaweedkms.GenerateDataKeyResponse, error) {
if req == nil {
return nil, fmt.Errorf("GenerateDataKeyRequest cannot be nil")
}
if req.KeyID == "" {
return nil, fmt.Errorf("KeyID is required")
}
// Validate key spec
var keySize int
switch req.KeySpec {
case seaweedkms.KeySpecAES256:
keySize = 32 // 256 bits
default:
return nil, fmt.Errorf("unsupported key spec: %s", req.KeySpec)
}
// Generate data key locally (similar to Azure/GCP approach)
dataKey := make([]byte, keySize)
if _, err := rand.Read(dataKey); err != nil {
return nil, fmt.Errorf("failed to generate random data key: %w", err)
}
// Encrypt the data key using OpenBao/Vault Transit
glog.V(4).Infof("OpenBao KMS: Encrypting data key using key %s", req.KeyID)
// Prepare encryption data
encryptData := map[string]interface{}{
"plaintext": base64.StdEncoding.EncodeToString(dataKey),
}
// Add encryption context if provided
if len(req.EncryptionContext) > 0 {
contextJSON, err := json.Marshal(req.EncryptionContext)
if err != nil {
return nil, fmt.Errorf("failed to marshal encryption context: %w", err)
}
encryptData["context"] = base64.StdEncoding.EncodeToString(contextJSON)
}
// Call OpenBao/Vault Transit encrypt endpoint
path := fmt.Sprintf("%s/encrypt/%s", p.transitPath, req.KeyID)
secret, err := p.client.Logical().WriteWithContext(ctx, path, encryptData)
if err != nil {
return nil, p.convertVaultError(err, req.KeyID)
}
if secret == nil || secret.Data == nil {
return nil, fmt.Errorf("no data returned from OpenBao/Vault encrypt operation")
}
ciphertext, ok := secret.Data["ciphertext"].(string)
if !ok {
return nil, fmt.Errorf("invalid ciphertext format from OpenBao/Vault")
}
// Create standardized envelope format for consistent API behavior
envelopeBlob, err := seaweedkms.CreateEnvelope("openbao", req.KeyID, ciphertext, nil)
if err != nil {
return nil, fmt.Errorf("failed to create ciphertext envelope: %w", err)
}
response := &seaweedkms.GenerateDataKeyResponse{
KeyID: req.KeyID,
Plaintext: dataKey,
CiphertextBlob: envelopeBlob, // Store in standardized envelope format
}
glog.V(4).Infof("OpenBao KMS: Generated and encrypted data key using key %s", req.KeyID)
return response, nil
}
// Decrypt decrypts an encrypted data key using OpenBao/Vault Transit
func (p *OpenBaoKMSProvider) Decrypt(ctx context.Context, req *seaweedkms.DecryptRequest) (*seaweedkms.DecryptResponse, error) {
if req == nil {
return nil, fmt.Errorf("DecryptRequest cannot be nil")
}
if len(req.CiphertextBlob) == 0 {
return nil, fmt.Errorf("CiphertextBlob cannot be empty")
}
// Parse the ciphertext envelope to extract key information
envelope, err := seaweedkms.ParseEnvelope(req.CiphertextBlob)
if err != nil {
return nil, fmt.Errorf("failed to parse ciphertext envelope: %w", err)
}
keyID := envelope.KeyID
if keyID == "" {
return nil, fmt.Errorf("envelope missing key ID")
}
// Use the ciphertext from envelope
ciphertext := envelope.Ciphertext
// Prepare decryption data
decryptData := map[string]interface{}{
"ciphertext": ciphertext,
}
// Add encryption context if provided
if len(req.EncryptionContext) > 0 {
contextJSON, err := json.Marshal(req.EncryptionContext)
if err != nil {
return nil, fmt.Errorf("failed to marshal encryption context: %w", err)
}
decryptData["context"] = base64.StdEncoding.EncodeToString(contextJSON)
}
// Call OpenBao/Vault Transit decrypt endpoint
path := fmt.Sprintf("%s/decrypt/%s", p.transitPath, keyID)
glog.V(4).Infof("OpenBao KMS: Decrypting data key using key %s", keyID)
secret, err := p.client.Logical().WriteWithContext(ctx, path, decryptData)
if err != nil {
return nil, p.convertVaultError(err, keyID)
}
if secret == nil || secret.Data == nil {
return nil, fmt.Errorf("no data returned from OpenBao/Vault decrypt operation")
}
plaintextB64, ok := secret.Data["plaintext"].(string)
if !ok {
return nil, fmt.Errorf("invalid plaintext format from OpenBao/Vault")
}
plaintext, err := base64.StdEncoding.DecodeString(plaintextB64)
if err != nil {
return nil, fmt.Errorf("failed to decode plaintext from OpenBao/Vault: %w", err)
}
response := &seaweedkms.DecryptResponse{
KeyID: keyID,
Plaintext: plaintext,
}
glog.V(4).Infof("OpenBao KMS: Decrypted data key using key %s", keyID)
return response, nil
}
// DescribeKey validates that a key exists and returns its metadata
func (p *OpenBaoKMSProvider) DescribeKey(ctx context.Context, req *seaweedkms.DescribeKeyRequest) (*seaweedkms.DescribeKeyResponse, error) {
if req == nil {
return nil, fmt.Errorf("DescribeKeyRequest cannot be nil")
}
if req.KeyID == "" {
return nil, fmt.Errorf("KeyID is required")
}
// Get key information from OpenBao/Vault
path := fmt.Sprintf("%s/keys/%s", p.transitPath, req.KeyID)
glog.V(4).Infof("OpenBao KMS: Describing key %s", req.KeyID)
secret, err := p.client.Logical().ReadWithContext(ctx, path)
if err != nil {
return nil, p.convertVaultError(err, req.KeyID)
}
if secret == nil || secret.Data == nil {
return nil, &seaweedkms.KMSError{
Code: seaweedkms.ErrCodeNotFoundException,
Message: fmt.Sprintf("Key not found: %s", req.KeyID),
KeyID: req.KeyID,
}
}
response := &seaweedkms.DescribeKeyResponse{
KeyID: req.KeyID,
ARN: fmt.Sprintf("openbao:%s:key:%s", p.address, req.KeyID),
Description: "OpenBao/Vault Transit engine key",
}
// Check key type and set usage
if keyType, ok := secret.Data["type"].(string); ok {
if keyType == "aes256-gcm96" || keyType == "aes128-gcm96" || keyType == "chacha20-poly1305" {
response.KeyUsage = seaweedkms.KeyUsageEncryptDecrypt
} else {
// Default to data key generation if not an encrypt/decrypt type
response.KeyUsage = seaweedkms.KeyUsageGenerateDataKey
}
} else {
// If type is missing, default to data key generation
response.KeyUsage = seaweedkms.KeyUsageGenerateDataKey
}
// OpenBao/Vault keys are enabled by default (no disabled state in transit)
response.KeyState = seaweedkms.KeyStateEnabled
// Keys in OpenBao/Vault transit are service-managed
response.Origin = seaweedkms.KeyOriginOpenBao
glog.V(4).Infof("OpenBao KMS: Described key %s (state: %s)", req.KeyID, response.KeyState)
return response, nil
}
// GetKeyID resolves a key name (already the full key ID in OpenBao/Vault)
func (p *OpenBaoKMSProvider) GetKeyID(ctx context.Context, keyIdentifier string) (string, error) {
if keyIdentifier == "" {
return "", fmt.Errorf("key identifier cannot be empty")
}
// Use DescribeKey to validate the key exists
descReq := &seaweedkms.DescribeKeyRequest{KeyID: keyIdentifier}
descResp, err := p.DescribeKey(ctx, descReq)
if err != nil {
return "", fmt.Errorf("failed to resolve key identifier %s: %w", keyIdentifier, err)
}
return descResp.KeyID, nil
}
// Close cleans up any resources used by the provider
func (p *OpenBaoKMSProvider) Close() error {
if p.stopRefresh != nil {
p.stopRefresh()
<-p.refreshDone
}
glog.V(2).Infof("OpenBao/Vault KMS provider closed")
return nil
}
// convertVaultError converts OpenBao/Vault errors to our standard KMS errors
func (p *OpenBaoKMSProvider) convertVaultError(err error, keyID string) error {
errMsg := err.Error()
if strings.Contains(errMsg, "not found") || strings.Contains(errMsg, "no handler") {
return &seaweedkms.KMSError{
Code: seaweedkms.ErrCodeNotFoundException,
Message: fmt.Sprintf("Key not found in OpenBao/Vault: %v", err),
KeyID: keyID,
}
}
if strings.Contains(errMsg, "permission") || strings.Contains(errMsg, "denied") || strings.Contains(errMsg, "forbidden") {
return &seaweedkms.KMSError{
Code: seaweedkms.ErrCodeAccessDenied,
Message: fmt.Sprintf("Access denied to OpenBao/Vault: %v", err),
KeyID: keyID,
}
}
if strings.Contains(errMsg, "disabled") || strings.Contains(errMsg, "unavailable") {
return &seaweedkms.KMSError{
Code: seaweedkms.ErrCodeKeyUnavailable,
Message: fmt.Sprintf("Key unavailable in OpenBao/Vault: %v", err),
KeyID: keyID,
}
}
// For unknown errors, wrap as internal failure
return &seaweedkms.KMSError{
Code: seaweedkms.ErrCodeKMSInternalFailure,
Message: fmt.Sprintf("OpenBao/Vault error: %v", err),
KeyID: keyID,
}
}