Browse code

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

Kamailio Dev authored on 17/11/2020 10:46:18
Showing 1 changed files
... ...
@@ -35,7 +35,8 @@ Daniel-Constantin Mierla
35 35
 
36 36
               4.1. secsipid_check_identity(keyPath)
37 37
               4.2. secsipid_check_identity(pubkeyVal)
38
-              4.3. secsipid_add_identity(origTN, destTN, attest, origID,
38
+              4.3. secsipid_get_url(url, ovar)
39
+              4.4. secsipid_add_identity(origTN, destTN, attest, origID,
39 40
                       x5u, keyPath)
40 41
 
41 42
         5. Installation
... ...
@@ -48,8 +49,9 @@ Daniel-Constantin Mierla
48 49
    1.4. Set cache_expire parameter
49 50
    1.5. secsipid_check_identity usage
50 51
    1.6. secsipid_check_identity_pubkey usage
51
-   1.7. secsipid_add_identity usage
52
-   1.8. Libsecsipid usage
52
+   1.7. secsipid_get_url usage
53
+   1.8. secsipid_add_identity usage
54
+   1.9. Libsecsipid usage
53 55
 
54 56
 Chapter 1. Admin Guide
55 57
 
... ...
@@ -72,7 +74,8 @@ Chapter 1. Admin Guide
72 74
 
73 75
         4.1. secsipid_check_identity(keyPath)
74 76
         4.2. secsipid_check_identity(pubkeyVal)
75
-        4.3. secsipid_add_identity(origTN, destTN, attest, origID, x5u,
77
+        4.3. secsipid_get_url(url, ovar)
78
+        4.4. secsipid_add_identity(origTN, destTN, attest, origID, x5u,
76 79
                 keyPath)
77 80
 
78 81
    5. Installation
... ...
@@ -159,7 +162,8 @@ modparam("secsipid", "cache_expire", 7200)
159 162
 
160 163
    4.1. secsipid_check_identity(keyPath)
161 164
    4.2. secsipid_check_identity(pubkeyVal)
162
-   4.3. secsipid_add_identity(origTN, destTN, attest, origID, x5u,
165
+   4.3. secsipid_get_url(url, ovar)
166
+   4.4. secsipid_add_identity(origTN, destTN, attest, origID, x5u,
163 167
           keyPath)
164 168
 
165 169
 4.1.  secsipid_check_identity(keyPath)
... ...
@@ -211,11 +215,26 @@ request_route {
211 215
 }
212 216
 ...
213 217
 
214
-   Further checks can be done with config operations, decoding the JWT
215
-   header and payload using {s.select} and {s.decode.base64t}
216
-   transformations together with jansson module.
218
+4.3.  secsipid_get_url(url, ovar)
219
+
220
+   Get the content of a URL and store the result in a variable.
221
+
222
+   The url parameters can contain pseudo-variables and ovar has to be the
223
+   name of a writtable pseudo-variable.
224
+
225
+   This function can be used from ANY_ROUTE.
226
+
227
+   Example 1.7. secsipid_get_url usage
228
+...
229
+request_route {
230
+  ...
231
+  if(secsipid_get_url("https://$fd/stirshaken/cert.pem", "$var(pubkey)")) { ...
232
+}
233
+  ...
234
+}
235
+...
217 236
 
218
-4.3.  secsipid_add_identity(origTN, destTN, attest, origID, x5u, keyPath)
237
+4.4.  secsipid_add_identity(origTN, destTN, attest, origID, x5u, keyPath)
219 238
 
220 239
    Add Identity header using the key specified by "keyPath" to sign the
221 240
    JWT body. If origID is empty, a UUID string is generated to fill the
... ...
@@ -229,7 +248,7 @@ request_route {
229 248
 
230 249
    This function can be used from ANY_ROUTE.
231 250
 
232
-   Example 1.7. secsipid_add_identity usage
251
+   Example 1.8. secsipid_add_identity usage
233 252
 ...
234 253
 request_route {
235 254
     ...
... ...
@@ -253,7 +272,7 @@ request_route {
253 272
    installed and its environment configured, then run the following
254 273
    commands:
255 274
 
256
-   Example 1.8. Libsecsipid usage
275
+   Example 1.9. Libsecsipid usage
257 276
 ...
258 277
 go get https://github.com/asipto/secsipidx
259 278
 cd $GOPATH/src/github.com/asipto/secsipidx/csecsipid/