Disallow creating invalid DirCacheEntry records
A dircache record must not use a path string like "/a" or "a//b" as this results in a tree entry being written with a zero length name component in the record. C git does not support an empty name, and neither does any modern filesystem. A record also must not have a stage outside of the standard 0-3 value range, as there are only 2 bits of space available in the on-disk format of the record to store the stage information. Any other values would be truncated into this space, storing a different value than the caller expected. If an application tries to create a DirCache record with either of these wrong values, we abort with an IllegalArgumentException. Change-Id: I699de149efdfccd85d8adde07d3efd080e3b49c2 Originally: http://thread.gmane.org/gmane.comp.version-control.git/128214 Signed-off-by: Shawn O. Pearce <spearce@spearce.org> CC: Adam W. Hawks <awhawks@writeme.com>
This commit is contained in:
parent
fbadb19543
commit
329abf7212
|
@ -174,6 +174,10 @@ public class DirCacheEntry {
|
|||
*
|
||||
* @param newPath
|
||||
* name of the cache entry.
|
||||
* @throws IllegalArgumentException
|
||||
* If the path starts or ends with "/", or contains "//" either
|
||||
* "\0". These sequences are not permitted in a git tree object
|
||||
* or DirCache file.
|
||||
*/
|
||||
public DirCacheEntry(final String newPath) {
|
||||
this(Constants.encode(newPath));
|
||||
|
@ -186,6 +190,11 @@ public DirCacheEntry(final String newPath) {
|
|||
* name of the cache entry.
|
||||
* @param stage
|
||||
* the stage index of the new entry.
|
||||
* @throws IllegalArgumentException
|
||||
* If the path starts or ends with "/", or contains "//" either
|
||||
* "\0". These sequences are not permitted in a git tree object
|
||||
* or DirCache file. Or if {@code stage} is outside of the
|
||||
* range 0..3, inclusive.
|
||||
*/
|
||||
public DirCacheEntry(final String newPath, final int stage) {
|
||||
this(Constants.encode(newPath), stage);
|
||||
|
@ -196,6 +205,10 @@ public DirCacheEntry(final String newPath, final int stage) {
|
|||
*
|
||||
* @param newPath
|
||||
* name of the cache entry, in the standard encoding.
|
||||
* @throws IllegalArgumentException
|
||||
* If the path starts or ends with "/", or contains "//" either
|
||||
* "\0". These sequences are not permitted in a git tree object
|
||||
* or DirCache file.
|
||||
*/
|
||||
public DirCacheEntry(final byte[] newPath) {
|
||||
this(newPath, STAGE_0);
|
||||
|
@ -208,8 +221,20 @@ public DirCacheEntry(final byte[] newPath) {
|
|||
* name of the cache entry, in the standard encoding.
|
||||
* @param stage
|
||||
* the stage index of the new entry.
|
||||
* @throws IllegalArgumentException
|
||||
* If the path starts or ends with "/", or contains "//" either
|
||||
* "\0". These sequences are not permitted in a git tree object
|
||||
* or DirCache file. Or if {@code stage} is outside of the
|
||||
* range 0..3, inclusive.
|
||||
*/
|
||||
public DirCacheEntry(final byte[] newPath, final int stage) {
|
||||
if (!isValidPath(newPath))
|
||||
throw new IllegalArgumentException("Invalid path: "
|
||||
+ toString(newPath));
|
||||
if (stage < 0 || 3 < stage)
|
||||
throw new IllegalArgumentException("Invalid stage " + stage
|
||||
+ " for path " + toString(newPath));
|
||||
|
||||
info = new byte[INFO_LEN];
|
||||
infoOffset = 0;
|
||||
path = newPath;
|
||||
|
@ -469,7 +494,7 @@ public void setObjectIdFromRaw(final byte[] bs, final int p) {
|
|||
* returned string.
|
||||
*/
|
||||
public String getPathString() {
|
||||
return Constants.CHARSET.decode(ByteBuffer.wrap(path)).toString();
|
||||
return toString(path);
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -500,4 +525,32 @@ private void encodeTS(final int pIdx, final long when) {
|
|||
NB.encodeInt32(info, base, (int) (when / 1000));
|
||||
NB.encodeInt32(info, base + 4, ((int) (when % 1000)) * 1000000);
|
||||
}
|
||||
|
||||
private static String toString(final byte[] path) {
|
||||
return Constants.CHARSET.decode(ByteBuffer.wrap(path)).toString();
|
||||
}
|
||||
|
||||
static boolean isValidPath(final byte[] path) {
|
||||
if (path.length == 0)
|
||||
return false; // empty path is not permitted.
|
||||
|
||||
boolean componentHasChars = false;
|
||||
for (final byte c : path) {
|
||||
switch (c) {
|
||||
case 0:
|
||||
return false; // NUL is never allowed within the path.
|
||||
|
||||
case '/':
|
||||
if (componentHasChars)
|
||||
componentHasChars = false;
|
||||
else
|
||||
return false;
|
||||
break;
|
||||
|
||||
default:
|
||||
componentHasChars = true;
|
||||
}
|
||||
}
|
||||
return componentHasChars;
|
||||
}
|
||||
}
|
||||
|
|
|
@ -0,0 +1,121 @@
|
|||
/*
|
||||
* Copyright (C) 2009, Google Inc.
|
||||
* and other copyright owners as documented in the project's IP log.
|
||||
*
|
||||
* This program and the accompanying materials are made available
|
||||
* under the terms of the Eclipse Distribution License v1.0 which
|
||||
* accompanies this distribution, is reproduced below, and is
|
||||
* available at http://www.eclipse.org/org/documents/edl-v10.php
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or
|
||||
* without modification, are permitted provided that the following
|
||||
* conditions are met:
|
||||
*
|
||||
* - Redistributions of source code must retain the above copyright
|
||||
* notice, this list of conditions and the following disclaimer.
|
||||
*
|
||||
* - Redistributions in binary form must reproduce the above
|
||||
* copyright notice, this list of conditions and the following
|
||||
* disclaimer in the documentation and/or other materials provided
|
||||
* with the distribution.
|
||||
*
|
||||
* - Neither the name of the Eclipse Foundation, Inc. nor the
|
||||
* names of its contributors may be used to endorse or promote
|
||||
* products derived from this software without specific prior
|
||||
* written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
|
||||
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
|
||||
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
|
||||
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
||||
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
||||
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
|
||||
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
|
||||
package org.spearce.jgit.dircache;
|
||||
|
||||
import junit.framework.TestCase;
|
||||
|
||||
import org.spearce.jgit.lib.Constants;
|
||||
|
||||
public class DirCacheEntryTest extends TestCase {
|
||||
public void testIsValidPath() {
|
||||
assertTrue(isValidPath("a"));
|
||||
assertTrue(isValidPath("a/b"));
|
||||
assertTrue(isValidPath("ab/cd/ef"));
|
||||
|
||||
assertFalse(isValidPath(""));
|
||||
assertFalse(isValidPath("/a"));
|
||||
assertFalse(isValidPath("a//b"));
|
||||
assertFalse(isValidPath("ab/cd//ef"));
|
||||
assertFalse(isValidPath("a/"));
|
||||
assertFalse(isValidPath("ab/cd/ef/"));
|
||||
assertFalse(isValidPath("a\u0000b"));
|
||||
}
|
||||
|
||||
private static boolean isValidPath(final String path) {
|
||||
return DirCacheEntry.isValidPath(Constants.encode(path));
|
||||
}
|
||||
|
||||
public void testCreate_ByStringPath() {
|
||||
assertEquals("a", new DirCacheEntry("a").getPathString());
|
||||
assertEquals("a/b", new DirCacheEntry("a/b").getPathString());
|
||||
|
||||
try {
|
||||
new DirCacheEntry("/a");
|
||||
fail("Incorrectly created DirCacheEntry");
|
||||
} catch (IllegalArgumentException err) {
|
||||
assertEquals("Invalid path: /a", err.getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
public void testCreate_ByStringPathAndStage() {
|
||||
DirCacheEntry e;
|
||||
|
||||
e = new DirCacheEntry("a", 0);
|
||||
assertEquals("a", e.getPathString());
|
||||
assertEquals(0, e.getStage());
|
||||
|
||||
e = new DirCacheEntry("a/b", 1);
|
||||
assertEquals("a/b", e.getPathString());
|
||||
assertEquals(1, e.getStage());
|
||||
|
||||
e = new DirCacheEntry("a/c", 2);
|
||||
assertEquals("a/c", e.getPathString());
|
||||
assertEquals(2, e.getStage());
|
||||
|
||||
e = new DirCacheEntry("a/d", 3);
|
||||
assertEquals("a/d", e.getPathString());
|
||||
assertEquals(3, e.getStage());
|
||||
|
||||
try {
|
||||
new DirCacheEntry("/a", 1);
|
||||
fail("Incorrectly created DirCacheEntry");
|
||||
} catch (IllegalArgumentException err) {
|
||||
assertEquals("Invalid path: /a", err.getMessage());
|
||||
}
|
||||
|
||||
try {
|
||||
new DirCacheEntry("a", -11);
|
||||
fail("Incorrectly created DirCacheEntry");
|
||||
} catch (IllegalArgumentException err) {
|
||||
assertEquals("Invalid stage -11 for path a", err.getMessage());
|
||||
}
|
||||
|
||||
try {
|
||||
new DirCacheEntry("a", 4);
|
||||
fail("Incorrectly created DirCacheEntry");
|
||||
} catch (IllegalArgumentException err) {
|
||||
assertEquals("Invalid stage 4 for path a", err.getMessage());
|
||||
}
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue