All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
- Nothing should go in this section, please add to the latest unreleased version (and update the corresponding date), or add a new version.
6.0.0 - 2023-12-28
- Remove support for Conjur V4 (CNJR-2935)
5.4.1 - 2023-06-14
- Added authenticate wrapper to access unparsed response object (including headers). cyberark/conjur-api-ruby#213
- Support Ruby v3.1 and v3.2. cyberark/conjur-api-ruby#220
5.4.0 - 2022-08-16
- Added support for OIDC V2 authentication endpoint. cyberark/conjur-api-ruby#207
- Added support for OIDC authenticator providers endpoint. cyberark/conjur-api-ruby#207
- Remove support for Ruby versions <2.7 which are end of life. cyberark/conjur-api-ruby#206
- Adding operation call to fetch authentication providers cyberark/conjur-api-ruby#206
5.3.7 - 2021-12-28
- Change addressable gem dependency. cyberark/conjur-api-ruby#199
- Update to use automated release process
5.3.6 - 2021-12-09
- Support ruby-3.0.2. cyberark/conjur-api-ruby#197
5.3.5 - 2021-05-04
- Add
rest_client_options
option toConjur.configuration
. This allows users to configure the RestClient instance used by Conjur API to communicate with the Conjur server. cyberark/conjur-api-ruby#188
- Replace monkey patching
RestClient::Request
with defaults onConjur.configuration.rest_client_options
in order to limit the scope of the default:ssl_cert_store
option only to inside Conjur API. cyberark/conjur-api-ruby#188
5.3.4 - 2020-10-29
- When rotating the currently logged in user's/host's API key, we now explictily
prevent use of
resource({own_id}).rotate_api_key
for that action as theConjur::API.rotate_api_key
should be used instead for that. This change is a downstream enforcement of the stricter key rotation requirements on the server covered by this security bulletin. cyberark/conjur-api-ruby#181
5.3.3 - 2020-08-18
- Release process is updated to ensure that the published Ruby Gem matches a tag in this repository, so that consumers of this gem can always reference the correct source code included in any given version. cyberark/conjur-api-ruby#173
- Add
Conjur::API.authenticator_list
,Conjur::API.authenticator_enable
, and ``Conjur::API.authenticator_disable` to inspect and manage authenticator status.
5.3.1 - 2018-09-24
- Updates URI path parameter escaping to consistently encode resource ids
5.3.0 - 2018-06-19
- Add
Conjur::API.ldap_sync_policy
for fetching the LDAP sync policy.
- Fix
Conjur::BuildObject#build_object
so it only tries to create instances of objects for classes that inherit from BaseObject.
- require
openssl
before using it.
- Adds support for the Role endpoint for searching and paging Role Members
- Adds additional escaping to URL parameters on requests to handle special characters (e.g. spaces)
5.1.0 - 2017-12-19
- Introduces backwards compatibility with Conjur 4.x for most API methods.
- Adds the configuration setting
version
, which is auto-populated from the environment variableCONJUR_VERSION
. - Adds support for the
authn-local
service, which can be used when the API client runs on the server.
5.0.0 - 2017-09-19
- Provides compatibility with cyberark/conjur, Conjur 5 CE.
- Changed license to Apache 2.0
- 5.0.0-beta.4
-
- Support for batch secret retrieval.
- v5.0.0-beta.3
-
- Removed hard dependency on older version of
rest-client
gem.
- Removed hard dependency on older version of
- v5.0.0-beta.1
-
- Migrated to be compatible with Conjur 5 API.
4.31.0 - 2017-03-27
- Internal refactor to improve performance and facilitate caching.
4.30.0 - 2017-03-07
- The following enhancements require Conjur server 4.9.1.0 or later:
- Supports filter and pagination of role-listing methods.
- Supports non-recursive retrieval of role memberships.
- Supports the +role+ field on
Conjur::RoleGrant
. - On older server versions, the new options will be ignored by the server.
4.29.2 - 2017-02-22
Conjur::API#resources
now supports:owner
to retrieve all resources owned (directly or indirectly) by the indicated role. This capability has always been provided by the service, but was not exposed by the Ruby API.
Conjur::API#audit
now supports:has_annotation
to retrieve audit events for resources annotated with the given name.
4.29.0 - 2017-02-01
- Add
Conjur::API#new_from_token_file
to create an API instance from a file which contains an access token, which should be periodically updated by another process.
- Make sure certificate file is readable before trying to use it.
4.28.1 - 2016-11-30
Conjur::API#ldap_sync_policy
now returns log events generated when showing a policy.
4.28.0 - 2016-11-16
- Add
Conjur::API#ldap_sync_policy
to fetch the policy to use to bring Conjur and the LDAP server into sync.
- Remove
Conjur::API#ldap_sync_now
andConjur::API#ldap_sync_jobs
- Add `Conjur::API#resources_permitted?"
Conjur::API#ldap_sync_now
now accepts an options Hash which will be passed on to the/sync
entrypoint. The old argument list is maintained for backwards compatibility.Conjur::Api#resources
now supports:has_annotation
for retrieving Conjur resources that have an annotation with the given name.
4.26.0 - 2016-07-01
- expose admin_option in the role graph (only populated by Conjur 4.8 and later)
4.25.1 - 2016-06-22
- Fix token refresh when using
with_privilege
,with_audit_roles
, andwith_audit_resources
.
4.25.0 - 2016-06-17
- Add a workaround for a bug in Conjur <4.7 where long-running operations (such as policy load) would sometimes fail with 404 after five minutes.
4.24.1 - 2016-06-10
- Clarify the handling of the dry-run argument to
Conjur::API#ldap_sync_now
.
4.24.0 - 2016-05-24
- Add
Conjur::API#ldap_sync_now
(requires Conjur 4.7 or later). - Don't trust the system clock and don't check token validity. Rely on the server to verify the token instead, and only try to refresh if enough time has passed locally (using monotonic clock for reference where available).
- Don't try refreshing the token if the required credentials are not available.
4.23.0 - 2016-04-22
- Add
with_audit_roles
andwith_audit_resources
toConjur::API
to add additional roles and resources to audit records generated by requests
- Fix encoding of spaces in some urls.
4.22.1 - 2016-04-13
bootstrap
creates host and webserviceconjur/expiration
.
4.22.0 - 2016-03-08
- Add
show_expired
argument toConjur::Variable#value
to allow retrieval of values of expired variables. - Properly assign ownership of bootstrap-created webservice resources to the
security_admin
group.
4.21.0 - 2016-03-02
- Add extensible Bootstrap commands as API methods.
bootstrap
grantsreveal
andelevate
to thesecurity_admin
group.bootstrap
createswebservice:authn-tv
.bootstrap
creates anauditors
group and givesreveal
privilege to it.
4.20.1 - 2016-02-18
- BUGFIX: Better handling for unicode and special characters in user ids.
4.20.0 - 2016-02-05
- Add support for Host Factory functionality (replaces conjur-asset-host-factory plugin).
- Add support for sending audit events (replaces conjur-asset-audit-send plugin).
- Add support for variable expiration. Variable expiration is available in version 4.6 of the Conjur server.
- Add
Conjur::API
methods to querying service versions :service_version
,service_names
,appliance_info
. - Add
Conjur::API
method for querying server health:appliance_health(remote_host=nil)
- Support ISO8601 duration strings as arguments in variable expiration methods.
- Add support for CIDR restrictions
- BUGFIX: Allow Configuration to parse several certs in a string
4.19.0 - 2015-08-28
- Rename
sudo
toelevate
throughout the spec and docstrings. This is an incompatible change, but it occurs before the Conjur 4.5 server that implementselevate
is released.
- Add method
global_privilege_permitted?
to facilitate working with Conjur 4.5 global privileges.
- Add handling for
X-Forwarded-For
andX-Conjur-Privilege
("conjur sudo") - Transform embedded whitespace in certificate string into newlines
4.16.0 - 2015-04-28
- Add ssl_certificate option to allow certs to be provided as strings (helpful in heroku)
- Add
Conjur::Configuration#apply_cert_config!
method to add certs from#cert_file
and#ssl_certificate
to the default cert store.
4.15.0 - 2015-04-23
- Extensive documentation improvements
- A few additional methoods, for example
Conjur::API#public_key_names
.
4.14.0 - 2015-03-26
- Bump rest-client version, remove the troublesome mime-types patch
- Make sure SSL certificate verification is enabled
- Bugfix: Don't escape ids twice when listing records
- Add a stub so that require 'conjur-api' works
- Lots of doc updates
4.13.0 - 2015-02-11
- Add GID handling utilities
4.12.0 - 2015-01-27
- Add the API method
role_graph
for retrieving role relationships in bulk
- Patch rest-client's patch of mime-types to support lazy loading
- Remove 'wrong' dependency for faster loading
- Fixed bug retrieving
Variable#version_count
- Include CONJUR_ENV in
Conjur.configuration
- Add
cert_file
option toConjur.configuration
4.10.2 - 2014-09-22
- Authn token is refetched before the expiration
- Support for configuration
sticky
option is discarded - Resource#exists? refactored -- no overloading, code from exists.rb used
- Tests use Rspec v3 and reset configuration between test cases
4.10.1 - 2014-09-04
- Resource#exists? returns true if access to resource is forbidden
- Thread-local configuration for working with different endpoints
4.10.0 - 2014-08-15
- User#update
- Added Users#find_users
4.9.2 - 2014-08-05
- Always construct Heroku service names that are valid Heroku names
- authz resource#exists? anticipates a result of 403 Forbidden, and interprets this as true
- Provide a method to detect whether each configuration setting has been explicitly set via the environment
4.9.1 - 2014-07-17
- Require rest-client gem version 1.6.7, as version 1.7 has bugs in SSL certificate trust options
4.9.0 - 2014-06-06
- Layer and Pubkeys are now part of the core API
4.8.0 - 2014-05-23
- Variable#variable_values, batch fetching of variables to support the new conjur env command