# HG changeset patch # User Olaf Wintermann # Date 1501777740 -7200 # Node ID c743721d566fe66175ddb7f866b6600b55399254 # Parent b321a3be0a38fcc14ecbcbc4ad70058c39af54c7 more documentation diff -r b321a3be0a38 -r c743721d566f README --- a/README Thu Aug 03 14:32:36 2017 +0200 +++ b/README Thu Aug 03 18:29:00 2017 +0200 @@ -1,5 +1,5 @@ - DavUtils - cmd tools -============================ + DavUtils - dav cmd tools +========================== Introduction ------------ @@ -19,7 +19,8 @@ Documentation ------------- -Documentation can be found at http://davutils.sourceforge.net/docs/ +Documentation can be found at http://davutils.sourceforge.net/docs/ and +in the docs sub-directory. First Steps diff -r b321a3be0a38 -r c743721d566f docs/html/add-directory.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/html/add-directory.html Thu Aug 03 18:29:00 2017 +0200 @@ -0,0 +1,73 @@ + + + + + + + + + + + +
+ davutils documentation +
+
+
+

dav

+ +
+
+

dav-sync

+ +
+
+ + +
+

dav-sync add-directory

+

The command runs an interactive assistant that creates a sync-directory configuration and adds it to the sync.xml file. Before running this command, a repository must be created. See dav add-repository.

+

Command alias: add-dir

+
+ + + diff -r b321a3be0a38 -r c743721d566f docs/html/add-repository.html --- a/docs/html/add-repository.html Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/html/add-repository.html Thu Aug 03 18:29:00 2017 +0200 @@ -43,14 +43,30 @@

dav-sync

- +

dav add-repository

+

The command runs an interactive assistant that creates a repository configuration and adds it to the config.xml file.

+

Command alias: add-repo

diff -r b321a3be0a38 -r c743721d566f docs/html/check-config.html --- a/docs/html/check-config.html Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/html/check-config.html Thu Aug 03 18:29:00 2017 +0200 @@ -43,14 +43,29 @@

dav-sync

- +

dav check-config

+

Validates the config.xml file. If the config is ok, it prints Configuration OK. on stdout and returns 0, otherwise it prints an error message on stderr and returns 1.

diff -r b321a3be0a38 -r c743721d566f docs/html/check-repositories.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/html/check-repositories.html Thu Aug 03 18:29:00 2017 +0200 @@ -0,0 +1,71 @@ + + + + + + + + + + + +
+ davutils documentation +
+
+
+

dav

+ +
+
+

dav-sync

+ +
+
+ + +
+ +
+ + + diff -r b321a3be0a38 -r c743721d566f docs/html/commands.html --- a/docs/html/commands.html Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/html/commands.html Thu Aug 03 18:29:00 2017 +0200 @@ -43,7 +43,21 @@

dav-sync

diff -r b321a3be0a38 -r c743721d566f docs/html/configuration.html --- a/docs/html/configuration.html Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/html/configuration.html Thu Aug 03 18:29:00 2017 +0200 @@ -43,7 +43,21 @@

dav-sync

@@ -63,7 +77,7 @@ Example: <name>myrepo</name>

url

The url must point to a valid WebDAV compilant collection.

-

Type: string
+

Type: url
Example: <url>https://example.com/webdav/repo1/</url>

user

User used for authentication

@@ -138,23 +152,56 @@

Required child elements: <url>
Optional elements: <user>, <password>, <no>

url

+

Specifies the proxy url.

+

Type: url
+Example: <url>http://myproxy/</url>

user

+

User used for authentication with the proxy.

+

Type: string
+Example: <user>alice</user>

password

+

A base64 encoded password used for authentication.

+

Type: base64 string
+Example: <password>MTIzNDU2Nzg=</password>

no

+

A comma separated list of all hosts that should not be accessed through the proxy.

+

Type: string
+Example: <no>host1, host2, host3</no>

Example 1: minimal repository configuration

A minimal configuration for a repository. If no user and/or password are configured, dav prompts for authentication informations if required.

-
<repository>
-    <name>myrepo</name>
-    <url>https://example.com/path/to/repo/</url>
-</repository>
+
<configuration>
+    <repository>
+        <name>myrepo</name>
+        <url>https://example.com/path/to/repo/</url>
+    </repository>
+</configuration>

Example 2: repository with authentication informations

A typical configuration for easy accessing a repository without authentication prompt.

-
<repository>
-    <name>myrepo</name>
-    <url>https://example.com/path/to/repo/</url>
-    <user>alice</user>
-    <password>MTIzNDU2Nzg=</password>
-</repository>
+
<configuration>
+    <repository>
+        <name>myrepo</name>
+        <url>https://example.com/path/to/repo/</url>
+        <user>alice</user>
+        <password>MTIzNDU2Nzg=</password>
+    </repository>
+</configuration>
+

Example 3: repository with full encryption

+

A configuration for a full encrypted repository. Additionally to the repository a key must be configured.

+
<configuration>
+    <repository>
+        <name>myrepo</name>
+        <url>https://example.com/path/to/repo/</url>
+        <user>alice</user>
+        <password>MTIzNDU2Nzg=</password>
+        <full-encryption>true</full-encryption>
+    </repository>
+    
+    <key>
+        <name>mykey1</name>
+        <file>keys/mykey1</file>
+        <type>aes256</type>
+    </key>
+</configuration>
diff -r b321a3be0a38 -r c743721d566f docs/html/copy.html --- a/docs/html/copy.html Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/html/copy.html Thu Aug 03 18:29:00 2017 +0200 @@ -43,7 +43,21 @@

dav-sync

diff -r b321a3be0a38 -r c743721d566f docs/html/date.html --- a/docs/html/date.html Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/html/date.html Thu Aug 03 18:29:00 2017 +0200 @@ -43,7 +43,21 @@

dav-sync

diff -r b321a3be0a38 -r c743721d566f docs/html/davdoc.css --- a/docs/html/davdoc.css Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/html/davdoc.css Thu Aug 03 18:29:00 2017 +0200 @@ -28,14 +28,14 @@ div.nav { color: black; - background-color: #E9EBEC; + background-color: #d2d2d2; margin-bottom: 1em; padding-bottom: 0.1em; } div.nav h3 { color: white; - background-color: #5B6F7A; + background-color: #1a3300; font-size: 1.2em; padding-top: 0.2em; padding-bottom: 0.2em; @@ -59,7 +59,7 @@ div.content h1 { color: white; - background-color: #5B6F7A; + background-color: #1a3300; font-size: 1.2em; padding-top: 0.2em; padding-bottom: 0.2em; diff -r b321a3be0a38 -r c743721d566f docs/html/delete-conflicts.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/html/delete-conflicts.html Thu Aug 03 18:29:00 2017 +0200 @@ -0,0 +1,71 @@ + + + + + + + + + + + +
+ davutils documentation +
+
+
+

dav

+ +
+
+

dav-sync

+ +
+
+ + +
+ +
+ + + diff -r b321a3be0a38 -r c743721d566f docs/html/empty-trash.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/html/empty-trash.html Thu Aug 03 18:29:00 2017 +0200 @@ -0,0 +1,71 @@ + + + + + + + + + + + +
+ davutils documentation +
+
+
+

dav

+ +
+
+

dav-sync

+ +
+
+ + +
+ +
+ + + diff -r b321a3be0a38 -r c743721d566f docs/html/encryption.html --- a/docs/html/encryption.html Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/html/encryption.html Thu Aug 03 18:29:00 2017 +0200 @@ -43,14 +43,55 @@

dav-sync

- +

Encryption

+

The davutils programs have an integrated client-side encryption feature, that allows you to encrypt and decrypt on the fly with AES256 or AES128. To use this feature, the server must support WebDAV dead properties.

+

The tools support both, encryption of the resource content and encryption of the resource name. Each resource is encrypted separately. With activated name encryption, the actual resource name is random but the name used by the client is stored encrypted in WebDAV properties. This means, an attacker can see the directory structure and the file length, but can't see which files have the same name.

+

To enable encryption a key must be configured in $HOME/.dav/config.xml. A key must have an unique name. To access encrypted resources, all clients must configure the same key with the same name. Currently a key can only be loaded from a file and not generated from a password.

+

A configuration for a key looks like:

+
<key>
+    <name>mykey1</name>
+    <file>keys/mykey1</file>
+</key>
+

The file path must be relative to $HOME/.dav/. In this example the file $HOME/.dav/keys/mykey1 is loaded.

+

To generate a key use dd on unix like systems.

+
dd if=/dev/random of=mykey1 bs=32 count=1
+

After a key is configured, you can enable encryption/decryption in two ways. You can use the dav option -c to enable encryption and specify your key with the -k option. The alternative is to enable encryption by default for a repository in the config.xml file.

+
<repository>
+    <name>myrepo</name>
+    <url>http://example.com/webdav/</url>
+    
+    <default-key>mykey1</default-key>
+    <full-encryption>true</full-encryption>
+</repository>
+

See Configuration for details.

+

Internals

+

When a resource is encrypted, some crypto properties (namespace: http://davutils.org/) are set for the resource.

+
diff -r b321a3be0a38 -r c743721d566f docs/html/get-property.html --- a/docs/html/get-property.html Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/html/get-property.html Thu Aug 03 18:29:00 2017 +0200 @@ -43,7 +43,21 @@

dav-sync

diff -r b321a3be0a38 -r c743721d566f docs/html/get.html --- a/docs/html/get.html Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/html/get.html Thu Aug 03 18:29:00 2017 +0200 @@ -43,7 +43,21 @@

dav-sync

diff -r b321a3be0a38 -r c743721d566f docs/html/getting-started.html --- a/docs/html/getting-started.html Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/html/getting-started.html Thu Aug 03 18:29:00 2017 +0200 @@ -43,7 +43,21 @@

dav-sync

@@ -76,8 +90,7 @@ Added repository: myserv (http://example.com/webdav/) -

You can also configure the config.xml yourself, check out this example page and the config.xml spec.

-

More informations about urls and path in dav here.

+

You can also configure the config.xml yourself, check out the config.xml spec.

diff -r b321a3be0a38 -r c743721d566f docs/html/info.html --- a/docs/html/info.html Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/html/info.html Thu Aug 03 18:29:00 2017 +0200 @@ -43,7 +43,21 @@

dav-sync

diff -r b321a3be0a38 -r c743721d566f docs/html/introduction.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/html/introduction.html Thu Aug 03 18:29:00 2017 +0200 @@ -0,0 +1,71 @@ + + + + + + + + + + + +
+ davutils documentation +
+
+
+

dav

+ +
+
+

dav-sync

+ +
+
+ + +
+ +
+ + + diff -r b321a3be0a38 -r c743721d566f docs/html/list-directories.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/html/list-directories.html Thu Aug 03 18:29:00 2017 +0200 @@ -0,0 +1,73 @@ + + + + + + + + + + + +
+ davutils documentation +
+
+
+

dav

+ +
+
+

dav-sync

+ +
+
+ + +
+

dav-sync list-directories

+

This command lists all configured sync-directories.

+

Command alias: list-dirs

+
+ + + diff -r b321a3be0a38 -r c743721d566f docs/html/list-repositories.html --- a/docs/html/list-repositories.html Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/html/list-repositories.html Thu Aug 03 18:29:00 2017 +0200 @@ -43,14 +43,30 @@

dav-sync

- +

dav list-repositories

+

This command lists all configured repositories.

+

Command alias: list-repos

diff -r b321a3be0a38 -r c743721d566f docs/html/list.html --- a/docs/html/list.html Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/html/list.html Thu Aug 03 18:29:00 2017 +0200 @@ -43,7 +43,21 @@

dav-sync

diff -r b321a3be0a38 -r c743721d566f docs/html/lock.html --- a/docs/html/lock.html Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/html/lock.html Thu Aug 03 18:29:00 2017 +0200 @@ -43,7 +43,21 @@

dav-sync

diff -r b321a3be0a38 -r c743721d566f docs/html/mkdir.html --- a/docs/html/mkdir.html Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/html/mkdir.html Thu Aug 03 18:29:00 2017 +0200 @@ -43,7 +43,21 @@

dav-sync

diff -r b321a3be0a38 -r c743721d566f docs/html/move.html --- a/docs/html/move.html Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/html/move.html Thu Aug 03 18:29:00 2017 +0200 @@ -43,7 +43,21 @@

dav-sync

diff -r b321a3be0a38 -r c743721d566f docs/html/pull.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/html/pull.html Thu Aug 03 18:29:00 2017 +0200 @@ -0,0 +1,78 @@ + + + + + + + + + + + +
+ davutils documentation +
+
+
+

dav

+ +
+
+

dav-sync

+ +
+
+ + +
+

dav-sync pull

+

pull [-cld] <directory>

+

Pulls all changes from the server. All new or modified files are downloaded and all files deleted on the server are deleted locally. If a file is also locally modified and conflict detection is not disabled, the local file is renamed and an entry in the conflict database is added.

+

When a trash directory is configured for the SyncDirectory, all files that should be deleted are moved to the trash directory.

+

When backup-on-pull is enabled for the SyncDirectory, all files that should be overridden are moved to the trash.

+

-c Disable conflict detection. This always overrides locally modified files

+

-l Lock the repository before accessing it. After pull completed, the repository is unlocked

+

-d Don't lock the repository

+
+ + + diff -r b321a3be0a38 -r c743721d566f docs/html/push.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/html/push.html Thu Aug 03 18:29:00 2017 +0200 @@ -0,0 +1,77 @@ + + + + + + + + + + + +
+ davutils documentation +
+
+
+

dav

+ +
+
+

dav-sync

+ +
+
+ + +
+

dav-sync push

+

push [-cld] <directory>

+

Pushes all local changes to the server. This uploads all locally modified files and deletes all locally deleted files on the server.

+

If conflict detection is not disabled, all files that are also modified on the server will be skipped.

+

-c Disable conflict detection. This always overrides files on the server

+

-l Lock the repository before accessing it. After push completed, the repository is unlocked

+

-d Don't lock the repository

+
+ + + diff -r b321a3be0a38 -r c743721d566f docs/html/put.html --- a/docs/html/put.html Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/html/put.html Thu Aug 03 18:29:00 2017 +0200 @@ -43,7 +43,21 @@

dav-sync

diff -r b321a3be0a38 -r c743721d566f docs/html/remove.html --- a/docs/html/remove.html Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/html/remove.html Thu Aug 03 18:29:00 2017 +0200 @@ -43,7 +43,21 @@

dav-sync

diff -r b321a3be0a38 -r c743721d566f docs/html/resolve-conflicts.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/html/resolve-conflicts.html Thu Aug 03 18:29:00 2017 +0200 @@ -0,0 +1,71 @@ + + + + + + + + + + + +
+ davutils documentation +
+
+
+

dav

+ +
+
+

dav-sync

+ +
+
+ + +
+ +
+ + + diff -r b321a3be0a38 -r c743721d566f docs/html/set-property.html --- a/docs/html/set-property.html Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/html/set-property.html Thu Aug 03 18:29:00 2017 +0200 @@ -43,7 +43,21 @@

dav-sync

diff -r b321a3be0a38 -r c743721d566f docs/html/sync-check-config.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/html/sync-check-config.html Thu Aug 03 18:29:00 2017 +0200 @@ -0,0 +1,72 @@ + + + + + + + + + + + +
+ davutils documentation +
+
+
+

dav

+ +
+
+

dav-sync

+ +
+
+ + +
+

dav-sync check-config

+

Validates the sync.xml file. If the config is ok, it prints Configuration OK. on stdout and returns 0, otherwise it prints an error message on stderr and returns 1.

+
+ + + diff -r b321a3be0a38 -r c743721d566f docs/html/sync-commands.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/html/sync-commands.html Thu Aug 03 18:29:00 2017 +0200 @@ -0,0 +1,77 @@ + + + + + + + + + + + +
+ davutils documentation +
+
+
+

dav

+ +
+
+

dav-sync

+ +
+
+ + +
+

Commands

+

All commands expect a <directory> argument, which is the identifer of a local directory that should be synchronized. The directory must be configured in sync.xml. See Configuration.

+

Common Commands

+

Get resources from the server, which are modified since last sync:

+
dav pull <directory>
+

Upload all locally modified resources:

+
dav push <directory>
+
+ + + diff -r b321a3be0a38 -r c743721d566f docs/html/sync-configuration.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/html/sync-configuration.html Thu Aug 03 18:29:00 2017 +0200 @@ -0,0 +1,71 @@ + + + + + + + + + + + +
+ davutils documentation +
+
+
+

dav

+ +
+
+

dav-sync

+ +
+
+ + +
+ +
+ + + diff -r b321a3be0a38 -r c743721d566f docs/html/trash-info.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/html/trash-info.html Thu Aug 03 18:29:00 2017 +0200 @@ -0,0 +1,71 @@ + + + + + + + + + + + +
+ davutils documentation +
+
+
+

dav

+ +
+
+

dav-sync

+ +
+
+ + +
+ +
+ + + diff -r b321a3be0a38 -r c743721d566f docs/html/unlock.html --- a/docs/html/unlock.html Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/html/unlock.html Thu Aug 03 18:29:00 2017 +0200 @@ -43,7 +43,21 @@

dav-sync

diff -r b321a3be0a38 -r c743721d566f docs/src/Makefile --- a/docs/src/Makefile Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/src/Makefile Thu Aug 03 18:29:00 2017 +0200 @@ -49,6 +49,20 @@ SRC += add-repository.md SRC += list-repositories.md SRC += check-config.md +SRC += introduction.md +SRC += sync-commands.md +SRC += pull.md +SRC += push.md +SRC += resolve-conflicts.md +SRC += delete-conflicts.md +SRC += trash-info.md +SRC += empty-trash.md +SRC += add-directory.md +SRC += list-directories.md +SRC += sync-check-config.md +SRC += check-repositories.md +SRC += sync-configuration.md + HTML = $(SRC:%.md=build/%.html) diff -r b321a3be0a38 -r c743721d566f docs/src/add-directory.md --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/src/add-directory.md Thu Aug 03 18:29:00 2017 +0200 @@ -0,0 +1,8 @@ +dav-sync add-directory +====================== + +The command runs an interactive assistant that creates a sync-directory configuration and adds it to the sync.xml file. Before running this command, a repository must be created. See [dav add-repository][1]. + +[1]: ./add-repository.html + +**Command alias:** add-dir diff -r b321a3be0a38 -r c743721d566f docs/src/add-repository.md --- a/docs/src/add-repository.md Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/src/add-repository.md Thu Aug 03 18:29:00 2017 +0200 @@ -0,0 +1,6 @@ +dav add-repository +================== + +The command runs an interactive assistant that creates a repository configuration and adds it to the config.xml file. + +**Command alias:** add-repo diff -r b321a3be0a38 -r c743721d566f docs/src/check-config.md --- a/docs/src/check-config.md Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/src/check-config.md Thu Aug 03 18:29:00 2017 +0200 @@ -0,0 +1,4 @@ +dav check-config +================ + +Validates the config.xml file. If the config is ok, it prints `Configuration OK.` on stdout and returns 0, otherwise it prints an error message on stderr and returns 1. diff -r b321a3be0a38 -r c743721d566f docs/src/check-repositories.md diff -r b321a3be0a38 -r c743721d566f docs/src/configuration.md --- a/docs/src/configuration.md Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/src/configuration.md Thu Aug 03 18:29:00 2017 +0200 @@ -23,7 +23,7 @@ The url must point to a valid WebDAV compilant collection. -Type: string \ +Type: url \ Example: `https://example.com/webdav/repo1/` ### user @@ -150,29 +150,73 @@ ### url +Specifies the proxy url. + +Type: url \ +Example: `http://myproxy/` + ### user +User used for authentication with the proxy. + +Type: string \ +Example: `alice` + ### password +A base64 encoded password used for authentication. + +Type: base64 string \ +Example: `MTIzNDU2Nzg=` + ### no +A comma separated list of all hosts that should not be accessed through the proxy. + +Type: string \ +Example: `host1, host2, host3` + ## Example 1: minimal repository configuration A minimal configuration for a repository. If no user and/or password are configured, dav prompts for authentication informations if required. - - myrepo - https://example.com/path/to/repo/ - + + + myrepo + https://example.com/path/to/repo/ + + ## Example 2: repository with authentication informations A typical configuration for easy accessing a repository without authentication prompt. - - myrepo - https://example.com/path/to/repo/ - alice - MTIzNDU2Nzg= - + + + myrepo + https://example.com/path/to/repo/ + alice + MTIzNDU2Nzg= + + + +## Example 3: repository with full encryption + +A configuration for a full encrypted repository. Additionally to the repository a key must be configured. + + + myrepo + https://example.com/path/to/repo/ + alice + MTIzNDU2Nzg= + true + + + + mykey1 + keys/mykey1 + aes256 + + + diff -r b321a3be0a38 -r c743721d566f docs/src/davdoc.css --- a/docs/src/davdoc.css Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/src/davdoc.css Thu Aug 03 18:29:00 2017 +0200 @@ -28,14 +28,14 @@ div.nav { color: black; - background-color: #E9EBEC; + background-color: #d2d2d2; margin-bottom: 1em; padding-bottom: 0.1em; } div.nav h3 { color: white; - background-color: #5B6F7A; + background-color: #1a3300; font-size: 1.2em; padding-top: 0.2em; padding-bottom: 0.2em; @@ -59,7 +59,7 @@ div.content h1 { color: white; - background-color: #5B6F7A; + background-color: #1a3300; font-size: 1.2em; padding-top: 0.2em; padding-bottom: 0.2em; diff -r b321a3be0a38 -r c743721d566f docs/src/delete-conflicts.md diff -r b321a3be0a38 -r c743721d566f docs/src/empty-trash.md diff -r b321a3be0a38 -r c743721d566f docs/src/encryption.md --- a/docs/src/encryption.md Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/src/encryption.md Thu Aug 03 18:29:00 2017 +0200 @@ -0,0 +1,46 @@ +Encryption +========== + +The davutils programs have an integrated client-side encryption feature, that allows you to encrypt and decrypt on the fly with AES256 or AES128. To use this feature, the server **must** support WebDAV dead properties. + +The tools support both, encryption of the resource content and encryption of the resource name. Each resource is encrypted separately. With activated name encryption, the actual resource name is random but the name used by the client is stored encrypted in WebDAV properties. This means, an attacker can see the directory structure and the file length, but can't see which files have the same name. + +To enable encryption a key must be configured in `$HOME/.dav/config.xml`. A key must have an unique name. To access encrypted resources, all clients must configure the same key with the same name. Currently a key can only be loaded from a file and not generated from a password. + +A configuration for a key looks like: + + + mykey1 + keys/mykey1 + + +The file path must be relative to `$HOME/.dav/`. In this example the file `$HOME/.dav/keys/mykey1` is loaded. + +To generate a key use **`dd`** on unix like systems. + + dd if=/dev/random of=mykey1 bs=32 count=1 + +After a key is configured, you can enable encryption/decryption in two ways. You can use the dav option **`-c`** to enable encryption and specify your key with the **`-k`** option. The alternative is to enable encryption by default for a repository in the config.xml file. + + + myrepo + http://example.com/webdav/ + + mykey1 + true + + +See [Configuration][1] for details. + +[1]: ./configuration.html + +Internals +--------- + +When a resource is encrypted, some crypto properties (namespace: http://davutils.org/) are set for the resource. + + - crypto-key: Contains the name of the key used for encryption. The presence of this property indicates that the resource is encrypted + - crypto-hash: A Hash of the cleartext, encrypted and base64 encoded + - crypto-name: The name of the resource, encrypted and base64 encoded. This property is not used if name encryption is disabled. + + diff -r b321a3be0a38 -r c743721d566f docs/src/getting-started.md --- a/docs/src/getting-started.md Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/src/getting-started.md Thu Aug 03 18:29:00 2017 +0200 @@ -39,6 +39,7 @@ Added repository: myserv (http://example.com/webdav/) -You can also configure the config.xml yourself, check out this example page and the config.xml spec. +You can also configure the config.xml yourself, check out [the config.xml spec][1]. -More informations about urls and path in dav here. +[1]: ./configuration.html + diff -r b321a3be0a38 -r c743721d566f docs/src/header.html --- a/docs/src/header.html Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/src/header.html Thu Aug 03 18:29:00 2017 +0200 @@ -32,7 +32,21 @@

dav-sync

diff -r b321a3be0a38 -r c743721d566f docs/src/introduction.md diff -r b321a3be0a38 -r c743721d566f docs/src/list-directories.md --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/src/list-directories.md Thu Aug 03 18:29:00 2017 +0200 @@ -0,0 +1,6 @@ +dav-sync list-directories +===================== + +This command lists all configured sync-directories. + +**Command alias:** list-dirs diff -r b321a3be0a38 -r c743721d566f docs/src/list-repositories.md --- a/docs/src/list-repositories.md Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/src/list-repositories.md Thu Aug 03 18:29:00 2017 +0200 @@ -0,0 +1,6 @@ +dav list-repositories +===================== + +This command lists all configured repositories. + +**Command alias:** list-repos diff -r b321a3be0a38 -r c743721d566f docs/src/pull.md --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/src/pull.md Thu Aug 03 18:29:00 2017 +0200 @@ -0,0 +1,18 @@ +dav-sync pull +============= + +**`pull [-cld] `** + +Pulls all changes from the server. All new or modified files are downloaded and all files deleted on the server are deleted locally. If a file is also locally modified and conflict detection is not disabled, the local file is renamed and an entry in the conflict database is added. + +When a trash directory is configured for the SyncDirectory, all files that should be deleted are moved to the trash directory. + +When backup-on-pull is enabled for the SyncDirectory, all files that should be overridden are moved to the trash. + +**`-c`** Disable conflict detection. This always overrides locally modified files + +**`-l`** Lock the repository before accessing it. After `pull` completed, the repository is unlocked + +**`-d`** Don't lock the repository + + diff -r b321a3be0a38 -r c743721d566f docs/src/push.md --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/src/push.md Thu Aug 03 18:29:00 2017 +0200 @@ -0,0 +1,14 @@ +dav-sync push +============= + +**`push [-cld] `** + +Pushes all local changes to the server. This uploads all locally modified files and deletes all locally deleted files on the server. + +If conflict detection is not disabled, all files that are also modified on the server will be skipped. + +**`-c`** Disable conflict detection. This always overrides files on the server + +**`-l`** Lock the repository before accessing it. After `push` completed, the repository is unlocked + +**`-d`** Don't lock the repository diff -r b321a3be0a38 -r c743721d566f docs/src/resolve-conflicts.md diff -r b321a3be0a38 -r c743721d566f docs/src/sync-check-config.md --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/src/sync-check-config.md Thu Aug 03 18:29:00 2017 +0200 @@ -0,0 +1,4 @@ +dav-sync check-config +===================== + +Validates the sync.xml file. If the config is ok, it prints Configuration OK. on stdout and returns 0, otherwise it prints an error message on stderr and returns 1. diff -r b321a3be0a38 -r c743721d566f docs/src/sync-commands.md --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/src/sync-commands.md Thu Aug 03 18:29:00 2017 +0200 @@ -0,0 +1,19 @@ +Commands +======== + +All commands expect a `` argument, which is the identifer of a local directory that should be synchronized. The directory must be configured in sync.xml. See [Configuration][1]. + +[1]: ./sync-configuration.html + +Common Commands +--------------- + +Get resources from the server, which are modified since last sync: + + dav pull + +Upload all locally modified resources: + + dav push + + diff -r b321a3be0a38 -r c743721d566f docs/src/sync-configuration.md diff -r b321a3be0a38 -r c743721d566f docs/src/trash-info.md