https://github.com/os-climate/sostrades-authapi
This is the repo for the SoSTrades Authentication API.
https://github.com/os-climate/sostrades-authapi
Last synced: 5 months ago
JSON representation
This is the repo for the SoSTrades Authentication API.
- Host: GitHub
- URL: https://github.com/os-climate/sostrades-authapi
- Owner: os-climate
- License: apache-2.0
- Created: 2022-01-12T21:09:43.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2024-06-26T09:03:08.000Z (11 months ago)
- Last Synced: 2024-11-07T17:12:34.472Z (7 months ago)
- Language: Python
- Homepage:
- Size: 24.4 KB
- Stars: 3
- Watchers: 5
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SoStrades authAPI
This is the repo for the SoSTrades Authentication API.
##How it works
When a user logs in SoSTrades Application, if the CORP SSO authentication succeeded, it redirects to this SoSTrades Authentication server.
The SoSTrades Authentication server drives CORP SSO request to the SoSTrades API server.
The SoSTrades API server manages user authentication then responds to the SoSTrades Authentication API with access information.
The SoSTrades Authentication API, then, redirects the browser to the SoSTrades Application.
The authentication protocol used in SoSTrades is SAML v2.
## Packages installation
### Online (no vpn) install
pip install -r requirements.txt --trusted-host pypi.org --trusted-host files.pythonhosted.org
## Configuration
- set the SAML v2 'settings.json' file for the SSO authentication (the file must have this name 'settings.json')
A template of this file is located in the 'sostrades_authapi\configuration_template\saml' folder.
All explanations on how to fill it are accessible here: https://github.com/onelogin/python3-saml.
- in the '.env' file, set the environment variable SAML_V2_METADATA_FOLDER with the folder path where the settings.json is
- in the '.env' file, set the environment variable INTERNAL_SSL_CERTIFICATE with the certificate file path.
This certificate is used to send a request to the SoSTrades API server via SSL verification.
- in the '.flaskenv' file, set the path to the sostrades_authapi\server.py file in the variable FLASK_APP
## API Start
If you want to run the authAPI locally:
python \sostrades_authapi\sostrades_authapi.py
## License
The sostrades-authapi source code is distributed under the Apache License Version 2.0.
A copy of it can be found in the LICENSE file.
The sostrades-authapi product depends on other software which have various licenses.
The list of dependencies with their licenses is given in the CREDITS.rst file.