debian-mirror-gitlab/lib/api/api_guard.rb

177 lines
5.2 KiB
Ruby
Raw Normal View History

2015-04-26 12:48:37 +05:30
# Guard API with OAuth 2.0 Access Token
require 'rack/oauth2'
2016-06-02 11:05:42 +05:30
module API
module APIGuard
extend ActiveSupport::Concern
2015-04-26 12:48:37 +05:30
2016-06-02 11:05:42 +05:30
included do |base|
# OAuth2 Resource Server Authentication
use Rack::OAuth2::Server::Resource::Bearer, 'The API' do |request|
# The authenticator only fetches the raw token string
2015-04-26 12:48:37 +05:30
2016-06-02 11:05:42 +05:30
# Must yield access token to store it in the env
request.access_token
end
2015-04-26 12:48:37 +05:30
2016-06-02 11:05:42 +05:30
helpers HelperMethods
2015-04-26 12:48:37 +05:30
2016-06-02 11:05:42 +05:30
install_error_responders(base)
end
2015-04-26 12:48:37 +05:30
2016-06-02 11:05:42 +05:30
# Helper Methods for Grape Endpoint
module HelperMethods
# Invokes the doorkeeper guard.
#
# If token is presented and valid, then it sets @current_user.
#
# If the token does not have sufficient scopes to cover the requred scopes,
# then it raises InsufficientScopeError.
#
# If the token is expired, then it raises ExpiredError.
#
# If the token is revoked, then it raises RevokedError.
#
# If the token is not found (nil), then it raises TokenNotFoundError.
#
# Arguments:
#
# scopes: (optional) scopes required for this guard.
# Defaults to empty array.
#
def doorkeeper_guard!(scopes: [])
if (access_token = find_access_token).nil?
raise TokenNotFoundError
else
case validate_access_token(access_token, scopes)
when Oauth2::AccessTokenValidationService::INSUFFICIENT_SCOPE
raise InsufficientScopeError.new(scopes)
when Oauth2::AccessTokenValidationService::EXPIRED
raise ExpiredError
when Oauth2::AccessTokenValidationService::REVOKED
raise RevokedError
when Oauth2::AccessTokenValidationService::VALID
@current_user = User.find(access_token.resource_owner_id)
end
2015-04-26 12:48:37 +05:30
end
end
2016-06-02 11:05:42 +05:30
def doorkeeper_guard(scopes: [])
if access_token = find_access_token
case validate_access_token(access_token, scopes)
when Oauth2::AccessTokenValidationService::INSUFFICIENT_SCOPE
raise InsufficientScopeError.new(scopes)
2015-04-26 12:48:37 +05:30
2016-06-02 11:05:42 +05:30
when Oauth2::AccessTokenValidationService::EXPIRED
raise ExpiredError
2015-04-26 12:48:37 +05:30
2016-06-02 11:05:42 +05:30
when Oauth2::AccessTokenValidationService::REVOKED
raise RevokedError
2015-04-26 12:48:37 +05:30
2016-06-02 11:05:42 +05:30
when Oauth2::AccessTokenValidationService::VALID
@current_user = User.find(access_token.resource_owner_id)
end
2015-04-26 12:48:37 +05:30
end
end
2016-06-02 11:05:42 +05:30
def current_user
@current_user
end
2015-04-26 12:48:37 +05:30
2016-06-02 11:05:42 +05:30
private
2015-04-26 12:48:37 +05:30
2016-06-02 11:05:42 +05:30
def find_access_token
@access_token ||= Doorkeeper.authenticate(doorkeeper_request, Doorkeeper.configuration.access_token_methods)
end
2015-04-26 12:48:37 +05:30
2016-06-02 11:05:42 +05:30
def doorkeeper_request
@doorkeeper_request ||= ActionDispatch::Request.new(env)
end
2015-04-26 12:48:37 +05:30
2016-06-02 11:05:42 +05:30
def validate_access_token(access_token, scopes)
Oauth2::AccessTokenValidationService.validate(access_token, scopes: scopes)
2015-04-26 12:48:37 +05:30
end
end
2016-06-02 11:05:42 +05:30
module ClassMethods
# Installs the doorkeeper guard on the whole Grape API endpoint.
#
# Arguments:
#
# scopes: (optional) scopes required for this guard.
# Defaults to empty array.
#
def guard_all!(scopes: [])
before do
guard! scopes: scopes
end
end
2015-04-26 12:48:37 +05:30
2016-06-02 11:05:42 +05:30
private
2015-04-26 12:48:37 +05:30
2016-06-02 11:05:42 +05:30
def install_error_responders(base)
error_classes = [ MissingTokenError, TokenNotFoundError,
ExpiredError, RevokedError, InsufficientScopeError]
2015-04-26 12:48:37 +05:30
2016-06-02 11:05:42 +05:30
base.send :rescue_from, *error_classes, oauth2_bearer_token_error_handler
end
def oauth2_bearer_token_error_handler
Proc.new do |e|
response =
case e
when MissingTokenError
Rack::OAuth2::Server::Resource::Bearer::Unauthorized.new
when TokenNotFoundError
Rack::OAuth2::Server::Resource::Bearer::Unauthorized.new(
:invalid_token,
"Bad Access Token.")
when ExpiredError
Rack::OAuth2::Server::Resource::Bearer::Unauthorized.new(
:invalid_token,
"Token is expired. You can either do re-authorization or token refresh.")
when RevokedError
Rack::OAuth2::Server::Resource::Bearer::Unauthorized.new(
:invalid_token,
"Token was revoked. You have to re-authorize from the user.")
when InsufficientScopeError
# FIXME: ForbiddenError (inherited from Bearer::Forbidden of Rack::Oauth2)
# does not include WWW-Authenticate header, which breaks the standard.
Rack::OAuth2::Server::Resource::Bearer::Forbidden.new(
:insufficient_scope,
Rack::OAuth2::Server::Resource::ErrorMethods::DEFAULT_DESCRIPTION[:insufficient_scope],
{ scope: e.scopes })
end
response.finish
end
2015-04-26 12:48:37 +05:30
end
end
2016-06-02 11:05:42 +05:30
#
# Exceptions
#
2015-04-26 12:48:37 +05:30
2016-06-02 11:05:42 +05:30
class MissingTokenError < StandardError; end
2015-04-26 12:48:37 +05:30
2016-06-02 11:05:42 +05:30
class TokenNotFoundError < StandardError; end
2015-04-26 12:48:37 +05:30
2016-06-02 11:05:42 +05:30
class ExpiredError < StandardError; end
2015-04-26 12:48:37 +05:30
2016-06-02 11:05:42 +05:30
class RevokedError < StandardError; end
2015-04-26 12:48:37 +05:30
2016-06-02 11:05:42 +05:30
class InsufficientScopeError < StandardError
attr_reader :scopes
def initialize(scopes)
@scopes = scopes
end
2015-04-26 12:48:37 +05:30
end
end
end