This is gnutls.info, produced by makeinfo version 6.3 from gnutls.texi.
This manual is last updated 12 February 2018 for version 3.6.2 of
GnuTLS.
Copyright (C) 2001-2018 Free Software Foundation, Inc.\\ Copyright (C)
2001-2018 Nikos Mavrogiannopoulos
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License,
Version 1.3 or any later version published by the Free Software
Foundation; with no Invariant Sections, no Front-Cover Texts, and
no Back-Cover Texts. A copy of the license is included in the
section entitled "GNU Free Documentation License".
INFO-DIR-SECTION Software libraries
START-INFO-DIR-ENTRY
* GnuTLS: (gnutls). GNU Transport Layer Security Library.
END-INFO-DIR-ENTRY
INFO-DIR-SECTION System Administration
START-INFO-DIR-ENTRY
* certtool: (gnutls)Invoking certtool. Manipulate certificates and keys.
* gnutls-serv: (gnutls)Invoking gnutls-serv. GnuTLS test server.
* gnutls-cli: (gnutls)Invoking gnutls-cli. GnuTLS test client.
* gnutls-cli-debug: (gnutls)Invoking gnutls-cli-debug. GnuTLS debug client.
* psktool: (gnutls)Invoking psktool. Simple TLS-Pre-Shared-Keys manager.
* srptool: (gnutls)Invoking srptool. Simple SRP password tool.
END-INFO-DIR-ENTRY
File: gnutls.info, Node: PKCS 7 API, Next: OCSP API, Prev: X509 certificate API, Up: API reference
E.4 PKCS 7 API
==============
The following functions are to be used for PKCS 7 structures handling.
Their prototypes lie in 'gnutls/pkcs7.h'.
gnutls_pkcs7_add_attr
---------------------
-- Function: int gnutls_pkcs7_add_attr (gnutls_pkcs7_attrs_t * LIST,
const char * OID, gnutls_datum_t * DATA, unsigned FLAGS)
LIST: A list of existing attributes or pointer to 'NULL' for the
first one
OID: the OID of the attribute to be set
DATA: the raw (DER-encoded) data of the attribute to be set
FLAGS: zero or 'GNUTLS_PKCS7_ATTR_ENCODE_OCTET_STRING'
This function will set a PKCS '7' attribute in the provided list.
If this function fails, the previous list would be deallocated.
Note that any attributes set with this function must either be DER
or BER encoded, unless a special flag is present.
*Returns:* On success, the new list head, otherwise 'NULL' .
*Since:* 3.4.2
gnutls_pkcs7_attrs_deinit
-------------------------
-- Function: void gnutls_pkcs7_attrs_deinit (gnutls_pkcs7_attrs_t LIST)
LIST: A list of existing attributes
This function will clear a PKCS '7' attribute list.
*Since:* 3.4.2
gnutls_pkcs7_deinit
-------------------
-- Function: void gnutls_pkcs7_deinit (gnutls_pkcs7_t PKCS7)
PKCS7: the type to be deinitialized
This function will deinitialize a PKCS7 type.
gnutls_pkcs7_delete_crl
-----------------------
-- Function: int gnutls_pkcs7_delete_crl (gnutls_pkcs7_t PKCS7, int
INDX)
PKCS7: The pkcs7 type
INDX: the index of the crl to delete
This function will delete a crl from a PKCS7 or RFC2630 crl set.
Index starts from 0. Returns 0 on success.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs7_delete_crt
-----------------------
-- Function: int gnutls_pkcs7_delete_crt (gnutls_pkcs7_t PKCS7, int
INDX)
PKCS7: The pkcs7 type
INDX: the index of the certificate to delete
This function will delete a certificate from a PKCS7 or RFC2630
certificate set. Index starts from 0. Returns 0 on success.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs7_export
-------------------
-- Function: int gnutls_pkcs7_export (gnutls_pkcs7_t PKCS7,
gnutls_x509_crt_fmt_t FORMAT, void * OUTPUT_DATA, size_t *
OUTPUT_DATA_SIZE)
PKCS7: The pkcs7 type
FORMAT: the format of output params. One of PEM or DER.
OUTPUT_DATA: will contain a structure PEM or DER encoded
OUTPUT_DATA_SIZE: holds the size of output_data (and will be
replaced by the actual size of parameters)
This function will export the pkcs7 structure to DER or PEM format.
If the buffer provided is not long enough to hold the output, then
* 'output_data_size' is updated and 'GNUTLS_E_SHORT_MEMORY_BUFFER'
will be returned.
If the structure is PEM encoded, it will have a header of "BEGIN
PKCS7".
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs7_export2
--------------------
-- Function: int gnutls_pkcs7_export2 (gnutls_pkcs7_t PKCS7,
gnutls_x509_crt_fmt_t FORMAT, gnutls_datum_t * OUT)
PKCS7: The pkcs7 type
FORMAT: the format of output params. One of PEM or DER.
OUT: will contain a structure PEM or DER encoded
This function will export the pkcs7 structure to DER or PEM format.
The output buffer is allocated using 'gnutls_malloc()' .
If the structure is PEM encoded, it will have a header of "BEGIN
PKCS7".
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.1.3
gnutls_pkcs7_get_attr
---------------------
-- Function: int gnutls_pkcs7_get_attr (gnutls_pkcs7_attrs_t LIST,
unsigned IDX, char ** OID, gnutls_datum_t * DATA, unsigned
FLAGS)
LIST: A list of existing attributes or 'NULL' for the first one
IDX: the index of the attribute to get
OID: the OID of the attribute (read-only)
DATA: the raw data of the attribute
FLAGS: zero or 'GNUTLS_PKCS7_ATTR_ENCODE_OCTET_STRING'
This function will get a PKCS '7' attribute from the provided list.
The OID is a constant string, but data will be allocated and must
be deinitialized by the caller.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
'GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE' is returned if there are no
data in the current index.
*Since:* 3.4.2
gnutls_pkcs7_get_crl_count
--------------------------
-- Function: int gnutls_pkcs7_get_crl_count (gnutls_pkcs7_t PKCS7)
PKCS7: The pkcs7 type
This function will return the number of certificates in the PKCS7
or RFC2630 crl set.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs7_get_crl_raw
------------------------
-- Function: int gnutls_pkcs7_get_crl_raw (gnutls_pkcs7_t PKCS7,
unsigned INDX, void * CRL, size_t * CRL_SIZE)
PKCS7: The pkcs7 type
INDX: contains the index of the crl to extract
CRL: the contents of the crl will be copied there (may be null)
CRL_SIZE: should hold the size of the crl
This function will return a crl of the PKCS7 or RFC2630 crl set.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value. If the provided buffer is not
long enough, then 'crl_size' is updated and
'GNUTLS_E_SHORT_MEMORY_BUFFER' is returned. After the last crl has
been read 'GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE' will be returned.
gnutls_pkcs7_get_crl_raw2
-------------------------
-- Function: int gnutls_pkcs7_get_crl_raw2 (gnutls_pkcs7_t PKCS7,
unsigned INDX, gnutls_datum_t * CRL)
PKCS7: The pkcs7 type
INDX: contains the index of the crl to extract
CRL: will contain the contents of the CRL in an allocated buffer
This function will return a DER encoded CRL of the PKCS7 or RFC2630
crl set.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value. After the last crl has been read
'GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE' will be returned.
*Since:* 3.4.2
gnutls_pkcs7_get_crt_count
--------------------------
-- Function: int gnutls_pkcs7_get_crt_count (gnutls_pkcs7_t PKCS7)
PKCS7: should contain a 'gnutls_pkcs7_t' type
This function will return the number of certificates in the PKCS7
or RFC2630 certificate set.
*Returns:* On success, a positive number is returned, otherwise a
negative error value.
gnutls_pkcs7_get_crt_raw
------------------------
-- Function: int gnutls_pkcs7_get_crt_raw (gnutls_pkcs7_t PKCS7,
unsigned INDX, void * CERTIFICATE, size_t * CERTIFICATE_SIZE)
PKCS7: should contain a gnutls_pkcs7_t type
INDX: contains the index of the certificate to extract
CERTIFICATE: the contents of the certificate will be copied there
(may be null)
CERTIFICATE_SIZE: should hold the size of the certificate
This function will return a certificate of the PKCS7 or RFC2630
certificate set.
After the last certificate has been read
'GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE' will be returned.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value. If the provided buffer is not
long enough, then 'certificate_size' is updated and
'GNUTLS_E_SHORT_MEMORY_BUFFER' is returned.
gnutls_pkcs7_get_crt_raw2
-------------------------
-- Function: int gnutls_pkcs7_get_crt_raw2 (gnutls_pkcs7_t PKCS7,
unsigned INDX, gnutls_datum_t * CERT)
PKCS7: should contain a gnutls_pkcs7_t type
INDX: contains the index of the certificate to extract
CERT: will hold the contents of the certificate; must be
deallocated with 'gnutls_free()'
This function will return a certificate of the PKCS7 or RFC2630
certificate set.
After the last certificate has been read
'GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE' will be returned.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value. If the provided buffer is not
long enough, then 'certificate_size' is updated and
'GNUTLS_E_SHORT_MEMORY_BUFFER' is returned.
*Since:* 3.4.2
gnutls_pkcs7_get_embedded_data
------------------------------
-- Function: int gnutls_pkcs7_get_embedded_data (gnutls_pkcs7_t PKCS7,
unsigned FLAGS, gnutls_datum_t * DATA)
PKCS7: should contain a gnutls_pkcs7_t type
FLAGS: must be zero or 'GNUTLS_PKCS7_EDATA_GET_RAW'
DATA: will hold the embedded data in the provided structure
This function will return the data embedded in the signature of the
PKCS7 structure. If no data are available then
'GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE' will be returned.
The returned data must be de-allocated using 'gnutls_free()' .
Note, that this function returns the exact same data that are
authenticated. If the 'GNUTLS_PKCS7_EDATA_GET_RAW' flag is
provided, the returned data will be including the wrapping
tag/value as they are encoded in the structure.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.4.8
gnutls_pkcs7_get_embedded_data_oid
----------------------------------
-- Function: const char * gnutls_pkcs7_get_embedded_data_oid
(gnutls_pkcs7_t PKCS7)
PKCS7: should contain a gnutls_pkcs7_t type
This function will return the OID of the data embedded in the
signature of the PKCS7 structure. If no data are available then
'NULL' will be returned. The returned value will be valid during
the lifetime of the 'pkcs7' structure.
*Returns:* On success, a pointer to an OID string, 'NULL' on error.
*Since:* 3.5.5
gnutls_pkcs7_get_signature_count
--------------------------------
-- Function: int gnutls_pkcs7_get_signature_count (gnutls_pkcs7_t
PKCS7)
PKCS7: should contain a 'gnutls_pkcs7_t' type
This function will return the number of signatures in the PKCS7
structure.
*Returns:* On success, a positive number is returned, otherwise a
negative error value.
*Since:* 3.4.3
gnutls_pkcs7_get_signature_info
-------------------------------
-- Function: int gnutls_pkcs7_get_signature_info (gnutls_pkcs7_t PKCS7,
unsigned IDX, gnutls_pkcs7_signature_info_st * INFO)
PKCS7: should contain a 'gnutls_pkcs7_t' type
IDX: the index of the signature info to check
INFO: will contain the output signature
This function will return information about the signature
identified by idx in the provided PKCS '7' structure. The
information should be deinitialized using
'gnutls_pkcs7_signature_info_deinit()' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.4.2
gnutls_pkcs7_import
-------------------
-- Function: int gnutls_pkcs7_import (gnutls_pkcs7_t PKCS7, const
gnutls_datum_t * DATA, gnutls_x509_crt_fmt_t FORMAT)
PKCS7: The data to store the parsed PKCS7.
DATA: The DER or PEM encoded PKCS7.
FORMAT: One of DER or PEM
This function will convert the given DER or PEM encoded PKCS7 to
the native 'gnutls_pkcs7_t' format. The output will be stored in
'pkcs7' .
If the PKCS7 is PEM encoded it should have a header of "PKCS7".
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs7_init
-----------------
-- Function: int gnutls_pkcs7_init (gnutls_pkcs7_t * PKCS7)
PKCS7: A pointer to the type to be initialized
This function will initialize a PKCS7 structure. PKCS7 structures
usually contain lists of X.509 Certificates and X.509 Certificate
revocation lists.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs7_print
------------------
-- Function: int gnutls_pkcs7_print (gnutls_pkcs7_t PKCS7,
gnutls_certificate_print_formats_t FORMAT, gnutls_datum_t *
OUT)
PKCS7: The PKCS7 struct to be printed
FORMAT: Indicate the format to use
OUT: Newly allocated datum with null terminated string.
This function will pretty print a signed PKCS '7' structure,
suitable for display to a human.
Currently the supported formats are 'GNUTLS_CRT_PRINT_FULL' and
'GNUTLS_CRT_PRINT_COMPACT' .
The output 'out' needs to be deallocated using 'gnutls_free()' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs7_set_crl
--------------------
-- Function: int gnutls_pkcs7_set_crl (gnutls_pkcs7_t PKCS7,
gnutls_x509_crl_t CRL)
PKCS7: The pkcs7 type
CRL: the DER encoded crl to be added
This function will add a parsed CRL to the PKCS7 or RFC2630 crl
set.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs7_set_crl_raw
------------------------
-- Function: int gnutls_pkcs7_set_crl_raw (gnutls_pkcs7_t PKCS7, const
gnutls_datum_t * CRL)
PKCS7: The pkcs7 type
CRL: the DER encoded crl to be added
This function will add a crl to the PKCS7 or RFC2630 crl set.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs7_set_crt
--------------------
-- Function: int gnutls_pkcs7_set_crt (gnutls_pkcs7_t PKCS7,
gnutls_x509_crt_t CRT)
PKCS7: The pkcs7 type
CRT: the certificate to be copied.
This function will add a parsed certificate to the PKCS7 or RFC2630
certificate set. This is a wrapper function over
'gnutls_pkcs7_set_crt_raw()' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs7_set_crt_raw
------------------------
-- Function: int gnutls_pkcs7_set_crt_raw (gnutls_pkcs7_t PKCS7, const
gnutls_datum_t * CRT)
PKCS7: The pkcs7 type
CRT: the DER encoded certificate to be added
This function will add a certificate to the PKCS7 or RFC2630
certificate set.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs7_sign
-----------------
-- Function: int gnutls_pkcs7_sign (gnutls_pkcs7_t PKCS7,
gnutls_x509_crt_t SIGNER, gnutls_privkey_t SIGNER_KEY, const
gnutls_datum_t * DATA, gnutls_pkcs7_attrs_t SIGNED_ATTRS,
gnutls_pkcs7_attrs_t UNSIGNED_ATTRS, gnutls_digest_algorithm_t
DIG, unsigned FLAGS)
PKCS7: should contain a 'gnutls_pkcs7_t' type
SIGNER: the certificate to sign the structure
SIGNER_KEY: the key to sign the structure
DATA: The data to be signed or 'NULL' if the data are already
embedded
SIGNED_ATTRS: Any additional attributes to be included in the
signed ones (or 'NULL' )
UNSIGNED_ATTRS: Any additional attributes to be included in the
unsigned ones (or 'NULL' )
DIG: The digest algorithm to use for signing
FLAGS: Should be zero or one of 'GNUTLS_PKCS7' flags
This function will add a signature in the provided PKCS '7'
structure for the provided data. Multiple signatures can be made
with different signers.
The available flags are: 'GNUTLS_PKCS7_EMBED_DATA' ,
'GNUTLS_PKCS7_INCLUDE_TIME' , 'GNUTLS_PKCS7_INCLUDE_CERT' , and
'GNUTLS_PKCS7_WRITE_SPKI' . They are explained in the
'gnutls_pkcs7_sign_flags' definition.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.4.2
gnutls_pkcs7_signature_info_deinit
----------------------------------
-- Function: void gnutls_pkcs7_signature_info_deinit
(gnutls_pkcs7_signature_info_st * INFO)
INFO: should point to a 'gnutls_pkcs7_signature_info_st' structure
This function will deinitialize any allocated value in the provided
'gnutls_pkcs7_signature_info_st' .
*Since:* 3.4.2
gnutls_pkcs7_verify
-------------------
-- Function: int gnutls_pkcs7_verify (gnutls_pkcs7_t PKCS7,
gnutls_x509_trust_list_t TL, gnutls_typed_vdata_st * VDATA,
unsigned int VDATA_SIZE, unsigned IDX, const gnutls_datum_t *
DATA, unsigned FLAGS)
PKCS7: should contain a 'gnutls_pkcs7_t' type
TL: A list of trusted certificates
VDATA: an array of typed data
VDATA_SIZE: the number of data elements
IDX: the index of the signature info to check
DATA: The data to be verified or 'NULL'
FLAGS: Zero or an OR list of 'gnutls_certificate_verify_flags'
This function will verify the provided data against the signature
present in the SignedData of the PKCS '7' structure. If the data
provided are NULL then the data in the encapsulatedContent field
will be used instead.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value. A verification error results to
a 'GNUTLS_E_PK_SIG_VERIFY_FAILED' and the lack of encapsulated data
to verify to a 'GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE' .
*Since:* 3.4.2
gnutls_pkcs7_verify_direct
--------------------------
-- Function: int gnutls_pkcs7_verify_direct (gnutls_pkcs7_t PKCS7,
gnutls_x509_crt_t SIGNER, unsigned IDX, const gnutls_datum_t *
DATA, unsigned FLAGS)
PKCS7: should contain a 'gnutls_pkcs7_t' type
SIGNER: the certificate believed to have signed the structure
IDX: the index of the signature info to check
DATA: The data to be verified or 'NULL'
FLAGS: Zero or an OR list of 'gnutls_certificate_verify_flags'
This function will verify the provided data against the signature
present in the SignedData of the PKCS '7' structure. If the data
provided are NULL then the data in the encapsulatedContent field
will be used instead.
Note that, unlike 'gnutls_pkcs7_verify()' this function does not
verify the key purpose of the signer. It is expected for the
caller to verify the intended purpose of the 'signer' -e.g., via
'gnutls_x509_crt_get_key_purpose_oid()' , or
'gnutls_x509_crt_check_key_purpose()' .
Note also, that since GnuTLS 3.5.6 this function introduces checks
in the end certificate ( 'signer' ), including time checks and key
usage checks.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value. A verification error results to
a 'GNUTLS_E_PK_SIG_VERIFY_FAILED' and the lack of encapsulated data
to verify to a 'GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE' .
*Since:* 3.4.2
File: gnutls.info, Node: OCSP API, Next: PKCS 12 API, Prev: PKCS 7 API, Up: API reference
E.5 OCSP API
============
The following functions are for OCSP certificate status checking. Their
prototypes lie in 'gnutls/ocsp.h'.
gnutls_ocsp_req_add_cert
------------------------
-- Function: int gnutls_ocsp_req_add_cert (gnutls_ocsp_req_t REQ,
gnutls_digest_algorithm_t DIGEST, gnutls_x509_crt_t ISSUER,
gnutls_x509_crt_t CERT)
REQ: should contain a 'gnutls_ocsp_req_t' type
DIGEST: hash algorithm, a 'gnutls_digest_algorithm_t' value
ISSUER: issuer of 'subject' certificate
CERT: certificate to request status for
This function will add another request to the OCSP request for a
particular certificate. The issuer name hash, issuer key hash, and
serial number fields is populated as follows. The issuer name and
the serial number is taken from 'cert' . The issuer key is taken
from 'issuer' . The hashed values will be hashed using the
'digest' algorithm, normally 'GNUTLS_DIG_SHA1' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error code is returned.
gnutls_ocsp_req_add_cert_id
---------------------------
-- Function: int gnutls_ocsp_req_add_cert_id (gnutls_ocsp_req_t REQ,
gnutls_digest_algorithm_t DIGEST, const gnutls_datum_t *
ISSUER_NAME_HASH, const gnutls_datum_t * ISSUER_KEY_HASH,
const gnutls_datum_t * SERIAL_NUMBER)
REQ: should contain a 'gnutls_ocsp_req_t' type
DIGEST: hash algorithm, a 'gnutls_digest_algorithm_t' value
ISSUER_NAME_HASH: hash of issuer's DN
ISSUER_KEY_HASH: hash of issuer's public key
SERIAL_NUMBER: serial number of certificate to check
This function will add another request to the OCSP request for a
particular certificate having the issuer name hash of
'issuer_name_hash' and issuer key hash of 'issuer_key_hash' (both
hashed using 'digest' ) and serial number 'serial_number' .
The information needed corresponds to the CertID structure:
<informalexample><programlisting> CertID ::= SEQUENCE {
hashAlgorithm AlgorithmIdentifier, issuerNameHash OCTET STRING, -
Hash of Issuer's DN issuerKeyHash OCTET STRING, - Hash of Issuers
public key serialNumber CertificateSerialNumber }
</programlisting></informalexample>
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error code is returned.
gnutls_ocsp_req_deinit
----------------------
-- Function: void gnutls_ocsp_req_deinit (gnutls_ocsp_req_t REQ)
REQ: The data to be deinitialized
This function will deinitialize a OCSP request structure.
gnutls_ocsp_req_export
----------------------
-- Function: int gnutls_ocsp_req_export (gnutls_ocsp_req_t REQ,
gnutls_datum_t * DATA)
REQ: Holds the OCSP request
DATA: newly allocate buffer holding DER encoded OCSP request
This function will export the OCSP request to DER format.
*Returns:* In case of failure a negative error code will be
returned, and 0 on success.
gnutls_ocsp_req_get_cert_id
---------------------------
-- Function: int gnutls_ocsp_req_get_cert_id (gnutls_ocsp_req_t REQ,
unsigned INDX, gnutls_digest_algorithm_t * DIGEST,
gnutls_datum_t * ISSUER_NAME_HASH, gnutls_datum_t *
ISSUER_KEY_HASH, gnutls_datum_t * SERIAL_NUMBER)
REQ: should contain a 'gnutls_ocsp_req_t' type
INDX: Specifies which extension OID to get. Use (0) to get the
first one.
DIGEST: output variable with 'gnutls_digest_algorithm_t' hash
algorithm
ISSUER_NAME_HASH: output buffer with hash of issuer's DN
ISSUER_KEY_HASH: output buffer with hash of issuer's public key
SERIAL_NUMBER: output buffer with serial number of certificate to
check
This function will return the certificate information of the 'indx'
'ed request in the OCSP request. The information returned
corresponds to the CertID structure:
<informalexample><programlisting> CertID ::= SEQUENCE {
hashAlgorithm AlgorithmIdentifier, issuerNameHash OCTET STRING, -
Hash of Issuer's DN issuerKeyHash OCTET STRING, - Hash of Issuers
public key serialNumber CertificateSerialNumber }
</programlisting></informalexample>
Each of the pointers to output variables may be NULL to indicate
that the caller is not interested in that value.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error code is returned. If you have reached
the last CertID available 'GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE'
will be returned.
gnutls_ocsp_req_get_extension
-----------------------------
-- Function: int gnutls_ocsp_req_get_extension (gnutls_ocsp_req_t REQ,
unsigned INDX, gnutls_datum_t * OID, unsigned int * CRITICAL,
gnutls_datum_t * DATA)
REQ: should contain a 'gnutls_ocsp_req_t' type
INDX: Specifies which extension OID to get. Use (0) to get the
first one.
OID: will hold newly allocated buffer with OID of extension, may be
NULL
CRITICAL: output variable with critical flag, may be NULL.
DATA: will hold newly allocated buffer with extension data, may be
NULL
This function will return all information about the requested
extension in the OCSP request. The information returned is the
OID, the critical flag, and the data itself. The extension OID
will be stored as a string. Any of 'oid' , 'critical' , and 'data'
may be NULL which means that the caller is not interested in
getting that information back.
The caller needs to deallocate memory by calling 'gnutls_free()' on
'oid' ->data and 'data' ->data.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error code is returned. If you have reached
the last extension available
'GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE' will be returned.
gnutls_ocsp_req_get_nonce
-------------------------
-- Function: int gnutls_ocsp_req_get_nonce (gnutls_ocsp_req_t REQ,
unsigned int * CRITICAL, gnutls_datum_t * NONCE)
REQ: should contain a 'gnutls_ocsp_req_t' type
CRITICAL: whether nonce extension is marked critical, or NULL
NONCE: will hold newly allocated buffer with nonce data
This function will return the OCSP request nonce extension data.
The caller needs to deallocate memory by calling 'gnutls_free()' on
'nonce' ->data.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error code is returned.
gnutls_ocsp_req_get_version
---------------------------
-- Function: int gnutls_ocsp_req_get_version (gnutls_ocsp_req_t REQ)
REQ: should contain a 'gnutls_ocsp_req_t' type
This function will return the version of the OCSP request.
Typically this is always 1 indicating version 1.
*Returns:* version of OCSP request, or a negative error code on
error.
gnutls_ocsp_req_import
----------------------
-- Function: int gnutls_ocsp_req_import (gnutls_ocsp_req_t REQ, const
gnutls_datum_t * DATA)
REQ: The data to store the parsed request.
DATA: DER encoded OCSP request.
This function will convert the given DER encoded OCSP request to
the native 'gnutls_ocsp_req_t' format. The output will be stored
in 'req' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_ocsp_req_init
--------------------
-- Function: int gnutls_ocsp_req_init (gnutls_ocsp_req_t * REQ)
REQ: A pointer to the type to be initialized
This function will initialize an OCSP request structure.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_ocsp_req_print
---------------------
-- Function: int gnutls_ocsp_req_print (gnutls_ocsp_req_t REQ,
gnutls_ocsp_print_formats_t FORMAT, gnutls_datum_t * OUT)
REQ: The data to be printed
FORMAT: Indicate the format to use
OUT: Newly allocated datum with (0) terminated string.
This function will pretty print a OCSP request, suitable for
display to a human.
If the format is 'GNUTLS_OCSP_PRINT_FULL' then all fields of the
request will be output, on multiple lines.
The output 'out' ->data needs to be deallocate using
'gnutls_free()' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_ocsp_req_randomize_nonce
-------------------------------
-- Function: int gnutls_ocsp_req_randomize_nonce (gnutls_ocsp_req_t
REQ)
REQ: should contain a 'gnutls_ocsp_req_t' type
This function will add or update an nonce extension to the OCSP
request with a newly generated random value.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error code is returned.
gnutls_ocsp_req_set_extension
-----------------------------
-- Function: int gnutls_ocsp_req_set_extension (gnutls_ocsp_req_t REQ,
const char * OID, unsigned int CRITICAL, const gnutls_datum_t
* DATA)
REQ: should contain a 'gnutls_ocsp_req_t' type
OID: buffer with OID of extension as a string.
CRITICAL: critical flag, normally false.
DATA: the extension data
This function will add an extension to the OCSP request. Calling
this function multiple times for the same OID will overwrite values
from earlier calls.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error code is returned.
gnutls_ocsp_req_set_nonce
-------------------------
-- Function: int gnutls_ocsp_req_set_nonce (gnutls_ocsp_req_t REQ,
unsigned int CRITICAL, const gnutls_datum_t * NONCE)
REQ: should contain a 'gnutls_ocsp_req_t' type
CRITICAL: critical flag, normally false.
NONCE: the nonce data
This function will add an nonce extension to the OCSP request.
Calling this function multiple times will overwrite values from
earlier calls.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error code is returned.
gnutls_ocsp_resp_check_crt
--------------------------
-- Function: int gnutls_ocsp_resp_check_crt (gnutls_ocsp_resp_t RESP,
unsigned int INDX, gnutls_x509_crt_t CRT)
RESP: should contain a 'gnutls_ocsp_resp_t' type
INDX: Specifies response number to get. Use (0) to get the first
one.
CRT: The certificate to check
This function will check whether the OCSP response is about the
provided certificate.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error code is returned.
*Since:* 3.1.3
gnutls_ocsp_resp_deinit
-----------------------
-- Function: void gnutls_ocsp_resp_deinit (gnutls_ocsp_resp_t RESP)
RESP: The data to be deinitialized
This function will deinitialize a OCSP response structure.
gnutls_ocsp_resp_export
-----------------------
-- Function: int gnutls_ocsp_resp_export (gnutls_ocsp_resp_t RESP,
gnutls_datum_t * DATA)
RESP: Holds the OCSP response
DATA: newly allocate buffer holding DER encoded OCSP response
This function will export the OCSP response to DER format.
*Returns:* In case of failure a negative error code will be
returned, and 0 on success.
gnutls_ocsp_resp_get_certs
--------------------------
-- Function: int gnutls_ocsp_resp_get_certs (gnutls_ocsp_resp_t RESP,
gnutls_x509_crt_t ** CERTS, size_t * NCERTS)
RESP: should contain a 'gnutls_ocsp_resp_t' type
CERTS: newly allocated array with 'gnutls_x509_crt_t' certificates
NCERTS: output variable with number of allocated certs.
This function will extract the X.509 certificates found in the
Basic OCSP Response. The 'certs' output variable will hold a newly
allocated zero-terminated array with X.509 certificates.
Every certificate in the array needs to be de-allocated with
'gnutls_x509_crt_deinit()' and the array itself must be freed using
'gnutls_free()' .
Both the 'certs' and 'ncerts' variables may be NULL. Then the
function will work as normal but will not return the NULL:d
information. This can be used to get the number of certificates
only, or to just get the certificate array without its size.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_ocsp_resp_get_extension
------------------------------
-- Function: int gnutls_ocsp_resp_get_extension (gnutls_ocsp_resp_t
RESP, unsigned INDX, gnutls_datum_t * OID, unsigned int *
CRITICAL, gnutls_datum_t * DATA)
RESP: should contain a 'gnutls_ocsp_resp_t' type
INDX: Specifies which extension OID to get. Use (0) to get the
first one.
OID: will hold newly allocated buffer with OID of extension, may be
NULL
CRITICAL: output variable with critical flag, may be NULL.
DATA: will hold newly allocated buffer with extension data, may be
NULL
This function will return all information about the requested
extension in the OCSP response. The information returned is the
OID, the critical flag, and the data itself. The extension OID
will be stored as a string. Any of 'oid' , 'critical' , and 'data'
may be NULL which means that the caller is not interested in
getting that information back.
The caller needs to deallocate memory by calling 'gnutls_free()' on
'oid' ->data and 'data' ->data.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error code is returned. If you have reached
the last extension available
'GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE' will be returned.
gnutls_ocsp_resp_get_nonce
--------------------------
-- Function: int gnutls_ocsp_resp_get_nonce (gnutls_ocsp_resp_t RESP,
unsigned int * CRITICAL, gnutls_datum_t * NONCE)
RESP: should contain a 'gnutls_ocsp_resp_t' type
CRITICAL: whether nonce extension is marked critical
NONCE: will hold newly allocated buffer with nonce data
This function will return the Basic OCSP Response nonce extension
data.
The caller needs to deallocate memory by calling 'gnutls_free()' on
'nonce' ->data.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error code is returned.
gnutls_ocsp_resp_get_produced
-----------------------------
-- Function: time_t gnutls_ocsp_resp_get_produced (gnutls_ocsp_resp_t
RESP)
RESP: should contain a 'gnutls_ocsp_resp_t' type
This function will return the time when the OCSP response was
signed.
*Returns:* signing time, or (time_t)-1 on error.
gnutls_ocsp_resp_get_responder
------------------------------
-- Function: int gnutls_ocsp_resp_get_responder (gnutls_ocsp_resp_t
RESP, gnutls_datum_t * DN)
RESP: should contain a 'gnutls_ocsp_resp_t' type
DN: newly allocated buffer with name
This function will extract the name of the Basic OCSP Response in
the provided buffer. The name will be in the form
"C=xxxx,O=yyyy,CN=zzzz" as described in RFC2253. The output string
will be ASCII or UTF-8 encoded, depending on the certificate data.
If the responder ID is not a name but a hash, this function will
return zero and the 'dn' elements will be set to 'NULL' .
The caller needs to deallocate memory by calling 'gnutls_free()' on
'dn' ->data.
This function does not output a fully RFC4514 compliant string, if
that is required see 'gnutls_ocsp_resp_get_responder2()' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error code is returned. When no data exist it
will return success and set 'dn' elements to zero.
gnutls_ocsp_resp_get_responder2
-------------------------------
-- Function: int gnutls_ocsp_resp_get_responder2 (gnutls_ocsp_resp_t
RESP, gnutls_datum_t * DN, unsigned FLAGS)
RESP: should contain a 'gnutls_ocsp_resp_t' type
DN: newly allocated buffer with name
FLAGS: zero or 'GNUTLS_X509_DN_FLAG_COMPAT'
This function will extract the name of the Basic OCSP Response in
the provided buffer. The name will be in the form
"C=xxxx,O=yyyy,CN=zzzz" as described in RFC2253. The output string
will be ASCII or UTF-8 encoded, depending on the certificate data.
If the responder ID is not a name but a hash, this function will
return zero and the 'dn' elements will be set to 'NULL' .
The caller needs to deallocate memory by calling 'gnutls_free()' on
'dn' ->data.
When the flag 'GNUTLS_X509_DN_FLAG_COMPAT' is specified, the output
format will match the format output by previous to 3.5.6 versions
of GnuTLS which was not not fully RFC4514-compliant.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error code is returned. When no data exist it
will return 'GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE' .
gnutls_ocsp_resp_get_responder_raw_id
-------------------------------------
-- Function: int gnutls_ocsp_resp_get_responder_raw_id
(gnutls_ocsp_resp_t RESP, unsigned TYPE, gnutls_datum_t * RAW)
RESP: should contain a 'gnutls_ocsp_resp_t' type
TYPE: should be 'GNUTLS_OCSP_RESP_ID_KEY' or
'GNUTLS_OCSP_RESP_ID_DN'
RAW: newly allocated buffer with the raw ID
This function will extract the raw key (or DN) ID of the Basic OCSP
Response in the provided buffer. If the responder ID is not a key
ID then this function will return
'GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE' .
The caller needs to deallocate memory by calling 'gnutls_free()' on
'dn' ->data.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error code is returned.
gnutls_ocsp_resp_get_response
-----------------------------
-- Function: int gnutls_ocsp_resp_get_response (gnutls_ocsp_resp_t
RESP, gnutls_datum_t * RESPONSE_TYPE_OID, gnutls_datum_t *
RESPONSE)
RESP: should contain a 'gnutls_ocsp_resp_t' type
RESPONSE_TYPE_OID: newly allocated output buffer with response type
OID
RESPONSE: newly allocated output buffer with DER encoded response
This function will extract the response type OID in and the
response data from an OCSP response. Normally the
'response_type_oid' is always "1.3.6.1.5.5.7.48.1.1" which means
the 'response' should be decoded as a Basic OCSP Response, but
technically other response types could be used.
This function is typically only useful when you want to extract the
response type OID of an response for diagnostic purposes.
Otherwise 'gnutls_ocsp_resp_import()' will decode the basic OCSP
response part and the caller need not worry about that aspect.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_ocsp_resp_get_signature
------------------------------
-- Function: int gnutls_ocsp_resp_get_signature (gnutls_ocsp_resp_t
RESP, gnutls_datum_t * SIG)
RESP: should contain a 'gnutls_ocsp_resp_t' type
SIG: newly allocated output buffer with signature data
This function will extract the signature field of a OCSP response.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_ocsp_resp_get_signature_algorithm
----------------------------------------
-- Function: int gnutls_ocsp_resp_get_signature_algorithm
(gnutls_ocsp_resp_t RESP)
RESP: should contain a 'gnutls_ocsp_resp_t' type
This function will return a value of the 'gnutls_sign_algorithm_t'
enumeration that is the signature algorithm that has been used to
sign the OCSP response.
*Returns:* a 'gnutls_sign_algorithm_t' value, or a negative error
code on error.
gnutls_ocsp_resp_get_single
---------------------------
-- Function: int gnutls_ocsp_resp_get_single (gnutls_ocsp_resp_t RESP,
unsigned INDX, gnutls_digest_algorithm_t * DIGEST,
gnutls_datum_t * ISSUER_NAME_HASH, gnutls_datum_t *
ISSUER_KEY_HASH, gnutls_datum_t * SERIAL_NUMBER, unsigned int
* CERT_STATUS, time_t * THIS_UPDATE, time_t * NEXT_UPDATE,
time_t * REVOCATION_TIME, unsigned int * REVOCATION_REASON)
RESP: should contain a 'gnutls_ocsp_resp_t' type
INDX: Specifies response number to get. Use (0) to get the first
one.
DIGEST: output variable with 'gnutls_digest_algorithm_t' hash
algorithm
ISSUER_NAME_HASH: output buffer with hash of issuer's DN
ISSUER_KEY_HASH: output buffer with hash of issuer's public key
SERIAL_NUMBER: output buffer with serial number of certificate to
check
CERT_STATUS: a certificate status, a 'gnutls_ocsp_cert_status_t'
enum.
THIS_UPDATE: time at which the status is known to be correct.
NEXT_UPDATE: when newer information will be available, or
(time_t)-1 if unspecified
REVOCATION_TIME: when 'cert_status' is 'GNUTLS_OCSP_CERT_REVOKED' ,
holds time of revocation.
REVOCATION_REASON: revocation reason, a 'gnutls_x509_crl_reason_t'
enum.
This function will return the certificate information of the 'indx'
'ed response in the Basic OCSP Response 'resp' . The information
returned corresponds to the OCSP SingleResponse structure except
the final singleExtensions.
Each of the pointers to output variables may be NULL to indicate
that the caller is not interested in that value.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error code is returned. If you have reached
the last CertID available 'GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE'
will be returned.
gnutls_ocsp_resp_get_status
---------------------------
-- Function: int gnutls_ocsp_resp_get_status (gnutls_ocsp_resp_t RESP)
RESP: should contain a 'gnutls_ocsp_resp_t' type
This function will return the status of a OCSP response, an
'gnutls_ocsp_resp_status_t' enumeration.
*Returns:* status of OCSP request as a 'gnutls_ocsp_resp_status_t'
, or a negative error code on error.
gnutls_ocsp_resp_get_version
----------------------------
-- Function: int gnutls_ocsp_resp_get_version (gnutls_ocsp_resp_t RESP)
RESP: should contain a 'gnutls_ocsp_resp_t' type
This function will return the version of the Basic OCSP Response.
Typically this is always 1 indicating version 1.
*Returns:* version of Basic OCSP response, or a negative error code
on error.
gnutls_ocsp_resp_import
-----------------------
-- Function: int gnutls_ocsp_resp_import (gnutls_ocsp_resp_t RESP,
const gnutls_datum_t * DATA)
RESP: The data to store the parsed response.
DATA: DER encoded OCSP response.
This function will convert the given DER encoded OCSP response to
the native 'gnutls_ocsp_resp_t' format. It also decodes the Basic
OCSP Response part, if any. The output will be stored in 'resp' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_ocsp_resp_init
---------------------
-- Function: int gnutls_ocsp_resp_init (gnutls_ocsp_resp_t * RESP)
RESP: A pointer to the type to be initialized
This function will initialize an OCSP response structure.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_ocsp_resp_print
----------------------
-- Function: int gnutls_ocsp_resp_print (gnutls_ocsp_resp_t RESP,
gnutls_ocsp_print_formats_t FORMAT, gnutls_datum_t * OUT)
RESP: The data to be printed
FORMAT: Indicate the format to use
OUT: Newly allocated datum with (0) terminated string.
This function will pretty print a OCSP response, suitable for
display to a human.
If the format is 'GNUTLS_OCSP_PRINT_FULL' then all fields of the
response will be output, on multiple lines.
The output 'out' ->data needs to be deallocate using
'gnutls_free()' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_ocsp_resp_verify
-----------------------
-- Function: int gnutls_ocsp_resp_verify (gnutls_ocsp_resp_t RESP,
gnutls_x509_trust_list_t TRUSTLIST, unsigned int * VERIFY,
unsigned int FLAGS)
RESP: should contain a 'gnutls_ocsp_resp_t' type
TRUSTLIST: trust anchors as a 'gnutls_x509_trust_list_t' type
VERIFY: output variable with verification status, an
'gnutls_ocsp_verify_reason_t'
FLAGS: verification flags from 'gnutls_certificate_verify_flags'
Verify signature of the Basic OCSP Response against the public key
in the certificate of a trusted signer. The 'trustlist' should be
populated with trust anchors. The function will extract the signer
certificate from the Basic OCSP Response and will verify it against
the 'trustlist' . A trusted signer is a certificate that is either
in 'trustlist' , or it is signed directly by a certificate in
'trustlist' and has the id-ad-ocspSigning Extended Key Usage bit
set.
The output 'verify' variable will hold verification status codes
(e.g., 'GNUTLS_OCSP_VERIFY_SIGNER_NOT_FOUND' ,
'GNUTLS_OCSP_VERIFY_INSECURE_ALGORITHM' ) which are only valid if
the function returned 'GNUTLS_E_SUCCESS' .
Note that the function returns 'GNUTLS_E_SUCCESS' even when
verification failed. The caller must always inspect the 'verify'
variable to find out the verification status.
The 'flags' variable should be 0 for now.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_ocsp_resp_verify_direct
------------------------------
-- Function: int gnutls_ocsp_resp_verify_direct (gnutls_ocsp_resp_t
RESP, gnutls_x509_crt_t ISSUER, unsigned int * VERIFY,
unsigned int FLAGS)
RESP: should contain a 'gnutls_ocsp_resp_t' type
ISSUER: certificate believed to have signed the response
VERIFY: output variable with verification status, an
'gnutls_ocsp_verify_reason_t'
FLAGS: verification flags from 'gnutls_certificate_verify_flags'
Verify signature of the Basic OCSP Response against the public key
in the 'issuer' certificate.
The output 'verify' variable will hold verification status codes
(e.g., 'GNUTLS_OCSP_VERIFY_SIGNER_NOT_FOUND' ,
'GNUTLS_OCSP_VERIFY_INSECURE_ALGORITHM' ) which are only valid if
the function returned 'GNUTLS_E_SUCCESS' .
Note that the function returns 'GNUTLS_E_SUCCESS' even when
verification failed. The caller must always inspect the 'verify'
variable to find out the verification status.
The 'flags' variable should be 0 for now.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
File: gnutls.info, Node: PKCS 12 API, Next: PKCS 11 API, Prev: OCSP API, Up: API reference
E.6 PKCS 12 API
===============
The following functions are to be used for PKCS 12 handling. Their
prototypes lie in 'gnutls/pkcs12.h'.
gnutls_pkcs12_bag_decrypt
-------------------------
-- Function: int gnutls_pkcs12_bag_decrypt (gnutls_pkcs12_bag_t BAG,
const char * PASS)
BAG: The bag
PASS: The password used for encryption, must be ASCII.
This function will decrypt the given encrypted bag and return 0 on
success.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error code is returned.
gnutls_pkcs12_bag_deinit
------------------------
-- Function: void gnutls_pkcs12_bag_deinit (gnutls_pkcs12_bag_t BAG)
BAG: A pointer to the type to be initialized
This function will deinitialize a PKCS12 Bag structure.
gnutls_pkcs12_bag_enc_info
--------------------------
-- Function: int gnutls_pkcs12_bag_enc_info (gnutls_pkcs12_bag_t BAG,
unsigned int * SCHEMA, unsigned int * CIPHER, void * SALT,
unsigned int * SALT_SIZE, unsigned int * ITER_COUNT, char **
OID)
BAG: The bag
SCHEMA: indicate the schema as one of 'gnutls_pkcs_encrypt_flags_t'
CIPHER: the cipher used as 'gnutls_cipher_algorithm_t'
SALT: PBKDF2 salt (if non-NULL then 'salt_size' initially holds its
size)
SALT_SIZE: PBKDF2 salt size
ITER_COUNT: PBKDF2 iteration count
OID: if non-NULL it will contain an allocated null-terminated
variable with the OID
This function will provide information on the encryption algorithms
used in an encrypted bag. If the structure algorithms are unknown
the code 'GNUTLS_E_UNKNOWN_CIPHER_TYPE' will be returned, and only
'oid' , will be set. That is, 'oid' will be set on encrypted bags
whether supported or not. It must be deinitialized using
'gnutls_free()' . The other variables are only set on supported
structures.
*Returns:* 'GNUTLS_E_INVALID_REQUEST' if the provided bag isn't
encrypted, 'GNUTLS_E_UNKNOWN_CIPHER_TYPE' if the structure's
encryption isn't supported, or another negative error code in case
of a failure. Zero on success.
gnutls_pkcs12_bag_encrypt
-------------------------
-- Function: int gnutls_pkcs12_bag_encrypt (gnutls_pkcs12_bag_t BAG,
const char * PASS, unsigned int FLAGS)
BAG: The bag
PASS: The password used for encryption, must be ASCII
FLAGS: should be one of 'gnutls_pkcs_encrypt_flags_t' elements
bitwise or'd
This function will encrypt the given bag.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error code is returned.
gnutls_pkcs12_bag_get_count
---------------------------
-- Function: int gnutls_pkcs12_bag_get_count (gnutls_pkcs12_bag_t BAG)
BAG: The bag
This function will return the number of the elements within the
bag.
*Returns:* Number of elements in bag, or an negative error code on
error.
gnutls_pkcs12_bag_get_data
--------------------------
-- Function: int gnutls_pkcs12_bag_get_data (gnutls_pkcs12_bag_t BAG,
unsigned INDX, gnutls_datum_t * DATA)
BAG: The bag
INDX: The element of the bag to get the data from
DATA: where the bag's data will be. Should be treated as constant.
This function will return the bag's data. The data is a constant
that is stored into the bag. Should not be accessed after the bag
is deleted.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs12_bag_get_friendly_name
-----------------------------------
-- Function: int gnutls_pkcs12_bag_get_friendly_name
(gnutls_pkcs12_bag_t BAG, unsigned INDX, char ** NAME)
BAG: The bag
INDX: The bag's element to add the id
NAME: will hold a pointer to the name (to be treated as const)
This function will return the friendly name, of the specified bag
element. The key ID is usually used to distinguish the local
private key and the certificate pair.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value. or a negative error code on
error.
gnutls_pkcs12_bag_get_key_id
----------------------------
-- Function: int gnutls_pkcs12_bag_get_key_id (gnutls_pkcs12_bag_t BAG,
unsigned INDX, gnutls_datum_t * ID)
BAG: The bag
INDX: The bag's element to add the id
ID: where the ID will be copied (to be treated as const)
This function will return the key ID, of the specified bag element.
The key ID is usually used to distinguish the local private key and
the certificate pair.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value. or a negative error code on
error.
gnutls_pkcs12_bag_get_type
--------------------------
-- Function: int gnutls_pkcs12_bag_get_type (gnutls_pkcs12_bag_t BAG,
unsigned INDX)
BAG: The bag
INDX: The element of the bag to get the type
This function will return the bag's type.
*Returns:* On error a negative error value or one of the
'gnutls_pkcs12_bag_type_t' enumerations.
gnutls_pkcs12_bag_init
----------------------
-- Function: int gnutls_pkcs12_bag_init (gnutls_pkcs12_bag_t * BAG)
BAG: A pointer to the type to be initialized
This function will initialize a PKCS12 bag structure. PKCS12 Bags
usually contain private keys, lists of X.509 Certificates and X.509
Certificate revocation lists.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs12_bag_set_crl
-------------------------
-- Function: int gnutls_pkcs12_bag_set_crl (gnutls_pkcs12_bag_t BAG,
gnutls_x509_crl_t CRL)
BAG: The bag
CRL: the CRL to be copied.
This function will insert the given CRL into the bag. This is just
a wrapper over 'gnutls_pkcs12_bag_set_data()' .
*Returns:* the index of the added bag on success, or a negative
error code on failure.
gnutls_pkcs12_bag_set_crt
-------------------------
-- Function: int gnutls_pkcs12_bag_set_crt (gnutls_pkcs12_bag_t BAG,
gnutls_x509_crt_t CRT)
BAG: The bag
CRT: the certificate to be copied.
This function will insert the given certificate into the bag. This
is just a wrapper over 'gnutls_pkcs12_bag_set_data()' .
*Returns:* the index of the added bag on success, or a negative
value on failure.
gnutls_pkcs12_bag_set_data
--------------------------
-- Function: int gnutls_pkcs12_bag_set_data (gnutls_pkcs12_bag_t BAG,
gnutls_pkcs12_bag_type_t TYPE, const gnutls_datum_t * DATA)
BAG: The bag
TYPE: The data's type
DATA: the data to be copied.
This function will insert the given data of the given type into the
bag.
*Returns:* the index of the added bag on success, or a negative
value on error.
gnutls_pkcs12_bag_set_friendly_name
-----------------------------------
-- Function: int gnutls_pkcs12_bag_set_friendly_name
(gnutls_pkcs12_bag_t BAG, unsigned INDX, const char * NAME)
BAG: The bag
INDX: The bag's element to add the id
NAME: the name
This function will add the given key friendly name, to the
specified, by the index, bag element. The name will be encoded as
a 'Friendly name' bag attribute, which is usually used to set a
user name to the local private key and the certificate pair.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value. or a negative error code on
error.
gnutls_pkcs12_bag_set_key_id
----------------------------
-- Function: int gnutls_pkcs12_bag_set_key_id (gnutls_pkcs12_bag_t BAG,
unsigned INDX, const gnutls_datum_t * ID)
BAG: The bag
INDX: The bag's element to add the id
ID: the ID
This function will add the given key ID, to the specified, by the
index, bag element. The key ID will be encoded as a 'Local key
identifier' bag attribute, which is usually used to distinguish the
local private key and the certificate pair.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value. or a negative error code on
error.
gnutls_pkcs12_bag_set_privkey
-----------------------------
-- Function: int gnutls_pkcs12_bag_set_privkey (gnutls_pkcs12_bag_t
BAG, gnutls_x509_privkey_t PRIVKEY, const char * PASSWORD,
unsigned FLAGS)
BAG: The bag
PRIVKEY: the private key to be copied.
PASSWORD: the password to protect the key with (may be 'NULL' )
FLAGS: should be one of 'gnutls_pkcs_encrypt_flags_t' elements
bitwise or'd
This function will insert the given private key into the bag. This
is just a wrapper over 'gnutls_pkcs12_bag_set_data()' .
*Returns:* the index of the added bag on success, or a negative
value on failure.
gnutls_pkcs12_deinit
--------------------
-- Function: void gnutls_pkcs12_deinit (gnutls_pkcs12_t PKCS12)
PKCS12: The type to be initialized
This function will deinitialize a PKCS12 type.
gnutls_pkcs12_export
--------------------
-- Function: int gnutls_pkcs12_export (gnutls_pkcs12_t PKCS12,
gnutls_x509_crt_fmt_t FORMAT, void * OUTPUT_DATA, size_t *
OUTPUT_DATA_SIZE)
PKCS12: A pkcs12 type
FORMAT: the format of output params. One of PEM or DER.
OUTPUT_DATA: will contain a structure PEM or DER encoded
OUTPUT_DATA_SIZE: holds the size of output_data (and will be
replaced by the actual size of parameters)
This function will export the pkcs12 structure to DER or PEM
format.
If the buffer provided is not long enough to hold the output, then
*output_data_size will be updated and GNUTLS_E_SHORT_MEMORY_BUFFER
will be returned.
If the structure is PEM encoded, it will have a header of "BEGIN
PKCS12".
*Returns:* In case of failure a negative error code will be
returned, and 0 on success.
gnutls_pkcs12_export2
---------------------
-- Function: int gnutls_pkcs12_export2 (gnutls_pkcs12_t PKCS12,
gnutls_x509_crt_fmt_t FORMAT, gnutls_datum_t * OUT)
PKCS12: A pkcs12 type
FORMAT: the format of output params. One of PEM or DER.
OUT: will contain a structure PEM or DER encoded
This function will export the pkcs12 structure to DER or PEM
format.
The output buffer is allocated using 'gnutls_malloc()' .
If the structure is PEM encoded, it will have a header of "BEGIN
PKCS12".
*Returns:* In case of failure a negative error code will be
returned, and 0 on success.
*Since:* 3.1.3
gnutls_pkcs12_generate_mac
--------------------------
-- Function: int gnutls_pkcs12_generate_mac (gnutls_pkcs12_t PKCS12,
const char * PASS)
PKCS12: A pkcs12 type
PASS: The password for the MAC
This function will generate a MAC for the PKCS12 structure.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs12_generate_mac2
---------------------------
-- Function: int gnutls_pkcs12_generate_mac2 (gnutls_pkcs12_t PKCS12,
gnutls_mac_algorithm_t MAC, const char * PASS)
PKCS12: A pkcs12 type
MAC: the MAC algorithm to use
PASS: The password for the MAC
This function will generate a MAC for the PKCS12 structure.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs12_get_bag
---------------------
-- Function: int gnutls_pkcs12_get_bag (gnutls_pkcs12_t PKCS12, int
INDX, gnutls_pkcs12_bag_t BAG)
PKCS12: A pkcs12 type
INDX: contains the index of the bag to extract
BAG: An initialized bag, where the contents of the bag will be
copied
This function will return a Bag from the PKCS12 structure.
After the last Bag has been read
'GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE' will be returned.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs12_import
--------------------
-- Function: int gnutls_pkcs12_import (gnutls_pkcs12_t PKCS12, const
gnutls_datum_t * DATA, gnutls_x509_crt_fmt_t FORMAT, unsigned
int FLAGS)
PKCS12: The data to store the parsed PKCS12.
DATA: The DER or PEM encoded PKCS12.
FORMAT: One of DER or PEM
FLAGS: an ORed sequence of gnutls_privkey_pkcs8_flags
This function will convert the given DER or PEM encoded PKCS12 to
the native gnutls_pkcs12_t format. The output will be stored in
'pkcs12'.
If the PKCS12 is PEM encoded it should have a header of "PKCS12".
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs12_init
------------------
-- Function: int gnutls_pkcs12_init (gnutls_pkcs12_t * PKCS12)
PKCS12: A pointer to the type to be initialized
This function will initialize a PKCS12 type. PKCS12 structures
usually contain lists of X.509 Certificates and X.509 Certificate
revocation lists.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs12_mac_info
----------------------
-- Function: int gnutls_pkcs12_mac_info (gnutls_pkcs12_t PKCS12,
unsigned int * MAC, void * SALT, unsigned int * SALT_SIZE,
unsigned int * ITER_COUNT, char ** OID)
PKCS12: A pkcs12 type
MAC: the MAC algorithm used as 'gnutls_mac_algorithm_t'
SALT: the salt used for string to key (if non-NULL then 'salt_size'
initially holds its size)
SALT_SIZE: string to key salt size
ITER_COUNT: string to key iteration count
OID: if non-NULL it will contain an allocated null-terminated
variable with the OID
This function will provide information on the MAC algorithm used in
a PKCS '12' structure. If the structure algorithms are unknown the
code 'GNUTLS_E_UNKNOWN_HASH_ALGORITHM' will be returned, and only
'oid' , will be set. That is, 'oid' will be set on structures with
a MAC whether supported or not. It must be deinitialized using
'gnutls_free()' . The other variables are only set on supported
structures.
*Returns:* 'GNUTLS_E_INVALID_REQUEST' if the provided structure
doesn't contain a MAC, 'GNUTLS_E_UNKNOWN_HASH_ALGORITHM' if the
structure's MAC isn't supported, or another negative error code in
case of a failure. Zero on success.
gnutls_pkcs12_set_bag
---------------------
-- Function: int gnutls_pkcs12_set_bag (gnutls_pkcs12_t PKCS12,
gnutls_pkcs12_bag_t BAG)
PKCS12: should contain a gnutls_pkcs12_t type
BAG: An initialized bag
This function will insert a Bag into the PKCS12 structure.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs12_simple_parse
--------------------------
-- Function: int gnutls_pkcs12_simple_parse (gnutls_pkcs12_t P12, const
char * PASSWORD, gnutls_x509_privkey_t * KEY,
gnutls_x509_crt_t ** CHAIN, unsigned int * CHAIN_LEN,
gnutls_x509_crt_t ** EXTRA_CERTS, unsigned int *
EXTRA_CERTS_LEN, gnutls_x509_crl_t * CRL, unsigned int FLAGS)
P12: A pkcs12 type
PASSWORD: optional password used to decrypt the structure, bags and
keys.
KEY: a structure to store the parsed private key.
CHAIN: the corresponding to key certificate chain (may be 'NULL' )
CHAIN_LEN: will be updated with the number of additional (may be
'NULL' )
EXTRA_CERTS: optional pointer to receive an array of additional
certificates found in the PKCS12 structure (may be 'NULL' ).
EXTRA_CERTS_LEN: will be updated with the number of additional
certs (may be 'NULL' ).
CRL: an optional structure to store the parsed CRL (may be 'NULL'
).
FLAGS: should be zero or one of GNUTLS_PKCS12_SP_*
This function parses a PKCS12 structure in 'pkcs12' and extracts
the private key, the corresponding certificate chain, any
additional certificates and a CRL. The structures in 'key' ,
'chain' 'crl' , and 'extra_certs' must not be initialized.
The 'extra_certs' and 'extra_certs_len' parameters are optional and
both may be set to 'NULL' . If either is non-'NULL' , then both
must be set. The value for 'extra_certs' is allocated using
'gnutls_malloc()' .
Encrypted PKCS12 bags and PKCS8 private keys are supported, but
only with password based security and the same password for all
operations.
Note that a PKCS12 structure may contain many keys and/or
certificates, and there is no way to identify which key/certificate
pair you want. For this reason this function is useful for PKCS12
files that contain only one key/certificate pair and/or one CRL.
If the provided structure has encrypted fields but no password is
provided then this function returns 'GNUTLS_E_DECRYPTION_FAILED' .
Note that normally the chain constructed does not include self
signed certificates, to comply with TLS' requirements. If,
however, the flag 'GNUTLS_PKCS12_SP_INCLUDE_SELF_SIGNED' is
specified then self signed certificates will be included in the
chain.
Prior to using this function the PKCS '12' structure integrity must
be verified using 'gnutls_pkcs12_verify_mac()' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.1.0
gnutls_pkcs12_verify_mac
------------------------
-- Function: int gnutls_pkcs12_verify_mac (gnutls_pkcs12_t PKCS12,
const char * PASS)
PKCS12: should contain a gnutls_pkcs12_t type
PASS: The password for the MAC
This function will verify the MAC for the PKCS12 structure.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
File: gnutls.info, Node: PKCS 11 API, Next: TPM API, Prev: PKCS 12 API, Up: API reference
E.7 Hardware token via PKCS 11 API
==================================
The following functions are to be used for PKCS 11 handling. Their
prototypes lie in 'gnutls/pkcs11.h'.
gnutls_pkcs11_add_provider
--------------------------
-- Function: int gnutls_pkcs11_add_provider (const char * NAME, const
char * PARAMS)
NAME: The filename of the module
PARAMS: should be NULL or a known string (see description)
This function will load and add a PKCS 11 module to the module list
used in gnutls. After this function is called the module will be
used for PKCS 11 operations.
When loading a module to be used for certificate verification, use
the string 'trusted' as 'params' .
Note that this function is not thread safe.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_pkcs11_copy_attached_extension
-------------------------------------
-- Function: int gnutls_pkcs11_copy_attached_extension (const char *
TOKEN_URL, gnutls_x509_crt_t CRT, gnutls_datum_t * DATA, const
char * LABEL, unsigned int FLAGS)
TOKEN_URL: A PKCS '11' URL specifying a token
CRT: An X.509 certificate object
DATA: the attached extension
LABEL: A name to be used for the attached extension (may be 'NULL'
)
FLAGS: One of GNUTLS_PKCS11_OBJ_FLAG_*
This function will copy an the attached extension in 'data' for the
certificate provided in 'crt' in the PKCS '11' token specified by
the URL (typically a trust module). The extension must be in
RFC5280 Extension format.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.3.8
gnutls_pkcs11_copy_pubkey
-------------------------
-- Function: int gnutls_pkcs11_copy_pubkey (const char * TOKEN_URL,
gnutls_pubkey_t PUBKEY, const char * LABEL, const
gnutls_datum_t * CID, unsigned int KEY_USAGE, unsigned int
FLAGS)
TOKEN_URL: A PKCS '11' URL specifying a token
PUBKEY: The public key to copy
LABEL: The name to be used for the stored data
CID: The CKA_ID to set for the object -if NULL, the ID will be
derived from the public key
KEY_USAGE: One of GNUTLS_KEY_*
FLAGS: One of GNUTLS_PKCS11_OBJ_FLAG_*
This function will copy a public key object into a PKCS '11' token
specified by a URL. Valid flags to mark the key:
'GNUTLS_PKCS11_OBJ_FLAG_MARK_TRUSTED' ,
'GNUTLS_PKCS11_OBJ_FLAG_MARK_SENSITIVE' ,
'GNUTLS_PKCS11_OBJ_FLAG_MARK_PRIVATE' ,
'GNUTLS_PKCS11_OBJ_FLAG_MARK_CA' ,
'GNUTLS_PKCS11_OBJ_FLAG_MARK_ALWAYS_AUTH' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.4.6
gnutls_pkcs11_copy_secret_key
-----------------------------
-- Function: int gnutls_pkcs11_copy_secret_key (const char * TOKEN_URL,
gnutls_datum_t * KEY, const char * LABEL, unsigned int
KEY_USAGE, unsigned int FLAGS)
TOKEN_URL: A PKCS '11' URL specifying a token
KEY: The raw key
LABEL: A name to be used for the stored data
KEY_USAGE: One of GNUTLS_KEY_*
FLAGS: One of GNUTLS_PKCS11_OBJ_FLAG_*
This function will copy a raw secret (symmetric) key into a PKCS
'11' token specified by a URL. The key can be marked as sensitive
or not.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_pkcs11_copy_x509_crt
---------------------------
-- Function: int gnutls_pkcs11_copy_x509_crt (const char * TOKEN_URL,
gnutls_x509_crt_t CRT, const char * LABEL, unsigned int FLAGS)
TOKEN_URL: A PKCS '11' URL specifying a token
CRT: A certificate
LABEL: A name to be used for the stored data
FLAGS: One of GNUTLS_PKCS11_OBJ_FLAG_*
This function will copy a certificate into a PKCS '11' token
specified by a URL. The certificate can be marked as trusted or
not.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_pkcs11_copy_x509_crt2
----------------------------
-- Function: int gnutls_pkcs11_copy_x509_crt2 (const char * TOKEN_URL,
gnutls_x509_crt_t CRT, const char * LABEL, const
gnutls_datum_t * CID, unsigned int FLAGS)
TOKEN_URL: A PKCS '11' URL specifying a token
CRT: The certificate to copy
LABEL: The name to be used for the stored data
CID: The CKA_ID to set for the object -if NULL, the ID will be
derived from the public key
FLAGS: One of GNUTLS_PKCS11_OBJ_FLAG_*
This function will copy a certificate into a PKCS '11' token
specified by a URL. Valid flags to mark the certificate:
'GNUTLS_PKCS11_OBJ_FLAG_MARK_TRUSTED' ,
'GNUTLS_PKCS11_OBJ_FLAG_MARK_SENSITIVE' ,
'GNUTLS_PKCS11_OBJ_FLAG_MARK_PRIVATE' ,
'GNUTLS_PKCS11_OBJ_FLAG_MARK_CA' ,
'GNUTLS_PKCS11_OBJ_FLAG_MARK_ALWAYS_AUTH' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.4.0
gnutls_pkcs11_copy_x509_privkey
-------------------------------
-- Function: int gnutls_pkcs11_copy_x509_privkey (const char *
TOKEN_URL, gnutls_x509_privkey_t KEY, const char * LABEL,
unsigned int KEY_USAGE, unsigned int FLAGS)
TOKEN_URL: A PKCS '11' URL specifying a token
KEY: A private key
LABEL: A name to be used for the stored data
KEY_USAGE: One of GNUTLS_KEY_*
FLAGS: One of GNUTLS_PKCS11_OBJ_* flags
This function will copy a private key into a PKCS '11' token
specified by a URL. It is highly recommended flags to contain
'GNUTLS_PKCS11_OBJ_FLAG_MARK_SENSITIVE' unless there is a strong
reason not to.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_pkcs11_copy_x509_privkey2
--------------------------------
-- Function: int gnutls_pkcs11_copy_x509_privkey2 (const char *
TOKEN_URL, gnutls_x509_privkey_t KEY, const char * LABEL,
const gnutls_datum_t * CID, unsigned int KEY_USAGE, unsigned
int FLAGS)
TOKEN_URL: A PKCS '11' URL specifying a token
KEY: A private key
LABEL: A name to be used for the stored data
CID: The CKA_ID to set for the object -if NULL, the ID will be
derived from the public key
KEY_USAGE: One of GNUTLS_KEY_*
FLAGS: One of GNUTLS_PKCS11_OBJ_* flags
This function will copy a private key into a PKCS '11' token
specified by a URL. It is highly recommended flags to contain
'GNUTLS_PKCS11_OBJ_FLAG_MARK_SENSITIVE' unless there is a strong
reason not to.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.4.0
gnutls_pkcs11_crt_is_known
--------------------------
-- Function: unsigned gnutls_pkcs11_crt_is_known (const char * URL,
gnutls_x509_crt_t CERT, unsigned int FLAGS)
URL: A PKCS 11 url identifying a token
CERT: is the certificate to find issuer for
FLAGS: Use zero or flags from 'GNUTLS_PKCS11_OBJ_FLAG' .
This function will check whether the provided certificate is stored
in the specified token. This is useful in combination with
'GNUTLS_PKCS11_OBJ_FLAG_RETRIEVE_TRUSTED' or
'GNUTLS_PKCS11_OBJ_FLAG_RETRIEVE_DISTRUSTED' , to check whether a
CA is present or a certificate is blacklisted in a trust PKCS '11'
module.
This function can be used with a 'url' of "pkcs11:", and in that
case all modules will be searched. To restrict the modules to the
marked as trusted in p11-kit use the
'GNUTLS_PKCS11_OBJ_FLAG_PRESENT_IN_TRUSTED_MODULE' flag.
Note that the flag 'GNUTLS_PKCS11_OBJ_FLAG_RETRIEVE_DISTRUSTED' is
specific to p11-kit trust modules.
*Returns:* If the certificate exists non-zero is returned,
otherwise zero.
*Since:* 3.3.0
gnutls_pkcs11_deinit
--------------------
-- Function: void gnutls_pkcs11_deinit ( VOID)
This function will deinitialize the PKCS 11 subsystem in gnutls.
This function is only needed if you need to deinitialize the
subsystem without calling 'gnutls_global_deinit()' .
*Since:* 2.12.0
gnutls_pkcs11_delete_url
------------------------
-- Function: int gnutls_pkcs11_delete_url (const char * OBJECT_URL,
unsigned int FLAGS)
OBJECT_URL: The URL of the object to delete.
FLAGS: One of GNUTLS_PKCS11_OBJ_* flags
This function will delete objects matching the given URL. Note that
not all tokens support the delete operation.
*Returns:* On success, the number of objects deleted is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_pkcs11_get_pin_function
------------------------------
-- Function: gnutls_pin_callback_t gnutls_pkcs11_get_pin_function (void
** USERDATA)
USERDATA: data to be supplied to callback
This function will return the callback function set using
'gnutls_pkcs11_set_pin_function()' .
*Returns:* The function set or NULL otherwise.
*Since:* 3.1.0
gnutls_pkcs11_get_raw_issuer
----------------------------
-- Function: int gnutls_pkcs11_get_raw_issuer (const char * URL,
gnutls_x509_crt_t CERT, gnutls_datum_t * ISSUER,
gnutls_x509_crt_fmt_t FMT, unsigned int FLAGS)
URL: A PKCS 11 url identifying a token
CERT: is the certificate to find issuer for
ISSUER: Will hold the issuer if any in an allocated buffer.
FMT: The format of the exported issuer.
FLAGS: Use zero or flags from 'GNUTLS_PKCS11_OBJ_FLAG' .
This function will return the issuer of a given certificate, if it
is stored in the token. By default only marked as trusted issuers
are retuned. If any issuer should be returned specify
'GNUTLS_PKCS11_OBJ_FLAG_RETRIEVE_ANY' in 'flags' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.2.7
gnutls_pkcs11_get_raw_issuer_by_dn
----------------------------------
-- Function: int gnutls_pkcs11_get_raw_issuer_by_dn (const char * URL,
const gnutls_datum_t * DN, gnutls_datum_t * ISSUER,
gnutls_x509_crt_fmt_t FMT, unsigned int FLAGS)
URL: A PKCS 11 url identifying a token
DN: is the DN to search for
ISSUER: Will hold the issuer if any in an allocated buffer.
FMT: The format of the exported issuer.
FLAGS: Use zero or flags from 'GNUTLS_PKCS11_OBJ_FLAG' .
This function will return the certificate with the given DN, if it
is stored in the token. By default only marked as trusted issuers
are retuned. If any issuer should be returned specify
'GNUTLS_PKCS11_OBJ_FLAG_RETRIEVE_ANY' in 'flags' .
The name of the function includes issuer because it can be used to
discover issuers of certificates.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.4.0
gnutls_pkcs11_get_raw_issuer_by_subject_key_id
----------------------------------------------
-- Function: int gnutls_pkcs11_get_raw_issuer_by_subject_key_id (const
char * URL, const gnutls_datum_t * DN, const gnutls_datum_t *
SPKI, gnutls_datum_t * ISSUER, gnutls_x509_crt_fmt_t FMT,
unsigned int FLAGS)
URL: A PKCS 11 url identifying a token
DN: is the DN to search for (may be 'NULL' )
SPKI: is the subject key ID to search for
ISSUER: Will hold the issuer if any in an allocated buffer.
FMT: The format of the exported issuer.
FLAGS: Use zero or flags from 'GNUTLS_PKCS11_OBJ_FLAG' .
This function will return the certificate with the given DN and
'spki' , if it is stored in the token. By default only marked as
trusted issuers are retuned. If any issuer should be returned
specify 'GNUTLS_PKCS11_OBJ_FLAG_RETRIEVE_ANY' in 'flags' .
The name of the function includes issuer because it can be used to
discover issuers of certificates.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.4.2
gnutls_pkcs11_init
------------------
-- Function: int gnutls_pkcs11_init (unsigned int FLAGS, const char *
DEPRECATED_CONFIG_FILE)
FLAGS: An ORed sequence of 'GNUTLS_PKCS11_FLAG_' *
DEPRECATED_CONFIG_FILE: either NULL or the location of a deprecated
configuration file
This function will initialize the PKCS 11 subsystem in gnutls. It
will read configuration files if 'GNUTLS_PKCS11_FLAG_AUTO' is used
or allow you to independently load PKCS 11 modules using
'gnutls_pkcs11_add_provider()' if 'GNUTLS_PKCS11_FLAG_MANUAL' is
specified.
You don't need to call this function since GnuTLS 3.3.0 because it
is being called during the first request PKCS 11 operation. That
call will assume the 'GNUTLS_PKCS11_FLAG_AUTO' flag. If another
flags are required then it must be called independently prior to
any PKCS 11 operation.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_pkcs11_obj_deinit
------------------------
-- Function: void gnutls_pkcs11_obj_deinit (gnutls_pkcs11_obj_t OBJ)
OBJ: The type to be deinitialized
This function will deinitialize a certificate structure.
*Since:* 2.12.0
gnutls_pkcs11_obj_export
------------------------
-- Function: int gnutls_pkcs11_obj_export (gnutls_pkcs11_obj_t OBJ,
void * OUTPUT_DATA, size_t * OUTPUT_DATA_SIZE)
OBJ: Holds the object
OUTPUT_DATA: will contain the object data
OUTPUT_DATA_SIZE: holds the size of output_data (and will be
replaced by the actual size of parameters)
This function will export the PKCS11 object data. It is normal for
data to be inaccesible and in that case 'GNUTLS_E_INVALID_REQUEST'
will be returned.
If the buffer provided is not long enough to hold the output, then
*output_data_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will
be returned.
*Returns:* In case of failure a negative error code will be
returned, and 'GNUTLS_E_SUCCESS' (0) on success.
*Since:* 2.12.0
gnutls_pkcs11_obj_export2
-------------------------
-- Function: int gnutls_pkcs11_obj_export2 (gnutls_pkcs11_obj_t OBJ,
gnutls_datum_t * OUT)
OBJ: Holds the object
OUT: will contain the object data
This function will export the PKCS11 object data. It is normal for
data to be inaccesible and in that case 'GNUTLS_E_INVALID_REQUEST'
will be returned.
The output buffer is allocated using 'gnutls_malloc()' .
*Returns:* In case of failure a negative error code will be
returned, and 'GNUTLS_E_SUCCESS' (0) on success.
*Since:* 3.1.3
gnutls_pkcs11_obj_export3
-------------------------
-- Function: int gnutls_pkcs11_obj_export3 (gnutls_pkcs11_obj_t OBJ,
gnutls_x509_crt_fmt_t FMT, gnutls_datum_t * OUT)
OBJ: Holds the object
FMT: The format of the exported data
OUT: will contain the object data
This function will export the PKCS11 object data. It is normal for
data to be inaccesible and in that case 'GNUTLS_E_INVALID_REQUEST'
will be returned.
The output buffer is allocated using 'gnutls_malloc()' .
*Returns:* In case of failure a negative error code will be
returned, and 'GNUTLS_E_SUCCESS' (0) on success.
*Since:* 3.2.7
gnutls_pkcs11_obj_export_url
----------------------------
-- Function: int gnutls_pkcs11_obj_export_url (gnutls_pkcs11_obj_t OBJ,
gnutls_pkcs11_url_type_t DETAILED, char ** URL)
OBJ: Holds the PKCS 11 certificate
DETAILED: non zero if a detailed URL is required
URL: will contain an allocated url
This function will export a URL identifying the given object.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_pkcs11_obj_flags_get_str
-------------------------------
-- Function: char * gnutls_pkcs11_obj_flags_get_str (unsigned int
FLAGS)
FLAGS: holds the flags
This function given an or-sequence of 'GNUTLS_PKCS11_OBJ_FLAG_MARK'
, will return an allocated string with its description. The string
needs to be deallocated using 'gnutls_free()' .
*Returns:* If flags is zero 'NULL' is returned, otherwise an
allocated string.
*Since:* 3.3.7
gnutls_pkcs11_obj_get_exts
--------------------------
-- Function: int gnutls_pkcs11_obj_get_exts (gnutls_pkcs11_obj_t OBJ,
gnutls_x509_ext_st ** EXTS, unsigned int * EXTS_SIZE, unsigned
int FLAGS)
OBJ: should contain a 'gnutls_pkcs11_obj_t' type
EXTS: a pointer to a 'gnutls_x509_ext_st' pointer
EXTS_SIZE: will be updated with the number of 'exts'
FLAGS: Or sequence of 'GNUTLS_PKCS11_OBJ_' * flags
This function will return information about attached extensions
that associate to the provided object (which should be a
certificate). The extensions are the attached p11-kit trust module
extensions.
Each element of 'exts' must be deinitialized using
'gnutls_x509_ext_deinit()' while 'exts' should be deallocated using
'gnutls_free()' .
*Returns:* 'GNUTLS_E_SUCCESS' (0) on success or a negative error
code on error.
*Since:* 3.3.8
gnutls_pkcs11_obj_get_flags
---------------------------
-- Function: int gnutls_pkcs11_obj_get_flags (gnutls_pkcs11_obj_t OBJ,
unsigned int * OFLAGS)
OBJ: The pkcs11 object
OFLAGS: Will hold the output flags
This function will return the flags of the object. The 'oflags'
will be flags from 'gnutls_pkcs11_obj_flags' . That is, the
'GNUTLS_PKCS11_OBJ_FLAG_MARK_' * flags.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.3.7
gnutls_pkcs11_obj_get_info
--------------------------
-- Function: int gnutls_pkcs11_obj_get_info (gnutls_pkcs11_obj_t OBJ,
gnutls_pkcs11_obj_info_t ITYPE, void * OUTPUT, size_t *
OUTPUT_SIZE)
OBJ: should contain a 'gnutls_pkcs11_obj_t' type
ITYPE: Denotes the type of information requested
OUTPUT: where output will be stored
OUTPUT_SIZE: contains the maximum size of the output and will be
overwritten with actual
This function will return information about the PKCS11 certificate
such as the label, id as well as token information where the key is
stored. When output is text it returns null terminated string
although 'output_size' contains the size of the actual data only.
In versions previously to 3.6.0 this function included the null
terminator to 'output_size' . After 3.6.0 the output size doesn't
include the terminator character.
*Returns:* 'GNUTLS_E_SUCCESS' (0) on success or a negative error
code on error.
*Since:* 2.12.0
gnutls_pkcs11_obj_get_type
--------------------------
-- Function: gnutls_pkcs11_obj_type_t gnutls_pkcs11_obj_get_type
(gnutls_pkcs11_obj_t OBJ)
OBJ: Holds the PKCS 11 object
This function will return the type of the object being stored in
the structure.
*Returns:* The type of the object
*Since:* 2.12.0
gnutls_pkcs11_obj_import_url
----------------------------
-- Function: int gnutls_pkcs11_obj_import_url (gnutls_pkcs11_obj_t OBJ,
const char * URL, unsigned int FLAGS)
OBJ: The structure to store the object
URL: a PKCS 11 url identifying the key
FLAGS: Or sequence of GNUTLS_PKCS11_OBJ_* flags
This function will "import" a PKCS 11 URL identifying an object
(e.g. certificate) to the 'gnutls_pkcs11_obj_t' type. This does
not involve any parsing (such as X.509 or OpenPGP) since the
'gnutls_pkcs11_obj_t' is format agnostic. Only data are
transferred.
If the flag 'GNUTLS_PKCS11_OBJ_FLAG_OVERWRITE_TRUSTMOD_EXT' is
specified any certificate read, will have its extensions
overwritten by any stapled extensions in the trust module.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_pkcs11_obj_init
----------------------
-- Function: int gnutls_pkcs11_obj_init (gnutls_pkcs11_obj_t * OBJ)
OBJ: A pointer to the type to be initialized
This function will initialize a pkcs11 certificate structure.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_pkcs11_obj_list_import_url3
----------------------------------
-- Function: int gnutls_pkcs11_obj_list_import_url3
(gnutls_pkcs11_obj_t * P_LIST, unsigned int * N_LIST, const
char * URL, unsigned int FLAGS)
P_LIST: An uninitialized object list (may be 'NULL' )
N_LIST: Initially should hold the maximum size of the list. Will
contain the actual size.
URL: A PKCS 11 url identifying a set of objects
FLAGS: Or sequence of GNUTLS_PKCS11_OBJ_* flags
This function will initialize and set values to an object list by
using all objects identified by a PKCS 11 URL.
This function will enumerate all the objects specified by the
PKCS'11' URL provided. It expects an already allocated 'p_list'
which has * 'n_list' elements, and that value will be updated to
the actual number of present objects. The 'p_list' objects will be
initialized and set by this function. To obtain a list of all
available objects use a 'url' of 'pkcs11:'.
All returned objects must be deinitialized using
'gnutls_pkcs11_obj_deinit()' .
The supported in this function 'flags' are
'GNUTLS_PKCS11_OBJ_FLAG_LOGIN' , 'GNUTLS_PKCS11_OBJ_FLAG_LOGIN_SO'
, 'GNUTLS_PKCS11_OBJ_FLAG_PRESENT_IN_TRUSTED_MODULE' ,
'GNUTLS_PKCS11_OBJ_FLAG_CRT' , 'GNUTLS_PKCS11_OBJ_FLAG_PUBKEY' ,
'GNUTLS_PKCS11_OBJ_FLAG_PRIVKEY' ,
'GNUTLS_PKCS11_OBJ_FLAG_WITH_PRIVKEY' ,
'GNUTLS_PKCS11_OBJ_FLAG_MARK_CA' ,
'GNUTLS_PKCS11_OBJ_FLAG_MARK_TRUSTED' , and since 3.5.1 the
'GNUTLS_PKCS11_OBJ_FLAG_OVERWRITE_TRUSTMOD_EXT' .
On versions of GnuTLS prior to 3.4.0 the equivalent function was
'gnutls_pkcs11_obj_list_import_url()' . That is also available on
this version as a macro which maps to this function.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.4.0
gnutls_pkcs11_obj_list_import_url4
----------------------------------
-- Function: int gnutls_pkcs11_obj_list_import_url4
(gnutls_pkcs11_obj_t ** P_LIST, unsigned int * N_LIST, const
char * URL, unsigned int FLAGS)
P_LIST: An uninitialized object list (may be NULL)
N_LIST: It will contain the size of the list.
URL: A PKCS 11 url identifying a set of objects
FLAGS: Or sequence of GNUTLS_PKCS11_OBJ_* flags
This function will enumerate all the objects specified by the
PKCS'11' URL provided. It will initialize and set values to the
object pointer list ( 'p_list' ) provided. To obtain a list of all
available objects use a 'url' of 'pkcs11:'.
All returned objects must be deinitialized using
'gnutls_pkcs11_obj_deinit()' , and 'p_list' must be deinitialized
using 'gnutls_free()' .
The supported in this function 'flags' are
'GNUTLS_PKCS11_OBJ_FLAG_LOGIN' , 'GNUTLS_PKCS11_OBJ_FLAG_LOGIN_SO'
, 'GNUTLS_PKCS11_OBJ_FLAG_PRESENT_IN_TRUSTED_MODULE' ,
'GNUTLS_PKCS11_OBJ_FLAG_CRT' , 'GNUTLS_PKCS11_OBJ_FLAG_PUBKEY' ,
'GNUTLS_PKCS11_OBJ_FLAG_PRIVKEY' ,
'GNUTLS_PKCS11_OBJ_FLAG_WITH_PRIVKEY' ,
'GNUTLS_PKCS11_OBJ_FLAG_MARK_CA' ,
'GNUTLS_PKCS11_OBJ_FLAG_MARK_TRUSTED' , and since 3.5.1 the
'GNUTLS_PKCS11_OBJ_FLAG_OVERWRITE_TRUSTMOD_EXT' .
On versions of GnuTLS prior to 3.4.0 the equivalent function was
'gnutls_pkcs11_obj_list_import_url2()' . That is also available on
this version as a macro which maps to this function.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.4.0
gnutls_pkcs11_obj_set_info
--------------------------
-- Function: int gnutls_pkcs11_obj_set_info (gnutls_pkcs11_obj_t OBJ,
gnutls_pkcs11_obj_info_t ITYPE, const void * DATA, size_t
DATA_SIZE, unsigned FLAGS)
OBJ: should contain a 'gnutls_pkcs11_obj_t' type
ITYPE: Denotes the type of information to be set
DATA: the data to set
DATA_SIZE: the size of data
FLAGS: Or sequence of GNUTLS_PKCS11_OBJ_* flags
This function will set attributes on the provided object.
Available options for 'itype' are 'GNUTLS_PKCS11_OBJ_LABEL' ,
'GNUTLS_PKCS11_OBJ_ID_HEX' , and 'GNUTLS_PKCS11_OBJ_ID' .
*Returns:* 'GNUTLS_E_SUCCESS' (0) on success or a negative error
code on error.
*Since:* 3.4.0
gnutls_pkcs11_obj_set_pin_function
----------------------------------
-- Function: void gnutls_pkcs11_obj_set_pin_function
(gnutls_pkcs11_obj_t OBJ, gnutls_pin_callback_t FN, void *
USERDATA)
OBJ: The object structure
FN: the callback
USERDATA: data associated with the callback
This function will set a callback function to be used when required
to access the object. This function overrides the global set using
'gnutls_pkcs11_set_pin_function()' .
*Since:* 3.1.0
gnutls_pkcs11_privkey_cpy
-------------------------
-- Function: int gnutls_pkcs11_privkey_cpy (gnutls_pkcs11_privkey_t
DST, gnutls_pkcs11_privkey_t SRC)
DST: The destination key, which should be initialized.
SRC: The source key
This function will copy a private key from source to destination
key. Destination has to be initialized.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.4.0
gnutls_pkcs11_privkey_deinit
----------------------------
-- Function: void gnutls_pkcs11_privkey_deinit (gnutls_pkcs11_privkey_t
KEY)
KEY: the key to be deinitialized
This function will deinitialize a private key structure.
gnutls_pkcs11_privkey_export_pubkey
-----------------------------------
-- Function: int gnutls_pkcs11_privkey_export_pubkey
(gnutls_pkcs11_privkey_t PKEY, gnutls_x509_crt_fmt_t FMT,
gnutls_datum_t * DATA, unsigned int FLAGS)
PKEY: The private key
FMT: the format of output params. PEM or DER.
DATA: will hold the public key
FLAGS: should be zero
This function will extract the public key (modulus and public
exponent) from the private key specified by the 'url' private key.
This public key will be stored in 'pubkey' in the format specified
by 'fmt' . 'pubkey' should be deinitialized using 'gnutls_free()'
.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.3.7
gnutls_pkcs11_privkey_export_url
--------------------------------
-- Function: int gnutls_pkcs11_privkey_export_url
(gnutls_pkcs11_privkey_t KEY, gnutls_pkcs11_url_type_t
DETAILED, char ** URL)
KEY: Holds the PKCS 11 key
DETAILED: non zero if a detailed URL is required
URL: will contain an allocated url
This function will export a URL identifying the given key.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs11_privkey_generate
------------------------------
-- Function: int gnutls_pkcs11_privkey_generate (const char * URL,
gnutls_pk_algorithm_t PK, unsigned int BITS, const char *
LABEL, unsigned int FLAGS)
URL: a token URL
PK: the public key algorithm
BITS: the security bits
LABEL: a label
FLAGS: should be zero
This function will generate a private key in the specified by the
'url' token. The private key will be generate within the token and
will not be exportable.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.0
gnutls_pkcs11_privkey_generate2
-------------------------------
-- Function: int gnutls_pkcs11_privkey_generate2 (const char * URL,
gnutls_pk_algorithm_t PK, unsigned int BITS, const char *
LABEL, gnutls_x509_crt_fmt_t FMT, gnutls_datum_t * PUBKEY,
unsigned int FLAGS)
URL: a token URL
PK: the public key algorithm
BITS: the security bits
LABEL: a label
FMT: the format of output params. PEM or DER
PUBKEY: will hold the public key (may be 'NULL' )
FLAGS: zero or an OR'ed sequence of 'GNUTLS_PKCS11_OBJ_FLAGs'
This function will generate a private key in the specified by the
'url' token. The private key will be generate within the token and
will not be exportable. This function will store the DER-encoded
public key in the SubjectPublicKeyInfo format in 'pubkey' . The
'pubkey' should be deinitialized using 'gnutls_free()' .
Note that when generating an elliptic curve key, the curve can be
substituted in the place of the bits parameter using the
'GNUTLS_CURVE_TO_BITS()' macro.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.1.5
gnutls_pkcs11_privkey_generate3
-------------------------------
-- Function: int gnutls_pkcs11_privkey_generate3 (const char * URL,
gnutls_pk_algorithm_t PK, unsigned int BITS, const char *
LABEL, const gnutls_datum_t * CID, gnutls_x509_crt_fmt_t FMT,
gnutls_datum_t * PUBKEY, unsigned int KEY_USAGE, unsigned int
FLAGS)
URL: a token URL
PK: the public key algorithm
BITS: the security bits
LABEL: a label
CID: The CKA_ID to use for the new object
FMT: the format of output params. PEM or DER
PUBKEY: will hold the public key (may be 'NULL' )
KEY_USAGE: One of GNUTLS_KEY_*
FLAGS: zero or an OR'ed sequence of 'GNUTLS_PKCS11_OBJ_FLAGs'
This function will generate a private key in the specified by the
'url' token. The private key will be generate within the token and
will not be exportable. This function will store the DER-encoded
public key in the SubjectPublicKeyInfo format in 'pubkey' . The
'pubkey' should be deinitialized using 'gnutls_free()' .
Note that when generating an elliptic curve key, the curve can be
substituted in the place of the bits parameter using the
'GNUTLS_CURVE_TO_BITS()' macro.
It is highly recommended flags to contain
'GNUTLS_PKCS11_OBJ_FLAG_MARK_SENSITIVE' unless there is a strong
reason not to.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.4.0
gnutls_pkcs11_privkey_get_info
------------------------------
-- Function: int gnutls_pkcs11_privkey_get_info
(gnutls_pkcs11_privkey_t PKEY, gnutls_pkcs11_obj_info_t ITYPE,
void * OUTPUT, size_t * OUTPUT_SIZE)
PKEY: should contain a 'gnutls_pkcs11_privkey_t' type
ITYPE: Denotes the type of information requested
OUTPUT: where output will be stored
OUTPUT_SIZE: contains the maximum size of the output and will be
overwritten with actual
This function will return information about the PKCS 11 private key
such as the label, id as well as token information where the key is
stored. When output is text it returns null terminated string
although 'output_size' contains the size of the actual data only.
*Returns:* 'GNUTLS_E_SUCCESS' (0) on success or a negative error
code on error.
gnutls_pkcs11_privkey_get_pk_algorithm
--------------------------------------
-- Function: int gnutls_pkcs11_privkey_get_pk_algorithm
(gnutls_pkcs11_privkey_t KEY, unsigned int * BITS)
KEY: should contain a 'gnutls_pkcs11_privkey_t' type
BITS: if bits is non null it will hold the size of the parameters'
in bits
This function will return the public key algorithm of a private
key.
*Returns:* a member of the 'gnutls_pk_algorithm_t' enumeration on
success, or a negative error code on error.
gnutls_pkcs11_privkey_import_url
--------------------------------
-- Function: int gnutls_pkcs11_privkey_import_url
(gnutls_pkcs11_privkey_t PKEY, const char * URL, unsigned int
FLAGS)
PKEY: The private key
URL: a PKCS 11 url identifying the key
FLAGS: Or sequence of GNUTLS_PKCS11_OBJ_* flags
This function will "import" a PKCS 11 URL identifying a private key
to the 'gnutls_pkcs11_privkey_t' type. In reality since in most
cases keys cannot be exported, the private key structure is being
associated with the available operations on the token.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs11_privkey_init
--------------------------
-- Function: int gnutls_pkcs11_privkey_init (gnutls_pkcs11_privkey_t *
KEY)
KEY: A pointer to the type to be initialized
This function will initialize an private key structure. This
structure can be used for accessing an underlying PKCS'11' object.
In versions of GnuTLS later than 3.5.11 the object is protected
using locks and a single 'gnutls_pkcs11_privkey_t' can be re-used
by many threads. However, for performance it is recommended to
utilize one object per key per thread.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs11_privkey_set_pin_function
--------------------------------------
-- Function: void gnutls_pkcs11_privkey_set_pin_function
(gnutls_pkcs11_privkey_t KEY, gnutls_pin_callback_t FN, void *
USERDATA)
KEY: The private key
FN: the callback
USERDATA: data associated with the callback
This function will set a callback function to be used when required
to access the object. This function overrides the global set using
'gnutls_pkcs11_set_pin_function()' .
*Since:* 3.1.0
gnutls_pkcs11_privkey_status
----------------------------
-- Function: unsigned gnutls_pkcs11_privkey_status
(gnutls_pkcs11_privkey_t KEY)
KEY: Holds the key
Checks the status of the private key token.
*Returns:* this function will return non-zero if the token holding
the private key is still available (inserted), and zero otherwise.
*Since:* 3.1.9
gnutls_pkcs11_reinit
--------------------
-- Function: int gnutls_pkcs11_reinit ( VOID)
This function will reinitialize the PKCS 11 subsystem in gnutls.
This is required by PKCS 11 when an application uses 'fork()' .
The reinitialization function must be called on the child.
Note that since GnuTLS 3.3.0, the reinitialization of the PKCS '11'
subsystem occurs automatically after fork.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.0
gnutls_pkcs11_set_pin_function
------------------------------
-- Function: void gnutls_pkcs11_set_pin_function (gnutls_pin_callback_t
FN, void * USERDATA)
FN: The PIN callback, a 'gnutls_pin_callback_t()' function.
USERDATA: data to be supplied to callback
This function will set a callback function to be used when a PIN is
required for PKCS 11 operations. See 'gnutls_pin_callback_t()' on
how the callback should behave.
*Since:* 2.12.0
gnutls_pkcs11_set_token_function
--------------------------------
-- Function: void gnutls_pkcs11_set_token_function
(gnutls_pkcs11_token_callback_t FN, void * USERDATA)
FN: The token callback
USERDATA: data to be supplied to callback
This function will set a callback function to be used when a token
needs to be inserted to continue PKCS 11 operations.
*Since:* 2.12.0
gnutls_pkcs11_token_check_mechanism
-----------------------------------
-- Function: unsigned gnutls_pkcs11_token_check_mechanism (const char *
URL, unsigned long MECHANISM, void * PTR, unsigned PSIZE,
unsigned FLAGS)
URL: should contain a PKCS 11 URL
MECHANISM: The PKCS '11' mechanism ID
PTR: if set it should point to a CK_MECHANISM_INFO struct
PSIZE: the size of CK_MECHANISM_INFO struct (for safety)
FLAGS: must be zero
This function will return whether a mechanism is supported by the
given token. If the mechanism is supported and 'ptr' is set, it
will be updated with the token information.
*Returns:* Non-zero if the mechanism is supported or zero
otherwise.
*Since:* 3.6.0
gnutls_pkcs11_token_get_flags
-----------------------------
-- Function: int gnutls_pkcs11_token_get_flags (const char * URL,
unsigned int * FLAGS)
URL: should contain a PKCS 11 URL
FLAGS: The output flags (GNUTLS_PKCS11_TOKEN_*)
This function will return information about the PKCS 11 token
flags.
The supported flags are: 'GNUTLS_PKCS11_TOKEN_HW' and
'GNUTLS_PKCS11_TOKEN_TRUSTED' .
*Returns:* 'GNUTLS_E_SUCCESS' (0) on success or a negative error
code on error.
*Since:* 2.12.0
gnutls_pkcs11_token_get_info
----------------------------
-- Function: int gnutls_pkcs11_token_get_info (const char * URL,
gnutls_pkcs11_token_info_t TTYPE, void * OUTPUT, size_t *
OUTPUT_SIZE)
URL: should contain a PKCS 11 URL
TTYPE: Denotes the type of information requested
OUTPUT: where output will be stored
OUTPUT_SIZE: contains the maximum size of the output and will be
overwritten with actual
This function will return information about the PKCS 11 token such
as the label, id, etc.
*Returns:* 'GNUTLS_E_SUCCESS' (0) on success or a negative error
code on error.
*Since:* 2.12.0
gnutls_pkcs11_token_get_mechanism
---------------------------------
-- Function: int gnutls_pkcs11_token_get_mechanism (const char * URL,
unsigned int IDX, unsigned long * MECHANISM)
URL: should contain a PKCS 11 URL
IDX: The index of the mechanism
MECHANISM: The PKCS '11' mechanism ID
This function will return the names of the supported mechanisms by
the token. It should be called with an increasing index until it
return GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE.
*Returns:* 'GNUTLS_E_SUCCESS' (0) on success or a negative error
code on error.
*Since:* 2.12.0
gnutls_pkcs11_token_get_random
------------------------------
-- Function: int gnutls_pkcs11_token_get_random (const char *
TOKEN_URL, void * RNDDATA, size_t LEN)
TOKEN_URL: A PKCS '11' URL specifying a token
RNDDATA: A pointer to the memory area to be filled with random data
LEN: The number of bytes of randomness to request
This function will get random data from the given token. It will
store rnddata and fill the memory pointed to by rnddata with len
random bytes from the token.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs11_token_get_url
---------------------------
-- Function: int gnutls_pkcs11_token_get_url (unsigned int SEQ,
gnutls_pkcs11_url_type_t DETAILED, char ** URL)
SEQ: sequence number starting from 0
DETAILED: non zero if a detailed URL is required
URL: will contain an allocated url
This function will return the URL for each token available in
system. The url has to be released using 'gnutls_free()'
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
'GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE' if the sequence number
exceeds the available tokens, otherwise a negative error value.
*Since:* 2.12.0
gnutls_pkcs11_token_init
------------------------
-- Function: int gnutls_pkcs11_token_init (const char * TOKEN_URL,
const char * SO_PIN, const char * LABEL)
TOKEN_URL: A PKCS '11' URL specifying a token
SO_PIN: Security Officer's PIN
LABEL: A name to be used for the token
This function will initialize (format) a token. If the token is at
a factory defaults state the security officer's PIN given will be
set to be the default. Otherwise it should match the officer's
PIN.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs11_token_set_pin
---------------------------
-- Function: int gnutls_pkcs11_token_set_pin (const char * TOKEN_URL,
const char * OLDPIN, const char * NEWPIN, unsigned int FLAGS)
TOKEN_URL: A PKCS '11' URL specifying a token
OLDPIN: old user's PIN
NEWPIN: new user's PIN
FLAGS: one of 'gnutls_pin_flag_t' .
This function will modify or set a user's PIN for the given token.
If it is called to set a user pin for first time the oldpin must be
NULL.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_pkcs11_type_get_name
---------------------------
-- Function: const char * gnutls_pkcs11_type_get_name
(gnutls_pkcs11_obj_type_t TYPE)
TYPE: Holds the PKCS 11 object type, a 'gnutls_pkcs11_obj_type_t' .
This function will return a human readable description of the
PKCS11 object type 'obj' . It will return "Unknown" for unknown
types.
*Returns:* human readable string labeling the PKCS11 object type
'type' .
*Since:* 2.12.0
gnutls_x509_crt_import_pkcs11
-----------------------------
-- Function: int gnutls_x509_crt_import_pkcs11 (gnutls_x509_crt_t CRT,
gnutls_pkcs11_obj_t PKCS11_CRT)
CRT: A certificate of type 'gnutls_x509_crt_t'
PKCS11_CRT: A PKCS 11 object that contains a certificate
This function will import a PKCS 11 certificate to a
'gnutls_x509_crt_t' structure.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_x509_crt_list_import_pkcs11
----------------------------------
-- Function: int gnutls_x509_crt_list_import_pkcs11 (gnutls_x509_crt_t
* CERTS, unsigned int CERT_MAX, gnutls_pkcs11_obj_t * const
OBJS, unsigned int FLAGS)
CERTS: A list of certificates of type 'gnutls_x509_crt_t'
CERT_MAX: The maximum size of the list
OBJS: A list of PKCS 11 objects
FLAGS: 0 for now
This function will import a PKCS 11 certificate list to a list of
'gnutls_x509_crt_t' type. These must not be initialized.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
File: gnutls.info, Node: TPM API, Next: Abstract key API, Prev: PKCS 11 API, Up: API reference
E.8 TPM API
===========
The following functions are to be used for TPM handling. Their
prototypes lie in 'gnutls/tpm.h'.
gnutls_tpm_get_registered
-------------------------
-- Function: int gnutls_tpm_get_registered (gnutls_tpm_key_list_t *
LIST)
LIST: a list to store the keys
This function will get a list of stored keys in the TPM. The uuid
of those keys
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.1.0
gnutls_tpm_key_list_deinit
--------------------------
-- Function: void gnutls_tpm_key_list_deinit (gnutls_tpm_key_list_t
LIST)
LIST: a list of the keys
This function will deinitialize the list of stored keys in the TPM.
*Since:* 3.1.0
gnutls_tpm_key_list_get_url
---------------------------
-- Function: int gnutls_tpm_key_list_get_url (gnutls_tpm_key_list_t
LIST, unsigned int IDX, char ** URL, unsigned int FLAGS)
LIST: a list of the keys
IDX: The index of the key (starting from zero)
URL: The URL to be returned
FLAGS: should be zero
This function will return for each given index a URL of the
corresponding key. If the provided index is out of bounds then
'GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE' is returned.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.1.0
gnutls_tpm_privkey_delete
-------------------------
-- Function: int gnutls_tpm_privkey_delete (const char * URL, const
char * SRK_PASSWORD)
URL: the URL describing the key
SRK_PASSWORD: a password for the SRK key
This function will unregister the private key from the TPM chip.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.1.0
gnutls_tpm_privkey_generate
---------------------------
-- Function: int gnutls_tpm_privkey_generate (gnutls_pk_algorithm_t PK,
unsigned int BITS, const char * SRK_PASSWORD, const char *
KEY_PASSWORD, gnutls_tpmkey_fmt_t FORMAT,
gnutls_x509_crt_fmt_t PUB_FORMAT, gnutls_datum_t * PRIVKEY,
gnutls_datum_t * PUBKEY, unsigned int FLAGS)
PK: the public key algorithm
BITS: the security bits
SRK_PASSWORD: a password to protect the exported key (optional)
KEY_PASSWORD: the password for the TPM (optional)
FORMAT: the format of the private key
PUB_FORMAT: the format of the public key
PRIVKEY: the generated key
PUBKEY: the corresponding public key (may be null)
FLAGS: should be a list of GNUTLS_TPM_* flags
This function will generate a private key in the TPM chip. The
private key will be generated within the chip and will be exported
in a wrapped with TPM's master key form. Furthermore the wrapped
key can be protected with the provided 'password' .
Note that bits in TPM is quantized value. If the input value is
not one of the allowed values, then it will be quantized to one of
512, 1024, 2048, 4096, 8192 and 16384.
Allowed flags are:
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.1.0
File: gnutls.info, Node: Abstract key API, Next: Socket specific API, Prev: TPM API, Up: API reference
E.9 Abstract key API
====================
The following functions are to be used for abstract key handling. Their
prototypes lie in 'gnutls/abstract.h'.
gnutls_certificate_set_key
--------------------------
-- Function: int gnutls_certificate_set_key
(gnutls_certificate_credentials_t RES, const char ** NAMES,
int NAMES_SIZE, gnutls_pcert_st * PCERT_LIST, int
PCERT_LIST_SIZE, gnutls_privkey_t KEY)
RES: is a 'gnutls_certificate_credentials_t' type.
NAMES: is an array of DNS name of the certificate (NULL if none)
NAMES_SIZE: holds the size of the names list
PCERT_LIST: contains a certificate list (path) for the specified
private key
PCERT_LIST_SIZE: holds the size of the certificate list
KEY: is a 'gnutls_privkey_t' key
This function sets a certificate/private key pair in the
gnutls_certificate_credentials_t type. This function may be called
more than once, in case multiple keys/certificates exist for the
server. For clients that want to send more than their own end-
entity certificate (e.g., also an intermediate CA cert), the full
certificate chain must be provided in 'pcert_list' .
Note that the 'key' and the elements of 'pcert_list' will become
part of the credentials structure and must not be deallocated.
They will be automatically deallocated when the 'res' structure is
deinitialized.
If that function fails to load the 'res' structure is at an
undefined state, it must not be reused to load other keys or
certificates.
Note that, this function by default returns zero on success and a
negative value on error. Since 3.5.6, when the flag
'GNUTLS_CERTIFICATE_API_V2' is set using
'gnutls_certificate_set_flags()' it returns an index (greater or
equal to zero). That index can be used to other functions to refer
to the added key-pair.
*Returns:* On success this functions returns zero, and otherwise a
negative value on error (see above for modifying that behavior).
*Since:* 3.0
gnutls_certificate_set_retrieve_function2
-----------------------------------------
-- Function: void gnutls_certificate_set_retrieve_function2
(gnutls_certificate_credentials_t CRED,
gnutls_certificate_retrieve_function2 * FUNC)
CRED: is a 'gnutls_certificate_credentials_t' type.
FUNC: is the callback function
This function sets a callback to be called in order to retrieve the
certificate to be used in the handshake. The callback will take
control only if a certificate is requested by the peer.
The callback's function prototype is: int
(*callback)(gnutls_session_t, const gnutls_datum_t* req_ca_dn, int
nreqs, const gnutls_pk_algorithm_t* pk_algos, int pk_algos_length,
gnutls_pcert_st** pcert, unsigned int *pcert_length,
gnutls_privkey_t * pkey);
'req_ca_dn' is only used in X.509 certificates. Contains a list
with the CA names that the server considers trusted. This is a
hint and typically the client should send a certificate that is
signed by one of these CAs. These names, when available, are DER
encoded. To get a more meaningful value use the function
'gnutls_x509_rdn_get()' .
'pk_algos' contains a list with server's acceptable public key
algorithms. The certificate returned should support the server's
given algorithms.
'pcert' should contain a single certificate and public key or a
list of them.
'pcert_length' is the size of the previous list.
'pkey' is the private key.
If the callback function is provided then gnutls will call it, in
the handshake, after the certificate request message has been
received. All the provided by the callback values will not be
released or modified by gnutls.
In server side pk_algos and req_ca_dn are NULL.
The callback function should set the certificate list to be sent,
and return 0 on success. If no certificate was selected then the
number of certificates should be set to zero. The value (-1)
indicates error and the handshake will be terminated. If both
certificates are set in the credentials and a callback is
available, the callback takes predence.
*Since:* 3.0
gnutls_pcert_deinit
-------------------
-- Function: void gnutls_pcert_deinit (gnutls_pcert_st * PCERT)
PCERT: The structure to be deinitialized
This function will deinitialize a pcert structure.
*Since:* 3.0
gnutls_pcert_export_openpgp
---------------------------
-- Function: int gnutls_pcert_export_openpgp (gnutls_pcert_st * PCERT,
gnutls_openpgp_crt_t * CRT)
PCERT: The pcert structure.
CRT: An initialized 'gnutls_openpgp_crt_t' .
This function is no-op.
*Returns:* 'GNUTLS_E_UNIMPLEMENTED_FEATURE' .
*Since:* 3.4.0
gnutls_pcert_export_x509
------------------------
-- Function: int gnutls_pcert_export_x509 (gnutls_pcert_st * PCERT,
gnutls_x509_crt_t * CRT)
PCERT: The pcert structure.
CRT: An initialized 'gnutls_x509_crt_t' .
Converts the given 'gnutls_pcert_t' type into a 'gnutls_x509_crt_t'
. This function only works if the type of 'pcert' is
'GNUTLS_CRT_X509' . When successful, the value written to 'crt'
must be freed with 'gnutls_x509_crt_deinit()' when no longer
needed.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.4.0
gnutls_pcert_import_openpgp
---------------------------
-- Function: int gnutls_pcert_import_openpgp (gnutls_pcert_st * PCERT,
gnutls_openpgp_crt_t CRT, unsigned int FLAGS)
PCERT: The pcert structure
CRT: The raw certificate to be imported
FLAGS: zero for now
This function is no-op.
*Returns:* 'GNUTLS_E_UNIMPLEMENTED_FEATURE' .
*Since:* 3.0
gnutls_pcert_import_openpgp_raw
-------------------------------
-- Function: int gnutls_pcert_import_openpgp_raw (gnutls_pcert_st *
PCERT, const gnutls_datum_t * CERT, gnutls_openpgp_crt_fmt_t
FORMAT, gnutls_openpgp_keyid_t KEYID, unsigned int FLAGS)
PCERT: The pcert structure
CERT: The raw certificate to be imported
FORMAT: The format of the certificate
KEYID: The key ID to use (NULL for the master key)
FLAGS: zero for now
This function is no-op.
*Returns:* 'GNUTLS_E_UNIMPLEMENTED_FEATURE' .
*Since:* 3.0
gnutls_pcert_import_x509
------------------------
-- Function: int gnutls_pcert_import_x509 (gnutls_pcert_st * PCERT,
gnutls_x509_crt_t CRT, unsigned int FLAGS)
PCERT: The pcert structure
CRT: The certificate to be imported
FLAGS: zero for now
This convenience function will import the given certificate to a
'gnutls_pcert_st' structure. The structure must be deinitialized
afterwards using 'gnutls_pcert_deinit()' ;
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.0
gnutls_pcert_import_x509_list
-----------------------------
-- Function: int gnutls_pcert_import_x509_list (gnutls_pcert_st *
PCERT, gnutls_x509_crt_t * CRT, unsigned * NCRT, unsigned int
FLAGS)
PCERT: The pcert structure
CRT: The certificates to be imported
NCRT: The number of certificates
FLAGS: zero or 'GNUTLS_X509_CRT_LIST_SORT'
This convenience function will import the given certificate to a
'gnutls_pcert_st' structure. The structure must be deinitialized
afterwards using 'gnutls_pcert_deinit()' ;
In the case 'GNUTLS_X509_CRT_LIST_SORT' is specified and that
function cannot sort the list, 'GNUTLS_E_CERTIFICATE_LIST_UNSORTED'
will be returned. Currently sorting can fail if the list size
exceeds an internal constraint (16).
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.4.0
gnutls_pcert_import_x509_raw
----------------------------
-- Function: int gnutls_pcert_import_x509_raw (gnutls_pcert_st * PCERT,
const gnutls_datum_t * CERT, gnutls_x509_crt_fmt_t FORMAT,
unsigned int FLAGS)
PCERT: The pcert structure
CERT: The raw certificate to be imported
FORMAT: The format of the certificate
FLAGS: zero for now
This convenience function will import the given certificate to a
'gnutls_pcert_st' structure. The structure must be deinitialized
afterwards using 'gnutls_pcert_deinit()' ;
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.0
gnutls_pcert_list_import_x509_raw
---------------------------------
-- Function: int gnutls_pcert_list_import_x509_raw (gnutls_pcert_st *
PCERTS, unsigned int * PCERT_MAX, const gnutls_datum_t * DATA,
gnutls_x509_crt_fmt_t FORMAT, unsigned int FLAGS)
PCERTS: The structures to store the parsed certificate. Must not
be initialized.
PCERT_MAX: Initially must hold the maximum number of certs. It
will be updated with the number of certs available.
DATA: The certificates.
FORMAT: One of DER or PEM.
FLAGS: must be (0) or an OR'd sequence of
gnutls_certificate_import_flags.
This function will convert the given PEM encoded certificate list
to the native gnutls_x509_crt_t format. The output will be stored
in 'certs' . They will be automatically initialized.
If the Certificate is PEM encoded it should have a header of "X509
CERTIFICATE", or "CERTIFICATE".
*Returns:* the number of certificates read or a negative error
value.
*Since:* 3.0
gnutls_privkey_decrypt_data
---------------------------
-- Function: int gnutls_privkey_decrypt_data (gnutls_privkey_t KEY,
unsigned int FLAGS, const gnutls_datum_t * CIPHERTEXT,
gnutls_datum_t * PLAINTEXT)
KEY: Holds the key
FLAGS: zero for now
CIPHERTEXT: holds the data to be decrypted
PLAINTEXT: will contain the decrypted data, allocated with
'gnutls_malloc()'
This function will decrypt the given data using the algorithm
supported by the private key.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_privkey_deinit
---------------------
-- Function: void gnutls_privkey_deinit (gnutls_privkey_t KEY)
KEY: The key to be deinitialized
This function will deinitialize a private key structure.
*Since:* 2.12.0
gnutls_privkey_export_dsa_raw
-----------------------------
-- Function: int gnutls_privkey_export_dsa_raw (gnutls_privkey_t KEY,
gnutls_datum_t * P, gnutls_datum_t * Q, gnutls_datum_t * G,
gnutls_datum_t * Y, gnutls_datum_t * X)
KEY: Holds the public key
P: will hold the p
Q: will hold the q
G: will hold the g
Y: will hold the y
X: will hold the x
This function will export the DSA private key's parameters found in
the given structure. The new parameters will be allocated using
'gnutls_malloc()' and will be stored in the appropriate datum.
*Returns:* 'GNUTLS_E_SUCCESS' on success, otherwise a negative
error code.
*Since:* 3.3.0
gnutls_privkey_export_dsa_raw2
------------------------------
-- Function: int gnutls_privkey_export_dsa_raw2 (gnutls_privkey_t KEY,
gnutls_datum_t * P, gnutls_datum_t * Q, gnutls_datum_t * G,
gnutls_datum_t * Y, gnutls_datum_t * X, unsigned int FLAGS)
KEY: Holds the public key
P: will hold the p
Q: will hold the q
G: will hold the g
Y: will hold the y
X: will hold the x
FLAGS: flags from 'gnutls_abstract_export_flags_t'
This function will export the DSA private key's parameters found in
the given structure. The new parameters will be allocated using
'gnutls_malloc()' and will be stored in the appropriate datum.
*Returns:* 'GNUTLS_E_SUCCESS' on success, otherwise a negative
error code.
*Since:* 3.6.0
gnutls_privkey_export_ecc_raw
-----------------------------
-- Function: int gnutls_privkey_export_ecc_raw (gnutls_privkey_t KEY,
gnutls_ecc_curve_t * CURVE, gnutls_datum_t * X, gnutls_datum_t
* Y, gnutls_datum_t * K)
KEY: Holds the public key
CURVE: will hold the curve
X: will hold the x coordinate
Y: will hold the y coordinate
K: will hold the private key
This function will export the ECC private key's parameters found in
the given structure. The new parameters will be allocated using
'gnutls_malloc()' and will be stored in the appropriate datum.
*Returns:* 'GNUTLS_E_SUCCESS' on success, otherwise a negative
error code.
*Since:* 3.3.0
gnutls_privkey_export_ecc_raw2
------------------------------
-- Function: int gnutls_privkey_export_ecc_raw2 (gnutls_privkey_t KEY,
gnutls_ecc_curve_t * CURVE, gnutls_datum_t * X, gnutls_datum_t
* Y, gnutls_datum_t * K, unsigned int FLAGS)
KEY: Holds the public key
CURVE: will hold the curve
X: will hold the x coordinate
Y: will hold the y coordinate
K: will hold the private key
FLAGS: flags from 'gnutls_abstract_export_flags_t'
This function will export the ECC private key's parameters found in
the given structure. The new parameters will be allocated using
'gnutls_malloc()' and will be stored in the appropriate datum.
*Returns:* 'GNUTLS_E_SUCCESS' on success, otherwise a negative
error code.
*Since:* 3.6.0
gnutls_privkey_export_openpgp
-----------------------------
-- Function: int gnutls_privkey_export_openpgp (gnutls_privkey_t PKEY,
gnutls_openpgp_privkey_t * KEY)
PKEY: The private key
KEY: Location for the key to be exported.
This function is no-op.
*Returns:* 'GNUTLS_E_UNIMPLEMENTED_FEATURE' .
*Since:* 3.4.0
gnutls_privkey_export_pkcs11
----------------------------
-- Function: int gnutls_privkey_export_pkcs11 (gnutls_privkey_t PKEY,
gnutls_pkcs11_privkey_t * KEY)
PKEY: The private key
KEY: Location for the key to be exported.
Converts the given abstract private key to a
'gnutls_pkcs11_privkey_t' type. The key must be of type
'GNUTLS_PRIVKEY_PKCS11' . The key returned in 'key' must be
deinitialized with 'gnutls_pkcs11_privkey_deinit()' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.4.0
gnutls_privkey_export_rsa_raw
-----------------------------
-- Function: int gnutls_privkey_export_rsa_raw (gnutls_privkey_t KEY,
gnutls_datum_t * M, gnutls_datum_t * E, gnutls_datum_t * D,
gnutls_datum_t * P, gnutls_datum_t * Q, gnutls_datum_t * U,
gnutls_datum_t * E1, gnutls_datum_t * E2)
KEY: Holds the certificate
M: will hold the modulus
E: will hold the public exponent
D: will hold the private exponent
P: will hold the first prime (p)
Q: will hold the second prime (q)
U: will hold the coefficient
E1: will hold e1 = d mod (p-1)
E2: will hold e2 = d mod (q-1)
This function will export the RSA private key's parameters found in
the given structure. The new parameters will be allocated using
'gnutls_malloc()' and will be stored in the appropriate datum. For
EdDSA keys, the 'y' value should be 'NULL' .
*Returns:* 'GNUTLS_E_SUCCESS' on success, otherwise a negative
error code.
*Since:* 3.3.0
gnutls_privkey_export_rsa_raw2
------------------------------
-- Function: int gnutls_privkey_export_rsa_raw2 (gnutls_privkey_t KEY,
gnutls_datum_t * M, gnutls_datum_t * E, gnutls_datum_t * D,
gnutls_datum_t * P, gnutls_datum_t * Q, gnutls_datum_t * U,
gnutls_datum_t * E1, gnutls_datum_t * E2, unsigned int FLAGS)
KEY: Holds the certificate
M: will hold the modulus
E: will hold the public exponent
D: will hold the private exponent
P: will hold the first prime (p)
Q: will hold the second prime (q)
U: will hold the coefficient
E1: will hold e1 = d mod (p-1)
E2: will hold e2 = d mod (q-1)
FLAGS: flags from 'gnutls_abstract_export_flags_t'
This function will export the RSA private key's parameters found in
the given structure. The new parameters will be allocated using
'gnutls_malloc()' and will be stored in the appropriate datum.
*Returns:* 'GNUTLS_E_SUCCESS' on success, otherwise a negative
error code.
*Since:* 3.6.0
gnutls_privkey_export_x509
--------------------------
-- Function: int gnutls_privkey_export_x509 (gnutls_privkey_t PKEY,
gnutls_x509_privkey_t * KEY)
PKEY: The private key
KEY: Location for the key to be exported.
Converts the given abstract private key to a
'gnutls_x509_privkey_t' type. The abstract key must be of type
'GNUTLS_PRIVKEY_X509' . The input 'key' must not be initialized.
The key returned in 'key' should be deinitialized using
'gnutls_x509_privkey_deinit()' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.4.0
gnutls_privkey_generate
-----------------------
-- Function: int gnutls_privkey_generate (gnutls_privkey_t PKEY,
gnutls_pk_algorithm_t ALGO, unsigned int BITS, unsigned int
FLAGS)
PKEY: An initialized private key
ALGO: is one of the algorithms in 'gnutls_pk_algorithm_t' .
BITS: the size of the parameters to generate
FLAGS: Must be zero or flags from 'gnutls_privkey_flags_t' .
This function will generate a random private key. Note that this
function must be called on an initialized private key.
The flag 'GNUTLS_PRIVKEY_FLAG_PROVABLE' instructs the key
generation process to use algorithms like Shawe-Taylor (from FIPS
PUB186-4) which generate provable parameters out of a seed for RSA
and DSA keys. See 'gnutls_privkey_generate2()' for more
information.
Note that when generating an elliptic curve key, the curve can be
substituted in the place of the bits parameter using the
'GNUTLS_CURVE_TO_BITS()' macro. The input to the macro is any
curve from 'gnutls_ecc_curve_t' .
For DSA keys, if the subgroup size needs to be specified check the
'GNUTLS_SUBGROUP_TO_BITS()' macro.
It is recommended to do not set the number of 'bits' directly, use
'gnutls_sec_param_to_pk_bits()' instead .
See also 'gnutls_privkey_generate2()' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.3.0
gnutls_privkey_generate2
------------------------
-- Function: int gnutls_privkey_generate2 (gnutls_privkey_t PKEY,
gnutls_pk_algorithm_t ALGO, unsigned int BITS, unsigned int
FLAGS, const gnutls_keygen_data_st * DATA, unsigned DATA_SIZE)
PKEY: The private key
ALGO: is one of the algorithms in 'gnutls_pk_algorithm_t' .
BITS: the size of the modulus
FLAGS: Must be zero or flags from 'gnutls_privkey_flags_t' .
DATA: Allow specifying 'gnutls_keygen_data_st' types such as the
seed to be used.
DATA_SIZE: The number of 'data' available.
This function will generate a random private key. Note that this
function must be called on an initialized private key.
The flag 'GNUTLS_PRIVKEY_FLAG_PROVABLE' instructs the key
generation process to use algorithms like Shawe-Taylor (from FIPS
PUB186-4) which generate provable parameters out of a seed for RSA
and DSA keys. On DSA keys the PQG parameters are generated using
the seed, while on RSA the two primes. To specify an explicit seed
(by default a random seed is used), use the 'data' with a
'GNUTLS_KEYGEN_SEED' type.
Note that when generating an elliptic curve key, the curve can be
substituted in the place of the bits parameter using the
'GNUTLS_CURVE_TO_BITS()' macro.
To export the generated keys in memory or in files it is
recommended to use the PKCS'8' form as it can handle all key types,
and can store additional parameters such as the seed, in case of
provable RSA or DSA keys. Generated keys can be exported in memory
using 'gnutls_privkey_export_x509()' , and then with
'gnutls_x509_privkey_export2_pkcs8()' .
If key generation is part of your application, avoid setting the
number of bits directly, and instead use
'gnutls_sec_param_to_pk_bits()' . That way the generated keys will
adapt to the security levels of the underlying GnuTLS library.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.5.0
gnutls_privkey_get_pk_algorithm
-------------------------------
-- Function: int gnutls_privkey_get_pk_algorithm (gnutls_privkey_t KEY,
unsigned int * BITS)
KEY: should contain a 'gnutls_privkey_t' type
BITS: If set will return the number of bits of the parameters (may
be NULL)
This function will return the public key algorithm of a private key
and if possible will return a number of bits that indicates the
security parameter of the key.
*Returns:* a member of the 'gnutls_pk_algorithm_t' enumeration on
success, or a negative error code on error.
*Since:* 2.12.0
gnutls_privkey_get_seed
-----------------------
-- Function: int gnutls_privkey_get_seed (gnutls_privkey_t KEY,
gnutls_digest_algorithm_t * DIGEST, void * SEED, size_t *
SEED_SIZE)
KEY: should contain a 'gnutls_privkey_t' type
DIGEST: if non-NULL it will contain the digest algorithm used for
key generation (if applicable)
SEED: where seed will be copied to
SEED_SIZE: originally holds the size of 'seed' , will be updated
with actual size
This function will return the seed that was used to generate the
given private key. That function will succeed only if the key was
generated as a provable key.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.5.0
gnutls_privkey_get_spki
-----------------------
-- Function: int gnutls_privkey_get_spki (gnutls_privkey_t PRIVKEY,
gnutls_x509_spki_t SPKI, unsigned int FLAGS)
PRIVKEY: a public key of type 'gnutls_privkey_t'
SPKI: a SubjectPublicKeyInfo structure of type
'gnutls_privkey_spki_t'
FLAGS: must be zero
This function will return the public key information if available.
The provided 'spki' must be initialized.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.6.0
gnutls_privkey_get_type
-----------------------
-- Function: gnutls_privkey_type_t gnutls_privkey_get_type
(gnutls_privkey_t KEY)
KEY: should contain a 'gnutls_privkey_t' type
This function will return the type of the private key. This is
actually the type of the subsystem used to set this private key.
*Returns:* a member of the 'gnutls_privkey_type_t' enumeration on
success, or a negative error code on error.
*Since:* 2.12.0
gnutls_privkey_import_dsa_raw
-----------------------------
-- Function: int gnutls_privkey_import_dsa_raw (gnutls_privkey_t KEY,
const gnutls_datum_t * P, const gnutls_datum_t * Q, const
gnutls_datum_t * G, const gnutls_datum_t * Y, const
gnutls_datum_t * X)
KEY: The structure to store the parsed key
P: holds the p
Q: holds the q
G: holds the g
Y: holds the y
X: holds the x
This function will convert the given DSA raw parameters to the
native 'gnutls_privkey_t' format. The output will be stored in
'key' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_privkey_import_ecc_raw
-----------------------------
-- Function: int gnutls_privkey_import_ecc_raw (gnutls_privkey_t KEY,
gnutls_ecc_curve_t CURVE, const gnutls_datum_t * X, const
gnutls_datum_t * Y, const gnutls_datum_t * K)
KEY: The key
CURVE: holds the curve
X: holds the x
Y: holds the y
K: holds the k
This function will convert the given elliptic curve parameters to
the native 'gnutls_privkey_t' format. The output will be stored in
'key' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.0
gnutls_privkey_import_ext
-------------------------
-- Function: int gnutls_privkey_import_ext (gnutls_privkey_t PKEY,
gnutls_pk_algorithm_t PK, void * USERDATA,
gnutls_privkey_sign_func SIGN_FUNC,
gnutls_privkey_decrypt_func DECRYPT_FUNC, unsigned int FLAGS)
PKEY: The private key
PK: The public key algorithm
USERDATA: private data to be provided to the callbacks
SIGN_FUNC: callback for signature operations
DECRYPT_FUNC: callback for decryption operations
FLAGS: Flags for the import
This function will associate the given callbacks with the
'gnutls_privkey_t' type. At least one of the two callbacks must be
non-null.
Note that the signing function is supposed to "raw" sign data,
i.e., without any hashing or preprocessing. In case of RSA the
DigestInfo will be provided, and the signing function is expected
to do the PKCS '1' 1.5 padding and the exponentiation.
See also 'gnutls_privkey_import_ext3()' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.0
gnutls_privkey_import_ext2
--------------------------
-- Function: int gnutls_privkey_import_ext2 (gnutls_privkey_t PKEY,
gnutls_pk_algorithm_t PK, void * USERDATA,
gnutls_privkey_sign_func SIGN_FN, gnutls_privkey_decrypt_func
DECRYPT_FN, gnutls_privkey_deinit_func DEINIT_FN, unsigned int
FLAGS)
PKEY: The private key
PK: The public key algorithm
USERDATA: private data to be provided to the callbacks
SIGN_FN: callback for signature operations
DECRYPT_FN: callback for decryption operations
DEINIT_FN: a deinitialization function
FLAGS: Flags for the import
This function will associate the given callbacks with the
'gnutls_privkey_t' type. At least one of the two callbacks must be
non-null. If a deinitialization function is provided then flags is
assumed to contain 'GNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE' .
Note that the signing function is supposed to "raw" sign data,
i.e., without any hashing or preprocessing. In case of RSA the
DigestInfo will be provided, and the signing function is expected
to do the PKCS '1' 1.5 padding and the exponentiation.
See also 'gnutls_privkey_import_ext3()' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.1
gnutls_privkey_import_ext3
--------------------------
-- Function: int gnutls_privkey_import_ext3 (gnutls_privkey_t PKEY,
void * USERDATA, gnutls_privkey_sign_func SIGN_FN,
gnutls_privkey_decrypt_func DECRYPT_FN,
gnutls_privkey_deinit_func DEINIT_FN, gnutls_privkey_info_func
INFO_FN, unsigned int FLAGS)
PKEY: The private key
USERDATA: private data to be provided to the callbacks
SIGN_FN: callback for signature operations
DECRYPT_FN: callback for decryption operations
DEINIT_FN: a deinitialization function
INFO_FN: returns info about the public key algorithm (should not be
'NULL' )
FLAGS: Flags for the import
This function will associate the given callbacks with the
'gnutls_privkey_t' type. At least one of the two callbacks must be
non-null. If a deinitialization function is provided then flags is
assumed to contain 'GNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE' .
Note that the signing function is supposed to "raw" sign data,
i.e., without any hashing or preprocessing. In case of RSA the
DigestInfo will be provided, and the signing function is expected
to do the PKCS '1' 1.5 padding and the exponentiation.
The 'info_fn' must provide information on the algorithms supported
by this private key, and should support the flags
'GNUTLS_PRIVKEY_INFO_PK_ALGO' and 'GNUTLS_PRIVKEY_INFO_SIGN_ALGO' .
It must return -1 on unknown flags.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.4.0
gnutls_privkey_import_ext4
--------------------------
-- Function: int gnutls_privkey_import_ext4 (gnutls_privkey_t PKEY,
void * USERDATA, gnutls_privkey_sign_data_func SIGN_DATA_FN,
gnutls_privkey_sign_hash_func SIGN_HASH_FN,
gnutls_privkey_decrypt_func DECRYPT_FN,
gnutls_privkey_deinit_func DEINIT_FN, gnutls_privkey_info_func
INFO_FN, unsigned int FLAGS)
PKEY: The private key
USERDATA: private data to be provided to the callbacks
SIGN_DATA_FN: callback for signature operations (may be 'NULL' )
SIGN_HASH_FN: callback for signature operations (may be 'NULL' )
DECRYPT_FN: callback for decryption operations (may be 'NULL' )
DEINIT_FN: a deinitialization function
INFO_FN: returns info about the public key algorithm (should not be
'NULL' )
FLAGS: Flags for the import
This function will associate the given callbacks with the
'gnutls_privkey_t' type. At least one of the callbacks must be
non-null. If a deinitialization function is provided then flags is
assumed to contain 'GNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE' .
Note that in contrast with the signing function of
'gnutls_privkey_import_ext3()' , the signing functions provided to
this function take explicitly the signature algorithm as parameter
and different functions are provided to sign the data and hashes.
The 'sign_hash_fn' is to be called to sign pre-hashed data. The
input to the callback is the output of the hash (such as SHA256)
corresponding to the signature algorithm. For RSA PKCS'1'
signatures, the signature algorithm can be set to
'GNUTLS_SIGN_RSA_RAW' , and in that case the data should be handled
as if they were an RSA PKCS'1' DigestInfo structure.
The 'sign_data_fn' is to be called to sign data. The input data
will be he data to be signed (and hashed), with the provided
signature algorithm. This function is to be used for signature
algorithms like Ed25519 which cannot take pre-hashed data as input.
When both 'sign_data_fn' and 'sign_hash_fn' functions are provided
they must be able to operate on all the supported signature
algorithms, unless prohibited by the type of the algorithm (e.g.,
as with Ed25519).
The 'info_fn' must provide information on the signature algorithms
supported by this private key, and should support the flags
'GNUTLS_PRIVKEY_INFO_PK_ALGO' and
'GNUTLS_PRIVKEY_INFO_HAVE_SIGN_ALGO' . It must return -1 on
unknown flags.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.6.0
gnutls_privkey_import_openpgp
-----------------------------
-- Function: int gnutls_privkey_import_openpgp (gnutls_privkey_t PKEY,
gnutls_openpgp_privkey_t KEY, unsigned int FLAGS)
PKEY: The private key
KEY: The private key to be imported
FLAGS: Flags for the import
This function is no-op.
*Returns:* 'GNUTLS_E_UNIMPLEMENTED_FEATURE' .
*Since:* 2.12.0
gnutls_privkey_import_openpgp_raw
---------------------------------
-- Function: int gnutls_privkey_import_openpgp_raw (gnutls_privkey_t
PKEY, const gnutls_datum_t * DATA, gnutls_openpgp_crt_fmt_t
FORMAT, const gnutls_openpgp_keyid_t KEYID, const char *
PASSWORD)
PKEY: The private key
DATA: The private key data to be imported
FORMAT: The format of the private key
KEYID: The key id to use (optional)
PASSWORD: A password (optional)
This function is no-op.
*Returns:* 'GNUTLS_E_UNIMPLEMENTED_FEATURE' .
*Since:* 3.1.0
gnutls_privkey_import_pkcs11
----------------------------
-- Function: int gnutls_privkey_import_pkcs11 (gnutls_privkey_t PKEY,
gnutls_pkcs11_privkey_t KEY, unsigned int FLAGS)
PKEY: The private key
KEY: The private key to be imported
FLAGS: Flags for the import
This function will import the given private key to the abstract
'gnutls_privkey_t' type.
The 'gnutls_pkcs11_privkey_t' object must not be deallocated during
the lifetime of this structure.
'flags' might be zero or one of
'GNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE' and
'GNUTLS_PRIVKEY_IMPORT_COPY' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_privkey_import_pkcs11_url
--------------------------------
-- Function: int gnutls_privkey_import_pkcs11_url (gnutls_privkey_t
KEY, const char * URL)
KEY: A key of type 'gnutls_pubkey_t'
URL: A PKCS 11 url
This function will import a PKCS 11 private key to a
'gnutls_private_key_t' type.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.1.0
gnutls_privkey_import_rsa_raw
-----------------------------
-- Function: int gnutls_privkey_import_rsa_raw (gnutls_privkey_t KEY,
const gnutls_datum_t * M, const gnutls_datum_t * E, const
gnutls_datum_t * D, const gnutls_datum_t * P, const
gnutls_datum_t * Q, const gnutls_datum_t * U, const
gnutls_datum_t * E1, const gnutls_datum_t * E2)
KEY: The structure to store the parsed key
M: holds the modulus
E: holds the public exponent
D: holds the private exponent
P: holds the first prime (p)
Q: holds the second prime (q)
U: holds the coefficient (optional)
E1: holds e1 = d mod (p-1) (optional)
E2: holds e2 = d mod (q-1) (optional)
This function will convert the given RSA raw parameters to the
native 'gnutls_privkey_t' format. The output will be stored in
'key' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_privkey_import_tpm_raw
-----------------------------
-- Function: int gnutls_privkey_import_tpm_raw (gnutls_privkey_t PKEY,
const gnutls_datum_t * FDATA, gnutls_tpmkey_fmt_t FORMAT,
const char * SRK_PASSWORD, const char * KEY_PASSWORD, unsigned
int FLAGS)
PKEY: The private key
FDATA: The TPM key to be imported
FORMAT: The format of the private key
SRK_PASSWORD: The password for the SRK key (optional)
KEY_PASSWORD: A password for the key (optional)
FLAGS: should be zero
This function will import the given private key to the abstract
'gnutls_privkey_t' type.
With respect to passwords the same as in
'gnutls_privkey_import_tpm_url()' apply.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.1.0
gnutls_privkey_import_tpm_url
-----------------------------
-- Function: int gnutls_privkey_import_tpm_url (gnutls_privkey_t PKEY,
const char * URL, const char * SRK_PASSWORD, const char *
KEY_PASSWORD, unsigned int FLAGS)
PKEY: The private key
URL: The URL of the TPM key to be imported
SRK_PASSWORD: The password for the SRK key (optional)
KEY_PASSWORD: A password for the key (optional)
FLAGS: One of the GNUTLS_PRIVKEY_* flags
This function will import the given private key to the abstract
'gnutls_privkey_t' type.
Note that unless 'GNUTLS_PRIVKEY_DISABLE_CALLBACKS' is specified,
if incorrect (or NULL) passwords are given the PKCS11 callback
functions will be used to obtain the correct passwords. Otherwise
if the SRK password is wrong 'GNUTLS_E_TPM_SRK_PASSWORD_ERROR' is
returned and if the key password is wrong or not provided then
'GNUTLS_E_TPM_KEY_PASSWORD_ERROR' is returned.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.1.0
gnutls_privkey_import_url
-------------------------
-- Function: int gnutls_privkey_import_url (gnutls_privkey_t KEY, const
char * URL, unsigned int FLAGS)
KEY: A key of type 'gnutls_privkey_t'
URL: A PKCS 11 url
FLAGS: should be zero
This function will import a PKCS11 or TPM URL as a private key.
The supported URL types can be checked using
'gnutls_url_is_supported()' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.1.0
gnutls_privkey_import_x509
--------------------------
-- Function: int gnutls_privkey_import_x509 (gnutls_privkey_t PKEY,
gnutls_x509_privkey_t KEY, unsigned int FLAGS)
PKEY: The private key
KEY: The private key to be imported
FLAGS: Flags for the import
This function will import the given private key to the abstract
'gnutls_privkey_t' type.
The 'gnutls_x509_privkey_t' object must not be deallocated during
the lifetime of this structure.
'flags' might be zero or one of
'GNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE' and
'GNUTLS_PRIVKEY_IMPORT_COPY' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_privkey_import_x509_raw
------------------------------
-- Function: int gnutls_privkey_import_x509_raw (gnutls_privkey_t PKEY,
const gnutls_datum_t * DATA, gnutls_x509_crt_fmt_t FORMAT,
const char * PASSWORD, unsigned int FLAGS)
PKEY: The private key
DATA: The private key data to be imported
FORMAT: The format of the private key
PASSWORD: A password (optional)
FLAGS: an ORed sequence of gnutls_pkcs_encrypt_flags_t
This function will import the given private key to the abstract
'gnutls_privkey_t' type.
The supported formats are basic unencrypted key, PKCS8, PKCS12, and
the openssl format.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.1.0
gnutls_privkey_init
-------------------
-- Function: int gnutls_privkey_init (gnutls_privkey_t * KEY)
KEY: A pointer to the type to be initialized
This function will initialize a private key object. The object can
be used to generate, import, and perform cryptographic operations
on the associated private key.
Note that when the underlying private key is a PKCS'11' key (i.e.,
when imported with a PKCS'11' URI), the limitations of
'gnutls_pkcs11_privkey_init()' apply to this object as well. In
versions of GnuTLS later than 3.5.11 the object is protected using
locks and a single 'gnutls_privkey_t' can be re-used by many
threads. However, for performance it is recommended to utilize one
object per key per thread.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_privkey_set_flags
------------------------
-- Function: void gnutls_privkey_set_flags (gnutls_privkey_t KEY,
unsigned int FLAGS)
KEY: A key of type 'gnutls_privkey_t'
FLAGS: flags from the 'gnutls_privkey_flags'
This function will set flags for the specified private key, after
it is generated. Currently this is useful for the
'GNUTLS_PRIVKEY_FLAG_EXPORT_COMPAT' to allow exporting a "provable"
private key in backwards compatible way.
*Since:* 3.5.0
gnutls_privkey_set_pin_function
-------------------------------
-- Function: void gnutls_privkey_set_pin_function (gnutls_privkey_t
KEY, gnutls_pin_callback_t FN, void * USERDATA)
KEY: A key of type 'gnutls_privkey_t'
FN: the callback
USERDATA: data associated with the callback
This function will set a callback function to be used when required
to access the object. This function overrides any other global PIN
functions.
Note that this function must be called right after initialization
to have effect.
*Since:* 3.1.0
gnutls_privkey_set_spki
-----------------------
-- Function: int gnutls_privkey_set_spki (gnutls_privkey_t PRIVKEY,
const gnutls_x509_spki_t SPKI, unsigned int FLAGS)
PRIVKEY: a public key of type 'gnutls_privkey_t'
SPKI: a SubjectPublicKeyInfo structure of type
'gnutls_privkey_spki_t'
FLAGS: must be zero
This function will set the public key information. The provided
'spki' must be initialized.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.6.0
gnutls_privkey_sign_data
------------------------
-- Function: int gnutls_privkey_sign_data (gnutls_privkey_t SIGNER,
gnutls_digest_algorithm_t HASH, unsigned int FLAGS, const
gnutls_datum_t * DATA, gnutls_datum_t * SIGNATURE)
SIGNER: Holds the key
HASH: should be a digest algorithm
FLAGS: Zero or one of 'gnutls_privkey_flags_t'
DATA: holds the data to be signed
SIGNATURE: will contain the signature allocated with
'gnutls_malloc()'
This function will sign the given data using a signature algorithm
supported by the private key. Signature algorithms are always used
together with a hash functions. Different hash functions may be
used for the RSA algorithm, but only the SHA family for the DSA
keys.
You may use 'gnutls_pubkey_get_preferred_hash_algorithm()' to
determine the hash algorithm.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_privkey_sign_data2
-------------------------
-- Function: int gnutls_privkey_sign_data2 (gnutls_privkey_t SIGNER,
gnutls_sign_algorithm_t ALGO, unsigned int FLAGS, const
gnutls_datum_t * DATA, gnutls_datum_t * SIGNATURE)
SIGNER: Holds the key
ALGO: The signature algorithm used
FLAGS: Zero or one of 'gnutls_privkey_flags_t'
DATA: holds the data to be signed
SIGNATURE: will contain the signature allocated with
'gnutls_malloc()'
This function will sign the given data using the specified
signature algorithm. This function is an enhancement of
'gnutls_privkey_sign_data()' , as it allows utilizing a alternative
signature algorithm where possible (e.g, use an RSA key with
RSA-PSS).
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.6.0
gnutls_privkey_sign_hash
------------------------
-- Function: int gnutls_privkey_sign_hash (gnutls_privkey_t SIGNER,
gnutls_digest_algorithm_t HASH_ALGO, unsigned int FLAGS, const
gnutls_datum_t * HASH_DATA, gnutls_datum_t * SIGNATURE)
SIGNER: Holds the signer's key
HASH_ALGO: The hash algorithm used
FLAGS: Zero or one of 'gnutls_privkey_flags_t'
HASH_DATA: holds the data to be signed
SIGNATURE: will contain newly allocated signature
This function will sign the given hashed data using a signature
algorithm supported by the private key. Signature algorithms are
always used together with a hash functions. Different hash
functions may be used for the RSA algorithm, but only SHA-XXX for
the DSA keys.
You may use 'gnutls_pubkey_get_preferred_hash_algorithm()' to
determine the hash algorithm.
The flags may be 'GNUTLS_PRIVKEY_SIGN_FLAG_TLS1_RSA' or
'GNUTLS_PRIVKEY_SIGN_FLAG_RSA_PSS' . In the former case this
function will ignore 'hash_algo' and perform a raw PKCS1 signature,
and in the latter an RSA-PSS signature will be generated.
Note that, not all algorithm support signing already hashed data.
When signing with Ed25519, 'gnutls_privkey_sign_data()' should be
used.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_privkey_sign_hash2
-------------------------
-- Function: int gnutls_privkey_sign_hash2 (gnutls_privkey_t SIGNER,
gnutls_sign_algorithm_t ALGO, unsigned int FLAGS, const
gnutls_datum_t * HASH_DATA, gnutls_datum_t * SIGNATURE)
SIGNER: Holds the signer's key
ALGO: The signature algorithm used
FLAGS: Zero or one of 'gnutls_privkey_flags_t'
HASH_DATA: holds the data to be signed
SIGNATURE: will contain newly allocated signature
This function will sign the given hashed data using a signature
algorithm supported by the private key. Signature algorithms are
always used together with a hash functions. Different hash
functions may be used for the RSA algorithm, but only SHA-XXX for
the DSA keys.
You may use 'gnutls_pubkey_get_preferred_hash_algorithm()' to
determine the hash algorithm.
The flags may be 'GNUTLS_PRIVKEY_SIGN_FLAG_TLS1_RSA' or
'GNUTLS_PRIVKEY_SIGN_FLAG_RSA_PSS' . In the former case this
function will ignore 'hash_algo' and perform a raw PKCS1 signature,
and in the latter an RSA-PSS signature will be generated.
Note that, not all algorithm support signing already hashed data.
When signing with Ed25519, 'gnutls_privkey_sign_data()' should be
used.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.6.0
gnutls_privkey_status
---------------------
-- Function: int gnutls_privkey_status (gnutls_privkey_t KEY)
KEY: Holds the key
Checks the status of the private key token. This function is an
actual wrapper over 'gnutls_pkcs11_privkey_status()' , and if the
private key is a PKCS '11' token it will check whether it is
inserted or not.
*Returns:* this function will return non-zero if the token holding
the private key is still available (inserted), and zero otherwise.
*Since:* 3.1.10
gnutls_privkey_verify_params
----------------------------
-- Function: int gnutls_privkey_verify_params (gnutls_privkey_t KEY)
KEY: should contain a 'gnutls_privkey_t' type
This function will verify the private key parameters.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.3.0
gnutls_privkey_verify_seed
--------------------------
-- Function: int gnutls_privkey_verify_seed (gnutls_privkey_t KEY,
gnutls_digest_algorithm_t DIGEST, const void * SEED, size_t
SEED_SIZE)
KEY: should contain a 'gnutls_privkey_t' type
DIGEST: it contains the digest algorithm used for key generation
(if applicable)
SEED: the seed of the key to be checked with
SEED_SIZE: holds the size of 'seed'
This function will verify that the given private key was generated
from the provided seed.
*Returns:* In case of a verification failure
'GNUTLS_E_PRIVKEY_VERIFICATION_ERROR' is returned, and zero or
positive code on success.
*Since:* 3.5.0
gnutls_pubkey_deinit
--------------------
-- Function: void gnutls_pubkey_deinit (gnutls_pubkey_t KEY)
KEY: The key to be deinitialized
This function will deinitialize a public key structure.
*Since:* 2.12.0
gnutls_pubkey_encrypt_data
--------------------------
-- Function: int gnutls_pubkey_encrypt_data (gnutls_pubkey_t KEY,
unsigned int FLAGS, const gnutls_datum_t * PLAINTEXT,
gnutls_datum_t * CIPHERTEXT)
KEY: Holds the public key
FLAGS: should be 0 for now
PLAINTEXT: The data to be encrypted
CIPHERTEXT: contains the encrypted data
This function will encrypt the given data, using the public key.
On success the 'ciphertext' will be allocated using
'gnutls_malloc()' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.0
gnutls_pubkey_export
--------------------
-- Function: int gnutls_pubkey_export (gnutls_pubkey_t KEY,
gnutls_x509_crt_fmt_t FORMAT, void * OUTPUT_DATA, size_t *
OUTPUT_DATA_SIZE)
KEY: Holds the certificate
FORMAT: the format of output params. One of PEM or DER.
OUTPUT_DATA: will contain a certificate PEM or DER encoded
OUTPUT_DATA_SIZE: holds the size of output_data (and will be
replaced by the actual size of parameters)
This function will export the public key to DER or PEM format. The
contents of the exported data is the SubjectPublicKeyInfo X.509
structure.
If the buffer provided is not long enough to hold the output, then
*output_data_size is updated and 'GNUTLS_E_SHORT_MEMORY_BUFFER'
will be returned.
If the structure is PEM encoded, it will have a header of "BEGIN
CERTIFICATE".
*Returns:* In case of failure a negative error code will be
returned, and 0 on success.
*Since:* 2.12.0
gnutls_pubkey_export2
---------------------
-- Function: int gnutls_pubkey_export2 (gnutls_pubkey_t KEY,
gnutls_x509_crt_fmt_t FORMAT, gnutls_datum_t * OUT)
KEY: Holds the certificate
FORMAT: the format of output params. One of PEM or DER.
OUT: will contain a certificate PEM or DER encoded
This function will export the public key to DER or PEM format. The
contents of the exported data is the SubjectPublicKeyInfo X.509
structure.
The output buffer will be allocated using 'gnutls_malloc()' .
If the structure is PEM encoded, it will have a header of "BEGIN
CERTIFICATE".
*Returns:* In case of failure a negative error code will be
returned, and 0 on success.
*Since:* 3.1.3
gnutls_pubkey_export_dsa_raw
----------------------------
-- Function: int gnutls_pubkey_export_dsa_raw (gnutls_pubkey_t KEY,
gnutls_datum_t * P, gnutls_datum_t * Q, gnutls_datum_t * G,
gnutls_datum_t * Y)
KEY: Holds the public key
P: will hold the p (may be 'NULL' )
Q: will hold the q (may be 'NULL' )
G: will hold the g (may be 'NULL' )
Y: will hold the y (may be 'NULL' )
This function will export the DSA public key's parameters found in
the given certificate. The new parameters will be allocated using
'gnutls_malloc()' and will be stored in the appropriate datum.
This function allows for 'NULL' parameters since 3.4.1.
*Returns:* 'GNUTLS_E_SUCCESS' on success, otherwise a negative
error code.
*Since:* 3.3.0
gnutls_pubkey_export_dsa_raw2
-----------------------------
-- Function: int gnutls_pubkey_export_dsa_raw2 (gnutls_pubkey_t KEY,
gnutls_datum_t * P, gnutls_datum_t * Q, gnutls_datum_t * G,
gnutls_datum_t * Y, unsigned FLAGS)
KEY: Holds the public key
P: will hold the p (may be 'NULL' )
Q: will hold the q (may be 'NULL' )
G: will hold the g (may be 'NULL' )
Y: will hold the y (may be 'NULL' )
FLAGS: flags from 'gnutls_abstract_export_flags_t'
This function will export the DSA public key's parameters found in
the given certificate. The new parameters will be allocated using
'gnutls_malloc()' and will be stored in the appropriate datum.
This function allows for 'NULL' parameters since 3.4.1.
*Returns:* 'GNUTLS_E_SUCCESS' on success, otherwise a negative
error code.
*Since:* 3.6.0
gnutls_pubkey_export_ecc_raw
----------------------------
-- Function: int gnutls_pubkey_export_ecc_raw (gnutls_pubkey_t KEY,
gnutls_ecc_curve_t * CURVE, gnutls_datum_t * X, gnutls_datum_t
* Y)
KEY: Holds the public key
CURVE: will hold the curve (may be 'NULL' )
X: will hold x (may be 'NULL' )
Y: will hold y (may be 'NULL' )
This function will export the ECC public key's parameters found in
the given key. The new parameters will be allocated using
'gnutls_malloc()' and will be stored in the appropriate datum. For
EdDSA public keys, 'y' will be set to 'NULL' .
This function allows for 'NULL' parameters since 3.4.1.
*Returns:* 'GNUTLS_E_SUCCESS' on success, otherwise a negative
error code.
*Since:* 3.0
gnutls_pubkey_export_ecc_raw2
-----------------------------
-- Function: int gnutls_pubkey_export_ecc_raw2 (gnutls_pubkey_t KEY,
gnutls_ecc_curve_t * CURVE, gnutls_datum_t * X, gnutls_datum_t
* Y, unsigned int FLAGS)
KEY: Holds the public key
CURVE: will hold the curve (may be 'NULL' )
X: will hold x (may be 'NULL' )
Y: will hold y (may be 'NULL' )
FLAGS: flags from 'gnutls_abstract_export_flags_t'
This function will export the ECC public key's parameters found in
the given key. The new parameters will be allocated using
'gnutls_malloc()' and will be stored in the appropriate datum.
This function allows for 'NULL' parameters since 3.4.1.
*Returns:* 'GNUTLS_E_SUCCESS' on success, otherwise a negative
error code.
*Since:* 3.6.0
gnutls_pubkey_export_ecc_x962
-----------------------------
-- Function: int gnutls_pubkey_export_ecc_x962 (gnutls_pubkey_t KEY,
gnutls_datum_t * PARAMETERS, gnutls_datum_t * ECPOINT)
KEY: Holds the public key
PARAMETERS: DER encoding of an ANSI X9.62 parameters
ECPOINT: DER encoding of ANSI X9.62 ECPoint
This function will export the ECC public key's parameters found in
the given certificate. The new parameters will be allocated using
'gnutls_malloc()' and will be stored in the appropriate datum.
*Returns:* 'GNUTLS_E_SUCCESS' on success, otherwise a negative
error code.
*Since:* 3.3.0
gnutls_pubkey_export_rsa_raw
----------------------------
-- Function: int gnutls_pubkey_export_rsa_raw (gnutls_pubkey_t KEY,
gnutls_datum_t * M, gnutls_datum_t * E)
KEY: Holds the certificate
M: will hold the modulus (may be 'NULL' )
E: will hold the public exponent (may be 'NULL' )
This function will export the RSA public key's parameters found in
the given structure. The new parameters will be allocated using
'gnutls_malloc()' and will be stored in the appropriate datum.
This function allows for 'NULL' parameters since 3.4.1.
*Returns:* 'GNUTLS_E_SUCCESS' on success, otherwise a negative
error code.
*Since:* 3.3.0
gnutls_pubkey_export_rsa_raw2
-----------------------------
-- Function: int gnutls_pubkey_export_rsa_raw2 (gnutls_pubkey_t KEY,
gnutls_datum_t * M, gnutls_datum_t * E, unsigned FLAGS)
KEY: Holds the certificate
M: will hold the modulus (may be 'NULL' )
E: will hold the public exponent (may be 'NULL' )
FLAGS: flags from 'gnutls_abstract_export_flags_t'
This function will export the RSA public key's parameters found in
the given structure. The new parameters will be allocated using
'gnutls_malloc()' and will be stored in the appropriate datum.
This function allows for 'NULL' parameters since 3.4.1.
*Returns:* 'GNUTLS_E_SUCCESS' on success, otherwise a negative
error code.
*Since:* 3.6.0
gnutls_pubkey_get_key_id
------------------------
-- Function: int gnutls_pubkey_get_key_id (gnutls_pubkey_t KEY,
unsigned int FLAGS, unsigned char * OUTPUT_DATA, size_t *
OUTPUT_DATA_SIZE)
KEY: Holds the public key
FLAGS: should be one of the flags from 'gnutls_keyid_flags_t'
OUTPUT_DATA: will contain the key ID
OUTPUT_DATA_SIZE: holds the size of output_data (and will be
replaced by the actual size of parameters)
This function will return a unique ID that depends on the public
key parameters. This ID can be used in checking whether a
certificate corresponds to the given public key.
If the buffer provided is not long enough to hold the output, then
*output_data_size is updated and 'GNUTLS_E_SHORT_MEMORY_BUFFER'
will be returned. The output will normally be a SHA-1 hash output,
which is 20 bytes.
*Returns:* In case of failure a negative error code will be
returned, and 0 on success.
*Since:* 2.12.0
gnutls_pubkey_get_key_usage
---------------------------
-- Function: int gnutls_pubkey_get_key_usage (gnutls_pubkey_t KEY,
unsigned int * USAGE)
KEY: should contain a 'gnutls_pubkey_t' type
USAGE: If set will return the number of bits of the parameters (may
be NULL)
This function will return the key usage of the public key.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_pubkey_get_openpgp_key_id
--------------------------------
-- Function: int gnutls_pubkey_get_openpgp_key_id (gnutls_pubkey_t KEY,
unsigned int FLAGS, unsigned char * OUTPUT_DATA, size_t *
OUTPUT_DATA_SIZE, unsigned int * SUBKEY)
KEY: Holds the public key
FLAGS: should be one of the flags from 'gnutls_keyid_flags_t'
OUTPUT_DATA: will contain the key ID
OUTPUT_DATA_SIZE: holds the size of output_data (and will be
replaced by the actual size of parameters)
SUBKEY: - undescribed -
This function is no-op.
*Returns:* 'GNUTLS_E_UNIMPLEMENTED_FEATURE' .
*Since:* 2.12.0
gnutls_pubkey_get_pk_algorithm
------------------------------
-- Function: int gnutls_pubkey_get_pk_algorithm (gnutls_pubkey_t KEY,
unsigned int * BITS)
KEY: should contain a 'gnutls_pubkey_t' type
BITS: If set will return the number of bits of the parameters (may
be NULL)
This function will return the public key algorithm of a public key
and if possible will return a number of bits that indicates the
security parameter of the key.
*Returns:* a member of the 'gnutls_pk_algorithm_t' enumeration on
success, or a negative error code on error.
*Since:* 2.12.0
gnutls_pubkey_get_preferred_hash_algorithm
------------------------------------------
-- Function: int gnutls_pubkey_get_preferred_hash_algorithm
(gnutls_pubkey_t KEY, gnutls_digest_algorithm_t * HASH,
unsigned int * MAND)
KEY: Holds the certificate
HASH: The result of the call with the hash algorithm used for
signature
MAND: If non zero it means that the algorithm MUST use this hash.
May be NULL.
This function will read the certificate and return the appropriate
digest algorithm to use for signing with this certificate. Some
certificates (i.e. DSA might not be able to sign without the
preferred algorithm).
To get the signature algorithm instead of just the hash use
'gnutls_pk_to_sign()' with the algorithm of the certificate/key and
the provided 'hash' .
*Returns:* the 0 if the hash algorithm is found. A negative error
code is returned on error.
*Since:* 2.12.0
gnutls_pubkey_get_spki
----------------------
-- Function: int gnutls_pubkey_get_spki (gnutls_pubkey_t PUBKEY,
gnutls_x509_spki_t SPKI, unsigned int FLAGS)
PUBKEY: a public key of type 'gnutls_pubkey_t'
SPKI: a SubjectPublicKeyInfo structure of type
'gnutls_pubkey_spki_t'
FLAGS: must be zero
This function will return the public key information if available.
The provided 'spki' must be initialized.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.6.0
gnutls_pubkey_import
--------------------
-- Function: int gnutls_pubkey_import (gnutls_pubkey_t KEY, const
gnutls_datum_t * DATA, gnutls_x509_crt_fmt_t FORMAT)
KEY: The public key.
DATA: The DER or PEM encoded certificate.
FORMAT: One of DER or PEM
This function will import the provided public key in a
SubjectPublicKeyInfo X.509 structure to a native 'gnutls_pubkey_t'
type. The output will be stored in 'key' . If the public key is
PEM encoded it should have a header of "PUBLIC KEY".
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_pubkey_import_dsa_raw
----------------------------
-- Function: int gnutls_pubkey_import_dsa_raw (gnutls_pubkey_t KEY,
const gnutls_datum_t * P, const gnutls_datum_t * Q, const
gnutls_datum_t * G, const gnutls_datum_t * Y)
KEY: The structure to store the parsed key
P: holds the p
Q: holds the q
G: holds the g
Y: holds the y
This function will convert the given DSA raw parameters to the
native 'gnutls_pubkey_t' format. The output will be stored in
'key' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_pubkey_import_ecc_raw
----------------------------
-- Function: int gnutls_pubkey_import_ecc_raw (gnutls_pubkey_t KEY,
gnutls_ecc_curve_t CURVE, const gnutls_datum_t * X, const
gnutls_datum_t * Y)
KEY: The structure to store the parsed key
CURVE: holds the curve
X: holds the x
Y: holds the y
This function will convert the given elliptic curve parameters to a
'gnutls_pubkey_t' . The output will be stored in 'key' . For
EdDSA keys the 'y' parameter should be 'NULL' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.0
gnutls_pubkey_import_ecc_x962
-----------------------------
-- Function: int gnutls_pubkey_import_ecc_x962 (gnutls_pubkey_t KEY,
const gnutls_datum_t * PARAMETERS, const gnutls_datum_t *
ECPOINT)
KEY: The structure to store the parsed key
PARAMETERS: DER encoding of an ANSI X9.62 parameters
ECPOINT: DER encoding of ANSI X9.62 ECPoint
This function will convert the given elliptic curve parameters to a
'gnutls_pubkey_t' . The output will be stored in 'key' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.0
gnutls_pubkey_import_openpgp
----------------------------
-- Function: int gnutls_pubkey_import_openpgp (gnutls_pubkey_t KEY,
gnutls_openpgp_crt_t CRT, unsigned int FLAGS)
KEY: The public key
CRT: The certificate to be imported
FLAGS: should be zero
This function is no-op.
*Returns:* 'GNUTLS_E_UNIMPLEMENTED_FEATURE' .
*Since:* 2.12.0
gnutls_pubkey_import_openpgp_raw
--------------------------------
-- Function: int gnutls_pubkey_import_openpgp_raw (gnutls_pubkey_t
PKEY, const gnutls_datum_t * DATA, gnutls_openpgp_crt_fmt_t
FORMAT, const gnutls_openpgp_keyid_t KEYID, unsigned int
FLAGS)
PKEY: The public key
DATA: The public key data to be imported
FORMAT: The format of the public key
KEYID: The key id to use (optional)
FLAGS: Should be zero
This function is no-op.
*Returns:* 'GNUTLS_E_UNIMPLEMENTED_FEATURE' .
*Since:* 3.1.3
gnutls_pubkey_import_pkcs11
---------------------------
-- Function: int gnutls_pubkey_import_pkcs11 (gnutls_pubkey_t KEY,
gnutls_pkcs11_obj_t OBJ, unsigned int FLAGS)
KEY: The public key
OBJ: The parameters to be imported
FLAGS: should be zero
Imports a public key from a pkcs11 key. This function will import
the given public key to the abstract 'gnutls_pubkey_t' type.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_pubkey_import_privkey
----------------------------
-- Function: int gnutls_pubkey_import_privkey (gnutls_pubkey_t KEY,
gnutls_privkey_t PKEY, unsigned int USAGE, unsigned int FLAGS)
KEY: The public key
PKEY: The private key
USAGE: GNUTLS_KEY_* key usage flags.
FLAGS: should be zero
Imports the public key from a private. This function will import
the given public key to the abstract 'gnutls_pubkey_t' type.
Note that in certain keys this operation may not be possible, e.g.,
in other than RSA PKCS'11' keys.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_pubkey_import_rsa_raw
----------------------------
-- Function: int gnutls_pubkey_import_rsa_raw (gnutls_pubkey_t KEY,
const gnutls_datum_t * M, const gnutls_datum_t * E)
KEY: The key
M: holds the modulus
E: holds the public exponent
This function will replace the parameters in the given structure.
The new parameters should be stored in the appropriate
gnutls_datum.
*Returns:* 'GNUTLS_E_SUCCESS' on success, or an negative error
code.
*Since:* 2.12.0
gnutls_pubkey_import_tpm_raw
----------------------------
-- Function: int gnutls_pubkey_import_tpm_raw (gnutls_pubkey_t PKEY,
const gnutls_datum_t * FDATA, gnutls_tpmkey_fmt_t FORMAT,
const char * SRK_PASSWORD, unsigned int FLAGS)
PKEY: The public key
FDATA: The TPM key to be imported
FORMAT: The format of the private key
SRK_PASSWORD: The password for the SRK key (optional)
FLAGS: One of the GNUTLS_PUBKEY_* flags
This function will import the public key from the provided TPM key
structure.
With respect to passwords the same as in
'gnutls_pubkey_import_tpm_url()' apply.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.1.0
gnutls_pubkey_import_tpm_url
----------------------------
-- Function: int gnutls_pubkey_import_tpm_url (gnutls_pubkey_t PKEY,
const char * URL, const char * SRK_PASSWORD, unsigned int
FLAGS)
PKEY: The public key
URL: The URL of the TPM key to be imported
SRK_PASSWORD: The password for the SRK key (optional)
FLAGS: should be zero
This function will import the given private key to the abstract
'gnutls_privkey_t' type.
Note that unless 'GNUTLS_PUBKEY_DISABLE_CALLBACKS' is specified, if
incorrect (or NULL) passwords are given the PKCS11 callback
functions will be used to obtain the correct passwords. Otherwise
if the SRK password is wrong 'GNUTLS_E_TPM_SRK_PASSWORD_ERROR' is
returned.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.1.0
gnutls_pubkey_import_url
------------------------
-- Function: int gnutls_pubkey_import_url (gnutls_pubkey_t KEY, const
char * URL, unsigned int FLAGS)
KEY: A key of type 'gnutls_pubkey_t'
URL: A PKCS 11 url
FLAGS: One of GNUTLS_PKCS11_OBJ_* flags
This function will import a public key from the provided URL.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.1.0
gnutls_pubkey_import_x509
-------------------------
-- Function: int gnutls_pubkey_import_x509 (gnutls_pubkey_t KEY,
gnutls_x509_crt_t CRT, unsigned int FLAGS)
KEY: The public key
CRT: The certificate to be imported
FLAGS: should be zero
This function will import the given public key to the abstract
'gnutls_pubkey_t' type.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_pubkey_import_x509_crq
-----------------------------
-- Function: int gnutls_pubkey_import_x509_crq (gnutls_pubkey_t KEY,
gnutls_x509_crq_t CRQ, unsigned int FLAGS)
KEY: The public key
CRQ: The certificate to be imported
FLAGS: should be zero
This function will import the given public key to the abstract
'gnutls_pubkey_t' type.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.1.5
gnutls_pubkey_import_x509_raw
-----------------------------
-- Function: int gnutls_pubkey_import_x509_raw (gnutls_pubkey_t PKEY,
const gnutls_datum_t * DATA, gnutls_x509_crt_fmt_t FORMAT,
unsigned int FLAGS)
PKEY: The public key
DATA: The public key data to be imported
FORMAT: The format of the public key
FLAGS: should be zero
This function will import the given public key to the abstract
'gnutls_pubkey_t' type.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.1.3
gnutls_pubkey_init
------------------
-- Function: int gnutls_pubkey_init (gnutls_pubkey_t * KEY)
KEY: A pointer to the type to be initialized
This function will initialize a public key.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_pubkey_print
-------------------
-- Function: int gnutls_pubkey_print (gnutls_pubkey_t PUBKEY,
gnutls_certificate_print_formats_t FORMAT, gnutls_datum_t *
OUT)
PUBKEY: The data to be printed
FORMAT: Indicate the format to use
OUT: Newly allocated datum with null terminated string.
This function will pretty print public key information, suitable
for display to a human.
Only 'GNUTLS_CRT_PRINT_FULL' and 'GNUTLS_CRT_PRINT_FULL_NUMBERS'
are implemented.
The output 'out' needs to be deallocated using 'gnutls_free()' .
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.1.5
gnutls_pubkey_set_key_usage
---------------------------
-- Function: int gnutls_pubkey_set_key_usage (gnutls_pubkey_t KEY,
unsigned int USAGE)
KEY: a certificate of type 'gnutls_x509_crt_t'
USAGE: an ORed sequence of the GNUTLS_KEY_* elements.
This function will set the key usage flags of the public key. This
is only useful if the key is to be exported to a certificate or
certificate request.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_pubkey_set_pin_function
------------------------------
-- Function: void gnutls_pubkey_set_pin_function (gnutls_pubkey_t KEY,
gnutls_pin_callback_t FN, void * USERDATA)
KEY: A key of type 'gnutls_pubkey_t'
FN: the callback
USERDATA: data associated with the callback
This function will set a callback function to be used when required
to access the object. This function overrides any other global PIN
functions.
Note that this function must be called right after initialization
to have effect.
*Since:* 3.1.0
gnutls_pubkey_set_spki
----------------------
-- Function: int gnutls_pubkey_set_spki (gnutls_pubkey_t PUBKEY, const
gnutls_x509_spki_t SPKI, unsigned int FLAGS)
PUBKEY: a public key of type 'gnutls_pubkey_t'
SPKI: a SubjectPublicKeyInfo structure of type
'gnutls_pubkey_spki_t'
FLAGS: must be zero
This function will set the public key information. The provided
'spki' must be initialized.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.6.0
gnutls_pubkey_verify_data2
--------------------------
-- Function: int gnutls_pubkey_verify_data2 (gnutls_pubkey_t PUBKEY,
gnutls_sign_algorithm_t ALGO, unsigned int FLAGS, const
gnutls_datum_t * DATA, const gnutls_datum_t * SIGNATURE)
PUBKEY: Holds the public key
ALGO: The signature algorithm used
FLAGS: Zero or an OR list of 'gnutls_certificate_verify_flags'
DATA: holds the signed data
SIGNATURE: contains the signature
This function will verify the given signed data, using the
parameters from the certificate.
*Returns:* In case of a verification failure
'GNUTLS_E_PK_SIG_VERIFY_FAILED' is returned, and zero or positive
code on success. For known to be insecure signatures this function
will return 'GNUTLS_E_INSUFFICIENT_SECURITY' unless the flag
'GNUTLS_VERIFY_ALLOW_BROKEN' is specified.
*Since:* 3.0
gnutls_pubkey_verify_hash2
--------------------------
-- Function: int gnutls_pubkey_verify_hash2 (gnutls_pubkey_t KEY,
gnutls_sign_algorithm_t ALGO, unsigned int FLAGS, const
gnutls_datum_t * HASH, const gnutls_datum_t * SIGNATURE)
KEY: Holds the public key
ALGO: The signature algorithm used
FLAGS: Zero or an OR list of 'gnutls_certificate_verify_flags'
HASH: holds the hash digest to be verified
SIGNATURE: contains the signature
This function will verify the given signed digest, using the
parameters from the public key. Note that unlike
'gnutls_privkey_sign_hash()' , this function accepts a signature
algorithm instead of a digest algorithm. You can use
'gnutls_pk_to_sign()' to get the appropriate value.
*Returns:* In case of a verification failure
'GNUTLS_E_PK_SIG_VERIFY_FAILED' is returned, and zero or positive
code on success. For known to be insecure signatures this function
will return 'GNUTLS_E_INSUFFICIENT_SECURITY' unless the flag
'GNUTLS_VERIFY_ALLOW_BROKEN' is specified.
*Since:* 3.0
gnutls_pubkey_verify_params
---------------------------
-- Function: int gnutls_pubkey_verify_params (gnutls_pubkey_t KEY)
KEY: should contain a 'gnutls_pubkey_t' type
This function will verify the private key parameters.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.3.0
gnutls_register_custom_url
--------------------------
-- Function: int gnutls_register_custom_url (const gnutls_custom_url_st
* ST)
ST: A 'gnutls_custom_url_st' structure
Register a custom URL. This will affect the following functions:
'gnutls_url_is_supported()' , 'gnutls_privkey_import_url()' ,
gnutls_pubkey_import_url, 'gnutls_x509_crt_import_url()' and all
functions that depend on them, e.g.,
'gnutls_certificate_set_x509_key_file2()' .
The provided structure and callback functions must be valid
throughout the lifetime of the process. The registration of an
existing URL type will fail with 'GNUTLS_E_INVALID_REQUEST' .
Since GnuTLS 3.5.0 this function can be used to override the
builtin URLs.
This function is not thread safe.
*Returns:* returns zero if the given structure was imported or a
negative value otherwise.
*Since:* 3.4.0
gnutls_system_key_add_x509
--------------------------
-- Function: int gnutls_system_key_add_x509 (gnutls_x509_crt_t CRT,
gnutls_x509_privkey_t PRIVKEY, const char * LABEL, char **
CERT_URL, char ** KEY_URL)
CRT: the certificate to be added
PRIVKEY: the key to be added
LABEL: the friendly name to describe the key
CERT_URL: if non-NULL it will contain an allocated value with the
certificate URL
KEY_URL: if non-NULL it will contain an allocated value with the
key URL
This function will added the given key and certificate pair, to the
system list.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.4.0
gnutls_system_key_delete
------------------------
-- Function: int gnutls_system_key_delete (const char * CERT_URL, const
char * KEY_URL)
CERT_URL: the URL of the certificate
KEY_URL: the URL of the key
This function will delete the key and certificate pair.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.4.0
gnutls_system_key_iter_deinit
-----------------------------
-- Function: void gnutls_system_key_iter_deinit
(gnutls_system_key_iter_t ITER)
ITER: an iterator of system keys
This function will deinitialize the iterator.
*Since:* 3.4.0
gnutls_system_key_iter_get_info
-------------------------------
-- Function: int gnutls_system_key_iter_get_info
(gnutls_system_key_iter_t * ITER, unsigned CERT_TYPE, char **
CERT_URL, char ** KEY_URL, char ** LABEL, gnutls_datum_t *
DER, unsigned int FLAGS)
ITER: an iterator of the system keys (must be set to 'NULL'
initially)
CERT_TYPE: A value of gnutls_certificate_type_t which indicates the
type of certificate to look for
CERT_URL: The certificate URL of the pair (may be 'NULL' )
KEY_URL: The key URL of the pair (may be 'NULL' )
LABEL: The friendly name (if any) of the pair (may be 'NULL' )
DER: if non-NULL the DER data of the certificate
FLAGS: should be zero
This function will return on each call a certificate and key pair
URLs, as well as a label associated with them, and the DER-encoded
certificate. When the iteration is complete it will return
'GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE' .
Typically 'cert_type' should be 'GNUTLS_CRT_X509' .
All values set are allocated and must be cleared using
'gnutls_free()' ,
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 3.4.0
gnutls_x509_crl_privkey_sign
----------------------------
-- Function: int gnutls_x509_crl_privkey_sign (gnutls_x509_crl_t CRL,
gnutls_x509_crt_t ISSUER, gnutls_privkey_t ISSUER_KEY,
gnutls_digest_algorithm_t DIG, unsigned int FLAGS)
CRL: should contain a gnutls_x509_crl_t type
ISSUER: is the certificate of the certificate issuer
ISSUER_KEY: holds the issuer's private key
DIG: The message digest to use. GNUTLS_DIG_SHA256 is the safe
choice unless you know what you're doing.
FLAGS: must be 0
This function will sign the CRL with the issuer's private key, and
will copy the issuer's information into the CRL.
This must be the last step in a certificate CRL since all the
previously set parameters are now signed.
A known limitation of this function is, that a newly-signed CRL
will not be fully functional (e.g., for signature verification),
until it is exported an re-imported.
After GnuTLS 3.6.1 the value of 'dig' may be 'GNUTLS_DIG_UNKNOWN' ,
and in that case, a suitable but reasonable for the key algorithm
will be selected.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
Since 2.12.0
gnutls_x509_crq_privkey_sign
----------------------------
-- Function: int gnutls_x509_crq_privkey_sign (gnutls_x509_crq_t CRQ,
gnutls_privkey_t KEY, gnutls_digest_algorithm_t DIG, unsigned
int FLAGS)
CRQ: should contain a 'gnutls_x509_crq_t' type
KEY: holds a private key
DIG: The message digest to use, i.e., 'GNUTLS_DIG_SHA1'
FLAGS: must be 0
This function will sign the certificate request with a private key.
This must be the same key as the one used in
'gnutls_x509_crt_set_key()' since a certificate request is self
signed.
This must be the last step in a certificate request generation
since all the previously set parameters are now signed.
A known limitation of this function is, that a newly-signed request
will not be fully functional (e.g., for signature verification),
until it is exported an re-imported.
After GnuTLS 3.6.1 the value of 'dig' may be 'GNUTLS_DIG_UNKNOWN' ,
and in that case, a suitable but reasonable for the key algorithm
will be selected.
*Returns:* 'GNUTLS_E_SUCCESS' on success, otherwise a negative
error code. 'GNUTLS_E_ASN1_VALUE_NOT_FOUND' is returned if you
didn't set all information in the certificate request (e.g., the
version using 'gnutls_x509_crq_set_version()' ).
*Since:* 2.12.0
gnutls_x509_crq_set_pubkey
--------------------------
-- Function: int gnutls_x509_crq_set_pubkey (gnutls_x509_crq_t CRQ,
gnutls_pubkey_t KEY)
CRQ: should contain a 'gnutls_x509_crq_t' type
KEY: holds a public key
This function will set the public parameters from the given public
key to the request. The 'key' can be deallocated after that.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
gnutls_x509_crt_privkey_sign
----------------------------
-- Function: int gnutls_x509_crt_privkey_sign (gnutls_x509_crt_t CRT,
gnutls_x509_crt_t ISSUER, gnutls_privkey_t ISSUER_KEY,
gnutls_digest_algorithm_t DIG, unsigned int FLAGS)
CRT: a certificate of type 'gnutls_x509_crt_t'
ISSUER: is the certificate of the certificate issuer
ISSUER_KEY: holds the issuer's private key
DIG: The message digest to use, 'GNUTLS_DIG_SHA256' is a safe
choice
FLAGS: must be 0
This function will sign the certificate with the issuer's private
key, and will copy the issuer's information into the certificate.
This must be the last step in a certificate generation since all
the previously set parameters are now signed.
A known limitation of this function is, that a newly-signed
certificate will not be fully functional (e.g., for signature
verification), until it is exported an re-imported.
After GnuTLS 3.6.1 the value of 'dig' may be 'GNUTLS_DIG_UNKNOWN' ,
and in that case, a suitable but reasonable for the key algorithm
will be selected.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
gnutls_x509_crt_set_pubkey
--------------------------
-- Function: int gnutls_x509_crt_set_pubkey (gnutls_x509_crt_t CRT,
gnutls_pubkey_t KEY)
CRT: should contain a 'gnutls_x509_crt_t' type
KEY: holds a public key
This function will set the public parameters from the given public
key to the certificate. The 'key' can be deallocated after that.
*Returns:* On success, 'GNUTLS_E_SUCCESS' (0) is returned,
otherwise a negative error value.
*Since:* 2.12.0
File: gnutls.info, Node: Socket specific API, Next: DANE API, Prev: Abstract key API, Up: API reference
E.10 Socket specific API
========================
The prototypes for the following functions lie in 'gnutls/socket.h'.
gnutls_transport_set_fastopen
-----------------------------
-- Function: void gnutls_transport_set_fastopen (gnutls_session_t
SESSION, int FD, struct sockaddr * CONNECT_ADDR, socklen_t
CONNECT_ADDRLEN, unsigned int FLAGS)
SESSION: is a 'gnutls_session_t' type.
FD: is the session's socket descriptor
CONNECT_ADDR: is the address we want to connect to
CONNECT_ADDRLEN: is the length of 'connect_addr'
FLAGS: must be zero
Enables TCP Fast Open (TFO) for the specified TLS client session.
That means that TCP connection establishment and the transmission
of the first TLS client hello packet are combined. The peer's
address must be specified in 'connect_addr' and 'connect_addrlen' ,
and the socket specified by 'fd' should not be connected.
TFO only works for TCP sockets of type AF_INET and AF_INET6. If
the OS doesn't support TCP fast open this function will result to
gnutls using 'connect()' transparently during the first write.
*Note:* This function overrides all the transport callback
functions. If this is undesirable, TCP Fast Open must be
implemented on the user callback functions without calling this
function. When using this function, transport callbacks must not
be set, and 'gnutls_transport_set_ptr()' or
'gnutls_transport_set_int()' must not be called.
On GNU/Linux TFO has to be enabled at the system layer, that is in
/proc/sys/net/ipv4/tcp_fastopen, bit 0 has to be set.
This function has no effect on server sessions.
*Since:* 3.5.3