-
Notifications
You must be signed in to change notification settings - Fork 872
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
Add IMDSv1 fallback (#2609) #2610
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -339,6 +339,7 @@ pub struct AmazonS3Builder { | |
token: Option<String>, | ||
retry_config: RetryConfig, | ||
allow_http: bool, | ||
imdsv1_fallback: bool, | ||
} | ||
|
||
impl AmazonS3Builder { | ||
|
@@ -446,6 +447,23 @@ impl AmazonS3Builder { | |
self | ||
} | ||
|
||
/// By default instance credentials will only be fetched over [IMDSv2], as AWS recommends | ||
/// against having IMDSv1 enabled on EC2 instances as it is vulnerable to [SSRF attack] | ||
/// | ||
/// However, certain deployment environments, such as those running old versions of kube2iam, | ||
/// may not support IMDSv2. This option will enable automatic fallback to using IMDSv1 | ||
/// if the token endpoint returns a 403 error indicating that IMDSv2 is not supported. | ||
/// | ||
/// This option has no effect if not using instance credentials | ||
/// | ||
/// [IMDSv2]: [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html] | ||
/// [SSRF attack]: [https://aws.amazon.com/blogs/security/defense-in-depth-open-firewalls-reverse-proxies-ssrf-vulnerabilities-ec2-instance-metadata-service/] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I really like that you describe the implications here and include some really helpful links to official docs 👍 |
||
/// | ||
pub fn with_imdsv1_fallback(mut self) -> Self { | ||
self.imdsv1_fallback = true; | ||
self | ||
} | ||
|
||
/// Create a [`AmazonS3`] instance from the provided values, | ||
/// consuming `self`. | ||
pub fn build(self) -> Result<AmazonS3> { | ||
|
@@ -503,6 +521,7 @@ impl AmazonS3Builder { | |
cache: Default::default(), | ||
client, | ||
retry_config: self.retry_config.clone(), | ||
imdsv1_fallback: self.imdsv1_fallback, | ||
}) | ||
} | ||
}, | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
// Licensed to the Apache Software Foundation (ASF) under one | ||
// or more contributor license agreements. See the NOTICE file | ||
// distributed with this work for additional information | ||
// regarding copyright ownership. The ASF licenses this file | ||
// to you under the Apache License, Version 2.0 (the | ||
// "License"); you may not use this file except in compliance | ||
// with the License. You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, | ||
// software distributed under the License is distributed on an | ||
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
// KIND, either express or implied. See the License for the | ||
// specific language governing permissions and limitations | ||
// under the License. | ||
|
||
use hyper::service::{make_service_fn, service_fn}; | ||
use hyper::{Body, Request, Response, Server}; | ||
use parking_lot::Mutex; | ||
use std::collections::VecDeque; | ||
use std::convert::Infallible; | ||
use std::net::SocketAddr; | ||
use std::sync::Arc; | ||
use tokio::sync::oneshot; | ||
use tokio::task::JoinHandle; | ||
|
||
pub type ResponseFn = Box<dyn FnOnce(Request<Body>) -> Response<Body> + Send>; | ||
|
||
/// A mock server | ||
pub struct MockServer { | ||
responses: Arc<Mutex<VecDeque<ResponseFn>>>, | ||
shutdown: oneshot::Sender<()>, | ||
handle: JoinHandle<()>, | ||
url: String, | ||
} | ||
|
||
impl MockServer { | ||
pub fn new() -> Self { | ||
let responses: Arc<Mutex<VecDeque<ResponseFn>>> = | ||
Arc::new(Mutex::new(VecDeque::with_capacity(10))); | ||
|
||
let r = Arc::clone(&responses); | ||
let make_service = make_service_fn(move |_conn| { | ||
let r = Arc::clone(&r); | ||
async move { | ||
Ok::<_, Infallible>(service_fn(move |req| { | ||
let r = Arc::clone(&r); | ||
async move { | ||
Ok::<_, Infallible>(match r.lock().pop_front() { | ||
Some(r) => r(req), | ||
None => Response::new(Body::from("Hello World")), | ||
}) | ||
} | ||
})) | ||
} | ||
}); | ||
|
||
let (shutdown, rx) = oneshot::channel::<()>(); | ||
let server = | ||
Server::bind(&SocketAddr::from(([127, 0, 0, 1], 0))).serve(make_service); | ||
|
||
let url = format!("http://{}", server.local_addr()); | ||
|
||
let handle = tokio::spawn(async move { | ||
server | ||
.with_graceful_shutdown(async { | ||
rx.await.ok(); | ||
}) | ||
.await | ||
.unwrap() | ||
}); | ||
|
||
Self { | ||
responses, | ||
shutdown, | ||
handle, | ||
url, | ||
} | ||
} | ||
|
||
/// The url of the mock server | ||
pub fn url(&self) -> &str { | ||
&self.url | ||
} | ||
|
||
/// Add a response | ||
pub fn push(&self, response: Response<Body>) { | ||
self.push_fn(|_| response) | ||
} | ||
|
||
/// Add a response function | ||
pub fn push_fn<F>(&self, f: F) | ||
where | ||
F: FnOnce(Request<Body>) -> Response<Body> + Send + 'static, | ||
{ | ||
self.responses.lock().push_back(Box::new(f)) | ||
} | ||
|
||
/// Shutdown the mock server | ||
pub async fn shutdown(self) { | ||
let _ = self.shutdown.send(()); | ||
self.handle.await.unwrap() | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There wasn't an obvious way to use the ec2-metadata-mock to test this fallback, so I opted to reuse the plumbing from the retry tests. More test coverage can't hurt 😄