While building Buttercup password manager, I was constantly looking for a suitable method to allow me to store my archive files so that they would be accessible on each device that I use. As I was already using free, self-hosted cloud storage options like Nextcloud, this seemed like the obvious method to try first.
Like several cloud storage solutions, Nextcloud supports WebDAV as a means of accessing files remotely. WebDAV is quite a mature and commonplace protocol that allows for easy integration amongst synchronization and file-storage tools. It’s also quite easy to implement client applications (from existing libraries or from scratch), depending on the use case.
For all of these reasons and more, WebDAV seemed like the best possible choice to start with in terms of password archive storage for Buttercup. At the time I didn’t find any particularly appealing libraries to use, so I wrote my own.
WebDAV-fs is a NodeJS WebDAV client that provides many methods for interacting with WebDAV servers. The fs in the title denotes that the library is intended to resemble Node’s fs module, and it implements some of its most-used methods:
readFile: Read a remote file on a WebDAV server – fetches the content asynchronously.
writeFile: Write to a remote file.
stat: Fetch statistics of a file.
mkdir: Create a directory.
readdir: Read the contents of a directory.
rename: Rename a remote file or directory.
unlink: Delete a remote file or directory.
Synchronous methods are obviously not supported due to the necessity of making RESTful requests.
WebDAV-fs began its life as its own project but was eventually split into two, branching off of the new WebDAV-client. The newer WebDAV-client project provides basically the same functionality, just with a more async-friendly API.
# You can install webdav-client from npm by running the following in your project:
npm install webdav --save
It’s clear to see just how simple it is reading from a remote server when you’re using WebDAV-client with Nextcloud, for instance. Here’s an example that reads a directory on a Nextcloud demo server:
This example asynchronously fetches the contents of the root of the Nextcloud server and logs all of the files and directories contained within. File explorers (that allow for the choosing of files) can be easily implemented around such a method as getDirectoryContents.
Applications like Buttercup can then very easily use tools such as this to read and write files remotely:
The benefit to using WebDAV-fs over WebDAV-client is that because it resembles the NodeJS fs API, the two can usually be used interchangeably if the application is designed for such work. Switching between local and remote files such as Buttercup does is made easy by the resemblance.
What was even more important for me when writing these tools was the ability to continue accessing storages like Nextcloud when working in the browser instead of NodeJS. Transpiling these libraries for use in the browser (with tools like webpack & browserify) works very well, and the final script is of reasonable size. At the core of webdav-client is node-fetch which provides the fetch method in both NodeJS and browser environments.
After some weeks of building and testing these libraries I discovered that quite a number of services and applications support WebDAV:
Today, US-based file sync & share vendor Kiteworks announced their acquisition of ownCloud and Dracoon. Kiteworks points out that their customers now have access to their file-sharing application. It is to be expected they will not maintain 3 similar products, but customers will have to migrate to the US firms’ platform or look for another […]
As part of Schleswig-Holstein's state digitization strategy, the state chancellery has announced they will work with Nextcloud to develop AI for working with government documents. This comes just after we announced the first private AI assistant last weekend with Hub 6. The German state already uses Nextcloud and their AI strategy aligns with our work on ethical, local AI technologies.
Over the last year, AI has become a popular topic. Some is hype, some is substance. Some is good, some is bad. We want to give you the good, not the bad, and ignore the hype! AI has a ton of opportunity – but also risk. So we put you in control – off by […]
The serious security flaws in ownCloud (now owned by Kiteworks) do NOT affect Nextcloud. We have strict security processes in place, and do not ship test data from libraries that can cause security breaches.