hidden-hippo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 723e65ca63ec61202d7e3ba1c8e4097a418ad5c4
+  data.tar.gz: d60d6875a2378c997e3ec2b68a8cf5637640ea72
+SHA512:
+  metadata.gz: a7a3c6d86d8f8a72ad5880728d5fc8248a914f1c0f2363f52f5fad85d5ec51067752843e8c763afa16c71eff71acd4cdce5c39f0590d0afab2661c21bb3625e0
+  data.tar.gz: 6235f7eadc6ab0bbcb22ab3f9e24d2165440e195a8c984911988b3d3cf9e90d684ac12bc8106f790df923d2cf21e3e20b055132b129ee73fe6d5b519a5593c08

data/.gitignore

@@ -0,0 +1,47 @@
+# Created by https://www.gitignore.io
+
+*~
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Created by https://www.gitignore.io
+
+### Vagrant ###
+.vagrant/
+
+.idea/
+hidden-hippo.iml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,16 @@
+before_install:
+  - sudo apt-get update -q
+  - sudo apt-get install -y libpcap-dev
+  - ./ci/install-tshark.sh
+
+services: mongodb
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.5
+  - 2.2.0
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/HACKING.md

@@ -0,0 +1,78 @@
+Hacking on hidden-hippo
+=======================
+
+Here's how to setup your development environment so that you can start hacking
+on hidden-hippo.
+
+Check out the source
+--------------------
+
+    $ git clone git@github.com:beraboris/hidden-hippo
+    $ cd hidden-hippo
+
+Setup a dev environment
+-----------------------
+
+You have two options when it comes to the dev environment. You can use Vagrant,
+which is a magic VM thingy that sets up the whole environment for you. Or you
+can setup the environment yourself. Using Vagrant is the easier option.
+
+### Vagrant
+
+If you don't already have it, install [vagrant](https://www.vagrantup.com/downloads.html).
+You're also going to need either VMware or VirtualBox.
+
+Setup the VM with: (This will create a VM with a working dev environment.)
+
+    $ vagrant up
+
+Ssh into the VM with:
+
+    $ vagrant ssh
+    $ cd /vagrant
+    $ bundle install
+
+Once you're done suspend the vm with:
+
+    $ vagrant suspend
+
+In the VM, the code can be found in `/vagrant`. This is a shared folder that is
+automatically setup by vagrant.
+
+### Manual setup
+
+Install ruby. We currently support:
+
+- ruby 1.9.3
+- ruby 2.0.0
+- ruby 2.1.5
+- ruby 2.2.0
+
+Install bundler:
+
+    $ gem install bundler
+
+Install dependencies
+
+    $ bundle install
+
+Install mongodb. This is very platform specific. Look it up in the appropriate wiki. Currently we're only supporting
+version 2.4. It could work with 2.6 but it's not tested. The unit tests assume that mongo is running on
+`localhost:27017`.
+
+Install tshark. the `tshark` executable needs to be somewhere in your `$PATH`. tshark is part of the wireshark
+distribution. It is sometimes packaged on its own.
+
+Running hidden-hippo
+--------------------
+
+    $ bundle exec hh ...
+
+Running tests
+-------------
+
+    $ rake
+
+or
+
+    $ rspec spec/...

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Boris Bera, Clément Zotti, François Genois, Ulrich Kossou
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+Hidden Hippo
+============
+
+<img align="right" src="hippo-small.png"/>
+
+[![Build Status](https://travis-ci.org/beraboris/hidden-hippo.svg?branch=master)](https://travis-ci.org/beraboris/hidden-hippo)
+
+A tool that identifies the people around by sniffing network traffic and mining social networks.
+
+Installation
+------------
+
+Install the gem:
+
+    $ gem install hidden-hippo
+
+Usage
+-----
+
+TODO: Write usage instructions here
+
+Contributing
+------------
+
+1. Fork it ( https://github.com/beraboris/hidden-hippo/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+Check out [HACKING.md](HACKING.md) to setup your development environment.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/Vagrantfile

@@ -0,0 +1,24 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure(2) do |config|
+  config.vm.box = 'ubuntu/trusty32'
+
+  config.vm.network 'forwarded_port', guest: 5432, host: 5432
+  config.vm.network 'forwarded_port', guest: 28018, host: 28018
+
+  config.vm.provision 'shell', inline: <<-SHELL
+    apt-get update
+    apt-get install -y build-essential \
+                       ruby1.9.1-dev \
+                       git \
+                       mongodb-server=1:2.4.9-1ubuntu2 \
+                       tshark=1.10.6-1
+    gem install bundler
+  SHELL
+
+  config.vm.provision 'shell', privileged: false, inline: <<-SHELL
+    cd /vagrant
+    bundle install
+  SHELL
+end

data/bin/hh

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'hidden_hippo'
+
+HiddenHippo::Cli::App.start

data/ci/install-tshark.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+wget https://2.na.dl.wireshark.org/src/wireshark-1.10.13.tar.bz2
+tar xjf wireshark-1.10.13.tar.bz2
+cd wireshark-1.10.13
+
+./configure --prefix /usr \
+    --disable-wireshark \
+    --disable-capinfos \
+    --disable-captype \
+    --disable-editcap \
+    --disable-dumpcap \
+    --disable-mergecap \
+    --disable-reordercap \
+    --disable-text2pcap \
+    --disable-randpkt \
+    --disable-dftest \
+    --disable-rawshark
+
+make
+sudo make install

data/config/gui-dev.ru

@@ -0,0 +1,6 @@
+require 'hidden_hippo'
+require 'hidden_hippo/gui'
+
+HiddenHippo.configure_db! :development
+
+run HiddenHippo::Gui

data/config/mongoid.yml

@@ -0,0 +1,20 @@
+production:
+  sessions:
+    default:
+      hosts:
+        - localhost:28018
+      database: hidden-hippo
+
+development:
+  sessions:
+    default:
+      hosts:
+        - localhost:27017
+      database: hidden-hippo-dev
+
+test:
+  sessions:
+    default:
+      hosts:
+        - localhost:27017
+      database: hidden-hippo-test

data/gui/public/hidden-hippo.css

@@ -0,0 +1,18 @@
+.person-picture {
+    width: 150px;
+    height: 150px;
+}
+
+.dossier-short .caption h3 {
+    text-align: center;
+}
+
+.dossier-short .name {
+    font-weight: bold;
+}
+
+.dossier-short .value {
+    overflow: hidden;
+    text-overflow: ellipsis;
+    white-space: nowrap;
+}

data/gui/views/dossier.rhtml

@@ -0,0 +1,12 @@
+<div class="container">
+    <h1 class="page-header"><%= dossier.mac_address %></h1>
+
+    <%= erb :possibilities, locals: {name: 'Name', possibilities: dossier.name} %>
+    <%= erb :possibilities, locals: {name: 'Host name', possibilities: dossier.hostname} %>
+    <%= erb :possibilities, locals: {name: 'User name', possibilities: dossier.username} %>
+    <%= erb :possibilities, locals: {name: 'Email', possibilities: dossier.email} %>
+    <%= erb :possibilities, locals: {name: 'Device', possibilities: dossier.device} %>
+    <%= erb :possibilities, locals: {name: 'Gender', possibilities: dossier.gender} %>
+    <%= erb :possibilities, locals: {name: 'Age', possibilities: dossier.age} %>
+    <%= erb :possibilities, locals: {name: 'History', possibilities: dossier.history} %>
+</div>

data/gui/views/index.rhtml

@@ -0,0 +1,25 @@
+<div class="container">
+<h1 class="page-header">Hidden Hippo</h1>
+<div class="row">
+<% dossiers.each do |dossier| %>
+<div class="col-md-4">
+<div class="thumbnail dossier-short">
+    <img src="user-placeholder.png" class="img-circle person-picture">
+    <div class="caption">
+        <a href="/<%= dossier.mac_address %>">
+            <h3><%= dossier.mac_address %></h3>
+        </a>
+        <div class="row">
+            <div class="col-xs-4 name">Name:</div>
+            <div class="col-xs-8 value"><%= dossier.name.first || 'Nothing :(' %></div>
+        </div>
+        <div class="row">
+            <div class="col-xs-4 name">Host Name:</div>
+            <div class="col-xs-8 value"><%= dossier.hostname.first || 'Nothing :(' %></div>
+        </div>
+    </div>
+</div>
+</div>
+<% end %>
+</div>
+</div>

data/gui/views/layout.rhtml

@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
+    <title>Hidden Hippo</title>
+
+    <!-- Latest compiled and minified CSS -->
+    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">
+    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap-theme.min.css">
+    <link rel="stylesheet" href="hidden-hippo.css">
+
+    <link rel="icon" type="image/png" href="favicon.png">
+
+    <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+    <!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
+    <!--[if lt IE 9]>
+    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+    <![endif]-->
+</head>
+<body>
+
+<%= yield %>
+
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
+</body>
+</html>

data/gui/views/possibilities.rhtml

@@ -0,0 +1,10 @@
+<h3><%= name %></h3>
+<% if possibilities.any? %>
+    <ul>
+    <% possibilities.each do |possibility| %>
+    <li><%= possibility %></li>
+    <% end %>
+    </ul>
+<% else %>
+    <p>Nothing here :(</p>
+<% end %>

data/hidden-hippo.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hidden_hippo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hidden-hippo'
+  spec.version       = HiddenHippo::VERSION
+  spec.authors       = ['Boris Bera', 'Clément Zotti', 'François Genois', 'Ulrich Kossou']
+  spec.email         = ['bboris@rsoft.ca', nil, nil, nil]
+  spec.summary       = %q{A tool that identifies the people around by sniffing network traffic and mining social networks.}
+  spec.homepage      = 'https://github.com/beraboris/hidden-hippo'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rspec-retry', '~> 0.4'
+  spec.add_development_dependency 'shoulda-matchers', '~> 2.8'
+  spec.add_development_dependency 'pry'
+
+  spec.add_dependency 'thor', '~> 0.19'
+  spec.add_dependency 'sinatra', '~> 1.4'
+  spec.add_dependency 'thin', '~> 1.6'
+  spec.add_dependency 'mongoid', '~> 4.0'
+end

data/lib/hidden_hippo/cli/app.rb

@@ -0,0 +1,23 @@
+require 'thor'
+require 'hidden_hippo'
+require 'hidden_hippo/cli/database'
+require 'hidden_hippo/cli/gui'
+require 'hidden_hippo/reader'
+
+module HiddenHippo
+  module Cli
+    class App < Thor
+      desc 'db start|stop|status', 'control the database service'
+      subcommand 'db', Database
+      
+      desc 'gui start|stop|status', 'control the gui service'
+      subcommand 'gui', Gui
+
+      desc 'read [FILE]', 'parse a pcap file'
+      def read(file)
+        HiddenHippo.configure_db!
+        Reader.new(file).call
+      end
+    end
+  end
+end

data/lib/hidden_hippo/cli/database.rb

@@ -0,0 +1,47 @@
+require 'thor'
+require 'hidden_hippo/daemon'
+
+module HiddenHippo
+  module Cli
+    class Database < Thor
+      class Daemon < HiddenHippo::Daemon
+        def initialize
+          super('db')
+        end
+
+        protected
+
+        def run
+          db_path.mkpath
+
+          Process.spawn 'mongod',
+                        '--dbpath', db_path.to_s,
+                        '--port', '28018',
+                        '--smallfiles',
+                        '--logpath', log_file.to_s
+        end
+
+        def db_path
+          home + 'store/db'
+        end
+      end
+
+      namespace :db
+
+      desc 'start', 'start the database service'
+      def start
+        Daemon.new.start
+      end
+
+      desc 'stop', 'stop the database service'
+      def stop
+        Daemon.new.stop
+      end
+
+      desc 'status', 'check if the database is running'
+      def status
+        Daemon.new.status
+      end
+    end
+  end
+end

data/lib/hidden_hippo/cli/gui.rb

@@ -0,0 +1,51 @@
+require 'thor'
+require 'thin'
+require 'hidden_hippo'
+require 'hidden_hippo/daemon'
+require 'hidden_hippo/gui'
+
+module HiddenHippo
+  module Cli
+    class Gui < Thor
+      class Daemon < HiddenHippo::Daemon
+        def initialize
+          super('gui')
+        end
+
+        protected
+
+        def run
+          pid = fork do
+            HiddenHippo.configure_db!
+
+            server = Thin::Server.new '0.0.0.0', 5432, HiddenHippo::Gui
+            server.log_file = log_file.to_s
+            server.reopen_log
+            server.start
+          end
+
+          puts 'To access the gui, point your browser to http://localhost:5432'
+
+          pid
+        end
+      end
+
+      namespace :gui
+
+      desc 'start', 'start the gui service'
+      def start
+        Daemon.new.start
+      end
+
+      desc 'stop', 'stop the gui service'
+      def stop
+        Daemon.new.stop
+      end
+
+      desc 'status', 'check if the gui service is running'
+      def status
+        Daemon.new.status
+      end
+    end
+  end
+end

data/lib/hidden_hippo/daemon.rb

@@ -0,0 +1,90 @@
+require 'hidden_hippo/paths'
+
+module HiddenHippo
+  class Daemon
+    include HiddenHippo::Paths
+
+    def initialize(name)
+      @name = name
+    end
+
+    def start
+      if running?
+        puts "#{@name} is already running"
+        puts "If this is not the case, delete #{pid_file}"
+        exit 1
+      else
+        if stale_pid_file?
+          puts 'Found a stale pid file, removing it'
+          pid_file.delete
+        end
+
+        pid_file.dirname.mkpath
+        log_file.dirname.mkpath
+
+        pid = run
+
+        File.write pid_file, pid
+
+        puts "Started #{@name} service"
+      end
+    end
+
+    def stop
+      if pid_file.exist?
+        pid = pid_file.read.to_i
+        Process.kill 15, pid
+        pid_file.delete
+      else
+        puts "#{@name} service is not running"
+        exit 1
+      end
+    end
+
+    def status
+      if pid_file.exist?
+        pid = pid_file.read.to_i
+        if HiddenHippo.pid_exists? pid
+          puts "#{@name} is running with pid #{pid}"
+          exit 0
+        else
+          puts "#{@name} is not running, but the pid file is present"
+          puts "You may need to delete #{pid_file}"
+          exit 2
+        end
+      else
+        puts "#{@name} is not running"
+        exit 1
+      end
+    end
+
+    protected
+
+    # Start the daemon in the background
+    #
+    # Sub classes should implement this method to start their daemon
+    #
+    # @return the pid of the process
+    def run
+      nil
+    end
+
+    def pid_file
+      home + 'pid' + "#{@name}.pid"
+    end
+
+    def log_file
+      home + 'log' + "#{@name}.log"
+    end
+
+    private
+
+    def running?
+      pid_file.exist? && HiddenHippo.pid_exists?(pid_file.read.to_i)
+    end
+
+    def stale_pid_file?
+      pid_file.exist? && !HiddenHippo.pid_exists?(pid_file.read.to_i)
+    end
+  end
+end