motiejus
/
jgit
1
Fork 0
Code Releases Activity

ReceivePack: Clarify the check reachable option 

This option was mis-named from day 1.  Its not checking that the
objects provided by the client are reachable, its actually doing
a scan to prove that objects referenced by the client are already
reachable through another reference on the server, or were sent
as part of the pack from the client.

Rename it checkReferencedObjectsAreReachable, since we really are
trying to validate that objects referenced by the client's actions
are reachable to the client.

We also need to ensure we run checkConnectivity() anytime this is
enabled, even if the caller didn't turn on fsck for object formats.
Otherwise the check would be completely bypassed.

Change-Id: Ic352ddb0ca8464d407c6da5c83573093e018af19
Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
This commit is contained in:
Shawn O. Pearce 2010-04-16 17:03:54 -07:00
parent a770205070
commit 585dcb7a1c
2 changed files with 49 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
org.eclipse.jgit.test/tst/org/eclipse/jgit/transport/ReceivePackRefFilterTest.java
View File

@ -186,7 +186,7 @@ ReceivePack createReceivePack(final Repository db) {
final ReceivePack rp = super.createReceivePack(dst);
rp.setCheckReceivedObjects(true);
rp.setEnsureProvidedObjectsVisible(true);
rp.setCheckReferencedObjectsAreReachable(true);
rp.setRefFilter(new HidePrivateFilter());
return rp;
}
@ -229,7 +229,7 @@ public void testCreateBranchAtHiddenCommitFails() throws Exception {
final TemporaryBuffer.Heap outBuf = new TemporaryBuffer.Heap(1024);
final ReceivePack rp = new ReceivePack(dst);
rp.setCheckReceivedObjects(true);
rp.setEnsureProvidedObjectsVisible(true);
rp.setCheckReferencedObjectsAreReachable(true);
rp.setRefFilter(new HidePrivateFilter());
rp.receive(new ByteArrayInputStream(inBuf.toByteArray()), outBuf, null);
@ -264,7 +264,7 @@ public void testUsingHiddenDeltaBaseFails() throws Exception {
final TemporaryBuffer.Heap outBuf = new TemporaryBuffer.Heap(1024);
final ReceivePack rp = new ReceivePack(dst);
rp.setCheckReceivedObjects(true);
rp.setEnsureProvidedObjectsVisible(true);
rp.setCheckReferencedObjectsAreReachable(true);
rp.setRefFilter(new HidePrivateFilter());
rp.receive(new ByteArrayInputStream(inBuf.toByteArray()), outBuf, null);
@ -305,7 +305,7 @@ public void testUsingHiddenCommonBlobFails() throws Exception {
final TemporaryBuffer.Heap outBuf = new TemporaryBuffer.Heap(1024);
final ReceivePack rp = new ReceivePack(dst);
rp.setCheckReceivedObjects(true);
rp.setEnsureProvidedObjectsVisible(true);
rp.setCheckReferencedObjectsAreReachable(true);
rp.setRefFilter(new HidePrivateFilter());
rp.receive(new ByteArrayInputStream(inBuf.toByteArray()), outBuf, null);
@ -347,7 +347,7 @@ public void testUsingUnknownBlobFails() throws Exception {
final TemporaryBuffer.Heap outBuf = new TemporaryBuffer.Heap(1024);
final ReceivePack rp = new ReceivePack(dst);
rp.setCheckReceivedObjects(true);
rp.setEnsureProvidedObjectsVisible(true);
rp.setCheckReferencedObjectsAreReachable(true);
rp.setRefFilter(new HidePrivateFilter());
rp.receive(new ByteArrayInputStream(inBuf.toByteArray()), outBuf, null);
@ -386,7 +386,7 @@ public void testUsingUnknownTreeFails() throws Exception {
final TemporaryBuffer.Heap outBuf = new TemporaryBuffer.Heap(1024);
final ReceivePack rp = new ReceivePack(dst);
rp.setCheckReceivedObjects(true);
rp.setEnsureProvidedObjectsVisible(true);
rp.setCheckReferencedObjectsAreReachable(true);
rp.setRefFilter(new HidePrivateFilter());
rp.receive(new ByteArrayInputStream(inBuf.toByteArray()), outBuf, null);

68
org.eclipse.jgit/src/org/eclipse/jgit/transport/ReceivePack.java
View File

@ -184,7 +184,7 @@ public class ReceivePack {
/** Lock around the received pack file, while updating refs. */
private PackLock packLock;
private boolean ensureObjectsProvidedVisible;
private boolean checkReferencedIsReachable;
/**
* Create a new pack receive for an open repository.
@ -252,23 +252,36 @@ public final Map<String, Ref> getAdvertisedRefs() {
}
/**
* Configure this receive pack instance to ensure that the provided
* objects are visible to the user.
* <p>
* By default, a receive pack assumes that its user will only provide
* references to objects that it can see. Setting this flag to {@code true}
* will add an additional check that verifies that the objects that were
* provided are reachable by a tree or a commit that the user can see.
* <p>
* This option is useful when the code doesn't trust the client not to
* provide a forged SHA-1 reference to an object in an attempt to access
* parts of the DAG that they aren't allowed to see, via the configured
* {@link RefFilter}.
*
* @param b {@code true} to enable the additional check.
* @return true if this instance will validate all referenced, but not
* supplied by the client, objects are reachable from another
* reference.
*/
public void setEnsureProvidedObjectsVisible(boolean b) {
this.ensureObjectsProvidedVisible = b;
public boolean isCheckReferencedObjectsAreReachable() {
return checkReferencedIsReachable;
}
/**
* Validate all referenced but not supplied objects are reachable.
* <p>
* If enabled, this instance will verify that references to objects not
* contained within the received pack are already reachable through at least
* one other reference selected by the {@link #getRefFilter()} and displayed
* as part of {@link #getAdvertisedRefs()}.
* <p>
* This feature is useful when the application doesn't trust the client to
* not provide a forged SHA-1 reference to an object, in an attempt to
* access parts of the DAG that they aren't allowed to see and which have
* been hidden from them via the configured {@link RefFilter}.
* <p>
* Enabling this feature may imply at least some, if not all, of the same
* functionality performed by {@link #setCheckReceivedObjects(boolean)}.
* Applications are encouraged to enable both features, if desired.
*
* @param b
* {@code true} to enable the additional check.
*/
public void setCheckReferencedObjectsAreReachable(boolean b) {
this.checkReferencedIsReachable = b;
}
/**
@ -611,7 +624,7 @@ private void service() throws IOException {
if (needPack()) {
try {
receivePack();
if (isCheckReceivedObjects())
if (needCheckConnectivity())
checkConnectivity();
ip = null;
unpackError = null;
@ -761,8 +774,8 @@ private void receivePack() throws IOException {
ip = IndexPack.create(db, rawIn);
ip.setFixThin(true);
ip.setNeedNewObjectIds(ensureObjectsProvidedVisible);
ip.setNeedBaseObjectIds(ensureObjectsProvidedVisible);
ip.setNeedNewObjectIds(checkReferencedIsReachable);
ip.setNeedBaseObjectIds(checkReferencedIsReachable);
ip.setObjectChecking(isCheckReceivedObjects());
ip.index(NullProgressMonitor.INSTANCE);
@ -775,11 +788,16 @@ private void receivePack() throws IOException {
timeoutIn.setTimeout(timeout * 1000);
}
private boolean needCheckConnectivity() {
return isCheckReceivedObjects()
|| isCheckReferencedObjectsAreReachable();
}
private void checkConnectivity() throws IOException {
ObjectIdSubclassMap<ObjectId> baseObjects = null;
ObjectIdSubclassMap<ObjectId> providedObjects = null;
if (ensureObjectsProvidedVisible) {
if (checkReferencedIsReachable) {
baseObjects = ip.getBaseObjectIds();
providedObjects = ip.getNewObjectIds();
}
@ -797,7 +815,7 @@ private void checkConnectivity() throws IOException {
RevObject o = ow.parseAny(ref.getObjectId());
ow.markUninteresting(o);
if (ensureObjectsProvidedVisible && !baseObjects.isEmpty()) {
if (checkReferencedIsReachable && !baseObjects.isEmpty()) {
while (o instanceof RevTag)
o = ((RevTag) o).getObject();
if (o instanceof RevCommit)
@ -807,7 +825,7 @@ private void checkConnectivity() throws IOException {
}
}
if (ensureObjectsProvidedVisible) {
if (checkReferencedIsReachable) {
for (ObjectId id : baseObjects) {
RevObject b = ow.lookupAny(id, Constants.OBJ_BLOB);
if (!b.has(RevFlag.UNINTERESTING))
@ -817,13 +835,13 @@ private void checkConnectivity() throws IOException {
RevCommit c;
while ((c = ow.next()) != null) {
if (ensureObjectsProvidedVisible && !providedObjects.contains(c))
if (checkReferencedIsReachable && !providedObjects.contains(c))
throw new MissingObjectException(c, Constants.TYPE_COMMIT);
}
RevObject o;
while ((o = ow.nextObject()) != null) {
if (ensureObjectsProvidedVisible) {
if (checkReferencedIsReachable) {
if (providedObjects.contains(o))
continue;
else