2015-03-12 19:44:22 +00:00
|
|
|
package vault
|
|
|
|
|
2015-03-13 17:55:54 +00:00
|
|
|
import (
|
|
|
|
"encoding/json"
|
|
|
|
"fmt"
|
|
|
|
"path"
|
2015-03-16 18:33:59 +00:00
|
|
|
"strings"
|
2015-03-13 18:31:43 +00:00
|
|
|
"sync"
|
2015-03-13 17:55:54 +00:00
|
|
|
"time"
|
2015-03-15 20:52:43 +00:00
|
|
|
|
2016-12-16 20:29:27 +00:00
|
|
|
"github.com/armon/go-metrics"
|
2016-08-19 20:45:17 +00:00
|
|
|
log "github.com/mgutz/logxi/v1"
|
|
|
|
|
2015-12-16 17:56:20 +00:00
|
|
|
"github.com/hashicorp/go-uuid"
|
2016-07-06 16:25:40 +00:00
|
|
|
"github.com/hashicorp/vault/helper/jsonutil"
|
2015-03-15 20:52:43 +00:00
|
|
|
"github.com/hashicorp/vault/logical"
|
2015-03-13 17:55:54 +00:00
|
|
|
)
|
2015-03-13 01:38:15 +00:00
|
|
|
|
2015-03-12 19:44:22 +00:00
|
|
|
const (
|
|
|
|
// expirationSubPath is the sub-path used for the expiration manager
|
|
|
|
// view. This is nested under the system view.
|
|
|
|
expirationSubPath = "expire/"
|
2015-03-16 18:33:59 +00:00
|
|
|
|
2015-04-10 21:21:23 +00:00
|
|
|
// leaseViewPrefix is the prefix used for the ID based lookup of leases.
|
|
|
|
leaseViewPrefix = "id/"
|
|
|
|
|
|
|
|
// tokenViewPrefix is the prefix used for the token based lookup of leases.
|
|
|
|
tokenViewPrefix = "token/"
|
|
|
|
|
2015-03-16 18:33:59 +00:00
|
|
|
// maxRevokeAttempts limits how many revoke attempts are made
|
|
|
|
maxRevokeAttempts = 6
|
|
|
|
|
|
|
|
// revokeRetryBase is a baseline retry time
|
|
|
|
revokeRetryBase = 10 * time.Second
|
|
|
|
|
|
|
|
// minRevokeDelay is used to prevent an instant revoke on restore
|
|
|
|
minRevokeDelay = 5 * time.Second
|
2015-04-03 00:45:42 +00:00
|
|
|
|
2015-07-30 13:42:49 +00:00
|
|
|
// maxLeaseDuration is the default maximum lease duration
|
2016-09-28 22:32:49 +00:00
|
|
|
maxLeaseTTL = 32 * 24 * time.Hour
|
2015-04-03 00:45:42 +00:00
|
|
|
|
2015-07-30 13:42:49 +00:00
|
|
|
// defaultLeaseDuration is the default lease duration used when no lease is specified
|
2015-08-27 14:50:16 +00:00
|
|
|
defaultLeaseTTL = maxLeaseTTL
|
2015-03-12 19:44:22 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
// ExpirationManager is used by the Core to manage leases. Secrets
|
|
|
|
// can provide a lease, meaning that they can be renewed or revoked.
|
|
|
|
// If a secret is not renewed in timely manner, it may be expired, and
|
|
|
|
// the ExpirationManager will handle doing automatic revocation.
|
|
|
|
type ExpirationManager struct {
|
2015-03-24 01:00:14 +00:00
|
|
|
router *Router
|
2015-04-10 21:21:23 +00:00
|
|
|
idView *BarrierView
|
|
|
|
tokenView *BarrierView
|
2015-03-24 01:00:14 +00:00
|
|
|
tokenStore *TokenStore
|
2016-08-19 20:45:17 +00:00
|
|
|
logger log.Logger
|
2015-03-16 01:06:19 +00:00
|
|
|
|
|
|
|
pending map[string]*time.Timer
|
2015-03-16 18:33:59 +00:00
|
|
|
pendingLock sync.Mutex
|
2015-03-12 19:44:22 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// NewExpirationManager creates a new ExpirationManager that is backed
|
2015-03-13 01:38:15 +00:00
|
|
|
// using a given view, and uses the provided router for revocation.
|
2016-08-19 20:45:17 +00:00
|
|
|
func NewExpirationManager(router *Router, view *BarrierView, ts *TokenStore, logger log.Logger) *ExpirationManager {
|
2015-03-16 01:06:19 +00:00
|
|
|
if logger == nil {
|
2016-08-19 20:45:17 +00:00
|
|
|
logger = log.New("expiration_manager")
|
|
|
|
|
2015-03-16 01:06:19 +00:00
|
|
|
}
|
2015-03-12 19:44:22 +00:00
|
|
|
exp := &ExpirationManager{
|
2015-03-24 01:00:14 +00:00
|
|
|
router: router,
|
2015-04-10 21:21:23 +00:00
|
|
|
idView: view.SubView(leaseViewPrefix),
|
|
|
|
tokenView: view.SubView(tokenViewPrefix),
|
2015-03-24 01:00:14 +00:00
|
|
|
tokenStore: ts,
|
|
|
|
logger: logger,
|
|
|
|
pending: make(map[string]*time.Timer),
|
2015-03-12 19:44:22 +00:00
|
|
|
}
|
|
|
|
return exp
|
|
|
|
}
|
|
|
|
|
|
|
|
// setupExpiration is invoked after we've loaded the mount table to
|
|
|
|
// initialize the expiration manager
|
|
|
|
func (c *Core) setupExpiration() error {
|
2015-10-12 20:33:54 +00:00
|
|
|
c.metricsMutex.Lock()
|
|
|
|
defer c.metricsMutex.Unlock()
|
2015-03-12 19:44:22 +00:00
|
|
|
// Create a sub-view
|
2015-09-04 20:58:12 +00:00
|
|
|
view := c.systemBarrierView.SubView(expirationSubPath)
|
2015-03-12 19:44:22 +00:00
|
|
|
|
|
|
|
// Create the manager
|
2015-03-24 01:00:14 +00:00
|
|
|
mgr := NewExpirationManager(c.router, view, c.tokenStore, c.logger)
|
2015-03-12 19:44:22 +00:00
|
|
|
c.expiration = mgr
|
2015-03-13 18:20:36 +00:00
|
|
|
|
2015-04-03 18:40:08 +00:00
|
|
|
// Link the token store to this
|
|
|
|
c.tokenStore.SetExpirationManager(mgr)
|
|
|
|
|
2015-03-13 18:20:36 +00:00
|
|
|
// Restore the existing state
|
|
|
|
if err := c.expiration.Restore(); err != nil {
|
|
|
|
return fmt.Errorf("expiration state restore failed: %v", err)
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// stopExpiration is used to stop the expiration manager before
|
|
|
|
// sealing the Vault.
|
|
|
|
func (c *Core) stopExpiration() error {
|
2015-04-14 20:32:56 +00:00
|
|
|
if c.expiration != nil {
|
|
|
|
if err := c.expiration.Stop(); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2015-10-12 20:33:54 +00:00
|
|
|
c.metricsMutex.Lock()
|
|
|
|
defer c.metricsMutex.Unlock()
|
2015-04-14 20:32:56 +00:00
|
|
|
c.expiration = nil
|
2015-03-13 18:20:36 +00:00
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// Restore is used to recover the lease states when starting.
|
|
|
|
// This is used after starting the vault.
|
|
|
|
func (m *ExpirationManager) Restore() error {
|
2015-03-16 18:33:59 +00:00
|
|
|
m.pendingLock.Lock()
|
|
|
|
defer m.pendingLock.Unlock()
|
|
|
|
|
|
|
|
// Accumulate existing leases
|
2017-01-06 20:42:18 +00:00
|
|
|
existing, err := logical.CollectKeys(m.idView)
|
2015-03-18 19:03:33 +00:00
|
|
|
if err != nil {
|
2015-03-16 18:33:59 +00:00
|
|
|
return fmt.Errorf("failed to scan for leases: %v", err)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Restore each key
|
2015-04-08 20:35:32 +00:00
|
|
|
for _, leaseID := range existing {
|
2015-03-16 18:33:59 +00:00
|
|
|
// Load the entry
|
2015-04-08 20:35:32 +00:00
|
|
|
le, err := m.loadEntry(leaseID)
|
2015-03-16 18:33:59 +00:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
// If there is no entry, nothing to restore
|
|
|
|
if le == nil {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
|
2015-04-01 04:01:12 +00:00
|
|
|
// If there is no expiry time, don't do anything
|
|
|
|
if le.ExpireTime.IsZero() {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
|
2015-03-16 18:33:59 +00:00
|
|
|
// Determine the remaining time to expiration
|
2016-07-07 21:44:14 +00:00
|
|
|
expires := le.ExpireTime.Sub(time.Now())
|
2015-03-16 18:33:59 +00:00
|
|
|
if expires <= 0 {
|
|
|
|
expires = minRevokeDelay
|
|
|
|
}
|
|
|
|
|
|
|
|
// Setup revocation timer
|
2015-04-08 20:35:32 +00:00
|
|
|
m.pending[le.LeaseID] = time.AfterFunc(expires, func() {
|
|
|
|
m.expireID(le.LeaseID)
|
2015-03-16 18:33:59 +00:00
|
|
|
})
|
|
|
|
}
|
2015-03-24 00:27:46 +00:00
|
|
|
if len(m.pending) > 0 {
|
2016-08-19 20:45:17 +00:00
|
|
|
if m.logger.IsInfo() {
|
|
|
|
m.logger.Info("expire: leases restored", "restored_lease_count", len(m.pending))
|
|
|
|
}
|
2015-03-24 00:27:46 +00:00
|
|
|
}
|
2015-03-13 18:20:36 +00:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// Stop is used to prevent further automatic revocations.
|
|
|
|
// This must be called before sealing the view.
|
|
|
|
func (m *ExpirationManager) Stop() error {
|
2015-03-16 01:06:19 +00:00
|
|
|
// Stop all the pending expiration timers
|
|
|
|
m.pendingLock.Lock()
|
|
|
|
for _, timer := range m.pending {
|
|
|
|
timer.Stop()
|
2015-03-13 18:31:43 +00:00
|
|
|
}
|
2015-03-16 01:06:19 +00:00
|
|
|
m.pending = make(map[string]*time.Timer)
|
|
|
|
m.pendingLock.Unlock()
|
2015-03-12 19:44:22 +00:00
|
|
|
return nil
|
|
|
|
}
|
2015-03-13 01:38:15 +00:00
|
|
|
|
2015-04-08 20:35:32 +00:00
|
|
|
// Revoke is used to revoke a secret named by the given LeaseID
|
|
|
|
func (m *ExpirationManager) Revoke(leaseID string) error {
|
2015-04-08 23:43:17 +00:00
|
|
|
defer metrics.MeasureSince([]string{"expire", "revoke"}, time.Now())
|
Add forced revocation.
In some situations, it can be impossible to revoke leases (for instance,
if someone has gone and manually removed users created by Vault). This
can not only cause Vault to cycle trying to revoke them, but it also
prevents mounts from being unmounted, leaving them in a tainted state
where the only operations allowed are to revoke (or rollback), which
will never successfully complete.
This adds a new endpoint that works similarly to `revoke-prefix` but
ignores errors coming from a backend upon revocation (it does not ignore
errors coming from within the expiration manager, such as errors
accessing the data store). This can be used to force Vault to abandon
leases.
Like `revoke-prefix`, this is a very sensitive operation and requires
`sudo`. It is implemented as a separate endpoint, rather than an
argument to `revoke-prefix`, to ensure that control can be delegated
appropriately, as even most administrators should not normally have
this privilege.
Fixes #1135
2016-03-03 01:26:38 +00:00
|
|
|
|
2016-03-31 19:10:25 +00:00
|
|
|
return m.revokeCommon(leaseID, false, false)
|
Add forced revocation.
In some situations, it can be impossible to revoke leases (for instance,
if someone has gone and manually removed users created by Vault). This
can not only cause Vault to cycle trying to revoke them, but it also
prevents mounts from being unmounted, leaving them in a tainted state
where the only operations allowed are to revoke (or rollback), which
will never successfully complete.
This adds a new endpoint that works similarly to `revoke-prefix` but
ignores errors coming from a backend upon revocation (it does not ignore
errors coming from within the expiration manager, such as errors
accessing the data store). This can be used to force Vault to abandon
leases.
Like `revoke-prefix`, this is a very sensitive operation and requires
`sudo`. It is implemented as a separate endpoint, rather than an
argument to `revoke-prefix`, to ensure that control can be delegated
appropriately, as even most administrators should not normally have
this privilege.
Fixes #1135
2016-03-03 01:26:38 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// revokeCommon does the heavy lifting. If force is true, we ignore a problem
|
|
|
|
// during revocation and still remove entries/index/lease timers
|
2016-03-31 19:10:25 +00:00
|
|
|
func (m *ExpirationManager) revokeCommon(leaseID string, force, skipToken bool) error {
|
Add forced revocation.
In some situations, it can be impossible to revoke leases (for instance,
if someone has gone and manually removed users created by Vault). This
can not only cause Vault to cycle trying to revoke them, but it also
prevents mounts from being unmounted, leaving them in a tainted state
where the only operations allowed are to revoke (or rollback), which
will never successfully complete.
This adds a new endpoint that works similarly to `revoke-prefix` but
ignores errors coming from a backend upon revocation (it does not ignore
errors coming from within the expiration manager, such as errors
accessing the data store). This can be used to force Vault to abandon
leases.
Like `revoke-prefix`, this is a very sensitive operation and requires
`sudo`. It is implemented as a separate endpoint, rather than an
argument to `revoke-prefix`, to ensure that control can be delegated
appropriately, as even most administrators should not normally have
this privilege.
Fixes #1135
2016-03-03 01:26:38 +00:00
|
|
|
defer metrics.MeasureSince([]string{"expire", "revoke-common"}, time.Now())
|
2015-03-16 18:33:59 +00:00
|
|
|
// Load the entry
|
2015-04-08 20:35:32 +00:00
|
|
|
le, err := m.loadEntry(leaseID)
|
2015-03-16 18:33:59 +00:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
// If there is no entry, nothing to revoke
|
|
|
|
if le == nil {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// Revoke the entry
|
2016-03-31 19:10:25 +00:00
|
|
|
if !skipToken || le.Auth == nil {
|
|
|
|
if err := m.revokeEntry(le); err != nil {
|
|
|
|
if !force {
|
|
|
|
return err
|
|
|
|
} else {
|
2016-08-19 20:45:17 +00:00
|
|
|
if m.logger.IsWarn() {
|
|
|
|
m.logger.Warn("revocation from the backend failed, but in force mode so ignoring", "error", err)
|
|
|
|
}
|
2016-03-31 19:10:25 +00:00
|
|
|
}
|
2016-03-08 16:05:46 +00:00
|
|
|
}
|
2015-03-16 18:33:59 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Delete the entry
|
2015-04-08 20:35:32 +00:00
|
|
|
if err := m.deleteEntry(leaseID); err != nil {
|
2015-03-16 18:33:59 +00:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2016-12-16 18:11:55 +00:00
|
|
|
// Delete the secondary index, but only if it's a leased secret (not auth)
|
|
|
|
if le.Secret != nil {
|
|
|
|
if err := m.removeIndexByToken(le.ClientToken, le.LeaseID); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2015-04-10 21:48:08 +00:00
|
|
|
}
|
|
|
|
|
2015-03-16 18:33:59 +00:00
|
|
|
// Clear the expiration handler
|
|
|
|
m.pendingLock.Lock()
|
2015-04-08 20:35:32 +00:00
|
|
|
if timer, ok := m.pending[leaseID]; ok {
|
2015-03-16 18:33:59 +00:00
|
|
|
timer.Stop()
|
2015-04-08 20:35:32 +00:00
|
|
|
delete(m.pending, leaseID)
|
2015-03-16 18:33:59 +00:00
|
|
|
}
|
|
|
|
m.pendingLock.Unlock()
|
2015-03-13 01:38:15 +00:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
Add forced revocation.
In some situations, it can be impossible to revoke leases (for instance,
if someone has gone and manually removed users created by Vault). This
can not only cause Vault to cycle trying to revoke them, but it also
prevents mounts from being unmounted, leaving them in a tainted state
where the only operations allowed are to revoke (or rollback), which
will never successfully complete.
This adds a new endpoint that works similarly to `revoke-prefix` but
ignores errors coming from a backend upon revocation (it does not ignore
errors coming from within the expiration manager, such as errors
accessing the data store). This can be used to force Vault to abandon
leases.
Like `revoke-prefix`, this is a very sensitive operation and requires
`sudo`. It is implemented as a separate endpoint, rather than an
argument to `revoke-prefix`, to ensure that control can be delegated
appropriately, as even most administrators should not normally have
this privilege.
Fixes #1135
2016-03-03 01:26:38 +00:00
|
|
|
// RevokeForce works similarly to RevokePrefix but continues in the case of a
|
|
|
|
// revocation error; this is mostly meant for recovery operations
|
|
|
|
func (m *ExpirationManager) RevokeForce(prefix string) error {
|
|
|
|
defer metrics.MeasureSince([]string{"expire", "revoke-force"}, time.Now())
|
|
|
|
|
|
|
|
return m.revokePrefixCommon(prefix, true)
|
|
|
|
}
|
|
|
|
|
2015-03-13 01:38:15 +00:00
|
|
|
// RevokePrefix is used to revoke all secrets with a given prefix.
|
|
|
|
// The prefix maps to that of the mount table to make this simpler
|
|
|
|
// to reason about.
|
|
|
|
func (m *ExpirationManager) RevokePrefix(prefix string) error {
|
2015-04-08 23:43:17 +00:00
|
|
|
defer metrics.MeasureSince([]string{"expire", "revoke-prefix"}, time.Now())
|
2015-03-16 21:59:37 +00:00
|
|
|
|
Add forced revocation.
In some situations, it can be impossible to revoke leases (for instance,
if someone has gone and manually removed users created by Vault). This
can not only cause Vault to cycle trying to revoke them, but it also
prevents mounts from being unmounted, leaving them in a tainted state
where the only operations allowed are to revoke (or rollback), which
will never successfully complete.
This adds a new endpoint that works similarly to `revoke-prefix` but
ignores errors coming from a backend upon revocation (it does not ignore
errors coming from within the expiration manager, such as errors
accessing the data store). This can be used to force Vault to abandon
leases.
Like `revoke-prefix`, this is a very sensitive operation and requires
`sudo`. It is implemented as a separate endpoint, rather than an
argument to `revoke-prefix`, to ensure that control can be delegated
appropriately, as even most administrators should not normally have
this privilege.
Fixes #1135
2016-03-03 01:26:38 +00:00
|
|
|
return m.revokePrefixCommon(prefix, false)
|
|
|
|
}
|
|
|
|
|
2016-03-31 19:10:25 +00:00
|
|
|
// RevokeByToken is used to revoke all the secrets issued with a given token.
|
|
|
|
// This is done by using the secondary index. It also removes the lease entry
|
|
|
|
// for the token itself. As a result it should *ONLY* ever be called from the
|
|
|
|
// token store's revokeSalted function.
|
|
|
|
func (m *ExpirationManager) RevokeByToken(te *TokenEntry) error {
|
Add forced revocation.
In some situations, it can be impossible to revoke leases (for instance,
if someone has gone and manually removed users created by Vault). This
can not only cause Vault to cycle trying to revoke them, but it also
prevents mounts from being unmounted, leaving them in a tainted state
where the only operations allowed are to revoke (or rollback), which
will never successfully complete.
This adds a new endpoint that works similarly to `revoke-prefix` but
ignores errors coming from a backend upon revocation (it does not ignore
errors coming from within the expiration manager, such as errors
accessing the data store). This can be used to force Vault to abandon
leases.
Like `revoke-prefix`, this is a very sensitive operation and requires
`sudo`. It is implemented as a separate endpoint, rather than an
argument to `revoke-prefix`, to ensure that control can be delegated
appropriately, as even most administrators should not normally have
this privilege.
Fixes #1135
2016-03-03 01:26:38 +00:00
|
|
|
defer metrics.MeasureSince([]string{"expire", "revoke-by-token"}, time.Now())
|
|
|
|
// Lookup the leases
|
2016-03-31 19:10:25 +00:00
|
|
|
existing, err := m.lookupByToken(te.ID)
|
2015-03-18 19:03:33 +00:00
|
|
|
if err != nil {
|
2015-03-16 18:33:59 +00:00
|
|
|
return fmt.Errorf("failed to scan for leases: %v", err)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Revoke all the keys
|
Add forced revocation.
In some situations, it can be impossible to revoke leases (for instance,
if someone has gone and manually removed users created by Vault). This
can not only cause Vault to cycle trying to revoke them, but it also
prevents mounts from being unmounted, leaving them in a tainted state
where the only operations allowed are to revoke (or rollback), which
will never successfully complete.
This adds a new endpoint that works similarly to `revoke-prefix` but
ignores errors coming from a backend upon revocation (it does not ignore
errors coming from within the expiration manager, such as errors
accessing the data store). This can be used to force Vault to abandon
leases.
Like `revoke-prefix`, this is a very sensitive operation and requires
`sudo`. It is implemented as a separate endpoint, rather than an
argument to `revoke-prefix`, to ensure that control can be delegated
appropriately, as even most administrators should not normally have
this privilege.
Fixes #1135
2016-03-03 01:26:38 +00:00
|
|
|
for idx, leaseID := range existing {
|
2015-04-08 20:35:32 +00:00
|
|
|
if err := m.Revoke(leaseID); err != nil {
|
2015-03-16 18:33:59 +00:00
|
|
|
return fmt.Errorf("failed to revoke '%s' (%d / %d): %v",
|
2015-04-08 20:35:32 +00:00
|
|
|
leaseID, idx+1, len(existing), err)
|
2015-03-16 18:33:59 +00:00
|
|
|
}
|
|
|
|
}
|
2016-03-31 19:10:25 +00:00
|
|
|
|
2016-12-16 20:29:27 +00:00
|
|
|
if te.Path != "" {
|
|
|
|
tokenLeaseID := path.Join(te.Path, m.tokenStore.SaltID(te.ID))
|
|
|
|
|
|
|
|
// We want to skip the revokeEntry call as that will call back into
|
|
|
|
// revocation logic in the token store, which is what is running this
|
|
|
|
// function in the first place -- it'd be a deadlock loop. Since the only
|
|
|
|
// place that this function is called is revokeSalted in the token store,
|
|
|
|
// we're already revoking the token, so we just want to clean up the lease.
|
|
|
|
// This avoids spurious revocations later in the log when the timer runs
|
|
|
|
// out, and eases up resource usage.
|
|
|
|
return m.revokeCommon(tokenLeaseID, false, true)
|
|
|
|
}
|
2016-03-31 19:10:25 +00:00
|
|
|
|
2016-12-16 20:29:27 +00:00
|
|
|
return nil
|
2015-03-13 01:38:15 +00:00
|
|
|
}
|
|
|
|
|
Add forced revocation.
In some situations, it can be impossible to revoke leases (for instance,
if someone has gone and manually removed users created by Vault). This
can not only cause Vault to cycle trying to revoke them, but it also
prevents mounts from being unmounted, leaving them in a tainted state
where the only operations allowed are to revoke (or rollback), which
will never successfully complete.
This adds a new endpoint that works similarly to `revoke-prefix` but
ignores errors coming from a backend upon revocation (it does not ignore
errors coming from within the expiration manager, such as errors
accessing the data store). This can be used to force Vault to abandon
leases.
Like `revoke-prefix`, this is a very sensitive operation and requires
`sudo`. It is implemented as a separate endpoint, rather than an
argument to `revoke-prefix`, to ensure that control can be delegated
appropriately, as even most administrators should not normally have
this privilege.
Fixes #1135
2016-03-03 01:26:38 +00:00
|
|
|
func (m *ExpirationManager) revokePrefixCommon(prefix string, force bool) error {
|
|
|
|
// Ensure there is a trailing slash
|
|
|
|
if !strings.HasSuffix(prefix, "/") {
|
|
|
|
prefix = prefix + "/"
|
|
|
|
}
|
|
|
|
|
|
|
|
// Accumulate existing leases
|
|
|
|
sub := m.idView.SubView(prefix)
|
2017-01-06 20:42:18 +00:00
|
|
|
existing, err := logical.CollectKeys(sub)
|
2015-04-10 21:48:08 +00:00
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("failed to scan for leases: %v", err)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Revoke all the keys
|
Add forced revocation.
In some situations, it can be impossible to revoke leases (for instance,
if someone has gone and manually removed users created by Vault). This
can not only cause Vault to cycle trying to revoke them, but it also
prevents mounts from being unmounted, leaving them in a tainted state
where the only operations allowed are to revoke (or rollback), which
will never successfully complete.
This adds a new endpoint that works similarly to `revoke-prefix` but
ignores errors coming from a backend upon revocation (it does not ignore
errors coming from within the expiration manager, such as errors
accessing the data store). This can be used to force Vault to abandon
leases.
Like `revoke-prefix`, this is a very sensitive operation and requires
`sudo`. It is implemented as a separate endpoint, rather than an
argument to `revoke-prefix`, to ensure that control can be delegated
appropriately, as even most administrators should not normally have
this privilege.
Fixes #1135
2016-03-03 01:26:38 +00:00
|
|
|
for idx, suffix := range existing {
|
|
|
|
leaseID := prefix + suffix
|
2016-03-31 19:10:25 +00:00
|
|
|
if err := m.revokeCommon(leaseID, force, false); err != nil {
|
2015-04-10 21:48:08 +00:00
|
|
|
return fmt.Errorf("failed to revoke '%s' (%d / %d): %v",
|
|
|
|
leaseID, idx+1, len(existing), err)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2015-04-08 20:35:32 +00:00
|
|
|
// Renew is used to renew a secret using the given leaseID
|
2015-03-13 01:38:15 +00:00
|
|
|
// and a renew interval. The increment may be ignored.
|
2015-04-08 20:35:32 +00:00
|
|
|
func (m *ExpirationManager) Renew(leaseID string, increment time.Duration) (*logical.Response, error) {
|
2015-04-08 23:43:17 +00:00
|
|
|
defer metrics.MeasureSince([]string{"expire", "renew"}, time.Now())
|
2015-03-16 18:33:59 +00:00
|
|
|
// Load the entry
|
2015-04-08 20:35:32 +00:00
|
|
|
le, err := m.loadEntry(leaseID)
|
2015-03-16 18:33:59 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
2015-04-09 21:23:37 +00:00
|
|
|
// Check if the lease is renewable
|
|
|
|
if err := le.renewable(); err != nil {
|
|
|
|
return nil, err
|
2015-04-09 00:03:46 +00:00
|
|
|
}
|
|
|
|
|
2015-03-16 20:29:51 +00:00
|
|
|
// Attempt to renew the entry
|
2015-03-16 21:59:37 +00:00
|
|
|
resp, err := m.renewEntry(le, increment)
|
2015-03-16 20:29:51 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
2015-03-16 18:33:59 +00:00
|
|
|
}
|
|
|
|
|
2015-03-16 20:29:51 +00:00
|
|
|
// Fast-path if there is no lease
|
2015-04-09 19:29:13 +00:00
|
|
|
if resp == nil || resp.Secret == nil || !resp.Secret.LeaseEnabled() {
|
2015-03-16 20:29:51 +00:00
|
|
|
return resp, nil
|
2015-03-16 18:33:59 +00:00
|
|
|
}
|
|
|
|
|
2015-03-16 20:29:51 +00:00
|
|
|
// Validate the lease
|
2015-03-19 22:11:42 +00:00
|
|
|
if err := resp.Secret.Validate(); err != nil {
|
2015-03-16 20:29:51 +00:00
|
|
|
return nil, err
|
2015-03-16 18:33:59 +00:00
|
|
|
}
|
|
|
|
|
2015-04-08 20:35:32 +00:00
|
|
|
// Attach the LeaseID
|
|
|
|
resp.Secret.LeaseID = leaseID
|
2015-03-16 23:11:55 +00:00
|
|
|
|
2015-03-16 18:33:59 +00:00
|
|
|
// Update the lease entry
|
2015-03-16 20:29:51 +00:00
|
|
|
le.Data = resp.Data
|
2015-03-19 22:11:42 +00:00
|
|
|
le.Secret = resp.Secret
|
2015-04-09 19:29:13 +00:00
|
|
|
le.ExpireTime = resp.Secret.ExpirationTime()
|
2016-07-07 21:44:14 +00:00
|
|
|
le.LastRenewalTime = time.Now()
|
2015-03-16 18:33:59 +00:00
|
|
|
if err := m.persistEntry(le); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// Update the expiration time
|
2015-04-09 19:39:12 +00:00
|
|
|
m.updatePending(le, resp.Secret.LeaseTotal())
|
2015-03-16 18:33:59 +00:00
|
|
|
|
2015-03-16 20:29:51 +00:00
|
|
|
// Return the response
|
|
|
|
return resp, nil
|
2015-03-13 01:38:15 +00:00
|
|
|
}
|
|
|
|
|
2015-04-03 18:58:10 +00:00
|
|
|
// RenewToken is used to renew a token which does not need to
|
|
|
|
// invoke a logical backend.
|
2016-02-18 16:22:04 +00:00
|
|
|
func (m *ExpirationManager) RenewToken(req *logical.Request, source string, token string,
|
2016-03-04 19:56:51 +00:00
|
|
|
increment time.Duration) (*logical.Response, error) {
|
2015-04-08 23:43:17 +00:00
|
|
|
defer metrics.MeasureSince([]string{"expire", "renew-token"}, time.Now())
|
2015-04-08 20:35:32 +00:00
|
|
|
// Compute the Lease ID
|
|
|
|
leaseID := path.Join(source, m.tokenStore.SaltID(token))
|
2015-04-03 18:58:10 +00:00
|
|
|
|
|
|
|
// Load the entry
|
2015-04-08 20:35:32 +00:00
|
|
|
le, err := m.loadEntry(leaseID)
|
2015-04-03 18:58:10 +00:00
|
|
|
if err != nil {
|
2015-04-06 23:35:39 +00:00
|
|
|
return nil, err
|
2015-04-03 18:58:10 +00:00
|
|
|
}
|
|
|
|
|
2016-03-01 17:33:35 +00:00
|
|
|
// Check if the lease is renewable. Note that this also checks for a nil
|
|
|
|
// lease and errors in that case as well.
|
2015-04-09 21:23:37 +00:00
|
|
|
if err := le.renewable(); err != nil {
|
2016-07-06 20:42:34 +00:00
|
|
|
return logical.ErrorResponse(err.Error()), logical.ErrInvalidRequest
|
2015-04-03 18:58:10 +00:00
|
|
|
}
|
|
|
|
|
2015-04-09 21:23:37 +00:00
|
|
|
// Attempt to renew the auth entry
|
2016-02-18 16:22:04 +00:00
|
|
|
resp, err := m.renewAuthEntry(req, le, increment)
|
2015-04-09 21:23:37 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
2015-04-03 18:58:10 +00:00
|
|
|
}
|
|
|
|
|
2015-04-09 21:23:37 +00:00
|
|
|
if resp == nil {
|
|
|
|
return nil, nil
|
|
|
|
}
|
2016-03-04 20:13:04 +00:00
|
|
|
|
|
|
|
if resp.IsError() {
|
2016-03-04 20:35:58 +00:00
|
|
|
return &logical.Response{
|
|
|
|
Data: resp.Data,
|
|
|
|
}, nil
|
2016-03-04 20:13:04 +00:00
|
|
|
}
|
|
|
|
|
2015-04-09 21:23:37 +00:00
|
|
|
if resp.Auth == nil || !resp.Auth.LeaseEnabled() {
|
2016-03-04 23:08:13 +00:00
|
|
|
return &logical.Response{
|
|
|
|
Auth: resp.Auth,
|
|
|
|
}, nil
|
2015-04-09 00:03:46 +00:00
|
|
|
}
|
|
|
|
|
2015-04-09 21:23:37 +00:00
|
|
|
// Attach the ClientToken
|
|
|
|
resp.Auth.ClientToken = token
|
2015-08-21 05:27:01 +00:00
|
|
|
resp.Auth.Increment = 0
|
2015-04-09 21:23:37 +00:00
|
|
|
|
2015-04-03 18:58:10 +00:00
|
|
|
// Update the lease entry
|
2015-04-09 21:23:37 +00:00
|
|
|
le.Auth = resp.Auth
|
|
|
|
le.ExpireTime = resp.Auth.ExpirationTime()
|
2016-07-07 21:44:14 +00:00
|
|
|
le.LastRenewalTime = time.Now()
|
2015-04-03 18:58:10 +00:00
|
|
|
if err := m.persistEntry(le); err != nil {
|
2015-04-06 23:35:39 +00:00
|
|
|
return nil, err
|
2015-04-03 18:58:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Update the expiration time
|
2015-04-09 21:23:37 +00:00
|
|
|
m.updatePending(le, resp.Auth.LeaseTotal())
|
2016-03-04 20:35:58 +00:00
|
|
|
return &logical.Response{
|
|
|
|
Auth: resp.Auth,
|
|
|
|
}, nil
|
2015-04-03 18:58:10 +00:00
|
|
|
}
|
|
|
|
|
2015-03-13 01:38:15 +00:00
|
|
|
// Register is used to take a request and response with an associated
|
2015-04-08 20:35:32 +00:00
|
|
|
// lease. The secret gets assigned a LeaseID and the management of
|
2015-03-13 01:38:15 +00:00
|
|
|
// of lease is assumed by the expiration manager.
|
2015-03-15 21:53:41 +00:00
|
|
|
func (m *ExpirationManager) Register(req *logical.Request, resp *logical.Response) (string, error) {
|
2015-04-08 23:43:17 +00:00
|
|
|
defer metrics.MeasureSince([]string{"expire", "register"}, time.Now())
|
2015-03-19 22:11:42 +00:00
|
|
|
// Ignore if there is no leased secret
|
2015-04-01 04:04:10 +00:00
|
|
|
if resp == nil || resp.Secret == nil {
|
2015-03-13 17:55:54 +00:00
|
|
|
return "", nil
|
|
|
|
}
|
|
|
|
|
2015-03-19 22:11:42 +00:00
|
|
|
// Validate the secret
|
|
|
|
if err := resp.Secret.Validate(); err != nil {
|
2015-03-13 17:55:54 +00:00
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
|
|
|
|
// Create a lease entry
|
2016-01-13 18:40:08 +00:00
|
|
|
leaseUUID, err := uuid.GenerateUUID()
|
|
|
|
if err != nil {
|
|
|
|
return "", err
|
|
|
|
}
|
2015-03-13 17:55:54 +00:00
|
|
|
le := leaseEntry{
|
2016-01-13 18:40:08 +00:00
|
|
|
LeaseID: path.Join(req.Path, leaseUUID),
|
2015-04-10 21:48:08 +00:00
|
|
|
ClientToken: req.ClientToken,
|
|
|
|
Path: req.Path,
|
|
|
|
Data: resp.Data,
|
|
|
|
Secret: resp.Secret,
|
2016-07-07 21:44:14 +00:00
|
|
|
IssueTime: time.Now(),
|
2015-04-10 21:48:08 +00:00
|
|
|
ExpireTime: resp.Secret.ExpirationTime(),
|
2015-03-13 17:55:54 +00:00
|
|
|
}
|
|
|
|
|
2015-03-16 01:06:19 +00:00
|
|
|
// Encode the entry
|
|
|
|
if err := m.persistEntry(&le); err != nil {
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
|
2015-04-10 21:48:08 +00:00
|
|
|
// Maintain secondary index by token
|
2015-11-04 15:48:44 +00:00
|
|
|
if err := m.createIndexByToken(le.ClientToken, le.LeaseID); err != nil {
|
2015-04-10 21:48:08 +00:00
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
|
2015-04-01 04:01:12 +00:00
|
|
|
// Setup revocation timer if there is a lease
|
2015-04-09 19:39:12 +00:00
|
|
|
m.updatePending(&le, resp.Secret.LeaseTotal())
|
2015-03-16 01:06:19 +00:00
|
|
|
|
|
|
|
// Done
|
2015-04-08 20:35:32 +00:00
|
|
|
return le.LeaseID, nil
|
2015-03-16 01:06:19 +00:00
|
|
|
}
|
|
|
|
|
2015-04-03 00:45:42 +00:00
|
|
|
// RegisterAuth is used to take an Auth response with an associated lease.
|
2015-04-08 20:35:32 +00:00
|
|
|
// The token does not get a LeaseID, but the lease management is handled by
|
2015-04-03 00:45:42 +00:00
|
|
|
// the expiration manager.
|
|
|
|
func (m *ExpirationManager) RegisterAuth(source string, auth *logical.Auth) error {
|
2015-04-08 23:43:17 +00:00
|
|
|
defer metrics.MeasureSince([]string{"expire", "register-auth"}, time.Now())
|
2015-04-11 04:21:06 +00:00
|
|
|
|
2015-03-24 01:11:15 +00:00
|
|
|
// Create a lease entry
|
|
|
|
le := leaseEntry{
|
2015-04-10 21:48:08 +00:00
|
|
|
LeaseID: path.Join(source, m.tokenStore.SaltID(auth.ClientToken)),
|
|
|
|
ClientToken: auth.ClientToken,
|
|
|
|
Auth: auth,
|
|
|
|
Path: source,
|
2016-07-07 21:44:14 +00:00
|
|
|
IssueTime: time.Now(),
|
2015-04-10 21:48:08 +00:00
|
|
|
ExpireTime: auth.ExpirationTime(),
|
2015-03-24 01:11:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Encode the entry
|
|
|
|
if err := m.persistEntry(&le); err != nil {
|
2015-04-03 00:45:42 +00:00
|
|
|
return err
|
2015-03-24 01:11:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Setup revocation timer
|
2015-04-09 19:39:12 +00:00
|
|
|
m.updatePending(&le, auth.LeaseTotal())
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2016-01-04 21:43:07 +00:00
|
|
|
// FetchLeaseTimesByToken is a helper function to use token values to compute
|
|
|
|
// the leaseID, rather than pushing that logic back into the token store.
|
|
|
|
func (m *ExpirationManager) FetchLeaseTimesByToken(source, token string) (*leaseEntry, error) {
|
|
|
|
defer metrics.MeasureSince([]string{"expire", "fetch-lease-times-by-token"}, time.Now())
|
|
|
|
|
|
|
|
// Compute the Lease ID
|
|
|
|
leaseID := path.Join(source, m.tokenStore.SaltID(token))
|
|
|
|
return m.FetchLeaseTimes(leaseID)
|
|
|
|
}
|
|
|
|
|
|
|
|
// FetchLeaseTimes is used to fetch the issue time, expiration time, and last
|
|
|
|
// renewed time of a lease entry. It returns a leaseEntry itself, but with only
|
|
|
|
// those values copied over.
|
|
|
|
func (m *ExpirationManager) FetchLeaseTimes(leaseID string) (*leaseEntry, error) {
|
|
|
|
defer metrics.MeasureSince([]string{"expire", "fetch-lease-times"}, time.Now())
|
|
|
|
|
|
|
|
// Load the entry
|
|
|
|
le, err := m.loadEntry(leaseID)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
if le == nil {
|
|
|
|
return nil, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
ret := &leaseEntry{
|
|
|
|
IssueTime: le.IssueTime,
|
|
|
|
ExpireTime: le.ExpireTime,
|
|
|
|
LastRenewalTime: le.LastRenewalTime,
|
|
|
|
}
|
2016-06-08 13:19:39 +00:00
|
|
|
if le.Secret != nil {
|
|
|
|
ret.Secret = &logical.Secret{}
|
|
|
|
ret.Secret.Renewable = le.Secret.Renewable
|
|
|
|
ret.Secret.TTL = le.Secret.TTL
|
|
|
|
}
|
|
|
|
if le.Auth != nil {
|
|
|
|
ret.Auth = &logical.Auth{}
|
|
|
|
ret.Auth.Renewable = le.Auth.Renewable
|
|
|
|
ret.Auth.TTL = le.Auth.TTL
|
|
|
|
}
|
2016-01-04 21:43:07 +00:00
|
|
|
|
|
|
|
return ret, nil
|
|
|
|
}
|
|
|
|
|
2015-04-09 19:39:12 +00:00
|
|
|
// updatePending is used to update a pending invocation for a lease
|
|
|
|
func (m *ExpirationManager) updatePending(le *leaseEntry, leaseTotal time.Duration) {
|
|
|
|
m.pendingLock.Lock()
|
|
|
|
defer m.pendingLock.Unlock()
|
|
|
|
|
|
|
|
// Check for an existing timer
|
|
|
|
timer, ok := m.pending[le.LeaseID]
|
|
|
|
|
|
|
|
// Create entry if it does not exist
|
|
|
|
if !ok && leaseTotal > 0 {
|
|
|
|
timer := time.AfterFunc(leaseTotal, func() {
|
2015-04-08 22:43:26 +00:00
|
|
|
m.expireID(le.LeaseID)
|
|
|
|
})
|
2015-04-09 19:39:12 +00:00
|
|
|
m.pending[le.LeaseID] = timer
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
// Delete the timer if the expiration time is zero
|
|
|
|
if ok && leaseTotal == 0 {
|
|
|
|
timer.Stop()
|
|
|
|
delete(m.pending, le.LeaseID)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
// Extend the timer by the lease total
|
|
|
|
if ok && leaseTotal > 0 {
|
|
|
|
timer.Reset(leaseTotal)
|
2015-04-08 22:43:26 +00:00
|
|
|
}
|
2015-03-24 01:11:15 +00:00
|
|
|
}
|
|
|
|
|
2015-03-16 01:06:19 +00:00
|
|
|
// expireID is invoked when a given ID is expired
|
2015-04-08 20:35:32 +00:00
|
|
|
func (m *ExpirationManager) expireID(leaseID string) {
|
2015-03-16 01:06:19 +00:00
|
|
|
// Clear from the pending expiration
|
|
|
|
m.pendingLock.Lock()
|
2015-04-08 20:35:32 +00:00
|
|
|
delete(m.pending, leaseID)
|
2015-03-16 01:06:19 +00:00
|
|
|
m.pendingLock.Unlock()
|
|
|
|
|
2015-03-16 18:33:59 +00:00
|
|
|
for attempt := uint(0); attempt < maxRevokeAttempts; attempt++ {
|
2015-04-08 20:35:32 +00:00
|
|
|
err := m.Revoke(leaseID)
|
2015-03-16 18:33:59 +00:00
|
|
|
if err == nil {
|
2016-08-19 20:45:17 +00:00
|
|
|
if m.logger.IsInfo() {
|
|
|
|
m.logger.Info("expire: revoked lease", "lease_id", leaseID)
|
|
|
|
}
|
2015-03-16 18:33:59 +00:00
|
|
|
return
|
|
|
|
}
|
2016-08-19 20:45:17 +00:00
|
|
|
m.logger.Error("expire: failed to revoke lease", "lease_id", leaseID, "error", err)
|
2015-03-16 18:33:59 +00:00
|
|
|
time.Sleep((1 << attempt) * revokeRetryBase)
|
2015-03-16 01:06:19 +00:00
|
|
|
}
|
2016-08-19 20:45:17 +00:00
|
|
|
m.logger.Error("expire: maximum revoke attempts reached", "lease_id", leaseID)
|
2015-03-16 01:06:19 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// revokeEntry is used to attempt revocation of an internal entry
|
|
|
|
func (m *ExpirationManager) revokeEntry(le *leaseEntry) error {
|
2015-03-24 01:11:15 +00:00
|
|
|
// Revocation of login tokens is special since we can by-pass the
|
|
|
|
// backend and directly interact with the token store
|
2015-04-03 18:58:10 +00:00
|
|
|
if le.Auth != nil {
|
|
|
|
if err := m.tokenStore.RevokeTree(le.Auth.ClientToken); err != nil {
|
2015-03-24 01:11:15 +00:00
|
|
|
return fmt.Errorf("failed to revoke token: %v", err)
|
|
|
|
}
|
2015-09-10 01:58:09 +00:00
|
|
|
|
2015-03-24 01:11:15 +00:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// Handle standard revocation via backends
|
2016-05-26 03:24:10 +00:00
|
|
|
resp, err := m.router.Route(logical.RevokeRequest(
|
2015-03-19 22:11:42 +00:00
|
|
|
le.Path, le.Secret, le.Data))
|
2016-05-26 03:24:10 +00:00
|
|
|
if err != nil || (resp != nil && resp.IsError()) {
|
|
|
|
return fmt.Errorf("failed to revoke entry: resp:%#v err:%s", resp, err)
|
2015-03-16 18:33:59 +00:00
|
|
|
}
|
|
|
|
return nil
|
2015-03-16 01:06:19 +00:00
|
|
|
}
|
|
|
|
|
2015-03-16 20:29:51 +00:00
|
|
|
// renewEntry is used to attempt renew of an internal entry
|
2015-03-16 21:59:37 +00:00
|
|
|
func (m *ExpirationManager) renewEntry(le *leaseEntry, increment time.Duration) (*logical.Response, error) {
|
2015-03-19 22:11:42 +00:00
|
|
|
secret := *le.Secret
|
2015-08-21 05:27:01 +00:00
|
|
|
secret.IssueTime = le.IssueTime
|
|
|
|
secret.Increment = increment
|
2015-04-08 20:35:32 +00:00
|
|
|
secret.LeaseID = ""
|
2015-03-19 22:11:42 +00:00
|
|
|
|
2015-04-09 21:23:37 +00:00
|
|
|
req := logical.RenewRequest(le.Path, &secret, le.Data)
|
|
|
|
resp, err := m.router.Route(req)
|
2016-05-26 03:24:10 +00:00
|
|
|
if err != nil || (resp != nil && resp.IsError()) {
|
|
|
|
return nil, fmt.Errorf("failed to renew entry: resp:%#v err:%s", resp, err)
|
2015-04-09 21:23:37 +00:00
|
|
|
}
|
|
|
|
return resp, nil
|
|
|
|
}
|
|
|
|
|
2016-03-09 16:07:13 +00:00
|
|
|
// renewAuthEntry is used to attempt renew of an auth entry. Only the token
|
|
|
|
// store should get the actual token ID intact.
|
2016-02-18 16:22:04 +00:00
|
|
|
func (m *ExpirationManager) renewAuthEntry(req *logical.Request, le *leaseEntry, increment time.Duration) (*logical.Response, error) {
|
2015-04-09 21:23:37 +00:00
|
|
|
auth := *le.Auth
|
2015-08-21 05:27:01 +00:00
|
|
|
auth.IssueTime = le.IssueTime
|
|
|
|
auth.Increment = increment
|
2016-03-09 16:07:13 +00:00
|
|
|
if strings.HasPrefix(le.Path, "auth/token/") {
|
|
|
|
auth.ClientToken = le.ClientToken
|
|
|
|
} else {
|
|
|
|
auth.ClientToken = ""
|
|
|
|
}
|
2015-04-09 21:23:37 +00:00
|
|
|
|
2016-02-18 16:22:04 +00:00
|
|
|
authReq := logical.RenewAuthRequest(le.Path, &auth, nil)
|
|
|
|
authReq.Connection = req.Connection
|
|
|
|
resp, err := m.router.Route(authReq)
|
2015-03-16 20:29:51 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, fmt.Errorf("failed to renew entry: %v", err)
|
|
|
|
}
|
|
|
|
return resp, nil
|
|
|
|
}
|
|
|
|
|
2015-03-16 01:06:19 +00:00
|
|
|
// loadEntry is used to read a lease entry
|
2015-04-08 20:35:32 +00:00
|
|
|
func (m *ExpirationManager) loadEntry(leaseID string) (*leaseEntry, error) {
|
2015-04-10 21:21:23 +00:00
|
|
|
out, err := m.idView.Get(leaseID)
|
2015-03-16 01:06:19 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, fmt.Errorf("failed to read lease entry: %v", err)
|
|
|
|
}
|
|
|
|
if out == nil {
|
|
|
|
return nil, nil
|
|
|
|
}
|
|
|
|
le, err := decodeLeaseEntry(out.Value)
|
|
|
|
if err != nil {
|
|
|
|
return nil, fmt.Errorf("failed to decode lease entry: %v", err)
|
|
|
|
}
|
|
|
|
return le, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// persistEntry is used to persist a lease entry
|
|
|
|
func (m *ExpirationManager) persistEntry(le *leaseEntry) error {
|
2015-03-13 17:55:54 +00:00
|
|
|
// Encode the entry
|
|
|
|
buf, err := le.encode()
|
|
|
|
if err != nil {
|
2015-03-16 01:06:19 +00:00
|
|
|
return fmt.Errorf("failed to encode lease entry: %v", err)
|
2015-03-13 17:55:54 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Write out to the view
|
2015-03-15 20:52:43 +00:00
|
|
|
ent := logical.StorageEntry{
|
2015-04-08 20:35:32 +00:00
|
|
|
Key: le.LeaseID,
|
2015-03-13 17:55:54 +00:00
|
|
|
Value: buf,
|
|
|
|
}
|
2015-04-10 21:21:23 +00:00
|
|
|
if err := m.idView.Put(&ent); err != nil {
|
2015-03-16 01:06:19 +00:00
|
|
|
return fmt.Errorf("failed to persist lease entry: %v", err)
|
2015-03-13 17:55:54 +00:00
|
|
|
}
|
2015-03-16 01:06:19 +00:00
|
|
|
return nil
|
|
|
|
}
|
2015-03-13 17:55:54 +00:00
|
|
|
|
2015-03-16 01:06:19 +00:00
|
|
|
// deleteEntry is used to delete a lease entry
|
2015-04-08 20:35:32 +00:00
|
|
|
func (m *ExpirationManager) deleteEntry(leaseID string) error {
|
2015-04-10 21:21:23 +00:00
|
|
|
if err := m.idView.Delete(leaseID); err != nil {
|
2015-03-16 01:06:19 +00:00
|
|
|
return fmt.Errorf("failed to delete lease entry: %v", err)
|
|
|
|
}
|
|
|
|
return nil
|
2015-03-13 17:55:54 +00:00
|
|
|
}
|
|
|
|
|
2015-11-04 15:48:44 +00:00
|
|
|
// createIndexByToken creates a secondary index from the token to a lease entry
|
|
|
|
func (m *ExpirationManager) createIndexByToken(token, leaseID string) error {
|
2015-04-10 21:48:08 +00:00
|
|
|
ent := logical.StorageEntry{
|
|
|
|
Key: m.tokenStore.SaltID(token) + "/" + m.tokenStore.SaltID(leaseID),
|
|
|
|
Value: []byte(leaseID),
|
|
|
|
}
|
|
|
|
if err := m.tokenView.Put(&ent); err != nil {
|
|
|
|
return fmt.Errorf("failed to persist lease index entry: %v", err)
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2015-11-04 15:48:44 +00:00
|
|
|
// indexByToken looks up the secondary index from the token to a lease entry
|
|
|
|
func (m *ExpirationManager) indexByToken(token, leaseID string) (*logical.StorageEntry, error) {
|
|
|
|
key := m.tokenStore.SaltID(token) + "/" + m.tokenStore.SaltID(leaseID)
|
|
|
|
entry, err := m.tokenView.Get(key)
|
|
|
|
if err != nil {
|
|
|
|
return nil, fmt.Errorf("failed to look up secondary index entry")
|
|
|
|
}
|
|
|
|
return entry, nil
|
|
|
|
}
|
|
|
|
|
2015-04-10 21:48:08 +00:00
|
|
|
// removeIndexByToken removes the secondary index from the token to a lease entry
|
|
|
|
func (m *ExpirationManager) removeIndexByToken(token, leaseID string) error {
|
|
|
|
key := m.tokenStore.SaltID(token) + "/" + m.tokenStore.SaltID(leaseID)
|
|
|
|
if err := m.tokenView.Delete(key); err != nil {
|
|
|
|
return fmt.Errorf("failed to delete lease index entry: %v", err)
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// lookupByToken is used to lookup all the leaseID's via the
|
|
|
|
func (m *ExpirationManager) lookupByToken(token string) ([]string, error) {
|
|
|
|
// Scan via the index for sub-leases
|
|
|
|
prefix := m.tokenStore.SaltID(token) + "/"
|
|
|
|
subKeys, err := m.tokenView.List(prefix)
|
|
|
|
if err != nil {
|
|
|
|
return nil, fmt.Errorf("failed to list leases: %v", err)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Read each index entry
|
|
|
|
leaseIDs := make([]string, 0, len(subKeys))
|
|
|
|
for _, sub := range subKeys {
|
|
|
|
out, err := m.tokenView.Get(prefix + sub)
|
|
|
|
if err != nil {
|
|
|
|
return nil, fmt.Errorf("failed to read lease index: %v", err)
|
|
|
|
}
|
|
|
|
if out == nil {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
leaseIDs = append(leaseIDs, string(out.Value))
|
|
|
|
}
|
|
|
|
return leaseIDs, nil
|
|
|
|
}
|
|
|
|
|
2015-04-08 23:43:17 +00:00
|
|
|
// emitMetrics is invoked periodically to emit statistics
|
|
|
|
func (m *ExpirationManager) emitMetrics() {
|
|
|
|
m.pendingLock.Lock()
|
|
|
|
num := len(m.pending)
|
|
|
|
m.pendingLock.Unlock()
|
|
|
|
metrics.SetGauge([]string{"expire", "num_leases"}, float32(num))
|
|
|
|
}
|
|
|
|
|
2015-03-13 17:55:54 +00:00
|
|
|
// leaseEntry is used to structure the values the expiration
|
|
|
|
// manager stores. This is used to handle renew and revocation.
|
|
|
|
type leaseEntry struct {
|
2016-01-04 21:43:07 +00:00
|
|
|
LeaseID string `json:"lease_id"`
|
|
|
|
ClientToken string `json:"client_token"`
|
|
|
|
Path string `json:"path"`
|
|
|
|
Data map[string]interface{} `json:"data"`
|
|
|
|
Secret *logical.Secret `json:"secret"`
|
|
|
|
Auth *logical.Auth `json:"auth"`
|
|
|
|
IssueTime time.Time `json:"issue_time"`
|
|
|
|
ExpireTime time.Time `json:"expire_time"`
|
|
|
|
LastRenewalTime time.Time `json:"last_renewal_time"`
|
2015-03-13 17:55:54 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// encode is used to JSON encode the lease entry
|
|
|
|
func (l *leaseEntry) encode() ([]byte, error) {
|
|
|
|
return json.Marshal(l)
|
|
|
|
}
|
|
|
|
|
2015-04-09 21:23:37 +00:00
|
|
|
func (le *leaseEntry) renewable() error {
|
|
|
|
// If there is no entry, cannot review
|
|
|
|
if le == nil || le.ExpireTime.IsZero() {
|
2015-06-18 22:37:08 +00:00
|
|
|
return fmt.Errorf("lease not found or lease is not renewable")
|
2015-04-09 21:23:37 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Determine if the lease is expired
|
2016-07-07 21:44:14 +00:00
|
|
|
if le.ExpireTime.Before(time.Now()) {
|
2015-04-09 21:23:37 +00:00
|
|
|
return fmt.Errorf("lease expired")
|
|
|
|
}
|
|
|
|
|
|
|
|
// Determine if the lease is renewable
|
|
|
|
if le.Secret != nil && !le.Secret.Renewable {
|
|
|
|
return fmt.Errorf("lease is not renewable")
|
|
|
|
}
|
|
|
|
if le.Auth != nil && !le.Auth.Renewable {
|
|
|
|
return fmt.Errorf("lease is not renewable")
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2015-03-13 17:55:54 +00:00
|
|
|
// decodeLeaseEntry is used to reverse encode and return a new entry
|
|
|
|
func decodeLeaseEntry(buf []byte) (*leaseEntry, error) {
|
|
|
|
out := new(leaseEntry)
|
2016-07-06 16:25:40 +00:00
|
|
|
return out, jsonutil.DecodeJSON(buf, out)
|
2015-03-13 01:38:15 +00:00
|
|
|
}
|