Browse code

modules: readme files regenerated - ims_ipsec_pcscf ... [skip ci]

Kamailio Dev authored on 01/06/2022 16:16:21
Showing 1 changed files
... ...
@@ -314,6 +314,8 @@ ipsec_create("location", "1");
314 314
           + 0x20 (32) - do not reset the destination URI.
315 315
           + 0x40 (64) - use user equipment client port as target for TCP
316 316
             requests.
317
+          + 0x80 (128) - set transport parameter in the new dst uri for
318
+            TCP requests.
317 319
        This is an optional parameter, default value - 0.
318 320
 
319 321
    Example 1.12. ipsec_forward
Browse code

modules: readme files regenerated - ims_ipsec_pcscf ... [skip ci]

Kamailio Dev authored on 01/06/2022 12:16:40
Showing 1 changed files
... ...
@@ -311,6 +311,9 @@ ipsec_create("location", "1");
311 311
           + 0x08 (8) - use new R-URI for IPSec tunnel search.
312 312
           + 0x10 (16) - do not look for alias parameter to set received
313 313
             details.
314
+          + 0x20 (32) - do not reset the destination URI.
315
+          + 0x40 (64) - use user equipment client port as target for TCP
316
+            requests.
314 317
        This is an optional parameter, default value - 0.
315 318
 
316 319
    Example 1.12. ipsec_forward
Browse code

modules: readme files regenerated - ims_ipsec_pcscf ... [skip ci]

Kamailio Dev authored on 31/05/2022 08:16:16
Showing 1 changed files
... ...
@@ -302,13 +302,15 @@ ipsec_create("location", "1");
302 302
      * domain - Logical domain within the registrar. If a database is used
303 303
        then this must be name of the table which stores the contacts.
304 304
        flags - bitwise flag:
305
-          + 0x01 - set force socket for request messages. Useful for ipsec
306
-            and TCP.
307
-          + 0x02 - reverse search for a contact in the memory. Useful when
308
-            contact alias is disabled.
309
-          + 0x04 - use destination URI for IPSec tunnel search. Useful for
310
-            routing requests within dialog.
311
-          + 0x08 - use new R-URI for IPSec tunnel search.
305
+          + 0x01 (1) - set force socket for request messages. Useful for
306
+            ipsec and TCP.
307
+          + 0x02 (2) - reverse search for a contact in the memory. Useful
308
+            when contact alias is disabled.
309
+          + 0x04 (4) - use destination URI for IPSec tunnel search. Useful
310
+            for routing requests within dialog.
311
+          + 0x08 (8) - use new R-URI for IPSec tunnel search.
312
+          + 0x10 (16) - do not look for alias parameter to set received
313
+            details.
312 314
        This is an optional parameter, default value - 0.
313 315
 
314 316
    Example 1.12. ipsec_forward
Browse code

modules: readme files regenerated - ims_ipsec_pcscf ... [skip ci]

Kamailio Dev authored on 31/05/2022 06:46:20
Showing 1 changed files
... ...
@@ -308,6 +308,7 @@ ipsec_create("location", "1");
308 308
             contact alias is disabled.
309 309
           + 0x04 - use destination URI for IPSec tunnel search. Useful for
310 310
             routing requests within dialog.
311
+          + 0x08 - use new R-URI for IPSec tunnel search.
311 312
        This is an optional parameter, default value - 0.
312 313
 
313 314
    Example 1.12. ipsec_forward
Browse code

modules: readme files regenerated - ims_ipsec_pcscf ... [skip ci]

Kamailio Dev authored on 30/05/2022 13:31:17
Showing 1 changed files
... ...
@@ -301,10 +301,14 @@ ipsec_create("location", "1");
301 301
    Meaning of the parameters is as follows:
302 302
      * domain - Logical domain within the registrar. If a database is used
303 303
        then this must be name of the table which stores the contacts.
304
-       flags - bitwise flag: 0x01 - set force socket for request messages.
305
-       Useful for ipsec and TCP. 0x02 - reverse search for a contact in
306
-       the memory. Useful when contact alias is disabled. This is an
307
-       optional parameter, default value - 0.
304
+       flags - bitwise flag:
305
+          + 0x01 - set force socket for request messages. Useful for ipsec
306
+            and TCP.
307
+          + 0x02 - reverse search for a contact in the memory. Useful when
308
+            contact alias is disabled.
309
+          + 0x04 - use destination URI for IPSec tunnel search. Useful for
310
+            routing requests within dialog.
311
+       This is an optional parameter, default value - 0.
308 312
 
309 313
    Example 1.12. ipsec_forward
310 314
 ...
Browse code

modules: readme files regenerated - ims_ipsec_pcscf ... [skip ci]

Kamailio Dev authored on 24/05/2022 08:46:28
Showing 1 changed files
... ...
@@ -51,6 +51,8 @@ Tsvetomir Dimitrov
51 51
               3.6. ipsec_reuse_server_port (int)
52 52
               3.7. ipsec_spi_id_start (int)
53 53
               3.8. ipsec_spi_id_range (int)
54
+              3.9. ipsec_preferred_alg (string)
55
+              3.10. ipsec_preferred_ealg (string)
54 56
 
55 57
         4. Functions
56 58
 
... ...
@@ -68,9 +70,11 @@ Tsvetomir Dimitrov
68 70
    1.6. ipsec_reuse_server_port parameter usage
69 71
    1.7. ipsec_spi_id_start parameter usage
70 72
    1.8. ipsec_spi_id_range parameter usage
71
-   1.9. ipsec_create
72
-   1.10. ipsec_forward
73
-   1.11. ipsec_destroy
73
+   1.9. ipsec_preferred_alg parameter usage
74
+   1.10. ipsec_preferred_ealg parameter usage
75
+   1.11. ipsec_create
76
+   1.12. ipsec_forward
77
+   1.13. ipsec_destroy
74 78
 
75 79
 Chapter 1. Admin Guide
76 80
 
... ...
@@ -92,6 +96,8 @@ Chapter 1. Admin Guide
92 96
         3.6. ipsec_reuse_server_port (int)
93 97
         3.7. ipsec_spi_id_start (int)
94 98
         3.8. ipsec_spi_id_range (int)
99
+        3.9. ipsec_preferred_alg (string)
100
+        3.10. ipsec_preferred_ealg (string)
95 101
 
96 102
    4. Functions
97 103
 
... ...
@@ -130,6 +136,8 @@ Chapter 1. Admin Guide
130 136
    3.6. ipsec_reuse_server_port (int)
131 137
    3.7. ipsec_spi_id_start (int)
132 138
    3.8. ipsec_spi_id_range (int)
139
+   3.9. ipsec_preferred_alg (string)
140
+   3.10. ipsec_preferred_ealg (string)
133 141
 
134 142
 3.1. ipsec_listen_addr (string)
135 143
 
... ...
@@ -159,8 +167,7 @@ modparam("ims_ipsec_pcscf", "ipsec_listen_addr6", "")
159 167
 
160 168
 3.3. ipsec_client_port (int)
161 169
 
162
-   Start port number which will be bound for incoming (server) IPSec
163
-   traffic.
170
+   Port number which will be bound for incoming (server) IPSec traffic.
164 171
 
165 172
    Default value is 5062.
166 173
 
... ...
@@ -171,8 +178,7 @@ modparam("ims_ipsec_pcscf", "ipsec_client_port", 5062)
171 178
 
172 179
 3.4. ipsec_server_port (int)
173 180
 
174
-   Start port number which will be bound for incoming (server) IPSec
175
-   traffic.
181
+   Port number which will be bound for incoming (server) IPSec traffic.
176 182
 
177 183
    Default value is 5063.
178 184
 
... ...
@@ -183,11 +189,7 @@ modparam("ims_ipsec_pcscf", "ipsec_server_port", 5063)
183 189
 
184 190
 3.5. ipsec_max_connections (int)
185 191
 
186
-   Maximum IPSec connections for the process. E.g. if
187
-   ipsec_client_port=5100, ipsec_server_port=6100 and
188
-   ipsec_max_connections=10, all client ports between 5100 and 5109 and
189
-   all server ports between 6100 and 6109 will be used for maximum to 10
190
-   IPSec connections.
192
+   Maximum simultanious IPSec connections
191 193
 
192 194
    Default value is 2.
193 195
 
... ...
@@ -198,11 +200,10 @@ modparam("ims_ipsec_pcscf", "ipsec_max_connections", 10)
198 200
 
199 201
 3.6. ipsec_reuse_server_port (int)
200 202
 
201
-   Reuse (1) or not (0) the P-CSCF Server port for Re-registration for one
202
-   UA. When set to 0 - During Re-registration P-CSCF will distribute new
203
-   P-CSCF client and P-CSCF server ports. When set to 1 - During
204
-   Re-registration P-CSCF will reuse the old P-CSCF server port and will
205
-   distribute a new P-CSCF client port.
203
+   Reuse (1) or not (0) the P-CSCF IPSec information for Re-registration
204
+   for one UA. When set to 0 - During Re-registration P-CSCF will create
205
+   new IPSec tunnels. When set to 1 - During Re-registration P-CSCF will
206
+   reuse the old IPSec tunnels.
206 207
 
207 208
    Default value is 1.
208 209
 
... ...
@@ -238,6 +239,33 @@ modparam("ims_ipsec_pcscf", "ipsec_spi_id_start", 100)
238 239
 modparam("ims_ipsec_pcscf", "ipsec_spi_id_range", 1000)
239 240
 ...
240 241
 
242
+3.9. ipsec_preferred_alg (string)
243
+
244
+   A name of an authentication algorithm which the Proxy-CSCF will prefer
245
+   when creating IPSec tunnels.
246
+
247
+   Default value is empty string (null) - the last algorithm in the
248
+   Sec-Agree header will be used.
249
+
250
+   Example 1.9. ipsec_preferred_alg parameter usage
251
+...
252
+modparam("ims_ipsec_pcscf", "ipsec_preferred_alg", "hmac-sha-1-96")
253
+...
254
+
255
+3.10. ipsec_preferred_ealg (string)
256
+
257
+   A name of an encrytion algorithm which the Proxy-CSCF will prefer when
258
+   creating IPSec tunnels.
259
+
260
+   Default value is empty string (null) - the last algorithm in the
261
+   Sec-Agree header will be used. Note that the possibility of it being
262
+   the "null" algorithm is not insignificant.
263
+
264
+   Example 1.10. ipsec_preferred_ealg parameter usage
265
+...
266
+modparam("ims_ipsec_pcscf", "ipsec_preferred_ealg", "aes-cbc")
267
+...
268
+
241 269
 4. Functions
242 270
 
243 271
    4.1. ipsec_create(domain)
... ...
@@ -258,7 +286,7 @@ modparam("ims_ipsec_pcscf", "ipsec_spi_id_range", 1000)
258 286
        every registration. This is an optional parameter, default value -
259 287
        0.
260 288
 
261
-   Example 1.9. ipsec_create
289
+   Example 1.11. ipsec_create
262 290
 ...
263 291
 ipsec_create("location");
264 292
 # or
... ...
@@ -278,7 +306,7 @@ ipsec_create("location", "1");
278 306
        the memory. Useful when contact alias is disabled. This is an
279 307
        optional parameter, default value - 0.
280 308
 
281
-   Example 1.10. ipsec_forward
309
+   Example 1.12. ipsec_forward
282 310
 ...
283 311
 ipsec_forward("location");
284 312
 # or
... ...
@@ -293,7 +321,7 @@ ipsec_forward("location", "1");
293 321
      * domain - Logical domain within the registrar. If a database is used
294 322
        then this must be name of the table which stores the contacts.
295 323
 
296
-   Example 1.11. ipsec_destroy
324
+   Example 1.13. ipsec_destroy
297 325
 ...
298 326
 ipsec_destroy("location");
299 327
 ...
Browse code

modules: readme files regenerated - ims_ipsec_pcscf ... [skip ci]

Kamailio Dev authored on 20/08/2020 10:01:15
Showing 1 changed files
... ...
@@ -254,10 +254,15 @@ modparam("ims_ipsec_pcscf", "ipsec_spi_id_range", 1000)
254 254
    Meaning of the parameters is as follows:
255 255
      * domain - Logical domain within the registrar. If a database is used
256 256
        then this must be name of the table which stores the contacts.
257
+       flags - bitwise flag: 0x01 - if set - delete unused tunnels before
258
+       every registration. This is an optional parameter, default value -
259
+       0.
257 260
 
258 261
    Example 1.9. ipsec_create
259 262
 ...
260 263
 ipsec_create("location");
264
+# or
265
+ipsec_create("location", "1");
261 266
 ...
262 267
 
263 268
 4.2. ipsec_forward(domain, flags)
Browse code

modules: readme files regenerated - ims_ipsec_pcscf ... [skip ci]

Kamailio Dev authored on 12/08/2020 18:46:12
Showing 1 changed files
... ...
@@ -268,9 +268,10 @@ ipsec_create("location");
268 268
    Meaning of the parameters is as follows:
269 269
      * domain - Logical domain within the registrar. If a database is used
270 270
        then this must be name of the table which stores the contacts.
271
-       flags - Set send force socket for request messages. If 1 - set
272
-       force socket for request messages. Useful for ipsec and TCP. This
273
-       is an optional parameter, default value - 0.
271
+       flags - bitwise flag: 0x01 - set force socket for request messages.
272
+       Useful for ipsec and TCP. 0x02 - reverse search for a contact in
273
+       the memory. Useful when contact alias is disabled. This is an
274
+       optional parameter, default value - 0.
274 275
 
275 276
    Example 1.10. ipsec_forward
276 277
 ...
Browse code

modules: readme files regenerated - ims_ipsec_pcscf ... [skip ci]

Kamailio Dev authored on 13/01/2020 20:16:19
Showing 1 changed files
... ...
@@ -48,8 +48,9 @@ Tsvetomir Dimitrov
48 48
               3.3. ipsec_client_port (int)
49 49
               3.4. ipsec_server_port (int)
50 50
               3.5. ipsec_max_connections (int)
51
-              3.6. ipsec_spi_id_start (int)
52
-              3.7. ipsec_spi_id_range (int)
51
+              3.6. ipsec_reuse_server_port (int)
52
+              3.7. ipsec_spi_id_start (int)
53
+              3.8. ipsec_spi_id_range (int)
53 54
 
54 55
         4. Functions
55 56
 
... ...
@@ -64,11 +65,12 @@ Tsvetomir Dimitrov
64 65
    1.3. ipsec_client_port parameter usage
65 66
    1.4. ipsec_server_port parameter usage
66 67
    1.5. ipsec_max_connections parameter usage
67
-   1.6. ipsec_spi_id_start parameter usage
68
-   1.7. ipsec_spi_id_range parameter usage
69
-   1.8. ipsec_create
70
-   1.9. ipsec_forward
71
-   1.10. ipsec_destroy
68
+   1.6. ipsec_reuse_server_port parameter usage
69
+   1.7. ipsec_spi_id_start parameter usage
70
+   1.8. ipsec_spi_id_range parameter usage
71
+   1.9. ipsec_create
72
+   1.10. ipsec_forward
73
+   1.11. ipsec_destroy
72 74
 
73 75
 Chapter 1. Admin Guide
74 76
 
... ...
@@ -87,8 +89,9 @@ Chapter 1. Admin Guide
87 89
         3.3. ipsec_client_port (int)
88 90
         3.4. ipsec_server_port (int)
89 91
         3.5. ipsec_max_connections (int)
90
-        3.6. ipsec_spi_id_start (int)
91
-        3.7. ipsec_spi_id_range (int)
92
+        3.6. ipsec_reuse_server_port (int)
93
+        3.7. ipsec_spi_id_start (int)
94
+        3.8. ipsec_spi_id_range (int)
92 95
 
93 96
    4. Functions
94 97
 
... ...
@@ -124,8 +127,9 @@ Chapter 1. Admin Guide
124 127
    3.3. ipsec_client_port (int)
125 128
    3.4. ipsec_server_port (int)
126 129
    3.5. ipsec_max_connections (int)
127
-   3.6. ipsec_spi_id_start (int)
128
-   3.7. ipsec_spi_id_range (int)
130
+   3.6. ipsec_reuse_server_port (int)
131
+   3.7. ipsec_spi_id_start (int)
132
+   3.8. ipsec_spi_id_range (int)
129 133
 
130 134
 3.1. ipsec_listen_addr (string)
131 135
 
... ...
@@ -192,7 +196,22 @@ modparam("ims_ipsec_pcscf", "ipsec_server_port", 5063)
192 196
 modparam("ims_ipsec_pcscf", "ipsec_max_connections", 10)
193 197
 ...
194 198
 
195
-3.6. ipsec_spi_id_start (int)
199
+3.6. ipsec_reuse_server_port (int)
200
+
201
+   Reuse (1) or not (0) the P-CSCF Server port for Re-registration for one
202
+   UA. When set to 0 - During Re-registration P-CSCF will distribute new
203
+   P-CSCF client and P-CSCF server ports. When set to 1 - During
204
+   Re-registration P-CSCF will reuse the old P-CSCF server port and will
205
+   distribute a new P-CSCF client port.
206
+
207
+   Default value is 1.
208
+
209
+   Example 1.6. ipsec_reuse_server_port parameter usage
210
+...
211
+modparam("ims_ipsec_pcscf", "ipsec_reuse_server_port", 1)
212
+...
213
+
214
+3.7. ipsec_spi_id_start (int)
196 215
 
197 216
    Each IPSec tunnel has a unique system-wide identifier. This and the
198 217
    following option allows to tune the SPIs used by Kamailio in order to
... ...
@@ -201,12 +220,12 @@ modparam("ims_ipsec_pcscf", "ipsec_max_connections", 10)
201 220
 
202 221
    Default value is 100.
203 222
 
204
-   Example 1.6. ipsec_spi_id_start parameter usage
223
+   Example 1.7. ipsec_spi_id_start parameter usage
205 224
 ...
206 225
 modparam("ims_ipsec_pcscf", "ipsec_spi_id_start", 100)
207 226
 ...
208 227
 
209
-3.7. ipsec_spi_id_range (int)
228
+3.8. ipsec_spi_id_range (int)
210 229
 
211 230
    How many SPIs to be allocated for the process. E.g. if
212 231
    ipsec_spi_id_start = 100 and ipsec_spi_id_range = 1000, SPIs between
... ...
@@ -214,7 +233,7 @@ modparam("ims_ipsec_pcscf", "ipsec_spi_id_start", 100)
214 233
 
215 234
    Default value is 1000.
216 235
 
217
-   Example 1.7. ipsec_spi_id_range parameter usage
236
+   Example 1.8. ipsec_spi_id_range parameter usage
218 237
 ...
219 238
 modparam("ims_ipsec_pcscf", "ipsec_spi_id_range", 1000)
220 239
 ...
... ...
@@ -236,7 +255,7 @@ modparam("ims_ipsec_pcscf", "ipsec_spi_id_range", 1000)
236 255
      * domain - Logical domain within the registrar. If a database is used
237 256
        then this must be name of the table which stores the contacts.
238 257
 
239
-   Example 1.8. ipsec_create
258
+   Example 1.9. ipsec_create
240 259
 ...
241 260
 ipsec_create("location");
242 261
 ...
... ...
@@ -253,7 +272,7 @@ ipsec_create("location");
253 272
        force socket for request messages. Useful for ipsec and TCP. This
254 273
        is an optional parameter, default value - 0.
255 274
 
256
-   Example 1.9. ipsec_forward
275
+   Example 1.10. ipsec_forward
257 276
 ...
258 277
 ipsec_forward("location");
259 278
 # or
... ...
@@ -268,7 +287,7 @@ ipsec_forward("location", "1");
268 287
      * domain - Logical domain within the registrar. If a database is used
269 288
        then this must be name of the table which stores the contacts.
270 289
 
271
-   Example 1.10. ipsec_destroy
290
+   Example 1.11. ipsec_destroy
272 291
 ...
273 292
 ipsec_destroy("location");
274 293
 ...
Browse code

modules: readme files regenerated - ims_ipsec_pcscf ... [skip ci]

Kamailio Dev authored on 19/12/2019 10:01:22
Showing 1 changed files
... ...
@@ -54,7 +54,7 @@ Tsvetomir Dimitrov
54 54
         4. Functions
55 55
 
56 56
               4.1. ipsec_create(domain)
57
-              4.2. ipsec_forward(domain)
57
+              4.2. ipsec_forward(domain, flags)
58 58
               4.3. ipsec_destroy(domain)
59 59
 
60 60
    List of Examples
... ...
@@ -93,7 +93,7 @@ Chapter 1. Admin Guide
93 93
    4. Functions
94 94
 
95 95
         4.1. ipsec_create(domain)
96
-        4.2. ipsec_forward(domain)
96
+        4.2. ipsec_forward(domain, flags)
97 97
         4.3. ipsec_destroy(domain)
98 98
 
99 99
 1. Overview
... ...
@@ -222,7 +222,7 @@ modparam("ims_ipsec_pcscf", "ipsec_spi_id_range", 1000)
222 222
 4. Functions
223 223
 
224 224
    4.1. ipsec_create(domain)
225
-   4.2. ipsec_forward(domain)
225
+   4.2. ipsec_forward(domain, flags)
226 226
    4.3. ipsec_destroy(domain)
227 227
 
228 228
 4.1. ipsec_create(domain)
... ...
@@ -241,7 +241,7 @@ modparam("ims_ipsec_pcscf", "ipsec_spi_id_range", 1000)
241 241
 ipsec_create("location");
242 242
 ...
243 243
 
244
-4.2. ipsec_forward(domain)
244
+4.2. ipsec_forward(domain, flags)
245 245
 
246 246
    The function processes redirects outgoing message via the IPSec tunnel
247 247
    initiated with ipsec_create().
... ...
@@ -249,10 +249,15 @@ ipsec_create("location");
249 249
    Meaning of the parameters is as follows:
250 250
      * domain - Logical domain within the registrar. If a database is used
251 251
        then this must be name of the table which stores the contacts.
252
+       flags - Set send force socket for request messages. If 1 - set
253
+       force socket for request messages. Useful for ipsec and TCP. This
254
+       is an optional parameter, default value - 0.
252 255
 
253 256
    Example 1.9. ipsec_forward
254 257
 ...
255 258
 ipsec_forward("location");
259
+# or
260
+ipsec_forward("location", "1");
256 261
 ...
257 262
 
258 263
 4.3. ipsec_destroy(domain)
Browse code

modules: readme files regenerated - acc ... [skip ci]

Kamailio Dev authored on 16/07/2019 09:23:08
Showing 1 changed files
... ...
@@ -24,11 +24,11 @@ Tsvetomir Dimitrov
24 24
 
25 25
    <tsv.dimitrov@gmail.com>
26 26
 
27
-   Copyright � 2007 FhG FOKUS
27
+   Copyright © 2007 FhG FOKUS
28 28
 
29
-   Copyright � 2012 Smile Communications
29
+   Copyright © 2012 Smile Communications
30 30
 
31
-   Copyright � 2015 ng-voice GmbH
31
+   Copyright © 2015 ng-voice GmbH
32 32
      __________________________________________________________________
33 33
 
34 34
    Table of Contents
... ...
@@ -47,8 +47,9 @@ Tsvetomir Dimitrov
47 47
               3.2. ipsec_listen_addr6 (string)
48 48
               3.3. ipsec_client_port (int)
49 49
               3.4. ipsec_server_port (int)
50
-              3.5. ipsec_spi_id_start (int)
51
-              3.6. ipsec_spi_id_range (int)
50
+              3.5. ipsec_max_connections (int)
51
+              3.6. ipsec_spi_id_start (int)
52
+              3.7. ipsec_spi_id_range (int)
52 53
 
53 54
         4. Functions
54 55
 
... ...
@@ -62,11 +63,12 @@ Tsvetomir Dimitrov
62 63
    1.2. ipsec_listen_addr6 parameter usage
63 64
    1.3. ipsec_client_port parameter usage
64 65
    1.4. ipsec_server_port parameter usage
65
-   1.5. ipsec_spi_id_start parameter usage
66
-   1.6. ipsec_spi_id_range parameter usage
67
-   1.7. ipsec_create
68
-   1.8. ipsec_forward
66
+   1.5. ipsec_max_connections parameter usage
67
+   1.6. ipsec_spi_id_start parameter usage
68
+   1.7. ipsec_spi_id_range parameter usage
69
+   1.8. ipsec_create
69 70
    1.9. ipsec_forward
71
+   1.10. ipsec_destroy
70 72
 
71 73
 Chapter 1. Admin Guide
72 74
 
... ...
@@ -84,8 +86,9 @@ Chapter 1. Admin Guide
84 86
         3.2. ipsec_listen_addr6 (string)
85 87
         3.3. ipsec_client_port (int)
86 88
         3.4. ipsec_server_port (int)
87
-        3.5. ipsec_spi_id_start (int)
88
-        3.6. ipsec_spi_id_range (int)
89
+        3.5. ipsec_max_connections (int)
90
+        3.6. ipsec_spi_id_start (int)
91
+        3.7. ipsec_spi_id_range (int)
89 92
 
90 93
    4. Functions
91 94
 
... ...
@@ -120,8 +123,9 @@ Chapter 1. Admin Guide
120 123
    3.2. ipsec_listen_addr6 (string)
121 124
    3.3. ipsec_client_port (int)
122 125
    3.4. ipsec_server_port (int)
123
-   3.5. ipsec_spi_id_start (int)
124
-   3.6. ipsec_spi_id_range (int)
126
+   3.5. ipsec_max_connections (int)
127
+   3.6. ipsec_spi_id_start (int)
128
+   3.7. ipsec_spi_id_range (int)
125 129
 
126 130
 3.1. ipsec_listen_addr (string)
127 131
 
... ...
@@ -151,9 +155,10 @@ modparam("ims_ipsec_pcscf", "ipsec_listen_addr6", "")
151 155
 
152 156
 3.3. ipsec_client_port (int)
153 157
 
154
-   Port number which will be bound for incoming (server) IPSec traffic.
158
+   Start port number which will be bound for incoming (server) IPSec
159
+   traffic.
155 160
 
156
-   Default value is 5963.
161
+   Default value is 5062.
157 162
 
158 163
    Example 1.3. ipsec_client_port parameter usage
159 164
 ...
... ...
@@ -162,7 +167,8 @@ modparam("ims_ipsec_pcscf", "ipsec_client_port", 5062)
162 167
 
163 168
 3.4. ipsec_server_port (int)
164 169
 
165
-   Port number which will be bound for incoming (server) IPSec traffic.
170
+   Start port number which will be bound for incoming (server) IPSec
171
+   traffic.
166 172
 
167 173
    Default value is 5063.
168 174
 
... ...
@@ -171,7 +177,22 @@ modparam("ims_ipsec_pcscf", "ipsec_client_port", 5062)
171 177
 modparam("ims_ipsec_pcscf", "ipsec_server_port", 5063)
172 178
 ...
173 179
 
174
-3.5. ipsec_spi_id_start (int)
180
+3.5. ipsec_max_connections (int)
181
+
182
+   Maximum IPSec connections for the process. E.g. if
183
+   ipsec_client_port=5100, ipsec_server_port=6100 and
184
+   ipsec_max_connections=10, all client ports between 5100 and 5109 and
185
+   all server ports between 6100 and 6109 will be used for maximum to 10
186
+   IPSec connections.
187
+
188
+   Default value is 2.
189
+
190
+   Example 1.5. ipsec_max_connections parameter usage
191
+...
192
+modparam("ims_ipsec_pcscf", "ipsec_max_connections", 10)
193
+...
194
+
195
+3.6. ipsec_spi_id_start (int)
175 196
 
176 197
    Each IPSec tunnel has a unique system-wide identifier. This and the
177 198
    following option allows to tune the SPIs used by Kamailio in order to
... ...
@@ -180,12 +201,12 @@ modparam("ims_ipsec_pcscf", "ipsec_server_port", 5063)
180 201
 
181 202
    Default value is 100.
182 203
 
183
-   Example 1.5. ipsec_spi_id_start parameter usage
204
+   Example 1.6. ipsec_spi_id_start parameter usage
184 205
 ...
185 206
 modparam("ims_ipsec_pcscf", "ipsec_spi_id_start", 100)
186 207
 ...
187 208
 
188
-3.6. ipsec_spi_id_range (int)
209
+3.7. ipsec_spi_id_range (int)
189 210
 
190 211
    How many SPIs to be allocated for the process. E.g. if
191 212
    ipsec_spi_id_start = 100 and ipsec_spi_id_range = 1000, SPIs between
... ...
@@ -193,7 +214,7 @@ modparam("ims_ipsec_pcscf", "ipsec_spi_id_start", 100)
193 214
 
194 215
    Default value is 1000.
195 216
 
196
-   Example 1.6. ipsec_spi_id_range parameter usage
217
+   Example 1.7. ipsec_spi_id_range parameter usage
197 218
 ...
198 219
 modparam("ims_ipsec_pcscf", "ipsec_spi_id_range", 1000)
199 220
 ...
... ...
@@ -215,7 +236,7 @@ modparam("ims_ipsec_pcscf", "ipsec_spi_id_range", 1000)
215 236
      * domain - Logical domain within the registrar. If a database is used
216 237
        then this must be name of the table which stores the contacts.
217 238
 
218
-   Example 1.7. ipsec_create
239
+   Example 1.8. ipsec_create
219 240
 ...
220 241
 ipsec_create("location");
221 242
 ...
... ...
@@ -229,7 +250,7 @@ ipsec_create("location");
229 250
      * domain - Logical domain within the registrar. If a database is used
230 251
        then this must be name of the table which stores the contacts.
231 252
 
232
-   Example 1.8. ipsec_forward
253
+   Example 1.9. ipsec_forward
233 254
 ...
234 255
 ipsec_forward("location");
235 256
 ...
... ...
@@ -242,7 +263,7 @@ ipsec_forward("location");
242 263
      * domain - Logical domain within the registrar. If a database is used
243 264
        then this must be name of the table which stores the contacts.
244 265
 
245
-   Example 1.9. ipsec_forward
266
+   Example 1.10. ipsec_destroy
246 267
 ...
247 268
 ipsec_destroy("location");
248 269
 ...
Browse code

ims_ipsec_pcscf: add back the README file

- it was removed completely with the merge of PR #1974

Daniel-Constantin Mierla authored on 05/06/2019 10:20:03
Showing 1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,248 @@
1
+The IMS IPSec-Registrar Module
2
+
3
+Dragos Vingarzan
4
+
5
+   FhG Fokus
6
+   <Dragos.Vingarzan@fokus.fraunhofer.de>
7
+
8
+Jason Penton
9
+
10
+   Smile Communications
11
+   <jason.penton@smilecoms.com>
12
+
13
+Richard Good
14
+
15
+   Smile Communications
16
+   <richard.good@smilecoms.com>
17
+
18
+Carsten Bock
19
+
20
+   ng-voice GmbH
21
+   <carsten@ng-voice.com>
22
+
23
+Tsvetomir Dimitrov
24
+
25
+   <tsv.dimitrov@gmail.com>
26
+
27
+   Copyright � 2007 FhG FOKUS
28
+
29
+   Copyright � 2012 Smile Communications
30
+
31
+   Copyright � 2015 ng-voice GmbH
32
+     __________________________________________________________________
33
+
34
+   Table of Contents
35
+
36
+   1. Admin Guide
37
+
38
+        1. Overview
39
+        2. Dependencies
40
+
41
+              2.1. Kamailio Modules
42
+              2.2. External Libraries or Applications
43
+
44
+        3. Parameters
45
+
46
+              3.1. ipsec_listen_addr (string)
47
+              3.2. ipsec_listen_addr6 (string)
48
+              3.3. ipsec_client_port (int)
49
+              3.4. ipsec_server_port (int)
50
+              3.5. ipsec_spi_id_start (int)
51
+              3.6. ipsec_spi_id_range (int)
52
+
53
+        4. Functions
54
+
55
+              4.1. ipsec_create(domain)
56
+              4.2. ipsec_forward(domain)
57
+              4.3. ipsec_destroy(domain)
58
+
59
+   List of Examples
60
+
61
+   1.1. ipsec_listen_addr parameter usage
62
+   1.2. ipsec_listen_addr6 parameter usage
63
+   1.3. ipsec_client_port parameter usage
64
+   1.4. ipsec_server_port parameter usage
65
+   1.5. ipsec_spi_id_start parameter usage
66
+   1.6. ipsec_spi_id_range parameter usage
67
+   1.7. ipsec_create
68
+   1.8. ipsec_forward
69
+   1.9. ipsec_forward
70
+
71
+Chapter 1. Admin Guide
72
+
73
+   Table of Contents
74
+
75
+   1. Overview
76
+   2. Dependencies
77
+
78
+        2.1. Kamailio Modules
79
+        2.2. External Libraries or Applications
80
+
81
+   3. Parameters
82
+
83
+        3.1. ipsec_listen_addr (string)
84
+        3.2. ipsec_listen_addr6 (string)
85
+        3.3. ipsec_client_port (int)
86
+        3.4. ipsec_server_port (int)
87
+        3.5. ipsec_spi_id_start (int)
88
+        3.6. ipsec_spi_id_range (int)
89
+
90
+   4. Functions
91
+
92
+        4.1. ipsec_create(domain)
93
+        4.2. ipsec_forward(domain)
94
+        4.3. ipsec_destroy(domain)
95
+
96
+1. Overview
97
+
98
+   This module contains methods for IPSec initialisation/deinitialisation
99
+   related for usage of Kamailio as a Proxy-CSCF.
100
+
101
+2. Dependencies
102
+
103
+   2.1. Kamailio Modules
104
+   2.2. External Libraries or Applications
105
+
106
+2.1. Kamailio Modules
107
+
108
+   The Following modules must be loaded before this module:
109
+     * Usrloc PCSCF
110
+     * TM
111
+
112
+2.2. External Libraries or Applications
113
+
114
+   This modules requires the internal IMS library and libmnl for operating
115
+   with netlink sockets.
116
+
117
+3. Parameters
118
+
119
+   3.1. ipsec_listen_addr (string)
120
+   3.2. ipsec_listen_addr6 (string)
121
+   3.3. ipsec_client_port (int)
122
+   3.4. ipsec_server_port (int)
123
+   3.5. ipsec_spi_id_start (int)
124
+   3.6. ipsec_spi_id_range (int)
125
+
126
+3.1. ipsec_listen_addr (string)
127
+
128
+   IP address which the Proxy-CSCF will use for incoming/outgoing SIP
129
+   traffic over IPSec.
130
+
131
+   Default value is empty string (null) - IPv4 listen interface will not
132
+   be added
133
+
134
+   Example 1.1. ipsec_listen_addr parameter usage
135
+...
136
+modparam("ims_ipsec_pcscf", "ipsec_listen_addr", "")
137
+...
138
+
139
+3.2. ipsec_listen_addr6 (string)
140
+
141
+   IPv6 address which the Proxy-CSCF will use for incoming/outgoing SIP
142
+   traffic over IPSec.
143
+
144
+   Default value is empty string (null) - IPv6 listen interface will not
145
+   be added
146
+
147
+   Example 1.2. ipsec_listen_addr6 parameter usage
148
+...
149
+modparam("ims_ipsec_pcscf", "ipsec_listen_addr6", "")
150
+...
151
+
152
+3.3. ipsec_client_port (int)
153
+
154
+   Port number which will be bound for incoming (server) IPSec traffic.
155
+
156
+   Default value is 5963.
157
+
158
+   Example 1.3. ipsec_client_port parameter usage
159
+...
160
+modparam("ims_ipsec_pcscf", "ipsec_client_port", 5062)
161
+...
162
+
163
+3.4. ipsec_server_port (int)
164
+
165
+   Port number which will be bound for incoming (server) IPSec traffic.
166
+
167
+   Default value is 5063.
168
+
169
+   Example 1.4. ipsec_server_port parameter usage
170
+...
171
+modparam("ims_ipsec_pcscf", "ipsec_server_port", 5063)
172
+...
173
+
174
+3.5. ipsec_spi_id_start (int)
175
+
176
+   Each IPSec tunnel has a unique system-wide identifier. This and the
177
+   following option allows to tune the SPIs used by Kamailio in order to
178
+   avoid collisions with other IPSec useres. If Kamailio is the only
179
+   process on the system which uses IPSec, don't bother with this option.
180
+
181
+   Default value is 100.
182
+
183
+   Example 1.5. ipsec_spi_id_start parameter usage
184
+...
185
+modparam("ims_ipsec_pcscf", "ipsec_spi_id_start", 100)
186
+...
187
+
188
+3.6. ipsec_spi_id_range (int)
189
+
190
+   How many SPIs to be allocated for the process. E.g. if
191
+   ipsec_spi_id_start = 100 and ipsec_spi_id_range = 1000, SPIs between
192
+   100 and 1100 will be used.
193
+
194
+   Default value is 1000.
195
+
196
+   Example 1.6. ipsec_spi_id_range parameter usage
197
+...
198
+modparam("ims_ipsec_pcscf", "ipsec_spi_id_range", 1000)
199
+...
200
+
201
+4. Functions
202
+
203
+   4.1. ipsec_create(domain)
204
+   4.2. ipsec_forward(domain)
205
+   4.3. ipsec_destroy(domain)
206
+
207
+4.1. ipsec_create(domain)
208
+
209
+   This function creates IPSec SA and Policy based on the parameters sent
210
+   in Security-Client header in the REGISTER message. It's called when OK
211
+   is received. The function also adds Security-Server header to the
212
+   REGISTER.
213
+
214
+   Meaning of the parameters is as follows:
215
+     * domain - Logical domain within the registrar. If a database is used
216
+       then this must be name of the table which stores the contacts.
217
+
218
+   Example 1.7. ipsec_create
219
+...
220
+ipsec_create("location");
221
+...
222
+
223
+4.2. ipsec_forward(domain)
224
+
225
+   The function processes redirects outgoing message via the IPSec tunnel
226
+   initiated with ipsec_create().
227
+
228
+   Meaning of the parameters is as follows:
229
+     * domain - Logical domain within the registrar. If a database is used
230
+       then this must be name of the table which stores the contacts.
231
+
232
+   Example 1.8. ipsec_forward
233
+...
234
+ipsec_forward("location");
235
+...
236
+
237
+4.3. ipsec_destroy(domain)
238
+
239
+   The function destroys IPSec tunnel, created with ipsec_create.
240
+
241
+   Meaning of the parameters is as follows:
242
+     * domain - Logical domain within the registrar. If a database is used
243
+       then this must be name of the table which stores the contacts.
244
+
245
+   Example 1.9. ipsec_forward
246
+...
247
+ipsec_destroy("location");
248
+...
Browse code

Delete README

Will be autogenerated.

alexyosifov authored on 05/06/2019 06:32:58 • GitHub committed on 05/06/2019 06:32:58
Showing 1 changed files
1 1
deleted file mode 100644
... ...
@@ -1,248 +0,0 @@
1
-The IMS IPSec-Registrar Module
2
-
3
-Dragos Vingarzan
4
-
5
-   FhG Fokus
6
-   <Dragos.Vingarzan@fokus.fraunhofer.de>
7
-
8
-Jason Penton
9
-
10
-   Smile Communications
11
-   <jason.penton@smilecoms.com>
12
-
13
-Richard Good
14
-
15
-   Smile Communications
16
-   <richard.good@smilecoms.com>
17
-
18
-Carsten Bock
19
-
20
-   ng-voice GmbH
21
-   <carsten@ng-voice.com>
22
-
23
-Tsvetomir Dimitrov
24
-
25
-   <tsv.dimitrov@gmail.com>
26
-
27
-   Copyright © 2007 FhG FOKUS
28
-
29
-   Copyright © 2012 Smile Communications
30
-
31
-   Copyright © 2015 ng-voice GmbH
32
-     __________________________________________________________________
33
-
34
-   Table of Contents
35
-
36
-   1. Admin Guide
37
-
38
-        1. Overview
39
-        2. Dependencies
40
-
41
-              2.1. Kamailio Modules
42
-              2.2. External Libraries or Applications
43
-
44
-        3. Parameters
45
-
46
-              3.1. ipsec_listen_addr (string)
47
-              3.2. ipsec_listen_addr6 (string)
48
-              3.3. ipsec_client_port (int)
49
-              3.4. ipsec_server_port (int)
50
-              3.5. ipsec_spi_id_start (int)
51
-              3.6. ipsec_spi_id_range (int)
52
-
53
-        4. Functions
54
-
55
-              4.1. ipsec_create(domain)
56
-              4.2. ipsec_forward(domain)
57
-              4.3. ipsec_destroy(domain)