github.com/gravitational/teleport/api@v0.0.0-20240507183017-3110591cbafc/types/lock.go

/*
Copyright 2021 Gravitational, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package types

import (
	"strings"
	"time"

	"github.com/gogo/protobuf/proto"
	"github.com/gravitational/trace"

	"github.com/gravitational/teleport/api/utils"
)

// Lock configures locking out of a particular access vector.
type Lock interface {
	Resource
	ResourceWithOrigin
	ResourceWithLabels

	// Target returns the lock's target.
	Target() LockTarget
	// SetTarget sets the lock's target.
	SetTarget(LockTarget)

	// Message returns the message displayed to locked-out users.
	Message() string
	// SetMessage sets the lock's user message.
	SetMessage(string)

	// LockExpiry returns when the lock ceases to be in force.
	LockExpiry() *time.Time
	// SetLockExpiry sets the lock's expiry.
	SetLockExpiry(*time.Time)

	// CreatedAt returns the time the lock was created.
	CreatedAt() time.Time
	// SetCreatedAt sets the lock's created time.
	SetCreatedAt(time.Time)
	// CreatedBy returns the user that created the lock.
	CreatedBy() string
	// SetCreatedBy sets the lock's creator.
	SetCreatedBy(string)

	// IsInForce returns whether the lock is in force at a particular time.
	IsInForce(time.Time) bool
}

// NewLock is a convenience method to create a Lock resource.
func NewLock(name string, spec LockSpecV2) (Lock, error) {
	lock := &LockV2{
		Metadata: Metadata{
			Name: name,
		},
		Spec: spec,
	}
	if err := lock.CheckAndSetDefaults(); err != nil {
		return nil, trace.Wrap(err)
	}
	return lock, nil
}

// GetVersion returns resource version.
func (c *LockV2) GetVersion() string {
	return c.Version
}

// GetName returns the name of the resource.
func (c *LockV2) GetName() string {
	return c.Metadata.Name
}

// SetName sets the name of the resource.
func (c *LockV2) SetName(e string) {
	c.Metadata.Name = e
}

// SetExpiry sets expiry time for the object.
func (c *LockV2) SetExpiry(expires time.Time) {
	c.Metadata.SetExpiry(expires)
}

// Expiry returns object expiry setting.
func (c *LockV2) Expiry() time.Time {
	return c.Metadata.Expiry()
}

// GetMetadata returns object metadata.
func (c *LockV2) GetMetadata() Metadata {
	return c.Metadata
}

// GetResourceID returns resource ID.
func (c *LockV2) GetResourceID() int64 {
	return c.Metadata.ID
}

// SetResourceID sets resource ID.
func (c *LockV2) SetResourceID(id int64) {
	c.Metadata.ID = id
}

// GetRevision returns the revision
func (c *LockV2) GetRevision() string {
	return c.Metadata.GetRevision()
}

// SetRevision sets the revision
func (c *LockV2) SetRevision(rev string) {
	c.Metadata.SetRevision(rev)
}

// GetKind returns resource kind.
func (c *LockV2) GetKind() string {
	return c.Kind
}

// GetSubKind returns resource subkind.
func (c *LockV2) GetSubKind() string {
	return c.SubKind
}

// SetSubKind sets resource subkind.
func (c *LockV2) SetSubKind(sk string) {
	c.SubKind = sk
}

// Target returns the lock's target.
func (c *LockV2) Target() LockTarget {
	return c.Spec.Target
}

// SetTarget sets the lock's target.
func (c *LockV2) SetTarget(target LockTarget) {
	c.Spec.Target = target
}

// Message returns the message displayed to locked-out users.
func (c *LockV2) Message() string {
	return c.Spec.Message
}

// SetMessage sets the lock's user message.
func (c *LockV2) SetMessage(message string) {
	c.Spec.Message = message
}

// LockExpiry returns when the lock ceases to be in force.
func (c *LockV2) LockExpiry() *time.Time {
	return c.Spec.Expires
}

// SetLockExpiry sets the lock's expiry.
func (c *LockV2) SetLockExpiry(expiry *time.Time) {
	c.Spec.Expires = expiry
}

func (c *LockV2) CreatedAt() time.Time {
	return c.Spec.CreatedAt
}

func (c *LockV2) SetCreatedAt(t time.Time) {
	c.Spec.CreatedAt = t
}

func (c *LockV2) CreatedBy() string {
	return c.Spec.CreatedBy
}

func (c *LockV2) SetCreatedBy(user string) {
	c.Spec.CreatedBy = user
}

// IsInForce returns whether the lock is in force at a particular time.
func (c *LockV2) IsInForce(t time.Time) bool {
	if c.Spec.Expires == nil {
		return true
	}
	return t.Before(*c.Spec.Expires)
}

// setStaticFields sets static resource header and metadata fields.
func (c *LockV2) setStaticFields() {
	c.Kind = KindLock
	c.Version = V2
}

// CheckAndSetDefaults verifies the constraints for Lock.
func (c *LockV2) CheckAndSetDefaults() error {
	c.setStaticFields()
	err := c.Metadata.CheckAndSetDefaults()
	if err != nil {
		return trace.Wrap(err)
	}

	if c.Spec.Target.IsEmpty() {
		return trace.BadParameter("at least one target field must be set")
	}
	return nil
}

// Origin fetches the lock's origin, if any. Returns the empty string if no
// origin is set.
func (c *LockV2) Origin() string {
	return c.Metadata.Labels[OriginLabel]
}

func (c *LockV2) SetOrigin(origin string) {
	c.Metadata.SetOrigin(origin)
}

// GetLabel fetches the given user label, with the same semantics
// as a map read
func (c *LockV2) GetLabel(key string) (value string, ok bool) {
	value, ok = c.Metadata.Labels[key]
	return
}

// GetAllLabels fetches all the user labels.
func (c *LockV2) GetAllLabels() map[string]string {
	return c.Metadata.Labels
}

// GetStaticLabels fetches all the user labels.
func (c *LockV2) GetStaticLabels() map[string]string {
	return c.Metadata.Labels
}

// SetStaticLabels sets the entire label set for the user.
func (c *LockV2) SetStaticLabels(sl map[string]string) {
	c.Metadata.Labels = sl
}

// MatchSearch goes through select field values and tries to
// match against the list of search values.
func (c *LockV2) MatchSearch(values []string) bool {
	fieldVals := append(utils.MapToStrings(c.Metadata.Labels), c.GetName())
	return MatchSearch(fieldVals, values, nil)
}

// IntoMap returns the target attributes in the form of a map.
func (t LockTarget) IntoMap() (map[string]string, error) {
	m := map[string]string{}
	if err := utils.ObjectToStruct(t, &m); err != nil {
		return nil, trace.Wrap(err)
	}
	return m, nil
}

// FromMap copies values from a map into this LockTarget.
func (t *LockTarget) FromMap(m map[string]string) error {
	return trace.Wrap(utils.ObjectToStruct(m, t))
}

// IsEmpty returns true if none of the target's fields is set.
func (t LockTarget) IsEmpty() bool {
	return t.User == "" &&
		t.Role == "" &&
		t.Login == "" &&
		t.Node == "" &&
		t.MFADevice == "" &&
		t.WindowsDesktop == "" &&
		t.AccessRequest == "" &&
		t.Device == "" &&
		t.ServerID == ""
}

// Match returns true if the lock's target is matched by this target.
func (t LockTarget) Match(lock Lock) bool {
	if t.IsEmpty() {
		return false
	}
	lockTarget := lock.Target()
	return (t.User == "" || lockTarget.User == t.User) &&
		(t.Role == "" || lockTarget.Role == t.Role) &&
		(t.Login == "" || lockTarget.Login == t.Login) &&
		(t.MFADevice == "" || lockTarget.MFADevice == t.MFADevice) &&
		(t.WindowsDesktop == "" || lockTarget.WindowsDesktop == t.WindowsDesktop) &&
		(t.AccessRequest == "" || lockTarget.AccessRequest == t.AccessRequest) &&
		(t.Device == "" || lockTarget.Device == t.Device) &&
		((t.Node == "" && t.ServerID == "") ||
			// Node lock overrides ServerID lock because we want to keep backwards compatibility
			// with previous versions of Teleport where a node lock only locked the ssh_service
			// and not the other services running on that host.
			// Newer versions of Teleport will lock all services based on the ServerID field.
			(lockTarget.Node != "" && lockTarget.Node == t.Node) ||
			(lockTarget.ServerID != "" && lockTarget.ServerID == t.ServerID))
}

// String returns string representation of the LockTarget.
func (t LockTarget) String() string {
	return strings.TrimSpace(proto.CompactTextString(&t))
}

// Equals returns true when the two lock targets are equal.
func (t LockTarget) Equals(t2 LockTarget) bool {
	return proto.Equal(&t, &t2)
}