Compound File Binary Format: Difference between revisions

Revision as of 04:34, 8 July 2019

Latest revision as of 10:29, 11 May 2025

(8 intermediate revisions by 8 users not shown)

Line 1:

{{Short description|Compound document file format}}

'''Compound File Binary Format''' (CFBF), also called '''Compound File''', '''Compound Document format''',<ref>{{cite web|url=http://poi.apache.org/poifs/index.html|title=Apache POI - POIFS|work=|publisher=POI Project|accessdate=10 May 2011|date=|archive-url=https://web.archive.org/web/20110426150340/http://poi.apache.org/poifs/index.html|archive-date=26 April 2011|dead-url=yes}}</ref> or '''Composite Document File V2 Document'''<ref>{{cite web

{{Use dmy dates|date=NovemberDecember 20112019}}

'''Compound File Binary Format''' (CFBF), also called '''Compound File''', '''Compound Document format''',<ref>{{cite web|url=http://poi.apache.org/poifs/index.html|title=Apache POI -– POIFS|work=|publisher=POI Project|accessdate=10 May 2011|date=|archive-url=https://web.archive.org/web/20110426150340/http://poi.apache.org/poifs/index.html|archive-date=26 April 2011|deadurl-urlstatus=yesdead}}</ref> or '''Composite Document File V2 Document'''<ref>{{cite web

|url=https://linuxconfig.org/how-to-convert-documents-between-libreoffice-and-microsoft-office-file-formats-on-linux

|title= How to convert documents between LibreOffice and Microsoft Office file formats on Linux

|accessdate=25 November 2016

|accessdate=25 Nov 2016|date=}}</ref> (CDF), is a [[compound document|compound]] [[document file format]] for storing numerous files and streams within a single file on a disk. CFBF is developed by [[Microsoft]] and is an implementation of Microsoft [[COM Structured Storage]].<ref>{{cite web

|archive-url=https://web.archive.org/web/20190921163547/https://linuxconfig.org/how-to-convert-documents-between-libreoffice-and-microsoft-office-file-formats-on-linux

|archive-date=21 September 2019

|url-status=dead

|accessdate=25 Nov 2016|date=}}</ref> (CDF), is a [[compound document|compound]] [[document file format]] for storing numerous files and streams within a single file on a disk. CFBF is developed by [[Microsoft]] and is an implementation of Microsoft [[COM Structured Storage]].<ref>{{cite web

|url=http://msdn.microsoft.com/en-us/library/aa378938%28VS.85%29.aspx

|title=Compound Files (Windows)

|work=Microsoft Developers Network (MSDN) library – COM SDK|publisher=Microsoft Corporation|accessdate=23 September 2009|date=20 November 2008}}</ref><ref>{{cite web|url=http://msdn.microsoft.com/en-us/library/ydd3k45e.aspx|title=Containers: Compound Files|work=Microsoft Developers Network (MSDN) library – Visual Studio 2008 documentation|publisher=Microsoft Corporation|accessdate=23 September 2009}}</ref><ref>{{cite web|url=http://msdn.microsoft.com/en-us/library/cc542545%28VS.85%29.aspx|title=Understand Compound Files|work=Microsoft Developers Network (MSDN) library – ActiveDirectory Rights Management|accessdate=23 September 2009|date=25 June 2009}}</ref> The file format is used for storing storage objects and stream objects in a hierarchical structure within a single file.<ref>{{Cite web |date=2020-01-28 |title=Microsoft Compound File Binary File Format, Version 4 |url=https://www.loc.gov/preservation/digital/formats/fdd/fdd000392.shtml |access-date=2024-06-13 |website=www.loc.gov}}</ref>

Microsoft has opened the format for use by others and it is now used in a variety of programs from [[Microsoft Word]] and [[Microsoft Access]] to Business Objects.{{Citation needed|date=November 2009}} It also forms the basis of the [[Advanced Authoring Format]].<ref>[http://www.aafassociation.org AMW Association (formerly AAF Association)] {{webarchive|url=https://web.archive.org/web/20000815063147/http://www.aafassociation.org/ |date=15 August 2000 }}</ref>

Line 12 ⟶ 18:

At its simplest, the Compound File Binary Format is a container, with little restriction on what can be stored within it.

A CFBF file structure loosely resembles a [[File Allocation Table|FAT]] [[filesystemfile system]]. The file is partitioned into ''Sectors'' which are chained together with a ''File Allocation Table'' (not to be mistaken with the file system of the same name) which contains chains of sectors related to each file, a ''Directory'' holds information for contained files with a Sector ID (SID) for the starting sector of a chain and so on.

==Structure==

The CFBF file consists of a 512-Bytebyte header record followed by a number of sectorsSectors whose size is defined in the header. The literature defines Sectors to be either 512 or 4096 bytes in length, although the format is potentially capable of supporting sectors ranging in size from 128-Bytes bytes upwards, in powers of 2two (128, 256, 512, 1024, etc.). The lower limit of 128 is the minimum required to fit a single directory entry in a Directory Sector.{{Relevance inline|paragraph|reason=MS-CFB standard clearly says that a sector MUST be 512 or 4096, this sentence is encouraging to break the standard|date=November 2016}}

a Directory Sector.{{Relevance inline|paragraph|reason=MS-CFB standard clearly says that a sector MUST be 512 or 4096, this sentence is encouraging to break the standard|date=November 2016}}

There are several types of sector that may be present in a CFBF file:

* File Allocation Table (FAT) Sector -– contains chains of sector indices much as a FAT does in the FAT/FAT32 filesystems

* MiniFAT Sectors -– similar to the FAT but storing chains of mini-sectors within the Mini-Stream

* Double-Indirect FAT (DIFAT) Sector -– contains chains of FAT sector indices

* Directory Sector -– contains directory entries

* Stream Sector -– contains arbitrary file data

* Range Lock Sector -– contains the byte-range locking area of a large file

More detail is given below for the header and each sector type.

===CFBF Headerheader format===

The CFBF Headerheader occupies the first 512 bytes of the file and information required to interpret the rest of the file. The C-Stylestyle structure declaration below (extracted from the AAFA's Low-Level Container Specification) shows the members of the CFBF header and their purpose:

<sourcesyntaxhighlight lang="c">

typedef unsigned long ULONG; // 4 Bytesbytes

typedef unsigned short USHORT; // 2 Bytesbytes

typedef short OFFSET; // 2 Bytesbytes

typedef ULONG SECT; // 4 Bytesbytes

typedef ULONG FSINDEX; // 4 Bytesbytes

typedef USHORT FSOFFSET; // 2 Bytesbytes

typedef USHORT WCHAR; // 2 Bytesbytes

typedef ULONG DFSIGNATURE; // 4 Bytesbytes

typedef unsigned char BYTE; // 1 Bytebyte

typedef unsigned short WORD; // 2 Bytesbytes

typedef unsigned long DWORD; // 4 Bytesbytes

typedef ULONG SID; // 4 Bytesbytes

typedef GUID CLSID; // 16 Bytesbytes

struct StructuredStorageHeader { // [offset from start (bytes), length (bytes)]

BYTE _abSig[8]; // [00H,08] {0xd0, 0xcf, 0x11, 0xe0, 0xa1, 0xb1,

// 0x1a, 0xe1} for current version

CLSID _clsid; // [08H,16] reserved must be zero (WriteClassStg/

// GetClassFile uses root directory class id)

USHORT _uMinorVersion; // [18H,02] minor version of the format: 33 is

// written by reference implementation

USHORT _uDllVersion; // [1AH,02] major version of the dll/format: 3 for

// 512-byte sectors, 4 for 4 KB sectors

USHORT _uByteOrder; // [1CH,02] 0xFFFE: indicates Intel byte-ordering

USHORT _uSectorShift; // [1EH,02] size of sectors in power-of-two;

// typically 9 indicating 512-byte sectors

USHORT _uMiniSectorShift; // [20H,02] size of mini-sectors in power-of-two;

// typically 6 indicating 64-byte mini-sectors

USHORT _usReserved; // [22H,02] reserved, must be zero

ULONG _ulReserved1; // [24H,04] reserved, must be zero

FSINDEX _csectDir; // [28H,04] must be zero for 512-byte sectors,

// number of SECTs in directory chain for 4 KB

// sectors

FSINDEX _csectFat; // [2CH,04] number of SECTs in the FAT chain

SECT _sectDirStart; // [30H,04] first SECT in the directory chain

DFSIGNATURE _signature; // [34H,04] signature used for transactions; must

// be zero. The reference implementation

// does not support transactions

ULONG _ulMiniSectorCutoff; // [38H,04] maximum size for a mini stream;

// typically 4096 bytes

SECT _sectMiniFatStart; // [3CH,04] first SECT in the MiniFAT chain

FSINDEX _csectMiniFat; // [40H,04] number of SECTs in the MiniFAT chain

SECT _sectDifStart; // [44H,04] first SECT in the DIFAT chain

FSINDEX _csectDif; // [48H,04] number of SECTs in the DIFAT chain

SECT _sectFat[109]; // [4CH,436] the SECTs of first 109 FAT sectors

};

</syntaxhighlight>

</source>

===File Allocation Table (FAT) Sectorssectors===

When taken together as a single stream the collection of FAT sectors define the status and linkage of every sector in the file. Each entry in the FAT is 4 bytes in length and contains the sector number of the next sector in a FAT chain or one of the following special values:

* {{Mono|FREESECT}} ({{Mono|0xFFFFFFFF}}) -– denotes an unused sector

* {{Mono|ENDOFCHAIN}} ({{Mono|0xFFFFFFFE}}) -– marks the last sector in a FAT chain

* {{Mono|FATSECT}} ({{Mono|0xFFFFFFFD}}) -– marks a sector used to store part of the FAT

* {{Mono|DIFSECT}} ({{Mono|0xFFFFFFFC}}) -– marks a sector used to store part of the DIFAT

===Range Lock Sector===

{{Expand section|date=November 2009}}

The '''Range Lock Sector''' must exist in files greater than 2GB2&nbsp;GB in size, and must not exist in files smaller than 2GB2&nbsp;GB. The Range Lock Sector must contain the byte range {{Mono|0x7FFFFF00}} to {{Mono|0x7FFFFFFF}} in the file. This area is reserved by Microsoft's COM implementation for storing byte-range locking information for concurrent access.

===Glossary===

* ''FAT'' -– File Allocation Table,; also known as: ''SAT'' -– Sector Allocation Table

* ''DIFAT'' -– Double-Indirect File Allocation Table

* ''FAT Chain'' -– a group of FAT entries which indicate the sectorsSectors allocated to a Stream in the file

* ''Stream'' -– a virtual file which occupies a number of sectorsSectors within the CFBF

* ''Sector'' -– the unit of allocation within the CFBF, usually 512 or 4096 Bytes in length

==See also==

* [[COM Structured Storage|Structured Storage]]

* [[Advanced Authoring Format|Advanced Authoring Format]] (AAF)]]

* [[Cabinet (file format)]]

==References==

{{Reflist|2}}

==External links==

* {{cite web

| accessdate = 6 July 2019-07-06

| url = https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-cfb/53989ce4-7b05-4f8d-829b-d08d6148375b

| title = [MS-CFB]: Compound File Binary File Format

Line 116 ⟶ 121:

}}

* {{cite web

| accessdate = 2006-05-22 May 2006

| format = PDF

| url = http://sc.openoffice.org/compdocfileformat.pdf

| title = Microsoft Compound Document File Format

Line 123 ⟶ 128:

}}

* {{cite web

| accessdate = 2006-05-22 May 2006

| format = PDF

| url = http://www.amwa.tv/downloads/specifications/aafcontainerspec-v1.0.1.pdf

| title = Advanced Authoring Format Low-Level Container Specification

Line 130 ⟶ 134:

| archive-url = https://web.archive.org/web/20110809045600/http://www.amwa.tv/downloads/specifications/aafcontainerspec-v1.0.1.pdf

| archive-date = 9 August 2011

| dead-url-status = yesdead

}}

* {{cite web

| accessdate = 6 July 2019-07-06

| format = HTML

| url = https://www.loc.gov/preservation/digital/formats/fdd/fdd000380.shtml

| title = Microsoft Compound File Binary File Format, Version 3

| publisher = Library of Congress, Digital Formats web site

}}

{{Use dmy dates|date=November 2011}}

[[Category:Computer file formats]]