mysqlaudit 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjRmYmMyZjFiYjNiMGNkYzllNTY3NjZjMWJlZTljNjY0MTUwOTE1Zg==
+  data.tar.gz: !binary |-
+    N2MwYTg0NWFlZjQ5NzAyMTQzYWRmYzc0YWEwMDk4NGRmY2ViN2ZjNw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ODUzYWIxYWYxY2NhMTI2MTlmZTM0NzhmN2MyYTEyYWY0MjlhMzEwMGUxNWZh
+    MjVhMmI3ZDQ1YWVlZTE0YjRjM2E3MTJlZGQxMGFiYjA2YjA4NWQ1NWQyOWIz
+    NzQ1MDVmYmM5NWYzNWFkYzEzYWI0YTA1ZjQ5NjhlMDMxYTliNzU=
+  data.tar.gz: !binary |-
+    MjI4ODI0MWQwODYyNWViZjdiMjFiYWIwZmM0ZmUyOWY2NzVkN2RkYjMyNzYx
+    OWZkNTc5NzNiZGFkYWNlYjNkMGJhMjlhMzgwYWFlZTk5NjRjYjI4Nzg5MWU5
+    NGY2N2EyYjc0ZTBkNDFlOWEzZWZkZTBkY2M2YzlhMDJiMWY0MzQ=

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nicola Strappazzon C.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,152 @@
+# Mysqlaudit
+
+MySQL tool build in ruby for audit all tables with triggers, this is a change
+log for SQL transactions executed sentences as INSERT, UPDATE, and DELETE.
+
+## Useful for:
+
+1. Log all changes on table.
+2. Rollback changes.
+3. Detecting unnecessary transactions.
+
+## Installation
+
+Install this tool executing the following command:
+
+```Shell
+$ gem install mysqlaudit
+```
+
+## Usage
+
+This is a simple tutorial to understand this tool, please, follow next
+instructions:
+
+### Install test enviroment
+
+Create test database and table:
+
+```SQL
+CREATE DATABASE audit CHARACTER SET utf8;
+
+USE audit;
+
+CREATE TABLE foo (
+  id int(10) unsigned NOT NULL AUTO_INCREMENT,
+  email char(255) NOT NULL,
+  name VARCHAR(45) NOT NULL,
+  birthday TIMESTAMP NOT NULL,
+  PRIMARY KEY (id),
+  UNIQUE KEY id_UNIQUE (id)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+```
+
+Install audit table and triggers on foo table:
+
+```Shell
+$ mysqlaudit install --host 127.0.0.1 --user root --pass admin --schema audit --table foo
+```
+
+The following query catch all changes of data with trigger audit:
+
+```SQL
+INSERT INTO foo (email, name, birthday) VALUES ('abc@abc.com','Fulano','1980-04-01');
+INSERT INTO foo (email, name, birthday) VALUES ('def@def.org','Mengano','1979-03-28');
+INSERT INTO foo (email, name, birthday) VALUES ('ghi@ghi.net','Jaimito','1980-06-15');
+UPDATE foo SET name = 'Zutano' WHERE id = 3;
+DELETE FROM foo WHERE id = 2;
+```
+
+To apply rollback with specific transaction, this generate SQL output:
+
+### Get deleted data:
+
+```Shell
+$ mysqlaudit rollback --host 127.0.0.1 \
+                      --user root \
+                      --pass admin \
+                      --schema audit \
+                      --table foo \
+                      --statement delete
+```
+
+Output of last executed command:
+
+```
+/* 2013-07-11 07:25:25 */ INSERT INTO foo (id, email, name, birthday) VALUES (2, 'def@def.org', 'Mengano', '1979-03-28 00:00:00');
+```
+
+### Get updated data:
+```Shell
+$ mysqlaudit rollback --host 127.0.0.1 \
+                      --user root \
+                      --pass admin \
+                      --schema audit \
+                      --table foo \
+                      --statement update
+```
+
+Output of last executed command:
+
+```
+/* 2013-07-11 07:26:26 */ UPDATE users SET birthday = '1980-06-15 00:00:00' WHERE id = 3;
+/* 2013-07-11 07:26:26 */ UPDATE users SET name = 'Jaimito' WHERE id = 3;
+```
+
+### Get inserted data:
+```Shell
+$ mysqlaudit rollback --host 127.0.0.1 \
+                      --user root \
+                      --pass admin \
+                      --schema audit \
+                      --table foo \
+                      --statement insert
+```
+
+Output of last executed command:
+
+```
+/* 2013-07-11 07:27:27 */ DELETE FROM foo WHERE id = 1;
+/* 2013-07-11 07:27:27 */ DELETE FROM foo WHERE id = 2;
+/* 2013-07-11 07:27:27 */ DELETE FROM foo WHERE id = 3;
+```
+
+### Uninstall test enviroment:
+
+Uninstall all triggers and drop audit table.
+
+```Shell
+$ mysqlaudit uninstall --host 127.0.0.1 \
+                       --user root \
+                       --pass admin \
+                       --schema audit \
+                       --table foo \
+                       --drop-audit-table
+```
+
+Drop testing table and database:
+
+```SQL
+DROP TABLE audit;
+DROP DATABASE foo;
+```
+
+For more information:
+
+```Shell
+$ mysqlaudit --help
+```
+
+## Warning
+
+1. Do not use this tool in production before testing it.
+2. Please, use when do you need.
+3. The author is NOT responsible for misuse use of this tool.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/bin/mysqlaudit

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+
+# Only for deploy this script.
+$LOAD_PATH << './lib'
+
+
+require 'rubygems'
+require 'commander'
+require 'commander/import'
+require 'mysqlaudit'
+require 'mysqlaudit/actions'
+require 'mysqlaudit/version'
+
+program :name, 'MySQL Audit Tool'
+program :version, Mysqlaudit::VERSION
+program :description, 'MySQL tool for audit all tables with triggers.'
+program :help, 'Author', 'Nicola Strappazzon <nicola51980@gmail.com>'
+
+command :install do |c|
+  c.description = 'Install audit table'
+  c.syntax = 'audits install --host 127.0.0.1 --user root [--pass admin] --schema sakila [--table foo]'
+  c.option '--host STRING', String, 'Host'
+  c.option '--user STRING', String, 'User'
+  c.option '--pass STRING', String, 'Password'
+  c.option '--schema STRING', String, 'Schema name'
+  c.option '--table STRING', String, 'Table name'
+  c.action do |args, options|
+    Mysqlaudit::Actions.new(options.host, options.user, options.pass, options.schema, options.table).install
+  end
+end
+
+command :uninstall do |c|
+  c.description = 'Uninstall audit table'
+  c.syntax = 'audits uninstall --host 127.0.0.1 --user root [--pass admin] --schema sakila [--table foo] [--[no-]drop-audit-table]'
+  c.option '--host STRING', String, 'Host'
+  c.option '--user STRING', String, 'User'
+  c.option '--pass STRING', String, 'Password'
+  c.option '--schema STRING', String, 'Schema name'
+  c.option '--table STRING', String, 'Table name'
+  c.option '--[no-]drop-audit-table', 'Drop audit table'
+  c.action do |args, options|
+    Mysqlaudit::Actions.new(options.host, options.user, options.pass, options.schema, options.table, options.drop_audit_table).uninstall
+  end
+end
+
+command :rollback do |c|
+  c.description = 'Rollback transaction cath in audit table'
+  c.syntax = 'audits rollback --host 127.0.0.1 --user root [--pass admin] --schema sakila --table foo --statement INSERT'
+  c.option '--host STRING', String, 'Host'
+  c.option '--user STRING', String, 'User'
+  c.option '--pass STRING', String, 'Password'
+  c.option '--schema STRING', String, 'Schema name'
+  c.option '--table STRING', String, 'Table name'
+  c.option '--statement STRING', String, 'Statement operation, INSERT, UPDATE, or DELETE'
+  c.action do |args, options|
+    Mysqlaudit::Actions.new(options.host, options.user, options.pass, options.schema, options.table, nil, options.statement).rollback
+  end
+end

data/lib/mysqlaudit/actions.rb

@@ -0,0 +1,62 @@
+require 'mysqlaudit/audit'
+
+module Mysqlaudit
+  class Actions
+    @audit = nil
+
+    def initialize(host, user, password, schema, table, drop = nil, statement = nil)
+    # def initialize(schema, table, options = {})
+    #   options = {host: 'localhost', user: 'root', password: ''}.merge(options)
+
+      $host      = host
+      $user      = user
+      $password  = password
+      $schema    = schema
+      $table     = table
+      $drop      = drop
+      $statement = statement
+
+      @audit = Mysqlaudit::Audit.new($host, $user, $password, $schema)
+    end
+
+    def install()
+      @audit.create_table()
+
+      if !$table
+        tables = @audit.get_tables()
+        tables.each do | table |
+          @audit.create_trigger(table, :insert)
+          @audit.create_trigger(table, :update)
+          @audit.create_trigger(table, :delete)
+        end
+      else
+        @audit.create_trigger($table, :insert)
+        @audit.create_trigger($table, :update)
+        @audit.create_trigger($table, :delete)
+      end
+    end
+
+    def uninstall()
+      if !$table
+        tables = @audit.get_tables()
+        tables.each do | table |
+          @audit.drop_trigger(table, :insert)
+          @audit.drop_trigger(table, :update)
+          @audit.drop_trigger(table, :delete)
+        end
+      else
+          @audit.drop_trigger($table, :insert)
+          @audit.drop_trigger($table, :update)
+          @audit.drop_trigger($table, :delete)
+      end
+
+      if $drop
+        @audit.drop_table()
+      end
+    end
+
+    def rollback()
+      @audit.rollback($table, $statement.to_sym)
+    end
+  end
+end

data/lib/mysqlaudit/audit.rb

@@ -0,0 +1,168 @@
+require 'rubygems'
+require 'mysql2'
+
+# @todo Optimize passing params on methods with maps.
+# @todo Optimize is set params to execute methods.
+# @todo Passing as parameter the tables names to apply triggers.
+# @todo Change name for audit table.
+# @todo If exist trigger then append to existing.
+# @todo Backup if exist triggers.
+# @todo Define expiration time for events.
+
+module Mysqlaudit
+  class Audit
+    def initialize(host, user, password, schema)
+      $host     = host
+      $user     = user
+      $password = password
+      $schema   = schema
+
+      connect
+    end
+
+    def connect()
+      begin
+        @mysql = Mysql2::Client.new(:host     => $host,
+                                    :username => $user,
+                                    :password => $password,
+                                    :database => $schema)
+      rescue
+        puts "Can't connect to MySQL Server."
+        exit 1
+      end
+    end
+
+    def create_table()
+      if !has_table
+        sql = <<SQL
+CREATE TABLE IF NOT EXISTS audits (
+  id int(10) unsigned NOT NULL AUTO_INCREMENT,
+  type enum('I', 'U', 'D') NOT NULL,
+  `table` char(64) NOT NULL,
+  `column` char(64) NOT NULL,
+  `primary_key` int(10) unsigned,
+  `old` TEXT DEFAULT NULL,
+  `new` TEXT DEFAULT NULL,
+  `trigger_at` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
+  PRIMARY KEY (id),
+  UNIQUE KEY id_UNIQUE (id)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8
+SQL
+
+        @mysql.query(sql)
+        puts "Created table audits in #{$schema} database."
+      end
+    end
+
+    def has_table()
+      sql       = "SELECT true AS has FROM information_schema.tables WHERE table_schema = '#{$schema}' AND table_name = 'audits';"
+      @mysql.query(sql).count == 1
+    end
+
+    def drop_table()
+      return unless has_table()
+      @mysql.query("DROP TABLE IF EXISTS audits;")
+      puts "Delete table audits in #{$schema} database."
+    end
+
+    def get_tables()
+      sql        = "SELECT table_name AS name FROM INFORMATION_SCHEMA.TABLES WHERE table_schema = '#{$schema}' AND table_name <> 'audits';"
+      sql_result = @mysql.query(sql)
+      sql_result.map { |table| table['name']}
+    end
+
+    def get_primary_key(table)
+      sql = "SELECT column_name AS name FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_SCHEMA='#{$schema}' AND TABLE_NAME='#{table}' AND column_key = 'PRI';"
+      @mysql.query(sql).first['name']
+    end
+
+    def get_columns(table)
+      sql       = "SELECT column_name AS name FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_SCHEMA='#{$schema}' AND TABLE_NAME='#{table}' AND column_key <> 'PRI';"
+      sql_result = @mysql.query(sql)
+      sql_result.map { |table| table['name']}
+    end
+
+    def create_trigger(table, actionName)
+      if !has_trigger(table, actionName)
+        columns = get_columns(table)
+        key     = get_primary_key(table)
+
+        if key
+          sql = "CREATE TRIGGER audit_#{table}_#{actionName.downcase} AFTER #{actionName.upcase} ON #{table}\nFOR EACH ROW BEGIN\n"
+
+          columns.each do | column |
+            case actionName.downcase
+              when :insert
+                sql << "INSERT INTO audits (type, `table`, `column`, primary_key, old, new) VALUES ('#{actionName[0,1].upcase}', '#{table}', '#{column}', NEW.#{key}, NULL, NEW.#{column});\n"
+              when :update
+                sql << "IF OLD.#{column} <> NEW.#{column} THEN\n"
+                sql << "  INSERT INTO audits (type, `table`, `column`, primary_key, old, new) VALUES ('#{actionName[0,1].upcase}', '#{table}', '#{column}', NEW.#{key}, OLD.#{column}, NEW.#{column});\n"
+                sql << "END IF;\n"
+              when :delete
+                sql << "INSERT INTO audits (type, `table`, `column`, primary_key, old, new) VALUES ('#{actionName[0,1].upcase}', '#{table}', '#{column}', OLD.#{key}, OLD.#{column}, NULL);\n"
+            end
+          end
+
+          sql << "END;"
+
+          @mysql.query(sql)
+          puts "Created trigger in #{table} table after #{actionName}."
+        else
+          puts "Impossible to create trigger in #{table}, not have primary key."
+        end
+      else
+        puts "Impossible to create trigger in #{table}, has a trigger."
+      end
+    end
+
+    def drop_trigger(table, actionName)
+      if has_trigger(table, actionName)
+        sql = "DROP TRIGGER IF EXISTS audit_#{table}_#{actionName};"
+        @mysql.query(sql)
+        puts "Deleted trigger in #{table} table after #{actionName}."
+      end
+    end
+
+    def has_trigger(table, actionName)
+      sql       = "SELECT true AS has FROM information_schema.triggers WHERE trigger_schema = '#{$schema}' AND trigger_name = 'audit_#{table}_#{actionName}';"
+      @mysql.query(sql).count == 1
+    end
+
+    def build_pivot_query(table, statement)
+      columns = get_columns($table)
+      key     = get_primary_key($table)
+
+      case statement
+        when :insert
+          sql = <<SQL
+SELECT CONCAT('/* ', trigger_at, ' */ DELETE FROM #{$table} WHERE id = ', MAX(primary_key),';') AS `row`
+FROM audits
+WHERE `type`  = 'I'
+  AND `table` = '#{$table}'
+GROUP BY primary_key
+ORDER BY trigger_at, primary_key, `column` ASC;
+SQL
+        when :delete
+          sql = "SELECT CONCAT('/* ', trigger_at, ' */ INSERT INTO #{$table} (#{key}, #{columns.join(', ')}) VALUES (', primary_key, ', ', "
+          columns.each do | column |
+            sql << " QUOTE(MAX(IF(`column` = '#{column}', `old`, NULL))), ', ', "
+          end
+          sql  = sql.chomp(" ', ', ")
+          sql << "');'"
+          sql << ") AS `row` FROM audits WHERE `type`  = 'D' AND `table` = '#{$table}' GROUP BY primary_key ORDER BY trigger_at, primary_key, `column` ASC;"
+        when :update
+          sql = "SELECT CONCAT('/* ', trigger_at, ' */ UPDATE users SET ',  `column`, ' = ', QUOTE(old), ' WHERE id = ', primary_key, ';') AS `row`"
+          sql << "FROM audits WHERE `type` = 'U' AND `table` = '#{$table}' ORDER BY trigger_at, primary_key, `column` ASC;"
+      end
+
+      sql_result = @mysql.query(sql)
+      sql_result.each(:as => :array) do |row|
+        puts row
+      end
+    end
+
+    def rollback(table, statement)
+      build_pivot_query(table, statement)
+    end
+  end
+end

data/lib/mysqlaudit/version.rb

@@ -0,0 +1,3 @@
+module Mysqlaudit
+  VERSION = '0.0.1'
+end

data/lib/mysqlaudit.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'mysqlaudit/actions'
+require 'mysqlaudit/audit'
+require 'mysqlaudit/version'
+
+module Mysqlaudit
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: mysqlaudit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nicola Strappazzon C.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-14 00:00:00.000000000 Z
+dependencies: []
+description: MySQL tool for audit all tables with triggers.
+email: nicola51980@gmail.com
+executables:
+- mysqlaudit
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/mysqlaudit
+- lib/mysqlaudit/actions.rb
+- lib/mysqlaudit/audit.rb
+- lib/mysqlaudit/version.rb
+- lib/mysqlaudit.rb
+- LICENSE.txt
+- README.md
+homepage: https://github.com/nicola51980/mysqlaudit
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: MySQL Audit Tool
+test_files: []