diff --git a/examples/kemi/kamailio-basic-kemi-python.py b/examples/kemi/kamailio-basic-kemi-python.py new file mode 100644 index 00000000000..ec18d78a3d0 --- /dev/null +++ b/examples/kemi/kamailio-basic-kemi-python.py @@ -0,0 +1,359 @@ +## Kamailio - equivalent of routing blocks in Python +## KSR - the new dynamic object exporting Kamailio functions +## Router - the old object exporting Kamailio functions +## +import sys +import Router.Logger as Logger +import KSR as KSR + +FLT_ACC=1 +FLT_ACCMISSED=2 +FLT_ACCFAILED=3 +FLT_NATS=5 + +FLB_NATB=6 +FLB_NATSIPPING=7 + +def dumpObj(obj): + for attr in dir(obj): + # KSR.info("obj.%s = %s\n" % (attr, getattr(obj, attr))); + Logger.LM_INFO("obj.%s = %s\n" % (attr, getattr(obj, attr))); + +def mod_init(): + KSR.info("===== from Python mod init\n"); + # dumpObj(KSR); + return kamailio(); + +class kamailio: + def __init__(self): + KSR.info('===== kamailio.__init__\n'); + + + def child_init(self, rank): + KSR.info('===== kamailio.child_init(%d)\n' % rank); + return 0; + + + def ksr_request_route(self, msg): + # KSR.info("===== request - from kamailio python script\n"); + # KSR.info("===== method [%s] r-uri [%s]\n" % (KSR.pv.get("$rm"),KSR.pv.get("$ru"))); + + # per request initial checks + if self.ksr_route_reqinit(msg)==-255 : + return 1; + + # NAT detection + if self.ksr_route_natdetect(msg)==-255 : + return 1; + + # CANCEL processing + if KSR.pv.get("$rm") == "CANCEL" : + if KSR.tm.t_check_trans()>0 : + self.ksr_route_relay(); + return 1; + + # handle requests within SIP dialogs + self.ksr_route_withindlg(msg); + + # -- only initial requests (no To tag) + + # handle retransmissions + if KSR.tmx.t_precheck_trans()>0 : + KSR.tm.t_check_trans(); + return 1; + + if KSR.tm.t_check_trans()==0 : + return 1; + + # authentication + if self.ksr_route_auth(msg)==-255 : + return 1 + + # record routing for dialog forming requests (in case they are routed) + # - remove preloaded route headers + KSR.hdr.remove("Route"); + if "INVITE|SUBSCRIBE".find(KSR.pv.get("$rm"))!=-1 : + KSR.rr.record_route(); + + + # account only INVITEs + if KSR.pv.get("$rm")=="INVITE" : + KSR.setflag(FLT_ACC); # do accounting + + + # dispatch requests to foreign domains + if self.ksr_route_sipout(msg)==-255 : + return 1; + + # # requests for my local domains + + # handle registrations + if self.ksr_route_registrar(msg)==-255 : + return 1; + + if KSR.pv.is_null("$rU") : + # request with no Username in RURI + KSR.sl.sl_send_reply(484,"Address Incomplete"); + return 1; + + + # user location service + self.ksr_route_location(msg); + + return 1; + + + # wrapper around tm relay function + def ksr_route_relay(self, msg): + # enable additional event routes for forwarded requests + # - serial forking, RTP relaying handling, a.s.o. + if "INVITE,BYE,SUBSCRIBE,UPDATE".find(KSR.pv.get("$rm"))!=-1 : + if KSR.tm.t_is_set("branch_route")<0 : + KSR.tm.t_on_branch("ksr_branch_manage"); + + if "INVITE,SUBSCRIBE,UPDATE".find(KSR.pv.get("$rm"))!=-1 : + if KSR.tm.t_is_set("onreply_route")<0 : + KSR.tm.t_on_reply("ksr_onreply_manage"); + + if KSR.pv.get("$rm")=="INVITE" : + if KSR.tm.t_is_set("failure_route")<0 : + KSR.tm.t_on_failure("MANAGE_FAILURE"); + + if KSR.tm.t_relay()<0 : + KSR.sl.sl_reply_error(); + + return -255; + + + # Per SIP request initial checks + def ksr_route_reqinit(self, msg): + if not KSR.is_myself(KSR.pv.get("$si")) : + if not KSR.pv.is_null("$sht(ipban=>$si)") : + # ip is already blocked + KSR.dbg("request from blocked IP - " + KSR.pv.get("$rm") + + " from " + KSR.pv.get("$fu") + " (IP:" + + KSR.pv.get("$si") + ":" + KSR.pv.get("$sp") + ")\n"); + return -255; + + if KSR.pike.pike_check_req()<0 : + KSR.err("ALERT: pike blocking " + KSR.pv.get("$rm") + + " from " + KSR.pv.get("$fu") + " (IP:" + + KSR.pv.get("$si") + ":" + KSR.pv.get("$sp") + ")\n"); + KSR.pv.seti("$sht(ipban=>$si)", 1); + return -255; + + if not KSR.pv.is_null("$ua") : + if (KSR.pv.get("$ua").find("friendly-scanner")!=-1 + or KSR.pv.get("$ua").find("sipcli")!=-1) : + KSR.sl.sl_send_reply(200, "Processed"); + return -255; + + if KSR.maxfwd.process_maxfwd(10) < 0 : + KSR.sl.sl_send_reply(483,"Too Many Hops"); + return -255; + + if (KSR.pv.get("$rm")=="OPTIONS" + and KSR.is_myself(KSR.pv.get("$ru")) + and KSR.pv.is_null("$rU")) : + KSR.sl.sl_send_reply(200,"Keepalive"); + return -255; + + if KSR.sanity.sanity_check(1511, 7)<0 : + KSR.err("Malformed SIP message from " + + KSR.pv.get("$si") + ":" + KSR.pv.get("$sp") +"\n"); + return -255; + + + # Handle requests within SIP dialogs + def ksr_route_withindlg(self, msg): + if KSR.siputils.has_totag()<0 : + return 1; + + # sequential request withing a dialog should + # take the path determined by record-routing + if KSR.rr.loose_route()>0 : + if self.ksr_route_dlguri(msg)==-255 : + return -255; + if KSR.pv.get("$rm")=="BYE" : + # do accounting ... + KSR.setflag(FLT_ACC); + # ... even if the transaction fails + KSR.setflag(FLT_ACCFAILED); + elif KSR.pv.get("$rm")=="ACK" : + # ACK is forwarded statelessy + if self.ksr_route_natmanage(msg)==-255 : + return -255; + elif KSR.pv.get("$rm")=="NOTIFY" : + # Add Record-Route for in-dialog NOTIFY as per RFC 6665. + KSR.rr.record_route(); + + self.ksr_route_relay(msg); + return -255; + + if KSR.pv.get("$rm")=="ACK" : + if KSR.tm.t_check_trans() >0 : + # no loose-route, but stateful ACK; + # must be an ACK after a 487 + # or e.g. 404 from upstream server + self.ksr_route_relay(msg); + return -255; + else: + # ACK without matching transaction ... ignore and discard + return -255; + + KSR.sl.sl_send_reply(404, "Not here"); + return -255; + + + # Handle SIP registrations + def ksr_route_registrar(self, msg): + if KSR.pv.get("$rm") != "REGISTER" : + return 1; + if KSR.isflagset(FLT_NATS) : + KSR.setbflag(FLB_NATB); + # do SIP NAT pinging + KSR.setbflag(FLB_NATSIPPING); + + if KSR.registrar.save("location", 0)<0 : + KSR.sl.sl_reply_error(); + + return -255; + + + # User location service + def ksr_route_location(self, msg): + rc = KSR.registrar.lookup("location"); + if rc<0 : + KSR.tm.t_newtran(); + if rc==-1 or rc==-3 : + KSR.sl.send_reply(404, "Not Found"); + return -255; + elif rc==-2 : + KSR.sl.send_reply(405, "Method Not Allowed"); + return -255; + + # when routing via usrloc, log the missed calls also + if KSR.pv.get("$rm")=="INVITE" : + KSR.setflag(FLT_ACCMISSED); + + self.ksr_route_relay(msg); + return -255; + + + + # IP authorization and user uthentication + def ksr_route_auth(self, msg): + + if KSR.pv.get("$rm") != "REGISTER" : + if KSR.permissions.allow_source_address(1)>0 : + # source IP allowed + return 1; + + if KSR.pv.get("$rm")=="REGISTER" or KSR.is_myself(KSR.pv.get("$fu")) : + # authenticate requests + if KSR.auth_db.auth_check(KSR.pv.get("$fd"), "subscriber", 1)<0 : + KSR.auth.auth_challenge(KSR.pv.get("$fd"), 0); + return -255; + + # user authenticated - remove auth header + if not "REGISTER,PUBLISH".find(KSR.pv.get("$rm"))!=-1 : + KSR.auth.consume_credentials(); + + # if caller is not local subscriber, then check if it calls + # a local destination, otherwise deny, not an open relay here + if (not KSR.is_myself(KSR.pv.get("$fu")) + and (not KSR.is_myself(KSR.pv.get("$ru")))) : + KSR.sl.sl_send_reply(403,"Not relaying"); + return -255; + + return 1; + + + # Caller NAT detection + def ksr_route_natdetect(self, msg): + KSR.force_rport(); + if KSR.nathelper.nat_uac_test(19)>0 : + if KSR.pv.get("$rm")=="REGISTER" : + KSR.nathelper.fix_nated_register(); + elif KSR.siputils.is_first_hop()>0 : + KSR.nathelper.set_contact_alias(); + + KSR.setflag(FLT_NATS); + + return 1; + + + # RTPProxy control + def ksr_route_natmanage(self, msg): + if KSR.siputils.is_request()>0 : + if KSR.siputils.has_totag()>0 : + if KSR.rr.check_route_param("nat=yes")>0 : + KSR.setbflag(FLB_NATB); + + if (not (KSR.isflagset(FLT_NATS) or KSR.isbflagset(FLB_NATB))) : + return 1; + + KSR.rtpproxy.rtpproxy_manage("co"); + + if KSR.siputils.is_request()>0 : + if not KSR.siputils.has_totag() : + if KSR.tmx.t_is_branch_route()>0 : + KSR.rr.add_rr_param(";nat=yes"); + + if KSR.siputils.is_reply()>0 : + if KSR.isbflagset(FLB_NATB) : + KSR.nathelper.set_contact_alias(); + + return 1; + + + # URI update for dialog requests + def ksr_route_dlguri(self, msg): + if not KSR.isdsturiset() : + KSR.nathelper.handle_ruri_alias(); + + return 1; + + + # Routing to foreign domains + def ksr_route_sipout(self, msg): + if KSR.is_myself(KSR.pv.get("$ru")) : + return 1; + + KSR.hdr.append("P-Hint: outbound\r\n"); + self.ksr_route_relay(msg); + return -255; + + + # Manage outgoing branches + def ksr_branch_manage(self, msg): + KSR.dbg("new branch ["+ str(KSR.pv.get("$T_branch_idx")) + + " to "+ KSR.pv.get("$ru") + "\n"); + self.ksr_route_natmanage(msg); + return 1; + + + # Manage incoming replies + def ksr_onreply_manage(self, msg): + KSR.dbg("incoming reply\n"); + scode = KSR.pv.get("$rs"); + if scode>100 and scode<299 : + self.ksr_route_natmanage(msg); + + return 1; + + + # Manage failure routing cases + def ksr_failure_manage(self, msg): + if self.ksr_route_natmanage()==-255 : return 1; + + if KSR.tm.t_is_canceled()>0 : + return 1; + + return 1; + + + def ksr_reply_route(self, msg): + KSR.info("===== response - from kamailio python script\n"); + return 1; +