Independentsoft.Webdav 2.0.0

WebDAV .NET 2.0

WebDAV .NET is a WebDAV client library for .NET. It is built on HttpClient, every request method is asynchronous, and it supports RFC 4918 and the WebDAV extensions in common use: access control, quota, collection synchronization, search, versioning, bindings and more.

using System.Net;
using Independentsoft.Webdav;

using var client = new WebdavClient(new NetworkCredential("username", "password"))
{
    BaseAddress = new Uri("https://myserver/dav/")
};

foreach (ResourceInfo resource in await client.List("documents/"))
{
    Console.WriteLine($"{resource.Name}  {resource.ContentLength}  {resource.LastModified}");
}

await client.Upload("documents/report.pdf", "report.pdf");
await client.Download("documents/report.pdf", "copy-of-report.pdf");

• Website: https://www.independentsoft.de/webdav/
• Tutorial with C# and VB examples: https://www.independentsoft.de/webdav/tutorial/
• NuGet: dotnet add package Independentsoft.Webdav

Supported .NET versions

The library targets .NET Standard 2.0, so it runs on:

• .NET 8, .NET 9, .NET 10 and later, .NET 5 to 7, .NET Core 2.0 and later
• .NET Framework 4.6.2 and later (4.7.2 or later recommended)
• Mono, Xamarin and Unity

It has no dependencies besides the .NET libraries.

Features

Supported specifications

Examples

Connect

// Basic, Digest, NTLM or Negotiate, whichever the server asks for.
using var client = new WebdavClient(new NetworkCredential("username", "password"));
client.BaseAddress = new Uri("https://myserver/dav/");

// A proxy, certificates or other connection settings: pass a handler.
var handler = new HttpClientHandler { Credentials = credential, Proxy = new WebProxy("http://proxy:8080") };
using var client2 = new WebdavClient(handler);

Upload and download with progress

var options = new UploadOptions
{
    ContentType = "application/pdf",
    Progress = new Progress<TransferProgress>(p => Console.WriteLine($"{p.Percentage:0}%"))
};

await client.Upload("documents/report.pdf", "report.pdf", options, cancellationToken);
await client.Download("documents/report.pdf", "report.pdf", options.Progress, cancellationToken);

Prevent lost updates

ResourceInfo file = await client.GetResource("documents/notes.txt");

try
{
    await client.Upload("documents/notes.txt", content, new UploadOptions { Precondition = Precondition.IfMatch(file.ETag!) });
}
catch (WebdavException e) when (e.StatusCode == HttpStatusCode.PreconditionFailed)
{
    // Someone else changed the file in the meantime.
}

Lock

ActiveLock fileLock = await client.Lock("documents/report.pdf", LockScope.Exclusive, Depth.Zero, TimeSpan.FromMinutes(10));

await client.Upload("documents/report.pdf", "report.pdf");   // the lock token is submitted automatically

await client.Unlock(fileLock);

Properties

var author = new PropertyName("author", "http://example.com/ns");

await client.SetProperty("documents/report.pdf", new Property(author, "John Smith"));
Property? value = await client.GetProperty("documents/report.pdf", author);

Permissions

IReadOnlyList<XName> privileges = await client.GetCurrentUserPrivileges("documents/report.pdf");
bool canWrite = privileges.Contains(DavPrivilege.Write) || privileges.Contains(DavPrivilege.All);

Synchronize

SyncResult changes = await client.SyncCollection("calendars/john/home/", savedToken);

foreach (ResourceInfo changed in changes.Changed) { /* download */ }
foreach (Uri removed in changes.Removed) { /* delete locally */ }

savedToken = changes.SyncToken;

Errors

try
{
    await client.Delete("documents/report.pdf");
}
catch (WebdavException e)
{
    Console.WriteLine($"{(int)e.StatusCode} {e.ReasonPhrase}, condition: {e.Condition}");
}

More examples, in C# and VB, are in the tutorial.

Upgrading from 1.x

Version 2.0 is a new library with a new API:

Building and testing

dotnet build Webdav/Webdav.csproj
dotnet test Webdav.Tests

The unit tests run against a simulated server. To run the server tests too, point them at one or more WebDAV collections the account may write to:

set WEBDAV_TEST_URLS=http://server:9090/;http://server:7070/home/user/
set WEBDAV_TEST_USER=user
set WEBDAV_TEST_PASSWORD=password
set WEBDAV_TEST_USER2=second-user
set WEBDAV_TEST_PASSWORD2=password
dotnet test Webdav.Tests

Each server test runs once for every server and is reported as inconclusive where a server lacks the feature it tests.

The tutorial examples are in Tutorial: python Tutorial/tutorial.py test runs every example, in C# and VB, against the servers, and python Tutorial/tutorial.py site publishes them as the tutorial pages.

License

WebDAV .NET is a commercial product of Independentsoft. See https://www.independentsoft.de/webdav/ for licensing.