diff options
Diffstat (limited to 'lib/x509')
| -rw-r--r-- | lib/x509/crl.c | 64 | ||||
| -rw-r--r-- | lib/x509/crl_write.c | 16 | ||||
| -rw-r--r-- | lib/x509/crq.c | 74 | ||||
| -rw-r--r-- | lib/x509/dn.c | 4 | ||||
| -rw-r--r-- | lib/x509/extensions.c | 4 | ||||
| -rw-r--r-- | lib/x509/hostname-verify.c | 4 | ||||
| -rw-r--r-- | lib/x509/name_constraints.c | 32 | ||||
| -rw-r--r-- | lib/x509/ocsp.c | 62 | ||||
| -rw-r--r-- | lib/x509/ocsp_output.c | 4 | ||||
| -rw-r--r-- | lib/x509/output.c | 10 | ||||
| -rw-r--r-- | lib/x509/pkcs12.c | 28 | ||||
| -rw-r--r-- | lib/x509/pkcs12_bag.c | 4 | ||||
| -rw-r--r-- | lib/x509/pkcs7.c | 32 | ||||
| -rw-r--r-- | lib/x509/privkey.c | 44 | ||||
| -rw-r--r-- | lib/x509/privkey_openssl.c | 2 | ||||
| -rw-r--r-- | lib/x509/privkey_pkcs8.c | 2 | ||||
| -rw-r--r-- | lib/x509/verify-high.c | 24 | ||||
| -rw-r--r-- | lib/x509/verify-high2.c | 10 | ||||
| -rw-r--r-- | lib/x509/x509.c | 106 | ||||
| -rw-r--r-- | lib/x509/x509_ext.c | 155 | ||||
| -rw-r--r-- | lib/x509/x509_write.c | 6 |
21 files changed, 343 insertions, 344 deletions
diff --git a/lib/x509/crl.c b/lib/x509/crl.c index 3b70d92819..cb9bda5a86 100644 --- a/lib/x509/crl.c +++ b/lib/x509/crl.c @@ -54,7 +54,7 @@ int result; /** * gnutls_x509_crl_init: - * @crl: The structure to be initialized + * @crl: A pointer to the type to be initialized * * This function will initialize a CRL structure. CRL stands for * Certificate Revocation List. A revocation list usually contains @@ -85,7 +85,7 @@ int gnutls_x509_crl_init(gnutls_x509_crl_t * crl) /** * gnutls_x509_crl_deinit: - * @crl: The structure to be deinitialized + * @crl: The data to be deinitialized * * This function will deinitialize a CRL structure. **/ @@ -103,7 +103,7 @@ void gnutls_x509_crl_deinit(gnutls_x509_crl_t crl) /** * gnutls_x509_crl_import: - * @crl: The structure to store the parsed CRL. + * @crl: The data to store the parsed CRL. * @data: The DER or PEM encoded CRL. * @format: One of DER or PEM * @@ -183,7 +183,7 @@ gnutls_x509_crl_import(gnutls_x509_crl_t crl, /** * gnutls_x509_crl_get_issuer_dn: - * @crl: should contain a gnutls_x509_crl_t structure + * @crl: should contain a gnutls_x509_crl_t type * @buf: a pointer to a structure to hold the peer's name (may be null) * @sizeof_buf: initially holds the size of @buf * @@ -215,7 +215,7 @@ gnutls_x509_crl_get_issuer_dn(const gnutls_x509_crl_t crl, char *buf, /** * gnutls_x509_crl_get_issuer_dn_by_oid: - * @crl: should contain a gnutls_x509_crl_t structure + * @crl: should contain a gnutls_x509_crl_t type * @oid: holds an Object Identified in null terminated string * @indx: In case multiple same OIDs exist in the RDN, this specifies which to send. Use (0) to get the first one. * @raw_flag: If non-zero returns the raw DER data of the DN part. @@ -265,9 +265,9 @@ gnutls_x509_crl_get_issuer_dn_by_oid(gnutls_x509_crl_t crl, /** * gnutls_x509_crl_get_dn_oid: - * @crl: should contain a gnutls_x509_crl_t structure + * @crl: should contain a gnutls_x509_crl_t type * @indx: Specifies which DN OID to send. Use (0) to get the first one. - * @oid: a pointer to a structure to hold the name (may be null) + * @oid: a pointer to store the OID (may be null) * @sizeof_oid: initially holds the size of 'oid' * * This function will extract the requested OID of the name of the CRL @@ -295,7 +295,7 @@ gnutls_x509_crl_get_dn_oid(gnutls_x509_crl_t crl, /** * gnutls_x509_crl_get_issuer_dn2: - * @crl: should contain a #gnutls_x509_crl_t structure + * @crl: should contain a #gnutls_x509_crl_t type * @dn: a pointer to a structure to hold the name * * This function will allocate buffer and copy the name of the CRL issuer. @@ -322,7 +322,7 @@ gnutls_x509_crl_get_issuer_dn2(gnutls_x509_crl_t crl, gnutls_datum_t * dn) /** * gnutls_x509_crl_get_signature_algorithm: - * @crl: should contain a #gnutls_x509_crl_t structure + * @crl: should contain a #gnutls_x509_crl_t type * * This function will return a value of the #gnutls_sign_algorithm_t * enumeration that is the signature algorithm. @@ -362,7 +362,7 @@ int gnutls_x509_crl_get_signature_algorithm(gnutls_x509_crl_t crl) /** * gnutls_x509_crl_get_signature: - * @crl: should contain a gnutls_x509_crl_t structure + * @crl: should contain a gnutls_x509_crl_t type * @sig: a pointer where the signature part will be copied (may be null). * @sizeof_sig: initially holds the size of @sig * @@ -416,7 +416,7 @@ gnutls_x509_crl_get_signature(gnutls_x509_crl_t crl, /** * gnutls_x509_crl_get_version: - * @crl: should contain a #gnutls_x509_crl_t structure + * @crl: should contain a #gnutls_x509_crl_t type * * This function will return the version of the specified CRL. * @@ -445,7 +445,7 @@ int gnutls_x509_crl_get_version(gnutls_x509_crl_t crl) /** * gnutls_x509_crl_get_this_update: - * @crl: should contain a #gnutls_x509_crl_t structure + * @crl: should contain a #gnutls_x509_crl_t type * * This function will return the time this CRL was issued. * @@ -464,7 +464,7 @@ time_t gnutls_x509_crl_get_this_update(gnutls_x509_crl_t crl) /** * gnutls_x509_crl_get_next_update: - * @crl: should contain a #gnutls_x509_crl_t structure + * @crl: should contain a #gnutls_x509_crl_t type * * This function will return the time the next CRL will be issued. * This field is optional in a CRL so it might be normal to get an @@ -485,7 +485,7 @@ time_t gnutls_x509_crl_get_next_update(gnutls_x509_crl_t crl) /** * gnutls_x509_crl_get_crt_count: - * @crl: should contain a #gnutls_x509_crl_t structure + * @crl: should contain a #gnutls_x509_crl_t type * * This function will return the number of revoked certificates in the * given CRL. @@ -517,7 +517,7 @@ int gnutls_x509_crl_get_crt_count(gnutls_x509_crl_t crl) /** * gnutls_x509_crl_get_crt_serial: - * @crl: should contain a #gnutls_x509_crl_t structure + * @crl: should contain a #gnutls_x509_crl_t type * @indx: the index of the certificate to extract (starting from 0) * @serial: where the serial number will be copied * @serial_size: initially holds the size of serial @@ -575,9 +575,9 @@ gnutls_x509_crl_get_crt_serial(gnutls_x509_crl_t crl, int indx, /** * gnutls_x509_crl_iter_deinit: - * @iter: The iterator structure to be deinitialized + * @iter: The iterator to be deinitialized * - * This function will deinitialize an iterator structure. + * This function will deinitialize an iterator type. **/ void gnutls_x509_crl_iter_deinit(gnutls_x509_crl_iter_t iter) { @@ -589,7 +589,7 @@ void gnutls_x509_crl_iter_deinit(gnutls_x509_crl_iter_t iter) /** * gnutls_x509_crl_iter_crt_serial: - * @crl: should contain a #gnutls_x509_crl_t structure + * @crl: should contain a #gnutls_x509_crl_t type * @iter: A pointer to an iterator (initially the iterator should be %NULL) * @serial: where the serial number will be copied * @serial_size: initially holds the size of serial @@ -675,7 +675,7 @@ gnutls_x509_crl_iter_crt_serial(gnutls_x509_crl_t crl, /** * gnutls_x509_crl_get_raw_issuer_dn: - * @crl: should contain a gnutls_x509_crl_t structure + * @crl: should contain a gnutls_x509_crl_t type * @dn: will hold the starting point of the DN * * This function will return a pointer to the DER encoded DN structure @@ -761,9 +761,9 @@ gnutls_x509_crl_export2(gnutls_x509_crl_t crl, } /*- - * _gnutls_x509_crl_cpy - This function copies a gnutls_x509_crl_t structure - * @dest: The structure where to copy - * @src: The structure to be copied + * _gnutls_x509_crl_cpy - This function copies a gnutls_x509_crl_t type + * @dest: The data where to copy + * @src: The data to be copied * * This function will copy an X.509 certificate structure. * @@ -839,7 +839,7 @@ _get_authority_key_id(gnutls_x509_crl_t cert, ASN1_TYPE * c2, /** * gnutls_x509_crl_get_authority_key_gn_serial: - * @crl: should contain a #gnutls_x509_crl_t structure + * @crl: should contain a #gnutls_x509_crl_t type * @seq: specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.) * @alt: is the place where the alternative name will be copied to * @alt_size: holds the size of alt. @@ -911,7 +911,7 @@ gnutls_x509_crl_get_authority_key_gn_serial(gnutls_x509_crl_t crl, /** * gnutls_x509_crl_get_authority_key_id: - * @crl: should contain a #gnutls_x509_crl_t structure + * @crl: should contain a #gnutls_x509_crl_t type * @id: The place where the identifier will be copied * @id_size: Holds the size of the result field. * @critical: will be non-zero if the extension is marked as critical @@ -963,7 +963,7 @@ gnutls_x509_crl_get_authority_key_id(gnutls_x509_crl_t crl, void *id, /** * gnutls_x509_crl_get_number: - * @crl: should contain a #gnutls_x509_crl_t structure + * @crl: should contain a #gnutls_x509_crl_t type * @ret: The place where the number will be copied * @ret_size: Holds the size of the result field. * @critical: will be non-zero if the extension is marked as critical @@ -1021,9 +1021,9 @@ gnutls_x509_crl_get_number(gnutls_x509_crl_t crl, void *ret, /** * gnutls_x509_crl_get_extension_oid: - * @crl: should contain a #gnutls_x509_crl_t structure + * @crl: should contain a #gnutls_x509_crl_t type * @indx: Specifies which extension OID to send, use (0) to get the first one. - * @oid: a pointer to a structure to hold the OID (may be null) + * @oid: a pointer to store the OID (may be null) * @sizeof_oid: initially holds the size of @oid * * This function will return the requested extension OID in the CRL. @@ -1060,9 +1060,9 @@ gnutls_x509_crl_get_extension_oid(gnutls_x509_crl_t crl, int indx, /** * gnutls_x509_crl_get_extension_info: - * @crl: should contain a #gnutls_x509_crl_t structure + * @crl: should contain a #gnutls_x509_crl_t type * @indx: Specifies which extension OID to send, use (0) to get the first one. - * @oid: a pointer to a structure to hold the OID + * @oid: a pointer to store the OID * @sizeof_oid: initially holds the maximum size of @oid, on return * holds actual size of @oid. * @critical: output variable with critical flag, may be NULL. @@ -1134,7 +1134,7 @@ gnutls_x509_crl_get_extension_info(gnutls_x509_crl_t crl, int indx, /** * gnutls_x509_crl_get_extension_data: - * @crl: should contain a #gnutls_x509_crl_t structure + * @crl: should contain a #gnutls_x509_crl_t type * @indx: Specifies which extension OID to send. Use (0) to get the first one. * @data: a pointer to a structure to hold the data (may be null) * @sizeof_data: initially holds the size of @oid @@ -1186,7 +1186,7 @@ gnutls_x509_crl_get_extension_data(gnutls_x509_crl_t crl, int indx, /** * gnutls_x509_crl_list_import2: - * @crls: The structures to store the parsed crl list. Must not be initialized. + * @crls: Will contain the parsed crl list. * @size: It will contain the size of the list. * @data: The PEM encoded CRL. * @format: One of DER or PEM. @@ -1248,7 +1248,7 @@ gnutls_x509_crl_list_import2(gnutls_x509_crl_t ** crls, /** * gnutls_x509_crl_list_import: - * @crls: The structures to store the parsed CRLs. Must not be initialized. + * @crls: Indicates where the parsed CRLs will be copied to. Must not be initialized. * @crl_max: Initially must hold the maximum number of crls. It will be updated with the number of crls available. * @data: The PEM encoded CRLs * @format: One of DER or PEM. diff --git a/lib/x509/crl_write.c b/lib/x509/crl_write.c index 24d5bf029d..e87b7dc863 100644 --- a/lib/x509/crl_write.c +++ b/lib/x509/crl_write.c @@ -38,7 +38,7 @@ static void disable_optional_stuff(gnutls_x509_crl_t crl); /** * gnutls_x509_crl_set_version: - * @crl: should contain a gnutls_x509_crl_t structure + * @crl: should contain a gnutls_x509_crl_t type * @version: holds the version number. For CRLv1 crls must be 1. * * This function will set the version of the CRL. This @@ -74,7 +74,7 @@ gnutls_x509_crl_set_version(gnutls_x509_crl_t crl, unsigned int version) /** * gnutls_x509_crl_sign2: - * @crl: should contain a gnutls_x509_crl_t structure + * @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_SHA1 is the safe choice unless you know what you're doing. @@ -132,7 +132,7 @@ gnutls_x509_crl_sign2(gnutls_x509_crl_t crl, gnutls_x509_crt_t issuer, /** * gnutls_x509_crl_sign: - * @crl: should contain a gnutls_x509_crl_t structure + * @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 * @@ -154,7 +154,7 @@ gnutls_x509_crl_sign(gnutls_x509_crl_t crl, gnutls_x509_crt_t issuer, /** * gnutls_x509_crl_set_this_update: - * @crl: should contain a gnutls_x509_crl_t structure + * @crl: should contain a gnutls_x509_crl_t type * @act_time: The actual time * * This function will set the time this CRL was issued. @@ -175,7 +175,7 @@ int gnutls_x509_crl_set_this_update(gnutls_x509_crl_t crl, time_t act_time) /** * gnutls_x509_crl_set_next_update: - * @crl: should contain a gnutls_x509_crl_t structure + * @crl: should contain a gnutls_x509_crl_t type * @exp_time: The actual time * * This function will set the time this CRL will be updated. @@ -195,7 +195,7 @@ int gnutls_x509_crl_set_next_update(gnutls_x509_crl_t crl, time_t exp_time) /** * gnutls_x509_crl_set_crt_serial: - * @crl: should contain a gnutls_x509_crl_t structure + * @crl: should contain a gnutls_x509_crl_t type * @serial: The revoked certificate's serial number * @serial_size: Holds the size of the serial field. * @revocation_time: The time this certificate was revoked @@ -257,7 +257,7 @@ gnutls_x509_crl_set_crt_serial(gnutls_x509_crl_t crl, /** * gnutls_x509_crl_set_crt: - * @crl: should contain a gnutls_x509_crl_t structure + * @crl: should contain a gnutls_x509_crl_t type * @crt: a certificate of type #gnutls_x509_crt_t with the revoked certificate * @revocation_time: The time this certificate was revoked * @@ -443,7 +443,7 @@ gnutls_x509_crl_set_number(gnutls_x509_crl_t crl, /** * gnutls_x509_crl_privkey_sign: - * @crl: should contain a gnutls_x509_crl_t structure + * @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_SHA1 is the safe choice unless you know what you're doing. diff --git a/lib/x509/crq.c b/lib/x509/crq.c index a6be6a5d82..bb7d7abb6f 100644 --- a/lib/x509/crq.c +++ b/lib/x509/crq.c @@ -39,7 +39,7 @@ /** * gnutls_x509_crq_init: - * @crq: The structure to be initialized + * @crq: A pointer to the type to be initialized * * This function will initialize a PKCS#10 certificate request * structure. @@ -71,7 +71,7 @@ int gnutls_x509_crq_init(gnutls_x509_crq_t * crq) /** * gnutls_x509_crq_deinit: - * @crq: The structure to be initialized + * @crq: A pointer to the type to be initialized * * This function will deinitialize a PKCS#10 certificate request * structure. @@ -92,12 +92,12 @@ void gnutls_x509_crq_deinit(gnutls_x509_crq_t crq) /** * gnutls_x509_crq_import: - * @crq: The structure to store the parsed certificate request. + * @crq: The data to store the parsed certificate request. * @data: The DER or PEM encoded certificate. * @format: One of DER or PEM * * This function will convert the given DER or PEM encoded certificate - * request to a #gnutls_x509_crq_t structure. The output will be + * request to a #gnutls_x509_crq_t type. The output will be * stored in @crq. * * If the Certificate is PEM encoded it should have a header of "NEW @@ -161,7 +161,7 @@ gnutls_x509_crq_import(gnutls_x509_crq_t crq, /** * gnutls_x509_crq_get_signature_algorithm: - * @crq: should contain a #gnutls_x509_cr_t structure + * @crq: should contain a #gnutls_x509_cr_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 @@ -180,7 +180,7 @@ int gnutls_x509_crq_get_signature_algorithm(gnutls_x509_crq_t crq) /** * gnutls_x509_crq_get_private_key_usage_period: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @activation: The activation time * @expiration: The expiration time * @critical: the extension status @@ -245,7 +245,7 @@ gnutls_x509_crq_get_private_key_usage_period(gnutls_x509_crq_t crq, /** * gnutls_x509_crq_get_dn: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @buf: a pointer to a structure to hold the name (may be %NULL) * @buf_size: initially holds the size of @buf * @@ -274,7 +274,7 @@ gnutls_x509_crq_get_dn(gnutls_x509_crq_t crq, char *buf, size_t * buf_size) /** * gnutls_x509_crq_get_dn2: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @dn: a pointer to a structure to hold the name * * This function will allocate buffer and copy the name of the Certificate @@ -301,7 +301,7 @@ int gnutls_x509_crq_get_dn2(gnutls_x509_crq_t crq, gnutls_datum_t * dn) /** * gnutls_x509_crq_get_dn_by_oid: - * @crq: should contain a gnutls_x509_crq_t structure + * @crq: should contain a gnutls_x509_crq_t type * @oid: holds an Object Identifier in a null terminated string * @indx: In case multiple same OIDs exist in the RDN, this specifies * which to get. Use (0) to get the first one. @@ -349,7 +349,7 @@ gnutls_x509_crq_get_dn_by_oid(gnutls_x509_crq_t crq, const char *oid, /** * gnutls_x509_crq_get_dn_oid: - * @crq: should contain a gnutls_x509_crq_t structure + * @crq: should contain a gnutls_x509_crq_t type * @indx: Specifies which DN OID to get. Use (0) to get the first one. * @oid: a pointer to a structure to hold the name (may be %NULL) * @sizeof_oid: initially holds the size of @oid @@ -497,7 +497,7 @@ parse_attribute(ASN1_TYPE asn1_struct, /** * gnutls_x509_crq_get_challenge_password: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @pass: will hold a (0)-terminated password string * @pass_size: Initially holds the size of @pass. * @@ -675,7 +675,7 @@ set_attribute(ASN1_TYPE asn, const char *root, /** * gnutls_x509_crq_set_attribute_by_oid: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @oid: holds an Object Identifier in a null-terminated string * @buf: a pointer to a structure that holds the attribute data * @buf_size: holds the size of @buf @@ -712,7 +712,7 @@ gnutls_x509_crq_set_attribute_by_oid(gnutls_x509_crq_t crq, /** * gnutls_x509_crq_get_attribute_by_oid: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @oid: holds an Object Identifier in null-terminated string * @indx: In case multiple same OIDs exist in the attribute list, this * specifies which to get, use (0) to get the first one @@ -754,7 +754,7 @@ gnutls_x509_crq_get_attribute_by_oid(gnutls_x509_crq_t crq, /** * gnutls_x509_crq_set_dn_by_oid: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @oid: holds an Object Identifier in a (0)-terminated string * @raw_flag: must be 0, or 1 if the data are DER encoded * @data: a pointer to the input data @@ -789,7 +789,7 @@ gnutls_x509_crq_set_dn_by_oid(gnutls_x509_crq_t crq, const char *oid, /** * gnutls_x509_crq_set_version: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @version: holds the version number, for v1 Requests must be 1 * * This function will set the version of the certificate request. For @@ -825,7 +825,7 @@ gnutls_x509_crq_set_version(gnutls_x509_crq_t crq, unsigned int version) /** * gnutls_x509_crq_get_version: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * * This function will return the version of the specified Certificate * request. @@ -859,7 +859,7 @@ int gnutls_x509_crq_get_version(gnutls_x509_crq_t crq) /** * gnutls_x509_crq_set_key: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @key: holds a private key * * This function will set the public parameters from the given private @@ -954,7 +954,7 @@ gnutls_x509_crq_get_key_rsa_raw(gnutls_x509_crq_t crq, /** * gnutls_x509_crq_set_key_rsa_raw: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @m: holds the modulus * @e: holds the public exponent * @@ -1020,7 +1020,7 @@ gnutls_x509_crq_set_key_rsa_raw(gnutls_x509_crq_t crq, /** * gnutls_x509_crq_set_challenge_password: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @pass: holds a (0)-terminated password * * This function will set a challenge password to be used when @@ -1065,7 +1065,7 @@ gnutls_x509_crq_set_challenge_password(gnutls_x509_crq_t crq, /** * gnutls_x509_crq_sign2: - * @crq: should contain a #gnutls_x509_crq_t structure + * @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 @@ -1124,7 +1124,7 @@ gnutls_x509_crq_sign2(gnutls_x509_crq_t crq, gnutls_x509_privkey_t key, /** * gnutls_x509_crq_sign: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @key: holds a private key * * This function is the same a gnutls_x509_crq_sign2() with no flags, @@ -1142,7 +1142,7 @@ int gnutls_x509_crq_sign(gnutls_x509_crq_t crq, gnutls_x509_privkey_t key) /** * gnutls_x509_crq_export: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @format: the format of output params. One of PEM or DER. * @output_data: will contain a certificate request PEM or DER encoded * @output_data_size: holds the size of output_data (and will be @@ -1177,7 +1177,7 @@ gnutls_x509_crq_export(gnutls_x509_crq_t crq, /** * gnutls_x509_crq_export2: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @format: the format of output params. One of PEM or DER. * @out: will contain a certificate request PEM or DER encoded * @@ -1208,7 +1208,7 @@ gnutls_x509_crq_export2(gnutls_x509_crq_t crq, /** * gnutls_x509_crq_get_pk_algorithm: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_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 PKCS#10 @@ -1242,7 +1242,7 @@ gnutls_x509_crq_get_pk_algorithm(gnutls_x509_crq_t crq, unsigned int *bits) /** * gnutls_x509_crq_get_attribute_info: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @indx: Specifies which attribute number to get. Use (0) to get the first one. * @oid: a pointer to a structure to hold the OID * @sizeof_oid: initially holds the maximum size of @oid, on return @@ -1297,7 +1297,7 @@ gnutls_x509_crq_get_attribute_info(gnutls_x509_crq_t crq, int indx, /** * gnutls_x509_crq_get_attribute_data: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @indx: Specifies which attribute number to get. Use (0) to get the first one. * @data: a pointer to a structure to hold the data (may be null) * @sizeof_data: initially holds the size of @oid @@ -1350,7 +1350,7 @@ gnutls_x509_crq_get_attribute_data(gnutls_x509_crq_t crq, int indx, /** * gnutls_x509_crq_get_extension_info: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @indx: Specifies which extension number to get. Use (0) to get the first one. * @oid: a pointer to a structure to hold the OID * @sizeof_oid: initially holds the maximum size of @oid, on return @@ -1477,7 +1477,7 @@ gnutls_x509_crq_get_extension_info(gnutls_x509_crq_t crq, int indx, /** * gnutls_x509_crq_get_extension_data: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @indx: Specifies which extension number to get. Use (0) to get the first one. * @data: a pointer to a structure to hold the data (may be null) * @sizeof_data: initially holds the size of @oid @@ -1518,7 +1518,7 @@ gnutls_x509_crq_get_extension_data(gnutls_x509_crq_t crq, int indx, /** * gnutls_x509_crq_get_extension_data2: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @extension_id: An X.509 extension OID. * @indx: Specifies which extension OID to read. Use (0) to get the first one. * @data: will contain the extension DER-encoded data @@ -1616,7 +1616,7 @@ gnutls_x509_crq_get_extension_data2(gnutls_x509_crq_t crq, /** * gnutls_x509_crq_get_key_usage: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @key_usage: where the key usage bits will be stored * @critical: will be non-zero if the extension is marked as critical * @@ -1671,7 +1671,7 @@ gnutls_x509_crq_get_key_usage(gnutls_x509_crq_t crq, /** * gnutls_x509_crq_get_basic_constraints: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @critical: will be non-zero if the extension is marked as critical * @ca: pointer to output integer indicating CA status, may be NULL, * value is 1 if the certificate CA flag is set, 0 otherwise. @@ -1807,7 +1807,7 @@ get_subject_alt_name(gnutls_x509_crq_t crq, /** * gnutls_x509_crq_get_subject_alt_name: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @seq: specifies the sequence number of the alt name, 0 for the * first one, 1 for the second etc. * @ret: is the place where the alternative name will be copied to @@ -1846,7 +1846,7 @@ gnutls_x509_crq_get_subject_alt_name(gnutls_x509_crq_t crq, /** * gnutls_x509_crq_get_subject_alt_othername_oid: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @seq: specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.) * @ret: is the place where the otherName OID will be copied to * @ret_size: holds the size of ret. @@ -1883,7 +1883,7 @@ gnutls_x509_crq_get_subject_alt_othername_oid(gnutls_x509_crq_t crq, /** * gnutls_x509_crq_get_extension_by_oid: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @oid: holds an Object Identifier in a null terminated string * @indx: In case multiple same OIDs exist in the extensions, this * specifies which to get. Use (0) to get the first one. @@ -1943,7 +1943,7 @@ gnutls_x509_crq_get_extension_by_oid(gnutls_x509_crq_t crq, /** * gnutls_x509_crq_get_extension_by_oid2: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @oid: holds an Object Identifier in a null terminated string * @indx: In case multiple same OIDs exist in the extensions, this * specifies which to get. Use (0) to get the first one. @@ -2211,7 +2211,7 @@ gnutls_x509_crq_set_key_usage(gnutls_x509_crq_t crq, unsigned int usage) /** * gnutls_x509_crq_get_key_purpose_oid: - * @crq: should contain a #gnutls_x509_crq_t structure + * @crq: should contain a #gnutls_x509_crq_t type * @indx: This specifies which OID to return, use (0) to get the first one * @oid: a pointer to a buffer to hold the OID (may be %NULL) * @sizeof_oid: initially holds the size of @oid @@ -2493,7 +2493,7 @@ gnutls_x509_crq_get_key_id(gnutls_x509_crq_t crq, unsigned int flags, /** * gnutls_x509_crq_privkey_sign: - * @crq: should contain a #gnutls_x509_crq_t structure + * @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 diff --git a/lib/x509/dn.c b/lib/x509/dn.c index 7d71abcbe7..9166587c54 100644 --- a/lib/x509/dn.c +++ b/lib/x509/dn.c @@ -741,7 +741,7 @@ _gnutls_x509_set_dn_oid(ASN1_TYPE asn1_struct, * gnutls_x509_dn_init: * @dn: the object to be initialized * - * This function initializes a #gnutls_x509_dn_t structure. + * This function initializes a #gnutls_x509_dn_t type. * * The object returned must be deallocated using * gnutls_x509_dn_deinit(). @@ -774,7 +774,7 @@ int gnutls_x509_dn_init(gnutls_x509_dn_t * dn) * @data: should contain a DER encoded RDN sequence * * This function parses an RDN sequence and stores the result to a - * #gnutls_x509_dn_t structure. The structure must have been initialized + * #gnutls_x509_dn_t type. The data must have been initialized * with gnutls_x509_dn_init(). You may use gnutls_x509_dn_get_rdn_ava() to * decode the DN. * diff --git a/lib/x509/extensions.c b/lib/x509/extensions.c index 3f674d8a77..af90dec6c2 100644 --- a/lib/x509/extensions.c +++ b/lib/x509/extensions.c @@ -161,7 +161,7 @@ _gnutls_x509_crt_get_extension(gnutls_x509_crt_t cert, /** * gnutls_x509_crt_get_extension_data2: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @indx: Specifies which extension OID to read. Use (0) to get the first one. * @data: will contain the extension DER-encoded data * @@ -197,7 +197,7 @@ _gnutls_x509_crl_get_extension(gnutls_x509_crl_t crl, /** * gnutls_x509_crl_get_extension_data2: - * @crl: should contain a #gnutls_x509_crl_t structure + * @crl: should contain a #gnutls_x509_crl_t type * @indx: Specifies which extension OID to read. Use (0) to get the first one. * @data: will contain the extension DER-encoded data * diff --git a/lib/x509/hostname-verify.c b/lib/x509/hostname-verify.c index e40aa5dc5a..a9bca262a4 100644 --- a/lib/x509/hostname-verify.c +++ b/lib/x509/hostname-verify.c @@ -29,7 +29,7 @@ /** * gnutls_x509_crt_check_hostname: - * @cert: should contain an gnutls_x509_crt_t structure + * @cert: should contain an gnutls_x509_crt_t type * @hostname: A null terminated string that contains a DNS name * * This function will check if the given certificate's subject matches @@ -93,7 +93,7 @@ static int has_embedded_null(const char *str, unsigned size) /** * gnutls_x509_crt_check_hostname: - * @cert: should contain an gnutls_x509_crt_t structure + * @cert: should contain an gnutls_x509_crt_t type * @hostname: A null terminated string that contains a DNS name * @flags: gnutls_certificate_verify_flags * diff --git a/lib/x509/name_constraints.c b/lib/x509/name_constraints.c index 65ee409eb1..0734283216 100644 --- a/lib/x509/name_constraints.c +++ b/lib/x509/name_constraints.c @@ -130,12 +130,12 @@ int _gnutls_extract_name_constraints(ASN1_TYPE c2, const char *vstr, /** * gnutls_x509_crt_get_name_constraints: - * @crt: should contain a #gnutls_x509_crt_t structure - * @nc: The nameconstraints intermediate structure + * @crt: should contain a #gnutls_x509_crt_t type + * @nc: The nameconstraints intermediate type * @flags: zero or %GNUTLS_NAME_CONSTRAINTS_FLAG_APPEND * @critical: the extension status * - * This function will return an intermediate structure containing + * This function will return an intermediate type containing * the name constraints of the provided CA certificate. That * structure can be used in combination with gnutls_x509_name_constraints_check() * to verify whether a server's name is in accordance with the constraints. @@ -192,9 +192,9 @@ int gnutls_x509_crt_get_name_constraints(gnutls_x509_crt_t crt, /** * gnutls_x509_name_constraints_deinit: - * @nc: The nameconstraints structure + * @nc: The nameconstraints * - * This function will deinitialize a name constraints structure. + * This function will deinitialize a name constraints type. * * Since: 3.3.0 **/ @@ -222,9 +222,9 @@ void gnutls_x509_name_constraints_deinit(gnutls_x509_name_constraints_t nc) /** * gnutls_x509_name_constraints_init: - * @nc: The nameconstraints structure + * @nc: The nameconstraints * - * This function will initialize a name constraints structure. + * This function will initialize a name constraints type. * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value. * @@ -296,7 +296,7 @@ int name_constraints_add(gnutls_x509_name_constraints_t nc, /** * gnutls_x509_name_constraints_add_permitted: - * @nc: The nameconstraints structure + * @nc: The nameconstraints * @type: The type of the constraints * @name: The data of the constraints * @@ -316,7 +316,7 @@ int gnutls_x509_name_constraints_add_permitted(gnutls_x509_name_constraints_t nc /** * gnutls_x509_name_constraints_add_excluded: - * @nc: The nameconstraints structure + * @nc: The nameconstraints * @type: The type of the constraints * @name: The data of the constraints * @@ -336,7 +336,7 @@ int gnutls_x509_name_constraints_add_excluded(gnutls_x509_name_constraints_t nc, /** * gnutls_x509_crt_set_name_constraints: - * @crt: The certificate structure + * @crt: The certificate * @nc: The nameconstraints structure * @critical: whether this extension will be critical * @@ -561,7 +561,7 @@ gnutls_datum_t rname; /** * gnutls_x509_name_constraints_check: - * @nc: the extracted name constraints structure + * @nc: the extracted name constraints * @type: the type of the constraint to check (of type gnutls_x509_subject_alt_name_t) * @name: the name to be checked * @@ -588,7 +588,7 @@ unsigned gnutls_x509_name_constraints_check(gnutls_x509_name_constraints_t nc, /** * gnutls_x509_name_constraints_check_crt: - * @nc: the extracted name constraints structure + * @nc: the extracted name constraints * @type: the type of the constraint to check (of type gnutls_x509_subject_alt_name_t) * @cert: the certificate to be checked * @@ -741,12 +741,12 @@ unsigned found_one; /** * gnutls_x509_name_constraints_get_permitted: - * @nc: the extracted name constraints structure + * @nc: the extracted name constraints * @idx: the index of the constraint * @type: the type of the constraint (of type gnutls_x509_subject_alt_name_t) * @name: the name in the constraint (of the specific type) * - * This function will return an intermediate structure containing + * This function will return an intermediate type containing * the name constraints of the provided CA certificate. That * structure can be used in combination with gnutls_x509_name_constraints_check() * to verify whether a server's name is in accordance with the constraints. @@ -785,12 +785,12 @@ int gnutls_x509_name_constraints_get_permitted(gnutls_x509_name_constraints_t nc /** * gnutls_x509_name_constraints_get_excluded: - * @nc: the extracted name constraints structure + * @nc: the extracted name constraints * @idx: the index of the constraint * @type: the type of the constraint (of type gnutls_x509_subject_alt_name_t) * @name: the name in the constraint (of the specific type) * - * This function will return an intermediate structure containing + * This function will return an intermediate type containing * the name constraints of the provided CA certificate. That * structure can be used in combination with gnutls_x509_name_constraints_check() * to verify whether a server's name is in accordance with the constraints. diff --git a/lib/x509/ocsp.c b/lib/x509/ocsp.c index 937d38a93f..46befc1aec 100644 --- a/lib/x509/ocsp.c +++ b/lib/x509/ocsp.c @@ -50,7 +50,7 @@ typedef struct gnutls_ocsp_resp_int { /** * gnutls_ocsp_req_init: - * @req: The structure to be initialized + * @req: A pointer to the type to be initialized * * This function will initialize an OCSP request structure. * @@ -81,7 +81,7 @@ int gnutls_ocsp_req_init(gnutls_ocsp_req_t * req) /** * gnutls_ocsp_req_deinit: - * @req: The structure to be deinitialized + * @req: The data to be deinitialized * * This function will deinitialize a OCSP request structure. **/ @@ -99,7 +99,7 @@ void gnutls_ocsp_req_deinit(gnutls_ocsp_req_t req) /** * gnutls_ocsp_resp_init: - * @resp: The structure to be initialized + * @resp: A pointer to the type to be initialized * * This function will initialize an OCSP response structure. * @@ -140,7 +140,7 @@ int gnutls_ocsp_resp_init(gnutls_ocsp_resp_t * resp) /** * gnutls_ocsp_resp_deinit: - * @resp: The structure to be deinitialized + * @resp: The data to be deinitialized * * This function will deinitialize a OCSP response structure. **/ @@ -165,7 +165,7 @@ void gnutls_ocsp_resp_deinit(gnutls_ocsp_resp_t resp) /** * gnutls_ocsp_req_import: - * @req: The structure to store the parsed request. + * @req: The data to store the parsed request. * @data: DER encoded OCSP request. * * This function will convert the given DER encoded OCSP request to @@ -211,7 +211,7 @@ gnutls_ocsp_req_import(gnutls_ocsp_req_t req, const gnutls_datum_t * data) /** * gnutls_ocsp_resp_import: - * @resp: The structure to store the parsed response. + * @resp: The data to store the parsed response. * @data: DER encoded OCSP response. * * This function will convert the given DER encoded OCSP response to @@ -362,7 +362,7 @@ int gnutls_ocsp_resp_export(gnutls_ocsp_resp_t resp, gnutls_datum_t * data) /** * gnutls_ocsp_req_get_version: - * @req: should contain a #gnutls_ocsp_req_t structure + * @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. @@ -394,7 +394,7 @@ int gnutls_ocsp_req_get_version(gnutls_ocsp_req_t req) /** * gnutls_ocsp_req_get_cert_id: - * @req: should contain a #gnutls_ocsp_req_t structure + * @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 @@ -508,7 +508,7 @@ gnutls_ocsp_req_get_cert_id(gnutls_ocsp_req_t req, /** * gnutls_ocsp_req_add_cert_id: - * @req: should contain a #gnutls_ocsp_req_t structure + * @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 @@ -621,7 +621,7 @@ gnutls_ocsp_req_add_cert_id(gnutls_ocsp_req_t req, /** * gnutls_ocsp_req_add_cert: - * @req: should contain a #gnutls_ocsp_req_t structure + * @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 @@ -707,7 +707,7 @@ gnutls_ocsp_req_add_cert(gnutls_ocsp_req_t req, /** * gnutls_ocsp_req_get_extension: - * @req: should contain a #gnutls_ocsp_req_t structure + * @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. @@ -792,7 +792,7 @@ gnutls_ocsp_req_get_extension(gnutls_ocsp_req_t req, /** * gnutls_ocsp_req_set_extension: - * @req: should contain a #gnutls_ocsp_req_t structure + * @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 @@ -821,7 +821,7 @@ gnutls_ocsp_req_set_extension(gnutls_ocsp_req_t req, /** * gnutls_ocsp_req_get_nonce: - * @req: should contain a #gnutls_ocsp_req_t structure + * @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 * @@ -868,7 +868,7 @@ gnutls_ocsp_req_get_nonce(gnutls_ocsp_req_t req, /** * gnutls_ocsp_req_set_nonce: - * @req: should contain a #gnutls_ocsp_req_t structure + * @req: should contain a #gnutls_ocsp_req_t type * @critical: critical flag, normally false. * @nonce: the nonce data * @@ -920,7 +920,7 @@ gnutls_ocsp_req_set_nonce(gnutls_ocsp_req_t req, /** * gnutls_ocsp_req_randomize_nonce: - * @req: should contain a #gnutls_ocsp_req_t structure + * @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. @@ -956,7 +956,7 @@ int gnutls_ocsp_req_randomize_nonce(gnutls_ocsp_req_t req) /** * gnutls_ocsp_resp_get_status: - * @resp: should contain a #gnutls_ocsp_resp_t structure + * @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. @@ -998,7 +998,7 @@ int gnutls_ocsp_resp_get_status(gnutls_ocsp_resp_t resp) /** * gnutls_ocsp_resp_get_response: - * @resp: should contain a #gnutls_ocsp_resp_t structure + * @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 * @@ -1055,7 +1055,7 @@ gnutls_ocsp_resp_get_response(gnutls_ocsp_resp_t resp, /** * gnutls_ocsp_resp_get_version: - * @resp: should contain a #gnutls_ocsp_resp_t structure + * @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. @@ -1089,7 +1089,7 @@ int gnutls_ocsp_resp_get_version(gnutls_ocsp_resp_t resp) /** * gnutls_ocsp_resp_get_responder: - * @resp: should contain a #gnutls_ocsp_resp_t structure + * @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 @@ -1152,7 +1152,7 @@ gnutls_ocsp_resp_get_responder(gnutls_ocsp_resp_t resp, /** * gnutls_ocsp_resp_get_responder_by_key: - * @resp: should contain a #gnutls_ocsp_resp_t structure + * @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 * @@ -1228,7 +1228,7 @@ gnutls_ocsp_resp_get_responder_raw_id(gnutls_ocsp_resp_t resp, /** * gnutls_ocsp_resp_get_produced: - * @resp: should contain a #gnutls_ocsp_resp_t structure + * @resp: should contain a #gnutls_ocsp_resp_t type * * This function will return the time when the OCSP response was * signed. @@ -1262,7 +1262,7 @@ time_t gnutls_ocsp_resp_get_produced(gnutls_ocsp_resp_t resp) /** * gnutls_ocsp_resp_check_crt: - * @resp: should contain a #gnutls_ocsp_resp_t structure + * @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 * @@ -1357,7 +1357,7 @@ gnutls_ocsp_resp_check_crt(gnutls_ocsp_resp_t resp, /** * gnutls_ocsp_resp_get_single: - * @resp: should contain a #gnutls_ocsp_resp_t structure + * @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 @@ -1558,7 +1558,7 @@ gnutls_ocsp_resp_get_single(gnutls_ocsp_resp_t resp, /** * gnutls_ocsp_resp_get_extension: - * @resp: should contain a #gnutls_ocsp_resp_t structure + * @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. @@ -1644,7 +1644,7 @@ gnutls_ocsp_resp_get_extension(gnutls_ocsp_resp_t resp, /** * gnutls_ocsp_resp_get_nonce: - * @resp: should contain a #gnutls_ocsp_resp_t structure + * @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 * @@ -1689,7 +1689,7 @@ gnutls_ocsp_resp_get_nonce(gnutls_ocsp_resp_t resp, /** * gnutls_ocsp_resp_get_signature_algorithm: - * @resp: should contain a #gnutls_ocsp_resp_t structure + * @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 @@ -1719,7 +1719,7 @@ int gnutls_ocsp_resp_get_signature_algorithm(gnutls_ocsp_resp_t resp) /** * gnutls_ocsp_resp_get_signature: - * @resp: should contain a #gnutls_ocsp_resp_t structure + * @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. @@ -1749,7 +1749,7 @@ gnutls_ocsp_resp_get_signature(gnutls_ocsp_resp_t resp, /** * gnutls_ocsp_resp_get_certs: - * @resp: should contain a #gnutls_ocsp_resp_t structure + * @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. * @@ -2048,7 +2048,7 @@ static int check_ocsp_purpose(gnutls_x509_crt_t signercert) /** * gnutls_ocsp_resp_verify_direct: - * @resp: should contain a #gnutls_ocsp_resp_t structure + * @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, 0 for now. @@ -2124,8 +2124,8 @@ gnutls_ocsp_resp_verify_direct(gnutls_ocsp_resp_t resp, /** * gnutls_ocsp_resp_verify: - * @resp: should contain a #gnutls_ocsp_resp_t structure - * @trustlist: trust anchors as a #gnutls_x509_trust_list_t structure + * @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, 0 for now. * diff --git a/lib/x509/ocsp_output.c b/lib/x509/ocsp_output.c index 4994dd6b61..8a15975cfe 100644 --- a/lib/x509/ocsp_output.c +++ b/lib/x509/ocsp_output.c @@ -155,7 +155,7 @@ static void print_req(gnutls_buffer_st * str, gnutls_ocsp_req_t req) /** * gnutls_ocsp_req_print: - * @req: The structure to be printed + * @req: The data to be printed * @format: Indicate the format to use * @out: Newly allocated datum with (0) terminated string. * @@ -625,7 +625,7 @@ print_resp(gnutls_buffer_st * str, gnutls_ocsp_resp_t resp, /** * gnutls_ocsp_resp_print: - * @resp: The structure to be printed + * @resp: The data to be printed * @format: Indicate the format to use * @out: Newly allocated datum with (0) terminated string. * diff --git a/lib/x509/output.c b/lib/x509/output.c index ec94ca66e2..135a6bc387 100644 --- a/lib/x509/output.c +++ b/lib/x509/output.c @@ -1661,7 +1661,7 @@ static void print_oneline(gnutls_buffer_st * str, gnutls_x509_crt_t cert) /** * gnutls_x509_crt_print: - * @cert: The structure to be printed + * @cert: The data to be printed * @format: Indicate the format to use * @out: Newly allocated datum with null terminated string. * @@ -2035,7 +2035,7 @@ print_crl(gnutls_buffer_st * str, gnutls_x509_crl_t crl, int notsigned) /** * gnutls_x509_crl_print: - * @crl: The structure to be printed + * @crl: The data to be printed * @format: Indicate the format to use * @out: Newly allocated datum with null terminated string. * @@ -2333,7 +2333,7 @@ static void print_crq_other(gnutls_buffer_st * str, gnutls_x509_crq_t crq) /** * gnutls_x509_crq_print: - * @crq: The structure to be printed + * @crq: The data to be printed * @format: Indicate the format to use * @out: Newly allocated datum with null terminated string. * @@ -2402,7 +2402,7 @@ print_pubkey_other(gnutls_buffer_st * str, gnutls_pubkey_t pubkey, /** * gnutls_pubkey_print: - * @pubkey: The structure to be printed + * @pubkey: The data to be printed * @format: Indicate the format to use * @out: Newly allocated datum with null terminated string. * @@ -2438,7 +2438,7 @@ gnutls_pubkey_print(gnutls_pubkey_t pubkey, /** * gnutls_x509_ext_print: - * @exts: The structures to be printed + * @exts: The data to be printed * @exts_size: the number of available structures * @format: Indicate the format to use * @out: Newly allocated datum with null terminated string. diff --git a/lib/x509/pkcs12.c b/lib/x509/pkcs12.c index 04019f3847..5e4fe11528 100644 --- a/lib/x509/pkcs12.c +++ b/lib/x509/pkcs12.c @@ -138,9 +138,9 @@ int result; /** * gnutls_pkcs12_init: - * @pkcs12: The structure to be initialized + * @pkcs12: A pointer to the type to be initialized * - * This function will initialize a PKCS12 structure. PKCS12 structures + * This function will initialize a PKCS12 type. PKCS12 structures * usually contain lists of X.509 Certificates and X.509 Certificate * revocation lists. * @@ -165,9 +165,9 @@ int gnutls_pkcs12_init(gnutls_pkcs12_t * pkcs12) /** * gnutls_pkcs12_deinit: - * @pkcs12: The structure to be initialized + * @pkcs12: The type to be initialized * - * This function will deinitialize a PKCS12 structure. + * This function will deinitialize a PKCS12 type. **/ void gnutls_pkcs12_deinit(gnutls_pkcs12_t pkcs12) { @@ -182,7 +182,7 @@ void gnutls_pkcs12_deinit(gnutls_pkcs12_t pkcs12) /** * gnutls_pkcs12_import: - * @pkcs12: The structure to store the parsed PKCS12. + * @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 @@ -260,7 +260,7 @@ gnutls_pkcs12_import(gnutls_pkcs12_t pkcs12, /** * gnutls_pkcs12_export: - * @pkcs12: Holds the pkcs12 structure + * @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 @@ -294,7 +294,7 @@ gnutls_pkcs12_export(gnutls_pkcs12_t pkcs12, /** * gnutls_pkcs12_export2: - * @pkcs12: Holds the pkcs12 structure + * @pkcs12: A pkcs12 type * @format: the format of output params. One of PEM or DER. * @out: will contain a structure PEM or DER encoded * @@ -586,7 +586,7 @@ _parse_safe_contents(ASN1_TYPE sc, const char *sc_name, /** * gnutls_pkcs12_get_bag: - * @pkcs12: should contain a gnutls_pkcs12_t structure + * @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 * @@ -726,7 +726,7 @@ static int create_empty_pfx(ASN1_TYPE pkcs12) /** * gnutls_pkcs12_set_bag: - * @pkcs12: should contain a gnutls_pkcs12_t structure + * @pkcs12: should contain a gnutls_pkcs12_t type * @bag: An initialized bag * * This function will insert a Bag into the PKCS12 structure. @@ -849,7 +849,7 @@ int gnutls_pkcs12_set_bag(gnutls_pkcs12_t pkcs12, gnutls_pkcs12_bag_t bag) /** * gnutls_pkcs12_generate_mac2: - * @pkcs12: should contain a gnutls_pkcs12_t structure + * @pkcs12: A pkcs12 type * @mac: the MAC algorithm to use * @pass: The password for the MAC * @@ -980,7 +980,7 @@ int gnutls_pkcs12_generate_mac2(gnutls_pkcs12_t pkcs12, gnutls_mac_algorithm_t m /** * gnutls_pkcs12_generate_mac: - * @pkcs12: should contain a gnutls_pkcs12_t structure + * @pkcs12: A pkcs12 type * @pass: The password for the MAC * * This function will generate a MAC for the PKCS12 structure. @@ -995,7 +995,7 @@ int gnutls_pkcs12_generate_mac(gnutls_pkcs12_t pkcs12, const char *pass) /** * gnutls_pkcs12_verify_mac: - * @pkcs12: should contain a gnutls_pkcs12_t structure + * @pkcs12: should contain a gnutls_pkcs12_t type * @pass: The password for the MAC * * This function will verify the MAC for the PKCS12 structure. @@ -1395,7 +1395,7 @@ static int make_chain(gnutls_x509_crt_t ** chain, unsigned int *chain_len, /** * gnutls_pkcs12_simple_parse: - * @p12: should contain a gnutls_pkcs12_t structure + * @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) @@ -1823,7 +1823,7 @@ gnutls_pkcs12_simple_parse(gnutls_pkcs12_t p12, /** * gnutls_pkcs12_mac_info: - * @pkcs12: The PKCS #12 structure + * @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 diff --git a/lib/x509/pkcs12_bag.c b/lib/x509/pkcs12_bag.c index d7100a7b10..2807b5dd9a 100644 --- a/lib/x509/pkcs12_bag.c +++ b/lib/x509/pkcs12_bag.c @@ -34,7 +34,7 @@ /** * gnutls_pkcs12_bag_init: - * @bag: The structure to be initialized + * @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 @@ -70,7 +70,7 @@ static inline void _pkcs12_bag_free_data(gnutls_pkcs12_bag_t bag) /** * gnutls_pkcs12_bag_deinit: - * @bag: The structure to be initialized + * @bag: A pointer to the type to be initialized * * This function will deinitialize a PKCS12 Bag structure. **/ diff --git a/lib/x509/pkcs7.c b/lib/x509/pkcs7.c index d0adf7c087..b15db8cdf6 100644 --- a/lib/x509/pkcs7.c +++ b/lib/x509/pkcs7.c @@ -144,7 +144,7 @@ static int pkcs7_reinit(gnutls_pkcs7_t pkcs7) /** * gnutls_pkcs7_init: - * @pkcs7: The structure to be initialized + * @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 @@ -171,9 +171,9 @@ int gnutls_pkcs7_init(gnutls_pkcs7_t * pkcs7) /** * gnutls_pkcs7_deinit: - * @pkcs7: The structure to be initialized + * @pkcs7: A pointer to the type to be initialized * - * This function will deinitialize a PKCS7 structure. + * This function will deinitialize a PKCS7 type. **/ void gnutls_pkcs7_deinit(gnutls_pkcs7_t pkcs7) { @@ -188,7 +188,7 @@ void gnutls_pkcs7_deinit(gnutls_pkcs7_t pkcs7) /** * gnutls_pkcs7_import: - * @pkcs7: The structure to store the parsed PKCS7. + * @pkcs7: The data to store the parsed PKCS7. * @data: The DER or PEM encoded PKCS7. * @format: One of DER or PEM * @@ -259,7 +259,7 @@ gnutls_pkcs7_import(gnutls_pkcs7_t pkcs7, const gnutls_datum_t * data, /** * gnutls_pkcs7_get_crt_raw: - * @pkcs7: should contain a gnutls_pkcs7_t structure + * @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) @@ -360,7 +360,7 @@ gnutls_pkcs7_get_crt_raw(gnutls_pkcs7_t pkcs7, /** * gnutls_pkcs7_get_crt_count: - * @pkcs7: should contain a #gnutls_pkcs7_t structure + * @pkcs7: should contain a #gnutls_pkcs7_t type * * This function will return the number of certifcates in the PKCS7 * or RFC2630 certificate set. @@ -401,7 +401,7 @@ int gnutls_pkcs7_get_crt_count(gnutls_pkcs7_t pkcs7) /** * gnutls_pkcs7_export: - * @pkcs7: Holds the pkcs7 structure + * @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 @@ -433,7 +433,7 @@ gnutls_pkcs7_export(gnutls_pkcs7_t pkcs7, /** * gnutls_pkcs7_export2: - * @pkcs7: Holds the pkcs7 structure + * @pkcs7: The pkcs7 type * @format: the format of output params. One of PEM or DER. * @out: will contain a structure PEM or DER encoded * @@ -537,7 +537,7 @@ static int create_empty_signed_data(ASN1_TYPE pkcs7, ASN1_TYPE * sdata) /** * gnutls_pkcs7_set_crt_raw: - * @pkcs7: should contain a #gnutls_pkcs7_t structure + * @pkcs7: The pkcs7 type * @crt: the DER encoded certificate to be added * * This function will add a certificate to the PKCS7 or RFC2630 @@ -626,7 +626,7 @@ gnutls_pkcs7_set_crt_raw(gnutls_pkcs7_t pkcs7, const gnutls_datum_t * crt) /** * gnutls_pkcs7_set_crt: - * @pkcs7: should contain a #gnutls_pkcs7_t structure + * @pkcs7: The pkcs7 type * @crt: the certificate to be copied. * * This function will add a parsed certificate to the PKCS7 or @@ -665,7 +665,7 @@ int gnutls_pkcs7_set_crt(gnutls_pkcs7_t pkcs7, gnutls_x509_crt_t crt) /** * gnutls_pkcs7_delete_crt: - * @pkcs7: should contain a gnutls_pkcs7_t structure + * @pkcs7: The pkcs7 type * @indx: the index of the certificate to delete * * This function will delete a certificate from a PKCS7 or RFC2630 @@ -728,7 +728,7 @@ int gnutls_pkcs7_delete_crt(gnutls_pkcs7_t pkcs7, int indx) /** * gnutls_pkcs7_get_crl_raw: - * @pkcs7: should contain a #gnutls_pkcs7_t structure + * @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 @@ -802,7 +802,7 @@ gnutls_pkcs7_get_crl_raw(gnutls_pkcs7_t pkcs7, /** * gnutls_pkcs7_get_crl_count: - * @pkcs7: should contain a gnutls_pkcs7_t structure + * @pkcs7: The pkcs7 type * * This function will return the number of certifcates in the PKCS7 * or RFC2630 crl set. @@ -843,7 +843,7 @@ int gnutls_pkcs7_get_crl_count(gnutls_pkcs7_t pkcs7) /** * gnutls_pkcs7_set_crl_raw: - * @pkcs7: should contain a #gnutls_pkcs7_t structure + * @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. @@ -921,7 +921,7 @@ gnutls_pkcs7_set_crl_raw(gnutls_pkcs7_t pkcs7, const gnutls_datum_t * crl) /** * gnutls_pkcs7_set_crl: - * @pkcs7: should contain a #gnutls_pkcs7_t structure + * @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 @@ -958,7 +958,7 @@ int gnutls_pkcs7_set_crl(gnutls_pkcs7_t pkcs7, gnutls_x509_crl_t crl) /** * gnutls_pkcs7_delete_crl: - * @pkcs7: should contain a #gnutls_pkcs7_t structure + * @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. diff --git a/lib/x509/privkey.c b/lib/x509/privkey.c index e05d977319..1203ad10c9 100644 --- a/lib/x509/privkey.c +++ b/lib/x509/privkey.c @@ -36,9 +36,9 @@ /** * gnutls_x509_privkey_init: - * @key: The structure to be initialized + * @key: A pointer to the type to be initialized * - * This function will initialize an private key structure. + * This function will initialize a private key type. * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a * negative error value. @@ -68,7 +68,7 @@ void _gnutls_x509_privkey_reinit(gnutls_x509_privkey_t key) /** * gnutls_x509_privkey_deinit: - * @key: The structure to be deinitialized + * @key: The key to be deinitialized * * This function will deinitialize a private key structure. **/ @@ -434,7 +434,7 @@ decode_dsa_key(const gnutls_datum_t * raw_key, gnutls_x509_privkey_t pkey) /** * gnutls_x509_privkey_import: - * @key: The structure to store the parsed key + * @key: The data to store the parsed key * @data: The DER or PEM encoded certificate. * @format: One of DER or PEM * @@ -626,7 +626,7 @@ static int import_pkcs12_privkey(gnutls_x509_privkey_t key, /** * gnutls_x509_privkey_import2: - * @key: The structure to store the parsed key + * @key: The data to store the parsed key * @data: The DER or PEM encoded key. * @format: One of DER or PEM * @password: A password (optional) @@ -716,7 +716,7 @@ gnutls_x509_privkey_import2(gnutls_x509_privkey_t key, /** * gnutls_x509_privkey_import_rsa_raw: - * @key: The structure to store the parsed key + * @key: The data to store the parsed key * @m: holds the modulus * @e: holds the public exponent * @d: holds the private exponent @@ -746,7 +746,7 @@ gnutls_x509_privkey_import_rsa_raw(gnutls_x509_privkey_t key, /** * gnutls_x509_privkey_import_rsa_raw2: - * @key: The structure to store the parsed key + * @key: The data to store the parsed key * @m: holds the modulus * @e: holds the public exponent * @d: holds the private exponent @@ -882,7 +882,7 @@ gnutls_x509_privkey_import_rsa_raw2(gnutls_x509_privkey_t key, /** * gnutls_x509_privkey_import_dsa_raw: - * @key: The structure to store the parsed key + * @key: The data to store the parsed key * @p: holds the p * @q: holds the q * @g: holds the g @@ -969,7 +969,7 @@ gnutls_x509_privkey_import_dsa_raw(gnutls_x509_privkey_t key, /** * gnutls_x509_privkey_import_ecc_raw: - * @key: The structure to store the parsed key + * @key: The data to store the parsed key * @curve: holds the curve * @x: holds the x * @y: holds the y @@ -1038,7 +1038,7 @@ gnutls_x509_privkey_import_ecc_raw(gnutls_x509_privkey_t key, /** * gnutls_x509_privkey_get_pk_algorithm: - * @key: should contain a #gnutls_x509_privkey_t structure + * @key: should contain a #gnutls_x509_privkey_t type * * This function will return the public key algorithm of a private * key. @@ -1058,7 +1058,7 @@ int gnutls_x509_privkey_get_pk_algorithm(gnutls_x509_privkey_t key) /** * gnutls_x509_privkey_get_pk_algorithm2: - * @key: should contain a #gnutls_x509_privkey_t structure + * @key: should contain a #gnutls_x509_privkey_t type * @bits: The number of bits in the public key algorithm * * This function will return the public key algorithm of a private @@ -1179,7 +1179,7 @@ gnutls_x509_privkey_export2(gnutls_x509_privkey_t key, /** * gnutls_x509_privkey_sec_param: - * @key: a key structure + * @key: a key * * This function will return the security parameter appropriate with * this private key. @@ -1202,7 +1202,7 @@ gnutls_sec_param_t gnutls_x509_privkey_sec_param(gnutls_x509_privkey_t key) /** * gnutls_x509_privkey_export_ecc_raw: - * @key: a structure that holds the rsa parameters + * @key: a key * @curve: will hold the curve * @x: will hold the x coordinate * @y: will hold the y coordinate @@ -1233,7 +1233,7 @@ int gnutls_x509_privkey_export_ecc_raw(gnutls_x509_privkey_t key, /** * gnutls_x509_privkey_export_rsa_raw: - * @key: a structure that holds the rsa parameters + * @key: a key * @m: will hold the modulus * @e: will hold the public exponent * @d: will hold the private exponent @@ -1259,7 +1259,7 @@ gnutls_x509_privkey_export_rsa_raw(gnutls_x509_privkey_t key, /** * gnutls_x509_privkey_export_rsa_raw2: - * @key: a structure that holds the rsa parameters + * @key: a key * @m: will hold the modulus * @e: will hold the public exponent * @d: will hold the private exponent @@ -1291,7 +1291,7 @@ gnutls_x509_privkey_export_rsa_raw2(gnutls_x509_privkey_t key, /** * gnutls_x509_privkey_export_dsa_raw: - * @key: a structure that holds the DSA parameters + * @key: a key * @p: will hold the p * @q: will hold the q * @g: will hold the g @@ -1405,7 +1405,7 @@ cleanup: /** * gnutls_x509_privkey_generate: - * @key: should contain a #gnutls_x509_privkey_t structure + * @key: a key * @algo: is one of the algorithms in #gnutls_pk_algorithm_t. * @bits: the size of the modulus * @flags: unused for now. Must be 0. @@ -1487,7 +1487,7 @@ gnutls_x509_privkey_generate(gnutls_x509_privkey_t key, /** * gnutls_x509_privkey_verify_params: - * @key: should contain a #gnutls_x509_privkey_t structure + * @key: a key * * This function will verify the private key parameters. * @@ -1509,7 +1509,7 @@ int gnutls_x509_privkey_verify_params(gnutls_x509_privkey_t key) /** * gnutls_x509_privkey_get_key_id: - * @key: Holds the key + * @key: a key * @flags: should be 0 for now * @output_data: will contain the key ID * @output_data_size: holds the size of output_data (and will be @@ -1615,7 +1615,7 @@ _gnutls_x509_privkey_sign_hash2(gnutls_x509_privkey_t signer, /** * gnutls_x509_privkey_sign_hash: - * @key: Holds the key + * @key: a key * @hash: holds the data to be signed * @signature: will contain newly allocated signature * @@ -1655,7 +1655,7 @@ gnutls_x509_privkey_sign_hash(gnutls_x509_privkey_t key, /** * gnutls_x509_privkey_sign_data: - * @key: Holds the key + * @key: a key * @digest: should be MD5 or SHA1 * @flags: should be 0 for now * @data: holds the data to be signed @@ -1731,7 +1731,7 @@ gnutls_x509_privkey_sign_data(gnutls_x509_privkey_t key, /** * gnutls_x509_privkey_fix: - * @key: Holds the key + * @key: a key * * This function will recalculate the secondary parameters in a key. * In RSA keys, this can be the coefficient and exponent1,2. diff --git a/lib/x509/privkey_openssl.c b/lib/x509/privkey_openssl.c index 97753eab44..c6feb00630 100644 --- a/lib/x509/privkey_openssl.c +++ b/lib/x509/privkey_openssl.c @@ -102,7 +102,7 @@ static const struct pem_cipher pem_ciphers[] = { /** * gnutls_x509_privkey_import_openssl: - * @key: The structure to store the parsed key + * @key: The data to store the parsed key * @data: The DER or PEM encoded key. * @password: the password to decrypt the key (if it is encrypted). * diff --git a/lib/x509/privkey_pkcs8.c b/lib/x509/privkey_pkcs8.c index 0065ae1d6b..d9aed063f7 100644 --- a/lib/x509/privkey_pkcs8.c +++ b/lib/x509/privkey_pkcs8.c @@ -1411,7 +1411,7 @@ error: /** * gnutls_x509_privkey_import_pkcs8: - * @key: The structure to store the parsed key + * @key: The data to store the parsed key * @data: The DER or PEM encoded key. * @format: One of DER or PEM * @password: the password to decrypt the key (if it is encrypted). diff --git a/lib/x509/verify-high.c b/lib/x509/verify-high.c index 96d61a81ac..6e3a4be20e 100644 --- a/lib/x509/verify-high.c +++ b/lib/x509/verify-high.c @@ -69,7 +69,7 @@ struct gnutls_x509_trust_list_iter { /** * gnutls_x509_trust_list_init: - * @list: The structure to be initialized + * @list: A pointer to the type to be initialized * @size: The size of the internal hash table. Use (0) for default size. * * This function will initialize an X.509 trust list structure. @@ -111,7 +111,7 @@ gnutls_x509_trust_list_init(gnutls_x509_trust_list_t * list, /** * gnutls_x509_trust_list_deinit: - * @list: The structure to be deinitialized + * @list: The list to be deinitialized * @all: if non-zero it will deinitialize all the certificates and CRLs contained in the structure. * * This function will deinitialize a trust list. Note that the @@ -250,7 +250,7 @@ trust_list_add_compat(gnutls_x509_trust_list_t list, /** * gnutls_x509_trust_list_add_cas: - * @list: The structure of the list + * @list: The list * @clist: A list of CAs * @clist_size: The length of the CA list * @flags: should be 0 or an or'ed sequence of %GNUTLS_TL options. @@ -386,7 +386,7 @@ advance_iter(gnutls_x509_trust_list_t list, /** * gnutls_x509_trust_list_iter_get_ca: - * @list: The structure of the list + * @list: The list * @iter: A pointer to an iterator (initially the iterator should be %NULL) * @crt: where the certificate will be copied * @@ -539,7 +539,7 @@ int ret; /** * gnutls_x509_trust_list_remove_cas: - * @list: The structure of the list + * @list: The list * @clist: A list of CAs * @clist_size: The length of the CA list * @@ -611,7 +611,7 @@ gnutls_x509_trust_list_remove_cas(gnutls_x509_trust_list_t list, /** * gnutls_x509_trust_list_add_named_crt: - * @list: The structure of the list + * @list: The list * @cert: A certificate * @name: An identifier for the certificate * @name_size: The size of the identifier @@ -676,7 +676,7 @@ gnutls_x509_trust_list_add_named_crt(gnutls_x509_trust_list_t list, /** * gnutls_x509_trust_list_add_crls: - * @list: The structure of the list + * @list: The list * @crl_list: A list of CRLs * @crl_size: The length of the CRL list * @flags: if GNUTLS_TL_VERIFY_CRL is given the CRLs will be verified before being added. @@ -865,7 +865,7 @@ int trust_list_get_issuer_by_dn(gnutls_x509_trust_list_t list, /** * gnutls_x509_trust_list_get_issuer: - * @list: The structure of the list + * @list: The list * @cert: is the certificate to find issuer for * @issuer: Will hold the issuer if any. Should be treated as constant. * @flags: Use zero or %GNUTLS_TL_GET_COPY @@ -940,7 +940,7 @@ int gnutls_x509_trust_list_get_issuer(gnutls_x509_trust_list_t list, /** * gnutls_x509_trust_list_get_issuer_by_dn: - * @list: The structure of the list + * @list: The list * @dn: is the issuer's DN * @issuer: Will hold the issuer if any. Should be treated as constant. * @flags: Use zero @@ -1019,7 +1019,7 @@ unsigned i, j; /** * gnutls_x509_trust_list_verify_crt: - * @list: The structure of the list + * @list: The list * @cert_list: is the certificate list to be verified * @cert_list_size: is the certificate list size * @flags: Flags that may be used to change the verification algorithm. Use OR of the gnutls_certificate_verify_flags enumerations. @@ -1051,7 +1051,7 @@ gnutls_x509_trust_list_verify_crt(gnutls_x509_trust_list_t list, /** * gnutls_x509_trust_list_verify_crt2: - * @list: The structure of the list + * @list: The list * @cert_list: is the certificate list to be verified * @cert_list_size: is the certificate list size * @data: an array of typed data @@ -1265,7 +1265,7 @@ gnutls_x509_trust_list_verify_crt2(gnutls_x509_trust_list_t list, /** * gnutls_x509_trust_list_verify_named_crt: - * @list: The structure of the list + * @list: The list * @cert: is the certificate to be verified * @name: is the certificate's name * @name_size: is the certificate's name size diff --git a/lib/x509/verify-high2.c b/lib/x509/verify-high2.c index 09eefd4000..b7b69c29bf 100644 --- a/lib/x509/verify-high2.c +++ b/lib/x509/verify-high2.c @@ -48,7 +48,7 @@ /** * gnutls_x509_trust_list_add_trust_mem: - * @list: The structure of the list + * @list: The list * @cas: A buffer containing a list of CAs (optional) * @crls: A buffer containing a list of CRLs (optional) * @type: The format of the certificates @@ -119,7 +119,7 @@ gnutls_x509_trust_list_add_trust_mem(gnutls_x509_trust_list_t list, /** * gnutls_x509_trust_list_remove_trust_mem: - * @list: The structure of the list + * @list: The list * @cas: A buffer containing a list of CAs (optional) * @type: The format of the certificates * @@ -282,7 +282,7 @@ int remove_pkcs11_object_url(gnutls_x509_trust_list_t list, const char *url) /** * gnutls_x509_trust_list_add_trust_file: - * @list: The structure of the list + * @list: The list * @ca_file: A file containing a list of CAs (optional) * @crl_file: A file containing a list of CRLs (optional) * @type: The format of the certificates @@ -424,7 +424,7 @@ int load_dir_certs(const char *dirname, /** * gnutls_x509_trust_list_add_trust_dir: - * @list: The structure of the list + * @list: The list * @ca_dir: A directory containing the CAs (optional) * @crl_dir: A directory containing a list of CRLs (optional) * @type: The format of the certificates @@ -470,7 +470,7 @@ gnutls_x509_trust_list_add_trust_dir(gnutls_x509_trust_list_t list, /** * gnutls_x509_trust_list_remove_trust_file: - * @list: The structure of the list + * @list: The list * @ca_file: A file containing a list of CAs * @type: The format of the certificates * diff --git a/lib/x509/x509.c b/lib/x509/x509.c index a8cd8a9a01..75ca8a7e20 100644 --- a/lib/x509/x509.c +++ b/lib/x509/x509.c @@ -60,7 +60,7 @@ static int crt_reinit(gnutls_x509_crt_t crt) /** * gnutls_x509_crt_init: - * @cert: The structure to be initialized + * @cert: A pointer to the type to be initialized * * This function will initialize an X.509 certificate structure. * @@ -97,9 +97,9 @@ int gnutls_x509_crt_init(gnutls_x509_crt_t * cert) } /*- - * _gnutls_x509_crt_cpy - This function copies a gnutls_x509_crt_t structure - * @dest: The structure where to copy - * @src: The structure to be copied + * _gnutls_x509_crt_cpy - This function copies a gnutls_x509_crt_t type + * @dest: The data where to copy + * @src: The data to be copied * * This function will copy an X.509 certificate structure. * @@ -152,7 +152,7 @@ int _gnutls_x509_crt_cpy(gnutls_x509_crt_t dest, gnutls_x509_crt_t src) /** * gnutls_x509_crt_deinit: - * @cert: The structure to be deinitialized + * @cert: The data to be deinitialized * * This function will deinitialize a certificate structure. **/ @@ -234,7 +234,7 @@ static int compare_sig_algorithm(gnutls_x509_crt_t cert) /** * gnutls_x509_crt_import: - * @cert: The structure to store the parsed certificate. + * @cert: The data to store the parsed certificate. * @data: The DER or PEM encoded certificate. * @format: One of DER or PEM * @@ -374,7 +374,7 @@ gnutls_x509_crt_import(gnutls_x509_crt_t cert, /** * gnutls_x509_crt_get_issuer_dn: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @buf: a pointer to a structure to hold the name (may be null) * @buf_size: initially holds the size of @buf * @@ -405,7 +405,7 @@ gnutls_x509_crt_get_issuer_dn(gnutls_x509_crt_t cert, char *buf, /** * gnutls_x509_crt_get_issuer_dn2: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @dn: a pointer to a structure to hold the name * * This function will allocate buffer and copy the name of issuer of the Certificate. @@ -433,7 +433,7 @@ gnutls_x509_crt_get_issuer_dn2(gnutls_x509_crt_t cert, gnutls_datum_t * dn) /** * gnutls_x509_crt_get_issuer_dn_by_oid: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @oid: holds an Object Identified in null terminated string * @indx: In case multiple same OIDs exist in the RDN, this specifies which to send. Use (0) to get the first one. * @raw_flag: If non-zero returns the raw DER data of the DN part. @@ -485,7 +485,7 @@ gnutls_x509_crt_get_issuer_dn_by_oid(gnutls_x509_crt_t cert, /** * gnutls_x509_crt_get_issuer_dn_oid: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @indx: This specifies which OID to return. Use (0) to get the first one. * @oid: a pointer to a buffer to hold the OID (may be null) * @oid_size: initially holds the size of @oid @@ -518,7 +518,7 @@ gnutls_x509_crt_get_issuer_dn_oid(gnutls_x509_crt_t cert, /** * gnutls_x509_crt_get_dn: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @buf: a pointer to a structure to hold the name (may be null) * @buf_size: initially holds the size of @buf * @@ -549,7 +549,7 @@ gnutls_x509_crt_get_dn(gnutls_x509_crt_t cert, char *buf, /** * gnutls_x509_crt_get_dn2: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @dn: a pointer to a structure to hold the name * * This function will allocate buffer and copy the name of the Certificate. @@ -576,7 +576,7 @@ int gnutls_x509_crt_get_dn2(gnutls_x509_crt_t cert, gnutls_datum_t * dn) /** * gnutls_x509_crt_get_dn_by_oid: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @oid: holds an Object Identified in null terminated string * @indx: In case multiple same OIDs exist in the RDN, this specifies which to send. Use (0) to get the first one. * @raw_flag: If non-zero returns the raw DER data of the DN part. @@ -627,7 +627,7 @@ gnutls_x509_crt_get_dn_by_oid(gnutls_x509_crt_t cert, const char *oid, /** * gnutls_x509_crt_get_dn_oid: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @indx: This specifies which OID to return. Use (0) to get the first one. * @oid: a pointer to a buffer to hold the OID (may be null) * @oid_size: initially holds the size of @oid @@ -660,7 +660,7 @@ gnutls_x509_crt_get_dn_oid(gnutls_x509_crt_t cert, /** * gnutls_x509_crt_get_signature_algorithm: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_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 @@ -677,7 +677,7 @@ int gnutls_x509_crt_get_signature_algorithm(gnutls_x509_crt_t cert) /** * gnutls_x509_crt_get_signature: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @sig: a pointer where the signature part will be copied (may be null). * @sig_size: initially holds the size of @sig * @@ -714,7 +714,7 @@ gnutls_x509_crt_get_signature(gnutls_x509_crt_t cert, /** * gnutls_x509_crt_get_version: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * * This function will return the version of the specified Certificate. * @@ -746,7 +746,7 @@ int gnutls_x509_crt_get_version(gnutls_x509_crt_t cert) /** * gnutls_x509_crt_get_activation_time: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * * This function will return the time this Certificate was or will be * activated. @@ -767,7 +767,7 @@ time_t gnutls_x509_crt_get_activation_time(gnutls_x509_crt_t cert) /** * gnutls_x509_crt_get_expiration_time: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * * This function will return the time this Certificate was or will be * expired. @@ -791,7 +791,7 @@ time_t gnutls_x509_crt_get_expiration_time(gnutls_x509_crt_t cert) /** * gnutls_x509_crt_get_private_key_usage_period: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @activation: The activation time * @expiration: The expiration time * @critical: the extension status @@ -845,7 +845,7 @@ gnutls_x509_crt_get_private_key_usage_period(gnutls_x509_crt_t cert, /** * gnutls_x509_crt_get_serial: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @result: The place where the serial number will be copied * @result_size: Holds the size of the result field. * @@ -884,7 +884,7 @@ gnutls_x509_crt_get_serial(gnutls_x509_crt_t cert, void *result, /** * gnutls_x509_crt_get_subject_key_id: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @ret: The place where the identifier will be copied * @ret_size: Holds the size of the result field. * @critical: will be non-zero if the extension is marked as critical (may be null) @@ -951,7 +951,7 @@ inline static int is_type_printable(int type) /** * gnutls_x509_crt_get_authority_key_gn_serial: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @seq: specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.) * @alt: is the place where the alternative name will be copied to * @alt_size: holds the size of alt. @@ -1049,7 +1049,7 @@ gnutls_x509_crt_get_authority_key_gn_serial(gnutls_x509_crt_t cert, /** * gnutls_x509_crt_get_authority_key_id: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @id: The place where the identifier will be copied * @id_size: Holds the size of the id field. * @critical: will be non-zero if the extension is marked as critical (may be null) @@ -1135,7 +1135,7 @@ gnutls_x509_crt_get_authority_key_id(gnutls_x509_crt_t cert, void *id, /** * gnutls_x509_crt_get_pk_algorithm: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_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 an X.509 @@ -1432,7 +1432,7 @@ cleanup: /** * gnutls_x509_crt_get_subject_alt_name: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @seq: specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.) * @san: is the place where the alternative name will be copied to * @san_size: holds the size of san. @@ -1472,7 +1472,7 @@ gnutls_x509_crt_get_subject_alt_name(gnutls_x509_crt_t cert, /** * gnutls_x509_crt_get_issuer_alt_name: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @seq: specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.) * @ian: is the place where the alternative name will be copied to * @ian_size: holds the size of ian. @@ -1515,7 +1515,7 @@ gnutls_x509_crt_get_issuer_alt_name(gnutls_x509_crt_t cert, /** * gnutls_x509_crt_get_subject_alt_name2: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @seq: specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.) * @san: is the place where the alternative name will be copied to * @san_size: holds the size of ret. @@ -1550,7 +1550,7 @@ gnutls_x509_crt_get_subject_alt_name2(gnutls_x509_crt_t cert, /** * gnutls_x509_crt_get_issuer_alt_name2: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @seq: specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.) * @ian: is the place where the alternative name will be copied to * @ian_size: holds the size of ret. @@ -1588,7 +1588,7 @@ gnutls_x509_crt_get_issuer_alt_name2(gnutls_x509_crt_t cert, /** * gnutls_x509_crt_get_subject_alt_othername_oid: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @seq: specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.) * @oid: is the place where the otherName OID will be copied to * @oid_size: holds the size of ret. @@ -1627,7 +1627,7 @@ gnutls_x509_crt_get_subject_alt_othername_oid(gnutls_x509_crt_t cert, /** * gnutls_x509_crt_get_issuer_alt_othername_oid: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @seq: specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.) * @ret: is the place where the otherName OID will be copied to * @ret_size: holds the size of ret. @@ -1668,7 +1668,7 @@ gnutls_x509_crt_get_issuer_alt_othername_oid(gnutls_x509_crt_t cert, /** * gnutls_x509_crt_get_basic_constraints: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @critical: will be non-zero if the extension is marked as critical * @ca: pointer to output integer indicating CA status, may be NULL, * value is 1 if the certificate CA flag is set, 0 otherwise. @@ -1728,7 +1728,7 @@ gnutls_x509_crt_get_basic_constraints(gnutls_x509_crt_t cert, /** * gnutls_x509_crt_get_ca_status: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @critical: will be non-zero if the extension is marked as critical * * This function will return certificates CA status, by reading the @@ -1757,7 +1757,7 @@ gnutls_x509_crt_get_ca_status(gnutls_x509_crt_t cert, /** * gnutls_x509_crt_get_key_usage: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @key_usage: where the key usage bits will be stored * @critical: will be non-zero if the extension is marked as critical * @@ -1811,7 +1811,7 @@ gnutls_x509_crt_get_key_usage(gnutls_x509_crt_t cert, /** * gnutls_x509_crt_get_proxy: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @critical: will be non-zero if the extension is marked as critical * @pathlen: pointer to output integer indicating path length (may be * NULL), non-negative error codes indicate a present pCPathLenConstraint @@ -1887,7 +1887,7 @@ void gnutls_x509_policy_release(struct gnutls_x509_policy_st *policy) /** * gnutls_x509_crt_get_policy: - * @crt: should contain a #gnutls_x509_crt_t structure + * @crt: should contain a #gnutls_x509_crt_t type * @indx: This specifies which policy to return. Use (0) to get the first one. * @policy: A pointer to a policy structure. * @critical: will be non-zero if the extension is marked as critical @@ -1962,7 +1962,7 @@ gnutls_x509_crt_get_policy(gnutls_x509_crt_t crt, int indx, /** * gnutls_x509_crt_get_extension_by_oid: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @oid: holds an Object Identified in null terminated string * @indx: In case multiple same OIDs exist in the extensions, this specifies which to send. Use (0) to get the first one. * @buf: a pointer to a structure to hold the name (may be null) @@ -2022,7 +2022,7 @@ gnutls_x509_crt_get_extension_by_oid(gnutls_x509_crt_t cert, /** * gnutls_x509_crt_get_extension_by_oid2: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @oid: holds an Object Identified in null terminated string * @indx: In case multiple same OIDs exist in the extensions, this specifies which to send. Use (0) to get the first one. * @output: will hold the allocated extension data @@ -2069,7 +2069,7 @@ gnutls_x509_crt_get_extension_by_oid2(gnutls_x509_crt_t cert, /** * gnutls_x509_crt_get_extension_oid: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @indx: Specifies which extension OID to send. Use (0) to get the first one. * @oid: a pointer to a structure to hold the OID (may be null) * @oid_size: initially holds the size of @oid @@ -2108,7 +2108,7 @@ gnutls_x509_crt_get_extension_oid(gnutls_x509_crt_t cert, int indx, /** * gnutls_x509_crt_get_extension_info: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @indx: Specifies which extension OID to send. Use (0) to get the first one. * @oid: a pointer to a structure to hold the OID * @oid_size: initially holds the maximum size of @oid, on return @@ -2181,7 +2181,7 @@ gnutls_x509_crt_get_extension_info(gnutls_x509_crt_t cert, int indx, /** * gnutls_x509_crt_get_extension_data: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @indx: Specifies which extension OID to send. Use (0) to get the first one. * @data: a pointer to a structure to hold the data (may be null) * @sizeof_data: initially holds the size of @data @@ -2236,7 +2236,7 @@ gnutls_x509_crt_get_extension_data(gnutls_x509_crt_t cert, int indx, /** * gnutls_x509_crt_get_raw_issuer_dn: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @dn: will hold the starting point of the DN * * This function will return a pointer to the DER encoded DN structure @@ -2260,7 +2260,7 @@ gnutls_x509_crt_get_raw_issuer_dn(gnutls_x509_crt_t cert, /** * gnutls_x509_crt_get_raw_dn: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @dn: will hold the starting point of the DN * * This function will return a pointer to the DER encoded DN structure and @@ -2290,7 +2290,7 @@ get_dn(gnutls_x509_crt_t cert, const char *whom, gnutls_x509_dn_t * dn) /** * gnutls_x509_crt_get_subject: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @dn: output variable with pointer to uint8_t DN. * * Return the Certificate's Subject DN as a %gnutls_x509_dn_t data type, @@ -2310,7 +2310,7 @@ gnutls_x509_crt_get_subject(gnutls_x509_crt_t cert, gnutls_x509_dn_t * dn) /** * gnutls_x509_crt_get_issuer: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @dn: output variable with pointer to uint8_t DN * * Return the Certificate's Issuer DN as a %gnutls_x509_dn_t data type, @@ -2447,7 +2447,7 @@ gnutls_x509_dn_get_rdn_ava(gnutls_x509_dn_t dn, /** * gnutls_x509_crt_get_fingerprint: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @algo: is a digest algorithm * @buf: a pointer to a structure to hold the fingerprint (may be null) * @buf_size: initially holds the size of @buf @@ -2767,8 +2767,8 @@ _gnutls_x509_crt_check_revocation(gnutls_x509_crt_t cert, /** * gnutls_x509_crt_check_revocation: - * @cert: should contain a #gnutls_x509_crt_t structure - * @crl_list: should contain a list of gnutls_x509_crl_t structures + * @cert: should contain a #gnutls_x509_crt_t type + * @crl_list: should contain a list of gnutls_x509_crl_t types * @crl_list_length: the length of the crl_list * * This function will return check if the given certificate is @@ -2839,7 +2839,7 @@ gnutls_x509_crt_get_preferred_hash_algorithm(gnutls_x509_crt_t crt, /** * gnutls_x509_crt_get_crl_dist_points: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @seq: specifies the sequence number of the distribution point (0 for the first one, 1 for the second etc.) * @san: is the place where the distribution point will be copied to * @san_size: holds the size of ret. @@ -2927,7 +2927,7 @@ gnutls_x509_crt_get_crl_dist_points(gnutls_x509_crt_t cert, /** * gnutls_x509_crt_get_key_purpose_oid: - * @cert: should contain a #gnutls_x509_crt_t structure + * @cert: should contain a #gnutls_x509_crt_t type * @indx: This specifies which OID to return. Use (0) to get the first one. * @oid: a pointer to a buffer to hold the OID (may be null) * @oid_size: initially holds the size of @oid @@ -3152,7 +3152,7 @@ gnutls_x509_crt_get_pk_dsa_raw(gnutls_x509_crt_t crt, /** * gnutls_x509_crt_list_import2: - * @certs: The structures to store the parsed certificate. Must not be initialized. + * @certs: Will hold the parsed certificate list. * @size: It will contain the size of the list. * @data: The PEM encoded certificate. * @format: One of DER or PEM. @@ -3217,7 +3217,7 @@ gnutls_x509_crt_list_import2(gnutls_x509_crt_t ** certs, /** * gnutls_x509_crt_list_import: - * @certs: The structures to store the parsed certificate. Must not be initialized. + * @certs: Indicates where the parsed list will be copied to. Must not be initialized. * @cert_max: Initially must hold the maximum number of certs. It will be updated with the number of certs available. * @data: The PEM encoded certificate. * @format: One of DER or PEM. @@ -3716,7 +3716,7 @@ void gnutls_x509_crt_set_pin_function(gnutls_x509_crt_t crt, * @flags: One of GNUTLS_PKCS11_OBJ_* flags * * This function will import a PKCS 11 certificate directly from a token - * without involving the #gnutls_pkcs11_obj_t structure. This function will + * without involving the #gnutls_pkcs11_obj_t type. This function will * fail if the certificate stored is not of X.509 type. * * Despite its name this function will attempt to import any kind of diff --git a/lib/x509/x509_ext.c b/lib/x509/x509_ext.c index c1f0f2d8cb..bdec2412d0 100644 --- a/lib/x509/x509_ext.c +++ b/lib/x509/x509_ext.c @@ -45,7 +45,7 @@ struct gnutls_subject_alt_names_st { /** * gnutls_subject_alt_names_init: - * @sans: The alternative names structure + * @sans: The alternative names * * This function will initialize an alternative names structure. * @@ -77,7 +77,7 @@ static void subject_alt_names_deinit(gnutls_subject_alt_names_t sans) /** * gnutls_subject_alt_names_deinit: - * @sans: The alternative names structure + * @sans: The alternative names * * This function will deinitialize an alternative names structure. * @@ -91,14 +91,14 @@ void gnutls_subject_alt_names_deinit(gnutls_subject_alt_names_t sans) /** * gnutls_subject_alt_names_get: - * @sans: The alternative names structure + * @sans: The alternative names * @seq: The index of the name to get * @san_type: Will hold the type of the name (of %gnutls_subject_alt_names_t) * @san: The alternative name data (should be treated as constant) * @othername_oid: The object identifier if @san_type is %GNUTLS_SAN_OTHERNAME (should be treated as constant) * * This function will return a specific alternative name as stored in - * the @sans structure. The returned values should be treated as constant + * the @sans type. The returned values should be treated as constant * and valid for the lifetime of @sans. * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, %GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE @@ -163,13 +163,13 @@ int subject_alt_names_set(struct name_st **names, /** * gnutls_subject_alt_names_set: - * @sans: The alternative names structure + * @sans: The alternative names * @san_type: The type of the name (of %gnutls_subject_alt_names_t) * @san: The alternative name data * @othername_oid: The object identifier if @san_type is %GNUTLS_SAN_OTHERNAME * * This function will store the specified alternative name in - * the @sans structure. + * the @sans. * * Returns: On success, %GNUTLS_E_SUCCESS (0), otherwise a negative error value. * @@ -205,13 +205,13 @@ int gnutls_subject_alt_names_set(gnutls_subject_alt_names_t sans, /** * gnutls_x509_ext_import_subject_alt_names: * @ext: The DER-encoded extension data - * @sans: The alternative names structure + * @sans: The alternative names * @flags: should be zero * * This function will export the alternative names in the provided DER-encoded - * SubjectAltName PKIX extension, to a %gnutls_subject_alt_names_t structure. The structure - * must have been initialized. - * + * SubjectAltName PKIX extension, to a %gnutls_subject_alt_names_t type. @sans + * must be initialized. + * * This function will succeed even if there no subject alternative names * in the structure. * @@ -291,7 +291,7 @@ int gnutls_x509_ext_import_subject_alt_names(const gnutls_datum_t * ext, /** * gnutls_x509_ext_export_subject_alt_names: - * @sans: The alternative names structure + * @sans: The alternative names * @ext: The DER-encoded extension data; must be freed using gnutls_free(). * * This function will convert the provided alternative names structure to a @@ -347,18 +347,17 @@ int gnutls_x509_ext_export_subject_alt_names(gnutls_subject_alt_names_t sans, /** * gnutls_x509_ext_import_name_constraints: * @ext: a DER encoded extension - * @nc: The nameconstraints intermediate structure + * @nc: The nameconstraints * @flags: zero or %GNUTLS_NAME_CONSTRAINTS_FLAG_APPEND * - * This function will return an intermediate structure containing + * This function will return an intermediate type containing * the name constraints of the provided NameConstraints extension. That - * structure can be used in combination with gnutls_x509_name_constraints_check() + * can be used in combination with gnutls_x509_name_constraints_check() * to verify whether a server's name is in accordance with the constraints. * * When the @flags is set to %GNUTLS_NAME_CONSTRAINTS_FLAG_APPEND, then if - * the @nc structure is empty - * this function will behave identically as if the flag was not set. - * Otherwise if there are elements in the @nc structure then only the + * the @nc type is empty this function will behave identically as if the flag was not set. + * Otherwise if there are elements in the @nc type then only the * excluded constraints will be appended to the constraints. * * Note that @nc must be initialized prior to calling this function. @@ -418,10 +417,10 @@ int gnutls_x509_ext_import_name_constraints(const gnutls_datum_t * ext, /** * gnutls_x509_ext_export_name_constraints: - * @nc: The nameconstraints structure + * @nc: The nameconstraints * @ext: The DER-encoded extension data; must be freed using gnutls_free(). * - * This function will convert the provided name constraints structure to a + * This function will convert the provided name constraints type to a * DER-encoded PKIX NameConstraints (2.5.29.30) extension. The output data in * @ext will be allocated usin gnutls_malloc(). * @@ -663,9 +662,9 @@ struct gnutls_x509_aki_st { /** * gnutls_x509_aki_init: - * @aki: The authority key ID structure + * @aki: The authority key ID type * - * This function will initialize an authority key ID structure. + * This function will initialize an authority key ID. * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value. * @@ -682,9 +681,9 @@ int gnutls_x509_aki_init(gnutls_x509_aki_t * aki) /** * gnutls_x509_aki_deinit: - * @aki: The authority key identifier structure + * @aki: The authority key identifier type * - * This function will deinitialize an authority key identifier structure. + * This function will deinitialize an authority key identifier. * * Since: 3.3.0 **/ @@ -698,11 +697,11 @@ void gnutls_x509_aki_deinit(gnutls_x509_aki_t aki) /** * gnutls_x509_aki_get_id: - * @aki: The authority key ID structure + * @aki: The authority key ID * @id: Will hold the identifier * * This function will return the key identifier as stored in - * the @aki structure. The identifier should be treated as constant. + * the @aki type. The identifier should be treated as constant. * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, %GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE * if the index is out of bounds, otherwise a negative error value. @@ -720,11 +719,11 @@ int gnutls_x509_aki_get_id(gnutls_x509_aki_t aki, gnutls_datum_t * id) /** * gnutls_x509_aki_set_id: - * @aki: The authority key ID structure + * @aki: The authority key ID * @id: the key identifier * * This function will set the keyIdentifier to be stored in the @aki - * structure. + * type. * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value. * @@ -737,14 +736,14 @@ int gnutls_x509_aki_set_id(gnutls_x509_aki_t aki, const gnutls_datum_t * id) /** * gnutls_x509_aki_set_cert_issuer: - * @aki: The authority key ID structure + * @aki: The authority key ID * @san_type: the type of the name (of %gnutls_subject_alt_names_t), may be null * @san: The alternative name data * @othername_oid: The object identifier if @san_type is %GNUTLS_SAN_OTHERNAME * @serial: The authorityCertSerialNumber number (may be null) * * This function will set the authorityCertIssuer name and the authorityCertSerialNumber - * to be stored in the @aki structure. When storing multiple names, the serial + * to be stored in the @aki type. When storing multiple names, the serial * should be set on the first call, and subsequent calls should use a %NULL serial. * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value. @@ -793,7 +792,7 @@ int gnutls_x509_aki_set_cert_issuer(gnutls_x509_aki_t aki, /** * gnutls_x509_aki_get_cert_issuer: - * @aki: The authority key ID structure + * @aki: The authority key ID * @seq: The index of the name to get * @san_type: Will hold the type of the name (of %gnutls_subject_alt_names_t) * @san: The alternative name data @@ -801,7 +800,7 @@ int gnutls_x509_aki_set_cert_issuer(gnutls_x509_aki_t aki, * @serial: The authorityCertSerialNumber number * * This function will return a specific authorityCertIssuer name as stored in - * the @aki structure, as well as the authorityCertSerialNumber. All the returned + * the @aki type, as well as the authorityCertSerialNumber. All the returned * values should be treated as constant, and may be set to %NULL when are not required. * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, %GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE @@ -847,7 +846,7 @@ int gnutls_x509_aki_get_cert_issuer(gnutls_x509_aki_t aki, unsigned int seq, /** * gnutls_x509_ext_import_authority_key_id: * @ext: a DER encoded extension - * @aki: An initialized authority key identifier structure + * @aki: An initialized authority key identifier type * @flags: should be zero * * This function will return the subject key ID stored in the provided @@ -952,7 +951,7 @@ int gnutls_x509_ext_import_authority_key_id(const gnutls_datum_t * ext, /** * gnutls_x509_ext_export_authority_key_id: - * @aki: An initialized authority key identifier structure + * @aki: An initialized authority key identifier * @ext: The DER-encoded extension data; must be freed using gnutls_free(). * * This function will convert the provided key identifier to a @@ -1644,9 +1643,9 @@ struct gnutls_x509_policies_st { /** * gnutls_x509_policies_init: - * @policies: The authority key ID structure + * @policies: The authority key ID * - * This function will initialize an authority key ID structure. + * This function will initialize an authority key ID type. * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value. * @@ -1663,9 +1662,9 @@ int gnutls_x509_policies_init(gnutls_x509_policies_t * policies) /** * gnutls_x509_policies_deinit: - * @policies: The authority key identifier structure + * @policies: The authority key identifier * - * This function will deinitialize an authority key identifier structure. + * This function will deinitialize an authority key identifier type. * * Since: 3.3.0 **/ @@ -1680,12 +1679,12 @@ void gnutls_x509_policies_deinit(gnutls_x509_policies_t policies) /** * gnutls_x509_policies_get: - * @policies: The policies structure + * @policies: The policies * @seq: The index of the name to get * @policy: Will hold the policy * * This function will return a specific policy as stored in - * the @policies structure. The returned values should be treated as constant + * the @policies type. The returned values should be treated as constant * and valid for the lifetime of @policies. * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, %GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE @@ -1719,12 +1718,12 @@ void _gnutls_x509_policies_erase(gnutls_x509_policies_t policies, /** * gnutls_x509_policies_set: - * @policies: An initialized policies structure + * @policies: An initialized policies * @seq: The index of the name to get * @policy: Contains the policy to set * * This function will store the specified policy in - * the provided @policies structure. + * the provided @policies. * * Returns: On success, %GNUTLS_E_SUCCESS (0), otherwise a negative error value. * @@ -1767,11 +1766,11 @@ int gnutls_x509_policies_set(gnutls_x509_policies_t policies, /** * gnutls_x509_ext_import_policies: * @ext: the DER encoded extension data - * @policies: A pointer to an initialized policies structures. + * @policies: A pointer to an initialized policies. * @flags: should be zero * * This function will extract the certificate policy extension (2.5.29.32) - * and store it the provided structure. + * and store it the provided policies. * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value. * @@ -1973,7 +1972,7 @@ static int encode_user_notice(const gnutls_datum_t * txt, /** * gnutls_x509_ext_export_policies: - * @policies: A pointer to an initialized policies structure. + * @policies: A pointer to an initialized policies. * @ext: The DER-encoded extension data; must be freed using gnutls_free(). * * This function will convert the provided policies, to a certificate policy @@ -2131,9 +2130,9 @@ struct gnutls_x509_crl_dist_points_st { /** * gnutls_x509_crl_dist_points_init: - * @cdp: The CRL distribution points structure + * @cdp: The CRL distribution points * - * This function will initialize a CRL distribution points structure. + * This function will initialize a CRL distribution points type. * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value. * @@ -2150,9 +2149,9 @@ int gnutls_x509_crl_dist_points_init(gnutls_x509_crl_dist_points_t * cdp) /** * gnutls_x509_crl_dist_points_deinit: - * @cdp: The CRL distribution points structure + * @cdp: The CRL distribution points * - * This function will deinitialize a CRL distribution points structure. + * This function will deinitialize a CRL distribution points type. * * Since: 3.3.0 **/ @@ -2169,14 +2168,14 @@ void gnutls_x509_crl_dist_points_deinit(gnutls_x509_crl_dist_points_t cdp) /** * gnutls_x509_crl_dist_points_get: - * @cdp: The CRL distribution points structure + * @cdp: The CRL distribution points * @seq: specifies the sequence number of the distribution point (0 for the first one, 1 for the second etc.) * @type: The name type of the corresponding name (gnutls_x509_subject_alt_name_t) * @san: The distribution point names (to be treated as constant) * @reasons: Revocation reasons. An ORed sequence of flags from %gnutls_x509_crl_reason_flags_t. * * This function retrieves the individual CRL distribution points (2.5.29.31), - * contained in provided structure. + * contained in provided type. * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, %GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE * if the index is out of bounds, otherwise a negative error value. @@ -2231,13 +2230,13 @@ int crl_dist_points_set(gnutls_x509_crl_dist_points_t cdp, /** * gnutls_x509_crl_dist_points_set: - * @cdp: The CRL distribution points structure + * @cdp: The CRL distribution points * @type: The type of the name (of %gnutls_subject_alt_names_t) * @san: The point name data * @reasons: Revocation reasons. An ORed sequence of flags from %gnutls_x509_crl_reason_flags_t. * * This function will store the specified CRL distibution point value - * the @cdp structure. + * the @cdp type. * * Returns: On success, %GNUTLS_E_SUCCESS (0), otherwise a negative error value. * @@ -2267,11 +2266,11 @@ int gnutls_x509_crl_dist_points_set(gnutls_x509_crl_dist_points_t cdp, /** * gnutls_x509_ext_import_crl_dist_points: * @ext: the DER encoded extension data - * @cdp: A pointer to an initialized CRL distribution points structure. + * @cdp: A pointer to an initialized CRL distribution points. * @flags: should be zero * * This function will extract the CRL distribution points extension (2.5.29.31) - * and store it into the provided structure. + * and store it into the provided type. * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value. * @@ -2372,7 +2371,7 @@ int gnutls_x509_ext_import_crl_dist_points(const gnutls_datum_t * ext, /** * gnutls_x509_ext_export_crl_dist_points: - * @cdp: A pointer to an initialized CRL distribution points structure. + * @cdp: A pointer to an initialized CRL distribution points. * @ext: The DER-encoded extension data; must be freed using gnutls_free(). * * This function will convert the provided policies, to a certificate policy @@ -2488,9 +2487,9 @@ struct gnutls_x509_aia_st { /** * gnutls_x509_aia_init: - * @aia: The authority info access structure + * @aia: The authority info access * - * This function will initialize a CRL distribution points structure. + * This function will initialize an authority info access type. * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value. * @@ -2507,9 +2506,9 @@ int gnutls_x509_aia_init(gnutls_x509_aia_t * aia) /** * gnutls_x509_aia_deinit: - * @aia: The authority info access structure + * @aia: The authority info access * - * This function will deinitialize a CRL distribution points structure. + * This function will deinitialize an authority info access type. * * Since: 3.3.0 **/ @@ -2527,13 +2526,13 @@ void gnutls_x509_aia_deinit(gnutls_x509_aia_t aia) /** * gnutls_x509_aia_get: - * @aia: The authority info access structure + * @aia: The authority info access * @seq: specifies the sequence number of the access descriptor (0 for the first one, 1 for the second etc.) * @oid: the type of available data; to be treated as constant. * @san_type: Will hold the type of the name of %gnutls_subject_alt_names_t (may be null). * @san: the access location name; to be treated as constant (may be null). * - * This function reads from the Authority Information Access structure. + * This function reads from the Authority Information Access type. * * The @seq input parameter is used to indicate which member of the * sequence the caller is interested in. The first member is 0, the @@ -2571,14 +2570,14 @@ int gnutls_x509_aia_get(gnutls_x509_aia_t aia, unsigned int seq, /** * gnutls_x509_aia_set: - * @aia: The authority info access structure + * @aia: The authority info access * @oid: the type of data. * @san_type: The type of the name (of %gnutls_subject_alt_names_t) * @san: The alternative name data * @othername_oid: The object identifier if @san_type is %GNUTLS_SAN_OTHERNAME * * This function will store the specified alternative name in - * the @aia structure. + * the @aia type. * * Typically the value for @oid should be %GNUTLS_OID_AD_OCSP, or * %GNUTLS_OID_AD_CAISSUERS. @@ -2678,7 +2677,7 @@ static int parse_aia(ASN1_TYPE c2, gnutls_x509_aia_t aia) /** * gnutls_x509_ext_import_aia: * @ext: The DER-encoded extension data - * @aia: The authority info access structure + * @aia: The authority info access * @flags: should be zero * * This function extracts the Authority Information Access (AIA) @@ -2730,7 +2729,7 @@ int gnutls_x509_ext_import_aia(const gnutls_datum_t * ext, /** * gnutls_x509_ext_export_aia: - * @aia: The authority info access structure + * @aia: The authority info access * @ext: The DER-encoded extension data; must be freed using gnutls_free(). * * This function will DER encode the Authority Information Access (AIA) @@ -2807,9 +2806,9 @@ struct gnutls_x509_key_purposes_st { /** * gnutls_subject_alt_names_init: - * @p: The key purposes structure + * @p: The key purposes * - * This function will initialize an alternative names structure. + * This function will initialize an alternative names type. * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value. * @@ -2837,9 +2836,9 @@ static void key_purposes_deinit(gnutls_x509_key_purposes_t p) /** * gnutls_x509_key_purpose_deinit: - * @p: The key purposes structure + * @p: The key purposes * - * This function will deinitialize an alternative names structure. + * This function will deinitialize a key purposes type. * * Since: 3.3.0 **/ @@ -2851,11 +2850,11 @@ void gnutls_x509_key_purpose_deinit(gnutls_x509_key_purposes_t p) /** * gnutls_x509_key_purpose_set: - * @p: The key purposes structure + * @p: The key purposes * @oid: The object identifier of the key purpose * * This function will store the specified key purpose in the - * purposes structure. + * purposes. * * Returns: On success, %GNUTLS_E_SUCCESS (0), otherwise a negative error value. * @@ -2878,12 +2877,12 @@ int gnutls_x509_key_purpose_set(gnutls_x509_key_purposes_t p, const char *oid) /** * gnutls_x509_key_purpose_get: - * @p: The key purposes structure + * @p: The key purposes * @idx: The index of the key purpose to retrieve * @oid: Will hold the object identifier of the key purpose (to be treated as constant) * * This function will retrieve the specified by the index key purpose in the - * purposes structure. The object identifier will be a null terminated string. + * purposes type. The object identifier will be a null terminated string. * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, %GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE * if the index is out of bounds, otherwise a negative error value. @@ -2904,12 +2903,12 @@ int gnutls_x509_key_purpose_get(gnutls_x509_key_purposes_t p, unsigned idx, gnut /** * gnutls_x509_ext_import_key_purposes: * @ext: The DER-encoded extension data - * @p: The key purposes structure + * @p: The key purposes * @flags: should be zero * * This function will extract the key purposes in the provided DER-encoded - * ExtKeyUsageSyntax PKIX extension, to a %gnutls_x509_key_purposes_t structure. - * The structure must be initialized. + * ExtKeyUsageSyntax PKIX extension, to a %gnutls_x509_key_purposes_t type. + * The data must be initialized. * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value. * @@ -2978,10 +2977,10 @@ int gnutls_x509_ext_import_key_purposes(const gnutls_datum_t * ext, /** * gnutls_x509_ext_export_key_purposes: - * @p: The key purposes structure + * @p: The key purposes * @ext: The DER-encoded extension data; must be freed using gnutls_free(). * - * This function will convert the key purposes structure to a + * This function will convert the key purposes type to a * DER-encoded PKIX ExtKeyUsageSyntax (2.5.29.37) extension. The output data in * @ext will be allocated usin gnutls_malloc(). * diff --git a/lib/x509/x509_write.c b/lib/x509/x509_write.c index ef51a328b1..5ddbc0869d 100644 --- a/lib/x509/x509_write.c +++ b/lib/x509/x509_write.c @@ -113,7 +113,7 @@ gnutls_x509_crt_set_issuer_dn_by_oid(gnutls_x509_crt_t crt, /** * gnutls_x509_crt_set_proxy_dn: - * @crt: a gnutls_x509_crt_t structure with the new proxy cert + * @crt: a gnutls_x509_crt_t type with the new proxy cert * @eecrt: the end entity certificate that will be issuing the proxy * @raw_flag: must be 0, or 1 if the CN is DER encoded * @name: a pointer to the CN name, may be NULL (but MUST then be added later) @@ -1530,8 +1530,8 @@ gnutls_x509_crt_set_authority_info_access(gnutls_x509_crt_t crt, /** * gnutls_x509_crt_set_policy: - * @crt: should contain a #gnutls_x509_crt_t structure - * @policy: A pointer to a policy structure. + * @crt: should contain a #gnutls_x509_crt_t type + * @policy: A pointer to a policy * @critical: use non-zero if the extension is marked as critical * * This function will set the certificate policy extension (2.5.29.32). |