az-identity 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8febab2955adfb7bdc0a0df7d91d24bfadb5ec05e395bf9996be4cee357380f5
+  data.tar.gz: 752d7f9395c662b2f32cad314f09136378d2df7f1110c9505058d717f767b389
+SHA512:
+  metadata.gz: 7bb039d9cf3ee98d194356fbf61cd7330fa573295f8133629a270e70f857125e3763ec66eaa3f9ef931af76701042e9c2b57e8939ab122bc09b57a74480af590
+  data.tar.gz: d66d03e045ce23f111d43767aa6e24ced3ee5899fee41ff56e9cdd439319eda34dd370b7efd749668de33baa066030551ab26f211b30cd4d9b73baa592230eed

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## Unreleased
+
+- Extract Azure identity credential acquisition (workload identity and managed identity) into a standalone gem.
+- Add `RedisCredentialsProvider` for authenticating to Azure Cache for Redis with a Microsoft Entra token.

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 GitLab B.V.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,93 @@
+# AzIdentity
+
+[![Gem Version](https://badge.fury.io/rb/az-identity.svg)](https://badge.fury.io/rb/az-identity)
+[![CI](https://gitlab.com/gitlab-org/ruby/gems/az-identity/badges/main/pipeline.svg)](https://gitlab.com/gitlab-org/ruby/gems/az-identity/-/pipelines)
+
+Azure identity and authentication library for Ruby.
+
+Provides credential acquisition for Azure services including Workload Identity and Managed Identity.
+
+## :warning: Not Supported by Microsoft
+
+This library is **not supported by Microsoft**. It is developed and maintained by GitLab.
+
+Microsoft provides official Azure Identity libraries for Ruby:
+- [azure-identity (Microsoft)](https://github.com/Azure/azure-sdk-for-ruby/tree/master/sdk/identity/azure-identity)
+
+If you encounter issues with this library, please file issues on the [GitLab issue tracker](https://gitlab.com/gitlab-org/ruby/gems/az-identity/-/issues), not Microsoft support channels.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'az-identity'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself:
+
+```bash
+$ gem install az-identity
+```
+
+## Usage
+
+```ruby
+require 'az_identity'
+
+# Get credentials using default chain (Workload Identity -> Managed Identity)
+credentials = AzIdentity.credentials(environment: 'AzureCloud')
+
+# Or use specific client directly
+client = AzIdentity::Identity::WorkloadIdentityClient.new(environment: 'AzureCloud')
+credentials = client.fetch_credentials_if_needed
+```
+
+### Environment Variables
+
+#### Workload Identity
+- `AZURE_TENANT_ID` - Your Azure tenant ID
+- `AZURE_CLIENT_ID` - Your client/application ID
+- `AZURE_FEDERATED_TOKEN_FILE` - Path to the OIDC token file
+- `AZURE_AUTHORITY_HOST` - (Optional) Override authority URL
+
+#### Managed Identity
+- `AZURE_CLIENT_ID` - (Optional) Specific managed identity client ID
+- `IDENTITY_ENDPOINT` - (Optional) Custom IMDS endpoint
+- `IDENTITY_HEADER` - (Optional) Custom header for IMDS
+
+#### Azure Environment
+- `AZURE_ENVIRONMENT` - (Optional) Azure cloud: `AzureCloud`, `AzureChinaCloud`, `AzureUSGovernment`
+
+## Supported Azure Environments
+
+- AzureCloud (default)
+- AzureChinaCloud
+- AzureUSGovernment
+
+## Sovereign clouds
+
+The OAuth resource/audience (`https://storage.azure.com`, `https://redis.azure.com`) is the same in every Azure cloud; only the Microsoft Entra authority (login host) differs. Cloud selection therefore only affects the authority:
+
+- **Workload identity**: the authority comes from `AZURE_AUTHORITY_HOST`, which AKS injects with the correct per-cloud value, so it works in sovereign clouds without further configuration. The `AZURE_ENVIRONMENT` fallback is used only when that variable is unset.
+- **Managed identity**: uses the IMDS endpoint, which is the same in every cloud, so it is cloud-agnostic.
+
+Only Azure Public and Azure US Government have been exercised; other clouds rely on the mechanisms above rather than dedicated testing.
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rake test` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitLab at https://gitlab.com/gitlab-org/ruby/gems/az-identity.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/az_identity/azure_environment.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'constants'
+
+module AzIdentity
+  module AzureEnvironment
+    # The Microsoft Entra authority (login host) differs per cloud. On AKS with
+    # workload identity, AZURE_AUTHORITY_HOST is injected with the correct value
+    # and takes precedence over this fallback (see WorkloadIdentityClient).
+    def authority_url(environment = AzIdentity::Constants::AZURE_CLOUD)
+      case environment
+      when AzIdentity::Constants::AZURE_CHINA_CLOUD
+        'https://login.partner.microsoftonline.cn'
+      when AzIdentity::Constants::AZURE_US_GOVERNMENT
+        'https://login.microsoftonline.us'
+      else
+        'https://login.microsoftonline.com'
+      end
+    end
+
+    # The OAuth resource/audience is the same in every cloud (only the authority
+    # differs), so these intentionally ignore the environment.
+    # https://learn.microsoft.com/en-us/rest/api/storageservices/authorize-with-azure-active-directory
+    def storage_resource(_environment = AzIdentity::Constants::AZURE_CLOUD)
+      'https://storage.azure.com'
+    end
+
+    def redis_resource(_environment = AzIdentity::Constants::AZURE_CLOUD)
+      'https://redis.azure.com'
+    end
+  end
+end

data/lib/az_identity/constants.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module AzIdentity
+  module Constants
+    AZURE_CLOUD = 'AzureCloud'
+    AZURE_CHINA_CLOUD = 'AzureChinaCloud'
+    AZURE_US_GOVERNMENT = 'AzureUSGovernment'
+  end
+end

data/lib/az_identity/identity/base_client.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'faraday'
+require_relative '../azure_environment'
+
+module AzIdentity
+  module Identity
+    class BaseClient
+      include AzIdentity::AzureEnvironment
+
+      class FetchCredentialsError < RuntimeError
+      end
+
+      DEFAULT_TIMEOUT_S = 30
+
+      attr_accessor :credentials
+
+      def initialize
+        @mutex = Mutex.new
+      end
+
+      def fetch_credentials
+        raise NotImplementedError
+      end
+
+      def fetch_credentials_if_needed
+        # Serialize refreshes so concurrent callers (for example pooled Redis
+        # connections across threads) don't each hit the token endpoint.
+        @mutex.synchronize do
+          @credentials = fetch_credentials if @credentials.nil? || refresh_needed?
+
+          credentials
+        end
+      end
+
+      def refresh_needed?
+        return true unless @credentials
+
+        @credentials.refresh_needed?
+      end
+
+      protected
+
+      def process_token_response(response)
+        raise FetchCredentialsError, response.to_s unless response.success?
+
+        body = ::JSON.parse(response.body)
+        access_token = body['access_token']
+
+        return unless access_token
+
+        Credentials.new(access_token, expiration_time(body))
+      rescue ::JSON::ParserError
+        nil
+      end
+
+      # IMDS (managed identity) returns an absolute epoch in +expires_on+, while
+      # the Microsoft Entra v2.0 token endpoint (workload identity) returns a
+      # relative +expires_in+ in seconds. Returns nil when neither is present,
+      # which Credentials treats as "expiry unknown, always refresh".
+      def expiration_time(body)
+        if (expires_on = body['expires_on'])
+          ::Time.at(expires_on.to_i)
+        elsif (expires_in = body['expires_in'])
+          ::Time.now + expires_in.to_i
+        end
+      end
+
+      private
+
+      def get(url, params: nil, headers: nil)
+        Faraday.get(url, params, headers) do |req|
+          req.options.timeout = DEFAULT_TIMEOUT_S
+        end
+      rescue ::Faraday::Error => e
+        raise FetchCredentialsError, e.to_s
+      end
+
+      def post(url, body: nil, headers: nil)
+        Faraday.post(url, body, headers) do |req|
+          req.options.timeout = DEFAULT_TIMEOUT_S
+        end
+      rescue ::Faraday::Error => e
+        raise FetchCredentialsError, e.to_s
+      end
+    end
+  end
+end

data/lib/az_identity/identity/credentials.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module AzIdentity
+  module Identity
+    class Credentials
+      attr_accessor :token, :expires_at
+
+      EXPIRATION_BUFFER = 600
+
+      def initialize(token, expires_at)
+        @token = token
+        @expires_at = expires_at
+      end
+
+      def refresh_needed?
+        return true unless expires_at
+
+        Time.now >= expires_at - EXPIRATION_BUFFER
+      end
+    end
+  end
+end

data/lib/az_identity/identity/default_credentials.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'json'
+require_relative 'base_client'
+require_relative 'workload_identity_client'
+require_relative 'managed_identity_client'
+
+module AzIdentity
+  class DefaultCredentials
+    CLIENTS = [
+      AzIdentity::Identity::WorkloadIdentityClient,
+      AzIdentity::Identity::ManagedIdentityClient
+    ].freeze
+
+    def initialize(options = {})
+      @options = options
+      @credential_client = nil
+      @mutex = Mutex.new
+    end
+
+    def fetch_credentials_if_needed
+      return unless credential_client
+
+      credential_client.fetch_credentials_if_needed
+    end
+
+    private
+
+    attr_reader :options
+
+    def credential_client
+      return @credential_client if @credential_client
+
+      @mutex.synchronize do
+        @credential_client ||= discover_client
+      end
+    end
+
+    def discover_client
+      CLIENTS.each do |klass|
+        client = klass.new(options)
+        return client if try_fetch_credentials(client)
+      end
+
+      nil
+    end
+
+    # A credential source that is not configured in this environment should be
+    # skipped so the next one is tried, rather than aborting discovery of the
+    # remaining sources.
+    def try_fetch_credentials(client)
+      client.fetch_credentials_if_needed
+    rescue StandardError
+      nil
+    end
+  end
+end

data/lib/az_identity/identity/managed_identity_client.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'faraday'
+require 'cgi'
+require_relative 'base_client'
+
+module AzIdentity
+  module Identity
+    IDENTITY_ENDPOINT = 'http://169.254.169.254/metadata/identity/oauth2/token'
+    API_VERSION = '2018-02-01'
+
+    class ManagedIdentityClient < BaseClient
+      attr_reader :resource
+
+      def initialize(options = {})
+        super()
+        @environment = options[:environment]
+        @resource = options[:resource] || storage_resource(@environment)
+      end
+
+      def fetch_credentials
+        url = "#{identity_endpoint}?api-version=#{api_version}&resource=#{CGI.escape(resource)}"
+
+        client_id = ENV.fetch('AZURE_CLIENT_ID', nil)
+        url += "&client_id=#{client_id}" if client_id
+
+        headers = { 'Metadata' => 'true' }
+        headers['X-IDENTITY-HEADER'] = ENV['IDENTITY_HEADER'] if ENV['IDENTITY_HEADER']
+
+        response = get(url, headers: headers)
+        process_token_response(response)
+      end
+
+      private
+
+      def identity_endpoint
+        ENV['IDENTITY_ENDPOINT'] || IDENTITY_ENDPOINT
+      end
+
+      def api_version
+        ENV['IDENTITY_ENDPOINT'] ? '2019-08-01' : API_VERSION
+      end
+    end
+  end
+end

data/lib/az_identity/identity/workload_identity_client.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'faraday'
+require_relative 'base_client'
+
+module AzIdentity
+  module Identity
+    class WorkloadIdentityClient < BaseClient
+      attr_accessor :environment, :resource, :authority, :tenant_id, :client_id, :token_file
+
+      def initialize(options = {})
+        super()
+        @environment = options[:environment]
+        @resource = options[:resource] || storage_resource(@environment)
+        @authority = ENV['AZURE_AUTHORITY_HOST'] || authority_url(@environment)
+        @tenant_id = ENV.fetch('AZURE_TENANT_ID', nil)
+        @client_id = ENV.fetch('AZURE_CLIENT_ID', nil)
+        @token_file = ENV.fetch('AZURE_FEDERATED_TOKEN_FILE', nil)
+
+        normalize_authority!
+      end
+
+      def fetch_credentials
+        return unless federated_credentials_available?
+
+        response = post(token_endpoint, body: token_request_body)
+        process_token_response(response)
+      rescue ::Faraday::Error => e
+        raise FetchCredentialsError, e.to_s
+      end
+
+      private
+
+      def federated_credentials_available?
+        return false unless authority && tenant_id && client_id && token_file
+
+        ::File.exist?(token_file) && ::File.readable?(token_file)
+      end
+
+      def token_endpoint
+        "#{authority}/#{tenant_id}/oauth2/v2.0/token"
+      end
+
+      def token_request_body
+        {
+          client_id: client_id,
+          grant_type: 'client_credentials',
+          client_assertion_type: 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer',
+          client_assertion: ::File.read(token_file),
+          scope: "#{resource}/.default"
+        }
+      end
+
+      def normalize_authority!
+        parsed = URI.parse(authority)
+
+        unless parsed.scheme
+          @authority = "https://#{authority.strip.chomp('/')}"
+          return
+        end
+
+        unless parsed.scheme == 'https'
+          raise ArgumentError,
+                "'#{authority}' is an invalid authority. The value must be a TLS protected (https) URL."
+        end
+
+        @authority = authority.strip.chomp('/')
+      end
+    end
+  end
+end

data/lib/az_identity/redis_credentials_provider.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'json'
+require_relative 'azure_environment'
+require_relative 'identity/default_credentials'
+
+module AzIdentity
+  # Adapts Azure identity credential acquisition to the credentials-provider
+  # interface expected by redis-client / redis-rb:
+  #
+  #   provider.call        # => [username, password]
+  #   provider.expires_at  # => Time or nil
+  #
+  # The password is a Microsoft Entra access token for the Azure Cache for
+  # Redis scope. The username is the object (principal) ID of the managed
+  # identity or service principal, taken from the token's +oid+ claim unless
+  # an explicit +:username+ is supplied.
+  class RedisCredentialsProvider
+    include AzureEnvironment
+
+    def initialize(options = {})
+      @username = options[:username]
+      @credential_client = options[:credential_client] || build_default_client(options)
+      @mutex = Mutex.new
+    end
+
+    # Returns fresh [username, access_token]. Acquires or refreshes the token
+    # as needed. Called by the Redis client on every (re)connect and before a
+    # command whenever the token is close to expiring.
+    def call
+      credentials = @mutex.synchronize do
+        @credentials = @credential_client.fetch_credentials_if_needed
+      end
+
+      raise Identity::BaseClient::FetchCredentialsError, 'no Azure credentials available for Redis' unless credentials
+
+      [username(credentials.token), credentials.token]
+    end
+
+    # The Time at which the current token expires, so the Redis client can
+    # re-authenticate long-lived connections before the token is rejected.
+    def expires_at
+      @mutex.synchronize { @credentials&.expires_at }
+    end
+
+    private
+
+    def build_default_client(options)
+      resource = options[:resource] || redis_resource(options[:environment])
+      DefaultCredentials.new(options.merge(resource: resource))
+    end
+
+    def username(token)
+      @username || object_id_from_token(token)
+    end
+
+    # Extracts the +oid+ (object ID) claim from the JWT access token without
+    # verifying its signature. Azure Cache for Redis expects the AUTH username
+    # to be the managed identity / service principal object ID.
+    def object_id_from_token(token)
+      payload = token.to_s.split('.')[1]
+      return unless payload
+
+      json = Base64.urlsafe_decode64(pad_base64(payload))
+      JSON.parse(json)['oid']
+    rescue ArgumentError, JSON::ParserError
+      nil
+    end
+
+    def pad_base64(str)
+      remainder = str.length % 4
+      remainder.zero? ? str : str + ('=' * (4 - remainder))
+    end
+  end
+end

data/lib/az_identity/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AzIdentity
+  VERSION = '0.1.0'
+end

data/lib/az_identity.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'az_identity/identity/base_client'
+require_relative 'az_identity/identity/credentials'
+require_relative 'az_identity/identity/default_credentials'
+require_relative 'az_identity/identity/managed_identity_client'
+require_relative 'az_identity/identity/workload_identity_client'
+require_relative 'az_identity/redis_credentials_provider'
+
+module AzIdentity
+  class << self
+    def credentials(options = {})
+      AzIdentity::DefaultCredentials.new(options).fetch_credentials_if_needed
+    end
+
+    # Builds a credentials provider suitable for authenticating to Azure Cache
+    # for Redis with a Microsoft Entra token. Pass the result as the
+    # +credentials_provider+ option to redis-client / redis-rb.
+    def redis_credentials_provider(options = {})
+      AzIdentity::RedisCredentialsProvider.new(options)
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: az-identity
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- GitLab
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Credential acquisition for Azure services using workload identity or
+  managed identity
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/az_identity.rb
+- lib/az_identity/azure_environment.rb
+- lib/az_identity/constants.rb
+- lib/az_identity/identity/base_client.rb
+- lib/az_identity/identity/credentials.rb
+- lib/az_identity/identity/default_credentials.rb
+- lib/az_identity/identity/managed_identity_client.rb
+- lib/az_identity/identity/workload_identity_client.rb
+- lib/az_identity/redis_credentials_provider.rb
+- lib/az_identity/version.rb
+homepage: https://gitlab.com/gitlab-org/ruby/gems/az-identity
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: Azure identity and authentication library for Ruby
+test_files: []