s7n 0.1.0

data/lib/s7n/cipher.rb

@@ -0,0 +1,110 @@
+# -*- coding: utf-8 -*-
+
+require "openssl"
+
+module S7n
+  # 秘密鍵暗号化方式を用いた暗号化処理を表現する。
+  class Cipher
+    @@cipher_classes = {}
+
+    class << self
+      def create_instance(type, options)
+        return @@cipher_classes[type].new(options)
+      end
+
+      private
+      
+      def cipher_type(name)
+        if @@cipher_classes.nil?
+          @@cipher_classes = {}
+        end
+        @@cipher_classes[name] = self
+        self.const_set("CIPHER_TYPE", name)
+      end
+    end
+
+    attr_accessor :options
+
+    def initialize(options)
+      self.options = options
+    end
+
+    # io で指定した IO からデータを読み込み、復号する。
+    def decrypt(io)
+      begin
+        cipher = create_cipher
+        cipher.decrypt
+        parse_options(cipher, options)
+        s = ""
+        while d = io.read(cipher.block_size)
+          s << cipher.update(d)
+        end
+        s << cipher.final
+      rescue OpenSSL::Cipher::CipherError
+        raise InvalidPassphrase
+      end
+      return s
+    end
+
+    # io で指定した IO からデータを読み込み、暗号化する。
+    def encrypt(io)
+      cipher = create_cipher
+      cipher.encrypt
+      parse_options(cipher, options)
+      s = ""
+      while d = io.read(cipher.block_size)
+        s << cipher.update(d)
+      end
+      s << cipher.final
+      return s
+    end
+
+    private
+
+    def create_cipher
+      cipher_type = self.class.const_get("CIPHER_TYPE")
+      return OpenSSL::Cipher::Cipher.new(cipher_type)
+    end
+    
+    def parse_options(cipher, options)
+      if options.key?(:passphrase)
+        cipher.pkcs5_keyivgen(options[:passphrase])
+      elsif options.key?(:key)
+        cipher.key_len = options[:key].length
+        cipher.key = options[:key].key
+        if options.key?(:iv)
+          cipher.iv = options[:iv]
+        end
+      else
+        raise ArgumentError, "too few options: :passphrase or :key"
+      end
+      if options.key?(:padding)
+        cipher.padding = options[:padding]
+      end
+    end
+  end
+
+  # 秘密鍵方式の一つ AES を用いて暗号化処理を行うクラスを表現する。
+  class Aes256CbcCipher < Cipher
+    cipher_type "AES-256-CBC"
+  end
+
+  # 秘密鍵方式の一つ Blowfish を用いて暗号化処理を行うクラスを表現する。
+  class BfCbcCipher < Cipher
+    cipher_type "BF-CBC"
+  end
+
+  # Cipher クラスと同じインタフェースを持つが、暗号化しないクラスを表現
+  # する。
+  class PlainCipher < Cipher
+    cipher_type "plain"
+
+    def encrypt(io)
+      return io.read
+    end
+
+    def decrypt(io)
+      return io.read
+    end
+  end
+end

data/lib/s7n/configuration.rb

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+
+require "fileutils"
+
+module S7n
+  # 設定を表現する。
+  class Configuration
+    # デフォルトの秘密鍵暗号方式。
+    DEFAULT_CIPHER_TYPE = "AES-256-CBC"
+    
+    # World オブジェクト。
+    attr_accessor :world
+
+    # 秘密鍵暗号方式。
+    attr_accessor :cipher_type
+    
+    def initialize(world)
+      @world = world
+      @cipher_type = DEFAULT_CIPHER_TYPE
+    end
+
+    # 設定をファイルに書き出す。
+    def save(path)
+      hash = {
+        "cipher_type" => @cipher_type,
+      }
+      FileUtils.touch(path)
+      File.open(path, "wb") do |f|
+        f.write(hash.to_yaml)
+      end
+    end
+    
+    # 設定をファイルから読み込む。
+    def load(path)
+      File.open(path, "rb") do |f|
+        hash = YAML.load(f.read)
+        @cipher_type = hash["cipher_type"]
+      end
+    end
+  end
+end

data/lib/s7n/entry.rb

@@ -0,0 +1,106 @@
+# -*- coding: utf-8 -*-
+
+require "gettext"
+
+module S7n
+  # 機密情報を表現する。
+  class Entry
+    include GetText
+    
+    # タグ名の配列。
+    attr_reader :tags
+
+    # 属性の配列。
+    attr_reader :attributes
+
+    def initialize
+      @attributes = []
+      attr = NumericAttribute.new("name" => "id", "editabled" => false,
+                                  "protected" => true)
+      @attributes.push(attr)
+      attr = TextAttribute.new("name" => "name", "protected" => true)
+      @attributes.push(attr)
+      attr = NumericAttribute.new("name" => "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> expected=<%s> actual=<%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/s7n/entry_collection.rb

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+
+require "s7n/entry"
+
+module S7n
+  # 機密情報の集合を表現する。
+  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/s7n/entry_template.rb

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

data/lib/s7n/exception.rb

@@ -0,0 +1,116 @@
+# -*- coding: utf-8 -*-
+
+require "gettext"
+
+module S7n
+  # s7nで定義する例外クラスの親クラス。
+  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/s7n/file.rb

@@ -0,0 +1,77 @@
+require "s7n/exception"
+
+module S7n
+  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