mongodb/mongo-ruby-driver

# frozen_string_literal: true

# Copyright (C) 2019-2021 MongoDB Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# 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.

module Mongo
  module Crypt
    module KMS
      module Azure
        # Azure KMS Credentials object contains credentials for using Azure KMS provider.
        #
        # @api private
        class Credentials
          extend Forwardable
          include KMS::Validations

          # @return [ String ] Azure tenant id.
          attr_reader :tenant_id

          # @return [ String ] Azure client id.
          attr_reader :client_id

          # @return [ String ] Azure client secret.
          attr_reader :client_secret

          # @return [ String | nil ] Azure identity platform endpoint.
          attr_reader :identity_platform_endpoint

          # @return [ String | nil ] Azure access token.
          attr_reader :access_token

          # @api private
          def_delegator :@opts, :empty?

          FORMAT_HINT = 'Azure KMS provider options must be in the format: \
            { tenant_id: "TENANT-ID", client_id: "TENANT_ID", client_secret: "CLIENT_SECRET" }'

          # Creates an Azure KMS credentials object form a parameters hash.
          #
          # @param [ Hash ] opts A hash that contains credentials for
          #   Azure KMS provider
          # @option opts [ String ] :tenant_id Azure tenant id.
          # @option opts [ String ] :client_id Azure client id.
          # @option opts [ String ] :client_secret Azure client secret.
          # @option opts [ String | nil ] :identity_platform_endpoint Azure
          #   identity platform endpoint, optional.
          #
          # @raise [ ArgumentError ] If required options are missing or incorrectly
          #   formatted.
          def initialize(opts)
            @opts = opts
            return if empty?

            if opts[:access_token]
              @access_token = opts[:access_token]
            else
              @tenant_id = validate_param(:tenant_id, opts, FORMAT_HINT)
              @client_id = validate_param(:client_id, opts, FORMAT_HINT)
              @client_secret = validate_param(:client_secret, opts, FORMAT_HINT)
              @identity_platform_endpoint = validate_param(
                :identity_platform_endpoint, opts, FORMAT_HINT, required: false
              )
            end
          end

          # Convert credentials object to a BSON document in libmongocrypt format.
          #
          # @return [ BSON::Document ] Azure KMS credentials in libmongocrypt format.
          def to_document
            return BSON::Document.new if empty?

            if access_token
              BSON::Document.new({ accessToken: access_token })
            else
              BSON::Document.new(
                {
                  tenantId: @tenant_id,
                  clientId: @client_id,
                  clientSecret: @client_secret
                }
              ).tap do |bson|
                unless identity_platform_endpoint.nil?
                  bson.update({ identityPlatformEndpoint: identity_platform_endpoint })
                end
              end
            end
          end
        end
      end
    end
  end
end