Perform private token and personal access token authentication in the same `before_action`.

- So that the check for valid personal access tokens happens only if
  private token auth fails.
This commit is contained in:
Timothy Andrew 2016-06-01 14:04:38 +05:30
parent 70add1388f
commit 05b319b0b4
2 changed files with 67 additions and 71 deletions

View File

@ -7,8 +7,7 @@ class ApplicationController < ActionController::Base
include GitlabRoutingHelper include GitlabRoutingHelper
include PageLayoutHelper include PageLayoutHelper
before_action :authenticate_user_from_private_token! before_action :authenticate_user_from_token!
before_action :authenticate_user_from_personal_access_token!
before_action :authenticate_user! before_action :authenticate_user!
before_action :validate_user_service_ticket! before_action :validate_user_service_ticket!
before_action :reject_blocked! before_action :reject_blocked!
@ -64,26 +63,8 @@ class ApplicationController < ActionController::Base
end end
end end
# From https://github.com/plataformatec/devise/wiki/How-To:-Simple-Token-Authentication-Example def authenticate_user_from_token!
# https://gist.github.com/josevalim/fb706b1e933ef01e4fb6 user = get_user_from_private_token || get_user_from_personal_access_token
def authenticate_user_from_private_token!
user_token = params[:private_token].presence || request.headers['PRIVATE-TOKEN'].presence
user = user_token && User.find_by_authentication_token(user_token.to_s)
if user
# Notice we are passing store false, so the user is not
# actually stored in the session and a token is needed
# for every request. If you want the token to work as a
# sign in token, you can simply remove store: false.
sign_in user, store: false
end
end
def authenticate_user_from_personal_access_token!
token_string = params[:private_token].presence || request.headers['PRIVATE-TOKEN'].presence
personal_access_token = PersonalAccessToken.active.find_by_token(token_string)
user = personal_access_token && personal_access_token.user
if user if user
# Notice we are passing store false, so the user is not # Notice we are passing store false, so the user is not
# actually stored in the session and a token is needed # actually stored in the session and a token is needed
@ -383,4 +364,17 @@ class ApplicationController < ActionController::Base
(controller_name == 'groups' && action_name == page_type) || (controller_name == 'groups' && action_name == page_type) ||
(controller_name == 'dashboard' && action_name == page_type) (controller_name == 'dashboard' && action_name == page_type)
end end
# From https://github.com/plataformatec/devise/wiki/How-To:-Simple-Token-Authentication-Example
# https://gist.github.com/josevalim/fb706b1e933ef01e4fb6
def get_user_from_private_token
user_token = params[:private_token].presence || request.headers['PRIVATE-TOKEN'].presence
User.find_by_authentication_token(user_token.to_s) if user_token
end
def get_user_from_personal_access_token
token_string = params[:private_token].presence || request.headers['PRIVATE-TOKEN'].presence
personal_access_token = PersonalAccessToken.active.find_by_token(token_string)
personal_access_token.user if personal_access_token
end
end end

View File

@ -31,63 +31,65 @@ describe ApplicationController do
end end
end end
describe "#authenticate_user_from_private_token!" do describe "#authenticate_user_from_token!" do
controller(ApplicationController) do describe "authenticating a user from a private token" do
def index controller(ApplicationController) do
render text: "authenticated" def index
render text: "authenticated"
end
end
let(:user) { create(:user) }
it "logs the user in when the 'private_token' param is populated with the private token" do
get :index, private_token: user.private_token
expect(response.status).to eq(200)
expect(response.body).to eq("authenticated")
end
it "logs the user in when the 'PRIVATE-TOKEN' header is populated with the private token" do
@request.headers['PRIVATE-TOKEN'] = user.private_token
get :index
expect(response.status).to eq(200)
expect(response.body).to eq("authenticated")
end
it "doesn't log the user in otherwise" do
@request.headers['PRIVATE-TOKEN'] = "token"
get :index, private_token: "token", authenticity_token: "token"
expect(response.status).to_not eq(200)
expect(response.body).to_not eq("authenticated")
end end
end end
let(:user) { create(:user) } describe "authenticating a user from a personal access token" do
controller(ApplicationController) do
it "logs the user in when the 'private_token' param is populated with the private token" do def index
get :index, private_token: user.private_token render text: 'authenticated'
expect(response.status).to eq(200) end
expect(response.body).to eq("authenticated")
end
it "logs the user in when the 'PRIVATE-TOKEN' header is populated with the private token" do
@request.headers['PRIVATE-TOKEN'] = user.private_token
get :index
expect(response.status).to eq(200)
expect(response.body).to eq("authenticated")
end
it "doesn't log the user in otherwise" do
@request.headers['PRIVATE-TOKEN'] = "token"
get :index, private_token: "token", authenticity_token: "token"
expect(response.status).to_not eq(200)
expect(response.body).to_not eq("authenticated")
end
end
describe "#authenticate_user_from_personal_access_token!" do
controller(ApplicationController) do
def index
render text: 'authenticated'
end end
end
let(:user) { create(:user) } let(:user) { create(:user) }
let(:personal_access_token) { create(:personal_access_token, user: user) } let(:personal_access_token) { create(:personal_access_token, user: user) }
it "logs the user in when the 'personal_access_token' param is populated with the personal access token" do it "logs the user in when the 'personal_access_token' param is populated with the personal access token" do
get :index, private_token: personal_access_token.token get :index, private_token: personal_access_token.token
expect(response.status).to eq(200) expect(response.status).to eq(200)
expect(response.body).to eq('authenticated') expect(response.body).to eq('authenticated')
end end
it "logs the user in when the 'PERSONAL_ACCESS_TOKEN' header is populated with the personal access token" do it "logs the user in when the 'PERSONAL_ACCESS_TOKEN' header is populated with the personal access token" do
@request.headers["PRIVATE-TOKEN"] = personal_access_token.token @request.headers["PRIVATE-TOKEN"] = personal_access_token.token
get :index get :index
expect(response.status).to eq(200) expect(response.status).to eq(200)
expect(response.body).to eq('authenticated') expect(response.body).to eq('authenticated')
end end
it "doesn't log the user in otherwise" do it "doesn't log the user in otherwise" do
get :index, private_token: "token" get :index, private_token: "token"
expect(response.status).to_not eq(200) expect(response.status).to_not eq(200)
expect(response.body).to_not eq('authenticated') expect(response.body).to_not eq('authenticated')
end
end end
end end
end end