radsecproxy-1.6.5.
[radsecproxy.git] / fticks.c
index 98022cd..43b37fe 100644 (file)
--- a/fticks.c
+++ b/fticks.c
@@ -2,73 +2,85 @@
  * See LICENSE for information about licensing.
  */
 
-#include <stdio.h>             /* For sprintf().  */
-#include <string.h>
-#include <nettle/sha.h>
-#include <nettle/hmac.h>
-
-#include <regex.h>
-#include <pthread.h>
-#include <sys/time.h>
-#include "list.h"
 #include "radsecproxy.h"
 #include "debug.h"
-
 #include "fticks.h"
+#include "fticks_hashmac.h"
 
-static void
-format_hash(const uint8_t *hash, size_t out_len, uint8_t *out)
-{
-    int i;
-
-    for (i = 0; i < out_len / 2; i++)
-       sprintf((char *) out + i*2, "%02x", hash[i % SHA256_DIGEST_SIZE]);
-}
-
-static void
-hash(const uint8_t *in,
-     const uint8_t *key,
-     size_t out_len,
-     uint8_t *out)
+int
+fticks_configure(struct options *options,
+                uint8_t **reportingp,
+                uint8_t **macp,
+                uint8_t **keyp)
 {
-    if (key == NULL) {
-       struct sha256_ctx ctx;
-       uint8_t hash[SHA256_DIGEST_SIZE];
-
-       sha256_init(&ctx);
-       sha256_update(&ctx, strlen((char *) in), in);
-       sha256_digest(&ctx, sizeof(hash), hash);
-       format_hash(hash, out_len, out);
+    int r = 0;
+    const char *reporting = (const char *) *reportingp;
+    const char *mac = (const char *) *macp;
+
+    /* Set defaults.  */
+    options->fticks_reporting = RSP_FTICKS_REPORTING_NONE;
+    options->fticks_mac = RSP_FTICKS_MAC_VENDOR_KEY_HASHED;
+
+    if (reporting != NULL) {
+       if (strcasecmp(reporting, "None") == 0)
+           options->fticks_reporting = RSP_FTICKS_REPORTING_NONE;
+       else if (strcasecmp(reporting, "Basic") == 0)
+           options->fticks_reporting = RSP_FTICKS_REPORTING_BASIC;
+       else if (strcasecmp(reporting, "Full") == 0)
+           options->fticks_reporting = RSP_FTICKS_REPORTING_FULL;
+       else {
+           debugx(1, DBG_ERR,
+                  "config error: invalid FTicksReporting value: %s",
+                  reporting);
+           r = 1;
+       }
     }
-    else {
-       struct hmac_sha256_ctx ctx;
-       uint8_t hash[SHA256_DIGEST_SIZE];
 
-       hmac_sha256_set_key(&ctx, strlen((char *) key), key);
-       hmac_sha256_update(&ctx, strlen((char *) in), in);
-       hmac_sha256_digest(&ctx, sizeof(hash), hash);
-       format_hash(hash, out_len, out);
+    if (mac != NULL) {
+       if (strcasecmp(mac, "Static") == 0)
+           options->fticks_mac = RSP_FTICKS_MAC_STATIC;
+       else if (strcasecmp(mac, "Original") == 0)
+           options->fticks_mac = RSP_FTICKS_MAC_ORIGINAL;
+       else if (strcasecmp(mac, "VendorHashed") == 0)
+           options->fticks_mac = RSP_FTICKS_MAC_VENDOR_HASHED;
+       else if (strcasecmp(mac, "VendorKeyHashed") == 0)
+           options->fticks_mac = RSP_FTICKS_MAC_VENDOR_KEY_HASHED;
+       else if (strcasecmp(mac, "FullyHashed") == 0)
+           options->fticks_mac = RSP_FTICKS_MAC_FULLY_HASHED;
+       else if (strcasecmp(mac, "FullyKeyHashed") == 0)
+           options->fticks_mac = RSP_FTICKS_MAC_FULLY_KEY_HASHED;
+       else {
+           debugx(1, DBG_ERR,
+                  "config error: invalid FTicksMAC value: %s", mac);
+           r = 1;
+       }
     }
-}
-
-/** Hash the MAC in \a IN, keying with \a KEY if it's not NULL.
-
-    \a IN and \a KEY are NULL terminated strings.
 
-    \a IN is sanitised by lowercasing it, removing all but [0-9a-f]
-    and truncating it at first ';' (due to RADIUS praxis with tacking
-    on SSID to MAC in Calling-Station-Id).  */
-void
-fticks_hashmac(const uint8_t *in,
-              const uint8_t *key,
-              size_t out_len,
-              uint8_t *out)
-{
-    /* TODO: lowercase */
-    /* TODO: s/[!0-9a-f]//1 */
-    /* TODO: truncate after first ';', if any */
+    if (*keyp != NULL) {
+       options->fticks_key = *keyp;
+       if (options->fticks_mac != RSP_FTICKS_MAC_VENDOR_KEY_HASHED
+           && options->fticks_mac != RSP_FTICKS_MAC_FULLY_KEY_HASHED)
+           debugx(1, DBG_WARN, "config warning: FTicksKey not used");
+    }
+    else if (options->fticks_reporting != RSP_FTICKS_REPORTING_NONE
+            && (options->fticks_mac == RSP_FTICKS_MAC_VENDOR_KEY_HASHED
+                || options->fticks_mac == RSP_FTICKS_MAC_FULLY_KEY_HASHED)) {
+       debugx(1, DBG_ERR,
+              "config error: FTicksMAC values VendorKeyHashed and "
+              "FullyKeyHashed require an FTicksKey");
+       options->fticks_reporting = RSP_FTICKS_REPORTING_NONE;
+       r = 1;
+    }
 
-    hash(in, key, out_len, out);
+    if (*reportingp != NULL) {
+       free(*reportingp);
+       *reportingp = NULL;
+    }
+    if (*macp != NULL) {
+       free(*macp);
+       *macp = NULL;
+    }
+    return r;
 }
 
 void
@@ -77,8 +89,8 @@ fticks_log(const struct options *options,
           const struct radmsg *msg,
           const struct rqout *rqout)
 {
-    unsigned char *username = NULL;
-    unsigned char *realm = NULL;
+    uint8_t *username = NULL;
+    uint8_t *realm = NULL;
     uint8_t visinst[8+40+1+1]; /* Room for 40 octets of VISINST.  */
     uint8_t *macin = NULL;
     uint8_t macout[2*32+1]; /* Room for ASCII representation of SHA256.  */
@@ -86,57 +98,66 @@ fticks_log(const struct options *options,
     username = radattr2ascii(radmsg_gettype(rqout->rq->msg,
                                            RAD_Attr_User_Name));
     if (username != NULL) {
-       realm = (unsigned char *) strrchr((char *) username, '@');
+       realm = (uint8_t *) strrchr((char *) username, '@');
        if (realm != NULL)
            realm++;
-       else
-           realm = (unsigned char *) "";
     }
+    if (realm == NULL)
+       realm = (uint8_t *) "";
 
     memset(visinst, 0, sizeof(visinst));
-    if (options->fticks_reporting == RSP_FTICKS_REPORTING_FULL)
-       snprintf((char *) visinst, sizeof(visinst), "VISINST=%s#",
-                client->conf->name);
+    if (options->fticks_reporting == RSP_FTICKS_REPORTING_FULL) {
+        if (client->conf->fticks_visinst != NULL ) {
+           snprintf((char *) visinst, sizeof(visinst), "VISINST=%s#",
+                     client->conf->fticks_visinst);
+        } else {
+           snprintf((char *) visinst, sizeof(visinst), "VISINST=%s#",
+                     client->conf->name);
+        }
+    }
 
-#define BOGUS_MAC "00:00:00:00:00:00" /* FIXME: Is there a standard
-                                      * for bogus MAC addresses?  */
     memset(macout, 0, sizeof(macout));
-    strncpy((char *) macout, BOGUS_MAC, sizeof(macout) - 1);
-    if (options->fticks_mac != RSP_FTICKS_MAC_STATIC) {
+    if (options->fticks_mac == RSP_FTICKS_MAC_STATIC) {
+       strncpy((char *) macout, "undisclosed", sizeof(macout) - 1);
+    }
+    else {
        macin = radattr2ascii(radmsg_gettype(rqout->rq->msg,
                                             RAD_Attr_Calling_Station_Id));
+       if (macin) {
+           switch (options->fticks_mac)
+           {
+           case RSP_FTICKS_MAC_ORIGINAL:
+               memcpy(macout, macin, sizeof(macout));
+               break;
+           case RSP_FTICKS_MAC_VENDOR_HASHED:
+               memcpy(macout, macin, 9);
+               fticks_hashmac(macin, NULL, sizeof(macout) - 9, macout + 9);
+               break;
+           case RSP_FTICKS_MAC_VENDOR_KEY_HASHED:
+               memcpy(macout, macin, 9);
+               /* We are hashing the first nine octets too for easier
+                * correlation between vendor-key-hashed and
+                * fully-key-hashed log records.  This opens up for a
+                * known plaintext attack on the key but the
+                * consequences of that is considered outweighed by
+                * the convenience gained.  */
+               fticks_hashmac(macin, options->fticks_key,
+                              sizeof(macout) - 9, macout + 9);
+               break;
+           case RSP_FTICKS_MAC_FULLY_HASHED:
+               fticks_hashmac(macin, NULL, sizeof(macout), macout);
+               break;
+           case RSP_FTICKS_MAC_FULLY_KEY_HASHED:
+               fticks_hashmac(macin, options->fticks_key, sizeof(macout),
+                              macout);
+               break;
+           default:
+               debugx(2, DBG_ERR, "invalid fticks mac configuration: %d",
+                      options->fticks_mac);
+           }
+       }
     }
-#if RS_TESTING || 1
-    if (macin == NULL)
-       macin = (uint8_t *) strdup(BOGUS_MAC);
-#endif /* RS_TESTING */
-
-    switch (options->fticks_mac)
-    {
-    case RSP_FTICKS_MAC_STATIC:
-       memcpy(macout, BOGUS_MAC, sizeof(BOGUS_MAC));
-       break;
-    case RSP_FTICKS_MAC_ORIGINAL:
-       memcpy(macout, macin, sizeof(macout));
-       break;
-    case RSP_FTICKS_MAC_VENDOR_HASHED:
-       fticks_hashmac(macin + 3, NULL, sizeof(macout), macout);
-       break;
-    case RSP_FTICKS_MAC_VENDOR_KEY_HASHED:
-       fticks_hashmac(macin + 3, options->fticks_key, sizeof(macout),
-                      macout);
-       break;
-    case RSP_FTICKS_MAC_FULLY_HASHED:
-       fticks_hashmac(macin, NULL, sizeof(macout), macout);
-       break;
-    case RSP_FTICKS_MAC_FULLY_KEY_HASHED:
-       fticks_hashmac(macin, options->fticks_key, sizeof(macout), macout);
-       break;
-    default:
-       debugx(2, DBG_ERR, "invalid fticks mac configuration: %d",
-              options->fticks_mac);
-    }
-    debug(0xff,
+    fticks_debug(
          "F-TICKS/eduroam/1.0#REALM=%s#VISCOUNTRY=%s#%sCSI=%s#RESULT=%s#",
          realm,
          client->conf->fticks_viscountry,