conjur-api 6.0.1.pre.383 → 6.0.1.pre.394

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bb8763aae591647353cd0f996e73646d9b4c3e85788bb15dbd0d4f57d407b33
-  data.tar.gz: 1e88b17f00813bd22d9208e8fa19c04261ca1cefbb2007282278f6113fcd365f
+  metadata.gz: af87e0d8581ff7549934d83a5e0eb7061ce86a58d8517881350ffaf5b70848e5
+  data.tar.gz: 9241dff625cc8e68187973207a22a493f19b10538e421c8e4d319188c8be7ff4
 SHA512:
-  metadata.gz: 13a169d9d71e2b4de14619c5f2e0933d42c4738998323e8629772ced816681f394cc949151060031e78f08f3d4995194d0224c4321094257ec813070387fc484
-  data.tar.gz: 1915d74e7377e5d8a1a760e632ebcdf27570e34ba8891c77e49975b26bc7c9c38fc3c933579d4edd6ca6c63769fa696955222d97b71bdf4d97b2a983d02fc84b
+  metadata.gz: 6b0b8c96a12a5e40740ae1562a8dc943536326e35dff21e34abb17fc690b4df30b00f6ec63293a3f1d1d21d60f6af11fee6049bb632549556d4a1be0c3826e7e
+  data.tar.gz: c8475527f7db4c23abf56f35ff3bb674fe04e2311a9fbcde49822d938adbe02535faf53740da18e426fdd6f7fccb1d66b2e5ef8fc2b6bb3cf925d5cbceb29e19

data/CHANGELOG.md

@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - 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.1] - 2024-04-05
+## [6.0.1] - 2024-03-25
 
 ### Fixed
 - Pass valid field in #memberships to fix listing roles (CNJR-2109)

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/Jenkinsfile

@@ -25,14 +25,15 @@ pipeline {
     buildDiscarder(logRotator(numToKeepStr: '30'))
   }
 
-  triggers {
-    cron(getDailyCronString())
-  }
-
   environment {
     MODE = release.canonicalizeMode()
   }
 
+  triggers {
+    cron(getDailyCronString())
+    parameterizedCron(getWeeklyCronString("H(1-5)","%MODE=RELEASE"))
+  }
+
   stages {
     stage ("Skip build if triggering job didn't create a release") {
       when {

data/VERSION

@@ -1 +1 @@
-6.0.1-383
+6.0.1-394

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.383
+  version: 6.0.1.pre.394
 platform: ruby
 authors:
 - CyberArk Maintainers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-03-14 00:00:00.000000000 Z
+date: 2025-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client