open-vault/sdk/framework/wal.go

102 lines
2.5 KiB
Go
Raw Normal View History

package framework
2015-03-18 00:03:00 +00:00
import (
"context"
2015-03-18 00:03:00 +00:00
"encoding/json"
"strings"
"time"
uuid "github.com/hashicorp/go-uuid"
"github.com/hashicorp/vault/sdk/helper/jsonutil"
"github.com/hashicorp/vault/sdk/logical"
2015-03-18 00:03:00 +00:00
)
// WALPrefix is the prefix within Storage where WAL entries will be written.
const WALPrefix = "wal/"
type WALEntry struct {
ID string `json:"-"`
Kind string `json:"type"`
Data interface{} `json:"data"`
CreatedAt int64 `json:"created_at"`
}
2015-03-18 00:03:00 +00:00
// PutWAL writes some data to the WAL.
//
// The kind parameter is used by the framework to allow users to store
// multiple kinds of WAL data and to easily disambiguate what data they're
// expecting.
//
2015-03-18 00:03:00 +00:00
// Data within the WAL that is uncommitted (CommitWAL hasn't be called)
// will be given to the rollback callback when an rollback operation is
// received, allowing the backend to clean up some partial states.
//
// The data must be JSON encodable.
//
// This returns a unique ID that can be used to reference this WAL data.
// WAL data cannot be modified. You can only add to the WAL and commit existing
// WAL entries.
func PutWAL(ctx context.Context, s logical.Storage, kind string, data interface{}) (string, error) {
value, err := json.Marshal(&WALEntry{
Kind: kind,
Data: data,
CreatedAt: time.Now().UTC().Unix(),
})
2015-03-18 00:03:00 +00:00
if err != nil {
return "", err
}
id, err := uuid.GenerateUUID()
2015-03-18 00:03:00 +00:00
if err != nil {
return "", err
}
return id, s.Put(ctx, &logical.StorageEntry{
2015-03-18 00:03:00 +00:00
Key: WALPrefix + id,
Value: value,
})
}
// GetWAL reads a specific entry from the WAL. If the entry doesn't exist,
// then nil value is returned.
//
// The kind, value, and error are returned.
func GetWAL(ctx context.Context, s logical.Storage, id string) (*WALEntry, error) {
entry, err := s.Get(ctx, WALPrefix+id)
2015-03-18 00:03:00 +00:00
if err != nil {
return nil, err
2015-03-18 00:03:00 +00:00
}
if entry == nil {
return nil, nil
2015-03-18 00:03:00 +00:00
}
var raw WALEntry
if err := jsonutil.DecodeJSON(entry.Value, &raw); err != nil {
return nil, err
2015-03-18 00:03:00 +00:00
}
raw.ID = id
2015-03-18 00:03:00 +00:00
return &raw, nil
2015-03-18 00:03:00 +00:00
}
2016-05-15 16:58:36 +00:00
// DeleteWAL commits the WAL entry with the given ID. Once committed,
2015-03-18 00:03:00 +00:00
// it is assumed that the operation was a success and doesn't need to
// be rolled back.
func DeleteWAL(ctx context.Context, s logical.Storage, id string) error {
return s.Delete(ctx, WALPrefix+id)
2015-03-18 00:03:00 +00:00
}
// ListWAL lists all the entries in the WAL.
func ListWAL(ctx context.Context, s logical.Storage) ([]string, error) {
keys, err := s.List(ctx, WALPrefix)
2015-03-18 00:03:00 +00:00
if err != nil {
return nil, err
}
for i, k := range keys {
keys[i] = strings.TrimPrefix(k, WALPrefix)
}
return keys, nil
}