A python client for Passbolt.
Project description
Passbolt-python-API
Installation
$pip install passbolt-python-api
Dependencies
- Python3
- GPG (also known as GnuPG) software
Configuration
Create a config file with the following contents.
[PASSBOLT]
SERVER = http://<server_ip or domain>
SERVER_PUBLIC_KEY_FILE = <optional: server_public.asc>
USER_FINGERPRINT = <user_fingerprint>
USER_PUBLIC_KEY_FILE = <optional: passbolt_public.asc>
USER_PRIVATE_KEY_FILE = <optional: passbolt_private.asc>
PASSPHRASE = <passbolt_password>
Usage
>>>import passboltapi
>>>passbolt = passboltapi.PassboltAPI(config_path="config.ini")
# Now you may do any get, post, put and delete request.
>>>r = passbolt.get(url="/resources.json?api-version=v2")
>>>r = passbolt.post(self.server_url + url, json=data)
# One can also use it as context manager
>>>with passboltapi.PassboltAPI(config_path="config.ini") as passbolt:
Check test.py for an example.
If new keys needs to be imported, then USER_PUBLIC_KEY_FILE and USER_PRIVATE_KEY_FILE settings should be in the config ini having the path of the public and private keys file respectively.
To import new keys:
>>>import passboltapi
>>>passbolt = passboltapi.PassboltAPI(config_path="config.ini", new_keys=True)
To delete old keys and import only the new ones.
>>>import passboltapi
>>>passbolt = passboltapi.PassboltAPI(config_path="config.ini", new_keys=True, delete_old_keys=True)
Recommended to do: Do not keep private and public files. Rather just import them using gpg command one time and delete those files.
$gpg --import public.asc
$gpg --batch --import private.asc
For deleting gpg keys
$gpg --delete-secret-keys <fingerprint>
$gpg --delete-key <fingerprint>
Passbolt API
For more API related questions, visit Passbolt API documentation:
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
Built Distribution
Close
Hashes for passbolt-python-api-0.1.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8ce9b02309cc75bb84b63bdf04c2f909ef37b62cb3625f3b95a94a68954f3434 |
|
MD5 | 88f9ca4f28f88c500a833116ad9c1c14 |
|
BLAKE2b-256 | a9045e11fc425b063a2e1e366769e35ecaf7a62a5ffb922fd19a2532bed10272 |
Close
Hashes for passbolt_python_api-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a29b17d89fdef3e615431b73b52a950a503453ad5ce6dd81fb3bb9f48cafa289 |
|
MD5 | efb7a2b41a6f6b42f87daab0d03065c8 |
|
BLAKE2b-256 | 9bec56ca0122c20647035d2a49136eb2ed0c9f79adbfb2f8bd89a93d8363a1fd |