1 /*
2 * Copyright (C) 2015, Google Inc.
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
44 package org.eclipse.jgit.transport;
45
46 import org.eclipse.jgit.lib.Config;
47 import org.eclipse.jgit.lib.Config.SectionParser;
48
49 /**
50 * Configuration for server-side signed push verification.
51 *
52 * @since 4.1
53 */
54 public class SignedPushConfig {
55 /** Key for {@link Config#get(SectionParser)}. */
56 public static final SectionParser<SignedPushConfig> KEY =
57 new SectionParser<SignedPushConfig>() {
58 public SignedPushConfig parse(Config cfg) {
59 return new SignedPushConfig(cfg);
60 }
61 };
62
63 private String certNonceSeed;
64 private int certNonceSlopLimit;
65 private NonceGenerator nonceGenerator;
66
67 /** Create a new config with default values disabling push verification. */
68 public SignedPushConfig() {
69 }
70
71 SignedPushConfig(Config cfg) {
72 setCertNonceSeed(cfg.getString("receive", null, "certnonceseed")); //$NON-NLS-1$ //$NON-NLS-2$
73 certNonceSlopLimit = cfg.getInt("receive", "certnonceslop", 0); //$NON-NLS-1$ //$NON-NLS-2$
74 }
75
76 /**
77 * Set the seed used by the nonce verifier.
78 * <p>
79 * Setting this to a non-null value enables push certificate verification
80 * using the default {@link HMACSHA1NonceGenerator} implementation, if a
81 * different implementation was not set using {@link
82 * #setNonceGenerator(NonceGenerator)}.
83 *
84 * @param seed
85 * new seed value.
86 */
87 public void setCertNonceSeed(String seed) {
88 certNonceSeed = seed;
89 }
90
91 /** @return the configured seed. */
92 public String getCertNonceSeed() {
93 return certNonceSeed;
94 }
95
96 /**
97 * Set the nonce slop limit.
98 * <p>
99 * Old but valid nonces within this limit will be accepted.
100 *
101 * @param limit
102 * new limit in seconds.
103 */
104 public void setCertNonceSlopLimit(int limit) {
105 certNonceSlopLimit = limit;
106 }
107
108 /** @return the configured nonce slop limit. */
109 public int getCertNonceSlopLimit() {
110 return certNonceSlopLimit;
111 }
112
113 /**
114 * Set the {@link NonceGenerator} used for signed pushes.
115 * <p>
116 * Setting this to a non-null value enables push certificate verification. If
117 * this method is called, this implementation will be used instead of the
118 * default {@link HMACSHA1NonceGenerator} even if {@link
119 * #setCertNonceSeed(String)} was called.
120 *
121 * @param generator
122 * new nonce generator.
123 */
124 public void setNonceGenerator(NonceGenerator generator) {
125 nonceGenerator = generator;
126 }
127
128 /**
129 * Get the {@link NonceGenerator} used for signed pushes.
130 * <p>
131 * If {@link #setNonceGenerator(NonceGenerator)} was used to set a non-null
132 * implementation, that will be returned. If no custom implementation was set
133 * but {@link #setCertNonceSeed(String)} was called, returns a newly-created
134 * {@link HMACSHA1NonceGenerator}.
135 *
136 * @return the configured nonce generator.
137 */
138 public NonceGenerator getNonceGenerator() {
139 if (nonceGenerator != null) {
140 return nonceGenerator;
141 } else if (certNonceSeed != null) {
142 return new HMACSHA1NonceGenerator(certNonceSeed);
143 }
144 return null;
145 }
146 }