* @buf: a pointer to a structure to hold the peer's name
* @sizeof_buf: holds the size of @buf
*
- * This function will return the name of the given RDN sequence.
- * The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as described
- * in RFC2253.
+ * This function will return the name of the given RDN sequence. The
+ * name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as described in
+ * RFC2253.
*
- * If the provided buffer is not long enough, returns GNUTLS_E_SHORT_MEMORY_BUFFER
- * and &sizeof_buf will be updated.
- * On success 0 is returned.
+ * If the provided buffer is not long enough, returns
+ * GNUTLS_E_SHORT_MEMORY_BUFFER and *sizeof_buf will be updated. On
+ * success 0 is returned.
*
**/
int gnutls_x509_rdn_get(const gnutls_datum_t * idn,
* gnutls_x509_rdn_get_by_oid - This function parses an RDN sequence and returns a string
* @idn: should contain a DER encoded RDN sequence
* @oid: an Object Identifier
- * @indx: In case multiple same OIDs exist in the RDN indicates which to send. Use 0 for the first one.
+ * @indx: In case multiple same OIDs exist in the RDN indicates which
+ * to send. Use 0 for the first one.
* @raw_flag: If non zero then the raw DER data are returned.
* @buf: a pointer to a structure to hold the peer's name
* @sizeof_buf: holds the size of @buf
*
- * This function will return the name of the given Object identifier,
- * of the RDN sequence.
- * The name will be encoded using the rules from RFC2253.
+ * This function will return the name of the given Object identifier,
+ * of the RDN sequence. The name will be encoded using the rules
+ * from RFC2253.
*
- * Returns GNUTLS_E_SHORT_MEMORY_BUFFER and updates &sizeof_buf if the provided buffer is not long enough,
- * and 0 on success.
+ * Returns GNUTLS_E_SHORT_MEMORY_BUFFER and updates *sizeof_buf if
+ * the provided buffer is not long enough, and 0 on success.
*
**/
int gnutls_x509_rdn_get_by_oid(const gnutls_datum_t * idn, const char *oid,
* @oid: a pointer to a structure to hold the peer's name OID
* @sizeof_oid: holds the size of @oid
*
- * This function will return the specified Object identifier,
- * of the RDN sequence.
+ * This function will return the specified Object identifier, of the
+ * RDN sequence.
*
- * Returns GNUTLS_E_SHORT_MEMORY_BUFFER and updates &sizeof_buf if the provided buffer is not long enough,
- * and 0 on success.
+ * Returns GNUTLS_E_SHORT_MEMORY_BUFFER and updates *sizeof_buf if
+ * the provided buffer is not long enough, and 0 on success.
*
**/
int gnutls_x509_rdn_get_oid(const gnutls_datum_t * idn,
* @key: Holds the key
* @format: the format of output params. One of PEM or DER.
* @output_data: will contain a private key PEM or DER encoded
- * @output_data_size: holds the size of output_data (and will be replaced by the actual size of parameters)
+ * @output_data_size: holds the size of output_data (and will be
+ * replaced by the actual size of parameters)
*
- * This function will export the private key to a PKCS1 structure for RSA keys,
- * or an integer sequence for DSA keys. The DSA keys are in the same format
- * with the parameters used by openssl.
+ * This function will export the private key to a PKCS1 structure for
+ * RSA keys, or an integer sequence for DSA keys. The DSA keys are in
+ * the same format with the parameters used by openssl.
*
* If the buffer provided is not long enough to hold the output, then
- * &output_data_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will be returned.
+ * *output_data_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will
+ * be returned.
*
* If the structure is PEM encoded, it will have a header
* of "BEGIN RSA PRIVATE KEY".
*
- * In case of failure a negative value will be returned, and
- * 0 on success.
+ * Return value: In case of failure a negative value will be
+ * returned, and 0 on success.
*
**/
int gnutls_x509_privkey_export(gnutls_x509_privkey_t key,
}
/**
- * gnutls_x509_privkey_get_key_id - This function will return a unique ID of the key's parameters
+ * gnutls_x509_privkey_get_key_id - This function will return a unique ID
+ * of the key's parameters
* @key: Holds the 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 replaced by the actual size of parameters)
+ * @output_data_size: holds the size of output_data (and will be
+ * replaced by the actual size of parameters)
*
* This function will return a unique ID the depends on the public key
* parameters. This ID can be used in checking whether a certificate
* corresponds to the given key.
*
* If the buffer provided is not long enough to hold the output, then
- * &output_data_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will be returned. The output will normally
- * be a SHA-1 hash output, which is 20 bytes.
+ * *output_data_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will
+ * be returned. The output will normally be a SHA-1 hash output,
+ * which is 20 bytes.
*
- * In case of failure a negative value will be returned, and
- * 0 on success.
+ * Return value: In case of failure a negative value will be
+ * returned, and 0 on success.
*
**/
int gnutls_x509_privkey_get_key_id(gnutls_x509_privkey_t key,
* @flags: should be 0 for now
* @data: holds the data to be signed
* @signature: will contain the signature
- * @signature_size: holds the size of signature (and will be replaced by the new size)
+ * @signature_size: holds the size of signature (and will be replaced
+ * by the new size)
*
- * This function will sign the given data using a signature algorithm supported by
- * the private key. Signature algorithms are always used together with a hash functions.
- * Different hash functions may be used for the RSA algorithm, but only
- * SHA-1 for the DSA keys.
+ * This function will sign the given data using a signature algorithm
+ * supported by the private key. Signature algorithms are always used
+ * together with a hash functions. Different hash functions may be
+ * used for the RSA algorithm, but only SHA-1 for the DSA keys.
*
* If the buffer provided is not long enough to hold the output, then
- * &signature_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will be returned.
+ * *signature_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will
+ * be returned.
*
* In case of failure a negative value will be returned, and
* 0 on success.
* @buf: a pointer to a structure to hold the name (may be null)
* @sizeof_buf: initially holds the size of @buf
*
- * This function will copy the name of the Certificate issuer in the provided buffer. The name
- * will be in the form "C=xxxx,O=yyyy,CN=zzzz" as described in RFC2253. The output
- * string will be ASCII or UTF-8 encoded, depending on the certificate data.
+ * This function will copy the name of the Certificate issuer in the
+ * provided buffer. The name will be in the form
+ * "C=xxxx,O=yyyy,CN=zzzz" as described in RFC2253. The output string
+ * will be ASCII or UTF-8 encoded, depending on the certificate data.
*
* If @buf is null then only the size will be filled.
*
- * Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not long enough, and
- * in that case the &sizeof_buf will be updated with the required size.
- * On success 0 is returned.
+ * Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not
+ * long enough, and in that case the *sizeof_buf will be updated with
+ * the required size. On success 0 is returned.
*
**/
int gnutls_x509_crt_get_issuer_dn(gnutls_x509_crt_t cert, char *buf,
* @buf: a pointer to a structure to hold the name (may be null)
* @sizeof_buf: initially holds the size of @buf
*
- * This function will extract the part of the name of the Certificate issuer specified
- * by the given OID. The output will be encoded as described in RFC2253. The output
- * string will be ASCII or UTF-8 encoded, depending on the certificate data.
+ * This function will extract the part of the name of the Certificate
+ * issuer specified by the given OID. The output will be encoded as
+ * described in RFC2253. The output string will be ASCII or UTF-8
+ * encoded, depending on the certificate data.
*
* Some helper macros with popular OIDs can be found in gnutls/x509.h
- * If raw flag is zero, this function will only return known OIDs as text. Other OIDs
- * will be DER encoded, as described in RFC2253 -- in hex format with a '\#' prefix.
- * You can check about known OIDs using gnutls_x509_dn_oid_known().
+ * If raw flag is zero, this function will only return known OIDs as
+ * text. Other OIDs will be DER encoded, as described in RFC2253 --
+ * in hex format with a '\#' prefix. You can check about known OIDs
+ * using gnutls_x509_dn_oid_known().
*
* If @buf is null then only the size will be filled.
*
- * Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not long enough, and
- * in that case the &sizeof_buf will be updated with the required size.
- * On success 0 is returned.
+ * Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not
+ * long enough, and in that case the *sizeof_buf will be updated with
+ * the required size. On success 0 is returned.
*
**/
int gnutls_x509_crt_get_issuer_dn_by_oid(gnutls_x509_crt_t cert,
* @oid: a pointer to a buffer to hold the OID (may be null)
* @sizeof_oid: initially holds the size of @oid
*
- * This function will extract the OIDs of the name of the Certificate issuer specified
- * by the given index.
+ * This function will extract the OIDs of the name of the Certificate
+ * issuer specified by the given index.
*
* If @oid is null then only the size will be filled.
*
- * Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not long enough, and
- * in that case the &sizeof_oid will be updated with the required size.
- * On success 0 is returned.
+ * Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not
+ * long enough, and in that case the *sizeof_oid will be updated with
+ * the required size. On success 0 is returned.
*
**/
int gnutls_x509_crt_get_issuer_dn_oid(gnutls_x509_crt_t cert,
* @buf: a pointer to a structure to hold the name (may be null)
* @sizeof_buf: initially holds the size of @buf
*
- * This function will copy the name of the Certificate in the provided buffer. The name
- * will be in the form "C=xxxx,O=yyyy,CN=zzzz" as described in RFC2253. The output
- * string will be ASCII or UTF-8 encoded, depending on the certificate data.
+ * This function will copy the name of the Certificate in the
+ * provided buffer. The name will be in the form
+ * "C=xxxx,O=yyyy,CN=zzzz" as described in RFC2253. The output string
+ * will be ASCII or UTF-8 encoded, depending on the certificate data.
*
* If @buf is null then only the size will be filled.
*
- * Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not long enough, and
- * in that case the &sizeof_buf will be updated with the required size.
- * On success 0 is returned.
+ * Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not
+ * long enough, and in that case the *sizeof_buf will be updated with
+ * the required size. On success 0 is returned.
*
**/
int gnutls_x509_crt_get_dn(gnutls_x509_crt_t cert, char *buf,
* @buf: a pointer to a structure to hold the name (may be null)
* @sizeof_buf: initially holds the size of @buf
*
- * This function will extract the part of the name of the Certificate subject, specified
- * by the given OID. The output
- * string will be ASCII or UTF-8 encoded, depending on the certificate data.
+ * This function will extract the part of the name of the Certificate
+ * subject, specified by the given OID. The output string will be
+ * ASCII or UTF-8 encoded, depending on the certificate data.
*
* Some helper macros with popular OIDs can be found in gnutls/x509.h
- * If raw flag is zero, this function will only return known OIDs as text. Other OIDs
- * will be DER encoded, as described in RFC2253 -- in hex format with a '\#' prefix.
- * You can check about known OIDs using gnutls_x509_dn_oid_known().
+ * If raw flag is zero, this function will only return known OIDs as
+ * text. Other OIDs will be DER encoded, as described in RFC2253 --
+ * in hex format with a '\#' prefix. You can check about known OIDs
+ * using gnutls_x509_dn_oid_known().
*
* If @buf is null then only the size will be filled.
*
- * Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not long enough, and
- * in that case the &sizeof_buf will be updated with the required size.
- * On success 0 is returned.
+ * Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not
+ * long enough, and in that case the *sizeof_buf will be updated with
+ * the required size. On success 0 is returned.
*
**/
int gnutls_x509_crt_get_dn_by_oid(gnutls_x509_crt_t cert, const char *oid,
* @oid: a pointer to a buffer to hold the OID (may be null)
* @sizeof_oid: initially holds the size of @oid
*
- * This function will extract the OIDs of the name of the Certificate subject specified
- * by the given index.
+ * This function will extract the OIDs of the name of the Certificate
+ * subject specified by the given index.
*
* If oid is null then only the size will be filled.
*
- * Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not long enough, and
- * in that case the &sizeof_oid will be updated with the required size.
- * On success 0 is returned.
+ * Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not
+ * long enough, and in that case the *sizeof_oid will be updated with
+ * the required size. On success 0 is returned.
*
**/
int gnutls_x509_crt_get_dn_oid(gnutls_x509_crt_t cert,
*
* If the buffer is null then only the size will be filled.
*
- * Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not long enough, and
- * in that case the &sizeof_buf will be updated with the required size.
- * On success 0 is returned.
+ * Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not
+ * long enough, and in that case the *sizeof_buf will be updated with
+ * the required size. On success 0 is returned.
*
**/
int gnutls_x509_crt_get_fingerprint(gnutls_x509_crt_t cert,
* @cert: Holds the certificate
* @format: the format of output params. One of PEM or DER.
* @output_data: will contain a certificate PEM or DER encoded
- * @output_data_size: holds the size of output_data (and will be replaced by the actual size of parameters)
+ * @output_data_size: holds the size of output_data (and will be
+ * replaced by the actual size of parameters)
*
* This function will export the certificate to DER or PEM format.
*
* If the buffer provided is not long enough to hold the output, then
- * &output_data_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will be returned.
+ * *output_data_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will
+ * be returned.
*
* If the structure is PEM encoded, it will have a header
* of "BEGIN CERTIFICATE".
*
- * In case of failure a negative value will be returned, and
- * 0 on success.
+ * Return value: In case of failure a negative value will be
+ * returned, and 0 on success.
*
**/
int gnutls_x509_crt_export(gnutls_x509_crt_t cert,
/**
- * gnutls_x509_crt_get_key_id - This function will return a unique ID of the public key's parameters
+ * gnutls_x509_crt_get_key_id - This function will return a unique ID of
+ * the public key's parameters
* @crt: Holds the certificate
* @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 replaced by the actual size of parameters)
+ * @output_data_size: holds the size of output_data (and will be
+ * replaced by the actual size of parameters)
*
* This function will return a unique ID the depends on the public key
* parameters. This ID can be used in checking whether a certificate
* corresponds to the given private key.
*
* If the buffer provided is not long enough to hold the output, then
- * &output_data_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will be returned.
- * The output will normally be a SHA-1 hash output, which is 20 bytes.
+ * *output_data_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will
+ * be returned. The output will normally be a SHA-1 hash output,
+ * which is 20 bytes.
*
- * In case of failure a negative value will be returned, and
- * 0 on success.
+ * Return value: In case of failure a negative value will be
+ * returned, and 0 on success.
*
**/
int gnutls_x509_crt_get_key_id(gnutls_x509_crt_t crt, unsigned int flags,
* @oid: a pointer to a buffer to hold the OID (may be null)
* @sizeof_oid: initially holds the size of @oid
*
- * This function will extract the key purpose OIDs of the Certificate specified
- * by the given index. These are stored in the Extended Key Usage extension (2.5.29.37)
- * See the GNUTLS_KP_* definitions for human readable names.
+ * This function will extract the key purpose OIDs of the Certificate
+ * specified by the given index. These are stored in the Extended Key
+ * Usage extension (2.5.29.37) See the GNUTLS_KP_* definitions for
+ * human readable names.
*
* If @oid is null then only the size will be filled.
*
- * Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not long enough, and
- * in that case the &sizeof_oid will be updated with the required size.
- * On success 0 is returned.
+ * Returns GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not
+ * long enough, and in that case the *sizeof_oid will be updated with
+ * the required size. On success 0 is returned.
*
**/
int gnutls_x509_crt_get_key_purpose_oid(gnutls_x509_crt_t cert,
projects / thirdparty / gnutls.git / commitdiff
