2013-07-11 20:19:06 +00:00
|
|
|
/*
|
2015-02-17 21:11:34 +00:00
|
|
|
* ZeroTier One - Network Virtualization Everywhere
|
2016-01-12 22:04:55 +00:00
|
|
|
* Copyright (C) 2011-2016 ZeroTier, Inc. https://www.zerotier.com/
|
2013-07-11 20:19:06 +00:00
|
|
|
*
|
|
|
|
* This program is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program 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 General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
2014-09-24 16:04:09 +00:00
|
|
|
#ifndef ZT_INCOMINGPACKET_HPP
|
|
|
|
#define ZT_INCOMINGPACKET_HPP
|
2013-07-11 20:19:06 +00:00
|
|
|
|
|
|
|
#include <stdexcept>
|
|
|
|
|
|
|
|
#include "Packet.hpp"
|
|
|
|
#include "InetAddress.hpp"
|
|
|
|
#include "Utils.hpp"
|
2014-10-02 20:50:37 +00:00
|
|
|
#include "MulticastGroup.hpp"
|
2013-07-12 02:06:25 +00:00
|
|
|
#include "Peer.hpp"
|
2013-07-11 20:19:06 +00:00
|
|
|
|
2013-09-25 14:55:27 +00:00
|
|
|
/*
|
|
|
|
* The big picture:
|
|
|
|
*
|
|
|
|
* tryDecode gets called for a given fully-assembled packet until it returns
|
|
|
|
* true or the packet's time to live has been exceeded, in which case it is
|
|
|
|
* discarded as failed decode. Any exception thrown by tryDecode also causes
|
|
|
|
* the packet to be discarded.
|
|
|
|
*
|
|
|
|
* Thus a return of false from tryDecode() indicates that it should be called
|
|
|
|
* again. Logic is very simple as to when, and it's in doAnythingWaitingForPeer
|
|
|
|
* in Switch. This might be expanded to be more fine grained in the future.
|
|
|
|
*
|
|
|
|
* A return value of true indicates that the packet is done. tryDecode must
|
|
|
|
* never be called again after that.
|
|
|
|
*/
|
|
|
|
|
2013-07-11 20:19:06 +00:00
|
|
|
namespace ZeroTier {
|
|
|
|
|
|
|
|
class RuntimeEnvironment;
|
2014-06-11 04:41:34 +00:00
|
|
|
class Network;
|
2013-07-11 20:19:06 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Subclass of packet that handles the decoding of it
|
|
|
|
*/
|
2014-09-24 16:04:09 +00:00
|
|
|
class IncomingPacket : public Packet
|
2013-07-11 20:19:06 +00:00
|
|
|
{
|
|
|
|
public:
|
2016-03-18 21:16:07 +00:00
|
|
|
IncomingPacket() :
|
|
|
|
Packet(),
|
|
|
|
_receiveTime(0),
|
|
|
|
_localAddress(),
|
|
|
|
_remoteAddress()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
IncomingPacket(const IncomingPacket &p)
|
|
|
|
{
|
|
|
|
// All fields including InetAddress are memcpy'able
|
|
|
|
memcpy(this,&p,sizeof(IncomingPacket));
|
|
|
|
}
|
|
|
|
|
2013-07-12 14:13:24 +00:00
|
|
|
/**
|
|
|
|
* Create a new packet-in-decode
|
|
|
|
*
|
2015-04-08 02:31:11 +00:00
|
|
|
* @param data Packet data
|
|
|
|
* @param len Packet length
|
2015-09-24 23:21:36 +00:00
|
|
|
* @param localAddress Local interface address
|
2013-07-12 14:13:24 +00:00
|
|
|
* @param remoteAddress Address from which packet came
|
2015-04-08 22:26:45 +00:00
|
|
|
* @param now Current time
|
2013-07-12 14:13:24 +00:00
|
|
|
* @throws std::out_of_range Range error processing packet
|
|
|
|
*/
|
2015-09-24 23:21:36 +00:00
|
|
|
IncomingPacket(const void *data,unsigned int len,const InetAddress &localAddress,const InetAddress &remoteAddress,uint64_t now) :
|
2015-04-08 02:31:11 +00:00
|
|
|
Packet(data,len),
|
2015-04-08 22:26:45 +00:00
|
|
|
_receiveTime(now),
|
2015-09-24 23:21:36 +00:00
|
|
|
_localAddress(localAddress),
|
2016-03-18 21:16:07 +00:00
|
|
|
_remoteAddress(remoteAddress)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
inline IncomingPacket &operator=(const IncomingPacket &p)
|
|
|
|
{
|
|
|
|
// All fields including InetAddress are memcpy'able
|
|
|
|
memcpy(this,&p,sizeof(IncomingPacket));
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Init packet-in-decode in place
|
|
|
|
*
|
|
|
|
* @param data Packet data
|
|
|
|
* @param len Packet length
|
|
|
|
* @param localAddress Local interface address
|
|
|
|
* @param remoteAddress Address from which packet came
|
|
|
|
* @param now Current time
|
|
|
|
* @throws std::out_of_range Range error processing packet
|
|
|
|
*/
|
|
|
|
inline void init(const void *data,unsigned int len,const InetAddress &localAddress,const InetAddress &remoteAddress,uint64_t now)
|
2013-07-11 20:19:06 +00:00
|
|
|
{
|
2016-03-18 21:16:07 +00:00
|
|
|
copyFrom(data,len);
|
|
|
|
_receiveTime = now;
|
|
|
|
_localAddress = localAddress;
|
|
|
|
_remoteAddress = remoteAddress;
|
2013-07-11 20:19:06 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Attempt to decode this packet
|
|
|
|
*
|
2013-07-12 14:13:24 +00:00
|
|
|
* Note that this returns 'true' if processing is complete. This says nothing
|
|
|
|
* about whether the packet was valid. A rejection is 'complete.'
|
|
|
|
*
|
2013-09-25 14:55:27 +00:00
|
|
|
* Once true is returned, this must not be called again. The packet's state
|
2015-11-05 20:22:58 +00:00
|
|
|
* may no longer be valid. The only exception is deferred decoding. In this
|
|
|
|
* case true is returned to indicate to the normal decode path that it is
|
|
|
|
* finished with the packet. The packet will have added itself to the
|
|
|
|
* deferred queue and will expect tryDecode() to be called one more time
|
|
|
|
* with deferred set to true.
|
|
|
|
*
|
|
|
|
* Deferred decoding is performed by DeferredPackets.cpp and should not be
|
|
|
|
* done elsewhere. Under deferred decoding packets only get one shot and
|
|
|
|
* so the return value of tryDecode() is ignored.
|
2013-07-12 14:13:24 +00:00
|
|
|
*
|
2014-09-25 22:08:29 +00:00
|
|
|
* @param RR Runtime environment
|
2015-11-05 20:22:58 +00:00
|
|
|
* @param deferred If true, this is a deferred decode and the return is ignored
|
2013-07-12 14:13:24 +00:00
|
|
|
* @return True if decoding and processing is complete, false if caller should try again
|
2013-07-11 20:19:06 +00:00
|
|
|
*/
|
2015-11-05 20:22:58 +00:00
|
|
|
bool tryDecode(const RuntimeEnvironment *RR,bool deferred);
|
2013-07-11 20:19:06 +00:00
|
|
|
|
|
|
|
/**
|
2013-09-25 14:55:27 +00:00
|
|
|
* @return Time of packet receipt / start of decode
|
2013-07-11 20:19:06 +00:00
|
|
|
*/
|
|
|
|
inline uint64_t receiveTime() const throw() { return _receiveTime; }
|
|
|
|
|
2015-10-07 20:35:46 +00:00
|
|
|
/**
|
|
|
|
* Compute the Salsa20/12+SHA512 proof of work function
|
|
|
|
*
|
|
|
|
* @param difficulty Difficulty in bits (max: 64)
|
|
|
|
* @param challenge Challenge string
|
|
|
|
* @param challengeLength Length of challenge in bytes (max allowed: ZT_PROTO_MAX_PACKET_LENGTH)
|
|
|
|
* @param result Buffer to fill with 16-byte result
|
|
|
|
*/
|
|
|
|
static void computeSalsa2012Sha512ProofOfWork(unsigned int difficulty,const void *challenge,unsigned int challengeLength,unsigned char result[16]);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Verify the result of Salsa20/12+SHA512 proof of work
|
|
|
|
*
|
|
|
|
* @param difficulty Difficulty in bits (max: 64)
|
|
|
|
* @param challenge Challenge bytes
|
|
|
|
* @param challengeLength Length of challenge in bytes (max allowed: ZT_PROTO_MAX_PACKET_LENGTH)
|
|
|
|
* @param proposedResult Result supplied by client
|
|
|
|
* @return True if result is valid
|
|
|
|
*/
|
|
|
|
static bool testSalsa2012Sha512ProofOfWorkResult(unsigned int difficulty,const void *challenge,unsigned int challengeLength,const unsigned char proposedResult[16]);
|
|
|
|
|
2013-07-11 20:19:06 +00:00
|
|
|
private:
|
2013-07-12 14:13:24 +00:00
|
|
|
// These are called internally to handle packet contents once it has
|
|
|
|
// been authenticated, decrypted, decompressed, and classified.
|
2014-09-24 20:53:03 +00:00
|
|
|
bool _doERROR(const RuntimeEnvironment *RR,const SharedPtr<Peer> &peer);
|
2015-11-05 20:22:58 +00:00
|
|
|
bool _doHELLO(const RuntimeEnvironment *RR,SharedPtr<Peer> &peer); // can be called with NULL peer, while all others cannot
|
2014-09-24 20:53:03 +00:00
|
|
|
bool _doOK(const RuntimeEnvironment *RR,const SharedPtr<Peer> &peer);
|
|
|
|
bool _doWHOIS(const RuntimeEnvironment *RR,const SharedPtr<Peer> &peer);
|
|
|
|
bool _doRENDEZVOUS(const RuntimeEnvironment *RR,const SharedPtr<Peer> &peer);
|
|
|
|
bool _doFRAME(const RuntimeEnvironment *RR,const SharedPtr<Peer> &peer);
|
|
|
|
bool _doEXT_FRAME(const RuntimeEnvironment *RR,const SharedPtr<Peer> &peer);
|
2015-10-07 23:11:50 +00:00
|
|
|
bool _doECHO(const RuntimeEnvironment *RR,const SharedPtr<Peer> &peer);
|
2014-09-24 20:53:03 +00:00
|
|
|
bool _doMULTICAST_LIKE(const RuntimeEnvironment *RR,const SharedPtr<Peer> &peer);
|
|
|
|
bool _doNETWORK_MEMBERSHIP_CERTIFICATE(const RuntimeEnvironment *RR,const SharedPtr<Peer> &peer);
|
|
|
|
bool _doNETWORK_CONFIG_REQUEST(const RuntimeEnvironment *RR,const SharedPtr<Peer> &peer);
|
2015-01-06 01:47:59 +00:00
|
|
|
bool _doNETWORK_CONFIG_REFRESH(const RuntimeEnvironment *RR,const SharedPtr<Peer> &peer);
|
2014-09-26 19:23:43 +00:00
|
|
|
bool _doMULTICAST_GATHER(const RuntimeEnvironment *RR,const SharedPtr<Peer> &peer);
|
|
|
|
bool _doMULTICAST_FRAME(const RuntimeEnvironment *RR,const SharedPtr<Peer> &peer);
|
2015-07-06 22:05:04 +00:00
|
|
|
bool _doPUSH_DIRECT_PATHS(const RuntimeEnvironment *RR,const SharedPtr<Peer> &peer);
|
2015-09-30 20:59:05 +00:00
|
|
|
bool _doCIRCUIT_TEST(const RuntimeEnvironment *RR,const SharedPtr<Peer> &peer);
|
|
|
|
bool _doCIRCUIT_TEST_REPORT(const RuntimeEnvironment *RR,const SharedPtr<Peer> &peer);
|
2015-10-07 20:35:46 +00:00
|
|
|
bool _doREQUEST_PROOF_OF_WORK(const RuntimeEnvironment *RR,const SharedPtr<Peer> &peer);
|
2014-09-24 20:53:03 +00:00
|
|
|
|
2015-09-30 20:59:05 +00:00
|
|
|
// Send an ERROR_NEED_MEMBERSHIP_CERTIFICATE to a peer indicating that an updated cert is needed to communicate
|
2014-09-24 20:53:03 +00:00
|
|
|
void _sendErrorNeedCertificate(const RuntimeEnvironment *RR,const SharedPtr<Peer> &peer,uint64_t nwid);
|
2014-06-18 16:00:53 +00:00
|
|
|
|
2013-07-11 20:19:06 +00:00
|
|
|
uint64_t _receiveTime;
|
2015-09-24 23:21:36 +00:00
|
|
|
InetAddress _localAddress;
|
2013-07-11 20:19:06 +00:00
|
|
|
InetAddress _remoteAddress;
|
|
|
|
};
|
|
|
|
|
|
|
|
} // namespace ZeroTier
|
|
|
|
|
|
|
|
#endif
|