Add StartContext to ICE and DTLS Transport

dtlstransport.go

@@ -6,6 +6,7 @@
 package webrtc
 
 import (
+	"context"
 	"crypto/ecdsa"
 	"crypto/elliptic"
 	"crypto/rand"
@@ -301,6 +302,20 @@ func (t *DTLSTransport) role() DTLSRole {
 
 // Start DTLS transport negotiation with the parameters of the remote DTLS transport.
 func (t *DTLSTransport) Start(remoteParameters DTLSParameters) error {
+	ctx := context.Background()
+	if t.api.settingEngine.dtls.connectContextMaker != nil {
+		var cancel func()
+		ctx, cancel = t.api.settingEngine.dtls.connectContextMaker()
+		defer cancel()
+	}
+
+	return t.StartContext(ctx, remoteParameters)
+}
+
+// StartContext starts DTLS transport negotiation with the parameters of the remote DTLS
+// transport. If the context is canceled before the DTLS handshake is complete, the handshake
+// is interrupted and an error is returned.
+func (t *DTLSTransport) StartContext(ctx context.Context, remoteParameters DTLSParameters) error {
 	role, certificate, err := t.prepareStart(remoteParameters)
 	if err != nil {
 		return err
@@ -319,7 +334,7 @@ func (t *DTLSTransport) Start(remoteParameters DTLSParameters) error {
 		return t.failStart(err)
 	}
 
-	if err = t.handshakeDTLS(dtlsConn); err != nil {
+	if err = dtlsConn.HandshakeContext(ctx); err != nil {
 		dtlsEndpoint.SetOnClose(nil)
 		_ = dtlsConn.Close()
 

dtlstransport_test.go

@@ -216,7 +216,7 @@ func (c *failingPacketConn) SetReadDeadline(time.Time) error  { return nil }
 func (c *failingPacketConn) SetWriteDeadline(time.Time) error { return nil }
 
 func TestDTLSTransport_Start_ErrICEConnectionNotStarted(t *testing.T) {
-	transport := &DTLSTransport{state: DTLSTransportStateNew}
+	transport := &DTLSTransport{api: NewAPI(), state: DTLSTransportStateNew}
 
 	err := transport.Start(DTLSParameters{Role: DTLSRoleServer})
 	assert.ErrorIs(t, err, errICEConnectionNotStarted)

icetransport.go

@@ -87,7 +87,20 @@ func NewICETransport(gatherer *ICEGatherer, loggerFactory logging.LoggerFactory)
 }
 
 // Start incoming connectivity checks based on its configured role.
-func (t *ICETransport) Start(gatherer *ICEGatherer, params ICEParameters, role *ICERole) error { //nolint:cyclop
+func (t *ICETransport) Start(gatherer *ICEGatherer, params ICEParameters, role *ICERole) error {
+	return t.StartContext(context.Background(), gatherer, params, role)
+}
+
+// StartContext incoming connectivity checks based on its configured role.
+// If the context is canceled, the ICE transport will stop.
+//
+//nolint:cyclop
+func (t *ICETransport) StartContext(
+	ctx context.Context,
+	gatherer *ICEGatherer,
+	params ICEParameters,
+	role *ICERole,
+) error {
 	t.lock.Lock()
 	defer t.lock.Unlock()
 
@@ -134,7 +147,7 @@ func (t *ICETransport) Start(gatherer *ICEGatherer, params ICEParameters, role *
 	}
 	t.role = *role
 
-	ctx, ctxCancel := context.WithCancel(context.Background())
+	ctx, ctxCancel := context.WithCancel(ctx)
 	t.ctxCancel = ctxCancel
 
 	// Drop the lock here to allow ICE candidates to be
@@ -161,6 +174,17 @@ func (t *ICETransport) Start(gatherer *ICEGatherer, params ICEParameters, role *
 	// Reacquire the lock to set the connection/mux
 	t.lock.Lock()
 	if err != nil {
+		if ctxErr := ctx.Err(); ctxErr != nil {
+			t.lock.Unlock()
+			_ = t.Stop()
+			t.lock.Lock()
+
+			return ctxErr
+		}
+
+		ctxCancel()
+		t.ctxCancel = nil
+
 		return err
 	}
 

icetransport_test.go

@@ -6,6 +6,7 @@
 package webrtc
 
 import (
+	"context"
 	"sync"
 	"sync/atomic"
 	"testing"
@@ -15,6 +16,34 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
+func TestICETransport_StartContextClosesOnCancel(t *testing.T) {
+	lim := test.TimeOut(time.Second * 30)
+	defer lim.Stop()
+
+	api := NewAPI()
+	gatherer, err := api.NewICEGatherer(ICEGatherOptions{})
+	assert.NoError(t, err)
+
+	remoteGatherer, err := api.NewICEGatherer(ICEGatherOptions{})
+	assert.NoError(t, err)
+
+	params, err := remoteGatherer.GetLocalParameters()
+	assert.NoError(t, err)
+	defer func() {
+		assert.NoError(t, remoteGatherer.Close())
+	}()
+
+	transport := api.NewICETransport(gatherer)
+	ctx, cancel := context.WithCancel(context.Background())
+	cancel()
+
+	controlling := ICERoleControlling
+	err = transport.StartContext(ctx, nil, params, &controlling)
+	assert.ErrorIs(t, err, context.Canceled)
+	assert.Equal(t, ICEGathererStateClosed, gatherer.State())
+	assert.Nil(t, gatherer.getAgent())
+}
+
 func TestICETransport_OnConnectionStateChange(t *testing.T) {
 	report := test.CheckRoutines(t)
 	defer report()