include/vlc_http.h

   1 /*****************************************************************************
   2  * vlc_http.h: Shared code for HTTP clients
   3  *****************************************************************************
   4  * Copyright (C) 2001-2008 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   8  *          Christophe Massiot <massiot@via.ecp.fr>
   9  *          Rémi Denis-Courmont <rem # videolan.org>
  10  *          Antoine Cellerier <dionoea at videolan dot org>
  11  *
  12  * This program is free software; you can redistribute it and/or modify it
  13  * under the terms of the GNU Lesser General Public License as published by
  14  * the Free Software Foundation; either version 2.1 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  20  * GNU Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * along with this program; if not, write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  25  *****************************************************************************/
  26
  27 #ifndef VLC_HTTP_H
  28 #define VLC_HTTP_H 1
  29
  30 /**
  31  * \file
  32  * This file defines functions, structures, enums and macros shared between
  33  * HTTP clients.
  34  */
  35
  36 #include <vlc_url.h>
  37 #include <vlc_arrays.h>
  38
  39 /* RFC 2617: Basic and Digest Access Authentication */
  40 typedef struct vlc_http_auth_t
  41 {
  42     char *psz_realm;
  43     char *psz_domain;
  44     char *psz_nonce;
  45     char *psz_opaque;
  46     char *psz_stale;
  47     char *psz_algorithm;
  48     char *psz_qop;
  49     int i_nonce;
  50     char *psz_cnonce;
  51     char *psz_HA1; /* stored H(A1) value if algorithm = "MD5-sess" */
  52 } vlc_http_auth_t;
  53
  54
  55 VLC_API void vlc_http_auth_Init( vlc_http_auth_t * );
  56 VLC_API void vlc_http_auth_Deinit( vlc_http_auth_t * );
  57 VLC_API void vlc_http_auth_ParseWwwAuthenticateHeader
  58             ( vlc_object_t *, vlc_http_auth_t * , const char * );
  59 VLC_API int vlc_http_auth_ParseAuthenticationInfoHeader
  60             ( vlc_object_t *, vlc_http_auth_t *,
  61               const char *, const char *,
  62               const char *, const char *,
  63               const char * );
  64 VLC_API char *vlc_http_auth_FormatAuthorizationHeader
  65             ( vlc_object_t *, vlc_http_auth_t *,
  66               const char *, const char *,
  67               const char *, const char * ) VLC_USED;
  68
  69 /* RFC 6265: cookies */
  70
  71 typedef struct vlc_http_cookie_jar_t vlc_http_cookie_jar_t;
  72
  73 VLC_API vlc_http_cookie_jar_t * vlc_http_cookies_new( void ) VLC_USED;
  74 VLC_API void vlc_http_cookies_destroy( vlc_http_cookie_jar_t * p_jar );
  75
  76 /**
  77  * Parse a value of an incoming Set-Cookie header and append the
  78  * cookie to the cookie jar if appropriate.
  79  *
  80  * @param jar cookie jar object
  81  * @param cookie header field value of Set-Cookie
  82  * @return true, if the cookie was added, false otherwise
  83  */
  84 VLC_API bool vlc_http_cookies_store( vlc_http_cookie_jar_t *jar,
  85     const char *cookie, const char *host, const char *path );
  86
  87 /**
  88  * Returns a cookie value that match the given URL.
  89  *
  90  * @param p_jar a cookie jar
  91  * @param p_url the URL for which the cookies are returned
  92  * @return A string consisting of semicolon-separated cookie NAME=VALUE pairs.
  93  */
  94 VLC_API char *vlc_http_cookies_fetch( vlc_http_cookie_jar_t *jar, bool secure,
  95                                       const char *host, const char *path );
  96
  97 #endif /* VLC_HTTP_H */