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) NotAlive() bool {
209 if state.maxOnlineTime > 0 && state.started.Add(time.Duration(state.maxOnlineTime)*time.Second).Before(now) {
212 return uint(now.Sub(state.RxLastSeen).Seconds()) >= state.onlineDeadline &&
213 uint(now.Sub(state.TxLastSeen).Seconds()) >= state.onlineDeadline
216 func (state *SPState) dirUnlock() {
217 state.Ctx.UnlockDir(state.rxLock)
218 state.Ctx.UnlockDir(state.txLock)
221 func (state *SPState) WriteSP(dst io.Writer, payload []byte) error {
222 n, err := xdr.Marshal(dst, SPRaw{Magic: MagicNNCPLv1, Payload: payload})
224 state.TxLastSeen = time.Now()
225 state.TxBytes += int64(n)
230 func (state *SPState) ReadSP(src io.Reader) ([]byte, error) {
232 n, err := xdr.UnmarshalLimited(src, &sp, 1<<17)
234 ue := err.(*xdr.UnmarshalError)
235 if ue.Err == io.EOF {
240 state.RxLastSeen = time.Now()
241 state.RxBytes += int64(n)
242 if sp.Magic != MagicNNCPLv1 {
245 return sp.Payload, nil
248 func (ctx *Ctx) infosOur(nodeId *NodeId, nice uint8, seen *map[[32]byte]uint8) [][]byte {
251 for job := range ctx.Jobs(nodeId, TTx) {
253 if job.PktEnc.Nice > nice {
256 if _, known := (*seen)[*job.HshValue]; known {
259 totalSize += job.Size
260 infos = append(infos, &SPInfo{
261 Nice: job.PktEnc.Nice,
262 Size: uint64(job.Size),
265 (*seen)[*job.HshValue] = job.PktEnc.Nice
267 sort.Sort(ByNice(infos))
268 var payloads [][]byte
269 for _, info := range infos {
270 payloads = append(payloads, MarshalSP(SPTypeInfo, info))
271 ctx.LogD("sp-info-our", SDS{
273 "name": ToBase32(info.Hash[:]),
278 ctx.LogI("sp-infos", SDS{
281 "pkts": len(payloads),
285 return payloadsSplit(payloads)
288 func (state *SPState) StartI(conn ConnDeadlined) error {
289 nodeId := state.Node.Id
290 err := state.Ctx.ensureRxDir(nodeId)
295 if !state.listOnly && (state.xxOnly == "" || state.xxOnly == TRx) {
296 rxLock, err = state.Ctx.LockDir(nodeId, TRx)
302 if !state.listOnly && (state.xxOnly == "" || state.xxOnly == TTx) {
303 txLock, err = state.Ctx.LockDir(nodeId, TTx)
308 started := time.Now()
309 conf := noise.Config{
310 CipherSuite: NoiseCipherSuite,
311 Pattern: noise.HandshakeIK,
313 StaticKeypair: noise.DHKey{
314 Private: state.Ctx.Self.NoisePrv[:],
315 Public: state.Ctx.Self.NoisePub[:],
317 PeerStatic: state.Node.NoisePub[:],
319 hs, err := noise.NewHandshakeState(conf)
324 state.payloads = make(chan []byte)
325 state.infosTheir = make(map[[32]byte]*SPInfo)
326 state.infosOurSeen = make(map[[32]byte]uint8)
327 state.started = started
328 state.rxLock = rxLock
329 state.txLock = txLock
331 var infosPayloads [][]byte
332 if !state.listOnly && (state.xxOnly == "" || state.xxOnly == TTx) {
333 infosPayloads = state.Ctx.infosOur(nodeId, state.Nice, &state.infosOurSeen)
335 var firstPayload []byte
336 if len(infosPayloads) > 0 {
337 firstPayload = infosPayloads[0]
339 // Pad first payload, to hide actual number of existing files
340 for i := 0; i < (MaxSPSize-len(firstPayload))/SPHeadOverhead; i++ {
341 firstPayload = append(firstPayload, SPHaltMarshalized...)
346 buf, _, _, err = state.hs.WriteMessage(nil, firstPayload)
351 sds := SDS{"node": nodeId, "nice": int(state.Nice)}
352 state.Ctx.LogD("sp-start", sds, "sending first message")
353 conn.SetWriteDeadline(time.Now().Add(DefaultDeadline * time.Second))
354 if err = state.WriteSP(conn, buf); err != nil {
355 state.Ctx.LogE("sp-start", sds, err, "")
359 state.Ctx.LogD("sp-start", sds, "waiting for first message")
360 conn.SetReadDeadline(time.Now().Add(DefaultDeadline * time.Second))
361 if buf, err = state.ReadSP(conn); err != nil {
362 state.Ctx.LogE("sp-start", sds, err, "")
366 payload, state.csOur, state.csTheir, err = state.hs.ReadMessage(nil, buf)
368 state.Ctx.LogE("sp-start", sds, err, "")
372 state.Ctx.LogD("sp-start", sds, "starting workers")
373 err = state.StartWorkers(conn, infosPayloads, payload)
375 state.Ctx.LogE("sp-start", sds, err, "")
382 func (state *SPState) StartR(conn ConnDeadlined) error {
383 started := time.Now()
384 conf := noise.Config{
385 CipherSuite: NoiseCipherSuite,
386 Pattern: noise.HandshakeIK,
388 StaticKeypair: noise.DHKey{
389 Private: state.Ctx.Self.NoisePrv[:],
390 Public: state.Ctx.Self.NoisePub[:],
393 hs, err := noise.NewHandshakeState(conf)
399 state.payloads = make(chan []byte)
400 state.infosOurSeen = make(map[[32]byte]uint8)
401 state.infosTheir = make(map[[32]byte]*SPInfo)
402 state.started = started
403 state.xxOnly = xxOnly
406 state.Ctx.LogD("sp-start", SDS{"nice": int(state.Nice)}, "waiting for first message")
407 conn.SetReadDeadline(time.Now().Add(DefaultDeadline * time.Second))
408 if buf, err = state.ReadSP(conn); err != nil {
409 state.Ctx.LogE("sp-start", SDS{}, err, "")
412 if payload, _, _, err = state.hs.ReadMessage(nil, buf); err != nil {
413 state.Ctx.LogE("sp-start", SDS{}, err, "")
418 for _, n := range state.Ctx.Neigh {
419 if subtle.ConstantTimeCompare(state.hs.PeerStatic(), n.NoisePub[:]) == 1 {
425 peerId := ToBase32(state.hs.PeerStatic())
426 state.Ctx.LogE("sp-start", SDS{"peer": peerId}, errors.New("unknown"), "")
427 return errors.New("Unknown peer: " + peerId)
430 state.rxRate = node.RxRate
431 state.txRate = node.TxRate
432 state.onlineDeadline = node.OnlineDeadline
433 state.maxOnlineTime = node.MaxOnlineTime
434 sds := SDS{"node": node.Id, "nice": int(state.Nice)}
436 if state.Ctx.ensureRxDir(node.Id); err != nil {
440 if xxOnly == "" || xxOnly == TRx {
441 rxLock, err = state.Ctx.LockDir(node.Id, TRx)
446 state.rxLock = rxLock
448 if xxOnly == "" || xxOnly == TTx {
449 txLock, err = state.Ctx.LockDir(node.Id, TTx)
454 state.txLock = txLock
456 var infosPayloads [][]byte
457 if xxOnly == "" || xxOnly == TTx {
458 infosPayloads = state.Ctx.infosOur(node.Id, state.Nice, &state.infosOurSeen)
460 var firstPayload []byte
461 if len(infosPayloads) > 0 {
462 firstPayload = infosPayloads[0]
464 // Pad first payload, to hide actual number of existing files
465 for i := 0; i < (MaxSPSize-len(firstPayload))/SPHeadOverhead; i++ {
466 firstPayload = append(firstPayload, SPHaltMarshalized...)
469 state.Ctx.LogD("sp-start", sds, "sending first message")
470 buf, state.csTheir, state.csOur, err = state.hs.WriteMessage(nil, firstPayload)
475 conn.SetWriteDeadline(time.Now().Add(DefaultDeadline * time.Second))
476 if err = state.WriteSP(conn, buf); err != nil {
477 state.Ctx.LogE("sp-start", sds, err, "")
481 state.Ctx.LogD("sp-start", sds, "starting workers")
482 err = state.StartWorkers(conn, infosPayloads, payload)
490 func (state *SPState) StartWorkers(
492 infosPayloads [][]byte,
493 payload []byte) error {
494 sds := SDS{"node": state.Node.Id, "nice": int(state.Nice)}
495 if len(infosPayloads) > 1 {
497 for _, payload := range infosPayloads[1:] {
500 SdsAdd(sds, SDS{"size": len(payload)}),
501 "queuing remaining payload",
503 state.payloads <- payload
509 SdsAdd(sds, SDS{"size": len(payload)}),
510 "processing first payload",
512 replies, err := state.ProcessSP(payload)
514 state.Ctx.LogE("sp-work", sds, err, "")
519 for _, reply := range replies {
522 SdsAdd(sds, SDS{"size": len(reply)}),
525 state.payloads <- reply
529 if !state.listOnly && (state.xxOnly == "" || state.xxOnly == TTx) {
531 for range time.Tick(time.Second) {
532 if state.NotAlive() {
535 for _, payload := range state.Ctx.infosOur(
542 SdsAdd(sds, SDS{"size": len(payload)}),
545 state.payloads <- payload
558 if state.NotAlive() {
563 case payload = <-state.payloads:
566 SdsAdd(sds, SDS{"size": len(payload)}),
573 if len(state.queueTheir) == 0 {
574 state.Ctx.LogD("sp-xmit", sds, "file queue is empty")
576 time.Sleep(100 * time.Millisecond)
579 freq := state.queueTheir[0].freq
582 if state.txRate > 0 {
583 time.Sleep(time.Second / time.Duration(state.txRate))
586 sdsp := SdsAdd(sds, SDS{
588 "pkt": ToBase32(freq.Hash[:]),
589 "size": int64(freq.Offset),
591 state.Ctx.LogD("sp-file", sdsp, "queueing")
592 fd, err := os.Open(filepath.Join(
594 state.Node.Id.String(),
596 ToBase32(freq.Hash[:]),
599 state.Ctx.LogE("sp-file", sdsp, err, "")
604 state.Ctx.LogE("sp-file", sdsp, err, "")
607 fullSize := fi.Size()
609 if freq.Offset < uint64(fullSize) {
610 state.Ctx.LogD("sp-file", sdsp, "seeking")
611 if _, err = fd.Seek(int64(freq.Offset), io.SeekStart); err != nil {
612 state.Ctx.LogE("sp-file", sdsp, err, "")
615 buf = make([]byte, MaxSPSize-SPHeadOverhead-SPFileOverhead)
616 n, err := fd.Read(buf)
618 state.Ctx.LogE("sp-file", sdsp, err, "")
624 SdsAdd(sdsp, SDS{"size": n}),
629 payload = MarshalSP(SPTypeFile, SPFile{
634 ourSize := freq.Offset + uint64(len(buf))
635 sdsp["size"] = int64(ourSize)
636 sdsp["fullsize"] = fullSize
637 if state.Ctx.ShowPrgrs {
641 if len(state.queueTheir) > 0 && *state.queueTheir[0].freq.Hash == *freq.Hash {
642 if ourSize == uint64(fullSize) {
643 state.Ctx.LogD("sp-file", sdsp, "finished")
644 if len(state.queueTheir) > 1 {
645 state.queueTheir = state.queueTheir[1:]
647 state.queueTheir = state.queueTheir[:0]
650 state.queueTheir[0].freq.Offset += uint64(len(buf))
653 state.Ctx.LogD("sp-file", sdsp, "queue disappeared")
659 SdsAdd(sds, SDS{"size": len(payload)}),
662 conn.SetWriteDeadline(time.Now().Add(DefaultDeadline * time.Second))
663 if err := state.WriteSP(conn, state.csOur.Encrypt(nil, nil, payload)); err != nil {
664 state.Ctx.LogE("sp-xmit", sds, err, "")
677 if state.NotAlive() {
680 state.Ctx.LogD("sp-recv", sds, "waiting for payload")
681 conn.SetReadDeadline(time.Now().Add(DefaultDeadline * time.Second))
682 payload, err := state.ReadSP(conn)
687 unmarshalErr := err.(*xdr.UnmarshalError)
688 netErr, ok := unmarshalErr.Err.(net.Error)
689 if ok && netErr.Timeout() {
692 if unmarshalErr.ErrorCode == xdr.ErrIO {
695 state.Ctx.LogE("sp-recv", sds, err, "")
700 SdsAdd(sds, SDS{"size": len(payload)}),
703 payload, err = state.csTheir.Decrypt(nil, nil, payload)
705 state.Ctx.LogE("sp-recv", sds, err, "")
710 SdsAdd(sds, SDS{"size": len(payload)}),
713 replies, err := state.ProcessSP(payload)
715 state.Ctx.LogE("sp-recv", sds, err, "")
719 for _, reply := range replies {
722 SdsAdd(sds, SDS{"size": len(reply)}),
725 state.payloads <- reply
728 if state.rxRate > 0 {
729 time.Sleep(time.Second / time.Duration(state.rxRate))
737 func (state *SPState) Wait() {
740 state.Duration = time.Now().Sub(state.started)
741 state.RxSpeed = state.RxBytes
742 state.TxSpeed = state.TxBytes
743 rxDuration := int64(state.RxLastSeen.Sub(state.started).Seconds())
744 txDuration := int64(state.TxLastSeen.Sub(state.started).Seconds())
746 state.RxSpeed = state.RxBytes / rxDuration
749 state.TxSpeed = state.TxBytes / txDuration
753 func (state *SPState) ProcessSP(payload []byte) ([][]byte, error) {
754 sds := SDS{"node": state.Node.Id, "nice": int(state.Nice)}
755 r := bytes.NewReader(payload)
760 state.Ctx.LogD("sp-process", sds, "unmarshaling header")
762 if _, err = xdr.Unmarshal(r, &head); err != nil {
763 state.Ctx.LogE("sp-process", sds, err, "")
769 sdsp := SdsAdd(sds, SDS{"type": "info"})
770 state.Ctx.LogD("sp-process", sdsp, "unmarshaling packet")
772 if _, err = xdr.Unmarshal(r, &info); err != nil {
773 state.Ctx.LogE("sp-process", sdsp, err, "")
776 sdsp = SdsAdd(sds, SDS{
777 "pkt": ToBase32(info.Hash[:]),
778 "size": int64(info.Size),
779 "nice": int(info.Nice),
781 if !state.listOnly && info.Nice > state.Nice {
782 state.Ctx.LogD("sp-process", sdsp, "too nice")
785 state.Ctx.LogD("sp-process", sdsp, "received")
786 if !state.listOnly && state.xxOnly == TTx {
790 state.infosTheir[*info.Hash] = &info
792 state.Ctx.LogD("sp-process", sdsp, "stating part")
793 pktPath := filepath.Join(
795 state.Node.Id.String(),
797 ToBase32(info.Hash[:]),
799 if _, err = os.Stat(pktPath); err == nil {
800 state.Ctx.LogI("sp-info", sdsp, "already done")
802 replies = append(replies, MarshalSP(SPTypeDone, SPDone{info.Hash}))
806 if _, err = os.Stat(pktPath + SeenSuffix); err == nil {
807 state.Ctx.LogI("sp-info", sdsp, "already seen")
809 replies = append(replies, MarshalSP(SPTypeDone, SPDone{info.Hash}))
813 fi, err := os.Stat(pktPath + PartSuffix)
818 if !state.Ctx.IsEnoughSpace(int64(info.Size) - offset) {
819 state.Ctx.LogI("sp-info", sdsp, "not enough space")
824 SdsAdd(sdsp, SDS{"offset": offset}),
827 if !state.listOnly && (state.onlyPkts == nil || state.onlyPkts[*info.Hash]) {
828 replies = append(replies, MarshalSP(
830 SPFreq{info.Hash, uint64(offset)},
834 sdsp := SdsAdd(sds, SDS{"type": "file"})
835 state.Ctx.LogD("sp-process", sdsp, "unmarshaling packet")
837 if _, err = xdr.Unmarshal(r, &file); err != nil {
838 state.Ctx.LogE("sp-process", SdsAdd(sds, SDS{"type": "file"}), err, "")
841 sdsp["xx"] = string(TRx)
842 sdsp["pkt"] = ToBase32(file.Hash[:])
843 sdsp["size"] = len(file.Payload)
844 dirToSync := filepath.Join(
846 state.Node.Id.String(),
849 filePath := filepath.Join(dirToSync, ToBase32(file.Hash[:]))
850 state.Ctx.LogD("sp-file", sdsp, "opening part")
851 fd, err := os.OpenFile(
853 os.O_RDWR|os.O_CREATE,
857 state.Ctx.LogE("sp-file", sdsp, err, "")
862 SdsAdd(sdsp, SDS{"offset": file.Offset}),
865 if _, err = fd.Seek(int64(file.Offset), io.SeekStart); err != nil {
866 state.Ctx.LogE("sp-file", sdsp, err, "")
870 state.Ctx.LogD("sp-file", sdsp, "writing")
871 _, err = fd.Write(file.Payload)
873 state.Ctx.LogE("sp-file", sdsp, err, "")
877 ourSize := file.Offset + uint64(len(file.Payload))
879 sdsp["size"] = int64(ourSize)
880 sdsp["fullsize"] = int64(state.infosTheir[*file.Hash].Size)
881 if state.Ctx.ShowPrgrs {
884 if state.infosTheir[*file.Hash].Size != ourSize {
890 spWorkersGroup.Wait()
891 spWorkersGroup.Add(1)
893 if err := fd.Sync(); err != nil {
894 state.Ctx.LogE("sp-file", sdsp, err, "sync")
899 defer state.wg.Done()
900 fd.Seek(0, io.SeekStart)
901 state.Ctx.LogD("sp-file", sdsp, "checking")
902 gut, err := Check(fd, file.Hash[:], sdsp, state.Ctx.ShowPrgrs)
904 if err != nil || !gut {
905 state.Ctx.LogE("sp-file", sdsp, errors.New("checksum mismatch"), "")
908 state.Ctx.LogI("sp-done", SdsAdd(sdsp, SDS{"xx": string(TRx)}), "")
909 if err = os.Rename(filePath+PartSuffix, filePath); err != nil {
910 state.Ctx.LogE("sp-file", sdsp, err, "rename")
913 if err = DirSync(dirToSync); err != nil {
914 state.Ctx.LogE("sp-file", sdsp, err, "sync")
918 delete(state.infosTheir, *file.Hash)
920 spWorkersGroup.Done()
922 state.payloads <- MarshalSP(SPTypeDone, SPDone{file.Hash})
926 sdsp := SdsAdd(sds, SDS{"type": "done"})
927 state.Ctx.LogD("sp-process", sdsp, "unmarshaling packet")
929 if _, err = xdr.Unmarshal(r, &done); err != nil {
930 state.Ctx.LogE("sp-process", SdsAdd(sds, SDS{"type": "done"}), err, "")
933 sdsp["pkt"] = ToBase32(done.Hash[:])
934 state.Ctx.LogD("sp-done", sdsp, "removing")
935 err := os.Remove(filepath.Join(
937 state.Node.Id.String(),
939 ToBase32(done.Hash[:]),
941 sdsp["xx"] = string(TTx)
943 state.Ctx.LogI("sp-done", sdsp, "")
945 state.Ctx.LogE("sp-done", sdsp, err, "")
948 sdsp := SdsAdd(sds, SDS{"type": "freq"})
949 state.Ctx.LogD("sp-process", sdsp, "unmarshaling packet")
951 if _, err = xdr.Unmarshal(r, &freq); err != nil {
952 state.Ctx.LogE("sp-process", sdsp, err, "")
955 sdsp["pkt"] = ToBase32(freq.Hash[:])
956 sdsp["offset"] = freq.Offset
957 state.Ctx.LogD("sp-process", sdsp, "queueing")
958 nice, exists := state.infosOurSeen[*freq.Hash]
960 if state.onlyPkts == nil || !state.onlyPkts[*freq.Hash] {
963 var freqWithNice *FreqWithNice
964 for insertIdx, freqWithNice = range state.queueTheir {
965 if freqWithNice.nice > nice {
969 state.queueTheir = append(state.queueTheir, nil)
970 copy(state.queueTheir[insertIdx+1:], state.queueTheir[insertIdx:])
971 state.queueTheir[insertIdx] = &FreqWithNice{&freq, nice}
974 state.Ctx.LogD("sp-process", sdsp, "skipping")
977 state.Ctx.LogD("sp-process", sdsp, "unknown")
980 state.Ctx.LogD("sp-process", SdsAdd(sds, SDS{"type": "halt"}), "")
982 state.queueTheir = nil
987 SdsAdd(sds, SDS{"type": head.Type}),
988 errors.New("unknown type"),
991 return nil, BadPktType
998 for _, info := range state.infosTheir {
1003 state.Ctx.LogI("sp-infos", SDS{
1005 "node": state.Node.Id,
1007 "size": int64(size),
1010 return payloadsSplit(replies), nil