Deuxfleurs
/
garage
42
36
Fork 55
Code Issues 64 Pull Requests 4 Releases 29 Wiki Activity

web_server.rs: Log X-Forwarded-For IP #504

Merged
lx merged 3 commits from jpds/garage:web_server-log-x-forwarded-for into main 2023-03-06 12:33:07 +00:00
Conversation 3 Commits 3 Files Changed 4 +82 -10
jpds commented 2023-02-11 15:11:50 +00:00
Contributor
Copy Link
No description provided.
jpds force-pushed web_server-log-x-forwarded-for from b8be8b6af4 to e840c9b5b8 2023-02-11 15:18:05 +00:00 Compare
quentin commented 2023-02-28 17:42:28 +00:00
Owner
Copy Link

Do you confirm this work is the continuation of #500 but for the web endpoint?

Do you confirm this work is the continuation of #500 but for the web endpoint?
jpds commented 2023-03-01 11:38:56 +00:00
Author
Contributor
Copy Link

@quentin Indeed, it is.

@quentin Indeed, it is.
lx requested changes 2023-03-01 19:05:01 +00:00
lx left a comment
Owner
Copy Link

Proposing some changes to make code more consise and better exploit Rust's type system

Proposing some changes to make code more consise and better exploit Rust's type system
src/api/generic_server.rs Outdated
@ -135,2 +132,2 @@
.to_str()
.unwrap_or_default();
let forwarded_for_ip_addr =
forwarded_headers::handle_forwarded_for_headers(&req.headers());
lx commented 2023-03-01 19:03:54 +00:00
Owner
Copy Link

With handle_forwarded_for_headers returning a Result (see below), lines 130-133 should be rewritten as follows:

if let Ok(forwarded_for_ip_addr) = forwarded_headers::handle_forwarded_for_headers(&req.headers()) {

  info!(...)
With `handle_forwarded_for_headers` returning a `Result` (see below), lines 130-133 should be rewritten as follows: ```rust if let Ok(forwarded_for_ip_addr) = forwarded_headers::handle_forwarded_for_headers(&req.headers()) { info!(...) ```
jpds marked this conversation as resolved
src/util/forwarded_headers.rs Outdated
@ -0,0 +1,42 @@
use http::{HeaderMap, HeaderValue};
pub fn handle_forwarded_for_headers(headers: &HeaderMap<HeaderValue>) -> String {
lx commented 2023-03-01 19:02:39 +00:00
Owner
Copy Link

This function should return a Result<String, Error>, which is Ok if the value exists and passes all the checks, and Err otherwise.

This function should return a `Result<String, Error>`, which is `Ok` if the value exists and passes all the checks, and `Err` otherwise.
jpds marked this conversation as resolved
src/web/web_server.rs Outdated
@ -108,0 +108,4 @@
let has_forwarded_for_header = req.headers().contains_key("x-forwarded-for");
if has_forwarded_for_header {
let forwarded_for_ip_addr =
forwarded_headers::handle_forwarded_for_headers(&req.headers());
lx commented 2023-03-01 19:04:35 +00:00
Owner
Copy Link

Same as above, lines 108-111 should be rewritten as:

if let Ok(forwarded_for_ip_addr) = forwarded_headers::handle_forwarded_for_headers(&req.headers()) {

  info!(...)
Same as above, lines 108-111 should be rewritten as: ```rust if let Ok(forwarded_for_ip_addr) = forwarded_headers::handle_forwarded_for_headers(&req.headers()) { info!(...) ```
jpds marked this conversation as resolved
jpds force-pushed web_server-log-x-forwarded-for from e840c9b5b8 to b65af6df86 2023-03-03 14:33:54 +00:00 Compare
jpds force-pushed web_server-log-x-forwarded-for from b65af6df86 to f65beea554 2023-03-03 15:38:07 +00:00 Compare
jpds force-pushed web_server-log-x-forwarded-for from f65beea554 to 401a737acf 2023-03-03 15:40:55 +00:00 Compare
jpds force-pushed web_server-log-x-forwarded-for from 401a737acf to 9f026396f6 2023-03-03 17:24:45 +00:00 Compare
jpds force-pushed web_server-log-x-forwarded-for from 9f026396f6 to 872ffe68bd 2023-03-03 19:18:11 +00:00 Compare
lx requested changes 2023-03-06 10:19:33 +00:00
src/api/generic_server.rs Outdated
@ -128,20 +129,17 @@ impl<A: ApiHandler> ApiServer<A> {
let has_forwarded_for_header = req.headers().contains_key("x-forwarded-for");
if has_forwarded_for_header {
lx commented 2023-03-06 10:18:42 +00:00
Owner
Copy Link

You don't need lines 130-131, just use the second if (the if let statement) with the else branch of the first one.

You don't need lines 130-131, just use the second if (the `if let` statement) with the else branch of the first one.
src/web/web_server.rs Outdated
@ -106,2 +107,3 @@
) -> Result<Response<Body>, Infallible> {
info!("{} {} {}", addr, req.method(), req.uri());
let has_forwarded_for_header = req.headers().contains_key("x-forwarded-for");
if has_forwarded_for_header {
lx commented 2023-03-06 10:18:55 +00:00
Owner
Copy Link

Same here

Same here
jpds force-pushed web_server-log-x-forwarded-for from 872ffe68bd to 4e0fc3d6c9 2023-03-06 11:44:13 +00:00 Compare
lx commented 2023-03-06 12:33:03 +00:00
Owner
Copy Link

Thanks!

Thanks!
lx merged commit 00dcfc97a5 into main 2023-03-06 12:33:07 +00:00
jpds deleted branch web_server-log-x-forwarded-for 2023-03-06 12:36:17 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
lx
Labels
Clear labels   
AdminAPI

Issues concerning the administration API

  
Bug

   
Check AWS

The behaviour should be checked against AWS S3

  
CI

Issues with Nix, Drone, Rust Compiler, etc.

  
Correctness

Issues of theoretical correctness that may impact edge-case scenarios

  
Critical

   
Documentation

   
Ideas

For abstract ideas/proposal to make Garage better, to better communicate our not yet achieved aims

  
Improvement

   
Low priority

For issues that we don't want to spend time on until made absolutely necessary

  
Newcomer

A bug that should be newcomer friendly.

  
Performance

   
S3 Compatibility

   
Testing

   
Usability

Propositions to make Garage easier to operate, by improving error reporting, CLI, etc.

No Label
AdminAPI
Bug
Check AWS
CI
Correctness
Critical
Documentation
Ideas
Improvement
Low priority
Newcomer
Performance
S3 Compatibility
Testing
Usability
Milestone
Clear milestone
No items
No Milestone
Assignees
Clear assignees
No Assignees
3 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: Deuxfleurs/garage#504
No description provided.
Delete Branch "jpds/garage:web_server-log-x-forwarded-for"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?