Timothy Messier
2fbdcf6ce0
The session repository can now be passed an optional set of permissions. The permissions are used to restrict results from the repository. Currently this only impacts the List method. This enabled the sessions service to use a single query to retrieve sessions and replaces the previous behavior where the session service would first request all sessions for a given set of scopes, evaluate the permissions, and then request sessions based on a set of session ids.
133 lines
3.3 KiB
Go
133 lines
3.3 KiB
Go
package session
|
|
|
|
import (
|
|
"time"
|
|
|
|
"github.com/hashicorp/boundary/internal/db"
|
|
"github.com/hashicorp/boundary/internal/db/timestamp"
|
|
"github.com/hashicorp/boundary/internal/perms"
|
|
)
|
|
|
|
// 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 {
|
|
withLimit int
|
|
withOrderByCreateTime db.OrderBy
|
|
withProjectIds []string
|
|
withUserId string
|
|
withExpirationTime *timestamp.Timestamp
|
|
withTestTofu []byte
|
|
withListingConvert bool
|
|
withSessionIds []string
|
|
withDbOpts []db.Option
|
|
withWorkerStateDelay time.Duration
|
|
withTerminated bool
|
|
withPermissions *perms.UserPermissions
|
|
}
|
|
|
|
func getDefaultOptions() options {
|
|
return options{
|
|
withWorkerStateDelay: 10 * time.Second,
|
|
}
|
|
}
|
|
|
|
// 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) {
|
|
o.withLimit = limit
|
|
}
|
|
}
|
|
|
|
// WithOrderByCreateTime provides an option to specify ordering by the
|
|
// CreateTime field.
|
|
func WithOrderByCreateTime(orderBy db.OrderBy) Option {
|
|
return func(o *options) {
|
|
o.withOrderByCreateTime = orderBy
|
|
}
|
|
}
|
|
|
|
// WithProjectIds allows specifying a project ID criteria for the function.
|
|
func WithProjectIds(projectIds []string) Option {
|
|
return func(o *options) {
|
|
o.withProjectIds = projectIds
|
|
}
|
|
}
|
|
|
|
// WithUserId allows specifying a user ID criteria for the function.
|
|
func WithUserId(userId string) Option {
|
|
return func(o *options) {
|
|
o.withUserId = userId
|
|
}
|
|
}
|
|
|
|
// WithExpirationTime allows specifying an expiration time for the session
|
|
func WithExpirationTime(exp *timestamp.Timestamp) Option {
|
|
return func(o *options) {
|
|
o.withExpirationTime = exp
|
|
}
|
|
}
|
|
|
|
// WithTestTofu allows specifying a test tofu for a test session
|
|
func WithTestTofu(tofu []byte) Option {
|
|
return func(o *options) {
|
|
o.withTestTofu = tofu
|
|
}
|
|
}
|
|
|
|
// WithSessionIds allows the specification of the session ids to use for the
|
|
// operation.
|
|
func WithSessionIds(ids ...string) Option {
|
|
return func(o *options) {
|
|
o.withSessionIds = ids
|
|
}
|
|
}
|
|
|
|
func withListingConvert(withListingConvert bool) Option {
|
|
return func(o *options) {
|
|
o.withListingConvert = withListingConvert
|
|
}
|
|
}
|
|
|
|
// WithDbOpts passes through given DB options to the DB layer
|
|
func WithDbOpts(opts ...db.Option) Option {
|
|
return func(o *options) {
|
|
o.withDbOpts = opts
|
|
}
|
|
}
|
|
|
|
// WithWorkerStateDelay is used by queries to account for a delay in state
|
|
// propagation between worker and controller.
|
|
func WithWorkerStateDelay(d time.Duration) Option {
|
|
return func(o *options) {
|
|
o.withWorkerStateDelay = d
|
|
}
|
|
}
|
|
|
|
// WithTerminated is used to include terminated sessions in a list request.
|
|
func WithTerminated(withTerminated bool) Option {
|
|
return func(o *options) {
|
|
o.withTerminated = withTerminated
|
|
}
|
|
}
|
|
|
|
// WithPermissions is used to include user permissions when constructing a
|
|
// Repository.
|
|
func WithPermissions(p *perms.UserPermissions) Option {
|
|
return func(o *options) {
|
|
o.withPermissions = p
|
|
}
|
|
}
|