gsadmin/rustfs
1
0
Fork 0
mirror of https://github.com/rustfs/rustfs.git synced 2026-08-24 05:06:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(admin): require admin auth for metrics (#3562)

Browse Source 
fix: require admin auth for metrics
This commit is contained in:
houseme
2026-06-18 12:39:16 +08:00
committed by GitHub
parent a30cafa73f
commit d2a135b397
3 changed files with 75 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
crates/policy/src/policy/action.rs
+8
View File
@@ -500,6 +500,8 @@ pub enum AdminAction {
SetBucketTargetAction, SetBucketTargetAction,
#[strum(serialize = "admin:GetBucketTarget")] #[strum(serialize = "admin:GetBucketTarget")]
GetBucketTargetAction, GetBucketTargetAction,
#[strum(serialize = "admin:GetMetrics")]
GetMetricsAction,
#[strum(serialize = "admin:ReplicationDiff")] #[strum(serialize = "admin:ReplicationDiff")]
ReplicationDiff, ReplicationDiff,
#[strum(serialize = "admin:GetReplicationMetrics")] #[strum(serialize = "admin:GetReplicationMetrics")]
@@ -656,6 +658,7 @@ impl AdminAction {
| AdminAction::SetBucketQuotaAdminAction | AdminAction::SetBucketQuotaAdminAction
| AdminAction::SetBucketTargetAction | AdminAction::SetBucketTargetAction
| AdminAction::GetBucketTargetAction | AdminAction::GetBucketTargetAction
| AdminAction::GetMetricsAction
| AdminAction::ReplicationDiff | AdminAction::ReplicationDiff
| AdminAction::GetReplicationMetricsAction | AdminAction::GetReplicationMetricsAction
| AdminAction::ImportBucketMetadataAction | AdminAction::ImportBucketMetadataAction
@@ -820,6 +823,11 @@ mod tests {
assert!(AdminAction::GetReplicationMetricsAction.is_valid()); assert!(AdminAction::GetReplicationMetricsAction.is_valid());
} }
#[test]
fn test_get_metrics_admin_action_is_valid() {
assert!(AdminAction::GetMetricsAction.is_valid());
}
#[test] #[test]
fn test_table_catalog_admin_action_is_valid() { fn test_table_catalog_admin_action_is_valid() {
let get_action = AdminAction::try_from("admin:GetTableCatalog").expect("Should parse GetTableCatalog action"); let get_action = AdminAction::try_from("admin:GetTableCatalog").expect("Should parse GetTableCatalog action");
rustfs/src/admin/handlers/metrics.rs
+60 -6
View File
@@ -18,7 +18,10 @@
//! keeping the response format explicitly NDJSON. It is not a Prometheus text //! keeping the response format explicitly NDJSON. It is not a Prometheus text
//! exposition endpoint. //! exposition endpoint.
use crate::admin::auth::validate_admin_request;
use crate::admin::router::Operation; use crate::admin::router::Operation;
use crate::auth::{check_key_valid, get_session_token};
use crate::server::RemoteAddr;
use crate::storage::request_context::spawn_traced; use crate::storage::request_context::spawn_traced;
use bytes::Bytes; use bytes::Bytes;
use futures::{Stream, StreamExt}; use futures::{Stream, StreamExt};
@@ -28,6 +31,7 @@ use matchit::Params;
use rustfs_ecstore::metrics_realtime::{CollectMetricsOpts, MetricType, collect_local_metrics}; use rustfs_ecstore::metrics_realtime::{CollectMetricsOpts, MetricType, collect_local_metrics};
use rustfs_madmin::metrics::RealtimeMetrics; use rustfs_madmin::metrics::RealtimeMetrics;
use rustfs_madmin::utils::parse_duration; use rustfs_madmin::utils::parse_duration;
use rustfs_policy::policy::action::{Action, AdminAction};
use s3s::header::CONTENT_TYPE; use s3s::header::CONTENT_TYPE;
use s3s::stream::{ByteStream, DynByteStream}; use s3s::stream::{ByteStream, DynByteStream};
use s3s::{Body, S3Request, S3Response, S3Result, StdError, s3_error}; use s3s::{Body, S3Request, S3Response, S3Result, StdError, s3_error};
@@ -178,14 +182,32 @@ impl ByteStream for MetricsStream {}
pub struct MetricsHandler {} pub struct MetricsHandler {}
async fn authorize_metrics_request(req: &S3Request<Body>) -> S3Result<()> {
let Some(input_cred) = req.credentials.as_ref() else {
return Err(s3_error!(AccessDenied, "Signature is required"));
};
let (cred, owner) =
check_key_valid(get_session_token(&req.uri, &req.headers).unwrap_or_default(), &input_cred.access_key).await?;
let remote_addr = req.extensions.get::<Option<RemoteAddr>>().and_then(|opt| opt.map(|a| a.0));
validate_admin_request(
&req.headers,
&cred,
owner,
false,
vec![Action::AdminAction(AdminAction::GetMetricsAction)],
remote_addr,
)
.await
}
#[async_trait::async_trait] #[async_trait::async_trait]
impl Operation for MetricsHandler { impl Operation for MetricsHandler {
async fn call(&self, req: S3Request<Body>, params: Params<'_, '_>) -> S3Result<S3Response<(StatusCode, Body)>> { async fn call(&self, req: S3Request<Body>, params: Params<'_, '_>) -> S3Result<S3Response<(StatusCode, Body)>> {
debug!("handle MetricsHandler, uri: {:?}, params: {:?}", req.uri, params); debug!("handle MetricsHandler, uri: {:?}, params: {:?}", req.uri, params);
let Some(_cred) = req.credentials else { authorize_metrics_request(&req).await?;
return Err(s3_error!(InvalidRequest, "get cred failed")); debug!("validated console metrics admin authorization");
};
debug!("validated console metrics request credentials");
let mp = extract_metrics_init_params(&req.uri); let mp = extract_metrics_init_params(&req.uri);
debug!("mp: {:?}", mp); debug!("mp: {:?}", mp);
@@ -266,10 +288,28 @@ impl Operation for MetricsHandler {
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::{ use super::{
CONSOLE_METRICS_CONTENT_TYPE, DEFAULT_METRICS_SAMPLES, MAX_METRICS_SAMPLES, extract_metrics_init_params, CONSOLE_METRICS_CONTENT_TYPE, DEFAULT_METRICS_SAMPLES, MAX_METRICS_SAMPLES, MetricsHandler, extract_metrics_init_params,
resolve_sample_count, resolve_sample_count,
}; };
use http::Uri; use crate::admin::router::Operation;
use http::{Extensions, HeaderMap, Uri};
use hyper::Method;
use matchit::Params;
use s3s::{Body, S3ErrorCode, S3Request};
fn build_metrics_request(uri: &'static str) -> S3Request<Body> {
S3Request {
input: Body::empty(),
method: Method::GET,
uri: Uri::from_static(uri),
headers: HeaderMap::new(),
extensions: Extensions::new(),
credentials: None,
region: None,
service: None,
trailing_headers: None,
}
}
#[test] #[test]
fn metrics_params_default_to_single_sample() { fn metrics_params_default_to_single_sample() {
@@ -299,4 +339,18 @@ mod tests {
fn metrics_handler_uses_ndjson_content_type() { fn metrics_handler_uses_ndjson_content_type() {
assert_eq!(CONSOLE_METRICS_CONTENT_TYPE, "application/x-ndjson"); assert_eq!(CONSOLE_METRICS_CONTENT_TYPE, "application/x-ndjson");
} }
#[tokio::test]
async fn metrics_handler_rejects_missing_credentials() {
let result = MetricsHandler {}
.call(build_metrics_request("/rustfs/admin/v3/metrics"), Params::new())
.await;
let err = match result {
Ok(_) => panic!("metrics handler must reject unauthenticated requests"),
Err(err) => err,
};
assert_eq!(err.code(), &S3ErrorCode::AccessDenied);
assert_eq!(err.message(), Some("Signature is required"));
}
} }
rustfs/src/admin/route_policy.rs
+7 -1
View File
@@ -36,6 +36,7 @@ const EXPORT_BUCKET_METADATA: AdminActionRef = AdminActionRef::new("ExportBucket
const EXPORT_IAM: AdminActionRef = AdminActionRef::new("ExportIAMAction"); const EXPORT_IAM: AdminActionRef = AdminActionRef::new("ExportIAMAction");
const GET_BUCKET_TARGET: AdminActionRef = AdminActionRef::new("GetBucketTargetAction"); const GET_BUCKET_TARGET: AdminActionRef = AdminActionRef::new("GetBucketTargetAction");
const GET_GROUP: AdminActionRef = AdminActionRef::new("GetGroupAdminAction"); const GET_GROUP: AdminActionRef = AdminActionRef::new("GetGroupAdminAction");
const GET_METRICS: AdminActionRef = AdminActionRef::new("GetMetricsAction");
const GET_POLICY: AdminActionRef = AdminActionRef::new("GetPolicyAdminAction"); const GET_POLICY: AdminActionRef = AdminActionRef::new("GetPolicyAdminAction");
const GET_REPLICATION_METRICS: AdminActionRef = AdminActionRef::new("GetReplicationMetricsAction"); const GET_REPLICATION_METRICS: AdminActionRef = AdminActionRef::new("GetReplicationMetricsAction");
const GET_TABLE: AdminActionRef = AdminActionRef::new("GetTableAction"); const GET_TABLE: AdminActionRef = AdminActionRef::new("GetTableAction");
@@ -227,6 +228,7 @@ pub const ADMIN_ROUTE_POLICY_SPECS: &[AdminRouteSpec] = &[
), ),
admin(HttpMethod::Get, "/rustfs/admin/v3/info", SERVER_INFO, RouteRiskLevel::Sensitive), admin(HttpMethod::Get, "/rustfs/admin/v3/info", SERVER_INFO, RouteRiskLevel::Sensitive),
admin(HttpMethod::Get, "/rustfs/admin/v3/storageinfo", STORAGE_INFO, RouteRiskLevel::Sensitive), admin(HttpMethod::Get, "/rustfs/admin/v3/storageinfo", STORAGE_INFO, RouteRiskLevel::Sensitive),
admin(HttpMethod::Get, "/rustfs/admin/v3/metrics", GET_METRICS, RouteRiskLevel::Sensitive),
admin( admin(
HttpMethod::Post, HttpMethod::Post,
"/rustfs/admin/v3/pools/decommission", "/rustfs/admin/v3/pools/decommission",
@@ -1147,7 +1149,6 @@ pub const DEFERRED_ADMIN_ROUTE_POLICIES: &[DeferredAdminRoutePolicy] = &[
"/rustfs/admin/v3/object-zip-downloads/{id}.zip", "/rustfs/admin/v3/object-zip-downloads/{id}.zip",
DeferredRoutePolicyReason::CredentialOnly, DeferredRoutePolicyReason::CredentialOnly,
), ),
deferred(HttpMethod::Get, "/rustfs/admin/v3/metrics", DeferredRoutePolicyReason::CredentialOnly),
deferred(HttpMethod::Get, "/rustfs/admin/v3/pools/list", DeferredRoutePolicyReason::MultipleActions), deferred(HttpMethod::Get, "/rustfs/admin/v3/pools/list", DeferredRoutePolicyReason::MultipleActions),
deferred( deferred(
HttpMethod::Get, HttpMethod::Get,
@@ -1464,6 +1465,11 @@ mod tests {
); );
} }
#[test]
fn route_policy_maps_metrics_to_explicit_admin_action() {
assert_action(HttpMethod::Get, "/rustfs/admin/v3/metrics", GET_METRICS);
}
fn route_policy_inventory_keys() -> BTreeSet<String> { fn route_policy_inventory_keys() -> BTreeSet<String> {
ADMIN_ROUTE_POLICY_SPECS ADMIN_ROUTE_POLICY_SPECS
.iter() .iter()