Skip to content

Commit 14e06f9

Browse files
committed
added section on IMDS version to the readme
1 parent 1ae1487 commit 14e06f9

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

deps/rabbitmq_aws/README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,16 @@ The credentials values have the following precedence:
3434
- Environment variables
3535
- Credentials file
3636
- EC2 Instance Metadata Service
37-
37+
38+
### EC2 Instance Metadata Service Versions
39+
40+
There are two versions of the EC2 Instance Metadata Service that are available by default on EC2 instances; IMDSv1 and IMDSv2 which is protected by session authencation
41+
and [adds defenses against aditional vulnerabilities](https://aws.amazon.com/blogs/security/defense-in-depth-open-firewalls-reverse-proxies-ssrf-vulnerabilities-ec2-instance-metadata-service/).
42+
AWS recommends adopting IMDSv2 and disabling IMDSv1 [by configuring the Instance Metadata Service on the EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html).
43+
44+
By default *rabbitmq-aws* will attempt to use IMDSv2 first and will fallback to use IMDSv1 if calls to IMDSv2 fail. This behavior can be overridden
45+
by setting the ``aws_prefer_imdsv2`` setting to ``false``.
46+
3847
### Environment Variables
3948

4049
As with the AWS CLI, the following environment variables can be used to provide
@@ -67,7 +76,7 @@ configuration or to impact configuration behavior:
6776
## Example Usage
6877

6978
The following example assumes that you either have locally configured credentials or that
70-
you're using the AWS Instance Metadata service for credentials:
79+
you're using the EC2 Instance Metadata Service for credentials:
7180

7281
```erlang
7382
application:start(rabbitmq_aws).

0 commit comments

Comments
 (0)