1 After applying this patch, run these commands for a successful build:
11 I've been hacking together a way to use rsync with OpenSSL, and have
12 attached my current patch against a recent CVS tree. The details of
13 this implementation are:
15 1. The SSL code is added as a "layer" that is forked into its own
18 2. An SSL connection is established by the client issuing the
23 And, if the server allows SSL, it replies with
27 At which point both sides begin negotiating the SSL connection.
28 Servers that can't or don't want to use SSL just treat it as a
29 normal unknown command.
31 3. The SSL code is meant to be unobtrusive, and when this patch is
32 applied the program may still be built with no SSL code.
34 4. There are a number of details not implemented.
36 All warnings apply; I don't do C programming all that often, so I
37 can't say if I've left any cleanup/compatibility errors in the code.
40 --- orig/Makefile.in 2004-05-15 00:53:53
41 +++ Makefile.in 2004-07-03 20:22:28
42 @@ -39,7 +39,7 @@ OBJS3=progress.o pipe.o
43 DAEMON_OBJ = params.o loadparm.o clientserver.o access.o connection.o authenticate.o
44 popt_OBJS=popt/findme.o popt/popt.o popt/poptconfig.o \
45 popt/popthelp.o popt/poptparse.o
46 -OBJS=$(OBJS1) $(OBJS2) $(OBJS3) $(DAEMON_OBJ) $(LIBOBJ) $(ZLIBOBJ) @BUILD_POPT@
47 +OBJS=$(OBJS1) $(OBJS2) $(OBJS3) $(DAEMON_OBJ) $(LIBOBJ) $(ZLIBOBJ) @BUILD_POPT@ @SSL_OBJS@
49 TLS_OBJ = tls.o syscall.o lib/permstring.o
51 --- orig/cleanup.c 2004-07-02 18:11:26
52 +++ cleanup.c 2004-07-03 20:22:28
55 extern int keep_partial;
56 extern int log_got_error;
62 * Close all open sockets and files, allowing a (somewhat) graceful
63 @@ -98,6 +101,11 @@ void _exit_cleanup(int code, const char
64 signal(SIGUSR1, SIG_IGN);
65 signal(SIGUSR2, SIG_IGN);
73 rprintf(FINFO,"_exit_cleanup(code=%d, file=%s, line=%d): entered\n",
75 --- orig/clientserver.c 2004-06-18 15:59:19
76 +++ clientserver.c 2004-07-03 20:22:28
77 @@ -46,6 +46,9 @@ extern int io_timeout;
78 extern int orig_umask;
80 extern int default_af_hint;
84 extern char *bind_address;
85 extern struct exclude_list_struct server_exclude_list;
86 extern char *exclude_path_prefix;
87 @@ -93,8 +96,18 @@ int start_socket_client(char *host, char
88 exit_cleanup(RERR_SOCKETIO);
90 ret = start_inband_exchange(user, path, fd, fd, argc);
96 + int f_in = get_tls_rfd();
97 + int f_out = get_tls_wfd();
98 + return client_run(f_in, f_out, -1, argc, argv);
102 - return ret < 0? ret : client_run(fd, fd, -1, argc, argv);
103 + return client_run(fd, fd, -1, argc, argv);
106 int start_inband_exchange(char *user, char *path, int f_in, int f_out, int argc)
107 @@ -148,6 +161,33 @@ int start_inband_exchange(char *user, ch
108 if (protocol_version > remote_protocol)
109 protocol_version = remote_protocol;
113 + io_printf(f_out, "#starttls\n");
115 + if (!read_line(f_in, line, sizeof(line)-1)) {
116 + rprintf(FERROR, "rsync: did not receive reply to #starttls\n");
119 + if (strncmp(line, "@ERROR", 6) == 0) {
120 + rprintf(FERROR, "rsync: ssl connection denied\n");
123 + if (strcmp(line, "@RSYNCD: starttls") == 0) {
126 + rprintf(FINFO, "%s\n", line);
128 + if (start_tls(f_in, f_out)) {
129 + rprintf(FERROR, "rsync: error during SSL handshake: %s\n",
133 + f_in = get_tls_rfd();
134 + f_out = get_tls_wfd();
138 p = strchr(path,'/');
140 io_printf(f_out, "%s\n", path);
141 @@ -176,6 +216,10 @@ int start_inband_exchange(char *user, ch
142 * server to terminate the listing of modules.
143 * We don't want to go on and transfer
144 * anything; just exit. */
152 @@ -183,6 +227,10 @@ int start_inband_exchange(char *user, ch
153 rprintf(FERROR, "%s\n", line);
154 /* This is always fatal; the server will now
155 * close the socket. */
160 return RERR_STARTCLIENT;
162 rprintf(FINFO,"%s\n", line);
163 @@ -487,6 +535,7 @@ static void send_listing(int fd)
164 io_printf(fd,"@RSYNCD: EXIT\n");
168 /* this is called when a connection is established to a client
169 and we want to start talking. The setup of the system is done from
171 @@ -544,6 +593,20 @@ int start_daemon(int f_in, int f_out)
176 + if (use_ssl && strcmp(line, "#starttls") == 0) {
177 + io_printf(f_out, "@RSYNCD: starttls\n");
178 + if (start_tls(f_in, f_out)) {
179 + rprintf(FLOG, "SSL connection failed: %s\n",
183 + f_in = get_tls_rfd();
184 + f_out = get_tls_wfd();
190 /* it's some sort of command that I don't understand */
191 io_printf(f_out, "@ERROR: Unknown command '%s'\n", line);
192 --- orig/configure.in 2004-04-30 18:04:07
193 +++ configure.in 2004-07-03 20:22:28
194 @@ -271,6 +271,21 @@ yes
195 AC_SEARCH_LIBS(getaddrinfo, inet6)
198 +AC_ARG_ENABLE(openssl,
199 + AC_HELP_STRING([--enable-openssl], [compile SSL support with OpenSSL.]))
201 +if test "x$enable_openssl" != xno
204 + AC_CHECK_LIB(ssl, SSL_library_init, , [have_ssl=no])
205 + if test "x$have_ssl" = xyes
207 + AC_DEFINE(HAVE_OPENSSL, 1, [true if you want to use SSL.])
213 AC_MSG_CHECKING([whether to call shutdown on all sockets])
215 *cygwin* ) AC_MSG_RESULT(yes)
216 --- orig/main.c 2004-06-30 07:24:30
217 +++ main.c 2004-07-03 20:22:28
218 @@ -52,6 +52,9 @@ extern int rsync_port;
219 extern int read_batch;
220 extern int write_batch;
221 extern int filesfrom_fd;
225 extern pid_t cleanup_child_pid;
226 extern char *files_from;
227 extern char *remote_filesfrom_file;
228 @@ -719,17 +722,32 @@ static int start_client(int argc, char *
232 + int url_prefix = strlen(URL_PREFIX);
234 /* Don't clobber argv[] so that ps(1) can still show the right
236 if ((rc = copy_argv(argv)))
239 + if (strncasecmp(URL_PREFIX, argv[0], url_prefix) != 0) {
241 + url_prefix = strlen(SSL_URL_PREFIX);
242 + if (strncasecmp(SSL_URL_PREFIX, argv[0], url_prefix) != 0)
253 /* rsync:// always uses rsync server over direct socket connection */
254 - if (strncasecmp(URL_PREFIX, argv[0], strlen(URL_PREFIX)) == 0) {
258 - host = argv[0] + strlen(URL_PREFIX);
259 + host = argv[0] + url_prefix;
260 p = strchr(host,'/');
263 @@ -777,12 +795,27 @@ static int start_client(int argc, char *
265 } else { /* source is local */
267 + url_prefix = strlen(URL_PREFIX);
268 + if (strncasecmp(URL_PREFIX, argv[0], url_prefix) != 0) {
270 + url_prefix = strlen(SSL_URL_PREFIX);
271 + if (strncasecmp(SSL_URL_PREFIX, argv[0], url_prefix) != 0)
283 /* rsync:// destination uses rsync server over direct socket */
284 - if (strncasecmp(URL_PREFIX, argv[argc-1], strlen(URL_PREFIX)) == 0) {
288 - host = argv[argc-1] + strlen(URL_PREFIX);
289 + host = argv[argc-1] + url_prefix;
290 p = strchr(host,'/');
293 --- orig/options.c 2004-06-20 19:30:00
294 +++ options.c 2004-07-03 20:22:28
295 @@ -133,6 +133,14 @@ int quiet = 0;
296 int always_checksum = 0;
301 +char *ssl_cert_path = NULL;
302 +char *ssl_key_path = NULL;
303 +char *ssl_key_passwd = NULL;
304 +char *ssl_ca_path = NULL;
307 #define FIXED_CHECKSUM_SEED 32761
308 #define MAX_BATCH_PREFIX_LEN 256 /* Must be less than MAXPATHLEN-13 */
309 char *batch_prefix = NULL;
310 @@ -145,13 +153,13 @@ static int modify_window_set;
311 * address, or a hostname. **/
315 static void print_rsync_version(enum logcode f)
317 char const *got_socketpair = "no ";
318 char const *hardlinks = "no ";
319 char const *links = "no ";
320 char const *ipv6 = "no ";
321 + char const *ssl = "no ";
322 STRUCT_STAT *dumstat;
324 #ifdef HAVE_SOCKETPAIR
325 @@ -170,6 +178,10 @@ static void print_rsync_version(enum log
333 rprintf(f, "%s version %s protocol version %d\n",
334 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION);
336 @@ -183,10 +195,10 @@ static void print_rsync_version(enum log
337 /* Note that this field may not have type ino_t. It depends
338 * on the complicated interaction between largefile feature
340 - rprintf(f, " %sIPv6, %d-bit system inums, %d-bit internal inums\n",
341 + rprintf(f, " %sIPv6, %d-bit system inums, %d-bit internal inums, %sssl\n",
343 (int) (sizeof dumstat->st_ino * 8),
344 - (int) (sizeof (uint64) * 8));
345 + (int) (sizeof (uint64) * 8), ssl);
346 #ifdef MAINTAINER_MODE
347 rprintf(f, " panic action: \"%s\"\n",
349 @@ -299,6 +311,13 @@ void usage(enum logcode F)
350 rprintf(F," -4 --ipv4 prefer IPv4\n");
351 rprintf(F," -6 --ipv6 prefer IPv6\n");
354 + rprintf(F," --ssl allow socket connections to use SSL\n");
355 + rprintf(F," --ssl-cert=FILE path to server's SSL certificate\n");
356 + rprintf(F," --ssl-key=FILE path to server's SSL private key\n");
357 + rprintf(F," --ssl-key-passwd=PASS password for PEM-encoded private key\n");
358 + rprintf(F," --ssl-ca-certs=FILE path to trusted CA certificates\n");
360 rprintf(F," -h, --help show this help screen\n");
363 @@ -310,7 +329,7 @@ void usage(enum logcode F)
364 enum {OPT_VERSION = 1000, OPT_SENDER, OPT_EXCLUDE, OPT_EXCLUDE_FROM,
365 OPT_DELETE_AFTER, OPT_DELETE_EXCLUDED, OPT_LINK_DEST,
366 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_MODIFY_WINDOW,
367 - OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_TIMEOUT,
368 + OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_TIMEOUT, OPT_USE_SSL,
369 OPT_REFUSED_BASE = 9000};
371 static struct poptOption long_options[] = {
372 @@ -397,6 +416,13 @@ static struct poptOption long_options[]
373 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
374 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
377 + {"ssl", 0, POPT_ARG_NONE, 0, OPT_USE_SSL, 0, 0},
378 + {"ssl-cert", 0, POPT_ARG_STRING, &ssl_cert_path, OPT_USE_SSL, 0, 0},
379 + {"ssl-key", 0, POPT_ARG_STRING, &ssl_key_path, OPT_USE_SSL, 0, 0},
380 + {"ssl-key-passwd", 0, POPT_ARG_STRING, &ssl_key_passwd, OPT_USE_SSL, 0, 0},
381 + {"ssl-ca-certs", 0, POPT_ARG_STRING, &ssl_ca_path, OPT_USE_SSL, 0, 0},
386 @@ -596,6 +622,12 @@ int parse_arguments(int *argc, const cha
397 /* A large opt value means that set_refuse_options()
398 * turned this option off (opt-BASE is its index). */
399 @@ -733,6 +765,17 @@ int parse_arguments(int *argc, const cha
400 if (do_progress && !verbose)
406 + snprintf(err_buf, sizeof(err_buf),
407 + "Openssl error: %s\n",
415 bwlimit_writemax = (size_t)bwlimit * 128;
416 if (bwlimit_writemax < 512)
417 --- orig/rsync.h 2004-05-16 07:58:12
418 +++ rsync.h 2004-07-03 20:22:28
421 #define DEFAULT_LOCK_FILE "/var/run/rsyncd.lock"
422 #define URL_PREFIX "rsync://"
423 +#define SSL_URL_PREFIX "rsyncs://"
425 #define BACKUP_SUFFIX "~"
427 @@ -326,6 +327,11 @@ enum msgcode {
428 #define uint64 unsigned off_t
432 +#include <openssl/ssl.h>
433 +#include <openssl/err.h>
436 /* Starting from protocol version 26, we always use 64-bit
437 * ino_t and dev_t internally, even if this platform does not
438 * allow files to have 64-bit inums. That's because the
439 --- orig/ssl.c 2004-07-02 21:44:19
440 +++ ssl.c 2004-07-02 21:44:19
442 +/* -*- c-file-style: "linux" -*-
443 + * ssl.c: operations for negotiating SSL rsync connections.
445 + * Copyright (C) 2003 Casey Marshall <rsdio@metastatic.org>
447 + * This program is free software; you can redistribute it and/or modify
448 + * it under the terms of the GNU General Public License as published by
449 + * the Free Software Foundation; either version 2 of the License, or
450 + * (at your option) any later version.
452 + * This program is distributed in the hope that it will be useful,
453 + * but WITHOUT ANY WARRANTY; without even the implied warranty of
454 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
455 + * GNU General Public License for more details.
457 + * You should have received a copy of the GNU General Public License
458 + * along with this program; if not, write to the Free Software
459 + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
464 +#ifdef HAVE_SYS_SELECT_H
465 +#include <sys/select.h>
467 +#include <sys/time.h>
468 +#include <sys/types.h>
473 +#define BUF_SIZE 1024
476 +extern int am_daemon;
477 +extern int am_server;
479 +extern char *ssl_cert_path;
480 +extern char *ssl_key_path;
481 +extern char *ssl_key_passwd;
482 +extern char *ssl_ca_path;
484 +static SSL_CTX *ssl_ctx;
486 +static int tls_read[2] = { -1, -1 };
487 +static int tls_write[2] = { -1, -1 };
488 +static int ssl_running;
489 +static int ssl_pid = -1;
492 + * A non-interactive callback to be passed to SSL_CTX_set_default_password_cb,
493 + * which merely copies the value of ssl_key_passwd into buf. This is
494 + * used for when the private key password is supplied via an option.
496 +static int default_password_cb(char *buf, int n, UNUSED(int f), UNUSED(void *u))
498 + if (ssl_key_passwd == NULL || n < strlen(ssl_key_passwd))
500 + strncpy(buf, ssl_key_passwd, n-1);
501 + return strlen(ssl_key_passwd);
505 + * If verbose, this method traces the status of the SSL handshake.
507 +static void info_callback(SSL *ssl, int cb, int val)
514 + cbs = "SSL_CB_LOOP";
517 + cbs = "SSL_CB_EXIT";
520 + cbs = "SSL_CB_READ";
523 + cbs = "SSL_CB_WRITE";
526 + cbs = "SSL_CB_ALERT";
528 + case SSL_CB_READ_ALERT:
529 + cbs = "SSL_CB_READ_ALERT";
531 + case SSL_CB_WRITE_ALERT:
532 + cbs = "SSL_CB_WRITE_ALERT";
534 + case SSL_CB_ACCEPT_LOOP:
535 + cbs = "SSL_CB_ACCEPT_LOOP";
537 + case SSL_CB_ACCEPT_EXIT:
538 + cbs = "SSL_CB_ACCEPT_EXIT";
540 + case SSL_CB_CONNECT_LOOP:
541 + cbs = "SSL_CB_CONNECT_LOOP";
543 + case SSL_CB_CONNECT_EXIT:
544 + cbs = "SSL_CB_CONNECT_EXIT";
546 + case SSL_CB_HANDSHAKE_START:
547 + cbs = "SSL_CB_HANDSHAKE_START";
549 + case SSL_CB_HANDSHAKE_DONE:
550 + cbs = "SSL_CB_HANDSHAKE_DONE";
553 + snprintf(buf, sizeof buf, "??? (%d)", cb);
558 + rprintf(FLOG, "SSL: info_callback(%p,%s,%d)\n", ssl, cbs, val);
559 + if (cb == SSL_CB_HANDSHAKE_DONE) {
560 + SSL_CIPHER_description(SSL_get_current_cipher(ssl),
562 + rprintf(FLOG, "SSL: cipher: %s", buf);
568 + * Initializes the SSL context for TLSv1 connections; returns zero on
575 + SSL_library_init();
576 + SSL_load_error_strings();
577 + ssl_ctx = SSL_CTX_new(TLSv1_method());
580 + SSL_CTX_set_info_callback(ssl_ctx, info_callback);
582 + /* Sets the certificate sent to the other party. */
583 + if (ssl_cert_path != NULL
584 + && SSL_CTX_use_certificate_file(ssl_ctx, ssl_cert_path,
585 + SSL_FILETYPE_PEM) != 1)
587 + /* Set up the simple non-interactive callback if the password
588 + * was supplied on the command line. */
589 + if (ssl_key_passwd != NULL)
590 + SSL_CTX_set_default_passwd_cb(ssl_ctx, default_password_cb);
591 + /* Sets the private key that matches the public certificate. */
592 + if (ssl_key_path != NULL) {
593 + if (SSL_CTX_use_PrivateKey_file(ssl_ctx, ssl_key_path,
594 + SSL_FILETYPE_PEM) != 1)
596 + if (SSL_CTX_check_private_key(ssl_ctx) != 1)
599 + if (ssl_ca_path != NULL
600 + && !SSL_CTX_load_verify_locations(ssl_ctx, ssl_ca_path, NULL))
607 + * Returns the error string for the current SSL error, if any.
609 +char *get_ssl_error(void)
611 + return ERR_error_string(ERR_get_error(), NULL);
615 + * Returns the input file descriptor for the SSL connection.
617 +int get_tls_rfd(void)
619 + return tls_read[0];
623 + * Returns the output file descriptor for the SSL connection.
625 +int get_tls_wfd(void)
627 + return tls_write[1];
631 + * Signal handler that ends the SSL connection.
633 +static RETSIGTYPE tls_sigusr1(int UNUSED(val))
644 + * Negotiates the TLS connection, creates a socket pair for communicating
645 + * with the rsync process, then forks into a new process that will handle
646 + * the communication.
648 + * 0 is returned on success.
650 +int start_tls(int f_in, int f_out)
654 + unsigned char buf1[BUF_SIZE], buf2[BUF_SIZE];
655 + int avail1 = 0, avail2 = 0, write1 = 0, write2 = 0;
658 + if (fd_pair(tls_read))
660 + if (fd_pair(tls_write))
663 + set_blocking(tls_read[0]);
664 + set_blocking(tls_read[1]);
665 + set_blocking(tls_write[0]);
666 + set_blocking(tls_write[1]);
667 + set_blocking(f_in);
668 + set_blocking(f_out);
670 + ssl_pid = do_fork();
673 + if (ssl_pid != 0) {
674 + close(tls_write[0]);
675 + close(tls_read[1]);
679 + signal(SIGUSR1, tls_sigusr1);
680 + ssl = SSL_new(ssl_ctx);
683 + if (am_daemon || am_server)
684 + SSL_set_accept_state(ssl);
686 + SSL_set_connect_state(ssl);
687 + SSL_set_rfd(ssl, f_in);
688 + SSL_set_wfd(ssl, f_out);
690 + tls_fd = SSL_get_fd(ssl);
692 + n = MAX(tls_read[1], n);
693 + n = MAX(tls_fd, n) + 1;
696 + while (ssl_running) {
699 + FD_SET(tls_write[0], &rd);
700 + FD_SET(tls_read[1], &wd);
701 + FD_SET(tls_fd, &rd);
702 + FD_SET(tls_fd, &wd);
704 + r = select(n, &rd, &wd, NULL, NULL);
706 + if (r == -1 && errno == EINTR)
708 + if (FD_ISSET(tls_write[0], &rd)) {
709 + r = read(tls_write[0], buf1+avail1, BUF_SIZE-avail1);
713 + rprintf(FERROR, "pipe read error: %s\n",
718 + if (FD_ISSET(tls_fd, &rd)) {
719 + r = SSL_read(ssl, buf2+avail2, BUF_SIZE-avail2);
723 + switch (SSL_get_error(ssl, r)) {
724 + case SSL_ERROR_ZERO_RETURN:
726 + case SSL_ERROR_WANT_READ:
727 + case SSL_ERROR_WANT_WRITE:
729 + case SSL_ERROR_SYSCALL:
731 + rprintf(FERROR, "SSL spurious EOF\n");
733 + rprintf(FERROR, "SSL I/O error: %s\n",
736 + case SSL_ERROR_SSL:
737 + rprintf(FERROR, "SSL: %s\n",
738 + ERR_error_string(ERR_get_error(), NULL));
741 + rprintf(FERROR, "unexpected ssl error %d\n", r);
746 + if (FD_ISSET(tls_read[1], &wd) && write2 < avail2) {
747 + r = write(tls_read[1], buf2+write2, avail2-write2);
751 + rprintf(FERROR, "pipe write error: %s\n",
756 + if (FD_ISSET(tls_fd, &wd) && write1 < avail1) {
757 + r = SSL_write(ssl, buf1+write1, avail1-write1);
761 + switch (SSL_get_error(ssl, r)) {
762 + case SSL_ERROR_ZERO_RETURN:
764 + case SSL_ERROR_WANT_READ:
765 + case SSL_ERROR_WANT_WRITE:
767 + case SSL_ERROR_SYSCALL:
769 + rprintf(FERROR, "SSL: spurious EOF\n");
771 + rprintf(FERROR, "SSL: I/O error: %s\n",
774 + case SSL_ERROR_SSL:
775 + rprintf(FERROR, "SSL: %s\n",
776 + ERR_error_string(ERR_get_error(), NULL));
779 + rprintf(FERROR, "unexpected ssl error %d\n", r);
784 + if (avail1 == write1)
785 + avail1 = write1 = 0;
786 + if (avail2 == write2)
787 + avail2 = write2 = 0;
790 + /* XXX I'm pretty sure that there is a lot that I am not considering
791 + here. Bugs? Yes, probably. */
793 + /* We're finished. */
795 + close(tls_read[1]);
796 + close(tls_write[0]);
801 + * Ends the TLS connection.
806 + kill(ssl_pid, SIGUSR1);