}
/**
- * gnutls_cipher_suite_get_name - Returns a string with the name of the specified cipher suite
- * @kx_algorithm: is a Key exchange algorithm
- * @cipher_algorithm: is a cipher algorithm
- * @mac_algorithm: is a MAC algorithm
- *
- * Note that the full cipher suite name must be prepended by TLS or
- * SSL depending of the protocol in use.
- *
- * Returns: a string that contains the name of a TLS cipher suite,
- * specified by the given algorithms, or %NULL.
- **/
+ * gnutls_cipher_suite_get_name - get name of the specified cipher suite
+ * @kx_algorithm: is a Key exchange algorithm
+ * @cipher_algorithm: is a cipher algorithm
+ * @mac_algorithm: is a MAC algorithm
+ *
+ * Note that the full cipher suite name must be prepended by TLS or
+ * SSL depending of the protocol in use.
+ *
+ * Returns: a string that contains the name of a TLS cipher suite,
+ * specified by the given algorithms, or %NULL.
+ **/
const char *
gnutls_cipher_suite_get_name (gnutls_kx_algorithm_t kx_algorithm,
gnutls_cipher_algorithm_t cipher_algorithm,
/**
* gnutls_sign_algorithm_get_name - Returns a string with the name of the specified sign algorithm
- * @algorithm: is a sign algorithm
+ * @sign: is a sign algorithm
*
* Convert a #gnutls_sign_algorithm_t value to a string.
*
/*
- * Copyright (C) 2001, 2002, 2003, 2004, 2005, 2008 Free Software Foundation
+ * Copyright (C) 2001, 2002, 2003, 2004, 2005, 2008, 2009 Free Software Foundation
*
* Author: Nikos Mavrogiannopoulos
*
* { algorithm, credentials, pointer to next }
*/
/**
- * gnutls_credentials_set - Sets the needed credentials for the specified authentication algorithm.
- * @session: is a #gnutls_session_t structure.
- * @type: is the type of the credentials
- * @cred: is a pointer to a structure.
- *
- * Sets the needed credentials for the specified type.
- * Eg username, password - or public and private keys etc.
- * The (void* cred) parameter is a structure that depends on the
- * specified type and on the current session (client or server).
- * [ In order to minimize memory usage, and share credentials between
- * several threads gnutls keeps a pointer to cred, and not the whole cred
- * structure. Thus you will have to keep the structure allocated until
- * you call gnutls_deinit(). ]
- *
- * For GNUTLS_CRD_ANON cred should be gnutls_anon_client_credentials_t in case of a client.
- * In case of a server it should be gnutls_anon_server_credentials_t.
- *
- * For GNUTLS_CRD_SRP cred should be gnutls_srp_client_credentials_t
- * in case of a client, and gnutls_srp_server_credentials_t, in case
- * of a server.
- *
- * For GNUTLS_CRD_CERTIFICATE cred should be gnutls_certificate_credentials_t.
- *
- **/
+ * gnutls_credentials_set - Sets the needed credentials for the specified authentication algorithm.
+ * @session: is a #gnutls_session_t structure.
+ * @type: is the type of the credentials
+ * @cred: is a pointer to a structure.
+ *
+ * Sets the needed credentials for the specified type. Eg username,
+ * password - or public and private keys etc. The @cred parameter is
+ * a structure that depends on the specified type and on the current
+ * session (client or server).
+ *
+ * In order to minimize memory usage, and share credentials between
+ * several threads gnutls keeps a pointer to cred, and not the whole
+ * cred structure. Thus you will have to keep the structure allocated
+ * until you call gnutls_deinit().
+ *
+ * For %GNUTLS_CRD_ANON, @cred should be
+ * #gnutls_anon_client_credentials_t in case of a client. In case of
+ * a server it should be #gnutls_anon_server_credentials_t.
+ *
+ * For %GNUTLS_CRD_SRP, @cred should be #gnutls_srp_client_credentials_t
+ * in case of a client, and #gnutls_srp_server_credentials_t, in case
+ * of a server.
+ *
+ * For %GNUTLS_CRD_CERTIFICATE, @cred should be
+ * #gnutls_certificate_credentials_t.
+ *
+ * Returns: On success, %GNUTLS_E_SUCCESS (zero) is returned,
+ * otherwise an error code is returned.
+ **/
int
gnutls_credentials_set (gnutls_session_t session,
gnutls_credentials_type_t type, void *cred)
/*
- * Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation
+ * Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation
*
* Author: Nikos Mavrogiannopoulos
*
}
/**
- * gnutls_record_check_pending - checks if there are any data to receive in gnutls buffers.
- * @session: is a #gnutls_session_t structure.
- *
- * This function checks if there are any data to receive
- * in the gnutls buffers. Returns the size of that data or 0.
- * Notice that you may also use select() to check for data in
- * a TCP connection, instead of this function.
- * (gnutls leaves some data in the tcp buffer in order for select
- * to work).
- **/
+ * gnutls_record_check_pending - checks if there are any data to receive in gnutls buffers.
+ * @session: is a #gnutls_session_t structure.
+ *
+ * This function checks if there are any data to receive in the gnutls
+ * buffers.
+ *
+ * Notice that you may also use select() to check for data in a TCP
+ * connection, instead of this function. GnuTLS leaves some data in
+ * the tcp buffer in order for select to work.
+ *
+ * Returns: the size of that data or 0.
+ **/
size_t
gnutls_record_check_pending (gnutls_session_t session)
{
* Note that you must also check the peer's name in order to check if
* the verified certificate belongs to the actual peer.
*
- * This is the same as gnutls_x509_crt_list_verify() and uses the
- * loaded CAs in the credentials as trusted CAs.
+ * This function uses gnutls_x509_crt_list_verify() with the CAs in
+ * the credentials as trusted CAs.
*
* Note that some commonly used X.509 Certificate Authorities are
* still using Version 1 certificates. If you want to accept them,
* the peer's name in order to check if the verified certificate
* belongs to the actual peer.
*
- * The return value should be one or more of the
- * gnutls_certificate_status_t enumerated elements bitwise or'd, or a
- * negative value on error.
+ * This function uses gnutls_x509_crt_list_verify().
*
- * This is the same as gnutls_x509_crt_list_verify().
+ * Returns: one or more of the #gnutls_certificate_status_t
+ * enumerated elements bitwise or'd, or a negative value on error.
*
* Deprecated: Use gnutls_certificate_verify_peers2() instead.
**/
**/
void
gnutls_global_set_mem_functions (gnutls_alloc_function alloc_func,
- gnutls_alloc_function
- secure_alloc_func,
- gnutls_is_secure_function
- is_secure_func,
+ gnutls_alloc_function secure_alloc_func,
+ gnutls_is_secure_function is_secure_func,
gnutls_realloc_function realloc_func,
gnutls_free_function free_func)
{
**/
int
gnutls_priority_init (gnutls_priority_t * priority_cache,
- const char *priorities, const char **err_pos)
+ const char *priorities,
+ const char **err_pos)
{
char *broken_list[MAX_ELEMENTS];
int broken_list_size, i, j;
/*
- * Copyright (C) 2005, 2007, 2008 Free Software Foundation
+ * Copyright (C) 2005, 2007, 2008, 2009 Free Software Foundation
*
* Author: Nikos Mavrogiannopoulos
*
}
/**
- * gnutls_psk_set_server_params_function - set the DH parameters callback
- * @res: is a gnutls_certificate_credentials_t structure
- * @func: is the function to be called
- *
- * This function will set a callback in order for the server to get
- * the diffie hellman parameters for PSK authentication. The callback
- * should return zero on success.
- **/
+ * gnutls_psk_set_server_params_function - set the DH parameters callback
+ * @res: is a #gnutls_certificate_credentials_t structure
+ * @func: is the function to be called
+ *
+ * This function will set a callback in order for the server to get
+ * the diffie hellman parameters for PSK authentication. The callback
+ * should return zero on success.
+ **/
void
gnutls_psk_set_server_params_function (gnutls_psk_server_credentials_t res,
gnutls_params_function * func)
/*
- * Copyright (C) 2000, 2003, 2004, 2005, 2007, 2008 Free Software Foundation
+ * Copyright (C) 2000, 2003, 2004, 2005, 2007, 2008, 2009 Free Software Foundation
*
* Author: Nikos Mavrogiannopoulos
*
}
/**
- * gnutls_session_get_data2 - Returns all session parameters.
- * @session: is a #gnutls_session_t structure.
- * @session_data: is a pointer to a datum that will hold the session.
- *
- * Returns all session parameters, in order to support resuming.
- * The client should call this, and keep the returned session, if he wants to
- * resume that current version later by calling gnutls_session_set_data()
- * This function must be called after a successful handshake. The returned
- * datum must be freed with gnutls_free().
- *
- * Resuming sessions is really useful and speedups connections after
- * a succesful one.
- *
- * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise
- * an error code is returned.
- **/
+ * gnutls_session_get_data2 - Returns all session parameters.
+ * @session: is a #gnutls_session_t structure.
+ * @data: is a pointer to a datum that will hold the session.
+ *
+ * Returns all session parameters, in order to support resuming. The
+ * client should call this, and keep the returned session, if he wants
+ * to resume that current version later by calling
+ * gnutls_session_set_data(). This function must be called after a
+ * successful handshake. The returned datum must be freed with
+ * gnutls_free().
+ *
+ * Resuming sessions is really useful and speedups connections after
+ * a succesful one.
+ *
+ * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise
+ * an error code is returned.
+ **/
int
gnutls_session_get_data2 (gnutls_session_t session, gnutls_datum_t * data)
{
/**
* gnutls_session_set_finished_function:
* @session: is a #gnutls_session_t structure.
- * @finished_func: a #gnutls_finished_callback_func callback.
+ * @func: a #gnutls_finished_callback_func callback.
*
* Register a callback function for the session that will be called
* when a TLS Finished message has been generated. The function is
*
* The callback should follow this prototype:
*
- * void callback (gnutls_session_t session, const void *finished, size_t len);
+ * void callback (gnutls_session_t @session, const void *@finished, size_t @len);
*
* The @finished parameter will contain the binary TLS finished
* message, and @len will contains its length. For SSLv3 connections,
**/
void
gnutls_session_set_finished_function (gnutls_session_t session,
- gnutls_finished_callback_func
- finished_func)
+ gnutls_finished_callback_func func)
{
- session->internals.finished_func = finished_func;
+ session->internals.finished_func = func;
}
/**
/**
* gnutls_handshake_set_post_client_hello_function - set callback to be called after the client hello is received
- * @res: is a gnutls_anon_server_credentials_t structure
+ * @session: is a #gnutls_session_t structure.
* @func: is the function to be called
*
* This function will set a callback to be called after the client
GNUTLS_SIGN_RSA_SHA224
} gnutls_sign_algorithm_t;
- const char *gnutls_sign_algorithm_get_name (gnutls_sign_algorithm_t
- algorithm);
+ const char *
+ gnutls_sign_algorithm_get_name (gnutls_sign_algorithm_t sign);
/* If you want to change this, then also change the define in
* gnutls_int.h, and recompile.
const gnutls_kx_algorithm_t *gnutls_kx_list (void);
const gnutls_pk_algorithm_t *gnutls_pk_list (void);
const gnutls_sign_algorithm_t *gnutls_sign_list (void);
- const char *gnutls_cipher_suite_info (size_t i,
- char *id,
+ const char *gnutls_cipher_suite_info (size_t idx,
+ char *cs_id,
gnutls_kx_algorithm_t *kx,
gnutls_cipher_algorithm_t *cipher,
gnutls_mac_algorithm_t *mac,
/* if you just want some defaults, use the following.
*/
int gnutls_priority_init (gnutls_priority_t *priority_cache,
- const char *priority,
+ const char *priorities,
const char** err_pos);
- void gnutls_priority_deinit (gnutls_priority_t);
+ void gnutls_priority_deinit (gnutls_priority_t priority_cache);
int gnutls_priority_set (gnutls_session_t session,
gnutls_priority_t priority);
int gnutls_priority_set_direct (gnutls_session_t session,
- const char *priority,
+ const char *priorities,
const char** err_pos);
/* for compatibility
int gnutls_set_default_export_priority (gnutls_session_t session);
/* Returns the name of a cipher suite */
- const char *gnutls_cipher_suite_get_name (gnutls_kx_algorithm_t
- kx_algorithm,
- gnutls_cipher_algorithm_t
- cipher_algorithm,
- gnutls_mac_algorithm_t
- mac_algorithm);
+ const char *
+ gnutls_cipher_suite_get_name (gnutls_kx_algorithm_t kx_algorithm,
+ gnutls_cipher_algorithm_t cipher_algorithm,
+ gnutls_mac_algorithm_t mac_algorithm);
/* get the currently used protocol version */
gnutls_protocol_t gnutls_protocol_get_version (gnutls_session_t session);
size_t len);
void
gnutls_session_set_finished_function (gnutls_session_t session,
- gnutls_finished_callback_func
- finished_func);
+ gnutls_finished_callback_func func);
/* checks if this session is a resumed one
*/
typedef void (*gnutls_free_function) (void *);
typedef void *(*gnutls_realloc_function) (void *, size_t);
- void gnutls_global_set_mem_functions (gnutls_alloc_function gt_alloc_func,
- gnutls_alloc_function
- gt_secure_alloc_func,
- gnutls_is_secure_function
- gt_is_secure_func,
- gnutls_realloc_function gt_realloc_func,
- gnutls_free_function gt_free_func);
+ void
+ gnutls_global_set_mem_functions (gnutls_alloc_function alloc_func,
+ gnutls_alloc_function secure_alloc_func,
+ gnutls_is_secure_function is_secure_func,
+ gnutls_realloc_function realloc_func,
+ gnutls_free_function free_func);
/* For use in callbacks */
extern gnutls_alloc_function gnutls_malloc;
const char *username,
gnutls_datum_t * key);
void
- gnutls_psk_set_server_credentials_function
- (gnutls_psk_server_credentials_t cred,
- gnutls_psk_server_credentials_function * func);
+ gnutls_psk_set_server_credentials_function
+ (gnutls_psk_server_credentials_t cred,
+ gnutls_psk_server_credentials_function * func);
typedef int gnutls_psk_client_credentials_function (gnutls_session_t,
char **username,
int gnutls_hex_decode (const gnutls_datum_t * hex_data, char *result,
size_t * result_size);
- void gnutls_psk_set_server_dh_params (gnutls_psk_server_credentials_t res,
- gnutls_dh_params_t dh_params);
+ void
+ gnutls_psk_set_server_dh_params (gnutls_psk_server_credentials_t res,
+ gnutls_dh_params_t dh_params);
- void gnutls_psk_set_server_params_function (gnutls_psk_server_credentials_t
- res,
- gnutls_params_function * func);
+ void
+ gnutls_psk_set_server_params_function (gnutls_psk_server_credentials_t res,
+ gnutls_params_function * func);
int gnutls_psk_netconf_derive_key (const char *password,
const char *psk_identity,
/* The key_usage flags are defined in gnutls.h. They are
* the GNUTLS_KEY_* definitions.
*/
- int gnutls_openpgp_crt_get_key_usage (gnutls_openpgp_crt_t cert,
+ int gnutls_openpgp_crt_get_key_usage (gnutls_openpgp_crt_t key,
unsigned int *key_usage);
int gnutls_openpgp_crt_get_fingerprint (gnutls_openpgp_crt_t key, void *fpr,
size_t * fprlen);
int gnutls_openpgp_privkey_import (gnutls_openpgp_privkey_t key,
const gnutls_datum_t * data,
gnutls_openpgp_crt_fmt_t format,
- const char *pass, unsigned int flags);
+ const char *password,
+ unsigned int flags);
int gnutls_openpgp_privkey_sign_hash (gnutls_openpgp_privkey_t key,
const gnutls_datum_t * hash,
gnutls_datum_t * signature);
* fingerprint instead of a full key. See also
* gnutls_openpgp_set_recv_key_function().
*
+ * Returns: On success, %GNUTLS_E_SUCCESS (zero) is returned,
+ * otherwise an error code is returned.
*/
typedef int (*gnutls_openpgp_recv_key_func) (gnutls_session_t session,
const unsigned char *keyfpr,
gnutls_certificate_set_openpgp_key_file (gnutls_certificate_credentials_t res,
const char *certfile,
const char *keyfile,
- gnutls_openpgp_crt_fmt_t);
+ gnutls_openpgp_crt_fmt_t format);
int
gnutls_certificate_set_openpgp_key_mem (gnutls_certificate_credentials_t res,
const gnutls_datum_t * cert,
const gnutls_datum_t * key,
- gnutls_openpgp_crt_fmt_t);
+ gnutls_openpgp_crt_fmt_t format);
int
gnutls_certificate_set_openpgp_key_file2 (gnutls_certificate_credentials_t res,
const char *certfile,
const char *keyfile,
- const char *keyid,
+ const char *subkey_id,
gnutls_openpgp_crt_fmt_t format);
int
gnutls_certificate_set_openpgp_key_mem2 (gnutls_certificate_credentials_t res,
const gnutls_datum_t * cert,
const gnutls_datum_t * key,
- const char *keyid,
+ const char *subkey_id,
gnutls_openpgp_crt_fmt_t format);
int
/*
- * Copyright (C) 2003, 2004, 2005, 2007, 2008 Free Software Foundation
+ * Copyright (C) 2003, 2004, 2005, 2007, 2008, 2009 Free Software Foundation
*
* Author: Nikos Mavrogiannopoulos
*
GNUTLS_BAG_UNKNOWN = 20
} gnutls_pkcs12_bag_type_t;
- gnutls_pkcs12_bag_type_t gnutls_pkcs12_bag_get_type (gnutls_pkcs12_bag_t
- bag, int indx);
+ gnutls_pkcs12_bag_type_t
+ gnutls_pkcs12_bag_get_type (gnutls_pkcs12_bag_t bag,
+ int indx);
int gnutls_pkcs12_bag_get_data (gnutls_pkcs12_bag_t bag, int indx,
gnutls_datum_t * data);
int gnutls_pkcs12_bag_set_data (gnutls_pkcs12_bag_t bag,
const void *data,
unsigned int data_size,
unsigned int flags);
- int gnutls_x509_crt_sign (gnutls_x509_crt_t crt, gnutls_x509_crt_t issuer,
+ int gnutls_x509_crt_sign (gnutls_x509_crt_t crt,
+ gnutls_x509_crt_t issuer,
gnutls_x509_privkey_t issuer_key);
- int gnutls_x509_crt_sign2 (gnutls_x509_crt_t crt, gnutls_x509_crt_t issuer,
+ int gnutls_x509_crt_sign2 (gnutls_x509_crt_t crt,
+ gnutls_x509_crt_t issuer,
gnutls_x509_privkey_t issuer_key,
- gnutls_digest_algorithm_t, unsigned int flags);
+ gnutls_digest_algorithm_t dig,
+ unsigned int flags);
int gnutls_x509_crt_set_activation_time (gnutls_x509_crt_t cert,
time_t act_time);
int gnutls_x509_crt_set_expiration_time (gnutls_x509_crt_t cert,
/*
- * Copyright (C) 2003, 2004, 2005, 2007, 2008 Free Software Foundation
+ * Copyright (C) 2003, 2004, 2005, 2007, 2008, 2009 Free Software Foundation
*
* Author: Nikos Mavrogiannopoulos, Timo Schulz
*
/**
* gnutls_openpgp_keyring_get_crt - export an openpgp certificate from a keyring
- * @key: Holds the key.
+ * @ring: Holds the keyring.
* @idx: the index of the certificate to export
- * @crt: An uninitialized #gnutls_openpgp_crt_t structure
+ * @cert: An uninitialized #gnutls_openpgp_crt_t structure
*
* This function will extract an OpenPGP certificate from the given
* keyring. If the index given is out of range
}
/**
- * gnutls_certificate_set_openpgp_key - Used to set keys in a gnutls_certificate_credentials_t structure
- * @res: is an #gnutls_certificate_credentials_t structure.
- * @key: contains an openpgp public key
- * @pkey: is an openpgp private key
- *
- * This function sets a certificate/private key pair in the
- * gnutls_certificate_credentials_t structure. This function may be called
- * more than once (in case multiple keys/certificates exist for the
- * server).
- *
- * With this function the subkeys of the certificate are not used.
- *
- **/
+ * gnutls_certificate_set_openpgp_key - Used to set keys in a gnutls_certificate_credentials_t structure
+ * @res: is an #gnutls_certificate_credentials_t structure.
+ * @key: contains an openpgp public key
+ * @pkey: is an openpgp private key
+ *
+ * This function sets a certificate/private key pair in the
+ * gnutls_certificate_credentials_t structure. This function may be
+ * called more than once (in case multiple keys/certificates exist
+ * for the server).
+ *
+ * With this function the subkeys of the certificate are not used.
+ *
+ * Returns: On success, %GNUTLS_E_SUCCESS (zero) is returned,
+ * otherwise an error code is returned.
+ **/
int
-gnutls_certificate_set_openpgp_key (gnutls_certificate_credentials_t
- res, gnutls_openpgp_crt_t crt,
+gnutls_certificate_set_openpgp_key (gnutls_certificate_credentials_t res,
+ gnutls_openpgp_crt_t crt,
gnutls_openpgp_privkey_t pkey)
{
int ret;
* negative error value.
**/
int
-gnutls_certificate_set_openpgp_key_mem (gnutls_certificate_credentials_t
- res, const gnutls_datum_t * icert,
- const gnutls_datum_t * ikey,
+gnutls_certificate_set_openpgp_key_mem (gnutls_certificate_credentials_t res,
+ const gnutls_datum_t * cert,
+ const gnutls_datum_t * key,
gnutls_openpgp_crt_fmt_t format)
{
- return gnutls_certificate_set_openpgp_key_mem2 (res, icert, ikey,
+ return gnutls_certificate_set_openpgp_key_mem2 (res, cert, key,
NULL, format);
}
* negative error value.
**/
int
-gnutls_certificate_set_openpgp_key_file (gnutls_certificate_credentials_t
- res, const char *certfile,
+gnutls_certificate_set_openpgp_key_file (gnutls_certificate_credentials_t res,
+ const char *certfile,
const char *keyfile,
gnutls_openpgp_crt_fmt_t format)
{
* credentials structure. The files should only contain one key which
* is not encrypted.
*
- * The special keyword "auto" is also accepted as &subkey_id. In that
+ * The special keyword "auto" is also accepted as @subkey_id. In that
* case the gnutls_openpgp_crt_get_auth_subkey() will be used to
* retrieve the subkey.
*
* Since: 2.4.0
**/
int
-gnutls_certificate_set_openpgp_key_mem2 (gnutls_certificate_credentials_t
- res, const gnutls_datum_t * icert,
- const gnutls_datum_t * ikey,
+gnutls_certificate_set_openpgp_key_mem2 (gnutls_certificate_credentials_t res,
+ const gnutls_datum_t * cert,
+ const gnutls_datum_t * key,
const char *subkey_id,
gnutls_openpgp_crt_fmt_t format)
{
- gnutls_openpgp_privkey_t key;
- gnutls_openpgp_crt_t cert;
+ gnutls_openpgp_privkey_t pkey;
+ gnutls_openpgp_crt_t crt;
int ret;
- ret = gnutls_openpgp_privkey_init (&key);
+ ret = gnutls_openpgp_privkey_init (&pkey);
if (ret < 0)
{
gnutls_assert ();
return ret;
}
- ret = gnutls_openpgp_privkey_import (key, ikey, format, NULL, 0);
+ ret = gnutls_openpgp_privkey_import (pkey, key, format, NULL, 0);
if (ret < 0)
{
gnutls_assert ();
- gnutls_openpgp_privkey_deinit (key);
+ gnutls_openpgp_privkey_deinit (pkey);
return ret;
}
- ret = gnutls_openpgp_crt_init (&cert);
+ ret = gnutls_openpgp_crt_init (&crt);
if (ret < 0)
{
gnutls_assert ();
- gnutls_openpgp_privkey_deinit (key);
+ gnutls_openpgp_privkey_deinit (pkey);
return ret;
}
- ret = gnutls_openpgp_crt_import (cert, icert, format);
+ ret = gnutls_openpgp_crt_import (crt, cert, format);
if (ret < 0)
{
gnutls_assert ();
- gnutls_openpgp_privkey_deinit (key);
- gnutls_openpgp_crt_deinit (cert);
+ gnutls_openpgp_privkey_deinit (pkey);
+ gnutls_openpgp_crt_deinit (crt);
return ret;
}
gnutls_openpgp_keyid_t keyid;
if (strcasecmp (subkey_id, "auto") == 0)
- ret = gnutls_openpgp_crt_get_auth_subkey (cert, keyid, 1);
+ ret = gnutls_openpgp_crt_get_auth_subkey (crt, keyid, 1);
else
ret = get_keyid (keyid, subkey_id);
if (ret >= 0)
{
- ret = gnutls_openpgp_crt_set_preferred_key_id (cert, keyid);
+ ret = gnutls_openpgp_crt_set_preferred_key_id (crt, keyid);
if (ret >= 0)
- ret = gnutls_openpgp_privkey_set_preferred_key_id (key, keyid);
+ ret = gnutls_openpgp_privkey_set_preferred_key_id (pkey, keyid);
}
if (ret < 0)
{
gnutls_assert ();
- gnutls_openpgp_privkey_deinit (key);
- gnutls_openpgp_crt_deinit (cert);
+ gnutls_openpgp_privkey_deinit (pkey);
+ gnutls_openpgp_crt_deinit (crt);
return ret;
}
}
- ret = gnutls_certificate_set_openpgp_key (res, cert, key);
+ ret = gnutls_certificate_set_openpgp_key (res, crt, pkey);
- gnutls_openpgp_privkey_deinit (key);
- gnutls_openpgp_crt_deinit (cert);
+ gnutls_openpgp_privkey_deinit (pkey);
+ gnutls_openpgp_crt_deinit (crt);
return ret;
}
* This funtion is used to load OpenPGP keys into the GnuTLS credential
* structure. The files should contain non encrypted keys.
*
- * The special keyword "auto" is also accepted as &subkey_id. In that case
- * the gnutls_openpgp_crt_get_auth_subkey() will be used to retrieve the subkey.
+ * The special keyword "auto" is also accepted as @subkey_id. In that
+ * case the gnutls_openpgp_crt_get_auth_subkey() will be used to
+ * retrieve the subkey.
*
* Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
* negative error value.
* @c: A certificate credentials structure
* @data: buffer with keyring data.
* @dlen: length of data buffer.
+ * @format: the format of the keyring
*
* The function is used to set keyrings that will be used internally
* by various OpenPGP functions. For example to find a key when it
* negative error value.
**/
int
-gnutls_certificate_set_openpgp_keyring_mem (gnutls_certificate_credentials_t
- c, const opaque * data,
+gnutls_certificate_set_openpgp_keyring_mem (gnutls_certificate_credentials_t c,
+ const opaque * data,
size_t dlen,
gnutls_openpgp_crt_fmt_t format)
{
/*
- * Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation
+ * Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation
*
* Author: Timo Schulz, Nikos Mavrogiannopoulos
*
* This allows setting a preferred key id for the given certificate.
* This key will be used by functions that involve key handling.
*
+ * Returns: On success, %GNUTLS_E_SUCCESS (zero) is returned,
+ * otherwise an error code is returned.
**/
int
gnutls_openpgp_crt_set_preferred_key_id (gnutls_openpgp_crt_t key,
/**
* gnutls_openpgp_crt_get_auth_subkey - Gets the keyID of an authentication subkey
- * @key: the structure that contains the OpenPGP public key.
+ * @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.
*
/*
- * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation
+ * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation
*
* Author: Nikos Mavrogiannopoulos
*
* gnutls_openpgp_privkey_import - import a RAW or BASE64 encoded key
* @key: The structure to store the parsed key.
* @data: The RAW or BASE64 encoded key.
- * @format: One of gnutls_openpgp_crt_fmt_t elements.
- * @password: (unused for now)
+ * @format: One of #gnutls_openpgp_crt_fmt_t elements.
+ * @password: not used for now
* @flags: should be zero
*
* This function will convert the given RAW or Base64 encoded key to
* @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)
* @sizeof_oid: initially holds the size of @oid
+ * @critical: output variable with critical flag, may be NULL.
*
* This function will extract the key purpose OIDs of the Certificate
* specified by the given index. These are stored in the Extended
/**
* gnutls_x509_dn_import: get opaque DN object from DER RDN sequence
- *
* @dn: the structure that will hold the imported DN
* @data: should contain a DER encoded RDN sequence
*
/*
- * Copyright (C) 2003, 2004, 2005, 2008 Free Software Foundation
+ * Copyright (C) 2003, 2004, 2005, 2008, 2009 Free Software Foundation
*
* Author: Nikos Mavrogiannopoulos
*
}
/**
- * gnutls_pkcs12_bag_get_type - This function returns the bag's type
- * @bag: The bag
- * @indx: The element of the bag to get the type
- *
- * This function will return the bag's type. One of the gnutls_pkcs12_bag_type_t
- * enumerations.
- *
- **/
+ * gnutls_pkcs12_bag_get_type - This function returns the bag's type
+ * @bag: The bag
+ * @indx: The element of the bag to get the type
+ *
+ * This function will return the bag's type.
+ *
+ * Returns: One of the #gnutls_pkcs12_bag_type_t enumerations.
+ **/
gnutls_pkcs12_bag_type_t
gnutls_pkcs12_bag_get_type (gnutls_pkcs12_bag_t bag, int indx)
{
}
/**
- * gnutls_pkcs12_bag_get_count - This function returns the bag's elements count
- * @bag: The bag
- *
- * This function will return the number of the elements withing the bag.
- *
- **/
+ * gnutls_pkcs12_bag_get_count - This function returns the bag's elements count
+ * @bag: The bag
+ *
+ * This function will return the number of the elements withing the bag.
+ *
+ * Returns: Number of elements in bag, or an negative error code on
+ * error.
+ **/
int
gnutls_pkcs12_bag_get_count (gnutls_pkcs12_bag_t bag)
{
/**
- * gnutls_pkcs12_bag_decrypt - This function will decrypt an encrypted bag
- * @bag: The bag
- * @pass: The password used for encryption. This can only be ASCII.
- *
- * This function will decrypt the given encrypted bag and return 0 on success.
- *
- **/
+ * gnutls_pkcs12_bag_decrypt - This function will decrypt an encrypted bag
+ * @bag: The bag
+ * @pass: The password used for encryption, must be ASCII.
+ *
+ * This function will decrypt the given encrypted bag and return 0 on
+ * success.
+ *
+ * Returns: On success, %GNUTLS_E_SUCCESS (zero) is returned,
+ * otherwise an error code is returned.
+ **/
int
gnutls_pkcs12_bag_decrypt (gnutls_pkcs12_bag_t bag, const char *pass)
{
}
/**
- * gnutls_pkcs12_bag_encrypt - This function will encrypt a bag
- * @bag: The bag
- * @pass: The password used for encryption. This can only be ASCII.
- * @flags: should be one of gnutls_pkcs_encrypt_flags_t elements bitwise or'd
- *
- * This function will encrypt the given bag and return 0 on success.
- *
- **/
+ * gnutls_pkcs12_bag_encrypt - This function will encrypt a bag
+ * @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
+ *
+ * This function will encrypt the given bag.
+ *
+ * Returns: On success, %GNUTLS_E_SUCCESS (zero) is returned,
+ * otherwise an error code is returned.
+ **/
int
gnutls_pkcs12_bag_encrypt (gnutls_pkcs12_bag_t bag, const char *pass,
unsigned int flags)
}
/**
- * gnutls_x509_crt_get_extension_oid - This function returns the specified 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)
- * @sizeof_oid: initially holds the size of @oid
- *
- * This function will return the requested extension OID in the certificate.
- * The extension OID will be stored as a string in the provided buffer.
- *
- * A negative value may be returned in case of parsing error.
- * If your have reached the last extension available
- * GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE will be returned.
- *
- **/
+ * gnutls_x509_crt_get_extension_oid - get the specified 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)
+ * @sizeof_oid: initially holds the size of @oid
+ *
+ * This function will return the requested extension OID in the certificate.
+ * The extension OID will be stored as a string in the provided buffer.
+ *
+ * Returns: On success, %GNUTLS_E_SUCCESS (zero) is returned,
+ * otherwise an error code is returned. If you have reached the
+ * last extension available %GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE
+ * will be returned.
+ **/
int
gnutls_x509_crt_get_extension_oid (gnutls_x509_crt_t cert, int indx,
void *oid, size_t * sizeof_oid)
* if you want to get data indexed by the extension OID rather than
* sequence.
*
- * Return 0 on success. A negative value may be returned in case of
- * parsing error. If you have reached the last extension available
- * GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE will be returned.
+ * Returns: On success, %GNUTLS_E_SUCCESS (zero) is returned,
+ * otherwise an error code is returned. If you have reached the
+ * last extension available %GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE
+ * will be returned.
**/
int
gnutls_x509_crt_get_extension_data (gnutls_x509_crt_t cert, int indx,
*
* Subsequent calls to this function will append OIDs to the OID list.
*
- * On success 0 is returned.
+ * Returns: On success, %GNUTLS_E_SUCCESS (zero) is returned,
+ * otherwise an error code is returned.
**/
int
gnutls_x509_crt_set_key_purpose_oid (gnutls_x509_crt_t cert,
- const void *oid, unsigned int critical)
+ const void *oid,
+ unsigned int critical)
{
int result;
gnutls_datum_t old_id, der_data;
/*
- * Copyright (C) 2005, 2006, 2008 Free Software Foundation
+ * Copyright (C) 2005, 2006, 2008, 2009 Free Software Foundation
*
* Author: Simon Josefsson
*
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
- *
+ *
* GNUTLS-EXTRA is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
- *
+ *
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
* Perform a TLS/IA handshake. This should be called after
* gnutls_handshake() iff gnutls_ia_handshake_p().
*
- * Return 0 on success, or an error code.
+ * Returns: On success, %GNUTLS_E_SUCCESS (zero) is returned,
+ * otherwise an error code is returned.
**/
int
gnutls_ia_handshake (gnutls_session_t session)
projects / thirdparty / gnutls.git / commitdiff
