Swift library for SMB2/3 file operations on Apple platforms (iOS 13+, macOS 10.15+, tvOS 14+, watchOS 6+, visionOS 1+) and Linux. Wraps libsmb2 with a modern async/await API.

This is a fork of amosavian/AMSMB2, the original Swift SMB2 library created by Amir Abbas Mousavian. The original library provides a solid foundation for SMB2/3 file operations with async/await support, NSSecureCoding/Codable serialization, and Objective-C compatibility.

This fork extends the original with the following improvements:

• Connect to SMB2/3 shares with NTLM authentication
• List, create, remove directories (recursive)
• Read, write, append, truncate files with progress reporting
• Upload/download between local filesystem and SMB share
• Server-side copy and move operations
• Symbolic link creation and resolution
• File system and item attribute queries
• Change Notify (file monitoring)
• Streaming writes via AsyncSequence with backpressure flow control
• Pipelined read/write for high-throughput file transfers
• NSSecureCoding and Codable support for connection serialization (passwords intentionally excluded for security)
• Objective-C compatibility layer
• Direct access to SMB2Client and SMB2FileHandle for advanced use cases

Add to your Package.swift:

dependencies: [
    .package(url: "https://github.com/simplekube-ro/AMSMB2", branch: "master")
]

Then add the product dependency to your target:

.target(
    name: "MyApp",
    dependencies: [
        .product(name: "AMSMB2", package: "AMSMB2"),
    ]
)

import AMSMB2

// Create a manager
let url = URL(string: "smb://192.168.1.100")!
let credential = URLCredential(user: "username", password: "password", persistence: .forSession)
let smb = SMB2Manager(url: url, credential: credential)!

// Connect to a share
try await smb.connectShare(name: "Documents")

// List directory contents
let files = try await smb.contentsOfDirectory(atPath: "/")
for file in files {
    print(file.name ?? "?", file.fileSize ?? 0)
}

// Read a file
let data = try await smb.contents(atPath: "/report.pdf", progress: nil)

// Write a file
try await smb.write(data: data, toPath: "/backup/report.pdf", progress: nil)

// Upload a local file
let localURL = URL(fileURLWithPath: "/tmp/photo.jpg")
try await smb.uploadItem(at: localURL, toPath: "/photos/photo.jpg", progress: nil)

// Download a file
let downloadURL = URL(fileURLWithPath: "/tmp/downloaded.pdf")
try await smb.downloadItem(atPath: "/report.pdf", to: downloadURL, progress: nil)

// Disconnect
try await smb.disconnectShare()

git submodule update --init    # Required — fetches the libsmb2 C library

swift test

Runs 39 unit tests. Integration tests are automatically skipped when no SMB server is configured.

make integrationtest

Starts a Samba container, runs the full test suite (83 tests), and tears down. Requires Docker Desktop.

make linuxtest        # Uses local volume mount
make cleanlinuxtest   # Clean Docker build

• Architecture — Layer stack, event loop model, socket monitoring, buffer pool, pipelined I/O, thread safety model
• API Reference — Complete reference for all public types and methods

The source code in this repository is MIT licensed. However, it links to libsmb2 which is LGPL v2.1. The library is configured as a dynamic framework (.dynamic in Package.swift) to comply with LGPL requirements for App Store distribution.

You must link this library dynamically if you distribute your app on the App Store.