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