summaryrefslogtreecommitdiffstats
path: root/base/java-tools/src/com/netscape/cmstools/key/KeyRetrieveCLI.java
blob: 92389c021ea060f3c69f8aa69fe962dd9dbbb44f (plain)
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
package com.netscape.cmstools.key;

import java.io.File;
import java.io.FileInputStream;
import java.util.Arrays;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.Marshaller;
import javax.xml.bind.Unmarshaller;

import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.Option;
import org.apache.commons.cli.ParseException;

import com.netscape.certsrv.dbs.keydb.KeyId;
import com.netscape.certsrv.key.Key;
import com.netscape.certsrv.key.KeyRecoveryRequest;
import com.netscape.cmstools.cli.CLI;
import com.netscape.cmstools.cli.MainCLI;
import com.netscape.cmsutil.util.Utils;

public class KeyRetrieveCLI extends CLI {
    public KeyCLI keyCLI;
    private boolean clientEncryption = true;

    public KeyRetrieveCLI(KeyCLI keyCLI) {
        super("retrieve", "Retrieve key", keyCLI);
        this.keyCLI = keyCLI;

        createOptions();
    }

    public void printHelp() {
        formatter.printHelp(getFullName() + " [OPTIONS...]", options);
    }

    public void createOptions() {
        Option option = new Option(null, "keyID", true, "Key Identifier for the secret to be recovered.");
        option.setArgName("Key Identifier");
        options.addOption(option);

        option = new Option(null, "passphrase", true, "Passphrase to encrypt the key information.");
        option.setArgName("Passphrase");
        options.addOption(option);

        option = new Option(null, "input", true, "Location of the request template file.");
        option.setArgName("Input file path");
        options.addOption(option);

        option = new Option(null, "output", true, "Location to store the retrieved key information");
        option.setArgName("File path to store key information");
        options.addOption(option);
    }

    public void execute(String[] args) throws Exception {
        // Always check for "--help" prior to parsing
        if (Arrays.asList(args).contains("--help")) {
            // Display usage
            printHelp();
            System.exit(0);
        }

        CommandLine cmd = null;

        try {
            cmd = parser.parse(options, args);

        } catch (ParseException e) {
            System.err.println("Error: " + e.getMessage());
            printHelp();
            System.exit(-1);
        }

        String[] cmdArgs = cmd.getArgs();

        if (cmdArgs.length != 0) {
            System.err.println("Error: Too many arguments specified.");
            printHelp();
            System.exit(-1);
        }

        if (cmd.getOptions().length == 0) {
            System.err.println("Error: Incorrect number of parameters provided.");
            printHelp();
            System.exit(-1);
        }

        String requestFile = cmd.getOptionValue("input");

        Key keyData = null;

        if (requestFile != null) {
            JAXBContext context = JAXBContext.newInstance(KeyRecoveryRequest.class);
            Unmarshaller unmarshaller = context.createUnmarshaller();
            FileInputStream fis = new FileInputStream(requestFile);
            KeyRecoveryRequest req = (KeyRecoveryRequest) unmarshaller.unmarshal(fis);

            if (req.getKeyId() == null) {
                System.err.println("Error: Key ID must be specified in the request file.");
                System.exit(-1);
            }

            if (req.getCertificate() != null) {
                keyData = keyCLI.keyClient.retrieveKeyByPKCS12(req.getKeyId(), req.getCertificate(),
                        req.getPassphrase());

            } else if (req.getPassphrase() != null) {
                keyData = keyCLI.keyClient.retrieveKeyByPassphrase(req.getKeyId(), req.getPassphrase());

            } else if (req.getSessionWrappedPassphrase() != null) {
                keyData = keyCLI.keyClient.retrieveKeyUsingWrappedPassphrase(req.getKeyId(),
                        Utils.base64decode(req.getTransWrappedSessionKey()),
                        Utils.base64decode(req.getSessionWrappedPassphrase()),
                        Utils.base64decode(req.getNonceData()));

            } else if (req.getTransWrappedSessionKey() != null) {
                keyData = keyCLI.keyClient.retrieveKey(req.getKeyId(),
                        Utils.base64decode(req.getTransWrappedSessionKey()));

            } else {
                keyData = keyCLI.keyClient.retrieveKey(req.getKeyId());
            }

        } else {
            // Using command line options.
            String keyId = cmd.getOptionValue("keyID");
            String passphrase = cmd.getOptionValue("passphrase");

            if (passphrase != null) {
                keyData = keyCLI.keyClient.retrieveKeyByPassphrase(new KeyId(keyId), passphrase);

            } else {
                keyData = keyCLI.keyClient.retrieveKey(new KeyId(keyId));
                clientEncryption = false;

                // No need to return the encrypted data since encryption
                // is done locally.
                keyData.setEncryptedData(null);
            }
        }

        String outputFilePath = cmd.getOptionValue("output");
        if (outputFilePath != null) {
            JAXBContext context = JAXBContext.newInstance(Key.class);
            Marshaller marshaller = context.createMarshaller();
            marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
            marshaller.marshal(keyData, new File(outputFilePath));

        } else {
            MainCLI.printMessage("Retrieve Key Information");
            printKeyData(keyData);
        }
    }

    public void printKeyData(Key key) {
        System.out.println("  Key Algorithm: " + key.getAlgorithm());
        System.out.println("  Key Size: " + key.getSize());
        System.out.println("  Nonce data: " + Utils.base64encode(key.getNonceData()));

        if (clientEncryption) {
            System.out.println("  Encrypted Data:" + Utils.base64encode(key.getEncryptedData()));

        } else {
            System.out.println("  Actual archived data: " + Utils.base64encode(key.getData()));
        }

        if (key.getP12Data() != null) {
            System.out.println("  Key data in PKCS12 format: " + key.getP12Data());
        }
    }
}