Programmatic Ruby access to the Conjur API.
RDocs are available from the through the Ruby Gem details page
The Conjur server comes in two major versions:
- 4.x Conjur 4 is a commercial, non-open-source product, which is documented at https://developer.conjur.net/.
- 5.x Conjur 5 is open-source software, hosted and documented at https://www.conjur.org/.
You can use the
master branch of this project, which is
5.x, to do all of the following things against either type of Conjur server:
- Fetch secrets
- Check permissions
- List roles, resources, members, memberships and permitted roles.
- Create hosts using host factory
- Rotate API keys
Use the configuration setting
Conjur.configuration.version to select your server version, or set the environment variable
CONJUR_VERSION. In either case, the valid values are
5; the default is
If you are using Conjur server version
4.x, you can also choose to use the
4.x. In this case, the
Configuration.version setting is not required (actually, it doesn't exist).
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install conjur-api
Connecting to Conjur is a two-step process:
- Configuration Instruct the API where to find the Conjur endpoint and how to secure the connection.
- Authentication Provide the API with credentials that it can use to authenticate.
The simplest way to configure the Conjur API is to use the configuration file stored on the machine.
If you have configured the machine with conjur init,
its default location is
The Conjur configuration process also checks
/etc/conjur.conf for global settings. This is typically used
in server environments.
For custom scenarios, the location of the file can be overridden using the
CONJURRC environment variable.
You can load the Conjur configuration file using the following Ruby code:
require 'conjur/cli' Conjur::Config.load Conjur::Config.apply
Note this code requires the conjur-cli gem, which should also be in your gemset or bundle.
Once Conjur is configured, the connection can be established like this:
conjur = Conjur::Authn.connect nil, noask: true
To authenticate, the API client must
login name and
Conjur::Authn.connect will attempt the following, in order:
- Look for
loginin environment variable
- Look for credentials on disk. The default credentials file is
~/.netrc. The location of the credentials file can be overridden using the configuration file
- Prompt for credentials. This can be disabled using the option
Connecting Without Files
It's possible to configure and authenticate the Conjur connection without using any files, and without requiring
To accomplish this, apply the configuration settings directly to the Conjur::Configuration object.
For example, specify the
appliance_url (both of which are required) like this:
Conjur.configuration.account = 'my-account' Conjur.configuration.appliance_url = 'https://conjur.mydomain.com/api'
You can also specify these values using environment variables, which is often a bit more convenient.
Environment variables are mapped to configuration variables by prepending
CONJUR_ to the all-caps name of the
configuration variable. For example,
In either case, you will also need to configure certificate trust. For example:
Once Conjur is configured, you can create a new API client by providing a
Conjur::API.new_from_key login, api_key
Note that if you are connecting as a Host, the login should be
host/. For example:
host/myhost.example.com, not just
To develop and run tests against Conjur V5, use the
stop scripts in the
dev folder. The start script brings up an open source Conjur (and Postgres database), CLI container, and a "work" container, with the gem code mounted into the working directory.
Starting a Shell
$ cd dev $ ./start ... root@9df0ac10ada2:/src/conjur-api#
You'll be dropped into development container upon completion. From there, install the development gems:
NOTE: There are some existing challenges around running tests from the development console. For now, run tests
by using the
./test.sh script utilized for Jenkins Pipelines.
Stopping & Environment Cleanup
Once you're done, exit the shell, and stop the containers:
root@9df0ac10ada2:/src/conjur-api# exit $ ./stop
docker-compose.yml is a self-contained development environment for the project.
To bring it up, run:
$ docker-compose build $ docker-compose up -d pg conjur_4 conjur_5
Then configure the v4 and v5 servers:
$ ./ci/configure_v4.sh ... $ ./ci/configure_v5.sh ...
Obtain the API key for the v5 admin user:
$ docker-compose exec conjur_5 rake 'role:retrieve-key[cucumber:user:admin]' 3aezp05q3wkem3hmegymwzz8wh3bs3dr6xx3y3m2q41k5ymebkc
The password of the v4 admin user is "secret".
Now you can run the client
$ docker-compose run --rm dev
This gives you a shell session with
conjur_5 available as linked containers.
For a v5 demo, run:
$ bundle exec ./example/demo_v5.rb <admin-api-key>
For a v4 demo, run:
$ bundle exec ./example/demo_v4.rb
To bring it down, run:
$ docker-compose down
Releasing a new version of this Gem involves a two step process:
- Tag and Release (using
- Approving the push to RubyGems in Jenkins
Step 1: Tag and Release
First, update the following files:
- The version file (
lib/conjur-api/version.rb) has been updated with an appropriate Semantic version number.
CHANGELOG.mdfile has been updated to reflect the release version and appropriate release notes.
Next, save -- but do not commit -- the changes above.
Finally, when you're ready to release, run the following:
Step 2: Approve the push to RubyGems in Jenkins
- Navigate to Jenkins: https://jenkins.conjur.net/job/cyberark--conjur-api-ruby/job/master/.
- Once the pipeline reaches the
Publish to RubyGems?stage, click the blue box, and then click
- Open the confirmation step (
Wait for interactive input -- Publish to RubyGems?), and click
Proceed. Nothing appears to happen, but the "Publish" stage will be run.
- Finally, verify that the new library is present in RubyGems: https://rubygems.org/gems/conjur-api
The release is now complete.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Added some feature')
- Push to the branch (
git push origin my-new-feature)
- Create new Pull Request
Copyright 2016-2017 CyberArk
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.