sip-lab 1.12.10 → 1.12.14

package/DEV.md

@@ -0,0 +1,30 @@
+### For devs
+
+We build and statically link to libs pjproject, spandsp, bgc729 and rapidjson.
+
+Basic tasks for development:
+
+#### To build
+```
+npm install
+```
+
+#### To clean up (for a clean rebuild)
+```
+npx node-gyp clean
+```
+
+#### To update pjproject, spandsp, bcg729 or rapidjson
+Just delete the corresponding library subfolder in subfolder 3drParty.
+
+
+Then temporarily change install.sh to not checkout a specific version (or checkout a desired commit)
+
+Then run
+```
+npm install
+```
+
+Then perform code changes and tests. When you are satisfied with them, update install.sh with the new commit id.
+
+

package/README.md

@@ -25,12 +25,17 @@ apt install build-essential automake autoconf libtool libspeex-dev libopus-dev l
 
 Then install sip-lab by doing:
 ```
-  npm install sip-lab
+npm install sip-lab
 ```
 
 Be patient because we will need to download pjproject and build it.
 
-We will also download rapidjson.
+We will also download and build spandsp, bcg729 and rapidjson.
+
+However since it takes several minutes to build this module, you can install it globally:
+```
+npm install -g sip-lab
+```
 
 To test from within this repo just build and install by doing:
 ```
@@ -49,9 +54,11 @@ It was originally developed with node v.10 and tested with v.12 and v16.13.1 and
 (it is known to not work with node v.8)
 
 
+
 ### About the code
 
 Although the code in written in *.cpp/*.hpp named files, this is not actually a C++ project.
 
 It is mostly written in C using some C++ facilities.
 
+

package/devjournal

@@ -438,5 +438,12 @@ When rebuilding the addon, this should be enough (it should be fast):
 ```
   npm install --unsafe-perm
 ```
+------------------------------------------------------------
+2022/09/11 takeshi:
+
+To try to solve #21, we upraded pjproject to commit 797088ed133c98492519b7d042b75735f6f9388c.
+However, after doing it we verified sending CANCEL doesn't cause the other side to send '497 Request Terminated' by itself anymore (see samples/sip_cancel.js)
+ 
+
 
 

package/install.sh

@@ -52,10 +52,8 @@ then
 	git clone https://github.com/pjsip/pjproject
 	cd pjproject
 	#git checkout de3d744c2e1188b59bb907b6ee32ef83740ebc64
-    git checkout 33a3c9e0a5eb84426edef05a9aa98af17d8011c3 # required for bcg729
-
-    #echo "Patching sip_transaction.c to avoid problems with CANCEL"
-    sed -i -r 's|event->body.tx_msg.tdata == tsx->last_tx,|\t\t\t1, /* \0 */|' pjsip/src/pjsip/sip_transaction.c 
+    #git checkout 33a3c9e0a5eb84426edef05a9aa98af17d8011c3 # required for bcg729
+    git checkout 797088ed133c98492519b7d042b75735f6f9388c # updated as part of #21
 
 	cat > user.mak <<EOF
 	export CFLAGS += -fPIC -g

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "sip-lab",
-  "version": "1.12.10",
+  "version": "1.12.14",
   "description": "",
   "main": "index.js",
   "engines": {
     "node": ">=10.22"
   },
   "scripts": {
-    "install": "./install.sh"
+    "install": "./install.sh",
+    "test": "./runtests"
   },
   "repository": {
     "type": "git",

package/samples/register_subscribe.js

@@ -3,6 +3,7 @@ var Zeq = require('@mayama/zeq')
 var z = new Zeq()
 var m = require('data-matching')
 var sip_msg = require('sip-matching')
+var assert = require('assert')
 
 async function test() {
     //sip.set_log_level(6)
@@ -116,12 +117,14 @@ async function test() {
             msg: sip_msg({
                 $rm: 'NOTIFY',
                 '$hdr(Event)': 'dialog',
-                '$hdr(Subscription-State)': 'active;expires=120',
+                '$hdr(Subscription-State)': 'active;expires=!{sub_expires}',
                 '$hdr(Allow-Events)': 'refer, dialog',
             }),
         },
     ], 1000)
 
+    assert(parseInt(z.store.sub_expires) > 0)
+
     sip.account.unregister(a1)
 
     await z.wait([

package/samples/sip_cancel.js

@@ -87,6 +87,11 @@ async function test() {
                 $rr: 'OK',
             }),
         },
+    ], 1000)
+
+    sip.call.respond(ic.id, {code: 487, reason: 'Request Terminated'})
+
+    await z.wait([
         {
             event: 'response',
             call_id: oc.id,

package/src/event_templates.cpp

@@ -26,8 +26,11 @@ int make_evt_dtmf(char *dest, int size, long call_id, int digits_len, const char
 }
 
 int make_evt_call_ended(char *dest, int size, long call_id, int sip_msg_len, const char *sip_msg) {
-	printf("sip_msg_len=%i sip_msg=%s\n", sip_msg_len, sip_msg);
-	if(sip_msg_len > 500 && sip_msg_len < 2000 && sip_msg) {
+	printf("sip_msg_len=%i sip_msg=%x\n", sip_msg_len, sip_msg);
+    if(!sip_msg || sip_msg == (char*)0xc000000000000) {
+        // received invalid pointer to sip_msg so do not add the message to the event
+		return snprintf(dest, size, "{\"event\": \"call_ended\", \"call_id\": %ld}", call_id); 
+    } else if(sip_msg_len > 500 && sip_msg_len < 2000 && sip_msg) {
 		/* sip_msg_len sometimes show up as a large value like sip_msg_len=11560297 which seems to be a bug in pjsip */
 		return snprintf(dest, size, "{\"event\": \"call_ended\", \"call_id\": %ld}\n%.*s", call_id, sip_msg_len, sip_msg); 
 	} else {

package/src/sip.cpp

@@ -126,6 +126,33 @@ bool parse_json(Document &document, const char *json, char *buffer, long unsigne
     return true;
 }
 
+
+bool param_is_valid(const char *param, const char **valid_params) {
+    char **valid_param = (char**)valid_params;
+    while(*valid_param[0]) {
+        //printf("checking param=%s valid_param=%s\n", param, *valid_param);
+        if(strcmp(param, *valid_param) == 0) {
+            return true;
+        }
+        valid_param++;
+    }
+    return false;
+}
+
+bool validate_params(Document &document, const char **valid_params) {
+    for (Value::ConstMemberIterator itr = document.MemberBegin();
+        itr != document.MemberEnd(); ++itr)
+    {
+        const char *param = itr->name.GetString();
+        if(!param_is_valid(param, valid_params)) {
+            set_error("Invalid param %s", param);
+            return false;
+        }
+    }
+
+    return true;
+}
+
 bool json_get_string_param(Document &document, const char *param, bool optional, char **dest) {
     printf("json_get_string_param %s\n", param);
     if(!document.HasMember(param)) {
@@ -1078,11 +1105,17 @@ int pjw_transport_create(const char *json, int *out_t_id, char *out_t_address, i
 
     char buffer[MAX_JSON_INPUT];
 
+    const char *valid_params[] = {"address", "port", "type", ""};
+
     Document document;
 
     if(!parse_json(document, json, buffer, MAX_JSON_INPUT)) {
         goto out;
     }
+        
+    if(!validate_params(document, valid_params)) {
+        goto out;
+    }
 
     // address
     if(!document.HasMember("address")) {
@@ -1301,6 +1334,8 @@ int pjw_account_create(int t_id, const char *json, int *out_acc_id)
 
     Document document;
 
+    const char *valid_params[] = {"domain", "server", "username", "password", "to_url", "expires", "headers", ""};
+
 	if(!g_transport_ids.get(t_id, val)){
 		set_error("Invalid transport id");
         goto out;
@@ -1310,6 +1345,10 @@ int pjw_account_create(int t_id, const char *json, int *out_acc_id)
     if(!parse_json(document, json, buffer, MAX_JSON_INPUT)) {
         goto out;
     }
+    
+    if(!validate_params(document, valid_params)) {
+        goto out;
+    }
 
     if(!json_get_string_param(document, "domain", false, &domain)) {
         goto out;
@@ -1461,6 +1500,8 @@ int pjw_account_register(long acc_id, const char *json)
 
     Document document;
 
+    const char *valid_params[] = {"auto_refresh", ""};
+
 	if(!g_account_ids.get(acc_id, val)){
 		set_error("Invalid account_id");
         goto out;
@@ -1471,6 +1512,10 @@ int pjw_account_register(long acc_id, const char *json)
         goto out;
     }
 
+    if(!validate_params(document, valid_params)) {
+        goto out;
+    }
+
     if(!json_get_bool_param(document, "auto_refresh", true, &auto_refresh)) {
         goto out;
     }
@@ -1563,6 +1608,8 @@ int pjw_call_respond(long call_id, const char *json)
 
     Document document;
 
+    const char *valid_params[] = {"code", "reason", "headers", ""};
+
 	if(!g_call_ids.get(call_id, val)){
 		set_error("Invalid call_id");
         goto out;
@@ -1577,6 +1624,10 @@ int pjw_call_respond(long call_id, const char *json)
     if(!parse_json(document, json, buffer, MAX_JSON_INPUT)) {
         goto out;
     }
+    
+    if(!validate_params(document, valid_params)) {
+        goto out;
+    }
 
     if(!json_get_int_param(document, "code", true, &code)) {
         goto out;
@@ -1655,6 +1706,8 @@ int pjw_call_terminate(long call_id, const char *json)
 
     Document document;
 
+    const char *valid_params[] = {"code", "reason", "headers", ""};
+
 	if(!g_call_ids.get(call_id, val)){
 		set_error("Invalid call_id");
 		goto out;
@@ -1664,6 +1717,10 @@ int pjw_call_terminate(long call_id, const char *json)
     if(!parse_json(document, json, buffer, MAX_JSON_INPUT)) {
         goto out;
     }
+    
+    if(!validate_params(document, valid_params)) {
+        goto out;
+    }
 
     if(!json_get_int_param(document, "code", true, &code)) {
         goto out;
@@ -1744,6 +1801,8 @@ int pjw_call_create(long t_id, const char *json, long *out_call_id, char *out_si
 
     Document document;
 
+    const char *valid_params[] = {"from_uri", "to_uri", "request_uri", "proxy_uri", "auth", "delayed_media", "headers", ""};
+
 	if(!g_transport_ids.get(t_id, val)){
 		set_error("Invalid transport_id");
 		goto out;
@@ -1753,6 +1812,10 @@ int pjw_call_create(long t_id, const char *json, long *out_call_id, char *out_si
     if(!parse_json(document, json, buffer, MAX_JSON_INPUT)) {
         goto out;
     }
+        
+    if(!validate_params(document, valid_params)) {
+        goto out;
+    }
 
     if(!json_get_and_check_uri(document, "from_uri", false, &from_uri)) {
         goto out;
@@ -2160,10 +2223,17 @@ int pjw_call_send_dtmf(long call_id, const char *json)
 
     Document document;
 
+    const char *valid_params[] = {"digits", "mode", ""};
+
+
     if(!parse_json(document, json, buffer, MAX_JSON_INPUT)) {
         goto out;
     }
 
+    if(!validate_params(document, valid_params)) {
+        goto out;
+    }
+
 	if(!g_call_ids.get(call_id, val)){
 		set_error("Invalid call_id");
 		goto out;
@@ -2278,6 +2348,8 @@ int pjw_call_reinvite(long call_id, const char *json)
     char buffer[MAX_JSON_INPUT];
 
     Document document;
+    
+    const char *valid_params[] = {"hold", "delayed_media", ""};
 
 	if(!g_call_ids.get(call_id, val)){
 	    set_error("Invalid call_id");
@@ -2289,6 +2361,10 @@ int pjw_call_reinvite(long call_id, const char *json)
         goto out;
     }
 
+    if(!validate_params(document, valid_params)) {
+        goto out;
+    }
+
     if(!json_get_bool_param(document, "hold", true, &hold)) {
         goto out;
     }
@@ -2404,11 +2480,17 @@ int pjw_call_send_request(long call_id, const char *json)
     char buffer[MAX_JSON_INPUT];
 
     Document document;
+    
+    const char *valid_params[] = {"method", "body", "ct_type", "ct_subtype", "headers", ""};
 
     if(!parse_json(document, json, buffer, MAX_JSON_INPUT)) {
         goto out;
     }
 
+    if(!validate_params(document, valid_params)) {
+        goto out;
+    }
+
 	if(!g_call_ids.get(call_id, val)){
 		set_error("Invalid call_id");
 		goto out;
@@ -2503,6 +2585,8 @@ int pjw_call_start_record_wav(long call_id, const char *json)
 
     Document document;
 
+    const char *valid_params[] = {"file", ""};
+
 	if(!g_call_ids.get(call_id, val)){
 		set_error("Invalid call_id");
         goto out;
@@ -2519,6 +2603,10 @@ int pjw_call_start_record_wav(long call_id, const char *json)
         goto out;
     }
 
+    if(!validate_params(document, valid_params)) {
+        goto out;
+    }
+
     if(!json_get_string_param(document, "file", false, &file)) {
         goto out;
     }
@@ -2567,6 +2655,8 @@ int pjw_call_start_play_wav(long call_id, const char *json)
     char buffer[MAX_JSON_INPUT];
 
     Document document;
+    
+    const char *valid_params[] = {"file", ""};
 
 	if(!g_call_ids.get(call_id, val)){
 		set_error("Invalid call_id");
@@ -2584,6 +2674,10 @@ int pjw_call_start_play_wav(long call_id, const char *json)
         goto out;
     }
 
+    if(!validate_params(document, valid_params)) {
+        goto out;
+    }
+
     if(!json_get_string_param(document, "file", false, &file)) {
         goto out;
     }
@@ -2715,6 +2809,8 @@ int pjw_call_start_fax(long call_id, const char *json)
 
     Document document;
 
+    const char *valid_params[] = {"is_sender", "file", "transmit_on_idle", ""};
+
 	if(!g_call_ids.get(call_id, val)){
 		set_error("Invalid call_id");
         goto out;
@@ -2731,6 +2827,10 @@ int pjw_call_start_fax(long call_id, const char *json)
         goto out;
     }
 
+    if(!validate_params(document, valid_params)) {
+        goto out;
+    }
+
     if(!json_get_bool_param(document, "is_sender", false, &is_sender)) {
         goto out;
     }
@@ -4873,6 +4973,8 @@ int pjw_call_refer(long call_id, const char *json, long *out_subscription_id)
 
     Document document;
 
+    const char *valid_params[] = {"dest_uri", "headers", ""};
+
 	if(!g_call_ids.get(call_id, val)){
 		set_error("Invalid call_id");
 		goto out;
@@ -4883,6 +4985,10 @@ int pjw_call_refer(long call_id, const char *json, long *out_subscription_id)
         goto out;
     }
 
+    if(!validate_params(document, valid_params)) {
+        goto out;
+    }
+
     if(!json_get_and_check_uri(document, "dest_uri", false, &dest_uri)) {
         goto out;
     }
@@ -5061,6 +5167,8 @@ int pjw_notify(long subscriber_id, const char *json)
 
     Document document;
 
+    const char *valid_params[] = {"content_type", "body", "subscription_state", "reason", ""};
+
 	if(!g_subscriber_ids.get(subscriber_id, val)){
 		set_error("Invalid subscriber_id");
 		goto out;
@@ -5076,6 +5184,10 @@ int pjw_notify(long subscriber_id, const char *json)
         goto out;
     }
 
+    if(!validate_params(document, valid_params)) {
+        goto out;
+    }
+
     if(!json_get_string_param(document, "content_type", false, &content_type)) {
         goto out;
     }
@@ -5125,6 +5237,9 @@ int pjw_notify_xfer(long subscriber_id, const char *json) {
     char buffer[MAX_JSON_INPUT];
 
     Document document;
+
+    const char *valid_params[] = {"subscription_state", "code", "reason", ""};
+
 	if(!g_subscriber_ids.get(subscriber_id, val)){
 		set_error("Invalid subscriber_id");
 		goto out;
@@ -5140,6 +5255,10 @@ int pjw_notify_xfer(long subscriber_id, const char *json) {
         goto out;
     }
 
+    if(!validate_params(document, valid_params)) {
+        goto out;
+    }
+
     if(!json_get_int_param(document, "subscription_state", false, &subscription_state)) {
         goto out;
     }
@@ -5422,6 +5541,8 @@ int pjw_subscription_create(long transport_id, const char *json, long *out_subsc
 
     Document document;
 
+    const char *valid_params[] = {"event", "accept", "from_uri", "to_uri", "request_uri", "proxy_uri", "auth", ""};
+
 	if(!g_transport_ids.get(transport_id, val)){
 		set_error("Invalid transport_id");
 		goto out;
@@ -5432,6 +5553,10 @@ int pjw_subscription_create(long transport_id, const char *json, long *out_subsc
         goto out;
     }
 
+    if(!validate_params(document, valid_params)) {
+        goto out;
+    }
+
     if(!json_get_string_param(document, "event", false, &event)) {
         goto out;
     }
@@ -5628,6 +5753,8 @@ int pjw_subscription_subscribe(long subscription_id, const char *json) {
     char buffer[MAX_JSON_INPUT];
 
     Document document;
+    
+    const char *valid_params[] = {"expires", "headers", ""};
 
 	if(!g_subscription_ids.get(subscription_id, val)){
 		set_error("Invalid subscription_id");
@@ -5639,6 +5766,10 @@ int pjw_subscription_subscribe(long subscription_id, const char *json) {
         goto out;
     }
 
+    if(!validate_params(document, valid_params)) {
+        goto out;
+    }
+
     if(!json_get_int_param(document, "expires", true, &expires)) {
         goto out;
     }