160 lines
5.6 KiB
Ruby
160 lines
5.6 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module API::V2
|
|
module Resource
|
|
# Responsible for CRUD for api keys
|
|
class APIKeys < Grape::API
|
|
helpers ::API::V2::NamedParams
|
|
helpers do
|
|
def skip_api_key_2fa?
|
|
ENV['BARONG_SKIP_API_KEY_2FA'] == 'true'
|
|
end
|
|
|
|
def otp_protected!
|
|
return if skip_api_key_2fa?
|
|
|
|
unless current_user.otp
|
|
error!({ errors: ['resource.api_key.2fa_disabled'] }, 400)
|
|
end
|
|
error!({ errors: ['resource.api_key.missing_totp'] }, 422) unless params[:totp_code].present?
|
|
|
|
return if TOTPService.validate?(current_user.uid, params[:totp_code])
|
|
|
|
error!({ errors: ['resource.api_key.invalid_totp'] }, 422)
|
|
end
|
|
end
|
|
|
|
resource :api_keys do
|
|
desc 'Create an api key',
|
|
failure: [
|
|
{ code: 400, message: 'Required params are empty' },
|
|
{ code: 401, message: 'Invalid bearer token' },
|
|
{ code: 422, message: 'Validation errors' }
|
|
],
|
|
success: Entities::APIKey
|
|
params do
|
|
requires :algorithm,
|
|
type: String,
|
|
allow_blank: false,
|
|
desc: 'API key algorithm'
|
|
optional :scope,
|
|
type: String,
|
|
allow_blank: false,
|
|
desc: 'Comma separated scopes'
|
|
optional :totp_code,
|
|
type: String,
|
|
allow_blank: false,
|
|
desc: 'Code from Google Authenticator'
|
|
end
|
|
post do
|
|
otp_protected!
|
|
declared_params = declared(params, include_missing: false)
|
|
.except(:totp_code)
|
|
.merge(scope: params[:scope]&.split(','))
|
|
.merge(secret: SecureRandom.hex(16))
|
|
|
|
api_key = current_user.api_keys.new(declared_params)
|
|
|
|
APIKey.transaction do
|
|
raise ActiveRecord::Rollback unless api_key.save
|
|
rescue Vault::VaultError
|
|
api_key.errors.add(:api_key, 'could_not_save_secret')
|
|
raise ActiveRecord::Rollback
|
|
end
|
|
|
|
if api_key.errors.any?
|
|
code_error!(api_key.errors.details, 422)
|
|
end
|
|
|
|
present api_key, with: Entities::APIKey
|
|
end
|
|
|
|
desc 'Updates an api key',
|
|
failure: [
|
|
{ code: 400, message: 'Required params are empty' },
|
|
{ code: 401, message: 'Invalid bearer token' },
|
|
{ code: 404, message: 'Record is not found' },
|
|
{ code: 422, message: 'Validation errors' }
|
|
],
|
|
success: Entities::APIKey
|
|
params do
|
|
requires :kid,
|
|
type: String,
|
|
allow_blank: false,
|
|
desc: 'API key kid'
|
|
optional :scope,
|
|
type: String,
|
|
allow_blank: false,
|
|
desc: 'Comma separated scopes'
|
|
optional :state,
|
|
type: String,
|
|
allow_blank: false,
|
|
desc: 'State of API Key. "active" state means key is active and can be used for auth'
|
|
optional :totp_code,
|
|
type: String,
|
|
allow_blank: false,
|
|
desc: 'Code from Google Authenticator'
|
|
end
|
|
patch ':kid' do
|
|
otp_protected!
|
|
declared_params = declared(params, include_missing: false)
|
|
.except(:totp_code)
|
|
.merge(scope: params[:scope]&.split(','))
|
|
api_key = current_user.api_keys.find_by!(kid: params[:kid])
|
|
|
|
unless api_key.update(declared_params)
|
|
code_error!(api_key.errors.details, 422)
|
|
end
|
|
|
|
present api_key, with: Entities::APIKey, except: [:secret]
|
|
end
|
|
|
|
desc 'Delete an api key',
|
|
success: { code: 204, message: 'Succefully deleted' },
|
|
failure: [
|
|
{ code: 400, message: 'Required params are empty' },
|
|
{ code: 401, message: 'Invalid bearer token' },
|
|
{ code: 404, message: 'Record is not found' }
|
|
]
|
|
params do
|
|
requires :kid,
|
|
type: String,
|
|
allow_blank: false,
|
|
desc: 'API key kid'
|
|
optional :totp_code,
|
|
type: String,
|
|
allow_blank: false,
|
|
desc: 'Code from Google Authenticator'
|
|
end
|
|
delete ':kid' do
|
|
otp_protected!
|
|
api_key = current_user.api_keys.find_by!(kid: params[:kid])
|
|
api_key.destroy
|
|
status 204
|
|
end
|
|
|
|
desc 'List all api keys for current account.',
|
|
failure: [
|
|
{ code: 400, message: 'Require 2FA and totp code' },
|
|
{ code: 401, message: 'Invalid bearer token' }
|
|
],
|
|
success: Entities::APIKey
|
|
params do
|
|
optional :ordering,
|
|
values: { value: -> (p){ %w[asc desc].include?(p) }, message: 'resource.api_key.invalid_ordering' },
|
|
default: 'asc',
|
|
desc: 'If set, returned values will be sorted in specific order, defaults to \'asc\'.'
|
|
optional :order_by,
|
|
values: { value: -> (p){ APIKey.new.attributes.keys.include?(p) }, message: 'resource.api_key.invalid_attribute' },
|
|
default: 'id',
|
|
desc: 'Name of the field, which result will be ordered by.'
|
|
use :pagination_filters
|
|
end
|
|
get do
|
|
current_user.api_keys.order(params[:order_by] => params[:ordering]).tap { |q| present paginate(q), with: Entities::APIKey, except: [:secret] }
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|