From bce5922aef14cc2ffa35d5d63caaf388bd975129 Mon Sep 17 00:00:00 2001 From: Zhengchao An Date: Fri, 21 Aug 2026 21:16:18 +0800 Subject: [PATCH 01/10] feat(connect): answer offline enrolment challenges without a network (#6335) --- rustfs/src/bin/rustfs-cli.rs | 216 ++++- rustfs/src/connect/mod.rs | 2 + rustfs/src/connect/offline/enrollment.rs | 684 +++++++++++++++ rustfs/src/connect/offline/key_store.rs | 72 ++ rustfs/src/connect/offline/mod.rs | 35 + rustfs/tests/connect_offline_enrollment.rs | 951 +++++++++++++++++++++ 6 files changed, 1959 insertions(+), 1 deletion(-) create mode 100644 rustfs/src/connect/offline/enrollment.rs create mode 100644 rustfs/src/connect/offline/key_store.rs create mode 100644 rustfs/src/connect/offline/mod.rs create mode 100644 rustfs/tests/connect_offline_enrollment.rs diff --git a/rustfs/src/bin/rustfs-cli.rs b/rustfs/src/bin/rustfs-cli.rs index 61c8bc795..49d04db72 100644 --- a/rustfs/src/bin/rustfs-cli.rs +++ b/rustfs/src/bin/rustfs-cli.rs @@ -17,6 +17,220 @@ //! This binary shares RustFS's existing subcommand dispatcher and provides the //! documented entry point for offline tooling such as `inspect bucket-meta`. -fn main() { +use std::fs; +use std::io::{Read as _, Write as _}; +use std::path::{Path, PathBuf}; +use std::process::ExitCode; +use std::time::{SystemTime, UNIX_EPOCH}; + +use rustfs::connect::offline::{OfflineEnrollment, OfflineKeyStore}; + +/// Owner read/write only. The response names the key being enrolled and the +/// challenge it answers; neither belongs to anyone else on the machine. +#[cfg(unix)] +const RESPONSE_MODE: u32 = 0o600; + +const USAGE: &str = "\ +Usage: rustfs-cli connect offline enroll --challenge --output [--key-dir ] + +Answers a Connect offline enrolment challenge without a network. Reads the +challenge from a file or from stdin when the path is `-`, verifies it against the +enrolment root compiled into this binary, mints the key being enrolled on first +use, and writes the signed response. + +No secret is ever accepted on the command line. +"; + +fn main() -> ExitCode { + let arguments: Vec = std::env::args().skip(1).collect(); + + // Offline enrolment is handled before the server dispatcher is reached, and + // the reason is the surface's whole point: `run_process` builds a Tokio + // runtime and enters the server's async main. An air-gapped enrolment must + // not start a runtime, a task, or anything that could open a socket, so the + // two paths cannot share an entry. + if matches!( + arguments.first().map(String::as_str), + Some("connect") if matches!(arguments.get(1).map(String::as_str), Some("offline")) + ) { + return match run_offline(&arguments[2..]) { + Ok(()) => ExitCode::SUCCESS, + Err(message) => { + eprintln!("rustfs-cli: {message}"); + ExitCode::FAILURE + } + }; + } + rustfs::startup_entrypoint::run_process(); + + ExitCode::SUCCESS +} + +fn run_offline(arguments: &[String]) -> Result<(), String> { + match arguments.first().map(String::as_str) { + Some("enroll") => enroll(&arguments[1..]), + Some(other) => Err(format!("unknown offline subcommand `{other}`\n\n{USAGE}")), + None => Err(format!("missing offline subcommand\n\n{USAGE}")), + } +} + +fn enroll(arguments: &[String]) -> Result<(), String> { + let mut challenge_path: Option = None; + let mut output_path: Option = None; + let mut key_directory: Option = None; + + let mut index = 0; + while index < arguments.len() { + let flag = arguments[index].as_str(); + let take_value = |name: &str| -> Result { + arguments + .get(index + 1) + .cloned() + .ok_or_else(|| format!("`{name}` needs a value\n\n{USAGE}")) + }; + + match flag { + "--challenge" => challenge_path = Some(take_value("--challenge")?), + "--output" => output_path = Some(take_value("--output")?), + "--key-dir" => key_directory = Some(take_value("--key-dir")?), + "-h" | "--help" => { + println!("{USAGE}"); + return Ok(()); + } + other => return Err(format!("unknown option `{other}`\n\n{USAGE}")), + } + + index += 2; + } + + let challenge_path = challenge_path.ok_or_else(|| format!("`--challenge` is required\n\n{USAGE}"))?; + let output_path = output_path.ok_or_else(|| format!("`--output` is required\n\n{USAGE}"))?; + let key_directory = key_directory.unwrap_or_else(|| ".".to_string()); + + let challenge = read_challenge(&challenge_path)?; + + let now = SystemTime::now() + .duration_since(UNIX_EPOCH) + .map_err(|_| "the system clock is before the Unix epoch".to_string())? + .as_secs() as i64; + + let verified = OfflineEnrollment::verify_challenge(&challenge, now).map_err(|error| error.to_string())?; + + // First use mints the key; a retry answers with the one already enrolled, + // because the operator may already be carrying a response naming it. + let key = OfflineKeyStore::new(&key_directory) + .load_or_create() + .map_err(|error| error.to_string())?; + + let mut device_nonce = [0u8; 32]; + getrandom(&mut device_nonce)?; + + let response = OfflineEnrollment::build_response(&verified, &key, &device_nonce, now).map_err(|error| error.to_string())?; + + write_response(Path::new(&output_path), &response)?; + + Ok(()) +} + +/// Reads the challenge from a file, or from stdin when the path is `-`. +/// +/// A challenge is not a secret — it is signed, public, and carried in by hand — +/// so accepting a path is safe. The response's key never arrives this way. +fn read_challenge(path: &str) -> Result, String> { + if path == "-" { + let mut buffer = Vec::new(); + std::io::stdin() + .read_to_end(&mut buffer) + .map_err(|error| format!("cannot read the challenge from stdin: {error}"))?; + return Ok(buffer); + } + + fs::read(path).map_err(|error| format!("cannot read the challenge at {path}: {error}")) +} + +/// Writes the response durably and atomically at mode 0600. +/// +/// Not the no-clobber publish `IdentityStore` performs for a key: an operator +/// who reruns an enrolment expects the response file to be replaced, whereas a +/// second key would strand the first. Same durability, deliberately different +/// publication rule. +fn write_response(path: &Path, response: &[u8]) -> Result<(), String> { + let parent = path.parent().filter(|parent| !parent.as_os_str().is_empty()); + let temporary: PathBuf = match parent { + Some(parent) => parent.join(format!(".{}.tmp", file_name(path))), + None => PathBuf::from(format!(".{}.tmp", file_name(path))), + }; + + let mut options = fs::OpenOptions::new(); + options.write(true).create(true).truncate(true); + #[cfg(unix)] + { + use std::os::unix::fs::OpenOptionsExt as _; + options.mode(RESPONSE_MODE); + } + + let write = (|| -> std::io::Result<()> { + let mut file = options.open(&temporary)?; + file.write_all(response)?; + + // The umask can only narrow the creation mode, so set the exact mode + // before the bytes become durable. + #[cfg(unix)] + { + use std::os::unix::fs::PermissionsExt as _; + file.set_permissions(fs::Permissions::from_mode(RESPONSE_MODE))?; + } + + file.sync_all() + })(); + + if let Err(error) = write { + let _ = fs::remove_file(&temporary); + return Err(format!("cannot write the response to {}: {error}", path.display())); + } + + fs::rename(&temporary, path).map_err(|error| { + let _ = fs::remove_file(&temporary); + format!("cannot publish the response at {}: {error}", path.display()) + })?; + + if let Some(parent) = parent { + sync_directory(parent); + } + + Ok(()) +} + +fn file_name(path: &Path) -> String { + path.file_name() + .map(|name| name.to_string_lossy().into_owned()) + .unwrap_or_else(|| "response".to_string()) +} + +/// Fsync the directory so the renamed entry survives power loss. Directories +/// cannot be opened for syncing on Windows, where this is a no-op. +fn sync_directory(directory: &Path) { + #[cfg(unix)] + { + if let Ok(handle) = fs::File::open(directory) { + let _ = handle.sync_all(); + } + } + #[cfg(not(unix))] + let _ = directory; +} + +/// Fills `buffer` with operating-system randomness. +/// +/// The device nonce must be unpredictable: it is what stops a captured response +/// being replayed as a fresh one. Sourced through p256's pinned rand_core 0.6 +/// rather than the workspace `rand` 0.10, matching `identity.rs`; the two are +/// different crate versions and only the pinned one is on p256's own path. +fn getrandom(buffer: &mut [u8]) -> Result<(), String> { + use p256::elliptic_curve::rand_core::{OsRng, RngCore as _}; + + OsRng + .try_fill_bytes(buffer) + .map_err(|error| format!("the operating system random source failed: {error}")) } diff --git a/rustfs/src/connect/mod.rs b/rustfs/src/connect/mod.rs index 3972bf21c..8506055f2 100644 --- a/rustfs/src/connect/mod.rs +++ b/rustfs/src/connect/mod.rs @@ -27,6 +27,8 @@ pub mod identity; pub mod identity_store; +pub mod offline; pub use identity::{DeviceIdentity, IdentityError, RegistrationProof, RegistrationTranscript}; pub use identity_store::{IdentityStore, StoreError}; +pub use offline::{EnrollmentError, OfflineEnrollment, OfflineKeyStore, VerifiedChallenge}; diff --git a/rustfs/src/connect/offline/enrollment.rs b/rustfs/src/connect/offline/enrollment.rs new file mode 100644 index 000000000..a16fadb39 --- /dev/null +++ b/rustfs/src/connect/offline/enrollment.rs @@ -0,0 +1,684 @@ +// Copyright 2024 RustFS Team +// +// Licensed 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. + +//! Challenge verification and response production for offline enrolment. +//! +//! Two invariants carry the security of this surface and both are easy to break +//! by accident: +//! +//! - Every signature is checked over the octets that arrived, never over a +//! re-serialised document. Parsing happens only to route the verification, and +//! nothing a parse yields is believed until the signature over those same +//! octets has verified. +//! - The enrolment root is the constant in this file. It is never taken from a +//! challenge, a configuration file, or an operator prompt, so there is no +//! trust-on-first-use path an operator could be talked into. +//! +//! The order of the checks in [`OfflineEnrollment::verify_challenge`] is frozen +//! by `verificationOrder.enrollmentChallenge` in +//! `protocol/agent/v1/fixtures/offline-enrollment/trust-model.json`, and the +//! signature encoding, the domain separation tags, and every rejection reason +//! are frozen beside it. Reordering the checks changes which reason a given +//! artifact produces, which is itself part of the contract. + +use base64::Engine as _; +use base64::engine::general_purpose::{STANDARD as BASE64_STANDARD, URL_SAFE_NO_PAD as BASE64_URL_NO_PAD}; +use p256::ecdsa::signature::{Signer as _, Verifier as _}; +use p256::ecdsa::{Signature, SigningKey, VerifyingKey}; +use p256::pkcs8::DecodePrivateKey as _; +use serde::{Deserialize, Serialize}; +use sha2::{Digest as _, Sha256}; +use time::{Date, Month, OffsetDateTime, PrimitiveDateTime, Time}; + +use crate::connect::identity::DeviceIdentity; + +/// The hosted enrolment root, compiled in. Both halves are pinned: the +/// fingerprint identifies the root, and the point is what actually verifies the +/// first link, so a build cannot be pointed at a different key by supplying one. +const PINNED_ROOT_KEY_ID: &str = "df22e2806112debbe953672aafa186d699af0e97dd3fd2b09fa8359005fe348f"; +const PINNED_ROOT_PUBLIC_KEY: &str = "BFfx-K-FfEA5nK_Rz3IHacvRCkJyQ7JOd1geLyU6HKRZDgNezmVuKhvJ22VhemyjV__Gshk8JGGqOBzYPMD0p6s"; + +/// Domain separation tags. A document that verifies under one of these must not +/// be accepted for another artifact type, so the tag is part of the signature +/// input rather than a property of the caller. +const TAG_TRUST_LINK: &[u8] = b"rustfs-offline-trust-link-v1"; +const TAG_CHALLENGE: &[u8] = b"rustfs-offline-enrollment-challenge-v1"; +const TAG_RESPONSE: &[u8] = b"rustfs-offline-enrollment-response-v1"; + +/// The single octet between the tag and the signed document. +const DOMAIN_SEPARATOR: u8 = 0x00; + +const SIGNATURE_ALGORITHM: &str = "ES256"; +const PROTOCOL_VERSION: &str = "v1"; +const FORMAT_TRUST_LINK: &str = "rustfs.connect.offline.trustLink/1"; +const FORMAT_CHALLENGE: &str = "rustfs.connect.offline.enrollmentChallenge/1"; +const FORMAT_RESPONSE: &str = "rustfs.connect.offline.enrollmentResponse/1"; + +/// DER SubjectPublicKeyInfo header for an uncompressed P-256 point. A keyId is +/// the SHA-256 of this prefix followed by the 65 octet point, so the prefix is +/// also how a device public key is recovered from its own DER encoding. +const SPKI_PREFIX: [u8; 26] = [ + 0x30, 0x59, 0x30, 0x13, 0x06, 0x07, 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x02, 0x01, 0x06, 0x08, 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x03, + 0x01, 0x07, 0x03, 0x42, 0x00, +]; + +/// Order of the P-256 group, and half of it. `r` and `s` must lie in `[1, n)`, +/// and `s` additionally in `[1, n/2]`: ECDSA admits both `s` and `n - s`, and a +/// signature with two spellings cannot serve as an artifact identity. Every +/// ECDSA library accepts the malleated form, so the encoding layer rejects it. +const GROUP_ORDER: [u8; 32] = [ + 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xbc, 0xe6, 0xfa, 0xad, 0xa7, + 0x17, 0x9e, 0x84, 0xf3, 0xb9, 0xca, 0xc2, 0xfc, 0x63, 0x25, 0x51, +]; +const MAX_S: [u8; 32] = [ + 0x7f, 0xff, 0xff, 0xff, 0x80, 0x00, 0x00, 0x00, 0x7f, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xde, 0x73, 0x7d, 0x56, 0xd3, + 0x8b, 0xcf, 0x42, 0x79, 0xdc, 0xe5, 0x61, 0x7e, 0x31, 0x92, 0xa8, +]; + +const SCALAR_OCTETS: usize = 32; +const SIGNATURE_OCTETS: usize = 64; +/// 64 octets as unpadded base64url. The length is checked before decoding so +/// that `=` padding, the standard alphabet, DER, and a truncated value are all +/// refused rather than repaired. +const SIGNATURE_VALUE_CHARS: usize = 86; + +const PUBLIC_KEY_OCTETS: usize = 65; +const PUBLIC_KEY_CHARS: usize = 87; +/// SEC1 tag of an uncompressed point. Compressed and hybrid forms are refused. +const UNCOMPRESSED_POINT: u8 = 0x04; + +const TIMESTAMP_CHARS: usize = 20; + +/// The chain is exactly two links: a pinned root issues the intermediate, and +/// the intermediate issues the signing key. Roles are positional and the +/// enumeration is closed. +const CHAIN_LINK_COUNT: usize = 2; +const CHAIN_ROLES: [&str; CHAIN_LINK_COUNT] = ["intermediate", "signing"]; + +/// Skew allowed on the challenge window. A device may have no synchronised +/// clock at all, so its own reading of "now" is advisory. +const CLOCK_SKEW_TOLERANCE: i64 = 300; + +/// Longest life a challenge may claim. The issuer sets both ends of its own +/// window, so the protocol bound is applied on top of the declared expiry +/// rather than trusted from it. +const MAX_CHALLENGE_LIFETIME: i64 = 604_800; + +/// A challenge that verified, with the fields the response has to echo. +/// +/// Construction is the proof: a value of this type only exists after the chain +/// closed on the pinned root and the challenge signature verified over the +/// received octets. +#[derive(Clone, Debug, PartialEq, Eq)] +pub struct VerifiedChallenge { + pub challenge_id: String, + pub organization_name: String, + pub cluster_name: String, + pub nonce: String, + pub issued_at: String, + pub expires_at: String, + pub connect_key_id: String, + /// The signature value of the challenge, verbatim. It binds a response to + /// the one challenge it answers, so it is carried rather than recomputed. + pub challenge_proof: String, +} + +/// Why an offline enrolment artifact was refused. +/// +/// The variants are the frozen `reason` vocabulary of +/// `fixtures/offline-enrollment/error-codes.json`, which spans both halves of +/// the exchange. The device half implemented here produces the encoding, chain, +/// version, and freshness reasons; the reasons that describe a response being +/// evaluated against stored state — [`Self::ChallengeUnknown`], +/// [`Self::ChallengeProofInvalid`], [`Self::DeviceProofInvalid`], +/// [`Self::EnrollmentReplayed`], [`Self::OrganizationMismatch`], and +/// [`Self::ClusterMismatch`] — are Connect's to raise and are named here so the +/// two sides share one vocabulary. +/// +/// No variant carries a payload: a rejection must never disclose key material, +/// signature octets, nonces, or document bytes. +#[derive(Debug, PartialEq, Eq, thiserror::Error)] +pub enum EnrollmentError { + #[error("protocolVersion is missing, malformed, or names an unsupported major version")] + UnsupportedProtocol, + + #[error("formatVersion is not a supported offline enrollment format")] + UnsupportedFormat, + + #[error("the signature is not 64 octets of fixed-width r||s in unpadded base64url")] + SignatureMalformed, + + #[error("the signature is not in its canonical low-S form")] + SignatureNotCanonical, + + #[error("the signature does not verify over the received octets")] + SignatureInvalid, + + #[error("the trust chain is not issued by a root pinned in this build")] + EnrollmentRootUnknown, + + #[error("a trust link is invalid, misordered, or outside its validity at the challenge issuedAt")] + TrustChainInvalid, + + #[error("connectKeyId is not the subject of the last trust link")] + ConnectKeyUnchained, + + #[error("no issued challenge matches this challengeId")] + ChallengeUnknown, + + #[error("the challenge is not yet valid at the evaluation time")] + ChallengeNotYetValid, + + #[error("the challenge has expired at the evaluation time")] + ChallengeExpired, + + #[error("the response nonce or challengeProof is not the one issued for this challenge")] + ChallengeProofInvalid, + + #[error("the response does not prove possession of the device key it presents")] + DeviceProofInvalid, + + #[error("the challenge was already consumed")] + EnrollmentReplayed, + + #[error("the response names a different organization than the challenge it answers")] + OrganizationMismatch, + + #[error("the response names a different cluster than the challenge it answers")] + ClusterMismatch, + + /// The artifact could not be read as a signed enrolment document at all: the + /// envelope, the base64 of the signed octets, or a field the frozen order + /// reads before the signature verifies did not parse. The frozen reason set + /// has no code for a structurally unreadable document, so this variant maps + /// to none of them. + #[error("the offline enrollment document is not well formed")] + MalformedDocument, + + /// A fault on this side of the exchange rather than in the artifact: the + /// device key did not round-trip through its own PKCS#8 encoding, or the + /// caller named an instant outside the representable calendar. Fails closed + /// because a half-produced response must never reach removable media. + #[error("the enrollment response could not be produced on this device")] + ResponseNotProduced, +} + +impl EnrollmentError { + /// The frozen `reason` an operator and Connect both branch on. + /// + /// The `Display` message is prose and may be reworded; this is the stable + /// identifier, so nothing should parse the message instead. The two + /// variants with no frozen counterpart deliberately return codes outside + /// the frozen set rather than borrowing the nearest one, so a document that + /// simply failed to parse can never be reported as a signature or freshness + /// failure. + pub fn reason(&self) -> &'static str { + match self { + Self::UnsupportedProtocol => "UNSUPPORTED_PROTOCOL", + Self::UnsupportedFormat => "UNSUPPORTED_FORMAT", + Self::SignatureMalformed => "SIGNATURE_MALFORMED", + Self::SignatureNotCanonical => "SIGNATURE_NOT_CANONICAL", + Self::SignatureInvalid => "SIGNATURE_INVALID", + Self::EnrollmentRootUnknown => "ENROLLMENT_ROOT_UNKNOWN", + Self::TrustChainInvalid => "TRUST_CHAIN_INVALID", + Self::ConnectKeyUnchained => "CONNECT_KEY_UNCHAINED", + Self::ChallengeUnknown => "CHALLENGE_UNKNOWN", + Self::ChallengeNotYetValid => "CHALLENGE_NOT_YET_VALID", + Self::ChallengeExpired => "CHALLENGE_EXPIRED", + Self::ChallengeProofInvalid => "CHALLENGE_PROOF_INVALID", + Self::DeviceProofInvalid => "DEVICE_PROOF_INVALID", + Self::EnrollmentReplayed => "ENROLLMENT_REPLAYED", + Self::OrganizationMismatch => "ORGANIZATION_MISMATCH", + Self::ClusterMismatch => "CLUSTER_MISMATCH", + Self::MalformedDocument => "MALFORMED_DOCUMENT", + Self::ResponseNotProduced => "RESPONSE_NOT_PRODUCED", + } + } +} + +/// A signed document, in the shape both directions carry it. `bytes` is +/// standard padded base64 of the exact octets that were signed; nothing else is +/// ever used as the signature input. +#[derive(Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +struct SignedDocument { + bytes: String, + signature: DocumentSignature, +} + +#[derive(Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +struct DocumentSignature { + algorithm: String, + key_id: String, + value: String, +} + +/// The three fields the frozen order permits reading before anything verifies. +/// They route the verification and are not facts until it has. +#[derive(Deserialize)] +#[serde(rename_all = "camelCase")] +struct ChallengeRouting { + connect_key_id: String, + issued_at: String, + trust_chain: Vec, +} + +#[derive(Deserialize)] +#[serde(rename_all = "camelCase")] +struct ChallengeDocument { + format_version: String, + protocol_version: String, + challenge_id: String, + organization_name: String, + cluster_name: String, + nonce: String, + issued_at: String, + expires_at: String, + connect_key_id: String, +} + +#[derive(Deserialize)] +#[serde(rename_all = "camelCase")] +struct TrustLink { + format_version: String, + protocol_version: String, + role: String, + issuer_key_id: String, + subject_key_id: String, + subject_public_key: String, + not_before: String, + not_after: String, +} + +#[derive(Serialize)] +#[serde(rename_all = "camelCase")] +struct ResponseDocument<'a> { + format_version: &'a str, + protocol_version: &'a str, + challenge_id: &'a str, + organization_name: &'a str, + cluster_name: &'a str, + challenge_nonce: &'a str, + challenge_proof: &'a str, + device_key_id: String, + device_public_key: String, + device_nonce: String, + produced_at: String, +} + +/// The device half of the offline enrolment exchange: bytes in, bytes out. +pub struct OfflineEnrollment; + +impl OfflineEnrollment { + /// Verify an enrolment challenge and return what a response must echo. + /// + /// `now_unix` is the device's reading of the current time, which the clock + /// skew tolerance treats as advisory. + pub fn verify_challenge(document: &[u8], now_unix: i64) -> Result { + let envelope: SignedDocument = serde_json::from_slice(document).map_err(|_| EnrollmentError::MalformedDocument)?; + + // Step 1: the encoding is checked before anything is decoded from it, so + // a DER, padded, truncated, out-of-range, or high-S signature is refused + // on its spelling rather than handed to a library that would accept it. + let signature = decode_signature(&envelope.signature)?; + + // The octets that were transmitted. They are never re-serialised: every + // later step signs and parses this same buffer. + let bytes = BASE64_STANDARD + .decode(envelope.bytes.as_bytes()) + .map_err(|_| EnrollmentError::MalformedDocument)?; + + // Step 2: routing only. + let routing: ChallengeRouting = serde_json::from_slice(&bytes).map_err(|_| EnrollmentError::MalformedDocument)?; + let issued_at = parse_timestamp(&routing.issued_at)?; + + // Steps 3 to 5. + let connect_key = verify_trust_chain(&routing.trust_chain, &routing.connect_key_id, issued_at)?; + + // Step 6. The verification key comes from the chain, so `signature.keyId` + // is a label rather than an input: a value naming some other key simply + // fails to verify here. + if !verifies(&connect_key, TAG_CHALLENGE, &bytes, &signature) { + return Err(EnrollmentError::SignatureInvalid); + } + + // Step 7: only now is the document read as a fact. + let challenge: ChallengeDocument = serde_json::from_slice(&bytes).map_err(|_| EnrollmentError::MalformedDocument)?; + if challenge.protocol_version != PROTOCOL_VERSION { + return Err(EnrollmentError::UnsupportedProtocol); + } + if challenge.format_version != FORMAT_CHALLENGE { + return Err(EnrollmentError::UnsupportedFormat); + } + + // Step 8. + let expires_at = parse_timestamp(&challenge.expires_at)?; + check_challenge_window(issued_at, expires_at, now_unix)?; + + Ok(VerifiedChallenge { + challenge_id: challenge.challenge_id, + organization_name: challenge.organization_name, + cluster_name: challenge.cluster_name, + nonce: challenge.nonce, + issued_at: challenge.issued_at, + expires_at: challenge.expires_at, + connect_key_id: challenge.connect_key_id, + challenge_proof: envelope.signature.value, + }) + } + + /// Build the signed response an operator carries back to Connect. + /// + /// `device_nonce` is the response's own replay value and must come from a + /// cryptographic source. The private key never appears in the result: only + /// the public point, its fingerprint, and a signature over the document + /// that presents them, which is what makes presenting the key safe. + pub fn build_response( + challenge: &VerifiedChallenge, + key: &DeviceIdentity, + device_nonce: &[u8; 32], + produced_at_unix: i64, + ) -> Result, EnrollmentError> { + let issued_at = parse_timestamp(&challenge.issued_at)?; + let expires_at = parse_timestamp(&challenge.expires_at)?; + // Connect re-checks producedAt against the same window, so a response + // outside it is refused here rather than written to media and rejected + // after the operator has carried it out. + check_challenge_window(issued_at, expires_at, produced_at_unix)?; + + let point = device_public_point(key)?; + let produced_at = format_timestamp(produced_at_unix)?; + + let document = ResponseDocument { + format_version: FORMAT_RESPONSE, + protocol_version: PROTOCOL_VERSION, + challenge_id: &challenge.challenge_id, + organization_name: &challenge.organization_name, + cluster_name: &challenge.cluster_name, + challenge_nonce: &challenge.nonce, + challenge_proof: &challenge.challenge_proof, + device_key_id: key_id(&point), + device_public_key: BASE64_URL_NO_PAD.encode(point), + device_nonce: BASE64_URL_NO_PAD.encode(device_nonce), + produced_at, + }; + + // Serialised once. These octets are what is signed and what is carried, + // so no second serialisation can disagree with the signature. + let bytes = serde_json::to_vec(&document).map_err(|_| EnrollmentError::ResponseNotProduced)?; + let signature = sign(key, TAG_RESPONSE, &bytes)?; + + let envelope = SignedDocument { + bytes: BASE64_STANDARD.encode(&bytes), + signature: DocumentSignature { + algorithm: SIGNATURE_ALGORITHM.to_owned(), + key_id: document.device_key_id, + value: signature, + }, + }; + + serde_json::to_vec(&envelope).map_err(|_| EnrollmentError::ResponseNotProduced) + } +} + +/// Walk the chain from the pinned root to the signing key, returning the key +/// `connect_key_id` names once the chain vouches for it. +fn verify_trust_chain( + chain: &[SignedDocument], + connect_key_id: &str, + challenge_issued_at: i64, +) -> Result { + // The pinned root gate runs before the chain's shape is examined, so a + // chain that is internally consistent under a foreign root — exactly what + // trust on first use would have accepted — is refused for its root rather + // than for its length. + let first = chain.first().ok_or(EnrollmentError::EnrollmentRootUnknown)?; + let root = decode_trust_link(first)?; + if root.0.issuer_key_id != PINNED_ROOT_KEY_ID { + return Err(EnrollmentError::EnrollmentRootUnknown); + } + + let [_, second] = chain else { + return Err(EnrollmentError::TrustChainInvalid); + }; + let links = [root, decode_trust_link(second)?]; + + let mut issuer_key_id = PINNED_ROOT_KEY_ID.to_owned(); + let (mut issuer_key, _) = decode_public_key(PINNED_ROOT_PUBLIC_KEY).ok_or(EnrollmentError::EnrollmentRootUnknown)?; + + for (index, ((link, link_bytes), entry)) in links.iter().zip(chain).enumerate() { + if link.format_version != FORMAT_TRUST_LINK + || link.protocol_version != PROTOCOL_VERSION + || link.role != CHAIN_ROLES[index] + || link.issuer_key_id != issuer_key_id + // A link that names itself as its own issuer would let a stolen + // intermediate mint its own root. + || link.subject_key_id == link.issuer_key_id + { + return Err(EnrollmentError::TrustChainInvalid); + } + + let (subject_key, subject_point) = + decode_public_key(&link.subject_public_key).ok_or(EnrollmentError::TrustChainInvalid)?; + if key_id(&subject_point) != link.subject_key_id { + return Err(EnrollmentError::TrustChainInvalid); + } + + let signature = decode_signature(&entry.signature)?; + if !verifies(&issuer_key, TAG_TRUST_LINK, link_bytes, &signature) { + return Err(EnrollmentError::TrustChainInvalid); + } + + // The issuer controls both ends of a link's window, so it is evaluated + // with no skew tolerance, and against the challenge's issuedAt rather + // than against the device clock: a challenge carries the chain that was + // valid when it was issued. + let not_before = parse_timestamp(&link.not_before)?; + let not_after = parse_timestamp(&link.not_after)?; + if challenge_issued_at < not_before || challenge_issued_at > not_after { + return Err(EnrollmentError::TrustChainInvalid); + } + + issuer_key_id = link.subject_key_id.clone(); + issuer_key = subject_key; + } + + if issuer_key_id != connect_key_id { + return Err(EnrollmentError::ConnectKeyUnchained); + } + + Ok(issuer_key) +} + +/// Decode a link and keep the octets it was signed over: the signature is +/// checked against these, never against a re-encoding of the parsed link. +fn decode_trust_link(entry: &SignedDocument) -> Result<(TrustLink, Vec), EnrollmentError> { + let bytes = BASE64_STANDARD + .decode(entry.bytes.as_bytes()) + .map_err(|_| EnrollmentError::MalformedDocument)?; + let link = serde_json::from_slice(&bytes).map_err(|_| EnrollmentError::TrustChainInvalid)?; + Ok((link, bytes)) +} + +/// Check a signature's spelling and range, then admit it. +/// +/// `r` and `s` are compared against the group order here rather than left to +/// the ECDSA library, because a library that accepts high-S — every library +/// does — would let a malleated copy of an artifact pass as a second artifact. +fn decode_signature(signature: &DocumentSignature) -> Result { + if signature.algorithm != SIGNATURE_ALGORITHM { + return Err(EnrollmentError::SignatureMalformed); + } + + let value = signature.value.as_bytes(); + if value.len() != SIGNATURE_VALUE_CHARS || !value.iter().all(|byte| is_base64url(*byte)) { + return Err(EnrollmentError::SignatureMalformed); + } + + let decoded = BASE64_URL_NO_PAD + .decode(value) + .map_err(|_| EnrollmentError::SignatureMalformed)?; + let octets: [u8; SIGNATURE_OCTETS] = decoded + .as_slice() + .try_into() + .map_err(|_| EnrollmentError::SignatureMalformed)?; + + // Big-endian octets of equal length order lexicographically exactly as the + // integers they spell, so a slice comparison is the range check. + let (r, s) = octets.split_at(SCALAR_OCTETS); + let out_of_range = |scalar: &[u8]| scalar.iter().all(|byte| *byte == 0) || scalar >= &GROUP_ORDER[..]; + if out_of_range(r) || out_of_range(s) { + return Err(EnrollmentError::SignatureMalformed); + } + if s > &MAX_S[..] { + return Err(EnrollmentError::SignatureNotCanonical); + } + + Signature::from_slice(&octets).map_err(|_| EnrollmentError::SignatureMalformed) +} + +fn verifies(key: &VerifyingKey, tag: &[u8], bytes: &[u8], signature: &Signature) -> bool { + key.verify(&signature_input(tag, bytes), signature).is_ok() +} + +fn signature_input(tag: &[u8], bytes: &[u8]) -> Vec { + let mut input = Vec::with_capacity(tag.len() + 1 + bytes.len()); + input.extend_from_slice(tag); + input.push(DOMAIN_SEPARATOR); + input.extend_from_slice(bytes); + input +} + +fn sign(key: &DeviceIdentity, tag: &[u8], bytes: &[u8]) -> Result { + // `DeviceIdentity` publishes no general signing operation, so the key is + // rebuilt from its own PKCS#8 encoding; the encoding is wiped when the + // wrapper drops. + let pkcs8 = key.to_pkcs8_der().map_err(|_| EnrollmentError::ResponseNotProduced)?; + let signing_key = SigningKey::from_pkcs8_der(pkcs8.as_slice()).map_err(|_| EnrollmentError::ResponseNotProduced)?; + + let signature: Signature = signing_key.sign(&signature_input(tag, bytes)); + let canonical = signature.normalize_s().unwrap_or(signature); + + Ok(BASE64_URL_NO_PAD.encode(canonical.to_bytes())) +} + +/// The device's public point, recovered from the DER encoding the identity +/// publishes so that one prefix constant governs both the fingerprint and the +/// wire form. +fn device_public_point(key: &DeviceIdentity) -> Result<[u8; PUBLIC_KEY_OCTETS], EnrollmentError> { + key.public_key_der() + .strip_prefix(&SPKI_PREFIX) + .and_then(|point| <[u8; PUBLIC_KEY_OCTETS]>::try_from(point).ok()) + .ok_or(EnrollmentError::ResponseNotProduced) +} + +/// Decode an uncompressed SEC1 point and check that it is on the curve. +/// +/// The length and alphabet are checked before decoding so that a padded or +/// standard-alphabet spelling is refused, and the point tag is checked so that +/// the compressed and hybrid forms — which no keyId would match — cannot be +/// spelled at all. +fn decode_public_key(value: &str) -> Option<(VerifyingKey, [u8; PUBLIC_KEY_OCTETS])> { + let value = value.as_bytes(); + if value.len() != PUBLIC_KEY_CHARS || !value.iter().all(|byte| is_base64url(*byte)) { + return None; + } + + let point: [u8; PUBLIC_KEY_OCTETS] = BASE64_URL_NO_PAD.decode(value).ok()?.try_into().ok()?; + if point[0] != UNCOMPRESSED_POINT { + return None; + } + + VerifyingKey::from_sec1_bytes(&point).ok().map(|key| (key, point)) +} + +/// Lowercase SHA-256 hex of the DER SubjectPublicKeyInfo built from a 65 octet +/// uncompressed point. +fn key_id(point: &[u8]) -> String { + let mut digest = Sha256::new(); + digest.update(SPKI_PREFIX); + digest.update(point); + hex_simd::encode_to_string(digest.finalize(), hex_simd::AsciiCase::Lower) +} + +fn is_base64url(byte: u8) -> bool { + byte.is_ascii_alphanumeric() || byte == b'-' || byte == b'_' +} + +/// Parse `YYYY-MM-DDTHH:MM:SSZ` into a Unix instant. +/// +/// The shape is checked before the fields are read: offsets other than `Z` and +/// fractional seconds are refused rather than normalised, so two producers +/// cannot spell the same instant two ways. +fn parse_timestamp(value: &str) -> Result { + let octets = value.as_bytes(); + if octets.len() != TIMESTAMP_CHARS + || octets[4] != b'-' + || octets[7] != b'-' + || octets[10] != b'T' + || octets[13] != b':' + || octets[16] != b':' + || octets[19] != b'Z' + { + return Err(EnrollmentError::MalformedDocument); + } + + let field = |range: std::ops::Range| -> Result { + let text = &value[range]; + if !text.bytes().all(|byte| byte.is_ascii_digit()) { + return Err(EnrollmentError::MalformedDocument); + } + text.parse().map_err(|_| EnrollmentError::MalformedDocument) + }; + + let month = Month::try_from(field(5..7)? as u8).map_err(|_| EnrollmentError::MalformedDocument)?; + let date = Date::from_calendar_date(field(0..4)? as i32, month, field(8..10)? as u8) + .map_err(|_| EnrollmentError::MalformedDocument)?; + let clock = Time::from_hms(field(11..13)? as u8, field(14..16)? as u8, field(17..19)? as u8) + .map_err(|_| EnrollmentError::MalformedDocument)?; + + Ok(PrimitiveDateTime::new(date, clock).assume_utc().unix_timestamp()) +} + +fn format_timestamp(unix: i64) -> Result { + let moment = OffsetDateTime::from_unix_timestamp(unix).map_err(|_| EnrollmentError::ResponseNotProduced)?; + Ok(format!( + "{:04}-{:02}-{:02}T{:02}:{:02}:{:02}Z", + moment.year(), + u8::from(moment.month()), + moment.day(), + moment.hour(), + moment.minute(), + moment.second() + )) +} + +/// `at` must fall within `[issuedAt - 300, expiresAt + 300]`. +/// +/// The declared expiry is capped at the protocol's maximum challenge lifetime +/// because the issuer sets both ends of its own window; a challenge claiming a +/// longer life expires at the bound. +fn check_challenge_window(issued_at: i64, expires_at: i64, at: i64) -> Result<(), EnrollmentError> { + if at < issued_at.saturating_sub(CLOCK_SKEW_TOLERANCE) { + return Err(EnrollmentError::ChallengeNotYetValid); + } + + let effective_expiry = expires_at.min(issued_at.saturating_add(MAX_CHALLENGE_LIFETIME)); + if at > effective_expiry.saturating_add(CLOCK_SKEW_TOLERANCE) { + return Err(EnrollmentError::ChallengeExpired); + } + + Ok(()) +} diff --git a/rustfs/src/connect/offline/key_store.rs b/rustfs/src/connect/offline/key_store.rs new file mode 100644 index 000000000..1f67f7b7e --- /dev/null +++ b/rustfs/src/connect/offline/key_store.rs @@ -0,0 +1,72 @@ +// Copyright 2024 RustFS Team +// +// Licensed 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. + +//! On-disk home of the offline enrollment key. +//! +//! An air-gapped device enrols with a key that is not its online device +//! identity: the online key is minted during a registration exchange this +//! device cannot perform, and an operator who carries an enrolment response out +//! on removable media is enrolling exactly one key that Connect will pin. Losing +//! it means asking for a fresh challenge, so it is written durably and published +//! exactly once. +//! +//! The durability protocol is not reimplemented here. [`IdentityStore`] already +//! seals a P-256 key at mode 0600, fsyncs it, and publishes it through a +//! no-clobber link so a retry or a concurrent start converges on one key; it is +//! pointed at a directory of this key's own rather than generalised into a +//! key-store abstraction that would have to describe both lifecycles. + +use std::path::{Path, PathBuf}; + +use super::super::identity::DeviceIdentity; +use super::super::identity_store::{IdentityStore, StoreError}; + +/// Subdirectory holding the offline enrolment key, kept apart from the online +/// device identity so neither can be read in place of the other. +const OFFLINE_DIRECTORY: &str = "offline"; + +/// The offline enrolment key of one deployment. +#[derive(Clone, Debug)] +pub struct OfflineKeyStore { + inner: IdentityStore, +} + +impl OfflineKeyStore { + pub fn new(directory: impl AsRef) -> Self { + Self { + inner: IdentityStore::new(directory.as_ref().join(OFFLINE_DIRECTORY)), + } + } + + pub fn key_path(&self) -> PathBuf { + self.inner.key_path() + } + + /// Return the stored key, or `None` when this deployment has never enrolled + /// offline. Reading never creates one, so a deployment that only ever + /// registers online holds no offline key. + pub fn load(&self) -> Result, StoreError> { + self.inner.load() + } + + /// Return the stored key, generating and publishing one the first time. + /// + /// A second enrolment attempt returns the original key rather than minting a + /// replacement: the operator may already be carrying a response for it, and + /// two keys would mean the response and the device disagree about which one + /// Connect pinned. + pub fn load_or_create(&self) -> Result { + self.inner.load_or_create() + } +} diff --git a/rustfs/src/connect/offline/mod.rs b/rustfs/src/connect/offline/mod.rs new file mode 100644 index 000000000..c5364cb0b --- /dev/null +++ b/rustfs/src/connect/offline/mod.rs @@ -0,0 +1,35 @@ +// Copyright 2024 RustFS Team +// +// Licensed 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. + +//! Offline enrolment: joining a Connect tenant without a network. +//! +//! An air-gapped cluster cannot perform the registration exchange, so an +//! operator carries a signed challenge in and a signed response out. The device +//! half of that exchange lives here: verifying the challenge against a root +//! whose fingerprint is compiled into this binary, minting the key being +//! enrolled, and signing the response. +//! +//! Nothing here opens a socket. That is the point of the surface, and it is +//! asserted rather than assumed: the enrolment path takes bytes and returns +//! bytes. +//! +//! The trust model, the signing convention, and every rejection reason are +//! frozen by `protocol/agent/v1/fixtures/offline-enrollment/` and by +//! `docs/adr/0009-offline-signing.md` on the Connect side. + +pub mod enrollment; +pub mod key_store; + +pub use enrollment::{EnrollmentError, OfflineEnrollment, VerifiedChallenge}; +pub use key_store::OfflineKeyStore; diff --git a/rustfs/tests/connect_offline_enrollment.rs b/rustfs/tests/connect_offline_enrollment.rs new file mode 100644 index 000000000..e1e9cf0a1 --- /dev/null +++ b/rustfs/tests/connect_offline_enrollment.rs @@ -0,0 +1,951 @@ +// Copyright 2024 RustFS Team +// +// Licensed 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. + +//! Offline enrollment conformance against the frozen Connect fixtures. +//! +//! The device half of the air-gapped exchange verifies a challenge Connect +//! signed and produces a response Connect will verify. Neither side can talk to +//! the other while it does so, which means every disagreement about encoding, +//! trust, or clock windows surfaces as a failed enrollment in the field rather +//! than as an error at development time. The fixtures under +//! `protocol/agent/v1/fixtures/offline-enrollment/` are the shared statement of +//! what both sides must do, so this suite replays them rather than restating +//! them: accept vectors must be accepted with the fields the document carries, +//! reject vectors must fail with the single reason `error-codes.json` freezes, +//! and the signature encoding rules in `trust-model.json` must hold even where +//! the underlying ECDSA library is happy. + +use std::fs; +use std::path::PathBuf; + +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64_STANDARD; +use base64::engine::general_purpose::URL_SAFE_NO_PAD as BASE64_URL_NO_PAD; +use rustfs::connect::identity::DeviceIdentity; +use rustfs::connect::offline::{EnrollmentError, OfflineEnrollment, VerifiedChallenge}; +use serde_json::Value; +use sha2::{Digest as _, Sha256}; + +/// DER prefix of a P-256 `SubjectPublicKeyInfo`, frozen by +/// `trust-model.json` as `signature.subjectPublicKeyInfoDerPrefix`. The 65 +/// octet uncompressed point follows it, so a SEC1 point published in a fixture +/// becomes a decodable public key by concatenation. +const SPKI_PREFIX_HEX: &str = "3059301306072a8648ce3d020106082a8648ce3d030107034200"; + +/// `clockSkew.toleranceSeconds` in `trust-model.json`. +const SKEW_TOLERANCE_SECONDS: i64 = 300; + +// --------------------------------------------------------------------------- +// Fixture access +// --------------------------------------------------------------------------- + +fn fixture_dir() -> PathBuf { + PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("../protocol/agent/v1/fixtures/offline-enrollment") +} + +fn sha256_hex(bytes: &[u8]) -> String { + Sha256::digest(bytes).iter().map(|byte| format!("{byte:02x}")).collect() +} + +/// Read one fixture file and refuse it unless its bytes match the digest +/// `MANIFEST.sha256` freezes. +/// +/// Every vector in this suite arrives through here. A fixture edited on this +/// side therefore fails the tests that depend on it instead of quietly +/// redefining what conformance means, which is the failure mode a +/// fixture-driven suite is otherwise blind to. +fn read_fixture(name: &str) -> Vec { + let dir = fixture_dir(); + let manifest = fs::read_to_string(dir.join("MANIFEST.sha256")).expect("read MANIFEST.sha256"); + + let expected = manifest + .lines() + .filter(|line| !line.trim().is_empty()) + .find_map(|line| { + let (digest, file) = line + .split_once(" ") + .unwrap_or_else(|| panic!("malformed manifest line: {line}")); + (file == name).then(|| digest.to_string()) + }) + .unwrap_or_else(|| panic!("{name} is not listed in MANIFEST.sha256")); + + let bytes = fs::read(dir.join(name)).unwrap_or_else(|error| panic!("read {name}: {error}")); + assert_eq!(sha256_hex(&bytes), expected, "{name} does not match the digest MANIFEST.sha256 freezes"); + bytes +} + +fn fixture_json(name: &str) -> Value { + serde_json::from_slice(&read_fixture(name)).unwrap_or_else(|error| panic!("{name} parses: {error}")) +} + +fn accept_vectors() -> Value { + fixture_json("accept-vectors.json") +} + +fn reject_vectors() -> Value { + fixture_json("reject-vectors.json") +} + +fn trust_model() -> Value { + fixture_json("trust-model.json") +} + +fn vector_list(fixture: &Value) -> Vec { + fixture["vectors"].as_array().expect("fixture carries a vector list").clone() +} + +fn field<'a>(value: &'a Value, key: &str) -> &'a str { + value[key] + .as_str() + .unwrap_or_else(|| panic!("expected a string at '{key}' in {value}")) +} + +/// The octets an operator carries in on removable media. +/// +/// The fixture's `document` object *is* the transmitted artifact: a padded +/// base64 `bytes` field holding the raw signed octets, plus the detached +/// signature over them. Only `bytes` is covered by the signature, so +/// re-serialising the surrounding envelope here cannot change what a verifier +/// checks. +fn envelope(document: &Value) -> Vec { + serde_json::to_vec(document).expect("envelope serialises") +} + +/// The raw octets the signature covers, exactly as transmitted. +fn signed_octets(document: &Value) -> Vec { + BASE64_STANDARD + .decode(field(document, "bytes")) + .expect("document bytes are padded base64") +} + +/// The parsed signed document. Parsing is a convenience for the assertions +/// below; the implementation under test is required to verify before it parses. +fn signed_document(document: &Value) -> Value { + serde_json::from_slice(&signed_octets(document)).expect("signed document parses") +} + +fn unix(rfc3339: &str) -> i64 { + chrono::DateTime::parse_from_rfc3339(rfc3339) + .unwrap_or_else(|error| panic!("'{rfc3339}' is not RFC 3339: {error}")) + .timestamp() +} + +fn hex_to_bytes(hex: &str) -> Vec { + (0..hex.len()) + .step_by(2) + .map(|i| u8::from_str_radix(&hex[i..i + 2], 16).expect("valid hex")) + .collect() +} + +/// Turn a fixture's unpadded-base64url SEC1 point into a usable verifying key. +fn verifying_key(sec1_base64url: &str) -> p256::ecdsa::VerifyingKey { + let point = BASE64_URL_NO_PAD.decode(sec1_base64url).expect("public key is base64url"); + assert_eq!(point.len(), 65, "the protocol freezes a 65 octet uncompressed SEC1 point"); + + let mut der = hex_to_bytes(SPKI_PREFIX_HEX); + der.extend_from_slice(&point); + ::from_public_key_der(&der).expect("public key decodes") +} + +fn published_key(role_or_name: &str) -> Value { + fixture_json("trust-chain.json")["keys"] + .as_array() + .expect("trust chain publishes keys") + .iter() + .find(|key| field(key, "name") == role_or_name) + .unwrap_or_else(|| panic!("trust-chain.json publishes no key named '{role_or_name}'")) + .clone() +} + +/// `signatureInput = domainSeparationTag || 0x00 || the received octets`, the +/// rule `trust-model.json` freezes under `domainSeparation`. +fn signing_input(artifact_tag: &str, received: &[u8]) -> Vec { + let mut input = artifact_tag.as_bytes().to_vec(); + input.push(0x00); + input.extend_from_slice(received); + input +} + +fn domain_tag(artifact: &str) -> String { + let model = trust_model(); + assert_eq!( + field(&model["domainSeparation"], "separatorByte"), + "0x00", + "the separator byte this suite encodes is the one the trust model freezes" + ); + field(&model["domainSeparation"]["tags"], artifact).to_string() +} + +/// Locate an accept vector by the name other vectors reference it by. +fn accept_vector_named(name: &str) -> Value { + vector_list(&accept_vectors()) + .into_iter() + .find(|vector| field(vector, "name") == name) + .unwrap_or_else(|| panic!("accept-vectors.json carries no vector named '{name}'")) +} + +/// Verify the challenge a response vector answers, at that challenge's own +/// evaluation time. +fn answered_challenge(response_vector: &Value) -> (Value, VerifiedChallenge) { + let challenge_vector = accept_vector_named(field(response_vector, "answersChallenge")); + let now = unix(field(&challenge_vector, "evaluationTime")); + let verified = OfflineEnrollment::verify_challenge(&envelope(&challenge_vector["document"]), now) + .expect("the answered challenge is an accept vector and must verify"); + (challenge_vector, verified) +} + +fn device_nonce_of(document: &Value) -> [u8; 32] { + let raw = BASE64_URL_NO_PAD + .decode(field(&signed_document(document), "deviceNonce")) + .expect("deviceNonce is base64url"); + raw.try_into().expect("replay.nonceLengthBytes freezes a 32 octet nonce") +} + +// --------------------------------------------------------------------------- +// Accept vectors +// --------------------------------------------------------------------------- + +/// Every challenge accept vector must verify at its own evaluation time and +/// expose exactly what the signed document says. +/// +/// Two of these vectors sit on the skew boundary — 120 seconds before +/// `issuedAt` and 300 seconds after `expiresAt` — so a verifier that compares +/// against the raw window instead of the tolerated one fails here rather than +/// in an air-gapped data centre. `challenge_proof` is pinned to the challenge's +/// own detached signature value because that is what the response has to echo; +/// deriving it from anything else would silently break the binding. +#[test] +fn every_challenge_accept_vector_verifies_and_exposes_the_signed_fields() { + let mut verified_count = 0usize; + + for vector in vector_list(&accept_vectors()) { + if field(&vector, "artifact") != "challenge" { + continue; + } + + let name = field(&vector, "name"); + let document = &vector["document"]; + let now = unix(field(&vector, "evaluationTime")); + + let verified = OfflineEnrollment::verify_challenge(&envelope(document), now) + .unwrap_or_else(|error| panic!("accept vector '{name}' must verify: {}", error.reason())); + + let signed = signed_document(document); + assert_eq!(verified.challenge_id, field(&signed, "challengeId"), "vector '{name}' challengeId"); + assert_eq!( + verified.organization_name, + field(&signed, "organizationName"), + "vector '{name}' organizationName" + ); + assert_eq!(verified.cluster_name, field(&signed, "clusterName"), "vector '{name}' clusterName"); + assert_eq!(verified.nonce, field(&signed, "nonce"), "vector '{name}' nonce"); + assert_eq!(verified.issued_at, field(&signed, "issuedAt"), "vector '{name}' issuedAt"); + assert_eq!(verified.expires_at, field(&signed, "expiresAt"), "vector '{name}' expiresAt"); + assert_eq!(verified.connect_key_id, field(&signed, "connectKeyId"), "vector '{name}' connectKeyId"); + assert_eq!( + verified.challenge_proof, + field(&document["signature"], "value"), + "vector '{name}' must carry the challenge's own signature as the proof a response echoes" + ); + + verified_count += 1; + } + + assert_eq!( + verified_count, 3, + "accept-vectors.json publishes three challenge vectors; a fourth is a protocol change" + ); +} + +/// Connect's own producer wrote the response accept vectors. Rebuilding them +/// from the challenge they answer, with the device nonce and production time +/// they used, must reproduce every field that does not depend on which device +/// key signed — including the discarded-unknown-field vector, whose extra +/// `telemetryHint` must not survive into anything this side produces. +#[test] +fn response_accept_vectors_are_reproduced_field_for_field_by_build_response() { + let key = DeviceIdentity::generate(); + let mut reproduced = 0usize; + + for vector in vector_list(&accept_vectors()) { + if field(&vector, "artifact") != "response" { + continue; + } + + let name = field(&vector, "name"); + let published = signed_document(&vector["document"]); + let (_, challenge) = answered_challenge(&vector); + + let produced_at = unix(field(&published, "producedAt")); + let nonce = device_nonce_of(&vector["document"]); + + let built_envelope: Value = serde_json::from_slice( + &OfflineEnrollment::build_response(&challenge, &key, &nonce, produced_at) + .unwrap_or_else(|error| panic!("vector '{name}' must be reproducible: {}", error.reason())), + ) + .expect("the built response is JSON"); + let built = signed_document(&built_envelope); + + for shared in [ + "formatVersion", + "protocolVersion", + "challengeId", + "organizationName", + "clusterName", + "challengeNonce", + "challengeProof", + "deviceNonce", + ] { + assert_eq!( + field(&built, shared), + field(&published, shared), + "vector '{name}' field {shared} must match the response Connect published" + ); + } + assert_eq!( + unix(field(&built, "producedAt")), + produced_at, + "vector '{name}' producedAt must be the instant it was given" + ); + + // `versioning.additive` says an unknown optional field is discarded and + // never echoed back; a producer that copied the challenge or a previous + // response wholesale would carry it forward. + assert!( + built.get("telemetryHint").is_none(), + "vector '{name}' must not echo an unknown optional field" + ); + + reproduced += 1; + } + + assert_eq!( + reproduced, 2, + "accept-vectors.json publishes two response vectors; a third is a protocol change" + ); +} + +// --------------------------------------------------------------------------- +// Reject vectors +// --------------------------------------------------------------------------- + +/// Every challenge reject vector must fail, and fail for the one reason +/// `error-codes.json` freezes. +/// +/// Asserting only that verification failed would pass for an implementation +/// that rejects everything, and would let a tampered document be reported as an +/// expiry — a rejection reason is what an operator acts on, so it is part of the +/// contract rather than a diagnostic detail. +#[test] +fn every_challenge_reject_vector_fails_with_its_frozen_reason() { + let known_reasons: Vec = fixture_json("error-codes.json")["reasons"] + .as_array() + .expect("error-codes.json carries reasons") + .iter() + .map(|entry| field(entry, "reason").to_string()) + .collect(); + + let mut rejected = 0usize; + + for vector in vector_list(&reject_vectors()) { + if field(&vector, "artifact") != "challenge" { + continue; + } + + let name = field(&vector, "name"); + let expected = field(&vector["expected"], "reason"); + assert!( + known_reasons.iter().any(|reason| reason == expected), + "vector '{name}' names reason {expected}, which error-codes.json does not freeze" + ); + + let now = unix(field(&vector, "evaluationTime")); + let error = OfflineEnrollment::verify_challenge(&envelope(&vector["document"]), now) + .expect_err(&format!("reject vector '{name}' must not verify")); + + assert_eq!(error.reason(), expected, "vector '{name}' must fail as {expected}"); + rejected += 1; + } + + assert_eq!( + rejected, 8, + "reject-vectors.json publishes eight challenge vectors; losing one silently narrows the suite" + ); +} + +/// The response reject vectors are artifacts Connect refuses. This side never +/// verifies a response, so the device-side statement is the stronger one: given +/// the challenge each vector answers, `build_response` must not be capable of +/// emitting that artifact in the first place. +/// +/// Each arm pins the specific field a compromised or careless producer would +/// have to get wrong, so an implementation that copied values out of the wrong +/// place — the response's own document, an operator-supplied argument, a +/// previous exchange — fails here. +#[test] +fn response_reject_vectors_are_artifacts_build_response_cannot_emit() { + let key = DeviceIdentity::generate(); + let mut covered = 0usize; + + for vector in vector_list(&reject_vectors()) { + if field(&vector, "artifact") != "response" { + continue; + } + + let name = field(&vector, "name"); + let refused = signed_document(&vector["document"]); + let (_, challenge) = answered_challenge(&vector); + let produced_at = unix(field(&refused, "producedAt")); + let nonce = device_nonce_of(&vector["document"]); + + let outcome = OfflineEnrollment::build_response(&challenge, &key, &nonce, produced_at); + + match field(&vector["expected"], "reason") { + // `responseWindow` in trust-model.json: a device that emits a + // response outside the tolerated challenge window has produced an + // artifact Connect will refuse, so the refusal belongs here rather + // than at the far end of a courier run. + "CHALLENGE_EXPIRED" => { + let error = outcome.expect_err(&format!("vector '{name}': producing this response must be refused")); + assert_eq!(error.reason(), "CHALLENGE_EXPIRED", "vector '{name}' must refuse as CHALLENGE_EXPIRED"); + covered += 1; + continue; + } + reason => { + let built_envelope: Value = serde_json::from_slice( + &outcome.unwrap_or_else(|error| panic!("vector '{name}' baseline must build: {}", error.reason())), + ) + .expect("the built response is JSON"); + let built = signed_document(&built_envelope); + + match reason { + "ORGANIZATION_MISMATCH" => { + assert_ne!( + field(&refused, "organizationName"), + challenge.organization_name, + "vector '{name}' is only a mismatch if it names another organization" + ); + assert_eq!( + field(&built, "organizationName"), + challenge.organization_name, + "vector '{name}': the organization must come from the challenge, never from elsewhere" + ); + } + "CLUSTER_MISMATCH" => { + assert_ne!( + field(&refused, "clusterName"), + challenge.cluster_name, + "vector '{name}' is only a mismatch if it names another cluster" + ); + assert_eq!( + field(&built, "clusterName"), + challenge.cluster_name, + "vector '{name}': the cluster must come from the challenge, never from elsewhere" + ); + } + "CHALLENGE_PROOF_INVALID" => { + // Two distinct vectors land here: a nonce the challenge + // never carried, and a proof lifted from another + // challenge. Both must be impossible to produce. + assert_eq!( + field(&built, "challengeNonce"), + challenge.nonce, + "vector '{name}': the echoed nonce must be the challenge's own" + ); + assert_eq!( + field(&built, "challengeProof"), + challenge.challenge_proof, + "vector '{name}': the proof must be the answered challenge's signature" + ); + assert!( + field(&refused, "challengeNonce") != challenge.nonce + || field(&refused, "challengeProof") != challenge.challenge_proof, + "vector '{name}' must differ from the challenge in nonce or proof to be rejectable" + ); + } + "DEVICE_PROOF_INVALID" => { + // The refused vector presents one key and is signed by + // another; hold the fixture to that claim, then require + // the built response to be the opposite. Proof of + // possession is the only thing that makes presenting a + // key in an unauthenticated document safe. + use p256::ecdsa::signature::Verifier as _; + + let presented = verifying_key(field(&refused, "devicePublicKey")); + let raw = BASE64_URL_NO_PAD + .decode(field(&vector["document"]["signature"], "value")) + .expect("signature is base64url"); + let signature = p256::ecdsa::Signature::from_slice(&raw).expect("signature parses"); + assert!( + presented + .verify( + &signing_input(&domain_tag("enrollmentResponse"), &signed_octets(&vector["document"])), + &signature + ) + .is_err(), + "vector '{name}' is only a possession failure if it does not verify under the key it presents" + ); + + assert_response_proves_possession(&built_envelope, name); + } + "UNSUPPORTED_FORMAT" => { + assert_ne!( + field(&refused, "formatVersion"), + field(&built, "formatVersion"), + "vector '{name}' is only unsupported if it names another format version" + ); + assert_eq!( + field(&built, "formatVersion"), + "rustfs.connect.offline.enrollmentResponse/1", + "vector '{name}': the format version is frozen" + ); + } + "UNSUPPORTED_PROTOCOL" => { + assert_ne!( + field(&refused, "protocolVersion"), + field(&built, "protocolVersion"), + "vector '{name}' is only unsupported if it names another protocol major" + ); + assert_eq!(field(&built, "protocolVersion"), "v1", "vector '{name}': the protocol major is frozen"); + } + "ENROLLMENT_REPLAYED" => { + // The vector claims to be a byte-identical replay of an + // accepted response; hold it to that, because a replay + // vector that is not byte identical proves nothing about + // single use. + let accepted = accept_vector_named("response binding the device public key and the challenge proof"); + assert_eq!( + signed_octets(&vector["document"]), + signed_octets(&accepted["document"]), + "vector '{name}' must be the accepted response octet for octet" + ); + assert_eq!( + field(&vector["document"]["signature"], "value"), + field(&accepted["document"]["signature"], "value"), + "vector '{name}' must carry the accepted response's signature" + ); + + // A fresh device nonce is a different artifact, so a + // second enrollment is never mistaken for a replay of + // the first. + let other = OfflineEnrollment::build_response(&challenge, &key, &[0x5a; 32], produced_at) + .expect("a second response builds"); + assert_ne!( + signed_octets(&built_envelope), + signed_octets(&serde_json::from_slice::(&other).expect("JSON")), + "vector '{name}': a different device nonce must yield a different artifact" + ); + } + other => panic!("vector '{name}' names an unhandled reason {other}; extend this test"), + } + } + } + + covered += 1; + } + + assert_eq!( + covered, 9, + "reject-vectors.json publishes nine response vectors; losing one silently narrows the suite" + ); +} + +// --------------------------------------------------------------------------- +// Signature encoding +// --------------------------------------------------------------------------- + +/// The high-S malleation is the rejection the whole encoding rule exists for. +/// +/// `(r, n - s)` is a second valid signature over the same document under the +/// same key. Every mainstream ECDSA library verifies it, so an implementation +/// that hands the decoded octets straight to `p256` accepts a forged-looking +/// duplicate of a genuine challenge — and because the 64 octets differ, that +/// duplicate is a distinct artifact identity that slips past any deduplication +/// keyed on the signature. This test proves the rejection came from the +/// encoding rule and not from a failed verification: it first shows the +/// malleated signature verifying mathematically, then requires +/// `verify_challenge` to refuse it as SIGNATURE_NOT_CANONICAL. +#[test] +fn malleated_high_s_signature_is_refused_although_it_verifies_mathematically() { + use p256::ecdsa::signature::Verifier as _; + + let model = trust_model(); + let malleated = model["rejectedSignatureEncodings"] + .as_array() + .expect("trust-model.json publishes rejected encodings") + .iter() + .find(|entry| field(entry, "reason") == "SIGNATURE_NOT_CANONICAL") + .expect("trust-model.json publishes the high-S malleation") + .clone(); + assert!( + malleated["acceptedByALenientVerifier"].as_bool() == Some(true), + "this vector is only interesting because a lenient verifier accepts it" + ); + + let vector = accept_vector_named("challenge signed by a chained signing key under the pinned root"); + let genuine_value = field(&vector["document"]["signature"], "value").to_string(); + let malleated_value = field(&malleated, "value").to_string(); + assert_ne!(genuine_value, malleated_value, "the malleation must be a different encoding"); + + let genuine = BASE64_URL_NO_PAD.decode(&genuine_value).expect("signature is base64url"); + let raw = BASE64_URL_NO_PAD.decode(&malleated_value).expect("signature is base64url"); + assert_eq!(raw.len(), 64, "the malleation is well formed at 64 octets"); + assert_eq!(raw[..32], genuine[..32], "the malleation shares r with the genuine signature"); + assert_ne!(raw[32..], genuine[32..], "the malleation replaces s with n - s"); + + // Step one: the malleated pair really does verify under the signing key, so + // a verifier cannot be excused for accepting it on mathematical grounds. + let signature = p256::ecdsa::Signature::from_slice(&raw).expect("the malleated signature parses"); + assert!(signature.normalize_s().is_some(), "the malleated signature must be the high-S form"); + let key = verifying_key(field(&published_key("signing"), "publicKey")); + let input = signing_input(&domain_tag("enrollmentChallenge"), &signed_octets(&vector["document"])); + key.verify(&input, &signature) + .expect("the malleated signature must verify mathematically, or this test proves nothing"); + + // Step two: the implementation must refuse it anyway, and say why. + let mut tampered = vector["document"].clone(); + tampered["signature"]["value"] = Value::String(malleated_value); + + let now = unix(field(&vector, "evaluationTime")); + let error = OfflineEnrollment::verify_challenge(&envelope(&tampered), now) + .expect_err("a high-S signature must be refused even though it verifies"); + assert_eq!( + error.reason(), + "SIGNATURE_NOT_CANONICAL", + "a malleated signature is a canonicality failure, not a verification failure" + ); +} + +/// Every encoding `trust-model.json` names as rejected must fail with the +/// reason it names — DER, padded base64url, truncation, and out-of-range +/// scalars alongside the malleation. Three of the five are accepted by a +/// lenient verifier, so a single blanket "signature did not verify" answer would +/// be both wrong and undiagnosable. +#[test] +fn every_rejected_signature_encoding_fails_with_its_frozen_reason() { + let vector = accept_vector_named("challenge signed by a chained signing key under the pinned root"); + let now = unix(field(&vector, "evaluationTime")); + let model = trust_model(); + let encodings = model["rejectedSignatureEncodings"] + .as_array() + .expect("trust-model.json publishes rejected encodings"); + + for entry in encodings { + let name = field(entry, "name"); + let mut tampered = vector["document"].clone(); + tampered["signature"]["value"] = Value::String(field(entry, "value").to_string()); + + let error: EnrollmentError = OfflineEnrollment::verify_challenge(&envelope(&tampered), now) + .err() + .unwrap_or_else(|| panic!("rejected encoding '{name}' must not verify")); + + assert_eq!(error.reason(), field(entry, "reason"), "rejected encoding '{name}'"); + } + + assert_eq!(encodings.len(), 5, "trust-model.json freezes five rejected encodings"); +} + +// --------------------------------------------------------------------------- +// Clock window +// --------------------------------------------------------------------------- + +/// The tolerated window is `[issuedAt - 300, expiresAt + 300]`, inclusive at +/// both ends. An air-gapped device has no synchronised clock, so an +/// off-by-one here either strands a legitimate enrollment or widens the window +/// a stolen challenge stays usable in. Both ends are checked at the exact bound +/// and one second past it, and the reason distinguishes the two directions. +#[test] +fn challenge_is_accepted_at_the_exact_skew_bound_and_refused_one_second_past_it() { + let vector = accept_vector_named("challenge signed by a chained signing key under the pinned root"); + let document = envelope(&vector["document"]); + let signed = signed_document(&vector["document"]); + + let issued_at = unix(field(&signed, "issuedAt")); + let expires_at = unix(field(&signed, "expiresAt")); + + let earliest = issued_at - SKEW_TOLERANCE_SECONDS; + OfflineEnrollment::verify_challenge(&document, earliest).expect("the earliest tolerated instant is inside the window"); + let error = + OfflineEnrollment::verify_challenge(&document, earliest - 1).expect_err("one second earlier is outside the window"); + assert_eq!(error.reason(), "CHALLENGE_NOT_YET_VALID"); + + let latest = expires_at + SKEW_TOLERANCE_SECONDS; + OfflineEnrollment::verify_challenge(&document, latest).expect("the latest tolerated instant is inside the window"); + let error = OfflineEnrollment::verify_challenge(&document, latest + 1).expect_err("one second later is outside the window"); + assert_eq!(error.reason(), "CHALLENGE_EXPIRED"); +} + +// --------------------------------------------------------------------------- +// Response production +// --------------------------------------------------------------------------- + +/// Assert a built response proves possession of the key it presents: the +/// fingerprint matches the presented key, and the detached signature is a +/// canonical low-S ES256 signature that verifies under that key over the exact +/// octets transmitted. +fn assert_response_proves_possession(built_envelope: &Value, label: &str) { + use p256::ecdsa::signature::Verifier as _; + + let raw = signed_octets(built_envelope); + let built = signed_document(built_envelope); + let signature_block = &built_envelope["signature"]; + + assert_eq!(field(signature_block, "algorithm"), "ES256", "{label}: the algorithm is frozen"); + + let value = field(signature_block, "value"); + assert_eq!(value.len(), 86, "{label}: the transfer encoding is 86 unpadded base64url characters"); + assert!( + value.bytes().all(|b| b.is_ascii_alphanumeric() || b == b'-' || b == b'_'), + "{label}: the signature must use the base64url alphabet with no padding" + ); + + let bytes = BASE64_URL_NO_PAD.decode(value).expect("signature is base64url"); + assert_eq!(bytes.len(), 64, "{label}: the signature is a fixed-width r || s"); + let signature = p256::ecdsa::Signature::from_slice(&bytes).expect("signature parses"); + assert!( + signature.normalize_s().is_none(), + "{label}: this side must never emit the malleated high-S form it refuses to accept" + ); + + let presented = field(&built, "devicePublicKey"); + let key = verifying_key(presented); + key.verify(&signing_input(&domain_tag("enrollmentResponse"), &raw), &signature) + .unwrap_or_else(|error| panic!("{label}: the response must verify under the key it presents: {error}")); + + // `signature.keyIdAlgorithm`: the lowercase SHA-256 of the DER + // SubjectPublicKeyInfo, not of the bare point and not of the transfer + // encoding. + let mut spki = hex_to_bytes(SPKI_PREFIX_HEX); + spki.extend_from_slice(&BASE64_URL_NO_PAD.decode(presented).expect("public key is base64url")); + let fingerprint = sha256_hex(&spki); + assert_eq!( + field(&built, "deviceKeyId"), + fingerprint, + "{label}: deviceKeyId must be the fingerprint of the key the document presents" + ); + assert_eq!( + field(signature_block, "keyId"), + fingerprint, + "{label}: the detached signature must name the same key" + ); +} + +/// A response is the only thing Connect will ever see from this device, so it +/// has to carry the whole binding on its own: the challenge it answers, the +/// proof that challenge was genuine, the key being enrolled, and possession of +/// that key. +#[test] +fn built_response_binds_the_challenge_proof_and_proves_possession_of_the_device_key() { + let vector = accept_vector_named("response binding the device public key and the challenge proof"); + let (challenge_vector, challenge) = answered_challenge(&vector); + let key = DeviceIdentity::generate(); + let produced_at = unix(field(&signed_document(&vector["document"]), "producedAt")); + + let bytes = OfflineEnrollment::build_response(&challenge, &key, &[0x11; 32], produced_at).expect("the response builds"); + let built_envelope: Value = serde_json::from_slice(&bytes).expect("the response is JSON"); + let built = signed_document(&built_envelope); + + assert_response_proves_possession(&built_envelope, "built response"); + + // The proof is the challenge's own detached signature. A producer that + // echoed the nonce alone, or hashed something, would let a response be + // built from an unverified challenge. + assert_eq!( + field(&built, "challengeProof"), + field(&challenge_vector["document"]["signature"], "value"), + "the proof must be the signature of the challenge being answered" + ); + assert_eq!(field(&built, "challengeNonce"), challenge.nonce); + assert_eq!(field(&built, "challengeId"), challenge.challenge_id); + + assert_eq!( + field(&built, "devicePublicKey"), + BASE64_URL_NO_PAD.encode(&key.public_key_der()[hex_to_bytes(SPKI_PREFIX_HEX).len()..]), + "the presented key must be the key that was passed in" + ); + assert_eq!( + field(&built, "deviceNonce"), + BASE64_URL_NO_PAD.encode([0x11; 32]), + "the device nonce must be the one that was passed in" + ); + assert!(field(&built, "producedAt").ends_with('Z'), "producedAt is a UTC RFC 3339 instant"); +} + +/// The response leaves the air gap on removable media and is read by anyone who +/// handles it. A producer that serialised the key pair instead of the public +/// key, or logged a debug rendering into the document, would put the enrolled +/// private key on that medium — and the enrollment would still succeed, so +/// nothing else in this suite would notice. +#[test] +fn built_response_carries_no_private_key_material() { + let vector = accept_vector_named("response binding the device public key and the challenge proof"); + let (_, challenge) = answered_challenge(&vector); + let key = DeviceIdentity::generate(); + let produced_at = unix(field(&signed_document(&vector["document"]), "producedAt")); + + let response = OfflineEnrollment::build_response(&challenge, &key, &[0x22; 32], produced_at).expect("the response builds"); + + // The envelope carries the signed document base64-encoded, so a needle + // present in the document is not present in the envelope octets. Both + // layers are searched: an operator handling the medium can read either. + let envelope_value: Value = serde_json::from_slice(&response).expect("the response is JSON"); + let mut haystack = response; + haystack.extend_from_slice(&signed_octets(&envelope_value)); + + let pkcs8 = key.to_pkcs8_der().expect("serialise the key"); + let secret = ::from_pkcs8_der(&pkcs8).expect("the key parses"); + let scalar = secret.to_bytes(); + + // Every spelling the scalar could plausibly reach a document in: raw, and + // the three encodings this protocol already uses elsewhere. + let scalar_hex: String = scalar.iter().map(|byte| format!("{byte:02x}")).collect(); + for (description, needle) in [ + ("the PKCS#8 encoding", pkcs8.to_vec()), + ("the raw private scalar", scalar.to_vec()), + ("the scalar in base64url", BASE64_URL_NO_PAD.encode(scalar).into_bytes()), + ("the scalar in standard base64", BASE64_STANDARD.encode(scalar).into_bytes()), + ("the scalar in hex", scalar_hex.into_bytes()), + ] { + assert!( + !haystack.windows(needle.len()).any(|window| window == needle.as_slice()), + "the response must not contain {description}" + ); + } + + // The public half must be there, so the absence above is a statement about + // what was excluded rather than about a haystack that would not have found + // the private half either. + let point = BASE64_URL_NO_PAD.encode(&key.public_key_der()[hex_to_bytes(SPKI_PREFIX_HEX).len()..]); + assert!( + haystack.windows(point.len()).any(|window| window == point.as_bytes()), + "the response must still present the public key" + ); +} + +// --------------------------------------------------------------------------- +// The offline invariant +// --------------------------------------------------------------------------- + +/// The whole surface exists because there is no network. This asserts that +/// three different ways, because no single one of them is conclusive on its own. +/// +/// 1. The process opens no descriptor across a full verify-and-respond cycle. A +/// socket, a DNS resolver, a pooled HTTP client, or a revocation-list fetch +/// all show up here — including one that is opened and cached rather than +/// opened and closed, which is what a lazily built client does. +/// 2. The cycle is a pure byte transform: the same inputs produce the same +/// verified fields, and the evaluation instant is an argument rather than an +/// ambient read, so nothing about the outcome can depend on reachability. +/// 3. Repeating the cycle changes nothing observable, so a first call cannot be +/// quietly initialising shared state that a later one reuses. +#[cfg(unix)] +#[test] +fn enrollment_opens_no_descriptor_and_is_a_pure_byte_transform() { + let vector = accept_vector_named("challenge signed by a chained signing key under the pinned root"); + let document = envelope(&vector["document"]); + let now = unix(field(&vector, "evaluationTime")); + let key = DeviceIdentity::generate(); + + // Warm anything the test harness itself lazily opens before the baseline. + let _ = open_descriptors(); + let baseline = open_descriptors(); + assert!( + !baseline.is_empty(), + "the descriptor table must be readable for this test to mean anything" + ); + + let mut fields = Vec::new(); + for _ in 0..2 { + let challenge = OfflineEnrollment::verify_challenge(&document, now).expect("the challenge verifies"); + let response = OfflineEnrollment::build_response(&challenge, &key, &[0x33; 32], now).expect("the response builds"); + fields.push(( + challenge.challenge_id.clone(), + challenge.nonce.clone(), + challenge.challenge_proof.clone(), + signed_octets(&serde_json::from_slice::(&response).expect("JSON")), + )); + } + + assert_eq!( + open_descriptors(), + baseline, + "the enrollment path must not open a descriptor: no socket, no resolver, no cached client" + ); + + let (first, second) = (&fields[0], &fields[1]); + assert_eq!(first.0, second.0, "verification must be deterministic"); + assert_eq!(first.1, second.1, "verification must be deterministic"); + assert_eq!(first.2, second.2, "verification must be deterministic"); + assert_eq!( + first.3, second.3, + "the signed response octets are a function of the challenge, the key, the nonce, and the instant" + ); +} + +#[cfg(unix)] +fn open_descriptors() -> Vec { + // Linux publishes the table at /proc/self/fd; the BSDs and macOS at /dev/fd. + let path = if PathBuf::from("/proc/self/fd").is_dir() { + "/proc/self/fd" + } else { + "/dev/fd" + }; + + let mut entries: Vec = fs::read_dir(path) + .unwrap_or_else(|error| panic!("read {path}: {error}")) + .map(|entry| entry.expect("read dir entry").file_name().to_string_lossy().into_owned()) + .collect(); + entries.sort(); + entries +} + +/// A descriptor count taken around a call cannot see a socket that was opened +/// and closed inside it, so the invariant is also asserted where it can be +/// stated absolutely: the implementation names no network API at all. +/// +/// This is the shape the regression actually takes — someone adds a +/// revocation-list fetch, a time-server check, or a "just confirm the challenge +/// with Connect" call — and it is caught at the source rather than by observing +/// its effects. +#[test] +fn enrollment_implementation_names_no_network_api() { + let path = PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("src/connect/offline/enrollment.rs"); + let source = fs::read_to_string(&path).unwrap_or_else(|error| panic!("read {}: {error}", path.display())); + + // Prose is allowed to discuss the invariant it is documenting, so only code + // is scanned. + let code: String = source + .lines() + .filter(|line| !line.trim_start().starts_with("//")) + .collect::>() + .join("\n"); + + for forbidden in [ + "std::net", + "tokio::net", + "TcpStream", + "TcpListener", + "UdpSocket", + "UnixStream", + "ToSocketAddrs", + "reqwest", + "hyper", + "tonic", + ] { + assert!( + !code.contains(forbidden), + "offline enrollment must not reach the network, but the implementation names {forbidden}" + ); + } +} From bc07cfd115118dbcabf577e14804576f229ac940 Mon Sep 17 00:00:00 2001 From: Zhengchao An Date: Fri, 21 Aug 2026 23:04:08 +0800 Subject: [PATCH 02/10] ci: harden test selection and nightly coverage (#6341) --- .config/e2e-full-selection.txt | 2 + .config/e2e-nightly-selection.txt | 1 + .config/e2e-protocols-selection.txt | 2 + .config/e2e-repl-nightly-selection.txt | 1 + .config/e2e-smoke-selection.txt | 1 + .config/make/lint-fmt.mak | 5 + .config/make/pre-commit.mak | 6 +- .config/make/tests.mak | 2 + .config/nextest.toml | 62 ++- .github/s3tests/README.md | 7 +- .github/workflows/ci-docs-only.yml | 3 + .github/workflows/ci.yml | 23 +- .github/workflows/e2e-replication-nightly.yml | 133 +++++- .github/workflows/e2e-s3tests.yml | 63 ++- .github/workflows/fuzz.yml | 35 +- crates/e2e_test/README.md | 47 +- crates/e2e_test/src/protocols/README.md | 8 +- crates/ecstore/src/set_disk/mod.rs | 12 +- crates/utils/src/net.rs | 3 +- docs/testing/e2e-suite-inventory.md | 64 +-- fuzz/fuzz_targets/archive_extract.rs | 11 +- fuzz/fuzz_targets/policy_ingress.rs | 6 +- scripts/check_test_wiring.py | 419 ++++++++++++++++++ scripts/run_e2e_tests.sh | 25 +- scripts/s3-tests/README.md | 16 +- scripts/s3-tests/excluded_tests.txt | 7 + scripts/s3-tests/implemented_tests.txt | 4 + scripts/s3-tests/report_compat.py | 156 ++++++- scripts/s3-tests/run.sh | 158 ++++--- scripts/s3-tests/test_report_compat.py | 119 +++++ scripts/s3-tests/unimplemented_tests.txt | 4 + 31 files changed, 1146 insertions(+), 259 deletions(-) create mode 100644 .config/e2e-full-selection.txt create mode 100644 .config/e2e-nightly-selection.txt create mode 100644 .config/e2e-protocols-selection.txt create mode 100644 .config/e2e-repl-nightly-selection.txt create mode 100644 .config/e2e-smoke-selection.txt create mode 100755 scripts/check_test_wiring.py create mode 100644 scripts/s3-tests/test_report_compat.py diff --git a/.config/e2e-full-selection.txt b/.config/e2e-full-selection.txt new file mode 100644 index 000000000..bb9022327 --- /dev/null +++ b/.config/e2e-full-selection.txt @@ -0,0 +1,2 @@ +sha256-darwin=b4ae71aa894e5c7795ae3eb8116f1777a7601d0f5db3898be2e48faf3329bd9b +sha256-linux=433debd9d9defa832986269abdf0f1d131597b2d7a417ce930e17c1fd47d85ba diff --git a/.config/e2e-nightly-selection.txt b/.config/e2e-nightly-selection.txt new file mode 100644 index 000000000..9d929e2ee --- /dev/null +++ b/.config/e2e-nightly-selection.txt @@ -0,0 +1 @@ +sha256=9b9bc336b43b70d0e06e0adb5455bf035bb18945d85d60936eb6fe4d48e0e680 diff --git a/.config/e2e-protocols-selection.txt b/.config/e2e-protocols-selection.txt new file mode 100644 index 000000000..b0c07f708 --- /dev/null +++ b/.config/e2e-protocols-selection.txt @@ -0,0 +1,2 @@ +sha256-darwin=55534a97fbd376f64c8f6c341d319017d11ff77cad6da8629a1a7f6a874e0315 +sha256-linux=c06fb8c19aed6f388b9dc61cb8251b7a44f8561a9bf764ad2b9e635598f8dc17 diff --git a/.config/e2e-repl-nightly-selection.txt b/.config/e2e-repl-nightly-selection.txt new file mode 100644 index 000000000..d78fd611b --- /dev/null +++ b/.config/e2e-repl-nightly-selection.txt @@ -0,0 +1 @@ +sha256=655a3f3c1d042e694339d15caba7580518320322d1bac0f09450b37e6c09e2e7 diff --git a/.config/e2e-smoke-selection.txt b/.config/e2e-smoke-selection.txt new file mode 100644 index 000000000..7ca219cf1 --- /dev/null +++ b/.config/e2e-smoke-selection.txt @@ -0,0 +1 @@ +sha256=ec27cde6ce6400723c4b372bfbd2ac61709c744294e4810af765e8a808d8e31d diff --git a/.config/make/lint-fmt.mak b/.config/make/lint-fmt.mak index 55ed1efc6..dda47ae88 100644 --- a/.config/make/lint-fmt.mak +++ b/.config/make/lint-fmt.mak @@ -75,6 +75,11 @@ embedded-secrets-check: ## Check no private key material or credential literal i @echo "🔑 Checking embedded secret material guard..." ./scripts/check_embedded_secrets.sh +.PHONY: test-wiring-check +test-wiring-check: ## Check tests stay registered and selected by their intended runners + @echo "🧪 Checking test wiring..." + python3 ./scripts/check_test_wiring.py + .PHONY: log-analyzer-rules-check log-analyzer-rules-check: core-deps ## Check log-analyzer rule anchors still exist verbatim in source @echo "🩺 Checking log-analyzer rule anchors..." diff --git a/.config/make/pre-commit.mak b/.config/make/pre-commit.mak index b4ba093b0..54b54e34c 100644 --- a/.config/make/pre-commit.mak +++ b/.config/make/pre-commit.mak @@ -19,13 +19,13 @@ planning-docs-check: ## Check that no planning-type documents are committed ./scripts/check_no_planning_docs.sh .PHONY: pre-commit -pre-commit: fmt-check unsafe-code-check architecture-migration-check logging-guardrails-check tokio-io-uring-check extension-schema-check body-cache-whitelist-check s3s-footprint-check fips-wording-check embedded-secrets-check doc-paths-check planning-docs-check quick-check ## Run fast pre-commit checks without clippy/full tests +pre-commit: fmt-check unsafe-code-check architecture-migration-check logging-guardrails-check tokio-io-uring-check extension-schema-check body-cache-whitelist-check s3s-footprint-check fips-wording-check embedded-secrets-check test-wiring-check doc-paths-check planning-docs-check quick-check ## Run fast pre-commit checks without clippy/full tests @echo "✅ All pre-commit checks passed!" .PHONY: pre-pr -pre-pr: fmt-check unsafe-code-check architecture-migration-check logging-guardrails-check tokio-io-uring-check extension-schema-check body-cache-whitelist-check s3s-footprint-check fips-wording-check embedded-secrets-check doc-paths-check planning-docs-check log-analyzer-rules-check clippy-check test ## Run full pre-PR checks with clippy and tests +pre-pr: fmt-check unsafe-code-check architecture-migration-check logging-guardrails-check tokio-io-uring-check extension-schema-check body-cache-whitelist-check s3s-footprint-check fips-wording-check embedded-secrets-check test-wiring-check doc-paths-check planning-docs-check log-analyzer-rules-check clippy-check test ## Run full pre-PR checks with clippy and tests @echo "✅ All pre-PR checks passed!" .PHONY: dev-check -dev-check: fmt-check unsafe-code-check architecture-migration-check logging-guardrails-check tokio-io-uring-check extension-schema-check body-cache-whitelist-check s3s-footprint-check fips-wording-check embedded-secrets-check doc-paths-check planning-docs-check quick-check ## Run fast local development checks +dev-check: fmt-check unsafe-code-check architecture-migration-check logging-guardrails-check tokio-io-uring-check extension-schema-check body-cache-whitelist-check s3s-footprint-check fips-wording-check embedded-secrets-check test-wiring-check doc-paths-check planning-docs-check quick-check ## Run fast local development checks @echo "✅ Fast development checks passed!" diff --git a/.config/make/tests.mak b/.config/make/tests.mak index 937a22aca..1dec7db3e 100644 --- a/.config/make/tests.mak +++ b/.config/make/tests.mak @@ -35,6 +35,8 @@ script-tests: ## Run shell script tests ./scripts/test_pinned_paired_abba_bench.sh ./scripts/test_manual_transition_runbooks.sh ./scripts/check_embedded_secrets.sh --self-test + python3 ./scripts/check_test_wiring.py --self-test + python3 ./scripts/s3-tests/test_report_compat.py bash -n ./scripts/validate_object_data_cache_cold_stampede.sh python3 ./scripts/check_object_data_cache_follower_samples.py --self-test ./scripts/validate_object_data_cache_cold_stampede.sh --self-test diff --git a/.config/nextest.toml b/.config/nextest.toml index 4dd2d1d0e..097c79e3e 100644 --- a/.config/nextest.toml +++ b/.config/nextest.toml @@ -38,10 +38,11 @@ e2e-vault = { max-threads = 1 } # replacement_privileged_e2e_test when explicitly run as root on Linux). They # are correct in isolation but resource-heavy; serialize them under nextest's # process boundary (serial_test's #[serial] does not cross it) so several 4-disk -# servers never run at once. ci-7's nightly picks these up via the e2e suite; +# servers never run at once. The e2e-full merge/main lane picks these up; # they are deliberately NOT in the fast PR `e2e-smoke` filter. e2e-reliability = { max-threads = 1 } e2e-inline-boundaries = { max-threads = 1 } +e2e-cluster-nightly = { max-threads = 1 } # --- default profile (local): serialize the flaky groups, never retry -------- [[profile.default.overrides]] @@ -161,7 +162,7 @@ retries = 2 # Serialize the 4-disk reliability / degraded-read e2e tests under the ci # profile too (see the e2e-reliability test-group note near the top). Not a # quarantine: no retries, just single-threaded so several 4-disk servers never -# run concurrently when ci-7's nightly runs the full e2e suite. +# run concurrently when e2e-full runs the suite. [[profile.ci.overrides]] filter = 'package(e2e_test) & test(/^(reliability_disk_fault|degraded_read_eof_regression|replacement_privileged_e2e)_test::/)' test-group = 'e2e-reliability' @@ -230,8 +231,8 @@ test-group = 'ecstore-serial-flaky' # the nightly profile derives its set as "the replication module MINUS this # allowlist", so any new replication test lands in nightly by default (never # silently unrun) until it is explicitly blessed as fast here. Keep the two -# regexes byte-identical. Count invariant: 20 here + 49 nightly = 69 total -# (authority: `cargo nextest list`; docs/testing/e2e-suite-inventory.md). +# regexes byte-identical. The committed profile selection digests make changes +# visible in CI; current counts live in docs/testing/e2e-suite-inventory.md. # HISTORY (2026-07-11): the 20 fast tests were briefly pulled out of this lane # (#4724) because they set a loopback (127.0.0.1) replication target that the # SSRF egress guard rejected on every PR after repl-1 (#4712). That is fixed — @@ -327,9 +328,8 @@ slow-timeout = { period = "60s", terminate-after = 2, grace-period = "10s" } # the STS dual-node test actually exercises its path (it skips gracefully with # a visible log line when awscurl is absent), and routes scheduled failures # through .github/actions/schedule-failure-issue (ci-8). Explicit division of -# labor with ci-5's future e2e-full merge gate: these tests run ONLY here, not -# double-run there. TODO(ci-7): fold this interim repl-owned lane into the ci -# domain's consolidated scheduled e2e workflow once it exists. +# labor with e2e-full: these tests run only in the consolidated nightly +# workflow, not in the merge/main lane. [profile.e2e-repl-nightly] default-filter = """ package(e2e_test) @@ -343,26 +343,60 @@ fail-fast = false # workflow as the failure-triage artifact. path = "junit.xml" +# --------------------------------------------------------------------------- +# e2e-nightly profile — destructive multi-process cluster fault domains +# --------------------------------------------------------------------------- +# These seven modules are deliberately outside e2e-full's merge budget. Each +# starts a real multi-process or multi-disk topology and exercises node/disk +# loss, quorum, cleanup, notification fan-in, or admin-timeout behavior. The +# consolidated nightly workflow runs them serially to avoid resource +# starvation; failures are never retried. +[profile.e2e-nightly] +default-filter = """ + package(e2e_test) + & test(/^(admin_timeout_regression_test|cluster_concurrency_test|cluster_multidrive_pool_test|heal_erasure_disk_rebuild_test|namespace_lock_quorum_test|object_lambda_test|stale_multipart_cleanup_cluster_test)::/) +""" +fail-fast = false + +[profile.e2e-nightly.junit] +path = "junit.xml" + +[[profile.e2e-nightly.overrides]] +filter = 'package(e2e_test)' +test-group = 'e2e-cluster-nightly' + +# --------------------------------------------------------------------------- +# e2e-protocols profile — serial protocol lane +# --------------------------------------------------------------------------- +# The suite owns fixed ports, so the nightly workflow runs this exact profile +# with one nextest worker. +[profile.e2e-protocols] +default-filter = 'package(e2e_test) & test(/^protocols::/)' +fail-fast = false + +[profile.e2e-protocols.junit] +path = "junit.xml" + # --------------------------------------------------------------------------- # e2e-full profile — merge-gate full single-node e2e lane (backlog#1149 ci-5) # --------------------------------------------------------------------------- # The merge gate (ci.yml `e2e-full` job: push main + merge_group + -# workflow_dispatch). Runs the never-automated user-visible suites — KMS (40), -# object_lock (33), multipart_auth (109), quota, checksum, encryption, +# workflow_dispatch). Runs the user-visible KMS, object-lock, multipart-auth, +# quota, checksum, encryption, # security-boundary, ... — that the fast PR `e2e-smoke` subset deliberately # skips. Budget <= 45 min; authority for the suite count is `cargo nextest list # --profile e2e-full` (see docs/testing/e2e-suite-inventory.md). # # The filter is "the whole e2e_test crate MINUS the sets owned by other lanes": -# * protocols:: — FTPS/SFTP/WebDAV, still pinned to --test-threads=1 by fixed -# ports; they join a scheduled lane once ci-6 randomises the ports (ci-7). +# * protocols:: — FTPS/SFTP/WebDAV, run from the dedicated protocol profile +# with one worker because the suite owns fixed ports. # * the 7 cluster suites that spin up a RustFSTestClusterEnvironment # (cluster_concurrency, cluster_multidrive_pool, stale_multipart_cleanup_cluster, # namespace_lock_quorum, heal_erasure_disk_rebuild, admin_timeout_regression, -# object_lambda) — too heavy for the merge budget; they run in ci-7's -# nightly 4-node lane. +# object_lambda) — too heavy for the merge budget; they run in the +# e2e-nightly serial cluster-fault lane. # * replication_extension_test — repl-1 already splits it into the PR -# `e2e-smoke` (20 fast) and `e2e-repl-nightly` (49 slow) lanes and reserves +# `e2e-smoke` (20 fast) and `e2e-repl-nightly` (55 slow) lanes and reserves # it for those, so e2e-full does not double-run it. # * #[ignore]d tests — nextest skips them by default (no --run-ignored); the # manual-localhost:9000 reliant/policy tests are ci-13's migration. diff --git a/.github/s3tests/README.md b/.github/s3tests/README.md index 8f61534ec..0ca71309d 100644 --- a/.github/s3tests/README.md +++ b/.github/s3tests/README.md @@ -46,10 +46,9 @@ lists when upstream changes. the PR. - **Weekly + manual**: `.github/workflows/e2e-s3tests.yml` runs the full upstream suite (`TEST_SCOPE=all`) against a Docker deployment (single node - or a 4-node distributed cluster behind HAProxy). It fails only on - regressions in the implemented whitelist and publishes a classification - report (`compat-report.md`, also shown in the job summary) listing promotion - candidates and unclassified tests. + or a 4-node distributed cluster behind HAProxy). The canonical gate policy + and compatibility-report behavior are documented in + [`scripts/s3-tests/README.md`](../../scripts/s3-tests/README.md). ## Running Tests Locally diff --git a/.github/workflows/ci-docs-only.yml b/.github/workflows/ci-docs-only.yml index 89ae4d18f..85ce9b32f 100644 --- a/.github/workflows/ci-docs-only.yml +++ b/.github/workflows/ci-docs-only.yml @@ -125,6 +125,9 @@ jobs: - name: Check no embedded secret material run: ./scripts/check_embedded_secrets.sh + - name: Check test wiring + run: python3 ./scripts/check_test_wiring.py + - name: Check no planning docs committed run: ./scripts/check_no_planning_docs.sh diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 4812b118f..6a0d29604 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -160,6 +160,9 @@ jobs: - name: Check no embedded secret material run: ./scripts/check_embedded_secrets.sh + - name: Check test wiring + run: python3 ./scripts/check_test_wiring.py + - name: Check no planning docs committed run: ./scripts/check_no_planning_docs.sh @@ -686,9 +689,9 @@ jobs: - name: Make binary executable run: chmod +x ./target/debug/rustfs - # Build the e2e test graph once. The archive is reused by the security - # count-floor check and the smoke run below, avoiding a second compile of - # the same e2e_test target on cold runners (backlog#1645). + # Build the e2e test graph once. The archive is reused by the smoke + # selection guard, security exact-count check, and run below, avoiding a + # second compile of the same e2e_test target on cold runners (backlog#1645). - name: Archive e2e smoke test binaries env: NEXTEST_ARCHIVE: ${{ runner.temp }}/rustfs-e2e-smoke.tar.zst @@ -696,6 +699,7 @@ jobs: run: | cargo nextest archive --profile e2e-smoke -p e2e_test --archive-file "${NEXTEST_ARCHIVE}" cargo nextest list --profile e2e-smoke --archive-file "${NEXTEST_ARCHIVE}" --message-format json > "${NEXTEST_LISTING}" + python3 ./scripts/check_test_wiring.py --check-profile e2e-smoke "${NEXTEST_LISTING}" ./scripts/check_security_smoke_count.sh check "${NEXTEST_LISTING}" # PR smoke subset of the in-repo e2e suite (backlog#1149 ci-4). The @@ -760,7 +764,7 @@ jobs: # suites — KMS, object_lock, multipart_auth, quota, checksum, encryption, # security-boundary, ... — via the e2e-full nextest profile. Too heavy for # every PR, so it is gated to main pushes, the merge queue, and manual - # dispatch. protocols / the 6 cluster suites / replication / #[ignore] are + # dispatch. protocols / the 7 cluster suites / replication / #[ignore] are # owned by other lanes (see .config/nextest.toml profile.e2e-full). if: >- github.event_name == 'workflow_dispatch' || @@ -820,6 +824,13 @@ jobs: - name: Make binary executable run: chmod +x ./target/debug/rustfs + - name: Verify e2e full membership + env: + NEXTEST_LISTING: ${{ runner.temp }}/rustfs-e2e-full-list.json + run: | + cargo nextest list --profile e2e-full -p e2e_test --message-format json > "${NEXTEST_LISTING}" + python3 ./scripts/check_test_wiring.py --check-profile e2e-full "${NEXTEST_LISTING}" + # Full single-node e2e lane (backlog#1149 ci-5). The e2e-full # default-filter in .config/nextest.toml is the single wiring mechanism — # extend that filter, never add ad-hoc e2e jobs here. Reuses the downloaded @@ -832,7 +843,9 @@ jobs: uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6 with: name: e2e-full-junit-${{ github.run_number }} - path: target/nextest/e2e-full/junit.xml + path: | + target/nextest/e2e-full/junit.xml + ${{ runner.temp }}/rustfs-e2e-full-list.json retention-days: 7 e2e-tests-rio-v2: diff --git a/.github/workflows/e2e-replication-nightly.yml b/.github/workflows/e2e-replication-nightly.yml index 2dde9f2b3..837d9f79f 100644 --- a/.github/workflows/e2e-replication-nightly.yml +++ b/.github/workflows/e2e-replication-nightly.yml @@ -12,7 +12,7 @@ # See the License for the specific language governing permissions and # limitations under the License. -# Nightly full replication e2e lane (backlog#1147 repl-1, deps: ci-4). +# Consolidated nightly e2e lane for replication, cluster faults, and protocols. # # The per-PR gate (ci.yml `e2e-tests` job, `--profile e2e-smoke`) runs the # FAST replication tests. This scheduled lane runs the remaining heavier @@ -28,15 +28,12 @@ # add ad-hoc cargo-test steps here; change the filterset instead. The # authoritative membership and count come from # `cargo nextest list -p e2e_test --profile e2e-repl-nightly`; the PR/nightly -# count invariant is maintained next to the filtersets in .config/nextest.toml -# (deliberately not duplicated here). +# selection digest is committed under .config/. # -# Explicit division of labor: the nightly subset runs ONLY here, never double-run -# in ci-5's future e2e-full merge gate. TODO(ci-7): once the ci domain's -# consolidated scheduled e2e workflow exists, fold this interim repl-owned lane -# into it rather than growing a second scheduled entrypoint. +# Explicit division of labor: these subsets run only here and never double-run +# in the e2e-full merge gate. -name: e2e-replication-nightly +name: e2e-nightly on: workflow_dispatch: @@ -50,6 +47,10 @@ on: permissions: contents: read +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: false + jobs: repl-nightly: name: Replication e2e (nightly) @@ -97,9 +98,20 @@ jobs: # demand otherwise, but a single explicit build avoids several parallel # nextest test processes racing to build it at once. - name: Build rustfs binary - run: cargo build -p rustfs --bins + run: | + cargo build -p rustfs --bins + : > target/debug/rustfs.features + + - name: Verify replication e2e membership + env: + NEXTEST_LISTING: ${{ runner.temp }}/rustfs-e2e-repl-nightly-list.json + run: | + cargo nextest list --profile e2e-repl-nightly -p e2e_test --message-format json > "${NEXTEST_LISTING}" + python3 ./scripts/check_test_wiring.py --check-profile e2e-repl-nightly "${NEXTEST_LISTING}" - name: Run replication e2e nightly suite + env: + RUSTFS_E2E_LOG_DIR: ${{ runner.temp }}/rustfs-e2e-repl-nightly-logs run: cargo nextest run --profile e2e-repl-nightly -p e2e_test - name: Upload nextest junit report @@ -107,13 +119,112 @@ jobs: uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6 with: name: e2e-replication-nightly-junit-${{ github.run_number }} - path: target/nextest/e2e-repl-nightly/junit.xml + path: | + target/nextest/e2e-repl-nightly/junit.xml + ${{ runner.temp }}/rustfs-e2e-repl-nightly-list.json + ${{ runner.temp }}/rustfs-e2e-repl-nightly-logs/ retention-days: 7 if-no-files-found: ignore + cluster-nightly: + name: Cluster fault e2e (nightly) + runs-on: sm-standard-4 + timeout-minutes: 90 + env: + FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: "true" + steps: + - name: Checkout repository + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 + with: + persist-credentials: false + + - name: Setup Rust environment + uses: ./.github/actions/setup + with: + rust-version: stable + cache-shared-key: ci-e2e-nightly + cache-save-if: 'false' + install-build-packaging-tools: 'false' + + - name: Build rustfs binary + run: | + cargo build -p rustfs --bins --features e2e-test-hooks + : > target/debug/rustfs.features + + - name: Verify cluster fault e2e membership + env: + NEXTEST_LISTING: ${{ runner.temp }}/rustfs-e2e-nightly-list.json + run: | + cargo nextest list --profile e2e-nightly -p e2e_test --message-format json > "${NEXTEST_LISTING}" + python3 ./scripts/check_test_wiring.py --check-profile e2e-nightly "${NEXTEST_LISTING}" + + - name: Run cluster fault e2e nightly suite + env: + RUSTFS_E2E_LOG_DIR: ${{ runner.temp }}/rustfs-e2e-nightly-logs + run: cargo nextest run --profile e2e-nightly -p e2e_test + + - name: Upload cluster fault diagnostics + if: always() + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6 + with: + name: e2e-cluster-nightly-${{ github.run_number }} + path: | + target/nextest/e2e-nightly/junit.xml + ${{ runner.temp }}/rustfs-e2e-nightly-list.json + ${{ runner.temp }}/rustfs-e2e-nightly-logs/ + retention-days: 7 + if-no-files-found: warn + + protocols-nightly: + name: Protocol e2e (nightly) + runs-on: sm-standard-4 + timeout-minutes: 90 + env: + FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: "true" + RUSTFS_BUILD_FEATURES: ftps,webdav,sftp + steps: + - name: Checkout repository + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 + with: + persist-credentials: false + + - name: Setup Rust environment + uses: ./.github/actions/setup + with: + rust-version: stable + cache-shared-key: ci-e2e-protocols + cache-save-if: 'false' + install-build-packaging-tools: 'false' + + # The suite owns fixed protocol ports and serializes its internal cases. + - name: Verify protocol e2e membership + env: + NEXTEST_LISTING: ${{ runner.temp }}/rustfs-e2e-protocols-list.json + run: | + cargo nextest list --profile e2e-protocols -p e2e_test --message-format json > "${NEXTEST_LISTING}" + python3 ./scripts/check_test_wiring.py --check-profile e2e-protocols "${NEXTEST_LISTING}" + + - name: Run protocol e2e nightly suite + env: + RUSTFS_E2E_LOG_DIR: ${{ runner.temp }}/rustfs-protocol-e2e-logs + run: >- + cargo nextest run -j 1 --profile e2e-protocols -p e2e_test --no-capture + + - name: Upload protocol diagnostics + if: always() + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6 + with: + name: e2e-protocol-nightly-${{ github.run_number }} + path: | + target/nextest/e2e-protocols/junit.xml + ${{ runner.temp }}/rustfs-e2e-protocols-list.json + ${{ runner.temp }}/rustfs-protocol-e2e-logs/ + retention-days: 7 + if-no-files-found: warn + alert-on-failure: name: Alert on scheduled failure - needs: [repl-nightly] + needs: [repl-nightly, cluster-nightly, protocols-nightly] # Only scheduled runs open/append the tracking issue (backlog#1149 ci-8); # manual workflow_dispatch runs stay quiet so a debugging run never files a # spurious alert. diff --git a/.github/workflows/e2e-s3tests.yml b/.github/workflows/e2e-s3tests.yml index f8eeaec10..1e3ad90b6 100644 --- a/.github/workflows/e2e-s3tests.yml +++ b/.github/workflows/e2e-s3tests.yml @@ -18,10 +18,9 @@ # runs only the implemented_tests.txt whitelist. This workflow complements it: # # - Scheduled weekly full sweep (TEST_SCOPE=all): runs the ENTIRE upstream -# suite and reports promotion candidates (tests that newly pass) and -# unclassified tests. The job fails only on regressions in the implemented -# whitelist or on infrastructure errors — expected failures from -# not-yet-implemented features do not turn the run red. +# suite and reports promotion candidates. Regressions, unclassified tests, +# incomplete execution, and infrastructure errors fail the job; classified +# failures for not-yet-implemented features remain informational. # - Manual runs (workflow_dispatch): same, with configurable mode/scope. # # All test execution is delegated to scripts/s3-tests/run.sh (single source of @@ -45,13 +44,6 @@ # The PR gate (ci.yml s3-implemented-tests) is unaffected: it avoids Docker # via DEPLOY_MODE=binary and defers all pip setup to run.sh's self-bootstrap. -# DISABLED. This workflow is switched off in the repository's Actions settings -# (state: disabled_manually) and does not run on any trigger, including its cron -# and workflow_dispatch. That state lives in GitHub's UI and is invisible when -# reading this file, which has already misled at least one audit — hence this -# banner. Re-enabling is a UI action; anyone doing so should first check that the -# workflow still matches the current CI layout. See rustfs/backlog#1603. -# name: e2e-s3tests on: @@ -81,6 +73,19 @@ on: description: "Stop after N failures. '0' to run everything." required: false default: "0" + shard-count: + description: "Exact-node-ID shard count for a targeted manual run" + required: false + default: "1" + type: choice + options: + - "1" + - "2" + - "4" + shard-index: + description: "Zero-based shard index for a targeted manual run" + required: false + default: "0" markexpr: description: "Optional pytest -m expression" required: false @@ -111,6 +116,8 @@ env: XDIST: ${{ github.event.inputs.xdist || '4' }} MAXFAIL: ${{ github.event.inputs.maxfail || '0' }} MARKEXPR: ${{ github.event.inputs.markexpr || '' }} + S3_SHARD_COUNT: ${{ github.event_name == 'schedule' && '4' || github.event.inputs.shard-count || '1' }} + TEST_TIMEOUT: "300" concurrency: group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event.inputs['test-mode'] || 'single' }} @@ -127,19 +134,22 @@ defaults: jobs: s3tests: + name: s3tests (${{ matrix.test-mode }}, shard ${{ matrix.shard-index }}) # GitHub-hosted: reliably provides Docker + docker compose + python3/pip. # See the header note (ci-1) for why the self-hosted sm-standard-4 label - # was abandoned. TODO(ci-8): scheduled-failure alerting (auto-open issue) - # is added by the ci-8 composite action; do not implement it here. + # was abandoned. Scheduled failures are handled by alert-on-failure below. runs-on: ubuntu-latest timeout-minutes: 180 strategy: fail-fast: false + max-parallel: 2 matrix: # Scheduled sweeps cover both topologies; manual runs use the input. test-mode: ${{ github.event_name == 'schedule' && fromJSON('["single", "multi"]') || fromJSON(format('["{0}"]', github.event.inputs.test-mode || 'single')) }} + shard-index: ${{ github.event_name == 'schedule' && fromJSON('[0, 1, 2, 3]') || fromJSON(format('[{0}]', github.event.inputs.shard-index || '0')) }} env: TEST_MODE: ${{ matrix.test-mode }} + S3_SHARD_INDEX: ${{ matrix.shard-index }} steps: - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7 with: @@ -181,6 +191,7 @@ jobs: - name: Start single RustFS if: env.TEST_MODE == 'single' run: | + SSE_KEY="$(head -c 32 /dev/zero | base64 -w0)" docker network inspect rustfs-net >/dev/null 2>&1 || docker network create rustfs-net docker rm -f rustfs-single >/dev/null 2>&1 || true # The four disks share one physical device on the runner (a single @@ -193,6 +204,7 @@ jobs: -e RUSTFS_ADDRESS=0.0.0.0:9000 \ -e RUSTFS_ACCESS_KEY="${S3_ACCESS_KEY}" \ -e RUSTFS_SECRET_KEY="${S3_SECRET_KEY}" \ + -e RUSTFS_SSE_S3_MASTER_KEY="${SSE_KEY}" \ -e RUSTFS_VOLUMES="/data/rustfs{0...3}" \ -e RUSTFS_UNSAFE_BYPASS_DISK_CHECK=true \ -v /tmp/rustfs-single:/data \ @@ -201,6 +213,7 @@ jobs: - name: Start 4-node distributed cluster if: env.TEST_MODE == 'multi' run: | + SSE_KEY="$(head -c 32 /dev/zero | base64 -w0)" # A real distributed deployment: every node lists all endpoints in # RUSTFS_VOLUMES so data is erasure-coded ACROSS nodes. Do not use # node-local volume paths here — that would create four independent @@ -213,6 +226,7 @@ jobs: RUSTFS_ADDRESS: "0.0.0.0:9000" RUSTFS_ACCESS_KEY: ${S3_ACCESS_KEY} RUSTFS_SECRET_KEY: ${S3_SECRET_KEY} + RUSTFS_SSE_S3_MASTER_KEY: "${SSE_KEY}" RUSTFS_VOLUMES: "http://rustfs{1...4}:9000/data/rustfs{0...3}" # Each node's four disks share one physical device inside its # container, so bypass the local physical-disk-independence guard @@ -294,7 +308,6 @@ jobs: - name: Run ceph s3-tests run: | - set +e DEPLOY_MODE=existing \ TEST_MODE="${TEST_MODE}" \ TEST_SCOPE="${TEST_SCOPE}" \ @@ -302,26 +315,6 @@ jobs: MAXFAIL="${MAXFAIL}" \ MARKEXPR="${MARKEXPR}" \ ./scripts/s3-tests/run.sh - RC=$? - set -e - - if [ "${TEST_SCOPE}" = "implemented" ]; then - # Whitelist run: every failure is a regression. - exit "${RC}" - fi - - # Full sweep: failures outside the implemented whitelist are - # inventory (promotion candidates / unimplemented features), not a - # gate. Fail only on whitelist regressions or infrastructure errors. - JUNIT="artifacts/s3tests-${TEST_MODE}/junit.xml" - if [ ! -f "${JUNIT}" ]; then - echo "No junit.xml produced — infrastructure failure (exit ${RC})" >&2 - exit "${RC}" - fi - python3 scripts/s3-tests/report_compat.py \ - --junit "${JUNIT}" \ - --lists-dir scripts/s3-tests \ - --fail-on-regression - name: Publish compatibility report if: always() @@ -346,7 +339,7 @@ jobs: if: always() && env.ACT != 'true' uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6 with: - name: s3tests-${{ env.TEST_MODE }} + name: s3tests-${{ env.TEST_MODE }}-shard-${{ matrix.shard-index }} path: artifacts/** alert-on-failure: diff --git a/.github/workflows/fuzz.yml b/.github/workflows/fuzz.yml index f2967804f..d41a1107f 100644 --- a/.github/workflows/fuzz.yml +++ b/.github/workflows/fuzz.yml @@ -12,27 +12,22 @@ # See the License for the specific language governing permissions and # limitations under the License. -# DISABLED. This workflow is switched off in the repository's Actions settings -# (state: disabled_manually) and does not run on any trigger, including its cron -# and workflow_dispatch. That state lives in GitHub's UI and is invisible when -# reading this file, which has already misled at least one audit — hence this -# banner. Re-enabling is a UI action; anyone doing so should first check that the -# workflow still matches the current CI layout. See rustfs/backlog#1603. -# name: Fuzz on: pull_request: types: [ opened, synchronize, reopened, closed ] - # PR trigger is intentionally narrow: only changes to the fuzz harness - # itself gate a PR. Broad crate paths (ecstore/filemeta/utils/policy/…) - # are covered by the nightly `schedule` run below, which fuzzes against - # whatever landed on main. Widening these paths previously queued a - # ~45min fuzz-build on nearly every PR and is why this workflow was - # disabled; do not re-add crate paths here. + # Run when the harness or any directly fuzzed production crate changes. paths: - "fuzz/**" - "scripts/fuzz/**" + - "crates/ecstore/**" + - "crates/filemeta/**" + - "crates/policy/**" + - "crates/security-governance/**" + - "crates/utils/**" + - "Cargo.toml" + - "Cargo.lock" - ".github/workflows/fuzz.yml" schedule: - cron: "0 2 * * *" @@ -81,7 +76,7 @@ jobs: github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' runs-on: sm-standard-4 - timeout-minutes: 45 + timeout-minutes: 60 env: FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: "true" steps: @@ -121,12 +116,7 @@ jobs: uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6 with: name: fuzz-prebuilt-binaries-${{ github.run_number }} - path: | - fuzz/prebuilt/${{ env.CARGO_BUILD_TARGET }}/release/archive_extract - fuzz/prebuilt/${{ env.CARGO_BUILD_TARGET }}/release/bucket_validation - fuzz/prebuilt/${{ env.CARGO_BUILD_TARGET }}/release/local_metadata - fuzz/prebuilt/${{ env.CARGO_BUILD_TARGET }}/release/path_containment - fuzz/prebuilt/${{ env.CARGO_BUILD_TARGET }}/release/policy_ingress + path: fuzz/prebuilt/${{ env.CARGO_BUILD_TARGET }}/release/ if-no-files-found: error retention-days: 1 compression-level: 0 @@ -192,10 +182,7 @@ jobs: nightly-fuzz-corpus: name: "Nightly / ${{ matrix.target }}" needs: fuzz-build - # TODO(ci-8): when the schedule-failure-issue composite action lands, - # add a step here (or a dependent job) that opens/updates a GitHub issue - # on nightly failure. ci-8 is the single alerting mechanism for all - # scheduled workflows; do not self-roll alerting in this workflow. + # Scheduled failures are handled by alert-on-failure below. if: > github.event_name == 'schedule' || (github.event_name == 'workflow_dispatch' && diff --git a/crates/e2e_test/README.md b/crates/e2e_test/README.md index a48ff6434..24567ac6f 100644 --- a/crates/e2e_test/README.md +++ b/crates/e2e_test/README.md @@ -48,16 +48,14 @@ cargo nextest run --profile e2e-smoke -p e2e_test cargo nextest run -j1 --run-ignored ignored-only -p rustfs-scanner -p rustfs \ -E 'binary(lifecycle_integration_test) or (package(rustfs) and test(lifecycle_transition_api_test))' -# Protocols suite — fixed ports, MUST be single-threaded, gated by build features -RUSTFS_BUILD_FEATURES=ftps,webdav,sftp \ - cargo test -p e2e_test test_protocol_core_suite -- --test-threads=1 --nocapture ``` The protocols suite has its own contract (fixed bind ports 9022–9301, -`--test-threads=1`, feature-gated scheduling) documented in +single-worker execution, feature-gated scheduling) documented in [`src/protocols/README.md`](src/protocols/README.md). `RUSTFS_BUILD_FEATURES` selects which features the spawned binary is built with; leave it unset to run -every protocol entry. +every protocol entry. Use the exact profile command under +[Troubleshooting](#troubleshooting) for CI-equivalent execution. ### `#[ignore]` semantics @@ -159,27 +157,26 @@ construction (random port + isolated temp dir) and need no serialization. ## CI map `e2e_test` is **excluded** from the main `cargo nextest run --profile ci --all` -pass ([`.github/workflows/ci.yml`](../../.github/workflows/ci.yml) line 158, -`--exclude e2e_test`) — the whole crate is too slow to gate every PR. Subsets -join CI through the nextest profile system only (never as ad-hoc jobs): +pass (`--exclude e2e_test`) — the whole crate is too slow to gate every PR. +Subsets join CI through nextest profiles; the fixed-port protocol suite uses +the same profile for membership and execution with one nightly worker. | Suite | Runs where | Status | | --- | --- | --- | | Smoke subset (`e2e-smoke` profile) | `e2e-tests` job, every PR | **Active** (backlog#1149 ci-4) | +| Full single-node suite (`e2e-full` profile) | `e2e-full` job, merge queue + main | **Active** (backlog#1149 ci-5) | | `s3s-e2e` black-box | `e2e-tests` + `e2e-tests-rio-v2` jobs | **Active** (external conformance tool) | | ILM / lifecycle (ignored) | `test-ilm-integration-serial` lane, `-j1` | **Active** (backlog#1148 ilm-1) | -| KMS suite | — | Not in CI yet (backlog#1149 ci-5) | -| Protocols (FTPS/WebDAV/SFTP) | — | Not in CI yet (backlog#1149 ci-7) | +| KMS suite | `e2e-full` job, merge queue + main | **Active** | +| Cluster faults (`e2e-nightly` profile) | consolidated nightly workflow | **Active** (backlog#1149 ci-7) | +| Protocols (FTPS/WebDAV/SFTP) | consolidated nightly workflow, serial | **Active** (backlog#1149 ci-7) | | Replication (fast subset) | `e2e-smoke` profile, `e2e-tests` job, every PR | **Active** (backlog#1147 repl-1) | -| Replication (slow + dual-node) | `e2e-repl-nightly` profile, scheduled workflow | **Active** (backlog#1147 repl-1) | -| `reliant/*` (pre-started server) | — | Manual only | +| Replication (slow + multi-node) | `e2e-repl-nightly` profile, consolidated nightly workflow | **Active** (backlog#1147 repl-1) | +| `reliant/*` | 19 tests in PR smoke; remaining default tests in `e2e-full` | **Active** except `#[ignore]` | -Links: [`ci.yml`](../../.github/workflows/ci.yml) `e2e-tests` (line 347), -`test-ilm-integration-serial` (line 196). The `e2e-smoke` `default-filter` in -[`.config/nextest.toml`](../../.config/nextest.toml) is the **single wiring -mechanism** — extend that filter (or add a sibling profile) to admit more -tests; do not add e2e jobs to `ci.yml`. repl-1 / ilm-3 are landing in parallel -and may add lanes; keep the table above easy to extend. +The profile filters in [`.config/nextest.toml`](../../.config/nextest.toml) are +the wiring source of truth. Committed test-ID digests under +`.config/e2e-*-selection.txt` make every membership change explicit. ## Troubleshooting @@ -188,9 +185,15 @@ and may add lanes; keep the table above easy to extend. ```bash # Smoke (e2e-tests job) — includes the 20 fast replication tests cargo nextest run --profile e2e-smoke -p e2e_test -# Replication nightly lane (16 slow + dual-node tests; install awscurl for the -# STS dual-node test, else it skips gracefully) +# Full single-node merge/main lane +cargo nextest run --profile e2e-full -p e2e_test +# Cluster fault nightly lane +cargo nextest run --profile e2e-nightly -p e2e_test +# Replication nightly lane; install awscurl so STS paths do not skip cargo nextest run --profile e2e-repl-nightly -p e2e_test +# Fixed-port protocol nightly lane +RUSTFS_BUILD_FEATURES=ftps,webdav,sftp \ + cargo nextest run -j 1 --profile e2e-protocols -p e2e_test --no-capture # ILM serial lane cargo nextest run -j1 --run-ignored ignored-only -p rustfs-scanner -p rustfs \ -E 'binary(lifecycle_integration_test) or (package(rustfs) and test(lifecycle_transition_api_test))' @@ -273,4 +276,6 @@ current subset is. `docs/testing/e2e-suite-inventory.md` records the per-module test counts as listed by `cargo nextest list -p e2e_test`. Regenerate it when adding or moving e2e tests so acceptance numbers in the test-strategy issues -(backlog#1147–#1155) stay auditable. +(backlog#1147–#1155) stay auditable. When a profile membership change is +intentional, review its JSON listing before updating the matching +`.config/e2e-*-selection.txt` test-ID digest. diff --git a/crates/e2e_test/src/protocols/README.md b/crates/e2e_test/src/protocols/README.md index 0ecd3fad6..0cbb222b1 100644 --- a/crates/e2e_test/src/protocols/README.md +++ b/crates/e2e_test/src/protocols/README.md @@ -11,10 +11,17 @@ test process directly. ## Running Tests +Use the canonical CI-equivalent protocol command in the parent +[`e2e_test` README](../../README.md#troubleshooting). + +For targeted debugging of the core suite only: + ```bash RUSTFS_BUILD_FEATURES=ftps,webdav,sftp cargo test --package e2e_test test_protocol_core_suite -- --test-threads=1 --nocapture ``` +This targeted command does not cover the full `e2e-protocols` profile. + `RUSTFS_BUILD_FEATURES` controls which features the test rustfs binary is built with. When this variable is set, the protocol test runner schedules only entries whose protocol is present in the requested feature list. Leave @@ -133,4 +140,3 @@ property without consulting any external doc. Bind ports 9023 (SFTP) and 9100 (S3). Spawns rustfs with `RUSTFS_SFTP_IDLE_TIMEOUT=5`, sleeps 10 s past the timeout, then issues an SFTP request and asserts the server has closed the session. - diff --git a/crates/ecstore/src/set_disk/mod.rs b/crates/ecstore/src/set_disk/mod.rs index 5625d7583..cbf050a4b 100644 --- a/crates/ecstore/src/set_disk/mod.rs +++ b/crates/ecstore/src/set_disk/mod.rs @@ -922,14 +922,10 @@ mod prepared_get_object_metadata_tests { .expect("test should find an object whose initial fanout covers both data shards") } - #[allow( - dead_code, - reason = "test fixture no assertion in this module uses today; the live namesake lives in io_primitives tests (backlog#1823)" - )] - fn bounded_spare_disk_index(bucket: &str, object: &str) -> usize { + fn bounded_initial_parity_disk_index(bucket: &str, object: &str) -> usize { *bounded_metadata_fanout_order(bucket, object, 4, 2) - .get(3) - .expect("4-disk test geometry should leave one bounded spare disk") + .get(2) + .expect("4-disk test geometry should schedule one parity disk initially") } #[tokio::test] @@ -1087,7 +1083,7 @@ mod prepared_get_object_metadata_tests { ("RUSTFS_GET_METADATA_EARLY_STOP_BOUNDED_FANOUT", None::<&str>), ], async { - let slow_parity_disk = bounded_spare_disk_index(bucket, &object); + let slow_parity_disk = bounded_initial_parity_disk_index(bucket, &object); let barrier = rename_fanout_barrier::arm(&object, slow_parity_disk, rename_fanout_barrier::PHASE_READ_VERSION); let calls = disk_call_counters::observe(&object); diff --git a/crates/utils/src/net.rs b/crates/utils/src/net.rs index 3489ba41c..4fa656776 100644 --- a/crates/utils/src/net.rs +++ b/crates/utils/src/net.rs @@ -622,7 +622,8 @@ mod test { let _resolver_lock = DNS_RESOLVER_TEST_LOCK.lock().unwrap(); reset_dns_resolver_inner(); - let err = resolve_domain("rustfs-resolver-provenance.invalid").unwrap_err(); + // DNS labels are limited to 63 bytes, so the system resolver rejects this before lookup. + let err = resolve_domain("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.invalid").unwrap_err(); assert_ne!(err.kind(), std::io::ErrorKind::Other, "system resolver error was wrapped: {err}"); } diff --git a/docs/testing/e2e-suite-inventory.md b/docs/testing/e2e-suite-inventory.md index 0885c32e9..7d80a802d 100644 --- a/docs/testing/e2e-suite-inventory.md +++ b/docs/testing/e2e-suite-inventory.md @@ -5,12 +5,10 @@ > ```bash > cargo nextest list -p e2e_test --message-format json | jq -r '.["rust-suites"][]?.testcases | to_entries[] | select(.value.ignored == false) | .key | split("::")[0]' | sort | uniq -c > ``` -> Modules marked ✅ are in the PR smoke profile `e2e-smoke` -> (`.config/nextest.toml`); admission criteria: `crates/e2e_test/README.md`. -> 🌙 marks tests in the scheduled `e2e-repl-nightly` profile (backlog#1147 -> repl-1): `replication_extension_test` splits 20 fast tests into the PR smoke -> lane and 28 slow / `_real_dual_node` / `_real_three_node` / `_real_single_node` tests into the -> nightly lane (`.github/workflows/e2e-replication-nightly.yml`). +> Modules marked ✅ are in the PR smoke profile `e2e-smoke`; 🌙 marks the +> cluster, protocol, and replication subsets in the consolidated nightly +> workflow. The `e2e-full` merge/main profile covers the remaining default +> single-node tests. Committed test-ID digests are enforced before each run. > Note: counts exclude `#[ignore]`d tests (nextest lists them separately). > Managed-SSE (SSE-S3/SSE-KMS) replication contracts assert successful > re-encryption on the target (backlog#1783); SSE-C replication still pins a @@ -19,19 +17,21 @@ | module | tests | PR smoke | |---|---|---| | admin_auth_test | 4 | ✅ | -| admin_iam_crud_test | 2 | ✅ | +| admin_iam_crud_test | 3 | ✅ | | admin_pools_test | 1 | ✅ | -| admin_timeout_regression_test | 1 | | +| admin_timeout_regression_test | 1 | 🌙 | | anonymous_access_test | 4 | ✅ | | api_rate_limit_test | 3 | | | archive_download_integrity_test | 13 | | | bucket_logging_test | 3 | | | bucket_policy_check_test | 1 | ✅ | +| bucket_stats_regression_test | 3 | | +| chaos | 2 | | | checksum_upload_test | 7 | | -| cluster_concurrency_test | 2 | | -| cluster_multidrive_pool_test | 2 | | -| common | 12 | | -| compression_test | 1 | | +| cluster_concurrency_test | 2 | 🌙 | +| cluster_multidrive_pool_test | 2 | 🌙 | +| common | 14 | | +| compression_test | 6 | ✅ | | connection_cap_test | 2 | | | console_smoke_test | 1 | ✅ | | content_encoding_test | 3 | ✅ | @@ -45,48 +45,58 @@ | delete_marker_migration_semantics_test | 2 | ✅ | | delete_object_no_content_length_test | 1 | | | delete_objects_versioning_test | 2 | ✅ | +| delete_regression_test | 5 | | +| distributed_startup_regression_test | 3 | | | existing_object_tag_policy_test | 4 | | -| fake_s3_target | 4 | ✅ | +| fake_s3_target | 6 | ✅ | | fault_proxy | 7 | | | get_codec_streaming_compat_test | 1 | | +| get_stream_failure_observability_test | 1 | | +| group_delete_test | 1 | | | head_object_consistency_test | 1 | ✅ | | head_object_range_test | 1 | ✅ | -| heal_erasure_disk_rebuild_test | 3 | | -| inline_fast_path_cluster_test | 14 | | +| heal_erasure_disk_rebuild_test | 4 | 🌙 | +| inline_fast_path_cluster_test | 16 | | | internode_rpc_signature_e2e_test | 5 | | -| kms | 41 | | +| kms | 48 | | | leading_slash_key_test | 2 | ✅ | +| lifecycle_regression_test | 4 | | +| list_buckets_auth_test | 1 | ✅ | | list_buckets_double_slash_test | 3 | ✅ | +| list_buckets_iam_filter_test | 1 | ✅ | | list_object_versions_metadata_extension_test | 1 | | | list_object_versions_regression_test | 2 | ✅ | | list_objects_duplicates_test | 3 | ✅ | | list_objects_v2_metadata_extension_test | 1 | | | list_objects_v2_pagination_test | 12 | ✅ | +| listing_regression_test | 4 | | | mc_mirror_small_bucket_test | 1 | | | multipart_auth_test | 75 | | | multipart_storage_class_test | 3 | ✅ | -| namespace_lock_quorum_test | 2 | | +| namespace_lock_quorum_test | 2 | 🌙 | | negative_sigv4_test | 6 | ✅ | +| notification_startup_regression_test | 2 | | | notification_webhook_test | 3 | ✅ | -| object_lambda_test | 16 | | -| object_lock | 33 | | +| object_lambda_test | 16 | 🌙 | +| object_lock | 34 | | | overwrite_cleanup_regression_test | 1 | | | presigned_negative_test | 7 | ✅ | -| protocols | 16 | | +| protocols | 16 | 🌙 | | quota_test | 14 | | -| reliability_disk_fault_test | 3 | | -| reliant | 24 | 18 ✅ | -| replication_extension_test | 50 | 20 ✅ +30 🌙 | +| reliability_disk_fault_test | 4 | | +| reliant | 25 | 19 ✅ | +| replication_extension_test | 75 | 20 ✅ +55 🌙 | | security_boundary_test | 4 | | -| ssec_copy_test | 2 | ✅ | | server_startup_failfast_test | 1 | | | snowball_auto_extract_test | 6 | | | special_chars_test | 14 | ✅ | -| stale_multipart_cleanup_cluster_test | 1 | | +| ssec_copy_test | 2 | ✅ | +| stale_multipart_cleanup_cluster_test | 1 | 🌙 | | storage_class_capability_test | 4 | ✅ | -| sts_query_compat_test | 3 | ✅ | +| sts_query_compat_test | 6 | ✅ | +| tier_transition_regression_test | 3 | | | tls_gen | 3 | | | tls_hot_reload_test | 1 | ✅ | | version_id_regression_test | 10 | ✅ | -**Total listed: 530 tests across 70 modules · PR smoke subset: 148 tests / 33 modules** (31 full modules + 18 `reliant` tests + 20 of `replication_extension_test`) **· nightly `e2e-repl-nightly`: 30 tests** · updated 2026-08-09. +**Total listed: 577 tests across 82 modules · PR smoke: 163 tests / 36 modules · merge/main full: 455 tests / 73 modules · nightly replication: 55 tests · nightly cluster faults: 28 tests / 7 modules · nightly protocols: 16 tests** · updated 2026-08-21. diff --git a/fuzz/fuzz_targets/archive_extract.rs b/fuzz/fuzz_targets/archive_extract.rs index 1597a9a83..b0d40bd99 100644 --- a/fuzz/fuzz_targets/archive_extract.rs +++ b/fuzz/fuzz_targets/archive_extract.rs @@ -48,11 +48,8 @@ fn materialize_case(path: String, prefix: Option, flags: &[String]) -> ( .fold((path, prefix), |(path, prefix), flag| apply_flag(path, prefix, flag)) } -fn has_dot_segments(path: &str) -> bool { - path.split(['/', '\\']).any(|segment| { - let trimmed = segment.trim(); - trimmed == "." || trimmed == ".." - }) +fn has_parent_segments(path: &str) -> bool { + path.split(['/', '\\']).any(|segment| segment == "..") } fuzz_target!(|data: &[u8]| { @@ -66,8 +63,8 @@ fuzz_target!(|data: &[u8]| { if let Ok(key) = normalize_extract_entry_key(&path, prefix.as_deref(), is_dir) { assert!( - !has_dot_segments(&key), - "accepted archive entry retained dot segments: path={:?} prefix={:?} key={:?}", + !has_parent_segments(&key), + "accepted archive entry retained parent segments: path={:?} prefix={:?} key={:?}", path, prefix, key diff --git a/fuzz/fuzz_targets/policy_ingress.rs b/fuzz/fuzz_targets/policy_ingress.rs index 426991d76..32a2de9f2 100644 --- a/fuzz/fuzz_targets/policy_ingress.rs +++ b/fuzz/fuzz_targets/policy_ingress.rs @@ -69,7 +69,11 @@ fuzz_target!(|data: &[u8]| { && let Some(object) = value.as_object() { let mut legacy_doc = Map::new(); - if let Some(policy) = object.get("Policy").or_else(|| object.get("policy")) { + if let Some(policy) = object + .get("Policy") + .or_else(|| object.get("policy")) + .filter(|policy| serde_json::from_value::((*policy).clone()).is_ok()) + { legacy_doc.insert("version".to_string(), json!(1)); legacy_doc.insert("policy".to_string(), policy.clone()); legacy_doc.insert("create_date".to_string(), json!("2025-03-07T12:00:00Z")); diff --git a/scripts/check_test_wiring.py b/scripts/check_test_wiring.py new file mode 100755 index 000000000..d04af1f12 --- /dev/null +++ b/scripts/check_test_wiring.py @@ -0,0 +1,419 @@ +#!/usr/bin/env python3 +"""Fail when committed tests silently fall out of their execution wiring.""" + +from __future__ import annotations + +import hashlib +import json +import re +import sys +import tempfile +import tomllib +import unittest +from unittest import mock +from pathlib import Path + + +ROOT = Path(__file__).resolve().parents[1] + + +def words(value: str) -> set[str]: + return {item.strip() for item in value.split(",") if item.strip()} + + +def rust_code_only(source: str) -> str: + """Blank Rust comments and literals while preserving byte positions.""" + def quoted_end(quote_index: int, delimiter: str) -> int: + end = quote_index + 1 + while end < len(source): + if source[end] == "\\": + end += 2 + elif source[end] == delimiter: + return end + 1 + else: + end += 1 + return end + + code = list(source) + index = 0 + while index < len(source): + if source.startswith("//", index): + end = source.find("\n", index) + end = len(source) if end < 0 else end + elif source.startswith("/*", index): + depth = 1 + end = index + 2 + while end < len(source) and depth: + if source.startswith("/*", end): + depth += 1 + end += 2 + elif source.startswith("*/", end): + depth -= 1 + end += 2 + else: + end += 1 + else: + raw = re.match(r'(?:br|cr|r)(?P#{0,})"', source[index:]) + if raw: + marker = '"' + raw.group("hashes") + end = source.find(marker, index + raw.end()) + end = len(source) if end < 0 else end + len(marker) + elif source[index] == '"' or source.startswith(('b"', 'c"'), index): + start_quote = index if source[index] == '"' else index + 1 + end = quoted_end(start_quote, '"') + elif source[index] == "'" and index + 2 < len(source) and ( + source[index + 1] == "\\" or source[index + 2] == "'" + ): + end = quoted_end(index, "'") + elif source.startswith("b'", index): + end = quoted_end(index + 1, "'") + else: + index += 1 + continue + + for offset in range(index, end): + if code[offset] != "\n": + code[offset] = " " + index = end + return "".join(code) + + +def declared(parent: Path, module: str) -> bool: + source = parent.read_text() + code = rust_code_only(source) + pattern = re.compile(rf"^\s*(?:pub(?:\([^)]*\))?\s+)?mod\s+{re.escape(module)}\s*;", re.MULTILINE) + allowed_preambles = { + "#[cfg(test)]": "#[cfg(test)]", + "#[cfg(all(test,target_os=))]": '#[cfg(all(test,target_os="linux"))]', + } + for match in pattern.finditer(code): + prefix = code[: match.start()] + depths = {"(": 0, "[": 0, "{": 0} + pairs = {")": "(", "]": "[", "}": "{"} + for char in prefix: + if char in depths: + depths[char] += 1 + elif char in pairs: + depths[pairs[char]] -= 1 + if any(depths.values()): + continue + + boundary = max(prefix.rfind(";"), prefix.rfind("{"), prefix.rfind("}")) + code_preamble = re.sub(r"\s+", "", prefix[boundary + 1 :]) + if not code_preamble: + return True + if code_preamble in allowed_preambles: + attr_start = prefix.rfind("#[cfg", boundary + 1) + if attr_start >= 0 and re.sub(r"\s+", "", source[attr_start : match.start()]) == allowed_preambles[code_preamble]: + return True + return False + + +def module_source(src: Path, directory: Path) -> Path | None: + if not directory.parts: + return src / "lib.rs" + + mod_file = src / directory / "mod.rs" + if mod_file.is_file(): + return mod_file + + sibling = src.joinpath(*directory.parts[:-1], f"{directory.name}.rs") + return sibling if sibling.is_file() else None + + +def check_e2e_modules(root: Path) -> list[str]: + src = root / "crates/e2e_test/src" + errors: list[str] = [] + for test_file in sorted(src.rglob("*_test.rs")): + relative = test_file.relative_to(root).as_posix() + directory = test_file.relative_to(src).parent + parent = module_source(src, directory) + if parent is None: + errors.append(f"{relative}: no canonical parent module") + continue + + if not declared(parent, test_file.stem): + errors.append(f"{relative}: not declared by {parent.relative_to(root).as_posix()}") + while directory.parts: + module = directory.name + directory = directory.parent + parent = module_source(src, directory) + if parent is None: + errors.append(f"{relative}: module {module} has no canonical parent") + break + if not declared(parent, module): + errors.append(f"{relative}: module {module} not declared by {parent.relative_to(root).as_posix()}") + return errors + + +def check_fuzz_targets(root: Path) -> list[str]: + manifest = tomllib.loads((root / "fuzz/Cargo.toml").read_text()) + expected = {item["name"] for item in manifest.get("bin", []) if "name" in item} + errors: list[str] = [] + if not expected: + return ["fuzz/Cargo.toml: no [[bin]] fuzz targets found"] + + runner = (root / "scripts/fuzz/run.sh").read_text() + match = re.search(r'^targets="([^"]+)"', runner, re.MULTILINE) + runner_targets = set(match.group(1).split()) if match else set() + if runner_targets != expected: + errors.append(f"scripts/fuzz/run.sh targets {sorted(runner_targets)} != manifest {sorted(expected)}") + + workflow = (root / ".github/workflows/fuzz.yml").read_text() + matrices = [words(value) for value in re.findall(r"^\s*target:\s*\[([^]]+)]", workflow, re.MULTILINE)] + if len(matrices) != 2: + errors.append(f".github/workflows/fuzz.yml: expected smoke and nightly target matrices, found {len(matrices)}") + for index, matrix in enumerate(matrices, start=1): + if matrix != expected: + errors.append(f".github/workflows/fuzz.yml matrix {index} {sorted(matrix)} != manifest {sorted(expected)}") + + runtime_targets = re.findall(r"^\s*FUZZ_TARGET:\s*(\S.*?)\s*$", workflow, re.MULTILINE) + if runtime_targets != ["${{ matrix.target }}", "${{ matrix.target }}"]: + errors.append(".github/workflows/fuzz.yml: smoke and nightly jobs must pass matrix.target to FUZZ_TARGET") + + dependency_paths = { + f"{path.removeprefix('../')}/**" + for dependency in manifest.get("dependencies", {}).values() + if isinstance(dependency, dict) + and isinstance(path := dependency.get("path"), str) + and path.startswith("../crates/") + } + missing_paths = sorted(path for path in dependency_paths if f'"{path}"' not in workflow) + if missing_paths: + errors.append(f".github/workflows/fuzz.yml missing direct dependency paths: {', '.join(missing_paths)}") + + staged_matches = re.findall(r"^\s*for target in ([^;]+); do", workflow, re.MULTILINE) + staged = set(staged_matches[0].split()) if staged_matches else set() + if staged != expected: + errors.append(f".github/workflows/fuzz.yml staged binaries {sorted(staged)} != manifest {sorted(expected)}") + + return errors + + +def check_runner_selection(root: Path) -> list[str]: + runner = (root / "scripts/run_e2e_tests.sh").read_text() + errors: list[str] = [] + if "--include-ignored" not in runner: + errors.append("scripts/run_e2e_tests.sh: runner must include default and ignored tests") + if "--test-threads=1" not in runner: + errors.append("scripts/run_e2e_tests.sh: runner must serialize fixed-port protocol tests") + if re.search(r"(? str: + if not re.fullmatch(r"e2e-[a-z0-9-]+", profile): + raise ValueError(f"invalid e2e profile name: {profile}") + path = root / f".config/{profile}-selection.txt" + lines = [line for line in path.read_text().splitlines() if line.strip()] + values = dict(line.split("=", 1) for line in lines if "=" in line) + if len(values) != len(lines) or any(not re.fullmatch(r"sha256(?:-[a-z0-9]+)?", key) for key in values): + raise ValueError(f"{path.relative_to(root).as_posix()}: invalid sha256 entry") + key = f"sha256-{sys.platform}" + digest = values.get(key, values.get("sha256", "")) + if not re.fullmatch(r"[0-9a-f]{64}", digest): + raise ValueError(f"{path.relative_to(root).as_posix()}: missing sha256 for {sys.platform}") + return digest + + +def check_profile_definitions(root: Path) -> list[str]: + config = tomllib.loads((root / ".config/nextest.toml").read_text()) + profiles = { + profile + for profile in config.get("profile", {}) + if profile.startswith("e2e-") + } + selection_profiles = { + path.name.removesuffix("-selection.txt") for path in (root / ".config").glob("e2e-*-selection.txt") + } + errors: list[str] = [] + for profile in sorted(profiles | selection_profiles): + if profile not in profiles: + errors.append(f".config/nextest.toml: missing profile.{profile}") + if profile not in selection_profiles: + errors.append(f".config/{profile}-selection.txt: missing expected profile selection") + continue + try: + profile_selection(root, profile) + except (FileNotFoundError, ValueError) as error: + errors.append(str(error)) + return errors + + +def check_profile_listing(root: Path, profile: str, listing: Path) -> list[str]: + try: + expected_digest = profile_selection(root, profile) + data = json.loads(listing.read_text()) + selected = sorted( + f"{suite_id}::{test_name}" + for suite_id, suite in data["rust-suites"].items() + for test_name, testcase in suite["testcases"].items() + if testcase.get("filter-match", {}).get("status") == "matches" + ) + digest = hashlib.sha256(("\n".join(selected) + "\n").encode()).hexdigest() + except (FileNotFoundError, KeyError, TypeError, ValueError, json.JSONDecodeError) as error: + return [f"cannot read {profile} nextest listing: {error}"] + if digest != expected_digest: + return [ + f"{profile} selection changed: count={len(selected)} sha256={digest}; " + f"expected sha256={expected_digest}" + ] + print(f"{profile} selection OK: {len(selected)} tests, sha256={digest}") + return [] + + +def validate(root: Path) -> list[str]: + errors: list[str] = [] + errors.extend(check_e2e_modules(root)) + errors.extend(check_fuzz_targets(root)) + errors.extend(check_runner_selection(root)) + errors.extend(check_profile_definitions(root)) + return errors + + +class SelfTests(unittest.TestCase): + def test_e2e_requires_registration(self) -> None: + with tempfile.TemporaryDirectory() as tmp: + root = Path(tmp) + src = root / "crates/e2e_test/src" + src.mkdir(parents=True) + (src / "lib.rs").write_text("") + test_file = src / "boundary_test.rs" + test_file.write_text("#[test]\nfn boundary() {}\n") + self.assertEqual(len(check_e2e_modules(root)), 1) + (src / "lib.rs").write_text("mod boundary_test;\n") + self.assertEqual(check_e2e_modules(root), []) + + nested = src / "protocols" + nested.mkdir() + (nested / "mod.rs").write_text("mod fixed_port_test;\n") + (nested / "fixed_port_test.rs").write_text("#[test]\nfn fixed_port() {}\n") + self.assertEqual(len(check_e2e_modules(root)), 1) + (src / "lib.rs").write_text("mod boundary_test;\nmod protocols;\n") + self.assertEqual(check_e2e_modules(root), []) + + (src / "lib.rs").write_text("#[cfg(any())]\nmod boundary_test;\nmod protocols;\n") + self.assertEqual(len(check_e2e_modules(root)), 1) + + (src / "lib.rs").write_text( + "#[cfg(any())]\n/// hidden module\nmod boundary_test;\n#[cfg_attr(test, cfg(any()))]\nmod protocols;\n" + ) + self.assertEqual(len(check_e2e_modules(root)), 2) + + (src / "lib.rs").write_text( + 'const PHANTOM: &str = r#"{\nmod boundary_test;\n"#;\ndiscard! { mod protocols; }\n' + ) + self.assertEqual(len(check_e2e_modules(root)), 2) + + (src / "lib.rs").write_text( + '#[cfg(all(test, target_os = r"windows" /* target_os = "linux" */))]\n' + "mod boundary_test;\nmod protocols;\n" + ) + self.assertEqual(len(check_e2e_modules(root)), 1) + + (src / "lib.rs").write_text( + '#[cfg(all(test, target_os = r"windows"))] // #[cfg(all(test, target_os = "linux"))]\n' + "mod boundary_test;\nmod protocols;\n" + ) + self.assertEqual(len(check_e2e_modules(root)), 1) + + def test_fuzz_runtime_uses_matrix_target(self) -> None: + with tempfile.TemporaryDirectory() as tmp: + root = Path(tmp) + (root / "fuzz").mkdir() + (root / "scripts/fuzz").mkdir(parents=True) + (root / ".github/workflows").mkdir(parents=True) + (root / "fuzz/Cargo.toml").write_text( + 'dep = { path = "../crates/dep" }\n[[bin]]\nname = "one"\n' + ) + (root / "scripts/fuzz/run.sh").write_text('targets="one"\n') + (root / ".github/workflows/fuzz.yml").write_text( + 'paths:\n - "crates/dep/**"\n' + "target: [one]\nFUZZ_TARGET: fixed\n" + "target: [one]\nFUZZ_TARGET: ${{ matrix.target }}\n" + "for target in one; do\n" + " fuzz/prebuilt/${{ env.CARGO_BUILD_TARGET }}/release/one\n" + ) + self.assertEqual(len(check_fuzz_targets(root)), 1) + + def test_profile_listing_enforces_selection(self) -> None: + with tempfile.TemporaryDirectory() as tmp: + root = Path(tmp) + (root / ".config").mkdir() + digest = hashlib.sha256(b"suite::two\n").hexdigest() + (root / ".config/e2e-smoke-selection.txt").write_text(f"sha256={digest}\n") + listing = root / "listing.json" + listing.write_text( + json.dumps( + { + "rust-suites": { + "suite": { + "testcases": { + "one": {"filter-match": {"status": "matches"}}, + "two": {"filter-match": {"status": "mismatch"}}, + } + } + } + } + ) + ) + self.assertEqual(len(check_profile_listing(root, "e2e-smoke", listing)), 1) + + def test_profile_listing_binds_platform_digest(self) -> None: + with tempfile.TemporaryDirectory() as tmp: + root = Path(tmp) + (root / ".config").mkdir() + darwin_digest = hashlib.sha256(b"suite::darwin\n").hexdigest() + linux_digest = hashlib.sha256(b"suite::linux\n").hexdigest() + (root / ".config/e2e-full-selection.txt").write_text( + f"sha256-darwin={darwin_digest}\nsha256-linux={linux_digest}\n" + ) + listing = root / "listing.json" + listing.write_text( + json.dumps( + { + "rust-suites": { + "suite": { + "testcases": {"darwin": {"filter-match": {"status": "matches"}}} + } + } + } + ) + ) + with mock.patch.object(sys, "platform", "linux"): + self.assertEqual(len(check_profile_listing(root, "e2e-full", listing)), 1) + +def main() -> int: + if sys.argv[1:] == ["--self-test"]: + suite = unittest.defaultTestLoader.loadTestsFromTestCase(SelfTests) + return 0 if unittest.TextTestRunner(verbosity=2).run(suite).wasSuccessful() else 1 + if len(sys.argv) == 4 and sys.argv[1] == "--check-profile": + errors = check_profile_listing(ROOT, sys.argv[2], Path(sys.argv[3])) + if errors: + for error in errors: + print(f"ERROR: {error}", file=sys.stderr) + return 1 + return 0 + if sys.argv[1:]: + print( + "usage: check_test_wiring.py [--self-test | --check-profile PROFILE LISTING]", + file=sys.stderr, + ) + return 2 + + errors = validate(ROOT) + if errors: + for error in errors: + print(f"ERROR: {error}", file=sys.stderr) + return 1 + print("OK: e2e modules, runner selection, fuzz matrices, and profile guards are wired") + return 0 + + +if __name__ == "__main__": + raise SystemExit(main()) diff --git a/scripts/run_e2e_tests.sh b/scripts/run_e2e_tests.sh index 810aec5fd..8e98b202c 100755 --- a/scripts/run_e2e_tests.sh +++ b/scripts/run_e2e_tests.sh @@ -20,6 +20,8 @@ DATA_DIR="$TARGET_DIR/rustfs_test_data" RUSTFS_PID="" TEST_FILTER="" TEST_TYPE="all" +RUSTFS_BUILD_FEATURES="${RUSTFS_BUILD_FEATURES:-ftps,webdav,sftp}" +export RUSTFS_BUILD_FEATURES # Function to print colored output print_info() { @@ -92,7 +94,7 @@ build_rustfs() { print_info "Building RustFS..." cd "$PROJECT_ROOT" - if ! cargo build --bin rustfs; then + if ! cargo build --bin rustfs --features "$RUSTFS_BUILD_FEATURES"; then print_error "Failed to build RustFS" exit 1 fi @@ -219,27 +221,28 @@ start_rustfs() { run_tests() { print_info "Running e2e tests..." cd "$PROJECT_ROOT" - - local test_cmd="cargo test --package e2e_test --lib" - + + local test_cmd=(cargo test --package e2e_test --lib) + case "$TEST_TYPE" in "specific") - test_cmd="$test_cmd -- $TEST_FILTER --exact --show-output --ignored" + test_cmd+=(-- "$TEST_FILTER") print_info "Running specific test: $TEST_FILTER" ;; "file") - test_cmd="$test_cmd -- $TEST_FILTER --show-output --ignored" + test_cmd+=(-- "$TEST_FILTER") print_info "Running tests in file/module: $TEST_FILTER" ;; "all") - test_cmd="$test_cmd -- --show-output --ignored" + test_cmd+=(--) print_info "Running all e2e tests" ;; esac - - print_info "Test command: $test_cmd" - - if eval "$test_cmd"; then + test_cmd+=(--show-output --include-ignored --test-threads=1) + + print_info "Test command: ${test_cmd[*]}" + + if "${test_cmd[@]}"; then print_success "All tests passed!" return 0 else diff --git a/scripts/s3-tests/README.md b/scripts/s3-tests/README.md index dab4de556..fe06d679c 100644 --- a/scripts/s3-tests/README.md +++ b/scripts/s3-tests/README.md @@ -253,6 +253,9 @@ Test results are saved in the `artifacts/s3tests-${TEST_MODE}/` directory (defau - `junit.xml`: Test results in JUnit format (compatible with CI/CD systems) - `pytest.log`: Detailed pytest logs with full test output +- `all-collected-nodeids.txt`: Exact node IDs in the pinned upstream suite +- `selected-nodeids.txt`: Exact node IDs expected in this run +- `unsharded-selected-nodeids.txt`: Exact node IDs before deterministic sharding - `compat-report.md`: Classification report generated by `report_compat.py` — regressions against `implemented_tests.txt`, promotion candidates (tests that pass but are still listed as unimplemented/excluded), and tests missing @@ -449,9 +452,11 @@ RustFS. Two GitHub Actions workflows delegate to it: - **Full sweep** (`.github/workflows/e2e-s3tests.yml`): weekly scheduled (and manually dispatchable) run of the ENTIRE upstream suite (`TEST_SCOPE=all`) against a Docker deployment — single node or a real 4-node distributed - cluster behind HAProxy. The sweep fails only on regressions in the - implemented whitelist; everything else is reported by `report_compat.py` - as promotion candidates or unclassified tests. + cluster behind HAProxy. Regressions, unclassified tests, incomplete + execution, and infrastructure errors fail the sweep; classified unsupported + behavior remains informational. Scheduled topology runs are split into four + deterministic exact-node-ID shards, and every case has a five-minute timeout, + so one stalled case cannot erase the entire sweep's evidence. Keeping both workflows on this script means local runs, the PR gate, and the scheduled sweep always execute tests the same way (same pinned s3-tests @@ -466,8 +471,9 @@ pass/fail table in the job summary. ## Companion Tools - `report_compat.py` — diffs a junit.xml result against the classification - lists; run automatically at the end of `run.sh`, and used by the weekly - sweep to gate on whitelist regressions only (`--fail-on-regression`). + lists and the exact pytest collection; run before execution to reject stale + or missing classifications, then after execution to detect regressions and + incomplete parameterized cases. - `api_coverage.py` — quantifies S3 API surface coverage by comparing the s3s `S3` trait (at the revision pinned in Cargo.toml) against the methods RustFS overrides in `impl S3 for FS`: diff --git a/scripts/s3-tests/excluded_tests.txt b/scripts/s3-tests/excluded_tests.txt index 637aaff8c..49401c91b 100644 --- a/scripts/s3-tests/excluded_tests.txt +++ b/scripts/s3-tests/excluded_tests.txt @@ -307,3 +307,10 @@ test_object_acl_write test_object_acl_writeacp test_put_bucket_acl_grant_group_read test_object_raw_get_bucket_acl + +# Require upstream cloud-storage or IAM account services +test_bucket_logging_requester_assumed_role +test_lifecycle_cloud_transition_target_by_bucket +test_lifecycle_cloud_transition_target_by_bucket_multiple_buckets +test_list_object_versions_restore_status +test_list_objects_restore_status diff --git a/scripts/s3-tests/implemented_tests.txt b/scripts/s3-tests/implemented_tests.txt index 0f29756e8..83b6f8513 100644 --- a/scripts/s3-tests/implemented_tests.txt +++ b/scripts/s3-tests/implemented_tests.txt @@ -521,9 +521,13 @@ test_atomic_dual_conditional_write_1mb test_atomic_write_bucket_gone test_bucket_acl_canned_private_to_private test_bucket_concurrent_set_canned_acl +test_bucket_create_delete +test_bucket_policy test_bucket_policy_acl test_bucket_policy_put_obj_acl test_bucketv2_policy_acl +test_copy_enc +test_copy_part_enc test_copy_object_ifmatch_failed test_copy_object_ifnonematch_good test_cors_presigned_put_object_tenant_with_acl diff --git a/scripts/s3-tests/report_compat.py b/scripts/s3-tests/report_compat.py index 078c22c1d..a3c44a74a 100755 --- a/scripts/s3-tests/report_compat.py +++ b/scripts/s3-tests/report_compat.py @@ -21,14 +21,17 @@ Classifies every executed test into: - unclassified passes: passed but not present in any list (new upstream tests) - unclassified failures: failed and not present in any list (new upstream tests) -Writes a markdown report and prints a summary to stdout. Exit code is 0 unless ---fail-on-regression is given and at least one regression was found. +Writes a markdown report and prints a summary to stdout. Optional gates reject +regressions, unclassified tests, stale classifications, and incomplete node-ID +execution. """ from __future__ import annotations import argparse +from collections import Counter import pathlib +import re import sys import xml.etree.ElementTree as ET @@ -45,33 +48,47 @@ LIST_FILES = { } -def load_list(path: pathlib.Path) -> set[str]: - names: set[str] = set() +def load_entries(path: pathlib.Path) -> list[str]: + names: list[str] = [] if not path.is_file(): return names for line in path.read_text(encoding="utf-8").splitlines(): line = line.strip() if line and not line.startswith("#"): - names.add(line) + names.append(line) return names +def classification_errors(entries: dict[str, list[str]]) -> list[str]: + errors: list[str] = [] + lists = {key: set(names) for key, names in entries.items()} + for key, names in entries.items(): + duplicates = sorted(name for name, count in Counter(names).items() if count > 1) + if duplicates: + errors.append(f"{LIST_FILES[key]} has duplicates: {', '.join(duplicates)}") + keys = tuple(lists) + for index, left in enumerate(keys): + for right in keys[index + 1 :]: + overlap = sorted(lists[left] & lists[right]) + if overlap: + errors.append(f"{left}/{right} classifications overlap: {', '.join(overlap)}") + return errors + + def base_name(testcase_name: str) -> str: """Strip pytest parametrization (test_foo[param]) to match list entries.""" return testcase_name.split("[", 1)[0] -def parse_junit(path: pathlib.Path) -> dict[str, str]: - """Return {test name: status} with status in passed/failed/error/skipped. - - Parametrized cases collapse onto their base name; any failing variant marks - the whole test failed. - """ +def parse_junit(path: pathlib.Path) -> tuple[dict[str, str], list[str], list[tuple[str, str, str, str]]]: + """Return exact statuses, pytest-timeout cases, and failure summaries.""" results: dict[str, str] = {} + timed_out: list[str] = [] + failures: list[tuple[str, str, str, str]] = [] severity = {"skipped": 0, "passed": 1, "failed": 2, "error": 2} root = ET.parse(path).getroot() for case in root.iter("testcase"): - name = base_name(case.get("name", "")) + name = case.get("name", "") if not name: continue if case.find("failure") is not None: @@ -85,7 +102,35 @@ def parse_junit(path: pathlib.Path) -> dict[str, str]: prev = results.get(name) if prev is None or severity[status] > severity[prev]: results[name] = status - return results + node = case.find("failure") if status == "failed" else case.find("error") + if node is not None: + details = " ".join(filter(None, [node.get("message", ""), node.text or ""])) + message = node.get("message") or next(iter((node.text or "").strip().splitlines()), "") + failures.append((case.get("classname", ""), name, case.get("time", "0"), message)) + if re.search(r"\bTimeout\s*(?:>|\()", details, re.IGNORECASE): + timed_out.append(name) + return results, timed_out, failures + + +def collapse_results(results: dict[str, str]) -> dict[str, str]: + """Collapse parametrized cases for classification-level reporting.""" + collapsed: dict[str, str] = {} + severity = {"skipped": 0, "passed": 1, "failed": 2, "error": 2} + for exact_name, status in results.items(): + name = base_name(exact_name) + previous = collapsed.get(name) + if previous is None or severity[status] > severity[previous]: + collapsed[name] = status + return collapsed + + +def load_collected_nodeids(path: pathlib.Path) -> set[str]: + names: set[str] = set() + for line in path.read_text(encoding="utf-8").splitlines(): + nodeid = line.strip() + if nodeid: + names.add(nodeid.rsplit("::", 1)[-1]) + return names def render_section(title: str, rows: list[str], hint: str = "") -> list[str]: @@ -102,7 +147,7 @@ def render_section(title: str, rows: list[str], hint: str = "") -> list[str]: def main() -> int: parser = argparse.ArgumentParser(description=__doc__) - parser.add_argument("--junit", required=True, type=pathlib.Path, help="junit.xml produced by pytest") + parser.add_argument("--junit", type=pathlib.Path, help="junit.xml produced by pytest") parser.add_argument( "--lists-dir", type=pathlib.Path, @@ -115,14 +160,60 @@ def main() -> int: action="store_true", help="exit non-zero when a test from implemented_tests.txt failed", ) + parser.add_argument( + "--fail-on-unclassified", + action="store_true", + help="exit non-zero when an executed test is absent from every classification", + ) + parser.add_argument( + "--collected-nodeids", + type=pathlib.Path, + help="exact pytest node IDs from the pinned suite's collect-only pass", + ) + parser.add_argument( + "--check-classifications-only", + action="store_true", + help="validate classification names against collected node IDs without reading JUnit", + ) args = parser.parse_args() - if not args.junit.is_file(): + entries = {key: load_entries(args.lists_dir / fname) for key, fname in LIST_FILES.items()} + lists = {key: set(names) for key, names in entries.items()} + invalid_classifications = classification_errors(entries) + collected: set[str] = set() + if args.collected_nodeids: + collected = load_collected_nodeids(args.collected_nodeids) + collected_base = {base_name(name) for name in collected} + classified = set().union(*lists.values()) + missing_classifications = sorted(collected_base - classified) + stale_classifications = sorted(classified - collected_base) + else: + missing_classifications = [] + stale_classifications = [] + + if args.check_classifications_only: + if not args.collected_nodeids: + parser.error("--check-classifications-only requires --collected-nodeids") + for error in invalid_classifications: + print(f"[INVALID] {error}") + for name in missing_classifications: + print(f"[UNCLASSIFIED] {name}") + for name in stale_classifications: + print(f"[STALE] {name}") + return 1 if invalid_classifications or missing_classifications or stale_classifications else 0 + + if invalid_classifications: + for error in invalid_classifications: + print(f"[ERROR] {error}", file=sys.stderr) + return 2 + + if not args.junit or not args.junit.is_file(): print(f"[ERROR] junit file not found: {args.junit}", file=sys.stderr) return 2 - lists = {key: load_list(args.lists_dir / fname) for key, fname in LIST_FILES.items()} - results = parse_junit(args.junit) + exact_results, timed_out, failures = parse_junit(args.junit) + results = collapse_results(exact_results) + missing_results = sorted(collected - exact_results.keys()) if collected else [] regressions: list[str] = [] promotions: dict[str, list[str]] = {"unimplemented": [], "excluded": []} @@ -155,7 +246,9 @@ def main() -> int: lines = [ "# S3 compatibility report", "", - f"Executed: {len(results)} tests — " + f"Executed: {len(exact_results)} exact cases across {len(results)} classified tests.", + "", + "Classification status — " f"{counts['passed']} passed, {counts['failed']} failed, " f"{counts['error']} errored, {counts['skipped']} skipped.", "", @@ -191,6 +284,16 @@ def main() -> int: unclassified_failed, "Failing and absent from every list — triage into `unimplemented_tests.txt` or `excluded_tests.txt`.", ) + lines += render_section( + "Missing results", + missing_results, + "Present in the pinned upstream suite but absent from JUnit — the sweep was incomplete.", + ) + lines += render_section( + "Timed out", + timed_out, + "Per-test timeout is an infrastructure failure regardless of compatibility classification.", + ) report = "\n".join(lines) if args.output: @@ -201,13 +304,28 @@ def main() -> int: print( f"[INFO] {len(regressions)} regression(s), " f"{len(promotions['unimplemented']) + len(promotions['excluded']) + len(unclassified_passed)} promotion candidate(s), " - f"{len(unclassified_failed)} unclassified failure(s)" + f"{len(unclassified_failed)} unclassified failure(s), " + f"{len(missing_results)} missing result(s), " + f"{len(timed_out)} timeout(s)" ) for name in sorted(regressions): print(f"[REGRESSION] {name}") + if failures: + print("[ERROR] s3-tests failed testcase summary:") + for classname, name, duration, message in failures[:20]: + nodeid = f"{classname}::{name}" if classname else name + print(f"[ERROR] - {nodeid} ({duration}s): {message}") + if len(failures) > 20: + print(f"[ERROR] - ... {len(failures) - 20} additional failed testcases omitted") if args.fail_on_regression and regressions: return 1 + if args.fail_on_unclassified and (unclassified_passed or unclassified_failed): + return 1 + if args.collected_nodeids and missing_results: + return 1 + if timed_out: + return 1 return 0 diff --git a/scripts/s3-tests/run.sh b/scripts/s3-tests/run.sh index d9fd15040..ac8b691f5 100755 --- a/scripts/s3-tests/run.sh +++ b/scripts/s3-tests/run.sh @@ -58,6 +58,19 @@ if [[ "${TEST_SCOPE}" != "implemented" && "${TEST_SCOPE}" != "all" ]]; then echo "[ERROR] Invalid TEST_SCOPE: ${TEST_SCOPE} (must be \"implemented\" or \"all\")" >&2 exit 1 fi +S3_SHARD_COUNT="${S3_SHARD_COUNT:-1}" +S3_SHARD_INDEX="${S3_SHARD_INDEX:-0}" +TEST_TIMEOUT="${TEST_TIMEOUT:-300}" +if [[ ! "${S3_SHARD_COUNT}" =~ ^[1-9][0-9]*$ ]] \ + || [[ ! "${S3_SHARD_INDEX}" =~ ^[0-9]+$ ]] \ + || (( S3_SHARD_INDEX >= S3_SHARD_COUNT )); then + echo "[ERROR] Invalid S3 shard ${S3_SHARD_INDEX}/${S3_SHARD_COUNT}" >&2 + exit 1 +fi +if [[ ! "${TEST_TIMEOUT}" =~ ^[1-9][0-9]*$ ]]; then + echo "[ERROR] Invalid TEST_TIMEOUT: ${TEST_TIMEOUT}" >&2 + exit 1 +fi # Upstream ceph/s3-tests suite, pinned for reproducible runs. # Bump S3TESTS_REV deliberately: upstream changes can rename tests or change @@ -96,55 +109,6 @@ log_error() { echo -e "${RED}[ERROR]${NC} $*" } -summarize_junit_failures() { - local junit_path="$1" - - if [ ! -f "${junit_path}" ]; then - log_warn "JUnit report not found: ${junit_path}" - return 0 - fi - - python3 - "${junit_path}" <<'PY' -import sys -import xml.etree.ElementTree as ET - -junit_path = sys.argv[1] -try: - root = ET.parse(junit_path).getroot() -except Exception as exc: - print(f"[WARN] Failed to parse JUnit report {junit_path}: {exc}") - raise SystemExit(0) - -failures = [] -for case in root.iter("testcase"): - failure = case.find("failure") - error = case.find("error") - node = failure if failure is not None else error - if node is None: - continue - - classname = case.attrib.get("classname", "") - name = case.attrib.get("name", "") - duration = case.attrib.get("time", "0") - message = node.attrib.get("message") or (node.text or "").strip().splitlines()[0:1] - if isinstance(message, list): - message = message[0] if message else "" - failures.append((classname, name, duration, message)) - -if not failures: - print("[INFO] No failed testcases found in JUnit report") - raise SystemExit(0) - -print("[ERROR] s3-tests failed testcase summary:") -for classname, name, duration, message in failures[:20]: - nodeid = f"{classname}::{name}" if classname else name - print(f"[ERROR] - {nodeid} ({duration}s): {message}") - -if len(failures) > 20: - print(f"[ERROR] - ... {len(failures) - 20} additional failed testcases omitted") -PY -} - # ============================================================================= # Test Classification Files # ============================================================================= @@ -322,6 +286,9 @@ Environment Variables: MAXFAIL - Stop after N failures, 0 = never stop (default: 1) XDIST - Enable parallel execution with N workers (default: 0) TEST_SCOPE - "implemented" (whitelist, default) or "all" (entire upstream suite) + S3_SHARD_COUNT - Number of deterministic exact-node-ID shards (default: 1) + S3_SHARD_INDEX - Zero-based shard index (default: 0) + TEST_TIMEOUT - Per-test timeout in seconds (default: 300) S3TESTS_REPO - s3-tests repository URL (default: https://github.com/ceph/s3-tests.git) S3TESTS_REV - Pinned s3-tests commit; bump deliberately and reclassify test lists MARKEXPR - pytest marker expression (default: no marker filtering) @@ -982,9 +949,10 @@ mkdir -p "${ARTIFACTS_DIR}" XDIST_ARGS="" if [ "${XDIST}" != "0" ]; then # Add pytest-xdist to requirements.txt so tox installs it inside its virtualenv - echo "pytest-xdist" >> requirements.txt + grep -qxF "pytest-xdist" requirements.txt || echo "pytest-xdist" >> requirements.txt XDIST_ARGS="-n ${XDIST} --dist=loadgroup" fi +grep -qxF "pytest-timeout" requirements.txt || echo "pytest-timeout" >> requirements.txt # Resolve config path (absolute path for tox) if [[ "${S3TESTS_CONF}" = /* ]]; then @@ -1003,12 +971,69 @@ else PYTEST_SELECTION_ARGS=("${S3_TEST_FILE}") fi +collect_nodeids() { + local output_path="$1" + shift + local collect_log="${output_path%.txt}.log" + local collect_rc=0 + local node_prefix="${S3_TEST_FILE//./\\.}::" + + set +e + S3TEST_CONF="${CONF_OUTPUT_PATH}" tox -- -q --collect-only "$@" 2>&1 | tee "${collect_log}" + collect_rc=${PIPESTATUS[0]} + set -e + if [ "${collect_rc}" -ne 0 ]; then + log_error "pytest collection failed with exit code ${collect_rc}" + return "${collect_rc}" + fi + grep -E "^${node_prefix}" "${collect_log}" > "${output_path}" || true + if [ ! -s "${output_path}" ]; then + log_error "pytest collection produced no S3 test node IDs" + return 1 + fi +} + +ALL_COLLECTED_NODEIDS="${ARTIFACTS_DIR}/all-collected-nodeids.txt" +UNSHARDED_SELECTED_NODEIDS="${ARTIFACTS_DIR}/unsharded-selected-nodeids.txt" +SELECTED_NODEIDS="${ARTIFACTS_DIR}/selected-nodeids.txt" +collect_nodeids "${ALL_COLLECTED_NODEIDS}" "${S3_TEST_FILE}" -m "not rustfs_never_marker" +python3 "${SCRIPT_DIR}/report_compat.py" \ + --lists-dir "${SCRIPT_DIR}" \ + --collected-nodeids "${ALL_COLLECTED_NODEIDS}" \ + --check-classifications-only || { + log_error "S3 test classifications do not match pinned revision ${S3TESTS_REV}" + exit 1 +} +if [[ "${TEST_SCOPE}" == "all" && -z "${TESTEXPR}" && "${MARKEXPR}" == "not rustfs_never_marker" ]]; then + cp "${ALL_COLLECTED_NODEIDS}" "${UNSHARDED_SELECTED_NODEIDS}" +else + collect_nodeids "${UNSHARDED_SELECTED_NODEIDS}" "${PYTEST_SELECTION_ARGS[@]}" -m "${MARKEXPR}" +fi + +if (( S3_SHARD_COUNT > 1 )); then + awk -v count="${S3_SHARD_COUNT}" -v shard_index="${S3_SHARD_INDEX}" \ + '((NR - 1) % count) == shard_index' \ + "${UNSHARDED_SELECTED_NODEIDS}" > "${SELECTED_NODEIDS}" + if [[ ! -s "${SELECTED_NODEIDS}" ]]; then + log_error "Shard ${S3_SHARD_INDEX}/${S3_SHARD_COUNT} selected no tests" + exit 1 + fi + PYTEST_SELECTION_ARGS=() + while IFS= read -r nodeid; do + PYTEST_SELECTION_ARGS+=("${nodeid}") + done < "${SELECTED_NODEIDS}" + log_info "Selected shard ${S3_SHARD_INDEX}/${S3_SHARD_COUNT}: ${#PYTEST_SELECTION_ARGS[@]} exact cases" +else + cp "${UNSHARDED_SELECTED_NODEIDS}" "${SELECTED_NODEIDS}" +fi + # Run tests from s3tests/functional set +e S3TEST_CONF="${CONF_OUTPUT_PATH}" \ tox -- \ -vv -ra --showlocals --tb=long \ --maxfail="${MAXFAIL}" \ + --timeout="${TEST_TIMEOUT}" \ --junitxml="${ARTIFACTS_DIR}/junit.xml" \ ${XDIST_ARGS} \ "${PYTEST_SELECTION_ARGS[@]}" \ @@ -1033,19 +1058,22 @@ elif [ "${DEPLOY_MODE}" = "existing" ]; then echo "{\"host\": \"${S3_HOST}\", \"port\": ${S3_PORT}, \"mode\": \"existing\"}" > "${ARTIFACTS_DIR}/rustfs-${TEST_MODE}/inspect.json" || true fi -# Step 11: Classification report (informational, never fails the run) +# Step 11: Classification report and gate REPORT_SCRIPT="${SCRIPT_DIR}/report_compat.py" -if [ -f "${REPORT_SCRIPT}" ] && [ -f "${ARTIFACTS_DIR}/junit.xml" ]; then - python3 "${REPORT_SCRIPT}" \ - --junit "${ARTIFACTS_DIR}/junit.xml" \ - --lists-dir "${SCRIPT_DIR}" \ - --output "${ARTIFACTS_DIR}/compat-report.md" \ - || log_warn "Compatibility report generation failed" -fi - -if [ ${TEST_EXIT_CODE} -ne 0 ]; then - summarize_junit_failures "${ARTIFACTS_DIR}/junit.xml" +REPORT_ARGS=( + --junit "${ARTIFACTS_DIR}/junit.xml" + --lists-dir "${SCRIPT_DIR}" + --collected-nodeids "${SELECTED_NODEIDS}" + --output "${ARTIFACTS_DIR}/compat-report.md" + --fail-on-regression +) +if [[ "${TEST_SCOPE}" == "all" ]]; then + REPORT_ARGS+=(--fail-on-unclassified) fi +set +e +python3 "${REPORT_SCRIPT}" "${REPORT_ARGS[@]}" +REPORT_EXIT_CODE=$? +set -e # Summary if [ ${TEST_EXIT_CODE} -eq 0 ]; then @@ -1059,4 +1087,10 @@ else log_info "Check RustFS logs: ${ARTIFACTS_DIR}/rustfs-${TEST_MODE}/rustfs.log" fi -exit ${TEST_EXIT_CODE} +if [[ "${TEST_EXIT_CODE}" -ne 0 && "${TEST_EXIT_CODE}" -ne 1 ]]; then + exit "${TEST_EXIT_CODE}" +fi +if [[ "${TEST_SCOPE}" == "implemented" && "${TEST_EXIT_CODE}" -ne 0 ]]; then + exit "${TEST_EXIT_CODE}" +fi +exit "${REPORT_EXIT_CODE}" diff --git a/scripts/s3-tests/test_report_compat.py b/scripts/s3-tests/test_report_compat.py new file mode 100644 index 000000000..acae360d0 --- /dev/null +++ b/scripts/s3-tests/test_report_compat.py @@ -0,0 +1,119 @@ +#!/usr/bin/env python3 +"""Regression tests for the S3 compatibility report.""" + +from __future__ import annotations + +import importlib.util +import subprocess +import sys +import tempfile +import unittest +from pathlib import Path + + +REPORT_PATH = Path(__file__).with_name("report_compat.py") +SPEC = importlib.util.spec_from_file_location("report_compat", REPORT_PATH) +assert SPEC and SPEC.loader +REPORT = importlib.util.module_from_spec(SPEC) +SPEC.loader.exec_module(REPORT) + + +class ReportCompatTests(unittest.TestCase): + def test_upstream_names_expose_incomplete_junit(self) -> None: + with tempfile.TemporaryDirectory() as tmp: + directory = Path(tmp) + collected = directory / "collected.txt" + collected.write_text("s3tests/functional/test_s3.py::test_one[a]\ns3tests/functional/test_s3.py::test_one[b]\n") + junit = directory / "junit.xml" + junit.write_text('') + + expected = REPORT.load_collected_nodeids(collected) + results, _, _ = REPORT.parse_junit(junit) + + self.assertEqual(expected - results.keys(), {"test_one[b]"}) + + def test_cli_fails_an_incomplete_sweep(self) -> None: + with tempfile.TemporaryDirectory() as tmp: + directory = Path(tmp) + collected = directory / "collected.txt" + collected.write_text("s3tests/functional/test_s3.py::test_one\ns3tests/functional/test_s3.py::test_two\n") + junit = directory / "junit.xml" + junit.write_text('') + for filename in REPORT.LIST_FILES.values(): + (directory / filename).write_text("") + (directory / "implemented_tests.txt").write_text("test_one\n") + + result = subprocess.run( + [ + sys.executable, + str(REPORT_PATH), + "--junit", + str(junit), + "--lists-dir", + str(directory), + "--collected-nodeids", + str(collected), + "--fail-on-regression", + "--fail-on-unclassified", + ], + check=False, + capture_output=True, + text=True, + ) + + self.assertEqual(result.returncode, 1) + self.assertIn("1 missing result(s)", result.stdout) + + def test_preflight_rejects_missing_and_stale_classifications(self) -> None: + with tempfile.TemporaryDirectory() as tmp: + directory = Path(tmp) + collected = directory / "collected.txt" + collected.write_text("s3tests/functional/test_s3.py::test_known[a]\ntest_new\n") + for filename in REPORT.LIST_FILES.values(): + (directory / filename).write_text("") + (directory / "implemented_tests.txt").write_text("test_known\ntest_stale\ntest_stale\n") + + result = subprocess.run( + [ + sys.executable, + str(REPORT_PATH), + "--lists-dir", + str(directory), + "--collected-nodeids", + str(collected), + "--check-classifications-only", + ], + check=False, + capture_output=True, + text=True, + ) + + self.assertEqual(result.returncode, 1) + self.assertIn("[UNCLASSIFIED] test_new", result.stdout) + self.assertIn("[STALE] test_stale", result.stdout) + self.assertIn("[INVALID] implemented_tests.txt has duplicates: test_stale", result.stdout) + + def test_timeout_fails_even_when_test_is_excluded(self) -> None: + with tempfile.TemporaryDirectory() as tmp: + directory = Path(tmp) + junit = directory / "junit.xml" + junit.write_text( + '' + ) + for filename in REPORT.LIST_FILES.values(): + (directory / filename).write_text("") + (directory / "excluded_tests.txt").write_text("test_slow\n") + + result = subprocess.run( + [sys.executable, str(REPORT_PATH), "--junit", str(junit), "--lists-dir", str(directory)], + check=False, + capture_output=True, + text=True, + ) + + self.assertEqual(result.returncode, 1) + self.assertIn("1 timeout(s)", result.stdout) + + +if __name__ == "__main__": + unittest.main() diff --git a/scripts/s3-tests/unimplemented_tests.txt b/scripts/s3-tests/unimplemented_tests.txt index 5db63e3a7..cb7f3d644 100644 --- a/scripts/s3-tests/unimplemented_tests.txt +++ b/scripts/s3-tests/unimplemented_tests.txt @@ -11,8 +11,12 @@ # Failed tests test_bucket_create_delete_bucket_ownership +test_bucket_logging_request_id test_create_bucket_no_ownership_controls test_bucket_logging_owner +test_head_object_404_with_policy_prefix +test_multipart_reupload_checksum_and_etag +test_multipart_upload_complete_without_create test_object_copy_not_owned_bucket test_bucket_policy_multipart test_post_object_upload_checksum From ab5d433fe1794546456255eb25d67f84961ad11e Mon Sep 17 00:00:00 2001 From: Zhengchao An Date: Sat, 22 Aug 2026 07:07:29 +0800 Subject: [PATCH 03/10] feat(connect): add registration and credential rotation (#6353) --- Cargo.lock | 1 + Cargo.toml | 1 + .../agent/v1/fixtures/auth/MANIFEST.sha256 | 5 +- .../agent/v1/fixtures/auth/error-codes.json | 20 +- .../v1/fixtures/auth/rotation-proof.json | 306 ++++++ .../v1/fixtures/auth/surface-separation.json | 2 +- protocol/agent/v1/fixtures/fixture-sets.json | 2 +- rustfs/Cargo.toml | 1 + rustfs/src/connect/client.rs | 566 +++++++++++ rustfs/src/connect/credential_store.rs | 370 +++++++ rustfs/src/connect/identity.rs | 8 +- rustfs/src/connect/identity_store.rs | 131 ++- rustfs/src/connect/mod.rs | 6 + rustfs/src/connect/registration.rs | 527 ++++++++++ rustfs/tests/connect_registration.rs | 911 ++++++++++++++++++ 15 files changed, 2828 insertions(+), 29 deletions(-) create mode 100644 protocol/agent/v1/fixtures/auth/rotation-proof.json create mode 100644 rustfs/src/connect/client.rs create mode 100644 rustfs/src/connect/credential_store.rs create mode 100644 rustfs/src/connect/registration.rs create mode 100644 rustfs/tests/connect_registration.rs diff --git a/Cargo.lock b/Cargo.lock index 312fc1376..2cb35c808 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -9257,6 +9257,7 @@ dependencies = [ "url", "urlencoding", "uuid", + "x509-parser", "zeroize", "zip", "zstd", diff --git a/Cargo.toml b/Cargo.toml index 652e931e2..918af3cce 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -204,6 +204,7 @@ rsa = { version = "=0.10.0-rc.18" } rustls = { default-features = false, version = "0.23.43" } rustls-native-certs = "0.8" rustls-pki-types = "1.15.1" +x509-parser = "0.18.1" sha1 = "0.11.0" sha2 = "0.11.0" subtle = "2.6" diff --git a/protocol/agent/v1/fixtures/auth/MANIFEST.sha256 b/protocol/agent/v1/fixtures/auth/MANIFEST.sha256 index f43d5f192..6df7052ef 100644 --- a/protocol/agent/v1/fixtures/auth/MANIFEST.sha256 +++ b/protocol/agent/v1/fixtures/auth/MANIFEST.sha256 @@ -1,5 +1,6 @@ 3d602080f7ca4c32ba9e37ad1a32665c78560726b30aeee08fd9e95eb2f36194 accept-vectors.json d3c19946288717088145592e0e8d6f2fa684443ba2f73d4c7bc49c415d6dd051 certificate-profile.json -060485263c51003274c056a0e04bec1b7d76157cf599ba79eebe040bc7cee71b error-codes.json +299a2ae34a8ca74bcf31deeb53a08f9eff279efa09d3f5358a0cf10866fe1a5d error-codes.json 43fe297ffb512b1b9f4af62f1832f3aa3905157893bfdc3dcc6d56f5a98aaef6 reject-vectors.json -b946175b094f4a8d75091b652fbe3d4327c9c795f28e02c96e1ab90a429e418d surface-separation.json +0cf26a7332fa6e3f57390e081f2cceead3236f6ca57f7038e3b55c2582af1733 rotation-proof.json +7c07100460fa23fca482466df9ca22f91c7f26b36087a7207a001f7d987f527e surface-separation.json diff --git a/protocol/agent/v1/fixtures/auth/error-codes.json b/protocol/agent/v1/fixtures/auth/error-codes.json index 6a934b139..1af792add 100644 --- a/protocol/agent/v1/fixtures/auth/error-codes.json +++ b/protocol/agent/v1/fixtures/auth/error-codes.json @@ -2,7 +2,7 @@ "protocolVersion": "v1", "fixtureSet": "auth", "fixture": "error-codes", - "description": "Frozen ErrorInfo reasons for agent authentication and negotiation. Clients branch on status and reason, never on message.", + "description": "Frozen ErrorInfo reasons for agent authentication, negotiation, and credential-rotation authorization. Clients branch on status and reason, never on message.", "domain": "rustfs.connect", "detailType": "type.googleapis.com/google.rpc.ErrorInfo", "disclosureRules": [ @@ -81,6 +81,24 @@ "httpStatus": 401, "status": "UNAUTHENTICATED", "meaning": "A browser session cookie was presented to an authenticated agent operation. The agent surface never accepts it." + }, + { + "reason": "ROTATION_CREDENTIAL_NOT_CURRENT", + "httpStatus": 409, + "status": "ABORTED", + "meaning": "The authenticated certificate is valid for ordinary agent operations but is not the device's current ACTIVE credential and therefore cannot authorize another rotation." + }, + { + "reason": "ROTATION_REQUEST_CONFLICT", + "httpStatus": 409, + "status": "ABORTED", + "meaning": "The requestId already belongs to a rotation with different transcript inputs and cannot be reused." + }, + { + "reason": "ROTATION_PROOF_INVALID", + "httpStatus": 401, + "status": "UNAUTHENTICATED", + "meaning": "The credential proof does not verify over the canonical rotation transcript under the presented certificate key." } ] } diff --git a/protocol/agent/v1/fixtures/auth/rotation-proof.json b/protocol/agent/v1/fixtures/auth/rotation-proof.json new file mode 100644 index 000000000..a65b83a30 --- /dev/null +++ b/protocol/agent/v1/fixtures/auth/rotation-proof.json @@ -0,0 +1,306 @@ +{ + "protocolVersion": "v1", + "fixtureSet": "auth", + "fixture": "rotation-proof", + "description": "Frozen proof-of-possession transcript for rotating an online device credential. The current certificate key authorizes one new certificate request for one device and one idempotent request.", + "operation": { + "method": "POST", + "path": "/agent/clusterDevices/{device}:rotateCredential", + "operationId": "rotateClusterDeviceCredential", + "authenticatedSurface": "/agent/*", + "currentCredentialRequiredForNewRotation": true, + "outgoingOverlapCredentialMayAuthenticateOrdinaryOperations": true, + "outgoingOverlapCredentialMayRotate": false, + "outgoingOverlapCredentialMayReplayItsCompletedRotation": true + }, + "replayPolicy": { + "recordState": "COMPLETED", + "bindingFields": [ + "currentCertificateFingerprint", + "clusterDeviceName", + "requestId", + "certificateRequestSha256" + ], + "exactMatch": "returnStoredResult", + "mismatchReason": "ROTATION_REQUEST_CONFLICT", + "retentionLowerBound": "outgoingCredential.validUntil", + "sideEffects": "No issuer call, credential write, or overlap extension." + }, + "completedReplayRecord": { + "state": "COMPLETED", + "currentCertificateFingerprint": "1bc816e2d285c52ee3a0aa06dc7aec17e788626043e795259a67f2436f970d09", + "clusterDeviceName": "organizations/0198f4b0-1a00-7c10-8d21-2e3f4a5b6c70/clusters/0198f4b0-2b00-7d20-9e31-3f4a5b6c7d81/clusterDevices/0198f4b0-3c00-7e30-8f41-4a5b6c7d8e92", + "requestId": "7c5d6e2a-8b91-4f03-a4d5-6e7f8091a2b3", + "certificateRequestSha256": "kVS-bXYxD6F22cZNy4Vnpgb5gFZbr4EGP5GvIz7uOaw", + "resultReference": "credential-rotation-result-01" + }, + "transcript": { + "domain": "RUSTFS-CONNECT-CREDENTIAL-ROTATION-V1", + "domainTerminator": "0x0a", + "fieldSeparator": "0x3a", + "fieldTerminator": "0x0a", + "fieldCount": 4, + "encoding": "US-ASCII", + "normalisationPermitted": false, + "fieldOrder": [ + "currentCertificateFingerprint", + "clusterDeviceName", + "requestId", + "certificateRequestSha256" + ], + "fields": [ + { + "name": "currentCertificateFingerprint", + "position": 1, + "source": "the exact certificate accepted by trusted ingress and resolved by Connect", + "pattern": "^[0-9a-f]{64}$", + "binds": "the one currently active credential authorizing the rotation", + "absenceWouldAllow": "A proof captured from one current certificate to authorize another credential after the device rotated." + }, + { + "name": "clusterDeviceName", + "position": 2, + "source": "the authenticated identity after it is matched to the target resource", + "pattern": "^organizations/[0-9a-f-]{36}/clusters/[0-9a-f-]{36}/clusterDevices/[0-9a-f-]{36}$", + "binds": "the organization, cluster, and device being rotated", + "absenceWouldAllow": "A proof produced by one device to be presented against another device resource." + }, + { + "name": "requestId", + "position": 3, + "source": "the request body", + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", + "binds": "the single idempotent rotation attempt", + "absenceWouldAllow": "A captured proof to be replayed as a fresh attempt instead of the same idempotent request." + }, + { + "name": "certificateRequestSha256", + "position": 4, + "source": "recomputed over the exact PKCS#10 DER octets in certificateRequest", + "pattern": "^[A-Za-z0-9_-]{43}$", + "binds": "the next device public key and certificate request", + "absenceWouldAllow": "A valid proof to be combined with an attacker certificate request." + } + ] + }, + "signature": { + "algorithmField": "proof.algorithm", + "algorithmEnumeration": ["ES256"], + "curve": "P-256", + "signatureEncoding": "fixed-width-r-s", + "signatureLengthBytes": 64, + "signatureTransferEncoding": "base64url-unpadded", + "signatureValuePattern": "^[A-Za-z0-9_-]{86}$", + "lowSRequired": true, + "verifyingKeySource": "the SubjectPublicKeyInfo of the exact presented certificate accepted by trusted ingress", + "newKeyPossession": "the PKCS#10 self-signature is verified separately under the public key inside certificateRequest", + "sharedEncodingContract": "protocol/agent/v1/registration-proof.md#the-signature" + }, + "verificationOrder": [ + { + "stage": "protocolVersion", + "rule": "protocolVersion must be the supported major version.", + "reason": "UNSUPPORTED_PROTOCOL" + }, + { + "stage": "encoding", + "rule": "proof.algorithm and proof.value obey the shared ES256 fixed-width low-S contract.", + "reasons": ["UNSUPPORTED_ALGORITHM", "SIGNATURE_MALFORMED", "SIGNATURE_NOT_CANONICAL"] + }, + { + "stage": "certificateRequest", + "rule": "certificateRequest is one self-signed PKCS#10 request whose public key is P-256.", + "reasons": ["CERTIFICATE_REQUEST_MALFORMED", "DEVICE_KEY_UNSUPPORTED"] + }, + { + "stage": "proof", + "rule": "Connect rebuilds the transcript and verifies proof.value under the presented certificate public key.", + "reason": "ROTATION_PROOF_INVALID" + }, + { + "stage": "replay", + "rule": "A completed record bound to the presented credential, device, requestId, and CSR digest returns its stored result without issuing again. A requestId bound to different transcript inputs is refused.", + "reason": "ROTATION_REQUEST_CONFLICT" + }, + { + "stage": "credential", + "rule": "After replay lookup misses, the authenticated certificate must be the device current ACTIVE credential, not a credential in the outgoing overlap.", + "reason": "ROTATION_CREDENTIAL_NOT_CURRENT" + } + ], + "reasonSources": { + "auth": ["UNSUPPORTED_PROTOCOL", "ROTATION_CREDENTIAL_NOT_CURRENT", "ROTATION_REQUEST_CONFLICT", "ROTATION_PROOF_INVALID"], + "sharedFromRegistration": [ + "UNSUPPORTED_ALGORITHM", + "SIGNATURE_MALFORMED", + "SIGNATURE_NOT_CANONICAL", + "CERTIFICATE_REQUEST_MALFORMED", + "DEVICE_KEY_UNSUPPORTED" + ] + }, + "example": { + "inputs": { + "currentCertificateFingerprint": "1bc816e2d285c52ee3a0aa06dc7aec17e788626043e795259a67f2436f970d09", + "clusterDeviceName": "organizations/0198f4b0-1a00-7c10-8d21-2e3f4a5b6c70/clusters/0198f4b0-2b00-7d20-9e31-3f4a5b6c7d81/clusterDevices/0198f4b0-3c00-7e30-8f41-4a5b6c7d8e92", + "requestId": "7c5d6e2a-8b91-4f03-a4d5-6e7f8091a2b3", + "certificateRequestSha256": "kVS-bXYxD6F22cZNy4Vnpgb5gFZbr4EGP5GvIz7uOaw" + }, + "artifacts": { + "currentPublicKeySpki": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAENEpjuFZTqp0Hxh/OWV3TGkluNjCo15dk+4CozuR6aT9Vaxhkb2M9nhaVGfk8+aSiSIiKFSCsYonKl8jh743Qow==", + "currentPublicKeyFingerprint": "28608e223c75ed89e72041f12afae4fc1cd3f1d3bcca38cbb62d1a41687610c2", + "certificateRequest": "MIIBHjCBxAIBADBiMRswGQYDVQQDDBJpZ25vcmVkLWJ5LWNvbm5lY3QxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAAQWPosvIKr5V3CpTUdLfMQxDx31B3SglLKyqRg/oH3J+PhUnqf7pDWW1sTkP2aRIDjAwRn0DpLrz405CcvGHvYEoAAwCgYIKoZIzj0EAwIDSQAwRgIhAMJzXo/CK4E9BfjOxP35he9LLlqENhK7HTzZQTuIgLX2AiEAwOZHibk5HEijTWcJ/UT117nssfJesWZVOWwz/KTIpi8=", + "otherCertificateRequest": "MIIBHTCBxAIBADBiMRswGQYDVQQDDBJpZ25vcmVkLWJ5LWNvbm5lY3QxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAATi0KiZGcbPJixDiQN/aIVky7xqaYhjmwAn1aozrC2eanaDENYQ3D5zw5qoZNIp8YUk/CETZrba3C5KYR5ocdlLoAAwCgYIKoZIzj0EAwIDSAAwRQIhAL0ZtvWyTSu18RF5J4ZVIuOGjJpJwSdP+87CVxNKJJduAiAahIruc3FLtO3RI7B8Ome8IsVDUpSAQilThjdOeDMsYg==" + }, + "canonicalTranscript": "RUSTFS-CONNECT-CREDENTIAL-ROTATION-V1\n64:1bc816e2d285c52ee3a0aa06dc7aec17e788626043e795259a67f2436f970d09\n148:organizations/0198f4b0-1a00-7c10-8d21-2e3f4a5b6c70/clusters/0198f4b0-2b00-7d20-9e31-3f4a5b6c7d81/clusterDevices/0198f4b0-3c00-7e30-8f41-4a5b6c7d8e92\n36:7c5d6e2a-8b91-4f03-a4d5-6e7f8091a2b3\n43:kVS-bXYxD6F22cZNy4Vnpgb5gFZbr4EGP5GvIz7uOaw\n", + "canonicalTranscriptLengthBytes": 346, + "canonicalTranscriptSha256": "e5f0e9cd0d5d420bc7e51217512de76e1cf4dceb1d67804b6518c4fb5d9fe434" + }, + "acceptVectors": [ + { + "name": "current credential authorizes one new certificate request", + "requestId": "7c5d6e2a-8b91-4f03-a4d5-6e7f8091a2b3", + "proof": "vgz7Hm-xZ5JQ7B3oqUEKXB4tQxEzWZ988iPxAklaIZIsd4nSTUv5YriqES5yKGHvKOgWPyWjvrgI0j0T-fYEsQ", + "expected": {"accepted": true, "reason": null, "stage": "credential", "replayed": false} + }, + { + "name": "the same certificate request under a new requestId needs its own proof", + "requestId": "82e1f3a4-9b05-4c67-8d90-1e2f3a4b5c6d", + "proof": "s-rkF9w41sqgdQNkOlhjcLYlrNHN_HL5xh4C3k_1a9ZQu7Uq0LoET_x7i4Rw3xQ75ec6B6tfqZ3XsHTS0FfN7Q", + "expected": {"accepted": true, "reason": null, "stage": "credential", "replayed": false} + }, + { + "name": "outgoing credential replays its completed byte-equivalent rotation", + "requestId": "7c5d6e2a-8b91-4f03-a4d5-6e7f8091a2b3", + "proof": "vgz7Hm-xZ5JQ7B3oqUEKXB4tQxEzWZ988iPxAklaIZIsd4nSTUv5YriqES5yKGHvKOgWPyWjvrgI0j0T-fYEsQ", + "replayRecord": "completedExample", + "mutation": {"currentCredential": false}, + "expected": {"accepted": true, "reason": null, "stage": "replay", "replayedResultReference": "credential-rotation-result-01"} + } + ], + "rejectVectors": [ + { + "name": "outgoing overlap credential attempts another rotation", + "stage": "credential", + "requestId": "82e1f3a4-9b05-4c67-8d90-1e2f3a4b5c6d", + "proof": "s-rkF9w41sqgdQNkOlhjcLYlrNHN_HL5xh4C3k_1a9ZQu7Uq0LoET_x7i4Rw3xQ75ec6B6tfqZ3XsHTS0FfN7Q", + "mutation": {"currentCredential": false}, + "expected": {"accepted": false, "reason": "ROTATION_CREDENTIAL_NOT_CURRENT"} + }, + { + "name": "rotation declares protocol v2", + "stage": "protocolVersion", + "mutation": {"protocolVersion": "v2"}, + "expected": {"accepted": false, "reason": "UNSUPPORTED_PROTOCOL"} + }, + { + "name": "proof declares ES384", + "stage": "encoding", + "mutation": {"proofAlgorithm": "ES384"}, + "expected": {"accepted": false, "reason": "UNSUPPORTED_ALGORITHM"} + }, + { + "name": "DER encoded proof", + "stage": "encoding", + "mutation": {"proofValue": "MEUCIQC-DPseb7FnklDsHeipQQpcHi1DETNZn3zyI_ECSVohkgIgLHeJ0k1L-WK4qhEucihh7yjoFj8lo764CNI9E_n2BLE"}, + "expected": {"accepted": false, "reason": "SIGNATURE_MALFORMED"} + }, + { + "name": "padded base64url proof", + "stage": "encoding", + "mutation": {"proofValue": "vgz7Hm-xZ5JQ7B3oqUEKXB4tQxEzWZ988iPxAklaIZIsd4nSTUv5YriqES5yKGHvKOgWPyWjvrgI0j0T-fYEsQ=="}, + "expected": {"accepted": false, "reason": "SIGNATURE_MALFORMED"} + }, + { + "name": "protocol negotiation precedes proof encoding and stale credential state", + "stage": "protocolVersion", + "mutation": {"currentCredential": false, "protocolVersion": "v2", "proofValue": "not-a-signature"}, + "expected": {"accepted": false, "reason": "UNSUPPORTED_PROTOCOL"} + }, + { + "name": "declared algorithm precedes signature bytes", + "stage": "encoding", + "mutation": {"proofAlgorithm": "ES384", "proofValue": "not-a-signature"}, + "expected": {"accepted": false, "reason": "UNSUPPORTED_ALGORITHM"} + }, + { + "name": "malleated high-S proof", + "stage": "encoding", + "mutation": {"proofValue": "vgz7Hm-xZ5JQ7B3oqUEKXB4tQxEzWZ988iPxAklaIZLTiHYssrQGnkdV7tGN154Qk_7kboFz38zq542vAm0goA"}, + "expected": {"accepted": false, "reason": "SIGNATURE_NOT_CANONICAL"} + }, + { + "name": "proof over the rotation fields uses the registration domain", + "stage": "proof", + "mutation": {"proofValue": "as27GKXEKXtym-BU8NUl0BYhJkEUooZWPadrxwOWa40pAaN6p4VxKCCFggZl4ZQsl5CUtaMoMaxM_HzT1c1qUA"}, + "expected": {"accepted": false, "reason": "ROTATION_PROOF_INVALID"} + }, + { + "name": "proof verification precedes stale credential state", + "stage": "proof", + "mutation": {"currentCredential": false, "proofValue": "as27GKXEKXtym-BU8NUl0BYhJkEUooZWPadrxwOWa40pAaN6p4VxKCCFggZl4ZQsl5CUtaMoMaxM_HzT1c1qUA"}, + "expected": {"accepted": false, "reason": "ROTATION_PROOF_INVALID"} + }, + { + "name": "new certificate request key signs instead of the current credential key", + "stage": "proof", + "mutation": {"proofValue": "QEN8wMQQk5HjriDw2aeAxIfsRvrWgIjGR3KlpK81Y34kaTAacO-6_bOMAjQ0hMMIk-YYN6MDCw0Via_Ri0X0BA"}, + "expected": {"accepted": false, "reason": "ROTATION_PROOF_INVALID"} + }, + { + "name": "proof is moved to another current certificate", + "stage": "proof", + "mutation": {"currentCertificateFingerprint": "2bc816e2d285c52ee3a0aa06dc7aec17e788626043e795259a67f2436f970d09"}, + "expected": {"accepted": false, "reason": "ROTATION_PROOF_INVALID"} + }, + { + "name": "proof is moved to another device", + "stage": "proof", + "mutation": {"clusterDeviceName": "organizations/0198f4b0-1a00-7c10-8d21-2e3f4a5b6c70/clusters/0198f4b0-2b00-7d20-9e31-3f4a5b6c7d81/clusterDevices/0198f4b0-3c00-7e30-8f41-4a5b6c7d8e93"}, + "expected": {"accepted": false, "reason": "ROTATION_PROOF_INVALID"} + }, + { + "name": "proof is replayed under another requestId", + "stage": "proof", + "mutation": {"requestId": "82e1f3a4-9b05-4c67-8d90-1e2f3a4b5c6d"}, + "expected": {"accepted": false, "reason": "ROTATION_PROOF_INVALID"} + }, + { + "name": "proof is combined with another certificate request", + "stage": "proof", + "mutation": {"certificateRequest": "otherCertificateRequest"}, + "expected": {"accepted": false, "reason": "ROTATION_PROOF_INVALID"} + }, + { + "name": "completed replay belongs to another certificate fingerprint", + "stage": "replay", + "replayRecord": "completedExample", + "replayRecordMutation": {"currentCertificateFingerprint": "2bc816e2d285c52ee3a0aa06dc7aec17e788626043e795259a67f2436f970d09"}, + "mutation": {"currentCredential": false}, + "expected": {"accepted": false, "reason": "ROTATION_REQUEST_CONFLICT"} + }, + { + "name": "completed replay belongs to another device", + "stage": "replay", + "replayRecord": "completedExample", + "replayRecordMutation": {"clusterDeviceName": "organizations/0198f4b0-1a00-7c10-8d21-2e3f4a5b6c70/clusters/0198f4b0-2b00-7d20-9e31-3f4a5b6c7d81/clusterDevices/0198f4b0-3c00-7e30-8f41-4a5b6c7d8e93"}, + "mutation": {"currentCredential": false}, + "expected": {"accepted": false, "reason": "ROTATION_REQUEST_CONFLICT"} + }, + { + "name": "completed replay belongs to another requestId", + "stage": "replay", + "replayRecord": "completedExample", + "replayRecordMutation": {"requestId": "82e1f3a4-9b05-4c67-8d90-1e2f3a4b5c6d"}, + "mutation": {"currentCredential": false}, + "expected": {"accepted": false, "reason": "ROTATION_REQUEST_CONFLICT"} + }, + { + "name": "completed replay belongs to another CSR digest", + "stage": "replay", + "replayRecord": "completedExample", + "replayRecordMutation": {"certificateRequestSha256": "PXxfNGWtIbrqVocag6lOLDDR41AjpHXJ7UcAWkbTSAs"}, + "mutation": {"currentCredential": false}, + "expected": {"accepted": false, "reason": "ROTATION_REQUEST_CONFLICT"} + } + ] +} diff --git a/protocol/agent/v1/fixtures/auth/surface-separation.json b/protocol/agent/v1/fixtures/auth/surface-separation.json index 4d3f8a895..611a42cab 100644 --- a/protocol/agent/v1/fixtures/auth/surface-separation.json +++ b/protocol/agent/v1/fixtures/auth/surface-separation.json @@ -49,7 +49,7 @@ "schemeType": "mutualTLS", "forbiddenSecuritySchemes": ["sessionCookie"], "defaultSecurity": ["agentMutualTls"], - "publicOperations": ["getProtocolStatus"] + "publicOperations": ["getProtocolStatus", "exchangeRegistrationToken"] }, { "document": "openapi/control.json", diff --git a/protocol/agent/v1/fixtures/fixture-sets.json b/protocol/agent/v1/fixtures/fixture-sets.json index 5ded06740..d3beb8f23 100644 --- a/protocol/agent/v1/fixtures/fixture-sets.json +++ b/protocol/agent/v1/fixtures/fixture-sets.json @@ -11,7 +11,7 @@ { "name": "auth", "status": "populated", - "purpose": "Client certificate profile, RFC 9440 header profile, authentication accept and reject vectors, surface separation, and the frozen error reason registry." + "purpose": "Client certificate profile, RFC 9440 header profile, authentication and credential-rotation proof vectors, surface separation, and the frozen error reason registry." }, { "name": "version", diff --git a/rustfs/Cargo.toml b/rustfs/Cargo.toml index 206d9dfcc..28f4ad259 100644 --- a/rustfs/Cargo.toml +++ b/rustfs/Cargo.toml @@ -288,6 +288,7 @@ zstd.workspace = true # Cryptography and Security rustls = { workspace = true, default-features = false, features = ["aws-lc-rs", "logging", "tls12", "prefer-post-quantum", "std"] } rustls-pki-types = { workspace = true } +x509-parser = { workspace = true } subtle = { workspace = true } jiff = { workspace = true, features = ["serde"] } time = { workspace = true, features = ["parsing", "formatting", "serde", "macros"] } diff --git a/rustfs/src/connect/client.rs b/rustfs/src/connect/client.rs new file mode 100644 index 000000000..a13ec953d --- /dev/null +++ b/rustfs/src/connect/client.rs @@ -0,0 +1,566 @@ +// Copyright 2024 RustFS Team +// +// Licensed 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 std::time::Duration; + +use base64::Engine as _; +use reqwest::{Client, StatusCode, Url}; +use rustls::RootCertStore; +use rustls::pki_types::{CertificateDer, pem::PemObject as _}; +use serde::Deserialize; +use uuid::Uuid; +use zeroize::Zeroizing; + +use super::credential_store::{ + CompletedRegistration, CredentialStore, CredentialStoreError, DeviceCredential, PendingRegistration, PendingRotation, +}; +use super::identity::{IdentityError, RegistrationTranscript}; +use super::identity_store::{IdentityStore, StoreError}; +use super::registration::{ + CredentialResponse, CredentialValidationError, ExpectedDevice, RegistrationRequest, RegistrationToken, RotationRequest, + certificate_fingerprint, certificate_request_matches, public_key_fingerprint, validate_credential, + validate_stored_credential, +}; + +const MAX_ATTEMPTS: usize = 3; +const MAX_RESPONSE_BYTES: usize = 1024 * 1024; +const ROTATION_THRESHOLD_SECONDS: i64 = 8 * 60 * 60; + +pub struct ConnectConfig<'a> { + pub endpoint: &'a str, + pub root_ca_pem: &'a [u8], + pub timeout: Duration, +} + +pub struct ConnectClient { + endpoint: Url, + roots: RootCertStore, + root_certificates: Vec>, + client: Client, + timeout: Duration, +} + +impl ConnectClient { + pub fn from_optional_config(config: Option>) -> Result, ClientError> { + config.map(Self::new).transpose() + } + + pub fn new(config: ConnectConfig<'_>) -> Result { + let mut endpoint = Url::parse(config.endpoint).map_err(|_| ClientError::Endpoint)?; + if endpoint.scheme() != "https" + || endpoint.cannot_be_a_base() + || !endpoint.username().is_empty() + || endpoint.password().is_some() + || endpoint.query().is_some() + || endpoint.fragment().is_some() + { + return Err(ClientError::Endpoint); + } + if !endpoint.path().ends_with('/') { + let path = format!("{}/", endpoint.path()); + endpoint.set_path(&path); + } + + let root_certificates = CertificateDer::pem_slice_iter(config.root_ca_pem) + .collect::, _>>() + .map_err(|_| ClientError::RootCertificate)?; + if root_certificates.is_empty() { + return Err(ClientError::RootCertificate); + } + let mut roots = RootCertStore::empty(); + let (accepted, rejected) = roots.add_parsable_certificates(root_certificates.clone()); + if accepted != root_certificates.len() || rejected != 0 { + return Err(ClientError::RootCertificate); + } + + let client = build_client(&root_certificates, config.timeout, None)?; + Ok(Self { + endpoint, + roots, + root_certificates, + client, + timeout: config.timeout, + }) + } + + pub async fn register( + &self, + identity_store: &IdentityStore, + credential_store: &CredentialStore, + token: &RegistrationToken, + ) -> Result { + let _lock = credential_store.lock().await?; + if let Some((credential, _)) = self.load_valid_credential(identity_store, credential_store)? { + ensure_credential_time(&credential, unix_now())?; + return Ok(credential); + } + + let identity = identity_store.load_or_create()?; + let candidate = PendingRegistration { + token_uid: token.registration_token_uid.clone(), + request_id: Uuid::new_v4().to_string(), + certificate_request: identity.certificate_request_base64()?, + previous_credential_fingerprint: None, + next_public_key_sha256: None, + }; + let pending = credential_store.claim_pending_registration(&candidate)?; + if pending.token_uid != token.registration_token_uid + || pending.previous_credential_fingerprint.is_some() + || pending.next_public_key_sha256.is_some() + || !is_request_id(&pending.request_id) + || !certificate_request_matches(&pending.certificate_request, &identity)? + { + return Err(ClientError::PendingRegistration); + } + + let credential = match self.exchange_registration(token, &pending, &identity).await { + Ok(credential) => credential, + Err(error @ (ClientError::AccessRevoked { .. } | ClientError::Rejected { .. })) => { + credential_store.clear_pending_registration()?; + return Err(error); + } + Err(error) => return Err(error), + }; + credential_store.save(&credential)?; + credential_store.clear_pending_registration()?; + Ok(credential) + } + + pub async fn reenroll( + &self, + identity_store: &IdentityStore, + credential_store: &CredentialStore, + token: &RegistrationToken, + ) -> Result { + let _lock = credential_store.lock().await?; + let (credential, _) = self + .load_valid_credential(identity_store, credential_store)? + .ok_or(ClientError::NotRegistered)?; + let fingerprint = certificate_fingerprint(&credential.certificate)?; + if credential_store.load_completed_registration()?.is_some_and(|completed| { + completed.token_uid == token.registration_token_uid && completed.credential_fingerprint == fingerprint + }) { + return Ok(credential); + } + credential_store.clear_pending_rotation()?; + let next = identity_store.load_or_create_next()?; + let next_fingerprint = public_key_fingerprint(&next); + let candidate = PendingRegistration { + token_uid: token.registration_token_uid.clone(), + request_id: Uuid::new_v4().to_string(), + certificate_request: next.certificate_request_base64()?, + previous_credential_fingerprint: Some(fingerprint.clone()), + next_public_key_sha256: Some(next_fingerprint.clone()), + }; + let pending = credential_store.claim_pending_registration(&candidate)?; + if pending.token_uid != token.registration_token_uid + || pending.previous_credential_fingerprint.as_deref() != Some(&fingerprint) + || pending.next_public_key_sha256.as_deref() != Some(&next_fingerprint) + || !is_request_id(&pending.request_id) + || !certificate_request_matches(&pending.certificate_request, &next)? + { + return Err(ClientError::PendingRegistration); + } + let enrolled = match self.exchange_registration(token, &pending, &next).await { + Ok(credential) => credential, + Err(error @ (ClientError::AccessRevoked { .. } | ClientError::Rejected { .. })) => { + credential_store.clear_pending_registration()?; + identity_store.clear_next()?; + return Err(error); + } + Err(error) => return Err(error), + }; + credential_store.save(&enrolled)?; + identity_store.commit_next(&next)?; + credential_store.save_completed_registration(&CompletedRegistration { + token_uid: token.registration_token_uid.clone(), + credential_fingerprint: certificate_fingerprint(&enrolled.certificate)?, + })?; + credential_store.clear_pending_registration()?; + Ok(enrolled) + } + + async fn exchange_registration( + &self, + token: &RegistrationToken, + pending: &PendingRegistration, + identity: &super::identity::DeviceIdentity, + ) -> Result { + let csr_der = base64::engine::general_purpose::STANDARD + .decode(&pending.certificate_request) + .map_err(|_| ClientError::PendingRegistration)?; + let transcript = RegistrationTranscript::build( + &token.registration_token_uid, + &token.organization_uid, + &token.cluster_uid, + &pending.request_id, + &token.challenge_nonce, + token.expires_unix, + &csr_der, + )?; + let proof = identity.sign_registration(&transcript); + let body = RegistrationRequest::new(token, &pending.request_id, &pending.certificate_request, &proof); + let url = self.url("./registrationTokens:exchange")?; + let response = self + .send(StatusCode::CREATED, || self.client.post(url.clone()).json(&body)) + .await?; + let cluster = format!("organizations/{}/clusters/{}", token.organization_uid, token.cluster_uid); + let credential = validate_credential( + response, + identity, + &self.roots, + &self.root_certificates, + ExpectedDevice::Registration { cluster: &cluster }, + )?; + Ok(credential) + } + + pub async fn rotate_if_due( + &self, + identity_store: &IdentityStore, + credential_store: &CredentialStore, + now_unix: i64, + ) -> Result, ClientError> { + let _lock = credential_store.lock().await?; + let (credential, identity) = self + .load_valid_credential(identity_store, credential_store)? + .ok_or(ClientError::NotRegistered)?; + if credential_store.load_pending_registration()?.is_some() { + return Err(ClientError::PendingRegistration); + } + ensure_credential_time(&credential, now_unix)?; + if credential.not_after_unix - now_unix > ROTATION_THRESHOLD_SECONDS { + return Ok(None); + } + let fingerprint = certificate_fingerprint(&credential.certificate)?; + let next = identity_store.load_or_create_next()?; + let candidate = PendingRotation { + credential_fingerprint: fingerprint.clone(), + device_name: credential.name.clone(), + request_id: Uuid::new_v4().to_string(), + certificate_request: next.certificate_request_base64()?, + next_public_key_sha256: public_key_fingerprint(&next), + }; + let pending = credential_store.claim_pending_rotation(&candidate)?; + if pending.credential_fingerprint != fingerprint + || pending.device_name != credential.name + || !is_request_id(&pending.request_id) + || pending.next_public_key_sha256 != public_key_fingerprint(&next) + || !certificate_request_matches(&pending.certificate_request, &next)? + { + return Err(ClientError::PendingRotation); + } + let body = RotationRequest::new( + &identity, + &fingerprint, + &credential.name, + &pending.request_id, + &pending.certificate_request, + )?; + let private_key = identity.to_pkcs8_pem()?; + let mut identity_pem = Zeroizing::new(Vec::with_capacity(credential.certificate_chain.len() + private_key.len() + 1)); + identity_pem.extend_from_slice(credential.certificate_chain.as_bytes()); + identity_pem.push(b'\n'); + identity_pem.extend_from_slice(private_key.as_bytes()); + let tls_identity = reqwest::Identity::from_pem(&identity_pem).map_err(|_| ClientError::IdentityCertificate)?; + let client = build_client(&self.root_certificates, self.timeout, Some(tls_identity))?; + let path = format!("clusterDevices/{}:rotateCredential", credential.uid); + let url = self.url(&path)?; + let response = self.send(StatusCode::OK, || client.post(url.clone()).json(&body)).await?; + let rotated = validate_credential( + response, + &next, + &self.roots, + &self.root_certificates, + ExpectedDevice::Rotation { name: &credential.name }, + )?; + if rotated.name != credential.name || rotated.uid != credential.uid { + return Err(ClientError::Credential(CredentialValidationError::Identity)); + } + credential_store.save(&rotated)?; + identity_store.commit_next(&next)?; + credential_store.clear_pending_rotation()?; + Ok(Some(rotated)) + } + + fn load_valid_credential( + &self, + identity_store: &IdentityStore, + credential_store: &CredentialStore, + ) -> Result, ClientError> { + let Some(credential) = credential_store.load()? else { + return Ok(None); + }; + let current = identity_store.load()?.ok_or(ClientError::IdentityMissing)?; + if let Some(pending) = credential_store.load_pending_registration()? { + let Some(previous) = pending.previous_credential_fingerprint.as_deref() else { + if pending.next_public_key_sha256.is_some() + || !is_request_id(&pending.request_id) + || !certificate_request_matches(&pending.certificate_request, ¤t)? + { + return Err(ClientError::PendingRegistration); + } + validate_stored_credential(&credential, ¤t, &self.roots, &self.root_certificates)?; + credential_store.clear_pending_registration()?; + return Ok(Some((credential, current))); + }; + let next_fingerprint = pending + .next_public_key_sha256 + .as_deref() + .ok_or(ClientError::PendingRegistration)?; + if !is_request_id(&pending.request_id) { + return Err(ClientError::PendingRegistration); + } + let fingerprint = certificate_fingerprint(&credential.certificate)?; + if fingerprint == previous { + validate_stored_credential(&credential, ¤t, &self.roots, &self.root_certificates)?; + let next = identity_store.load_next()?.ok_or(ClientError::PendingRegistration)?; + if public_key_fingerprint(&next) != next_fingerprint + || !certificate_request_matches(&pending.certificate_request, &next)? + { + return Err(ClientError::PendingRegistration); + } + return Ok(Some((credential, current))); + } + if public_key_fingerprint(¤t) == next_fingerprint { + if !certificate_request_matches(&pending.certificate_request, ¤t)? { + return Err(ClientError::PendingRegistration); + } + validate_stored_credential(&credential, ¤t, &self.roots, &self.root_certificates)?; + } else { + let next = identity_store.load_next()?.ok_or(ClientError::PendingRegistration)?; + if public_key_fingerprint(&next) != next_fingerprint + || !certificate_request_matches(&pending.certificate_request, &next)? + { + return Err(ClientError::PendingRegistration); + } + validate_stored_credential(&credential, &next, &self.roots, &self.root_certificates)?; + identity_store.commit_next(&next)?; + } + credential_store.save_completed_registration(&CompletedRegistration { + token_uid: pending.token_uid, + credential_fingerprint: fingerprint, + })?; + credential_store.clear_pending_registration()?; + let current = identity_store.load()?.ok_or(ClientError::IdentityMissing)?; + return Ok(Some((credential, current))); + } + let Some(pending) = credential_store.load_pending_rotation()? else { + validate_stored_credential(&credential, ¤t, &self.roots, &self.root_certificates)?; + return Ok(Some((credential, current))); + }; + let fingerprint = certificate_fingerprint(&credential.certificate)?; + if pending.device_name != credential.name || !is_request_id(&pending.request_id) { + return Err(ClientError::PendingRotation); + } + if fingerprint == pending.credential_fingerprint { + validate_stored_credential(&credential, ¤t, &self.roots, &self.root_certificates)?; + let next = identity_store.load_next()?.ok_or(ClientError::PendingRotation)?; + if pending.next_public_key_sha256 != public_key_fingerprint(&next) + || !certificate_request_matches(&pending.certificate_request, &next)? + { + return Err(ClientError::PendingRotation); + } + return Ok(Some((credential, current))); + } + + if public_key_fingerprint(¤t) == pending.next_public_key_sha256 { + if !certificate_request_matches(&pending.certificate_request, ¤t)? { + return Err(ClientError::PendingRotation); + } + validate_stored_credential(&credential, ¤t, &self.roots, &self.root_certificates)?; + } else { + let next = identity_store.load_next()?.ok_or(ClientError::PendingRotation)?; + if public_key_fingerprint(&next) != pending.next_public_key_sha256 + || !certificate_request_matches(&pending.certificate_request, &next)? + { + return Err(ClientError::PendingRotation); + } + validate_stored_credential(&credential, &next, &self.roots, &self.root_certificates)?; + identity_store.commit_next(&next)?; + } + credential_store.clear_pending_rotation()?; + let current = identity_store.load()?.ok_or(ClientError::IdentityMissing)?; + Ok(Some((credential, current))) + } + + async fn send(&self, success: StatusCode, mut request: F) -> Result + where + F: FnMut() -> reqwest::RequestBuilder, + { + let mut last_status = None; + for attempt in 0..MAX_ATTEMPTS { + match request().send().await { + Ok(response) if response.status() == success => return decode_response(response).await, + Ok(response) if matches!(response.status(), StatusCode::UNAUTHORIZED | StatusCode::FORBIDDEN) => { + let status = response.status(); + let reason = decode_reason(response).await; + return Err(ClientError::AccessRevoked { status, reason }); + } + Ok(response) if matches!(response.status(), StatusCode::REQUEST_TIMEOUT | StatusCode::TOO_MANY_REQUESTS) => { + last_status = Some(response.status()); + } + Ok(response) if response.status().is_client_error() => { + let status = response.status(); + let reason = decode_reason(response).await; + return Err(ClientError::Rejected { status, reason }); + } + Ok(response) if response.status().is_server_error() => { + last_status = Some(response.status()); + } + Ok(response) => { + let status = response.status(); + let reason = decode_reason(response).await; + return Err(ClientError::Rejected { status, reason }); + } + Err(error) if !error.is_timeout() && !error.is_connect() => return Err(ClientError::Transport(error)), + Err(_) => {} + } + + if attempt + 1 < MAX_ATTEMPTS { + tokio::time::sleep(Duration::from_millis(50 * (attempt as u64 + 1))).await; + } + } + Err(ClientError::Unavailable { status: last_status }) + } + + fn url(&self, path: &str) -> Result { + self.endpoint.join(path).map_err(|_| ClientError::Endpoint) + } +} + +fn is_request_id(value: &str) -> bool { + Uuid::parse_str(value).is_ok_and(|uuid| uuid.get_version() == Some(uuid::Version::Random) && uuid.to_string() == value) +} + +fn unix_now() -> i64 { + std::time::SystemTime::now() + .duration_since(std::time::UNIX_EPOCH) + .map_or(0, |duration| duration.as_secs() as i64) +} + +fn ensure_credential_time(credential: &DeviceCredential, now_unix: i64) -> Result<(), ClientError> { + if credential.not_before_unix > now_unix { + return Err(ClientError::CredentialNotYetValid); + } + if credential.not_after_unix <= now_unix { + return Err(ClientError::CredentialExpired); + } + Ok(()) +} + +fn build_client( + roots: &[CertificateDer<'static>], + timeout: Duration, + identity: Option, +) -> Result { + let certificates = roots + .iter() + .map(|root| reqwest::Certificate::from_der(root.as_ref())) + .collect::, _>>()?; + let mut builder = Client::builder() + .https_only(true) + .redirect(reqwest::redirect::Policy::none()) + .timeout(timeout) + .tls_certs_only(certificates); + if let Some(identity) = identity { + builder = builder.identity(identity); + } + builder.build().map_err(ClientError::Transport) +} + +async fn decode_response(mut response: reqwest::Response) -> Result { + let body = read_body(&mut response).await?; + serde_json::from_slice(&body).map_err(|_| ClientError::Response) +} + +async fn read_body(response: &mut reqwest::Response) -> Result, ClientError> { + let mut body = Vec::new(); + while let Some(chunk) = response.chunk().await.map_err(ClientError::Transport)? { + if body.len() + chunk.len() > MAX_RESPONSE_BYTES { + return Err(ClientError::ResponseTooLarge); + } + body.extend_from_slice(&chunk); + } + Ok(body) +} + +#[derive(Deserialize)] +struct ErrorEnvelope { + #[serde(default)] + details: Vec, +} + +#[derive(Deserialize)] +struct ErrorDetail { + #[serde(default)] + reason: String, +} + +async fn decode_reason(mut response: reqwest::Response) -> Option { + let body = read_body(&mut response).await.ok()?; + serde_json::from_slice::(&body) + .ok()? + .details + .into_iter() + .find_map(|detail| (!detail.reason.is_empty()).then_some(detail.reason)) +} + +#[derive(Debug, thiserror::Error)] +pub enum ClientError { + #[error("Connect endpoint must be an HTTPS base URL without credentials, query, or fragment")] + Endpoint, + #[error("Connect root CA configuration is invalid")] + RootCertificate, + #[error( + "Connect registration has a pending attempt for a different token; restore the original protected token configuration" + )] + PendingRegistration, + #[error( + "Connect credential rotation has an unfinished attempt for a different current certificate; inspect the local credential store" + )] + PendingRotation, + #[error("RustFS is not registered with Connect")] + NotRegistered, + #[error("the Connect device private key is missing; restore device.key before using the stored certificate")] + IdentityMissing, + #[error("the Connect device certificate has expired; call ConnectClient::reenroll with a fresh registration token")] + CredentialExpired, + #[error("the Connect device certificate is not yet valid; fix local clock skew or call ConnectClient::reenroll")] + CredentialNotYetValid, + #[error("the stored Connect certificate and device private key cannot form a TLS identity")] + IdentityCertificate, + #[error( + "Connect rejected the device credential with HTTP {status}; reason={reason:?}; call ConnectClient::reenroll with a fresh registration token if revoked" + )] + AccessRevoked { status: StatusCode, reason: Option }, + #[error("Connect rejected the request with HTTP {status}; reason={reason:?}")] + Rejected { status: StatusCode, reason: Option }, + #[error("Connect remained unavailable after bounded retries; last_status={status:?}")] + Unavailable { status: Option }, + #[error("Connect response exceeded the 1 MiB credential-response limit")] + ResponseTooLarge, + #[error("Connect returned an invalid credential response")] + Response, + #[error(transparent)] + Transport(#[from] reqwest::Error), + #[error(transparent)] + Identity(#[from] IdentityError), + #[error(transparent)] + IdentityStore(#[from] StoreError), + #[error(transparent)] + CredentialStore(#[from] CredentialStoreError), + #[error(transparent)] + Credential(#[from] CredentialValidationError), +} diff --git a/rustfs/src/connect/credential_store.rs b/rustfs/src/connect/credential_store.rs new file mode 100644 index 000000000..863ae1096 --- /dev/null +++ b/rustfs/src/connect/credential_store.rs @@ -0,0 +1,370 @@ +// Copyright 2024 RustFS Team +// +// Licensed 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 std::fs; +use std::io::{self, Write as _}; +use std::path::{Path, PathBuf}; +use std::sync::atomic::{AtomicU64, Ordering}; + +use serde::{Deserialize, Serialize}; + +const CREDENTIAL_FILE: &str = "device.crt.json"; +const REGISTRATION_COMPLETED_FILE: &str = "registration.completed.json"; +const REGISTRATION_PENDING_FILE: &str = "registration.pending.json"; +const ROTATION_PENDING_FILE: &str = "rotation.pending.json"; +const LOCK_FILE: &str = ".state.lock"; + +#[cfg(unix)] +const FILE_MODE: u32 = 0o600; + +static STAGING_SEQUENCE: AtomicU64 = AtomicU64::new(0); + +#[derive(Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct DeviceCredential { + pub name: String, + pub uid: String, + pub protocol_version: String, + pub key_id: String, + pub certificate_serial: String, + pub certificate: String, + pub certificate_chain: String, + pub not_before_unix: i64, + pub not_after_unix: i64, +} + +impl std::fmt::Debug for DeviceCredential { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("DeviceCredential") + .field("name", &self.name) + .field("key_id", &self.key_id) + .field("certificate_serial", &self.certificate_serial) + .field("not_after_unix", &self.not_after_unix) + .finish_non_exhaustive() + } +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +#[serde(deny_unknown_fields)] +#[serde(rename_all = "camelCase")] +pub(crate) struct PendingRegistration { + pub token_uid: String, + pub request_id: String, + pub certificate_request: String, + #[serde(default)] + pub previous_credential_fingerprint: Option, + #[serde(default)] + pub next_public_key_sha256: Option, +} + +#[derive(Serialize, Deserialize)] +#[serde(deny_unknown_fields)] +#[serde(rename_all = "camelCase")] +pub(crate) struct CompletedRegistration { + pub token_uid: String, + pub credential_fingerprint: String, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +#[serde(deny_unknown_fields)] +#[serde(rename_all = "camelCase")] +pub(crate) struct PendingRotation { + pub credential_fingerprint: String, + pub device_name: String, + pub request_id: String, + pub certificate_request: String, + pub next_public_key_sha256: String, +} + +#[derive(Debug, thiserror::Error)] +pub enum CredentialStoreError { + #[error("connect credential store I/O failed at {path}: {source}")] + Io { + path: PathBuf, + #[source] + source: io::Error, + }, + + #[error("connect credential data at {path} is invalid: {source}")] + Invalid { + path: PathBuf, + #[source] + source: serde_json::Error, + }, + + #[cfg(unix)] + #[error("connect credential file at {path} has mode {mode:o}, expected {expected:o}")] + Permissions { path: PathBuf, mode: u32, expected: u32 }, +} + +#[derive(Clone, Debug)] +pub struct CredentialStore { + directory: PathBuf, +} + +pub(crate) struct CredentialLock { + _file: fs::File, +} + +impl CredentialStore { + pub fn new(directory: impl Into) -> Self { + Self { + directory: directory.into(), + } + } + + pub(crate) fn load(&self) -> Result, CredentialStoreError> { + self.read(CREDENTIAL_FILE) + } + + pub(crate) async fn lock(&self) -> Result { + let directory = self.directory.clone(); + tokio::task::spawn_blocking(move || { + fs::create_dir_all(&directory).map_err(|source| CredentialStoreError::Io { + path: directory.clone(), + source, + })?; + let path = directory.join(LOCK_FILE); + let mut options = fs::OpenOptions::new(); + options.create(true).truncate(false).read(true).write(true); + #[cfg(unix)] + { + use std::os::unix::fs::OpenOptionsExt as _; + options.mode(FILE_MODE); + } + let file = options.open(&path).map_err(|source| CredentialStoreError::Io { + path: path.clone(), + source, + })?; + check_mode(&path)?; + file.lock().map_err(|source| CredentialStoreError::Io { path, source })?; + Ok(CredentialLock { _file: file }) + }) + .await + .map_err(|source| CredentialStoreError::Io { + path: self.directory.join(LOCK_FILE), + source: io::Error::other(source), + })? + } + + pub(crate) fn save(&self, credential: &DeviceCredential) -> Result<(), CredentialStoreError> { + self.write(CREDENTIAL_FILE, credential) + } + + pub(crate) fn claim_pending_registration( + &self, + pending: &PendingRegistration, + ) -> Result { + self.claim(REGISTRATION_PENDING_FILE, pending) + } + + pub(crate) fn load_pending_registration(&self) -> Result, CredentialStoreError> { + self.read(REGISTRATION_PENDING_FILE) + } + + pub(crate) fn clear_pending_registration(&self) -> Result<(), CredentialStoreError> { + self.remove(REGISTRATION_PENDING_FILE) + } + + pub(crate) fn load_completed_registration(&self) -> Result, CredentialStoreError> { + self.read(REGISTRATION_COMPLETED_FILE) + } + + pub(crate) fn save_completed_registration(&self, completed: &CompletedRegistration) -> Result<(), CredentialStoreError> { + self.write(REGISTRATION_COMPLETED_FILE, completed) + } + + pub(crate) fn load_pending_rotation(&self) -> Result, CredentialStoreError> { + self.read(ROTATION_PENDING_FILE) + } + + pub(crate) fn claim_pending_rotation(&self, pending: &PendingRotation) -> Result { + self.claim(ROTATION_PENDING_FILE, pending) + } + + pub(crate) fn clear_pending_rotation(&self) -> Result<(), CredentialStoreError> { + self.remove(ROTATION_PENDING_FILE) + } + + fn read Deserialize<'de>>(&self, file: &str) -> Result, CredentialStoreError> { + let path = self.directory.join(file); + let bytes = match fs::read(&path) { + Ok(bytes) => bytes, + Err(source) if source.kind() == io::ErrorKind::NotFound => return Ok(None), + Err(source) => return Err(CredentialStoreError::Io { path, source }), + }; + + check_mode(&path)?; + serde_json::from_slice(&bytes) + .map(Some) + .map_err(|source| CredentialStoreError::Invalid { path, source }) + } + + fn write(&self, file: &str, value: &T) -> Result<(), CredentialStoreError> { + let bytes = serde_json::to_vec(value).map_err(|source| CredentialStoreError::Invalid { + path: self.directory.join(file), + source, + })?; + + fs::create_dir_all(&self.directory).map_err(|source| CredentialStoreError::Io { + path: self.directory.clone(), + source, + })?; + + let final_path = self.directory.join(file); + let temp_path = self.stage(file, &bytes)?; + let result = fs::rename(&temp_path, &final_path) + .map_err(|source| CredentialStoreError::Io { + path: final_path, + source, + }) + .and_then(|()| { + fsync_dir(&self.directory).map_err(|source| CredentialStoreError::Io { + path: self.directory.clone(), + source, + }) + }); + + if result.is_err() { + let _ = fs::remove_file(&temp_path); + } + result + } + + fn claim(&self, file: &str, value: &T) -> Result + where + T: Clone + Serialize + for<'de> Deserialize<'de>, + { + if let Some(existing) = self.read(file)? { + return Ok(existing); + } + let bytes = serde_json::to_vec(value).map_err(|source| CredentialStoreError::Invalid { + path: self.directory.join(file), + source, + })?; + fs::create_dir_all(&self.directory).map_err(|source| CredentialStoreError::Io { + path: self.directory.clone(), + source, + })?; + let final_path = self.directory.join(file); + let temp_path = self.stage(file, &bytes)?; + let published = fs::hard_link(&temp_path, &final_path); + let _ = fs::remove_file(&temp_path); + match published { + Ok(()) => { + fsync_dir(&self.directory).map_err(|source| CredentialStoreError::Io { + path: self.directory.clone(), + source, + })?; + Ok(value.clone()) + } + Err(source) if source.kind() == io::ErrorKind::AlreadyExists => { + fsync_dir(&self.directory).map_err(|source| CredentialStoreError::Io { + path: self.directory.clone(), + source, + })?; + self.read(file)?.ok_or_else(|| CredentialStoreError::Io { + path: final_path, + source: io::Error::new(io::ErrorKind::NotFound, "pending state vanished after publication"), + }) + } + Err(source) => Err(CredentialStoreError::Io { + path: final_path, + source, + }), + } + } + + fn stage(&self, file: &str, bytes: &[u8]) -> Result { + loop { + let path = self.directory.join(format!( + ".{file}.{}.{}.tmp", + std::process::id(), + STAGING_SEQUENCE.fetch_add(1, Ordering::Relaxed) + )); + let mut options = fs::OpenOptions::new(); + options.write(true).create_new(true); + #[cfg(unix)] + { + use std::os::unix::fs::OpenOptionsExt as _; + options.mode(FILE_MODE); + } + let mut staging = match options.open(&path) { + Ok(staging) => staging, + Err(source) if source.kind() == io::ErrorKind::AlreadyExists => continue, + Err(source) => return Err(CredentialStoreError::Io { path, source }), + }; + let result = staging + .write_all(bytes) + .and_then(|()| staging.sync_all()) + .map_err(|source| CredentialStoreError::Io { + path: path.clone(), + source, + }) + .and_then(|()| check_mode(&path)); + if let Err(error) = result { + let _ = fs::remove_file(&path); + return Err(error); + } + return Ok(path); + } + } + + fn remove(&self, file: &str) -> Result<(), CredentialStoreError> { + let path = self.directory.join(file); + match fs::remove_file(&path) { + Ok(()) => fsync_dir(&self.directory).map_err(|source| CredentialStoreError::Io { + path: self.directory.clone(), + source, + }), + Err(source) if source.kind() == io::ErrorKind::NotFound => Ok(()), + Err(source) => Err(CredentialStoreError::Io { path, source }), + } + } +} + +#[cfg(unix)] +fn check_mode(path: &Path) -> Result<(), CredentialStoreError> { + use std::os::unix::fs::PermissionsExt as _; + + let mode = fs::metadata(path) + .map_err(|source| CredentialStoreError::Io { + path: path.to_path_buf(), + source, + })? + .permissions() + .mode() + & 0o7777; + if mode != FILE_MODE { + return Err(CredentialStoreError::Permissions { + path: path.to_path_buf(), + mode, + expected: FILE_MODE, + }); + } + Ok(()) +} + +#[cfg(not(unix))] +fn check_mode(_path: &Path) -> Result<(), CredentialStoreError> { + Ok(()) +} + +fn fsync_dir(directory: &Path) -> io::Result<()> { + #[cfg(unix)] + fs::File::open(directory)?.sync_all()?; + #[cfg(not(unix))] + let _ = directory; + Ok(()) +} diff --git a/rustfs/src/connect/identity.rs b/rustfs/src/connect/identity.rs index 64aa79266..2220f4e8c 100644 --- a/rustfs/src/connect/identity.rs +++ b/rustfs/src/connect/identity.rs @@ -24,7 +24,7 @@ use base64::Engine as _; use base64::engine::general_purpose::{STANDARD as BASE64_STANDARD, URL_SAFE_NO_PAD as BASE64_URL_NO_PAD}; use p256::ecdsa::signature::Signer as _; use p256::ecdsa::{Signature, SigningKey}; -use p256::pkcs8::{DecodePrivateKey as _, EncodePrivateKey as _}; +use p256::pkcs8::{DecodePrivateKey as _, EncodePrivateKey as _, LineEnding}; use sha2::{Digest as _, Sha256}; use zeroize::Zeroizing; @@ -213,6 +213,12 @@ impl DeviceIdentity { .map_err(|error| IdentityError::MalformedKey(error.to_string())) } + pub(crate) fn to_pkcs8_pem(&self) -> Result, IdentityError> { + self.signing_key + .to_pkcs8_pem(LineEnding::LF) + .map_err(|error| IdentityError::MalformedKey(error.to_string())) + } + /// Build the PKCS#10 certificate request Connect consumes. /// /// Connect reads the request for its SubjectPublicKeyInfo and its diff --git a/rustfs/src/connect/identity_store.rs b/rustfs/src/connect/identity_store.rs index 2f4e6724e..426c98352 100644 --- a/rustfs/src/connect/identity_store.rs +++ b/rustfs/src/connect/identity_store.rs @@ -32,6 +32,7 @@ use super::identity::{DeviceIdentity, IdentityError}; /// Name of the key file inside the store directory. const KEY_FILE: &str = "device.key"; +const NEXT_KEY_FILE: &str = "device.key.next"; /// Owner read/write only. The key is the device's whole identity. #[cfg(unix)] @@ -94,7 +95,15 @@ impl IdentityStore { /// been enrolled. Reading never creates anything, so an unconfigured /// server can ask without acquiring an identity as a side effect. pub fn load(&self) -> Result, StoreError> { - let path = self.key_path(); + self.load_file(KEY_FILE) + } + + pub(crate) fn load_next(&self) -> Result, StoreError> { + self.load_file(NEXT_KEY_FILE) + } + + fn load_file(&self, file: &str) -> Result, StoreError> { + let path = self.directory.join(file); let der = match fs::read(&path) { Ok(der) => Zeroizing::new(der), @@ -142,11 +151,15 @@ impl IdentityStore { let candidate = DeviceIdentity::generate(); let der = candidate.to_pkcs8_der()?; - match self.publish(&der) { + match self.publish(KEY_FILE, &der) { Ok(()) => Ok(candidate), // Another process published first. Its key is the identity; ours // was never written anywhere and simply goes out of scope. Err(StoreError::Io { source, .. }) if source.kind() == io::ErrorKind::AlreadyExists => { + fsync_dir(&self.directory).map_err(|source| StoreError::Io { + path: self.directory.clone(), + source, + })?; self.load()?.ok_or_else(|| StoreError::Io { path: self.key_path(), source: io::Error::new( @@ -159,35 +172,106 @@ impl IdentityStore { } } + pub(crate) fn load_or_create_next(&self) -> Result { + if let Some(identity) = self.load_next()? { + return Ok(identity); + } + fs::create_dir_all(&self.directory).map_err(|source| StoreError::Io { + path: self.directory.clone(), + source, + })?; + let candidate = DeviceIdentity::generate(); + let der = candidate.to_pkcs8_der()?; + match self.publish(NEXT_KEY_FILE, &der) { + Ok(()) => Ok(candidate), + Err(StoreError::Io { source, .. }) if source.kind() == io::ErrorKind::AlreadyExists => { + fsync_dir(&self.directory).map_err(|source| StoreError::Io { + path: self.directory.clone(), + source, + })?; + self.load_next()?.ok_or_else(|| StoreError::Io { + path: self.directory.join(NEXT_KEY_FILE), + source: io::Error::new(io::ErrorKind::NotFound, "next device key vanished after publication"), + }) + } + Err(error) => Err(error), + } + } + + pub(crate) fn commit_next(&self, expected: &DeviceIdentity) -> Result<(), StoreError> { + let next_path = self.directory.join(NEXT_KEY_FILE); + match fs::rename(&next_path, self.key_path()) { + Ok(()) => fsync_dir(&self.directory).map_err(|source| StoreError::Io { + path: self.directory.clone(), + source, + }), + Err(source) if source.kind() == io::ErrorKind::NotFound => { + let current = self.load()?.ok_or_else(|| StoreError::Io { + path: self.key_path(), + source, + })?; + if current.public_key_der() == expected.public_key_der() { + fsync_dir(&self.directory).map_err(|source| StoreError::Io { + path: self.directory.clone(), + source, + }) + } else { + Err(StoreError::Io { + path: next_path, + source: io::Error::new(io::ErrorKind::NotFound, "next device key is missing"), + }) + } + } + Err(source) => Err(StoreError::Io { path: next_path, source }), + } + } + + pub(crate) fn clear_next(&self) -> Result<(), StoreError> { + let path = self.directory.join(NEXT_KEY_FILE); + match fs::remove_file(&path) { + Ok(()) => fsync_dir(&self.directory).map_err(|source| StoreError::Io { + path: self.directory.clone(), + source, + }), + Err(source) if source.kind() == io::ErrorKind::NotFound => Ok(()), + Err(source) => Err(StoreError::Io { path, source }), + } + } + /// Write, seal, fsync, then link into place and fsync the directory. The /// key is durable before it is reachable, and it is reachable only once. - fn publish(&self, der: &[u8]) -> Result<(), StoreError> { + fn publish(&self, file: &str, der: &[u8]) -> Result<(), StoreError> { use std::io::Write as _; - let final_path = self.key_path(); - let temp_path = self.directory.join(format!( - "{KEY_FILE}.{}.{}.tmp", - std::process::id(), - STAGING_SEQUENCE.fetch_add(1, Ordering::Relaxed) - )); + let final_path = self.directory.join(file); let io_at = |path: &Path| { let path = path.to_path_buf(); move |source| StoreError::Io { path, source } }; - let mut options = fs::OpenOptions::new(); - options.write(true).create(true).truncate(true); - #[cfg(unix)] - { - use std::os::unix::fs::OpenOptionsExt as _; - options.mode(KEY_MODE); - } - - let mut file = options.open(&temp_path).map_err(io_at(&temp_path))?; + let (temp_path, mut staging) = loop { + let temp_path = self.directory.join(format!( + ".{file}.{}.{}.tmp", + std::process::id(), + STAGING_SEQUENCE.fetch_add(1, Ordering::Relaxed) + )); + let mut options = fs::OpenOptions::new(); + options.write(true).create_new(true); + #[cfg(unix)] + { + use std::os::unix::fs::OpenOptionsExt as _; + options.mode(KEY_MODE); + } + match options.open(&temp_path) { + Ok(staging) => break (temp_path, staging), + Err(source) if source.kind() == io::ErrorKind::AlreadyExists => continue, + Err(source) => return Err(io_at(&temp_path)(source)), + } + }; let result = (|| -> Result<(), StoreError> { - file.write_all(der).map_err(io_at(&temp_path))?; + staging.write_all(der).map_err(io_at(&temp_path))?; // The umask can only narrow the creation mode, so set and verify // the exact mode before the bytes become durable. @@ -195,9 +279,10 @@ impl IdentityStore { { use std::os::unix::fs::PermissionsExt as _; - file.set_permissions(fs::Permissions::from_mode(KEY_MODE)) + staging + .set_permissions(fs::Permissions::from_mode(KEY_MODE)) .map_err(io_at(&temp_path))?; - let mode = file.metadata().map_err(io_at(&temp_path))?.permissions().mode() & 0o7777; + let mode = staging.metadata().map_err(io_at(&temp_path))?.permissions().mode() & 0o7777; if mode != KEY_MODE { return Err(StoreError::Permissions { path: temp_path.clone(), @@ -207,11 +292,11 @@ impl IdentityStore { } } - file.sync_all().map_err(io_at(&temp_path))?; + staging.sync_all().map_err(io_at(&temp_path))?; Ok(()) })(); - drop(file); + drop(staging); if let Err(error) = result { let _ = fs::remove_file(&temp_path); diff --git a/rustfs/src/connect/mod.rs b/rustfs/src/connect/mod.rs index 8506055f2..350cceb38 100644 --- a/rustfs/src/connect/mod.rs +++ b/rustfs/src/connect/mod.rs @@ -25,10 +25,16 @@ //! not been enrolled into a Connect control plane never calls into it, so an //! unconfigured server generates no key and holds no identity. +pub mod client; +pub mod credential_store; pub mod identity; pub mod identity_store; pub mod offline; +pub mod registration; +pub use client::{ClientError, ConnectClient, ConnectConfig}; +pub use credential_store::{CredentialStore, DeviceCredential}; pub use identity::{DeviceIdentity, IdentityError, RegistrationProof, RegistrationTranscript}; pub use identity_store::{IdentityStore, StoreError}; pub use offline::{EnrollmentError, OfflineEnrollment, OfflineKeyStore, VerifiedChallenge}; +pub use registration::{RegistrationToken, TokenError}; diff --git a/rustfs/src/connect/registration.rs b/rustfs/src/connect/registration.rs new file mode 100644 index 000000000..0dbdbe122 --- /dev/null +++ b/rustfs/src/connect/registration.rs @@ -0,0 +1,527 @@ +// Copyright 2024 RustFS Team +// +// Licensed 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 std::io::Read; +use std::sync::Arc; + +use base64::Engine as _; +use base64::engine::general_purpose::URL_SAFE_NO_PAD as BASE64_URL_NO_PAD; +use p256::ecdsa::signature::Signer as _; +use p256::ecdsa::{Signature, SigningKey}; +use p256::pkcs8::DecodePrivateKey as _; +use rustls::RootCertStore; +use rustls::pki_types::{CertificateDer, UnixTime, pem::PemObject as _}; +use rustls::server::WebPkiClientVerifier; +use serde::{Deserialize, Serialize}; +use sha2::{Digest as _, Sha256}; +use time::OffsetDateTime; +use time::format_description::well_known::Rfc3339; +use uuid::{Uuid, Version}; +use x509_parser::extensions::GeneralName; +use x509_parser::oid_registry::OID_SIG_ECDSA_WITH_SHA256; +use x509_parser::prelude::{FromDer as _, X509Certificate, X509CertificationRequest}; +use zeroize::Zeroizing; + +use super::credential_store::DeviceCredential; +use super::identity::{DeviceIdentity, RegistrationProof}; + +pub const PROTOCOL_VERSION: &str = "v1"; + +const CERTIFICATE_LIFETIME_SECONDS: i64 = 86_400; +const ROTATION_DOMAIN: &[u8] = b"RUSTFS-CONNECT-CREDENTIAL-ROTATION-V1"; +const MAX_TOKEN_BYTES: u64 = 16 * 1024; + +#[derive(Deserialize)] +#[serde(deny_unknown_fields, rename_all = "camelCase")] +struct RegistrationTokenDocument { + registration_token_uid: String, + registration_token_secret: String, + organization_uid: String, + cluster_uid: String, + challenge_nonce: String, + expires_unix: i64, +} + +pub struct RegistrationToken { + pub registration_token_uid: String, + registration_token_secret: Zeroizing, + pub organization_uid: String, + pub cluster_uid: String, + pub challenge_nonce: String, + pub expires_unix: i64, +} + +impl std::fmt::Debug for RegistrationToken { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("RegistrationToken") + .field("registration_token_uid", &self.registration_token_uid) + .field("expires_unix", &self.expires_unix) + .finish_non_exhaustive() + } +} + +impl RegistrationToken { + pub fn from_reader(reader: impl Read) -> Result { + let mut bytes = Zeroizing::new(Vec::new()); + reader + .take(MAX_TOKEN_BYTES + 1) + .read_to_end(&mut bytes) + .map_err(TokenError::Read)?; + if bytes.len() as u64 > MAX_TOKEN_BYTES { + return Err(TokenError::TooLarge); + } + let document: RegistrationTokenDocument = serde_json::from_slice(&bytes).map_err(TokenError::Invalid)?; + let decoded = BASE64_URL_NO_PAD + .decode(&document.registration_token_secret) + .map(Zeroizing::new) + .map_err(|_| TokenError::SecretShape)?; + if decoded.len() != 32 || BASE64_URL_NO_PAD.encode(&decoded) != document.registration_token_secret { + return Err(TokenError::SecretShape); + } + if !is_uuid_v7(&document.registration_token_uid) + || !is_uuid_v7(&document.organization_uid) + || !is_uuid_v7(&document.cluster_uid) + || document.expires_unix < 0 + || document.challenge_nonce.len() != 64 + || !document + .challenge_nonce + .bytes() + .all(|byte| byte.is_ascii_digit() || (b'a'..=b'f').contains(&byte)) + { + return Err(TokenError::Shape); + } + + Ok(Self { + registration_token_uid: document.registration_token_uid, + registration_token_secret: Zeroizing::new(document.registration_token_secret), + organization_uid: document.organization_uid, + cluster_uid: document.cluster_uid, + challenge_nonce: document.challenge_nonce, + expires_unix: document.expires_unix, + }) + } + + pub(crate) fn secret(&self) -> &str { + &self.registration_token_secret + } +} + +#[derive(Debug, thiserror::Error)] +pub enum TokenError { + #[error("failed to read the Connect registration token")] + Read(#[source] std::io::Error), + #[error("Connect registration token configuration is invalid")] + Invalid(#[source] serde_json::Error), + #[error("Connect registration token secret must be 32-byte unpadded base64url")] + SecretShape, + #[error("Connect registration token configuration exceeds 16 KiB")] + TooLarge, + #[error("Connect registration token fields do not match the protocol schema")] + Shape, +} + +#[derive(Serialize)] +#[serde(rename_all = "camelCase")] +pub(crate) struct RegistrationRequest<'a> { + protocol_version: &'static str, + request_id: &'a str, + registration_token_uid: &'a str, + registration_token_secret: &'a str, + certificate_request: &'a str, + proof: ProofRef<'a>, +} + +#[derive(Serialize)] +struct ProofRef<'a> { + algorithm: &'a str, + value: &'a str, +} + +impl<'a> RegistrationRequest<'a> { + pub(crate) fn new( + token: &'a RegistrationToken, + request_id: &'a str, + certificate_request: &'a str, + proof: &'a RegistrationProof, + ) -> Self { + Self { + protocol_version: PROTOCOL_VERSION, + request_id, + registration_token_uid: &token.registration_token_uid, + registration_token_secret: token.secret(), + certificate_request, + proof: ProofRef { + algorithm: &proof.algorithm, + value: &proof.value, + }, + } + } +} + +#[derive(Serialize)] +#[serde(rename_all = "camelCase")] +pub(crate) struct RotationRequest<'a> { + protocol_version: &'static str, + request_id: &'a str, + certificate_request: &'a str, + proof: ProofOwned, +} + +#[derive(Serialize)] +struct ProofOwned { + algorithm: String, + value: String, +} + +impl<'a> RotationRequest<'a> { + pub(crate) fn new( + identity: &DeviceIdentity, + credential_fingerprint: &str, + device_name: &str, + request_id: &'a str, + certificate_request: &'a str, + ) -> Result { + let csr_der = base64::engine::general_purpose::STANDARD + .decode(certificate_request) + .map_err(|_| CredentialValidationError::CertificateRequest)?; + let csr_digest = BASE64_URL_NO_PAD.encode(Sha256::digest(&csr_der)); + let transcript = rotation_transcript(credential_fingerprint, device_name, request_id, &csr_digest)?; + let key = identity + .to_pkcs8_der() + .map_err(|_| CredentialValidationError::CertificateRequest)?; + let signing_key = SigningKey::from_pkcs8_der(&key).map_err(|_| CredentialValidationError::CertificateRequest)?; + let signature: Signature = signing_key.sign(&transcript); + let canonical = signature.normalize_s().unwrap_or(signature); + + Ok(Self { + protocol_version: PROTOCOL_VERSION, + request_id, + certificate_request, + proof: ProofOwned { + algorithm: "ES256".to_string(), + value: BASE64_URL_NO_PAD.encode(canonical.to_bytes()), + }, + }) + } +} + +fn rotation_transcript( + credential_fingerprint: &str, + device_name: &str, + request_id: &str, + csr_digest: &str, +) -> Result, CredentialValidationError> { + let fields = [credential_fingerprint, device_name, request_id, csr_digest]; + if fields + .iter() + .any(|field| !field.is_ascii() || field.as_bytes().contains(&b'\n')) + { + return Err(CredentialValidationError::RotationTranscript); + } + + let mut transcript = Vec::with_capacity(346); + transcript.extend_from_slice(ROTATION_DOMAIN); + transcript.push(b'\n'); + for field in fields { + transcript.extend_from_slice(field.len().to_string().as_bytes()); + transcript.push(b':'); + transcript.extend_from_slice(field.as_bytes()); + transcript.push(b'\n'); + } + Ok(transcript) +} + +#[derive(Deserialize)] +#[serde(rename_all = "camelCase")] +pub(crate) struct CredentialResponse { + pub name: String, + #[serde(default)] + pub uid: String, + #[serde(default)] + pub cluster: String, + pub protocol_version: String, + pub key_id: String, + pub certificate_serial: String, + pub certificate: String, + pub certificate_chain: String, + pub not_before: String, + pub not_after: String, +} + +pub(crate) enum ExpectedDevice<'a> { + Registration { cluster: &'a str }, + Rotation { name: &'a str }, + Stored, +} + +#[derive(Debug, thiserror::Error)] +pub enum CredentialValidationError { + #[error("Connect returned malformed certificate material")] + Certificate, + #[error("Connect returned a certificate chain that is not trusted")] + Chain, + #[error("Connect returned a certificate for the wrong device identity")] + Identity, + #[error("Connect returned a certificate for a different device key")] + Key, + #[error("Connect returned an invalid certificate validity window")] + Validity, + #[error("the device certificate request could not be prepared")] + CertificateRequest, + #[error("the credential rotation transcript contains an invalid field")] + RotationTranscript, +} + +pub(crate) fn validate_credential( + response: CredentialResponse, + identity: &DeviceIdentity, + roots: &RootCertStore, + root_certificates: &[CertificateDer<'static>], + expected: ExpectedDevice<'_>, +) -> Result { + validate_credential_at(response, identity, roots, root_certificates, expected, true) +} + +pub(crate) fn validate_stored_credential( + credential: &DeviceCredential, + identity: &DeviceIdentity, + roots: &RootCertStore, + root_certificates: &[CertificateDer<'static>], +) -> Result<(), CredentialValidationError> { + let not_before = OffsetDateTime::from_unix_timestamp(credential.not_before_unix) + .map_err(|_| CredentialValidationError::Validity)? + .format(&Rfc3339) + .map_err(|_| CredentialValidationError::Validity)?; + let not_after = OffsetDateTime::from_unix_timestamp(credential.not_after_unix) + .map_err(|_| CredentialValidationError::Validity)? + .format(&Rfc3339) + .map_err(|_| CredentialValidationError::Validity)?; + let response = CredentialResponse { + name: credential.name.clone(), + uid: credential.uid.clone(), + cluster: String::new(), + protocol_version: credential.protocol_version.clone(), + key_id: credential.key_id.clone(), + certificate_serial: credential.certificate_serial.clone(), + certificate: credential.certificate.clone(), + certificate_chain: credential.certificate_chain.clone(), + not_before, + not_after, + }; + validate_credential_at(response, identity, roots, root_certificates, ExpectedDevice::Stored, false).map(|_| ()) +} + +fn validate_credential_at( + response: CredentialResponse, + identity: &DeviceIdentity, + roots: &RootCertStore, + root_certificates: &[CertificateDer<'static>], + expected: ExpectedDevice<'_>, + verify_now: bool, +) -> Result { + if response.protocol_version != PROTOCOL_VERSION { + return Err(CredentialValidationError::Identity); + } + + let leaves = CertificateDer::pem_slice_iter(response.certificate.as_bytes()) + .collect::, _>>() + .map_err(|_| CredentialValidationError::Certificate)?; + if leaves.len() != 1 { + return Err(CredentialValidationError::Certificate); + } + let chain = CertificateDer::pem_slice_iter(response.certificate_chain.as_bytes()) + .collect::, _>>() + .map_err(|_| CredentialValidationError::Certificate)?; + if chain.is_empty() + || chain[0].as_ref() != leaves[0].as_ref() + || chain + .iter() + .skip(1) + .any(|certificate| root_certificates.iter().any(|root| root.as_ref() == certificate.as_ref())) + { + return Err(CredentialValidationError::Chain); + } + + let (remaining, certificate) = + X509Certificate::from_der(leaves[0].as_ref()).map_err(|_| CredentialValidationError::Certificate)?; + if !remaining.is_empty() { + return Err(CredentialValidationError::Certificate); + } + + let uid = match expected { + ExpectedDevice::Registration { cluster } => { + if response.uid.is_empty() + || response.cluster != cluster + || response.name != format!("{cluster}/clusterDevices/{}", response.uid) + { + return Err(CredentialValidationError::Identity); + } + response.uid.clone() + } + ExpectedDevice::Rotation { name } => { + if response.name != name || !response.uid.is_empty() || !response.cluster.is_empty() { + return Err(CredentialValidationError::Identity); + } + name.rsplit_once("/clusterDevices/") + .map(|(_, uid)| uid.to_string()) + .ok_or(CredentialValidationError::Identity)? + } + ExpectedDevice::Stored => { + let (cluster, name_uid) = response + .name + .rsplit_once("/clusterDevices/") + .ok_or(CredentialValidationError::Identity)?; + if response.uid != name_uid + || !response.cluster.is_empty() + || !valid_cluster_name(cluster) + || response.name.matches("/clusterDevices/").count() != 1 + { + return Err(CredentialValidationError::Identity); + } + response.uid.clone() + } + }; + let parsed_uid = Uuid::parse_str(&uid).map_err(|_| CredentialValidationError::Identity)?; + if parsed_uid.get_version() != Some(Version::SortRand) || parsed_uid.to_string() != uid { + return Err(CredentialValidationError::Identity); + } + let expected_uri = format!("urn:rustfs:connect:device:{uid}"); + let common_names = certificate + .subject() + .iter_common_name() + .map(|name| name.as_str()) + .collect::, _>>() + .map_err(|_| CredentialValidationError::Identity)?; + let san = certificate + .subject_alternative_name() + .map_err(|_| CredentialValidationError::Identity)? + .ok_or(CredentialValidationError::Identity)?; + let san_matches = matches!(san.value.general_names.as_slice(), [GeneralName::URI(uri)] if *uri == expected_uri); + + if common_names.as_slice() != [uid.as_str()] + || !san_matches + || certificate.subject().iter().count() != 1 + || certificate.subject().iter_attributes().count() != 1 + { + return Err(CredentialValidationError::Identity); + } + if certificate.public_key().raw != identity.public_key_der() { + return Err(CredentialValidationError::Key); + } + + let not_before = OffsetDateTime::parse(&response.not_before, &Rfc3339) + .map_err(|_| CredentialValidationError::Validity)? + .unix_timestamp(); + let not_after = OffsetDateTime::parse(&response.not_after, &Rfc3339) + .map_err(|_| CredentialValidationError::Validity)? + .unix_timestamp(); + let verify_unix = if verify_now { + UnixTime::now() + } else { + let midpoint = certificate.validity().not_before.timestamp() + + (certificate.validity().not_after.timestamp() - certificate.validity().not_before.timestamp()) / 2; + UnixTime::since_unix_epoch(std::time::Duration::from_secs( + midpoint.try_into().map_err(|_| CredentialValidationError::Validity)?, + )) + }; + let verifier = WebPkiClientVerifier::builder(Arc::new(roots.clone())) + .build() + .map_err(|_| CredentialValidationError::Chain)?; + verifier + .verify_client_cert(&leaves[0], &chain[1..], verify_unix) + .map_err(|_| CredentialValidationError::Chain)?; + if not_before != certificate.validity().not_before.timestamp() + || not_after != certificate.validity().not_after.timestamp() + || not_after - not_before != CERTIFICATE_LIFETIME_SECONDS + || certificate.signature_algorithm.algorithm != OID_SIG_ECDSA_WITH_SHA256 + || response.certificate_serial != canonical_serial(certificate.raw_serial())? + || response.key_id != format!("x509-{}", response.certificate_serial) + { + return Err(CredentialValidationError::Validity); + } + + Ok(DeviceCredential { + name: response.name, + uid, + protocol_version: response.protocol_version, + key_id: response.key_id, + certificate_serial: response.certificate_serial, + certificate: response.certificate, + certificate_chain: response.certificate_chain, + not_before_unix: not_before, + not_after_unix: not_after, + }) +} + +pub(crate) fn public_key_fingerprint(identity: &DeviceIdentity) -> String { + hex_lower(&Sha256::digest(identity.public_key_der())) +} + +pub(crate) fn certificate_request_matches(encoded: &str, identity: &DeviceIdentity) -> Result { + let der = base64::engine::general_purpose::STANDARD + .decode(encoded) + .map_err(|_| CredentialValidationError::CertificateRequest)?; + let (remaining, request) = + X509CertificationRequest::from_der(&der).map_err(|_| CredentialValidationError::CertificateRequest)?; + Ok(remaining.is_empty() && request.certification_request_info.subject_pki.raw == identity.public_key_der()) +} + +fn canonical_serial(raw: &[u8]) -> Result { + let magnitude = match raw { + [0, first, rest @ ..] if first & 0x80 != 0 => { + if rest.len() + 1 > 16 { + return Err(CredentialValidationError::Validity); + } + &raw[1..] + } + [0] => raw, + [0, ..] | [] => return Err(CredentialValidationError::Validity), + [first, ..] if first & 0x80 != 0 => return Err(CredentialValidationError::Validity), + _ if raw.len() > 16 => return Err(CredentialValidationError::Validity), + _ => raw, + }; + let mut padded = [0u8; 16]; + padded[16 - magnitude.len()..].copy_from_slice(magnitude); + Ok(hex_lower(&padded)) +} + +fn is_uuid_v7(value: &str) -> bool { + Uuid::parse_str(value).is_ok_and(|uuid| uuid.get_version() == Some(Version::SortRand) && uuid.to_string() == value) +} + +fn valid_cluster_name(name: &str) -> bool { + let Some((organization, cluster)) = name + .strip_prefix("organizations/") + .and_then(|rest| rest.split_once("/clusters/")) + else { + return false; + }; + !cluster.contains('/') && is_uuid_v7(organization) && is_uuid_v7(cluster) +} + +pub(crate) fn certificate_fingerprint(certificate_pem: &str) -> Result { + let certificate = CertificateDer::pem_slice_iter(certificate_pem.as_bytes()) + .next() + .ok_or(CredentialValidationError::Certificate)? + .map_err(|_| CredentialValidationError::Certificate)?; + Ok(hex_lower(&Sha256::digest(certificate.as_ref()))) +} + +fn hex_lower(bytes: &[u8]) -> String { + bytes.iter().fold(String::with_capacity(bytes.len() * 2), |mut output, byte| { + use std::fmt::Write as _; + let _ = write!(output, "{byte:02x}"); + output + }) +} diff --git a/rustfs/tests/connect_registration.rs b/rustfs/tests/connect_registration.rs new file mode 100644 index 000000000..a1e94030d --- /dev/null +++ b/rustfs/tests/connect_registration.rs @@ -0,0 +1,911 @@ +// Copyright 2024 RustFS Team +// +// Licensed 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 std::collections::VecDeque; +use std::fs; +use std::sync::{Arc, Mutex}; +use std::time::Duration; + +use base64::Engine as _; +use base64::engine::general_purpose::{STANDARD as BASE64_STANDARD, URL_SAFE_NO_PAD as BASE64_URL_NO_PAD}; +use bytes::Bytes; +use http_body_util::{BodyExt as _, Full}; +use hyper::service::service_fn; +use hyper::{Request, Response, StatusCode}; +use hyper_util::rt::TokioIo; +use p256::ecdsa::signature::Verifier as _; +use p256::ecdsa::{Signature, VerifyingKey}; +use p256::pkcs8::DecodePublicKey as _; +use rcgen::{ + BasicConstraints, CertificateParams, DistinguishedName, DnType, ExtendedKeyUsagePurpose, IsCa, Issuer, KeyPair, + KeyUsagePurpose, SanType, SerialNumber, +}; +use rustfs::connect::{ClientError, ConnectClient, ConnectConfig, CredentialStore, IdentityStore, RegistrationToken, TokenError}; +use rustls::RootCertStore; +use rustls::pki_types::{CertificateDer, PrivateKeyDer, PrivatePkcs8KeyDer, pem::PemObject as _}; +use rustls::server::WebPkiClientVerifier; +use serde_json::{Value, json}; +use sha2::{Digest as _, Sha256}; +use time::OffsetDateTime; +use time::format_description::well_known::Rfc3339; +use tokio::net::TcpListener; +use tokio_rustls::TlsAcceptor; + +const ORGANIZATION_UID: &str = "0198f4b0-1a00-7c10-8d21-2e3f4a5b6c70"; +const CLUSTER_UID: &str = "0198f4b0-2b00-7d20-9e31-3f4a5b6c7d81"; +const DEVICE_UID: &str = "0198f4b0-3c00-7e30-8f41-4a5b6c7d8e92"; +const TOKEN_UID: &str = "0198f4b0-6f00-7b60-9271-7d8e9fa0b1c5"; +const FRESH_TOKEN_UID: &str = "0198f4b0-7f00-7c70-a381-8e9fa0b1c2d6"; +const SECOND_TOKEN_UID: &str = "0198f4b0-8f00-7d80-b491-9fa0b1c2d3e7"; + +struct TestPki { + root_params: CertificateParams, + root_key: KeyPair, + root_der: CertificateDer<'static>, + root_pem: String, + server_der: CertificateDer<'static>, + server_key: PrivatePkcs8KeyDer<'static>, +} + +impl TestPki { + fn new() -> Self { + let now = OffsetDateTime::now_utc(); + let root_key = KeyPair::generate().expect("generate root key"); + let mut root_params = CertificateParams::default(); + root_params.is_ca = IsCa::Ca(BasicConstraints::Unconstrained); + root_params.not_before = now - time::Duration::days(1); + root_params.not_after = now + time::Duration::days(30); + root_params.key_usages = vec![KeyUsagePurpose::KeyCertSign, KeyUsagePurpose::DigitalSignature]; + root_params.distinguished_name.push(DnType::CommonName, "Connect test root"); + let root = root_params.self_signed(&root_key).expect("sign root"); + + let server_key = KeyPair::generate().expect("generate server key"); + let mut server_params = CertificateParams::default(); + server_params.not_before = now - time::Duration::hours(1); + server_params.not_after = now + time::Duration::days(2); + server_params + .subject_alt_names + .push(SanType::DnsName("localhost".try_into().expect("valid DNS name"))); + server_params.extended_key_usages = vec![ExtendedKeyUsagePurpose::ServerAuth]; + let issuer = Issuer::from_params(&root_params, &root_key); + let server = server_params + .signed_by(&server_key, &issuer) + .expect("sign server certificate"); + + Self { + root_params, + root_key, + root_der: root.der().clone(), + root_pem: root.pem(), + server_der: server.der().clone(), + server_key: PrivatePkcs8KeyDer::from(server_key.serialize_der()), + } + } + + fn credential(&self, identity: &rustfs::connect::DeviceIdentity, uri: &str, serial_byte: u8) -> Value { + let now = OffsetDateTime::now_utc().replace_nanosecond(0).expect("whole second"); + self.credential_window(identity, uri, serial_byte, now, now + time::Duration::days(1)) + } + + fn credential_window( + &self, + identity: &rustfs::connect::DeviceIdentity, + uri: &str, + serial_byte: u8, + not_before: OffsetDateTime, + not_after: OffsetDateTime, + ) -> Value { + let mut params = CertificateParams::default(); + params.not_before = not_before; + params.not_after = not_after; + params.serial_number = Some(SerialNumber::from(vec![serial_byte; 16])); + params.key_usages = vec![KeyUsagePurpose::DigitalSignature]; + params.extended_key_usages = vec![ExtendedKeyUsagePurpose::ClientAuth]; + params.distinguished_name = DistinguishedName::new(); + params.distinguished_name.push(DnType::CommonName, DEVICE_UID); + params + .subject_alt_names + .push(SanType::URI(uri.try_into().expect("valid URI SAN"))); + let private_key = identity.to_pkcs8_der().expect("serialize device key"); + let private_key = PrivatePkcs8KeyDer::from(private_key.to_vec()); + let device_key = + KeyPair::from_pkcs8_der_and_sign_algo(&private_key, &rcgen::PKCS_ECDSA_P256_SHA256).expect("parse device key"); + let issuer = Issuer::from_params(&self.root_params, &self.root_key); + let certificate = params.signed_by(&device_key, &issuer).expect("sign device certificate"); + let serial = format!("{serial_byte:02x}").repeat(16); + let cluster = format!("organizations/{ORGANIZATION_UID}/clusters/{CLUSTER_UID}"); + + json!({ + "name": format!("{cluster}/clusterDevices/{DEVICE_UID}"), + "uid": DEVICE_UID, + "cluster": cluster, + "protocolVersion": "v1", + "keyId": format!("x509-{serial}"), + "certificateSerial": serial, + "certificate": certificate.pem(), + "certificateChain": certificate.pem(), + "notBefore": not_before.format(&Rfc3339).expect("format notBefore"), + "notAfter": not_after.format(&Rfc3339).expect("format notAfter"), + }) + } + + fn server_config(&self, require_client: bool) -> rustls::ServerConfig { + let mut roots = RootCertStore::empty(); + roots.add(self.root_der.clone()).expect("add client root"); + let verifier = WebPkiClientVerifier::builder(Arc::new(roots)); + let verifier = if require_client { + verifier.build() + } else { + verifier.allow_unauthenticated().build() + } + .expect("build client verifier"); + rustls::ServerConfig::builder() + .with_client_cert_verifier(verifier) + .with_single_cert(vec![self.server_der.clone()], PrivateKeyDer::Pkcs8(self.server_key.clone_key())) + .expect("build server TLS") + } +} + +#[derive(Clone)] +enum Reply { + Json(StatusCode, Value), + DelayedClose(Duration), + VerifiedRotation { + response: Value, + current_public_key: Vec, + current_certificate_fingerprint: String, + device_name: String, + }, +} + +struct TestServer { + endpoint: String, + seen: Arc>>, + task: tokio::task::JoinHandle<()>, +} + +impl Drop for TestServer { + fn drop(&mut self) { + self.task.abort(); + } +} + +async fn server(pki: &TestPki, replies: Vec) -> TestServer { + server_with_client_auth(pki, replies, false).await +} + +async fn server_with_client_auth(pki: &TestPki, replies: Vec, require_client: bool) -> TestServer { + let listener = TcpListener::bind("127.0.0.1:0").await.expect("bind test server"); + let address = listener.local_addr().expect("server address"); + let acceptor = TlsAcceptor::from(Arc::new(pki.server_config(require_client))); + let replies = Arc::new(Mutex::new(VecDeque::from(replies))); + let seen = Arc::new(Mutex::new(Vec::new())); + let captured = seen.clone(); + let task = tokio::spawn(async move { + loop { + let Ok((stream, _)) = listener.accept().await else { + return; + }; + let acceptor = acceptor.clone(); + let replies = replies.clone(); + let seen = captured.clone(); + tokio::spawn(async move { + let Ok(stream) = acceptor.accept(stream).await else { + return; + }; + let service = service_fn(move |request: Request| { + let replies = replies.clone(); + let seen = seen.clone(); + async move { + let body = request.into_body().collect().await.expect("read request body").to_bytes(); + let value: Value = serde_json::from_slice(&body).expect("request JSON"); + seen.lock().expect("seen lock").push(value.clone()); + let reply = replies.lock().expect("reply lock").pop_front().expect("planned reply"); + match reply { + Reply::Json(status, value) => Ok::<_, hyper::Error>( + Response::builder() + .status(status) + .header("content-type", "application/json") + .body(Full::new(Bytes::from(serde_json::to_vec(&value).expect("reply JSON")))) + .expect("response"), + ), + Reply::DelayedClose(delay) => { + tokio::time::sleep(delay).await; + Ok(Response::builder() + .status(StatusCode::SERVICE_UNAVAILABLE) + .body(Full::new(Bytes::new())) + .expect("response")) + } + Reply::VerifiedRotation { + response, + current_public_key, + current_certificate_fingerprint, + device_name, + } => { + verify_rotation_request( + &value, + ¤t_public_key, + ¤t_certificate_fingerprint, + &device_name, + ); + Ok(Response::builder() + .status(StatusCode::OK) + .header("content-type", "application/json") + .body(Full::new(Bytes::from(serde_json::to_vec(&response).expect("reply JSON")))) + .expect("response")) + } + } + } + }); + let _ = hyper::server::conn::http1::Builder::new() + .serve_connection(TokioIo::new(stream), service) + .await; + }); + } + }); + TestServer { + endpoint: format!("https://localhost:{}/agent/", address.port()), + seen, + task, + } +} + +fn verify_rotation_request(request: &Value, current_public_key: &[u8], fingerprint: &str, device_name: &str) { + assert_eq!(request["protocolVersion"], "v1"); + assert_eq!(request["proof"]["algorithm"], "ES256"); + let csr = BASE64_STANDARD + .decode(request["certificateRequest"].as_str().expect("certificateRequest")) + .expect("CSR base64"); + let csr_digest = BASE64_URL_NO_PAD.encode(Sha256::digest(&csr)); + let request_id = request["requestId"].as_str().expect("requestId"); + let transcript = rebuilt_rotation_transcript( + b"RUSTFS-CONNECT-CREDENTIAL-ROTATION-V1", + [fingerprint, device_name, request_id, &csr_digest], + ); + let encoded = request["proof"]["value"].as_str().expect("proof value"); + assert_eq!(encoded.len(), 86); + let raw = BASE64_URL_NO_PAD.decode(encoded).expect("proof base64url"); + let signature = Signature::from_slice(&raw).expect("fixed-width signature"); + assert!(signature.normalize_s().is_none(), "rotation proof must be low-S"); + let verifying = VerifyingKey::from_public_key_der(current_public_key).expect("current public key"); + verifying.verify(&transcript, &signature).expect("rotation proof verifies"); + + let wrong_domain = rebuilt_rotation_transcript( + b"RUSTFS-CONNECT-CREDENTIAL-ROTATION-V2", + [fingerprint, device_name, request_id, &csr_digest], + ); + assert!(verifying.verify(&wrong_domain, &signature).is_err()); + let wrong_order = rebuilt_rotation_transcript( + b"RUSTFS-CONNECT-CREDENTIAL-ROTATION-V1", + [device_name, fingerprint, request_id, &csr_digest], + ); + assert!(verifying.verify(&wrong_order, &signature).is_err()); +} + +fn rebuilt_rotation_transcript(domain: &[u8], fields: [&str; 4]) -> Vec { + let mut transcript = Vec::new(); + transcript.extend_from_slice(domain); + transcript.push(b'\n'); + for field in fields { + transcript.extend_from_slice(field.len().to_string().as_bytes()); + transcript.push(b':'); + transcript.extend_from_slice(field.as_bytes()); + transcript.push(b'\n'); + } + transcript +} + +fn certificate_fingerprint(pem: &str) -> String { + let certificate = CertificateDer::pem_slice_iter(pem.as_bytes()) + .next() + .expect("leaf certificate") + .expect("certificate PEM"); + Sha256::digest(certificate.as_ref()) + .iter() + .map(|byte| format!("{byte:02x}")) + .collect() +} + +fn token_document() -> Value { + json!({ + "registrationTokenUid": TOKEN_UID, + "registrationTokenSecret": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", + "organizationUid": ORGANIZATION_UID, + "clusterUid": CLUSTER_UID, + "challengeNonce": "a3f1c07d9b2e4856af0c1d3b5e7f9012c4a6b8d0e2f4061738495a6b7c8d9e0f", + "expiresUnix": OffsetDateTime::now_utc().unix_timestamp() + 3600, + }) +} + +fn token() -> RegistrationToken { + token_with_uid(TOKEN_UID) +} + +fn token_with_uid(uid: &str) -> RegistrationToken { + let document = token_document(); + let mut document = document; + document["registrationTokenUid"] = json!(uid); + RegistrationToken::from_reader(serde_json::to_vec(&document).expect("token JSON").as_slice()).expect("token parses") +} + +fn stores(temp: &tempfile::TempDir) -> (IdentityStore, CredentialStore) { + ( + IdentityStore::new(temp.path().join("identity")), + CredentialStore::new(temp.path().join("credential")), + ) +} + +fn client(server: &TestServer, pki: &TestPki, timeout: Duration) -> ConnectClient { + ConnectClient::new(ConnectConfig { + endpoint: &server.endpoint, + root_ca_pem: pki.root_pem.as_bytes(), + timeout, + }) + .expect("build Connect client") +} + +fn rotation_response(pki: &TestPki, identity: &rustfs::connect::DeviceIdentity, serial: u8) -> (Value, Value) { + let stored = pki.credential(identity, &format!("urn:rustfs:connect:device:{DEVICE_UID}"), serial); + let mut wire = stored.clone(); + wire.as_object_mut().expect("response object").remove("uid"); + wire.as_object_mut().expect("response object").remove("cluster"); + (wire, stored) +} + +fn write_stored_credential(path: &std::path::Path, response: &Value) { + let not_before = OffsetDateTime::parse(response["notBefore"].as_str().expect("notBefore"), &Rfc3339) + .expect("parse notBefore") + .unix_timestamp(); + let not_after = OffsetDateTime::parse(response["notAfter"].as_str().expect("notAfter"), &Rfc3339) + .expect("parse notAfter") + .unix_timestamp(); + let stored = json!({ + "name": response["name"], + "uid": DEVICE_UID, + "protocolVersion": response["protocolVersion"], + "keyId": response["keyId"], + "certificateSerial": response["certificateSerial"], + "certificate": response["certificate"], + "certificateChain": response["certificateChain"], + "notBeforeUnix": not_before, + "notAfterUnix": not_after, + }); + fs::write(path, serde_json::to_vec(&stored).expect("stored credential JSON")).expect("write credential"); + set_owner_only(path); +} + +#[cfg(unix)] +fn set_owner_only(path: &std::path::Path) { + use std::os::unix::fs::PermissionsExt as _; + fs::set_permissions(path, fs::Permissions::from_mode(0o600)).expect("set owner-only mode"); +} + +#[cfg(not(unix))] +fn set_owner_only(_path: &std::path::Path) {} + +#[tokio::test] +async fn registration_reuses_request_and_csr_after_timeout_and_restart() { + let temp = tempfile::tempdir().expect("temp dir"); + let (identity_store, credential_store) = stores(&temp); + let identity = identity_store.load_or_create().expect("create identity"); + let pki = TestPki::new(); + let response = pki.credential(&identity, &format!("urn:rustfs:connect:device:{DEVICE_UID}"), 0x80); + let server = server( + &pki, + vec![ + Reply::DelayedClose(Duration::from_millis(200)), + Reply::Json(StatusCode::SERVICE_UNAVAILABLE, json!({})), + Reply::Json(StatusCode::SERVICE_UNAVAILABLE, json!({})), + Reply::Json(StatusCode::CREATED, response), + ], + ) + .await; + let first = client(&server, &pki, Duration::from_millis(80)); + assert!(matches!( + first.register(&identity_store, &credential_store, &token()).await, + Err(ClientError::Unavailable { .. }) + )); + + let restarted = client(&server, &pki, Duration::from_secs(2)); + let credential = restarted + .register(&identity_store, &credential_store, &token()) + .await + .expect("restart replays completed exchange"); + assert_eq!(credential.uid, DEVICE_UID); + assert_eq!(credential.certificate_serial, "80".repeat(16)); + + let seen = server.seen.lock().expect("seen lock"); + assert_eq!(seen.len(), 4); + for request in &seen[1..] { + assert_eq!(request["requestId"], seen[0]["requestId"]); + assert_eq!(request["certificateRequest"], seen[0]["certificateRequest"]); + } +} + +#[tokio::test] +async fn registration_rejects_untrusted_or_misbound_credentials() { + for case in ["san", "chain", "key", "key_id", "cluster", "name"] { + let temp = tempfile::tempdir().expect("temp dir"); + let (identity_store, credential_store) = stores(&temp); + let identity = identity_store.load_or_create().expect("create identity"); + let pki = TestPki::new(); + let mut response = match case { + "san" => pki.credential(&identity, "urn:rustfs:connect:device:0198f4b0-3c00-7e30-8f41-4a5b6c7d8e93", 2), + "chain" => TestPki::new().credential(&identity, &format!("urn:rustfs:connect:device:{DEVICE_UID}"), 2), + "key" => pki.credential( + &rustfs::connect::DeviceIdentity::generate(), + &format!("urn:rustfs:connect:device:{DEVICE_UID}"), + 2, + ), + _ => pki.credential(&identity, &format!("urn:rustfs:connect:device:{DEVICE_UID}"), 2), + }; + match case { + "key_id" => response["keyId"] = json!("x509-deadbeef"), + "cluster" => response["cluster"] = json!(format!("organizations/{ORGANIZATION_UID}/clusters/other")), + "name" => { + response["name"] = json!(format!("organizations/{ORGANIZATION_UID}/clusters/other/clusterDevices/{DEVICE_UID}")) + } + _ => {} + } + let server = server(&pki, vec![Reply::Json(StatusCode::CREATED, response)]).await; + let error = client(&server, &pki, Duration::from_secs(2)) + .register(&identity_store, &credential_store, &token()) + .await + .expect_err("invalid returned identity must fail closed"); + assert!(matches!(error, ClientError::Credential(_))); + assert!(!temp.path().join("credential/device.crt.json").exists()); + } +} + +#[tokio::test] +async fn stored_credential_is_revalidated_before_reuse() { + let temp = tempfile::tempdir().expect("temp dir"); + let (identity_store, credential_store) = stores(&temp); + let identity = identity_store.load_or_create().expect("create identity"); + let pki = TestPki::new(); + let issued = pki.credential(&identity, &format!("urn:rustfs:connect:device:{DEVICE_UID}"), 4); + let server = server(&pki, vec![Reply::Json(StatusCode::CREATED, issued)]).await; + let client = client(&server, &pki, Duration::from_secs(2)); + client + .register(&identity_store, &credential_store, &token()) + .await + .expect("register"); + + let path = temp.path().join("credential/device.crt.json"); + let mut stored: Value = serde_json::from_slice(&fs::read(&path).expect("read credential")).expect("credential JSON"); + stored["certificateSerial"] = json!("00".repeat(16)); + fs::write(&path, serde_json::to_vec(&stored).expect("credential JSON")).expect("tamper credential"); + let error = client + .register(&identity_store, &credential_store, &token()) + .await + .expect_err("tampered stored credential must fail closed"); + assert!(matches!(error, ClientError::Credential(_))); +} + +#[tokio::test] +async fn register_rejects_expired_and_not_yet_valid_stored_credentials() { + let temp = tempfile::tempdir().expect("temp dir"); + let (identity_store, credential_store) = stores(&temp); + let identity = identity_store.load_or_create().expect("create identity"); + let pki = TestPki::new(); + let issued = pki.credential(&identity, &format!("urn:rustfs:connect:device:{DEVICE_UID}"), 9); + let registration = server(&pki, vec![Reply::Json(StatusCode::CREATED, issued)]).await; + let client = client(®istration, &pki, Duration::from_secs(2)); + client + .register(&identity_store, &credential_store, &token()) + .await + .expect("register"); + + let now = OffsetDateTime::now_utc().replace_nanosecond(0).expect("whole second"); + let path = temp.path().join("credential/device.crt.json"); + let expired = pki.credential_window( + &identity, + &format!("urn:rustfs:connect:device:{DEVICE_UID}"), + 10, + now - time::Duration::days(2), + now - time::Duration::days(1), + ); + write_stored_credential(&path, &expired); + assert!(matches!( + client.register(&identity_store, &credential_store, &token()).await, + Err(ClientError::CredentialExpired) + )); + + let future = pki.credential_window( + &identity, + &format!("urn:rustfs:connect:device:{DEVICE_UID}"), + 11, + now + time::Duration::hours(1), + now + time::Duration::hours(25), + ); + write_stored_credential(&path, &future); + assert!(matches!( + client.register(&identity_store, &credential_store, &token()).await, + Err(ClientError::CredentialNotYetValid) + )); +} + +#[tokio::test] +async fn concurrent_rotation_retries_converge_and_promote_the_next_key() { + let temp = tempfile::tempdir().expect("temp dir"); + let (identity_store, credential_store) = stores(&temp); + let current = identity_store.load_or_create().expect("create identity"); + let pki = TestPki::new(); + let mut issued = pki.credential(¤t, &format!("urn:rustfs:connect:device:{DEVICE_UID}"), 5); + issued["certificateChain"] = json!( + issued["certificateChain"] + .as_str() + .expect("certificate chain") + .trim_end_matches('\n') + ); + let registration = server(&pki, vec![Reply::Json(StatusCode::CREATED, issued)]).await; + let registered = client(®istration, &pki, Duration::from_secs(2)) + .register(&identity_store, &credential_store, &token()) + .await + .expect("register"); + + let retries = server( + &pki, + vec![ + Reply::DelayedClose(Duration::from_millis(200)), + Reply::Json(StatusCode::SERVICE_UNAVAILABLE, json!({})), + Reply::Json(StatusCode::SERVICE_UNAVAILABLE, json!({})), + Reply::Json(StatusCode::SERVICE_UNAVAILABLE, json!({})), + Reply::Json(StatusCode::SERVICE_UNAVAILABLE, json!({})), + Reply::Json(StatusCode::SERVICE_UNAVAILABLE, json!({})), + ], + ) + .await; + let retry_client = client(&retries, &pki, Duration::from_millis(80)); + let due = registered.not_after_unix - 8 * 60 * 60; + let (first, second) = tokio::join!( + retry_client.rotate_if_due(&identity_store, &credential_store, due), + retry_client.rotate_if_due(&identity_store, &credential_store, due) + ); + assert!(matches!(first, Err(ClientError::Unavailable { .. }))); + assert!(matches!(second, Err(ClientError::Unavailable { .. }))); + let (request_id, certificate_request) = { + let seen = retries.seen.lock().expect("seen lock"); + assert!(seen.len() >= 3, "bounded retries must reach the server"); + for request in &seen[1..] { + assert_eq!(request["requestId"], seen[0]["requestId"]); + assert_eq!(request["certificateRequest"], seen[0]["certificateRequest"]); + } + (seen[0]["requestId"].clone(), seen[0]["certificateRequest"].clone()) + }; + + let next_der = fs::read(temp.path().join("identity/device.key.next")).expect("read staged next key"); + let next = rustfs::connect::DeviceIdentity::from_pkcs8_der(&next_der).expect("parse next key"); + assert_ne!(current.public_key_der(), next.public_key_der()); + assert_eq!( + identity_store + .load() + .expect("load current key") + .expect("current key") + .public_key_der(), + current.public_key_der() + ); + #[cfg(unix)] + { + use std::os::unix::fs::PermissionsExt as _; + let mode = fs::metadata(temp.path().join("identity/device.key.next")) + .expect("next key metadata") + .permissions() + .mode() + & 0o7777; + assert_eq!(mode, 0o600); + } + let (rotated, _) = rotation_response(&pki, &next, 6); + let success = server_with_client_auth( + &pki, + vec![Reply::VerifiedRotation { + response: rotated, + current_public_key: current.public_key_der(), + current_certificate_fingerprint: certificate_fingerprint(®istered.certificate), + device_name: registered.name.clone(), + }], + true, + ) + .await; + let success_client = client(&success, &pki, Duration::from_secs(2)); + let (due_result, current_result) = tokio::join!( + success_client.rotate_if_due(&identity_store, &credential_store, due), + success_client.rotate_if_due(&identity_store, &credential_store, OffsetDateTime::now_utc().unix_timestamp()) + ); + let credential = due_result + .expect("retry rotation") + .or(current_result.expect("concurrent current-state check")) + .expect("exactly one rotation is due"); + assert_eq!(credential.certificate_serial, "06".repeat(16)); + let success_seen = success.seen.lock().expect("seen lock"); + assert_eq!(success_seen.len(), 1, "the post-commit actor must not publish stale state"); + assert_eq!(success_seen[0]["requestId"], request_id); + assert_eq!(success_seen[0]["certificateRequest"], certificate_request); + drop(success_seen); + assert_eq!( + identity_store + .load() + .expect("load key") + .expect("current key") + .public_key_der(), + next.public_key_der() + ); + assert!(!temp.path().join("identity/device.key.next").exists()); + assert!(!temp.path().join("credential/rotation.pending.json").exists()); +} + +#[tokio::test] +async fn rotation_commit_recovers_after_each_durable_step() { + let temp = tempfile::tempdir().expect("temp dir"); + let (identity_store, credential_store) = stores(&temp); + let current = identity_store.load_or_create().expect("create identity"); + let pki = TestPki::new(); + let issued = pki.credential(¤t, &format!("urn:rustfs:connect:device:{DEVICE_UID}"), 7); + let registration = server(&pki, vec![Reply::Json(StatusCode::CREATED, issued)]).await; + let registered = client(®istration, &pki, Duration::from_secs(2)) + .register(&identity_store, &credential_store, &token()) + .await + .expect("register"); + let failed = server(&pki, vec![Reply::Json(StatusCode::SERVICE_UNAVAILABLE, json!({})); 3]).await; + let due = registered.not_after_unix - 8 * 60 * 60; + assert!(matches!( + client(&failed, &pki, Duration::from_secs(2)) + .rotate_if_due(&identity_store, &credential_store, due) + .await, + Err(ClientError::Unavailable { .. }) + )); + + let pending_path = temp.path().join("credential/rotation.pending.json"); + let pending = fs::read(&pending_path).expect("read pending state"); + let next_der = fs::read(temp.path().join("identity/device.key.next")).expect("read next key"); + let next = rustfs::connect::DeviceIdentity::from_pkcs8_der(&next_der).expect("parse next key"); + let (_, stored) = rotation_response(&pki, &next, 8); + write_stored_credential(&temp.path().join("credential/device.crt.json"), &stored); + + let idle = server(&pki, vec![]).await; + assert!( + client(&idle, &pki, Duration::from_secs(2)) + .rotate_if_due(&identity_store, &credential_store, OffsetDateTime::now_utc().unix_timestamp()) + .await + .expect("recover after credential save") + .is_none() + ); + assert_eq!( + identity_store + .load() + .expect("load key") + .expect("current key") + .public_key_der(), + next.public_key_der() + ); + + fs::write(&pending_path, pending).expect("restore pending after key commit"); + set_owner_only(&pending_path); + assert!( + client(&idle, &pki, Duration::from_secs(2)) + .rotate_if_due(&identity_store, &credential_store, OffsetDateTime::now_utc().unix_timestamp()) + .await + .expect("recover after key commit") + .is_none() + ); + assert!(!pending_path.exists()); +} + +#[tokio::test] +async fn pending_reenrollment_blocks_rotation_and_resumes_original_exchange() { + let temp = tempfile::tempdir().expect("temp dir"); + let (identity_store, credential_store) = stores(&temp); + let current = identity_store.load_or_create().expect("create identity"); + let pki = TestPki::new(); + let issued = pki.credential(¤t, &format!("urn:rustfs:connect:device:{DEVICE_UID}"), 13); + let registration = server(&pki, vec![Reply::Json(StatusCode::CREATED, issued)]).await; + let registered = client(®istration, &pki, Duration::from_secs(2)) + .register(&identity_store, &credential_store, &token()) + .await + .expect("register"); + + let failed = server(&pki, vec![Reply::Json(StatusCode::SERVICE_UNAVAILABLE, json!({})); 3]).await; + assert!(matches!( + client(&failed, &pki, Duration::from_secs(2)) + .reenroll(&identity_store, &credential_store, &token_with_uid(FRESH_TOKEN_UID)) + .await, + Err(ClientError::Unavailable { .. }) + )); + + let pending_path = temp.path().join("credential/registration.pending.json"); + let pending = fs::read(&pending_path).expect("read pending reenrollment"); + let pending_document: Value = serde_json::from_slice(&pending).expect("pending JSON"); + let next_der = fs::read(temp.path().join("identity/device.key.next")).expect("read next key"); + let next = rustfs::connect::DeviceIdentity::from_pkcs8_der(&next_der).expect("parse next key"); + let enrolled = pki.credential(&next, &format!("urn:rustfs:connect:device:{DEVICE_UID}"), 14); + + let rotation = server(&pki, vec![]).await; + let error = client(&rotation, &pki, Duration::from_secs(2)) + .rotate_if_due(&identity_store, &credential_store, registered.not_after_unix - 8 * 60 * 60) + .await + .expect_err("pending reenrollment blocks rotation"); + assert!(matches!(error, ClientError::PendingRegistration)); + assert!(rotation.seen.lock().expect("seen lock").is_empty()); + + let resumed = server(&pki, vec![Reply::Json(StatusCode::CREATED, enrolled)]).await; + let credential = client(&resumed, &pki, Duration::from_secs(2)) + .reenroll(&identity_store, &credential_store, &token_with_uid(FRESH_TOKEN_UID)) + .await + .expect("resume reenrollment"); + assert_eq!(credential.certificate_serial, "0e".repeat(16)); + let resumed_seen = resumed.seen.lock().expect("seen lock"); + assert_eq!(resumed_seen.len(), 1); + assert_eq!(resumed_seen[0]["requestId"], pending_document["requestId"]); + assert_eq!(resumed_seen[0]["certificateRequest"], pending_document["certificateRequest"]); +} + +#[tokio::test] +async fn reenrollment_commit_recovers_after_each_durable_step() { + let temp = tempfile::tempdir().expect("temp dir"); + let (identity_store, credential_store) = stores(&temp); + let current = identity_store.load_or_create().expect("create identity"); + let pki = TestPki::new(); + let issued = pki.credential(¤t, &format!("urn:rustfs:connect:device:{DEVICE_UID}"), 13); + let registration = server(&pki, vec![Reply::Json(StatusCode::CREATED, issued)]).await; + client(®istration, &pki, Duration::from_secs(2)) + .register(&identity_store, &credential_store, &token()) + .await + .expect("register"); + + let failed = server(&pki, vec![Reply::Json(StatusCode::SERVICE_UNAVAILABLE, json!({})); 3]).await; + assert!(matches!( + client(&failed, &pki, Duration::from_secs(2)) + .reenroll(&identity_store, &credential_store, &token_with_uid(FRESH_TOKEN_UID)) + .await, + Err(ClientError::Unavailable { .. }) + )); + + let pending_path = temp.path().join("credential/registration.pending.json"); + let pending = fs::read(&pending_path).expect("read pending reenrollment"); + let next_der = fs::read(temp.path().join("identity/device.key.next")).expect("read next key"); + let next = rustfs::connect::DeviceIdentity::from_pkcs8_der(&next_der).expect("parse next key"); + let enrolled = pki.credential(&next, &format!("urn:rustfs:connect:device:{DEVICE_UID}"), 14); + write_stored_credential(&temp.path().join("credential/device.crt.json"), &enrolled); + + let idle = server(&pki, vec![]).await; + let idle_client = client(&idle, &pki, Duration::from_secs(2)); + let recovered = idle_client + .reenroll(&identity_store, &credential_store, &token_with_uid(FRESH_TOKEN_UID)) + .await + .expect("recover after reenrollment credential save"); + assert_eq!(recovered.certificate_serial, "0e".repeat(16)); + assert_eq!( + identity_store + .load() + .expect("load key") + .expect("current key") + .public_key_der(), + next.public_key_der() + ); + + fs::remove_file(temp.path().join("credential/registration.completed.json")).expect("remove completed receipt"); + fs::write(&pending_path, pending).expect("restore pending after key commit"); + set_owner_only(&pending_path); + let recovered = idle_client + .reenroll(&identity_store, &credential_store, &token_with_uid(FRESH_TOKEN_UID)) + .await + .expect("recover after reenrollment key commit"); + assert_eq!(recovered.certificate_serial, "0e".repeat(16)); + assert!(!pending_path.exists()); + let recovered = idle_client + .reenroll(&identity_store, &credential_store, &token_with_uid(FRESH_TOKEN_UID)) + .await + .expect("completed reenrollment is idempotent after pending cleanup"); + assert_eq!(recovered.certificate_serial, "0e".repeat(16)); + assert!(idle.seen.lock().expect("seen lock").is_empty()); + + let different = server(&pki, vec![Reply::Json(StatusCode::SERVICE_UNAVAILABLE, json!({})); 3]).await; + assert!(matches!( + client(&different, &pki, Duration::from_secs(2)) + .reenroll(&identity_store, &credential_store, &token_with_uid(SECOND_TOKEN_UID)) + .await, + Err(ClientError::Unavailable { .. }) + )); + assert_eq!(different.seen.lock().expect("seen lock").len(), 3); +} + +#[test] +fn registration_token_schema_is_strict_and_bounded() { + let mut document = serde_json::to_value(token_document()).expect("token document"); + document["unexpected"] = json!(true); + assert!(matches!( + RegistrationToken::from_reader(serde_json::to_vec(&document).expect("token JSON").as_slice()), + Err(TokenError::Invalid(_)) + )); + assert!(matches!( + RegistrationToken::from_reader(vec![b' '; 16 * 1024 + 1].as_slice()), + Err(TokenError::TooLarge) + )); + let mut malformed = token_document(); + malformed["challengeNonce"] = json!("A".repeat(64)); + assert!(matches!( + RegistrationToken::from_reader(serde_json::to_vec(&malformed).expect("token JSON").as_slice()), + Err(TokenError::Shape) + )); +} + +#[tokio::test] +async fn rotation_waits_for_threshold_and_stops_on_revocation() { + let temp = tempfile::tempdir().expect("temp dir"); + let (identity_store, credential_store) = stores(&temp); + let identity = identity_store.load_or_create().expect("create identity"); + let pki = TestPki::new(); + let issued = pki.credential(&identity, &format!("urn:rustfs:connect:device:{DEVICE_UID}"), 3); + let rotation_server = server( + &pki, + vec![ + Reply::Json(StatusCode::CREATED, issued), + Reply::Json(StatusCode::UNAUTHORIZED, json!({"details": [{"reason": "DEVICE_REVOKED"}]})), + ], + ) + .await; + let connect = client(&rotation_server, &pki, Duration::from_secs(2)); + let current = connect + .register(&identity_store, &credential_store, &token()) + .await + .expect("register"); + assert!( + connect + .rotate_if_due(&identity_store, &credential_store, current.not_before_unix) + .await + .expect("not due") + .is_none() + ); + let error = connect + .rotate_if_due(&identity_store, &credential_store, current.not_after_unix - 8 * 60 * 60) + .await + .expect_err("revocation must stop rotation"); + assert!(matches!(error, ClientError::AccessRevoked { .. })); + assert!(error.to_string().contains("ConnectClient::reenroll")); + assert_eq!(rotation_server.seen.lock().expect("seen lock").len(), 2); + let stored: Value = + serde_json::from_slice(&fs::read(temp.path().join("credential/device.crt.json")).expect("read stored credential")) + .expect("stored credential JSON"); + assert_eq!(stored["certificateSerial"], current.certificate_serial); + + let next_der = fs::read(temp.path().join("identity/device.key.next")).expect("read staged next key"); + let next = rustfs::connect::DeviceIdentity::from_pkcs8_der(&next_der).expect("parse staged next key"); + let enrolled = pki.credential(&next, &format!("urn:rustfs:connect:device:{DEVICE_UID}"), 12); + let reenrollment = server(&pki, vec![Reply::Json(StatusCode::CREATED, enrolled)]).await; + let fresh = client(&reenrollment, &pki, Duration::from_secs(2)) + .reenroll(&identity_store, &credential_store, &token_with_uid(FRESH_TOKEN_UID)) + .await + .expect("fresh token reenrolls revoked credential"); + assert_eq!(fresh.certificate_serial, "0c".repeat(16)); + assert_eq!( + identity_store + .load() + .expect("load identity") + .expect("identity") + .public_key_der(), + next.public_key_der() + ); +} + +#[test] +fn unconfigured_connect_has_no_side_effects() { + let temp = tempfile::tempdir().expect("temp dir"); + let directory = temp.path().join("connect"); + assert!( + ConnectClient::from_optional_config(None) + .expect("unconfigured is valid") + .is_none() + ); + assert!(!directory.exists()); +} From 61b5edf16ee02826688893563d3656e45c8da976 Mon Sep 17 00:00:00 2001 From: Zhengchao An Date: Sat, 22 Aug 2026 07:09:32 +0800 Subject: [PATCH 04/10] chore(ecstore): standardize 24 bare TODO/FIXME to tracked format (#6346) --- crates/ecstore/src/bucket/bucket_target_sys.rs | 2 +- crates/ecstore/src/cluster/rpc/peer_s3_client.rs | 2 +- crates/ecstore/src/cluster/rpc/remote_disk.rs | 2 +- crates/ecstore/src/core/sets.rs | 2 +- crates/ecstore/src/disk/local.rs | 14 +++++++------- crates/ecstore/src/layout/endpoints.rs | 4 ++-- crates/ecstore/src/object_api/types.rs | 2 +- crates/ecstore/src/set_disk/ops/multipart.rs | 4 ++-- crates/ecstore/src/set_disk/ops/object.rs | 6 +++--- crates/ecstore/src/store/bucket.rs | 2 +- crates/ecstore/src/store/list_objects.rs | 4 ++-- crates/ecstore/src/store/multipart.rs | 4 ++-- crates/ecstore/src/store/rebalance.rs | 2 +- 13 files changed, 25 insertions(+), 25 deletions(-) diff --git a/crates/ecstore/src/bucket/bucket_target_sys.rs b/crates/ecstore/src/bucket/bucket_target_sys.rs index f5ac0c013..74bf96d7f 100644 --- a/crates/ecstore/src/bucket/bucket_target_sys.rs +++ b/crates/ecstore/src/bucket/bucket_target_sys.rs @@ -866,7 +866,7 @@ impl BucketTargetSys { return Some(cli); } - // TODO: spawn a task to reload the target + // TODO(backlog): spawn an async task to proactively reload the replication target if self.is_reloading_target(bucket, arn).await { return None; } diff --git a/crates/ecstore/src/cluster/rpc/peer_s3_client.rs b/crates/ecstore/src/cluster/rpc/peer_s3_client.rs index d44651dce..72db2062c 100644 --- a/crates/ecstore/src/cluster/rpc/peer_s3_client.rs +++ b/crates/ecstore/src/cluster/rpc/peer_s3_client.rs @@ -454,7 +454,7 @@ impl S3PeerSys { } } topology_complete &= bucket_map.values().all(|count| *count >= quorum); - // TODO: MRF + // TODO(backlog): integrate MRF backlog stats into scanner bucket listing } let mut buckets: Vec = result_map.into_values().collect(); diff --git a/crates/ecstore/src/cluster/rpc/remote_disk.rs b/crates/ecstore/src/cluster/rpc/remote_disk.rs index ed8772f53..efb1b4d8d 100644 --- a/crates/ecstore/src/cluster/rpc/remote_disk.rs +++ b/crates/ecstore/src/cluster/rpc/remote_disk.rs @@ -2406,7 +2406,7 @@ impl DiskAPI for RemoteDisk { return errors; } - // TODO: use Error not string + // TODO(backlog): replace string errors with typed `StorageError` variants let result = self .execute_with_timeout( diff --git a/crates/ecstore/src/core/sets.rs b/crates/ecstore/src/core/sets.rs index 1d1bcedeb..3acf1a705 100644 --- a/crates/ecstore/src/core/sets.rs +++ b/crates/ecstore/src/core/sets.rs @@ -249,7 +249,7 @@ impl Sets { self.connect_disks().await; - // TODO: config interval + // TODO(backlog): make monitor_and_connect interval configurable instead of hardcoded 15s let mut interval = tokio::time::interval(Duration::from_secs(15)); loop { tokio::select! { diff --git a/crates/ecstore/src/disk/local.rs b/crates/ecstore/src/disk/local.rs index 0a9b11ef1..2d7270cff 100644 --- a/crates/ecstore/src/disk/local.rs +++ b/crates/ecstore/src/disk/local.rs @@ -5215,8 +5215,8 @@ impl LocalDisk { let cache = Cache::new(update_fn, Duration::from_secs(1), Opts::default()); - // TODO: DIRECT support - // TODD: DiskInfo + // TODO(backlog): add O_DIRECT I/O support for performance-critical paths + // TODO(backlog): populate DiskInfo in constructor let mut disk = Self { root: root.clone(), publication_root, @@ -5751,7 +5751,7 @@ impl LocalDisk { // return Ok(()); - // TODO: async notifications for disk space checks and trash cleanup + // TODO(backlog): make disk space checks and trash cleanup event-driven instead of poll-based let trash_path = self.io_get_object_path(RUSTFS_META_TMP_DELETED_BUCKET, Uuid::new_v4().to_string().as_str())?; // if let Some(parent) = trash_path.parent() { @@ -5997,7 +5997,7 @@ impl LocalDisk { #[hotpath::measure(impl_type = "LocalDisk")] async fn read_all_data(&self, volume: &str, volume_dir: impl AsRef, file_path: impl AsRef) -> Result> { - // TODO: timeout support + // TODO(backlog): add configurable timeout for read_all_data operations let (data, _) = self.read_all_data_with_dmtime(volume, volume_dir, file_path).await?; Ok(data) } @@ -6674,7 +6674,7 @@ impl LocalDisk { return Ok(()); } - // TODO: add lock + // TODO(backlog): add directory listing lock to prevent concurrent enumeration let stall = opts.stall_timeout_duration(); @@ -8796,7 +8796,7 @@ impl DiskAPI for LocalDisk { Ok(entries) } - // FIXME: TODO: io.writer TODO cancel + // TODO(backlog): support io.writer cancellation and early termination in walk_dir #[tracing::instrument(level = "trace", skip_all)] async fn walk_dir(&self, opts: WalkDirOptions, wr: &mut W) -> Result<()> { self.wait_for_startup_cleanup().await; @@ -9880,7 +9880,7 @@ impl DiskAPI for LocalDisk { ); return Err(e); } - // TODO: health check + // TODO(backlog): add post-setup disk health verification } Ok(()) } diff --git a/crates/ecstore/src/layout/endpoints.rs b/crates/ecstore/src/layout/endpoints.rs index 1f1a9bdd1..3212e3822 100644 --- a/crates/ecstore/src/layout/endpoints.rs +++ b/crates/ecstore/src/layout/endpoints.rs @@ -249,7 +249,7 @@ impl PoolEndpointList { endpoint.set_set_index(0); endpoint.set_disk_index(0); - // TODO Check for cross device mounts if any. + // TODO(backlog): check for cross-device mounts in single-drive setup return Ok(Self { inner: vec![Endpoints::from(vec![endpoint])], @@ -264,7 +264,7 @@ impl PoolEndpointList { // Convert args to endpoints let mut eps = Endpoints::try_from(set_layout.as_slice())?; - // TODO Check for cross device mounts if any. + // TODO(backlog): check for cross-device mounts in multi-pool setup for (disk_idx, ep) in eps.as_mut().iter_mut().enumerate() { ep.set_pool_index(pool_idx); diff --git a/crates/ecstore/src/object_api/types.rs b/crates/ecstore/src/object_api/types.rs index 3df802115..1bbff7a7f 100644 --- a/crates/ecstore/src/object_api/types.rs +++ b/crates/ecstore/src/object_api/types.rs @@ -1091,7 +1091,7 @@ impl ObjectInfo { } }; - // TODO:VersionPurgeStatus + // TODO(backlog): handle VersionPurgeStatus in object listing let versioned = vcfg.clone().map(|v| v.0.versioned(&entry.name)).unwrap_or_default(); objects.push(ObjectInfo::from_file_info(&fi, bucket, &entry.name, versioned)); diff --git a/crates/ecstore/src/set_disk/ops/multipart.rs b/crates/ecstore/src/set_disk/ops/multipart.rs index 0f418fa7f..6af71db17 100644 --- a/crates/ecstore/src/set_disk/ops/multipart.rs +++ b/crates/ecstore/src/set_disk/ops/multipart.rs @@ -1575,7 +1575,7 @@ impl crate::storage_api_contracts::multipart::MultipartOperations for SetDisks { let parts_metadata = vec![fi.clone(); disks.len()]; if !user_defined.contains_key("content-type") { - // TODO: get content-type + // TODO(backlog): detect content-type from part data when header is missing } if let Some(sc) = user_defined.get(AMZ_STORAGE_CLASS) @@ -1971,7 +1971,7 @@ impl crate::storage_api_contracts::multipart::MultipartOperations for SetDisks { return Err(Error::InvalidPart(p.part_num, ext_part.etag.clone(), p.etag.clone().unwrap_or_default())); } - // TODO: crypto + // TODO(backlog): integrate encryption verification during complete multipart if (i < uploaded_parts.len() - 1) && !(opts.data_movement && ext_part.actual_size < 0) diff --git a/crates/ecstore/src/set_disk/ops/object.rs b/crates/ecstore/src/set_disk/ops/object.rs index 9ba7f8da7..cb8f70766 100644 --- a/crates/ecstore/src/set_disk/ops/object.rs +++ b/crates/ecstore/src/set_disk/ops/object.rs @@ -6161,7 +6161,7 @@ impl crate::storage_api_contracts::object::ObjectOperations for SetDisks { join_all(rollback_futures).await; - // TODO: add_partial + // TODO(backlog): support partial object deletion for multi-part objects if let Some(api) = opts.tier_delete_journal_api.as_ref() { for (idx, je) in persisted_journal_entries { @@ -6371,7 +6371,7 @@ impl crate::storage_api_contracts::object::ObjectOperations for SetDisks { } } - // TODO: Lifecycle + // TODO(backlog): integrate lifecycle evaluation before object deletion let mut version_found = true; // delete_object_version below derives its own majority quorum from the @@ -6465,7 +6465,7 @@ impl crate::storage_api_contracts::object::ObjectOperations for SetDisks { mark_deleted: mark_delete, mod_time: Some(mod_time), replication_state_internal: opts.delete_replication.as_ref().map(replication_state_to_filemeta), - ..Default::default() // TODO: Transition + ..Default::default() // TODO(backlog): populate transition state on delete markers }; fi.set_tier_free_version_id(&find_vid.to_string()); diff --git a/crates/ecstore/src/store/bucket.rs b/crates/ecstore/src/store/bucket.rs index 1fac01899..77cdbc954 100644 --- a/crates/ecstore/src/store/bucket.rs +++ b/crates/ecstore/src/store/bucket.rs @@ -601,7 +601,7 @@ impl ECStore { #[instrument(skip(self))] pub(super) async fn handle_list_bucket(&self, opts: &BucketOptions) -> Result> { - // TODO: opts.cached + // TODO(backlog): support cached bucket listing via opts.cached let mut buckets = self.peer_sys.list_bucket(opts).await?; diff --git a/crates/ecstore/src/store/list_objects.rs b/crates/ecstore/src/store/list_objects.rs index 558bb7c94..0d8d238f9 100644 --- a/crates/ecstore/src/store/list_objects.rs +++ b/crates/ecstore/src/store/list_objects.rs @@ -4673,7 +4673,7 @@ async fn gather_results( entry.name = entry.name.replace("\\", "/"); } - // TODO: rx.recv() + // TODO(backlog): integrate rx.recv() for incremental listing results if let Some(marker) = &opts.marker && ((!opts.include_marker && &entry.name <= marker) || (opts.include_marker && &entry.name < marker)) @@ -4703,7 +4703,7 @@ async fn gather_results( continue; } - // TODO: Lifecycle + // TODO(backlog): integrate lifecycle evaluation during object listing entries.push(Some(entry)); candidate_entries += 1; diff --git a/crates/ecstore/src/store/multipart.rs b/crates/ecstore/src/store/multipart.rs index 3d460d4d5..2c0b18b2a 100644 --- a/crates/ecstore/src/store/multipart.rs +++ b/crates/ecstore/src/store/multipart.rs @@ -332,7 +332,7 @@ impl ECStore { let expected_incarnation_id = opts.expected_bucket_incarnation_id; if request.prefix.is_empty() { - // TODO: return from cache + // TODO(backlog): return cached multipart listing when prefix is empty } if self.single_pool() { @@ -610,7 +610,7 @@ impl ECStore { let (opts, _bucket_lifecycle_guard) = self.guard_multipart_bucket_incarnation(bucket, opts).await?; let opts = &opts; - // TODO: defer DeleteUploadID + // TODO(backlog): defer DeleteUploadID to background for faster abort response if self.single_pool() { return self.pools[0].abort_multipart_upload(bucket, object, upload_id, opts).await; diff --git a/crates/ecstore/src/store/rebalance.rs b/crates/ecstore/src/store/rebalance.rs index 79e3abf91..7d7c1d91e 100644 --- a/crates/ecstore/src/store/rebalance.rs +++ b/crates/ecstore/src/store/rebalance.rs @@ -385,7 +385,7 @@ impl ECStore { } pub(super) async fn is_suspended(&self, idx: usize) -> bool { - // TODO: LOCK + // TODO(backlog): acquire pool metadata lock for consistent suspension check let pool_meta = self.pool_meta.read().await; From 37c5ce13996cb4577e0852f136a0b09a442d0bdc Mon Sep 17 00:00:00 2001 From: Zhengchao An Date: Sat, 22 Aug 2026 08:19:53 +0800 Subject: [PATCH 05/10] docs(agents): streamline instruction routing (#6358) --- .../skills/adversarial-validation/SKILL.md | 296 ++-------- .../references/compatibility.md | 24 + .../references/concurrency-durability.md | 23 + .../references/correctness.md | 29 + .../references/performance.md | 20 + .../references/security.md | 31 + .../references/simplicity.md | 22 + .../references/test-coverage.md | 24 + .../skills/code-change-verification/SKILL.md | 6 +- .../agents/openai.yaml | 2 +- .agents/skills/pr-creation-checker/SKILL.md | 117 ++-- .../pr-creation-checker/agents/openai.yaml | 2 +- .../references/pr-readiness-checklist.md | 16 - .agents/skills/rust-code-quality/SKILL.md | 7 +- .../skills/rustfs-logging-governance/SKILL.md | 123 +--- .../references/logging-governance.md | 315 ++--------- .../skills/rustfs-release-publish/SKILL.md | 2 +- .../rustfs-release-version-bump/SKILL.md | 8 +- .../agents/openai.yaml | 2 +- .../skills/security-advisory-lessons/SKILL.md | 180 +----- .../agents/openai.yaml | 2 +- AGENTS.md | 531 +++++++----------- crates/AGENTS.md | 8 +- crates/audit/AGENTS.md | 1 - crates/e2e_test/AGENTS.md | 1 - crates/ecstore/AGENTS.md | 1 - crates/iam/AGENTS.md | 1 - crates/notify/AGENTS.md | 1 - crates/policy/AGENTS.md | 1 - crates/targets/AGENTS.md | 1 - rustfs/src/admin/AGENTS.md | 1 - rustfs/src/storage/AGENTS.md | 1 - 32 files changed, 545 insertions(+), 1254 deletions(-) create mode 100644 .agents/skills/adversarial-validation/references/compatibility.md create mode 100644 .agents/skills/adversarial-validation/references/concurrency-durability.md create mode 100644 .agents/skills/adversarial-validation/references/correctness.md create mode 100644 .agents/skills/adversarial-validation/references/performance.md create mode 100644 .agents/skills/adversarial-validation/references/security.md create mode 100644 .agents/skills/adversarial-validation/references/simplicity.md create mode 100644 .agents/skills/adversarial-validation/references/test-coverage.md delete mode 100644 .agents/skills/pr-creation-checker/references/pr-readiness-checklist.md diff --git a/.agents/skills/adversarial-validation/SKILL.md b/.agents/skills/adversarial-validation/SKILL.md index 4eddc3551..323be5fa1 100644 --- a/.agents/skills/adversarial-validation/SKILL.md +++ b/.agents/skills/adversarial-validation/SKILL.md @@ -1,277 +1,45 @@ --- name: adversarial-validation -description: Execute the Adversarial Validation policy from the root AGENTS.md — run the applicable reviewer roles with RustFS-specific attack probes. Use on every behavior-affecting code change, bug fix, design proposal, or agent-instruction change that alters execution before declaring it done. +description: Review a final RustFS diff adversarially when the user requests adversarial review, the root AGENTS.md classifies the change as high risk, or a substantial PR is being reviewed. Do not use for ordinary questions, diagnosis, planning, status, documentation-only work, or routine low-risk implementation. --- -# Adversarial Validation Playbooks +# RustFS Adversarial Validation -The policy — risk tiers, role list, protocol, exit criteria — lives in the -root `AGENTS.md` under "Adversarial Validation (Default On)". Read it first; -this skill does not restate it. This file adds the RustFS-specific probe -playbook for each role: concrete attacks, where they apply, and the real -shipped bug or rule that earns each probe its place. +Use the risk tier and review shape defined in the root `AGENTS.md`. This skill +routes a review to RustFS-specific probes without loading unrelated domains. -## How to run a role +## Select Lenses -1. Pick the tier and the applicable roles per the root `AGENTS.md`. -2. Run each role as an independent pass over the final diff — a parallel - reviewer agent where the tooling supports it, otherwise a fresh - sequential pass that starts from the diff and the nearest scoped - `AGENTS.md`, discarding the writing session's assumptions. -3. Within a role, execute the probes whose domain the diff touches, plus any - attack the diff obviously invites that no probe lists — the playbook is a - floor, not a ceiling. -4. Report findings (concrete failure scenario or named missing test, with - file:line) or the role's null report: "attacked X, Y, Z — no break - found". A bare pass is not a result. +Read only the references required by the diff: -## Role playbooks +| Lens | When to read | +|---|---| +| [Correctness](references/correctness.md) | Every non-exempt adversarial review | +| [Simplicity](references/simplicity.md) | Mechanical/standard changes and production growth | +| [Test coverage](references/test-coverage.md) | Behavior or test changes | +| [Security](references/security.md) | Authn/authz, IAM, RPC trust, paths, secrets, parsing, browser, encryption | +| [Concurrency/durability](references/concurrency-durability.md) | Async shared state, locks, storage commit, cancellation, persisted queues | +| [Compatibility](references/compatibility.md) | S3 surface, MinIO interop, metadata, wire/disk formats, mixed versions | +| [Performance](references/performance.md) | Request/object hot paths, allocation, blocking work, fsync, fan-out | -### Correctness adversary +Do not read all references as a precaution. A path name alone is insufficient; +the changed behavior must touch the lens's domain. -- For any change touching error aggregation or quorum decisions, build the exact disk-error slice at the quorum boundary: N disks where successes == quorum, then flip one success to an error (quorum-1) and separately inject None/nil placeholder entries into the slice. Trace whether reduce_errs (or the new equivalent) picks the placeholder as the dominant error or lets quorum-1 pass as success. Also check heal/write paths: does a per-target failure at quorum-1 return an explicit error, or silently degrade to success? - - Where: crates/ecstore/src/disk/error_reduce.rs; crates/ecstore/src/set_disk/{core,ops}; crates/heal - - Evidence: Commit 20d61c73b 'stop reduce_errs leaking nil placeholder as dominant error' (#4551) and 47c1e730c 'make erasure heal write quorum best-effort per target' (#4545); crates/ecstore/AGENTS.md: 'Do not weaken quorum checks... Prefer explicit failure over silent data corruption or implicit success.' -- For any change in EC read/reconstruct/streaming code, trace the mid-stream error path: the first K shards read fine, then a shard turns out bitrot-corrupt or inconsistent after N bytes have already been sent to the client. Verify the error propagates as a stream error (client sees failure), not a clean end-of-body — a silently truncated GET body is data corruption. Also re-check byte accounting: sum of per-part bytes vs object size, and partNumber-to-offset routing for the first and last part. - - Where: crates/ecstore/src/set_disk/read.rs (reconstruct-read, inconsistent_source_indexes handling ~line 3827); codec streaming paths in crates/ecstore/src/erasure_coding - - Evidence: Known live bug: EC reconstruct-read failing on inconsistent shards mid-stream silently truncates GET body → client 'unexpected EOF'; commit 15808254d 'correct codec-streaming byte accounting and partNumber routing' (#4535). -- For any listing/pagination change, construct the exact-boundary inputs: (a) exactly max_keys/max_uploads matching entries — assert the response contains max and is_truncated=false, then max+1 entries — assert exactly max returned with is_truncated=true and a correct continuation marker; (b) a delimiter listing where folding into CommonPrefixes re-fills a full page; (c) an object 'a' coexisting with prefix dir 'a/'. Off-by-one and dropped-truncation bugs live exactly at these boundaries. - - Where: crates/ecstore listing/merge paths (metacache, list_objects, list_multipart_uploads); rustfs/src/storage - - Evidence: Three recent real bugs: fefa70b31 'stop ListMultipartUploads from returning one upload past max-uploads' (#4447), d91f4d455 'report truncation when delimiter list re-folds a full page' (#4538), 7e1f7f242 'preserve CommonPrefixes when an object and same-named prefix dir coexist' (#4563). -- Run the diff's logic with a directory object key (trailing slash, e.g. 'pre/dir/') as input. Check which layer encodes/decodes __XLDIR__ — set_disk never sees the trailing slash, so any trailing-slash branch added below the store layer is dead code and a wrong-layer bug. For delete paths, check whether options force a nil versionId onto directory keys: the resulting miss surfaces as version-not-found, not object-not-found, so callers matching only ObjectNotFound leak ghost directory entries. - - Where: crates/ecstore/src/store*.rs (store layer) vs crates/ecstore/src/set_disk/*; delete option construction (del_opts) and its callers - - Evidence: trailing-slash branches must live at store layer; del_opts injects nil version for dir keys, PR#4220 ghost-directory cleanup never fired on the real path (rustfs#4307, backlog#798 still OPEN). -- Feed every new binary-UUID metadata read the three degenerate values: key absent, zero-length bytes, and 16 zero bytes (nil UUID). All three must mean 'no value' — any path that produces Uuid::nil() and then acts on it (e.g. sends it as a versionId) is a finding. For tier code specifically: with remote-tier version None or "", assert the tier GET/DELETE request carries no versionId parameter at all — sending versionId="" or nil yields NoSuchVersion against unversioned tier buckets. - - Where: crates/filemeta/src/filemeta/version.rs; crates/ecstore/src/bucket/lifecycle/; crates/ecstore/src/services/tier/; any new consumer of crates/utils/src/http/metadata_compat.rs - - Evidence: AGENTS.md Cross-Cutting Domain Invariants (defensive Uuid read pattern + unversioned-tier rule); docs/operations/tier-ilm-debugging.md ('nil transition_ver_id = corrupt legacy write-back, readers must filter'); commit 726f3dc18 'accept empty remote version_id in tier recovery paths' (#4552). -- For each match/if-let on an error or algorithm enum touched by the diff, enumerate what the wildcard/else arm swallows. Inject the variants the author didn't think of — DiskNotFound during listing, an unsupported checksum algorithm, an Err from a cleanup rename/delete — and trace whether they degrade into 'not found', a wrong-but-plausible value, or silent success. Any error path that converges with the success path without logging and propagating is a finding. - - Where: crates/ecstore (listing, delete/rename cleanup); crates/checksums; error-mapping layers in rustfs/src/storage - - Evidence: Three recent real bugs of this exact shape: e0619e355 'stop treating DiskNotFound as object not-found in listing' (#4536), afaf8c681 'reject md5 instead of silently returning crc32' (#4513), f7d2b2563 'propagate disk delete/rename failures instead of swallowing them' (#4546). -- For any change to version ordering, index lookup, or shard/part indexing: (a) call the accessor with index == len() and len()-1 — a get_idx-style bound must reject, not panic or wrap; (b) construct two versions with identical mod-times and check the sort tie-break is total and deterministic (equal keys must not compare as both before each other); (c) for EC shard math, compute shard size for object sizes 0, 1, blockSize-1, blockSize, blockSize+1 and cross-check total reconstructed length against the object size. - - Where: crates/filemeta/src/filemeta/*.rs (version sort, get_idx); crates/ecstore/src/erasure_coding shard-size math - - Evidence: Commit 8bfb00bc0 'guard get_idx bound and fix sorts_before tie-break' (#4509) — both bug classes shipped before; ecstore AGENTS.md high-risk designation for read/write/repair correctness. -- Exercise the zero/empty end of every new size or count parameter: zero-length object PUT then GET (body must be empty, not error), part count 0, empty Vec of disks/entries into aggregation functions, and env/config values of 0 (must clamp or reject, never divide-by-zero or 'scan nothing and report zero usage'). Anywhere the diff computes a ratio, capacity, or progress percentage, plug in 0 and the max value. - - Where: crates/ecstore aggregation and scanner paths; crates/object-capacity; config/env parsing in touched crates - - Evidence: Commits 787cc77a7 'clamp zero capacity env values to safe defaults' (#4559) and 32b1094ec 'resolve a symlinked scan root instead of silently counting zero' (#4564) — zero-as-silent-wrong-answer is a recurring repo bug class. -- For any diff touching multipart or object commit paths, order the operations on paper and attack the failure point between them: kill the process (or return Err) after the commit rename but before cleanup, and after cleanup but before commit. Verify the earlier-failure case leaves the object readable and the later-failure case leaves no half-visible object; part meta files must never be deleted before the commit is durable. - - Where: crates/ecstore multipart commit/cleanup (set_disk/ops); rustfs/src/storage multipart handlers - - Evidence: Commit c77c5f047 'defer multipart part.N.meta cleanup until after commit' (#4548) — cleanup-before-commit ordering already caused a real data-loss window; the #4221 durability work shows fsync/ordering bugs are endemic here. +For a dedicated security audit or advisory analysis, use +`security-advisory-lessons` instead of loading it automatically during every +adversarial review. -Null report example: "Attacked quorum-1 error reduction, exact max-keys listing boundary, trailing-slash dir keys, nil-UUID tier versionId, and mid-stream reconstruct error propagation — no break found." +## Review Protocol -### Simplicity adversary +1. Freeze the exact final diff/head and list the selected lenses. +2. Run the review shape required by root `AGENTS.md`. +3. For each selected lens, either report a concrete finding or a null verdict + naming the attacks performed. +4. A finding needs `file:line`, a triggering input/state/interleaving, the wrong + outcome, and a focused fix or missing regression check. +5. Fix or rebut every finding with code-path, test, or invariant evidence. +6. After a non-trivial edit, rerun only lenses affected by that edit against the + new exact diff. -- Smaller-diff attack: inspect production growth separately from tests, fixtures, generated code, and documentation; test additions have no growth budget. Rewrite the production diff mentally (or in scratch) as the minimal equivalent edit. Report a finding only with a concrete smaller design that preserves correctness, compatibility, readability, and real boundaries; fewer lines alone are not evidence. - - Where: Any diff; extra scrutiny for crates/ecstore, crates/lock, rustfs/src/storage where 'preserve the existing control-flow shape' is an explicit rule - - Evidence: AGENTS.md 'Change Style for Existing Logic' (conditional extraction rule, preserve sensitive control flow, canonical modules) and 'Reuse Before You Write'; the Adversarial Validation roles list charters this attack. -- Reuse-and-necessity attack: for each new helper, search `crates/utils`, `crates/common`, the touched crate, the likely domain owner, and relevant direct dependencies. A reimplementation is a finding, but forced reuse with mismatched normalization, error, backoff, or durability semantics is also a finding. Demand a nameable trigger for new defensive branches. Tests remain subject to validity and near-duplicate coverage review, never a size limit. - - Where: Any diff adding helpers, branches on decoded/peer data, or tests - - Evidence: AGENTS.md 'Reuse Before You Write' and 'Necessary Code Only'; GHSA-f4vq-9ffr-m8m3 (normalization-asymmetry traversal — why forced reuse of normalizing helpers on raw keys is itself an attack); docs/operations/tier-ilm-debugging.md nil-versionId incident (why boundary re-checks are load-bearing). -- Replacement-and-comment attack: when the diff introduces a replacement path or representation, trace all callers and flag a superseded in-scope path left behind without a compatibility requirement. Keep one canonical core behind compatibility adapters. Comments must state non-obvious invariants completely without narration or change history. Never demand unrelated deletion or trade away correctness, compatibility, or readability to reduce the diff. - -Null report example: "Separated production growth from tests/docs, tested a smaller equivalent, checked helper reuse and superseded paths, and found no break." - -### Security reviewer - -- For every admin handler in the diff, grep the exact AdminAction constant it passes to validate_admin_request and confirm it names the operation the handler actually performs. Construct the escalation: a low-privileged user whose policy grants the wrong-but-adjacent action (e.g. Export while the handler Imports, or Update while it Lists) — if the mismatched constant lets them through, that is the bug. Also confirm read-only endpoints (metrics, list, server-info, diagnostics) still call an operation-specific admin authz path and not a mere 'credentials exist' check. - - Where: rustfs/src/admin/handlers/**, rustfs/src/admin/router registration; check_permissions / validate_admin_request / AdminAction::* call sites - - Evidence: GHSA-vcwh-pff9-64cc (ImportIam checked ExportIAMAction), GHSA-mm2q-qcmx-gw4w (ListServiceAccount used UpdateServiceAccountAdminAction), GHSA-f5cv-v44x-2xgf (/admin/v3/metrics accepted any authenticated IAM user). advisory-patterns.md 'Admin authorization and route exposure'; rustfs/src/admin/AGENTS.md 'route registration, whitelist, handler authz must agree'. -- If the diff touches service-account or IAM import/update, treat parent, claims, accessKey, secretKey, status, policy names, and groups as attacker-controlled. Construct an ImportIam/create payload where parent points at root (or another user) and prove the code writes credentials without proving caller ownership or root authority. Separately, set deny_only=true (or 'no explicit deny') on a restricted account and check it does not skip the required allow check, letting it mint an unrestricted child. - - Where: crates/iam/, rustfs/src/admin/handlers (service account / import IAM), rustfs/src/auth.rs - - Evidence: GHSA-566f-q62r-wcr8 (attacker-controlled parent/claims/accessKey/secretKey → persistent backdoor under root), GHSA-xgr5-qc6w-vcg9 (deny_only=true skipped allow checks → privilege creation). crates/iam/AGENTS.md security boundaries; advisory-patterns.md 'IAM import, service accounts'. -- For a changed protocol-frontend handler (FTP/FTPS/SFTP/WebDAV/gateway), enumerate ALL sibling command handlers in the same driver — not just the changed one. For each, confirm it calls the per-operation IAM authorize hook mapped to the correct S3 action (RETR→GetObject, SIZE/MDTM→HeadObject, MKD→CreateBucket, bucket probe→ListBucket/HeadBucket) BEFORE touching storage. Construct a denied-authz case and prove the storage backend is never reached. - - Where: crates/protocols/ (FtpsDriver, SftpDriver, WebDAV), authorize_operation call sites - - Evidence: GHSA-3g29-xff2-92vp (FTP RETR/SIZE/MDTM authenticated but skipped IAM), GHSA-g3vq-vv42-f647 (FTPS MKD called create_bucket without s3:CreateBucket). advisory-patterns.md: 'RustFS advisories show mixed guarded and unguarded siblings in the same driver.' -- For any secret/token/signature/password comparison in the diff, check it uses a constant-time compare (e.g. subtle/constant_time_eq), not == or early-return byte loops. Then check the failure-response paths: construct an invalid-user request and an invalid-secret request and confirm they are indistinguishable (same error, no early length short-circuit) so an attacker cannot enumerate valid users or time-side-channel the secret. - - Where: crates/protocols/ (FTPS/WebDAV/FormPost auth), crates/credentials/, rustfs/src/auth.rs, RPC signature verification - - Evidence: GHSA-3p3x-734c-h5vx (FTPS/WebDAV early-return string equality + distinguishable invalid-user vs invalid-password). Fix commits 3c3113619 (constant-time FTPS/WebDAV) and c41062f27 (constant-time FormPost signature). 3p3x was fixed by PR #4403. -- If the diff parses or transports secret-bearing config (env vars, key files, connection strings), grep every error-construction and format site on that value's path (`format!` feeding `Error::other`/`configuration_error`/`panic!`/`expect`) for interpolation of the raw value or of variables named like secret material. Construct the likeliest misconfiguration: the operator supplies the bare secret without the expected `:` prefix (or with a stray newline) — if the parse-failure hint echoes the input, the secret lands in startup logs. Error strings are log content; the hint may name the env var and expected format, never the value. If the diff re-implements an existing parse helper, diff the two error paths — the duplicate is where the leak hides. - - Where: rustfs/src/init.rs (env plumbing), crates/kms/src/config.rs, crates/credentials/, any from_env/parse on secret values; mechanical backstop in scripts/check_logging_guardrails.sh (secret-interpolation check) - - Evidence: PR #5222 introduced `got: {secret_str}` in build_static_kms_config's format-hint error — a bare base64 key (the secret itself) would have been echoed into startup logs; fixed by PR #5243. The parallel parse in KmsConfig::from_env already omitted the value: the leak lived only in the duplicated copy (AGENTS.md 'Reuse Before You Write'). -- If the diff touches internode/RPC auth secret handling, trace whether the RPC HMAC secret can fall back to a public default (e.g. 'rustfsadmin', 'rustfs rpc') or be derived deterministically from the S3 root credentials. Construct the case where RUSTFS_RPC_SECRET is unset and confirm the code fails closed rather than silently using a default or a root-derived key. Verify RPC signing keys are independent random secrets, not reused across S3-root/RPC-HMAC/STS-JWT roles. - - Where: crates/credentials/, crates/ecstore/src/rpc/, internode auth setup - - Evidence: GHSA-r5qv-rc46-hv8q (fell back to 'rustfsadmin'), GHSA-75fx/68cw (RPC secret derivable from root creds → forgeable signatures), GHSA-h956 (hard-coded 'rustfs rpc'), GHSA-m77q (STS JWT reused root secret). Fix commit 7b2055405 (fail closed when deriving RPC secret from default credentials, PR#4402). -- If the diff touches RPC/NodeService authentication, verify the HMAC payload binds the EXACT concrete gRPC method path (not a service prefix), the HTTP method surrogate, and a fresh timestamp. Construct captured valid metadata for method A and replay it to method B within the timestamp window — if it authorizes, the signature is under-bound. Also test stale timestamp, wrong path, wrong method, wrong secret. - - Where: crates/ecstore/src/rpc/, verify_rpc_signature / NodeServiceServer, x-rustfs-signature handling - - Evidence: GHSA-c667-rgrv-99vj (signed service prefix instead of concrete method path → cross-method replay in timestamp window). advisory-patterns.md 'RPC input validation and panic safety'; Minimum Regression Test Expectations lists replay across two methods. -- For any RPC/gRPC handler or deserialization touched, feed empty bytes, truncated MessagePack/protobuf, invalid enum discriminants, and stale timestamps. Grep the deserialization path for unwrap()/expect()/panic-prone decode and prove malformed attacker payloads return a typed error, not a panic (remote DoS). Weak internode auth makes reachability worse, so combine with the RPC-secret probe. - - Where: crates/ecstore/src/rpc/, any #[derive(Deserialize)] decoded from wire bytes, RPC handler bodies - - Evidence: GHSA-gw2x-q739-qhcr (malformed GetMetrics reached unwrap() → remote DoS). advisory-patterns.md 'Treat all RPC payload bytes as attacker-controlled.' rust-code-quality skill: unwrap abuse. -- Take any object key, RPC disk path, or archive/tar/zip entry name introduced or handled in the diff and construct traversal payloads: '../', URL-encoded '%2e%2e%2f', absolute paths, platform separators, empty components. Trace the value through parse → authz check → final storage path and prove (a) authz and storage normalize the SAME way, and (b) the canonicalized path cannot escape the bucket/prefix root. Attack the case where authz sees the raw attacker bucket but storage cleaning crosses into a victim bucket. - - Where: crates/ecstore (path join/canonicalize), rustfs/src/storage/, Snowball auto-extract / normalize_extract_entry_key, rpc read_file_stream - - Evidence: GHSA-pq29-69jg-9mxc (read_file_stream joined untrusted paths, no canonical boundary check), GHSA-8r6f-hmq2-28rg (traversal object keys bypassed authz), GHSA-f4vq-9ffr-m8m3 (Snowball '../victim-bucket/object' authorized raw path then storage crossed boundary). Note __XLDIR__ trailing-slash encoding is store-layer only. -- If the diff touches multipart/copy or presigned POST, verify UploadPartCopy enforces source GetObject AND destination PutObject semantics equivalent to CopyObject, including copy-source policy conditions (not just independent source-read + dest-write). Construct a cross-bucket UploadPartCopy from a bucket the caller cannot read. For presigned POST, submit an upload that violates content-length-range, key prefix, or exact content-type and prove the server rejects it. - - Where: rustfs/src/storage / S3 API handlers: upload_part_copy, CompleteMultipartUpload, PostObject policy enforcement - - Evidence: GHSA-mx42-j6wv-px98 (UploadPartCopy missed source authz → cross-bucket exfil), GHSA-wfxj-ph3v-7mjf (missed destination copy-source policy constraint), GHSA-w5fh-f8xh-5x3p (presigned POST didn't enforce signed policy conditions). advisory-patterns.md 'S3 copy, multipart, and upload policy validation'. -- Grep the diff for debug!/trace!/info!/error! and any ?value / {:?} on structs or response bodies that can carry secret_key, session_token, JWT claims, HMAC secrets, expected signatures, access keys beyond safe identifiers, or raw credential-bearing responses. Check custom Debug impls and merged-config dumps too. Construct the error path (invalid signature, failed auth) and confirm it does not log the secret or the derived authenticator. Verify audit/notify entries redact credential request headers. - - Where: rustfs/src/**, crates/iam/, crates/audit/, crates/notify/, crates/targets/, RPC signature error paths - - Evidence: GHSA-r54g (STS creds logged at info), GHSA-8cm2 (debug logs leaked tokens/secrets/JWT claims/raw STS bodies), GHSA-333v (invalid RPC signature log included HMAC secret + expected signature). Fix commit ee6f79110 (redact credential request headers from audit/notify, backlog#963). rustfs-logging-governance skill. -- For any struct in the diff deserialized from untrusted input (S3 XML/JSON, lifecycle rules, bucket policy, replication config, RPC payload), check for #[serde(deny_unknown_fields)]. Construct a payload with a typo'd field (e.g. 'NoncurentDays') or an extra field and prove it is rejected, not silently ignored. Flag #[serde(default)] on security-critical fields (retention days, limits, permissions) lacking explicit post-deserialize validation, and any user-controlled integer cast with `as` (i32 as u32) — feed a negative value and check it doesn't wrap to a huge positive. - - Where: crates/policy/ (bucket policy), crates/ecstore lifecycle/ILM config, replication config structs, crates/protocols XML parsing - - Evidence: AGENTS.md 'Serde Safety'; advisory-patterns.md 'Serde deserialization' (no deny_unknown_fields found repo-wide; 'NoncurentDays' typo silently accepted; i32 as u32 wrap). Fix commit 1acd47f15 (SSE crash-loop DoS + credential reserved-char bypass, backlog#806). -- If the diff touches SSE / encryption reader-writer composition, do not trust API metadata claiming encryption. Trace the reader wrapper order (HashReader / EncryptReader / compression / warp) and confirm EncryptReader is actually in the chain that writes to disk — construct the case where a helper unwraps a nested reader and bypasses encryption, storing plaintext. Require a regression test that inspects the ACTUAL stored bytes on disk, not just read-back. Also check encrypted-object checksums are not exposed. - - Where: rustfs/src/storage/ecfs.rs, crates/rio/ (reader wrappers), crates/kms/, SSE-C replication - - Evidence: GHSA-xrrf-67jm-3c2r (SSE metadata reported encryption while composition bypassed EncryptReader, stored plaintext). Fix commits a7b9659e7 (hide encrypted object checksums, #4529), 80cc3b1fc (preserve SSE-C checksum state, #4410). advisory-patterns.md 'SSE and on-disk storage invariants'. -- If the diff touches CORS or the console/browser/object-preview surface: confirm default CORS does not reflect an arbitrary Origin while also sending Access-Control-Allow-Credentials: true — construct a request with a spoofed Origin and check the response. For preview, confirm attacker-controlled object content is origin-isolated (not rendered in a same-origin iframe with console creds), served with nosniff/CSP, and that preview trust derives from validated content-type + sandboxing, NOT from object name/extension (.pdf, .html). Separately, if aws:SourceIp is evaluated, spoof X-Forwarded-For / X-Real-IP as a direct (non-trusted-proxy) client and confirm the socket peer IP is used instead. - - Where: rustfs/src/server/layer.rs (CORS), console preview/auth code, aws:SourceIp / policy condition evaluation, X-Forwarded-For handling - - Evidence: GHSA-x5xv-223c-8vm7 (default CORS reflected arbitrary origins with credentials), GHSA-v9fg-3cr2-277j (preview rendered attacker HTML same-origin, exposed localStorage creds), GHSA-7gcx-wg4x-q9x6 (extension-based PDF detection bypassed sandbox), GHSA-fc6g-2gcp-2qrq (aws:SourceIp trusted client XFF). advisory-patterns.md 'Browser, CORS' + 'Trusted proxy'. - -Null report example: "Attacked admin action-constant matching in the two changed handlers (both call validate_admin_request with the exact AdminAction), the FTPS RETR/SIZE authz parity, and the new lifecycle struct's serde surface (has deny_unknown_fields) — no break found." - -### Concurrency/durability reviewer - -- For every new or moved lock acquisition, enumerate all other code paths that take any overlapping subset of those locks and construct the concrete ABBA interleaving (thread 1 holds A wants B, thread 2 holds B wants A). If the diff acquires 2+ locks without a comment documenting acquisition order, that alone is a finding. - - Where: crates/ecstore/** (namespace locks, set_disk, disk registry), crates/audit/**, crates/lock/**, any Mutex/RwLock pair in a diff - - Evidence: crates/ecstore/AGENTS.md 'Lock Ordering' (document order; same set in different orders = deadlock); real ABBA deadlock fixed in c0d5f938f (#4421, audit registry vs stream_cancellers) -- If the diff touches the object write/commit path or a lock guard's lifetime, construct the timeline where the distributed lock is lost (heartbeat refresh fails / expiry) after shard writes but before the xl.meta rename commit — verify the commit is fenced on guard.is_lock_lost() (set_disk/ops/object.rs:874-880) and the diff does not move the commit outside the fenced region or drop the guard early. - - Where: crates/ecstore/src/set_disk/ops/object.rs, ops/multipart.rs, crates/lock/** - - Evidence: 1e6207c08 (#4406) fence write commit on lock loss; ddf197ba5 (#4388) heartbeat lock refresh; backlog#899 fencing comment in object.rs -- For any change to file creation or write-then-rename: write out the exact syscall order (write tmp -> fdatasync tmp -> rename -> fsync parent dir -> fsync ancestor dirs on first object under a prefix) and simulate a power cut after each step. Flag any dropped/reordered sync, and check the change honors the durability gate (RUSTFS_DRIVE_SYNC_ENABLE, strict/relaxed/none modes, per-bucket overrides) instead of hardcoding one mode. The 'skip tmp parent fsync' optimization is only sound when the file is renamed out of tmp — verify that precondition still holds. - - Where: crates/ecstore/src/disk/local.rs, disk/os.rs, disk/fs.rs, crates/ecstore/src/bucket/durability.rs, set_disk/core/io_primitives.rs - - Evidence: PR #4221 (the repo previously had no fsync anywhere); 2df315baf/c081586e7 (#4493) fsync ancestor dirs; 062a68d15 (#4387) tmp-parent-fsync skip is rename-conditional; eaff17cad (#4397) durability modes; 54872d52d (#4478) rename_data crash harness exists — extend it for the diff -- If the diff touches quorum counting or per-disk error aggregation, construct adversarial error vectors for reduce_errs: nil/placeholder entries, DiskNotFound mixed with FileNotFound, exactly quorum-1 agreeing errors — and show which dominant error wins. Specifically attack the case where offline-disk errors get counted as 'object does not exist', flipping a read/heal decision into data loss. Also check quorum monotonicity: a retry or heal pass must never conclude with a LOWER quorum than the original write. - - Where: crates/ecstore/src/disk/error_reduce.rs, crates/ecstore/src/api/mod.rs, set_disk read/heal paths - - Evidence: 20d61c73b (#4551) reduce_errs leaked nil placeholder as dominant error; e0619e355 (#4536) DiskNotFound treated as object-not-found in listing; quorum monotonicity flagged as open follow-up to #4221 (#4221 follow-up list); crates/ecstore/AGENTS.md 'Do not weaken quorum checks' -- For any multi-disk fan-out (delete, rename, heal write, cleanup), trace each per-disk Result: find any `let _ =`, `.ok()`, or best-effort collapse that keeps a failed disk out of the quorum math. Construct the run where exactly write_quorum-1 disks succeed and prove the op still returns success — that is the bug. Conversely, for heal writes, check one bad target cannot fail the whole heal (best-effort per target). - - Where: crates/ecstore/src/set_disk/ops/*.rs, disk/disk_store.rs, crates/heal/** - - Evidence: f7d2b2563 (#4546) disk delete/rename failures were swallowed; 47c1e730c (#4545) heal write quorum made best-effort per target; 2b063b0c4 (#4400) disk-replacement heal missed versions -- For every new .await placed between a state mutation and its cleanup/commit (or inside select!/timeout/spawned task that can be aborted), construct the cancellation point: client disconnects and the future is dropped exactly there. Enumerate what is left behind — tmp files, incremented counters never decremented, half-written xl.meta, a held permit/waiter — and verify cleanup runs in Drop or the state is re-entrant. Background loops the diff adds must have a hard outer timeout so a wedged awaitee cannot pin them forever. - - Where: crates/ecstore/** write paths, crates/object-capacity/** scanners, crates/audit/**, anything using tokio::select! or spawn+abort - - Evidence: d608e320f io_uring cancel-safety spike (cancellation known-hard here); 5a372557e (#4533) wedged scans needed hard outer timeout; 7b87d4d13 (#4520) waiter-count leak; e44bece00 (#4497) audit start race + paused drops -- If the diff touches metacache/list producers or cursor resume, construct the interleaving where the producer task completes (or errors) while a reader with a saved cursor comes back for the next page — verify a completed producer is tolerated (no error, no hang) and that a re-folded/full page reports truncation instead of silently ending the listing early. Also feed a corrupt/oversized length prefix into any metacache decode the diff touches. - - Where: crates/ecstore/src/cache_value/metacache_set.rs, crates/ecstore/src/store/list_objects.rs, crates/filemeta/** - - Evidence: 91a23361e (#4531) tolerate completed metacache producers; d91f4d455 (#4538) delimiter re-fold dropped truncation flag; d2c100fd3 (#4226) corrupt length-prefix guard -- For multipart changes, construct concurrent operations on the SAME uploadId: put_object_part racing put_object_part (same part number), abort racing complete between the parts listing and the commit rename, and list-parts racing cleanup. Verify every metadata read/list/abort holds the per-uploadId lock, and that part.N.meta cleanup is deferred until AFTER the commit rename — cleanup before commit loses parts on a crash between the two. - - Where: crates/ecstore/src/set_disk/ops/multipart.rs, rustfs/src/storage/ - - Evidence: 3bc8d79fe (#4329) serialize put_object_part per uploadId; 7fb95d4fc (#4428) unlocked upload metadata reads/aborts; 93ffbdb9b (#4437) unlocked part listings; c77c5f047 (#4548) part.N.meta cleanup moved after commit -- Any cleanup/rollback logic added near a commit: verify it runs strictly AFTER the commit is durable, is best-effort (its failure must not fail an already-committed write), and is safe under retry — i.e., re-running it after a partial first attempt must never delete the newly-committed data dir or the last surviving copy. - - Where: crates/ecstore/src/set_disk/ops/object.rs (rename_data tail), ops/multipart.rs, disk cleanup helpers - - Evidence: afc7f1d6f/d908243e6 (#4386, backlog#898) post-commit old-data-dir cleanup had to be made best-effort; e7cc719c1 (#4389) speculative tmp cleanup moved off hot path -- If the diff does read-modify-write on any persisted shared state (bucket metadata, notify/target config, queue store), construct two concurrent writers: show whether the second write silently discards the first (lost update) — RMW must be serialized or CAS-guarded. For persisted queues/replay, construct crash-mid-replay and prove entries are neither lost nor delivered twice without an idempotency key. - - Where: crates/notify/**, crates/targets/** (queue store, SQL backends), crates/ecstore/src/bucket/metadata_sys.rs - - Evidence: 2490d4ee2 (#4425) persisted config RMW lost updates; 08e44b95f (#4505) queue store crash-safety + replay lifecycle; e008cc5da (#4500) SQL backend idempotency -- If the diff touches erasure decode/reconstruct or streaming GET, construct the failure mid-stream: shards become inconsistent (or a disk read fails) after N bytes of the body have already been sent — verify the stream surfaces an error to the client instead of ending cleanly at a truncated length. Silent truncation on a 200 response is the known failure mode. - - Where: crates/ecstore/src/set_disk/read.rs (reconstruct-read validation, historically ~line 3117), crates/ecstore/src/erasure/coding/decode.rs - - Evidence: Known open bug: EC reconstruct-read 'inconsistent shards' mid-GET silently truncates body -> client unexpected EOF; crates/ecstore/AGENTS.md 'explicit failure over silent corruption' - -Null report example: "Attacked lock ordering on the new disk-registry mutex pair, lock-loss fencing across the moved commit, power-cut points around the added rename, and cancellation at the two new awaits — no break found; quorum math and metacache paths untouched by this diff." - -### Compatibility reviewer - -- Grep the diff for raw 'x-rustfs-internal-' or 'x-minio-internal-' string literals used with map.insert/remove/get instead of the metadata_compat helpers. If found, construct the MinIO-written object case: a metadata map containing ONLY 'X-Minio-Internal-' (mixed case, no RustFS key) and trace the diff's read path — does it miss the value? Then construct the removal case: does remove leave the twin key behind so a stale MinIO-key value resurrects on next read? Also check the value-type trap: get_bytes has NO case-insensitive fallback (unlike get_str), so a diff that moves a suffix from FileInfo.metadata (String) to meta_sys (Vec) silently loses mixed-case MinIO keys. - - Where: Any code touching FileInfo.metadata / user_defined / meta_sys: crates/ecstore/, crates/filemeta/, rustfs/src/storage/, crates/utils/src/http/metadata_compat.rs - - Evidence: Repo-wide invariant in AGENTS.md 'Cross-Cutting Domain Invariants' and CLAUDE.md; helpers and the asymmetry are pinned by tests test_str_lookup_accepts_minio_metadata_case and test_get_bytes_no_case_insensitive_fallback in crates/utils/src/http/metadata_compat.rs -- For any diff reading a binary UUID from internal metadata (transitioned-versionID, tier-free-versionID, data_dir), trace the three degenerate inputs — key absent, value empty (b""), value nil UUID — through to the outgoing tier/S3 request. The bug shape to hunt: unwrap_or_default() or Uuid::from_slice(..).unwrap_or(Uuid::nil()) turning 'no value' into Uuid::nil(), which then gets serialized as ?versionId=00000000-... and the remote tier returns NoSuchVersion. The required pattern is .and_then(|v| Uuid::from_slice(&v).ok()).filter(|u| !u.is_nil()). - - Where: crates/ecstore/src/bucket/lifecycle/ (bucket_lifecycle_ops.rs, tier_sweeper.rs), crates/ecstore/src/services/tier/warm_backend_*.rs, crates/filemeta/src/filemeta/version.rs - - Evidence: Historical production bug documented in docs/operations/tier-ilm-debugging.md ('Nil-UUID versionId sent to tier'); regression tests live in crates/filemeta/src/filemeta/version.rs; follow-up fix 726f3dc18 'accept empty remote version_id in tier recovery paths' (#4552) -- For any diff touching tier or replication GET/DELETE against a remote S3 target, enumerate BOTH directions of the versionId contract and trace each: (a) remote version None/"" means the tier bucket is unversioned — the request must carry NO versionId parameter at all (not an empty one, not nil); (b) remote version Some(v) on a versioned target — the versionId MUST be sent, especially on version-purge deletes, or the delete lands on the wrong version / creates a delete marker instead of purging. Check whether the diff collapses these cases through a single Option/String conversion that loses the distinction. - - Where: crates/ecstore/src/services/tier/warm_backend*.rs, crates/ecstore/src/bucket/lifecycle/tier_sweeper.rs, replication code under crates/ecstore/src/bucket/ - - Evidence: Invariant in AGENTS.md and docs/operations/tier-ilm-debugging.md; real bug fixed by 0fad35645 'send versionId on version-purge deletes to generic S3 targets' (#4401) — the versioned direction, and #4552 — the unversioned direction -- If the diff changes xl.meta encoding (adds/reorders msgpack header fields, touches FileMeta::marshal_msg or codec.rs encode paths), attack downgrade and cross-vendor parse: encode an object with the new code and decode it with (a) the meta_ver<=3 read path and (b) the real-MinIO fixture tests from #4377. Then check the header signature: is it recomputed over the new bytes, or copied/hardcoded? MinIO validates it; a stale or zero signature makes MinIO reject the file. Finally verify XL_META_VERSION was not silently bumped — old RustFS/MinIO nodes reject meta_ver > 3 during a rolling upgrade. - - Where: crates/filemeta/src/filemeta.rs (XL_HEADER_VERSION/XL_META_VERSION, lines ~46-54), crates/filemeta/src/filemeta/codec.rs (check_xl2_v1, decode_xl_headers) - - Evidence: Real bug 073bc9675 'compute header signature instead of hardcoding zero' (#4343); format contract pinned in docs/architecture/minio-file-format-compat.md (write meta_ver 3, read <=3, XL2 magic); parity fixtures from a91d9cefc (#4377) -- If the diff touches xl.meta / FileInfo decode (into_fileinfo, version parsing, part arrays), construct hostile foreign input: a MinIO- or corruption-shaped msgpack with a parts-count that disagrees with the etags/sizes array lengths, missing optional fields, and a meta_ver 2 object with legacy checksum. Trace whether the new code indexes past an array, panics, or fabricates default values instead of returning a decode error. Run the pinned legacy fixtures (test_issue_2265_legacy_meta_v2_object_compatibility, test_issue_2288) plus the #4377 real-MinIO xl.meta parse tests against the diff. - - Where: crates/filemeta/src/ (fileinfo.rs, filemeta.rs, filemeta/codec.rs, filemeta/version.rs) - - Evidence: Real bug 7efacbdf9 'validate part array lengths in into_fileinfo' (#4382); legacy meta_ver 2 regression fixtures at crates/filemeta/src/filemeta.rs (~:1130-:1174) cited by docs/architecture/minio-file-format-compat.md -- If the diff 'corrects' a formula, constant, or layout that is a byte-for-byte MinIO port (shard-size math, bitrot hash interleaving, erasure distribution, inline-data prefix), treat the correction itself as the bug: verify against legacy on-disk data before accepting. Concretely: run crates/ecstore/tests/legacy_bitrot_read_test.rs and the ECA-18 pinning tests; check whether existing objects written by old RustFS or MinIO still verify byte-for-byte. Known trap examples: bitrot_shard_file_size's bare return for non-streaming algorithms is CORRECT MinIO whole-file behavior, and the 32-byte prefix on inline data is the HighwayHash256 bitrot hash, not corruption. - - Where: crates/ecstore/src/erasure/coding/bitrot.rs, crates/ecstore/src/io_support/bitrot.rs, crates/filemeta/src/fileinfo.rs - - Evidence: f96314a1d 'pin streaming-only bitrot layout invariant (ECA-18)' (#4553) — audit explicitly decided NOT to change the formula because it breaks legacy interop; #4377 proved the inline-data prefix is the bitrot hash -- For any diff that copies object metadata into an S3-client-visible surface (GET/HEAD response headers, notification event userMetadata, ListObjects/replication payloads, copy-object metadata directives), construct an object carrying internal keys under BOTH prefixes and in non-canonical casing ('X-Minio-Internal-Compression') and confirm every one is stripped via is_internal_key (which is case-insensitive) — not by an exact-match filter on one prefix. Leaked internal keys are an API-semantics break and an information leak. - - Where: rustfs/src/storage/, crates/notify/, replication and copy_object paths in crates/ecstore/ - - Evidence: Real bug cf8929189 'strip rustfs/minio internal metadata from event userMetadata' (#4419); is_internal_key contract in crates/utils/src/http/metadata_compat.rs -- If the diff touches crates/protos (node.proto, models.fbs) or internode RPC request/response structs, attack the rolling-upgrade interleaving: an old node sends a message without the new field to a new node, and a new node sends the extended message to an old node. Verify proto field numbers are only appended (never reused/renumbered), FlatBuffers tables are only extended at the end, and that an absent new field decodes to a safe default on the receiving side — 'safe' meaning it must not be interpreted as success/authorization (RPC errors fail closed) and must not flip a quorum decision. - - Where: crates/protos/ (node.proto, models.fbs, generated/), gRPC transport and dispatch in the internode layer - - Evidence: 6f613317f 'optimize gRPC transport' (#4337) shows the wire layer churns; security advisory 68cw fixed by PR#4402 established RPC fail-closed as a repo rule (see .agents/skills/security-advisory-lessons) -- For S3 handler diffs, replay the request shapes real clients actually send, not just the canonical one: mc and aws-sdk differ on path normalization (root '//' ListBuckets), virtual-host vs path style, and header casing. Then attack every pagination boundary the diff touches: request exactly max-keys/max-uploads/max-parts items and verify the response returns exactly N (not N+1), sets IsTruncated correctly, and yields a NextMarker/KeyMarker that resumes without skipping or duplicating — construct the N+1st-item case explicitly. - - Where: rustfs/src/storage/ S3 handlers, listing paths in crates/ecstore/src/store/ and set_disk/ - - Evidence: Real bugs 511ad31ba 'normalize root double-slash ListBuckets requests' (#4336) and fefa70b31 'stop ListMultipartUploads from returning one upload past max-uploads' (#4447); docs/architecture/s3-compatibility-matrix.md is the compat source of truth -- If the diff changes bucket-metadata (.metadata.bin) or IAM/config parsing structs, run it against the real MinIO RELEASE.2025-07-23 fixtures: the msgpack blob uses PascalCase field names, so any serde rename, field-type change, or derive tweak silently drops MinIO-written fields instead of erroring. Verify parse_all_configs still loads all ten config types from the fixture without loss, and that drop-in migration still decrypts MinIO-encrypted IAM/server config rather than treating ciphertext as corrupt. - - Where: crates/ecstore/src/bucket/metadata*, crates/ecstore/src/bucket/migration.rs, IAM/config load paths in crates/iam/ and crates/config/ - - Evidence: Fixture parity test parses_real_minio_bucket_metadata_blob_without_loss from a91d9cefc (#4377); real bug 717cdd2ab 'decrypt MinIO IAM & server config on drop-in migration' (#4358); format matrix in docs/architecture/minio-file-format-compat.md -- If the diff adds a compatibility shim, legacy fallback, wrapper, or old-endpoint alias (grep the diff for 'legacy', 'fallback', 'compat', 'deprecated'), verify two things: (1) it carries a RUSTFS_COMPAT_TODO() marker with an exact removal condition and a matching entry in the register — an unmarked shim becomes permanent dead weight; (2) the fallback's default direction is safe for old data: e.g. a new decode path must fall back to the legacy decode for old objects by default, not gate legacy reads behind an opt-in flag that makes existing data unreadable after upgrade. - - Where: Anywhere in the diff; register at docs/architecture/compat-cleanup-register.md; recent example: allow_inplace_legacy_fallback flag in the ecstore erasure codec streaming path - - Evidence: docs/architecture/compat-cleanup-register.md review checklist; d232a46b4 wired legacy decode prefetch behind a default-OFF gate while keeping legacy reads working (#4542), with arity fallout fixed in 05890d6e2 (#4573) - -Null report example: "Attacked dual-key metadata writes/removals against MinIO-only-key objects, nil/empty transitioned-versionID paths to the tier, xl.meta encode against meta_ver<=3 decoders and the #4377 real-MinIO fixtures, and proto field-number evolution for old-node/new-node RPC — no compatibility break found." - -### Performance reviewer - -- For each `.clone()` or allocation added to a per-request/per-object path, identify the copied data and execution frequency. Report a finding only for a concrete repeated cost or benchmark regression. Recommend borrowing, moving, `Bytes`/`Arc`, `Cow`, or capacity reservation only when it reduces that cost without obscuring ownership or APIs. - - Where: crates/ecstore/src/set_disk/**, crates/ecstore/src/store*.rs, rustfs/src/storage/, crates/filemeta/, request handlers in rustfs/src/ - - Evidence: crates/ecstore/AGENTS.md 'Allocation Discipline in Hot Paths'; .agents/skills/rust-code-quality/SKILL.md requires a concrete hot-path cost rather than a proxy metric -- For every new sync_all/sync_data/fdatasync/flush/File::sync call in the diff, trace the call chain to DurabilityMode / RUSTFS_DRIVE_SYNC_ENABLE resolution (crates/ecstore/src/disk/local.rs:291 DurabilityMode, :347 resolve_durability_mode) and to per-bucket durability overrides. Construct the run where the operator sets mode=none (or legacy RUSTFS_DRIVE_SYNC_ENABLE=false) and the new fsync still fires — that is an ungated durability cost and a regression on 4KiB writes. - - Where: crates/ecstore/src/disk/local.rs, crates/ecstore/src/bucket/durability.rs, crates/ecstore/src/set_disk/** (rename_data/commit paths), any crate doing tokio::fs or std::fs writes - - Evidence: #4221 fsync work caused a measured -10% 4KiB write regression (#814 investigation), later gated; durability modes added in eaff17cad (#4397), per-bucket tier overrides in 13e48d93a (#4407); 2df315baf (#4493) shows even ancestor-dir fsyncs are routed through the gate -- Attack blocking-work placement from both directions: (a) find new synchronous fs calls, hashing, or EC encode/decode executed directly on an async runtime thread without spawn_blocking/block_in_place — construct the stall (a slow disk blocks a worker thread and every task queued on it); (b) find new code that splits one logical disk operation into multiple spawn_blocking hops per object — each hop is a threadpool round-trip, so K hops x N objects multiplies latency. Demand the author justify the placement with the size of the work, not habit. - - Where: crates/ecstore/src/disk/local.rs, crates/ecstore/src/erasure_coding/, crates/ecstore/src/bitrot/, crates/rio/ - - Evidence: 608ab14d7 (#4554, HP-12) folded metadata open+fstat+read into a single spawn_blocking because per-op hops were measurably slow; 8fc637fb1 (#4484) moved the short EC encode inline because block_in_place cost exceeded the work — direction depends on measured work size -- For each lock acquisition the diff adds or relocates, mark the guard's live range and list every .await and disk/RPC call inside it. Construct the contention interleaving: N concurrent requests serialize on the guard while the holder waits on IO; for namespace/multipart commit locks, compute worst-case hold time (fsync + rename per disk) against the lock's timeout. Also diff the acquisition order against other paths taking the same locks (ABBA). - - Where: crates/ecstore/src/set_disk/** (commit/rename paths), crates/lock/, crates/audit/ registry, any RwLock/Mutex in per-request paths - - Evidence: crates/ecstore/AGENTS.md 'Lock Ordering'; c0d5f938f (#4421) fixed a real ABBA deadlock between registry and stream_cancellers; #4370 history: fsync-heavy serial cross-disk commits held a lock long enough to blow test timeouts (#4370) -- Trace exactly what executes inside the PUT commit critical section (under the object write lock, between tmp write and rename_data completion) before vs after the diff. Any newly added work there — cleanup, extra stat, additional rename, O_DIRECT write, logging — is an attack target: construct the per-PUT latency delta and demand it be moved off the critical section or parallelized across disks. - - Where: crates/ecstore/src/set_disk/ops/*, crates/ecstore/src/disk/local.rs rename_data path - - Evidence: Three real optimizations removed exactly this class of regression: e7cc719c1 (#4389) moved speculative PUT-tail tmp cleanup off the hot path, 92c8c6db7 (#4411) moved O_DIRECT shard-writes off the commit critical section, 651ccac13 (#4487) parallelized tmp xl.meta write and shard fdatasync on commit -- Find any new loop in a batch API that performs a per-item stat/read/RPC sequentially. Construct the concrete blowup: a 1000-key DeleteObjects or a full listing page -> 1000 serial round-trips added by the diff. Demand either a gate (skip when not needed) or bounded parallelism; for startup/load paths, check for accidental O(n^2) (re-scanning the full list per item). - - Where: crates/ecstore/src/store_delete*.rs / batch object APIs, listing/metacache paths, crates/iam/ store loading, crates/heal/ - - Evidence: a413729b1 (#4398) had to gate and parallelize the DeleteObjects per-object stat fanout after it shipped serial; 16a91c35e (#4537) fixed O(n^2) IAM startup load by chunking — both were diff-introduced fanouts of this exact shape -- For every buffer the diff allocates on the encode/decode/shard path, check: is it sized with with_capacity to the EC-expanded block (not the logical size, not default-grown)? Does it copy into a fresh Vec where Bytes::slice/clone (refcount) or the io-core buffer pool would avoid the copy? Does the diff read hash and data in separate passes where one pass suffices? Construct the per-block byte-copy count before vs after. If the diff touches the io-core pool, verify gauge accounting still balances. - - Where: crates/ecstore/src/erasure_coding/, crates/ecstore/src/bitrot/, crates/io-core/src/pool.rs, crates/rio/ - - Evidence: 92bf55ce6 (#4396) fixed a real regression by right-sizing BytesMut encode ingest capacity to the EC-expanded block; 47bee8b31 (#4475) merged bitrot hash+data into one read pass; 7fa3d0d4b (#4534) shows pool gauge accounting is easy to drift when touching buffer reuse -- For every logging or instrumentation statement the diff adds, classify the call site frequency: per-request, per-object, per-shard, or per-block. Anything info!/warn!/error! at per-object frequency or higher is a finding — construct the flood (one listing under client cancellation, one 10k-object heal) and count emitted lines. New metrics/timers on the data path must be feature-gated, not always-on. Run scripts/check_logging_guardrails.sh on the diff. - - Where: any per-request/per-object code, especially crates/ecstore listing and heal loops, rustfs/src/storage/ handlers; scripts/check_logging_guardrails.sh - - Evidence: .agents/skills/rustfs-logging-governance/SKILL.md (trace level for hot-path/repetitive success events); d25ddb0e1 (#4372) fixed real listing-cancellation error-log noise; hotpath instrumentation is deliberately feature-gated (3f13d098b #4394, f262fcfce #4541 HP-14) -- Count how many times the diff's request path parses or fetches the same metadata: xl.meta/FileMeta decoded more than once per object, bucket metadata (metadata_sys) re-fetched inside a per-object loop, or the dual x-rustfs-internal/x-minio-internal key lookup re-run repeatedly on the same map. Construct the per-request parse count before vs after; a second full FileMeta decode per GET is a finding. - - Where: crates/filemeta/, crates/ecstore/src/set_disk/** read paths, crates/ecstore/src/bucket/metadata_sys.rs, crates/utils/src/http/metadata_compat.rs - - Evidence: 608ab14d7 (#4554) exists because redundant metadata-read syscall sequences per object were measurable; CLAUDE.md dual-key metadata convention makes repeated get_bytes lookups an easy hidden double-parse -- If the diff touches PUT/GET/commit/erasure paths and claims 'no perf impact', demand numbers, not assertion: run the criterion benches (cargo bench -p ecstore — comparison_benchmark, erasure_benchmark, rename_data_meta_benchmark, single_block_non_inline_benchmark per crates/ecstore/benches/) against origin/main, and for end-to-end paths the warp A/B relative-budget gate (scripts/run_hotpath_warp_ab.sh --baseline-ref origin/main, as .github/workflows/performance-ab.yml runs it). Probe specifically at 4KiB object size — that is where the last real regression hid. - - Where: crates/ecstore/benches/, .github/workflows/performance-ab.yml, scripts/run_hotpath_warp_ab.sh - - Evidence: crates/ecstore/AGENTS.md: 'Benchmark-sensitive changes should include measurable rationale'; performance-ab.yml (215747022 #4480) is the repo's own relative-budget gate; the #4221 regression was only visible at 4KiB writes (#814 bisect) - -Null report example: "Attacked the new rename_data commit-section work, durability-gate routing of the added fdatasync, guard live-range across the shard-write awaits, and per-object clone count in the PUT path; ran comparison_benchmark + rename_data_meta_benchmark vs origin/main (4KiB delta within noise) — no break found." - -### Test-coverage skeptic - -- For every testable behavior claim in the PR description, revert that hunk and name the focused test or executable check that detects the revert. If no reasonable check exists, require the reason and residual risk from the validation floor. Especially verify the check exercises the real production path, not a lookalike helper. - - Where: All crates; highest value in crates/ecstore, rustfs/src/storage, crates/heal - - Evidence: AGENTS.md testable-behavior exit criterion. Real bug: PR #4220 (ghost-directory cleanup) merged with green tests but its fix never executed on the real delete path — required follow-up rustfs#4307, backlog#798 stayed OPEN. The tests exercised a path the production flow never took. -- Read each added/modified test and confirm it asserts the real outcome (returned value, stored bytes, error variant), not merely 'call succeeded' or 'no panic'. Flag any test whose only observable is that the function returned, and any `assert!(result.is_err())` that never checks WHICH error. Then check: does the test prove the exploit/failure form is denied, or only that the intended form still works? - - Where: crates/e2e_test (security_boundary_test.rs pattern), and every #[cfg(test)] module in the diff - - Evidence: Commit dee8e4e63 (#4466) had to rewrite 277 lines of crates/e2e_test/src/security_boundary_test.rs because 'security boundary tests' passed without asserting real outcomes. .agents/skills/rust-code-quality/SKILL.md requires an observable failure criterion; .agents/skills/security-advisory-lessons/SKILL.md asks whether the exploit form is denied. -- When the diff adds a boolean/mode parameter or config flag, find the test that fails if the flag's effect is INVERTED inside the changed function. Tests that were mechanically updated to pass `false`/default at every call site assert nothing about the new behavior. Execute the check: flip the flag's branch in the source and confirm at least one test goes red for each branch. - - Where: crates/ecstore/src/set_disk/ (e.g. build_codec_streaming_part_reader), any function gaining a parameter - - Evidence: Commit 05890d6e2 (#4573): PR #4560 added a 15th param allow_inplace_legacy_fallback; the arity tests were fixed by passing `false` everywhere — they assert Err outcomes independent of the flag, so the fallback behavior itself has no revert-detecting test at those sites. -- Mutation spot-check on error propagation: for each newly added `?`, `return Err`, or error-mapping line, mentally replace it with `Ok(default)`/ignore and ask which test fails. The swallowed-error bug class recurs in this repo and always ships with green tests — a fix that propagates errors needs a test that injects the failure (faulty disk, failed rename, dispatch error) and asserts the caller sees Err. - - Where: crates/ecstore (disk delete/rename, reduce_errs), crates/audit, crates/notify, crates/targets - - Evidence: Three recent fixes for the same class: f7d2b2563 (#4546, disk delete/rename failures swallowed), dbc628f16 (#4424, audit dispatch failures swallowed), 20d61c73b (#4551, reduce_errs leaking nil placeholder as dominant error). All existed while tests were green. -- Any test touching GET/read/reconstruct/stream paths must assert the FULL body content and exact length against a known value, not status-ok or first-bytes. Construct the degraded-read case (missing/inconsistent shards forcing EC reconstruction) and assert byte-for-byte equality; a mid-stream failure that truncates the body passes every test that only checks headers or the first chunk. - - Where: crates/ecstore/src/set_disk/read.rs and ops/, crates/rio, crates/e2e_test GET scenarios - - Evidence: Known live bug: EC reconstruct-read verification failure mid-GET at set_disk read path silently truncates the body → client 'unexpected EOF'; version-independent, undetected by existing suites because none assert full-body integrity under shard inconsistency. -- For on-disk / on-wire format changes (xl.meta, .metadata.bin, bitrot framing), reject round-trip-only tests: a struct serialized and deserialized by the same code under test cannot catch format drift. Demand the test parse a REAL captured fixture from crates/filemeta/tests/fixtures, crates/ecstore/tests/fixtures, or crates/rio-v2/tests/minio_fixture_lab — or capture a new one from a single-disk MinIO instance (RELEASE.2025-07-23 procedure from #4377). - - Where: crates/filemeta, crates/ecstore (headers, msgpack bucket metadata), crates/rio-v2, migration code - - Evidence: Commit 073bc9675 (#4343): filemeta header signature was hardcoded to zero — round-trip tests passed for months. Commit a91d9cefc (#4377) established the real-MinIO fixture convention (inline/versioned/multipart xl.meta, HighwayHash256-prefixed inline bodies) precisely because synthetic fixtures proved nothing about interop. -- Attack new concurrency tests for flakiness-by-construction: grep the added tests for `sleep(`, fixed timeouts under ~30s on lock acquisition, and use of shared global state (disk registry, lock client, GLOBAL_*). Serialized cross-disk commits exceed small lock timeouts under full-suite CI disk load. If the test shares global state or saturates IO, it must join the `ecstore-serial-flaky` nextest test-group in .config/nextest.toml (note: serial_test's #[serial] does NOT work — nextest runs each test in its own process). Require readiness polling, never fixed sleeps. - - Where: crates/ecstore tests, crates/e2e_test, .config/nextest.toml - - Evidence: Commit 2dfa3d3c3 (#4370): concurrent_resend test flaked with Lock(Timeout 5s) on CI — six legitimate serialized cross-disk commits under IO pressure needed 30s. Commit 7c701d9f2 (#4558) created the nextest test-group after bucket_delete_* raced make_bucket into InsufficientWriteQuorum. 65849740f (#4213) deflaked global-state contamination. crates/e2e_test/AGENTS.md: 'readiness checks and explicit polling over fixed sleep-based timing'. -- If the diff writes internal object metadata, run the dual-key mutation: delete the `x-minio-internal-` write (keeping only `x-rustfs-internal-`) and check whether any test fails. Because `get_bytes` prefers the RustFS key, every read-back test stays green while MinIO interop is silently broken — coverage must include an assertion that BOTH keys are present in the stored metadata map. - - Where: crates/utils/src/http/metadata_compat.rs and all its callers in crates/ecstore and rustfs/src/storage - - Evidence: CLAUDE.md domain convention: metadata must be written under both x-rustfs-internal- and x-minio-internal- keys for MinIO interop; get_bytes prefers the RustFS key, making the MinIO-key half of the invariant invisible to read-back tests. -- For changed quorum/version/UUID logic, name the tests covering the specific poison values: quorum−1 disks, nil UUID, absent vs empty vs nil-serialized UUID bytes, remote-tier version_id of None/"" (unversioned tier bucket → no versionId sent), and the same metadata read on both MetaObject and MetaDeleteMarker version types. Mutation check: remove a `.filter(|u| !u.is_nil())` guard from the diff and confirm a test fails; if none does, the nil-UUID class is uncovered. - - Where: crates/ecstore (tier recovery, heal, quorum paths), crates/filemeta, code reading UUIDs from xl.meta metadata - - Evidence: Commit 726f3dc18 (#4552) fixed rejection of empty remote version_id in tier recovery. CLAUDE.md invariant: absent/empty/nil UUID all mean 'no value', not Uuid::nil(). docs/operations/tier-ilm-debugging.md: None/"" tier version means unversioned bucket. df9cbc4ed (#4427): unvalidated distribution values caused shuffle index panic — edge values reached production untested. -- For any pagination/limit/truncation change, construct the exact-boundary test: result count == max (page exactly full), max+1, and a delimiter re-fold that lands precisely on the page boundary — assert both the item count AND the is_truncated/continuation marker. Off-by-one at the page boundary is a recurring shipped bug here. - - Where: crates/ecstore listing paths (list_objects, ListMultipartUploads, metacache), S3 handlers in rustfs/src/storage - - Evidence: Two shipped boundary bugs: fefa70b31 (#4447) ListMultipartUploads returned one upload past max-uploads; d91f4d455 (#4538) delimiter re-fold of a full page lost the truncation flag. Both survived existing tests because no test pinned n == max exactly. -- A green focused test is evidence only for the targets it builds. Follow the `AGENTS.md` validation tier: add package-scoped Clippy or broader test-target compilation only when changed targets, features, or dependents remain uncovered; do not require a workspace-wide build by default. - - Where: All crates; especially concurrent-branch merges into crates/ecstore - - Evidence: #4322 broke main because only cargo test ran (field_reassign_with_default is clippy-only). b06f3df6b (#4441) and 05890d6e2 (#4573): test code broke the workspace test build (E0061) on main after textually-clean merges, failing CI for every open PR. - -Null report example: "Attacked revert-detection for all 3 claimed behaviors (each has a named test that fails on revert), flag-inversion on the new fallback parameter (both branches covered in codec_streaming tests), full-body assertions on the changed GET path, and n==max pagination boundary — no coverage gap found." - -## Sources and maintenance - -Probes are distilled from shipped bugs in git history (commit/PR references -above), GitHub security advisories (see the security-advisory-lessons -skill), scoped `AGENTS.md` rules, and invariants under `docs/architecture/` -and `docs/operations/`. Line numbers drift; re-locate the invariant. Merge -new incidents into an existing probe when they share a failure class; add a -new probe only for a distinct attack, rather than growing the root policy. +Do not turn a null verdict into a long checklist. Record concise evidence that +the relevant failure classes were attacked. diff --git a/.agents/skills/adversarial-validation/references/compatibility.md b/.agents/skills/adversarial-validation/references/compatibility.md new file mode 100644 index 000000000..6b2b9b73b --- /dev/null +++ b/.agents/skills/adversarial-validation/references/compatibility.md @@ -0,0 +1,24 @@ +# Compatibility Lens + +- Internal metadata uses `metadata_compat` helpers for dual RustFS/MinIO keys, + including mixed casing and removal of both twins. +- Binary UUID metadata treats absent, empty, and nil as no value. Unversioned + remote tiers receive no `versionId`; versioned purge requests retain the real + version ID. +- `xl.meta` changes preserve supported header/meta versions, recompute + signatures, decode legacy fixtures, and remain readable by old RustFS/MinIO. +- Foreign/corrupt metadata validates parallel array lengths and missing fields; + it returns a decode error rather than indexing, panicking, or fabricating data. +- Do not “correct” byte-for-byte MinIO ports without legacy fixture evidence. + Bitrot framing, shard math, distribution, and inline prefixes are contracts. +- Client-visible metadata/events strip both internal prefixes + case-insensitively. +- Proto fields are appended, never reused/renumbered; FlatBuffers tables extend + compatibly and absent new fields fail closed where authorization/quorum is + involved. +- Replay real client request shapes and exact pagination boundaries for S3 + handler changes. +- Bucket metadata/IAM/config parsing remains compatible with pinned real MinIO + fixtures and encrypted migration data. +- Compatibility shims use `RUSTFS_COMPAT_TODO()`, have a removal + condition, and default toward reading old data safely. diff --git a/.agents/skills/adversarial-validation/references/concurrency-durability.md b/.agents/skills/adversarial-validation/references/concurrency-durability.md new file mode 100644 index 000000000..ae09a7718 --- /dev/null +++ b/.agents/skills/adversarial-validation/references/concurrency-durability.md @@ -0,0 +1,23 @@ +# Concurrency and Durability Lens + +- For every changed lock, enumerate overlapping lock sets and construct the + ABBA interleaving. Multiple-lock order must be documented and consistent. +- Mark guard lifetimes and every `.await`, disk, and RPC call inside them. + Estimate contention and timeout behavior under concurrent requests. +- Object commits remain fenced if the distributed lock is lost after shard + writes and before metadata rename. +- For write/rename changes, trace `write tmp -> sync tmp -> rename -> sync parent + -> sync required ancestors`; simulate a crash after each step and honor the + configured durability gate. +- Multi-disk fan-out counts every result. Quorum-minus-one cannot become success; + heal remains best-effort per target where that is the established contract. +- At every new cancellable await between mutation and cleanup/commit, drop the + future and inspect leftover files, counters, permits, and replay state. +- Multipart operations on the same upload ID are serialized where required; + abort/complete/list races cannot delete parts before durable commit. +- Post-commit cleanup is best-effort, retry-safe, and cannot fail an already + committed write or delete the last surviving copy. +- Persisted read-modify-write uses serialization/CAS. Queue replay is crash-safe + and duplicate delivery has an idempotency contract. +- Streaming reconstruction failures after partial output surface as errors, not + successful EOF. diff --git a/.agents/skills/adversarial-validation/references/correctness.md b/.agents/skills/adversarial-validation/references/correctness.md new file mode 100644 index 000000000..05b3d95f6 --- /dev/null +++ b/.agents/skills/adversarial-validation/references/correctness.md @@ -0,0 +1,29 @@ +# Correctness Lens + +Attack the changed behavior, not every subsystem in the repository. + +- Trace new error paths to the caller. Inject the ignored/wildcard variants and + verify they cannot become success, not-found, or a plausible default. +- Exercise zero/empty/missing, maximum, and exact-boundary inputs for every + changed count, size, index, page limit, or optional value. +- For aggregation/quorum changes, test exactly quorum and quorum-minus-one with + mixed disk errors and nil/placeholder entries. +- For listing/pagination, test `n == max`, `n == max + 1`, delimiter folding, + continuation markers, and object/prefix name collisions. +- For EC/read/streaming changes, inject failure after partial output and verify + the client receives an error rather than a clean truncated body. Assert exact + bytes and length. +- For multipart/object commits, fail before/after rename and cleanup; committed + data must remain readable and pre-commit cleanup must not destroy parts. +- For version/index ordering, test `len - 1`, `len`, equal timestamps, missing + versions, and deterministic tie-breaking. +- For directory-object behavior, trace `__XLDIR__` at the store layer; branches + below the layer that sees trailing slashes are dead. +- For binary UUID metadata, absent, empty, and nil all mean no value. Never send + nil/empty `versionId` to an unversioned tier. +- For agent rules/skill routers, test a trigger matrix covering ordinary + inquiry, low-risk implementation, explicit review, high-risk code, PR + creation, release, and post-PR monitoring. Each case must select only the + intended workflow and retain required safety/authorization boundaries. + +Null verdicts name only the probes relevant to the diff. diff --git a/.agents/skills/adversarial-validation/references/performance.md b/.agents/skills/adversarial-validation/references/performance.md new file mode 100644 index 000000000..2b352ac2a --- /dev/null +++ b/.agents/skills/adversarial-validation/references/performance.md @@ -0,0 +1,20 @@ +# Performance Lens + +- For added clones/allocations on request/object/block paths, quantify copied + data and frequency. Recommend borrowing, move, `Bytes`/`Arc`, `Cow`, or + capacity reservation only for a concrete repeated cost. +- Route every new sync/flush through the durability-mode and bucket override + gates; mode `none` must not pay the new fsync. +- Keep blocking filesystem/CPU work off async runtime threads, but do not split + one small operation into many `spawn_blocking` round trips. +- Measure lock hold time across I/O and compare acquisition order for ABBA. +- Keep cleanup, extra stat/rename, and diagnostics out of the PUT commit critical + section when they need not be there. +- Detect per-item serial I/O/RPC in batch APIs and accidental quadratic scans; + use a gate or bounded concurrency when the concrete fan-out warrants it. +- Count buffer growth and byte copies in EC/bitrot paths; preserve pool gauge + balance and avoid repeated metadata decode/fetch per object. +- Repetitive success logs stay at `trace`; metrics/instrumentation on hot paths + require an existing gate. +- Claims of no impact on PUT/GET/commit/erasure paths need relevant benchmark or + A/B evidence, especially for 4 KiB objects. diff --git a/.agents/skills/adversarial-validation/references/security.md b/.agents/skills/adversarial-validation/references/security.md new file mode 100644 index 000000000..9490a09f5 --- /dev/null +++ b/.agents/skills/adversarial-validation/references/security.md @@ -0,0 +1,31 @@ +# Security Lens + +Use `security-advisory-lessons` only for a dedicated advisory/security audit. +For an ordinary matched diff, attack these boundaries: + +- Admin routes: route registration, whitelist, handler authn, and the exact + `AdminAction` must agree. Read-only diagnostics still require admin authz. +- IAM/service accounts: treat parent, claims, keys, groups, status, and policy + names as attacker-controlled; prove ownership/root authority before writes. +- Protocol frontends: every changed/sibling command authorizes the matching S3 + action before reaching storage. +- Secrets/signatures: use constant-time comparison, normalize public failures, + keep RPC/root/STS keys independent, and fail closed when secrets are absent. +- RPC: bind signatures to the exact method/path and timestamp; reject replay, + stale, malformed, truncated, and invalid-enum payloads without panic. +- Paths/object/archive entries: reject traversal, absolute/platform escapes, + and normalization differences between authz and storage. +- Copy/multipart/presigned POST: enforce source, destination, version-aware + actions, copy-source conditions, and every signed policy condition. +- Logging/errors: never expose credentials, tokens, expected signatures, raw + secret-bearing input, or merged configs—including via `Debug` and parse errors. +- Untrusted serde: reject unknown fields where compatible and validate + security-critical defaults/ranges before numeric conversion. +- SSE/browser/CORS/trusted proxy: inspect stored ciphertext and wrapper order; + isolate user content; never reflect credentialed arbitrary origins or trust + forwarded identity from direct clients. +- Object Lock: unreadable/fabricated/unparsable metadata fails closed across + foreground, lifecycle, scanner, and force-delete paths. + +Security findings distinguish unauthenticated compromise from a +low-privileged authenticated bypass. diff --git a/.agents/skills/adversarial-validation/references/simplicity.md b/.agents/skills/adversarial-validation/references/simplicity.md new file mode 100644 index 000000000..ca192f884 --- /dev/null +++ b/.agents/skills/adversarial-validation/references/simplicity.md @@ -0,0 +1,22 @@ +# Simplicity Lens + +- Compare the production diff with the smallest equivalent local edit. Fewer + lines alone are not evidence; the replacement must preserve correctness, + compatibility, readability, and real boundaries. +- Search the touched crate, domain owner, `crates/utils`, `crates/common`, and + relevant dependencies for each new helper, constant, wrapper, or fixture. +- Reject forced reuse when normalization, error, deadline, or durability + semantics differ. +- Require a concrete trigger for every new defensive branch. Keep boundary + checks for disk/RPC/version data and checks immediately before destructive + actions. +- Flag one-caller helpers only when they merely forward or split a short linear + flow without adding domain naming, invariant isolation, or useful context. +- Ensure a replacement removes the superseded in-scope path or keeps one + canonical core behind a documented compatibility adapter. +- Remove narration/change-history comments; preserve concise safety, lock, + durability, and compatibility invariants. +- Treat tests, fixtures, generated code, and documentation separately from + production growth. Do not optimize away meaningful regression coverage. + +A finding must include a concrete smaller design, not a style preference. diff --git a/.agents/skills/adversarial-validation/references/test-coverage.md b/.agents/skills/adversarial-validation/references/test-coverage.md new file mode 100644 index 000000000..942295f88 --- /dev/null +++ b/.agents/skills/adversarial-validation/references/test-coverage.md @@ -0,0 +1,24 @@ +# Test-Coverage Lens + +- For every behavior claim, name the focused test/check that fails if the + changed hunk is reverted. If none is practical, require the reason and + residual risk. +- Confirm tests exercise the real production path and assert returned values, + exact bytes, stored state, or the specific error variant—not only success, + `is_err()`, or no panic. +- For new flags/modes, verify each branch and ask which test fails if the branch + is inverted. +- For new error propagation, inject the failure and assert the caller observes + it; mentally replacing `?`/`return Err` with success must break a test. +- Streaming GET tests assert the complete body and length under degraded reads. +- Disk/wire-format tests use pinned foreign/legacy fixtures; same-code + round-trips are insufficient for compatibility. +- Concurrency tests use readiness polling, isolate global state, and avoid fixed + sleeps or unrealistically short timeouts. Use nextest groups when process-level + serialization is required. +- Internal metadata tests assert both RustFS and MinIO keys, not only read-back + through a helper that prefers one key. +- Boundary companions are distinct coverage: `n == max` vs `max + 1`, and + absent vs empty vs nil UUID. +- A focused test proves only the targets/features it builds. Add compilation or + Clippy only for uncovered changed targets. diff --git a/.agents/skills/code-change-verification/SKILL.md b/.agents/skills/code-change-verification/SKILL.md index 553822c82..e295f975d 100644 --- a/.agents/skills/code-change-verification/SKILL.md +++ b/.agents/skills/code-change-verification/SKILL.md @@ -1,11 +1,12 @@ --- name: code-change-verification -description: Verify code changes by identifying correctness, regression, security, and performance risks from diffs or patches, then produce prioritized findings with file/line evidence and concrete fixes. Use when reviewing commits, PRs, and merged patches before/after release. +description: Review a commit, PR, or merged patch when the user requests ordinary code-change verification. Do not combine with adversarial-validation; use that skill instead for explicitly adversarial, substantial, or high-risk RustFS reviews. --- # Code Change Verification -Use this skill to review code changes consistently before merge, before release, and during incident follow-up. +Use this skill for an ordinary requested review. If the root policy or user calls +for adversarial validation, use `adversarial-validation` instead of running both. ## Quick Start @@ -79,4 +80,3 @@ Run the full checklist in [rust-code-quality](../rust-code-quality/SKILL.md) — - Impact: ... - Fix suggestion: ... - Validation: ... - diff --git a/.agents/skills/code-change-verification/agents/openai.yaml b/.agents/skills/code-change-verification/agents/openai.yaml index 7e4566774..2f76eace4 100644 --- a/.agents/skills/code-change-verification/agents/openai.yaml +++ b/.agents/skills/code-change-verification/agents/openai.yaml @@ -1,4 +1,4 @@ interface: display_name: "Code Change Verification" short_description: "Prioritize risks and verify code changes before merge." - default_prompt: "Inspect a patch or diff, identify correctness/security/regression risks, and return prioritized findings with file/line evidence and fixes." + default_prompt: "Use $code-change-verification for an ordinary requested diff review with prioritized findings." diff --git a/.agents/skills/pr-creation-checker/SKILL.md b/.agents/skills/pr-creation-checker/SKILL.md index c2c24bd29..e83490713 100644 --- a/.agents/skills/pr-creation-checker/SKILL.md +++ b/.agents/skills/pr-creation-checker/SKILL.md @@ -1,97 +1,46 @@ --- name: pr-creation-checker -description: Prepare PR-ready diffs by validating scope, checking required verification steps, drafting a compliant English PR title/body, and surfacing blockers before opening or updating a pull request in RustFS. +description: Perform the final RustFS PR preflight and draft compliant English title/body metadata immediately before creating or updating a PR. Do not use during implementation or as a second general code review. --- # PR Creation Checker -Use this skill before `gh pr create`, before `gh pr edit`, or when reviewing whether a branch is ready for PR. +Use this skill only at the PR boundary. Reuse completed diff review and +verification evidence; do not reread the repository or rerun equivalent checks. -## Read sources of truth first +## Preflight -- Read `AGENTS.md`. -- Read `.github/pull_request_template.md`. -- Use `Makefile` and `.config/make/` for local quality commands. -- Use `.github/workflows/ci.yml` for CI expectations. -- Do not restate long command matrices or template sections from memory when the files exist. +1. Confirm the branch is based on current `origin/main` and contains only the + intended task diff. +2. Inspect `git diff --stat`, `git diff --check`, and changed file names for + secrets, logs, generated artifacts, or unrelated edits. +3. Confirm the checks selected by root `AGENTS.md` passed on the final diff. + Do not replace focused behavioral tests with a generic gate or rerun checks + already covered by an unchanged umbrella run. +4. Read `.github/pull_request_template.md`. Consult `Makefile`, `.config/make/`, + or CI only when the required command/current gate is uncertain. +5. Return `BLOCKED` for an unclean scope, missing required evidence, failed + required checks, or non-compliant metadata. -## Workflow +## Metadata -1. Collect PR context -- Confirm base branch, current branch, change goal, and scope. -- Confirm whether the task is: draft a new PR, update an existing PR, or preflight-check readiness. -- Confirm whether the branch includes only intended changes. +- Title: English Conventional Commit, at most 72 characters, with no tool + prefix. +- Body: English, exact template headings, `N/A` where needed, concise rationale, + actual verification commands, and material risks/rollback notes. +- Use repository-relative paths; never include local absolute paths. +- Keep prose paragraphs on one logical line and never include the literal + sequence `\n`. +- Use a temporary body file with `gh pr create --body-file` or + `gh pr edit --body-file`; never pass multiline Markdown inline. -2. Inspect change scope -- Review the diff and summarize what changed. -- Inspect `git diff --stat` and `git diff --numstat`; assess production-code growth separately. Tests, fixtures, generated code, and documentation have no growth budget. Treat line counts as signals, not quotas. -- Call out unrelated edits, generated artifacts, logs, or secrets as blockers. -- Mark risky areas explicitly: auth, storage, config, network, migrations, breaking changes. -- Use the simplicity-adversary verdict instead of producing a per-symbol inventory. Block growth only when the review identifies duplication or gives a concrete smaller design that preserves correctness, compatibility, readability, and real boundaries. -- Confirm replacement implementations remove the superseded in-scope path or adapt compatibility at the boundary to one canonical core. -- Scan the diff for newly added string literals and confirm whether they duplicate values already defined as constants/enums/typed wrappers in the same module or shared modules. -- Treat introducing a new hardcoded literal where a project constant already exists as a likely regression risk; require either a refactor to reuse the constant or an explicit exception explanation in the PR body. +## Output -3. Verify readiness requirements -- Select checks from `AGENTS.md` "Verification Before PR" based on the final diff's risk tier. Do not replace a focused behavioral test with `make pre-commit`, or a required high-risk `make pre-pr` with a narrower gate. -- For focused verification, state why the selected tier is sufficient and list the scope-specific commands in the PR body. -- If `make` is unavailable, use the equivalent commands from `.config/make/`. -- Add scope-specific verification commands when the changed area needs more than the baseline. -- If required checks fail, stop and return `BLOCKED`. +- Status: `READY` or `BLOCKED`. +- Title. +- Complete PR body. +- Verification commands and results. +- Risks or `N/A`. -4. Draft PR metadata -- Write the PR title in English using Conventional Commits and keep it within 72 characters. -- If a generic PR workflow suggests a different title format, ignore it and follow the repository rule instead. -- In RustFS, do not use tool-specific prefixes such as `[codex]` when the repository requires Conventional Commits. -- Keep the PR body in English. -- Use the exact section headings from `.github/pull_request_template.md`. -- Fill non-applicable sections with `N/A`. -- Include verification commands in the PR description. -- Do not include local filesystem paths in the PR body unless the user explicitly asks for them. -- Prefer repo-relative paths, command names, and concise summaries over machine-specific paths such as `/Users/...`. - -5. Prepare reviewer context -- Summarize why the change exists. -- Summarize what was verified. -- Call out risks, rollout notes, config impact, and rollback notes when applicable. -- Mention assumptions or missing context instead of guessing. - -6. Prepare CLI-safe output -- When proposing `gh pr create` or `gh pr edit`, use `--body-file`, never inline `--body` for multiline markdown. -- Return a ready-to-save PR body plus a short title. -- If not ready, return blockers first and list the minimum steps needed to unblock. - -## Output format - -### Status -- `READY` or `BLOCKED` - -### Title -- `(): ` - -### PR Body -- Reproduce the repository template headings exactly. -- Fill every section. -- Omit local absolute paths unless explicitly required. - -### Verification -- List each command run. -- State pass/fail. - -### Risks -- List breaking changes, config changes, migration impact, or `N/A`. - -## Blocker rules - -- Return `BLOCKED` if the checks required by the `AGENTS.md` validation tier have not passed. -- Return `BLOCKED` if a documentation-only, agent-instruction-only, or local developer-tooling-only change lacks focused verification for the changed surface. -- Return `BLOCKED` if the diff contains unrelated changes that are not acknowledged. -- Return `BLOCKED` if required template sections are missing. -- Return `BLOCKED` if the title/body is not in English. -- Return `BLOCKED` if the title does not follow the repository's Conventional Commit rule. -- Return `BLOCKED` if the diff introduces string literals that should use existing constants but did not. -- Return `BLOCKED` for production-code growth only when the review identifies a duplicated or superseded implementation, or supplies a concrete smaller design with equivalent semantics. Fewer lines alone are not evidence. - -## Reference - -- Use [pr-readiness-checklist.md](references/pr-readiness-checklist.md) for a short final pass before opening or editing the PR. +Immediately before the GitHub write, repeat only the five preflight checks above +against the final head. diff --git a/.agents/skills/pr-creation-checker/agents/openai.yaml b/.agents/skills/pr-creation-checker/agents/openai.yaml index 6a709cc7d..761e02936 100644 --- a/.agents/skills/pr-creation-checker/agents/openai.yaml +++ b/.agents/skills/pr-creation-checker/agents/openai.yaml @@ -1,4 +1,4 @@ interface: display_name: "PR Creation Checker" short_description: "Draft RustFS-ready PRs with checks, template, and blockers." - default_prompt: "Inspect a branch or diff, verify required PR checks, and produce a compliant English PR title/body plus blockers or readiness status." + default_prompt: "Use $pr-creation-checker for final PR preflight and compliant English title/body metadata." diff --git a/.agents/skills/pr-creation-checker/references/pr-readiness-checklist.md b/.agents/skills/pr-creation-checker/references/pr-readiness-checklist.md deleted file mode 100644 index 354571430..000000000 --- a/.agents/skills/pr-creation-checker/references/pr-readiness-checklist.md +++ /dev/null @@ -1,16 +0,0 @@ -# PR Readiness Checklist - -- Confirm the branch is based on current `main`. -- Confirm the diff matches the stated scope. -- Confirm no secrets, logs, temp files, or unrelated refactors are included. -- Confirm the checks required by the `AGENTS.md` validation tier passed. -- For focused verification, confirm it covered the changed surface and the PR body explains why the selected tier is sufficient. -- Confirm extra verification commands are listed for risky changes. -- Confirm the PR title uses Conventional Commits and stays within 72 characters. -- Confirm the PR title does not use tool-specific prefixes such as `[codex]`. -- Confirm the PR body is in English. -- Confirm the PR body keeps the exact headings from `.github/pull_request_template.md`. -- Confirm non-applicable sections are filled with `N/A`. -- Confirm the PR body does not include local absolute paths unless explicitly required. -- Confirm multiline GitHub CLI commands use `--body-file`. -- Confirm new hardcoded string literals were not introduced for values already represented by existing constants/enums (including protocol labels, error identifiers, headers, and metric names), or record a justified exception. diff --git a/.agents/skills/rust-code-quality/SKILL.md b/.agents/skills/rust-code-quality/SKILL.md index 3c85805bd..ef78c23fe 100644 --- a/.agents/skills/rust-code-quality/SKILL.md +++ b/.agents/skills/rust-code-quality/SKILL.md @@ -1,11 +1,12 @@ --- name: rust-code-quality -description: Enforce Rust-specific code quality rules on every Rust change. Use before merge to catch unwrap abuse, silent truncation, unnecessary cloning, lock ordering violations, recursion risks, and error type anti-patterns. +description: Run a focused Rust quality review when the user requests one, when reviewing a Rust PR/commit, or when another selected review workflow delegates Rust-specific checks. Do not auto-load for every implementation edit. --- # Rust Code Quality Gate -Use this skill on every Rust code change to enforce quality rules that `cargo clippy` does not catch. +Use this skill for a dedicated Rust review to cover rules that `cargo clippy` +does not catch. ## Quick Start @@ -45,7 +46,7 @@ rg -n 'unwrap_or_default\(\)|unwrap_or\(' ## Manual Review Checklist -For every Rust code change, verify: +For the Rust diff under review, verify: ### Error Handling - [ ] Every production `unwrap()` or `expect()` is infallible by type or a checked invariant; explain only non-obvious invariants, using an existing type, a useful `expect` message, or a concise comment diff --git a/.agents/skills/rustfs-logging-governance/SKILL.md b/.agents/skills/rustfs-logging-governance/SKILL.md index ec716fca6..b00e57216 100644 --- a/.agents/skills/rustfs-logging-governance/SKILL.md +++ b/.agents/skills/rustfs-logging-governance/SKILL.md @@ -1,107 +1,34 @@ --- name: rustfs-logging-governance -description: Standardize and review RustFS logging with structured `tracing` events, lower noise on hot paths, preserve security-sensitive diagnostics, and extend guardrails to prevent legacy logging patterns from returning. Use whenever a change adds or edits any `tracing` macro call (`error!`/`warn!`/`info!`/`debug!`/`trace!`/`#[instrument]`) — including a single log line added in passing while fixing unrelated logic, which is how most new log sites enter the repo — and when reviewing RustFS logs, startup/config diagnostics, cloud metadata logs, request validation logs, or `scripts/check_logging_guardrails.sh`. +description: Add or review RustFS `tracing` events with the repository field shape, level policy, privacy boundaries, and guardrails. Use when a change adds or edits a tracing macro/instrumentation site or the logging guardrail script. --- # RustFS Logging Governance -Use this skill when RustFS logging needs to be added, cleaned up, reviewed, or protected against regressions. +Apply this skill only to changed logging sites; do not turn a local log edit into +a broad logging cleanup. -## Quick Start +## Workflow -1. Identify the files whose logs are changing. -2. Scan current `tracing` or `log` macros before editing. -3. Convert sentence-style logs to short event-style logs. -4. Demote hot-path success logs unless operators truly need them at `info`. -5. Preserve failure, fallback, and security-relevant diagnostics. -6. Update `scripts/check_logging_guardrails.sh` when a broad cleanup removes a legacy pattern class. -7. Validate with formatting, targeted checks/tests, and the logging guardrail script. +1. Read the changed function/module context and classify the site as lifecycle, + request/hot path, fallback, external fetch, or summary. +2. Match neighboring structured events and reuse existing `EVENT_*`, + `LOG_COMPONENT_*`, and `LOG_SUBSYSTEM_*` constants. +3. Put stable fields first (`event`, `component`, `subsystem`, `state`/`result`, + then context) and a short label last. +4. Select the level by operational meaning: + - `error`: behavior/security-affecting failure; + - `warn`: degraded/fallback/operator-actionable state; + - `info`: low-frequency lifecycle/mode change; + - `debug`: targeted diagnostics; + - `trace`: repetitive request/object/shard success paths. +5. Never log secrets, tokens, auth headers, credential payloads, raw + attacker-controlled bodies, or merged config dumps. Error strings and + `Debug` output are log surfaces too. +6. Prefer one aggregate summary over inventories or startup banners. +7. Run `./scripts/check_logging_guardrails.sh` and the checks selected by root + `AGENTS.md`. -## Core Workflow - -### 1. Scope the logging surface - -- Read the changed module in full before touching log lines. -- Classify the log site: - - lifecycle/startup - - request or validation path - - background loop or hot path - - fallback/degraded behavior - - cloud metadata or external fetch path - - metrics/config summary -- Do not rewrite business logic to make logging easier. - -### 2. Use the RustFS event shape - -- Prefer fields first, message second. -- Use short labels, not prose paragraphs. -- Default field shape: - - `event` - - `component` - - `subsystem` - - `state` or `result` - - key context fields -- Reuse stable field names and avoid inventing near-duplicates. - -See `references/logging-governance.md` for the event model, level policy, and anti-pattern list. - -### 3. Choose the right level - -- `error`: operation failure that affects behavior or security guarantees. -- `warn`: degraded path, fallback, suspicious input, or operator-actionable misconfiguration. -- `info`: low-frequency lifecycle or mode selection. -- `debug`: targeted diagnostics and low-volume detail. -- `trace`: hot-path and repetitive success-path events. - -When in doubt, lower the verbosity of normal success paths and keep structured detail in fields. - -### 4. Preserve security and privacy boundaries - -- Do not log secrets, tokens, auth headers, raw credential payloads, or merged config dumps. -- Avoid logging raw forwarded headers or full trusted network inventories above `debug`. -- Keep warning/error logs useful without echoing attacker-controlled payloads unnecessarily. - -### 5. Keep summaries aggregated - -- Replace multi-line startup banners or checklist logs with one structured event. -- If metrics already express a concept, avoid duplicating it with many `info!` lines. -- Prefer counts, modes, and sources over inventories unless debug detail is truly needed. - -### 6. Update guardrails when needed - -- Broad logging cleanup should usually extend `scripts/check_logging_guardrails.sh`. -- Add forbidden patterns only for styles the repo has intentionally retired: - - sentence-style lifecycle logs - - noisy hot-path `info!` - - checklist-style summary logs - - legacy fallback wording that has been replaced by structured fields -- Keep guardrails concrete and grep-friendly. - -### 7. Validate manually - -Use the smallest relevant set: - -```bash -cargo fmt --all --check -./scripts/check_logging_guardrails.sh -cargo check -p -cargo test -p -``` - -For broader Rust changes, add: - -```bash -./scripts/check_unsafe_code_allowances.sh -./scripts/check_architecture_migration_rules.sh -cargo clippy -p --all-targets -- -D warnings -``` - -## RustFS-Specific Notes - -- The durable RustFS logging direction is `event + component + subsystem + state/result + key context fields`. -- `crates/concurrency` and `crates/trusted-proxies` are examples of this style for lifecycle, fallback, and cloud metadata logs. -- `scripts/check_logging_guardrails.sh` is the enforcement point for preventing removed log styles from returning. - -## References - -- Read `references/logging-governance.md` when you need the detailed field set, anti-pattern examples, or guardrail update checklist. +Read [logging-governance.md](references/logging-governance.md) only for a broad +logging audit, event-model migration, or guardrail expansion. Ordinary single- +site edits do not require the full workspace scope map. diff --git a/.agents/skills/rustfs-logging-governance/references/logging-governance.md b/.agents/skills/rustfs-logging-governance/references/logging-governance.md index 7d4b23893..4002932e3 100644 --- a/.agents/skills/rustfs-logging-governance/references/logging-governance.md +++ b/.agents/skills/rustfs-logging-governance/references/logging-governance.md @@ -1,285 +1,62 @@ -# RustFS Logging Governance Reference +# Logging Audit and Migration Reference -## Workspace Scope Map +Read this reference only for a broad logging audit, an event-model migration, +or a change to `scripts/check_logging_guardrails.sh`. Use `Cargo.toml` for the +current workspace/crate list instead of maintaining one here. -Use `Cargo.toml` `[workspace].members` as the source of truth for crate membership. When doing a broad logging sweep, classify crates by operational role so logs stay consistent within each role. +## Audit by Operational Role -### Core Server And Request Handling +- Server/protocol/admin: lifecycle, authorization failures, request boundaries, + and degraded subsystems; avoid normal request success at `info`. +- Storage/heal/scanner/capacity: integrity failures and aggregate lifecycle; + avoid per-object, per-shard, and folder iteration noise. +- IAM/policy/credentials/KMS/crypto: safe identifiers and enforcement results; + never emit secrets, claims, payloads, or expected authenticators. +- Notify/audit/targets: target lifecycle and batch/backpressure summaries; avoid + per-event success logs. +- Locking/concurrency/I/O foundations: contention anomalies and state changes; + prefer metrics for high-frequency worker/permit signals. +- Shared type/schema crates: log at the operational caller boundary unless the + crate itself owns the failure context. -- `rustfs` - - Role: top-level server, startup, auth, admin wiring, S3 request handling. - - Logging focus: startup lifecycle, config summaries, authn/authz failures, protocol entrypoints, degraded subsystems. -- `crates/protocols` - - Role: protocol integrations such as FTP, SFTP, WebDAV, and related server-side protocol layers. - - Logging focus: listener lifecycle, per-protocol enablement/disablement, request bridge failures. -- `crates/madmin` - - Role: admin API contracts and management interfaces. - - Logging focus: admin action boundaries, validation failures, compatibility warnings. -- `crates/trusted-proxies` - - Role: forwarded IP trust, proxy chain validation, cloud metadata sources. - - Logging focus: direct/trusted/fallback decisions, degraded metadata fetches, aggregated config summaries. -- `crates/keystone` - - Role: Keystone auth integration. - - Logging focus: integration enablement, upstream auth failures, config safety without credential leakage. +## Event Shape -### Storage, Healing, And Data Plane +Prefer stable fields in this order when available: -- `crates/ecstore` - - Role: erasure-coded storage implementation and peer/store initialization. - - Logging focus: disk/peer lifecycle, storage fallback, object I/O failures, avoid per-object noise. -- `crates/heal` - - Role: healing orchestration and repair workflows. - - Logging focus: scheduler lifecycle, repair decisions, backlog or skipped work summaries, avoid repetitive task spam at `info`. -- `crates/scanner` - - Role: data integrity scanning and health monitoring. - - Logging focus: scan lifecycle, compaction/deep-heal transitions, lag/backlog, noisy folder iteration should stay at `debug/trace`. -- `crates/object-capacity` - - Role: capacity scan and refresh core. - - Logging focus: refresh lifecycle, degraded capacity sources, aggregate stats rather than per-object chatter. -- `crates/filemeta` - - Role: file metadata parsing and helpers. - - Logging focus: parse failures, schema/format mismatch, avoid dumping raw metadata payloads. -- `crates/storage-api` - - Role: storage contracts and shared data plane interfaces. - - Logging focus: contract mismatch and boundary diagnostics, usually low-volume. -- `crates/checksums` - - Role: checksum helpers and validation. - - Logging focus: integrity failures and compatibility mismatches, not per-chunk success logs. -- `crates/zip` - - Role: ZIP handling and compression helpers. - - Logging focus: parse/extract failures, archive path safety issues, avoid verbose file-by-file success logs. +1. `event` +2. `component` +3. `subsystem` +4. `state` or `result` +5. stable context such as mode, duration, reason, counts, safe identifiers, or + capacity/permit values +6. short message label -### Security, Identity, And Policy +Reuse the module's constants and neighboring field names. Do not create aliases +for the same concept. -- `crates/iam` - - Role: identity and access management. - - Logging focus: authz decision boundaries, imported payload safety, do not leak principals, secrets, or claims. -- `crates/policy` - - Role: policy modeling and evaluation. - - Logging focus: deny/allow decision context, parser/validation failures, no raw secret-bearing request dumps. -- `crates/credentials` - - Role: credential handling. - - Logging focus: never log secrets or tokens; only safe identifiers and redacted states. -- `crates/kms` - - Role: key management service integration. - - Logging focus: init/health/fallback, key-source availability, never log key material. -- `crates/crypto` - - Role: cryptographic helpers and security primitives. - - Logging focus: only algorithm or mode state, not plaintext, ciphertext, or secret-derived material. -- `crates/security-governance` - - Role: security governance contracts. - - Logging focus: policy/state transitions and enforcement diagnostics. -- `crates/signer` - - Role: request signing helpers. - - Logging focus: signature validation failures without expected-signature leakage. +## Patterns to Retire -### Notifications, Audit, And Targets +- sentence-style lifecycle announcements; +- startup banners and checklist lines; +- repetitive success logs at `info`/`debug`; +- raw inventories when an aggregate count is sufficient; +- fallback prose with values embedded in the message; +- `?value`/`Debug` output for credential-bearing or attacker-controlled data; +- logging a parse input when the malformed input may itself be a secret. -- `crates/notify` - - Role: notification dispatch, runtime facade, notifier implementations. - - Logging focus: target lifecycle, dispatch summaries, stream lag/backpressure, avoid per-event success spam. -- `crates/audit` - - Role: audit target fan-out and audit pipeline management. - - Logging focus: pipeline lifecycle, target availability, batch dispatch summaries, avoid noisy "started successfully" prose. -- `crates/targets` - - Role: target-specific configuration and utilities used by fan-out style systems. - - Logging focus: target selection, config validation, per-target degraded state. -- `crates/s3-types` - - Role: S3 event and type definitions. - - Logging focus: usually minimal; keep logging at integration boundaries rather than low-level type crates. -- `crates/s3-ops` - - Role: S3 operation definitions and mapping. - - Logging focus: mapping/contract failures, unsupported combinations, not normal-path request spam. +## Guardrail Changes -### Concurrency, Locking, And Runtime Foundations +When expanding `scripts/check_logging_guardrails.sh`: -- `crates/concurrency` - - Role: timeout, locking, backpressure, and I/O scheduling facade. - - Logging focus: lifecycle transitions and degraded states, not high-frequency worker/permit churn at `info`. -- `crates/lock` - - Role: distributed locking implementation. - - Logging focus: lock lifecycle, contention anomalies, lock ordering or timeout diagnostics. -- `crates/tls-runtime` - - Role: shared TLS runtime foundation. - - Logging focus: certificate lifecycle, reload/fallback, validation failures without sensitive dumps. -- `crates/obs` - - Role: observability helpers. - - Logging focus: this crate shapes other crates' telemetry conventions; avoid recursive or redundant summaries. -- `crates/io-core` - - Role: zero-copy I/O core primitives. - - Logging focus: keep very sparse; prefer metrics unless failures are actionable. -- `crates/io-metrics` - - Role: I/O metrics collection. - - Logging focus: typically minimal; metrics should carry the hot-path signal. -- `crates/rio` - - Role: Rust I/O utility layer. - - Logging focus: compatibility or runtime boundary failures, not fast-path internals. -- `crates/rio-v2` - - Role: next-generation I/O compatibility layer. - - Logging focus: migration/feature-mode differences and degraded fallback between I/O paths. -- `crates/utils` - - Role: shared helpers. - - Logging focus: usually avoid direct logging in generic helpers unless the helper is itself an operational boundary. -- `crates/common` - - Role: shared data structures and helpers. - - Logging focus: same principle as `utils`; prefer callers to log context-rich events. -- `crates/config` - - Role: configuration management. - - Logging focus: config source, fallback, validation, and summary aggregation; avoid dumping merged configs. -- `crates/data-usage` - - Role: shared data usage models and algorithms. - - Logging focus: refresh lifecycle, summary stats, and degraded reads. +1. Add only files/patterns intentionally migrated in the same change. +2. Keep patterns concrete and grep-friendly. +3. Do not encode a style that remains valid elsewhere as a global ban. +4. Run the guardrail script and the root validation tier. +5. Treat the script as a floor; manually verify level, field shape, and privacy. -### Schema, Contracts, And API Support - -- `crates/protos` - - Role: protobuf definitions. - - Logging focus: usually none inside the crate; emit logs at decode/use boundaries. -- `crates/extension-schema` - - Role: extension schema contracts. - - Logging focus: schema validation and compatibility mismatches. -- `crates/s3select-api` - - Role: S3 Select API interfaces. - - Logging focus: request validation and unsupported feature boundaries. -- `crates/s3select-query` - - Role: S3 Select query engine. - - Logging focus: query parse/planning/execution failures, avoid row-level spam. -- `crates/protocols` - - Role: non-S3 protocol support. - - Logging focus: see core server section; keep per-request verbosity below `info`. - -### Testing And Non-Production Crates - -- `crates/e2e_test` - - Role: end-to-end tests. - - Logging focus: test clarity matters more than production governance, but avoid copying test-only logging style into production crates. - -## Current Guardrail Coverage Map - -`scripts/check_logging_guardrails.sh` currently enforces retired patterns in these high-signal areas: - -- `rustfs/src/main.rs` -- `rustfs/src/startup_iam.rs` -- `rustfs/src/auth.rs` -- `rustfs/src/protocols/client.rs` -- `crates/audit/src/pipeline.rs` -- `crates/audit/src/system.rs` -- `crates/audit/src/global.rs` -- `crates/notify/src/config_manager.rs` -- `crates/notify/src/runtime_facade.rs` -- `crates/notify/src/notifier.rs` -- `crates/ecstore/src/store/peer.rs` -- `crates/ecstore/src/store/init.rs` -- `crates/ecstore/src/tier/tier.rs` -- `crates/concurrency/src/workers.rs` -- `crates/concurrency/src/manager.rs` -- `crates/concurrency/src/lock.rs` -- `crates/concurrency/src/deadlock.rs` -- `crates/trusted-proxies/src/global.rs` -- `crates/trusted-proxies/src/config/loader.rs` -- `crates/trusted-proxies/src/proxy/metrics.rs` -- `crates/trusted-proxies/src/proxy/validator.rs` -- `crates/trusted-proxies/src/proxy/chain.rs` -- `crates/trusted-proxies/src/middleware/service.rs` -- `crates/trusted-proxies/src/cloud/detector.rs` -- `crates/trusted-proxies/src/cloud/ranges.rs` -- `crates/trusted-proxies/src/cloud/metadata/aws.rs` -- `crates/trusted-proxies/src/cloud/metadata/azure.rs` -- `crates/trusted-proxies/src/cloud/metadata/gcp.rs` - -When expanding coverage, prefer crates with: - -- repeated sentence-style lifecycle logs -- high-frequency success-path `info!` -- startup/config checklist banners -- security-sensitive fallback wording -- external fetch/retry/fallback flows - -That typically means the next broad candidates are `rustfs`, `crates/notify`, `crates/audit`, `crates/targets`, `crates/heal`, and `crates/scanner`. - -## Event Model - -Prefer this structure when the fields are available: - -- `event` -- `component` -- `subsystem` -- `state` or `result` -- stable context fields such as: - - `enabled` - - `implementation` - - `validation_mode` - - `peer_ip` - - `client_ip` - - `proxy_hops` - - `duration_ms` - - `fallback` - - `reason` - - `range_count` - - `hold_time_ms` - - `available_slots` - - `total_slots` - - `permits_in_use` - -## Level Policy - -- `error`: the operation fails and callers or security guarantees are affected. -- `warn`: a degraded path, fallback, suspicious request, or operator-actionable config issue occurs. -- `info`: a low-frequency lifecycle or mode transition occurs. -- `debug`: useful diagnostics exist but normal operators do not need them all the time. -- `trace`: hot-path and repetitive success-path details occur. - -## Preferred Patterns - -- Use a short message label: - - `"trusted proxy validation failed"` - - `"concurrency manager state changed"` - - `"trusted proxy cloud metadata loaded"` -- Put key meaning into fields, not only the message text. -- Aggregate config or metrics summaries into one log event. - -## Retired Patterns - -These should usually be removed or replaced: - -- Sentence-style lifecycle logs: - - `info!("Concurrency manager stopped")` - - `info!("Trusted Proxies module initialized")` -- Checklist or banner logs: - - `info!("=== Application Configuration ===")` - - `info!("Available metrics:")` -- Hot-path noise: - - `info!("worker take, {}", *available)` - - `debug!("Proxy validation successful in {:?}", duration)` -- Legacy fallback prose: - - `"Request from private network but not trusted: ..."` - - `"Cloud metadata fetching is disabled"` - -## Guardrail Update Checklist - -When extending `scripts/check_logging_guardrails.sh`: - -1. Add the touched files to `checked_files`. -2. Add only legacy patterns that have been intentionally retired. -3. Keep patterns literal and grep-friendly. -4. Run the guardrail script after changes. -5. Avoid adding patterns for logs that are still valid elsewhere in the repo. - -## Validation Checklist - -For logging-only changes: +Useful search seeds for the changed surface: ```bash -cargo fmt --all --check -./scripts/check_logging_guardrails.sh -cargo check -p -cargo test -p -``` - -For broader Rust changes: - -```bash -./scripts/check_unsafe_code_allowances.sh -./scripts/check_architecture_migration_rules.sh -cargo clippy -p --all-targets -- -D warnings +rg -n 'error!|warn!|info!|debug!|trace!|#\[instrument' +rg -n '\?[^,)]|secret|token|credential|authorization|merged_config' ``` diff --git a/.agents/skills/rustfs-release-publish/SKILL.md b/.agents/skills/rustfs-release-publish/SKILL.md index 9bf8ab297..e38cfc587 100644 --- a/.agents/skills/rustfs-release-publish/SKILL.md +++ b/.agents/skills/rustfs-release-publish/SKILL.md @@ -1,6 +1,6 @@ --- name: rustfs-release-publish -description: "End-to-end RustFS release pipeline: first publish any merged-but-unreleased rustfs/console changes and wait for its latest Release asset, then bump RustFS version files on main directly to the final target, publish a visible GitHub prerelease from a preview tag without updating latest channels, validate it, and publish the final tag on the SAME commit. Use whenever the user wants to release/publish a RustFS version (发版/发布)." +description: "Run the end-to-end RustFS console gate, version bump, preview validation, and final-tag publication pipeline. Use only when the user explicitly asks to release or publish a RustFS version (发版/发布)." --- # RustFS Release Publish (preview-validated pipeline) diff --git a/.agents/skills/rustfs-release-version-bump/SKILL.md b/.agents/skills/rustfs-release-version-bump/SKILL.md index 3c760f409..d184ea27a 100644 --- a/.agents/skills/rustfs-release-version-bump/SKILL.md +++ b/.agents/skills/rustfs-release-version-bump/SKILL.md @@ -1,6 +1,6 @@ --- name: rustfs-release-version-bump -description: "Publish a RustFS alpha/beta/stable release with an auditable flow: confirm target version and scope, update workspace and release assets (including strict rustfs.spec changelog identity/date/version format), run required verification, and finish with commit, push, and GitHub PR creation." +description: "Prepare the version-file and release-asset bump for an exact RustFS alpha/beta/stable target, with verification and optional commit/push/PR delivery. Use for an explicit version bump or when invoked by the release-publish workflow." --- # RustFS Release Version Bump @@ -81,10 +81,7 @@ Only drop a file when the current repository release process clearly no longer r 4. Verify before shipping - Run: -- `cargo fmt --all` -- `cargo fmt --all --check` - `make pre-commit` -- If verification passes, run `cargo clean`. - If `make pre-commit` fails, return `BLOCKED` with root cause and do not silently widen scope to fix unrelated issues unless user asks. 5. Commit strategy @@ -109,10 +106,7 @@ Only drop a file when the current repository release process clearly no longer r - `git diff --name-only origin/main...HEAD` - `git diff --stat origin/main...HEAD` - `rg -n "|" Cargo.toml Cargo.lock README.md README_ZH.md flake.nix helm/rustfs/Chart.yaml rustfs.spec` -- `cargo fmt --all` -- `cargo fmt --all --check` - `make pre-commit` -- `cargo clean` ## Output contract diff --git a/.agents/skills/rustfs-release-version-bump/agents/openai.yaml b/.agents/skills/rustfs-release-version-bump/agents/openai.yaml index 3483dedcc..4bd3e0ff6 100644 --- a/.agents/skills/rustfs-release-version-bump/agents/openai.yaml +++ b/.agents/skills/rustfs-release-version-bump/agents/openai.yaml @@ -1,4 +1,4 @@ interface: display_name: "RustFS Release Bump" short_description: "Prepare RustFS release branches like PR #2957." - default_prompt: "Use $rustfs-release-version-bump to prepare a RustFS release version, ask about any unclear version policy, and finish the commit/push/PR flow." + default_prompt: "Use $rustfs-release-version-bump to prepare and verify an exact RustFS release-version bump." diff --git a/.agents/skills/security-advisory-lessons/SKILL.md b/.agents/skills/security-advisory-lessons/SKILL.md index 492669f44..99a43fcc7 100644 --- a/.agents/skills/security-advisory-lessons/SKILL.md +++ b/.agents/skills/security-advisory-lessons/SKILL.md @@ -1,170 +1,40 @@ --- name: security-advisory-lessons -description: Apply RustFS security lessons distilled from repository GitHub Security Advisories. Use when making or reviewing RustFS code changes, doing security checks, handling PR review for auth/authz, IAM, storage, RPC, logging, CORS, console/browser, encryption, policy, or endpoint changes, and when deciding which security regression tests are required. +description: Perform a dedicated RustFS security/advisory review for authn/authz, IAM, RPC trust, paths, secrets, browser isolation, encryption, Object Lock, or other security boundaries. Use only when the user requests a security/advisory review or an adversarial review explicitly escalates to the full advisory map; do not auto-load solely because code touches a sensitive path. --- # RustFS Security Advisory Lessons -Use this skill as a RustFS-specific security lens before changing or approving code. For the distilled advisory lessons and review patterns, read [advisory-patterns.md](references/advisory-patterns.md). +Use this skill as the deep security lens. For a normal adversarial review with a +matched security surface, the concise security reference under +`adversarial-validation` is sufficient. -When currentness matters, fetch the live advisory inventory instead of relying on this skill as a status mirror: +## Workflow + +1. Freeze the exact diff/head and identify the changed trust boundaries. +2. Read [advisory-patterns.md](references/advisory-patterns.md), then apply only + the matching sections. Useful headings are + auth/admin, IAM/STS/OIDC, policy/plugins, S3/copy/multipart, protocols, paths, + secrets/logging/RPC, browser/CORS/proxy, SSE, Object Lock, and serde. +3. Trace unauthenticated, low-privilege, wrong-action/owner/bucket, malformed, + and default-config cases. Security decisions must fail closed. +4. Require a focused negative regression test for the bypass/exploit form, not + only the intended success path. State residual risk when a test is impractical. +5. Report proven vulnerabilities separately from defense-in-depth hardening. + +When advisory currentness matters, fetch the live inventory instead of treating +the reference as a status mirror: ```bash gh api repos/rustfs/rustfs/security-advisories --paginate \ --jq '.[] | {ghsa_id,state,severity,summary,updated_at}' ``` -Fetch full advisory details only when the live summary suggests a new or changed lesson: +Fetch an individual advisory only when the live summary indicates a new or +changed lesson. -```bash -gh api repos/rustfs/rustfs/security-advisories/ -``` +## Finding Standard -For the full pattern map, read [advisory-patterns.md](references/advisory-patterns.md). - -## Workflow - -### 1. Scope the change -- Identify touched routes, protocol frontends, handlers, storage paths, credentials, logs, browser surfaces, CI/release code, and policy checks. -- Treat these paths as security-sensitive by default: `rustfs/src/admin/`, `rustfs/src/storage/`, `rustfs/src/auth.rs`, `rustfs/src/server/layer.rs`, `crates/iam/`, `crates/policy/`, `crates/credentials/`, `crates/ecstore/src/rpc/`, `crates/protocols/`, `crates/rio/`, OIDC/STS federation code, and console preview/auth code. - -### 2. Map to advisory classes -- Read [advisory-patterns.md](references/advisory-patterns.md) for matching GHSA lessons. -- Do not rely on advisory titles alone. Confirm whether the issue is authentication, authorization, input validation, storage invariant, browser isolation, logging, or operational hardening. - -### 3. Verify fail-closed behavior -- Check that unauthenticated, wrong-permission, cross-user, cross-bucket, malformed-input, and default-config cases fail explicitly. -- Prefer exact action/permission checks over broad helper calls or inferred ownership. -- Confirm lower storage/RPC layers do not bypass checks done in upper layers. - -### 4. Require regression evidence -- For behavior changes, add focused negative tests that reproduce the advisory class. -- For sensitive fixes, include tests for the bypass form, not only the happy path. -- If a test is impractical, explain the residual risk and provide a manual verification command. - -### 5. Report clearly -- Lead with concrete findings and file/line evidence. -- Separate proven vulnerabilities from hardening risks. -- Avoid exaggerating unauthenticated impact when the code actually rejects unauthenticated requests but allows a low-privileged authenticated bypass. - -## Advisory-Derived Guardrails - -### Auth and admin authorization -- Every admin or diagnostic route needs an explicit authn and authz story. Route registration, router whitelist, and handler-level authorization must agree. -- Match the admin action to the operation exactly. Copy-paste action constants are a known RustFS vulnerability class. -- Avoid authentication-only helpers for state-changing admin APIs; use `validate_admin_request` or the established equivalent with the right `AdminAction`. -- Read-only admin APIs such as metrics, server info, and diagnostics still require admin authorization; checking only that credentials exist is not enough. -- Replication admin reads can expose remote target credentials; list/get target endpoints require replication/admin authorization and must not return secrets to low-privilege callers. -- Do not assume admin-action `Resource` scoping constrains blast radius unless the policy engine actually enforces resources for that action. - -### IAM and service accounts -- Treat imported IAM payload fields as attacker-controlled: `parent`, `claims`, `accessKey`, `secretKey`, status, policy names, and groups. -- For service account create/update/import, prove parent ownership or root/admin authority before writing credentials or claims; an action permission alone must not allow choosing root or another user as `target_user`. -- Treat IAM export packages as credential disclosure surfaces; never include plaintext user or service-account secret keys unless the caller is allowed to recover those secrets and the export format is intentionally sealed. -- Do not let `deny_only` or "no explicit deny" become an allow decision that skips required allow checks. -- Test cross-user list/update/import flows with wrong, correct, self, parent, and root identities. - -### STS, OIDC, and federation flows -- Every STS endpoint must have an explicit authentication story: SigV4 where required, OIDC token verification for web identity, and role/session policy validation before issuing credentials. -- For web identity, the JWT is the credential; exemption from SigV4 is not itself an authentication bypass. Treat pre-verification claims only as untrusted routing hints, bound token size, normalize public failures, rate-limit discovery, and issue credentials only after signature, issuer, audience, and expiration checks. -- JWT session tokens must be signed and verified by a trusted issuer/key path, not by service-account-controlled material or a reused root secret. -- JWT verification must enforce required claims and expiration for every bearer token path; "allow missing exp" is never acceptable for user-presented credentials. -- Public OIDC bootstrap and callback routes must treat `Host`, `X-Forwarded-Proto`, redirect targets, `state`, and callback parameters as untrusted; credential-bearing redirects require a configured, allowlisted origin. -- OIDC discovery and validation URLs are SSRF sinks. Resolve and classify hostnames at connection time, reject rebinding to loopback/private/link-local ranges, and do not rely on literal string checks. - -### IAM policy conditions and plugins -- Treat request headers as attacker-controlled even after SigV4; callers sign their own spoofed headers. Do not merge them into server-derived condition keys such as identity, groups, version ID, signature version, JWT, or LDAP claims. -- Keep the condition-key namespace explicit. Reserved server-derived keys must reject or ignore colliding headers, while intentional request-header keys such as `s3:x-amz-*` remain available. -- Quantified IAM condition tests need partially overlapping multi-value sets. Fully contained and fully disjoint sets cannot distinguish `ForAllValues` from `ForAnyValue` bugs. -- External policy plugins must receive the same security context as built-in policy evaluation. If OPA or another plugin depends on existing object tags, load and pass `ExistingObjectTag/*` before the plugin decision. - -### S3 object actions, copy, multipart, and presigned POST -- Version-aware object requests need version-aware actions. Explicit `versionId` reads and copy sources must authorize `s3:GetObjectVersion`, not only `s3:GetObject`. -- Multipart copy must enforce source `GetObject` and destination `PutObject` semantics equivalent to `CopyObject`, including copy-source and policy conditions. -- Do not let `CreateMultipartUpload`, `UploadPartCopy`, `CompleteMultipartUpload`, or `AbortMultipartUpload` return success without authorization. -- Fallbacks from version actions to non-version actions must still pass the same public-access-block, anonymous-deny, and post-authorization gates as a direct allow. -- Presigned POST policies are server-side contracts. Enforce `content-length-range`, key prefix, exact metadata/content-type, and all signed policy conditions. - -### Protocol frontends and IAM parity -- FTP/FTPS, SFTP, gateway, and other protocol drivers must enforce IAM per operation before calling storage backends; authentication to a protocol listener is not authorization. -- Match protocol commands to the same S3 actions as HTTP, such as `RETR` to `GetObject`, `SIZE`/`MDTM` to `HeadObject`, `MKD` to `CreateBucket`, and bucket probes to `ListBucket` or `HeadBucket`. -- Review every handler in a protocol driver, not only the changed handler, because RustFS advisories show mixed guarded and unguarded siblings in the same driver. -- Regression tests for protocol frontends should deny the shared authorization hook and prove the backend is not reached for the denied command. -- Compare protocol secrets in constant time, normalize invalid-user and invalid-secret failures where practical, and add rate limiting before exposing password-style protocol endpoints. - -### Paths, object keys, and filesystem access -- Never join untrusted bucket/object/RPC path strings onto filesystem roots without normalization and boundary checks. -- Reject or safely handle `..`, absolute paths, URL-encoded traversal, platform separators, empty components, and paths that canonicalize outside the intended root. -- Validate both S3 object-key paths and internode/RPC disk paths; storage helpers can bypass S3 authorization if they trust already-parsed paths. -- Archive auto-extract paths are object keys too. Validate tar/zip entry names before IAM checks and before storage writes, and prove cleaned paths cannot cross bucket or prefix boundaries. - -### Secrets, default credentials, and crypto -- Do not ship hard-coded shared tokens, HMAC secrets, private keys, or production test keys. -- Defaults for root credentials and internode/RPC auth must fail closed for network-reachable deployments or generate per-install random secrets; warnings alone are not a security boundary. -- Keep cryptographic roles separated: root S3 credentials, RPC HMAC keys, and STS/JWT signing keys must not be reused or deterministically derived from each other. -- License or token validation must use signatures with embedded public/verifying keys only; do not use private-key decryption as authenticity. -- Plan key rotation and key IDs when removing exposed keys. - -### Logging and debug output -- Logs must never include access keys beyond safe identifiers, secret keys, session tokens, JWT claims, HMAC secrets, expected signatures, license secrets, or raw response bodies containing credentials. -- Treat `Debug` implementations, `?value` tracing, merged config dumps, and dependency-level HTTP body logging as leak surfaces. -- Error and panic messages are log content: they propagate through `?` and get printed by `error!`/startup logging far from where they were constructed. Never interpolate a raw config or credential value into an error string. -- A value that fails secret-format parsing is usually the secret itself (e.g. a bare base64 key missing its `:` prefix), so a parse-failure hint must name the env var or file and the expected format, never echo the input. Redacting `Debug` impls does not cover this channel. -- Add log-capture tests or targeted unit tests for redaction wrappers when changing credential structs or response bodies. - -### RPC, parsing, and panic safety -- Treat all RPC payload bytes as attacker-controlled. Replace `unwrap`, `expect`, and panic-prone deserialization with typed errors. -- Malformed request tests should cover empty bytes, truncated MessagePack/protobuf, invalid enum values, stale timestamps, and invalid signatures. -- RPC authentication must be independently strong; do not depend on S3 admin credentials unless the fallback is explicit and safe. -- RPC signatures must bind the exact generated gRPC method path, timestamp, and request method. Service-prefix signatures must not authorize a different concrete NodeService call. - -### Browser, CORS, and console surfaces -- Do not reflect arbitrary `Origin` while also allowing credentials. Default CORS should be no CORS unless explicitly configured. -- Do not render user-controlled object content in a same-origin iframe with console credentials available to JavaScript. -- Prefer origin separation for object preview/download, `nosniff`, CSP, strict content-type handling, and avoiding durable credentials in `localStorage`. -- Preview safety must be based on trusted content type and sandboxing, not object names or extensions such as `.pdf`. -- Console license/version-like metadata endpoints should expose only coarse public data unless authenticated, especially subject names and expiration timestamps. - -### Profiling, debug, and health endpoints -- Profiling and debug endpoints are not health checks. They require admin auth, opt-in enablement, rate limiting, and safe responses. -- Do not return absolute filesystem paths or other deployment layout in unauthenticated or low-privilege responses. -- Ensure health endpoint allowlists cannot accidentally include expensive diagnostics. - -### Trusted proxy and network identity -- Only honor `X-Forwarded-For` or `X-Real-IP` when the request came from a configured trusted proxy. -- Apply the same trusted-proxy rule to scheme and host derivation; direct clients must not control security-sensitive redirects through `Host`, `X-Forwarded-Host`, or `X-Forwarded-Proto`. -- Direct clients must use the socket peer address for `aws:SourceIp` and policy condition evaluation. -- Add tests for direct spoofed headers and trusted-proxy headers. - -### SSE and storage invariants -- Encryption metadata is not proof that bytes were encrypted on disk. -- When touching reader/writer wrappers such as hashing, encryption, compression, or warp readers, verify wrapper order and inspect stored bytes in regression tests. -- Avoid helper shortcuts that unwrap nested readers and accidentally bypass encryption or integrity layers. - -### Object Lock and retention invariants -- Object Lock state must fail closed when bucket metadata is unreadable, fabricated, or unparsable. Only a confirmed absence of Object Lock configuration may permit unprotected deletes or writes. -- Do not collapse metadata read faults, missing persisted metadata, parse failures, and genuinely absent Object Lock config into one "not configured" result. -- Retention enforcement must cover foreground deletes, batch deletes, force-delete helpers, default-retention materialization on PUT, lifecycle expiry, scanner sweeps, and all-versions expiry. - -## Review Prompts - -Use these prompts while reviewing a diff: - -- Could a low-privileged authenticated user reach this path with the wrong action, parent, bucket, or source object? -- Does a non-HTTP protocol path call the same authorization boundary as the S3 API before touching storage? -- Does a public/default/empty config change security behavior from fail-closed to fail-open? -- Is any attacker-controlled value later used as a path, policy condition, credential identity, log field, URL, Origin, or response body? -- Does this response contain stored replication, remote target, or service credentials that need redaction or stricter authorization? -- Does any error constructor or `format!` interpolate a variable that can hold secret material, including a config parse error that echoes the raw input? -- Does an IAM export/import path expose or trust plaintext credential secrets beyond the caller's intended authority? -- Can this STS/OIDC path issue credentials without SigV4, trusted issuer validation, allowlisted redirects, or trusted-proxy host/scheme handling? -- Can a service-account or STS token omit `exp`, forge `sessionPolicy`, or use a principal-controlled key as signing authority? -- Does this outbound validation path resolve attacker-supplied hostnames and reject private, loopback, link-local, and rebound addresses at the actual connection boundary? -- Is an archive entry, object key, or policy resource normalized differently between authorization and storage? -- Is the same operation implemented in multiple paths, such as `CopyObject` vs `UploadPartCopy`, and do all paths enforce the same security contract? -- Does an explicit object version, fallback action, or plugin authorization path pass through the same action and post-authorization gates as the direct S3 path? -- Can a caller-controlled header populate a condition key that should be derived only by the server? -- Do condition tests include partially overlapping multi-value inputs for quantified operators? -- Does unreadable bucket metadata make Object Lock or retention enforcement fail closed rather than disappear? -- Does a preview or browser-surface fix preserve the original security invariant when adding alternate viewers or file-type detection? -- Does the test prove the exploit form is denied, or only that the intended form still works? +Each finding includes severity, `file:line`, attacker prerequisites, concrete +input/path, impact, smallest safe fix, and a regression check. Do not exaggerate +unauthenticated impact when the actual issue requires authenticated low privilege. diff --git a/.agents/skills/security-advisory-lessons/agents/openai.yaml b/.agents/skills/security-advisory-lessons/agents/openai.yaml index 8bfb41d7a..a90ec68ac 100644 --- a/.agents/skills/security-advisory-lessons/agents/openai.yaml +++ b/.agents/skills/security-advisory-lessons/agents/openai.yaml @@ -1,4 +1,4 @@ interface: display_name: "Security Advisory Lessons" short_description: "Apply advisory lessons in reviews." - default_prompt: "Review code changes against past RustFS security advisory lessons and report concrete risks, missing tests, and recommended fixes." + default_prompt: "Use $security-advisory-lessons for a dedicated RustFS security review grounded in past advisories." diff --git a/AGENTS.md b/AGENTS.md index 2004c597d..2d9535399 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,402 +1,255 @@ -# RustFS Agent Instructions (Global) +# RustFS Agent Instructions -This root file keeps repository-wide rules only. -Use the nearest subdirectory `AGENTS.md` for path-specific guidance. +This file contains repository-wide rules. Use the nearest subdirectory +`AGENTS.md` for path-specific invariants. -## Rule Precedence +## Precedence 1. System/developer instructions. -2. Current user/task instructions. -3. The nearest `AGENTS.md` in the current path. -4. This file (global defaults). +2. The current user request. +3. The nearest `AGENTS.md`. +4. This file. -If repo-level instructions conflict, follow the nearest file and keep behavior aligned with CI. +## Operating Model -## Execution Discipline - -- Read the relevant existing code, tests, and local guidance before changing behavior. For new helpers or test setup, that read includes `crates/utils`, `crates/common`, and the touched crate's own `test_util`/fixtures (see Reuse Before You Write). -- State assumptions when they affect the implementation or verification path. -- If a task has multiple plausible interpretations, list the options briefly and choose the narrowest reasonable path; ask when the ambiguity would make the change risky. -- For multi-step work, keep the plan minimal and tied to verifiable outcomes. -- Avoid redundant file reads, repeated commands, and unnecessary exploratory work once enough context is available. -- A good result is a minimal diff with clear assumptions, no over-engineering, and independent verification that survives Adversarial Validation (below). +- Inquiry, diagnosis, review, and planning tasks are read-only unless the user + explicitly requests changes. +- For implementation, read the relevant code, tests, and local guidance, then + make the smallest change that satisfies the request. +- State assumptions only when they affect behavior or verification. Ask only + when a wrong assumption would materially change the result. +- Do not load every skill or inspect unrelated modules preemptively. Select a + skill only when its description directly matches the request or changed + surface. +- Avoid repeated reads and equivalent verification commands once enough + evidence exists. ## Worktree and Disk Hygiene -- Unless the requester explicitly says otherwise, treat every new implementation task as isolated work: fetch the latest `origin/main`, confirm the requested change is not already present there, and create a dedicated feature branch and worktree from that exact upstream commit before editing. Do not implement new work directly in the primary checkout or reuse a worktree from another task. -- Check available disk space before creating the worktree or starting dependency downloads, builds, tests, coverage, or other artifact-heavy commands. For long-running or artifact-heavy work, re-check disk usage at natural phase boundaries and before broad validation; if remaining space may not safely accommodate the next command, stop and reclaim task-owned artifacts before continuing. -- Keep cleanup scoped and safe: remove generated build/test/coverage artifacts and temporary files created by the task when they are no longer needed, and never delete another task's worktree or uncommitted files. Prefer shared dependency caches where supported instead of duplicating large artifacts across worktrees. -- At handoff, report the disk-space checks, cleanup performed, and any retained worktree or artifacts with the reason they are still needed. +- Start implementation from the latest `origin/main` and confirm the requested + change is not already present. +- An existing clean, isolated task worktree is sufficient. Create another + worktree only when the current checkout is shared, dirty with unrelated work, + or belongs to another task. +- Never commit from a shared checkout. Use an `overtrue/` feature branch unless + the user requests another name. +- Check free space before artifact-heavy builds, tests, coverage, or downloads. + Re-check before a broad gate when space is tight. +- Remove only task-owned temporary/build artifacts. Never delete another task's + worktree or uncommitted data. +- At handoff, mention disk or cleanup details only when they affected execution + or artifacts/worktrees remain intentionally. -## PR Lifecycle Monitoring +## Change Style -- Creating or updating a PR is not the terminal state. Unless the requester explicitly limits the task to PR creation, monitor the PR through its terminal state: merged, closed, or explicitly handed off because progress requires user or maintainer action. -- While the task is active, monitor CI/check runs, review decisions and unresolved threads, mergeability and conflicts, and unexpected head/base changes. Prefer event-driven or bounded waits provided by the current environment over frequent polling; report only state changes, actionable failures, or meaningful prolonged delays. -- Investigate every failing check and review comment before changing code. Fix failures attributable to the task, run the verification required for the new diff, push the update, respond to or resolve the corresponding review threads, and resume monitoring. Do not weaken checks, dismiss valid feedback, or retry flaky failures merely to obtain a green result. -- Treat opening, green CI, approval, and mergeability as intermediate states. Never merge without the required reviewer approval or explicit authority. If progress depends on credentials, infrastructure, a maintainer decision, or another external action, report the exact blocker and the evidence already collected. -- If the current execution environment cannot remain active until the next PR event, use a supported automation, monitor, or thread wakeup when available and within scope. Otherwise leave an explicit handoff containing the PR, current state, next event to observe, and pending cleanup; do not imply that background monitoring exists when none is scheduled. -- After observing a merge, verify the commits are preserved on the upstream base, ensure the worktree is clean, remove the dedicated worktree, prune stale worktree metadata, and delete the local task branch when it is no longer in use. For a closed or abandoned PR, preserve any unmerged work unless deletion was explicitly authorized. Do not delete remote branches unless explicitly requested or repository automation owns that cleanup. +- Preserve existing control flow unless changing it is required for correctness. +- Prefer a direct local edit over new files, wrappers, managers, or speculative + abstractions. +- Add a helper only when it removes current duplication, names a real domain + boundary, or isolates a non-trivial invariant. +- Remove an in-scope path superseded by the change. If compatibility requires it, + adapt at the boundary to one canonical core and use the repository's + `RUSTFS_COMPAT_TODO` policy. +- Comments explain non-obvious invariants or reasons. Do not narrate code or + record change history. +- Mention unrelated problems when useful; do not fix them in a narrow task. -## Autonomy and Approval Boundaries +## Reuse and Boundary Rules -- Inquiry tasks (answer, explain, review, diagnose, plan): report findings; do not change files unless a fix is explicitly requested. -- Action tasks (change, build, fix): make in-scope local changes without asking for approval. -- Ask for confirmation before destructive or hard-to-reverse operations (force-pushes, history rewrites, deleting data or branches), merging a PR (reviewer approval required), or any material expansion of the requested scope. - -## Communication and Language - -- Respond in the same language used by the requester. -- Keep source code, comments, commit messages, and PR title/body in English. -- Be concise. Avoid sycophantic openers, closing fluff, and verbose status reporting. - -## Change Style for Existing Logic - -- Start with the smallest direct, local edit. Add production files, types, traits, helpers, wrappers, or abstraction layers only when current behavior requires them. Extraction must remove present duplication, enforce a real boundary, or materially clarify a non-trivial flow; anticipated reuse is not enough. -- Use Rust's default module file layout (`mod foo;` with `foo.rs` or `foo/mod.rs`/`foo/*.rs`). - Avoid `#[path = "..."]` for module inclusion; move files into the canonical module tree instead. - If an unavoidable generated-code, FFI, or test-fixture exception remains, keep it local and document why the canonical layout cannot work. -- Solve only the requested problem; do not add speculative features, configurability, or adjacent improvements. -- Prefer editing existing code over rewriting files or reshaping unrelated logic. -- Modify only what is required. Remove any in-scope path or representation superseded by the change. If compatibility or rollback requires retention, adapt at the boundary to one canonical core and follow the repository's `RUSTFS_COMPAT_TODO` removal policy; never delete unrelated code merely to improve addition/deletion statistics. -- Preserve the existing control-flow and logic shape when fixing bugs or addressing review comments, especially in init, distributed coordination, locking, metadata, and concurrency paths. -- Do not refactor existing code only to make it easier to unit test. -- Keep fixes narrowly aligned with the requested behavior; avoid semantic-adjacent rewrites while touching sensitive paths. -- Keep code elegant, concise, and direct. Prefer the smallest readable design and existing abstractions over parallel managers, factories, adapters, or wrappers added only to make the design look extensible. -- Comments state non-obvious reasons, assumptions, and invariants in the shortest complete form. Their length follows the invariant's complexity: `SAFETY`, lock ordering, durability, and compatibility contracts may need a short list of conditions. Never narrate the next line, restate a signature, or record change history; move durable design rationale to architecture or operations documentation. -- Mention unrelated issues when useful, but do not fix them as part of a narrow task. - -## Reuse Before You Write - -Search for an existing implementation before writing a new one; extend what exists instead of duplicating it: - -- **Helpers and utilities** (path/string handling, hashing, retry, env parsing, IO wrappers): check `crates/utils`, `crates/common`, the touched crate, the likely domain-owning crate, and relevant direct workspace dependencies from `Cargo.toml`. Search snake_case signatures with a focused term. Reimplementing an existing workspace helper — or hand-rolling what `std`, `tokio`, or an existing dependency already provides — is a review finding, not a style preference. -- **Reuse requires matching semantics, not a matching name**: before adopting a helper, check its normalization (`clean` resolves `.`/`..` — never apply it to raw S3 object keys), error type, backoff/deadline behavior, and durability gating against the call site. When semantics differ, a new narrowly-named helper with a comment naming the rejected lookalike is the correct outcome. The inverse also holds: workspace wrappers exist because raw `std`/`tokio` semantics were insufficient (durability gates, retries) — prefer the wrapper over the raw call. -- **Constants and fixed tokens** (protocol labels, error identifiers, header keys, event names, metric names, command tags): search for existing constants/enums that already represent the same semantic value and reuse them. If a value is truly new, define one local constant near related logic; never scatter the literal across sites. When changing existing behavior, align naming and format with the established constants. -- **Test scaffolding**: reuse existing test utilities and fixtures (the touched crate's own `test_util` module and `tests/fixtures`, or `crates/test-utils`) instead of writing new setup code — run `rg -l '' /src /tests` before writing a test. A new test must pin a failure mode no existing test covers. Near-duplicate means same code path AND same poison-value class: this repo's boundary companions (n==max vs max+1, absent vs empty vs nil UUID bytes, MetaObject vs MetaDeleteMarker) are distinct by definition and must all be written. - -## Necessary Code Only - -Net-new code — files, types, branches, comments — is cost to justify, not progress: - -- Inspect production-code additions separately. Tests, fixtures, generated code, and documentation do not count as production-code growth. Line counts are signals, not quotas: new production structures must map to a current requirement, and a blocker requires a concrete smaller design that preserves correctness, compatibility, readability, and real boundaries. -- Validate at the trust boundary — untrusted client input, bytes read from disk, RPC payloads, config (see Serde Safety and Cross-Cutting Domain Invariants) — then trust the type: do not re-check what the type system or a validated upstream layer already guarantees, and cite the establishing check (`file:line`) when the guarantee is not obvious. -- The exception is load-bearing: a value that crossed a persistence, RPC, or version boundary is never guaranteed by the code on the other side — a peer may be older or buggy, disk bytes may be corrupt — so the Cross-Cutting Domain Invariant patterns apply at every consumer, and re-checks immediately before a destructive action (delete, overwrite, quorum decision) stay. Deleting an existing guard is a behavior change requiring adversarial review, not cleanup. -- Every new branch needs a nameable trigger: a concrete input, state, or failure that reaches it — for boundary-crossing values, corrupt or stale persisted/peer data is always nameable. If you cannot name one, do not write the branch. If the case is truly unreachable, encode the invariant in the type; where that is impossible, return a typed internal error (fail closed). `debug_assert!` is acceptable only for pure internal arithmetic on values that never crossed a disk/RPC/config boundary — never as the sole guard on decoded or peer-supplied data. -- Never substitute a default where the value is required (e.g. `unwrap_or_default()` on metadata that must exist) — that converts corruption into a wrong answer. Return the typed error instead: explicit failure over implicit success. -- Attach error context once, at the layer where it is actionable: re-wrapping equivalent context at every hop is noise, and expanding a fallible chain into nested `match` blocks where `?` or a combinator suffices is a finding. Never add context by converting a typed error into a generic variant below an error-aggregation or quorum layer (`reduce_errs` classifies by variant equality) — context there belongs in a `tracing` event, not the error value. +- Before adding helpers, constants, fixtures, or wrappers, search the touched + crate, the domain-owning crate, `crates/utils`, `crates/common`, and relevant + direct dependencies. +- Reuse requires matching semantics: normalization, error types, deadlines, + durability, and compatibility must fit the call site. A narrowly named local + helper is better than forced reuse with different semantics. +- Validate untrusted input at its trust boundary, then trust the validated type. + Values crossing disk, RPC, persistence, or version boundaries remain + untrusted at every consumer. +- Re-check boundary values immediately before destructive actions such as + delete, overwrite, or quorum decisions. +- Every new branch needs a concrete triggering input/state. For decoded or peer + data, corruption and mixed-version input are valid triggers. +- Required values must return a typed error when absent or corrupt; do not use a + default that converts corruption into a plausible result. +- Attach error context once where it is actionable. Do not erase typed errors + below aggregation or quorum layers. ## Sources of Truth -- Workspace layout and crate membership: `Cargo.toml` (`[workspace].members`) -- Local quality commands: `Makefile` and `.config/make/` -- CI quality gates: `.github/workflows/ci.yml` -- PR template: `.github/pull_request_template.md` -- High-level architecture and crate map: `ARCHITECTURE.md` -- Migration guardrails, readiness contracts, support matrices: - `docs/architecture/README.md` (routes by audience) -- Shared agent skills (all tools): `.agents/skills/` — each `SKILL.md` carries - a frontmatter `description` stating when it applies. Scan the descriptions - before starting a task and follow any skill that matches, even if your tool - does not auto-load skills: - `grep -m1 '^description:' .agents/skills/*/SKILL.md` - Claude Code reads them through the `.claude/skills` symlink; add new skills - to `.agents/skills/` only, never as separate copies per tool +- Workspace membership: `Cargo.toml`. +- Local gates: `Makefile` and `.config/make/`. +- CI gates: `.github/workflows/ci.yml`. +- PR format: `.github/pull_request_template.md`. +- Architecture routing: `ARCHITECTURE.md` and `docs/architecture/README.md`. +- Agent skills: `.agents/skills/*/SKILL.md`. -Avoid duplicating long crate lists or command matrices in instruction files. -Reference the source files above instead. +Do not commit one-shot plans, trackers, migration ledgers, benchmark snapshots, +or agent scratch notes. Durable architecture belongs under `docs/architecture/`, +operations under `docs/operations/`, and testing references under +`docs/testing/`. `scripts/check_no_planning_docs.sh` enforces this boundary. -Do not commit planning-type documents — one-shot implementation/optimization -plans, task trackers, migration-progress ledgers, phase/PR templates, -issue-scoped benchmark-result snapshots or optimization conclusions, or -agent-generated working notes (e.g. anything a `superpowers`/scratch workflow -produces). Keep that work in the issue tracker or your local worktree, not in -the repository. Only durable reference — the architecture set under -`docs/architecture/`, repeatable operational runbooks under `docs/operations/`, -and the test-suite references under `docs/testing/` — belongs in version -control; `.gitignore` ignores everything else under `docs/` by default, so a new -plan file will not be tracked unless someone force-adds it — don't. -`scripts/check_no_planning_docs.sh` (wired into `make pre-commit`/`pre-pr` and -CI) fails the build if anything is committed under `docs/superpowers/`, even via -`git add -f`. +## Verification -## Verification Before PR +Select checks from the final task-owned diff. Scoped `AGENTS.md` files may add a +concrete path-specific check, but must not replace this tiering with a generic +full-workspace gate. -Convert changes into independently verifiable outcomes. This section controls -agent-run local validation; preparing a commit or PR does not by itself require -the broadest gate. Inspect only the final task-owned diff, classify it by -behavioral impact rather than line count or path alone, and run the smallest -set of checks that provides meaningful coverage. Do not let unrelated -worktree changes or a generic contributor checklist expand the scope. -For non-exempt changes, complete the applicable multi-role adversarial review -before running `make pre-pr` (or an equivalent full gate). Resolve or rebut -every finding first, then run the gate against the reviewed final diff. +### Documentation and Instructions -### Validation floor +For prose, comments, agent instructions, and skill metadata that cannot affect +runtime/build output: -- Every change that is not documentation-only must finish with - `cargo fmt --all --check` passing. An umbrella gate that runs this exact - check satisfies the requirement; do not run it twice. Use `cargo fmt --all` - only when formatting needs to be fixed. Run the configured formatter or - validator for other changed languages when one exists. -- Documentation-only or instruction-only means all task-owned changes are - prose or documentation assets and cannot affect runtime, builds, CI, - dependencies, generated code, or tests. Run `git diff --check` and any - relevant documentation guard, but skip Cargo formatting, compilation, - Clippy, tests, `make pre-commit`, and `make pre-pr`. -- Behavior changes require relevant existing or new tests. Prefer the most - focused test or affected package. A passing targeted test can also provide - sufficient compilation coverage when it builds every changed target and - feature involved; do not add a redundant `cargo check` in that case. -- `cargo check` supplements compilation coverage; it never substitutes for a - behavioral test. If a relevant test cannot reasonably be added or run, use - the narrowest compilation check and report the reason and remaining risk. +- Run `git diff --check`. +- Run the relevant documentation guard or skill validator when applicable. +- Skip Cargo formatting, compilation, Clippy, tests, `make pre-commit`, and + `make pre-pr`. -### Validation tiers +### Non-Behavioral Source Changes -1. **Documentation/instruction-only:** Apply the exemption above. Run a guard - such as `make doc-paths-check` only when it is relevant to the edited text. -2. **Non-behavioral source change:** For comments, formatting, or another - demonstrably non-executable change, run the formatting floor. Compilation, - Clippy, and tests may be skipped only when the edit cannot affect - compilation or runtime behavior; run targeted doctests if executable - documentation examples changed. -3. **Localized or bounded behavior change:** Run the formatting floor and the - narrowest relevant tests. Add package-scoped `cargo check` or Clippy only - for changed targets, features, APIs, error handling, async behavior, or - control flow not already covered. When several crates are affected but the - dependency set is identifiable, validate those packages and known - dependents instead of the whole workspace. Use `make pre-commit` only when - a repository-wide fast gate adds useful confidence beyond those checks. -4. **Broad or high-risk change:** After the applicable adversarial review has - completed, run `make pre-pr` only when targeted coverage cannot bound the - impact, including: - - dependency, feature, build-script, procedural-macro, code-generation, - toolchain, or CI changes that alter compilation or the test matrix; - - cross-crate public APIs, shared foundational code, or broad refactors with - an unbounded dependent set; - - locking, storage durability or formats, erasure coding, replication, - RPC/protocol compatibility, IAM/KMS/auth, cryptography, or other - security-sensitive behavior; - - a targeted check that reveals wider impact, an explicit user request, or - a release policy that requires the full gate. +- Run the formatter/validator for the changed language. +- Add compilation or doctests only when syntax or executable examples changed. -Documentation-only and non-behavioral classifications take precedence over -path-based triggers. A small diff can still be high-risk, while a CI comment, -manifest comment, or release-note edit does not require full validation. +### Localized Behavior Changes -`make pre-pr` includes `make pre-commit` coverage. Never run both for the same -unchanged diff, and do not repeat equivalent checks during PR preparation or -because a local hook already ran them. Rerun only checks whose scope is affected -by later edits. Full workspace checks do not replace a relevant integration or -E2E test for changed behavior; run that focused test when required and -available, or report why it was not run and the remaining risk. +- Run `cargo fmt --all --check` for Rust changes. +- Run the narrowest test that exercises the changed behavior. +- Add package-scoped `cargo check` or Clippy only for targets, features, public + APIs, error handling, or control flow not compiled by the focused test. +- Use `make pre-commit` only when its repository-wide fast checks add confidence + beyond the focused checks. -If `make` is unavailable, run the equivalent checks defined under -`.config/make/`. At handoff, list the checks actually run, checks intentionally -skipped, and the reason for the selected tier. +### Broad or High-Risk Changes -After build-based verification completes, clean generated build artifacts before wrapping up to avoid unnecessary disk usage. -Do not open a PR with code changes when the required checks fail. -Make a failing check pass by fixing the cause, never by weakening the gate: -do not loosen or skip a guard script, add entries to a baseline or allowance -list, suppress a lint with `#[allow]`, mark a failing test `#[ignore]`, or -delete or relax a failing assertion to get green. If a check itself is wrong, -change it deliberately and state the rationale in the PR. +After the required adversarial review, run `make pre-pr` when targeted coverage +cannot bound the impact, including dependency/toolchain/build-matrix changes, +unbounded cross-crate APIs, or locking, durability, erasure coding, replication, +RPC, IAM/KMS/auth, cryptography, on-disk/on-wire, and S3-visible behavior. -For flaky tests, do not paper over them with retries. Follow the flake policy -in [docs/testing/README.md](docs/testing/README.md) (open an issue within 24h, -quarantine with an issue link, fix or delete within 30 days); the local -`default` nextest profile never retries. +`make pre-pr` includes `make pre-commit`; never run both for the same unchanged +diff. Do not repeat a check already covered by a successful umbrella gate. +Rerun only checks affected by later edits. -## Adversarial Validation (Default On) +Never weaken a gate to get green: do not add baselines/allowances, suppress +lints, ignore tests, or relax assertions unless changing that policy is itself +the reviewed task. Follow `docs/testing/README.md` for flaky tests. -Every non-exempt output (see Risk tiers) — code change, bug fix, or -design/solution proposal — passes multi-role adversarial review before it -counts as done. -Author confidence is not evidence: each role's job is to refute the change, -not to bless it. +## Adversarial Validation -### Risk tiers +Adversarial validation applies to final implementation diffs, explicitly +requested adversarial/design reviews, and agent-instruction changes that alter +execution. Ordinary questions, diagnoses, status reports, non-adversarial code +reviews, and low-risk planning do not trigger it. -Pick the tier from the riskiest file touched; when in doubt, pick the higher. +Risk and review shape: -- **Exempt:** docs/comments, formatting, and typos that cannot affect runtime, - builds, tests, or agent execution. Skip this section. -- **Mechanical:** pure renames, file moves, test-only or tooling changes, and - agent-instruction changes that alter execution — - correctness and simplicity adversaries only. -- **Standard (the default):** any change that affects behavior. -- **High risk:** touches locking, erasure coding, quorum/heal, replication, - multipart, RPC, lifecycle/tiering, metadata formats (`xl.meta`), - persistence/fsync, IAM/KMS/auth, on-disk or on-wire formats, or - S3 API-visible behavior. +- **Exempt:** documentation, comments, formatting, or typos with no runtime, + build, test, or agent-execution effect. +- **Mechanical:** renames, moves, test/tooling-only changes, and agent-rule + changes. Run correctness and simplicity lenses. +- **Standard:** localized behavior changes. Run one integrated final-diff pass + covering correctness, simplicity, and test coverage; add only domain lenses + matched by the diff. +- **High risk / substantial PR review:** high risk includes locking, + erasure/quorum/heal, replication, multipart, RPC, lifecycle/tiering, + persistence/fsync, IAM/KMS/auth, cryptography, on-disk/on-wire formats, and + S3-visible semantics. Cover all applicable lenses using exactly two + independent reviewers when delegation is explicitly authorized. Split the + lenses between them. Otherwise perform two fresh sequential passes. -### Roles +Available domain lenses are security, concurrency/durability, compatibility, +and performance. Select `.agents/skills/adversarial-validation/SKILL.md` for an +explicit adversarial request, a high-risk change, or a substantial PR review; +then read only its matching role references. A routine standard pass does not +load the playbook unless the reviewer needs a RustFS-specific probe. -Run each applicable role as an independent pass over the final diff (or -proposal text) — parallel reviewer agents where the tooling supports them, -otherwise sequential passes that each start fresh from the diff and the -nearest scoped `AGENTS.md`, discarding the writing session's assumptions. -Each role either produces findings or reports "attacked X, Y, Z — no break -found"; a bare pass is not a result. Repo-specific attack probes for every -role live in `.agents/skills/adversarial-validation/` — run them, they -encode this repo's shipped bugs. +A finding must name a concrete input/state/interleaving and wrong outcome, or a +specific missing regression check, with `file:line`. Resolve it by fixing the +diff or rebutting it with code-path/test/invariant evidence. After a non-trivial +fix, rerun only affected lenses. -- **Correctness adversary** — construct a concrete input/state/interleaving - that yields wrong output, data loss, or a crash. Probe error paths and edge - values (empty, nil UUID, zero-length, quorum−1, missing version). -- **Simplicity adversary** — same behavior, less code. Hunt reimplemented helpers, rewrites where an in-place edit suffices, speculative abstractions, defensive branches with no nameable trigger, redundant error wrapping, near-duplicate tests, and narration comments. A one-caller helper is a finding only when it merely forwards or splits a short linear flow without adding domain naming, boundary isolation, an invariant, or useful error context. Report a concrete smaller replacement; fewer lines alone are not evidence. -- **Security reviewer** — authn/authz bypass, injection, secret leakage, - untrusted deserialization (see Serde Safety), path traversal, timing leaks. -- **Concurrency/durability reviewer** — lock ordering, races, cancellation, - partial failure, retry/idempotency, crash and power-loss ordering. -- **Compatibility reviewer** — S3 API surface, MinIO interop, on-disk and - on-wire formats, mixed-version upgrade/downgrade paths. -- **Performance reviewer** — allocation and cloning on hot paths, lock hold - time across IO, sync or CPU-heavy work on async runtime threads, added - fsync/flush outside the durability gate, hot-path logging noise. A - measurable regression on a per-request or per-object path is a finding. -- **Test-coverage skeptic** — for each testable behavior claim, name the test - or executable check that detects a revert; then name a changed line that - could be wrong while all checks stay green. If a focused check is not - reasonable, require the reason and residual risk from the validation floor. - Test additions have no line-count or growth budget. +For high-risk PRs, record one concise verdict per covered lens in the PR body. -Standard tier: correctness adversary + simplicity adversary + test-coverage -skeptic, plus every role whose domain the diff touches (async or -shared-state code → concurrency; parsing of untrusted input → security; -public crate API shape → compatibility; per-request or per-object hot paths -→ performance). -High risk: all seven roles. +## Pull Request Lifecycle -### Protocol - -1. A finding states a concrete failure scenario (input/state → wrong - outcome) or names a missing test, with severity and file:line. "Looks - risky" is not a finding. -2. Resolve every finding: fix it, or rebut it with evidence — a test, a - traced code path, or a cited invariant. Restated intent and "unlikely" - are not rebuttals. -3. After non-trivial fixes, re-run the roles whose domain the fix touched. -4. For proposals with no diff, roles attack assumptions, failure modes, - migration/rollback, and testability instead — including the simplest - rejected alternative and the blast radius when the design fails. - -### Exit criteria - -- Every applicable role has run; every finding is fixed or rebutted with - evidence. -- Every testable behavior change has a focused regression check. Exceptions - follow the validation floor and state why a check is impractical and what - risk remains. -- After the applicable adversarial review has completed, the Verification - Before PR gates pass; adversarial review supplements those gates, never - replaces them. -- High risk only: record a one-line verdict per role in the PR description. +- Creating or updating a PR includes one immediate snapshot of checks, + mergeability, reviews, and unresolved threads. +- Unless the user explicitly requests monitoring, a release workflow requires + it, or an automation already owns it, hand off after the PR is open with the + current state and next event to watch. Do not delay ordinary handoff with + fixed quiet-period sleeps. +- For requested monitoring, use event-driven or bounded waits. Report only state + changes, actionable failures, or a meaningful prolonged delay. +- Investigate failures/comments before changing code. Fix task-attributable + issues, rerun affected verification, push, reply or resolve the thread, then + resume the requested monitor. +- Never merge without required reviewer approval or explicit authority. +- After an observed merge, verify the commit reached the base, then clean the + task worktree/branch when safe. Preserve unmerged work for closed PRs unless + deletion was explicitly authorized. ## Git and PR Baseline -- Use feature branches based on the latest `main`. -- Assume other agent sessions work this repository concurrently. Never commit - in a shared checkout; do all work on a dedicated feature branch, preferably - in a dedicated worktree. -- Immediately before branching, fetch `origin/main` and branch from it; - confirm the target issue is not already fixed there before writing code. -- Follow Conventional Commits, with subject length <= 72 characters. -- Keep PR title and description in English. -- Use `.github/pull_request_template.md` and keep all section headings. -- Use `N/A` for non-applicable template sections. -- Include verification commands in the PR description. -- When using `gh pr create`/`gh pr edit`, write the markdown body to a file - and pass `--body-file`; multiline inline `--body` is unsafe — backticks and - shell expansion can corrupt content or trigger unintended commands. - Pattern: `cat > /tmp/pr_body.md <<'EOF' ... EOF`, then - `--body-file /tmp/pr_body.md` (keep the file outside the checkout). -- Do not include the literal sequence `\n` in any GitHub issue, pull request, or discussion comment. -- Do not hard-wrap prose in PR/issue/discussion bodies; write each paragraph as a - single line and let it reflow. GitHub renders single newlines inside a paragraph - as line breaks, so mid-sentence wrapping shows up as ugly breaks. Only break lines - for list items, code blocks, and deliberate separators. -- After fixing code review comments or CI findings, always mark corresponding review - comments/threads as resolved before returning to the user. -- In handling review comments, confirm the underlying issue before changing code. - If a suggested change is not appropriate for behavior or risk, reply with a - concise rationale instead of blindly applying it. +- Follow Conventional Commits; keep the subject at most 72 characters. +- Source comments, commits, PR titles, and PR bodies are in English. +- Keep every heading from `.github/pull_request_template.md`; use `N/A` where + needed and include commands actually run. +- Use `--body-file` for multiline `gh pr create`/`gh pr edit` content. +- PR/issue/discussion content must not contain the literal sequence `\n` or + hard-wrapped prose paragraphs. +- Do not include local absolute paths or tool-specific labels/prefixes in GitHub + content. +- Resolve review threads after the underlying issue is fixed. If declining a + suggestion, reply with a short evidence-based reason. ## Security Baseline - Never commit secrets, credentials, or key material. - Use environment variables or vault tooling for sensitive configuration. -- For localhost-sensitive tests, verify proxy settings to avoid traffic leakage. +- For localhost-sensitive tests, bypass proxies explicitly. +- Untrusted S3 XML/JSON, lifecycle, policy, replication, and RPC structures use + strict deserialization where compatibility permits. Security-critical + defaults require explicit validation. ## Logging -Applies to **every** `tracing` macro you add or edit, including a single line -added in passing while fixing something else — not only to log-focused changes. +For every added or edited `tracing` call: -- Fields first, message second: `event`, `component`, `subsystem`, - `result`/`state`, then key context. The message is a short label, not a - sentence with values interpolated into it. -- Reuse the existing `EVENT_*` / `LOG_COMPONENT_*` / `LOG_SUBSYSTEM_*` - constants of the module you are editing; match the shape of the log sites - already in that file rather than introducing a second style next to them. -- Level policy: `error` for behavior/security-affecting failures, `warn` for - degraded or fallback paths, `info` for low-frequency lifecycle, `debug` for - targeted diagnostics, `trace` for hot paths. Per-object and per-request - success paths are `trace`. -- Never log secrets, tokens, credential payloads, or merged config dumps. -- `scripts/check_logging_guardrails.sh` enforces a subset of this on the files - it lists; passing it is a floor, not evidence the log matches the house style. +- Reuse the module's `EVENT_*`, `LOG_COMPONENT_*`, and `LOG_SUBSYSTEM_*` + constants and field shape. +- Put fields first and a short label last. +- Use `error` for behavior/security failure, `warn` for degradation/fallback, + `info` for low-frequency lifecycle, `debug` for diagnostics, and `trace` for + repetitive request/object success paths. +- Never log secrets, credential payloads, or merged configs. -See `.agents/skills/rustfs-logging-governance/SKILL.md` for the full event -model, level policy, and guardrail-update checklist. +Use `.agents/skills/rustfs-logging-governance/SKILL.md` for logging changes. -## Tools +## Cross-Cutting Storage Invariants -### xl.meta decode tool Quick Use +- Write internal object metadata under both `x-rustfs-internal-` and + `x-minio-internal-` using + `crates/utils/src/http/metadata_compat.rs` helpers. +- Read binary UUID metadata with + `.and_then(|v| Uuid::from_slice(&v).ok()).filter(|u| !u.is_nil())`; absent, + empty, and nil all mean no value. +- Remote-tier version `None` or `""` means an unversioned bucket; send no + `versionId` on tier GET/DELETE. +- `DataUsageCacheInfo` and `DataUsageEntry` keep their hand-written map + serialization and new fields remain `#[serde(default)]` for older readers. -``` -cargo run -p rustfs-filemeta --example dump_fileinfo -- "/path/to/file/xl.meta" -``` +## Naming -## Serde Safety +Use Rust API naming: `SCREAMING_SNAKE_CASE` constants/statics, `snake_case` +functions/variables, and `PascalCase` types. Do not rename unrelated existing +violations. -- Add `#[serde(deny_unknown_fields)]` to structs deserialized from untrusted input (S3 API XML/JSON, lifecycle rules, bucket policies, replication configs). -- When `deny_unknown_fields` is impractical (backward compatibility), at minimum log unknown fields at `warn` level. -- Never use `#[serde(default)]` on security-critical fields without explicit validation of the resulting value. +## Scoped Guidance -## Cross-Cutting Domain Invariants - -- Write internal object metadata under **both** `x-rustfs-internal-` - and `x-minio-internal-` keys (MinIO interop). Use the helpers in - `crates/utils/src/http/metadata_compat.rs` (`get_bytes` prefers the RustFS - key); never write only one of the two. -- Read binary UUID metadata defensively: - `.and_then(|v| Uuid::from_slice(&v).ok()).filter(|u| !u.is_nil())` — - absent, empty, and nil all mean "no value", never `Uuid::nil()`. -- A remote-tier version of `None`/`""` means the tier bucket is unversioned: - send **no** `versionId` on tier GET/DELETE. -- Structs persisted in the scanner data-usage cache (`DataUsageCacheInfo`, - `DataUsageEntry`) carry a hand-written map-encoded `Serialize`. MessagePack - encodes derived structs as arrays, where an appended field makes the whole - cache a decode error for older readers — keep new fields `#[serde(default)]` - and keep the map encoding rather than reverting to `derive(Serialize)`. - -## Naming Conventions - -- Follow Rust API Guidelines for naming: `SCREAMING_SNAKE_CASE` for statics and constants, `snake_case` for functions and variables, `PascalCase` for types. -- Do not use camelCase or Hungarian notation (e.g., `globalDeploymentIDPtr` → `GLOBAL_DEPLOYMENT_ID`). -- If existing code violates naming conventions, do not widen the violation in new code. Do not rename existing symbols as part of an unrelated task; mention the violation instead (see Change Style for Existing Logic). - -## Scoped Guidance in This Repository - -Many crates and modules carry their own `AGENTS.md` with path-specific rules -(security boundaries, lock ordering, domain invariants). Before editing a -path, check for the nearest one: +Before editing, locate the nearest instructions with: ```bash git ls-files '*AGENTS.md' ``` -The nearest file wins. Do not maintain a hand-written index of these files -here — it goes stale. +The nearest file wins for domain invariants. Keep generic workflow and +validation policy in this root file. diff --git a/crates/AGENTS.md b/crates/AGENTS.md index 3417bab26..65b97334c 100644 --- a/crates/AGENTS.md +++ b/crates/AGENTS.md @@ -19,7 +19,9 @@ Applies to all paths under `crates/`. - Document lock acquisition order when a module uses multiple locks. Never acquire the same set of locks in different orders across code paths. - Never hold a `tokio::sync::RwLock`/`Mutex` write guard across `.await` points unless the critical section is unavoidably async and the hold time is bounded. -- Prefer `compare_exchange` loops over load-then-store for concurrent counters (peak values, adaptive heuristics). +- Prefer direct atomic `fetch_*` operations for unconditional updates and + `compare_exchange` loops only for conditional updates such as peaks or + adaptive state. - When resetting multi-field atomic statistics, use a version/sequence counter or accept that concurrent readers may see partial snapshots; document the tradeoff. - `std::sync::Mutex` is acceptable in async context only when held for a brief, non-`await`-containing critical section. If in doubt, use `tokio::sync::Mutex`. @@ -40,7 +42,9 @@ Applies to all paths under `crates/`. - Keep unit tests close to the module they test. - Keep integration tests under each crate's `tests/` directory. - Add regression tests for bug fixes and behavior changes. -- Every test function must contain at least one `assert!`/`assert_eq!`/`assert_matches!`. A test that only calls code without asserting is not a test. +- Every test needs an observable failure criterion. Direct assertions, + delegated assertions, snapshots/properties, `#[should_panic]`, and meaningful + `Result` failures are all valid; a call that can silently succeed is not. - In tests, prefer `.expect("context: what was being tested")` over bare `.unwrap()`. A test failure should tell you which operation failed and with what input. ## Async and Performance diff --git a/crates/audit/AGENTS.md b/crates/audit/AGENTS.md index 39870cd65..32a1f3c1c 100644 --- a/crates/audit/AGENTS.md +++ b/crates/audit/AGENTS.md @@ -50,4 +50,3 @@ crate. - `cargo test -p rustfs-audit` - Focused: `cargo test -p rustfs-audit --test pipeline_layer_test` - Focused: `cargo test -p rustfs-audit pipeline` -- Full gate before commit: `make pre-commit` diff --git a/crates/e2e_test/AGENTS.md b/crates/e2e_test/AGENTS.md index 032f40e63..439ae8bcc 100644 --- a/crates/e2e_test/AGENTS.md +++ b/crates/e2e_test/AGENTS.md @@ -28,4 +28,3 @@ follow. ## Suggested Validation - `cargo test --package e2e_test` -- Full gate before commit: `make pre-commit` diff --git a/crates/ecstore/AGENTS.md b/crates/ecstore/AGENTS.md index 10101f55e..a9c128522 100644 --- a/crates/ecstore/AGENTS.md +++ b/crates/ecstore/AGENTS.md @@ -49,4 +49,3 @@ Applies to `crates/ecstore/`. ## Suggested Validation - `cargo test -p rustfs-ecstore` -- Full gate before commit: `make pre-commit` diff --git a/crates/iam/AGENTS.md b/crates/iam/AGENTS.md index c9c8332fa..c8bce3778 100644 --- a/crates/iam/AGENTS.md +++ b/crates/iam/AGENTS.md @@ -24,4 +24,3 @@ Applies to `crates/iam/`. ## Suggested Validation - `cargo test -p rustfs-iam` -- Full gate before commit: `make pre-commit` diff --git a/crates/notify/AGENTS.md b/crates/notify/AGENTS.md index 04d996a90..9a142ac13 100644 --- a/crates/notify/AGENTS.md +++ b/crates/notify/AGENTS.md @@ -55,4 +55,3 @@ shared plugin/runtime primitives from `rustfs-targets`. - Focused: `cargo test -p rustfs-notify runtime_facade` - Focused: `cargo test -p rustfs-notify runtime_view` - Focused: `cargo test -p rustfs-notify config_manager` -- Full gate before commit: `make pre-commit` diff --git a/crates/policy/AGENTS.md b/crates/policy/AGENTS.md index 75abf24ea..ac3f86ebe 100644 --- a/crates/policy/AGENTS.md +++ b/crates/policy/AGENTS.md @@ -23,4 +23,3 @@ Applies to `crates/policy/`. ## Suggested Validation - `cargo test -p rustfs-policy` -- Full gate before commit: `make pre-commit` diff --git a/crates/targets/AGENTS.md b/crates/targets/AGENTS.md index 03d79992e..5935a7b65 100644 --- a/crates/targets/AGENTS.md +++ b/crates/targets/AGENTS.md @@ -75,4 +75,3 @@ run commands. - `cargo test -p rustfs-targets plugin` - `cargo test -p rustfs-targets runtime` - `cargo test -p rustfs-targets control_plane` -- Full gate before commit: `make pre-commit` diff --git a/rustfs/src/admin/AGENTS.md b/rustfs/src/admin/AGENTS.md index 4564baa2f..fc78c4ace 100644 --- a/rustfs/src/admin/AGENTS.md +++ b/rustfs/src/admin/AGENTS.md @@ -25,4 +25,3 @@ Applies to `rustfs/src/admin/`. ## Suggested Validation - Admin handler and routing tests under `rustfs/src/admin/` -- Full gate before commit: `make pre-commit` diff --git a/rustfs/src/storage/AGENTS.md b/rustfs/src/storage/AGENTS.md index 7817bad24..f9d115519 100644 --- a/rustfs/src/storage/AGENTS.md +++ b/rustfs/src/storage/AGENTS.md @@ -25,4 +25,3 @@ Applies to `rustfs/src/storage/`. ## Suggested Validation - Targeted module tests in `rustfs/src/storage/*_test.rs` -- Full gate before commit: `make pre-commit` From 5d820df79c0f10c017505a4928a5ebb4ab3728ff Mon Sep 17 00:00:00 2001 From: Zhengchao An Date: Sat, 22 Aug 2026 08:30:30 +0800 Subject: [PATCH 06/10] chore(obs): rename ReplicationStats to ReplicationMetricsSnapshot (#6344) * chore(obs): ReplicationStats -> ReplicationMetricsSnapshot, BucketReplicationStats -> BucketReplicationMetricsSnapshot Rename in-obs-crate ReplicationStats and BucketReplicationStats to ReplicationMetricsSnapshot and BucketReplicationMetricsSnapshot respectively. No serde impact (these types are Prometheus metric collectors, not serialized). No external consumers found outside the obs crate. * cleanup: remove #[serial] annotations from e2e_test, scanner, lifecycle, and object-capacity crates Remove no-op #[serial] attributes (nextest ignores serial_test) and the serial_test dependency from four crates. All tests already use temp_env for env-var isolation, making #[serial] purely redundant. Crates cleaned: - e2e_test (37 annotations, 9 imports, removed serial_test dep) - rustfs-scanner (115 annotations across 7 files, removed serial_test dep) - rustfs-lifecycle (46 annotations, removed serial_test dep) - rustfs-object-capacity (38 annotations, removed serial_test dep) Also converted scanner/tests/lifecycle_integration_test.rs with_forced_immediate_enqueue_timeout helper from unsafe raw env::set_var/remove_var to temp_env::async_with_vars for proper isolation, and added async_closure feature to scanner's temp-env dep. * fix(lifecycle): restore #[serial] on 2 tests that read env vars without temp_env eval_inner_expires_latest_object_after_days_due and eval_inner_does_not_panic_on_many_equal_due_events call eval_inner() which reads ENV_ILM_PROCESS_TIME via std::env::var(). Without #[serial] they race with other tests that set these vars via temp_env. * style: cargo fmt --- Cargo.lock | 3 - crates/e2e_test/Cargo.toml | 1 - .../src/degraded_read_eof_regression_test.rs | 4 -- .../get_stream_failure_observability_test.rs | 2 - .../src/inline_fast_path_cluster_test.rs | 15 ----- crates/e2e_test/src/kms/kms_vault_test.rs | 6 -- .../src/policy/policy_variables_test.rs | 7 --- crates/e2e_test/src/policy/test_runner.rs | 2 - crates/e2e_test/src/protocols/webdav_core.rs | 2 - .../src/reliability_disk_fault_test.rs | 5 -- .../src/replacement_privileged_e2e_test.rs | 3 - crates/lifecycle/Cargo.toml | 2 +- crates/lifecycle/src/core.rs | 45 --------------- crates/object-capacity/Cargo.toml | 1 - .../object-capacity/src/capacity_manager.rs | 34 ----------- crates/object-capacity/src/scan.rs | 5 -- .../metrics/collectors/bucket_replication.rs | 10 ++-- crates/obs/src/metrics/collectors/mod.rs | 4 +- .../obs/src/metrics/collectors/replication.rs | 12 ++-- crates/obs/src/metrics/scheduler.rs | 4 +- crates/obs/src/metrics/stats_collector.rs | 22 +++---- crates/scanner/Cargo.toml | 3 +- crates/scanner/src/lib.rs | 5 -- crates/scanner/src/runtime_config.rs | 14 ----- crates/scanner/src/scanner/tests.rs | 57 ------------------- crates/scanner/src/scanner_folder/tests.rs | 34 ----------- crates/scanner/src/scanner_io/tests.rs | 27 --------- crates/scanner/src/sleeper.rs | 5 -- .../tests/lifecycle_integration_test.rs | 47 ++------------- 29 files changed, 32 insertions(+), 349 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 2cb35c808..637202fd5 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -3843,7 +3843,6 @@ dependencies = [ "s3s", "serde", "serde_json", - "serial_test", "sha2 0.11.0", "suppaftp", "time", @@ -9921,7 +9920,6 @@ dependencies = [ "rustfs-config", "rustfs-io-metrics", "rustfs-utils", - "serial_test", "temp-env", "tempfile", "tokio", @@ -10294,7 +10292,6 @@ dependencies = [ "s3s", "serde", "serde_json", - "serial_test", "sha2 0.11.0", "temp-env", "tempfile", diff --git a/crates/e2e_test/Cargo.toml b/crates/e2e_test/Cargo.toml index b0bc6ed2a..302cd34d3 100644 --- a/crates/e2e_test/Cargo.toml +++ b/crates/e2e_test/Cargo.toml @@ -96,7 +96,6 @@ tokio-stream = { workspace = true } rustfs-madmin.workspace = true rustfs-filemeta.workspace = true bytes = { workspace = true, features = ["serde"] } -serial_test = { workspace = true } aws-sdk-s3 = { workspace = true, default-features = false, features = ["sigv4a", "default-https-client", "rt-tokio"] } aws-sdk-sts = { workspace = true, default-features = false, features = ["default-https-client", "rt-tokio"] } aws-config = { workspace = true } diff --git a/crates/e2e_test/src/degraded_read_eof_regression_test.rs b/crates/e2e_test/src/degraded_read_eof_regression_test.rs index f5c2ada49..9b3c66649 100644 --- a/crates/e2e_test/src/degraded_read_eof_regression_test.rs +++ b/crates/e2e_test/src/degraded_read_eof_regression_test.rs @@ -55,7 +55,6 @@ mod tests { use aws_sdk_s3::Client; use aws_sdk_s3::primitives::ByteStream; use aws_sdk_s3::types::{CompletedMultipartUpload, CompletedPart}; - use serial_test::serial; use sha2::{Digest, Sha256}; use std::error::Error; use tokio::time::{Duration, timeout}; @@ -269,7 +268,6 @@ mod tests { /// stripes) and a multipart object (3 parts × 5 MiB) must GET back as a /// full, byte-identical body with the correct Content-Length. No early EOF. #[tokio::test] - #[serial] async fn degraded_read_large_objects_with_one_disk_offline_return_full_body() -> TestResult { init_logging(); info!("dist-13 (a): large-object degraded read with one of four disks offline"); @@ -335,7 +333,6 @@ mod tests { /// mid-stream — the exact window the fixes had to reconstruct through rather /// than truncate. #[tokio::test] - #[serial] async fn degraded_read_reconstructs_through_midstream_bitrot_within_quorum() -> TestResult { init_logging(); info!("dist-13 (b): mid-stream bitrot within quorum must reconstruct a full body"); @@ -393,7 +390,6 @@ mod tests { /// Content-Length. `get_checked` panics on that forbidden outcome, so this /// test fails loudly if the truncation bug ever returns. #[tokio::test] - #[serial] async fn beyond_quorum_degraded_read_never_silently_truncates() -> TestResult { init_logging(); info!("dist-13 (c): beyond-quorum degraded read must fail, never 200+truncated"); diff --git a/crates/e2e_test/src/get_stream_failure_observability_test.rs b/crates/e2e_test/src/get_stream_failure_observability_test.rs index 8777d1350..4f6bd597a 100644 --- a/crates/e2e_test/src/get_stream_failure_observability_test.rs +++ b/crates/e2e_test/src/get_stream_failure_observability_test.rs @@ -51,7 +51,6 @@ mod tests { use aws_sdk_s3::Client; use aws_sdk_s3::primitives::ByteStream; use aws_sdk_s3::types::{CompletedMultipartUpload, CompletedPart}; - use serial_test::serial; use std::error::Error; use tokio::time::{Duration, timeout}; use tracing::info; @@ -129,7 +128,6 @@ mod tests { /// the body — and assert the server log names the object, at the log level a /// default deployment actually runs with. #[tokio::test] - #[serial] async fn midstream_get_failure_is_logged_with_the_object_at_default_log_level() -> TestResult { init_logging(); info!("rustfs#4784: a mid-stream GET failure must name its object in the source log"); diff --git a/crates/e2e_test/src/inline_fast_path_cluster_test.rs b/crates/e2e_test/src/inline_fast_path_cluster_test.rs index a4df7cd88..8de63303f 100644 --- a/crates/e2e_test/src/inline_fast_path_cluster_test.rs +++ b/crates/e2e_test/src/inline_fast_path_cluster_test.rs @@ -46,7 +46,6 @@ use prost::Message; use rustfs_signer::constants::UNSIGNED_PAYLOAD; use rustfs_signer::sign_v4; use s3s::Body; -use serial_test::serial; use std::collections::BTreeMap; use std::convert::Infallible; use std::error::Error; @@ -1695,7 +1694,6 @@ fn assert_storage_layout( } #[tokio::test] -#[serial] async fn four_node_inline_storage_and_get_boundaries() -> TestResult { init_logging(); @@ -1767,7 +1765,6 @@ async fn four_node_inline_storage_and_get_boundaries() -> TestResult { } #[tokio::test] -#[serial] async fn four_node_empty_legacy_volumes_start_as_fresh() -> TestResult { init_logging(); @@ -1805,7 +1802,6 @@ async fn four_node_empty_legacy_volumes_start_as_fresh() -> TestResult { } #[tokio::test] -#[serial] async fn four_node_inline_fallback_controls() -> TestResult { init_logging(); @@ -1870,7 +1866,6 @@ async fn four_node_inline_fallback_controls() -> TestResult { } #[tokio::test] -#[serial] async fn four_node_compressed_inline_fallback() -> TestResult { init_logging(); @@ -1905,7 +1900,6 @@ async fn four_node_compressed_inline_fallback() -> TestResult { /// Multipart disk compression is live again, so a compression-enabled cluster classifies multipart objects as compressed and the roundtrip (full GET plus partNumber GET) must still return the original bytes. /// Reverting the multipart compression fix must fail this test. #[tokio::test] -#[serial] async fn four_node_multipart_disk_compression_roundtrip() -> TestResult { init_logging(); @@ -1952,7 +1946,6 @@ async fn four_node_multipart_disk_compression_roundtrip() -> TestResult { /// read costs on the order of the covering part's block size against a ~5 MiB /// object. #[tokio::test] -#[serial] async fn four_node_compressed_multipart_tail_range_reads_are_bounded() -> TestResult { init_logging(); @@ -2019,7 +2012,6 @@ async fn four_node_compressed_multipart_tail_range_reads_are_bounded() -> TestRe } #[tokio::test] -#[serial] async fn four_node_mixed_msgpack_compat_mode_preserves_fallback_controls() -> TestResult { init_logging(); @@ -2123,7 +2115,6 @@ async fn four_node_mixed_msgpack_compat_mode_preserves_fallback_controls() -> Te } #[tokio::test] -#[serial] async fn four_node_add_tier_converges() -> TestResult { init_logging(); @@ -2142,7 +2133,6 @@ async fn four_node_add_tier_converges() -> TestResult { } #[tokio::test] -#[serial] async fn four_node_add_tier_converges_after_offline_node_restart_without_second_mutation() -> TestResult { init_logging(); @@ -2164,7 +2154,6 @@ async fn four_node_add_tier_converges_after_offline_node_restart_without_second_ } #[tokio::test] -#[serial] async fn four_node_manual_transition_job_status_survives_node_restart() -> TestResult { init_logging(); @@ -2239,7 +2228,6 @@ async fn four_node_manual_transition_job_status_survives_node_restart() -> TestR } #[tokio::test] -#[serial] async fn four_node_manual_transition_distributed_admission_conflict_reports_status_and_backpressure() -> TestResult { init_logging(); @@ -2381,7 +2369,6 @@ async fn four_node_manual_transition_distributed_admission_conflict_reports_stat } #[tokio::test] -#[serial] #[ignore = "manual #1508 evidence harness: starts a 4-node cluster, a remote tier, and an in-flight transition job"] async fn four_node_manual_transition_rollout_non_empty_restart_readback() -> TestResult { init_logging(); @@ -2486,7 +2473,6 @@ async fn four_node_manual_transition_rollout_non_empty_restart_readback() -> Tes } #[tokio::test] -#[serial] async fn four_node_mixed_msgpack_compat_mode_preserves_fallback_controls_during_transition() -> TestResult { init_logging(); @@ -2598,7 +2584,6 @@ async fn four_node_mixed_msgpack_compat_mode_preserves_fallback_controls_during_ } #[tokio::test] -#[serial] async fn four_node_transitioned_inline_fallback() -> TestResult { init_logging(); diff --git a/crates/e2e_test/src/kms/kms_vault_test.rs b/crates/e2e_test/src/kms/kms_vault_test.rs index d360ea557..8fb49ca02 100644 --- a/crates/e2e_test/src/kms/kms_vault_test.rs +++ b/crates/e2e_test/src/kms/kms_vault_test.rs @@ -19,7 +19,6 @@ //! multipart upload behaviour. use crate::common::{TEST_BUCKET, init_logging}; -use serial_test::serial; use tokio::time::{Duration, sleep}; use tracing::{error, info}; @@ -62,7 +61,6 @@ impl VaultKmsTestContext { } #[tokio::test] -#[serial] async fn test_vault_kms_end_to_end() -> Result<(), Box> { init_logging(); if skip_if_kms_admin_tool_unavailable("test_vault_kms_end_to_end") { @@ -118,7 +116,6 @@ async fn test_vault_kms_end_to_end() -> Result<(), Box Result<(), Box> { init_logging(); if skip_if_kms_admin_tool_unavailable("test_vault_kms_key_isolation") { @@ -205,7 +202,6 @@ async fn test_vault_kms_key_isolation() -> Result<(), Box Result<(), Box> { init_logging(); if skip_if_kms_admin_tool_unavailable("test_vault_kms_large_file") { @@ -270,7 +266,6 @@ async fn test_vault_kms_large_file() -> Result<(), Box Result<(), Box> { init_logging(); if skip_if_kms_admin_tool_unavailable("test_vault_kms_multipart_upload") { @@ -301,7 +296,6 @@ async fn test_vault_kms_multipart_upload() -> Result<(), Box Result<(), Box> { init_logging(); if skip_if_kms_admin_tool_unavailable("test_vault_kms_key_operations") { diff --git a/crates/e2e_test/src/policy/policy_variables_test.rs b/crates/e2e_test/src/policy/policy_variables_test.rs index 52c6492d0..e9b603822 100644 --- a/crates/e2e_test/src/policy/policy_variables_test.rs +++ b/crates/e2e_test/src/policy/policy_variables_test.rs @@ -17,7 +17,6 @@ use crate::common::{awscurl_delete, awscurl_put, init_logging}; use crate::policy::test_env::PolicyTestEnvironment; use aws_sdk_s3::primitives::ByteStream; -use serial_test::serial; use tracing::info; /// Helper function to create a regular user with given credentials @@ -122,7 +121,6 @@ async fn cleanup_user_and_policy(env: &PolicyTestEnvironment, username: &str, po /// Test AWS policy variables with single-value scenarios #[tokio::test(flavor = "multi_thread")] -#[serial] #[ignore = "Starts a rustfs server; enable when running full E2E"] pub async fn test_aws_policy_variables_single_value() -> Result<(), Box> { test_aws_policy_variables_single_value_impl().await @@ -275,7 +273,6 @@ pub async fn test_aws_policy_variables_single_value_impl_with_env( /// Test AWS policy variables with multi-value scenarios #[tokio::test(flavor = "multi_thread")] -#[serial] #[ignore = "Starts a rustfs server; enable when running full E2E"] pub async fn test_aws_policy_variables_multi_value() -> Result<(), Box> { test_aws_policy_variables_multi_value_impl().await @@ -401,7 +398,6 @@ pub async fn test_aws_policy_variables_multi_value_impl_with_env( /// Test AWS policy variables with variable concatenation #[tokio::test(flavor = "multi_thread")] -#[serial] #[ignore = "Starts a rustfs server; enable when running full E2E"] pub async fn test_aws_policy_variables_concatenation() -> Result<(), Box> { test_aws_policy_variables_concatenation_impl().await @@ -491,7 +487,6 @@ pub async fn test_aws_policy_variables_concatenation_impl_with_env( /// Test AWS policy variables with nested scenarios #[tokio::test(flavor = "multi_thread")] -#[serial] #[ignore = "Starts a rustfs server; enable when running full E2E"] pub async fn test_aws_policy_variables_nested() -> Result<(), Box> { test_aws_policy_variables_nested_impl().await @@ -509,7 +504,6 @@ pub async fn test_aws_policy_variables_nested_impl() -> Result<(), Box Result<(), Box> { test_aws_policy_variables_sts_impl().await @@ -705,7 +699,6 @@ pub async fn test_aws_policy_variables_sts_impl_with_env( /// Test AWS policy variables with deny scenarios #[tokio::test(flavor = "multi_thread")] -#[serial] #[ignore = "Starts a rustfs server; enable when running full E2E"] pub async fn test_aws_policy_variables_deny() -> Result<(), Box> { test_aws_policy_variables_deny_impl().await diff --git a/crates/e2e_test/src/policy/test_runner.rs b/crates/e2e_test/src/policy/test_runner.rs index 2194db2fb..5402f72eb 100644 --- a/crates/e2e_test/src/policy/test_runner.rs +++ b/crates/e2e_test/src/policy/test_runner.rs @@ -14,7 +14,6 @@ use crate::common::init_logging; use crate::policy::test_env::PolicyTestEnvironment; -use serial_test::serial; use std::time::Instant; use tokio::time::{Duration, sleep}; use tracing::{error, info}; @@ -213,7 +212,6 @@ impl PolicyTestSuite { /// Test suite #[tokio::test] -#[serial] #[ignore = "Connects to existing rustfs server"] async fn test_policy_critical_suite() -> Result<(), Box> { let config = TestSuiteConfig { diff --git a/crates/e2e_test/src/protocols/webdav_core.rs b/crates/e2e_test/src/protocols/webdav_core.rs index 3b15a1d43..90c266c69 100644 --- a/crates/e2e_test/src/protocols/webdav_core.rs +++ b/crates/e2e_test/src/protocols/webdav_core.rs @@ -41,7 +41,6 @@ use reqwest::Client; use rustfs_signer::constants::UNSIGNED_PAYLOAD; use rustfs_signer::sign_v4; use s3s::Body; -use serial_test::serial; use tokio::process::Command; use tracing::info; @@ -821,7 +820,6 @@ pub async fn test_webdav_core_operations() -> Result<()> { } #[tokio::test] -#[serial] async fn test_webdav_core_operations_direct() -> Result<()> { test_webdav_core_operations().await } diff --git a/crates/e2e_test/src/reliability_disk_fault_test.rs b/crates/e2e_test/src/reliability_disk_fault_test.rs index 3b2ae3e29..c77249716 100644 --- a/crates/e2e_test/src/reliability_disk_fault_test.rs +++ b/crates/e2e_test/src/reliability_disk_fault_test.rs @@ -27,7 +27,6 @@ mod tests { use aws_sdk_s3::Client; use aws_sdk_s3::primitives::ByteStream; use aws_sdk_s3::types::{BucketVersioningStatus, CompletedMultipartUpload, CompletedPart, VersioningConfiguration}; - use serial_test::serial; use sha2::{Digest, Sha256}; use std::collections::HashSet; use std::error::Error; @@ -157,7 +156,6 @@ mod tests { /// content, degraded writes must succeed, and everything must still /// verify after the disk returns. #[tokio::test] - #[serial] async fn test_degraded_read_write_with_one_disk_offline() -> Result<(), Box> { init_logging(); info!("Reliability: degraded read/write with one of four disks offline"); @@ -210,7 +208,6 @@ mod tests { /// bytes to a reader: per-shard bitrot checksums reject the bad shard and /// the object is reconstructed from the remaining shards. #[tokio::test] - #[serial] async fn test_bitrot_corrupted_shard_read_returns_correct_data() -> Result<(), Box> { init_logging(); info!("Reliability: GET must read through a bitrot-corrupted shard"); @@ -253,7 +250,6 @@ mod tests { /// heal, and require the replaced disk to be rebuilt and all content to /// verify against the sha256 manifest. #[tokio::test] - #[serial] async fn test_fresh_disk_replacement_heals_after_sigkill_restart() -> Result<(), Box> { init_logging(); info!("Reliability: fresh-disk replacement heals after SIGKILL restart"); @@ -327,7 +323,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_versioned_shard_census_selects_each_version_data_dir() -> Result<(), Box> { init_logging(); info!("Reliability: physical shard census selects the requested object version"); diff --git a/crates/e2e_test/src/replacement_privileged_e2e_test.rs b/crates/e2e_test/src/replacement_privileged_e2e_test.rs index 67c1b0097..fc687d4e3 100644 --- a/crates/e2e_test/src/replacement_privileged_e2e_test.rs +++ b/crates/e2e_test/src/replacement_privileged_e2e_test.rs @@ -29,7 +29,6 @@ mod tests { use aws_sdk_s3::primitives::ByteStream; use aws_sdk_s3::types::{BucketVersioningStatus, CompletedMultipartUpload, CompletedPart, VersioningConfiguration}; use http::Method; - use serial_test::serial; use sha2::{Digest, Sha256}; use std::collections::BTreeSet; use std::error::Error; @@ -1061,7 +1060,6 @@ mod tests { /// Linux mount namespaces are per-thread; keep mount setup and process /// spawning on one OS thread so child RustFS nodes inherit the test mounts. #[tokio::test(flavor = "current_thread")] - #[serial] #[ignore = "requires Linux root/CAP_SYS_ADMIN and RUSTFS_PRIVILEGED_REPLACEMENT_E2E=1"] async fn test_privileged_3x4_auto_replacement_rebuilds_ec8_plus_4_without_admin_heal() -> Result<(), Box> { @@ -1075,7 +1073,6 @@ mod tests { /// Linux mount namespaces are per-thread; keep mount setup and process /// spawning on one OS thread so child RustFS nodes inherit the test mounts. #[tokio::test(flavor = "current_thread")] - #[serial] #[ignore = "requires Linux root/CAP_SYS_ADMIN and RUSTFS_PRIVILEGED_REPLACEMENT_E2E=1"] async fn test_privileged_3x4_auto_replacement_rebuilds_ec6_plus_6_without_admin_heal() -> Result<(), Box> { diff --git a/crates/lifecycle/Cargo.toml b/crates/lifecycle/Cargo.toml index ae8232f20..483b0e7d7 100644 --- a/crates/lifecycle/Cargo.toml +++ b/crates/lifecycle/Cargo.toml @@ -69,7 +69,7 @@ uuid = { workspace = true, features = ["v4", "serde", "fast-rng", "macro-diagnos [dev-dependencies] metrics-util = { workspace = true, features = ["debugging"] } proptest = "1" -serial_test.workspace = true +serial_test = { workspace = true } temp-env.workspace = true tokio = { workspace = true, features = ["macros", "fs", "rt-multi-thread"] } diff --git a/crates/lifecycle/src/core.rs b/crates/lifecycle/src/core.rs index 4d1f5298d..6180d0022 100644 --- a/crates/lifecycle/src/core.rs +++ b/crates/lifecycle/src/core.rs @@ -1564,7 +1564,6 @@ mod tests { } #[tokio::test] - #[serial] async fn abort_incomplete_multipart_upload_due_accepts_zero_days() { let initiated = OffsetDateTime::from_unix_timestamp(1_000_000).unwrap(); let lc = BucketLifecycleConfiguration { @@ -1625,7 +1624,6 @@ mod tests { } #[tokio::test] - #[serial] async fn predict_expiration_selects_closest_expiry_for_put_object() { let base_time = OffsetDateTime::from_unix_timestamp(1_000_000).unwrap(); let lc = BucketLifecycleConfiguration { @@ -1872,7 +1870,6 @@ mod tests { } #[tokio::test] - #[serial] async fn empty_transition_vectors_are_not_active_or_due() { let lc = BucketLifecycleConfiguration { expiry_updated_at: None, @@ -1938,7 +1935,6 @@ mod tests { } #[tokio::test] - #[serial] async fn eval_inner_keeps_latest_object_before_days_due() { let base_time = OffsetDateTime::from_unix_timestamp(1_000_000).unwrap(); let lc = BucketLifecycleConfiguration { @@ -1972,7 +1968,6 @@ mod tests { } #[tokio::test] - #[serial] async fn eval_inner_transitions_latest_object_after_days_due() { let base_time = OffsetDateTime::from_unix_timestamp(1_000_000).unwrap(); let lc = BucketLifecycleConfiguration { @@ -2010,7 +2005,6 @@ mod tests { } #[tokio::test] - #[serial] async fn eval_inner_transitions_latest_object_after_date_due() { let base_time = OffsetDateTime::from_unix_timestamp(1_000_000).unwrap(); let transition_date = base_time - Duration::days(1); @@ -2050,7 +2044,6 @@ mod tests { } #[tokio::test] - #[serial] async fn eval_inner_selects_earliest_due_among_multiple_past_due_events() { let base_time = OffsetDateTime::from_unix_timestamp(1_000_000).unwrap(); // Two enabled rules both yield a past-due DeleteAction and a third yields a @@ -2164,7 +2157,6 @@ mod tests { } #[tokio::test] - #[serial] async fn eval_inner_expires_noncurrent_version_after_due() { let base_time = OffsetDateTime::from_unix_timestamp(1_000_000).unwrap(); let lc = BucketLifecycleConfiguration { @@ -2202,7 +2194,6 @@ mod tests { } #[tokio::test] - #[serial] async fn eval_inner_skips_noncurrent_expiration_without_successor() { let base_time = OffsetDateTime::from_unix_timestamp(1_000_000).expect("valid fixed test timestamp"); let lc = BucketLifecycleConfiguration { @@ -2238,7 +2229,6 @@ mod tests { } #[tokio::test] - #[serial] async fn eval_inner_missing_successor_does_not_skip_noncurrent_transition() { let base_time = OffsetDateTime::from_unix_timestamp(1_000_000).expect("valid fixed test timestamp"); let lc = BucketLifecycleConfiguration { @@ -2281,7 +2271,6 @@ mod tests { } #[tokio::test] - #[serial] async fn eval_inner_noncurrent_expiration_one_day_respects_due_boundary() { let successor_time = datetime!(2025-06-15 12:00:00 UTC); let due = expected_expiry_time(successor_time, 1); @@ -2323,7 +2312,6 @@ mod tests { } #[tokio::test] - #[serial] async fn eval_inner_expires_noncurrent_version_immediately_when_zero_days() { let base_time = OffsetDateTime::from_unix_timestamp(1_000_000).unwrap(); let lc = BucketLifecycleConfiguration { @@ -2361,7 +2349,6 @@ mod tests { } #[tokio::test] - #[serial] async fn eval_inner_transitions_noncurrent_version_after_due() { let base_time = OffsetDateTime::from_unix_timestamp(1_000_000).unwrap(); let lc = BucketLifecycleConfiguration { @@ -2437,7 +2424,6 @@ mod tests { } #[tokio::test] - #[serial] async fn evaluator_honors_newer_noncurrent_versions_retention_count() { let base_time = OffsetDateTime::from_unix_timestamp(1_000_000).unwrap(); let lc = Arc::new(BucketLifecycleConfiguration { @@ -2726,7 +2712,6 @@ mod tests { } #[tokio::test] - #[serial] async fn expired_object_delete_marker_ignores_marker_with_noncurrent_versions_present() { let base_time = OffsetDateTime::from_unix_timestamp(1_000_000).unwrap(); let lc = BucketLifecycleConfiguration { @@ -2803,7 +2788,6 @@ mod tests { } #[tokio::test] - #[serial] async fn expired_object_delete_marker_deletes_only_delete_marker_immediately() { let base_time = OffsetDateTime::from_unix_timestamp(1_000_000).unwrap(); let lc = BucketLifecycleConfiguration { @@ -2881,7 +2865,6 @@ mod tests { } #[tokio::test] - #[serial] async fn expiration_days_deletes_only_expired_delete_marker_when_due() { let base_time = OffsetDateTime::from_unix_timestamp(1_000_000).unwrap(); let lc = BucketLifecycleConfiguration { @@ -2932,7 +2915,6 @@ mod tests { } #[tokio::test] - #[serial] async fn expiration_days_uses_earliest_due_rule_for_expired_delete_marker() { let base_time = OffsetDateTime::from_unix_timestamp(1_000_000).unwrap(); let make_rule = |id: &str, days| LifecycleRule { @@ -3263,7 +3245,6 @@ mod tests { } #[tokio::test] - #[serial] async fn del_marker_expiration_deletes_marker_and_older_versions_when_due() { let base_time = OffsetDateTime::from_unix_timestamp(1_000_000).expect("fixed timestamp should be valid"); let lc = BucketLifecycleConfiguration { @@ -3303,7 +3284,6 @@ mod tests { // --- TASK-003 tests: Round up to next UTC processing boundary --- #[test] - #[serial] fn expected_expiry_time_rounds_up_to_next_midnight_utc() { with_default_ilm_process_time(|| { // Object created at 2025-01-15T10:30:45Z, expire in 30 days @@ -3319,7 +3299,6 @@ mod tests { } #[test] - #[serial] fn expected_expiry_time_immediate_expiry_returns_epoch() { with_default_ilm_process_time(|| { let mod_time = datetime!(2025-06-01 12:00:00 UTC); @@ -3329,7 +3308,6 @@ mod tests { } #[test] - #[serial] fn expected_expiry_time_preserves_exact_midnight_boundary() { with_default_ilm_process_time(|| { let mod_time = datetime!(2025-03-01 00:00:00 UTC); @@ -3339,7 +3317,6 @@ mod tests { } #[test] - #[serial] fn expected_expiry_time_rounds_end_of_day_to_following_midnight() { with_default_ilm_process_time(|| { let mod_time = datetime!(2025-06-15 23:59:59 UTC); @@ -3349,7 +3326,6 @@ mod tests { } #[test] - #[serial] fn expected_expiry_time_uses_canonical_process_time_boundary() { let mod_time = datetime!(2025-01-15 10:30:45 UTC); @@ -3362,7 +3338,6 @@ mod tests { } #[test] - #[serial] fn expected_expiry_time_uses_deprecated_process_time_alias() { let mod_time = datetime!(2025-01-15 10:30:45 UTC); @@ -3375,7 +3350,6 @@ mod tests { } #[test] - #[serial] fn expected_expiry_time_uses_default_boundary_when_process_time_is_zero_or_invalid() { let mod_time = datetime!(2025-01-15 10:30:45 UTC); @@ -3398,7 +3372,6 @@ mod tests { // (a) Default path (env unset) is byte-identical: one day == 86400s. #[test] - #[serial] fn ilm_day_secs_defaults_to_86400_when_unset() { temp_env::with_var_unset(ENV_ILM_DEBUG_DAY_SECS, || { assert_eq!(ilm_day_secs(), DEFAULT_ILM_DAY_SECS); @@ -3427,7 +3400,6 @@ mod tests { // (b) End-to-end env read scales the day length. #[test] - #[serial] fn ilm_day_secs_scales_when_env_set() { temp_env::with_var(ENV_ILM_DEBUG_DAY_SECS, Some("2"), || { assert_eq!(ilm_day_secs(), 2); @@ -3436,7 +3408,6 @@ mod tests { // (c) Invalid env value falls back to 86400. #[test] - #[serial] fn ilm_day_secs_falls_back_on_invalid_env() { temp_env::with_var(ENV_ILM_DEBUG_DAY_SECS, Some("bogus"), || { assert_eq!(ilm_day_secs(), DEFAULT_ILM_DAY_SECS); @@ -3449,7 +3420,6 @@ mod tests { // Deadline math scales: with a 1s day and PROCESS_TIME unset, a Days=1 rule is // due 1s after mod_time (rounded up to the next 1s boundary => same instant). #[test] - #[serial] fn expected_expiry_time_scales_with_debug_day_secs() { let mod_time = datetime!(2025-01-15 10:30:45 UTC); temp_env::with_var(ENV_ILM_DEBUG_DAY_SECS, Some("1"), || { @@ -3465,7 +3435,6 @@ mod tests { // days == 0 still yields the immediate-expiry sentinel regardless of the switch. #[test] - #[serial] fn expected_expiry_time_zero_days_ignores_debug_day_secs() { let mod_time = datetime!(2025-06-01 12:00:00 UTC); temp_env::with_var(ENV_ILM_DEBUG_DAY_SECS, Some("2"), || { @@ -3476,7 +3445,6 @@ mod tests { // (③) Interaction with an explicit RUSTFS_ILM_PROCESS_TIME: the deadline offset // uses the accelerated day length, but the rounding boundary honors PROCESS_TIME. #[test] - #[serial] fn expected_expiry_time_debug_day_secs_respects_explicit_process_time() { let mod_time = datetime!(2025-01-15 10:30:00 UTC); // day == 10s, but round up to the next 60s (PROCESS_TIME) boundary. @@ -3493,7 +3461,6 @@ mod tests { // (③) With the switch unset, an explicit PROCESS_TIME behaves exactly as before. #[test] - #[serial] fn expected_expiry_time_unset_debug_day_secs_matches_legacy_process_time() { let mod_time = datetime!(2025-01-15 10:30:45 UTC); temp_env::with_var_unset(ENV_ILM_DEBUG_DAY_SECS, || { @@ -3521,7 +3488,6 @@ mod tests { // The abort-incomplete-multipart deadline path also scales through the switch. #[test] - #[serial] fn abort_incomplete_multipart_due_scales_with_debug_day_secs() { use s3s::dto::AbortIncompleteMultipartUpload; let initiated = datetime!(2025-01-15 10:30:45 UTC); @@ -3566,7 +3532,6 @@ mod tests { // (⑤ evaluator seam) A Days=1 rule fires under RUSTFS_ILM_DEBUG_DAY_SECS=1 once // `now` advances a few seconds past a mod_time only ~seconds in the past. #[test] - #[serial] fn eval_inner_expires_days_one_rule_under_debug_day_secs() { let lc = BucketLifecycleConfiguration { expiry_updated_at: None, @@ -3615,7 +3580,6 @@ mod tests { // Absolute Date-based rules must NOT scale with the switch (regression guard). #[test] - #[serial] fn eval_inner_date_rule_ignores_debug_day_secs() { let expiry_date = datetime!(2025-06-01 00:00:00 UTC); let lc = BucketLifecycleConfiguration { @@ -3873,7 +3837,6 @@ mod tests { } #[tokio::test] - #[serial] async fn eval_inner_triggers_delete_all_versions_when_expired_object_all_versions_set() { let base_time = OffsetDateTime::from_unix_timestamp(1_000_000).unwrap(); let lc = BucketLifecycleConfiguration { @@ -3912,7 +3875,6 @@ mod tests { } #[tokio::test] - #[serial] async fn expired_object_all_versions_does_not_apply_to_current_delete_marker() { let base_time = OffsetDateTime::from_unix_timestamp(1_000_000).expect("fixed timestamp should be valid"); let lc = BucketLifecycleConfiguration { @@ -3942,7 +3904,6 @@ mod tests { } #[tokio::test] - #[serial] async fn eval_inner_uses_delete_action_when_all_versions_not_set() { let base_time = OffsetDateTime::from_unix_timestamp(1_000_000).unwrap(); let lc = BucketLifecycleConfiguration { @@ -4061,7 +4022,6 @@ mod tests { use super::*; use proptest::prelude::*; use s3s::dto::{NoncurrentVersionExpiration, Tag}; - use serial_test::serial; const DAY_SECS: i64 = 86400; @@ -4292,7 +4252,6 @@ mod tests { /// combination, and must be deterministic: the same input /// evaluated twice yields an identical event. #[test] - #[serial] fn eval_inner_never_panics_and_is_deterministic( rules in prop::collection::vec(arb_rule(), 0..4), obj in arb_object_opts(), @@ -4432,7 +4391,6 @@ mod tests { /// candidate set — earliest due wins, ties prefer delete-class — /// and must be `NoneAction` exactly when that set is empty. #[test] - #[serial] fn eval_inner_winner_matches_selection_oracle( rules in prop::collection::vec(arb_selection_rule(), 0..5), mod_off in 0i64..(2 * DAY_SECS), @@ -4486,7 +4444,6 @@ mod tests { /// non-decreasing in `days` (days == 0 maps to UNIX_EPOCH, below /// any post-1970 deadline). #[test] - #[serial] fn expected_expiry_time_is_monotonic_in_days( mod_off in 0i64..(3650 * DAY_SECS), d1 in 0i32..2000, @@ -4508,7 +4465,6 @@ mod tests { /// to the next whole-day boundary: the result is day-aligned, not /// before `mod_time + days`, and less than one boundary beyond it. #[test] - #[serial] fn expected_expiry_time_lands_on_default_day_boundary( mod_off in 0i64..(3650 * DAY_SECS), days in 1i32..2000, @@ -4526,7 +4482,6 @@ mod tests { /// to that boundary instead: aligned to it, never early, and less /// than one boundary late. #[test] - #[serial] fn expected_expiry_time_lands_on_explicit_process_boundary( mod_off in 0i64..(365 * DAY_SECS), days in 1i32..400, diff --git a/crates/object-capacity/Cargo.toml b/crates/object-capacity/Cargo.toml index a1eea7740..b37d58f3b 100644 --- a/crates/object-capacity/Cargo.toml +++ b/crates/object-capacity/Cargo.toml @@ -73,7 +73,6 @@ walkdir = { workspace = true } [dev-dependencies] criterion = { workspace = true, features = ["html_reports"] } -serial_test = { workspace = true } temp-env = { workspace = true, features = ["async_closure"] } tempfile = { workspace = true } tokio = { workspace = true, features = ["test-util", "macros", "fs", "rt-multi-thread"] } diff --git a/crates/object-capacity/src/capacity_manager.rs b/crates/object-capacity/src/capacity_manager.rs index 2d70f985c..99c3a63bc 100644 --- a/crates/object-capacity/src/capacity_manager.rs +++ b/crates/object-capacity/src/capacity_manager.rs @@ -1484,7 +1484,6 @@ mod tests { ENV_CAPACITY_SAMPLE_RATE, ENV_CAPACITY_STAT_TIMEOUT, ENV_CAPACITY_WRITE_FREQUENCY_THRESHOLD, ENV_CAPACITY_WRITE_TRIGGER_DELAY, }; - use serial_test::serial; use std::sync::Arc; use std::sync::atomic::{AtomicUsize, Ordering}; @@ -1669,7 +1668,6 @@ mod tests { } #[test] - #[serial] fn test_config_getter_defaults() { for (env_var, getter, default, _, _) in config_getter_cases() { temp_env::with_var(env_var, None::<&str>, || { @@ -1679,7 +1677,6 @@ mod tests { } #[test] - #[serial] fn test_config_getter_env_overrides() { for (env_var, getter, _, override_value, expected) in config_getter_cases() { temp_env::with_var(env_var, Some(override_value), || { @@ -1689,7 +1686,6 @@ mod tests { } #[test] - #[serial] fn test_zero_env_values_clamp_to_defaults() { // A zero threshold makes small disks report 0 bytes; a zero timeout // (with dynamic timeout off) makes every scan fail. Both must fall @@ -1709,7 +1705,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_update_capacity_preserves_retrieval_metadata() { let manager = HybridCapacityManager::from_env(); @@ -1725,7 +1720,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_record_write_operation() { let manager = HybridCapacityManager::from_env(); @@ -1736,7 +1730,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_write_frequency_window() { let manager = HybridCapacityManager::from_env(); @@ -1824,7 +1817,6 @@ mod tests { } #[test] - #[serial] fn test_recent_write_count_ignores_future_buckets() { let record = WriteRecord::new(); record.write_buckets[0].store(120, 3); @@ -1838,7 +1830,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_needs_fast_update() { let manager = HybridCapacityManager::from_env(); @@ -1855,7 +1846,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_cache_age_tracking() { let manager = HybridCapacityManager::from_env(); @@ -1875,7 +1865,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_data_source_tracking() { let manager = HybridCapacityManager::from_env(); @@ -1891,7 +1880,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_needs_fast_update_waits_for_write_trigger_delay() { let manager = create_isolated_manager(HybridStrategyConfig { scheduled_update_interval: Duration::from_secs(60), @@ -1922,7 +1910,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_needs_fast_update_respects_enable_write_trigger() { let manager = create_isolated_manager(HybridStrategyConfig { scheduled_update_interval: Duration::from_secs(60), @@ -1949,7 +1936,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_concurrent_access() { let manager = Arc::new(HybridCapacityManager::from_env()); let mut handles = Vec::new(); @@ -1976,7 +1962,6 @@ mod tests { // exact under heavy same-second contention or the frequency window (and the // write-trigger decision) would undercount. #[tokio::test(flavor = "multi_thread", worker_threads = 8)] - #[serial] async fn test_record_write_operation_lock_free_is_exact_under_contention() { let manager = Arc::new(HybridCapacityManager::from_env()); let mut handles = Vec::new(); @@ -2001,7 +1986,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_performance_overhead() { let manager = Arc::new(HybridCapacityManager::from_env()); let start = Instant::now(); @@ -2018,7 +2002,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_refresh_or_join_singleflight() { let manager = Arc::new(HybridCapacityManager::from_env()); let calls = Arc::new(AtomicUsize::new(0)); @@ -2058,7 +2041,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_refresh_or_join_recovers_after_leader_cancellation() { let manager = Arc::new(HybridCapacityManager::from_env()); @@ -2087,7 +2069,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_refresh_or_join_cancelled_leader_unblocks_joiner() { let manager = Arc::new(HybridCapacityManager::from_env()); @@ -2115,7 +2096,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_spawn_refresh_if_needed_deduplicates_background_refresh() { let manager = Arc::new(HybridCapacityManager::from_env()); let calls = Arc::new(AtomicUsize::new(0)); @@ -2153,7 +2133,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_record_write_operation_with_scope_token_marks_dirty_disks() { let manager = create_isolated_manager(HybridStrategyConfig::default()); let token = uuid::Uuid::new_v4(); @@ -2177,7 +2156,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_get_dirty_disks_drains_global_dirty_scope_registry() { let manager = create_isolated_manager(HybridStrategyConfig::default()); record_global_dirty_scope(CapacityScope { @@ -2197,7 +2175,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_update_capacity_recomputes_total_from_disk_cache_for_subset_refresh() { let manager = create_isolated_manager(HybridStrategyConfig::default()); @@ -2308,7 +2285,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_update_capacity_degraded_full_refresh_merges_cache_and_does_not_oscillate() { let manager = create_isolated_manager(HybridStrategyConfig::default()); @@ -2354,7 +2330,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_update_capacity_degraded_with_empty_per_disk_serves_merged_cache() { let manager = create_isolated_manager(HybridStrategyConfig::default()); manager.update_capacity(full_two_disk_update(), DataSource::RealTime).await; @@ -2384,7 +2359,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_update_capacity_degraded_without_complete_cache_keeps_partial_sum() { let manager = create_isolated_manager(HybridStrategyConfig::default()); @@ -2425,7 +2399,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_commit_keeps_dirty_marks_recorded_after_scan_start() { let manager = create_isolated_manager(HybridStrategyConfig::default()); let disk = scope_disk("node-a", "/tmp/disk-a"); @@ -2456,7 +2429,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_commit_clears_dirty_marks_recorded_before_scan_start() { let manager = create_isolated_manager(HybridStrategyConfig::default()); let disk = scope_disk("node-a", "/tmp/disk-a"); @@ -2477,7 +2449,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_retain_dirty_disks_within_drops_ghost_entries() { let manager = create_isolated_manager(HybridStrategyConfig::default()); let local = scope_disk("node-a", "/tmp/disk-a"); @@ -2496,7 +2467,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_spawn_refresh_recovers_from_construction_panic() { let manager = create_isolated_manager(HybridStrategyConfig::default()); @@ -2563,7 +2533,6 @@ mod tests { } #[tokio::test(start_paused = true)] - #[serial] async fn test_refresh_or_join_joiner_times_out_when_leader_wedges() { let manager = create_isolated_manager(HybridStrategyConfig::default()); @@ -2591,7 +2560,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_refresh_or_join_returns_cluster_total_for_dirty_subset() { let manager = create_isolated_manager(HybridStrategyConfig::default()); @@ -2673,7 +2641,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_config_from_env() { let config = HybridStrategyConfig::from_env(); @@ -2687,7 +2654,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_config_from_env_with_override() { temp_env::with_var(ENV_CAPACITY_SCHEDULED_INTERVAL, Some("600"), || { let config = HybridStrategyConfig::from_env(); diff --git a/crates/object-capacity/src/scan.rs b/crates/object-capacity/src/scan.rs index bf974cda6..d93b99736 100644 --- a/crates/object-capacity/src/scan.rs +++ b/crates/object-capacity/src/scan.rs @@ -1069,7 +1069,6 @@ mod tests { #[cfg(unix)] use rustfs_config::ENV_CAPACITY_FOLLOW_SYMLINKS; use rustfs_config::{ENV_CAPACITY_MAX_FILES_THRESHOLD, ENV_CAPACITY_SAMPLE_RATE}; - use serial_test::serial; /// Reference implementation using unbounded `u128` arithmetic, clamped to /// `u64::MAX`, used as the source of truth for the sampling extrapolation. @@ -1274,7 +1273,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_get_dir_size_async_nonexistent_directory() { let result = get_dir_size_async(Path::new("/nonexistent/path")).await; assert!(result.is_err()); @@ -1648,7 +1646,6 @@ mod tests { } #[tokio::test] - #[serial] async fn test_metadata_incomplete_aggregate_does_not_replace_disk_cache() { use std::fs::File; use std::io::Write; @@ -1783,7 +1780,6 @@ mod tests { #[cfg(unix)] #[tokio::test] - #[serial] async fn test_get_dir_size_async_ignores_symlink_targets_when_follow_disabled() { use std::fs::File; use std::io::Write; @@ -1809,7 +1805,6 @@ mod tests { #[cfg(unix)] #[tokio::test] - #[serial] async fn test_get_dir_size_async_counts_symlink_targets_when_follow_enabled() { use std::fs::File; use std::io::Write; diff --git a/crates/obs/src/metrics/collectors/bucket_replication.rs b/crates/obs/src/metrics/collectors/bucket_replication.rs index a393c8e38..bbe7de6fe 100644 --- a/crates/obs/src/metrics/collectors/bucket_replication.rs +++ b/crates/obs/src/metrics/collectors/bucket_replication.rs @@ -75,7 +75,7 @@ pub struct BucketReplicationBandwidthStats { } #[derive(Debug, Clone, Default)] -pub struct BucketReplicationStats { +pub struct BucketReplicationMetricsSnapshot { pub bucket: String, pub total_failed_bytes: u64, pub total_failed_count: u64, @@ -107,7 +107,7 @@ pub struct BucketReplicationStats { #[derive(Debug, Clone, Default)] pub(crate) struct BucketReplicationRuntimeStats { - pub(crate) stats: BucketReplicationStats, + pub(crate) stats: BucketReplicationMetricsSnapshot, pub(crate) target_flows: Vec, } @@ -182,7 +182,7 @@ fn push_proxy_request_result_metrics( } } -pub fn collect_bucket_replication_metrics(stats: &[BucketReplicationStats]) -> Vec { +pub fn collect_bucket_replication_metrics(stats: &[BucketReplicationMetricsSnapshot]) -> Vec { if stats.is_empty() { return Vec::new(); } @@ -572,7 +572,7 @@ mod tests { #[test] fn test_collect_bucket_replication_metrics() { let stats = vec![BucketReplicationRuntimeStats { - stats: BucketReplicationStats { + stats: BucketReplicationMetricsSnapshot { bucket: "b1".to_string(), total_failed_bytes: 64, total_failed_count: 2, @@ -876,7 +876,7 @@ mod tests { #[test] fn test_collect_bucket_replication_metrics_empty() { - let stats: Vec = Vec::new(); + let stats: Vec = Vec::new(); let metrics = collect_bucket_replication_metrics(&stats); assert!(metrics.is_empty()); } diff --git a/crates/obs/src/metrics/collectors/mod.rs b/crates/obs/src/metrics/collectors/mod.rs index 67df19035..c4f849a4d 100644 --- a/crates/obs/src/metrics/collectors/mod.rs +++ b/crates/obs/src/metrics/collectors/mod.rs @@ -48,7 +48,7 @@ pub(crate) use bucket_replication::{ BucketReplicationTargetFlowStats, collect_bucket_replication_backlog_metrics, collect_bucket_replication_runtime_metrics, }; pub use bucket_replication::{ - BucketReplicationBandwidthStats, BucketReplicationStats, BucketReplicationTargetStats, + BucketReplicationBandwidthStats, BucketReplicationMetricsSnapshot, BucketReplicationTargetStats, collect_bucket_replication_bandwidth_metrics, collect_bucket_replication_metrics, }; pub use cluster::{ClusterStats, collect_cluster_metrics}; @@ -68,8 +68,8 @@ pub(crate) use notification::collect_notification_runtime_metrics; pub use notification::{NotificationStats, collect_notification_metrics}; pub(crate) use notification_target::{NotificationTargetRuntimeStats, collect_notification_target_runtime_metrics}; pub use notification_target::{NotificationTargetStats, collect_notification_target_metrics}; +pub use replication::{ReplicationMetricsSnapshot, collect_replication_metrics}; pub(crate) use replication::{ReplicationRuntimeStats, collect_replication_runtime_metrics}; -pub use replication::{ReplicationStats, collect_replication_metrics}; pub(crate) use request::{ApiRequestMetricSupport, ApiRequestStats, collect_request_metrics}; pub use resource::{ResourceStats, collect_resource_metrics}; pub(crate) use scanner::{ScannerRuntimeStats, collect_scanner_runtime_metrics}; diff --git a/crates/obs/src/metrics/collectors/replication.rs b/crates/obs/src/metrics/collectors/replication.rs index 4dc347058..d483c71ef 100644 --- a/crates/obs/src/metrics/collectors/replication.rs +++ b/crates/obs/src/metrics/collectors/replication.rs @@ -22,7 +22,7 @@ use crate::metrics::schema::replication::*; /// Replication statistics. #[derive(Debug, Clone, Default)] -pub struct ReplicationStats { +pub struct ReplicationMetricsSnapshot { /// Average number of active replication workers pub average_active_workers: f64, /// Average queued bytes since server start @@ -54,13 +54,13 @@ pub struct ReplicationStats { #[derive(Debug, Clone, Default)] pub(crate) struct ReplicationRuntimeStats { pub(crate) server: String, - pub(crate) stats: ReplicationStats, + pub(crate) stats: ReplicationMetricsSnapshot, } /// Collects replication metrics from the given stats. /// /// Returns a vector of Prometheus metrics for replication statistics. -pub fn collect_replication_metrics(stats: &ReplicationStats) -> Vec { +pub fn collect_replication_metrics(stats: &ReplicationMetricsSnapshot) -> Vec { vec![ PrometheusMetric::from_descriptor(&REPLICATION_AVERAGE_ACTIVE_WORKERS_MD, stats.average_active_workers), PrometheusMetric::from_descriptor(&REPLICATION_AVERAGE_QUEUED_BYTES_MD, stats.average_queued_bytes as f64), @@ -120,7 +120,7 @@ mod tests { #[test] fn test_collect_replication_metrics() { - let stats = ReplicationStats { + let stats = ReplicationMetricsSnapshot { average_active_workers: 8.5, average_queued_bytes: 1024 * 1024 * 40, average_queued_count: 240, @@ -182,7 +182,7 @@ mod tests { #[test] fn test_collect_replication_metrics_default() { - let stats = ReplicationStats::default(); + let stats = ReplicationMetricsSnapshot::default(); let metrics = collect_replication_metrics(&stats); assert_eq!(metrics.len(), 13); @@ -194,7 +194,7 @@ mod tests { #[test] fn replication_stats_struct_literal_keeps_legacy_fields() { - let stats = ReplicationStats { + let stats = ReplicationMetricsSnapshot { average_active_workers: 1.0, average_queued_bytes: 2, average_queued_count: 3, diff --git a/crates/obs/src/metrics/scheduler.rs b/crates/obs/src/metrics/scheduler.rs index 088799d5e..29734268f 100644 --- a/crates/obs/src/metrics/scheduler.rs +++ b/crates/obs/src/metrics/scheduler.rs @@ -2811,14 +2811,14 @@ mod tests { #[test] fn replication_proxy_bucket_keys_detect_removed_buckets() { let previous = repl_proxy_bucket_live_keys(&[BucketReplicationRuntimeStats { - stats: crate::metrics::BucketReplicationStats { + stats: crate::metrics::BucketReplicationMetricsSnapshot { bucket: "photos".to_string(), ..Default::default() }, ..Default::default() }]); let current = repl_proxy_bucket_live_keys(&[BucketReplicationRuntimeStats { - stats: crate::metrics::BucketReplicationStats { + stats: crate::metrics::BucketReplicationMetricsSnapshot { bucket: "logs".to_string(), ..Default::default() }, diff --git a/crates/obs/src/metrics/stats_collector.rs b/crates/obs/src/metrics/stats_collector.rs index 20e461952..0d3863762 100644 --- a/crates/obs/src/metrics/stats_collector.rs +++ b/crates/obs/src/metrics/stats_collector.rs @@ -21,12 +21,12 @@ use crate::metrics::collectors::scanner::{ScannerActiveBucketDriveStats, ScannerBucketDriveResultStats, ScannerSourceWorkStats}; use crate::metrics::collectors::{ ApiRequestMetricSupport, ApiRequestStats, BucketReplicationBacklogStats, BucketReplicationBandwidthStats, - BucketReplicationRuntimeStats, BucketReplicationStats, BucketReplicationTargetBacklogStats, BucketReplicationTargetFlowStats, - BucketReplicationTargetStats, BucketStats, BucketUsageStats, ClusterConfigStats, ClusterHealthStats, ClusterStats, - ClusterUsageStats, CompressionClusterStats, CpuStats, DiskStats, DriveCountStats, DriveDetailedStats, - DriveRuntimeDetailedStats, ErasureSetStats, HostNetworkStats, IamStats, IlmActionTaskStats, IlmBackpressureStats, - IlmQueueTaskStats, IlmRuntimeStats, IlmStats, IlmTaskEventStats, MemoryStats, NetworkStats, ProcessStats, ProcessStatusType, - ReplicationStats, ResourceStats, ScannerRuntimeStats, ScannerStats, + BucketReplicationMetricsSnapshot, BucketReplicationRuntimeStats, BucketReplicationTargetBacklogStats, + BucketReplicationTargetFlowStats, BucketReplicationTargetStats, BucketStats, BucketUsageStats, ClusterConfigStats, + ClusterHealthStats, ClusterStats, ClusterUsageStats, CompressionClusterStats, CpuStats, DiskStats, DriveCountStats, + DriveDetailedStats, DriveRuntimeDetailedStats, ErasureSetStats, HostNetworkStats, IamStats, IlmActionTaskStats, + IlmBackpressureStats, IlmQueueTaskStats, IlmRuntimeStats, IlmStats, IlmTaskEventStats, MemoryStats, NetworkStats, + ProcessStats, ProcessStatusType, ReplicationMetricsSnapshot, ResourceStats, ScannerRuntimeStats, ScannerStats, }; use crate::metrics::runtime_sources::{ObsIlmRuntimeSnapshot, bucket_monitor_handle, iam_metrics_snapshot, ilm_runtime_snapshot}; use crate::metrics::{ @@ -266,7 +266,7 @@ fn bucket_replication_detail_from_snapshot(stats: ObsBucketReplicationStatsSnaps BucketReplicationRuntimeStats { target_flows, - stats: BucketReplicationStats { + stats: BucketReplicationMetricsSnapshot { bucket, total_failed_bytes: stats.total_failed_bytes, total_failed_count: stats.total_failed_count, @@ -298,7 +298,7 @@ fn bucket_replication_detail_from_snapshot(stats: ObsBucketReplicationStatsSnaps } } -async fn obs_site_replication_stats() -> ReplicationStats { +async fn obs_site_replication_stats() -> ReplicationMetricsSnapshot { let current_data_transfer_rate = obs_bucket_replication_bandwidth_stats() .into_iter() .flatten() @@ -306,7 +306,7 @@ async fn obs_site_replication_stats() -> ReplicationStats { .sum::(); let stats = obs_replication_site_stats_snapshot(current_data_transfer_rate).await; - ReplicationStats { + ReplicationMetricsSnapshot { average_active_workers: stats.average_active_workers, average_queued_bytes: stats.average_queued_bytes, average_queued_count: stats.average_queued_count, @@ -648,7 +648,7 @@ pub fn collect_bucket_replication_bandwidth_stats() -> Vec Vec { +pub async fn collect_bucket_replication_detail_stats() -> Vec { obs_bucket_replication_stats_snapshot() .await .into_iter() @@ -662,7 +662,7 @@ pub(crate) async fn collect_bucket_replication_stats_bundle() } /// Collect site-level replication stats from the global replication runtime. -pub async fn collect_replication_stats() -> ReplicationStats { +pub async fn collect_replication_stats() -> ReplicationMetricsSnapshot { obs_site_replication_stats().await } diff --git a/crates/scanner/Cargo.toml b/crates/scanner/Cargo.toml index 0e2d039c6..d941dce48 100644 --- a/crates/scanner/Cargo.toml +++ b/crates/scanner/Cargo.toml @@ -103,8 +103,7 @@ hex-simd.workspace = true [dev-dependencies] tracing-subscriber = { workspace = true, features = ["json", "env-filter", "time"] } -serial_test = { workspace = true } -temp-env = { workspace = true } +temp-env = { workspace = true, features = ["async_closure"] } tempfile = { workspace = true } uuid = { workspace = true, features = ["v4", "serde", "fast-rng", "macro-diagnostics"] } tokio = { workspace = true, features = ["test-util", "fs", "rt-multi-thread"] } diff --git a/crates/scanner/src/lib.rs b/crates/scanner/src/lib.rs index 0e347a8c1..a1e37f14e 100644 --- a/crates/scanner/src/lib.rs +++ b/crates/scanner/src/lib.rs @@ -599,10 +599,8 @@ impl ScannerConfigObjectDelete for ECStore { #[cfg(test)] mod tests { use super::*; - use serial_test::serial; #[tokio::test] - #[serial] async fn runtime_tier_names_serves_cached_arc_within_ttl() { reset_tier_name_cache_for_test(); // The tier config manager is unconfigured in unit tests, so the @@ -616,7 +614,6 @@ mod tests { } #[test] - #[serial] fn foreground_read_guard_tracks_stream_lifetime() { reset_foreground_read_activity_for_test(); assert_eq!(current_foreground_read_activity(), 0); @@ -630,7 +627,6 @@ mod tests { } #[test] - #[serial] fn foreground_read_activity_keeps_larger_signal() { reset_foreground_read_activity_for_test(); let _guard = ForegroundReadGuard::new(); @@ -643,7 +639,6 @@ mod tests { } #[test] - #[serial] fn scanner_runtime_guard_tracks_runtime_lifetime() { reset_scanner_runtime_instances_for_test(); assert!(!scanner_runtime_initialized()); diff --git a/crates/scanner/src/runtime_config.rs b/crates/scanner/src/runtime_config.rs index da951339d..48fb40d2d 100644 --- a/crates/scanner/src/runtime_config.rs +++ b/crates/scanner/src/runtime_config.rs @@ -868,7 +868,6 @@ mod tests { SCANNER_CYCLE_MAX_DIRECTORIES, SCANNER_CYCLE_MAX_DURATION, SCANNER_CYCLE_MAX_OBJECTS, SCANNER_DELAY, SCANNER_IDLE_MODE, SCANNER_SPEED, SCANNER_SUB_SYS, ScannerSpeed, }; - use serial_test::serial; use std::collections::HashMap; use std::time::Duration; use temp_env::{with_var, with_var_unset}; @@ -916,7 +915,6 @@ mod tests { } #[test] - #[serial] fn scanner_runtime_config_uses_persisted_values_when_env_is_unset() { let config = server_config_with_scanner(&[ (SCANNER_SPEED, "slow"), @@ -944,7 +942,6 @@ mod tests { } #[test] - #[serial] fn scanner_runtime_config_normalizes_persisted_default_speed() { let config = server_config_with_scanner(&[(SCANNER_SPEED, "default")]); @@ -960,7 +957,6 @@ mod tests { } #[test] - #[serial] fn scanner_runtime_config_prefers_env_over_persisted_config() { let config = server_config_with_scanner(&[(SCANNER_SPEED, "slowest"), (SCANNER_CYCLE, "600")]); @@ -977,7 +973,6 @@ mod tests { } #[test] - #[serial] fn scanner_runtime_config_prefers_heal_bitrot_cycle_over_scanner_compat_config() { let config = server_config_with_scanner_and_heal(&[(SCANNER_BITROT_CYCLE, "3600")], &[(HEAL_BITROT_CYCLE, "off")]); @@ -990,7 +985,6 @@ mod tests { } #[test] - #[serial] fn scanner_runtime_config_marks_scanner_bitrot_cycle_as_compat_source() { let config = server_config_with_scanner(&[(SCANNER_BITROT_CYCLE, "3600")]); @@ -1007,7 +1001,6 @@ mod tests { } #[test] - #[serial] fn scanner_runtime_config_normalizes_persisted_default_bitrot_cycles() { let default_cycle = DEFAULT_HEAL_BITROT_CYCLE_SECS.to_string(); for config in [ @@ -1032,7 +1025,6 @@ mod tests { } #[test] - #[serial] fn scanner_runtime_config_validation_rejects_invalid_persisted_speed_with_env_override() { let config = server_config_with_scanner(&[(SCANNER_SPEED, "warp")]); @@ -1066,7 +1058,6 @@ mod tests { } #[test] - #[serial] fn scanner_runtime_config_uses_derived_delay_for_excessive_env_override() { let config = server_config_with_scanner(&[(SCANNER_SPEED, "slow")]); @@ -1087,7 +1078,6 @@ mod tests { } #[test] - #[serial] fn scanner_runtime_config_status_reports_value_sources() { let config = server_config_with_scanner(&[(SCANNER_CYCLE_MAX_OBJECTS, "100"), (SCANNER_CACHE_SAVE_TIMEOUT, "5")]); @@ -1108,7 +1098,6 @@ mod tests { } #[test] - #[serial] fn applied_runtime_config_is_the_authoritative_scheduler_state() { let config = server_config_with_scanner(&[(SCANNER_CYCLE, "321")]); @@ -1125,7 +1114,6 @@ mod tests { } #[test] - #[serial] fn scanner_runtime_config_status_reports_persisted_pacing_overrides() { let config = server_config_with_scanner(&[("delay", "3.5"), ("max_wait", "7")]); @@ -1147,7 +1135,6 @@ mod tests { } #[test] - #[serial] fn scanner_runtime_config_status_prefers_env_pacing_overrides() { let config = server_config_with_scanner(&[("delay", "3.5"), ("max_wait", "7")]); @@ -1169,7 +1156,6 @@ mod tests { } #[test] - #[serial] fn scanner_runtime_config_status_preserves_subsecond_max_wait() { let config = server_config_with_scanner(&[(SCANNER_SPEED, "fast")]); diff --git a/crates/scanner/src/scanner/tests.rs b/crates/scanner/src/scanner/tests.rs index fd321bfc3..c40f91849 100644 --- a/crates/scanner/src/scanner/tests.rs +++ b/crates/scanner/src/scanner/tests.rs @@ -19,7 +19,6 @@ use crate::{ ScannerObjectInfo as ObjectInfo, ScannerObjectOptions as ObjectOptions, ScannerPutObjReader as PutObjReader, init_bucket_metadata_sys_for_scanner_tests, init_ecstore_config_for_scanner_tests, init_local_disks_with_instance_ctx, }; -use serial_test::serial; use std::collections::HashMap; use std::io::Cursor; use std::task::Poll; @@ -362,7 +361,6 @@ fn test_initial_scanner_delay_uses_configured_start_delay() { } #[test] -#[serial] fn test_initial_scanner_delay_uses_cycle_without_explicit_start_delay() { with_var(ENV_SCANNER_CYCLE, Some("120"), || { crate::runtime_config::refresh_scanner_runtime_config_for_tests(); @@ -409,7 +407,6 @@ fn test_initial_scanner_delay_keeps_delay_for_replication_without_buckets() { } #[test] -#[serial] fn test_scanner_cycle_max_duration_uses_env() { with_var(ENV_SCANNER_CYCLE_MAX_DURATION_SECS, Some("42"), || { assert_eq!(scanner_cycle_max_duration(), Some(Duration::from_secs(42))); @@ -417,7 +414,6 @@ fn test_scanner_cycle_max_duration_uses_env() { } #[test] -#[serial] fn test_scanner_cycle_max_duration_default_is_disabled() { with_var_unset(ENV_SCANNER_CYCLE_MAX_DURATION_SECS, || { assert_eq!(scanner_cycle_max_duration(), None); @@ -461,7 +457,6 @@ async fn test_scanner_cycle_budget_drop_cancels_child_without_elapsed() { } #[test] -#[serial] fn test_scanner_cycle_budget_config_uses_work_budget_env() { with_var(ENV_SCANNER_CYCLE_MAX_OBJECTS, Some("100"), || { with_var(ENV_SCANNER_CYCLE_MAX_DIRECTORIES, Some("25"), || { @@ -473,7 +468,6 @@ fn test_scanner_cycle_budget_config_uses_work_budget_env() { } #[test] -#[serial] fn test_scanner_cycle_budget_config_disables_zero_work_budgets() { with_var(ENV_SCANNER_CYCLE_MAX_OBJECTS, Some("0"), || { with_var(ENV_SCANNER_CYCLE_MAX_DIRECTORIES, Some("0"), || { @@ -516,7 +510,6 @@ fn test_scan_cycle_partial_source_maps_budget_reason() { } #[tokio::test] -#[serial] async fn test_mark_scan_cycle_idle_clears_published_cycle_state() { let mut cycle_info = CurrentCycle { current: 12, @@ -545,7 +538,6 @@ async fn test_mark_scan_cycle_idle_clears_published_cycle_state() { } #[tokio::test] -#[serial] async fn scanner_cycle_metrics_guard_covers_published_first_cycle_lifetime() { let cycle_started = Utc::now() - chrono::Duration::seconds(5); let mut cycle_info = CurrentCycle { @@ -572,7 +564,6 @@ async fn scanner_cycle_metrics_guard_covers_published_first_cycle_lifetime() { } #[tokio::test] -#[serial] async fn scanner_cycle_metrics_guard_keeps_active_cycle_published_during_finalization() { let mut cycle_info = CurrentCycle { current: 12, @@ -597,7 +588,6 @@ async fn scanner_cycle_metrics_guard_keeps_active_cycle_published_during_finaliz } #[tokio::test] -#[serial] async fn scanner_cycle_metrics_guard_drop_clears_activity() { let guard = ScannerCycleMetricsGuard::new(CurrentCycle { current: 12, @@ -615,7 +605,6 @@ async fn scanner_cycle_metrics_guard_drop_clears_activity() { } #[tokio::test] -#[serial] async fn run_data_scanner_cycle_publishes_activity_for_owner_lifetime() { let (_temp_dir, store) = setup_scanner_cycle_store().await; let ctx = CancellationToken::new(); @@ -666,7 +655,6 @@ async fn run_data_scanner_cycle_publishes_activity_for_owner_lifetime() { } #[tokio::test] -#[serial] async fn test_finalize_partial_scan_cycle_advances_and_persists_counter() { let store = Arc::new(MemoryConfigStore::default()); let ctx = CancellationToken::new(); @@ -702,7 +690,6 @@ async fn test_finalize_partial_scan_cycle_advances_and_persists_counter() { } #[tokio::test] -#[serial] async fn scanner_cycle_recovers_to_newer_durable_cache_floor() { let store = Arc::new(MemoryConfigStore::default()); let ctx = CancellationToken::new(); @@ -742,7 +729,6 @@ async fn scanner_cycle_recovers_to_newer_durable_cache_floor() { } #[tokio::test] -#[serial] async fn scanner_cycle_rejects_invalid_cache_floor() { let store = Arc::new(MemoryConfigStore::default()); let ctx = CancellationToken::new(); @@ -1013,7 +999,6 @@ async fn scanner_usage_floor_fails_closed_on_corrupt_or_exhausted_usage_state() } #[tokio::test] -#[serial] async fn scanner_usage_backup_uses_durable_cycle_cadence_across_tasks() { let store = Arc::new(MemoryConfigStore::default()); let ctx = CancellationToken::new(); @@ -1087,7 +1072,6 @@ fn scanner_cycle_advance_fails_before_reserved_exhausted_value() { } #[tokio::test] -#[serial] async fn test_finalize_partial_scan_cycle_reports_persist_failure() { let store = Arc::new(MemoryConfigStore::default()); let ctx = CancellationToken::new(); @@ -1111,7 +1095,6 @@ async fn test_finalize_partial_scan_cycle_reports_persist_failure() { } #[tokio::test] -#[serial] async fn test_persist_scanner_cycle_state_reconciles_newer_winner() { let store = Arc::new(MemoryConfigStore::default()); let ctx = CancellationToken::new(); @@ -1534,7 +1517,6 @@ async fn test_usage_save_route_barrier_prevents_missing_snapshot_creation() { } #[tokio::test] -#[serial] async fn test_usage_route_barrier_precedes_durable_reconciliation() { let store = Arc::new(MemoryConfigStore::default()); let key = memory_config_key(RUSTFS_META_BUCKET, DATA_USAGE_OBJ_NAME_PATH.as_str()); @@ -1562,7 +1544,6 @@ async fn test_usage_route_barrier_precedes_durable_reconciliation() { } #[tokio::test] -#[serial] async fn test_deferred_usage_save_keeps_last_real_save_metric() { let metrics = global_metrics(); metrics.record_scanner_usage_save_result(ScannerUsageSaveResult::Success); @@ -2626,7 +2607,6 @@ fn scanner_cycle_cache_floor_stays_pending_during_deferred_usage_publication() { } #[test] -#[serial] fn finalizing_a_saved_cycle_acknowledges_its_exact_dirty_snapshot() { crate::scanner_io::clear_dirty_usage_bucket("photos"); crate::scanner_io::record_dirty_usage_bucket("photos"); @@ -2653,7 +2633,6 @@ fn finalizing_a_saved_cycle_acknowledges_its_exact_dirty_snapshot() { } #[test] -#[serial] fn finalizing_a_deferred_usage_save_keeps_dirty_work_pending() { crate::scanner_io::clear_dirty_usage_bucket("photos"); crate::scanner_io::record_dirty_usage_bucket("photos"); @@ -2696,7 +2675,6 @@ async fn scanner_cycle_keeps_remote_pending_acknowledgement() { } #[test] -#[serial] fn finalizing_an_already_durable_cycle_acknowledges_its_exact_dirty_snapshot() { crate::scanner_io::clear_dirty_usage_bucket("photos"); crate::scanner_io::record_dirty_usage_bucket("photos"); @@ -2711,7 +2689,6 @@ fn finalizing_an_already_durable_cycle_acknowledges_its_exact_dirty_snapshot() { } #[test] -#[serial] fn finalizing_a_prior_same_cycle_snapshot_keeps_new_dirty_work_pending() { crate::scanner_io::clear_dirty_usage_bucket("photos"); crate::scanner_io::record_dirty_usage_bucket("photos"); @@ -2727,7 +2704,6 @@ fn finalizing_a_prior_same_cycle_snapshot_keeps_new_dirty_work_pending() { } #[test] -#[serial] fn finalizing_a_durable_superseded_snapshot_keeps_dirty_work_pending() { crate::scanner_io::clear_dirty_usage_bucket("photos"); crate::scanner_io::record_dirty_usage_bucket("photos"); @@ -2743,7 +2719,6 @@ fn finalizing_a_durable_superseded_snapshot_keeps_dirty_work_pending() { } #[test] -#[serial] fn data_usage_persist_wait_covers_cache_retries_and_backup() { with_var(rustfs_config::ENV_SCANNER_CACHE_SAVE_TIMEOUT_SECS, Some("7"), || { crate::runtime_config::refresh_scanner_runtime_config_for_tests(); @@ -2796,7 +2771,6 @@ async fn maintenance_feature_inspection_preserves_base_cycle_after_timeout() { } #[tokio::test(start_paused = true)] -#[serial] async fn stable_maintenance_detection_preserves_base_cycle_after_timeout() { let ctx = CancellationToken::new(); @@ -2862,7 +2836,6 @@ async fn maintenance_feature_inspection_stops_on_cancellation() { } #[test] -#[serial] fn test_cycle_interval_prefers_explicit_cycle_override() { with_var(ENV_SCANNER_SPEED, Some("slowest"), || { with_var(ENV_SCANNER_CYCLE, Some("42"), || { @@ -2872,7 +2845,6 @@ fn test_cycle_interval_prefers_explicit_cycle_override() { } #[test] -#[serial] fn test_cycle_interval_prefers_explicit_cycle_over_default_cycle() { let _guard = ScannerDefaultCycleGuard::set(TEST_DEFAULT_SCANNER_CYCLE_SECS); @@ -2882,7 +2854,6 @@ fn test_cycle_interval_prefers_explicit_cycle_over_default_cycle() { } #[test] -#[serial] fn test_cycle_interval_uses_scanner_default_speed_override_when_unconfigured() { let _guard = ScannerDefaultSpeedGuard::set(ScannerSpeed::Slowest); @@ -2892,7 +2863,6 @@ fn test_cycle_interval_uses_scanner_default_speed_override_when_unconfigured() { } #[test] -#[serial] fn test_cycle_interval_prefers_explicit_speed_over_default_speed_override() { let _guard = ScannerDefaultSpeedGuard::set(ScannerSpeed::Slowest); @@ -2910,7 +2880,6 @@ fn test_cycle_interval_prefers_explicit_speed_over_default_speed_override() { } #[test] -#[serial] fn test_cycle_interval_uses_default_cycle_override_when_unconfigured() { let _guard = ScannerDefaultCycleGuard::set(TEST_DEFAULT_SCANNER_CYCLE_SECS); @@ -3074,7 +3043,6 @@ fn scanner_cycle_wait_plan_drives_growth_resets_and_bitrot_cap() { } #[test] -#[serial] fn scanner_cycle_schedule_status_reports_effective_backoff() { record_scanner_cycle_schedule(Duration::from_millis(86_400_001), true, 2_048, true, 7); @@ -3354,7 +3322,6 @@ fn dirty_usage_wakes_are_disabled_for_explicit_cycle_policy() { } #[test] -#[serial] fn clean_idle_cap_preserves_default_bitrot_coverage_window() { let config = ScannerRuntimeConfig { bitrot_cycle: Some(Duration::from_secs(30 * 24 * 60 * 60)), @@ -3384,7 +3351,6 @@ fn clean_idle_cap_allows_policy_max_when_bitrot_is_disabled() { } #[test] -#[serial] fn clean_idle_cap_never_shortens_the_base_cycle() { let config = ScannerRuntimeConfig { bitrot_cycle: Some(Duration::from_secs(60)), @@ -3398,7 +3364,6 @@ fn clean_idle_cap_never_shortens_the_base_cycle() { } #[test] -#[serial] fn test_cycle_interval_keeps_default_cycle_with_explicit_speed() { let _guard = ScannerDefaultCycleGuard::set(TEST_DEFAULT_SCANNER_CYCLE_SECS); @@ -3416,7 +3381,6 @@ fn test_cycle_interval_keeps_default_cycle_with_explicit_speed() { } #[test] -#[serial] fn test_cycle_interval_prefers_explicit_start_delay_over_default_cycle() { let _guard = ScannerDefaultCycleGuard::set(TEST_DEFAULT_SCANNER_CYCLE_SECS); @@ -3430,7 +3394,6 @@ fn test_cycle_interval_prefers_explicit_start_delay_over_default_cycle() { } #[test] -#[serial] fn test_cycle_interval_supports_minio_speed_alias() { with_var_unset(ENV_SCANNER_SPEED, || { with_var_unset(ENV_SCANNER_CYCLE, || { @@ -3444,7 +3407,6 @@ fn test_cycle_interval_supports_minio_speed_alias() { } #[test] -#[serial] fn test_cycle_interval_supports_minio_cycle_alias() { with_var_unset(ENV_SCANNER_CYCLE, || { with_var_unset(ENV_SCANNER_START_DELAY_SECS, || { @@ -3464,7 +3426,6 @@ fn test_randomized_cycle_delay_handles_small_start_delay() { } #[tokio::test] -#[serial] async fn test_wait_for_next_scanner_cycle_wakes_for_dirty_usage() { crate::scanner_io::clear_dirty_usage_buckets_for_tests(); @@ -3490,7 +3451,6 @@ async fn test_wait_for_next_scanner_cycle_wakes_for_dirty_usage() { } #[tokio::test] -#[serial] async fn test_wait_for_next_scanner_cycle_sees_unattempted_dirty_usage() { crate::scanner_io::clear_dirty_usage_buckets_for_tests(); let dirty_generation = crate::scanner_io::dirty_usage_generation(); @@ -3512,7 +3472,6 @@ async fn test_wait_for_next_scanner_cycle_sees_unattempted_dirty_usage() { } #[tokio::test(start_paused = true)] -#[serial] async fn test_wait_for_next_scanner_cycle_retries_stable_dirty_usage_on_timer() { crate::scanner_io::clear_dirty_usage_buckets_for_tests(); crate::scanner_io::record_dirty_usage_bucket("photos"); @@ -3534,7 +3493,6 @@ async fn test_wait_for_next_scanner_cycle_retries_stable_dirty_usage_on_timer() } #[tokio::test(start_paused = true)] -#[serial] async fn test_wait_for_next_scanner_cycle_can_defer_dirty_wakes_until_timer() { crate::scanner_io::clear_dirty_usage_buckets_for_tests(); let ctx = CancellationToken::new(); @@ -3553,7 +3511,6 @@ async fn test_wait_for_next_scanner_cycle_can_defer_dirty_wakes_until_timer() { } #[tokio::test] -#[serial] async fn test_wait_for_next_scanner_cycle_wakes_for_repeated_dirty_bucket() { crate::scanner_io::clear_dirty_usage_buckets_for_tests(); crate::scanner_io::record_dirty_usage_bucket("photos"); @@ -3579,7 +3536,6 @@ async fn test_wait_for_next_scanner_cycle_wakes_for_repeated_dirty_bucket() { } #[tokio::test] -#[serial] async fn test_wait_for_next_scanner_cycle_reschedules_for_runtime_config() { crate::scanner_io::clear_dirty_usage_buckets_for_tests(); let observed_generation = crate::runtime_config::scanner_runtime_config_generation(); @@ -3607,7 +3563,6 @@ async fn test_wait_for_next_scanner_cycle_reschedules_for_runtime_config() { } #[tokio::test] -#[serial] async fn test_wait_for_next_scanner_cycle_reschedules_for_maintenance_change() { crate::scanner_io::clear_dirty_usage_buckets_for_tests(); let observed_generation = crate::scanner_io::scanner_maintenance_generation(); @@ -3851,7 +3806,6 @@ fn scanner_activity_after_a_cycle_restores_the_base_interval() { } #[tokio::test(start_paused = true)] -#[serial] async fn distributed_clean_idle_wait_wakes_at_base_interval_for_remote_activity() { crate::scanner_io::clear_dirty_usage_buckets_for_tests(); let ctx = CancellationToken::new(); @@ -3879,7 +3833,6 @@ async fn distributed_clean_idle_wait_wakes_at_base_interval_for_remote_activity( } #[tokio::test(start_paused = true)] -#[serial] async fn superseded_retry_wait_defers_dirty_cluster_activity_until_timer() { crate::scanner_io::clear_dirty_usage_buckets_for_tests(); let ctx = CancellationToken::new(); @@ -3907,7 +3860,6 @@ async fn superseded_retry_wait_defers_dirty_cluster_activity_until_timer() { } #[tokio::test(start_paused = true)] -#[serial] async fn distributed_clean_idle_wait_blocks_backoff_for_unpropagated_maintenance() { crate::scanner_io::clear_dirty_usage_buckets_for_tests(); let ctx = CancellationToken::new(); @@ -3934,7 +3886,6 @@ async fn distributed_clean_idle_wait_blocks_backoff_for_unpropagated_maintenance } #[tokio::test(start_paused = true)] -#[serial] async fn distributed_clean_idle_wait_fails_closed_when_a_peer_is_unverifiable() { crate::scanner_io::clear_dirty_usage_buckets_for_tests(); let ctx = CancellationToken::new(); @@ -3961,7 +3912,6 @@ async fn distributed_clean_idle_wait_fails_closed_when_a_peer_is_unverifiable() } #[tokio::test(start_paused = true)] -#[serial] async fn distributed_clean_idle_wait_keeps_the_extended_deadline_when_peers_are_clean() { crate::scanner_io::clear_dirty_usage_buckets_for_tests(); let ctx = CancellationToken::new(); @@ -3989,7 +3939,6 @@ async fn distributed_clean_idle_wait_keeps_the_extended_deadline_when_peers_are_ } #[tokio::test(start_paused = true)] -#[serial] async fn scanner_activity_probe_wait_is_cancellation_aware() { crate::scanner_io::clear_dirty_usage_buckets_for_tests(); let ctx = CancellationToken::new(); @@ -4020,7 +3969,6 @@ async fn scanner_activity_probe_wait_is_cancellation_aware() { } #[tokio::test(start_paused = true)] -#[serial] async fn scanner_activity_probe_wait_stops_after_leader_lock_loss() { crate::scanner_io::clear_dirty_usage_buckets_for_tests(); let ctx = CancellationToken::new(); @@ -4052,7 +4000,6 @@ async fn scanner_activity_probe_wait_stops_after_leader_lock_loss() { } #[test] -#[serial] fn test_get_cycle_scan_mode_runs_deep_until_selection_window_completes() { with_var(ENV_SCANNER_BITROT_CYCLE_SECS, Some("3600"), || { let mode = get_cycle_scan_mode(10, 0, Some(Utc::now()), bitrot_scan_cycle()); @@ -4061,7 +4008,6 @@ fn test_get_cycle_scan_mode_runs_deep_until_selection_window_completes() { } #[test] -#[serial] fn test_get_cycle_scan_mode_respects_elapsed_bitrot_cycle() { with_var(ENV_SCANNER_BITROT_CYCLE_SECS, Some("3600"), || { let recent = Utc::now() - chrono::Duration::minutes(30); @@ -4073,7 +4019,6 @@ fn test_get_cycle_scan_mode_respects_elapsed_bitrot_cycle() { } #[test] -#[serial] fn test_get_cycle_scan_mode_can_disable_periodic_deep_scan() { with_var(ENV_SCANNER_BITROT_CYCLE_SECS, Some("off"), || { assert_eq!(get_cycle_scan_mode(1, 0, None, bitrot_scan_cycle()), HealScanMode::Normal); @@ -4081,7 +4026,6 @@ fn test_get_cycle_scan_mode_can_disable_periodic_deep_scan() { } #[test] -#[serial] fn test_background_heal_info_for_scan_start_marks_deep_active() { let now = Utc::now(); let info = @@ -4094,7 +4038,6 @@ fn test_background_heal_info_for_scan_start_marks_deep_active() { } #[test] -#[serial] fn test_background_heal_info_for_scan_start_keeps_deep_window_start() { with_var_unset(ENV_SCANNER_BITROT_CYCLE_SECS, || { let started_at = Utc::now(); diff --git a/crates/scanner/src/scanner_folder/tests.rs b/crates/scanner/src/scanner_folder/tests.rs index dc4460b15..503b0e75f 100644 --- a/crates/scanner/src/scanner_folder/tests.rs +++ b/crates/scanner/src/scanner_folder/tests.rs @@ -18,7 +18,6 @@ use super::*; use crate::storage_api::VersionPurgeStatusType; use crate::{DiskOption, Endpoint, STORAGE_FORMAT_FILE, TierStats, new_disk, storageclass}; use rustfs_filemeta::{FileInfo, FileMeta}; -use serial_test::serial; use std::io::Write; #[cfg(unix)] use std::os::unix::fs::{PermissionsExt, symlink}; @@ -356,7 +355,6 @@ impl Drop for TestGuard { } #[tokio::test] -#[serial] async fn test_should_skip_failed_respects_ttl() { let (mut scanner, temp_dir) = build_test_scanner().await; let _guard = TestGuard::new(60, 100, &mut scanner, temp_dir); @@ -378,7 +376,6 @@ async fn test_should_skip_failed_respects_ttl() { } #[tokio::test] -#[serial] async fn test_record_failed_ttl_zero_noop() { let (mut scanner, temp_dir) = build_test_scanner().await; let _guard = TestGuard::new(0, 100, &mut scanner, temp_dir); @@ -467,7 +464,6 @@ fn test_should_account_replication_stats_only_for_live_object_versions() { } #[tokio::test] -#[serial] async fn test_heal_replication_only_queues_pending_null_deletes() { async fn replication_skipped_count() -> u64 { global_metrics() @@ -716,7 +712,6 @@ async fn test_scanner_heal_admission_accounting_maps_deep_scan_to_bitrot() { } #[test] -#[serial] fn test_excessive_version_alert_thresholds_use_env() { with_var(rustfs_config::ENV_SCANNER_ALERT_EXCESS_VERSIONS, Some("3"), || { with_var(rustfs_config::ENV_SCANNER_ALERT_EXCESS_VERSION_SIZE, Some("100"), || { @@ -731,7 +726,6 @@ fn test_excessive_version_alert_thresholds_use_env() { } #[test] -#[serial] fn test_excessive_folders_threshold_uses_env() { with_var(rustfs_config::ENV_SCANNER_ALERT_EXCESS_FOLDERS, Some("3"), || { crate::runtime_config::refresh_scanner_runtime_config_for_tests(); @@ -741,7 +735,6 @@ fn test_excessive_folders_threshold_uses_env() { } #[test] -#[serial] fn test_excessive_folders_threshold_default_supports_pbs_layout() { with_var_unset(rustfs_config::ENV_SCANNER_ALERT_EXCESS_FOLDERS, || { crate::runtime_config::refresh_scanner_runtime_config_for_tests(); @@ -751,7 +744,6 @@ fn test_excessive_folders_threshold_default_supports_pbs_layout() { } #[test] -#[serial] fn test_scanner_yield_every_n_objects_uses_env() { with_var(rustfs_config::ENV_SCANNER_YIELD_EVERY_N_OBJECTS, Some("32"), || { crate::runtime_config::refresh_scanner_runtime_config_for_tests(); @@ -761,7 +753,6 @@ fn test_scanner_yield_every_n_objects_uses_env() { } #[test] -#[serial] fn test_scanner_yield_every_n_objects_uses_default() { with_var_unset(rustfs_config::ENV_SCANNER_YIELD_EVERY_N_OBJECTS, || { crate::runtime_config::refresh_scanner_runtime_config_for_tests(); @@ -888,7 +879,6 @@ fn test_order_folders_for_resume_reports_stale_hint() { } #[tokio::test] -#[serial] async fn test_record_failed_prunes_to_max_entries() { let (mut scanner, temp_dir) = build_test_scanner().await; let _guard = TestGuard::new(1000, 2, &mut scanner, temp_dir); @@ -920,7 +910,6 @@ async fn test_record_failed_prunes_to_max_entries() { } #[tokio::test] -#[serial] async fn test_prune_failed_objects_cache_drops_expired() { let (mut scanner, temp_dir) = build_test_scanner().await; let _guard = TestGuard::new(5, 10, &mut scanner, temp_dir); @@ -944,7 +933,6 @@ async fn test_prune_failed_objects_cache_drops_expired() { } #[tokio::test] -#[serial] async fn test_prune_failed_objects_max_zero_keeps_fresh() { let (mut scanner, temp_dir) = build_test_scanner().await; let _guard = TestGuard::new(60, 0, &mut scanner, temp_dir); @@ -1701,7 +1689,6 @@ async fn test_heal_actions_returns_actual_size_without_inline_heal() { } #[tokio::test] -#[serial] #[cfg(unix)] async fn test_scan_folder_skips_unreadable_child_directory() { let (mut scanner, temp_dir) = build_test_scanner().await; @@ -1734,7 +1721,6 @@ async fn test_scan_folder_skips_unreadable_child_directory() { } #[tokio::test] -#[serial] async fn test_scan_folder_exits_when_abandoned_child_listing_finishes() { let (mut scanner, temp_dir) = build_test_scanner().await; let _guard = TestGuard::new(60, 100, &mut scanner, temp_dir.clone()); @@ -1813,7 +1799,6 @@ async fn test_scan_folder_exits_when_abandoned_child_listing_finishes() { } #[tokio::test] -#[serial] async fn test_scan_folder_xl_meta_named_directory_uses_namespace_descent() { let (mut scanner, temp_dir) = build_test_scanner().await; let _guard = TestGuard::new(60, 100, &mut scanner, temp_dir.clone()); @@ -1859,7 +1844,6 @@ async fn test_scan_folder_xl_meta_named_directory_uses_namespace_descent() { } #[tokio::test(flavor = "current_thread")] -#[serial] async fn test_scan_folder_corrupt_xl_meta_stops_erasure_data_dir_descent() { let logs = CapturedLogs::default(); let subscriber = tracing_subscriber::fmt() @@ -2021,7 +2005,6 @@ async fn test_scan_folder_corrupt_xl_meta_stops_erasure_data_dir_descent() { } #[tokio::test] -#[serial] async fn test_scan_folder_missing_xl_meta_stops_erasure_data_dir_descent() { let (mut scanner, temp_dir) = build_test_scanner().await; let _guard = TestGuard::new(60, 100, &mut scanner, temp_dir.clone()); @@ -2099,7 +2082,6 @@ async fn test_scan_folder_missing_xl_meta_stops_erasure_data_dir_descent() { } #[tokio::test] -#[serial] async fn test_scan_folder_uuid_namespace_part_name_directory_is_not_data_dir() { let (mut scanner, temp_dir) = build_test_scanner().await; let _guard = TestGuard::new(60, 100, &mut scanner, temp_dir.clone()); @@ -2161,7 +2143,6 @@ async fn test_scan_folder_uuid_namespace_part_name_directory_is_not_data_dir() { } #[tokio::test] -#[serial] async fn test_scan_folder_non_erasure_metadata_keeps_namespace_descent() { let (mut scanner, temp_dir) = build_test_scanner().await; let _guard = TestGuard::new(60, 100, &mut scanner, temp_dir.clone()); @@ -2203,7 +2184,6 @@ async fn test_scan_folder_non_erasure_metadata_keeps_namespace_descent() { } #[tokio::test] -#[serial] async fn test_scan_folder_compacted_parent_sends_partial_update() { let (mut scanner, temp_dir) = build_test_scanner().await; let _guard = TestGuard::new(60, 100, &mut scanner, temp_dir.clone()); @@ -2245,7 +2225,6 @@ async fn test_scan_folder_compacted_parent_sends_partial_update() { } #[tokio::test] -#[serial] async fn test_scan_data_folder_cancelled_before_scan_clears_current_path() { let (scanner, temp_dir) = build_test_scanner().await; let _guard = TestGuard { @@ -2290,7 +2269,6 @@ async fn test_scan_data_folder_cancelled_before_scan_clears_current_path() { } #[tokio::test] -#[serial] async fn test_scan_data_folder_returns_partial_cache_on_budget_cancel() { let (mut scanner, temp_dir) = build_test_scanner().await; let _guard = TestGuard::new(60, 100, &mut scanner, temp_dir.clone()); @@ -2346,7 +2324,6 @@ async fn test_scan_data_folder_returns_partial_cache_on_budget_cancel() { } #[tokio::test] -#[serial] async fn test_scan_data_folder_reports_invalid_checkpoint_ignored_once() { let (scanner, temp_dir) = build_test_scanner().await; let _guard = TestGuard { @@ -2391,7 +2368,6 @@ async fn test_scan_data_folder_reports_invalid_checkpoint_ignored_once() { } #[tokio::test] -#[serial] async fn test_scan_data_folder_resume_hint_prioritizes_next_existing_folder() { let (scanner, temp_dir) = build_test_scanner().await; let _guard = TestGuard { @@ -2465,7 +2441,6 @@ async fn test_scan_data_folder_resume_hint_prioritizes_next_existing_folder() { } #[tokio::test] -#[serial] async fn scan_data_folder_missing_bucket_returns_partial() { let (scanner, temp_dir) = build_test_scanner().await; let _guard = TestGuard { @@ -2517,7 +2492,6 @@ async fn scan_data_folder_missing_bucket_returns_partial() { } #[tokio::test] -#[serial] async fn scan_data_folder_missing_scan_root_returns_partial() { let (scanner, temp_dir) = build_test_scanner().await; tokio::fs::remove_dir_all(&temp_dir) @@ -2563,7 +2537,6 @@ async fn scan_data_folder_missing_scan_root_returns_partial() { } #[tokio::test] -#[serial] async fn test_scan_data_folder_resume_hint_orders_across_new_and_existing_folders() { let (scanner, temp_dir) = build_test_scanner().await; let _guard = TestGuard { @@ -2632,7 +2605,6 @@ async fn test_scan_data_folder_resume_hint_orders_across_new_and_existing_folder } #[tokio::test] -#[serial] async fn test_scan_data_folder_partial_object_budget_accumulates_progress() { let (scanner, temp_dir) = build_test_scanner().await; let _guard = TestGuard { @@ -2715,7 +2687,6 @@ async fn test_scan_data_folder_partial_object_budget_accumulates_progress() { } #[tokio::test] -#[serial] async fn test_partial_compacted_entry_does_not_carry_children() { let (mut scanner, temp_dir) = build_test_scanner().await; let _guard = TestGuard { @@ -2761,7 +2732,6 @@ async fn test_partial_compacted_entry_does_not_carry_children() { } #[tokio::test] -#[serial] async fn test_partial_entry_does_not_carry_missing_old_child() { let (mut scanner, temp_dir) = build_test_scanner().await; let _guard = TestGuard { @@ -2794,7 +2764,6 @@ async fn test_partial_entry_does_not_carry_missing_old_child() { } #[tokio::test] -#[serial] async fn test_legacy_windows_cache_rebuilds_and_round_trips_portable_keys() { let (scanner, temp_dir) = build_test_scanner().await; let _guard = TestGuard { @@ -2861,7 +2830,6 @@ async fn test_legacy_windows_cache_rebuilds_and_round_trips_portable_keys() { } #[tokio::test] -#[serial] async fn test_scan_data_folder_success_clears_resume_hint() { let (scanner, temp_dir) = build_test_scanner().await; let _guard = TestGuard { @@ -2904,7 +2872,6 @@ async fn test_scan_data_folder_success_clears_resume_hint() { } #[tokio::test] -#[serial] async fn test_scan_data_folder_keeps_unresolved_objects_partial() { let (scanner, temp_dir) = build_test_scanner().await; let _guard = TestGuard { @@ -2951,7 +2918,6 @@ async fn test_scan_data_folder_keeps_unresolved_objects_partial() { } #[tokio::test] -#[serial] #[cfg(unix)] async fn test_scan_folder_ignores_symlinked_child_directory() { let (mut scanner, temp_dir) = build_test_scanner().await; diff --git a/crates/scanner/src/scanner_io/tests.rs b/crates/scanner/src/scanner_io/tests.rs index e6ef3bafb..9d2c1586d 100644 --- a/crates/scanner/src/scanner_io/tests.rs +++ b/crates/scanner/src/scanner_io/tests.rs @@ -27,7 +27,6 @@ use crate::{ init_local_disks_with_instance_ctx, new_disk, path2_bucket_object_with_base_path, }; use rustfs_filemeta::FileInfo; -use serial_test::serial; use temp_env::with_var; use time::OffsetDateTime; use uuid::Uuid; @@ -103,7 +102,6 @@ async fn setup_two_pool_scanner_store() -> (tempfile::TempDir, Arc) { } #[tokio::test] -#[serial] async fn scanner_cache_locks_block_same_source_workers() { let (_temp_dir, store) = setup_two_pool_scanner_store().await; let set = &store.pools[0].disk_set[0]; @@ -130,7 +128,6 @@ async fn scanner_cache_locks_block_same_source_workers() { } #[tokio::test] -#[serial] async fn scanner_cache_locks_allow_cross_source_workers() { let (_temp_dir, store) = setup_two_pool_scanner_store().await; let first_set = &store.pools[0].disk_set[0]; @@ -149,7 +146,6 @@ async fn scanner_cache_locks_allow_cross_source_workers() { } #[tokio::test] -#[serial] async fn scanner_cycle_is_deferred_while_rebalance_is_active() { let (_temp_dir, store) = setup_two_pool_scanner_store().await; let mut pool_stats = vec![EcstoreRebalanceStats::default(); store.pools.len()]; @@ -185,7 +181,6 @@ async fn scanner_cycle_is_deferred_while_rebalance_is_active() { } #[tokio::test] -#[serial] async fn scanner_cycle_is_deferred_while_terminal_decommission_is_blocked() { let (_temp_dir, store) = setup_two_pool_scanner_store().await; for decommission in [ @@ -230,7 +225,6 @@ async fn data_usage_publish_fails_when_receiver_is_closed() { } #[tokio::test] -#[serial] async fn multi_pool_scanner_cycle_publishes_combined_usage() { let (_temp_dir, store) = setup_two_pool_scanner_store().await; let bucket = format!("scanner-union-{}", Uuid::new_v4().simple()); @@ -278,7 +272,6 @@ async fn multi_pool_scanner_cycle_publishes_combined_usage() { } #[tokio::test] -#[serial] async fn multi_pool_scanner_cycle_zero_fills_bucket_absent_from_first_pool() { let (_temp_dir, store) = setup_two_pool_scanner_store().await; let bucket = format!("scanner-second-pool-{}", Uuid::new_v4().simple()); @@ -366,7 +359,6 @@ fn object_lock_config_enabled_accepts_enabled_only() { } #[test] -#[serial] fn dirty_usage_snapshot_clear_preserves_newer_generation() { clear_dirty_usage_buckets_for_tests(); record_dirty_usage_bucket("photos"); @@ -381,7 +373,6 @@ fn dirty_usage_snapshot_clear_preserves_newer_generation() { } #[test] -#[serial] fn dirty_usage_generation_acknowledgement_preserves_newer_mutations() { clear_dirty_usage_buckets_for_tests(); record_dirty_usage_bucket("photos"); @@ -407,7 +398,6 @@ fn dirty_usage_generation_acknowledgement_preserves_newer_mutations() { } #[test] -#[serial] fn dirty_usage_generation_acknowledgement_rejects_stale_process_and_future_generation() { clear_dirty_usage_buckets_for_tests(); record_dirty_usage_bucket("photos"); @@ -437,7 +427,6 @@ fn dirty_usage_generation_acknowledgement_rejects_stale_process_and_future_gener } #[test] -#[serial] fn dirty_usage_snapshot_detects_uncovered_generation() { clear_dirty_usage_buckets_for_tests(); record_dirty_usage_bucket("photos"); @@ -462,7 +451,6 @@ fn generation_saturates_instead_of_wrapping() { } #[test] -#[serial] fn dirty_usage_snapshot_clears_a_stably_absent_bucket_after_durable_save() { clear_dirty_usage_buckets_for_tests(); record_dirty_usage_bucket("photos"); @@ -484,7 +472,6 @@ fn dirty_usage_snapshot_clears_a_stably_absent_bucket_after_durable_save() { } #[test] -#[serial] fn dirty_usage_snapshot_preserves_an_absent_bucket_recorded_after_listing_started() { clear_dirty_usage_buckets_for_tests(); let generation_before_bucket_list = dirty_usage_generation(); @@ -499,7 +486,6 @@ fn dirty_usage_snapshot_preserves_an_absent_bucket_recorded_after_listing_starte } #[test] -#[serial] fn deleting_a_clean_bucket_invalidates_an_inflight_usage_snapshot() { clear_dirty_usage_buckets_for_tests(); let snapshot = snapshot_dirty_usage_buckets(&[bucket_info("photos")], dirty_usage_generation()); @@ -513,7 +499,6 @@ fn deleting_a_clean_bucket_invalidates_an_inflight_usage_snapshot() { } #[test] -#[serial] fn deleting_a_bucket_during_listing_invalidates_the_resulting_usage_snapshot() { clear_dirty_usage_buckets_for_tests(); let generation_before_bucket_list = dirty_usage_generation(); @@ -527,7 +512,6 @@ fn deleting_a_bucket_during_listing_invalidates_the_resulting_usage_snapshot() { } #[test] -#[serial] fn scanner_maintenance_change_advances_generation_and_marks_usage_dirty() { clear_dirty_usage_buckets_for_tests(); let generation = scanner_maintenance_generation(); @@ -540,7 +524,6 @@ fn scanner_maintenance_change_advances_generation_and_marks_usage_dirty() { } #[test] -#[serial] fn dirty_usage_clear_excludes_failed_buckets() { clear_dirty_usage_buckets_for_tests(); record_dirty_usage_bucket("photos"); @@ -572,7 +555,6 @@ fn dirty_usage_clear_plan_excludes_cache_save_failures() { } #[test] -#[serial] fn dirty_usage_is_acknowledged_only_after_durable_usage_confirmation() { clear_dirty_usage_buckets_for_tests(); record_dirty_usage_bucket("photos"); @@ -590,7 +572,6 @@ fn dirty_usage_is_acknowledged_only_after_durable_usage_confirmation() { } #[test] -#[serial] fn clear_dirty_usage_bucket_removes_deleted_bucket_marker() { clear_dirty_usage_buckets_for_tests(); record_dirty_usage_bucket("photos"); @@ -917,35 +898,30 @@ async fn bucket_cache_pending_heal_reaches_cycle_maintenance_state() { } #[test] -#[serial] fn scanner_concurrency_limit_preserves_available_when_unconfigured() { crate::reset_foreground_read_activity_for_test(); assert_eq!(scanner_concurrency_limit(0, 4), 4); } #[test] -#[serial] fn scanner_concurrency_limit_caps_to_configured_value() { crate::reset_foreground_read_activity_for_test(); assert_eq!(scanner_concurrency_limit(2, 4), 2); } #[test] -#[serial] fn scanner_concurrency_limit_never_exceeds_available_work() { crate::reset_foreground_read_activity_for_test(); assert_eq!(scanner_concurrency_limit(8, 4), 4); } #[test] -#[serial] fn scanner_concurrency_limit_handles_no_available_work() { crate::reset_foreground_read_activity_for_test(); assert_eq!(scanner_concurrency_limit(2, 0), 0); } #[test] -#[serial] fn scanner_concurrency_limit_yields_to_foreground_reads() { crate::reset_foreground_read_activity_for_test(); crate::set_foreground_read_activity(8); @@ -955,7 +931,6 @@ fn scanner_concurrency_limit_yields_to_foreground_reads() { } #[test] -#[serial] fn scanner_concurrency_limit_yields_to_streaming_reads() { crate::reset_foreground_read_activity_for_test(); let _guard = crate::ForegroundReadGuard::new(); @@ -979,7 +954,6 @@ fn increment_atomic_usize_saturates_at_max() { } #[test] -#[serial] fn scanner_max_concurrent_set_scans_uses_env_cap() { with_var(ENV_SCANNER_MAX_CONCURRENT_SET_SCANS, Some("2"), || { crate::runtime_config::refresh_scanner_runtime_config_for_tests(); @@ -989,7 +963,6 @@ fn scanner_max_concurrent_set_scans_uses_env_cap() { } #[test] -#[serial] fn scanner_max_concurrent_disk_scans_uses_env_cap() { with_var(ENV_SCANNER_MAX_CONCURRENT_DISK_SCANS, Some("1"), || { crate::runtime_config::refresh_scanner_runtime_config_for_tests(); diff --git a/crates/scanner/src/sleeper.rs b/crates/scanner/src/sleeper.rs index 200b97e08..de46d53ef 100644 --- a/crates/scanner/src/sleeper.rs +++ b/crates/scanner/src/sleeper.rs @@ -258,7 +258,6 @@ impl SleepTimer { #[cfg(test)] mod tests { use super::*; - use serial_test::serial; use temp_env::{with_var, with_var_unset}; struct ScannerDefaultSpeedGuard; @@ -326,7 +325,6 @@ mod tests { } #[test] - #[serial] fn test_refresh_from_env_applies_speed_and_idle_mode_for_next_cycle() { let prev_mode = SCANNER_IDLE_MODE.load(Ordering::Relaxed); SCANNER_IDLE_MODE.store(true, Ordering::Relaxed); @@ -346,7 +344,6 @@ mod tests { } #[test] - #[serial] fn test_refresh_from_env_uses_default_speed_override_when_speed_unset() { let _guard = ScannerDefaultSpeedGuard::set(ScannerSpeed::Slowest); let s = DynamicSleeper::new(ScannerSpeed::Default); @@ -362,7 +359,6 @@ mod tests { } #[tokio::test(start_paused = true)] - #[serial] async fn test_fastest_never_sleeps() { let prev_mode = SCANNER_IDLE_MODE.load(Ordering::Relaxed); SCANNER_IDLE_MODE.store(true, Ordering::Relaxed); @@ -376,7 +372,6 @@ mod tests { } #[tokio::test(start_paused = true)] - #[serial] async fn test_idle_mode_off_skips_sleep() { let prev_mode = SCANNER_IDLE_MODE.load(Ordering::Relaxed); SCANNER_IDLE_MODE.store(false, Ordering::Relaxed); diff --git a/crates/scanner/tests/lifecycle_integration_test.rs b/crates/scanner/tests/lifecycle_integration_test.rs index 12d928513..22e42732e 100644 --- a/crates/scanner/tests/lifecycle_integration_test.rs +++ b/crates/scanner/tests/lifecycle_integration_test.rs @@ -14,7 +14,6 @@ #![recursion_limit = "256"] -use futures::FutureExt; use rustfs_config::ENV_TEST_FORCE_IMMEDIATE_TRANSITION_ENQUEUE_TIMEOUT; use rustfs_scanner::scanner_folder::ScannerItem; use rustfs_scanner::scanner_io::ScannerIODisk; @@ -23,10 +22,8 @@ use rustfs_scanner::{ scanner::init_data_scanner, }; use s3s::dto::RestoreRequest; -use serial_test::serial; use std::{ collections::HashMap, - env, path::{Path, PathBuf}, sync::{Arc, Once, OnceLock}, time::Duration, @@ -535,31 +532,15 @@ async fn wait_for_transition(ecstore: &Arc, bucket: &str, object: &str, } } -// SAFETY: this helper is used only by `#[serial]` tests and runs under the single-threaded Tokio -// runtime (`worker_threads = 1`), so no concurrent test can mutate process environment during the -// `env::set_var` / `env::remove_var` window. -#[allow(unsafe_code)] +// Run `test_fn` with `ENV_TEST_FORCE_IMMEDIATE_TRANSITION_ENQUEUE_TIMEOUT` +// set to `"1"` for its duration. `temp_env` serializes environment mutations +// globally, preventing data races when multiple tests run in parallel. async fn with_forced_immediate_enqueue_timeout(test_fn: F) where F: FnOnce() -> Fut, Fut: std::future::Future, { - let original = env::var_os(ENV_TEST_FORCE_IMMEDIATE_TRANSITION_ENQUEUE_TIMEOUT); - unsafe { - env::set_var(ENV_TEST_FORCE_IMMEDIATE_TRANSITION_ENQUEUE_TIMEOUT, "1"); - } - let result = std::panic::AssertUnwindSafe(test_fn()).catch_unwind().await; - match original { - Some(value) => unsafe { - env::set_var(ENV_TEST_FORCE_IMMEDIATE_TRANSITION_ENQUEUE_TIMEOUT, value); - }, - None => unsafe { - env::remove_var(ENV_TEST_FORCE_IMMEDIATE_TRANSITION_ENQUEUE_TIMEOUT); - }, - } - if let Err(err) = result { - std::panic::resume_unwind(err); - } + temp_env::async_with_vars([(ENV_TEST_FORCE_IMMEDIATE_TRANSITION_ENQUEUE_TIMEOUT, Some("1"))], test_fn()).await; } mod serial_tests { @@ -592,7 +573,6 @@ mod serial_tests { /// body (GET won) or a clean object/version-not-found (expiry won). A /// tier-fetch failure -- the #3491 symptom -- is never tolerated. #[tokio::test(flavor = "multi_thread", worker_threads = 1)] - #[serial] #[ignore = "global-state ILM integration test: runs serialized in the CI ILM Integration (serial) lane, see ci.yml test-ilm-integration-serial and rustfs/backlog#1148 (ilm-2)"] async fn test_expire_transitioned_object_never_races_concurrent_get() { let (_disk_paths, ecstore) = setup_isolated_test_env(false).await; @@ -738,7 +718,6 @@ mod serial_tests { } #[tokio::test(flavor = "multi_thread", worker_threads = 1)] - #[serial] #[ignore = "global-state ILM integration test: runs serialized in the CI ILM Integration (serial) lane, see ci.yml test-ilm-integration-serial"] async fn rejected_transition_candidate_is_recovered_from_persisted_delete_journal() { let (_disk_paths, ecstore) = setup_isolated_test_env(false).await; @@ -825,7 +804,6 @@ mod serial_tests { } #[tokio::test(flavor = "multi_thread", worker_threads = 1)] - #[serial] #[ignore = "global-state ILM integration test: runs serialized in the CI ILM Integration (serial) lane, see ci.yml test-ilm-integration-serial"] async fn cancelled_before_cleanup_store_resolution_persists_journal() { let (_disk_paths, ecstore) = setup_isolated_test_env(false).await; @@ -919,7 +897,6 @@ mod serial_tests { } #[tokio::test(flavor = "multi_thread", worker_threads = 1)] - #[serial] #[ignore = "global-state ILM integration test: runs serialized in the CI ILM Integration (serial) lane, see ci.yml test-ilm-integration-serial"] async fn rejected_transition_cleanup_durability_matrix() { #[derive(Clone, Copy)] @@ -1059,7 +1036,6 @@ mod serial_tests { } #[test] - #[serial] #[ignore = "global-state ILM integration test: runs serialized in the CI ILM Integration (serial) lane, see ci.yml test-ilm-integration-serial and rustfs/backlog#1148 (ilm-1)"] fn test_transition_and_restore_flows() { std::thread::Builder::new() @@ -1385,7 +1361,6 @@ mod serial_tests { } #[tokio::test(flavor = "multi_thread", worker_threads = 1)] - #[serial] #[ignore = "global-state ILM integration test: runs serialized in the CI ILM Integration (serial) lane, see ci.yml test-ilm-integration-serial and rustfs/backlog#1148 (ilm-1)"] async fn test_scanner_enqueues_free_version_cleanup_for_stale_transitioned_object() { let (disk_paths, ecstore) = setup_isolated_test_env(false).await; @@ -1446,7 +1421,6 @@ mod serial_tests { } #[tokio::test(flavor = "multi_thread", worker_threads = 1)] - #[serial] #[ignore = "global-state ILM integration test: runs serialized in the CI ILM Integration (serial) lane, see ci.yml test-ilm-integration-serial and rustfs/backlog#1148 (ilm-1)"] async fn test_scanner_cleanup_still_works_after_immediate_compensation_transition() { let (disk_paths, ecstore) = setup_isolated_test_env(false).await; @@ -1504,7 +1478,6 @@ mod serial_tests { } #[tokio::test(flavor = "multi_thread", worker_threads = 1)] - #[serial] #[ignore = "global-state ILM integration test: runs serialized in the CI ILM Integration (serial) lane, see ci.yml test-ilm-integration-serial and rustfs/backlog#1148 (ilm-1)"] async fn test_existing_object_backfill_is_idempotent_after_immediate_compensation_transition() { let (_disk_paths, ecstore) = setup_isolated_test_env(false).await; @@ -1547,7 +1520,6 @@ mod serial_tests { } #[tokio::test(flavor = "multi_thread", worker_threads = 1)] - #[serial] #[ignore = "FAILING on main: excluded from the serial ILM lane pending a fix, see rustfs/backlog#1148 (ilm-1 partial)"] async fn test_noncurrent_expiry_still_works_after_immediate_compensation_transition() { let (disk_paths, ecstore) = setup_isolated_test_env(true).await; @@ -1631,7 +1603,6 @@ mod serial_tests { } #[tokio::test(flavor = "multi_thread", worker_threads = 1)] - #[serial] #[ignore = "FAILING on main: excluded from the serial ILM lane pending a fix, see rustfs/backlog#1148 (ilm-1 partial)"] async fn test_noncurrent_transition_still_works_after_immediate_compensation_transition() { let (disk_paths, ecstore) = setup_isolated_test_env(true).await; @@ -1714,7 +1685,6 @@ mod serial_tests { } #[tokio::test(flavor = "multi_thread", worker_threads = 1)] - #[serial] #[ignore = "global-state ILM integration test: runs serialized in the CI ILM Integration (serial) lane, see ci.yml test-ilm-integration-serial and rustfs/backlog#1148 (ilm-1)"] async fn test_modeled_versioned_delete_creates_delete_marker_after_immediate_compensation_transition() { let (_disk_paths, ecstore) = setup_isolated_test_env(true).await; @@ -1762,7 +1732,6 @@ mod serial_tests { } #[tokio::test(flavor = "multi_thread", worker_threads = 1)] - #[serial] #[ignore = "global-state ILM integration test: runs serialized in the CI ILM Integration (serial) lane, see ci.yml test-ilm-integration-serial and rustfs/backlog#1148 (ilm-1)"] async fn test_modeled_delete_marker_cleanup_after_immediate_compensation_transition() { let (disk_paths, ecstore) = setup_isolated_test_env(true).await; @@ -1839,7 +1808,6 @@ mod serial_tests { } #[tokio::test(flavor = "multi_thread", worker_threads = 1)] - #[serial] #[ignore = "global-state ILM integration test: runs serialized in the CI ILM Integration (serial) lane, see ci.yml test-ilm-integration-serial and rustfs/backlog#1148 (ilm-1)"] async fn test_scanner_expires_zero_day_current_version() { let (disk_paths, ecstore) = setup_isolated_test_env(false).await; @@ -1866,7 +1834,6 @@ mod serial_tests { } #[tokio::test(flavor = "multi_thread", worker_threads = 1)] - #[serial] #[ignore = "global-state ILM integration test: runs serialized in the CI ILM Integration (serial) lane, see ci.yml test-ilm-integration-serial and rustfs/backlog#1148 (ilm-1)"] async fn test_put_object_immediately_enqueues_zero_day_current_expiry() { let (_disk_paths, ecstore) = setup_isolated_test_env(true).await; @@ -1904,7 +1871,6 @@ mod serial_tests { } #[tokio::test(flavor = "multi_thread", worker_threads = 1)] - #[serial] #[ignore = "global-state ILM integration test: runs serialized in the CI ILM Integration (serial) lane, see ci.yml test-ilm-integration-serial and rustfs/backlog#1148 (ilm-1)"] async fn test_scanner_expires_zero_day_noncurrent_version() { let (disk_paths, ecstore) = setup_isolated_test_env(false).await; @@ -1971,7 +1937,6 @@ mod serial_tests { } #[tokio::test(flavor = "multi_thread", worker_threads = 1)] - #[serial] #[ignore = "global-state ILM integration test: runs serialized in the CI ILM Integration (serial) lane, see ci.yml test-ilm-integration-serial and rustfs/backlog#1148 (ilm-1)"] async fn test_put_object_immediately_enqueues_zero_day_noncurrent_expiry() { let (_disk_paths, ecstore) = setup_isolated_test_env(true).await; @@ -2032,7 +1997,6 @@ mod serial_tests { } #[tokio::test(flavor = "multi_thread", worker_threads = 1)] - #[serial] async fn test_background_scanner_expires_zero_day_current_version() { let (_disk_paths, ecstore) = setup_isolated_test_env(true).await; @@ -2056,7 +2020,6 @@ mod serial_tests { } #[tokio::test(flavor = "multi_thread", worker_threads = 1)] - #[serial] #[ignore = "global-state ILM integration test: runs serialized in the CI ILM Integration (serial) lane, see ci.yml test-ilm-integration-serial and rustfs/backlog#1148 (ilm-1)"] async fn test_background_scanner_expires_zero_day_current_version_for_exact_key_prefix() { let (_disk_paths, ecstore) = setup_isolated_test_env(true).await; @@ -2122,7 +2085,6 @@ mod serial_tests { /// tier object is untouched (zero `remove` calls) -> GET streams from the /// tier again -> a second restore succeeds. #[tokio::test(flavor = "multi_thread", worker_threads = 1)] - #[serial] #[ignore = "global-state ILM integration test: runs serialized in the CI ILM Integration (serial) lane, see ci.yml test-ilm-integration-serial and rustfs/backlog#1148 (ilm-8)"] async fn test_restore_chain_local_read_expiry_keeps_remote_and_allows_re_restore() { let (_disk_paths, ecstore) = setup_test_env().await; @@ -2254,7 +2216,6 @@ mod serial_tests { /// parts) must reassemble the exact part layout: part count and sizes, /// the multipart ETag, and byte-identical content across part boundaries. #[tokio::test(flavor = "multi_thread", worker_threads = 1)] - #[serial] #[ignore = "global-state ILM integration test: runs serialized in the CI ILM Integration (serial) lane, see ci.yml test-ilm-integration-serial and rustfs/backlog#1148 (ilm-8)"] async fn test_multipart_restore_preserves_parts_and_etag() { let (_disk_paths, ecstore) = setup_test_env().await; From eec34331defdd479f910d5cf1094179603d4f897 Mon Sep 17 00:00:00 2001 From: Zhengchao An Date: Sat, 22 Aug 2026 09:01:24 +0800 Subject: [PATCH 07/10] chore(madmin): remove dead trace structs, keep TraceType only (#6343) chore(madmin): remove dead trace structs, keep TraceType bitflag helper only TraceInfo, TraceInfoLegacy, TraceHTTPStats, TraceCallStats, TraceRequestInfo, TraceResponseInfo, StorageStats, and OSStats are unreferenced outside trace.rs. Trim to TraceType + its bitflag operations which are actively used by service_commands.rs and profile_admin.rs. -139 lines (215 -> 76 lines) --- crates/madmin/src/trace.rs | 170 +++++++------------------------------ 1 file changed, 32 insertions(+), 138 deletions(-) diff --git a/crates/madmin/src/trace.rs b/crates/madmin/src/trace.rs index 1c63d81e5..9863973c6 100644 --- a/crates/madmin/src/trace.rs +++ b/crates/madmin/src/trace.rs @@ -12,18 +12,16 @@ // See the License for the specific language governing permissions and // limitations under the License. -use std::{collections::HashMap, time::Duration}; - -use jiff::Timestamp; use serde::{Deserialize, Serialize}; -use crate::heal_commands::HealResultItem; - +/// Bitflag helper for service trace categories. +/// +/// Each variant occupies a single bit so that a `TraceType` value can represent +/// an arbitrary combination of categories via bitwise OR. #[derive(Debug, Clone, Copy, Serialize, Deserialize, Default)] pub struct TraceType(u64); impl TraceType { - // Define some constants pub const OS: TraceType = TraceType(1 << 0); pub const STORAGE: TraceType = TraceType(1 << 1); pub const S3: TraceType = TraceType(1 << 2); @@ -40,15 +38,13 @@ impl TraceType { pub const FTP: TraceType = TraceType(1 << 13); pub const ILM: TraceType = TraceType(1 << 14); - // MetricsAll must be last. + /// All trace categories combined. Must be updated when adding new variants. pub const ALL: TraceType = TraceType((1 << 15) - 1); pub fn new(t: u64) -> Self { Self(t) } -} -impl TraceType { pub fn contains(&self, x: &TraceType) -> bool { (self.0 & x.0) == x.0 } @@ -76,140 +72,38 @@ impl TraceType { } } -#[derive(Debug, Default, Clone, Serialize, Deserialize)] -pub struct TraceInfo { - #[serde(rename = "type")] - trace_type: u64, - #[serde(rename = "nodename")] - node_name: String, - #[serde(rename = "funcname")] - func_name: String, - #[serde(rename = "time")] - time: Timestamp, - #[serde(rename = "path")] - path: String, - #[serde(rename = "dur")] - duration: Duration, - #[serde(rename = "bytes", skip_serializing_if = "Option::is_none")] - bytes: Option, - #[serde(rename = "msg", skip_serializing_if = "Option::is_none")] - message: Option, - #[serde(rename = "error", skip_serializing_if = "Option::is_none")] - error: Option, - #[serde(rename = "custom", skip_serializing_if = "Option::is_none")] - custom: Option>, - #[serde(rename = "http", skip_serializing_if = "Option::is_none")] - http: Option, - #[serde(rename = "healResult", skip_serializing_if = "Option::is_none")] - heal_result: Option, -} - -impl TraceInfo { - pub fn mask(&self) -> u64 { - TraceType::new(self.trace_type).mask() - } -} - -#[derive(Debug, Default, Clone, Serialize, Deserialize)] -pub struct TraceInfoLegacy { - trace_info: TraceInfo, - #[serde(rename = "request")] - req_info: Option, - #[serde(rename = "response")] - resp_info: Option, - #[serde(rename = "stats")] - call_stats: Option, - #[serde(rename = "storageStats")] - storage_stats: Option, - #[serde(rename = "osStats")] - os_stats: Option, -} - -#[derive(Debug, Default, Clone, Serialize, Deserialize)] -pub struct StorageStats { - path: String, - duration: Duration, -} - -#[derive(Debug, Default, Clone, Serialize, Deserialize)] -pub struct OSStats { - path: String, - duration: Duration, -} - -#[derive(Debug, Default, Clone, Serialize, Deserialize)] -pub struct TraceHTTPStats { - req_info: TraceRequestInfo, - resp_info: TraceResponseInfo, - call_stats: TraceCallStats, -} - -#[derive(Debug, Default, Clone, Serialize, Deserialize)] -pub struct TraceCallStats { - input_bytes: i32, - output_bytes: i32, - latency: Duration, - time_to_first_byte: Duration, -} - -#[derive(Debug, Default, Clone, Serialize, Deserialize)] -pub struct TraceRequestInfo { - time: Timestamp, - proto: String, - method: String, - #[serde(skip_serializing_if = "Option::is_none")] - path: Option, - #[serde(skip_serializing_if = "Option::is_none")] - raw_query: Option, - #[serde(skip_serializing_if = "Option::is_none")] - headers: Option>, - #[serde(skip_serializing_if = "Option::is_none")] - body: Option>, - client: String, -} - -#[derive(Debug, Default, Clone, Serialize, Deserialize)] -pub struct TraceResponseInfo { - time: Timestamp, - #[serde(skip_serializing_if = "Option::is_none")] - headers: Option>, - #[serde(skip_serializing_if = "Option::is_none")] - body: Option>, - #[serde(skip_serializing_if = "Option::is_none")] - status_code: Option, -} - #[cfg(test)] mod tests { use super::*; #[test] - fn trace_timestamps_serialize_as_rfc3339_utc() { - let timestamp = Timestamp::constant(1_700_000_000, 123_456_000); - let trace = TraceInfo { - time: timestamp, - http: Some(TraceHTTPStats { - req_info: TraceRequestInfo { - time: timestamp, - ..Default::default() - }, - resp_info: TraceResponseInfo { - time: timestamp, - ..Default::default() - }, - ..Default::default() - }), - ..Default::default() - }; + fn trace_type_contains_and_overlaps() { + let mut combined = TraceType::default(); + combined.merge(&TraceType::S3); + combined.merge(&TraceType::HEALING); - let value = serde_json::to_value(trace).expect("trace should serialize"); - assert_eq!(value["time"], "2023-11-14T22:13:20.123456Z"); - assert_eq!(value["http"]["req_info"]["time"], "2023-11-14T22:13:20.123456Z"); - assert_eq!(value["http"]["resp_info"]["time"], "2023-11-14T22:13:20.123456Z"); - let trace: TraceInfo = serde_json::from_value(value).expect("trace should deserialize"); - assert_eq!(trace.time, timestamp); - let http = trace.http.expect("http trace should deserialize"); - assert_eq!(http.req_info.time, timestamp); - assert_eq!(http.resp_info.time, timestamp); + assert!(combined.contains(&TraceType::S3)); + assert!(combined.contains(&TraceType::HEALING)); + assert!(!combined.contains(&TraceType::SCANNER)); + assert!(combined.overlaps(&TraceType::S3)); + assert!(combined.overlaps(&TraceType::HEALING)); + assert!(!combined.overlaps(&TraceType::SCANNER)); + } + + #[test] + fn trace_type_set_if() { + let mut tt = TraceType::default(); + tt.set_if(true, &TraceType::OS); + tt.set_if(false, &TraceType::S3); + assert!(tt.contains(&TraceType::OS)); + assert!(!tt.contains(&TraceType::S3)); + } + + #[test] + fn trace_type_single_type() { + assert!(TraceType::S3.single_type()); + let mut combined = TraceType::S3; + combined.merge(&TraceType::HEALING); + assert!(!combined.single_type()); } } From 98c4675617317c75dc6ba5e643b798bec334f155 Mon Sep 17 00:00:00 2001 From: Zhengchao An Date: Sat, 22 Aug 2026 09:10:14 +0800 Subject: [PATCH 08/10] refactor(e2e): consolidate duplicated helper functions into common.rs (#6355) --- crates/e2e_test/src/common.rs | 151 ++++++++++++++++++ crates/e2e_test/src/kms/common.rs | 52 +++++- crates/e2e_test/src/object_lambda_test.rs | 38 +---- .../src/replication_extension_test.rs | 149 +---------------- 4 files changed, 208 insertions(+), 182 deletions(-) diff --git a/crates/e2e_test/src/common.rs b/crates/e2e_test/src/common.rs index 42fe5f92a..7fad7ea76 100644 --- a/crates/e2e_test/src/common.rs +++ b/crates/e2e_test/src/common.rs @@ -30,6 +30,7 @@ use reqwest::StatusCode; use rustfs_signer::constants::UNSIGNED_PAYLOAD; use rustfs_signer::sign_v4; use s3s::Body; +use serde_json; use std::ffi::OsStr; use std::fs as stdfs; use std::io::ErrorKind; @@ -1583,6 +1584,156 @@ impl Drop for RustFSTestClusterEnvironment { } } +/// Send a SigV4-signed HTTP request and return the raw `reqwest::Response`. +/// +/// Unlike [`signed_s3_request`], this variant accepts `body: Option>` +/// (binary-safe) and reorders parameters so that `access_key`/`secret_key` +/// appear before the body — matching the convention used by the replication +/// extension and object-lambda e2e suites. +pub(crate) async fn signed_request( + method: http::Method, + url: &str, + access_key: &str, + secret_key: &str, + body: Option>, + content_type: Option<&str>, +) -> Result> { + let uri = url.parse::()?; + let authority = uri.authority().ok_or("request URL missing authority")?.to_string(); + let mut request = http::Request::builder().method(method.clone()).uri(uri); + request = request.header(HOST, authority); + request = request.header("x-amz-content-sha256", UNSIGNED_PAYLOAD); + if let Some(content_type) = content_type { + request = request.header(CONTENT_TYPE, content_type); + } + + let content_len = body.as_ref().map(|body| body.len() as i64).unwrap_or_default(); + let signed = sign_v4(request.body(Body::empty())?, content_len, access_key, secret_key, "", "us-east-1"); + + let reqwest_method = reqwest::Method::from_bytes(method.as_str().as_bytes())?; + let client = local_http_client(); + let mut request_builder = client.request(reqwest_method, url); + for (name, value) in signed.headers() { + request_builder = request_builder.header(name, value); + } + if let Some(body) = body { + request_builder = request_builder.body(body); + } + + Ok(request_builder.send().await?) +} + +/// Like [`signed_request`], but uses a caller-supplied `reqwest::Client` +/// instead of the shared [`local_http_client`]. +pub(crate) async fn signed_request_with_client( + client: &reqwest::Client, + method: http::Method, + url: &str, + access_key: &str, + secret_key: &str, + body: Option>, + content_type: Option<&str>, +) -> Result> { + let uri = url.parse::()?; + let authority = uri.authority().ok_or("request URL missing authority")?.to_string(); + let mut request = http::Request::builder().method(method.clone()).uri(uri); + request = request.header(HOST, authority); + request = request.header("x-amz-content-sha256", UNSIGNED_PAYLOAD); + if let Some(content_type) = content_type { + request = request.header(CONTENT_TYPE, content_type); + } + + let content_len = body.as_ref().map(|body| body.len() as i64).unwrap_or_default(); + let signed = sign_v4(request.body(Body::empty())?, content_len, access_key, secret_key, "", "us-east-1"); + + let reqwest_method = reqwest::Method::from_bytes(method.as_str().as_bytes())?; + let mut request_builder = client.request(reqwest_method, url); + for (name, value) in signed.headers() { + request_builder = request_builder.header(name, value); + } + if let Some(body) = body { + request_builder = request_builder.body(body); + } + + Ok(request_builder.send().await?) +} + +/// Like [`signed_request`], but includes a `session_token` in the +/// `x-amz-security-token` header and passes it to the SigV4 signer. +pub(crate) async fn signed_request_with_session_token( + method: http::Method, + url: &str, + access_key: &str, + secret_key: &str, + session_token: &str, + body: Option>, + content_type: Option<&str>, +) -> Result> { + let uri = url.parse::()?; + let authority = uri.authority().ok_or("request URL missing authority")?.to_string(); + let mut request = http::Request::builder().method(method.clone()).uri(uri); + request = request.header(HOST, authority); + request = request.header("x-amz-content-sha256", UNSIGNED_PAYLOAD); + if !session_token.is_empty() { + request = request.header("x-amz-security-token", session_token); + } + if let Some(content_type) = content_type { + request = request.header(CONTENT_TYPE, content_type); + } + + let content_len = body.as_ref().map(|body| body.len() as i64).unwrap_or_default(); + let signed = sign_v4( + request.body(Body::empty())?, + content_len, + access_key, + secret_key, + session_token, + "us-east-1", + ); + + let reqwest_method = reqwest::Method::from_bytes(method.as_str().as_bytes())?; + let client = local_http_client(); + let mut request_builder = client.request(reqwest_method, url); + for (name, value) in signed.headers() { + request_builder = request_builder.header(name, value); + } + if let Some(body) = body { + request_builder = request_builder.body(body); + } + + Ok(request_builder.send().await?) +} + +/// Create a new user via the admin API. +pub(crate) async fn admin_create_user( + env: &RustFSTestEnvironment, + username: &str, + secret_key: &str, +) -> Result<(), Box> { + let url = format!("{}/rustfs/admin/v3/add-user?accessKey={}", env.url, username); + let body = serde_json::json!({ + "secretKey": secret_key, + "status": "enabled" + }); + let response = signed_request( + http::Method::PUT, + &url, + &env.access_key, + &env.secret_key, + Some(body.to_string().into_bytes()), + Some("application/json"), + ) + .await?; + + if response.status() != reqwest::StatusCode::OK { + let status = response.status(); + let body = response.text().await.unwrap_or_default(); + return Err(format!("create user failed: {status} {body}").into()); + } + + Ok(()) +} + #[cfg(test)] mod tests { use super::*; diff --git a/crates/e2e_test/src/kms/common.rs b/crates/e2e_test/src/kms/common.rs index 8d81cbc18..290cb937d 100644 --- a/crates/e2e_test/src/kms/common.rs +++ b/crates/e2e_test/src/kms/common.rs @@ -40,7 +40,7 @@ use std::time::Duration; use tokio::fs; use tokio::net::TcpStream; use tokio::time::sleep; -use tracing::{debug, error, info}; +use tracing::{debug, error, info, warn}; // KMS-specific constants pub const TEST_BUCKET: &str = "kms-test-bucket"; @@ -177,6 +177,49 @@ pub async fn get_kms_status( Ok(status) } +/// Poll the KMS status endpoint until the backend reports ready or the timeout +/// expires. Replaces hard-coded `sleep(Duration::from_secs(3))` startup waits +/// with an active readiness probe so tests start as soon as KMS is usable +/// (typically < 1 s) instead of always waiting the full 3 s. +/// +/// Uses exponential back-off starting at 200 ms (doubling each attempt, capped +/// at 1 s) up to a total wall-clock budget of 5 s. +pub async fn wait_for_kms_ready( + base_url: &str, + access_key: &str, + secret_key: &str, +) -> Result<(), Box> { + let total_deadline = Duration::from_secs(5); + let start = tokio::time::Instant::now(); + let mut backoff = Duration::from_millis(200); + let max_backoff = Duration::from_secs(1); + let mut first_attempt = true; + + loop { + if !first_attempt { + if start.elapsed() >= total_deadline { + return Err("KMS failed to become ready within 5 seconds".into()); + } + sleep(backoff).await; + backoff = (backoff * 2).min(max_backoff); + } + first_attempt = false; + + match get_kms_status(base_url, access_key, secret_key).await { + Ok(status) => { + info!("KMS is ready (status: {})", status); + return Ok(()); + } + Err(e) => { + if start.elapsed() >= total_deadline { + return Err(format!("KMS did not become ready within 5 s: last error: {e}").into()); + } + warn!(error = %e, elapsed_ms = start.elapsed().as_millis() as u64, "KMS not ready yet, retrying…"); + } + } + } +} + /// Create a default KMS key for testing and return the created key ID pub async fn create_default_key( base_url: &str, @@ -861,6 +904,13 @@ impl LocalKMSTestEnvironment { Ok(default_key_id.to_string()) } + /// Poll the KMS status endpoint until the backend reports ready. + /// + /// Prefer this over a fixed `sleep` after calling `start_rustfs_for_local_kms`. + pub async fn wait_for_kms_ready(&self) -> Result<(), Box> { + wait_for_kms_ready(&self.base_env.url, &self.base_env.access_key, &self.base_env.secret_key).await + } + /// Configure Local KMS backend with a predefined default key pub async fn configure_local_kms(&self) -> Result> { // Use a fixed, predictable default key ID diff --git a/crates/e2e_test/src/object_lambda_test.rs b/crates/e2e_test/src/object_lambda_test.rs index 66f259e6d..aa6f7d4a1 100644 --- a/crates/e2e_test/src/object_lambda_test.rs +++ b/crates/e2e_test/src/object_lambda_test.rs @@ -12,12 +12,11 @@ // See the License for the specific language governing permissions and // limitations under the License. -use crate::common::{RustFSTestClusterEnvironment, RustFSTestEnvironment, init_logging, local_http_client}; +use crate::common::{RustFSTestClusterEnvironment, RustFSTestEnvironment, init_logging, local_http_client, signed_request}; use aws_sdk_s3::primitives::ByteStream; use http::header::{CONTENT_TYPE, HOST}; use reqwest::StatusCode; -use rustfs_signer::constants::UNSIGNED_PAYLOAD; -use rustfs_signer::{pre_sign_v4, sign_v4}; +use rustfs_signer::pre_sign_v4; use rustfs_utils::egress::ENV_OUTBOUND_ALLOW_ORIGINS; use s3s::Body; use std::collections::HashMap; @@ -227,39 +226,6 @@ async fn presigned_get_request( Ok(local_http_client().get(signed.uri().to_string()).send().await?) } -async fn signed_request( - method: http::Method, - url: &str, - access_key: &str, - secret_key: &str, - body: Option>, - content_type: Option<&str>, -) -> Result> { - let uri = url.parse::()?; - let authority = uri.authority().ok_or("request URL missing authority")?.to_string(); - let mut request = http::Request::builder().method(method.clone()).uri(uri); - request = request.header(HOST, authority); - request = request.header("x-amz-content-sha256", UNSIGNED_PAYLOAD); - if let Some(content_type) = content_type { - request = request.header(CONTENT_TYPE, content_type); - } - - let content_len = body.as_ref().map(|body| body.len() as i64).unwrap_or_default(); - let signed = sign_v4(request.body(Body::empty())?, content_len, access_key, secret_key, "", "us-east-1"); - - let reqwest_method = reqwest::Method::from_bytes(method.as_str().as_bytes())?; - let client = local_http_client(); - let mut request_builder = client.request(reqwest_method, url); - for (name, value) in signed.headers() { - request_builder = request_builder.header(name, value); - } - if let Some(body) = body { - request_builder = request_builder.body(body); - } - - Ok(request_builder.send().await?) -} - async fn configure_webhook_target( env: &RustFSTestEnvironment, target_name: &str, diff --git a/crates/e2e_test/src/replication_extension_test.rs b/crates/e2e_test/src/replication_extension_test.rs index d0282c83a..3d51d139b 100644 --- a/crates/e2e_test/src/replication_extension_test.rs +++ b/crates/e2e_test/src/replication_extension_test.rs @@ -13,8 +13,9 @@ // limitations under the License. use crate::common::{ - RustFSTestEnvironment, awscurl_available, awscurl_post_sts_form_urlencoded, init_logging, local_http_client, - replication_fast_env, rustfs_binary_path, + RustFSTestEnvironment, admin_create_user, awscurl_available, awscurl_post_sts_form_urlencoded, init_logging, + local_http_client, replication_fast_env, rustfs_binary_path, signed_request, signed_request_with_client, + signed_request_with_session_token, }; use crate::fake_s3_target::{ FAKE_ACCESS_KEY, FAKE_SECRET_KEY, FakeS3Target, FaultAction as FakeTargetFault, Operation as FakeTargetOperation, @@ -35,7 +36,7 @@ use base64::{Engine, engine::general_purpose::STANDARD as BASE64_STANDARD}; use bytes::Bytes; use flate2::read::GzDecoder; use futures::{Stream, StreamExt}; -use http::header::{CONTENT_ENCODING, CONTENT_TYPE, HOST}; +use http::header::CONTENT_ENCODING; use http_body_util::{BodyExt, Full}; use hyper::body::Incoming; use hyper::server::conn::http1; @@ -56,9 +57,6 @@ use rustfs_madmin::{ AddServiceAccountReq, ListServiceAccountsResp, PeerInfo, PeerSite, ReplicateAddStatus, ReplicateEditStatus, ReplicateRemoveStatus, SRRemoveReq, SRResyncOpStatus, SRStatusInfo, SiteReplicationInfo, SyncStatus, }; -use rustfs_signer::constants::UNSIGNED_PAYLOAD; -use rustfs_signer::sign_v4; -use s3s::Body; use s3s::header::X_AMZ_REPLICATION_STATUS; use sha2::{Digest, Sha256}; use std::collections::BTreeMap; @@ -387,116 +385,6 @@ struct ReplicationResetStatusTarget { object: String, } -async fn signed_request( - method: http::Method, - url: &str, - access_key: &str, - secret_key: &str, - body: Option>, - content_type: Option<&str>, -) -> Result> { - let uri = url.parse::()?; - let authority = uri.authority().ok_or("request URL missing authority")?.to_string(); - let mut request = http::Request::builder().method(method.clone()).uri(uri); - request = request.header(HOST, authority); - request = request.header("x-amz-content-sha256", UNSIGNED_PAYLOAD); - if let Some(content_type) = content_type { - request = request.header(CONTENT_TYPE, content_type); - } - - let content_len = body.as_ref().map(|body| body.len() as i64).unwrap_or_default(); - let signed = sign_v4(request.body(Body::empty())?, content_len, access_key, secret_key, "", "us-east-1"); - - let reqwest_method = reqwest::Method::from_bytes(method.as_str().as_bytes())?; - let client = local_http_client(); - let mut request_builder = client.request(reqwest_method, url); - for (name, value) in signed.headers() { - request_builder = request_builder.header(name, value); - } - if let Some(body) = body { - request_builder = request_builder.body(body); - } - - Ok(request_builder.send().await?) -} - -async fn signed_request_with_client( - client: &reqwest::Client, - method: http::Method, - url: &str, - access_key: &str, - secret_key: &str, - body: Option>, - content_type: Option<&str>, -) -> Result> { - let uri = url.parse::()?; - let authority = uri.authority().ok_or("request URL missing authority")?.to_string(); - let mut request = http::Request::builder().method(method.clone()).uri(uri); - request = request.header(HOST, authority); - request = request.header("x-amz-content-sha256", UNSIGNED_PAYLOAD); - if let Some(content_type) = content_type { - request = request.header(CONTENT_TYPE, content_type); - } - - let content_len = body.as_ref().map(|body| body.len() as i64).unwrap_or_default(); - let signed = sign_v4(request.body(Body::empty())?, content_len, access_key, secret_key, "", "us-east-1"); - - let reqwest_method = reqwest::Method::from_bytes(method.as_str().as_bytes())?; - let mut request_builder = client.request(reqwest_method, url); - for (name, value) in signed.headers() { - request_builder = request_builder.header(name, value); - } - if let Some(body) = body { - request_builder = request_builder.body(body); - } - - Ok(request_builder.send().await?) -} - -async fn signed_request_with_session_token( - method: http::Method, - url: &str, - access_key: &str, - secret_key: &str, - session_token: &str, - body: Option>, - content_type: Option<&str>, -) -> Result> { - let uri = url.parse::()?; - let authority = uri.authority().ok_or("request URL missing authority")?.to_string(); - let mut request = http::Request::builder().method(method.clone()).uri(uri); - request = request.header(HOST, authority); - request = request.header("x-amz-content-sha256", UNSIGNED_PAYLOAD); - if !session_token.is_empty() { - request = request.header("x-amz-security-token", session_token); - } - if let Some(content_type) = content_type { - request = request.header(CONTENT_TYPE, content_type); - } - - let content_len = body.as_ref().map(|body| body.len() as i64).unwrap_or_default(); - let signed = sign_v4( - request.body(Body::empty())?, - content_len, - access_key, - secret_key, - session_token, - "us-east-1", - ); - - let reqwest_method = reqwest::Method::from_bytes(method.as_str().as_bytes())?; - let client = local_http_client(); - let mut request_builder = client.request(reqwest_method, url); - for (name, value) in signed.headers() { - request_builder = request_builder.header(name, value); - } - if let Some(body) = body { - request_builder = request_builder.body(body); - } - - Ok(request_builder.send().await?) -} - fn extract_xml_tag(xml: &str, tag: &str) -> Option { let open = format!("<{tag}>"); let close = format!(""); @@ -1016,35 +904,6 @@ fn create_user_s3_client(env: &RustFSTestEnvironment, access_key: &str, secret_k Client::from_conf(config) } -async fn admin_create_user( - env: &RustFSTestEnvironment, - username: &str, - secret_key: &str, -) -> Result<(), Box> { - let url = format!("{}/rustfs/admin/v3/add-user?accessKey={}", env.url, username); - let body = serde_json::json!({ - "secretKey": secret_key, - "status": "enabled" - }); - let response = signed_request( - http::Method::PUT, - &url, - &env.access_key, - &env.secret_key, - Some(body.to_string().into_bytes()), - Some("application/json"), - ) - .await?; - - if response.status() != StatusCode::OK { - let status = response.status(); - let body = response.text().await.unwrap_or_default(); - return Err(format!("create user failed: {status} {body}").into()); - } - - Ok(()) -} - async fn admin_add_canned_policy( env: &RustFSTestEnvironment, policy_name: &str, From 5b951de2b71dc3df7afef976ce12c4e5b75cc0ee Mon Sep 17 00:00:00 2001 From: Zhengchao An Date: Sat, 22 Aug 2026 10:58:01 +0800 Subject: [PATCH 09/10] test(ci): bound s3-tests failure logs (#6361) --- scripts/check_test_wiring.py | 27 ++++++++++++++++++++++++++- scripts/s3-tests/run.sh | 3 ++- 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/scripts/check_test_wiring.py b/scripts/check_test_wiring.py index d04af1f12..4edd41f0d 100755 --- a/scripts/check_test_wiring.py +++ b/scripts/check_test_wiring.py @@ -206,6 +206,13 @@ def check_runner_selection(root: Path) -> list[str]: return errors +def check_s3_tests_runner(root: Path) -> list[str]: + runner = (root / "scripts/s3-tests/run.sh").read_text() + if "--showlocals" in runner: + return ["scripts/s3-tests/run.sh: pytest failure diagnostics must not dump local values"] + return [] + + def profile_selection(root: Path, profile: str) -> str: if not re.fullmatch(r"e2e-[a-z0-9-]+", profile): raise ValueError(f"invalid e2e profile name: {profile}") @@ -272,6 +279,7 @@ def validate(root: Path) -> list[str]: errors.extend(check_e2e_modules(root)) errors.extend(check_fuzz_targets(root)) errors.extend(check_runner_selection(root)) + errors.extend(check_s3_tests_runner(root)) errors.extend(check_profile_definitions(root)) return errors @@ -341,6 +349,23 @@ class SelfTests(unittest.TestCase): ) self.assertEqual(len(check_fuzz_targets(root)), 1) + def test_s3_runner_rejects_unbounded_failure_locals(self) -> None: + with tempfile.TemporaryDirectory() as tmp: + root = Path(tmp) + runner = root / "scripts/s3-tests/run.sh" + runner.parent.mkdir(parents=True) + runner.write_text("tox -- -vv -ra --tb=long\n") + self.assertEqual(check_s3_tests_runner(root), []) + runner.write_text("tox -- -vv -ra --showlocals --tb=long\n") + self.assertEqual(len(check_s3_tests_runner(root)), 1) + with ( + mock.patch(__name__ + ".check_e2e_modules", return_value=[]), + mock.patch(__name__ + ".check_fuzz_targets", return_value=[]), + mock.patch(__name__ + ".check_runner_selection", return_value=[]), + mock.patch(__name__ + ".check_profile_definitions", return_value=[]), + ): + self.assertEqual(len(validate(root)), 1) + def test_profile_listing_enforces_selection(self) -> None: with tempfile.TemporaryDirectory() as tmp: root = Path(tmp) @@ -411,7 +436,7 @@ def main() -> int: for error in errors: print(f"ERROR: {error}", file=sys.stderr) return 1 - print("OK: e2e modules, runner selection, fuzz matrices, and profile guards are wired") + print("OK: e2e modules, runner selection, fuzz matrices, profiles, and bounded diagnostics are wired") return 0 diff --git a/scripts/s3-tests/run.sh b/scripts/s3-tests/run.sh index ac8b691f5..74e2289f6 100755 --- a/scripts/s3-tests/run.sh +++ b/scripts/s3-tests/run.sh @@ -1028,10 +1028,11 @@ else fi # Run tests from s3tests/functional +# Failure locals can contain multi-MiB request bodies; keep tracebacks without expanding local values. set +e S3TEST_CONF="${CONF_OUTPUT_PATH}" \ tox -- \ - -vv -ra --showlocals --tb=long \ + -vv -ra --tb=long \ --maxfail="${MAXFAIL}" \ --timeout="${TEST_TIMEOUT}" \ --junitxml="${ARTIFACTS_DIR}/junit.xml" \ From 2f0918f60b8c0fa42ff2ad9e2507197962f0934d Mon Sep 17 00:00:00 2001 From: houseme Date: Sat, 22 Aug 2026 11:24:24 +0800 Subject: [PATCH 10/10] feat(disk): fsync dedicated blocking pool (default-off) (#6366) --- crates/config/src/constants/runtime.rs | 7 ++++ crates/ecstore/src/disk/os.rs | 46 +++++++++++++++++++++++--- 2 files changed, 49 insertions(+), 4 deletions(-) diff --git a/crates/config/src/constants/runtime.rs b/crates/config/src/constants/runtime.rs index 9d93c9f5e..783ad6993 100644 --- a/crates/config/src/constants/runtime.rs +++ b/crates/config/src/constants/runtime.rs @@ -57,6 +57,13 @@ pub const DEFAULT_MAX_IO_EVENTS_PER_TICK: usize = 1024; pub const DEFAULT_EVENT_INTERVAL: u32 = 61; pub const DEFAULT_RNG_SEED: Option = None; // None means random +/// Dedicated blocking thread pool for fsync/fdatasync operations. +/// When > 1, fsync operations are isolated from the main blocking pool to +/// prevent device-bound fsync from starving read operations (pread/stat/open). +/// Default 0 means auto (no isolation, use main runtime). +pub const ENV_FSYNC_BLOCKING_THREADS: &str = "RUSTFS_RUNTIME_FSYNC_BLOCKING_THREADS"; +pub const DEFAULT_FSYNC_BLOCKING_THREADS: usize = 0; + // Dial9 Tokio Telemetry Default values pub const DEFAULT_RUNTIME_DIAL9_ENABLED: bool = false; // Disabled by default pub const DEFAULT_RUNTIME_DIAL9_OUTPUT_DIR: &str = "/var/log/rustfs/telemetry"; diff --git a/crates/ecstore/src/disk/os.rs b/crates/ecstore/src/disk/os.rs index ba97f67c5..77ea01991 100644 --- a/crates/ecstore/src/disk/os.rs +++ b/crates/ecstore/src/disk/os.rs @@ -315,7 +315,7 @@ pub async fn fsync_dir(dir: impl AsRef) -> io::Result<()> { #[cfg(unix)] { let dir = dir.as_ref().to_path_buf(); - tokio::task::spawn_blocking(move || fsync_dir_std(dir)).await? + fsync_spawn_blocking(move || fsync_dir_std(dir)).await? } #[cfg(not(unix))] @@ -683,7 +683,7 @@ async fn fsync_open_dst_dir_group(group: &DstDirFsyncGroup) -> io::Result<()> { #[cfg(test)] let dir = group.dir.clone(); let dir_file = group.dir_file.clone(); - tokio::task::spawn_blocking(move || { + fsync_spawn_blocking(move || { #[cfg(test)] { if let Some(kind) = fsync_dir_recorder::take_grouped_failure(&dir) { @@ -1080,6 +1080,44 @@ const TEST_GLOBAL_FILE_SYNCS: usize = 64; static FILE_SYNC_PERMITS: LazyLock = LazyLock::new(|| Semaphore::new(global_file_sync_limit())); static DISK_FILE_SYNC_LIMITERS: LazyLock>>> = LazyLock::new(|| Mutex::new(HashMap::new())); + +/// Dedicated tokio runtime for fsync/fdatasync blocking operations. When +/// configured with >1 threads, isolates device-bound fsync from the main +/// blocking pool so reads (pread/stat/open) are not starved. `None` means +/// fall back to the main runtime (zero behavior change). +static FSYNC_RUNTIME: LazyLock> = LazyLock::new(|| { + let threads = + rustfs_utils::get_env_usize(rustfs_config::ENV_FSYNC_BLOCKING_THREADS, rustfs_config::DEFAULT_FSYNC_BLOCKING_THREADS); + if threads <= 1 { + return None; + } + let mut builder = tokio::runtime::Builder::new_multi_thread(); + builder + .worker_threads(num_cpus::get().min(8)) + .max_blocking_threads(threads) + .thread_name("rustfs-fsync") + .thread_stack_size(512 * 1024) + .enable_all(); + match builder.build() { + Ok(rt) => { + tracing::info!(threads, "fsync dedicated blocking pool enabled"); + Some(rt) + } + Err(err) => { + tracing::warn!(%err, "failed to build fsync runtime, falling back to main pool"); + None + } + } +}); + +/// Spawn a blocking task on the fsync-dedicated runtime if configured, +/// otherwise fall back to the main tokio blocking pool. +fn fsync_spawn_blocking(f: impl FnOnce() -> T + Send + 'static) -> tokio::task::JoinHandle { + match FSYNC_RUNTIME.as_ref() { + Some(rt) => rt.spawn_blocking(f), + None => tokio::task::spawn_blocking(f), + } +} static DISK_VOLUME_MUTATION_LOCKS: LazyLock>>>> = LazyLock::new(|| Mutex::new(HashMap::new())); type NamespaceMutationLock = AsyncMutex<()>; @@ -1217,7 +1255,7 @@ where F: FnOnce() -> io::Result + Send + 'static, { let (disk_permit, global_permit) = acquire_file_sync_permits(disk_permits).await?; - let result = tokio::task::spawn_blocking(move || { + let result = fsync_spawn_blocking(move || { let _disk_permit = disk_permit; work() }) @@ -2146,7 +2184,7 @@ async fn run_blocking_namespace_file_sync_operation_with_global