]> Cypherpunks.ru repositories - nncp.git/blob - src/cfg.go
a72d371c141fecd588e8762fa2a758ece1ed18bd
[nncp.git] / src / cfg.go
1 /*
2 NNCP -- Node to Node copy, utilities for store-and-forward data exchange
3 Copyright (C) 2016-2021 Sergey Matveev <stargrave@stargrave.org>
4
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.
8
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.
13
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/>.
16 */
17
18 package nncp
19
20 import (
21         "bytes"
22         "encoding/json"
23         "errors"
24         "log"
25         "os"
26         "path"
27         "strconv"
28         "time"
29
30         "github.com/gorhill/cronexpr"
31         "github.com/hjson/hjson-go"
32         "golang.org/x/crypto/ed25519"
33         "golang.org/x/term"
34 )
35
36 const (
37         CfgPathEnv  = "NNCPCFG"
38         CfgSpoolEnv = "NNCPSPOOL"
39         CfgLogEnv   = "NNCPLOG"
40 )
41
42 var (
43         DefaultCfgPath      string = "/usr/local/etc/nncp.hjson"
44         DefaultSendmailPath string = "/usr/sbin/sendmail"
45         DefaultSpoolPath    string = "/var/spool/nncp"
46         DefaultLogPath      string = "/var/spool/nncp/log"
47 )
48
49 type NodeJSON struct {
50         Id       string              `json:"id"`
51         ExchPub  string              `json:"exchpub"`
52         SignPub  string              `json:"signpub"`
53         NoisePub *string             `json:"noisepub,omitempty"`
54         Exec     map[string][]string `json:"exec,omitempty"`
55         Incoming *string             `json:"incoming,omitempty"`
56         Freq     *NodeFreqJSON       `json:"freq,omitempty"`
57         Via      []string            `json:"via,omitempty"`
58         Calls    []CallJSON          `json:"calls,omitempty"`
59
60         Addrs map[string]string `json:"addrs,omitempty"`
61
62         RxRate         *int  `json:"rxrate,omitempty"`
63         TxRate         *int  `json:"txrate,omitempty"`
64         OnlineDeadline *uint `json:"onlinedeadline,omitempty"`
65         MaxOnlineTime  *uint `json:"maxonlinetime,omitempty"`
66 }
67
68 type NodeFreqJSON struct {
69         Path    *string `json:"path,omitempty"`
70         Chunked *uint64 `json:"chunked,omitempty"`
71         MinSize *uint64 `json:"minsize,omitempty"`
72         MaxSize *uint64 `json:"maxsize,omitempty"`
73 }
74
75 type CallJSON struct {
76         Cron           string
77         Nice           *string `json:"nice,omitempty"`
78         Xx             *string `json:"xx,omitempty"`
79         RxRate         *int    `json:"rxrate,omitempty"`
80         TxRate         *int    `json:"txrate,omitempty"`
81         Addr           *string `json:"addr,omitempty"`
82         OnlineDeadline *uint   `json:"onlinedeadline,omitempty"`
83         MaxOnlineTime  *uint   `json:"maxonlinetime,omitempty"`
84
85         AutoToss       *bool `json:"autotoss,omitempty"`
86         AutoTossDoSeen *bool `json:"autotoss-doseen,omitempty"`
87         AutoTossNoFile *bool `json:"autotoss-nofile,omitempty"`
88         AutoTossNoFreq *bool `json:"autotoss-nofreq,omitempty"`
89         AutoTossNoExec *bool `json:"autotoss-noexec,omitempty"`
90         AutoTossNoTrns *bool `json:"autotoss-notrns,omitempty"`
91 }
92
93 type NodeOurJSON struct {
94         Id       string `json:"id"`
95         ExchPub  string `json:"exchpub"`
96         ExchPrv  string `json:"exchprv"`
97         SignPub  string `json:"signpub"`
98         SignPrv  string `json:"signprv"`
99         NoisePrv string `json:"noiseprv"`
100         NoisePub string `json:"noisepub"`
101 }
102
103 type FromToJSON struct {
104         From string
105         To   string
106 }
107
108 type NotifyJSON struct {
109         File *FromToJSON            `json:"file,omitempty"`
110         Freq *FromToJSON            `json:"freq,omitempty"`
111         Exec map[string]*FromToJSON `json:"exec,omitempty"`
112 }
113
114 type CfgJSON struct {
115         Spool string `json:"spool"`
116         Log   string `json:"log"`
117         Umask string `json:"umask,omitempty"`
118
119         OmitPrgrs bool `json:"noprogress,omitempty"`
120
121         Notify *NotifyJSON `json:"notify,omitempty"`
122
123         Self  *NodeOurJSON        `json:"self"`
124         Neigh map[string]NodeJSON `json:"neigh"`
125 }
126
127 func NewNode(name string, cfg NodeJSON) (*Node, error) {
128         nodeId, err := NodeIdFromString(cfg.Id)
129         if err != nil {
130                 return nil, err
131         }
132
133         exchPub, err := Base32Codec.DecodeString(cfg.ExchPub)
134         if err != nil {
135                 return nil, err
136         }
137         if len(exchPub) != 32 {
138                 return nil, errors.New("Invalid exchPub size")
139         }
140
141         signPub, err := Base32Codec.DecodeString(cfg.SignPub)
142         if err != nil {
143                 return nil, err
144         }
145         if len(signPub) != ed25519.PublicKeySize {
146                 return nil, errors.New("Invalid signPub size")
147         }
148
149         var noisePub []byte
150         if cfg.NoisePub != nil {
151                 noisePub, err = Base32Codec.DecodeString(*cfg.NoisePub)
152                 if err != nil {
153                         return nil, err
154                 }
155                 if len(noisePub) != 32 {
156                         return nil, errors.New("Invalid noisePub size")
157                 }
158         }
159
160         var incoming *string
161         if cfg.Incoming != nil {
162                 inc := path.Clean(*cfg.Incoming)
163                 if !path.IsAbs(inc) {
164                         return nil, errors.New("Incoming path must be absolute")
165                 }
166                 incoming = &inc
167         }
168
169         var freqPath *string
170         freqChunked := int64(MaxFileSize)
171         var freqMinSize int64
172         freqMaxSize := int64(MaxFileSize)
173         if cfg.Freq != nil {
174                 f := cfg.Freq
175                 if f.Path != nil {
176                         fPath := path.Clean(*f.Path)
177                         if !path.IsAbs(fPath) {
178                                 return nil, errors.New("freq.path path must be absolute")
179                         }
180                         freqPath = &fPath
181                 }
182                 if f.Chunked != nil {
183                         if *f.Chunked == 0 {
184                                 return nil, errors.New("freq.chunked value must be greater than zero")
185                         }
186                         freqChunked = int64(*f.Chunked) * 1024
187                 }
188                 if f.MinSize != nil {
189                         freqMinSize = int64(*f.MinSize) * 1024
190                 }
191                 if f.MaxSize != nil {
192                         freqMaxSize = int64(*f.MaxSize) * 1024
193                 }
194         }
195
196         defRxRate := 0
197         if cfg.RxRate != nil && *cfg.RxRate > 0 {
198                 defRxRate = *cfg.RxRate
199         }
200         defTxRate := 0
201         if cfg.TxRate != nil && *cfg.TxRate > 0 {
202                 defTxRate = *cfg.TxRate
203         }
204
205         defOnlineDeadline := DefaultDeadline
206         if cfg.OnlineDeadline != nil {
207                 if *cfg.OnlineDeadline <= 0 {
208                         return nil, errors.New("OnlineDeadline must be at least 1 second")
209                 }
210                 defOnlineDeadline = time.Duration(*cfg.OnlineDeadline) * time.Second
211         }
212         var defMaxOnlineTime time.Duration
213         if cfg.MaxOnlineTime != nil {
214                 defMaxOnlineTime = time.Duration(*cfg.MaxOnlineTime) * time.Second
215         }
216
217         var calls []*Call
218         for _, callCfg := range cfg.Calls {
219                 expr, err := cronexpr.Parse(callCfg.Cron)
220                 if err != nil {
221                         return nil, err
222                 }
223
224                 nice := uint8(255)
225                 if callCfg.Nice != nil {
226                         nice, err = NicenessParse(*callCfg.Nice)
227                         if err != nil {
228                                 return nil, err
229                         }
230                 }
231
232                 var xx TRxTx
233                 if callCfg.Xx != nil {
234                         switch *callCfg.Xx {
235                         case "rx":
236                                 xx = TRx
237                         case "tx":
238                                 xx = TTx
239                         default:
240                                 return nil, errors.New("xx field must be either \"rx\" or \"tx\"")
241                         }
242                 }
243
244                 rxRate := defRxRate
245                 if callCfg.RxRate != nil {
246                         rxRate = *callCfg.RxRate
247                 }
248                 txRate := defTxRate
249                 if callCfg.TxRate != nil {
250                         txRate = *callCfg.TxRate
251                 }
252
253                 var addr *string
254                 if callCfg.Addr != nil {
255                         if a, exists := cfg.Addrs[*callCfg.Addr]; exists {
256                                 addr = &a
257                         } else {
258                                 addr = callCfg.Addr
259                         }
260                 }
261
262                 onlineDeadline := defOnlineDeadline
263                 if callCfg.OnlineDeadline != nil {
264                         if *callCfg.OnlineDeadline == 0 {
265                                 return nil, errors.New("OnlineDeadline must be at least 1 second")
266                         }
267                         onlineDeadline = time.Duration(*callCfg.OnlineDeadline) * time.Second
268                 }
269
270                 call := Call{
271                         Cron:           expr,
272                         Nice:           nice,
273                         Xx:             xx,
274                         RxRate:         rxRate,
275                         TxRate:         txRate,
276                         Addr:           addr,
277                         OnlineDeadline: onlineDeadline,
278                 }
279
280                 if callCfg.MaxOnlineTime != nil {
281                         call.MaxOnlineTime = time.Duration(*callCfg.MaxOnlineTime) * time.Second
282                 }
283                 if callCfg.AutoToss != nil {
284                         call.AutoToss = *callCfg.AutoToss
285                 }
286                 if callCfg.AutoTossDoSeen != nil {
287                         call.AutoTossDoSeen = *callCfg.AutoTossDoSeen
288                 }
289                 if callCfg.AutoTossNoFile != nil {
290                         call.AutoTossNoFile = *callCfg.AutoTossNoFile
291                 }
292                 if callCfg.AutoTossNoFreq != nil {
293                         call.AutoTossNoFreq = *callCfg.AutoTossNoFreq
294                 }
295                 if callCfg.AutoTossNoExec != nil {
296                         call.AutoTossNoExec = *callCfg.AutoTossNoExec
297                 }
298                 if callCfg.AutoTossNoTrns != nil {
299                         call.AutoTossNoTrns = *callCfg.AutoTossNoTrns
300                 }
301
302                 calls = append(calls, &call)
303         }
304
305         node := Node{
306                 Name:           name,
307                 Id:             nodeId,
308                 ExchPub:        new([32]byte),
309                 SignPub:        ed25519.PublicKey(signPub),
310                 Exec:           cfg.Exec,
311                 Incoming:       incoming,
312                 FreqPath:       freqPath,
313                 FreqChunked:    freqChunked,
314                 FreqMinSize:    freqMinSize,
315                 FreqMaxSize:    freqMaxSize,
316                 Calls:          calls,
317                 Addrs:          cfg.Addrs,
318                 RxRate:         defRxRate,
319                 TxRate:         defTxRate,
320                 OnlineDeadline: defOnlineDeadline,
321                 MaxOnlineTime:  defMaxOnlineTime,
322         }
323         copy(node.ExchPub[:], exchPub)
324         if len(noisePub) > 0 {
325                 node.NoisePub = new([32]byte)
326                 copy(node.NoisePub[:], noisePub)
327         }
328         return &node, nil
329 }
330
331 func NewNodeOur(cfg *NodeOurJSON) (*NodeOur, error) {
332         id, err := NodeIdFromString(cfg.Id)
333         if err != nil {
334                 return nil, err
335         }
336
337         exchPub, err := Base32Codec.DecodeString(cfg.ExchPub)
338         if err != nil {
339                 return nil, err
340         }
341         if len(exchPub) != 32 {
342                 return nil, errors.New("Invalid exchPub size")
343         }
344
345         exchPrv, err := Base32Codec.DecodeString(cfg.ExchPrv)
346         if err != nil {
347                 return nil, err
348         }
349         if len(exchPrv) != 32 {
350                 return nil, errors.New("Invalid exchPrv size")
351         }
352
353         signPub, err := Base32Codec.DecodeString(cfg.SignPub)
354         if err != nil {
355                 return nil, err
356         }
357         if len(signPub) != ed25519.PublicKeySize {
358                 return nil, errors.New("Invalid signPub size")
359         }
360
361         signPrv, err := Base32Codec.DecodeString(cfg.SignPrv)
362         if err != nil {
363                 return nil, err
364         }
365         if len(signPrv) != ed25519.PrivateKeySize {
366                 return nil, errors.New("Invalid signPrv size")
367         }
368
369         noisePub, err := Base32Codec.DecodeString(cfg.NoisePub)
370         if err != nil {
371                 return nil, err
372         }
373         if len(noisePub) != 32 {
374                 return nil, errors.New("Invalid noisePub size")
375         }
376
377         noisePrv, err := Base32Codec.DecodeString(cfg.NoisePrv)
378         if err != nil {
379                 return nil, err
380         }
381         if len(noisePrv) != 32 {
382                 return nil, errors.New("Invalid noisePrv size")
383         }
384
385         node := NodeOur{
386                 Id:       id,
387                 ExchPub:  new([32]byte),
388                 ExchPrv:  new([32]byte),
389                 SignPub:  ed25519.PublicKey(signPub),
390                 SignPrv:  ed25519.PrivateKey(signPrv),
391                 NoisePub: new([32]byte),
392                 NoisePrv: new([32]byte),
393         }
394         copy(node.ExchPub[:], exchPub)
395         copy(node.ExchPrv[:], exchPrv)
396         copy(node.NoisePub[:], noisePub)
397         copy(node.NoisePrv[:], noisePrv)
398         return &node, nil
399 }
400
401 func CfgParse(data []byte) (*Ctx, error) {
402         var err error
403         if bytes.Compare(data[:8], MagicNNCPBv3[:]) == 0 {
404                 os.Stderr.WriteString("Passphrase:") // #nosec G104
405                 password, err := term.ReadPassword(0)
406                 if err != nil {
407                         log.Fatalln(err)
408                 }
409                 os.Stderr.WriteString("\n") // #nosec G104
410                 data, err = DeEBlob(data, password)
411                 if err != nil {
412                         return nil, err
413                 }
414         }
415         var cfgGeneral map[string]interface{}
416         if err = hjson.Unmarshal(data, &cfgGeneral); err != nil {
417                 return nil, err
418         }
419         marshaled, err := json.Marshal(cfgGeneral)
420         if err != nil {
421                 return nil, err
422         }
423         var cfgJSON CfgJSON
424         if err = json.Unmarshal(marshaled, &cfgJSON); err != nil {
425                 return nil, err
426         }
427         if _, exists := cfgJSON.Neigh["self"]; !exists {
428                 return nil, errors.New("self neighbour missing")
429         }
430         var self *NodeOur
431         if cfgJSON.Self != nil {
432                 self, err = NewNodeOur(cfgJSON.Self)
433                 if err != nil {
434                         return nil, err
435                 }
436         }
437         spoolPath := path.Clean(cfgJSON.Spool)
438         if !path.IsAbs(spoolPath) {
439                 return nil, errors.New("Spool path must be absolute")
440         }
441         logPath := path.Clean(cfgJSON.Log)
442         if !path.IsAbs(logPath) {
443                 return nil, errors.New("Log path must be absolute")
444         }
445         var umaskForce *int
446         if cfgJSON.Umask != "" {
447                 r, err := strconv.ParseUint(cfgJSON.Umask, 8, 16)
448                 if err != nil {
449                         return nil, err
450                 }
451                 rInt := int(r)
452                 umaskForce = &rInt
453         }
454         showPrgrs := true
455         if cfgJSON.OmitPrgrs {
456                 showPrgrs = false
457         }
458         ctx := Ctx{
459                 Spool:      spoolPath,
460                 LogPath:    logPath,
461                 UmaskForce: umaskForce,
462                 ShowPrgrs:  showPrgrs,
463                 Self:       self,
464                 Neigh:      make(map[NodeId]*Node, len(cfgJSON.Neigh)),
465                 Alias:      make(map[string]*NodeId),
466         }
467         if cfgJSON.Notify != nil {
468                 if cfgJSON.Notify.File != nil {
469                         ctx.NotifyFile = cfgJSON.Notify.File
470                 }
471                 if cfgJSON.Notify.Freq != nil {
472                         ctx.NotifyFreq = cfgJSON.Notify.Freq
473                 }
474                 if cfgJSON.Notify.Exec != nil {
475                         ctx.NotifyExec = cfgJSON.Notify.Exec
476                 }
477         }
478         vias := make(map[NodeId][]string)
479         for name, neighJSON := range cfgJSON.Neigh {
480                 neigh, err := NewNode(name, neighJSON)
481                 if err != nil {
482                         return nil, err
483                 }
484                 ctx.Neigh[*neigh.Id] = neigh
485                 if _, already := ctx.Alias[name]; already {
486                         return nil, errors.New("Node names conflict")
487                 }
488                 ctx.Alias[name] = neigh.Id
489                 vias[*neigh.Id] = neighJSON.Via
490         }
491         ctx.SelfId = ctx.Alias["self"]
492         for neighId, viasRaw := range vias {
493                 for _, viaRaw := range viasRaw {
494                         foundNodeId, err := ctx.FindNode(viaRaw)
495                         if err != nil {
496                                 return nil, err
497                         }
498                         ctx.Neigh[neighId].Via = append(
499                                 ctx.Neigh[neighId].Via,
500                                 foundNodeId.Id,
501                         )
502                 }
503         }
504         return &ctx, nil
505 }