fix: enhance loose routing handling in SIP headers and URI parsing #110

Author: shenjinti

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rsipstack"
-version = "0.5.1"
+version = "0.5.2"
 edition = "2021"
 description = "SIP Stack Rust library for building SIP applications"
 license = "MIT"

src/sip/headers/typed/record_route.rs

@@ -1,5 +1,5 @@
 use super::parse_helpers::parse_display_uri_params_str;
-use crate::sip::{uri::Param, Error, Header, Uri};
+use crate::sip::{uri::Param, uri::ParamsExt, Error, Header, Uri};
 
 #[derive(Debug, PartialEq, Eq, Clone)]
 pub struct RecordRoute {
@@ -62,7 +62,7 @@ impl RecordRoute {
     }
 
     pub fn has_lr(&self) -> bool {
-        self.uri.params.iter().any(|p| matches!(p, Param::Lr))
+        self.uri.has_lr()
     }
 }
 
@@ -145,6 +145,7 @@ mod tests {
 
     #[test]
     fn record_route_with_transport() {
+        use crate::sip::Param;
         use crate::sip::Transport;
         let rr = RecordRoute::parse("<sip:proxy.restsend.com;transport=tcp;lr>").unwrap();
         assert!(rr.has_lr());
@@ -154,4 +155,11 @@ mod tests {
             .iter()
             .any(|p| matches!(p, Param::Transport(Transport::Tcp))));
     }
+
+    #[test]
+    fn record_route_lr_on_is_treated_as_loose_route() {
+        let rr = RecordRoute::parse("<sip:proxy.restsend.com;lr=on>").unwrap();
+        assert!(rr.has_lr());
+        assert_eq!(rr.uri.to_string(), "sip:proxy.restsend.com;lr=on");
+    }
 }

src/sip/headers/typed/route.rs

@@ -1,5 +1,5 @@
 use super::parse_helpers::parse_display_uri_params_str;
-use crate::sip::{uri::Param, Error, Header, Uri};
+use crate::sip::{uri::Param, uri::ParamsExt, Error, Header, Uri};
 
 #[derive(Debug, PartialEq, Eq, Clone)]
 pub struct Route {
@@ -62,7 +62,7 @@ impl Route {
     }
 
     pub fn has_lr(&self) -> bool {
-        self.uri.params.iter().any(|p| matches!(p, Param::Lr))
+        self.uri.has_lr()
     }
 
     pub fn has_ob(&self) -> bool {
@@ -182,6 +182,7 @@ mod tests {
 
     #[test]
     fn route_with_transport_param() {
+        use crate::sip::uri::Param;
         use crate::sip::Transport;
         let r = Route::parse("<sip:proxy.restsend.com;transport=tcp;lr>").unwrap();
         assert!(r.has_lr());
@@ -191,4 +192,11 @@ mod tests {
             .iter()
             .any(|p| matches!(p, Param::Transport(Transport::Tcp))));
     }
+
+    #[test]
+    fn route_lr_on_is_treated_as_loose_route() {
+        let r = Route::parse("<sip:proxy.restsend.com;lr=on>").unwrap();
+        assert!(r.has_lr());
+        assert_eq!(r.uri.to_string(), "sip:proxy.restsend.com;lr=on");
+    }
 }

src/sip/uri.rs

@@ -668,7 +668,12 @@ pub trait ParamsExt {
         })
     }
     fn has_lr(&self) -> bool {
-        self.params().iter().any(|p| matches!(p, Param::Lr))
+        self.params().iter().any(|p| {
+            matches!(p, Param::Lr)
+                || matches!(p, Param::Other(name, Some(value))
+                    if name.value().eq_ignore_ascii_case("lr")
+                        && value.value().eq_ignore_ascii_case("on"))
+        })
     }
     fn expires(&self) -> Option<&str> {
         self.params().iter().find_map(|p| {
@@ -826,7 +831,7 @@ impl ParamsExt for Uri {
 
 #[cfg(test)]
 mod tests {
-    use super::{parse_uri, Host, Param, Scheme};
+    use super::{parse_uri, Host, Param, ParamsExt, Scheme};
 
     #[test]
     fn uri_param_value_keeps_colons_and_following_params() {
@@ -899,6 +904,13 @@ mod tests {
         assert_eq!(uri.to_string(), "sip:proxy.restsend.com;lr");
     }
 
+    #[test]
+    fn uri_lr_on_is_treated_as_loose_route() {
+        let uri = parse_uri("sip:proxy.restsend.com;lr=on").unwrap();
+        assert!(uri.has_lr());
+        assert_eq!(uri.to_string(), "sip:proxy.restsend.com;lr=on");
+    }
+
     #[test]
     fn uri_sips_scheme() {
         let uri = parse_uri("sips:alice@restsend.com").unwrap();

src/transaction/message.rs

@@ -2,6 +2,7 @@ use super::{endpoint::EndpointInner, make_call_id};
 use crate::sip::{
     prelude::{HeadersExt, ToTypedHeader},
     typed::Route as TypedRoute,
+    uri::ParamsExt,
     Error, Header, Request, Response, StatusCode, UriWithParams,
 };
 use crate::sip::{CallId, Method};
@@ -297,11 +298,7 @@ impl EndpointInner {
                 }
                 [head, rest @ ..] => {
                     // loose routing
-                    if head
-                        .params
-                        .iter()
-                        .any(|param| matches!(param, crate::sip::Param::Lr))
-                    {
+                    if head.has_lr() {
                         request_uri = remote_target_uri;
                         route_set
                     } else {

src/transaction/tests/test_client.rs

@@ -248,6 +248,12 @@ Content-Length: 0\r\n\r\n";
     let invite = make_invite_request("sip:bob@example.com")?;
     let ack = endpoint.inner.make_ack(&invite, &response)?;
 
+    let expected_uri = Uri::try_from("sip:uas@192.0.2.55:5080")?;
+    assert_eq!(
+        ack.uri, expected_uri,
+        "lr=on must be treated as loose routing so ACK targets Contact",
+    );
+
     let routes: Vec<String> = ack
         .headers
         .iter()
@@ -264,6 +270,15 @@ Content-Length: 0\r\n\r\n";
         "ACK Route headers must preserve du parameter values with colons and keep following params"
     );
 
+    assert_eq!(
+        routes,
+        vec![
+            "<sip:4.5.6.7:32222;lr=on;ftag=d4nwJ0jF>".to_string(),
+            "<sip:2.2.2.2;lr=on;ftag=d4nwJ0jF;du=sip:1.2.3.4:5060;did=893.d6d1>".to_string(),
+        ],
+        "lr=on route set must be handled as loose routing and keep reversed Record-Route order",
+    );
+
     Ok(())
 }