libtpms/man/man3/TPMLIB_ValidateState.pod
Nicolas Iooss bbd7b75d71 Fix many misspellings
When testing downgrading from libtpms 0.8 to 0.7 (which is not
possible), the error message which is reported is:

    libtpms/tpm2: Unexpect value for MAX_RSA_KEY_BITS; its value 3072 is
    not = 2048; (version: 2).

codespell (https://github.com/codespell-project/codespell) reports a
misspelling for "Unexpect", which should be "Unexpected". As the project
contains many more misspellings in comments, error messages and
documentation, fix all misspellings reported by codespell.

Signed-off-by: Nicolas Iooss <nicolas.iooss@ledger.fr>
2021-03-02 08:20:25 -05:00

45 lines
1.3 KiB
Plaintext

=head1 NAME
TPMLIB_ValidateState - Validate the state blobs of the TPM
=head1 LIBRARY
TPM library (libtpms, -ltpms)
=head1 SYNOPSIS
B<#include <libtpms/tpm_library.h>>
B<uint32_t TPMLIB_ValidateState(TPMLIB_StateType st,
unsigned int flags);
>
=head1 DESCRIPTION
The B<TPMLIB_ValidateState()> function allows to validate the
state blobs that the TPM would read upon B<TPMLIB_MainInit()> or
once the TPM_Startup command has been sent to it.
This function is useful for TPM state migration between possibly
different version of libtpms. Here the target libtpms needs to be
able to determine whether it can support the version of blobs that were
migrated and if this is not the case, the caller can refuse the
migration.
The B<tpmlib_state> parameter can be a logical 'or' of one or
multiple of of the following: B<TPMLIB_STATE_PERMANENT>,
B<TPMLIB_STATE_VOLATILE>, or B<TPMLIB_STATE_SAVE_STATE>.
The B<flags> parameter is currently not used and should be set to 0.
The first state blob that should be loaded is the permanent state,
since for example the volatile state requires it to be available
for validation.
This function should be called before B<TPMLIB_MainInit()> is invoked.
=head1 SEE ALSO
B<TPMLIB_MainInit>(3), B<TPMLIB_Terminate>(3)
=cut