Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add test for ServerKeyExchange and PSK #636

Merged
merged 1 commit into from
May 31, 2024
Merged

Add test for ServerKeyExchange and PSK #636

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion conn.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -969,7 +969,7 @@ func (c *Conn) isHandshakeCompletedSuccessfully() bool {
return boolean.bool
}

func (c *Conn) handshake(ctx context.Context, cfg *handshakeConfig, initialFlight flightVal, initialState handshakeState) error { //nolint:gocognit
func (c *Conn) handshake(ctx context.Context, cfg *handshakeConfig, initialFlight flightVal, initialState handshakeState) error { //nolint:gocognit,contextcheck
c.fsm = newHandshakeFSM(&c.state, c.handshakeCache, cfg, initialFlight)

done := make(chan struct{})
Expand Down
118 changes: 112 additions & 6 deletions conn_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -539,6 +539,7 @@ func TestPSK(t *testing.T) {

for _, test := range []struct {
Name string
ClientIdentity []byte
ServerIdentity []byte
CipherSuites []CipherSuiteID
ClientVerifyConnection func(*State) error
Expand All @@ -550,11 +551,13 @@ func TestPSK(t *testing.T) {
{
Name: "Server identity specified",
ServerIdentity: []byte("Test Identity"),
ClientIdentity: []byte("Client Identity"),
CipherSuites: []CipherSuiteID{TLS_PSK_WITH_AES_128_CCM_8},
},
{
Name: "Server identity specified - Server verify connection fails",
ServerIdentity: []byte("Test Identity"),
ClientIdentity: []byte("Client Identity"),
CipherSuites: []CipherSuiteID{TLS_PSK_WITH_AES_128_CCM_8},
ServerVerifyConnection: func(*State) error {
return errExample
Expand All @@ -566,6 +569,7 @@ func TestPSK(t *testing.T) {
{
Name: "Server identity specified - Client verify connection fails",
ServerIdentity: []byte("Test Identity"),
ClientIdentity: []byte("Client Identity"),
CipherSuites: []CipherSuiteID{TLS_PSK_WITH_AES_128_CCM_8},
ClientVerifyConnection: func(*State) error {
return errExample
Expand All @@ -577,25 +581,33 @@ func TestPSK(t *testing.T) {
{
Name: "Server identity nil",
ServerIdentity: nil,
ClientIdentity: []byte("Client Identity"),
CipherSuites: []CipherSuiteID{TLS_PSK_WITH_AES_128_CCM_8},
},
{
Name: "TLS_PSK_WITH_AES_128_CBC_SHA256",
ServerIdentity: nil,
ClientIdentity: []byte("Client Identity"),
CipherSuites: []CipherSuiteID{TLS_PSK_WITH_AES_128_CBC_SHA256},
},
{
Name: "TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256",
ServerIdentity: nil,
ClientIdentity: []byte("Client Identity"),
CipherSuites: []CipherSuiteID{TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256},
},
{
Name: "Client identity empty",
ServerIdentity: nil,
ClientIdentity: []byte{},
CipherSuites: []CipherSuiteID{TLS_PSK_WITH_AES_128_CCM_8},
},
} {
test := test
t.Run(test.Name, func(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()

clientIdentity := []byte("Client Identity")
type result struct {
c *Conn
err error
Expand All @@ -612,7 +624,7 @@ func TestPSK(t *testing.T) {

return []byte{0xAB, 0xC1, 0x23}, nil
},
PSKIdentityHint: clientIdentity,
PSKIdentityHint: test.ClientIdentity,
CipherSuites: test.CipherSuites,
VerifyConnection: test.ClientVerifyConnection,
}
Expand All @@ -623,8 +635,9 @@ func TestPSK(t *testing.T) {

config := &Config{
PSK: func(hint []byte) ([]byte, error) {
if !bytes.Equal(clientIdentity, hint) {
return nil, fmt.Errorf("%w: expected(% 02x) actual(% 02x)", errTestPSKInvalidIdentity, clientIdentity, hint)
fmt.Println(hint)
if !bytes.Equal(test.ClientIdentity, hint) {
return nil, fmt.Errorf("%w: expected(% 02x) actual(% 02x)", errTestPSKInvalidIdentity, test.ClientIdentity, hint)
}
return []byte{0xAB, 0xC1, 0x23}, nil
},
Expand All @@ -649,8 +662,8 @@ func TestPSK(t *testing.T) {
}

actualPSKIdentityHint := server.ConnectionState().IdentityHint
if !bytes.Equal(actualPSKIdentityHint, clientIdentity) {
t.Errorf("TestPSK: Server ClientPSKIdentity Mismatch '%s': expected(%v) actual(%v)", test.Name, clientIdentity, actualPSKIdentityHint)
if !bytes.Equal(actualPSKIdentityHint, test.ClientIdentity) {
t.Errorf("TestPSK: Server ClientPSKIdentity Mismatch '%s': expected(%v) actual(%v)", test.Name, test.ClientIdentity, actualPSKIdentityHint)
}

defer func() {
Expand Down Expand Up @@ -713,6 +726,99 @@ func TestPSKHintFail(t *testing.T) {
}
}

// Assert that ServerKeyExchange is only sent if Identity is set on server side
func TestPSKServerKeyExchange(t *testing.T) {
// Limit runtime in case of deadlocks
lim := test.TimeOut(time.Second * 20)
defer lim.Stop()

// Check for leaking routines
report := test.CheckRoutines(t)
defer report()

for _, test := range []struct {
Name string
SetIdentity bool
}{
{
Name: "Server Identity Set",
SetIdentity: true,
},
{
Name: "Server Not Identity Set",
SetIdentity: false,
},
} {
test := test
t.Run(test.Name, func(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
gotServerKeyExchange := false

clientErr := make(chan error, 1)
ca, cb := dpipe.Pipe()
cbAnalyzer := &connWithCallback{Conn: cb}
cbAnalyzer.onWrite = func(in []byte) {
messages, err := recordlayer.UnpackDatagram(in)
if err != nil {
t.Fatal(err)
}

for i := range messages {
h := &handshake.Handshake{}
_ = h.Unmarshal(messages[i][recordlayer.FixedHeaderSize:])

if h.Header.Type == handshake.TypeServerKeyExchange {
gotServerKeyExchange = true
}
}
}

go func() {
conf := &Config{
PSK: func([]byte) ([]byte, error) {
return []byte{0xAB, 0xC1, 0x23}, nil
},
PSKIdentityHint: []byte{0xAB, 0xC1, 0x23},
CipherSuites: []CipherSuiteID{TLS_PSK_WITH_AES_128_CCM_8},
}

if client, err := testClient(ctx, dtlsnet.PacketConnFromConn(ca), ca.RemoteAddr(), conf, false); err != nil {
clientErr <- err
} else {
clientErr <- client.Close() //nolint
}
}()

config := &Config{
PSK: func([]byte) ([]byte, error) {
return []byte{0xAB, 0xC1, 0x23}, nil
},
CipherSuites: []CipherSuiteID{TLS_PSK_WITH_AES_128_CCM_8},
}
if test.SetIdentity {
config.PSKIdentityHint = []byte{0xAB, 0xC1, 0x23}
}

if server, err := testServer(ctx, dtlsnet.PacketConnFromConn(cbAnalyzer), cbAnalyzer.RemoteAddr(), config, false); err != nil {
t.Fatalf("TestPSK: Server error %v", err)
} else {
if err = server.Close(); err != nil {
t.Fatal(err)
}
}

if err := <-clientErr; err != nil {
t.Fatalf("TestPSK: Client error %v", err)
}

if gotServerKeyExchange != test.SetIdentity {
t.Fatalf("Mismatch between setting Identity and getting a ServerKeyExchange exp(%t) actual(%t)", test.SetIdentity, gotServerKeyExchange)
}
})
}
}

func TestClientTimeout(t *testing.T) {
// Limit runtime in case of deadlocks
lim := test.TimeOut(time.Second * 20)
Expand Down
2 changes: 1 addition & 1 deletion examples/dial/psk/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ func main() {
fmt.Printf("Server's hint: %s \n", hint)
return []byte{0xAB, 0xC1, 0x23}, nil
},
PSKIdentityHint: []byte("Pion DTLS Client"),
PSKIdentityHint: []byte{},
CipherSuites: []dtls.CipherSuiteID{dtls.TLS_PSK_WITH_AES_128_CCM_8},
ExtendedMasterSecret: dtls.RequireExtendedMasterSecret,
}
Expand Down
3 changes: 1 addition & 2 deletions examples/util/util.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import (
"errors"
"fmt"
"io"
"io/ioutil"
"net"
"os"
"path/filepath"
Expand Down Expand Up @@ -70,7 +69,7 @@ func LoadKeyAndCertificate(keyPath string, certificatePath string) (tls.Certific

// LoadCertificate Load/read certificate(s) from file
func LoadCertificate(path string) (*tls.Certificate, error) {
rawData, err := ioutil.ReadFile(filepath.Clean(path))
rawData, err := os.ReadFile(filepath.Clean(path))
if err != nil {
return nil, err
}
Expand Down
Loading