-
Notifications
You must be signed in to change notification settings - Fork 8
/
SecretColumnSqlFilter.java
367 lines (323 loc) · 12 KB
/
SecretColumnSqlFilter.java
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
package jp.co.future.uroborosql.filter;
import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.nio.charset.UnsupportedCharsetException;
import java.security.KeyStore;
import java.security.KeyStore.SecretKeyEntry;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.util.ArrayList;
import java.util.Base64;
import java.util.List;
import javax.crypto.Cipher;
import javax.crypto.SecretKey;
import jp.co.future.uroborosql.context.SqlContext;
import jp.co.future.uroborosql.parameter.Parameter;
import jp.co.future.uroborosql.utils.CaseFormat;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* 特定のカラムの読み書きに対して暗号化/復号化を行うSQLフィルター.
*
* 登録、更新時はパラメータを暗号化 検索時は検索結果を復号化する
*
* @author H.Sugimoto
*
*/
public class SecretColumnSqlFilter extends AbstractSqlFilter {
private static final Logger LOG = LoggerFactory.getLogger(SecretColumnSqlFilter.class);
/** 暗号キー */
private SecretKey secretKey = null;
/** 暗号器 */
private Cipher encryptCipher = null;
/** 秘密鍵を格納したKeyStoreファイルのパス. KeyStoreはJCEKSタイプであること。 */
private String keyStoreFilePath = null;
/** KeyStoreにアクセスするためのストアパスワード. Base64エンコードした値を指定する */
private String storePassword = null;
/** KeyStore内で秘密鍵が格納されている場所を示すエイリアス名 */
private String alias = null;
/** キャラクタセット(デフォルトUTF-8) */
private Charset charset = StandardCharsets.UTF_8;
/** 暗号化、復号化を行うカラム名のリスト. カラム名はスネークケース(大文字)で指定する */
private List<String> cryptColumnNames = null;
/** 暗号化、復号化を行うパラメータ名リスト. キャメルケースで保存される */
private List<String> cryptParamKeys = null;
private boolean skipFilter = false;
/**
* 変換の名前 (たとえば、DES/CBC/PKCS5Padding)。標準の変換名については、Java 暗号化アーキテクチャー標準アルゴリズム名のドキュメントの Cipher のセクションを参照。
* 初期値は<code>AES/ECB/PKCS5Padding</code>
*/
private String transformationType = "AES/ECB/PKCS5Padding";
/**
* {@inheritDoc}
*
* @see jp.co.future.uroborosql.filter.AbstractSqlFilter#initialize()
*/
@Override
public void initialize() {
if (getCryptColumnNames() == null || getCryptColumnNames().isEmpty()) {
setSkipFilter(true);
return;
} else {
cryptParamKeys = new ArrayList<>();
List<String> newColumnNames = new ArrayList<>();
for (String columnName : getCryptColumnNames()) {
cryptParamKeys.add(CaseFormat.CAMEL_CASE.convert(columnName));
newColumnNames.add(CaseFormat.UPPER_SNAKE_CASE.convert(columnName));
}
// 定義ファイルで指定されたカラム名は大文字でない可能性があるので、ここで大文字に置換し直す
cryptColumnNames = newColumnNames;
}
KeyStore store;
try {
if (StringUtils.isBlank(getKeyStoreFilePath())) {
LOG.error("Invalid KeyStore file path. Path:{}", getKeyStoreFilePath());
setSkipFilter(true);
return;
}
File storeFile = new File(getKeyStoreFilePath());
if (!storeFile.exists()) {
LOG.error("Not found KeyStore file path. Path:{}", getKeyStoreFilePath());
setSkipFilter(true);
return;
}
if (storeFile.isDirectory()) {
LOG.error("Invalid KeyStore file path. Path:{}", getKeyStoreFilePath());
setSkipFilter(true);
return;
}
if (StringUtils.isBlank(getStorePassword())) {
LOG.error("Invalid password for access KeyStore.");
setSkipFilter(true);
return;
}
if (StringUtils.isBlank(getAlias())) {
LOG.error("KeyStoreにアクセスするためのエイリアスが指定されていません。");
LOG.error("No alias for access KeyStore.");
setSkipFilter(true);
return;
}
store = KeyStore.getInstance("JCEKS");
char[] pass;
try (InputStream is = new BufferedInputStream(new FileInputStream(storeFile))) {
pass = new String(Base64.getUrlDecoder().decode(getStorePassword())).toCharArray();
store.load(is, pass);
}
KeyStore.SecretKeyEntry entry = (SecretKeyEntry) store.getEntry(getAlias(),
new KeyStore.PasswordProtection(pass));
secretKey = entry.getSecretKey();
encryptCipher = Cipher.getInstance(transformationType);
encryptCipher.init(Cipher.ENCRYPT_MODE, secretKey);
} catch (Exception ex) {
LOG.error("Failed to acquire secret key. Cause:{}", ex.getMessage());
setSkipFilter(true);
ex.printStackTrace();
}
}
/**
* {@inheritDoc}
*
* パラメータが暗号化対象のパラメータ名と一致する場合、パラメータの値を暗号化する
*
* @see jp.co.future.uroborosql.filter.AbstractSqlFilter#doParameter(jp.co.future.uroborosql.parameter.Parameter)
*/
@Override
public Parameter doParameter(final Parameter parameter) {
if (skipFilter || parameter == null) {
return parameter;
}
if (Parameter.class.equals(parameter.getClass())) {
// 通常のパラメータの場合
String key = parameter.getParameterName();
if (getCryptParamKeys().contains(CaseFormat.CAMEL_CASE.convert(key))) {
Object obj = parameter.getValue();
if (obj != null && obj instanceof String) {
String objStr = obj.toString();
if (StringUtils.isNotEmpty(objStr)) {
try {
synchronized (encryptCipher) {
byte[] crypted = encryptCipher.doFinal(StringUtils.defaultString(objStr).getBytes(
getCharset()));
return new Parameter(key, Base64.getUrlEncoder().withoutPadding().encodeToString(crypted));
}
} catch (Exception ex) {
return parameter;
}
}
}
}
}
return parameter;
}
/**
* {@inheritDoc}
*
* 検索結果に暗号化対象カラムが含まれる場合、値の取得時に復号化されるようResultSetを{@link SecretResultSet}でラップして返す
*
* @see jp.co.future.uroborosql.filter.AbstractSqlFilter#doQuery(jp.co.future.uroborosql.context.SqlContext, java.sql.PreparedStatement, java.sql.ResultSet)
*/
@Override
public ResultSet doQuery(final SqlContext sqlContext, final PreparedStatement preparedStatement,
final ResultSet resultSet) {
if (skipFilter) {
return resultSet;
}
try {
Cipher cipher = Cipher.getInstance(transformationType);
cipher.init(Cipher.DECRYPT_MODE, secretKey);
return new SecretResultSet(resultSet, cipher, getCryptColumnNames(), getCharset());
} catch (Exception ex) {
ex.printStackTrace();
}
return resultSet;
}
/**
* 秘密鍵を格納したKeyStoreファイルのパス. KeyStoreはJCEKSタイプであること。を取得します。
*
* @return 秘密鍵を格納したKeyStoreファイルのパス. KeyStoreはJCEKSタイプであること。
*/
public String getKeyStoreFilePath() {
return keyStoreFilePath;
}
/**
* 秘密鍵を格納したKeyStoreファイルのパス. KeyStoreはJCEKSタイプであること。を設定します。
*
* @param keyStoreFilePath
* 秘密鍵を格納したKeyStoreファイルのパス. KeyStoreはJCEKSタイプであること。
*/
public void setKeyStoreFilePath(final String keyStoreFilePath) {
this.keyStoreFilePath = keyStoreFilePath;
}
/**
* KeyStoreにアクセスするためのストアパスワード. Base64エンコードした値を指定するを取得します。
*
* @return KeyStoreにアクセスするためのストアパスワード. Base64エンコードした値を指定する
*/
public String getStorePassword() {
return storePassword;
}
/**
* KeyStoreにアクセスするためのストアパスワード. Base64エンコードした値を指定するを設定します。
*
* @param storePassword
* KeyStoreにアクセスするためのストアパスワード. Base64エンコードした値を指定する
*/
public void setStorePassword(final String storePassword) {
this.storePassword = storePassword;
}
/**
* KeyStore内で秘密鍵が格納されている場所を示すエイリアス名を取得します。
*
* @return KeyStore内で秘密鍵が格納されている場所を示すエイリアス名
*/
public String getAlias() {
return alias;
}
/**
* KeyStore内で秘密鍵が格納されている場所を示すエイリアス名を設定します。
*
* @param alias
* KeyStore内で秘密鍵が格納されている場所を示すエイリアス名
*/
public void setAlias(final String alias) {
this.alias = alias;
}
/**
* キャラクタセット(デフォルトUTF-8)を取得します。
*
* @return キャラクタセット(デフォルトUTF-8)
*/
public Charset getCharset() {
return charset;
}
/**
* キャラクタセット(デフォルトUTF-8)を設定します。
*
* @param charset キャラクタセット(デフォルトUTF-8)
*/
public void setCharset(final String charset) {
try {
this.charset = Charset.forName(charset);
} catch (UnsupportedCharsetException ex) {
this.charset = StandardCharsets.UTF_8;
LOG.error("The specified character set could not be converted to {}. Set the default character set({}).",
charset, this.charset);
}
}
/**
* 暗号化、復号化を行うカラム名のリスト. カラム名はスネークケース(大文字)で指定するを取得します。
*
* @return 暗号化、復号化を行うカラム名のリスト. カラム名はスネークケース(大文字)で指定する
*/
public List<String> getCryptColumnNames() {
return cryptColumnNames;
}
/**
* 暗号化、復号化を行うカラム名のリスト. カラム名はスネークケース(大文字)で指定するを設定します。
*
* @param cryptColumnNames
* 暗号化、復号化を行うカラム名のリスト. カラム名はスネークケース(大文字)で指定する
*/
public void setCryptColumnNames(final List<String> cryptColumnNames) {
this.cryptColumnNames = cryptColumnNames;
}
/**
* 暗号化、復号化を行うパラメータ名リスト. キャメルケースで保存されるを取得します。
*
* @return 暗号化、復号化を行うパラメータ名リスト. キャメルケースで保存される
*/
public List<String> getCryptParamKeys() {
return cryptParamKeys;
}
/**
* 暗号化、復号化を行うパラメータ名リスト. キャメルケースで保存されるを設定します。
*
* @param cryptParamKeys
* 暗号化、復号化を行うパラメータ名リスト. キャメルケースで保存される
*/
public void setCryptParamKeys(final List<String> cryptParamKeys) {
this.cryptParamKeys = cryptParamKeys;
}
/**
* skipFilterを取得します。
*
* @return skipFilter
*/
public boolean isSkipFilter() {
return skipFilter;
}
/**
* skipFilterを設定します。
*
* @param skipFilter
* skipFilter
*/
public void setSkipFilter(final boolean skipFilter) {
this.skipFilter = skipFilter;
}
/**
* 変換の名前を取得する
* 標準の変換名については、Java 暗号化アーキテクチャー標準アルゴリズム名のドキュメントの Cipher のセクションを参照。
* 初期値は<code>AES/ECB/PKCS5Padding</code>
*
* @return 変換の名前
*/
public String getTransformationType() {
return transformationType;
}
/**
* 変換の名前を設定する
* 標準の変換名については、Java 暗号化アーキテクチャー標準アルゴリズム名のドキュメントの Cipher のセクションを参照。
* 初期値は<code>AES/ECB/PKCS5Padding</code>
*
* @param transformationType 変換の名前
*/
public void setTransformationType(final String transformationType) {
this.transformationType = transformationType;
}
}