Jeff MalnickandJeff Mitchell
11c7c8dbe8
* feat: make auth token time to live and staleness configurable * docs: add configuration docs for auth token TTL and staleness Co-authored-by: Jeff Mitchell <jeffrey.mitchell@gmail.com>
78 lines
1.9 KiB
Go
78 lines
1.9 KiB
Go
package authtoken
|
|
|
|
import (
|
|
"time"
|
|
|
|
"github.com/hashicorp/boundary/internal/db"
|
|
)
|
|
|
|
var (
|
|
defaultTokenTimeToLiveDuration = 7 * 24 * time.Hour
|
|
defaultTokenTimeToStaleDuration = 24 * time.Hour
|
|
)
|
|
|
|
// getOpts - iterate the inbound Options and return a struct
|
|
func getOpts(opt ...Option) options {
|
|
opts := getDefaultOptions()
|
|
for _, o := range opt {
|
|
o(&opts)
|
|
}
|
|
return opts
|
|
}
|
|
|
|
// Option - how Options are passed as arguments.
|
|
type Option func(*options)
|
|
|
|
// options = how options are represented
|
|
type options struct {
|
|
withTokenValue bool
|
|
withTokenTimeToLiveDuration time.Duration
|
|
withTokenTimeToStaleDuration time.Duration
|
|
withLimit int
|
|
}
|
|
|
|
func getDefaultOptions() options {
|
|
return options{
|
|
withLimit: db.DefaultLimit,
|
|
withTokenTimeToLiveDuration: defaultTokenTimeToLiveDuration,
|
|
withTokenTimeToStaleDuration: defaultTokenTimeToStaleDuration,
|
|
}
|
|
}
|
|
|
|
// withTokenValue allows the auth token value to be included in the lookup response.
|
|
// This is purposefully not exported as it should only be used internally by the auth token repository itself.
|
|
func withTokenValue() Option {
|
|
return func(o *options) {
|
|
o.withTokenValue = true
|
|
}
|
|
}
|
|
|
|
// WithTokenTimeToLiveDuration allows setting the auth token time-to-live.
|
|
func WithTokenTimeToLiveDuration(ttl time.Duration) Option {
|
|
return func(o *options) {
|
|
if ttl > 0 {
|
|
o.withTokenTimeToLiveDuration = ttl
|
|
}
|
|
}
|
|
}
|
|
|
|
// WithTokenTimeToStaleDuration allows setting the auth token staleness duration.
|
|
func WithTokenTimeToStaleDuration(dur time.Duration) Option {
|
|
return func(o *options) {
|
|
if dur > 0 {
|
|
o.withTokenTimeToStaleDuration = dur
|
|
}
|
|
}
|
|
}
|
|
|
|
// WithLimit provides an option to provide a limit. Intentionally allowing
|
|
// negative integers. If WithLimit < 0, then unlimited results are returned.
|
|
// If WithLimit == 0, then default limits are used for results.
|
|
func WithLimit(limit int) Option {
|
|
return func(o *options) {
|
|
if limit > 0 {
|
|
o.withLimit = limit
|
|
}
|
|
}
|
|
}
|