test/integration/oauth2_test.rb

   1 require "test_helper"
   2 require "jwt"
   3
   4 class OAuth2Test < ActionDispatch::IntegrationTest
   5   def test_oauth2
   6     user = create(:user)
   7     client = create(:oauth_application, :redirect_uri => "https://some.web.app.example.org/callback", :scopes => "read_prefs write_api read_gpx")
   8     state = SecureRandom.urlsafe_base64(16)
   9
  10     authorize_client(user, client, :state => state)
  11     assert_response :redirect
  12     code = validate_redirect(client, state)
  13
  14     token = request_token(client, code)
  15
  16     assert_equal "read_prefs", token["scope"]
  17     test_token(token["access_token"], user, client)
  18   end
  19
  20   def test_oauth2_oob
  21     user = create(:user)
  22     client = create(:oauth_application, :redirect_uri => "urn:ietf:wg:oauth:2.0:oob", :scopes => "read_prefs write_api read_gpx")
  23
  24     authorize_client(user, client)
  25     assert_response :redirect
  26     follow_redirect!
  27     assert_response :success
  28     assert_template "oauth2_authorizations/show"
  29     m = response.body.match(%r{<code id="authorization_code">([A-Za-z0-9_-]+)</code>})
  30     assert_not_nil m
  31     code = m[1]
  32
  33     token = request_token(client, code)
  34
  35     assert_equal "read_prefs", token["scope"]
  36     test_token(token["access_token"], user, client)
  37   end
  38
  39   def test_oauth2_pkce_plain
  40     user = create(:user)
  41     client = create(:oauth_application, :redirect_uri => "https://some.web.app.example.org/callback", :scopes => "read_prefs write_api read_gpx")
  42     state = SecureRandom.urlsafe_base64(16)
  43     verifier = SecureRandom.urlsafe_base64(48)
  44     challenge = verifier
  45
  46     authorize_client(user, client, :state => state, :code_challenge => challenge, :code_challenge_method => "plain")
  47     assert_response :redirect
  48     code = validate_redirect(client, state)
  49
  50     token = request_token(client, code, verifier)
  51
  52     assert_equal "read_prefs", token["scope"]
  53     test_token(token["access_token"], user, client)
  54   end
  55
  56   def test_oauth2_pkce_s256
  57     user = create(:user)
  58     client = create(:oauth_application, :redirect_uri => "https://some.web.app.example.org/callback", :scopes => "read_prefs write_api read_gpx")
  59     state = SecureRandom.urlsafe_base64(16)
  60     verifier = SecureRandom.urlsafe_base64(48)
  61     challenge = Base64.urlsafe_encode64(Digest::SHA256.digest(verifier), :padding => false)
  62
  63     authorize_client(user, client, :state => state, :code_challenge => challenge, :code_challenge_method => "S256")
  64     assert_response :redirect
  65     code = validate_redirect(client, state)
  66
  67     token = request_token(client, code, verifier)
  68
  69     assert_equal "read_prefs", token["scope"]
  70     test_token(token["access_token"], user, client)
  71   end
  72
  73   def test_openid_connect
  74     user = create(:user)
  75     client = create(:oauth_application, :redirect_uri => "https://some.web.app.example.org/callback", :scopes => "openid read_prefs")
  76     state = SecureRandom.urlsafe_base64(16)
  77     verifier = SecureRandom.urlsafe_base64(48)
  78     challenge = Base64.urlsafe_encode64(Digest::SHA256.digest(verifier), :padding => false)
  79
  80     authorize_client(user, client, :state => state, :code_challenge => challenge, :code_challenge_method => "S256", :scope => "openid read_prefs")
  81     assert_response :redirect
  82     code = validate_redirect(client, state)
  83
  84     token = request_token(client, code, verifier)
  85
  86     assert_equal "openid read_prefs", token["scope"]
  87
  88     access_token = token["access_token"]
  89     assert_not_nil access_token
  90
  91     id_token = token["id_token"]
  92     assert_not_nil id_token
  93
  94     data, _headers = JWT.decode id_token, Doorkeeper::OpenidConnect.signing_key.public_key, true, {
  95       :algorithm => [Doorkeeper::OpenidConnect.signing_algorithm.to_s],
  96       :verify_iss => true,
  97       :iss => "#{Settings.server_protocol}://#{Settings.server_url}",
  98       :verify_sub => true,
  99       :sub => user.id,
 100       :verify_aud => true,
 101       :aud => client.uid
 102     }
 103
 104     assert_equal user.id.to_s, data["sub"]
 105     assert_not data.key?("preferred_username")
 106
 107     get oauth_userinfo_path
 108     assert_response :unauthorized
 109
 110     auth_header = bearer_authorization_header(access_token)
 111     get oauth_userinfo_path, :headers => auth_header
 112     assert_response :success
 113
 114     userinfo = response.parsed_body
 115
 116     assert_not_nil userinfo
 117     assert_equal user.id.to_s, userinfo["sub"]
 118     assert_equal user.display_name, userinfo["preferred_username"]
 119   end
 120
 121   def test_openid_discovery
 122     get oauth_discovery_provider_path
 123     assert_response :success
 124     openid_config = response.parsed_body
 125
 126     assert_equal "#{Settings.server_protocol}://#{Settings.server_url}", openid_config["issuer"]
 127
 128     assert_equal oauth_authorization_path, URI(openid_config["authorization_endpoint"]).path
 129     assert_equal oauth_token_path, URI(openid_config["token_endpoint"]).path
 130     assert_equal oauth_userinfo_path, URI(openid_config["userinfo_endpoint"]).path
 131     assert_equal oauth_discovery_keys_path, URI(openid_config["jwks_uri"]).path
 132   end
 133
 134   def test_openid_key
 135     get oauth_discovery_keys_path
 136     assert_response :success
 137     key_info = response.parsed_body
 138     assert key_info.key?("keys")
 139     assert_equal 1, key_info["keys"].size
 140     assert_equal Doorkeeper::OpenidConnect.signing_key.kid, key_info["keys"][0]["kid"]
 141   end
 142
 143   private
 144
 145   def authorize_client(user, client, options = {})
 146     options = {
 147       :client_id => client.uid,
 148       :redirect_uri => client.redirect_uri,
 149       :response_type => "code",
 150       :scope => "read_prefs"
 151     }.merge(options)
 152
 153     get oauth_authorization_path(options)
 154     assert_response :redirect
 155     assert_redirected_to login_path(:referer => request.fullpath)
 156
 157     post login_path(:username => user.email, :password => "test")
 158     follow_redirect!
 159     assert_response :success
 160
 161     get oauth_authorization_path(options)
 162     assert_response :success
 163     assert_template "oauth2_authorizations/new"
 164
 165     delete oauth_authorization_path(options)
 166
 167     validate_deny(client, options)
 168
 169     post oauth_authorization_path(options)
 170   end
 171
 172   def validate_deny(client, options)
 173     if client.redirect_uri == "urn:ietf:wg:oauth:2.0:oob"
 174       assert_response :bad_request
 175     else
 176       assert_response :redirect
 177       location = URI.parse(response.location)
 178       assert_match(/^#{Regexp.escape(client.redirect_uri)}/, location.to_s)
 179       query = Rack::Utils.parse_query(location.query)
 180       assert_equal "access_denied", query["error"]
 181       assert_equal "The resource owner or authorization server denied the request.", query["error_description"]
 182       assert_equal options[:state], query["state"]
 183     end
 184   end
 185
 186   def validate_redirect(client, state)
 187     location = URI.parse(response.location)
 188     assert_match(/^#{Regexp.escape(client.redirect_uri)}/, location.to_s)
 189     query = Rack::Utils.parse_query(location.query)
 190     assert_equal state, query["state"]
 191
 192     query["code"]
 193   end
 194
 195   def request_token(client, code, verifier = nil)
 196     options = {
 197       :client_id => client.uid,
 198       :client_secret => client.plaintext_secret,
 199       :code => code,
 200       :grant_type => "authorization_code",
 201       :redirect_uri => client.redirect_uri
 202     }
 203
 204     if verifier
 205       post oauth_token_path(options)
 206       assert_response :bad_request
 207
 208       options = options.merge(:code_verifier => verifier)
 209     end
 210
 211     post oauth_token_path(options)
 212     assert_response :success
 213     token = response.parsed_body
 214     assert_equal "Bearer", token["token_type"]
 215
 216     token
 217   end
 218
 219   def test_token(token, user, client)
 220     get user_preferences_path
 221     assert_response :unauthorized
 222
 223     auth_header = bearer_authorization_header(token)
 224
 225     get user_preferences_path, :headers => auth_header
 226     assert_response :success
 227
 228     get user_preferences_path(:access_token => token)
 229     assert_response :unauthorized
 230
 231     get user_preferences_path(:bearer_token => token)
 232     assert_response :unauthorized
 233
 234     get api_trace_path(:id => 2), :headers => auth_header
 235     assert_response :forbidden
 236
 237     user.suspend!
 238
 239     get user_preferences_path, :headers => auth_header
 240     assert_response :forbidden
 241
 242     user.hide!
 243
 244     get user_preferences_path, :headers => auth_header
 245     assert_response :forbidden
 246
 247     user.unhide!
 248
 249     get user_preferences_path, :headers => auth_header
 250     assert_response :success
 251
 252     post oauth_revoke_path(:token => token)
 253     assert_response :forbidden
 254
 255     post oauth_revoke_path(:token => token,
 256                            :client_id => client.uid,
 257                            :client_secret => client.plaintext_secret)
 258     assert_response :success
 259
 260     get user_preferences_path, :headers => auth_header
 261     assert_response :unauthorized
 262   end
 263 end