/
libgobuster.go
324 lines (277 loc) · 7.55 KB
/
libgobuster.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
package libgobuster
import (
"bufio"
"bytes"
"context"
"fmt"
"net"
"os"
"strings"
"sync"
)
const (
// VERSION contains the current gobuster version
VERSION = "2.0.1"
)
// SetupFunc is the "setup" function prototype for implementations
type SetupFunc func(*Gobuster) error
// ProcessFunc is the "process" function prototype for implementations
type ProcessFunc func(*Gobuster, string) ([]Result, error)
// ResultToStringFunc is the "to string" function prototype for implementations
type ResultToStringFunc func(*Gobuster, *Result) (*string, error)
// Gobuster is the main object when creating a new run
type Gobuster struct {
Opts *Options
http *httpClient
WildcardIps stringSet
context context.Context
requestsExpected int
requestsIssued int
mu *sync.RWMutex
plugin GobusterPlugin
IsWildcard bool
resultChan chan Result
errorChan chan error
}
// GobusterPlugin is an interface which plugins must implement
type GobusterPlugin interface {
Setup(*Gobuster) error
Process(*Gobuster, string) ([]Result, error)
ResultToString(*Gobuster, *Result) (*string, error)
}
// NewGobuster returns a new Gobuster object
func NewGobuster(c context.Context, opts *Options, plugin GobusterPlugin) (*Gobuster, error) {
// validate given options
multiErr := opts.validate()
if multiErr != nil {
return nil, multiErr
}
var g Gobuster
g.WildcardIps = newStringSet()
g.context = c
g.Opts = opts
h, err := newHTTPClient(c, opts)
if err != nil {
return nil, err
}
g.http = h
g.plugin = plugin
g.mu = new(sync.RWMutex)
g.resultChan = make(chan Result)
g.errorChan = make(chan error)
return &g, nil
}
// Results returns a channel of Results
func (g *Gobuster) Results() <-chan Result {
return g.resultChan
}
// Errors returns a channel of errors
func (g *Gobuster) Errors() <-chan error {
return g.errorChan
}
func (g *Gobuster) incrementRequests() {
g.mu.Lock()
g.requestsIssued++
g.mu.Unlock()
}
// PrintProgress outputs the current wordlist progress to stderr
func (g *Gobuster) PrintProgress() {
if !g.Opts.Quiet && !g.Opts.NoProgress {
g.mu.RLock()
if g.Opts.Wordlist == "-" {
fmt.Fprintf(os.Stderr, "\rProgress: %d", g.requestsIssued)
// only print status if we already read in the wordlist
} else if g.requestsExpected > 0 {
fmt.Fprintf(os.Stderr, "\rProgress: %d / %d (%3.2f%%)", g.requestsIssued, g.requestsExpected, float32(g.requestsIssued)*100.0/float32(g.requestsExpected))
}
g.mu.RUnlock()
}
}
// ClearProgress removes the last status line from stderr
func (g *Gobuster) ClearProgress() {
fmt.Fprint(os.Stderr, resetTerminal())
}
// GetRequest issues a GET request to the target and returns
// the status code, length and an error
func (g *Gobuster) GetRequest(url string) (*int, *int64, error) {
return g.http.makeRequest(url, g.Opts.Cookies)
}
// DNSLookup looks up a domain via system default DNS servers
func (g *Gobuster) DNSLookup(domain string) ([]string, error) {
return net.LookupHost(domain)
}
// DNSLookupCname looks up a CNAME record via system default DNS servers
func (g *Gobuster) DNSLookupCname(domain string) (string, error) {
return net.LookupCNAME(domain)
}
func (g *Gobuster) worker(wordChan <-chan string, wg *sync.WaitGroup) {
defer wg.Done()
for {
select {
case <-g.context.Done():
return
case word, ok := <-wordChan:
// worker finished
if !ok {
return
}
g.incrementRequests()
// Mode-specific processing
res, err := g.plugin.Process(g, word)
if err != nil {
// do not exit and continue
g.errorChan <- err
continue
} else {
for _, r := range res {
g.resultChan <- r
}
}
}
}
}
func (g *Gobuster) getWordlist() (*bufio.Scanner, error) {
if g.Opts.Wordlist == "-" {
// Read directly from stdin
return bufio.NewScanner(os.Stdin), nil
}
// Pull content from the wordlist
wordlist, err := os.Open(g.Opts.Wordlist)
if err != nil {
return nil, fmt.Errorf("failed to open wordlist: %v", err)
}
lines, err := lineCounter(wordlist)
if err != nil {
return nil, fmt.Errorf("failed to get number of lines: %v", err)
}
g.requestsExpected = lines
g.requestsIssued = 0
// rewind wordlist
_, err = wordlist.Seek(0, 0)
if err != nil {
return nil, fmt.Errorf("failed to rewind wordlist: %v", err)
}
return bufio.NewScanner(wordlist), nil
}
// Start the busting of the website with the given
// set of settings from the command line.
func (g *Gobuster) Start() error {
if err := g.plugin.Setup(g); err != nil {
return err
}
var workerGroup sync.WaitGroup
workerGroup.Add(g.Opts.Threads)
wordChan := make(chan string, g.Opts.Threads)
// Create goroutines for each of the number of threads
// specified.
for i := 0; i < g.Opts.Threads; i++ {
go g.worker(wordChan, &workerGroup)
}
scanner, err := g.getWordlist()
if err != nil {
return err
}
Scan:
for scanner.Scan() {
select {
case <-g.context.Done():
break Scan
default:
word := strings.TrimSpace(scanner.Text())
// Skip "comment" (starts with #), as well as empty lines
if !strings.HasPrefix(word, "#") && len(word) > 0 {
wordChan <- word
}
}
}
close(wordChan)
workerGroup.Wait()
close(g.resultChan)
close(g.errorChan)
return nil
}
// GetConfigString returns the current config as a printable string
func (g *Gobuster) GetConfigString() (string, error) {
buf := &bytes.Buffer{}
o := g.Opts
if _, err := fmt.Fprintf(buf, "[+] Mode : %s\n", o.Mode); err != nil {
return "", err
}
if _, err := fmt.Fprintf(buf, "[+] Url/Domain : %s\n", o.URL); err != nil {
return "", err
}
if _, err := fmt.Fprintf(buf, "[+] Threads : %d\n", o.Threads); err != nil {
return "", err
}
wordlist := "stdin (pipe)"
if o.Wordlist != "-" {
wordlist = o.Wordlist
}
if _, err := fmt.Fprintf(buf, "[+] Wordlist : %s\n", wordlist); err != nil {
return "", err
}
if o.Mode == ModeDir {
if _, err := fmt.Fprintf(buf, "[+] Status codes : %s\n", o.StatusCodesParsed.Stringify()); err != nil {
return "", err
}
if o.Proxy != "" {
if _, err := fmt.Fprintf(buf, "[+] Proxy : %s\n", o.Proxy); err != nil {
return "", err
}
}
if o.Cookies != "" {
if _, err := fmt.Fprintf(buf, "[+] Cookies : %s\n", o.Cookies); err != nil {
return "", err
}
}
if o.UserAgent != "" {
if _, err := fmt.Fprintf(buf, "[+] User Agent : %s\n", o.UserAgent); err != nil {
return "", err
}
}
if o.IncludeLength {
if _, err := fmt.Fprintf(buf, "[+] Show length : true\n"); err != nil {
return "", err
}
}
if o.Username != "" {
if _, err := fmt.Fprintf(buf, "[+] Auth User : %s\n", o.Username); err != nil {
return "", err
}
}
if len(o.Extensions) > 0 {
if _, err := fmt.Fprintf(buf, "[+] Extensions : %s\n", o.ExtensionsParsed.Stringify()); err != nil {
return "", err
}
}
if o.UseSlash {
if _, err := fmt.Fprintf(buf, "[+] Add Slash : true\n"); err != nil {
return "", err
}
}
if o.FollowRedirect {
if _, err := fmt.Fprintf(buf, "[+] Follow Redir : true\n"); err != nil {
return "", err
}
}
if o.Expanded {
if _, err := fmt.Fprintf(buf, "[+] Expanded : true\n"); err != nil {
return "", err
}
}
if o.NoStatus {
if _, err := fmt.Fprintf(buf, "[+] No status : true\n"); err != nil {
return "", err
}
}
if o.Verbose {
if _, err := fmt.Fprintf(buf, "[+] Verbose : true\n"); err != nil {
return "", err
}
}
if _, err := fmt.Fprintf(buf, "[+] Timeout : %s\n", o.Timeout.String()); err != nil {
return "", err
}
}
return strings.TrimSpace(buf.String()), nil
}