}
/**
- * gnutls_srp_base64_encode - Encode raw data using SRP-Base64
+ * gnutls_srp_base64_encode:
* @data: contain the raw data
* @result: the place where base64 data will be copied
* @result_size: holds the size of the result
}
/**
- * gnutls_srp_base64_encode_alloc - encode raw data using SRP-Base64
+ * gnutls_srp_base64_encode_alloc:
* @data: contains the raw data
* @result: will hold the newly allocated encoded data
*
}
/**
- * gnutls_srp_base64_decode - decode SRP-base64 encoded data
+ * gnutls_srp_base64_decode:
* @b64_data: contain the encoded data
* @result: the place where decoded data will be copied
* @result_size: holds the size of the result
}
/**
- * gnutls_srp_base64_decode_alloc - decode SRP-base64 encoded data
+ * gnutls_srp_base64_decode_alloc:
* @b64_data: contains the encoded data
* @result: the place where decoded data lie
*
#include <crypto.h>
/**
- * gnutls_cipher_init - initializes a crypto context
+ * gnutls_cipher_init:
* @handle: is a #gnutls_cipher_hd_t structure.
* @cipher: the encryption algorithm to use
* @key: The key to be used for encryption
* Returns: Zero or a negative value on error.
**/
int
-gnutls_cipher_init (gnutls_cipher_hd_t * handle, gnutls_cipher_algorithm_t cipher,
- const gnutls_datum_t * key, const gnutls_datum_t * iv)
+gnutls_cipher_init (gnutls_cipher_hd_t * handle,
+ gnutls_cipher_algorithm_t cipher,
+ const gnutls_datum_t * key,
+ const gnutls_datum_t * iv)
{
*handle = gnutls_malloc(sizeof(cipher_hd_st));
if (*handle == NULL) {
}
/**
- * gnutls_cipher_encrypt - encrypts the given data
+ * gnutls_cipher_encrypt:
* @handle: is a #gnutls_cipher_hd_t structure.
* @text: the data to encrypt
* @textlen: The length of data to encrypt
}
/**
- * gnutls_cipher_decrypt - decrypts the given data
+ * gnutls_cipher_decrypt:
* @handle: is a #gnutls_cipher_hd_t structure.
- * @text: the data to encrypt
- * @textlen: The length of data to encrypt
+ * @ciphertext: the data to encrypt
+ * @ciphertextlen: The length of data to encrypt
*
* This function will decrypt the given data using the algorithm
* specified by the context.
gnutls_cipher_decrypt (gnutls_cipher_hd_t handle, void *ciphertext,
int ciphertextlen)
{
- return _gnutls_cipher_decrypt((cipher_hd_st*)handle, ciphertext, ciphertextlen);
+ return _gnutls_cipher_decrypt((cipher_hd_st*)handle, ciphertext,
+ ciphertextlen);
}
/**
- * gnutls_cipher_deinit - deinitializes resources by a context
+ * gnutls_cipher_deinit:
* @handle: is a #gnutls_cipher_hd_t structure.
*
- * This function will deinitialize all resources occupied by
- * the given encryption context.
- *
- * Returns: This function has no return value.
+ * This function will deinitialize all resources occupied by the given
+ * encryption context.
**/
void
gnutls_cipher_deinit (gnutls_cipher_hd_t handle)
/* HMAC */
/**
- * gnutls_hmac_init - initializes an HMAC context
- * @handle: is a #gnutls_hmac_hd_t structure.
+ * gnutls_hmac_init:
+ * @dig: is a #gnutls_hmac_hd_t structure.
* @algorithm: the HMAC algorithm to use
* @key: The key to be used for encryption
* @keylen: The length of the key
* Returns: Zero or a negative value on error.
**/
int
-gnutls_hmac_init (gnutls_hmac_hd_t * dig, gnutls_digest_algorithm_t algorithm,
- const void *key, int keylen)
+gnutls_hmac_init (gnutls_hmac_hd_t * dig,
+ gnutls_digest_algorithm_t algorithm,
+ const void *key, int keylen)
{
*dig = gnutls_malloc(sizeof(digest_hd_st));
if (*dig == NULL) {
gnutls_assert();
return GNUTLS_E_MEMORY_ERROR;
}
-
+
return _gnutls_hmac_init(((digest_hd_st*)*dig), algorithm, key, keylen);
}
/**
- * gnutls_hmac - hashes the given data
+ * gnutls_hmac:
* @handle: is a #gnutls_cipher_hd_t structure.
* @text: the data to hash
* @textlen: The length of data to hash
}
/**
- * gnutls_hmac_output - Outputs the current MAC value
+ * gnutls_hmac_output:
* @handle: is a #gnutls_hmac_hd_t structure.
* @digest: is the output value of the MAC
*
* This function will output the current MAC value.
- *
- * Returns: This function has no return value.
**/
void
gnutls_hmac_output (gnutls_hmac_hd_t handle, void *digest)
}
/**
- * gnutls_hmac_deinit - deinitializes resources by a context
+ * gnutls_hmac_deinit:
* @handle: is a #gnutls_hmac_hd_t structure.
* @digest: is the output value of the MAC
*
* This function will deinitialize all resources occupied by
* the given hmac context.
- *
- * Returns: This function has no return value.
**/
void gnutls_hmac_deinit (gnutls_hmac_hd_t handle, void *digest)
{
}
/**
- * gnutls_hmac_get_len - returns the length of the output data
+ * gnutls_hmac_get_len:
* @algorithm: the hmac algorithm to use
*
* This function will return the length of the output data
}
/**
- * gnutls_hmac_fast - hashes data
+ * gnutls_hmac_fast:
* @algorithm: the hash algorithm to use
* @key: the key to use
* @keylen: The length of the key
/* HASH */
/**
- * gnutls_hash_init - initializes an hash context
- * @handle: is a #gnutls_hash_hd_t structure.
+ * gnutls_hash_init:
+ * @dig: is a #gnutls_hash_hd_t structure.
* @algorithm: the hash algorithm to use
- * @key: The key to be used for encryption
- * @keylen: The length of the key
*
* This function will initialize an context that can be used to
* produce a Message Digest of data. This will effectively use the
}
/**
- * gnutls_hash - hashes the given data
+ * gnutls_hash:
* @handle: is a #gnutls_cipher_hd_t structure.
* @text: the data to hash
* @textlen: The length of data to hash
}
/**
- * gnutls_hash_output - Outputs the current hash value
+ * gnutls_hash_output:
* @handle: is a #gnutls_hash_hd_t structure.
* @digest: is the output value of the hash
*
* This function will output the current hash value.
- *
- * Returns: This function has no return value.
**/
void gnutls_hash_output (gnutls_hash_hd_t handle, void *digest)
{
}
/**
- * gnutls_hash_deinit - deinitializes resources by a context
+ * gnutls_hash_deinit:
* @handle: is a #gnutls_hash_hd_t structure.
* @digest: is the output value of the hash
*
* This function will deinitialize all resources occupied by
* the given hash context.
- *
- * Returns: This function has no return value.
**/
void
gnutls_hash_deinit (gnutls_hash_hd_t handle, void *digest)
}
/**
- * gnutls_hash_get_len - returns the length of the output data
+ * gnutls_hash_get_len:
* @algorithm: the hash algorithm to use
*
* This function will return the length of the output data
}
/**
- * gnutls_hash_fast - initializes an hash context
+ * gnutls_hash_fast:
* @algorithm: the hash algorithm to use
* @text: the data to hash
* @textlen: The length of data to hash
}
/**
- * gnutls_crypto_single_cipher_register2 - register a cipher algorithm
+ * gnutls_crypto_single_cipher_register2:
* @algorithm: is the gnutls algorithm identifier
* @priority: is the priority of the algorithm
* @version: should be set to %GNUTLS_CRYPTO_API_VERSION
}
/**
- * gnutls_crypto_rnd_register2 - register a random generator
+ * gnutls_crypto_rnd_register2:
* @priority: is the priority of the generator
* @version: should be set to %GNUTLS_CRYPTO_API_VERSION
* @s: is a structure holding new generator's data
}
/**
- * gnutls_crypto_single_mac_register2 - register a MAC algorithm
+ * gnutls_crypto_single_mac_register2:
* @algorithm: is the gnutls algorithm identifier
* @priority: is the priority of the algorithm
* @version: should be set to %GNUTLS_CRYPTO_API_VERSION
}
/**
- * gnutls_crypto_single_digest_register2 - register a digest algorithm
+ * gnutls_crypto_single_digest_register2:
* @algorithm: is the gnutls algorithm identifier
* @priority: is the priority of the algorithm
* @version: should be set to %GNUTLS_CRYPTO_API_VERSION
}
/**
- * gnutls_crypto_bigint_register2 - register a bigint interface
+ * gnutls_crypto_bigint_register2:
* @priority: is the priority of the interface
* @version: should be set to %GNUTLS_CRYPTO_API_VERSION
* @s: is a structure holding new interface's data
}
/**
- * gnutls_crypto_pk_register2 - register a public key interface
+ * gnutls_crypto_pk_register2:
* @priority: is the priority of the interface
* @version: should be set to %GNUTLS_CRYPTO_API_VERSION
* @s: is a structure holding new interface's data
}
/**
- * gnutls_crypto_cipher_register2 - register a cipher interface
+ * gnutls_crypto_cipher_register2:
* @priority: is the priority of the cipher interface
* @version: should be set to %GNUTLS_CRYPTO_API_VERSION
* @s: is a structure holding new interface's data
}
/**
- * gnutls_crypto_mac_register2 - register a mac interface
+ * gnutls_crypto_mac_register2:
* @priority: is the priority of the mac interface
* @version: should be set to %GNUTLS_CRYPTO_API_VERSION
* @s: is a structure holding new interface's data
}
/**
- * gnutls_crypto_digest_register2 - register a digest interface
+ * gnutls_crypto_digest_register2:
* @priority: is the priority of the digest interface
* @version: should be set to %GNUTLS_CRYPTO_API_VERSION
* @s: is a structure holding new interface's data
}
/**
- * gnutls_safe_negotiation_set_initial - Used to enable and disable initial safe renegotiation
+ * gnutls_safe_negotiation_set_initial:
* @session: is a #gnutls_session_t structure.
* @value: 0 to disable and 1 to enable
*
}
/**
- * gnutls_safe_negotiation_set - Used to enable and disable safe renegotiation
+ * gnutls_safe_negotiation_set:
* @session: is a #gnutls_session_t structure.
* @value: 0 to disable and 1 to enable
*
}
/**
- * gnutls_server_name_get - Used to get the server name indicator send by a client
+ * gnutls_server_name_get:
* @session: is a #gnutls_session_t structure.
* @data: will hold the data
* @data_length: will hold the data length. Must hold the maximum size of data.
}
/**
- * gnutls_server_name_set - set a name indicator to be sent as an extension
+ * gnutls_server_name_set:
* @session: is a #gnutls_session_t structure.
* @type: specifies the indicator type
* @name: is a string that contains the server name.
}
/**
- * gnutls_sign_algorithm_get - get signature algorithms requested by peer
+ * gnutls_sign_algorithm_get:
* @session: is a #gnutls_session_t structure.
* @indx: is an index of the signature algorithm to return
* @algo: the returned certificate type will be stored there
};
/**
- * gnutls_alert_get_name - Returns a string describing the alert number given
+ * gnutls_alert_get_name:
* @alert: is an alert number #gnutls_session_t structure.
*
* This function will return a string that describes the given alert
}
/**
- * gnutls_alert_send - send an alert message to the peer
+ * gnutls_alert_send:
* @session: is a #gnutls_session_t structure.
* @level: is the level of the alert
* @desc: is the alert description
}
/**
- * gnutls_error_to_alert - return an alert code based on the given error code
+ * gnutls_error_to_alert:
* @err: is a negative integer
* @level: the alert level will be stored there
*
}
/**
- * gnutls_alert_send_appropriate - send alert to peer depending on error code
+ * gnutls_alert_send_appropriate:
* @session: is a #gnutls_session_t structure.
* @err: is an integer
*
}
/**
- * gnutls_alert_get - Returns the last alert number received.
+ * gnutls_alert_get:
* @session: is a #gnutls_session_t structure.
*
* This function will return the last alert number received. This
}
/**
- * gnutls_mac_get_name - Returns a string with the name of the specified mac algorithm
+ * gnutls_mac_get_name:
* @algorithm: is a MAC algorithm
*
* Convert a #gnutls_mac_algorithm_t value to a string.
}
/**
- * gnutls_mac_get_id - Returns the gnutls id of the specified in string algorithm
+ * gnutls_mac_get_id:
* @name: is a MAC algorithm name
*
* Convert a string to a #gnutls_mac_algorithm_t value. The names are
}
/**
- * gnutls_mac_get_key_size - Returns the length of the MAC's key size
+ * gnutls_mac_get_key_size:
* @algorithm: is an encryption algorithm
*
* Get size of MAC key.
}
/**
- * gnutls_mac_list - Get a list of supported MAC algorithms
+ * gnutls_mac_list:
*
* Get a list of hash algorithms for use as MACs. Note that not
* necessarily all MACs are supported in TLS cipher suites. For
}
/**
- * gnutls_cipher_get_key_size - Returns the length of the cipher's key size
+ * gnutls_cipher_get_key_size:
* @algorithm: is an encryption algorithm
*
* Get key size for cipher.
}
/**
- * gnutls_cipher_get_name - Returns a string with the name of the specified cipher algorithm
+ * gnutls_cipher_get_name:
* @algorithm: is an encryption algorithm
*
* Convert a #gnutls_cipher_algorithm_t type to a string.
}
/**
- * gnutls_cipher_get_id - Returns the gnutls id of the specified in string algorithm
+ * gnutls_cipher_get_id:
* @name: is a MAC algorithm name
*
* The names are compared in a case insensitive way.
}
/**
- * gnutls_cipher_list - Get a list of supported ciphers
+ * gnutls_cipher_list:
*
* Get a list of supported cipher algorithms. Note that not
* necessarily all ciphers are supported as TLS cipher suites. For
}
/**
- * gnutls_kx_get_name - Returns a string with the name of the specified key exchange algorithm
+ * gnutls_kx_get_name:
* @algorithm: is a key exchange algorithm
*
* Convert a #gnutls_kx_algorithm_t value to a string.
}
/**
- * gnutls_kx_get_id - Returns the gnutls id of the specified in string algorithm
+ * gnutls_kx_get_id:
* @name: is a KX name
*
* Convert a string to a #gnutls_kx_algorithm_t value. The names are
}
/**
- * gnutls_kx_list - Get a list of supported key exchange methods
+ * gnutls_kx_list:
*
* Get a list of supported key exchange algorithms.
*
/**
- * gnutls_protocol_get_name - Returns a string with the name of the specified SSL/TLS version
+ * gnutls_protocol_get_name:
* @version: is a (gnutls) version number
*
* Convert a #gnutls_protocol_t value to a string.
}
/**
- * gnutls_protocol_get_id - Returns the gnutls id of the specified in string protocol
+ * gnutls_protocol_get_id:
* @name: is a protocol name
*
* The names are compared in a case insensitive way.
}
/**
- * gnutls_protocol_list - Get a list of supported protocols
+ * gnutls_protocol_list:
*
* Get a list of supported protocols, e.g. SSL 3.0, TLS 1.0 etc.
*
}
/**
- * gnutls_cipher_suite_get_name - get name of the specified cipher suite
+ * gnutls_cipher_suite_get_name:
* @kx_algorithm: is a Key exchange algorithm
* @cipher_algorithm: is a cipher algorithm
* @mac_algorithm: is a MAC algorithm
}
/**
- * gnutls_certificate_type_get_name - Returns a string with the name of the specified certificate type
+ * gnutls_certificate_type_get_name:
* @type: is a certificate type
*
* Convert a #gnutls_certificate_type_t type to a string.
}
/**
- * gnutls_certificate_type_get_id - Returns the gnutls id of the specified in string type
+ * gnutls_certificate_type_get_id:
* @name: is a certificate type name
*
* The names are compared in a case insensitive way.
};
/**
- * gnutls_certificate_type_list - Get a list of supported certificate types
+ * gnutls_certificate_type_list:
*
* Get a list of certificate types. Note that to be able to use
* OpenPGP certificates, you must link to libgnutls-extra and call
GNUTLS_SIGN_LOOP( if(p->id && p->id == sign) { a; break; } )
/**
- * gnutls_sign_algorithm_get_name - Returns a string with the name of the specified sign algorithm
+ * gnutls_sign_algorithm_get_name:
* @sign: is a sign algorithm
*
* Convert a #gnutls_sign_algorithm_t value to a string.
}
/**
- * gnutls_sign_list - Get a list of supported public key signature algorithms
+ * gnutls_sign_list:
*
* Get a list of supported public key signature algorithms.
*
}
/**
- * gnutls_sign_get_id - Returns the gnutls id of the specified in signature algorithm
+ * gnutls_sign_get_id:
* @name: is a MAC algorithm name
*
* The names are compared in a case insensitive way.
}
/**
- * gnutls_sign_get_name - Get name string for a #gnutls_sign_algorithm_t
+ * gnutls_sign_get_name:
* @algorithm: is a public key signature algorithm
*
* Convert a #gnutls_sign_algorithm_t value to a string.
};
/**
- * gnutls_pk_algorithm_get_name - Get string with name of public key algorithm
+ * gnutls_pk_algorithm_get_name:
* @algorithm: is a pk algorithm
*
* Convert a #gnutls_pk_algorithm_t value to a string.
}
/**
- * gnutls_pk_list - Get a list of supported public key algorithms
+ * gnutls_pk_list:
*
* Get a list of supported public key algorithms.
*
}
/**
- * gnutls_pk_get_id - Get #gnutls_pk_algorithm_t from a string
+ * gnutls_pk_get_id:
* @name: is a string containing a public key algorithm name.
*
* Convert a string to a #gnutls_pk_algorithm_t value. The names are
}
/**
- * gnutls_pk_get_name - Get name string with #gnutls_pk_algorithm_t algorithm
+ * gnutls_pk_get_name:
* @algorithm: is a public key algorithm
*
* Convert a #gnutls_pk_algorithm_t value to a string.
#include "gnutls_mpi.h"
/**
- * gnutls_anon_free_server_credentials - Used to free an allocated gnutls_anon_server_credentials_t structure
+ * gnutls_anon_free_server_credentials:
* @sc: is a #gnutls_anon_server_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
}
/**
- * gnutls_anon_allocate_server_credentials - Used to allocate an gnutls_anon_server_credentials_t structure
+ * gnutls_anon_allocate_server_credentials:
* @sc: is a pointer to a #gnutls_anon_server_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
/**
- * gnutls_anon_free_client_credentials - Used to free an allocated gnutls_anon_client_credentials_t structure
+ * gnutls_anon_free_client_credentials:
* @sc: is a #gnutls_anon_client_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
static const gnutls_anon_client_credentials_t anon_dummy = &anon_dummy_struct;
/**
- * gnutls_anon_allocate_client_credentials - Used to allocate a credentials structure
+ * gnutls_anon_allocate_client_credentials:
* @sc: is a pointer to a #gnutls_anon_client_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus
}
/**
- * gnutls_anon_set_server_dh_params - set the DH parameters for a server to use
+ * gnutls_anon_set_server_dh_params:
* @res: is a gnutls_anon_server_credentials_t structure
* @dh_params: is a structure that holds Diffie-Hellman parameters.
*
}
/**
- * gnutls_anon_set_server_params_function - set the DH parameters callback
+ * gnutls_anon_set_server_params_function:
* @res: is a gnutls_certificate_credentials_t structure
* @func: is the function to be called
*
*/
/**
- * gnutls_credentials_clear - Clears all the credentials previously set
+ * gnutls_credentials_clear:
* @session: is a #gnutls_session_t structure.
*
* Clears all the credentials previously set in this session.
* { algorithm, credentials, pointer to next }
*/
/**
- * gnutls_credentials_set - Sets the needed credentials for the specified authentication algorithm.
+ * gnutls_credentials_set:
* @session: is a #gnutls_session_t structure.
* @type: is the type of the credentials
* @cred: is a pointer to a structure.
}
/**
- * gnutls_auth_get_type - Returns the type of credentials for the current authentication schema.
+ * gnutls_auth_get_type:
* @session: is a #gnutls_session_t structure.
*
* Returns type of credentials for the current authentication schema.
}
/**
- * gnutls_auth_server_get_type - Returns the type of credentials for the server authentication schema.
+ * gnutls_auth_server_get_type:
* @session: is a #gnutls_session_t structure.
*
* Returns the type of credentials that were used for server authentication.
}
/**
- * gnutls_auth_client_get_type - Returns the type of credentials for the client authentication schema.
+ * gnutls_auth_client_get_type:
* @session: is a #gnutls_session_t structure.
*
* Returns the type of credentials that were used for client authentication.
}
/**
- * gnutls_record_check_pending - checks if there are any data to receive in gnutls buffers.
+ * gnutls_record_check_pending:
* @session: is a #gnutls_session_t structure.
*
* This function checks if there are any data to receive in the gnutls
#endif
/**
- * gnutls_certificate_free_keys - Used to free all the keys from a gnutls_certificate_credentials_t structure
+ * gnutls_certificate_free_keys:
* @sc: is a #gnutls_certificate_credentials_t structure.
*
* This function will delete all the keys and the certificates associated
}
/**
- * gnutls_certificate_free_cas - Used to free all the CAs from a gnutls_certificate_credentials_t structure
+ * gnutls_certificate_free_cas:
* @sc: is a #gnutls_certificate_credentials_t structure.
*
* This function will delete all the CAs associated with the given
}
/**
- * gnutls_certificate_get_x509_cas - Used to export all the CAs from a gnutls_certificate_credentials_t structure
+ * gnutls_certificate_get_x509_cas:
* @sc: is a #gnutls_certificate_credentials_t structure.
* @x509_ca_list: will point to the CA list. Should be treated as constant
* @ncas: the number of CAs
}
/**
- * gnutls_certificate_get_x509_crls - Used to export all the CRLs from a gnutls_certificate_credentials_t structure
+ * gnutls_certificate_get_x509_crls:
* @sc: is a #gnutls_certificate_credentials_t structure.
* @x509_crl_list: the exported CRL list. Should be treated as constant
* @ncrls: the number of exported CRLs
#ifdef ENABLE_OPENPGP
/**
- * gnutls_certificate_get_openpgp_keyring - export keyring from a #gnutls_certificate_credentials_t
+ * gnutls_certificate_get_openpgp_keyring:
* @sc: is a #gnutls_certificate_credentials_t structure.
* @keyring: the exported keyring. Should be treated as constant
*
#endif
/**
- * gnutls_certificate_free_ca_names - Used to free all the CA names from a gnutls_certificate_credentials_t structure
+ * gnutls_certificate_free_ca_names:
* @sc: is a #gnutls_certificate_credentials_t structure.
*
* This function will delete all the CA name in the given
/**
- * gnutls_certificate_free_credentials - Used to free an allocated gnutls_certificate_credentials_t structure
+ * gnutls_certificate_free_credentials:
* @sc: is a #gnutls_certificate_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
/**
- * gnutls_certificate_allocate_credentials - Used to allocate a gnutls_certificate_credentials_t structure
+ * gnutls_certificate_allocate_credentials:
* @res: is a pointer to a #gnutls_certificate_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
/**
- * gnutls_certificate_server_set_request - Used to set whether to request a client certificate
+ * gnutls_certificate_server_set_request:
* @session: is a #gnutls_session_t structure.
* @req: is one of GNUTLS_CERT_REQUEST, GNUTLS_CERT_REQUIRE
*
}
/**
- * gnutls_certificate_client_set_retrieve_function - Used to set a callback to retrieve the certificate
+ * gnutls_certificate_client_set_retrieve_function:
* @cred: is a #gnutls_certificate_credentials_t structure.
* @func: is the callback function
*
}
/**
- * gnutls_certificate_server_set_retrieve_function - Used to set a callback to retrieve the certificate
+ * gnutls_certificate_server_set_retrieve_function:
* @cred: is a #gnutls_certificate_credentials_t structure.
* @func: is the callback function
*
}
/*-
- * gnutls_x509_extract_certificate_expiration_time - return the certificate's expiration time
+ * gnutls_x509_extract_certificate_expiration_time:
* @cert: should contain an X.509 DER encoded certificate
*
* This function will return the certificate's expiration time in UNIX
#endif
/**
- * gnutls_certificate_verify_peers2 - return the peer's certificate verification status
+ * gnutls_certificate_verify_peers2:
* @session: is a gnutls session
* @status: is the output of the verification
*
}
/**
- * gnutls_certificate_verify_peers - return the peer's certificate verification status
+ * gnutls_certificate_verify_peers:
* @session: is a gnutls session
*
* This function will try to verify the peer's certificate and return
}
/**
- * gnutls_certificate_expiration_time_peers - return the peer's certificate expiration time
+ * gnutls_certificate_expiration_time_peers:
* @session: is a gnutls session
*
* This function will return the peer's certificate expiration time.
}
/**
- * gnutls_certificate_activation_time_peers - return the peer's certificate activation time
+ * gnutls_certificate_activation_time_peers:
* @session: is a gnutls session
*
* This function will return the peer's certificate activation time.
/* Compression Functions */
/**
- * gnutls_compression_get_name - Returns a string with the name of the specified compression algorithm
+ * gnutls_compression_get_name:
* @algorithm: is a Compression algorithm
*
* Convert a #gnutls_compression_method_t value to a string.
}
/**
- * gnutls_compression_get_id - Returns the gnutls id of the specified in string algorithm
+ * gnutls_compression_get_id:
* @name: is a compression method name
*
* The names are compared in a case insensitive way.
}
/**
- * gnutls_compression_list - Get a list of supported compression methods
+ * gnutls_compression_list:
*
* Get a list of compression methods. Note that to be able to use LZO
* compression, you must link to libgnutls-extra and call
#include <gnutls_datum.h>
/**
- * gnutls_db_set_retrieve_function - Set the function that will be used to get data
+ * gnutls_db_set_retrieve_function:
* @session: is a #gnutls_session_t structure.
* @retr_func: is the function.
*
}
/**
- * gnutls_db_set_remove_function - Set the function that will be used to remove data
+ * gnutls_db_set_remove_function:
* @session: is a #gnutls_session_t structure.
* @rem_func: is the function.
*
}
/**
- * gnutls_db_set_store_function - Set the function that will be used to put data
+ * gnutls_db_set_store_function:
* @session: is a #gnutls_session_t structure.
* @store_func: is the function
*
}
/**
- * gnutls_db_set_ptr - Set a pointer to be sent to db functions
+ * gnutls_db_set_ptr:
* @session: is a #gnutls_session_t structure.
* @ptr: is the pointer
*
}
/**
- * gnutls_db_get_ptr - Returns the pointer which is sent to db functions
+ * gnutls_db_get_ptr:
* @session: is a #gnutls_session_t structure.
*
* Get db function pointer.
}
/**
- * gnutls_db_set_cache_expiration - Set the expiration time for resumed sessions.
+ * gnutls_db_set_cache_expiration:
* @session: is a #gnutls_session_t structure.
* @seconds: is the number of seconds.
*
}
/**
- * gnutls_db_check_entry - check if the given db entry has expired
+ * gnutls_db_check_entry:
* @session: is a #gnutls_session_t structure.
* @session_entry: is the session data (not key)
*
}
/**
- * gnutls_db_remove_session - remove the current session data from the database
+ * gnutls_db_remove_session:
* @session: is a #gnutls_session_t structure.
*
* This function will remove the current session data from the
* generated one.
*/
/**
- * gnutls_dh_params_import_raw - import DH parameters
+ * gnutls_dh_params_import_raw:
* @dh_params: Is a structure that will hold the prime numbers
* @prime: holds the new prime
* @generator: holds the new generator
}
/**
- * gnutls_dh_params_init - initialize the DH parameters
+ * gnutls_dh_params_init:
* @dh_params: Is a structure that will hold the prime numbers
*
* This function will initialize the DH parameters structure.
}
/**
- * gnutls_dh_params_deinit - deinitialize the DH parameters
+ * gnutls_dh_params_deinit:
* @dh_params: Is a structure that holds the prime numbers
*
* This function will deinitialize the DH parameters structure.
}
/**
- * gnutls_dh_params_cpy - copy a DH parameters structure
+ * gnutls_dh_params_cpy:
* @dst: Is the destination structure, which should be initialized.
* @src: Is the source structure
*
/**
- * gnutls_dh_params_generate2 - generate new DH parameters
+ * gnutls_dh_params_generate2:
* @params: Is the structure that the DH parameters will be stored
* @bits: is the prime's number of bits
*
}
/**
- * gnutls_dh_params_import_pkcs3 - import DH params from a pkcs3 structure
+ * gnutls_dh_params_import_pkcs3:
* @params: A structure where the parameters will be copied to
* @pkcs3_params: should contain a PKCS3 DHParams structure PEM or DER encoded
* @format: the format of params. PEM or DER.
}
/**
- * gnutls_dh_params_export_pkcs3 - export DH params to a pkcs3 structure
+ * gnutls_dh_params_export_pkcs3:
* @params: Holds the DH parameters
* @format: the format of output params. One of PEM or DER.
* @params_data: will contain a PKCS3 DHParams structure PEM or DER encoded
}
/**
- * gnutls_dh_params_export_raw - export the raw DH parameters
+ * gnutls_dh_params_export_raw:
* @params: Holds the DH parameters
* @prime: will hold the new prime
* @generator: will hold the new generator
};
/**
- * gnutls_error_is_fatal - Returns non-zero in case of a fatal error
+ * gnutls_error_is_fatal:
* @error: is a GnuTLS error code, a negative value
*
* If a GnuTLS function returns a negative value you may feed that
}
/**
- * gnutls_perror - prints a string to stderr with a description of an error
+ * gnutls_perror:
* @error: is a GnuTLS error code, a negative value
*
* This function is like perror(). The only difference is that it
/**
- * gnutls_strerror - Returns a string with a description of an error
+ * gnutls_strerror:
* @error: is a GnuTLS error code, a negative value
*
* This function is similar to strerror. The difference is that it
}
/**
- * gnutls_ext_register - Register a handler for a TLS extension
+ * gnutls_ext_register:
* @type: the 16-bit integer referring to the extension type
* @name: human printable name of the extension used for debugging
* @parse_type: either #GNUTLS_EXT_TLS or %GNUTLS_EXT_APPLICATION.
int _gnutls_log_level = 0; /* default log level */
/**
- * gnutls_global_set_log_function - set the logging function
+ * gnutls_global_set_log_function:
* @log_func: it's a log function
*
* This is the function where you set the logging function gnutls is
}
/**
- * gnutls_global_set_log_level - set the logging level
+ * gnutls_global_set_log_level:
* @level: it's an integer from 0 to 9.
*
* This is the function that allows you to set the log level. The
}
/**
- * gnutls_global_set_mem_functions - set the memory allocation functions
+ * gnutls_global_set_mem_functions:
* @alloc_func: it's the default memory allocation function. Like malloc().
* @secure_alloc_func: This is the memory allocation function that will be used for sensitive data.
* @is_secure_func: a function that returns 0 if the memory given is not secure. May be NULL.
static int _gnutls_init = 0;
/**
- * gnutls_global_init - initialize the global data to defaults.
+ * gnutls_global_init:
*
* This function initializes the global data to defaults. Every
* gnutls application has a global data which holds common parameters
}
/**
- * gnutls_global_deinit - deinitialize the global data
+ * gnutls_global_deinit:
*
* This function deinitializes the global data, that were initialized
* using gnutls_global_init().
*/
/**
- * gnutls_transport_set_pull_function - set a read like function
+ * gnutls_transport_set_pull_function:
* @pull_func: a callback function similar to read()
* @session: gnutls session
*
}
/**
- * gnutls_transport_set_push_function - set the function to send data
+ * gnutls_transport_set_push_function:
* @push_func: a callback function similar to write()
* @session: gnutls session
*
}
/**
- * gnutls_check_version - checks the libgnutls version
+ * gnutls_check_version:
* @req_version: version string to compare with, or %NULL.
*
* Check GnuTLS Library version.
*/
/**
- * gnutls_rehandshake - renegotiate security parameters
+ * gnutls_rehandshake:
* @session: is a #gnutls_session_t structure.
*
* This function will renegotiate security parameters with the
}
/**
- * gnutls_handshake - This is the main function in the handshake protocol.
+ * gnutls_handshake:
* @session: is a #gnutls_session_t structure.
*
* This function does the handshake of the TLS/SSL protocol, and
}
/**
- * gnutls_handshake_set_max_packet_length - set the maximum size of the handshake
+ * gnutls_handshake_set_max_packet_length:
* @session: is a #gnutls_session_t structure.
* @max: is the maximum number.
*
}
/**
- * gnutls_handshake_get_last_in - Returns the last handshake message received.
+ * gnutls_handshake_get_last_in:
* @session: is a #gnutls_session_t structure.
*
* This function is only useful to check where the last performed
}
/**
- * gnutls_handshake_get_last_out - Returns the last handshake message sent.
+ * gnutls_handshake_get_last_out:
* @session: is a #gnutls_session_t structure.
*
* This function is only useful to check where the last performed
*/
/**
- * gnutls_malloc - Allocates and returns data
+ * gnutls_malloc:
*
* This function will allocate 's' bytes data, and
* return a pointer to memory. This function is supposed
}
/**
- * gnutls_free - Returns a free() like function
+ * gnutls_free:
* @d: pointer to memory
*
* This function will free data pointed by ptr.
char sep);
/**
- * gnutls_cipher_set_priority - Sets the priority on the ciphers supported by gnutls.
+ * gnutls_cipher_set_priority:
* @session: is a #gnutls_session_t structure.
* @list: is a 0 terminated list of gnutls_cipher_algorithm_t elements.
*
}
/**
- * gnutls_kx_set_priority - Sets the priority on the key exchange algorithms supported by gnutls.
+ * gnutls_kx_set_priority:
* @session: is a #gnutls_session_t structure.
* @list: is a 0 terminated list of gnutls_kx_algorithm_t elements.
*
}
/**
- * gnutls_mac_set_priority - Sets the priority on the mac algorithms supported by gnutls.
+ * gnutls_mac_set_priority:
* @session: is a #gnutls_session_t structure.
* @list: is a 0 terminated list of gnutls_mac_algorithm_t elements.
*
}
/**
- * gnutls_compression_set_priority - Sets the priority on the compression algorithms supported by gnutls.
+ * gnutls_compression_set_priority:
* @session: is a #gnutls_session_t structure.
* @list: is a 0 terminated list of gnutls_compression_method_t elements.
*
}
/**
- * gnutls_protocol_set_priority - Sets the priority on the protocol versions supported by gnutls.
+ * gnutls_protocol_set_priority:
* @session: is a #gnutls_session_t structure.
* @list: is a 0 terminated list of gnutls_protocol_t elements.
*
}
/**
- * gnutls_certificate_type_set_priority - Sets the priority on the certificate types supported by gnutls.
+ * gnutls_certificate_type_set_priority:
* @session: is a #gnutls_session_t structure.
* @list: is a 0 terminated list of gnutls_certificate_type_t elements.
*
/**
- * gnutls_priority_set - Sets priorities for the cipher suites supported by gnutls.
+ * gnutls_priority_set:
* @session: is a #gnutls_session_t structure.
* @priority: is a #gnutls_priority_t structure.
*
#define MAX_ELEMENTS 48
/**
- * gnutls_priority_init - Sets priorities for the cipher suites supported by gnutls.
+ * gnutls_priority_init:
* @priority_cache: is a #gnutls_prioritity_t structure.
* @priorities: is a string describing priorities
* @err_pos: In case of an error this will have the position in the string the error occured
}
/**
- * gnutls_priority_deinit - deinitialize the priorities cache
+ * gnutls_priority_deinit:
* @priority_cache: is a #gnutls_prioritity_t structure.
*
* Deinitializes the priority cache.
/**
- * gnutls_priority_set_direct - Sets priorities for the cipher suites supported by gnutls.
+ * gnutls_priority_set_direct:
* @session: is a #gnutls_session_t structure.
* @priorities: is a string describing priorities
* @err_pos: In case of an error this will have the position in the string the error occured
}
/**
- * gnutls_set_default_priority - Sets some default priority on the cipher suites supported by gnutls.
+ * gnutls_set_default_priority:
* @session: is a #gnutls_session_t structure.
*
* Sets some default priority on the ciphers, key exchange methods,
}
/**
- * gnutls_set_default_export_priority - Sets some default priority on the cipher suites supported by gnutls.
+ * gnutls_set_default_export_priority:
* @session: is a #gnutls_session_t structure.
*
* Sets some default priority on the ciphers, key exchange methods, macs
#include "debug.h"
/**
- * gnutls_psk_free_client_credentials - Used to free an allocated gnutls_psk_client_credentials_t structure
+ * gnutls_psk_free_client_credentials:
* @sc: is a #gnutls_psk_client_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
}
/**
- * gnutls_psk_allocate_client_credentials - Used to allocate an gnutls_psk_server_credentials_t structure
+ * gnutls_psk_allocate_client_credentials:
* @sc: is a pointer to a #gnutls_psk_server_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
}
/**
- * gnutls_psk_set_client_credentials - Used to set the username/password, in a gnutls_psk_client_credentials_t structure
+ * gnutls_psk_set_client_credentials:
* @res: is a #gnutls_psk_client_credentials_t structure.
* @username: is the user's zero-terminated userid
* @key: is the user's key
}
/**
- * gnutls_psk_free_server_credentials - Used to free an allocated gnutls_psk_server_credentials_t structure
+ * gnutls_psk_free_server_credentials:
* @sc: is a #gnutls_psk_server_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
}
/**
- * gnutls_psk_allocate_server_credentials - Used to allocate an gnutls_psk_server_credentials_t structure
+ * gnutls_psk_allocate_server_credentials:
* @sc: is a pointer to a #gnutls_psk_server_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
/**
- * gnutls_psk_set_server_credentials_file - Used to set the password files, in a gnutls_psk_server_credentials_t structure
+ * gnutls_psk_set_server_credentials_file:
* @res: is a #gnutls_psk_server_credentials_t structure.
* @password_file: is the PSK password file (passwd.psk)
*
}
/**
- * gnutls_psk_set_server_credentials_hint - Set a identity hint, in a %gnutls_psk_server_credentials_t structure
+ * gnutls_psk_set_server_credentials_hint:
* @res: is a #gnutls_psk_server_credentials_t structure.
* @hint: is the PSK identity hint string
*
}
/**
- * gnutls_psk_set_server_credentials_function - Used to set a callback to retrieve the user's PSK credentials
+ * gnutls_psk_set_server_credentials_function:
* @cred: is a #gnutls_psk_server_credentials_t structure.
* @func: is the callback function
*
}
/**
- * gnutls_psk_set_client_credentials_function - Used to set a callback to retrieve the username and key
+ * gnutls_psk_set_client_credentials_function:
* @cred: is a #gnutls_psk_server_credentials_t structure.
* @func: is the callback function
*
/**
- * gnutls_psk_server_get_username - return the username of the peer
+ * gnutls_psk_server_get_username:
* @session: is a gnutls session
*
* This should only be called in case of PSK authentication and in
}
/**
- * gnutls_psk_client_get_hint - return the PSK identity hint of the peer
+ * gnutls_psk_client_get_hint:
* @session: is a gnutls session
*
* The PSK identity hint may give the client help in deciding which
}
/**
- * gnutls_hex_decode - decode hex encoded data
+ * gnutls_hex_decode:
* @hex_data: contain the encoded data
* @result: the place where decoded data will be copied
* @result_size: holds the size of the result
}
/**
- * gnutls_hex_encode - convert raw data to hex encoded
+ * gnutls_hex_encode:
* @data: contain the raw data
* @result: the place where hex data will be copied
* @result_size: holds the size of the result
}
/**
- * gnutls_psk_set_server_dh_params - set the DH parameters for a server to use
+ * gnutls_psk_set_server_dh_params:
* @res: is a gnutls_psk_server_credentials_t structure
* @dh_params: is a structure that holds Diffie-Hellman parameters.
*
}
/**
- * gnutls_psk_set_server_params_function - set the DH parameters callback
+ * gnutls_psk_set_server_params_function:
* @res: is a #gnutls_certificate_credentials_t structure
* @func: is the function to be called
*
/**
- * gnutls_psk_netconf_derive_key - derive PSK Netconf key from password
+ * gnutls_psk_netconf_derive_key:
* @password: zero terminated string containing password.
* @psk_identity: zero terminated string with PSK identity.
* @psk_identity_hint: zero terminated string with PSK identity hint.
#include <gnutls_dh.h>
/**
- * gnutls_protocol_get_version - Returns the version of the currently used protocol
+ * gnutls_protocol_get_version:
* @session: is a #gnutls_session_t structure.
*
* Get TLS version, a #gnutls_protocol_t value.
}
/**
- * gnutls_transport_set_lowat - Used to set the lowat value in order for select to check for pending data.
+ * gnutls_transport_set_lowat:
* @session: is a #gnutls_session_t structure.
* @num: is the low water value.
*
}
/**
- * gnutls_record_disable_padding - Used to disabled padding in TLS 1.0 and above
+ * gnutls_record_disable_padding:
* @session: is a #gnutls_session_t structure.
*
* Used to disabled padding in TLS 1.0 and above. Normally you do not
}
/**
- * gnutls_transport_set_ptr - Used to set first argument of the transport functions
+ * gnutls_transport_set_ptr:
* @session: is a #gnutls_session_t structure.
* @ptr: is the value.
*
}
/**
- * gnutls_transport_set_ptr2 - Used to set first argument of the transport functions
+ * gnutls_transport_set_ptr2:
* @session: is a #gnutls_session_t structure.
* @recv_ptr: is the value for the pull function
* @send_ptr: is the value for the push function
}
/**
- * gnutls_transport_get_ptr - Used to return the first argument of the transport functions
+ * gnutls_transport_get_ptr:
* @session: is a #gnutls_session_t structure.
*
* Used to get the first argument of the transport function (like
}
/**
- * gnutls_transport_get_ptr2 - Used to return the first argument of the transport functions
+ * gnutls_transport_get_ptr2:
* @session: is a #gnutls_session_t structure.
* @recv_ptr: will hold the value for the pull function
* @send_ptr: will hold the value for the push function
}
/**
- * gnutls_bye - terminate the current TLS/SSL connection.
+ * gnutls_bye:
* @session: is a #gnutls_session_t structure.
* @how: is an integer
*
/**
- * gnutls_record_send - sends to the peer the specified data
+ * gnutls_record_send:
* @session: is a #gnutls_session_t structure.
* @data: contains the data to send
* @sizeofdata: is the length of the data
}
/**
- * gnutls_record_recv - reads data from the TLS record protocol
+ * gnutls_record_recv:
* @session: is a #gnutls_session_t structure.
* @data: the buffer that the data will be read into
* @sizeofdata: the number of requested bytes
}
/**
- * gnutls_record_get_max_size - returns the maximum record size
+ * gnutls_record_get_max_size:
* @session: is a #gnutls_session_t structure.
*
* Get the record size. The maximum record size is negotiated by the
/**
- * gnutls_record_set_max_size - sets the maximum record size
+ * gnutls_record_set_max_size:
* @session: is a #gnutls_session_t structure.
* @size: is the new size
*
}
/**
- * gnutls_rsa_params_import_raw - set the RSA parameters
+ * gnutls_rsa_params_import_raw:
* @rsa_params: Is a structure will hold the parameters
* @m: holds the modulus
* @e: holds the public exponent
}
/**
- * gnutls_rsa_params_init - initialize the temporary RSA parameters
+ * gnutls_rsa_params_init:
* @rsa_params: Is a structure that will hold the parameters
*
* This function will initialize the temporary RSA parameters structure.
}
/**
- * gnutls_rsa_params_deinit - deinitialize the RSA parameters
+ * gnutls_rsa_params_deinit:
* @rsa_params: Is a structure that holds the parameters
*
* This function will deinitialize the RSA parameters structure.
}
/**
- * gnutls_rsa_params_cpy - copy an RSA parameters structure
+ * gnutls_rsa_params_cpy:
* @dst: Is the destination structure, which should be initialized.
* @src: Is the source structure
*
}
/**
- * gnutls_rsa_params_generate2 - generate temporary RSA parameters
+ * gnutls_rsa_params_generate2:
* @params: The structure where the parameters will be stored
* @bits: is the prime's number of bits
*
}
/**
- * gnutls_rsa_params_import_pkcs1 - import RSA params from a pkcs1 structure
+ * gnutls_rsa_params_import_pkcs1:
* @params: A structure where the parameters will be copied to
* @pkcs1_params: should contain a PKCS1 RSAPublicKey structure PEM or DER encoded
* @format: the format of params. PEM or DER.
}
/**
- * gnutls_rsa_params_export_pkcs1 - export RSA params to a pkcs1 structure
+ * gnutls_rsa_params_export_pkcs1:
* @params: Holds the RSA parameters
* @format: the format of output params. One of PEM or DER.
* @params_data: will contain a PKCS1 RSAPublicKey structure PEM or DER encoded
}
/**
- * gnutls_rsa_params_export_raw - export the RSA parameters
+ * gnutls_rsa_params_export_raw:
* @params: a structure that holds the rsa parameters
* @m: will hold the modulus
* @e: will hold the public exponent
#include <gnutls_datum.h>
/**
- * gnutls_session_get_data - Returns all session parameters.
+ * gnutls_session_get_data:
* @session: is a #gnutls_session_t structure.
* @session_data: is a pointer to space to hold the session.
* @session_data_size: is the session_data's size, or it will be set by the function.
}
/**
- * gnutls_session_get_data2 - Returns all session parameters.
+ * gnutls_session_get_data2:
* @session: is a #gnutls_session_t structure.
* @data: is a pointer to a datum that will hold the session.
*
/**
- * gnutls_session_get_id - Returns session id.
+ * gnutls_session_get_id:
* @session: is a #gnutls_session_t structure.
* @session_id: is a pointer to space to hold the session id.
* @session_id_size: is the session id's size, or it will be set by the function.
}
/**
- * gnutls_session_set_data - Sets all session parameters
+ * gnutls_session_set_data:
* @session: is a #gnutls_session_t structure.
* @session_data: is a pointer to space to hold the session.
* @session_data_size: is the session's size
}
/**
- * gnutls_srp_free_client_credentials - Used to free an allocated gnutls_srp_client_credentials_t structure
+ * gnutls_srp_free_client_credentials:
* @sc: is a #gnutls_srp_client_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus
}
/**
- * gnutls_srp_allocate_client_credentials - Used to allocate an gnutls_srp_server_credentials_t structure
+ * gnutls_srp_allocate_client_credentials:
* @sc: is a pointer to a #gnutls_srp_server_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus
}
/**
- * gnutls_srp_set_client_credentials - Used to set the username/password, in a gnutls_srp_client_credentials_t structure
+ * gnutls_srp_set_client_credentials:
* @res: is a #gnutls_srp_client_credentials_t structure.
* @username: is the user's userid
* @password: is the user's password
}
/**
- * gnutls_srp_free_server_credentials - Used to free an allocated gnutls_srp_server_credentials_t structure
+ * gnutls_srp_free_server_credentials:
* @sc: is a #gnutls_srp_server_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus
}
/**
- * gnutls_srp_allocate_server_credentials - Used to allocate an gnutls_srp_server_credentials_t structure
+ * gnutls_srp_allocate_server_credentials:
* @sc: is a pointer to a #gnutls_srp_server_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
}
/**
- * gnutls_srp_set_server_credentials_file - Used to set the password files, in a gnutls_srp_server_credentials_t structure
+ * gnutls_srp_set_server_credentials_file:
* @res: is a #gnutls_srp_server_credentials_t structure.
* @password_file: is the SRP password file (tpasswd)
* @password_conf_file: is the SRP password conf file (tpasswd.conf)
/**
- * gnutls_srp_set_server_credentials_function - Used to set a callback to retrieve the user's SRP credentials
+ * gnutls_srp_set_server_credentials_function:
* @cred: is a #gnutls_srp_server_credentials_t structure.
* @func: is the callback function
*
}
/**
- * gnutls_srp_set_client_credentials_function - Used to set a callback to retrieve the username and password
+ * gnutls_srp_set_client_credentials_function:
* @cred: is a #gnutls_srp_server_credentials_t structure.
* @func: is the callback function
*
/**
- * gnutls_srp_server_get_username - return the username of the peer
+ * gnutls_srp_server_get_username:
* @session: is a gnutls session
*
* This function will return the username of the peer. This should
}
/**
- * gnutls_srp_verifier - Used to calculate an SRP verifier
+ * gnutls_srp_verifier:
* @username: is the user's name
* @password: is the user's password
* @salt: should be some randomly generated bytes
}
/**
- * gnutls_srp_set_prime_bits - set the minimum bits for a SRP ciphersuite
+ * gnutls_srp_set_prime_bits:
* @session: is a #gnutls_session_t structure.
* @bits: is the number of bits
*
}
/**
- * gnutls_cipher_get - Returns the currently used cipher.
+ * gnutls_cipher_get:
* @session: is a #gnutls_session_t structure.
*
* Get currently used cipher.
}
/**
- * gnutls_certificate_type_get - Returns the currently used certificate type.
+ * gnutls_certificate_type_get:
* @session: is a #gnutls_session_t structure.
*
* The certificate type is by default X.509, unless it is negotiated
}
/**
- * gnutls_kx_get - Returns the key exchange algorithm.
+ * gnutls_kx_get:
* @session: is a #gnutls_session_t structure.
*
* Get currently used key exchange algorithm.
}
/**
- * gnutls_mac_get - Returns the currently used mac algorithm.
+ * gnutls_mac_get:
* @session: is a #gnutls_session_t structure.
*
* Get currently used MAC algorithm.
}
/**
- * gnutls_compression_get - Returns the currently used compression algorithm.
+ * gnutls_compression_get:
* @session: is a #gnutls_session_t structure.
*
* Get currently used compression algorithm.
#define MIN_DH_BITS 727
/**
- * gnutls_init - initialize the session to null (null encryption etc...).
+ * gnutls_init:
* @con_end: indicate if this session is to be used for server or client.
* @session: is a pointer to a #gnutls_session_t structure.
*
/**
- * gnutls_deinit - clear all buffers associated with a session
+ * gnutls_deinit:
* @session: is a #gnutls_session_t structure.
*
* This function clears all buffers associated with the @session.
#ifdef ENABLE_OPENPGP
/**
- * gnutls_openpgp_send_cert - order gnutls to send the openpgp fingerprint instead of the key
+ * gnutls_openpgp_send_cert:
* @session: is a pointer to a #gnutls_session_t structure.
* @status: is one of GNUTLS_OPENPGP_CERT, or GNUTLS_OPENPGP_CERT_FINGERPRINT
*
#endif
/**
- * gnutls_certificate_send_x509_rdn_sequence - order gnutls to send or not the x.509 rdn sequence
+ * gnutls_certificate_send_x509_rdn_sequence:
* @session: is a pointer to a #gnutls_session_t structure.
* @status: is 0 or 1
*
}
/**
- * gnutls_handshake_set_private_extensions - Used to enable the private cipher suites
+ * gnutls_handshake_set_private_extensions:
* @session: is a #gnutls_session_t structure.
* @allow: is an integer (0 or 1)
*
}
/**
- * gnutls_prf_raw - access the TLS PRF directly
+ * gnutls_prf_raw:
* @session: is a #gnutls_session_t structure.
* @label_size: length of the @label variable.
* @label: label used in PRF computation, typically a short string.
}
/**
- * gnutls_prf - derive pseudo-random data using the TLS PRF
+ * gnutls_prf:
* @session: is a #gnutls_session_t structure.
* @label_size: length of the @label variable.
* @label: label used in PRF computation, typically a short string.
}
/**
- * gnutls_session_get_client_random - get the session's client random value
+ * gnutls_session_get_client_random:
* @session: is a #gnutls_session_t structure.
*
* Return a pointer to the 32-byte client random field used in the
}
/**
- * gnutls_session_get_server_random - get the session's server random value
+ * gnutls_session_get_server_random:
* @session: is a #gnutls_session_t structure.
*
* Return a pointer to the 32-byte server random field used in the
}
/**
- * gnutls_session_get_master_secret - get the session's master secret value
+ * gnutls_session_get_master_secret:
* @session: is a #gnutls_session_t structure.
*
* Return a pointer to the 48-byte master secret in the session. The
}
/**
- * gnutls_session_is_resumed - check whether this session is a resumed one
+ * gnutls_session_is_resumed:
* @session: is a #gnutls_session_t structure.
*
* Check whether session is resumed or not.
}
/**
- * gnutls_session_get_ptr - Get the user pointer from the session structure
+ * gnutls_session_get_ptr:
* @session: is a #gnutls_session_t structure.
*
* Get user pointer for session. Useful in callbacks. This is the
}
/**
- * gnutls_session_set_ptr - Used to set the user pointer to the session structure
+ * gnutls_session_set_ptr:
* @session: is a #gnutls_session_t structure.
* @ptr: is the user pointer
*
/**
- * gnutls_record_get_direction - return the direction of the last interrupted function call
+ * gnutls_record_get_direction:
* @session: is a #gnutls_session_t structure.
*
* This function provides information about the internals of the
}
/**
- * gnutls_handshake_set_post_client_hello_function - set callback to be called after the client hello is received
+ * gnutls_handshake_set_post_client_hello_function:
* @session: is a #gnutls_session_t structure.
* @func: is the function to be called
*
}
/**
- * gnutls_session_enable_compatibility_mode - disable certain features in TLS in order to honour compatibility
+ * gnutls_session_enable_compatibility_mode:
* @session: is a #gnutls_session_t structure.
*
* This function can be used to disable certain (security) features in
}
/**
- * gnutls_hex2bin - convert hex string into binary buffer.
+ * gnutls_hex2bin:
* @hex_data: string with data in hex format
* @hex_size: size of hex data
* @bin_data: output array with binary data
/* ANON & DHE */
/**
- * gnutls_dh_set_prime_bits - Used to set the bits for a DH ciphersuite
+ * gnutls_dh_set_prime_bits:
* @session: is a #gnutls_session_t structure.
* @bits: is the number of bits
*
/**
- * gnutls_dh_get_group - return the group of the D-H key exchange
+ * gnutls_dh_get_group:
* @session: is a gnutls session
* @raw_gen: will hold the generator.
* @raw_prime: will hold the prime.
}
/**
- * gnutls_dh_get_pubkey - return the peer's public key used in D-H key exchange
+ * gnutls_dh_get_pubkey:
* @session: is a gnutls session
* @raw_key: will hold the public key.
*
}
/**
- * gnutls_rsa_export_get_pubkey - return the peer's public key used in RSA-EXPORT authentication
+ * gnutls_rsa_export_get_pubkey:
* @session: is a gnutls session
* @exponent: will hold the exponent.
* @modulus: will hold the modulus.
/**
- * gnutls_dh_get_secret_bits - return the bits used in D-H key exchange
+ * gnutls_dh_get_secret_bits:
* @session: is a gnutls session
*
* This function will return the bits used in the last Diffie-Hellman
}
/**
- * gnutls_dh_get_prime_bits - return the bits used in D-H key exchange
+ * gnutls_dh_get_prime_bits:
* @session: is a gnutls session
*
* This function will return the bits of the prime used in the last
}
/**
- * gnutls_rsa_export_get_modulus_bits - return the bits used in RSA-export key exchange
+ * gnutls_rsa_export_get_modulus_bits:
* @session: is a gnutls session
*
* Get the export RSA parameter's modulus size.
}
/**
- * gnutls_dh_get_peers_public_bits - return the bits used in D-H key exchange
+ * gnutls_dh_get_peers_public_bits:
* @session: is a gnutls session
*
* Get the Diffie-Hellman public key bit size. Can be used for both
/* CERTIFICATE STUFF */
/**
- * gnutls_certificate_get_ours - return the raw certificate sent in the last handshake
+ * gnutls_certificate_get_ours:
* @session: is a gnutls session
*
* Get the certificate as sent to the peer, in the last handshake.
}
/**
- * gnutls_certificate_get_peers - return the peer's raw certificate
+ * gnutls_certificate_get_peers:
* @session: is a gnutls session
* @list_size: is the length of the certificate list
*
/**
- * gnutls_certificate_client_get_request_status - return the certificate request status
+ * gnutls_certificate_client_get_request_status:
* @session: is a gnutls session
*
* Get whether client certificate is requested or not.
}
/**
- * gnutls_fingerprint - calculate the fingerprint of the given data
+ * gnutls_fingerprint:
* @algo: is a digest algorithm
* @data: is the data
* @result: is the place where the result will be copied (may be null).
/**
- * gnutls_certificate_set_dh_params - set the DH parameters for a server to use
+ * gnutls_certificate_set_dh_params:
* @res: is a gnutls_certificate_credentials_t structure
* @dh_params: is a structure that holds Diffie-Hellman parameters.
*
}
/**
- * gnutls_certificate_set_params_function - set the DH or RSA parameters callback
+ * gnutls_certificate_set_params_function:
* @res: is a gnutls_certificate_credentials_t structure
* @func: is the function to be called
*
/**
- * gnutls_certificate_set_verify_flags - set the flags to be used at certificate verification
+ * gnutls_certificate_set_verify_flags:
* @res: is a gnutls_certificate_credentials_t structure
* @flags: are the flags
*
}
/**
- * gnutls_certificate_set_verify_limits - set the upper limits to be used at certificate verification
+ * gnutls_certificate_set_verify_limits:
* @res: is a gnutls_certificate_credentials structure
* @max_bits: is the number of bits of an acceptable certificate (default 8200)
* @max_depth: is maximum depth of the verification of a certificate chain (default 5)
}
/**
- * gnutls_certificate_set_rsa_export_params - set the RSA parameters for a server to use
+ * gnutls_certificate_set_rsa_export_params:
* @res: is a gnutls_certificate_credentials_t structure
* @rsa_params: is a structure that holds temporary RSA parameters.
*
}
/**
- * gnutls_psk_set_params_function - set the DH or RSA parameters callback
+ * gnutls_psk_set_params_function:
* @res: is a gnutls_psk_server_credentials_t structure
* @func: is the function to be called
*
}
/**
- * gnutls_anon_set_params_function - set the DH or RSA parameters callback
+ * gnutls_anon_set_params_function:
* @res: is a gnutls_anon_server_credentials_t structure
* @func: is the function to be called
*
}
/**
- * gnutls_certificate_set_x509_key_mem - Used to set keys in a gnutls_certificate_credentials_t structure
+ * gnutls_certificate_set_x509_key_mem:
* @res: is a #gnutls_certificate_credentials_t structure.
* @cert: contains a certificate list (path) for the specified private key
* @key: is the private key, or %NULL
}
/**
- * gnutls_certificate_set_x509_key - Used to set keys in a gnutls_certificate_credentials_t structure
+ * gnutls_certificate_set_x509_key:
* @res: is a #gnutls_certificate_credentials_t structure.
* @cert_list: contains a certificate list (path) for the specified private key
* @cert_list_size: holds the size of the certificate list
}
/**
- * gnutls_certificate_set_x509_key_file - Used to set keys in a gnutls_certificate_credentials_t structure
+ * gnutls_certificate_set_x509_key_file:
* @res: is a #gnutls_certificate_credentials_t structure.
* @certfile: is a file that containing the certificate list (path) for
* the specified private key, in PKCS7 format, or a list of certificates
}
/**
- * gnutls_certificate_set_x509_trust_mem - Used to add trusted CAs in a gnutls_certificate_credentials_t structure
+ * gnutls_certificate_set_x509_trust_mem:
* @res: is a #gnutls_certificate_credentials_t structure.
* @ca: is a list of trusted CAs or a DER certificate
* @type: is DER or PEM
}
/**
- * gnutls_certificate_set_x509_trust - Used to add trusted CAs in a gnutls_certificate_credentials_t structure
+ * gnutls_certificate_set_x509_trust:
* @res: is a #gnutls_certificate_credentials_t structure.
* @ca_list: is a list of trusted CAs
* @ca_list_size: holds the size of the CA list
}
/**
- * gnutls_certificate_set_x509_trust_file - Used to add trusted CAs in a gnutls_certificate_credentials_t structure
+ * gnutls_certificate_set_x509_trust_file:
* @res: is a #gnutls_certificate_credentials_t structure.
* @cafile: is a file containing the list of trusted CAs (DER or PEM list)
* @type: is PEM or DER
}
/**
- * gnutls_certificate_set_x509_crl_mem - Used to add CRLs in a gnutls_certificate_credentials_t structure
+ * gnutls_certificate_set_x509_crl_mem:
* @res: is a #gnutls_certificate_credentials_t structure.
* @CRL: is a list of trusted CRLs. They should have been verified before.
* @type: is DER or PEM
}
/**
- * gnutls_certificate_set_x509_crl - Used to add CRLs in a gnutls_certificate_credentials_t structure
+ * gnutls_certificate_set_x509_crl:
* @res: is a #gnutls_certificate_credentials_t structure.
* @crl_list: is a list of trusted CRLs. They should have been verified before.
* @crl_list_size: holds the size of the crl_list
}
/**
- * gnutls_certificate_set_x509_crl_file - Used to add CRLs in a gnutls_certificate_credentials_t structure
+ * gnutls_certificate_set_x509_crl_file:
* @res: is a #gnutls_certificate_credentials_t structure.
* @crlfile: is a file containing the list of verified CRLs (DER or PEM list)
* @type: is PEM or DER
/**
- * gnutls_certificate_free_crls - Used to free all the CRLs from a gnutls_certificate_credentials_t structure
+ * gnutls_certificate_free_crls:
* @sc: is a #gnutls_certificate_credentials_t structure.
*
* This function will delete all the CRLs associated
typedef struct cipher_hd_st* gnutls_cipher_hd_t;
-int gnutls_cipher_init (gnutls_cipher_hd_t*, gnutls_cipher_algorithm_t cipher,
- const gnutls_datum_t * key,
- const gnutls_datum_t * iv);
-int gnutls_cipher_encrypt (const gnutls_cipher_hd_t handle, void *text, int textlen);
-int gnutls_cipher_decrypt (const gnutls_cipher_hd_t handle, void *ciphertext,
- int ciphertextlen);
+int gnutls_cipher_init (gnutls_cipher_hd_t *handle,
+ gnutls_cipher_algorithm_t cipher,
+ const gnutls_datum_t * key,
+ const gnutls_datum_t * iv);
+int gnutls_cipher_encrypt (const gnutls_cipher_hd_t handle,
+ void *text, int textlen);
+int gnutls_cipher_decrypt (const gnutls_cipher_hd_t handle,
+ void *ciphertext,
+ int ciphertextlen);
void gnutls_cipher_deinit (gnutls_cipher_hd_t handle);
int gnutls_cipher_get_block_size (gnutls_cipher_algorithm_t algorithm);
/**
- * cdk_stream_close: Close a stream and flush all buffers.
+ * cdk_stream_close:
* @s: The STREAM object.
*
- * This function work different for read or write streams. When the
- * stream is for reading, the filtering is already done and we can
- * simply close the file and all buffers.
- * But for the case it's a write stream, we need to apply all registered
- * filters now. The file is closed in the filter function and not here.
+ * Close a stream and flush all buffers. This function work different
+ * for read or write streams. When the stream is for reading, the
+ * filtering is already done and we can simply close the file and all
+ * buffers. But for the case it's a write stream, we need to apply
+ * all registered filters now. The file is closed in the filter
+ * function and not here.
**/
cdk_error_t
cdk_stream_close (cdk_stream_t s)
/**
- * cdk_stream_eof: Return if the associated file handle was set to EOF.
+ * cdk_stream_eof:
* @s: The STREAM object.
*
- * This function will only work with read streams.
+ * Return if the associated file handle was set to EOF. This
+ * function will only work with read streams.
**/
int
cdk_stream_eof (cdk_stream_t s)
/**
- * cdk_stream_get_length: Return the length of the associated file handle.
+ * cdk_stream_get_length:
* @s: The STREAM object.
*
- * This function should work for both read and write streams. For write
- * streams an additional flush is used to write possible pending data.
+ * Return the length of the associated file handle. This function
+ * should work for both read and write streams. For write streams an
+ * additional flush is used to write possible pending data.
**/
off_t
cdk_stream_get_length (cdk_stream_t s)
#include <openpgp_int.h>
/*-
- * gnutls_openpgp_verify_key - Verify all signatures on the key
+ * gnutls_openpgp_verify_key:
* @cert_list: the structure that holds the certificates.
* @cert_list_lenght: the items in the cert_list.
* @status: the output of the verification function
}
/*-
- * gnutls_openpgp_fingerprint - Gets the fingerprint
+ * gnutls_openpgp_fingerprint:
* @cert: the raw data that contains the OpenPGP public key.
* @fpr: the buffer to save the fingerprint.
* @fprlen: the integer to save the length of the fingerprint.
}
/*-
- * gnutls_openpgp_get_raw_key_creation_time - Extract the timestamp
+ * gnutls_openpgp_get_raw_key_creation_time:
* @cert: the raw data that contains the OpenPGP public key.
*
* Returns the timestamp when the OpenPGP key was created.
/*-
- * gnutls_openpgp_get_raw_key_expiration_time - Extract the expire date
+ * gnutls_openpgp_get_raw_key_expiration_time:
* @cert: the raw data that contains the OpenPGP public key.
*
* Returns the time when the OpenPGP key expires. A value of '0' means
*/
/**
- * gnutls_openpgp_keyring_init - initializes a #gnutls_openpgp_keyring_t structure
+ * gnutls_openpgp_keyring_init:
* @keyring: The structure to be initialized
*
* This function will initialize an keyring structure.
/**
- * gnutls_openpgp_keyring_deinit - deinitializes memory used by a #gnutls_openpgp_keyring_t structure
+ * gnutls_openpgp_keyring_deinit:
* @keyring: The structure to be initialized
*
* This function will deinitialize a keyring structure.
}
/**
- * gnutls_openpgp_keyring_check_id - Check if a key id exists in the keyring
+ * gnutls_openpgp_keyring_check_id:
* @ring: holds the keyring to check against
* @keyid: will hold the keyid to check for.
* @flags: unused (should be 0)
}
/**
- * gnutls_openpgp_keyring_import - Import a raw- or Base64-encoded keyring
+ * gnutls_openpgp_keyring_import:
* @keyring: The structure to store the parsed key.
* @data: The RAW or BASE64 encoded keyring.
* @format: One of #gnutls_openpgp_keyring_fmt elements.
cdk_kbnode_find_packet (node, CDK_PKT_PUBLIC_KEY)!=NULL
/**
- * gnutls_openpgp_keyring_get_crt_count - return the number of certificates
+ * gnutls_openpgp_keyring_get_crt_count:
* @ring: is an OpenPGP key ring
*
* This function will return the number of OpenPGP certificates
}
/**
- * gnutls_openpgp_keyring_get_crt - export an openpgp certificate from a keyring
+ * gnutls_openpgp_keyring_get_crt:
* @ring: Holds the keyring.
* @idx: the index of the certificate to export
* @cert: An uninitialized #gnutls_openpgp_crt_t structure
}
/**
- * gnutls_certificate_set_openpgp_key - Used to set keys in a gnutls_certificate_credentials_t structure
+ * gnutls_certificate_set_openpgp_key:
* @res: is a #gnutls_certificate_credentials_t structure.
* @key: contains an openpgp public key
* @pkey: is an openpgp private key
}
/*-
- * gnutls_openpgp_get_key - Retrieve a key from the keyring.
+ * gnutls_openpgp_get_key:
* @key: the destination context to save the key.
* @keyring: the datum struct that contains all keyring information.
* @attr: The attribute (keyid, fingerprint, ...).
}
/**
- * gnutls_certificate_set_openpgp_key_mem - Used to set OpenPGP keys
+ * gnutls_certificate_set_openpgp_key_mem:
* @res: the destination context to save the data.
* @cert: the datum that contains the public key.
* @key: the datum that contains the secret key.
/**
- * gnutls_certificate_set_openpgp_key_file - Used to set OpenPGP keys
+ * gnutls_certificate_set_openpgp_key_file:
* @res: the destination context to save the data.
* @certfile: the file that contains the public key.
* @keyfile: the file that contains the secret key.
}
/**
- * gnutls_certificate_set_openpgp_key_mem2 - Used to set OpenPGP keys
+ * gnutls_certificate_set_openpgp_key_mem2:
* @res: the destination context to save the data.
* @cert: the datum that contains the public key.
* @key: the datum that contains the secret key.
/**
- * gnutls_certificate_set_openpgp_key_file2 - Used to set OpenPGP keys
+ * gnutls_certificate_set_openpgp_key_file2:
* @res: the destination context to save the data.
* @certfile: the file that contains the public key.
* @keyfile: the file that contains the secret key.
/**
- * gnutls_certificate_set_openpgp_keyring_file - Sets a keyring file for OpenPGP
+ * gnutls_certificate_set_openpgp_keyring_file:
* @c: A certificate credentials structure
* @file: filename of the keyring.
* @format: format of keyring.
}
/**
- * gnutls_certificate_set_openpgp_keyring_mem - Add keyring data for OpenPGP
+ * gnutls_certificate_set_openpgp_keyring_mem:
* @c: A certificate credentials structure
* @data: buffer with keyring data.
* @dlen: length of data buffer.
}
/**
- * gnutls_openpgp_set_recv_key_function - Used to set a key retrieval callback for PGP keys
+ * gnutls_openpgp_set_recv_key_function:
* @session: a TLS session
* @func: the callback
*
/**
- * gnutls_openpgp_privkey_sign_hash - sign the given data using the private key params
+ * gnutls_openpgp_privkey_sign_hash:
* @key: Holds the key
* @hash: holds the data to be signed
* @signature: will contain newly allocated signature
}
/**
- * gnutls_openpgp_crt_print - Pretty print OpenPGP certificates
+ * gnutls_openpgp_crt_print:
* @cert: The structure to be printed
* @format: Indicate the format to use
* @out: Newly allocated datum with zero terminated string.
#include <gnutls_num.h>
/**
- * gnutls_openpgp_crt_init - initialize a #gnutls_openpgp_crt_t structure
+ * gnutls_openpgp_crt_init:
* @key: The structure to be initialized
*
* This function will initialize an OpenPGP key structure.
}
/**
- * gnutls_openpgp_crt_deinit - deinitialize memory used by a #gnutls_openpgp_crt_t structure
+ * gnutls_openpgp_crt_deinit:
* @key: The structure to be initialized
*
* This function will deinitialize a key structure.
}
/**
- * gnutls_openpgp_crt_import - import a RAW or BASE64 encoded key
+ * gnutls_openpgp_crt_import:
* @key: The structure to store the parsed key.
* @data: The RAW or BASE64 encoded key.
* @format: One of gnutls_openpgp_crt_fmt_t elements.
}
/**
- * gnutls_openpgp_crt_export - export a RAW or BASE64 encoded key
+ * gnutls_openpgp_crt_export:
* @key: Holds the key.
* @format: One of gnutls_openpgp_crt_fmt_t elements.
* @output_data: will contain the key base64 encoded or raw
}
/**
- * gnutls_openpgp_crt_get_fingerprint - Gets the fingerprint
+ * gnutls_openpgp_crt_get_fingerprint:
* @key: the raw data that contains the OpenPGP public key.
* @fpr: the buffer to save the fingerprint, must hold at least 20 bytes.
* @fprlen: the integer to save the length of the fingerprint.
/**
- * gnutls_openpgp_crt_get_name - Extracts the userID
+ * gnutls_openpgp_crt_get_name:
* @key: the structure that contains the OpenPGP public key.
* @idx: the index of the ID to extract
* @buf: a pointer to a structure to hold the name, may be %NULL
}
/**
- * gnutls_openpgp_crt_get_pk_algorithm - return the key's PublicKey algorithm
+ * gnutls_openpgp_crt_get_pk_algorithm:
* @key: is an OpenPGP key
* @bits: if bits is non null it will hold the size of the parameters' in bits
*
/**
- * gnutls_openpgp_crt_get_version - Extracts the version of the key.
+ * gnutls_openpgp_crt_get_version:
* @key: the structure that contains the OpenPGP public key.
*
* Extract the version of the OpenPGP key.
/**
- * gnutls_openpgp_crt_get_creation_time - Extract the timestamp
+ * gnutls_openpgp_crt_get_creation_time:
* @key: the structure that contains the OpenPGP public key.
*
* Get key creation time.
/**
- * gnutls_openpgp_crt_get_expiration_time - Extract the expire date
+ * gnutls_openpgp_crt_get_expiration_time:
* @key: the structure that contains the OpenPGP public key.
*
* Get key expiration time. A value of '0' means that the key doesn't
}
/**
- * gnutls_openpgp_crt_get_key_id - Gets the keyID
+ * gnutls_openpgp_crt_get_key_id:
* @key: the structure that contains the OpenPGP public key.
* @keyid: the buffer to save the keyid.
*
}
/**
- * gnutls_openpgp_crt_get_revoked_status - Gets the revoked status of the key
+ * gnutls_openpgp_crt_get_revoked_status:
* @key: the structure that contains the OpenPGP public key.
*
* Get revocation status of key.
}
/**
- * gnutls_openpgp_crt_check_hostname - compare hostname with the key's hostname
+ * gnutls_openpgp_crt_check_hostname:
* @key: should contain a #gnutls_openpgp_crt_t structure
* @hostname: A null terminated string that contains a DNS name
*
}
/**
- * gnutls_openpgp_crt_get_key_usage - This function returns the key's usage
+ * gnutls_openpgp_crt_get_key_usage:
* @key: should contain a gnutls_openpgp_crt_t structure
* @key_usage: where the key usage bits will be stored
*
}
/**
- * gnutls_openpgp_crt_get_subkey_count - return the number of subkeys
+ * gnutls_openpgp_crt_get_subkey_count:
* @key: is an OpenPGP key
*
* This function will return the number of subkeys present in the
}
/**
- * gnutls_openpgp_crt_get_subkey_revoked_status - Gets the revoked status of the key
+ * gnutls_openpgp_crt_get_subkey_revoked_status:
* @key: the structure that contains the OpenPGP public key.
* @idx: is the subkey index
*
}
/**
- * gnutls_openpgp_crt_get_subkey_pk_algorithm - return the subkey's PublicKey algorithm
+ * gnutls_openpgp_crt_get_subkey_pk_algorithm:
* @key: is an OpenPGP key
* @idx: is the subkey index
* @bits: if bits is non null it will hold the size of the parameters' in bits
}
/**
- * gnutls_openpgp_crt_get_subkey_creation_time - Extract the timestamp
+ * gnutls_openpgp_crt_get_subkey_creation_time:
* @key: the structure that contains the OpenPGP public key.
* @idx: the subkey index
*
/**
- * gnutls_openpgp_crt_get_subkey_expiration_time - Extract the expire date
+ * gnutls_openpgp_crt_get_subkey_expiration_time:
* @key: the structure that contains the OpenPGP public key.
* @idx: the subkey index
*
}
/**
- * gnutls_openpgp_crt_get_subkey_id - Gets the keyID
+ * gnutls_openpgp_crt_get_subkey_id:
* @key: the structure that contains the OpenPGP public key.
* @idx: the subkey index
* @keyid: the buffer to save the keyid.
}
/**
- * gnutls_openpgp_crt_get_subkey_fingerprint - Gets the fingerprint of a subkey
+ * gnutls_openpgp_crt_get_subkey_fingerprint:
* @key: the raw data that contains the OpenPGP public key.
* @idx: the subkey index
* @fpr: the buffer to save the fingerprint, must hold at least 20 bytes.
}
/**
- * gnutls_openpgp_crt_get_subkey_idx - Returns the subkey's index
+ * gnutls_openpgp_crt_get_subkey_idx:
* @key: the structure that contains the OpenPGP public key.
* @keyid: the keyid.
*
}
/**
- * gnutls_openpgp_crt_get_subkey_usage - returns the key's usage
+ * gnutls_openpgp_crt_get_subkey_usage:
* @key: should contain a gnutls_openpgp_crt_t structure
* @idx: the subkey index
* @key_usage: where the key usage bits will be stored
/**
- * gnutls_openpgp_crt_get_pk_rsa_raw - export the RSA public key
+ * gnutls_openpgp_crt_get_pk_rsa_raw:
* @crt: Holds the certificate
* @m: will hold the modulus
* @e: will hold the public exponent
}
/**
- * gnutls_openpgp_crt_get_pk_dsa_raw - export the DSA public key
+ * gnutls_openpgp_crt_get_pk_dsa_raw:
* @crt: Holds the certificate
* @p: will hold the p
* @q: will hold the q
}
/**
- * gnutls_openpgp_crt_get_subkey_pk_rsa_raw - export the RSA public key
+ * gnutls_openpgp_crt_get_subkey_pk_rsa_raw:
* @crt: Holds the certificate
* @idx: Is the subkey index
* @m: will hold the modulus
}
/**
- * gnutls_openpgp_crt_get_subkey_pk_dsa_raw - export the DSA public key
+ * gnutls_openpgp_crt_get_subkey_pk_dsa_raw:
* @crt: Holds the certificate
* @idx: Is the subkey index
* @p: will hold the p
}
/**
- * gnutls_openpgp_crt_get_preferred_key_id - Gets the preferred keyID
+ * gnutls_openpgp_crt_get_preferred_key_id:
* @key: the structure that contains the OpenPGP public key.
* @keyid: the struct to save the keyid.
*
}
/**
- * gnutls_openpgp_crt_set_preferred_key_id - Sets the preferred keyID
+ * gnutls_openpgp_crt_set_preferred_key_id:
* @key: the structure that contains the OpenPGP public key.
* @keyid: the selected keyid
*
}
/**
- * gnutls_openpgp_crt_get_auth_subkey - Gets the keyID of an authentication subkey
+ * gnutls_openpgp_crt_get_auth_subkey:
* @crt: the structure that contains the OpenPGP public key.
* @keyid: the struct to save the keyid.
* @flag: Non zero indicates that a valid subkey is always returned.
#include <gnutls_num.h>
/**
- * gnutls_openpgp_crt_verify_ring - Verify all signatures in the key
+ * gnutls_openpgp_crt_verify_ring:
* @key: the structure that holds the key.
* @keyring: holds the keyring to check against
* @flags: unused (should be 0)
/**
- * gnutls_openpgp_crt_verify_self - Verify the self signature on the key
+ * gnutls_openpgp_crt_verify_self:
* @key: the structure that holds the key.
* @flags: unused (should be 0)
* @verify: will hold the key verification output.
#include <gnutls_cert.h>
/**
- * gnutls_openpgp_privkey_init - initializes a #gnutls_openpgp_privkey_t structure
+ * gnutls_openpgp_privkey_init:
* @key: The structure to be initialized
*
* This function will initialize an OpenPGP key structure.
}
/**
- * gnutls_openpgp_privkey_deinit - deinitializes memory used by a #gnutls_openpgp_privkey_t structure
+ * gnutls_openpgp_privkey_deinit:
* @key: The structure to be initialized
*
* This function will deinitialize a key structure.
}
/**
- * gnutls_openpgp_privkey_import - import a RAW or BASE64 encoded key
+ * gnutls_openpgp_privkey_import:
* @key: The structure to store the parsed key.
* @data: The RAW or BASE64 encoded key.
* @format: One of #gnutls_openpgp_crt_fmt_t elements.
}
/**
- * gnutls_openpgp_privkey_export - export a RAW or BASE64 encoded key
+ * gnutls_openpgp_privkey_export:
* @key: Holds the key.
* @format: One of gnutls_openpgp_crt_fmt_t elements.
* @password: the password that will be used to encrypt the key. (unused for now)
/**
- * gnutls_openpgp_privkey_get_pk_algorithm - return the key's PublicKey algorithm
+ * gnutls_openpgp_privkey_get_pk_algorithm:
* @key: is an OpenPGP key
* @bits: if bits is non null it will hold the size of the parameters' in bits
*
}
/**
- * gnutls_openpgp_privkey_get_revoked_ status - Get the revoked status of the key
+ * gnutls_openpgp_privkey_get_revoked_status:
* @key: the structure that contains the OpenPGP private key.
*
* Get revocation status of key.
}
/**
- * gnutls_openpgp_privkey_get_fingerprint - Gets the fingerprint
+ * gnutls_openpgp_privkey_get_fingerprint:
* @key: the raw data that contains the OpenPGP secret key.
* @fpr: the buffer to save the fingerprint, must hold at least 20 bytes.
* @fprlen: the integer to save the length of the fingerprint.
}
/**
- * gnutls_openpgp_privkey_get_key_id - Gets the keyID
+ * gnutls_openpgp_privkey_get_key_id:
* @key: the structure that contains the OpenPGP secret key.
* @keyid: the buffer to save the keyid.
*
/**
- * gnutls_openpgp_privkey_get_subkey_count - return the number of subkeys
+ * gnutls_openpgp_privkey_get_subkey_count:
* @key: is an OpenPGP key
*
* This function will return the number of subkeys present in the
}
/**
- * gnutls_openpgp_privkey_get_subkey_revoked_ status - Get the revoked status of the key
+ * gnutls_openpgp_privkey_get_subkey_revoked_status:
* @key: the structure that contains the OpenPGP private key.
* @idx: is the subkey index
*
}
/**
- * gnutls_openpgp_privkey_get_subkey_pk_algorithm - return the subkey's PublicKey algorithm
+ * gnutls_openpgp_privkey_get_subkey_pk_algorithm:
* @key: is an OpenPGP key
* @idx: is the subkey index
* @bits: if bits is non null it will hold the size of the parameters' in bits
}
/**
- * gnutls_openpgp_privkey_get_subkey_idx - Returns the subkey's index
+ * gnutls_openpgp_privkey_get_subkey_idx:
* @key: the structure that contains the OpenPGP private key.
* @keyid: the keyid.
*
}
/**
- * gnutls_openpgp_privkey_get_subkey_creation_time - Extract the timestamp
+ * gnutls_openpgp_privkey_get_subkey_creation_time:
* @key: the structure that contains the OpenPGP private key.
* @idx: the subkey index
*
}
/**
- * gnutls_openpgp_privkey_get_subkey_expiration_time - Extract the expire date
+ * gnutls_openpgp_privkey_get_subkey_expiration_time:
* @key: the structure that contains the OpenPGP private key.
* @idx: the subkey index
*
}
/**
- * gnutls_openpgp_privkey_get_subkey_id - Gets the keyID
+ * gnutls_openpgp_privkey_get_subkey_id:
* @key: the structure that contains the OpenPGP secret key.
* @idx: the subkey index
* @keyid: the buffer to save the keyid.
}
/**
- * gnutls_openpgp_privkey_get_subkey_fingerprint - Gets the fingerprint of a subkey
+ * gnutls_openpgp_privkey_get_subkey_fingerprint:
* @key: the raw data that contains the OpenPGP secret key.
* @idx: the subkey index
* @fpr: the buffer to save the fingerprint, must hold at least 20 bytes.
/**
- * gnutls_openpgp_privkey_export_rsa_raw - This function will export the RSA private key
+ * gnutls_openpgp_privkey_export_rsa_raw:
* @pkey: Holds the certificate
* @m: will hold the modulus
* @e: will hold the public exponent
}
/**
- * gnutls_openpgp_privkey_export_dsa_raw - This function will export the DSA private key
+ * gnutls_openpgp_privkey_export_dsa_raw:
* @pkey: Holds the certificate
* @p: will hold the p
* @q: will hold the q
}
/**
- * gnutls_openpgp_privkey_export_subkey_rsa_raw - export the RSA private key
+ * gnutls_openpgp_privkey_export_subkey_rsa_raw:
* @pkey: Holds the certificate
* @idx: Is the subkey index
* @m: will hold the modulus
}
/**
- * gnutls_openpgp_privkey_export_subkey_dsa_raw - export the DSA private key
+ * gnutls_openpgp_privkey_export_subkey_dsa_raw:
* @pkey: Holds the certificate
* @idx: Is the subkey index
* @p: will hold the p
}
/**
- * gnutls_openpgp_privkey_get_preferred_key_id - Gets the preferred keyID
+ * gnutls_openpgp_privkey_get_preferred_key_id:
* @key: the structure that contains the OpenPGP public key.
* @keyid: the struct to save the keyid.
*
}
/**
- * gnutls_openpgp_privkey_set_preferred_key_id - Set the preferred keyID
+ * gnutls_openpgp_privkey_set_preferred_key_id:
* @key: the structure that contains the OpenPGP public key.
* @keyid: the selected keyid
*
}
/**
- * gnutls_x509_dn_oid_known - return true if the given OID is known
+ * gnutls_x509_dn_oid_known:
* @oid: holds an Object Identifier in a null terminated string
*
* This function will inform about known DN OIDs. This is useful since
#include <x509_int.h>
/**
- * gnutls_x509_crl_init - initializes a #gnutls_x509_crl_t structure
+ * gnutls_x509_crl_init:
* @crl: The structure to be initialized
*
* This function will initialize a CRL structure. CRL stands for
}
/**
- * gnutls_x509_crl_deinit - deinitializes a #gnutls_x509_crl_t structure
+ * gnutls_x509_crl_deinit:
* @crl: The structure to be initialized
*
* This function will deinitialize a CRL structure.
}
/**
- * gnutls_x509_crl_import - import a DER or PEM encoded CRL
+ * gnutls_x509_crl_import:
* @crl: The structure to store the parsed CRL.
* @data: The DER or PEM encoded CRL.
* @format: One of DER or PEM
/**
- * gnutls_x509_crl_get_issuer_dn - returns the CRL's issuer distinguished name
+ * gnutls_x509_crl_get_issuer_dn:
* @crl: should contain a gnutls_x509_crl_t structure
* @buf: a pointer to a structure to hold the peer's name (may be null)
* @sizeof_buf: initially holds the size of @buf
}
/**
- * gnutls_x509_crl_get_issuer_dn_by_oid - return the CRL's issuer distinguished name
+ * gnutls_x509_crl_get_issuer_dn_by_oid:
* @crl: should contain a gnutls_x509_crl_t structure
* @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 zero to get the first one.
}
/**
- * gnutls_x509_crl_get_dn_oid - returns the Certificate request issuer's distinguished name OIDs
+ * gnutls_x509_crl_get_dn_oid:
* @crl: should contain a gnutls_x509_crl_t structure
* @indx: Specifies which DN OID to send. Use zero to get the first one.
* @oid: a pointer to a structure to hold the name (may be null)
/**
- * gnutls_x509_crl_get_signature_algorithm - returns the CRL's signature algorithm
+ * gnutls_x509_crl_get_signature_algorithm:
* @crl: should contain a #gnutls_x509_crl_t structure
*
* This function will return a value of the #gnutls_sign_algorithm_t
}
/**
- * gnutls_x509_crl_get_signature - Returns the CRL's signature
+ * gnutls_x509_crl_get_signature:
* @crl: should contain a gnutls_x509_crl_t structure
* @sig: a pointer where the signature part will be copied (may be null).
* @sizeof_sig: initially holds the size of @sig
}
/**
- * gnutls_x509_crl_get_version - returns the CRL's version number
+ * gnutls_x509_crl_get_version:
* @crl: should contain a #gnutls_x509_crl_t structure
*
* This function will return the version of the specified CRL.
}
/**
- * gnutls_x509_crl_get_this_update - return the CRL's thisUpdate time
+ * gnutls_x509_crl_get_this_update:
* @crl: should contain a #gnutls_x509_crl_t structure
*
* This function will return the time this CRL was issued.
}
/**
- * gnutls_x509_crl_get_next_update - return the CRL's nextUpdate time
+ * gnutls_x509_crl_get_next_update:
* @crl: should contain a #gnutls_x509_crl_t structure
*
* This function will return the time the next CRL will be issued.
}
/**
- * gnutls_x509_crl_get_crt_count - get number of revoked certificates in a CRL
+ * gnutls_x509_crl_get_crt_count:
* @crl: should contain a #gnutls_x509_crl_t structure
*
* This function will return the number of revoked certificates in the
}
/**
- * gnutls_x509_crl_get_crt_serial - get the serial number of a revoked certificate
+ * gnutls_x509_crl_get_crt_serial:
* @crl: should contain a #gnutls_x509_crl_t structure
* @indx: the index of the certificate to extract (starting from 0)
* @serial: where the serial number will be copied
}
/**
- * gnutls_x509_crl_export - export the CRL
+ * gnutls_x509_crl_export:
* @crl: Holds the revocation list
* @format: the format of output params. One of PEM or DER.
* @output_data: will contain a private key PEM or DER encoded
}
/**
- * gnutls_x509_crl_get_authority_key_id - get the CRL authority's identifier
+ * gnutls_x509_crl_get_authority_key_id:
* @crl: should contain a #gnutls_x509_crl_t structure
* @ret: The place where the identifier will be copied
* @ret_size: Holds the size of the result field.
}
/**
- * gnutls_x509_crl_get_number - get the CRL number (extension)
+ * gnutls_x509_crl_get_number:
* @crl: should contain a #gnutls_x509_crl_t structure
* @ret: The place where the number will be copied
* @ret_size: Holds the size of the result field.
}
/**
- * gnutls_x509_crl_get_extension_oid - get the specified extension OID
+ * gnutls_x509_crl_get_extension_oid:
* @crl: should contain a #gnutls_x509_crl_t structure
* @indx: Specifies which extension OID to send, use zero to get the first one.
* @oid: a pointer to a structure to hold the OID (may be null)
}
/**
- * gnutls_x509_crl_get_extension_info - Get extension id and criticality
+ * gnutls_x509_crl_get_extension_info:
* @crl: should contain a #gnutls_x509_crl_t structure
* @indx: Specifies which extension OID to send, use zero to get the first one.
* @oid: a pointer to a structure to hold the OID
}
/**
- * gnutls_x509_crl_get_extension_data - Get the specified extension data
+ * gnutls_x509_crl_get_extension_data:
* @crl: should contain a #gnutls_x509_crl_t structure
* @indx: Specifies which extension OID to send. Use zero to get the first one.
* @data: a pointer to a structure to hold the data (may be null)
static void disable_optional_stuff (gnutls_x509_crl_t crl);
/**
- * gnutls_x509_crl_set_version - This function will set the CRL version
+ * gnutls_x509_crl_set_version:
* @crl: should contain a gnutls_x509_crl_t structure
* @version: holds the version number. For CRLv1 crls must be 1.
*
}
/**
- * gnutls_x509_crl_sign2 - This function will sign a CRL with a key
+ * gnutls_x509_crl_sign2:
* @crl: should contain a gnutls_x509_crl_t structure
* @issuer: is the certificate of the certificate issuer
* @issuer_key: holds the issuer's private key
}
/**
- * gnutls_x509_crl_sign - This function will sign a CRL with a key
+ * gnutls_x509_crl_sign:
* @crl: should contain a gnutls_x509_crl_t structure
* @issuer: is the certificate of the certificate issuer
* @issuer_key: holds the issuer's private key
}
/**
- * gnutls_x509_crl_set_this_update - This function will set the CRL's issuing time
+ * gnutls_x509_crl_set_this_update:
* @crl: should contain a gnutls_x509_crl_t structure
* @act_time: The actual time
*
}
/**
- * gnutls_x509_crl_set_next_update - This function will set the CRL next update time
+ * gnutls_x509_crl_set_next_update:
* @crl: should contain a gnutls_x509_crl_t structure
* @exp_time: The actual time
*
}
/**
- * gnutls_x509_crl_set_crt_serial - This function will set a revoked certificate's serial number
+ * gnutls_x509_crl_set_crt_serial:
* @crl: should contain a gnutls_x509_crl_t structure
* @serial: The revoked certificate's serial number
* @serial_size: Holds the size of the serial field.
}
/**
- * gnutls_x509_crl_set_crt - This function will set a revoked certificate's serial number
+ * gnutls_x509_crl_set_crt:
* @crl: should contain a gnutls_x509_crl_t structure
* @crt: a certificate of type #gnutls_x509_crt_t with the revoked certificate
* @revocation_time: The time this certificate was revoked
}
/**
- * gnutls_x509_crl_set_authority_key_id - Set the CRL's authority key id
+ * gnutls_x509_crl_set_authority_key_id:
* @crl: a CRL of type #gnutls_x509_crl_t
* @id: The key ID
* @id_size: Holds the size of the serial field.
}
/**
- * gnutls_x509_crl_set_number - Set the CRL's number extension
+ * gnutls_x509_crl_set_number:
* @crl: a CRL of type #gnutls_x509_crl_t
* @nr: The CRL number
* @nr_size: Holds the size of the nr field.
#include <libtasn1.h>
/**
- * gnutls_x509_crq_init - initializes a #gnutls_x509_crq_t structure
+ * gnutls_x509_crq_init:
* @crq: The structure to be initialized
*
* This function will initialize a PKCS#10 certificate request
}
/**
- * gnutls_x509_crq_deinit - deinitializes a #gnutls_x509_crq_t structure
+ * gnutls_x509_crq_deinit:
* @crq: The structure to be initialized
*
* This function will deinitialize a PKCS#10 certificate request
#define PEM_CRQ2 "CERTIFICATE REQUEST"
/**
- * gnutls_x509_crq_import - import a DER or PEM encoded Certificate request
+ * gnutls_x509_crq_import:
* @crq: The structure to store the parsed certificate request.
* @data: The DER or PEM encoded certificate.
* @format: One of DER or PEM
/**
- * gnutls_x509_crq_get_dn - get certificate request subject's distinguished name
+ * gnutls_x509_crq_get_dn:
* @crq: should contain a #gnutls_x509_crq_t structure
* @buf: a pointer to a structure to hold the name (may be %NULL)
* @sizeof_buf: initially holds the size of @buf
}
/**
- * gnutls_x509_crq_get_dn_by_oid - get certificate request subject's distinguished name
+ * gnutls_x509_crq_get_dn_by_oid:
* @crq: should contain a gnutls_x509_crq_t structure
* @oid: holds an Object Identified in null terminated string
* @indx: In case multiple same OIDs exist in the RDN, this specifies
}
/**
- * gnutls_x509_crq_get_dn_oid - This function returns the Certificate request subject's distinguished name OIDs
+ * gnutls_x509_crq_get_dn_oid:
* @crq: should contain a gnutls_x509_crq_t structure
* @indx: Specifies which DN OID to send. Use zero to get the first one.
* @oid: a pointer to a structure to hold the name (may be %NULL)
}
/**
- * gnutls_x509_crq_get_challenge_password - get challenge password
+ * gnutls_x509_crq_get_challenge_password:
* @crq: should contain a #gnutls_x509_crq_t structure
* @pass: will hold a zero-terminated password string
* @sizeof_pass: Initially holds the size of @pass.
}
/**
- * gnutls_x509_crq_set_attribute_by_oid - set attribute in the request
+ * gnutls_x509_crq_set_attribute_by_oid:
* @crq: should contain a #gnutls_x509_crq_t structure
* @oid: holds an Object Identified in zero-terminated string
* @buf: a pointer to a structure that holds the attribute data
}
/**
- * gnutls_x509_crq_get_attribute_by_oid - get an attribute in the request
+ * gnutls_x509_crq_get_attribute_by_oid:
* @crq: should contain a #gnutls_x509_crq_t structure
* @oid: holds an Object Identified in zero-terminated string
* @indx: In case multiple same OIDs exist in the attribute list, this
}
/**
- * gnutls_x509_crq_set_dn_by_oid - set the certificate request subject's distinguished name
+ * gnutls_x509_crq_set_dn_by_oid:
* @crq: should contain a #gnutls_x509_crq_t structure
* @oid: holds an Object Identifier in a zero-terminated string
* @raw_flag: must be 0, or 1 if the data are DER encoded
}
/**
- * gnutls_x509_crq_set_version - set the Certificate request version
+ * gnutls_x509_crq_set_version:
* @crq: should contain a #gnutls_x509_crq_t structure
* @version: holds the version number, for v1 Requests must be 1
*
}
/**
- * gnutls_x509_crq_get_version - get certificate request's version number
+ * gnutls_x509_crq_get_version:
* @crq: should contain a #gnutls_x509_crq_t structure
*
* This function will return the version of the specified Certificate
}
/**
- * gnutls_x509_crq_set_key - associate the certificate request with a key
+ * gnutls_x509_crq_set_key:
* @crq: should contain a #gnutls_x509_crq_t structure
* @key: holds a private key
*
}
/**
- * gnutls_x509_crq_get_key_rsa_raw - export the RSA public key
+ * gnutls_x509_crq_get_key_rsa_raw:
* @crq: Holds the certificate
* @m: will hold the modulus
* @e: will hold the public exponent
}
/**
- * gnutls_x509_crq_set_key_rsa_raw - associate Certificate request with a key
+ * gnutls_x509_crq_set_key_rsa_raw:
* @crq: should contain a #gnutls_x509_crq_t structure
* @m: holds the modulus
* @e: holds the public exponent
}
/**
- * gnutls_x509_crq_set_challenge_password - set a challenge password
+ * gnutls_x509_crq_set_challenge_password:
* @crq: should contain a #gnutls_x509_crq_t structure
* @pass: holds a zero-terminated password
*
}
/**
- * gnutls_x509_crq_sign2 - Sign a Certificate request with a key
+ * gnutls_x509_crq_sign2:
* @crq: should contain a #gnutls_x509_crq_t structure
* @key: holds a private key
* @dig: The message digest to use, i.e., %GNUTLS_DIG_SHA1
}
/**
- * gnutls_x509_crq_sign - sign a Certificate request with a key
+ * gnutls_x509_crq_sign:
* @crq: should contain a #gnutls_x509_crq_t structure
* @key: holds a private key
*
}
/**
- * gnutls_x509_crq_export - Export the generated certificate request
+ * gnutls_x509_crq_export:
* @crq: should contain a #gnutls_x509_crq_t structure
* @format: the format of output params. One of PEM or DER.
* @output_data: will contain a certificate request PEM or DER encoded
}
/**
- * gnutls_x509_crq_get_pk_algorithm - get certificate request public key algorithm
+ * gnutls_x509_crq_get_pk_algorithm:
* @crq: should contain a #gnutls_x509_crq_t structure
* @bits: if bits is non-%NULL it will hold the size of the parameters' in bits
*
}
/**
- * gnutls_x509_crq_get_attribute_info - Get attribute id
+ * gnutls_x509_crq_get_attribute_info:
* @crq: should contain a #gnutls_x509_crq_t structure
* @indx: Specifies which attribute OID to send. Use zero to get the first one.
* @oid: a pointer to a structure to hold the OID
}
/**
- * gnutls_x509_crq_get_attribute_data - Get the specified attribute data
+ * gnutls_x509_crq_get_attribute_data:
* @crq: should contain a #gnutls_x509_crq_t structure
* @indx: Specifies which attribute OID to send. Use zero to get the first one.
* @data: a pointer to a structure to hold the data (may be null)
}
/**
- * gnutls_x509_crq_get_extension_info - Get extension id and criticality
+ * gnutls_x509_crq_get_extension_info:
* @crq: should contain a #gnutls_x509_crq_t structure
* @indx: Specifies which extension OID to send. Use zero to get the first one.
* @oid: a pointer to a structure to hold the OID
}
/**
- * gnutls_x509_crq_get_extension_data - Get the specified extension data
+ * gnutls_x509_crq_get_extension_data:
* @crq: should contain a #gnutls_x509_crq_t structure
* @indx: Specifies which extension OID to send. Use zero to get the first one.
* @data: a pointer to a structure to hold the data (may be null)
}
/**
- * gnutls_x509_crq_get_key_usage - return the certificate's key usage
+ * gnutls_x509_crq_get_key_usage:
* @crq: should contain a #gnutls_x509_crq_t structure
* @key_usage: where the key usage bits will be stored
* @critical: will be non zero if the extension is marked as critical
}
/**
- * gnutls_x509_crq_get_basic_constraints - get certificate's basic constraints
+ * gnutls_x509_crq_get_basic_constraints:
* @crq: should contain a #gnutls_x509_crq_t structure
* @critical: will be non zero if the extension is marked as critical
* @ca: pointer to output integer indicating CA status, may be NULL,
}
/**
- * gnutls_x509_crq_get_subject_alt_name - Get certificate's alternative name
+ * gnutls_x509_crq_get_subject_alt_name:
* @crq: should contain a #gnutls_x509_crq_t structure
* @seq: specifies the sequence number of the alt name, 0 for the
* first one, 1 for the second etc.
}
/**
- * gnutls_x509_crq_get_subject_alt_othername_oid - Get SAN otherName OID
+ * gnutls_x509_crq_get_subject_alt_othername_oid:
* @crq: should contain a #gnutls_x509_crq_t structure
* @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
}
/**
- * gnutls_x509_crq_get_extension_by_oid - get the specified extension
+ * gnutls_x509_crq_get_extension_by_oid:
* @crq: should contain a #gnutls_x509_crq_t structure
* @oid: holds an Object Identified in null terminated string
* @indx: In case multiple same OIDs exist in the extensions, this
}
/**
- * gnutls_x509_crq_set_subject_alt_name - Set the subject Alternative Name
+ * gnutls_x509_crq_set_subject_alt_name:
* @crq: a certificate request of type #gnutls_x509_crq_t
* @nt: is one of the #gnutls_x509_subject_alt_name_t enumerations
* @data: The data to be set
}
/**
- * gnutls_x509_crq_set_basic_constraints - Set the basicConstraints extension
+ * gnutls_x509_crq_set_basic_constraints:
* @crq: a certificate request of type #gnutls_x509_crq_t
* @ca: true(1) or false(0) depending on the Certificate authority status.
* @pathLenConstraint: non-negative values indicate maximum length of path,
}
/**
- * gnutls_x509_crq_set_key_usage - Set the keyUsage extension
+ * gnutls_x509_crq_set_key_usage:
* @crq: a certificate request of type #gnutls_x509_crq_t
* @usage: an ORed sequence of the GNUTLS_KEY_* elements.
*
}
/**
- * gnutls_x509_crq_get_key_purpose_oid - get Certificate's key purpose OIDs
+ * gnutls_x509_crq_get_key_purpose_oid:
* @crq: should contain a #gnutls_x509_crq_t structure
* @indx: This specifies which OID to return, use zero to get the first one
* @oid: a pointer to a buffer to hold the OID (may be %NULL)
}
/**
- * gnutls_x509_crq_set_key_purpose_oid - Sets the Certificate's key purpose OIDs
+ * gnutls_x509_crq_set_key_purpose_oid:
* @crq: a certificate of type #gnutls_x509_crq_t
* @oid: a pointer to a zero-terminated string that holds the OID
* @critical: Whether this extension will be critical or not
}
/**
- * gnutls_x509_crq_get_key_id - Return unique ID of public key's parameters
+ * gnutls_x509_crq_get_key_id:
* @crq: a certificate of type #gnutls_x509_crq_t
* @flags: should be 0 for now
* @output_data: will contain the key ID
}
/**
- * gnutls_x509_dn_init: initialize an opaque DN object
+ * gnutls_x509_dn_init:
* @dn: the object to be initialized
*
* This function initializes a #gnutls_x509_dn_t structure.
}
/**
- * gnutls_x509_dn_import: get opaque DN object from DER RDN sequence
+ * gnutls_x509_dn_import:
* @dn: the structure that will hold the imported DN
* @data: should contain a DER encoded RDN sequence
*
}
/**
- * gnutls_x509_dn_deinit: deallocate a DN object
+ * gnutls_x509_dn_deinit:
* @dn: a DN opaque object pointer.
*
* This function deallocates the DN object as returned by
}
/**
- * gnutls_x509_rdn_get - parse an RDN sequence and returns a string
+ * gnutls_x509_rdn_get:
* @idn: should contain a DER encoded RDN sequence
* @buf: a pointer to a structure to hold the peer's name
* @sizeof_buf: holds the size of @buf
}
/**
- * gnutls_x509_rdn_get_by_oid - parse an RDN sequence and returns a string
+ * gnutls_x509_rdn_get_by_oid:
* @idn: should contain a DER encoded RDN sequence
* @oid: an Object Identifier
* @indx: In case multiple same OIDs exist in the RDN indicates which
}
/**
- * gnutls_x509_rdn_get_oid - parse an RDN sequence and returns an OID.
+ * gnutls_x509_rdn_get_oid:
* @idn: should contain a DER encoded RDN sequence
* @indx: Indicates which OID to return. Use 0 for the first one.
* @buf: a pointer to a structure to hold the peer's name OID
}
/**
- * gnutls_x509_dn_export - This function will export the DN
+ * gnutls_x509_dn_export:
* @dn: Holds the opaque DN object
* @format: the format of output params. One of PEM or DER.
* @output_data: will contain a DN PEM or DER encoded
}
/**
- * gnutls_x509_crt_print - Pretty print X.509 certificates
+ * gnutls_x509_crt_print:
* @cert: The structure to be printed
* @format: Indicate the format to use
* @out: Newly allocated datum with zero terminated string.
}
/**
- * gnutls_x509_crl_print - Pretty print X.509 certificate revocation list
+ * gnutls_x509_crl_print:
* @crl: The structure to be printed
* @format: Indicate the format to use
* @out: Newly allocated datum with zero terminated string.
}
/**
- * gnutls_x509_crq_print - Pretty print PKCS 10 certificate request
+ * gnutls_x509_crq_print:
* @crq: The structure to be printed
* @format: Indicate the format to use
* @out: Newly allocated datum with zero terminated string.
}
/**
- * gnutls_pkcs12_init - This function initializes a gnutls_pkcs12_t structure
+ * gnutls_pkcs12_init:
* @pkcs12: The structure to be initialized
*
* This function will initialize a PKCS12 structure. PKCS12 structures
}
/**
- * gnutls_pkcs12_deinit - This function deinitializes memory used by a gnutls_pkcs12_t structure
+ * gnutls_pkcs12_deinit:
* @pkcs12: The structure to be initialized
*
* This function will deinitialize a PKCS12 structure.
}
/**
- * gnutls_pkcs12_import - This function will import a DER or PEM encoded PKCS12 structure
+ * gnutls_pkcs12_import:
* @pkcs12: The structure to store the parsed PKCS12.
* @data: The DER or PEM encoded PKCS12.
* @format: One of DER or PEM
/**
- * gnutls_pkcs12_export - This function will export the pkcs12 structure
+ * gnutls_pkcs12_export:
* @pkcs12: Holds the pkcs12 structure
* @format: the format of output params. One of PEM or DER.
* @output_data: will contain a structure PEM or DER encoded
/**
- * gnutls_pkcs12_get_bag - This function returns a Bag from a PKCS12 structure
+ * gnutls_pkcs12_get_bag:
* @pkcs12: should contain a gnutls_pkcs12_t structure
* @indx: contains the index of the bag to extract
* @bag: An initialized bag, where the contents of the bag will be copied
}
/**
- * gnutls_pkcs12_set_bag - This function inserts a Bag into a PKCS12 structure
+ * gnutls_pkcs12_set_bag:
* @pkcs12: should contain a gnutls_pkcs12_t structure
* @bag: An initialized bag
*
}
/**
- * gnutls_pkcs12_generate_mac - This function generates the MAC of the PKCS12 structure
+ * gnutls_pkcs12_generate_mac:
* @pkcs12: should contain a gnutls_pkcs12_t structure
* @pass: The password for the MAC
*
}
/**
- * gnutls_pkcs12_verify_mac - This function verifies the MAC of the PKCS12 structure
+ * gnutls_pkcs12_verify_mac:
* @pkcs12: should contain a gnutls_pkcs12_t structure
* @pass: The password for the MAC
*
#include "x509_int.h"
/**
- * gnutls_pkcs12_bag_init - This function initializes a gnutls_pkcs12_bag_t structure
+ * gnutls_pkcs12_bag_init:
* @bag: The structure to be initialized
*
* This function will initialize a PKCS12 bag structure. PKCS12 Bags
/**
- * gnutls_pkcs12_bag_deinit - This function deinitializes memory used by a gnutls_pkcs12_t structure
+ * gnutls_pkcs12_bag_deinit:
* @bag: The structure to be initialized
*
* This function will deinitialize a PKCS12 Bag structure.
}
/**
- * gnutls_pkcs12_bag_get_type - This function returns the bag's type
+ * gnutls_pkcs12_bag_get_type:
* @bag: The bag
* @indx: The element of the bag to get the type
*
}
/**
- * gnutls_pkcs12_bag_get_count - This function returns the bag's elements count
+ * gnutls_pkcs12_bag_get_count:
* @bag: The bag
*
* This function will return the number of the elements withing the bag.
}
/**
- * gnutls_pkcs12_bag_get_data - This function returns the bag's data
+ * gnutls_pkcs12_bag_get_data:
* @bag: The bag
* @indx: The element of the bag to get the data from
* @data: where the bag's data will be. Should be treated as constant.
/**
- * gnutls_pkcs12_bag_set_data - This function inserts data into the bag
+ * gnutls_pkcs12_bag_set_data:
* @bag: The bag
* @type: The data's type
* @data: the data to be copied.
}
/**
- * gnutls_pkcs12_bag_set_crt - This function inserts a certificate into the bag
+ * gnutls_pkcs12_bag_set_crt:
* @bag: The bag
* @crt: the certificate to be copied.
*
}
/**
- * gnutls_pkcs12_bag_set_crl - insert the CRL into the bag
+ * gnutls_pkcs12_bag_set_crl:
* @bag: The bag
* @crl: the CRL to be copied.
*
}
/**
- * gnutls_pkcs12_bag_set_key_id - This function sets a key ID into the bag element
+ * gnutls_pkcs12_bag_set_key_id:
* @bag: The bag
* @indx: The bag's element to add the id
* @id: the ID
}
/**
- * gnutls_pkcs12_bag_get_key_id - This function gets the key ID from the bag element
+ * gnutls_pkcs12_bag_get_key_id:
* @bag: The bag
* @indx: The bag's element to add the id
* @id: where the ID will be copied (to be treated as const)
}
/**
- * gnutls_pkcs12_bag_get_friendly_name - This function returns the friendly name of the bag element
+ * gnutls_pkcs12_bag_get_friendly_name:
* @bag: The bag
* @indx: The bag's element to add the id
* @name: will hold a pointer to the name (to be treated as const)
/**
- * gnutls_pkcs12_bag_set_friendly_name - This function sets a friendly name into the bag element
+ * gnutls_pkcs12_bag_set_friendly_name:
* @bag: The bag
* @indx: The bag's element to add the id
* @name: the name
/**
- * gnutls_pkcs12_bag_decrypt - This function will decrypt an encrypted bag
+ * gnutls_pkcs12_bag_decrypt:
* @bag: The bag
* @pass: The password used for encryption, must be ASCII.
*
}
/**
- * gnutls_pkcs12_bag_encrypt - This function will encrypt a bag
+ * gnutls_pkcs12_bag_encrypt:
* @bag: The bag
* @pass: The password used for encryption, must be ASCII
* @flags: should be one of #gnutls_pkcs_encrypt_flags_t elements bitwise or'd
}
/**
- * gnutls_pkcs7_init - initialize a #gnutls_pkcs7_t structure
+ * gnutls_pkcs7_init:
* @pkcs7: The structure to be initialized
*
* This function will initialize a PKCS7 structure. PKCS7 structures
}
/**
- * gnutls_pkcs7_deinit - deinitializes a #gnutls_pkcs7_t structure
+ * gnutls_pkcs7_deinit:
* @pkcs7: The structure to be initialized
*
* This function will deinitialize a PKCS7 structure.
}
/**
- * gnutls_pkcs7_import - import a DER or PEM encoded PKCS7
+ * gnutls_pkcs7_import:
* @pkcs7: The structure to store the parsed PKCS7.
* @data: The DER or PEM encoded PKCS7.
* @format: One of DER or PEM
}
/**
- * gnutls_pkcs7_get_crt_raw - get a certificate from a PKCS7 certificate set
+ * gnutls_pkcs7_get_crt_raw:
* @pkcs7: should contain a gnutls_pkcs7_t structure
* @indx: contains the index of the certificate to extract
* @certificate: the contents of the certificate will be copied
}
/**
- * gnutls_pkcs7_get_crt_count - return the number of certificates in a PKCS7 certificate set
+ * gnutls_pkcs7_get_crt_count:
* @pkcs7: should contain a #gnutls_pkcs7_t structure
*
* This function will return the number of certifcates in the PKCS7
}
/**
- * gnutls_pkcs7_export - export the pkcs7 structure
+ * gnutls_pkcs7_export:
* @pkcs7: Holds the pkcs7 structure
* @format: the format of output params. One of PEM or DER.
* @output_data: will contain a structure PEM or DER encoded
}
/**
- * gnutls_pkcs7_set_crt_raw - add a certificate in a PKCS7 certificate set
+ * gnutls_pkcs7_set_crt_raw:
* @pkcs7: should contain a #gnutls_pkcs7_t structure
* @crt: the DER encoded certificate to be added
*
}
/**
- * gnutls_pkcs7_set_crt - add a parsed certificate in a PKCS7 certificate set
+ * gnutls_pkcs7_set_crt:
* @pkcs7: should contain a #gnutls_pkcs7_t structure
* @crt: the certificate to be copied.
*
/**
- * gnutls_pkcs7_delete_crt - deletes a certificate from a PKCS7 certificate set
+ * gnutls_pkcs7_delete_crt:
* @pkcs7: should contain a gnutls_pkcs7_t structure
* @indx: the index of the certificate to delete
*
*/
/**
- * gnutls_pkcs7_get_crl_raw - returns a crl in a PKCS7 crl set
+ * gnutls_pkcs7_get_crl_raw:
* @pkcs7: should contain a #gnutls_pkcs7_t structure
* @indx: contains the index of the crl to extract
* @crl: the contents of the crl will be copied there (may be null)
}
/**
- * gnutls_pkcs7_get_crl_count - returns the number of CRLs in a PKCS7 crl set
+ * gnutls_pkcs7_get_crl_count:
* @pkcs7: should contain a gnutls_pkcs7_t structure
*
* This function will return the number of certifcates in the PKCS7
}
/**
- * gnutls_pkcs7_set_crl_raw - add a crl in a PKCS7 crl set
+ * gnutls_pkcs7_set_crl_raw:
* @pkcs7: should contain a #gnutls_pkcs7_t structure
* @crl: the DER encoded crl to be added
*
}
/**
- * gnutls_pkcs7_set_crl - add a parsed crl in a PKCS7 crl set
+ * gnutls_pkcs7_set_crl:
* @pkcs7: should contain a #gnutls_pkcs7_t structure
* @crl: the DER encoded crl to be added
*
}
/**
- * gnutls_pkcs7_delete_crl - deletes a CRL from a PKCS7 crl set
+ * gnutls_pkcs7_delete_crl:
* @pkcs7: should contain a #gnutls_pkcs7_t structure
* @indx: the index of the crl to delete
*
static int _gnutls_asn1_encode_rsa (ASN1_TYPE * c2, bigint_t * params);
/**
- * gnutls_x509_privkey_init - initialize a #gnutls_privkey_t structure
+ * gnutls_x509_privkey_init:
* @key: The structure to be initialized
*
* This function will initialize an private key structure.
}
/**
- * gnutls_x509_privkey_deinit - deinitializes a #gnutls_x509_privkey_t structure
+ * gnutls_x509_privkey_deinit:
* @key: The structure to be initialized
*
* This function will deinitialize a private key structure.
}
/**
- * gnutls_x509_privkey_cpy - copy a private key
+ * gnutls_x509_privkey_cpy:
* @dst: The destination key, which should be initialized.
* @src: The source key
*
#define PEM_KEY_RSA "RSA PRIVATE KEY"
/**
- * gnutls_x509_privkey_import - import a DER or PEM encoded key
+ * gnutls_x509_privkey_import:
* @key: The structure to store the parsed key
* @data: The DER or PEM encoded certificate.
* @format: One of DER or PEM
_gnutls_mpi_release(&key->params[i])
/**
- * gnutls_x509_privkey_import_rsa_raw - import a raw RSA key
+ * gnutls_x509_privkey_import_rsa_raw:
* @key: The structure to store the parsed key
* @m: holds the modulus
* @e: holds the public exponent
}
/**
- * gnutls_x509_privkey_import_dsa_raw - import a raw DSA key
+ * gnutls_x509_privkey_import_dsa_raw:
* @key: The structure to store the parsed key
* @p: holds the p
* @q: holds the q
/**
- * gnutls_x509_privkey_get_pk_algorithm - returns the key's PublicKey algorithm
+ * gnutls_x509_privkey_get_pk_algorithm:
* @key: should contain a #gnutls_x509_privkey_t structure
*
* This function will return the public key algorithm of a private
}
/**
- * gnutls_x509_privkey_export - export the private key
+ * gnutls_x509_privkey_export:
* @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
}
/**
- * gnutls_x509_privkey_export_rsa_raw - export the RSA private key
+ * gnutls_x509_privkey_export_rsa_raw:
* @key: a structure that holds the rsa parameters
* @m: will hold the modulus
* @e: will hold the public exponent
}
/**
- * gnutls_x509_privkey_export_dsa_raw - export the DSA private key
+ * gnutls_x509_privkey_export_dsa_raw:
* @key: a structure that holds the DSA parameters
* @p: will hold the p
* @q: will hold the q
/**
- * gnutls_x509_privkey_generate - generate a private key
+ * gnutls_x509_privkey_generate:
* @key: should contain a #gnutls_x509_privkey_t structure
* @algo: is one of RSA or DSA.
* @bits: the size of the modulus
}
/**
- * gnutls_x509_privkey_get_key_id - Return unique ID of the key's parameters
+ * gnutls_x509_privkey_get_key_id:
* @key: Holds the key
* @flags: should be 0 for now
* @output_data: will contain the key ID
#ifdef ENABLE_PKI
/**
- * gnutls_x509_privkey_sign_data - sign data using the private key
+ * gnutls_x509_privkey_sign_data:
* @key: Holds the key
* @digest: should be MD5 or SHA1
* @flags: should be 0 for now
}
/**
- * gnutls_x509_privkey_sign_hash - sign hash using the private key
+ * gnutls_x509_privkey_sign_hash:
* @key: Holds the key
* @hash: holds the data to be signed
* @signature: will contain newly allocated signature
}
/**
- * gnutls_x509_privkey_verify_data - Verify the signed data using private key
+ * gnutls_x509_privkey_verify_data:
* @key: Holds the key
* @flags: should be 0 for now
* @data: holds the data to be signed
}
/**
- * gnutls_x509_privkey_fix - recalculate some parameters of the key.
+ * gnutls_x509_privkey_fix:
* @key: Holds the key
*
* This function will recalculate the secondary parameters in a key.
/**
- * gnutls_x509_privkey_export_pkcs8 - This function will export the private key to PKCS8 format
+ * gnutls_x509_privkey_export_pkcs8:
* @key: Holds the key
* @format: the format of output params. One of PEM or DER.
* @password: the password that will be used to encrypt the key.
}
/**
- * gnutls_x509_privkey_import_pkcs8 - This function will import a DER or PEM PKCS8 encoded key
+ * gnutls_x509_privkey_import_pkcs8:
* @key: The structure to store the parsed key
* @data: The DER or PEM encoded key.
* @format: One of DER or PEM
#include <gnutls_errors.h>
/**
- * gnutls_x509_crt_check_hostname - compares the hostname with certificate's hostname
+ * gnutls_x509_crt_check_hostname:
* @cert: should contain an gnutls_x509_crt_t structure
* @hostname: A null terminated string that contains a DNS name
*
}
/**
- * gnutls_x509_crt_check_issuer - check if certificate has given issuer
+ * gnutls_x509_crt_check_issuer:
* @cert: is the certificate to be checked
* @issuer: is the certificate of a possible issuer
*
}
/**
- * gnutls_x509_crt_list_verify - This function verifies the given certificate list
+ * gnutls_x509_crt_list_verify:
* @cert_list: is the certificate list to be verified
* @cert_list_length: holds the number of certificate in cert_list
* @CA_list: is the CA list which will be used in verification
}
/**
- * gnutls_x509_crt_verify - This function verifies the given certificate against a given trusted one
+ * gnutls_x509_crt_verify:
* @cert: is the certificate to be verified
* @CA_list: is one certificate that is considered to be trusted one
* @CA_list_length: holds the number of CA certificate in CA_list
#ifdef ENABLE_PKI
/**
- * gnutls_x509_crl_check_issuer - checks if CRL has given issuer
+ * gnutls_x509_crl_check_issuer:
* @crl: is the CRL to be checked
* @issuer: is the certificate of a possible issuer
*
}
/**
- * gnutls_x509_crl_verify - This function verifies the given crl against a given trusted one
+ * gnutls_x509_crl_verify:
* @crl: is the crl to be verified
* @CA_list: is a certificate list that is considered to be trusted one
* @CA_list_length: holds the number of CA certificates in CA_list
#include <libtasn1.h>
/**
- * gnutls_x509_crt_init - This function initializes a gnutls_x509_crt_t structure
+ * gnutls_x509_crt_init:
* @cert: The structure to be initialized
*
* This function will initialize an X.509 certificate structure.
}
/**
- * gnutls_x509_crt_deinit - This function deinitializes memory used by a gnutls_x509_crt_t structure
+ * gnutls_x509_crt_deinit:
* @cert: The structure to be initialized
*
* This function will deinitialize a CRL structure.
}
/**
- * gnutls_x509_crt_import - This function will import a DER or PEM encoded Certificate
+ * gnutls_x509_crt_import:
* @cert: The structure to store the parsed certificate.
* @data: The DER or PEM encoded certificate.
* @format: One of DER or PEM
/**
- * gnutls_x509_crt_get_issuer_dn - This function returns the Certificate's issuer distinguished name
+ * gnutls_x509_crt_get_issuer_dn:
* @cert: should contain a #gnutls_x509_crt_t structure
* @buf: a pointer to a structure to hold the name (may be null)
* @sizeof_buf: initially holds the size of @buf
}
/**
- * gnutls_x509_crt_get_issuer_dn_by_oid - This function returns the Certificate's issuer distinguished name
+ * gnutls_x509_crt_get_issuer_dn_by_oid:
* @cert: should contain a #gnutls_x509_crt_t structure
* @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 zero to get the first one.
}
/**
- * gnutls_x509_crt_get_issuer_dn_oid - This function returns the Certificate's issuer distinguished name OIDs
+ * gnutls_x509_crt_get_issuer_dn_oid:
* @cert: should contain a #gnutls_x509_crt_t structure
* @indx: This specifies which OID to return. Use zero to get the first one.
* @oid: a pointer to a buffer to hold the OID (may be null)
}
/**
- * gnutls_x509_crt_get_dn - This function returns the Certificate's distinguished name
+ * gnutls_x509_crt_get_dn:
* @cert: should contain a #gnutls_x509_crt_t structure
* @buf: a pointer to a structure to hold the name (may be null)
* @sizeof_buf: initially holds the size of @buf
}
/**
- * gnutls_x509_crt_get_dn_by_oid - This function returns the Certificate's distinguished name
+ * gnutls_x509_crt_get_dn_by_oid:
* @cert: should contain a #gnutls_x509_crt_t structure
* @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 zero to get the first one.
}
/**
- * gnutls_x509_crt_get_dn_oid - This function returns the Certificate's subject distinguished name OIDs
+ * gnutls_x509_crt_get_dn_oid:
* @cert: should contain a #gnutls_x509_crt_t structure
* @indx: This specifies which OID to return. Use zero to get the first one.
* @oid: a pointer to a buffer to hold the OID (may be null)
}
/**
- * gnutls_x509_crt_get_signature_algorithm - This function returns the Certificate's signature algorithm
+ * gnutls_x509_crt_get_signature_algorithm:
* @cert: should contain a #gnutls_x509_crt_t structure
*
* This function will return a value of the #gnutls_sign_algorithm_t
}
/**
- * gnutls_x509_crt_get_signature - Returns the Certificate's signature
+ * gnutls_x509_crt_get_signature:
* @cert: should contain a #gnutls_x509_crt_t structure
* @sig: a pointer where the signature part will be copied (may be null).
* @sizeof_sig: initially holds the size of @sig
}
/**
- * gnutls_x509_crt_get_version - return the Certificate's version number
+ * gnutls_x509_crt_get_version:
* @cert: should contain a #gnutls_x509_crt_t structure
*
* This function will return the version of the specified Certificate.
}
/**
- * gnutls_x509_crt_get_activation_time - returns the Certificate's activation time
+ * gnutls_x509_crt_get_activation_time:
* @cert: should contain a #gnutls_x509_crt_t structure
*
* This function will return the time this Certificate was or will be
}
/**
- * gnutls_x509_crt_get_expiration_time - returns the Certificate's expiration time
+ * gnutls_x509_crt_get_expiration_time:
* @cert: should contain a #gnutls_x509_crt_t structure
*
* This function will return the time this Certificate was or will be
}
/**
- * gnutls_x509_crt_get_serial - This function returns the certificate's serial number
+ * gnutls_x509_crt_get_serial:
* @cert: should contain a #gnutls_x509_crt_t structure
* @result: The place where the serial number will be copied
* @result_size: Holds the size of the result field.
}
/**
- * gnutls_x509_crt_get_subject_key_id - This function returns the certificate's key identifier
+ * gnutls_x509_crt_get_subject_key_id:
* @cert: should contain a #gnutls_x509_crt_t structure
* @ret: The place where the identifier will be copied
* @ret_size: Holds the size of the result field.
}
/**
- * gnutls_x509_crt_get_authority_key_id - This function returns the certificate authority's identifier
+ * gnutls_x509_crt_get_authority_key_id:
* @cert: should contain a #gnutls_x509_crt_t structure
* @ret: The place where the identifier will be copied
* @ret_size: Holds the size of the result field.
}
/**
- * gnutls_x509_crt_get_pk_algorithm - return the certificate's PublicKey algorithm
+ * gnutls_x509_crt_get_pk_algorithm:
* @cert: should contain a #gnutls_x509_crt_t structure
* @bits: if bits is non null it will hold the size of the parameters' in bits
*
}
/**
- * gnutls_x509_crt_get_subject_alt_name - Get certificate's alternative name, if any
+ * gnutls_x509_crt_get_subject_alt_name:
* @cert: should contain a #gnutls_x509_crt_t structure
* @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
}
/**
- * gnutls_x509_crt_get_issuer_alt_name - Get certificate's issuer alternative name, if any
+ * gnutls_x509_crt_get_issuer_alt_name:
* @cert: should contain a #gnutls_x509_crt_t structure
* @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
}
/**
- * gnutls_x509_crt_get_subject_alt_name2 - Get certificate's alternative name, if any
+ * gnutls_x509_crt_get_subject_alt_name2:
* @cert: should contain a #gnutls_x509_crt_t structure
* @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
}
/**
- * gnutls_x509_crt_get_issuer_alt_name2 - Get certificate issuer's alternative name, if any
+ * gnutls_x509_crt_get_issuer_alt_name2:
* @cert: should contain a #gnutls_x509_crt_t structure
* @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
}
/**
- * gnutls_x509_crt_get_subject_alt_othername_oid - Get SAN otherName OID
+ * gnutls_x509_crt_get_subject_alt_othername_oid:
* @cert: should contain a #gnutls_x509_crt_t structure
* @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
}
/**
- * gnutls_x509_crt_get_issuer_alt_othername_oid - Get Issuer AltName otherName OID
+ * gnutls_x509_crt_get_issuer_alt_othername_oid:
* @cert: should contain a #gnutls_x509_crt_t structure
* @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
}
/**
- * gnutls_x509_crt_get_basic_constraints - This function returns the certificate basic constraints
+ * gnutls_x509_crt_get_basic_constraints:
* @cert: should contain a #gnutls_x509_crt_t structure
* @critical: will be non zero if the extension is marked as critical
* @ca: pointer to output integer indicating CA status, may be NULL,
}
/**
- * gnutls_x509_crt_get_ca_status - This function returns the certificate CA status
+ * gnutls_x509_crt_get_ca_status:
* @cert: should contain a #gnutls_x509_crt_t structure
* @critical: will be non zero if the extension is marked as critical
*
}
/**
- * gnutls_x509_crt_get_key_usage - return the certificate's key usage
+ * gnutls_x509_crt_get_key_usage:
* @cert: should contain a #gnutls_x509_crt_t structure
* @key_usage: where the key usage bits will be stored
* @critical: will be non zero if the extension is marked as critical
}
/**
- * gnutls_x509_crt_get_proxy - This function returns the proxy certificate info
+ * gnutls_x509_crt_get_proxy:
* @cert: should contain a #gnutls_x509_crt_t structure
* @critical: will be non zero if the extension is marked as critical
* @pathlen: pointer to output integer indicating path length (may be
}
/**
- * gnutls_x509_crt_get_extension_by_oid - This function returns the specified extension
+ * gnutls_x509_crt_get_extension_by_oid:
* @cert: should contain a #gnutls_x509_crt_t structure
* @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 zero to get the first one.
}
/**
- * gnutls_x509_crt_get_extension_oid - get the specified extension OID
+ * gnutls_x509_crt_get_extension_oid:
* @cert: should contain a #gnutls_x509_crt_t structure
* @indx: Specifies which extension OID to send. Use zero to get the first one.
* @oid: a pointer to a structure to hold the OID (may be null)
}
/**
- * gnutls_x509_crt_get_extension_info - Get extension id and criticality
+ * gnutls_x509_crt_get_extension_info:
* @cert: should contain a #gnutls_x509_crt_t structure
* @indx: Specifies which extension OID to send. Use zero to get the first one.
* @oid: a pointer to a structure to hold the OID
}
/**
- * gnutls_x509_crt_get_extension_data - Get the specified extension data
+ * gnutls_x509_crt_get_extension_data:
* @cert: should contain a #gnutls_x509_crt_t structure
* @indx: Specifies which extension OID to send. Use zero to get the first one.
* @data: a pointer to a structure to hold the data (may be null)
}
/**
- * gnutls_x509_crt_get_raw_issuer_dn - This function returns the issuer's DN DER encoded
+ * gnutls_x509_crt_get_raw_issuer_dn:
* @cert: should contain a #gnutls_x509_crt_t structure
* @start: will hold the starting point of the DN
*
}
/**
- * gnutls_x509_crt_get_raw_dn - This function returns the subject's DN DER encoded
+ * gnutls_x509_crt_get_raw_dn:
* @cert: should contain a #gnutls_x509_crt_t structure
* @start: will hold the starting point of the DN
*
}
/**
- * gnutls_x509_crt_get_subject: get opaque subject DN pointer
+ * gnutls_x509_crt_get_subject:
* @cert: should contain a #gnutls_x509_crt_t structure
* @dn: output variable with pointer to opaque DN.
*
}
/**
- * gnutls_x509_crt_get_issuer: get opaque issuer DN pointer
+ * gnutls_x509_crt_get_issuer:
* @cert: should contain a #gnutls_x509_crt_t structure
* @dn: output variable with pointer to opaque DN
*
}
/**
- * gnutls_x509_crt_get_fingerprint - This function returns the Certificate's fingerprint
+ * gnutls_x509_crt_get_fingerprint:
* @cert: should contain a #gnutls_x509_crt_t structure
* @algo: is a digest algorithm
* @buf: a pointer to a structure to hold the fingerprint (may be null)
}
/**
- * gnutls_x509_crt_export - This function will export the certificate
+ * gnutls_x509_crt_export:
* @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
}
/**
- * gnutls_x509_crt_get_key_id - Return unique ID of public key's parameters
+ * gnutls_x509_crt_get_key_id:
* @crt: Holds the certificate
* @flags: should be 0 for now
* @output_data: will contain the key ID
#ifdef ENABLE_PKI
/**
- * gnutls_x509_crt_check_revocation - This function checks if the given certificate is revoked
+ * 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
* @crl_list_length: the length of the crl_list
}
/**
- * gnutls_x509_crt_get_verify_algorithm - get hash algorithm used to verify signature.
+ * gnutls_x509_crt_get_verify_algorithm:
* @crt: Holds the certificate
* @signature: contains the signature
* @hash: The result of the call with the hash algorithm used for signature
}
/**
- * gnutls_x509_crt_verify_data - verify the given signed data.
+ * gnutls_x509_crt_verify_data:
* @crt: Holds the certificate
* @flags: should be 0 for now
* @data: holds the data to be signed
}
/**
- * gnutls_x509_crt_verify_hash - verify the given signed digest
+ * gnutls_x509_crt_verify_hash:
* @crt: Holds the certificate
* @flags: should be 0 for now
* @hash: holds the hash digest to be verified
}
/**
- * gnutls_x509_crt_get_crl_dist_points - This function returns the CRL distribution points
+ * gnutls_x509_crt_get_crl_dist_points:
* @cert: should contain a #gnutls_x509_crt_t structure
* @seq: specifies the sequence number of the distribution point (0 for the first one, 1 for the second etc.)
* @ret: is the place where the distribution point will be copied to
}
/**
- * gnutls_x509_crt_get_key_purpose_oid - This function returns the Certificate's key purpose OIDs
+ * gnutls_x509_crt_get_key_purpose_oid:
* @cert: should contain a #gnutls_x509_crt_t structure
* @indx: This specifies which OID to return. Use zero to get the first one.
* @oid: a pointer to a buffer to hold the OID (may be null)
}
/**
- * gnutls_x509_crt_get_pk_rsa_raw - This function will export the RSA public key
+ * gnutls_x509_crt_get_pk_rsa_raw:
* @crt: Holds the certificate
* @m: will hold the modulus
* @e: will hold the public exponent
}
/**
- * gnutls_x509_crt_get_pk_dsa_raw - This function will export the DSA public key
+ * gnutls_x509_crt_get_pk_dsa_raw:
* @crt: Holds the certificate
* @p: will hold the p
* @q: will hold the q
#endif
/**
- * gnutls_x509_crt_list_import - This function will import a PEM encoded certificate list
+ * gnutls_x509_crt_list_import:
* @certs: The structures to store the parsed certificate. 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.
static void disable_optional_stuff (gnutls_x509_crt_t cert);
/**
- * gnutls_x509_crt_set_dn_by_oid - Set the Certificate request subject's distinguished name
+ * gnutls_x509_crt_set_dn_by_oid:
* @crt: a certificate of type #gnutls_x509_crt_t
* @oid: holds an Object Identifier in a null terminated string
* @raw_flag: must be 0, or 1 if the data are DER encoded
}
/**
- * gnutls_x509_crt_set_issuer_dn_by_oid - Set the Certificate request issuer's distinguished name
+ * gnutls_x509_crt_set_issuer_dn_by_oid:
* @crt: a certificate of type #gnutls_x509_crt_t
* @oid: holds an Object Identifier in a null terminated string
* @raw_flag: must be 0, or 1 if the data are DER encoded
}
/**
- * gnutls_x509_crt_set_proxy_dn - Set Proxy Certificate subject's distinguished name
+ * gnutls_x509_crt_set_proxy_dn:
* @crt: a gnutls_x509_crt_t structure 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
}
/**
- * gnutls_x509_crt_set_version - Set the Certificate request version
+ * gnutls_x509_crt_set_version:
* @crt: a certificate of type #gnutls_x509_crt_t
* @version: holds the version number. For X.509v1 certificates must be 1.
*
}
/**
- * gnutls_x509_crt_set_key - This function will associate the Certificate with a key
+ * gnutls_x509_crt_set_key:
* @crt: a certificate of type #gnutls_x509_crt_t
* @key: holds a private key
*
}
/**
- * gnutls_x509_crt_set_crq - Associate the Certificate with a request
+ * gnutls_x509_crt_set_crq:
* @crt: a certificate of type #gnutls_x509_crt_t
* @crq: holds a certificate request
*
}
/**
- * gnutls_x509_crt_set_crq_extensions - Associate the Certificate with a request
+ * gnutls_x509_crt_set_crq_extensions:
* @crt: a certificate of type #gnutls_x509_crt_t
* @crq: holds a certificate request
*
}
/**
- * gnutls_x509_crt_set_extension_by_oid - Set an arbitrary extension
+ * gnutls_x509_crt_set_extension_by_oid:
* @crt: a certificate of type #gnutls_x509_crt_t
* @oid: holds an Object Identified in null terminated string
* @buf: a pointer to a DER encoded data
}
/**
- * gnutls_x509_crt_set_basic_constraints - Set the basicConstraints extension
+ * gnutls_x509_crt_set_basic_constraints:
* @crt: a certificate of type #gnutls_x509_crt_t
* @ca: true(1) or false(0). Depending on the Certificate authority status.
* @pathLenConstraint: non-negative values indicate maximum length of path,
}
/**
- * gnutls_x509_crt_set_ca_status - Set the basicConstraints extension
+ * gnutls_x509_crt_set_ca_status:
* @crt: a certificate of type #gnutls_x509_crt_t
* @ca: true(1) or false(0). Depending on the Certificate authority status.
*
}
/**
- * gnutls_x509_crt_set_key_usage - Set the keyUsage extension
+ * gnutls_x509_crt_set_key_usage:
* @crt: a certificate of type #gnutls_x509_crt_t
* @usage: an ORed sequence of the GNUTLS_KEY_* elements.
*
}
/**
- * gnutls_x509_crt_set_subject_alternative_name - Set the subject Alternative Name
+ * gnutls_x509_crt_set_subject_alternative_name:
* @crt: a certificate of type #gnutls_x509_crt_t
* @type: is one of the gnutls_x509_subject_alt_name_t enumerations
* @data_string: The data to be set, a zero terminated string
}
/**
- * gnutls_x509_crt_set_subject_alt_name - Set the subject Alternative Name
+ * gnutls_x509_crt_set_subject_alt_name:
* @crt: a certificate of type #gnutls_x509_crt_t
* @type: is one of the gnutls_x509_subject_alt_name_t enumerations
* @data: The data to be set
}
/**
- * gnutls_x509_crt_set_proxy - Set the proxyCertInfo extension
+ * gnutls_x509_crt_set_proxy:
* @crt: a certificate of type #gnutls_x509_crt_t
* @pathLenConstraint: non-negative values indicate maximum length of path,
* and negative values indicate that the pathLenConstraints field should
}
/**
- * gnutls_x509_crt_sign2 - Sign a certificate with a key
+ * gnutls_x509_crt_sign2:
* @crt: a certificate of type #gnutls_x509_crt_t
* @issuer: is the certificate of the certificate issuer
* @issuer_key: holds the issuer's private key
}
/**
- * gnutls_x509_crt_sign - Sign a certificate with a key
+ * gnutls_x509_crt_sign:
* @crt: a certificate of type #gnutls_x509_crt_t
* @issuer: is the certificate of the certificate issuer
* @issuer_key: holds the issuer's private key
}
/**
- * gnutls_x509_crt_set_activation_time - Set the Certificate's activation time
+ * gnutls_x509_crt_set_activation_time:
* @cert: a certificate of type #gnutls_x509_crt_t
* @act_time: The actual time
*
}
/**
- * gnutls_x509_crt_set_expiration_time - Set the Certificate's expiration time
+ * gnutls_x509_crt_set_expiration_time:
* @cert: a certificate of type #gnutls_x509_crt_t
* @exp_time: The actual time
*
}
/**
- * gnutls_x509_crt_set_serial - Set the certificate's serial number
+ * gnutls_x509_crt_set_serial:
* @cert: a certificate of type #gnutls_x509_crt_t
* @serial: The serial number
* @serial_size: Holds the size of the serial field.
}
/**
- * gnutls_x509_crt_set_crl_dist_points - Set the CRL dist points
+ * gnutls_x509_crt_set_crl_dist_points:
* @crt: a certificate of type #gnutls_x509_crt_t
* @type: is one of the gnutls_x509_subject_alt_name_t enumerations
* @data_string: The data to be set
}
/**
- * gnutls_x509_crt_set_crl_dist_points2 - Set the CRL dist points
+ * gnutls_x509_crt_set_crl_dist_points2:
* @crt: a certificate of type #gnutls_x509_crt_t
* @type: is one of the gnutls_x509_subject_alt_name_t enumerations
* @data: The data to be set
}
/**
- * gnutls_x509_crt_cpy_crl_dist_points - Copy the CRL dist points
+ * gnutls_x509_crt_cpy_crl_dist_points:
* @dst: a certificate of type #gnutls_x509_crt_t
* @src: the certificate where the dist points will be copied from
*
}
/**
- * gnutls_x509_crt_set_subject_key_id - Set the certificate's subject key id
+ * gnutls_x509_crt_set_subject_key_id:
* @cert: a certificate of type #gnutls_x509_crt_t
* @id: The key ID
* @id_size: Holds the size of the serial field.
}
/**
- * gnutls_x509_crt_set_authority_key_id - Set the certificate authority's key id
+ * gnutls_x509_crt_set_authority_key_id:
* @cert: a certificate of type #gnutls_x509_crt_t
* @id: The key ID
* @id_size: Holds the size of the serial field.
}
/**
- * gnutls_x509_crt_set_key_purpose_oid - Sets the Certificate's key purpose OIDs
+ * gnutls_x509_crt_set_key_purpose_oid:
* @cert: a certificate of type #gnutls_x509_crt_t
* @oid: a pointer to a null terminated string that holds the OID
* @critical: Whether this extension will be critical or not
}
/**
- * gnutls_pem_base64_encode - convert raw data to Base64 encoded
+ * gnutls_pem_base64_encode:
* @msg: is a message to be put in the header
* @data: contain the raw data
* @result: the place where base64 data will be copied
}
/**
- * gnutls_pem_base64_encode_alloc - convert raw data to Base64 encoded
+ * gnutls_pem_base64_encode_alloc:
* @msg: is a message to be put in the encoded header
* @data: contains the raw data
* @result: will hold the newly allocated encoded data
}
/**
- * gnutls_pem_base64_decode - decode base64 encoded data
+ * gnutls_pem_base64_decode:
* @header: A null terminated string with the PEM header (eg. CERTIFICATE)
* @b64_data: contain the encoded data
* @result: the place where decoded data will be copied
}
/**
- * gnutls_pem_base64_decode_alloc - decode base64 encoded data
+ * gnutls_pem_base64_decode_alloc:
* @header: The PEM header (eg. CERTIFICATE)
* @b64_data: contains the encoded data
* @result: the place where decoded data lie
static int _gnutls_init_extra = 0;
/**
- * gnutls_global_init_extra - initializes the global state of gnutls-extra
+ * gnutls_global_init_extra:
*
* This function initializes the global state of gnutls-extra library
* to defaults.
}
/**
- * gnutls_extra_check_version - checks the libgnutls-extra version
+ * gnutls_extra_check_version:
* @req_version: version string to compare with, or %NULL.
*
* Check GnuTLS Extra Library version.
}
/**
- * gnutls_ia_send: Send peer the specified TLS/IA data.
+ * gnutls_ia_send:
* @session: is a #gnutls_session_t structure.
* @data: contains the data to send
* @sizeofdata: is the length of the data
}
/**
- * gnutls_ia_recv - read data from the TLS/IA protocol
+ * gnutls_ia_recv:
* @session: is a #gnutls_session_t structure.
* @data: the buffer that the data will be read into, must hold >= 12 bytes.
* @sizeofdata: the number of requested bytes, must be >= 12.
}
/**
- * gnutls_ia_allocate_client_credentials - Used to allocate an gnutls_ia_server_credentials_t structure
+ * gnutls_ia_allocate_client_credentials:
* @sc: is a pointer to a #gnutls_ia_server_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
}
/**
- * gnutls_ia_free_client_credentials - Used to free an allocated #gnutls_ia_client_credentials_t structure
+ * gnutls_ia_free_client_credentials:
* @sc: is a #gnutls_ia_client_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
}
/**
- * gnutls_ia_set_client_avp_function - Used to set a AVP callback
+ * gnutls_ia_set_client_avp_function:
* @cred: is a #gnutls_ia_client_credentials_t structure.
* @avp_func: is the callback function
*
}
/**
- * gnutls_ia_set_client_avp_ptr - Sets a pointer to be sent to TLS/IA callback
+ * gnutls_ia_set_client_avp_ptr:
* @cred: is a #gnutls_ia_client_credentials_t structure.
* @ptr: is the pointer
*
}
/**
- * gnutls_ia_get_client_avp_ptr - Returns the pointer which is sent to TLS/IA callback
+ * gnutls_ia_get_client_avp_ptr:
* @cred: is a #gnutls_ia_client_credentials_t structure.
*
* Returns the pointer that will be provided to the TLS/IA callback
}
/**
- * gnutls_ia_allocate_server_credentials - Used to allocate an gnutls_ia_server_credentials_t structure
+ * gnutls_ia_allocate_server_credentials:
* @sc: is a pointer to a #gnutls_ia_server_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
}
/**
- * gnutls_ia_free_server_credentials - Used to free an allocated #gnutls_ia_server_credentials_t structure
+ * gnutls_ia_free_server_credentials:
* @sc: is a #gnutls_ia_server_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
}
/**
- * gnutls_ia_set_server_credentials_function - Used to set a AVP callback
+ * gnutls_ia_set_server_credentials_function:
* @cred: is a #gnutls_ia_server_credentials_t structure.
* @func: is the callback function
*
}
/**
- * gnutls_ia_set_server_avp_ptr - Sets a pointer to be sent to TLS/IA callback
+ * gnutls_ia_set_server_avp_ptr:
* @cred: is a #gnutls_ia_client_credentials_t structure.
* @ptr: is the pointer
*
}
/**
- * gnutls_ia_get_server_avp_ptr - Returns the pointer which is sent to TLS/IA callback
+ * gnutls_ia_get_server_avp_ptr:
* @cred: is a #gnutls_ia_client_credentials_t structure.
*
* Returns the pointer that will be provided to the TLS/IA callback
}
/**
- * gnutls_ia_enable - Indicate willingness for TLS/IA application phases
+ * gnutls_ia_enable:
* @session: is a #gnutls_session_t structure.
* @allow_skip_on_resume: non-zero if local party allows to skip the
* TLS/IA application phases for a resumed session.
#include <openssl_compat.h>
/*-
- * gnutls_x509_extract_dn - This function parses an RDN sequence
+ * gnutls_x509_extract_dn:
* @idn: should contain a DER encoded RDN sequence
* @rdn: a pointer to a structure to hold the name
*
}
/*-
- * gnutls_x509_extract_certificate_dn - This function returns the certificate's distinguished name
+ * gnutls_x509_extract_certificate_dn:
* @cert: should contain an X.509 DER encoded certificate
* @ret: a pointer to a structure to hold the peer's name
*
}
/*-
- * gnutls_x509_extract_certificate_issuer_dn - This function returns the certificate's issuer distinguished name
+ * gnutls_x509_extract_certificate_issuer_dn:
* @cert: should contain an X.509 DER encoded certificate
* @ret: a pointer to a structure to hold the issuer's name
*
/*-
- * gnutls_x509_extract_certificate_subject_alt_name - This function returns the certificate's alternative name, if any
+ * gnutls_x509_extract_certificate_subject_alt_name:
* @cert: should contain an X.509 DER encoded certificate
* @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
}
/*-
- * gnutls_x509_extract_certificate_ca_status - This function returns the certificate CA status
+ * gnutls_x509_extract_certificate_ca_status:
* @cert: should contain an X.509 DER encoded certificate
*
* This function will return certificates CA status, by reading the
}
/*-
- * gnutls_x509_extract_certificate_activation_time - This function returns the peer's certificate activation time
+ * gnutls_x509_extract_certificate_activation_time:
* @cert: should contain an X.509 DER encoded certificate
*
* This function will return the certificate's activation time in UNIX time
}
/*-
- * gnutls_x509_extract_certificate_expiration_time - This function returns the certificate's expiration time
+ * gnutls_x509_extract_certificate_expiration_time:
* @cert: should contain an X.509 DER encoded certificate
*
* This function will return the certificate's expiration time in UNIX time
}
/*-
- * gnutls_x509_extract_certificate_version - This function returns the certificate's version
+ * gnutls_x509_extract_certificate_version:
* @cert: is an X.509 DER encoded certificate
*
* This function will return the X.509 certificate's version (1, 2, 3). This is obtained by the X509 Certificate
}
/*-
- * gnutls_x509_extract_certificate_serial - This function returns the certificate's serial number
+ * gnutls_x509_extract_certificate_serial:
* @cert: is an X.509 DER encoded certificate
* @result: The place where the serial number will be copied
* @result_size: Holds the size of the result field.
/*-
- * gnutls_x509_extract_certificate_pk_algorithm - This function returns the certificate's PublicKey algorithm
+ * gnutls_x509_extract_certificate_pk_algorithm:
* @cert: is a DER encoded X.509 certificate
* @bits: if bits is non null it will hold the size of the parameters' in bits
*
/*-
- * gnutls_x509_extract_certificate_dn_string - This function returns the certificate's distinguished name
+ * gnutls_x509_extract_certificate_dn_string:
* @cert: should contain an X.509 DER encoded certificate
* @buf: a pointer to a structure to hold the peer's name
* @sizeof_buf: holds the size of 'buf'
}
/*-
- * gnutls_x509_verify_certificate - This function verifies given certificate list
+ * gnutls_x509_verify_certificate:
* @cert_list: is the certificate list to be verified
* @cert_list_length: holds the number of certificate in cert_list
* @CA_list: is the CA list which will be used in verification
}
/*-
- * gnutls_x509_extract_key_pk_algorithm - This function returns the keys's PublicKey algorithm
+ * gnutls_x509_extract_key_pk_algorithm:
* @cert: is a DER encoded private key
*
* This function will return the public key algorithm of a DER encoded private
#ifdef ENABLE_PKI
/*-
- * gnutls_x509_pkcs7_extract_certificate - This function returns a certificate in a PKCS7 certificate set
+ * gnutls_x509_pkcs7_extract_certificate:
* @pkcs7_struct: should contain a PKCS7 DER formatted structure
* @indx: contains the index of the certificate to extract
* @certificate: the contents of the certificate will be copied there
projects / thirdparty / gnutls.git / commitdiff
