firefox-hash-generator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae346bc8c98ba04ffa83b921a8968f2614704173937233623b0d0b35590e0877
+  data.tar.gz: e7b96414f78b7cdd1423fb44937b946bcdcfc2c12dbd519cea45043a3677a6c7
+SHA512:
+  metadata.gz: ddb78b81e2aa24c8fb50c3bdbfc7e7aa80a26d1742d20e9fef0d26693318f7faa6cb1de391201f380c2172d0f425f01af067a7d55e1dff153b692868e254cc1d
+  data.tar.gz: '091e33d0d376f0eba1a5c0dbc9e8888aeb6fb8dea691bfa07ba2605e82d23a8d68e9407a4ee0fabc4ecf4bd1f8782ac7045f5147d2211f4e4daa8bbabe8a0493'

data/LICENSE

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+=====================
+
+Copyright (c) 2021 Oleg Pudeyev
+
+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,54 @@
+# Firefox/Waterfox/Pale Moon Hash Generator
+
+This library generates the hashes for firefox and derived browsers' search
+engine file. The hash is needed to programmatically set the default search
+engine.
+
+## Usage
+
+  require 'firefox_hash_generator'
+  
+  FirefoxHashGenerator.generate(
+    :firefox,
+    'randombytes.default',
+    'DuckDuckGo',
+  )
+
+The first argument is the browser app name. This can be retrieved from the
+[browser console](https://developer.mozilla.org/en-US/docs/Tools/Browser_Console)
+by typing `Services.appinfo.name` for your browser. Note that the input
+control is disabled by default and is enabled by setting the `about:config`
+pref `devtools.chrome.enabled` to `true`.
+
+The app name can be provided as a string or, for convenience, a symbol that
+maps the known browsers to their app names. Currently the following browsers
+are known:
+
+- `:firefox`
+- `:pale_moon`
+- `:waterfox`
+
+The second parameter is the basename of the profile directory. It usually
+consists of a randomly generated string followed by the profile name.
+
+The third parameter is the name of the search engine that is being set as the
+default one.
+
+The entire process was copied from [this](https://blog.onee3.org/2018/04/manually-add-a-search-engine-to-firefox-quantum/)
+amazing guide by Frederick Zhang.
+
+To extract the JSON serialization of the search engine configuration from the
+`search.json.mozlz4` file (which contains a proprietary header followed by
+the LZ4-compressed JSON), use a utility like [lz4jsoncat](https://github.com/andikleen/lz4json)
+or [this Python code](https://gist.github.com/kaefer3000/73febe1eec898cd50ce4de1af79a332a)
+(which originated from [this Python code](https://gist.github.com/Tblue/62ff47bef7f894e92ed5)).
+For Ruby, a working LZ4 compressor/decompressor is
+[extlz4](https://github.com/dearblue/ruby-extlz4).
+
+## Bugs & Patches
+
+Please report via issues and pull requests.
+
+## License
+
+MIT

data/lib/firefox_hash_generator.rb

@@ -0,0 +1,36 @@
+require 'digest'
+
+module FirefoxHashGenerator
+  class UnknownAppName < StandardError; end
+
+  # @see https://blog.onee3.org/2018/04/manually-add-a-search-engine-to-firefox-quantum/
+  # @see https://developer.mozilla.org/en-US/docs/Tools/Browser_Console
+  # @see https://hg.mozilla.org/mozilla-central/rev/2ae760290f8c
+  module_function def generate(app_name, profile_basename, search_engine_name)
+    if app_name.is_a?(Symbol)
+      begin
+        app_name = APP_NAMES.fetch(app_name)
+      rescue KeyError
+        raise UnknownAppName, "The app name symbol #{app_name.inspect} is not known - either add it to the APP_NAMES constant or specify a string name"
+      end
+    end
+
+    text = profile_basename + search_engine_name + TEMPLATE.gsub('$appName', app_name)
+    Digest::SHA256.base64digest(text)
+  end
+
+  APP_NAMES = {
+    firefox: 'Firefox',
+    pale_moon: 'Pale Moon',
+    waterfox: 'Waterfox',
+  }.freeze
+
+  private
+
+  TEMPLATE = "By modifying this file, I agree that I am doing so " +
+    "only within $appName itself, using official, user-driven search " +
+    "engine selection processes, and in a way which does not circumvent " +
+    "user consent. I acknowledge that any attempt to change this file " +
+    "from outside of $appName is a malicious act, and will be responded " +
+    "to accordingly.".freeze
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: firefox-hash-generator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Oleg Pudeyev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-07-07 00:00:00.000000000 Z
+dependencies: []
+description: Firefox/Waterfox/Pale Moon search engine hash generator
+email: code@olegp.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/firefox_hash_generator.rb
+homepage: https://github.com/p/firefox-hash-generator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.5
+signing_key: 
+specification_version: 4
+summary: firefox-hash-generator-1.0.0
+test_files: []