Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Process credentials #178

Merged
merged 1 commit into from
Apr 17, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,27 @@ Path to the shared file. Defaults to "#{Dir.home}/.aws/credentials".

Defaults to 'default' or `[ENV]('AWS_PROFILE')`.

### process_credentials

This loads AWS access credentials from an external process.

<match *>
@type kinesis_streams

<process_credentials>
process CMD
</process_credentials>
</match>

See also:

* [Aws::ProcessCredentials](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ProcessCredentials.html)
* [Sourcing Credentials From External Processes](https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes)

**process (required)**

Command to be executed as an external process.

## Configuration: Format

### format (section)
Expand Down
11 changes: 11 additions & 0 deletions lib/fluent/plugin/kinesis_helper/client.rb
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,10 @@ module ClientParams
desc "Profile name. Default to 'default' or ENV['AWS_PROFILE']"
config_param :profile_name, :string, default: nil
end
config_section :process_credentials, multi: false do
desc "External process to execute."
config_param :process, :string
end
end

def self.included(mod)
Expand Down Expand Up @@ -146,6 +150,13 @@ def setup_credentials
credentials_options[:path] = c.path if c.path
credentials_options[:profile_name] = c.profile_name if c.profile_name
options[:credentials] = Aws::SharedCredentials.new(credentials_options)
when @process_credentials
if Gem::Version.new(Aws::CORE_GEM_VERSION) < Gem::Version.new('3.24.0')
raise Fluent::ConfigError, "Config process_credentials requires aws-sdk-core >= 3.24.0. Found aws-sdk-core #{Aws::CORE_GEM_VERSION} instead."
end
c = @process_credentials
process = c.process
options[:credentials] = Aws::ProcessCredentials.new(process)
else
# Use default credentials
# See http://docs.aws.amazon.com/sdkforruby/api/Aws/S3/Client.html
Expand Down
53 changes: 48 additions & 5 deletions test/kinesis_helper/test_client.rb
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,39 @@
require 'fluent/plugin/kinesis_helper/client'

class KinesisHelperClientTest < Test::Unit::TestCase
class Mock
class ProcessCredentials
def self.process
expiration = Time.now.utc + 3600
response = {
:SecretAccessKey => "secret",
:SessionToken => "session-token",
:Version => 1,
:Expiration => expiration.strftime('%Y-%m-%dT%H:%M:%SZ'),
:AccessKeyId => "akid"
}.to_json

"echo '#{response}'"
end
end

class MockClientInstanceProfile
include Fluent::Plugin::KinesisHelper::Client

def initialize
@region = 'us-east-1'
end

def request_type
:firehose
end
end

class MockClientProcessCredentials
include Fluent::Plugin::KinesisHelper::Client

def initialize
@region = 'us-east-1'
@process_credentials = ProcessCredentials
end

def request_type
Expand All @@ -35,8 +63,6 @@ def self.startup
def setup
WebMock.enable!
FakeFS.activate!
@object = Mock.new
Aws.shared_config.fresh
end

def teardown
Expand All @@ -46,21 +72,38 @@ def teardown
end

def test_instance_profile
Aws.shared_config.fresh
setup_instance_profile
credentials = @object.client.config.credentials
credentials = MockClientInstanceProfile.new.client.config.credentials
assert_equal 'akid', credentials.credentials.access_key_id
assert_equal 'secret', credentials.credentials.secret_access_key
assert_equal 'session-token', credentials.credentials.session_token
end

def test_instance_profile_refresh
Aws.shared_config.fresh
setup_instance_profile(Time.now.utc + 299)
credentials = @object.client.config.credentials
credentials = MockClientInstanceProfile.new.client.config.credentials
assert_equal 'akid-2', credentials.credentials.access_key_id
assert_equal 'secret-2', credentials.credentials.secret_access_key
assert_equal 'session-token-2', credentials.credentials.session_token
end

def test_process_credentials
omit_if(Gem::Version.new(Aws::CORE_GEM_VERSION) < Gem::Version.new('3.24.0'))
credentials = MockClientProcessCredentials.new.client.config.credentials
assert_equal 'akid', credentials.credentials.access_key_id
assert_equal 'secret', credentials.credentials.secret_access_key
assert_equal 'session-token', credentials.credentials.session_token
end

def test_process_credentials_config_error
omit_if(Gem::Version.new(Aws::CORE_GEM_VERSION) >= Gem::Version.new('3.24.0'))
assert_raise(Fluent::ConfigError) do
MockClientProcessCredentials.new.client.config.credentials
end
end

private

def setup_instance_profile(expiration = Time.now.utc + 3600)
Expand Down