activerecord_aad 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e518372b2ec5ea175036f90aea3db8a6ee83a04e892e9e1c9d369b84d8a5419
-  data.tar.gz: 2790cdbe0184da177aaa6d114904554dca90be20c85bdfe244f042b28b964fe5
+  metadata.gz: 72b9b8232931fdf6b39a2c77182eb989b2ef1b31f48228be1b7bbc8b2ed89e23
+  data.tar.gz: 7b78bdc58f5c029f8f6f109aca762124370f3ab2a88685c0621891192ba06352
 SHA512:
-  metadata.gz: aed2b5969e0bbd14be1bf51834734455348e15ce02e0b415085bd4d8d67c6d2b50d109b43e23913f860a301e221fe1683813391bbe7c7d1233ccc6a3d5a77ee8
-  data.tar.gz: 43d43ea9c87011cd34882964002165ee13f8166703eda4c279f74a0f11396d53404658cde65db7dd6c4a2c658b980a9601d96c41d5470ac1a7092b9aae34e83c
+  metadata.gz: 2af61c5eb0f09f763b511e4f0da836db09f484ccaecb44568e12cea01e3c2d0a0b947c2e72aac03a86dc81ef723e20cb37b6db0612af6da9fed8147ece80a7c3
+  data.tar.gz: bf57dc76487e2a2310a0294c3f7605be0746ac55deda50286f297b3597cd415ddc32860bcdac88edf584ce91c4aa03dc8331b13c73fc3e039357e3e8fba9aaff

data/README.md

@@ -6,3 +6,29 @@ This gem enables using an Azure ActiveDirectory Managed Identity to connect to a
 
 - Add `gem :activerecord_aad` to your Gemfile.
 - Run `bin/bundle install`
+
+## Setup
+
+Follow one of the following guides:
+- MySQL: https://learn.microsoft.com/en-us/azure/mysql/single-server/how-to-connect-with-managed-identity
+- PostgreSQL: https://learn.microsoft.com/en-us/azure/postgresql/single-server/how-to-connect-with-managed-identity
+
+Add the `client_id` from the Azure AD Managed Identity and add it to your `config/database.yml` file with the key `azure_managed_identity`
+
+Example:
+```yaml
+production:
+  adapter: mysql2
+  reconnect: true
+  host: my-app.mysql.database.azure.com
+  azure_managed_identity: 91cb2200-004b-4577-a8ca-a5fa9c082485
+  database: app
+  username: MyAppsManagedIdentity@my-app
+  sslca: /opt/ssl/BaltimoreCyberTrustRoot.crt.pem
+  sslverify: true
+  sslcipher: 'AES256-SHA'
+```
+
+## How it works
+
+Whenever a new database connection is needed, a call is made to "http://169.254.169.254/metadata/identity/oauth2/token?api-version=2018-02-01&resource=https%3A%2F%2Fossrdbms-aad.database.windows.net&client_id=#{database_yml_azure_managed_identity}" to get a new access key. That access key is added as the password to the database configuration that is passed to the adapter to establish the connection.

data/activerecord_aad.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
 
 Gem::Specification.new do |s|
   s.name        = 'activerecord_aad'
-  s.version     = '0.1.0'
+  s.version     = '0.2.1'
   s.authors     = ['Taylor Yelverton']
   s.email       = 'rubygems@yelvert.io'
   s.homepage    = 'https://github.com/ComplyMD/activerecord_aad'

data/lib/activerecord_aad.rb

@@ -7,10 +7,10 @@ module Azure
       module HashConfig
 
         def configuration_hash
-          hash = super.dup
-          if hash[:azure_managed_identity_client_id].present?
-            @managed_identity_manager ||= ManagedIdentityManager.new(hash[:azure_managed_identity_client_id])
-            @managed_identity_manager.apply(hash)
+          hash = super.dup.with_indifferent_access
+          if hash[:azure_managed_identity].present?
+            @managed_identity_manager ||= ManagedIdentityManager.new(hash)
+            @managed_identity_manager.apply
           end
           hash.symbolize_keys!.freeze
           hash
@@ -23,14 +23,17 @@ module Azure
 
         attr_reader :config, :url
 
-        def initialize(cid)
-          raise 'ActiveRecordAAD: missing client_id' unless cid.present?
-          @client_id = cid
-          @url = "#{URL}&client_id=#{client_id}"
+        def initialize(conf)
+          raise "ActiveRecordAAD: invalid config: `#{conf}`" unless conf.is_a?(Hash)
+          @config = conf
+          @client_id = config[:azure_managed_identity]
+          @url = URL
+          @url += "&client_id=#{@client_id}" if @client_id.present?
         end
 
-        def apply(hash)
-          hash.merge!(password: access_token, enable_cleartext_plugin: true)
+        def apply
+          config[:password] = access_token
+          config[:enable_cleartext_plugin] = true if config[:adapter] == 'mysql2'
         end
 
         def access_token

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord_aad
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Taylor Yelverton