From a0cd614bf317e430418ba9f2ad851c6fecd2bf79 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc=20W=C3=A4ckerlin?= Date: Wed, 29 Sep 2010 11:19:03 +0000 Subject: [PATCH] first cleanup; still missing: RPM/Debian packages, pkgconfig, version compiled-in-version-info; refs #7 --- openssl-act-engine/AUTHORS | 1 + openssl-act-engine/COPYING | 1 + openssl-act-engine/ChangeLog | 0 openssl-act-engine/INSTALL | 1 + openssl-act-engine/Makefile | 40 - openssl-act-engine/NEWS | 0 openssl-act-engine/README | 4 + openssl-act-engine/ReadMe.txt | 82 +- openssl-act-engine/USING_ENGINE_act.txt | 150 +- openssl-act-engine/bootstrap.sh | 19 + openssl-act-engine/configure.in | 119 ++ openssl-act-engine/default.vs2008.vsprops | 22 +- openssl-act-engine/doc/doxyfile.in | 1518 +++++++++++++++++ openssl-act-engine/doc/makefile.am | 47 + openssl-act-engine/engine_securetoken.sln | 48 +- openssl-act-engine/engine_securetoken.vcproj | 714 ++++---- openssl-act-engine/{ => src}/CardKey.cpp | 0 openssl-act-engine/{ => src}/CardKey.h | 0 openssl-act-engine/{ => src}/CardObject.cpp | 0 openssl-act-engine/{ => src}/CardObject.h | 0 .../{ => src}/CertificateList.cpp | 0 .../{ => src}/CertificateList.h | 0 openssl-act-engine/{ => src}/Init_Engine.h | 450 ++--- openssl-act-engine/{ => src}/SecOpGuard.cpp | 0 openssl-act-engine/{ => src}/SecOpGuard.h | 0 openssl-act-engine/{ => src}/SlotList.cpp | 0 openssl-act-engine/{ => src}/SlotList.h | 0 openssl-act-engine/{ => src}/SyncObject.h | 368 ++-- .../{ => src}/SyncObjectMacOS.h | 92 +- .../{ => src}/SyncObjectPosix.h | 76 +- .../{ => src}/SyncObjectSolaris.h | 76 +- .../{ => src}/SyncObjectWin32.h | 78 +- .../{ => src}/SyncObjectWinCE.h | 72 +- openssl-act-engine/{ => src}/Warns.h | 14 +- openssl-act-engine/{ => src}/actUtility.h | 1308 +++++++------- openssl-act-engine/{ => src}/dllmain.cpp | 38 +- openssl-act-engine/{ => src}/engine_front.cpp | 0 openssl-act-engine/{ => src}/engine_sct.cpp | 0 openssl-act-engine/{ => src}/engine_sct.h | 0 .../{ => src}/engine_sct_internal.h | 0 .../{ => src}/engine_securetoken.cpp | 12 +- openssl-act-engine/src/makefile.am | 26 + openssl-act-engine/{ => src}/stdafx.cpp | 16 +- openssl-act-engine/{ => src}/stdafx.h | 32 +- openssl-act-engine/{ => src}/targetver.h | 48 +- openssl-act-engine/{ => src}/test_engine.cpp | 1 + .../win32_win2000.vs2008.vsprops | 22 +- 47 files changed, 3596 insertions(+), 1899 deletions(-) create mode 100644 openssl-act-engine/AUTHORS create mode 120000 openssl-act-engine/COPYING create mode 100644 openssl-act-engine/ChangeLog create mode 120000 openssl-act-engine/INSTALL delete mode 100644 openssl-act-engine/Makefile create mode 100644 openssl-act-engine/NEWS create mode 100644 openssl-act-engine/README create mode 100755 openssl-act-engine/bootstrap.sh create mode 100644 openssl-act-engine/configure.in create mode 100644 openssl-act-engine/doc/doxyfile.in create mode 100644 openssl-act-engine/doc/makefile.am rename openssl-act-engine/{ => src}/CardKey.cpp (100%) rename openssl-act-engine/{ => src}/CardKey.h (100%) rename openssl-act-engine/{ => src}/CardObject.cpp (100%) rename openssl-act-engine/{ => src}/CardObject.h (100%) rename openssl-act-engine/{ => src}/CertificateList.cpp (100%) rename openssl-act-engine/{ => src}/CertificateList.h (100%) rename openssl-act-engine/{ => src}/Init_Engine.h (97%) rename openssl-act-engine/{ => src}/SecOpGuard.cpp (100%) rename openssl-act-engine/{ => src}/SecOpGuard.h (100%) rename openssl-act-engine/{ => src}/SlotList.cpp (100%) rename openssl-act-engine/{ => src}/SlotList.h (100%) rename openssl-act-engine/{ => src}/SyncObject.h (95%) rename openssl-act-engine/{ => src}/SyncObjectMacOS.h (93%) rename openssl-act-engine/{ => src}/SyncObjectPosix.h (94%) rename openssl-act-engine/{ => src}/SyncObjectSolaris.h (94%) rename openssl-act-engine/{ => src}/SyncObjectWin32.h (94%) rename openssl-act-engine/{ => src}/SyncObjectWinCE.h (94%) rename openssl-act-engine/{ => src}/Warns.h (94%) rename openssl-act-engine/{ => src}/actUtility.h (96%) rename openssl-act-engine/{ => src}/dllmain.cpp (95%) rename openssl-act-engine/{ => src}/engine_front.cpp (100%) rename openssl-act-engine/{ => src}/engine_sct.cpp (100%) rename openssl-act-engine/{ => src}/engine_sct.h (100%) rename openssl-act-engine/{ => src}/engine_sct_internal.h (100%) rename openssl-act-engine/{ => src}/engine_securetoken.cpp (94%) create mode 100644 openssl-act-engine/src/makefile.am rename openssl-act-engine/{ => src}/stdafx.cpp (97%) rename openssl-act-engine/{ => src}/stdafx.h (96%) rename openssl-act-engine/{ => src}/targetver.h (98%) rename openssl-act-engine/{ => src}/test_engine.cpp (98%) diff --git a/openssl-act-engine/AUTHORS b/openssl-act-engine/AUTHORS new file mode 100644 index 0000000..a6da7ac --- /dev/null +++ b/openssl-act-engine/AUTHORS @@ -0,0 +1 @@ +Carsten Pluntke Cryptovision diff --git a/openssl-act-engine/COPYING b/openssl-act-engine/COPYING new file mode 120000 index 0000000..6168a39 --- /dev/null +++ b/openssl-act-engine/COPYING @@ -0,0 +1 @@ +/usr/share/automake-1.11/COPYING \ No newline at end of file diff --git a/openssl-act-engine/ChangeLog b/openssl-act-engine/ChangeLog new file mode 100644 index 0000000..e69de29 diff --git a/openssl-act-engine/INSTALL b/openssl-act-engine/INSTALL new file mode 120000 index 0000000..cbd1c80 --- /dev/null +++ b/openssl-act-engine/INSTALL @@ -0,0 +1 @@ +/usr/share/automake-1.11/INSTALL \ No newline at end of file diff --git a/openssl-act-engine/Makefile b/openssl-act-engine/Makefile deleted file mode 100644 index 26dc5e7..0000000 --- a/openssl-act-engine/Makefile +++ /dev/null @@ -1,40 +0,0 @@ - -# User servicable parts, place the location of the target architecture's -# OpenSSL Include and libraries here as well as the common path to the actlibrary. -OPENSSL_LIBDIR=/usr/lib/ -OPENSSL_INCDIR=/usr/include/ -ACTLIB_ROOT=../actlib - -CXXFLAGS=-pthread -g -O0 -DDEBUG - - -INCDIRS=-I$(ACTLIB_ROOT)/include/ -I$(OPENSSL_INCDIR) - -LIBS=-L$(OPENSSL_LIBDIR) -L$(ACTLIB_ROOT)/ -lact -ldl -lcrypto -lpthread -OBJS=engine_front.o engine_sct.o CardObject.o CardKey.o SlotList.o CertificateList.o SecOpGuard.o -TARGET=libengine_act.so - -TESTOBJS=test_engine.o -TESTTARGET=test_engine -TESTLIBS=$(OPENSSL_LIBDIR) -lcrypto -lssl -ldl -lpthread - - -all: $(TARGET) - -test: $(TESTTARGET) -clean: - rm -f *.o $(TARGET) $(TESTTARGET) - -$(TARGET): $(OBJS) - $(CXX) --shared -o $(TARGET) $(OBJS) $(LIBS) - -$(TESTTARGET): $(TESTOBJS) - $(CXX) -o $(TESTTARGET) $(TESTOBJS) $(TESTLIBS) - -.cpp.o: - $(CXX) -c $(CXXFLAGS) $(INCDIRS) $< - -.c.o: - $(CC) -c $(CFLAGS) $(INCDIRS) $< - - diff --git a/openssl-act-engine/NEWS b/openssl-act-engine/NEWS new file mode 100644 index 0000000..e69de29 diff --git a/openssl-act-engine/README b/openssl-act-engine/README new file mode 100644 index 0000000..e615bf1 --- /dev/null +++ b/openssl-act-engine/README @@ -0,0 +1,4 @@ +OpenSSL-Engine auf Basis der actlibrary zur Benutzung von +Smartcard-basierten Schlüsseln von OpenSSL aus. + +Erstellt libengine_act.so diff --git a/openssl-act-engine/ReadMe.txt b/openssl-act-engine/ReadMe.txt index cacf15b..4078f22 100644 --- a/openssl-act-engine/ReadMe.txt +++ b/openssl-act-engine/ReadMe.txt @@ -1,41 +1,41 @@ -======================================================================== - DYNAMIC LINK LIBRARY : engine_securetoken Project Overview -======================================================================== - -AppWizard has created this engine_securetoken DLL for you. - -This file contains a summary of what you will find in each of the files that -make up your engine_securetoken application. - - -engine_securetoken.vcproj - This is the main project file for VC++ projects generated using an Application Wizard. - It contains information about the version of Visual C++ that generated the file, and - information about the platforms, configurations, and project features selected with the - Application Wizard. - -engine_securetoken.cpp - This is the main DLL source file. - - When created, this DLL does not export any symbols. As a result, it - will not produce a .lib file when it is built. If you wish this project - to be a project dependency of some other project, you will either need to - add code to export some symbols from the DLL so that an export library - will be produced, or you can set the Ignore Input Library property to Yes - on the General propert page of the Linker folder in the project's Property - Pages dialog box. - -///////////////////////////////////////////////////////////////////////////// -Other standard files: - -StdAfx.h, StdAfx.cpp - These files are used to build a precompiled header (PCH) file - named engine_securetoken.pch and a precompiled types file named StdAfx.obj. - -///////////////////////////////////////////////////////////////////////////// -Other notes: - -AppWizard uses "TODO:" comments to indicate parts of the source code you -should add to or customize. - -///////////////////////////////////////////////////////////////////////////// +======================================================================== + DYNAMIC LINK LIBRARY : engine_securetoken Project Overview +======================================================================== + +AppWizard has created this engine_securetoken DLL for you. + +This file contains a summary of what you will find in each of the files that +make up your engine_securetoken application. + + +engine_securetoken.vcproj + This is the main project file for VC++ projects generated using an Application Wizard. + It contains information about the version of Visual C++ that generated the file, and + information about the platforms, configurations, and project features selected with the + Application Wizard. + +engine_securetoken.cpp + This is the main DLL source file. + + When created, this DLL does not export any symbols. As a result, it + will not produce a .lib file when it is built. If you wish this project + to be a project dependency of some other project, you will either need to + add code to export some symbols from the DLL so that an export library + will be produced, or you can set the Ignore Input Library property to Yes + on the General propert page of the Linker folder in the project's Property + Pages dialog box. + +///////////////////////////////////////////////////////////////////////////// +Other standard files: + +StdAfx.h, StdAfx.cpp + These files are used to build a precompiled header (PCH) file + named engine_securetoken.pch and a precompiled types file named StdAfx.obj. + +///////////////////////////////////////////////////////////////////////////// +Other notes: + +AppWizard uses "TODO:" comments to indicate parts of the source code you +should add to or customize. + +///////////////////////////////////////////////////////////////////////////// diff --git a/openssl-act-engine/USING_ENGINE_act.txt b/openssl-act-engine/USING_ENGINE_act.txt index 27dcd1a..3e5a2d6 100644 --- a/openssl-act-engine/USING_ENGINE_act.txt +++ b/openssl-act-engine/USING_ENGINE_act.txt @@ -1,75 +1,75 @@ -Benutzung der engine_act OpenSSL engine - -Abgesehen von den Engine-Befehlen "ENUM_CERTS" und "PIN" (s.u.) läuft die Benutzung dieser Engine über OpenSSL selbst ab. - -1) Laden/Einbinden - -SO_PATH gibt den absoluten Pfad zur Engine an. - -#include - - ENGINE *e; - - ENGINE_load_dynamic(); - e = ENGINE_by_id("dynamic"); - - int r= ENGINE_ctrl_cmd_string(e, "SO_PATH", "C:\\Windows\\System32\\engine_act.dll", 0); - r= ENGINE_ctrl_cmd_string(e, "ID", "act", 0); - r= ENGINE_ctrl_cmd_string(e, "LIST_ADD", "1", 0); - r= ENGINE_ctrl_cmd_string(e, "LOAD", NULL, 0); - -2) Entfernen der Engine und abschliessende Operationen - - ENGINE_finish(e); - ENGINE_cleanup(); - - -3) Enumerierung der erreichbaren Smartcard-Zertifikate und Schlüssel - -#include -#include "engine_sct.h" - - enum_certs_s* certs_found = NULL; - - int r = ENGINE_ctrl_cmd(e, "ENUM_CERTS", 0, &certs_found, NULL, 0); - - -enum_certs_s ist eine Struktur von der folgenden Form: - -struct enum_cert_s -{ - const char* id; // ID which can be passed as key ID for crypto operations - const char* name; // Alternatively one can use the name, provided it's unique for the token. - X509* cert; // Decoded certificate -}; - -struct enum_certs_s -{ - unsigned int num_certs; // Number of certificates present - enum_cert_s certificate[]; // Array of identifiers and certificates -}; - - -So kann man dann mit einer for-Schleife über die einzelnen Zertifikate/Schlüsselidentifikationen iterieren - - for(int i=0;inum_certs;i++) - { - enum_cert_s* cert_data = &(certs_found->certificate[i]); - - .... - } - -4) Laden eines Schlüssels zur Benutzung - -Sowohl cert_data.id als auch cert_data.name können als Parameter für ENGINE_load_public_key() oder ENGINE_load_private_key() verwendet werden. -cert_data.name hat das Format "slot--name-", der Authenthisierungsschlüssel im ersten (oder einzigen) Slot wäre dann - -"slot-0-name-SwissSign_digSig" - -ENGINE_load_private_key() versucht gleich schon ein Login auf der Karte. Man kann ein Pin-Dialog per Callback übergeben, aber man kann auch -die PIN von vornherein setzen, und zwar mit - - ENGINE_ctrl_cmd_string(e, "PIN", pin_str, 0); - -/!\ pin_str ist ein nullterminierter String (char *) und wird in der Funktion überschrieben! Wird die PIN also später anderswo noch gebraucht, muss man -hier eine Kopie des Strings übergeben. +Benutzung der engine_act OpenSSL engine + +Abgesehen von den Engine-Befehlen "ENUM_CERTS" und "PIN" (s.u.) läuft die Benutzung dieser Engine über OpenSSL selbst ab. + +1) Laden/Einbinden + +SO_PATH gibt den absoluten Pfad zur Engine an. + +#include + + ENGINE *e; + + ENGINE_load_dynamic(); + e = ENGINE_by_id("dynamic"); + + int r= ENGINE_ctrl_cmd_string(e, "SO_PATH", "C:\\Windows\\System32\\engine_act.dll", 0); + r= ENGINE_ctrl_cmd_string(e, "ID", "act", 0); + r= ENGINE_ctrl_cmd_string(e, "LIST_ADD", "1", 0); + r= ENGINE_ctrl_cmd_string(e, "LOAD", NULL, 0); + +2) Entfernen der Engine und abschliessende Operationen + + ENGINE_finish(e); + ENGINE_cleanup(); + + +3) Enumerierung der erreichbaren Smartcard-Zertifikate und Schlüssel + +#include +#include "engine_sct.h" + + enum_certs_s* certs_found = NULL; + + int r = ENGINE_ctrl_cmd(e, "ENUM_CERTS", 0, &certs_found, NULL, 0); + + +enum_certs_s ist eine Struktur von der folgenden Form: + +struct enum_cert_s +{ + const char* id; // ID which can be passed as key ID for crypto operations + const char* name; // Alternatively one can use the name, provided it's unique for the token. + X509* cert; // Decoded certificate +}; + +struct enum_certs_s +{ + unsigned int num_certs; // Number of certificates present + enum_cert_s certificate[]; // Array of identifiers and certificates +}; + + +So kann man dann mit einer for-Schleife über die einzelnen Zertifikate/Schlüsselidentifikationen iterieren + + for(int i=0;inum_certs;i++) + { + enum_cert_s* cert_data = &(certs_found->certificate[i]); + + .... + } + +4) Laden eines Schlüssels zur Benutzung + +Sowohl cert_data.id als auch cert_data.name können als Parameter für ENGINE_load_public_key() oder ENGINE_load_private_key() verwendet werden. +cert_data.name hat das Format "slot--name-", der Authenthisierungsschlüssel im ersten (oder einzigen) Slot wäre dann + +"slot-0-name-SwissSign_digSig" + +ENGINE_load_private_key() versucht gleich schon ein Login auf der Karte. Man kann ein Pin-Dialog per Callback übergeben, aber man kann auch +die PIN von vornherein setzen, und zwar mit + + ENGINE_ctrl_cmd_string(e, "PIN", pin_str, 0); + +/!\ pin_str ist ein nullterminierter String (char *) und wird in der Funktion überschrieben! Wird die PIN also später anderswo noch gebraucht, muss man +hier eine Kopie des Strings übergeben. diff --git a/openssl-act-engine/bootstrap.sh b/openssl-act-engine/bootstrap.sh new file mode 100755 index 0000000..916e283 --- /dev/null +++ b/openssl-act-engine/bootstrap.sh @@ -0,0 +1,19 @@ +#! /bin/sh + +## @file +## +## $Id: bootstrap.sh 2 2009-06-16 13:20:59Z $ +## +## $Date: 2004/08/31 15:57:19 $ +## $Author: marc $ +## +## @copy © Marc Wäckerlin +## @license LGPL, see file COPYING +## +## $Log: bootstrap.sh,v $ +## Revision 1.3 2004/08/31 15:57:19 marc +## added file header +## + +test -f makefile && make distclean +aclocal && libtoolize --force && automake -a && autoconf diff --git a/openssl-act-engine/configure.in b/openssl-act-engine/configure.in new file mode 100644 index 0000000..96620d1 --- /dev/null +++ b/openssl-act-engine/configure.in @@ -0,0 +1,119 @@ +## @id $Id$ + +## 1 2 3 4 5 6 7 8 +## 45678901234567890123456789012345678901234567890123456789012345678901234567890 + +# init +AC_INIT([README]) +PACKAGENAME=openssl-act-engine +SRC_DIR=src +TST_DIR= +DOC_DIR=doc + +m4_define(x_major, 1) +m4_define(x_minor, 0) +PACKAGENAME=x_packagename +MAJOR=x_major +MINOR=x_minor + +LEAST="ERROR-UNDEFINED-REVISION-to-be-built-in-subdirectory-of-svn-checkout" +for path in . .. ../..; do + if svn info $path 2>&1 > /dev/null; then + LEAST=$(LANG= svn info $path | sed -n 's/Revision: //p') + break; + fi +done + +AM_INIT_AUTOMAKE(@PACKAGENAME@, @MAJOR@.@MINOR@.@LEAST@, [marc@waeckerlin.org]) + +# files to create +AC_CONFIG_FILES(makefile src/makefile doc/makefile doc/doxyfile) + +AC_SUBST(MAJOR) +AC_SUBST(MINOR) +AC_SUBST(LEAST) + +README=README +AC_SUBST_FILE(README) + +# libtool versioning +LIB_MAJOR=m4_eval(x_major+x_minor) +LIB_MINOR=$LEAST +LIB_LEAST=x_minor +LIB_VERSION="${LIB_MAJOR}:${LIB_MINOR}:${LIB_LEAST}" +AC_SUBST(LIB_VERSION) + +# Get rid of that stupid -O2 -g options! +CXXFLAGS="${CXXFLAGS:-}" + +# languages +AC_LANG(C++) + +# programs +AC_PROG_CXX +AC_PROG_CPP +AC_PROG_INSTALL +AC_PROG_LN_S +AC_PROG_MAKE_SET +AC_PROG_LIBTOOL +AC_CHECK_PROG(have_doxygen, doxygen, yes, no) +AC_CHECK_PROG(have_dot, dot, yes, no) + +AC_ARG_ENABLE(pedantic, + [AS_HELP_STRING([--enable-pedantic], + [enable all warnings and checks, abort on warnings])], + [have_pedantic="$enableval"; test "$enableval" = "yes" && \ + AM_CXXFLAGS="${AM_CXXFLAGS:-} -pedantic-errors -Wall -W -Wfloat-equal -Wundef -Wendif-labels -Wpointer-arith -Wcast-align -Wwrite-strings -Wconversion -Wsign-compare -Wmissing-format-attribute -Wno-multichar -Wpacked -Wredundant-decls -Werror -Wshadow -Wcast-qual -Wno-ctor-dtor-privacy"]) +dnl problem in libs: -Wshadow -Wcast-qual +dnl auto.hpp: -Wno-ctor-dtor-privacy (removed) +AM_CONDITIONAL(PEDANTIC, test "$enableval" = "yes") +AC_ARG_ENABLE(dot, + [AS_HELP_STRING([--disable-dot], + [disable dot graphic tools for documentation])], + [have_dot="$enableval"]) +test "$enableval" = "yes" && HAVE_DOT="YES" || HAVE_DOT="NO"; +AM_PATH_CPPUNIT([1.0.0], [have_cppunit="yes"], [have_cppunit="no"]) + +# export macros +SRCDIR=${srcdir} +AC_SUBST(SRCDIR) +AC_SUBST(SRC_DIR) +AC_SUBST(TST_DIR) +AC_SUBST(DOC_DIR) +AC_SUBST(HAVE_DOT) +AC_SUBST(THREADS) +AC_SUBST(PACKAGENAME) +AC_SUBST(AM_CXXFLAGS) +AC_SUBST(AM_CPPFLAGS) +AC_SUBST(LIBS) +AC_SUBST(QMAKE) +AC_SUBST(QMAKE_OPTIONS) + +# create output +AC_OUTPUT + +# infos and warnings +if test "$have_doxygen" = "no"; then +AC_MSG_WARN([Missing program doxygen! + - you cannot rebuild the documentation with make doc + - there are precompiled derived files in the distribution]); fi +if test "$have_dot" = "no"; then +AC_MSG_WARN([Missing program dot! + - when you rebild documentation with make doc, there are no generated images + - there are precompiled derived files in the distribution]); fi +if test "$have_cppunit" = "no"; then +AC_MSG_WARN([Missing cppunit development library! + - you cannot check the library using "make check" + - everything else works perfectly]); fi +if test "$have_pedantic" == "yes"; then +AC_MSG_NOTICE([Pedantic compile mode enabled! + - all warnings for GNU g++ are enabled + - all warnings result in an error + - doxygen warnings are treated as error too]); fi +if test "$build_win" == "yes"; then +AC_MSG_NOTICE([Will cross-compile for windows + Requires: + - mingw32, mingw32-binutils, mingw32-runtime + - i586-mingw32msvc-g++, i586-mingw32msvc-ar, + i586-mingw32msvc-windres, i586-mingw32msvc-strip + - Boost for MinGW in ~/.wine/drive_c/Programme/Boost-1.34.1]); fi diff --git a/openssl-act-engine/default.vs2008.vsprops b/openssl-act-engine/default.vs2008.vsprops index cdd097c..8f9cba7 100644 --- a/openssl-act-engine/default.vs2008.vsprops +++ b/openssl-act-engine/default.vs2008.vsprops @@ -1,11 +1,11 @@ - - - - + + + + diff --git a/openssl-act-engine/doc/doxyfile.in b/openssl-act-engine/doc/doxyfile.in new file mode 100644 index 0000000..5470aa7 --- /dev/null +++ b/openssl-act-engine/doc/doxyfile.in @@ -0,0 +1,1518 @@ +# Doxyfile 1.5.8 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = "Projektdokumentation @PACKAGENAME@" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = "Version @MAJOR@.@MINOR@.@LEAST@" + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, +# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, +# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, +# Spanish, Swedish, and Ukrainian. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = YES + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = YES + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 2 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = "id=\par File-ID\n" \ + "copy=\par Copyright\n" \ + "license=\par License\n" \ + "classmutex=\par Reentrant:\nAccess is locked with class static mutex @c " \ + "instancemutex=\par Reentrant:\nAccess is locked with per instance mutex @c " \ + "mutex=\par Reentrant:\nAccess is locked with mutex @c " + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it parses. +# With this tag you can assign which parser to use for a given extension. +# Doxygen has a built-in mapping, but you can override or extend it using this tag. +# The format is ext=language, where ext is a file extension, and language is one of +# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, +# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat +# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C + +EXTENSION_MAPPING = + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = YES + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate getter +# and setter methods for a property. Setting this option to YES (the default) +# will make doxygen to replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = YES + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penality. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will rougly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols + +SYMBOL_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespace are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = YES + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = YES + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = NO + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. The default is NO. + +SHOW_DIRECTORIES = NO + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. +# This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by +# doxygen. The layout file controls the global structure of the generated output files +# in an output format independent way. The create the layout file that represents +# doxygen's defaults, run doxygen with the -l option. You can optionally specify a +# file name after the option, if omitted DoxygenLayout.xml will be used as the name +# of the layout file. + +LAYOUT_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = NO + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be abled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = doxygen.errors + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = @SRCDIR@/../src + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 + +FILE_PATTERNS = *.[ch]xx \ + *.doc + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = moc_* \ + uic_* \ + qrc_* + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = @SRCDIR@/.. + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. +# If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. +# Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. +# The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# is applied to all files. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = NO + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = YES + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. +# Otherwise they will link to the documentation. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = YES + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = YES + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER +# are set, an additional index file will be generated that can be used as input for +# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated +# HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. +# For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see +# Qt Help Project / Custom Filters. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's +# filter section matches. +# Qt Help Project / Filter Attributes. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to FRAME, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. Other possible values +# for this tag are: HIERARCHIES, which will generate the Groups, Directories, +# and Class Hierarchy pages using a tree view instead of an ordered list; +# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which +# disables this behavior completely. For backwards compatibility with previous +# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE +# respectively. + +GENERATE_TREEVIEW = YES + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = YES + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4 + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = YES + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = YES + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = YES + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. +# This is useful +# if you want to understand what is going on. +# On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# in the INCLUDE_PATH (see below) will be search if a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = HAVE_STACKTRACE + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse +# the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = @PACKAGENAME@.doxytag + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more +# powerful graphs. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = NO + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = @HAVE_DOT@ + +# By default doxygen will write a font called FreeSans.ttf to the output +# directory and reference it in all dot files that doxygen generates. This +# font does not include all possible unicode characters however, so when you need +# these (or just want a differently looking font) you can specify the font name +# using DOT_FONTNAME. You need need to make sure dot is able to find the font, +# which can be done by putting it in a standard location or by setting the +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory +# containing the font. + +DOT_FONTNAME = FreeSans + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the output directory to look for the +# FreeSans.ttf font (which doxygen will put there itself). If you specify a +# different font using DOT_FONTNAME you can set the path where dot +# can find it using this tag. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = NO + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = NO + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). + +DOT_TRANSPARENT = YES + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES + +#--------------------------------------------------------------------------- +# Options related to the search engine +#--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + +SEARCHENGINE = NO diff --git a/openssl-act-engine/doc/makefile.am b/openssl-act-engine/doc/makefile.am new file mode 100644 index 0000000..7a7d2dd --- /dev/null +++ b/openssl-act-engine/doc/makefile.am @@ -0,0 +1,47 @@ +## @file +## +## $Id: makefile.am 40 2010-03-31 15:13:10Z marc $ +## +## 1 2 3 4 5 6 7 8 +## 45678901234567890123456789012345678901234567890123456789012345678901234567890 + +#SUBDIRS = examples + +develdir = ${pkgdatadir}/doc +devel_DATA = html/index.html + +ALL_SRC = ${top_srcdir}/src/*.cpp ${top_srcdir}/src/*.h + +DIRS = html latex + +all: ${DIRS} + +deps = ${top_srcdir}/COPYING ${top_srcdir}/README \ + ${top_srcdir}/INSTALL ${top_srcdir}/NEWS ${top_srcdir}/ChangeLog + +${devel_DATA}: ${ALL_SRC} doxyfile ${deps} + doxygen doxyfile +if PEDANTIC + test \! -s doxygen.errors +endif +# cd latex && make +# mv latex/refman.pdf @PACKAGENAME@-@MAJOR@.@MINOR@.@LEAST@.pdf + +CLEANFILES = doxygen.errors @PACKAGENAME@-@MAJOR@.@MINOR@.@LEAST@.pdf +DISTCLEANFILES = @PACKAGENAME@.doxytag +MAINTAINERCLEANFILES = makefile.in + + +distclean-local: + - rm -r html latex + +dist-hook: ${devel_DATA} + cp -r html ${distdir}/ + +install-data-hook: + chmod -R u+w ${develdir} + cp -r html/* ${develdir}/ + +uninstall-hook: + -chmod -R u+w ${develdir} + -rm -rf ${develdir}/* diff --git a/openssl-act-engine/engine_securetoken.sln b/openssl-act-engine/engine_securetoken.sln index f580a01..ea38b4e 100644 --- a/openssl-act-engine/engine_securetoken.sln +++ b/openssl-act-engine/engine_securetoken.sln @@ -1,24 +1,24 @@ - -Microsoft Visual Studio Solution File, Format Version 10.00 -# Visual Studio 2008 -Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "engine_securetoken", "engine_securetoken.vcproj", "{A1D90F74-60E0-4ED0-A93D-F626A754310D}" -EndProject -Global - GlobalSection(SubversionScc) = preSolution - Svn-Managed = True - Manager = AnkhSVN - Subversion Support for Visual Studio - EndGlobalSection - GlobalSection(SolutionConfigurationPlatforms) = preSolution - Debug|Win32 = Debug|Win32 - Release|Win32 = Release|Win32 - EndGlobalSection - GlobalSection(ProjectConfigurationPlatforms) = postSolution - {A1D90F74-60E0-4ED0-A93D-F626A754310D}.Debug|Win32.ActiveCfg = Debug|Win32 - {A1D90F74-60E0-4ED0-A93D-F626A754310D}.Debug|Win32.Build.0 = Debug|Win32 - {A1D90F74-60E0-4ED0-A93D-F626A754310D}.Release|Win32.ActiveCfg = Release|Win32 - {A1D90F74-60E0-4ED0-A93D-F626A754310D}.Release|Win32.Build.0 = Release|Win32 - EndGlobalSection - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE - EndGlobalSection -EndGlobal + +Microsoft Visual Studio Solution File, Format Version 10.00 +# Visual Studio 2008 +Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "engine_securetoken", "engine_securetoken.vcproj", "{A1D90F74-60E0-4ED0-A93D-F626A754310D}" +EndProject +Global + GlobalSection(SubversionScc) = preSolution + Svn-Managed = True + Manager = AnkhSVN - Subversion Support for Visual Studio + EndGlobalSection + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Win32 = Debug|Win32 + Release|Win32 = Release|Win32 + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {A1D90F74-60E0-4ED0-A93D-F626A754310D}.Debug|Win32.ActiveCfg = Debug|Win32 + {A1D90F74-60E0-4ED0-A93D-F626A754310D}.Debug|Win32.Build.0 = Debug|Win32 + {A1D90F74-60E0-4ED0-A93D-F626A754310D}.Release|Win32.ActiveCfg = Release|Win32 + {A1D90F74-60E0-4ED0-A93D-F626A754310D}.Release|Win32.Build.0 = Release|Win32 + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection +EndGlobal diff --git a/openssl-act-engine/engine_securetoken.vcproj b/openssl-act-engine/engine_securetoken.vcproj index 1cb3c85..cb2268c 100644 --- a/openssl-act-engine/engine_securetoken.vcproj +++ b/openssl-act-engine/engine_securetoken.vcproj @@ -1,357 +1,357 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/openssl-act-engine/CardKey.cpp b/openssl-act-engine/src/CardKey.cpp similarity index 100% rename from openssl-act-engine/CardKey.cpp rename to openssl-act-engine/src/CardKey.cpp diff --git a/openssl-act-engine/CardKey.h b/openssl-act-engine/src/CardKey.h similarity index 100% rename from openssl-act-engine/CardKey.h rename to openssl-act-engine/src/CardKey.h diff --git a/openssl-act-engine/CardObject.cpp b/openssl-act-engine/src/CardObject.cpp similarity index 100% rename from openssl-act-engine/CardObject.cpp rename to openssl-act-engine/src/CardObject.cpp diff --git a/openssl-act-engine/CardObject.h b/openssl-act-engine/src/CardObject.h similarity index 100% rename from openssl-act-engine/CardObject.h rename to openssl-act-engine/src/CardObject.h diff --git a/openssl-act-engine/CertificateList.cpp b/openssl-act-engine/src/CertificateList.cpp similarity index 100% rename from openssl-act-engine/CertificateList.cpp rename to openssl-act-engine/src/CertificateList.cpp diff --git a/openssl-act-engine/CertificateList.h b/openssl-act-engine/src/CertificateList.h similarity index 100% rename from openssl-act-engine/CertificateList.h rename to openssl-act-engine/src/CertificateList.h diff --git a/openssl-act-engine/Init_Engine.h b/openssl-act-engine/src/Init_Engine.h similarity index 97% rename from openssl-act-engine/Init_Engine.h rename to openssl-act-engine/src/Init_Engine.h index 8ba079c..f00e658 100644 --- a/openssl-act-engine/Init_Engine.h +++ b/openssl-act-engine/src/Init_Engine.h @@ -1,225 +1,225 @@ -////////////////////////////////////////////////////////////////////////////////// -// Name: actInit.h -// Product: cv act library -// Purpose: initialize the map entries of the objects -// -// Copyright: (c) 2007 cv cryptovision GmbH -// all rights reserved -// Licence: The conditions for the use of this software are regulated -// in the cv act library licence agreement. -// remarks: -// declare NO_SMARTCARD: no smartcard support required. -////////////////////////////////////////////////////////////////////////////////// - -#ifndef actInit_h -#define actInit_h - -#include "actKeyKit.h" -#include "actKeyReg.h" -#include "actHashKit.h" -#include "actHashReg.h" -#include "actEMSAReg.h" -#include "actEMSAKit.h" -#include "actPaddingReg.h" -#include "actPaddingKit.h" -#include "actCertificateReg.h" -#include "actCertificateKit.h" -#include "actDefaultRNG.h" -#include "actRNGKit.h" - -#ifndef NO_SMARTCARD -// NOTE: To Enable support for additional smartcards / profiles define: -// ACT_SUPPORT_TCOS_NETKEY30 -# include "actSCardOSReg.h" -# include "actSCardOSKit.h" -# include "actSCardTokenReg.h" -# include "actSCardTokenKit.h" -# include "actSubsystemReg.h" -# include "actSubsystemKit.h" -# include "actSlotMonitorReg.h" -# include "actSlotMonitorKit.h" -# include "actTokenExtensionReg.h" -# include "actTokenExtensionKit.h" -# include "actTokenAuthProtocolReg.h" -# include "actTokenAuthProtocolKit.h" -# include "actPKCS15BehaviorReg.h" -# include "actPKCS15BehaviorKit.h" -#endif // NO_SMARTCARD - -namespace act -{ - // ------------------------------------------------------------------------ - const KeyMapEntry KeyMap[] = - { - { "RSA" , CreateRSAKey }, - { 0, 0 } - }; - - - // ------------------------------------------------------------------------ - const HashMapEntry HashMap[] = - { - { "MD5" , CreateMD5 }, - { "SHA1" , CreateSHA1 }, - { "SHA224" , CreateSHA224 }, - { "SHA256" , CreateSHA256 }, - { "SHA384" , CreateSHA384 }, - { "SHA512" , CreateSHA512 }, - { "DummyHash" , CreateDummyHash }, - { 0, 0 } - }; - - // ------------------------------------------------------------------------ - const EMSAMapEntry EMSAMap[] = - { - { "EMSA1", CreateEMSA1 }, - { "PKCS1V1_5EMSA", CreatePKCS1V1_5EMSA }, - { "TLS_EMSA", CreateTLS_EMSA}, - { "PKCS1_PSS_EMSA", CreatePKCS1_PSS_EMSA }, - { "DummyEMSA" , CreateDummyEMSA }, // Used for "Hash on Card" - { 0, 0 } - }; - - // ------------------------------------------------------------------------ - const PaddingMapEntry PaddingMap[] = - { - { "PKCS5", CreatePKCS5Pad }, - { "RSAES", CreatePKCS1V1_5EMEPad }, - { "ISO", CreateOneAndZerosPad }, - { "ISO9796", CreateISO9796Pad }, - { "NOPAD", CreateNoPad }, - { 0, 0 } - }; - - // ------------------------------------------------------------------------ - const CertificateMapEntry CertificateMap[] = - { - { "X509", CreateX509Certificate }, - { 0, 0 } - }; - -#ifndef NO_SMARTCARD - // ------------------------------------------------------------------------ - const SCardOSMapEntry SCardOSMap[] = - { - // CardOS - { "c806", CreateCardOS_V4 }, // CardOS V4.2 - { "c807", CreateCardOS_V4 }, // CardOS V4.3 - { "c808", CreateCardOS_V4 }, // CardOS V4.3B - { "c809", CreateCardOS_V4 }, // CardOS V4.2B - { "c80a", CreateCardOS_V4 }, // CardOS V4.2B DI - { "0000c80a3381b100", CreateCardOS_V4 }, // CardOS V4.2B DI contactless - { "c80b", CreateCardOS_V4 }, // CardOS V4.2C - { "c80d", CreateCardOS_V4 }, // CardOS V4.4 - { "56346376", CreateCardOS_V4 }, // CardOS V4.2/4.3/4.3B cv profile - { "563432626376", CreateCardOS_V4 }, // CardOS V4.2b cv profile - { "5634326244496376", CreateCardOS_V4 }, // CardOS V4.2b DI cv profile - { "563432636376", CreateCardOS_V4 }, // CardOS V4.2c cv profile - { "5634346376", CreateCardOS_V4 }, // CardOS V4.4 cv profile - { "563463765f45", CreateCardOS_V4_ECC }, // CardOS V4.3B ECC cv profile - { "006b0508c806012101434e53103180", CreateCardOS_V4 }, // CardOS V4.2 CNS profile, 2004.02.20 - { "006b0508c807012101434e53103180", CreateCardOS_V4 }, // CardOS V4.3 CNS profile, 2004.02.20 - { "006b0508c808012101434e53103180", CreateCardOS_V4 }, // CardOS V4.3B CNS profile, 2004.02.20 - { "006b0508c806011101434e53103180", CreateCardOS_V4 }, // CardOS V4.2 CNS profile, 2005.03.11 - { "006b0508c807011101434e53103180", CreateCardOS_V4 }, // CardOS V4.3 CNS profile, 2005.03.11 - { "006b0508c808011101434e53103180", CreateCardOS_V4 }, // CardOS V4.3B CNS profile, 2005.03.11 - { "006b0508c808011101434e53103180", CreateCardOS_V4 }, // CardOS V4.3B CNS profile, 2005.03.11 - { "4b53776973735369676e", CreateCardOS_V4 }, // CardOS V4.3B/V4.4 ATR by SwissSign - - { ACT_ISO7816OS_NAME, CreateISO7816OS }, // use act::ISO7816OS as fallback - { 0, 0 } - }; - - // ------------------------------------------------------------------------ - const SCardTokenMapEntry SCardTokenMap[] = - { - // PKCS#15 - { IsV4PKCS15ECProfile, CreateV4PKCS15ECProfile }, - { IsV4PKCS15Profile, CreateV4PKCS15Profile }, - - // CardOS - { IsM4cvMoCProfile, CreateM4cvMoCProfile }, - { IsM4cvECProfile, CreateM4cvECProfile }, - { IsV4cvECProfile, CreateV4cvECProfile }, - { IsV4cvProfile, CreateV4cvProfile }, - { IsM4cvProfile, CreateM4cvProfile }, - // { IsV4CNSProfile, CreateV4CNSProfile }, - - { 0, 0 } - }; - - // ------------------------------------------------------------------------ - const PKCS15BehaviorMapEntry PKCS15BehaviorMap[] = - { - { "cv cryptovision gmbh (c) v1.0n", CreateV4PKCS15Behavior }, - { "", CreatePKCS15Behavior }, // default - { 0, 0 } - }; - - // ------------------------------------------------------------------------ - const TokenExtensionMapEntry TokenExtensionMap[] = - { - { "MDProfileExt", CreateMDProfileExt }, // Minidriver FS Profile Extension - { 0, 0 } - }; - - // ------------------------------------------------------------------------ - const TokenAuthProtocolMapEntry TokenAuthProtocolMap[] = - { - { "EAC 2.01 PACE", CreateTokenAuthPACE }, - { "EAC 2.01 TA", CreateTokenAuthTA }, - { "EAC 2.01 CA", CreateTokenAuthCA }, - { "BAC", CreateTokenAuthBAC }, - { 0, 0 } - }; - - // ------------------------------------------------------------------------ - const SubsystemMapEntry SubsystemMap[] = - { - { "PCSC", CreatePCSCSystem, CreatePCSCSystemEx }, - { 0, 0, 0 } - }; - - // ------------------------------------------------------------------------ - const SlotMonitorRegEntry SlotMonitorMap[] = - { - { "PCSC", { CreatePCSCSlotMonitor, CreatePCSCSystemSlotMonitor } }, - { 0, { 0, 0 } } - }; - -#endif // NO_SMARTCARD - - // ------------------------------------------------------------------------ - // Version: V1R4M4 - const char* GetVersion(); - - // ------------------------------------------------------------------------ - inline void Init(bool bAlwaysInit = false) - { - static bool loaded = false; - if(loaded == true && bAlwaysInit == false) - return; - - KeyReg::Insert(KeyMap); - HashReg::Insert(HashMap); - EMSAReg::Insert(EMSAMap); - PaddingReg::Insert(PaddingMap); - CertificateReg::Insert(CertificateMap); - -#ifndef NO_SMARTCARD - SubsystemReg::Insert(SubsystemMap); - SlotMonitorReg::Insert(SlotMonitorMap); - SCardOSReg::Insert(SCardOSMap); - SCardTokenReg::Insert(SCardTokenMap); - PKCS15BehaviorReg::Insert(PKCS15BehaviorMap); - TokenExtensionReg::Insert(TokenExtensionMap); - TokenAuthProtocolReg::Insert(TokenAuthProtocolMap); -#endif - CreateFastRNG = CreateFIPS186; - CreateStrongRNG = CreateBBS; - loaded = true; - } - -} // namespace act - -#endif // actInit_h +////////////////////////////////////////////////////////////////////////////////// +// Name: actInit.h +// Product: cv act library +// Purpose: initialize the map entries of the objects +// +// Copyright: (c) 2007 cv cryptovision GmbH +// all rights reserved +// Licence: The conditions for the use of this software are regulated +// in the cv act library licence agreement. +// remarks: +// declare NO_SMARTCARD: no smartcard support required. +////////////////////////////////////////////////////////////////////////////////// + +#ifndef actInit_h +#define actInit_h + +#include "actKeyKit.h" +#include "actKeyReg.h" +#include "actHashKit.h" +#include "actHashReg.h" +#include "actEMSAReg.h" +#include "actEMSAKit.h" +#include "actPaddingReg.h" +#include "actPaddingKit.h" +#include "actCertificateReg.h" +#include "actCertificateKit.h" +#include "actDefaultRNG.h" +#include "actRNGKit.h" + +#ifndef NO_SMARTCARD +// NOTE: To Enable support for additional smartcards / profiles define: +// ACT_SUPPORT_TCOS_NETKEY30 +# include "actSCardOSReg.h" +# include "actSCardOSKit.h" +# include "actSCardTokenReg.h" +# include "actSCardTokenKit.h" +# include "actSubsystemReg.h" +# include "actSubsystemKit.h" +# include "actSlotMonitorReg.h" +# include "actSlotMonitorKit.h" +# include "actTokenExtensionReg.h" +# include "actTokenExtensionKit.h" +# include "actTokenAuthProtocolReg.h" +# include "actTokenAuthProtocolKit.h" +# include "actPKCS15BehaviorReg.h" +# include "actPKCS15BehaviorKit.h" +#endif // NO_SMARTCARD + +namespace act +{ + // ------------------------------------------------------------------------ + const KeyMapEntry KeyMap[] = + { + { "RSA" , CreateRSAKey }, + { 0, 0 } + }; + + + // ------------------------------------------------------------------------ + const HashMapEntry HashMap[] = + { + { "MD5" , CreateMD5 }, + { "SHA1" , CreateSHA1 }, + { "SHA224" , CreateSHA224 }, + { "SHA256" , CreateSHA256 }, + { "SHA384" , CreateSHA384 }, + { "SHA512" , CreateSHA512 }, + { "DummyHash" , CreateDummyHash }, + { 0, 0 } + }; + + // ------------------------------------------------------------------------ + const EMSAMapEntry EMSAMap[] = + { + { "EMSA1", CreateEMSA1 }, + { "PKCS1V1_5EMSA", CreatePKCS1V1_5EMSA }, + { "TLS_EMSA", CreateTLS_EMSA}, + { "PKCS1_PSS_EMSA", CreatePKCS1_PSS_EMSA }, + { "DummyEMSA" , CreateDummyEMSA }, // Used for "Hash on Card" + { 0, 0 } + }; + + // ------------------------------------------------------------------------ + const PaddingMapEntry PaddingMap[] = + { + { "PKCS5", CreatePKCS5Pad }, + { "RSAES", CreatePKCS1V1_5EMEPad }, + { "ISO", CreateOneAndZerosPad }, + { "ISO9796", CreateISO9796Pad }, + { "NOPAD", CreateNoPad }, + { 0, 0 } + }; + + // ------------------------------------------------------------------------ + const CertificateMapEntry CertificateMap[] = + { + { "X509", CreateX509Certificate }, + { 0, 0 } + }; + +#ifndef NO_SMARTCARD + // ------------------------------------------------------------------------ + const SCardOSMapEntry SCardOSMap[] = + { + // CardOS + { "c806", CreateCardOS_V4 }, // CardOS V4.2 + { "c807", CreateCardOS_V4 }, // CardOS V4.3 + { "c808", CreateCardOS_V4 }, // CardOS V4.3B + { "c809", CreateCardOS_V4 }, // CardOS V4.2B + { "c80a", CreateCardOS_V4 }, // CardOS V4.2B DI + { "0000c80a3381b100", CreateCardOS_V4 }, // CardOS V4.2B DI contactless + { "c80b", CreateCardOS_V4 }, // CardOS V4.2C + { "c80d", CreateCardOS_V4 }, // CardOS V4.4 + { "56346376", CreateCardOS_V4 }, // CardOS V4.2/4.3/4.3B cv profile + { "563432626376", CreateCardOS_V4 }, // CardOS V4.2b cv profile + { "5634326244496376", CreateCardOS_V4 }, // CardOS V4.2b DI cv profile + { "563432636376", CreateCardOS_V4 }, // CardOS V4.2c cv profile + { "5634346376", CreateCardOS_V4 }, // CardOS V4.4 cv profile + { "563463765f45", CreateCardOS_V4_ECC }, // CardOS V4.3B ECC cv profile + { "006b0508c806012101434e53103180", CreateCardOS_V4 }, // CardOS V4.2 CNS profile, 2004.02.20 + { "006b0508c807012101434e53103180", CreateCardOS_V4 }, // CardOS V4.3 CNS profile, 2004.02.20 + { "006b0508c808012101434e53103180", CreateCardOS_V4 }, // CardOS V4.3B CNS profile, 2004.02.20 + { "006b0508c806011101434e53103180", CreateCardOS_V4 }, // CardOS V4.2 CNS profile, 2005.03.11 + { "006b0508c807011101434e53103180", CreateCardOS_V4 }, // CardOS V4.3 CNS profile, 2005.03.11 + { "006b0508c808011101434e53103180", CreateCardOS_V4 }, // CardOS V4.3B CNS profile, 2005.03.11 + { "006b0508c808011101434e53103180", CreateCardOS_V4 }, // CardOS V4.3B CNS profile, 2005.03.11 + { "4b53776973735369676e", CreateCardOS_V4 }, // CardOS V4.3B/V4.4 ATR by SwissSign + + { ACT_ISO7816OS_NAME, CreateISO7816OS }, // use act::ISO7816OS as fallback + { 0, 0 } + }; + + // ------------------------------------------------------------------------ + const SCardTokenMapEntry SCardTokenMap[] = + { + // PKCS#15 + { IsV4PKCS15ECProfile, CreateV4PKCS15ECProfile }, + { IsV4PKCS15Profile, CreateV4PKCS15Profile }, + + // CardOS + { IsM4cvMoCProfile, CreateM4cvMoCProfile }, + { IsM4cvECProfile, CreateM4cvECProfile }, + { IsV4cvECProfile, CreateV4cvECProfile }, + { IsV4cvProfile, CreateV4cvProfile }, + { IsM4cvProfile, CreateM4cvProfile }, + // { IsV4CNSProfile, CreateV4CNSProfile }, + + { 0, 0 } + }; + + // ------------------------------------------------------------------------ + const PKCS15BehaviorMapEntry PKCS15BehaviorMap[] = + { + { "cv cryptovision gmbh (c) v1.0n", CreateV4PKCS15Behavior }, + { "", CreatePKCS15Behavior }, // default + { 0, 0 } + }; + + // ------------------------------------------------------------------------ + const TokenExtensionMapEntry TokenExtensionMap[] = + { + { "MDProfileExt", CreateMDProfileExt }, // Minidriver FS Profile Extension + { 0, 0 } + }; + + // ------------------------------------------------------------------------ + const TokenAuthProtocolMapEntry TokenAuthProtocolMap[] = + { + { "EAC 2.01 PACE", CreateTokenAuthPACE }, + { "EAC 2.01 TA", CreateTokenAuthTA }, + { "EAC 2.01 CA", CreateTokenAuthCA }, + { "BAC", CreateTokenAuthBAC }, + { 0, 0 } + }; + + // ------------------------------------------------------------------------ + const SubsystemMapEntry SubsystemMap[] = + { + { "PCSC", CreatePCSCSystem, CreatePCSCSystemEx }, + { 0, 0, 0 } + }; + + // ------------------------------------------------------------------------ + const SlotMonitorRegEntry SlotMonitorMap[] = + { + { "PCSC", { CreatePCSCSlotMonitor, CreatePCSCSystemSlotMonitor } }, + { 0, { 0, 0 } } + }; + +#endif // NO_SMARTCARD + + // ------------------------------------------------------------------------ + // Version: V1R4M4 + const char* GetVersion(); + + // ------------------------------------------------------------------------ + inline void Init(bool bAlwaysInit = false) + { + static bool loaded = false; + if(loaded == true && bAlwaysInit == false) + return; + + KeyReg::Insert(KeyMap); + HashReg::Insert(HashMap); + EMSAReg::Insert(EMSAMap); + PaddingReg::Insert(PaddingMap); + CertificateReg::Insert(CertificateMap); + +#ifndef NO_SMARTCARD + SubsystemReg::Insert(SubsystemMap); + SlotMonitorReg::Insert(SlotMonitorMap); + SCardOSReg::Insert(SCardOSMap); + SCardTokenReg::Insert(SCardTokenMap); + PKCS15BehaviorReg::Insert(PKCS15BehaviorMap); + TokenExtensionReg::Insert(TokenExtensionMap); + TokenAuthProtocolReg::Insert(TokenAuthProtocolMap); +#endif + CreateFastRNG = CreateFIPS186; + CreateStrongRNG = CreateBBS; + loaded = true; + } + +} // namespace act + +#endif // actInit_h diff --git a/openssl-act-engine/SecOpGuard.cpp b/openssl-act-engine/src/SecOpGuard.cpp similarity index 100% rename from openssl-act-engine/SecOpGuard.cpp rename to openssl-act-engine/src/SecOpGuard.cpp diff --git a/openssl-act-engine/SecOpGuard.h b/openssl-act-engine/src/SecOpGuard.h similarity index 100% rename from openssl-act-engine/SecOpGuard.h rename to openssl-act-engine/src/SecOpGuard.h diff --git a/openssl-act-engine/SlotList.cpp b/openssl-act-engine/src/SlotList.cpp similarity index 100% rename from openssl-act-engine/SlotList.cpp rename to openssl-act-engine/src/SlotList.cpp diff --git a/openssl-act-engine/SlotList.h b/openssl-act-engine/src/SlotList.h similarity index 100% rename from openssl-act-engine/SlotList.h rename to openssl-act-engine/src/SlotList.h diff --git a/openssl-act-engine/SyncObject.h b/openssl-act-engine/src/SyncObject.h similarity index 95% rename from openssl-act-engine/SyncObject.h rename to openssl-act-engine/src/SyncObject.h index c834e60..e6ca779 100644 --- a/openssl-act-engine/SyncObject.h +++ b/openssl-act-engine/src/SyncObject.h @@ -1,184 +1,184 @@ -////////////////////////////////////////////////////////////////////////// -// Name: SyncObject.h -// Product: cv act library -// Purpose: Multithreading synchronization primitive for multiple Operating Systems. -// -// Copyright: (c) 2009 cv cryptovision GmbH -// all rights reserved -// Licence: The conditions for the use of this software are regulated -// in the cv act library licence agreement. -// -// Autor: Markus Tesche -// Date: 04/23/2009 -////////////////////////////////////////////////////////////////////////// - -#ifndef SyncObject_h -#define SyncObject_h - -#include "actBasics.h" - -#if defined(ACT_WIN32_WCE) -# include "SyncObjectWinCE.h" - -#elif defined(ACT_WIN32) -# include "SyncObjectWin32.h" - -#elif defined(ACT_SOLARIS) -# include "SyncObjectSloaris.h" - -#elif defined(ACT_MACOSX) -# include "SyncObjectMacOS.h" - -// posix has always to be last checked ! -#elif defined(ACT_POSIX) -# include "SyncObjectPosix.h" - -#else -# error SyncObject not implemented for this system - -#endif - -#include "actHandle.h" -#include "actISynchronize.h" - -namespace act -{ - // - // Synchronizeable<> - template - < - typename BaseT, /* ISynchronize or derived */ - typename SyncObjectT = SyncObject - > - class Synchronizeable : public BaseT - { - public: - typedef SyncObjectT SyncObject; - typedef ValueHandle SyncHandle; - - protected: - // - // ISynchronize methods - virtual void Lock() { syncObject().lock(); } - virtual void Unlock() { syncObject().unlock(); } - virtual long LockCount() const { return syncObject().lockCount(); } - - virtual const Handle& syncHandle() const { return m_sync_handle; } - - protected: - SyncObjectT& syncObject() const { return m_sync_handle.valueRef(); } - - protected: - ValueHandle m_sync_handle; - }; - - // - // GuardT<> - template - < - class SyncObjectT, - class BaseT = void, - class TypeT = void - > - class GuardT; - - // - // GuardT<> - template - class GuardT - { - public: - typedef SyncObjectT SyncObject; - - private: - GuardT(const GuardT&); - GuardT& operator=(const GuardT&); - - public: - GuardT(SyncObjectT& sync_object) - : m_sync_object(sync_object) - { - m_sync_object.lock(); - } - - GuardT(const Handle& sync_handle) - : m_sync_object(sync_handle.requiredAs()) - { - m_sync_object.lock(); - } - - GuardT(const ValueHandle& sync_handle) - : m_sync_object(sync_handle.valueRef()) - { - m_sync_object.lock(); - } - - ~GuardT() - { - m_sync_object.unlock(); - } - - long LockCount() const { return m_sync_object.lockCount(); } - - protected: - SyncObjectT& m_sync_object; - }; - - // - // GuardT<> - template - class GuardT - { - public: - typedef SyncObjectT SyncObject; - - private: - GuardT(const GuardT&); - GuardT& operator=(const GuardT&); - - public: - GuardT(ISynchronize& synchronize) - : m_guard(synchronize.syncHandle()) - { } - - GuardT(const ISynchronize& synchronize) - : m_guard(synchronize.syncHandle()) - { } - - long LockCount() const { return m_guard.LockCount(); } - - protected: - GuardT m_guard; - }; - - // - // GuardT<> - template - class GuardT - : public GuardT - { - public: - GuardT(TypeT& synchronize) - : GuardT(synchronize) - , m_synchronized(synchronize) - { } - - TypeT* operator->() const { return &m_synchronized; } - - protected: - TypeT& m_synchronized; - }; - - - typedef GuardT Guard; - typedef GuardT Synchronize; - - template - GuardT Synchronized(TypeT& synchronize) - { - return GuardT(synchronize); - } - -} // namespace act - -#endif // SyncObject_h +////////////////////////////////////////////////////////////////////////// +// Name: SyncObject.h +// Product: cv act library +// Purpose: Multithreading synchronization primitive for multiple Operating Systems. +// +// Copyright: (c) 2009 cv cryptovision GmbH +// all rights reserved +// Licence: The conditions for the use of this software are regulated +// in the cv act library licence agreement. +// +// Autor: Markus Tesche +// Date: 04/23/2009 +////////////////////////////////////////////////////////////////////////// + +#ifndef SyncObject_h +#define SyncObject_h + +#include "actBasics.h" + +#if defined(ACT_WIN32_WCE) +# include "SyncObjectWinCE.h" + +#elif defined(ACT_WIN32) +# include "SyncObjectWin32.h" + +#elif defined(ACT_SOLARIS) +# include "SyncObjectSloaris.h" + +#elif defined(ACT_MACOSX) +# include "SyncObjectMacOS.h" + +// posix has always to be last checked ! +#elif defined(ACT_POSIX) +# include "SyncObjectPosix.h" + +#else +# error SyncObject not implemented for this system + +#endif + +#include "actHandle.h" +#include "actISynchronize.h" + +namespace act +{ + // + // Synchronizeable<> + template + < + typename BaseT, /* ISynchronize or derived */ + typename SyncObjectT = SyncObject + > + class Synchronizeable : public BaseT + { + public: + typedef SyncObjectT SyncObject; + typedef ValueHandle SyncHandle; + + protected: + // + // ISynchronize methods + virtual void Lock() { syncObject().lock(); } + virtual void Unlock() { syncObject().unlock(); } + virtual long LockCount() const { return syncObject().lockCount(); } + + virtual const Handle& syncHandle() const { return m_sync_handle; } + + protected: + SyncObjectT& syncObject() const { return m_sync_handle.valueRef(); } + + protected: + ValueHandle m_sync_handle; + }; + + // + // GuardT<> + template + < + class SyncObjectT, + class BaseT = void, + class TypeT = void + > + class GuardT; + + // + // GuardT<> + template + class GuardT + { + public: + typedef SyncObjectT SyncObject; + + private: + GuardT(const GuardT&); + GuardT& operator=(const GuardT&); + + public: + GuardT(SyncObjectT& sync_object) + : m_sync_object(sync_object) + { + m_sync_object.lock(); + } + + GuardT(const Handle& sync_handle) + : m_sync_object(sync_handle.requiredAs()) + { + m_sync_object.lock(); + } + + GuardT(const ValueHandle& sync_handle) + : m_sync_object(sync_handle.valueRef()) + { + m_sync_object.lock(); + } + + ~GuardT() + { + m_sync_object.unlock(); + } + + long LockCount() const { return m_sync_object.lockCount(); } + + protected: + SyncObjectT& m_sync_object; + }; + + // + // GuardT<> + template + class GuardT + { + public: + typedef SyncObjectT SyncObject; + + private: + GuardT(const GuardT&); + GuardT& operator=(const GuardT&); + + public: + GuardT(ISynchronize& synchronize) + : m_guard(synchronize.syncHandle()) + { } + + GuardT(const ISynchronize& synchronize) + : m_guard(synchronize.syncHandle()) + { } + + long LockCount() const { return m_guard.LockCount(); } + + protected: + GuardT m_guard; + }; + + // + // GuardT<> + template + class GuardT + : public GuardT + { + public: + GuardT(TypeT& synchronize) + : GuardT(synchronize) + , m_synchronized(synchronize) + { } + + TypeT* operator->() const { return &m_synchronized; } + + protected: + TypeT& m_synchronized; + }; + + + typedef GuardT Guard; + typedef GuardT Synchronize; + + template + GuardT Synchronized(TypeT& synchronize) + { + return GuardT(synchronize); + } + +} // namespace act + +#endif // SyncObject_h diff --git a/openssl-act-engine/SyncObjectMacOS.h b/openssl-act-engine/src/SyncObjectMacOS.h similarity index 93% rename from openssl-act-engine/SyncObjectMacOS.h rename to openssl-act-engine/src/SyncObjectMacOS.h index aca4e8f..0a476ef 100644 --- a/openssl-act-engine/SyncObjectMacOS.h +++ b/openssl-act-engine/src/SyncObjectMacOS.h @@ -1,46 +1,46 @@ -#ifndef SyncObject_MacOS_h -#define SyncObject_MacOS_h - -#ifndef SyncObject_h -# error include SyncObject.h instead -#endif - -#include - -namespace act -{ - class SyncObject - { - private: - SyncObject(const SyncObject&); - SyncObject& operator=(const SyncObject&); - - public: - SyncObject(); - ~SyncObject(); - - void lock(); - void unlock(); - - long lockCount() const { return m_lock_count; } - MPTaskID threadId() const { return m_thread_id; } - - private: - volatile long m_lock_count; - volatile MPTaskID m_thread_id; - MPCriticalRegionID m_sync; - }; - - void Sleep(long msec); - -} // namespace act - -#ifdef verify -# undef verify -#endif - -#ifdef check -# undef check -#endif - -#endif // SyncObject_MacOS_h +#ifndef SyncObject_MacOS_h +#define SyncObject_MacOS_h + +#ifndef SyncObject_h +# error include SyncObject.h instead +#endif + +#include + +namespace act +{ + class SyncObject + { + private: + SyncObject(const SyncObject&); + SyncObject& operator=(const SyncObject&); + + public: + SyncObject(); + ~SyncObject(); + + void lock(); + void unlock(); + + long lockCount() const { return m_lock_count; } + MPTaskID threadId() const { return m_thread_id; } + + private: + volatile long m_lock_count; + volatile MPTaskID m_thread_id; + MPCriticalRegionID m_sync; + }; + + void Sleep(long msec); + +} // namespace act + +#ifdef verify +# undef verify +#endif + +#ifdef check +# undef check +#endif + +#endif // SyncObject_MacOS_h diff --git a/openssl-act-engine/SyncObjectPosix.h b/openssl-act-engine/src/SyncObjectPosix.h similarity index 94% rename from openssl-act-engine/SyncObjectPosix.h rename to openssl-act-engine/src/SyncObjectPosix.h index 2509915..f82f0e6 100644 --- a/openssl-act-engine/SyncObjectPosix.h +++ b/openssl-act-engine/src/SyncObjectPosix.h @@ -1,38 +1,38 @@ -#ifndef SyncObject_Posix_h -#define SyncObject_Posix_h - -#ifndef SyncObject_h -# error include SyncObject.h instead -#endif - -#include - -namespace act -{ - class SyncObject - { - private: - SyncObject(const SyncObject&); - SyncObject& operator=(const SyncObject&); - - public: - SyncObject(); - ~SyncObject(); - - void lock(); - void unlock(); - - long lockCount() const { return m_lock_count; } - pid_t threadId() const { return m_thread_id; } - - private: - volatile long m_lock_count; - volatile pid_t m_thread_id; - pthread_mutex_t m_sync; - }; - - void Sleep(long msec); - -} // namespace act - -#endif // SyncObject_Posix_h +#ifndef SyncObject_Posix_h +#define SyncObject_Posix_h + +#ifndef SyncObject_h +# error include SyncObject.h instead +#endif + +#include + +namespace act +{ + class SyncObject + { + private: + SyncObject(const SyncObject&); + SyncObject& operator=(const SyncObject&); + + public: + SyncObject(); + ~SyncObject(); + + void lock(); + void unlock(); + + long lockCount() const { return m_lock_count; } + pid_t threadId() const { return m_thread_id; } + + private: + volatile long m_lock_count; + volatile pid_t m_thread_id; + pthread_mutex_t m_sync; + }; + + void Sleep(long msec); + +} // namespace act + +#endif // SyncObject_Posix_h diff --git a/openssl-act-engine/SyncObjectSolaris.h b/openssl-act-engine/src/SyncObjectSolaris.h similarity index 94% rename from openssl-act-engine/SyncObjectSolaris.h rename to openssl-act-engine/src/SyncObjectSolaris.h index 40a662d..30a8b48 100644 --- a/openssl-act-engine/SyncObjectSolaris.h +++ b/openssl-act-engine/src/SyncObjectSolaris.h @@ -1,38 +1,38 @@ -#ifndef SyncObject_Solaris_h -#define SyncObject_Solaris_h - -#ifndef SyncObject_h -# error include SyncObject.h instead -#endif - -#include - -namespace act -{ - class SyncObject - { - private: - SyncObject(const SyncObject&); - SyncObject& operator=(const SyncObject&); - - public: - SyncObject(); - ~SyncObject(); - - void lock(); - void unlock(); - - long lockCount() const { return m_lock_count; } - pid_t threadId() const { return m_thread_id; } - - private: - volatile long m_lock_count; - volatile pid_t m_thread_id; - pthread_mutex_t m_sync; - }; - - void Sleep(long msec); - -} // namespace act - -#endif // SyncObject_Solaris_h +#ifndef SyncObject_Solaris_h +#define SyncObject_Solaris_h + +#ifndef SyncObject_h +# error include SyncObject.h instead +#endif + +#include + +namespace act +{ + class SyncObject + { + private: + SyncObject(const SyncObject&); + SyncObject& operator=(const SyncObject&); + + public: + SyncObject(); + ~SyncObject(); + + void lock(); + void unlock(); + + long lockCount() const { return m_lock_count; } + pid_t threadId() const { return m_thread_id; } + + private: + volatile long m_lock_count; + volatile pid_t m_thread_id; + pthread_mutex_t m_sync; + }; + + void Sleep(long msec); + +} // namespace act + +#endif // SyncObject_Solaris_h diff --git a/openssl-act-engine/SyncObjectWin32.h b/openssl-act-engine/src/SyncObjectWin32.h similarity index 94% rename from openssl-act-engine/SyncObjectWin32.h rename to openssl-act-engine/src/SyncObjectWin32.h index 3fb13dc..b3da6eb 100644 --- a/openssl-act-engine/SyncObjectWin32.h +++ b/openssl-act-engine/src/SyncObjectWin32.h @@ -1,39 +1,39 @@ -#ifndef SyncObject_Win32_h -#define SyncObject_Win32_h - -#ifndef SyncObject_h -# error include SyncObject.h instead -#endif - -#ifndef _WIN32_WINNT -# define _WIN32_WINNT 0x0403 -#endif -#include - -namespace act -{ - class SyncObject - { - private: - SyncObject(const SyncObject&); - SyncObject& operator=(const SyncObject&); - - public: - SyncObject(); - ~SyncObject(); - - void lock(); - void unlock(); - - long lockCount() const { return m_lock_count; } - DWORD threadId() const { return m_thread_id; } - - private: - volatile long m_lock_count; - volatile DWORD m_thread_id; - CRITICAL_SECTION m_sync; - }; - -} // namespace act - -#endif // SyncObject_Win32_h +#ifndef SyncObject_Win32_h +#define SyncObject_Win32_h + +#ifndef SyncObject_h +# error include SyncObject.h instead +#endif + +#ifndef _WIN32_WINNT +# define _WIN32_WINNT 0x0403 +#endif +#include + +namespace act +{ + class SyncObject + { + private: + SyncObject(const SyncObject&); + SyncObject& operator=(const SyncObject&); + + public: + SyncObject(); + ~SyncObject(); + + void lock(); + void unlock(); + + long lockCount() const { return m_lock_count; } + DWORD threadId() const { return m_thread_id; } + + private: + volatile long m_lock_count; + volatile DWORD m_thread_id; + CRITICAL_SECTION m_sync; + }; + +} // namespace act + +#endif // SyncObject_Win32_h diff --git a/openssl-act-engine/SyncObjectWinCE.h b/openssl-act-engine/src/SyncObjectWinCE.h similarity index 94% rename from openssl-act-engine/SyncObjectWinCE.h rename to openssl-act-engine/src/SyncObjectWinCE.h index 6a62f86..dc94e74 100644 --- a/openssl-act-engine/SyncObjectWinCE.h +++ b/openssl-act-engine/src/SyncObjectWinCE.h @@ -1,36 +1,36 @@ -#ifndef SyncObject_WinCE_h -#define SyncObject_WinCE_h - -#ifndef SyncObject_h -# error include SyncObject.h instead -#endif - -#include - -namespace act -{ - class SyncObject - { - private: - SyncObject(const SyncObject&); - SyncObject& operator=(const SyncObject&); - - public: - SyncObject(); - ~SyncObject(); - - void lock(); - void unlock(); - - long lockCount() const { return m_lock_count; } - DWORD threadId() const { return m_thread_id; } - - private: - volatile long m_lock_count; - volatile DWORD m_thread_id; - CRITICAL_SECTION m_sync; - }; - -} // namespace act - -#endif // SyncObject_WinCE_h +#ifndef SyncObject_WinCE_h +#define SyncObject_WinCE_h + +#ifndef SyncObject_h +# error include SyncObject.h instead +#endif + +#include + +namespace act +{ + class SyncObject + { + private: + SyncObject(const SyncObject&); + SyncObject& operator=(const SyncObject&); + + public: + SyncObject(); + ~SyncObject(); + + void lock(); + void unlock(); + + long lockCount() const { return m_lock_count; } + DWORD threadId() const { return m_thread_id; } + + private: + volatile long m_lock_count; + volatile DWORD m_thread_id; + CRITICAL_SECTION m_sync; + }; + +} // namespace act + +#endif // SyncObject_WinCE_h diff --git a/openssl-act-engine/Warns.h b/openssl-act-engine/src/Warns.h similarity index 94% rename from openssl-act-engine/Warns.h rename to openssl-act-engine/src/Warns.h index 1442ca6..f2a2053 100644 --- a/openssl-act-engine/Warns.h +++ b/openssl-act-engine/src/Warns.h @@ -1,7 +1,7 @@ -#ifndef __WARNS_H__ -#define __WARNS_H__ - -#define _SCL_SECURE_NO_WARNINGS -#define _CRT_SECURE_NO_WARNINGS - -#endif +#ifndef __WARNS_H__ +#define __WARNS_H__ + +#define _SCL_SECURE_NO_WARNINGS +#define _CRT_SECURE_NO_WARNINGS + +#endif diff --git a/openssl-act-engine/actUtility.h b/openssl-act-engine/src/actUtility.h similarity index 96% rename from openssl-act-engine/actUtility.h rename to openssl-act-engine/src/actUtility.h index 702a4b9..f389cc9 100644 --- a/openssl-act-engine/actUtility.h +++ b/openssl-act-engine/src/actUtility.h @@ -1,654 +1,654 @@ -////////////////////////////////////////////////////////////////////////////////// -// Name: actUtility.h -// Product: cv act library -// Purpose: useful global functions -// -// Copyright: (c) 2000-2001 cv cryptovision GmbH -// all rights reserved -// Licence: The conditions for the use of this software are regulated -// in the cv act library licence agreement. -////////////////////////////////////////////////////////////////////////////////// - -#ifndef ACT_Utility_h -#define ACT_Utility_h - -#include "actBlob.h" -#include "actBasics.h" -#include "actException.h" - -#include -#include -#include -#include -#include -#include - -#if defined(__GNUC__) && (__GNUC__ < 4) - namespace act { typedef std::basic_string wstring; } -#else - namespace act { using std::wstring; } -#endif - -namespace act -{ - class IParam; - - // - // Const Values - // - - extern const size_t sizeof_uuid; - - // - // Prototypes - // - - const char* get_string_param(paramid_t id, IParam* owner); - - // Converts an unsigned hexadecimal number (independent of prefix "0x") - // into a Blob and backwards. - // - for blob2hex: the user has to allocate hexnumber - Blob& hex2blob(const char* hexnumber, Blob& b); - inline Blob& hex2blob(const std::string& hexnumber, Blob& b) - { - return hex2blob(hexnumber.c_str(), b); - } - inline Blob hex2blob(const char* hexnumber) - { - Blob b; - return move(hex2blob(hexnumber, b)); - } - - void blob2hex(const Blob& b, char* hexnumber); - std::string blob2hex(const Blob& b); - - // file i/o for act::Blob - bool file2blob(const char* filename, Blob &blob); - bool blob2file(const char* filename, const act::Blob &blob); - - // Create an ISO 9834-8 / RFC 4122 version 4 (pseudo random) UUID. - // Output string format is "xxxxxxxx-xxxx-4xxx-vxxx-xxxxxxxxxxxx", where - // x is random hex char 0 <= x <= f and v an element of { 8, 9, a, b}. - void createPseudoRandomUUID(Blob& uuid, bool network_byte_order = true); - std::string createPseudoRandomUUID(); - std::string uuid2string(const Blob& uuid, bool is_network_byte_order = true); - void swapTimeFields(Blob& uuid); - - std::string serno2string(const act::Blob& serno); - std::string id2string(const act::Blob& id, bool is_network_byte_order = true); - - // CBCMAC with ISO padding - void iCBCMAC(const char* cipher, const Blob& iv, const Blob& mac_key, - const Blob& mac_data, Blob& mac); - - void SetDESKeyParity(Blob &key); - bool CheckDESKeyParity(const Blob &key); - - void get_string_seq(const std::string& s, const std::string start, const std::string end, - std::string& result, bool case_sens); - - bool wstr2utf8(const wchar_t* str, std::string& utf8); - bool utf82wstr(const char* utf8, act::wstring& wstr); - - void ASN1ToSequenceOf(Blob& asn1_data); - Blob GetASN1SequenceOf(const Blob& asn1_data); - Blob GetASN1EncodedLength(size_t length); - - size_t SkipTagLength(byte tag, const byte* tlv_data, size_t tlv_data_len); - size_t SkipTLVElement(byte tag, const byte* tlv_data, size_t tlv_data_len, bool skip_value = true); - int FindTlvTemplate(Blob& contentb, const Blob& inb, int intag, int counts); - - // - // Implementation - // - - // - // -------------------------------------------------------------------- - template - const Blob SafeGetName(TypeT* instance) - { - Blob name; - if(instance != 0) - { - const char* cname = RegistryT::GetName(instance->GetCreatePointer()); - if(cname != 0) ConverterT(cname).swap(name); - } - return move(name); - } - - // --------------------------------------------------------------------------- - template - struct is_whitespace : is_whitespace - { - typedef typename TypeT::value_type argument_type; - using is_whitespace::operator(); - }; - - template<> - struct is_whitespace - { - typedef char argument_type; - bool operator()(unsigned char value) const { return std::isspace(value) != 0; } - }; - - template<> - struct is_whitespace - { - typedef wchar_t argument_type; - bool operator()(wchar_t value) const { return std::iswspace(value) != 0; } - }; - - // --------------------------------------------------------------------------- - template - inline TypeT& erase_right(const PredicateT& predicate, TypeT& value) - { - value.erase(std::find_if(value.rbegin(), value.rend(), predicate).base(), value.end()); - return value; - } - - // --------------------------------------------------------------------------- - template - inline void fill(TypeT* begin, size_t length, byte value) - { - ACT_ASSERT(begin != 0); - std::fill(reinterpret_cast(begin), - reinterpret_cast(begin) + length, value); - } - - // - // scoped_delete - // --------------------------------------------------------------------------- - template - struct scoped_delete - { - PointerT _ptr; - - explicit scoped_delete(PointerT ptr) : _ptr(ptr) { } - ~scoped_delete() { delete _ptr; } - - PointerT operator->() const - { - if(_ptr == 0) throw NullPointerException(); - return _ptr; - } - }; - - // --------------------------------------------------------------------------- - template - scoped_delete checked_delete(PointerT& ptr_ref) - { - PointerT ptr = ptr_ref; ptr_ref = 0; - return scoped_delete(ptr); - } - - // - // scoped_delete - // --------------------------------------------------------------------------- - template - < - template class AutoPtrT, - class TypeT - > - struct scoped_delete, void, 1> - { - AutoPtrT _ptr; - - explicit scoped_delete(AutoPtrT& ptr) : _ptr(ptr) { } - ~scoped_delete() { AutoPtrT(_ptr); } - - TypeT* operator->() const - { - TypeT* ptr = _ptr.get(); - if(ptr == 0) throw NullPointerException(); - return ptr; - } - }; - - // --------------------------------------------------------------------------- - template - < - template class AutoPtrT, - class TypeT - > - scoped_delete, void, 1> checked_delete(AutoPtrT& ptr_ref) - { - return scoped_delete, void, 1>(ptr_ref); - } - - - // - // scoped_delete > - // --------------------------------------------------------------------------- - template - < - template class ArrayT, - class TypeT, class AllocatorT, - typename DestructF - > - struct scoped_delete, DestructF, 3> - { - typedef ArrayT container_type; - typedef DestructF destruct_func; - - explicit scoped_delete(container_type& _container, const destruct_func& _destruct) - : destruct(_destruct) - { container.swap(_container); } - - ~scoped_delete() - { release(container, destruct); } - - static void release(container_type& container, const destruct_func& destruct) - { - if(container.empty() == true) return; - - container_type failed; - typedef typename container_type::const_iterator const_iterator; - for(const_iterator i(container.begin()), end(container.end()); i != end; ++i) - try { destruct(*i); } - catch(Exception&) { failed.push_back(*i); } - - container.swap(failed); - } - - destruct_func destruct; - container_type container; - }; - - // - // checked_delete(array_of_ptr_to_type, std::mem_fun(&type::destruct)); - // --------------------------------------------------------------------------- - template - < - template class ArrayT, - class TypeT, class AllocatorT, - typename DestructF - > - scoped_delete, DestructF, 3> - checked_delete(ArrayT& container, const DestructF& destruct) - { - return scoped_delete, DestructF, 3>(container, destruct); - } - - // - // scoped_delete > - // --------------------------------------------------------------------------- - template - < - template class MapT, - class KeyT, class TypeT, class PredT, class AllocatorT, - typename DestructF - > - struct scoped_delete, DestructF, 4> - { - typedef MapT container_type; - typedef DestructF destruct_func; - - explicit scoped_delete(container_type& _container, const destruct_func& _destruct) - : destruct(_destruct) - { container.swap(_container); } - - ~scoped_delete() - { release(container, destruct); } - - static void release(container_type& container, const destruct_func& destruct) - { - if(container.empty() == true) return; - - container_type failed; - typedef typename container_type::const_iterator const_iterator; - for(const_iterator i(container.begin()), end(container.end()); i != end; ++i) - try { destruct(i->second); } - catch(Exception&) { failed.insert(*i); } - - container.swap(failed); - } - - destruct_func destruct; - container_type container; - }; - - // - // checked_delete_map(map_of_ptr_to_type, std::mem_fun(&type::destruct)); - // --------------------------------------------------------------------------- - template - < - template class MapT, - class KeyT, class TypeT, class PredT, class AllocatorT, - typename DestructF - > - scoped_delete, DestructF, 4> - checked_delete_map(MapT& map_ref, const DestructF& destruct) - { - return scoped_delete, DestructF, 4>(map_ref, destruct); - } - - // - // scoped_delete<> - // --------------------------------------------------------------------------- - template - struct scoped_delete - { - scoped_delete(const DestructF& _destruct) - : destruct(_destruct) - { } - - ~scoped_delete() - { if(value.empty() == false) checked_delete(value, destruct); } - - DestructF destruct; - TypeT value; - }; - - // - // checked_static_cast<> - // --------------------------------------------------------------------------- - template - inline U checked_static_cast(V p) - { - ACT_ASSERT(p != 0); - ACT_ASSERT(dynamic_cast(p) != 0); - return static_cast(p); - } - - // --------------------------------------------------------------------------- - template - inline TypeT& byref(const TypeT& e) - { - return const_cast(e); - } - - // --------------------------------------------------------------------------- - inline int max_int() - { - return int((unsigned(1) << (8 * sizeof(int) - 1)) - 1); - } - - // --------------------------------------------------------------------------- - inline void OS2IP(Blob& number) - { - // octet string to integer presentation - if((number.at(0) & byte(0x80)) != 0) - number.insert(number.begin(), 0); - } - - // --------------------------------------------------------------------------- - inline void I2OSP(Blob& number) - { - // integer to octet string presentation - if(number.at(0) == byte(0)) - number.erase(number.begin()); - } - - // --------------------------------------------------------------------------- - inline void byte2long(const byte *in, size_t input_len, uint32 *out) - { - size_t i, output_len = input_len / 4; - for(i = 0; i < output_len; i++) - out[i]= in[i*4] | (in[i*4+1] << 8) | (in[i*4+2] << 16) | (in[i*4+3] << 24); - } - - // --------------------------------------------------------------------------- - inline void long2byte(const uint32 *in, size_t input_len, byte *out) - { - size_t i, output_len = input_len * 4; - for(i = 0; i < output_len; i++) - out[i] = byte(in[i/4] >> (8*(i%4))); - } - - // --------------------------------------------------------------------------- - inline void sweep(void* Mem,size_t l) - { - std::fill_n(reinterpret_cast(Mem), l, byte(0)); - } - - // --------------------------------------------------------------------------- - template - inline const TypeT Min(const TypeT& a, const TypeT& b) - { - return (a < b) ? a : b; - } - - // --------------------------------------------------------------------------- - template - inline const TypeT& Max(const TypeT& a, const TypeT& b) - { - return (a - inline void xor_n(T1 a, T2 len, T3 b) - { - for(T2 i = 0; i < len; i++) b[i] ^= a[i]; - } - - // --------------------------------------------------------------------------- - template inline void Xor (T1 a, T1 a_end, T3 b) - { - while(a < a_end) - *b++ ^= *a++; - } - - // --------------------------------------------------------------------------- - inline const char* blob2char(Blob& b) - { - b.push_back(byte(0)); - return reinterpret_cast(&b[0]); - } - - // --------------------------------------------------------------------------- - inline std::string blob2string(const Blob& value) - { - return value.empty() == false ? - std::string(reinterpret_cast(&value.at(0)), - reinterpret_cast(&value[0] + value.size())) : - std::string(); - } - - // --------------------------------------------------------------------------- - inline std::string byte2hex(const byte i) - { - char tmp[3]; - sprintf(tmp, "%02x", i); - return tmp; - } - - // --------------------------------------------------------------------------- - inline bool isHex(const byte c) - { - if((c < byte('0') || c > byte('9')) - && (c < byte('a') || c > byte('f')) - && (c < byte('A') || c > byte('F'))) - return false; - - return true; - } - - // --------------------------------------------------------------------------- - inline bool isHex(const Blob& b) - { - size_t i, b_len = b.size(); - - for(i = 0; i < b_len; ++i) - if(!isHex(b[i])) - return false; - - return true; - } - - // --------------------------------------------------------------------------- - inline bool isAlphanumeric(const byte c) - { - if((c < byte('0') || c > byte('9')) - && (c < byte('a') || c > byte('z')) - && (c < byte('A') || c > byte('Z'))) - return false; - - return true; - } - - // --------------------------------------------------------------------------- - inline bool isAlphanumeric(const Blob& b) - { - size_t i, b_len = b.size(); - - for(i = 0; i < b_len; ++i) - if(!isAlphanumeric(b[i])) - return false; - - return true; - } - - // --------------------------------------------------------------------------- - inline bool isPrintable(const Blob& b) - { - size_t i, b_len = b.size(); - - for(i = 0; i < b_len; ++i) - if(isprint(int(b[i])) == 0) - return false; - - return true; - } - - // --------------------------------------------------------------------------- - inline bool isUUIDFormat(const Blob& b) - { - size_t b_len = b.size(); - - if(b_len != sizeof_uuid) - return false; - - // check if the Blob contains only hexadecimal characters, - // separated by '-' (UUID string representation) - for(size_t i = 0; i < b_len; ++i) - if(!isHex(b[i]) && (b[i] != byte('-'))) - return false; - - return true; - } - - // --------------------------------------------------------------------------- - inline std::string short2hex(const unsigned short i) - { - char tmp[5]; - sprintf(tmp,"%04x",i); - return tmp; - } - - // --------------------------------------------------------------------------- - inline std::string long2hex(const unsigned long i) - { - char tmp[9]; - sprintf(tmp,"%08lx",i); - return tmp; - } - - // --------------------------------------------------------------------------- - inline unsigned long blob2long(const Blob& b) - { - if(b.size() == 0) - throw LogicalException("bad size","blob2long"); - - Blob tmp(b); - while(tmp[0] == 0 && tmp.size() > sizeof(long)) - tmp.erase(tmp.begin()); - - if(tmp.size() > sizeof(long)) - throw LogicalException("bad size", "blob2long"); - - unsigned long n = tmp[0]; - for(unsigned int i = 1; i < tmp.size(); ++i) - { - n <<= 8; - n |= tmp[i]; - } - return n; - } - - // --------------------------------------------------------------------------- - inline Blob& long2blob(unsigned long n, Blob& value) - { - value.resize(sizeof(long)); - for(size_t i = sizeof(long) - 1, j = 0; j < sizeof(long); --i, ++j) - value[j] = byte((n >> (8 * i)) & 0xff); - return value; - } - - // --------------------------------------------------------------------------- - inline Blob long2blob(unsigned long n) - { - Blob value; - return move(long2blob(n, value)); - } - - // --------------------------------------------------------------------------- - inline Blob size2blob(size_t size) - { - Blob tmp; - tmp.reserve(8); - - if(size == 0) - { - tmp.resize(1); - return move(tmp); - } - size_t remaining = size; - while(remaining > 0) - { - tmp.insert(tmp.begin(), byte(remaining & 0xFF)); - remaining >>= 8; - } - return move(tmp); - } - - // --------------------------------------------------------------------------- - inline unsigned short blob2short(const Blob& b) - { - if(b.size() != sizeof(short)) - throw LogicalException("bad size", "blob2short"); - - unsigned short n = b[1]; - n += (b[0] << 8); - return n; - } - - // --------------------------------------------------------------------------- - // Input: a (big endian byte arrays) - // Output: ++a (increment with carry) - inline byte memincr(byte* a, int len) - { - int i = len-1; - byte carry; - do { - carry = ++a[i] == 0 ? 1 : 0; - } while( --i >= 0 && carry != 0); - return carry; - } - - // --------------------------------------------------------------------------- - // Input: a, b (big endian byte arrays) - // Output: a += b (add with carry) - inline byte memadd(byte* a, const byte* b, int len, byte carry = 0) - { - int i = len - 1; - unsigned long tmp; - for(; i >= 0; --i) - { - tmp = a[i] + b[i] + carry; - a[i] = byte(tmp & 0xff); - carry = byte(tmp >> 8); - } - return carry; - } - - // --------------------------------------------------------------------------- - inline void convert_to_upper(std::string& s) - { - for(std::string::iterator it = s.begin(); it != s.end() ; ++it) - *it = toupper(*it); - } - -} //namespace act - -#endif // ACT_Utility_h +////////////////////////////////////////////////////////////////////////////////// +// Name: actUtility.h +// Product: cv act library +// Purpose: useful global functions +// +// Copyright: (c) 2000-2001 cv cryptovision GmbH +// all rights reserved +// Licence: The conditions for the use of this software are regulated +// in the cv act library licence agreement. +////////////////////////////////////////////////////////////////////////////////// + +#ifndef ACT_Utility_h +#define ACT_Utility_h + +#include "actBlob.h" +#include "actBasics.h" +#include "actException.h" + +#include +#include +#include +#include +#include +#include + +#if defined(__GNUC__) && (__GNUC__ < 4) + namespace act { typedef std::basic_string wstring; } +#else + namespace act { using std::wstring; } +#endif + +namespace act +{ + class IParam; + + // + // Const Values + // + + extern const size_t sizeof_uuid; + + // + // Prototypes + // + + const char* get_string_param(paramid_t id, IParam* owner); + + // Converts an unsigned hexadecimal number (independent of prefix "0x") + // into a Blob and backwards. + // - for blob2hex: the user has to allocate hexnumber + Blob& hex2blob(const char* hexnumber, Blob& b); + inline Blob& hex2blob(const std::string& hexnumber, Blob& b) + { + return hex2blob(hexnumber.c_str(), b); + } + inline Blob hex2blob(const char* hexnumber) + { + Blob b; + return move(hex2blob(hexnumber, b)); + } + + void blob2hex(const Blob& b, char* hexnumber); + std::string blob2hex(const Blob& b); + + // file i/o for act::Blob + bool file2blob(const char* filename, Blob &blob); + bool blob2file(const char* filename, const act::Blob &blob); + + // Create an ISO 9834-8 / RFC 4122 version 4 (pseudo random) UUID. + // Output string format is "xxxxxxxx-xxxx-4xxx-vxxx-xxxxxxxxxxxx", where + // x is random hex char 0 <= x <= f and v an element of { 8, 9, a, b}. + void createPseudoRandomUUID(Blob& uuid, bool network_byte_order = true); + std::string createPseudoRandomUUID(); + std::string uuid2string(const Blob& uuid, bool is_network_byte_order = true); + void swapTimeFields(Blob& uuid); + + std::string serno2string(const act::Blob& serno); + std::string id2string(const act::Blob& id, bool is_network_byte_order = true); + + // CBCMAC with ISO padding + void iCBCMAC(const char* cipher, const Blob& iv, const Blob& mac_key, + const Blob& mac_data, Blob& mac); + + void SetDESKeyParity(Blob &key); + bool CheckDESKeyParity(const Blob &key); + + void get_string_seq(const std::string& s, const std::string start, const std::string end, + std::string& result, bool case_sens); + + bool wstr2utf8(const wchar_t* str, std::string& utf8); + bool utf82wstr(const char* utf8, act::wstring& wstr); + + void ASN1ToSequenceOf(Blob& asn1_data); + Blob GetASN1SequenceOf(const Blob& asn1_data); + Blob GetASN1EncodedLength(size_t length); + + size_t SkipTagLength(byte tag, const byte* tlv_data, size_t tlv_data_len); + size_t SkipTLVElement(byte tag, const byte* tlv_data, size_t tlv_data_len, bool skip_value = true); + int FindTlvTemplate(Blob& contentb, const Blob& inb, int intag, int counts); + + // + // Implementation + // + + // + // -------------------------------------------------------------------- + template + const Blob SafeGetName(TypeT* instance) + { + Blob name; + if(instance != 0) + { + const char* cname = RegistryT::GetName(instance->GetCreatePointer()); + if(cname != 0) ConverterT(cname).swap(name); + } + return move(name); + } + + // --------------------------------------------------------------------------- + template + struct is_whitespace : is_whitespace + { + typedef typename TypeT::value_type argument_type; + using is_whitespace::operator(); + }; + + template<> + struct is_whitespace + { + typedef char argument_type; + bool operator()(unsigned char value) const { return std::isspace(value) != 0; } + }; + + template<> + struct is_whitespace + { + typedef wchar_t argument_type; + bool operator()(wchar_t value) const { return std::iswspace(value) != 0; } + }; + + // --------------------------------------------------------------------------- + template + inline TypeT& erase_right(const PredicateT& predicate, TypeT& value) + { + value.erase(std::find_if(value.rbegin(), value.rend(), predicate).base(), value.end()); + return value; + } + + // --------------------------------------------------------------------------- + template + inline void fill(TypeT* begin, size_t length, byte value) + { + ACT_ASSERT(begin != 0); + std::fill(reinterpret_cast(begin), + reinterpret_cast(begin) + length, value); + } + + // + // scoped_delete + // --------------------------------------------------------------------------- + template + struct scoped_delete + { + PointerT _ptr; + + explicit scoped_delete(PointerT ptr) : _ptr(ptr) { } + ~scoped_delete() { delete _ptr; } + + PointerT operator->() const + { + if(_ptr == 0) throw NullPointerException(); + return _ptr; + } + }; + + // --------------------------------------------------------------------------- + template + scoped_delete checked_delete(PointerT& ptr_ref) + { + PointerT ptr = ptr_ref; ptr_ref = 0; + return scoped_delete(ptr); + } + + // + // scoped_delete + // --------------------------------------------------------------------------- + template + < + template class AutoPtrT, + class TypeT + > + struct scoped_delete, void, 1> + { + AutoPtrT _ptr; + + explicit scoped_delete(AutoPtrT& ptr) : _ptr(ptr) { } + ~scoped_delete() { AutoPtrT(_ptr); } + + TypeT* operator->() const + { + TypeT* ptr = _ptr.get(); + if(ptr == 0) throw NullPointerException(); + return ptr; + } + }; + + // --------------------------------------------------------------------------- + template + < + template class AutoPtrT, + class TypeT + > + scoped_delete, void, 1> checked_delete(AutoPtrT& ptr_ref) + { + return scoped_delete, void, 1>(ptr_ref); + } + + + // + // scoped_delete > + // --------------------------------------------------------------------------- + template + < + template class ArrayT, + class TypeT, class AllocatorT, + typename DestructF + > + struct scoped_delete, DestructF, 3> + { + typedef ArrayT container_type; + typedef DestructF destruct_func; + + explicit scoped_delete(container_type& _container, const destruct_func& _destruct) + : destruct(_destruct) + { container.swap(_container); } + + ~scoped_delete() + { release(container, destruct); } + + static void release(container_type& container, const destruct_func& destruct) + { + if(container.empty() == true) return; + + container_type failed; + typedef typename container_type::const_iterator const_iterator; + for(const_iterator i(container.begin()), end(container.end()); i != end; ++i) + try { destruct(*i); } + catch(Exception&) { failed.push_back(*i); } + + container.swap(failed); + } + + destruct_func destruct; + container_type container; + }; + + // + // checked_delete(array_of_ptr_to_type, std::mem_fun(&type::destruct)); + // --------------------------------------------------------------------------- + template + < + template class ArrayT, + class TypeT, class AllocatorT, + typename DestructF + > + scoped_delete, DestructF, 3> + checked_delete(ArrayT& container, const DestructF& destruct) + { + return scoped_delete, DestructF, 3>(container, destruct); + } + + // + // scoped_delete > + // --------------------------------------------------------------------------- + template + < + template class MapT, + class KeyT, class TypeT, class PredT, class AllocatorT, + typename DestructF + > + struct scoped_delete, DestructF, 4> + { + typedef MapT container_type; + typedef DestructF destruct_func; + + explicit scoped_delete(container_type& _container, const destruct_func& _destruct) + : destruct(_destruct) + { container.swap(_container); } + + ~scoped_delete() + { release(container, destruct); } + + static void release(container_type& container, const destruct_func& destruct) + { + if(container.empty() == true) return; + + container_type failed; + typedef typename container_type::const_iterator const_iterator; + for(const_iterator i(container.begin()), end(container.end()); i != end; ++i) + try { destruct(i->second); } + catch(Exception&) { failed.insert(*i); } + + container.swap(failed); + } + + destruct_func destruct; + container_type container; + }; + + // + // checked_delete_map(map_of_ptr_to_type, std::mem_fun(&type::destruct)); + // --------------------------------------------------------------------------- + template + < + template class MapT, + class KeyT, class TypeT, class PredT, class AllocatorT, + typename DestructF + > + scoped_delete, DestructF, 4> + checked_delete_map(MapT& map_ref, const DestructF& destruct) + { + return scoped_delete, DestructF, 4>(map_ref, destruct); + } + + // + // scoped_delete<> + // --------------------------------------------------------------------------- + template + struct scoped_delete + { + scoped_delete(const DestructF& _destruct) + : destruct(_destruct) + { } + + ~scoped_delete() + { if(value.empty() == false) checked_delete(value, destruct); } + + DestructF destruct; + TypeT value; + }; + + // + // checked_static_cast<> + // --------------------------------------------------------------------------- + template + inline U checked_static_cast(V p) + { + ACT_ASSERT(p != 0); + ACT_ASSERT(dynamic_cast(p) != 0); + return static_cast(p); + } + + // --------------------------------------------------------------------------- + template + inline TypeT& byref(const TypeT& e) + { + return const_cast(e); + } + + // --------------------------------------------------------------------------- + inline int max_int() + { + return int((unsigned(1) << (8 * sizeof(int) - 1)) - 1); + } + + // --------------------------------------------------------------------------- + inline void OS2IP(Blob& number) + { + // octet string to integer presentation + if((number.at(0) & byte(0x80)) != 0) + number.insert(number.begin(), 0); + } + + // --------------------------------------------------------------------------- + inline void I2OSP(Blob& number) + { + // integer to octet string presentation + if(number.at(0) == byte(0)) + number.erase(number.begin()); + } + + // --------------------------------------------------------------------------- + inline void byte2long(const byte *in, size_t input_len, uint32 *out) + { + size_t i, output_len = input_len / 4; + for(i = 0; i < output_len; i++) + out[i]= in[i*4] | (in[i*4+1] << 8) | (in[i*4+2] << 16) | (in[i*4+3] << 24); + } + + // --------------------------------------------------------------------------- + inline void long2byte(const uint32 *in, size_t input_len, byte *out) + { + size_t i, output_len = input_len * 4; + for(i = 0; i < output_len; i++) + out[i] = byte(in[i/4] >> (8*(i%4))); + } + + // --------------------------------------------------------------------------- + inline void sweep(void* Mem,size_t l) + { + std::fill_n(reinterpret_cast(Mem), l, byte(0)); + } + + // --------------------------------------------------------------------------- + template + inline const TypeT Min(const TypeT& a, const TypeT& b) + { + return (a < b) ? a : b; + } + + // --------------------------------------------------------------------------- + template + inline const TypeT& Max(const TypeT& a, const TypeT& b) + { + return (a + inline void xor_n(T1 a, T2 len, T3 b) + { + for(T2 i = 0; i < len; i++) b[i] ^= a[i]; + } + + // --------------------------------------------------------------------------- + template inline void Xor (T1 a, T1 a_end, T3 b) + { + while(a < a_end) + *b++ ^= *a++; + } + + // --------------------------------------------------------------------------- + inline const char* blob2char(Blob& b) + { + b.push_back(byte(0)); + return reinterpret_cast(&b[0]); + } + + // --------------------------------------------------------------------------- + inline std::string blob2string(const Blob& value) + { + return value.empty() == false ? + std::string(reinterpret_cast(&value.at(0)), + reinterpret_cast(&value[0] + value.size())) : + std::string(); + } + + // --------------------------------------------------------------------------- + inline std::string byte2hex(const byte i) + { + char tmp[3]; + sprintf(tmp, "%02x", i); + return tmp; + } + + // --------------------------------------------------------------------------- + inline bool isHex(const byte c) + { + if((c < byte('0') || c > byte('9')) + && (c < byte('a') || c > byte('f')) + && (c < byte('A') || c > byte('F'))) + return false; + + return true; + } + + // --------------------------------------------------------------------------- + inline bool isHex(const Blob& b) + { + size_t i, b_len = b.size(); + + for(i = 0; i < b_len; ++i) + if(!isHex(b[i])) + return false; + + return true; + } + + // --------------------------------------------------------------------------- + inline bool isAlphanumeric(const byte c) + { + if((c < byte('0') || c > byte('9')) + && (c < byte('a') || c > byte('z')) + && (c < byte('A') || c > byte('Z'))) + return false; + + return true; + } + + // --------------------------------------------------------------------------- + inline bool isAlphanumeric(const Blob& b) + { + size_t i, b_len = b.size(); + + for(i = 0; i < b_len; ++i) + if(!isAlphanumeric(b[i])) + return false; + + return true; + } + + // --------------------------------------------------------------------------- + inline bool isPrintable(const Blob& b) + { + size_t i, b_len = b.size(); + + for(i = 0; i < b_len; ++i) + if(isprint(int(b[i])) == 0) + return false; + + return true; + } + + // --------------------------------------------------------------------------- + inline bool isUUIDFormat(const Blob& b) + { + size_t b_len = b.size(); + + if(b_len != sizeof_uuid) + return false; + + // check if the Blob contains only hexadecimal characters, + // separated by '-' (UUID string representation) + for(size_t i = 0; i < b_len; ++i) + if(!isHex(b[i]) && (b[i] != byte('-'))) + return false; + + return true; + } + + // --------------------------------------------------------------------------- + inline std::string short2hex(const unsigned short i) + { + char tmp[5]; + sprintf(tmp,"%04x",i); + return tmp; + } + + // --------------------------------------------------------------------------- + inline std::string long2hex(const unsigned long i) + { + char tmp[9]; + sprintf(tmp,"%08lx",i); + return tmp; + } + + // --------------------------------------------------------------------------- + inline unsigned long blob2long(const Blob& b) + { + if(b.size() == 0) + throw LogicalException("bad size","blob2long"); + + Blob tmp(b); + while(tmp[0] == 0 && tmp.size() > sizeof(long)) + tmp.erase(tmp.begin()); + + if(tmp.size() > sizeof(long)) + throw LogicalException("bad size", "blob2long"); + + unsigned long n = tmp[0]; + for(unsigned int i = 1; i < tmp.size(); ++i) + { + n <<= 8; + n |= tmp[i]; + } + return n; + } + + // --------------------------------------------------------------------------- + inline Blob& long2blob(unsigned long n, Blob& value) + { + value.resize(sizeof(long)); + for(size_t i = sizeof(long) - 1, j = 0; j < sizeof(long); --i, ++j) + value[j] = byte((n >> (8 * i)) & 0xff); + return value; + } + + // --------------------------------------------------------------------------- + inline Blob long2blob(unsigned long n) + { + Blob value; + return move(long2blob(n, value)); + } + + // --------------------------------------------------------------------------- + inline Blob size2blob(size_t size) + { + Blob tmp; + tmp.reserve(8); + + if(size == 0) + { + tmp.resize(1); + return move(tmp); + } + size_t remaining = size; + while(remaining > 0) + { + tmp.insert(tmp.begin(), byte(remaining & 0xFF)); + remaining >>= 8; + } + return move(tmp); + } + + // --------------------------------------------------------------------------- + inline unsigned short blob2short(const Blob& b) + { + if(b.size() != sizeof(short)) + throw LogicalException("bad size", "blob2short"); + + unsigned short n = b[1]; + n += (b[0] << 8); + return n; + } + + // --------------------------------------------------------------------------- + // Input: a (big endian byte arrays) + // Output: ++a (increment with carry) + inline byte memincr(byte* a, int len) + { + int i = len-1; + byte carry; + do { + carry = ++a[i] == 0 ? 1 : 0; + } while( --i >= 0 && carry != 0); + return carry; + } + + // --------------------------------------------------------------------------- + // Input: a, b (big endian byte arrays) + // Output: a += b (add with carry) + inline byte memadd(byte* a, const byte* b, int len, byte carry = 0) + { + int i = len - 1; + unsigned long tmp; + for(; i >= 0; --i) + { + tmp = a[i] + b[i] + carry; + a[i] = byte(tmp & 0xff); + carry = byte(tmp >> 8); + } + return carry; + } + + // --------------------------------------------------------------------------- + inline void convert_to_upper(std::string& s) + { + for(std::string::iterator it = s.begin(); it != s.end() ; ++it) + *it = toupper(*it); + } + +} //namespace act + +#endif // ACT_Utility_h diff --git a/openssl-act-engine/dllmain.cpp b/openssl-act-engine/src/dllmain.cpp similarity index 95% rename from openssl-act-engine/dllmain.cpp rename to openssl-act-engine/src/dllmain.cpp index 8a4edd3..69b5891 100644 --- a/openssl-act-engine/dllmain.cpp +++ b/openssl-act-engine/src/dllmain.cpp @@ -1,19 +1,19 @@ -// dllmain.cpp : Defines the entry point for the DLL application. -#include "stdafx.h" - -BOOL APIENTRY DllMain( HMODULE hModule, - DWORD ul_reason_for_call, - LPVOID lpReserved - ) -{ - switch (ul_reason_for_call) - { - case DLL_PROCESS_ATTACH: - case DLL_THREAD_ATTACH: - case DLL_THREAD_DETACH: - case DLL_PROCESS_DETACH: - break; - } - return TRUE; -} - +// dllmain.cpp : Defines the entry point for the DLL application. +#include "stdafx.h" + +BOOL APIENTRY DllMain( HMODULE hModule, + DWORD ul_reason_for_call, + LPVOID lpReserved + ) +{ + switch (ul_reason_for_call) + { + case DLL_PROCESS_ATTACH: + case DLL_THREAD_ATTACH: + case DLL_THREAD_DETACH: + case DLL_PROCESS_DETACH: + break; + } + return TRUE; +} + diff --git a/openssl-act-engine/engine_front.cpp b/openssl-act-engine/src/engine_front.cpp similarity index 100% rename from openssl-act-engine/engine_front.cpp rename to openssl-act-engine/src/engine_front.cpp diff --git a/openssl-act-engine/engine_sct.cpp b/openssl-act-engine/src/engine_sct.cpp similarity index 100% rename from openssl-act-engine/engine_sct.cpp rename to openssl-act-engine/src/engine_sct.cpp diff --git a/openssl-act-engine/engine_sct.h b/openssl-act-engine/src/engine_sct.h similarity index 100% rename from openssl-act-engine/engine_sct.h rename to openssl-act-engine/src/engine_sct.h diff --git a/openssl-act-engine/engine_sct_internal.h b/openssl-act-engine/src/engine_sct_internal.h similarity index 100% rename from openssl-act-engine/engine_sct_internal.h rename to openssl-act-engine/src/engine_sct_internal.h diff --git a/openssl-act-engine/engine_securetoken.cpp b/openssl-act-engine/src/engine_securetoken.cpp similarity index 94% rename from openssl-act-engine/engine_securetoken.cpp rename to openssl-act-engine/src/engine_securetoken.cpp index d6253ba..0dfd4cc 100644 --- a/openssl-act-engine/engine_securetoken.cpp +++ b/openssl-act-engine/src/engine_securetoken.cpp @@ -1,6 +1,6 @@ -// engine_securetoken.cpp : Defines the exported functions for the DLL application. -// - -#include "stdafx.h" - - +// engine_securetoken.cpp : Defines the exported functions for the DLL application. +// + +#include "stdafx.h" + + diff --git a/openssl-act-engine/src/makefile.am b/openssl-act-engine/src/makefile.am new file mode 100644 index 0000000..d8cdfa6 --- /dev/null +++ b/openssl-act-engine/src/makefile.am @@ -0,0 +1,26 @@ +## @id $Id$ + +## 1 2 3 4 5 6 7 8 +## 45678901234567890123456789012345678901234567890123456789012345678901234567890 + +AM_CXXFLAGS += -I ${top_srcdir}/src -I ${top_srcdir}/../actlibrary/include + +lib_LTLIBRARIES = libengine_act.la +noinst_PROGRAMS = test_engine + +noinst_HEADERS = actUtility.h CardKey.h CardObject.h CertificateList.h \ + engine_sct.h engine_sct_internal.h Init_Engine.h \ + SecOpGuard.h SlotList.h stdafx.h SyncObject.h \ + SyncObjectMacOS.h SyncObjectPosix.h \ + SyncObjectSolaris.h SyncObjectWin32.h \ + SyncObjectWinCE.h targetver.h Warns.h + +libengine_act_la_SOURCES = engine_front.cpp engine_sct.cpp \ + CardObject.cpp CardKey.cpp SlotList.cpp \ + CertificateList.cpp SecOpGuard.cpp +libengine_act_la_LDFLAGS = -version-info @LIB_VERSION@ + +test_engine_SOURCES = test_engine.cpp +test_engine_LDADD = -lssl + +MAINTAINERCLEANFILES = makefile.in diff --git a/openssl-act-engine/stdafx.cpp b/openssl-act-engine/src/stdafx.cpp similarity index 97% rename from openssl-act-engine/stdafx.cpp rename to openssl-act-engine/src/stdafx.cpp index c93cb2a..17ab434 100644 --- a/openssl-act-engine/stdafx.cpp +++ b/openssl-act-engine/src/stdafx.cpp @@ -1,8 +1,8 @@ -// stdafx.cpp : source file that includes just the standard includes -// engine_securetoken.pch will be the pre-compiled header -// stdafx.obj will contain the pre-compiled type information - -#include "stdafx.h" - -// TODO: reference any additional headers you need in STDAFX.H -// and not in this file +// stdafx.cpp : source file that includes just the standard includes +// engine_securetoken.pch will be the pre-compiled header +// stdafx.obj will contain the pre-compiled type information + +#include "stdafx.h" + +// TODO: reference any additional headers you need in STDAFX.H +// and not in this file diff --git a/openssl-act-engine/stdafx.h b/openssl-act-engine/src/stdafx.h similarity index 96% rename from openssl-act-engine/stdafx.h rename to openssl-act-engine/src/stdafx.h index 677e68a..f3a0737 100644 --- a/openssl-act-engine/stdafx.h +++ b/openssl-act-engine/src/stdafx.h @@ -1,16 +1,16 @@ -// stdafx.h : include file for standard system include files, -// or project specific include files that are used frequently, but -// are changed infrequently -// - -#pragma once - -#include "targetver.h" - -#define WIN32_LEAN_AND_MEAN // Exclude rarely-used stuff from Windows headers -// Windows Header Files: -#include - - - -// TODO: reference additional headers your program requires here +// stdafx.h : include file for standard system include files, +// or project specific include files that are used frequently, but +// are changed infrequently +// + +#pragma once + +#include "targetver.h" + +#define WIN32_LEAN_AND_MEAN // Exclude rarely-used stuff from Windows headers +// Windows Header Files: +#include + + + +// TODO: reference additional headers your program requires here diff --git a/openssl-act-engine/targetver.h b/openssl-act-engine/src/targetver.h similarity index 98% rename from openssl-act-engine/targetver.h rename to openssl-act-engine/src/targetver.h index f583181..203dfbc 100644 --- a/openssl-act-engine/targetver.h +++ b/openssl-act-engine/src/targetver.h @@ -1,24 +1,24 @@ -#pragma once - -// The following macros define the minimum required platform. The minimum required platform -// is the earliest version of Windows, Internet Explorer etc. that has the necessary features to run -// your application. The macros work by enabling all features available on platform versions up to and -// including the version specified. - -// Modify the following defines if you have to target a platform prior to the ones specified below. -// Refer to MSDN for the latest info on corresponding values for different platforms. -#ifndef WINVER // Specifies that the minimum required platform is Windows Vista. -#define WINVER 0x0600 // Change this to the appropriate value to target other versions of Windows. -#endif - -#ifndef _WIN32_WINNT // Specifies that the minimum required platform is Windows Vista. -#define _WIN32_WINNT 0x0600 // Change this to the appropriate value to target other versions of Windows. -#endif - -#ifndef _WIN32_WINDOWS // Specifies that the minimum required platform is Windows 98. -#define _WIN32_WINDOWS 0x0410 // Change this to the appropriate value to target Windows Me or later. -#endif - -#ifndef _WIN32_IE // Specifies that the minimum required platform is Internet Explorer 7.0. -#define _WIN32_IE 0x0700 // Change this to the appropriate value to target other versions of IE. -#endif +#pragma once + +// The following macros define the minimum required platform. The minimum required platform +// is the earliest version of Windows, Internet Explorer etc. that has the necessary features to run +// your application. The macros work by enabling all features available on platform versions up to and +// including the version specified. + +// Modify the following defines if you have to target a platform prior to the ones specified below. +// Refer to MSDN for the latest info on corresponding values for different platforms. +#ifndef WINVER // Specifies that the minimum required platform is Windows Vista. +#define WINVER 0x0600 // Change this to the appropriate value to target other versions of Windows. +#endif + +#ifndef _WIN32_WINNT // Specifies that the minimum required platform is Windows Vista. +#define _WIN32_WINNT 0x0600 // Change this to the appropriate value to target other versions of Windows. +#endif + +#ifndef _WIN32_WINDOWS // Specifies that the minimum required platform is Windows 98. +#define _WIN32_WINDOWS 0x0410 // Change this to the appropriate value to target Windows Me or later. +#endif + +#ifndef _WIN32_IE // Specifies that the minimum required platform is Internet Explorer 7.0. +#define _WIN32_IE 0x0700 // Change this to the appropriate value to target other versions of IE. +#endif diff --git a/openssl-act-engine/test_engine.cpp b/openssl-act-engine/src/test_engine.cpp similarity index 98% rename from openssl-act-engine/test_engine.cpp rename to openssl-act-engine/src/test_engine.cpp index fd13fe4..6410e10 100644 --- a/openssl-act-engine/test_engine.cpp +++ b/openssl-act-engine/src/test_engine.cpp @@ -3,6 +3,7 @@ #include #include +#include int main(int argc, char* argv[]) { diff --git a/openssl-act-engine/win32_win2000.vs2008.vsprops b/openssl-act-engine/win32_win2000.vs2008.vsprops index 48f5221..a7a2fa9 100644 --- a/openssl-act-engine/win32_win2000.vs2008.vsprops +++ b/openssl-act-engine/win32_win2000.vs2008.vsprops @@ -1,11 +1,11 @@ - - - - + + + +