tools/brecsum.cc

   1 ///
   2 /// \file       brecsum.cc
   3 ///             Generate SHA1 sums of raw Blackberry database records.
   4 ///             This is mostly useful for data verification during testing.
   5 ///
   6
   7 /*
   8     Copyright (C) 2008-2010, Net Direct Inc. (http://www.netdirect.ca/)
   9
  10     This program is free software; you can redistribute it and/or modify
  11     it under the terms of the GNU General Public License as published by
  12     the Free Software Foundation; either version 2 of the License, or
  13     (at your option) any later version.
  14
  15     This program is distributed in the hope that it will be useful,
  16     but WITHOUT ANY WARRANTY; without even the implied warranty of
  17     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  18
  19     See the GNU General Public License in the COPYING file at the
  20     root directory of this project for more details.
  21 */
  22
  23 #include <barry/barry.h>
  24 #include <iomanip>
  25 #include <iostream>
  26 #include <vector>
  27 #include <string>
  28 #include <getopt.h>
  29 #include "i18n.h"
  30
  31 using namespace std;
  32 using namespace Barry;
  33
  34 void Usage()
  35 {
  36    int major, minor;
  37    const char *Version = Barry::Version(major, minor);
  38
  39    cerr
  40    << "brecsum - Generate SHA1 sums of raw Blackberry database records.\n"
  41    << "        Copyright 2008-2010, Net Direct Inc. (http://www.netdirect.ca/)\n"
  42    << "        Using: " << Version << "\n"
  43    << "\n"
  44    << "   -d db     Read database 'db' and sum all its records.\n"
  45    << "             Can be used multiple times to fetch more than one DB\n"
  46    << "   -h        This help\n"
  47    << "   -i        Include DB Name, Type, and Unique record IDs in the checksums\n"
  48    << "   -p pin    PIN of device to talk with\n"
  49    << "             If only one device is plugged in, this flag is optional\n"
  50    << "   -P pass   Simplistic method to specify device password\n"
  51    << "   -v        Dump protocol data during operation\n"
  52    << endl;
  53 }
  54
  55 class ChecksumParser : public Barry::Parser
  56 {
  57         bool m_IncludeIds;
  58         SHA_CTX m_ctx;
  59
  60 public:
  61         explicit ChecksumParser(bool IncludeIds)
  62                 : m_IncludeIds(IncludeIds)
  63         {}
  64
  65         virtual void Clear()
  66         {
  67                 SHA1_Init(&m_ctx);
  68         }
  69
  70         virtual void SetIds(const std::string &DbName,
  71                                 uint8_t RecType, uint32_t UniqueId)
  72         {
  73                 if( m_IncludeIds ) {
  74                         SHA1_Update(&m_ctx, DbName.c_str(), DbName.size());
  75                         SHA1_Update(&m_ctx, &RecType, sizeof(RecType));
  76                         SHA1_Update(&m_ctx, &UniqueId, sizeof(UniqueId));
  77                 }
  78         }
  79
  80         virtual void ParseHeader(const Barry::Data &, size_t &)
  81         {
  82                 // do nothing here, parse it all at once in ParseFields
  83         }
  84
  85         virtual void ParseFields(const Barry::Data &data, size_t &offset,
  86                                 const Barry::IConverter *ic)
  87         {
  88                 int len = data.GetSize() - offset;
  89                 SHA1_Update(&m_ctx, data.GetData() + offset, len);
  90                 offset += len;
  91         }
  92
  93         virtual void Store()
  94         {
  95                 unsigned char sha1[SHA_DIGEST_LENGTH];
  96                 SHA1_Final(sha1, &m_ctx);
  97
  98                 for( int i = 0; i < SHA_DIGEST_LENGTH; i++ ) {
  99                         cout << hex << setfill('0') << setw(2)
 100                                 << (unsigned int) sha1[i];
 101                 }
 102                 cout << endl;
 103         }
 104 };
 105
 106 int main(int argc, char *argv[])
 107 {
 108         INIT_I18N(PACKAGE);
 109
 110         cout.sync_with_stdio(true);     // leave this on, since libusb uses
 111                                         // stdio for debug messages
 112
 113         try {
 114
 115                 uint32_t pin = 0;
 116                 bool
 117                         data_dump = false,
 118                         include_ids = false;
 119                 string password;
 120                 vector<string> dbNames;
 121
 122                 // process command line options
 123                 for(;;) {
 124                         int cmd = getopt(argc, argv, "d:hip:P:v");
 125                         if( cmd == -1 )
 126                                 break;
 127
 128                         switch( cmd )
 129                         {
 130                         case 'd':       // show dbname
 131                                 dbNames.push_back(string(optarg));
 132                                 break;
 133
 134                         case 'i':       // Include IDs
 135                                 include_ids = true;
 136                                 break;
 137
 138                         case 'p':       // Blackberry PIN
 139                                 pin = strtoul(optarg, NULL, 16);
 140                                 break;
 141
 142                         case 'P':       // Device password
 143                                 password = optarg;
 144                                 break;
 145
 146                         case 'v':       // data dump on
 147                                 data_dump = true;
 148                                 break;
 149
 150                         case 'h':       // help
 151                         default:
 152                                 Usage();
 153                                 return 0;
 154                         }
 155                 }
 156
 157                 // Display usage info if user appears confused
 158                 if( !dbNames.size() ) {
 159                         Usage();
 160                         return 0;
 161                 }
 162
 163                 // Initialize the barry library.  Must be called before
 164                 // anything else.
 165                 Barry::Init(data_dump);
 166
 167                 // Probe the USB bus for Blackberry devices and display.
 168                 Barry::Probe probe;
 169                 int activeDevice = probe.FindActive(pin);
 170                 if( activeDevice == -1 ) {
 171                         cerr << "No device selected, or PIN not found" << endl;
 172                         return 1;
 173                 }
 174
 175                 // Create our controller object
 176                 Barry::Controller con(probe.Get(activeDevice));
 177                 Barry::Mode::Desktop desktop(con);
 178
 179                 // Sum all specified databases
 180                 if( dbNames.size() ) {
 181                         vector<string>::iterator b = dbNames.begin();
 182                         ChecksumParser parser(include_ids);
 183
 184                         desktop.Open(password.c_str());
 185                         for( ; b != dbNames.end(); b++ ) {
 186                                 unsigned int id = desktop.GetDBID(*b);
 187                                 desktop.LoadDatabase(id, parser);
 188                         }
 189                 }
 190
 191         }
 192         catch( std::exception &e ) {
 193                 std::cerr << e.what() << endl;
 194                 return 1;
 195         }
 196
 197         return 0;
 198 }
 199