Provider¶

class gafaelfawr.providers.base.Provider¶

Bases: object

Abstract base class for authentication providers.

Methods Summary

`create_session`(code, state)	Given the code from a successful authentication, create a session.
`get_redirect_url`(state)	Get the login URL to which to redirect the user.

Methods Documentation

create_session(code: str, state: str) → Session¶

Given the code from a successful authentication, create a session.

Parameters:	code (`str`) – Code returned by a successful authentication. state (`str`) – The same random string used for the redirect URL.
Returns:	session – The new authentication session.
Return type:	`gafaelfawr.session.Session`
Raises:	`aiohttp.ClientResponseError` – An HTTP client error occurred trying to talk to the authentication provider. `ProviderException` – The provider responded with an error to a request.

get_redirect_url(state: str) → str¶

Get the login URL to which to redirect the user.

Parameters:	state (`str`) – A random string used for CSRF protection.
Returns:	url – The encoded URL to which to redirect the user.
Return type:	`str`