2 NNCP -- Node to Node copy, utilities for store-and-forward data exchange
3 Copyright (C) 2016-2020 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, version 3 of the License.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>.
32 xdr "github.com/davecgh/go-xdr/xdr2"
33 "github.com/flynn/noise"
37 MaxSPSize = 1<<16 - 256
45 MagicNNCPLv1 [8]byte = [8]byte{'N', 'N', 'C', 'P', 'S', 0, 0, 1}
50 SPHaltMarshalized []byte
52 NoiseCipherSuite noise.CipherSuite = noise.NewCipherSuite(
54 noise.CipherChaChaPoly,
58 spWorkersGroup sync.WaitGroup
64 SPTypeInfo SPType = iota
65 SPTypeFreq SPType = iota
66 SPTypeFile SPType = iota
67 SPTypeDone SPType = iota
68 SPTypeHalt SPType = iota
101 type FreqWithNice struct {
106 type ConnDeadlined interface {
108 SetReadDeadline(t time.Time) error
109 SetWriteDeadline(t time.Time) error
114 spHead := SPHead{Type: SPTypeHalt}
115 if _, err := xdr.Marshal(&buf, spHead); err != nil {
118 SPHaltMarshalized = make([]byte, SPHeadOverhead)
119 copy(SPHaltMarshalized, buf.Bytes())
122 spInfo := SPInfo{Nice: 123, Size: 123, Hash: new([32]byte)}
123 if _, err := xdr.Marshal(&buf, spInfo); err != nil {
126 SPInfoOverhead = buf.Len()
129 spFreq := SPFreq{Hash: new([32]byte), Offset: 123}
130 if _, err := xdr.Marshal(&buf, spFreq); err != nil {
133 SPFreqOverhead = buf.Len()
136 spFile := SPFile{Hash: new([32]byte), Offset: 123}
137 if _, err := xdr.Marshal(&buf, spFile); err != nil {
140 SPFileOverhead = buf.Len()
143 func MarshalSP(typ SPType, sp interface{}) []byte {
146 if _, err = xdr.Marshal(&buf, SPHead{typ}); err != nil {
149 if _, err = xdr.Marshal(&buf, sp); err != nil {
155 func payloadsSplit(payloads [][]byte) [][]byte {
156 var outbounds [][]byte
157 outbound := make([]byte, 0, MaxSPSize)
158 for i, payload := range payloads {
159 outbound = append(outbound, payload...)
160 if i+1 < len(payloads) && len(outbound)+len(payloads[i+1]) > MaxSPSize {
161 outbounds = append(outbounds, outbound)
162 outbound = make([]byte, 0, MaxSPSize)
165 if len(outbound) > 0 {
166 outbounds = append(outbounds, outbound)
171 type SPState struct {
177 hs *noise.HandshakeState
178 csOur *noise.CipherState
179 csTheir *noise.CipherState
181 infosTheir map[[32]byte]*SPInfo
182 infosOurSeen map[[32]byte]uint8
183 queueTheir []*FreqWithNice
190 Duration time.Duration
200 onlyPkts map[[32]byte]bool
204 func (state *SPState) SetDead() {
208 case _, ok := <-state.isDead:
210 // Already closed channel, dead
217 for _ = range state.payloads {
222 func (state *SPState) NotAlive() bool {
224 case _, ok := <-state.isDead:
231 if state.maxOnlineTime > 0 && state.started.Add(time.Duration(state.maxOnlineTime)*time.Second).Before(now) {
234 return uint(now.Sub(state.RxLastSeen).Seconds()) >= state.onlineDeadline &&
235 uint(now.Sub(state.TxLastSeen).Seconds()) >= state.onlineDeadline
238 func (state *SPState) dirUnlock() {
239 state.Ctx.UnlockDir(state.rxLock)
240 state.Ctx.UnlockDir(state.txLock)
243 func (state *SPState) WriteSP(dst io.Writer, payload []byte) error {
244 n, err := xdr.Marshal(dst, SPRaw{Magic: MagicNNCPLv1, Payload: payload})
246 state.TxLastSeen = time.Now()
247 state.TxBytes += int64(n)
252 func (state *SPState) ReadSP(src io.Reader) ([]byte, error) {
254 n, err := xdr.UnmarshalLimited(src, &sp, 1<<17)
256 ue := err.(*xdr.UnmarshalError)
257 if ue.Err == io.EOF {
262 state.RxLastSeen = time.Now()
263 state.RxBytes += int64(n)
264 if sp.Magic != MagicNNCPLv1 {
267 return sp.Payload, nil
270 func (ctx *Ctx) infosOur(nodeId *NodeId, nice uint8, seen *map[[32]byte]uint8) [][]byte {
273 for job := range ctx.Jobs(nodeId, TTx) {
275 if job.PktEnc.Nice > nice {
278 if _, known := (*seen)[*job.HshValue]; known {
281 totalSize += job.Size
282 infos = append(infos, &SPInfo{
283 Nice: job.PktEnc.Nice,
284 Size: uint64(job.Size),
287 (*seen)[*job.HshValue] = job.PktEnc.Nice
289 sort.Sort(ByNice(infos))
290 var payloads [][]byte
291 for _, info := range infos {
292 payloads = append(payloads, MarshalSP(SPTypeInfo, info))
293 ctx.LogD("sp-info-our", SDS{
295 "name": ToBase32(info.Hash[:]),
300 ctx.LogI("sp-infos", SDS{
303 "pkts": len(payloads),
307 return payloadsSplit(payloads)
310 func (state *SPState) StartI(conn ConnDeadlined) error {
311 nodeId := state.Node.Id
312 err := state.Ctx.ensureRxDir(nodeId)
317 if !state.listOnly && (state.xxOnly == "" || state.xxOnly == TRx) {
318 rxLock, err = state.Ctx.LockDir(nodeId, TRx)
324 if !state.listOnly && (state.xxOnly == "" || state.xxOnly == TTx) {
325 txLock, err = state.Ctx.LockDir(nodeId, TTx)
330 started := time.Now()
331 conf := noise.Config{
332 CipherSuite: NoiseCipherSuite,
333 Pattern: noise.HandshakeIK,
335 StaticKeypair: noise.DHKey{
336 Private: state.Ctx.Self.NoisePrv[:],
337 Public: state.Ctx.Self.NoisePub[:],
339 PeerStatic: state.Node.NoisePub[:],
341 hs, err := noise.NewHandshakeState(conf)
346 state.payloads = make(chan []byte)
347 state.infosTheir = make(map[[32]byte]*SPInfo)
348 state.infosOurSeen = make(map[[32]byte]uint8)
349 state.started = started
350 state.rxLock = rxLock
351 state.txLock = txLock
353 var infosPayloads [][]byte
354 if !state.listOnly && (state.xxOnly == "" || state.xxOnly == TTx) {
355 infosPayloads = state.Ctx.infosOur(nodeId, state.Nice, &state.infosOurSeen)
357 var firstPayload []byte
358 if len(infosPayloads) > 0 {
359 firstPayload = infosPayloads[0]
361 // Pad first payload, to hide actual number of existing files
362 for i := 0; i < (MaxSPSize-len(firstPayload))/SPHeadOverhead; i++ {
363 firstPayload = append(firstPayload, SPHaltMarshalized...)
368 buf, _, _, err = state.hs.WriteMessage(nil, firstPayload)
373 sds := SDS{"node": nodeId, "nice": int(state.Nice)}
374 state.Ctx.LogD("sp-start", sds, "sending first message")
375 conn.SetWriteDeadline(time.Now().Add(DefaultDeadline * time.Second))
376 if err = state.WriteSP(conn, buf); err != nil {
377 state.Ctx.LogE("sp-start", sds, err, "")
381 state.Ctx.LogD("sp-start", sds, "waiting for first message")
382 conn.SetReadDeadline(time.Now().Add(DefaultDeadline * time.Second))
383 if buf, err = state.ReadSP(conn); err != nil {
384 state.Ctx.LogE("sp-start", sds, err, "")
388 payload, state.csOur, state.csTheir, err = state.hs.ReadMessage(nil, buf)
390 state.Ctx.LogE("sp-start", sds, err, "")
394 state.Ctx.LogD("sp-start", sds, "starting workers")
395 err = state.StartWorkers(conn, infosPayloads, payload)
397 state.Ctx.LogE("sp-start", sds, err, "")
403 func (state *SPState) StartR(conn ConnDeadlined) error {
404 started := time.Now()
405 conf := noise.Config{
406 CipherSuite: NoiseCipherSuite,
407 Pattern: noise.HandshakeIK,
409 StaticKeypair: noise.DHKey{
410 Private: state.Ctx.Self.NoisePrv[:],
411 Public: state.Ctx.Self.NoisePub[:],
414 hs, err := noise.NewHandshakeState(conf)
420 state.payloads = make(chan []byte)
421 state.infosOurSeen = make(map[[32]byte]uint8)
422 state.infosTheir = make(map[[32]byte]*SPInfo)
423 state.started = started
424 state.xxOnly = xxOnly
427 state.Ctx.LogD("sp-start", SDS{"nice": int(state.Nice)}, "waiting for first message")
428 conn.SetReadDeadline(time.Now().Add(DefaultDeadline * time.Second))
429 if buf, err = state.ReadSP(conn); err != nil {
430 state.Ctx.LogE("sp-start", SDS{}, err, "")
433 if payload, _, _, err = state.hs.ReadMessage(nil, buf); err != nil {
434 state.Ctx.LogE("sp-start", SDS{}, err, "")
439 for _, n := range state.Ctx.Neigh {
440 if subtle.ConstantTimeCompare(state.hs.PeerStatic(), n.NoisePub[:]) == 1 {
446 peerId := ToBase32(state.hs.PeerStatic())
447 state.Ctx.LogE("sp-start", SDS{"peer": peerId}, errors.New("unknown"), "")
448 return errors.New("Unknown peer: " + peerId)
451 state.rxRate = node.RxRate
452 state.txRate = node.TxRate
453 state.onlineDeadline = node.OnlineDeadline
454 state.maxOnlineTime = node.MaxOnlineTime
455 sds := SDS{"node": node.Id, "nice": int(state.Nice)}
457 if state.Ctx.ensureRxDir(node.Id); err != nil {
461 if xxOnly == "" || xxOnly == TRx {
462 rxLock, err = state.Ctx.LockDir(node.Id, TRx)
467 state.rxLock = rxLock
469 if xxOnly == "" || xxOnly == TTx {
470 txLock, err = state.Ctx.LockDir(node.Id, TTx)
475 state.txLock = txLock
477 var infosPayloads [][]byte
478 if xxOnly == "" || xxOnly == TTx {
479 infosPayloads = state.Ctx.infosOur(node.Id, state.Nice, &state.infosOurSeen)
481 var firstPayload []byte
482 if len(infosPayloads) > 0 {
483 firstPayload = infosPayloads[0]
485 // Pad first payload, to hide actual number of existing files
486 for i := 0; i < (MaxSPSize-len(firstPayload))/SPHeadOverhead; i++ {
487 firstPayload = append(firstPayload, SPHaltMarshalized...)
490 state.Ctx.LogD("sp-start", sds, "sending first message")
491 buf, state.csTheir, state.csOur, err = state.hs.WriteMessage(nil, firstPayload)
496 conn.SetWriteDeadline(time.Now().Add(DefaultDeadline * time.Second))
497 if err = state.WriteSP(conn, buf); err != nil {
498 state.Ctx.LogE("sp-start", sds, err, "")
502 state.Ctx.LogD("sp-start", sds, "starting workers")
503 err = state.StartWorkers(conn, infosPayloads, payload)
510 func (state *SPState) StartWorkers(
512 infosPayloads [][]byte,
515 state.isDead = make(chan struct{})
516 sds := SDS{"node": state.Node.Id, "nice": int(state.Nice)}
518 if len(infosPayloads) > 1 {
521 for _, payload := range infosPayloads[1:] {
524 SdsAdd(sds, SDS{"size": len(payload)}),
525 "queuing remaining payload",
527 state.payloads <- payload
534 SdsAdd(sds, SDS{"size": len(payload)}),
535 "processing first payload",
537 replies, err := state.ProcessSP(payload)
539 state.Ctx.LogE("sp-work", sds, err, "")
545 for _, reply := range replies {
548 SdsAdd(sds, SDS{"size": len(reply)}),
551 state.payloads <- reply
556 if !state.listOnly && (state.xxOnly == "" || state.xxOnly == TTx) {
559 ticker := time.NewTicker(time.Second)
562 case _, ok := <-state.isDead:
569 for _, payload := range state.Ctx.infosOur(
576 SdsAdd(sds, SDS{"size": len(payload)}),
579 state.payloads <- payload
589 if state.NotAlive() {
594 case payload = <-state.payloads:
597 SdsAdd(sds, SDS{"size": len(payload)}),
604 if len(state.queueTheir) == 0 {
606 time.Sleep(100 * time.Millisecond)
609 freq := state.queueTheir[0].freq
612 if state.txRate > 0 {
613 time.Sleep(time.Second / time.Duration(state.txRate))
616 sdsp := SdsAdd(sds, SDS{
618 "pkt": ToBase32(freq.Hash[:]),
619 "size": int64(freq.Offset),
621 state.Ctx.LogD("sp-file", sdsp, "queueing")
622 fd, err := os.Open(filepath.Join(
624 state.Node.Id.String(),
626 ToBase32(freq.Hash[:]),
629 state.Ctx.LogE("sp-file", sdsp, err, "")
634 state.Ctx.LogE("sp-file", sdsp, err, "")
637 fullSize := fi.Size()
639 if freq.Offset < uint64(fullSize) {
640 state.Ctx.LogD("sp-file", sdsp, "seeking")
641 if _, err = fd.Seek(int64(freq.Offset), io.SeekStart); err != nil {
642 state.Ctx.LogE("sp-file", sdsp, err, "")
645 buf = make([]byte, MaxSPSize-SPHeadOverhead-SPFileOverhead)
646 n, err := fd.Read(buf)
648 state.Ctx.LogE("sp-file", sdsp, err, "")
654 SdsAdd(sdsp, SDS{"size": n}),
659 payload = MarshalSP(SPTypeFile, SPFile{
664 ourSize := freq.Offset + uint64(len(buf))
665 sdsp["size"] = int64(ourSize)
666 sdsp["fullsize"] = fullSize
667 if state.Ctx.ShowPrgrs {
671 if len(state.queueTheir) > 0 && *state.queueTheir[0].freq.Hash == *freq.Hash {
672 if ourSize == uint64(fullSize) {
673 state.Ctx.LogD("sp-file", sdsp, "finished")
674 if len(state.queueTheir) > 1 {
675 state.queueTheir = state.queueTheir[1:]
677 state.queueTheir = state.queueTheir[:0]
680 state.queueTheir[0].freq.Offset += uint64(len(buf))
683 state.Ctx.LogD("sp-file", sdsp, "queue disappeared")
689 SdsAdd(sds, SDS{"size": len(payload)}),
692 conn.SetWriteDeadline(time.Now().Add(DefaultDeadline * time.Second))
693 if err := state.WriteSP(conn, state.csOur.Encrypt(nil, nil, payload)); err != nil {
694 state.Ctx.LogE("sp-xmit", sds, err, "")
705 if state.NotAlive() {
708 state.Ctx.LogD("sp-recv", sds, "waiting for payload")
709 conn.SetReadDeadline(time.Now().Add(DefaultDeadline * time.Second))
710 payload, err := state.ReadSP(conn)
715 unmarshalErr := err.(*xdr.UnmarshalError)
716 netErr, ok := unmarshalErr.Err.(net.Error)
717 if ok && netErr.Timeout() {
720 if unmarshalErr.ErrorCode == xdr.ErrIO {
723 state.Ctx.LogE("sp-recv", sds, err, "")
728 SdsAdd(sds, SDS{"size": len(payload)}),
731 payload, err = state.csTheir.Decrypt(nil, nil, payload)
733 state.Ctx.LogE("sp-recv", sds, err, "")
738 SdsAdd(sds, SDS{"size": len(payload)}),
741 replies, err := state.ProcessSP(payload)
743 state.Ctx.LogE("sp-recv", sds, err, "")
748 for _, reply := range replies {
751 SdsAdd(sds, SDS{"size": len(reply)}),
754 state.payloads <- reply
758 if state.rxRate > 0 {
759 time.Sleep(time.Second / time.Duration(state.rxRate))
769 func (state *SPState) Wait() {
771 close(state.payloads)
773 state.Duration = time.Now().Sub(state.started)
774 state.RxSpeed = state.RxBytes
775 state.TxSpeed = state.TxBytes
776 rxDuration := int64(state.RxLastSeen.Sub(state.started).Seconds())
777 txDuration := int64(state.TxLastSeen.Sub(state.started).Seconds())
779 state.RxSpeed = state.RxBytes / rxDuration
782 state.TxSpeed = state.TxBytes / txDuration
786 func (state *SPState) ProcessSP(payload []byte) ([][]byte, error) {
787 sds := SDS{"node": state.Node.Id, "nice": int(state.Nice)}
788 r := bytes.NewReader(payload)
793 state.Ctx.LogD("sp-process", sds, "unmarshaling header")
795 if _, err = xdr.Unmarshal(r, &head); err != nil {
796 state.Ctx.LogE("sp-process", sds, err, "")
802 sdsp := SdsAdd(sds, SDS{"type": "info"})
803 state.Ctx.LogD("sp-process", sdsp, "unmarshaling packet")
805 if _, err = xdr.Unmarshal(r, &info); err != nil {
806 state.Ctx.LogE("sp-process", sdsp, err, "")
809 sdsp = SdsAdd(sds, SDS{
810 "pkt": ToBase32(info.Hash[:]),
811 "size": int64(info.Size),
812 "nice": int(info.Nice),
814 if !state.listOnly && info.Nice > state.Nice {
815 state.Ctx.LogD("sp-process", sdsp, "too nice")
818 state.Ctx.LogD("sp-process", sdsp, "received")
819 if !state.listOnly && state.xxOnly == TTx {
823 state.infosTheir[*info.Hash] = &info
825 state.Ctx.LogD("sp-process", sdsp, "stating part")
826 pktPath := filepath.Join(
828 state.Node.Id.String(),
830 ToBase32(info.Hash[:]),
832 if _, err = os.Stat(pktPath); err == nil {
833 state.Ctx.LogI("sp-info", sdsp, "already done")
835 replies = append(replies, MarshalSP(SPTypeDone, SPDone{info.Hash}))
839 if _, err = os.Stat(pktPath + SeenSuffix); err == nil {
840 state.Ctx.LogI("sp-info", sdsp, "already seen")
842 replies = append(replies, MarshalSP(SPTypeDone, SPDone{info.Hash}))
846 fi, err := os.Stat(pktPath + PartSuffix)
851 if !state.Ctx.IsEnoughSpace(int64(info.Size) - offset) {
852 state.Ctx.LogI("sp-info", sdsp, "not enough space")
857 SdsAdd(sdsp, SDS{"offset": offset}),
860 if !state.listOnly && (state.onlyPkts == nil || state.onlyPkts[*info.Hash]) {
861 replies = append(replies, MarshalSP(
863 SPFreq{info.Hash, uint64(offset)},
867 sdsp := SdsAdd(sds, SDS{"type": "file"})
868 state.Ctx.LogD("sp-process", sdsp, "unmarshaling packet")
870 if _, err = xdr.Unmarshal(r, &file); err != nil {
871 state.Ctx.LogE("sp-process", SdsAdd(sds, SDS{"type": "file"}), err, "")
874 sdsp["xx"] = string(TRx)
875 sdsp["pkt"] = ToBase32(file.Hash[:])
876 sdsp["size"] = len(file.Payload)
877 dirToSync := filepath.Join(
879 state.Node.Id.String(),
882 filePath := filepath.Join(dirToSync, ToBase32(file.Hash[:]))
883 state.Ctx.LogD("sp-file", sdsp, "opening part")
884 fd, err := os.OpenFile(
886 os.O_RDWR|os.O_CREATE,
890 state.Ctx.LogE("sp-file", sdsp, err, "")
895 SdsAdd(sdsp, SDS{"offset": file.Offset}),
898 if _, err = fd.Seek(int64(file.Offset), io.SeekStart); err != nil {
899 state.Ctx.LogE("sp-file", sdsp, err, "")
903 state.Ctx.LogD("sp-file", sdsp, "writing")
904 _, err = fd.Write(file.Payload)
906 state.Ctx.LogE("sp-file", sdsp, err, "")
910 ourSize := file.Offset + uint64(len(file.Payload))
912 sdsp["size"] = int64(ourSize)
913 sdsp["fullsize"] = int64(state.infosTheir[*file.Hash].Size)
914 if state.Ctx.ShowPrgrs {
917 if state.infosTheir[*file.Hash].Size != ourSize {
923 spWorkersGroup.Wait()
924 spWorkersGroup.Add(1)
926 if err := fd.Sync(); err != nil {
927 state.Ctx.LogE("sp-file", sdsp, err, "sync")
932 defer state.wg.Done()
933 fd.Seek(0, io.SeekStart)
934 state.Ctx.LogD("sp-file", sdsp, "checking")
935 gut, err := Check(fd, file.Hash[:], sdsp, state.Ctx.ShowPrgrs)
937 if err != nil || !gut {
938 state.Ctx.LogE("sp-file", sdsp, errors.New("checksum mismatch"), "")
941 state.Ctx.LogI("sp-done", SdsAdd(sdsp, SDS{"xx": string(TRx)}), "")
942 if err = os.Rename(filePath+PartSuffix, filePath); err != nil {
943 state.Ctx.LogE("sp-file", sdsp, err, "rename")
946 if err = DirSync(dirToSync); err != nil {
947 state.Ctx.LogE("sp-file", sdsp, err, "sync")
951 delete(state.infosTheir, *file.Hash)
953 spWorkersGroup.Done()
956 state.payloads <- MarshalSP(SPTypeDone, SPDone{file.Hash})
961 sdsp := SdsAdd(sds, SDS{"type": "done"})
962 state.Ctx.LogD("sp-process", sdsp, "unmarshaling packet")
964 if _, err = xdr.Unmarshal(r, &done); err != nil {
965 state.Ctx.LogE("sp-process", SdsAdd(sds, SDS{"type": "done"}), err, "")
968 sdsp["pkt"] = ToBase32(done.Hash[:])
969 state.Ctx.LogD("sp-done", sdsp, "removing")
970 err := os.Remove(filepath.Join(
972 state.Node.Id.String(),
974 ToBase32(done.Hash[:]),
976 sdsp["xx"] = string(TTx)
978 state.Ctx.LogI("sp-done", sdsp, "")
980 state.Ctx.LogE("sp-done", sdsp, err, "")
983 sdsp := SdsAdd(sds, SDS{"type": "freq"})
984 state.Ctx.LogD("sp-process", sdsp, "unmarshaling packet")
986 if _, err = xdr.Unmarshal(r, &freq); err != nil {
987 state.Ctx.LogE("sp-process", sdsp, err, "")
990 sdsp["pkt"] = ToBase32(freq.Hash[:])
991 sdsp["offset"] = freq.Offset
992 state.Ctx.LogD("sp-process", sdsp, "queueing")
993 nice, exists := state.infosOurSeen[*freq.Hash]
995 if state.onlyPkts == nil || !state.onlyPkts[*freq.Hash] {
998 var freqWithNice *FreqWithNice
999 for insertIdx, freqWithNice = range state.queueTheir {
1000 if freqWithNice.nice > nice {
1004 state.queueTheir = append(state.queueTheir, nil)
1005 copy(state.queueTheir[insertIdx+1:], state.queueTheir[insertIdx:])
1006 state.queueTheir[insertIdx] = &FreqWithNice{&freq, nice}
1009 state.Ctx.LogD("sp-process", sdsp, "skipping")
1012 state.Ctx.LogD("sp-process", sdsp, "unknown")
1015 state.Ctx.LogD("sp-process", SdsAdd(sds, SDS{"type": "halt"}), "")
1017 state.queueTheir = nil
1022 SdsAdd(sds, SDS{"type": head.Type}),
1023 errors.New("unknown type"),
1026 return nil, BadPktType
1033 for _, info := range state.infosTheir {
1038 state.Ctx.LogI("sp-infos", SDS{
1040 "node": state.Node.Id,
1042 "size": int64(size),
1045 return payloadsSplit(replies), nil