firefox-data 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69f8af3ca8b398607350277c4525297d73cf77c0
+  data.tar.gz: 68217687204f43a15abc0d1db16404c0b820fecf
+SHA512:
+  metadata.gz: b4796e5e185a385c37052bb3d6f07c312c44c7f73029d8fd8e93dee677a44ffdd3df6800c3f2da5b870a5a5cf47d40f1db559ac13d2d070a0867dca72c8cc5ea
+  data.tar.gz: 7ca0eff0b21d59cb366d4f228bd6fec66d3111b8c6935f9665f39889ad5ab8ac1f6f52c6ee058ae4521c43c0706e55ed94fbdebba616a8abcff933e5cc6e44d3

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2017 Nicolas Martyanoff <khaelin@gmail.com>
+
+Permission to use, copy, modify, and distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/bin/firefox-data

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby
+#
+# Copyright (c) 2017 Nicolas Martyanoff <khaelin@gmail.com>
+#
+# Permission to use, copy, modify, and distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+require 'bundler/setup'
+
+require 'firefox'
+require 'nss'
+require 'termios'
+require 'thor'
+
+class FirefoxData < Thor
+  class_option :profile,
+    desc: 'the name of the profile',
+    banner: 'NAME',
+    type: :string,
+    default: 'default',
+    aliases: ['p']
+
+  desc "search-logins REGEXP", "Search for logins in the password database"
+  option :password,
+    desc: 'ask for the master password',
+    type: :boolean,
+    aliases: ['w']
+  def search_logins(re_string)
+    re = Regexp.new(re_string, Regexp::IGNORECASE)
+
+    index = Firefox::ProfileIndex.new()
+    index.load()
+
+    profile = index.profiles[options[:profile]]
+
+    password = ''
+    if options[:password]
+      password = ask_password()
+    end
+
+    NSS.init(profile.path)
+    NSS.authenticate(password)
+
+    profile.load_logins(decrypt: true)
+    matches = profile.logins.select {|l| l.hostname.match? re}
+    renders = matches.map do |login|
+      "hostname  #{login.hostname}\n" + \
+      "username  #{login.username}\n" + \
+      "password  #{login.password}\n"
+    end
+    puts renders.join("\n")
+  end
+
+  no_commands do
+    def without_term_echo(&block)
+      attr = Termios.tcgetattr($stdin)
+
+      nattr = attr.dup
+      nattr.c_lflag &= ~(Termios::ECHO | Termios::ICANON)
+      Termios.tcsetattr($stdin, Termios::TCSANOW, nattr)
+
+      begin
+        yield
+      ensure
+        Termios.tcsetattr($stdin, Termios::TCSANOW, attr)
+      end
+    end
+
+    def ask_password()
+      printf('Password: ')
+
+      password = ''
+
+      without_term_echo() do
+        password = $stdin.gets().chomp()
+        puts ''
+      end
+
+      password
+    end
+  end
+end
+
+FirefoxData.start(ARGV)

data/firefox-data.gemspec

@@ -0,0 +1,21 @@
+
+require 'rake'
+
+Gem::Specification.new do |s|
+  s.name = 'firefox-data'
+  s.version = '1.0.0'
+  s.date = '2017-02-11'
+  s.summary = 'A library to extract data from firefox profiles.'
+  s.description = 'The firefox-data library extracts various types of ' + \
+    'data from firefox profiles.'
+  s.homepage = 'https://github.com/galdor/rb-firefox-data'
+  s.license = 'ISC'
+  s.author = 'Nicolas Martyanoff'
+  s.email = 'khaelin@gmail.com'
+
+  s.required_ruby_version = '>= 2.4.0'
+
+  s.files = FileList['firefox-data.gemspec', 'LICENSE',
+                     'bin/*.rb', 'lib/**/*.rb']
+  s.executables = ['firefox-data']
+end

data/lib/firefox.rb

@@ -0,0 +1,25 @@
+# Copyright (c) 2017 Nicolas Martyanoff <khaelin@gmail.com>
+#
+# Permission to use, copy, modify, and distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+require 'bundler/setup'
+
+require 'pathname'
+
+module Firefox
+  ROOT_PATH = Pathname.new("#{Dir.home}/.mozilla/firefox")
+end
+
+require 'firefox/profile_index'
+require 'firefox/profile'
+require 'firefox/login'

data/lib/firefox/login.rb

@@ -0,0 +1,109 @@
+# Copyright (c) 2017 Nicolas Martyanoff <khaelin@gmail.com>
+#
+# Permission to use, copy, modify, and distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+require 'date'
+
+require 'json-schema'
+
+require 'nss'
+
+module Firefox
+  class InvalidLogin < StandardError
+  end
+
+  class Login
+    JSON_SCHEMA = {
+      'type' => 'object',
+      'required' => ['id', 'hostname',
+                     'encryptedUsername', 'encryptedPassword'],
+      'properties' => {
+        'id' => {'type': 'integer'},
+        'hostname' => {'type': 'string'},
+        'httpRealm' => {'type': ['string', 'null']},
+        'formSubmitURL' => {'type': ['string', 'null']},
+        'usernameField' => {'type': ['string', 'null']},
+        'passwordField' => {'type': ['string', 'null']},
+        'encryptedUsername' => {'type': 'string'},
+        'encryptedPassword' => {'type': 'string'},
+        'guid' => {'type': ['string', 'null']},
+        'encType' => {'type': 'integer'},
+        'timeCreated' => {'type': 'integer'},
+        'timeLastUsed' => {'type': 'integer'},
+        'timePasswordChanged' => {'type': 'integer'},
+        'timesUsed' => {'type': 'integer'},
+      },
+    }
+
+    attr_accessor :id, :hostname, :http_realm, :form_submit_url,
+                  :username_field, :password_field,
+                  :encrypted_username, :encrypted_password, :enc_type,
+                  :username, :password,
+                  :guid,
+                  :time_created, :time_last_used, :time_password_changed,
+                  :times_used
+
+    def initialize()
+    end
+
+    def to_s()
+      "#<Firefox::Login #{@hostname}>"
+    end
+
+    def inspect()
+      to_s()
+    end
+
+    def self.from_json(data)
+      # In firefox (checked in the mercurial repository on 2017-02-11),
+      # logins.json is updated in
+      # toolkit/components/passwordmgr/storage-json.js
+
+      begin
+        JSON::Validator.validate!(JSON_SCHEMA, data)
+      rescue JSON::Schema::ValidationError => err
+        raise InvalidLogin, "invalid login data: #{err.message}"
+      end
+
+      login = Login.new()
+
+      to_date = lambda do |timestamp|
+        seconds = timestamp / 1000
+        milliseconds = timestamp % 1000
+        Time.at(seconds, milliseconds).utc()
+      end
+
+      login.id = data['id']
+      login.hostname = data['hostname']
+      login.http_realm = data['httpRealm']
+      login.form_submit_url = data['formSubmitURL']
+      login.username_field = data['usernameField']
+      login.password_field = data['passwordField']
+      login.encrypted_username = data['encryptedUsername']
+      login.encrypted_password = data['encryptedPassword']
+      login.enc_type = data['encType']
+      login.guid = data['guid']
+      login.time_created = to_date.(data['timeCreated'])
+      login.time_last_used = to_date.(data['timeLastUsed'])
+      login.time_password_changed = to_date.(data['timePasswordChanged'])
+      login.times_used = data['timesUsed']
+
+      login
+    end
+
+    def decrypt()
+      @username = NSS.decrypt(@encrypted_username)
+      @password = NSS.decrypt(@encrypted_password)
+    end
+  end
+end

data/lib/firefox/profile.rb

@@ -0,0 +1,54 @@
+# Copyright (c) 2017 Nicolas Martyanoff <khaelin@gmail.com>
+#
+# Permission to use, copy, modify, and distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+require 'json'
+
+module Firefox
+  class InvalidProfile < StandardError
+  end
+
+  class Profile
+    attr_reader :name, :path, :logins
+
+    def initialize(name, path)
+      @name = name
+      @path = path
+      @logins = nil
+    end
+
+    def to_s()
+      "#<Firefox::Profile #{@name}>"
+    end
+
+    def inspect()
+      to_s()
+    end
+
+    def load_logins(decrypt: false)
+      path = @path.join('logins.json')
+      data = JSON.parse(File.read(path))
+      unless data.key? 'logins'
+        raise InvalidProfile, "missing 'logins' entry in #{path}"
+      end
+
+      logins = []
+      data['logins'].each do |login_data|
+        login =  Login.from_json(login_data)
+        login.decrypt() if decrypt
+        logins << login
+      end
+      @logins = logins
+    end
+  end
+end

data/lib/firefox/profile_index.rb

@@ -0,0 +1,65 @@
+# Copyright (c) 2017 Nicolas Martyanoff <khaelin@gmail.com>
+#
+# Permission to use, copy, modify, and distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+module Firefox
+  class ProfileIndex
+    DEFAULT_PATH = ROOT_PATH.join('profiles.ini')
+
+    attr_reader :path, :profiles
+
+    def initialize(path: DEFAULT_PATH)
+      @path = path
+      @profiles = {}
+    end
+
+    def load()
+      sections = []
+      section = nil
+
+      File.open(@path).each do |line|
+        if line.match(/^\[([^\]]+)\]/)
+          title = $1
+          next if title == 'General'
+
+          section = {}
+          sections << section
+        elsif !section.nil? && line.match(/^([^=]+)\s*=\s*(.*)/)
+          key = $1
+          value = $2
+
+          section[key] = value
+        end
+      end
+
+      profiles = {}
+      sections.each do |section|
+        name = section['Name']
+        path = Pathname.new(section['Path'])
+        is_relative = section['IsRelative']
+
+        if is_relative == '1'
+          path = ROOT_PATH.join(path)
+        end
+
+        profile = Profile.new(name, path)
+        profiles[name] = profile
+      end
+      @profiles = profiles
+    end
+
+    def profile?(name)
+      return @profiles.key? name
+    end
+  end
+end

data/lib/nss.rb

@@ -0,0 +1,123 @@
+# Copyright (c) 2017 Nicolas Martyanoff <khaelin@gmail.com>
+#
+# Permission to use, copy, modify, and distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+require 'ffi'
+
+module NSSFFI
+  extend FFI::Library
+
+  class SecItemStr < FFI::Struct
+    layout :type, :int,
+           :data, :pointer,
+           :len, :uint
+
+    def string()
+      self[:data].read_string(self[:len])
+    end
+  end
+
+  ffi_lib 'nss3'
+
+  enum :sec_status, [:wouldblock, -2,
+                     :failure, -1,
+                     :success, 0]
+
+  typedef :int, :pr_bool
+  typedef SecItemStr.ptr(), :sec_item
+  typedef :int, :sec_item_type
+  typedef :pointer, :pl_arena_pool
+  typedef :pointer, :pk11_slot_info
+
+  attach_function :nss_init, 'NSS_Init', [:string], :sec_status
+  attach_function :nss_base64_decode_buffer, 'NSSBase64_DecodeBuffer',
+    [:pl_arena_pool, :sec_item, :string, :uint], :sec_item
+
+  attach_function :pk11_get_internal_key_slot, 'PK11_GetInternalKeySlot',
+    [], :pk11_slot_info
+  attach_function :pk11_free_slot, 'PK11_FreeSlot', [:pk11_slot_info], :void
+  attach_function :pk11_check_user_password, 'PK11_CheckUserPassword',
+    [:pk11_slot_info, :string], :sec_status
+  attach_function :pk11sdr_decrypt, 'PK11SDR_Decrypt',
+    [:sec_item, :sec_item, :pointer], :sec_status
+
+  attach_function :secitem_alloc_item, 'SECITEM_AllocItem',
+    [:pl_arena_pool, :sec_item, :uint], :sec_item
+  attach_function :secitem_free_item, 'SECITEM_FreeItem',
+    [:sec_item, :pr_bool], :void
+end
+
+module NSS
+  class Error < StandardError
+  end
+
+  def self.init(profile_path)
+    res = NSSFFI.nss_init(profile_path.to_s())
+    raise NSS::Error, "cannot initialize nss" unless res == :success
+  end
+
+  def self.with_internal_key_slot(&block)
+    slot = NSSFFI.pk11_get_internal_key_slot()
+    raise NSS::Error, "cannot retrieve internal key slot" if slot.nil?
+
+    begin
+      yield slot
+    ensure
+      NSSFFI.pk11_free_slot(slot)
+    end
+  end
+
+  def self.check_user_password(slot, password)
+    res = NSSFFI.pk11_check_user_password(slot, password)
+    raise NSS::Error, "authentication failed" unless res == :success
+  end
+
+  def self.authenticate(password)
+    with_internal_key_slot do |slot|
+      check_user_password(slot, password)
+    end
+  end
+
+  def self.base64_decode(str, &block)
+    str_item = NSSFFI.nss_base64_decode_buffer(nil, nil, str, str.bytesize())
+    raise NSS::Error, "cannot decode base64 string" if str_item.nil?
+
+    begin
+      yield str_item
+    ensure
+      NSSFFI.secitem_free_item(str_item, 1)
+    end
+  end
+
+  def self.decrypt(b64str)
+    base64_decode(b64str) do |str_item|
+      with_sec_item do |res_item|
+        res = NSSFFI.pk11sdr_decrypt(str_item, res_item, nil)
+        raise NSS::Error, "cannot decrypt string" unless res == :success
+
+        res_item.string()
+      end
+    end
+  end
+
+  def self.with_sec_item(&block)
+    item = NSSFFI.secitem_alloc_item(nil, nil, 0)
+    raise NSS::Error, "cannot allocate sec item" if item.nil?
+
+    begin
+      yield item
+    ensure
+      NSSFFI.secitem_free_item(item, 1)
+    end
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: firefox-data
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nicolas Martyanoff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-11 00:00:00.000000000 Z
+dependencies: []
+description: The firefox-data library extracts various types of data from firefox
+  profiles.
+email: khaelin@gmail.com
+executables:
+- firefox-data
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- bin/firefox-data
+- firefox-data.gemspec
+- lib/firefox.rb
+- lib/firefox/login.rb
+- lib/firefox/profile.rb
+- lib/firefox/profile_index.rb
+- lib/nss.rb
+homepage: https://github.com/galdor/rb-firefox-data
+licenses:
+- ISC
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: A library to extract data from firefox profiles.
+test_files: []