Module: UDAPSecurityTestKit::MockUDAPServer::UDAPTokenResponseCreation

Included in:
TokenEndpoint
Defined in:
lib/udap_security_test_kit/endpoints/mock_udap_server/udap_token_response_creation.rb

Instance Method Summary collapse

Instance Method Details

#make_udap_authorization_code_token_response ⇒ Object

rubocop:disable Metrics/CyclomaticComplexity



9
10
11
12
13
14
15
16
17
18
19
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
 
# File 'lib/udap_security_test_kit/endpoints/mock_udap_server/udap_token_response_creation.rb', line 9

def make_udap_authorization_code_token_response # rubocop:disable Metrics/CyclomaticComplexity
  authorization_code = request.params[:code]
  client_id = MockUDAPServer.issued_token_to_client_id(authorization_code)
  software_statement = MockUDAPServer.udap_registration_software_statement(test_run.test_session_id)
  return unless udap_authenticated?(request.params[:client_assertion], software_statement)

  if MockUDAPServer.token_expired?(authorization_code)
    MockUDAPServer.update_response_for_expired_token(response, 'Authorization code')
    return
  end

  return if request.params[:code_verifier].present? && !udap_pkce_valid?(authorization_code)

  exp_min = 60
  response_body = {
    access_token: MockUDAPServer.client_id_to_token(client_id, exp_min),
    token_type: 'Bearer',
    expires_in: 60 * exp_min
  }

  launch_context =
    begin
      input_string = JSON.parse(result.input_json)&.find do |input|
        input['name'] == 'launch_context'
      end&.dig('value')
      JSON.parse(input_string) if input_string.present?
    rescue JSON::ParserError
      nil
    end
  additional_context = udap_requested_scope_context(udap_registered_scope(software_statement), authorization_code,
                                                    launch_context)

  response.body = additional_context.merge(response_body).to_json # response body values take priority
  response.headers['Cache-Control'] = 'no-store'
  response.headers['Pragma'] = 'no-cache'
  response.headers['Access-Control-Allow-Origin'] = '*'
  response.content_type = 'application/json'
  response.status = 200
end

#make_udap_client_credential_token_response ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/udap_security_test_kit/endpoints/mock_udap_server/udap_token_response_creation.rb', line 103

def make_udap_client_credential_token_response
  assertion = request.params[:client_assertion]
  client_id = MockUDAPServer.client_id_from_client_assertion(assertion)
  software_statement = MockUDAPServer.udap_registration_software_statement(test_run.test_session_id)
  return unless udap_authenticated?(request.params[:client_assertion], software_statement)

  exp_min = 60
  response_body = {
    access_token: MockUDAPServer.client_id_to_token(client_id, exp_min),
    token_type: 'Bearer',
    expires_in: 60 * exp_min
  }

  response.body = response_body.to_json
  response.headers['Cache-Control'] = 'no-store'
  response.headers['Pragma'] = 'no-cache'
  response.headers['Access-Control-Allow-Origin'] = '*'
  response.content_type = 'application/json'
  response.status = 200
end

#make_udap_refresh_token_response ⇒ Object

rubocop:disable Metrics/CyclomaticComplexity



49
50
51
52
53
54
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/udap_security_test_kit/endpoints/mock_udap_server/udap_token_response_creation.rb', line 49

def make_udap_refresh_token_response # rubocop:disable Metrics/CyclomaticComplexity
  refresh_token = request.params[:refresh_token]
  authorization_code = MockUDAPServer.refresh_token_to_authorization_code(refresh_token)
  client_id = MockUDAPServer.issued_token_to_client_id(authorization_code)
  software_statement = MockUDAPServer.udap_registration_software_statement(test_run.test_session_id)
  return unless udap_authenticated?(request.params[:client_assertion], software_statement)

  # no expiration checks for refresh tokens

  authorization_request = MockUDAPServer.authorization_request_for_code(authorization_code,
                                                                        test_run.test_session_id)
  if authorization_request.blank?
    MockUDAPServer.update_response_for_error(
      response,
      "no authorization request found for refresh token #{refresh_token}"
    )
    return
  end
  auth_code_request_inputs = MockUDAPServer.authorization_code_request_details(authorization_request)
  if auth_code_request_inputs.blank?
    MockUDAPServer.update_response_for_error(
      response,
      'invalid authorization request details'
    )
    return
  end

  exp_min = 60
  response_body = {
    access_token: MockUDAPServer.client_id_to_token(client_id, exp_min),
    token_type: 'Bearer',
    expires_in: 60 * exp_min
  }

  launch_context =
    begin
      input_string = JSON.parse(result.input_json)&.find do |input|
        input['name'] == 'launch_context'
      end&.dig('value')
      JSON.parse(input_string) if input_string.present?
    rescue JSON::ParserError
      nil
    end
  additional_context = udap_requested_scope_context(udap_registered_scope(software_statement), authorization_code,
                                                    launch_context)

  response.body = additional_context.merge(response_body).to_json # response body values take priority
  response.headers['Cache-Control'] = 'no-store'
  response.headers['Pragma'] = 'no-cache'
  response.headers['Access-Control-Allow-Origin'] = '*'
  response.content_type = 'application/json'
  response.status = 200
end

#udap_authenticated?(assertion, software_statement) ⇒ Boolean

Returns:

  • (Boolean) 


124
125
126
127
128
129
130
131
132
133
 
# File 'lib/udap_security_test_kit/endpoints/mock_udap_server/udap_token_response_creation.rb', line 124

def udap_authenticated?(assertion, software_statement)
  signature_error = MockUDAPServer.udap_token_signature_verification(assertion, software_statement)

  if signature_error.present?
    MockUDAPServer.update_response_for_error(response, signature_error)
    return false
  end

  true
end

#udap_construct_id_token(include_fhir_user) ⇒ Object

rubocop:disable Metrics/CyclomaticComplexity



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/udap_security_test_kit/endpoints/mock_udap_server/udap_token_response_creation.rb', line 148

def udap_construct_id_token(include_fhir_user) # rubocop:disable Metrics/CyclomaticComplexity
  client_id = JSON.parse(result.input_json)&.find do |input|
    input['name'] == 'client_id'
  end&.dig('value')
  fhir_user_relative_reference = JSON.parse(result.input_json)&.find do |input|
    input['name'] == 'fhir_user_relative_reference'
  end&.dig('value')

  subject_id = if fhir_user_relative_reference.present?
                 fhir_user_relative_reference.downcase.gsub('/', '-')
               else
                 SecureRandom.uuid
               end

  claims = {
    iss: client_fhir_base_url,
    sub: subject_id,
    aud: client_id,
    exp: 1.year.from_now.to_i,
    iat: Time.now.to_i
  }
  if include_fhir_user && fhir_user_relative_reference.present?
    claims[:fhirUser] = "#{client_fhir_base_url}/#{fhir_user_relative_reference}"
  end

  algorithm = 'RS256'
  private_key = OIDCJWKS.jwks
    .select { |key| key[:key_ops]&.include?('sign') }
    .select { |key| key[:alg] == algorithm }
    .first

  JWT.encode claims, private_key.signing_key, algorithm, { alg: algorithm, kid: private_key.kid, typ: 'JWT' }
end

#udap_pkce_valid?(authorization_code) ⇒ Boolean

Returns:

  • (Boolean) 


182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/udap_security_test_kit/endpoints/mock_udap_server/udap_token_response_creation.rb', line 182

def udap_pkce_valid?(authorization_code)
  authorization_request = MockUDAPServer.authorization_request_for_code(authorization_code,
                                                                        test_run.test_session_id)
  if authorization_request.blank?
    MockUDAPServer.update_response_for_error(
      response,
      "Could not check code_verifier: no authorization request found that returned code #{authorization_code}"
    )
    return false
  end
  auth_code_request_inputs = MockUDAPServer.authorization_code_request_details(authorization_request)
  if auth_code_request_inputs.blank?
    MockUDAPServer.update_response_for_error(
      response,
      "Could not check code_verifier: invalid authorization request details for code #{authorization_code}"
    )
    return false
  end

  verifier = request.params[:code_verifier]
  challenge = auth_code_request_inputs&.dig('code_challenge')
  method = auth_code_request_inputs&.dig('code_challenge_method')
  MockUDAPServer.pkce_valid?(verifier, challenge, method, response)
end

#udap_registered_scope(software_statement_jwt) ⇒ Object 



207
208
209
210
211
212
213
214
215
 
# File 'lib/udap_security_test_kit/endpoints/mock_udap_server/udap_token_response_creation.rb', line 207

def udap_registered_scope(software_statement_jwt)
  claims, _headers = begin
    JWT.decode(software_statement_jwt, nil, false)
  rescue StandardError
    return nil
  end

  claims['scope']
end

#udap_requested_scope_context(requested_scopes, authorization_code, launch_context) ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/udap_security_test_kit/endpoints/mock_udap_server/udap_token_response_creation.rb', line 135

def udap_requested_scope_context(requested_scopes, authorization_code, launch_context)
  context = launch_context.present? ? launch_context : {}
  scopes_list = requested_scopes&.split || []

  if scopes_list.include?('offline_access') || scopes_list.include?('online_access')
    context[:refresh_token] = MockUDAPServer.authorization_code_to_refresh_token(authorization_code)
  end

  context[:id_token] = udap_construct_id_token(scopes_list.include?('fhirUser')) if scopes_list.include?('openid')

  context
end