1 /* $NetBSD: cdf.h,v 1.1.1.2 2011/05/12 20:46:55 christos Exp $ */ 2 3 /*- 4 * Copyright (c) 2008 Christos Zoulas 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 17 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 18 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 19 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 20 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 /* 29 * Parse Composite Document Files, the format used in Microsoft Office 30 * document files before they switched to zipped XML. 31 * Info from: http://sc.openoffice.org/compdocfileformat.pdf 32 * 33 * N.B. This is the "Composite Document File" format, and not the 34 * "Compound Document Format", nor the "Channel Definition Format". 35 */ 36 37 #ifndef _H_CDF_ 38 #define _H_CDF_ 39 40 #ifdef WIN32 41 #include <winsock2.h> 42 #define timespec timeval 43 #define tv_nsec tv_usec 44 #endif 45 #ifdef __DJGPP__ 46 #define timespec timeval 47 #define tv_nsec tv_usec 48 #endif 49 50 typedef int32_t cdf_secid_t; 51 52 #define CDF_LOOP_LIMIT 10000 53 54 #define CDF_SECID_NULL 0 55 #define CDF_SECID_FREE -1 56 #define CDF_SECID_END_OF_CHAIN -2 57 #define CDF_SECID_SECTOR_ALLOCATION_TABLE -3 58 #define CDF_SECID_MASTER_SECTOR_ALLOCATION_TABLE -4 59 60 typedef struct { 61 uint64_t h_magic; 62 #define CDF_MAGIC 0xE11AB1A1E011CFD0LL 63 uint64_t h_uuid[2]; 64 uint16_t h_revision; 65 uint16_t h_version; 66 uint16_t h_byte_order; 67 uint16_t h_sec_size_p2; 68 uint16_t h_short_sec_size_p2; 69 uint8_t h_unused0[10]; 70 uint32_t h_num_sectors_in_sat; 71 uint32_t h_secid_first_directory; 72 uint8_t h_unused1[4]; 73 uint32_t h_min_size_standard_stream; 74 cdf_secid_t h_secid_first_sector_in_short_sat; 75 uint32_t h_num_sectors_in_short_sat; 76 cdf_secid_t h_secid_first_sector_in_master_sat; 77 uint32_t h_num_sectors_in_master_sat; 78 cdf_secid_t h_master_sat[436/4]; 79 } cdf_header_t; 80 81 #define CDF_SEC_SIZE(h) (1 << (h)->h_sec_size_p2) 82 #define CDF_SEC_POS(h, secid) (CDF_SEC_SIZE(h) + (secid) * CDF_SEC_SIZE(h)) 83 #define CDF_SHORT_SEC_SIZE(h) (1 << (h)->h_short_sec_size_p2) 84 #define CDF_SHORT_SEC_POS(h, secid) ((secid) * CDF_SHORT_SEC_SIZE(h)) 85 86 typedef int32_t cdf_dirid_t; 87 #define CDF_DIRID_NULL -1 88 89 typedef int64_t cdf_timestamp_t; 90 #define CDF_BASE_YEAR 1601 91 #define CDF_TIME_PREC 10000000 92 93 typedef struct { 94 uint16_t d_name[32]; 95 uint16_t d_namelen; 96 uint8_t d_type; 97 #define CDF_DIR_TYPE_EMPTY 0 98 #define CDF_DIR_TYPE_USER_STORAGE 1 99 #define CDF_DIR_TYPE_USER_STREAM 2 100 #define CDF_DIR_TYPE_LOCKBYTES 3 101 #define CDF_DIR_TYPE_PROPERTY 4 102 #define CDF_DIR_TYPE_ROOT_STORAGE 5 103 uint8_t d_color; 104 #define CDF_DIR_COLOR_READ 0 105 #define CDF_DIR_COLOR_BLACK 1 106 cdf_dirid_t d_left_child; 107 cdf_dirid_t d_right_child; 108 cdf_dirid_t d_storage; 109 uint64_t d_storage_uuid[2]; 110 uint32_t d_flags; 111 cdf_timestamp_t d_created; 112 cdf_timestamp_t d_modified; 113 cdf_secid_t d_stream_first_sector; 114 uint32_t d_size; 115 uint32_t d_unused0; 116 } cdf_directory_t; 117 118 #define CDF_DIRECTORY_SIZE 128 119 120 typedef struct { 121 cdf_secid_t *sat_tab; 122 size_t sat_len; 123 } cdf_sat_t; 124 125 typedef struct { 126 cdf_directory_t *dir_tab; 127 size_t dir_len; 128 } cdf_dir_t; 129 130 typedef struct { 131 void *sst_tab; 132 size_t sst_len; 133 size_t sst_dirlen; 134 } cdf_stream_t; 135 136 typedef struct { 137 uint32_t cl_dword; 138 uint16_t cl_word[2]; 139 uint8_t cl_two[2]; 140 uint8_t cl_six[6]; 141 } cdf_classid_t; 142 143 typedef struct { 144 uint16_t si_byte_order; 145 uint16_t si_zero; 146 uint16_t si_os_version; 147 uint16_t si_os; 148 cdf_classid_t si_class; 149 uint32_t si_count; 150 } cdf_summary_info_header_t; 151 152 #define CDF_SECTION_DECLARATION_OFFSET 0x1c 153 154 typedef struct { 155 cdf_classid_t sd_class; 156 uint32_t sd_offset; 157 } cdf_section_declaration_t; 158 159 typedef struct { 160 uint32_t sh_len; 161 uint32_t sh_properties; 162 } cdf_section_header_t; 163 164 typedef struct { 165 uint32_t pi_id; 166 uint32_t pi_type; 167 union { 168 uint16_t _pi_u16; 169 int16_t _pi_s16; 170 uint32_t _pi_u32; 171 int32_t _pi_s32; 172 uint64_t _pi_u64; 173 int64_t _pi_s64; 174 cdf_timestamp_t _pi_tp; 175 struct { 176 uint32_t s_len; 177 const char *s_buf; 178 } _pi_str; 179 } pi_val; 180 #define pi_u64 pi_val._pi_u64 181 #define pi_s64 pi_val._pi_s64 182 #define pi_u32 pi_val._pi_u32 183 #define pi_s32 pi_val._pi_s32 184 #define pi_u16 pi_val._pi_u16 185 #define pi_s16 pi_val._pi_s16 186 #define pi_tp pi_val._pi_tp 187 #define pi_str pi_val._pi_str 188 } cdf_property_info_t; 189 190 #define CDF_ROUND(val, by) (((val) + (by) - 1) & ~((by) - 1)) 191 192 /* Variant type definitions */ 193 #define CDF_EMPTY 0x00000000 194 #define CDF_NULL 0x00000001 195 #define CDF_SIGNED16 0x00000002 196 #define CDF_SIGNED32 0x00000003 197 #define CDF_FLOAT 0x00000004 198 #define CDF_DOUBLE 0x00000005 199 #define CDF_CY 0x00000006 200 #define CDF_DATE 0x00000007 201 #define CDF_BSTR 0x00000008 202 #define CDF_DISPATCH 0x00000009 203 #define CDF_ERROR 0x0000000a 204 #define CDF_BOOL 0x0000000b 205 #define CDF_VARIANT 0x0000000c 206 #define CDF_UNKNOWN 0x0000000d 207 #define CDF_DECIMAL 0x0000000e 208 #define CDF_SIGNED8 0x00000010 209 #define CDF_UNSIGNED8 0x00000011 210 #define CDF_UNSIGNED16 0x00000012 211 #define CDF_UNSIGNED32 0x00000013 212 #define CDF_SIGNED64 0x00000014 213 #define CDF_UNSIGNED64 0x00000015 214 #define CDF_INT 0x00000016 215 #define CDF_UINT 0x00000017 216 #define CDF_VOID 0x00000018 217 #define CDF_HRESULT 0x00000019 218 #define CDF_PTR 0x0000001a 219 #define CDF_SAFEARRAY 0x0000001b 220 #define CDF_CARRAY 0x0000001c 221 #define CDF_USERDEFINED 0x0000001d 222 #define CDF_LENGTH32_STRING 0x0000001e 223 #define CDF_LENGTH32_WSTRING 0x0000001f 224 #define CDF_FILETIME 0x00000040 225 #define CDF_BLOB 0x00000041 226 #define CDF_STREAM 0x00000042 227 #define CDF_STORAGE 0x00000043 228 #define CDF_STREAMED_OBJECT 0x00000044 229 #define CDF_STORED_OBJECT 0x00000045 230 #define CDF_BLOB_OBJECT 0x00000046 231 #define CDF_CLIPBOARD 0x00000047 232 #define CDF_CLSID 0x00000048 233 #define CDF_VECTOR 0x00001000 234 #define CDF_ARRAY 0x00002000 235 #define CDF_BYREF 0x00004000 236 #define CDF_RESERVED 0x00008000 237 #define CDF_ILLEGAL 0x0000ffff 238 #define CDF_ILLEGALMASKED 0x00000fff 239 #define CDF_TYPEMASK 0x00000fff 240 241 #define CDF_PROPERTY_CODE_PAGE 0x00000001 242 #define CDF_PROPERTY_TITLE 0x00000002 243 #define CDF_PROPERTY_SUBJECT 0x00000003 244 #define CDF_PROPERTY_AUTHOR 0x00000004 245 #define CDF_PROPERTY_KEYWORDS 0x00000005 246 #define CDF_PROPERTY_COMMENTS 0x00000006 247 #define CDF_PROPERTY_TEMPLATE 0x00000007 248 #define CDF_PROPERTY_LAST_SAVED_BY 0x00000008 249 #define CDF_PROPERTY_REVISION_NUMBER 0x00000009 250 #define CDF_PROPERTY_TOTAL_EDITING_TIME 0x0000000a 251 #define CDF_PROPERTY_LAST_PRINTED 0X0000000b 252 #define CDF_PROPERTY_CREATE_TIME 0x0000000c 253 #define CDF_PROPERTY_LAST_SAVED_TIME 0x0000000d 254 #define CDF_PROPERTY_NUMBER_OF_PAGES 0x0000000e 255 #define CDF_PROPERTY_NUMBER_OF_WORDS 0x0000000f 256 #define CDF_PROPERTY_NUMBER_OF_CHARACTERS 0x00000010 257 #define CDF_PROPERTY_THUMBNAIL 0x00000011 258 #define CDF_PROPERTY_NAME_OF_APPLICATION 0x00000012 259 #define CDF_PROPERTY_SECURITY 0x00000013 260 #define CDF_PROPERTY_LOCALE_ID 0x80000000 261 262 typedef struct { 263 int i_fd; 264 const unsigned char *i_buf; 265 size_t i_len; 266 } cdf_info_t; 267 268 struct timespec; 269 int cdf_timestamp_to_timespec(struct timespec *, cdf_timestamp_t); 270 int cdf_timespec_to_timestamp(cdf_timestamp_t *, const struct timespec *); 271 int cdf_read_header(const cdf_info_t *, cdf_header_t *); 272 void cdf_swap_header(cdf_header_t *); 273 void cdf_unpack_header(cdf_header_t *, char *); 274 void cdf_swap_dir(cdf_directory_t *); 275 void cdf_unpack_dir(cdf_directory_t *, char *); 276 void cdf_swap_class(cdf_classid_t *); 277 ssize_t cdf_read_sector(const cdf_info_t *, void *, size_t, size_t, 278 const cdf_header_t *, cdf_secid_t); 279 ssize_t cdf_read_short_sector(const cdf_stream_t *, void *, size_t, size_t, 280 const cdf_header_t *, cdf_secid_t); 281 int cdf_read_sat(const cdf_info_t *, cdf_header_t *, cdf_sat_t *); 282 size_t cdf_count_chain(const cdf_sat_t *, cdf_secid_t, size_t); 283 int cdf_read_long_sector_chain(const cdf_info_t *, const cdf_header_t *, 284 const cdf_sat_t *, cdf_secid_t, size_t, cdf_stream_t *); 285 int cdf_read_short_sector_chain(const cdf_header_t *, const cdf_sat_t *, 286 const cdf_stream_t *, cdf_secid_t, size_t, cdf_stream_t *); 287 int cdf_read_sector_chain(const cdf_info_t *, const cdf_header_t *, 288 const cdf_sat_t *, const cdf_sat_t *, const cdf_stream_t *, cdf_secid_t, 289 size_t, cdf_stream_t *); 290 int cdf_read_dir(const cdf_info_t *, const cdf_header_t *, const cdf_sat_t *, 291 cdf_dir_t *); 292 int cdf_read_ssat(const cdf_info_t *, const cdf_header_t *, const cdf_sat_t *, 293 cdf_sat_t *); 294 int cdf_read_short_stream(const cdf_info_t *, const cdf_header_t *, 295 const cdf_sat_t *, const cdf_dir_t *, cdf_stream_t *); 296 int cdf_read_property_info(const cdf_stream_t *, const cdf_header_t *, uint32_t, 297 cdf_property_info_t **, size_t *, size_t *); 298 int cdf_read_summary_info(const cdf_info_t *, const cdf_header_t *, 299 const cdf_sat_t *, const cdf_sat_t *, const cdf_stream_t *, 300 const cdf_dir_t *, cdf_stream_t *); 301 int cdf_unpack_summary_info(const cdf_stream_t *, const cdf_header_t *, 302 cdf_summary_info_header_t *, cdf_property_info_t **, size_t *); 303 int cdf_print_classid(char *, size_t, const cdf_classid_t *); 304 int cdf_print_property_name(char *, size_t, uint32_t); 305 int cdf_print_elapsed_time(char *, size_t, cdf_timestamp_t); 306 uint16_t cdf_tole2(uint16_t); 307 uint32_t cdf_tole4(uint32_t); 308 uint64_t cdf_tole8(uint64_t); 309 char *cdf_ctime(const time_t *); 310 311 #ifdef CDF_DEBUG 312 void cdf_dump_header(const cdf_header_t *); 313 void cdf_dump_sat(const char *, const cdf_sat_t *, size_t); 314 void cdf_dump(void *, size_t); 315 void cdf_dump_stream(const cdf_header_t *, const cdf_stream_t *); 316 void cdf_dump_dir(const cdf_info_t *, const cdf_header_t *, const cdf_sat_t *, 317 const cdf_sat_t *, const cdf_stream_t *, const cdf_dir_t *); 318 void cdf_dump_property_info(const cdf_property_info_t *, size_t); 319 void cdf_dump_summary_info(const cdf_header_t *, const cdf_stream_t *); 320 #endif 321 322 323 #endif /* _H_CDF_ */ 324