Project

mask_sql

0.0
No commit activity in last 3 years
No release in over 3 years
mask_sqlemsk/mask_sqlHomepageDocumentationSource CodeBug TrackerWiki
MaskSQL is a command-line tool to mask sensitive values in a SQL file
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
4,568
Stars
2
Forks
0
Watchers
2
 Releases
Current version
0.2.0
Total releases
2
First release
2017-04-17
Latest release
2017-05-27
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2019-03-21
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.14
coveralls
~> 0.8
rake
~> 10.0
rspec
~> 3.6
rubocop
~> 0.49
simplecov
~> 0.14

Runtime

thor
~> 0.19
 Project Readme

MaskSQL

Gem Version Build Status Build Status Build Status Codecov Code Climate Inline docs License

MaskSQL is a command-line tool to mask sensitive values in a SQL file.

Installation

Add this line to your application's Gemfile:

gem 'mask_sql'

And then execute:

$ bundle

Or install it yourself as:

$ gem install mask_sql

Usage

Mask sensitive values in a SQL file

$ mask_sql --in dump.sql --out masked_dump.sql --config mask_config.yml

Generate a config file

$ mask_sql init

Command Options

Option Alias Description Default
--in -i Input file path (Required).
--out -o Output file path (Required).
--config -c Config YAML file path. .mask.yml in the working directory.
--insert true if mask INSERT SQL. false, but true if --insert, --replace, and --copy options are not given.
--replace true if mask REPLACE SQL. false, but true if --insert, --replace, and --copy options are not given.
--copy true if mask COPY SQL. false, but true if --insert, --replace, and --copy options are not given.

Config

The following keys are available in the config YAML file.

Top level keys

Key Description Type
mark Replacement text. String
targets Array of targets. Array

Keys for targets

Key Description Type
table Target table name. String
columns Columns count of the table. Integer
dummy_values Target column index (zero-based) and dummy text. Hash
group_indexes Array of column indexes (zero-based).
Records that have the same values in these indexes are considered as the same numbering group.		 Array

Examples

Input file (includes sensitive values):

INSERT INTO `people` (`id`, `code`, `name`, `email`) VALUES (1,'01','坂本龍馬','ryoma-sakamoto@example.com'),(2,'02','高杉晋作','shinsaku-takasugi@example.com'),(3,'03','沖田総司','soji-okita@example.com');
INSERT INTO `cats` (`code`, `name`) VALUES ('01','Sora'),('02','Hana'),('03','Leo');
INSERT INTO `dogs` (`code`, `name`, `house_id`, `room_id`) VALUES ('01','Pochi',1,1),('02','Rose',2,1),('03','Momo',1,1),('04','Sakura',1,2);

REPLACE INTO `people` (`id`, `code`, `name`, `email`) VALUES (1,'01','坂本龍馬','ryoma-sakamoto@example.com'),(2,'02','高杉晋作','shinsaku-takasugi@example.com'),(3,'03','沖田総司','soji-okita@example.com');
REPLACE INTO `cats` (`code`, `name`) VALUES ('01','Sora'),('02','Hana'),('03','Leo');
REPLACE INTO `dogs` (`code`, `name`, `house_id`, `room_id`) VALUES ('01','Pochi',1,1),('02','Rose',2,1),('03','Momo',1,1),('04','Sakura',1,2);

COPY people (id, code, name, email) FROM stdin;
1	01	坂本龍馬	ryoma-sakamoto@example.com
2	02	高杉晋作	shinsaku-takasugi@example.com
3	03	沖田総司	soji-okita@example.com
\.
COPY cats (code, name) FROM stdin;
01	Sora
02	Hana
03	Leo
\.
COPY dogs (code, name, house_id, room_id) FROM stdin;
01	Pochi	1	1
02	Rose	2	1
03	Momo	1	1
04	Sakura	1	2
\.

Output file (the sensitive values are masked):

INSERT INTO `people` (`id`, `code`, `name`, `email`) VALUES (1,'01','氏名1','email-1@example.com'),(2,'02','氏名2','email-2@example.com'),(3,'03','氏名3','email-3@example.com');
INSERT INTO `cats` (`code`, `name`) VALUES ('code-1','Cat name 1'),('code-2','Cat name 2'),('code-3','Cat name 3');
INSERT INTO `dogs` (`code`, `name`, `house_id`, `room_id`) VALUES ('code-1','Dog name 1',1,1),('code-1','Dog name 1',2,1),('code-2','Dog name 2',1,1),('code-1','Dog name 1',1,2);

REPLACE INTO `people` (`id`, `code`, `name`, `email`) VALUES (1,'01','氏名1','email-1@example.com'),(2,'02','氏名2','email-2@example.com'),(3,'03','氏名3','email-3@example.com');
REPLACE INTO `cats` (`code`, `name`) VALUES ('code-1','Cat name 1'),('code-2','Cat name 2'),('code-3','Cat name 3');
REPLACE INTO `dogs` (`code`, `name`, `house_id`, `room_id`) VALUES ('code-1','Dog name 1',1,1),('code-1','Dog name 1',2,1),('code-2','Dog name 2',1,1),('code-1','Dog name 1',1,2);

COPY people (id, code, name, email) FROM stdin;
1	01	氏名1	email-1@example.com
2	02	氏名2	email-2@example.com
3	03	氏名3	email-3@example.com
\.
COPY cats (code, name) FROM stdin;
code-1	Cat name 1
code-2	Cat name 2
code-3	Cat name 3
\.
COPY dogs (code, name, house_id, room_id) FROM stdin;
code-1	Dog name 1	1	1
code-1	Dog name 1	2	1
code-2	Dog name 2	1	1
code-1	Dog name 1	1	2
\.

Config file:

mark: '[mask]'
targets:
  - table: people
    columns: 4
    dummy_values:
      2: 氏名[mask]
      3: email-[mask]@example.com
  - table: cats
    columns: 2
    dummy_values:
      0: code-[mask]
      1: Cat name [mask]
  - table: dogs
    columns: 4
    dummy_values:
      0: code-[mask]
      1: Dog name [mask]
    group_indexes:
      - 2
      - 3

Supported Ruby Versions

Ruby 2.0.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 3.0

Contributing

Bug reports and pull requests are welcome.

Related

License

MIT