-
Notifications
You must be signed in to change notification settings - Fork 0
/
scan-service.go
509 lines (461 loc) · 13.6 KB
/
scan-service.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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
package tlsaudit
import (
"encoding/json"
"fmt"
"io/ioutil"
"math/rand"
"net"
"net/http"
"os"
"path/filepath"
"sort"
"strconv"
"strings"
"sync"
"time"
"github.com/adedayo/cidr"
"github.com/mitchellh/go-homedir"
tlsmodel "github.com/adedayo/tlsaudit/pkg/model"
"github.com/carlescere/scheduler"
"github.com/gorilla/handlers"
"github.com/gorilla/mux"
log "github.com/sirupsen/logrus"
yaml "gopkg.in/yaml.v2"
)
var (
//TLSAuditConfigPath is the default config path of the TLSAudit service
TLSAuditConfigPath = filepath.Join("data", "config", "TLSAuditConfig.yml")
// tempTable = []byte("tempTable")
//control files
runFlag = "runlock.txt"
runFlag2 = "deletethistoresume.txt"
workList = "worklist.txt"
progress = "progress.txt"
resolvedIPs = make(map[string]string)
ipLock = sync.RWMutex{}
routes = mux.NewRouter()
)
func init() {
if home, err := homedir.Expand("~/.tlsaudit"); err == nil {
home = filepath.Join(home, "data", "tlsaudit")
if _, err := os.Stat(home); os.IsNotExist(err) {
if err2 := os.MkdirAll(home, 0755); err2 != nil {
log.Errorln("Could not create the path ", home)
}
}
runFlag = filepath.Join(home, "runlock.txt")
runFlag2 = filepath.Join(home, "deletethistoresume.txt")
workList = filepath.Join(home, "worklist.txt")
progress = filepath.Join(home, "progress.txt")
}
AddTLSAuditRoutes(routes)
}
//AddTLSAuditRoutes adds TLSAudit service's routes to an existing router setup
func AddTLSAuditRoutes(r *mux.Router) {
r.HandleFunc("/scan", RealtimeAdvancedScan).Methods("GET")
r.HandleFunc("/listtlsscan/{rewind}/{completed}", getTLSAuditScanRequests).Methods("GET")
r.HandleFunc("/getscandata/{date}/{scanID}", getTLSAuditScanData).Methods("GET")
r.HandleFunc("/getprotocols/{date}/{scanID}", getTLSProtocols).Methods("GET")
r.HandleFunc("/getscansummaries/{rewind}", getTLSScanSummaries).Methods("GET")
}
//Service main service entry function
func Service(configPath string) {
println("Running TLSAudit Service ...")
TLSAuditConfigPath = configPath
ScheduleTLSAudit(getIPsFromConfig, ipResolver)
if config, err := loadTLSConfig(configPath); err == nil {
ServeAPI(config.ServicePort)
}
}
//ServeAPI provides an API endpoint for interacting with TLSAudit on the localhost
func ServeAPI(port int) {
corsOptions := []handlers.CORSOption{
handlers.AllowedOrigins([]string{"http://localhost:4200",
fmt.Sprintf("http://localhost:%d", port)}),
handlers.AllowedMethods([]string{"GET", "HEAD", "POST"}),
handlers.AllowedHeaders([]string{"Content-Type", "Authorization", "Accept",
"Accept-Language", "Origin"}),
handlers.AllowCredentials(),
}
log.Error(http.ListenAndServe(fmt.Sprintf(":%d", port), handlers.CORS(corsOptions...)(routes)))
}
//ServeAPITLS provides an API endpoint over TLS for interacting with TLSAudit on the
// localhost potentially for remote consumption
func ServeAPITLS(port int) {
corsOptions := []handlers.CORSOption{
handlers.AllowedOrigins([]string{"http://localhost:4200",
fmt.Sprintf("http://localhost:%d", port)}),
handlers.AllowedMethods([]string{"GET", "HEAD", "POST"}),
handlers.AllowedHeaders([]string{"Content-Type", "Authorization", "Accept",
"Accept-Language", "Origin"}),
handlers.AllowCredentials(),
}
certFile, keyFile, err := genCerts()
if err == nil {
log.Error(http.ListenAndServeTLS(fmt.Sprintf(":%d", port), certFile, keyFile, handlers.CORS(corsOptions...)(routes)))
} else {
log.Error(err)
}
}
func getTLSAuditScanRequests(w http.ResponseWriter, req *http.Request) {
vars := mux.Vars(req)
rewind := 365
if rew, err := strconv.Atoi(vars["rewind"]); err == nil {
rewind = rew
}
completed := false
if comp, err := strconv.ParseBool(vars["completed"]); err == nil {
completed = comp
}
json.NewEncoder(w).Encode(ListScans(rewind, completed))
}
func getTLSAuditScanData(w http.ResponseWriter, req *http.Request) {
vars := mux.Vars(req)
date := vars["date"]
scanID := vars["scanID"]
json.NewEncoder(w).Encode(GetScanData(date, scanID))
}
func getTLSProtocols(w http.ResponseWriter, req *http.Request) {
vars := mux.Vars(req)
date := vars["date"]
scanID := vars["scanID"]
type data struct {
Hostname string
Protocols []string
IP string
STARTTLS bool
Score tlsmodel.SecurityScore
}
result := []data{}
for _, ds := range GetScanData(date, scanID).Results {
for _, d := range ds {
if d.SupportsTLS {
result = append(result, data{
Hostname: d.HostName,
Protocols: d.SupportedProtocols,
IP: d.Server,
STARTTLS: d.IsSTARTLS,
Score: d.Score,
})
}
}
}
json.NewEncoder(w).Encode(result)
}
func getTLSScanSummaries(w http.ResponseWriter, req *http.Request) {
vars := mux.Vars(req)
rewind := 365
if rew, err := strconv.Atoi(vars["rewind"]); err == nil {
rewind = rew
}
json.NewEncoder(w).Encode(GetScanSummaries(rewind))
}
func resolveIPs(ips []string) {
for _, ip := range ips {
ipLock.Lock()
if _, present := resolvedIPs[ip]; !present {
if hosts, err := net.LookupAddr(ip); err == nil && len(hosts) > 0 {
resolvedIPs[ip] = hosts[0]
ips = append(ips, ip)
} else {
resolvedIPs[ip] = ""
}
}
ipLock.Unlock()
}
}
func ipResolver(ip string) string {
defer ipLock.Unlock()
ipLock.Lock()
if hostname, present := resolvedIPs[ip]; present {
return hostname
}
return ""
}
func getIPsFromConfig() []tlsmodel.GroupedHost {
config, err := loadTLSConfig(TLSAuditConfigPath)
if err != nil {
return []tlsmodel.GroupedHost{}
}
ips := getIPsToScan(config)
return ips
}
func getIPsToScan(config tlsmodel.TLSAuditConfig) []tlsmodel.GroupedHost {
groupedHosts := []tlsmodel.GroupedHost{}
for _, sg := range config.ScanGroups {
data := make(map[string]string)
ips := []string{}
for _, c := range sg.CIDRRanges {
ports := ""
if strings.Contains(c, ":") {
cc, p, err := extractPorts(c)
if err != nil {
continue
}
c = cc
ports = p
}
for _, ip := range cidr.Expand(c) {
ip = fmt.Sprintf("%s/32", ip)
if ps, present := data[ip]; present {
if ps == "" {
data[ip] = ports
} else if ports != "" {
data[ip] = fmt.Sprintf("%s,%s", ps, ports)
}
} else {
data[ip] = ports
}
}
}
for ip, ports := range data {
x := ip
if ports != "" {
z := strings.Split(ip, "/")
if len(z) != 2 {
continue
}
x = fmt.Sprintf("%s:%s/%s", z[0], ports, z[1])
println(x)
}
ips = append(ips, x)
}
groupedHosts = append(groupedHosts, tlsmodel.GroupedHost{
ScanGroup: sg,
Hosts: ips,
})
}
return groupedHosts
}
func extractPorts(cidrX string) (string, string, error) {
cs := strings.Split(cidrX, ":")
if len(cs) != 2 {
return cidrX, "", fmt.Errorf("Bad CIDR with port format %s", cidrX)
}
ip := cs[0]
if !strings.Contains(cs[1], "/") {
return ip + "/32", cs[1], nil
}
rng := strings.Split(cs[1], "/")
if len(rng) != 2 {
return cidrX, "", fmt.Errorf("Bad CIDR with port format %s", cidrX)
}
return fmt.Sprintf("%s/%s", ip, rng[1]), rng[0], nil
}
//ScheduleTLSAudit runs TLSAudit scan
func ScheduleTLSAudit(ipSource func() []tlsmodel.GroupedHost, resolver func(string) string) {
//a restart schould clear the lock file
if _, err := os.Stat(runFlag2); !os.IsNotExist(err) { // there is a runlock
if err := os.Remove(runFlag2); err != nil {
println(err.Error())
log.Error(err)
}
}
scanJob := func() {
runTLSScan(ipSource, resolver)
}
if config, err := loadTLSConfig(TLSAuditConfigPath); err == nil {
for _, t := range config.DailySchedules {
if config.IsProduction {
println("Running next at ", t)
scheduler.Every().Day().At(t).Run(scanJob)
} else {
scheduler.Every(2).Hours().Run(scanJob)
}
}
}
if _, err := os.Stat(workList); !os.IsNotExist(err) {
runTLSScan(ipSource, resolver)
}
}
//RunTLSScan accepts generator of IP addresses to scan and a function to map the IPs to hostnames (if any) - function to allow the hostname resolution happen in parallel if necessary
func runTLSScan(ipSource func() []tlsmodel.GroupedHost, ipToHostnameResolver func(string) string) {
//create a directory, if not exist, for tlsaudit to keep temporary file
path := filepath.Join("data", "tlsaudit", "scan")
if _, err := os.Stat(path); os.IsNotExist(err) {
if err2 := os.MkdirAll(path, 0755); err2 != nil {
log.Errorln("Could not create the path ", path)
}
}
//prevent concurrent runs
if _, err := os.Stat(runFlag2); !os.IsNotExist(err) { // there is a runlock
//do not start a new scan
return
}
psr := tlsmodel.PersistedScanRequest{}
if _, err := os.Stat(workList); !os.IsNotExist(err) { // there is a worklist (due to a previous crash!)
//load the list of IPs from there
println("Resuming due to a worklist")
file, err := os.Open(workList)
if err != nil {
log.Error(err)
return
}
defer file.Close()
// scanner := bufio.NewScanner(file)
// for scanner.Scan() {
// hosts = append(hosts, scanner.Text())
// }
day, err := ioutil.ReadFile(runFlag)
if err != nil {
log.Error(err)
return
}
d := strings.TrimSpace(string(day))
println("Resuming on date ", d, filepath.Join(path, d))
dirs, err := ioutil.ReadDir(filepath.Join(path, d))
if err != nil {
println(err.Error())
log.Error(err)
return
}
fmt.Printf("%#v\n", dirs)
for _, sID := range dirs {
scanID := sID.Name()
println(scanID)
if p, err := LoadScanRequest(d, scanID); err == nil {
psr = p
break
}
}
fmt.Printf("Will be scanning with PSR %#v", psr)
} else { // starting a fresh scan
shuffledHosts := []string{}
for _, gh := range ipSource() {
//shuffle hosts randomly
rand.Shuffle(len(gh.Hosts), func(i, j int) {
gh.Hosts[i], gh.Hosts[j] = gh.Hosts[j], gh.Hosts[i]
})
psr.GroupedHosts = append(psr.GroupedHosts, gh)
shuffledHosts = append(shuffledHosts, gh.Hosts...)
}
//write shuffled hosts into worklist file - we no longer rely on this for scanning, kept for debugging
if err := ioutil.WriteFile(workList, []byte(strings.Join(shuffledHosts, "\n")+"\n"), 0644); err != nil {
log.Error(err)
return
}
//track progress in the progress file
if err := ioutil.WriteFile(progress, []byte(fmt.Sprintf("-1,%d", len(shuffledHosts))), 0644); err != nil {
log.Error(err)
return
}
//create the lock file with the start day
today := time.Now().Format(dayFormat)
if err := ioutil.WriteFile(runFlag, []byte(today), 0644); err != nil {
log.Error(err)
return
}
if err := ioutil.WriteFile(runFlag2, []byte{}, 0644); err != nil {
log.Error(err)
return
}
psr.HostCount = len(shuffledHosts)
request := tlsmodel.AdvancedScanRequest{}
for _, gh := range psr.GroupedHosts {
request.ScanGroups = append(request.ScanGroups, gh.ScanGroup)
}
request.Day = today
request.ScanID = getNextScanID()
config, _ := loadTLSConfig(TLSAuditConfigPath)
scanConfig := tlsmodel.ScanConfig{
PacketsPerSecond: config.PacketsPerSecond,
Timeout: config.Timeout,
}
request.Config = scanConfig
psr.Request = request
}
//we've got the psr. Now use it as the basis of the scans
hosts := []string{} // hosts to scan
for _, gh := range psr.GroupedHosts {
hosts = append(hosts, gh.Hosts...)
}
//get ready to scan
//get where we "stopped" last time possibly after a crash
stopped := 0
p, err := ioutil.ReadFile(progress)
if err != nil {
log.Error(err)
return
}
stopped, err = strconv.Atoi(strings.Split(string(p), ",")[0])
if err != nil {
log.Error(err)
return
}
psr.Progress = stopped
//only resolve IPs for the hosts that have not been scanned
if stopped < len(hosts) {
go resolveIPs(hosts[stopped:])
}
PersistScanRequest(psr)
count := len(hosts)
println(strings.Join(hosts, "\n"))
//scan hosts
for index, host := range hosts {
//skip already scanned hosts, if any
if index <= stopped {
fmt.Printf("Skipping host %s\n", host)
continue
}
counter := index + 1
scan := make(map[string]tlsmodel.ScanResult)
results := []<-chan tlsmodel.ScanResult{}
scanResults := []tlsmodel.ScanResult{}
fmt.Printf("Scanning Host %s (%d of %d)\n", host, counter, count)
results = append(results, ScanCIDRTLS(host, psr.Request.Config))
for result := range MergeResultChannels(results...) {
key := result.Server + result.Port
if _, present := scan[key]; !present {
scan[key] = result
scanResults = append(scanResults, result)
println("Got result for ", result.Server, ipToHostnameResolver(result.Server), result.Port, result.SupportsTLS(), result.IsSTARTLS, fmt.Sprintf("%#v", result.SupportedProtocols))
}
}
sort.Sort(tlsmodel.ScanResultSorter(scanResults))
PersistScans(psr, host, scanResults)
if err := ioutil.WriteFile(progress, []byte(fmt.Sprintf("%d,%d", counter, len(hosts))), 0644); err != nil {
log.Error(err)
return
}
psr.Progress = counter
PersistScanRequest(psr)
}
//cleanup
if err := os.Remove(runFlag); err != nil {
log.Error(err)
}
if err := os.Remove(runFlag2); err != nil {
log.Error(err)
}
if err := os.Remove(progress); err != nil {
log.Error(err)
}
if err := os.Remove(workList); err != nil {
log.Error(err)
}
}
func loadTLSConfig(path string) (config tlsmodel.TLSAuditConfig, e error) {
configFile, err := ioutil.ReadFile(path)
if err != nil {
log.Error(err)
return config, err
}
err = yaml.Unmarshal(configFile, &config)
if err != nil {
log.Error(err)
return config, err
}
return
}
type sorter []tlsmodel.ScanResult
func (k sorter) Len() int {
return len(k)
}
func (k sorter) Swap(i, j int) {
k[i], k[j] = k[j], k[i]
}
func (k sorter) Less(i, j int) bool {
iPort, _ := strconv.Atoi(k[i].Port)
jPort, _ := strconv.Atoi(k[j].Port)
return k[i].Server < k[j].Server || (k[i].Server == k[j].Server && iPort <= jPort)
}