ruby-mysql 2.10.0 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '03296aa0e624e599242e8efc5d3011b4337e161c3b7bf1c9cc81e98fa99f5052'
-  data.tar.gz: c7391d48dab125e86b97b8130556e69ceadf503e11884744b7fdf19af3b58cf1
+  metadata.gz: 40bdb4e1eba4eca2ed1e93524260bd9407f91ee5f65b8c32b8c38524ef05ebdd
+  data.tar.gz: 224ad0bdf2050dca6e5d7a603bd64cb44a5f414270aa06b9dd89690cd2665a32
 SHA512:
-  metadata.gz: ba1a7bad362dc1523de97aa487ee8c571649854a2bb8a9342ecd525dbda0441c9562639556dcd933f7e7c643373907144329e97c2600af30a5ae6b1cc5fb5606
-  data.tar.gz: bdea4b3d97980fea097d59525b327c275374d006ddb699efda0c359608d8588a8beba742f713f0b2721433ea5efbf9eac5db8d7f4e6d7ddbe9eeb050220e6a3d
+  metadata.gz: a73e1ab248a44935cd4115c0d2de16f491d51b2eb7ab7a9b33185a0f478be8753cc226ea78d645a2bb1ae0b09cb15a7432f9e8d5a1dfa82af3ef016783689544
+  data.tar.gz: 37db0a8b13b5a543cf9d552801aa0419c4ccce9fbe287d8df0335002df728e5e5ab5a9d82c873c174dec547b1077730cd265a4a6ace1714c88cb984b3d5f4134

data/README.rdoc

@@ -20,8 +20,6 @@ MySQL connector for Ruby.
 
 * MySQL/Ruby 2.8.x とほぼ互換があります。
 
-* MySQL 8.0 には対応していません。
-
 == Synopsis
 
 使用例:
@@ -35,17 +33,17 @@ MySQL connector for Ruby.
 
 == Incompatible with MySQL/Ruby 2.8.x
 
-* Ruby 1.8.x ではシフトJISのような安全でないマルチバイト文字セットに対して Mysql#escape_string を使用すると例外が発生します。
-
 * いくつかのメソッドがありません: Mysql#debug, Mysql#change_user,
   Mysql#create_db, Mysql#drop_db, Mysql#dump_debug_info,
   Mysql#ssl_set, Mysql#reconnect
 
 * Mysql#options でサポートしているオプションは次のものだけです:
   Mysql::INIT_COMMAND, Mysql::OPT_CONNECT_TIMEOUT,
+  Mysql::OPT_GET_SERVER_PUBLIC_KEY,
+  Mysql::OPT_LOAD_DATA_LOCAL_DIR,
   Mysql::OPT_LOCAL_INFILE, Mysql::OPT_READ_TIMEOUT,
-  Mysql::OPT_WRITE_TIMEOUT, Mysql::SET_CHARSET_NAME,
-  Mysql::OPT_LOAD_DATA_LOCAL_DIR.
+  Mysql::OPT_SSL_MODE,
+  Mysql::OPT_WRITE_TIMEOUT, Mysql::SET_CHARSET_NAME.
   これら以外を指定すると "option not implementted" という warning が標準エラー出力に出力されます。
 
 * Mysql#use_result は Mysql#store_result と同じです。つまりサーバーから一気に結果セットを読み込みます。

data/lib/mysql/authenticator/caching_sha2_password.rb

@@ -0,0 +1,62 @@
+require 'digest/sha2'
+
+class Mysql
+  class Authenticator
+    class CachingSha2Password
+      # @param protocol [Mysql::Protocol]
+      def initialize(protocol)
+        @protocol = protocol
+      end
+
+      # @return [String]
+      def name
+        'caching_sha2_password'
+      end
+
+      # @param passwd [String]
+      # @param scramble [String]
+      # @yield [String] hashed password
+      # @return [Mysql::Packet]
+      def authenticate(passwd, scramble)
+        yield hash_password(passwd, scramble)
+        pkt = @protocol.read
+        data = pkt.to_s
+        if data.size == 2 && data[0] == "\x01"
+          case data[1]
+          when "\x03"  # fast_auth_success
+            # OK
+          when "\x04"  # perform_full_authentication
+            if @protocol.client_flags & CLIENT_SSL != 0
+              @protocol.write passwd+"\0"
+            elsif !@protocol.get_server_public_key
+              raise 'Authentication requires secure connection'
+            else
+              @protocol.write "\2"  # request public key
+              pkt = @protocol.read
+              pkt.utiny # skip
+              pubkey = pkt.to_s
+              hash = (passwd+"\0").unpack("C*").zip(scramble.unpack("C*")).map{|a, b| a ^ b}.pack("C*")
+              enc = OpenSSL::PKey::RSA.new(pubkey).public_encrypt(hash, OpenSSL::PKey::RSA::PKCS1_OAEP_PADDING)
+              @protocol.write enc
+            end
+          else
+            raise "invalid auth reply packet: #{data.inspect}"
+          end
+          pkt = @protocol.read
+        end
+        return pkt
+      end
+
+      # @param passwd [String]
+      # @param scramble [String]
+      # @return [String] hashed password
+      def hash_password(passwd, scramble)
+        return '' if passwd.nil? or passwd.empty?
+        hash1 = Digest::SHA256.digest(passwd)
+        hash2 = Digest::SHA256.digest(hash1)
+        hash3 = Digest::SHA256.digest(hash2 + scramble)
+        hash1.unpack("C*").zip(hash3.unpack("C*")).map{|a, b| a ^ b}.pack("C*")
+      end
+    end
+  end
+end

data/lib/mysql/authenticator/mysql_native_password.rb

@@ -0,0 +1,37 @@
+require 'digest/sha1'
+
+class Mysql
+  class Authenticator
+    class MysqlNativePassword
+      # @param protocol [Mysql::Protocol]
+      def initialize(protocol)
+        @protocol = protocol
+      end
+
+      # @return [String]
+      def name
+        'mysql_native_password'
+      end
+
+      # @param passwd [String]
+      # @param scramble [String]
+      # @yield [String] hashed password
+      # @return [Mysql::Packet]
+      def authenticate(passwd, scramble)
+        yield hash_password(passwd, scramble)
+        @protocol.read
+      end
+
+      # @param passwd [String]
+      # @param scramble [String]
+      # @return [String] hashed password
+      def hash_password(passwd, scramble)
+        return '' if passwd.nil? or passwd.empty?
+        hash1 = Digest::SHA1.digest(passwd)
+        hash2 = Digest::SHA1.digest(hash1)
+        hash3 = Digest::SHA1.digest(scramble + hash2)
+        hash1.unpack("C*").zip(hash3.unpack("C*")).map{|a, b| a ^ b}.pack("C*")
+      end
+    end
+  end
+end

data/lib/mysql/authenticator/sha256_password.rb

@@ -0,0 +1,40 @@
+require 'openssl'
+
+class Mysql
+  class Authenticator
+    class Sha256Password
+      # @param protocol [Mysql::Protocol]
+      def initialize(protocol)
+        @protocol = protocol
+      end
+
+      # @return [String]
+      def name
+        'sha256_password'
+      end
+
+      # @param passwd [String]
+      # @param scramble [String]
+      # @yield [String] hashed password
+      # @return [Mysql::Packet]
+      def authenticate(passwd, scramble)
+        if @protocol.client_flags & CLIENT_SSL != 0
+          yield passwd+"\0"
+          return @protocol.read
+        end
+        yield "\x01"  # request public key
+        pkt = @protocol.read
+        data = pkt.to_s
+        if data[0] == "\x01"
+          pkt.utiny # skip
+          pubkey = pkt.to_s
+          hash = (passwd+"\0").unpack("C*").zip(scramble.unpack("C*")).map{|a, b| a ^ b}.pack("C*")
+          enc = OpenSSL::PKey::RSA.new(pubkey).public_encrypt(hash, OpenSSL::PKey::RSA::PKCS1_OAEP_PADDING)
+          @protocol.write enc
+          pkt = @protocol.read
+        end
+        return pkt
+      end
+    end
+  end
+end

data/lib/mysql/authenticator.rb

@@ -0,0 +1,84 @@
+class Mysql
+  class Authenticator
+    @plugins = {}
+
+    # @param plugin [String]
+    def self.plugin_class(plugin)
+      return @plugins[plugin] if @plugins[plugin]
+
+      raise ClientError, "invalid plugin name: #{plugin}" unless plugin.match?(/\A\w+\z/)
+      begin
+        require_relative "authenticator/#{plugin}"
+      rescue LoadError
+        return nil
+      end
+      class_name = plugin.gsub(/(?:^|_)(.)/){$1.upcase}
+      raise ClientError, "#{class_name} is undefined" unless self.const_defined? class_name
+      klass = self.const_get(class_name)
+      @plugins[plugin] = klass
+      return klass
+    end
+
+    def initialize(protocol)
+      @protocol = protocol
+    end
+
+    # @param plugin [String]
+    def get(plugin)
+      self.class.plugin_class(plugin)
+    end
+
+    # @param plugin [String]
+    def get!(plugin)
+      get(plugin) or raise ClientError, "unknown plugin: #{plugin}"
+    end
+
+    def authenticate(user, passwd, db, scramble, plugin_name)
+      plugin = (get(plugin_name) || DummyPlugin).new(@protocol)
+      pkt = plugin.authenticate(passwd, scramble) do |hashed|
+        @protocol.write Protocol::AuthenticationPacket.serialize(@protocol.client_flags, 1024**3, @protocol.charset.number, user, hashed, db, plugin.name)
+      end
+      while true
+        res = Protocol::AuthenticationResultPacket.parse(pkt)
+        case res.result
+        when 0  # OK
+          break
+        when 2  # multi factor auth
+          raise ClientError, 'multi factor authentication is not supported'
+        when 254  # change auth plugin
+          plugin = get!(res.auth_plugin).new(@protocol)
+          pkt = plugin.authenticate(passwd, res.scramble) do |hashed|
+            if passwd.nil? || passwd.empty?
+              @protocol.write "\0"
+            else
+              @protocol.write hashed
+            end
+          end
+        else
+          raise ClientError, "invalid packet: #{pkt.to_s}"
+        end
+      end
+    end
+
+    class DummyPlugin
+      # @param protocol [Mysql::Protocol]
+      def initialize(protocol)
+        @protocol = protocol
+      end
+
+      # @return [String]
+      def name
+        ''
+      end
+
+      # @param passwd [String]
+      # @param scramble [String]
+      # @yield [String] hashed password
+      # @return [Mysql::Packet]
+      def authenticate(passwd, scramble)
+        yield ''
+        @protocol.read
+      end
+    end
+  end
+end