affine 0.2.1 → 0.2.2

data/README.rdoc

@@ -1,10 +1,37 @@
 = affine
 
-Simple affine cipher
+An affine cipher is a monoalphabetic substitution cipher, that uses
+math to generate the substitution alphabet based on three paramaters:
+
+[modulus] specifies how many different plaintexts and ciphertexts
+          are available.
+[a_key] multiplied against the plaintext. <b>Must be coprime with
+        the modulus.</b>
+[b_key] added to the multiplied plaintext.  No restrictions, but
+        it's modulus math, so making it larger than +modulus+ is
+        useless.
+
+These parameters are passed in order to the Cipher constructor:
 
     a = Affine::Cipher.new(2176782371, 65182241782, 123235151)
     r = rand(123235150) # (should be smaller then the modulus)
-    r == a.decipher(a.encipher r)
+    ciphertext = a.encipher r
+    # ciphertext = ((r * 65182241782) + 123235151) % 2176782371
+    r == a.decipher(ciphertext)
+
+== Giant security caveat
+
+Don't use this cipher for security related tasks.  I'm using it
+to make primary keys alphanumeric and less-predictable:
+http://github.com/bkerley/have-code/
+
+== How to crack it
+
+Know two plaintexts and their ciphertexts, put into linear system, solve.
+
+Know the relation between two plaintexts, predict future ciphertexts.
+
+Know lots of ciphertexts, guess it's English, solve like a cryptogram.
 
 == Copyright
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 1
+:patch: 2
 :major: 0
 :minor: 2

data/affine.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{affine}
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bryce Kerley"]
-  s.date = %q{2009-05-18}
+  s.date = %q{2009-06-10}
   s.email = %q{bkerley@brycekerley.net}
   s.extra_rdoc_files = [
     "LICENSE",

data/lib/affine/cipher.rb

@@ -28,12 +28,20 @@ module Affine
     end
 
     # Encrypt one +plaintext+ into a +ciphertext+.
+    #
+    # == Argument
+    # [+plaintext+] a single positive integer between 0 and the +modulus+
+    #               for the cipher
     def encipher(plaintext)
       raise RangeError.new(plaintext, @modulus) if plaintext > @modulus
       ((@a_key * plaintext) + @b_key) % @modulus
     end
 
     # Decrypt one +ciphertext+ into a +plaintext+.
+    #
+    # == Argument
+    # [+ciphertext+] a single positive integer between 0 and the +modulus+
+    #               for the cipher
     def decipher(ciphertext)
       raise RangeError.new(ciphertext, @modulus) if ciphertext > @modulus
       (@a_inv * (ciphertext - @b_key)) % @modulus

data/lib/affine/errors.rb

@@ -13,7 +13,7 @@ module Affine
   #
   # Keys and moduli from external sources might raise these.
   class CoprimeError < AffineError
-    def initialize(a, b) #:nodoc:
+    def initialize(a, b) #:nodoc: :notnew:
       super("Expected #{a} to be coprime with #{b}")
     end
   end
@@ -23,7 +23,7 @@ module Affine
   # Plaintexts or ciphertexts from external sources might
   # raise these.
   class RangeError < AffineError
-    def initialize(n, mod) #:nodoc:
+    def initialize(n, mod) #:nodoc: :notnew:
       super("Expected input #{n} to be smaller than modulus #{mod}")
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: affine
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - Bryce Kerley
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-18 00:00:00 -04:00
+date: 2009-06-10 00:00:00 -04:00
 default_executable: 
 dependencies: []