teleport/api/client/sessions.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 client

import (
	"context"
	"errors"
	"io"
	"iter"

	"github.com/gravitational/trace"
	"google.golang.org/protobuf/types/known/emptypb"

	"github.com/gravitational/teleport/api/client/proto"
	"github.com/gravitational/teleport/api/types"
	"github.com/gravitational/teleport/api/utils/clientutils"
)

// GetWebSession returns the web session for the specified request.
// Implements ReadAccessPoint
func (c *Client) GetWebSession(ctx context.Context, req types.GetWebSessionRequest) (types.WebSession, error) {
	return c.WebSessions().Get(ctx, req)
}

// WebSessions returns the web sessions controller
func (c *Client) WebSessions() types.WebSessionInterface {
	return &webSessions{c: c}
}

// Get returns the web session for the specified request
func (r *webSessions) Get(ctx context.Context, req types.GetWebSessionRequest) (types.WebSession, error) {
	resp, err := r.c.grpc.GetWebSession(ctx, &req)
	if err != nil {
		return nil, trace.Wrap(err)
	}
	return resp.Session, nil
}

// List returns the list of all web sessions
func (r *webSessions) List(ctx context.Context) ([]types.WebSession, error) {
	sessions, err := r.listStream(ctx)
	if err != nil {
		return nil, trace.Wrap(err)
	}
	return sessions, nil
}

func (r *webSessions) listStream(ctx context.Context) ([]types.WebSession, error) {
	stream, err := r.c.grpc.StreamWebSessions(ctx, new(emptypb.Empty))
	if err != nil {
		return nil, trace.Wrap(err)
	}

	var sessions []types.WebSession
	for {
		session, err := stream.Recv()
		if err != nil {
			if errors.Is(err, io.EOF) {
				return sessions, nil
			}
			return nil, trace.Wrap(err)
		}
		sessions = append(sessions, session)
	}
}

// Upsert not implemented: can only be called locally.
func (r *webSessions) Upsert(ctx context.Context, session types.WebSession) error {
	return trace.NotImplemented(notImplementedMessage)
}

// Delete deletes the web session specified with the request
func (r *webSessions) Delete(ctx context.Context, req types.DeleteWebSessionRequest) error {
	_, err := r.c.grpc.DeleteWebSession(ctx, &req)
	if err != nil {
		return trace.Wrap(err)
	}
	return nil
}

// DeleteAll deletes all web sessions
func (r *webSessions) DeleteAll(ctx context.Context) error {
	_, err := r.c.grpc.DeleteAllWebSessions(ctx, &emptypb.Empty{})
	if err != nil {
		return trace.Wrap(err)
	}
	return nil
}

type webSessions struct {
	c *Client
}

// GetWebToken returns the web token for the specified request
func (c *Client) GetWebToken(ctx context.Context, req types.GetWebTokenRequest) (types.WebToken, error) {
	resp, err := c.grpc.GetWebToken(ctx, &req)
	if err != nil {
		return nil, trace.Wrap(err)
	}
	return resp.Token, nil
}

// GetWebTokens returns the list of all web tokens
// Deprecated: Prefer using [Client.ListWebTokens] or [Client.RangeWebTokens] instead.
func (c *Client) GetWebTokens(ctx context.Context) ([]types.WebToken, error) {
	//nolint:staticcheck // TODO(okraport): deprecated, to be removed in v21
	resp, err := c.grpc.GetWebTokens(ctx, &emptypb.Empty{})
	if err != nil {
		return nil, trace.Wrap(err)
	}
	out := make([]types.WebToken, 0, len(resp.Tokens))
	for _, token := range resp.Tokens {
		out = append(out, token)
	}
	return out, nil
}

// ListWebTokens returns a page of web tokens
func (c *Client) ListWebTokens(ctx context.Context, limit int, start string) ([]types.WebToken, string, error) {
	resp, err := c.grpc.ListWebTokens(ctx, &proto.ListWebTokensRequest{
		PageToken: start,
		PageSize:  int32(limit),
	})
	if err != nil {
		return nil, "", trace.Wrap(err)
	}

	tokens := make([]types.WebToken, 0, len(resp.Tokens))
	for _, token := range resp.Tokens {
		tokens = append(tokens, token)
	}

	return tokens, resp.NextPageToken, nil
}

// RangeWebTokens returns web tokens within the range [start, end).
func (c *Client) RangeWebTokens(ctx context.Context, start, end string) iter.Seq2[types.WebToken, error] {
	return clientutils.RangeResources(ctx, start, end, c.ListWebTokens, types.WebToken.GetName)
}

// UpsertWebToken not implemented: can only be called locally.
func (c *Client) UpsertWebToken(ctx context.Context, token types.WebToken) error {
	return trace.NotImplemented(notImplementedMessage)
}

// DeleteWebToken deletes the web token specified with the request
func (c *Client) DeleteWebToken(ctx context.Context, req types.DeleteWebTokenRequest) error {
	_, err := c.grpc.DeleteWebToken(ctx, &req)
	if err != nil {
		return trace.Wrap(err)
	}
	return nil
}

// DeleteAllWebTokens deletes all web tokens
func (c *Client) DeleteAllWebTokens(ctx context.Context) error {
	_, err := c.grpc.DeleteAllWebTokens(ctx, &emptypb.Empty{})
	if err != nil {
		return trace.Wrap(err)
	}
	return nil
}

// WebTokens returns the web tokens controller
//
// TODO(okraport): DELETE IN v21
//
// Deprecated: Use [Client] methods directly.
func (c *Client) WebTokens() types.WebTokenInterface {
	return &webTokens{c: c}
}

// Get returns the web token for the specified request
//
// TODO(okraport): DELETE IN v21
//
// Deprecated: Use [Client.GetWebToken] instead.
func (r *webTokens) Get(ctx context.Context, req types.GetWebTokenRequest) (types.WebToken, error) {
	return r.c.GetWebToken(ctx, req)
}

// List returns the list of all web tokens
//
// TODO(okraport): DELETE IN v21
//
// Deprecated: Use [Client.GetWebTokens] instead.
func (r *webTokens) List(ctx context.Context) ([]types.WebToken, error) {
	return clientutils.CollectWithFallback(ctx, r.c.ListWebTokens, r.c.GetWebTokens)
}

// Upsert not implemented: can only be called locally.
//
// TODO(okraport): DELETE IN v21
//
// Deprecated: Use [Client.UpsertWebToken] instead.
func (r *webTokens) Upsert(ctx context.Context, token types.WebToken) error {
	return r.c.UpsertWebToken(ctx, token)
}

// Delete deletes the web token specified with the request
//
// TODO(okraport): DELETE IN v21
//
// Deprecated: Use [Client.DeleteWebToken] instead.
func (r *webTokens) Delete(ctx context.Context, req types.DeleteWebTokenRequest) error {
	return r.c.DeleteWebToken(ctx, req)
}

// DeleteAll deletes all web tokens
//
// TODO(okraport): DELETE IN v21
//
// Deprecated: Use [Client.DeleteAllWebTokens] instead.
func (r *webTokens) DeleteAll(ctx context.Context) error {
	return r.c.DeleteAllWebTokens(ctx)
}

// Deprecated: Use [Client] directly.
type webTokens struct {
	c *Client
}

const notImplementedMessage = "not implemented: can only be called by auth locally"