{"id":1109,"date":"2017-10-12T14:30:12","date_gmt":"2017-10-12T09:30:12","guid":{"rendered":"http:\/\/alexeyka.zantsev.com\/?p=1109"},"modified":"2021-02-28T01:37:27","modified_gmt":"2021-02-27T20:37:27","slug":"opensips-register-vs-permissions-module","status":"publish","type":"post","link":"https:\/\/alexeyka.zantsev.com\/?p=1109","title":{"rendered":"OpenSIPS battle: REGISTER requests vs permissions module"},"content":{"rendered":"

UPDATE: this post restricts access based on source IP address. A new article shows how to restrict access (registrations) based on username<\/a>.<\/p>\n

Sutuation: you have to check the source address of REGISTER messages, going to your OpenSIPS server and decide wether to allow them or to deny.<\/p>\n

Use permissions<\/a> module for this.<\/p>\n

You can use it in two variants:<\/p>\n

1.<\/strong> with OpenSIPS’ text config files register.allow and register.deny (similar to Unix hosts.allow and hosts.deny).
\nIn this case you should use module’s function ‘allow_register<\/a>‘<\/p>\n

Example of blocking REGISTERs from 10.145.13.49 IP address:<\/p>\n

register.deny file:<\/p>\n

ALL : \"^sip:.*10\\.145\\.13\\.49\"\nALL : \"^sip:.*0*10\\.145\\.0*13\\.0*49\"   # this is to prevent bypassing\n                                       # by the insertion of one or more '0' in the IP address\n<\/pre>\n
register.allow file is empty (allow everything except those in .deny file).<\/p>\n
OpenSIPS script snippet:<\/p>\n
\tif ( is_method(\"REGISTER\") ) {\n\t\tif (allow_register(\"register\")) {\n\t\t\tsave(\"location\");\n\t\t\texit;\n\t\t} else {\n\t\t\tsl_send_reply(\"403\", \"Forbidden registration from your IP v2\");\n\t\t\texit;\n\t\t}\n\t}\n<\/pre>\n
But this method has one big disadvantage – you need to restart OpenSIPS each time you edit register.allow\/register.deny.
\nOpenSIPS ‘permissions’ module has a MI function ‘address_reload<\/a>‘ but it reloads the table (see below), not the allow\/deny files.
\nSo, it’s more cool to use the second variant, go on reading!..<\/p>\n
2.<\/strong> with DB table ‘address<\/a>‘.
\nIn this case you should use modules’ function ‘check_address<\/a>‘<\/p>\n
– register.allow and register.deny files are empty.
\n– add entries to ‘address’ table. In our case we’re using not real SQL DB but dbtext<\/a>. So, this is how ‘\/etc\/opensips\/dbtext\/address’ file looks like:<\/p>\n
voip-pbx-sbc ~ # cat \/etc\/opensips\/dbtext\/address \nid(int,auto) grp(int) ip(string) mask(int) port(int) proto(string) pattern(string,null) context_info(string,null)\n1:0:10.84.2.0:24:0:any\n2:0:10.145.13.5:32:0:any\n3:0:10.145.13.49:32:0:any\n4:0:10.145.14.0:24:0:any\n<\/pre>\n
WARNING: every time you add any new table, do not forget to add it’s version to another table ‘version’:<\/p>\n
voip-pbx-sbc ~ # cat \/etc\/opensips\/dbtext\/version \ntable_name(string) table_version(int) \ndispatcher:8\nload_balancer:2\naddress:5\n<\/pre>\n
Firstly, I haven’t done it, and that’s why OpenSIPS could not start and I had this message in the system log:<\/p>\n
ERROR:core:db_check_table_version: invalid version 0 for table address found, expected 5\n<\/pre>\n
So, the script snippet with the ‘check_address’ function:<\/p>\n
\tif ( is_method(\"REGISTER\") ) {\n\n\t\tif(check_address(\"0\",\"$si\",\"0\",\"any\")) {\n\t\t\tsave(\"location\");\n\t\t\texit;\n\t\t} else {\n\t\t\tsl_send_reply(\"403\", \"Forbidden registration from your IP v2\");\n\t\t\texit;\n\t\t}\n\n\t}\n<\/pre>\n
And here’s the magic! You may add IP-addresses or subnets to your DB or dbtext file and then run a MI command ‘address_reload<\/a>‘ without restarting your high-loaded OpenSIPS.<\/p>\n
Now the policy is “if address is in the table – allow it, otherwise block”. Look at the images below.<\/p>\n
IP is not in the table – REGISTER is forbidden:
\n\"\"<\/a><\/p>\n
\"\"<\/a><\/p>\n
IP has been added to dbtext table and table reloaded – registrations passed successfully:
\n\"\"<\/a><\/p>\n
You can also look the table’s contents with MI commands ‘opensipsctl fifo address_dump<\/a>‘ and ‘opensipsctl fifo subnet_dump<\/a>‘.
\n\"\"<\/a><\/p>\n
UPD: OpenSIPS core developer’s answer to my question http:\/\/lists.opensips.org\/pipermail\/users\/2017-October\/038169.html .<\/p>\n","protected":false},"excerpt":{"rendered":"
UPDATE: this post restricts access based on source IP address. A new article shows how to restrict access (registrations) based on username. Sutuation: you have to check the source address of REGISTER messages, going to your OpenSIPS server and decide wether to allow them or to deny. Use permissions module for this. You can use […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[208,137,151],"class_list":["post-1109","post","type-post","status-publish","format-standard","hentry","category-uncategorized","tag-opensips","tag-permissions","tag-register"],"_links":{"self":[{"href":"https:\/\/alexeyka.zantsev.com\/index.php?rest_route=\/wp\/v2\/posts\/1109","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/alexeyka.zantsev.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/alexeyka.zantsev.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/alexeyka.zantsev.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/alexeyka.zantsev.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=1109"}],"version-history":[{"count":34,"href":"https:\/\/alexeyka.zantsev.com\/index.php?rest_route=\/wp\/v2\/posts\/1109\/revisions"}],"predecessor-version":[{"id":3647,"href":"https:\/\/alexeyka.zantsev.com\/index.php?rest_route=\/wp\/v2\/posts\/1109\/revisions\/3647"}],"wp:attachment":[{"href":"https:\/\/alexeyka.zantsev.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=1109"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/alexeyka.zantsev.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=1109"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/alexeyka.zantsev.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=1109"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}