digestauth.c

Go to the documentation of this file.

/*
     This file is part of libmicrohttpd
     (C) 2010, 2011, 2012 Daniel Pittman and Christian Grothoff

     This library is free software; you can redistribute it and/or
     modify it under the terms of the GNU Lesser General Public
     License as published by the Free Software Foundation; either
     version 2.1 of the License, or (at your option) any later version.

     This library is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Lesser General Public License for more details.

     You should have received a copy of the GNU Lesser General Public
     License along with this library; if not, write to the Free Software
     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/

#include "platform.h"
#include <limits.h>
#include "internal.h"
#include "md5.h"
#include "base64.h"

#define HASH_MD5_HEX_LEN (2 * MD5_DIGEST_SIZE)

#define _BASE           "Digest "

#define _BASIC_BASE             "Basic "

#define MAX_USERNAME_LENGTH 128

#define MAX_REALM_LENGTH 256

#define MAX_AUTH_RESPONSE_LENGTH 128

static void
cvthex(const unsigned char *bin,
       size_t len,
       char *hex)
{
  size_t i;
  unsigned int j;
  
  for (i = 0; i < len; ++i) 
    {
      j = (bin[i] >> 4) & 0x0f;      
      hex[i * 2] = j <= 9 ? (j + '0') : (j + 'a' - 10);    
      j = bin[i] & 0x0f;    
      hex[i * 2 + 1] = j <= 9 ? (j + '0') : (j + 'a' - 10);
    }
  hex[len * 2] = '\0';
}

static void
digest_calc_ha1(const char *alg,
                const char *username,
                const char *realm,
                const char *password,
                const char *nonce,
                const char *cnonce,
                char *sessionkey)
{
  struct MD5Context md5;
  unsigned char ha1[MD5_DIGEST_SIZE];
  
  MD5Init (&md5);
  MD5Update (&md5, username, strlen (username));
  MD5Update (&md5, ":", 1);
  MD5Update (&md5, realm, strlen (realm));
  MD5Update (&md5, ":", 1);
  MD5Update (&md5, password, strlen (password));
  MD5Final (ha1, &md5);
  if (0 == strcasecmp(alg, "md5-sess")) 
    {
      MD5Init (&md5);
      MD5Update (&md5, ha1, sizeof (ha1));
      MD5Update (&md5, ":", 1);
      MD5Update (&md5, nonce, strlen (nonce));
      MD5Update (&md5, ":", 1);
      MD5Update (&md5, cnonce, strlen (cnonce));
      MD5Final (ha1, &md5);
    }
  cvthex(ha1, sizeof (ha1), sessionkey);
}


static void
digest_calc_response(const char *ha1,
                     const char *nonce,
                     const char *noncecount,
                     const char *cnonce,
                     const char *qop,
                     const char *method,
                     const char *uri,
                     const char *hentity,
                     char *response)
{
  struct MD5Context md5;
  unsigned char ha2[MD5_DIGEST_SIZE];
  unsigned char resphash[MD5_DIGEST_SIZE];
  char ha2hex[HASH_MD5_HEX_LEN + 1];
  
  MD5Init (&md5);
  MD5Update (&md5, method, strlen(method));
  MD5Update (&md5, ":", 1);
  MD5Update (&md5, uri, strlen(uri)); 
#if 0
  if (strcasecmp(qop, "auth-int") == 0) 
    {
      /* This is dead code since the rest of this module does
         not support auth-int. */
      MD5Update (&md5, ":", 1);
      if (hentity != NULL)
        MD5Update (&md5, hentity, strlen(hentity));
    }
#endif  
  MD5Final (ha2, &md5);
  cvthex(ha2, MD5_DIGEST_SIZE, ha2hex);
  MD5Init (&md5);  
  /* calculate response */  
  MD5Update (&md5, ha1, HASH_MD5_HEX_LEN);
  MD5Update (&md5, ":", 1);
  MD5Update (&md5, nonce, strlen(nonce));
  MD5Update (&md5, ":", 1);  
  if ('\0' != *qop)
    {
      MD5Update (&md5, noncecount, strlen(noncecount));
      MD5Update (&md5, ":", 1);
      MD5Update (&md5, cnonce, strlen(cnonce));
      MD5Update (&md5, ":", 1);
      MD5Update (&md5, qop, strlen(qop));
      MD5Update (&md5, ":", 1);
    }  
  MD5Update (&md5, ha2hex, HASH_MD5_HEX_LEN);
  MD5Final (resphash, &md5);
  cvthex(resphash, sizeof (resphash), response);
}


static int
lookup_sub_value(char *dest,
                 size_t size,
                 const char *data,
                 const char *key)
{
  size_t keylen = strlen(key);
  size_t len;
  const char *ptr = data;
  const char *eq;
  const char *q1;
  const char *q2;
  const char *qn;

  if (0 == size)
    return 0;
  while ('\0' != *ptr)
    {
      if (NULL == (eq = strstr (ptr, "=")))
        return 0;
      q1 = eq + 1;
      while (' ' == *q1)
        q1++;      
      if ('\"' != *q1)
        {
          q2 = strstr (q1, ",");
          qn = q2;
        }
      else
        {
          q1++;
          q2 = strstr (q1, "\"");
          if (NULL == q2)
            return 0; /* end quote not found */
          qn = q2 + 1;
        }      
      if ( (0 == strncasecmp (ptr,
                              key,
                              keylen)) &&
           (eq == &ptr[keylen]) )
        {
          if (q2 == NULL)
            {
              len = strlen (q1) + 1;
              if (size > len)
                size = len;
              size--;
              strncpy (dest,
                       q1,
                       size);
              dest[size] = '\0';
              return size;
            }
          else
            {
              if (size > (q2 - q1) + 1)
                size = (q2 - q1) + 1;
              size--;
              memcpy (dest, 
                      q1,
                      size);
              dest[size] = '\0';
              return size;
            }
        }
      if (NULL == qn)
        return 0;
      ptr = strstr (qn, ",");
      if (NULL == ptr)
        return 0;
      ptr++;
      while (' ' == *ptr)
        ptr++;
    }
  return 0;
}


static int
check_nonce_nc (struct MHD_Connection *connection,
                const char *nonce,
                unsigned long int nc)
{
  uint32_t off;
  uint32_t mod;
  const char *np;

  mod = connection->daemon->nonce_nc_size;
  if (0 == mod)
    return MHD_NO; /* no array! */
  /* super-fast xor-based "hash" function for HT lookup in nonce array */
  off = 0;
  np = nonce;
  while (*np != '\0')
    {
      off = (off << 8) | (*np ^ (off >> 24));
      np++;
    }
  off = off % mod;
  /*
   * Look for the nonce, if it does exist and its corresponding
   * nonce counter is less than the current nonce counter by 1,
   * then only increase the nonce counter by one.
   */
  
  pthread_mutex_lock(&connection->daemon->nnc_lock);
  if (nc == 0)
    {
      strcpy(connection->daemon->nnc[off].nonce, 
             nonce);
      connection->daemon->nnc[off].nc = 0;  
      pthread_mutex_unlock(&connection->daemon->nnc_lock);
      return MHD_YES;
    }
  if ( (nc <= connection->daemon->nnc[off].nc) ||
       (0 != strcmp(connection->daemon->nnc[off].nonce, nonce)) )
    {
      pthread_mutex_unlock(&connection->daemon->nnc_lock);
#if HAVE_MESSAGES
      MHD_DLOG (connection->daemon, 
                "Stale nonce received.  If this happens a lot, you should probably increase the size of the nonce array.\n");
#endif
      return MHD_NO;
    }
  connection->daemon->nnc[off].nc = nc;
  pthread_mutex_unlock(&connection->daemon->nnc_lock);
  return MHD_YES;
}


char *
MHD_digest_auth_get_username(struct MHD_Connection *connection)
{
  size_t len;
  char user[MAX_USERNAME_LENGTH];
  const char *header;
  
  header = MHD_lookup_connection_value(connection,
                                       MHD_HEADER_KIND, 
                                       MHD_HTTP_HEADER_AUTHORIZATION); 
  if (header == NULL)
    return NULL;
  if (strncmp(header, _BASE, strlen(_BASE)) != 0)
    return NULL;
  header += strlen (_BASE);
  len = lookup_sub_value(user,
                         sizeof (user),
                         header, 
                         "username");
  if (!len)
    return NULL;
  return strdup(user);
}


static void
calculate_nonce (uint32_t nonce_time,
                 const char *method,
                 const char *rnd,
                 unsigned int rnd_size,
                 const char *uri,
                 const char *realm,
                 char *nonce)
{
  struct MD5Context md5;
  unsigned char timestamp[4];
  unsigned char tmpnonce[MD5_DIGEST_SIZE];
  char timestamphex[sizeof(timestamp)*2+1];

  MD5Init (&md5);
  timestamp[0] = (nonce_time & 0xff000000) >> 0x18;
  timestamp[1] = (nonce_time & 0x00ff0000) >> 0x10;
  timestamp[2] = (nonce_time & 0x0000ff00) >> 0x08;
  timestamp[3] = (nonce_time & 0x000000ff);    
  MD5Update(&md5, timestamp, 4);
  MD5Update(&md5, ":", 1);
  MD5Update(&md5, method, strlen(method));
  MD5Update(&md5, ":", 1);
  if (rnd_size > 0)
    MD5Update(&md5, rnd, rnd_size);
  MD5Update(&md5, ":", 1);
  MD5Update(&md5, uri, strlen(uri));
  MD5Update(&md5, ":", 1);
  MD5Update(&md5, realm, strlen(realm));
  MD5Final (tmpnonce, &md5);  
  cvthex(tmpnonce, sizeof (tmpnonce), nonce);  
  cvthex(timestamp, 4, timestamphex);
  strncat(nonce, timestamphex, 8);
}


static int
test_header (struct MHD_Connection *connection,
             const char *key,
             const char *value)
{
  struct MHD_HTTP_Header *pos;

  for (pos = connection->headers_received; NULL != pos; pos = pos->next)
    {
      if (MHD_GET_ARGUMENT_KIND != pos->kind)
        continue;
      if (0 != strcmp (key, pos->header))
        continue;
      if ( (NULL == value) && (NULL == pos->value))
        return MHD_YES;
      if ( (NULL == value) || (NULL == pos->value))
        continue;
      if (0 != strcmp (value, pos->value))
        continue;
      return MHD_YES;      
    }
  return MHD_NO;
}


static int
check_argument_match (struct MHD_Connection *connection,
                      const char *args)
{
  struct MHD_HTTP_Header *pos;
  size_t slen = strlen (args) + 1;
  char argb[slen];
  char *argp;
  char *equals;
  char *amper;
  unsigned int num_headers;

  num_headers = 0;
  memcpy (argb, args, slen);
  argp = argb;
  while ( (argp != NULL) &&
          (argp[0] != '\0') )
    {
      equals = strstr (argp, "=");
      if (equals == NULL) 
        {         
          /* add with 'value' NULL */
          connection->daemon->unescape_callback (connection->daemon->unescape_callback_cls,
                                                 connection,
                                                 argp);
          if (MHD_YES != test_header (connection, argp, NULL))
            return MHD_NO;
          num_headers++;
          break;
        }
      equals[0] = '\0';
      equals++;
      amper = strstr (equals, "&");
      if (amper != NULL)
        {
          amper[0] = '\0';
          amper++;
        }
      connection->daemon->unescape_callback (connection->daemon->unescape_callback_cls,
                                             connection,
                                             argp);
      connection->daemon->unescape_callback (connection->daemon->unescape_callback_cls,
                                             connection,
                                             equals);
      if (! test_header (connection, argp, equals))
        return MHD_NO;
      num_headers++;
      argp = amper;
    }
  
  /* also check that the number of headers matches */
  for (pos = connection->headers_received; NULL != pos; pos = pos->next)
    {
      if (MHD_GET_ARGUMENT_KIND != pos->kind)
        continue;
      num_headers--;
    }
  if (0 != num_headers)  
    return MHD_NO;
  return MHD_YES;
}


int
MHD_digest_auth_check(struct MHD_Connection *connection,
                      const char *realm,
                      const char *username,
                      const char *password,
                      unsigned int nonce_timeout)
{
  size_t len;
  const char *header;
  char *end;
  char nonce[MAX_NONCE_LENGTH];
  char cnonce[MAX_NONCE_LENGTH];
  char qop[15]; /* auth,auth-int */
  char nc[20];
  char response[MAX_AUTH_RESPONSE_LENGTH];
  const char *hentity = NULL; /* "auth-int" is not supported */
  char ha1[HASH_MD5_HEX_LEN + 1];
  char respexp[HASH_MD5_HEX_LEN + 1];
  char noncehashexp[HASH_MD5_HEX_LEN + 9];
  uint32_t nonce_time;
  uint32_t t;
  size_t left; /* number of characters left in 'header' for 'uri' */
  unsigned long int nci;

  header = MHD_lookup_connection_value(connection,
                                       MHD_HEADER_KIND,
                                       MHD_HTTP_HEADER_AUTHORIZATION);  
  if (header == NULL) 
    return MHD_NO;
  if (strncmp(header, _BASE, strlen(_BASE)) != 0) 
    return MHD_NO;
  header += strlen (_BASE);
  left = strlen (header);

  {
    char un[MAX_USERNAME_LENGTH];
    len = lookup_sub_value(un,
                           sizeof (un),
                           header, "username");
    if ( (!len) ||
         (strcmp(username, un) != 0) ) 
      return MHD_NO;
    left -= strlen ("username") + len;
  }

  {
    char r[MAX_REALM_LENGTH];
    len = lookup_sub_value(r, 
                           sizeof (r),
                           header, "realm");  
    if ( (!len) || 
         (strcmp(realm, r) != 0) )
      return MHD_NO;
    left -= strlen ("realm") + len;
  }

  if (0 == (len = lookup_sub_value(nonce, 
                                   sizeof (nonce),
                                   header, "nonce")))
    return MHD_NO;
  left -= strlen ("nonce") + len;

  {
    char uri[left];  
  
    if (0 == lookup_sub_value(uri,
                              sizeof (uri),
                              header, "uri")) 
      return MHD_NO;
      
    /* 8 = 4 hexadecimal numbers for the timestamp */  
    nonce_time = strtoul(nonce + len - 8, (char **)NULL, 16);  
    t = (uint32_t) MHD_monotonic_time();    
    /*
     * First level vetting for the nonce validity if the timestamp
     * attached to the nonce exceeds `nonce_timeout' then the nonce is
     * invalid.
     */
    if ( (t > nonce_time + nonce_timeout) ||
         (nonce_time + nonce_timeout < nonce_time) )
      return MHD_INVALID_NONCE;
    if (0 != strncmp (uri,
                      connection->url,
                      strlen (connection->url)))
    {
#if HAVE_MESSAGES
      MHD_DLOG (connection->daemon, 
                "Authentication failed, URI does not match.\n");
#endif
      return MHD_NO;
    }
    {
      const char *args = strstr (uri, "?");
      if (args == NULL)
        args = "";
      else
        args++;
      if (MHD_YES !=
          check_argument_match (connection,
                                args) ) 
      {
#if HAVE_MESSAGES
        MHD_DLOG (connection->daemon, 
                  "Authentication failed, arguments do not match.\n");
#endif
        return MHD_NO;
      }
    }
    calculate_nonce (nonce_time,
                     connection->method,
                     connection->daemon->digest_auth_random,
                     connection->daemon->digest_auth_rand_size,
                     connection->url,
                     realm,
                     noncehashexp);
    /*
     * Second level vetting for the nonce validity
     * if the timestamp attached to the nonce is valid
     * and possibly fabricated (in case of an attack)
     * the attacker must also know the random seed to be
     * able to generate a "sane" nonce, which if he does
     * not, the nonce fabrication process going to be
     * very hard to achieve.
     */
    
    if (0 != strcmp(nonce, noncehashexp))
      return MHD_INVALID_NONCE;
    if ( (0 == lookup_sub_value(cnonce,
                                sizeof (cnonce), 
                                header, "cnonce")) ||
         (0 == lookup_sub_value(qop, sizeof (qop), header, "qop")) ||
         ( (0 != strcmp (qop, "auth")) && 
           (0 != strcmp (qop, "")) ) ||
         (0 == lookup_sub_value(nc, sizeof (nc), header, "nc"))  ||
         (0 == lookup_sub_value(response, sizeof (response), header, "response")) )
    {
#if HAVE_MESSAGES
      MHD_DLOG (connection->daemon, 
                "Authentication failed, invalid format.\n");
#endif
      return MHD_NO;
    }
    nci = strtoul (nc, &end, 16);
    if ( ('\0' != *end) ||
         ( (LONG_MAX == nci) && (errno == ERANGE) ) )
    {
#if HAVE_MESSAGES
      MHD_DLOG (connection->daemon, 
                "Authentication failed, invalid format.\n");
#endif
      return MHD_NO; /* invalid nonce format */
    }
    /*
     * Checking if that combination of nonce and nc is sound
     * and not a replay attack attempt. Also adds the nonce
     * to the nonce-nc map if it does not exist there.
     */
    
    if (MHD_YES != check_nonce_nc (connection, nonce, nci))
      return MHD_NO;
    
    digest_calc_ha1("md5",
                    username,
                    realm,
                    password,
                    nonce,
                    cnonce,
                    ha1);
    digest_calc_response(ha1,
                         nonce,
                         nc,
                         cnonce,
                         qop,
                         connection->method,
                         uri,
                         hentity,
                         respexp);  
    return strcmp(response, respexp) == 0 ? MHD_YES : MHD_NO;
  }
}


int
MHD_queue_auth_fail_response(struct MHD_Connection *connection,
                             const char *realm,
                             const char *opaque,
                             struct MHD_Response *response,
                             int signal_stale)
{
  int ret;
  size_t hlen;
  char nonce[HASH_MD5_HEX_LEN + 9];

  /* Generating the server nonce */  
  calculate_nonce ((uint32_t) MHD_monotonic_time(),
                   connection->method,
                   connection->daemon->digest_auth_random,
                   connection->daemon->digest_auth_rand_size,
                   connection->url,
                   realm,
                   nonce);
  if (MHD_YES != check_nonce_nc (connection, nonce, 0))
    {
#if HAVE_MESSAGES
      MHD_DLOG (connection->daemon, 
                "Could not register nonce (is the nonce array size zero?).\n");
#endif
      return MHD_NO;  
    }
  /* Building the authentication header */
  hlen = snprintf(NULL,
                  0,
                  "Digest realm=\"%s\",qop=\"auth\",nonce=\"%s\",opaque=\"%s\"%s",
                  realm, 
                  nonce,
                  opaque,
                  signal_stale ? ",stale=\"true\"" : "");
  {
    char header[hlen + 1];
    snprintf(header,
             sizeof(header),
             "Digest realm=\"%s\",qop=\"auth\",nonce=\"%s\",opaque=\"%s\"%s",
             realm, 
             nonce,
             opaque,
             signal_stale ? ",stale=\"true\"" : "");
    ret = MHD_add_response_header(response,
                                  MHD_HTTP_HEADER_WWW_AUTHENTICATE, 
                                  header);
  }
  if (MHD_YES == ret) 
    ret = MHD_queue_response(connection, 
                             MHD_HTTP_UNAUTHORIZED, 
                             response);  
  return ret;
}


char *
MHD_basic_auth_get_username_password(struct MHD_Connection *connection,
                                     char** password) 
{
  const char *header;
  char *decode;
  const char *separator;
  char *user;
  
  header = MHD_lookup_connection_value(connection, 
                                       MHD_HEADER_KIND,
                                       MHD_HTTP_HEADER_AUTHORIZATION);
  if (header == NULL)
    return NULL;
  if (strncmp(header, _BASIC_BASE, strlen(_BASIC_BASE)) != 0)
    return NULL;
  header += strlen(_BASIC_BASE);
  decode = BASE64Decode(header);
  if (decode == NULL) 
    {
#if HAVE_MESSAGES
      MHD_DLOG(connection->daemon,
               "Error decoding basic authentication\n");
#endif
      return NULL;
    }
  /* Find user:password pattern */
  separator = strstr(decode, ":");
  if (separator == NULL) 
    {
#if HAVE_MESSAGES
      MHD_DLOG(connection->daemon,
               "Basic authentication doesn't contain ':' separator\n");
#endif
      free(decode);
      return NULL;
    }
  user = strdup(decode);
  if (NULL == user)
    {
      free (decode);
      return NULL;
    }
  user[separator - decode] = '\0'; /* cut off at ':' */
  if (password != NULL) 
    {
      *password = strdup(separator + 1);  
      if (NULL == *password)
        {
#if HAVE_MESSAGES
          MHD_DLOG(connection->daemon,
                   "Failed to allocate memory for password\n");
#endif
          free (decode);
          free (user);
          return NULL;
        }
    }
  free(decode);
  return user;
}


int 
MHD_queue_basic_auth_fail_response(struct MHD_Connection *connection,
                                   const char *realm, 
                                   struct MHD_Response *response) 
{
  int ret;
  size_t hlen = strlen(realm) + strlen("Basic realm=\"\"") + 1;
  char header[hlen];

  snprintf(header, 
           sizeof (header), 
           "Basic realm=\"%s\"", 
           realm);
  ret = MHD_add_response_header(response,
                                MHD_HTTP_HEADER_WWW_AUTHENTICATE,
                                header);
  if (MHD_YES == ret)
    ret = MHD_queue_response(connection, 
                             MHD_HTTP_UNAUTHORIZED, 
                             response);
  return ret;
}

/* end of digestauth.c */