mar.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim:set ts=2 sw=2 sts=2 et cindent: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
#ifndef MAR_H__
#define MAR_H__
 
#include "mozilla/Assertions.h"
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* We have a MAX_SIGNATURES limit so that an invalid MAR will never
 * waste too much of either updater's or signmar's time.
 * It is also used at various places internally and will affect memory usage.
 * If you want to increase this value above 9 then you need to adjust parsing
 * code in tool/mar.c.
*/
#define MAX_SIGNATURES 8
#ifdef __cplusplus
static_assert(MAX_SIGNATURES <= 9, "too many signatures");
#else
MOZ_STATIC_ASSERT(MAX_SIGNATURES <= 9, "too many signatures");
#endif
 
struct ProductInformationBlock {
  const char *MARChannelID;
  const char *productVersion;
};
 
typedef struct MarItem_ {
  struct MarItem_ *next;  /* private field */
  uint32_t offset;        /* offset into archive */
  uint32_t length;        /* length of data in bytes */
  uint32_t flags;         /* contains file mode bits */
  char name[1];           /* file path */
} MarItem;
 
#define TABLESIZE 256
 
struct MarFile_ {
  FILE *fp;
  MarItem *item_table[TABLESIZE];
};
 
typedef struct MarFile_ MarFile;
 
typedef int (* MarItemCallback)(MarFile *mar, const MarItem *item, void *data);
 
MarFile *mar_open(const char *path);
 
#ifdef _WIN32
MarFile *mar_wopen(const wchar_t *path);
#endif
 
void mar_close(MarFile *mar);
 
const MarItem *mar_find_item(MarFile *mar, const char *item);
 
int mar_enum_items(MarFile *mar, MarItemCallback callback, void *data);
 
int mar_read(MarFile *mar, const MarItem *item, int offset, char *buf,
             int bufsize);
 
int mar_create(const char *dest,
               int numfiles,
               char **files,
               struct ProductInformationBlock *infoBlock);
 
int mar_extract(const char *path);
 
#define MAR_MAX_CERT_SIZE (16*1024) // Way larger than necessary
 
/* Read the entire file (not a MAR file) into a newly-allocated buffer.
 * This function does not write to stderr. Instead, the caller should
 * write whatever error messages it sees fit. The caller must free the returned
 * buffer using free().
 *
 * @param filePath The path to the file that should be read.
 * @param maxSize  The maximum valid file size.
 * @param data     On success, *data will point to a newly-allocated buffer
 *                 with the file's contents in it.
 * @param size     On success, *size will be the size of the created buffer.
 *
 * @return 0 on success, -1 on error
 */
int mar_read_entire_file(const char * filePath,
                         uint32_t maxSize,
                         /*out*/ const uint8_t * *data,
                         /*out*/ uint32_t *size);
 
int mar_verify_signatures(MarFile *mar,
                          const uint8_t * const *certData,
                          const uint32_t *certDataSizes,
                          uint32_t certCount);
 
int
mar_read_product_info_block(MarFile *mar,
                            struct ProductInformationBlock *infoBlock);
 
#ifdef __cplusplus
}
#endif
 
#endif  /* MAR_H__ */