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>
Or as a dictionary
config = {
"PASSBOLT": {
"SERVER": "http://<server_ip or domain>"
....(same as above)
}
}
Usage
>>>import passboltapi
>>>passbolt = passboltapi.PassboltAPI(config_path="config.ini")
# Or pass the configuration settings as a dict
>>>passbolt = passboltapi.PassboltAPI(config=<dictionary as the given example 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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e734c53e720bbda0b343b05cdfdd1c1a5319d4519c63f931f3b1046508ec6f36 |
|
MD5 | 95cad6b5ba819effd636e4dc70032368 |
|
BLAKE2b-256 | ca11b3d8145f4528b3664b2601674bf84ff4ac8620a9e8ef70f56191cabcafda |
Close
Hashes for passbolt_python_api-0.1.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aad9754945f7c1b02921d8fe47a7adf55685d43cbb274190c3f3c1b5a5bcfa6b |
|
MD5 | 3613b869000605d076a389c24031e3f1 |
|
BLAKE2b-256 | b9fd806fae780b1d7cc9f99fd70a8e3370f4a1b65fd68ec6f7af261f2576dbc5 |