1rsync-ssl(1)                     User Commands                    rsync-ssl(1)
2
3
4

NAME

6       rsync-ssl - a helper script for connecting to an ssl rsync daemon
7

SYNOPSIS

9       rsync-ssl [--type=SSL_TYPE] RSYNC_ARGS
10

DESCRIPTION

12       The  rsync-ssl  script  helps you to run an rsync copy to/from an rsync
13       daemon that requires ssl connections.
14
15       The script requires that you specify an rsync-daemon arg in  the  style
16       of either hostname:: (with 2 colons) or rsync://hostname/.  The default
17       port used for connecting is 874 (one higher than the normal 873) unless
18       overridden  in the environment.  You can specify an overriding port via
19       --port or by including it in the normal spot in the URL format,  though
20       both of those require your rsync version to be at least 3.2.0.
21

OPTIONS

23       If  the first arg is a --type=SSL_TYPE option, the script will only use
24       that particular program to open an ssl connection instead of trying  to
25       find  an openssl or stunnel executable via a simple heuristic (assuming
26       that the RSYNC_SSL_TYPE environment variable is not set as well --  see
27       below).  This option must specify one of openssl or stunnel.  The equal
28       sign is required for this particular option.
29
30       All the other options are passed through to the rsync command, so  con‐
31       sult the rsync(1) manpage for more information on how it works.
32

ENVIRONMENT VARIABLES

34       The  ssl helper scripts are affected by the following environment vari‐
35       ables:
36
37       RSYNC_SSL_TYPE
38              Specifies the program type that should be used to open  the  ssl
39              connection.   It  must  be  one  of  openssl  or  stunnel.   The
40              --type=SSL_TYPE option overrides this, when specified.
41
42       RSYNC_SSL_PORT
43              If specified, the value is the port number that is used  as  the
44              default  when  the  user  does not specify a port in their rsync
45              command.  When not specified, the default port  number  is  874.
46              (Note  that older rsync versions (prior to 3.2.0) did not commu‐
47              nicate an overriding port number value to the helper script.)
48
49       RSYNC_SSL_CERT
50              If specified, the value is a filename that contains  a  certifi‐
51              cate to use for the connection.
52
53       RSYNC_SSL_CA_CERT
54              If  specified,  the value is a filename that contains a certifi‐
55              cate authority certificate that is used to validate the  connec‐
56              tion.
57
58       RSYNC_SSL_OPENSSL
59              Specifies the openssl executable to run when the connection type
60              is set to openssl.  If unspecified, the $PATH  is  searched  for
61              "openssl".
62
63       RSYNC_SSL_GNUTLS
64              Specifies  the  gnutls-cli executable to run when the connection
65              type is set to gnutls.  If unspecified, the  $PATH  is  searched
66              for "gnutls-cli".
67
68       RSYNC_SSL_STUNNEL
69              Specifies the stunnel executable to run when the connection type
70              is set to stunnel.  If unspecified, the $PATH is searched  first
71              for "stunnel4" and then for "stunnel".
72

EXAMPLES

74           rsync-ssl -aiv example.com::mod/ dest
75
76           rsync-ssl --type=openssl -aiv example.com::mod/ dest
77
78           rsync-ssl -aiv --port 9874 example.com::mod/ dest
79
80           rsync-ssl -aiv rsync://example.com:9874/mod/ dest
81

SEE ALSO

83       rsync(1), rsyncd.conf(5)
84

CAVEATS

86       Note  that  using  an stunnel connection requires at least version 4 of
87       stunnel, which should be the case on modern systems.  Also, it does not
88       verify  a  connection against the CA certificate collection, so it only
89       encrypts the connection without any cert  validation  unless  you  have
90       specified the certificate environment options.
91
92       This  script  also  supports a --type=gnutls option, but at the time of
93       this release the gnutls-cli command  was  dropping  output,  making  it
94       unusable.  If that bug has been fixed in your version, feel free to put
95       gnutls into an exported RSYNC_SSL_TYPE environment variable to make its
96       use the default.
97

BUGS

99       Please report bugs! See the web site at https://rsync.samba.org/.
100

VERSION

102       This man page is current for version 3.2.3 of rsync.
103

CREDITS

105       rsync  is  distributed  under  the GNU General Public License.  See the
106       file COPYING for details.
107
108       A web site is available at https://rsync.samba.org/.  The site includes
109       an  FAQ-O-Matic  which  may  cover  questions unanswered by this manual
110       page.
111

AUTHOR

113       This manpage was written by Wayne Davison.
114
115       Mailing  lists  for  support   and   development   are   available   at
116       https://lists.samba.org/.
117
118
119
120rsync-ssl 3.2.3                   06 Aug 2020                     rsync-ssl(1)
Impressum