Files
teleport/api/client/client.go
T
Dan Upton 165ec1fdb4 MWI: Generate AutoUpdateBotInstanceReport resource (#59738)
* Add `AutoUpdateBotReport` resource definition

* Generate bot version report once per minute

* Add gRPC endpoint for reading bot report

* Add updater info to the bot heartbeat message

* Fix a couple of minor typos

* Add forgotten cache event plumbing

* Fix duplicate import

* Fix racy test

* Add missing license header

* Fill HostUUID in tests

* Rename "bot report" to "bot instance report"

* Fix formatting

* Make one of the expected values different

* Defend against expired instances being counted

* Closer align `AutoUpdateBotInstanceReport` resource with RFD 153

* Add endpoint for deleting report
2025-10-07 14:32:36 +00:00

5631 lines
205 KiB
Go
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
/*
Copyright 2020-2022 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 (
"cmp"
"compress/gzip"
"context"
"crypto/tls"
"errors"
"fmt"
"io"
"iter"
"log/slog"
"net"
"slices"
"sync"
"sync/atomic"
"time"
"github.com/coreos/go-semver/semver"
"github.com/gravitational/trace"
"github.com/jonboulle/clockwork"
"go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
"golang.org/x/crypto/ssh"
"google.golang.org/grpc"
"google.golang.org/grpc/connectivity"
"google.golang.org/grpc/credentials"
ggzip "google.golang.org/grpc/encoding/gzip"
"google.golang.org/grpc/keepalive"
gmetadata "google.golang.org/grpc/metadata"
"google.golang.org/protobuf/types/known/durationpb"
"google.golang.org/protobuf/types/known/emptypb"
"google.golang.org/protobuf/types/known/timestamppb"
"github.com/gravitational/teleport/api/breaker"
"github.com/gravitational/teleport/api/client/accesslist"
"github.com/gravitational/teleport/api/client/accessmonitoringrules"
crownjewelapi "github.com/gravitational/teleport/api/client/crownjewel"
"github.com/gravitational/teleport/api/client/discoveryconfig"
"github.com/gravitational/teleport/api/client/dynamicwindows"
"github.com/gravitational/teleport/api/client/externalauditstorage"
gitserverclient "github.com/gravitational/teleport/api/client/gitserver"
kubewaitingcontainerclient "github.com/gravitational/teleport/api/client/kubewaitingcontainer"
"github.com/gravitational/teleport/api/client/okta"
"github.com/gravitational/teleport/api/client/proto"
"github.com/gravitational/teleport/api/client/scim"
"github.com/gravitational/teleport/api/client/secreport"
statichostuserclient "github.com/gravitational/teleport/api/client/statichostuser"
"github.com/gravitational/teleport/api/client/userloginstate"
usertaskapi "github.com/gravitational/teleport/api/client/usertask"
"github.com/gravitational/teleport/api/constants"
"github.com/gravitational/teleport/api/defaults"
accesslistv1 "github.com/gravitational/teleport/api/gen/proto/go/teleport/accesslist/v1"
accessmonitoringrulev1 "github.com/gravitational/teleport/api/gen/proto/go/teleport/accessmonitoringrules/v1"
auditlogpb "github.com/gravitational/teleport/api/gen/proto/go/teleport/auditlog/v1"
autoupdatev1pb "github.com/gravitational/teleport/api/gen/proto/go/teleport/autoupdate/v1"
clusterconfigpb "github.com/gravitational/teleport/api/gen/proto/go/teleport/clusterconfig/v1"
crownjewelv1 "github.com/gravitational/teleport/api/gen/proto/go/teleport/crownjewel/v1"
dbobjectv1 "github.com/gravitational/teleport/api/gen/proto/go/teleport/dbobject/v1"
dbobjectimportrulev1 "github.com/gravitational/teleport/api/gen/proto/go/teleport/dbobjectimportrule/v1"
decisionpb "github.com/gravitational/teleport/api/gen/proto/go/teleport/decision/v1alpha1"
devicepb "github.com/gravitational/teleport/api/gen/proto/go/teleport/devicetrust/v1"
discoveryconfigv1 "github.com/gravitational/teleport/api/gen/proto/go/teleport/discoveryconfig/v1"
dynamicwindowsv1 "github.com/gravitational/teleport/api/gen/proto/go/teleport/dynamicwindows/v1"
externalauditstoragev1 "github.com/gravitational/teleport/api/gen/proto/go/teleport/externalauditstorage/v1"
gitserverpb "github.com/gravitational/teleport/api/gen/proto/go/teleport/gitserver/v1"
healthcheckconfigv1 "github.com/gravitational/teleport/api/gen/proto/go/teleport/healthcheckconfig/v1"
integrationpb "github.com/gravitational/teleport/api/gen/proto/go/teleport/integration/v1"
joinv1 "github.com/gravitational/teleport/api/gen/proto/go/teleport/join/v1"
kubeproto "github.com/gravitational/teleport/api/gen/proto/go/teleport/kube/v1"
kubewaitingcontainerpb "github.com/gravitational/teleport/api/gen/proto/go/teleport/kubewaitingcontainer/v1"
loginrulepb "github.com/gravitational/teleport/api/gen/proto/go/teleport/loginrule/v1"
machineidv1pb "github.com/gravitational/teleport/api/gen/proto/go/teleport/machineid/v1"
notificationsv1pb "github.com/gravitational/teleport/api/gen/proto/go/teleport/notifications/v1"
oktapb "github.com/gravitational/teleport/api/gen/proto/go/teleport/okta/v1"
pluginspb "github.com/gravitational/teleport/api/gen/proto/go/teleport/plugins/v1"
presencepb "github.com/gravitational/teleport/api/gen/proto/go/teleport/presence/v1"
recordingencryptionv1pb "github.com/gravitational/teleport/api/gen/proto/go/teleport/recordingencryption/v1"
recordingmetadatav1 "github.com/gravitational/teleport/api/gen/proto/go/teleport/recordingmetadata/v1"
resourceusagepb "github.com/gravitational/teleport/api/gen/proto/go/teleport/resourceusage/v1"
samlidppb "github.com/gravitational/teleport/api/gen/proto/go/teleport/samlidp/v1"
scopedaccessv1 "github.com/gravitational/teleport/api/gen/proto/go/teleport/scopes/access/v1"
secreportsv1 "github.com/gravitational/teleport/api/gen/proto/go/teleport/secreports/v1"
stableunixusersv1 "github.com/gravitational/teleport/api/gen/proto/go/teleport/stableunixusers/v1"
summarizerv1 "github.com/gravitational/teleport/api/gen/proto/go/teleport/summarizer/v1"
trustpb "github.com/gravitational/teleport/api/gen/proto/go/teleport/trust/v1"
userloginstatev1 "github.com/gravitational/teleport/api/gen/proto/go/teleport/userloginstate/v1"
userprovisioningpb "github.com/gravitational/teleport/api/gen/proto/go/teleport/userprovisioning/v2"
userspb "github.com/gravitational/teleport/api/gen/proto/go/teleport/users/v1"
usertaskv1 "github.com/gravitational/teleport/api/gen/proto/go/teleport/usertasks/v1"
"github.com/gravitational/teleport/api/gen/proto/go/teleport/vnet/v1"
workloadidentityv1pb "github.com/gravitational/teleport/api/gen/proto/go/teleport/workloadidentity/v1"
userpreferencespb "github.com/gravitational/teleport/api/gen/proto/go/userpreferences/v1"
"github.com/gravitational/teleport/api/internalutils/stream"
"github.com/gravitational/teleport/api/metadata"
"github.com/gravitational/teleport/api/mfa"
"github.com/gravitational/teleport/api/observability/tracing"
"github.com/gravitational/teleport/api/types"
"github.com/gravitational/teleport/api/types/events"
"github.com/gravitational/teleport/api/types/wrappers"
"github.com/gravitational/teleport/api/utils"
"github.com/gravitational/teleport/api/utils/clientutils"
grpcutils "github.com/gravitational/teleport/api/utils/grpc"
"github.com/gravitational/teleport/api/utils/grpc/interceptors"
)
func init() {
// gzip is used for gRPC auditStream compression. SetLevel changes the
// compression level, must be called in initialization, and is not thread safe.
if err := ggzip.SetLevel(gzip.BestSpeed); err != nil {
panic(err)
}
}
// AuthServiceClient keeps the interfaces implemented by the auth service.
type AuthServiceClient struct {
proto.AuthServiceClient
auditlogpb.AuditLogServiceClient
userpreferencespb.UserPreferencesServiceClient
notificationsv1pb.NotificationServiceClient
recordingencryptionv1pb.RecordingEncryptionServiceClient
}
// Client is a gRPC Client that connects to a Teleport Auth server either
// locally or over ssh through a Teleport web proxy or tunnel proxy.
//
// This client can be used to cover a variety of Teleport use cases,
// such as programmatically handling access requests, integrating
// with external tools, or dynamically configuring Teleport.
type Client struct {
// c contains configuration values for the client.
c Config
// tlsConfig is the *tls.Config for a successfully connected client.
tlsConfig *tls.Config
// dialer is the ContextDialer for a successfully connected client.
dialer ContextDialer
// conn is a grpc connection to the auth server.
conn *grpc.ClientConn
// grpc is the gRPC client specification for the auth server.
grpc AuthServiceClient
// JoinServiceClient is a client for the legacy JoinService, which
// runs on both the auth and proxy.
*JoinServiceClient
// closedFlag is set to indicate that the connection is closed.
// It's a pointer to allow the Client struct to be copied.
closedFlag *int32
}
// New creates a new Client with an open connection to a Teleport server.
//
// New will try to open a connection with all combinations of addresses and credentials.
// The first successful connection to a server will be used, or an aggregated error will
// be returned if all combinations fail.
//
// cfg.Credentials must be non-empty. One of cfg.Addrs and cfg.Dialer must be non-empty,
// unless LoadProfile is used to fetch Credentials and load a web proxy dialer.
//
// See the example below for usage.
func New(ctx context.Context, cfg Config) (*Client, error) {
if err := cfg.CheckAndSetDefaults(); err != nil {
return nil, trace.Wrap(err)
}
// If cfg.DialInBackground is true, only a single connection is attempted.
// This option is primarily meant for internal use where the client has
// direct access to server values that guarantee a successful connection.
if cfg.DialInBackground {
return connectInBackground(ctx, cfg)
}
return connect(ctx, cfg)
}
// NewTracingClient creates a new tracing.Client that will forward spans to the
// connected Teleport server. See New for details on how the connection it
// established.
func NewTracingClient(ctx context.Context, cfg Config) (*tracing.Client, error) {
clt, err := New(ctx, cfg)
if err != nil {
return nil, trace.Wrap(err)
}
return tracing.NewClient(clt.GetConnection()), nil
}
// NewOktaClient creates a new Okta client for managing Okta resources.
func NewOktaClient(ctx context.Context, cfg Config) (*okta.Client, error) {
clt, err := New(ctx, cfg)
if err != nil {
return nil, trace.Wrap(err)
}
return okta.NewClient(oktapb.NewOktaServiceClient(clt.GetConnection())), nil
}
// newClient constructs a new client.
func newClient(cfg Config, dialer ContextDialer, tlsConfig *tls.Config) *Client {
return &Client{
c: cfg,
dialer: dialer,
tlsConfig: ConfigureALPN(tlsConfig, cfg.ALPNSNIAuthDialClusterName),
closedFlag: new(int32),
}
}
// connectInBackground connects the client to the server in the background.
//
// The client will use the first credentials and the given dialer.
//
// If no dialer is given, the first address will be used. If no
// ALPNSNIAuthDialClusterName is given, this address must be an auth server
// address.
//
// If ALPNSNIAuthDialClusterName is given, the address is expected to be a web
// proxy address and the client will connect auth through the web proxy server
// using TLS Routing.
func connectInBackground(ctx context.Context, cfg Config) (*Client, error) {
tlsConfig, err := cfg.Credentials[0].TLSConfig()
if err != nil {
return nil, trace.Wrap(err)
}
if cfg.Dialer != nil {
return dialerConnect(ctx, connectParams{
cfg: cfg,
tlsConfig: tlsConfig,
dialer: cfg.Dialer,
})
} else if len(cfg.Addrs) != 0 {
return authConnect(ctx, connectParams{
cfg: cfg,
tlsConfig: tlsConfig,
addr: cfg.Addrs[0],
})
}
return nil, trace.BadParameter("must provide Dialer or Addrs in config")
}
// connect connects the client to the server using the Credentials and
// Dialer/Addresses provided in the client's config. Multiple goroutines are started
// to make dial attempts with different combinations of dialers and credentials. The
// first client to successfully connect is used to populate the client's connection
// attributes. If none successfully connect, an aggregated error is returned.
func connect(ctx context.Context, cfg Config) (*Client, error) {
ctx, cancel := context.WithCancel(ctx)
defer cancel()
var wg sync.WaitGroup
// sendError is used to send errors to errChan with context.
errChan := make(chan error)
sendError := func(err error) {
errChan <- trace.Wrap(err)
}
// syncConnect is used to concurrently create multiple clients
// with the different combination of connection parameters.
// The first successful client to be sent to cltChan will be returned.
cltChan := make(chan *Client)
syncConnect := func(ctx context.Context, connect connectFunc, params connectParams) {
wg.Add(1)
go func() {
defer wg.Done()
clt, err := connect(ctx, params)
if err != nil {
sendError(trace.Wrap(err))
return
}
select {
case cltChan <- clt:
case <-ctx.Done():
clt.Close()
}
}()
}
wg.Add(1)
go func() {
defer wg.Done()
// Connect with provided credentials.
for _, creds := range cfg.Credentials {
tlsConfig, err := creds.TLSConfig()
if err != nil {
sendError(trace.Wrap(err))
continue
}
sshConfig, err := creds.SSHClientConfig()
if err != nil && !trace.IsNotImplemented(err) {
sendError(trace.Wrap(err))
continue
}
// Connect with dialer provided in config.
if cfg.Dialer != nil {
syncConnect(ctx, dialerConnect, connectParams{
cfg: cfg,
tlsConfig: tlsConfig,
})
}
addrs := cfg.Addrs
if len(addrs) == 0 {
// If there's no explicitly specified address, fall back to
// an address provided by the credential, if it provides one.
credAddrSource, ok := creds.(CredentialsWithDefaultAddrs)
if ok {
addrs, err = credAddrSource.DefaultAddrs()
if err != nil {
sendError(trace.Wrap(err))
continue
}
slog.DebugContext(ctx, "No addresses were configured explicitly, falling back to addresses specified by credential. Consider explicitly configuring an address.", "address", addrs)
}
}
// Attempt to connect to each address as Auth, Proxy, Tunnel and TLS Routing.
for _, addr := range addrs {
syncConnect(ctx, authConnect, connectParams{
cfg: cfg,
tlsConfig: tlsConfig,
addr: addr,
})
if sshConfig != nil {
for _, cf := range []connectFunc{proxyConnect, tunnelConnect, tlsRoutingConnect, tlsRoutingWithConnUpgradeConnect} {
syncConnect(ctx, cf, connectParams{
cfg: cfg,
tlsConfig: tlsConfig,
sshConfig: sshConfig,
addr: addr,
})
}
}
}
}
}()
// Start goroutine to wait for wait group.
go func() {
wg.Wait()
// Close errChan to return errors.
close(errChan)
}()
var errs []error
Outer:
for {
select {
// Use the first client to successfully connect in syncConnect.
case clt := <-cltChan:
go func() {
for range errChan {
}
}()
return clt, nil
case err, ok := <-errChan:
if !ok {
break Outer
}
// Add a new line to make errs human readable.
errs = append(errs, trace.Wrap(err, ""))
}
}
// errChan is closed, return errors.
if len(errs) == 0 {
if len(cfg.Addrs) == 0 && cfg.Dialer == nil {
// Some credentials don't require these fields. If no errors propagate, then they need to provide these fields.
return nil, trace.BadParameter("no connection methods found, try providing Dialer or Addrs in config")
}
// This case should never be reached with config validation and above case.
return nil, trace.Errorf("no connection methods found")
}
if ctx.Err() != nil {
errs = append(errs, trace.Wrap(ctx.Err()))
}
return nil, trace.Wrap(trace.NewAggregate(errs...), "all connection methods failed")
}
type (
connectFunc func(ctx context.Context, params connectParams) (*Client, error)
connectParams struct {
cfg Config
addr string
tlsConfig *tls.Config
dialer ContextDialer
sshConfig *ssh.ClientConfig
}
)
// authConnect connects to the Teleport Auth Server directly or through Proxy.
func authConnect(ctx context.Context, params connectParams) (*Client, error) {
dialer := NewDialer(ctx, params.cfg.KeepAlivePeriod, params.cfg.DialTimeout,
WithInsecureSkipVerify(params.cfg.InsecureAddressDiscovery),
WithALPNConnUpgrade(params.cfg.ALPNConnUpgradeRequired),
WithALPNConnUpgradePing(true), // Use Ping protocol for long-lived connections.
WithPROXYHeaderGetter(params.cfg.PROXYHeaderGetter),
)
clt := newClient(params.cfg, dialer, params.tlsConfig)
if err := clt.dialGRPC(ctx, params.addr); err != nil {
return nil, trace.Wrap(err, "failed to connect to addr %v as an auth server", params.addr)
}
return clt, nil
}
// tunnelConnect connects to the Teleport Auth Server through the proxy's reverse tunnel.
func tunnelConnect(ctx context.Context, params connectParams) (*Client, error) {
if params.sshConfig == nil {
return nil, trace.BadParameter("must provide ssh client config")
}
dialer := newTunnelDialer(*params.sshConfig, params.cfg.KeepAlivePeriod, params.cfg.DialTimeout, WithInsecureSkipVerify(params.cfg.InsecureAddressDiscovery))
clt := newClient(params.cfg, dialer, params.tlsConfig)
if err := clt.dialGRPC(ctx, params.addr); err != nil {
return nil, trace.Wrap(err, "failed to connect to addr %v as a reverse tunnel proxy", params.addr)
}
return clt, nil
}
// proxyConnect connects to the Teleport Auth Server through the proxy.
// takes a specific addr parameter to allow the proxy address to be modified
// when using special credentials.
func proxyConnect(ctx context.Context, params connectParams) (*Client, error) {
if params.sshConfig == nil {
return nil, trace.BadParameter("must provide ssh client config")
}
dialer := NewProxyDialer(
*params.sshConfig,
params.cfg.KeepAlivePeriod,
params.cfg.DialTimeout,
params.addr,
params.cfg.InsecureAddressDiscovery,
WithInsecureSkipVerify(params.cfg.InsecureAddressDiscovery),
)
clt := newClient(params.cfg, dialer, params.tlsConfig)
if err := clt.dialGRPC(ctx, params.addr); err != nil {
return nil, trace.Wrap(err, "failed to connect to addr %v as a web proxy", params.addr)
}
return clt, nil
}
// tlsRoutingConnect connects to the Teleport Auth Server through the proxy using TLS Routing.
func tlsRoutingConnect(ctx context.Context, params connectParams) (*Client, error) {
if params.sshConfig == nil {
return nil, trace.BadParameter("must provide ssh client config")
}
dialer := newTLSRoutingTunnelDialer(*params.sshConfig, params.cfg.KeepAlivePeriod, params.cfg.DialTimeout, params.addr, params.cfg.InsecureAddressDiscovery)
clt := newClient(params.cfg, dialer, params.tlsConfig)
if err := clt.dialGRPC(ctx, params.addr); err != nil {
return nil, trace.Wrap(err, "failed to connect to addr %v with TLS Routing dialer", params.addr)
}
return clt, nil
}
// tlsRoutingWithConnUpgradeConnect connects to the Teleport Auth Server
// through the proxy using TLS Routing with ALPN connection upgrade.
func tlsRoutingWithConnUpgradeConnect(ctx context.Context, params connectParams) (*Client, error) {
if params.sshConfig == nil {
return nil, trace.BadParameter("must provide ssh client config")
}
dialer := newTLSRoutingWithConnUpgradeDialer(*params.sshConfig, params)
clt := newClient(params.cfg, dialer, params.tlsConfig)
if err := clt.dialGRPC(ctx, params.addr); err != nil {
return nil, trace.Wrap(err, "failed to connect to addr %v with TLS Routing with ALPN connection upgrade dialer", params.addr)
}
return clt, nil
}
// dialerConnect connects to the Teleport Auth Server through a custom dialer.
// The dialer must provide the address in a custom ContextDialerFunc function.
func dialerConnect(ctx context.Context, params connectParams) (*Client, error) {
if params.dialer == nil {
if params.cfg.Dialer == nil {
return nil, trace.BadParameter("must provide dialer to connectParams.dialer or params.cfg.Dialer")
}
params.dialer = params.cfg.Dialer
}
clt := newClient(params.cfg, params.dialer, params.tlsConfig)
// Since the client uses a custom dialer to connect to the server and SNI
// is used for the TLS handshake, the address dialed here is arbitrary.
if err := clt.dialGRPC(ctx, constants.APIDomain); err != nil {
return nil, trace.Wrap(err, "failed to connect using pre-defined dialer")
}
return clt, nil
}
// dialGRPC dials a connection between server and client.
func (c *Client) dialGRPC(ctx context.Context, addr string) error {
dialContext, cancel := context.WithTimeout(ctx, c.c.DialTimeout)
defer cancel()
cb, err := breaker.New(c.c.CircuitBreakerConfig)
if err != nil {
return trace.Wrap(err)
}
var dialOpts []grpc.DialOption
dialOpts = append(dialOpts, grpc.WithContextDialer(c.grpcDialer()))
dialOpts = append(dialOpts,
grpc.WithStatsHandler(otelgrpc.NewClientHandler()),
grpc.WithChainUnaryInterceptor(
metadata.UnaryClientInterceptor,
interceptors.GRPCClientUnaryErrorInterceptor,
interceptors.WithMFAUnaryInterceptor(c.PerformMFACeremony),
breaker.UnaryClientInterceptor(cb),
),
grpc.WithChainStreamInterceptor(
metadata.StreamClientInterceptor,
interceptors.GRPCClientStreamErrorInterceptor,
breaker.StreamClientInterceptor(cb),
),
grpc.WithDefaultCallOptions(
grpc.MaxCallRecvMsgSize(grpcutils.MaxClientRecvMsgSize()),
),
)
// Only set transportCredentials if tlsConfig is set. This makes it possible
// to explicitly provide grpc.WithTransportCredentials(insecure.NewCredentials())
// in the client's dial options.
if c.tlsConfig != nil {
dialOpts = append(dialOpts, grpc.WithTransportCredentials(credentials.NewTLS(c.tlsConfig)))
}
// must come last, otherwise provided opts may get clobbered by defaults above
dialOpts = append(dialOpts, c.c.DialOpts...)
conn, err := grpc.DialContext(dialContext, addr, dialOpts...)
if err != nil {
return trace.Wrap(err)
}
c.conn = conn
c.grpc = AuthServiceClient{
AuthServiceClient: proto.NewAuthServiceClient(c.conn),
AuditLogServiceClient: auditlogpb.NewAuditLogServiceClient(c.conn),
UserPreferencesServiceClient: userpreferencespb.NewUserPreferencesServiceClient(c.conn),
NotificationServiceClient: notificationsv1pb.NewNotificationServiceClient(c.conn),
RecordingEncryptionServiceClient: recordingencryptionv1pb.NewRecordingEncryptionServiceClient(c.conn),
}
c.JoinServiceClient = NewJoinServiceClient(proto.NewJoinServiceClient(c.conn))
return nil
}
// ConfigureALPN configures ALPN SNI cluster routing information in TLS settings allowing for
// allowing to dial auth service through Teleport Proxy directly without using SSH Tunnels.
func ConfigureALPN(tlsConfig *tls.Config, clusterName string) *tls.Config {
if tlsConfig == nil {
return nil
}
if clusterName == "" {
return tlsConfig
}
out := tlsConfig.Clone()
routeInfo := fmt.Sprintf("%s%s", constants.ALPNSNIAuthProtocol, utils.EncodeClusterName(clusterName))
out.NextProtos = append([]string{routeInfo}, out.NextProtos...)
return out
}
// grpcDialer wraps the client's dialer with a grpcDialer.
func (c *Client) grpcDialer() func(ctx context.Context, addr string) (net.Conn, error) {
return func(ctx context.Context, addr string) (net.Conn, error) {
if c.isClosed() {
return nil, trace.ConnectionProblem(nil, "client is closed")
}
conn, err := c.dialer.DialContext(ctx, "tcp", addr)
if err != nil {
return nil, trace.ConnectionProblem(err, "failed to dial: %v", err)
}
return conn, nil
}
}
// waitForConnectionReady waits for the client's grpc connection finish dialing, returning an error
// if the ctx is canceled or the client's gRPC connection enters an unexpected state. This can be used
// alongside the DialInBackground client config option to wait until background dialing has completed.
func (c *Client) waitForConnectionReady(ctx context.Context) error {
for {
if c.conn == nil {
return errors.New("conn was closed")
}
switch state := c.conn.GetState(); state {
case connectivity.Ready:
return nil
case connectivity.TransientFailure, connectivity.Connecting, connectivity.Idle:
// Wait for expected state transitions. For details about grpc.ClientConn state changes
// see https://github.com/grpc/grpc/blob/master/doc/connectivity-semantics-and-api.md
if !c.conn.WaitForStateChange(ctx, state) {
// ctx canceled
return trace.Wrap(ctx.Err())
}
case connectivity.Shutdown:
return trace.Errorf("client gRPC connection entered an unexpected state: %v", state)
}
}
}
// Config contains configuration of the client
type Config struct {
// Addrs is a list of teleport auth/proxy server addresses to dial.
// If you are using identity file credentials, at least one address must be supplied.
// This field is optional if you are using tsh profile credentials.
Addrs []string
// Credentials are a list of credentials to use when attempting
// to connect to the server.
Credentials []Credentials
// Dialer is a custom dialer used to dial a server. The Dialer should
// have custom logic to provide an address to the dialer. If set, Dialer
// takes precedence over all other connection options.
Dialer ContextDialer
// DialOpts define options for dialing the client connection.
DialOpts []grpc.DialOption
// DialInBackground specifies to dial the connection in the background
// rather than blocking until the connection is up. A predefined Dialer
// or an auth server address must be provided.
DialInBackground bool
// DialTimeout defines how long to attempt dialing before timing out.
DialTimeout time.Duration
// KeepAlivePeriod defines period between keep alives.
KeepAlivePeriod time.Duration
// KeepAliveCount specifies the amount of missed keep alives
// to wait for before declaring the connection as broken.
KeepAliveCount int
// The web proxy uses a self-signed TLS certificate by default, which
// requires this field to be set. If the web proxy was provided with
// signed TLS certificates, this field should not be set.
InsecureAddressDiscovery bool
// ALPNSNIAuthDialClusterName if present the client will include ALPN SNI routing information in TLS Hello message
// allowing to dial auth service through Teleport Proxy directly without using SSH Tunnels.
ALPNSNIAuthDialClusterName string
// CircuitBreakerConfig defines how the circuit breaker should behave.
CircuitBreakerConfig breaker.Config
// Context is the base context to use for dialing. If not provided context.Background is used
Context context.Context
// ALPNConnUpgradeRequired indicates that ALPN connection upgrades are
// required for making TLS Routing requests.
//
// In DialInBackground mode without a Dialer, a valid value must be
// provided as it's assumed that the caller knows the context if connection
// upgrades are required for TLS Routing.
//
// In default mode, this value is optional as some of the connect methods
// will perform necessary tests to decide if connection upgrade is
// required.
ALPNConnUpgradeRequired bool
// PROXYHeaderGetter returns signed PROXY header that is sent to allow Proxy to propagate client's real IP to the
// auth server from the Proxy's web server, when we create user's client for the web session.
PROXYHeaderGetter PROXYHeaderGetter
// MFAPromptConstructor is used to create MFA prompts when needed.
// If nil, the client will not prompt for MFA.
MFAPromptConstructor mfa.PromptConstructor
// SSOMFACeremonyConstructor is used to handle SSO MFA when needed.
// If nil, the client will not prompt for MFA.
SSOMFACeremonyConstructor mfa.SSOMFACeremonyConstructor
}
// CheckAndSetDefaults checks and sets default config values.
func (c *Config) CheckAndSetDefaults() error {
if len(c.Credentials) == 0 {
return trace.BadParameter("missing connection credentials")
}
if c.KeepAlivePeriod == 0 {
c.KeepAlivePeriod = defaults.ServerKeepAliveTTL()
}
if c.KeepAliveCount == 0 {
c.KeepAliveCount = defaults.KeepAliveCountMax
}
if c.DialTimeout == 0 {
c.DialTimeout = defaults.DefaultIOTimeout
}
if c.CircuitBreakerConfig.Trip == nil || c.CircuitBreakerConfig.IsSuccessful == nil {
c.CircuitBreakerConfig = breaker.DefaultBreakerConfig(clockwork.NewRealClock())
}
if c.Context == nil {
c.Context = context.Background()
}
c.DialOpts = append(c.DialOpts, grpc.WithKeepaliveParams(keepalive.ClientParameters{
Time: c.KeepAlivePeriod,
Timeout: c.KeepAlivePeriod * time.Duration(c.KeepAliveCount),
PermitWithoutStream: true,
}))
if !c.DialInBackground {
c.DialOpts = append(
c.DialOpts,
// Provides additional feedback on connection failure, otherwise,
// users will only receive a `context deadline exceeded` error when
// c.DialInBackground == false.
//
// grpc.WithReturnConnectionError implies grpc.WithBlock which is
// necessary for connection route selection to work properly.
grpc.WithReturnConnectionError(),
)
}
return nil
}
// Config returns the tls.Config the client connected with.
func (c *Client) Config() *tls.Config {
return c.tlsConfig
}
// Dialer returns the ContextDialer the client connected with.
func (c *Client) Dialer() ContextDialer {
return c.dialer
}
// GetConnection returns gRPC connection.
func (c *Client) GetConnection() *grpc.ClientConn {
return c.conn
}
// SetMFAPromptConstructor sets the MFA prompt constructor for this client.
func (c *Client) SetMFAPromptConstructor(pc mfa.PromptConstructor) {
c.c.MFAPromptConstructor = pc
}
// SetSSOMFACeremonyConstructor sets the SSO MFA ceremony constructor for this client.
func (c *Client) SetSSOMFACeremonyConstructor(scc mfa.SSOMFACeremonyConstructor) {
c.c.SSOMFACeremonyConstructor = scc
}
// Close closes the Client connection to the auth server.
func (c *Client) Close() error {
if c.setClosed() && c.conn != nil {
return trace.Wrap(c.conn.Close())
}
return nil
}
// isClosed returns whether the client is marked as closed.
func (c *Client) isClosed() bool {
return atomic.LoadInt32(c.closedFlag) == 1
}
// setClosed marks the client as closed and returns true if it was open.
func (c *Client) setClosed() bool {
return atomic.CompareAndSwapInt32(c.closedFlag, 0, 1)
}
// DevicesClient returns an unadorned Device Trust client, using the underlying
// Auth gRPC connection.
// Clients connecting to non-Enterprise clusters, or older Teleport versions,
// still get a devices client when calling this method, but all RPCs will return
// "not implemented" errors (as per the default gRPC behavior).
func (c *Client) DevicesClient() devicepb.DeviceTrustServiceClient {
return devicepb.NewDeviceTrustServiceClient(c.conn)
}
// CreateDeviceResource creates a device using its resource representation.
// Prefer using [DevicesClient] directly if you can.
func (c *Client) CreateDeviceResource(ctx context.Context, res *types.DeviceV1) (*types.DeviceV1, error) {
dev, err := types.DeviceFromResource(res)
if err != nil {
return nil, trace.Wrap(err)
}
created, err := c.DevicesClient().CreateDevice(ctx, &devicepb.CreateDeviceRequest{
Device: dev,
CreateAsResource: true,
})
if err != nil {
return nil, trace.Wrap(err)
}
return types.DeviceToResource(created), nil
}
// DeleteDeviceResource deletes a device using its ID (either devicepb.Device.Id
// or its Metadata.Name).
// Prefer using [DevicesClient] directly if you can.
func (c *Client) DeleteDeviceResource(ctx context.Context, id string) error {
_, err := c.DevicesClient().DeleteDevice(ctx, &devicepb.DeleteDeviceRequest{
DeviceId: id,
})
return trace.Wrap(err)
}
// GetDeviceResource reads a device using its ID (either devicepb.Device.Id
// or its Metadata.Name).
// Prefer using [DevicesClient] directly if you can.
func (c *Client) GetDeviceResource(ctx context.Context, id string) (*types.DeviceV1, error) {
dev, err := c.DevicesClient().GetDevice(ctx, &devicepb.GetDeviceRequest{
DeviceId: id,
})
if err != nil {
return nil, trace.Wrap(err)
}
return types.DeviceToResource(dev), nil
}
// UpsertDeviceResource creates or updates a device using its resource
// representation.
// Prefer using [DevicesClient] directly if you can.
func (c *Client) UpsertDeviceResource(ctx context.Context, res *types.DeviceV1) (*types.DeviceV1, error) {
dev, err := types.DeviceFromResource(res)
if err != nil {
return nil, trace.Wrap(err)
}
upserted, err := c.DevicesClient().UpsertDevice(ctx, &devicepb.UpsertDeviceRequest{
Device: dev,
CreateAsResource: true,
})
if err != nil {
return nil, trace.Wrap(err)
}
return types.DeviceToResource(upserted), nil
}
// ScopedAccessServiceClient returns an unadorned Scoped Access Service client, using the underlying
// Auth gRPC connection.
func (c *Client) ScopedAccessServiceClient() scopedaccessv1.ScopedAccessServiceClient {
return scopedaccessv1.NewScopedAccessServiceClient(c.conn)
}
// LoginRuleClient returns an unadorned Login Rule client, using the underlying
// Auth gRPC connection.
// Clients connecting to non-Enterprise clusters, or older Teleport versions,
// still get a login rule client when calling this method, but all RPCs will
// return "not implemented" errors (as per the default gRPC behavior).
func (c *Client) LoginRuleClient() loginrulepb.LoginRuleServiceClient {
return loginrulepb.NewLoginRuleServiceClient(c.conn)
}
// SecReportsClient returns Security client that can be used to fetch security reports.
func (c *Client) SecReportsClient() *secreport.Client {
return secreport.NewClient(secreportsv1.NewSecReportsServiceClient(c.conn))
}
// SAMLIdPClient returns an unadorned SAML IdP client, using the underlying
// Auth gRPC connection.
// Clients connecting to non-Enterprise clusters, or older Teleport versions,
// still get a SAML IdP client when calling this method, but all RPCs will
// return "not implemented" errors (as per the default gRPC behavior).
func (c *Client) SAMLIdPClient() samlidppb.SAMLIdPServiceClient {
return samlidppb.NewSAMLIdPServiceClient(c.conn)
}
// ExternalAuditStorageClient returns an unadorned External Audit Storage
// client, using the underlying Auth gRPC connection.
// Clients connecting to non-Enterprise clusters, or older Teleport versions,
// still get a external audit client when calling this method, but all RPCs will
// return "not implemented" errors (as per the default gRPC behavior).
func (c *Client) ExternalAuditStorageClient() *externalauditstorage.Client {
return externalauditstorage.NewClient(externalauditstoragev1.NewExternalAuditStorageServiceClient(c.conn))
}
// TrustClient returns an unadorned Trust client, using the underlying
// Auth gRPC connection.
func (c *Client) TrustClient() trustpb.TrustServiceClient {
return trustpb.NewTrustServiceClient(c.conn)
}
// BotServiceClient returns an unadorned client for the bot service.
func (c *Client) BotServiceClient() machineidv1pb.BotServiceClient {
return machineidv1pb.NewBotServiceClient(c.conn)
}
// BotInstanceServiceClient returns an unadorned client for the bot instance service
func (c *Client) BotInstanceServiceClient() machineidv1pb.BotInstanceServiceClient {
return machineidv1pb.NewBotInstanceServiceClient(c.conn)
}
func (c *Client) SPIFFEFederationServiceClient() machineidv1pb.SPIFFEFederationServiceClient {
return machineidv1pb.NewSPIFFEFederationServiceClient(c.conn)
}
// WorkloadIdentityResourceServiceClient returns an unadorned client for the
// workload identity resource service.
func (c *Client) WorkloadIdentityResourceServiceClient() workloadidentityv1pb.WorkloadIdentityResourceServiceClient {
return workloadidentityv1pb.NewWorkloadIdentityResourceServiceClient(c.conn)
}
// WorkloadIdentityRevocationServiceClient returns an unadorned client for the
// workload identity revocation service.
func (c *Client) WorkloadIdentityRevocationServiceClient() workloadidentityv1pb.WorkloadIdentityRevocationServiceClient {
return workloadidentityv1pb.NewWorkloadIdentityRevocationServiceClient(c.conn)
}
// WorkloadIdentityIssuanceClient returns an unadorned client for the workload
// identity service.
func (c *Client) WorkloadIdentityIssuanceClient() workloadidentityv1pb.WorkloadIdentityIssuanceServiceClient {
return workloadidentityv1pb.NewWorkloadIdentityIssuanceServiceClient(c.conn)
}
// WorkloadIdentityX509OverridesClient returns an unadorned client for the
// teleport.workloadidentity.v1.X509OverridesService service.
func (c *Client) WorkloadIdentityX509OverridesClient() workloadidentityv1pb.X509OverridesServiceClient {
return workloadidentityv1pb.NewX509OverridesServiceClient(c.conn)
}
// SigstorePolicyResourceServiceClient returns an unadorned client for the
// Sigstore policy resource service.
func (c *Client) SigstorePolicyResourceServiceClient() workloadidentityv1pb.SigstorePolicyResourceServiceClient {
return workloadidentityv1pb.NewSigstorePolicyResourceServiceClient(c.conn)
}
// PresenceServiceClient returns an unadorned client for the presence service.
func (c *Client) PresenceServiceClient() presencepb.PresenceServiceClient {
return presencepb.NewPresenceServiceClient(c.conn)
}
// NotificationServiceClient returns a notification service client that can be used to fetch notifications.
func (c *Client) NotificationServiceClient() notificationsv1pb.NotificationServiceClient {
return notificationsv1pb.NewNotificationServiceClient(c.conn)
}
// VnetConfigServiceClient returns an unadorned client for the VNet config service.
func (c *Client) VnetConfigServiceClient() vnet.VnetConfigServiceClient {
return vnet.NewVnetConfigServiceClient(c.conn)
}
// JoinV1Client returns an unadorned gRPC client for the new Join service.
func (c *Client) JoinV1Client() joinv1.JoinServiceClient {
return joinv1.NewJoinServiceClient(c.conn)
}
// SummarizerServiceClient returns an unadorned client for the session
// recording summarizer service.
func (c *Client) SummarizerServiceClient() summarizerv1.SummarizerServiceClient {
return summarizerv1.NewSummarizerServiceClient(c.conn)
}
// RecordingMetadataServiceClient returns an unadorned client for the session
// recording metadata service.
func (c *Client) RecordingMetadataServiceClient() recordingmetadatav1.RecordingMetadataServiceClient {
return recordingmetadatav1.NewRecordingMetadataServiceClient(c.conn)
}
// RecordingEncryptionServiceClient returns an unadorned client for the session
// recording encryption service.
func (c *Client) RecordingEncryptionServiceClient() recordingencryptionv1pb.RecordingEncryptionServiceClient {
return recordingencryptionv1pb.NewRecordingEncryptionServiceClient(c.conn)
}
// GetVnetConfig returns the singleton VnetConfig resource.
func (c *Client) GetVnetConfig(ctx context.Context) (*vnet.VnetConfig, error) {
return c.VnetConfigServiceClient().GetVnetConfig(ctx, &vnet.GetVnetConfigRequest{})
}
// Ping gets basic info about the auth server.
func (c *Client) Ping(ctx context.Context) (proto.PingResponse, error) {
rsp, err := c.grpc.Ping(ctx, &proto.PingRequest{})
if err != nil {
return proto.PingResponse{}, trace.Wrap(err)
}
return *rsp, nil
}
// CreateUser creates a new user from the specified descriptor.
func (c *Client) CreateUser(ctx context.Context, user types.User) (types.User, error) {
userV2, ok := user.(*types.UserV2)
if !ok {
return nil, trace.BadParameter("unsupported user type %T", user)
}
resp, err := userspb.NewUsersServiceClient(c.conn).CreateUser(ctx, &userspb.CreateUserRequest{User: userV2})
if err != nil {
return nil, trace.Wrap(err)
}
return resp.User, trace.Wrap(err)
}
// UpsertUser creates a new user or updates an existing user.
func (c *Client) UpsertUser(ctx context.Context, user types.User) (types.User, error) {
userV2, ok := user.(*types.UserV2)
if !ok {
return nil, trace.BadParameter("unsupported user type %T", user)
}
resp, err := userspb.NewUsersServiceClient(c.conn).UpsertUser(ctx, &userspb.UpsertUserRequest{User: userV2})
if err != nil {
return nil, trace.Wrap(err)
}
return resp.User, trace.Wrap(err)
}
// UpdateUser updates an existing user in a backend.
func (c *Client) UpdateUser(ctx context.Context, user types.User) (types.User, error) {
userV2, ok := user.(*types.UserV2)
if !ok {
return nil, trace.BadParameter("unsupported user type %T", user)
}
resp, err := userspb.NewUsersServiceClient(c.conn).UpdateUser(ctx, &userspb.UpdateUserRequest{User: userV2})
if err != nil {
return nil, trace.Wrap(err)
}
return resp.User, trace.Wrap(err)
}
// GetUser returns a list of usernames registered in the system.
// withSecrets controls whether authentication details are returned.
func (c *Client) GetUser(ctx context.Context, name string, withSecrets bool) (types.User, error) {
if name == "" {
return nil, trace.BadParameter("missing username")
}
resp, err := userspb.NewUsersServiceClient(c.conn).GetUser(ctx, &userspb.GetUserRequest{Name: name, WithSecrets: withSecrets})
if err != nil {
return nil, trace.Wrap(err)
}
return resp.User, nil
}
// GetCurrentUser returns current user as seen by the server.
// Useful especially in the context of remote clusters which perform role and trait mapping.
func (c *Client) GetCurrentUser(ctx context.Context) (types.User, error) {
resp, err := userspb.NewUsersServiceClient(c.conn).GetUser(ctx, &userspb.GetUserRequest{CurrentUser: true})
if err != nil {
return nil, trace.Wrap(err)
}
return resp.User, nil
}
// GetCurrentUserRoles returns current user's roles.
func (c *Client) GetCurrentUserRoles(ctx context.Context) ([]types.Role, error) {
stream, err := c.grpc.GetCurrentUserRoles(ctx, &emptypb.Empty{})
if err != nil {
return nil, trace.Wrap(err)
}
var roles []types.Role
for role, err := stream.Recv(); !errors.Is(err, io.EOF); role, err = stream.Recv() {
if err != nil {
return nil, trace.Wrap(err)
}
roles = append(roles, role)
}
return roles, nil
}
// GetUsers returns all currently registered users.
// withSecrets controls whether authentication details are returned.
func (c *Client) GetUsers(ctx context.Context, withSecrets bool) ([]types.User, error) {
req := userspb.ListUsersRequest{
WithSecrets: withSecrets,
}
var out []types.User
for {
rsp, err := c.ListUsers(ctx, &req)
if err != nil {
return nil, trace.Wrap(err)
}
for _, user := range rsp.Users {
out = append(out, user)
}
req.PageToken = rsp.NextPageToken
if req.PageToken == "" {
break
}
}
return out, nil
}
// ListUsers returns a page of users.
func (c *Client) ListUsers(ctx context.Context, req *userspb.ListUsersRequest) (*userspb.ListUsersResponse, error) {
var header gmetadata.MD
rsp, err := userspb.NewUsersServiceClient(c.conn).ListUsers(ctx, req, grpc.Header(&header))
if err != nil {
return nil, trace.Wrap(err)
}
if req.Filter == nil {
// remaining logic is all filter compat that we can skip
return rsp, nil
}
vs, _ := metadata.VersionFromMetadata(header)
ver, _ := semver.NewVersion(vs)
if ver != nil && ver.Major >= 16 {
// auth implements all expected filtering features
return rsp, nil
}
filtered := rsp.Users[:0]
for _, user := range rsp.Users {
if req.Filter.Match(user) {
filtered = append(filtered, user)
}
}
rsp.Users = filtered
return rsp, nil
}
// DeleteUser deletes a user by name.
func (c *Client) DeleteUser(ctx context.Context, user string) error {
_, err := userspb.NewUsersServiceClient(c.conn).DeleteUser(ctx, &userspb.DeleteUserRequest{Name: user})
return trace.Wrap(err)
}
// GenerateUserCerts takes the public key in the OpenSSH `authorized_keys` plain
// text format, signs it using User Certificate Authority signing key and
// returns the resulting certificates.
func (c *Client) GenerateUserCerts(ctx context.Context, req proto.UserCertsRequest) (*proto.Certs, error) {
certs, err := c.grpc.GenerateUserCerts(ctx, &req)
return certs, trace.Wrap(err)
}
// GenerateHostCerts generates host certificates.
func (c *Client) GenerateHostCerts(ctx context.Context, req *proto.HostCertsRequest) (*proto.Certs, error) {
if err := req.CheckAndSetDefaults(); err != nil {
return nil, trace.Wrap(err)
}
certs, err := c.grpc.GenerateHostCerts(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return certs, nil
}
// GenerateOpenSSHCert signs a SSH certificate that can be used
// to connect to Agentless nodes.
func (c *Client) GenerateOpenSSHCert(ctx context.Context, req *proto.OpenSSHCertRequest) (*proto.OpenSSHCert, error) {
cert, err := c.grpc.GenerateOpenSSHCert(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return cert, nil
}
// AssertSystemRole is used by agents to prove that they have a given system role when their credentials originate
// from multiple separate join tokens so that they can be issued an instance certificate that encompasses
// all of their capabilities. This method will be deprecated once we have a more comprehensive
// model for join token joining/replacement.
func (c *Client) AssertSystemRole(ctx context.Context, req proto.SystemRoleAssertion) error {
_, err := c.grpc.AssertSystemRole(ctx, &req)
return trace.Wrap(err)
}
// EmitAuditEvent sends an auditable event to the auth server.
func (c *Client) EmitAuditEvent(ctx context.Context, event events.AuditEvent) error {
grpcEvent, err := events.ToOneOf(event)
if err != nil {
return trace.Wrap(err)
}
_, err = c.grpc.EmitAuditEvent(context.WithoutCancel(ctx), grpcEvent)
if err != nil {
return trace.Wrap(err)
}
return nil
}
// GetResetPasswordToken returns a reset password token for the specified tokenID.
func (c *Client) GetResetPasswordToken(ctx context.Context, tokenID string) (types.UserToken, error) {
token, err := c.grpc.GetResetPasswordToken(ctx, &proto.GetResetPasswordTokenRequest{
TokenID: tokenID,
})
if err != nil {
return nil, trace.Wrap(err)
}
return token, nil
}
// CreateResetPasswordToken creates reset password token.
func (c *Client) CreateResetPasswordToken(ctx context.Context, req *proto.CreateResetPasswordTokenRequest) (types.UserToken, error) {
token, err := c.grpc.CreateResetPasswordToken(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return token, nil
}
func (c *Client) ListResetPasswordTokens(ctx context.Context, pageSize int, pageToken string) ([]types.UserToken, string, error) {
req := &proto.ListResetPasswordTokenRequest{
PageSize: int32(pageSize),
PageToken: pageToken,
}
resp, err := c.grpc.ListResetPasswordTokens(ctx, req)
if err != nil {
return nil, "", trace.Wrap(err)
}
// Convert concrete type []*types.UserTokenV3 to interface type []types.UserToken
tokens := make([]types.UserToken, len(resp.UserTokens))
for i, token := range resp.UserTokens {
tokens[i] = token
}
return tokens, resp.NextPageToken, nil
}
// GetAccessRequests retrieves a list of all access requests matching the provided filter.
func (c *Client) GetAccessRequests(ctx context.Context, filter types.AccessRequestFilter) ([]types.AccessRequest, error) {
requests, err := c.ListAllAccessRequests(ctx, &proto.ListAccessRequestsRequest{
Filter: &filter,
})
if err != nil {
return nil, trace.Wrap(err)
}
ireqs := make([]types.AccessRequest, 0, len(requests))
for _, r := range requests {
ireqs = append(ireqs, r)
}
return ireqs, nil
}
// ListAccessRequests is an access request getter with pagination and sorting options.
func (c *Client) ListAccessRequests(ctx context.Context, req *proto.ListAccessRequestsRequest) (*proto.ListAccessRequestsResponse, error) {
rsp, err := c.grpc.ListAccessRequests(ctx, req)
return rsp, trace.Wrap(err)
}
// ListAllAccessRequests aggregates all access requests via the ListAccessRequests api. This is equivalent to calling GetAccessRequests
// except that it supports custom sort order/indexes. Calling this method rather than ListAccessRequests also provides the advantage
// that it can fallback to calling the old GetAccessRequests grpc method if it encounters and outdated control plane. For that reason,
// implementations that don't actually *need* pagination are better served by calling this method.
func (c *Client) ListAllAccessRequests(ctx context.Context, req *proto.ListAccessRequestsRequest) ([]*types.AccessRequestV3, error) {
var requests []*types.AccessRequestV3
for {
rsp, err := c.ListAccessRequests(ctx, req)
if err != nil {
if trace.IsNotImplemented(err) {
return c.listAllAccessRequestsCompat(ctx, req)
}
return nil, trace.Wrap(err)
}
requests = append(requests, rsp.AccessRequests...)
req.StartKey = rsp.NextKey
if req.StartKey == "" {
break
}
}
return requests, nil
}
// listAllAccessRequestsCompat is a helper that simulates ListAllAccessRequests behavior via the old GetAccessRequests method.
func (c *Client) listAllAccessRequestsCompat(ctx context.Context, req *proto.ListAccessRequestsRequest) ([]*types.AccessRequestV3, error) {
var filter types.AccessRequestFilter
if req.Filter != nil {
filter = *req.Filter
}
requests, err := c.getAccessRequests(ctx, filter)
if err != nil {
return nil, trace.Wrap(err)
}
switch req.Sort {
case proto.AccessRequestSort_DEFAULT:
// no custom sort order needed
case proto.AccessRequestSort_CREATED:
slices.SortFunc(requests, func(a, b *types.AccessRequestV3) int {
return a.GetCreationTime().Compare(b.GetCreationTime())
})
case proto.AccessRequestSort_STATE:
slices.SortFunc(requests, func(a, b *types.AccessRequestV3) int {
return cmp.Compare(a.GetState().String(), b.GetState().String())
})
default:
return nil, trace.BadParameter("list access request compat fallback does not support sort order %q", req.Sort)
}
if req.Descending {
slices.Reverse(requests)
}
return requests, nil
}
// getAccessRequests calls the old GetAccessRequests method. used by back-compat logic when interacting with
// an outdated control-plane that doesn't support ListAccessRequests.
func (c *Client) getAccessRequests(ctx context.Context, filter types.AccessRequestFilter) ([]*types.AccessRequestV3, error) {
stream, err := c.grpc.GetAccessRequestsV2(ctx, &filter)
if err != nil {
return nil, trace.Wrap(err)
}
var reqs []*types.AccessRequestV3
for {
req, err := stream.Recv()
if errors.Is(err, io.EOF) {
break
}
if err != nil {
return nil, trace.Wrap(err)
}
reqs = append(reqs, req)
}
return reqs, nil
}
// CreateAccessRequestV2 registers a new access request with the auth server.
func (c *Client) CreateAccessRequestV2(ctx context.Context, req types.AccessRequest) (types.AccessRequest, error) {
r, ok := req.(*types.AccessRequestV3)
if !ok {
return nil, trace.BadParameter("unexpected access request type %T", req)
}
resp, err := c.grpc.CreateAccessRequestV2(ctx, r)
return resp, trace.Wrap(err)
}
// DeleteAccessRequest deletes an access request.
func (c *Client) DeleteAccessRequest(ctx context.Context, reqID string) error {
_, err := c.grpc.DeleteAccessRequest(ctx, &proto.RequestID{ID: reqID})
return trace.Wrap(err)
}
// GetAccessRequestAllowedPromotions returns the list of promotions allowed for the given access request.
func (c *Client) GetAccessRequestAllowedPromotions(ctx context.Context, req types.AccessRequest) (*types.AccessRequestAllowedPromotions, error) {
resp, err := c.grpc.GetAccessRequestAllowedPromotions(ctx, &proto.AccessRequestAllowedPromotionRequest{
AccessRequestID: req.GetName(),
})
if err != nil {
return nil, trace.Wrap(err)
}
return resp.AllowedPromotions, nil
}
// SetAccessRequestState updates the state of an existing access request.
func (c *Client) SetAccessRequestState(ctx context.Context, params types.AccessRequestUpdate) error {
setter := proto.RequestStateSetter{
ID: params.RequestID,
State: params.State,
Reason: params.Reason,
Annotations: params.Annotations,
Roles: params.Roles,
AssumeStartTime: params.AssumeStartTime,
}
if d := utils.GetDelegator(ctx); d != "" {
setter.Delegator = d
}
_, err := c.grpc.SetAccessRequestState(ctx, &setter)
return trace.Wrap(err)
}
// SubmitAccessReview applies a review to a request and returns the post-application state.
func (c *Client) SubmitAccessReview(ctx context.Context, params types.AccessReviewSubmission) (types.AccessRequest, error) {
req, err := c.grpc.SubmitAccessReview(ctx, &params)
if err != nil {
return nil, trace.Wrap(err)
}
return req, nil
}
// GetAccessCapabilities requests the access capabilities of a user.
func (c *Client) GetAccessCapabilities(ctx context.Context, req types.AccessCapabilitiesRequest) (*types.AccessCapabilities, error) {
caps, err := c.grpc.GetAccessCapabilities(ctx, &req)
if err != nil {
return nil, trace.Wrap(err)
}
return caps, nil
}
// GetRemoteAccessCapabilities requests the access capabilities of a user.
func (c *Client) GetRemoteAccessCapabilities(ctx context.Context, req types.RemoteAccessCapabilitiesRequest) (*types.RemoteAccessCapabilities, error) {
caps, err := c.grpc.GetRemoteAccessCapabilities(ctx, &req)
if err != nil {
return nil, trace.Wrap(err)
}
return caps, nil
}
// GetPluginData loads all plugin data matching the supplied filter.
func (c *Client) GetPluginData(ctx context.Context, filter types.PluginDataFilter) ([]types.PluginData, error) {
seq, err := c.grpc.GetPluginData(ctx, &filter)
if err != nil {
return nil, trace.Wrap(err)
}
data := make([]types.PluginData, 0, len(seq.PluginData))
for _, d := range seq.PluginData {
data = append(data, d)
}
return data, nil
}
// UpdatePluginData updates a per-resource PluginData entry.
func (c *Client) UpdatePluginData(ctx context.Context, params types.PluginDataUpdateParams) error {
_, err := c.grpc.UpdatePluginData(ctx, &params)
return trace.Wrap(err)
}
// AcquireSemaphore acquires lease with requested resources from semaphore.
func (c *Client) AcquireSemaphore(ctx context.Context, params types.AcquireSemaphoreRequest) (*types.SemaphoreLease, error) {
lease, err := c.grpc.AcquireSemaphore(ctx, &params)
if err != nil {
return nil, trace.Wrap(err)
}
return lease, nil
}
// KeepAliveSemaphoreLease updates semaphore lease.
func (c *Client) KeepAliveSemaphoreLease(ctx context.Context, lease types.SemaphoreLease) error {
_, err := c.grpc.KeepAliveSemaphoreLease(ctx, &lease)
return trace.Wrap(err)
}
// CancelSemaphoreLease cancels semaphore lease early.
func (c *Client) CancelSemaphoreLease(ctx context.Context, lease types.SemaphoreLease) error {
_, err := c.grpc.CancelSemaphoreLease(ctx, &lease)
return trace.Wrap(err)
}
// GetSemaphores returns a list of all semaphores matching the supplied filter.
func (c *Client) GetSemaphores(ctx context.Context, filter types.SemaphoreFilter) ([]types.Semaphore, error) {
rsp, err := c.grpc.GetSemaphores(ctx, &filter)
if err != nil {
return nil, trace.Wrap(err)
}
sems := make([]types.Semaphore, 0, len(rsp.Semaphores))
for _, s := range rsp.Semaphores {
sems = append(sems, s)
}
return sems, nil
}
// DeleteSemaphore deletes a semaphore matching the supplied filter.
func (c *Client) DeleteSemaphore(ctx context.Context, filter types.SemaphoreFilter) error {
_, err := c.grpc.DeleteSemaphore(ctx, &filter)
return trace.Wrap(err)
}
// GetKubernetesServers returns the list of kubernetes servers registered in the
// cluster.
func (c *Client) GetKubernetesServers(ctx context.Context) ([]types.KubeServer, error) {
servers, err := GetAllResources[types.KubeServer](ctx, c, &proto.ListResourcesRequest{
Namespace: defaults.Namespace,
ResourceType: types.KindKubeServer,
})
return servers, trace.Wrap(err)
}
// DeleteKubernetesServer deletes a named kubernetes server.
func (c *Client) DeleteKubernetesServer(ctx context.Context, hostID, name string) error {
_, err := c.grpc.DeleteKubernetesServer(ctx, &proto.DeleteKubernetesServerRequest{
HostID: hostID,
Name: name,
})
return trace.Wrap(err)
}
// DeleteAllKubernetesServers deletes all registered kubernetes servers.
func (c *Client) DeleteAllKubernetesServers(ctx context.Context) error {
_, err := c.grpc.DeleteAllKubernetesServers(ctx, &proto.DeleteAllKubernetesServersRequest{})
return trace.Wrap(err)
}
// UpsertKubernetesServer is used by kubernetes services to report their presence
// to other auth servers in form of heartbeat expiring after ttl period.
func (c *Client) UpsertKubernetesServer(ctx context.Context, s types.KubeServer) (*types.KeepAlive, error) {
server, ok := s.(*types.KubernetesServerV3)
if !ok {
return nil, trace.BadParameter("invalid type %T, expected *types.KubernetesServerV3", server)
}
keepAlive, err := c.grpc.UpsertKubernetesServer(ctx, &proto.UpsertKubernetesServerRequest{Server: server})
if err != nil {
return nil, trace.Wrap(err)
}
return keepAlive, nil
}
// GetApplicationServers returns all registered application servers.
func (c *Client) GetApplicationServers(ctx context.Context, namespace string) ([]types.AppServer, error) {
servers, err := GetAllResources[types.AppServer](ctx, c, &proto.ListResourcesRequest{
Namespace: namespace,
ResourceType: types.KindAppServer,
})
return servers, trace.Wrap(err)
}
// UpsertApplicationServer registers an application server.
func (c *Client) UpsertApplicationServer(ctx context.Context, server types.AppServer) (*types.KeepAlive, error) {
s, ok := server.(*types.AppServerV3)
if !ok {
return nil, trace.BadParameter("invalid type %T", server)
}
keepAlive, err := c.grpc.UpsertApplicationServer(ctx, &proto.UpsertApplicationServerRequest{
Server: s,
})
if err != nil {
return nil, trace.Wrap(err)
}
return keepAlive, nil
}
// DeleteApplicationServer removes specified application server.
func (c *Client) DeleteApplicationServer(ctx context.Context, namespace, hostID, name string) error {
_, err := c.grpc.DeleteApplicationServer(ctx, &proto.DeleteApplicationServerRequest{
Namespace: namespace,
HostID: hostID,
Name: name,
})
return trace.Wrap(err)
}
// DeleteAllApplicationServers removes all registered application servers.
func (c *Client) DeleteAllApplicationServers(ctx context.Context, namespace string) error {
_, err := c.grpc.DeleteAllApplicationServers(ctx, &proto.DeleteAllApplicationServersRequest{
Namespace: namespace,
})
return trace.Wrap(err)
}
// GetAppSession gets an application web session.
func (c *Client) GetAppSession(ctx context.Context, req types.GetAppSessionRequest) (types.WebSession, error) {
resp, err := c.grpc.GetAppSession(ctx, &proto.GetAppSessionRequest{
SessionID: req.SessionID,
})
if err != nil {
return nil, trace.Wrap(err)
}
return resp.GetSession(), nil
}
// ListAppSessions gets a paginated list of application web sessions.
func (c *Client) ListAppSessions(ctx context.Context, pageSize int, pageToken, user string) ([]types.WebSession, string, error) {
resp, err := c.grpc.ListAppSessions(
ctx,
&proto.ListAppSessionsRequest{
PageSize: int32(pageSize),
PageToken: pageToken,
User: user,
})
if err != nil {
return nil, "", trace.Wrap(err)
}
out := make([]types.WebSession, 0, len(resp.GetSessions()))
for _, v := range resp.GetSessions() {
out = append(out, v)
}
return out, resp.NextPageToken, nil
}
// GetSnowflakeSessions gets all Snowflake web sessions.
func (c *Client) GetSnowflakeSessions(ctx context.Context) ([]types.WebSession, error) {
resp, err := c.grpc.GetSnowflakeSessions(ctx, &emptypb.Empty{})
if err != nil {
return nil, trace.Wrap(err)
}
out := make([]types.WebSession, 0, len(resp.GetSessions()))
for _, v := range resp.GetSessions() {
out = append(out, v)
}
return out, nil
}
// CreateAppSession creates an application web session. Application web
// sessions represent a browser session the client holds.
func (c *Client) CreateAppSession(ctx context.Context, req *proto.CreateAppSessionRequest) (types.WebSession, error) {
resp, err := c.grpc.CreateAppSession(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp.GetSession(), nil
}
// CreateSnowflakeSession creates a Snowflake web session.
func (c *Client) CreateSnowflakeSession(ctx context.Context, req types.CreateSnowflakeSessionRequest) (types.WebSession, error) {
resp, err := c.grpc.CreateSnowflakeSession(ctx, &proto.CreateSnowflakeSessionRequest{
Username: req.Username,
SessionToken: req.SessionToken,
TokenTTL: proto.Duration(req.TokenTTL),
})
if err != nil {
return nil, trace.Wrap(err)
}
return resp.GetSession(), nil
}
// GetSnowflakeSession gets a Snowflake web session.
func (c *Client) GetSnowflakeSession(ctx context.Context, req types.GetSnowflakeSessionRequest) (types.WebSession, error) {
resp, err := c.grpc.GetSnowflakeSession(ctx, &proto.GetSnowflakeSessionRequest{
SessionID: req.SessionID,
})
if err != nil {
return nil, trace.Wrap(err)
}
return resp.GetSession(), nil
}
// DeleteAppSession removes an application web session.
func (c *Client) DeleteAppSession(ctx context.Context, req types.DeleteAppSessionRequest) error {
_, err := c.grpc.DeleteAppSession(ctx, &proto.DeleteAppSessionRequest{
SessionID: req.SessionID,
})
return trace.Wrap(err)
}
// DeleteSnowflakeSession removes a Snowflake web session.
func (c *Client) DeleteSnowflakeSession(ctx context.Context, req types.DeleteSnowflakeSessionRequest) error {
_, err := c.grpc.DeleteSnowflakeSession(ctx, &proto.DeleteSnowflakeSessionRequest{
SessionID: req.SessionID,
})
return trace.Wrap(err)
}
// DeleteAllAppSessions removes all application web sessions.
func (c *Client) DeleteAllAppSessions(ctx context.Context) error {
_, err := c.grpc.DeleteAllAppSessions(ctx, &emptypb.Empty{})
return trace.Wrap(err)
}
// DeleteAllSnowflakeSessions removes all Snowflake web sessions.
func (c *Client) DeleteAllSnowflakeSessions(ctx context.Context) error {
_, err := c.grpc.DeleteAllSnowflakeSessions(ctx, &emptypb.Empty{})
return trace.Wrap(err)
}
// DeleteUserAppSessions deletes all users application sessions.
func (c *Client) DeleteUserAppSessions(ctx context.Context, req *proto.DeleteUserAppSessionsRequest) error {
_, err := c.grpc.DeleteUserAppSessions(ctx, req)
return trace.Wrap(err)
}
// GenerateAppToken creates a JWT token with application access.
func (c *Client) GenerateAppToken(ctx context.Context, req types.GenerateAppTokenRequest) (string, error) {
traits := map[string]*wrappers.StringValues{}
for traitName, traitValues := range req.Traits {
traits[traitName] = &wrappers.StringValues{
Values: traitValues,
}
}
resp, err := c.grpc.GenerateAppToken(ctx, &proto.GenerateAppTokenRequest{
Username: req.Username,
Roles: req.Roles,
Traits: traits,
URI: req.URI,
Expires: req.Expires,
})
if err != nil {
return "", trace.Wrap(err)
}
return resp.GetToken(), nil
}
// GenerateSnowflakeJWT generates JWT in the Snowflake required format.
func (c *Client) GenerateSnowflakeJWT(ctx context.Context, req types.GenerateSnowflakeJWT) (string, error) {
resp, err := c.grpc.GenerateSnowflakeJWT(ctx, &proto.SnowflakeJWTRequest{
UserName: req.Username,
AccountName: req.Account,
})
if err != nil {
return "", trace.Wrap(err)
}
return resp.GetToken(), nil
}
// GetDatabaseServers returns all registered database proxy servers.
//
// Note that in HA setups, a registered database may have multiple
// DatabaseServer entries. Web UI and `tsh db ls` extract databases from this
// list and remove duplicates by name.
func (c *Client) GetDatabaseServers(ctx context.Context, namespace string) ([]types.DatabaseServer, error) {
servers, err := GetAllResources[types.DatabaseServer](ctx, c, &proto.ListResourcesRequest{
Namespace: namespace,
ResourceType: types.KindDatabaseServer,
})
return servers, trace.Wrap(err)
}
// UpsertDatabaseServer registers a new database proxy server.
func (c *Client) UpsertDatabaseServer(ctx context.Context, server types.DatabaseServer) (*types.KeepAlive, error) {
s, ok := server.(*types.DatabaseServerV3)
if !ok {
return nil, trace.BadParameter("invalid type %T", server)
}
keepAlive, err := c.grpc.UpsertDatabaseServer(ctx, &proto.UpsertDatabaseServerRequest{
Server: s,
})
if err != nil {
return nil, trace.Wrap(err)
}
return keepAlive, nil
}
// DeleteDatabaseServer removes the specified database proxy server.
func (c *Client) DeleteDatabaseServer(ctx context.Context, namespace, hostID, name string) error {
_, err := c.grpc.DeleteDatabaseServer(ctx, &proto.DeleteDatabaseServerRequest{
Namespace: namespace,
HostID: hostID,
Name: name,
})
if err != nil {
return trace.Wrap(err)
}
return nil
}
// DeleteAllDatabaseServers removes all registered database proxy servers.
func (c *Client) DeleteAllDatabaseServers(ctx context.Context, namespace string) error {
_, err := c.grpc.DeleteAllDatabaseServers(ctx, &proto.DeleteAllDatabaseServersRequest{
Namespace: namespace,
})
if err != nil {
return trace.Wrap(err)
}
return nil
}
// SignDatabaseCSR generates a client certificate used by proxy when talking
// to a remote database service.
func (c *Client) SignDatabaseCSR(ctx context.Context, req *proto.DatabaseCSRRequest) (*proto.DatabaseCSRResponse, error) {
resp, err := c.grpc.SignDatabaseCSR(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GenerateDatabaseCert generates a client certificate used by a database
// service to authenticate with the database instance, or a server certificate
// for configuring a self-hosted database, depending on the requester_name.
func (c *Client) GenerateDatabaseCert(ctx context.Context, req *proto.DatabaseCertRequest) (*proto.DatabaseCertResponse, error) {
resp, err := c.grpc.GenerateDatabaseCert(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GetRole returns role by name
func (c *Client) GetRole(ctx context.Context, name string) (types.Role, error) {
if name == "" {
return nil, trace.BadParameter("missing name")
}
role, err := c.grpc.GetRole(ctx, &proto.GetRoleRequest{Name: name})
if err != nil {
return nil, trace.Wrap(err)
}
return role, nil
}
// GetRoles returns a list of roles
func (c *Client) GetRoles(ctx context.Context) ([]types.Role, error) {
var roles []types.Role
var req proto.ListRolesRequest
for {
rsp, err := c.ListRoles(ctx, &req)
if err != nil {
return nil, trace.Wrap(err)
}
for _, r := range rsp.Roles {
roles = append(roles, r)
}
req.StartKey = rsp.NextKey
if req.StartKey == "" {
break
}
}
return roles, nil
}
// ListRoles is a paginated role getter.
func (c *Client) ListRoles(ctx context.Context, req *proto.ListRolesRequest) (*proto.ListRolesResponse, error) {
var header gmetadata.MD
rsp, err := c.grpc.ListRoles(ctx, req, grpc.Header(&header))
if err != nil {
return nil, trace.Wrap(err)
}
if req.Filter == nil {
// remaining logic is all filter compat that we can skip
return rsp, nil
}
vs, _ := metadata.VersionFromMetadata(header)
ver, _ := semver.NewVersion(vs)
if ver != nil && ver.Major >= 16 {
// auth implements all expected filtering features
return rsp, nil
}
filtered := rsp.Roles[:0]
for _, role := range rsp.Roles {
if req.Filter.Match(role) {
filtered = append(filtered, role)
}
}
rsp.Roles = filtered
return rsp, nil
}
// ListRequestableRoles is a paginated requestable role getter.
func (c *Client) ListRequestableRoles(ctx context.Context, req *proto.ListRequestableRolesRequest) (*proto.ListRequestableRolesResponse, error) {
rsp, err := c.grpc.ListRequestableRoles(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return rsp, nil
}
// CreateRole creates a new role.
func (c *Client) CreateRole(ctx context.Context, role types.Role) (types.Role, error) {
r, ok := role.(*types.RoleV6)
if !ok {
return nil, trace.BadParameter("invalid type %T", role)
}
created, err := c.grpc.CreateRole(ctx, &proto.CreateRoleRequest{Role: r})
return created, trace.Wrap(err)
}
// UpdateRole updates an already existing role.
func (c *Client) UpdateRole(ctx context.Context, role types.Role) (types.Role, error) {
r, ok := role.(*types.RoleV6)
if !ok {
return nil, trace.BadParameter("invalid type %T", role)
}
updated, err := c.grpc.UpdateRole(ctx, &proto.UpdateRoleRequest{Role: r})
return updated, trace.Wrap(err)
}
// UpsertRole creates or updates a role.
func (c *Client) UpsertRole(ctx context.Context, role types.Role) (types.Role, error) {
r, ok := role.(*types.RoleV6)
if !ok {
return nil, trace.BadParameter("invalid type %T", role)
}
upserted, err := c.grpc.UpsertRoleV2(ctx, &proto.UpsertRoleRequest{Role: r})
if err != nil && trace.IsNotImplemented(err) {
//nolint:staticcheck // SA1019. Kept for backward compatibility.
_, err := c.grpc.UpsertRole(ctx, r)
if err != nil {
return nil, trace.Wrap(err)
}
r, err := c.grpc.GetRole(ctx, &proto.GetRoleRequest{Name: role.GetName()})
return r, trace.Wrap(err)
}
return upserted, trace.Wrap(err)
}
// DeleteRole deletes role by name
func (c *Client) DeleteRole(ctx context.Context, name string) error {
if name == "" {
return trace.BadParameter("missing name")
}
_, err := c.grpc.DeleteRole(ctx, &proto.DeleteRoleRequest{Name: name})
return trace.Wrap(err)
}
// AddMFADeviceSync adds a new MFA device.
func (c *Client) AddMFADeviceSync(ctx context.Context, in *proto.AddMFADeviceSyncRequest) (*proto.AddMFADeviceSyncResponse, error) {
res, err := c.grpc.AddMFADeviceSync(ctx, in)
return res, trace.Wrap(err)
}
// DeleteMFADeviceSync deletes a users MFA device.
func (c *Client) DeleteMFADeviceSync(ctx context.Context, in *proto.DeleteMFADeviceSyncRequest) error {
_, err := c.grpc.DeleteMFADeviceSync(ctx, in)
return trace.Wrap(err)
}
func (c *Client) GetMFADevices(ctx context.Context, in *proto.GetMFADevicesRequest) (*proto.GetMFADevicesResponse, error) {
resp, err := c.grpc.GetMFADevices(ctx, in)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
func (c *Client) IsMFARequired(ctx context.Context, req *proto.IsMFARequiredRequest) (*proto.IsMFARequiredResponse, error) {
resp, err := c.grpc.IsMFARequired(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GetOIDCConnector returns an OIDC connector by name.
func (c *Client) GetOIDCConnector(ctx context.Context, name string, withSecrets bool) (types.OIDCConnector, error) {
if name == "" {
return nil, trace.BadParameter("cannot get OIDC Connector, missing name")
}
req := &types.ResourceWithSecretsRequest{Name: name, WithSecrets: withSecrets}
resp, err := c.grpc.GetOIDCConnector(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GetOIDCConnectors returns a list of OIDC connectors.
func (c *Client) GetOIDCConnectors(ctx context.Context, withSecrets bool) ([]types.OIDCConnector, error) {
req := &types.ResourcesWithSecretsRequest{WithSecrets: withSecrets}
resp, err := c.grpc.GetOIDCConnectors(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
oidcConnectors := make([]types.OIDCConnector, len(resp.OIDCConnectors))
for i, oidcConnector := range resp.OIDCConnectors {
oidcConnectors[i] = oidcConnector
}
return oidcConnectors, nil
}
// CreateOIDCConnector creates an OIDC connector.
func (c *Client) CreateOIDCConnector(ctx context.Context, connector types.OIDCConnector) (types.OIDCConnector, error) {
oidcConnector, ok := connector.(*types.OIDCConnectorV3)
if !ok {
return nil, trace.BadParameter("invalid type %T", connector)
}
conn, err := c.grpc.CreateOIDCConnector(ctx, &proto.CreateOIDCConnectorRequest{Connector: oidcConnector})
return conn, trace.Wrap(err)
}
// UpdateOIDCConnector updates an OIDC connector.
func (c *Client) UpdateOIDCConnector(ctx context.Context, connector types.OIDCConnector) (types.OIDCConnector, error) {
oidcConnector, ok := connector.(*types.OIDCConnectorV3)
if !ok {
return nil, trace.BadParameter("invalid type %T", oidcConnector)
}
conn, err := c.grpc.UpdateOIDCConnector(ctx, &proto.UpdateOIDCConnectorRequest{Connector: oidcConnector})
return conn, trace.Wrap(err)
}
// UpsertOIDCConnector creates or updates an OIDC connector.
func (c *Client) UpsertOIDCConnector(ctx context.Context, oidcConnector types.OIDCConnector) (types.OIDCConnector, error) {
connector, ok := oidcConnector.(*types.OIDCConnectorV3)
if !ok {
return nil, trace.BadParameter("invalid type %T", oidcConnector)
}
upserted, err := c.grpc.UpsertOIDCConnectorV2(ctx, &proto.UpsertOIDCConnectorRequest{Connector: connector})
return upserted, trace.Wrap(err)
}
// DeleteOIDCConnector deletes an OIDC connector by name.
func (c *Client) DeleteOIDCConnector(ctx context.Context, name string) error {
if name == "" {
return trace.BadParameter("cannot delete OIDC Connector, missing name")
}
_, err := c.grpc.DeleteOIDCConnector(ctx, &types.ResourceRequest{Name: name})
return trace.Wrap(err)
}
// CreateOIDCAuthRequest creates OIDCAuthRequest.
func (c *Client) CreateOIDCAuthRequest(ctx context.Context, req types.OIDCAuthRequest) (*types.OIDCAuthRequest, error) {
resp, err := c.grpc.CreateOIDCAuthRequest(ctx, &req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GetOIDCAuthRequest gets an OIDCAuthRequest by state token.
func (c *Client) GetOIDCAuthRequest(ctx context.Context, stateToken string) (*types.OIDCAuthRequest, error) {
req := &proto.GetOIDCAuthRequestRequest{StateToken: stateToken}
resp, err := c.grpc.GetOIDCAuthRequest(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GetSAMLConnector returns a SAML connector by name.
func (c *Client) GetSAMLConnector(ctx context.Context, name string, withSecrets bool) (types.SAMLConnector, error) {
return c.GetSAMLConnectorWithValidationOptions(ctx, name, withSecrets)
}
// GetSAMLConnectorWithValidationOptions returns a SAML connector by name.
func (c *Client) GetSAMLConnectorWithValidationOptions(ctx context.Context, name string, withSecrets bool, opts ...types.SAMLConnectorValidationOption) (types.SAMLConnector, error) {
var options types.SAMLConnectorValidationOptions
for _, opt := range opts {
opt(&options)
}
if name == "" {
return nil, trace.BadParameter("cannot get SAML Connector, missing name")
}
req := &types.ResourceWithSecretsRequest{
Name: name,
WithSecrets: withSecrets,
SAMLValidationNoFollowURLs: options.NoFollowURLs,
}
resp, err := c.grpc.GetSAMLConnector(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GetSAMLConnectors returns a list of SAML connectors.
func (c *Client) GetSAMLConnectors(ctx context.Context, withSecrets bool) ([]types.SAMLConnector, error) {
return c.GetSAMLConnectorsWithValidationOptions(ctx, withSecrets)
}
// GetSAMLConnectorsWithoutURLValidation returns a list of SAML connectors.
func (c *Client) GetSAMLConnectorsWithValidationOptions(ctx context.Context, withSecrets bool, opts ...types.SAMLConnectorValidationOption) ([]types.SAMLConnector, error) {
var options types.SAMLConnectorValidationOptions
for _, opt := range opts {
opt(&options)
}
req := &types.ResourcesWithSecretsRequest{
WithSecrets: withSecrets,
SAMLValidationNoFollowURLs: options.NoFollowURLs,
}
resp, err := c.grpc.GetSAMLConnectors(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
samlConnectors := make([]types.SAMLConnector, len(resp.SAMLConnectors))
for i, samlConnector := range resp.SAMLConnectors {
samlConnectors[i] = samlConnector
}
return samlConnectors, nil
}
// CreateSAMLConnector creates a SAML connector.
func (c *Client) CreateSAMLConnector(ctx context.Context, connector types.SAMLConnector) (types.SAMLConnector, error) {
samlConnectorV2, ok := connector.(*types.SAMLConnectorV2)
if !ok {
return nil, trace.BadParameter("invalid type %T", connector)
}
conn, err := c.grpc.CreateSAMLConnector(ctx, &proto.CreateSAMLConnectorRequest{Connector: samlConnectorV2})
return conn, trace.Wrap(err)
}
// UpdateSAMLConnector updates a SAML connector.
func (c *Client) UpdateSAMLConnector(ctx context.Context, connector types.SAMLConnector) (types.SAMLConnector, error) {
samlConnectorV2, ok := connector.(*types.SAMLConnectorV2)
if !ok {
return nil, trace.BadParameter("invalid type %T", connector)
}
conn, err := c.grpc.UpdateSAMLConnector(ctx, &proto.UpdateSAMLConnectorRequest{Connector: samlConnectorV2})
return conn, trace.Wrap(err)
}
// UpsertSAMLConnector creates or updates a SAML connector.
func (c *Client) UpsertSAMLConnector(ctx context.Context, connector types.SAMLConnector) (types.SAMLConnector, error) {
samlConnector, ok := connector.(*types.SAMLConnectorV2)
if !ok {
return nil, trace.BadParameter("invalid type %T", connector)
}
upserted, err := c.grpc.UpsertSAMLConnectorV2(ctx, &proto.UpsertSAMLConnectorRequest{Connector: samlConnector})
return upserted, trace.Wrap(err)
}
// DeleteSAMLConnector deletes a SAML connector by name.
func (c *Client) DeleteSAMLConnector(ctx context.Context, name string) error {
if name == "" {
return trace.BadParameter("cannot delete SAML Connector, missing name")
}
_, err := c.grpc.DeleteSAMLConnector(ctx, &types.ResourceRequest{Name: name})
return trace.Wrap(err)
}
// CreateSAMLAuthRequest creates SAMLAuthRequest.
func (c *Client) CreateSAMLAuthRequest(ctx context.Context, req types.SAMLAuthRequest) (*types.SAMLAuthRequest, error) {
resp, err := c.grpc.CreateSAMLAuthRequest(ctx, &req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GetSAMLAuthRequest gets a SAMLAuthRequest by id.
func (c *Client) GetSAMLAuthRequest(ctx context.Context, id string) (*types.SAMLAuthRequest, error) {
req := &proto.GetSAMLAuthRequestRequest{ID: id}
resp, err := c.grpc.GetSAMLAuthRequest(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GetGithubConnector returns a Github connector by name.
func (c *Client) GetGithubConnector(ctx context.Context, name string, withSecrets bool) (types.GithubConnector, error) {
if name == "" {
return nil, trace.BadParameter("cannot get GitHub Connector, missing name")
}
req := &types.ResourceWithSecretsRequest{Name: name, WithSecrets: withSecrets}
resp, err := c.grpc.GetGithubConnector(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GetGithubConnectors returns a list of Github connectors.
func (c *Client) GetGithubConnectors(ctx context.Context, withSecrets bool) ([]types.GithubConnector, error) {
req := &types.ResourcesWithSecretsRequest{WithSecrets: withSecrets}
resp, err := c.grpc.GetGithubConnectors(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
githubConnectors := make([]types.GithubConnector, len(resp.GithubConnectors))
for i, githubConnector := range resp.GithubConnectors {
githubConnectors[i] = githubConnector
}
return githubConnectors, nil
}
// CreateGithubConnector creates a Github connector.
func (c *Client) CreateGithubConnector(ctx context.Context, connector types.GithubConnector) (types.GithubConnector, error) {
githubConnector, ok := connector.(*types.GithubConnectorV3)
if !ok {
return nil, trace.BadParameter("invalid type %T", connector)
}
conn, err := c.grpc.CreateGithubConnector(ctx, &proto.CreateGithubConnectorRequest{Connector: githubConnector})
return conn, trace.Wrap(err)
}
// UpdateGithubConnector updates a Github connector.
func (c *Client) UpdateGithubConnector(ctx context.Context, connector types.GithubConnector) (types.GithubConnector, error) {
githubConnector, ok := connector.(*types.GithubConnectorV3)
if !ok {
return nil, trace.BadParameter("invalid type %T", connector)
}
conn, err := c.grpc.UpdateGithubConnector(ctx, &proto.UpdateGithubConnectorRequest{Connector: githubConnector})
return conn, trace.Wrap(err)
}
// UpsertGithubConnector creates or updates a Github connector.
func (c *Client) UpsertGithubConnector(ctx context.Context, connector types.GithubConnector) (types.GithubConnector, error) {
githubConnector, ok := connector.(*types.GithubConnectorV3)
if !ok {
return nil, trace.BadParameter("invalid type %T", connector)
}
conn, err := c.grpc.UpsertGithubConnectorV2(ctx, &proto.UpsertGithubConnectorRequest{Connector: githubConnector})
return conn, trace.Wrap(err)
}
// DeleteGithubConnector deletes a Github connector by name.
func (c *Client) DeleteGithubConnector(ctx context.Context, name string) error {
if name == "" {
return trace.BadParameter("cannot delete GitHub Connector, missing name")
}
_, err := c.grpc.DeleteGithubConnector(ctx, &types.ResourceRequest{Name: name})
return trace.Wrap(err)
}
// CreateGithubAuthRequest creates GithubAuthRequest.
func (c *Client) CreateGithubAuthRequest(ctx context.Context, req types.GithubAuthRequest) (*types.GithubAuthRequest, error) {
resp, err := c.grpc.CreateGithubAuthRequest(ctx, &req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GetGithubAuthRequest gets a GithubAuthRequest by state token.
func (c *Client) GetGithubAuthRequest(ctx context.Context, stateToken string) (*types.GithubAuthRequest, error) {
req := &proto.GetGithubAuthRequestRequest{StateToken: stateToken}
resp, err := c.grpc.GetGithubAuthRequest(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GetSSODiagnosticInfo returns SSO diagnostic info records for a specific SSO Auth request.
func (c *Client) GetSSODiagnosticInfo(ctx context.Context, authRequestKind string, authRequestID string) (*types.SSODiagnosticInfo, error) {
req := &proto.GetSSODiagnosticInfoRequest{AuthRequestKind: authRequestKind, AuthRequestID: authRequestID}
resp, err := c.grpc.GetSSODiagnosticInfo(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GetServerInfos returns a stream of ServerInfos.
func (c *Client) GetServerInfos(ctx context.Context) stream.Stream[types.ServerInfo] {
// set up cancelable context so that Stream.Done can close the stream if the caller
// halts early.
ctx, cancel := context.WithCancel(ctx)
serverInfos, err := c.grpc.GetServerInfos(ctx, &emptypb.Empty{})
if err != nil {
cancel()
return stream.Fail[types.ServerInfo](trace.Wrap(err))
}
return stream.Func(func() (types.ServerInfo, error) {
si, err := serverInfos.Recv()
if err != nil {
if errors.Is(err, io.EOF) {
// io.EOF signals that stream has completed successfully
return nil, io.EOF
}
return nil, trace.Wrap(err)
}
return si, nil
}, cancel)
}
// GetServerInfo returns a ServerInfo by name.
func (c *Client) GetServerInfo(ctx context.Context, name string) (types.ServerInfo, error) {
if name == "" {
return nil, trace.BadParameter("cannot get server info, missing name")
}
req := &types.ResourceRequest{Name: name}
resp, err := c.grpc.GetServerInfo(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// UpsertServerInfo upserts a ServerInfo.
func (c *Client) UpsertServerInfo(ctx context.Context, serverInfo types.ServerInfo) error {
si, ok := serverInfo.(*types.ServerInfoV1)
if !ok {
return trace.BadParameter("invalid type %T", serverInfo)
}
_, err := c.grpc.UpsertServerInfo(ctx, si)
return trace.Wrap(err)
}
// DeleteServerInfo deletes a ServerInfo by name.
func (c *Client) DeleteServerInfo(ctx context.Context, name string) error {
if name == "" {
return trace.BadParameter("cannot delete server info, missing name")
}
req := &types.ResourceRequest{Name: name}
_, err := c.grpc.DeleteServerInfo(ctx, req)
return trace.Wrap(err)
}
// DeleteAllServerInfos deletes all ServerInfos.
func (c *Client) DeleteAllServerInfos(ctx context.Context) error {
_, err := c.grpc.DeleteAllServerInfos(ctx, &emptypb.Empty{})
return trace.Wrap(err)
}
// GetTrustedCluster returns a Trusted Cluster by name.
func (c *Client) GetTrustedCluster(ctx context.Context, name string) (types.TrustedCluster, error) {
if name == "" {
return nil, trace.BadParameter("cannot get trusted cluster, missing name")
}
req := &types.ResourceRequest{Name: name}
resp, err := c.grpc.GetTrustedCluster(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GetTrustedClusters returns a list of Trusted Clusters.
// Deprecated: Use [Client.ListTrustedClusters] instead.
func (c *Client) GetTrustedClusters(ctx context.Context) ([]types.TrustedCluster, error) {
//nolint:staticcheck // TODO(okraport): deprecated, to be removed in v21
resp, err := c.grpc.GetTrustedClusters(ctx, &emptypb.Empty{})
if err != nil {
return nil, trace.Wrap(err)
}
trustedClusters := make([]types.TrustedCluster, len(resp.TrustedClusters))
for i, trustedCluster := range resp.TrustedClusters {
trustedClusters[i] = trustedCluster
}
return trustedClusters, nil
}
// ListTrustedClusters returns a page of Trusted Cluster resources.
func (c *Client) ListTrustedClusters(ctx context.Context, limit int, start string) ([]types.TrustedCluster, string, error) {
resp, err := c.TrustClient().ListTrustedClusters(ctx, &trustpb.ListTrustedClustersRequest{
PageSize: int32(limit),
PageToken: start,
})
if err != nil {
return nil, "", trace.Wrap(err)
}
tcs := make([]types.TrustedCluster, len(resp.TrustedClusters))
for i := range resp.TrustedClusters {
tcs[i] = resp.TrustedClusters[i]
}
return tcs, resp.NextPageToken, nil
}
// RangeTrustedClusters returns Trusted Cluster resources within the range [start, end).
func (c *Client) RangeTrustedClusters(ctx context.Context, start, end string) iter.Seq2[types.TrustedCluster, error] {
return clientutils.RangeResources(ctx, start, end, c.ListTrustedClusters, types.TrustedCluster.GetName)
}
// UpsertTrustedCluster creates or updates a Trusted Cluster.
//
// Deprecated: Use [Client.UpsertTrustedClusterV2] instead.
func (c *Client) UpsertTrustedCluster(ctx context.Context, trustedCluster types.TrustedCluster) (types.TrustedCluster, error) {
trustedClusterV2, ok := trustedCluster.(*types.TrustedClusterV2)
if !ok {
return nil, trace.BadParameter("invalid type %T", trustedCluster)
}
resp, err := c.grpc.UpsertTrustedCluster(ctx, trustedClusterV2)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// UpsertTrustedClusterV2 creates or updates a Trusted Cluster.
func (c *Client) UpsertTrustedClusterV2(ctx context.Context, trustedCluster types.TrustedCluster) (types.TrustedCluster, error) {
trustedClusterV2, ok := trustedCluster.(*types.TrustedClusterV2)
if !ok {
return nil, trace.BadParameter("invalid type %T", trustedCluster)
}
req := &trustpb.UpsertTrustedClusterRequest{TrustedCluster: trustedClusterV2}
resp, err := c.TrustClient().UpsertTrustedCluster(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// CreateTrustedCluster creates a Trusted Cluster.
func (c *Client) CreateTrustedCluster(ctx context.Context, trustedCluster types.TrustedCluster) (types.TrustedCluster, error) {
trustedClusterV2, ok := trustedCluster.(*types.TrustedClusterV2)
if !ok {
return nil, trace.BadParameter("invalid type %T", trustedCluster)
}
req := &trustpb.CreateTrustedClusterRequest{TrustedCluster: trustedClusterV2}
resp, err := c.TrustClient().CreateTrustedCluster(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// UpdateTrustedCluster updates a Trusted Cluster.
func (c *Client) UpdateTrustedCluster(ctx context.Context, trustedCluster types.TrustedCluster) (types.TrustedCluster, error) {
trustedClusterV2, ok := trustedCluster.(*types.TrustedClusterV2)
if !ok {
return nil, trace.BadParameter("invalid type %T", trustedCluster)
}
req := &trustpb.UpdateTrustedClusterRequest{TrustedCluster: trustedClusterV2}
resp, err := c.TrustClient().UpdateTrustedCluster(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// DeleteTrustedCluster deletes a Trusted Cluster by name.
func (c *Client) DeleteTrustedCluster(ctx context.Context, name string) error {
if name == "" {
return trace.BadParameter("cannot delete trusted cluster, missing name")
}
_, err := c.grpc.DeleteTrustedCluster(ctx, &types.ResourceRequest{Name: name})
return trace.Wrap(err)
}
// GetToken returns a provision token by name.
func (c *Client) GetToken(ctx context.Context, name string) (types.ProvisionToken, error) {
if name == "" {
return nil, trace.BadParameter("cannot get token, missing name")
}
resp, err := c.grpc.GetToken(ctx, &types.ResourceRequest{Name: name})
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GetTokens returns a list of active provision tokens for nodes and users.
// Deprecated: Use [ListProvisionTokens], [GetStaticTokens], and [ListResetPasswordTokens] instead.
// TODO(hugoShaka): DELETE IN 19.0.0
func (c *Client) GetTokens(ctx context.Context) ([]types.ProvisionToken, error) {
resp, err := c.grpc.GetTokens(ctx, &emptypb.Empty{}) //nolint:staticcheck // Provides backward compatibility, will be removed later.
if err != nil {
return nil, trace.Wrap(err)
}
tokens := make([]types.ProvisionToken, len(resp.ProvisionTokens))
for i, token := range resp.ProvisionTokens {
tokens[i] = token
}
return tokens, nil
}
// GetStaticTokens returns the cluster static tokens.
func (c *Client) GetStaticTokens(ctx context.Context) (types.StaticTokens, error) {
tokens, err := c.grpc.GetStaticTokens(ctx, &emptypb.Empty{})
if err != nil {
return nil, trace.Wrap(err)
}
return tokens, nil
}
// ListProvisionTokens retrieves a paginated list of provision tokens.
func (c *Client) ListProvisionTokens(ctx context.Context, pageSize int, pageToken string, anyRoles types.SystemRoles, botName string) ([]types.ProvisionToken, string, error) {
resp, err := c.grpc.ListProvisionTokens(ctx, &proto.ListProvisionTokensRequest{
Limit: int32(pageSize),
StartKey: pageToken,
FilterRoles: anyRoles.StringSlice(),
FilterBotName: botName,
})
if err != nil {
return nil, "", trace.Wrap(err)
}
// Convert concrete type []*types.ProvisionTokenV2 to interface type []types.ProvisionToken
tokens := make([]types.ProvisionToken, len(resp.Tokens))
for i, token := range resp.Tokens {
tokens[i] = token
}
return tokens, resp.NextKey, nil
}
// UpsertToken creates or updates a provision token.
func (c *Client) UpsertToken(ctx context.Context, token types.ProvisionToken) error {
tokenV2, ok := token.(*types.ProvisionTokenV2)
if !ok {
return trace.BadParameter("invalid type %T", token)
}
_, err := c.grpc.UpsertTokenV2(ctx, &proto.UpsertTokenV2Request{
Token: &proto.UpsertTokenV2Request_V2{
V2: tokenV2,
},
})
return trace.Wrap(err)
}
// CreateToken creates a provision token.
func (c *Client) CreateToken(ctx context.Context, token types.ProvisionToken) error {
tokenV2, ok := token.(*types.ProvisionTokenV2)
if !ok {
return trace.BadParameter("invalid type %T", token)
}
_, err := c.grpc.CreateTokenV2(ctx, &proto.CreateTokenV2Request{
Token: &proto.CreateTokenV2Request_V2{
V2: tokenV2,
},
})
return trace.Wrap(err)
}
// DeleteToken deletes a provision token by name.
func (c *Client) DeleteToken(ctx context.Context, name string) error {
if name == "" {
return trace.BadParameter("cannot delete token, missing name")
}
_, err := c.grpc.DeleteToken(ctx, &types.ResourceRequest{Name: name})
return trace.Wrap(err)
}
// GetNode returns a node by name and namespace.
func (c *Client) GetNode(ctx context.Context, namespace, name string) (types.Server, error) {
resp, err := c.grpc.GetNode(ctx, &types.ResourceInNamespaceRequest{
Name: name,
Namespace: namespace,
})
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GetNodes returns a complete list of nodes that the user has access to in the given namespace.
func (c *Client) GetNodes(ctx context.Context, namespace string) ([]types.Server, error) {
servers, err := GetAllResources[types.Server](ctx, c, &proto.ListResourcesRequest{
ResourceType: types.KindNode,
Namespace: namespace,
})
return servers, trace.Wrap(err)
}
// UpsertNode is used by SSH servers to report their presence
// to the auth servers in form of heartbeat expiring after ttl period.
func (c *Client) UpsertNode(ctx context.Context, node types.Server) (*types.KeepAlive, error) {
if node.GetNamespace() == "" {
return nil, trace.BadParameter("missing node namespace")
}
serverV2, ok := node.(*types.ServerV2)
if !ok {
return nil, trace.BadParameter("invalid type %T", node)
}
keepAlive, err := c.grpc.UpsertNode(ctx, serverV2)
if err != nil {
return nil, trace.Wrap(err)
}
return keepAlive, nil
}
// DeleteNode deletes a node by name and namespace.
func (c *Client) DeleteNode(ctx context.Context, namespace, name string) error {
if namespace == "" {
return trace.BadParameter("missing parameter namespace")
}
if name == "" {
return trace.BadParameter("missing parameter name")
}
_, err := c.grpc.DeleteNode(ctx, &types.ResourceInNamespaceRequest{
Name: name,
Namespace: namespace,
})
return trace.Wrap(err)
}
// DeleteAllNodes deletes all nodes in a given namespace.
func (c *Client) DeleteAllNodes(ctx context.Context, namespace string) error {
if namespace == "" {
return trace.BadParameter("missing parameter namespace")
}
_, err := c.grpc.DeleteAllNodes(ctx, &types.ResourcesInNamespaceRequest{Namespace: namespace})
return trace.Wrap(err)
}
// StreamSessionEvents streams audit events from a given session recording.
func (c *Client) StreamSessionEvents(ctx context.Context, sessionID string, startIndex int64) (chan events.AuditEvent, chan error) {
request := &proto.StreamSessionEventsRequest{
SessionID: sessionID,
StartIndex: int32(startIndex),
}
ch := make(chan events.AuditEvent)
e := make(chan error, 1)
stream, err := c.grpc.StreamSessionEvents(ctx, request)
if err != nil {
e <- trace.Wrap(err)
return ch, e
}
go func() {
outer:
for {
oneOf, err := stream.Recv()
if err != nil {
if !errors.Is(err, io.EOF) {
e <- trace.Wrap(err)
} else {
close(ch)
}
break outer
}
event, err := events.FromOneOf(*oneOf)
if err != nil {
e <- trace.Wrap(err)
break outer
}
select {
case ch <- event:
case <-ctx.Done():
e <- trace.Wrap(ctx.Err())
break outer
}
}
}()
return ch, e
}
// UploadEncryptedRecording streams encrypted recording parts to the auth
// server to be saved in long term storage.
func (c *Client) UploadEncryptedRecording(ctx context.Context, sessionID string, parts iter.Seq2[[]byte, error]) error {
createRes, err := c.grpc.CreateUpload(ctx, &recordingencryptionv1pb.CreateUploadRequest{
SessionId: sessionID,
})
if err != nil {
return trace.Wrap(err)
}
var uploadedParts []*recordingencryptionv1pb.Part
// S3 requires that part numbers start at 1, so we do that by default regardless of which uploader is
// configured for the auth service
var partNumber int64 = 1
for part, err := range parts {
if err != nil {
return trace.Wrap(err)
}
uploadRes, err := c.grpc.UploadPart(ctx, &recordingencryptionv1pb.UploadPartRequest{
Upload: createRes.Upload,
PartNumber: partNumber,
Part: part,
})
if err != nil {
return trace.Wrap(err)
}
uploadedParts = append(uploadedParts, uploadRes.Part)
partNumber++
}
if _, err := c.grpc.CompleteUpload(ctx, &recordingencryptionv1pb.CompleteUploadRequest{
Upload: createRes.Upload,
Parts: uploadedParts,
}); err != nil {
return trace.Wrap(err)
}
return nil
}
// SearchEvents allows searching for events with a full pagination support.
func (c *Client) SearchEvents(ctx context.Context, fromUTC, toUTC time.Time, namespace string, eventTypes []string, limit int, order types.EventOrder, startKey string) ([]events.AuditEvent, string, error) {
request := &proto.GetEventsRequest{
Namespace: namespace,
StartDate: fromUTC,
EndDate: toUTC,
EventTypes: eventTypes,
Limit: int32(limit),
StartKey: startKey,
Order: proto.Order(order),
}
response, err := c.grpc.GetEvents(ctx, request)
if err != nil {
return nil, "", trace.Wrap(err)
}
decodedEvents := make([]events.AuditEvent, 0, len(response.Items))
for _, rawEvent := range response.Items {
event, err := events.FromOneOf(*rawEvent)
if err != nil {
if trace.IsBadParameter(err) {
slog.WarnContext(ctx, "skipping unknown event", "error", err)
continue
}
return nil, "", trace.Wrap(err)
}
decodedEvents = append(decodedEvents, event)
}
return decodedEvents, response.LastKey, nil
}
// SearchUnstructuredEvents allows searching for events with a full pagination support
// and returns events in an unstructured format (json like).
// This method is used by the Teleport event-handler plugin to receive events
// from the auth server without having to support the Protobuf event schema.
func (c *Client) SearchUnstructuredEvents(ctx context.Context, fromUTC, toUTC time.Time, namespace string, eventTypes []string, limit int, order types.EventOrder, startKey string) ([]*auditlogpb.EventUnstructured, string, error) {
request := &auditlogpb.GetUnstructuredEventsRequest{
Namespace: namespace,
StartDate: timestamppb.New(fromUTC),
EndDate: timestamppb.New(toUTC),
EventTypes: eventTypes,
Limit: int32(limit),
StartKey: startKey,
Order: auditlogpb.Order(order),
}
response, err := c.grpc.GetUnstructuredEvents(ctx, request)
if err != nil {
return nil, "", trace.Wrap(err)
}
return response.Items, response.LastKey, nil
}
// ExportUnstructuredEvents exports events from a given event chunk returned by GetEventExportChunks. This API prioritizes
// performance over ordering and filtering, and is intended for bulk export of events.
func (c *Client) ExportUnstructuredEvents(ctx context.Context, req *auditlogpb.ExportUnstructuredEventsRequest) stream.Stream[*auditlogpb.ExportEventUnstructured] {
// set up cancelable context so that Stream.Done can close the stream if the caller
// halts early.
ctx, cancel := context.WithCancel(ctx)
events, err := c.grpc.ExportUnstructuredEvents(ctx, req)
if err != nil {
cancel()
return stream.Fail[*auditlogpb.ExportEventUnstructured](trace.Wrap(err))
}
return stream.Func[*auditlogpb.ExportEventUnstructured](func() (*auditlogpb.ExportEventUnstructured, error) {
event, err := events.Recv()
if err != nil {
if errors.Is(err, io.EOF) {
// io.EOF signals that stream has completed successfully
return nil, io.EOF
}
return nil, trace.Wrap(err)
}
return event, nil
}, cancel)
}
// GetEventExportChunks returns a stream of event chunks that can be exported via ExportUnstructuredEvents. The returned
// list isn't ordered and polling for new chunks requires re-consuming the entire stream from the beginning.
func (c *Client) GetEventExportChunks(ctx context.Context, req *auditlogpb.GetEventExportChunksRequest) stream.Stream[*auditlogpb.EventExportChunk] {
// set up cancelable context so that Stream.Done can close the stream if the caller
// halts early.
ctx, cancel := context.WithCancel(ctx)
chunks, err := c.grpc.GetEventExportChunks(ctx, req)
if err != nil {
cancel()
return stream.Fail[*auditlogpb.EventExportChunk](trace.Wrap(err))
}
return stream.Func[*auditlogpb.EventExportChunk](func() (*auditlogpb.EventExportChunk, error) {
chunk, err := chunks.Recv()
if err != nil {
if errors.Is(err, io.EOF) {
// io.EOF signals that stream has completed successfully
return nil, io.EOF
}
return nil, trace.Wrap(err)
}
return chunk, nil
}, cancel)
}
// StreamUnstructuredSessionEvents streams audit events from a given session recording in an unstructured format.
// This method is used by the Teleport event-handler plugin to receive events
// from the auth server wihout having to support the Protobuf event schema.
func (c *Client) StreamUnstructuredSessionEvents(ctx context.Context, sessionID string, startIndex int64) (chan *auditlogpb.EventUnstructured, chan error) {
request := &auditlogpb.StreamUnstructuredSessionEventsRequest{
SessionId: sessionID,
StartIndex: int32(startIndex),
}
ch := make(chan *auditlogpb.EventUnstructured)
e := make(chan error, 1)
stream, err := c.grpc.StreamUnstructuredSessionEvents(ctx, request)
if err != nil {
e <- trace.Wrap(err)
return ch, e
}
go func() {
for {
event, err := stream.Recv()
if err != nil {
if !errors.Is(err, io.EOF) {
e <- trace.Wrap(err)
} else {
close(ch)
}
return
}
select {
case ch <- event:
case <-ctx.Done():
e <- trace.Wrap(ctx.Err())
return
}
}
}()
return ch, e
}
// SearchSessionEvents allows searching for session events with a full pagination support.
func (c *Client) SearchSessionEvents(ctx context.Context, fromUTC time.Time, toUTC time.Time, limit int, order types.EventOrder, startKey string) ([]events.AuditEvent, string, error) {
request := &proto.GetSessionEventsRequest{
StartDate: fromUTC,
EndDate: toUTC,
Limit: int32(limit),
StartKey: startKey,
Order: proto.Order(order),
}
response, err := c.grpc.GetSessionEvents(ctx, request)
if err != nil {
return nil, "", trace.Wrap(err)
}
decodedEvents := make([]events.AuditEvent, 0, len(response.Items))
for _, rawEvent := range response.Items {
event, err := events.FromOneOf(*rawEvent)
if err != nil {
return nil, "", trace.Wrap(err)
}
decodedEvents = append(decodedEvents, event)
}
return decodedEvents, response.LastKey, nil
}
func (c *Client) DynamicDesktopClient() *dynamicwindows.Client {
return dynamicwindows.NewClient(dynamicwindowsv1.NewDynamicWindowsServiceClient(c.conn))
}
func (c *Client) ListDynamicWindowsDesktops(ctx context.Context, pageSize int, pageToken string) ([]types.DynamicWindowsDesktop, string, error) {
return c.DynamicDesktopClient().ListDynamicWindowsDesktops(ctx, pageSize, pageToken)
}
func (c *Client) GetDynamicWindowsDesktop(ctx context.Context, name string) (types.DynamicWindowsDesktop, error) {
return c.DynamicDesktopClient().GetDynamicWindowsDesktop(ctx, name)
}
// ClusterConfigClient returns an unadorned Cluster Configuration client, using the underlying
// Auth gRPC connection.
func (c *Client) ClusterConfigClient() clusterconfigpb.ClusterConfigServiceClient {
return clusterconfigpb.NewClusterConfigServiceClient(c.conn)
}
// GetClusterNetworkingConfig gets cluster networking configuration.
func (c *Client) GetClusterNetworkingConfig(ctx context.Context) (types.ClusterNetworkingConfig, error) {
resp, err := c.ClusterConfigClient().GetClusterNetworkingConfig(ctx, &clusterconfigpb.GetClusterNetworkingConfigRequest{})
return resp, trace.Wrap(err)
}
// UpdateClusterNetworkingConfig updates an existing cluster networking configuration.
func (c *Client) UpdateClusterNetworkingConfig(ctx context.Context, cfg types.ClusterNetworkingConfig) (types.ClusterNetworkingConfig, error) {
v2, ok := cfg.(*types.ClusterNetworkingConfigV2)
if !ok {
return nil, trace.BadParameter("unsupported cluster networking config type %T", cfg)
}
updated, err := c.ClusterConfigClient().UpdateClusterNetworkingConfig(ctx, &clusterconfigpb.UpdateClusterNetworkingConfigRequest{ClusterNetworkConfig: v2})
return updated, trace.Wrap(err)
}
// UpsertClusterNetworkingConfig creates a new configuration or overwrites the existing cluster networking configuration.
func (c *Client) UpsertClusterNetworkingConfig(ctx context.Context, cfg types.ClusterNetworkingConfig) (types.ClusterNetworkingConfig, error) {
v2, ok := cfg.(*types.ClusterNetworkingConfigV2)
if !ok {
return nil, trace.BadParameter("unsupported cluster networking config type %T", cfg)
}
updated, err := c.ClusterConfigClient().UpsertClusterNetworkingConfig(ctx, &clusterconfigpb.UpsertClusterNetworkingConfigRequest{ClusterNetworkConfig: v2})
return updated, trace.Wrap(err)
}
// ResetClusterNetworkingConfig resets cluster networking configuration to defaults.
func (c *Client) ResetClusterNetworkingConfig(ctx context.Context) error {
_, err := c.ClusterConfigClient().ResetClusterNetworkingConfig(ctx, &clusterconfigpb.ResetClusterNetworkingConfigRequest{})
return trace.Wrap(err)
}
// GetSessionRecordingConfig gets session recording configuration.
func (c *Client) GetSessionRecordingConfig(ctx context.Context) (types.SessionRecordingConfig, error) {
resp, err := c.ClusterConfigClient().GetSessionRecordingConfig(ctx, &clusterconfigpb.GetSessionRecordingConfigRequest{})
return resp, trace.Wrap(err)
}
// ResetSessionRecordingConfig resets session recording configuration to defaults.
func (c *Client) ResetSessionRecordingConfig(ctx context.Context) error {
_, err := c.ClusterConfigClient().ResetSessionRecordingConfig(ctx, &clusterconfigpb.ResetSessionRecordingConfigRequest{})
return trace.Wrap(err)
}
// UpdateSessionRecordingConfig updates an existing session recording configuration.
func (c *Client) UpdateSessionRecordingConfig(ctx context.Context, cfg types.SessionRecordingConfig) (types.SessionRecordingConfig, error) {
v2, ok := cfg.(*types.SessionRecordingConfigV2)
if !ok {
return nil, trace.BadParameter("unsupported session recording config type %T", cfg)
}
updated, err := c.ClusterConfigClient().UpdateSessionRecordingConfig(ctx, &clusterconfigpb.UpdateSessionRecordingConfigRequest{SessionRecordingConfig: v2})
return updated, trace.Wrap(err)
}
// UpsertSessionRecordingConfig creates a new configuration or overwrites the existing session recording configuration.
func (c *Client) UpsertSessionRecordingConfig(ctx context.Context, cfg types.SessionRecordingConfig) (types.SessionRecordingConfig, error) {
v2, ok := cfg.(*types.SessionRecordingConfigV2)
if !ok {
return nil, trace.BadParameter("unsupported session recording config type %T", cfg)
}
updated, err := c.ClusterConfigClient().UpsertSessionRecordingConfig(ctx, &clusterconfigpb.UpsertSessionRecordingConfigRequest{SessionRecordingConfig: v2})
return updated, trace.Wrap(err)
}
// GetAuthPreference gets the active cluster auth preference.
func (c *Client) GetAuthPreference(ctx context.Context) (types.AuthPreference, error) {
pref, err := c.ClusterConfigClient().GetAuthPreference(ctx, &clusterconfigpb.GetAuthPreferenceRequest{})
return pref, trace.Wrap(err)
}
// ResetAuthPreference resets cluster auth preference to defaults.
func (c *Client) ResetAuthPreference(ctx context.Context) error {
_, err := c.ClusterConfigClient().ResetAuthPreference(ctx, &clusterconfigpb.ResetAuthPreferenceRequest{})
return trace.Wrap(err)
}
// UpdateAuthPreference updates an existing auth preference.
func (c *Client) UpdateAuthPreference(ctx context.Context, p types.AuthPreference) (types.AuthPreference, error) {
v2, ok := p.(*types.AuthPreferenceV2)
if !ok {
return nil, trace.BadParameter("unsupported auth preference type %T", p)
}
updated, err := c.ClusterConfigClient().UpdateAuthPreference(ctx, &clusterconfigpb.UpdateAuthPreferenceRequest{AuthPreference: v2})
return updated, trace.Wrap(err)
}
// UpsertAuthPreference creates a new preference or overwrites the existing auth preference.
func (c *Client) UpsertAuthPreference(ctx context.Context, p types.AuthPreference) (types.AuthPreference, error) {
v2, ok := p.(*types.AuthPreferenceV2)
if !ok {
return nil, trace.BadParameter("unsupported auth preference type %T", p)
}
updated, err := c.ClusterConfigClient().UpsertAuthPreference(ctx, &clusterconfigpb.UpsertAuthPreferenceRequest{AuthPreference: v2})
return updated, trace.Wrap(err)
}
// GetClusterAuditConfig gets cluster audit configuration.
func (c *Client) GetClusterAuditConfig(ctx context.Context) (types.ClusterAuditConfig, error) {
resp, err := c.grpc.GetClusterAuditConfig(ctx, &emptypb.Empty{})
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// CreateAutoUpdateConfig creates AutoUpdateConfig resource.
func (c *Client) CreateAutoUpdateConfig(ctx context.Context, config *autoupdatev1pb.AutoUpdateConfig) (*autoupdatev1pb.AutoUpdateConfig, error) {
client := autoupdatev1pb.NewAutoUpdateServiceClient(c.conn)
resp, err := client.CreateAutoUpdateConfig(ctx, &autoupdatev1pb.CreateAutoUpdateConfigRequest{
Config: config,
})
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GetAutoUpdateConfig gets AutoUpdateConfig resource.
func (c *Client) GetAutoUpdateConfig(ctx context.Context) (*autoupdatev1pb.AutoUpdateConfig, error) {
client := autoupdatev1pb.NewAutoUpdateServiceClient(c.conn)
resp, err := client.GetAutoUpdateConfig(ctx, &autoupdatev1pb.GetAutoUpdateConfigRequest{})
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// UpdateAutoUpdateConfig updates AutoUpdateConfig resource.
func (c *Client) UpdateAutoUpdateConfig(ctx context.Context, config *autoupdatev1pb.AutoUpdateConfig) (*autoupdatev1pb.AutoUpdateConfig, error) {
client := autoupdatev1pb.NewAutoUpdateServiceClient(c.conn)
resp, err := client.UpdateAutoUpdateConfig(ctx, &autoupdatev1pb.UpdateAutoUpdateConfigRequest{
Config: config,
})
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// UpsertAutoUpdateConfig updates or creates AutoUpdateConfig resource.
func (c *Client) UpsertAutoUpdateConfig(ctx context.Context, config *autoupdatev1pb.AutoUpdateConfig) (*autoupdatev1pb.AutoUpdateConfig, error) {
client := autoupdatev1pb.NewAutoUpdateServiceClient(c.conn)
resp, err := client.UpsertAutoUpdateConfig(ctx, &autoupdatev1pb.UpsertAutoUpdateConfigRequest{
Config: config,
})
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// DeleteAutoUpdateConfig deletes AutoUpdateConfig resource.
func (c *Client) DeleteAutoUpdateConfig(ctx context.Context) error {
client := autoupdatev1pb.NewAutoUpdateServiceClient(c.conn)
_, err := client.DeleteAutoUpdateConfig(ctx, &autoupdatev1pb.DeleteAutoUpdateConfigRequest{})
return trace.Wrap(err)
}
// CreateAutoUpdateVersion creates AutoUpdateVersion resource.
func (c *Client) CreateAutoUpdateVersion(ctx context.Context, version *autoupdatev1pb.AutoUpdateVersion) (*autoupdatev1pb.AutoUpdateVersion, error) {
client := autoupdatev1pb.NewAutoUpdateServiceClient(c.conn)
resp, err := client.CreateAutoUpdateVersion(ctx, &autoupdatev1pb.CreateAutoUpdateVersionRequest{
Version: version,
})
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GetAutoUpdateVersion gets AutoUpdateVersion resource.
func (c *Client) GetAutoUpdateVersion(ctx context.Context) (*autoupdatev1pb.AutoUpdateVersion, error) {
client := autoupdatev1pb.NewAutoUpdateServiceClient(c.conn)
resp, err := client.GetAutoUpdateVersion(ctx, &autoupdatev1pb.GetAutoUpdateVersionRequest{})
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// UpdateAutoUpdateVersion updates AutoUpdateVersion resource.
func (c *Client) UpdateAutoUpdateVersion(ctx context.Context, version *autoupdatev1pb.AutoUpdateVersion) (*autoupdatev1pb.AutoUpdateVersion, error) {
client := autoupdatev1pb.NewAutoUpdateServiceClient(c.conn)
resp, err := client.UpdateAutoUpdateVersion(ctx, &autoupdatev1pb.UpdateAutoUpdateVersionRequest{
Version: version,
})
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// UpsertAutoUpdateVersion updates or creates AutoUpdateVersion resource.
func (c *Client) UpsertAutoUpdateVersion(ctx context.Context, version *autoupdatev1pb.AutoUpdateVersion) (*autoupdatev1pb.AutoUpdateVersion, error) {
client := autoupdatev1pb.NewAutoUpdateServiceClient(c.conn)
resp, err := client.UpsertAutoUpdateVersion(ctx, &autoupdatev1pb.UpsertAutoUpdateVersionRequest{
Version: version,
})
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// DeleteAutoUpdateVersion deletes AutoUpdateVersion resource.
func (c *Client) DeleteAutoUpdateVersion(ctx context.Context) error {
client := autoupdatev1pb.NewAutoUpdateServiceClient(c.conn)
_, err := client.DeleteAutoUpdateVersion(ctx, &autoupdatev1pb.DeleteAutoUpdateVersionRequest{})
return trace.Wrap(err)
}
// CreateAutoUpdateAgentRollout creates AutoUpdateAgentRollout resource.
func (c *Client) CreateAutoUpdateAgentRollout(ctx context.Context, rollout *autoupdatev1pb.AutoUpdateAgentRollout) (*autoupdatev1pb.AutoUpdateAgentRollout, error) {
client := autoupdatev1pb.NewAutoUpdateServiceClient(c.conn)
resp, err := client.CreateAutoUpdateAgentRollout(ctx, &autoupdatev1pb.CreateAutoUpdateAgentRolloutRequest{
Rollout: rollout,
})
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GetAutoUpdateAgentRollout gets AutoUpdateAgentRollout resource.
func (c *Client) GetAutoUpdateAgentRollout(ctx context.Context) (*autoupdatev1pb.AutoUpdateAgentRollout, error) {
client := autoupdatev1pb.NewAutoUpdateServiceClient(c.conn)
resp, err := client.GetAutoUpdateAgentRollout(ctx, &autoupdatev1pb.GetAutoUpdateAgentRolloutRequest{})
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// UpdateAutoUpdateAgentRollout updates AutoUpdateAgentRollout resource.
func (c *Client) UpdateAutoUpdateAgentRollout(ctx context.Context, rollout *autoupdatev1pb.AutoUpdateAgentRollout) (*autoupdatev1pb.AutoUpdateAgentRollout, error) {
client := autoupdatev1pb.NewAutoUpdateServiceClient(c.conn)
resp, err := client.UpdateAutoUpdateAgentRollout(ctx, &autoupdatev1pb.UpdateAutoUpdateAgentRolloutRequest{
Rollout: rollout,
})
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// UpsertAutoUpdateAgentRollout updates or creates AutoUpdateAgentRollout resource.
func (c *Client) UpsertAutoUpdateAgentRollout(ctx context.Context, rollout *autoupdatev1pb.AutoUpdateAgentRollout) (*autoupdatev1pb.AutoUpdateAgentRollout, error) {
client := autoupdatev1pb.NewAutoUpdateServiceClient(c.conn)
resp, err := client.UpsertAutoUpdateAgentRollout(ctx, &autoupdatev1pb.UpsertAutoUpdateAgentRolloutRequest{
Rollout: rollout,
})
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// DeleteAutoUpdateAgentRollout deletes AutoUpdateAgentRollout resource.
func (c *Client) DeleteAutoUpdateAgentRollout(ctx context.Context) error {
client := autoupdatev1pb.NewAutoUpdateServiceClient(c.conn)
_, err := client.DeleteAutoUpdateAgentRollout(ctx, &autoupdatev1pb.DeleteAutoUpdateAgentRolloutRequest{})
return trace.Wrap(err)
}
func (c *Client) TriggerAutoUpdateAgentGroup(ctx context.Context, groups []string, state autoupdatev1pb.AutoUpdateAgentGroupState) (*autoupdatev1pb.AutoUpdateAgentRollout, error) {
client := autoupdatev1pb.NewAutoUpdateServiceClient(c.conn)
rollout, err := client.TriggerAutoUpdateAgentGroup(ctx, &autoupdatev1pb.TriggerAutoUpdateAgentGroupRequest{Groups: groups, DesiredState: state})
if err != nil {
return nil, trace.Wrap(err)
}
return rollout, nil
}
func (c *Client) ForceAutoUpdateAgentGroup(ctx context.Context, groups []string) (*autoupdatev1pb.AutoUpdateAgentRollout, error) {
client := autoupdatev1pb.NewAutoUpdateServiceClient(c.conn)
rollout, err := client.ForceAutoUpdateAgentGroup(ctx, &autoupdatev1pb.ForceAutoUpdateAgentGroupRequest{Groups: groups})
if err != nil {
return nil, trace.Wrap(err)
}
return rollout, nil
}
func (c *Client) RollbackAutoUpdateAgentGroup(ctx context.Context, groups []string, allStartedGroups bool) (*autoupdatev1pb.AutoUpdateAgentRollout, error) {
client := autoupdatev1pb.NewAutoUpdateServiceClient(c.conn)
rollout, err := client.RollbackAutoUpdateAgentGroup(ctx, &autoupdatev1pb.RollbackAutoUpdateAgentGroupRequest{Groups: groups, AllStartedGroups: allStartedGroups})
if err != nil {
return nil, trace.Wrap(err)
}
return rollout, nil
}
// GetAutoUpdateAgentReport gets the AutoUpdateAgentReport from a specific Auth Service instance.
func (c *Client) GetAutoUpdateAgentReport(ctx context.Context, name string) (*autoupdatev1pb.AutoUpdateAgentReport, error) {
client := autoupdatev1pb.NewAutoUpdateServiceClient(c.conn)
report, err := client.GetAutoUpdateAgentReport(ctx, &autoupdatev1pb.GetAutoUpdateAgentReportRequest{Name: name})
if err != nil {
return nil, trace.Wrap(err)
}
return report, nil
}
// ListAutoUpdateAgentReports returns an AutoUpdateAgentReports page.
func (c *Client) ListAutoUpdateAgentReports(ctx context.Context, pageSize int, pageToken string) ([]*autoupdatev1pb.AutoUpdateAgentReport, string, error) {
client := autoupdatev1pb.NewAutoUpdateServiceClient(c.conn)
resp, err := client.ListAutoUpdateAgentReports(ctx, &autoupdatev1pb.ListAutoUpdateAgentReportsRequest{
PageSize: int32(pageSize),
NextToken: pageToken,
})
if err != nil {
return nil, "", trace.Wrap(err)
}
return resp.GetAutoupdateAgentReports(), resp.GetNextKey(), nil
}
// UpsertAutoUpdateAgentReport upserts an AutoUpdateAgentReport resource.
func (c *Client) UpsertAutoUpdateAgentReport(ctx context.Context, report *autoupdatev1pb.AutoUpdateAgentReport) (*autoupdatev1pb.AutoUpdateAgentReport, error) {
client := autoupdatev1pb.NewAutoUpdateServiceClient(c.conn)
resp, err := client.UpsertAutoUpdateAgentReport(ctx, &autoupdatev1pb.UpsertAutoUpdateAgentReportRequest{
AutoupdateAgentReport: report,
})
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GetAutoUpdateBotInstanceReport gets the singleton auto-update bot report.
func (c *Client) GetAutoUpdateBotInstanceReport(ctx context.Context) (*autoupdatev1pb.AutoUpdateBotInstanceReport, error) {
client := autoupdatev1pb.NewAutoUpdateServiceClient(c.conn)
resp, err := client.GetAutoUpdateBotInstanceReport(ctx, &autoupdatev1pb.GetAutoUpdateBotInstanceReportRequest{})
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// DeleteAutoUpdateBotInstanceReport deletes the singleton auto-update bot instance report.
func (c *Client) DeleteAutoUpdateBotInstanceReport(ctx context.Context) error {
client := autoupdatev1pb.NewAutoUpdateServiceClient(c.conn)
_, err := client.GetAutoUpdateBotInstanceReport(ctx, &autoupdatev1pb.GetAutoUpdateBotInstanceReportRequest{})
return trace.Wrap(err)
}
// GetClusterAccessGraphConfig retrieves the Cluster Access Graph configuration from Auth server.
func (c *Client) GetClusterAccessGraphConfig(ctx context.Context) (*clusterconfigpb.AccessGraphConfig, error) {
rsp, err := c.ClusterConfigClient().GetClusterAccessGraphConfig(ctx, &clusterconfigpb.GetClusterAccessGraphConfigRequest{})
if err != nil {
return nil, trace.Wrap(err)
}
return rsp.AccessGraph, nil
}
// GetInstallers gets all installer script resources
func (c *Client) GetInstallers(ctx context.Context) ([]types.Installer, error) {
resp, err := c.grpc.GetInstallers(ctx, &emptypb.Empty{})
if err != nil {
return nil, trace.Wrap(err)
}
installers := make([]types.Installer, len(resp.Installers))
for i, inst := range resp.Installers {
installers[i] = inst
}
return installers, nil
}
// GetUIConfig gets the configuration for the UI served by the proxy service
func (c *Client) GetUIConfig(ctx context.Context) (types.UIConfig, error) {
resp, err := c.grpc.GetUIConfig(ctx, &emptypb.Empty{})
return resp, trace.Wrap(err)
}
// SetUIConfig sets the configuration for the UI served by the proxy service
func (c *Client) SetUIConfig(ctx context.Context, uic types.UIConfig) error {
uicV1, ok := uic.(*types.UIConfigV1)
if !ok {
return trace.BadParameter("invalid type %T", uic)
}
_, err := c.grpc.SetUIConfig(ctx, uicV1)
return trace.Wrap(err)
}
func (c *Client) DeleteUIConfig(ctx context.Context) error {
_, err := c.grpc.DeleteUIConfig(ctx, &emptypb.Empty{})
return trace.Wrap(err)
}
// GetInstaller gets the cluster installer resource
func (c *Client) GetInstaller(ctx context.Context, name string) (types.Installer, error) {
resp, err := c.grpc.GetInstaller(ctx, &types.ResourceRequest{Name: name})
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// SetInstaller sets the cluster installer resource
func (c *Client) SetInstaller(ctx context.Context, inst types.Installer) error {
instV1, ok := inst.(*types.InstallerV1)
if !ok {
return trace.BadParameter("invalid type %T", inst)
}
_, err := c.grpc.SetInstaller(ctx, instV1)
return trace.Wrap(err)
}
// DeleteInstaller deletes the cluster installer resource
func (c *Client) DeleteInstaller(ctx context.Context, name string) error {
_, err := c.grpc.DeleteInstaller(ctx, &types.ResourceRequest{Name: name})
return trace.Wrap(err)
}
// DeleteAllInstallers deletes all the installer resources.
func (c *Client) DeleteAllInstallers(ctx context.Context) error {
_, err := c.grpc.DeleteAllInstallers(ctx, &emptypb.Empty{})
return trace.Wrap(err)
}
// GetLock gets a lock by name.
func (c *Client) GetLock(ctx context.Context, name string) (types.Lock, error) {
if name == "" {
return nil, trace.BadParameter("missing lock name")
}
resp, err := c.grpc.GetLock(ctx, &proto.GetLockRequest{Name: name})
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GetLocks gets all/in-force locks that match at least one of the targets when specified.
func (c *Client) GetLocks(ctx context.Context, inForceOnly bool, targets ...types.LockTarget) ([]types.Lock, error) {
targetPtrs := make([]*types.LockTarget, len(targets))
for i := range targets {
targetPtrs[i] = &targets[i]
}
resp, err := c.grpc.GetLocks(ctx, &proto.GetLocksRequest{
InForceOnly: inForceOnly,
Targets: targetPtrs,
})
if err != nil {
return nil, trace.Wrap(err)
}
locks := make([]types.Lock, 0, len(resp.Locks))
for _, lock := range resp.Locks {
locks = append(locks, lock)
}
return locks, nil
}
// UpsertLock upserts a lock.
func (c *Client) UpsertLock(ctx context.Context, lock types.Lock) error {
lockV2, ok := lock.(*types.LockV2)
if !ok {
return trace.BadParameter("invalid type %T", lock)
}
_, err := c.grpc.UpsertLock(ctx, lockV2)
return trace.Wrap(err)
}
// DeleteLock deletes a lock.
func (c *Client) DeleteLock(ctx context.Context, name string) error {
if name == "" {
return trace.BadParameter("missing lock name")
}
_, err := c.grpc.DeleteLock(ctx, &proto.DeleteLockRequest{Name: name})
return trace.Wrap(err)
}
// ReplaceRemoteLocks replaces the set of locks associated with a remote cluster.
func (c *Client) ReplaceRemoteLocks(ctx context.Context, clusterName string, locks []types.Lock) error {
if clusterName == "" {
return trace.BadParameter("missing cluster name")
}
lockV2s := make([]*types.LockV2, 0, len(locks))
for _, lock := range locks {
lockV2, ok := lock.(*types.LockV2)
if !ok {
return trace.BadParameter("unexpected lock type %T", lock)
}
lockV2s = append(lockV2s, lockV2)
}
_, err := c.grpc.ReplaceRemoteLocks(ctx, &proto.ReplaceRemoteLocksRequest{
ClusterName: clusterName,
Locks: lockV2s,
})
return trace.Wrap(err)
}
// GetNetworkRestrictions retrieves the network restrictions
func (c *Client) GetNetworkRestrictions(ctx context.Context) (types.NetworkRestrictions, error) {
nr, err := c.grpc.GetNetworkRestrictions(ctx, &emptypb.Empty{})
if err != nil {
return nil, trace.Wrap(err)
}
return nr, nil
}
// SetNetworkRestrictions updates the network restrictions
func (c *Client) SetNetworkRestrictions(ctx context.Context, nr types.NetworkRestrictions) error {
restrictionsV4, ok := nr.(*types.NetworkRestrictionsV4)
if !ok {
return trace.BadParameter("invalid type %T", nr)
}
_, err := c.grpc.SetNetworkRestrictions(ctx, restrictionsV4)
if err != nil {
return trace.Wrap(err)
}
return nil
}
// DeleteNetworkRestrictions deletes the network restrictions
func (c *Client) DeleteNetworkRestrictions(ctx context.Context) error {
_, err := c.grpc.DeleteNetworkRestrictions(ctx, &emptypb.Empty{})
if err != nil {
return trace.Wrap(err)
}
return nil
}
// CreateApp creates a new application resource.
func (c *Client) CreateApp(ctx context.Context, app types.Application) error {
appV3, ok := app.(*types.AppV3)
if !ok {
return trace.BadParameter("unsupported application type %T", app)
}
_, err := c.grpc.CreateApp(ctx, appV3)
return trace.Wrap(err)
}
// UpdateApp updates existing application resource.
func (c *Client) UpdateApp(ctx context.Context, app types.Application) error {
appV3, ok := app.(*types.AppV3)
if !ok {
return trace.BadParameter("unsupported application type %T", app)
}
_, err := c.grpc.UpdateApp(ctx, appV3)
return trace.Wrap(err)
}
// GetApp returns the specified application resource.
//
// Note that application resources here refers to "dynamically-added"
// applications such as applications created by `tctl create`, or the CreateApp
// API. Applications defined in the `app_service.apps` section of the service
// YAML configuration are not collected in this API.
//
// For a full list of registered applications that are served by an application
// service, use GetApplicationServers instead.
func (c *Client) GetApp(ctx context.Context, name string) (types.Application, error) {
if name == "" {
return nil, trace.BadParameter("missing application name")
}
app, err := c.grpc.GetApp(ctx, &types.ResourceRequest{Name: name})
if err != nil {
return nil, trace.Wrap(err)
}
return app, nil
}
// GetApps returns all application resources.
//
// Note that application resources here refers to "dynamically-added"
// applications such as applications created by `tctl create`, or the CreateApp
// API. Applications defined in the `app_service.apps` section of the service
// YAML configuration are not collected in this API.
//
// For a full list of registered applications that are served by an application
// service, use GetApplicationServers instead.
// Deprecated: Prefer using [ListApps] or [Apps] instead.
func (c *Client) GetApps(ctx context.Context) ([]types.Application, error) {
//nolint:staticcheck // TODO(okraport): deprecated, to be removed in v21
items, err := c.grpc.GetApps(ctx, &emptypb.Empty{})
if err != nil {
return nil, trace.Wrap(err)
}
apps := make([]types.Application, len(items.Apps))
for i := range items.Apps {
apps[i] = items.Apps[i]
}
return apps, nil
}
// ListApps returns a page of application resources.
//
// Note that application resources here refers to "dynamically-added"
// applications such as applications created by `tctl create`, or the CreateApp
// API. Applications defined in the `app_service.apps` section of the service
// YAML configuration are not collected in this API.
//
// For a page of registered applications that are served by an application
// service, use ListResources instead.
func (c *Client) ListApps(ctx context.Context, limit int, start string) ([]types.Application, string, error) {
resp, err := c.grpc.ListApps(ctx, &proto.ListAppsRequest{
Limit: int32(limit),
StartKey: start,
})
if err != nil {
return nil, "", trace.Wrap(err)
}
apps := make([]types.Application, 0, len(resp.Applications))
for _, app := range resp.Applications {
apps = append(apps, app)
}
return apps, resp.NextKey, nil
}
// Apps returns application resources within the range [start, end).
func (c *Client) Apps(ctx context.Context, start, end string) iter.Seq2[types.Application, error] {
return clientutils.RangeResources(ctx, start, end, c.ListApps, types.Application.GetName)
}
// DeleteApp deletes specified application resource.
func (c *Client) DeleteApp(ctx context.Context, name string) error {
_, err := c.grpc.DeleteApp(ctx, &types.ResourceRequest{Name: name})
return trace.Wrap(err)
}
// DeleteAllApps deletes all application resources.
func (c *Client) DeleteAllApps(ctx context.Context) error {
_, err := c.grpc.DeleteAllApps(ctx, &emptypb.Empty{})
return trace.Wrap(err)
}
// CreateKubernetesCluster creates a new kubernetes cluster resource.
func (c *Client) CreateKubernetesCluster(ctx context.Context, cluster types.KubeCluster) error {
kubeClusterV3, ok := cluster.(*types.KubernetesClusterV3)
if !ok {
return trace.BadParameter("unsupported kubernetes cluster type %T", cluster)
}
_, err := c.grpc.CreateKubernetesCluster(ctx, kubeClusterV3)
return trace.Wrap(err)
}
// UpdateKubernetesCluster updates existing kubernetes cluster resource.
func (c *Client) UpdateKubernetesCluster(ctx context.Context, cluster types.KubeCluster) error {
kubeClusterV3, ok := cluster.(*types.KubernetesClusterV3)
if !ok {
return trace.BadParameter("unsupported kubernetes cluster type %T", cluster)
}
_, err := c.grpc.UpdateKubernetesCluster(ctx, kubeClusterV3)
return trace.Wrap(err)
}
// GetKubernetesCluster returns the specified kubernetes resource.
func (c *Client) GetKubernetesCluster(ctx context.Context, name string) (types.KubeCluster, error) {
if name == "" {
return nil, trace.BadParameter("missing kubernetes cluster name")
}
cluster, err := c.grpc.GetKubernetesCluster(ctx, &types.ResourceRequest{Name: name})
if err != nil {
return nil, trace.Wrap(err)
}
return cluster, nil
}
// GetKubernetesClusters returns all kubernetes cluster resources.
func (c *Client) GetKubernetesClusters(ctx context.Context) ([]types.KubeCluster, error) {
items, err := c.grpc.GetKubernetesClusters(ctx, &emptypb.Empty{})
if err != nil {
return nil, trace.Wrap(err)
}
clusters := make([]types.KubeCluster, len(items.KubernetesClusters))
for i := range items.KubernetesClusters {
clusters[i] = items.KubernetesClusters[i]
}
return clusters, nil
}
// DeleteKubernetesCluster deletes specified kubernetes cluster resource.
func (c *Client) DeleteKubernetesCluster(ctx context.Context, name string) error {
_, err := c.grpc.DeleteKubernetesCluster(ctx, &types.ResourceRequest{Name: name})
return trace.Wrap(err)
}
// DeleteAllKubernetesClusters deletes all kubernetes cluster resources.
func (c *Client) DeleteAllKubernetesClusters(ctx context.Context) error {
_, err := c.grpc.DeleteAllKubernetesClusters(ctx, &emptypb.Empty{})
return trace.Wrap(err)
}
// GetKubernetesWaitingContainerClient an unadorned KubeWaitingContainers
// client, using the underlying Auth gRPC connection.
func (c *Client) GetKubernetesWaitingContainerClient() *kubewaitingcontainerclient.Client {
return kubewaitingcontainerclient.NewClient(kubewaitingcontainerpb.NewKubeWaitingContainersServiceClient(c.conn))
}
// ListKubernetesWaitingContainers lists Kubernetes ephemeral
// containers that are waiting to be created until moderated
// session conditions are met.
func (c *Client) ListKubernetesWaitingContainers(ctx context.Context, pageSize int, pageToken string) ([]*kubewaitingcontainerpb.KubernetesWaitingContainer, string, error) {
return c.GetKubernetesWaitingContainerClient().ListKubernetesWaitingContainers(ctx, pageSize, pageToken)
}
// GetKubernetesWaitingContainer returns a Kubernetes ephemeral
// container that are waiting to be created until moderated
// session conditions are met.
func (c *Client) GetKubernetesWaitingContainer(ctx context.Context, req *kubewaitingcontainerpb.GetKubernetesWaitingContainerRequest) (*kubewaitingcontainerpb.KubernetesWaitingContainer, error) {
return c.GetKubernetesWaitingContainerClient().GetKubernetesWaitingContainer(ctx, req)
}
// CreateKubernetesWaitingContainer creates a Kubernetes ephemeral
// container that are waiting to be created until moderated
// session conditions are met.
func (c *Client) CreateKubernetesWaitingContainer(ctx context.Context, waitingPod *kubewaitingcontainerpb.KubernetesWaitingContainer) (*kubewaitingcontainerpb.KubernetesWaitingContainer, error) {
return c.GetKubernetesWaitingContainerClient().CreateKubernetesWaitingContainer(ctx, waitingPod)
}
// DeleteKubernetesWaitingContainer deletes a Kubernetes ephemeral
// container that are waiting to be created until moderated
// session conditions are met.
func (c *Client) DeleteKubernetesWaitingContainer(ctx context.Context, req *kubewaitingcontainerpb.DeleteKubernetesWaitingContainerRequest) error {
return c.GetKubernetesWaitingContainerClient().DeleteKubernetesWaitingContainer(ctx, req)
}
// StaticHostUserClient returns a new static host user client.
func (c *Client) StaticHostUserClient() *statichostuserclient.Client {
return statichostuserclient.NewClient(userprovisioningpb.NewStaticHostUsersServiceClient(c.conn))
}
// CreateDatabase creates a new database resource.
func (c *Client) CreateDatabase(ctx context.Context, database types.Database) error {
databaseV3, ok := database.(*types.DatabaseV3)
if !ok {
return trace.BadParameter("unsupported database type %T", database)
}
_, err := c.grpc.CreateDatabase(ctx, databaseV3)
return trace.Wrap(err)
}
// UpdateDatabase updates existing database resource.
func (c *Client) UpdateDatabase(ctx context.Context, database types.Database) error {
databaseV3, ok := database.(*types.DatabaseV3)
if !ok {
return trace.BadParameter("unsupported database type %T", database)
}
_, err := c.grpc.UpdateDatabase(ctx, databaseV3)
return trace.Wrap(err)
}
// GetDatabase returns the specified database resource.
//
// Note that database resources here refers to "dynamically-added" databases
// such as databases created by `tctl create`, the discovery service, or the
// CreateDatabase API. Databases discovered by the database agent (legacy
// discovery flow using `database_service.aws/database_service.azure`) and
// static databases defined in the `database_service.databases` section of the
// service YAML configuration are not collected in this API.
//
// For a full list of registered databases that are served by a database
// service, use GetDatabaseServers instead.
func (c *Client) GetDatabase(ctx context.Context, name string) (types.Database, error) {
if name == "" {
return nil, trace.BadParameter("missing database name")
}
database, err := c.grpc.GetDatabase(ctx, &types.ResourceRequest{Name: name})
if err != nil {
return nil, trace.Wrap(err)
}
return database, nil
}
// GetDatabases returns all database resources.
//
// Note that database resources here refers to "dynamically-added" databases
// such as databases created by `tctl create`, the discovery service, or the
// CreateDatabase API. Databases discovered by the database agent (legacy
// discovery flow using `database_service.aws/database_service.azure`) and
// static databases defined in the `database_service.databases` section of the
// service YAML configuration are not collected in this API.
//
// For a full list of registered databases that are served by a database
// service, use GetDatabaseServers instead.
// Deprecated: Prefer paginated variant such as [ListDatabases] or [RangeDatabases]
func (c *Client) GetDatabases(ctx context.Context) ([]types.Database, error) {
//nolint:staticcheck // TODO(okraport): deprecated, to be removed in v21
items, err := c.grpc.GetDatabases(ctx, &emptypb.Empty{})
if err != nil {
return nil, trace.Wrap(err)
}
databases := make([]types.Database, len(items.Databases))
for i := range items.Databases {
databases[i] = items.Databases[i]
}
return databases, nil
}
// ListDatabases returns a page of database resources.
//
// Note that database resources here refers to "dynamically-added" databases
// such as databases created by `tctl create`, the discovery service, or the
// CreateDatabase API. Databases discovered by the database agent (legacy
// discovery flow using `database_service.aws/database_service.azure`) and
// static databases defined in the `database_service.databases` section of the
// service YAML configuration are not collected in this API.
func (c *Client) ListDatabases(ctx context.Context, limit int, start string) ([]types.Database, string, error) {
resp, err := c.grpc.ListDatabases(ctx, &proto.ListDatabasesRequest{
PageSize: int32(limit),
PageToken: start,
})
if err != nil {
return nil, "", trace.Wrap(err)
}
databases := make([]types.Database, len(resp.Databases))
for i := range resp.Databases {
databases[i] = resp.Databases[i]
}
return databases, resp.NextPageToken, nil
}
// RangeDatabases returns database resources within the range [start, end).
func (c *Client) RangeDatabases(ctx context.Context, start, end string) iter.Seq2[types.Database, error] {
return clientutils.RangeResources(ctx, start, end, c.ListDatabases, types.Database.GetName)
}
// DeleteDatabase deletes specified database resource.
func (c *Client) DeleteDatabase(ctx context.Context, name string) error {
_, err := c.grpc.DeleteDatabase(ctx, &types.ResourceRequest{Name: name})
return trace.Wrap(err)
}
// DeleteAllDatabases deletes all database resources.
func (c *Client) DeleteAllDatabases(ctx context.Context) error {
_, err := c.grpc.DeleteAllDatabases(ctx, &emptypb.Empty{})
return trace.Wrap(err)
}
// UpsertDatabaseService creates or updates existing DatabaseService resource.
func (c *Client) UpsertDatabaseService(ctx context.Context, service types.DatabaseService) (*types.KeepAlive, error) {
serviceV1, ok := service.(*types.DatabaseServiceV1)
if !ok {
return nil, trace.BadParameter("unsupported DatabaseService type %T", serviceV1)
}
keepAlive, err := c.grpc.UpsertDatabaseService(ctx, &proto.UpsertDatabaseServiceRequest{
Service: serviceV1,
})
return keepAlive, trace.Wrap(err)
}
// DeleteDatabaseService deletes a specific DatabaseService resource.
func (c *Client) DeleteDatabaseService(ctx context.Context, name string) error {
_, err := c.grpc.DeleteDatabaseService(ctx, &types.ResourceRequest{Name: name})
return trace.Wrap(err)
}
// DeleteAllDatabaseServices deletes all DatabaseService resources.
// If an error occurs, a partial delete may happen.
func (c *Client) DeleteAllDatabaseServices(ctx context.Context) error {
_, err := c.grpc.DeleteAllDatabaseServices(ctx, &proto.DeleteAllDatabaseServicesRequest{})
return trace.Wrap(err)
}
// GetDatabaseObjectImportRules retrieves all database object import rules.
func (c *Client) GetDatabaseObjectImportRules(ctx context.Context) ([]*dbobjectimportrulev1.DatabaseObjectImportRule, error) {
var out []*dbobjectimportrulev1.DatabaseObjectImportRule
req := &dbobjectimportrulev1.ListDatabaseObjectImportRulesRequest{}
client := c.DatabaseObjectImportRuleClient()
for {
resp, err := client.ListDatabaseObjectImportRules(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
out = append(out, resp.Rules...)
if resp.NextPageToken == "" {
break
}
req.PageToken = resp.NextPageToken
}
return out, nil
}
// GetDatabaseObjects retrieves all database objects.
func (c *Client) GetDatabaseObjects(ctx context.Context) ([]*dbobjectv1.DatabaseObject, error) {
var out []*dbobjectv1.DatabaseObject
req := &dbobjectv1.ListDatabaseObjectsRequest{}
client := c.DatabaseObjectClient()
for {
resp, err := client.ListDatabaseObjects(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
out = append(out, resp.Objects...)
if resp.NextPageToken == "" {
break
}
req.PageToken = resp.NextPageToken
}
return out, nil
}
// ListWindowsDesktops returns a page of registered Windows desktop hosts.
func (c *Client) ListWindowsDesktops(ctx context.Context, req types.ListWindowsDesktopsRequest) (*types.ListWindowsDesktopsResponse, error) {
resp, err := c.grpc.ListWindowsDesktops(ctx, &proto.ListWindowsDesktopsRequest{
Limit: int32(req.Limit),
StartKey: req.StartKey,
Labels: req.Labels,
PredicateExpression: req.PredicateExpression,
SearchKeywords: req.SearchKeywords,
WindowsDesktopFilter: req.WindowsDesktopFilter,
})
if err != nil {
return nil, trace.Wrap(err)
}
out := &types.ListWindowsDesktopsResponse{
Desktops: make([]types.WindowsDesktop, 0, len(resp.Desktops)),
NextKey: resp.NextKey,
}
for _, d := range resp.Desktops {
out.Desktops = append(out.Desktops, d)
}
return out, nil
}
// ListWindowsDesktopServices returns a page of Windows desktop services.
func (c *Client) ListWindowsDesktopServices(ctx context.Context, req types.ListWindowsDesktopServicesRequest) (*types.ListWindowsDesktopServicesResponse, error) {
resp, err := c.grpc.ListResources(ctx, &proto.ListResourcesRequest{
Limit: int32(req.Limit),
StartKey: req.StartKey,
Labels: req.Labels,
PredicateExpression: req.PredicateExpression,
SearchKeywords: req.SearchKeywords,
})
if err != nil {
return nil, trace.Wrap(err)
}
out := &types.ListWindowsDesktopServicesResponse{
DesktopServices: make([]types.WindowsDesktopService, 0, len(resp.Resources)),
NextKey: resp.NextKey,
}
for _, r := range resp.Resources {
out.DesktopServices = append(out.DesktopServices, r.GetWindowsDesktopService())
}
return out, nil
}
// GetWindowsDesktopServices returns all registered windows desktop services.
func (c *Client) GetWindowsDesktopServices(ctx context.Context) ([]types.WindowsDesktopService, error) {
resp, err := c.grpc.GetWindowsDesktopServices(ctx, &emptypb.Empty{})
if err != nil {
return nil, trace.Wrap(err)
}
services := make([]types.WindowsDesktopService, 0, len(resp.GetServices()))
for _, service := range resp.GetServices() {
services = append(services, service)
}
return services, nil
}
// GetWindowsDesktopService returns a registered windows desktop service by name.
func (c *Client) GetWindowsDesktopService(ctx context.Context, name string) (types.WindowsDesktopService, error) {
resp, err := c.grpc.GetWindowsDesktopService(ctx, &proto.GetWindowsDesktopServiceRequest{Name: name})
if err != nil {
return nil, trace.Wrap(err)
}
return resp.GetService(), nil
}
// UpsertWindowsDesktopService registers a new windows desktop service.
func (c *Client) UpsertWindowsDesktopService(ctx context.Context, service types.WindowsDesktopService) (*types.KeepAlive, error) {
s, ok := service.(*types.WindowsDesktopServiceV3)
if !ok {
return nil, trace.BadParameter("invalid type %T", service)
}
keepAlive, err := c.grpc.UpsertWindowsDesktopService(ctx, s)
if err != nil {
return nil, trace.Wrap(err)
}
return keepAlive, nil
}
// DeleteWindowsDesktopService removes the specified windows desktop service.
func (c *Client) DeleteWindowsDesktopService(ctx context.Context, name string) error {
_, err := c.grpc.DeleteWindowsDesktopService(ctx, &proto.DeleteWindowsDesktopServiceRequest{
Name: name,
})
if err != nil {
return trace.Wrap(err)
}
return nil
}
// DeleteAllWindowsDesktopServices removes all registered windows desktop services.
func (c *Client) DeleteAllWindowsDesktopServices(ctx context.Context) error {
_, err := c.grpc.DeleteAllWindowsDesktopServices(ctx, &emptypb.Empty{})
if err != nil {
return trace.Wrap(err)
}
return nil
}
// GetRelayServer returns the relay server heartbeat with a given name.
func (c *Client) GetRelayServer(ctx context.Context, name string) (*presencepb.RelayServer, error) {
req := &presencepb.GetRelayServerRequest{
Name: name,
}
resp, err := c.PresenceServiceClient().GetRelayServer(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp.GetRelayServer(), nil
}
// ListRelayServers returns a paginated list of relay server heartbeats.
func (c *Client) ListRelayServers(ctx context.Context, pageSize int, pageToken string) (_ []*presencepb.RelayServer, nextPageToken string, _ error) {
req := &presencepb.ListRelayServersRequest{
PageSize: int64(pageSize),
PageToken: pageToken,
}
resp, err := c.PresenceServiceClient().ListRelayServers(ctx, req)
if err != nil {
return nil, "", trace.Wrap(err)
}
return resp.GetRelays(), resp.GetNextPageToken(), nil
}
// DeleteRelayServer deletes a relay server heartbeat by name.
func (c *Client) DeleteRelayServer(ctx context.Context, name string) error {
req := &presencepb.DeleteRelayServerRequest{
Name: name,
}
_, err := c.PresenceServiceClient().DeleteRelayServer(ctx, req)
return trace.Wrap(err)
}
func (c *Client) GetDesktopBootstrapScript(ctx context.Context) (string, error) {
resp, err := c.grpc.GetDesktopBootstrapScript(ctx, &emptypb.Empty{})
if err != nil {
return "", trace.Wrap(err)
}
return resp.GetScript(), nil
}
// GetWindowsDesktops returns all registered windows desktop hosts.
func (c *Client) GetWindowsDesktops(ctx context.Context, filter types.WindowsDesktopFilter) ([]types.WindowsDesktop, error) {
resp, err := c.grpc.GetWindowsDesktops(ctx, &filter)
if err != nil {
return nil, trace.Wrap(err)
}
desktops := make([]types.WindowsDesktop, 0, len(resp.GetDesktops()))
for _, desktop := range resp.GetDesktops() {
desktops = append(desktops, desktop)
}
return desktops, nil
}
// CreateWindowsDesktop registers a new windows desktop host.
func (c *Client) CreateWindowsDesktop(ctx context.Context, desktop types.WindowsDesktop) error {
d, ok := desktop.(*types.WindowsDesktopV3)
if !ok {
return trace.BadParameter("invalid type %T", desktop)
}
_, err := c.grpc.CreateWindowsDesktop(ctx, d)
return trace.Wrap(err)
}
// UpdateWindowsDesktop updates an existing windows desktop host.
func (c *Client) UpdateWindowsDesktop(ctx context.Context, desktop types.WindowsDesktop) error {
d, ok := desktop.(*types.WindowsDesktopV3)
if !ok {
return trace.BadParameter("invalid type %T", desktop)
}
_, err := c.grpc.UpdateWindowsDesktop(ctx, d)
return trace.Wrap(err)
}
// UpsertWindowsDesktop updates a windows desktop resource, creating it if it doesn't exist.
func (c *Client) UpsertWindowsDesktop(ctx context.Context, desktop types.WindowsDesktop) error {
d, ok := desktop.(*types.WindowsDesktopV3)
if !ok {
return trace.BadParameter("invalid type %T", desktop)
}
_, err := c.grpc.UpsertWindowsDesktop(ctx, d)
return trace.Wrap(err)
}
// DeleteWindowsDesktop removes the specified windows desktop host.
// Note: unlike GetWindowsDesktops, this will delete at-most one desktop.
// Passing an empty host ID will not trigger "delete all" behavior. To delete
// all desktops, use DeleteAllWindowsDesktops.
func (c *Client) DeleteWindowsDesktop(ctx context.Context, hostID, name string) error {
_, err := c.grpc.DeleteWindowsDesktop(ctx, &proto.DeleteWindowsDesktopRequest{
Name: name,
HostID: hostID,
})
if err != nil {
return trace.Wrap(err)
}
return nil
}
// DeleteAllWindowsDesktops removes all registered windows desktop hosts.
func (c *Client) DeleteAllWindowsDesktops(ctx context.Context) error {
_, err := c.grpc.DeleteAllWindowsDesktops(ctx, &emptypb.Empty{})
if err != nil {
return trace.Wrap(err)
}
return nil
}
// GenerateWindowsDesktopCert generates client certificate for Windows RDP authentication.
func (c *Client) GenerateWindowsDesktopCert(ctx context.Context, req *proto.WindowsDesktopCertRequest) (*proto.WindowsDesktopCertResponse, error) {
resp, err := c.grpc.GenerateWindowsDesktopCert(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// ChangeUserAuthentication allows a user with a reset or invite token to change their password and if enabled also adds a new mfa device.
// Upon success, creates new web session and creates new set of recovery codes (if user meets requirements).
func (c *Client) ChangeUserAuthentication(ctx context.Context, req *proto.ChangeUserAuthenticationRequest) (*proto.ChangeUserAuthenticationResponse, error) {
res, err := c.grpc.ChangeUserAuthentication(ctx, req)
return res, trace.Wrap(err)
}
// StartAccountRecovery creates a recovery start token for a user who successfully verified their username and their recovery code.
// This token is used as part of a URL that will be emailed to the user (not done in this request).
// Represents step 1 of the account recovery process.
func (c *Client) StartAccountRecovery(ctx context.Context, req *proto.StartAccountRecoveryRequest) (types.UserToken, error) {
res, err := c.grpc.StartAccountRecovery(ctx, req)
return res, trace.Wrap(err)
}
// VerifyAccountRecovery creates a recovery approved token after successful verification of users password or second factor
// (authn depending on what user needed to recover). This token will allow users to perform protected actions while not logged in.
// Represents step 2 of the account recovery process after RPC StartAccountRecovery.
func (c *Client) VerifyAccountRecovery(ctx context.Context, req *proto.VerifyAccountRecoveryRequest) (types.UserToken, error) {
res, err := c.grpc.VerifyAccountRecovery(ctx, req)
return res, trace.Wrap(err)
}
// CompleteAccountRecovery sets a new password or adds a new mfa device,
// allowing user to regain access to their account using the new credentials.
// Represents the last step in the account recovery process after RPC's StartAccountRecovery and VerifyAccountRecovery.
func (c *Client) CompleteAccountRecovery(ctx context.Context, req *proto.CompleteAccountRecoveryRequest) error {
_, err := c.grpc.CompleteAccountRecovery(ctx, req)
return trace.Wrap(err)
}
// CreateAccountRecoveryCodes creates new set of recovery codes for a user, replacing and invalidating any previously owned codes.
func (c *Client) CreateAccountRecoveryCodes(ctx context.Context, req *proto.CreateAccountRecoveryCodesRequest) (*proto.RecoveryCodes, error) {
res, err := c.grpc.CreateAccountRecoveryCodes(ctx, req)
return res, trace.Wrap(err)
}
// GetAccountRecoveryToken returns a user token resource after verifying the token in
// request is not expired and is of the correct recovery type.
func (c *Client) GetAccountRecoveryToken(ctx context.Context, req *proto.GetAccountRecoveryTokenRequest) (types.UserToken, error) {
res, err := c.grpc.GetAccountRecoveryToken(ctx, req)
return res, trace.Wrap(err)
}
// GetAccountRecoveryCodes returns the user in context their recovery codes resource without any secrets.
func (c *Client) GetAccountRecoveryCodes(ctx context.Context, req *proto.GetAccountRecoveryCodesRequest) (*proto.RecoveryCodes, error) {
res, err := c.grpc.GetAccountRecoveryCodes(ctx, req)
return res, trace.Wrap(err)
}
// CreateAuthenticateChallenge creates and returns MFA challenges for a users registered MFA devices.
func (c *Client) CreateAuthenticateChallenge(ctx context.Context, in *proto.CreateAuthenticateChallengeRequest) (*proto.MFAAuthenticateChallenge, error) {
resp, err := c.grpc.CreateAuthenticateChallenge(ctx, in)
return resp, trace.Wrap(err)
}
// CreatePrivilegeToken is implemented by AuthService.CreatePrivilegeToken.
func (c *Client) CreatePrivilegeToken(ctx context.Context, req *proto.CreatePrivilegeTokenRequest) (*types.UserTokenV3, error) {
resp, err := c.grpc.CreatePrivilegeToken(ctx, req)
return resp, trace.Wrap(err)
}
// CreateRegisterChallenge creates and returns MFA register challenge for a new MFA device.
func (c *Client) CreateRegisterChallenge(ctx context.Context, in *proto.CreateRegisterChallengeRequest) (*proto.MFARegisterChallenge, error) {
resp, err := c.grpc.CreateRegisterChallenge(ctx, in)
return resp, trace.Wrap(err)
}
// GenerateCertAuthorityCRL generates an empty CRL for a CA.
func (c *Client) GenerateCertAuthorityCRL(ctx context.Context, req *proto.CertAuthorityRequest) (*proto.CRL, error) {
resp, err := c.grpc.GenerateCertAuthorityCRL(ctx, req)
return resp, trace.Wrap(err)
}
// ListResources returns a paginated list of nodes that the user has access to.
// `nextKey` is used as `startKey` in another call to ListResources to retrieve
// the next page. If you want to list all resources pages, check the
// `GetResourcesWithFilters` function.
// It will return a `trace.LimitExceeded` error if the page exceeds gRPC max
// message size.
func (c *Client) ListResources(ctx context.Context, req proto.ListResourcesRequest) (*types.ListResourcesResponse, error) {
if err := req.CheckAndSetDefaults(); err != nil {
return nil, trace.Wrap(err)
}
resp, err := c.grpc.ListResources(ctx, &req)
if err != nil {
return nil, trace.Wrap(err)
}
resources := make([]types.ResourceWithLabels, len(resp.GetResources()))
for i, respResource := range resp.GetResources() {
switch req.ResourceType {
case types.KindDatabaseServer:
resources[i] = respResource.GetDatabaseServer()
case types.KindDatabaseService:
resources[i] = respResource.GetDatabaseService()
case types.KindAppServer:
resources[i] = respResource.GetAppServer()
case types.KindNode:
resources[i] = respResource.GetNode()
case types.KindWindowsDesktop:
resources[i] = respResource.GetWindowsDesktop()
case types.KindWindowsDesktopService:
resources[i] = respResource.GetWindowsDesktopService()
case types.KindKubernetesCluster:
resources[i] = respResource.GetKubeCluster()
case types.KindKubeServer:
resources[i] = respResource.GetKubernetesServer()
case types.KindUserGroup:
resources[i] = respResource.GetUserGroup()
case types.KindSAMLIdPServiceProvider:
resources[i] = respResource.GetSAMLIdPServiceProvider()
case types.KindIdentityCenterAccount:
resources[i] = respResource.GetAppServer()
case types.KindIdentityCenterAccountAssignment:
src := respResource.GetIdentityCenterAccountAssignment()
dst := proto.UnpackICAccountAssignment(src)
resources[i] = dst
case types.KindGitServer:
resources[i] = respResource.GetGitServer()
default:
return nil, trace.NotImplemented("resource type %s does not support pagination", req.ResourceType)
}
}
return &types.ListResourcesResponse{
Resources: resources,
NextKey: resp.NextKey,
TotalCount: int(resp.TotalCount),
}, nil
}
// GetResources returns a paginated list of resources that the user has access to.
// `nextKey` is used as `startKey` in another call to GetResources to retrieve
// the next page.
// It will return a `trace.LimitExceeded` error if the page exceeds gRPC max
// message size.
func (c *Client) GetResources(ctx context.Context, req *proto.ListResourcesRequest) (*proto.ListResourcesResponse, error) {
if err := req.CheckAndSetDefaults(); err != nil {
return nil, trace.Wrap(err)
}
resp, err := c.grpc.ListResources(ctx, req)
return resp, trace.Wrap(err)
}
// ListUnifiedResources returns a paginated list of unified resources that the user has access to.
// `nextKey` is used as `startKey` in another call to ListUnifiedResources to retrieve
// the next page.
// It will return a `trace.LimitExceeded` error if the page exceeds gRPC max
// message size.
func (c *Client) ListUnifiedResources(ctx context.Context, req *proto.ListUnifiedResourcesRequest) (*proto.ListUnifiedResourcesResponse, error) {
if err := req.CheckAndSetDefaults(); err != nil {
return nil, trace.Wrap(err)
}
resp, err := c.grpc.ListUnifiedResources(ctx, req)
return resp, trace.Wrap(err)
}
// GetResourcesClient is an interface used by GetResources to abstract over implementations of
// the ListResources method.
type GetResourcesClient interface {
GetResources(ctx context.Context, req *proto.ListResourcesRequest) (*proto.ListResourcesResponse, error)
}
// ListUnifiedResourcesClient is an interface used by ListUnifiedResources to abstract over implementations of
// the ListUnifiedResources method.
type ListUnifiedResourcesClient interface {
ListUnifiedResources(ctx context.Context, req *proto.ListUnifiedResourcesRequest) (*proto.ListUnifiedResourcesResponse, error)
}
// ResourcePage holds a page of results from [GetResourcePage].
type ResourcePage[T types.ResourceWithLabels] struct {
// Resources retrieved for a single [proto.ListResourcesRequest]. The length of
// the slice will be at most [proto.ListResourcesRequest.Limit].
Resources []T
// Total number of all resources matching the request. It will be greater than
// the length of [Resources] if the number of matches exceeds the request limit.
Total int
// NextKey is the start of the next page
NextKey string
}
// convertEnrichedResource extracts the resource and any enriched information from the
// PaginatedResource returned from the rpc ListUnifiedResources.
func convertEnrichedResource(resource *proto.PaginatedResource) (*types.EnrichedResource, error) {
if r := resource.GetNode(); r != nil {
return &types.EnrichedResource{ResourceWithLabels: r, Logins: resource.Logins, RequiresRequest: resource.RequiresRequest}, nil
} else if r := resource.GetDatabaseServer(); r != nil {
return &types.EnrichedResource{ResourceWithLabels: r, RequiresRequest: resource.RequiresRequest}, nil
} else if r := resource.GetDatabaseService(); r != nil {
return &types.EnrichedResource{ResourceWithLabels: r, RequiresRequest: resource.RequiresRequest}, nil
} else if r := resource.GetWindowsDesktop(); r != nil {
return &types.EnrichedResource{ResourceWithLabels: r, Logins: resource.Logins, RequiresRequest: resource.RequiresRequest}, nil
} else if r := resource.GetWindowsDesktopService(); r != nil {
return &types.EnrichedResource{ResourceWithLabels: r, RequiresRequest: resource.RequiresRequest}, nil
} else if r := resource.GetKubeCluster(); r != nil {
return &types.EnrichedResource{ResourceWithLabels: r, RequiresRequest: resource.RequiresRequest}, nil
} else if r := resource.GetKubernetesServer(); r != nil {
return &types.EnrichedResource{ResourceWithLabels: r, RequiresRequest: resource.RequiresRequest}, nil
} else if r := resource.GetUserGroup(); r != nil {
return &types.EnrichedResource{ResourceWithLabels: r, RequiresRequest: resource.RequiresRequest}, nil
} else if r := resource.GetAppServer(); r != nil {
return &types.EnrichedResource{ResourceWithLabels: r, Logins: resource.Logins, RequiresRequest: resource.RequiresRequest}, nil
} else if r := resource.GetSAMLIdPServiceProvider(); r != nil {
return &types.EnrichedResource{ResourceWithLabels: r, RequiresRequest: resource.RequiresRequest}, nil
} else if r := resource.GetGitServer(); r != nil {
return &types.EnrichedResource{ResourceWithLabels: r, RequiresRequest: resource.RequiresRequest}, nil
} else {
return nil, trace.BadParameter("received unsupported resource %T", resource.Resource)
}
}
// GetUnifiedResourcePage is a helper for getting a single page of unified resources that match the provided request.
func GetUnifiedResourcePage(ctx context.Context, clt ListUnifiedResourcesClient, req *proto.ListUnifiedResourcesRequest) ([]*types.EnrichedResource, string, error) {
var out []*types.EnrichedResource
// Set the limit to the default size if one was not provided within
// an acceptable range.
if req.Limit <= 0 || req.Limit > int32(defaults.DefaultChunkSize) {
req.Limit = int32(defaults.DefaultChunkSize)
}
for {
resp, err := clt.ListUnifiedResources(ctx, req)
if err != nil {
if trace.IsLimitExceeded(err) {
// Cut chunkSize in half if gRPC max message size is exceeded.
req.Limit /= 2
// This is an extremely unlikely scenario, but better to cover it anyways.
if req.Limit == 0 {
return nil, "", trace.Wrap(err, "resource is too large to retrieve")
}
continue
}
return nil, "", trace.Wrap(err)
}
for _, respResource := range resp.Resources {
resource, err := convertEnrichedResource(respResource)
if err != nil {
return nil, "", trace.Wrap(err)
}
out = append(out, resource)
}
return out, resp.NextKey, nil
}
}
// GetAllUnifiedResources is a helper for getting all existing resources that match the provided request. In addition to
// iterating pages, it also correctly handles downsizing pages when LimitExceeded errors are encountered.
func GetAllUnifiedResources(ctx context.Context, clt ListUnifiedResourcesClient, req *proto.ListUnifiedResourcesRequest) ([]*types.EnrichedResource, error) {
var out []*types.EnrichedResource
// Set the limit to the default size.
req.Limit = int32(defaults.DefaultChunkSize)
for {
resources, nextKey, err := GetUnifiedResourcePage(ctx, clt, req)
if err != nil {
return nil, trace.Wrap(err)
}
out = append(out, resources...)
if nextKey == "" || len(resources) == 0 {
break
}
req.StartKey = nextKey
}
return out, nil
}
// GetEnrichedResourcePage is a helper for getting a single page of enriched resources.
func GetEnrichedResourcePage(ctx context.Context, clt GetResourcesClient, req *proto.ListResourcesRequest) (ResourcePage[*types.EnrichedResource], error) {
var out ResourcePage[*types.EnrichedResource]
// Set the limit to the default size if one was not provided within
// an acceptable range.
if req.Limit <= 0 || req.Limit > int32(defaults.DefaultChunkSize) {
req.Limit = int32(defaults.DefaultChunkSize)
}
for {
resp, err := clt.GetResources(ctx, req)
if err != nil {
if trace.IsLimitExceeded(err) {
// Cut chunkSize in half if gRPC max message size is exceeded.
req.Limit /= 2
// This is an extremely unlikely scenario, but better to cover it anyways.
if req.Limit == 0 {
return out, trace.Wrap(err, "resource is too large to retrieve")
}
continue
}
return out, trace.Wrap(err)
}
for _, respResource := range resp.Resources {
var resource types.ResourceWithLabels
switch req.ResourceType {
case types.KindDatabaseServer:
resource = respResource.GetDatabaseServer()
case types.KindDatabaseService:
resource = respResource.GetDatabaseService()
case types.KindAppServer:
resource = respResource.GetAppServer()
case types.KindNode:
resource = respResource.GetNode()
case types.KindWindowsDesktop:
resource = respResource.GetWindowsDesktop()
case types.KindWindowsDesktopService:
resource = respResource.GetWindowsDesktopService()
case types.KindKubernetesCluster:
resource = respResource.GetKubeCluster()
case types.KindKubeServer:
resource = respResource.GetKubernetesServer()
case types.KindUserGroup:
resource = respResource.GetUserGroup()
case types.KindSAMLIdPServiceProvider:
resource = respResource.GetSAMLIdPServiceProvider()
case types.KindGitServer:
resource = respResource.GetGitServer()
default:
out.Resources = nil
return out, trace.NotImplemented("resource type %s does not support pagination", req.ResourceType)
}
out.Resources = append(out.Resources, &types.EnrichedResource{ResourceWithLabels: resource, Logins: respResource.Logins})
}
out.NextKey = resp.NextKey
out.Total = int(resp.TotalCount)
return out, nil
}
}
// GetResourcePage is a helper for getting a single page of resources that match the provide request.
func GetResourcePage[T types.ResourceWithLabels](ctx context.Context, clt GetResourcesClient, req *proto.ListResourcesRequest) (ResourcePage[T], error) {
var out ResourcePage[T]
// Set the limit to the default size if one was not provided within
// an acceptable range.
if req.Limit <= 0 || req.Limit > int32(defaults.DefaultChunkSize) {
req.Limit = int32(defaults.DefaultChunkSize)
}
for {
resp, err := clt.GetResources(ctx, req)
if err != nil {
if trace.IsLimitExceeded(err) {
// Cut chunkSize in half if gRPC max message size is exceeded.
req.Limit /= 2
// This is an extremely unlikely scenario, but better to cover it anyways.
if req.Limit == 0 {
return out, trace.Wrap(err, "resource is too large to retrieve")
}
continue
}
return out, trace.Wrap(err)
}
for _, respResource := range resp.Resources {
var resource types.ResourceWithLabels
switch req.ResourceType {
case types.KindDatabaseServer:
resource = respResource.GetDatabaseServer()
case types.KindDatabaseService:
resource = respResource.GetDatabaseService()
case types.KindAppServer:
resource = respResource.GetAppServer()
case types.KindNode:
resource = respResource.GetNode()
case types.KindWindowsDesktop:
resource = respResource.GetWindowsDesktop()
case types.KindWindowsDesktopService:
resource = respResource.GetWindowsDesktopService()
case types.KindKubernetesCluster:
resource = respResource.GetKubeCluster()
case types.KindKubeServer:
resource = respResource.GetKubernetesServer()
case types.KindUserGroup:
resource = respResource.GetUserGroup()
case types.KindSAMLIdPServiceProvider:
resource = respResource.GetSAMLIdPServiceProvider()
case types.KindGitServer:
resource = respResource.GetGitServer()
default:
out.Resources = nil
return out, trace.NotImplemented("resource type %q does not support pagination", req.ResourceType)
}
t, ok := resource.(T)
if !ok {
out.Resources = nil
return out, trace.BadParameter("received unexpected resource type %T", resource)
}
out.Resources = append(out.Resources, t)
}
out.NextKey = resp.NextKey
out.Total = int(resp.TotalCount)
return out, nil
}
}
// GetAllResources is a helper for getting all existing resources that match the provided request. In addition to
// iterating pages, it also correctly handles downsizing pages when LimitExceeded errors are encountered.
func GetAllResources[T types.ResourceWithLabels](ctx context.Context, clt GetResourcesClient, req *proto.ListResourcesRequest) ([]T, error) {
var out []T
// Set the limit to the default size.
req.Limit = int32(defaults.DefaultChunkSize)
for {
page, err := GetResourcePage[T](ctx, clt, req)
if err != nil {
return nil, trace.Wrap(err)
}
out = append(out, page.Resources...)
if page.NextKey == "" || len(page.Resources) == 0 {
break
}
req.StartKey = page.NextKey
}
return out, nil
}
// ListResourcesClient is an interface used by GetResourcesWithFilters to abstract over implementations of
// the ListResources method.
type ListResourcesClient interface {
ListResources(ctx context.Context, req proto.ListResourcesRequest) (*types.ListResourcesResponse, error)
}
// GetResourcesWithFilters is a helper for getting a list of resources with optional filtering. In addition to
// iterating pages, it also correctly handles downsizing pages when LimitExceeded errors are encountered.
//
// GetAllResources or GetResourcePage should be preferred for client side operations to avoid converting
// from []types.ResourceWithLabels to concrete types.
func GetResourcesWithFilters(ctx context.Context, clt ListResourcesClient, req proto.ListResourcesRequest) ([]types.ResourceWithLabels, error) {
// Retrieve the complete list of resources in chunks.
var (
resources []types.ResourceWithLabels
startKey string
chunkSize = int32(defaults.DefaultChunkSize)
)
for {
resp, err := clt.ListResources(ctx, proto.ListResourcesRequest{
Namespace: req.Namespace,
ResourceType: req.ResourceType,
StartKey: startKey,
Limit: chunkSize,
Labels: req.Labels,
SearchKeywords: req.SearchKeywords,
PredicateExpression: req.PredicateExpression,
UseSearchAsRoles: req.UseSearchAsRoles,
UsePreviewAsRoles: req.UsePreviewAsRoles,
})
if err != nil {
if trace.IsLimitExceeded(err) {
// Cut chunkSize in half if gRPC max message size is exceeded.
chunkSize = chunkSize / 2
// This is an extremely unlikely scenario, but better to cover it anyways.
if chunkSize == 0 {
return nil, trace.Wrap(err, "resource is too large to retrieve")
}
continue
}
return nil, trace.Wrap(err)
}
startKey = resp.NextKey
resources = append(resources, resp.Resources...)
if startKey == "" || len(resp.Resources) == 0 {
break
}
}
return resources, nil
}
// GetKubernetesResourcesWithFilters is a helper for getting a list of kubernetes resources with optional filtering. In addition to
// iterating pages, it also correctly handles downsizing pages when LimitExceeded errors are encountered.
func GetKubernetesResourcesWithFilters(ctx context.Context, clt kubeproto.KubeServiceClient, req *kubeproto.ListKubernetesResourcesRequest) ([]types.ResourceWithLabels, error) {
var (
resources []types.ResourceWithLabels
startKey = req.StartKey
// Retrieve the complete list of resources in chunks.
chunkSize = req.Limit
)
// Set the chunk size to the default if it is not set.
if chunkSize == 0 {
chunkSize = int32(defaults.DefaultChunkSize)
}
for {
// Reset startKey to the previous page's nextKey.
req.StartKey = startKey
// Set the chunk size based on the previous chunk size error.
req.Limit = chunkSize
resp, err := clt.ListKubernetesResources(
ctx,
req,
)
if err != nil {
if trace.IsLimitExceeded(err) {
// Cut chunkSize in half if gRPC max message size is exceeded.
chunkSize = chunkSize / 2
// This is an extremely unlikely scenario, but better to cover it anyways.
if chunkSize == 0 {
return nil, trace.Wrap(err, "resource is too large to retrieve")
}
continue
}
return nil, trace.Wrap(err)
}
startKey = resp.NextKey
resources = append(resources, types.KubeResources(resp.Resources).AsResources()...)
if startKey == "" || len(resp.Resources) == 0 {
break
}
}
return resources, nil
}
// GetSSHTargets gets all servers that would match an equivalent ssh dial request. Note that this method
// returns all resources directly accessible to the user *and* all resources available via 'SearchAsRoles',
// which is what we want when handling things like ambiguous host errors and resource-based access requests,
// but may result in confusing behavior if it is used outside of those contexts.
func (c *Client) GetSSHTargets(ctx context.Context, req *proto.GetSSHTargetsRequest) (*proto.GetSSHTargetsResponse, error) {
rsp, err := c.grpc.GetSSHTargets(ctx, req)
return rsp, trace.Wrap(err)
}
// ResolveSSHTarget gets a server that would match an equivalent ssh dial request.
func (c *Client) ResolveSSHTarget(ctx context.Context, req *proto.ResolveSSHTargetRequest) (*proto.ResolveSSHTargetResponse, error) {
rsp, err := c.grpc.ResolveSSHTarget(ctx, req)
return rsp, trace.Wrap(err)
}
// CreateSessionTracker creates a tracker resource for an active session.
func (c *Client) CreateSessionTracker(ctx context.Context, st types.SessionTracker) (types.SessionTracker, error) {
v1, ok := st.(*types.SessionTrackerV1)
if !ok {
return nil, trace.BadParameter("invalid type %T, expected *types.SessionTrackerV1", st)
}
req := &proto.CreateSessionTrackerRequest{SessionTracker: v1}
tracker, err := c.grpc.CreateSessionTracker(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return tracker, nil
}
// GetSessionTracker returns the current state of a session tracker for an active session.
func (c *Client) GetSessionTracker(ctx context.Context, sessionID string) (types.SessionTracker, error) {
req := &proto.GetSessionTrackerRequest{SessionID: sessionID}
resp, err := c.grpc.GetSessionTracker(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GetActiveSessionTrackers returns a list of active session trackers.
func (c *Client) GetActiveSessionTrackers(ctx context.Context) ([]types.SessionTracker, error) {
stream, err := c.grpc.GetActiveSessionTrackers(ctx, &emptypb.Empty{})
if err != nil {
return nil, trace.Wrap(err)
}
var sessions []types.SessionTracker
for {
session, err := stream.Recv()
if err != nil {
if errors.Is(err, io.EOF) {
break
}
return nil, trace.Wrap(err)
}
sessions = append(sessions, session)
}
return sessions, nil
}
// GetActiveSessionTrackersWithFilter returns a list of active sessions filtered by a filter.
func (c *Client) GetActiveSessionTrackersWithFilter(ctx context.Context, filter *types.SessionTrackerFilter) ([]types.SessionTracker, error) {
stream, err := c.grpc.GetActiveSessionTrackersWithFilter(ctx, filter)
if err != nil {
return nil, trace.Wrap(err)
}
var sessions []types.SessionTracker
for {
session, err := stream.Recv()
if err != nil {
if errors.Is(err, io.EOF) {
break
}
return nil, trace.Wrap(err)
}
sessions = append(sessions, session)
}
return sessions, nil
}
// RemoveSessionTracker removes a tracker resource for an active session.
func (c *Client) RemoveSessionTracker(ctx context.Context, sessionID string) error {
_, err := c.grpc.RemoveSessionTracker(ctx, &proto.RemoveSessionTrackerRequest{SessionID: sessionID})
return trace.Wrap(err)
}
// UpdateSessionTracker updates a tracker resource for an active session.
func (c *Client) UpdateSessionTracker(ctx context.Context, req *proto.UpdateSessionTrackerRequest) error {
_, err := c.grpc.UpdateSessionTracker(ctx, req)
return trace.Wrap(err)
}
// MaintainSessionPresence establishes a channel used to continuously verify the presence for a session.
func (c *Client) MaintainSessionPresence(ctx context.Context) (proto.AuthService_MaintainSessionPresenceClient, error) {
stream, err := c.grpc.MaintainSessionPresence(ctx)
return stream, trace.Wrap(err)
}
// GetDomainName returns local auth domain of the current auth server
func (c *Client) GetDomainName(ctx context.Context) (string, error) {
resp, err := c.grpc.GetDomainName(ctx, &emptypb.Empty{})
if err != nil {
return "", trace.Wrap(err)
}
return resp.DomainName, nil
}
// GetClusterCACert returns the PEM-encoded TLS certs for the local cluster. If
// the cluster has multiple TLS certs, they will all be concatenated.
func (c *Client) GetClusterCACert(ctx context.Context) (*proto.GetClusterCACertResponse, error) {
resp, err := c.grpc.GetClusterCACert(ctx, &emptypb.Empty{})
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GetConnectionDiagnostic reads a connection diagnostic
func (c *Client) GetConnectionDiagnostic(ctx context.Context, name string) (types.ConnectionDiagnostic, error) {
req := &proto.GetConnectionDiagnosticRequest{
Name: name,
}
res, err := c.grpc.GetConnectionDiagnostic(ctx, req)
return res, trace.Wrap(err)
}
// CreateConnectionDiagnostic creates a new connection diagnostic.
func (c *Client) CreateConnectionDiagnostic(ctx context.Context, connectionDiagnostic types.ConnectionDiagnostic) error {
connectionDiagnosticV1, ok := connectionDiagnostic.(*types.ConnectionDiagnosticV1)
if !ok {
return trace.BadParameter("invalid type %T", connectionDiagnostic)
}
_, err := c.grpc.CreateConnectionDiagnostic(ctx, connectionDiagnosticV1)
return trace.Wrap(err)
}
// UpdateConnectionDiagnostic updates a connection diagnostic.
func (c *Client) UpdateConnectionDiagnostic(ctx context.Context, connectionDiagnostic types.ConnectionDiagnostic) error {
connectionDiagnosticV1, ok := connectionDiagnostic.(*types.ConnectionDiagnosticV1)
if !ok {
return trace.BadParameter("invalid type %T", connectionDiagnostic)
}
_, err := c.grpc.UpdateConnectionDiagnostic(ctx, connectionDiagnosticV1)
return trace.Wrap(err)
}
// AppendDiagnosticTrace adds a new trace for the given ConnectionDiagnostic.
func (c *Client) AppendDiagnosticTrace(ctx context.Context, name string, t *types.ConnectionDiagnosticTrace) (types.ConnectionDiagnostic, error) {
req := &proto.AppendDiagnosticTraceRequest{
Name: name,
Trace: t,
}
connectionDiagnostic, err := c.grpc.AppendDiagnosticTrace(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return connectionDiagnostic, nil
}
// GetClusterAlerts loads matching cluster alerts.
func (c *Client) GetClusterAlerts(ctx context.Context, query types.GetClusterAlertsRequest) ([]types.ClusterAlert, error) {
rsp, err := c.grpc.GetClusterAlerts(ctx, &query)
if err != nil {
return nil, trace.Wrap(err)
}
return rsp.Alerts, nil
}
// UpsertClusterAlert creates a cluster alert.
func (c *Client) UpsertClusterAlert(ctx context.Context, alert types.ClusterAlert) error {
_, err := c.grpc.UpsertClusterAlert(ctx, &proto.UpsertClusterAlertRequest{
Alert: alert,
})
return trace.Wrap(err)
}
func (c *Client) ChangePassword(ctx context.Context, req *proto.ChangePasswordRequest) error {
_, err := c.grpc.ChangePassword(ctx, req)
return trace.Wrap(err)
}
// SubmitUsageEvent submits an external usage event.
func (c *Client) SubmitUsageEvent(ctx context.Context, req *proto.SubmitUsageEventRequest) error {
_, err := c.grpc.SubmitUsageEvent(ctx, req)
return trace.Wrap(err)
}
// GetLicense returns the license used to start the teleport enterprise auth server
func (c *Client) GetLicense(ctx context.Context) (string, error) {
resp, err := c.grpc.GetLicense(ctx, &proto.GetLicenseRequest{})
if err != nil {
return "", trace.Wrap(err)
}
return string(resp.License), nil
}
// ListReleases returns a list of teleport enterprise releases
func (c *Client) ListReleases(ctx context.Context, req *proto.ListReleasesRequest) ([]*types.Release, error) {
resp, err := c.grpc.ListReleases(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp.Releases, nil
}
// CreateAlertAck marks a cluster alert as acknowledged.
func (c *Client) CreateAlertAck(ctx context.Context, ack types.AlertAcknowledgement) error {
_, err := c.grpc.CreateAlertAck(ctx, &ack)
return trace.Wrap(err)
}
// GetAlertAcks gets active alert acknowledgements.
func (c *Client) GetAlertAcks(ctx context.Context) ([]types.AlertAcknowledgement, error) {
rsp, err := c.grpc.GetAlertAcks(ctx, &proto.GetAlertAcksRequest{})
if err != nil {
return nil, trace.Wrap(err)
}
return rsp.Acks, nil
}
// ClearAlertAcks clears alert acknowledgments.
func (c *Client) ClearAlertAcks(ctx context.Context, req proto.ClearAlertAcksRequest) error {
_, err := c.grpc.ClearAlertAcks(ctx, &req)
return trace.Wrap(err)
}
// ListSAMLIdPServiceProviders returns a paginated list of SAML IdP service provider resources.
func (c *Client) ListSAMLIdPServiceProviders(ctx context.Context, pageSize int, nextKey string) ([]types.SAMLIdPServiceProvider, string, error) {
resp, err := c.grpc.ListSAMLIdPServiceProviders(ctx, &proto.ListSAMLIdPServiceProvidersRequest{
Limit: int32(pageSize),
NextKey: nextKey,
})
if err != nil {
return nil, "", trace.Wrap(err)
}
serviceProviders := make([]types.SAMLIdPServiceProvider, 0, len(resp.GetServiceProviders()))
for _, sp := range resp.GetServiceProviders() {
serviceProviders = append(serviceProviders, sp)
}
return serviceProviders, resp.GetNextKey(), nil
}
// GetSAMLIdPServiceProvider returns the specified SAML IdP service provider resources.
func (c *Client) GetSAMLIdPServiceProvider(ctx context.Context, name string) (types.SAMLIdPServiceProvider, error) {
sp, err := c.grpc.GetSAMLIdPServiceProvider(ctx, &proto.GetSAMLIdPServiceProviderRequest{
Name: name,
})
if err != nil {
return nil, trace.Wrap(err)
}
return sp, nil
}
// CreateSAMLIdPServiceProvider creates a new SAML IdP service provider resource.
func (c *Client) CreateSAMLIdPServiceProvider(ctx context.Context, sp types.SAMLIdPServiceProvider) error {
spV1, ok := sp.(*types.SAMLIdPServiceProviderV1)
if !ok {
return trace.BadParameter("unsupported SAML IdP service provider type %T", sp)
}
_, err := c.grpc.CreateSAMLIdPServiceProvider(ctx, spV1)
if err != nil {
return trace.Wrap(err)
}
return nil
}
// UpdateSAMLIdPServiceProvider updates an existing SAML IdP service provider resource.
func (c *Client) UpdateSAMLIdPServiceProvider(ctx context.Context, sp types.SAMLIdPServiceProvider) error {
spV1, ok := sp.(*types.SAMLIdPServiceProviderV1)
if !ok {
return trace.BadParameter("unsupported SAML IdP service provider type %T", sp)
}
_, err := c.grpc.UpdateSAMLIdPServiceProvider(ctx, spV1)
if err != nil {
return trace.Wrap(err)
}
return nil
}
// DeleteSAMLIdPServiceProvider removes the specified SAML IdP service provider resource.
func (c *Client) DeleteSAMLIdPServiceProvider(ctx context.Context, name string) error {
_, err := c.grpc.DeleteSAMLIdPServiceProvider(ctx, &proto.DeleteSAMLIdPServiceProviderRequest{
Name: name,
})
if err != nil {
return trace.Wrap(err)
}
return nil
}
// DeleteAllSAMLIdPServiceProviders removes all SAML IdP service providers.
func (c *Client) DeleteAllSAMLIdPServiceProviders(ctx context.Context) error {
_, err := c.grpc.DeleteAllSAMLIdPServiceProviders(ctx, &emptypb.Empty{})
if err != nil {
return trace.Wrap(err)
}
return nil
}
// ListUserGroups returns a paginated list of SAML IdP service provider resources.
func (c *Client) ListUserGroups(ctx context.Context, pageSize int, nextKey string) ([]types.UserGroup, string, error) {
resp, err := c.grpc.ListUserGroups(ctx, &proto.ListUserGroupsRequest{
Limit: int32(pageSize),
NextKey: nextKey,
})
if err != nil {
return nil, "", trace.Wrap(err)
}
userGroups := make([]types.UserGroup, 0, len(resp.GetUserGroups()))
for _, ug := range resp.GetUserGroups() {
userGroups = append(userGroups, ug)
}
return userGroups, resp.GetNextKey(), nil
}
// GetUserGroup returns the specified SAML IdP service provider resources.
func (c *Client) GetUserGroup(ctx context.Context, name string) (types.UserGroup, error) {
ug, err := c.grpc.GetUserGroup(ctx, &proto.GetUserGroupRequest{
Name: name,
})
if err != nil {
return nil, trace.Wrap(err)
}
return ug, nil
}
// CreateUserGroup creates a new user group resource.
func (c *Client) CreateUserGroup(ctx context.Context, ug types.UserGroup) error {
ugV1, ok := ug.(*types.UserGroupV1)
if !ok {
return trace.BadParameter("unsupported user group type %T", ug)
}
_, err := c.grpc.CreateUserGroup(ctx, ugV1)
if err != nil {
return trace.Wrap(err)
}
return nil
}
// UpdateUserGroup updates an existing user group resource.
func (c *Client) UpdateUserGroup(ctx context.Context, ug types.UserGroup) error {
ugV1, ok := ug.(*types.UserGroupV1)
if !ok {
return trace.BadParameter("unsupported user group type %T", ug)
}
_, err := c.grpc.UpdateUserGroup(ctx, ugV1)
if err != nil {
return trace.Wrap(err)
}
return nil
}
// DeleteUserGroup removes the specified user group resource.
func (c *Client) DeleteUserGroup(ctx context.Context, name string) error {
_, err := c.grpc.DeleteUserGroup(ctx, &proto.DeleteUserGroupRequest{
Name: name,
})
if err != nil {
return trace.Wrap(err)
}
return nil
}
// DeleteAllUserGroups removes all user groups.
func (c *Client) DeleteAllUserGroups(ctx context.Context) error {
_, err := c.grpc.DeleteAllUserGroups(ctx, &emptypb.Empty{})
if err != nil {
return trace.Wrap(err)
}
return nil
}
// ExportUpgradeWindows is used to load derived upgrade window values for agents that
// need to export schedules to external upgraders.
func (c *Client) ExportUpgradeWindows(ctx context.Context, req proto.ExportUpgradeWindowsRequest) (proto.ExportUpgradeWindowsResponse, error) {
rsp, err := c.grpc.ExportUpgradeWindows(ctx, &req)
if err != nil {
return proto.ExportUpgradeWindowsResponse{}, trace.Wrap(err)
}
return *rsp, nil
}
// GetClusterMaintenanceConfig gets the current maintenance window config singleton.
func (c *Client) GetClusterMaintenanceConfig(ctx context.Context) (types.ClusterMaintenanceConfig, error) {
rsp, err := c.grpc.GetClusterMaintenanceConfig(ctx, &emptypb.Empty{})
if err != nil {
return nil, trace.Wrap(err)
}
return rsp, nil
}
// UpdateClusterMaintenanceConfig updates the current maintenance window config singleton.
func (c *Client) UpdateClusterMaintenanceConfig(ctx context.Context, cmc types.ClusterMaintenanceConfig) error {
req, ok := cmc.(*types.ClusterMaintenanceConfigV1)
if !ok {
return trace.BadParameter("unexpected maintenance config type: %T", cmc)
}
_, err := c.grpc.UpdateClusterMaintenanceConfig(ctx, req)
return trace.Wrap(err)
}
// DeleteClusterMaintenanceConfig deletes the current maintenance window config singleton.
func (c *Client) DeleteClusterMaintenanceConfig(ctx context.Context) error {
_, err := c.grpc.DeleteClusterMaintenanceConfig(ctx, &emptypb.Empty{})
return trace.Wrap(err)
}
// integrationsClient returns an unadorned Integration client, using the underlying
// Auth gRPC connection.
func (c *Client) integrationsClient() integrationpb.IntegrationServiceClient {
return integrationpb.NewIntegrationServiceClient(c.conn)
}
// ListIntegrations returns a paginated list of Integrations.
// The response includes a nextKey which must be used to fetch the next page.
func (c *Client) ListIntegrations(ctx context.Context, pageSize int, nextKey string) ([]types.Integration, string, error) {
resp, err := c.integrationsClient().ListIntegrations(ctx, &integrationpb.ListIntegrationsRequest{
Limit: int32(pageSize),
NextKey: nextKey,
})
if err != nil {
return nil, "", trace.Wrap(err)
}
integrations := make([]types.Integration, 0, len(resp.GetIntegrations()))
for _, ig := range resp.GetIntegrations() {
integrations = append(integrations, ig)
}
return integrations, resp.GetNextKey(), nil
}
// ListAllIntegrations returns the list of all Integrations.
func (c *Client) ListAllIntegrations(ctx context.Context) ([]types.Integration, error) {
var result []types.Integration
var nextKey string
for {
integrations, nextKey, err := c.ListIntegrations(ctx, 0, nextKey)
if err != nil {
return nil, trace.Wrap(err)
}
result = append(result, integrations...)
if nextKey == "" {
return result, nil
}
}
}
// GetIntegration returns an Integration by its name.
func (c *Client) GetIntegration(ctx context.Context, name string) (types.Integration, error) {
ig, err := c.integrationsClient().GetIntegration(ctx, &integrationpb.GetIntegrationRequest{
Name: name,
})
if err != nil {
return nil, trace.Wrap(err)
}
return ig, nil
}
// CreateIntegration creates a new Integration.
func (c *Client) CreateIntegration(ctx context.Context, ig types.Integration) (types.Integration, error) {
igV1, ok := ig.(*types.IntegrationV1)
if !ok {
return nil, trace.BadParameter("unsupported integration type %T", ig)
}
ig, err := c.integrationsClient().CreateIntegration(ctx, &integrationpb.CreateIntegrationRequest{Integration: igV1})
if err != nil {
return nil, trace.Wrap(err)
}
return ig, nil
}
// UpdateIntegration updates an existing Integration.
func (c *Client) UpdateIntegration(ctx context.Context, ig types.Integration) (types.Integration, error) {
igV1, ok := ig.(*types.IntegrationV1)
if !ok {
return nil, trace.BadParameter("unsupported integration type %T", ig)
}
ig, err := c.integrationsClient().UpdateIntegration(ctx, &integrationpb.UpdateIntegrationRequest{Integration: igV1})
if err != nil {
return nil, trace.Wrap(err)
}
return ig, nil
}
// DeleteIntegration removes an Integration by its name.
func (c *Client) DeleteIntegration(ctx context.Context, name string) error {
_, err := c.integrationsClient().DeleteIntegration(ctx, &integrationpb.DeleteIntegrationRequest{
Name: name,
})
return trace.Wrap(err)
}
// DeleteAllIntegrations removes all Integrations.
func (c *Client) DeleteAllIntegrations(ctx context.Context) error {
_, err := c.integrationsClient().DeleteAllIntegrations(ctx, &integrationpb.DeleteAllIntegrationsRequest{})
return trace.Wrap(err)
}
// GenerateAWSOIDCToken generates a token to be used when executing an AWS OIDC Integration action.
func (c *Client) GenerateAWSOIDCToken(ctx context.Context, integration string) (string, error) {
resp, err := c.integrationsClient().GenerateAWSOIDCToken(ctx, &integrationpb.GenerateAWSOIDCTokenRequest{
Integration: integration,
})
if err != nil {
return "", trace.Wrap(err)
}
return resp.GetToken(), nil
}
// GenerateAWSRACredentials generates a set of AWS Credentials using the AWS IAM Roles Anywhere Integration.
func (c *Client) GenerateAWSRACredentials(ctx context.Context, req *integrationpb.GenerateAWSRACredentialsRequest) (*integrationpb.GenerateAWSRACredentialsResponse, error) {
resp, err := c.integrationsClient().GenerateAWSRACredentials(ctx, req)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// GenerateAzureOIDCToken generates a token to be used when executing an Azure OIDC Integration action.
func (c *Client) GenerateAzureOIDCToken(ctx context.Context, integration string) (string, error) {
resp, err := c.integrationsClient().GenerateAzureOIDCToken(ctx, &integrationpb.GenerateAzureOIDCTokenRequest{
Integration: integration,
})
if err != nil {
return "", trace.Wrap(err)
}
return resp.GetToken(), nil
}
// PluginsClient returns an unadorned Plugins client, using the underlying
// Auth gRPC connection.
// Clients connecting to non-Enterprise clusters, or older Teleport versions,
// still get a plugins client when calling this method, but all RPCs will return
// "not implemented" errors (as per the default gRPC behavior).
func (c *Client) PluginsClient() pluginspb.PluginServiceClient {
return pluginspb.NewPluginServiceClient(c.conn)
}
// GetLoginRule retrieves a login rule described by name.
func (c *Client) GetLoginRule(ctx context.Context, name string) (*loginrulepb.LoginRule, error) {
rule, err := c.LoginRuleClient().GetLoginRule(ctx, &loginrulepb.GetLoginRuleRequest{
Name: name,
})
return rule, trace.Wrap(err)
}
// CreateLoginRule creates a login rule if one with the same name does not
// already exist, else it returns an error.
func (c *Client) CreateLoginRule(ctx context.Context, rule *loginrulepb.LoginRule) (*loginrulepb.LoginRule, error) {
rule, err := c.LoginRuleClient().CreateLoginRule(ctx, &loginrulepb.CreateLoginRuleRequest{
LoginRule: rule,
})
return rule, trace.Wrap(err)
}
// UpsertLoginRule creates a login rule if one with the same name does not
// already exist, else it replaces the existing login rule.
func (c *Client) UpsertLoginRule(ctx context.Context, rule *loginrulepb.LoginRule) (*loginrulepb.LoginRule, error) {
rule, err := c.LoginRuleClient().UpsertLoginRule(ctx, &loginrulepb.UpsertLoginRuleRequest{
LoginRule: rule,
})
return rule, trace.Wrap(err)
}
// DeleteLoginRule deletes an existing login rule by name.
func (c *Client) DeleteLoginRule(ctx context.Context, name string) error {
_, err := c.LoginRuleClient().DeleteLoginRule(ctx, &loginrulepb.DeleteLoginRuleRequest{
Name: name,
})
return trace.Wrap(err)
}
// OktaClient returns an Okta client.
// Clients connecting older Teleport versions still get an okta client when
// calling this method, but all RPCs will return "not implemented" errors (as per
// the default gRPC behavior).
func (c *Client) OktaClient() *okta.Client {
return okta.NewClient(oktapb.NewOktaServiceClient(c.conn))
}
func (c *Client) SCIMClient() *scim.Client {
return scim.NewClientFromConn(c.conn)
}
// AccessListClient returns an access list client.
// Clients connecting to older Teleport versions, still get an access list client
// when calling this method, but all RPCs will return "not implemented" errors
// (as per the default gRPC behavior).
func (c *Client) AccessListClient() *accesslist.Client {
return accesslist.NewClient(accesslistv1.NewAccessListServiceClient(c.conn))
}
// AccessMonitoringRulesClient returns an Access Monitoring Rules client.
// Clients connecting to older Teleport versions, still get an access list client
// when calling this method, but all RPCs will return "not implemented" errors
// (as per the default gRPC behavior).
func (c *Client) AccessMonitoringRulesClient() *accessmonitoringrules.Client {
return accessmonitoringrules.NewClient(accessmonitoringrulev1.NewAccessMonitoringRulesServiceClient(c.conn))
}
// DatabaseObjectImportRuleClient returns a client for managing database object import rules.
func (c *Client) DatabaseObjectImportRuleClient() dbobjectimportrulev1.DatabaseObjectImportRuleServiceClient {
return dbobjectimportrulev1.NewDatabaseObjectImportRuleServiceClient(c.conn)
}
// DatabaseObjectClient returns a client for managing database objects.
func (c *Client) DatabaseObjectClient() dbobjectv1.DatabaseObjectServiceClient {
return dbobjectv1.NewDatabaseObjectServiceClient(c.conn)
}
// DiscoveryConfigClient returns a DiscoveryConfig client.
// Clients connecting to older Teleport versions, still get an DiscoveryConfig client
// when calling this method, but all RPCs will return "not implemented" errors
// (as per the default gRPC behavior).
func (c *Client) DiscoveryConfigClient() *discoveryconfig.Client {
return discoveryconfig.NewClient(discoveryconfigv1.NewDiscoveryConfigServiceClient(c.conn))
}
// CrownJewelServiceClient returns a CrownJewel client.
// Clients connecting to older Teleport versions, still get a CrownJewel client
// when calling this method, but all RPCs will return "not implemented" errors
// (as per the default gRPC behavior).
func (c *Client) CrownJewelServiceClient() *crownjewelapi.Client {
return crownjewelapi.NewClient(crownjewelv1.NewCrownJewelServiceClient(c.conn))
}
// UserLoginStateClient returns a user login state client.
// Clients connecting to older Teleport versions, still get a user login state client
// when calling this method, but all RPCs will return "not implemented" errors
// (as per the default gRPC behavior).
func (c *Client) UserLoginStateClient() *userloginstate.Client {
return userloginstate.NewClient(userloginstatev1.NewUserLoginStateServiceClient(c.conn))
}
// UserTasksServiceClient returns a UserTask client.
// Clients connecting to older Teleport versions, still get a UserTask client
// when calling this method, but all RPCs will return "not implemented" errors
// (as per the default gRPC behavior).
func (c *Client) UserTasksServiceClient() *usertaskapi.Client {
return usertaskapi.NewClient(usertaskv1.NewUserTaskServiceClient(c.conn))
}
// GitServerClient returns a client for managing Git servers
func (c *Client) GitServerClient() *gitserverclient.Client {
return gitserverclient.NewClient(gitserverpb.NewGitServerServiceClient(c.conn))
}
// GitServerReadOnlyClient returns the read-only client for Git servers.
func (c *Client) GitServerReadOnlyClient() gitserverclient.ReadOnlyClient {
return c.GitServerClient()
}
// StableUNIXUsersClient returns a client for the stable UNIX users API.
func (c *Client) StableUNIXUsersClient() stableunixusersv1.StableUNIXUsersServiceClient {
return stableunixusersv1.NewStableUNIXUsersServiceClient(c.conn)
}
// GetCertAuthority retrieves a CA by type and domain.
func (c *Client) GetCertAuthority(ctx context.Context, id types.CertAuthID, loadKeys bool) (types.CertAuthority, error) {
ca, err := c.TrustClient().GetCertAuthority(ctx, &trustpb.GetCertAuthorityRequest{
Type: string(id.Type),
Domain: id.DomainName,
IncludeKey: loadKeys,
})
return ca, trace.Wrap(err)
}
// GetCertAuthorities retrieves CAs by type.
func (c *Client) GetCertAuthorities(ctx context.Context, caType types.CertAuthType, loadKeys bool) ([]types.CertAuthority, error) {
resp, err := c.TrustClient().GetCertAuthorities(ctx, &trustpb.GetCertAuthoritiesRequest{
Type: string(caType),
IncludeKey: loadKeys,
})
if err != nil {
return nil, trace.Wrap(err)
}
cas := make([]types.CertAuthority, 0, len(resp.CertAuthoritiesV2))
for _, ca := range resp.CertAuthoritiesV2 {
cas = append(cas, ca)
}
return cas, nil
}
// DeleteCertAuthority removes a CA matching the type and domain.
func (c *Client) DeleteCertAuthority(ctx context.Context, id types.CertAuthID) error {
_, err := c.TrustClient().DeleteCertAuthority(ctx, &trustpb.DeleteCertAuthorityRequest{
Type: string(id.Type),
Domain: id.DomainName,
})
return trace.Wrap(err)
}
// UpsertCertAuthority creates or updates the provided cert authority.
func (c *Client) UpsertCertAuthority(ctx context.Context, ca types.CertAuthority) (types.CertAuthority, error) {
cav2, ok := ca.(*types.CertAuthorityV2)
if !ok {
return nil, trace.BadParameter("unexpected ca type %T", ca)
}
out, err := c.TrustClient().UpsertCertAuthority(ctx, &trustpb.UpsertCertAuthorityRequest{
CertAuthority: cav2,
})
return out, trace.Wrap(err)
}
// RotateCertAuthority updates or inserts new cert authority
func (c *Client) RotateCertAuthority(ctx context.Context, rr types.RotateRequest) error {
req := &trustpb.RotateCertAuthorityRequest{
Type: string(rr.Type),
TargetPhase: rr.TargetPhase,
Mode: rr.Mode,
}
if rr.GracePeriod != nil {
req.GracePeriod = durationpb.New(*rr.GracePeriod)
}
if rr.Schedule != nil {
req.Schedule = &trustpb.RotationSchedule{
UpdateClients: timestamppb.New(rr.Schedule.UpdateClients),
UpdateServers: timestamppb.New(rr.Schedule.UpdateServers),
Standby: timestamppb.New(rr.Schedule.Standby),
}
}
_, err := c.TrustClient().RotateCertAuthority(ctx, req)
return trace.Wrap(err)
}
// RotateExternalCertAuthority rotates the provided cert authority.
func (c *Client) RotateExternalCertAuthority(ctx context.Context, ca types.CertAuthority) error {
cav2, ok := ca.(*types.CertAuthorityV2)
if !ok {
return trace.BadParameter("unexpected ca type %T", ca)
}
_, err := c.TrustClient().RotateExternalCertAuthority(ctx, &trustpb.RotateExternalCertAuthorityRequest{
CertAuthority: cav2,
})
return trace.Wrap(err)
}
// UpdateHeadlessAuthenticationState updates a headless authentication state.
func (c *Client) UpdateHeadlessAuthenticationState(ctx context.Context, id string, state types.HeadlessAuthenticationState, mfaResponse *proto.MFAAuthenticateResponse) error {
_, err := c.grpc.UpdateHeadlessAuthenticationState(ctx, &proto.UpdateHeadlessAuthenticationStateRequest{
Id: id,
State: state,
MfaResponse: mfaResponse,
})
if err != nil {
return trace.Wrap(err)
}
return nil
}
// GetHeadlessAuthentication retrieves a headless authentication by id.
func (c *Client) GetHeadlessAuthentication(ctx context.Context, id string) (*types.HeadlessAuthentication, error) {
headlessAuthn, err := c.grpc.GetHeadlessAuthentication(ctx, &proto.GetHeadlessAuthenticationRequest{
Id: id,
})
if err != nil {
return nil, trace.Wrap(err)
}
return headlessAuthn, nil
}
// WatchPendingHeadlessAuthentications creates a watcher for pending headless authentication for the current user.
func (c *Client) WatchPendingHeadlessAuthentications(ctx context.Context) (types.Watcher, error) {
cancelCtx, cancel := context.WithCancel(ctx)
stream, err := c.grpc.WatchPendingHeadlessAuthentications(cancelCtx, &emptypb.Empty{})
if err != nil {
cancel()
return nil, trace.Wrap(err)
}
w := &streamWatcher{
stream: stream,
ctx: cancelCtx,
cancel: cancel,
eventsC: make(chan types.Event),
}
go w.receiveEvents()
return w, nil
}
// GetUserPreferences returns the user preferences for a given user.
func (c *Client) GetUserPreferences(ctx context.Context, in *userpreferencespb.GetUserPreferencesRequest) (*userpreferencespb.GetUserPreferencesResponse, error) {
resp, err := c.grpc.GetUserPreferences(ctx, in)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// UpsertUserPreferences creates or updates user preferences for a given username.
func (c *Client) UpsertUserPreferences(ctx context.Context, in *userpreferencespb.UpsertUserPreferencesRequest) error {
_, err := c.grpc.UpsertUserPreferences(ctx, in)
if err != nil {
return trace.Wrap(err)
}
return nil
}
// ListNotifications returns a paginated list of notifications for the user.
// This includes global notifications which match the user, as well as user-specific notifications for the user.
func (c *Client) ListNotifications(ctx context.Context, req *notificationsv1pb.ListNotificationsRequest) (*notificationsv1pb.ListNotificationsResponse, error) {
rsp, err := c.NotificationServiceClient().ListNotifications(ctx, req)
return rsp, trace.Wrap(err)
}
// CreateGlobalNotification creates a global notification.
func (c *Client) CreateGlobalNotification(ctx context.Context, req *notificationsv1pb.CreateGlobalNotificationRequest) (*notificationsv1pb.GlobalNotification, error) {
rsp, err := c.NotificationServiceClient().CreateGlobalNotification(ctx, req)
return rsp, trace.Wrap(err)
}
// CreateUserNotification creates a user-specific notification.
func (c *Client) CreateUserNotification(ctx context.Context, req *notificationsv1pb.CreateUserNotificationRequest) (*notificationsv1pb.Notification, error) {
rsp, err := c.NotificationServiceClient().CreateUserNotification(ctx, req)
return rsp, trace.Wrap(err)
}
// DeleteGlobalNotification deletes a global notification.
func (c *Client) DeleteGlobalNotification(ctx context.Context, req *notificationsv1pb.DeleteGlobalNotificationRequest) error {
_, err := c.NotificationServiceClient().DeleteGlobalNotification(ctx, req)
return trace.Wrap(err)
}
// DeleteUserNotification not implemented: can only be called locally.
func (c *Client) DeleteUserNotification(ctx context.Context, req *notificationsv1pb.DeleteUserNotificationRequest) error {
_, err := c.NotificationServiceClient().DeleteUserNotification(ctx, req)
return trace.Wrap(err)
}
// UpsertUserNotificationState creates or updates a user notification state which records whether the user has clicked on or dismissed a notification.
func (c *Client) UpsertUserNotificationState(ctx context.Context, req *notificationsv1pb.UpsertUserNotificationStateRequest) (*notificationsv1pb.UserNotificationState, error) {
rsp, err := c.NotificationServiceClient().UpsertUserNotificationState(ctx, req)
return rsp, trace.Wrap(err)
}
// UpsertUserLastSeenNotification creates or updates a user's last seen notification timestamp.
func (c *Client) UpsertUserLastSeenNotification(ctx context.Context, req *notificationsv1pb.UpsertUserLastSeenNotificationRequest) (*notificationsv1pb.UserLastSeenNotification, error) {
rsp, err := c.NotificationServiceClient().UpsertUserLastSeenNotification(ctx, req)
return rsp, trace.Wrap(err)
}
// GetWorkloadIdentity returns a workload identity by name.
func (c *Client) GetWorkloadIdentity(ctx context.Context, name string) (*workloadidentityv1pb.WorkloadIdentity, error) {
resp, err := c.WorkloadIdentityResourceServiceClient().GetWorkloadIdentity(ctx, &workloadidentityv1pb.GetWorkloadIdentityRequest{
Name: name,
})
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// DeleteWorkloadIdentity deletes a workload identity by name. It will throw an
// error if the workload identity does not exist.
func (c *Client) DeleteWorkloadIdentity(ctx context.Context, name string) error {
_, err := c.WorkloadIdentityResourceServiceClient().DeleteWorkloadIdentity(ctx, &workloadidentityv1pb.DeleteWorkloadIdentityRequest{
Name: name,
})
if err != nil {
return trace.Wrap(err)
}
return nil
}
// CreateWorkloadIdentity creates a new workload identity, it will not overwrite
// an existing workload identity with the same name.
func (c *Client) CreateWorkloadIdentity(ctx context.Context, r *workloadidentityv1pb.WorkloadIdentity) (*workloadidentityv1pb.WorkloadIdentity, error) {
resp, err := c.WorkloadIdentityResourceServiceClient().CreateWorkloadIdentity(ctx, &workloadidentityv1pb.CreateWorkloadIdentityRequest{
WorkloadIdentity: r,
})
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// UpsertWorkloadIdentity creates or updates a workload identity.
func (c *Client) UpsertWorkloadIdentity(ctx context.Context, r *workloadidentityv1pb.WorkloadIdentity) (*workloadidentityv1pb.WorkloadIdentity, error) {
resp, err := c.WorkloadIdentityResourceServiceClient().UpsertWorkloadIdentity(ctx, &workloadidentityv1pb.UpsertWorkloadIdentityRequest{
WorkloadIdentity: r,
})
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}
// ResourceUsageClient returns an unadorned Resource Usage service client,
// using the underlying Auth gRPC connection.
// Clients connecting to non-Enterprise clusters, or older Teleport versions,
// still get a plugins client when calling this method, but all RPCs will return
// "not implemented" errors (as per the default gRPC behavior).
func (c *Client) ResourceUsageClient() resourceusagepb.ResourceUsageServiceClient {
return resourceusagepb.NewResourceUsageServiceClient(c.conn)
}
// UpdateRemoteCluster updates remote cluster from the specified value.
func (c *Client) UpdateRemoteCluster(ctx context.Context, rc types.RemoteCluster) (types.RemoteCluster, error) {
rcV3, ok := rc.(*types.RemoteClusterV3)
if !ok {
return nil, trace.BadParameter("unsupported remote cluster type %T", rcV3)
}
res, err := c.PresenceServiceClient().UpdateRemoteCluster(ctx, &presencepb.UpdateRemoteClusterRequest{
RemoteCluster: rcV3,
})
return res, trace.Wrap(err)
}
// ListRemoteClusters returns a page of remote clusters.
func (c *Client) ListRemoteClusters(ctx context.Context, pageSize int, nextToken string) ([]types.RemoteCluster, string, error) {
res, err := c.PresenceServiceClient().ListRemoteClusters(ctx, &presencepb.ListRemoteClustersRequest{
PageSize: int32(pageSize),
PageToken: nextToken,
})
if err != nil {
return nil, "", trace.Wrap(err)
}
rcs := make([]types.RemoteCluster, 0, len(res.RemoteClusters))
for _, rc := range res.RemoteClusters {
rcs = append(rcs, rc)
}
return rcs, res.NextPageToken, nil
}
// DeleteRemoteCluster creates remote cluster resource
func (c *Client) DeleteRemoteCluster(ctx context.Context, name string) error {
_, err := c.PresenceServiceClient().DeleteRemoteCluster(ctx, &presencepb.DeleteRemoteClusterRequest{
Name: name,
})
return trace.Wrap(err)
}
// GetRemoteCluster returns remote cluster by name
func (c *Client) GetRemoteCluster(ctx context.Context, name string) (types.RemoteCluster, error) {
rc, err := c.PresenceServiceClient().GetRemoteCluster(ctx, &presencepb.GetRemoteClusterRequest{
Name: name,
})
return rc, trace.Wrap(err)
}
// ListReverseTunnels returns a page of remote clusters.
func (c *Client) ListReverseTunnels(ctx context.Context, pageSize int, nextToken string) ([]types.ReverseTunnel, string, error) {
res, err := c.PresenceServiceClient().ListReverseTunnels(ctx, &presencepb.ListReverseTunnelsRequest{
PageSize: int32(pageSize),
PageToken: nextToken,
})
if err != nil {
return nil, "", trace.Wrap(err)
}
rcs := make([]types.ReverseTunnel, 0, len(res.ReverseTunnels))
for _, rc := range res.ReverseTunnels {
rcs = append(rcs, rc)
}
return rcs, res.NextPageToken, nil
}
// DeleteReverseTunnel deletes a reverse tunnel resource
func (c *Client) DeleteReverseTunnel(ctx context.Context, name string) error {
_, err := c.PresenceServiceClient().DeleteReverseTunnel(ctx, &presencepb.DeleteReverseTunnelRequest{
Name: name,
})
return trace.Wrap(err)
}
// UpsertReverseTunnel creates or updates reverse tunnel resource
func (c *Client) UpsertReverseTunnel(ctx context.Context, rt types.ReverseTunnel) (types.ReverseTunnel, error) {
rtV3, ok := rt.(*types.ReverseTunnelV2)
if !ok {
return nil, trace.BadParameter("unsupported reverse tunnel type %T", rt)
}
res, err := c.PresenceServiceClient().UpsertReverseTunnel(ctx, &presencepb.UpsertReverseTunnelRequest{
ReverseTunnel: rtV3,
})
if err != nil {
return nil, trace.Wrap(err)
}
return res, nil
}
// GetRemoteClusters returns all remote clusters.
// Deprecated: use ListRemoteClusters instead.
func (c *Client) GetRemoteClusters(ctx context.Context) ([]types.RemoteCluster, error) {
var rcs []types.RemoteCluster
pageToken := ""
for {
page, nextToken, err := c.ListRemoteClusters(ctx, 0, pageToken)
if err != nil {
return nil, trace.Wrap(err)
}
rcs = append(rcs, page...)
if nextToken == "" {
return rcs, nil
}
pageToken = nextToken
}
}
// IntegrationsClient returns integrations client.
func (c *Client) IntegrationsClient() integrationpb.IntegrationServiceClient {
return c.integrationsClient()
}
// DecisionClient returns an unadorned DecisionService client using the
// underlying Auth gRPC connection.
func (c *Client) DecisionClient() decisionpb.DecisionServiceClient {
return decisionpb.NewDecisionServiceClient(c.conn)
}
// GetClusterName returns the name of the cluster.
func (c *Client) GetClusterName(ctx context.Context) (types.ClusterName, error) {
cn, err := c.ClusterConfigClient().GetClusterName(ctx, &clusterconfigpb.GetClusterNameRequest{})
if err != nil {
return nil, trace.Wrap(err)
}
return cn, nil
}
// HealthCheckConfigClient returns an
// [healthcheckconfigv1.HealthCheckConfigServiceClient].
func (c *Client) HealthCheckConfigClient() healthcheckconfigv1.HealthCheckConfigServiceClient {
return healthcheckconfigv1.NewHealthCheckConfigServiceClient(c.conn)
}
// GetHealthCheckConfig fetches a health check config by name.
func (c *Client) GetHealthCheckConfig(ctx context.Context, name string) (*healthcheckconfigv1.HealthCheckConfig, error) {
cc := c.HealthCheckConfigClient()
resp, err := cc.GetHealthCheckConfig(ctx,
&healthcheckconfigv1.GetHealthCheckConfigRequest{
Name: name,
},
)
return resp, trace.Wrap(err)
}
// ListHealthCheckConfigs lists health check configs with pagination.
func (c *Client) ListHealthCheckConfigs(ctx context.Context, limit int, startKey string) ([]*healthcheckconfigv1.HealthCheckConfig, string, error) {
cc := c.HealthCheckConfigClient()
resp, err := cc.ListHealthCheckConfigs(ctx,
&healthcheckconfigv1.ListHealthCheckConfigsRequest{
PageSize: int32(limit),
PageToken: startKey,
},
)
return resp.GetConfigs(), resp.GetNextPageToken(), trace.Wrap(err)
}
// CreateHealthCheckConfig creates a new health check config.
func (c *Client) CreateHealthCheckConfig(ctx context.Context, in *healthcheckconfigv1.HealthCheckConfig) (*healthcheckconfigv1.HealthCheckConfig, error) {
cc := c.HealthCheckConfigClient()
resp, err := cc.CreateHealthCheckConfig(ctx,
&healthcheckconfigv1.CreateHealthCheckConfigRequest{
Config: in,
},
)
return resp, trace.Wrap(err)
}
// UpdateHealthCheckConfig updates an existing health check config.
func (c *Client) UpdateHealthCheckConfig(ctx context.Context, in *healthcheckconfigv1.HealthCheckConfig) (*healthcheckconfigv1.HealthCheckConfig, error) {
cc := c.HealthCheckConfigClient()
resp, err := cc.UpdateHealthCheckConfig(ctx,
&healthcheckconfigv1.UpdateHealthCheckConfigRequest{
Config: in,
},
)
return resp, trace.Wrap(err)
}
// UpsertHealthCheckConfig creates or updates a health check config.
func (c *Client) UpsertHealthCheckConfig(ctx context.Context, in *healthcheckconfigv1.HealthCheckConfig) (*healthcheckconfigv1.HealthCheckConfig, error) {
cc := c.HealthCheckConfigClient()
resp, err := cc.UpsertHealthCheckConfig(ctx,
&healthcheckconfigv1.UpsertHealthCheckConfigRequest{
Config: in,
},
)
return resp, trace.Wrap(err)
}
// DeleteHealthCheckConfig deletes a health check config.
func (c *Client) DeleteHealthCheckConfig(ctx context.Context, name string) error {
cc := c.HealthCheckConfigClient()
_, err := cc.DeleteHealthCheckConfig(ctx,
&healthcheckconfigv1.DeleteHealthCheckConfigRequest{
Name: name,
},
)
return trace.Wrap(err)
}
// ValidateTrustedCluster is called by the proxy on behalf of a cluster that
// wishes to join this one as a leaf cluster.
func (c *Client) ValidateTrustedCluster(
ctx context.Context, validateRequest *proto.ValidateTrustedClusterRequest,
) (*proto.ValidateTrustedClusterResponse, error) {
resp, err := c.grpc.ValidateTrustedCluster(ctx, validateRequest)
if err != nil {
return nil, trace.Wrap(err)
}
return resp, nil
}