config: remove advanced from add_password()
[vlc.git] / modules / access_output / http.c
1 /*****************************************************************************
2  * http.c
3  *****************************************************************************
4  * Copyright (C) 2001-2009 VLC authors and VideoLAN
5  * $Id$
6  *
7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8  *          Remi Denis-Courmont
9  *
10  * This program is free software; you can redistribute it and/or modify it
11  * under the terms of the GNU Lesser General Public License as published by
12  * the Free Software Foundation; either version 2.1 of the License, or
13  * (at your option) any later version.
14  *
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 Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * along with this program; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 /*****************************************************************************
26  * Preamble
27  *****************************************************************************/
28
29 #ifdef HAVE_CONFIG_H
30 # include "config.h"
31 #endif
32
33 #include <stdint.h>
34
35 #include <vlc_common.h>
36 #include <vlc_plugin.h>
37 #include <vlc_sout.h>
38 #include <vlc_block.h>
39
40
41 #include <vlc_input.h>
42 #include <vlc_httpd.h>
43
44 /*****************************************************************************
45  * Module descriptor
46  *****************************************************************************/
47 static int  Open ( vlc_object_t * );
48 static void Close( vlc_object_t * );
49
50 #define SOUT_CFG_PREFIX "sout-http-"
51
52 #define USER_TEXT N_("Username")
53 #define USER_LONGTEXT N_("Username that will be " \
54                          "requested to access the stream." )
55 #define PASS_TEXT N_("Password")
56 #define PASS_LONGTEXT N_("Password that will be " \
57                          "requested to access the stream." )
58 #define MIME_TEXT N_("Mime")
59 #define MIME_LONGTEXT N_("MIME returned by the server (autodetected " \
60                         "if not specified)." )
61 #define METACUBE_TEXT N_("Metacube")
62 #define METACUBE_LONGTEXT N_("Use the Metacube protocol. Needed for streaming " \
63                              "to the Cubemap reflector.")
64
65
66 vlc_module_begin ()
67     set_description( N_("HTTP stream output") )
68     set_capability( "sout access", 0 )
69     set_shortname( "HTTP" )
70     add_shortcut( "http", "https", "mmsh" )
71     set_category( CAT_SOUT )
72     set_subcategory( SUBCAT_SOUT_ACO )
73     add_string( SOUT_CFG_PREFIX "user", "",
74                 USER_TEXT, USER_LONGTEXT, true )
75     add_password(SOUT_CFG_PREFIX "pwd", "", PASS_TEXT, PASS_LONGTEXT)
76     add_string( SOUT_CFG_PREFIX "mime", "",
77                 MIME_TEXT, MIME_LONGTEXT, true )
78     add_bool( SOUT_CFG_PREFIX "metacube", false,
79               METACUBE_TEXT, METACUBE_LONGTEXT, true )
80     set_callbacks( Open, Close )
81 vlc_module_end ()
82
83
84 /*****************************************************************************
85  * Exported prototypes
86  *****************************************************************************/
87 static const char *const ppsz_sout_options[] = {
88     "user", "pwd", "mime", "metacube", NULL
89 };
90
91 static ssize_t Write( sout_access_out_t *, block_t * );
92 static int Control( sout_access_out_t *, int, va_list );
93
94 struct sout_access_out_sys_t
95 {
96     /* host */
97     httpd_host_t        *p_httpd_host;
98
99     /* stream */
100     httpd_stream_t      *p_httpd_stream;
101
102     /* gather header from stream */
103     int                 i_header_allocated;
104     int                 i_header_size;
105     uint8_t             *p_header;
106     bool                b_header_complete;
107     bool                b_metacube;
108     bool                b_has_keyframes;
109 };
110
111 /* Definitions for the Metacube2 protocol, used to communicate with Cubemap. */
112
113 static const uint8_t METACUBE2_SYNC[8] = {'c', 'u', 'b', 'e', '!', 'm', 'a', 'p'};
114 #define METACUBE_FLAGS_HEADER 0x1
115 #define METACUBE_FLAGS_NOT_SUITABLE_FOR_STREAM_START 0x2
116
117 struct metacube2_block_header
118 {
119     char sync[8];    /* METACUBE2_SYNC */
120     uint32_t size;   /* Network byte order. Does not include header. */
121     uint16_t flags;  /* Network byte order. METACUBE_FLAGS_*. */
122     uint16_t csum;   /* Network byte order. CRC16 of size and flags. */
123 };
124
125 /*
126  * Implementation of Metacube2 utility functions. Taken from the Cubemap
127  * distribution and then relicensed by the author to LGPL2.1+ for inclusion
128  * into VLC.
129  */
130
131 /*
132  * https://www.ece.cmu.edu/~koopman/pubs/KoopmanCRCWebinar9May2012.pdf
133  * recommends this for messages as short as ours (see table at page 34).
134  */
135 #define METACUBE2_CRC_POLYNOMIAL 0x8FDB
136
137 /* Semi-random starting value to make sure all-zero won't pass. */
138 #define METACUBE2_CRC_START 0x1234
139
140 /* This code is based on code generated by pycrc. */
141 static uint16_t metacube2_compute_crc(const struct metacube2_block_header *hdr)
142 {
143     static const int data_len = sizeof(hdr->size) + sizeof(hdr->flags);
144     const uint8_t *data = (uint8_t *)&hdr->size;
145     uint16_t crc = METACUBE2_CRC_START;
146
147     for (int i = 0; i < data_len; ++i) {
148         uint8_t c = data[i];
149         for (int j = 0; j < 8; j++) {
150             int bit = crc & 0x8000;
151             crc = (crc << 1) | ((c >> (7 - j)) & 0x01);
152             if (bit) {
153                 crc ^= METACUBE2_CRC_POLYNOMIAL;
154             }
155         }
156     }
157
158     /* Finalize. */
159     for (int i = 0; i < 16; i++) {
160         int bit = crc & 0x8000;
161         crc = crc << 1;
162         if (bit) {
163             crc ^= METACUBE2_CRC_POLYNOMIAL;
164         }
165     }
166
167     return crc;
168 }
169
170 /*****************************************************************************
171  * Open: open the file
172  *****************************************************************************/
173 static int Open( vlc_object_t *p_this )
174 {
175     sout_access_out_t       *p_access = (sout_access_out_t*)p_this;
176     sout_access_out_sys_t   *p_sys;
177
178     char                *psz_user;
179     char                *psz_pwd;
180     char                *psz_mime;
181
182     if( !( p_sys = p_access->p_sys =
183                 malloc( sizeof( sout_access_out_sys_t ) ) ) )
184         return VLC_ENOMEM ;
185
186     config_ChainParse( p_access, SOUT_CFG_PREFIX, ppsz_sout_options, p_access->p_cfg );
187
188     const char *path = p_access->psz_path;
189     path += strcspn( path, "/" );
190     if( path > p_access->psz_path )
191     {
192         const char *port = strrchr( p_access->psz_path, ':' );
193         if( port != NULL && strchr( port, ']' ) != NULL )
194             port = NULL; /* IPv6 numeral */
195         if( port != p_access->psz_path )
196         {
197             int len = (port ? port : path) - p_access->psz_path;
198             msg_Warn( p_access, "\"%.*s\" HTTP host might be ignored in "
199                       "multiple-host configurations, use at your own risks.",
200                       len, p_access->psz_path );
201             msg_Info( p_access, "Consider passing --http-host=IP on the "
202                                 "command line instead." );
203
204             char host[len + 1];
205             strncpy( host, p_access->psz_path, len );
206             host[len] = '\0';
207
208             var_Create( p_access, "http-host", VLC_VAR_STRING );
209             var_SetString( p_access, "http-host", host );
210         }
211         if( port != NULL )
212         {
213             /* int len = path - ++port;
214             msg_Info( p_access, "Consider passing --%s-port=%.*s on the "
215                                 "command line instead.",
216                       strcasecmp( p_access->psz_access, "https" )
217                       ? "http" : "https", len, port ); */
218             port++;
219
220             int bind_port = atoi( port );
221             if( bind_port > 0 )
222             {
223                 const char *var = strcasecmp( p_access->psz_access, "https" )
224                                   ? "http-port" : "https-port";
225                 var_Create( p_access, var, VLC_VAR_INTEGER );
226                 var_SetInteger( p_access, var, bind_port );
227             }
228         }
229     }
230     if( !*path )
231         path = "/";
232
233     /* TLS support */
234     if( p_access->psz_access && !strcmp( p_access->psz_access, "https" ) )
235         p_sys->p_httpd_host = vlc_https_HostNew( VLC_OBJECT(p_access) );
236     else
237         p_sys->p_httpd_host = vlc_http_HostNew( VLC_OBJECT(p_access) );
238
239     if( p_sys->p_httpd_host == NULL )
240     {
241         msg_Err( p_access, "cannot start HTTP server" );
242         free( p_sys );
243         return VLC_EGENERIC;
244     }
245
246     psz_user = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "user" );
247     psz_pwd = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "pwd" );
248     if( p_access->psz_access && !strcmp( p_access->psz_access, "mmsh" ) )
249     {
250         psz_mime = strdup( "video/x-ms-asf-stream" );
251     }
252     else
253     {
254         psz_mime = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "mime" );
255     }
256
257     p_sys->b_metacube = var_GetBool( p_access, SOUT_CFG_PREFIX "metacube" );
258     p_sys->b_has_keyframes = false;
259
260     p_sys->p_httpd_stream =
261         httpd_StreamNew( p_sys->p_httpd_host, path, psz_mime,
262                          psz_user, psz_pwd );
263     free( psz_user );
264     free( psz_pwd );
265     free( psz_mime );
266
267     if( p_sys->p_httpd_stream == NULL )
268     {
269         msg_Err( p_access, "cannot add stream %s", path );
270         httpd_HostDelete( p_sys->p_httpd_host );
271
272         free( p_sys );
273         return VLC_EGENERIC;
274     }
275
276     if( p_sys->b_metacube )
277     {
278         const httpd_header headers[] = {
279             { (char *)"Content-encoding", (char *)"metacube" }
280         };
281         int err = httpd_StreamSetHTTPHeaders( p_sys->p_httpd_stream, headers,
282                                               ARRAY_SIZE(headers) );
283         if( err != VLC_SUCCESS )
284         {
285             free( p_sys );
286             return err;
287         }
288     }
289
290     p_sys->i_header_allocated = 1024;
291     p_sys->i_header_size      = 0;
292     p_sys->p_header           = xmalloc( p_sys->i_header_allocated );
293     p_sys->b_header_complete  = false;
294
295     p_access->pf_write       = Write;
296     p_access->pf_control     = Control;
297
298     return VLC_SUCCESS;
299 }
300
301 /*****************************************************************************
302  * Close: close the target
303  *****************************************************************************/
304 static void Close( vlc_object_t * p_this )
305 {
306     sout_access_out_t       *p_access = (sout_access_out_t*)p_this;
307     sout_access_out_sys_t   *p_sys = p_access->p_sys;
308
309     httpd_StreamDelete( p_sys->p_httpd_stream );
310     httpd_HostDelete( p_sys->p_httpd_host );
311
312     free( p_sys->p_header );
313
314     msg_Dbg( p_access, "Close" );
315
316     free( p_sys );
317 }
318
319 static int Control( sout_access_out_t *p_access, int i_query, va_list args )
320 {
321     (void)p_access;
322
323     switch( i_query )
324     {
325         case ACCESS_OUT_CONTROLS_PACE:
326             *va_arg( args, bool * ) = false;
327             break;
328
329         default:
330             return VLC_EGENERIC;
331     }
332     return VLC_SUCCESS;
333 }
334
335 /*****************************************************************************
336  * Write:
337  *****************************************************************************/
338 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
339 {
340     sout_access_out_sys_t *p_sys = p_access->p_sys;
341     int i_err = 0;
342     int i_len = 0;
343
344     while( p_buffer )
345     {
346         block_t *p_next;
347
348         if( p_buffer->i_flags & BLOCK_FLAG_HEADER )
349         {
350             /* gather header */
351             if( p_sys->b_header_complete )
352             {
353                 /* free previously gathered header */
354                 p_sys->i_header_size = 0;
355                 p_sys->b_header_complete = false;
356             }
357             if( (int)(p_buffer->i_buffer + p_sys->i_header_size) >
358                 p_sys->i_header_allocated )
359             {
360                 p_sys->i_header_allocated =
361                     p_buffer->i_buffer + p_sys->i_header_size + 1024;
362                 p_sys->p_header = xrealloc( p_sys->p_header,
363                                                   p_sys->i_header_allocated );
364             }
365             memcpy( &p_sys->p_header[p_sys->i_header_size],
366                     p_buffer->p_buffer,
367                     p_buffer->i_buffer );
368             p_sys->i_header_size += p_buffer->i_buffer;
369         }
370         else if( !p_sys->b_header_complete )
371         {
372             p_sys->b_header_complete = true;
373
374             if ( p_sys->b_metacube )
375             {
376                 struct metacube2_block_header hdr;
377                 memcpy( hdr.sync, METACUBE2_SYNC, sizeof( METACUBE2_SYNC ) );
378                 hdr.size = hton32( p_sys->i_header_size );
379                 hdr.flags = hton16( METACUBE_FLAGS_HEADER );
380                 hdr.csum = hton16( metacube2_compute_crc( &hdr ) );
381
382                 int i_header_size = p_sys->i_header_size + sizeof( hdr );
383                 block_t *p_hdr_block = block_Alloc( i_header_size );
384                 if( p_hdr_block == NULL ) {
385                     block_ChainRelease( p_buffer );
386                     return VLC_ENOMEM;
387                 }
388                 p_hdr_block->i_flags = 0;
389                 memcpy( p_hdr_block->p_buffer, &hdr, sizeof( hdr ) );
390                 memcpy( p_hdr_block->p_buffer + sizeof( hdr ), p_sys->p_header, p_sys->i_header_size );
391
392                 /* send the combined header here instead of sending them as regular
393                  * data, so that we get them as a single Metacube header block */
394                 httpd_StreamHeader( p_sys->p_httpd_stream, p_hdr_block->p_buffer, p_hdr_block->i_buffer );
395                 httpd_StreamSend( p_sys->p_httpd_stream, p_hdr_block );
396
397                 block_Release( p_hdr_block );
398             }
399             else
400             {
401                 httpd_StreamHeader( p_sys->p_httpd_stream, p_sys->p_header,
402                                     p_sys->i_header_size );
403             }
404         }
405
406         i_len += p_buffer->i_buffer;
407
408         if( p_buffer->i_flags & BLOCK_FLAG_TYPE_I )
409         {
410             p_sys->b_has_keyframes = true;
411         }
412
413         p_next = p_buffer->p_next;
414
415         if( p_sys->b_metacube )
416         {
417             /* header data is combined into one packet and sent earlier */
418             if( p_buffer->i_flags & BLOCK_FLAG_HEADER ) {
419                 block_Release( p_buffer );
420                 p_buffer = p_next;
421                 continue;
422             }
423
424             /* prepend Metacube header */
425             struct metacube2_block_header hdr;
426             memcpy( hdr.sync, METACUBE2_SYNC, sizeof( METACUBE2_SYNC ) );
427             hdr.size = hton32( p_buffer->i_buffer );
428             hdr.flags = hton16( 0 );
429             if( p_buffer->i_flags & BLOCK_FLAG_HEADER )
430                 hdr.flags |= hton16( METACUBE_FLAGS_HEADER );
431             if( p_sys->b_has_keyframes && !( p_buffer->i_flags & BLOCK_FLAG_TYPE_I ) )
432                 hdr.flags |= hton16( METACUBE_FLAGS_NOT_SUITABLE_FOR_STREAM_START );
433             hdr.csum = hton16( metacube2_compute_crc( &hdr ) );
434
435             p_buffer = block_Realloc( p_buffer, sizeof( hdr ), p_buffer->i_buffer );
436             if( p_buffer == NULL ) {
437                 block_ChainRelease( p_next );
438                 return VLC_ENOMEM;
439             }
440             memcpy( p_buffer->p_buffer, &hdr, sizeof( hdr ) );
441         }
442
443         /* send data */
444         i_err = httpd_StreamSend( p_sys->p_httpd_stream, p_buffer );
445
446         block_Release( p_buffer );
447         p_buffer = p_next;
448
449         if( i_err < 0 )
450         {
451             break;
452         }
453     }
454
455     if( i_err < 0 )
456     {
457         block_ChainRelease( p_buffer );
458     }
459
460     return( i_err < 0 ? VLC_EGENERIC : i_len );
461 }