Split out http authentication handling into a separate file
[ffmpeg.git] / libavformat / httpauth.h
1 /*
2  * HTTP authentication
3  * Copyright (c) 2010 Martin Storsjo
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #ifndef AVFORMAT_HTTPAUTH_H
23 #define AVFORMAT_HTTPAUTH_H
24
25 /**
26  * Authentication types, ordered from weakest to strongest.
27  */
28 typedef enum HTTPAuthType {
29     HTTP_AUTH_NONE = 0,    /**< No authentication specified */
30     HTTP_AUTH_BASIC,       /**< HTTP 1.0 Basic auth from RFC 1945
31                              *  (also in RFC 2617) */
32 } HTTPAuthType;
33
34 /**
35  * HTTP Authentication state structure. Must be zero-initialized
36  * before used with the functions below.
37  */
38 typedef struct {
39     /**
40      * The currently chosen auth type.
41      */
42     HTTPAuthType auth_type;
43     /**
44      * Authentication realm
45      */
46     char realm[200];
47 } HTTPAuthState;
48
49 void ff_http_auth_handle_header(HTTPAuthState *state, const char *key,
50                                 const char *value);
51 char *ff_http_auth_create_response(HTTPAuthState *state, const char *auth,
52                                    const char *path, const char *method);
53
54 #endif /* AVFORMAT_HTTPAUTH_H */