View Javadoc
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 static java.nio.charset.StandardCharsets.ISO_8859_1;
46  import static java.nio.charset.StandardCharsets.UTF_8;
47  
48  import java.security.InvalidKeyException;
49  import java.security.NoSuchAlgorithmException;
50  
51  import javax.crypto.Mac;
52  import javax.crypto.spec.SecretKeySpec;
53  
54  import org.eclipse.jgit.lib.Repository;
55  import org.eclipse.jgit.transport.PushCertificate.NonceStatus;
56  
57  /**
58   * The nonce generator which was first introduced to git-core.
59   *
60   * @since 4.0
61   */
62  public class HMACSHA1NonceGenerator implements NonceGenerator {
63  
64  	private Mac mac;
65  
66  	/**
67  	 * Constructor for HMACSHA1NonceGenerator.
68  	 *
69  	 * @param seed
70  	 *            seed the generator
71  	 * @throws java.lang.IllegalStateException
72  	 */
73  	public HMACSHA1NonceGenerator(String seed) throws IllegalStateException {
74  		try {
75  			byte[] keyBytes = seed.getBytes(ISO_8859_1);
76  			SecretKeySpec signingKey = new SecretKeySpec(keyBytes, "HmacSHA1"); //$NON-NLS-1$
77  			mac = Mac.getInstance("HmacSHA1"); //$NON-NLS-1$
78  			mac.init(signingKey);
79  		} catch (InvalidKeyException | NoSuchAlgorithmException e) {
80  			throw new IllegalStateException(e);
81  		}
82  	}
83  
84  	/** {@inheritDoc} */
85  	@Override
86  	public synchronized String createNonce(Repository repo, long timestamp)
87  			throws IllegalStateException {
88  		String input = repo.getIdentifier() + ":" + String.valueOf(timestamp); //$NON-NLS-1$
89  		byte[] rawHmac = mac.doFinal(input.getBytes(UTF_8));
90  		return Long.toString(timestamp) + "-" + toHex(rawHmac); //$NON-NLS-1$
91  	}
92  
93  	/** {@inheritDoc} */
94  	@Override
95  	public NonceStatus verify(String received, String sent,
96  			Repository db, boolean allowSlop, int slop) {
97  		if (received.isEmpty()) {
98  			return NonceStatus.MISSING;
99  		} else if (sent.isEmpty()) {
100 			return NonceStatus.UNSOLICITED;
101 		} else if (received.equals(sent)) {
102 			return NonceStatus.OK;
103 		}
104 
105 		if (!allowSlop) {
106 			return NonceStatus.BAD;
107 		}
108 
109 		/* nonce is concat(<seconds-since-epoch>, "-", <hmac>) */
110 		int idxSent = sent.indexOf('-');
111 		int idxRecv = received.indexOf('-');
112 		if (idxSent == -1 || idxRecv == -1) {
113 			return NonceStatus.BAD;
114 		}
115 
116 		String signedStampStr = received.substring(0, idxRecv);
117 		String advertisedStampStr = sent.substring(0, idxSent);
118 		long signedStamp;
119 		long advertisedStamp;
120 		try {
121 			signedStamp = Long.parseLong(signedStampStr);
122 			advertisedStamp = Long.parseLong(advertisedStampStr);
123 		} catch (IllegalArgumentException e) {
124 			return NonceStatus.BAD;
125 		}
126 
127 		// what we would have signed earlier
128 		String expect = createNonce(db, signedStamp);
129 
130 		if (!expect.equals(received)) {
131 			return NonceStatus.BAD;
132 		}
133 
134 		long nonceStampSlop = Math.abs(advertisedStamp - signedStamp);
135 
136 		if (nonceStampSlop <= slop) {
137 			return NonceStatus.OK;
138 		}
139 		return NonceStatus.SLOP;
140 	}
141 
142 	private static final String HEX = "0123456789ABCDEF"; //$NON-NLS-1$
143 
144 	private static String toHex(byte[] bytes) {
145 		StringBuilder builder = new StringBuilder(2 * bytes.length);
146 		for (byte b : bytes) {
147 			builder.append(HEX.charAt((b & 0xF0) >> 4));
148 			builder.append(HEX.charAt(b & 0xF));
149 		}
150 		return builder.toString();
151 	}
152 }