2 NNCP -- Node to Node copy, utilities for store-and-forward data exchange
3 Copyright (C) 2016-2019 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
43 MagicNNCPLv1 [8]byte = [8]byte{'N', 'N', 'C', 'P', 'S', 0, 0, 1}
49 SPHaltMarshalized []byte
51 NoiseCipherSuite noise.CipherSuite = noise.NewCipherSuite(
53 noise.CipherChaChaPoly,
57 spWorkersGroup sync.WaitGroup
63 SPTypeInfo SPType = iota
64 SPTypeFreq SPType = iota
65 SPTypeFile SPType = iota
66 SPTypeDone SPType = iota
67 SPTypeHalt SPType = iota
100 type FreqWithNice struct {
105 type ConnDeadlined interface {
107 SetReadDeadline(t time.Time) error
108 SetWriteDeadline(t time.Time) error
113 spHead := SPHead{Type: SPTypeHalt}
114 if _, err := xdr.Marshal(&buf, spHead); err != nil {
117 copy(SPHaltMarshalized, buf.Bytes())
118 SPHeadOverhead = buf.Len()
121 spInfo := SPInfo{Nice: 123, Size: 123, Hash: new([32]byte)}
122 if _, err := xdr.Marshal(&buf, spInfo); err != nil {
125 SPInfoOverhead = buf.Len()
128 spFreq := SPFreq{Hash: new([32]byte), Offset: 123}
129 if _, err := xdr.Marshal(&buf, spFreq); err != nil {
132 SPFreqOverhead = buf.Len()
135 spFile := SPFile{Hash: new([32]byte), Offset: 123}
136 if _, err := xdr.Marshal(&buf, spFile); err != nil {
139 SPFileOverhead = buf.Len()
142 func MarshalSP(typ SPType, sp interface{}) []byte {
145 if _, err = xdr.Marshal(&buf, SPHead{typ}); err != nil {
148 if _, err = xdr.Marshal(&buf, sp); err != nil {
154 func payloadsSplit(payloads [][]byte) [][]byte {
155 var outbounds [][]byte
156 outbound := make([]byte, 0, MaxSPSize)
157 for i, payload := range payloads {
158 outbound = append(outbound, payload...)
159 if i+1 < len(payloads) && len(outbound)+len(payloads[i+1]) > MaxSPSize {
160 outbounds = append(outbounds, outbound)
161 outbound = make([]byte, 0, MaxSPSize)
164 if len(outbound) > 0 {
165 outbounds = append(outbounds, outbound)
170 type SPState struct {
176 hs *noise.HandshakeState
177 csOur *noise.CipherState
178 csTheir *noise.CipherState
180 infosTheir map[[32]byte]*SPInfo
181 infosOurSeen map[[32]byte]uint8
182 queueTheir []*FreqWithNice
189 Duration time.Duration
199 onlyPkts map[[32]byte]bool
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)
233 ue := err.(*xdr.UnmarshalError)
234 if ue.Err == io.EOF {
239 state.RxLastSeen = time.Now()
240 state.RxBytes += int64(n)
241 if sp.Magic != MagicNNCPLv1 {
244 return sp.Payload, nil
247 func (ctx *Ctx) infosOur(nodeId *NodeId, nice uint8, seen *map[[32]byte]uint8) [][]byte {
250 for job := range ctx.Jobs(nodeId, TTx) {
252 if job.PktEnc.Nice > nice {
255 if _, known := (*seen)[*job.HshValue]; known {
258 totalSize += job.Size
259 infos = append(infos, &SPInfo{
260 Nice: job.PktEnc.Nice,
261 Size: uint64(job.Size),
264 (*seen)[*job.HshValue] = job.PktEnc.Nice
266 sort.Sort(ByNice(infos))
267 var payloads [][]byte
268 for _, info := range infos {
269 payloads = append(payloads, MarshalSP(SPTypeInfo, info))
270 ctx.LogD("sp-info-our", SDS{
272 "name": ToBase32(info.Hash[:]),
277 ctx.LogI("sp-infos", SDS{
280 "pkts": len(payloads),
284 return payloadsSplit(payloads)
287 func (state *SPState) StartI(conn ConnDeadlined) error {
288 nodeId := state.Node.Id
289 err := state.Ctx.ensureRxDir(nodeId)
294 if !state.listOnly && (state.xxOnly == "" || state.xxOnly == TRx) {
295 rxLock, err = state.Ctx.LockDir(nodeId, TRx)
301 if !state.listOnly && (state.xxOnly == "" || state.xxOnly == TTx) {
302 txLock, err = state.Ctx.LockDir(nodeId, TTx)
307 started := time.Now()
308 conf := noise.Config{
309 CipherSuite: NoiseCipherSuite,
310 Pattern: noise.HandshakeIK,
312 StaticKeypair: noise.DHKey{
313 Private: state.Ctx.Self.NoisePrv[:],
314 Public: state.Ctx.Self.NoisePub[:],
316 PeerStatic: state.Node.NoisePub[:],
318 hs, err := noise.NewHandshakeState(conf)
323 state.payloads = make(chan []byte)
324 state.infosTheir = make(map[[32]byte]*SPInfo)
325 state.infosOurSeen = make(map[[32]byte]uint8)
326 state.started = started
327 state.rxLock = rxLock
328 state.txLock = txLock
330 var infosPayloads [][]byte
331 if !state.listOnly && (state.xxOnly == "" || state.xxOnly == TTx) {
332 infosPayloads = state.Ctx.infosOur(nodeId, state.Nice, &state.infosOurSeen)
334 var firstPayload []byte
335 if len(infosPayloads) > 0 {
336 firstPayload = infosPayloads[0]
338 // Pad first payload, to hide actual number of existing files
339 for i := 0; i < (MaxSPSize-len(firstPayload))/SPHeadOverhead; i++ {
340 firstPayload = append(firstPayload, SPHaltMarshalized...)
345 buf, _, _, err = state.hs.WriteMessage(nil, firstPayload)
350 sds := SDS{"node": nodeId, "nice": int(state.Nice)}
351 state.Ctx.LogD("sp-start", sds, "sending first message")
352 conn.SetWriteDeadline(time.Now().Add(DefaultDeadline * time.Second))
353 if err = state.WriteSP(conn, buf); err != nil {
354 state.Ctx.LogE("sp-start", sds, err, "")
358 state.Ctx.LogD("sp-start", sds, "waiting for first message")
359 conn.SetReadDeadline(time.Now().Add(DefaultDeadline * time.Second))
360 if buf, err = state.ReadSP(conn); err != nil {
361 state.Ctx.LogE("sp-start", sds, err, "")
365 payload, state.csOur, state.csTheir, err = state.hs.ReadMessage(nil, buf)
367 state.Ctx.LogE("sp-start", sds, err, "")
371 state.Ctx.LogD("sp-start", sds, "starting workers")
372 err = state.StartWorkers(conn, infosPayloads, payload)
374 state.Ctx.LogE("sp-start", sds, err, "")
381 func (state *SPState) StartR(conn ConnDeadlined) error {
382 started := time.Now()
383 conf := noise.Config{
384 CipherSuite: NoiseCipherSuite,
385 Pattern: noise.HandshakeIK,
387 StaticKeypair: noise.DHKey{
388 Private: state.Ctx.Self.NoisePrv[:],
389 Public: state.Ctx.Self.NoisePub[:],
392 hs, err := noise.NewHandshakeState(conf)
398 state.payloads = make(chan []byte)
399 state.infosOurSeen = make(map[[32]byte]uint8)
400 state.infosTheir = make(map[[32]byte]*SPInfo)
401 state.started = started
402 state.xxOnly = xxOnly
405 state.Ctx.LogD("sp-start", SDS{"nice": int(state.Nice)}, "waiting for first message")
406 conn.SetReadDeadline(time.Now().Add(DefaultDeadline * time.Second))
407 if buf, err = state.ReadSP(conn); err != nil {
408 state.Ctx.LogE("sp-start", SDS{}, err, "")
411 if payload, _, _, err = state.hs.ReadMessage(nil, buf); err != nil {
412 state.Ctx.LogE("sp-start", SDS{}, err, "")
417 for _, n := range state.Ctx.Neigh {
418 if subtle.ConstantTimeCompare(state.hs.PeerStatic(), n.NoisePub[:]) == 1 {
424 peerId := ToBase32(state.hs.PeerStatic())
425 state.Ctx.LogE("sp-start", SDS{"peer": peerId}, errors.New("unknown"), "")
426 return errors.New("Unknown peer: " + peerId)
429 state.rxRate = node.RxRate
430 state.txRate = node.TxRate
431 state.onlineDeadline = node.OnlineDeadline
432 state.maxOnlineTime = node.MaxOnlineTime
433 sds := SDS{"node": node.Id, "nice": int(state.Nice)}
435 if state.Ctx.ensureRxDir(node.Id); err != nil {
439 if xxOnly == "" || xxOnly == TRx {
440 rxLock, err = state.Ctx.LockDir(node.Id, TRx)
445 state.rxLock = rxLock
447 if xxOnly == "" || xxOnly == TTx {
448 txLock, err = state.Ctx.LockDir(node.Id, TTx)
453 state.txLock = txLock
455 var infosPayloads [][]byte
456 if xxOnly == "" || xxOnly == TTx {
457 infosPayloads = state.Ctx.infosOur(node.Id, state.Nice, &state.infosOurSeen)
459 var firstPayload []byte
460 if len(infosPayloads) > 0 {
461 firstPayload = infosPayloads[0]
463 // Pad first payload, to hide actual number of existing files
464 for i := 0; i < (MaxSPSize-len(firstPayload))/SPHeadOverhead; i++ {
465 firstPayload = append(firstPayload, SPHaltMarshalized...)
468 state.Ctx.LogD("sp-start", sds, "sending first message")
469 buf, state.csTheir, state.csOur, err = state.hs.WriteMessage(nil, firstPayload)
474 conn.SetWriteDeadline(time.Now().Add(DefaultDeadline * time.Second))
475 if err = state.WriteSP(conn, buf); err != nil {
476 state.Ctx.LogE("sp-start", sds, err, "")
480 state.Ctx.LogD("sp-start", sds, "starting workers")
481 err = state.StartWorkers(conn, infosPayloads, payload)
489 func (state *SPState) StartWorkers(
491 infosPayloads [][]byte,
492 payload []byte) error {
493 sds := SDS{"node": state.Node.Id, "nice": int(state.Nice)}
494 if len(infosPayloads) > 1 {
496 for _, payload := range infosPayloads[1:] {
499 SdsAdd(sds, SDS{"size": len(payload)}),
500 "queuing remaining payload",
502 state.payloads <- payload
508 SdsAdd(sds, SDS{"size": len(payload)}),
509 "processing first payload",
511 replies, err := state.ProcessSP(payload)
513 state.Ctx.LogE("sp-work", sds, err, "")
518 for _, reply := range replies {
521 SdsAdd(sds, SDS{"size": len(reply)}),
524 state.payloads <- reply
528 if !state.listOnly && (state.xxOnly == "" || state.xxOnly == TTx) {
530 for range time.Tick(time.Second) {
531 if state.NotAlive() {
534 for _, payload := range state.Ctx.infosOur(
541 SdsAdd(sds, SDS{"size": len(payload)}),
544 state.payloads <- payload
557 if state.NotAlive() {
562 case payload = <-state.payloads:
565 SdsAdd(sds, SDS{"size": len(payload)}),
572 if len(state.queueTheir) == 0 {
573 state.Ctx.LogD("sp-xmit", sds, "file queue is empty")
575 time.Sleep(100 * time.Millisecond)
578 freq := state.queueTheir[0].freq
581 if state.txRate > 0 {
582 time.Sleep(time.Second / time.Duration(state.txRate))
585 sdsp := SdsAdd(sds, SDS{
587 "pkt": ToBase32(freq.Hash[:]),
588 "size": int64(freq.Offset),
590 state.Ctx.LogD("sp-file", sdsp, "queueing")
591 fd, err := os.Open(filepath.Join(
593 state.Node.Id.String(),
595 ToBase32(freq.Hash[:]),
598 state.Ctx.LogE("sp-file", sdsp, err, "")
603 state.Ctx.LogE("sp-file", sdsp, err, "")
606 fullSize := fi.Size()
608 if freq.Offset < uint64(fullSize) {
609 state.Ctx.LogD("sp-file", sdsp, "seeking")
610 if _, err = fd.Seek(int64(freq.Offset), io.SeekStart); err != nil {
611 state.Ctx.LogE("sp-file", sdsp, err, "")
614 buf = make([]byte, MaxSPSize-SPHeadOverhead-SPFileOverhead)
615 n, err := fd.Read(buf)
617 state.Ctx.LogE("sp-file", sdsp, err, "")
623 SdsAdd(sdsp, SDS{"size": n}),
628 payload = MarshalSP(SPTypeFile, SPFile{
633 ourSize := freq.Offset + uint64(len(buf))
634 sdsp["size"] = int64(ourSize)
635 sdsp["fullsize"] = fullSize
636 if state.Ctx.ShowPrgrs {
640 if len(state.queueTheir) > 0 && *state.queueTheir[0].freq.Hash == *freq.Hash {
641 if ourSize == uint64(fullSize) {
642 state.Ctx.LogD("sp-file", sdsp, "finished")
643 if len(state.queueTheir) > 1 {
644 state.queueTheir = state.queueTheir[1:]
646 state.queueTheir = state.queueTheir[:0]
649 state.queueTheir[0].freq.Offset += uint64(len(buf))
652 state.Ctx.LogD("sp-file", sdsp, "queue disappeared")
658 SdsAdd(sds, SDS{"size": len(payload)}),
661 conn.SetWriteDeadline(time.Now().Add(DefaultDeadline * time.Second))
662 if err := state.WriteSP(conn, state.csOur.Encrypt(nil, nil, payload)); err != nil {
663 state.Ctx.LogE("sp-xmit", sds, err, "")
676 if state.NotAlive() {
679 state.Ctx.LogD("sp-recv", sds, "waiting for payload")
680 conn.SetReadDeadline(time.Now().Add(DefaultDeadline * time.Second))
681 payload, err := state.ReadSP(conn)
686 unmarshalErr := err.(*xdr.UnmarshalError)
687 netErr, ok := unmarshalErr.Err.(net.Error)
688 if ok && netErr.Timeout() {
691 if unmarshalErr.ErrorCode == xdr.ErrIO {
694 state.Ctx.LogE("sp-recv", sds, err, "")
699 SdsAdd(sds, SDS{"size": len(payload)}),
702 payload, err = state.csTheir.Decrypt(nil, nil, payload)
704 state.Ctx.LogE("sp-recv", sds, err, "")
709 SdsAdd(sds, SDS{"size": len(payload)}),
712 replies, err := state.ProcessSP(payload)
714 state.Ctx.LogE("sp-recv", sds, err, "")
718 for _, reply := range replies {
721 SdsAdd(sds, SDS{"size": len(reply)}),
724 state.payloads <- reply
727 if state.rxRate > 0 {
728 time.Sleep(time.Second / time.Duration(state.rxRate))
736 func (state *SPState) Wait() {
739 state.Duration = time.Now().Sub(state.started)
740 state.RxSpeed = state.RxBytes
741 state.TxSpeed = state.TxBytes
742 rxDuration := int64(state.RxLastSeen.Sub(state.started).Seconds())
743 txDuration := int64(state.TxLastSeen.Sub(state.started).Seconds())
745 state.RxSpeed = state.RxBytes / rxDuration
748 state.TxSpeed = state.TxBytes / txDuration
752 func (state *SPState) ProcessSP(payload []byte) ([][]byte, error) {
753 sds := SDS{"node": state.Node.Id, "nice": int(state.Nice)}
754 r := bytes.NewReader(payload)
759 state.Ctx.LogD("sp-process", sds, "unmarshaling header")
761 if _, err = xdr.Unmarshal(r, &head); err != nil {
762 state.Ctx.LogE("sp-process", sds, err, "")
768 sdsp := SdsAdd(sds, SDS{"type": "info"})
769 state.Ctx.LogD("sp-process", sdsp, "unmarshaling packet")
771 if _, err = xdr.Unmarshal(r, &info); err != nil {
772 state.Ctx.LogE("sp-process", sdsp, err, "")
775 sdsp = SdsAdd(sds, SDS{
776 "pkt": ToBase32(info.Hash[:]),
777 "size": int64(info.Size),
778 "nice": int(info.Nice),
780 if !state.listOnly && info.Nice > state.Nice {
781 state.Ctx.LogD("sp-process", sdsp, "too nice")
784 state.Ctx.LogD("sp-process", sdsp, "received")
785 if !state.listOnly && state.xxOnly == TTx {
789 state.infosTheir[*info.Hash] = &info
791 state.Ctx.LogD("sp-process", sdsp, "stating part")
792 pktPath := filepath.Join(
794 state.Node.Id.String(),
796 ToBase32(info.Hash[:]),
798 if _, err = os.Stat(pktPath); err == nil {
799 state.Ctx.LogI("sp-info", sdsp, "already done")
801 replies = append(replies, MarshalSP(SPTypeDone, SPDone{info.Hash}))
805 if _, err = os.Stat(pktPath + SeenSuffix); err == nil {
806 state.Ctx.LogI("sp-info", sdsp, "already seen")
808 replies = append(replies, MarshalSP(SPTypeDone, SPDone{info.Hash}))
812 fi, err := os.Stat(pktPath + PartSuffix)
817 if !state.Ctx.IsEnoughSpace(int64(info.Size) - offset) {
818 state.Ctx.LogI("sp-info", sdsp, "not enough space")
823 SdsAdd(sdsp, SDS{"offset": offset}),
826 if !state.listOnly && (state.onlyPkts == nil || state.onlyPkts[*info.Hash]) {
827 replies = append(replies, MarshalSP(
829 SPFreq{info.Hash, uint64(offset)},
833 sdsp := SdsAdd(sds, SDS{"type": "file"})
834 state.Ctx.LogD("sp-process", sdsp, "unmarshaling packet")
836 if _, err = xdr.Unmarshal(r, &file); err != nil {
837 state.Ctx.LogE("sp-process", SdsAdd(sds, SDS{"type": "file"}), err, "")
840 sdsp["xx"] = string(TRx)
841 sdsp["pkt"] = ToBase32(file.Hash[:])
842 sdsp["size"] = len(file.Payload)
843 dirToSync := filepath.Join(
845 state.Node.Id.String(),
848 filePath := filepath.Join(dirToSync, ToBase32(file.Hash[:]))
849 state.Ctx.LogD("sp-file", sdsp, "opening part")
850 fd, err := os.OpenFile(
852 os.O_RDWR|os.O_CREATE,
856 state.Ctx.LogE("sp-file", sdsp, err, "")
861 SdsAdd(sdsp, SDS{"offset": file.Offset}),
864 if _, err = fd.Seek(int64(file.Offset), io.SeekStart); err != nil {
865 state.Ctx.LogE("sp-file", sdsp, err, "")
869 state.Ctx.LogD("sp-file", sdsp, "writing")
870 _, err = fd.Write(file.Payload)
872 state.Ctx.LogE("sp-file", sdsp, err, "")
876 ourSize := file.Offset + uint64(len(file.Payload))
878 sdsp["size"] = int64(ourSize)
879 sdsp["fullsize"] = int64(state.infosTheir[*file.Hash].Size)
880 if state.Ctx.ShowPrgrs {
883 if state.infosTheir[*file.Hash].Size != ourSize {
889 spWorkersGroup.Wait()
890 spWorkersGroup.Add(1)
892 if err := fd.Sync(); err != nil {
893 state.Ctx.LogE("sp-file", sdsp, err, "sync")
898 defer state.wg.Done()
899 fd.Seek(0, io.SeekStart)
900 state.Ctx.LogD("sp-file", sdsp, "checking")
901 gut, err := Check(fd, file.Hash[:], sdsp, state.Ctx.ShowPrgrs)
903 if err != nil || !gut {
904 state.Ctx.LogE("sp-file", sdsp, errors.New("checksum mismatch"), "")
907 state.Ctx.LogI("sp-done", SdsAdd(sdsp, SDS{"xx": string(TRx)}), "")
908 if err = os.Rename(filePath+PartSuffix, filePath); err != nil {
909 state.Ctx.LogE("sp-file", sdsp, err, "rename")
912 if err = DirSync(dirToSync); err != nil {
913 state.Ctx.LogE("sp-file", sdsp, err, "sync")
917 delete(state.infosTheir, *file.Hash)
919 spWorkersGroup.Done()
921 state.payloads <- MarshalSP(SPTypeDone, SPDone{file.Hash})
925 sdsp := SdsAdd(sds, SDS{"type": "done"})
926 state.Ctx.LogD("sp-process", sdsp, "unmarshaling packet")
928 if _, err = xdr.Unmarshal(r, &done); err != nil {
929 state.Ctx.LogE("sp-process", SdsAdd(sds, SDS{"type": "done"}), err, "")
932 sdsp["pkt"] = ToBase32(done.Hash[:])
933 state.Ctx.LogD("sp-done", sdsp, "removing")
934 err := os.Remove(filepath.Join(
936 state.Node.Id.String(),
938 ToBase32(done.Hash[:]),
940 sdsp["xx"] = string(TTx)
942 state.Ctx.LogI("sp-done", sdsp, "")
944 state.Ctx.LogE("sp-done", sdsp, err, "")
947 sdsp := SdsAdd(sds, SDS{"type": "freq"})
948 state.Ctx.LogD("sp-process", sdsp, "unmarshaling packet")
950 if _, err = xdr.Unmarshal(r, &freq); err != nil {
951 state.Ctx.LogE("sp-process", sdsp, err, "")
954 sdsp["pkt"] = ToBase32(freq.Hash[:])
955 sdsp["offset"] = freq.Offset
956 state.Ctx.LogD("sp-process", sdsp, "queueing")
957 nice, exists := state.infosOurSeen[*freq.Hash]
959 if state.onlyPkts == nil || !state.onlyPkts[*freq.Hash] {
962 var freqWithNice *FreqWithNice
963 for insertIdx, freqWithNice = range state.queueTheir {
964 if freqWithNice.nice > nice {
968 state.queueTheir = append(state.queueTheir, nil)
969 copy(state.queueTheir[insertIdx+1:], state.queueTheir[insertIdx:])
970 state.queueTheir[insertIdx] = &FreqWithNice{&freq, nice}
973 state.Ctx.LogD("sp-process", sdsp, "skipping")
976 state.Ctx.LogD("sp-process", sdsp, "unknown")
979 state.Ctx.LogD("sp-process", SdsAdd(sds, SDS{"type": "halt"}), "")
981 state.queueTheir = nil
986 SdsAdd(sds, SDS{"type": head.Type}),
987 errors.New("unknown type"),
990 return nil, BadPktType
997 for _, info := range state.infosTheir {
1002 state.Ctx.LogI("sp-infos", SDS{
1004 "node": state.Node.Id,
1006 "size": int64(size),
1009 return payloadsSplit(replies), nil