RubyGems - simple-gnupg-keyserver - Versions diffs - 1.3.0 → 2.0.0 - Mend

simple-gnupg-keyserver 1.3.0 → 2.0.0

Files changed (11) hide show

data/.gitignore +5 -1
data/History.txt +0 -2
data/Manifest.txt +4 -1
data/README.rdoc +45 -40
data/Rakefile +1 -0
data/lib/simpleHKP/echo.rb +49 -8
data/lib/simpleHKP/identities.rb +240 -0
data/lib/simpleHKP/keys.rb +239 -0
data/lib/simpleHKP/server.rb +349 -0
data/lib/simpleHKP.rb +10 -489
metadata +13 -9

data/lib/simpleHKP.rb CHANGED Viewed

@@ -1,8 +1,3 @@
-require 'uri'
-require 'open3'
-require 'pp'
-require 'fileutils'
 # This code was inspired by:
 #   Sebi2020's Informatikonline Easy-HKP
 #     https://github.com/Sebi2020/easy-hkp
@@ -39,492 +34,18 @@ require 'fileutils'
 # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-class SimpleHKP
-  VERSION = "1.3.0"
-  def saveLastKey(lastKey)
-    lastKey['colonData'].gsub!(/\\x3a/,':') if
-      lastKey.has_key?('colonData')
-    pp lastKey if @debug
-    @keyLookupData[lastKey['keyID']] = lastKey unless
-      lastKey.empty? || lastKey['keyID'].empty?
-  end
-  def loadKeys
-    @keyLookupData = Hash.new
-    puts "SimpleHKP: loading keys" if @debug
-    gpg2cmd = "gpg2 --homedir #{@keyDir} --with-fingerprint --with-colons --list-sigs"
-    puts gpg2cmd if @debug
-    lastKey = Hash.new
-    IO.popen(gpg2cmd, 'r').readlines.each do | aLine |
-      next if aLine =~ /^tru/
-      if aLine =~ /^pub/ then
-        saveLastKey(lastKey)
-        lastKey = Hash.new
-        keyData = aLine.split(/:/)
-        lastKey['userID']    = keyData[9].gsub(/\\x3a/,':') # user ID
-        lastKey['keyID']     = keyData[4] #  key ID
-        lastKey['algorithm'] = keyData[3] #  key type (algorithm)
-        lastKey['len']       = keyData[2] #  key length
-        lastKey['created']   = keyData[5] #  creation date
-        lastKey['expires']   = keyData[6] #  expiration date
-        lastKey['flags']     = keyData[1] #  flags
-        lastKey['colonData'] = aLine
-        next
-      end
-      lastKey['userID'] = aLine.split(/:/)[9].gsub(/\\x3a/,':') if
-        aLine =~ /^uid/ && lastKey['userID'].empty?
-      lastKey['colonData'] << aLine
-    end
-    saveLastKey(lastKey)
-    @keyLookupData.each_pair do | key, value |
-      value['humanData'] = `gpg2 --list-sig #{key}`
-    end
-    pp @keyLookupData if @debug
-    puts "SimpleHKP: finished loading keys" if @debug
-  end
-  def loadHtml
-    puts "SimpleHKP: loading html partials" if @debug
-    Dir.chdir(@htmlDir) do
-      @headerHtml =  "<html><head>"
-      @headerHtml << "  <title>#{@title}</title>\n"
-      @headerHtml << "</head><body class=\"simpleHKP-body\">\n"
-      @headerHtml << "<p><a href=\"/\">#{@title}</a></p>"
-      @headerHtml = File.open('header.html','r').read if
-        File.exists?('header.html')
-      puts @headerHtml if @debug
-      @defaultBody = ""
-      @defaultBody << "<h1 class=\"simpleHKP-welcome\">Welcome to SimpleHKP</h1>\n"
-      @defaultBody << "<ul class=\"simpleHKP-tasksList\">\n"
-      @defaultBody << "  <li class=\"simpleHKP-taskItem\"><a href=\"lookup?op=form\">Search</a></li>\n"
-      @defaultBody << "  <li class=\"simpleHKP-taskItem\"><a href=\"add\">Upload new key</a></li>\n"
-      @defaultBody << "  <li class=\"simpleHKP-taskItem\"><a href=\"reload\">Reload existing keys</a></li>\n"
-      @defaultBody << "</ul>\n"
-      @defaultBody = File.open('defaultBody.html','r').read if
-        File.exists?('defaultBody.html')
-      puts @defaultBody if @debug
-      @lookupForm = ""
-      @lookupForm << "<div class=\"simpleHKP-lookupFormDiv\">\n"
-      @lookupForm << "  <h1 class=\"simpleHKP-lookupFormTitle\">Search GnuPG keys</h1>\n"
-      @lookupForm << "  <form action=\"lookup\" method=\"get\" id=\"simpleHKP-lookupForm\">\n"
-      @lookupForm << "    <input type=\"text\" name=\"search\" size=\"80\" />\n"
-      @lookupForm << "    <input type=\"hidden\" name=\"op\" value=\"index\" />\n"
-      @lookupForm << "    <input type=\"submit\" value=\"Search\" />\n"
-      @lookupForm << "  </form>\n"
-      @lookupForm << "</div>\n"
-      @lookupForm = File.open('lookupForm.html','r').read if
-        File.exists?('lookupForm.html')
-      puts @lookupForm if @debug
-      @uploadForm = ""
-      @uploadForm << "<div class=\"simpleHKP-uploadFormDiv\">\n"
-      @uploadForm << "  <h1 class=\"simpleHKP-uploadFormTitle\">Paste GnuPG key to be uploaded below</h1>\n"
-      @uploadForm << "  <form action=\"add\" method=\"post\" id=\"simpleHKP-uploadForm\">\n"
-      @uploadForm << "    <textarea name=\"keytext\" form=\"simpleHKP-uploadForm\" rows = \"30\" cols=\"70\" ></textarea>\n"
-      @uploadForm << "    <input type=\"submit\" value=\"Upload\" />\n"
-      @uploadForm << "  </form>\n"
-      @uploadForm << "</div>\n"
-      @uploadForm = File.open('uploadForm.html','r').read if
-        File.exists?('uploadForm.html')
-      puts @uploadForm if @debug
-      @footer = "</body></html>\n"
-      @footer = File.open('footer.html','r').read if
-        File.exists?('footer.html')
-      puts @footer if @debug
-    end
-    puts "SimpleHKP: finished loading html partials" if @debug
-  end
-  def initialize(options = {})
-    #
-    # setup the default options
-    #
-    defaultOptions = {
-      'debug'        => false,
-      'title'        => 'SimpleHKP',
-      'simpleHKPdir' => 'simpleHKP',
-      'keyDir'       => 'keys',
-      'mediaDir'     => 'media',
-      'htmlDir'      => 'html',
-      'mimeMap'      => {
-        'css'  => 'text/css',
-        'html' => 'text/html',
-        'js'   => 'text/javascript'
-      }
-    }
-    #
-    # merge the options mimeMap into the default options mimeMap
-    #
-    defaultOptions['mimeMap'].merge!(delete(options['mimeMap'])) if
-      options.has_key?('mimeMap')
-    #
-    # merge in the rest of the options into the default options
-    #
-    @options  = defaultOptions.merge(options)
-    #
-    # setup the required variables
-    #
-    @debug    = @options['debug']
-    @title    = @options['title']
-    @baseDir  = @options['simpleHKPdir']
-    @keyDir   = @baseDir+'/'+@options['keyDir']
-    @mediaDir = @baseDir+'/'+@options['mediaDir']
-    @htmlDir  = @baseDir+'/'+@options['htmlDir']
-    @mimeMap  = @options['mimeMap']
-    if @debug then
-      puts "SimpleHKP options:"
-      pp @options
-    end
-    #
-    # ensure the required directories all exist
-    #
-    FileUtils.mkdir_p(@keyDir)
-    FileUtils.chmod(0700, @keyDir)
-    FileUtils.mkdir_p(@mediaDir)
-    FileUtils.mkdir_p(@htmlDir)
-    #
-    # load the existing keys and the html partials
-    loadKeys
-    loadHtml
-  end
-  def ppEnv(env)
-    Dir.pwd+' '+
-#    '['+URI.decode_www_form(env["rack.input"].rewind.read).pretty_inspect+']'+
-    env.pretty_inspect
-  end
-  def replyInternalError(env, exception)
-    @statusCode = 500
-    @body << @headerHtml
-    @body << "<p>Internal server error!</p>\n"
-    @body << "<pre>#{exception}</pre>\n" if @debug
-    @body << @footer
-    if @debug then
-      puts "\n\n-------------------------------------------------------------"
-      puts exception
-      puts "-------------------------------------------------------------"
-      puts ppEnv(env)
-      puts "-------------------------------------------------------------\n\n"
-    end
-  end
-  def replyNotImplemented
-    @statusCode = 501
-    @body << @headerHtml
-    @body << '<p>Not implemented!<p>'
-    @body << @footer
-  end
-  def replyBadRequest(message)
-    @statusCode = 400
-    @body << @headerHtml
-    @body << '<p>Bad request!</p>'
-    @body << "<p>#{message}</p>"
-    @body << @footer
-  end
-  def replyNotFound
-    @statusCode = 404
-    @body << @headerHtml
-    @body << '<p>Not found!</p>'
-    @body << @footer
-  end
-  def replyDefaultBody
-    @body << @headerHtml
-    @body << @defaultBody
-    @body << @footer
-  end
-  def replyLookupForm
-    @body << @headerHtml
-    @body << @lookupForm
-    @body << @footer
-  end
-  def replyUploadForm
-    @body << @headerHtml
-    @body << @uploadForm
-    @body << @footer
-  end
-  def replyFile(env)
-    fileName = env['REQUEST_PATH'].sub(/^.*\/media\//,'')
-    if File.exists?(fileName) then
-      fileExt = File.extname(fileName).sub(/^\./,'')
-      @header['Content-Type'] = @mimeMap[fileExt] if
-        @mimeMap.has_key?(fileExt)
-      @body << File.open(fileName,'r').read
-    end
-  end
-  def storeKey(env)
-    #
-    # decode the post data
-    #
-    keys = URI.decode_www_form(env['rack.input'].read)
-    #
-    # ensure we are being sent a key
-    #
-    return replyBadRequest("No keytext field in post data") unless
-      keys[0][0] =~ /keytext/
-    pp keys[0][1] if @debug
-    #
-    # send the key data through gpg2 to import it
-    #
-    gpgStdErr  = ""
-    Open3.popen3("gpg2 --homedir #{@keyDir} --import") do | stdin, stdout, stderr, wait_thread |
-      stdin.write(keys[0][1])
-      stdin.close
-      gpgStdErr  = stderr.read
-    end
-    #
-    # check to see if the key has already been imported and/or changed
-    #
-    puts "[[#{gpgStdErr}]]" if @debug
-    keyChanged = "changed"
-    if gpgStdErr =~ /not\s+changed/ then
-      keyChanged = "unchanged"
-    else
-      # something has changed to re-load the keys
-      loadKeys
-    end
-    #
-    # send the key data through gpg2 (again ;-( to extract the keyID
-    #
-    gpgKeyData = ""
-    IO.popen('gpg2 --with-fingerprint --with-colons -', 'r+') do | pipe |
-      puts 'gpg2 --with-fingerprint --with-colons -' if @debug
-      pipe.write(keys[0][1])
-      pipe.close_write
-      gpgKeyData = pipe.read
-    end
-    puts gpgKeyData if @debug
-    #
-    # look for the keyID of the public key
-    #
-    keyID = nil
-    gpgKeyData.each_line do | aLine |
-      keyData = aLine.split(/:/)
-      next unless keyData[0] =~ /pub/
-      keyID = keyData[4]
-      break
-    end
-    return replyBadRequest("No keyID found in gpg2 result using uploaded keytext data") if keyID.nil?
-    #
-    # return OK
-    #
-    @statusCode = 200
-    @body << @headerHtml
-    @body << "<h1 class=\"simpleHKP-storedKey\">Stored key: [#{keyID}]</h1>"
-    @body << "<p>key #{keyChanged}</p>"
-    @body << "<h2 class=\"simpleHKP-keyDataKeyID\">Key data for key: [#{keyID}]</h2>"
-    @body << '<pre class="simpleHKP-keyData">'+@keyLookupData[keyID]['colonData']+"</pre>\n"
-    @body << '<pre class="simpleHKP-keyData">'+@keyLookupData[keyID]['humanData']+"</pre>\n"
-    @body << @footer
-  end
-  def lookUpKey(queryString)
-    return replyBadRequest("No search field in queryString") unless
-      queryString.has_key?('search')
-    #
-    # normalize the search string
-    #
-    searchString = queryString['search']
-    searchString.gsub!(/0x/,'')
-    searchRegexp = Regexp.new(searchString,
-                              Regexp::IGNORECASE | Regexp::MULTILINE)
-    puts searchRegexp if @debug
-    #
-    # (linearly) look through the hash of known keys
-    # looking for the FIRST match
-    #
-    keyID = nil
-    @keyLookupData.each_pair do | key, keyData |
-      next unless keyData['colonData'] =~ searchRegexp
-      puts "FOUND #{key} (#{keyData})" if @debug
-      keyID = key
-      break
-    end
-    return replyNotFound if keyID.nil?
-    if queryString.has_key?('options') &&
-      queryString['options'] == 'mr' then
-      #
-      # return the key data in machine readable format
-      #
-      @header = {
-        'Content-Type' => 'application/pgp-keys; charset=utf-8',
-        'Content-Disposition' =>
-          'attachment; filename=' + keyID
-      }
-      puts @header if @debug
-      @body << `gpg2 --homedir #{@keyDir} --armor --export #{keyID}`
-    else
-      #
-      # return the key data for a human to read
-      #
-      @body << @headerHtml
-      @body << @lookupForm
-      @body << '<h1 class="simpleHKP-keyAsckeyId">Key: '+keyID+'</h1>'
-      @body << '<h2 class="simpleHKP-keyDataTitle">Key data:</h2>'
-      @body << '<pre class="simpleHKP-keyData">'
-      @body << @keyLookupData[keyID]['humanData']
-      @body << '</pre>'
-      @body << '<h2 class="simpleHKP-keyAscTitle">Key contents:</h2>'
-      @body << '<pre class="simpleHKP-keyAsc">'
-      @body << `gpg2 --homedir #{@keyDir} --armor --export #{keyID}`
-      @body << '</pre>'
-      @body << @footer
-    end
-  end
-  def indexKeys(queryString)
-    return replyBadRequest("No search field in queryString") unless
-      queryString.has_key?('search')
-    #
-    # normalize the search string
-    #
-    searchString = queryString['search']
-    searchString.gsub!(/0x/,'')
-    searchRegexp = Regexp.new(searchString,
-                              Regexp::IGNORECASE | Regexp::MULTILINE)
-    puts searchRegexp if @debug
-    #
-    # accumulate the keyIDs of any keys that match the serach
-    #
-    keys = Array.new
-    @keyLookupData.each_pair do | key, keyData |
-      next unless keyData['colonData'] =~ searchRegexp
-      puts "FOUND #{key} (#{keyData})" if @debug
-      keys.push(key)
-    end
+require 'uri'
+require 'open3'
+require 'pp'
+require 'fileutils'
+require 'safe_yaml'
-    if queryString.has_key?('options') &&
-      queryString['options'] == 'mr' then
-      #
-      # return a machine readable list of the keys found
-      #
-      @header = { 'Content-Type' => 'text/plain' }
-      @body << "info:1:#{keys.size}\n"
-      keys.each do | aKey |
-        next unless @keyLookupData.has_key?(aKey)
-        keyData   = @keyLookupData[aKey]
-        pubData = [ "pub" ]
-        pubData << aKey
-        pubData << keyData['algorithm']
-        pubData << keyData['len']
-        pubData << keyData['created']
-        pubData << keyData['expires']
-        pubData << keyData['flags']
-        @body << pubData.join(':')
-        @body << "\n"
-        uidData = [ "uid" ]
-        uidData << keyData['userID'].gsub(/:/, '\x3a')
-        uidData << keyData['created']
-        uidData << keyData['expires']
-        uidData << keyData['flags']
-        @body << uidData.join(':')
-        @body << "\n"
-      end
-    else
-      #
-      # return a (simple) human readable list of the keys found
-      #
-      @body << @headerHtml
-      @body << @lookupForm
-      @body << '<h1 class="simpleHKP-searchString">Keys matching: ['+searchString+']</h1><ul class="simpleHKP-searchList">'
-      keys.each do | aKey |
-        next unless @keyLookupData.has_key?(aKey)
-        keyData   = @keyLookupData[aKey]
-        keyStr = "  <li class=\"simpleHKP-searchItem\"><a href=\"lookup?op=get&search=#{aKey}\">#{aKey}:&nbsp;"
-        keyStr << keyData['userID']
-        keyStr <<  "</a></li>\n"
-        @body << keyStr
-      end
-      @body << '</ul>'
-      @body << @footer
-    end
-    pp @body if @debug
-  end
+require 'simpleHKP/keys'
+require 'simpleHKP/identities'
+require 'simpleHKP/server'
-  def decodeQueryString(env)
-    queryHash = Hash.new
-    URI.decode_www_form(env['QUERY_STRING']).each do | aKeyValue |
-      queryHash[aKeyValue[0]] = aKeyValue[1]
-    end
-    queryHash
-  end
+module SimpleHKP
-  def call(env)
-    #
-    # initialize the response parts
-    #
-    @statusCode = 200
-    @header     = {"Content-Type" => "text/html; charset=utf-8"}
-    @body       = Array.new
-    #
-    # decode the request
-    #
-    begin
-      puts ppEnv(env) if @debug
-      case env['REQUEST_METHOD']
-      when 'POST'
-        case env['REQUEST_PATH']
-        when /add$/i
-          storeKey(env)
-        else
-          replyNotImplemented
-        end
-      when 'GET'
-        case env['REQUEST_PATH']
-        when /add$/i
-          replyUploadForm
-        when /lookup$/i
-          queryString = decodeQueryString(env)
-          if queryString.has_key?('op') then
-            case queryString['op']
-            when /get/i
-              lookUpKey(queryString)
-            when /index/i
-              indexKeys(queryString)
-            else
-              replyLookupForm
-            end
-          else
-            replyBadRequest("No op field in queryString")
-          end
-        when /media\//i
-          replyFile(env)
-        when /reload$/i
-          loadKeys
-          loadHtml
-          replyDefaultBody
-        else
-          replyDefaultBody
-        end
-      else
-        replyBadRequest("Unknown request method")
-      end
-    rescue Exception => exception
-      replyInternalError(env, exception)
-    end
-    #
-    # send the response
-    #
-    if @debug then
-      puts "SimpleHKP reply:"
-      pp @statusCode
-      pp @header
-      puts @body.join("\n")
-    end
-    [ @statusCode, @header, @body.flatten ]
-  end
+  VERSION = "2.0.0"
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-gnupg-keyserver
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
   prerelease:
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-03-12 00:00:00.000000000 Z
+date: 2015-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -43,12 +43,12 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.13'
-description: ! "SimpleHKP is a simple Ruby/rack based GnuPG HKP key server.\n\nIts
-  sole task is to supply a limited number of GnuPG _public_ keys \nto/from MonkeySphere
-  on a limited number of machines/servers. It is \n_not_ meant to server hundreds
-  of keys, so it is not meant as a truely \npublic key server.\n\nIf you need to run
-  your own _large_ scale production Key Sever then use \n{SKS}[https://bitbucket.org/skskeyserver/sks-keyserver/wiki/Home].
-  You \nmight want to read Paul Bauer's {How To Setup A Free PGP Key Server in \nUbuntu}[http://www.bauer-power.net/2010/05/how-to-setup-free-pgp-key-server-in.html]."
+description: ! "SimpleHKP is a simple Ruby/rack based GnuPG extendedHKP key and \nidentity
+  server packaged as a standard Ruby Gem. \n\nAs such it conforms to an {extended
+  \nversion}[http://stephengaito.github.io/rGem-simple-gnupg-keyserver/] of \n{the
+  OpenPGP HTTP Keyserver Protocol (HKP) \n(draft-shaw-openpgp-hkp-00.txt)}[http://tools.ietf.org/html/draft-shaw-openpgp-hkp-00].\n\nThe
+  {associated \ndocumentation}[https://stephengaito.github.io/rGem-simple-gnupg-keyserver]
+  \nprovides more detail."
 email:
 - stephen@perceptisys.co.uk
 executables: []
@@ -65,6 +65,9 @@ files:
 - Rakefile
 - lib/simpleHKP.rb
 - lib/simpleHKP/echo.rb
+- lib/simpleHKP/identities.rb
+- lib/simpleHKP/keys.rb
+- lib/simpleHKP/server.rb
 homepage: https://github.com/stephengaito/rGem-simple-gnupg-keyserver
 licenses:
 - MIT
@@ -91,5 +94,6 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key:
 specification_version: 3
-summary: SimpleHKP is a simple Ruby/rack based GnuPG HKP key server
+summary: SimpleHKP is a simple Ruby/rack based GnuPG extendedHKP key and  identity
+  server packaged as a standard Ruby Gem
 test_files: []