bkerley-affine 0.1.0 → 0.2.0

data/VERSION.yml

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

data/lib/affine/cipher.rb

@@ -1,5 +1,24 @@
 module Affine
+  # The affine cipher for positive integers.  This algorithm is only defined
+  # for positive integers, and many arguments have further restrictions.
+  #
+  # == Usage
+  #
+  #   @a = Affine::Cipher.new(2176782371, 65182241782, 123235151)
+  #   ct = @a.encipher(14)
+  #   14 == @a.decipher(ct)
   class Cipher
+
+    # Cipher objects are used both for decryption and encryption.
+    #
+    # == Arguments
+    # [+modulus+] specifies how many different plaintexts and ciphertexts
+    #             are available.
+    # [+a_key+] multiplied against the plaintext. <b>Must be coprime with
+    #           +modulus+.</b>
+    # [+b_key+] added to the multiplied plaintext.  No restrictions, but
+    #           it's modulus math, so making it larger than +modulus+ is
+    #           useless.
     def initialize(modulus, a_key, b_key)
       raise CoprimeError.new(modulus, a_key) if modulus.gcd(a_key) != 1
       @modulus = modulus
@@ -7,15 +26,21 @@ module Affine
       @b_key = b_key
       @a_inv = extended_gcd(a_key, modulus)
     end
+
+    # Encrypt one +plaintext+ into a +ciphertext+.
     def encipher(plaintext)
       raise RangeError.new(plaintext, @modulus) if plaintext > @modulus
       ((@a_key * plaintext) + @b_key) % @modulus
     end
+
+    # Decrypt one +ciphertext+ into a +plaintext+.
     def decipher(ciphertext)
       raise RangeError.new(ciphertext, @modulus) if ciphertext > @modulus
       (@a_inv * (ciphertext - @b_key)) % @modulus
     end
 
+    alias_method :encrypt, :encipher
+    alias_method :decrypt, :decipher
     private
     # from http://snippets.dzone.com/posts/show/6074
     def extended_gcd(b,m,_recursion_depth=0)

data/lib/affine/errors.rb

@@ -1,13 +1,29 @@
 module Affine
+
+  # Parent class for Affine cipher errors.
+  #
+  # This is a good kind of error to rescue when you're not
+  # sure about the key, modulus, plaintext, or ciphertext
+  # and want to fail cleanly.
   class AffineError < StandardError
   end
+
+  # Raised when two numbers that are supposed to be coprime
+  # (greatest common denominator of 1) are not.
+  #
+  # Keys and moduli from external sources might raise these.
   class CoprimeError < AffineError
-    def initialize(a, b)
+    def initialize(a, b) #:nodoc:
       super("Expected #{a} to be coprime with #{b}")
     end
   end
+
+  # Raised when an input number is larger than the modulus.
+  #
+  # Plaintexts or ciphertexts from external sources might
+  # raise these.
   class RangeError < AffineError
-    def initialize(n, mod)
+    def initialize(n, mod) #:nodoc:
       super("Expected input #{n} to be smaller than modulus #{mod}")
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bkerley-affine
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Bryce Kerley
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-14 00:00:00 -07:00
+date: 2009-05-16 00:00:00 -07:00
 default_executable: 
 dependencies: []