156 lines
5.2 KiB
C
156 lines
5.2 KiB
C
/*
|
|
* Copyright (C) 2011-2014 Andreas Steffen
|
|
* HSR Hochschule fuer Technik Rapperswil
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License as published by the
|
|
* Free Software Foundation; either version 2 of the License, or (at your
|
|
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
|
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
* for more details.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup pts_database pts_database
|
|
* @{ @ingroup pts
|
|
*/
|
|
|
|
#ifndef PTS_DATABASE_H_
|
|
#define PTS_DATABASE_H_
|
|
|
|
typedef struct pts_database_t pts_database_t;
|
|
|
|
#include "pts_meas_algo.h"
|
|
#include "components/pts_comp_func_name.h"
|
|
|
|
#include <imv/imv_database.h>
|
|
#include <library.h>
|
|
|
|
/**
|
|
* Class implementing the PTS File Measurement database
|
|
*
|
|
*/
|
|
struct pts_database_t {
|
|
|
|
/**
|
|
* Get absolute pathname for file or directory measurement
|
|
*
|
|
* @param is_dir TRUE if dir, FALSE if file
|
|
* @param id Primary key into directories or files table
|
|
* @return Absolute pathname as a text string
|
|
*/
|
|
char* (*get_pathname)(pts_database_t *this, bool is_dir, int id);
|
|
|
|
/**
|
|
* Get stored measurement hash for single file or directory entries
|
|
*
|
|
* @param pid Primary key of software product in database
|
|
* @param algo Hash algorithm used for measurement
|
|
* @param is_dir TRUE if directory was measured
|
|
* @param id Primary key of measured file/directory
|
|
* @return Enumerator over all matching measurement hashes
|
|
*/
|
|
enumerator_t* (*create_file_hash_enumerator)(pts_database_t *this,
|
|
int pid, pts_meas_algorithms_t algo,
|
|
bool is_dir, int id);
|
|
|
|
/**
|
|
* Add PTS file measurement reference value
|
|
*
|
|
* @param pid Primary key of software product in database
|
|
* @param algo File measurement hash algorithm used
|
|
* @param measurement File measurement hash
|
|
* @param filename Optional name of the file to be checked
|
|
* @param is_dir TRUE if part of directory measurement
|
|
* @param id Primary key into direcories/files table
|
|
* @return Status
|
|
*/
|
|
status_t (*add_file_measurement)(pts_database_t *this, int pid,
|
|
pts_meas_algorithms_t algo,
|
|
chunk_t measurement, char *filename,
|
|
bool is_dir, int id);
|
|
|
|
/**
|
|
* Get PTS measurement[s] for a given filename stored in database
|
|
*
|
|
* @param pid Primary key of software product in database
|
|
* @param algo File measurement hash algorithm used
|
|
* @param filename Name of the file to be checked
|
|
* @return Enumerator over all matching measurement hashes
|
|
*/
|
|
enumerator_t* (*create_file_meas_enumerator)(pts_database_t *this, int pid,
|
|
pts_meas_algorithms_t algo,
|
|
char *filename);
|
|
|
|
/**
|
|
* Check a functional component measurement against value stored in database
|
|
*
|
|
* @param measurement measurement hash
|
|
* @param cid Primary key of Component Functional Name entry
|
|
* @param aik_id Primary key of AIK entry in database
|
|
* @param seq_no Measurement sequence number
|
|
* @param prc Number of the PCR the measurement was extended into
|
|
* @param algo Hash algorithm used for measurement
|
|
* @return SUCCESS if check was successful
|
|
*/
|
|
status_t (*check_comp_measurement)(pts_database_t *this, chunk_t measurement,
|
|
int cid, int aik_id, int seq_no, int pcr,
|
|
pts_meas_algorithms_t algo);
|
|
|
|
/**
|
|
* Insert a functional component measurement into the database
|
|
*
|
|
* @param measurement Measurement hash
|
|
* @param cid Primary key of Component Functional Name entry
|
|
* @param aik_id Primary key of AIK entry in database
|
|
* @param seq_no Measurement sequence number
|
|
* @param prc Number of the PCR the measurement was extended into
|
|
* @param algo Hash algorithm used for measurement
|
|
* @return SUCCESS if INSERT was successful
|
|
*/
|
|
status_t (*insert_comp_measurement)(pts_database_t *this, chunk_t measurement,
|
|
int cid, int aik_id, int seq_no, int pcr,
|
|
pts_meas_algorithms_t algo);
|
|
|
|
/**
|
|
* Delete functional component measurements from the database
|
|
*
|
|
* @param cid Primary key of Component Functional Name entry
|
|
* @param aik_id Primary key of AIK entry in database
|
|
* @return number of deleted measurement entries
|
|
*/
|
|
int (*delete_comp_measurements)(pts_database_t *this, int cid, int aik_id);
|
|
|
|
/**
|
|
* Get the number of measurements for a functional component and AIK
|
|
*
|
|
* @param comp_name Component Functional Name
|
|
* @param aik_id Primary key of AIK entry in database
|
|
* @param algo Hash algorithm used for measurement
|
|
* @param cid Primary key of Component Functional Name entry
|
|
* @param count measurement count
|
|
* @return SUCCESS if COUNT was successful
|
|
*/
|
|
status_t (*get_comp_measurement_count)(pts_database_t *this,
|
|
pts_comp_func_name_t *comp_name, int aik_id,
|
|
pts_meas_algorithms_t algo, int *cid, int *count);
|
|
|
|
/**
|
|
* Destroys a pts_database_t object.
|
|
*/
|
|
void (*destroy)(pts_database_t *this);
|
|
|
|
};
|
|
|
|
/**
|
|
* Creates an pts_database_t object
|
|
*
|
|
* @param imv_db Already attached IMV database
|
|
*/
|
|
pts_database_t* pts_database_create(imv_database_t *imv_db);
|
|
|
|
#endif /** PTS_DATABASE_H_ @}*/
|