Files
teleport/lib/cloud/imds.go
T
2023-12-01 17:48:14 +00:00

133 lines
4.0 KiB
Go

/*
* Teleport
* Copyright (C) 2023 Gravitational, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package cloud
import (
"context"
"time"
"github.com/gravitational/trace"
"github.com/gravitational/teleport/api/types"
"github.com/gravitational/teleport/lib/cloud/aws"
"github.com/gravitational/teleport/lib/cloud/azure"
)
const (
// discoverInstanceMetadataTimeout is the maximum amount of time allowed
// to discover an instance metadata service. The timeout is short to
// minimize Teleport's startup time when it isn't running on any cloud
// instance. Checking for instance metadata typically takes less than 30ms.
discoverInstanceMetadataTimeout = 500 * time.Millisecond
)
// InstanceMetadata is an interface for fetching information from a cloud
// service's instance metadata.
type InstanceMetadata interface {
// IsAvailable checks if instance metadata is available.
IsAvailable(ctx context.Context) bool
// GetTags gets all of the instance's tags.
GetTags(ctx context.Context) (map[string]string, error)
// GetHostname gets the hostname set by the cloud instance that Teleport
// should use, if any.
GetHostname(ctx context.Context) (string, error)
// GetType gets the cloud instance type.
GetType() types.InstanceMetadataType
// GetID gets the cloud instance ID.
GetID(ctx context.Context) (string, error)
}
type imConstructor func(ctx context.Context) (InstanceMetadata, error)
var providers = map[types.InstanceMetadataType]imConstructor{
types.InstanceMetadataTypeEC2: initEC2,
types.InstanceMetadataTypeAzure: initAzure,
}
func initEC2(ctx context.Context) (InstanceMetadata, error) {
im, err := aws.NewInstanceMetadataClient(ctx)
return im, trace.Wrap(err)
}
func initAzure(ctx context.Context) (InstanceMetadata, error) {
return azure.NewInstanceMetadataClient(), nil
}
// DiscoverInstanceMetadata checks which cloud instance type Teleport is
// running on, if any.
func DiscoverInstanceMetadata(ctx context.Context) (InstanceMetadata, error) {
ctx, cancel := context.WithTimeout(ctx, discoverInstanceMetadataTimeout)
defer cancel()
c := make(chan InstanceMetadata)
clients := make([]InstanceMetadata, 0, len(providers))
for _, constructor := range providers {
im, err := constructor(ctx)
if err != nil {
return nil, trace.Wrap(err)
}
clients = append(clients, im)
}
for _, client := range clients {
client := client
go func() {
if client.IsAvailable(ctx) {
c <- client
}
}()
}
select {
case client := <-c:
return client, nil
case <-ctx.Done():
return nil, trace.NotFound("no instance metadata service found")
}
}
// DisabledIMDSClient is an EC2 instance metadata client that is always disabled. This is faster
// than the default client when not testing instance metadata behavior.
type DisabledIMDSClient struct{}
// NewDisabledIMDSClient creates a new DisabledIMDSClient.
func NewDisabledIMDSClient() InstanceMetadata {
return &DisabledIMDSClient{}
}
func (d *DisabledIMDSClient) IsAvailable(ctx context.Context) bool {
return false
}
func (d *DisabledIMDSClient) GetTags(ctx context.Context) (map[string]string, error) {
return nil, nil
}
func (d *DisabledIMDSClient) GetHostname(ctx context.Context) (string, error) {
return "", nil
}
func (d *DisabledIMDSClient) GetType() types.InstanceMetadataType {
return types.InstanceMetadataTypeDisabled
}
func (d *DisabledIMDSClient) GetID(ctx context.Context) (string, error) {
return "", nil
}