esp-idf-webdav-client

WebDav client example for ESP-IDF.
ESP-IDF contains a lot of example code, but there is no example to WebDav client.
This project uses the WevDav protocol to manipulate files on a WebDav server.
No libraries other than ESP-IDF are required to use WebDav.

Waht is WebDav

WebDAV (Web-based Distributed Authoring and Versioning) is an extension of Hypertext Transfer Protocol and is a protocol that realizes a distributed file system for managing files on web servers. https://en.wikipedia.org/wiki/WebDAV

Software requiment

ESP-IDF V4.4/V5.x.
ESP-IDF V5.0 is required when using ESP32-C2.
ESP-IDF V5.1 is required when using ESP32-C6.

Installation

git clone https://github.com/nopnop2002/esp-idf-webdav-client
cd esp-idf-webdav-client
idf.py menuconfig
idf.py flash monitor

Configuration

Set the following items using menuconfig.

WiFi Setting

HTTP Server Setting

HTTP server is specified by one of the following.

• IP address
  192.168.10.20
• mDNS host name
  http-server.local
• Fully Qualified Domain Name
  httpbin.org

You can use BASIC authentication.

Start WebDav server on Linux

# Install wsgidav
sudo apt install git python3-pip python3-setuptools
python3 -m pip install -U pip
python3 -m pip install wsgidav cheroot

# Create public folder
mkdir $HOME/web-test

# Start WebDav server
wsgidav --host=0.0.0.0 --port=8080 --root=$HOME/web-test --auth anonymous

How to use

• Open a new terminal and navigate to your public directory.

$ cd $HOME/web-test
$ LANG=C ls -lR
.:
total 0

• Create new folder

W (6604) HTTP: Creating new foder on Webdav Server. Press Enter when ready.   

$ LANG=C ls -lR
.:
total 4
drwxrwxr-x 2 nop nop 4096 Feb 19 23:26 new_folder

./new_folder:
total 0

• Create new text file

W (28975) HTTP: Creating new text file on Webdav Server. Press Enter when ready.

$ LANG=C ls -lR
.:
total 4
drwxrwxr-x 2 nop nop 4096 Feb 20 09:00 new_folder

./new_folder:
total 4
-rw-rw-r-- 1 nop nop 286 Feb 20 09:00 file.txt

• Create new binary file

W (47475) HTTP: Creating new binary file on Webdav Server. Press Enter when ready.

$ LANG=C ls -lR
.:
total 4
drwxrwxr-x 2 nop nop 4096 Feb 26 06:18 new_folder

./new_folder:
total 24
-rw-rw-r-- 1 nop nop 18753 Feb 26 06:18 esp32.jpeg
-rw-rw-r-- 1 nop nop   286 Feb 26 06:18 file.txt

• Get file from server

W (14114) HTTP: Geting file on Webdav Server. Press Enter when ready.

• Copy file

W (37584) HTTP: Copying file on Webdav Server. Press Enter when ready.

$ LANG=C ls -lR
.:
total 4
drwxrwxr-x 2 nop nop 4096 Feb 26 06:19 new_folder

./new_folder:
total 28
-rw-rw-r-- 1 nop nop 18753 Feb 26 06:18 esp32.jpeg
-rw-rw-r-- 1 nop nop   286 Feb 26 06:18 file.txt
-rw-rw-r-- 1 nop nop   286 Feb 26 06:18 file2.txt

• Move file

W (19844) HTTP: Moveing file on Webdav Server. Press Enter when ready.

$ LANG=C ls -lR
.:
total 4
drwxrwxr-x 2 nop nop 4096 Feb 26 06:19 new_folder

./new_folder:
total 28
-rw-rw-r-- 1 nop nop 18753 Feb 26 06:18 esp32.jpeg
-rw-rw-r-- 1 nop nop   286 Feb 26 06:18 file2.txt
-rw-rw-r-- 1 nop nop   286 Feb 26 06:18 file3.txt

• Copy folder

W (40084) HTTP: Copying folder on Webdav Server. Press Enter when ready.

$ LANG=C ls -lR
.:
total 8
drwxrwxr-x 2 nop nop 4096 Feb 26 06:20 copy_folder
drwxrwxr-x 2 nop nop 4096 Feb 26 06:19 new_folder

./copy_folder:
total 28
-rw-rw-r-- 1 nop nop 18753 Feb 26 06:18 esp32.jpeg
-rw-rw-r-- 1 nop nop   286 Feb 26 06:18 file2.txt
-rw-rw-r-- 1 nop nop   286 Feb 26 06:18 file3.txt

./new_folder:
total 28
-rw-rw-r-- 1 nop nop 18753 Feb 26 06:18 esp32.jpeg
-rw-rw-r-- 1 nop nop   286 Feb 26 06:18 file2.txt
-rw-rw-r-- 1 nop nop   286 Feb 26 06:18 file3.txt

• Delete file

W (84614) HTTP: Deleting file on Webdav Server. Press Enter when ready.

t$ LANG=C ls -lR
.:
total 8
drwxrwxr-x 2 nop nop 4096 Feb 26 06:20 copy_folder
drwxrwxr-x 2 nop nop 4096 Feb 26 06:20 new_folder

./copy_folder:
total 28
-rw-rw-r-- 1 nop nop 18753 Feb 26 06:18 esp32.jpeg
-rw-rw-r-- 1 nop nop   286 Feb 26 06:18 file2.txt
-rw-rw-r-- 1 nop nop   286 Feb 26 06:18 file3.txt

./new_folder:
total 24
-rw-rw-r-- 1 nop nop 18753 Feb 26 06:18 esp32.jpeg
-rw-rw-r-- 1 nop nop   286 Feb 26 06:18 file2.txt

• Delete folder

W (118894) HTTP: Deleting folder on Webdav Server. Press Enter when ready.

$ LANG=C ls -lR
.:
total 0

Limitaion

• LOCK/UNLOCK is not supported.
• https is not supported.

Using curl

You can work with files using curl.
In addition to PUT/GET/DELETE, WebDav can use PROPFIND/MKCOL/COPY/MOVE.

• Find All Files/Folders on Webdav Server:
  The body is XML and follows the following schema.
  https://personium.io/docs/en/apiref/307_Get_Property

curl -i -X PROPFIND '192.168.10.42:8080'

• Find a Folder on Webdav Server:

curl -i -X PROPFIND '192.168.10.42:8080/new_folder'

• Find a File on Webdav Server:

curl -i -X PROPFIND '192.168.10.42:8080/new_folder/file.tx'

• Creat new foder on Webdav Server:

curl -i -X MKCOL '192.168.10.42:8080/new_folder'

• Upload Text File on Webdav Server:

curl -i -X PUT -T 'file.txt' '192.168.10.42:8080/new_folder/file.txt'

• Upload Binary File on Webdav Server:

curl -i -X PUT --data-binary @'esp32.jpeg' '192.168.10.42:8080/new_folder/esp32.jpeg'

• Download file on Webdav Server:

curl -i -X GET '192.168.10.42:8080/new_folder/file.txt'

• Copy file on Webdav Server:

curl -i -X COPY '192.168.10.42:8080/new_folder/file.txt' -H "Destination: /new_folder/file2.txt"

• Copy file on Webdav Server by overwriting them:

curl -i -X COPY '192.168.10.42:8080/new_folder/file.txt' -H "Destination: /new_folder/file2.txt" -H "Overwrite: T"

• Move file on Webdav Server:

curl -i -X MOVE '192.168.10.42:8080/new_folder/file.txt' -H "Destination: /new_folder/file3.txt"

• Move file on Webdav Server by overwriting them:

curl -i -X MOVE '192.168.10.42:8080/new_folder/file.txt' -H "Destination: /new_folder/file3.txt" -H "Overwrite: T"

• Copy folder on Webdav Server:

curl -i -X COPY '192.168.10.42:8080/new_folder' -H "Destination: /copy-folder"

• Delete file on Webdav Server:

curl -i -X DELETE '192.168.10.42:8080/copy-folder/file3.txt'

• Delete folder on Webdav Server:

curl -i -X DELETE '192.168.10.42:8080/copy-folder'