wifimap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf34d96b423042eeb6528fc637a1d3b622d1d14881b495882b9be47212d31b38
+  data.tar.gz: 04c7fde8424f6885c1a932a7dffe0492465f0ab36fe11d37b37c012088ef614e
+SHA512:
+  metadata.gz: 1152bf26fe94bdc03d45aac4d678d4c494912eac9a5977d81bccbdef58c412a27f48ce11c930876502e47350592552f0aa856c383b2d17d5a773d0a4d4a38a21
+  data.tar.gz: 6e8dfc0f49d28ee6b540f066548f80c77befbe74b9d9fecef0988e46c30e825718f313741468a0a91aaf7863cf8367a22cffbf431c598d9271d087aed40437c2

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at gianpiero.addis@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in wifimap.gemspec
+gemspec
+
+gem "rake", "~> 12.3"
+gem "rspec", "~> 3.0"
+gem 'coveralls', require: false

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    wifimap (0.1.0)
+      louis
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    json (2.3.0)
+    louis (2.2.4)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.0.1)
+    tins (1.24.1)
+      sync
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls
+  rake (~> 12.3)
+  rspec (~> 3.0)
+  wifimap!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Gianpiero Addis
+
+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,76 @@
+# Wifimap
+[![Build Status](https://travis-ci.com/gpaddis/wifimap.svg?branch=master)](https://travis-ci.com/gpaddis/wifimap)
+[![Coverage Status](https://coveralls.io/repos/github/gpaddis/wifimap/badge.svg?branch=master)](https://coveralls.io/github/gpaddis/wifimap?branch=master)
+
+Parse wifi dump files and get a structured collection of access points and stations, including probes and associations (see [supported dump formats](#supported-dump-formats)). You can then import the formatted data into your application, e.g. to build a database or a map of wireless networks and clients.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wifimap'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install wifimap
+
+## Usage
+
+Require the parser and pass the content of a dump file to the `parse` method:
+```rb
+require 'wifimap/parser'
+
+dump = File.read('airodump.csv')
+parsed = Wifimap::Parser.parse(dump)
+
+parsed.access_points  # returns an array of AccessPoint objects
+parsed.stations       # returns an array of Station objects
+```
+
+### Attributes
+
+An AccessPoint instance contains the following attributes:
+
+```rb
+access_point.bssid         # ex.: '04:F0:21:13:32:29'
+access_point.privacy       # ex.: 'WPA2'
+access_point.essid         # ex.: 'Home Network'
+access_point.manufacturer  # ex.: 'Compex Systems Pte Ltd'
+```
+
+A Station instance contains the following attributes:
+
+```rb
+station.mac           # ex.: 'AE:91:B5:23:87:9D'
+station.associations  # ex.: ['04:F0:21:13:32:29']
+station.probes        # ex.: ['Home Network']
+station.manufacturer  # ex.: 'Apple, Inc.'
+```
+
+### Supported dump formats
+- Airodump CSV ([airodump-ng](https://www.aircrack-ng.org/doku.php?id=airodump-ng))
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gpaddis/wifimap. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/wifimap/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Wifimap project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/wifimap/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wifimap"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/wifimap/access_point.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Wifimap
+  class AccessPoint
+    attr_reader :bssid, :privacy, :essid
+
+    def initialize(bssid:, privacy:, essid:)
+      @bssid = bssid
+      @privacy = privacy
+      @essid = essid
+    end
+
+    # Get the device manufacturer based on the bssid.
+    def manufacturer
+      Mac.manufacturer(bssid)
+    end
+  end
+end

data/lib/wifimap/mac.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'louis'
+
+module Wifimap
+  class Mac
+    # Return true if the mac format is correct, false otherwise.
+    def self.valid?(mac)
+      mac =~ /([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})/ ? true : false
+    end
+
+    # Get the manufacturer for the given mac address.
+    def self.manufacturer(mac)
+      Louis.lookup(mac)['long_vendor']
+    end
+  end
+end

data/lib/wifimap/parser/airodump.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'wifimap/mac'
+require 'wifimap/station'
+require 'wifimap/access_point'
+
+module Wifimap
+  module Parser
+    # Parse the content of an airodump.csv file.
+    class Airodump
+      def initialize(dump)
+        @dump = dump
+      end
+
+      # Get the list of access points from the dump.
+      def access_points
+        aps = @dump.split("\n").filter do |row|
+          fields = row.split(',')
+          channel = fields[3].to_i
+          Mac.valid?(fields.first) && channel.between?(1, 16)
+        end
+
+        aps.map do |ap|
+          fields = ap.split(',')
+          AccessPoint.new(
+            bssid: fields.first,
+            privacy: fields[5].strip,
+            essid: fields[13].strip
+          )
+        end
+      end
+
+      # Get the list of stations from the dump.
+      def stations
+        stations = @dump.split("\n").filter do |row|
+          fields = row.split(',')
+          power = fields[3].to_i
+          Mac.valid?(fields.first) && power.negative?
+        end
+
+        stations.map do |row|
+          fields = row.split(',')
+          station = Station.new(mac: fields.first)
+          unless fields[5].include?('(not associated)')
+            station.associations << fields[5].strip
+          end
+
+          station.probes << fields[6].strip unless fields[6].strip.empty?
+
+          station
+        end
+      end
+    end
+  end
+end

data/lib/wifimap/parser.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'wifimap/parser/airodump'
+
+module Wifimap
+  module Parser
+    # Parse the content of a dump file and return a hash of APs, stations and probes.
+    def self.parse(file_content)
+      case dump_format(file_content)
+      when :airodump
+        Wifimap::Parser::Airodump.new(file_content)
+      else
+        raise Error, 'Unsupported dump format'
+      end
+    end
+
+    # Check the file content and identify the dump format.
+    def self.dump_format(file_content)
+      airodump_header = 'BSSID, First time seen, Last time seen, channel, Speed, Privacy, Cipher, Authentication, Power'
+      :airodump if file_content.include?(airodump_header)    end
+  end
+end

data/lib/wifimap/station.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Wifimap
+  class Station
+    attr_reader :mac
+    attr_accessor :associations, :probes
+
+    def initialize(mac:)
+      @mac = mac
+      @associations = []
+      @probes = []
+    end
+
+    # Get the device manufacturer based on the mac.
+    def manufacturer
+      Mac.manufacturer(mac)
+    end
+  end
+end

data/lib/wifimap/version.rb

@@ -0,0 +1,3 @@
+module Wifimap
+  VERSION = "0.1.0"
+end

data/lib/wifimap.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'wifimap/version'
+
+module Wifimap
+  class Error < StandardError; end
+end

data/wifimap.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'lib/wifimap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'wifimap'
+  spec.version       = Wifimap::VERSION
+  spec.authors       = ['Gianpiero Addis']
+  spec.email         = ['gianpiero.addis@gmail.com']
+
+  spec.summary       = 'Parse wifi sniffer dump files.'
+  spec.homepage      = 'https://github.com/gpaddis/wifimap'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/gpaddis/wifimap'
+  spec.metadata['changelog_uri'] = 'https://github.com/gpaddis/wifimap/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'louis'
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: wifimap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gianpiero Addis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: louis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- gianpiero.addis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wifimap.rb
+- lib/wifimap/access_point.rb
+- lib/wifimap/mac.rb
+- lib/wifimap/parser.rb
+- lib/wifimap/parser/airodump.rb
+- lib/wifimap/station.rb
+- lib/wifimap/version.rb
+- wifimap.gemspec
+homepage: https://github.com/gpaddis/wifimap
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gpaddis/wifimap
+  source_code_uri: https://github.com/gpaddis/wifimap
+  changelog_uri: https://github.com/gpaddis/wifimap/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Parse wifi sniffer dump files.
+test_files: []