[asterisk-commits] oej: trunk r99464 - in /trunk: channels/ include/asterisk/ main/
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Tue Jan 22 10:39:57 CST 2008
Author: oej
Date: Tue Jan 22 02:58:46 2008
New Revision: 99464
URL: http://svn.digium.com/view/asterisk?view=rev&rev=99464
Log:
Doxygen updates
Modified:
trunk/channels/chan_zap.c
trunk/include/asterisk/tcptls.h
trunk/main/abstract_jb.c
trunk/main/tcptls.c
Change Statistics:
trunk/channels/chan_zap.c | 2 -
trunk/include/asterisk/tcptls.h | 25 +++++++------
trunk/main/abstract_jb.c | 8 ++--
trunk/main/tcptls.c | 51 +++++++++++++---------------
4 files changed, 44 insertions(+), 42 deletions(-)
Modified: trunk/channels/chan_zap.c
URL: http://svn.digium.com/view/asterisk/trunk/channels/chan_zap.c?view=diff&rev=99464&r1=99463&r2=99464
==============================================================================
--- trunk/channels/chan_zap.c (original)
+++ trunk/channels/chan_zap.c Tue Jan 22 02:58:46 2008
@@ -731,7 +731,7 @@
char smdi_port[SMDI_MAX_FILENAME_LEN];
};
-/** returns a new zt_chan_conf with default values (by-value) */
+/*! returns a new zt_chan_conf with default values (by-value) */
static struct zt_chan_conf zt_chan_conf_default(void) {
/* recall that if a field is not included here it is initialized
* to 0 or equivalent
Modified: trunk/include/asterisk/tcptls.h
URL: http://svn.digium.com/view/asterisk/trunk/include/asterisk/tcptls.h?view=diff&rev=99464&r1=99463&r2=99464
==============================================================================
--- trunk/include/asterisk/tcptls.h (original)
+++ trunk/include/asterisk/tcptls.h Tue Jan 22 02:58:46 2008
@@ -17,25 +17,28 @@
*/
/*!
- * \file server.h
+ * \file tcptls.h
*
* \brief Generic support for tcp/tls servers in Asterisk.
* \note In order to have TLS/SSL support, we need the openssl libraries.
* Still we can decide whether or not to use them by commenting
* in or out the DO_SSL macro.
+ *
* TLS/SSL support is basically implemented by reading from a config file
- * (currently http.conf) the names of the certificate and cipher to use,
+ * (currently http.conf and sip.conf) the names of the certificate and cipher to use,
* and then run ssl_setup() to create an appropriate SSL_CTX (ssl_ctx)
* If we support multiple domains, presumably we need to read multiple
* certificates.
+ *
* When we are requested to open a TLS socket, we run make_file_from_fd()
* on the socket, to do the necessary setup. At the moment the context's name
* is hardwired in the function, but we can certainly make it into an extra
* parameter to the function.
+ *
* We declare most of ssl support variables unconditionally,
* because their number is small and this simplifies the code.
*
- * \note: the ssl-support variables (ssl_ctx, do_ssl, certfile, cipher)
+ * \note The ssl-support variables (ssl_ctx, do_ssl, certfile, cipher)
* and their setup should be moved to a more central place, e.g. asterisk.conf
* and the source files that processes it. Similarly, ssl_setup() should
* be run earlier in the startup process so modules have it available.
@@ -113,33 +116,33 @@
* server_start() and server_root().
*/
-/*!
+/*! \brief
* describes a server instance
*/
struct server_instance {
FILE *f; /* fopen/funopen result */
int fd; /* the socket returned by accept() */
SSL *ssl; /* ssl state */
-// iint (*ssl_setup)(SSL *);
+/* iint (*ssl_setup)(SSL *); */
int client;
struct sockaddr_in requestor;
struct server_args *parent;
};
-/*!
+/*! \brief
* arguments for the accepting thread
*/
struct server_args {
struct sockaddr_in sin;
struct sockaddr_in oldsin;
- char hostname[MAXHOSTNAMELEN]; /* only necessary for SSL clients so we can compare to common name */
- struct ast_tls_config *tls_cfg; /* points to the SSL configuration if any */
+ char hostname[MAXHOSTNAMELEN]; /*!< only necessary for SSL clients so we can compare to common name */
+ struct ast_tls_config *tls_cfg; /*!< points to the SSL configuration if any */
int accept_fd;
int poll_timeout;
pthread_t master;
- void *(*accept_fn)(void *); /* the function in charge of doing the accept */
- void (*periodic_fn)(void *);/* something we may want to run before after select on the accept socket */
- void *(*worker_fn)(void *); /* the function in charge of doing the actual work */
+ void *(*accept_fn)(void *); /*!< the function in charge of doing the accept */
+ void (*periodic_fn)(void *);/*!< something we may want to run before after select on the accept socket */
+ void *(*worker_fn)(void *); /*!< the function in charge of doing the actual work */
const char *name;
};
Modified: trunk/main/abstract_jb.c
URL: http://svn.digium.com/view/asterisk/trunk/main/abstract_jb.c?view=diff&rev=99464&r1=99463&r2=99464
==============================================================================
--- trunk/main/abstract_jb.c (original)
+++ trunk/main/abstract_jb.c Tue Jan 22 02:58:46 2008
@@ -25,6 +25,8 @@
* \brief Common implementation-independent jitterbuffer stuff.
*
* \author Slav Klenov <slav at securax.org>
+ *
+ *
*/
#include "asterisk.h"
@@ -85,7 +87,7 @@
/* Implementation functions */
/* fixed */
-static void * jb_create_fixed(struct ast_jb_conf *general_config, long resynch_threshold);
+static void *jb_create_fixed(struct ast_jb_conf *general_config, long resynch_threshold);
static void jb_destroy_fixed(void *jb);
static int jb_put_first_fixed(void *jb, struct ast_frame *fin, long now);
static int jb_put_fixed(void *jb, struct ast_frame *fin, long now);
@@ -422,7 +424,7 @@
break;
case JB_IMPL_NOFRAME:
ast_log(LOG_WARNING,
- "JB_IMPL_NOFRAME is retuned from the %s jb when now=%ld >= next=%ld, jbnext=%ld!\n",
+ "JB_IMPL_NOFRAME is returned from the %s jb when now=%ld >= next=%ld, jbnext=%ld!\n",
jbimpl->name, now, jb->next, jbimpl->next(jbobj));
jb_framelog("\tJB_GET {now=%ld}: No frame for now!?\n", now);
return;
@@ -496,7 +498,7 @@
jb->logfile = fopen(logfile_pathname, "w+b");
if (!jb->logfile)
- ast_log(LOG_WARNING, "Failed to create frame log file with pathname '%s'\n", logfile_pathname);
+ ast_log(LOG_ERROR, "Failed to create frame log file with pathname '%s'\n", logfile_pathname);
if (res == JB_IMPL_OK)
jb_framelog("JB_PUT_FIRST {now=%ld}: Queued frame with ts=%ld and len=%ld\n",
Modified: trunk/main/tcptls.c
URL: http://svn.digium.com/view/asterisk/trunk/main/tcptls.c?view=diff&rev=99464&r1=99463&r2=99464
==============================================================================
--- trunk/main/tcptls.c (original)
+++ trunk/main/tcptls.c Tue Jan 22 02:58:46 2008
@@ -43,7 +43,7 @@
#include "asterisk/options.h"
#include "asterisk/manager.h"
-/*!
+/*! \brief
* replacement read/write functions for SSL support.
* We use wrappers rather than SSL_read/SSL_write directly so
* we can put in some debugging.
@@ -161,7 +161,7 @@
SSLeay_add_ssl_algorithms();
if (!(cfg->ssl_ctx = SSL_CTX_new( client ? SSLv23_client_method() : SSLv23_server_method() ))) {
- ast_log(LOG_DEBUG, "Sorry, SSL_CTX_new call returned null...\n");
+ ast_debug(1, "Sorry, SSL_CTX_new call returned null...\n");
cfg->enabled = 0;
return 0;
}
@@ -171,7 +171,7 @@
SSL_CTX_check_private_key(cfg->ssl_ctx) == 0 ) {
if (!client) {
/* Clients don't need a certificate, but if its setup we can use it */
- ast_verbose("ssl cert error <%s>", cfg->certfile);
+ ast_verbose("SSL cert error <%s>", cfg->certfile);
sleep(2);
cfg->enabled = 0;
return 0;
@@ -181,7 +181,7 @@
if (!ast_strlen_zero(cfg->cipher)) {
if (SSL_CTX_set_cipher_list(cfg->ssl_ctx, cfg->cipher) == 0 ) {
if (!client) {
- ast_verbose("ssl cipher error <%s>", cfg->cipher);
+ ast_verbose("SSL cipher error <%s>", cfg->cipher);
sleep(2);
cfg->enabled = 0;
return 0;
@@ -190,10 +190,10 @@
}
if (!ast_strlen_zero(cfg->cafile) || !ast_strlen_zero(cfg->capath)) {
if (SSL_CTX_load_verify_locations(cfg->ssl_ctx, S_OR(cfg->cafile, NULL), S_OR(cfg->capath,NULL)) == 0)
- ast_verbose("ssl CA file(%s)/path(%s) error\n", cfg->cafile, cfg->capath);
- }
-
- ast_verbose("ssl cert ok\n");
+ ast_verbose("SSL CA file(%s)/path(%s) error\n", cfg->cafile, cfg->capath);
+ }
+
+ ast_verbose("SSL certificate ok\n");
return 1;
#endif
}
@@ -203,7 +203,7 @@
return __ssl_setup(cfg, 0);
}
-/*! A generic client routine for a TCP client
+/*! \brief A generic client routine for a TCP client
* and starts a thread for handling accept()
*/
struct server_instance *client_start(struct server_args *desc)
@@ -213,8 +213,7 @@
/* Do nothing if nothing has changed */
if(!memcmp(&desc->oldsin, &desc->sin, sizeof(desc->oldsin))) {
- if (option_debug)
- ast_log(LOG_DEBUG, "Nothing changed in %s\n", desc->name);
+ ast_debug(1, "Nothing changed in %s\n", desc->name);
return NULL;
}
@@ -231,7 +230,7 @@
}
if (connect(desc->accept_fd, (const struct sockaddr *)&desc->sin, sizeof(desc->sin))) {
- ast_log(LOG_NOTICE, "Unable to connect %s to %s:%d: %s\n",
+ ast_log(LOG_ERROR, "Unable to connect %s to %s:%d: %s\n",
desc->name,
ast_inet_ntoa(desc->sin.sin_addr), ntohs(desc->sin.sin_port),
strerror(errno));
@@ -269,12 +268,11 @@
return NULL;
}
-/*!
+/*! \brief
* This is a generic (re)start routine for a TCP server,
* which does the socket/bind/listen and starts a thread for handling
* accept().
*/
-
void server_start(struct server_args *desc)
{
int flags;
@@ -282,8 +280,7 @@
/* Do nothing if nothing has changed */
if (!memcmp(&desc->oldsin, &desc->sin, sizeof(desc->oldsin))) {
- if (option_debug)
- ast_log(LOG_DEBUG, "Nothing changed in %s\n", desc->name);
+ ast_debug(1, "Nothing changed in %s\n", desc->name);
return;
}
@@ -305,27 +302,27 @@
desc->accept_fd = socket(AF_INET, SOCK_STREAM, 0);
if (desc->accept_fd < 0) {
- ast_log(LOG_WARNING, "Unable to allocate socket for %s: %s\n",
+ ast_log(LOG_ERROR, "Unable to allocate socket for %s: %s\n",
desc->name, strerror(errno));
return;
}
setsockopt(desc->accept_fd, SOL_SOCKET, SO_REUSEADDR, &x, sizeof(x));
if (bind(desc->accept_fd, (struct sockaddr *)&desc->sin, sizeof(desc->sin))) {
- ast_log(LOG_NOTICE, "Unable to bind %s to %s:%d: %s\n",
+ ast_log(LOG_ERROR, "Unable to bind %s to %s:%d: %s\n",
desc->name,
ast_inet_ntoa(desc->sin.sin_addr), ntohs(desc->sin.sin_port),
strerror(errno));
goto error;
}
if (listen(desc->accept_fd, 10)) {
- ast_log(LOG_NOTICE, "Unable to listen for %s!\n", desc->name);
+ ast_log(LOG_ERROR, "Unable to listen for %s!\n", desc->name);
goto error;
}
flags = fcntl(desc->accept_fd, F_GETFL);
fcntl(desc->accept_fd, F_SETFL, flags | O_NONBLOCK);
if (ast_pthread_create_background(&desc->master, NULL, desc->accept_fn, desc)) {
- ast_log(LOG_NOTICE, "Unable to launch %s on %s:%d: %s\n",
+ ast_log(LOG_ERROR, "Unable to launch thread for %s on %s:%d: %s\n",
desc->name,
ast_inet_ntoa(desc->sin.sin_addr), ntohs(desc->sin.sin_port),
strerror(errno));
@@ -338,9 +335,9 @@
desc->accept_fd = -1;
}
+/*! \brief Shutdown a running server if there is one */
void server_stop(struct server_args *desc)
{
- /* Shutdown a running server if there is one */
if (desc->master != AST_PTHREADT_NULL) {
pthread_cancel(desc->master);
pthread_kill(desc->master, SIGURG);
@@ -351,7 +348,7 @@
desc->accept_fd = -1;
}
-/*!
+/*! \brief
* creates a FILE * from the fd passed by the accept thread.
* This operation is potentially expensive (certificate verification),
* so we do it in the child thread context.
@@ -385,7 +382,7 @@
ser->f = fopencookie(ser->ssl, "w+", cookie_funcs);
#else
/* could add other methods here */
- ast_log(LOG_WARNING, "no ser->f methods attempted!");
+ ast_debug(2, "no ser->f methods attempted!");
#endif
if ((ser->client && !ast_test_flag(&ser->parent->tls_cfg->flags, AST_SSL_DONT_VERIFY_SERVER))
|| (!ser->client && ast_test_flag(&ser->parent->tls_cfg->flags, AST_SSL_VERIFY_CLIENT))) {
@@ -393,10 +390,10 @@
long res;
peer = SSL_get_peer_certificate(ser->ssl);
if (!peer)
- ast_log(LOG_WARNING, "No peer certificate\n");
+ ast_log(LOG_WARNING, "No peer SSL certificate\n");
res = SSL_get_verify_result(ser->ssl);
if (res != X509_V_OK)
- ast_log(LOG_WARNING, "Certificate did not verify: %s\n", X509_verify_cert_error_string(res));
+ ast_log(LOG_ERROR, "Certificate did not verify: %s\n", X509_verify_cert_error_string(res));
if (!ast_test_flag(&ser->parent->tls_cfg->flags, AST_SSL_IGNORE_COMMON_NAME)) {
ASN1_STRING *str;
unsigned char *str2;
@@ -415,14 +412,14 @@
if (str2) {
if (!strcasecmp(ser->parent->hostname, (char *) str2))
found = 1;
- ast_log(LOG_DEBUG, "SSL Common Name compare s1='%s' s2='%s'\n", ser->parent->hostname, str2);
+ ast_debug(3, "SSL Common Name compare s1='%s' s2='%s'\n", ser->parent->hostname, str2);
OPENSSL_free(str2);
}
if (found)
break;
}
if (!found) {
- ast_log(LOG_WARNING, "Certificate common name did not match (%s)\n", ser->parent->hostname);
+ ast_log(LOG_ERROR, "Certificate common name did not match (%s)\n", ser->parent->hostname);
if (peer)
X509_free(peer);
fclose(ser->f);
More information about the asterisk-commits
mailing list