Make externally visible some generic code useful to create
and implement services over tcp and/or tcp-tls. This commit is nothing more than moving structure definitions (and documentation) from main/http.c to include/asterisk/http.h (temporary location until we find a better place), and removing the 'static' qualifier from server_root() and server_start(). The name change (adding the ast_ prefix as a minimum, and then possibly a more meaningful name) is postponed to future commits. Does not apply to other versions of asterisk. git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@48324 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
parent
c39f887ac8
commit
6a147ed134
2 changed files with 99 additions and 66 deletions
|
@ -29,6 +29,102 @@
|
||||||
\author Mark Spencer <markster@digium.com>
|
\author Mark Spencer <markster@digium.com>
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* 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,
|
||||||
|
* 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)
|
||||||
|
* 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.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#if defined(HAVE_OPENSSL) && (defined(HAVE_FUNOPEN) || defined(HAVE_FOPENCOOKIE))
|
||||||
|
#define DO_SSL /* comment in/out if you want to support ssl */
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifdef DO_SSL
|
||||||
|
#include <openssl/ssl.h>
|
||||||
|
#include <openssl/err.h>
|
||||||
|
#else
|
||||||
|
typedef struct {} SSL; /* so we can define a pointer to it */
|
||||||
|
#endif /* DO_SSL */
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* The following code implements a generic mechanism for starting
|
||||||
|
* services on a TCP or TLS socket.
|
||||||
|
* The service is configured in the struct server_args, and
|
||||||
|
* then started by calling server_start(desc) on the descriptor.
|
||||||
|
* server_start() first verifies if an instance of the service is active,
|
||||||
|
* and in case shuts it down. Then, if the service must be started, creates
|
||||||
|
* a socket and a thread in charge of doing the accept().
|
||||||
|
*
|
||||||
|
* The body of the thread is desc->accept_fn(desc), which the user can define
|
||||||
|
* freely. We supply a sample implementation, server_root(), structured as an
|
||||||
|
* infinite loop. At the beginning of each iteration it runs periodic_fn()
|
||||||
|
* if defined (e.g. to perform some cleanup etc.) then issues a poll()
|
||||||
|
* or equivalent with a timeout of 'poll_timeout' milliseconds, and if the
|
||||||
|
* following accept() is successful it creates a thread in charge of
|
||||||
|
* running the session, whose body is desc->worker_fn(). The argument of
|
||||||
|
* worker_fn() is a struct server_instance, which contains the address
|
||||||
|
* of the other party, a pointer to desc, the file descriptors (fd) on which
|
||||||
|
* we can do a select/poll (but NOT IO/, and a FILE * on which we can do I/O.
|
||||||
|
* We have both because we want to support plain and SSL sockets, and
|
||||||
|
* going through a FILE * lets us provide the encryption/decryption
|
||||||
|
* on the stream without using an auxiliary thread.
|
||||||
|
*
|
||||||
|
* NOTE: in order to let other parts of asterisk use these services,
|
||||||
|
* we need to do the following:
|
||||||
|
* + move struct server_instance and struct server_args to
|
||||||
|
* a common header file, together with prototypes for
|
||||||
|
* server_start() and server_root().
|
||||||
|
* +
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* describes a server instance
|
||||||
|
*/
|
||||||
|
struct server_instance {
|
||||||
|
FILE *f; /* fopen/funopen result */
|
||||||
|
int fd; /* the socket returned by accept() */
|
||||||
|
SSL *ssl; /* ssl state */
|
||||||
|
struct sockaddr_in requestor;
|
||||||
|
struct server_args *parent;
|
||||||
|
};
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* arguments for the accepting thread
|
||||||
|
*/
|
||||||
|
struct server_args {
|
||||||
|
struct sockaddr_in sin;
|
||||||
|
struct sockaddr_in oldsin;
|
||||||
|
int is_ssl; /* is this an SSL accept ? */
|
||||||
|
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 */
|
||||||
|
const char *name;
|
||||||
|
};
|
||||||
|
|
||||||
|
void *server_root(void *);
|
||||||
|
void server_start(struct server_args *desc);
|
||||||
|
int ssl_setup(void);
|
||||||
|
|
||||||
/*! \brief HTTP Callbacks take the socket, the method and the path as arguments and should
|
/*! \brief HTTP Callbacks take the socket, the method and the path as arguments and should
|
||||||
return the content, allocated with malloc(). Status should be changed to reflect
|
return the content, allocated with malloc(). Status should be changed to reflect
|
||||||
the status of the request if it isn't 200 and title may be set to a malloc()'d string
|
the status of the request if it isn't 200 and title may be set to a malloc()'d string
|
||||||
|
|
69
main/http.c
69
main/http.c
|
@ -85,11 +85,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifdef DO_SSL
|
#ifdef DO_SSL
|
||||||
#include <openssl/ssl.h>
|
|
||||||
#include <openssl/err.h>
|
|
||||||
static SSL_CTX* ssl_ctx;
|
static SSL_CTX* ssl_ctx;
|
||||||
#else
|
|
||||||
typedef struct {} SSL; /* so we can define a pointer to it */
|
|
||||||
#endif /* DO_SSL */
|
#endif /* DO_SSL */
|
||||||
|
|
||||||
/* SSL support */
|
/* SSL support */
|
||||||
|
@ -98,65 +94,6 @@ static int do_ssl;
|
||||||
static char *certfile;
|
static char *certfile;
|
||||||
static char *cipher;
|
static char *cipher;
|
||||||
|
|
||||||
/*!
|
|
||||||
* The following code implements a generic mechanism for starting
|
|
||||||
* services on a TCP or TLS socket.
|
|
||||||
* The service is configured in the struct server_args, and
|
|
||||||
* then started by calling server_start(desc) on the descriptor.
|
|
||||||
* server_start() first verifies if an instance of the service is active,
|
|
||||||
* and in case shuts it down. Then, if the service must be started, creates
|
|
||||||
* a socket and a thread in charge of doing the accept().
|
|
||||||
*
|
|
||||||
* The body of the thread is desc->accept_fn(desc), which the user can define
|
|
||||||
* freely. We supply a sample implementation, server_root(), structured as an
|
|
||||||
* infinite loop. At the beginning of each iteration it runs periodic_fn()
|
|
||||||
* if defined (e.g. to perform some cleanup etc.) then issues a poll()
|
|
||||||
* or equivalent with a timeout of 'poll_timeout' milliseconds, and if the
|
|
||||||
* following accept() is successful it creates a thread in charge of
|
|
||||||
* running the session, whose body is desc->worker_fn(). The argument of
|
|
||||||
* worker_fn() is a struct server_instance, which contains the address
|
|
||||||
* of the other party, a pointer to desc, the file descriptors (fd) on which
|
|
||||||
* we can do a select/poll (but NOT IO/, and a FILE * on which we can do I/O.
|
|
||||||
* We have both because we want to support plain and SSL sockets, and
|
|
||||||
* going through a FILE * lets us provide the encryption/decryption
|
|
||||||
* on the stream without using an auxiliary thread.
|
|
||||||
*
|
|
||||||
* NOTE: in order to let other parts of asterisk use these services,
|
|
||||||
* we need to do the following:
|
|
||||||
* + move struct server_instance and struct server_args to
|
|
||||||
* a common header file, together with prototypes for
|
|
||||||
* server_start() and server_root().
|
|
||||||
* +
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*!
|
|
||||||
* describes a server instance
|
|
||||||
*/
|
|
||||||
struct server_instance {
|
|
||||||
FILE *f; /* fopen/funopen result */
|
|
||||||
int fd; /* the socket returned by accept() */
|
|
||||||
SSL *ssl; /* ssl state */
|
|
||||||
struct sockaddr_in requestor;
|
|
||||||
struct server_args *parent;
|
|
||||||
};
|
|
||||||
|
|
||||||
/*!
|
|
||||||
* arguments for the accepting thread
|
|
||||||
*/
|
|
||||||
struct server_args {
|
|
||||||
struct sockaddr_in sin;
|
|
||||||
struct sockaddr_in oldsin;
|
|
||||||
int is_ssl; /* is this an SSL accept ? */
|
|
||||||
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 */
|
|
||||||
const char *name;
|
|
||||||
};
|
|
||||||
|
|
||||||
static void *server_root(void *arg);
|
|
||||||
static void *httpd_helper_thread(void *arg);
|
static void *httpd_helper_thread(void *arg);
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
|
@ -705,7 +642,7 @@ done:
|
||||||
return NULL;
|
return NULL;
|
||||||
}
|
}
|
||||||
|
|
||||||
static void *server_root(void *data)
|
void *server_root(void *data)
|
||||||
{
|
{
|
||||||
struct server_args *desc = data;
|
struct server_args *desc = data;
|
||||||
int fd;
|
int fd;
|
||||||
|
@ -765,7 +702,7 @@ char *ast_http_setcookie(const char *var, const char *val, int expires, char *bu
|
||||||
return buf;
|
return buf;
|
||||||
}
|
}
|
||||||
|
|
||||||
static int ssl_setup(void)
|
int ssl_setup(void)
|
||||||
{
|
{
|
||||||
#ifndef DO_SSL
|
#ifndef DO_SSL
|
||||||
do_ssl = 0;
|
do_ssl = 0;
|
||||||
|
@ -804,7 +741,7 @@ static int ssl_setup(void)
|
||||||
* which does the socket/bind/listen and starts a thread for handling
|
* which does the socket/bind/listen and starts a thread for handling
|
||||||
* accept().
|
* accept().
|
||||||
*/
|
*/
|
||||||
static void server_start(struct server_args *desc)
|
void server_start(struct server_args *desc)
|
||||||
{
|
{
|
||||||
int flags;
|
int flags;
|
||||||
int x = 1;
|
int x = 1;
|
||||||
|
|
Loading…
Reference in a new issue