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, "")
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)
488 func (state *SPState) StartWorkers(
490 infosPayloads [][]byte,
491 payload []byte) error {
492 sds := SDS{"node": state.Node.Id, "nice": int(state.Nice)}
493 if len(infosPayloads) > 1 {
495 for _, payload := range infosPayloads[1:] {
498 SdsAdd(sds, SDS{"size": len(payload)}),
499 "queuing remaining payload",
501 state.payloads <- payload
507 SdsAdd(sds, SDS{"size": len(payload)}),
508 "processing first payload",
510 replies, err := state.ProcessSP(payload)
512 state.Ctx.LogE("sp-work", sds, err, "")
517 for _, reply := range replies {
520 SdsAdd(sds, SDS{"size": len(reply)}),
523 state.payloads <- reply
527 if !state.listOnly && (state.xxOnly == "" || state.xxOnly == TTx) {
529 for range time.Tick(time.Second) {
530 if state.NotAlive() {
533 for _, payload := range state.Ctx.infosOur(
540 SdsAdd(sds, SDS{"size": len(payload)}),
543 state.payloads <- payload
556 if state.NotAlive() {
561 case payload = <-state.payloads:
564 SdsAdd(sds, SDS{"size": len(payload)}),
571 if len(state.queueTheir) == 0 {
573 time.Sleep(100 * time.Millisecond)
576 freq := state.queueTheir[0].freq
579 if state.txRate > 0 {
580 time.Sleep(time.Second / time.Duration(state.txRate))
583 sdsp := SdsAdd(sds, SDS{
585 "pkt": ToBase32(freq.Hash[:]),
586 "size": int64(freq.Offset),
588 state.Ctx.LogD("sp-file", sdsp, "queueing")
589 fd, err := os.Open(filepath.Join(
591 state.Node.Id.String(),
593 ToBase32(freq.Hash[:]),
596 state.Ctx.LogE("sp-file", sdsp, err, "")
601 state.Ctx.LogE("sp-file", sdsp, err, "")
604 fullSize := fi.Size()
606 if freq.Offset < uint64(fullSize) {
607 state.Ctx.LogD("sp-file", sdsp, "seeking")
608 if _, err = fd.Seek(int64(freq.Offset), io.SeekStart); err != nil {
609 state.Ctx.LogE("sp-file", sdsp, err, "")
612 buf = make([]byte, MaxSPSize-SPHeadOverhead-SPFileOverhead)
613 n, err := fd.Read(buf)
615 state.Ctx.LogE("sp-file", sdsp, err, "")
621 SdsAdd(sdsp, SDS{"size": n}),
626 payload = MarshalSP(SPTypeFile, SPFile{
631 ourSize := freq.Offset + uint64(len(buf))
632 sdsp["size"] = int64(ourSize)
633 sdsp["fullsize"] = fullSize
634 if state.Ctx.ShowPrgrs {
638 if len(state.queueTheir) > 0 && *state.queueTheir[0].freq.Hash == *freq.Hash {
639 if ourSize == uint64(fullSize) {
640 state.Ctx.LogD("sp-file", sdsp, "finished")
641 if len(state.queueTheir) > 1 {
642 state.queueTheir = state.queueTheir[1:]
644 state.queueTheir = state.queueTheir[:0]
647 state.queueTheir[0].freq.Offset += uint64(len(buf))
650 state.Ctx.LogD("sp-file", sdsp, "queue disappeared")
656 SdsAdd(sds, SDS{"size": len(payload)}),
659 conn.SetWriteDeadline(time.Now().Add(DefaultDeadline * time.Second))
660 if err := state.WriteSP(conn, state.csOur.Encrypt(nil, nil, payload)); err != nil {
661 state.Ctx.LogE("sp-xmit", sds, err, "")
674 if state.NotAlive() {
677 state.Ctx.LogD("sp-recv", sds, "waiting for payload")
678 conn.SetReadDeadline(time.Now().Add(DefaultDeadline * time.Second))
679 payload, err := state.ReadSP(conn)
684 unmarshalErr := err.(*xdr.UnmarshalError)
685 netErr, ok := unmarshalErr.Err.(net.Error)
686 if ok && netErr.Timeout() {
689 if unmarshalErr.ErrorCode == xdr.ErrIO {
692 state.Ctx.LogE("sp-recv", sds, err, "")
697 SdsAdd(sds, SDS{"size": len(payload)}),
700 payload, err = state.csTheir.Decrypt(nil, nil, payload)
702 state.Ctx.LogE("sp-recv", sds, err, "")
707 SdsAdd(sds, SDS{"size": len(payload)}),
710 replies, err := state.ProcessSP(payload)
712 state.Ctx.LogE("sp-recv", sds, err, "")
716 for _, reply := range replies {
719 SdsAdd(sds, SDS{"size": len(reply)}),
722 state.payloads <- reply
725 if state.rxRate > 0 {
726 time.Sleep(time.Second / time.Duration(state.rxRate))
734 func (state *SPState) Wait() {
737 state.Duration = time.Now().Sub(state.started)
738 state.RxSpeed = state.RxBytes
739 state.TxSpeed = state.TxBytes
740 rxDuration := int64(state.RxLastSeen.Sub(state.started).Seconds())
741 txDuration := int64(state.TxLastSeen.Sub(state.started).Seconds())
743 state.RxSpeed = state.RxBytes / rxDuration
746 state.TxSpeed = state.TxBytes / txDuration
750 func (state *SPState) ProcessSP(payload []byte) ([][]byte, error) {
751 sds := SDS{"node": state.Node.Id, "nice": int(state.Nice)}
752 r := bytes.NewReader(payload)
757 state.Ctx.LogD("sp-process", sds, "unmarshaling header")
759 if _, err = xdr.Unmarshal(r, &head); err != nil {
760 state.Ctx.LogE("sp-process", sds, err, "")
766 sdsp := SdsAdd(sds, SDS{"type": "info"})
767 state.Ctx.LogD("sp-process", sdsp, "unmarshaling packet")
769 if _, err = xdr.Unmarshal(r, &info); err != nil {
770 state.Ctx.LogE("sp-process", sdsp, err, "")
773 sdsp = SdsAdd(sds, SDS{
774 "pkt": ToBase32(info.Hash[:]),
775 "size": int64(info.Size),
776 "nice": int(info.Nice),
778 if !state.listOnly && info.Nice > state.Nice {
779 state.Ctx.LogD("sp-process", sdsp, "too nice")
782 state.Ctx.LogD("sp-process", sdsp, "received")
783 if !state.listOnly && state.xxOnly == TTx {
787 state.infosTheir[*info.Hash] = &info
789 state.Ctx.LogD("sp-process", sdsp, "stating part")
790 pktPath := filepath.Join(
792 state.Node.Id.String(),
794 ToBase32(info.Hash[:]),
796 if _, err = os.Stat(pktPath); err == nil {
797 state.Ctx.LogI("sp-info", sdsp, "already done")
799 replies = append(replies, MarshalSP(SPTypeDone, SPDone{info.Hash}))
803 if _, err = os.Stat(pktPath + SeenSuffix); err == nil {
804 state.Ctx.LogI("sp-info", sdsp, "already seen")
806 replies = append(replies, MarshalSP(SPTypeDone, SPDone{info.Hash}))
810 fi, err := os.Stat(pktPath + PartSuffix)
815 if !state.Ctx.IsEnoughSpace(int64(info.Size) - offset) {
816 state.Ctx.LogI("sp-info", sdsp, "not enough space")
821 SdsAdd(sdsp, SDS{"offset": offset}),
824 if !state.listOnly && (state.onlyPkts == nil || state.onlyPkts[*info.Hash]) {
825 replies = append(replies, MarshalSP(
827 SPFreq{info.Hash, uint64(offset)},
831 sdsp := SdsAdd(sds, SDS{"type": "file"})
832 state.Ctx.LogD("sp-process", sdsp, "unmarshaling packet")
834 if _, err = xdr.Unmarshal(r, &file); err != nil {
835 state.Ctx.LogE("sp-process", SdsAdd(sds, SDS{"type": "file"}), err, "")
838 sdsp["xx"] = string(TRx)
839 sdsp["pkt"] = ToBase32(file.Hash[:])
840 sdsp["size"] = len(file.Payload)
841 dirToSync := filepath.Join(
843 state.Node.Id.String(),
846 filePath := filepath.Join(dirToSync, ToBase32(file.Hash[:]))
847 state.Ctx.LogD("sp-file", sdsp, "opening part")
848 fd, err := os.OpenFile(
850 os.O_RDWR|os.O_CREATE,
854 state.Ctx.LogE("sp-file", sdsp, err, "")
859 SdsAdd(sdsp, SDS{"offset": file.Offset}),
862 if _, err = fd.Seek(int64(file.Offset), io.SeekStart); err != nil {
863 state.Ctx.LogE("sp-file", sdsp, err, "")
867 state.Ctx.LogD("sp-file", sdsp, "writing")
868 _, err = fd.Write(file.Payload)
870 state.Ctx.LogE("sp-file", sdsp, err, "")
874 ourSize := file.Offset + uint64(len(file.Payload))
876 sdsp["size"] = int64(ourSize)
877 sdsp["fullsize"] = int64(state.infosTheir[*file.Hash].Size)
878 if state.Ctx.ShowPrgrs {
881 if state.infosTheir[*file.Hash].Size != ourSize {
887 spWorkersGroup.Wait()
888 spWorkersGroup.Add(1)
890 if err := fd.Sync(); err != nil {
891 state.Ctx.LogE("sp-file", sdsp, err, "sync")
896 defer state.wg.Done()
897 fd.Seek(0, io.SeekStart)
898 state.Ctx.LogD("sp-file", sdsp, "checking")
899 gut, err := Check(fd, file.Hash[:], sdsp, state.Ctx.ShowPrgrs)
901 if err != nil || !gut {
902 state.Ctx.LogE("sp-file", sdsp, errors.New("checksum mismatch"), "")
905 state.Ctx.LogI("sp-done", SdsAdd(sdsp, SDS{"xx": string(TRx)}), "")
906 if err = os.Rename(filePath+PartSuffix, filePath); err != nil {
907 state.Ctx.LogE("sp-file", sdsp, err, "rename")
910 if err = DirSync(dirToSync); err != nil {
911 state.Ctx.LogE("sp-file", sdsp, err, "sync")
915 delete(state.infosTheir, *file.Hash)
917 spWorkersGroup.Done()
919 state.payloads <- MarshalSP(SPTypeDone, SPDone{file.Hash})
923 sdsp := SdsAdd(sds, SDS{"type": "done"})
924 state.Ctx.LogD("sp-process", sdsp, "unmarshaling packet")
926 if _, err = xdr.Unmarshal(r, &done); err != nil {
927 state.Ctx.LogE("sp-process", SdsAdd(sds, SDS{"type": "done"}), err, "")
930 sdsp["pkt"] = ToBase32(done.Hash[:])
931 state.Ctx.LogD("sp-done", sdsp, "removing")
932 err := os.Remove(filepath.Join(
934 state.Node.Id.String(),
936 ToBase32(done.Hash[:]),
938 sdsp["xx"] = string(TTx)
940 state.Ctx.LogI("sp-done", sdsp, "")
942 state.Ctx.LogE("sp-done", sdsp, err, "")
945 sdsp := SdsAdd(sds, SDS{"type": "freq"})
946 state.Ctx.LogD("sp-process", sdsp, "unmarshaling packet")
948 if _, err = xdr.Unmarshal(r, &freq); err != nil {
949 state.Ctx.LogE("sp-process", sdsp, err, "")
952 sdsp["pkt"] = ToBase32(freq.Hash[:])
953 sdsp["offset"] = freq.Offset
954 state.Ctx.LogD("sp-process", sdsp, "queueing")
955 nice, exists := state.infosOurSeen[*freq.Hash]
957 if state.onlyPkts == nil || !state.onlyPkts[*freq.Hash] {
960 var freqWithNice *FreqWithNice
961 for insertIdx, freqWithNice = range state.queueTheir {
962 if freqWithNice.nice > nice {
966 state.queueTheir = append(state.queueTheir, nil)
967 copy(state.queueTheir[insertIdx+1:], state.queueTheir[insertIdx:])
968 state.queueTheir[insertIdx] = &FreqWithNice{&freq, nice}
971 state.Ctx.LogD("sp-process", sdsp, "skipping")
974 state.Ctx.LogD("sp-process", sdsp, "unknown")
977 state.Ctx.LogD("sp-process", SdsAdd(sds, SDS{"type": "halt"}), "")
979 state.queueTheir = nil
984 SdsAdd(sds, SDS{"type": head.Type}),
985 errors.New("unknown type"),
988 return nil, BadPktType
995 for _, info := range state.infosTheir {
1000 state.Ctx.LogI("sp-infos", SDS{
1002 "node": state.Node.Id,
1004 "size": int64(size),
1007 return payloadsSplit(replies), nil