Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor Mapper and MapFunc #17

Merged
merged 4 commits into from
Feb 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 6 additions & 15 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

<groupId>no.ssb.dapla.dlp.pseudo.func</groupId>
<artifactId>dapla-dlp-pseudo-func</artifactId>
<version>1.2.9-SNAPSHOT</version>
<version>1.3.0-SNAPSHOT</version>
<name>dapla-dlp-pseudo-func</name>

<properties>
Expand Down Expand Up @@ -186,29 +186,20 @@

<repositories>
<repository>
<id>artifact-registry</id>
<url>${artifact-registry.url}</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
<id>central</id>
<url>https://repo.maven.apache.org/maven2</url>
</repository>
<repository>
<id>artifact-registry-snapshot</id>
<id>artifact-registry</id>
<url>${artifact-registry.url}</url>
<releases>
<enabled>false</enabled>
<enabled>true</enabled>
<updatePolicy>always</updatePolicy>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
<repository>
<id>central</id>
<url>https://repo.maven.apache.org/maven2</url>
</repository>
</repositories>

<profiles>
Expand Down
3 changes: 3 additions & 0 deletions src/main/java/no/ssb/dapla/dlp/pseudo/func/PseudoFunc.java
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ public interface PseudoFunc {
/** Name of the function declaration (including any parameters), e.g. foo(param1,param2) */
String getFuncDecl();

/** Name of the encryption algorithm, e.g. TINK_FPE, TINK-DAEAD */
String getAlgorithm();

/**
* Preprocessing of input. This will be called before apply
*/
Expand Down
15 changes: 12 additions & 3 deletions src/main/java/no/ssb/dapla/dlp/pseudo/func/PseudoFuncOutput.java
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,18 @@
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

@Value
@NoArgsConstructor
public class PseudoFuncOutput {
private List<Object> values = new ArrayList<>();
private List<String> warnings = new ArrayList<>();
List<Object> values = new ArrayList<>();
List<String> warnings = new ArrayList<>();
Map<String, String> metadata = new HashMap<>();


public PseudoFuncOutput(Object v) {
if (v instanceof Collection) {
Expand All @@ -39,14 +43,18 @@ public void addWarning(String warning) {
warnings.add(warning);
}

public void addMetadata(String key, String value) {
metadata.put(key, value);
}

public List<String> getStringValues() {
return values.stream()
.map(String::valueOf)
.collect(Collectors.toList());
}

public Object getFirstValue() {
return getValues().get(0);
return getValues().getFirst();
}

@Override
Expand All @@ -57,4 +65,5 @@ public String toString() {
public boolean hasWarnings() {
return ! warnings.isEmpty();
}

}
7 changes: 7 additions & 0 deletions src/main/java/no/ssb/dapla/dlp/pseudo/func/fpe/FpeFunc.java
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,17 @@ public class FpeFunc extends AbstractPseudoFunc {
private final FormatPreservingEncryption fpe;
private final FpeConfigService fpeConfigService = new FpeConfigService();

private static final String ALGORITHM = "FPE";

// We should consider implementing a more sophisticated tweak, see:
// https://crypto.stackexchange.com/questions/10903/what-are-the-uses-of-tweaks-in-block-ciphers
private static final byte[] STATIC_TWEAK = new byte[0];

@Override
public String getAlgorithm() {
return ALGORITHM;
}

public FpeFunc(PseudoFuncConfig genericConfig) {
super(genericConfig.getFuncDecl());
config = fpeConfigService.resolve(genericConfig);
Expand Down
32 changes: 8 additions & 24 deletions src/main/java/no/ssb/dapla/dlp/pseudo/func/map/MapFunc.java
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,15 @@

@Slf4j
public class MapFunc extends AbstractPseudoFunc {
private final MapFuncConfig config;
private final MapFuncConfigService mapFuncConfigService = new MapFuncConfigService();
private final Mapper mapper;

@Override
public String getAlgorithm() {
return null;
}

public MapFunc(PseudoFuncConfig genericConfig) {
super(genericConfig.getFuncDecl());
this.config = mapFuncConfigService.resolve(genericConfig);
this.mapper = loadMapper();
this.mapper.setConfig(genericConfig.asMap());
}
Expand All @@ -31,35 +33,17 @@ public static Mapper loadMapper() {

@Override
public void init(PseudoFuncInput input) {
for (Object inputValue : input.getValues()) {
mapper.init(String.valueOf(inputValue));
}
mapper.init(input);
}

@Override
public PseudoFuncOutput apply(PseudoFuncInput input) {
PseudoFuncOutput output = new PseudoFuncOutput();

for (Object inputValue : input.getValues()) {
String plain = String.valueOf(inputValue);
final Object pseudonymized = mapper.map(plain);
output.add(pseudonymized);
}

return output;
return mapper.map(input);
}

@Override
public PseudoFuncOutput restore(PseudoFuncInput input) {
PseudoFuncOutput output = new PseudoFuncOutput();

for (Object inputValue : input.getValues()) {
String mapped = String.valueOf(inputValue);
final Object clear = mapper.restore(mapped);
output.add(clear);
}

return output;
return mapper.restore(input);
}

}
9 changes: 6 additions & 3 deletions src/main/java/no/ssb/dapla/dlp/pseudo/func/map/Mapper.java
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
package no.ssb.dapla.dlp.pseudo.func.map;

import no.ssb.dapla.dlp.pseudo.func.PseudoFuncInput;
import no.ssb.dapla.dlp.pseudo.func.PseudoFuncOutput;

import java.util.Map;

public interface Mapper {

void init(Object data);
void init(PseudoFuncInput data);
void setConfig(Map<String, Object> config);
Object map(Object data);
PseudoFuncOutput map(PseudoFuncInput data);

Object restore(Object mapped);
PseudoFuncOutput restore(PseudoFuncInput mapped);

}
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ public class RedactFunc extends AbstractPseudoFunc {
private final RedactFuncConfigService configService = new RedactFuncConfigService();
private final RedactFuncConfig config;

// A.k.a Free Text Redaction
private static final String ALGORITHM = "REDACT";

@Override
public String getAlgorithm() {
return ALGORITHM;
}

public RedactFunc(@NonNull PseudoFuncConfig genericConfig) {
super(genericConfig.getFuncDecl());
this.config = configService.resolve(genericConfig);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,13 @@ public class TinkDaeadFunc extends AbstractPseudoFunc {
private final TinkDaeadFuncConfigService configService = new TinkDaeadFuncConfigService();
private final TinkDaeadFuncConfig config;

private static final String ALGORITHM = "TINK-DAEAD";

@Override
public String getAlgorithm() {
return ALGORITHM;
}

public TinkDaeadFunc(@NonNull PseudoFuncConfig genericConfig) {
super(genericConfig.getFuncDecl());
this.config = configService.resolve(genericConfig);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ public class TinkFpeFunc extends AbstractPseudoFunc {
private final TinkFpeFuncConfigService configService = new TinkFpeFuncConfigService();
private final TinkFpeFuncConfig config;

private static final String ALGORITHM = "TINK-FPE";
@Override
public String getAlgorithm() {
return ALGORITHM;
}

public TinkFpeFunc(@NonNull PseudoFuncConfig genericConfig) {
super(genericConfig.getFuncDecl());
this.config = configService.resolve(genericConfig);
Expand Down
Loading