fsrecord.h

/*
 * Copyright (c) 2018, Exile Heavy Industries
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted (subject to the limitations in the disclaimer
 * below) provided that the following conditions are met:
 * 
 * * Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 * 
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * 
 * * Neither the name of the copyright holder nor the names of its contributors may be used
 *   to endorse or promote products derived from this software without specific
 *   prior written permission.
 * 
 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS
 * LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 */

/* 
 * This file contains the forward declarations necessary for improved
 * boot environment tracking. It'll be stoshed in a SQLite3 database, 
 * stored in /usr/local/etc/dfbeadm/bootenv.data
 */

#define DFBEADM_RECORD_H
#ifndef DFBEADM_MAIN_H
#include "dfbeadm.h"
#endif

#include <sqlite3.h>

/* Define some useful data */
#define DFBEADM_CONFIG_DIR "/usr/local/etc/dfbeadm"
#define DFBEADM_RECORD_DB "bootenv.data"
#define DFBEADM_DB_PATHLEN 36
/* Planned for a future release */
#define DFBEADM_CONFIG_FILE "bootenvs.conf"
#define DFBEADM_BEINFO_TABLE "h2be"
/* Compile-time constants for database testing */
#define DFBEADM_APP_ID 999
#define DFBEADM_USR_VER 0;
/* 
 * Planning for some degree of backwards compatibility, 
 * allowing the database layout to change 
 */
#define DFBEADM_COMPAT_MIN 0;

/* 
 * Define enumeration values for the accepted hashing algorithms
 */
/* XXX: LibreSSL 2.9.1 only seems to support 0 and 4 */
typedef enum dfbeadm_hashspec_t {
	whirlpool = 0,
	sha3_512 = 1,
	blake2k512 = 2,
	shake256 = 3,
	sha2_512 = 4,
} hashspec;

/* Now the function declarations */
int connect_bedb(sqlite3 *dbptr);
int init_bedb(void);
int read_bedata(const char *belabel);
int write_bedata(bedata *bootenv);
int drop_bootenv(const char *belabal);
int testdb(const char *dbpath);