Commit 725b3837 authored by Dmitriy Zaporozhets's avatar Dmitriy Zaporozhets

Merge branch 'fix/thread-safe-gpgme-tmp-directory' into 'master'

Fix: Thread safe GPGME tmp directory

Closes #35986

See merge request !13481
parents 56054c3f a1759666
---
title: Make GPGME temporary directory handling thread safe
merge_request: 13481
author: Alexis Reigel
...@@ -2,6 +2,8 @@ module Gitlab ...@@ -2,6 +2,8 @@ module Gitlab
module Gpg module Gpg
extend self extend self
MUTEX = Mutex.new
module CurrentKeyChain module CurrentKeyChain
extend self extend self
...@@ -42,21 +44,37 @@ module Gitlab ...@@ -42,21 +44,37 @@ module Gitlab
end end
end end
def using_tmp_keychain # Allows thread safe switching of temporary keychain files
Dir.mktmpdir do |dir| #
@original_dirs ||= [GPGME::Engine.dirinfo('homedir')] # 1. The current thread may use nesting of temporary keychain
@original_dirs.push(dir) # 2. Another thread needs to wait for the lock to be released
def using_tmp_keychain(&block)
GPGME::Engine.home_dir = dir if MUTEX.locked? && MUTEX.owned?
optimistic_using_tmp_keychain(&block)
return_value = yield else
MUTEX.synchronize do
optimistic_using_tmp_keychain(&block)
end
end
end
@original_dirs.pop # 1. Returns the custom home directory if one has been set by calling
# `GPGME::Engine.home_dir=`
# 2. Returns the default home directory otherwise
def current_home_dir
GPGME::Engine.info.first.home_dir || GPGME::Engine.dirinfo('homedir')
end
GPGME::Engine.home_dir = @original_dirs[-1] private
return_value def optimistic_using_tmp_keychain
previous_dir = current_home_dir
Dir.mktmpdir do |dir|
GPGME::Engine.home_dir = dir
yield
end end
ensure
GPGME::Engine.home_dir = previous_dir
end end
end end
end end
...@@ -43,6 +43,58 @@ describe Gitlab::Gpg do ...@@ -43,6 +43,58 @@ describe Gitlab::Gpg do
).to eq [] ).to eq []
end end
end end
describe '.current_home_dir' do
let(:default_home_dir) { GPGME::Engine.dirinfo('homedir') }
it 'returns the default value when no explicit home dir has been set' do
expect(described_class.current_home_dir).to eq default_home_dir
end
it 'returns the explicitely set home dir' do
GPGME::Engine.home_dir = '/tmp/gpg'
expect(described_class.current_home_dir).to eq '/tmp/gpg'
GPGME::Engine.home_dir = GPGME::Engine.dirinfo('homedir')
end
it 'returns the default value when explicitely setting the home dir to nil' do
GPGME::Engine.home_dir = nil
expect(described_class.current_home_dir).to eq default_home_dir
end
end
describe '.using_tmp_keychain' do
it "the second thread does not change the first thread's directory" do
thread1 = Thread.new do
described_class.using_tmp_keychain do
dir = described_class.current_home_dir
sleep 0.1
expect(described_class.current_home_dir).to eq dir
end
end
thread2 = Thread.new do
described_class.using_tmp_keychain do
sleep 0.2
end
end
thread1.join
thread2.join
end
it 'allows recursive execution in the same thread' do
expect do
described_class.using_tmp_keychain do
described_class.using_tmp_keychain do
end
end
end.not_to raise_error(ThreadError)
end
end
end end
describe Gitlab::Gpg::CurrentKeyChain do describe Gitlab::Gpg::CurrentKeyChain do
......
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