Greenmask Beta Release v0.1.0-beta

.gitignore

@@ -0,0 +1,28 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+vendor/
+
+# IDEs directories
+.idea
+.vscode
+scratch
+
+# Project exclusion
+venv
+config.yml
+.cache
+# Binaries
+cmd/greenmask/greenmask
+pkg/toolkit/test/test

LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

Makefile

@@ -0,0 +1,25 @@
+MAIN_PATH := ./cmd/greenmask/
+CMD_NAME := greenmask
+CMD_FILES = $(wildcard *.go)
+TEST_FILES = $(wildcard *.go)
+COVERAGE_FILE := coverage.out
+VERSION ?= $(shell git tag --points-at HEAD)
+LDFLAGS ?= -X main.version=$(VERSION)
+
+.PHONY: build
+
+tests: unittest
+
+unittest:
+	go list ./... | xargs go vet
+	go test $(TEST_FILES)
+
+coverage:
+	go list ./... | grep -E 'internal|pkg' | xargs go test -v -coverprofile=$(COVERAGE_FILE) | grep -v 'no test files'
+	go tool cover -html=$(COVERAGE_FILE)
+
+install:
+	mv $(MAIN_PATH)/$(CMD_NAME) $(GOBIN)/$(CMD_NAME)
+
+build: $(CMD_FILES)
+	go build -ldflags="$(LDFLAGS)" -v -o $(CMD_NAME) $(MAIN_PATH)

README.md

@@ -0,0 +1,129 @@
+# Greenmask - dump obfuscation tool
+
+## Preface
+
+**Greenmask** is an open-source util written on go that provides features for logical backup dumping, obfuscation and
+restoration. Brings wide functionality for backing up, anonymization and masking. It is written fully in pure go
+with ported required PostgreSQL library.
+It is stateless util (is not required any database schema changes), has a variety of storages and provide comprehensive
+obfuscation features. Was designed as easy customizable and backward compatible with PostgreSQL utils.
+
+# Features
+
+* **Cross-platform** - may be built and run on any platform because fully written on go without platform dependencies.
+* **Database type safe**: Greenmask validated data and uses the driver for encode-decoding operation from byte
+  representation
+  into real Golang type. Can work strictly with real types thereby guaranteeing the data format.
+* **Transformation validation and easy maintainable**: Greenmask allows you check the transformation result during
+  obfuscation development providing validation warnings and transformation diff. That allows you to keep the
+  transformation
+  fresh in the whole software lifecycle
+* **Partitioned tables transformation inheritance**: Define the transformation config once and inherit it for all
+  partitions in partitioned tables
+* **Stateless**: it will not affect existing schema, it is just a logical dump
+* **Backward compatible** - support the same features and protocols as existing vanilla PostgreSQL utils. The dump made
+  by the Greenmask might be successfully restored by `pg_restore` util
+* **Extensible** - bring users the possibility to implement their own domain-based transformation in any language or use
+  templates
+* **Declarative** - define config in a structured easily parsed and recognizable format
+* **Integrable** - integrable with your CI/CD system
+* **Parallel execution** - perform parallel dumping and restoration that may significantly decrease the time to delivery
+* **Provide variety of storages** - provide storages for local and remote data storing such as Directory or S3-like
+
+## When to use?
+
+* Daily routines with dumping and restoring a logical backup. Such as table restoration after truncation. It works in
+  the
+  same way as pg_dump or pg_restore, and it might be used in the same ways without struggling
+* Anonymization/transformation/masking backup for staging environment and analytics purposes. It might be useful
+  for deploying a pre-production environment that contains consistent anonymized data. It allows for decreased
+  time to market in the development life-cycle.
+
+## Our purpose
+
+Greenmask util is going to be a core system within the Greenmask environment. We are trying to develop a comprehensive
+**UI-based** solution for managing obfuscation procedures. We understand that it is difficult to maintain an obfuscation
+state during the software lifecycle and Greenmask is trying to provide useful tools and features for keeping
+the obfuscation procedure fresh, predictable, and clear.
+
+## [Getting started](./getting_started.md)
+
+## Architecture
+
+### Common information
+
+It is quite clear that the right way to perform logical backup dumping and restoration is using the core PostgreSQL
+utils such as pg_dump and pg_restore. **Greenmask** was designed as compatible with PostgreSQL vanilla
+utils, it performs only data dumping features by itself and delegates schema dumping and restoration to pg_dump and
+pg_restore.
+
+### Backing up
+
+PostgreSQL backup is separated into three sections:
+
+* **pre-data** - raw tables schema itself excluding PK, FK
+* **data** - contains actual table data in COPY format, sequences current value setting up, and Large Objects data
+* **post-data** - contains the definition of indexes, triggers, rules, constraints (such as PK, FK)
+
+**Greenmask** operates in runtime only with _data_ section and delegates _pre-data_ and _post-data_ to pg_dump and
+pg_restore.
+
+**Greenmask** uses **directory** format of pg_dump/pg_restore.
+
+_Directory_ format is more suitable for parallel execution, and partial restoration, and it contains clear meta-data
+file that would be used for determining the backup and restoration steps. Greenmask significantly adapts them for
+working with remote storages and obfuscation procedures.
+
+_Greenmask_ performs the table data dumping using _COPY_ command in _TEXT_ format as well as _pg_dump_. It brings
+reliability and compatibility with vanilla utils.
+
+Greenmask supports parallel execution that significantly may decrease dumping time.
+
+## Storages
+
+PostgreSQL vanilla utils _pg_dump_ and _pg_restore_ operate with files in the directory without any alternatives.
+Understanding modern backup requirements and delivering approaches **Greenmask** introducing _Storages_:
+
+* **s3** - might be any S3-like storage, such as AWS S3
+* **directory** - ordinary filesystem directory
+
+Suggest any other storage that would be fine to implement.
+
+## Restoration
+
+Greenmask restores schema using pg_restore but applies COPY data by itself using COPY protocol. Due to supporting
+a variety of storages and awareness of the restoration metadata, **Greenmask** may download only required data. It might
+be useful in case of partial restoration, for instance restoring only one table from the whole backup.
+
+Greenmask supports parallel restoration that significantly may decrease restoration time.
+
+## Obfuscation and Validation
+
+**Greenmask** operates with COPY lines, gathers schema metadata for the Golang driver, and uses this driver for
+transformation in the encode-decoding procedure. The validate command allows you to check the schema affection (
+validation
+warnings) and data affection (performing transformation and showing diff)
+
+## Customization
+
+If your table schema has functional dependencies between columns it is possible to overcome this issue using
+`TeamplteRecord` transformer. It allows to define transformation logic for the whole table with type-safe operations
+when assigning new values.
+
+**Greenmask** implements a framework for defining your custom transformers that might be reused later. It integrates
+easily without recompiling - just PIPE (stdin/stdout) interaction.
+
+Since Greenmask was implemented fundamentally as an extensible solution it is possible to introduce other
+interaction protocols (HTTP, Socket, etc.) for performing obfuscation procedures.
+
+## PostgreSQL version compatibility
+
+**11 and higher**
+
+## Links
+
+* [Documentation](https://greenmask.io)
+* Email: **[email protected]**
+* [Twitter](https://twitter.com/GreenmaskIO)
+* [Telegram](https://t.me/greenmask_community)
+* [Discord](https://discord.gg/97AKHdGD)