Compare commits

..
Author SHA1 Message Date
Hare bf5fa54f44 fix: validate resolved ancestry inside atomic projection dispatch
Resolve one connected lineage and retain its root-to-parent capabilities. Backends validate ancestor identity/membership and refresh all policy metadata inside the same boundary as target validators and typed dispatch; hidden/replaced ancestors reject as NotFound without invocation or effects. Preserve pinned leaf and configured-root capabilities. Covers MR ANCESTOR_VISIBILITY_TOCTOU with HTTP memory and Linux replacement/budget/guard regressions; all T-19 workspace acceptance commands pass (Clippy via Nix shell).
2026-10-06 20:21:15 +09:00
Hare c6528c2887 test: verify filesystem extension and principal security contracts
Add 21 independent memory-backend external-style tests, both principal HTTP flows, atomic validator/target/effect checks, budgets and sanitized failures; document migration and implementer responsibilities. All T-19 acceptance commands pass; Clippy runs in the repository Nix development shell.
2026-10-06 18:12:05 +09:00
Hare b196047b57 feat: expose extensible filesystem projection engine
Separate pinned Linux backend, typed composition, coherent principal policy views and standard HTTP adapter. Refresh validators inside serialized execution and preserve default listener and effect boundaries. Linux/adapter and real-listener regressions pass.
2026-10-06 18:12:05 +09:00
Hare ea49cb0586 feat: add principal-scoped typed publication views
Restrict interface order and operation descriptors without changing registry artifacts or dispatch codecs; prune hidden-only types/docs and support typed pre-dispatch provider rejection. Validated host contracts and the dependent workspace suite for T-19.
2026-10-06 18:12:05 +09:00
11 changed files with 4515 additions and 547 deletions
+1 -1
View File
@@ -3,7 +3,7 @@ name = "wip-fs-server"
version.workspace = true version.workspace = true
edition.workspace = true edition.workspace = true
rust-version.workspace = true rust-version.workspace = true
description = "Request-time filesystem projection server for WIP over HTTP" description = "Extensible request-time filesystem projection library and WIP over HTTP server"
license.workspace = true license.workspace = true
repository.workspace = true repository.workspace = true
readme = "README.md" readme = "README.md"
+113
View File
@@ -6,6 +6,119 @@ keep one object instance per entry. It uses `wip-host` for publication and typed
operation dispatch and uses the standard `wip-http` routes, JSON codecs, operation dispatch and uses the standard `wip-http` routes, JSON codecs,
envelopes, and HTTP status mapping. envelopes, and HTTP status mapping.
## Library assembly and migration
The existing `ServerConfig`, `WipFsServer::new`, `handle_http`, CLI flags and wire
representation remain compatible. The formerly private projection has become a
public, generic library engine. No package version or publication policy changes
are required.
Use `default_projection(root, access, limits)` to obtain the default Linux engine
without starting a listener. `projection.view(&principal)` is the effective view;
it owns canonical `observe` and `fetch_interface` and implements the standard
`wip_host::ObjectProvider` typed `call_operation` API. `DefaultPolicy` has the unit
principal `()`; default engines also offer unit-principal convenience methods.
For an external backend/composition:
1. Implement `BackendEntry` on a local, cloneable, root-confined stable capability.
Its `WipObject` metadata is public-only; its validator binds identity and the
protected state. Implement `FilesystemBackend` to resolve one connected
`ResolvedEntry<Entry>` (root-to-parent ancestry plus pinned target), enumerate
bounded children, and execute against that already-resolved lineage.
2. Register generated `#[wip_interface::interface]` definitions using the existing
`wip_host::InterfaceRegistry`. `DefaultInterfaces::register` optionally supplies
reusable built-in tokens; using those tokens does not force their publication.
3. Implement `Composition<Entry>` on a local type. Its local Object wraps the entry
and implements both `WipObject` and the chosen generated traits, avoiding orphan
rules. `PublishedObject::expose` proves each implementation at compile time.
Publication can add, replace, reorder or omit built-ins based on entry metadata
and actual backend capabilities, not just entry kind. `LinuxEntry` implements
bounded `FileRead`, `FileWrite` and `SymlinkInspect` for safe delegation; never
advertise write in read-only mode or link operations on a non-link capability.
4. Assemble `Projection::new(backend, registry, composition, policy, limits)`.
`ProjectionPolicy` supplies an opaque associated `Principal`, hides Objects and
entire hidden subtrees, selects an ordered subset of implemented interfaces,
controls descriptor/operation visibility, and permits or denies execution.
5. An authenticated deployment chooses the principal and `ExecutionContext`. To
use HTTP, construct `HttpAdapter::new(&view, &endpoint, limits)` and invoke
`handle_http_with_context`. This uses the standard `wip-http` binding, not a
filesystem wire profile. Enforce body collection, header, concurrency and
deadline bounds in the deployment's listener; the adapter owns none of these
intake resources. The bundled loopback listener remains a thin default user.
A complete external-style memory backend, local Object with multiple custom
Operations, typed registration, principal policy and HTTP flow is exercised in
[`tests/extensions.rs`](tests/extensions.rs). It uses no Linux filesystem for its
backend. The public library APIs do not require private types, a fork, an HTTP
listener, a global object registry, or dynamic plugin loading.
### Extension security contract
Backend implementations and Operation authors are trusted code, not sandboxed
plugins. `FilesystemBackend::resolve` returns `ResolvedEntry::new(ancestors, target)`
from one connected backend traversal/snapshot, not independent path-prefix
resolutions. A root target has no ancestors; other targets retain the root first,
then intermediate parent containers. This is backend-private context, never wire
metadata. Backend `resolve` and `execute` signatures both carry this type;
compositions still receive only the exact scoped target `Entry`.
`FilesystemBackend::execute` must validate ancestor membership/identity and
refresh **all** lineage state/validators inside its transaction or lock before
calling the engine callback, retaining the same target and connected ancestry
through validation and dispatch. Replaced/detached ancestors must return
`NotFound` without callback invocation, even when the replacement is visible.
The engine evaluates Object visibility for every refreshed ancestor and target
inside that same boundary; a hidden ancestor rejects the entire subtree before
publication/typed dispatch. Never fix a changed lineage by resolving the raw path
again and substituting capabilities. Participating policy-relevant backend state
changes must be serialized by this boundary, not just target-content writes.
Return the committed post-operation validator. Retained ancestry is subject to
handle/work ceilings; resource exhaustion is an error, not missing ancestry.
Confirm rollback only after rollback succeeds. Pre-dispatch failures
must never commit; failed started operations without a non-commit guarantee remain
`OperationOutcomeUnknown`. Object implementations must delegate validators to
that entry and declare requirements per `(InterfaceRef, operation)`, rather than
classify all operations by a read/write name. Operations use the scoped entry and
propagated context, not a fresh raw-path resolution; they must check deadlines,
cancellation and resource budgets throughout backend work and report effects
truthfully. POSIX symlinks, identity, atomic mutations and locking cannot be assumed
for other backends.
The default Linux backend acquires advisory exclusive locks in root-to-parent
order and then on the lockable target (directory or regular file). It compares
retained ancestor identity to no-follow descriptor-relative lookup results,
refreshes lineage snapshots after acquiring the locks, and holds the guards
through post-dispatch state observation. The configured root remains its pinned
capability even if its textual path is renamed; replaced intermediate ancestors
are rejected. Leaf path replacement never redirects execution to a new inode.
This serializes cooperating library calls; it does **not** promise transactional
isolation from unrelated processes ignoring `flock`. Linux capabilities only
expose bounded methods, not raw descriptors or backend paths.
A policy must be stable/deterministic within one effective Worldspace view.
Interface/operation visibility is uniform per registered reference within that
view, so observation, fetch and dispatch use the identical filtered descriptor.
For entry-specific operation sets, register distinct interface definitions and
select them by entry. Different principals may have different effective views.
Changing a policy must establish a new view/reference lifetime (e.g. rebuild the
registry/engine); do not keep validator-free references while changing their
meaning. Execution permission may deny a visible Operation without hiding it.
A published interface is always fetchable by that principal; hidden operations
are omitted (along with their unreachable named types and interface-wide docs)
and guessed calls return `OperationNotFound`, whereas visible denied
operations return `PermissionDenied`. Hidden Objects and descendants return
`NotFound` and are absent from parent observations. Work spent scanning hidden
entries still counts against traversal bounds; resource limits are not a
constant-time/side-channel guarantee.
Never put absolute paths, hidden metadata, credentials or policy internals in
public `WipObject` metadata, descriptions, validators or normal logs. Validators
must be opaque public tokens, not confidential content. Engine/HTTP failures use
bounded generic diagnostics; arbitrary trusted implementation metadata/logging
cannot be sanitized automatically. Do not log credentials or sensitive panic
payloads from extensions.
## Security model ## Security model
- The effective root is opened once as a directory capability. Root path - The effective root is opened once as a directory capability. Root path
+146
View File
@@ -0,0 +1,146 @@
//! Reusable default Linux composition; no listener or authentication dependency.
use crate::engine::{BackendEntry, Composition, DefaultPolicy, EntryKind, Projection};
use crate::interfaces::{
FileRead, FileReadDefinition, FileWrite, FileWriteDefinition, SymlinkInspect,
SymlinkInspectDefinition,
};
use crate::projection::{LinuxBackend, LinuxEntry};
use crate::{AccessMode, ResourceLimits};
use wip_host::{
ExecutionContext, HostError, InterfaceRef, InterfaceRegistry, PublishedObject,
RegisteredInterface, RegistrationError, Validator, WipObject,
};
use wip_interface as wip;
/// Registered built-in interfaces, usable by external compositions and Objects.
pub struct DefaultInterfaces {
/// Bounded regular-file reads.
pub read: RegisteredInterface<FileReadDefinition>,
/// No-follow link inspection.
pub symlink: RegisteredInterface<SymlinkInspectDefinition>,
/// Validator-protected replacement.
pub write: RegisteredInterface<FileWriteDefinition>,
}
impl DefaultInterfaces {
/// Register reusable default descriptors without publishing any objects.
pub fn register(registry: &mut InterfaceRegistry) -> Result<Self, RegistrationError> {
Ok(Self {
read: registry.register(FileReadDefinition, None)?,
symlink: registry.register(SymlinkInspectDefinition, None)?,
write: registry.register(FileWriteDefinition, None)?,
})
}
}
/// Default capability-aware Linux publication, independent of HTTP.
pub struct DefaultComposition {
interfaces: DefaultInterfaces,
}
impl DefaultComposition {
/// Use previously registered built-in interface tokens.
pub fn new(interfaces: DefaultInterfaces) -> Self {
Self { interfaces }
}
}
/// Request-scoped default Object; external Objects may instead wrap `LinuxEntry`.
pub struct DefaultObject {
entry: LinuxEntry,
write: InterfaceRef,
}
impl DefaultObject {
/// The pinned, bounded capability used by every operation on this Object.
pub fn entry(&self) -> &LinuxEntry {
&self.entry
}
}
impl WipObject for DefaultObject {
fn name(&self) -> &str {
self.entry.name()
}
fn description(&self) -> Option<&str> {
self.entry.description()
}
fn reference(&self) -> Option<&str> {
self.entry.reference()
}
fn validator(&self) -> Option<&Validator> {
self.entry.validator()
}
fn requires_validator(&self, interface: &InterfaceRef, operation: &str) -> bool {
interface == &self.write && operation == "replace"
}
}
impl FileRead for DefaultObject {
fn read(&self, offset: Option<u64>, length: Option<u64>) -> wip::OperationResult<wip::Bytes> {
self.entry.read(offset, length)
}
}
impl SymlinkInspect for DefaultObject {
fn read_link(&self) -> wip::OperationResult<wip::Bytes> {
self.entry.read_link()
}
}
impl FileWrite for DefaultObject {
fn replace(&self, contents: wip::Bytes) -> wip::OperationResult<()> {
self.entry.replace(contents)
}
}
impl Composition<LinuxEntry> for DefaultComposition {
type Object = DefaultObject;
fn publish(
&self,
entry: LinuxEntry,
_: &ExecutionContext,
) -> Result<PublishedObject<Self::Object>, HostError> {
let kind = entry.kind();
let writable = entry.access_mode() == AccessMode::ReadWrite;
let mut publication = PublishedObject::new(DefaultObject {
entry,
write: self.interfaces.write.reference().clone(),
});
match kind {
EntryKind::Regular => {
publication = publication
.expose(&self.interfaces.read)
.map_err(publication_error)?;
if writable {
publication = publication
.expose(&self.interfaces.write)
.map_err(publication_error)?;
}
}
EntryKind::Symlink => {
publication = publication
.expose(&self.interfaces.symlink)
.map_err(publication_error)?;
}
EntryKind::Directory | EntryKind::Unsupported => {}
}
Ok(publication)
}
}
fn publication_error(_: wip_host::PublicationError) -> HostError {
HostError::internal(
"default publication failed",
wip_host::EffectGuarantee::NotCommitted,
)
}
/// Construct the secure-by-default Linux engine without binding a listener.
pub fn default_projection(
root: &std::path::Path,
access: AccessMode,
limits: ResourceLimits,
) -> Result<Projection<LinuxBackend, DefaultComposition, DefaultPolicy>, std::io::Error> {
let backend = LinuxBackend::open(root, access, limits)?;
let mut registry = InterfaceRegistry::new();
let interfaces = DefaultInterfaces::register(&mut registry).map_err(std::io::Error::other)?;
Ok(Projection::new(
backend,
registry,
DefaultComposition::new(interfaces),
DefaultPolicy,
limits,
))
}
+661
View File
@@ -0,0 +1,661 @@
//! Transport-independent projection, publication, and principal view boundaries.
use crate::ResourceLimits;
use wip_host::{
EffectGuarantee, ExecutionContext, HostError, InterfaceRef, InterfaceRegistry, ObjectProvider,
OperationAttempt, ProviderResult, PublishedObject, WipObject,
};
use wip_protocol::{
FetchInterfaceRequest, FetchInterfaceResponse, ObjectObservation, ObserveRequest,
ObserveResponse, ProtocolError, ProtocolErrorCode,
};
/// Portable entry classification; capabilities must not be inferred from kind alone.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum EntryKind {
/// Container whose children can be enumerated.
Directory,
/// Regular data entry.
Regular,
/// Link itself, never implicitly followed.
Symlink,
/// Metadata-only entry unless the composition supplies a capability.
Unsupported,
}
/// A root-confined, request-time capability, not a path to resolve again.
///
/// Metadata must be safe for public exposure. Validators bind both identity and
/// protected state. Cloning must retain the same target rather than re-resolve it.
pub trait BackendEntry: WipObject + Clone {
/// Classification for observation and publication selection.
fn kind(&self) -> EntryKind;
}
/// A single resolved target together with its retained root-to-parent lineage.
///
/// The backend must resolve a connected lineage, never independent raw-path
/// prefixes. At execution it validates ancestor membership/identity, refreshes
/// their policy metadata, and pins that snapshot through dispatch. Target
/// replacement must not redirect the original capability. This value is private
/// backend context, not protocol metadata.
#[derive(Clone)]
pub struct ResolvedEntry<E> {
ancestors: Vec<E>,
target: E,
}
impl<E> ResolvedEntry<E> {
/// Create backend resolution context. `/` has no ancestors; a non-root target
/// has the pinned root first, followed by its intermediate parent containers.
pub fn new(ancestors: Vec<E>, target: E) -> Self {
Self { ancestors, target }
}
/// Pinned ancestor capabilities, ordered from the root to the direct parent.
pub fn ancestors(&self) -> &[E] {
&self.ancestors
}
/// The original resolved target capability, never a redirected replacement.
pub fn target(&self) -> &E {
&self.target
}
/// Consume this snapshot for refresh or request-time publication.
pub fn into_parts(self) -> (Vec<E>, E) {
(self.ancestors, self.target)
}
}
/// Trusted backend boundary. Implementations need not use POSIX semantics.
///
/// Resolve and enumerate pinned capabilities within the configured root. Enforce
/// context cancellation, deadlines and work budgets during backend work. Do not
/// advertise capabilities the backend cannot guarantee. Errors must not include
/// backend paths, credentials or hidden metadata.
///
/// `execute` must retain the same target and complete lineage and serialize
/// ancestor identity/membership checks, policy metadata, validator observation,
/// publication, validation, typed dispatch and commit/rollback. Changed/detached
/// ancestors must return `NotFound` before the callback; never substitute a new
/// ancestor or redirect the target by re-resolving its raw path. Refresh *all*
/// lineage metadata/validators inside the boundary and retain that snapshot
/// through dispatch, then return the committed post-operation validator. Never
/// upgrade an unknown outcome except after confirmed rollback. Locks only protect
/// actors participating in the protocol; document any external-writer limits.
pub trait FilesystemBackend {
/// Stable capability supplied to the composition.
type Entry: BackendEntry;
/// Resolve a canonical WIP path and retain its connected ancestry.
///
/// Obtain the target and lineage in one backend traversal/snapshot. Enforce
/// configured handle/work budgets while retaining ancestors; do not silently
/// omit ancestry on resource exhaustion.
fn resolve(
&self,
context: &ExecutionContext,
path: &str,
) -> ProviderResult<ResolvedEntry<Self::Entry>>;
/// Enumerate direct children, at most `maximum`; excess must fail, not truncate.
fn children(
&self,
context: &ExecutionContext,
entry: &Self::Entry,
maximum: usize,
) -> Result<Vec<Self::Entry>, HostError>;
/// Execute against this already-resolved target within an atomic boundary.
fn execute(
&self,
context: &ExecutionContext,
entry: ResolvedEntry<Self::Entry>,
operation: impl FnOnce(ResolvedEntry<Self::Entry>) -> OperationAttempt,
) -> ProviderResult<OperationAttempt>;
}
/// Typed publication extension point, implementable on an external crate's type.
///
/// Use `InterfaceRegistry::register` and `PublishedObject::expose` with generated
/// definitions. An external local Object can wrap the entry and implement any
/// number of interfaces, avoiding orphan rules. Its `WipObject` implementation
/// declares validator requirements per qualified operation. Operation failures
/// declare their own `EffectGuarantee`, not a fixed read/write classification.
pub trait Composition<E: BackendEntry> {
/// Local typed operation implementation and safe public metadata.
type Object: WipObject;
/// Build a request-scoped publication using this exact capability/context.
///
/// Publication and policy hooks must be side-effect-free with respect to the
/// backend. A publication failure is a pre-dispatch rejection, never a
/// started Operation. Delegate metadata/validators to the boundary snapshot.
fn publish(
&self,
entry: E,
context: &ExecutionContext,
) -> Result<PublishedObject<Self::Object>, HostError>;
}
/// Principal-specific view policy, independent of authentication transport.
///
/// Keep decisions deterministic and stable within an effective Worldspace view.
/// A changed policy requires a new view/reference lifetime (or interface
/// validators). Operation visibility is interface-wide within a view so every
/// published reference has exactly the descriptor returned by fetch. Entry-
/// specific differences should select different registered interfaces. Hooks
/// cannot add implementations, metadata, or raw paths to a publication.
pub trait ProjectionPolicy<E: BackendEntry, O: WipObject> {
/// Opaque deployment-established principal/request identity.
type Principal;
/// Whether the entry is visible. Invisible ancestors hide their whole subtree.
fn object_visible(&self, principal: &Self::Principal, entry: &E) -> bool;
/// Whether an interface descriptor may be fetched in this view.
fn interface_visible(&self, _principal: &Self::Principal, _interface: &InterfaceRef) -> bool {
true
}
/// Select/order a subset of implemented interfaces; defaults to all.
fn interfaces(
&self,
_principal: &Self::Principal,
_entry: &E,
available: &[InterfaceRef],
) -> Vec<InterfaceRef> {
available.to_vec()
}
/// Whether an operation is present in this view's descriptor and dispatch.
fn operation_visible(
&self,
_principal: &Self::Principal,
_interface: &InterfaceRef,
_operation: &str,
) -> bool {
true
}
/// Execution permission for a visible operation, after canonical preconditions.
fn authorize(
&self,
_principal: &Self::Principal,
_object: &O,
_interface: &InterfaceRef,
_operation: &str,
) -> bool {
true
}
}
/// No authentication assumption: all configured objects/operations are visible.
pub struct DefaultPolicy;
impl<E: BackendEntry, O: WipObject> ProjectionPolicy<E, O> for DefaultPolicy {
type Principal = ();
fn object_visible(&self, _: &(), _: &E) -> bool {
true
}
}
/// Canonical request-time engine, independent of HTTP and Linux.
pub struct Projection<B, C, P> {
backend: B,
registry: InterfaceRegistry,
composition: C,
policy: P,
limits: ResourceLimits,
}
impl<B, C, P> Projection<B, C, P>
where
B: FilesystemBackend,
C: Composition<B::Entry>,
P: ProjectionPolicy<B::Entry, C::Object>,
{
/// Assemble trusted components. The registry must contain all exposed tokens.
pub fn new(
backend: B,
registry: InterfaceRegistry,
composition: C,
policy: P,
limits: ResourceLimits,
) -> Self {
Self {
backend,
registry,
composition,
policy,
limits,
}
}
/// Backend access for trusted composition/configuration, never serialized.
pub fn backend(&self) -> &B {
&self.backend
}
/// Borrow one effective principal view for observation, fetch and dispatch.
pub fn view<'a>(&'a self, principal: &'a P::Principal) -> ProjectionView<'a, B, C, P> {
ProjectionView {
projection: self,
principal,
}
}
}
/// A coherent principal view implementing canonical typed host dispatch.
pub struct ProjectionView<'a, B, C, P>
where
B: FilesystemBackend,
C: Composition<B::Entry>,
P: ProjectionPolicy<B::Entry, C::Object>,
{
projection: &'a Projection<B, C, P>,
principal: &'a P::Principal,
}
impl<B, C, P> ProjectionView<'_, B, C, P>
where
B: FilesystemBackend,
C: Composition<B::Entry>,
P: ProjectionPolicy<B::Entry, C::Object>,
{
fn resolve(
&self,
context: &ExecutionContext,
path: &str,
) -> ProviderResult<ResolvedEntry<B::Entry>> {
if let Err(error) = preflight(context) {
return ProviderResult::Failure(error);
}
if wip_protocol::validate_path(path).is_err() {
return ProviderResult::NotFound;
}
match self.projection.backend.resolve(context, path) {
ProviderResult::Found(resolved) => {
if !lineage_matches_path(&resolved, path) {
return ProviderResult::Failure(internal());
}
if !self.lineage_visible(&resolved) {
return ProviderResult::NotFound;
}
ProviderResult::Found(resolved)
}
ProviderResult::NotFound => ProviderResult::NotFound,
ProviderResult::Failure(error) => ProviderResult::Failure(error),
}
}
fn lineage_visible(&self, resolved: &ResolvedEntry<B::Entry>) -> bool {
resolved
.ancestors()
.iter()
.chain(std::iter::once(resolved.target()))
.all(|entry| self.projection.policy.object_visible(self.principal, entry))
}
fn publication(
&self,
entry: B::Entry,
context: &ExecutionContext,
) -> Result<PublishedObject<C::Object>, HostError> {
let publication = self
.projection
.composition
.publish(entry.clone(), context)?;
let available = publication
.protocol_object()
.interfaces
.iter()
.map(|reference| {
self.projection
.registry
.resolve(reference)
.ok_or_else(internal)
})
.collect::<Result<Vec<_>, _>>()?;
let mut selected = self
.projection
.policy
.interfaces(self.principal, &entry, &available);
selected.retain(|reference| {
self.projection
.policy
.interface_visible(self.principal, reference)
});
publication
.project(&selected, |reference, operation| {
self.projection
.policy
.operation_visible(self.principal, reference, operation)
})
.map_err(|_| internal())
}
/// Retrieve the descriptor with precisely this principal's visible operations.
pub fn fetch_interface(
&self,
request: &FetchInterfaceRequest,
) -> Result<FetchInterfaceResponse, ProtocolError> {
read_boundary(|| self.fetch_interface_inner(request))
}
fn fetch_interface_inner(
&self,
request: &FetchInterfaceRequest,
) -> Result<FetchInterfaceResponse, ProtocolError> {
let observation = self
.projection
.registry
.fetch_interface(&request.interface)?;
if !self
.projection
.policy
.interface_visible(self.principal, &observation.reference)
{
return Err(protocol(
ProtocolErrorCode::InterfaceNotFound,
"interface is not published",
));
}
let reference = observation.reference.clone();
observation
.project_operations(|operation| {
self.projection
.policy
.operation_visible(self.principal, &reference, operation)
})
.protocol_response()
}
/// Observe a complete bounded tree, omitting invisible children and subtrees.
pub fn observe(
&self,
context: &ExecutionContext,
request: &ObserveRequest,
) -> Result<ObserveResponse, ProtocolError> {
read_boundary(|| self.observe_inner(context, request))
}
fn observe_inner(
&self,
context: &ExecutionContext,
request: &ObserveRequest,
) -> Result<ObserveResponse, ProtocolError> {
request
.validate()
.map_err(|_| protocol(ProtocolErrorCode::InvalidRequest, "invalid observe request"))?;
if request.depth > self.projection.limits.max_observation_depth {
return Err(resource_protocol());
}
let entry = match self.resolve(context, &request.path) {
ProviderResult::Found(entry) => entry,
ProviderResult::NotFound => {
return Err(protocol(
ProtocolErrorCode::NotFound,
"target path is not published",
));
}
ProviderResult::Failure(error) => return Err(read_error(error)),
};
let (_ancestors, entry) = entry.into_parts();
let mut remaining = u64::from(self.projection.limits.max_observation_nodes)
.min(context.resource_budget().unwrap_or(u64::MAX));
let response = self.observe_entry(context, entry, request.depth, &mut remaining)?;
request.validate_response(&response).map_err(|_| {
protocol(
ProtocolErrorCode::Internal,
"invalid projection observation",
)
})?;
Ok(response)
}
fn observe_entry(
&self,
context: &ExecutionContext,
entry: B::Entry,
depth: u32,
remaining: &mut u64,
) -> Result<ObjectObservation, ProtocolError> {
preflight(context).map_err(read_error)?;
if *remaining == 0 {
return Err(resource_protocol());
}
*remaining -= 1;
let object = self
.publication(entry.clone(), context)
.map_err(read_error)?
.protocol_object();
if depth == 0 {
return Ok(ObjectObservation {
object,
children: None,
});
}
let mut children = Vec::new();
if entry.kind() == EntryKind::Directory {
let entries = self
.projection
.backend
.children(
context,
&entry,
usize::try_from(*remaining).unwrap_or(usize::MAX),
)
.map_err(read_error)?;
if entries.len() as u64 > *remaining {
return Err(resource_protocol());
}
for child in entries {
if self
.projection
.policy
.object_visible(self.principal, &child)
{
children.push(self.observe_entry(context, child, depth - 1, remaining)?);
} else {
if *remaining == 0 {
return Err(resource_protocol());
}
*remaining -= 1;
}
}
}
Ok(ObjectObservation {
object,
children: Some(children),
})
}
}
impl<B, C, P> ObjectProvider for ProjectionView<'_, B, C, P>
where
B: FilesystemBackend,
C: Composition<B::Entry>,
P: ProjectionPolicy<B::Entry, C::Object>,
{
type Object = C::Object;
fn with_object<R>(
&self,
context: &ExecutionContext,
path: &str,
operation: impl FnOnce(&PublishedObject<Self::Object>) -> R,
) -> ProviderResult<R> {
match self.resolve(context, path) {
ProviderResult::Found(resolved) => {
let (_ancestors, entry) = resolved.into_parts();
match self.publication(entry, context) {
Ok(publication) => ProviderResult::Found(operation(&publication)),
Err(error) => ProviderResult::Failure(error),
}
}
ProviderResult::NotFound => ProviderResult::NotFound,
ProviderResult::Failure(error) => ProviderResult::Failure(error),
}
}
fn execute_operation(
&self,
context: &ExecutionContext,
path: &str,
operation: impl FnOnce(&PublishedObject<Self::Object>) -> OperationAttempt,
) -> ProviderResult<OperationAttempt> {
let entry = match self.resolve(context, path) {
ProviderResult::Found(entry) => entry,
ProviderResult::NotFound => return ProviderResult::NotFound,
ProviderResult::Failure(error) => return ProviderResult::Failure(error),
};
self.projection.backend.execute(context, entry, |resolved| {
// Backend validates retained lineage membership/identity and refreshes
// all metadata before this callback under the same boundary as dispatch.
if !lineage_matches_path(&resolved, path) {
return OperationAttempt::reject(wip_host::CallErrorKind::Internal);
}
if !self.lineage_visible(&resolved) {
return OperationAttempt::reject(wip_host::CallErrorKind::NotFound);
}
let (_ancestors, entry) = resolved.into_parts();
if let Err(error) = preflight(context) {
return OperationAttempt::reject(match error.kind() {
wip_host::HostErrorKind::Internal => wip_host::CallErrorKind::Internal,
wip_host::HostErrorKind::ResourceLimitExceeded => {
wip_host::CallErrorKind::ResourceLimitExceeded
}
});
}
match self.publication(entry, context) {
Ok(publication) => operation(&publication),
Err(error) => OperationAttempt::reject(match error.kind() {
wip_host::HostErrorKind::Internal => wip_host::CallErrorKind::Internal,
wip_host::HostErrorKind::ResourceLimitExceeded => {
wip_host::CallErrorKind::ResourceLimitExceeded
}
}),
}
})
}
fn authorize(
&self,
_: &str,
object: &Self::Object,
interface: &InterfaceRef,
operation: &str,
) -> bool {
self.projection
.policy
.authorize(self.principal, object, interface, operation)
}
}
impl<B, C, P> ObjectProvider for Projection<B, C, P>
where
B: FilesystemBackend,
C: Composition<B::Entry>,
P: ProjectionPolicy<B::Entry, C::Object, Principal = ()>,
{
type Object = C::Object;
fn with_object<R>(
&self,
context: &ExecutionContext,
path: &str,
operation: impl FnOnce(&PublishedObject<Self::Object>) -> R,
) -> ProviderResult<R> {
self.view(&()).with_object(context, path, operation)
}
fn execute_operation(
&self,
context: &ExecutionContext,
path: &str,
operation: impl FnOnce(&PublishedObject<Self::Object>) -> OperationAttempt,
) -> ProviderResult<OperationAttempt> {
self.view(&()).execute_operation(context, path, operation)
}
fn authorize(
&self,
path: &str,
object: &Self::Object,
interface: &InterfaceRef,
operation: &str,
) -> bool {
self.view(&()).authorize(path, object, interface, operation)
}
}
impl<B, C, P> Projection<B, C, P>
where
B: FilesystemBackend,
C: Composition<B::Entry>,
P: ProjectionPolicy<B::Entry, C::Object, Principal = ()>,
{
/// Observe the default unit-principal view.
pub fn observe(
&self,
context: &ExecutionContext,
request: &ObserveRequest,
) -> Result<ObserveResponse, ProtocolError> {
self.view(&()).observe(context, request)
}
/// Fetch in the default unit-principal view.
pub fn fetch_interface(
&self,
request: &FetchInterfaceRequest,
) -> Result<FetchInterfaceResponse, ProtocolError> {
self.view(&()).fetch_interface(request)
}
}
fn lineage_matches_path<E: BackendEntry>(resolved: &ResolvedEntry<E>, path: &str) -> bool {
let names: Vec<_> = if path == "/" {
vec![""]
} else {
std::iter::once("").chain(path[1..].split('/')).collect()
};
if resolved.ancestors().len() + 1 != names.len()
|| resolved.target().name() != names[names.len() - 1]
{
return false;
}
resolved
.ancestors()
.iter()
.zip(names)
.all(|(entry, name)| entry.kind() == EntryKind::Directory && entry.name() == name)
}
fn read_boundary<T>(
operation: impl FnOnce() -> Result<T, ProtocolError>,
) -> Result<T, ProtocolError> {
std::panic::catch_unwind(std::panic::AssertUnwindSafe(operation))
.unwrap_or_else(|_| Err(protocol(ProtocolErrorCode::Internal, "projection failed")))
}
fn internal() -> HostError {
HostError::internal(
"projection publication failed",
EffectGuarantee::NotCommitted,
)
}
fn protocol(code: ProtocolErrorCode, message: &str) -> ProtocolError {
ProtocolError {
code,
message: message.into(),
}
}
fn resource_protocol() -> ProtocolError {
protocol(
ProtocolErrorCode::ResourceLimitExceeded,
"projection resource limit exceeded",
)
}
fn read_error(error: HostError) -> ProtocolError {
match error.kind() {
wip_host::HostErrorKind::ResourceLimitExceeded => resource_protocol(),
wip_host::HostErrorKind::Internal => {
protocol(ProtocolErrorCode::Internal, "projection failed")
}
}
}
fn preflight(context: &ExecutionContext) -> Result<(), HostError> {
if context.cancellation().is_cancelled()
|| context
.deadline()
.is_some_and(|deadline| std::time::Instant::now() >= deadline)
|| context.resource_budget() == Some(0)
{
Err(HostError::resource_limit(
"projection work limit exceeded",
EffectGuarantee::NotCommitted,
))
} else {
Ok(())
}
}
+435
View File
@@ -0,0 +1,435 @@
//! Framework-neutral standard WIP over HTTP mapping for a projection view.
use std::time::Instant;
use http::header::ALLOW;
use http::{Request, Response, StatusCode};
use wip_host::{ExecutionContext, ObjectProvider};
use wip_http::{
CodecError, EncodeHttpError, Endpoint, RequestMetadataError, Route,
decode_call_operation_metadata, decode_fetch_interface_request, decode_observe_request,
encode_call_operation_response, encode_fetch_interface_response, encode_observe_response,
encode_protocol_error_response, validate_http_request,
};
use wip_protocol::{ProtocolError, ProtocolErrorCode, ProtocolInteraction};
use crate::engine::ProjectionView;
use crate::{Composition, FilesystemBackend, ProjectionPolicy, ResourceLimits};
/// Standard HTTP routes and codecs over a caller-scoped projection view.
///
/// The adapter borrows the view and endpoint without owning a listener, selecting
/// a principal, or imposing a new execution context. Integrations must enforce
/// the request body limit while collecting bytes, before calling this adapter.
pub struct HttpAdapter<'a, 'view, B, C, P>
where
B: FilesystemBackend,
C: Composition<B::Entry>,
P: ProjectionPolicy<B::Entry, C::Object>,
{
view: &'a ProjectionView<'view, B, C, P>,
endpoint: &'a Endpoint,
limits: ResourceLimits,
}
impl<'a, 'view, B, C, P> HttpAdapter<'a, 'view, B, C, P>
where
B: FilesystemBackend,
C: Composition<B::Entry>,
P: ProjectionPolicy<B::Entry, C::Object>,
{
/// Creates an adapter for an already-selected principal's projection view.
#[must_use]
pub fn new(
view: &'a ProjectionView<'view, B, C, P>,
endpoint: &'a Endpoint,
limits: ResourceLimits,
) -> Self {
Self {
view,
endpoint,
limits,
}
}
/// Handles one buffered request using the supplied execution controls.
///
/// Observation and operation dispatch receive the original context, including
/// cancellation and resource budget. An elapsed deadline after dispatch keeps
/// the listener's existing empty HTTP 504 transport-failure behavior.
#[must_use]
pub fn handle_http_with_context(
&self,
request: Request<Vec<u8>>,
context: &ExecutionContext,
) -> Response<Vec<u8>> {
let Some(route) = self.route(request.uri()) else {
return empty_response(StatusCode::NOT_FOUND);
};
if let Err(error) = validate_http_request(self.endpoint, route, &request) {
return self.metadata_error(error);
}
let response = match route {
Route::Observe => self.observe(request.body(), context),
Route::FetchInterface => self.fetch_interface(request.body()),
Route::CallOperation => self.call_operation(request.body(), context),
};
if context
.deadline()
.is_some_and(|deadline| Instant::now() >= deadline)
{
empty_response(StatusCode::GATEWAY_TIMEOUT)
} else {
response
}
}
fn route(&self, uri: &http::Uri) -> Option<Route> {
if uri.query().is_some() {
return None;
}
[Route::Observe, Route::FetchInterface, Route::CallOperation]
.into_iter()
.find(|route| self.endpoint.route(*route).path() == uri.path())
}
fn observe(&self, body: &[u8], context: &ExecutionContext) -> Response<Vec<u8>> {
let request = match decode_observe_request(body, self.limits.wire) {
Ok(request) => request,
Err(error) => return self.codec_error(ProtocolInteraction::Observe, error),
};
match self.view.observe(context, &request) {
Ok(tree) => {
encode_observe_response(&request, &tree, self.limits.wire).unwrap_or_else(|error| {
self.read_encode_error(ProtocolInteraction::Observe, error)
})
}
Err(error) => self.protocol_error(ProtocolInteraction::Observe, &error),
}
}
fn fetch_interface(&self, body: &[u8]) -> Response<Vec<u8>> {
let request = match decode_fetch_interface_request(body, self.limits.wire) {
Ok(request) => request,
Err(error) => return self.codec_error(ProtocolInteraction::FetchInterface, error),
};
match self.view.fetch_interface(&request) {
Ok(interface) => {
encode_fetch_interface_response(&request, &interface, self.limits.wire)
.unwrap_or_else(|error| {
self.read_encode_error(ProtocolInteraction::FetchInterface, error)
})
}
Err(error) => self.protocol_error(ProtocolInteraction::FetchInterface, &error),
}
}
fn call_operation(&self, body: &[u8], context: &ExecutionContext) -> Response<Vec<u8>> {
let metadata = match decode_call_operation_metadata(body, self.limits.wire) {
Ok(metadata) => metadata,
Err(error) => return self.codec_error(ProtocolInteraction::CallOperation, error),
};
let decoded = std::sync::Mutex::new(None);
let execution = self.view.call_operation_with_context_and_decoder(
context,
metadata.target.clone(),
metadata.interface.clone(),
metadata.operation.clone(),
|descriptor| {
let request = metadata.decode_request(body, descriptor, self.limits.wire)?;
let arguments = request.arguments.clone();
*decoded.lock().unwrap_or_else(|error| error.into_inner()) =
Some((request, descriptor.clone()));
Ok::<_, CodecError>(arguments)
},
);
match execution.map_err(|error| error.protocol_error()) {
Ok(result) => {
let Some((request, descriptor)) = decoded
.into_inner()
.unwrap_or_else(|error| error.into_inner())
else {
return self.protocol_error(
ProtocolInteraction::CallOperation,
&operation_outcome_unknown(),
);
};
encode_call_operation_response(&request, &descriptor, &result, self.limits.wire)
.unwrap_or_else(|error| self.operation_encode_error(error))
}
Err(error) => self.protocol_error(ProtocolInteraction::CallOperation, &error),
}
}
fn operation_encode_error(&self, error: EncodeHttpError) -> Response<Vec<u8>> {
if matches!(&error, EncodeHttpError::Codec(codec) if is_transport_limit(codec)) {
return empty_response(StatusCode::INTERNAL_SERVER_ERROR);
}
// Any successfully executed operation may have committed effects. Its
// name cannot establish a non-commit guarantee after response failure.
self.protocol_error(
ProtocolInteraction::CallOperation,
&operation_outcome_unknown(),
)
}
fn metadata_error(&self, error: RequestMetadataError) -> Response<Vec<u8>> {
match error {
RequestMetadataError::NotFound => empty_response(StatusCode::NOT_FOUND),
error @ RequestMetadataError::MethodNotAllowed => Response::builder()
.status(error.status())
.header(
ALLOW,
error
.allow()
.expect("method-not-allowed metadata has an Allow value"),
)
.body(Vec::new())
.expect("static method response is valid"),
RequestMetadataError::UnsupportedMediaType => {
empty_response(StatusCode::UNSUPPORTED_MEDIA_TYPE)
}
RequestMetadataError::NotAcceptable => empty_response(StatusCode::NOT_ACCEPTABLE),
}
}
fn codec_error(
&self,
interaction: ProtocolInteraction,
error: CodecError,
) -> Response<Vec<u8>> {
if is_transport_limit(&error) {
empty_response(StatusCode::PAYLOAD_TOO_LARGE)
} else {
self.protocol_error(
interaction,
&ProtocolError {
code: ProtocolErrorCode::InvalidRequest,
message: "malformed WIP request".into(),
},
)
}
}
fn read_encode_error(
&self,
interaction: ProtocolInteraction,
error: EncodeHttpError,
) -> Response<Vec<u8>> {
match error {
EncodeHttpError::Codec(codec) if is_transport_limit(&codec) => {
empty_response(StatusCode::INTERNAL_SERVER_ERROR)
}
_ => self.protocol_error(
interaction,
&ProtocolError {
code: ProtocolErrorCode::Internal,
message: "HTTP adapter failed".into(),
},
),
}
}
fn protocol_error(
&self,
interaction: ProtocolInteraction,
error: &ProtocolError,
) -> Response<Vec<u8>> {
// Engine and policy diagnostics may contain paths, argument values, or
// backend details. Emit only fixed, bounded diagnostics on the wire.
let sanitized = ProtocolError {
code: error.code,
message: sanitized_message(error.code).into(),
};
encode_protocol_error_response(interaction, &sanitized, self.limits.wire)
.unwrap_or_else(|_| empty_response(StatusCode::INTERNAL_SERVER_ERROR))
}
}
fn operation_outcome_unknown() -> ProtocolError {
ProtocolError {
code: ProtocolErrorCode::OperationOutcomeUnknown,
message: "operation completed but its response could not be encoded".into(),
}
}
fn sanitized_message(code: ProtocolErrorCode) -> &'static str {
match code {
ProtocolErrorCode::InvalidRequest => "malformed WIP request",
ProtocolErrorCode::NotFound => "target path is not published",
ProtocolErrorCode::InterfaceNotFound => "interface is not published",
ProtocolErrorCode::InterfaceMismatch => "interface is not published on the target",
ProtocolErrorCode::OperationNotFound => "operation is not published",
ProtocolErrorCode::InvalidArguments => "arguments do not match the operation",
ProtocolErrorCode::ValidatorRequired => "object validator is required",
ProtocolErrorCode::ValidatorMismatch => "object validator does not match",
ProtocolErrorCode::InterfaceValidatorRequired => "interface validator is required",
ProtocolErrorCode::InterfaceValidatorMismatch => "interface validator does not match",
ProtocolErrorCode::PermissionDenied => "operation is not permitted",
ProtocolErrorCode::ResourceLimitExceeded => "projection resource limit exceeded",
ProtocolErrorCode::Internal => "HTTP adapter failed",
ProtocolErrorCode::OperationOutcomeUnknown => "operation outcome is unknown",
}
}
fn is_transport_limit(error: &CodecError) -> bool {
matches!(
error,
CodecError::BodyTooLarge { .. } | CodecError::NestingTooDeep { .. }
)
}
fn empty_response(status: StatusCode) -> Response<Vec<u8>> {
Response::builder()
.status(status)
.body(Vec::new())
.expect("static status builds an HTTP response")
}
#[cfg(test)]
mod tests {
use super::*;
use tempfile::tempdir;
use wip_http::{
DecodedResponse, Limits, decode_fetch_interface_response, decode_observe_response,
encode_fetch_interface_request, encode_observe_request,
};
use wip_protocol::{FetchInterfaceRequest, ObserveRequest};
#[test]
fn adapter_serves_observation_and_interface_fetch_without_server() {
let root = tempdir().unwrap();
std::fs::write(root.path().join("file"), b"contents").unwrap();
let limits = ResourceLimits::default();
let projection =
crate::default_projection(root.path(), crate::AccessMode::ReadOnly, limits).unwrap();
let view = projection.view(&());
let endpoint = Endpoint::parse("http://localhost/custom").unwrap();
let adapter = HttpAdapter::new(&view, &endpoint, limits);
let context = ExecutionContext::new();
let request = ObserveRequest {
path: "/file".into(),
depth: 0,
};
let response = adapter.handle_http_with_context(
encode_observe_request(&endpoint, &request, limits.wire).unwrap(),
&context,
);
let DecodedResponse::Success(observation) =
decode_observe_response(&request, &response, limits.wire).unwrap()
else {
panic!("expected observation success")
};
let request = FetchInterfaceRequest {
interface: observation.object.interfaces[0].clone(),
};
let response = adapter.handle_http_with_context(
encode_fetch_interface_request(&endpoint, &request, limits.wire).unwrap(),
&context,
);
assert!(matches!(
decode_fetch_interface_response(&request, &response, limits.wire).unwrap(),
DecodedResponse::Success(_)
));
}
#[test]
fn adapter_preserves_transport_boundaries_and_execution_context() {
let root = tempdir().unwrap();
let limits = ResourceLimits::default();
let projection =
crate::default_projection(root.path(), crate::AccessMode::ReadOnly, limits).unwrap();
let view = projection.view(&());
let endpoint = Endpoint::parse("http://localhost/wip").unwrap();
let adapter = HttpAdapter::new(&view, &endpoint, limits);
let context = ExecutionContext::new();
for uri in [
"/wip/v1/observe?query=1",
"/wip/v1/unknown",
"/wip/v1/observe/extra",
] {
let response = adapter.handle_http_with_context(
Request::builder().uri(uri).body(Vec::new()).unwrap(),
&context,
);
assert_eq!(response.status(), StatusCode::NOT_FOUND);
assert!(response.body().is_empty());
}
let response = adapter.handle_http_with_context(
Request::builder()
.uri("/wip/v1/observe")
.body(Vec::new())
.unwrap(),
&context,
);
assert_eq!(response.status(), StatusCode::METHOD_NOT_ALLOWED);
assert_eq!(response.headers()[ALLOW], "POST");
assert!(response.body().is_empty());
let request = ObserveRequest {
path: "/".into(),
depth: 0,
};
let response = adapter.handle_http_with_context(
encode_observe_request(&endpoint, &request, limits.wire).unwrap(),
&ExecutionContext::new().with_resource_budget(0),
);
let text = std::str::from_utf8(response.body()).unwrap();
assert!(text.contains("resource_limit_exceeded"));
let response = adapter.handle_http_with_context(
encode_observe_request(&endpoint, &request, limits.wire).unwrap(),
&ExecutionContext::new().with_deadline(Instant::now()),
);
assert_eq!(response.status(), StatusCode::GATEWAY_TIMEOUT);
assert!(response.body().is_empty());
}
#[test]
fn post_success_encoding_is_unknown_except_empty_transport_limit_failure() {
let root = tempdir().unwrap();
let limits = ResourceLimits::default();
let projection =
crate::default_projection(root.path(), crate::AccessMode::ReadOnly, limits).unwrap();
let view = projection.view(&());
let endpoint = Endpoint::parse("http://localhost/wip").unwrap();
let adapter = HttpAdapter::new(&view, &endpoint, limits);
let error = decode_observe_request(b"{", limits.wire).unwrap_err();
let response = adapter.operation_encode_error(EncodeHttpError::Codec(error));
assert!(
std::str::from_utf8(response.body())
.unwrap()
.contains("operation_outcome_unknown")
);
let tiny_limits = Limits::new(1, 1, 1).unwrap();
let error = decode_observe_request(b"{}", tiny_limits).unwrap_err();
assert!(is_transport_limit(&error));
let response = adapter.operation_encode_error(EncodeHttpError::Codec(error));
assert_eq!(response.status(), StatusCode::INTERNAL_SERVER_ERROR);
assert!(response.body().is_empty());
assert!(!response.headers().contains_key(http::header::CONTENT_TYPE));
}
#[test]
fn engine_error_diagnostics_are_sanitized_and_bounded() {
let root = tempdir().unwrap();
let limits = ResourceLimits::default();
let projection =
crate::default_projection(root.path(), crate::AccessMode::ReadOnly, limits).unwrap();
let view = projection.view(&());
let endpoint = Endpoint::parse("http://localhost/wip").unwrap();
let adapter = HttpAdapter::new(&view, &endpoint, limits);
let response = adapter.protocol_error(
ProtocolInteraction::Observe,
&ProtocolError {
code: ProtocolErrorCode::Internal,
message: "/private/backend/secret".repeat(1000),
},
);
assert!(response.body().len() < 512);
assert!(
!std::str::from_utf8(response.body())
.unwrap()
.contains("secret")
);
assert_eq!(response.status(), StatusCode::INTERNAL_SERVER_ERROR);
}
}
+45 -1
View File
@@ -7,12 +7,46 @@
//! - [`wip_http`] owns routes, JSON, envelopes, and status mapping; //! - [`wip_http`] owns routes, JSON, envelopes, and status mapping;
//! - this crate owns the filesystem capability boundary and the real HTTP listener. //! - this crate owns the filesystem capability boundary and the real HTTP listener.
//! //!
//! # Extension boundary
//!
//! [`Projection`] composes a [`FilesystemBackend`], typed [`Composition`] and
//! [`ProjectionPolicy`]. External local Objects can wrap a [`BackendEntry`] and
//! implement generated interfaces without orphan-rule workarounds. The backend
//! retains a root-confined target and atomic validator/dispatch boundary; the
//! engine owns recursive observation and standard host typed validation. No
//! listener is needed to use [`ProjectionView`]. [`HttpAdapter`] applies the
//! existing standard HTTP binding to a deployment-established principal view.
//!
//! Backends and Operations are trusted code, responsible for truthful effects,
//! public-only metadata and ongoing execution-context bounds. Policies must be
//! stable within a view; changing descriptor visibility requires new reference
//! lifetimes. See the crate README for implementer security and migration details.
//!
//! ```no_run
//! use wip_fs_server::{default_projection, AccessMode, ResourceLimits};
//! use wip_host::{ExecutionContext, ObjectProvider};
//! use wip_protocol::ObserveRequest;
//!
//! let engine = default_projection(std::path::Path::new("./public"),
//! AccessMode::ReadOnly, ResourceLimits::default())?;
//! let view = engine.view(&());
//! let context = ExecutionContext::new().with_resource_budget(128);
//! let tree = view.observe(&context, &ObserveRequest { path: "/".into(), depth: 1 })?;
//! assert_eq!(tree.object.name, "");
//! let object = view.observe_object_with_context(&context, "/")?;
//! assert!(object.interfaces.is_empty());
//! # Ok::<(), Box<dyn std::error::Error>>(())
//! ```
//!
//! The built-in HTTP listener is intentionally loopback-only. TLS termination, //! The built-in HTTP listener is intentionally loopback-only. TLS termination,
//! certificates, authentication, and externally visible schemes are independent //! certificates, authentication, and externally visible schemes are independent
//! deployment concerns rather than WIP transport profiles. //! deployment concerns rather than WIP transport profiles.
#![deny(missing_docs)] #![deny(missing_docs)]
mod defaults;
mod engine;
mod http_adapter;
mod interfaces; mod interfaces;
mod projection; mod projection;
mod server; mod server;
@@ -21,7 +55,17 @@ use std::net::{IpAddr, Ipv4Addr, SocketAddr};
use std::path::PathBuf; use std::path::PathBuf;
use std::time::Duration; use std::time::Duration;
pub use interfaces::{FileRead, FileWrite, SymlinkInspect}; pub use defaults::{DefaultComposition, DefaultInterfaces, DefaultObject, default_projection};
pub use engine::{
BackendEntry, Composition, DefaultPolicy, EntryKind, FilesystemBackend, Projection,
ProjectionPolicy, ProjectionView, ResolvedEntry,
};
pub use http_adapter::HttpAdapter;
pub use interfaces::{
FileRead, FileReadDefinition, FileWrite, FileWriteDefinition, SymlinkInspect,
SymlinkInspectDefinition,
};
pub use projection::{LinuxBackend, LinuxEntry};
pub use server::{BoundServer, ServerBuildError, WipFsServer}; pub use server::{BoundServer, ServerBuildError, WipFsServer};
/// Filesystem capabilities published by regular files. /// Filesystem capabilities published by regular files.
File diff suppressed because it is too large Load Diff
+12 -210
View File
@@ -5,26 +5,20 @@ use std::sync::atomic::{AtomicBool, Ordering};
use std::thread; use std::thread;
use std::time::{Duration, Instant}; use std::time::{Duration, Instant};
use http::header::ALLOW;
use http::{Request, Response, StatusCode}; use http::{Request, Response, StatusCode};
use wip_host::{ExecutionContext, ObjectProvider}; use wip_host::ExecutionContext;
use wip_http::{ use wip_http::Endpoint;
CodecError, EncodeHttpError, Endpoint, RequestMetadataError, Route,
decode_call_operation_metadata, decode_fetch_interface_request, decode_observe_request,
encode_call_operation_response, encode_fetch_interface_response, encode_observe_response,
encode_protocol_error_response, validate_http_request,
};
use wip_protocol::{ProtocolError, ProtocolErrorCode, ProtocolInteraction};
use crate::projection::Projection; use crate::engine::Projection;
use crate::{ConfigError, ServerConfig}; use crate::http_adapter::HttpAdapter;
use crate::{ConfigError, DefaultComposition, DefaultPolicy, LinuxBackend, ServerConfig};
/// Filesystem projection and framework-neutral standard WIP request adapter. /// Default Linux filesystem projection and bounded loopback HTTP listener.
pub struct WipFsServer { pub struct WipFsServer {
config: ServerConfig, config: ServerConfig,
endpoint: Endpoint, endpoint: Endpoint,
effective_root: std::path::PathBuf, effective_root: std::path::PathBuf,
projection: Arc<Projection>, projection: Arc<Projection<LinuxBackend, DefaultComposition, DefaultPolicy>>,
} }
impl WipFsServer { impl WipFsServer {
@@ -32,8 +26,8 @@ impl WipFsServer {
pub fn new(config: ServerConfig) -> Result<Self, ServerBuildError> { pub fn new(config: ServerConfig) -> Result<Self, ServerBuildError> {
config.validate()?; config.validate()?;
let endpoint = config.endpoint()?; let endpoint = config.endpoint()?;
let projection = Projection::open(&config.root, config.access, config.limits)?; let projection = crate::default_projection(&config.root, config.access, config.limits)?;
let effective_root = projection.effective_root()?; let effective_root = projection.backend().effective_root()?;
Ok(Self { Ok(Self {
config, config,
endpoint, endpoint,
@@ -67,25 +61,12 @@ impl WipFsServer {
request: Request<Vec<u8>>, request: Request<Vec<u8>>,
deadline: Instant, deadline: Instant,
) -> Response<Vec<u8>> { ) -> Response<Vec<u8>> {
let Some(route) = self.route(request.uri()) else {
return empty_response(StatusCode::NOT_FOUND);
};
if let Err(error) = validate_http_request(&self.endpoint, route, &request) {
return self.metadata_error(error);
}
let context = ExecutionContext::new() let context = ExecutionContext::new()
.with_deadline(deadline) .with_deadline(deadline)
.with_resource_budget(u64::from(self.config.limits.max_observation_nodes)); .with_resource_budget(u64::from(self.config.limits.max_observation_nodes));
let response = match route { let view = self.projection.view(&());
Route::Observe => self.observe(request.body(), &context), HttpAdapter::new(&view, &self.endpoint, self.config.limits)
Route::FetchInterface => self.fetch_interface(request.body()), .handle_http_with_context(request, &context)
Route::CallOperation => self.call_operation(request.body(), &context),
};
if Instant::now() >= deadline {
empty_response(StatusCode::GATEWAY_TIMEOUT)
} else {
response
}
} }
/// Binds the built-in bounded loopback HTTP listener. /// Binds the built-in bounded loopback HTTP listener.
@@ -108,171 +89,6 @@ impl WipFsServer {
listener: Arc::new(listener), listener: Arc::new(listener),
}) })
} }
fn route(&self, uri: &http::Uri) -> Option<Route> {
if uri.query().is_some() {
return None;
}
[Route::Observe, Route::FetchInterface, Route::CallOperation]
.into_iter()
.find(|route| self.endpoint.route(*route).path() == uri.path())
}
fn observe(&self, body: &[u8], context: &ExecutionContext) -> Response<Vec<u8>> {
let request = match decode_observe_request(body, self.config.limits.wire) {
Ok(request) => request,
Err(error) => return self.codec_error(ProtocolInteraction::Observe, error),
};
match self.projection.observe(context, &request) {
Ok(tree) => encode_observe_response(&request, &tree, self.config.limits.wire)
.unwrap_or_else(|error| {
self.read_encode_error(ProtocolInteraction::Observe, error)
}),
Err(error) => self.protocol_error(ProtocolInteraction::Observe, &error),
}
}
fn fetch_interface(&self, body: &[u8]) -> Response<Vec<u8>> {
let request = match decode_fetch_interface_request(body, self.config.limits.wire) {
Ok(request) => request,
Err(error) => return self.codec_error(ProtocolInteraction::FetchInterface, error),
};
match self.projection.fetch_interface(&request) {
Ok(interface) => {
encode_fetch_interface_response(&request, &interface, self.config.limits.wire)
.unwrap_or_else(|error| {
self.read_encode_error(ProtocolInteraction::FetchInterface, error)
})
}
Err(error) => self.protocol_error(ProtocolInteraction::FetchInterface, &error),
}
}
fn call_operation(&self, body: &[u8], context: &ExecutionContext) -> Response<Vec<u8>> {
let metadata = match decode_call_operation_metadata(body, self.config.limits.wire) {
Ok(metadata) => metadata,
Err(error) => return self.codec_error(ProtocolInteraction::CallOperation, error),
};
let may_commit = metadata.operation == "replace";
let decoded = std::sync::Mutex::new(None);
let execution = self.projection.call_operation_with_context_and_decoder(
context,
metadata.target.clone(),
metadata.interface.clone(),
metadata.operation.clone(),
|descriptor| {
let request = metadata.decode_request(body, descriptor, self.config.limits.wire)?;
let arguments = request.arguments.clone();
*decoded.lock().unwrap_or_else(|error| error.into_inner()) =
Some((request, descriptor.clone()));
Ok::<_, CodecError>(arguments)
},
);
match execution.map_err(|error| error.protocol_error()) {
Ok(result) => {
let Some((request, descriptor)) = decoded
.into_inner()
.unwrap_or_else(|error| error.into_inner())
else {
let error = ProtocolError {
code: if may_commit {
ProtocolErrorCode::OperationOutcomeUnknown
} else {
ProtocolErrorCode::Internal
},
message: "operation completed without response metadata".into(),
};
return self.protocol_error(ProtocolInteraction::CallOperation, &error);
};
encode_call_operation_response(
&request,
&descriptor,
&result,
self.config.limits.wire,
)
.unwrap_or_else(|encode_error| {
if matches!(
&encode_error,
EncodeHttpError::Codec(codec) if is_transport_limit(codec)
) {
return empty_response(StatusCode::INTERNAL_SERVER_ERROR);
}
if !may_commit {
return self
.read_encode_error(ProtocolInteraction::CallOperation, encode_error);
}
// Replacement may already be committed, so a response
// encoding failure cannot carry a non-commit guarantee.
let error = ProtocolError {
code: ProtocolErrorCode::OperationOutcomeUnknown,
message: "operation completed but its response could not be encoded".into(),
};
self.protocol_error(ProtocolInteraction::CallOperation, &error)
})
}
Err(error) => self.protocol_error(ProtocolInteraction::CallOperation, &error),
}
}
fn metadata_error(&self, error: RequestMetadataError) -> Response<Vec<u8>> {
match error {
RequestMetadataError::NotFound => empty_response(StatusCode::NOT_FOUND),
error @ RequestMetadataError::MethodNotAllowed => Response::builder()
.status(error.status())
.header(
ALLOW,
error
.allow()
.expect("method-not-allowed metadata has an Allow value"),
)
.body(Vec::new())
.expect("static method response is valid"),
RequestMetadataError::UnsupportedMediaType => {
empty_response(StatusCode::UNSUPPORTED_MEDIA_TYPE)
}
RequestMetadataError::NotAcceptable => empty_response(StatusCode::NOT_ACCEPTABLE),
}
}
fn codec_error(
&self,
interaction: ProtocolInteraction,
error: CodecError,
) -> Response<Vec<u8>> {
if is_transport_limit(&error) {
empty_response(StatusCode::PAYLOAD_TOO_LARGE)
} else {
self.protocol_error(
interaction,
&ProtocolError {
code: ProtocolErrorCode::InvalidRequest,
message: "malformed WIP request".into(),
},
)
}
}
fn read_encode_error(
&self,
interaction: ProtocolInteraction,
error: EncodeHttpError,
) -> Response<Vec<u8>> {
match error {
EncodeHttpError::Codec(codec) if is_transport_limit(&codec) => {
empty_response(StatusCode::INTERNAL_SERVER_ERROR)
}
_ => self.protocol_error(interaction, &internal_error()),
}
}
fn protocol_error(
&self,
interaction: ProtocolInteraction,
error: &ProtocolError,
) -> Response<Vec<u8>> {
encode_protocol_error_response(interaction, error, self.config.limits.wire)
.unwrap_or_else(|_| empty_response(StatusCode::INTERNAL_SERVER_ERROR))
}
} }
/// Bound real HTTP listener for a [`WipFsServer`]. /// Bound real HTTP listener for a [`WipFsServer`].
@@ -560,20 +376,6 @@ fn write_all_with_deadline(
stream.flush() stream.flush()
} }
fn is_transport_limit(error: &CodecError) -> bool {
matches!(
error,
CodecError::BodyTooLarge { .. } | CodecError::NestingTooDeep { .. }
)
}
fn internal_error() -> ProtocolError {
ProtocolError {
code: ProtocolErrorCode::Internal,
message: "filesystem server failed".into(),
}
}
fn empty_response(status: StatusCode) -> Response<Vec<u8>> { fn empty_response(status: StatusCode) -> Response<Vec<u8>> {
Response::builder() Response::builder()
.status(status) .status(status)
File diff suppressed because it is too large Load Diff
+185
View File
@@ -211,6 +211,17 @@ pub struct InterfaceObservation {
} }
impl InterfaceObservation { impl InterfaceObservation {
/// Restricts this effective view to visible operations and reachable types.
///
/// Registry artifacts are unchanged. When operations are removed, interface-
/// wide documentation is omitted because it may describe hidden operations.
/// Providers must use the same predicate for publication and fetch.
#[must_use]
pub fn project_operations(mut self, visible: impl Fn(&str) -> bool) -> Self {
restrict_descriptor(&mut self.descriptor, visible);
self
}
/// Converts this host observation to a validated canonical protocol response. /// Converts this host observation to a validated canonical protocol response.
/// ///
/// A Host-side response construction failure is returned as `Internal`; it is /// A Host-side response construction failure is returned as `Internal`; it is
@@ -449,6 +460,60 @@ pub trait WipObject {
} }
} }
fn restrict_descriptor(descriptor: &mut InterfaceDescriptor, visible: impl Fn(&str) -> bool) {
let count = descriptor.operations.len();
descriptor
.operations
.retain(|operation| visible(&operation.name));
if descriptor.operations.len() == count {
return;
}
descriptor.documentation = None;
let mut used = HashSet::new();
fn references(expression: &wip_protocol::TypeExpr, used: &mut HashSet<String>) {
use wip_protocol::TypeExpr;
match expression {
TypeExpr::Named { name } => {
used.insert(name.clone());
}
TypeExpr::Record { fields } => {
for field in fields {
references(&field.r#type, used);
}
}
TypeExpr::List { items } => references(items, used),
TypeExpr::Union { cases } => {
for case in cases {
if let Some(payload) = &case.payload {
references(payload, used);
}
}
}
_ => {}
}
}
for operation in &descriptor.operations {
for parameter in &operation.parameters {
references(&parameter.r#type, &mut used);
}
references(&operation.returns.r#type, &mut used);
}
loop {
let before = used.len();
for declaration in &descriptor.types {
if used.contains(&declaration.name) {
references(&declaration.definition, &mut used);
}
}
if before == used.len() {
break;
}
}
descriptor
.types
.retain(|declaration| used.contains(&declaration.name));
}
type DispatchFn<T> = fn(&T, &str, BTreeMap<String, Value>) -> Result<Value, DispatchError>; type DispatchFn<T> = fn(&T, &str, BTreeMap<String, Value>) -> Result<Value, DispatchError>;
struct BoundInterface<T> { struct BoundInterface<T> {
@@ -502,6 +567,46 @@ impl<T: WipObject> PublishedObject<T> {
Ok(self) Ok(self)
} }
/// Restricts a publication to an ordered interface/operation view.
///
/// This never adds implementations or changes codecs. The provider must use
/// the identical operation predicate for `fetch_interface`, and keep the
/// effective view stable for the lifetime of its references. Filtered
/// descriptors are scoped to that view, not mutations of registry artifacts.
pub fn project(
mut self,
interfaces: &[InterfaceRef],
visible: impl Fn(&InterfaceRef, &str) -> bool,
) -> Result<Self, PublicationError> {
let mut projected = Vec::with_capacity(interfaces.len());
for reference in interfaces {
if projected
.iter()
.any(|bound: &BoundInterface<T>| &bound.artifact.reference == reference)
{
return Err(PublicationError::DuplicateInterface(reference.clone()));
}
let Some(index) = self
.interfaces
.iter()
.position(|bound| &bound.artifact.reference == reference)
else {
return Err(PublicationError::UnexposedInterface(reference.clone()));
};
let mut bound = self.interfaces.remove(index);
let mut descriptor = bound.artifact.descriptor.clone();
restrict_descriptor(&mut descriptor, |operation| visible(reference, operation));
bound.artifact = Arc::new(InterfaceArtifact {
reference: reference.clone(),
descriptor,
validator: bound.artifact.validator.clone(),
});
projected.push(bound);
}
self.interfaces = projected;
Ok(self)
}
/// Returns the host-private implementation without projecting its fields. /// Returns the host-private implementation without projecting its fields.
#[must_use] #[must_use]
pub fn implementation(&self) -> &T { pub fn implementation(&self) -> &T {
@@ -782,6 +887,15 @@ pub enum OperationAttempt {
} }
impl OperationAttempt { impl OperationAttempt {
/// Rejects a provider precondition before typed implementation invocation.
///
/// Only use this before dispatch starts; post-invocation failures require
/// an explicit effect disposition. The diagnostic is intentionally generic.
#[must_use]
pub fn reject(kind: CallErrorKind) -> Self {
Self::NotStarted(CallError::new(kind, "provider precondition failed"))
}
/// Marks a post-invocation failure as fully rolled back. /// Marks a post-invocation failure as fully rolled back.
/// ///
/// Successful attempts and pre-dispatch failures are returned unchanged. /// Successful attempts and pre-dispatch failures are returned unchanged.
@@ -1016,11 +1130,18 @@ pub trait ObjectProvider {
pub enum PublicationError { pub enum PublicationError {
/// The same opaque interface reference was exposed more than once. /// The same opaque interface reference was exposed more than once.
DuplicateInterface(InterfaceRef), DuplicateInterface(InterfaceRef),
/// Projection attempted to add an interface without an implementation.
UnexposedInterface(InterfaceRef),
} }
impl Display for PublicationError { impl Display for PublicationError {
fn fmt(&self, formatter: &mut Formatter<'_>) -> fmt::Result { fn fmt(&self, formatter: &mut Formatter<'_>) -> fmt::Result {
match self { match self {
Self::UnexposedInterface(reference) => write!(
formatter,
"interface `{}` has no implementation",
reference.as_str()
),
Self::DuplicateInterface(reference) => write!( Self::DuplicateInterface(reference) => write!(
formatter, formatter,
"interface `{}` is already exposed by this object", "interface `{}` is already exposed by this object",
@@ -1032,6 +1153,70 @@ impl Display for PublicationError {
impl Error for PublicationError {} impl Error for PublicationError {}
#[cfg(test)]
mod projection_tests {
use super::*;
use wip_protocol::{
Documentation, OperationDeclaration, ReturnDeclaration, TypeDeclaration, TypeExpr,
};
#[test]
fn operation_views_prune_hidden_types_and_documentation_without_mutating_registry() {
let named = |name: &str| TypeExpr::Named { name: name.into() };
let operation = |name: &str, returns| OperationDeclaration {
name: name.into(),
documentation: None,
parameters: Vec::new(),
returns: ReturnDeclaration {
documentation: None,
r#type: returns,
},
};
let declaration = |name: &str, definition| TypeDeclaration {
name: name.into(),
documentation: None,
definition,
};
let descriptor = InterfaceDescriptor {
format: "wip/1".into(),
documentation: Some(Documentation {
summary: "contains hidden operation details".into(),
details: None,
}),
operations: vec![
operation("visible", named("Public")),
operation("secret", named("Secret")),
],
types: vec![
declaration(
"Public",
TypeExpr::List {
items: Box::new(named("Shared")),
},
),
declaration("Shared", TypeExpr::String),
declaration("Secret", TypeExpr::Bytes),
],
};
let mut projected = descriptor.clone();
restrict_descriptor(&mut projected, |operation| operation == "visible");
assert_eq!(projected.operations.len(), 1);
assert!(projected.documentation.is_none());
assert_eq!(
projected
.types
.iter()
.map(|declaration| declaration.name.as_str())
.collect::<Vec<_>>(),
vec!["Public", "Shared"]
);
assert_eq!(descriptor.types.len(), 3);
restrict_descriptor(&mut projected, |_| false);
assert!(projected.types.is_empty());
assert!(projected.operations.is_empty());
}
}
/// Stable Host dispatch failure kind. /// Stable Host dispatch failure kind.
#[derive(Debug, Clone, Copy, PartialEq, Eq)] #[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum CallErrorKind { pub enum CallErrorKind {
+56
View File
@@ -14,6 +14,62 @@ use wip_interface::{
}; };
use wip_protocol::ProtocolErrorCode; use wip_protocol::ProtocolErrorCode;
#[test]
fn principal_projection_orders_subsets_and_rejects_unimplemented_or_duplicate_tokens() {
let mut registry = InterfaceRegistry::new();
let read = registry.register(ReaderDefinition, None).unwrap();
let write = registry.register(WriterDefinition, None).unwrap();
let hidden = registry.register(HiddenDefinition, None).unwrap();
let publication = || {
PublishedObject::new(Document::open("document", None, Rc::new(Cell::new(0))))
.expose(&read)
.unwrap()
.expose(&write)
.unwrap()
};
let projected = publication()
.project(
&[write.reference().clone(), read.reference().clone()],
|_, operation| operation == "label",
)
.unwrap();
assert_eq!(
projected.protocol_object().interfaces,
vec![write.reference().as_str(), read.reference().as_str()]
);
assert!(
publication()
.project(&[hidden.reference().clone()], |_, _| true)
.is_err()
);
assert!(
publication()
.project(
&[read.reference().clone(), read.reference().clone()],
|_, _| true
)
.is_err()
);
assert!(
publication()
.project(&[], |_, _| true)
.unwrap()
.protocol_object()
.interfaces
.is_empty()
);
let full = registry.fetch_interface(read.reference().as_str()).unwrap();
let filtered = full
.clone()
.project_operations(|operation| operation == "label");
assert_eq!(filtered.descriptor.operations.len(), 1);
assert_eq!(full.descriptor.operations.len(), 3);
assert_eq!(
registry.fetch_interface(read.reference().as_str()).unwrap(),
full
);
}
#[interface] #[interface]
pub trait Reader { pub trait Reader {
/// Returns the reader-qualified label. /// Returns the reader-qualified label.