trustbridge: common/selftest.h annotate

annotate common/selftest.h @ 1331:8897c90b8166

(issue108) Remove generate_cppcheck and cppcheck target This did not work correctly. It is better just to manually execute cppcheck on the files as it gives you more control over the options.

author	Andre Heinecke <andre.heinecke@intevation.de>
date	Wed, 15 Oct 2014 13:24:59 +0200
parents	78798d3af8f0
children	28885e8c891f

rev	line source
634 80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	1 #ifndef COMMON_SELFTEST_H
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	2 #define COMMON_SELFTEST_H
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	3 /* Copyright (C) 2014 by Bundesamt für Sicherheit in der Informationstechnik
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	4 * Software engineering by Intevation GmbH
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	5 *
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	6 * This file is Free Software under the GNU GPL (v>=2)
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	7 * and comes with ABSOLUTELY NO WARRANTY!
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	8 * See LICENSE.txt for details.
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	9 */
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	10
1053 78798d3af8f0 Fixed doxygen build warnings. Emanuel Schuetze <emanuel@intevation.de> parents: 634 diff changeset	11 /**
78798d3af8f0 Fixed doxygen build warnings. Emanuel Schuetze <emanuel@intevation.de> parents: 634 diff changeset	12 * @file selftest.h
78798d3af8f0 Fixed doxygen build warnings. Emanuel Schuetze <emanuel@intevation.de> parents: 634 diff changeset	13 * @brief self test against manipulation
634 80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	14 *
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	15 * The selftest is intended to detect untargeted manipulation or
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	16 * corruption of the executable. Circumvention of the selftest
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	17 * by targeted manipulation of the binary can, of course, not
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	18 * be detected.
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	19 */
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	20
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	21 #include <stdbool.h>
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	22
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	23 #ifdef __cplusplus
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	24 extern "C" {
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	25 #endif
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	26 /** @brief check that the current process is signed by the correct certificate
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	27 *
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	28 * Checks that the certificate is signed with a valid signature and the
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	29 * builtin public certificate.
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	30 *
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	31 * @returns true if the selftest is successful. false on error.
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	32 */
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	33 bool selftest();
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	34
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	35 #ifdef __cplusplus
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	36 }
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	37 #endif
80d1a80b3e8d Factor out selftest for better test and reviewability Andre Heinecke <andre.heinecke@intevation.de> parents: diff changeset	38 #endif // COMMON_SELFTEST_H

Mercurial > trustbridge

annotate common/selftest.h @ 1331:8897c90b8166