Versions in this module Expand all Collapse all v11 v11.3.3 Dec 13, 2022 Changes in this version + const AppsIdentityEvent + const AppsReady + const AuthIdentityEvent + const AuthTLSReady + const DatabasesIdentityEvent + const DatabasesReady + const DebugAppReady + const DiscoveryIdentityEvent + const DiscoveryReady + const InstanceIdentityEvent + const InstanceReady + const KubeIdentityEvent + const KubernetesReady + const MetricsReady + const NodeSSHReady + const ProxyAgentPoolReady + const ProxyIdentityEvent + const ProxyReverseTunnelReady + const ProxySSHReady + const ProxyWebServerReady + const SSHIdentityEvent + const ServiceExitedWithErrorEvent + const TeleportDegradedEvent + const TeleportExitEvent + const TeleportOKEvent + const TeleportPhaseChangeEvent + const TeleportReadyEvent + const TeleportReloadEvent + const TracingReady + const WindowsDesktopIdentityEvent + const WindowsDesktopReady + var AllTLSModes = []TLSMode + var ErrTeleportExited = &trace.CompareFailedError + var ErrTeleportReloading = &trace.CompareFailedError + var ListenerAuth = ListenerType(teleport.ComponentAuth) + var ListenerDiagnostic = ListenerType(teleport.ComponentDiagnostic) + var ListenerKube = ListenerType(teleport.ComponentKube) + var ListenerMetrics = ListenerType(teleport.ComponentMetrics) + var ListenerNodeSSH = ListenerType(teleport.ComponentNode) + var ListenerProxyKube = ListenerType(teleport.Component(teleport.ComponentProxy, "kube")) + var ListenerProxyMongo = ListenerType(teleport.Component(teleport.ComponentProxy, "mongo")) + var ListenerProxyMySQL = ListenerType(teleport.Component(teleport.ComponentProxy, "mysql")) + var ListenerProxyPeer = ListenerType(teleport.Component(teleport.ComponentProxy, "peer")) + var ListenerProxyPostgres = ListenerType(teleport.Component(teleport.ComponentProxy, "postgres")) + var ListenerProxySSH = ListenerType(teleport.Component(teleport.ComponentProxy, "ssh")) + var ListenerProxyTunnel = ListenerType(teleport.Component(teleport.ComponentProxy, "tunnel")) + var ListenerProxyTunnelAndWeb = ListenerType(teleport.Component(teleport.ComponentProxy, "tunnel", "web")) + var ListenerProxyWeb = ListenerType(teleport.Component(teleport.ComponentProxy, "web")) + var ListenerWindowsDesktop = ListenerType(teleport.ComponentWindowsDesktop) + func ApplyDefaults(cfg *Config) + func ApplyFIPSDefaults(cfg *Config) + func Run(ctx context.Context, cfg Config, newTeleport NewProcess) error + type ACME struct + Email string + Enabled bool + URI string + type App struct + AWS *AppAWS + Description string + DynamicLabels services.CommandLabels + InsecureSkipVerify bool + Name string + PublicAddr string + Rewrite *Rewrite + StaticLabels map[string]string + URI string + func (a *App) CheckAndSetDefaults() error + type AppAWS struct + ExternalID string + type AppsConfig struct + Apps []App + DebugApp bool + Enabled bool + MonitorCloseChannel chan struct{} + ResourceMatchers []services.ResourceMatcher + type AuthConfig struct + AuditConfig types.ClusterAuditConfig + Authorities []types.CertAuthority + ClusterName types.ClusterName + EnableProxyProtocol bool + Enabled bool + KeyStore keystore.Config + LicenseFile string + Limiter limiter.Config + ListenAddr utils.NetAddr + LoadAllCAs bool + NetworkingConfig types.ClusterNetworkingConfig + NoAudit bool + Preference types.AuthPreference + PublicAddrs []utils.NetAddr + Resources []types.Resource + Roles []types.Role + SessionRecordingConfig types.SessionRecordingConfig + StaticTokens types.StaticTokens + StorageConfig backend.Config + type CachePolicy struct + Enabled bool + func (c *CachePolicy) CheckAndSetDefaults() error + func (c CachePolicy) String() string + type Config struct + Access services.Access + AdvertiseIP string + Apps AppsConfig + Auth AuthConfig + BPFConfig *bpf.Config + CAPins []string + CachePolicy CachePolicy + CipherSuites []uint16 + Ciphers []string + CircuitBreakerConfig breaker.Config + ClientTimeout time.Duration + Clock clockwork.Clock + ClusterConfiguration services.ClusterConfiguration + ConnectFailureC chan time.Duration + Console io.Writer + DataDir string + Databases DatabasesConfig + Debug bool + DiagnosticAddr utils.NetAddr + Discovery DiscoveryConfig + Events types.Events + FIPS bool + FileDescriptors []FileDescriptor + HostUUID string + Hostname string + Identities []*auth.Identity + Identity services.Identity + JoinMethod types.JoinMethod + KEXAlgorithms []string + Keygen sshca.Authority + Kube KubeConfig + Log utils.Logger + MACAlgorithms []string + MaxRetryPeriod time.Duration + Metrics MetricsConfig + OIDCConnectors []types.OIDCConnector + PIDFile string + PluginRegistry plugin.Registry + PollingPeriod time.Duration + Presence services.Presence + Provisioner services.Provisioner + Proxy ProxyConfig + ProxyServer utils.NetAddr + ReverseTunnels []types.ReverseTunnel + RotationConnectionInterval time.Duration + SSH SSHConfig + ShutdownTimeout time.Duration + SkipVersionCheck bool + TeleportHome string + TeleportVersion string + Tracing TracingConfig + Trust services.Trust + UploadEventsC chan events.UploadEvent + UsageReporter services.UsageReporter + Version string + WindowsDesktop WindowsDesktopConfig + func MakeDefaultConfig() (config *Config) + func (cfg *Config) ApplyCAPins(caPins []string) error + func (cfg *Config) AuthServerAddresses() []utils.NetAddr + func (cfg *Config) DebugDumpToYAML() string + func (cfg *Config) HasToken() bool + func (cfg *Config) RoleConfig() RoleConfig + func (cfg *Config) SetAuthServerAddress(addr utils.NetAddr) + func (cfg *Config) SetAuthServerAddresses(addrs []utils.NetAddr) error + func (cfg *Config) SetToken(token string) + func (cfg *Config) Token() (string, error) + type Connector struct + Client *auth.Client + ClientIdentity *auth.Identity + ServerIdentity *auth.Identity + func (c *Connector) Close() error + func (c *Connector) TunnelProxyResolver() reversetunnel.Resolver + func (c *Connector) UseTunnel() bool + type Database struct + AD DatabaseAD + AWS DatabaseAWS + Azure DatabaseAzure + Description string + DynamicLabels services.CommandLabels + GCP DatabaseGCP + MySQL MySQLOptions + Name string + Protocol string + StaticLabels map[string]string + TLS DatabaseTLS + URI string + func (d *Database) CheckAndSetDefaults() error + func (d *Database) ToDatabase() (types.Database, error) + type DatabaseAD struct + Domain string + KeytabFile string + Krb5File string + SPN string + func (d *DatabaseAD) CheckAndSetDefaults(name string) error + func (d *DatabaseAD) IsEmpty() bool + type DatabaseAWS struct + AccountID string + ElastiCache DatabaseAWSElastiCache + MemoryDB DatabaseAWSMemoryDB + RDS DatabaseAWSRDS + Redshift DatabaseAWSRedshift + Region string + SecretStore DatabaseAWSSecretStore + type DatabaseAWSElastiCache struct + ReplicationGroupID string + type DatabaseAWSMemoryDB struct + ClusterName string + type DatabaseAWSRDS struct + ClusterID string + InstanceID string + type DatabaseAWSRedshift struct + ClusterID string + type DatabaseAWSSecretStore struct + KMSKeyID string + KeyPrefix string + type DatabaseAzure struct + ResourceID string + type DatabaseGCP struct + InstanceID string + ProjectID string + type DatabaseTLS struct + CACert []byte + Mode TLSMode + ServerName string + type DatabasesConfig struct + AWSMatchers []services.AWSMatcher + AzureMatchers []services.AzureMatcher + Databases []Database + Enabled bool + Limiter limiter.Config + ResourceMatchers []services.ResourceMatcher + type DiscoveryConfig struct + AWSMatchers []services.AWSMatcher + AzureMatchers []services.AzureMatcher + Enabled bool + GCPMatchers []services.GCPMatcher + func (d DiscoveryConfig) IsEmpty() bool + type Event struct + Name string + Payload interface{} + func (e *Event) String() string + type EventMapping struct + In []string + Out string + func (e EventMapping) String() string + type ExitEventPayload struct + Error error + Service Service + type FileDescriptor struct + Address string + File *os.File + Type string + func (fd *FileDescriptor) ToListener() (net.Listener, error) + type Func func() error + type Header struct + Name string + Value string + func ParseHeader(header string) (*Header, error) + func ParseHeaders(headers []string) (headersOut []Header, err error) + type HostLabelRule struct + Labels map[string]string + Regexp *regexp.Regexp + type HostLabelRules struct + func NewHostLabelRules(rules ...HostLabelRule) HostLabelRules + func (h HostLabelRules) LabelsForHost(host string) map[string]string + type KeyPair struct + PrivateKey []byte + PublicSSHKey []byte + PublicTLSKey []byte + type KeyPairPath struct + Certificate string + PrivateKey string + type KubeConfig struct + CheckImpersonationPermissions proxy.ImpersonationPermissionsChecker + DynamicLabels services.CommandLabels + Enabled bool + KubeClusterName string + KubeconfigPath string + Limiter limiter.Config + ListenAddr *utils.NetAddr + PublicAddrs []utils.NetAddr + ResourceMatchers []services.ResourceMatcher + StaticLabels map[string]string + type KubeProxyConfig struct + ClusterOverride string + Enabled bool + KubeconfigPath string + LegacyKubeProxy bool + ListenAddr utils.NetAddr + PublicAddrs []utils.NetAddr + type LDAPConfig struct + Addr string + CA *x509.Certificate + Domain string + InsecureSkipVerify bool + ServerName string + Username string + type LDAPDiscoveryConfig struct + BaseDN string + Filters []string + LabelAttributes []string + type ListenerType string + type LocalService struct + Critical bool + Function Func + ServiceName string + func (l *LocalService) IsCritical() bool + func (l *LocalService) Name() string + func (l *LocalService) Serve() error + func (l *LocalService) String() string + type LocalSupervisor struct + func (s *LocalSupervisor) BroadcastEvent(event Event) + func (s *LocalSupervisor) ExitContext() context.Context + func (s *LocalSupervisor) GracefulExitContext() context.Context + func (s *LocalSupervisor) ListenForEvents(ctx context.Context, name string, eventC chan<- Event) + func (s *LocalSupervisor) Register(srv Service) + func (s *LocalSupervisor) RegisterCriticalFunc(name string, fn Func) + func (s *LocalSupervisor) RegisterEventMapping(m EventMapping) + func (s *LocalSupervisor) RegisterFunc(name string, fn Func) + func (s *LocalSupervisor) ReloadContext() context.Context + func (s *LocalSupervisor) RemoveService(srv Service) error + func (s *LocalSupervisor) Run() error + func (s *LocalSupervisor) ServiceCount() int + func (s *LocalSupervisor) Services() []string + func (s *LocalSupervisor) Start() error + func (s *LocalSupervisor) Wait() error + func (s *LocalSupervisor) WaitForEvent(ctx context.Context, name string) (Event, error) + func (s *LocalSupervisor) WaitForEventTimeout(timeout time.Duration, name string) (Event, error) + type MetricsConfig struct + CACerts []string + Enabled bool + GRPCClientLatency bool + GRPCServerLatency bool + KeyPairs []KeyPairPath + ListenAddr *utils.NetAddr + MTLS bool + type MySQLOptions struct + ServerVersion string + type NewProcess func(cfg *Config) (Process, error) + type NewTeleportOption func(*newTeleportConfig) + func WithIMDSClient(client cloud.InstanceMetadata) NewTeleportOption + type Process interface + ExportFileDescriptors func() ([]FileDescriptor, error) + Shutdown func(context.Context) + Start func() error + WaitForEvent func(ctx context.Context, name string) (Event, error) + WaitForSignals func(context.Context) error + WaitWithContext func(ctx context.Context) + type ProxyConfig struct + ACME ACME + DisableALPNSNIListener bool + DisableDatabaseProxy bool + DisableReverseTunnel bool + DisableTLS bool + DisableWebInterface bool + DisableWebService bool + EnableProxyProtocol bool + Enabled bool + KeyPairs []KeyPairPath + Kube KubeProxyConfig + Limiter limiter.Config + MongoAddr utils.NetAddr + MongoPublicAddrs []utils.NetAddr + MySQLAddr utils.NetAddr + MySQLPublicAddrs []utils.NetAddr + PeerAddr utils.NetAddr + PeerPublicAddr utils.NetAddr + PostgresAddr utils.NetAddr + PostgresPublicAddrs []utils.NetAddr + PublicAddrs []utils.NetAddr + ReverseTunnelListenAddr utils.NetAddr + SSHAddr utils.NetAddr + SSHPublicAddrs []utils.NetAddr + TunnelPublicAddrs []utils.NetAddr + WebAddr utils.NetAddr + func (c ProxyConfig) KubeAddr() (string, error) + type Rate struct + Amount int + Time time.Duration + type Rewrite struct + Headers []Header + Redirect []string + type RoleConfig struct + Auth AuthConfig + AuthServers []utils.NetAddr + Console io.Writer + DataDir string + HostName string + HostUUID string + type SSHConfig struct + Addr utils.NetAddr + AllowFileCopying bool + AllowTCPForwarding bool + BPF *bpf.Config + CmdLabels services.CommandLabels + DisableCreateHostUser bool + Enabled bool + IdleTimeoutMessage string + Labels map[string]string + Limiter limiter.Config + Namespace string + PAM *pam.Config + PermitUserEnvironment bool + PublicAddrs []utils.NetAddr + RestrictedSession *restricted.Config + Shell string + X11 *x11.ServerConfig + type Service interface + IsCritical func() bool + Name func() string + Serve func() error + String func() string + type Supervisor interface + BroadcastEvent func(Event) + ExitContext func() context.Context + GracefulExitContext func() context.Context + ListenForEvents func(ctx context.Context, name string, eventC chan<- Event) + Register func(srv Service) + RegisterCriticalFunc func(name string, fn Func) + RegisterEventMapping func(EventMapping) + RegisterFunc func(name string, fn Func) + ReloadContext func() context.Context + Run func() error + ServiceCount func() int + Services func() []string + Start func() error + Wait func() error + WaitForEvent func(ctx context.Context, name string) (Event, error) + WaitForEventTimeout func(timeout time.Duration, name string) (Event, error) + func NewSupervisor(id string, parentLog logrus.FieldLogger) Supervisor + type TLSMode string + const Insecure + const VerifyCA + const VerifyFull + func (m *TLSMode) CheckAndSetDefaults() error + func (m TLSMode) ToProto() types.DatabaseTLSMode + type TeleportProcess struct + Clock clockwork.Clock + Config *Config + Identities map[types.SystemRole]*auth.Identity + PluginRegistry plugin.Registry + TracingProvider *tracing.Provider + func NewTeleport(cfg *Config, opts ...NewTeleportOption) (*TeleportProcess, error) + func (process *TeleportProcess) AuthAddr() (*utils.NetAddr, error) + func (process *TeleportProcess) Close() error + func (process *TeleportProcess) DiagnosticAddr() (*utils.NetAddr, error) + func (process *TeleportProcess) ExportFileDescriptors() ([]FileDescriptor, error) + func (process *TeleportProcess) GetAuditLog() events.IAuditLog + func (process *TeleportProcess) GetAuthServer() *auth.Server + func (process *TeleportProcess) GetBackend() backend.Backend + func (process *TeleportProcess) GetIdentity(role types.SystemRole) (i *auth.Identity, err error) + func (process *TeleportProcess) NodeSSHAddr() (*utils.NetAddr, error) + func (process *TeleportProcess) OnExit(serviceName string, callback func(interface{})) + func (process *TeleportProcess) ProxyKubeAddr() (*utils.NetAddr, error) + func (process *TeleportProcess) ProxyPeerAddr() (*utils.NetAddr, error) + func (process *TeleportProcess) ProxySSHAddr() (*utils.NetAddr, error) + func (process *TeleportProcess) ProxyTunnelAddr() (*utils.NetAddr, error) + func (process *TeleportProcess) ProxyWebAddr() (*utils.NetAddr, error) + func (process *TeleportProcess) Shutdown(ctx context.Context) + func (process *TeleportProcess) StartShutdown(ctx context.Context) context.Context + func (process *TeleportProcess) WaitForSignals(ctx context.Context) error + func (process *TeleportProcess) WaitWithContext(ctx context.Context) + type TracingConfig struct + CACerts []string + Enabled bool + ExporterURL string + KeyPairs []KeyPairPath + SamplingRate float64 + func (t TracingConfig) Config(attrs ...attribute.KeyValue) (*tracing.Config, error) + type WindowsDesktopConfig struct + ConnLimiter limiter.Config + Discovery LDAPDiscoveryConfig + Enabled bool + HostLabels HostLabelRules + Hosts []utils.NetAddr + LDAP LDAPConfig + Labels map[string]string + ListenAddr utils.NetAddr + PublicAddrs []utils.NetAddr Other modules containing this package github.com/zmb3/teleport
Go to main page