oxd-ruby 0.1.9 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a6f9d21c4d5fd1f1e0e893595e97985749bd94e8
-  data.tar.gz: 4fba31e51faf898d93a42180e74786ecf50598e1
+SHA256:
+  metadata.gz: 44810d1d51584267d4eb543925ea5659b1288398d3d639ec87c0b315e618c3a6
+  data.tar.gz: 685bee8e40f0e64f5d3eb85148515ece3106bb5995ec730f121de439b8ac92b6
 SHA512:
-  metadata.gz: bba06880ed389a598e3a6aae0561af20741416875fe017e8643ab3b2078ac784d56cc560a2ac7e3276febb880d092bdb54afa3cdc8742e3c2fa8594a023a90cd
-  data.tar.gz: 8ab4c90bdf20239d69c9c3e7b5d63bfc7d16b524e87c54d029a53b0b3c6627cf6430b2b92b8b47e8636be0353dd63cb0bfc570e39f5ee584c721e15f87cdd1e6
+  metadata.gz: 63450ead6ca0d9c7c26e86fc8771f215ee3c8247f8fe0701eae65fb7e5fe7ab235740b0b8753e4912e69bb6ae244ab1526049ad49da2be06395eaa219551fe76
+  data.tar.gz: 8c5f0c1bf3f28d459a28cfa06d4315a366bd1a180c5a6ba7262e61bb746ebe46f40d602b872f55cd46edf4741c78b5c54f2ee545de34a6ea9c734d2c3ebec340

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+log/

data/CHANGELOG.md

@@ -1,6 +1,22 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [1.0.2] - 2018-03-05
+### Added
+- support for "client_credentials" `grant_type`
+- new `update_site` command
+- new `remove_site` command
+- new `introspect_access_token` command
+- new `introspect_rpt` command
+- `client_frontchannel_logout_uris` and `claims_redirect_uri` parameters in `setup_client` and `register_site` commands
+- `op_discovery_path` parameter in `get_client_token` command
+
+### Removed
+- `update_site_registration` command
+- `client_logout_uris` and `oxd_rp_programming_language` parameters from `setup_client` command
+- `oxd_id`, `authorization_redirect_uri`, `post_logout_redirect_uri`, `application_type`, `response_types`, `grant_types`, `acr_values`, `client_name`, `client_jwks_uri`, `client_token_endpoint_auth_method`, `client_request_uris`, `client_sector_identifier_uri`, `contacts`, `ui_locales`, `claims_locales`, `client_logout_uris` and `oxd_rp_programming_language` parameters from `get_client_token` command
+- `client_logout_uris` parameter from `register_site` command
+
 ## [0.1.9] - 2017-10-17
 ### Added
 - support for oxd-to-https

data/README.md

@@ -1,243 +1,5 @@
-# Oxd Ruby
-[![Gem Version](https://badge.fury.io/rb/oxd-ruby.png)](https://badge.fury.io/rb/oxd-ruby)
+# oxd-Ruby
 
-Ruby Client Library for the [Gluu oxD Server RP - v3.1.1](https://gluu.org/docs/oxd/3.1.1).
+oxd-Ruby is a client library for Gluu's OpenID Connect and UMA client software, [oxd](https://gluu.org/docs/oxd/3.1.2/). 
 
-**oxdruby** is a thin wrapper around the communication protocol of oxD server. This can be used to access the OpenID connect & UMA Authorization end points of the Gluu Server via the oxD RP. This library provides the function calls required by a website to access user information from a OpenID Connect Provider (OP) by using the OxD as the Relying Party (RP).
-
-## Using the Library in your website
-
-> You are now on the `master` branch. If you want to use `oxd-ruby` for production use, switch to the branch of the matching version as the `oxd-server` you are installing.
-
-[oxD RP](https://gluu.org/docs/oxd/3.1.1) has complete information about the Code Authorization flow and the various details about oxD RP configuration. This document provides only documentation about the oxd-ruby library.
-
-### Prerequisites
-
-* A valid OpenID Connect Provider (OP), like the Gluu Server or Google.
-* An active installation of the oxd-server running on the same server as the client application.
-* An active installation of the oxd-https-extension if oxd-https-extension connection is used. In this case, client applications can be on different servers but will be able to access oxd-https-extension.
-
-
-### Installation
-
-To install gem, add this line to your application's Gemfile:
-
-```ruby
-gem 'oxd-ruby', '~> 0.1.9'
-```
-
-Run bundle command to install it:
-
-```bash
-$ bundle install
-```
-#### Important Links
-
-- See the [API docs](https://gluu.org/docs/oxd/3.1.1/libraries/ruby/) for in-depth information about the various functions and their parameters.
-- See the code of a [sample Ruby on Rails app](https://github.com/GluuFederation/oxd-ruby/tree/master/demosite) built using oxd-ruby.
-
-### Configuring
-
-After you installed oxd-ruby, you need to run the generator command to generate the configuration file:
-
-```bash
-$ rails generate oxd:config
-```
-
-The generator will install `oxd_config.rb` initializer file in `config/initializers` directory which conatins all the global configuration options for oxd-ruby plguin. The generated configuration file looks like this: 
-
-```ruby
-config.oxd_host_ip = '127.0.0.1'
-config.oxd_host_port = 8099
-config.op_host = "https://your.openid.provider.com"
-config.client_id = "<client_id of OpenId provider>"
-config.client_secret = "<client_secret of OpenId provider>"
-config.client_name = "Gluu Oxd Sample Client"
-config.authorization_redirect_uri = "https://domain.example.com/callback"
-config.logout_redirect_uri = "https://domain.example.com/callback2"
-config.post_logout_redirect_uri = "https://domain.example.com/logout"
-config.scope = ["openid","profile", "email", "uma_protection","uma_authorization"]
-config.grant_types = []
-config.application_type = "web"
-config.response_types = ["code"]
-config.acr_values = ["basic"]
-config.client_jwks_uri = ""
-config.client_token_endpoint_auth_method = ""
-config.client_request_uris = []
-config.contacts = ["example-email@gmail.com"]
-config.client_logout_uris = ['https://domain.example.com/logout']
-config.oxd_host = "https://127.0.0.1:8443" set if you are using oxd-https extension
-config.connection_type = "local" if you are using oxd-server without oxd-https extension otherwise "web"
-config.dynamic_registration	= true if the op_host supports dynamic registration otherwise 'false'
-```
-The following configuration must be set in config file before the gem can be used:
-
-- config.oxd_host_ip
-- config.oxd_host_port
-- config.op_host
-- config.authorization_redirect_uri
-- config.client_id
-- config.client_secret
-- config.connection_type
-- config.oxd_host
-
-**Note :** client_id and client_secret must be set if your OpenID provider does not support dynamic registration, otherwise can be left blank.
-
-## Usage
-
-Add following snippet to your `application_controller.rb` file:
-
-```ruby
-require 'oxd-ruby'
-
-before_filter :set_oxd_commands_instance
-protected
-	def set_oxd_commands_instance
-		@oxd_command = Oxd::ClientOxdCommands.new
-		@uma_command = Oxd::UMACommands.new
-		@oxdConfig = @oxd_command.oxdConfig
-	end
-```
-
-The `ClientOxdCommands` class of the library provides all the methods required for the website to communicate with the oxD RP through sockets. The `oxdConfig` method returns Oxd Configuration object.
-The `UMACommands` class provides commands for UMA Resource Server(UMA RS) and UMA Requesting Party(UMA RP) protocol.
-
-### Setup Client
-
-In order to use an OpenID Connect Provider (OP) for login, you need to setup your client application at the OP. During setup oxd will dynamically register the OpenID Connect client and save its configuration. Upon successful setup a unique identifier will be issued by the oxd server by assigning a specific oxd id. Along with oxd Id oxd server will also return client Id and client secret. This client Id and client secret can be used for `get_client_token` method. The Setup Client method is a one time task to configure a client in the oxd server and OP.
-
-**Note:** If your OpenID Connect Provider does not support dynamic registration (like Google), you will need to obtain a ClientID and Client Secret which can be set in `oxd_config.rb` initializer file.
-
-```ruby
-@oxd_command.setup_client
-```
-
-### Get Client Token
-
-The `get_client_token` method is used to get a token which is sent as `protection_access_token` for other methods when the `protect_commands_with_access_token` is enabled in oxd-server.
-
-> `get_client_token` command must be invoked to use following methods when the `protect_commands_with_access_token` is enabled in oxd-server.
-
-```ruby
-@oxd_command.get_client_token
-```
-
-### Website Registration
-
-In order to use an OpenID Connect Provider (OP) for login, you need to register your client application at the OP. During registration oxd will dynamically register the OpenID Connect client and save its configuration. Upon successful registration a unique identifier will be issued by the oxd server. The Register Site method is a one time task to configure a client in the oxd server and OP.
-
-**Note:** If your OpenID Connect Provider does not support dynamic registration (like Google), you will need to obtain a ClientID and Client Secret which can be set in `oxd_config.rb` initializer file.
-
-```ruby
-@oxd_command.register_site
-```
-
-### Get Authorization URL
-
-The `get_authorization_url` method returns the OpenID Connect Provider authentication URL to which the client application must redirect the user to authorize the release of personal data. The response URL includes state value, which can be used to obtain tokens required for authentication. This state value is used 
-to maintain state between the request and the callback.
-
-```ruby
-authorization_url = @oxd_command.get_authorization_url
-```
-Using the above url the website can redirect the user for authentication at the OpenId Provider. 
-
-### Get access token
-
-Upon successful login, the login result will return code and state. `get_tokens_by_code` uses code and state to retrieve token which can be used to access user claims.
-
-```ruby
-code = params[:code]
-state = params[:state]
-access_token = @oxd_command.get_tokens_by_code( code,state )
-```
-The values for code and state are parsed from the callback url query parameters.
-
-### Get Access Token by Refresh Token
-
-The `get_access_token_by_refresh_token` method is used to get a fresh access token and refresh token by using the refresh token which is obtained from `get_tokens_by_code` method.
-
-```ruby
-access_token = @oxd_command.get_access_token_by_refresh_token
-```
-
-### Get user claims
-
-Once the user has been authenticated by the OpenID Connect Provider, the `get_user_info` method returns Claims (Like First Name, Last Name, emailId, etc.) about the authenticated end user. Claims (user information fields) made availble by the OpenId Provider can be fetched using the access token obtained above.
-
-```ruby
-user = @oxd_command.get_user_info(access_token)
-```
-
-### Using the claims
-
-Once the user data is obtained, the various claims supported by the OpenId Provider can be used as required.
-
-```ruby
-<% user.each do |field,value| %>
-	<%= "#{field} : #{value}" %>
-<% end %>
-```
-The availability of various claims are completely dependent on the OpenId Provider.
-
-### Logging out
-
-Once the required work is done the user can be logged out of the system. `get_logout_uri` method returns the OpenID Connect Provider logout url.
-
-```ruby
-logout_uri = @oxd_command.get_logout_uri(state, session_state)
-```
-You can then redirect the user to obtained url to perform logout.
-
-## Using UMA commands
-
-### UMA Protect resources
-
-`uma_rs_protect` method is used for protecting resource with UMA Resource server. Resource server need to construct the command which will protect the resource. The command will contain api path, http methods (POST,GET, PUT) and scopes. Scopes can be mapped with authorization policy (uma_rpt_policies). If no authorization policy mapped, `uma_rs_check_access` method will always return access as granted.
-
-To protect resources with UMA Resource server, you need to add resources to library using `uma_add_resource(path, *conditions)` method. Then you can call following method to register resources for protection with UMA RS.
-
-```ruby
-@uma_command.uma_add_resource(path, *conditions)
-@uma_command.uma_rs_protect
-```
-
-### UMA Check access for a particular resource
-To check wether you have access to a particular resource on UMA Resource Sevrer or not, use following method:
-
-```ruby
-@uma_command.uma_rs_check_access(path, http_method)
-```
-
-### Get Requesting Party Token(RPT)
-To gain access to protected resources at the UMA resource server, you must first obtain RPT.
-
-**Method parameters:**
-
-- claim_token: (Optional)
-- claim_token_format: (Optional)
-- pct: (Optional)
-- rpt: (Optional)
-- scope: (Optional)
-- state: (Optional) state that is returned from uma_rp_get_claims_gathering_url method
-
-```ruby
-@uma_command.uma_rp_get_rpt
-```
-
-### UMA RP - Get Claims-Gathering URL
-
-**Method parameters:**
-
-- claims_redirect_uri: (Required)
-
-```ruby
-@uma_command.uma_rp_get_claims_gathering_url
-```
-
-## Logs
-You can find `oxd-ruby.log` file in `rails_app_root/log` folder. It contains all the logs about oxd-server connections, commands/data sent to server, recieved response and all the errors and exceptions raised.
-
-## Demo Site
-
-The **demosite** folder contains a demo Ruby on Rails application which uses the `oxd-ruby` library to demonstrate the usage of the library. The deployment instrctions for the demo site can be found inside the demosite's README file.
+For complete instructions on how to use oxd-ruby, please see the [oxd-ruby docs](https://gluu.org/docs/oxd/3.1.2/libraries/languages/ruby).

data/lib/generators/oxd/templates/oxd_config.rb

@@ -5,12 +5,13 @@ Oxd.configure do |config|
 	config.op_host					 			= "https://your.openid.provider.com"
 	config.client_id 							= ""
 	config.client_secret 						= ""
-	config.client_name 							= "Gluu Oxd Sample Client"
+	config.client_name 							= "Gluu oxd Sample Client"
+	config.op_discovery_path 					= ""
 	config.authorization_redirect_uri 			= "https://domain.example.com/callback"
-	config.logout_redirect_uri 		  			= "https://domain.example.com/callback2"
 	config.post_logout_redirect_uri	  			= "https://domain.example.com/logout"
+	config.claims_redirect_uri	  				= ["https://domain.example.com/claims"]
 	config.scope					  			= ["openid","profile", "email", "uma_protection","uma_authorization"]
-	config.grant_types							= []
+	config.grant_types							= ["authorization_code","client_credenitals"]
 	config.application_type       	  			= "web"
 	config.response_types     		  			= ["code"]
 	config.acr_values 				  			= ["basic"]
@@ -18,8 +19,7 @@ Oxd.configure do |config|
 	config.client_token_endpoint_auth_method	= ""
 	config.client_request_uris					= []
 	config.contacts								= ["example-email@gmail.com"]
-	config.client_logout_uris		  			= ['https://domain.example.com/logout']
-	config.oxd_host 							= ""
+	config.client_frontchannel_logout_uris		= ['https://domain.example.com/logout']
 	config.connection_type 						= "local"
 	config.dynamic_registration					= true
 end

data/lib/oxd-ruby.rb

@@ -1,12 +1,14 @@
 # load oxd components
+require 'oxd/version'
 require 'oxd/config'
+require 'oxd/errors'
 require 'oxd/oxd_connector'
 require 'oxd/client_oxd_commands'
 require 'oxd/uma_commands'
 
 # @author Inderpal Singh
 # Oxd Module namespace
-# oxd_version 3.1.1	
+# oxd_version 3.1.2	
 module Oxd
 	
 end

data/lib/oxd/client_oxd_commands.rb

@@ -1,12 +1,12 @@
 # @author Inderpal Singh
-# @note supports oxd-version 3.1.1
+# @note supports oxd-version 3.1.2
 module Oxd
 
 	require 'json'
 
-	# This class carries out the commands to talk with the oxD server.
-	# The oxD request commands are provided as class methods that can be called to send the command 
-	# 	to the oxD server via socket and the reponse is returned as a dict by the called method.
+	# This class carries out the commands to talk with the oxd server.
+	# The oxd request commands are provided as class methods that can be called to send the command 
+	# 	to the oxd server via socket and the reponse is returned as a dict by the called method.
 	class ClientOxdCommands < OxdConnector	
 
 		# class constructor
@@ -15,116 +15,69 @@ module Oxd
 		end
 
 		# @return [String] oxd_id of the registered website
-		# method to setup the client and generate a Client ID, Client Secret for the site
-		# works with oxd-to-https and oxd-server
+		# method to setup the client and generate a Client ID, Client Secret for the site		
 		def setup_client
 			@command = 'setup_client'
-			@params = {
-				"authorization_redirect_uri" => @configuration.authorization_redirect_uri,
-				"op_host" => @configuration.op_host,
-				"post_logout_redirect_uri" => @configuration.post_logout_redirect_uri,
-				"application_type" => @configuration.application_type,
-				"response_types"=> @configuration.response_types,
-	            "grant_types" => @configuration.grant_types,
-	            "scope" => @configuration.scope,
-	            "acr_values" => @configuration.acr_values,
-	            "client_jwks_uri" => @configuration.client_jwks_uri,
-				"client_name" => @configuration.client_name,
-				"client_token_endpoint_auth_method" => @configuration.client_token_endpoint_auth_method,
-				"client_request_uris" => @configuration.client_request_uris,
-				"client_logout_uris"=> @configuration.client_logout_uris,
-				"client_sector_identifier_uri" => @configuration.client_sector_identifier_uri,
-				"contacts" => @configuration.contacts,
-				"ui_locales" => @configuration.ui_locales,
-				"claims_locales" => @configuration.claims_locales,
-				"client_id" => @configuration.client_id,
-		        "client_secret" => @configuration.client_secret,
-		        "oxd_rp_programming_language" => 'ruby',
-				"protection_access_token" => @configuration.protection_access_token
-			}
+			@params = client_params.merge(register_params)
 			request('setup-client')
 	        @configuration.client_id = getResponseData['client_id']
 	        @configuration.client_secret = getResponseData['client_secret']
 	        @configuration.oxd_id = getResponseData['oxd_id']
-
 		end
 
 		# @return [String] oxd_id of the registered website
-		# method to register the website and generate a unique ID for that website
-		# works with oxd-to-https and oxd-server
+		# method to register the website and generate a unique ID for that website		
 		def register_site	
-			if(!@configuration.oxd_id.empty?) # Check if client is already registered
+			# Check if client is already registered
+			# @return registered oxd_id
+			if(!@configuration.oxd_id.empty?)
 				return @configuration.oxd_id
 			else
 				@command = 'register_site'
-				@params = {
-		        	"authorization_redirect_uri" => @configuration.authorization_redirect_uri,
-					"op_host" => @configuration.op_host,
-		            "post_logout_redirect_uri" => @configuration.post_logout_redirect_uri,
-		            "application_type" => @configuration.application_type,		            
-		            "response_types"=> @configuration.response_types,
-		            "grant_types" => @configuration.grant_types,
-		            "scope" => @configuration.scope,
-		            "acr_values" => @configuration.acr_values,
-		            "client_jwks_uri" => @configuration.client_jwks_uri,
-		            "client_token_endpoint_auth_method" => @configuration.client_token_endpoint_auth_method,
-		            "client_request_uris" => @configuration.client_request_uris,
-		            "client_logout_uris"=> @configuration.client_logout_uris,
-		            "contacts" => @configuration.contacts,
-		            "client_id" => @configuration.client_id,
-		            "client_secret" => @configuration.client_secret,
-					"client_name" => @configuration.client_name,
-					"client_sector_identifier_uri" => @configuration.client_sector_identifier_uri,
-					"ui_locales" => @configuration.ui_locales,
-					"claims_locales" => @configuration.claims_locales,
-					"protection_access_token" => @configuration.protection_access_token
-		        }
+				@params = client_params.merge(register_params)
+				@params = @params.merge({"protection_access_token" => @configuration.protection_access_token})
 		        request('register-site')
-		        logger(:log_msg => "OXD ID FROM setup_client : "+getResponseData['oxd_id'])
+		        logger("oxd Id from register_site : "+getResponseData['oxd_id'])
 		        @configuration.oxd_id = getResponseData['oxd_id']
 		    end	        
 		end
 
+		# @param op_discovery_path [STRING] OPTIONAL, op discovery path provided by OP
 		# @return [STRING] access_token
 		# method to generate the protection access token
 		# obtained access token is passed as protection_access_token to all further calls to oxd-https-extension
-		def get_client_token
+		def get_client_token(op_discovery_path = nil)
 			@command = 'get_client_token'
 			@params = {
-	        	"oxd_id" => @configuration.oxd_id,
-				"authorization_redirect_uri" => @configuration.authorization_redirect_uri,
 				"op_host" => @configuration.op_host,
-				"post_logout_redirect_uri" => @configuration.post_logout_redirect_uri,
-				"application_type" => @configuration.application_type,		            
-				"response_types"=> @configuration.response_types,
-				"grant_types" => @configuration.grant_types,
 				"scope" => @configuration.scope,
-				"acr_values" => @configuration.acr_values,
-				"client_name" => @configuration.client_name,
-				"client_jwks_uri" => @configuration.client_jwks_uri,
-				"client_token_endpoint_auth_method" => @configuration.client_token_endpoint_auth_method,
-				"client_request_uris" => @configuration.client_request_uris,
-				"client_sector_identifier_uri" => @configuration.client_sector_identifier_uri,
-				"contacts" => @configuration.contacts,
-				"ui_locales" => @configuration.ui_locales,
-				"claims_locales" => @configuration.claims_locales,
 				"client_id" => @configuration.client_id,
 				"client_secret" => @configuration.client_secret,
-				"client_frontchannel_logout_uris"=> @configuration.client_logout_uris,
-				"oxd_rp_programming_language" => 'ruby'
+				"op_discovery_path" => (op_discovery_path.blank?)? @configuration.op_discovery_path : op_discovery_path,
 	        }
 	        request('get-client-token')
 	        @configuration.protection_access_token = getResponseData['access_token']
 		end
 
+		# @return [OBJECT] @response_data
+		# method to gain information about an access token
+		def introspect_access_token
+			@command = 'introspect_access_token'
+			@params = {
+				"oxd_id" => @configuration.oxd_id,
+				"access_token" => @configuration.protection_access_token
+	        }
+	        request('introspect-access-token')
+	        getResponseData
+		end
+
 		# @param scope [Array] OPTIONAL, scopes required, takes the scopes registered with register_site by defualt
 		# @param acr_values [Array] OPTIONAL, list of acr values in the order of priority
 		# @param custom_params [Hash] OPTIONAL, custom parameters		
 		# @return [String] authorization_url
-		# method to get authorization url that the user must be redirected to for authorization and authentication
-		# works with oxd-to-https and oxd-server
-		def get_authorization_url(scope = [], acr_values = [], custom_params = {})
-			logger(:log_msg => "@configuration object params #{@configuration.inspect}", :error => "")
+		# method to get authorization url that the user must be redirected to for authorization and authentication		
+		def get_authorization_url(scope: [], acr_values: [], custom_params: {})
+			logger("@configuration object params #{@configuration.inspect}")
 			
 			@command = 'get_authorization_url'			
 			@params = {
@@ -135,19 +88,18 @@ module Oxd
 	            "custom_parameters" => custom_params,
 				"protection_access_token" => @configuration.protection_access_token
         	}
-        	logger(:log_msg => "get_authorization_url params #{@params.inspect}", :error => "")
+        	logger("get_authorization_url params #{@params.inspect}")
 		    request('get-authorization-url')
 		    getResponseData['authorization_url']
 		end
 
 		# @param code [String] code obtained from the authorization url callback
 		# @param state [String] state obtained from the authorization url callback
-		# @return [Hash] {:access_token, :id_token}
-		# method to retrieve access token. It is called after the user authorizes by visiting the authorization url.
-		# works with oxd-to-https and oxd-server
+		# @return [String] access_token
+		# method to retrieve access token. It is called after the user authorizes by visiting the authorization url.		
 		def get_tokens_by_code( code, state )
             if (code.empty?)
-            	logger(:log_msg => "Empty/Wrong value in place of code.")
+            	trigger_error("Empty/Wrong value in place of code.")
         	end
 			@command = 'get_tokens_by_code'
 			@params = {
@@ -165,7 +117,7 @@ module Oxd
 		# @param scope [Array] OPTIONAL, scopes required, takes the scopes registered with register_site by defualt
 		# @return [String] access_token
 		# method to retrieve access token. It is called after getting the refresh_token by using the code and state.
-		# works with oxd-to-https and oxd-server		
+			
 		def get_access_token_by_refresh_token(scope = nil)
 			@command = 'get_access_token_by_refresh_token'
 			@params = {
@@ -180,11 +132,10 @@ module Oxd
 
 		# @param access_token [String] access token recieved from the get_tokens_by_code command
 		# @return [String] user data claims that are returned by the OP
-		# get the information about the user using the access token obtained from the OP
-		# works with oxd-to-https and oxd-server
+		# get the information about the user using the access token obtained from the OP		
 		def get_user_info(access_token)
 			if access_token.empty?
-	            logger(:log_msg => "Empty access code sent for get_user_info", :error => "Empty access code")
+	            trigger_error("Empty access code sent for get_user_info")
 	        end
 			@command = 'get_user_info'
 	    	@params = {
@@ -199,8 +150,7 @@ module Oxd
 		# @param state [String] OPTIONAL, website state obtained from the authorization url callback
 		# @param session_state [String] OPTIONAL, session state obtained from the authorization url callback
 		# @return [String] uri
-		# method to retrieve logout url from OP. User must be redirected to this url to perform logout
-		# works with oxd-to-https and oxd-server
+		# method to retrieve logout url from OP. User must be redirected to this url to perform logout		
 		def get_logout_uri( state = nil, session_state = nil)
 			@command = 'get_logout_uri'
 			@params = {
@@ -216,43 +166,80 @@ module Oxd
 		end
 
 		# @return [Boolean] status - if site registration was updated successfully or not
-		# method to update the website's information with OpenID Provider. 
-		# 	This should be called after changing the values in the oxd_config file.
-		# works with oxd-to-https and oxd-server
-		def update_site_registration
-	    	@command = 'update_site_registration'
+		# method to update the website's information for oxd server. 
+		# 	This should be called after changing the values in the oxd_config file.		
+		def update_site
+	    	@command = 'update_site'
+        	@params = client_params.merge(
+        		{
+		        	"oxd_id" => @configuration.oxd_id,
+					"client_secret_expires_at" => 3080736637943,
+					"oxd_rp_programming_language" => "ruby",
+					"protection_access_token" => @configuration.protection_access_token
+				}
+        	)				
+	        request('update-site')
+	        if @response_object['status'] == "ok"
+	        	@configuration.oxd_id = getResponseData['oxd_id']
+	            return true
+	        else
+	            return false
+	        end
+		end
+
+		# @return [String] oxd_id - if site data was cleaned successfully
+		# method to clean up the website's information from oxd server. 		
+		def remove_site
+	    	@command = 'remove_site'
         	@params = {
 	        	"oxd_id" => @configuration.oxd_id,
+	        	"protection_access_token" => @configuration.protection_access_token
+	        }
+	        request('remove-site')
+	        if @response_object['status'] == "ok"
+	        	@configuration.oxd_id = getResponseData['oxd_id']	            
+	        end
+		end
+
+		# @return [HASH] client_params
+		# common params to use with client setup commands
+		# ie. setup_client, register_site and update_site
+		def client_params
+			client_params = {
 				"authorization_redirect_uri" => @configuration.authorization_redirect_uri,
 				"post_logout_redirect_uri" => @configuration.post_logout_redirect_uri,
-				"client_logout_uris"=> @configuration.client_logout_uris,
 				"response_types"=> @configuration.response_types,
 				"grant_types" => @configuration.grant_types,
 				"scope" => @configuration.scope,
 				"acr_values" => @configuration.acr_values,
-				"client_name" => @configuration.client_name,
-				"client_secret_expires_at" => 3080736637943,
 				"client_jwks_uri" => @configuration.client_jwks_uri,
+				"client_name" => @configuration.client_name,
 				"client_token_endpoint_auth_method" => @configuration.client_token_endpoint_auth_method,
 				"client_request_uris" => @configuration.client_request_uris,
+				"client_frontchannel_logout_uris" => @configuration.client_frontchannel_logout_uris,
 				"client_sector_identifier_uri" => @configuration.client_sector_identifier_uri,
 				"contacts" => @configuration.contacts,
 				"ui_locales" => @configuration.ui_locales,
-				"claims_locales" => @configuration.claims_locales,
-				"protection_access_token" => @configuration.protection_access_token
-	        }
-	        request('update-site')
-	        if @response_object['status'] == "ok"
-	        	@configuration.oxd_id = getResponseData['oxd_id']
-	            return true
-	        else
-	            return false
-	        end
+				"claims_locales" => @configuration.claims_locales
+			}
+		end
+
+		# @return [HASH] register_params
+		# common params to use with register_site and setup_client commands		
+		def register_params
+			register_params = {
+				"op_host" => @configuration.op_host,
+				"application_type" => @configuration.application_type,
+				"claims_redirect_uri" => @configuration.claims_redirect_uri,
+				"client_id" => @configuration.client_id,
+		        "client_secret" => @configuration.client_secret,
+		        "oxd_rp_programming_language" => "ruby"
+			}
 		end
 
-		# @return Oxd Configuraton object
+		# @return oxd Configuraton object
 		def oxdConfig
 			return @configuration
 		end
 	end
-end
+end