flytekit.clients.auth_helper

Directory

Classes

Methods

Methods

bootstrap_creds_from_server()

def bootstrap_creds_from_server(
    endpoint: str,
) -> grpc.ChannelCredentials

Retrieves the SSL cert from the remote and uses that. should be used only if insecure-skip-verify

get_authenticated_channel()

def get_authenticated_channel(
    cfg: flytekit.configuration.PlatformConfig,
) -> grpc.Channel

Returns a new channel for the given config that is authenticated

get_authenticator()

def get_authenticator(
    cfg: flytekit.configuration.PlatformConfig,
    cfg_store: flytekit.clients.auth.authenticator.ClientConfigStore,
) -> flytekit.clients.auth.authenticator.Authenticator

Returns a new authenticator based on the platform config.

get_channel()

def get_channel(
    cfg: flytekit.configuration.PlatformConfig,
    kwargs,
) -> n: grpc.Channel (secure / insecure)

Creates a new grpc.Channel given a platformConfig. It is possible to pass additional options to the underlying channel. Examples for various options are as below

    get_channel(cfg=PlatformConfig(...))

   :caption: Additional options to insecure / secure channel. Example `options` and `compression` refer to grpc guide

    get_channel(cfg=PlatformConfig(...), options=..., compression=...)

:caption: Create secure channel with custom grpc.ssl_channel_credentials

get_channel(cfg=PlatformConfig(insecure=False,...), credentials=...)

get_proxy_authenticator()

def get_proxy_authenticator(
    cfg: flytekit.configuration.PlatformConfig,
) -> flytekit.clients.auth.authenticator.Authenticator

get_session()

def get_session(
    cfg: flytekit.configuration.PlatformConfig,
    kwargs,
) -> requests.sessions.Session

Return a new session for the given platform config.

upgrade_channel_to_authenticated()

def upgrade_channel_to_authenticated(
    cfg: flytekit.configuration.PlatformConfig,
    in_channel: grpc.Channel,
) -> n: grpc.Channel. New composite channel

Given a grpc.Channel, preferably a secure channel, it returns a composed channel that uses Interceptor to perform an Oauth2.0 Auth flow

upgrade_channel_to_proxy_authenticated()

def upgrade_channel_to_proxy_authenticated(
    cfg: flytekit.configuration.PlatformConfig,
    in_channel: grpc.Channel,
) -> n: grpc.Channel. New composite channel

If activated in the platform config, given a grpc.Channel, preferably a secure channel, it returns a composed channel that uses Interceptor to perform authentication with a proxy in front of Flyte

upgrade_session_to_proxy_authenticated()

def upgrade_session_to_proxy_authenticated(
    cfg: flytekit.configuration.PlatformConfig,
    session: requests.sessions.Session,
) -> n: requests.Session. New session with custom HTTPAdapter mounted

Given a requests.Session, it returns a new session that uses a custom HTTPAdapter to perform authentication with a proxy in front of Flyte

wrap_exceptions_channel()

def wrap_exceptions_channel(
    cfg: flytekit.configuration.PlatformConfig,
    in_channel: grpc.Channel,
) -> n: grpc.Channel

Wraps the input channel with RetryExceptionWrapperInterceptor. This wrapper will cover all exceptions and raise Exception from the Family flytekit.exceptions

flytekit.clients.auth_helper.AuthenticationHTTPAdapter

A custom HTTPAdapter that adds authentication headers to requests of a session.

class AuthenticationHTTPAdapter(
    authenticator,
    args,
    kwargs,
)

Methods

add_auth_header()

def add_auth_header(
    request,
)

Adds authentication headers to the request.

add_headers()

def add_headers(
    request,
    kwargs,
)

Add any headers needed by the connection. As of v2.0 this does nothing by default, but is left for overriding by users that subclass the :class:HTTPAdapter <requests.adapters.HTTPAdapter>.

This should not be called from user code, and is only exposed for use when subclassing the :class:HTTPAdapter <requests.adapters.HTTPAdapter>.

build_connection_pool_key_attributes()

def build_connection_pool_key_attributes(
    request,
    verify,
    cert,
)

Build the PoolKey attributes used by urllib3 to return a connection.

This looks at the PreparedRequest, the user-specified verify value, and the value of the cert parameter to determine what PoolKey values to use to select a connection from a given urllib3 Connection Pool.

The SSL related pool key arguments are not consistently set. As of this writing, use the following to determine what keys may be in that dictionary:

• If verify is True, "ssl_context" will be set and will be the default Requests SSL Context
• If verify is False, "ssl_context" will not be set but "cert_reqs" will be set
• If verify is a string, (i.e., it is a user-specified trust bundle) "ca_certs" will be set if the string is not a directory recognized by :py:func:os.path.isdir, otherwise "ca_certs_dir" will be set.
• If "cert" is specified, "cert_file" will always be set. If "cert" is a tuple with a second item, "key_file" will also be present

To override these settings, one may subclass this class, call this method and use the above logic to change parameters as desired. For example, if one wishes to use a custom :py:class:ssl.SSLContext one must both set "ssl_context" and based on what else they require, alter the other keys to ensure the desired behaviour.

build_response()

def build_response(
    req,
    resp,
) -> e: requests.Response

Builds a :class:Response <requests.Response> object from a urllib3 response. This should not be called from user code, and is only exposed for use when subclassing the :class:HTTPAdapter <requests.adapters.HTTPAdapter>

cert_verify()

def cert_verify(
    conn,
    url,
    verify,
    cert,
)

Verify a SSL certificate. This method should not be called from user code, and is only exposed for use when subclassing the :class:HTTPAdapter <requests.adapters.HTTPAdapter>.

close()

def close()

Disposes of any internal state.

Currently, this closes the PoolManager and any active ProxyManager, which closes any pooled connections.

get_connection()

def get_connection(
    url,
    proxies,
) -> e: urllib3.ConnectionPool

DEPRECATED: Users should move to get_connection_with_tls_context for all subclasses of HTTPAdapter using Requests>=2.32.2.

Returns a urllib3 connection for the given URL. This should not be called from user code, and is only exposed for use when subclassing the :class:HTTPAdapter <requests.adapters.HTTPAdapter>.

get_connection_with_tls_context()

def get_connection_with_tls_context(
    request,
    verify,
    proxies,
    cert,
) -> e:

Returns a urllib3 connection for the given request and TLS settings. This should not be called from user code, and is only exposed for use when subclassing the :class:HTTPAdapter <requests.adapters.HTTPAdapter>.

init_poolmanager()

def init_poolmanager(
    connections,
    maxsize,
    block,
    pool_kwargs,
)

Initializes a urllib3 PoolManager.

This method should not be called from user code, and is only exposed for use when subclassing the :class:HTTPAdapter <requests.adapters.HTTPAdapter>.

proxy_headers()

def proxy_headers(
    proxy,
) -> e: dict

Returns a dictionary of the headers to add to any request sent through a proxy. This works with urllib3 magic to ensure that they are correctly sent to the proxy, rather than in a tunnelled request if CONNECT is being used.

This should not be called from user code, and is only exposed for use when subclassing the :class:HTTPAdapter <requests.adapters.HTTPAdapter>.

proxy_manager_for()

def proxy_manager_for(
    proxy,
    proxy_kwargs,
) -> e: urllib3.ProxyManager

Return urllib3 ProxyManager for the given proxy.

This method should not be called from user code, and is only exposed for use when subclassing the :class:HTTPAdapter <requests.adapters.HTTPAdapter>.

request_url()

def request_url(
    request,
    proxies,
) -> e: str

Obtain the url to use when making the final request.

If the message is being sent through a HTTP proxy, the full URL has to be used. Otherwise, we should only use the path portion of the URL.

This should not be called from user code, and is only exposed for use when subclassing the :class:HTTPAdapter <requests.adapters.HTTPAdapter>.

send()

def send(
    request,
    args,
    kwargs,
) -> n: The response object.

Sends the request with added authentication headers. If the response returns a 401 status code, refreshes the credentials and retries the request.

flytekit.clients.auth_helper.RemoteClientConfigStore

This class implements the ClientConfigStore that is served by the Flyte Server, that implements AuthMetadataService

class RemoteClientConfigStore(
    secure_channel: grpc.Channel,
)

Methods

get_client_config()

def get_client_config()

Retrieves the ClientConfig from the given grpc.Channel assuming AuthMetadataService is available