Adding doxygen documentation

modules/tls/fixed_c_zlib.h

@@ -18,6 +18,13 @@
  *    version).
  *  -- andrei
  */
+/*!
+ * \file
+ * \brief SIP-router TLS support :: Zlib functions
+ * \ingroup tls
+ * Module: \ref tls
+ */
+
 
 
 #ifdef TLS_FIX_ZLIB_COMPRESSION

modules/tls/tls_config.c

@@ -29,6 +29,13 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
  */
+/*!
+ * \file
+ * \brief SIP-router TLS support :: Configuration file parser
+ * \ingroup tls
+ * Module: \ref tls
+ */
+
 
 #include "tls_config.h"
 #include "tls_domain.h"

modules/tls/tls_config.h

@@ -29,6 +29,13 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
  */
+/*!
+ * \file
+ * \brief SIP-router TLS support :: Configuration file parser
+ * \ingroup tls
+ * Module: \ref tls
+ */
+
 
 #ifndef _TLS_CONFIG_H
 #define _TLS_CONFIG_H

modules/tls/tls_domain.c

@@ -28,6 +28,13 @@
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+/*!
+ * \file
+ * \brief SIP-router TLS support :: Virtual domain configuration support
+ * \ingroup tls
+ * Module: \ref tls
+ */
+
 
 #include <stdlib.h>
 #include <openssl/ssl.h>

modules/tls/tls_domain.h

@@ -28,6 +28,13 @@
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+/*!
+ * \file
+ * \brief SIP-router TLS support :: virtual configuration domain support
+ * \ingroup tls
+ * Module: \ref tls
+ */
+
 
 #ifndef _TLS_DOMAIN_H
 #define _TLS_DOMAIN_H

modules/tls/tls_init.c

@@ -35,6 +35,24 @@
  *  2007-02-23  openssl low memory bugs workaround (andrei)
  */
 
+/*! \defgroup tls SIP-router TLS support
+ *
+ * This modules implements SIP over TCP with TLS encryption.
+ * Make sure you read the README file that describes configuration
+ * of TLS for single servers and servers hosting multiple domains,
+ * and thus using multiple SSL/TLS certificates.
+ *
+ *
+ */
+/*!
+ * \file
+ * \brief SIP-router TLS support :: Initialization
+ * \ingroup tls
+ * Module: \ref tls
+ */
+
+
+
 #include <stdio.h>
 #include <sys/types.h>
 #include <netinet/in_systm.h>

modules/tls/tls_init.h

@@ -28,6 +28,13 @@
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+/*!
+ * \file
+ * \brief SIP-router TLS support :: OpenSSL initialization funtions
+ * \ingroup tls
+ * Module: \ref tls
+ */
+
 
 #ifndef _TLS_INIT_H
 #define _TLS_INIT_H

modules/tls/tls_locking.c

@@ -22,6 +22,13 @@
  * --------
  *  2007-01-22  created by andrei
  */
+/*!
+ * \file
+ * \brief SIP-router TLS support :: Locking
+ * \ingroup tls
+ * Module: \ref tls
+ */
+
 
 #include <stdlib.h> /* abort() */
 #include <openssl/crypto.h>

modules/tls/tls_locking.h

@@ -22,6 +22,13 @@
  * --------
  *  2007-01-22  created by andrei
  */
+/*!
+ * \file
+ * \brief SIP-router TLS support ::  tls locking and atomic ops related init functions
+ * \ingroup tls
+ * Module: \ref tls
+ */
+
 
 #ifndef _tls_locking_h
 #define _tls_locking_h

modules/tls/tls_mod.c

@@ -39,6 +39,13 @@
  * 2007-02-09  updated to the new tls_hooks api and renamed tls hooks hanlder
  *              functions to avoid conflicts: s/tls_/tls_h_/   (andrei)
  */
+/*!
+ * \file
+ * \brief SIP-router TLS support :: Module interface
+ * \ingroup tls
+ * Module: \ref tls
+ */
+
 
 #include <sys/types.h>
 #include <sys/socket.h>

modules/tls/tls_mod.h

@@ -7,19 +7,19 @@
  * Copyright (C) 2004,2005 Free Software Foundation, Inc.
  * Copyright (C) 2005 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of sip-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * sip-router is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
+ * For a license to use the sip-router software under conditions
  * other than those described here, or to purchase support for this
  * software, please contact iptel.org by e-mail at the following addresses:
  *    [email protected]
  *
- * ser is distributed in the hope that it will be useful,
+ * sip-router 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.
@@ -28,10 +28,17 @@
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+/*!
+ * \file
+ * \brief SIP-router TLS support :: module interface
+ * \ingroup tls
+ * Module: \ref tls
+ */
+
 
 
 #ifndef _TLS_MOD_H
-#define _TLS_MOD_H
+#iefine _TLS_MOD_H
 
 #include "../../str.h"
 #include "../../locking.h"

modules/tls/tls_rpc.c

@@ -7,19 +7,19 @@
  * Copyright (C) 2004,2005 Free Software Foundation, Inc.
  * Copyright (C) 2005 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of sip-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * sip-router is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
+ * For a license to use the sip-router software under conditions
  * other than those described here, or to purchase support for this
  * software, please contact iptel.org by e-mail at the following addresses:
  *    [email protected]
  *
- * ser is distributed in the hope that it will be useful,
+ * sip-router 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.
@@ -28,6 +28,13 @@
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+/*!
+ * \file
+ * \brief SIP-router TLS support :: management interface
+ * \ingroup tls
+ * Module: \ref tls
+ */
+
 
 #include "../../rpc.h"
 #include "../../tcp_conn.h"

modules/tls/tls_rpc.h

@@ -7,19 +7,19 @@
  * Copyright (C) 2004,2005 Free Software Foundation, Inc.
  * Copyright (C) 2005 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of sip-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * sip-router is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
+ * For a license to use the sip-router software under conditions
  * other than those described here, or to purchase support for this
  * software, please contact iptel.org by e-mail at the following addresses:
  *    [email protected]
  *
- * ser is distributed in the hope that it will be useful,
+ * sip-router 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.
@@ -28,6 +28,13 @@
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+/*!
+ * \file
+ * \brief SIP-router TLS support :: Management interface
+ * \ingroup tls
+ * Module: \ref tls
+ */
+
 #ifndef _TLS_RPC_H
 #define _TLS_RPC_H
 

modules/tls/tls_select.c

@@ -8,19 +8,19 @@
  * Copyright (C) 2005 iptelorg GmbH
  * Copyright (C) 2006 enum.at
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of sip-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * sip-router is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
+ * For a license to use the sip-router software under conditions
  * other than those described here, or to purchase support for this
  * software, please contact iptel.org by e-mail at the following addresses:
  *    [email protected]
  *
- * ser is distributed in the hope that it will be useful,
+ * sip-router 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.
@@ -29,6 +29,13 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+/*!
+ * \file
+ * \brief SIP-router TLS support :: Select interface
+ * \ingroup tls
+ * Module: \ref tls
+ */
+
 
 #include <openssl/ssl.h>
 #include <openssl/x509v3.h>

modules/tls/tls_select.h

@@ -8,19 +8,19 @@
  * Copyright (C) 2005,2006 iptelorg GmbH
  * Copyright (C) 2006 enum.at
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of sip-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * sip-router is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
+ * For a license to use the sip-router software under conditions
  * other than those described here, or to purchase support for this
  * software, please contact iptel.org by e-mail at the following addresses:
  *    [email protected]
  *
- * ser is distributed in the hope that it will be useful,
+ * sip-router 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.
@@ -29,6 +29,13 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+/*!
+ * \file
+ * \brief SIP-router TLS support :: select interface
+ * \ingroup tls
+ * Module: \ref tls
+ */
+
 
 #ifndef _TLS_SELECT_H
 #define _TLS_SELECT_H

modules/tls/tls_server.c

@@ -36,6 +36,13 @@
  *  2009-09-21  tls connection state is now kept in c->extra_data (no
  *               longer shared with tcp state) (andrei)
  */
+/*!
+ * \file
+ * \brief SIP-router TLS support :: Main server part
+ * \ingroup tls
+ * Module: \ref tls
+ */
+
 
 #include <sys/poll.h>
 #include <openssl/err.h>

modules/tls/tls_server.h

@@ -7,19 +7,19 @@
  * Copyright (C) 2004,2005 Free Software Foundation, Inc.
  * Copyright (C) 2005,2006 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of sip-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * sip-router is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
+ * For a license to use the sip-router software under conditions
  * other than those described here, or to purchase support for this
  * software, please contact iptel.org by e-mail at the following addresses:
  *    [email protected]
  *
- * ser is distributed in the hope that it will be useful,
+ * sip-router 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.
@@ -28,6 +28,13 @@
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+/*!
+ * \file
+ * \brief SIP-router TLS support :: Main server part
+ * \ingroup tls
+ * Module: \ref tls
+ */
+
 
 #ifndef _TLS_SERVER_H
 #define _TLS_SERVER_H

modules/tls/tls_util.c

@@ -37,6 +37,13 @@
 #include "../../globals.h"
 #include "tls_mod.h"
 #include "tls_util.h"
+/*!
+ * \file
+ * \brief SIP-router TLS support :: Common functions
+ * \ingroup tls
+ * Module: \ref tls
+ */
+
 
 
 /*

modules/tls/tls_util.h

@@ -7,14 +7,14 @@
  * Copyright (C) 2004,2005 Free Software Foundation, Inc.
  * COpyright (C) 2005 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of sip-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * sip-router is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
+ * For a license to use the sip-router software under conditions
  * other than those described here, or to purchase support for this
  * software, please contact iptel.org by e-mail at the following addresses:
  *    [email protected]
@@ -28,6 +28,13 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+/*!
+ * \file
+ * \brief SIP-router TLS support :: Common functions
+ * \ingroup tls
+ * Module: \ref tls
+ */
+
 
 #ifndef _TLS_UTIL_H
 #define _TLS_UTIL_H

modules/tls/tls_verify.c

@@ -32,6 +32,14 @@
 #include "../../dprint.h"
 #include "tls_verify.h"
 
+/*!
+ * \file
+ * \brief SIP-router TLS support :: Certificate verification
+ * \ingroup tls
+ * Module: \ref tls
+ */
+
+
 /* FIXME: remove this and use the value in domains instead */
 #define VERIFY_DEPTH_S 3
 

modules/tls/tls_verify.h

@@ -7,19 +7,19 @@
  * Copyright (C) 2004,2005 Free Software Foundation, Inc.
  * COpyright (C) 2005 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of SIP-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * SIP-router is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
+ * For a license to use the SIP-router software under conditions
  * other than those described here, or to purchase support for this
  * software, please contact iptel.org by e-mail at the following addresses:
  *    [email protected]
  *
- * ser is distributed in the hope that it will be useful,
+ * SIP-router 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.
@@ -28,6 +28,13 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+/*!
+ * \file
+ * \brief SIP-router TLS support :: Certificate verification function
+ * \ingroup tls
+ * Module: \ref tls
+ */
+
 
 #ifndef _TLS_VERIFY_H
 #define _TLS_VERIFY_H

tls_hooks.c

@@ -23,6 +23,14 @@
  *  2007-02-09  created by andrei
  */
 
+/*!
+ * \file
+ * \brief SIP-router TLS support :: TLS hooks for modules
+ * \ingroup tls
+ * Module: \ref tls
+ */
+
+
 #include "tls_hooks.h"
 #include "tls_hooks_init.h"
 #include "globals.h"