Skip to main content

Crate nfs_v3

Crate nfs_v3 

Source
Expand description

NFS version 3 – RFC 1813, with the MOUNT v3 protocol it depends on.

A complete NFSv3 client: all 22 procedures, all wire types, and the MOUNT sideband service that turns an export path into the root file handle everything else starts from.

§Layers

ModuleWhat it is
wireXDR types transcribed verbatim from the RFC
Nfs3ClientOne method per procedure, wire types in and out
apiDomain types – file handles, attributes, access bits
Nfs3ErrorProtocol status codes, classified

Pick a layer by what you are doing. Reading a file wants api. Sending a deliberately malformed request to see how a server reacts wants wire and the raw client, which will encode whatever you hand it.

§Protocol properties worth knowing

Two are load-bearing for anything security-related:

  • File handles are bearer tokens. A handle obtained under one credential keeps working under any other (RFC 1813 sec. 2.6). The server does not re-check how you got it. Handles can therefore be reused across identity switches instead of re-resolving paths, and a handle guessed or constructed rather than looked up is just as valid.
  • ACCESS is advisory. The server answers what it believes the caller may do and is not required to be right (RFC 1813 sec. 3.3.4). It may permit an operation here and refuse it for real, or the reverse. Confirm by attempting the operation.

Re-exports§

pub use api::CreateMode;
pub use api::DirEntry;
pub use api::DirEntryPlus;
pub use api::DirPage;
pub use api::FileAttrs;
pub use api::FileHandle;
pub use api::FileType;
pub use api::FsInfo;
pub use api::FsStat;
pub use api::HexError;
pub use api::Nfs3Fault;
pub use api::NfsTime;
pub use api::ReadChunk;
pub use api::WriteAck;
pub use api::WriteStable;
pub use api::access;
pub use wire::PROGRAM;
pub use wire::VERSION;

Modules§

api
Domain types – ergonomic wrappers over the raw NFSv3 wire format.
wire
NFSv3 and MOUNT v3 wire types – verbatim transcriptions of RFC 1813.

Structs§

Nfs3Client
Client for the NFSv3 service (program 100003, version 3).

Enums§

MountError
Re-export the MOUNT error from nfswolf-mount for backward compatibility. Error from a MOUNT operation.
Nfs3Error
An NFSv3 protocol status other than NFS3_OK.

Type Aliases§

MountClient
Re-export the MOUNT client from nfswolf-mount for backward compatibility.