lib/security.c

   1 /* This source code was modified by Martin Hedenfalk <mhe@stacken.kth.se> for
   2  * use in Curl. His latest changes were done 2000-09-18.
   3  *
   4  * It has since been patched and modified a lot by Daniel Stenberg
   5  * <daniel@haxx.se> to make it better applied to curl conditions, and to make
   6  * it not use globals, pollute name space and more. This source code awaits a
   7  * rewrite to work around the paragraph 2 in the BSD licenses as explained
   8  * below.
   9  *
  10  * Copyright (c) 1998, 1999 Kungliga Tekniska Högskolan
  11  * (Royal Institute of Technology, Stockholm, Sweden).
  12  *
  13  * Copyright (C) 2001 - 2010, Daniel Stenberg, <daniel@haxx.se>, et al.
  14  *
  15  * All rights reserved.
  16  *
  17  * Redistribution and use in source and binary forms, with or without
  18  * modification, are permitted provided that the following conditions
  19  * are met:
  20  *
  21  * 1. Redistributions of source code must retain the above copyright
  22  *    notice, this list of conditions and the following disclaimer.
  23  *
  24  * 2. Redistributions in binary form must reproduce the above copyright
  25  *    notice, this list of conditions and the following disclaimer in the
  26  *    documentation and/or other materials provided with the distribution.
  27  *
  28  * 3. Neither the name of the Institute nor the names of its contributors
  29  *    may be used to endorse or promote products derived from this software
  30  *    without specific prior written permission.
  31  *
  32  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  33  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  34  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  35  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  36  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  37  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  38  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  39  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  40  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  41  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  42  * SUCH DAMAGE.  */
  43
  44 #include "setup.h"
  45
  46 #ifndef CURL_DISABLE_FTP
  47 #if defined(HAVE_KRB4) || defined(HAVE_GSSAPI)
  48
  49 #include <stdarg.h>
  50 #include <string.h>
  51
  52 #ifdef HAVE_NETDB_H
  53 #include <netdb.h>
  54 #endif
  55
  56 #ifdef HAVE_UNISTD_H
  57 #include <unistd.h>
  58 #endif
  59
  60 #include "urldata.h"
  61 #include "curl_base64.h"
  62 #include "curl_memory.h"
  63 #include "krb4.h"
  64 #include "ftp.h"
  65 #include "sendf.h"
  66 #include "rawstr.h"
  67
  68 /* The last #include file should be: */
  69 #include "memdebug.h"
  70
  71 static const struct {
  72   enum protection_level level;
  73   const char *name;
  74 } level_names[] = {
  75   { prot_clear, "clear" },
  76   { prot_safe, "safe" },
  77   { prot_confidential, "confidential" },
  78   { prot_private, "private" }
  79 };
  80
  81 static enum protection_level
  82 name_to_level(const char *name)
  83 {
  84   int i;
  85   for(i = 0; i < (int)sizeof(level_names)/(int)sizeof(level_names[0]); i++)
  86     if(checkprefix(name, level_names[i].name))
  87       return level_names[i].level;
  88   return (enum protection_level)-1;
  89 }
  90
  91 /* Convert a protocol |level| to its char representation.
  92    We take an int to catch programming mistakes. */
  93 static char level_to_char(int level) {
  94   switch(level) {
  95   case prot_clear:
  96     return 'C';
  97   case prot_safe:
  98     return 'S';
  99   case prot_confidential:
 100     return 'E';
 101   case prot_private:
 102     return 'P';
 103   case prot_cmd:
 104     /* Fall through */
 105   default:
 106     /* Those 2 cases should not be reached! */
 107     break;
 108   }
 109   DEBUGASSERT(0);
 110   /* Default to the most secure alternative. */
 111   return 'P';
 112 }
 113
 114 static const struct Curl_sec_client_mech * const mechs[] = {
 115 #if defined(HAVE_GSSAPI)
 116   &Curl_krb5_client_mech,
 117 #endif
 118 #if defined(HAVE_KRB4)
 119   &Curl_krb4_client_mech,
 120 #endif
 121   NULL
 122 };
 123
 124 /* Send an FTP command defined by |message| and the optional arguments. The
 125    function returns the ftp_code. If an error occurs, -1 is returned. */
 126 static int ftp_send_command(struct connectdata *conn, const char *message, ...)
 127 {
 128   int ftp_code;
 129   ssize_t nread;
 130   va_list args;
 131   char print_buffer[50];
 132
 133   va_start(args, message);
 134   vsnprintf(print_buffer, sizeof(print_buffer), message, args);
 135   va_end(args);
 136
 137   if(Curl_ftpsendf(conn, print_buffer) != CURLE_OK) {
 138     ftp_code = -1;
 139   }
 140   else {
 141     if(Curl_GetFTPResponse(&nread, conn, &ftp_code) != CURLE_OK)
 142       ftp_code = -1;
 143   }
 144
 145   (void)nread; /* Unused */
 146   return ftp_code;
 147 }
 148
 149 /* Read |len| from the socket |fd| and store it in |to|. Return a CURLcode
 150    saying whether an error occured or CURLE_OK if |len| was read. */
 151 static CURLcode
 152 socket_read(curl_socket_t fd, void *to, size_t len)
 153 {
 154   char *to_p = to;
 155   CURLcode code;
 156   ssize_t nread;
 157
 158   while(len > 0) {
 159     code = Curl_read_plain(fd, to_p, len, &nread);
 160     if(code == CURLE_OK) {
 161       len -= nread;
 162       to_p += nread;
 163     }
 164     else {
 165       /* FIXME: We are doing a busy wait */
 166       if(code == CURLE_AGAIN)
 167         continue;
 168       return code;
 169     }
 170   }
 171   return CURLE_OK;
 172 }
 173
 174
 175 /* Write |len| bytes from the buffer |to| to the socket |fd|. Return a
 176    CURLcode saying whether an error occured or CURLE_OK if |len| was
 177    written. */
 178 static CURLcode
 179 socket_write(struct connectdata *conn, curl_socket_t fd, const void *to,
 180              size_t len)
 181 {
 182   const char *to_p = to;
 183   CURLcode code;
 184   ssize_t written;
 185
 186   while(len > 0) {
 187     code = Curl_write_plain(conn, fd, to_p, len, &written);
 188     if(code == CURLE_OK) {
 189       len -= written;
 190       to_p += written;
 191     }
 192     else {
 193       /* FIXME: We are doing a busy wait */
 194       if(code == CURLE_AGAIN)
 195         continue;
 196       return code;
 197     }
 198   }
 199   return CURLE_OK;
 200 }
 201
 202 static CURLcode read_data(struct connectdata *conn,
 203                           curl_socket_t fd,
 204                           struct krb4buffer *buf)
 205 {
 206   int len;
 207   void* tmp;
 208   CURLcode ret;
 209
 210   ret = socket_read(fd, &len, sizeof(len));
 211   if (ret != CURLE_OK)
 212     return ret;
 213
 214   len = ntohl(len);
 215   tmp = realloc(buf->data, len);
 216   if (tmp == NULL)
 217     return CURLE_OUT_OF_MEMORY;
 218
 219   ret = socket_read(fd, buf->data, len);
 220   if (ret != CURLE_OK)
 221     return ret;
 222   buf->size = conn->mech->decode(conn->app_data, buf->data, len,
 223                                  conn->data_prot, conn);
 224   buf->index = 0;
 225   return CURLE_OK;
 226 }
 227
 228 static size_t
 229 buffer_read(struct krb4buffer *buf, void *data, size_t len)
 230 {
 231   if(buf->size - buf->index < len)
 232     len = buf->size - buf->index;
 233   memcpy(data, (char*)buf->data + buf->index, len);
 234   buf->index += len;
 235   return len;
 236 }
 237
 238 /* Matches Curl_recv signature */
 239 static ssize_t sec_recv(struct connectdata *conn, int sockindex,
 240                         char *buffer, size_t len, CURLcode *err)
 241 {
 242   size_t bytes_read;
 243   size_t total_read = 0;
 244   curl_socket_t fd = conn->sock[sockindex];
 245
 246   *err = CURLE_OK;
 247
 248   if(conn->in_buffer.eof_flag) {
 249     conn->in_buffer.eof_flag = 0;
 250     return 0;
 251   }
 252
 253   bytes_read = buffer_read(&conn->in_buffer, buffer, len);
 254   len -= bytes_read;
 255   total_read += bytes_read;
 256   buffer += bytes_read;
 257
 258   while(len > 0) {
 259     if(read_data(conn, fd, &conn->in_buffer) != CURLE_OK)
 260       return -1;
 261     if(conn->in_buffer.size == 0) {
 262       if(bytes_read > 0)
 263         conn->in_buffer.eof_flag = 1;
 264       return bytes_read;
 265     }
 266     bytes_read = buffer_read(&conn->in_buffer, buffer, len);
 267     len -= bytes_read;
 268     total_read += bytes_read;
 269     buffer += bytes_read;
 270   }
 271   /* FIXME: Check for overflow */
 272   return total_read;
 273 }
 274
 275 /* Send |length| bytes from |from| to the |fd| socket taking care of encoding
 276    and negociating with the server. |from| can be NULL. */
 277 /* FIXME: We don't check for errors nor report any! */
 278 static void do_sec_send(struct connectdata *conn, curl_socket_t fd,
 279                         const char *from, int length)
 280 {
 281   size_t bytes;
 282   size_t htonl_bytes;
 283   char *buffer;
 284   char *cmd_buffer;
 285   enum protection_level prot_level = conn->data_prot;
 286   bool iscmd = prot_level == prot_cmd;
 287
 288   if(iscmd) {
 289     if(!strncmp(from, "PASS ", 5) || !strncmp(from, "ACCT ", 5))
 290       prot_level = prot_private;
 291     else
 292       prot_level = conn->command_prot;
 293   }
 294   bytes = conn->mech->encode(conn->app_data, from, length, prot_level,
 295                              (void**)&buffer, conn);
 296   if(iscmd) {
 297     bytes = Curl_base64_encode(conn->data, buffer, bytes, &cmd_buffer);
 298     if(bytes > 0) {
 299       static const char *enc = "ENC ";
 300       static const char *mic = "MIC ";
 301       if(prot_level == prot_private)
 302         socket_write(conn, fd, enc, 4);
 303       else
 304         socket_write(conn, fd, mic, 4);
 305
 306       socket_write(conn, fd, cmd_buffer, bytes);
 307       socket_write(conn, fd, "\r\n", 2);
 308       infof(conn->data, "Send: %s%s", prot_level == prot_private?enc:mic,
 309             cmd_buffer);
 310       free(cmd_buffer);
 311     }
 312   }
 313   else {
 314     htonl_bytes = htonl(bytes);
 315     socket_write(conn, fd, &htonl_bytes, sizeof(htonl_bytes));
 316     socket_write(conn, fd, buffer, bytes);
 317   }
 318   free(buffer);
 319 }
 320
 321 static ssize_t sec_write(struct connectdata *conn, curl_socket_t fd,
 322                          const char *buffer, size_t length)
 323 {
 324   /* FIXME: Check for overflow */
 325   ssize_t len = conn->buffer_size;
 326   int tx = 0;
 327
 328   len -= conn->mech->overhead(conn->app_data, conn->data_prot, len);
 329   if(len <= 0)
 330     len = length;
 331   while(length) {
 332     if(len >= 0 || length < (size_t)len) {
 333       /* FIXME: Check for overflow. */
 334       len = length;
 335     }
 336     do_sec_send(conn, fd, buffer, len);
 337     length -= len;
 338     buffer += len;
 339     tx += len;
 340   }
 341   return tx;
 342 }
 343
 344 /* FIXME: fd should be a curl_socket_t */
 345 int Curl_sec_fflush_fd(struct connectdata *conn, int fd)
 346 {
 347   if(conn->data_prot == prot_clear)
 348     return 0;
 349
 350   /* Force a flush by trying to send no data */
 351   do_sec_send(conn, fd, NULL, 0);
 352   return 0;
 353 }
 354
 355 /* Matches Curl_send signature */
 356 static ssize_t sec_send(struct connectdata *conn, int sockindex,
 357                         const void *buffer, size_t len, CURLcode *err)
 358 {
 359   curl_socket_t fd = conn->sock[sockindex];
 360   *err = CURLE_OK;
 361   return sec_write(conn, fd, buffer, len);
 362 }
 363
 364 /* FIXME: |level| should not be an int but a struct protection_level */
 365 int Curl_sec_read_msg(struct connectdata *conn, char *buffer, int level)
 366 {
 367   /* decoded_len should be size_t or ssize_t but conn->mech->decode returns an
 368      int */
 369   int decoded_len;
 370   char *buf;
 371   int ret_code;
 372
 373   decoded_len = Curl_base64_decode(buffer + 4, (unsigned char **)&buf);
 374   if(decoded_len <= 0) {
 375     free(buf);
 376     return -1;
 377   }
 378
 379   decoded_len = conn->mech->decode(conn->app_data, buf, decoded_len,
 380                                    level, conn);
 381   if(decoded_len <= 0) {
 382     free(buf);
 383     return -1;
 384   }
 385
 386   if(conn->data->set.verbose) {
 387     buf[decoded_len] = '\n';
 388     Curl_debug(conn->data, CURLINFO_HEADER_IN, buf, decoded_len + 1, conn);
 389   }
 390
 391   buf[decoded_len] = '\0';
 392   DEBUGASSERT(decoded_len > 3);
 393   if(buf[3] == '-')
 394     ret_code = 0;
 395   else {
 396     /* Check for error? */
 397     sscanf(buf, "%d", &ret_code);
 398   }
 399
 400   if(buf[decoded_len - 1] == '\n')
 401     buf[decoded_len - 1] = '\0';
 402   /* FIXME: Is |buffer| length always greater than |decoded_len|? */
 403   strcpy(buffer, buf);
 404   free(buf);
 405   return ret_code;
 406 }
 407
 408 enum protection_level
 409 Curl_set_command_prot(struct connectdata *conn, enum protection_level level)
 410 {
 411   enum protection_level old = conn->command_prot;
 412   conn->command_prot = level;
 413   return old;
 414 }
 415
 416 /* FIXME: The error code returned here is never checked. */
 417 int Curl_sec_set_protection_level(struct connectdata *conn)
 418 {
 419   int code;
 420   char* pbsz;
 421   static unsigned int buffer_size = 1 << 20; /* 1048576 */
 422   enum protection_level level = conn->request_data_prot;
 423
 424   if(!conn->sec_complete) {
 425     infof(conn->data, "Trying to change the protection level after the"
 426                       "completion of the data exchange.");
 427     return -1;
 428   }
 429
 430   /* Bail out if we try to set up the same level */
 431   if(conn->data_prot == level)
 432     return 0;
 433
 434   if(level) {
 435     code = ftp_send_command(conn, "PSBZ %u", buffer_size);
 436     if(code < 0)
 437       return -1;
 438
 439     if(code/100 != 2) {
 440       failf(conn->data, "Failed to set the protection's buffer size.");
 441       return -1;
 442     }
 443     conn->buffer_size = buffer_size;
 444
 445     pbsz = strstr(conn->data->state.buffer, "PBSZ=");
 446     if(pbsz) {
 447       /* FIXME: Checks for errors in sscanf? */
 448       sscanf(pbsz, "PBSZ=%u", &buffer_size);
 449       if(buffer_size < conn->buffer_size)
 450         conn->buffer_size = buffer_size;
 451     }
 452   }
 453
 454   /* Now try to negiociate the protection level. */
 455   code = ftp_send_command(conn, "PROT %c", level_to_char(level));
 456
 457   if(code < 0)
 458     return -1;
 459
 460   if(code/100 != 2) {
 461     failf(conn->data, "Failed to set the protection level.");
 462     return -1;
 463   }
 464
 465   conn->data_prot = level;
 466   if(level == prot_private)
 467     conn->command_prot = level;
 468
 469   return 0;
 470 }
 471
 472 int
 473 Curl_sec_request_prot(struct connectdata *conn, const char *level)
 474 {
 475   int l = name_to_level(level);
 476   if(l == -1)
 477     return -1;
 478   conn->request_data_prot = (enum protection_level)l;
 479   return 0;
 480 }
 481
 482 static CURLcode choose_mech(struct connectdata *conn)
 483 {
 484   int ret;
 485   struct SessionHandle *data = conn->data;
 486   const struct Curl_sec_client_mech * const *mech;
 487   void *tmp_allocation;
 488   const char *mech_name;
 489
 490   for(mech = mechs; (*mech); ++mech) {
 491     mech_name = (*mech)->name;
 492     /* We have no mechanism with a NULL name but keep this check */
 493     DEBUGASSERT(mech_name != NULL);
 494     if(mech_name == NULL) {
 495       infof(data, "Skipping mechanism with empty name (%p)", mech);
 496       continue;
 497     }
 498     tmp_allocation = realloc(conn->app_data, (*mech)->size);
 499     if(tmp_allocation == NULL) {
 500       failf(data, "Failed realloc of size %u", (*mech)->size);
 501       mech = NULL;
 502       return CURLE_OUT_OF_MEMORY;
 503     }
 504     conn->app_data = tmp_allocation;
 505
 506     if((*mech)->init) {
 507       ret = (*mech)->init(conn);
 508       if(ret != 0) {
 509         infof(data, "Failed initialization for %s. Skipping it.", mech_name);
 510         continue;
 511       }
 512     }
 513
 514     infof(data, "Trying mechanism %s...", mech_name);
 515     ret = ftp_send_command(conn, "AUTH %s", mech_name);
 516     if(ret < 0)
 517       /* FIXME: This error is too generic but it is OK for now. */
 518       return CURLE_COULDNT_CONNECT;
 519
 520     if(ret/100 != 3) {
 521       switch(ret) {
 522       case 504:
 523         infof(data, "Mechanism %s is not supported by the server (server "
 524                     "returned ftp code: 504).", mech_name);
 525         break;
 526       case 534:
 527         infof(data, "Mechanism %s was rejected by the server (server returned "
 528                     "ftp code: 534).", mech_name);
 529         break;
 530       default:
 531         if(ret/100 == 5) {
 532           infof(data, "The server does not support the security extensions.");
 533           return CURLE_USE_SSL_FAILED;
 534         }
 535         break;
 536       }
 537       continue;
 538     }
 539
 540     /* Authenticate */
 541     ret = (*mech)->auth(conn->app_data, conn);
 542
 543     if(ret == AUTH_CONTINUE)
 544       continue;
 545     else if(ret != AUTH_OK) {
 546       /* Mechanism has dumped the error to stderr, don't error here. */
 547       return -1;
 548     }
 549     DEBUGASSERT(ret == AUTH_OK);
 550
 551     conn->mech = *mech;
 552     conn->sec_complete = 1;
 553     if (conn->data_prot != prot_clear) {
 554       conn->recv[FIRSTSOCKET] = sec_recv;
 555       conn->send[FIRSTSOCKET] = sec_send;
 556       conn->recv[SECONDARYSOCKET] = sec_recv;
 557       conn->send[SECONDARYSOCKET] = sec_send;
 558     }
 559     conn->command_prot = prot_safe;
 560     /* Set the requested protection level */
 561     /* BLOCKING */
 562     Curl_sec_set_protection_level(conn);
 563     break;
 564   }
 565
 566   return mech != NULL ? CURLE_OK : CURLE_FAILED_INIT;
 567 }
 568
 569 int
 570 Curl_sec_login(struct connectdata *conn)
 571 {
 572   CURLcode code = choose_mech(conn);
 573   return code == CURLE_OK;
 574 }
 575
 576
 577 void
 578 Curl_sec_end(struct connectdata *conn)
 579 {
 580   if(conn->mech != NULL) {
 581     if(conn->mech->end)
 582       conn->mech->end(conn->app_data);
 583     free(conn->app_data);
 584     conn->app_data = NULL;
 585   }
 586   conn->sec_complete = 0;
 587   conn->data_prot = (enum protection_level)0;
 588   conn->mech = NULL;
 589 }
 590
 591 #endif /* HAVE_KRB4 || HAVE_GSSAPI */
 592
 593 #endif /* CURL_DISABLE_FTP */