eff_passphrase 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 64a013de2942fc88936bd48c8f9dba5792517cc58f8345ceadf509cbed40ffd0
+  data.tar.gz: d90ee3d87be418c363c90b148fe99c803625f8210077b8766cc1f1da79f362bc
+SHA512:
+  metadata.gz: 6498b3b39f2281ff62317392b65e1eb6402652186326700ef0a66612e7164ffae8e43672db08c0e5b174dba32ed684dfb1f3a9556cec3444951cd6ea53a7bfb0
+  data.tar.gz: 94297d30056efab7b7eec98aed05ac28d6d6a652a7df68ac0e8e674eafda80babdbcf3f9ddcc7e19e13b374dd409687777af9b5078b624bb325f134d41b2cd26

data/CHANGELOG.md

@@ -0,0 +1 @@
+# ChangeLog

data/LICENSE.txt

@@ -0,0 +1,5 @@
+Copyright 2023 Instrumentl, Inc.
+
+Permission to use, copy, modify, and/or 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/README.md

@@ -0,0 +1,39 @@
+This repository contains a very simple Ruby library for using the EFF's [Diceware wordlists](https://www.eff.org/dice) to generate secure passphrases.
+
+"EFF®" is a registered trademark of the [Electronic Frontier Foundation](https://www.eff.org/). This repository and project are in no way affiliated by, endorsed by, or associated with the Electronic Frontier Foundation Foundation.
+
+## Usage
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eff_passphrase'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install eff_passphrase
+```
+
+## Invocation
+
+```ruby
+require "eff_passphrase"
+
+EffPassphrase.generate(num_words: 6)
+```
+
+This returns an object whose `.to_s` is the raw password, and which includes a helpful `.bits_of_security` field.
+
+You can select a wordlist with the `list` kwarg; the following lists are available:
+
+ - `eff_large_wordlist` (default)
+ - `eff_short_wordlist_1` (shorter words; you should use more of them to get the same bits of security)
+ - `eff_short_wordlist_2_0` (shorter words; you should use more of them to get the same bits of security)
+ - `unsafe_extremely_small` (don't use this except for testing)

data/lib/eff_passphrase/lists.rb

@@ -0,0 +1,19 @@
+module EffPassphrase
+  module Lists
+    LOADED = {}
+
+    def self.get(list_name)
+      unless LOADED.has_key? list_name
+        if list_name.include? ".."
+          raise "No path injection attacks for you"
+        end
+
+        path = File.expand_path("../../../wordlists/#{list_name}.txt", __FILE__)
+        File.open(path) do |f|
+          LOADED[list_name] = f.readlines.map { |s| s.strip }
+        end
+      end
+      LOADED[list_name]
+    end
+  end
+end

data/lib/eff_passphrase/passphrase.rb

@@ -0,0 +1,22 @@
+module EffPassphrase
+  class Passphrase
+    attr_reader :bits_of_security
+
+    def initialize(s, bits_of_security)
+      @inner = s
+      @bits_of_security = bits_of_security
+    end
+
+    def length
+      @inner.length
+    end
+
+    def [](i)
+      @inner[i]
+    end
+
+    def to_s
+      @inner
+    end
+  end
+end

data/lib/eff_passphrase/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EffPassphrase
+  VERSION = "0.1.0"
+end

data/lib/eff_passphrase.rb

@@ -0,0 +1,19 @@
+require "eff_passphrase/version"
+require "eff_passphrase/lists"
+require "eff_passphrase/passphrase"
+
+require "securerandom"
+
+module EffPassphrase
+  # Generate a new passphrase from the given list.
+  def self.generate(num_words: 6, separator: "-", list: "eff_large_wordlist")
+    words = EffPassphrase::Lists.get(list)
+    bits_per_word = Math.log(words.length, 2)
+    bits_of_security = bits_per_word.floor.to_i * num_words
+    s_passphrase = num_words.times.map do
+      index = SecureRandom.random_number(0...words.length)
+      words[index]
+    end.join(separator)
+    EffPassphrase::Passphrase.new(s_passphrase, bits_of_security)
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: eff_passphrase
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Instrumentl, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-01-10 00:00:00.000000000 Z
+dependencies: []
+description: |2
+      Library for using the EFF's list of Engliush passphrase words to generate
+      a Diceware-style passphrase
+email:
+- oss@instrumentl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/eff_passphrase.rb
+- lib/eff_passphrase/lists.rb
+- lib/eff_passphrase/passphrase.rb
+- lib/eff_passphrase/version.rb
+homepage: https://github.com/instrumentl/eff_passphrase
+licenses:
+- ISC
+metadata:
+  homepage_uri: https://github.com/instrumentl/eff_passphrase
+  source_code_uri: https://github.com/instrumentl/eff_passphrase
+  changelog_uri: https://github.com/instrumentl/eff_passphrase/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: Library for generating passphrases
+test_files: []