s7 0.0.1

data/lib/s7/entry.rb

@@ -0,0 +1,106 @@
+# -*- coding: utf-8 -*-
+
+require "gettext"
+
+module S7
+  # 機密情報を表現する。
+  class Entry
+    include GetText
+    
+    # タグ名の配列。
+    attr_reader :tags
+
+    # 属性の配列。
+    attr_reader :attributes
+
+    def initialize
+      @attributes = []
+      attr = NumericAttribute.new("name" => N_("id"), "editabled" => false,
+                                  "protected" => true)
+      @attributes.push(attr)
+      attr = TextAttribute.new("name" => N_("name"), "protected" => true)
+      @attributes.push(attr)
+      attr = NumericAttribute.new("name" => N_("rate"), "protected" => true,
+                                  "value" => 1)
+      @attributes.push(attr)
+      
+      @tags = []
+    end
+
+    # ID を取得する。
+    def id
+      return get_attribute("id").value
+    end
+
+    # ID を設定する。
+    def id=(val)
+      get_attribute("id").value = val
+    end
+
+    # name で指定した名前の属性を取得する。
+    # 存在しない場合、nil を返す。
+    def get_attribute(name)
+      return @attributes.find { |attr| attr.name == name }
+    end
+    
+    # attributes で指定した属性を追加する。
+    # 名前が同じ属性が存在する場合、値を書き換える。
+    # 名前が同じ属性が存在し、なおかつ型が異なる場合、ApplicationError
+    # 例外を発生させる。
+    def add_attributes(*attributes)
+      [attributes].flatten.each do |attribute|
+        attr = @attributes.find { |a|
+          a.name == attribute.name
+        }
+        if attr
+          if attr.class == attribute.class
+            attr.value = attribute.value
+          else
+            raise ApplicationError, _("not same attribute type: name=<%s> exist=<%s> argument=<%s>") % [attr.name, attr.class, attribute.class]
+          end
+        else
+          @attributes.push(attribute)
+        end
+      end
+    end
+
+    # 全ての属性の複製を取得する。
+    def duplicate_attributes(exclude_uneditable = true)
+      if exclude_uneditable
+        attrs = @attributes
+      else
+        attrs = @attributes.select { |attr|
+          attr.editable?
+        }
+      end
+      return attrs.collect { |attr|
+        a = attr.dup
+        begin
+          a.value = attr.value.dup
+        rescue TypeError
+        end
+        a
+      }
+    end
+
+    def method_missing(symbol, *args)
+      attr_name = symbol.to_s
+      if attr_name[-1] == "="
+        attr_name = attr_name[0..-2]
+        setter = true
+      end
+      attr = @attributes.find { |a|
+        a.name == attr_name
+      }
+      if attr
+        if setter
+          attr.value = args.first
+        else
+          return attr.value
+        end
+      else
+        super
+      end
+    end
+  end
+end

data/lib/s7/entry_collection.rb

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+
+require "s7/entry"
+
+module S7
+  # 機密情報の集合を表現する。
+  class EntryCollection
+    # 機密情報の配列。
+    attr_reader :entries
+
+    def initialize
+      @entries = []
+      @max_id = 0
+    end
+
+    # 機密情報を追加する。
+    def add_entries(*entries)
+      [entries].flatten.each do |entry|
+        @max_id += 1
+        entry.id = @max_id
+        @entries.push(entry)
+      end
+    end
+
+    # 機密情報を削除し、削除した機密情報を返す。
+    def delete_entries(*entries)
+      entries = [entries].flatten
+      return @entries.delete_if { |entry|
+        entries.include?(entry)
+      }
+    end
+
+    # other で指定した EntryCollection オブジェクトの entries をマージ
+    # する。
+    def merge(other)
+      add_entries(other.entries)
+    end
+
+    # 指定した id にマッチする Entry オブジェクトを entries から探す。
+    def find(id)
+      return @entries.find { |entry| entry.id == id }
+    end
+  end
+end

data/lib/s7/entry_template.rb

@@ -0,0 +1,10 @@
+module S7
+  # 機密情報の新規作成時に利用するテンプレートを表現する。
+  class EntryTemplate
+    # 名前。
+    attr_accessor :name
+
+    # 属性の配列。
+    attr_accessor :attributes
+  end
+end

data/lib/s7/exception.rb

@@ -0,0 +1,116 @@
+# -*- coding: utf-8 -*-
+
+require "gettext"
+
+module S7
+  # s7で定義する例外クラスの親クラス。
+  class ApplicationError < StandardError
+    include GetText
+  end
+
+  # 不正なパスフレーズを表現する例外クラス。
+  class InvalidPassphrase < ApplicationError
+    def to_s
+      return _("Invlaid passphrase.")
+    end
+  end
+
+  # 不正なパスを表現する例外クラス。
+  class InvalidPath < ApplicationError
+    def initialize(path)
+      @path = path
+    end
+    
+    def to_s
+      return _("Invalid path: path=<%s>") % @path
+    end
+  end
+
+  # ファイルやディレクトリが存在しないことを表現する例外クラス。
+  class NotExist < ApplicationError
+    def initialize(path)
+      @path = path
+    end
+    
+    def to_s
+      return _("Does not exit: path=<%s>") % @path
+    end
+  end
+
+  # 機密情報が存在しないことを表現する例外クラス。
+  class NoSuchEntry < ApplicationError
+    def initialize(options = {})
+      @options = options
+    end
+    
+    def to_s
+      if !@options.empty?
+        s = ""
+        @options.each do |key, value|
+          s << " #{key}=<#{value}>"
+        end
+      end
+      if s.empty?
+        return _("No such entry.")
+      else
+        return _("No such entry:%s") % s
+      end
+    end
+  end
+
+  # 機密情報の属性が存在しないことを表現する例外クラス。
+  class NoSuchAttribute < ApplicationError
+    def initialize(options = {})
+      @options = options
+    end
+    
+    def to_s
+      if !@options.empty?
+        s = ""
+        @options.each do |key, value|
+          s << " #{key}=<#{value}>"
+        end
+      end
+      if s.empty?
+        return _("No such attribute.")
+      else
+        return _("No such attribute:%s") % s
+      end
+    end
+  end
+
+  # データ長が不正であることを表現する例外クラス。
+  class DataLengthError < ApplicationError
+    def initialize(actual, needed)
+      @actual = actual
+      @needed = needed
+    end
+
+    def to_s
+      return _("Invalid data length: actual=<%s> needed=<%s>") % [@actual, @needed]
+    end
+  end
+
+  # キャンセルを表現する例外クラス。
+  class Canceled < ApplicationError
+    MESSAGE = _("Canceled.")
+    
+    def to_s
+      return MESSAGE
+    end
+  end
+
+  # OS のコマンドの実行に失敗したことを表現する例外クラス。
+  class CommandFailed < ApplicationError
+    # command:: 失敗したコマンド
+    # status:: コマンドの終了ステータス
+    def initialize(command, status)
+      @command = command
+      @status = status
+    end
+
+    def to_s
+      return _("Failed the command: command=<%s> status=<%d>") % [@command, @status]
+    end
+  end
+end

data/lib/s7/file.rb

@@ -0,0 +1,77 @@
+require "s7/exception"
+
+module S7
+  class File
+    # パスワードコレクションのファイルのバージョン。
+    VERSION = "1.1.0"
+      
+    # パスワードコレクションの先頭記述するマジック文字列。
+    MAGIC = "GPassFile version #{VERSION}"
+
+    # Cipherで使用するIV(Initial Vector)
+    IV = [5, 23, 1, 123, 12, 3, 54, 94].pack("C8")
+
+    # パスワードコレクションを格納するファイルを作成する。
+    # +path+:: 作成するファイルのパスを文字列で指定する。
+    # +passphrase+:: ファイルを暗号化するマスターパスフレーズを
+    #                文字列で指定する。
+    #
+    # すでにファイルが存在した場合、例外を発生させる。
+    def self.create(path, passphrase)
+      path = ::File.expand_path(path)
+      if ::File.exist?(path)
+        raise S7::Exception, "already exist file or directory: #{path}"
+      end
+      ::File.open(path, "w") do |f|
+        key = S7::Key.create_instance("SHA-1", passphrase)
+        cipher =
+          S7::Cipher.create_instance("BF-CBC", :key => key, :iv => S7::File::IV)
+        magic = cipher.encrypt(StringIO.new(S7::File::MAGIC))
+        f.write(magic)
+      end
+    end
+
+    def self.open(path, passphrase)
+      path = ::File.expand_path(path)
+      if !::File.exist?(path)
+        raise S7::Exception, "no such file or directory: #{path}"
+      end
+      if !block_given?
+        raise ArgumentError, "no block given"
+      end
+      begin
+        f = self.new(path, passphrase)
+        yield(f)
+      ensure
+        f.close
+      end
+    end
+
+    # パスワードコレクションのパス。
+    attr_accessor :path
+
+    # パスフレーズから生成したCipher用のキー。
+    attr_accessor :key
+
+    # キーとIVから生成したCipher。
+    attr_accessor :cipher
+
+    # 操作対象のファイル。
+    attr_accessor :file
+
+    def initialize(path, passphrase)
+      self.path = ::File.expand_path(path)
+      self.key = S7::Key.create_instance("SHA-1", passphrase)
+      self.cipher = S7::Cipher.create_instance("BF-CBC", :key => key,
+                                               :iv => S7::File::IV)
+      self.file = nil
+    end
+
+    # ファイルを閉じる。
+    def close
+      if self.file
+        self.file.close
+      end
+    end
+  end
+end

data/lib/s7/gpass_file.rb

@@ -0,0 +1,202 @@
+# -*- coding: utf-8 -*-
+
+require "s7/key"
+require "s7/cipher"
+require "s7/entry_collection"
+require "s7/attribute"
+require "gettext"
+
+module S7
+  # GPass のファイルに関する処理を表現する。
+  class GPassFile
+    include GetText
+    
+    # GPass のファイルが格納されているデフォルトのパス。
+    DEFAULT_PATH = "~/.gpass/passwords.gps"
+
+    # Blowfish の初期化配列。
+    IV = [5, 23, 1, 123, 12, 3, 54, 94].pack("C8")
+
+    # GPass のファイルであることを示すマジック。
+    MAGIC_PATTERN = /\AGPassFile version (\d\.\d\.\d)/
+    
+    # GPass で扱う秘密情報の種類と属性。
+    ENTRY_ATTRIBUTE_TEMPLATES = { 
+      "entry" => [TextAttribute.new("name" => N_("name")),
+                  TextAttribute.new("name" => N_("description")),
+                  DateTimeAttribute.new("name" => N_("created_at")),
+                  DateTimeAttribute.new("name" => N_("updated_at")),
+                  BooleanAttribute.new("name" => N_("expiration")),
+                  DateTimeAttribute.new("name" => N_("expire_at"))],
+      "folder" => ["entry"],
+      "password" => ["entry",
+                     TextAttribute.new("name" => N_("username")),
+                     TextAttribute.new("name" => N_("password"),
+                                       "secret" => true)],
+      "general" => ["password",
+                    TextAttribute.new("name" => N_("hostname"))],
+      "shell" => ["general"],
+      "website" => ["password",
+                    TextAttribute.new("name" => N_("url"))],
+    }
+    
+    ENTRY_ATTRIBUTE_TEMPLATES.each do |name, template|
+      loop do
+        replaced = false
+        template.each_with_index do |attr, i|
+          if attr.is_a?(String)
+            template[i] = ENTRY_ATTRIBUTE_TEMPLATES[attr]
+            replaced = true
+          end
+        end
+        if replaced
+          template.flatten!
+        else
+          break
+        end
+      end
+    end
+    
+    def read(passphrase, path = DEFAULT_PATH)
+      res = EntryCollection.new
+      File.open(File.expand_path(path), "r") do |f|
+        f.flock(File::LOCK_EX)
+        s = decrypt(f, passphrase)
+        parse(s, res)
+      end
+      return res
+    end
+
+    private
+
+    def decrypt(io, passphrase)
+      key = Key.create_instance("SHA-1", passphrase)
+      cipher = Cipher.create_instance("BF-CBC", :key => key, :iv => IV)
+      return cipher.decrypt(io)
+    end
+
+    def parse(s, entry_collection)
+      if s.slice!(MAGIC_PATTERN).nil?
+        raise InvalidPassphrase
+      end
+      version = $1
+      # TODO: 1.1.0 より前のバージョンもサポートする。
+      if version != "1.1.0"
+        raise GPassFileError, _("not supported version: %s") % version
+      end
+      id_entry = {}
+      while !s.empty?
+        res = parse_gpass_entry(s)
+        id = res["id"]
+        entry = res["entry"]
+        if id_entry.key?(id)
+          raise GPassFileError, _("duplicated entry id: %s") % id
+        end
+        id_entry[id] = entry
+        parent = id_entry[res["parent_id"]]
+        if parent
+          entry.tags.push(*parent.tags)
+        end
+        if res["type"] == "folder"
+          entry.tags.push(entry.name)
+        else
+          entry_collection.add_entries(entry)
+        end
+      end
+    end
+
+    def parse_gpass_entry(s)
+      id = unpack_number(s)
+      parent_id = unpack_number(s)
+      type = unpack_string(s, unpack_number(s))
+      bytes = unpack_number(s)
+      if s.length < bytes
+        raise DataLengthError.new(s.length, bytes)
+      end
+      entry = Entry.new
+      unpack_attributes(entry, type, s.slice!(0, bytes))
+      return {
+        "id" => id,
+        "parent_id" => parent_id,
+        "type" => type,
+        "entry" => entry,
+      }
+    end
+
+    def unpack_attributes(entry, type, s)
+      template = ENTRY_ATTRIBUTE_TEMPLATES[type]
+      if !template
+        raise GPassFileError, _("invalid entry type: type=<%s>") % type
+      end
+      template.each do |a|
+        attr = a.dup
+        case attr
+        when NumericAttribute
+          attr.value = unpack_variable_number(s)
+        when BooleanAttribute
+          attr.value = unpack_boolean(s)
+        when DateTimeAttribute
+          attr.value = unpack_time(s)
+        when TextAttribute
+          attr.value = unpack_string(s, unpack_variable_number(s))
+        end
+        entry.add_attributes(attr)
+      end
+    end
+    
+    # s で指定したバイト列から 4 バイト取り出し、リトルエンディアンの数
+    # 値として unpack した結果を返す。
+    def unpack_number(s)
+      if s.length < 4
+        raise DataLengthError.new(s.length, 4)
+      end
+      return s.slice!(0, 4).unpack("V").first
+    end
+
+    # s で指定したバイト列から 8 ビット目が 0 のバイトを見つけるまで 1
+    # バイトずつ取り出し、4 バイトのリトルエンディアンの数値として
+    # unpack した結果を返す。
+    def unpack_variable_number(s)
+      n = 0
+      base = 1
+      i = 0
+      while (t = s.slice!(0)) && i <= 5
+        t = t.ord
+        if t & 0x80 == 0
+          n += base * t
+          break
+        else
+          n += base * (t & 0x7f)
+          base *= 0x80
+        end
+        i += 1
+      end
+      return [n].pack("V").unpack("I").first
+    end
+
+    # s で指定したバイト列から n で指定した長さを取り出し、それを文字列
+    # として返す。
+    def unpack_string(s, n)
+      if s.length < n
+        raise DataLengthError.new(s.length, n)
+      end
+      return s.slice!(0, n).force_encoding("utf-8")
+    end
+
+    # s で指定したバイト列から unpack_variable_number を使用して数値を
+    # 取り出す。それを time_t の値として扱い、DateTimeオブジェクトを返す。
+    def unpack_time(s)
+      return Time.at(unpack_variable_number(s)).to_datetime
+    end
+
+    # s で指定したバイト列から unpack_variable_number を使用して数値を
+    # 取り出す。それが 0 であれば false を、そうでなければ true を返す。
+    def unpack_boolean(s)
+      return unpack_variable_number(s) != 0
+    end
+
+    # GPass のファイルの処理中に発生したエラーを表現する例外クラス。
+    class GPassFileError < ApplicationError
+    end
+  end
+end