xref: /aosp_15_r20/external/tink/java_src/examples/hybrid/HybridExample.java (revision e7b1675dde1b92d52ec075b0a92829627f2c52a5)
1*e7b1675dSTing-Kang Chang /**
2*e7b1675dSTing-Kang Chang  * Copyright 2021 Google LLC
3*e7b1675dSTing-Kang Chang  *
4*e7b1675dSTing-Kang Chang  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
5*e7b1675dSTing-Kang Chang  * in compliance with the License. You may obtain a copy of the License at
6*e7b1675dSTing-Kang Chang  *
7*e7b1675dSTing-Kang Chang  * http://www.apache.org/licenses/LICENSE-2.0
8*e7b1675dSTing-Kang Chang  *
9*e7b1675dSTing-Kang Chang  * Unless required by applicable law or agreed to in writing, software distributed under the License
10*e7b1675dSTing-Kang Chang  * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
11*e7b1675dSTing-Kang Chang  * or implied. See the License for the specific language governing permissions and limitations under
12*e7b1675dSTing-Kang Chang  * the License.
13*e7b1675dSTing-Kang Chang  */
14*e7b1675dSTing-Kang Chang // [START hybrid-example]
15*e7b1675dSTing-Kang Chang package hybrid;
16*e7b1675dSTing-Kang Chang 
17*e7b1675dSTing-Kang Chang import static java.nio.charset.StandardCharsets.UTF_8;
18*e7b1675dSTing-Kang Chang 
19*e7b1675dSTing-Kang Chang import com.google.crypto.tink.HybridDecrypt;
20*e7b1675dSTing-Kang Chang import com.google.crypto.tink.HybridEncrypt;
21*e7b1675dSTing-Kang Chang import com.google.crypto.tink.InsecureSecretKeyAccess;
22*e7b1675dSTing-Kang Chang import com.google.crypto.tink.KeysetHandle;
23*e7b1675dSTing-Kang Chang import com.google.crypto.tink.TinkJsonProtoKeysetFormat;
24*e7b1675dSTing-Kang Chang import com.google.crypto.tink.hybrid.HybridConfig;
25*e7b1675dSTing-Kang Chang import java.nio.file.Files;
26*e7b1675dSTing-Kang Chang import java.nio.file.Path;
27*e7b1675dSTing-Kang Chang import java.nio.file.Paths;
28*e7b1675dSTing-Kang Chang 
29*e7b1675dSTing-Kang Chang /**
30*e7b1675dSTing-Kang Chang  * A command-line utility for hybrid encryption.
31*e7b1675dSTing-Kang Chang  *
32*e7b1675dSTing-Kang Chang  * <p>It loads cleartext keys from disk - this is not recommended!
33*e7b1675dSTing-Kang Chang  *
34*e7b1675dSTing-Kang Chang  * <p>It requires the following arguments:
35*e7b1675dSTing-Kang Chang  *
36*e7b1675dSTing-Kang Chang  * <ul>
37*e7b1675dSTing-Kang Chang  *   <li>mode: either 'encrypt' or 'decrypt'.
38*e7b1675dSTing-Kang Chang  *   <li>key-file: Read the key material from this file.
39*e7b1675dSTing-Kang Chang  *   <li>input-file: Read the input from this file.
40*e7b1675dSTing-Kang Chang  *   <li>output-file: Write the result to this file.
41*e7b1675dSTing-Kang Chang  *   <li>[optional] contex-info: Bind the encryption to this context info.
42*e7b1675dSTing-Kang Chang  */
43*e7b1675dSTing-Kang Chang public final class HybridExample {
main(String[] args)44*e7b1675dSTing-Kang Chang   public static void main(String[] args) throws Exception {
45*e7b1675dSTing-Kang Chang     if (args.length != 4 && args.length != 5) {
46*e7b1675dSTing-Kang Chang       System.err.printf("Expected 4 or 5 parameters, got %d\n", args.length);
47*e7b1675dSTing-Kang Chang       System.err.println(
48*e7b1675dSTing-Kang Chang           "Usage: java HybridExample encrypt/decrypt key-file input-file output-file context-info");
49*e7b1675dSTing-Kang Chang       System.exit(1);
50*e7b1675dSTing-Kang Chang     }
51*e7b1675dSTing-Kang Chang 
52*e7b1675dSTing-Kang Chang     String mode = args[0];
53*e7b1675dSTing-Kang Chang     if (!mode.equals("encrypt") && !mode.equals("decrypt")) {
54*e7b1675dSTing-Kang Chang       System.err.println("Incorrect mode. Please select encrypt or decrypt.");
55*e7b1675dSTing-Kang Chang       System.exit(1);
56*e7b1675dSTing-Kang Chang     }
57*e7b1675dSTing-Kang Chang     Path keyFile = Paths.get(args[1]);
58*e7b1675dSTing-Kang Chang     Path inputFile = Paths.get(args[2]);
59*e7b1675dSTing-Kang Chang     byte[] input = Files.readAllBytes(inputFile);
60*e7b1675dSTing-Kang Chang     Path outputFile = Paths.get(args[3]);
61*e7b1675dSTing-Kang Chang     byte[] contextInfo = new byte[0];
62*e7b1675dSTing-Kang Chang     if (args.length == 5) {
63*e7b1675dSTing-Kang Chang       contextInfo = args[4].getBytes(UTF_8);
64*e7b1675dSTing-Kang Chang     }
65*e7b1675dSTing-Kang Chang 
66*e7b1675dSTing-Kang Chang     // Register all hybrid encryption key types with the Tink runtime.
67*e7b1675dSTing-Kang Chang     HybridConfig.register();
68*e7b1675dSTing-Kang Chang 
69*e7b1675dSTing-Kang Chang     // Read the keyset into a KeysetHandle.
70*e7b1675dSTing-Kang Chang     KeysetHandle handle =
71*e7b1675dSTing-Kang Chang         TinkJsonProtoKeysetFormat.parseKeyset(
72*e7b1675dSTing-Kang Chang             new String(Files.readAllBytes(keyFile), UTF_8), InsecureSecretKeyAccess.get());
73*e7b1675dSTing-Kang Chang 
74*e7b1675dSTing-Kang Chang     if (mode.equals("encrypt")) {
75*e7b1675dSTing-Kang Chang       // Get the primitive.
76*e7b1675dSTing-Kang Chang       HybridEncrypt encryptor = handle.getPrimitive(HybridEncrypt.class);
77*e7b1675dSTing-Kang Chang 
78*e7b1675dSTing-Kang Chang       // Use the primitive to encrypt data.
79*e7b1675dSTing-Kang Chang       byte[] ciphertext = encryptor.encrypt(input, contextInfo);
80*e7b1675dSTing-Kang Chang       Files.write(outputFile, ciphertext);
81*e7b1675dSTing-Kang Chang     } else {
82*e7b1675dSTing-Kang Chang       HybridDecrypt decryptor = handle.getPrimitive(HybridDecrypt.class);
83*e7b1675dSTing-Kang Chang 
84*e7b1675dSTing-Kang Chang       // Use the primitive to decrypt data.
85*e7b1675dSTing-Kang Chang       byte[] plaintext = decryptor.decrypt(input, contextInfo);
86*e7b1675dSTing-Kang Chang       Files.write(outputFile, plaintext);
87*e7b1675dSTing-Kang Chang     }
88*e7b1675dSTing-Kang Chang   }
89*e7b1675dSTing-Kang Chang 
HybridExample()90*e7b1675dSTing-Kang Chang   private HybridExample() {}
91*e7b1675dSTing-Kang Chang }
92*e7b1675dSTing-Kang Chang // [END hybrid-example]
93