org.eclipse.jgit.lib

Class ObjectChecker

java.lang.Object

org.eclipse.jgit.lib.ObjectChecker

public class ObjectChecker
extends Object

Verifies that an object is formatted correctly.

Verifications made by this class only check that the fields of an object are formatted correctly. The ObjectId checksum of the object is not verified, and connectivity links between objects are also not verified. Its assumed that the caller can provide both of these validations on its own.

Instances of this class are not thread safe, but they may be reused to perform multiple object validations, calling reset() between them to clear the internal state (e.g. getGitsubmodules())

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ObjectChecker.ErrorType Potential issues identified by the checker.

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	author Header "author "
static byte[]	committer Header "committer "
static byte[]	encoding Header "encoding "
static byte[]	object Header "object "
static byte[]	parent Header "parent "
static byte[]	tag Header "tag "
static byte[]	tagger Header "tagger "
static byte[]	tree Header "tree "
static byte[]	type Header "type "

Constructor Summary

Constructors

Constructor and Description
ObjectChecker()

Method Summary

Modifier and Type	Method and Description
void	check(AnyObjectId id, int objType, byte[] raw) Check an object for parsing errors.
void	check(int objType, byte[] raw) Check an object for parsing errors.
void	checkBlob(byte[] raw) Check a blob for errors.
void	checkCommit(AnyObjectId id, byte[] raw) Check a commit for errors.
void	checkCommit(byte[] raw) Check a commit for errors.
void	checkPath(byte[] raw, int ptr, int end) Check tree path entry for validity.
void	checkPath(String path) Check tree path entry for validity.
void	checkPathSegment(byte[] raw, int ptr, int end) Check tree path entry for validity.
void	checkTag(AnyObjectId id, byte[] raw) Check an annotated tag for errors.
void	checkTag(byte[] raw) Check an annotated tag for errors.
void	checkTree(AnyObjectId id, byte[] raw) Check a canonical formatted tree for errors.
void	checkTree(byte[] raw) Check a canonical formatted tree for errors.
List<GitmoduleEntry>	getGitsubmodules() Get the list of ".gitmodules" files found in the pack.
BlobObjectChecker	newBlobObjectChecker() Create a new BlobObjectChecker.
void	reset() Reset the invocation-specific state from this instance.
ObjectChecker	setAllowInvalidPersonIdent(boolean allow) Enable accepting invalid author, committer and tagger identities.
ObjectChecker	setAllowLeadingZeroFileMode(boolean allow) Enable accepting leading zero mode in tree entries.
ObjectChecker	setIgnore(ObjectChecker.ErrorType id, boolean ignore) Add message type to be ignored across all objects.
ObjectChecker	setIgnore(Set<ObjectChecker.ErrorType> ids) Configure error types to be ignored across all objects.
ObjectChecker	setSafeForMacOS(boolean mac) Restrict trees to only names legal on Mac OS X platforms.
ObjectChecker	setSafeForWindows(boolean win) Restrict trees to only names legal on Windows platforms.
ObjectChecker	setSkipList(ObjectIdSet objects) Enable accepting specific malformed (but not horribly broken) objects.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

tree

public static final byte[] tree

Header "tree "

parent

public static final byte[] parent

Header "parent "

author

public static final byte[] author

Header "author "

committer

public static final byte[] committer

Header "committer "

encoding

public static final byte[] encoding

Header "encoding "

object

public static final byte[] object

Header "object "

type

public static final byte[] type

Header "type "

tag

public static final byte[] tag

Header "tag "

tagger

public static final byte[] tagger

Header "tagger "

Constructor Detail

ObjectChecker

public ObjectChecker()

Method Detail

setSkipList

public ObjectChecker setSkipList(@Nullable
                                 ObjectIdSet objects)

Enable accepting specific malformed (but not horribly broken) objects.

Parameters:

objects - collection of object names known to be broken in a non-fatal way that should be ignored by the checker.

Returns:

this

Since:

4.2

setIgnore

public ObjectChecker setIgnore(@Nullable
                               Set<ObjectChecker.ErrorType> ids)

Configure error types to be ignored across all objects.

Parameters:

ids - error types to ignore. The caller's set is copied.

Returns:

this

Since:

4.2

setIgnore

public ObjectChecker setIgnore(ObjectChecker.ErrorType id,
                               boolean ignore)

Add message type to be ignored across all objects.

Parameters:

id - error type to ignore.

ignore - true to ignore this error; false to treat the error as an error and throw.

Returns:

this

Since:

4.2

setAllowLeadingZeroFileMode

public ObjectChecker setAllowLeadingZeroFileMode(boolean allow)

Enable accepting leading zero mode in tree entries.

Some broken Git libraries generated leading zeros in the mode part of tree entries. This is technically incorrect but gracefully allowed by git-core. JGit rejects such trees by default, but may need to accept them on broken histories.

Same as setIgnore(ZERO_PADDED_FILEMODE, allow).

Parameters:

allow - allow leading zero mode.

Returns:

this.

Since:

3.4

setAllowInvalidPersonIdent

public ObjectChecker setAllowInvalidPersonIdent(boolean allow)

Enable accepting invalid author, committer and tagger identities.

Some broken Git versions/libraries allowed users to create commits and tags with invalid formatting between the name, email and timestamp.

Parameters:

allow - if true accept invalid person identity strings.

Returns:

this.

Since:

4.0

setSafeForWindows

public ObjectChecker setSafeForWindows(boolean win)

Restrict trees to only names legal on Windows platforms.

Also rejects any mixed case forms of reserved names (.git).

Parameters:

win - true if Windows name checking should be performed.

Returns:

this.

Since:

3.4

setSafeForMacOS

public ObjectChecker setSafeForMacOS(boolean mac)

Restrict trees to only names legal on Mac OS X platforms.

Rejects any mixed case forms of reserved names (.git) for users working on HFS+ in case-insensitive (default) mode.

Parameters:

mac - true if Mac OS X name checking should be performed.

Returns:

this.

Since:

3.4

check

public void check(int objType,
                  byte[] raw)
           throws CorruptObjectException

Check an object for parsing errors.

Parameters:

objType - type of the object. Must be a valid object type code in Constants.

raw - the raw data which comprises the object. This should be in the canonical format (that is the format used to generate the ObjectId of the object). The array is never modified.

Throws:

CorruptObjectException - if an error is identified.

check

public void check(@Nullable
                  AnyObjectId id,
                  int objType,
                  byte[] raw)
           throws CorruptObjectException

Check an object for parsing errors.

Parameters:

id - identify of the object being checked.

objType - type of the object. Must be a valid object type code in Constants.

raw - the raw data which comprises the object. This should be in the canonical format (that is the format used to generate the ObjectId of the object). The array is never modified.

Throws:

CorruptObjectException - if an error is identified.

Since:

4.2

checkCommit

public void checkCommit(byte[] raw)
                 throws CorruptObjectException

Check a commit for errors.

Parameters:

raw - the commit data. The array is never modified.

Throws:

CorruptObjectException - if any error was detected.

checkCommit

public void checkCommit(@Nullable
                        AnyObjectId id,
                        byte[] raw)
                 throws CorruptObjectException

Check a commit for errors.

Parameters:

id - identity of the object being checked.

raw - the commit data. The array is never modified.

Throws:

CorruptObjectException - if any error was detected.

Since:

4.2

checkTag

public void checkTag(byte[] raw)
              throws CorruptObjectException

Check an annotated tag for errors.

Parameters:

raw - the tag data. The array is never modified.

Throws:

CorruptObjectException - if any error was detected.

checkTag

public void checkTag(@Nullable
                     AnyObjectId id,
                     byte[] raw)
              throws CorruptObjectException

Check an annotated tag for errors.

Parameters:

id - identity of the object being checked.

raw - the tag data. The array is never modified.

Throws:

CorruptObjectException - if any error was detected.

Since:

4.2

checkTree

public void checkTree(byte[] raw)
               throws CorruptObjectException

Check a canonical formatted tree for errors.

Parameters:

raw - the raw tree data. The array is never modified.

Throws:

CorruptObjectException - if any error was detected.

checkTree

public void checkTree(@Nullable
                      AnyObjectId id,
                      byte[] raw)
               throws CorruptObjectException

Check a canonical formatted tree for errors.

Parameters:

id - identity of the object being checked.

raw - the raw tree data. The array is never modified.

Throws:

CorruptObjectException - if any error was detected.

Since:

4.2

checkPath

public void checkPath(String path)
               throws CorruptObjectException

Check tree path entry for validity.

Unlike checkPathSegment(byte[], int, int), this version scans a multi-directory path string such as "src/main.c".

Parameters:

path - path string to scan.

Throws:

CorruptObjectException - path is invalid.

Since:

3.6

checkPath

public void checkPath(byte[] raw,
                      int ptr,
                      int end)
               throws CorruptObjectException

Check tree path entry for validity.

Unlike checkPathSegment(byte[], int, int), this version scans a multi-directory path string such as "src/main.c".

Parameters:

raw - buffer to scan.

ptr - offset to first byte of the name.

end - offset to one past last byte of name.

Throws:

CorruptObjectException - path is invalid.

Since:

3.6

checkPathSegment

public void checkPathSegment(byte[] raw,
                             int ptr,
                             int end)
                      throws CorruptObjectException

Check tree path entry for validity.

Parameters:

raw - buffer to scan.

ptr - offset to first byte of the name.

end - offset to one past last byte of name.

Throws:

CorruptObjectException - name is invalid.

Since:

3.4

newBlobObjectChecker

@Nullable
public BlobObjectChecker newBlobObjectChecker()

Create a new BlobObjectChecker.

Returns:

new BlobObjectChecker or null if it's not provided.

Since:

4.9

checkBlob

public void checkBlob(byte[] raw)
               throws CorruptObjectException

Check a blob for errors.

This may not be called from PackParser in some cases. Use newBlobObjectChecker() instead.

Parameters:

raw - the blob data. The array is never modified.

Throws:

CorruptObjectException - if any error was detected.

getGitsubmodules

public List<GitmoduleEntry> getGitsubmodules()

Get the list of ".gitmodules" files found in the pack. For each, report its blob id (e.g. to validate its contents) and the tree where it was found (e.g. to check if it is in the root)

Returns:

List of pairs of ids <tree, blob>.

Since:

4.7.5

reset

public void reset()

Reset the invocation-specific state from this instance. Specifically this clears the list of .gitmodules files encountered (see getGitsubmodules()) Configurations like errors to filter, skip lists or the specified O.S. (set via setSafeForMacOS(boolean) or setSafeForWindows(boolean)) are NOT cleared.

Since:

5.2