forked from ssllabs/ssllabs-scan
/
manager.go
167 lines (149 loc) · 4.81 KB
/
manager.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
package apis
import (
"github.com/sirupsen/logrus"
"time"
"../backend"
"../hooks"
// Initialize API-hooks
_ "./crawler"
_ "./observatory"
_ "./observatory_tls"
_ "./securityheaders"
_ "./ssllabs"
// Example API
// _ "./example"
)
var StatusTime = 4
var finishErrorLimit = 3
var Logger *logrus.Logger
//Datatypes
func Start(manager *hooks.Manager, scanID int, restart bool) {
go control(manager, scanID, restart)
}
func setUp(manager *hooks.Manager) {
// Do required SetUp
for _, setUpFunction := range hooks.ManagerSetUp {
setUpFunction()
}
}
// control runs as a routine per manager handling the scan
func control(manager *hooks.Manager, scanID int, restart bool) {
manager.ScanID = scanID
domains := receiveScans(manager, restart)
hooks.Logger.Infof("Found %d domains to scan", len(domains))
// if no domains to scan, just finished
if len(domains) == 0 {
manager.FirstScan = true
}
manager.Status.SetTotalScans(int32(len(domains)))
updateTime := time.NewTicker(time.Second * time.Duration(StatusTime)).C
internalChannel := make(chan hooks.InternalMessage)
setUp(manager)
for {
select {
case <-updateTime:
sendStatusMessage(manager)
case res := <-internalChannel:
handleResults(manager, res)
default:
domains = handleScans(manager, domains, internalChannel)
if testFinished(manager, domains) {
// needs to send goodbye
manager.Logger.Info("Scan complete, shutting down")
sendStatusMessage(manager)
manager.OutputChannel <- hooks.ScanStatusMessage{
Status: nil,
Sender: manager.Table,
}
return
}
}
}
}
// receiveScans extracts the scans saved in the table
func receiveScans(manager *hooks.Manager, restart bool) []hooks.DomainsReachable {
if !restart {
err := backend.PrepareScanData(manager.GetTableName(), manager.ScanID, manager.ScanType)
if err != nil {
manager.Logger.WithFields(logrus.Fields{"error": err}).Panic("Preparing Scan Data failed")
}
}
domains, err := backend.GetScans(manager.GetTableName(), manager.ScanID, hooks.StatusPending)
if err != nil {
manager.Logger.WithFields(logrus.Fields{"error": err}).Panic("Reading Scans from Database failed")
}
return domains
}
// sendStatusMessage sends status message to the controller
func sendStatusMessage(manager *hooks.Manager) {
manager.Logger.Infof("Running: %5d Retrying: %5d Failed:%5d Remaining: %5d ",
manager.Status.GetCurrentScans(),
manager.Status.GetErrorScans(),
manager.Status.GetFatalErrorScans(),
manager.Status.GetTotalScans()-manager.Status.GetFinishedScans())
var mes = hooks.ScanStatus{
CurrentScans: manager.Status.GetCurrentScans(),
ErrorScans: manager.Status.GetErrorScans(),
FinishedScans: manager.Status.GetFinishedScans(),
TotalScans: manager.Status.GetTotalScans(),
FatalErrorScans: manager.Status.GetFatalErrorScans(),
}
manager.OutputChannel <- hooks.ScanStatusMessage{
Status: &mes,
Sender: manager.Table,
}
}
//handleScans checks if new scans should be started and starts them if needed
func handleScans(manager *hooks.Manager, domains []hooks.DomainsReachable, internalChannel chan hooks.InternalMessage) []hooks.DomainsReachable {
if int(manager.Status.GetCurrentScans()) >= manager.MaxParallelScans {
return domains
}
f := hooks.ManagerHandleScan[manager.Table]
if f == nil {
manager.Logger.WithFields(logrus.Fields{
"tableName": manager.Table,
}).Panic("Unknown manager table name")
}
domains = f(domains, internalChannel)
return domains
}
// testFinished checks if all tests have been completed
func testFinished(manager *hooks.Manager, domains []hooks.DomainsReachable) bool {
if manager.Status.GetRemainingScans() == 0 && manager.FirstScan {
if len(domains) != 0 && len(manager.Errors) != 0 {
if manager.FinishError >= finishErrorLimit {
manager.Logger.WithFields(logrus.Fields{
"errorcount": manager.FinishError,
"limit": finishErrorLimit,
}).Panic("Exceeded finishErrorLimit")
}
manager.FinishError++
return false
}
return true
}
return false
}
// handleResults saves finished scans
func handleResults(manager *hooks.Manager, results hooks.InternalMessage) {
handleResultsFunction := hooks.ManagerHandleResults[manager.Table]
if handleResultsFunction == nil {
manager.Logger.WithFields(logrus.Fields{"tableName": manager.Table}).Panic("Unknown manager table name")
}
if results.Retries != 0 {
manager.Status.AddErrorScans(-1)
}
if results.StatusCode == hooks.InternalError {
if results.Retries >= manager.MaxRetries {
results.StatusCode = hooks.InternalFatalError
} else {
results.Retries++
manager.Errors = append(manager.Errors, results)
manager.Status.AddErrorScans(1)
manager.Status.AddCurrentScans(-1)
manager.Logger.Debugf("Retrying %v for the %d. times", results.Domain.DomainName, results.Retries)
return
}
}
handleResultsFunction(results)
}