rsa 0.1.0 → 0.1.1

data/README

@@ -17,10 +17,31 @@ Features
 * Compatible with Ruby 1.9.1+ and JRuby 1.5.0+.
 * Compatible with older Ruby versions with the help of the [Backports][] gem.
 
+Examples
+--------
+
+    require 'rsa'
+
+### Generating a new RSA key pair
+
+    key_pair = RSA::KeyPair.generate(128)
+
+### Encrypting a plaintext message
+
+    ciphertext = key_pair.encrypt("Hello, world!")
+
+### Decrypting a ciphertext message
+
+    plaintext = key_pair.decrypt(ciphertext)
+
 Documentation
 -------------
 
-* <http://rsa.rubyforge.org/>
+<http://rsa.rubyforge.org/>
+
+* {RSA::KeyPair}
+* {RSA::Key}
+* {RSA::PKCS1}
 
 Dependencies
 ------------

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/rsa/key_pair.rb

@@ -91,65 +91,140 @@ module RSA
     # Encrypts the given `plaintext` using the public key from this key
     # pair.
     #
-    # @param  [Integer, String, IO]     plaintext
+    # @overload encrypt(plaintext, options = {})
+    #   @param  [Integer]                 plaintext
+    #   @param  [Hash{Symbol => Object}]  options
+    #   @return [Integer]
+    #
+    # @overload encrypt(plaintext, options = {})
+    #   @param  [String, IO, StringIO]    plaintext
+    #   @param  [Hash{Symbol => Object}]  options
+    #   @return [String]
+    #
+    # @param  [Object]                  plaintext
     # @param  [Hash{Symbol => Object}]  options
     # @option options [Symbol, #to_sym] :padding (nil)
-    # @return [Integer]
     def encrypt(plaintext, options = {})
-      PKCS1.rsaep(public_key, convert_to_integer(plaintext))
+      case plaintext
+        when Integer      then encrypt_integer(plaintext, options)
+        when String       then PKCS1.i2osp(encrypt_integer(PKCS1.os2ip(plaintext), options))
+        when StringIO, IO then PKCS1.i2osp(encrypt_integer(PKCS1.os2ip(plaintext.read), options))
+        else raise ArgumentError, plaintext.inspect # FIXME
+      end
     end
 
     ##
     # Decrypts the given `ciphertext` using the private key from this key
     # pair.
     #
-    # @param  [Integer, String, IO]     ciphertext
+    # @overload decrypt(ciphertext, options = {})
+    #   @param  [Integer]                 ciphertext
+    #   @param  [Hash{Symbol => Object}]  options
+    #   @return [Integer]
+    #
+    # @overload decrypt(ciphertext, options = {})
+    #   @param  [String, IO, StringIO]    ciphertext
+    #   @param  [Hash{Symbol => Object}]  options
+    #   @return [String]
+    #
+    # @param  [Object]                  ciphertext
     # @param  [Hash{Symbol => Object}]  options
     # @option options [Symbol, #to_sym] :padding (nil)
-    # @return [Integer]
     def decrypt(ciphertext, options = {})
-      PKCS1.rsadp(private_key, convert_to_integer(ciphertext))
+      case ciphertext
+        when Integer      then decrypt_integer(ciphertext, options)
+        when String       then PKCS1.i2osp(decrypt_integer(PKCS1.os2ip(ciphertext), options))
+        when StringIO, IO then PKCS1.i2osp(decrypt_integer(PKCS1.os2ip(ciphertext.read), options))
+        else raise ArgumentError, ciphertext.inspect # FIXME
+      end
     end
 
     ##
     # Signs the given `plaintext` using the private key from this key pair.
     #
-    # @param  [Integer, String, IO]     plaintext
+    # @overload sign(plaintext, options = {})
+    #   @param  [Integer]                 plaintext
+    #   @param  [Hash{Symbol => Object}]  options
+    #   @return [Integer]
+    #
+    # @overload sign(plaintext, options = {})
+    #   @param  [String, IO, StringIO]    plaintext
+    #   @param  [Hash{Symbol => Object}]  options
+    #   @return [String]
+    #
+    # @param  [Object]                  plaintext
     # @param  [Hash{Symbol => Object}]  options
     # @option options [Symbol, #to_sym] :padding (nil)
-    # @return [Integer]
     def sign(plaintext, options = {})
-      PKCS1.rsasp1(private_key, convert_to_integer(plaintext))
+      case plaintext
+        when Integer      then sign_integer(plaintext, options)
+        when String       then PKCS1.i2osp(sign_integer(PKCS1.os2ip(plaintext), options))
+        when StringIO, IO then PKCS1.i2osp(sign_integer(PKCS1.os2ip(plaintext.read), options))
+        else raise ArgumentError, plaintext.inspect # FIXME
+      end
     end
 
     ##
     # Verifies the given `signature` using the public key from this key
     # pair.
     #
-    # @param  [Integer, String, IO]     signature
-    # @param  [Integer, String, IO]     plaintext
+    # @overload verify(signature, plaintext, options = {})
+    #   @param  [Integer]                 signature
+    #   @param  [Integer]                 plaintext
+    #   @param  [Hash{Symbol => Object}]  options
+    #   @return [Boolean]
+    #
+    # @overload verify(signature, plaintext, options = {})
+    #   @param  [String, IO, StringIO]    signature
+    #   @param  [String, IO, StringIO]    plaintext
+    #   @param  [Hash{Symbol => Object}]  options
+    #   @return [Boolean]
+    #
+    # @param  [Object]                  signature
+    # @param  [Object]                  plaintext
     # @param  [Hash{Symbol => Object}]  options
     # @option options [Symbol, #to_sym] :padding (nil)
     # @return [Boolean]
     def verify(signature, plaintext, options = {})
-      PKCS1.rsavp1(public_key, convert_to_integer(signature)).eql?(convert_to_integer(plaintext))
+      signature = case signature
+        when Integer      then signature
+        when String       then PKCS1.os2ip(signature)
+        when StringIO, IO then PKCS1.os2ip(signature.read)
+        else raise ArgumentError, signature.inspect # FIXME
+      end
+      plaintext = case plaintext
+        when Integer      then plaintext
+        when String       then PKCS1.os2ip(plaintext)
+        when StringIO, IO then PKCS1.os2ip(plaintext.read)
+        else raise ArgumentError, plaintext.inspect # FIXME
+      end
+      verify_integer(signature, plaintext, options)
     end
 
   protected
 
     ##
-    # Converts the given `input` to an integer suitable for use with RSA
-    # primitives.
-    #
-    # @param  [Integer, String, IO] input
-    # @return [Integer]
-    def convert_to_integer(input)
-      case input
-        when Integer      then input
-        when String       then PKCS1.os2ip(input)
-        when IO, StringIO then PKCS1.os2ip(input.read)
-        else raise ArgumentError, input.inspect # FIXME
-      end
+    # @private
+    def encrypt_integer(plaintext, options = {})
+      PKCS1.rsaep(public_key, plaintext)
+    end
+
+    ##
+    # @private
+    def decrypt_integer(ciphertext, options = {})
+      PKCS1.rsadp(private_key, ciphertext)
+    end
+
+    ##
+    # @private
+    def sign_integer(plaintext, options = {})
+      PKCS1.rsasp1(private_key, plaintext)
+    end
+
+    ##
+    # @private
+    def verify_integer(signature, plaintext, options = {})
+      PKCS1.rsavp1(public_key, signature).eql?(plaintext)
     end
   end # class KeyPair
 end # module RSA

data/lib/rsa/math.rb

@@ -30,8 +30,8 @@ module RSA
     # This is equivalent to `base**exponent % modulus` but much faster for
     # large exponents.
     #
-    # This is presently a semi-naive implementation. Don't rely on it for
-    # very large exponents.
+    # The running time of the used algorithm, the right-to-left binary
+    # method, is O(log _exponent_).
     #
     # @example
     #   RSA::Math.modpow(5, 3, 13)                     #=> 8
@@ -43,9 +43,13 @@ module RSA
     # @return [Integer]
     # @see    http://en.wikipedia.org/wiki/Modular_exponentiation
     def self.modpow(base, exponent, modulus)
-      1.upto(exponent).inject(1) do |c, e|
-        (c * base) % modulus
+      result = 1
+      while exponent > 0
+        result   = (base * result) % modulus unless (exponent & 1).zero?
+        base     = (base * base)   % modulus
+        exponent >>= 1
       end
+      result
     end
 
     ##

data/lib/rsa/version.rb

@@ -2,7 +2,7 @@ module RSA
   module VERSION
     MAJOR = 0
     MINOR = 1
-    TINY  = 0
+    TINY  = 1
     EXTRA = nil
 
     STRING = [MAJOR, MINOR, TINY, EXTRA].compact.join('.')

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Arto Bendiken