protocol.h

Go to the documentation of this file.

/*     -*-C++-*- -*-coding: utf-8-unix;-*-
    Classified Ads is Copyright (c) Antti Järvinen 2013.

    This file is part of Classified Ads.

    Classified Ads is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    Classified Ads is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with Classified Ads; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/

#ifndef CA_PROTOCOL_H
#define CA_PROTOCOL_H
#include "../util/hash.h" // for Hash

// node greeting has following fields, each is unsigned
// 8-bit if not otherwise stated, 32-bit integers are
// in network byte order:
// 1. protocol version for this node. Note that identifies
//    both this message and the protocol version. Later we
//    may invent protocol version xyz that will then
//    identify node and its protocol with some other
//    number.
static const unsigned char KProtocolVersion (1) ; 
// 2. number of bytes that follows for the whole message
// 3. node greeting as qCompress()ed JSon
//
// ok, next thing to define is our easiest message type, random numbers.
// idea for this is this: upon connect node sends node greeting.
// node greeting contains hash and outside ip addr. suppose someone
// is eavesdropping the tsl tcp connection she already has some known
// plaintext in there, in the very first real datapacket transmitted,
// in known offset so .. say, the original tsl key was done using bad
// random number and in addition the listener knows some plaintext
// inside it might be possible to brute-force the key.
//
// lets make her job a bit more interesting by first transmitting
// short random sequence of random length in the beginning.
static const unsigned char KRandomNumbersPacket (100) ; 
// rest of the packet is msg len and then the bytes that are supposed
// to be discarded (or written into your weekly lottery ticket
// if you consider yourself a lucky jerk :)

// then have packet for requesting nodes that might be held liable
// for keeping alive content with given hash
// the packet consists of the identifier and a 160 bit hash. nothing else.

// following items are for requesting various things from peer:
static const unsigned char KNodesAroundHash (101) ; 
static const unsigned char KProfileAtHash (103) ; 
static const unsigned char KBinaryFileAtHash (104) ; 
static const unsigned char KClassifiedAdAtHash (109) ; 
static const unsigned char KProfilePublish (102) ; 
static const unsigned char KBinaryFilePublish (105) ; 
static const unsigned char KBinaryFileSend (106) ; 
static const unsigned char KClassifiedAdPublish (107) ; 
static const unsigned char KProfileSend (108) ; 
static const unsigned char KClassifiedAdSend (110) ; 
static const unsigned char KAdsClassifiedAtHash (111) ; 
static const unsigned char KListOfAdsClassifiedAtHash (112) ; 
static const unsigned char KPrivMessagePublish (113) ; 
static const unsigned char KPrivMessageSend (114) ; 
static const unsigned char KPrivMessagesAtHash (115) ; 
static const unsigned char KPrivMessagesForProfile (116) ; 
static const unsigned char KProfileCommentPublish (117) ; 
static const unsigned char KProfileCommentSend (118) ; 
static const unsigned char KProfileCommentAtHash (119) ;
static const unsigned char KSingleProfileCommentAtHash (120) ;
static const unsigned char KSearchRequest (121) ;
static const unsigned char KSearchResults (122) ;
static const unsigned char KVoiceCallStart (123) ;
static const unsigned char KVoiceCallEnd (124) ;
static const unsigned char KRealtimeData (125) ;
static const unsigned char KFutureUse4 (126) ;
static const unsigned char KFutureUse5 (127) ;
static const unsigned char KFutureUse6 (128) ;


static const unsigned char KRTDataAudioSubtype (1) ;
static const unsigned char KRTDataControlSubtype (2) ;

enum ProtocolItemType {
    OwnNodeGreeting=1, 
    NodeGreeting=2, 
    ClassifiedAd=3, 
    PrivateMessage=4, 
    BinaryBlob=5, 
    UserProfile=6, 
    RequestForClassifiedAd=7,
    RequestForPrivateMessage=8,
    RequestForBinaryBlob=9,
    RequestForUserProfile=10,
    RandomNumbers=11, 
    RequestForNodesAroundHash=12, 
    UserProfilePublish=13, 
    BinaryFilePublish=14, 
    ClassifiedAdPublish=15, 
    ClassifiedAd2NdAddr=16, 
    RequestAdsClassified=17,
    PrivateMessagePublish=18,
    PrivateMessagesForProfile=19, 
    UserProfileComment=20, 
    ProfileCommentPublish=21, 
    UserProfileCommentsForProfile=22, 
    RequestForProfilePoll=23, 
    RequestForProfileComment=24, 
    RequestForSearchSend=25, 
    RequestForVoiceCallStart=26,
    RequestForVoiceCallEnd=27 
};
struct SendQueueItem {
    ProtocolItemType iItemType ; 
    Hash iHash ; 
} ;
struct PublishItem {
    ProtocolItemType iObjectType ; 
    Hash iObjectHash ; 
    QList<quint32> iAlreadyPushedHosts ;
    Hash i2NdAddr ; 
} ;

static const int KMaxOpenConnections( 100 );
static const int KNumberOfNodesToSendToEachPeer ( 300 ) ;
static const int KNumberOfClassifiedAdsToSendToEachPeer ( 300 ) ;
static const quint32 KMaxProtocolItemSize ( 1024*1024*2 ) ;

static const quint16 KBroadCastAdvertismentPort ( 23432 ) ;
#endif /* CA_PROTOCOL_H */