src/packet.h

   1 ///
   2 /// \file       packet.h
   3 ///             Low level protocol packet builder class.
   4 ///             Has knowledge of specific protocol commands in order
   5 ///             to hide protocol details behind an API.
   6 ///
   7
   8 /*
   9     Copyright (C) 2005-2009, Net Direct Inc. (http://www.netdirect.ca/)
  10
  11     This program is free software; you can redistribute it and/or modify
  12     it under the terms of the GNU General Public License as published by
  13     the Free Software Foundation; either version 2 of the License, or
  14     (at your option) any later version.
  15
  16     This program is distributed in the hope that it will be useful,
  17     but WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  19
  20     See the GNU General Public License in the COPYING file at the
  21     root directory of this project for more details.
  22 */
  23
  24 #ifndef __BARRY_PACKET_H__
  25 #define __BARRY_PACKET_H__
  26
  27 #include <string>
  28 #include <stdint.h>
  29 #include "protocol.h"
  30
  31 namespace Barry { class Data; }
  32
  33 namespace Barry {
  34
  35 // forward declarations
  36 class Parser;
  37 class Builder;
  38 class SocketZero;
  39 class Socket;
  40 class IConverter;
  41 namespace Mode {
  42         class Desktop;
  43         class JavaLoader;
  44 }
  45
  46 class Packet
  47 {
  48         friend class SocketZero;
  49         friend class Socket;
  50
  51 protected:
  52         Data &m_send, &m_receive;
  53
  54         Data& GetSend() { return m_send; }
  55         Data& GetReceive() { return m_receive; }
  56
  57 public:
  58         Packet(Data &send, Data &receive)
  59                 : m_send(send), m_receive(receive)
  60                 {}
  61         virtual ~Packet() {}
  62
  63         //////////////////////////////////
  64         // common response analysis
  65
  66         unsigned int Command() const;   // throws Error if receive isn't big enough
  67 };
  68
  69 //
  70 // ZeroPacket class
  71 //
  72 /// Provides an API for building and analyzing socket-0 protocol packets.
  73 /// This class relies on 2 external objects: a send and receive Data buffer.
  74 ///
  75 /// Note that the receive buffer may be modified
  76 /// during a packet send, and this class provides API helpers
  77 /// to analyze the results.
  78 ///
  79 class ZeroPacket : public Packet
  80 {
  81         friend class Socket;
  82
  83 public:
  84         ZeroPacket(Data &send, Data &receive);
  85         ~ZeroPacket();
  86
  87         //////////////////////////////////
  88         // meta access
  89
  90         //////////////////////////////////
  91         // packet building
  92
  93         void GetAttribute(unsigned int object, unsigned int attribute);
  94         void Echo(uint64_t us_ticks);
  95         void Reset();
  96
  97
  98         //////////////////////////////////
  99         // response analysis
 100
 101         unsigned int ObjectID() const;
 102         unsigned int AttributeID() const;
 103         uint32_t ChallengeSeed() const;
 104         unsigned int RemainingTries() const;
 105         unsigned int SocketResponse() const;
 106         unsigned char SocketSequence() const;
 107         uint8_t CommandResponse() const;
 108 };
 109
 110
 111 //
 112 // DBPacket class
 113 //
 114 /// Provides an API for building and analyzing raw DB protocol packets.
 115 /// This class relies on 3 external objects: a Mode::Desktop object,
 116 /// a send Data buffer, and a receive data buffer.  Socket and
 117 /// connection details are retrieved on a readonly basis from the
 118 /// Mode::Desktop object, but both send and receive buffers can be
 119 /// modified.
 120 ///
 121 /// Note that the receive buffer may be modified
 122 /// during a packet send, and this DBPacket class provides API helpers
 123 /// to analyze the results.
 124 ///
 125 class DBPacket : public Packet
 126 {
 127         friend class Socket;
 128
 129 private:
 130         Mode::Desktop &m_con;
 131         unsigned int m_last_dbop;       // last database operation
 132
 133 protected:
 134
 135 public:
 136         DBPacket(Mode::Desktop &con, Data &send, Data &receive);
 137         ~DBPacket();
 138
 139         //////////////////////////////////
 140         // meta access
 141
 142         //////////////////////////////////
 143         // packet building
 144
 145         // commands that correspond to the DB operation
 146         // constants in protocol.h
 147         void ClearDatabase(unsigned int dbId);
 148         void GetDBDB();
 149         void GetRecordStateTable(unsigned int dbId);
 150         void SetRecordFlags(unsigned int dbId, unsigned int stateTableIndex, uint8_t flag1);
 151         void DeleteRecordByIndex(unsigned int dbId, unsigned int stateTableIndex);
 152         void GetRecordByIndex(unsigned int dbId, unsigned int stateTableIndex);
 153         bool SetRecordByIndex(unsigned int dbId, unsigned int stateTableIndex, Builder &build, const IConverter *ic);
 154         void GetRecords(unsigned int dbId);
 155         bool SetRecord(unsigned int dbId, Builder &build, const IConverter *ic);
 156
 157
 158         //////////////////////////////////
 159         // response analysis
 160
 161         // DB command response functions
 162         unsigned int ReturnCode() const;        // throws FIXME if packet doesn't support it
 163         unsigned int DBOperation() const; // throws Error on size trouble
 164
 165         bool Parse(Parser &parser, const IConverter *ic); // switches based on last m_send command
 166
 167         // response parsers
 168 };
 169
 170
 171 //
 172 // JLPacket class
 173 //
 174 /// Provides an API for building and analyzing raw Javaloader protocol packets.
 175 /// This class relies on 3 external objects:
 176 /// a command send Data buffer (which can be fairly small), a data
 177 /// or argument send Data buffer, and a receive data buffer.  Socket and
 178 /// connection details are retrieved on a readonly basis from the
 179 /// Mode::JavaLoader object, but all buffers can be modified.
 180 ///
 181 /// Note that the receive buffer may be modified
 182 /// during a packet send, and this JLPacket class provides API helpers
 183 /// to analyze the results.
 184 ///
 185 class JLPacket : public Packet
 186 {
 187         friend class Socket;
 188
 189 private:
 190         Data &m_cmd, &m_data;
 191         int m_last_set_size;
 192
 193 public:
 194         JLPacket(Data &cmd, Data &send, Data &receive);
 195         ~JLPacket();
 196
 197         //////////////////////////////////
 198         // meta access
 199
 200         bool HasData() const    { return m_last_set_size == 2; }
 201         Data& GetReceive()      { return m_receive; }
 202
 203         //////////////////////////////////
 204         // packet building
 205
 206         // commands that correspond to the operation
 207         // constants in protocol.h
 208
 209         // returns 1 or 2 depending on whether cmd or cmd+send are available
 210         int SimpleCmd(uint8_t cmd, uint8_t unknown = 0, uint16_t size = 0);
 211         int SimpleData(const void *data, uint16_t size);
 212         int BigEndianData(uint16_t value);
 213         int BigEndianData(uint32_t value);
 214
 215         int Hello()             { return SimpleCmd(SB_COMMAND_JL_HELLO); }
 216         int Goodbye()           { return SimpleCmd(SB_COMMAND_JL_GOODBYE); }
 217         int SetUnknown1();
 218         int SetCodFilename(const std::string &filename);
 219         int SetCodSize(off_t size);
 220         int SetTime(time_t when);
 221         int GetScreenshot();
 222         int GetData()           { return SimpleCmd(SB_COMMAND_JL_SEND_DATA); }
 223         int DeviceInfo()        { return SimpleCmd(SB_COMMAND_JL_DEVICE_INFO); }
 224         int OsMetrics()         { return SimpleCmd(SB_COMMAND_JL_OS_METRICS); }
 225         int BootromMetrics()    { return SimpleCmd(SB_COMMAND_JL_BOOTROM_METRICS); }
 226         int GetDirectory()      { return SimpleCmd(SB_COMMAND_JL_GET_DIRECTORY); }
 227         int GetSubDir(uint16_t id);
 228         int GetDirEntry(uint8_t entry_cmd, uint16_t id);
 229         int Erase(uint16_t cmd, uint16_t id);
 230         int GetEventlog()       { return SimpleCmd(SB_COMMAND_JL_GET_LOG); }
 231         int GetEventlogEntry(uint16_t entry_num);
 232         int ClearEventlog()     { return SimpleCmd(SB_COMMAND_JL_CLEAR_LOG); }
 233         int SaveModule(uint16_t id);
 234         int PutData(const void *data, uint16_t size);
 235         int WipeApps()          { return SimpleCmd(SB_COMMAND_JL_WIPE_APPS); }
 236         int WipeFs()            { return SimpleCmd(SB_COMMAND_JL_WIPE_FS); }
 237         int LogStackTraces()    { return SimpleCmd(SB_COMMAND_JL_LOG_STRACES); }
 238
 239         //////////////////////////////////
 240         // response analysis
 241         unsigned int Size();
 242 };
 243
 244
 245 } // namespace Barry
 246
 247 #endif
 248