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