Commit 3203baf3 authored by Mayra Cabrera's avatar Mayra Cabrera
Browse files

Include ProjectDeployTokens

Also:
- Changes scopes from serializer to use boolean columns
- Fixes broken specs
parent 3316b8eff61b
......@@ -21,6 +21,6 @@ def revoke
private
def deploy_token_params
params.require(:deploy_token).permit(:name, :expires_at, scopes: [])
params.require(:deploy_token).permit(:name, :expires_at, :read_repository, :read_registry)
end
end
......@@ -56,7 +56,7 @@ def load_gon_index
def define_deploy_token
attributes = @deploy_tokens.attributes_deploy_token
@deploy_token = @project.deploy_tokens.build(attributes)
@deploy_token = DeployToken.new(attributes)
@deploy_token.valid? unless attributes.empty?
end
end
......
......@@ -3,36 +3,51 @@ class DeployToken < ActiveRecord::Base
include TokenAuthenticatable
add_authentication_token_field :token
AVAILABLE_SCOPES = %w(read_repository read_registry).freeze
AVAILABLE_SCOPES = %i(read_repository read_registry).freeze
serialize :scopes, Array # rubocop:disable Cop/ActiveRecordSerialize
validates :scopes, presence: true
validates :project, presence: true
belongs_to :project
has_many :project_deploy_tokens, inverse_of: :deploy_token
has_many :projects, through: :project_deploy_tokens
validate :ensure_at_least_one_scope
before_save :ensure_token
accepts_nested_attributes_for :project_deploy_tokens
scope :active, -> { where("revoked = false AND (expires_at >= NOW() OR expires_at IS NULL)") }
scope :read_repository, -> { where(read_repository: true) }
scope :read_registry, -> { where(read_registry: true) }
def revoke!
update!(revoked: true)
def self.redis_shared_state_key(user_id)
"gitlab:deploy_token:user_#{user_id}"
end
def redis_shared_state_key(user_id)
"gitlab:deploy_token:#{project_id}:#{user_id}"
def revoke!
update!(revoked: true)
end
def active?
!revoked
end
def scopes
AVAILABLE_SCOPES.select { |token_scope| send("#{token_scope}") } # rubocop:disable GitlabSecurity/PublicSend
end
def username
"gitlab+deploy-token-#{id}"
end
def has_access_to?(project)
self.project == project
def has_access_to?(requested_project)
self.projects.first == requested_project
end
def project
projects.first
end
private
def ensure_at_least_one_scope
errors.add(:base, "Scopes can't be blank") unless read_repository || read_registry
end
end
......@@ -222,7 +222,8 @@ class Project < ActiveRecord::Base
has_many :environments
has_many :deployments
has_many :pipeline_schedules, class_name: 'Ci::PipelineSchedule'
has_many :deploy_tokens
has_many :project_deploy_tokens
has_many :deploy_tokens, through: :project_deploy_tokens
has_many :active_runners, -> { active }, through: :runner_projects, source: :runner, class_name: 'Ci::Runner'
......
class ProjectDeployToken < ActiveRecord::Base
belongs_to :project
belongs_to :deploy_token, inverse_of: :project_deploy_tokens
validates :deploy_token, presence: true
validates :project, presence: true
validates :deploy_token_id, uniqueness: { scope: [:project_id] }
accepts_nested_attributes_for :deploy_token
def redis_shared_state_key(user_id)
"gitlab:deploy_token:#{project_id}:#{user_id}"
end
end
......@@ -5,18 +5,10 @@ class DeployTokensPresenter < Gitlab::View::Presenter::Simple
presents :deploy_tokens
def available_scopes
DeployToken::AVAILABLE_SCOPES
end
def length
deploy_tokens.length
end
def scope_description(scope)
scope_descriptions[scope]
end
def each
deploy_tokens.each do |deploy_token|
yield deploy_token
......@@ -42,15 +34,8 @@ def attributes_deploy_token
private
def scope_descriptions
{
'read_repository' => s_('DeployTokens|Allows read-only access to the repository'),
'read_registry' => s_('DeployTokens|Allows read-only access to the registry images')
}
end
def deploy_token_key
@deploy_token_key ||= project.deploy_tokens.new.redis_shared_state_key(current_user.id)
@deploy_token_key ||= DeployToken.redis_shared_state_key(current_user.id)
end
end
end
......
......@@ -145,7 +145,7 @@ def user_can_pull?(requested_project)
has_authentication_ability?(:read_container_image) &&
can_user?(:read_container_image, requested_project)
end
def deploy_token_can_pull?(requested_project)
has_authentication_ability?(:read_container_image) &&
current_user.is_a?(DeployToken) &&
......@@ -165,7 +165,7 @@ def build_can_push?(requested_project)
def user_can_push?(requested_project)
has_authentication_ability?(:create_container_image) &&
can_user?(current_user, :create_container_image, requested_project)
can_user?(:create_container_image, requested_project)
end
def error(code, status:, message: '')
......
module DeployTokens
class CreateService < BaseService
REDIS_EXPIRY_TIME = 3.minutes
def execute
@project.deploy_tokens.build.tap do |deploy_token|
deploy_token.attributes = params
......@@ -13,7 +11,7 @@ def execute
private
def store_deploy_token_info_in_redis(deploy_token)
deploy_token_key = deploy_token.redis_shared_state_key(current_user.id)
deploy_token_key = DeployToken.redis_shared_state_key(current_user.id)
if deploy_token.persisted?
store_in_redis(deploy_token_key, deploy_token.token)
......@@ -31,7 +29,7 @@ def store_deploy_attributes(deploy_token_key, deploy_token)
def store_in_redis(key, value)
Gitlab::Redis::SharedState.with do |redis|
redis.set(key, value, ex: REDIS_EXPIRY_TIME)
redis.set(key, value, ex: 3.minutes)
end
end
end
......
......@@ -14,8 +14,15 @@
.form-group
= f.label :scopes, class: 'label-light'
- presenter.available_scopes.each do |scope|
= render 'projects/deploy_tokens/scope_form', token: token, scope: scope, presenter: presenter
%fieldset
= f.check_box :read_repository
= label_tag ("deploy_token_read_repository"), 'read_repository'
%span= s_('DeployTokens|Allows read-only access to the repository')
%fieldset
= f.check_box :read_registry
= label_tag ("deploy_token_read_registry"), 'read_registry'
%span= s_('DeployTokens|Allows read-only access to the registry images')
.prepend-top-default
= f.submit s_('DeployTokens|Create deploy token'), class: 'btn btn-success'
%fieldset
= check_box_tag "deploy_token[scopes][]", scope, token.scopes.include?(scope), id: "deploy_token_scopes_#{scope}"
= label_tag ("deploy_token_scopes_#{scope}"), scope
%span= presenter.scope_description(scope)
......@@ -3,10 +3,10 @@ class CreateDeployTokens < ActiveRecord::Migration
def change
create_table :deploy_tokens do |t|
t.references :project, index: true, foreign_key: true, null: false
t.string :name, null: false
t.string :token, index: { unique: true }, null: false
t.string :scopes
t.boolean :read_repository, default: false
t.boolean :read_registry, default: false
t.boolean :revoked, default: false
t.datetime :expires_at
......
class CreateProjectDeployTokens < ActiveRecord::Migration
include Gitlab::Database::MigrationHelpers
DOWNTIME = false
disable_ddl_transaction!
def up
create_table :project_deploy_tokens do |t|
t.integer :project_id, null: false
t.integer :deploy_token_id, null: false
t.timestamps null: false
end
add_concurrent_index :project_deploy_tokens, [:project_id, :deploy_token_id]
end
def down
drop_table :project_deploy_tokens
remove_index :project_deploy_tokens, column: [:project_id, :deploy_token_id] if index_exists?(:project_deploy_tokens, [:project_id, :deploy_token_id])
end
end
......@@ -11,7 +11,7 @@
#
# It's strongly recommended that you check this file into your version control system.
ActiveRecord::Schema.define(version: 20180405101928) do
ActiveRecord::Schema.define(version: 20180405142733) do
# These are extensions that must be enabled in order to support this database
enable_extension "plpgsql"
......@@ -684,17 +684,16 @@
add_index "deploy_keys_projects", ["project_id"], name: "index_deploy_keys_projects_on_project_id", using: :btree
create_table "deploy_tokens", force: :cascade do |t|
t.integer "project_id", null: false
t.string "name", null: false
t.string "token", null: false
t.string "scopes"
t.boolean "read_repository", default: false
t.boolean "read_registry", default: false
t.boolean "revoked", default: false
t.datetime "expires_at"
t.datetime "created_at", null: false
t.datetime "updated_at", null: false
end
add_index "deploy_tokens", ["project_id"], name: "index_deploy_tokens_on_project_id", using: :btree
add_index "deploy_tokens", ["token"], name: "index_deploy_tokens_on_token", unique: true, using: :btree
create_table "deployments", force: :cascade do |t|
......@@ -1444,6 +1443,15 @@
add_index "project_custom_attributes", ["key", "value"], name: "index_project_custom_attributes_on_key_and_value", using: :btree
add_index "project_custom_attributes", ["project_id", "key"], name: "index_project_custom_attributes_on_project_id_and_key", unique: true, using: :btree
create_table "project_deploy_tokens", force: :cascade do |t|
t.integer "project_id", null: false
t.integer "deploy_token_id", null: false
t.datetime "created_at", null: false
t.datetime "updated_at", null: false
end
add_index "project_deploy_tokens", ["project_id", "deploy_token_id"], name: "index_project_deploy_tokens_on_project_id_and_deploy_token_id", using: :btree
create_table "project_features", force: :cascade do |t|
t.integer "project_id"
t.integer "merge_requests_access_level"
......
......@@ -184,9 +184,9 @@ def deploy_token_check(login, password)
return unless token
return unless login != "gitlab+deploy-token-#{token.id}"
scopes = abilities_for_scopes(token.scopes)
if valid_scoped_token?(token, scopes)
if valid_scoped_token?(token, available_scopes)
Gitlab::Auth::Result.new(token, token.project, :deploy_token, scopes)
end
end
......
FactoryBot.define do
factory :deploy_token do
project
token { SecureRandom.hex(50) }
sequence(:name) { |n| "PDT #{n}" }
read_repository true
read_registry true
revoked false
expires_at { 5.days.from_now }
scopes %w(read_repository read_registry)
trait :revoked do
revoked true
end
trait :read_repository do
scopes ['read_repository']
end
trait :read_registry do
scopes ['read_registry']
end
end
end
FactoryBot.define do
factory :project_deploy_token do
project
deploy_token
end
end
......@@ -90,25 +90,26 @@
end
context 'Deploy tokens' do
let(:deploy_token) { create(:deploy_token, project: project) }
let(:deploy_token_project) { create(:project_deploy_token, project: project) }
let!(:deploy_token) { deploy_token_project.deploy_token }
before do
project.deploy_tokens << deploy_token
visit project_settings_repository_path(project)
end
scenario 'view deploy tokens' do
within('.deploy-tokens') do
expect(page).to have_content(deploy_token.name)
expect(page).to have_content(deploy_token.scopes.join(", "))
expect(page).to have_content('read_repository')
expect(page).to have_content('read_registry')
end
end
scenario 'add a new deploy token' do
fill_in 'deploy_token_name', with: 'new_deploy_key'
fill_in 'deploy_token_expires_at', with: (Date.today + 1.month).to_s
check 'deploy_token_scopes_read_repo'
check 'deploy_token_scopes_read_registry'
check 'deploy_token_read_repository'
check 'deploy_token_read_registry'
click_button 'Create deploy token'
expect(page).to have_content('Your new project deploy token has been created')
......@@ -120,7 +121,8 @@
click_link "Revoke #{deploy_token.name}"
expect(page).not_to have_content(deploy_token.name)
expect(page).not_to have_content(deploy_token.scopes.join(", "))
expect(page).not_to have_content('read_repository')
expect(page).not_to have_content('read_registry')
end
end
end
......
......@@ -261,7 +261,7 @@ def operation
let(:auth_failure) { Gitlab::Auth::Result.new(nil, nil) }
context 'when the deploy token has read_repository as scope' do
let(:deploy_token) { create(:deploy_token, :read_repository, project: project) }
let(:deploy_token) { create(:deploy_token, read_registry: false, projects: [project]) }
it 'succeeds when project is present, token is valid and has read_repository as scope' do
abilities = %i(read_project download_code)
......@@ -284,13 +284,6 @@ def operation
.to eq(auth_failure)
end
it 'fails for any other project' do
another_project = create(:project)
expect(gl_auth).to receive(:rate_limit!).with('ip', success: false, login: '')
expect(gl_auth.find_for_git_client('', deploy_token.token, project: another_project, ip: 'ip'))
.to eq(auth_failure)
end
it 'fails if token has been revoked' do
deploy_token.revoke!
......@@ -302,7 +295,7 @@ def operation
end
context 'when the deploy token has read_registry as a scope' do
let(:deploy_token) { create(:deploy_token, :read_registry, project: project) }
let(:deploy_token) { create(:deploy_token, read_repository: false, projects: [project]) }
context 'when registry enabled' do
before do
......
......@@ -147,25 +147,17 @@ def disable_protocol(protocol)
end
context 'when actor is DeployToken' do
context 'when DeployToken is active and belongs to project' do
let(:actor) { create(:deploy_token, :read_repo, project: project) }
let(:project_deploy_token) { create(:project_deploy_token, project: project) }
let(:actor) { project_deploy_token.deploy_token }
context 'when DeployToken is active and belongs to project' do
it 'allows pull access' do
expect { pull_access_check }.not_to raise_error
end
end
context 'when DeployToken has been revoked' do
let(:actor) { create(:deploy_token, :read_repo, project: project) }
it 'blocks pull access' do
actor.revoke!
expect { pull_access_check }.to raise_not_found
end
end
context 'when DeployToken does not belong to project' do
let(:actor) { create(:deploy_token, :read_repo) }
let(:actor) { create(:deploy_token) }
it 'blocks pull access' do
expect { pull_access_check }.to raise_not_found
......
require 'spec_helper'
describe DeployToken do
let(:deploy_token) { create(:deploy_token) }
subject(:deploy_token) { create(:deploy_token) }
it { is_expected.to belong_to :project }
it { is_expected.to validate_presence_of :project }
it { is_expected.to have_many :project_deploy_tokens }
it { is_expected.to have_many(:projects).through(:project_deploy_tokens) }
describe 'validations' do
context 'with no scopes defined' do
it 'should not be valid' do
deploy_token.scopes = []
describe '#ensure_token' do
it 'should ensure a token' do
deploy_token.token = nil
deploy_token.save
expect(deploy_token.token).not_to be_empty
end
end
describe '#ensure_at_least_one_scope' do
context 'with at least one scope' do
it 'should be valid' do
is_expected.to be_valid
end
end
context 'with no scopes' do
it 'should be invalid' do
deploy_token = build(:deploy_token, read_repository: false, read_registry: false)
expect(deploy_token).not_to be_valid
expect(deploy_token.errors[:scopes].first).to eq("can't be blank")
expect(deploy_token.errors[:base].first).to eq("Scopes can't be blank")
end
end
end
describe '#ensure_token' do
it 'should ensure a token' do
deploy_token.token = nil
deploy_token.save
describe '#scopes' do
context 'with all the scopes' do
it 'should return scopes assigned to DeployToken' do
expect(deploy_token.scopes).to eq([:read_repository, :read_registry])
end
end
expect(deploy_token.token).not_to be_empty
context 'with only one scope' do
it 'should return scopes assigned to DeployToken' do
deploy_token = create(:deploy_token, read_registry: false)
expect(deploy_token.scopes).to eq([:read_repository])
end
end
end
......@@ -50,8 +71,7 @@
describe '#username' do
it 'returns Ghost username' do
ghost = User.ghost
expect(deploy_token.username).to eq(ghost.username)
expect(deploy_token.username).to eq("gitlab+deploy-token-#{deploy_token.id}")
end
end
end
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment