1 /*-
2 * Copyright (C) 2019, Salesforce.
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43 package org.eclipse.jgit.lib.internal;
44
45 import java.net.URISyntaxException;
46 import java.nio.file.Path;
47 import java.text.MessageFormat;
48
49 import org.bouncycastle.openpgp.PGPException;
50 import org.bouncycastle.util.encoders.Hex;
51 import org.eclipse.jgit.api.errors.CanceledException;
52 import org.eclipse.jgit.errors.UnsupportedCredentialItem;
53 import org.eclipse.jgit.internal.JGitText;
54 import org.eclipse.jgit.transport.CredentialItem.CharArrayType;
55 import org.eclipse.jgit.transport.CredentialItem.InformationalMessage;
56 import org.eclipse.jgit.transport.CredentialsProvider;
57 import org.eclipse.jgit.transport.URIish;
58
59 /**
60 * Prompts for a passphrase and caches it until {@link #clear() cleared}.
61 * <p>
62 * Implements {@link AutoCloseable} so it can be used within a
63 * try-with-resources block.
64 * </p>
65 */
66 class BouncyCastleGpgKeyPassphrasePrompt implements AutoCloseable {
67
68 private CharArrayType passphrase;
69
70 private CredentialsProvider credentialsProvider;
71
72 public BouncyCastleGpgKeyPassphrasePrompt(
73 CredentialsProvider credentialsProvider) {
74 this.credentialsProvider = credentialsProvider;
75 }
76
77 /**
78 * Clears any cached passphrase
79 */
80 public void clear() {
81 if (passphrase != null) {
82 passphrase.clear();
83 passphrase = null;
84 }
85 }
86
87 @Override
88 public void close() {
89 clear();
90 }
91
92 private URIish createURI(Path keyLocation) throws URISyntaxException {
93 return new URIish(keyLocation.toUri().toString());
94 }
95
96 /**
97 * Prompts use for a passphrase unless one was cached from a previous
98 * prompt.
99 *
100 * @param keyFingerprint
101 * the fingerprint to show to the user during prompting
102 * @param keyLocation
103 * the location the key was loaded from
104 * @return the passphrase (maybe <code>null</code>)
105 * @throws PGPException
106 * @throws CanceledException
107 * in case passphrase was not entered by user
108 * @throws URISyntaxException
109 * @throws UnsupportedCredentialItem
110 */
111 public char[] getPassphrase(byte[] keyFingerprint, Path keyLocation)
112 throws PGPException, CanceledException, UnsupportedCredentialItem,
113 URISyntaxException {
114 if (passphrase == null) {
115 passphrase = new CharArrayType(JGitText.get().credentialPassphrase,
116 true);
117 }
118
119 if (credentialsProvider == null) {
120 throw new PGPException(JGitText.get().gpgNoCredentialsProvider);
121 }
122
123 if (passphrase.getValue() == null
124 && !credentialsProvider.get(createURI(keyLocation),
125 new InformationalMessage(
126 MessageFormat.format(JGitText.get().gpgKeyInfo,
127 Hex.toHexString(keyFingerprint))),
128 passphrase)) {
129 throw new CanceledException(JGitText.get().gpgSigningCancelled);
130 }
131 return passphrase.getValue();
132 }
133
134 }