rsync-ssl.1.md

   1 ## NAME
   2
   3 rsync-ssl - a helper script for connecting to an ssl rsync daemon
   4
   5 ## SYNOPSIS
   6
   7 ```
   8 rsync-ssl [--type=SSL_TYPE] RSYNC_ARGS
   9 ```
  10
  11 The online version of this manpage (that includes cross-linking of topics)
  12 is available at <https://download.samba.org/pub/rsync/rsync-ssl.1>.
  13
  14 ## DESCRIPTION
  15
  16 The rsync-ssl script helps you to run an rsync copy to/from an rsync daemon
  17 that requires ssl connections.
  18
  19 The script requires that you specify an rsync-daemon arg in the style of either
  20 `hostname::` (with 2 colons) or `rsync://hostname/`.  The default port used for
  21 connecting is 874 (one higher than the normal 873) unless overridden in the
  22 environment.  You can specify an overriding port via `--port` or by including
  23 it in the normal spot in the URL format, though both of those require your
  24 rsync version to be at least 3.2.0.
  25
  26 ## OPTIONS
  27
  28 If the **first** arg is a `--type=SSL_TYPE` option, the script will only use
  29 that particular program to open an ssl connection instead of trying to find an
  30 openssl or stunnel executable via a simple heuristic (assuming that the
  31 `RSYNC_SSL_TYPE` environment variable is not set as well -- see below).  This
  32 option must specify one of `openssl` or `stunnel`.  The equal sign is
  33 required for this particular option.
  34
  35 All the other options are passed through to the rsync command, so consult the
  36 **rsync**(1) manpage for more information on how it works.
  37
  38 ## ENVIRONMENT VARIABLES
  39
  40 The ssl helper scripts are affected by the following environment variables:
  41
  42 0.  `RSYNC_SSL_TYPE`
  43
  44     Specifies the program type that should be used to open the ssl connection.
  45     It must be one of `openssl` or `stunnel`.  The `--type=SSL_TYPE` option
  46     overrides this, when specified.
  47
  48 0.  `RSYNC_SSL_PORT`
  49
  50     If specified, the value is the port number that is used as the default when
  51     the user does not specify a port in their rsync command.  When not
  52     specified, the default port number is 874.  (Note that older rsync versions
  53     (prior to 3.2.0) did not communicate an overriding port number value to the
  54     helper script.)
  55
  56 0.  `RSYNC_SSL_CERT`
  57
  58     If specified, the value is a filename that contains a certificate to use
  59     for the connection.
  60
  61 0.  `RSYNC_SSL_KEY`
  62
  63     If specified, the value is a filename that contains a key for the provided
  64     certificate to use for the connection.
  65
  66 0.  `RSYNC_SSL_CA_CERT`
  67
  68     If specified, the value is a filename that contains a certificate authority
  69     certificate that is used to validate the connection.
  70
  71 0.  `RSYNC_SSL_OPENSSL`
  72
  73     Specifies the openssl executable to run when the connection type is set to
  74     openssl.  If unspecified, the $PATH is searched for "openssl".
  75
  76 0.  `RSYNC_SSL_GNUTLS`
  77
  78     Specifies the gnutls-cli executable to run when the connection type is set
  79     to gnutls.  If unspecified, the $PATH is searched for "gnutls-cli".
  80
  81 0.  `RSYNC_SSL_STUNNEL`
  82
  83     Specifies the stunnel executable to run when the connection type is set to
  84     stunnel.  If unspecified, the $PATH is searched first for "stunnel4" and
  85     then for "stunnel".
  86
  87 ## EXAMPLES
  88
  89 >     rsync-ssl -aiv example.com::mod/ dest
  90
  91 >     rsync-ssl --type=openssl -aiv example.com::mod/ dest
  92
  93 >     rsync-ssl -aiv --port 9874 example.com::mod/ dest
  94
  95 >     rsync-ssl -aiv rsync://example.com:9874/mod/ dest
  96
  97 ## THE SERVER SIDE
  98
  99 For help setting up an SSL/TLS supporting rsync, see the [instructions in
 100 rsyncd.conf](rsyncd.conf.5#SSL_TLS_Daemon_Setup).
 101
 102 ## SEE ALSO
 103
 104 [**rsync**(1)](rsync.1), [**rsyncd.conf**(5)](rsyncd.conf.5)
 105
 106 ## CAVEATS
 107
 108 Note that using an stunnel connection requires at least version 4 of stunnel,
 109 which should be the case on modern systems.  Also, it does not verify a
 110 connection against the CA certificate collection, so it only encrypts the
 111 connection without any cert validation unless you have specified the
 112 certificate environment options.
 113
 114 This script also supports a `--type=gnutls` option, but at the time of this
 115 release the gnutls-cli command was dropping output, making it unusable.  If
 116 that bug has been fixed in your version, feel free to put gnutls into an
 117 exported RSYNC_SSL_TYPE environment variable to make its use the default.
 118
 119 ## BUGS
 120
 121 Please report bugs! See the web site at <https://rsync.samba.org/>.
 122
 123 ## VERSION
 124
 125 This manpage is current for version @VERSION@ of rsync.
 126
 127 ## CREDITS
 128
 129 Rsync is distributed under the GNU General Public License.  See the file
 130 [COPYING](COPYING) for details.
 131
 132 A web site is available at <https://rsync.samba.org/>.  The site includes an
 133 FAQ-O-Matic which may cover questions unanswered by this manual page.
 134
 135 ## AUTHOR
 136
 137 This manpage was written by Wayne Davison.
 138
 139 Mailing lists for support and development are available at
 140 <https://lists.samba.org/>.