ms_rest_azure 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1fa53ad5c656df3cc93d4b643a071188ec484065
-  data.tar.gz: 54a52fddbcd922a038d4a8d29596fc597b24f656
+  metadata.gz: 598eee1919adb8f42b15642431cf5b5fdb948c06
+  data.tar.gz: e3202bab608bb1cf4a2b3f2c664a12da53084964
 SHA512:
-  metadata.gz: 4c2c2a09377082f0983813aec073022da15d725427ff28b7783a77fc18a0a91a2ba6aeee2c6988b392aca28f5dee65fec36878b0fc7aec65aa2a67ee7bc45f7e
-  data.tar.gz: d15cd3eb322e305fa59de8377366fffa34e93421b58f24000d887b2c35b0b246aaccb2d91041f558e3333210b79ad9f0ba12524fde7f6a510a32f802737323d7
+  metadata.gz: fa5e95ea325152eb570a5bde4ad22938a0414b7cf3b3b17c614851b5529e8478f30c54436fea3d154b3239bab2d4c2fab9ca7d4787836d331cbfc1207ce7f861
+  data.tar.gz: efa6785890307c55f49a069b70625aeb63246af643b11f9292965cc5f0c54053d5e08ccb90f7fc52cb074008ae2f56b56c0a0a815d4a8e1cb1a3e0da8e40058f

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+##2017.08.28 ms_rest_azure version 0.8.2
+* Enable Managed Service Identity authentication features into ms_rest_azure runtime for azure_mgmt_* sdks.[Issue #884](https://github.com/Azure/azure-sdk-for-ruby/issues/884) [PR #889](https://github.com/Azure/azure-sdk-for-ruby/pull/889)
+
 ##2017.07.10 ms_rest_azure version 0.8.1
 * [Bug Fix] Fixed the issue with the polling status object to handle the response code and provisioning status correctly.[Issue #817](https://github.com/Azure/azure-sdk-for-ruby/issues/817) [PR #828](https://github.com/Azure/azure-sdk-for-ruby/pull/828)
 

data/README.md

@@ -37,10 +37,19 @@ To start working on the gem the only additional dev dependecy is required - rspe
 Reference it in the gemfile and also add this line to your client's gemspec file:
 
 ```ruby
-spec.add_runtime_dependency 'ms_rest_azure', '~> 0.8.0'
+spec.add_runtime_dependency 'ms_rest_azure', '~> 0.8.2'
 ```
 Don't forget to correct the version.
 
+# Utilizing MSI(Managed Service Identity) Token Provider
+
+MSI support has been enabled in `ms_rest_azure` version `0.8.2`. Below code snippet demonstrates how to use MSITokenProvider with default port `50342`:  
+
+```ruby
+provider = MsRestAzure::MSITokenProvider.new('{tenant_id}')
+credentials = MsRest::TokenCredentials.new(provider)
+```
+
 # Utilizing Telemetry Extension in your SDK
 
 We encourage the customer of ms_rest_azure library to provide information about their product sent via telemetry extension point as below:

data/lib/ms_rest_azure.rb

@@ -11,6 +11,7 @@ require 'ms_rest_azure/azure_operation_response.rb'
 require 'ms_rest_azure/azure_service_client.rb'
 require 'ms_rest_azure/cloud_error_data.rb'
 require 'ms_rest_azure/credentials/application_token_provider.rb'
+require 'ms_rest_azure/credentials/msi_token_provider.rb'
 require 'ms_rest_azure/polling_state.rb'
 require 'ms_rest_azure/sub_resource.rb'
 require 'ms_rest_azure/resource.rb'

data/lib/ms_rest_azure/credentials/application_token_provider.rb

@@ -45,7 +45,7 @@ module MsRestAzure
     # @param tenant_id [String] tenant id (also known as domain).
     # @param client_id [String] client id.
     # @param client_secret [String] client secret.
-    # @param settings [ActiveDirectoryServiceSettings] client secret.
+    # @param settings [ActiveDirectoryServiceSettings] active directory setting.
     def initialize(tenant_id, client_id, client_secret, settings = ActiveDirectoryServiceSettings.get_azure_settings)
       fail ArgumentError, 'Tenant id cannot be nil' if tenant_id.nil?
       fail ArgumentError, 'Client id cannot be nil' if client_id.nil?
@@ -81,7 +81,7 @@ module MsRestAzure
     end
 
     #
-    # Retrieves a new authenticaion token.
+    # Retrieves a new authentication token.
     #
     # @return [String] new authentication token.
     def acquire_token

data/lib/ms_rest_azure/credentials/msi_token_provider.rb

@@ -0,0 +1,112 @@
+# encoding: utf-8
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+
+module MsRestAzure
+  #
+  # Class that provides access to authentication token via Managed Service Identity.
+  #
+  class MSITokenProvider < MsRest::TokenProvider
+
+    private
+
+    TOKEN_ACQUIRE_URL = 'http://localhost:{port}/oauth2/token'
+    REQUEST_BODY_PATTERN = 'authority={authentication_endpoint}{tenant_id}&resource={resource_uri}'
+    DEFAULT_SCHEME = 'Bearer'
+
+    # @return [MSIActiveDirectoryServiceSettings] settings.
+    attr_accessor :settings
+
+    # @return [String] tenant id (also known as domain).
+    attr_accessor :tenant_id
+
+    # @return [Integer] port number where MSI service is running.
+    attr_accessor :port
+
+    # @return [String] auth token.
+    attr_accessor :token
+
+    # @return [Time] the date when the current token expires.
+    attr_accessor :token_expires_on
+
+    # @return [Integer] the amount of time we refresh token before it expires.
+    attr_reader :expiration_threshold
+
+    # @return [String] the type of token.
+    attr_reader :token_type
+
+    public
+
+    #
+    # Creates and initialize new instance of the MSITokenProvider class.
+    # @param tenant_id [String] tenant id (also known as domain).
+    # @param port [Integer] port number where MSI service is running.
+    # @param settings [ActiveDirectoryServiceSettings] active directory setting.
+    def initialize(tenant_id, port = 50342, settings = ActiveDirectoryServiceSettings.get_azure_settings)
+      fail ArgumentError, 'Tenant id cannot be nil' if tenant_id.nil?
+      fail ArgumentError, 'Port cannot be nil' if port.nil?
+      fail ArgumentError, 'Port must be an Integer' unless port.is_a? Integer
+      fail ArgumentError, 'Azure AD settings cannot be nil' if settings.nil?
+
+      @tenant_id = tenant_id
+      @port = port
+      @settings = settings
+
+      @expiration_threshold = 5 * 60
+    end
+
+    #
+    # Returns the string value which needs to be attached
+    # to HTTP request header in order to be authorized.
+    #
+    # @return [String] authentication headers.
+    def get_authentication_header
+      acquire_token if token_expired
+      "#{token_type} #{token}"
+    end
+
+    private
+
+    #
+    # Checks whether token is about to expire.
+    #
+    # @return [Bool] True if token is about to expire, false otherwise.
+    def token_expired
+      @token.nil? || Time.now >= @token_expires_on + expiration_threshold
+    end
+
+    #
+    # Retrieves a new authentication token.
+    #
+    # @return [String] new authentication token.
+    def acquire_token
+      token_acquire_url = TOKEN_ACQUIRE_URL.dup
+      token_acquire_url['{port}'] = @port.to_s
+
+      url = URI.parse(token_acquire_url)
+
+      connection = Faraday.new(:url => url, :ssl => MsRest.ssl_options) do |builder|
+        builder.adapter Faraday.default_adapter
+      end
+
+      request_body = REQUEST_BODY_PATTERN.dup
+      request_body['{authentication_endpoint}'] = ERB::Util.url_encode(@settings.authentication_endpoint)
+      request_body['{tenant_id}'] = ERB::Util.url_encode(@tenant_id)
+      request_body['{resource_uri}'] = ERB::Util.url_encode(@settings.token_audience)
+
+      response = connection.post do |request|
+        request.headers['content-type'] = 'application/x-www-form-urlencoded'
+        request.body = request_body
+      end
+
+      fail AzureOperationError,
+        'Couldn\'t acquire access token from Managed Service Identity, please verify your tenant id, port and settings' unless response.status == 200
+
+      response_body = JSON.load(response.body)
+      @token = response_body['access_token']
+      @token_expires_on = Time.at(Integer(response_body['expires_on']))
+      @token_type = response_body['token_type']
+    end
+  end
+
+end

data/lib/ms_rest_azure/version.rb

@@ -3,5 +3,5 @@
 # Licensed under the MIT License. See License.txt in the project root for license information.
 
 module MsRestAzure
-  VERSION = '0.8.1'
+  VERSION = '0.8.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ms_rest_azure
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Microsoft Corporation
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-10 00:00:00.000000000 Z
+date: 2017-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,6 +126,7 @@ files:
 - lib/ms_rest_azure/azure_service_client.rb
 - lib/ms_rest_azure/cloud_error_data.rb
 - lib/ms_rest_azure/credentials/application_token_provider.rb
+- lib/ms_rest_azure/credentials/msi_token_provider.rb
 - lib/ms_rest_azure/polling_state.rb
 - lib/ms_rest_azure/resource.rb
 - lib/ms_rest_azure/serialization.rb