* by an Authority. The revocation lists are always signed with
* the authority's private key.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
*
* If the CRL is PEM encoded it should have a header of "X509 CRL".
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
*
* This function will extract the signature field of a CRL.
*
- * Returns 0 on success, and a negative value on error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value. and a negative value on error.
**/
int
gnutls_x509_crl_get_signature (gnutls_x509_crl_t crl,
* If the structure is PEM encoded, it will have a header
* of "BEGIN X509 CRL".
*
- * Returns 0 on success, and a negative value on failure.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value. and a negative value on failure.
*
**/
int
*
* This function will copy an X.509 certificate structure.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
-*/
int
* must be one for CRL version 1, and so on. The CRLs generated
* by gnutls should have a version number of 2.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
* This must be the last step in a certificate CRL since all
* the previously set parameters are now signed.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
* This function is the same a gnutls_x509_crl_sign2() with no flags, and
* SHA1 as the hash algorithm.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
*
* This function will set the time this CRL was issued.
*
- * Returns 0 on success, or a negative value in case of an error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value. or a negative value in case of an error.
*
**/
int
*
* This function will set the time this CRL will be updated.
*
- * Returns 0 on success, or a negative value in case of an error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value. or a negative value in case of an error.
*
**/
int
*
* This function will set a revoked certificate's serial number to the CRL.
*
- * Returns 0 on success, or a negative value in case of an error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value. or a negative value in case of an error.
*
**/
int
*
* This function will set a revoked certificate's serial number to the CRL.
*
- * Returns 0 on success, or a negative value in case of an error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value. or a negative value in case of an error.
*
**/
int
*
* This function will initialize a PKCS10 certificate request structure.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
*
* If the Certificate is PEM encoded it should have a header of "NEW CERTIFICATE REQUEST".
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
* This function will return the challenge password in the
* request.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
* This function will set the attribute in the certificate request specified
* by the given Object ID. The attribute must be be DER encoded.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
* This function will return the attribute in the certificate request specified
* by the given Object ID. The attribute will be DER encoded.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
* not known (by gnutls) you should properly DER encode your data, and
* call this function with raw_flag set.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
* This function will set the version of the certificate request. For
* version 1 requests this must be one.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
* This function will set the public parameters from the given private key to the
* request. Only RSA keys are currently supported.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
*
* This function will set a challenge password to be used when revoking the request.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
* This function is the same a gnutls_x509_crq_sign2() with no flags, and
* SHA1 as the hash algorithm.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
* usually contain lists of X.509 Certificates and X.509 Certificate
* revocation lists.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
*
* If the PKCS12 is PEM encoded it should have a header of "PKCS12".
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
* @bag: An initialized bag, where the contents of the bag will be copied
*
* This function will return a Bag from the PKCS12 structure.
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
* After the last Bag has been read GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE
* will be returned.
* @bag: An initialized bag
*
* This function will insert a Bag into the PKCS12 structure.
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
* @pass: The password for the MAC
*
* This function will generate a MAC for the PKCS12 structure.
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
* @pass: The password for the MAC
*
* This function will verify the MAC for the PKCS12 structure.
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
* usually contain private keys, lists of X.509 Certificates and X.509 Certificate
* revocation lists.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
* that is stored into the bag. Should not be accessed after the bag
* is deleted.
*
- * Returns 0 on success and a negative error code on error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.and a negative error code on error.
*
**/
int
* element. The key ID will be encoded as a 'Local key identifier' bag attribute,
* which is usually used to distinguish the local private key and the certificate pair.
*
- * Returns 0 on success, or a negative value on error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value. or a negative value on error.
*
**/
int
* This function will return the key ID, of the specified bag element.
* The key ID is usually used to distinguish the local private key and the certificate pair.
*
- * Returns 0 on success, or a negative value on error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value. or a negative value on error.
*
**/
int
* This function will return the friendly name, of the specified bag element.
* The key ID is usually used to distinguish the local private key and the certificate pair.
*
- * Returns 0 on success, or a negative value on error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value. or a negative value on error.
*
**/
int
* element. The name will be encoded as a 'Friendly name' bag attribute,
* which is usually used to set a user name to the local private key and the certificate pair.
*
- * Returns 0 on success, or a negative value on error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value. or a negative value on error.
*
**/
int
* usually contain lists of X.509 Certificates and X.509 Certificate
* revocation lists.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
*
* If the PKCS7 is PEM encoded it should have a header of "PKCS7".
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
* @certificate_size: should hold the size of the certificate
*
* This function will return a certificate of the PKCS7 or RFC2630 certificate set.
- * Returns 0 on success. If the provided buffer is not long enough,
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value. If the provided buffer is not long enough,
* then @certificate_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER is returned.
*
* After the last certificate has been read GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE
* @crt: the DER encoded certificate to be added
*
* This function will add a certificate to the PKCS7 or RFC2630 certificate set.
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
* This function will add a parsed certificate to the PKCS7 or RFC2630 certificate set.
* This is a wrapper function over gnutls_pkcs7_set_crt_raw() .
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
* @crl_size: should hold the size of the crl
*
* This function will return a crl of the PKCS7 or RFC2630 crl set.
- * Returns 0 on success. If the provided buffer is not long enough,
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value. If the provided buffer is not long enough,
* then @crl_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER is returned.
*
* After the last crl has been read GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE
* @crl: the DER encoded crl to be added
*
* This function will add a crl to the PKCS7 or RFC2630 crl set.
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
* @crl: the DER encoded crl to be added
*
* This function will add a parsed crl to the PKCS7 or RFC2630 crl set.
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
* or "PRIVATE KEY". You only need to specify the flags if the key is DER encoded, since
* in that case the encryption status cannot be auto-detected.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
* This function will sign a CRL or a certificate with the issuer's private key, and
* will copy the issuer's information into the CRL or certificate.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
-*/
int
*
* GNUTLS_CERT_REVOKED: a certificate in the chain has been revoked.
*
- * Returns 0 on success and a negative value in case of an error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.and a negative value in case of an error.
*
**/
int
* This function will try to verify the given certificate and return its status.
* The verification output in this functions cannot be GNUTLS_CERT_NOT_VALID.
*
- * Returns 0 on success and a negative value in case of an error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.and a negative value in case of an error.
*
**/
int
* See gnutls_x509_crt_list_verify() for a detailed description of
* return values.
*
- * Returns 0 on success and a negative value in case of an error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.and a negative value in case of an error.
*
**/
int
*
* This function will initialize an X.509 certificate structure.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
*
* This function will copy an X.509 certificate structure.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
-*/
int
* If the Certificate is PEM encoded it should have a header of "X509 CERTIFICATE", or
* "CERTIFICATE".
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
*
* This function will extract the signature field of a certificate.
*
- * Returns 0 on success, and a negative value on error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value. and a negative value on error.
**/
int
gnutls_x509_crt_get_signature (gnutls_x509_crt_t cert,
* large serial numbers, thus it may be wise to handle it as something
* opaque.
*
- * Returns 0 on success and a negative value in case of an error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.and a negative value in case of an error.
*
**/
int
* This is obtained by the X.509 Subject Key identifier extension
* field (2.5.29.14).
*
- * Returns 0 on success and a negative value in case of an error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.and a negative value in case of an error.
*
**/
int
* field (2.5.29.35). Note that this function only returns the keyIdentifier
* field of the extension.
*
- * Returns 0 on success and a negative value in case of an error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.and a negative value in case of an error.
*
**/
int
* This function will return a pointer to the DER encoded DN structure
* and the length.
*
- * Returns 0 on success or a negative value on error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.or a negative value on error.
*
**/
int
* This function will return a pointer to the DER encoded DN structure and
* the length.
*
- * Returns 0 on success, or a negative value on error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value. or a negative value on error.
*
**/
int
* not known (by gnutls) you should properly DER encode your data,
* and call this function with @raw_flag set.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
**/
int
gnutls_x509_crt_set_dn_by_oid (gnutls_x509_crt_t crt, const char *oid,
* operation will copy the signer's name as the issuer of the
* certificate.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
**/
int
gnutls_x509_crt_set_issuer_dn_by_oid (gnutls_x509_crt_t crt,
* certificate naming style. Note that if @name is %NULL, you MUST
* set it later by using gnutls_x509_crt_set_dn_by_oid() or similar.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
**/
int
gnutls_x509_crt_set_proxy_dn (gnutls_x509_crt_t crt,gnutls_x509_crt_t eecrt,
* functions such as gnutls_x509_crt_set_subject_alternative_name()
* or gnutls_x509_crt_set_key_usage().
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
**/
int
gnutls_x509_crt_set_version (gnutls_x509_crt_t crt, unsigned int version)
* private key to the certificate. Only RSA keys are currently
* supported.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
*
**/
int
* given certificate request to the certificate. Only RSA keys are
* currently supported.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
**/
int
gnutls_x509_crt_set_crq (gnutls_x509_crt_t crt, gnutls_x509_crq_t crq)
* the certificate. The extension data should be binary data DER
* encoded.
*
- * Returns 0 on success and a negative value in case of an error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.and a negative value in case of an error.
**/
int
gnutls_x509_crt_set_extension_by_oid (gnutls_x509_crt_t crt,
*
* This function will set the basicConstraints certificate extension.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
**/
int
gnutls_x509_crt_set_basic_constraints (gnutls_x509_crt_t crt,
* Use gnutls_x509_crt_set_basic_constraints() if you want to control
* the pathLenConstraint field too.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
**/
int
gnutls_x509_crt_set_ca_status (gnutls_x509_crt_t crt, unsigned int ca)
*
* This function will set the keyUsage certificate extension.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
**/
int
gnutls_x509_crt_set_key_usage (gnutls_x509_crt_t crt, unsigned int usage)
* This function will set the subject alternative name certificate
* extension.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
**/
int
gnutls_x509_crt_set_subject_alternative_name (gnutls_x509_crt_t crt,
*
* This function will set the proxyCertInfo extension.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
**/
int
gnutls_x509_crt_set_proxy (gnutls_x509_crt_t crt,
* This must be the last step in a certificate generation since all
* the previously set parameters are now signed.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
**/
int
gnutls_x509_crt_sign2 (gnutls_x509_crt_t crt, gnutls_x509_crt_t issuer,
* This function is the same a gnutls_x509_crt_sign2() with no flags,
* and SHA1 as the hash algorithm.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
**/
int
gnutls_x509_crt_sign (gnutls_x509_crt_t crt, gnutls_x509_crt_t issuer,
* This function will set the time this Certificate was or will be
* activated.
*
- * Returns 0 on success, or a negative value in case of an error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value. or a negative value in case of an error.
**/
int
gnutls_x509_crt_set_activation_time (gnutls_x509_crt_t cert, time_t act_time)
*
* This function will set the time this Certificate will expire.
*
- * Returns 0 on success, or a negative value in case of an error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value. or a negative value in case of an error.
**/
int
gnutls_x509_crt_set_expiration_time (gnutls_x509_crt_t cert, time_t exp_time)
* serial numbers, thus it may be wise to handle it as something
* opaque.
*
- * Returns 0 on success, or a negative value in case of an error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value. or a negative value in case of an error.
**/
int
gnutls_x509_crt_set_serial (gnutls_x509_crt_t cert, const void *serial,
*
* This function will set the CRL distribution points certificate extension.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
**/
int
gnutls_x509_crt_set_crl_dist_points (gnutls_x509_crt_t crt,
* extension, from the source to the destination certificate.
* This may be useful to copy from a CA certificate to issued ones.
*
- * Returns 0 on success.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value.
**/
int
gnutls_x509_crt_cpy_crl_dist_points (gnutls_x509_crt_t dst,
* This function will set the X.509 certificate's subject key ID
* extension.
*
- * Returns 0 on success, or a negative value in case of an error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value. or a negative value in case of an error.
**/
int
gnutls_x509_crt_set_subject_key_id (gnutls_x509_crt_t cert,
* This function will set the X.509 certificate's authority key ID extension.
* Only the keyIdentifier field can be set with this function.
*
- * Returns 0 on success, or a negative value in case of an error.
+ * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
+ * negative error value. or a negative value in case of an error.
**/
int
gnutls_x509_crt_set_authority_key_id (gnutls_x509_crt_t cert,
projects / thirdparty / gnutls.git / commitdiff
