Package org.apache.pdfbox.pdfparser
Class COSParser
- java.lang.Object
-
- org.apache.pdfbox.pdfparser.BaseParser
-
- org.apache.pdfbox.pdfparser.COSParser
-
- All Implemented Interfaces:
ICOSParser
- Direct Known Subclasses:
BruteForceParser,FDFParser,PDFParser
public class COSParser extends BaseParser implements ICOSParser
COS-Parser which first reads startxref and xref tables in order to know valid objects and parse only these objects. This class is a much enhanced version ofQuickParserpresented in PDFBOX-1104 by Jeremy Villalobos.
-
-
Field Summary
Fields Modifier and Type Field Description protected static char[]EOF_MARKEREOF-marker.protected longfileLenfile length.protected booleaninitialParseDoneprotected static char[]OBJ_MARKERobj-marker.protected SecurityHandler<? extends ProtectionPolicy>securityHandlerThe security handler.static java.lang.StringSYSPROP_EOFLOOKUPRANGEThe range within the %%EOF marker will be searched.protected XrefTrailerResolverxrefTrailerResolverCollects all Xref/trailer objects and resolves them into single object using startxref reference.-
Fields inherited from class org.apache.pdfbox.pdfparser.BaseParser
A, ASCII_CR, ASCII_LF, B, D, DEF, document, E, ENDOBJ_STRING, ENDSTREAM_STRING, J, M, N, O, R, S, source, STREAM_STRING, T
-
-
Constructor Summary
Constructors Constructor Description COSParser(org.apache.pdfbox.io.RandomAccessRead source)Default constructor.COSParser(org.apache.pdfbox.io.RandomAccessRead source, java.lang.String password, java.io.InputStream keyStore, java.lang.String keyAlias)Constructor for encrypted pdfs.COSParser(org.apache.pdfbox.io.RandomAccessRead source, java.lang.String password, java.io.InputStream keyStore, java.lang.String keyAlias, org.apache.pdfbox.io.RandomAccessStreamCache.StreamCacheCreateFunction streamCacheCreateFunction)Constructor for encrypted pdfs.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidcheckPages(COSDictionary root)Check if all entries of the pages dictionary are present.org.apache.pdfbox.io.RandomAccessReadViewcreateRandomAccessReadView(long startPosition, long streamLength)Creates a random access read view starting at the given position with the given length.COSBasedereferenceCOSObject(COSObject obj)Dereference the COSBase object which is referenced by the given COSObject.protected AccessPermissiongetAccessPermission()This will get the AccessPermission.protected PDEncryptiongetEncryption()This will get the encryption dictionary.booleanisLenient()Return true if parser is lenient.protected booleanisString(char[] string)Checks if the given string can be found at the current offset.protected intlastIndexOf(char[] pattern, byte[] buf, int endOff)Searches last appearance of pattern within buffer.protected COSStreamparseCOSStream(COSDictionary dic)This will read a COSStream from the input stream using length attribute within dictionary.protected booleanparseFDFHeader()Parse the header of a fdf.protected COSBaseparseObjectDynamically(COSObjectKey objKey, boolean requireExistingNotCompressedObj)Parse the object for the given object key.protected COSBaseparseObjectStreamObject(long objstmObjNr, COSObjectKey key)Parse the object with the given key from the object stream with the given number.protected booleanparsePDFHeader()Parse the header of a pdf.protected booleanparseXrefTable(long startByteOffset)This will parse the xref table from the stream and add it to the state The XrefTable contents are ignored.protected voidprepareDecryption()Prepare for decryption.protected booleanresetTrailerResolver()Indicates whether the xref trailer resolver should be reset or not.protected COSDictionaryretrieveTrailer()Read the trailer information and provide a COSDictionary containing the trailer information.voidsetEOFLookupRange(int byteCount)Sets how many trailing bytes of PDF file are searched for EOF marker and 'startxref' marker.protected voidsetLenient(boolean lenient)Change the parser leniency flag.-
Methods inherited from class org.apache.pdfbox.pdfparser.BaseParser
getObjectKey, isClosing, isClosing, isDigit, isDigit, isEndOfName, isEOF, isEOL, isEOL, isSpace, isSpace, isWhitespace, isWhitespace, parseCOSArray, parseCOSDictionary, parseCOSName, parseCOSString, parseDirObject, readExpectedChar, readExpectedString, readGenerationNumber, readInt, readLine, readLong, readObjectNumber, readString, readString, readStringNumber, skipLinebreak, skipSpaces, skipWhiteSpaces
-
-
-
-
Field Detail
-
SYSPROP_EOFLOOKUPRANGE
public static final java.lang.String SYSPROP_EOFLOOKUPRANGE
The range within the %%EOF marker will be searched. Useful if there are additional characters after %%EOF within the PDF.- See Also:
- Constant Field Values
-
EOF_MARKER
protected static final char[] EOF_MARKER
EOF-marker.
-
OBJ_MARKER
protected static final char[] OBJ_MARKER
obj-marker.
-
fileLen
protected long fileLen
file length.
-
initialParseDone
protected boolean initialParseDone
-
securityHandler
protected SecurityHandler<? extends ProtectionPolicy> securityHandler
The security handler.
-
xrefTrailerResolver
protected XrefTrailerResolver xrefTrailerResolver
Collects all Xref/trailer objects and resolves them into single object using startxref reference.
-
-
Constructor Detail
-
COSParser
public COSParser(org.apache.pdfbox.io.RandomAccessRead source) throws java.io.IOExceptionDefault constructor.- Parameters:
source- input representing the pdf.- Throws:
java.io.IOException- if something went wrong
-
COSParser
public COSParser(org.apache.pdfbox.io.RandomAccessRead source, java.lang.String password, java.io.InputStream keyStore, java.lang.String keyAlias) throws java.io.IOExceptionConstructor for encrypted pdfs.- Parameters:
source- input representing the pdf.password- password to be used for decryption.keyStore- key store to be used for decryption when using public key securitykeyAlias- alias to be used for decryption when using public key security- Throws:
java.io.IOException- if the source data could not be read
-
COSParser
public COSParser(org.apache.pdfbox.io.RandomAccessRead source, java.lang.String password, java.io.InputStream keyStore, java.lang.String keyAlias, org.apache.pdfbox.io.RandomAccessStreamCache.StreamCacheCreateFunction streamCacheCreateFunction) throws java.io.IOExceptionConstructor for encrypted pdfs.- Parameters:
source- input representing the pdf.password- password to be used for decryption.keyStore- key store to be used for decryption when using public key securitykeyAlias- alias to be used for decryption when using public key securitystreamCacheCreateFunction- a function to create an instance of the stream cache- Throws:
java.io.IOException- if the source data could not be read
-
-
Method Detail
-
setEOFLookupRange
public void setEOFLookupRange(int byteCount)
Sets how many trailing bytes of PDF file are searched for EOF marker and 'startxref' marker. If not set we use default valueDEFAULT_TRAIL_BYTECOUNT.We check that new value is at least 16. However for practical use cases this value should not be lower than 1000; even 2000 was found to not be enough in some cases where some trailing garbage like HTML snippets followed the EOF marker.
In case system property
SYSPROP_EOFLOOKUPRANGEis defined this value will be set on initialization but can be overwritten later.- Parameters:
byteCount- number of trailing bytes
-
retrieveTrailer
protected COSDictionary retrieveTrailer() throws java.io.IOException
Read the trailer information and provide a COSDictionary containing the trailer information.- Returns:
- a COSDictionary containing the trailer information
- Throws:
java.io.IOException- if something went wrong
-
resetTrailerResolver
protected boolean resetTrailerResolver()
Indicates whether the xref trailer resolver should be reset or not. Should be overwritten if the xref trailer resolver is needed after the initial parsing.- Returns:
- true if the xref trailer resolver should be reset
-
lastIndexOf
protected int lastIndexOf(char[] pattern, byte[] buf, int endOff)Searches last appearance of pattern within buffer. Lookup before _lastOff and goes back until 0.- Parameters:
pattern- pattern to search forbuf- buffer to search pattern inendOff- offset (exclusive) where lookup starts at- Returns:
- start offset of pattern within buffer or
-1if pattern could not be found
-
isLenient
public boolean isLenient()
Return true if parser is lenient. Meaning auto healing capacity of the parser are used.- Returns:
- true if parser is lenient
-
setLenient
protected void setLenient(boolean lenient)
Change the parser leniency flag. This method can only be called before the parsing of the file.- Parameters:
lenient- try to handle malformed PDFs.
-
dereferenceCOSObject
public COSBase dereferenceCOSObject(COSObject obj) throws java.io.IOException
Description copied from interface:ICOSParserDereference the COSBase object which is referenced by the given COSObject.- Specified by:
dereferenceCOSObjectin interfaceICOSParser- Parameters:
obj- the COSObject which references the COSBase object to be dereferenced.- Returns:
- the referenced object
- Throws:
java.io.IOException- if something went wrong when dereferencing the COSBase object
-
createRandomAccessReadView
public org.apache.pdfbox.io.RandomAccessReadView createRandomAccessReadView(long startPosition, long streamLength) throws java.io.IOExceptionDescription copied from interface:ICOSParserCreates a random access read view starting at the given position with the given length.- Specified by:
createRandomAccessReadViewin interfaceICOSParser- Parameters:
startPosition- start position within the underlying random access readstreamLength- stream length- Returns:
- the random access read view
- Throws:
java.io.IOException- if something went wrong when creating the view for the RandomAccessRead
-
parseObjectDynamically
protected COSBase parseObjectDynamically(COSObjectKey objKey, boolean requireExistingNotCompressedObj) throws java.io.IOException
Parse the object for the given object key.- Parameters:
objKey- key of object to be parsedrequireExistingNotCompressedObj- iftruethe object to be parsed must be defined in xref (comment: null objects may be missing from xref) and it must not be a compressed object within object stream (this is used to circumvent being stuck in a loop in a malicious PDF)- Returns:
- the parsed object (which is also added to document object)
- Throws:
java.io.IOException- If an IO error occurs.
-
parseObjectStreamObject
protected COSBase parseObjectStreamObject(long objstmObjNr, COSObjectKey key) throws java.io.IOException
Parse the object with the given key from the object stream with the given number.- Parameters:
objstmObjNr- the number of the offset streamkey- the key of the object to be parsed- Returns:
- the parsed object
- Throws:
java.io.IOException- if something went wrong when parsing the object
-
parseCOSStream
protected COSStream parseCOSStream(COSDictionary dic) throws java.io.IOException
This will read a COSStream from the input stream using length attribute within dictionary. If length attribute is a indirect reference it is first resolved to get the stream length. This means we copy stream data without testing for 'endstream' or 'endobj' and thus it is no problem if these keywords occur within stream. We require 'endstream' to be found after stream data is read.- Parameters:
dic- dictionary that goes with this stream.- Returns:
- parsed pdf stream.
- Throws:
java.io.IOException- if an error occurred reading the stream, like problems with reading length attribute, stream does not end with 'endstream' after data read, stream too short etc.
-
checkPages
protected void checkPages(COSDictionary root) throws java.io.IOException
Check if all entries of the pages dictionary are present. Those which can't be dereferenced are removed.- Parameters:
root- the root dictionary of the pdf- Throws:
java.io.IOException- if the page tree root is null
-
isString
protected boolean isString(char[] string) throws java.io.IOExceptionChecks if the given string can be found at the current offset.- Parameters:
string- the bytes of the string to look for- Returns:
- true if the bytes are in place, false if not
- Throws:
java.io.IOException- if something went wrong
-
parsePDFHeader
protected boolean parsePDFHeader() throws java.io.IOExceptionParse the header of a pdf.- Returns:
- true if a PDF header was found
- Throws:
java.io.IOException- if something went wrong
-
parseFDFHeader
protected boolean parseFDFHeader() throws java.io.IOExceptionParse the header of a fdf.- Returns:
- true if a FDF header was found
- Throws:
java.io.IOException- if something went wrong
-
parseXrefTable
protected boolean parseXrefTable(long startByteOffset) throws java.io.IOExceptionThis will parse the xref table from the stream and add it to the state The XrefTable contents are ignored.- Parameters:
startByteOffset- the offset to start at- Returns:
- false on parsing error
- Throws:
java.io.IOException- If an IO error occurs.
-
getEncryption
protected PDEncryption getEncryption() throws java.io.IOException
This will get the encryption dictionary. The document must be parsed before this is called.- Returns:
- The encryption dictionary of the document that was parsed.
- Throws:
java.io.IOException- If there is an error getting the document.
-
getAccessPermission
protected AccessPermission getAccessPermission() throws java.io.IOException
This will get the AccessPermission. The document must be parsed before this is called.- Returns:
- The access permission of document that was parsed.
- Throws:
java.io.IOException- If there is an error getting the document.
-
prepareDecryption
protected void prepareDecryption() throws java.io.IOExceptionPrepare for decryption.- Throws:
InvalidPasswordException- If the password is incorrect.java.io.IOException- if something went wrong
-
-