-
Notifications
You must be signed in to change notification settings - Fork 8
/
config.go
291 lines (243 loc) · 8.87 KB
/
config.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
package main
// Copyright (C) 2013 Alexander Bauer, Luke Evers, Dylan Whichard,
// and contributors; (GPLv3) see LICENSE or doc.go
import (
"encoding/json"
"errors"
"html/template"
"net"
"os"
"time"
)
type Config struct {
// Name is the string by which this instance of NodeAtlas will be
// referred to. It usually describes the entire project name or
// the region about which it focuses.
Name string
// AdminContact is the structure which contains information
// relating to where you can contact the administrator.
AdminContact struct {
// Name of the administrator
Name string
// Email of the administrator
Email string
// PGP key of the administrator
PGP string
}
// AdminAddresses is a slice of addresses which are considered
// fully authenticated. Connections originating from those
// addresses will not be required to verify or perform any sort of
// authentication, meaning that they can edit or register any
// node. If it is not specified, no addresses are granted this
// ability.
AdminAddresses []IP
// Web is the structure which contains information relating to the
// backend of the HTTP webserver.
Web struct {
// Hostname is the address which NodeAtlas should identify
// itself as. For example, in a verification email, NodeAtlas
// would give the verification link as
// http://<hostname><prefix>/verify/<long-random-id>
Hostname string
// Prefix is the URL prefix which is required to access the
// front end. For example, with a prefix of "/nodeatlas",
// NodeAtlas would be able to respond to
// http://example.com/nodeatlas.
Prefix string
// Addr is the network protocol, interface, and port to which
// NodeAtlas should bind. For example, "tcp://0.0.0.0:8077"
// will bind globally to the 8077 TCP port, and
// "unix://nodeatlas.sock" will create a UNIX socket at
// nodeatlas.sock.
Addr string
// DeproxyHeaderFields is a list of HTTP header fields that
// should be used instead of the connecting IP when verifying
// nodes and logging major errors. They must be in
// canonicalized form, such as "X-Forwarded-For" or
// "X-Real-IP".
DeproxyHeaderFields []string
// HeaderSnippet is a snippet of code which is inserted into
// the <head> of each page. For example, one could include a
// script tieing into Pikwik.
HeaderSnippet template.HTML
// AboutSnippet is an excerpt that will get put into
// the /about page for all to read upon going to the
// /about page.
AboutSnippet string
// RSS is the structure which contains settings for the
// built-in RSS feed generator.
RSS struct {
// MaxAge is the duration after which new nodes are
// considered old, and should no longer populate the feed.
MaxAge Duration
}
}
// ChildMaps is a list of addresses from which to pull lists of
// nodes every heartbeat. Please note that these maps are trusted
// fully, and they could easily introduce false nodes to the
// database temporarily (until cleared by the CacheExpiration.
ChildMaps []string
// Database is the structure which contains the database driver
// name, such as "sqlite3" or "mysql", and the database resource,
// such as a path to .db file, or username, password, and name.
Database struct {
DriverName string
Resource string
ReadOnly bool
}
// HeartbeatRate is the amount of time to wait between performing
// regular tasks, such as clearing expired nodes from the queue
// and cache.
HeartbeatRate Duration
// CacheExpiration is the amount of time for which to store cached
// nodes before considering them outdated, and removing them.
CacheExpiration Duration
// VerificationExpiration is the amount of time to allow users to
// verify nodes by email after initially placing them. See the
// documentation for time.ParseDuration for format information.
VerificationExpiration Duration
// ExtraVerificationFlags can be specified to add additional flags
// (such as "-6") to the curl and wget instructions in the
// verification email.
ExtraVerificationFlags string
// SMTP contains the information necessary to connect to a mail
// relay, so as to send verification email to registered nodes.
SMTP *struct {
// VerifyDisabled controls whether email verification is used
// for newly registered nodes. If it is false or omitted, an
// email will be sent using the SMTP settings defined in this
// struct.
VerifyDisabled bool
// EmailAddress will be given as the "From" address when
// sending email.
EmailAddress string
// NoAuthenticate determines whether NodeAtlas should attempt to
// authenticate with the SMTP relay or not. Unless the relay
// is local, leave this false.
NoAuthenticate bool
// Username and Password are the credentials required by the
// server to log in.
Username, Password string
// ServerAddress is the address of the SMTP relay, including
// the port.
ServerAddress string
}
// Map contains the information used by NodeAtlas to power the
// Leaflet.js map.
Map struct {
// Favicon is the icon to be displayed in the browser when
// viewing the map. It is a filename to be loaded from
// `<*fRes>/icon/`.
Favicon string
// Tileserver is the URL used for loading tiles. It is of the
// form "http://{s}.tile.osm.org/{z}/{x}/{y}.png", so that
// Leaflet.js can use it.
Tileserver string
// Center contains the coordinates on which to center the map.
Center struct {
Latitude, Longitude float64
}
// Zoom is the Leaflet.js zoom level to start the map at.
Zoom int
// MaxZoom is the maximum zoom level to allow Leaflet.js.
MaxZoom int
// ClusterRadius is the range (in pixels) at which markers on
// the map will cluster together.
ClusterRadius int
// Attribution is the "map data" copyright notice placed at
// the bottom right of the map, meant to credit the
// maintainers of the tileserver.
Attribution template.HTML
// AddressType is the text that is displayed on the
// map next to "Address" when adding a new node or
// editing a previous node. The default is
// "Network-specific IP", but due to how general that
// is, it should be changed to whatever is the most
// helpful for people to understand.
AddressType string
}
// Verify contains the list of steps used to ensure that new nodes
// are valid when registered. They can be enabled or disabled
// according to one's needs.
Verify struct {
// Netmask, if not nil, is a CIDR-form network mask which
// requires that nodes registered have an Addr which matches
// it. For example, "fc00::/8" would only allow IPv6 addresses
// in which the first two digits are "fc", and
// "192.168.0.0/16" would only allow IPv4 addresses in which
// the first two bytes are "192.168".
Netmask *IPNet
// FromNode requires the verification request (GET
// /api/verify?id=<long_random_id>) to originate from the
// address of the node that is being verified.
FromNode bool
}
// NetworkAdmin is the set of configuration options which allows
// NodeAtlas to connect to the administration interface of the
// network device, if applicable. If it is not given, the feature
// is disabled.
NetworkAdmin *struct {
// Type is the string which identifies the network
// administration type to connect to. Currently, only "cjdns"
// is supported. See <https://github.com/cjdelisle/cjdns>.
Type string
Credentials map[string]interface{}
}
}
// ReadConfig uses os and encoding/json to read a configuration from
// the filesystem. It returns any errors it encounters.
func ReadConfig(path string) (conf *Config, err error) {
f, err := os.Open(path)
if err != nil {
return
}
defer f.Close()
conf = &Config{}
err = json.NewDecoder(f).Decode(conf)
return
}
// WriteConfig uses os and encoding/json to write a configuration to
// the filesystem. It creates the file if it doesn't exist and returns
// any errors it encounters.
func WriteConfig(conf *Config, path string) (err error) {
f, err := os.Create(path)
if err != nil {
return
}
defer f.Close()
err = json.NewEncoder(f).Encode(conf)
return
}
type Duration time.Duration
func (d Duration) MarshalJSON() ([]byte, error) {
return json.Marshal(time.Duration(d).String())
}
func (d *Duration) UnmarshalJSON(b []byte) error {
if b[0] != '"' {
// If the duration is not a string, then consider it to be the
// zero duration, so we do not have to set it.
return nil
}
dur, err := time.ParseDuration(string(b[1 : len(b)-1]))
if err != nil {
return err
}
*d = *(*Duration)(&dur)
return nil
}
// IPNet is a wrapper for net.IPNet which implements json.Unmarshaler.
type IPNet net.IPNet
var InvalidIPNetError = errors.New("network mask is invalid")
func (n *IPNet) UnmarshalJSON(b []byte) error {
if b[0] != '"' {
// If the IPNet is not given as a string, then it is invalid
// and should return an error.
return InvalidIPNetError
}
_, ipnet, err := net.ParseCIDR(string(b[1 : len(b)-1]))
if err != nil {
return err
}
*n = *(*IPNet)(ipnet)
return nil
}