digdeo-syspass-client 0.4.9rc1

DigDeo Syspass Client

digdeo-syspass-client

Python API Client for SysPass server (https://www.syspass.org/en)

Implemented API

Both 100% Cover and 100% UnitTested

• 3.0: https://syspass-doc.readthedocs.io/en/3.0/
• 3.1: https://syspass-doc.readthedocs.io/en/3.1/

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

Note authTokenRO and tokenPassRO are not standard if regarding Syspass API. that is impose by the digdeo-ansible-lookup for the wrapper "search_or_create".

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: '######################################################'
  authTokenRO: '######################################################'
  tokenPass: '######################################################'
  tokenPassRO: '######################################################'
  debug: False
  debug_level: 0
  verbose: False
  verbose_level: 0

Variables

• DD_SYSPASS_CLIENT_CONFIG_DIR
• DD_SYSPASS_CLIENT_AUTH_TOKEN
• DD_SYSPASS_CLIENT_AUTH_TOKEN_RO
• DD_SYSPASS_CLIENT_TOKEN_PASS
• DD_SYSPASS_CLIENT_TOKEN_PASS_RO
• DD_SYSPASS_CLIENT_API_URL
• DD_SYSPASS_CLIENT_API_VERSION

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_AUTH_TOKEN_RO

Shortcut the authToken set inside the config.yml and DD_SYSPASS_CLIENT_AUTH_TOKEN during a Read Only operation

DD_SYSPASS_CLIENT_TOKEN_PASS

Shortcut the tokenPass set inside the config.yml

DD_SYSPASS_CLIENT_TOKEN_PASS_RO

Shortcut the tokenPass set inside the config.yml and DD_SYSPASS_CLIENT_TOKEN_PASS during a Read Only operation

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

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