@@ -30,6 +30,12 @@
"too complicated", using `--peer-fingerprint` makes TLS mode about as easy as
using `--secret`.
+* **`replay-persist` has been removed**
+
+ This feature has been removed as it was never properly implemented for
+ server mode and generally was a niche feature. If the option is present
+ it will be ignored.
+
## Maintainer-visible changes
- The configure-time option `--enable-debug` is no longer available
@@ -285,9 +285,6 @@
/* Define to 1 if you have the <sys/epoll.h> header file. */
#cmakedefine HAVE_SYS_EPOLL_H
-/* Define to 1 if you have the <sys/file.h> header file. */
-#undef HAVE_SYS_FILE_H
-
/* Define to 1 if you have the <sys/inotify.h> header file. */
#cmakedefine HAVE_SYS_INOTIFY_H
@@ -453,7 +453,7 @@
])
AC_CHECK_HEADERS([ \
sys/time.h sys/ioctl.h sys/stat.h \
- sys/mman.h sys/file.h sys/wait.h \
+ sys/mman.h sys/wait.h \
libgen.h stropts.h \
syslog.h pwd.h grp.h \
sys/sockio.h sys/uio.h \
@@ -561,8 +561,7 @@
AC_CHECK_FUNCS([ \
daemon chroot getpwnam setuid nice dup dup2 \
syslog openlog mlockall getrlimit getgrnam setgid \
- setgroups flock gettimeofday \
- setsid chdir \
+ setgroups gettimeofday setsid chdir \
chsize ftruncate execve getpeereid basename dirname \
epoll_create strlcpy strsep strtok_r \
])
@@ -440,19 +440,6 @@
physical IP layer. The problem is easily fixed by simply using TCP as
the VPN transport layer.
---replay-persist file
- Persist replay-protection state across sessions using ``file`` to save
- and reload the state.
-
- This option will keep a disk copy of the current replay protection state
- (i.e. the most recent packet timestamp and sequence number received from
- the remote peer), so that if an OpenVPN session is stopped and
- restarted, it will reject any replays of packets which were already
- received by the prior session.
-
- This option only makes sense when replay protection is enabled (the
- default) and you are using TLS mode with ``--tls-auth``.
-
--session-timeout n
Raises :code:`SIGTERM` for the client instance after ``n`` seconds since
the beginning of the session, forcing OpenVPN to disconnect.
@@ -370,10 +370,7 @@
level has had a chance to authenticate the peer. The result is that
packets without the correct signature can be dropped immediately upon
reception, before they have a chance to consume additional system
- resources such as by initiating a TLS handshake. ``--tls-auth`` can be
- strengthened by adding the ``--replay-persist`` option which will keep
- OpenVPN's replay protection state in a file so that it is not lost
- across restarts.
+ resources such as by initiating a TLS handshake.
It should be emphasized that this feature is optional and that the key
file used with ``--tls-auth`` gives a peer nothing more than the power
@@ -79,3 +79,8 @@
--allow-deprecated-insecure-static-crypto
Removed in OpenVPN 2.8 as --secret was also removed.
+
+--replay-persist
+ Removed in OpenVPN 2.8. This option never really worked well with ``--server``
+ and the usefulness of this option in p2p setups is not very high either.
+ It is now ignored if present in the configuration file.
@@ -312,9 +312,6 @@
ce->tls_crypt_v2_file, R_OK, "--tls-crypt-v2");
}
- errs |= check_file_access(CHKACC_DIRPATH | CHKACC_FILEXSTWR, options->packet_id_file,
- R_OK | W_OK, "--replay-persist");
-
/* ** Password files ** */
errs |= check_file_access(CHKACC_FILE | CHKACC_ACPTSTDIN | CHKACC_PRIVATE,
options->key_pass_file, R_OK, "--askpass");
@@ -403,10 +403,6 @@
if (packet_id_test(recv, pin))
{
packet_id_add(recv, pin);
- if (opt->pid_persist && (opt->flags & CO_PACKET_ID_LONG_FORM))
- {
- packet_id_persist_save_obj(opt->pid_persist, &opt->packet_id);
- }
ret = true;
}
else
@@ -339,11 +339,6 @@
* The packet id also used as the IV
* for AEAD/OFB/CFG ciphers.
*/
- struct packet_id_persist *pid_persist;
- /**< Persistent packet ID state for
- * keeping state between successive
- * OpenVPN process startups. */
-
#define CO_PACKET_ID_LONG_FORM (1u << 0)
/**< Bit-flag indicating whether to use
* OpenVPN's long packet ID format. */
@@ -64,7 +64,6 @@
#define D_MULTI_ERRORS LOGLEV(1, 9, M_NONFATAL) /* show multi-client server errors */
#define D_EVENT_ERRORS LOGLEV(1, 10, M_NONFATAL) /* show event.[ch] errors */
#define D_PUSH_ERRORS LOGLEV(1, 11, M_NONFATAL) /* show push/pull errors */
-#define D_PID_PERSIST LOGLEV(1, 12, M_NONFATAL) /* show packet_id persist errors */
#define D_FRAG_ERRORS LOGLEV(1, 13, M_NONFATAL) /* show fragmentation errors */
#define D_ALIGN_ERRORS LOGLEV(1, 14, M_NONFATAL) /* show bad struct alignments */
@@ -161,16 +160,15 @@
#define D_EVENT_WAIT LOGLEV(8, 70, M_DEBUG) /* show detailed info from event waits */
#define D_MULTI_TCP LOGLEV(8, 70, M_DEBUG) /* show debug info from mtcp.c */
-#define D_TLS_DEBUG LOGLEV(9, 70, M_DEBUG) /* show detailed info from TLS routines */
-#define D_COMP LOGLEV(9, 70, M_DEBUG) /* show compression info */
-#define D_READ_WRITE LOGLEV(9, 70, M_DEBUG) /* show all tun/tcp/udp reads/writes/opens */
-#define D_PACKET_CONTENT LOGLEV(9, 70, M_DEBUG) /* show before/after encryption packet content */
-#define D_TLS_NO_SEND_KEY LOGLEV(9, 70, M_DEBUG) /* show when no data channel send-key exists */
-#define D_PID_PERSIST_DEBUG LOGLEV(9, 70, M_DEBUG) /* show packet-id persist debugging info */
-#define D_LINK_RW_VERBOSE LOGLEV(9, 70, M_DEBUG) /* increase link reads/writes verbosity */
-#define D_STREAM_DEBUG LOGLEV(9, 70, M_DEBUG) /* show TCP stream debug info */
-#define D_WIN32_IO LOGLEV(9, 70, M_DEBUG) /* win32 I/O debugging info */
-#define D_PKCS11_DEBUG LOGLEV(9, 70, M_DEBUG) /* show PKCS#11 debugging */
+#define D_TLS_DEBUG LOGLEV(9, 70, M_DEBUG) /* show detailed info from TLS routines */
+#define D_COMP LOGLEV(9, 70, M_DEBUG) /* show compression info */
+#define D_READ_WRITE LOGLEV(9, 70, M_DEBUG) /* show all tun/tcp/udp reads/writes/opens */
+#define D_PACKET_CONTENT LOGLEV(9, 70, M_DEBUG) /* show before/after encryption packet content */
+#define D_TLS_NO_SEND_KEY LOGLEV(9, 70, M_DEBUG) /* show when no data channel send-key exists */
+#define D_LINK_RW_VERBOSE LOGLEV(9, 70, M_DEBUG) /* increase link reads/writes verbosity */
+#define D_STREAM_DEBUG LOGLEV(9, 70, M_DEBUG) /* show TCP stream debug info */
+#define D_WIN32_IO LOGLEV(9, 70, M_DEBUG) /* win32 I/O debugging info */
+#define D_PKCS11_DEBUG LOGLEV(9, 70, M_DEBUG) /* show PKCS#11 debugging */
#define D_SHAPER_DEBUG LOGLEV(10, 70, M_DEBUG) /* show traffic shaper info */
@@ -744,14 +744,6 @@
static void
process_coarse_timers(struct context *c)
{
- /* flush current packet-id to file once per 60
- * seconds if --replay-persist was specified */
- if (packet_id_persist_enabled(&c->c1.pid_persist)
- && event_timeout_trigger(&c->c2.packet_id_persist_interval, &c->c2.timeval, ETT_DEFAULT))
- {
- packet_id_persist_save(&c->c1.pid_persist);
- }
-
/* Should we write timer-triggered status file */
if (c->c1.status_output
&& event_timeout_trigger(&c->c1.status_output->et, &c->c2.timeval, ETT_DEFAULT))
@@ -66,7 +66,6 @@
/*
* Crypto initialization flags
*/
-#define CF_LOAD_PERSISTED_PACKET_ID (1 << 0)
#define CF_INIT_TLS_MULTI (1 << 1)
#define CF_INIT_TLS_AUTH_STANDALONE (1 << 2)
@@ -741,8 +740,6 @@
{
context_clear_1(c);
- packet_id_persist_init(&c->c1.pid_persist);
-
init_connection_list(c);
c->c1.link_sockets_num = c->options.ce.local_list->len;
@@ -1350,12 +1347,6 @@
now);
}
- /* initialize packet_id persistence timer */
- if (c->options.packet_id_file)
- {
- event_timeout_init(&c->c2.packet_id_persist_interval, 60, now);
- }
-
/* initialize tmp_int optimization that limits the number of times we call
* tls_multi_process in the main event loop */
interval_init(&c->c2.tmp_int, TLS_MULTI_HORIZON, TLS_MULTI_REFRESH);
@@ -2955,31 +2946,15 @@
}
static void
-init_crypto_pre(struct context *c, const unsigned int flags)
-{
- if (c->options.engine)
- {
- crypto_init_lib_engine(c->options.engine);
- }
-
- if (flags & CF_LOAD_PERSISTED_PACKET_ID)
- {
- /* load a persisted packet-id for cross-session replay-protection */
- if (c->options.packet_id_file)
- {
- packet_id_persist_load(&c->c1.pid_persist, c->options.packet_id_file);
- }
- }
-}
-
-
-static void
do_init_crypto_test(struct context *c)
{
const struct options *options = &c->options;
ASSERT(options->test_crypto);
- init_crypto_pre(c, 0);
+ if (c->options.engine)
+ {
+ crypto_init_lib_engine(c->options.engine);
+ }
c->c2.crypto_options.flags |= CO_PACKET_ID_LONG_FORM;
@@ -3180,7 +3155,10 @@
ASSERT(options->tls_server || options->tls_client);
ASSERT(!options->test_crypto);
- init_crypto_pre(c, flags);
+ if (c->options.engine)
+ {
+ crypto_init_lib_engine(c->options.engine);
+ }
/* Make sure we are either a TLS client or server but not both */
ASSERT(options->tls_server == !options->tls_client);
@@ -3358,7 +3336,6 @@
if (to.tls_wrap.mode == TLS_WRAP_AUTH || to.tls_wrap.mode == TLS_WRAP_CRYPT)
{
to.tls_wrap.opt.key_ctx_bi = c->c1.ks.tls_wrap_key;
- to.tls_wrap.opt.pid_persist = &c->c1.pid_persist;
to.tls_wrap.opt.flags |= CO_PACKET_ID_LONG_FORM;
to.tls_wrap.original_wrap_keydata = c->c1.ks.original_wrap_keydata;
}
@@ -3917,11 +3894,6 @@
do_close_packet_id(struct context *c)
{
packet_id_free(&c->c2.crypto_options.packet_id);
- packet_id_persist_save(&c->c1.pid_persist);
- if (!(c->sig->signal_received == SIGUSR1))
- {
- packet_id_persist_close(&c->c1.pid_persist);
- }
}
#ifdef ENABLE_FRAGMENT
@@ -4457,7 +4429,7 @@
}
else if (c->mode == CM_P2P)
{
- crypto_flags = CF_LOAD_PERSISTED_PACKET_ID | CF_INIT_TLS_MULTI;
+ crypto_flags = CF_INIT_TLS_MULTI;
}
else if (child)
{
@@ -4715,7 +4687,6 @@
ALLOC_OBJ_CLEAR_GC(dest->sig, struct signal_info, &dest->gc);
/* c1 init */
- packet_id_persist_init(&dest->c1.pid_persist);
dest->c1.link_sockets_num = 1;
do_link_socket_addr_new(dest);
@@ -75,21 +75,6 @@
};
/*
- * struct packet_id_persist should be empty if we are not
- * building with crypto.
- */
-#ifndef PACKET_ID_H
-struct packet_id_persist
-{
- int dummy;
-};
-static inline void
-packet_id_persist_init(struct packet_id_persist *p)
-{
-}
-#endif
-
-/*
* Packet processing buffers.
*/
struct context_buffers
@@ -167,9 +152,6 @@
/* preresolved and cached host names */
struct cached_dns_entry *dns_cache;
- /* persist crypto sequence number to/from file */
- struct packet_id_persist pid_persist;
-
struct tuntap *tuntap; /**< Tun/tap virtual network interface. */
bool tuntap_owned; /**< Whether the tun/tap interface should
* be cleaned up when this %context is
@@ -352,8 +334,6 @@
* Channel Crypto module\endlink to
* process data channel packet. */
- struct event_timeout packet_id_persist_interval;
-
#ifdef USE_COMP
struct compress_context *comp_context;
/**< Compression context used by the
@@ -573,8 +573,6 @@
"--replay-window n [t] : Use a replay protection sliding window of size n\n"
" and a time window of t seconds.\n"
" Default n=%d t=%d\n"
- "--replay-persist file : Persist replay-protection state across sessions\n"
- " using file.\n"
"--test-crypto : Run a self-test of crypto features enabled.\n"
" For debugging only.\n"
"\n"
@@ -7047,7 +7045,7 @@
else if (streq(p[0], "replay-persist") && p[1] && !p[2])
{
VERIFY_PERMISSION(OPT_P_GENERAL);
- options->packet_id_file = p[1];
+ msg(M_WARN, "DEPRECATED OPTION: --replay-persist option ignored.");
}
else if (streq(p[0], "test-crypto") && !p[1])
{
@@ -582,7 +582,6 @@
bool mute_replay_warnings;
int replay_window;
int replay_time;
- const char *packet_id_file;
bool test_crypto;
/* TLS (control channel) parms */
@@ -501,7 +501,6 @@
SHOW_BOOL(mute_replay_warnings);
SHOW_INT(replay_window);
SHOW_INT(replay_time);
- SHOW_STR(packet_id_file);
SHOW_BOOL(test_crypto);
SHOW_BOOL(tls_server);
@@ -426,146 +426,6 @@
return BSTR(&out);
}
-/* initialize the packet_id_persist structure in a disabled state */
-void
-packet_id_persist_init(struct packet_id_persist *p)
-{
- p->filename = NULL;
- p->fd = -1;
- p->time = p->time_last_written = 0;
- p->id = p->id_last_written = 0;
-}
-
-/* close the file descriptor if it is open, and switch to disabled state */
-void
-packet_id_persist_close(struct packet_id_persist *p)
-{
- if (packet_id_persist_enabled(p))
- {
- if (close(p->fd))
- {
- msg(D_PID_PERSIST | M_ERRNO, "Close error on --replay-persist file %s", p->filename);
- }
- packet_id_persist_init(p);
- }
-}
-
-/* load persisted rec packet_id (time and id) only once from file, and set state to enabled */
-void
-packet_id_persist_load(struct packet_id_persist *p, const char *filename)
-{
- struct gc_arena gc = gc_new();
- if (!packet_id_persist_enabled(p))
- {
- /* open packet-id persist file for both read and write */
- p->fd = platform_open(filename, O_CREAT | O_RDWR | O_BINARY, S_IRUSR | S_IWUSR);
- if (p->fd == -1)
- {
- msg(D_PID_PERSIST | M_ERRNO, "Cannot open --replay-persist file %s for read/write",
- filename);
- }
- else
- {
- struct packet_id_persist_file_image image;
- ssize_t n;
-
-#if defined(HAVE_FLOCK) && defined(LOCK_EX) && defined(LOCK_NB)
- if (flock(p->fd, LOCK_EX | LOCK_NB))
- {
- msg(M_ERR, "Cannot obtain exclusive lock on --replay-persist file %s", filename);
- }
-#endif
-
- p->filename = filename;
- n = read(p->fd, &image, sizeof(image));
- if (n == sizeof(image))
- {
- p->time = p->time_last_written = image.time;
- p->id = p->id_last_written = image.id;
- dmsg(D_PID_PERSIST_DEBUG, "PID Persist Read from %s: %s", p->filename,
- packet_id_persist_print(p, &gc));
- }
- else if (n == -1)
- {
- msg(D_PID_PERSIST | M_ERRNO, "Read error on --replay-persist file %s", p->filename);
- }
- }
- }
- gc_free(&gc);
-}
-
-/* save persisted rec packet_id (time and id) to file (only if enabled state) */
-void
-packet_id_persist_save(struct packet_id_persist *p)
-{
- if (packet_id_persist_enabled(p) && p->time
- && (p->time != p->time_last_written || p->id != p->id_last_written))
- {
- struct packet_id_persist_file_image image;
- CLEAR(image);
- off_t seek_ret;
- struct gc_arena gc = gc_new();
-
- image.time = p->time;
- image.id = p->id;
- seek_ret = lseek(p->fd, (off_t)0, SEEK_SET);
- if (seek_ret == (off_t)0)
- {
- const ssize_t n = write(p->fd, &image, sizeof(image));
- if (n == sizeof(image))
- {
- p->time_last_written = p->time;
- p->id_last_written = p->id;
- dmsg(D_PID_PERSIST_DEBUG, "PID Persist Write to %s: %s", p->filename,
- packet_id_persist_print(p, &gc));
- }
- else
- {
- msg(D_PID_PERSIST | M_ERRNO, "Cannot write to --replay-persist file %s",
- p->filename);
- }
- }
- else
- {
- msg(D_PID_PERSIST | M_ERRNO, "Cannot seek to beginning of --replay-persist file %s",
- p->filename);
- }
- gc_free(&gc);
- }
-}
-
-/* transfer packet_id_persist -> packet_id */
-void
-packet_id_persist_load_obj(const struct packet_id_persist *p, struct packet_id *pid)
-{
- if (p && pid && packet_id_persist_enabled(p) && p->time)
- {
- pid->rec.time = p->time;
- pid->rec.id = p->id;
- }
-}
-
-const char *
-packet_id_persist_print(const struct packet_id_persist *p, struct gc_arena *gc)
-{
- struct buffer out = alloc_buf_gc(256, gc);
-
- buf_printf(&out, "[");
-
- if (packet_id_persist_enabled(p))
- {
- buf_printf(&out, " #" packet_id_format, (packet_id_print_type)p->id);
- if (p->time)
- {
- buf_printf(&out, " / time = (" packet_id_format ") %s", (packet_id_print_type)p->time,
- time_string(p->time, 0, false, gc));
- }
- }
-
- buf_printf(&out, " ]");
- return (char *)out.data;
-}
-
#ifndef ENABLE_SMALL
static void
@@ -125,26 +125,6 @@
};
/*
- * file to facilitate cross-session persistence
- * of time/id
- */
-struct packet_id_persist
-{
- const char *filename;
- int fd;
- time_t time; /* time stamp */
- packet_id_type id; /* sequence number */
- time_t time_last_written;
- packet_id_type id_last_written;
-};
-
-struct packet_id_persist_file_image
-{
- time_t time; /* time stamp */
- packet_id_type id; /* sequence number */
-};
-
-/*
* Keep a record of our current packet-id state
* on the sending side.
*/
@@ -222,28 +202,6 @@
void packet_id_reap(struct packet_id_rec *p);
/*
- * packet ID persistence
- */
-
-/* initialize the packet_id_persist structure in a disabled state */
-void packet_id_persist_init(struct packet_id_persist *p);
-
-/* close the file descriptor if it is open, and switch to disabled state */
-void packet_id_persist_close(struct packet_id_persist *p);
-
-/* load persisted rec packet_id (time and id) only once from file, and set state to enabled */
-void packet_id_persist_load(struct packet_id_persist *p, const char *filename);
-
-/* save persisted rec packet_id (time and id) to file (only if enabled state) */
-void packet_id_persist_save(struct packet_id_persist *p);
-
-/* transfer packet_id_persist -> packet_id */
-void packet_id_persist_load_obj(const struct packet_id_persist *p, struct packet_id *pid);
-
-/* return an ascii string representing a packet_id_persist object */
-const char *packet_id_persist_print(const struct packet_id_persist *p, struct gc_arena *gc);
-
-/*
* Read/write a packet ID to/from the buffer. Short form is sequence number
* only. Long form is sequence number and timestamp.
*/
@@ -273,27 +231,6 @@
return pid->rec.initialized;
}
-/* are we in enabled state? */
-static inline bool
-packet_id_persist_enabled(const struct packet_id_persist *p)
-{
- return p->fd >= 0;
-}
-
-/* transfer packet_id -> packet_id_persist
- Note: Only supported for non-epoch format (i.e. 32bit ID, not 64bit format),
- must be enforced at the caller.
- */
-static inline void
-packet_id_persist_save_obj(struct packet_id_persist *p, const struct packet_id *pid)
-{
- if (packet_id_persist_enabled(p) && pid->rec.time && pid->rec.id <= PACKET_ID_MAX)
- {
- p->time = pid->rec.time;
- p->id = (packet_id_type)pid->rec.id;
- }
-}
-
/**
* Reset the current send packet id to its initial state.
* Use very carefully (e.g. in the standalone reset packet context) to
@@ -878,8 +878,6 @@
packet_id_init(&ks->crypto_options.packet_id, session->opt->replay_window,
session->opt->replay_time, "SSL", ks->key_id);
- ks->crypto_options.pid_persist = NULL;
-
#ifdef ENABLE_MANAGEMENT
ks->mda_key_id = session->opt->mda_context->mda_key_id_counter++;
#endif
@@ -1037,9 +1035,6 @@
session->tls_wrap.opt.packet_id.send.id = EARLY_NEG_START;
}
- /* load most recent packet-id to replay protect on --tls-auth */
- packet_id_persist_load_obj(session->tls_wrap.opt.pid_persist, &session->tls_wrap.opt.packet_id);
-
key_state_init(session, &session->key[KS_PRIMARY]);
dmsg(D_TLS_DEBUG, "TLS: tls_session_init: new session object, sid=%s",
@@ -127,10 +127,6 @@
#include <fcntl.h>
#endif
-#ifdef HAVE_SYS_FILE_H
-#include <sys/file.h>
-#endif
-
/* These headers belong to C99 and should be always be present */
#include <stdlib.h>
#include <inttypes.h>
@@ -109,7 +109,6 @@
session->tls_wrap_reneg.mode = TLS_WRAP_CRYPT;
session->tls_wrap_reneg.cleanup_key_ctx = true;
session->tls_wrap_reneg.work = alloc_buf(BUF_SIZE(&session->opt->frame));
- session->tls_wrap_reneg.opt.pid_persist = NULL;
packet_id_init(&session->tls_wrap_reneg.opt.packet_id, session->opt->replay_window,
session->opt->replay_time, "TLS_WRAP_RENEG", session->key_id);