DigDeo Syspass Client
Project description
digdeo-syspass-client
Python API Client for SysPass server (https://www.syspass.org/en)
Implemented API
Both 100% Cover and 100% UnitTested
Cool but what i need to use it ?
The API Client require settings like the server and token ;) It have many ways to inject that setting, via config file and/or by ENV vars.
Permanent configuration::
That is suppose to be the default setting , where a file config.yml
is store in user space.
That standard is describe on FreeDedktop web site. https://specifications.freedesktop.org/basedir-spec/basedir-spec-0.6.html
Then by follow recommendation and standard we use $HOME/.config/digdeo-syspass-client/
as default directory for search config.yml
file.
You can change the $XDG_CONFIG_HOME/digdeo-syspass-client/config.yml
search by set a ENV var DD_SYSPASS_CLIENT_CONFIG_DIR then
$HOME/.config/digdeo-syspass-client/config.yml
will become $DD_SYSPASS_CLIENT_CONFIG_DIR/config.yml
For more information's take a look on FreeDesktop XDG recommendation.
Config file
You can use any type of key here, in our usage that is a Read Only key.
syspassclient:
api_url: 'https://you.server.exemple.com/api.php'
api_version: '3.1'
authToken: '######################################################'
tokenPass: '######################################################'
verify_ssl: True
debug: False
debug_level: 0
verbose: False
verbose_level: 0
Variables
- DD_SYSPASS_CLIENT_CONFIG_DIR
- DD_SYSPASS_CLIENT_AUTH_TOKEN
- DD_SYSPASS_CLIENT_TOKEN_PASS
- DD_SYSPASS_CLIENT_VERIFY_SSL
- DD_SYSPASS_CLIENT_API_URL
- DD_SYSPASS_CLIENT_API_VERSION
- DD_SYSPASS_CLIENT_DEBUG
- DD_SYSPASS_CLIENT_DEBUG_LEVEL
- DD_SYSPASS_CLIENT_VERBOSE
- DD_SYSPASS_CLIENT_VERBOSE_LEVEL
DD_SYSPASS_CLIENT_CONFIG_DIR
Shortcut the $HOME/.config/digdeo-syspass-client
default path by the value of the variable
DD_SYSPASS_CLIENT_AUTH_TOKEN
Shortcut the authToken
set inside the config.yml
DD_SYSPASS_CLIENT_VERIFY_SSL
If it variable is set then, SSL certificates will be verify.
Note that is Python Requests module it deal with SSL certificate , if you take a look of it module documentation, you'll be inform about how deal with self signed certificates. In summary, Requests module use REQUESTS_CA_BUNDLE env variable, for get the SSL Bundle certificate file path of you system.
Example:
export REQUESTS_CA_BUNDLE="/etc/ssl/certs/ca-certificates.crt"
The ca-certificates.crt
file is generate by system package call ca-certificates
and must be re-generate each time you add a new self-signed certificate.
Exemple:
sudo cp my.cert /usr/local/share/ca-certificates/
sudo update-ca-certificates
For many programming language, self signed certificates addition, require to inform the system about that new self-signed certificates existence.
The SSL Bundle Certificates , is common thing for SSL and is not impose by Python it self. If you want more information's, back to you system documentation for know more about SSL bundle cert .
DD_SYSPASS_CLIENT_TOKEN_PASS
Shortcut the tokenPass
set inside the config.yml
DD_SYSPASS_CLIENT_API_URL
Shortcut the api_url
set inside the config.yml
DD_SYSPASS_CLIENT_API_VERSION
Shortcut the api_version
set inside the config.yml
DD_SYSPASS_CLIENT_DEBUG
Shortcut the debug
set inside the config.yml
DD_SYSPASS_CLIENT_DEBUG_LEVEL
Shortcut the debug_level
set inside the config.yml
DD_SYSPASS_CLIENT_VERBOSE
Shortcut the verbose
set inside the config.yaml
DD_SYSPASS_CLIENT_VERBOSE_LEVEL
Shortcut the verbose_level
set inside the config.yml
Tips
- If you would like to change token on fly, you'll have to play with $DD_SYSPASS_CLIENT_CONFIG_DIR and a subdirectory structure.
- Syspassclient can start without config.yml file and is suppose to use Variables , that permit to make tests inside a CI.
DigDeo FLOSS Team - 2020
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for digdeo-syspass-client-0.5.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4bd56dd00e704196779d9ca39db88975474d4e44dd55a2fcff2232d9906d692a |
|
MD5 | eddeb034099103bdf94fddff73cc5b98 |
|
BLAKE2b-256 | 1ba5fab1e22bfe8d0229bbbe19a36ccd3025f2f31b85d3f02214998346cced20 |