Browse code

Adding doxygen documentation

oej authored on 10/10/2009 11:48:00
Showing 22 changed files
... ...
@@ -18,6 +18,13 @@
18 18
  *    version).
19 19
  *  -- andrei
20 20
  */
21
+/*!
22
+ * \file
23
+ * \brief SIP-router TLS support :: Zlib functions
24
+ * \ingroup tls
25
+ * Module: \ref tls
26
+ */
27
+
21 28
 
22 29
 
23 30
 #ifdef TLS_FIX_ZLIB_COMPRESSION
... ...
@@ -29,6 +29,13 @@
29 29
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30 30
  *
31 31
  */
32
+/*!
33
+ * \file
34
+ * \brief SIP-router TLS support :: Configuration file parser
35
+ * \ingroup tls
36
+ * Module: \ref tls
37
+ */
38
+
32 39
 
33 40
 #include "tls_config.h"
34 41
 #include "tls_domain.h"
... ...
@@ -29,6 +29,13 @@
29 29
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30 30
  *
31 31
  */
32
+/*!
33
+ * \file
34
+ * \brief SIP-router TLS support :: Configuration file parser
35
+ * \ingroup tls
36
+ * Module: \ref tls
37
+ */
38
+
32 39
 
33 40
 #ifndef _TLS_CONFIG_H
34 41
 #define _TLS_CONFIG_H
... ...
@@ -28,6 +28,13 @@
28 28
  * along with this program; if not, write to the Free Software 
29 29
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30 30
  */
31
+/*!
32
+ * \file
33
+ * \brief SIP-router TLS support :: Virtual domain configuration support
34
+ * \ingroup tls
35
+ * Module: \ref tls
36
+ */
37
+
31 38
 
32 39
 #include <stdlib.h>
33 40
 #include <openssl/ssl.h>
... ...
@@ -28,6 +28,13 @@
28 28
  * along with this program; if not, write to the Free Software 
29 29
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30 30
  */
31
+/*!
32
+ * \file
33
+ * \brief SIP-router TLS support :: virtual configuration domain support
34
+ * \ingroup tls
35
+ * Module: \ref tls
36
+ */
37
+
31 38
 
32 39
 #ifndef _TLS_DOMAIN_H
33 40
 #define _TLS_DOMAIN_H
... ...
@@ -35,6 +35,24 @@
35 35
  *  2007-02-23  openssl low memory bugs workaround (andrei)
36 36
  */
37 37
 
38
+/*! \defgroup tls SIP-router TLS support
39
+ *
40
+ * This modules implements SIP over TCP with TLS encryption.
41
+ * Make sure you read the README file that describes configuration
42
+ * of TLS for single servers and servers hosting multiple domains,
43
+ * and thus using multiple SSL/TLS certificates.
44
+ *
45
+ *
46
+ */
47
+/*!
48
+ * \file
49
+ * \brief SIP-router TLS support :: Initialization
50
+ * \ingroup tls
51
+ * Module: \ref tls
52
+ */
53
+
54
+
55
+
38 56
 #include <stdio.h>
39 57
 #include <sys/types.h>
40 58
 #include <netinet/in_systm.h>
... ...
@@ -28,6 +28,13 @@
28 28
  * along with this program; if not, write to the Free Software 
29 29
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30 30
  */
31
+/*!
32
+ * \file
33
+ * \brief SIP-router TLS support :: OpenSSL initialization funtions
34
+ * \ingroup tls
35
+ * Module: \ref tls
36
+ */
37
+
31 38
 
32 39
 #ifndef _TLS_INIT_H
33 40
 #define _TLS_INIT_H
... ...
@@ -22,6 +22,13 @@
22 22
  * --------
23 23
  *  2007-01-22  created by andrei
24 24
  */
25
+/*!
26
+ * \file
27
+ * \brief SIP-router TLS support :: Locking
28
+ * \ingroup tls
29
+ * Module: \ref tls
30
+ */
31
+
25 32
 
26 33
 #include <stdlib.h> /* abort() */
27 34
 #include <openssl/crypto.h>
... ...
@@ -22,6 +22,13 @@
22 22
  * --------
23 23
  *  2007-01-22  created by andrei
24 24
  */
25
+/*!
26
+ * \file
27
+ * \brief SIP-router TLS support ::  tls locking and atomic ops related init functions
28
+ * \ingroup tls
29
+ * Module: \ref tls
30
+ */
31
+
25 32
 
26 33
 #ifndef _tls_locking_h
27 34
 #define _tls_locking_h
... ...
@@ -39,6 +39,13 @@
39 39
  * 2007-02-09  updated to the new tls_hooks api and renamed tls hooks hanlder
40 40
  *              functions to avoid conflicts: s/tls_/tls_h_/   (andrei)
41 41
  */
42
+/*!
43
+ * \file
44
+ * \brief SIP-router TLS support :: Module interface
45
+ * \ingroup tls
46
+ * Module: \ref tls
47
+ */
48
+
42 49
 
43 50
 #include <sys/types.h>
44 51
 #include <sys/socket.h>
... ...
@@ -7,19 +7,19 @@
7 7
  * Copyright (C) 2004,2005 Free Software Foundation, Inc.
8 8
  * Copyright (C) 2005 iptelorg GmbH
9 9
  *
10
- * This file is part of ser, a free SIP server.
10
+ * This file is part of sip-router, a free SIP server.
11 11
  *
12
- * ser is free software; you can redistribute it and/or modify
12
+ * sip-router is free software; you can redistribute it and/or modify
13 13
  * it under the terms of the GNU General Public License as published by
14 14
  * the Free Software Foundation; either version 2 of the License, or
15 15
  * (at your option) any later version
16 16
  *
17
- * For a license to use the ser software under conditions
17
+ * For a license to use the sip-router software under conditions
18 18
  * other than those described here, or to purchase support for this
19 19
  * software, please contact iptel.org by e-mail at the following addresses:
20 20
  *    info@iptel.org
21 21
  *
22
- * ser is distributed in the hope that it will be useful,
22
+ * sip-router is distributed in the hope that it will be useful,
23 23
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 24
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25 25
  * GNU General Public License for more details.
... ...
@@ -28,10 +28,17 @@
28 28
  * along with this program; if not, write to the Free Software 
29 29
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30 30
  */
31
+/*!
32
+ * \file
33
+ * \brief SIP-router TLS support :: module interface
34
+ * \ingroup tls
35
+ * Module: \ref tls
36
+ */
37
+
31 38
 
32 39
 
33 40
 #ifndef _TLS_MOD_H
34
-#define _TLS_MOD_H
41
+#iefine _TLS_MOD_H
35 42
 
36 43
 #include "../../str.h"
37 44
 #include "../../locking.h"
... ...
@@ -7,19 +7,19 @@
7 7
  * Copyright (C) 2004,2005 Free Software Foundation, Inc.
8 8
  * Copyright (C) 2005 iptelorg GmbH
9 9
  *
10
- * This file is part of ser, a free SIP server.
10
+ * This file is part of sip-router, a free SIP server.
11 11
  *
12
- * ser is free software; you can redistribute it and/or modify
12
+ * sip-router is free software; you can redistribute it and/or modify
13 13
  * it under the terms of the GNU General Public License as published by
14 14
  * the Free Software Foundation; either version 2 of the License, or
15 15
  * (at your option) any later version
16 16
  *
17
- * For a license to use the ser software under conditions
17
+ * For a license to use the sip-router software under conditions
18 18
  * other than those described here, or to purchase support for this
19 19
  * software, please contact iptel.org by e-mail at the following addresses:
20 20
  *    info@iptel.org
21 21
  *
22
- * ser is distributed in the hope that it will be useful,
22
+ * sip-router is distributed in the hope that it will be useful,
23 23
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 24
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25 25
  * GNU General Public License for more details.
... ...
@@ -28,6 +28,13 @@
28 28
  * along with this program; if not, write to the Free Software 
29 29
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30 30
  */
31
+/*!
32
+ * \file
33
+ * \brief SIP-router TLS support :: management interface
34
+ * \ingroup tls
35
+ * Module: \ref tls
36
+ */
37
+
31 38
 
32 39
 #include "../../rpc.h"
33 40
 #include "../../tcp_conn.h"
... ...
@@ -7,19 +7,19 @@
7 7
  * Copyright (C) 2004,2005 Free Software Foundation, Inc.
8 8
  * Copyright (C) 2005 iptelorg GmbH
9 9
  *
10
- * This file is part of ser, a free SIP server.
10
+ * This file is part of sip-router, a free SIP server.
11 11
  *
12
- * ser is free software; you can redistribute it and/or modify
12
+ * sip-router is free software; you can redistribute it and/or modify
13 13
  * it under the terms of the GNU General Public License as published by
14 14
  * the Free Software Foundation; either version 2 of the License, or
15 15
  * (at your option) any later version
16 16
  *
17
- * For a license to use the ser software under conditions
17
+ * For a license to use the sip-router software under conditions
18 18
  * other than those described here, or to purchase support for this
19 19
  * software, please contact iptel.org by e-mail at the following addresses:
20 20
  *    info@iptel.org
21 21
  *
22
- * ser is distributed in the hope that it will be useful,
22
+ * sip-router is distributed in the hope that it will be useful,
23 23
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 24
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25 25
  * GNU General Public License for more details.
... ...
@@ -28,6 +28,13 @@
28 28
  * along with this program; if not, write to the Free Software 
29 29
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30 30
  */
31
+/*!
32
+ * \file
33
+ * \brief SIP-router TLS support :: Management interface
34
+ * \ingroup tls
35
+ * Module: \ref tls
36
+ */
37
+
31 38
 #ifndef _TLS_RPC_H
32 39
 #define _TLS_RPC_H
33 40
 
... ...
@@ -8,19 +8,19 @@
8 8
  * Copyright (C) 2005 iptelorg GmbH
9 9
  * Copyright (C) 2006 enum.at
10 10
  *
11
- * This file is part of ser, a free SIP server.
11
+ * This file is part of sip-router, a free SIP server.
12 12
  *
13
- * ser is free software; you can redistribute it and/or modify
13
+ * sip-router is free software; you can redistribute it and/or modify
14 14
  * it under the terms of the GNU General Public License as published by
15 15
  * the Free Software Foundation; either version 2 of the License, or
16 16
  * (at your option) any later version
17 17
  *
18
- * For a license to use the ser software under conditions
18
+ * For a license to use the sip-router software under conditions
19 19
  * other than those described here, or to purchase support for this
20 20
  * software, please contact iptel.org by e-mail at the following addresses:
21 21
  *    info@iptel.org
22 22
  *
23
- * ser is distributed in the hope that it will be useful,
23
+ * sip-router is distributed in the hope that it will be useful,
24 24
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 25
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
26 26
  * GNU General Public License for more details.
... ...
@@ -29,6 +29,13 @@
29 29
  * along with this program; if not, write to the Free Software
30 30
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
31 31
  */
32
+/*!
33
+ * \file
34
+ * \brief SIP-router TLS support :: Select interface
35
+ * \ingroup tls
36
+ * Module: \ref tls
37
+ */
38
+
32 39
 
33 40
 #include <openssl/ssl.h>
34 41
 #include <openssl/x509v3.h>
... ...
@@ -8,19 +8,19 @@
8 8
  * Copyright (C) 2005,2006 iptelorg GmbH
9 9
  * Copyright (C) 2006 enum.at
10 10
  *
11
- * This file is part of ser, a free SIP server.
11
+ * This file is part of sip-router, a free SIP server.
12 12
  *
13
- * ser is free software; you can redistribute it and/or modify
13
+ * sip-router is free software; you can redistribute it and/or modify
14 14
  * it under the terms of the GNU General Public License as published by
15 15
  * the Free Software Foundation; either version 2 of the License, or
16 16
  * (at your option) any later version
17 17
  *
18
- * For a license to use the ser software under conditions
18
+ * For a license to use the sip-router software under conditions
19 19
  * other than those described here, or to purchase support for this
20 20
  * software, please contact iptel.org by e-mail at the following addresses:
21 21
  *    info@iptel.org
22 22
  *
23
- * ser is distributed in the hope that it will be useful,
23
+ * sip-router is distributed in the hope that it will be useful,
24 24
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 25
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
26 26
  * GNU General Public License for more details.
... ...
@@ -29,6 +29,13 @@
29 29
  * along with this program; if not, write to the Free Software
30 30
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
31 31
  */
32
+/*!
33
+ * \file
34
+ * \brief SIP-router TLS support :: select interface
35
+ * \ingroup tls
36
+ * Module: \ref tls
37
+ */
38
+
32 39
 
33 40
 #ifndef _TLS_SELECT_H
34 41
 #define _TLS_SELECT_H
... ...
@@ -36,6 +36,13 @@
36 36
  *  2009-09-21  tls connection state is now kept in c->extra_data (no
37 37
  *               longer shared with tcp state) (andrei)
38 38
  */
39
+/*!
40
+ * \file
41
+ * \brief SIP-router TLS support :: Main server part
42
+ * \ingroup tls
43
+ * Module: \ref tls
44
+ */
45
+
39 46
 
40 47
 #include <sys/poll.h>
41 48
 #include <openssl/err.h>
... ...
@@ -7,19 +7,19 @@
7 7
  * Copyright (C) 2004,2005 Free Software Foundation, Inc.
8 8
  * Copyright (C) 2005,2006 iptelorg GmbH
9 9
  *
10
- * This file is part of ser, a free SIP server.
10
+ * This file is part of sip-router, a free SIP server.
11 11
  *
12
- * ser is free software; you can redistribute it and/or modify
12
+ * sip-router is free software; you can redistribute it and/or modify
13 13
  * it under the terms of the GNU General Public License as published by
14 14
  * the Free Software Foundation; either version 2 of the License, or
15 15
  * (at your option) any later version
16 16
  *
17
- * For a license to use the ser software under conditions
17
+ * For a license to use the sip-router software under conditions
18 18
  * other than those described here, or to purchase support for this
19 19
  * software, please contact iptel.org by e-mail at the following addresses:
20 20
  *    info@iptel.org
21 21
  *
22
- * ser is distributed in the hope that it will be useful,
22
+ * sip-router is distributed in the hope that it will be useful,
23 23
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 24
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25 25
  * GNU General Public License for more details.
... ...
@@ -28,6 +28,13 @@
28 28
  * along with this program; if not, write to the Free Software 
29 29
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30 30
  */
31
+/*!
32
+ * \file
33
+ * \brief SIP-router TLS support :: Main server part
34
+ * \ingroup tls
35
+ * Module: \ref tls
36
+ */
37
+
31 38
 
32 39
 #ifndef _TLS_SERVER_H
33 40
 #define _TLS_SERVER_H
... ...
@@ -37,6 +37,13 @@
37 37
 #include "../../globals.h"
38 38
 #include "tls_mod.h"
39 39
 #include "tls_util.h"
40
+/*!
41
+ * \file
42
+ * \brief SIP-router TLS support :: Common functions
43
+ * \ingroup tls
44
+ * Module: \ref tls
45
+ */
46
+
40 47
 
41 48
 
42 49
 /*
... ...
@@ -7,14 +7,14 @@
7 7
  * Copyright (C) 2004,2005 Free Software Foundation, Inc.
8 8
  * COpyright (C) 2005 iptelorg GmbH
9 9
  *
10
- * This file is part of ser, a free SIP server.
10
+ * This file is part of sip-router, a free SIP server.
11 11
  *
12
- * ser is free software; you can redistribute it and/or modify
12
+ * sip-router is free software; you can redistribute it and/or modify
13 13
  * it under the terms of the GNU General Public License as published by
14 14
  * the Free Software Foundation; either version 2 of the License, or
15 15
  * (at your option) any later version
16 16
  *
17
- * For a license to use the ser software under conditions
17
+ * For a license to use the sip-router software under conditions
18 18
  * other than those described here, or to purchase support for this
19 19
  * software, please contact iptel.org by e-mail at the following addresses:
20 20
  *    info@iptel.org
... ...
@@ -28,6 +28,13 @@
28 28
  * along with this program; if not, write to the Free Software
29 29
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30 30
  */
31
+/*!
32
+ * \file
33
+ * \brief SIP-router TLS support :: Common functions
34
+ * \ingroup tls
35
+ * Module: \ref tls
36
+ */
37
+
31 38
 
32 39
 #ifndef _TLS_UTIL_H
33 40
 #define _TLS_UTIL_H
... ...
@@ -32,6 +32,14 @@
32 32
 #include "../../dprint.h"
33 33
 #include "tls_verify.h"
34 34
 
35
+/*!
36
+ * \file
37
+ * \brief SIP-router TLS support :: Certificate verification
38
+ * \ingroup tls
39
+ * Module: \ref tls
40
+ */
41
+
42
+
35 43
 /* FIXME: remove this and use the value in domains instead */
36 44
 #define VERIFY_DEPTH_S 3
37 45
 
... ...
@@ -7,19 +7,19 @@
7 7
  * Copyright (C) 2004,2005 Free Software Foundation, Inc.
8 8
  * COpyright (C) 2005 iptelorg GmbH
9 9
  *
10
- * This file is part of ser, a free SIP server.
10
+ * This file is part of SIP-router, a free SIP server.
11 11
  *
12
- * ser is free software; you can redistribute it and/or modify
12
+ * SIP-router is free software; you can redistribute it and/or modify
13 13
  * it under the terms of the GNU General Public License as published by
14 14
  * the Free Software Foundation; either version 2 of the License, or
15 15
  * (at your option) any later version
16 16
  *
17
- * For a license to use the ser software under conditions
17
+ * For a license to use the SIP-router software under conditions
18 18
  * other than those described here, or to purchase support for this
19 19
  * software, please contact iptel.org by e-mail at the following addresses:
20 20
  *    info@iptel.org
21 21
  *
22
- * ser is distributed in the hope that it will be useful,
22
+ * SIP-router is distributed in the hope that it will be useful,
23 23
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 24
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25 25
  * GNU General Public License for more details.
... ...
@@ -28,6 +28,13 @@
28 28
  * along with this program; if not, write to the Free Software
29 29
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30 30
  */
31
+/*!
32
+ * \file
33
+ * \brief SIP-router TLS support :: Certificate verification function
34
+ * \ingroup tls
35
+ * Module: \ref tls
36
+ */
37
+
31 38
 
32 39
 #ifndef _TLS_VERIFY_H
33 40
 #define _TLS_VERIFY_H
... ...
@@ -23,6 +23,14 @@
23 23
  *  2007-02-09  created by andrei
24 24
  */
25 25
 
26
+/*!
27
+ * \file
28
+ * \brief SIP-router TLS support :: TLS hooks for modules
29
+ * \ingroup tls
30
+ * Module: \ref tls
31
+ */
32
+
33
+
26 34
 #include "tls_hooks.h"
27 35
 #include "tls_hooks_init.h"
28 36
 #include "globals.h"