v1.0.0
Version 1.0.0 - SSOv2 / PKCE
First and foremost, keep in mind that using SSO v2 is a permanent move. If you want to keep using SSO v1, consider using only EsiPy 0.5.x
Warnings
- From this version EsiPy will only use SSOv2 (JWT). If you don't want to migrate to JWT tokens, you should keep using version 0.5.x, as migration to the new SSO is a permanent move.
- JWT tokens are really bigger than SSOv1 token, so keep this in mind when migrating if you store these tokens in databases.
Breaking Changes
- The following parameters have been removed from
EsiSecurity.__init__():app,esi_url,sso_url,esi_datasource. EsiSecurity.__init__()does not construct URLs from either given URL or swagger spec, but makes a request to SSO endpoint discovery.EsiSecurity.__get_token_auth_header()has been removed.EsiSecurity.verify()now uses JWT library python-jose to get informations of the token instead of querying ESI/verifyendpoint.EsiSecurity.verify()may raise exceptions if a token does not validate or if it is expired.
Changes
EsiSecurity.__init__()has a new optional parametersso_endpoints_urlto provide the SSO discovery URL (which is different for Tranquility, Singularity and Serenity)EsiSecurity.__init__()has a new optional parametersso_endpointswhich can be used to give the content (cached by the user) of the SSO discovery URL. This will preventEsiSecurityfrom making a request.EsiSecurity.__init__()has a new optional parameterjwks_keywhich can be used to give the content (cached by the user) of the JSON Web Key Set (JWKS). This will preventEsiSecurityfrom making a request.EsiSecurity.__init__()has a new optional parametercode_verifierwhich can be used for PKCE flow.EsiSecurity.refresh()now acceptscope_listparameter, a list of scope to only refresh a subset of scope for the token. (None by default to refresh everything)- New utils functions have been added in the
esipy.utilsmodule:generate_code_verifier(length)to generate a code verifier for the PKCE flow that will respect the RFC requirements.generate_code_challenge(code_verifier)to generate the code_challenge to be used in the PKCE flow (used inEsiSecurity)
About PKCE
- If a secret key is provided, EsiSecurity will never use PKCE.
- If you want to use PKCE, you need to follow the 2 requirements while instanciating your
EsiSecurityobject:secret_keymust be ignored or set toNonecode_verifiermust be provided and must follow the RFC 7636 format
For a PKCE example, you can check the doc here