LCOV - code coverage report
Current view: top level - lib/scram - client.c (source / functions) Hit Total Coverage
Test: GNU SASL Lines: 135 172 78.5 %
Date: 2010-09-27 Functions: 7 7 100.0 %
Legend: Lines: hit not hit | Branches: + taken - not taken # not executed Branches: 55 96 57.3 %

           Branch data     Line data    Source code
       1                 :            : /* client.c --- SASL SCRAM client side functions.
       2                 :            :  * Copyright (C) 2009  Simon Josefsson
       3                 :            :  *
       4                 :            :  * This file is part of GNU SASL Library.
       5                 :            :  *
       6                 :            :  * GNU SASL Library is free software; you can redistribute it and/or
       7                 :            :  * modify it under the terms of the GNU Lesser General Public License
       8                 :            :  * as published by the Free Software Foundation; either version 2.1 of
       9                 :            :  * the License, or (at your option) any later version.
      10                 :            :  *
      11                 :            :  * GNU SASL Library is distributed in the hope that it will be useful,
      12                 :            :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      13                 :            :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
      14                 :            :  * Lesser General Public License for more details.
      15                 :            :  *
      16                 :            :  * You should have received a copy of the GNU Lesser General Public
      17                 :            :  * License along with GNU SASL Library; if not, write to the Free
      18                 :            :  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
      19                 :            :  * Boston, MA 02110-1301, USA.
      20                 :            :  *
      21                 :            :  */
      22                 :            : 
      23                 :            : #ifdef HAVE_CONFIG_H
      24                 :            : # include "config.h"
      25                 :            : #endif
      26                 :            : 
      27                 :            : /* Get specification. */
      28                 :            : #include "scram.h"
      29                 :            : 
      30                 :            : /* Get malloc, free. */
      31                 :            : #include <stdlib.h>
      32                 :            : 
      33                 :            : /* Get memcpy, strlen, strchr. */
      34                 :            : #include <string.h>
      35                 :            : 
      36                 :            : /* Get bool. */
      37                 :            : #include <stdbool.h>
      38                 :            : 
      39                 :            : #include "tokens.h"
      40                 :            : #include "parser.h"
      41                 :            : #include "printer.h"
      42                 :            : #include "gc.h"
      43                 :            : #include "memxor.h"
      44                 :            : 
      45                 :            : #define CNONCE_ENTROPY_BYTES 18
      46                 :            : 
      47                 :            : struct scram_client_state
      48                 :            : {
      49                 :            :   int step;
      50                 :            :   char *cfmb; /* client first message bare */
      51                 :            :   char *serversignature;
      52                 :            :   char *authmessage;
      53                 :            :   struct scram_client_first cf;
      54                 :            :   struct scram_server_first sf;
      55                 :            :   struct scram_client_final cl;
      56                 :            :   struct scram_server_final sl;
      57                 :            : };
      58                 :            : 
      59                 :            : int
      60                 :         30 : _gsasl_scram_sha1_client_start (Gsasl_session * sctx, void **mech_data)
      61                 :            : {
      62                 :            :   struct scram_client_state *state;
      63                 :            :   char buf[CNONCE_ENTROPY_BYTES];
      64                 :            :   int rc;
      65                 :            : 
      66                 :         30 :   state = (struct scram_client_state *) calloc (sizeof (*state), 1);
      67         [ -  + ]:         30 :   if (state == NULL)
      68                 :          0 :     return GSASL_MALLOC_ERROR;
      69                 :            : 
      70                 :         30 :   rc = gsasl_nonce (buf, CNONCE_ENTROPY_BYTES);
      71         [ -  + ]:         30 :   if (rc != GSASL_OK)
      72                 :            :     {
      73                 :          0 :       free (state);
      74                 :          0 :       return rc;
      75                 :            :     }
      76                 :            : 
      77                 :         30 :   rc = gsasl_base64_to (buf, CNONCE_ENTROPY_BYTES,
      78                 :            :                         &state->cf.client_nonce, NULL);
      79         [ -  + ]:         30 :   if (rc != GSASL_OK)
      80                 :            :     {
      81                 :          0 :       free (state);
      82                 :          0 :       return rc;
      83                 :            :     }
      84                 :            : 
      85                 :         30 :   *mech_data = state;
      86                 :            : 
      87                 :         30 :   return GSASL_OK;
      88                 :            : }
      89                 :            : 
      90                 :            : static char
      91                 :        160 : hexdigit_to_char (char hexdigit)
      92                 :            : {
      93 [ +  - ][ +  + ]:        160 :   if (hexdigit >= '0' && hexdigit <= '9')
      94                 :        102 :     return hexdigit - '0';
      95 [ +  - ][ +  - ]:         58 :   if (hexdigit >= 'a' && hexdigit <= 'f')
      96                 :         58 :     return hexdigit - 'a' + 10;
      97                 :        160 :   return 0;
      98                 :            : }
      99                 :            : 
     100                 :            : static char
     101                 :         80 : hex_to_char (char u, char l)
     102                 :            : {
     103                 :         80 :   return (char) (((unsigned char) hexdigit_to_char (u)) * 16
     104                 :            :                  + hexdigit_to_char (l));
     105                 :            : }
     106                 :            : 
     107                 :            : static void
     108                 :          4 : sha1_hex_to_byte (char *saltedpassword, const char *p)
     109                 :            : {
     110         [ +  + ]:         84 :   while (*p)
     111                 :            :     {
     112                 :         80 :       *saltedpassword = hex_to_char (p[0], p[1]);
     113                 :         80 :       p += 2;
     114                 :         80 :       saltedpassword++;
     115                 :            :     }
     116                 :          4 : }
     117                 :            : 
     118                 :            : static bool
     119                 :          4 : hex_p (const char *hexstr)
     120                 :            : {
     121                 :            :   static const char hexalpha[] = "0123456789abcdef";
     122                 :            : 
     123         [ +  + ]:        164 :   for (; *hexstr; hexstr++)
     124         [ -  + ]:        160 :     if (strchr (hexalpha, *hexstr) == NULL)
     125                 :          0 :       return false;
     126                 :            : 
     127                 :          4 :   return true;
     128                 :            : }
     129                 :            : 
     130                 :            : int
     131                 :         65 : _gsasl_scram_sha1_client_step (Gsasl_session * sctx,
     132                 :            :                                void *mech_data,
     133                 :            :                                const char *input, size_t input_len,
     134                 :            :                                char **output, size_t * output_len)
     135                 :            : {
     136                 :         65 :   struct scram_client_state *state = mech_data;
     137                 :         65 :   int res = GSASL_MECHANISM_CALLED_TOO_MANY_TIMES;
     138                 :            :   int rc;
     139                 :            : 
     140                 :         65 :   *output = NULL;
     141                 :         65 :   *output_len = 0;
     142                 :            : 
     143   [ +  +  +  - ]:         65 :   switch (state->step)
     144                 :            :     {
     145                 :            :     case 0:
     146                 :            :       {
     147                 :            :         const char *p;
     148                 :            : 
     149                 :            :         /* We don't support channel bindings. */
     150                 :         27 :         state->cf.cbflag = 'n';
     151                 :            : 
     152                 :         27 :         p = gsasl_property_get (sctx, GSASL_AUTHID);
     153         [ +  + ]:         27 :         if (!p)
     154                 :          5 :           return GSASL_NO_AUTHID;
     155                 :            : 
     156                 :            :         /* FIXME check that final document uses query strings. */
     157                 :         22 :         rc = gsasl_saslprep (p, GSASL_ALLOW_UNASSIGNED,
     158                 :            :                              &state->cf.username, NULL);
     159         [ -  + ]:         22 :         if (rc != GSASL_OK)
     160                 :          0 :           return rc;
     161                 :            : 
     162                 :         22 :         p = gsasl_property_get (sctx, GSASL_AUTHZID);
     163         [ +  + ]:         22 :         if (p)
     164                 :         11 :           state->cf.authzid = strdup (p);
     165                 :            : 
     166                 :         22 :         rc = scram_print_client_first (&state->cf, output);
     167         [ -  + ]:         22 :         if (rc == -2)
     168                 :          0 :           return GSASL_MALLOC_ERROR;
     169         [ -  + ]:         22 :         else if (rc != 0)
     170                 :          0 :           return GSASL_AUTHENTICATION_ERROR;
     171                 :            : 
     172                 :         22 :         *output_len = strlen (*output);
     173                 :            : 
     174                 :            :         /* Save "cbind" and "bare" for next step. */
     175                 :         22 :         p = strchr (*output, ',');
     176         [ -  + ]:         22 :         if (!p)
     177                 :          0 :             return GSASL_AUTHENTICATION_ERROR;
     178                 :         22 :         p++;
     179                 :         22 :         p = strchr (p, ',');
     180         [ -  + ]:         22 :         if (!p)
     181                 :          0 :             return GSASL_AUTHENTICATION_ERROR;
     182                 :         22 :         p++;
     183                 :         22 :         rc = gsasl_base64_to (*output, p - *output, &state->cl.cbind, NULL);
     184         [ -  + ]:         22 :         if (rc != 0)
     185                 :          0 :           return rc;
     186                 :            : 
     187                 :         22 :         state->cfmb = strdup (p);
     188         [ -  + ]:         22 :         if (!state->cfmb)
     189                 :          0 :           return GSASL_MALLOC_ERROR;
     190                 :            : 
     191                 :            :         /* We are done. */
     192                 :         22 :         state->step++;
     193                 :         22 :         return GSASL_NEEDS_MORE;
     194                 :            :         break;
     195                 :            :       }
     196                 :            : 
     197                 :            :     case 1:
     198                 :            :       {
     199         [ -  + ]:         22 :         if (scram_parse_server_first (input, input_len, &state->sf) < 0)
     200                 :          0 :           return GSASL_MECHANISM_PARSE_ERROR;
     201                 :            : 
     202 [ +  - ][ -  + ]:         22 :         if (strlen (state->sf.nonce) < strlen (state->cf.client_nonce) ||
     203                 :         22 :             memcmp (state->cf.client_nonce, state->sf.nonce,
     204                 :         44 :                     strlen (state->cf.client_nonce)) != 0)
     205                 :          0 :           return GSASL_AUTHENTICATION_ERROR;
     206                 :            : 
     207                 :         22 :         state->cl.nonce = strdup (state->sf.nonce);
     208         [ -  + ]:         22 :         if (!state->cl.nonce)
     209                 :          0 :           return GSASL_MALLOC_ERROR;
     210                 :            : 
     211                 :            :         /* Save salt/iter as properties, so that client callback can
     212                 :            :            access them. */
     213                 :            :         {
     214                 :         22 :           char *str = NULL;
     215                 :            :           int n;
     216                 :         22 :           n = asprintf (&str, "%d", state->sf.iter);
     217   [ +  -  -  + ]:         22 :           if (n < 0 || str == NULL)
     218                 :          0 :             return GSASL_MALLOC_ERROR;
     219                 :         22 :           gsasl_property_set (sctx, GSASL_SCRAM_ITER, str);
     220                 :         22 :           free (str);
     221                 :            :         }
     222                 :            : 
     223                 :         22 :         gsasl_property_set (sctx, GSASL_SCRAM_SALT, state->sf.salt);
     224                 :            : 
     225                 :            :         /* Generate ClientProof. */
     226                 :            :         {
     227                 :            :           char saltedpassword[20];
     228                 :            :           char *clientkey;
     229                 :            :           char *storedkey;
     230                 :            :           char *clientsignature;
     231                 :            :           char clientproof[20];
     232                 :            :           const char *p;
     233                 :            : 
     234                 :            :           /* Get SaltedPassword. */
     235                 :         22 :           p = gsasl_property_get (sctx, GSASL_SCRAM_SALTED_PASSWORD);
     236   [ +  +  +  - ]:         26 :           if (p && strlen (p) == 40 && hex_p (p))
                 [ +  - ]
     237                 :          4 :             sha1_hex_to_byte (saltedpassword, p);
     238         [ +  - ]:         18 :           else if ((p = gsasl_property_get (sctx, GSASL_PASSWORD)) != NULL)
     239                 :            :             {
     240                 :            :               Gc_rc err;
     241                 :            :               char *salt;
     242                 :            :               size_t saltlen;
     243                 :            :               char *preppasswd;
     244                 :            : 
     245                 :         18 :               rc = gsasl_saslprep (p, 0, &preppasswd, NULL);
     246         [ -  + ]:         18 :               if (rc != GSASL_OK)
     247                 :          0 :                 return rc;
     248                 :            : 
     249                 :         18 :               rc = gsasl_base64_from (state->sf.salt, strlen (state->sf.salt),
     250                 :            :                                       &salt, &saltlen);
     251         [ -  + ]:         18 :               if (rc != 0)
     252                 :            :                 {
     253                 :          0 :                   gsasl_free (preppasswd);
     254                 :          0 :                   return rc;
     255                 :            :                 }
     256                 :            : 
     257                 :            :               /* SaltedPassword := Hi(password, salt) */
     258                 :         18 :               err = gc_pbkdf2_sha1 (preppasswd, strlen (preppasswd),
     259                 :            :                                     salt, saltlen,
     260                 :            :                                     state->sf.iter, saltedpassword, 20);
     261                 :         18 :               gsasl_free (preppasswd);
     262                 :         18 :               gsasl_free (salt);
     263         [ -  + ]:         18 :               if (err != GC_OK)
     264                 :          0 :                 return GSASL_MALLOC_ERROR;
     265                 :            :             }
     266                 :            :           else
     267                 :          0 :             return GSASL_NO_PASSWORD;
     268                 :            : 
     269                 :            :           /* Get client-final-message-without-proof. */
     270                 :            :           {
     271                 :            :             char *cfmwp;
     272                 :            :             int n;
     273                 :            : 
     274                 :         22 :             state->cl.proof = strdup ("p");
     275                 :         22 :             rc = scram_print_client_final (&state->cl, &cfmwp);
     276         [ -  + ]:         22 :             if (rc != 0)
     277                 :          0 :               return GSASL_MALLOC_ERROR;
     278                 :         22 :             free (state->cl.proof);
     279                 :            : 
     280                 :            :             /* Compute AuthMessage */
     281                 :         22 :             n = asprintf (&state->authmessage, "%s,%.*s,%.*s",
     282                 :            :                           state->cfmb,
     283                 :            :                           input_len, input,
     284                 :            :                           strlen (cfmwp) - 4,
     285                 :            :                           cfmwp);
     286                 :         22 :             free (cfmwp);
     287   [ +  -  -  + ]:         22 :             if (n <= 0 || !state->authmessage)
     288                 :          0 :               return GSASL_MALLOC_ERROR;
     289                 :            :           }
     290                 :            : 
     291                 :            :           /* ClientKey := HMAC(SaltedPassword, "Client Key") */
     292                 :            : #define CLIENT_KEY "Client Key"
     293                 :         22 :           rc = gsasl_hmac_sha1 (saltedpassword, 20,
     294                 :            :                                 CLIENT_KEY, strlen (CLIENT_KEY),
     295                 :            :                                 &clientkey);
     296         [ -  + ]:         22 :           if (rc != 0)
     297                 :          0 :             return rc;
     298                 :            : 
     299                 :            :           /* StoredKey := H(ClientKey) */
     300                 :         22 :           rc = gsasl_sha1 (clientkey, 20, &storedkey);
     301         [ -  + ]:         22 :           if (rc != 0)
     302                 :            :             {
     303                 :          0 :               free (clientkey);
     304                 :          0 :               return rc;
     305                 :            :             }
     306                 :            : 
     307                 :            :           /* ClientSignature := HMAC(StoredKey, AuthMessage) */
     308                 :         22 :           rc = gsasl_hmac_sha1 (storedkey, 20,
     309                 :         22 :                                 state->authmessage,
     310                 :         22 :                                 strlen (state->authmessage),
     311                 :            :                                 &clientsignature);
     312                 :         22 :           free (storedkey);
     313         [ -  + ]:         22 :           if (rc != 0)
     314                 :            :             {
     315                 :          0 :               free (clientkey);
     316                 :          0 :               return rc;
     317                 :            :             }
     318                 :            : 
     319                 :            :           /* ClientProof := ClientKey XOR ClientSignature */
     320                 :         22 :           memcpy (clientproof, clientkey, 20);
     321                 :         22 :           memxor (clientproof, clientsignature, 20);
     322                 :            : 
     323                 :         22 :           free (clientkey);
     324                 :         22 :           free (clientsignature);
     325                 :            : 
     326                 :         22 :           rc = gsasl_base64_to (clientproof, 20, &state->cl.proof, NULL);
     327         [ -  + ]:         22 :           if (rc != 0)
     328                 :          0 :             return rc;
     329                 :            : 
     330                 :            :           /* Generate ServerSignature, for comparison in next step. */
     331                 :            :           {
     332                 :            :             char *serverkey;
     333                 :            :             char *serversignature;
     334                 :            : 
     335                 :            :             /* ServerKey := HMAC(SaltedPassword, "Server Key") */
     336                 :            : #define SERVER_KEY "Server Key"
     337                 :         22 :             rc = gsasl_hmac_sha1 (saltedpassword, 20,
     338                 :            :                                   SERVER_KEY, strlen (SERVER_KEY),
     339                 :            :                                   &serverkey);
     340         [ -  + ]:         22 :             if (rc != 0)
     341                 :          0 :               return rc;
     342                 :            : 
     343                 :            :             /* ServerSignature := HMAC(ServerKey, AuthMessage) */
     344                 :         22 :             rc = gsasl_hmac_sha1 (serverkey, 20,
     345                 :         22 :                                   state->authmessage,
     346                 :         22 :                                   strlen (state->authmessage),
     347                 :            :                                   &serversignature);
     348                 :         22 :             gsasl_free (serverkey);
     349         [ -  + ]:         22 :             if (rc != 0)
     350                 :          0 :               return rc;
     351                 :            : 
     352                 :         22 :             rc = gsasl_base64_to (serversignature, 20,
     353                 :            :                                   &state->serversignature, NULL);
     354                 :         22 :             gsasl_free (serversignature);
     355         [ -  + ]:         22 :             if (rc != 0)
     356                 :          0 :               return rc;
     357                 :            :           }
     358                 :            :         }
     359                 :            : 
     360                 :         22 :         rc = scram_print_client_final (&state->cl, output);
     361         [ -  + ]:         22 :         if (rc != 0)
     362                 :          0 :           return GSASL_MALLOC_ERROR;
     363                 :            : 
     364                 :         22 :         *output_len = strlen (*output);
     365                 :            : 
     366                 :         22 :         state->step++;
     367                 :         22 :         return GSASL_NEEDS_MORE;
     368                 :            :         break;
     369                 :            :       }
     370                 :            : 
     371                 :            :     case 2:
     372                 :            :       {
     373         [ -  + ]:         16 :         if (scram_parse_server_final (input, input_len, &state->sl) < 0)
     374                 :          0 :           return GSASL_MECHANISM_PARSE_ERROR;
     375                 :            : 
     376         [ -  + ]:         16 :         if (strcmp (state->sl.verifier, state->serversignature) != 0)
     377                 :          0 :           return GSASL_AUTHENTICATION_ERROR;
     378                 :            : 
     379                 :         16 :         state->step++;
     380                 :         16 :         return GSASL_OK;
     381                 :            :         break;
     382                 :            :       }
     383                 :            : 
     384                 :            :     default:
     385                 :            :       break;
     386                 :            :     }
     387                 :            : 
     388                 :         65 :   return res;
     389                 :            : }
     390                 :            : 
     391                 :            : void
     392                 :         30 : _gsasl_scram_sha1_client_finish (Gsasl_session * sctx, void *mech_data)
     393                 :            : {
     394                 :         30 :   struct scram_client_state *state = mech_data;
     395                 :            : 
     396         [ -  + ]:         30 :   if (!state)
     397                 :          0 :     return;
     398                 :            : 
     399                 :         30 :   free (state->cfmb);
     400                 :         30 :   free (state->serversignature);
     401                 :         30 :   free (state->authmessage);
     402                 :         30 :   scram_free_client_first (&state->cf);
     403                 :         30 :   scram_free_server_first (&state->sf);
     404                 :         30 :   scram_free_client_final (&state->cl);
     405                 :         30 :   scram_free_server_final (&state->sl);
     406                 :            : 
     407                 :         30 :   free (state);
     408                 :            : }

Generated by: LCOV version 1.8