bendiken-openpgp 0.0.1.1 → 0.0.1.2

data/README

@@ -2,6 +2,9 @@
 
 This is a pure-Ruby implementation of the OpenPGP Message Format (RFC 4880).
 
+* http://openpgp.rubyforge.org
+* http://github.com/bendiken/openpgp
+
 
 === About OpenPGP
 
@@ -81,6 +84,15 @@ directly from GitHub as follows:
   % [sudo] gem install bendiken-openpgp -s http://gems.github.com
 
 
+== Resources
+
+* http://openpgp.rubyforge.org
+* http://github.com/bendiken/openpgp
+* http://rubyforge.org/projects/openpgp
+* http://raa.ruby-lang.org/project/openpgp
+* http://www.ohloh.net/p/openpgp
+
+
 == Authors
 
 * Arto Bendiken (mailto:arto.bendiken@gmail.com) - http://ar.to

data/Rakefile

@@ -3,3 +3,17 @@ $:.unshift(File.expand_path(File.join(File.dirname(__FILE__), 'lib')))
 require 'rubygems'
 require 'rakefile' # http://github.com/bendiken/rakefile
 require 'openpgp'
+
+desc "Generate YARD documentation (with title)"
+task :yardocs => :yardoc do
+  # FIXME: fork YARD and patch it to allow the title to be configured
+  sh "sed -i 's/YARD Documentation/OpenPGP.rb Documentation/' doc/yard/index.html"
+
+  # TODO: investigate why YARD doesn't auto-link URLs like RDoc does
+  html = File.read(file = 'doc/yard/readme.html')
+  html.gsub!(/>(http:\/\/)([\w\d\.\/\-]+)/, '><a href="\1\2" target="_blank">\2</a>')
+  html.gsub!(/(http:\/\/ar\.to\/[\w\d\.\/]+)/, '<a href="\1">\1</a>')
+  html.gsub!(/(http:\/\/ar\.to)([^\/]+)/, '<a href="\1" target="_top">ar.to</a>\2')
+  html.gsub!(/(mailto:[^\)]+)/, '<a href="\1">\1</a>')
+  File.open(file, 'wb') { |f| f.puts html }
+end

data/VERSION

@@ -1 +1 @@
-0.0.1.1
+0.0.1.2

data/lib/openpgp.rb

@@ -1,6 +1,10 @@
 require 'openpgp/version'
-require 'openpgp/armor'
-require 'openpgp/message'
-require 'openpgp/packet'
-require 'openpgp/algorithm'
-require 'openpgp/gnupg'
+require 'openpgp/util'
+
+module OpenPGP
+  autoload :Armor,     'openpgp/armor'
+  autoload :Message,   'openpgp/message'
+  autoload :Packet,    'openpgp/packet'
+  autoload :Algorithm, 'openpgp/algorithm'
+  autoload :GnuPG,     'openpgp/gnupg'
+end

data/lib/openpgp/armor.rb

@@ -1,16 +1,4 @@
 module OpenPGP
-  ##
-  # Alias for OpenPGP::Armor.encode().
-  def self.enarmor(data, marker = 'MESSAGE', headers = {})
-    Armor.encode(data, marker, headers)
-  end
-
-  ##
-  # Alias for OpenPGP::Armor.decode().
-  def self.dearmor(text, marker = nil)
-    Armor.decode(text, marker)
-  end
-
   ##
   # OpenPGP ASCII Armor utilities.
   #
@@ -42,14 +30,11 @@ module OpenPGP
     # @see http://tools.ietf.org/html/rfc4880#section-6.2
     # @see http://tools.ietf.org/html/rfc2045
     def self.encode(data, marker = 'MESSAGE', headers = {})
-      require 'stringio'
-      require 'base64'
-
       text = StringIO.new
       text << self.header(marker)     << "\n"
       headers.each { |key, value| text << "#{key}: #{value}\n" }
       text << "\n" << Base64.encode64(data)
-      text << "="  << Base64.encode64([self.crc24(data)].pack('N')[1, 3])
+      text << "="  << Base64.encode64([OpenPGP.crc24(data)].pack('N')[1, 3])
       text << self.footer(marker)     << "\n"
       text.string
     end
@@ -58,9 +43,6 @@ module OpenPGP
     # @see http://tools.ietf.org/html/rfc4880#section-6
     # @see http://tools.ietf.org/html/rfc2045
     def self.decode(text, marker = nil)
-      require 'stringio'
-      require 'base64'
-
       data, crc, state = StringIO.new, nil, :begin
       text.each_line do |line|
         line.chomp!
@@ -88,26 +70,6 @@ module OpenPGP
       end
       data.string
     end
-
-    ##
-    # @see http://tools.ietf.org/html/rfc4880#section-6.1
-    CRC24_INIT = 0x00b704ce
-    CRC24_POLY = 0x01864cfb
-
-    ##
-    # @see http://tools.ietf.org/html/rfc4880#section-6
-    # @see http://tools.ietf.org/html/rfc4880#section-6.1
-    def self.crc24(data)
-      crc = CRC24_INIT
-      data.each_byte do |octet|
-        crc ^= octet << 16
-        8.times do
-          crc <<= 1
-          crc ^= CRC24_POLY if (crc & 0x01000000).nonzero?
-        end
-      end
-      crc &= 0x00ffffff
-    end
   end
 
   include Armor::Markers

data/lib/openpgp/message.rb

@@ -14,7 +14,6 @@ module OpenPGP
     # @see http://tools.ietf.org/html/rfc4880#section-4.1
     # @see http://tools.ietf.org/html/rfc4880#section-4.2
     def self.parse(data)
-      require 'stringio'
       data = StringIO.new(data.to_str) if data.respond_to?(:to_str)
 
       msg = self.new

data/lib/openpgp/packet.rb

@@ -14,7 +14,6 @@ module OpenPGP
     #
     # @see http://tools.ietf.org/html/rfc4880#section-4.2
     def self.parse(data)
-      require 'stringio'
       data = StringIO.new(data.to_str) if data.respond_to?(:to_str)
 
       unless data.eof?
@@ -78,6 +77,32 @@ module OpenPGP
       @tag, @data, @size = tag, data, data ? data.size : 0
     end
 
+    ##
+    # @see http://tools.ietf.org/html/rfc4880#section-3.5
+    def read_timestamp
+      read_unpacked(4, 'N')
+    end
+
+    ##
+    # @see http://tools.ietf.org/html/rfc4880#section-3.2
+    def read_mpi
+      length = read_unpacked(2, 'n')      # length in bits
+      length = ((length + 7) / 8.0).floor # length in bytes
+      read_bytes(length)
+    end
+
+    def read_unpacked(count, format)
+      read_bytes(count).unpack(format).first
+    end
+
+    def read_byte
+      data.getc
+    end
+
+    def read_bytes(count)
+      data.read(count)
+    end
+
     ##
     # OpenPGP Public-Key Encrypted Session Key packet (tag 1).
     #
@@ -118,7 +143,62 @@ module OpenPGP
     # @see http://tools.ietf.org/html/rfc4880#section-11.1
     # @see http://tools.ietf.org/html/rfc4880#section-12
     class PublicKey < Packet
-      # TODO
+      attr_accessor :version, :timestamp, :algorithm
+      attr_accessor :key, :key_fields
+
+      def initialize(tag = nil, data = nil)
+        super
+        @data = StringIO.new(@data.to_str)
+        @key  = {}
+
+        case @version = @data.getc
+          when 2, 3
+            # TODO
+          when 4
+            @timestamp, @algorithm = read_timestamp, read_byte
+            read_key_material
+        end
+      end
+
+      ##
+      # @see http://tools.ietf.org/html/rfc4880#section-5.5.2
+      def read_key_material
+        @key_fields = case algorithm
+          when Algorithm::Asymmetric::RSA
+            [:n, :e]
+          when Algorithm::Asymmetric::ELG_E
+            [:p, :g, :y]
+          when Algorithm::Asymmetric::DSA
+            [:p, :q, :g, :y]
+          else
+            raise "Unknown OpenPGP key algorithm: #{algorithm}"
+        end
+        @key_fields.each { |field| key[field] = read_mpi }
+        key_id
+      end
+
+      def key_id
+        @key_id ||= fingerprint[-8..-1]
+      end
+
+      ##
+      # @see http://tools.ietf.org/html/rfc4880#section-12.2
+      # @see http://tools.ietf.org/html/rfc4880#section-3.3
+      def fingerprint
+        @fingerprint ||= case version
+          when 2, 3
+            require 'digest/md5'
+            Digest::MD5.hexdigest([key[:n], key[:e]].join)
+          when 4
+            require 'digest/sha1'
+            material = [0x99.chr, [size].pack('n'), version.chr, [timestamp].pack('N'), algorithm.chr]
+            @key_fields.each do |key_field|
+              material << [OpenPGP.bitlength(key[key_field])].pack('n')
+              material << key[key_field]
+            end
+            Digest::SHA1.hexdigest(material.join)
+        end
+      end
     end
 
     ##

data/lib/openpgp/util.rb

@@ -0,0 +1,44 @@
+require 'stringio'
+require 'base64'
+
+module OpenPGP
+  ##
+  # Alias for OpenPGP::Armor.encode().
+  def self.enarmor(data, marker = 'MESSAGE', headers = {})
+    Armor.encode(data, marker, headers)
+  end
+
+  ##
+  # Alias for OpenPGP::Armor.decode().
+  def self.dearmor(text, marker = nil)
+    Armor.decode(text, marker)
+  end
+
+  ##
+  # @see http://tools.ietf.org/html/rfc4880#section-6.1
+  CRC24_INIT = 0x00b704ce
+  CRC24_POLY = 0x01864cfb
+
+  ##
+  # @see http://tools.ietf.org/html/rfc4880#section-6
+  # @see http://tools.ietf.org/html/rfc4880#section-6.1
+  def self.crc24(data)
+    crc = CRC24_INIT
+    data.each_byte do |octet|
+      crc ^= octet << 16
+      8.times do
+        crc <<= 1
+        crc ^= CRC24_POLY if (crc & 0x01000000).nonzero?
+      end
+    end
+    crc &= 0x00ffffff
+  end
+
+  ##
+  # Returns the bit length of a multiprecision integer (MPI).
+  #
+  # @see http://tools.ietf.org/html/rfc4880#section-3.2
+  def self.bitlength(data)
+    (data.size - 1) * 8 + (Math.log(data[0]) / Math.log(2)).floor + 1
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bendiken-openpgp
 version: !ruby/object:Gem::Version 
-  version: 0.0.1.1
+  version: 0.0.1.2
 platform: ruby
 authors: 
 - Arto Bendiken
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-18 00:00:00 -07:00
+date: 2009-04-30 00:00:00 -07:00
 default_executable: openpgp
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,6 +42,7 @@ files:
 - lib/openpgp/gnupg.rb
 - lib/openpgp/message.rb
 - lib/openpgp/packet.rb
+- lib/openpgp/util.rb
 - lib/openpgp/version.rb
 has_rdoc: false
 homepage: http://github.com/bendiken/openpgp