pax_global_header00006660000000000000000000000064135745063420014523gustar00rootroot0000000000000052 comment=eedaf1a83e10d95b6a454c21678fcd51fcf99ab4 tpm2-tss-2.3.2/000077500000000000000000000000001357450634200132205ustar00rootroot00000000000000tpm2-tss-2.3.2/.appveyor.yml000066400000000000000000000003661357450634200156730ustar00rootroot00000000000000version: '{build}' pull_requests: do_not_increment_build_number: true skip_tags: true image: Visual Studio 2017 configuration: - Debug - Release platform: - x86 - x64 build: project: tpm2-tss.sln parallel: false verbosity: normal tpm2-tss-2.3.2/.codecov.yml000066400000000000000000000001641357450634200154440ustar00rootroot00000000000000ignore: - "test" coverage: status: project: default: threshold: 1% comment: behavior: new tpm2-tss-2.3.2/.dockerignore000066400000000000000000000000221357450634200156660ustar00rootroot00000000000000test/fuzz/*.fuzz* tpm2-tss-2.3.2/.gitattributes000066400000000000000000000010211357450634200161050ustar00rootroot00000000000000# Set the default behavior, in case people don't have core.autocrlf set. * text=auto # Explicitly declare text files you want to always be normalized and converted # to native line endings on checkout. *.c text eol=lf *.cpp text eol=lf *.h text eol=lf *.am text eol=lf *.in text eol=lf *.ac text eol=lf install text eol=lf # Declare files that will always have CRLF line endings on checkout. *.sln text eol=crlf *.vcxproj text eol=crlf *.mak text eol=crlf # Denote all files that are truly binary and should not be modified. tpm2-tss-2.3.2/.lgtm.yml000066400000000000000000000001031357450634200147560ustar00rootroot00000000000000extraction: cpp: prepare: packages: "autoconf-archive" tpm2-tss-2.3.2/.travis.yml000066400000000000000000000141761357450634200153420ustar00rootroot00000000000000language: c compiler: - gcc - clang dist: xenial cache: ccache env: matrix: - SCANBUILD=yes CC=clang WITH_TCTI_ASYNC=yes WITH_TCTI_PARTIAL=yes WITH_CRYPTO=ossl OPENSSL_BRANCH=OpenSSL_1_1_0-stable - WITH_CRYPTO=ossl OPENSSL_BRANCH=OpenSSL_1_0_2-stable - WITH_CRYPTO=ossl OPENSSL_BRANCH=OpenSSL_1_1_0-stable - WITH_CRYPTO=gcrypt OPENSSL_BRANCH=NONE - WITH_TCTI_ASYNC=yes WITH_TCTI_PARTIAL=yes WITH_CRYPTO=gcrypt OPENSSL_BRANCH=NONE - WITH_TCTI_ASYNC=yes WITH_TCTI_PARTIAL=no WITH_CRYPTO=gcrypt OPENSSL_BRANCH=NONE - WITH_TCTI_ASYNC=no WITH_TCTI_PARTIAL=yes WITH_CRYPTO=gcrypt OPENSSL_BRANCH=NONE global: # COVERITY_SCAN_TOKEN - secure: "ZD0KxBhO/CaSE/TOkW+H5nsBbaMolbIPv5DgctcjA1BlTckgc5lK4m+7BIR1Fft6gaeeLOoCY3qUm4kW++Bqk2bTsrx/HvrmVmrzMO572jA74x4E+5lynUnRVaAgBg7cVBcB0hZcUurx8FifNBbgnWlxT/nDWttVnglkz400GCE9/zy+VTJWqt4QAB+6qeKPiG3vRthQdWcHstBI8IIAbvp4rhSUajBBQeZ5ro5RPGNy+iHen+t6tyJmbjiP0Y4qjkKGbfwXHnsseEcuSJQuxSkQ9MWK6t93BFXFSPw5MjHIApMn+4CjRp2JMoVTVfe5fFeZEHxVUmAzy+e5eIeftrUtUlCI293UuxZnw/vpJczn3BWunlhhjqjsCwVeknzGHxlaT+ck8Et1Mdl/3nY/E9dt47/NOzXY2xrAz59GYsdKvvsPoCGgNlAub03Vl0W24I1kjppsmN/zFwazHGqoxIBTwrDOQUmZvPfXA3jAUozrfAdT3YjnRcCG7bbQmacFApqfUm/bqMgapAgozjjxpuBrO1wQSUjjH6NANZsP2Gpk0eAl7FOlBzbVgKPxCQozWCjpKOj3HMnXX458ZQWsboG5J00wwjw9DRNRCkeexLdi832L/BPhUY5JgRlTqqyKr9cr69DvogBF/pLytpSCciF6t9NqqGZYbBomXJLaG84=" # run coverity scan on gcc build to keep from DOSing coverity - coverity_scan_run_condition='"$CC" = gcc' - LD_LIBRARY_PATH="$(pwd)/osslinstall/usr/local/lib:/usr/lib" - PATH="$(pwd)/ibmtpm/src:${PATH}" addons: apt: packages: - autoconf-archive - doxygen - libcmocka-dev - libcmocka0 - libgcrypt20-dev - realpath - lcov - libssl-dev - gnulib coverity_scan: project: name: "01org/TPM2.0-TSS" description: Build submitted via Travis-CI notification_email: philip.b.tricca@intel.com build_command_prepend: "./bootstrap && ./configure" build_command: "make --jobs=$(nproc)" branch_pattern: coverity_scan install: # Autoconf archive - wget http://ftpmirror.gnu.org/autoconf-archive/autoconf-archive-2019.01.06.tar.xz - sha256sum autoconf-archive-2019.01.06.tar.xz | grep -q 17195c833098da79de5778ee90948f4c5d90ed1a0cf8391b4ab348e2ec511e3f || travis_terminate 1 - tar xJf autoconf-archive-2019.01.06.tar.xz - cp autoconf-archive-2019.01.06/m4/ax_code_coverage.m4 m4/ - cp autoconf-archive-2019.01.06/m4/ax_is_release.m4 m4/ - cp autoconf-archive-2019.01.06/m4/ax_prog_doxygen.m4 m4/ # IBM-TPM - wget https://download.01.org/tpm2/ibmtpm974.tar.gz - sha256sum ibmtpm974.tar.gz | grep -q ^8e45d86129a0adb95fee4cee51f4b1e5b2d81ed3e55af875df53f98f39eb7ad7 || travis_terminate 1 - mkdir ibmtpm - tar axf ibmtpm974.tar.gz -C ibmtpm - make -C ibmtpm/src -j$(nproc) # 2.1.0 version of uthash - wget https://github.com/troydhanson/uthash/archive/v2.1.0.tar.gz - tar xzf v2.1.0.tar.gz - mkdir -p $(pwd)/osslinstall/usr/local/include - cp uthash-2.1.0/src/*.h $(pwd)/osslinstall/usr/local/include/ # OpenSSL 1.0.2 (Must come after all wgets, since it overrides libcrypto.so for the test-environment) - | if [ "$OPENSSL_BRANCH" != "NONE" ]; then mkdir -p osslinstall/usr/local/bin git clone --branch $OPENSSL_BRANCH --depth=1 https://github.com/openssl/openssl.git pushd openssl ./config --prefix=/usr/local --openssldir=/usr/local/openssl shared make -j$(nproc) if [ "$OPENSSL_BRANCH" == "OpenSSL_1_0_2-stable" ]; then make install INSTALL_PREFIX=${PWD}/../osslinstall else make install DESTDIR=${PWD}/../osslinstall fi which openssl popd fi before_script: - ./bootstrap script: # Check for whitespace errors - git diff --check $(git hash-object -t tree /dev/null) # short-circuit normal build if we've already done a coverity scan - | if [ "${COVERITY_SCAN_BRANCH}" == 1 ]; then echo "COVERITY_SCAN_BRANCH set, not running normal build." exit 0 fi # build with no tests enabled - mkdir ./build-no-tests - pushd ./build-no-tests - ../configure --enable-tcti-partial-reads=$WITH_TCTI_PARTIAL --enable-tcti-device-async=$WITH_TCTI_ASYNC --with-crypto=$WITH_CRYPTO CFLAGS=-I${PWD}/../osslinstall/usr/local/include LDFLAGS=-L${PWD}/../osslinstall/usr/local/lib - make -j$(nproc) - popd # build with all tests enabled - mkdir ./build - pushd ./build - | if [ "$CC" == "gcc" ]; then export CONFIGURE_OPTIONS="--enable-code-coverage"; fi - | if [ "$SCANBUILD" == "yes" ]; then scan-build --status-bugs ../configure --enable-tcti-partial-reads=$WITH_TCTI_PARTIAL --enable-tcti-device-async=$WITH_TCTI_ASYNC --enable-unit --enable-integration --with-crypto=$WITH_CRYPTO $CONFIGURE_OPTIONS CFLAGS=-I${PWD}/../osslinstall/usr/local/include LDFLAGS=-L${PWD}/../osslinstall/usr/local/lib elif [ "$CC" == "clang" ]; then ../configure --enable-tcti-partial-reads=$WITH_TCTI_PARTIAL --enable-tcti-device-async=$WITH_TCTI_ASYNC --enable-unit --enable-integration --with-crypto=$WITH_CRYPTO $CONFIGURE_OPTIONS CFLAGS=-I${PWD}/../osslinstall/usr/local/include LDFLAGS=-L${PWD}/../osslinstall/usr/local/lib else ../configure --enable-tcti-partial-reads=$WITH_TCTI_PARTIAL --enable-tcti-device-async=$WITH_TCTI_ASYNC --enable-unit --enable-integration --with-crypto=$WITH_CRYPTO $CONFIGURE_OPTIONS CFLAGS=-I${PWD}/../osslinstall/usr/local/include LDFLAGS=-L${PWD}/../osslinstall/usr/local/lib fi - | if [ "$SCANBUILD" == "yes" ]; then scan-build --status-bugs make -j distcheck elif [ "$CC" == "clang" ]; then make -j distcheck else make -j check fi after_success: - | if [ "$CC" == "gcc" ]; then bash <(curl -s https://codecov.io/bash) fi # check fuzz targets matrix: include: - env: WITH_CRYPTO=ossl OPENSSL_BRANCH=OpenSSL_1_1_0-stable GEN_FUZZ=1 CXX=clang++ CC=clang compiler: clang script: - ./configure --with-fuzzing=libfuzzer --enable-tcti-fuzzing --disable-tcti-device --disable-tcti-mssim --disable-shared --with-crypto=$WITH_CRYPTO CFLAGS=-I${PWD}/osslinstall/usr/local/include LDFLAGS=-L${PWD}/osslinstall/usr/local/lib - make -j$(nproc) check tpm2-tss-2.3.2/CHANGELOG.md000066400000000000000000001121101357450634200150250ustar00rootroot00000000000000# Change Log All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/) ## [2.3.2] - 2019-12-12 ### Fixed - Fix unit tests on S390 architectures ## [2.3.1] - 2019-08-30 ### Fixed - Fixed HMAC generation for policy sessions ## [2.3.0] - 2019-08-13 ### Added - tss2-tctildr: A new library that helps with tcti initialization Recommend to use this in place of custom tcti loading code now ! - tss2-rc: A new library that provides textual representations for return codes - Added release and maintainance info (~3 per year and latest 2 are supported) - Support for building on VxWorks. - Option to disable NIST-deprecated crypto (--disable-weak-crypto) - Support Esys_TR_FromTPMPublic on sessions (for use in Esys_FlushContext) - Better Windows/VS Support - Fuzz-Testing and Valgrind-Testing - map-files with correct symbol lists for tss2-sys and tss2-esys This may lead to unresolved symbols in linked applications ### Changed - Several further minor fixes and cleanups - Support to call Tss2_Sys_Execute repeatedly on certain errors - Reduced RAM consumption in Esys due to Tss2_Sys_Execute change - Automated session attribution clearing for esys (decrypt and encrypt) per cmd - Switched to git.mk, many ax_ makros and away from gnulib - Switched to config.h and autoheaders ### Removed - Removed libtss2-mu from "Requires" field of libtss2-esys.pc Needs to be added explicitely now ### Fixed - All fixes from 2.2.1, 2.2.2 and 2.2.3 - SPDX License Identifiers - Null-pointer problems in tcti-tbs - Default locality for tcti-mssim set to LOC_0 - coverity and valgrind leaks detected in test programs (not library code) ## [2.2.3] - 2019-05-28 ### Fixed - Fix computation of session name - Fixed PolicyPassword handling of session Attributes - Fixed windows build from dist ball - Fixed default tcti configure option - Fixed nonce size calculation in ESYS sessions ## [2.2.2] - 2019-03-28 ### Fixed - Fixed wrong encryption flag in EncryptDecrypt - Fixing openssl engine invocation ## [2.2.1] - 2019-02-28 ### Fixed - Forced RAND_bytes method to software implementation to avoid session spoofing - Fixed OpenSSL symbolic naming conflict - Fixed leaks of local point variables and BN_ctx - Fixed memory leaks related to using regular free on gcrypt allocated objects - Fixed leak of rsa->n in iesys_cryptossl_pk_encrypt - Fixed memory leaks in iesys_cryptossl_pk_encrypt - Fixed possible NULL dereference of big number ## [2.2.0] - 2019-02-04 ### Fixed - Fixed leak of hkey on success in iesys_cryptossl_hmac_start - Fixed NULL ptr issues in Esys_HMAC_Start, Esys_HierarchyChangeAuth and Esys_NV_ChangeAuth - Fixed NULL ptr issue in sequenceHandleNode - Fixed NULL ptr auth handling in Esys_TR_SetAuth - Fixed NULL auth handling in iesys_compute_session_value - Fixed marshaling of TPM2Bs with sub types. - Fixed NULL ptr session handling in Esys_TRSess_SetAttributes - Fixed the way size of the hmac value of a session without authorization - Added missing MU functions for TPM2_NT type - Added missing MU functions for TPMA_ID_OBJECT type - Added missing type TPM2_NT into tss2_tpm2_types.h - Fixed wrong typename _ID_OBJECT in tss2_tpm2_types.h - Fixed build breakage when --with-maxloglevel is not 'trace' - Fixed build breakage in generated configure script when CFLAGS is set - Fixed configure scritp ERROR_IF_NO_PROG macro - Changed TPM2B type unmarshal to use sizeof of the dest buffer instead of dest - Fixed unmarshaling of the TPM2B type with invalid size - Removed dead code defect detected by coverity from Esys_TRSess_GetNonceTPM ### Added - Added support for QNX build - Added support for partial reads in device TCTI ## [2.1.1] - 2019-02-04 ### Fixed - Fixed leak of hkey on success in iesys_cryptossl_hmac_start - Fixed NULL ptr issues in Esys_HMAC_Start, Esys_HierarchyChangeAuth and Esys_NV_ChangeAuth - Fixed NULL ptr issue in sequenceHandleNode - Fixed NULL ptr auth handling in Esys_TR_SetAuth - Fixed NULL auth handling in iesys_compute_session_value - Fixed marshaling of TPM2Bs with sub types. - Fixed NULL ptr session handling in Esys_TRSess_SetAttributes - Fixed the way size of the hmac value of a session without authorization - Added missing MU functions for TPM2_NT type - Added missing MU functions for TPMA_ID_OBJECT type - Added missing type TPM2_NT into tss2_tpm2_types.h - Fixed wrong typename _ID_OBJECT in tss2_tpm2_types.h - Fixed build breakage when --with-maxloglevel is not 'trace' - Fixed build breakage in generated configure script when CFLAGS is set - Fixed configure scritp ERROR_IF_NO_PROG macro - Changed TPM2B type unmarshal to use sizeof of the dest buffer instead of dest - Fixed unmarshaling of the TPM2B type with invalid size - Removed dead code defect detected by coverity from Esys_TRSess_GetNonceTPM ## [2.1.0] ### Fixed - Fixed handling of the default TCTI - Changed logging to be ISO-C99 compatible - Fixed leak of dlopen handle - Fixed logging of a response header tag in Tss2_Sys_Execute - Fixed marshaling of TPM2B parameters in SAPI commands - Fixed unnecessary warning in Esys_Startup - Fixed warnings in doxygen documentation ### Added - Added Esys_Free wrapper function for systems using different C runtime libraries - Added Windows TBS TCTI - Added non-blocking mode of operation in tcti-device - Added tests for Esys_HMAC and Esys_Hash - Enabled integration tests on physical TPM device - Added openssl libcrypto backend - Added Doxygen documentation to integration tests ### Changed - Refactored SetDecryptParam - Enabled OpenSSL crypto backend by default ## [2.0.2] - 2019-02-04 ### Fixed - Fixed NULL ptr issues in Esys_HMAC_Start, Esys_HierarchyChangeAuth and Esys_NV_ChangeAuth - Fixed NULL ptr issue in sequenceHandleNode - Fixed NULL ptr auth handling in Esys_TR_SetAuth - Fixed NULL auth handling in iesys_compute_session_value - Fixed marshaling of TPM2Bs with sub types. - Fixed NULL ptr session handling in Esys_TRSess_SetAttributes - Fixed the way size of the hmac value of a session without authorization - Added missing MU functions for TPM2_NT type - Added missing MU functions for TPMA_ID_OBJECT type - Added missing type TPM2_NT into tss2_tpm2_types.h - Fixed wrong typename _ID_OBJECT in tss2_tpm2_types.h - Fixed build breakage when --with-maxloglevel is not 'trace' - Fixed build breakage in generated configure script when CFLAGS is set - Fixed configure scritp ERROR_IF_NO_PROG macro - Changed TPM2B type unmarshal to use sizeof of the dest buffer instead of dest - Fixed unmarshaling of the TPM2B type with invalid size - Removed dead code defect detected by coverity from Esys_TRSess_GetNonceTPM ## [2.0.1] - 2018-08-10 ### Fixed - Fixed problems with doxygan failing make distcheck - Fixed conversion of gcrypt mpi numbers to binary data - Fixed an error in parsing socket address in MSSIM TCTI - Fixed compilation error with --disable-tcti-mssim - Added initialization function for gcrypt to suppress warning - Fixed invalid type base type while marshaling TPMI_ECC_CURVE in Tss2_Sys_ECC_Parameters - Fixed invalid RSA encryption with exponent equal to 0 - Fixed checking of return codes in ESAPI commands - Added checks for programs required by the test harness @ configure time - Fixed warning on TPM2_RC_INITIALIZE rc after a Startup in Esys_Startup - Checked for 1.2 TPM type response - Changed constants values in esys header file to unsigned ## [2.0.0] - 2018-06-20 ### Added - Implementation of the Marshal/Unmarshal library (libtss2-mu) - Implementation of the Enhanced System API (libtss2-esys aka ESAPI) - New implemetation of the TPM Command Transmission Interface (TCTI) for: - communication with Linux TPM2 device driver: libtss2-tcti-device - communication with Microsoft software simulator: libtss2-tcti-mssim - New directory layout (API break) - Updated documentation with new doxygen and updated man pages - Support for Windows build with Visual Studio and clang, currently limited to libtss2-mu and libtss2-sys - Implementation of the new Attached Component (AC) commands - Implementation of the new TPM2_PolicyAuthorizeNV command - Implementation of the new TPM2_CreateLoaded command - Implementation of the new TPM2_PolicyTemplate command - Addition of _Complete functions to all TPM commands - New logging framework - Added const qualifiers to API input pointers (API break) - Cleaned up headers and remove implementation.h and tpm2.h (API break) ### Changed - Converted all cpp files to c, removed dependency on C++ compiler. - Cleaned out a number of marshaling functions from the SAPI code. - Update Linux / Unix OS detection to use non-obsolete macros. - Changed TCTI macros to CamelCase (API break) - Changed TPMA_types to unsigned int with defines instead of bitfield structs (API/ABI break) - Changed Get/SetCmd/RspAuths to new parameter types (API/ABI break) - Fixed order of parameters in AC commands: Input command authorizations now come after the input handles, but still before the command parameters. ### Removed - Removed all sysapi/sysapi_utils/*arshal_TPM*.c files ### Fixed - Updated invalid number of handles in TPM2_PolicyNvWritten and TPM2_TestParms - Updated PlatformCommand function from libtss2-tcti-mssim to no longer send CANCEL_OFF before every command. - Expanded TPM2B macros and removed TPM2B_TYPE1 and TPM2B_TYPE2 macros - Fixed wrong return type for Tss2_Sys_Finalize (API break). ## [1.4.0] - 2018-03-02 ### Added - Attached Component commands from the last public review spec. ### Fixed - Essential files missing from release tarballs are now included. - Version string generation has been moved from configure.ac to the bootstrap script. It is now stored in a file named `VERSION` that is shipped in the release tarball. - We've stopped shipping the built man page for InitSocketTcti.3 and now ship the source. ## [1.3.0] - 2017-12-07 ### Added - Implementation of the EncryptDecrypt2 command. - Coding standard documentation. - Support for latest TPM2 simulator v974 (only changes in test harness). - Check cmocka version for compatibility with 1.0 API. ### Fixed - Definition of HMAC_SESSION_LAST and POLICY_SESSION_LAST. - Drop cast from TPM_ALG_XXX definitions - Use mock functions with built-in cast to avoid compiler warnings from manual cast. - Free memory correctly on error condition return paths in InitSysContext & SockServer. ## [1.2.0] - 2017-08-25 ### Added - Support for PTT-specific capabilities. - Manuals with overviews for SAPI and TCTI layers & TCTI init functions. - Further decomposition of the tpmclient program into an integration test harness based on the automake infrastructure. ### Changed - File list generated by bootstrap script is now sorted to play nice with reproducible builds. - Test harness now supports parallel execution of integration tests. - libtcti-socket interrupted syscalls now resume. - Additional hardening of compiler / linker flags. - All options supported by `tpmclient` executable now removed. - Unimplemented TCTI functions now return NOT_IMPLEMENTED RC. ### Fixed - NULL dereference bugs in TCTI modules. - Cleanup & structure initialization to keep coverity scans happy. - Fixed memory leak in integration test harness. ## [1.1.0] - 2017-05-10 ### Changed - tpmclient, disabled all tests that rely on the old resourcemgr. ### Fixed - Fixed definition of PCR_LAST AND TRANSIENT_LAST macros. ### Removed - tpmtest - resourcemgr, replacement is in new repo: https://github.com/01org/tpm2-abrmd ## [1.0] - 2016-11-01 ### Added - Travis-CI integration with GitHub - Unit tests for primitive (un)?marshal functions. - Example systemd unit for resourcemgr. - Allow for unit tests to be enabled selectively. - added pkg-config files for libraries ### Changed - move simulator initialization code to socket TCTI init function. - socket TCTI finalize no longer frees context - rename libtss2 to libsapi - rename libtcti_device to libtcti-device - rename libtcti_socket to libtcti-socket - move $(includedir)/tss to $(includedir)/sapi - Move default compiler flags to config.site file. ### Fixed - Fix run away resourcemgr threads by closing client sockets when resourcemgr recv() call returns 0. - Set MSG_NOSIGNAL for client connections to avoid SIGPIPE killing resourcemgr. - Fixes to handling of persistent objects by resourcemgr. ### Removed - Semicolon from TPMA_* macros definitions. - Windows build files. - SAPI_CLIENT macro tests. ### Security - Fix buffer overflow in resourcemgr. ## [0.98] - 2015-07-28 ### Added - Added ability for resource manager to communicate with a real TPM via /dev/tpm0 (Linux only). Added command line switch to select simulator if not communicating with a real TPM. ### Changed - Rearranged directory structure in a more logical fashion. - Changed name of Linux makefiles from “makefile.linux” to makefile. This was done in preparation for autotools porting (future enhancement). - Changed tpm library’s windows makefile from “makefile” to “windows.mak”. - Changed all makefiles and Visual Studio solution and project files to work with new directory structure. - Split out debug and TPM platform command code in tpmsockets.cpp into separate files. This code didn’t belong in this file. ## [0.97] - 2015-??-?? ### Added - Added code to save context in RM table when an object is context loaded. - Added code to get hierarchy from context when object is context loaded. - Added targeted test to tpmclient.cpp to make sure that hierarchy is saved - Added code to print level-specific messages when errors occur. - Added test for EvictControl.Fixed TestEncryptDecryptSession to work with 1.22 simulator. - Added code to check that TPM2B output parameters' size fields are set to 0 for following structures: TPM2B_ECC_POINT, TPM2B_PUBLIC, TPM2B_NV_PUBLIC, and TPM2B_CREATION_DATA. ### Changed - Fixed resource manager issues with leaving objects and session contexts in TPM memory. This was causing a 902 error on 2nd pass of PolicyTests. And it could have caused issues when error conditions occurred, because in those cases, the contexts weren't being evicted. - Changed TAB/RM into a separate executable (daemon). - Fixed bug: if LoadContext fails when loading objects it should exit ResourceMgrSendTpmCommand immediately. Instead it was loading other objects and proceeding through the rest of ResourceMgrSendTpmCommand function. correctly for ContextLoad command. - Fixed issues with TCTI: opaque data shouldn't be defined in tss2_tcti.h file. - Fixed makefile issue: under Windows, it was using mkdir command instead of md. - Fixed issue with definition of TSS2_TCTI_POLL_HANDLE in tss2_tcti.h file. - Fixed bug: wasn't handling case for TPM errors correctly in CheckPassed. - Changed CheckOverflow to return SAPI error level for errors. Other levels of TSS that call this function will alter the error level field. - Fixed resource manager to properly handle EvictControl commands. Before, if a persistent object was needed, the RM would give a 0xc0002 error. - Fixed printf's in resource manager so that they only print the right # of characters. - Fixed TestShutdown to work with 1.22 simulator. ## [0.96] - 2015-04-16 ### Added - Added buffer overrun checks to all SAPI code. - Added buffer overrun checks to resource manager code. - Added code to Part 3 functions to properly handle null pointers for output parameters. ### Changed - Auto-generated most of the SAPI code from the TPM 2.0 specification. ## [0.95.1] - 2015-01-26 ### Added - Added code to dynamically work around simulator 1.19 bugs: - Added code to RM and simDriver to support timeout on receive calls. - Added code to properly handle TPM errors in ExecuteFinish. Previously it was ignoring these errors, which meant that the rest of the _Complete call would try to unmarshal non-existent response data. Added test case for this. - Added support for cancel commands and tests for this. - Added help text for command line options. - Added code to reset dictionary attacks to start of tpmclient tests: this works around an issue where the simulator doesn't seem to completely clear the dictionary attack counter. - Added support for TCTI setLocality to resource manager and sim driver and made test app use this. - Added RM tests. - Added code to RM to evict contexts for objects, sequences, and sessions whose handles are returned by commands. - Added code to properly support ContextSave. - Added proper error code levels to all RM errors. - Added code to LoadContext function to output TPM formatted error codes. - For Create and Load commands, added proper handling of errors if parent handle not found. - Added tests for bad session handle, both in handle area and in authorization area. - Added command line option to run the StartAuthSession tests by themselves. - Added support for command line control of debug message levels. - Added new error level for resource manager for errors received from TPM from commands sent by RM. - Added error return for insufficiently sized response to ExecuteFinish function. - Added gap support to resource manager. - Added support to resource manager for kicking out oldest session if max sessions have been started and a new one is being created. - Added getCap calls to RM init function for getting max sessions and gap limit. - Added code to teardown the RM. - Added test for session gapping. - Added code to proactively detect MAX_ACTIVE_SESSIONS. - Added SAPI library subproject to test app project. This allows a one-touch build in Visual Studio. - Added changes to return error codes from TAB/RM and layers underneath in a response byte stream. ### Changed - Fixed bug in CreatePrimary and Create: for one-call and decrypt session case, they were copying first parameter from incorrect pointer. - For CopyCreationDataOut, CopyECCPointOut, CopyNvPublicOut, CopyPublicOut added placeholder for return code if size != 0 when called. To be filled in when TSS WG decides on error code. - Fixed bugs in CopySensitiveCreateIn and CopySensitiveIn: they shouldn't look at the size. - Fixed bugs in CopyECCPointIn, CopyNvPublicIn, CopyPublicIn, CopySensitiveIn, and CopySensitiveCreateIn: not handling NULL outpul parameters correctly. - Changes all instances of calls to ExecuteFinish to a timeout that works for all cases including communicating with the simulator over the network. - Fixed call to LoadExternal in TestUnseal--needed to pass in a NULL pointer for the inSensitive parameter. - Fixed bug in CreatePrimary: not passing correct pointer for inSensitive. - Fixed timeouts for all ExecuteFinish calls in test application. - Fixed bugs in RM: cases where I wasn't handling errors and then parsing data that hadn't been received. Caused seg faults under Linux. - Fixed timeout for async Startup test. - Fixed SocketReceiveTpmResponse for blocking case. - Fixed bug in ExecuteFinish: BAD_SEQUENCE error generated early in function was getting overwritten by INSUFFICIENT_RESPONSE error. - Fixed bug in ExecuteFinish: it was always setting timeout to 0 instead of TSS2_TCTI_TIMEOUT_BLOCK. - Fixed bug in resource manager: error level for non-TPM errors was getting overwritten with resource manager error level. - Replace Implementation.h with implementation.h. - Changed name of TPMB.h tpmb.h - GetCapability with bad property returns different error code. - Shutdown with bad value for shutdownValue causes TPM to go into failure mode. - Fixed overlap in error codes: TSS2_BASE_RC_NOT_SUPPORTED and TSS2_BASE_RC_BAD_TCTI_STRUCTURE had same value. - Cleaned up all app level error codes. - Fixed bug with ordering of -startAuthSessionTest command line parameter: if it was not the last option, tpmclient would fail. - Fixed bugs related to ContextLoad. - Fixed bug in EvictContext: it was updating lastSessionSequenceNum even if the ContextSave command failed. - Fixed handling of RM errors that occur during command send. - Fixed bug in simDriver init function. A second TCTI context being initialized was re-initing the whole driver. - Updated to latest 1.19 header files. - Fixed bugs in resource manager: - FindOldestSession wasn't working correctly—it was just finding the first one. - HandleGap needed to un-gap all the session contexts from the older interval. It wasn't doing that. - Fixed bug in handling of command line options—specifying none would cause program to error out. - Fixed issues in cleanup of TestStartAuthSession test. It was leaving some sessions alive. - Updated copyright notices on all files. - Changed test app to use linked list of session structures instead of fixed array. This fixed a host of issues. - Fixed bugs in Certify, CertifyCreation, Commit, Create, CreatePrimary, and GetCapability: if null used for return parameters, the function would fail. - Fixed bug in SimpleHmacOrPolicyTest where it was re-creating the global sysContext causing failures in later tests because the context was too small. - Fixed a bug in ExecuteFinish. If response is too small, code was just using the command buffer as the response buffer instead of returning an error. - Fixed some places in test app where I wasn't deleting entries from the sessions table. - Fixed build warnings related to size mismatch of connectionId. - Changed TeardownSysContext to zero out freed context pointer. - This helps prevent double free errors. - Fixed bug in EncryptDecryptXOR: wasn't setting the size of the outputData buffer. ### Removed - Removed 'extern "C"' statement from resourcemgr.c file. Not needed and causes problems with some compilers. - Removed unneeded includes from resource manager source. ## [0.95] - 2014-10-17 ### Added - Added support for Shutdown/Startup and effects on saved contexts. - Added support for stClear bit objects. On a TPM Restart, objects with this bit set will be removed from the TAB/RM entry list. - Added TCTI teardown function. - Added TAB functionality. - Added TCTI layer below RM to talk to driver. This allows making calls into the SAPI library from the RM without recursing into the RM again. With the separate TCTI context, the RM can route SAPI calls to talk directly to the driver. This fixed the virtual/real handle mess that was occurring with recursively entering the RM. - Added function pointers to TAB/RM for functions that might need to be different based on the environment that TAB/RM is running in: malloc, free, printf. - Added and corrected error codes to match latest SAPI spec. - Added MAX_NV_BUFFER_SIZE and used for max size of MAX_NV_BUFFER_2B. - Added code to TestHash to calculate and validate a hash. - Added code to TestHash to force a flush of an active sequence and then use it to finish the hash calculation. - Added code to SimpleHMACTest to read the NV index back. - Added SimpleHMACOrPolicyTest function which helps illustrate the difference between HMAC and policy sessions. ### Changed - Fixed intermittent access violation bug with GetSetDecryptParamTests function. I was reading off the end of the nvWrite buffer. - Fixed bug in Tss2_Sys_GetContextSize function: it was getting the requested size only, not the requested size plus the context blob's size. Problem was an associativity issue with ternary conditional ?: operator. - Re-architected TAB/RM: - Changed RM from reactive mode to proactive mode. Now instead of reacting to error codes from the TPM that indicate no enough slots, it guarantees that the TPM is always ready for each command (all slots freed after execution of each command). - Replaced the fixed length arrays of RM structures with linked list structures and appropriate functions. - Fixed some cases of using pointers before checking that they're not NULL. - Fixed bugs in marshaling/unmarshaling routines and added some missing unmarshaling functions. - Fixed hash sequence test. - Fixed bugs in CopyCapabilityDataOut function for algorithms. - Fixed bug with ExecuteAsync: passed in BE size to transmit call. Needs to be host-endian. - Changed on bit fields in TPM2 data structures to unsigned int. Previously the compiler was generating incorrect code because these were int bit fields. - Cleaned up TestHash function. ### Removed - Removed most instances of sysContext in tpmclient.cpp. Now most tests use the global one. - Removed pack pragma from header files for external interfaces. ## [0.93] - 2014-08-01 ### Added - Added IsSession routine and fixed all instances in resource manager where a handle is checked for being a session handle (some were incorrect). - Added RollNonces function and used for all tests for HMAC and policy sessions. - Added TCTI malformed response error code. - Added simple HMAC test. - Added test for session parameter encryption and decryption. - Added more descriptive error codes to StartAuthSession function. - Added TpmHashSequence function. Used this build password/PCR policy. - Added more policy tests: password/PCR, authValue, password - Added code to flush context of session handles I'm not using. - Added GetTestResult functions (had missed these previously) - Added tests for asynchronous and synchronous non-one call to Startup tests. - Added GetTestResult tests. - Added test to create a bunch of sessions. This test found some resource manager issues. ### Changed - Fixed bad parameters on call to GetEncryptParam. This only failed on Linux systems. - Fixed minor build errors under Linux. - Eliminated unneeded code in TestPolicy. - Changed how nonce's are setup after StartAuthSession. Before they were being inherently rolled in preparation for first command. Now the RollNonces routine will need to be called before the first command. This makes handling of the nonces consistent for all code that needs to roll them. - Fixed bug in StartAuthSession: wasn't marshaling symmetric parameter properly if algorithm was TPM_ALG_XOR. - Fixed bug in SetDecryptParam: when inserting a decrypt param, the code wasn't updating the command size field. - Fixed bug in ExecuteFinish: wasn't returning TPM error code if no other errors had occurred. - Fixed bug in KDFa function: if key size was zero, this was just returning success, but not generating a key. That behavior is specific to session key generation not to the underlying KDFa function. Upleveled that code into StartAuthSession function so that it only occurs in the session key generation case. - Changed NV attributes for all NV indices to add orderly attribute. This helps, but doesn't entirely relieve, NV wearout issues with the tests. - Changed NV attributes for all NV indices to add orderly attribute. This helps, but doesn't entirely relieve, NV wearout issues with the tests. - Fixed a bunch of resource manager issues. Many of these were exposed by the new policy tests. - Updated resource manager to properly handle sessions. Before we were not swapping them in as needed. - Updated readme.docx file. Now tests can run with V1.15 version of MS simulator. - Made test app work with MS simulator version 1.15. Had to add command to turn on NV. Before this change, when running against MS simulator, TPM2_Startup would fail with 0x923 error: "ERROR: WARNING, TPM_RC_NV_UNAVAILABLE: the command may require writing of NV and NV is not current accessible." - Changed NO_RESPONSE_RECEIVED error code to IO_ERROR. - Cleaned up defines for MS simulator commands. ### Removed? - Removed an unused input parameter from ComputeCommandHmacs and CheckResponseHmacs. - Removed an unused input parameter from ComputeCommandHmacs and CheckResponseHmacs. - Removed DRIVER_NOT_FOUND and DRIVERINFO_NOT_FOUND error codes. ## [0.92] - 2014-06-17 ### Changed - Fixed bugs in sockets send and receive code. Needed to account for actual bytes sent/received instead of assuming them. This was causing intermittent errors when looping continuously on the tests and running the tests remotely (on a different host system than the simulator was running on). - Fixed SAPI and test app builds to not fail if directories are already present. Suppressed error messages related to mkdir. - Turned on compiler warnings and fixed all issues when building under Ubuntu Linux. - Fixed error in readme.docx file. I was specifying the wrong version of the simulator. - Fixed error handling if sockets interface fails to connect. - Fixed build error: now I make directories that are needed. ## [0.91] - 2014-06-04 ### Added - Added code optimized builds to System API library code - Added warning flags to compiler command lines. ### Changed - Fixed all compiler warnings when built under Windows and Linux. ## [0.90] - 2014-05-28 ### Added - Added support for encrypt/decrypt sessions with one-call functions. - Added cleaned up and reorganized header files that comply with latest SAPI specification. - Added changes for supporting get/set encrypt/decrypt functions. - Added latest header file that corresponds to version 1.03 of TPM 2.0 specification. - Added debug display of command string for each command being run. - Added command line flag to slow down test display for demo purposes. - Added option to loop the tests continuously. ### Changed - Ported existing functionality to latest SAPI spec. - Cleaned up and added comments to PasswordTest. - Fixed problem of hang when looping through tests. Sessions table was running out of entries because we weren't removing sessions that were closed. - Fixed issue with resource manager. All virtual handles had the high nibble set to 0xff. Now the high nibble is left intact so that applications can determine the type of the handle. ### Notes 1. Testing is not comprehensive. See test code to see what’s tested. Please report any bugs found so that fixes can be rolled out. 2. Range checks within SAPI code not yet implemented. 3. Still need to add support for separate debug and production builds. Production build will be optimized for code size. ## [0.82] - 2013-12-16 ### Added - Added support for building and running system API code and tests under Linux. - Added command line options for host name and port to test application. ### Notes HMAC and cpHash calculations are only supported for NV Read and NV Write commands currently. The system API changes to support this have been prototyped for these commands and are awaitingTSS approval before being ported to all the other commands. ## [0.81] - 2013-12-02 ### Added - Added support for TPM2_PolicyNvWritten command. ### Changed - Altered tests to work with 1.01 simulator. - Fixed errors in readme.docx. ### Notes HMAC and cpHash calculations are only supported for NV Read and NV Write commands currently. The system API changes to support this have been prototyped for these commands and are awaitingTSS approval before being ported to all the other commands. ## [0.80] - 2013-11-19 ### Added - Added code to create a new session for reading/writing the NV index after it’s first written. This tests the other case for bound sessions. - Added routine to start policy sessions. - Added policy test code--not used currently. ### Changed - Fixed bugs in resource manager. - Fixed bugs with salted session tests. - Ported tests to work with 0.99 sim's version of support for bound sessions. - Fixed bugs in test code, with how key is generated for encrypting the salt for salted session tests. - Fixed a rather serious bug in HmacSessionTest: CopyNvPublicIn is called to copy a structure, but is had the side effect of modifying the first parameter. This function really wasn't designed to be used the way it is. Worked around the problem by resetting the pointer after calling CopyNvPublicIn. This problem showed up as a stack corruption issue that occurred during the 4th test. Basically the pointer moved enough after the first 3 tests to start corrupting other variables on the stack. - Automated runtime setup of key for salted tests. - Developed changes for NVRead/Write commands to use new 2-stage method for handling HMAC calculations. - Changed CopyPcrSelectionIn function so that it can be used by applications to generate policy hashes. - Fixed build error: changes in header files weren't causing TPM 2.0 library functions to be rebuilt. - Created CalcPHash helper function. - Changed HMAC session code to new architecture that doesn't use any helper function pointers. - Changed return code type form UINT32 to TPM_RC in tss_sysapi.h. - Changed "authHandle" to "sessionHandle" in sample code. - Debugged and fixed StartAuthSession2 function in test code. - Debugged and fixed first policy test. - Used new NvDefine function to help abstract some of the details of creating NV indices. - Used non-MS header file to build system API. - Cleaned up and reorganized files and directories. ### Notes HMAC and cpHash calculations are only supported for NV Read and NV Write commands currently. The system API changes to support this have been prototyped for these commands and are awaitingTSS approval before being ported to all the other commands. ## [0.67] - 2013-08-07 ### Added - Plumbed in a resource mgr (doesn't actually do anything other than pass through at this time). - Added BOUND and SALTED HMAC session tests. BOUND test works, but SALTED doesn't yet work. - Added code to delete an entity from the entity table. - Added code to work around an NV index anomaly with TPM simulator 0.98 and previous versions: after the first NV index write, the name changes. This causes the TPM's HMAC calculation to treat the index as if it's never the BOUND entity, even if it is. This is expected (but weird) behavior which will be fixed in 0.99 simulator. - Created two helper functions pointers for system API and used them for HMAC sessions. - Added support for HMAC session for NV read/write APIs.Added HMAC tests for unbounded/unsalted sessions.Fixed context save/restore functions.Created CopyNvPublicIn function and altered Tpm2_DefineSpace function to use it. - Created TpmHash function - Created TpmHandleToName function - Added HMAC tests for unbounded/unsalted sessions. - Created CopyNvPublicIn function and altered Tpm2_DefineSpace function to use it. - Created TpmHash function - Created TpmHandleToName function - Documented helper function pointers in the system API header file. - Added tests for TpmHandleToName function. - Added functionality needed for KDFa functions ConcatSizedByteBuffer, CopySizedByteBuffer - Added KDFa function in preparation for HMAC session test. Not tested yet. - Added LoadExternalHMACKey function. This function is called by TPM HMAC function. ### Changed - Updated headers with Intel license text. - Split sockets driver into separate code module. - SALTED session test fixes: * Fixed CopyRSAEncryptIon function--wasn't handling some cases correctly. * Backed out change to make parameterSize passed to ComputeSessionHmacPtr function a UINT16. Needs to be UINT32. * For ComputeSessionHmacPtr, changed parameterSize to UINT16 to fix build warning. - Fixed bugs in KDFa(). - Altered all APIs to use pointers to TPM input/output buffers. - Fixed context save/restore functions. - Fixed formatting of prints of sized byte buffers in test app. - Fixed bug in TpmHmac function: needed to set size of result to 0 in case an error occurs. - Fixed bugs in CopySensitiveIn function: uninitialized size field, bad pointers, and incorrect increment of otherData at end of function. - Altered TpmHMAC function to call LoadExternalHMAC key function. This allows a better HMAC function pointer, one that complies with normal HMAC calling convention. Before it was TPM-specific. - Bumped up TPMBUF_LEN to 32k in tpmclient.cpp. This fixed overwriting problems during context save/restore function. - Fixed bugs in ContextLoad function: otherData wasn't initialized before it was used. - Fixed bug in Tpm20LoadExternal command: it wasn't properly marshaling the inPrivate data. ### Removed - Removed tis.h file. Not needed. - Eliminated salted session test (because it doesn't work yet), and changed out.good file to match. - Reorganized directories and moved files to make more logical sense. ### Notes HMAC helper function callouts are only being done for NV Read and NV Write commands currently. The system API changes to support this are still being prototyped. After they are finalized, these changes will be extended to all functions that use sessions. ## [0.66] - 2013-??-?? ### Added - Added CertifyCreation function - Added EcEphemeral function - Added test for tspi_sys_TPM2_HashStart ### Changed - Cleaned up for general TCG release ## [0.65] - 2013-04-10 ### Added - All TPM 2.0 functions now supported. - Limited testing done on following functions: - tspi_sys_TPM2_Startup - tspi_sys_Tpm2_SelfTest - tspi_sys_TPM2_GetCapability - tspi_sys_TPM2_Clear-tested - tspi_sys_TPM2_StartAuthSession - tspi_sys_TPM2_ClearControl - tspi_sys_TPM2_ChangeEPS - tspi_sys_TPM2_HierarchyChangeAuth - tspi_sys_TPM2_Extend - tspi_sys_TPM2_HashSequenceStart - tspi_sys_TPM2_SequenceUpdate - tspi_sys_TPM2_SequenceComplete - tspi_sys_TPM2_EventSequenceComplete - tspi_sys_TPM2_GetRandom - tspi_sys_TPM2_SaveState - tspi_sys_TPM2_PcrRead - tspi_sys_TPM2_NVRead - tspi_sys_TPM2_NVWrite - tspi_sys_TPM2_Unseal - tspi_sys_TPM2_PcrAllocate - tspi_sys_TPM2_DictionaryAttackLockReset - tspi_sys_TPM2_NV_Writelock - tspi_sys_TPM2_PolicyCommandCode - tspi_sys_TPM2_PolicyGetDigest - tspi_sys_TPM2_PolicyOr - tspi_sys_TPM2_PolicyRestart - tspi_sys_TPM2_LoadExternal - tspi_sys_TPM2_HierarchyControl - tspi_sys_TPM2_NV_UndefineSpace - tspi_sys_TPM2_Create - tspi_sys_TPM2_Load - tspi_sys_TPM2_Quote - tspi_sys_TPM2_NV_ReadPublic - tspi_sys_TPM2_ChangePPS - tspi_sys_TPM2_NV_DefineSpace - tspi_sys_TPM2_PolicyLocality - tspi_sys_TPM2_PolicyPCR - tspi_sys_TPM2_CreatePrimary - tspi_sys_TPM2_Shutdown - tspi_sys_TPM2_PCR_Event - tspi_sys_TPM2_PolicyNV - tspi_sys_TPM2_NV_ReadLock - tspi_sys_TPM2_NV_UndefineSpaceSpecial No testing done on all other 61 functions ## [0.60] - 2013-03-29 ### Added - Added changes to make it comply with TSS 2.0 system library API ### Removed - Cleaned up and removed unneeded files. tpm2-tss-2.3.2/CONTRIBUTING.md000066400000000000000000000037361357450634200154620ustar00rootroot00000000000000# Guidelines for submitting bugs: All non security bugs should be filed on the Issues tracker: https://github.com/tpm2-software/tpm2-tss/issues Security sensitive bugs should be emailed to a maintainer directly, or to Intel via the guidelines here: https://security-center.intel.com/VulnerabilityHandlingGuidelines.aspx # Guideline for submitting changes: All changes to the source code must follow the coding standard used in the surrounding source and documented [here](doc/coding_standard_c.md). All changes should be introduced via github pull requests. This allows anyone to comment and provide feedback in lieu of having a mailing list. For pull requests opened by non-maintainers, any maintainer may review and merge that pull request. For maintainers, they either must have their pull request reviewed by another maintainer if possible, or leave the PR open for at least 24 hours, we consider this the window for comments. ## Patch requirements * All tests must pass on Travis CI for the merge to occur. * All changes must not introduce superfluous changes or whitespace errors. * All commits should adhere to the git commit message guidelines described here: https://chris.beams.io/posts/git-commit/ with the following exceptions. * We allow commit subject lines up to 80 characters. * Commit subject lines should be prefixed with a string identifying the effected subsystem. If the change is spread over a number of subsystems then the prefix may be omitted. Recommended prefix for changes to files in src/tss2-sys is "sys: ", and for changes to files in src/tss2-esys is "esys: ". * All contributions must adhere to the Developers Certificate of Origin. The full text of the DCO is here: https://developercertificate.org/. Contributors must add a 'Signed-off-by' line to their commits. This indicates the submitters acceptance of the DCO. ## Guideline for merging changes Changes must be merged with the "rebase" option on github to avoid merge commits. This provides for a clear linear history. tpm2-tss-2.3.2/Dockerfile000066400000000000000000000011771357450634200152200ustar00rootroot00000000000000FROM tpm2software/tpm2-tss AS base COPY . /tmp/tpm2-tss/ WORKDIR /tmp/tpm2-tss ENV LD_LIBRARY_PATH /usr/local/lib # Fuzzing FROM base AS fuzzing ENV GEN_FUZZ 1 RUN ./bootstrap \ && ./configure \ CC=clang \ CXX=clang++ \ --enable-debug \ --with-fuzzing=libfuzzer \ --enable-tcti-fuzzing \ --enable-tcti-device=no \ --enable-tcti-mssim=no \ --with-maxloglevel=none \ --disable-shared \ && make -j $(nproc) check RUN cat test-suite.log # TPM2-TSS FROM base RUN ./bootstrap \ && ./configure --enable-unit \ && make -j$(nproc) check \ && make install \ && ldconfig RUN cat test-suite.log tpm2-tss-2.3.2/Doxyfile.in000066400000000000000000003335551357450634200153510ustar00rootroot00000000000000# Unfortunately AC_CONFIG_FILES is too intelligent if this file lives inside the # /doc subdirectory; i.e. it will set @top_srcdir@ to ".." which screws up all # doxygen generation. Thus this file needs to live on top-level until anybody # comes up with a different solution. # Doxyfile 1.8.11 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. # # All text after a single 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. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by # double-quotes, unless you are using Doxywizard) that should identify the # project for which the documentation is generated. This name is used in the # title of most generated pages and in a few other places. # The default value is: My Project. PROJECT_NAME = @PACKAGE_NAME@ # 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@ # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = "TPM Software stack 2.0 TCG spec compliant implementation" # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. PROJECT_LOGO = # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. 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 = @top_builddir@/doxygen-doc # 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 causes # performance problems for the file system. # The default value is: NO. CREATE_SUBDIRS = NO # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode # U+3044. # The default value is: NO. ALLOW_UNICODE_NAMES = 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. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, # Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES, 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. # The default value is: YES. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES, 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. # The default value is: YES. 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 and 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. # The default value is: NO. 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. # The default value is: NO. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES, 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 # The default value is: YES. FULL_PATH_NAMES = YES # 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. # # Note that you can specify absolute paths here, but also relative paths, which # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. 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 list of 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. # The default value is: NO. 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-style will behave just like regular Qt- # style comments (thus requiring an explicit @brief command for a brief # description.) # The default value is: NO. 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 Qt-style will behave just like regular Qt-style comments (thus # requiring an explicit \brief command for a brief description.) # The default value is: NO. 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 behavior. 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 behavior instead. # # Note that setting this tag to YES also means that rational rose comments are # not recognized any more. # The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. 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. # The default value is: NO. 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. # Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 4 # This tag can be used to specify a number of aliases that act 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 = # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" # will allow you to use the command class in the itcl::class meaning. TCL_SUBST = # 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. # The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = YES # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or # Python sources only. Doxygen will then generate output that is more tailored # for that language. For instance, namespaces will be presented as packages, # qualified scopes will look different, etc. # The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources. Doxygen will then generate output that is tailored for Fortran. # The default value is: NO. 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. # The default value is: NO. 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 (fixed format Fortran: # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: # Fortran. In the later case the parser tries to guess whether the code is fixed # or free formatted code, this is the default for Fortran type files), VHDL. 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. # # Note: For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable # documentation. See http://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. # The default value is: YES. MARKDOWN_SUPPORT = YES # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by putting a % sign in front of the word or # globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES # 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); # versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = NO # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. # The default value is: NO. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: # http://www.riverbankcomputing.co.uk/software/sip/intro) 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. # The default value is: NO. 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 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. # The default value is: YES. 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. # The default value is: NO. DISTRIBUTE_GROUP_DOC = NO # If one adds a struct or class to a group and this option is enabled, then also # any nested class or struct is added to the same group. By default this option # is disabled and one has to add nested compounds explicitly via \ingroup. # The default value is: NO. GROUP_NESTED_COMPOUNDS = YES # Set the SUBGROUPING tag to YES 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. # The default value is: YES. SUBGROUPING = YES # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions # are shown inside the group in which they are included (e.g. using \ingroup) # instead of on a separate page (for HTML and Man pages) or section (for LaTeX # and RTF). # # Note that this feature does not work in combination with # SEPARATE_MEMBER_PAGES. # The default value is: NO. INLINE_GROUPED_CLASSES = YES # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions # with only public data fields or simple typedef fields will be shown inline in # the documentation of the scope in which they are defined (i.e. file, # namespace, or group documentation), provided this scope is documented. If set # to NO, structs, classes, and unions are shown on a separate page (for HTML and # Man pages) or section (for LaTeX and RTF). # The default value is: NO. INLINE_SIMPLE_STRUCTS = NO # When TYPEDEF_HIDES_STRUCT tag 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. # The default value is: NO. TYPEDEF_HIDES_STRUCT = NO # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be # an expensive process and often the same symbol appears multiple times in the # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small # doxygen will become slower. If the cache is too large, memory is wasted. The # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 # symbols. At the end of a run doxygen will report the cache usage and suggest # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_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 respectively EXTRACT_STATIC tags are set to YES. # Note: This will also disable the warnings about undocumented members that are # normally produced when WARNINGS is set to YES. # The default value is: NO. EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = NO # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be # included in the documentation. # The default value is: NO. EXTRACT_STATIC = NO # 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. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. If 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, only methods in the interface are # included. # The default value is: NO. 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. # The default value is: NO. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO 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. # The default value is: NO. 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, these classes will be included in the various overviews. This option # has no effect if EXTRACT_ALL is enabled. # The default value is: NO. 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, these declarations will be # included in the documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO # 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, these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. 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 then the documentation # will be excluded. Set it to YES to include the internal documentation. # The default value is: NO. INTERNAL_DOCS = NO # 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. # The default value is: system dependent. CASE_SENSE_NAMES = NO # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES, the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = YES # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will # append additional text to a page's title, such as Class Reference. If set to # YES the compound reference will be hidden. # The default value is: NO. HIDE_COMPOUND_REFERENCE= NO # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. SHOW_INCLUDE_FILES = YES # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each # grouped member an include statement to the documentation, telling the reader # which file to include in order to use the member. # The default value is: NO. SHOW_GROUPED_MEMB_INC = NO # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the # documentation for inline members. # The default value is: YES. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES 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. # The default value is: YES. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the # (brief and detailed) documentation of class members so that constructors and # destructors are listed first. If set to NO the constructors will appear in the # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief # member documentation. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting # detailed member documentation. # The default value is: NO. SORT_MEMBERS_CTORS_1ST = 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 group names will # appear in their defined order. # The default value is: NO. 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 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. # The default value is: NO. SORT_BY_SCOPE_NAME = NO # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper # type resolution of all parameters of a function it will reject a match between # the prototype and the implementation of a member function even if there is # only one candidate or it is obvious which candidate to choose by doing a # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still # accept a match between prototype and implementation in such cases. # The default value is: NO. STRICT_PROTO_MATCHING = 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. # The default value is: YES. 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. # The default value is: YES. 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. # The default value is: YES. 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. # The default value is: YES. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond # ... \endcond blocks. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have 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 value of individual variables and macros / defines can be # controlled using \showinitializer or \hideinitializer command in the # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. 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. # The default value is: YES. SHOW_USED_FILES = YES # 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 value 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 value 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 command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. 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. To 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. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. See also \cite for info how to create references. CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to # standard output by doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = YES # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. # The default value is: YES. WARNINGS = YES # If the WARN_IF_UNDOCUMENTED tag 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. # The default value is: YES. WARN_IF_UNDOCUMENTED = NO # If the WARN_IF_DOC_ERROR tag 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. # The default value is: YES. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return # value. If set to NO, doxygen will only warn about wrong or incomplete # parameter documentation, but not about the absence of documentation. # The default value is: NO. WARN_NO_PARAMDOC = YES # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # a warning is encountered. # The default value is: NO. WARN_AS_ERROR = 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) # The default value is: $file:$line: $text. 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 standard # error (stderr). WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag is 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. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. INPUT = @top_srcdir@/doc/coding_standard_c.md \ @top_srcdir@/doc/logging.md \ @top_srcdir@/doc/doxygen.dox \ @top_srcdir@/README.md \ @top_srcdir@/include/tss2/tss2_esys.h \ @top_srcdir@/src/tss2-esys \ @top_srcdir@/test/integration/esys-audit.int.c \ @top_srcdir@/test/integration/esys-certify-creation.int.c \ @top_srcdir@/test/integration/esys-certify.int.c \ @top_srcdir@/test/integration/esys-change-eps.int.c \ @top_srcdir@/test/integration/esys-clear-control.int.c \ @top_srcdir@/test/integration/esys-clear.int.c \ @top_srcdir@/test/integration/esys-clockset.int.c \ @top_srcdir@/test/integration/esys-commit.int.c \ @top_srcdir@/test/integration/esys-create-fail.int.c \ @top_srcdir@/test/integration/esys-create-password-auth.int.c \ @top_srcdir@/test/integration/esys-create-policy-auth.int.c \ @top_srcdir@/test/integration/esys-create-primary-hmac.int.c \ @top_srcdir@/test/integration/esys-create-session-auth.int.c \ @top_srcdir@/test/integration/esys-createloaded.int.c \ @top_srcdir@/test/integration/esys-duplicate.int.c \ @top_srcdir@/test/integration/esys-ecc-parameters.int.c \ @top_srcdir@/test/integration/esys-ecdh-keygen.int.c \ @top_srcdir@/test/integration/esys-ecdh-zgen.int.c \ @top_srcdir@/test/integration/esys-encrypt-decrypt.int.c \ @top_srcdir@/test/integration/esys-event-sequence-complete.int.c \ @top_srcdir@/test/integration/esys-evict-control-serialization.int.c \ @top_srcdir@/test/integration/esys-field-upgrade.int.c \ @top_srcdir@/test/integration/esys-firmware-read.int.c \ @top_srcdir@/test/integration/esys-get-capability.int.c \ @top_srcdir@/test/integration/esys-get-random.int.c \ @top_srcdir@/test/integration/esys-get-time.int.c \ @top_srcdir@/test/integration/esys-hash.int.c \ @top_srcdir@/test/integration/esys-hashsequencestart.int.c \ @top_srcdir@/test/integration/esys-hierarchy-control.int.c \ @top_srcdir@/test/integration/esys-hierarchychangeauth.int.c \ @top_srcdir@/test/integration/esys-hmac.int.c \ @top_srcdir@/test/integration/esys-hmacsequencestart.int.c \ @top_srcdir@/test/integration/esys-import.int.c \ @top_srcdir@/test/integration/esys-lock.int.c \ @top_srcdir@/test/integration/esys-make-credential.int.c \ @top_srcdir@/test/integration/esys-nv-certify.int.c \ @top_srcdir@/test/integration/esys-nv-ram-counter.int.c \ @top_srcdir@/test/integration/esys-nv-ram-extend-index.int.c \ @top_srcdir@/test/integration/esys-nv-ram-ordinary-index.int.c \ @top_srcdir@/test/integration/esys-nv-ram-set-bits.int.c \ @top_srcdir@/test/integration/esys-object-changeauth.int.c \ @top_srcdir@/test/integration/esys-pcr-auth-value.int.c \ @top_srcdir@/test/integration/esys-pcr-basic.int.c \ @top_srcdir@/test/integration/esys-policy-authorize.int.c \ @top_srcdir@/test/integration/esys-policy-nv-changeauth.int.c \ @top_srcdir@/test/integration/esys-policy-nv-undefine-special.int.c \ @top_srcdir@/test/integration/esys-policy-password.int.c \ @top_srcdir@/test/integration/esys-policy-regression.int.c \ @top_srcdir@/test/integration/esys-policy-authorize-nv-opt.int.c \ @top_srcdir@/test/integration/esys-policy-physical-presence-opt.int.c \ @top_srcdir@/test/integration/esys-policy-template-opt.int.c \ @top_srcdir@/test/integration/esys-policy-ticket.int.c \ @top_srcdir@/test/integration/esys-pp-commands.int.c \ @top_srcdir@/test/integration/esys-quote.int.c \ @top_srcdir@/test/integration/esys-rsa-encrypt-decrypt.int.c \ @top_srcdir@/test/integration/esys-save-and-load-context.int.c \ @top_srcdir@/test/integration/esys-set-algorithm-set.int.c \ @top_srcdir@/test/integration/esys-stir-random.int.c \ @top_srcdir@/test/integration/esys-testparms.int.c \ @top_srcdir@/test/integration/esys-tpm-tests.int.c \ @top_srcdir@/test/integration/esys-tr-fromTpmPublic-key.int.c \ @top_srcdir@/test/integration/esys-tr-fromTpmPublic-nv.int.c \ @top_srcdir@/test/integration/esys-tr-getName-hierarchy.int.c \ @top_srcdir@/test/integration/esys-unseal-password-auth.int.c \ @top_srcdir@/test/integration/esys-verify-signature.int.c \ @top_srcdir@/test/integration/esys-zgen-2phase.int.c # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: http://www.gnu.org/software/libiconv) for the list of # possible encodings. # The default value is: UTF-8. 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 patterns (like *.cpp and # *.h) to filter out the source-files in the directories. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # read by doxygen. # # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, # *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. FILE_PATTERNS = *.c \ *.h \ *.md \ *.dox # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. # The default value is: NO. RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that should be # 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. # # Note that relative paths are relative to the directory from which doxygen is # run. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. # The default value is: NO. 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 = # 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 # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = *_IN IESYS_CMD_IN_PARAM # 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 = # 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. # The default value is: NO. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be 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. # # Note that the filter must not add or remove lines; it is applied before the # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. 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 information on how # filters are used. If the FILTER_PATTERNS tag is empty or if none of the # patterns match the file name, INPUT_FILTER is applied. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will also be used to filter the input files that are used for # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and # it is also possible to disable source filtering for a specific pattern using # *.ext= (so without naming a filter). # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. USE_MDFILE_AS_MAINPAGE = README.md #--------------------------------------------------------------------------- # 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 that # also VERBATIM_HEADERS is set to NO. # The default value is: NO. SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. # The default value is: NO. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any # special comment blocks from generated source code fragments. Normal C, C++ and # Fortran comments will always remain visible. # The default value is: YES. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES then for each documented # function all documented functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = NO # 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. # The default value is: NO. REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES 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. # The default value is: YES. REFERENCES_LINK_SOURCE = YES # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the # source code will show a tooltip with additional information such as prototype, # brief description and links to the definition and documentation. Since this # will make the HTML file larger and loading of large files a bit slower, you # can opt to disable this feature. # The default value is: YES. # This tag requires that the tag SOURCE_BROWSER is set to YES. SOURCE_TOOLTIPS = 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. # # To use it do the following: # - Install the latest version of global # - Enable SOURCE_BROWSER and USE_HTAGS in the config file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # # Doxygen will invoke htags (and that will in turn invoke gtags), so these # tools must be available from the command line (i.e. in the search path). # # The result: instead of the source browser generated by doxygen, the links to # source code will now point to the output of htags. # The default value is: NO. # This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set the YES 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. # See also: Section \class. # The default value is: YES. VERBATIM_HEADERS = YES # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the # cost of reduced performance. This can be particularly helpful with template # rich C++ code for which doxygen's built-in parser lacks the necessary type # information. # Note: The availability of this option depends on whether or not doxygen was # generated with the -Duse-libclang=ON option for CMake. # The default value is: NO. CLANG_ASSISTED_PARSING = NO # If clang assisted parsing is enabled you can provide the compiler with command # line options that you would normally use when invoking the compiler. Note that # the include paths will already be set by doxygen for the files and directories # specified with INPUT and INCLUDE_PATH. # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. CLANG_OPTIONS = #--------------------------------------------------------------------------- # 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. # The default value is: YES. ALPHABETICAL_INDEX = YES # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in # which the alphabetical index list will be split. # Minimum value: 1, maximum value: 20, default value: 5. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 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 a prefix (or a list of prefixes) that should be ignored # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. 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. # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. 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). # The default value is: .html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for # each generated HTML page. If the tag is left blank doxygen will generate a # standard header. # # To get valid HTML the header file that includes any scripts and style sheets # that doxygen needs, which is dependent on the configuration options used (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage" # for information on how to generate the default header that doxygen normally # uses. # Note: The header is subject to change so you typically have to regenerate the # default header when upgrading to a newer version of doxygen. For a description # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default footer # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. 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 left blank doxygen will generate a default style sheet. # See also section "Doxygen usage" for information on how to generate the style # sheet that doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future become # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefore more robust against future updates. # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that the # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see # http://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # in the HTML output. For a value of 0 the output will use grayscales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 100 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the # luminance component of the colors in the HTML output. Values below 100 # gradually make the output lighter, whereas values above 100 make the output # darker. The value divided by 100 is the actual gamma applied, so 80 represents # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not # change the gamma. # Minimum value: 40, maximum value: 240, default value: 80. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting this # to YES can help to show when doxygen was last run and thus if the # documentation is up to date. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = NO # 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. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand # and collapse entries dynamically later on. Doxygen will expand the tree to # such a level that at most the specified number of entries are visible (unless # a fully collapsed tree already exceeds this amount). So setting the number of # entries 1 will produce a full collapsed tree by default. 0 is a special value # representing an infinite number of entries and will result in a full expanded # tree by default. # Minimum value: 0, maximum value: 9999, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_INDEX_NUM_ENTRIES = 100 # 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 (see: http://developer.apple.com/tools/xcode/), 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. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO # This tag determines the name of the docset 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. # The default value is: Doxygen generated docs. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" # 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. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. # The default value is: org.doxygen.Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. # The default value is: Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on # Windows. # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML # files are now used as the Windows 98 help format, and will replace the old # Windows help format (.hlp) on all Windows platforms in the future. Compressed # HTML files also contain an index, a table of contents, and you can search for # words in the documentation. The HTML workshop also contains a viewer for # compressed HTML files. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO # 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. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = # 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. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = # 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). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = # 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. Furthermore it # enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members to # the table of contents of the HTML help documentation and to the tree view. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 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. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. 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. # This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- # folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. 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 (see: # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = # 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. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be # generated, together with the HTML files, they form an Eclipse help plugin. To # install this plugin and make it available under the help contents menu in # Eclipse, the contents of the directory containing the HTML and XML files needs # to be copied into the plugins directory of eclipse. The name of the directory # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. # After copying Eclipse needs to be restarted before the help appears. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO # A unique identifier for the Eclipse help plugin. When installing the plugin # the directory name containing the HTML and XML files should also have this # name. Each documentation set should have its own identifier. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project # If you want full control over the layout of the generated HTML pages it might # be necessary to disable the index and replace it with your own. The # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top # of each HTML page. A value of NO enables the index and the value YES disables # it. Since the tabs in the index contain the same information as the navigation # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO # 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 YES, 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 # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can # further fine-tune the look of the index. As an example, the default style # sheet generated by doxygen has an example that shows how to put an image at # the root of the tree instead of the PROJECT_NAME. Since the tree basically has # the same information as the tab index, you could consider setting # DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = YES # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. # Minimum value: 0, maximum value: 20, default value: 4. # This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 # 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. # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. 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. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # # Note that when changing this option you need to delete any form_*.png files in # the HTML output directory before the changes have effect. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # http://www.mathjax.org) which uses client side Javascript for the rendering # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path # to it using the MATHJAX_RELPATH option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO # When MathJax is enabled you can set the default output format to be used for # the MathJax output. See the MathJax site (see: # http://docs.mathjax.org/en/latest/output.html) for more details. # Possible values are: HTML-CSS (which is slower, but has the best # compatibility), NativeMML (i.e. MathML) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_FORMAT = HTML-CSS # When MathJax is enabled you need to specify the location relative to the HTML # output directory using the MATHJAX_RELPATH option. The destination directory # should contain the MathJax.js script. For instance, if the mathjax directory # is located at the same level as the HTML output directory, then # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of # MathJax from http://www.mathjax.org before deployment. # The default value is: http://cdn.mathjax.org/mathjax/latest. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_CODEFILE = # When the SEARCHENGINE tag is enabled doxygen will generate a search box for # the HTML output. The underlying search engine uses javascript and DHTML and # should work on any modern browser. Note that when using HTML help # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) # there is already a search function so this one should typically be disabled. # For large projects the javascript based search engine can be slow, then # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to # search using the keyboard; to jump to the search box use + S # (what the is depends on the OS and browser, but it is typically # , /