Struct libunftp::Server [−][src]
pub struct Server<Storage, User> where
Storage: StorageBackend<User>,
User: UserDetail, { /* fields omitted */ }
Expand description
An instance of an FTP(S) server. It aggregates an Authenticator
implementation that will be used for authentication, and a StorageBackend
implementation that will be used as the virtual file system.
The server can be started with the listen
method.
Example
use libunftp::Server; use unftp_sbe_fs::ServerExt; use tokio::runtime::Runtime; let mut rt = Runtime::new().unwrap(); let server = Server::with_fs("/srv/ftp"); rt.spawn(server.listen("127.0.0.1:2121")); // ... drop(rt);
Implementations
impl<Storage, User> Server<Storage, User> where
Storage: StorageBackend<User> + 'static,
Storage::Metadata: Metadata,
User: UserDetail + 'static,
impl<Storage, User> Server<Storage, User> where
Storage: StorageBackend<User> + 'static,
Storage::Metadata: Metadata,
User: UserDetail + 'static,
pub fn new(sbe_generator: Box<dyn Fn() -> Storage + Send + Sync>) -> Self where
AnonymousAuthenticator: Authenticator<User>,
pub fn new(sbe_generator: Box<dyn Fn() -> Storage + Send + Sync>) -> Self where
AnonymousAuthenticator: Authenticator<User>,
Construct a new Server
with the given StorageBackend
generator and an AnonymousAuthenticator
pub fn with_authenticator(
s: Box<dyn Fn() -> Storage + Send + Sync>,
authenticator: Arc<dyn Authenticator<User> + Send + Sync>
) -> Self
pub fn with_authenticator(
s: Box<dyn Fn() -> Storage + Send + Sync>,
authenticator: Arc<dyn Authenticator<User> + Send + Sync>
) -> Self
Construct a new Server
with the given StorageBackend
and Authenticator
. The other parameters will be set to defaults.
Set the Authenticator
that will be used for authentication.
Example
use libunftp::{auth, auth::AnonymousAuthenticator, Server}; use unftp_sbe_fs::ServerExt; use std::sync::Arc; // Use it in a builder-like pattern: let mut server = Server::with_fs("/tmp") .authenticator(Arc::new(auth::AnonymousAuthenticator{}));
Enables FTPS by configuring the path to the certificates file and the private key file. Both should be in PEM format.
Example
use libunftp::Server; use unftp_sbe_fs::ServerExt; let server = Server::with_fs("/tmp") .ftps("/srv/unftp/server.certs", "/srv/unftp/server.key");
Allows switching on Mutual TLS. For this to work the trust anchors also needs to be set using the ftps_trust_store method.
Example
use libunftp::Server; use unftp_sbe_fs::ServerExt; use libunftp::options::FtpsClientAuth; let server = Server::with_fs("/tmp") .ftps("/srv/unftp/server.certs", "/srv/unftp/server.key") .ftps_client_auth(FtpsClientAuth::Require) .ftps_trust_store("/srv/unftp/trusted.pem");
pub fn ftps_required<R>(self, for_control_chan: R, for_data_chan: R) -> Self where
R: Into<FtpsRequired>,
pub fn ftps_required<R>(self, for_control_chan: R, for_data_chan: R) -> Self where
R: Into<FtpsRequired>,
Configures whether client connections may use plaintext mode or not.
Sets the certificates to use when verifying client certificates in Mutual TLS mode. This should point to certificates in a PEM formatted file. For this to have any effect MTLS needs to be switched on via the ftps_client_auth method.
Example
use libunftp::Server; use unftp_sbe_fs::ServerExt; let server = Server::with_fs("/tmp") .ftps("/srv/unftp/server.certs", "/srv/unftp/server.key") .ftps_client_auth(true) .ftps_trust_store("/srv/unftp/trusted.pem");
Switches TLS features on or off.
Example
This example enables only TLS v1.3 and allows TLS session resumption with tickets.
use libunftp::Server; use unftp_sbe_fs::ServerExt; use libunftp::options::TlsFlags; let mut server = Server::with_fs("/tmp") .greeting("Welcome to my FTP Server") .ftps("/srv/unftp/server.certs", "/srv/unftp/server.key") .ftps_tls_flags(TlsFlags::V1_3 | TlsFlags::RESUMPTION_TICKETS);
Set the greeting that will be sent to the client after connecting.
Example
use libunftp::Server; use unftp_sbe_fs::ServerExt; // Use it in a builder-like pattern: let mut server = Server::with_fs("/tmp").greeting("Welcome to my FTP Server"); // Or instead if you prefer: let mut server = Server::with_fs("/tmp"); server.greeting("Welcome to my FTP Server");
Set the idle session timeout in seconds. The default is 600 seconds.
Example
use libunftp::Server; use unftp_sbe_fs::ServerExt; // Use it in a builder-like pattern: let mut server = Server::with_fs("/tmp").idle_session_timeout(600); // Or instead if you prefer: let mut server = Server::with_fs("/tmp"); server.idle_session_timeout(600);
Sets the structured logger (slog::Logger) to use
Enables the collection of prometheus metrics.
Example
use libunftp::Server; use unftp_sbe_fs::ServerExt; // Use it in a builder-like pattern: let mut server = Server::with_fs("/tmp").metrics(); // Or instead if you prefer: let mut server = Server::with_fs("/tmp"); server.metrics();
Specifies how the IP address that libunftp will advertise in response to the PASV command is determined.
Examples
Using a fixed IP specified as a numeric array:
use libunftp::Server; use unftp_sbe_fs::ServerExt; let server = Server::with_fs("/tmp") .passive_host([127,0,0,1]);
Or the same but more explicitly:
use libunftp::{Server,options}; use unftp_sbe_fs::ServerExt; use std::net::Ipv4Addr; let server = Server::with_fs("/tmp") .passive_host(options::PassiveHost::Ip(Ipv4Addr::new(127, 0, 0, 1)));
To determine the passive IP from the incoming control connection:
use libunftp::{Server,options}; use unftp_sbe_fs::ServerExt; let server = Server::with_fs("/tmp") .passive_host(options::PassiveHost::FromConnection);
Get the IP by resolving a DNS name:
use libunftp::{Server,options}; use unftp_sbe_fs::ServerExt; let server = Server::with_fs("/tmp") .passive_host("ftp.myserver.org");
Sets the range of passive ports that we’ll use for passive connections.
Example
use libunftp::Server; use unftp_sbe_fs::ServerExt; // Use it in a builder-like pattern: let server = Server::with_fs("/tmp") .passive_ports(49152..65535); // Or instead if you prefer: let mut server = Server::with_fs("/tmp"); server.passive_ports(49152..65535);
Enables PROXY protocol mode.
If you use a proxy such as haproxy or nginx, you can enable the PROXY protocol (https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
Configure your proxy to enable PROXY protocol encoding for control and data external listening ports, forwarding these connections to the libunFTP listening port in proxy protocol mode.
In PROXY protocol mode, libunftp receives both control and
data connections on the listening port. It then distinguishes
control and data connections by comparing the original
destination port (extracted from the PROXY header) with the
port specified as the external_control_port
parameter.
Example
use libunftp::Server; use unftp_sbe_fs::ServerExt; // Use it in a builder-like pattern: let mut server = Server::with_fs("/tmp").proxy_protocol_mode(2121);
Runs the main ftp process asynchronously. Should be started in a async runtime context.
Example
use libunftp::Server; use unftp_sbe_fs::ServerExt; use tokio::runtime::Runtime; let mut rt = Runtime::new().unwrap(); let server = Server::with_fs("/srv/ftp"); rt.spawn(server.listen("127.0.0.1:2121")); // ... drop(rt);
Panics
This function panics when called with invalid addresses or when the process is unable to
bind()
to the address.
Enables SITE MD5
Warning: Depending on the storage backend, SITE MD5 may use relatively much memory and generate high CPU usage. This opens a Denial of Service vulnerability that could be exploited by malicious users, by means of flooding the server with SITE MD5 commands. As such this feature is probably best user configured and at least disabled for anonymous users by default.
Example
use libunftp::Server; use libunftp::options::SiteMd5; use unftp_sbe_fs::ServerExt; // Use it in a builder-like pattern: let mut server = Server::with_fs("/tmp").sitemd5(SiteMd5::None);
Trait Implementations
impl<Storage, User> Debug for Server<Storage, User> where
Storage: StorageBackend<User>,
User: UserDetail,
impl<Storage, User> Debug for Server<Storage, User> where
Storage: StorageBackend<User>,
User: UserDetail,
Auto Trait Implementations
impl<Storage, User> !RefUnwindSafe for Server<Storage, User>
impl<Storage, User> !UnwindSafe for Server<Storage, User>
Blanket Implementations
Mutably borrows from an owned value. Read more
fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,
Causes self
to use its Binary
implementation when Debug
-formatted.
fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,
Causes self
to use its Display
implementation when
Debug
-formatted. Read more
fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,
Causes self
to use its LowerExp
implementation when
Debug
-formatted. Read more
fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,
Causes self
to use its LowerHex
implementation when
Debug
-formatted. Read more
Causes self
to use its Octal
implementation when Debug
-formatted.
fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,
Causes self
to use its Pointer
implementation when
Debug
-formatted. Read more
fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,
Causes self
to use its UpperExp
implementation when
Debug
-formatted. Read more
fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,
Causes self
to use its UpperHex
implementation when
Debug
-formatted. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
impl<T> Pipe for T where
T: ?Sized,
impl<T> Pipe for T where
T: ?Sized,
Pipes by value. This is generally the method you want to use. Read more
Borrows self
and passes that borrow into the pipe function. Read more
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,
Mutably borrows self
and passes that borrow into the pipe function. Read more
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
Self: Borrow<B>,
R: 'a,
B: 'a + ?Sized,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
Self: Borrow<B>,
R: 'a,
B: 'a + ?Sized,
Borrows self
, then passes self.borrow()
into the pipe function. Read more
fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
R: 'a,
B: 'a + ?Sized,
fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
R: 'a,
B: 'a + ?Sized,
Mutably borrows self
, then passes self.borrow_mut()
into the pipe
function. Read more
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
Borrows self
, then passes self.as_ref()
into the pipe function.
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
Mutably borrows self
, then passes self.as_mut()
into the pipe
function. Read more
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Deref<Target = T>,
R: 'a,
T: 'a + ?Sized,
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Deref<Target = T>,
R: 'a,
T: 'a + ?Sized,
Borrows self
, then passes self.deref()
into the pipe function.
fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
R: 'a,
T: 'a,
fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
R: 'a,
T: 'a,
Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more
fn pipe_as_mut<'a, T, R>(&'a mut self, func: impl FnOnce(&'a mut T) -> R) -> R where
Self: AsMut<T>,
R: 'a,
T: 'a,
fn pipe_as_mut<'a, T, R>(&'a mut self, func: impl FnOnce(&'a mut T) -> R) -> R where
Self: AsMut<T>,
R: 'a,
T: 'a,
Pipes a trait mutable borrow into a function that cannot normally be called in suffix position. Read more
fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
R: 'a,
T: 'a,
fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
R: 'a,
T: 'a,
Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more
fn pipe_borrow_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: BorrowMut<T>,
R: 'a,
T: 'a,
fn pipe_borrow_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: BorrowMut<T>,
R: 'a,
T: 'a,
Pipes a trait mutable borrow into a function that cannot normally be called in suffix position. Read more
fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,
fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,
Pipes a dereference into a function that cannot normally be called in suffix position. Read more
fn pipe_deref_mut<'a, R>(
&'a mut self,
func: impl FnOnce(&'a mut Self::Target) -> R
) -> R where
Self: DerefMut,
R: 'a,
fn pipe_deref_mut<'a, R>(
&'a mut self,
func: impl FnOnce(&'a mut Self::Target) -> R
) -> R where
Self: DerefMut,
R: 'a,
Pipes a mutable dereference into a function that cannot normally be called in suffix position. Read more
Pipes a reference into a function that cannot ordinarily be called in suffix position. Read more
type Output = T
type Output = T
Should always be Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
Immutable access to the Borrow<B>
of a value. Read more
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
Mutable access to the BorrowMut<B>
of a value. Read more
Immutable access to the AsRef<R>
view of a value. Read more
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
Mutable access to the AsMut<R>
view of a value. Read more
Immutable access to the Deref::Target
of a value. Read more
Mutable access to the Deref::Target
of a value. Read more
Calls .tap()
only in debug builds, and is erased in release builds.
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut()
only in debug builds, and is erased in release
builds. Read more
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
Calls .tap_borrow()
only in debug builds, and is erased in release
builds. Read more
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
Calls .tap_borrow_mut()
only in debug builds, and is erased in release
builds. Read more
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
Calls .tap_ref()
only in debug builds, and is erased in release
builds. Read more
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
Calls .tap_ref_mut()
only in debug builds, and is erased in release
builds. Read more
Provides immutable access for inspection. Read more
Calls tap
in debug builds, and does nothing in release builds.
Provides mutable access for modification. Read more
fn tap_mut_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&mut Self) -> R,
fn tap_mut_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&mut Self) -> R,
Calls tap_mut
in debug builds, and does nothing in release builds.
impl<T, U> TapAsRef<U> for T where
U: ?Sized,
impl<T, U> TapAsRef<U> for T where
U: ?Sized,
Provides immutable access to the reference for inspection.
fn tap_ref_dbg<F, R>(self, func: F) -> Self where
Self: AsRef<T>,
F: FnOnce(&T) -> R,
fn tap_ref_dbg<F, R>(self, func: F) -> Self where
Self: AsRef<T>,
F: FnOnce(&T) -> R,
Calls tap_ref
in debug builds, and does nothing in release builds.
fn tap_ref_mut<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,
fn tap_ref_mut<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,
Provides mutable access to the reference for modification.
fn tap_ref_mut_dbg<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,
fn tap_ref_mut_dbg<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,
Calls tap_ref_mut
in debug builds, and does nothing in release builds.
impl<T, U> TapBorrow<U> for T where
U: ?Sized,
impl<T, U> TapBorrow<U> for T where
U: ?Sized,
fn tap_borrow<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R,
fn tap_borrow<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R,
Provides immutable access to the borrow for inspection. Read more
fn tap_borrow_dbg<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R,
fn tap_borrow_dbg<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R,
Calls tap_borrow
in debug builds, and does nothing in release builds.
fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
Provides mutable access to the borrow for modification.
fn tap_borrow_mut_dbg<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
fn tap_borrow_mut_dbg<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
Calls tap_borrow_mut
in debug builds, and does nothing in release
builds. Read more
Immutably dereferences self
for inspection.
fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,
fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,
Calls tap_deref
in debug builds, and does nothing in release builds.
fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
Mutably dereferences self
for modification.
fn tap_deref_mut_dbg<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
fn tap_deref_mut_dbg<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
Calls tap_deref_mut
in debug builds, and does nothing in release
builds. Read more