activerecord-cipherstash-pg-adapter 0.1.0 → 0.3.0

data/lib/active_record/connection_adapters/6.1/cipherstash_pg/quoting.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module CipherStashPG
+      module Quoting
+        # Escapes binary strings for bytea input to the database.
+        def escape_bytea(value)
+          @connection.escape_bytea(value) if value
+        end
+
+        # Unescapes bytea output from a database to the binary string it represents.
+        # NOTE: This is NOT an inverse of escape_bytea! This is only to be used
+        # on escaped binary output from database drive.
+        def unescape_bytea(value)
+          @connection.unescape_bytea(value) if value
+        end
+
+        # Quotes strings for use in SQL input.
+        def quote_string(s) #:nodoc:
+          @connection.escape(s)
+        end
+
+        # Checks the following cases:
+        #
+        # - table_name
+        # - "table.name"
+        # - schema_name.table_name
+        # - schema_name."table.name"
+        # - "schema.name".table_name
+        # - "schema.name"."table.name"
+        def quote_table_name(name) # :nodoc:
+          self.class.quoted_table_names[name] ||= Utils.extract_schema_qualified_name(name.to_s).quoted.freeze
+        end
+
+        # Quotes schema names for use in SQL queries.
+        def quote_schema_name(name)
+          PG::Connection.quote_ident(name)
+        end
+
+        def quote_table_name_for_assignment(table, attr)
+          quote_column_name(attr)
+        end
+
+        # Quotes column names for use in SQL queries.
+        def quote_column_name(name) # :nodoc:
+          self.class.quoted_column_names[name] ||= PG::Connection.quote_ident(super).freeze
+        end
+
+        # Quote date/time values for use in SQL input.
+        def quoted_date(value) # :nodoc:
+          if value.year <= 0
+            bce_year = format("%04d", -value.year + 1)
+            super.sub(/^-?\d+/, bce_year) + " BC"
+          else
+            super
+          end
+        end
+
+        def quoted_binary(value) # :nodoc:
+          "'#{escape_bytea(value.to_s)}'"
+        end
+
+        def quote_default_expression(value, column) # :nodoc:
+          if value.is_a?(Proc)
+            value.call
+          elsif column.type == :uuid && value.is_a?(String) && /\(\)/.match?(value)
+            value # Does not quote function default values for UUID columns
+          elsif column.respond_to?(:array?)
+            type = lookup_cast_type_from_column(column)
+            quote(type.serialize(value))
+          else
+            super
+          end
+        end
+
+        def lookup_cast_type_from_column(column) # :nodoc:
+          type_map.lookup(column.oid, column.fmod, column.sql_type)
+        end
+
+        def column_name_matcher
+          COLUMN_NAME
+        end
+
+        def column_name_with_order_matcher
+          COLUMN_NAME_WITH_ORDER
+        end
+
+        COLUMN_NAME = /
+          \A
+          (
+            (?:
+              # "table_name"."column_name"::type_name | function(one or no argument)::type_name
+              ((?:\w+\.|"\w+"\.)?(?:\w+|"\w+")(?:::\w+)?) | \w+\((?:|\g<2>)\)(?:::\w+)?
+            )
+            (?:(?:\s+AS)?\s+(?:\w+|"\w+"))?
+          )
+          (?:\s*,\s*\g<1>)*
+          \z
+        /ix
+
+        COLUMN_NAME_WITH_ORDER = /
+          \A
+          (
+            (?:
+              # "table_name"."column_name"::type_name | function(one or no argument)::type_name
+              ((?:\w+\.|"\w+"\.)?(?:\w+|"\w+")(?:::\w+)?) | \w+\((?:|\g<2>)\)(?:::\w+)?
+            )
+            (?:\s+ASC|\s+DESC)?
+            (?:\s+NULLS\s+(?:FIRST|LAST))?
+          )
+          (?:\s*,\s*\g<1>)*
+          \z
+        /ix
+
+        private_constant :COLUMN_NAME, :COLUMN_NAME_WITH_ORDER
+
+        private
+          def lookup_cast_type(sql_type)
+            super(query_value("SELECT #{quote(sql_type)}::regtype::oid", "SCHEMA").to_i)
+          end
+
+          def _quote(value)
+            case value
+            when OID::Xml::Data
+              "xml '#{quote_string(value.to_s)}'"
+            when OID::Bit::Data
+              if value.binary?
+                "B'#{value}'"
+              elsif value.hex?
+                "X'#{value}'"
+              end
+            when Numeric
+              if value.finite?
+                super
+              else
+                "'#{value}'"
+              end
+            when OID::Array::Data
+              _quote(encode_array(value))
+            when Range
+              _quote(encode_range(value))
+            else
+              super
+            end
+          end
+
+          def _type_cast(value)
+            case value
+            when Type::Binary::Data
+              # Return a bind param hash with format as binary.
+              # See https://deveiate.org/code/pg/PG/Connection.html#method-i-exec_prepared-doc
+              # for more information
+              { value: value.to_s, format: 1 }
+            when OID::Xml::Data, OID::Bit::Data
+              value.to_s
+            when OID::Array::Data
+              encode_array(value)
+            when Range
+              encode_range(value)
+            else
+              super
+            end
+          end
+
+          def encode_array(array_data)
+            encoder = array_data.encoder
+            values = type_cast_array(array_data.values)
+
+            result = encoder.encode(values)
+            if encoding = determine_encoding_of_strings_in_array(values)
+              result.force_encoding(encoding)
+            end
+            result
+          end
+
+          def encode_range(range)
+            "[#{type_cast_range_value(range.begin)},#{type_cast_range_value(range.end)}#{range.exclude_end? ? ')' : ']'}"
+          end
+
+          def determine_encoding_of_strings_in_array(value)
+            case value
+            when ::Array then determine_encoding_of_strings_in_array(value.first)
+            when ::String then value.encoding
+            end
+          end
+
+          def type_cast_array(values)
+            case values
+            when ::Array then values.map { |item| type_cast_array(item) }
+            else _type_cast(values)
+            end
+          end
+
+          def type_cast_range_value(value)
+            infinity?(value) ? "" : type_cast(value)
+          end
+
+          def infinity?(value)
+            value.respond_to?(:infinite?) && value.infinite?
+          end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/6.1/cipherstash_pg/referential_integrity.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module CipherStashPG
+      module ReferentialIntegrity # :nodoc:
+        def disable_referential_integrity # :nodoc:
+          original_exception = nil
+
+          begin
+            transaction(requires_new: true) do
+              execute(tables.collect { |name| "ALTER TABLE #{quote_table_name(name)} DISABLE TRIGGER ALL" }.join(";"))
+            end
+          rescue ActiveRecord::ActiveRecordError => e
+            original_exception = e
+          end
+
+          begin
+            yield
+          rescue ActiveRecord::InvalidForeignKey => e
+            warn <<-WARNING
+WARNING: Rails was not able to disable referential integrity.
+
+This is most likely caused due to missing permissions.
+Rails needs superuser privileges to disable referential integrity.
+
+    cause: #{original_exception&.message}
+
+            WARNING
+            raise e
+          end
+
+          begin
+            transaction(requires_new: true) do
+              execute(tables.collect { |name| "ALTER TABLE #{quote_table_name(name)} ENABLE TRIGGER ALL" }.join(";"))
+            end
+          rescue ActiveRecord::ActiveRecordError
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/6.1/cipherstash_pg/schema_creation.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module CipherStashPG
+      class SchemaCreation < SchemaCreation # :nodoc:
+        private
+          def visit_AlterTable(o)
+            super << o.constraint_validations.map { |fk| visit_ValidateConstraint fk }.join(" ")
+          end
+
+          def visit_AddForeignKey(o)
+            super.dup.tap { |sql| sql << " NOT VALID" unless o.validate? }
+          end
+
+          def visit_CheckConstraintDefinition(o)
+            super.dup.tap { |sql| sql << " NOT VALID" unless o.validate? }
+          end
+
+          def visit_ValidateConstraint(name)
+            "VALIDATE CONSTRAINT #{quote_column_name(name)}"
+          end
+
+          def visit_ChangeColumnDefinition(o)
+            column = o.column
+            column.sql_type = type_to_sql(column.type, **column.options)
+            quoted_column_name = quote_column_name(o.name)
+
+            change_column_sql = +"ALTER COLUMN #{quoted_column_name} TYPE #{column.sql_type}"
+
+            options = column_options(column)
+
+            if options[:collation]
+              change_column_sql << " COLLATE \"#{options[:collation]}\""
+            end
+
+            if options[:using]
+              change_column_sql << " USING #{options[:using]}"
+            elsif options[:cast_as]
+              cast_as_type = type_to_sql(options[:cast_as], **options)
+              change_column_sql << " USING CAST(#{quoted_column_name} AS #{cast_as_type})"
+            end
+
+            if options.key?(:default)
+              if options[:default].nil?
+                change_column_sql << ", ALTER COLUMN #{quoted_column_name} DROP DEFAULT"
+              else
+                quoted_default = quote_default_expression(options[:default], column)
+                change_column_sql << ", ALTER COLUMN #{quoted_column_name} SET DEFAULT #{quoted_default}"
+              end
+            end
+
+            if options.key?(:null)
+              change_column_sql << ", ALTER COLUMN #{quoted_column_name} #{options[:null] ? 'DROP' : 'SET'} NOT NULL"
+            end
+
+            change_column_sql
+          end
+
+          def add_column_options!(sql, options)
+            if options[:collation]
+              sql << " COLLATE \"#{options[:collation]}\""
+            end
+            super
+          end
+
+          # Returns any SQL string to go between CREATE and TABLE. May be nil.
+          def table_modifier_in_create(o)
+            # A table cannot be both TEMPORARY and UNLOGGED, since all TEMPORARY
+            # tables are already UNLOGGED.
+            if o.temporary
+              " TEMPORARY"
+            elsif o.unlogged
+              " UNLOGGED"
+            end
+          end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/6.1/cipherstash_pg/schema_definitions.rb

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module CipherStashPG
+      module ColumnMethods
+        extend ActiveSupport::Concern
+
+        # Defines the primary key field.
+        # Use of the native PostgreSQL UUID type is supported, and can be used
+        # by defining your tables as such:
+        #
+        #   create_table :stuffs, id: :uuid do |t|
+        #     t.string :content
+        #     t.timestamps
+        #   end
+        #
+        # By default, this will use the <tt>gen_random_uuid()</tt> function from the
+        # +pgcrypto+ extension. As that extension is only available in
+        # PostgreSQL 9.4+, for earlier versions an explicit default can be set
+        # to use <tt>uuid_generate_v4()</tt> from the +uuid-ossp+ extension instead:
+        #
+        #   create_table :stuffs, id: false do |t|
+        #     t.primary_key :id, :uuid, default: "uuid_generate_v4()"
+        #     t.uuid :foo_id
+        #     t.timestamps
+        #   end
+        #
+        # To enable the appropriate extension, which is a requirement, use
+        # the +enable_extension+ method in your migrations.
+        #
+        # To use a UUID primary key without any of the extensions, set the
+        # +:default+ option to +nil+:
+        #
+        #   create_table :stuffs, id: false do |t|
+        #     t.primary_key :id, :uuid, default: nil
+        #     t.uuid :foo_id
+        #     t.timestamps
+        #   end
+        #
+        # You may also pass a custom stored procedure that returns a UUID or use a
+        # different UUID generation function from another library.
+        #
+        # Note that setting the UUID primary key default value to +nil+ will
+        # require you to assure that you always provide a UUID value before saving
+        # a record (as primary keys cannot be +nil+). This might be done via the
+        # +SecureRandom.uuid+ method and a +before_save+ callback, for instance.
+        def primary_key(name, type = :primary_key, **options)
+          if type == :uuid
+            options[:default] = options.fetch(:default, "gen_random_uuid()")
+          end
+
+          super
+        end
+
+        ##
+        # :method: bigserial
+        # :call-seq: bigserial(*names, **options)
+
+        ##
+        # :method: bit
+        # :call-seq: bit(*names, **options)
+
+        ##
+        # :method: bit_varying
+        # :call-seq: bit_varying(*names, **options)
+
+        ##
+        # :method: cidr
+        # :call-seq: cidr(*names, **options)
+
+        ##
+        # :method: citext
+        # :call-seq: citext(*names, **options)
+
+        ##
+        # :method: daterange
+        # :call-seq: daterange(*names, **options)
+
+        ##
+        # :method: hstore
+        # :call-seq: hstore(*names, **options)
+
+        ##
+        # :method: inet
+        # :call-seq: inet(*names, **options)
+
+        ##
+        # :method: interval
+        # :call-seq: interval(*names, **options)
+
+        ##
+        # :method: int4range
+        # :call-seq: int4range(*names, **options)
+
+        ##
+        # :method: int8range
+        # :call-seq: int8range(*names, **options)
+
+        ##
+        # :method: jsonb
+        # :call-seq: jsonb(*names, **options)
+
+        ##
+        # :method: ltree
+        # :call-seq: ltree(*names, **options)
+
+        ##
+        # :method: macaddr
+        # :call-seq: macaddr(*names, **options)
+
+        ##
+        # :method: money
+        # :call-seq: money(*names, **options)
+
+        ##
+        # :method: numrange
+        # :call-seq: numrange(*names, **options)
+
+        ##
+        # :method: oid
+        # :call-seq: oid(*names, **options)
+
+        ##
+        # :method: point
+        # :call-seq: point(*names, **options)
+
+        ##
+        # :method: line
+        # :call-seq: line(*names, **options)
+
+        ##
+        # :method: lseg
+        # :call-seq: lseg(*names, **options)
+
+        ##
+        # :method: box
+        # :call-seq: box(*names, **options)
+
+        ##
+        # :method: path
+        # :call-seq: path(*names, **options)
+
+        ##
+        # :method: polygon
+        # :call-seq: polygon(*names, **options)
+
+        ##
+        # :method: circle
+        # :call-seq: circle(*names, **options)
+
+        ##
+        # :method: serial
+        # :call-seq: serial(*names, **options)
+
+        ##
+        # :method: tsrange
+        # :call-seq: tsrange(*names, **options)
+
+        ##
+        # :method: tstzrange
+        # :call-seq: tstzrange(*names, **options)
+
+        ##
+        # :method: tsvector
+        # :call-seq: tsvector(*names, **options)
+
+        ##
+        # :method: uuid
+        # :call-seq: uuid(*names, **options)
+
+        ##
+        # :method: xml
+        # :call-seq: xml(*names, **options)
+
+        included do
+          define_column_methods :bigserial, :bit, :bit_varying, :cidr, :citext, :daterange,
+            :hstore, :inet, :interval, :int4range, :int8range, :jsonb, :ltree, :macaddr,
+            :money, :numrange, :oid, :point, :line, :lseg, :box, :path, :polygon, :circle,
+            :serial, :tsrange, :tstzrange, :tsvector, :uuid, :xml
+        end
+      end
+
+      class TableDefinition < ActiveRecord::ConnectionAdapters::TableDefinition
+        include ColumnMethods
+
+        attr_reader :unlogged
+
+        def initialize(*, **)
+          super
+          @unlogged = ActiveRecord::ConnectionAdapters::CipherStashPGAdapter.create_unlogged_tables
+        end
+
+        private
+          def integer_like_primary_key_type(type, options)
+            if type == :bigint || options[:limit] == 8
+              :bigserial
+            else
+              :serial
+            end
+          end
+      end
+
+      class Table < ActiveRecord::ConnectionAdapters::Table
+        include ColumnMethods
+      end
+
+      class AlterTable < ActiveRecord::ConnectionAdapters::AlterTable
+        attr_reader :constraint_validations
+
+        def initialize(td)
+          super
+          @constraint_validations = []
+        end
+
+        def validate_constraint(name)
+          @constraint_validations << name
+        end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/6.1/cipherstash_pg/schema_dumper.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module CipherStashPG
+      class SchemaDumper < ConnectionAdapters::SchemaDumper # :nodoc:
+        private
+          def extensions(stream)
+            extensions = @connection.extensions
+            if extensions.any?
+              stream.puts "  # These are extensions that must be enabled in order to support this database"
+              extensions.sort.each do |extension|
+                stream.puts "  enable_extension #{extension.inspect}"
+              end
+              stream.puts
+            end
+          end
+
+          def prepare_column_options(column)
+            spec = super
+            spec[:array] = "true" if column.array?
+            spec
+          end
+
+          def default_primary_key?(column)
+            schema_type(column) == :bigserial
+          end
+
+          def explicit_primary_key_default?(column)
+            column.type == :uuid || (column.type == :integer && !column.serial?)
+          end
+
+          def schema_type(column)
+            return super unless column.serial?
+
+            if column.bigint?
+              :bigserial
+            else
+              :serial
+            end
+          end
+
+          def schema_expression(column)
+            super unless column.serial?
+          end
+      end
+    end
+  end
+end