mastodon/spec/requests/oauth/token_spec.rb
Emelia Smith 77cf2abb3a
Improve /oauth/token request specs
Previously these specs passed incorrect parameters to both the authorization_code
and client_credentials grant flows.

The authorization_code flow does not accept a `scope` parameter, instead the scope
is set when the access grant is created, per RFC 6749 Section 4.1.2. The `code`
parameter is accepted by this flow.

https://www.rfc-editor.org/rfc/rfc6749#section-4.1.2

The client_credentials flow does not accept a `code` parameter, and instead accepts
a `scope` parameter, per RFC 6749 Section 4.4.1

https://www.rfc-editor.org/rfc/rfc6749#section-4.4.1

This ensures we're only testing valid oauth flows, and not deviating from the
specification. The OAuth flows should ignore any unknown parameters (i.e., passing
`code` to client_credentials would have no impact on the functionality, and this
would be asserted at the Doorkeeper level).
2025-04-24 18:13:56 +02:00

147 lines
4.3 KiB
Ruby

# frozen_string_literal: true
require 'rails_helper'
RSpec.describe 'Managing OAuth Tokens' do
describe 'POST /oauth/token' do
subject do
post '/oauth/token', params: params, headers: headers
end
let(:application) do
Fabricate(:application, scopes: 'read write follow', redirect_uri: 'urn:ietf:wg:oauth:2.0:oob')
end
# This is using the OAuth client_secret_basic client authentication method
let(:headers) do
{
Authorization: ActionController::HttpAuthentication::Basic.encode_credentials(application.uid, application.secret),
}
end
context "with grant_type 'authorization_code'" do
let(:params) do
{
grant_type: 'authorization_code',
redirect_uri: 'urn:ietf:wg:oauth:2.0:oob',
code: code,
}
end
let(:code) do
access_grant = Fabricate(:access_grant, application: application, redirect_uri: 'urn:ietf:wg:oauth:2.0:oob', scopes: 'read write')
access_grant.plaintext_token
end
shared_examples 'original scope request preservation' do
it 'returns all scopes requested by the authorization code' do
subject
expect(response).to have_http_status(200)
expect(response.parsed_body[:scope]).to eq 'read write'
end
end
context 'with client authentication via params' do
let(:headers) { nil }
let(:params) do
{
grant_type: 'authorization_code',
redirect_uri: 'urn:ietf:wg:oauth:2.0:oob',
client_id: application.uid,
client_secret: application.secret,
code: code,
}
end
it_behaves_like 'original scope request preservation'
end
it_behaves_like 'original scope request preservation'
end
context "with grant_type 'client_credentials'" do
let(:scope) { nil }
let(:params) do
{
grant_type: 'client_credentials',
scope: scope,
}
end
context 'with client authentication via params' do
let(:headers) { nil }
let(:params) do
{
grant_type: 'client_credentials',
client_id: application.uid,
client_secret: application.secret,
scope: scope,
}
end
it 'returns only the default scope' do
subject
expect(response).to have_http_status(200)
expect(response.parsed_body[:scope]).to eq('read')
end
end
context 'with no scopes specified' do
let(:scope) { nil }
it 'returns only the default scope' do
subject
expect(response).to have_http_status(200)
expect(response.parsed_body[:scope]).to eq('read')
end
end
context 'with scopes specified' do
context 'when the scopes belong to the application' do
let(:scope) { 'read write' }
it 'returns all the requested scopes' do
subject
expect(response).to have_http_status(200)
expect(response.parsed_body[:scope]).to eq 'read write'
end
end
context 'when some scopes do not belong to the application' do
let(:scope) { 'read write push' }
it 'returns an error' do
subject
expect(response).to have_http_status(400)
expect(response.parsed_body[:error]).to eq 'invalid_scope'
end
end
end
end
end
describe 'POST /oauth/revoke' do
subject { post '/oauth/revoke', params: { client_id: application.uid, token: access_token.token } }
let!(:user) { Fabricate(:user) }
let!(:application) { Fabricate(:application, confidential: false) }
let!(:access_token) { Fabricate(:accessible_access_token, resource_owner_id: user.id, application: application) }
let!(:web_push_subscription) { Fabricate(:web_push_subscription, user: user, access_token: access_token) }
it 'revokes the token and removes subscriptions' do
expect { subject }
.to change { access_token.reload.revoked_at }.from(nil).to(be_present)
expect(Web::PushSubscription.where(access_token: access_token).count)
.to eq(0)
expect { web_push_subscription.reload }
.to raise_error(ActiveRecord::RecordNotFound)
end
end
end