conjur-api 6.0.1.pre.392 → 6.0.1.pre.397

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f07a58c83c43f077c6c0681c4eb7d9a3eb68e5670fce35b7a8de14af94138ef
-  data.tar.gz: df1f3ebe59388cb6fd4481d6e325e8ac8cf8c8e547ea1f228c27f6d562285526
+  metadata.gz: dfad32924a3946437d68dec74e837d60b7b86c12a83c82c0b76f94c9d1e038ac
+  data.tar.gz: 82cc3d6b12d3d08a49d002fb6dfd7ca6998d0b097fc83e4313140fa968c94d74
 SHA512:
-  metadata.gz: 8a348b59ccca310f949e2a05ea1fb306daff9bea27acb94b9ae7c3c78a02fd8afb9a57f7f4fa269226c235c91f20647bd4743ead700a7f95de367e9a7e7dc502
-  data.tar.gz: '05009cbe0759b29083320189bf18a46dab12573be4e531ec08b22781bbbcf504cefb8e0ae8f5cb5db9fe853d6cc883a784aa17a5a9aec6b4c8dd7edea762bcee'
+  metadata.gz: d19e588938870c7b500a40e66d63680ff4a08a1e66ae644b5c392f2d8dff5ceac77c19f16d92fba4af8b9ff5ac032eac5e2ee09a96e1943b142e50bf0227fe33
+  data.tar.gz: 6ed03dfacb53665f4eccdbb2f69691db04207b69751aabfa04492fe96411ce5c9fbf3e34ce19cc0b53cd24cc0122a217149af10b0c1fac6ca1371699052f2e26

data/Dockerfile

@@ -1,7 +1,7 @@
 ARG RUBY_VERSION
 FROM ruby:$RUBY_VERSION
 
-RUN apt-get update && apt-get install -y --no-install-recommends vim curl
+RUN apt-get update && apt-get install -y --no-install-recommends vim curl libyaml-dev
 
 WORKDIR /src/conjur-api
 

data/VERSION

@@ -1 +1 @@
-6.0.1-392
+6.0.1-397

data/dev/Dockerfile.dev

@@ -1,6 +1,6 @@
 FROM ruby:3-slim
 
-RUN apt-get update && apt-get install -y --no-install-recommends vim curl git build-essential
+RUN apt-get update && apt-get install -y --no-install-recommends vim curl git build-essential libyaml-dev
 
 WORKDIR /src/conjur-api
 

data/dev/docker-compose.yml

@@ -1,4 +1,3 @@
-version: '3'
 services:
   pg:
     image: postgres:15

data/dev/start

@@ -5,7 +5,7 @@ function development() {
 
   docker compose exec -T conjur conjurctl wait
 
-  local api_key=$(docker compose exec -T conjur rake 'role:retrieve-key[cucumber:user:admin]')
+  local api_key=$(docker compose exec -T conjur bundle exec rake 'role:retrieve-key[cucumber:user:admin]')
   api_key=$(docker compose exec -T conjur conjurctl role retrieve-key cucumber:user:admin | tr -d '\r')
 
   docker exec -e CONJUR_AUTHN_API_KEY="$api_key" -it --detach-keys 'ctrl-\' $(docker compose ps -q gem) bash

data/lib/conjur/configuration.rb

@@ -22,6 +22,7 @@
 require 'openssl'
 require 'set'
 require 'conjur/cert_utils'
+require 'base64'
 
 module Conjur
   class << self
@@ -368,6 +369,19 @@ module Conjur
     # @see cert_file
     add_option :ssl_certificate
 
+    # add custom header to request containing customer detail and sdk version
+    add_option :integration_name, default: "SecretsManagerRuby SDK" 
+    
+    add_option :integration_type, default: "cybr-secretsmanager"
+
+    add_option :integration_version, default: Conjur::API::VERSION
+    
+    add_option :vendor_name, default: "CyberArk"
+
+    add_option :vendor_version, default: nil
+    
+    add_option :final_telemetry_header
+
     # @!attribute rest_client_options
     #
     # Custom options for the underlying RestClient Requests. This defaults to:
@@ -384,7 +398,10 @@ module Conjur
     # you must manually set them on the value you provide.
     add_option :rest_client_options do
       {
-        ssl_cert_store: OpenSSL::SSL::SSLContext::DEFAULT_CERT_STORE
+        ssl_cert_store: OpenSSL::SSL::SSLContext::DEFAULT_CERT_STORE,
+        headers: { 
+          'x-cybr-telemetry': get_telemetry_header
+        }
       }
     end
 
@@ -397,7 +414,8 @@ module Conjur
     # Create rest_client_options by merging the input with the
     # rest_client_options present on the configuration object.
     def create_rest_client_options options
-      rest_client_options.merge(options || {})
+      options ||= {}
+      rest_client_options.merge(options) { |key, left, right| left.merge(right) }
     end
 
     # Add the certificate configured by the {#ssl_certificate} and {#cert_file} options to the certificate
@@ -436,5 +454,43 @@ module Conjur
       # propagate.
       File.open(path) {}
     end
+
+    # get_telemetry_header constructs and returns a base64-encoded telemetry header string.
+    #
+    # The method checks the values of various instance variables (`integration_name`,
+    # `integration_version`, `integration_type`, `vendor_name`, `vendor_version`) and
+    # constructs the header accordingly. If any of these values are not provided (empty or nil),
+    # they will be omitted from the final header string.
+    #
+    # The telemetry header is formatted as a series of key-value pairs separated by "&". Each key-value
+    # pair corresponds to one of the following fields:
+    #   - `in`: Integration Name
+    #   - `iv`: Integration Version
+    #   - `it`: Integration Type
+    #   - `vn`: Vendor Name
+    #   - `vv`: Vendor Version
+    #
+    # The final header string is base64-encoded using URL-safe encoding (without padding).
+    # If the header has been previously generated and cached in `final_telemetry_header`, it is returned directly.
+    #
+    # Returns:
+    #   - String: The base64-encoded telemetry header string.
+    def get_telemetry_header
+      unless final_telemetry_header.nil?
+        return final_telemetry_header
+      end
+      final_telemetry_header = ""
+      if integration_name && !integration_name.strip.empty?
+        final_telemetry_header += "in=#{integration_name}" 
+        final_telemetry_header += "&iv=#{integration_version}"  if integration_version && !integration_version.strip.empty?
+        final_telemetry_header += "&it=#{integration_type}" if integration_type && !integration_type.strip.empty?
+      end
+
+      if vendor_name && !vendor_name.strip.empty?
+        final_telemetry_header += "&vn=#{vendor_name}"
+        final_telemetry_header += "&vv=#{vendor_version}" if vendor_version && !vendor_version.strip.empty?
+      end
+      Base64.urlsafe_encode64(final_telemetry_header, padding: false)
+    end
   end
 end

data/spec/configuration_spec.rb

@@ -31,10 +31,12 @@ describe Conjur::Configuration do
     }
 
     it "rest_client_options defaults" do
+      encoded_attr = Base64.urlsafe_encode64("in=SecretsManager Ruby SDK&iv=0.0.dev&it=cybr-secretsmanager&vn=CyberArk", padding: false)
       expected = {
-        ssl_cert_store: OpenSSL::SSL::SSLContext::DEFAULT_CERT_STORE
+        ssl_cert_store: OpenSSL::SSL::SSLContext::DEFAULT_CERT_STORE,
+        headers: { 'x-cybr-telemetry': encoded_attr}
       }
-      expect(configuration.rest_client_options).to eq(expected)
+      expect(configuration.rest_client_options[:headers]).to include(:'x-cybr-telemetry')
     end
 
     it "rest_client_options propagate to RestClient::Resource" do

data/test.sh

@@ -60,7 +60,7 @@ function runTests() {
     -e CONJUR_AUTHN_API_KEY="$api_key" \
     -e SSL_CERT_FILE=/etc/ssl/certs/keycloak.pem \
     tester \
-    "/scripts/fetch_certificate && rake jenkins_init jenkins_spec jenkins_cucumber"
+    "/scripts/fetch_certificate && bundle exec rake jenkins_init jenkins_spec jenkins_cucumber"
 }
 
 main

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: conjur-api
 version: !ruby/object:Gem::Version
-  version: 6.0.1.pre.392
+  version: 6.0.1.pre.397
 platform: ruby
 authors:
 - CyberArk Maintainers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-03-26 00:00:00.000000000 Z
+date: 2025-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client