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:
Client usage
-
To get all resources
resources = { record.username: record for record in passbolt.list_resources(folder_id=folder_id) }
-
To create new resource (optional: folder)
response_created = passbolt.create_new_resource(username, password, folder=passbolt_folder_id)
-
To move resource to folder
passbolt.move_resource_to_folder(resource_id, folder_id)
Sample test
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
Hashes for passbolt-python-api-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6295a0aea99f2354c07b2bf8e9957449a1ab30f51535d2cfd597831092e209d2 |
|
MD5 | 353f53dfd99abd887484688cc162e066 |
|
BLAKE2b-256 | d6e72e47aa31d8f42b479cacdedf9ca51b0f5986d0bcf9311cdecaf11e0f2183 |
Hashes for passbolt_python_api-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 740b98127347fea2f6a148804bd43f21deea53b15c3925c57fd22a3b493c944a |
|
MD5 | 5c56d2ed3801d1c4c37f8988264e0ef1 |
|
BLAKE2b-256 | e40f790099e9b0c24b295c90555b9b6ee33b7178fb86d921b940537835b6c6a4 |