Skip to main content

APIs for interacting with the Conjur v5 appliance

Project description

conjur-api-python3

Python3-based API SDK for Conjur OSS. The repo also includes a self-contained CLI tool (conjur-cli) that wraps the API in a simple executable script/binary.

Test Coverage Maintainability


Status: Alpha

Warning: Naming and APIs are still subject to breaking changes!


Installing the code

Using conjur-api-python3 with Conjur OSS

Are you using this project with Conjur OSS? Then we strongly recommend choosing the version of this project to use from the latest Conjur OSS suite release. Conjur maintainers perform additional testing on the suite release versions to ensure compatibility. When possible, upgrade your Conjur version to match the latest suite release; when using integrations, choose the latest suite release that matches your Conjur version. For any questions, please contact us on Discourse.

From PyPI

$ pip3 install conjur-client

From source

$ pip3 install .

Note: On some machines, you have to use pip instead of pip3 but in most cases, you will want to use pip3 if it's available for your platform.

Usage

CLI

CLI can either be used with the included executable script:

conjur-cli --insecure -l https://myserver -a orgname -u admin -p secret \
  variable get foo/bar

Or through the installed module:

python -m conjur --insecure -l https://myserver -a orgname -u admin -p secret list

API

Most usage is done by creating a Client instance and then invoking the API on it:

With login ID and password

#!/usr/bin/env python3

from conjur import Client

client = Client(url='https://conjur.myorg.com',
                account='default',
                login_id='admin',
                password='mypassword',
                ca_bundle='/path/to/my/ca/bundle')

print("Setting variable...")
client.set('conjur/my/variable', 'new value')

print("Fetching variable...")
new_value = client.get('conjur/my/variable')

print("Variable value is:", new_value.decode('utf-8'))

With login Id and API key

Write the code same as in the first example but create the client with the following arguments:

client = Client(url='https://conjur.myorg.com',
                account='default',
                login_id='admin',
                api_key='myapikey',
                ca_bundle='/path/to/my/ca/bundle')

With .netrc and .conjurrc settings

Write the code same as in the first example but create the client with the following arguments:

client = Client()

Currently supported client methods:

get(variable_id)

Gets a variable value based on its ID. Variable is binary data that should be decoded to your system's encoding (e.g. get(variable_id).decode('utf-8').

get_many(variable_id[,variable_id...])

Gets multiple variable values based on their IDs. Variables are returned in a dictionary that maps the variable name to its value.

set(variable_id, value)

Sets a variable to a specific value based on its ID.

Note: Policy to create the variable must have been already loaded otherwise you will get a 404 error during invocation.

apply_policy_file(policy_name, policy_file)

Applies a file-based YAML to a named policy. This method only supports additive changes. Result is a dictionary object constructed from the returned JSON data.

replace_policy_file(policy_name, policy_file)

Replaces a named policy with one from the provided file. This is usually a destructive invocation. Result is a dictionary object constructed from the returned JSON data.

delete_policy_file(policy_name, policy_file)

Modifies an existing Conjur policy. Data may be explicitly deleted using the !delete, !revoke, and !deny statements. Unlike "replace" mode, no data is ever implicitly deleted. Result is a dictionary object constructed from the returned JSON data.

list()

Returns a Python list of all the available resources for the current account.

whoami()

Note: This method requires Conjur v1.9+

Returns a Python dictionary of information about the client making an API request (such as its ip address, user, account, token expiration date etc.).

Contributing

We store instructions for development and guidelines for how to build and test this project in the CONTRIBUTING.md - please refer to that document if you would like to contribute.

License

This project is licensed under Apache License v2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

conjur-client-0.1.1.tar.gz (24.1 kB view details)

Uploaded Source

Built Distribution

conjur_client-0.1.1-py3-none-any.whl (32.3 kB view details)

Uploaded Python 3

File details

Details for the file conjur-client-0.1.1.tar.gz.

File metadata

  • Download URL: conjur-client-0.1.1.tar.gz
  • Upload date:
  • Size: 24.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.9

File hashes

Hashes for conjur-client-0.1.1.tar.gz
Algorithm Hash digest
SHA256 5e361e322aae4e11e8f6d82e2cf2dc2ec28cf212f22acd4532c1c7f3447786b3
MD5 a5b7fc302e47817a33c3a167c9696c3f
BLAKE2b-256 ac26fbeea7a516b849e9079a93603122596cf8f1d3c86242c3f74bd58e7319eb

See more details on using hashes here.

File details

Details for the file conjur_client-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: conjur_client-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 32.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.9

File hashes

Hashes for conjur_client-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3a4cdd638eb613ddacf435883d10f4cbcf342443e611717533cb1f7b1cdd3f5a
MD5 fb8505047fd3b9d5ee0c0998b7bf44f2
BLAKE2b-256 88836e80be7ed7472b18b8f29bc6a8a8c401896efad6de6445ad2bd15ab187f9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page