Blame doc/tpm-api.texi

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