package
18.0.0-dev.vnet-windows.4+incompatible
Repository: https://github.com/gravitational/teleport.git
Documentation: pkg.go.dev
# Packages
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Package packetcapture provides utilities for saving application-layer packets to file in either plain text or PCAP formats.
No description provided by the author
No description provided by the author
# Functions
CheckEngines checks if provided engine names are registered.
ConvertConnectError converts common connection errors to trace errors with extra information/recommendations if necessary.
ConvertError converts errors to trace errors.
GetConnectionSetupTimeObserver returns a callback that will observe connection setup time metric.
GetEngine returns a new engine for the provided configuration.
GetEngineErrorsMetric increments the synthetic errors sent by an engine to a client.
GetMessagesFromClientMetric increments the messages from client metric.
GetMessagesFromServerMetric increments the messages from server metric.
MakeDatabaseMetadata returns common database metadata for database session.
MakeEventMetadata returns common event metadata for database session.
MakeServerMetadata returns common server metadata for database session.
MakeSessionMetadata returns common session metadata for database session.
MakeTestClientTLSCert returns TLS certificate suitable for configuring test database Postgres/MySQL clients.
MakeTestClientTLSConfig returns TLS config suitable for configuring test database Postgres/MySQL clients.
MakeTestServerTLSConfig returns TLS config suitable for configuring test database Postgres/MySQL servers.
MakeUserMetadata returns common user metadata for database session.
NewAudit returns a new instance of the audit events emitter.
NewAuth returns a new instance of database access authenticator.
NewAuthForSession returns a copy of Auth with session-specific logging.
RegisterEngine registers a new engine constructor.
WithUserAgent set client user agent.
# Constants
DefaultMongoDBServerSelectionTimeout is the timeout for selecting a MongoDB server to connect to.
MaxPages is the maximum number of pages to iterate over when fetching cloud databases.
SQLStateActiveUser is the SQLSTATE raised by deactivation procedure when user has active connections.
SQLStatePermissionsChanged is the SQLSTATE raised by permissions update procedure when the user has active connections for current database but permissions have changed.
SQLStateRolesChanged is the SQLSTATE raised by activation procedure when the user has active connections but roles have changed.
SQLStateUserDeactivated is the SQLSTATE returned by the delete procedure indicating was deactivated.
SQLStateUserDropped is the SQLSTATE returned by the delete procedure indicating the user was dropped.
SQLStateUsernameDoesNotMatch is the SQLSTATE raised by activation procedure when the Teleport username does not match user's attributes.
# Structs
AuditConfig is the audit events emitter configuration.
AuthConfig is the database access authenticator configuration.
ConnectParams keeps parameters used when connecting to Service.
EngineConfig is the common configuration every database engine uses.
ProxyContext contains parameters for a database session being proxied.
Query combines database query parameters.
Result represents a query or command result.
Session combines parameters for a database connection session.
TestClientConfig combines parameters for a test Postgres/MySQL client.
TestServerConfig combines parameters for a test Postgres/MySQL server.
UserProvisioner handles automatic database user creation.
# Interfaces
AccessPoint is an interface that defines a subset of authclient.DatabaseAccessPoint that are required for database auth.
Audit defines an interface for database access audit events logger.
Auth defines interface for creating auth tokens and TLS configurations.
AuthClient is an interface that defines a subset of libauth.Client's functions that are required for database auth.
AuthClientCA contains the required methods to Generate mTLS certificate to be used by the postgres TestServer.
AutoUsers defines an interface for automatic user provisioning a particular database engine should implement.
Engine defines an interface for specific database protocol engine such as Postgres or MySQL.
Proxy defines an interface a database proxy should implement.
Service defines an interface for connecting to a remote database service.
Users defines an interface for managing database users.
# Type aliases
ClientOption represents a database client config option.
EngineFn defines a database engine constructor function.