Commit 3a1f25bf authored by Pekka Pessi's avatar Pekka Pessi

iptsec: updated documentation

darcs-hash:20070920173404-65a35-c88421f6a79f03f26f3e8a3ec0b07cbeb940317a.gz
parent 6d8ecb5a
......@@ -20,7 +20,7 @@ TAGFILES += ../docs/nta.doxytags=../nta
GENERATE_TAGFILE = ../docs/iptsec.doxytags
ALIASES +=
ALIASES += "iptsec=@ref index \"iptsec\""
PREDEFINED += SOFIA_EXTEND_AUTH_CLIENT=1
......@@ -205,15 +205,17 @@ int ca_challenge(auth_client_t *ca,
* processed.
*
* @bug
* The result can be quite unexpected if there are more than one
* authenticator with the given type (specified by @a crcl). In principle,
* SIP allows more than one challenge for a single request.
* In principle, SIP allows more than one challenge for a single request.
* For example, there can be multiple proxies that each challenge the
* client. The result of storing authentication info can be quite unexpected
* if there are more than one authenticator with the given type (specified
* by @a credential_class).
*
* @retval number of challenges to updated
* @retval 0 when there was no challenge to update
* @retval -1 upon an error
*
* @NEW_1_12_5
* @NEW_1_12_5.
*/
int auc_info(auth_client_t **auc_list,
msg_auth_info_t const *info,
......@@ -525,7 +527,7 @@ int ca_clear_credentials(auth_client_t *ca)
* @retval 1 when authorization can proceed
* @retval 0 when there is not enough credentials
*
* @NEW_1_12_5
* @NEW_1_12_5.
*/
int auc_has_authorization(auth_client_t **auc_list)
{
......
......@@ -22,7 +22,7 @@
*
*/
/**
/**@internal
* @file auth_module_http.c
* @brief Authenticate HTTP request
*
......
......@@ -22,7 +22,7 @@
*
*/
/**
/**@internal
* @file auth_module_sip.c
* @brief Authenticate SIP request
*
......
......@@ -22,7 +22,7 @@
*
*/
/**
/**@internal
* @file auth_plugin.c
* @brief Plugin interface for authentication verification modules.
*
......
......@@ -22,7 +22,7 @@
*
*/
/**@file iptsec_debug.c
/**@internal @file iptsec_debug.c
* @brief Debug log for IPTSEC module.
*
* @author Pekka Pessi <Pekka.Pessi@nokia.com>
......@@ -36,25 +36,34 @@
#include "iptsec_debug.h"
/**@var IPTSEC_DEBUG
#if DOXYGEN_ONLY
/** @defgroup iptsec_env Environment Variables Used by iptsec Module
*
* Environment variable determining the debug log level for @b iptsec
* @brief Environment variables used by @iptsec module are listed here.
*
* The #IPTSEC_DEBUG variable sets the debug level.
*/
/**@ingroup iptsec_env
*
* Environment variable determining the debug log level for @iptsec
* module.
*
* The IPTSEC_DEBUG environment variable is used to determine the debug
* logging level for @b iptsec module. The default level is 3.
* logging level for @iptsec module. The default level is 3.
*
* @sa <sofia-sip/su_debug.h>, iptsec_log, SOFIA_DEBUG
* @sa <sofia-sip/su_debug.h>, #iptsec_log, #SOFIA_DEBUG
*/
extern char const IPTSEC_DEBUG[];
extern IPTSEC_DEBUG;
#endif
#ifndef SU_DEBUG
#define SU_DEBUG 3
#endif
/**Debug log for @b iptsec module.
/** Common log for client and server components.
*
* The iptsec_log is the log object used by @b iptsec module. The level of
* The iptsec_log is the log object used by @iptsec module. The level of
* #iptsec_log is set using #IPTSEC_DEBUG environment variable.
*/
su_log_t iptsec_log[] = { SU_LOG_INIT("iptsec", "IPTSEC_DEBUG", SU_DEBUG) };
......
......@@ -26,7 +26,8 @@
/** Defined when <iptsec_debug.h> has been included. */
#define IPTSEC_DEBUG_H
/**@file iptsec_debug.h
/**@internal
* @file iptsec_debug.h
* @brief Debug log for IPTSEC module.
*
* @author Pekka Pessi <Pekka.Pessi@nokia.com>
......@@ -38,7 +39,7 @@
SOFIA_BEGIN_DECLS
/** Common log for application and srvlib components. */
/** Common log for client and server components. */
SOFIAPUBVAR su_log_t iptsec_log[];
SOFIA_END_DECLS
......
......@@ -91,12 +91,12 @@ struct auth_client_plugin
int (*auc_info)(auth_client_t *ca, msg_auth_info_t const *ai);
#if SOFIA_EXTEND_AUTH_CLIENT
/** Clear credentials (user/pass). @NEW_1_12_6 */
/** Clear credentials (user/pass). @NEW_1_12_6. */
int (*auc_clear)(auth_client_t *ca);
#endif
};
/** Check if authentication client has been extended. @NEW_1_12_6 */
/** Check if authentication client has been extended. @NEW_1_12_6. */
#define AUTH_CLIENT_IS_EXTENDED(ca) \
((ca)->ca_auc->auc_plugin_size > \
(int)offsetof(auth_client_plugin_t, auc_clear) \
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment