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
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.security.tool.crypto;
import com.yahoo.security.SealedSharedKey;
import com.yahoo.security.SharedKeyGenerator;
import com.yahoo.vespa.security.tool.CliUtils;
import com.yahoo.vespa.security.tool.Tool;
import com.yahoo.vespa.security.tool.ToolDescription;
import com.yahoo.vespa.security.tool.ToolInvocation;
import org.apache.commons.cli.Option;
import java.io.IOException;
import java.util.List;
import java.util.Optional;
import static com.yahoo.vespa.security.tool.crypto.ToolUtils.PRIVATE_KEY_DIR_OPTION;
import static com.yahoo.vespa.security.tool.crypto.ToolUtils.PRIVATE_KEY_FILE_OPTION;
/**
* Tooling for decrypting a file using a private key that corresponds to the public key used
* to originally encrypt the file.
*
* Uses the opaque token abstraction from {@link SharedKeyGenerator}.
*
* @author vekterli
*/
public class DecryptTool implements Tool {
static final String OUTPUT_FILE_OPTION = "output-file";
static final String EXPECTED_KEY_ID_OPTION = "expected-key-id";
static final String TOKEN_OPTION = "token";
private static final List<Option> OPTIONS = List.of(
Option.builder("o")
.longOpt(OUTPUT_FILE_OPTION)
.hasArg(true)
.required(false)
.desc("Output file for decrypted plaintext. Specify '-' (without the " +
"quotes) to write plaintext to STDOUT instead of a file.")
.build(),
Option.builder("k")
.longOpt(PRIVATE_KEY_FILE_OPTION)
.hasArg(true)
.required(false)
.desc("Private key file in Base58 encoded format")
.build(),
Option.builder("d")
.longOpt(PRIVATE_KEY_DIR_OPTION)
.hasArg(true)
.required(false)
.desc("Private key file directory used for automatically looking up " +
"private keys based on the key ID specified as part of a token.")
.build(),
Option.builder("e")
.longOpt(EXPECTED_KEY_ID_OPTION)
.hasArg(true)
.required(false)
.desc("Expected key ID in token. If this is not provided, the key ID is not verified.")
.build(),
Option.builder("t")
.longOpt(TOKEN_OPTION)
.hasArg(true)
.required(false)
.desc("Token generated when the input file was encrypted")
.build());
@Override
public String name() {
return "decrypt";
}
@Override
public ToolDescription description() {
return new ToolDescription(
"<encrypted file> <options>",
"Decrypts a file using a provided token and a secret private key. The file must " +
"previously have been encrypted using the public key component of the given private key.\n\n" +
"To decrypt the contents of STDIN, specify an input file of '-' (without the quotes).",
"Note: this is a BETA tool version; its interface may be changed at any time",
OPTIONS);
}
@Override
public int invoke(ToolInvocation invocation) {
try {
var arguments = invocation.arguments();
var leftoverArgs = arguments.getArgs();
if (leftoverArgs.length != 1) {
throw new IllegalArgumentException("Expected exactly 1 file argument to decrypt");
}
var inputArg = leftoverArgs[0];
var maybeKeyId = Optional.ofNullable(arguments.getOptionValue(EXPECTED_KEY_ID_OPTION));
var outputArg = CliUtils.optionOrThrow(arguments, OUTPUT_FILE_OPTION);
var tokenString = CliUtils.optionOrThrow(arguments, TOKEN_OPTION);
var sealedSharedKey = SealedSharedKey.fromTokenString(tokenString.strip());
ToolUtils.verifyExpectedKeyId(sealedSharedKey, maybeKeyId);
var privateKey = ToolUtils.resolvePrivateKeyFromInvocation(invocation, sealedSharedKey.keyId());
var secretShared = SharedKeyGenerator.fromSealedKey(sealedSharedKey, privateKey);
var cipher = SharedKeyGenerator.makeAesGcmDecryptionCipher(secretShared);
try (var inStream = CliUtils.inputStreamFromFileOrStream(inputArg, invocation.stdIn());
var outStream = CliUtils.outputStreamToFileOrStream(outputArg, invocation.stdOut())) {
CipherUtils.streamEncipher(inStream, outStream, cipher);
}
} catch (IOException e) {
throw new RuntimeException(e);
}
return 0;
}
}
|