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 package org.eclipse.jgit.transport;
44
45 import org.eclipse.jgit.lib.Repository;
46 import org.eclipse.jgit.transport.PushCertificate.NonceStatus;
47
48 /**
49 * A NonceGenerator is used to create a nonce to be sent out to the pusher who
50 * will sign the nonce to prove it is not a replay attack on the push
51 * certificate.
52 *
53 * @since 4.0
54 */
55 public interface NonceGenerator {
56
57 /**
58 * Create nonce to be signed by the pusher
59 *
60 * @param db
61 * The repository which should be used to obtain a unique String
62 * such that the pusher cannot forge nonces by pushing to another
63 * repository at the same time as well and reusing the nonce.
64 * @param timestamp
65 * The current time in seconds.
66 * @return The nonce to be signed by the pusher
67 * @throws java.lang.IllegalStateException
68 */
69 public String createNonce(Repository db, long timestamp)
70 throws IllegalStateException;
71
72 /**
73 * Verify trustworthiness of the received nonce.
74 *
75 * @param received
76 * The nonce which was received from the server
77 * @param sent
78 * The nonce which was originally sent out to the client.
79 * @param db
80 * The repository which should be used to obtain a unique String
81 * such that the pusher cannot forge nonces by pushing to another
82 * repository at the same time as well and reusing the nonce.
83 * @param allowSlop
84 * If the receiving backend is is able to generate slop. This is
85 * the case for serving via http protocol using more than one
86 * http frontend. The client would talk to different http
87 * frontends, which may have a slight difference of time due to
88 * @param slop
89 * If `allowSlop` is true, this specifies the number of seconds
90 * which we allow as slop.
91 * @return a NonceStatus indicating the trustworthiness of the received
92 * nonce.
93 */
94 public NonceStatus verify(String received, String sent,
95 Repository db, boolean allowSlop, int slop);
96 }