2 NNCP -- Node to Node copy, utilities for store-and-forward data exchange
3 Copyright (C) 2016-2018 Sergey Matveev <stargrave@stargrave.org>
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
34 "github.com/davecgh/go-xdr/xdr2"
35 "github.com/flynn/noise"
39 MaxSPSize = 1<<16 - 256
45 MagicNNCPLv1 [8]byte = [8]byte{'N', 'N', 'C', 'P', 'S', 0, 0, 1}
51 SPHaltMarshalized []byte
53 NoiseCipherSuite noise.CipherSuite = noise.NewCipherSuite(
55 noise.CipherChaChaPoly,
59 spWorkersGroup sync.WaitGroup
65 SPTypeInfo SPType = iota
66 SPTypeFreq SPType = iota
67 SPTypeFile SPType = iota
68 SPTypeDone SPType = iota
69 SPTypeHalt SPType = iota
102 type FreqWithNice struct {
107 type ConnDeadlined interface {
109 SetReadDeadline(t time.Time) error
110 SetWriteDeadline(t time.Time) error
115 spHead := SPHead{Type: SPTypeHalt}
116 if _, err := xdr.Marshal(&buf, spHead); err != nil {
119 copy(SPHaltMarshalized, buf.Bytes())
120 SPHeadOverhead = buf.Len()
123 spInfo := SPInfo{Nice: 123, Size: 123, Hash: new([32]byte)}
124 if _, err := xdr.Marshal(&buf, spInfo); err != nil {
127 SPInfoOverhead = buf.Len()
130 spFreq := SPFreq{Hash: new([32]byte), Offset: 123}
131 if _, err := xdr.Marshal(&buf, spFreq); err != nil {
134 SPFreqOverhead = buf.Len()
137 spFile := SPFile{Hash: new([32]byte), Offset: 123}
138 if _, err := xdr.Marshal(&buf, spFile); err != nil {
141 SPFileOverhead = buf.Len()
144 func MarshalSP(typ SPType, sp interface{}) []byte {
147 if _, err = xdr.Marshal(&buf, SPHead{typ}); err != nil {
150 if _, err = xdr.Marshal(&buf, sp); err != nil {
156 func payloadsSplit(payloads [][]byte) [][]byte {
157 var outbounds [][]byte
158 outbound := make([]byte, 0, MaxSPSize)
159 for i, payload := range payloads {
160 outbound = append(outbound, payload...)
161 if i+1 < len(payloads) && len(outbound)+len(payloads[i+1]) > MaxSPSize {
162 outbounds = append(outbounds, outbound)
163 outbound = make([]byte, 0, MaxSPSize)
166 if len(outbound) > 0 {
167 outbounds = append(outbounds, outbound)
172 type SPState struct {
178 hs *noise.HandshakeState
179 csOur *noise.CipherState
180 csTheir *noise.CipherState
182 infosTheir map[[32]byte]*SPInfo
183 infosOurSeen map[[32]byte]uint8
184 queueTheir []*FreqWithNice
191 Duration time.Duration
203 func (state *SPState) NotAlive() bool {
208 if state.maxOnlineTime > 0 && state.started.Add(time.Duration(state.maxOnlineTime)*time.Second).Before(now) {
211 return uint(now.Sub(state.RxLastSeen).Seconds()) >= state.onlineDeadline &&
212 uint(now.Sub(state.TxLastSeen).Seconds()) >= state.onlineDeadline
215 func (state *SPState) dirUnlock() {
216 state.ctx.UnlockDir(state.rxLock)
217 state.ctx.UnlockDir(state.txLock)
220 func (state *SPState) WriteSP(dst io.Writer, payload []byte) error {
221 n, err := xdr.Marshal(dst, SPRaw{Magic: MagicNNCPLv1, Payload: payload})
223 state.TxLastSeen = time.Now()
224 state.TxBytes += int64(n)
229 func (state *SPState) ReadSP(src io.Reader) ([]byte, error) {
231 n, err := xdr.UnmarshalLimited(src, &sp, 1<<17)
235 state.RxLastSeen = time.Now()
236 state.RxBytes += int64(n)
237 if sp.Magic != MagicNNCPLv1 {
240 return sp.Payload, nil
243 func (ctx *Ctx) infosOur(nodeId *NodeId, nice uint8, seen *map[[32]byte]uint8) [][]byte {
246 for job := range ctx.Jobs(nodeId, TTx) {
248 if job.PktEnc.Nice > nice {
251 if _, known := (*seen)[*job.HshValue]; known {
254 totalSize += job.Size
255 infos = append(infos, &SPInfo{
256 Nice: job.PktEnc.Nice,
257 Size: uint64(job.Size),
260 (*seen)[*job.HshValue] = job.PktEnc.Nice
262 sort.Sort(ByNice(infos))
263 var payloads [][]byte
264 for _, info := range infos {
265 payloads = append(payloads, MarshalSP(SPTypeInfo, info))
266 ctx.LogD("sp-info-our", SDS{
268 "name": ToBase32(info.Hash[:]),
269 "size": strconv.FormatInt(int64(info.Size), 10),
273 ctx.LogI("sp-infos", SDS{
276 "pkts": strconv.Itoa(len(payloads)),
277 "size": strconv.FormatInt(totalSize, 10),
280 return payloadsSplit(payloads)
283 func (ctx *Ctx) StartI(
289 onlineDeadline, maxOnlineTime uint) (*SPState, error) {
290 err := ctx.ensureRxDir(nodeId)
295 if xxOnly == "" || xxOnly == TRx {
296 rxLock, err = ctx.LockDir(nodeId, TRx)
302 if xxOnly == "" || xxOnly == TTx {
303 txLock, err = ctx.LockDir(nodeId, TTx)
308 started := time.Now()
309 node := ctx.Neigh[*nodeId]
310 conf := noise.Config{
311 CipherSuite: NoiseCipherSuite,
312 Pattern: noise.HandshakeIK,
314 StaticKeypair: noise.DHKey{
315 Private: ctx.Self.NoisePrv[:],
316 Public: ctx.Self.NoisePub[:],
318 PeerStatic: node.NoisePub[:],
320 hs, err := noise.NewHandshakeState(conf)
328 onlineDeadline: onlineDeadline,
329 maxOnlineTime: maxOnlineTime,
331 payloads: make(chan []byte),
332 infosTheir: make(map[[32]byte]*SPInfo),
333 infosOurSeen: make(map[[32]byte]uint8),
342 var infosPayloads [][]byte
343 if xxOnly == "" || xxOnly == TTx {
344 infosPayloads = ctx.infosOur(nodeId, nice, &state.infosOurSeen)
346 var firstPayload []byte
347 if len(infosPayloads) > 0 {
348 firstPayload = infosPayloads[0]
350 // Pad first payload, to hide actual number of existing files
351 for i := 0; i < (MaxSPSize-len(firstPayload))/SPHeadOverhead; i++ {
352 firstPayload = append(firstPayload, SPHaltMarshalized...)
357 buf, _, _, err = state.hs.WriteMessage(nil, firstPayload)
362 sds := SDS{"node": nodeId, "nice": strconv.Itoa(int(nice))}
363 ctx.LogD("sp-start", sds, "sending first message")
364 conn.SetWriteDeadline(time.Now().Add(DefaultDeadline * time.Second))
365 if err = state.WriteSP(conn, buf); err != nil {
366 ctx.LogE("sp-start", SdsAdd(sds, SDS{"err": err}), "")
370 ctx.LogD("sp-start", sds, "waiting for first message")
371 conn.SetReadDeadline(time.Now().Add(DefaultDeadline * time.Second))
372 if buf, err = state.ReadSP(conn); err != nil {
373 ctx.LogE("sp-start", SdsAdd(sds, SDS{"err": err}), "")
377 payload, state.csOur, state.csTheir, err = state.hs.ReadMessage(nil, buf)
379 ctx.LogE("sp-start", SdsAdd(sds, SDS{"err": err}), "")
383 ctx.LogD("sp-start", sds, "starting workers")
384 err = state.StartWorkers(conn, infosPayloads, payload)
386 ctx.LogE("sp-start", SdsAdd(sds, SDS{"err": err}), "")
393 func (ctx *Ctx) StartR(conn ConnDeadlined, nice uint8, xxOnly TRxTx) (*SPState, error) {
394 started := time.Now()
395 conf := noise.Config{
396 CipherSuite: NoiseCipherSuite,
397 Pattern: noise.HandshakeIK,
399 StaticKeypair: noise.DHKey{
400 Private: ctx.Self.NoisePrv[:],
401 Public: ctx.Self.NoisePub[:],
404 hs, err := noise.NewHandshakeState(conf)
412 payloads: make(chan []byte),
413 infosOurSeen: make(map[[32]byte]uint8),
414 infosTheir: make(map[[32]byte]*SPInfo),
422 SDS{"nice": strconv.Itoa(int(nice))},
423 "waiting for first message",
425 conn.SetReadDeadline(time.Now().Add(DefaultDeadline * time.Second))
426 if buf, err = state.ReadSP(conn); err != nil {
427 ctx.LogE("sp-start", SDS{"err": err}, "")
430 if payload, _, _, err = state.hs.ReadMessage(nil, buf); err != nil {
431 ctx.LogE("sp-start", SDS{"err": err}, "")
436 for _, node = range ctx.Neigh {
437 if subtle.ConstantTimeCompare(state.hs.PeerStatic(), node.NoisePub[:]) == 1 {
442 peerId := ToBase32(state.hs.PeerStatic())
443 ctx.LogE("sp-start", SDS{"peer": peerId}, "unknown")
444 return nil, errors.New("Unknown peer: " + peerId)
447 state.rxRate = node.RxRate
448 state.txRate = node.TxRate
449 state.onlineDeadline = node.OnlineDeadline
450 state.maxOnlineTime = node.MaxOnlineTime
451 sds := SDS{"node": node.Id, "nice": strconv.Itoa(int(nice))}
453 if ctx.ensureRxDir(node.Id); err != nil {
457 if xxOnly == "" || xxOnly == TRx {
458 rxLock, err = ctx.LockDir(node.Id, TRx)
463 state.rxLock = rxLock
465 if xxOnly == "" || xxOnly == TTx {
466 txLock, err = ctx.LockDir(node.Id, TTx)
471 state.txLock = txLock
473 var infosPayloads [][]byte
474 if xxOnly == "" || xxOnly == TTx {
475 infosPayloads = ctx.infosOur(node.Id, nice, &state.infosOurSeen)
477 var firstPayload []byte
478 if len(infosPayloads) > 0 {
479 firstPayload = infosPayloads[0]
481 // Pad first payload, to hide actual number of existing files
482 for i := 0; i < (MaxSPSize-len(firstPayload))/SPHeadOverhead; i++ {
483 firstPayload = append(firstPayload, SPHaltMarshalized...)
486 ctx.LogD("sp-start", sds, "sending first message")
487 buf, state.csTheir, state.csOur, err = state.hs.WriteMessage(nil, firstPayload)
492 conn.SetWriteDeadline(time.Now().Add(DefaultDeadline * time.Second))
493 if err = state.WriteSP(conn, buf); err != nil {
494 ctx.LogE("sp-start", SdsAdd(sds, SDS{"err": err}), "")
498 ctx.LogD("sp-start", sds, "starting workers")
499 err = state.StartWorkers(conn, infosPayloads, payload)
507 func (state *SPState) StartWorkers(
509 infosPayloads [][]byte,
510 payload []byte) error {
511 sds := SDS{"node": state.Node.Id, "nice": strconv.Itoa(int(state.nice))}
512 if len(infosPayloads) > 1 {
514 for _, payload := range infosPayloads[1:] {
517 SdsAdd(sds, SDS{"size": strconv.Itoa(len(payload))}),
518 "queuing remaining payload",
520 state.payloads <- payload
526 SdsAdd(sds, SDS{"size": strconv.Itoa(len(payload))}),
527 "processing first payload",
529 replies, err := state.ProcessSP(payload)
531 state.ctx.LogE("sp-work", SdsAdd(sds, SDS{"err": err}), "")
536 for _, reply := range replies {
539 SdsAdd(sds, SDS{"size": strconv.Itoa(len(reply))}),
542 state.payloads <- reply
546 if state.xxOnly == "" || state.xxOnly == TTx {
548 for range time.Tick(time.Second) {
549 for _, payload := range state.ctx.infosOur(
556 SdsAdd(sds, SDS{"size": strconv.Itoa(len(payload))}),
559 state.payloads <- payload
572 if state.NotAlive() {
577 case payload = <-state.payloads:
580 SdsAdd(sds, SDS{"size": strconv.Itoa(len(payload))}),
587 if len(state.queueTheir) == 0 {
588 state.ctx.LogD("sp-xmit", sds, "file queue is empty")
590 time.Sleep(100 * time.Millisecond)
593 freq := state.queueTheir[0].freq
596 if state.txRate > 0 {
597 time.Sleep(time.Second / time.Duration(state.txRate))
600 sdsp := SdsAdd(sds, SDS{
602 "hash": ToBase32(freq.Hash[:]),
603 "size": strconv.FormatInt(int64(freq.Offset), 10),
605 state.ctx.LogD("sp-file", sdsp, "queueing")
606 fd, err := os.Open(filepath.Join(
608 state.Node.Id.String(),
610 ToBase32(freq.Hash[:]),
613 state.ctx.LogE("sp-file", SdsAdd(sdsp, SDS{"err": err}), "")
618 state.ctx.LogE("sp-file", SdsAdd(sdsp, SDS{"err": err}), "")
621 fullSize := uint64(fi.Size())
623 if freq.Offset < fullSize {
624 state.ctx.LogD("sp-file", sdsp, "seeking")
625 if _, err = fd.Seek(int64(freq.Offset), 0); err != nil {
626 state.ctx.LogE("sp-file", SdsAdd(sdsp, SDS{"err": err}), "")
629 buf = make([]byte, MaxSPSize-SPHeadOverhead-SPFileOverhead)
630 n, err := fd.Read(buf)
632 state.ctx.LogE("sp-file", SdsAdd(sdsp, SDS{"err": err}), "")
638 SdsAdd(sdsp, SDS{"size": strconv.Itoa(n)}),
643 payload = MarshalSP(SPTypeFile, SPFile{
648 ourSize := freq.Offset + uint64(len(buf))
649 sdsp["size"] = strconv.FormatInt(int64(ourSize), 10)
650 sdsp["fullsize"] = strconv.FormatInt(int64(fullSize), 10)
651 state.ctx.LogP("sp-file", sdsp, "")
653 if len(state.queueTheir) > 0 && *state.queueTheir[0].freq.Hash == *freq.Hash {
654 if ourSize == fullSize {
655 state.ctx.LogD("sp-file", sdsp, "finished")
656 if len(state.queueTheir) > 1 {
657 state.queueTheir = state.queueTheir[1:]
659 state.queueTheir = state.queueTheir[:0]
662 state.queueTheir[0].freq.Offset += uint64(len(buf))
665 state.ctx.LogD("sp-file", sdsp, "queue disappeared")
671 SdsAdd(sds, SDS{"size": strconv.Itoa(len(payload))}),
674 conn.SetWriteDeadline(time.Now().Add(DefaultDeadline * time.Second))
675 if err := state.WriteSP(conn, state.csOur.Encrypt(nil, nil, payload)); err != nil {
676 state.ctx.LogE("sp-xmit", SdsAdd(sds, SDS{"err": err}), "")
689 if state.NotAlive() {
692 state.ctx.LogD("sp-recv", sds, "waiting for payload")
693 conn.SetReadDeadline(time.Now().Add(DefaultDeadline * time.Second))
694 payload, err := state.ReadSP(conn)
696 unmarshalErr := err.(*xdr.UnmarshalError)
697 netErr, ok := unmarshalErr.Err.(net.Error)
698 if ok && netErr.Timeout() {
701 if unmarshalErr.ErrorCode == xdr.ErrIO {
704 state.ctx.LogE("sp-recv", SdsAdd(sds, SDS{"err": err}), "")
709 SdsAdd(sds, SDS{"size": strconv.Itoa(len(payload))}),
712 payload, err = state.csTheir.Decrypt(nil, nil, payload)
714 state.ctx.LogE("sp-recv", SdsAdd(sds, SDS{"err": err}), "")
719 SdsAdd(sds, SDS{"size": strconv.Itoa(len(payload))}),
722 replies, err := state.ProcessSP(payload)
724 state.ctx.LogE("sp-recv", SdsAdd(sds, SDS{"err": err}), "")
728 for _, reply := range replies {
731 SdsAdd(sds, SDS{"size": strconv.Itoa(len(reply))}),
734 state.payloads <- reply
737 if state.rxRate > 0 {
738 time.Sleep(time.Second / time.Duration(state.rxRate))
746 func (state *SPState) Wait() {
749 state.Duration = time.Now().Sub(state.started)
750 state.RxSpeed = state.RxBytes
751 state.TxSpeed = state.TxBytes
752 rxDuration := int64(state.RxLastSeen.Sub(state.started).Seconds())
753 txDuration := int64(state.TxLastSeen.Sub(state.started).Seconds())
755 state.RxSpeed = state.RxBytes / rxDuration
758 state.TxSpeed = state.TxBytes / txDuration
762 func (state *SPState) ProcessSP(payload []byte) ([][]byte, error) {
763 sds := SDS{"node": state.Node.Id, "nice": strconv.Itoa(int(state.nice))}
764 r := bytes.NewReader(payload)
769 state.ctx.LogD("sp-process", sds, "unmarshaling header")
771 if _, err = xdr.Unmarshal(r, &head); err != nil {
772 state.ctx.LogE("sp-process", SdsAdd(sds, SDS{"err": err}), "")
778 sdsp := SdsAdd(sds, SDS{"type": "info"})
779 state.ctx.LogD("sp-process", sdsp, "unmarshaling packet")
781 if _, err = xdr.Unmarshal(r, &info); err != nil {
782 state.ctx.LogE("sp-process", SdsAdd(sdsp, SDS{"err": err}), "")
785 sdsp = SdsAdd(sds, SDS{
786 "hash": ToBase32(info.Hash[:]),
787 "size": strconv.FormatInt(int64(info.Size), 10),
789 if info.Nice > state.nice {
790 state.ctx.LogD("sp-process", sdsp, "too nice")
793 state.ctx.LogD("sp-process", sdsp, "received")
794 if state.xxOnly == TTx {
798 state.infosTheir[*info.Hash] = &info
800 state.ctx.LogD("sp-process", sdsp, "stating part")
801 pktPath := filepath.Join(
803 state.Node.Id.String(),
805 ToBase32(info.Hash[:]),
807 if _, err = os.Stat(pktPath); err == nil {
808 state.ctx.LogD("sp-process", sdsp, "already done")
809 replies = append(replies, MarshalSP(SPTypeDone, SPDone{info.Hash}))
812 if _, err = os.Stat(pktPath + SeenSuffix); err == nil {
813 state.ctx.LogD("sp-process", sdsp, "already seen")
814 replies = append(replies, MarshalSP(SPTypeDone, SPDone{info.Hash}))
817 fi, err := os.Stat(pktPath + PartSuffix)
823 SdsAdd(sdsp, SDS{"offset": strconv.FormatInt(offset, 10)}),
827 replies = append(replies, MarshalSP(
829 SPFreq{info.Hash, uint64(offset)},
834 SdsAdd(sds, SDS{"type": "file"}),
835 "unmarshaling packet",
838 if _, err = xdr.Unmarshal(r, &file); err != nil {
839 state.ctx.LogE("sp-process", SdsAdd(sds, SDS{
845 sdsp := SdsAdd(sds, SDS{
847 "hash": ToBase32(file.Hash[:]),
848 "size": strconv.Itoa(len(file.Payload)),
850 filePath := filepath.Join(
852 state.Node.Id.String(),
854 ToBase32(file.Hash[:]),
856 state.ctx.LogD("sp-file", sdsp, "opening part")
857 fd, err := os.OpenFile(
859 os.O_RDWR|os.O_CREATE,
863 state.ctx.LogE("sp-file", SdsAdd(sdsp, SDS{"err": err}), "")
868 SdsAdd(sdsp, SDS{"offset": strconv.FormatInt(int64(file.Offset), 10)}),
871 if _, err = fd.Seek(int64(file.Offset), 0); err != nil {
872 state.ctx.LogE("sp-file", SdsAdd(sdsp, SDS{"err": err}), "")
876 state.ctx.LogD("sp-file", sdsp, "writing")
877 _, err = fd.Write(file.Payload)
879 state.ctx.LogE("sp-file", SdsAdd(sdsp, SDS{"err": err}), "")
883 ourSize := uint64(file.Offset) + uint64(len(file.Payload))
885 sdsp["fullsize"] = strconv.FormatInt(int64(state.infosTheir[*file.Hash].Size), 10)
886 sdsp["size"] = strconv.FormatInt(int64(ourSize), 10)
887 state.ctx.LogP("sp-file", sdsp, "")
888 if state.infosTheir[*file.Hash].Size != ourSize {
894 spWorkersGroup.Wait()
895 spWorkersGroup.Add(1)
897 if err := fd.Sync(); err != nil {
898 state.ctx.LogE("sp-file", SdsAdd(sdsp, SDS{"err": err}), "sync")
903 defer state.wg.Done()
905 state.ctx.LogD("sp-file", sdsp, "checking")
906 gut, err := Check(fd, file.Hash[:])
908 if err != nil || !gut {
909 state.ctx.LogE("sp-file", sdsp, "checksum mismatch")
912 state.ctx.LogI("sp-done", SdsAdd(sdsp, SDS{"xx": string(TRx)}), "")
913 os.Rename(filePath+PartSuffix, filePath)
915 delete(state.infosTheir, *file.Hash)
917 spWorkersGroup.Done()
919 state.payloads <- MarshalSP(SPTypeDone, SPDone{file.Hash})
925 SdsAdd(sds, SDS{"type": "done"}),
926 "unmarshaling packet",
929 if _, err = xdr.Unmarshal(r, &done); err != nil {
930 state.ctx.LogE("sp-process", SdsAdd(sds, SDS{
936 sdsp := SdsAdd(sds, SDS{"hash": ToBase32(done.Hash[:])})
937 state.ctx.LogD("sp-done", sdsp, "removing")
938 err := os.Remove(filepath.Join(
940 state.Node.Id.String(),
942 ToBase32(done.Hash[:]),
945 state.ctx.LogI("sp-done", SdsAdd(sdsp, SDS{"xx": string(TTx)}), "")
947 state.ctx.LogE("sp-done", SdsAdd(sdsp, SDS{"xx": string(TTx)}), "")
950 sdsp := SdsAdd(sds, SDS{"type": "freq"})
951 state.ctx.LogD("sp-process", sdsp, "unmarshaling packet")
953 if _, err = xdr.Unmarshal(r, &freq); err != nil {
954 state.ctx.LogE("sp-process", SdsAdd(sdsp, SDS{"err": err}), "")
957 state.ctx.LogD("sp-process", SdsAdd(sdsp, SDS{
958 "hash": ToBase32(freq.Hash[:]),
959 "offset": strconv.FormatInt(int64(freq.Offset), 10),
961 nice, exists := state.infosOurSeen[*freq.Hash]
965 var freqWithNice *FreqWithNice
966 for insertIdx, freqWithNice = range state.queueTheir {
967 if freqWithNice.nice > nice {
971 state.queueTheir = append(state.queueTheir, nil)
972 copy(state.queueTheir[insertIdx+1:], state.queueTheir[insertIdx:])
973 state.queueTheir[insertIdx] = &FreqWithNice{&freq, nice}
976 state.ctx.LogD("sp-process", SdsAdd(sdsp, SDS{
977 "hash": ToBase32(freq.Hash[:]),
978 "offset": strconv.FormatInt(int64(freq.Offset), 10),
982 sdsp := SdsAdd(sds, SDS{"type": "halt"})
983 state.ctx.LogD("sp-process", sdsp, "")
985 state.queueTheir = nil
990 SdsAdd(sds, SDS{"type": head.Type}),
993 return nil, BadPktType
1000 for _, info := range state.infosTheir {
1005 state.ctx.LogI("sp-infos", SDS{
1007 "node": state.Node.Id,
1008 "pkts": strconv.Itoa(pkts),
1009 "size": strconv.FormatInt(int64(size), 10),
1012 return payloadsSplit(replies), nil