Class: Oxd::ClientOxdCommands

Inherits:
OxdConnector show all
Defined in:
lib/oxd/client_oxd_commands.rb

Overview

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.

Instance Method Summary collapse

Methods inherited from OxdConnector

#getData, #getData2, #getResponseData, #getResponseObject, #is_json?, #logger, #oxd_http_request, #oxd_socket_request, #request, #validate_command

Constructor Details

#initialize ⇒ ClientOxdCommands

class constructor



13
14
15
 
# File 'lib/oxd/client_oxd_commands.rb', line 13

def initialize
  super
end

Instance Method Details

#get_access_token_by_refresh_token(scope = nil) ⇒ String

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

Parameters:

  • scope (Array) (defaults to: nil) —

    OPTIONAL, scopes required, takes the scopes registered with register_site by defualt

Returns:

  • (String) —

    access_token



169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/oxd/client_oxd_commands.rb', line 169

def get_access_token_by_refresh_token(scope = nil)
  @command = 'get_access_token_by_refresh_token'
  @params = {
           "oxd_id" => @configuration.oxd_id,
           "refresh_token" => @configuration.refresh_token,
           "scope" => (scope.blank?)? @configuration.scope : scope,
           "protection_access_token" => @configuration.protection_access_token
        }          
  request('get-access-token-by-refresh-token')
  getResponseData['access_token']
end

#get_authorization_url(scope = [], acr_values = [], custom_params = {}) ⇒ String

method to get authorization url that the user must be redirected to for authorization and authentication works with oxd-to-https and oxd-server

Parameters:

  • scope (Array) (defaults to: []) —

    OPTIONAL, scopes required, takes the scopes registered with register_site by defualt

  • acr_values (Array) (defaults to: []) —

    OPTIONAL, list of acr values in the order of priority

  • custom_params (Hash) (defaults to: {}) —

    OPTIONAL, custom parameters

Returns:

  • (String) —

    authorization_url



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oxd/client_oxd_commands.rb', line 126

def get_authorization_url(scope = [], acr_values = [], custom_params = {})
  logger(:log_msg => "@configuration object params #{@configuration.inspect}", :error => "")
  
  @command = 'get_authorization_url'     
  @params = {
           "oxd_id" => @configuration.oxd_id,
           "prompt" => @configuration.prompt,
           "scope" => (scope.blank?)? @configuration.scope : scope,             
           "acr_values" => (acr_values.blank?)? @configuration.acr_values : acr_values,
           "custom_parameters" => custom_params,
    "protection_access_token" => @configuration.protection_access_token
        }
        logger(:log_msg => "get_authorization_url params #{@params.inspect}", :error => "")
    request('get-authorization-url')
    getResponseData['authorization_url']
end

#get_client_token ⇒ STRING

method to generate the protection access token obtained access token is passed as protection_access_token to all further calls to oxd-https-extension

Returns:

  • (STRING) —

    access_token



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/oxd/client_oxd_commands.rb', line 91

def get_client_token
  @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'
       }
       request('get-client-token')
       @configuration.protection_access_token = getResponseData['access_token']
end

#get_logout_uri(state = nil, session_state = nil) ⇒ String

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

Parameters:

  • state (String) (defaults to: nil) —

    OPTIONAL, website state obtained from the authorization url callback

  • session_state (String) (defaults to: nil) —

    OPTIONAL, session state obtained from the authorization url callback

Returns:

  • (String) —

    uri



204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/oxd/client_oxd_commands.rb', line 204

def get_logout_uri( state = nil, session_state = nil)
  @command = 'get_logout_uri'
  @params = {
           "oxd_id" => @configuration.oxd_id,
           "id_token_hint" => @configuration.id_token,
           "post_logout_redirect_uri" => @configuration.post_logout_redirect_uri, 
           "state" => state,
           "session_state" => session_state,
           "protection_access_token" => @configuration.protection_access_token
        }
        request('get-logout-uri')
        getResponseData['uri']
end

#get_tokens_by_code(code, state) ⇒ Hash

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

Parameters:

  • code (String) —

    code obtained from the authorization url callback

  • state (String) —

    state obtained from the authorization url callback

Returns:

  • (Hash) —

    :id_token



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oxd/client_oxd_commands.rb', line 148

def get_tokens_by_code( code, state )
          if (code.empty?)
            logger(:log_msg => "Empty/Wrong value in place of code.")
        end
  @command = 'get_tokens_by_code'
  @params = {
           "oxd_id" => @configuration.oxd_id,
           "code" => code,
           "state" => state,
           "protection_access_token" => @configuration.protection_access_token
        }          
  request('get-tokens-by-code')
  @configuration.id_token = getResponseData['id_token']
  @configuration.refresh_token = getResponseData['refresh_token']
  getResponseData['access_token']
end

#get_user_info(access_token) ⇒ String

get the information about the user using the access token obtained from the OP works with oxd-to-https and oxd-server

Parameters:

  • access_token (String) —

    access token recieved from the get_tokens_by_code command

Returns:

  • (String) —

    user data claims that are returned by the OP



185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oxd/client_oxd_commands.rb', line 185

def (access_token)
  if access_token.empty?
           logger(:log_msg => "Empty access code sent for get_user_info", :error => "Empty access code")
       end
  @command = 'get_user_info'
    @params = {
           "oxd_id" => @configuration.oxd_id,
           "access_token" => access_token,
           "protection_access_token" => @configuration.protection_access_token
        }
        request('get-user-info')
  getResponseData['claims']
end

#oxdConfig ⇒ Object

Returns Oxd Configuraton object.

Returns:

  • Oxd Configuraton object



254
255
256
 
# File 'lib/oxd/client_oxd_commands.rb', line 254

def oxdConfig
  return @configuration
end

#register_site ⇒ String

method to register the website and generate a unique ID for that website works with oxd-to-https and oxd-server

Returns:

  • (String) —

    oxd_id of the registered website



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oxd/client_oxd_commands.rb', line 55

def register_site 
  if(!@configuration.oxd_id.empty?) # Check if client is already registered
    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
        }
        request('register-site')
        logger(:log_msg => "OXD ID FROM setup_client : "+getResponseData['oxd_id'])
        @configuration.oxd_id = getResponseData['oxd_id']
    end         
end

#setup_client ⇒ String

method to setup the client and generate a Client ID, Client Secret for the site works with oxd-to-https and oxd-server

Returns:

  • (String) —

    oxd_id of the registered website



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/oxd/client_oxd_commands.rb', line 20

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
  }
  request('setup-client')
       @configuration.client_id = getResponseData['client_id']
       @configuration.client_secret = getResponseData['client_secret']
       @configuration.oxd_id = getResponseData['oxd_id']

end

#update_site_registration ⇒ Boolean

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

Returns:

  • (Boolean) —

    status - if site registration was updated successfully or not



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/oxd/client_oxd_commands.rb', line 222

def update_site_registration
    @command = 'update_site_registration'
        @params = {
        "oxd_id" => @configuration.oxd_id,
    "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_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,
    "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