Blame doc/tpm-api.texi

Packit aea12f
Packit aea12f
@subheading gnutls_tpm_get_registered
Packit aea12f
@anchor{gnutls_tpm_get_registered}
Packit aea12f
@deftypefun {int} {gnutls_tpm_get_registered} (gnutls_tpm_key_list_t * @var{list})
Packit aea12f
@var{list}: a list to store the keys
Packit aea12f
Packit aea12f
This function will get a list of stored keys in the TPM. The uuid
Packit aea12f
of those keys
Packit aea12f
Packit aea12f
@strong{Returns:} On success, @code{GNUTLS_E_SUCCESS}  (0) is returned, otherwise a
Packit aea12f
negative error value.
Packit aea12f
Packit aea12f
@strong{Since:} 3.1.0
Packit aea12f
@end deftypefun
Packit aea12f
Packit aea12f
@subheading gnutls_tpm_key_list_deinit
Packit aea12f
@anchor{gnutls_tpm_key_list_deinit}
Packit aea12f
@deftypefun {void} {gnutls_tpm_key_list_deinit} (gnutls_tpm_key_list_t @var{list})
Packit aea12f
@var{list}: a list of the keys
Packit aea12f
Packit aea12f
This function will deinitialize the list of stored keys in the TPM.
Packit aea12f
Packit aea12f
@strong{Since:} 3.1.0
Packit aea12f
@end deftypefun
Packit aea12f
Packit aea12f
@subheading gnutls_tpm_key_list_get_url
Packit aea12f
@anchor{gnutls_tpm_key_list_get_url}
Packit aea12f
@deftypefun {int} {gnutls_tpm_key_list_get_url} (gnutls_tpm_key_list_t @var{list}, unsigned int @var{idx}, char ** @var{url}, unsigned int @var{flags})
Packit aea12f
@var{list}: a list of the keys
Packit aea12f
Packit aea12f
@var{idx}: The index of the key (starting from zero)
Packit aea12f
Packit aea12f
@var{url}: The URL to be returned
Packit aea12f
Packit aea12f
@var{flags}: should be zero
Packit aea12f
Packit aea12f
This function will return for each given index a URL of
Packit aea12f
the corresponding key.
Packit aea12f
If the provided index is out of bounds then @code{GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE} 
Packit aea12f
is returned.
Packit aea12f
Packit aea12f
@strong{Returns:} On success, @code{GNUTLS_E_SUCCESS}  (0) is returned, otherwise a
Packit aea12f
negative error value.
Packit aea12f
Packit aea12f
@strong{Since:} 3.1.0
Packit aea12f
@end deftypefun
Packit aea12f
Packit aea12f
@subheading gnutls_tpm_privkey_delete
Packit aea12f
@anchor{gnutls_tpm_privkey_delete}
Packit aea12f
@deftypefun {int} {gnutls_tpm_privkey_delete} (const char * @var{url}, const char * @var{srk_password})
Packit aea12f
@var{url}: the URL describing the key
Packit aea12f
Packit aea12f
@var{srk_password}: a password for the SRK key
Packit aea12f
Packit aea12f
This function will unregister the private key from the TPM
Packit aea12f
chip. 
Packit aea12f
Packit aea12f
@strong{Returns:} On success, @code{GNUTLS_E_SUCCESS}  (0) is returned, otherwise a
Packit aea12f
negative error value.
Packit aea12f
Packit aea12f
@strong{Since:} 3.1.0
Packit aea12f
@end deftypefun
Packit aea12f
Packit aea12f
@subheading gnutls_tpm_privkey_generate
Packit aea12f
@anchor{gnutls_tpm_privkey_generate}
Packit aea12f
@deftypefun {int} {gnutls_tpm_privkey_generate} (gnutls_pk_algorithm_t @var{pk}, unsigned int @var{bits}, const char * @var{srk_password}, const char * @var{key_password}, gnutls_tpmkey_fmt_t @var{format}, gnutls_x509_crt_fmt_t @var{pub_format}, gnutls_datum_t * @var{privkey}, gnutls_datum_t * @var{pubkey}, unsigned int @var{flags})
Packit aea12f
@var{pk}: the public key algorithm
Packit aea12f
Packit aea12f
@var{bits}: the security bits
Packit aea12f
Packit aea12f
@var{srk_password}: a password to protect the exported key (optional)
Packit aea12f
Packit aea12f
@var{key_password}: the password for the TPM (optional)
Packit aea12f
Packit aea12f
@var{format}: the format of the private key
Packit aea12f
Packit aea12f
@var{pub_format}: the format of the public key
Packit aea12f
Packit aea12f
@var{privkey}: the generated key
Packit aea12f
Packit aea12f
@var{pubkey}: the corresponding public key (may be null)
Packit aea12f
Packit aea12f
@var{flags}: should be a list of GNUTLS_TPM_* flags
Packit aea12f
Packit aea12f
This function will generate a private key in the TPM
Packit aea12f
chip. The private key will be generated within the chip
Packit aea12f
and will be exported in a wrapped with TPM's master key
Packit aea12f
form. Furthermore the wrapped key can be protected with
Packit aea12f
the provided  @code{password} .
Packit aea12f
Packit aea12f
Note that bits in TPM is quantized value. If the input value
Packit aea12f
is not one of the allowed values, then it will be quantized to
Packit aea12f
one of 512, 1024, 2048, 4096, 8192 and 16384.
Packit aea12f
Packit aea12f
Allowed flags are:
Packit aea12f
Packit aea12f
@strong{Returns:} On success, @code{GNUTLS_E_SUCCESS}  (0) is returned, otherwise a
Packit aea12f
negative error value.
Packit aea12f
Packit aea12f
@strong{Since:} 3.1.0
Packit aea12f
@end deftypefun
Packit aea12f