http-conn: pass all HTTP headers into callback function
[siplcs.git] / src / core / http-conn.c
blobe77c7db67ec1a341e75f3b516009f66d339e410e
1 /**
2 * @file http-conn.c
4 * pidgin-sipe
6 * Copyright (C) 2010 SIPE Project <http://sipe.sourceforge.net/>
7 * Copyright (C) 2009 pier11 <pier11@operamail.com>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 /**
26 * Operates with HTTPS connection.
27 * Support Negotiate (Windows only) and NTLM authentications, redirect, cookie, GET/POST.
30 #ifdef HAVE_CONFIG_H
31 #include "config.h"
32 #endif
34 #include <stdlib.h>
35 #include <string.h>
37 #include <glib.h>
39 #include "http-conn.h"
40 #include "sipmsg.h"
41 #include "sip-sec.h"
42 #include "sipe-backend.h"
43 #include "sipe-core.h"
44 #include "sipe-core-private.h"
45 #include "sipe-utils.h"
47 /**
48 * HTTP header
49 * @param method (%s) Ex.: GET or POST
50 * @param url (%s) Ex.: /EWS/Exchange.asmx
51 * @param host (%s) Ex.: cosmo-ocs-r2.cosmo.local
53 #define HTTP_CONN_HEADER \
54 "%s %s HTTP/1.1\r\n"\
55 "Host: %s\r\n"\
56 "User-Agent: Sipe/" PACKAGE_VERSION "\r\n"
59 struct http_conn_struct {
60 struct sipe_core_public *sipe_public;
62 /* GET, POST */
63 char *method;
64 guint conn_type;
65 gboolean allow_redirect;
66 char *host;
67 guint port;
68 char *url;
69 char *body;
70 char *content_type;
71 gchar *additional_headers;
72 HttpConnAuth *auth;
73 HttpConnCallback callback;
74 void *data;
76 struct sipe_transport_connection *conn;
78 SipSecContext sec_ctx;
79 int retries;
81 HttpSession *http_session;
83 /* if server sends "Connection: close" header */
84 gboolean closed;
85 HttpConn* do_close;
87 #define HTTP_CONN ((HttpConn *) conn->user_data)
89 struct http_session_struct {
90 char *cookie;
93 static HttpConn*
94 http_conn_clone(HttpConn* http_conn)
96 HttpConn *res = g_new0(HttpConn, 1);
98 res->http_session = http_conn->http_session;
99 res->method = g_strdup(http_conn->method);
100 res->conn_type = http_conn->conn_type;
101 res->allow_redirect = http_conn->allow_redirect;
102 res->host = g_strdup(http_conn->host);
103 res->port = http_conn->port;
104 res->url = g_strdup(http_conn->url);
105 res->body = g_strdup(http_conn->body);
106 res->content_type = g_strdup(http_conn->content_type);
107 res->additional_headers = g_strdup(http_conn->additional_headers);
108 res->auth = http_conn->auth;
109 res->callback = http_conn->callback;
110 res->data = http_conn->data;
112 res->conn = http_conn->conn;
113 res->sec_ctx = http_conn->sec_ctx;
114 res->retries = http_conn->retries;
116 res->do_close = NULL;
118 return res;
121 void
122 http_conn_free(HttpConn* http_conn)
124 if (!http_conn) return;
126 /* make sure also pending connections are released */
127 sipe_backend_transport_disconnect(http_conn->conn);
129 /* don't free "http_conn->http_session" - client should do */
130 g_free(http_conn->method);
131 g_free(http_conn->host);
132 g_free(http_conn->url);
133 g_free(http_conn->body);
134 g_free(http_conn->content_type);
135 g_free(http_conn->additional_headers);
137 if (http_conn->sec_ctx) {
138 sip_sec_destroy_context(http_conn->sec_ctx);
141 g_free(http_conn);
144 gboolean
145 http_conn_is_closed(HttpConn *http_conn)
147 return http_conn->closed;
150 HttpSession *
151 http_conn_session_create()
153 HttpSession *res = g_new0(HttpSession, 1);
154 return res;
157 void
158 http_conn_session_free(HttpSession *http_session)
160 if (!http_session) return;
162 g_free(http_session->cookie);
163 g_free(http_session);
166 void
167 http_conn_set_close(HttpConn* http_conn)
169 http_conn->do_close = http_conn;
172 static void
173 http_conn_close(HttpConn *http_conn, const char *message)
175 SIPE_DEBUG_INFO("http_conn_close: closing http connection: %s", message ? message : "");
176 http_conn_free(http_conn);
180 * Extracts host, port and relative url
181 * Ex. url: https://machine.domain.Contoso.com/EWS/Exchange.asmx
183 * Allocates memory, must be g_free'd.
185 static void
186 http_conn_parse_url(const char *url,
187 char **host,
188 guint *port,
189 char **rel_url)
191 char **parts = g_strsplit(url, "://", 2);
192 char *no_proto;
193 guint port_tmp;
194 char *tmp;
195 char *host_port;
197 /* Make sure we always return valid information */
198 if (host) *host = NULL;
199 if (rel_url) *rel_url = NULL;
201 if(!parts) {
202 return;
203 } else if(!parts[0]) {
204 g_strfreev(parts);
205 return;
208 no_proto = parts[1] ? g_strdup(parts[1]) : g_strdup(parts[0]);
209 port_tmp = sipe_strequal(parts[0], "https") ? 443 : 80;
210 g_strfreev(parts);
212 if(!no_proto) {
213 return;
216 tmp = strstr(no_proto, "/");
217 if (tmp && rel_url) *rel_url = g_strdup(tmp);
218 host_port = tmp ? g_strndup(no_proto, tmp - no_proto) : g_strdup(no_proto);
219 g_free(no_proto);
221 if(!host_port) {
222 return;
225 parts = g_strsplit(host_port, ":", 2);
227 if(parts) {
228 if (host) *host = g_strdup(parts[0]);
229 if(parts[0]) {
230 port_tmp = parts[1] ? (guint) atoi(parts[1]) : port_tmp;
232 if (port) *port = port_tmp;
233 g_strfreev(parts);
236 g_free(host_port);
239 static void http_conn_error(struct sipe_transport_connection *conn,
240 const gchar *msg)
242 HttpConn *http_conn = HTTP_CONN;
243 if (http_conn->callback) {
244 (*http_conn->callback)(HTTP_CONN_ERROR, NULL, NULL, http_conn, http_conn->data);
246 http_conn_close(http_conn, msg);
249 static void http_conn_send0(HttpConn *http_conn,
250 const char *authorization);
251 static void http_conn_connected(struct sipe_transport_connection *conn)
253 http_conn_send0(HTTP_CONN, NULL);
256 static void http_conn_input(struct sipe_transport_connection *conn);
257 static struct sipe_transport_connection *http_conn_setup(HttpConn *http_conn,
258 struct sipe_core_public *sipe_public,
259 guint type,
260 const gchar *host,
261 guint port) {
262 sipe_connect_setup setup = {
263 type,
264 host,
265 port,
266 http_conn,
267 http_conn_connected,
268 http_conn_input,
269 http_conn_error
272 if (!host) {
273 http_conn_close(http_conn, "Missing host");
274 return NULL;
277 return(sipe_backend_transport_connect(sipe_public, &setup));
280 HttpConn *
281 http_conn_create(struct sipe_core_public *sipe_public,
282 HttpSession *http_session,
283 const char *method,
284 guint conn_type,
285 gboolean allow_redirect,
286 const char *full_url,
287 const char *body,
288 const char *content_type,
289 const gchar *additional_headers,
290 HttpConnAuth *auth,
291 HttpConnCallback callback,
292 void *data)
294 HttpConn *http_conn;
295 struct sipe_transport_connection *conn;
296 gchar *host, *url;
297 guint port;
299 if (!full_url || (strlen(full_url) == 0)) {
300 SIPE_DEBUG_INFO_NOFORMAT("no URL supplied!");
301 return NULL;
304 http_conn_parse_url(full_url, &host, &port, &url);
305 http_conn = g_new0(HttpConn, 1);
306 conn = http_conn_setup(http_conn, sipe_public, conn_type, host, port);
307 if (!conn) {
308 // http_conn_setup deallocates http_conn on error, don't free here
309 g_free(host);
310 g_free(url);
311 return NULL;
314 http_conn->sipe_public = sipe_public;
315 conn->user_data = http_conn;
317 http_conn->http_session = http_session;
318 http_conn->method = g_strdup(method);
319 http_conn->conn_type = conn_type;
320 http_conn->allow_redirect = allow_redirect;
321 http_conn->host = host;
322 http_conn->port = port;
323 http_conn->url = url;
324 http_conn->body = g_strdup(body);
325 http_conn->content_type = g_strdup(content_type);
326 http_conn->additional_headers = g_strdup(additional_headers);
327 http_conn->auth = auth;
328 http_conn->callback = callback;
329 http_conn->data = data;
330 http_conn->conn = conn;
332 return http_conn;
335 /* Data part */
336 static void
337 http_conn_send0(HttpConn *http_conn,
338 const char *authorization)
340 GString *outstr;
342 if (!http_conn->host || !http_conn->url) return;
344 outstr = g_string_new("");
345 g_string_append_printf(outstr, HTTP_CONN_HEADER,
346 http_conn->method ? http_conn->method : "GET",
347 http_conn->url,
348 http_conn->host);
349 if (sipe_strequal(http_conn->method, "POST")) {
350 g_string_append_printf(outstr, "Content-Length: %d\r\n",
351 http_conn->body ? (int)strlen(http_conn->body) : 0);
353 g_string_append_printf(outstr, "Content-Type: %s\r\n",
354 http_conn->content_type ? http_conn->content_type : "text/plain");
356 if (http_conn->http_session && http_conn->http_session->cookie) {
357 g_string_append_printf(outstr, "Cookie: %s\r\n", http_conn->http_session->cookie);
359 if (authorization) {
360 g_string_append_printf(outstr, "Authorization: %s\r\n", authorization);
362 if (http_conn->additional_headers) {
363 g_string_append(outstr, http_conn->additional_headers);
366 g_string_append_printf(outstr, "\r\n%s", http_conn->body ? http_conn->body : "");
368 sipe_utils_message_debug("HTTP", outstr->str, NULL, TRUE);
369 sipe_backend_transport_message(http_conn->conn, outstr->str);
370 g_string_free(outstr, TRUE);
373 void
374 http_conn_send( HttpConn *http_conn,
375 const char *method,
376 const char *full_url,
377 const char *body,
378 const char *content_type,
379 HttpConnCallback callback,
380 void *data)
382 if (!http_conn) {
383 SIPE_DEBUG_INFO_NOFORMAT("http_conn_send: NULL http_conn, exiting.");
384 return;
387 g_free(http_conn->method);
388 g_free(http_conn->url);
389 g_free(http_conn->body);
390 g_free(http_conn->content_type);
391 http_conn->method = g_strdup(method);
392 http_conn_parse_url(full_url, NULL, NULL, &http_conn->url);
393 http_conn->body = g_strdup(body);
394 http_conn->content_type = g_strdup(content_type);
395 http_conn->callback = callback;
396 http_conn->data = data;
398 http_conn_send0(http_conn, NULL);
401 static void
402 http_conn_process_input_message(HttpConn *http_conn,
403 struct sipmsg *msg)
405 /* Redirect */
406 if ((msg->response == 300 ||
407 msg->response == 301 ||
408 msg->response == 302 ||
409 msg->response == 307) &&
410 http_conn->allow_redirect)
412 const char *location = sipmsg_find_header(msg, "Location");
413 gchar *host, *url;
414 guint port;
416 SIPE_DEBUG_INFO("http_conn_process_input_message: Redirect to: %s", location ? location : "");
417 http_conn_parse_url(location, &host, &port, &url);
419 if (host) {
420 http_conn->do_close = http_conn_clone(http_conn);
421 http_conn->sec_ctx = NULL;
423 g_free(http_conn->host);
424 g_free(http_conn->url);
426 http_conn->host = host;
427 http_conn->port = port;
428 http_conn->url = url;
430 http_conn->conn = http_conn_setup(http_conn,
431 http_conn->sipe_public,
432 http_conn->conn_type,
433 host,
434 port);
435 } else {
436 SIPE_DEBUG_ERROR_NOFORMAT("http_conn_process_input_message: no redirect host");
437 g_free(url);
438 return;
441 /* Authentication required */
442 else if (msg->response == 401) {
443 const gchar *auth_hdr = NULL;
444 guint auth_type;
445 const char *auth_name;
446 char *authorization;
447 char *output_toked_base64;
448 int use_sso = !http_conn->auth || (http_conn->auth && !http_conn->auth->user);
449 long ret = -1;
451 http_conn->retries++;
452 if (http_conn->retries > 2) {
453 if (http_conn->callback) {
454 (*http_conn->callback)(HTTP_CONN_ERROR_FATAL, NULL, NULL, http_conn, http_conn->data);
456 SIPE_DEBUG_INFO_NOFORMAT("http_conn_process_input_message: Authentication failed");
457 http_conn_set_close(http_conn);
458 return;
461 #ifdef HAVE_SSPI
462 if (http_conn->auth && http_conn->auth->use_negotiate)
463 auth_hdr = sipmsg_find_auth_header(msg, "Negotiate");
464 if (auth_hdr) {
465 auth_type = AUTH_TYPE_NEGOTIATE;
466 auth_name = "Negotiate";
467 } else {
468 #endif
469 auth_hdr = sipmsg_find_auth_header(msg, "NTLM");
470 auth_type = AUTH_TYPE_NTLM;
471 auth_name = "NTLM";
472 #ifdef HAVE_SSPI
474 #endif
475 if (!auth_hdr) {
476 if (http_conn->callback) {
477 (*http_conn->callback)(HTTP_CONN_ERROR_FATAL, NULL, NULL, http_conn, http_conn->data);
479 #ifdef HAVE_SSPI
480 #define AUTHSTRING "NTLM and Negotiate authentications are"
481 #else /* !HAVE_SSPI */
482 #define AUTHSTRING "NTLM authentication is"
483 #endif /* HAVE_SSPI */
484 SIPE_DEBUG_INFO("http_conn_process_input_message: Only %s supported in the moment, exiting",
485 AUTHSTRING
487 http_conn_set_close(http_conn);
488 return;
491 if (!http_conn->sec_ctx) {
492 http_conn->sec_ctx =
493 sip_sec_create_context(auth_type,
494 use_sso,
496 http_conn->auth && http_conn->auth->domain ? http_conn->auth->domain : "",
497 http_conn->auth ? http_conn->auth->user : NULL,
498 http_conn->auth ? http_conn->auth->password : NULL);
501 if (http_conn->sec_ctx) {
502 char **parts = g_strsplit(auth_hdr, " ", 0);
503 char *spn = g_strdup_printf("HTTP/%s", http_conn->host);
504 ret = sip_sec_init_context_step(http_conn->sec_ctx,
505 spn,
506 parts[1],
507 &output_toked_base64,
508 NULL);
509 g_free(spn);
510 g_strfreev(parts);
513 if (ret < 0) {
514 if (http_conn->callback) {
515 (*http_conn->callback)(HTTP_CONN_ERROR_FATAL, NULL, NULL, http_conn, http_conn->data);
517 SIPE_DEBUG_INFO_NOFORMAT("http_conn_process_input_message: Failed to initialize security context");
518 http_conn_set_close(http_conn);
519 return;
522 authorization = g_strdup_printf("%s %s", auth_name, output_toked_base64 ? output_toked_base64 : "");
523 g_free(output_toked_base64);
525 http_conn_send0(http_conn, authorization);
526 g_free(authorization);
528 /* Other response */
529 else {
530 const char *set_cookie_hdr;
531 http_conn->retries = 0;
533 /* Set cookies.
534 * Set-Cookie: RMID=732423sdfs73242; expires=Fri, 31-Dec-2010 23:59:59 GMT; path=/; domain=.example.net
536 if (http_conn->http_session && (set_cookie_hdr = sipmsg_find_header(msg, "Set-Cookie"))) {
537 char **parts;
538 char *tmp;
539 int i;
541 g_free(http_conn->http_session->cookie);
542 http_conn->http_session->cookie = NULL;
544 parts = g_strsplit(set_cookie_hdr, ";", 0);
545 for (i = 0; parts[i]; i++) {
546 if (!strstr(parts[i], "path=") &&
547 !strstr(parts[i], "domain=") &&
548 !strstr(parts[i], "expires=") &&
549 !strstr(parts[i], "secure"))
551 tmp = http_conn->http_session->cookie;
552 http_conn->http_session->cookie = !tmp ?
553 g_strdup(parts[i]) :
554 g_strconcat(http_conn->http_session->cookie, ";", parts[i], NULL);
555 g_free(tmp);
558 g_strfreev(parts);
559 SIPE_DEBUG_INFO("http_conn_process_input_message: Set cookie: %s",
560 http_conn->http_session->cookie ? http_conn->http_session->cookie : "");
563 if (http_conn->callback) {
564 (*http_conn->callback)(msg->response, msg->body, msg->headers, http_conn, http_conn->data);
569 static void http_conn_input(struct sipe_transport_connection *conn)
571 HttpConn *http_conn = HTTP_CONN;
572 char *cur = conn->buffer;
574 /* according to the RFC remove CRLF at the beginning */
575 while (*cur == '\r' || *cur == '\n') {
576 cur++;
578 if (cur != conn->buffer)
579 sipe_utils_shrink_buffer(conn, cur);
581 while ((cur = strstr(conn->buffer, "\r\n\r\n")) != NULL) {
582 struct sipmsg *msg;
583 guint remainder;
585 cur += 2;
586 cur[0] = '\0';
587 msg = sipmsg_parse_header(conn->buffer);
589 /* HTTP/1.1 Transfer-Encoding: chunked */
590 if (msg && (msg->bodylen == SIPMSG_BODYLEN_CHUNKED)) {
591 gchar *start = cur + 2;
592 GSList *chunks = NULL;
593 gboolean incomplete = TRUE;
595 msg->bodylen = 0;
596 while (strlen(start) > 0) {
597 gchar *tmp;
598 guint length = strtol(start, &tmp, 16);
599 struct _chunk {
600 guint length;
601 const gchar *start;
602 } *chunk;
604 /* Illegal number */
605 if ((length == 0) && (start == tmp))
606 break;
607 msg->bodylen += length;
609 /* Chunk header not finished yet */
610 tmp = strstr(tmp, "\r\n");
611 if (tmp == NULL)
612 break;
614 /* Chunk not finished yet */
615 tmp += 2;
616 remainder = conn->buffer_used - (tmp - conn->buffer);
617 if (remainder < length + 2)
618 break;
620 /* Next chunk */
621 start = tmp + length + 2;
623 /* Body completed */
624 if (length == 0) {
625 gchar *dummy = g_malloc(msg->bodylen + 1);
626 gchar *p = dummy;
627 GSList *entry = chunks;
629 while (entry) {
630 chunk = entry->data;
631 memcpy(p, chunk->start, chunk->length);
632 p += chunk->length;
633 entry = entry->next;
635 p[0] = '\0';
637 msg->body = dummy;
638 sipe_utils_message_debug("HTTP",
639 conn->buffer,
640 msg->body,
641 FALSE);
643 cur = start;
644 sipe_utils_shrink_buffer(conn, cur);
646 incomplete = FALSE;
647 break;
650 /* Append completed chunk */
651 chunk = g_new0(struct _chunk, 1);
652 chunk->length = length;
653 chunk->start = tmp;
654 chunks = g_slist_append(chunks, chunk);
657 if (chunks) {
658 GSList *entry = chunks;
659 while (entry) {
660 g_free(entry->data);
661 entry = entry->next;
663 g_slist_free(chunks);
666 if (incomplete) {
667 /* restore header for next try */
668 sipmsg_free(msg);
669 cur[0] = '\r';
670 return;
673 } else {
674 cur += 2;
675 remainder = conn->buffer_used - (cur - conn->buffer);
676 if (msg && remainder >= (guint) msg->bodylen) {
677 char *dummy = g_malloc(msg->bodylen + 1);
678 memcpy(dummy, cur, msg->bodylen);
679 dummy[msg->bodylen] = '\0';
680 msg->body = dummy;
681 cur += msg->bodylen;
682 sipe_utils_message_debug("HTTP",
683 conn->buffer,
684 msg->body,
685 FALSE);
686 sipe_utils_shrink_buffer(conn, cur);
687 } else {
688 if (msg){
689 SIPE_DEBUG_INFO("process_input: body too short (%d < %d, strlen %d) - ignoring message", remainder, msg->bodylen, (int)strlen(conn->buffer));
690 sipmsg_free(msg);
693 /* restore header for next try */
694 cur[-2] = '\r';
695 return;
699 /* important to set before callback call */
700 if (sipe_strcase_equal(sipmsg_find_header(msg, "Connection"), "close")) {
701 http_conn->closed = TRUE;
704 http_conn_process_input_message(http_conn, msg);
706 sipmsg_free(msg);
709 if (http_conn->closed) {
710 http_conn_close(http_conn->do_close, "Server closed connection");
711 } else if (http_conn->do_close) {
712 http_conn_close(http_conn->do_close, "User initiated");
717 Local Variables:
718 mode: c
719 c-file-style: "bsd"
720 indent-tabs-mode: t
721 tab-width: 8
722 End: