handshake_test.go 32 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241
  1. // Copyright 2013 The Go Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style
  3. // license that can be found in the LICENSE file.
  4. package ssh
  5. import (
  6. "bytes"
  7. "crypto/rand"
  8. "errors"
  9. "fmt"
  10. "io"
  11. "net"
  12. "reflect"
  13. "runtime"
  14. "strings"
  15. "sync"
  16. "testing"
  17. )
  18. type testChecker struct {
  19. calls []string
  20. }
  21. func (t *testChecker) Check(dialAddr string, addr net.Addr, key PublicKey) error {
  22. if dialAddr == "bad" {
  23. return fmt.Errorf("dialAddr is bad")
  24. }
  25. if tcpAddr, ok := addr.(*net.TCPAddr); !ok || tcpAddr == nil {
  26. return fmt.Errorf("testChecker: got %T want *net.TCPAddr", addr)
  27. }
  28. t.calls = append(t.calls, fmt.Sprintf("%s %v %s %x", dialAddr, addr, key.Type(), key.Marshal()))
  29. return nil
  30. }
  31. // netPipe is analogous to net.Pipe, but it uses a real net.Conn, and
  32. // therefore is buffered (net.Pipe deadlocks if both sides start with
  33. // a write.)
  34. func netPipe() (net.Conn, net.Conn, error) {
  35. listener, err := net.Listen("tcp", "127.0.0.1:0")
  36. if err != nil {
  37. listener, err = net.Listen("tcp", "[::1]:0")
  38. if err != nil {
  39. return nil, nil, err
  40. }
  41. }
  42. defer listener.Close()
  43. c1, err := net.Dial("tcp", listener.Addr().String())
  44. if err != nil {
  45. return nil, nil, err
  46. }
  47. c2, err := listener.Accept()
  48. if err != nil {
  49. c1.Close()
  50. return nil, nil, err
  51. }
  52. return c1, c2, nil
  53. }
  54. // noiseTransport inserts ignore messages to check that the read loop
  55. // and the key exchange filters out these messages.
  56. type noiseTransport struct {
  57. keyingTransport
  58. }
  59. func (t *noiseTransport) writePacket(p []byte) error {
  60. ignore := []byte{msgIgnore}
  61. if err := t.keyingTransport.writePacket(ignore); err != nil {
  62. return err
  63. }
  64. debug := []byte{msgDebug, 1, 2, 3}
  65. if err := t.keyingTransport.writePacket(debug); err != nil {
  66. return err
  67. }
  68. return t.keyingTransport.writePacket(p)
  69. }
  70. func addNoiseTransport(t keyingTransport) keyingTransport {
  71. return &noiseTransport{t}
  72. }
  73. // handshakePair creates two handshakeTransports connected with each
  74. // other. If the noise argument is true, both transports will try to
  75. // confuse the other side by sending ignore and debug messages.
  76. func handshakePair(clientConf *ClientConfig, addr string, noise bool) (client *handshakeTransport, server *handshakeTransport, err error) {
  77. a, b, err := netPipe()
  78. if err != nil {
  79. return nil, nil, err
  80. }
  81. var trC, trS keyingTransport
  82. trC = newTransport(a, rand.Reader, true)
  83. trS = newTransport(b, rand.Reader, false)
  84. if noise {
  85. trC = addNoiseTransport(trC)
  86. trS = addNoiseTransport(trS)
  87. }
  88. clientConf.SetDefaults()
  89. v := []byte("version")
  90. client = newClientTransport(trC, v, v, clientConf, addr, a.RemoteAddr())
  91. serverConf := &ServerConfig{}
  92. serverConf.AddHostKey(testSigners["ecdsa"])
  93. serverConf.AddHostKey(testSigners["rsa"])
  94. serverConf.SetDefaults()
  95. server = newServerTransport(trS, v, v, serverConf)
  96. if err := server.waitSession(); err != nil {
  97. return nil, nil, fmt.Errorf("server.waitSession: %v", err)
  98. }
  99. if err := client.waitSession(); err != nil {
  100. return nil, nil, fmt.Errorf("client.waitSession: %v", err)
  101. }
  102. return client, server, nil
  103. }
  104. func TestHandshakeBasic(t *testing.T) {
  105. if runtime.GOOS == "plan9" {
  106. t.Skip("see golang.org/issue/7237")
  107. }
  108. checker := &syncChecker{
  109. waitCall: make(chan int, 10),
  110. called: make(chan int, 10),
  111. }
  112. checker.waitCall <- 1
  113. trC, trS, err := handshakePair(&ClientConfig{HostKeyCallback: checker.Check}, "addr", false)
  114. if err != nil {
  115. t.Fatalf("handshakePair: %v", err)
  116. }
  117. defer trC.Close()
  118. defer trS.Close()
  119. // Let first kex complete normally.
  120. <-checker.called
  121. clientDone := make(chan int, 0)
  122. gotHalf := make(chan int, 0)
  123. const N = 20
  124. errorCh := make(chan error, 1)
  125. go func() {
  126. defer close(clientDone)
  127. // Client writes a bunch of stuff, and does a key
  128. // change in the middle. This should not confuse the
  129. // handshake in progress. We do this twice, so we test
  130. // that the packet buffer is reset correctly.
  131. for i := 0; i < N; i++ {
  132. p := []byte{msgRequestSuccess, byte(i)}
  133. if err := trC.writePacket(p); err != nil {
  134. errorCh <- err
  135. trC.Close()
  136. return
  137. }
  138. if (i % 10) == 5 {
  139. <-gotHalf
  140. // halfway through, we request a key change.
  141. trC.requestKeyExchange()
  142. // Wait until we can be sure the key
  143. // change has really started before we
  144. // write more.
  145. <-checker.called
  146. }
  147. if (i % 10) == 7 {
  148. // write some packets until the kex
  149. // completes, to test buffering of
  150. // packets.
  151. checker.waitCall <- 1
  152. }
  153. }
  154. errorCh <- nil
  155. }()
  156. // Server checks that client messages come in cleanly
  157. i := 0
  158. for ; i < N; i++ {
  159. p, err := trS.readPacket()
  160. if err != nil && err != io.EOF {
  161. t.Fatalf("server error: %v", err)
  162. }
  163. if (i % 10) == 5 {
  164. gotHalf <- 1
  165. }
  166. want := []byte{msgRequestSuccess, byte(i)}
  167. if bytes.Compare(p, want) != 0 {
  168. t.Errorf("message %d: got %v, want %v", i, p, want)
  169. }
  170. }
  171. <-clientDone
  172. if err := <-errorCh; err != nil {
  173. t.Fatalf("sendPacket: %v", err)
  174. }
  175. if i != N {
  176. t.Errorf("received %d messages, want 10.", i)
  177. }
  178. close(checker.called)
  179. if _, ok := <-checker.called; ok {
  180. // If all went well, we registered exactly 2 key changes: one
  181. // that establishes the session, and one that we requested
  182. // additionally.
  183. t.Fatalf("got another host key checks after 2 handshakes")
  184. }
  185. }
  186. func TestForceFirstKex(t *testing.T) {
  187. // like handshakePair, but must access the keyingTransport.
  188. checker := &testChecker{}
  189. clientConf := &ClientConfig{HostKeyCallback: checker.Check}
  190. a, b, err := netPipe()
  191. if err != nil {
  192. t.Fatalf("netPipe: %v", err)
  193. }
  194. var trC, trS keyingTransport
  195. trC = newTransport(a, rand.Reader, true)
  196. // This is the disallowed packet:
  197. trC.writePacket(Marshal(&serviceRequestMsg{serviceUserAuth}))
  198. // Rest of the setup.
  199. trS = newTransport(b, rand.Reader, false)
  200. clientConf.SetDefaults()
  201. v := []byte("version")
  202. client := newClientTransport(trC, v, v, clientConf, "addr", a.RemoteAddr())
  203. serverConf := &ServerConfig{}
  204. serverConf.AddHostKey(testSigners["ecdsa"])
  205. serverConf.AddHostKey(testSigners["rsa"])
  206. serverConf.SetDefaults()
  207. server := newServerTransport(trS, v, v, serverConf)
  208. defer client.Close()
  209. defer server.Close()
  210. // We setup the initial key exchange, but the remote side
  211. // tries to send serviceRequestMsg in cleartext, which is
  212. // disallowed.
  213. if err := server.waitSession(); err == nil {
  214. t.Errorf("server first kex init should reject unexpected packet")
  215. }
  216. }
  217. func TestHandshakeAutoRekeyWrite(t *testing.T) {
  218. checker := &syncChecker{
  219. called: make(chan int, 10),
  220. waitCall: nil,
  221. }
  222. clientConf := &ClientConfig{HostKeyCallback: checker.Check}
  223. clientConf.RekeyThreshold = 500
  224. trC, trS, err := handshakePair(clientConf, "addr", false)
  225. if err != nil {
  226. t.Fatalf("handshakePair: %v", err)
  227. }
  228. defer trC.Close()
  229. defer trS.Close()
  230. input := make([]byte, 251)
  231. input[0] = msgRequestSuccess
  232. done := make(chan int, 1)
  233. const numPacket = 5
  234. go func() {
  235. defer close(done)
  236. j := 0
  237. for ; j < numPacket; j++ {
  238. if p, err := trS.readPacket(); err != nil {
  239. break
  240. } else if !bytes.Equal(input, p) {
  241. t.Errorf("got packet type %d, want %d", p[0], input[0])
  242. }
  243. }
  244. if j != numPacket {
  245. t.Errorf("got %d, want 5 messages", j)
  246. }
  247. }()
  248. <-checker.called
  249. for i := 0; i < numPacket; i++ {
  250. p := make([]byte, len(input))
  251. copy(p, input)
  252. if err := trC.writePacket(p); err != nil {
  253. t.Errorf("writePacket: %v", err)
  254. }
  255. if i == 2 {
  256. // Make sure the kex is in progress.
  257. <-checker.called
  258. }
  259. }
  260. <-done
  261. }
  262. type syncChecker struct {
  263. waitCall chan int
  264. called chan int
  265. }
  266. func (c *syncChecker) Check(dialAddr string, addr net.Addr, key PublicKey) error {
  267. c.called <- 1
  268. if c.waitCall != nil {
  269. <-c.waitCall
  270. }
  271. return nil
  272. }
  273. func TestHandshakeAutoRekeyRead(t *testing.T) {
  274. sync := &syncChecker{
  275. called: make(chan int, 2),
  276. waitCall: nil,
  277. }
  278. clientConf := &ClientConfig{
  279. HostKeyCallback: sync.Check,
  280. }
  281. clientConf.RekeyThreshold = 500
  282. trC, trS, err := handshakePair(clientConf, "addr", false)
  283. if err != nil {
  284. t.Fatalf("handshakePair: %v", err)
  285. }
  286. defer trC.Close()
  287. defer trS.Close()
  288. packet := make([]byte, 501)
  289. packet[0] = msgRequestSuccess
  290. if err := trS.writePacket(packet); err != nil {
  291. t.Fatalf("writePacket: %v", err)
  292. }
  293. // While we read out the packet, a key change will be
  294. // initiated.
  295. errorCh := make(chan error, 1)
  296. go func() {
  297. _, err := trC.readPacket()
  298. errorCh <- err
  299. }()
  300. if err := <-errorCh; err != nil {
  301. t.Fatalf("readPacket(client): %v", err)
  302. }
  303. <-sync.called
  304. }
  305. // errorKeyingTransport generates errors after a given number of
  306. // read/write operations.
  307. type errorKeyingTransport struct {
  308. packetConn
  309. readLeft, writeLeft int
  310. }
  311. func (n *errorKeyingTransport) prepareKeyChange(*algorithms, *kexResult) error {
  312. return nil
  313. }
  314. func (n *errorKeyingTransport) getSessionID() []byte {
  315. return nil
  316. }
  317. func (n *errorKeyingTransport) writePacket(packet []byte) error {
  318. if n.writeLeft == 0 {
  319. n.Close()
  320. return errors.New("barf")
  321. }
  322. n.writeLeft--
  323. return n.packetConn.writePacket(packet)
  324. }
  325. func (n *errorKeyingTransport) readPacket() ([]byte, error) {
  326. if n.readLeft == 0 {
  327. n.Close()
  328. return nil, errors.New("barf")
  329. }
  330. n.readLeft--
  331. return n.packetConn.readPacket()
  332. }
  333. func (n *errorKeyingTransport) setStrictMode() error { return nil }
  334. func (n *errorKeyingTransport) setInitialKEXDone() {}
  335. func TestHandshakeErrorHandlingRead(t *testing.T) {
  336. for i := 0; i < 20; i++ {
  337. testHandshakeErrorHandlingN(t, i, -1, false)
  338. }
  339. }
  340. func TestHandshakeErrorHandlingWrite(t *testing.T) {
  341. for i := 0; i < 20; i++ {
  342. testHandshakeErrorHandlingN(t, -1, i, false)
  343. }
  344. }
  345. func TestHandshakeErrorHandlingReadCoupled(t *testing.T) {
  346. for i := 0; i < 20; i++ {
  347. testHandshakeErrorHandlingN(t, i, -1, true)
  348. }
  349. }
  350. func TestHandshakeErrorHandlingWriteCoupled(t *testing.T) {
  351. for i := 0; i < 20; i++ {
  352. testHandshakeErrorHandlingN(t, -1, i, true)
  353. }
  354. }
  355. // testHandshakeErrorHandlingN runs handshakes, injecting errors. If
  356. // handshakeTransport deadlocks, the go runtime will detect it and
  357. // panic.
  358. func testHandshakeErrorHandlingN(t *testing.T, readLimit, writeLimit int, coupled bool) {
  359. if (runtime.GOOS == "js" || runtime.GOOS == "wasip1") && runtime.GOARCH == "wasm" {
  360. t.Skipf("skipping on %s/wasm; see golang.org/issue/32840", runtime.GOOS)
  361. }
  362. msg := Marshal(&serviceRequestMsg{strings.Repeat("x", int(minRekeyThreshold)/4)})
  363. a, b := memPipe()
  364. defer a.Close()
  365. defer b.Close()
  366. key := testSigners["ecdsa"]
  367. serverConf := Config{RekeyThreshold: minRekeyThreshold}
  368. serverConf.SetDefaults()
  369. serverConn := newHandshakeTransport(&errorKeyingTransport{a, readLimit, writeLimit}, &serverConf, []byte{'a'}, []byte{'b'})
  370. serverConn.hostKeys = []Signer{key}
  371. go serverConn.readLoop()
  372. go serverConn.kexLoop()
  373. clientConf := Config{RekeyThreshold: 10 * minRekeyThreshold}
  374. clientConf.SetDefaults()
  375. clientConn := newHandshakeTransport(&errorKeyingTransport{b, -1, -1}, &clientConf, []byte{'a'}, []byte{'b'})
  376. clientConn.hostKeyAlgorithms = []string{key.PublicKey().Type()}
  377. clientConn.hostKeyCallback = InsecureIgnoreHostKey()
  378. go clientConn.readLoop()
  379. go clientConn.kexLoop()
  380. var wg sync.WaitGroup
  381. for _, hs := range []packetConn{serverConn, clientConn} {
  382. if !coupled {
  383. wg.Add(2)
  384. go func(c packetConn) {
  385. for i := 0; ; i++ {
  386. str := fmt.Sprintf("%08x", i) + strings.Repeat("x", int(minRekeyThreshold)/4-8)
  387. err := c.writePacket(Marshal(&serviceRequestMsg{str}))
  388. if err != nil {
  389. break
  390. }
  391. }
  392. wg.Done()
  393. c.Close()
  394. }(hs)
  395. go func(c packetConn) {
  396. for {
  397. _, err := c.readPacket()
  398. if err != nil {
  399. break
  400. }
  401. }
  402. wg.Done()
  403. }(hs)
  404. } else {
  405. wg.Add(1)
  406. go func(c packetConn) {
  407. for {
  408. _, err := c.readPacket()
  409. if err != nil {
  410. break
  411. }
  412. if err := c.writePacket(msg); err != nil {
  413. break
  414. }
  415. }
  416. wg.Done()
  417. }(hs)
  418. }
  419. }
  420. wg.Wait()
  421. }
  422. func TestDisconnect(t *testing.T) {
  423. if runtime.GOOS == "plan9" {
  424. t.Skip("see golang.org/issue/7237")
  425. }
  426. checker := &testChecker{}
  427. trC, trS, err := handshakePair(&ClientConfig{HostKeyCallback: checker.Check}, "addr", false)
  428. if err != nil {
  429. t.Fatalf("handshakePair: %v", err)
  430. }
  431. defer trC.Close()
  432. defer trS.Close()
  433. trC.writePacket([]byte{msgRequestSuccess, 0, 0})
  434. errMsg := &disconnectMsg{
  435. Reason: 42,
  436. Message: "such is life",
  437. }
  438. trC.writePacket(Marshal(errMsg))
  439. trC.writePacket([]byte{msgRequestSuccess, 0, 0})
  440. packet, err := trS.readPacket()
  441. if err != nil {
  442. t.Fatalf("readPacket 1: %v", err)
  443. }
  444. if packet[0] != msgRequestSuccess {
  445. t.Errorf("got packet %v, want packet type %d", packet, msgRequestSuccess)
  446. }
  447. _, err = trS.readPacket()
  448. if err == nil {
  449. t.Errorf("readPacket 2 succeeded")
  450. } else if !reflect.DeepEqual(err, errMsg) {
  451. t.Errorf("got error %#v, want %#v", err, errMsg)
  452. }
  453. _, err = trS.readPacket()
  454. if err == nil {
  455. t.Errorf("readPacket 3 succeeded")
  456. }
  457. }
  458. type mockKeyingTransport struct {
  459. packetConn
  460. kexInitAllowed chan struct{}
  461. kexInitSent chan struct{}
  462. }
  463. func (n *mockKeyingTransport) prepareKeyChange(*algorithms, *kexResult) error {
  464. return nil
  465. }
  466. func (n *mockKeyingTransport) writePacket(packet []byte) error {
  467. if packet[0] == msgKexInit {
  468. <-n.kexInitAllowed
  469. n.kexInitSent <- struct{}{}
  470. }
  471. return n.packetConn.writePacket(packet)
  472. }
  473. func (n *mockKeyingTransport) readPacket() ([]byte, error) {
  474. return n.packetConn.readPacket()
  475. }
  476. func (n *mockKeyingTransport) setStrictMode() error { return nil }
  477. func (n *mockKeyingTransport) setInitialKEXDone() {}
  478. func TestHandshakePendingPacketsWait(t *testing.T) {
  479. a, b := memPipe()
  480. trS := &mockKeyingTransport{
  481. packetConn: a,
  482. kexInitAllowed: make(chan struct{}, 2),
  483. kexInitSent: make(chan struct{}, 2),
  484. }
  485. // Allow the first KEX.
  486. trS.kexInitAllowed <- struct{}{}
  487. trC := &mockKeyingTransport{
  488. packetConn: b,
  489. kexInitAllowed: make(chan struct{}, 2),
  490. kexInitSent: make(chan struct{}, 2),
  491. }
  492. // Allow the first KEX.
  493. trC.kexInitAllowed <- struct{}{}
  494. clientConf := &ClientConfig{
  495. HostKeyCallback: InsecureIgnoreHostKey(),
  496. }
  497. clientConf.SetDefaults()
  498. v := []byte("version")
  499. client := newClientTransport(trC, v, v, clientConf, "addr", nil)
  500. serverConf := &ServerConfig{}
  501. serverConf.AddHostKey(testSigners["ecdsa"])
  502. serverConf.AddHostKey(testSigners["rsa"])
  503. serverConf.SetDefaults()
  504. server := newServerTransport(trS, v, v, serverConf)
  505. if err := server.waitSession(); err != nil {
  506. t.Fatalf("server.waitSession: %v", err)
  507. }
  508. if err := client.waitSession(); err != nil {
  509. t.Fatalf("client.waitSession: %v", err)
  510. }
  511. <-trC.kexInitSent
  512. <-trS.kexInitSent
  513. // Allow and request new KEX server side.
  514. trS.kexInitAllowed <- struct{}{}
  515. server.requestKeyExchange()
  516. // Wait until the KEX init is sent.
  517. <-trS.kexInitSent
  518. // The client is not allowed to respond to the KEX, so writes will be
  519. // blocked on the server side once the packets queue is full.
  520. for i := 0; i < maxPendingPackets; i++ {
  521. p := []byte{msgRequestSuccess, byte(i)}
  522. if err := server.writePacket(p); err != nil {
  523. t.Errorf("unexpected write error: %v", err)
  524. }
  525. }
  526. // The packets queue is now full, the next write will block.
  527. server.mu.Lock()
  528. if len(server.pendingPackets) != maxPendingPackets {
  529. t.Errorf("unexpected pending packets size; got: %d, want: %d", len(server.pendingPackets), maxPendingPackets)
  530. }
  531. server.mu.Unlock()
  532. writeDone := make(chan struct{})
  533. go func() {
  534. defer close(writeDone)
  535. p := []byte{msgRequestSuccess, byte(65)}
  536. // This write will block until KEX completes.
  537. err := server.writePacket(p)
  538. if err != nil {
  539. t.Errorf("unexpected write error: %v", err)
  540. }
  541. }()
  542. // Consume packets on the client side
  543. readDone := make(chan bool)
  544. go func() {
  545. defer close(readDone)
  546. for {
  547. if _, err := client.readPacket(); err != nil {
  548. if err != io.EOF {
  549. t.Errorf("unexpected read error: %v", err)
  550. }
  551. break
  552. }
  553. }
  554. }()
  555. // Allow the client to reply to the KEX and so unblock the write goroutine.
  556. trC.kexInitAllowed <- struct{}{}
  557. <-trC.kexInitSent
  558. <-writeDone
  559. // Close the client to unblock the read goroutine.
  560. client.Close()
  561. <-readDone
  562. server.Close()
  563. }
  564. func TestHandshakePendingPacketsError(t *testing.T) {
  565. a, b := memPipe()
  566. trS := &mockKeyingTransport{
  567. packetConn: a,
  568. kexInitAllowed: make(chan struct{}, 2),
  569. kexInitSent: make(chan struct{}, 2),
  570. }
  571. // Allow the first KEX.
  572. trS.kexInitAllowed <- struct{}{}
  573. trC := &mockKeyingTransport{
  574. packetConn: b,
  575. kexInitAllowed: make(chan struct{}, 2),
  576. kexInitSent: make(chan struct{}, 2),
  577. }
  578. // Allow the first KEX.
  579. trC.kexInitAllowed <- struct{}{}
  580. clientConf := &ClientConfig{
  581. HostKeyCallback: InsecureIgnoreHostKey(),
  582. }
  583. clientConf.SetDefaults()
  584. v := []byte("version")
  585. client := newClientTransport(trC, v, v, clientConf, "addr", nil)
  586. serverConf := &ServerConfig{}
  587. serverConf.AddHostKey(testSigners["ecdsa"])
  588. serverConf.AddHostKey(testSigners["rsa"])
  589. serverConf.SetDefaults()
  590. server := newServerTransport(trS, v, v, serverConf)
  591. if err := server.waitSession(); err != nil {
  592. t.Fatalf("server.waitSession: %v", err)
  593. }
  594. if err := client.waitSession(); err != nil {
  595. t.Fatalf("client.waitSession: %v", err)
  596. }
  597. <-trC.kexInitSent
  598. <-trS.kexInitSent
  599. // Allow and request new KEX server side.
  600. trS.kexInitAllowed <- struct{}{}
  601. server.requestKeyExchange()
  602. // Wait until the KEX init is sent.
  603. <-trS.kexInitSent
  604. // The client is not allowed to respond to the KEX, so writes will be
  605. // blocked on the server side once the packets queue is full.
  606. for i := 0; i < maxPendingPackets; i++ {
  607. p := []byte{msgRequestSuccess, byte(i)}
  608. if err := server.writePacket(p); err != nil {
  609. t.Errorf("unexpected write error: %v", err)
  610. }
  611. }
  612. // The packets queue is now full, the next write will block.
  613. writeDone := make(chan struct{})
  614. go func() {
  615. defer close(writeDone)
  616. p := []byte{msgRequestSuccess, byte(65)}
  617. // This write will block until KEX completes.
  618. err := server.writePacket(p)
  619. if err != io.EOF {
  620. t.Errorf("unexpected write error: %v", err)
  621. }
  622. }()
  623. // Consume packets on the client side
  624. readDone := make(chan bool)
  625. go func() {
  626. defer close(readDone)
  627. for {
  628. if _, err := client.readPacket(); err != nil {
  629. if err != io.EOF {
  630. t.Errorf("unexpected read error: %v", err)
  631. }
  632. break
  633. }
  634. }
  635. }()
  636. // Close the server to unblock the write after an error
  637. server.Close()
  638. <-writeDone
  639. // Unblock the pending write and close the client to unblock the read
  640. // goroutine.
  641. trC.kexInitAllowed <- struct{}{}
  642. client.Close()
  643. <-readDone
  644. }
  645. func TestHandshakeRekeyDefault(t *testing.T) {
  646. clientConf := &ClientConfig{
  647. Config: Config{
  648. Ciphers: []string{"aes128-ctr"},
  649. },
  650. HostKeyCallback: InsecureIgnoreHostKey(),
  651. }
  652. trC, trS, err := handshakePair(clientConf, "addr", false)
  653. if err != nil {
  654. t.Fatalf("handshakePair: %v", err)
  655. }
  656. defer trC.Close()
  657. defer trS.Close()
  658. trC.writePacket([]byte{msgRequestSuccess, 0, 0})
  659. trC.Close()
  660. rgb := (1024 + trC.readBytesLeft) >> 30
  661. wgb := (1024 + trC.writeBytesLeft) >> 30
  662. if rgb != 64 {
  663. t.Errorf("got rekey after %dG read, want 64G", rgb)
  664. }
  665. if wgb != 64 {
  666. t.Errorf("got rekey after %dG write, want 64G", wgb)
  667. }
  668. }
  669. func TestHandshakeAEADCipherNoMAC(t *testing.T) {
  670. for _, cipher := range []string{chacha20Poly1305ID, gcm128CipherID} {
  671. checker := &syncChecker{
  672. called: make(chan int, 1),
  673. }
  674. clientConf := &ClientConfig{
  675. Config: Config{
  676. Ciphers: []string{cipher},
  677. MACs: []string{},
  678. },
  679. HostKeyCallback: checker.Check,
  680. }
  681. trC, trS, err := handshakePair(clientConf, "addr", false)
  682. if err != nil {
  683. t.Fatalf("handshakePair: %v", err)
  684. }
  685. defer trC.Close()
  686. defer trS.Close()
  687. <-checker.called
  688. }
  689. }
  690. // TestNoSHA2Support tests a host key Signer that is not an AlgorithmSigner and
  691. // therefore can't do SHA-2 signatures. Ensures the server does not advertise
  692. // support for them in this case.
  693. func TestNoSHA2Support(t *testing.T) {
  694. c1, c2, err := netPipe()
  695. if err != nil {
  696. t.Fatalf("netPipe: %v", err)
  697. }
  698. defer c1.Close()
  699. defer c2.Close()
  700. serverConf := &ServerConfig{
  701. PasswordCallback: func(conn ConnMetadata, password []byte) (*Permissions, error) {
  702. return &Permissions{}, nil
  703. },
  704. }
  705. serverConf.AddHostKey(&legacyRSASigner{testSigners["rsa"]})
  706. go func() {
  707. _, _, _, err := NewServerConn(c1, serverConf)
  708. if err != nil {
  709. t.Error(err)
  710. }
  711. }()
  712. clientConf := &ClientConfig{
  713. User: "test",
  714. Auth: []AuthMethod{Password("testpw")},
  715. HostKeyCallback: FixedHostKey(testSigners["rsa"].PublicKey()),
  716. }
  717. if _, _, _, err := NewClientConn(c2, "", clientConf); err != nil {
  718. t.Fatal(err)
  719. }
  720. }
  721. func TestMultiAlgoSignerHandshake(t *testing.T) {
  722. algorithmSigner, ok := testSigners["rsa"].(AlgorithmSigner)
  723. if !ok {
  724. t.Fatal("rsa test signer does not implement the AlgorithmSigner interface")
  725. }
  726. multiAlgoSigner, err := NewSignerWithAlgorithms(algorithmSigner, []string{KeyAlgoRSASHA256, KeyAlgoRSASHA512})
  727. if err != nil {
  728. t.Fatalf("unable to create multi algorithm signer: %v", err)
  729. }
  730. c1, c2, err := netPipe()
  731. if err != nil {
  732. t.Fatalf("netPipe: %v", err)
  733. }
  734. defer c1.Close()
  735. defer c2.Close()
  736. serverConf := &ServerConfig{
  737. PasswordCallback: func(conn ConnMetadata, password []byte) (*Permissions, error) {
  738. return &Permissions{}, nil
  739. },
  740. }
  741. serverConf.AddHostKey(multiAlgoSigner)
  742. go NewServerConn(c1, serverConf)
  743. clientConf := &ClientConfig{
  744. User: "test",
  745. Auth: []AuthMethod{Password("testpw")},
  746. HostKeyCallback: FixedHostKey(testSigners["rsa"].PublicKey()),
  747. HostKeyAlgorithms: []string{KeyAlgoRSASHA512},
  748. }
  749. if _, _, _, err := NewClientConn(c2, "", clientConf); err != nil {
  750. t.Fatal(err)
  751. }
  752. }
  753. func TestMultiAlgoSignerNoCommonHostKeyAlgo(t *testing.T) {
  754. algorithmSigner, ok := testSigners["rsa"].(AlgorithmSigner)
  755. if !ok {
  756. t.Fatal("rsa test signer does not implement the AlgorithmSigner interface")
  757. }
  758. multiAlgoSigner, err := NewSignerWithAlgorithms(algorithmSigner, []string{KeyAlgoRSASHA256, KeyAlgoRSASHA512})
  759. if err != nil {
  760. t.Fatalf("unable to create multi algorithm signer: %v", err)
  761. }
  762. c1, c2, err := netPipe()
  763. if err != nil {
  764. t.Fatalf("netPipe: %v", err)
  765. }
  766. defer c1.Close()
  767. defer c2.Close()
  768. // ssh-rsa is disabled server side
  769. serverConf := &ServerConfig{
  770. PasswordCallback: func(conn ConnMetadata, password []byte) (*Permissions, error) {
  771. return &Permissions{}, nil
  772. },
  773. }
  774. serverConf.AddHostKey(multiAlgoSigner)
  775. go NewServerConn(c1, serverConf)
  776. // the client only supports ssh-rsa
  777. clientConf := &ClientConfig{
  778. User: "test",
  779. Auth: []AuthMethod{Password("testpw")},
  780. HostKeyCallback: FixedHostKey(testSigners["rsa"].PublicKey()),
  781. HostKeyAlgorithms: []string{KeyAlgoRSA},
  782. }
  783. _, _, _, err = NewClientConn(c2, "", clientConf)
  784. if err == nil {
  785. t.Fatal("succeeded connecting with no common hostkey algorithm")
  786. }
  787. }
  788. func TestPickIncompatibleHostKeyAlgo(t *testing.T) {
  789. algorithmSigner, ok := testSigners["rsa"].(AlgorithmSigner)
  790. if !ok {
  791. t.Fatal("rsa test signer does not implement the AlgorithmSigner interface")
  792. }
  793. multiAlgoSigner, err := NewSignerWithAlgorithms(algorithmSigner, []string{KeyAlgoRSASHA256, KeyAlgoRSASHA512})
  794. if err != nil {
  795. t.Fatalf("unable to create multi algorithm signer: %v", err)
  796. }
  797. signer := pickHostKey([]Signer{multiAlgoSigner}, KeyAlgoRSA)
  798. if signer != nil {
  799. t.Fatal("incompatible signer returned")
  800. }
  801. }
  802. func TestStrictKEXResetSeqFirstKEX(t *testing.T) {
  803. if runtime.GOOS == "plan9" {
  804. t.Skip("see golang.org/issue/7237")
  805. }
  806. checker := &syncChecker{
  807. waitCall: make(chan int, 10),
  808. called: make(chan int, 10),
  809. }
  810. checker.waitCall <- 1
  811. trC, trS, err := handshakePair(&ClientConfig{HostKeyCallback: checker.Check}, "addr", false)
  812. if err != nil {
  813. t.Fatalf("handshakePair: %v", err)
  814. }
  815. <-checker.called
  816. t.Cleanup(func() {
  817. trC.Close()
  818. trS.Close()
  819. })
  820. // Throw away the msgExtInfo packet sent during the handshake by the server
  821. _, err = trC.readPacket()
  822. if err != nil {
  823. t.Fatalf("readPacket failed: %s", err)
  824. }
  825. // close the handshake transports before checking the sequence number to
  826. // avoid races.
  827. trC.Close()
  828. trS.Close()
  829. // check that the sequence number counters. We reset after msgNewKeys, but
  830. // then the server immediately writes msgExtInfo, and we close the
  831. // transports so we expect read 2, write 0 on the client and read 1, write 1
  832. // on the server.
  833. if trC.conn.(*transport).reader.seqNum != 2 || trC.conn.(*transport).writer.seqNum != 0 ||
  834. trS.conn.(*transport).reader.seqNum != 1 || trS.conn.(*transport).writer.seqNum != 1 {
  835. t.Errorf(
  836. "unexpected sequence counters:\nclient: reader %d (expected 2), writer %d (expected 0)\nserver: reader %d (expected 1), writer %d (expected 1)",
  837. trC.conn.(*transport).reader.seqNum,
  838. trC.conn.(*transport).writer.seqNum,
  839. trS.conn.(*transport).reader.seqNum,
  840. trS.conn.(*transport).writer.seqNum,
  841. )
  842. }
  843. }
  844. func TestStrictKEXResetSeqSuccessiveKEX(t *testing.T) {
  845. if runtime.GOOS == "plan9" {
  846. t.Skip("see golang.org/issue/7237")
  847. }
  848. checker := &syncChecker{
  849. waitCall: make(chan int, 10),
  850. called: make(chan int, 10),
  851. }
  852. checker.waitCall <- 1
  853. trC, trS, err := handshakePair(&ClientConfig{HostKeyCallback: checker.Check}, "addr", false)
  854. if err != nil {
  855. t.Fatalf("handshakePair: %v", err)
  856. }
  857. <-checker.called
  858. t.Cleanup(func() {
  859. trC.Close()
  860. trS.Close()
  861. })
  862. // Throw away the msgExtInfo packet sent during the handshake by the server
  863. _, err = trC.readPacket()
  864. if err != nil {
  865. t.Fatalf("readPacket failed: %s", err)
  866. }
  867. // write and read five packets on either side to bump the sequence numbers
  868. for i := 0; i < 5; i++ {
  869. if err := trC.writePacket([]byte{msgRequestSuccess}); err != nil {
  870. t.Fatalf("writePacket failed: %s", err)
  871. }
  872. if _, err := trS.readPacket(); err != nil {
  873. t.Fatalf("readPacket failed: %s", err)
  874. }
  875. if err := trS.writePacket([]byte{msgRequestSuccess}); err != nil {
  876. t.Fatalf("writePacket failed: %s", err)
  877. }
  878. if _, err := trC.readPacket(); err != nil {
  879. t.Fatalf("readPacket failed: %s", err)
  880. }
  881. }
  882. // Request a key exchange, which should cause the sequence numbers to reset
  883. checker.waitCall <- 1
  884. trC.requestKeyExchange()
  885. <-checker.called
  886. // write a packet on the client, and then read it, to verify the key change has actually happened, since
  887. // the HostKeyCallback is called _during_ the handshake, so isn't actually indicative of the handshake
  888. // finishing.
  889. dummyPacket := []byte{99}
  890. if err := trS.writePacket(dummyPacket); err != nil {
  891. t.Fatalf("writePacket failed: %s", err)
  892. }
  893. if p, err := trC.readPacket(); err != nil {
  894. t.Fatalf("readPacket failed: %s", err)
  895. } else if !bytes.Equal(p, dummyPacket) {
  896. t.Fatalf("unexpected packet: got %x, want %x", p, dummyPacket)
  897. }
  898. // close the handshake transports before checking the sequence number to
  899. // avoid races.
  900. trC.Close()
  901. trS.Close()
  902. if trC.conn.(*transport).reader.seqNum != 2 || trC.conn.(*transport).writer.seqNum != 0 ||
  903. trS.conn.(*transport).reader.seqNum != 1 || trS.conn.(*transport).writer.seqNum != 1 {
  904. t.Errorf(
  905. "unexpected sequence counters:\nclient: reader %d (expected 2), writer %d (expected 0)\nserver: reader %d (expected 1), writer %d (expected 1)",
  906. trC.conn.(*transport).reader.seqNum,
  907. trC.conn.(*transport).writer.seqNum,
  908. trS.conn.(*transport).reader.seqNum,
  909. trS.conn.(*transport).writer.seqNum,
  910. )
  911. }
  912. }
  913. func TestSeqNumIncrease(t *testing.T) {
  914. if runtime.GOOS == "plan9" {
  915. t.Skip("see golang.org/issue/7237")
  916. }
  917. checker := &syncChecker{
  918. waitCall: make(chan int, 10),
  919. called: make(chan int, 10),
  920. }
  921. checker.waitCall <- 1
  922. trC, trS, err := handshakePair(&ClientConfig{HostKeyCallback: checker.Check}, "addr", false)
  923. if err != nil {
  924. t.Fatalf("handshakePair: %v", err)
  925. }
  926. <-checker.called
  927. t.Cleanup(func() {
  928. trC.Close()
  929. trS.Close()
  930. })
  931. // Throw away the msgExtInfo packet sent during the handshake by the server
  932. _, err = trC.readPacket()
  933. if err != nil {
  934. t.Fatalf("readPacket failed: %s", err)
  935. }
  936. // write and read five packets on either side to bump the sequence numbers
  937. for i := 0; i < 5; i++ {
  938. if err := trC.writePacket([]byte{msgRequestSuccess}); err != nil {
  939. t.Fatalf("writePacket failed: %s", err)
  940. }
  941. if _, err := trS.readPacket(); err != nil {
  942. t.Fatalf("readPacket failed: %s", err)
  943. }
  944. if err := trS.writePacket([]byte{msgRequestSuccess}); err != nil {
  945. t.Fatalf("writePacket failed: %s", err)
  946. }
  947. if _, err := trC.readPacket(); err != nil {
  948. t.Fatalf("readPacket failed: %s", err)
  949. }
  950. }
  951. // close the handshake transports before checking the sequence number to
  952. // avoid races.
  953. trC.Close()
  954. trS.Close()
  955. if trC.conn.(*transport).reader.seqNum != 7 || trC.conn.(*transport).writer.seqNum != 5 ||
  956. trS.conn.(*transport).reader.seqNum != 6 || trS.conn.(*transport).writer.seqNum != 6 {
  957. t.Errorf(
  958. "unexpected sequence counters:\nclient: reader %d (expected 7), writer %d (expected 5)\nserver: reader %d (expected 6), writer %d (expected 6)",
  959. trC.conn.(*transport).reader.seqNum,
  960. trC.conn.(*transport).writer.seqNum,
  961. trS.conn.(*transport).reader.seqNum,
  962. trS.conn.(*transport).writer.seqNum,
  963. )
  964. }
  965. }
  966. func TestStrictKEXUnexpectedMsg(t *testing.T) {
  967. if runtime.GOOS == "plan9" {
  968. t.Skip("see golang.org/issue/7237")
  969. }
  970. // Check that unexpected messages during the handshake cause failure
  971. _, _, err := handshakePair(&ClientConfig{HostKeyCallback: func(hostname string, remote net.Addr, key PublicKey) error { return nil }}, "addr", true)
  972. if err == nil {
  973. t.Fatal("handshake should fail when there are unexpected messages during the handshake")
  974. }
  975. trC, trS, err := handshakePair(&ClientConfig{HostKeyCallback: func(hostname string, remote net.Addr, key PublicKey) error { return nil }}, "addr", false)
  976. if err != nil {
  977. t.Fatalf("handshake failed: %s", err)
  978. }
  979. // Check that ignore/debug pacekts are still ignored outside of the handshake
  980. if err := trC.writePacket([]byte{msgIgnore}); err != nil {
  981. t.Fatalf("writePacket failed: %s", err)
  982. }
  983. if err := trC.writePacket([]byte{msgDebug}); err != nil {
  984. t.Fatalf("writePacket failed: %s", err)
  985. }
  986. dummyPacket := []byte{99}
  987. if err := trC.writePacket(dummyPacket); err != nil {
  988. t.Fatalf("writePacket failed: %s", err)
  989. }
  990. if p, err := trS.readPacket(); err != nil {
  991. t.Fatalf("readPacket failed: %s", err)
  992. } else if !bytes.Equal(p, dummyPacket) {
  993. t.Fatalf("unexpected packet: got %x, want %x", p, dummyPacket)
  994. }
  995. }
  996. func TestStrictKEXMixed(t *testing.T) {
  997. // Test that we still support a mixed connection, where one side sends kex-strict but the other
  998. // side doesn't.
  999. a, b, err := netPipe()
  1000. if err != nil {
  1001. t.Fatalf("netPipe failed: %s", err)
  1002. }
  1003. var trC, trS keyingTransport
  1004. trC = newTransport(a, rand.Reader, true)
  1005. trS = newTransport(b, rand.Reader, false)
  1006. trS = addNoiseTransport(trS)
  1007. clientConf := &ClientConfig{HostKeyCallback: func(hostname string, remote net.Addr, key PublicKey) error { return nil }}
  1008. clientConf.SetDefaults()
  1009. v := []byte("version")
  1010. client := newClientTransport(trC, v, v, clientConf, "addr", a.RemoteAddr())
  1011. serverConf := &ServerConfig{}
  1012. serverConf.AddHostKey(testSigners["ecdsa"])
  1013. serverConf.AddHostKey(testSigners["rsa"])
  1014. serverConf.SetDefaults()
  1015. transport := newHandshakeTransport(trS, &serverConf.Config, []byte("version"), []byte("version"))
  1016. transport.hostKeys = serverConf.hostKeys
  1017. transport.publicKeyAuthAlgorithms = serverConf.PublicKeyAuthAlgorithms
  1018. readOneFailure := make(chan error, 1)
  1019. go func() {
  1020. if _, err := transport.readOnePacket(true); err != nil {
  1021. readOneFailure <- err
  1022. }
  1023. }()
  1024. // Basically sendKexInit, but without the kex-strict extension algorithm
  1025. msg := &kexInitMsg{
  1026. KexAlgos: transport.config.KeyExchanges,
  1027. CiphersClientServer: transport.config.Ciphers,
  1028. CiphersServerClient: transport.config.Ciphers,
  1029. MACsClientServer: transport.config.MACs,
  1030. MACsServerClient: transport.config.MACs,
  1031. CompressionClientServer: supportedCompressions,
  1032. CompressionServerClient: supportedCompressions,
  1033. ServerHostKeyAlgos: []string{KeyAlgoRSASHA256, KeyAlgoRSASHA512, KeyAlgoRSA},
  1034. }
  1035. packet := Marshal(msg)
  1036. // writePacket destroys the contents, so save a copy.
  1037. packetCopy := make([]byte, len(packet))
  1038. copy(packetCopy, packet)
  1039. if err := transport.pushPacket(packetCopy); err != nil {
  1040. t.Fatalf("pushPacket: %s", err)
  1041. }
  1042. transport.sentInitMsg = msg
  1043. transport.sentInitPacket = packet
  1044. if err := transport.getWriteError(); err != nil {
  1045. t.Fatalf("getWriteError failed: %s", err)
  1046. }
  1047. var request *pendingKex
  1048. select {
  1049. case err = <-readOneFailure:
  1050. t.Fatalf("server readOnePacket failed: %s", err)
  1051. case request = <-transport.startKex:
  1052. break
  1053. }
  1054. // We expect the following calls to fail if the side which does not support
  1055. // kex-strict sends unexpected/ignored packets during the handshake, even if
  1056. // the other side does support kex-strict.
  1057. if err := transport.enterKeyExchange(request.otherInit); err != nil {
  1058. t.Fatalf("enterKeyExchange failed: %s", err)
  1059. }
  1060. if err := client.waitSession(); err != nil {
  1061. t.Fatalf("client.waitSession: %v", err)
  1062. }
  1063. }