From 141f1a04454ab7cbb31c62070e3b4d0e946d231c Mon Sep 17 00:00:00 2001 From: Simon Josefsson Date: Wed, 25 Aug 2004 13:35:43 +0000 Subject: Doc fix. --- lib/gnutls_anon_cred.c | 15 +++++++-------- lib/gnutls_dh_primes.c | 20 ++++++++++---------- lib/gnutls_srp.c | 4 ++-- lib/gnutls_ui.c | 7 ++++--- lib/gnutls_ui.h | 10 ---------- 5 files changed, 23 insertions(+), 33 deletions(-) (limited to 'lib') diff --git a/lib/gnutls_anon_cred.c b/lib/gnutls_anon_cred.c index c2ac568ed4..dde79de41a 100644 --- a/lib/gnutls_anon_cred.c +++ b/lib/gnutls_anon_cred.c @@ -105,14 +105,13 @@ void gnutls_anon_free_client_credentials(gnutls_anon_client_credentials_t sc) } /** - * gnutls_allocate_anon_client_credentials - Used to allocate a credentials structure - * @sc: is a pointer to an &gnutls_anon_client_credentials_t structure. - * - * This structure is complex enough to manipulate directly thus - * this helper function is provided in order to allocate it. - **/ -int gnutls_anon_allocate_client_credentials(gnutls_anon_client_credentials_t - * sc) + * gnutls_anon_allocate_client_credentials - Used to allocate a credentials structure + * @sc: is a pointer to an &gnutls_anon_client_credentials_t structure. + * + * This structure is complex enough to manipulate directly thus + * this helper function is provided in order to allocate it. + **/ +int gnutls_anon_allocate_client_credentials(gnutls_anon_client_credentials_t * sc) { /* anon_dummy is only there for *sc not to be null. * it is not used at all; diff --git a/lib/gnutls_dh_primes.c b/lib/gnutls_dh_primes.c index 6eda6a1a11..cdd5d512ce 100644 --- a/lib/gnutls_dh_primes.c +++ b/lib/gnutls_dh_primes.c @@ -128,16 +128,16 @@ int _gnutls_dh_generate_prime(mpi_t * ret_g, mpi_t * ret_n, * generated one. */ /** - * gnutls_dh_import_raw - This function will import DH parameters - * @dh_params: Is a structure that will hold the prime numbers - * @prime: holds the new prime - * @generator: holds the new generator - * - * This function will replace the pair of prime and generator for use in - * the Diffie-Hellman key exchange. The new parameters should be stored in the - * appropriate gnutls_datum. - * - **/ + * gnutls_dh_params_import_raw - This function will import DH parameters + * @dh_params: Is a structure that will hold the prime numbers + * @prime: holds the new prime + * @generator: holds the new generator + * + * This function will replace the pair of prime and generator for use in + * the Diffie-Hellman key exchange. The new parameters should be stored in the + * appropriate gnutls_datum. + * + **/ int gnutls_dh_params_import_raw(gnutls_dh_params_t dh_params, const gnutls_datum_t * prime, const gnutls_datum_t * generator) diff --git a/lib/gnutls_srp.c b/lib/gnutls_srp.c index d0630bceb0..ab679f1c95 100644 --- a/lib/gnutls_srp.c +++ b/lib/gnutls_srp.c @@ -374,7 +374,7 @@ mpi_t _gnutls_calc_srp_S2(mpi_t B, mpi_t g, mpi_t x, } /** - * gnutls_srp_free_server_credentials - Used to free an allocated gnutls_srp_client_credentials_t structure + * gnutls_srp_free_client_credentials - Used to free an allocated gnutls_srp_client_credentials_t structure * @sc: is an &gnutls_srp_client_credentials_t structure. * * This structure is complex enough to manipulate directly thus @@ -389,7 +389,7 @@ void gnutls_srp_free_client_credentials(gnutls_srp_client_credentials_t sc) } /** - * gnutls_srp_allocate_server_credentials - Used to allocate an gnutls_srp_server_credentials_t structure + * gnutls_srp_allocate_client_credentials - Used to allocate an gnutls_srp_server_credentials_t structure * @sc: is a pointer to an &gnutls_srp_server_credentials_t structure. * * This structure is complex enough to manipulate directly thus diff --git a/lib/gnutls_ui.c b/lib/gnutls_ui.c index 711cbd07a1..f12ba647ac 100644 --- a/lib/gnutls_ui.c +++ b/lib/gnutls_ui.c @@ -156,13 +156,14 @@ int gnutls_dh_get_pubkey(gnutls_session_t session, gnutls_datum_t * raw_key) } /** - * gnutls_rsa_export_get_modulus - This function returns the peer's modulus used in RSA-EXPORT authentication + * gnutls_rsa_export_get_pubkey - This function returns the peer's public key used in RSA-EXPORT authentication * @session: is a gnutls session * @exp: will hold the exponent. * @mod: will hold the modulus. * - * This function will return the peer's modulus used in the last RSA-EXPORT authentication. - * The output parameters must be freed with gnutls_free(). + * This function will return the peer's public key exponent and + * modulus used in the last RSA-EXPORT authentication. The output + * parameters must be freed with gnutls_free(). * * Returns a negative value in case of an error. * diff --git a/lib/gnutls_ui.h b/lib/gnutls_ui.h index 867ca51178..cfb9a6036c 100644 --- a/lib/gnutls_ui.h +++ b/lib/gnutls_ui.h @@ -73,16 +73,6 @@ void gnutls_certificate_server_set_retrieve_function(gnutls_certificate_credenti void gnutls_certificate_server_set_request(gnutls_session_t session, gnutls_certificate_request_t req); -/* X.509 certificate handling functions - */ - -int gnutls_pkcs3_extract_dh_params(const gnutls_datum_t * params, - gnutls_x509_crt_fmt_t format, - gnutls_datum_t * prime, gnutls_datum_t * generator, int *prime_bits); -int gnutls_pkcs3_export_dh_params(const gnutls_datum_t * prime, - const gnutls_datum_t * generator, gnutls_x509_crt_fmt_t format, - unsigned char *params_data, int *params_data_size); - /* get data from the session */ const gnutls_datum_t *gnutls_certificate_get_peers(gnutls_session_t session, -- cgit v1.2.1