Add media encryption options.

livekit · Dec 12, 2024 · edf00ba · edf00ba
1 parent 933b7ff
commit edf00ba
Show file tree

Hide file tree

Showing 12 changed files with 1,113 additions and 917 deletions.
diff --git a/.changeset/healthy-poets-tan.md b/.changeset/healthy-poets-tan.md
@@ -0,0 +1,6 @@
+---
+"@livekit/protocol": minor
+"github.com/livekit/protocol": minor
+---
+
+Add media encryption options for SIP.
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/protobufs/livekit_sip.proto b/protobufs/livekit_sip.proto
@@ -111,6 +111,12 @@ enum SIPTransport {
   SIP_TRANSPORT_TLS = 3;
 }
 
+enum SIPMediaEncryption {
+  SIP_MEDIA_ENCRYPT_DISABLE = 0; // do not enable encryption
+  SIP_MEDIA_ENCRYPT_ALLOW = 1; // use encryption if available
+  SIP_MEDIA_ENCRYPT_REQUIRE = 2; // require encryption
+}
+
 message SIPTrunkInfo {
   option deprecated = true;
 
@@ -201,8 +207,9 @@ message SIPInboundTrunkInfo {
   google.protobuf.Duration max_call_duration = 12;
 
   bool krisp_enabled = 13;
+  SIPMediaEncryption media_encryption = 15;
 
-  // NEXT ID: 15
+  // NEXT ID: 16
 }
 
 message CreateSIPOutboundTrunkRequest {
@@ -242,7 +249,8 @@ message SIPOutboundTrunkInfo {
   // 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
+  SIPMediaEncryption media_encryption = 12;
+  // NEXT ID: 13
 }
 
 message GetSIPInboundTrunkRequest {
@@ -385,7 +393,10 @@ message SIPDispatchRuleInfo {
   // Participants created by this rule will inherit these attributes.
   map<string, string> attributes = 8;
 
-  // NEXT ID: 9
+  bool krisp_enabled = 9;
+  SIPMediaEncryption media_encryption = 10;
+
+  // NEXT ID: 11
 }
 
 // ListSIPDispatchRuleRequest lists dispatch rules for given filters. If no filters are set, all rules are listed.
@@ -452,8 +463,10 @@ message CreateSIPParticipantRequest {
   google.protobuf.Duration max_call_duration = 12;
 
   // Enable voice isolation for the callee.
-  bool enable_krisp = 14;
-  // NEXT ID: 17
+  bool krisp_enabled = 14;
+  SIPMediaEncryption media_encryption = 17;
+
+  // NEXT ID: 18
 }
 
 message SIPParticipantInfo {

diff --git a/protobufs/rpc/io.proto b/protobufs/rpc/io.proto
@@ -179,7 +179,9 @@ message EvaluateSIPDispatchRulesResponse {
   // Max call duration.
   google.protobuf.Duration max_call_duration = 17;
 
-  // NEXT ID: 19
+  livekit.SIPMediaEncryption media_encryption = 19;
+
+  // NEXT ID: 20
 }
 
 message UpdateSIPCallStateRequest {

diff --git a/protobufs/rpc/sip.proto b/protobufs/rpc/sip.proto
@@ -92,7 +92,9 @@ message InternalCreateSIPParticipantRequest {
   // Max call duration.
   google.protobuf.Duration max_call_duration = 24;
 
-  // NEXT ID: 27
+  livekit.SIPMediaEncryption media_encryption = 27;
+
+  // NEXT ID: 28
 }
 
 message InternalCreateSIPParticipantResponse {

diff --git a/rpc/io.pb.go b/rpc/io.pb.go
diff --git a/rpc/io.psrpc.go b/rpc/io.psrpc.go
diff --git a/rpc/sip.go b/rpc/sip.go
@@ -50,9 +50,13 @@ func NewCreateSIPParticipantRequest(
 	}
 
 	var features []livekit.SIPFeature
-	if req.EnableKrisp {
+	if req.KrispEnabled {
 		features = append(features, livekit.SIPFeature_KRISP_ENABLED)
 	}
+	enc := trunk.MediaEncryption
+	if req.MediaEncryption != 0 {
+		enc = req.MediaEncryption
+	}
 
 	headers := trunk.Headers
 	if len(req.Headers) != 0 {
@@ -91,5 +95,6 @@ func NewCreateSIPParticipantRequest(
 		EnabledFeatures:       features,
 		RingingTimeout:        req.RingingTimeout,
 		MaxCallDuration:       req.MaxCallDuration,
+		MediaEncryption:       enc,
 	}, nil
 }
diff --git a/rpc/sip.pb.go b/rpc/sip.pb.go
diff --git a/rpc/sip.psrpc.go b/rpc/sip.psrpc.go
diff --git a/sip/sip.go b/sip/sip.go
@@ -25,7 +25,6 @@ import (
 	"strings"
 
 	"github.com/twitchtv/twirp"
-
 	"golang.org/x/exp/slices"
 
 	"github.com/livekit/protocol/livekit"
@@ -513,15 +512,24 @@ func EvaluateDispatchRule(projectID string, trunk *livekit.SIPInboundTrunkInfo,
 		ParticipantMetadata:   rule.Metadata,
 		ParticipantAttributes: attrs,
 	}
+	krispEnabled := false
 	if trunk != nil {
 		resp.Headers = trunk.Headers
 		resp.HeadersToAttributes = trunk.HeadersToAttributes
 		resp.AttributesToHeaders = trunk.AttributesToHeaders
 		resp.RingingTimeout = trunk.RingingTimeout
 		resp.MaxCallDuration = trunk.MaxCallDuration
-		if trunk.KrispEnabled {
-			resp.EnabledFeatures = append(resp.EnabledFeatures, livekit.SIPFeature_KRISP_ENABLED)
+		resp.MediaEncryption = trunk.MediaEncryption
+		krispEnabled = krispEnabled || trunk.KrispEnabled
+	}
+	if rule != nil {
+		krispEnabled = krispEnabled || rule.KrispEnabled
+		if rule.MediaEncryption != 0 {
+			resp.MediaEncryption = rule.MediaEncryption
 		}
 	}
+	if krispEnabled {
+		resp.EnabledFeatures = append(resp.EnabledFeatures, livekit.SIPFeature_KRISP_ENABLED)
+	}
 	return resp, nil
 }