source: trunk/libtransmission/peer-io.h @ 7770

Last change on this file since 7770 was 7770, checked in by charles, 12 years ago

(trunk libT) #1734: encrypted peers' outgoing RC4 stream can be corrupted by sending protocol messages out-of-order

  • Property svn:keywords set to Date Rev Author Id
File size: 10.8 KB
Line 
1/*
2 * This file Copyright (C) 2007-2009 Charles Kerr <charles@transmissionbt.com>
3 *
4 * This file is licensed by the GPL version 2.  Works owned by the
5 * Transmission project are granted a special exemption to clause 2(b)
6 * so that the bulk of its code can remain under the MIT license.
7 * This exemption does not extend to derived works not owned by
8 * the Transmission project.
9 *
10 * $Id: peer-io.h 7770 2009-01-22 14:32:29Z charles $
11 */
12
13#ifndef __TRANSMISSION__
14#error only libtransmission should #include this header.
15#endif
16
17#ifndef TR_PEER_IO_H
18#define TR_PEER_IO_H
19
20/**
21***
22**/
23
24#include <assert.h>
25
26#include <event.h>
27
28#include "transmission.h"
29#include "bandwidth.h"
30#include "list.h" /* __tr_list */
31#include "net.h" /* tr_address */
32
33struct evbuffer;
34struct tr_bandwidth;
35struct tr_crypto;
36struct tr_peerIo;
37
38typedef enum
39{
40    READ_NOW,
41    READ_LATER,
42    READ_ERR
43}
44ReadState;
45
46typedef ReadState ( *tr_can_read_cb  )( struct tr_peerIo * io,
47                                        void             * user_data,
48                                        size_t           * setme_piece_byte_count );
49
50typedef void      ( *tr_did_write_cb )( struct tr_peerIo * io,
51                                        size_t             bytesWritten,
52                                        int                wasPieceData,
53                                        void             * userData );
54
55typedef void      ( *tr_net_error_cb )( struct tr_peerIo * io,
56                                        short              what,
57                                        void             * userData );
58
59typedef struct tr_peerIo
60{
61    tr_bool               isEncrypted;
62    tr_bool               isIncoming;
63    tr_bool               peerIdIsSet;
64    tr_bool               extendedProtocolSupported;
65    tr_bool               fastExtensionSupported;
66
67    /* we create the socket in a nonblocking way, so this flag is initially
68     * false and then set to true when libevent says that the socket is ready
69     * for reading or writing */
70    tr_bool               hasFinishedConnecting;
71
72    int                   magicNumber;
73
74    uint8_t               encryptionMode;
75
76    tr_port               port;
77    int                   socket;
78
79    int                   refCount;
80
81    uint8_t               peerId[SHA_DIGEST_LENGTH];
82    time_t                timeCreated;
83
84    tr_session          * session;
85
86    tr_address            addr;
87
88    tr_can_read_cb        canRead;
89    tr_did_write_cb       didWrite;
90    tr_net_error_cb       gotError;
91    void *                userData;
92
93    struct tr_bandwidth   bandwidth;
94    struct tr_crypto    * crypto;
95
96    struct evbuffer     * inbuf;
97    struct evbuffer     * outbuf;
98    struct __tr_list      outbuf_datatypes; /* struct tr_datatype */
99
100    struct event          event_read;
101    struct event          event_write;
102}
103tr_peerIo;
104
105/**
106***
107**/
108
109tr_peerIo*  tr_peerIoNewOutgoing( tr_session              * session,
110                                  struct tr_bandwidth     * parent,
111                                  const struct tr_address * addr,
112                                  tr_port                   port,
113                                  const  uint8_t          * torrentHash );
114
115tr_peerIo*  tr_peerIoNewIncoming( tr_session              * session,
116                                  struct tr_bandwidth     * parent,
117                                  const struct tr_address * addr,
118                                  tr_port                   port,
119                                  int                       socket );
120
121void tr_peerIoRef               ( tr_peerIo * io );
122
123void tr_peerIoUnref             ( tr_peerIo * io );
124
125tr_bool     tr_isPeerIo         ( const tr_peerIo         * io );
126
127
128/**
129***
130**/
131
132void        tr_peerIoEnableLTEP( tr_peerIo * io, tr_bool flag );
133
134static TR_INLINE tr_bool tr_peerIoSupportsLTEP( const tr_peerIo * io )
135{
136    assert( tr_isPeerIo( io ) );
137
138    return io->extendedProtocolSupported;
139}
140
141void        tr_peerIoEnableFEXT( tr_peerIo * io, tr_bool flag );
142
143static TR_INLINE tr_bool tr_peerIoSupportsFEXT( const tr_peerIo * io )
144{
145    assert( tr_isPeerIo( io ) );
146
147    return io->fastExtensionSupported;
148}
149
150/**
151***
152**/
153
154static TR_INLINE tr_session* tr_peerIoGetSession ( tr_peerIo * io )
155{
156    assert( tr_isPeerIo( io ) );
157    assert( io->session );
158
159    return io->session;
160}
161
162const char* tr_peerIoAddrStr( const struct tr_address * addr,
163                              tr_port                   port );
164
165static TR_INLINE const char* tr_peerIoGetAddrStr( const tr_peerIo * io )
166{
167    return tr_isPeerIo( io ) ? tr_peerIoAddrStr( &io->addr, io->port ) : "error";
168}
169
170const struct tr_address * tr_peerIoGetAddress( const tr_peerIo * io,
171                                               tr_port         * port );
172
173const uint8_t*       tr_peerIoGetTorrentHash( tr_peerIo * io );
174
175int                  tr_peerIoHasTorrentHash( const tr_peerIo * io );
176
177void                 tr_peerIoSetTorrentHash( tr_peerIo *     io,
178                                              const uint8_t * hash );
179
180int                  tr_peerIoReconnect( tr_peerIo * io );
181
182static TR_INLINE tr_bool tr_peerIoIsIncoming( const tr_peerIo * io )
183{
184    return io->isIncoming;
185}
186
187static TR_INLINE int    tr_peerIoGetAge( const tr_peerIo * io )
188{
189    return time( NULL ) - io->timeCreated;
190}
191
192
193/**
194***
195**/
196
197void                 tr_peerIoSetPeersId( tr_peerIo *     io,
198                                          const uint8_t * peer_id );
199
200static TR_INLINE const uint8_t* tr_peerIoGetPeersId( const tr_peerIo * io )
201{
202    assert( tr_isPeerIo( io ) );
203    assert( io->peerIdIsSet );
204
205    return io->peerId;
206}
207
208/**
209***
210**/
211
212void    tr_peerIoSetIOFuncs      ( tr_peerIo        * io,
213                                   tr_can_read_cb     readcb,
214                                   tr_did_write_cb    writecb,
215                                   tr_net_error_cb    errcb,
216                                   void             * user_data );
217
218void    tr_peerIoClear           ( tr_peerIo        * io );
219
220/**
221***
222**/
223
224void    tr_peerIoWrite          ( tr_peerIo         * io,
225                                  const void        * writeme,
226                                  size_t              writemeLen,
227                                  tr_bool             isPieceData );
228
229void    tr_peerIoWriteBuf       ( tr_peerIo         * io,
230                                  struct evbuffer   * buf,
231                                  tr_bool             isPieceData );
232
233/**
234***
235**/
236
237static TR_INLINE struct tr_crypto * tr_peerIoGetCrypto( tr_peerIo * io )
238{
239    return io->crypto;
240}
241
242typedef enum
243{
244    /* these match the values in MSE's crypto_select */
245    PEER_ENCRYPTION_NONE  = ( 1 << 0 ),
246    PEER_ENCRYPTION_RC4   = ( 1 << 1 )
247}
248EncryptionMode;
249
250void      tr_peerIoSetEncryption( tr_peerIo * io,
251                                  int         encryptionMode );
252
253static TR_INLINE tr_bool tr_peerIoIsEncrypted( const tr_peerIo * io )
254{
255    return ( io != NULL ) && ( io->encryptionMode == PEER_ENCRYPTION_RC4 );
256}
257
258static TR_INLINE void tr_peerIoWriteBytes( tr_peerIo        * io UNUSED,
259                                           struct evbuffer  * outbuf,
260                                           const void       * bytes,
261                                           size_t             byteCount )
262{
263    evbuffer_add( outbuf, bytes, byteCount );
264}
265
266static TR_INLINE void  tr_peerIoWriteUint8( tr_peerIo        * io,
267                                            struct evbuffer  * outbuf,
268                                            uint8_t            writeme )
269{
270    tr_peerIoWriteBytes( io, outbuf, &writeme, sizeof( uint8_t ) );
271}
272
273static TR_INLINE void tr_peerIoWriteUint16( tr_peerIo        * io,
274                                            struct evbuffer  * outbuf,
275                                            uint16_t           writeme )
276{
277    const uint16_t tmp = htons( writeme );
278    tr_peerIoWriteBytes( io, outbuf, &tmp, sizeof( uint16_t ) );
279}
280
281static TR_INLINE void tr_peerIoWriteUint32( tr_peerIo        * io,
282                                            struct evbuffer  * outbuf,
283                                            uint32_t           writeme )
284{
285    const uint32_t tmp = htonl( writeme );
286    tr_peerIoWriteBytes( io, outbuf, &tmp, sizeof( uint32_t ) );
287}
288
289void tr_peerIoReadBytes( tr_peerIo        * io,
290                         struct evbuffer  * inbuf,
291                         void             * bytes,
292                         size_t             byteCount );
293
294static TR_INLINE void tr_peerIoReadUint8( tr_peerIo        * io,
295                                          struct evbuffer  * inbuf,
296                                          uint8_t          * setme )
297{
298    tr_peerIoReadBytes( io, inbuf, setme, sizeof( uint8_t ) );
299}
300
301static TR_INLINE void tr_peerIoReadUint16( tr_peerIo        * io,
302                                           struct evbuffer  * inbuf,
303                                           uint16_t         * setme )
304{
305    uint16_t tmp;
306    tr_peerIoReadBytes( io, inbuf, &tmp, sizeof( uint16_t ) );
307    *setme = ntohs( tmp );
308}
309
310static TR_INLINE void tr_peerIoReadUint32( tr_peerIo        * io,
311                                           struct evbuffer  * inbuf,
312                                           uint32_t         * setme )
313{
314    uint32_t tmp;
315    tr_peerIoReadBytes( io, inbuf, &tmp, sizeof( uint32_t ) );
316    *setme = ntohl( tmp );
317}
318
319void      tr_peerIoDrain( tr_peerIo        * io,
320                          struct evbuffer  * inbuf,
321                          size_t             byteCount );
322
323/**
324***
325**/
326
327size_t    tr_peerIoGetWriteBufferSpace( const tr_peerIo * io, uint64_t now );
328
329static TR_INLINE void tr_peerIoSetParent( tr_peerIo            * io,
330                                       struct tr_bandwidth  * parent )
331{
332    assert( tr_isPeerIo( io ) );
333
334    tr_bandwidthSetParent( &io->bandwidth, parent );
335}
336
337void      tr_peerIoBandwidthUsed( tr_peerIo           * io,
338                                  tr_direction          direction,
339                                  size_t                byteCount,
340                                  int                   isPieceData );
341
342static TR_INLINE tr_bool tr_peerIoHasBandwidthLeft( const tr_peerIo  * io,
343                                                 tr_direction       dir )
344{
345    assert( tr_isPeerIo( io ) );
346
347    return tr_bandwidthClamp( &io->bandwidth, dir, 1024 ) > 0;
348}
349
350static TR_INLINE double tr_peerIoGetPieceSpeed( const tr_peerIo * io, uint64_t now, tr_direction dir )
351{
352    assert( tr_isPeerIo( io ) );
353    assert( tr_isDirection( dir ) );
354
355    return tr_bandwidthGetPieceSpeed( &io->bandwidth, now, dir );
356}
357
358/**
359***
360**/
361
362void      tr_peerIoSetEnabled( tr_peerIo    * io,
363                               tr_direction   dir,
364                               tr_bool        isEnabled );
365                       
366int       tr_peerIoFlush( tr_peerIo     * io,
367                          tr_direction    dir,
368                          size_t          byteLimit );
369
370/**
371***
372**/
373
374static TR_INLINE struct evbuffer * tr_peerIoGetReadBuffer( tr_peerIo * io )
375{
376    return io->inbuf;
377}
378
379
380#endif
Note: See TracBrowser for help on using the repository browser.