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 /**
46 * Typed access to GPG related configuration options.
47 *
48 * @since 5.2
49 */
50 public class GpgConfig {
51
52 /**
53 * Config values for gpg.format.
54 */
55 public enum GpgFormat implements Config.ConfigEnum {
56
57 /** Value for openpgp */
58 OPENPGP("openpgp"), //$NON-NLS-1$
59 /** Value for x509 */
60 X509("x509"); //$NON-NLS-1$
61
62 private final String configValue;
63
64 private GpgFormat(String configValue) {
65 this.configValue = configValue;
66 }
67
68 @Override
69 public boolean matchConfigValue(String s) {
70 return configValue.equals(s);
71 }
72
73 @Override
74 public String toConfigValue() {
75 return configValue;
76 }
77 }
78
79 private final Config config;
80
81 /**
82 * Create a new GPG config, which will read configuration from config.
83 *
84 * @param config
85 * the config to read from
86 */
87 public GpgConfig(Config config) {
88 this.config = config;
89 }
90
91 /**
92 * Retrieves the config value of gpg.format.
93 *
94 * @return the {@link org.eclipse.jgit.lib.GpgConfig.GpgFormat}
95 */
96 public GpgFormat getKeyFormat() {
97 return config.getEnum(GpgFormat.values(),
98 ConfigConstants.CONFIG_GPG_SECTION, null,
99 ConfigConstants.CONFIG_KEY_FORMAT, GpgFormat.OPENPGP);
100 }
101
102 /**
103 * Retrieves the config value of user.signingKey.
104 *
105 * @return the value of user.signingKey (may be <code>null</code>)
106 */
107 public String getSigningKey() {
108 return config.getString(ConfigConstants.CONFIG_USER_SECTION, null,
109 ConfigConstants.CONFIG_KEY_SIGNINGKEY);
110 }
111
112 /**
113 * Retrieves the config value of commit.gpgSign.
114 *
115 * @return the value of commit.gpgSign (defaults to <code>false</code>)
116 */
117 public boolean isSignCommits() {
118 return config.getBoolean(ConfigConstants.CONFIG_COMMIT_SECTION,
119 ConfigConstants.CONFIG_KEY_GPGSIGN, false);
120 }
121 }