mkj · jubeormk1 · Mar 3, 2026 · Mar 4, 2026 · Mar 4, 2026 · Mar 4, 2026
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -12,8 +12,10 @@ rust-version = "1.87"
 [workspace]
 members = [
     "demo/picow",
-    "demo/std", "fuzz",
+    "demo/std",
+    "fuzz",
     "stdasync",
+    "sftp",
     # workspace.dependencies paths are automatic
 ]
 
@@ -39,7 +41,9 @@ ascii = { version = "1.0", default-features = false }
 arbitrary = { workspace = true, optional = true }
 
 getrandom = "0.2"
-rand_core = { version = "0.6", default-features = false, features = ["getrandom"]}
+rand_core = { version = "0.6", default-features = false, features = [
+    "getrandom",
+] }
 
 ctr = { version = "0.9", features = ["zeroize"] }
 aes = { version = "0.8", features = ["zeroize"] }
@@ -53,14 +57,27 @@ zeroize = { version = "1", default-features = false, features = ["derive"] }
 cipher = { version = "0.4", features = ["zeroize"] }
 subtle = { version = "2.4", default-features = false }
 # ed25519/x25519
-ed25519-dalek = { version = "2.1", default-features = false, features = ["zeroize", "rand_core"] }
-x25519-dalek = { version = "2.0", default-features = false, features = ["zeroize"] }
-curve25519-dalek = { version = "4.1", default-features = false, features = ["zeroize"] }
-ml-kem = { version = "0.2.1", default-features = false, features = ["zeroize"], optional = true }
+ed25519-dalek = { version = "2.1", default-features = false, features = [
+    "zeroize",
+    "rand_core",
+] }
+x25519-dalek = { version = "2.0", default-features = false, features = [
+    "zeroize",
+] }
+curve25519-dalek = { version = "4.1", default-features = false, features = [
+    "zeroize",
+] }
+ml-kem = { version = "0.2.1", default-features = false, features = [
+    "zeroize",
+], optional = true }
 # p521 = { version = "0.13.2", default-features = false, features = ["ecdh", "ecdsa"] }
-rsa = { version = "0.9", default-features = false, optional = true, features = ["sha2"] }
+rsa = { version = "0.9", default-features = false, optional = true, features = [
+    "sha2",
+] }
 # TODO: getrandom feature is a workaround for missing ssh-key dependency with rsa. fixed in pending 0.6
-ssh-key = { version = "0.6", default-features = false, optional = true, features = ["getrandom"] }
+ssh-key = { version = "0.6", default-features = false, optional = true, features = [
+    "getrandom",
+] }
 
 embedded-io = { version = "0.6", optional = true }
 

diff --git a/sftp/Cargo.toml b/sftp/Cargo.toml
@@ -0,0 +1,26 @@
+[package]
+name = "sunset-sftp"
+version = "0.1.2"
+edition = "2024"
+
+[features]
+default = []
+# long paths support, which allows paths up to 4096 bytes, by default paths are limited to 256 bytes
+long-paths-4096 = []
+long-paths-1024 = []
+
+# Standard library support - enables std helpers
+std = []
+
+[dependencies]
+sunset = { path = "../" }
+sunset-async = { path = "../async" }
+sunset-sshwire-derive = { path = "../sshwire-derive" }
+
+
+embedded-io-async = "0.6"
+num_enum = { version = "0.7.4", default-features = false }
+paste = "1.0"
+log = "0.4"
+embassy-sync = "0.7.2"
+embassy-futures = "0.1.2"
diff --git a/sftp/src/lib.rs b/sftp/src/lib.rs
@@ -0,0 +1,128 @@
+//! SFTP (SSH File Transfer Protocol) implementation for [`sunset`].
+//!
+//! (Partially) Implements SFTP v3 as defined in [draft-ietf-secsh-filexfer-02](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-02).
+//!
+//! **Work in Progress**: Currently focuses on file upload operations.
+//! Long packets for requests other than writing and additional SFTP operations
+//! are not yet implemented. `no_std` compatibility is intended but not
+//! yet complete. Please see the roadmap and use this crate carefully.
+//!
+//! This crate implements a handler that, given a [`sunset::ChanHandle`]
+//! a `sunset_async::SSHServer` and some auxiliary buffers,
+//! can dispatch SFTP packets to a struct implementing [`crate::sftpserver::SftpServer`] trait.
+//!
+//! See example usage in the `../demo/sftd/std` directory for the intended usage
+//! of this library.
+//!
+//! # Roadmap
+//!
+//! The following list is an opinionated collection of the points that should be
+//! completed to provide growing functionality.
+//!
+//! ## Basic features
+//!
+//!  - [ ] [SFTP Protocol Initialization](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-02#section-4) (Only SFTP V3 supported)
+//! - [ ] [Canonicalizing the Server-Side Path Name](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-02#section-6.11) support
+//! - [ ] [Open, close](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-02#section-6.3)
+//! and [write](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-02#section-6.4)
+//! - [ ] Directory [Browsing](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-02#section-6.7)
+//! - [ ] File [read](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-02#section-6.4),
+//! - [ ] File [stats](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-02#section-6.8)
+//!
+//! ## Minimal features for convenient usability
+//!
+//! - [ ] [Removing files](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-02#section-6.5)
+//! - [ ] [Renaming files](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-02#section-6.5)
+//! - [ ] [Creating directories](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-02#section-6.6)
+//! - [ ] [Removing directories](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-02#section-6.6)
+//!
+//! ## Extended features
+//!
+//! - [ ] [Append, create and truncate files](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-02#section-6.3)
+//! files
+//! - [ ] [Reading](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-02#section-6.8)
+//! files attributes
+//! - [ ] [Setting](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-02#section-6.9) files attributes
+//! - [ ] [Dealing with Symbolic links](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-02#section-6.10)
+//! - [ ] [Vendor Specific](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-02#section-8)
+//!  request and responses
+
+#![forbid(unsafe_code)]
+#![warn(missing_docs)]
+#![cfg_attr(not(feature = "std"), no_std)]
+
+// mod opaquefilehandle;
+mod proto;
+// mod sftperror;
+// mod sftphandler;
+// mod sftpserver;
+// mod sftpsink;
+mod sftpsource;
+
+// Main calling point for the library provided that the user implements
+// a [`server::SftpServer`].
+//
+// Please see basic usage at `../demo/sftd/std`
+// pub use sftphandler::SftpHandler;
+
+/// Source of SFTP packets
+///
+/// Used to decode SFTP packets from a byte slice
+pub use sftpsource::SftpSource;
+
+// /// Structures and types used to add the details for the target system
+// /// Related to the implementation of the [`server::SftpServer`], which
+// /// is meant to be instantiated by the user and passed to [`SftpHandler`]
+// /// and has the task of executing client requests in the underlying system
+// pub mod server {
+
+//     pub use crate::sftpserver::DirReply;
+//     pub use crate::sftpserver::ReadReply;
+//     pub use crate::sftpserver::ReadStatus;
+//     pub use crate::sftpserver::SftpOpResult;
+//     pub use crate::sftpserver::SftpServer;
+//     /// Helpers to reduce error prone tasks and hide some details that
+//     /// add complexity when implementing an [`SftpServer`]
+//     pub mod helpers {
+//         pub use crate::sftpserver::helpers::*;
+
+//         #[cfg(feature = "std")]
+//         pub use crate::sftpserver::DirEntriesCollection;
+//         #[cfg(feature = "std")]
+//         pub use crate::sftpserver::get_file_attrs;
+//     }
+//     pub use crate::sftpsink::SftpSink;
+//     pub use sunset::sshwire::SSHEncode;
+
+//     pub use crate::proto::MAX_REQUEST_LEN;
+// }
+
+/// Handles and helpers used by the [`sftpserver::SftpServer`] trait implementer
+// pub mod handles {
+//     pub use crate::opaquefilehandle::OpaqueFileHandle;
+//     pub use crate::opaquefilehandle::OpaqueFileHandleManager;
+//     pub use crate::opaquefilehandle::PathFinder;
+// }
+
+/// SFTP Protocol types and structures
+pub mod protocol {
+    pub use crate::proto::Attrs;
+    pub use crate::proto::FileHandle;
+    pub use crate::proto::Filename;
+    pub use crate::proto::Name;
+    pub use crate::proto::NameEntry;
+    pub use crate::proto::PFlags;
+    pub use crate::proto::PathInfo;
+    pub use crate::proto::SftpPacket;
+    pub use crate::proto::StatusCode;
+    /// Constants that might be useful for SFTP developers
+    pub mod constants {
+        pub use crate::proto::MAX_NAME_ENTRY_SIZE;
+    }
+}
+
+// /// Errors and results used in this crate
+// pub mod error {
+//     pub use crate::sftperror::SftpError;
+//     pub use crate::sftperror::SftpResult;
+// }