oxd-ruby 0.1.8 → 0.1.9

data/lib/oxd/oxd_connector.rb

@@ -5,7 +5,7 @@ require 'json'
 require 'uri'
 
 # @author Inderpal Singh
-# @note supports oxd-version 2.4.4
+# @note supports oxd-version 3.1.1
 module Oxd
 
 	# A class which takes care of the socket communication with oxD Server.
@@ -19,7 +19,8 @@ module Oxd
 	    	@data = Hash.new
 	    	@params = Hash.new
 	    	@response_data = Hash.new
-	    	@configuration = Oxd.config		    	
+	    	@configuration = Oxd.config
+
 			logger(:log_msg => "Problem with json data : authorization_redirect_uri can't be blank") if @configuration.authorization_redirect_uri.empty?
 			logger(:log_msg => "#{@configuration.oxd_host_ip} is not a valid IP address") if (IPAddr.new(@configuration.oxd_host_ip) rescue nil).nil?
 			logger(:log_msg => "#{@configuration.oxd_host_port} is not a valid port for socket. Port must be integer and between from 0 to 65535") if (!@configuration.oxd_host_port.is_a?(Integer) || (@configuration.oxd_host_port < 0 && @configuration.oxd_host_port > 65535))	
@@ -27,7 +28,7 @@ module Oxd
 
 	    # Checks the validity of command that is to be passed to oxd-server
 	    def validate_command
-	    	command_types = ['get_authorization_url','update_site_registration', 'get_tokens_by_code','get_user_info', 'register_site', 'get_logout_uri','get_authorization_code','uma_rs_protect','uma_rs_check_access','uma_rp_get_rpt','uma_rp_authorize_rpt','uma_rp_get_gat']
+	    	command_types = ['setup_client', 'get_client_token', 'get_authorization_url','update_site_registration','get_tokens_by_code','get_access_token_by_refresh_token', 'get_user_info', 'register_site', 'get_logout_uri','get_authorization_code','uma_rs_protect','uma_rs_check_access','uma_rp_get_rpt','uma_rp_get_claims_gathering_url']
 	    	if (!command_types.include?(@command))
 				logger(:log_msg => "Command: #{@command} does not exist! Exiting process.")
         	end
@@ -64,19 +65,25 @@ module Oxd
 		end
 		
 		# method to communicate with the oxD-to-http server
-		# @param request [JSON] representation of the JSON command string
-		# @param char_count [Integer] number of characters to read from response
+		# @param request_params [JSON] representation of the JSON command string
 		# @return response from the oxD-to-http server
-		def oxd_http_request(requst, command = "")
+		def oxd_http_request(request_params, command = "")
 			uri = URI.parse("https://127.0.0.1/"+command)
 			http = Net::HTTP.new("127.0.0.1", 8443)
 			http.use_ssl = true
 			http.verify_mode = OpenSSL::SSL::VERIFY_NONE
 			request = Net::HTTP::Post.new(uri.request_uri)
+
 			request.add_field('Content-Type', 'application/json')
-			request.body = requst
+
+			if(@configuration.protection_access_token.present?)
+				request.add_field('Authorization','Bearer '+@configuration.protection_access_token)
+			end
+			request.body = request_params
+			logger(:log_msg => "Sending oxd_http_request command #{command} with data #{request_params.inspect}", :error => "")
 			response = http.request(request)
 			response2 = response.body
+			logger(:log_msg => "oxd_http_request response #{response2}", :error => "")
 			return response2
 		end
 
@@ -89,7 +96,7 @@ module Oxd
 			logger(:log_msg => "Please enable SSL on your website or check URIs in Oxd configuration.") if (uri.scheme != 'https')
 	    	validate_command
 	    	
-	    	if(@configuration.oxd_host_port == 8099)
+	    	if(@configuration.connection_type == 'local')
 				jsondata = getData.to_json
 				if(!is_json? (jsondata))
 					logger(:log_msg => "Sending parameters must be JSON. Exiting process.")
@@ -163,8 +170,7 @@ module Oxd
  		end
 
  		# Logs server response and errors to log file
- 		# @param log_msg [Hash] response to print in log file
- 		# @param error [Hash] error message to print in log file
+ 		# @param args [Hash] {:log_msg, :error} response to print in log file and raise error
  		# @raise RuntimeError
  		def logger(args={})
  			# Initialize Log file

data/lib/oxd/uma_commands.rb

@@ -1,5 +1,5 @@
 # @author Inderpal Singh
-# @note supports oxd-version 2.4.4
+# @note supports oxd-version 3.1.1
 module Oxd
 
 	require 'json'
@@ -21,8 +21,8 @@ module Oxd
 		#   condition2 = {:httpMethods => ["PUT", "POST"], :scopes => ["http://photoz.example.com/dev/actions/all","http://photoz.example.com/dev/actions/add"],:ticketScopes => ["http://photoz.example.com/dev/actions/add"]}
 		#   uma_add_resource("/photo", condition1, condition2)
 		# combines multiple resources into @resources array to pass to uma_rs_protect method
-		def uma_add_resource(path, *conditions)
-		    @resources.push({:path => path, :conditions => conditions})
+		def uma_add_resource(path, *conditions)			
+		    @resources.push({:path => path, :conditions => conditions})			
 		end
 
 		# @return [STRING] oxd_id
@@ -30,28 +30,45 @@ module Oxd
 		# method to protect resources with UMA resource server
 		def uma_rs_protect
 			logger(:log_msg => "Please set resources with uma_add_resource(path, *conditions) method first.") if(@resources.nil?)
+			logger(:log_msg => "UMA configuration #{@configuration}", :error => '')
 			@command = 'uma_rs_protect'
 			@params = {
 				"oxd_id" => @configuration.oxd_id,
-				"resources" => @resources
+				"resources" => @resources,
+				"protection_access_token" => @configuration.protection_access_token
 			}
-	        request
+	        request('uma-rs-protect')
 	        getResponseData['oxd_id']
 		end
 
-		# @param force_new [BOOLEAN] REQUIRED
-		# @return [STRING] RPT
-		# @raise RuntimeError if force_new param is not boolean
+		# @param claim_token [STRING] OPTIONAL
+		# @param claim_token_format [STRING] OPTIONAL
+		# @param pct [STRING] OPTIONAL
+		# @param rpt [STRING] OPTIONAL
+		# @param scope [STRING] OPTIONAL
+		# @param state [STRING] OPTIONAL, state that is returned from uma_rp_get_claims_gathering_url command
+		# @return [Hash] response data (access_token, token_type, pct, upgraded)
 		# method for obtaining RPT to gain access to protected resources at the UMA resource server
-		def uma_rp_get_rpt(force_new) 
-			logger(:log_msg => "Wrong value for force_new param. #{force_new.kind_of?(TrueClass)}") if(force_new.kind_of?(TrueClass) || force_new.kind_of?(FalseClass))
+		def uma_rp_get_rpt( claim_token = nil, claim_token_format = nil, pct = nil, rpt = nil, scope = nil, state = nil )
 			@command = 'uma_rp_get_rpt'
 			@params = {
 				"oxd_id" => @configuration.oxd_id,
-				"force_new" => force_new
+				"ticket" => @configuration.ticket,
+				"claim_token" => claim_token,
+				"claim_token_format" => claim_token_format,
+				"pct" => pct,
+				"rpt" => (!rpt.nil?)? rpt : @configuration.rpt,
+				"scope" => scope,
+				"state" => state,
+				"protection_access_token" => @configuration.protection_access_token
 	        }
-	        request
-	        @configuration.rpt = getResponseData['rpt']
+	        request('uma-rp-get-rpt')
+	        
+	        if getResponseData['error'] == 'need_info' && !getResponseData['details']['ticket'].empty?
+	        	@configuration.ticket = getResponseData['details']['ticket']	        
+	        end
+
+	        getResponseData
 		end
 
 		# @param path [STRING] REQUIRED
@@ -67,47 +84,34 @@ module Oxd
 				"oxd_id" => @configuration.oxd_id,
 				"rpt" => @configuration.rpt,
 				"path" => path,
-				"http_method" => http_method
+				"http_method" => http_method,
+				"protection_access_token" => @configuration.protection_access_token
 	        }
-	        request
+	        request('uma-rs-check-access')
 	        if getResponseData['access'] == 'denied' && !getResponseData['ticket'].empty?
 	        	@configuration.ticket = getResponseData['ticket']
 	        elsif getResponseData['access'] == 'granted' 
 	        	@configuration.ticket = ""
 	        end
 	        getResponseData
-		end	
-
-		# @return [String] oxd_id 
-		# @note This method should always be called after uma_rp_get_rpt and uma_rs_check_access methods
-		# Method to authorize generated RPT using oxd_id and ticket.
-		def uma_rp_authorize_rpt
-			@command = 'uma_rp_authorize_rpt'
-			@params = {
-				"oxd_id" => @configuration.oxd_id,
-				"rpt" => @configuration.rpt,
-				"ticket" => @configuration.ticket
-	        }
-	        request
-	        getResponseData['oxd_id']
 		end
 
-		# @param scopes [Array] REQUIRED
-		# @return [String] rpt 
-		# @example
-		# 	scopes = ["http://photoz.example.com/dev/actions/add","http://photoz.example.com/dev/actions/view"]
-		# 	uma_rp_get_gat(scopes)
-		# method to obtain GAT (Gluu Access Token)
-		def uma_rp_get_gat(scopes)
-			logger(:log_msg => "Invalid value for scopes argument.") if(!scopes.kind_of? Array)
-			@command = 'uma_rp_get_gat'
+		# @param claims_redirect_uri [STRING] REQUIRED
+		# @return [Hash] response data (url, state)
+		# method to check if we have permission to access particular resource or not
+		def uma_rp_get_claims_gathering_url( claims_redirect_uri )
+			if (claims_redirect_uri.empty?)
+            	logger(:log_msg => "Empty/Wrong value in place of claims_redirect_uri.")
+        	end
+			@command = 'uma_rp_get_claims_gathering_url'
 			@params = {
 				"oxd_id" => @configuration.oxd_id,
-				"scopes" => scopes
+				"ticket" => @configuration.ticket,
+				"claims_redirect_uri" => claims_redirect_uri,
+				"protection_access_token" => @configuration.protection_access_token
 	        }
-	        request
-	        logger(:log_msg => "Invalid GAT recieved : #{getResponseData['rpt']}") if(!getResponseData['rpt'].match(/gat_/)[0])
-	        getResponseData['rpt']
-		end
+	        request('uma-rp-get-claims-gathering-url')	        
+	        getResponseData
+		end			
 	end
 end

data/lib/oxd/version.rb

@@ -1,4 +1,4 @@
 # Gem version
 module Oxd
-    VERSION = "0.1.8"
+    VERSION = "0.1.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oxd-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - inderpal6785
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-17 00:00:00.000000000 Z
+date: 2017-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,6 +84,7 @@ files:
 - Rakefile
 - demosite/.gitignore
 - demosite/Gemfile
+- demosite/Gemfile.lock
 - demosite/README.md
 - demosite/Rakefile
 - demosite/app/assets/images/.keep