/
masking.go
184 lines (156 loc) · 4.7 KB
/
masking.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
// Copyright 2023 Greenmask
//
// 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.
package transformers
import (
"context"
"fmt"
"slices"
"strings"
"github.com/ggwhite/go-masker"
"github.com/greenmaskio/greenmask/internal/db/postgres/transformers/utils"
"github.com/greenmaskio/greenmask/pkg/toolkit"
)
const (
MPassword string = "password"
MName string = "name"
MAddress string = "addr"
MEmail string = "email"
MMobile string = "mobile"
MTelephone string = "tel"
MID string = "id"
MCreditCard string = "credit_card"
MURL string = "url"
MDefault string = "default"
)
var MaskingTransformerDefinition = utils.NewDefinition(
utils.NewTransformerProperties(
"Masking",
"Mask a value using one of masking type",
),
NewMaskingTransformer,
toolkit.MustNewParameter(
"column",
"column name",
).SetIsColumn(
toolkit.NewColumnProperties().
SetAffected(true).
SetAllowedColumnTypes("text", "varchar"),
).SetRequired(true),
toolkit.MustNewParameter(
"type",
"logical type of attribute (default, password, name, addr, email, mobile, tel, id, credit_card, url)",
).SetRawValueValidator(maskerTypeValidator).
SetDefaultValue(toolkit.ParamsValue(MDefault)),
)
type maskingFunction func(val string) string
type MaskingTransformer struct {
columnName string
columnIdx int
masker *masker.Masker
maskingFunction maskingFunction
affectedColumns map[int]string
}
func NewMaskingTransformer(ctx context.Context, driver *toolkit.Driver, parameters map[string]*toolkit.Parameter) (utils.Transformer, toolkit.ValidationWarnings, error) {
var columnName string
var dataType string
var mf maskingFunction
p := parameters["column"]
if _, err := p.Scan(&columnName); err != nil {
return nil, nil, fmt.Errorf("unable to scan column param: %w", err)
}
idx, _, ok := driver.GetColumnByName(columnName)
if !ok {
return nil, nil, fmt.Errorf("column with name %s is not found", columnName)
}
affectedColumns := make(map[int]string)
affectedColumns[idx] = columnName
p = parameters["type"]
if _, err := p.Scan(&dataType); err != nil {
return nil, nil, fmt.Errorf("unable to scan type param: %w", err)
}
var m = &masker.Masker{}
switch dataType {
case MPassword:
mf = m.Password
case MName:
mf = m.Name
case MAddress:
mf = m.Address
case MEmail:
mf = m.Email
case MMobile:
mf = m.Mobile
case MID:
mf = m.ID
case MTelephone:
mf = m.Telephone
case MCreditCard:
mf = m.CreditCard
case MURL:
mf = m.URL
case MDefault:
mf = defaultMasker
default:
return nil, nil, fmt.Errorf("wrong type: %s", dataType)
}
return &MaskingTransformer{
columnName: columnName,
masker: m,
maskingFunction: mf,
affectedColumns: affectedColumns,
columnIdx: idx,
}, nil, nil
}
func (mt *MaskingTransformer) GetAffectedColumns() map[int]string {
return mt.affectedColumns
}
func (mt *MaskingTransformer) Init(ctx context.Context) error {
return nil
}
func (mt *MaskingTransformer) Done(ctx context.Context) error {
return nil
}
func (mt *MaskingTransformer) Transform(ctx context.Context, r *toolkit.Record) (*toolkit.Record, error) {
val, err := r.GetRawColumnValueByIdx(mt.columnIdx)
if err != nil {
return nil, fmt.Errorf("unable to scan attribute value: %w", err)
}
if val.IsNull {
return r, nil
}
maskedValue := mt.maskingFunction(string(val.Data))
err = r.SetRawColumnValueByIdx(mt.columnIdx, toolkit.NewRawValue([]byte(maskedValue), false))
if err != nil {
return nil, fmt.Errorf("unable to set new value: %w", err)
}
return r, nil
}
func defaultMasker(v string) string {
return strings.Repeat("*", len(v))
}
func maskerTypeValidator(p *toolkit.Parameter, v toolkit.ParamsValue) (toolkit.ValidationWarnings, error) {
typeName := string(v)
types := []string{MDefault, MPassword, MName, MAddress, MEmail, MMobile, MTelephone, MID, MCreditCard, MURL}
if !slices.Contains(types, typeName) {
return toolkit.ValidationWarnings{
toolkit.NewValidationWarning().
SetSeverity(toolkit.ErrorValidationSeverity).
SetMsgf("unknown type %s: must be one of %s", typeName, strings.Join(types, ", ")),
}, nil
}
return nil, nil
}
func init() {
utils.DefaultTransformerRegistry.MustRegister(MaskingTransformerDefinition)
}