src/transport/plugin_transport_http.h

   1 /*
   2      This file is part of GNUnet
   3      (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file transport/plugin_transport_http.h
  23  * @brief http transport service plugin
  24  * @author Matthias Wachs
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_common.h"
  29 #include "gnunet_constants.h"
  30 #include "gnunet_protocols.h"
  31 #include "gnunet_connection_lib.h"
  32 #include "gnunet_service_lib.h"
  33 #include "gnunet_statistics_service.h"
  34 #include "gnunet_transport_service.h"
  35 #include "gnunet_resolver_service.h"
  36 #include "gnunet_server_lib.h"
  37 #include "gnunet_container_lib.h"
  38 #include "gnunet_transport_plugin.h"
  39 #include "gnunet_os_lib.h"
  40 #include "gnunet_nat_lib.h"
  41 #include "microhttpd.h"
  42 #include <curl/curl.h>
  43
  44
  45 #define DEBUG_HTTP GNUNET_EXTRA_LOGGING
  46 #define VERBOSE_SERVER GNUNET_EXTRA_LOGGING
  47 #define VERBOSE_CLIENT GNUNET_EXTRA_LOGGING
  48 #define VERBOSE_CURL GNUNET_NO
  49
  50 #if BUILD_HTTPS
  51 #define LIBGNUNET_PLUGIN_TRANSPORT_INIT libgnunet_plugin_transport_https_init
  52 #define LIBGNUNET_PLUGIN_TRANSPORT_DONE libgnunet_plugin_transport_https_done
  53 #else
  54 #define LIBGNUNET_PLUGIN_TRANSPORT_INIT libgnunet_plugin_transport_http_init
  55 #define LIBGNUNET_PLUGIN_TRANSPORT_DONE libgnunet_plugin_transport_http_done
  56 #endif
  57
  58 #define INBOUND  GNUNET_YES
  59 #define OUTBOUND GNUNET_NO
  60
  61
  62 #define HTTP_NOT_VALIDATED_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 15)
  63
  64 /**
  65  * Encapsulation of all of the state of the plugin.
  66  */
  67 struct Plugin
  68 {
  69   /**
  70    * General handles
  71    * ---------------
  72    */
  73
  74   /**
  75    * Our environment.
  76    */
  77   struct GNUNET_TRANSPORT_PluginEnvironment *env;
  78
  79   /**
  80    * Linked list of open sessions.
  81    */
  82
  83   struct Session *head;
  84
  85   struct Session *tail;
  86
  87   /**
  88    * NAT handle & address management
  89    */
  90   struct GNUNET_NAT_Handle *nat;
  91
  92   /**
  93    * List of own addresses
  94    */
  95
  96   /**
  97    * IPv4 addresses DLL head
  98    */
  99   struct IPv4HttpAddressWrapper *ipv4_addr_head;
 100
 101   /**
 102    * IPv4 addresses DLL tail
 103    */
 104   struct IPv4HttpAddressWrapper *ipv4_addr_tail;
 105
 106   /**
 107    * IPv6 addresses DLL head
 108    */
 109   struct IPv6HttpAddressWrapper *ipv6_addr_head;
 110
 111   /**
 112    * IPv6 addresses DLL tail
 113    */
 114   struct IPv6HttpAddressWrapper *ipv6_addr_tail;
 115
 116   /**
 117    * Plugin configuration
 118    * --------------------
 119    */
 120
 121   /**
 122    * Plugin name
 123    * Equals configuration section: transport-http, transport-https
 124    */
 125   char *name;
 126
 127   /**
 128    * Plugin protocol
 129    * http, https
 130    */
 131   char *protocol;
 132
 133   /**
 134    * Use IPv4?
 135    * GNUNET_YES or GNUNET_NO
 136    */
 137   int ipv4;
 138
 139   /**
 140    * Use IPv6?
 141    * GNUNET_YES or GNUNET_NO
 142    */
 143   int ipv6;
 144
 145   /**
 146    * Does plugin just use outbound connections and not accept inbound?
 147    */
 148
 149   int client_only;
 150
 151   /**
 152    * Port used
 153    */
 154   uint16_t port;
 155
 156   /**
 157    * Maximum number of sockets the plugin can use
 158    * Each http inbound /outbound connections are two connections
 159    */
 160   int max_connections;
 161
 162   /**
 163    * Number of outbound sessions
 164    */
 165   unsigned int outbound_sessions;
 166
 167   /**
 168    * Number of inbound sessions
 169    */
 170   unsigned int inbound_sessions;
 171
 172   /**
 173    * Plugin HTTPS SSL/TLS options
 174    * ----------------------------
 175    */
 176
 177   /**
 178    * libCurl TLS crypto init string, can be set to enhance performance
 179    *
 180    * Example:
 181    *
 182    * Use RC4-128 instead of AES:
 183    * NONE:+VERS-TLS1.0:+ARCFOUR-128:+SHA1:+RSA:+COMP-NULL
 184    *
 185    */
 186   char *crypto_init;
 187
 188   /**
 189    * TLS key
 190    */
 191   char *key;
 192
 193   /**
 194    * TLS certificate
 195    */
 196   char *cert;
 197
 198   /**
 199    * Plugin values
 200    * -------------
 201    */
 202
 203   /**
 204    * Current number of establishes connections
 205    */
 206   int cur_connections;
 207
 208   /**
 209    * Last used unique HTTP connection tag
 210    */
 211   uint32_t last_tag;
 212
 213   /**
 214    * Server handles
 215    * --------------
 216    */
 217
 218   /**
 219    * MHD IPv4 daemon
 220    */
 221   struct MHD_Daemon *server_v4;
 222
 223   /**
 224    * MHD IPv4 task
 225    */
 226   GNUNET_SCHEDULER_TaskIdentifier server_v4_task;
 227
 228   /**
 229    * The IPv4 server is scheduled to run asap
 230    */
 231   int server_v4_immediately;
 232
 233   /**
 234    * MHD IPv6 daemon
 235    */
 236   struct MHD_Daemon *server_v6;
 237
 238   /**
 239    * MHD IPv4 task
 240    */
 241   GNUNET_SCHEDULER_TaskIdentifier server_v6_task;
 242
 243   /**
 244    * The IPv6 server is scheduled to run asap
 245    */
 246
 247   int server_v6_immediately;
 248
 249   /**
 250    * IPv4 server socket to bind to
 251    */
 252   struct sockaddr_in *server_addr_v4;
 253
 254   /**
 255    * IPv6 server socket to bind to
 256    */
 257   struct sockaddr_in6 *server_addr_v6;
 258
 259   /**
 260    * Server semi connections
 261    * A full session consists of 2 semi-connections: send and receive
 262    * If not both directions are established the server keeps this sessions here
 263    */
 264   struct Session *server_semi_head;
 265
 266   struct Session *server_semi_tail;
 267
 268   /*
 269    * Client handles
 270    */
 271
 272   /**
 273    * cURL Multihandle
 274    */
 275   CURLM *client_mh;
 276
 277   /**
 278    * curl perform task
 279    */
 280   GNUNET_SCHEDULER_TaskIdentifier client_perform_task;
 281
 282 };
 283
 284 GNUNET_NETWORK_STRUCT_BEGIN
 285
 286 /**
 287  * IPv4 addresses
 288  */
 289 struct IPv4HttpAddress
 290 {
 291   /**
 292    * IPv4 address, in network byte order.
 293    */
 294   uint32_t ipv4_addr GNUNET_PACKED;
 295
 296   /**
 297    * Port number, in network byte order.
 298    */
 299   uint16_t u4_port GNUNET_PACKED;
 300 };
 301
 302 /**
 303  * IPv4 addresses
 304  */
 305 struct IPv6HttpAddress
 306 {
 307   /**
 308    * IPv6 address.
 309    */
 310   struct in6_addr ipv6_addr GNUNET_PACKED;
 311
 312   /**
 313    * Port number, in network byte order.
 314    */
 315   uint16_t u6_port GNUNET_PACKED;
 316 };
 317 GNUNET_NETWORK_STRUCT_END
 318
 319
 320 struct ServerConnection
 321 {
 322   /* _RECV or _SEND */
 323   int direction;
 324
 325   /* Should this connection get disconnected? GNUNET_YES/NO  */
 326   int disconnect;
 327
 328   /* The session this server connection belongs to */
 329   struct Session *session;
 330
 331   /* The MHD connection */
 332   struct MHD_Connection *mhd_conn;
 333 };
 334
 335
 336
 337 /**
 338  * Session handle for connections.
 339  */
 340 struct Session
 341 {
 342   /**
 343    * To whom are we talking to
 344    */
 345   struct GNUNET_PeerIdentity target;
 346
 347   /**
 348    * Stored in a linked list.
 349    */
 350   struct Session *next;
 351
 352   /**
 353    * Stored in a linked list.
 354    */
 355   struct Session *prev;
 356
 357   /**
 358    * Pointer to the global plugin struct.
 359    */
 360   struct Plugin *plugin;
 361
 362   /**
 363    * Address
 364    */
 365   void *addr;
 366
 367   /**
 368    * Address length
 369    */
 370   size_t addrlen;
 371
 372   /**
 373    * ATS network type in NBO
 374    */
 375   uint32_t ats_address_network_type;
 376
 377   /**
 378    * next pointer for double linked list
 379    */
 380   struct HTTP_Message *msg_head;
 381
 382   /**
 383    * previous pointer for double linked list
 384    */
 385   struct HTTP_Message *msg_tail;
 386
 387
 388   /**
 389    * Message stream tokenizer for incoming data
 390    */
 391   struct GNUNET_SERVER_MessageStreamTokenizer *msg_tk;
 392
 393   /**
 394    * Absolute time when to receive data again
 395    * Used for receive throttling
 396    */
 397   struct GNUNET_TIME_Absolute next_receive;
 398
 399   /**
 400    * Inbound or outbound connection
 401    * Outbound: GNUNET_NO (client is used to send and receive)
 402    * Inbound : GNUNET_YES (server is used to send and receive)
 403    */
 404   int inbound;
 405
 406   /**
 407    * Unique HTTP/S connection tag for this connection
 408    */
 409   uint32_t tag;
 410
 411   /**
 412    * Client handles
 413    */
 414
 415   /**
 416    * Client send handle
 417    */
 418   void *client_put;
 419
 420   /**
 421    * Client receive handle
 422    */
 423   void *client_get;
 424
 425   /**
 426    * Task to wake up client receive handle when receiving is allowed again
 427    */
 428   GNUNET_SCHEDULER_TaskIdentifier recv_wakeup_task;
 429
 430   /**
 431    * Session timeout task
 432    */
 433   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
 434
 435   /**
 436    * Is client send handle paused since there are no data to send?
 437    * GNUNET_YES/NO
 438    */
 439   int client_put_paused;
 440
 441   /**
 442    * Server handles
 443    */
 444
 445   /**
 446    * Client send handle
 447    */
 448   struct ServerConnection *server_recv;
 449
 450   /**
 451    * Client send handle
 452    */
 453   struct ServerConnection *server_send;
 454 };
 455
 456 /**
 457  *  Message to send using http
 458  */
 459 struct HTTP_Message
 460 {
 461   /**
 462    * next pointer for double linked list
 463    */
 464   struct HTTP_Message *next;
 465
 466   /**
 467    * previous pointer for double linked list
 468    */
 469   struct HTTP_Message *prev;
 470
 471   /**
 472    * buffer containing data to send
 473    */
 474   char *buf;
 475
 476   /**
 477    * amount of data already sent
 478    */
 479   size_t pos;
 480
 481   /**
 482    * buffer length
 483    */
 484   size_t size;
 485
 486   /**
 487    * Continuation function to call once the transmission buffer
 488    * has again space available.  NULL if there is no
 489    * continuation to call.
 490    */
 491   GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
 492
 493   /**
 494    * Closure for transmit_cont.
 495    */
 496   void *transmit_cont_cls;
 497 };
 498
 499 struct Session *
 500 create_session (struct Plugin *plugin, const struct GNUNET_PeerIdentity *target,
 501                 const void *addr, size_t addrlen);
 502
 503 int
 504 exist_session (struct Plugin *plugin, struct Session *s);
 505
 506 void
 507 delete_session (struct Session *s);
 508
 509 int
 510 exist_session (struct Plugin *plugin, struct Session *s);
 511
 512 struct GNUNET_TIME_Relative
 513 http_plugin_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
 514                      const struct GNUNET_MessageHeader *message,
 515                      struct Session *session, const char *sender_address,
 516                      uint16_t sender_address_len);
 517
 518 const char *
 519 http_plugin_address_to_string (void *cls, const void *addr, size_t addrlen);
 520
 521 int
 522 client_disconnect (struct Session *s);
 523
 524 int
 525 client_connect (struct Session *s);
 526
 527 int
 528 client_send (struct Session *s, struct HTTP_Message *msg);
 529
 530 int
 531 client_start (struct Plugin *plugin);
 532
 533 void
 534 client_stop (struct Plugin *plugin);
 535
 536 int
 537 server_disconnect (struct Session *s);
 538
 539 int
 540 server_send (struct Session *s, struct HTTP_Message *msg);
 541
 542 int
 543 server_start (struct Plugin *plugin);
 544
 545 void
 546 server_stop (struct Plugin *plugin);
 547
 548 void
 549 notify_session_end (void *cls, const struct GNUNET_PeerIdentity *peer,
 550                     struct Session *s);
 551
 552 /* end of plugin_transport_http.h */