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

Cherry-pick #16263 to 7.x: Add endpoint into AWS config #16389

Merged
merged 1 commit into from
Feb 18, 2020
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
1 change: 1 addition & 0 deletions CHANGELOG.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ processing events. (CVE-2019-17596) See https://www.elastic.co/community/securit
- Libbeat HTTP's Server can listen to a unix socket using the `unix:///tmp/hello.sock` syntax. {pull}13655[13655]
- Libbeat HTTP's Server can listen to a Windows named pipe using the `npipe:///hello` syntax. {pull}13655[13655]
- Adding new `Enterprise` license type to the licenser. {issue}14246[14246]
- Add endpoint config in AWS config to support using custom endpoint accessing AWS APIs. {issue}16245[16245] {pull}16263[16263]

*Auditbeat*

Expand Down
29 changes: 18 additions & 11 deletions filebeat/docs/modules/aws.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,18 +33,12 @@ Example config:
- module: aws
s3access:
enabled: false

# AWS SQS queue url
#var.queue_url: https://sqs.myregion.amazonaws.com/123456/myqueue

# Filename of AWS credential file
# If not set "$HOME/.aws/credentials" is used on Linux/Mac
# "%UserProfile%\.aws\credentials" is used on Windows
# var.shared_credential_file: /etc/filebeat/aws_credentials

# Profile name for aws credential
# If not set the default profile is used
# var.credential_profile_name: fb-aws
#var.shared_credential_file: /etc/filebeat/aws_credentials
#var.credential_profile_name: fb-aws
#var.visibility_timeout: 300s
#var.api_timeout: 120s
#var.endpoint: amazonaws.com

elb:
enabled: false
Expand Down Expand Up @@ -104,6 +98,19 @@ Filename of AWS credential file.

AWS credential profile name.

*`var.visibility_timeout`*::

The duration that the received messages are hidden from ReceiveMessage request.
Default to be 300 seconds.

*`var.api_timeout`*::

Maximum duration before AWS API request will be interrupted. Default to be 120 seconds.

*`var.endpoint`*::

Custom endpoint used to access AWS APIs.

[float]
=== cloudtrail fileset

Expand Down
12 changes: 12 additions & 0 deletions x-pack/filebeat/filebeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,9 @@ filebeat.modules:
# Default to be 120s
#var.api_timeout: 120s

# Custom endpoint used to access AWS APIs
#var.endpoint: amazonaws.com

elb:
enabled: false

Expand All @@ -142,6 +145,9 @@ filebeat.modules:
# Default to be 120s
#var.api_timeout: 120s

# Custom endpoint used to access AWS APIs
#var.endpoint: amazonaws.com

vpcflow:
enabled: false

Expand All @@ -165,6 +171,9 @@ filebeat.modules:
# Default to be 120s
#var.api_timeout: 120s

# Custom endpoint used to access AWS APIs
#var.endpoint: amazonaws.com

cloudtrail:
enabled: false

Expand All @@ -188,6 +197,9 @@ filebeat.modules:
# Default to be 120s
#var.api_timeout: 120s

# Custom endpoint used to access AWS APIs
#var.endpoint: amazonaws.com

#-------------------------------- Azure Module --------------------------------
- module: azure
# All logs
Expand Down
5 changes: 3 additions & 2 deletions x-pack/filebeat/input/s3/input.go
Original file line number Diff line number Diff line change
Expand Up @@ -181,8 +181,9 @@ func (p *s3Input) Run() {

awsConfig := p.awsConfig.Copy()
awsConfig.Region = regionName
svcSQS := sqs.New(awsConfig)
svcS3 := s3.New(awsConfig)

svcSQS := sqs.New(awscommon.EnrichAWSConfigWithEndpoint(p.config.AwsConfig.Endpoint, "sqs", regionName, awsConfig))
svcS3 := s3.New(awscommon.EnrichAWSConfigWithEndpoint(p.config.AwsConfig.Endpoint, "s3", regionName, awsConfig))

p.workerWg.Add(1)
go p.run(svcSQS, svcS3, visibilityTimeout)
Expand Down
12 changes: 12 additions & 0 deletions x-pack/filebeat/module/aws/_meta/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@
# Default to be 120s
#var.api_timeout: 120s

# Custom endpoint used to access AWS APIs
#var.endpoint: amazonaws.com

elb:
enabled: false

Expand All @@ -45,6 +48,9 @@
# Default to be 120s
#var.api_timeout: 120s

# Custom endpoint used to access AWS APIs
#var.endpoint: amazonaws.com

vpcflow:
enabled: false

Expand All @@ -68,6 +74,9 @@
# Default to be 120s
#var.api_timeout: 120s

# Custom endpoint used to access AWS APIs
#var.endpoint: amazonaws.com

cloudtrail:
enabled: false

Expand All @@ -90,3 +99,6 @@
# Maximum duration before AWS API request will be interrupted
# Default to be 120s
#var.api_timeout: 120s

# Custom endpoint used to access AWS APIs
#var.endpoint: amazonaws.com
29 changes: 18 additions & 11 deletions x-pack/filebeat/module/aws/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,12 @@ Example config:
- module: aws
s3access:
enabled: false
# AWS SQS queue url
#var.queue_url: https://sqs.myregion.amazonaws.com/123456/myqueue
# Filename of AWS credential file
# If not set "$HOME/.aws/credentials" is used on Linux/Mac
# "%UserProfile%\.aws\credentials" is used on Windows
# var.shared_credential_file: /etc/filebeat/aws_credentials
# Profile name for aws credential
# If not set the default profile is used
# var.credential_profile_name: fb-aws
#var.shared_credential_file: /etc/filebeat/aws_credentials
#var.credential_profile_name: fb-aws
#var.visibility_timeout: 300s
#var.api_timeout: 120s
#var.endpoint: amazonaws.com
elb:
enabled: false
Expand Down Expand Up @@ -99,6 +93,19 @@ Filename of AWS credential file.

AWS credential profile name.

*`var.visibility_timeout`*::

The duration that the received messages are hidden from ReceiveMessage request.
Default to be 300 seconds.

*`var.api_timeout`*::

Maximum duration before AWS API request will be interrupted. Default to be 120 seconds.

*`var.endpoint`*::

Custom endpoint used to access AWS APIs.

[float]
=== cloudtrail fileset

Expand Down
4 changes: 4 additions & 0 deletions x-pack/filebeat/module/aws/cloudtrail/config/cloudtrail.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ visibility_timeout: {{ .visibility_timeout }}
api_timeout: {{ .api_timeout }}
{{ end }}

{{ if .endpoint }}
endpoint: {{ .endpoint }}
{{ end }}

{{ else if eq .input "file" }}

type: log
Expand Down
1 change: 1 addition & 0 deletions x-pack/filebeat/module/aws/cloudtrail/manifest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ var:
- name: credential_profile_name
- name: visibility_timeout
- name: api_timeout
- name: endpoint

ingest_pipeline: ingest/pipeline.yml
input: config/cloudtrail.yml
4 changes: 4 additions & 0 deletions x-pack/filebeat/module/aws/elb/config/s3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,7 @@ visibility_timeout: {{ .visibility_timeout }}
{{ if .api_timeout }}
api_timeout: {{ .api_timeout }}
{{ end }}

{{ if .endpoint }}
endpoint: {{ .endpoint }}
{{ end }}
1 change: 1 addition & 0 deletions x-pack/filebeat/module/aws/elb/manifest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ var:
- name: credential_profile_name
- name: visibility_timeout
- name: api_timeout
- name: endpoint

ingest_pipeline: ingest/pipeline.yml
input: config/{{.input}}.yml
Expand Down
4 changes: 4 additions & 0 deletions x-pack/filebeat/module/aws/s3access/config/s3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,7 @@ visibility_timeout: {{ .visibility_timeout }}
{{ if .api_timeout }}
api_timeout: {{ .api_timeout }}
{{ end }}

{{ if .endpoint }}
endpoint: {{ .endpoint }}
{{ end }}
1 change: 1 addition & 0 deletions x-pack/filebeat/module/aws/s3access/manifest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ var:
- name: credential_profile_name
- name: visibility_timeout
- name: api_timeout
- name: endpoint

ingest_pipeline: ingest/pipeline.yml
input: config/{{.input}}.yml
4 changes: 4 additions & 0 deletions x-pack/filebeat/module/aws/vpcflow/config/input.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ visibility_timeout: {{ .visibility_timeout }}
api_timeout: {{ .api_timeout }}
{{ end }}

{{ if .endpoint }}
endpoint: {{ .endpoint }}
{{ end }}

{{ else if eq .input "file" }}

type: log
Expand Down
1 change: 1 addition & 0 deletions x-pack/filebeat/module/aws/vpcflow/manifest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ var:
- name: credential_profile_name
- name: visibility_timeout
- name: api_timeout
- name: endpoint

ingest_pipeline: ingest/pipeline.yml
input: config/input.yml
12 changes: 12 additions & 0 deletions x-pack/filebeat/modules.d/aws.yml.disabled
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@
# Default to be 120s
#var.api_timeout: 120s

# Custom endpoint used to access AWS APIs
#var.endpoint: amazonaws.com

elb:
enabled: false

Expand All @@ -48,6 +51,9 @@
# Default to be 120s
#var.api_timeout: 120s

# Custom endpoint used to access AWS APIs
#var.endpoint: amazonaws.com

vpcflow:
enabled: false

Expand All @@ -71,6 +77,9 @@
# Default to be 120s
#var.api_timeout: 120s

# Custom endpoint used to access AWS APIs
#var.endpoint: amazonaws.com

cloudtrail:
enabled: false

Expand All @@ -93,3 +102,6 @@
# Maximum duration before AWS API request will be interrupted
# Default to be 120s
#var.api_timeout: 120s

# Custom endpoint used to access AWS APIs
#var.endpoint: amazonaws.com
7 changes: 5 additions & 2 deletions x-pack/libbeat/autodiscover/providers/aws/ec2/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,9 @@ func AutodiscoverBuilder(bus bus.Bus, uuid uuid.UUID, c *common.Config) (autodis
if config.Regions == nil {
// set default region to make initial aws api call
awsCfg.Region = "us-west-1"
svcEC2 := ec2.New(awsCfg)
svcEC2 := ec2.New(awscommon.EnrichAWSConfigWithEndpoint(
config.AWSConfig.Endpoint, "ec2", awsCfg.Region, awsCfg))

completeRegionsList, err := awsauto.GetRegions(svcEC2)
if err != nil {
return nil, err
Expand All @@ -72,7 +74,8 @@ func AutodiscoverBuilder(bus bus.Bus, uuid uuid.UUID, c *common.Config) (autodis
logp.Error(errors.Wrap(err, "error loading AWS config for aws_ec2 autodiscover provider"))
}
awsCfg.Region = region
clients = append(clients, ec2.New(awsCfg))
clients = append(clients, ec2.New(awscommon.EnrichAWSConfigWithEndpoint(
config.AWSConfig.Endpoint, "ec2", region, awsCfg)))
}

return internalBuilder(uuid, bus, config, newAPIFetcher(clients))
Expand Down
7 changes: 5 additions & 2 deletions x-pack/libbeat/autodiscover/providers/aws/elb/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,9 @@ func AutodiscoverBuilder(bus bus.Bus, uuid uuid.UUID, c *common.Config) (autodis
if config.Regions == nil {
// set default region to make initial aws api call
awsCfg.Region = "us-west-1"
svcEC2 := ec2.New(awsCfg)
svcEC2 := ec2.New(awscommon.EnrichAWSConfigWithEndpoint(
config.AWSConfig.Endpoint, "ec2", awsCfg.Region, awsCfg))

completeRegionsList, err := awsauto.GetRegions(svcEC2)
if err != nil {
return nil, err
Expand All @@ -79,7 +81,8 @@ func AutodiscoverBuilder(bus bus.Bus, uuid uuid.UUID, c *common.Config) (autodis
logp.Err("error loading AWS config for aws_elb autodiscover provider: %s", err)
}
awsCfg.Region = region
clients = append(clients, elasticloadbalancingv2.New(awsCfg))
clients = append(clients, elasticloadbalancingv2.New(awscommon.EnrichAWSConfigWithEndpoint(
config.AWSConfig.Endpoint, "elasticloadbalancing", region, awsCfg)))
}

return internalBuilder(uuid, bus, config, newAPIFetcher(clients))
Expand Down
21 changes: 20 additions & 1 deletion x-pack/libbeat/common/aws/credentials.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ type ConfigAWS struct {
SessionToken string `config:"session_token"`
ProfileName string `config:"credential_profile_name"`
SharedCredentialFile string `config:"shared_credential_file"`
Endpoint string `config:"endpoint"`
}

// GetAWSCredentials function gets aws credentials from the config.
Expand Down Expand Up @@ -57,5 +58,23 @@ func GetAWSCredentials(config ConfigAWS) (awssdk.Config, error) {
if config.SharedCredentialFile != "" {
options = append(options, external.WithSharedConfigFiles([]string{config.SharedCredentialFile}))
}
return external.LoadDefaultAWSConfig(options...)

awsConfig, err := external.LoadDefaultAWSConfig(options...)
if err != nil {
return awsConfig, err
}
return awsConfig, nil
}

// EnrichAWSConfigWithEndpoint function enabled endpoint resolver for AWS
// service clients when endpoint is given in config.
func EnrichAWSConfigWithEndpoint(endpoint string, serviceName string, regionName string, awsConfig awssdk.Config) awssdk.Config {
if endpoint != "" {
if regionName == "" {
awsConfig.EndpointResolver = awssdk.ResolveWithEndpointURL("https://" + serviceName + "." + endpoint)
} else {
awsConfig.EndpointResolver = awssdk.ResolveWithEndpointURL("https://" + serviceName + "." + regionName + "." + endpoint)
}
}
return awsConfig
}
Loading