oxd-ruby 0.1.3

data/lib/oxd/config.rb

@@ -0,0 +1,94 @@
+require 'active_support/configurable'
+
+# @author Inderpal Singh
+# @note supports oxd-version 2.4.3
+module Oxd
+
+  # Configures global settings for Oxd
+  # @yield config
+  # @example
+  #   Oxd.configure do |config|
+  #     config.oxd_host_ip = '127.0.0.1'
+  #   end
+  def self.configure(&block)
+    @config ||= Oxd::Configuration.new
+    if block_given?
+      yield(@config)
+    end
+  end
+
+  # Global settings for Oxd
+  def self.config
+    @config
+  end
+
+  # This class holds all the information about the client and the OP metadata
+  class Configuration
+    include ActiveSupport::Configurable    
+    config_accessor :oxd_host_ip
+    config_accessor :oxd_host_port
+    config_accessor :application_type
+    config_accessor :authorization_redirect_uri
+    config_accessor :redirect_uris
+    config_accessor :post_logout_redirect_uri
+    config_accessor :client_logout_uris
+    config_accessor :logout_redirect_uri
+    config_accessor :grant_types
+    config_accessor :acr_values
+    config_accessor :client_jwks_uri
+    config_accessor :client_token_endpoint_auth_method
+    config_accessor :client_request_uris
+    config_accessor :scope
+    config_accessor :contacts
+    config_accessor :response_types
+    config_accessor :oxd_id
+
+    # define param_name writer
+    def param_name
+      config.param_name.respond_to?(:call) ? config.param_name.call : config.param_name
+    end
+    
+    writer, line = 'def param_name=(value); config.param_name = value; end', __LINE__
+    singleton_class.class_eval writer, __FILE__, line
+    class_eval writer, __FILE__, line
+  end
+
+  #[oxd]
+  # oxd_host_ip : the host is generally localhost as all communication are carried out between oxd-ruby and oxd server using sockets.
+  # oxd_host_port: the port is the one which is configured during the oxd deployment
+  
+  #[client]
+  # application_type: the app_type is generally 'web' although 'native' can be used for native app
+  # authorization_redirect_uri: [REQUIRED] this is the primary redirect URL of the website or app
+  # redirect_uris: [OPTIONAL, LIST] other redirect uris that the website can use - given as comma seperated values.
+  # => the first one is always your primary uri set in authorization_redirect_uri
+  # post_logout_redirect_uri: [OPTIONAL] website's public uri to call upon logout
+  # client_logout_uris:  [REQUIRED, LIST] logout uris of the client
+  # grant_types: [OPTIONAL, LIST] grant types to "authorization_code" or "refresh_token"
+  # acr_values: [OPTIONAL, LIST] the values are "basic" and "duo"
+  # client_jwks_uri: [OPTIONAL]
+  # client_token_endpoint_auth_method: [OPTIONAL]
+  # client_request_uris: [OPTIONAL]
+  # contacts: [OPTIONAL, LIST]
+  
+  # default values for config
+  configure do |config|
+  	config.oxd_host_ip = '127.0.0.1' 
+  	config.oxd_host_port = 8099 
+  	config.application_type = "web"
+  	config.authorization_redirect_uri = "https://gluu.example.com/callback"
+  	config.redirect_uris = ["https://gluu.example.com/callback","https://gluu.example.com/callback2"]
+  	config.post_logout_redirect_uri = "https://gluu.example.com/logout"
+  	config.client_logout_uris = ["https://gluu.example.com/callback"]
+  	config.logout_redirect_uri = 'https://gluu.example.com/logout'
+  	config.grant_types = []
+  	config.acr_values = [ "basic" ]
+  	config.client_jwks_uri = ""
+  	config.client_token_endpoint_auth_method = ""
+  	config.client_request_uris = []
+  	config.scope = [ "openid", "profile" ]
+  	config.contacts = ["example-email@gmail.com"]
+  	config.response_types = ["code"]
+    config.oxd_id = ""
+  end 
+end

data/lib/oxd/oxd_connector.rb

@@ -0,0 +1,133 @@
+require 'socket'
+require 'ipaddr'
+
+# @author Inderpal Singh
+# @note supports oxd-version 2.4.3
+module Oxd
+
+	# A class which takes care of the socket communication with oxD Server.
+	class OxdConnector
+
+	    # class constructor
+	    def initialize
+  			@command	    	
+	    	@response_json
+	    	@response_object
+	    	@data = Hash.new
+	    	@params = Hash.new
+	    	@response_data = Hash.new
+	    	@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))	
+	    end
+
+	    # 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']
+	    	if (!command_types.include?(@command))
+				logger(:log_msg => "Command: #{@command} does not exist! Exiting process.")
+        	end
+	    end
+
+		# method to communicate with the oxD server
+		# @param request [JSON] representation of the JSON command string
+		# @param char_count [Integer] number of characters to read from response
+		# @return response from the oxD Server
+		def oxd_socket_request(request, char_count = 8192)
+			host = @configuration.oxd_host_ip     # The web server
+			port = @configuration.oxd_host_port   # Default HTTP port
+
+			if(!socket = TCPSocket.new(host, port) )  # Connect to Oxd server
+				logger(:log_msg => "Socket Error : Couldn't connect to socket ")
+			else
+				logger(:log_msg => "Client: socket::socket_connect connected : #{request}", :error => "")
+			end
+			
+			socket.print(request)               # Send request
+			response = socket.recv(char_count)  # Read response
+			if(response)
+				logger(:log_msg => "Client: oxd_socket_response: #{response}", :error => "")
+	        else
+				logger(:log_msg => "Client: oxd_socket_response : Error socket reading process.")
+	        end
+	        # close connection
+	        if(socket.close)
+	        	logger(:log_msg => "Client: oxd_socket_connection : disconnected.", :error => "")
+	        end
+	        return response
+		end
+
+		# method to send commands to the oxD server and to recieve the response via {#oxd_socket_request}
+		# @return [JSON] @response_object : response from the oxd server in JSON form
+	    def request
+	    	validate_command
+	    	jsondata = getData.to_json
+	    	if(!is_json? (jsondata))
+	    		logger(:log_msg => "Sending parameters must be JSON. Exiting process.")
+	        end
+	        length = jsondata.length
+	        if( length <= 0 )
+	    		logger(:log_msg => "JSON data length must be more than zero. Exiting process.")
+	        else
+	            length = length <= 999 ? sprintf('0%d', length) : length
+	        end
+	        @response_json = oxd_socket_request((length + jsondata).encode("UTF-8"))
+	        @response_json.sub!(@response_json[0..3], "")
+
+	        if (@response_json)
+	            response = JSON.parse(@response_json)
+	            if (response['status'] == 'error') 
+	    			logger(:log_msg => "OxD Server Error : #{response['data']['error_description']}")
+	            elsif (response['status'] == 'ok') 
+	                @response_object = JSON.parse(@response_json)
+	            end
+	        else
+	        	logger(:log_msg => "Response is empty. Exiting process.")
+	        end
+	        return @response_object
+	    end
+
+	    # extracts 'data' parameter from @response_object
+	    # @return [Mixed] @response_data
+	    def getResponseData
+	    	if (!@response_object)
+	            @response_data = 'Data is empty';
+	        else
+	            @response_data = @response_object['data']
+	        end
+	        return @response_data
+	    end
+
+	    # combines command and command parameters for socket request
+	    # @return [Array] @data
+	    def getData
+	    	@data = {'command' => @command, 'params' => @params}
+        	return @data
+	    end
+
+    	# checks whether the passed string is in JSON format or not
+    	# @param  string_to_validate [String]
+    	# @return [Boolean]
+ 		def is_json? (string_to_validate)
+ 			begin
+		      !!JSON.parse(string_to_validate)
+		    rescue
+		      false
+		    end 			
+ 		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
+ 		# @raise RuntimeError
+ 		def logger(args={})
+ 			# Initialize Log file
+			# Location : app_root/log/oxd-ruby.log
+			@logger ||= Logger.new("log/oxd-ruby.log")
+			@logger.info(args[:log_msg])
+
+			raise (args[:error] || args[:log_msg]) if args[:error] != ""
+		end		
+	end
+end

data/lib/oxd/version.rb

@@ -0,0 +1,4 @@
+# Gem version
+module Oxd
+    VERSION = "0.1.3"
+end

data/oxd-ruby.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'oxd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "oxd-ruby"
+  spec.version       = Oxd::VERSION
+  spec.authors       = ["inderpal6785"]
+  spec.email         = ["inderpal6785@gmail.com"]
+
+  spec.summary       = %q{Ruby Client Library for Oxd Server - OpenID Connect Client RP Middleware, which organizes authentication and registration of users.}
+  spec.homepage      = "https://github.com/GluuFederation/oxd-ruby"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-rails"
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: oxd-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- inderpal6785
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- inderpal6785@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- demosite/.gitignore
+- demosite/Gemfile
+- demosite/Gemfile.lock
+- demosite/README.md
+- demosite/Rakefile
+- demosite/app/assets/images/.keep
+- demosite/app/assets/javascripts/application.js
+- demosite/app/assets/javascripts/bootstrap.js.coffee
+- demosite/app/assets/stylesheets/application.css
+- demosite/app/assets/stylesheets/bootstrap_and_overrides.css
+- demosite/app/controllers/application_controller.rb
+- demosite/app/controllers/concerns/.keep
+- demosite/app/controllers/home_controller.rb
+- demosite/app/helpers/application_helper.rb
+- demosite/app/mailers/.keep
+- demosite/app/models/.keep
+- demosite/app/models/concerns/.keep
+- demosite/app/views/home/index.html.erb
+- demosite/app/views/layouts/application.html.erb
+- demosite/bin/bundle
+- demosite/bin/rails
+- demosite/bin/rake
+- demosite/bin/setup
+- demosite/bin/spring
+- demosite/config.ru
+- demosite/config/application.rb
+- demosite/config/boot.rb
+- demosite/config/database.yml
+- demosite/config/environment.rb
+- demosite/config/environments/development.rb
+- demosite/config/environments/production.rb
+- demosite/config/environments/test.rb
+- demosite/config/initializers/assets.rb
+- demosite/config/initializers/backtrace_silencers.rb
+- demosite/config/initializers/cookies_serializer.rb
+- demosite/config/initializers/filter_parameter_logging.rb
+- demosite/config/initializers/inflections.rb
+- demosite/config/initializers/mime_types.rb
+- demosite/config/initializers/oxd_config.rb
+- demosite/config/initializers/session_store.rb
+- demosite/config/initializers/wrap_parameters.rb
+- demosite/config/locales/en.bootstrap.yml
+- demosite/config/locales/en.yml
+- demosite/config/routes.rb
+- demosite/config/secrets.yml
+- demosite/db/seeds.rb
+- demosite/lib/assets/.keep
+- demosite/lib/tasks/.keep
+- demosite/log/.keep
+- demosite/public/404.html
+- demosite/public/422.html
+- demosite/public/500.html
+- demosite/public/favicon.ico
+- demosite/public/robots.txt
+- demosite/test/controllers/.keep
+- demosite/test/fixtures/.keep
+- demosite/test/helpers/.keep
+- demosite/test/integration/.keep
+- demosite/test/mailers/.keep
+- demosite/test/models/.keep
+- demosite/test/test_helper.rb
+- demosite/vendor/assets/javascripts/.keep
+- demosite/vendor/assets/stylesheets/.keep
+- lib/generators/oxd/config_generator.rb
+- lib/generators/oxd/templates/oxd_config.rb
+- lib/oxd-ruby.rb
+- lib/oxd/client_oxd_commands.rb
+- lib/oxd/config.rb
+- lib/oxd/oxd_connector.rb
+- lib/oxd/version.rb
+- oxd-ruby.gemspec
+homepage: https://github.com/GluuFederation/oxd-ruby
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Ruby Client Library for Oxd Server - OpenID Connect Client RP Middleware,
+  which organizes authentication and registration of users.
+test_files: []
+has_rdoc: