autossh/configure.ac @@ -1,4 +1,12 @@ +Version 1.4b + +- add AUTOSSH_MAXLIFETIME (patch from Steven Clark) +- include configure.ac in package +- fix poll flags so not checking for writable when write done (patch + from John Grahor) +- compile time TOUCH_PIDFILE option to touch pid file on connection test. + Version 1.4a - fix up pid file generation (Xander Hudson) autossh/CHANGES @@ -1,8 +1,8 @@ -# $Id: Makefile.in,v 1.3 2006/07/13 14:53:44 harding Exp $ +# $Id: Makefile.in,v 1.4 2007/12/16 06:08:04 harding Exp $ # # @configure_input@ -VER= 1.4a +VER= 1.4b SSH= @path_ssh@ autossh/Makefile.in @@ -163,6 +163,8 @@ The following environment variables can be set: AUTOSSH_DEBUG - sets logging level to LOG_DEBUG, and if the operating system supports it, sets syslog to duplicate log entries to stderr. + AUTOSSH_FIRST_POLL - time to initial poll (default is as + AUTOSSH_POLL below). AUTOSSH_GATETIME - how long ssh must be up before we consider it a successful connection. Default is 30 seconds. If set to 0, then this behaviour @@ -173,6 +175,9 @@ The following environment variables can be set: AUTOSSH_LOGLEVEL - log level, they correspond to the levels used by syslog; so 0-7 with 7 being the chattiest. + AUTOSSH_MAXLIFETIME - Sets the maximum number of seconds the process + should live for before killing off the ssh child + and exiting. AUTOSSH_MAXSTART - specifies how many times ssh should be started. A negative number means no limit on the number of times ssh is started. The default value is -1. @@ -191,7 +196,6 @@ The following environment variables can be set: network timeouts (default 15 seconds) the network timeouts will be adjusted downward to 1/2 the poll time. - AUTOSSH_FIRST_POLL - time to initial poll (default is as above). AUTOSSH_PORT - set monitor port. Mostly in case ssh appropriates -M at some time. But because of this possible use, AUTOSSH_PORT overrides autossh/README @@ -17,7 +17,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: autossh.1,v 1.20 2006/05/21 03:33:00 harding Exp $ +.\" $Id: autossh.1,v 1.21 2008/03/28 16:58:21 harding Exp $ .\" .Dd Jul 20, 2004 .Dt AUTOSSH 1 @@ -211,6 +211,9 @@ way to avoid collisions. If this variable is set, the logging level is set to to LOG_DEBUG, and if the operating system supports it, syslog is set to duplicate log entries to stderr. +.It Ev AUTOSSH_FIRST_POLL +Specifies the time to wait before the first connection test. Thereafter +the general poll time is used (see AUTOSSH_POLL below). .It Ev AUTOSSH_GATETIME Specifies how long ssh must be up before we consider it a successful connection. The default is 30 seconds. Note that if AUTOSSH_GATETIME @@ -224,6 +227,10 @@ so 0-7 with 7 being the chattiest. Specifies that .Nm should use the named log file, rather than syslog. +.It Ev AUTOSSH_MAXLIFETIME +Sets the maximum number of seconds that the program should run. Once +the number of seconds has been passed, the ssh child will be killed +and the program will exit. .It Ev AUTOSSH_MAXSTART Specifies how many times ssh should be started. A negative number means no limit on the number of times ssh is started. The default @@ -245,9 +252,6 @@ Specifies the connection poll time in seconds; default is 600 seconds. If the poll time is less than twice the network timeouts (default 15 seconds) the network timeouts will be adjusted downward to 1/2 the poll time. -.It Ev AUTOSSH_FIRST_POLL -Specifies the time to wait before the first connection test. Thereafter -the general poll time is used (see AUTOSSH_POLL above). .It Ev AUTOSSH_PORT Sets the connection monitoring port. Mostly in case ssh appropriates -M at some time. But because of this possible use, AUTOSSH_PORT autossh/autossh.1 @@ -4,7 +4,7 @@ * * From the example of rstunnel. * - * Copyright (c) Carson Harding, 2002-2006. + * Copyright (c) Carson Harding, 2002-2008. * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -81,7 +81,7 @@ extern char *__progname; char *__progname; #endif -const char *rcsid = "$Id: autossh.c,v 1.75 2006/07/13 14:49:53 harding Exp $"; +const char *rcsid = "$Id: autossh.c,v 1.81 2008/04/04 22:29:58 harding Exp $"; #ifndef SSH_PATH # define SSH_PATH "/usr/bin/ssh" @@ -89,6 +89,7 @@ const char *rcsid = "$Id: autossh.c,v 1.75 2006/07/13 14:49:53 harding Exp $"; #define POLL_TIME 600 /* 10 minutes default */ #define GATE_TIME 30 /* 30 seconds default */ +#define MAX_LIFETIME 0 /* default max lifetime of forever */ #define TIMEO_NET 15000 /* poll on accept() and io (msecs) */ #define MAX_CONN_TRIES 3 /* how many attempts */ #define MAX_START (-1) /* max # of runs; <0 == forever */ @@ -118,10 +119,12 @@ char *env_port; /* port spec'd in environment */ char *echo_message = ""; /* message to append to echo string */ char *pid_file_name; /* path to pid file */ int pid_file_created; /* we have created pid file */ +time_t pid_start_time; /* time autossh process started */ int poll_time = POLL_TIME; /* default connection poll time */ int first_poll_time = POLL_TIME; /* initial connection poll time */ double gate_time = GATE_TIME; /* time to "make it out of the gate" */ int max_start = MAX_START; /* how many times to run (default no limit) */ +double max_lifetime = MAX_LIFETIME; /* how long can the process/daemon live */ int net_timeout = TIMEO_NET; /* timeout on network data */ char *ssh_path = SSH_PATH; /* default path to ssh */ int start_count; /* # of times exec()d ssh */ @@ -169,6 +172,7 @@ void xerrlog(int level, char *fmt, ...) void doerrlog(int level, char *fmt, va_list ap); char *timestr(void); void sig_catch(int sig); +int exceeded_lifetime(void); void usage(int code) @@ -195,50 +199,53 @@ usage(int code) fprintf(stderr, "\n"); fprintf(stderr, "Environment variables are:\n"); fprintf(stderr, - " AUTOSSH_GATETIME " + " AUTOSSH_GATETIME " "- how long must an ssh session be established\n" - " " + " " " before we decide it really was established\n" - " " + " " " (in seconds)\n"); fprintf(stderr, - " AUTOSSH_LOGFILE " + " AUTOSSH_LOGFILE " "- file to log to (default is to use the syslog\n" - " " + " " " facility)\n"); fprintf(stderr, - " AUTOSSH_LOGLEVEL " + " AUTOSSH_LOGLEVEL " "- level of log verbosity\n"); fprintf(stderr, - " AUTOSSH_MAXSTART " + " AUTOSSH_MAXLIFETIME " + "- set the maximum time to live (seconds)\n"); + fprintf(stderr, + " AUTOSSH_MAXSTART " "- max times to restart (default is no limit)\n"); fprintf(stderr, - " AUTOSSH_MESSAGE " + " AUTOSSH_MESSAGE " "- message to append to echo string (max 64 bytes)\n"); #if defined(__CYGWIN__) fprintf(stderr, - " AUTOSSH_NTSERVICE " + " AUTOSSH_NTSERVICE " "- tweak some things for running under cygrunsrv\n"); #endif fprintf(stderr, - " AUTOSSH_PATH " + " AUTOSSH_PATH " "- path to ssh if not default\n"); fprintf(stderr, - " AUTOSSH_PIDFILE " + " AUTOSSH_PIDFILE " "- write pid to this file\n"); fprintf(stderr, - " AUTOSSH_POLL " + " AUTOSSH_POLL " "- how often to check the connection (seconds)\n"); fprintf(stderr, - " AUTOSSH_FIRST_POLL " + " AUTOSSH_FIRST_POLL " "- time before first connection check (seconds)\n"); fprintf(stderr, - " AUTOSSH_PORT " + " AUTOSSH_PORT " "- port to use for monitor connection\n"); fprintf(stderr, - " AUTOSSH_DEBUG " + " AUTOSSH_DEBUG " "- turn logging to maximum verbosity and log to\n" - " " + " " " stderr\n"); fprintf(stderr, "\n"); } @@ -603,7 +610,7 @@ get_env_args(void) if ((s = getenv("AUTOSSH_MAXSTART")) != NULL) { max_start = (int)strtol(s, &t, 0); - if (*s == '\0' || *t != '\0' ) + if (*s == '\0' || max_start < 0 || *t != '\0') xerrlog(LOG_ERR, "invalid max start number \"%s\"", s); } @@ -620,6 +627,33 @@ get_env_args(void) if (*s != '\0') env_port = s; + if ((s = getenv("AUTOSSH_MAXLIFETIME")) != NULL) { + max_lifetime = (double)strtoul(s, &t, 0); + if (*s == '\0' || *t != '\0' ) + xerrlog(LOG_ERR, + "invalid max lifetime \"%s\"", s); + /* can't really be < 0, as converted as unsigned long */ + if (max_lifetime <= 0 ) + max_lifetime = MAX_LIFETIME; + else { + if (poll_time > max_lifetime) { + errlog( LOG_INFO, + "poll time is greater then lifetime," + " dropping poll time to %.0f", max_lifetime ); + poll_time = max_lifetime; + } + + if (first_poll_time > max_lifetime) { + errlog( LOG_INFO, + "first poll time is greater then lifetime," + " dropping first poll time to %.0f", max_lifetime ); + first_poll_time = max_lifetime; + } + + time(&pid_start_time); + } + } + if ((s = getenv("AUTOSSH_PIDFILE")) != NULL) if (*s != '\0') pid_file_name = s; @@ -679,6 +713,8 @@ ssh_run(int sock, char **av) srandom(getpid() ^ tv.tv_usec ^ tv.tv_sec); while (max_start < 0 || start_count < max_start) { + if (exceeded_lifetime()) + return; restart_ssh = 0; start_count++; grace_time(start_time); @@ -726,6 +762,8 @@ ssh_watch(int sock) int val; static int secs_left; int my_poll_time = first_poll_time; + time_t now; + double secs_to_shutdown; #if defined(HAVE_SETPROCTITLE) setproctitle("parent of %d (%d)", @@ -753,8 +791,16 @@ ssh_watch(int sock) secs_left = alarm(0); if (secs_left == 0) secs_left = my_poll_time; + my_poll_time = poll_time; + if (max_lifetime != 0) { + time(&now); + secs_to_shutdown = max_lifetime - difftime(now,pid_start_time); + if (secs_to_shutdown < poll_time) + secs_left = secs_to_shutdown; + } + errlog(LOG_DEBUG, "set alarm for %d secs", secs_left); @@ -775,6 +821,11 @@ ssh_watch(int sock) return P_EXIT; break; case SIGALRM: + if (exceeded_lifetime()) { + ssh_kill(); + return P_EXIT; + } + if (writep && sock != -1 && !conn_test(sock, mhost, writep)) { errlog(LOG_INFO, @@ -782,6 +833,19 @@ ssh_watch(int sock) ssh_kill(); return P_RESTART; } +#ifdef TOUCH_PIDFILE + /* + * utimes() with a NULL time argument sets + * file access and modification times to + * the current time + */ + if (pid_file_name && + utimes(pid_file_name, NULL) != 0) { + errlog(LOG_ERR, + "could not touch pid file: %s", + strerror(errno)); + } +#endif break; default: break; @@ -791,6 +855,27 @@ ssh_watch(int sock) } /* + * Checks to see if we have exceeded our time to live + * Returns 1 if we have, 0 if we haven't + */ +int +exceeded_lifetime(void) +{ + time_t now; + + if (max_lifetime > 0 ) { + time(&now); + if (difftime(now, pid_start_time) >= max_lifetime ) { + errlog(LOG_INFO, + "exceeded maximum time to live, shutting down"); + return 1; + } + } + + return 0; +} + +/* * Wait on child: with options == WNOHANG, poll for * dead child, else if options == 0, then wait for * known dead child. @@ -1258,8 +1343,16 @@ conn_send_and_receive(char *rp, char *wp, size_t len, wp += nwrite; } /* if complete, turn off polling for write */ - if (wleft == 0) + if (wleft == 0) { ntopoll = 1; + /* + * if we are reading and writing to the + * same fd then we must clear the write bit + * so that poll doesn't loop tight. + */ + if (iwr == ird) + pfd[ird].events = POLLIN; + } } if (pfd[ird].revents & POLLIN || pfd[ird].revents & POLLHUP) { autossh/autossh.c @@ -1,6 +1,6 @@ Summary: Automatically restart SSH sessions and tunnels Name: autossh -Version: 1.4 +Version: 1.4b Release: 1 License: Distributable Group: Applications/Networking @@ -38,6 +38,9 @@ rm -rf $RPM_BUILD_ROOT %{_mandir}/man1/* %changelog +* Fri Mar 28 2008 Carson Harding <harding@motd.ca> +- update to 1.4b + * Sat May 20 2006 Carson Harding <harding@motd.ca> - update to 1.4 and use autoconf autossh/autossh.spec e5a68b00d9e2816a402e14f2cf39ec24f4236310 Ryan Tomayko rtomayko@gmail.com http://github.com/rtomayko/hem/commit/7d8e2057bc3697af467ba7fb03f178c13ad71083 7d8e2057bc3697af467ba7fb03f178c13ad71083 2009-02-26T02:33:16-08:00 2009-02-26T02:33:16-08:00 bring in autossh-1.4b 7fbdbd3ae2dacc8fa54e9fc52703f355e59e805f Ryan Tomayko rtomayko@gmail.com