Lab Orchestrator Lib Auth
This package contains the lab orchestrator library authentication module.
Installation
pip3 install lab-orchestrator-lib-auth
Documentation
Check out the developer documentation at laborchestratorlib-auth.readthedocs.io.
Usage
The library contains one module called auth that contains 3 methods and one dataclass.
The first method generate_auth_token is used to generate a JWT token. The token contains the user id, and some information about the lab instance for which this token is created. That also contains a list of vmi_names the user should be allowed to connect to. HS256 is used as algorithm which is a symmetric algorithm, so you need to use the same secret for both: encryption and decryption of the key.
The next method decode_auth_token decodes the previously encoded JWT token. It returns the information that is contained in the token.
The third method verify_auth_token contains the parameter vmi_name and checks if this vmi_name is allowed. If it's not allowed the method will return none.
See more at: laborchestratorlib-auth.readthedocs.io.
Examples
There is one example that shows how to create a token with the library. For other examples you need to look into the LabOrchestratorLib or WebsocketProxy.
Contributing
Issues
Feel free to open issues.
Project Structure
The src folder contains the source code of the library. The tests folder contains the test cases. examples contains some example scripts of how to use the library. There is a makefile that contains some shortcuts for example to run the test cases and to make a release. Run make help to see all targets. The docs folder contains rst docs that are used in read the docs.
Developer Dependencies
- Python 3.8
- Make
pip install -r requirements.txtpip install -r requirements-dev.txt
Releases
Your part:
- Create branch for your feature (
issue/ISSUE_ID-SHORT_DESCRIPTION) - Code
- Make sure test cases are running and add new ones for your feature
- Create MR into master
- Increase version number in
src/lab_orchestrator_lib_auth/__init__.py(semantic versioning)
Admin part:
- Check and accept MR
- Merge MR
- Run
make release
Docs
To generate the docs run: cd docs && make html.
1 maintainer
Metadata
1 maintainer
Release files for lab-orchestrator-lib-auth 2.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| lab-orchestrator-lib-auth-2.2.0.tar.gz | 10.3 kB | Without provenance | Details for lab-orchestrator-lib-auth-2.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| lab_orchestrator_lib_auth-2.2.0-py3-none-any.whl | Python 3 | none | any | Details for lab_orchestrator_lib_auth-2.2.0-py3-none-any.whl |
Total release size: 20.5 kB
Release files / lab-orchestrator-lib-auth-2.2.0.tar.gz
| Download URL | lab-orchestrator-lib-auth-2.2.0.tar.gz |
|---|---|
| Size | 10.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9824ee86435c358d88c8669d095a908f16ec4aa32728bc7b8f98483d07a78aad
|
|
BLAKE2b-256 checksum How to use checksums |
00576b9e942aafe6eeb450f32475856ad8dbaa3aa12f86998983ce84a51438e2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.5.0.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.10
|
Release files / lab_orchestrator_lib_auth-2.2.0-py3-none-any.whl
| Download URL | lab_orchestrator_lib_auth-2.2.0-py3-none-any.whl |
|---|---|
| Size | 10.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6e11dd64b9d2ca8572e46c193731010e5271a203944ad2486de483094b4232cf
|
|
BLAKE2b-256 checksum How to use checksums |
63e8862aa5f4f35f5459455be5d02b233b9f93311adbd1fff27122e3eac16f54
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.5.0.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.10
|
Security for lab-orchestrator-lib-auth 2.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
