util: add CloseLog routine to close the server log
[openafs.git] / src / util / serverLog.c
index 7730807..5a6207b 100644 (file)
 
 #include <afsconfig.h>
 #include <afs/param.h>
+#include <afs/stds.h>
 
-
-#include <stdio.h>
-#ifdef AFS_NT40_ENV
-#include <io.h>
-#include <time.h>
-#else
-#ifdef AFS_AIX_ENV
-#include <time.h>
-#endif
-#include <sys/param.h>
-#include <sys/time.h>
-#include <syslog.h>
-#endif
 #include <afs/procmgmt.h>      /* signal(), kill(), wait(), etc. */
-#include <fcntl.h>
-#include <afs/stds.h>
-#include <stdlib.h>
-#include <string.h>
-#include <sys/stat.h>
+
+#include <roken.h>             /* Must come after procmgmt.h */
+#include <afs/opr.h>
 #include "afsutil.h"
 #include "fileutil.h"
 #include <lwp.h>
-#ifdef HAVE_STDINT_H
-# include <stdint.h>
-#endif
+
 #if defined(AFS_PTHREAD_ENV)
-#include <afs/afs_assert.h>
-/* can't include rx when we are libutil; it's too early */
-#include <rx/rx.h>
 #include <pthread.h>
 static pthread_mutex_t serverLogMutex;
-#define LOCK_SERVERLOG() MUTEX_ENTER(&serverLogMutex)
-#define UNLOCK_SERVERLOG() MUTEX_EXIT(&serverLogMutex)
+#define LOCK_SERVERLOG() opr_Verify(pthread_mutex_lock(&serverLogMutex) == 0)
+#define UNLOCK_SERVERLOG() opr_Verify(pthread_mutex_unlock(&serverLogMutex) == 0)
 
 #ifdef AFS_NT40_ENV
 #define NULLDEV "NUL"
@@ -84,7 +65,6 @@ int serverLogSyslogFacility = LOG_DAEMON;
 char *serverLogSyslogTag = 0;
 #endif
 
-#include <stdarg.h>
 int LogLevel;
 int mrafsStyleLogs = 0;
 static int threadIdLogs = 0;
@@ -101,8 +81,10 @@ void
 WriteLogBuffer(char *buf, afs_uint32 len)
 {
     LOCK_SERVERLOG();
-    if (serverLogFD > 0)
-       (void)write(serverLogFD, buf, len);
+    if (serverLogFD > 0) {
+       if (write(serverLogFD, buf, len) < 0)
+           ; /* don't care */
+    }
     UNLOCK_SERVERLOG();
 }
 
@@ -116,28 +98,27 @@ void
 vFSLog(const char *format, va_list args)
 {
     time_t currenttime;
-    char *timeStamp;
     char tbuffer[1024];
     char *info;
     size_t len;
+    struct tm tm;
     int num;
 
-    currenttime = time(0);
-    timeStamp = afs_ctime(&currenttime, tbuffer, sizeof(tbuffer));
-    timeStamp[24] = ' ';       /* ts[24] is the newline, 25 is the null */
-    info = &timeStamp[25];
+    currenttime = time(NULL);
+    len = strftime(tbuffer, sizeof(tbuffer), "%a %b %d %H:%M:%S %Y ",
+                  localtime_r(&currenttime, &tm));
+    info = &tbuffer[len];
 
     if (mrafsStyleLogs || threadIdLogs) {
        num = (*threadNumProgram) ();
         if (num > -1) {
-       (void)afs_snprintf(info, (sizeof tbuffer) - strlen(tbuffer), "[%d] ",
-                          num);
-       info += strlen(info);
-    }
+           snprintf(info, (sizeof tbuffer) - strlen(tbuffer), "[%d] ",
+                    num);
+           info += strlen(info);
+       }
     }
 
-    (void)afs_vsnprintf(info, (sizeof tbuffer) - strlen(tbuffer), format,
-                       args);
+    vsnprintf(info, (sizeof tbuffer) - strlen(tbuffer), format, args);
 
     len = strlen(tbuffer);
     LOCK_SERVERLOG();
@@ -146,8 +127,10 @@ vFSLog(const char *format, va_list args)
        syslog(LOG_INFO, "%s", info);
     } else
 #endif
-    if (serverLogFD > 0)
-       (void)write(serverLogFD, tbuffer, len);
+    if (serverLogFD > 0) {
+       if (write(serverLogFD, tbuffer, len) < 0)
+           ; /* don't care */
+    }
     UNLOCK_SERVERLOG();
 
 #if !defined(AFS_PTHREAD_ENV) && !defined(AFS_NT40_ENV)
@@ -178,6 +161,8 @@ LogCommandLine(int argc, char **argv, const char *progname,
     int i, l;
     char *commandLine, *cx;
 
+    opr_Assert(argc > 0);
+
     for (l = i = 0; i < argc; i++)
        l += strlen(argv[i]) + 1;
     if ((commandLine = malloc(l))) {
@@ -197,6 +182,19 @@ LogCommandLine(int argc, char **argv, const char *progname,
     }
 }
 
+void
+LogDesWarning(void)
+{
+    /* The blank newlines help this stand out a bit more in the log. */
+    ViceLog(0, ("\n"));
+    ViceLog(0, ("WARNING: You are using single-DES keys in a KeyFile. Using single-DES\n"));
+    ViceLog(0, ("WARNING: long-term keys is considered insecure, and it is strongly\n"));
+    ViceLog(0, ("WARNING: recommended that you migrate to stronger encryption. See\n"));
+    ViceLog(0, ("WARNING: OPENAFS-SA-2013-003 on http://www.openafs.org/security/\n"));
+    ViceLog(0, ("WARNING: for details.\n"));
+    ViceLog(0, ("\n"));
+}
+
 static void*
 DebugOn(void *param)
 {
@@ -310,7 +308,7 @@ OpenLog(const char *fileName)
     if (mrafsStyleLogs) {
         time_t t;
        struct stat buf;
-       FT_GetTimeOfDay(&Start, 0);
+       gettimeofday(&Start, NULL);
         t = Start.tv_sec;
        TimeFields = localtime(&t);
        if (fileName) {
@@ -318,18 +316,18 @@ OpenLog(const char *fileName)
                strcpy((char *)&ourName, (char *)fileName);
        }
     makefilename:
-       afs_snprintf(FileName, MAXPATHLEN, "%s.%d%02d%02d%02d%02d%02d",
-                    ourName, TimeFields->tm_year + 1900,
-                    TimeFields->tm_mon + 1, TimeFields->tm_mday,
-                    TimeFields->tm_hour, TimeFields->tm_min,
-                    TimeFields->tm_sec);
+       snprintf(FileName, MAXPATHLEN, "%s.%d%02d%02d%02d%02d%02d",
+                ourName, TimeFields->tm_year + 1900,
+                TimeFields->tm_mon + 1, TimeFields->tm_mday,
+                TimeFields->tm_hour, TimeFields->tm_min,
+                TimeFields->tm_sec);
        if(lstat(FileName, &buf) == 0) {
            /* avoid clobbering a log */
            TimeFields->tm_sec++;
            goto makefilename;
        }
        if (!isfifo)
-           renamefile(fileName, FileName);     /* don't check error code */
+           rk_rename(fileName, FileName);      /* don't check error code */
        tempfd = open(fileName, O_WRONLY | O_TRUNC | O_CREAT | (isfifo?O_NONBLOCK:0), 0666);
     } else {
        strcpy(oldName, fileName);
@@ -337,8 +335,8 @@ OpenLog(const char *fileName)
 
        /* don't check error */
        if (!isfifo)
-           renamefile(fileName, oldName);
-       tempfd = open(fileName, O_WRONLY | O_TRUNC | O_CREAT | (isfifo?O_NONBLOCK:0), 0666);
+           rk_rename(fileName, oldName);
+       tempfd = open(fileName, O_WRONLY | O_TRUNC | O_CREAT | O_APPEND | (isfifo?O_NONBLOCK:0), 0666);
     }
 
     if (tempfd < 0) {
@@ -346,16 +344,18 @@ OpenLog(const char *fileName)
        return -1;
     }
     /* redirect stdout and stderr so random printf's don't write to data */
-    (void)freopen(fileName, "a", stdout);
-    (void)freopen(fileName, "a", stderr);
+    if (freopen(fileName, "a", stdout) == NULL)
+       ; /* don't care */
+    if (freopen(fileName, "a", stderr) != NULL) {
 #ifdef HAVE_SETVBUF
-    setvbuf(stderr, NULL, _IONBF, 0);
+       setvbuf(stderr, NULL, _IONBF, 0);
 #else
-    setbuf(stderr, NULL);
+       setbuf(stderr, NULL);
 #endif
+    }
 
 #if defined(AFS_PTHREAD_ENV)
-    MUTEX_INIT(&serverLogMutex, "serverlog", MUTEX_DEFAULT, 0);
+    opr_Verify(pthread_mutex_init(&serverLogMutex, NULL) == 0);
 #endif /* AFS_PTHREAD_ENV */
 
     serverLogFD = tempfd;
@@ -390,19 +390,42 @@ ReOpenLog(const char *fileName)
        close(serverLogFD);
     serverLogFD = open(fileName, O_WRONLY | O_APPEND | O_CREAT | (isfifo?O_NONBLOCK:0), 0666);
     if (serverLogFD > 0) {
-       (void)freopen(fileName, "a", stdout);
-       (void)freopen(fileName, "a", stderr);
+       if (freopen(fileName, "a", stdout) == NULL)
+           ; /* don't care */
+       if (freopen(fileName, "a", stderr) != NULL) {
 #ifdef HAVE_SETVBUF
 #ifdef SETVBUF_REVERSED
-       setvbuf(stderr, _IONBF, NULL, 0);
+           setvbuf(stderr, _IONBF, NULL, 0);
 #else
-       setvbuf(stderr, NULL, _IONBF, 0);
+           setvbuf(stderr, NULL, _IONBF, 0);
 #endif
 #else
-       setbuf(stderr, NULL);
+           setbuf(stderr, NULL);
 #endif
+       }
 
     }
     UNLOCK_SERVERLOG();
     return serverLogFD < 0 ? -1 : 0;
 }
+
+/*!
+ * Close the server log file.
+ *
+ * \note Must be preceeded by OpenLog().
+ */
+void
+CloseLog(void)
+{
+    LOCK_SERVERLOG();
+#ifndef AFS_NT40_ENV
+    if (serverLogSyslog) {
+       closelog();
+    } else
+#endif
+    if (serverLogFD >= 0) {
+       close(serverLogFD);
+       serverLogFD = -1;
+    }
+    UNLOCK_SERVERLOG();
+}