1 /*
2 * Copyright (C) 2018, 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;
44
45 import org.eclipse.jgit.annotations.NonNull;
46 import org.eclipse.jgit.annotations.Nullable;
47 import org.eclipse.jgit.api.errors.CanceledException;
48 import org.eclipse.jgit.lib.internal.BouncyCastleGpgSigner;
49 import org.eclipse.jgit.transport.CredentialsProvider;
50
51 /**
52 * Creates GPG signatures for Git objects.
53 *
54 * @since 5.3
55 */
56 public abstract class GpgSigner {
57
58 private static GpgSigner defaultSigner = new BouncyCastleGpgSigner();
59
60 /**
61 * Get the default signer, or <code>null</code>.
62 *
63 * @return the default signer, or <code>null</code>.
64 */
65 public static GpgSigner getDefault() {
66 return defaultSigner;
67 }
68
69 /**
70 * Set the default signer.
71 *
72 * @param signer
73 * the new default signer, may be <code>null</code> to select no
74 * default.
75 */
76 public static void setDefault(GpgSigner signer) {
77 GpgSigner.defaultSigner = signer;
78 }
79
80 /**
81 * Signs the specified commit.
82 *
83 * <p>
84 * Implementors should obtain the payload for signing from the specified
85 * commit via {@link CommitBuilder#build()} and create a proper
86 * {@link GpgSignature}. The generated signature must be set on the
87 * specified {@code commit} (see
88 * {@link CommitBuilder#setGpgSignature(GpgSignature)}).
89 * </p>
90 * <p>
91 * Any existing signature on the commit must be discarded prior obtaining
92 * the payload via {@link CommitBuilder#build()}.
93 * </p>
94 *
95 * @param commit
96 * the commit to sign (must not be <code>null</code> and must be
97 * complete to allow proper calculation of payload)
98 * @param gpgSigningKey
99 * the signing key to locate (passed as is to the GPG signing
100 * tool as is; eg., value of <code>user.signingkey</code>)
101 * @param committer
102 * the signing identity (to help with key lookup in case signing
103 * key is not specified)
104 * @param credentialsProvider
105 * provider to use when querying for signing key credentials (eg.
106 * passphrase)
107 * @throws CanceledException
108 * when signing was canceled (eg., user aborted when entering
109 * passphrase)
110 */
111 public abstract void sign(@NonNull CommitBuilder commit,
112 @Nullable String gpgSigningKey, @NonNull PersonIdent committer,
113 CredentialsProvider credentialsProvider) throws CanceledException;
114
115 /**
116 * Indicates if a signing key is available for the specified committer
117 * and/or signing key.
118 *
119 * @param gpgSigningKey
120 * the signing key to locate (passed as is to the GPG signing
121 * tool as is; eg., value of <code>user.signingkey</code>)
122 * @param committer
123 * the signing identity (to help with key lookup in case signing
124 * key is not specified)
125 * @param credentialsProvider
126 * provider to use when querying for signing key credentials (eg.
127 * passphrase)
128 * @return <code>true</code> if a signing key is available,
129 * <code>false</code> otherwise
130 * @throws CanceledException
131 * when signing was canceled (eg., user aborted when entering
132 * passphrase)
133 */
134 public abstract boolean canLocateSigningKey(@Nullable String gpgSigningKey,
135 @NonNull PersonIdent committer,
136 CredentialsProvider credentialsProvider) throws CanceledException;
137
138 }