package
0.0.0-20250306163500-5f3bb2705e1f
Repository: https://github.com/versoriumx/teleport.git
Documentation: pkg.go.dev

# Packages

Package app connections to applications over a reverse tunnel and forwards HTTP requests to them.
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

# Functions

CheckResourceUpsert checks if the resource can be created or updated, depending on the http method.
ConstructSSHResponse creates a special SSH response for SSH login method that encodes everything using the client's secret key.
CreateResource is a helper function for POST requests from the UI to create a new resource.
ExtractResourceAndValidate extracts resource information from given string and validates basic fields.
NewHandler returns a new instance of web proxy handler.
NewServer constructs a [Server] from the provided [ServerConfig].
No description provided by the author
NewTerminal creates a web-based terminal based on WebSockets and returns a new TerminalHandler.
NewTerminalStream creates a stream that manages reading and writing data over the provided [websocket.Conn].
No description provided by the author
NewXForwardedForMiddleware is an HTTP middleware that overwrites client source address if X-Forwarded-For is set.
OK is a response that indicates request was successful.
ParseSSORequestParams extracts the SSO request parameters from an http.Request, returning them in an SSORequestParams struct.
RedirectURLWithError adds an err query parameter to the given redirect URL with the given errReply message and returns the new URL.
SetClock sets the clock on a handler.
SetSessionStreamPollPeriod sets polling period for session streams.
SSOSetWebSessionAndRedirectURL validates the CSRF token in the response against that in the request, validates that the callback URL in the response can be parsed, and sets a session cookie with the username and session name from the response.
UpdateResource is a helper function for PUT requests from the UI to update an existing resource.

# Constants

No description provided by the author
OIDCJWKWURI is the relative path where the OIDC IdP JWKS is located.
SNISuffix is the server name suffix used during SNI to specify the target desktop to connect to.
SSOLoginFailureMessage is a generic error message to avoid disclosing sensitive SSO failure messages.

# Variables

No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
AssistUserPreferencesResponse is the JSON response for the assist user preferences.
AuthParams are used to construct redirect URL containing auth information back to tsh login.
ClusterUserPreferencesResponse is the JSON response for the user's cluster preferences.
CommandHandlerConfig is the configuration for the command handler.
CommandRequest is a request to execute a command on all nodes that match the query.
Config represents web handler configuration parameters.
No description provided by the author
No description provided by the author
CreateSessionReq is a request to create session from username, password and second factor token.
CreateSessionResponse returns OAuth compabible data about access token: https://tools.ietf.org/html/rfc6749.
Envelope is used to wrap and transend and receive messages between the web client and proxy.
No description provided by the author
Handler is HTTP web proxy handler.
No description provided by the author
No description provided by the author
Server serves the web api.
ServerConfig provides dependencies required to create a [Server].
SessionContext is a context associated with a user's web session.
No description provided by the author
SSHSessionLatencyStats contain latency measurements for both legs of an ssh connection established via the Web UI.
SSOCallbackResponse holds the parameters for validating and executing an SSO callback URL.
SSORequestParams holds parameters parsed out of a HTTP request initiating an SSO login.
TerminalHandler connects together an SSH session with a web-based terminal via a web socket.
TerminalHandlerConfig contains the configuration options necessary to correctly set up the TerminalHandler.
TerminalRequest describes a request to create a web-based terminal to a remote SSH server.
TerminalStream manages the [websocket.Conn] to the web UI for a terminal session.
No description provided by the author
UserPreferencesResponse is the JSON response for the user preferences.
No description provided by the author
WSStream handles web socket communication with the frontend.

# Interfaces

AuthProvider is a subset of the full Auth API.
ClusterClientProvider is an interface for a type which can provide authenticated clients to remote clusters.
SessionController restricts creation of sessions based on cluster session control configuration(locks, connection limits, etc).
WSConn is a gorilla/websocket minimal interface used by our web implementation.

# Type aliases

ClusterClientHandler is an authenticated handler which can get a client for any remote cluster.
ClusterHandler is a authenticated handler that is called for some existing remote cluster.
ConnectionHandler defines a function for serving incoming connections.
ContextHandler is a handler called with the auth context, what means it is authenticated and ready to work.
No description provided by the author
No description provided by the author
HandlerOption is a functional argument - an option that can be passed to NewHandler function.
PresenceChecker is a function that executes an mfa prompt to enforce that a user is present.
ProvisionTokenHandler is a authenticated handler that is called for some existing Token.
No description provided by the author
SessionControllerFunc type is an adapter to allow the use of ordinary functions a [SessionController].
WSHandlerFunc specifies a handler that processes received a specific [Envelope] received via a web socket.