Go to file
Stefan Berger d41dedca4d build-sys: Use AC_LINK_IFELSE to check for understood linker flags
Use AC_LINK_IFELSE to check whether linker flags like 'now' and
'relro' are understood or remain unused (= useless), and only add them
to the set of HARDENING_LDFLAGS, if they are used by the linker. clang
for example does not seem to use them and Cygwin's linker does not
understand them.

Note: This patch merely improves on the handling of these flags but does
not solve a compilation issue when clang is used, unlike swtpm where
this created issues.

Signed-off-by: Stefan Berger <stefanb@linux.ibm.com>
2020-09-11 12:23:26 -04:00
debian rpm/debian: Add 0.8.0-1 entry to changelog 2020-06-15 11:55:41 -04:00
dist rpm/debian: Add 0.8.0-1 entry to changelog 2020-06-15 11:55:41 -04:00
include tpm2: Add RSAKeySizes field to TPM2_GetInfo() JSON under new flag 2020-05-04 08:01:26 -04:00
m4 build-sys: Require only autoconf 2.63 for older systems 2019-06-20 13:08:39 -04:00
man tpm2: Add RSAKeySizes field to TPM2_GetInfo() JSON under new flag 2020-05-04 08:01:26 -04:00
src tpm2: Fix the returned number in the JSON 2020-08-24 20:47:33 -04:00
tests rev162: fix PCRBelongsTCBGroup for PCClient (bugfix) 2020-06-29 08:42:37 -04:00
.gitignore gitignore: Ignore .dirstamp files 2020-04-14 16:03:45 -04:00
.travis.yml Travis: Add python3 dependencies for swtpm test 2020-08-28 20:33:09 -04:00
autogen.sh build-sys: add a simple autogen.sh 2018-05-26 07:41:18 -04:00
bootstrap.sh Remove config.h.in 2014-06-30 15:04:15 -04:00
CHANGES CHANGES: Update CHANGES file for 0.8.0 2020-06-02 09:00:46 -04:00
configure.ac build-sys: Use AC_LINK_IFELSE to check for understood linker flags 2020-09-11 12:23:26 -04:00
CREDITS Add CREDITS file 2013-10-31 16:37:33 -04:00
DCO1.1.txt Replace the CLA with the DCO, simply requiring a Signed-off-by: 2016-12-21 11:09:38 -05:00
INSTALL docs: Update the INSTALL file to reflect current build system 2018-10-29 19:50:35 -04:00
libtpms.pc.in pkg-config: add cryptolib to libtpms.pc 2018-08-03 13:06:29 -04:00
LICENSE Extend license texts with TPM 2 specifics 2018-06-15 18:07:47 -04:00
Makefile.am build-sys: Include autogen.sh in the tarball and use for RPM building 2018-08-08 08:59:04 -04:00
README docs: Update README to include CXX=clang++ for fuzzer build 2019-11-16 15:41:09 -05:00

What is libtpms?
----------------

Libtpms is a library that targets the integration of TPM functionality
into hypervisors, primarily into Qemu. Libtpms provides a very narrow
public API for this purpose so that integration is possible. Only the
minimum of necessary APIs are made publicly available.

It is assumed that the user of libtpms is familiar with the concepts
of the Trusted Platform Module (TPM). For the interaction with libtpms
it is necessary to know how to construct valid TPM commands and to
be able to parse their results. It is not within the scope of libtpms's
documentation to provide background on this. See the section on references
below.


What files does the libtpms package provide?
--------------------------------------------

The main libtpms package provides the following files:

/usr/lib64/libtpms.so.0
/usr/lib64/libtpms.so.0.5.1
/usr/share/doc/libtpms-0.5.1
/usr/share/doc/libtpms-0.5.1/CHANGES
/usr/share/doc/libtpms-0.5.1/LICENSE
/usr/share/doc/libtpms-0.5.1/README

Applications can link with -ltpms.


What files does the libtpms development package provide?
--------------------------------------------------------

The libtpms development package (libtpms-devel) provides the following
include files for applications to use:

tpm_error.h
tpm_library.h
tpm_memory.h
tpm_nvfilename.h
tpm_tis.h
tpm_types.h

These files contain the data structures, data types and API calls supported
by libtpms. It is recommended to not use any other API calls than those
provided in these include files.

All APIs are described in man pages. The man pages are part of the libtpms
development package as well:

TPMLIB_DecodeBlob
TPMLIB_GetTPMProperty
TPMLIB_GetVersion
TPMLIB_MainInit
TPMLIB_Process
TPMLIB_RegisterCallbacks
TPMLIB_Terminate
TPMLIB_VolatileAll_Store
TPM_Free
TPM_IO_Hash_Data
TPM_IO_Hash_End
TPM_IO_Hash_Start
TPM_IO_TpmEstablished_Get
TPM_Malloc
TPM_Realloc


How to contribute?
------------------
The mailing list for libtpms is libtpms@googlegroups.com.

For patch submissions, please use a Signed-off-by: <your email> to indicate
agreement to the DCO1.1.txt.


Fuzzing
-------
Initial fuzzing is possible with clang & libfuzzer.

You have to configure the project with --enable-fuzzer
(--enable-sanitizer can also help spot more issues). Then you can
build fuzz and run it with the testing corpus.

Fuzz testing is known to work with Fedora 28 or later. It requires that the
'clang' package is installed.

Ex:
$ ./configure --with-openssl --with-tpm2 --enable-sanitizers --enable-fuzzer \
    CC=clang CXX=clang++
$ make && make -C tests fuzz
$ tests/run-fuzzer.sh

oss-fuzz builds with its own fuzzer flags, and set $LIB_FUZZING_ENGINE
to be linked with. The script run by oss-fuzz is tests/oss-fuzz.sh.

Maintainers
-----------
libtpms is currently being maintained by Stefan Berger <stefanb@us.ibm.com>.

References:
-----------

Documentation about the Trusted Platform Module (TPM) can be downloaded
from the Trusted Computing Group's website at

http://www.trustedcomputinggroup.org