flytekit.clients.auth_helper

Class	Description
`AuthenticationHTTPAdapter`	A custom HTTPAdapter that adds authentication headers to requests of a session.
`RemoteClientConfigStore`	This class implements the ClientConfigStore that is served by the Flyte Server, that implements AuthMetadataService.

Method	Description
`bootstrap_creds_from_server()`	Retrieves the SSL cert from the remote and uses that.
`get_authenticated_channel()`	Returns a new channel for the given config that is authenticated.
`get_authenticator()`	Returns a new authenticator based on the platform config.
`get_channel()`	Creates a new grpc.
`get_proxy_authenticator()`
`get_session()`	Return a new session for the given platform config.
`upgrade_channel_to_authenticated()`	Given a grpc.
`upgrade_channel_to_proxy_authenticated()`	If activated in the platform config, given a grpc.
`upgrade_session_to_proxy_authenticated()`	Given a requests.
`wrap_exceptions_channel()`	Wraps the input channel with RetryExceptionWrapperInterceptor.

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

Parameter	Type	Description
`endpoint`	`str`

get_authenticated_channel()

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

Returns a new channel for the given config that is authenticated

Parameter	Type	Description
`cfg`	`flytekit.configuration.PlatformConfig`

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.

Parameter	Type	Description
`cfg`	`flytekit.configuration.PlatformConfig`
`cfg_store`	`flytekit.clients.auth.authenticator.ClientConfigStore`

get_channel()

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

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(...))

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

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

Create secure channel with custom grpc.ssl_channel_credentials

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

Parameter	Type	Description
`cfg`	`flytekit.configuration.PlatformConfig`	PlatformConfig
`kwargs`	`**kwargs`	Optional arguments to be passed to channel method. Refer to usage example above :return: grpc.Channel (secure / insecure)

get_proxy_authenticator()

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

Parameter	Type	Description
`cfg`	`flytekit.configuration.PlatformConfig`

get_session()

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

Return a new session for the given platform config.

Parameter	Type	Description
`cfg`	`flytekit.configuration.PlatformConfig`
`kwargs`	`**kwargs`

upgrade_channel_to_authenticated()

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

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

Parameter	Type	Description
`cfg`	`flytekit.configuration.PlatformConfig`	PlatformConfig
`in_channel`	`grpc.Channel`	grpc.Channel Precreated channel :return: grpc.Channel. New composite channel

upgrade_channel_to_proxy_authenticated()

        
    
def upgrade_channel_to_proxy_authenticated(
    cfg: flytekit.configuration.PlatformConfig,
    in_channel: grpc.Channel,
) -> grpc.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

Parameter	Type	Description
`cfg`	`flytekit.configuration.PlatformConfig`	PlatformConfig
`in_channel`	`grpc.Channel`	grpc.Channel Precreated channel :return: grpc.Channel. New composite channel

upgrade_session_to_proxy_authenticated()

        
    
def upgrade_session_to_proxy_authenticated(
    cfg: flytekit.configuration.PlatformConfig,
    session: requests.sessions.Session,
) -> requests.sessions.Session

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

Parameter	Type	Description
`cfg`	`flytekit.configuration.PlatformConfig`	PlatformConfig
`session`	`requests.sessions.Session`	requests.Session Precreated session :return: requests.Session. New session with custom HTTPAdapter mounted

wrap_exceptions_channel()

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

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

This channel should be usually the outermost channel. This channel will raise a FlyteException

Parameter	Type	Description
`cfg`	`flytekit.configuration.PlatformConfig`	PlatformConfig
`in_channel`	`grpc.Channel`	grpc.Channel :return: grpc.Channel

flytekit.clients.auth_helper.AuthenticationHTTPAdapter

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

        
    
class AuthenticationHTTPAdapter(
    authenticator,
    args,
    kwargs,
)

Parameter	Type	Description
`authenticator`
`args`	`*args`
`kwargs`	`**kwargs`

Methods

Method	Description
`add_auth_header()`	Adds authentication headers to the request.
`add_headers()`	Add any headers needed by the connection.
`build_connection_pool_key_attributes()`	Build the PoolKey attributes used by urllib3 to return a connection.
`build_response()`	Builds a :class:`Response <requests.
`cert_verify()`	Verify a SSL certificate.
`close()`	Disposes of any internal state.
`get_connection()`	DEPRECATED: Users should move to `get_connection_with_tls_context`.
`get_connection_with_tls_context()`	Returns a urllib3 connection for the given request and TLS settings.
`init_poolmanager()`	Initializes a urllib3 PoolManager.
`proxy_headers()`	Returns a dictionary of the headers to add to any request sent.
`proxy_manager_for()`	Return urllib3 ProxyManager for the given proxy.
`request_url()`	Obtain the url to use when making the final request.
`send()`	Sends the request with added authentication headers.

add_auth_header()

        
    
def add_auth_header(
    request,
)

Adds authentication headers to the request.

Parameter	Type	Description
`request`		The request object to add headers to.

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>.

Parameter	Type	Description
`request`		The
`kwargs`	`**kwargs`	The keyword arguments from the call to send().

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_cert_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.

Parameter	Type	Description
`request`		The PreparedReqest being sent over the connection. :type request: :class:`~requests.models.PreparedRequest`
`verify`		Either a boolean, in which case it controls whether we verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use.
`cert`		Any user-provided SSL certificate for client authentication (a.k.a., mTLS). This may be a string (i.e., just the path to a file which holds both certificate and key) or a tuple of length 2 with the certificate file path and key file path. :returns: A tuple of two dictionaries. The first is the “host parameters” portion of the Pool Key including scheme, hostname, and port. The second is a dictionary of SSLContext related parameters.

build_response()

        
    
def build_response(
    req,
    resp,
)

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>

Parameter	Type	Description
`req`		The
`resp`		The urllib3 response object. :rtype: requests.Response

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>.

Parameter	Type	Description
`conn`		The urllib3 connection object associated with the cert.
`url`		The requested URL.
`verify`		Either a boolean, in which case it controls whether we verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use
`cert`		The SSL certificate to verify.

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,
)

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>.

Parameter	Type	Description
`url`		The URL to connect to.
`proxies`		A Requests-style dictionary of proxies used on this request. :rtype: urllib3.ConnectionPool

get_connection_with_tls_context()

        
    
def get_connection_with_tls_context(
    request,
    verify,
    proxies,
    cert,
)

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>.

Parameter	Type	Description
`request`		The :class:`PreparedRequest <PreparedRequest>` object to be sent over the connection.
`verify`		Either a boolean, in which case it controls whether we verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use.
`proxies`		The proxies dictionary to apply to the request.
`cert`		Any user-provided SSL certificate to be used for client authentication (a.k.a., mTLS). :rtype: urllib3.ConnectionPool

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>.

Parameter	Type	Description
`connections`		The number of urllib3 connection pools to cache.
`maxsize`		The maximum number of connections to save in the pool.
`block`		Block when no free connections are available.
`pool_kwargs`		Extra keyword arguments used to initialize the Pool Manager.

proxy_headers()

        
    
def proxy_headers(
    proxy,
)

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>.

Parameter	Type	Description
`proxy`		The url of the proxy being used for this request. :rtype: dict

proxy_manager_for()

        
    
def proxy_manager_for(
    proxy,
    proxy_kwargs,
)

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>.

Parameter	Type	Description
`proxy`		The proxy to return a urllib3 ProxyManager for.
`proxy_kwargs`		Extra keyword arguments used to configure the Proxy Manager. :returns: ProxyManager :rtype: urllib3.ProxyManager

request_url()

        
    
def request_url(
    request,
    proxies,
)

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>.

Parameter	Type	Description
`request`		The
`proxies`		A dictionary of schemes or schemes and hosts to proxy URLs. :rtype: str

send()

        
    
def send(
    request,
    args,
    kwargs,
)

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

Parameter	Type	Description
`request`		The request object to send. :return: The response object.
`args`	`*args`
`kwargs`	`**kwargs`

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,
)

Parameter	Type	Description
`secure_channel`	`grpc.Channel`

Methods

Method	Description
`get_client_config()`	Retrieves the ClientConfig from the given grpc.

get_client_config()

def get_client_config()

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

On this page

flytekit.clients.auth_helper

Directory

Classes

Methods

Methods

bootstrap_creds_from_server()

get_authenticated_channel()

get_authenticator()

get_channel()

get_proxy_authenticator()

get_session()

upgrade_channel_to_authenticated()

upgrade_channel_to_proxy_authenticated()

upgrade_session_to_proxy_authenticated()

wrap_exceptions_channel()

flytekit.clients.auth_helper.AuthenticationHTTPAdapter

Methods

add_auth_header()

add_headers()

build_connection_pool_key_attributes()

build_response()

cert_verify()

close()

get_connection()

get_connection_with_tls_context()

init_poolmanager()

proxy_headers()

proxy_manager_for()

request_url()

send()

flytekit.clients.auth_helper.RemoteClientConfigStore

Methods

get_client_config()