Map participant attributes to SIP headers. (#893)

livekit · Nov 27, 2024 · 9e70d56 · 9e70d56
1 parent 4051190
commit 9e70d56
Show file tree

Hide file tree

Showing 13 changed files with 1,151 additions and 1,004 deletions.
diff --git a/.changeset/slow-planes-design.md b/.changeset/slow-planes-design.md
@@ -0,0 +1,6 @@
+---
+"@livekit/protocol": minor
+"github.com/livekit/protocol": minor
+---
+
+Map participant attributes to SIP headers.
diff --git a/livekit/livekit_sip.pb.go b/livekit/livekit_sip.pb.go
diff --git a/livekit/livekit_sip.twirp.go b/livekit/livekit_sip.twirp.go
diff --git a/livekit/sip.go b/livekit/sip.go
@@ -101,11 +101,27 @@ func (p *SIPOutboundTrunkInfo) AsTrunkInfo() *SIPTrunkInfo {
 	}
 }
 
-func validateHeaders(headers map[string]string) error {
+func validateHeader(header string) error {
+	v := strings.ToLower(header)
+	if !strings.HasPrefix(v, "x-") {
+		return fmt.Errorf("only X-* headers are allowed: %s", header)
+	}
+	return nil
+}
+
+func validateHeaderKeys(headers map[string]string) error {
 	for k := range headers {
-		k = strings.ToLower(k)
-		if !strings.HasPrefix(k, "x-") {
-			return fmt.Errorf("only X-* headers are allowed: %s", k)
+		if err := validateHeader(k); err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
+func validateHeaderValues(headers map[string]string) error {
+	for _, v := range headers {
+		if err := validateHeader(v); err != nil {
+			return err
 		}
 	}
 	return nil
@@ -151,10 +167,13 @@ func (p *SIPInboundTrunkInfo) Validate() error {
 	if !hasAuth && !hasCIDR && !hasNumbers {
 		return errors.New("for security, one of the fields must be set: AuthUsername+AuthPassword, AllowedAddresses or Numbers")
 	}
-	if err := validateHeaders(p.Headers); err != nil {
+	if err := validateHeaderKeys(p.Headers); err != nil {
+		return err
+	}
+	if err := validateHeaderKeys(p.HeadersToAttributes); err != nil {
 		return err
 	}
-	if err := validateHeaders(p.HeadersToAttributes); err != nil {
+	if err := validateHeaderValues(p.AttributesToHeaders); err != nil {
 		return err
 	}
 	return nil
@@ -171,10 +190,13 @@ func (p *SIPOutboundTrunkInfo) Validate() error {
 	} else if strings.ContainsAny(p.Address, "@;") || strings.HasPrefix(p.Address, "sip:") || strings.HasPrefix(p.Address, "sips:") {
 		return errors.New("trunk address should be a hostname or IP, not SIP URI")
 	}
-	if err := validateHeaders(p.Headers); err != nil {
+	if err := validateHeaderKeys(p.Headers); err != nil {
+		return err
+	}
+	if err := validateHeaderKeys(p.HeadersToAttributes); err != nil {
 		return err
 	}
-	if err := validateHeaders(p.HeadersToAttributes); err != nil {
+	if err := validateHeaderValues(p.AttributesToHeaders); err != nil {
 		return err
 	}
 	return nil

diff --git a/protobufs/livekit_sip.proto b/protobufs/livekit_sip.proto
@@ -190,13 +190,18 @@ message SIPInboundTrunkInfo {
   map<string, string> headers = 9;
   // Map SIP X-* headers from INVITE to SIP participant attributes.
   map<string, string> headers_to_attributes = 10;
+  // Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.
+  // Keys are the names of attributes and values are the names of X-* headers they will be mapped to.
+  map<string, string> attributes_to_headers = 14;
 
   // Max time for the caller to wait for track subscription.
   google.protobuf.Duration ringing_timeout = 11;
   // Max call duration.
   google.protobuf.Duration max_call_duration = 12;
 
   bool krisp_enabled = 13;
+
+  // NEXT ID: 15
 }
 
 message CreateSIPOutboundTrunkRequest {
@@ -232,6 +237,11 @@ message SIPOutboundTrunkInfo {
   // Map SIP X-* headers from 200 OK to SIP participant attributes.
   // Keys are the names of X-* headers and values are the names of attributes they will be mapped to.
   map<string, string> headers_to_attributes = 10;
+  // Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.
+  // Keys are the names of attributes and values are the names of X-* headers they will be mapped to.
+  map<string, string> attributes_to_headers = 11;
+
+  // NEXT ID: 12
 }
 
 message GetSIPInboundTrunkRequest {

diff --git a/protobufs/rpc/io.proto b/protobufs/rpc/io.proto
@@ -168,6 +168,9 @@ message EvaluateSIPDispatchRulesResponse {
   // Map SIP X-* headers from INVITE to SIP participant attributes.
   // Keys are the names of X-* headers and values are the names of attributes they will be mapped to.
   map<string, string> headers_to_attributes = 14;
+  // Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.
+  // Keys are the names of attributes and values are the names of X-* headers they will be mapped to.
+  map<string, string> attributes_to_headers = 18;
 
   repeated livekit.SIPFeature enabled_features = 15;
 
@@ -176,7 +179,7 @@ message EvaluateSIPDispatchRulesResponse {
   // Max call duration.
   google.protobuf.Duration max_call_duration = 17;
 
-  // NEXT ID: 18
+  // NEXT ID: 19
 }
 
 message UpdateSIPCallStateRequest {

diff --git a/protobufs/rpc/sip.proto b/protobufs/rpc/sip.proto
@@ -81,6 +81,9 @@ message InternalCreateSIPParticipantRequest {
 
   map<string, string> headers = 21;
   map<string, string> headers_to_attributes = 22;
+  // Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.
+  // Keys are the names of attributes and values are the names of X-* headers they will be mapped to.
+  map<string, string> attributes_to_headers = 26;
 
   repeated livekit.SIPFeature enabled_features = 25;
 
@@ -89,7 +92,7 @@ message InternalCreateSIPParticipantRequest {
   // Max call duration.
   google.protobuf.Duration max_call_duration = 24;
 
-  // NEXT ID: 26
+  // NEXT ID: 27
 }
 
 message InternalCreateSIPParticipantResponse {