source: trunk/libtransmission/bencode.h @ 4876

Last change on this file since 4876 was 4876, checked in by charles, 15 years ago

#667: remote crash exploit in bencode parser

  • Property svn:keywords set to Date Rev Author Id
File size: 4.4 KB
Line 
1/******************************************************************************
2 * $Id: bencode.h 4876 2008-01-31 02:24:43Z charles $
3 *
4 * Copyright (c) 2005-2008 Transmission authors and contributors
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 *****************************************************************************/
24
25#ifndef TR_BENCODE_H
26#define TR_BENCODE_H 1
27
28#include <inttypes.h> /* for int64_t */
29#include <string.h> /* for memset */
30
31typedef struct benc_val_s
32{
33#define TYPE_INT  1
34#define TYPE_STR  2
35#define TYPE_LIST 4
36#define TYPE_DICT 8
37    char   type;
38    union
39    {
40        int64_t i;
41        struct
42        {
43            int    i;
44            char * s;
45            int    nofree;
46        } s;
47        struct
48        {
49            int alloc;
50            int count;
51            struct benc_val_s * vals;
52        } l;
53    } val;
54} benc_val_t;
55
56
57int          tr_bencParse( const void      * buf,
58                           const void      * bufend,
59                           benc_val_t      * setme_benc,
60                           const uint8_t  ** setme_end );
61
62int          tr_bencLoad( const void  * buf,
63                          int           buflen,
64                          benc_val_t  * setme_benc,
65                          char       ** setme_end );
66
67void         tr_bencPrint( benc_val_t * val );
68void         tr_bencFree( benc_val_t * val );
69benc_val_t * tr_bencDictFind( benc_val_t * val, const char * key );
70benc_val_t * tr_bencDictFindType( benc_val_t * val, const char * key, int type );
71benc_val_t * tr_bencDictFindFirst( benc_val_t * val, ... );
72
73/* marks a string as 'do not free' and returns it */
74char *       tr_bencStealStr( benc_val_t * val );
75
76/* convenience functions for building benc_val_t structures */
77
78static inline void tr_bencInit( benc_val_t * val, int type )
79{
80    memset( val, 0, sizeof( *val ) );
81    val->type = type;
82}
83
84#define tr_bencInitStr( a, b, c, d ) \
85    _tr_bencInitStr( (a), ( char * )(b), (c), (d) )
86void   _tr_bencInitStr( benc_val_t * val, char * str, int len, int nofree );
87int    tr_bencInitStrDup( benc_val_t * val, const char * str );
88void   tr_bencInitInt( benc_val_t * val, int64_t num );
89int   tr_bencListReserve( benc_val_t * list, int count );
90/* note that for one key-value pair, count should be 1, not 2 */
91int   tr_bencDictReserve( benc_val_t * dict, int count );
92benc_val_t * tr_bencListAdd( benc_val_t * list );
93/* note: key must not be freed or modified while val is in use */
94benc_val_t * tr_bencDictAdd( benc_val_t * dict, const char * key );
95
96char*  tr_bencSave( const benc_val_t * val, int * len );
97
98int64_t  tr_bencGetInt ( const benc_val_t * val );
99
100
101/**
102***  Treat these as private -- they're only made public here
103***  so that the unit tests can find them
104**/
105
106int  tr_bencParseInt( const uint8_t  * buf,
107                      const uint8_t  * bufend,
108                      const uint8_t ** setme_end, 
109                      int64_t        * setme_val );
110
111int  tr_bencParseStr( const uint8_t  * buf,
112                      const uint8_t  * bufend,
113                      const uint8_t ** setme_end, 
114                      uint8_t       ** setme_str,
115                      size_t         * setme_strlen );
116
117/**
118***
119**/
120
121int tr_bencIsInt( const benc_val_t * val );
122int tr_bencIsList( const benc_val_t * val );
123int tr_bencIsDict( const benc_val_t * val );
124int tr_bencIsString( const benc_val_t * val );
125
126benc_val_t* tr_bencListGetNthChild( benc_val_t * val, int i );
127
128
129
130
131#endif
Note: See TracBrowser for help on using the repository browser.