Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Optional logging in provider #28

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Optional logging in provider #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5a37527
added log enable/disable method to provider
coopersimon Mar 17, 2022
df08711
using SetLog in main.go
coopersimon Mar 17, 2022
b3b869b
docs for p.log
coopersimon Mar 17, 2022
c86749e
removed unused log import in windows
Mar 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 10 additions & 11 deletions main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ import (
"encoding/json"
"flag"
"fmt"
"github.com/rapid7/go-get-proxied/proxy"
"io/ioutil"
"log"
"os"

"github.com/rapid7/go-get-proxied/proxy"
)

func main() {
Expand All @@ -37,7 +37,7 @@ func main() {
target string
jsonOut bool
verbose bool
useList bool
useList bool
)
if protocolP != nil {
protocol = *protocolP
Expand All @@ -54,19 +54,18 @@ func main() {
if verboseP != nil {
verbose = *verboseP
}
if verbose {
log.SetFlags(0)
log.SetOutput(os.Stderr)
} else {
log.SetOutput(ioutil.Discard)
}
if useListP != nil {
useList = *useListP
}
var exit int

log.SetFlags(0)
log.SetOutput(os.Stderr)

provider := proxy.NewProvider(config)
provider.SetLog(verbose)
if useList {
ps := proxy.NewProvider(config).GetProxies(protocol, target)
ps := provider.GetProxies(protocol, target)
if ps != nil {
if jsonOut {
b, _ := json.MarshalIndent(ps, "", " ")
Expand All @@ -80,7 +79,7 @@ func main() {
exit = 1
}
} else {
p := proxy.NewProvider(config).GetProxy(protocol, target)
p := provider.GetProxy(protocol, target)
if p != nil {
if jsonOut {
b, _ := json.MarshalIndent(p, "", " ")
Expand Down
36 changes: 32 additions & 4 deletions proxy/provider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,13 @@ type Provider interface {
*/
SetTimeouts(resolve int, connect int, send int, receive int)
GetProxies(protocol string, targetUrl string) []Proxy

/*
Set whether the provider should log or not.
Params:
log: True to enable logging, false to disable logging. Provider default is true.
*/
SetLog(log bool)
}

const (
Expand Down Expand Up @@ -133,6 +140,7 @@ type provider struct {
connectTimeout int
sendTimeout int
receiveTimeout int
enableLogging bool
}

func (p *provider) init(configFile string) {
Expand All @@ -143,6 +151,7 @@ func (p *provider) init(configFile string) {
p.connectTimeout = defaultConnectTimeout
p.sendTimeout = defaultSendTimeout
p.receiveTimeout = defaultReceiveTimeout
p.enableLogging = true
}

/*
Expand All @@ -166,6 +175,25 @@ func (p *provider) SetTimeouts(resolve int, connect int, send int, receive int)
p.receiveTimeout = receive
}

/*
Set whether the provider should log or not.
Params:
log: True to log, false to not log. Provider default is true.
*/
func (p *provider) SetLog(log bool) {
p.enableLogging = log
}

/*
Format and log a string. Will only log if logging is enabled on the provider.
Arguments are handled in the manner of fmt.Printf.
*/
func (p *provider) log(format string, v ...interface{}) {
if p.enableLogging {
log.Printf(format, v...)
}
}

/*
Returns the Proxy configuration for the given traffic protocol and targetUrl.
If none is found, or an error occurs, nil is returned.
Expand Down Expand Up @@ -196,7 +224,7 @@ Returns:
func (p *provider) readConfigFileProxy(protocol string) Proxy {
proxyJson, err := p.unmarshalProxyConfigFile()
if err != nil {
log.Printf("[proxy.Provider.readConfigFileProxy]: %s\n", err)
p.log("[proxy.Provider.readConfigFileProxy]: %s\n", err)
return nil
}
uStr, exists := proxyJson[protocol]
Expand All @@ -209,7 +237,7 @@ func (p *provider) readConfigFileProxy(protocol string) Proxy {
uProxy, uErr = NewProxy(uUrl, srcConfigurationFile)
}
if uErr != nil {
log.Printf("[proxy.Provider.readConfigFileProxy]: invalid config file proxy, skipping \"%s\": \"%s\"\n", protocol, uStr)
p.log("[proxy.Provider.readConfigFileProxy]: invalid config file proxy, skipping \"%s\": \"%s\"\n", protocol, uStr)
return nil
}
return uProxy
Expand Down Expand Up @@ -282,7 +310,7 @@ K:
proxy, err := p.parseEnvProxy(key)
if err != nil {
if !isNotFound(err) {
log.Printf("[proxy.Provider.readSystemEnvProxy]: failed to parse \"%s\" value: %s\n", key, err)
p.log("[proxy.Provider.readSystemEnvProxy]: failed to parse \"%s\" value: %s\n", key, err)
}
continue
}
Expand All @@ -292,7 +320,7 @@ K:
continue
}
bypass = p.isProxyBypass(targetUrl, proxyBypass, ",")
log.Printf("[proxy.Provider.readSystemEnvProxy]: \"%s\"=\"%s\", targetUrl=%s, bypass=%t", noProxyKey, proxyBypass, targetUrl, bypass)
p.log("[proxy.Provider.readSystemEnvProxy]: \"%s\"=\"%s\", targetUrl=%s, bypass=%t", noProxyKey, proxyBypass, targetUrl, bypass)
if bypass {
continue K
}
Expand Down
9 changes: 4 additions & 5 deletions proxy/provider_darwin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ import (
"bytes"
"context"
"fmt"
"log"
"net/url"
"regexp"
"strings"
Expand Down Expand Up @@ -146,11 +145,11 @@ func (p *providerDarwin) readDarwinNetworkSettingProxy(protocol string, targetUr
proxy, err := p.parseScutildata(protocol, targetUrl, scUtilBinary, scUtilBinaryArgument)
if err != nil {
if isNotFound(err) {
log.Printf("[proxy.Provider.readDarwinNetworkSettingProxy]: %s proxy is not enabled.\n", protocol)
p.log("[proxy.Provider.readDarwinNetworkSettingProxy]: %s proxy is not enabled.\n", protocol)
} else if isTimedOut(err) {
log.Printf("[proxy.Provider.readDarwinNetworkSettingProxy]: Operation timed out. \n")
p.log("[proxy.Provider.readDarwinNetworkSettingProxy]: Operation timed out. \n")
} else {
log.Printf("[proxy.Provider.readDarwinNetworkSettingProxy]: Failed to parse Scutil data, %s\n", err)
p.log("[proxy.Provider.readDarwinNetworkSettingProxy]: Failed to parse Scutil data, %s\n", err)
}
}
return proxy
Expand Down Expand Up @@ -265,7 +264,7 @@ func (p *providerDarwin) parseScutildata(protocol string, targetUrl *url.URL, na
}
if proxyBypass != "" {
bypass := p.isProxyBypass(targetUrl, proxyBypass, ",")
log.Printf("[proxy.Provider.parseProxyInfo]: ProxyBypass=\"%s\", targetUrl=%s, bypass=%t", proxyBypass, targetUrl, bypass)
p.log("[proxy.Provider.parseProxyInfo]: ProxyBypass=\"%s\", targetUrl=%s, bypass=%t", proxyBypass, targetUrl, bypass)
if bypass {
return nil, nil
}
Expand Down
21 changes: 10 additions & 11 deletions proxy/provider_windows.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ package proxy

import (
"github.com/rapid7/go-get-proxied/winhttp"
"log"
"net/url"
"reflect"
"strings"
Expand Down Expand Up @@ -58,7 +57,7 @@ func (p *providerWindows) GetProxy(protocol string, targetUrlStr string) Proxy {
if len(proxies) == 0 {
return nil
}
return proxies[len(proxies) - 1]
return proxies[len(proxies)-1]
}

/*
Expand Down Expand Up @@ -117,7 +116,7 @@ func (p *providerWindows) GetProxies(protocol string, targetUrlStr string) []Pro
targetUrl := ParseTargetURL(targetUrlStr, protocol)
proxy := p.provider.get(protocol, targetUrl)
if proxy != nil {
return []Proxy{proxy}
return []Proxy{proxy}
}
proxies := p.readWinHttpProxy(protocol, targetUrl)
return proxies
Expand All @@ -140,39 +139,39 @@ func (p *providerWindows) readWinHttpProxy(protocol string, targetUrl *url.URL)
// Internet Options
ieProxyConfig, err := p.getIeProxyConfigCurrentUser()
if err != nil {
log.Printf("[proxy.Provider.readWinHttpProxy] Failed to read IE proxy config: %s\n", err)
p.log("[proxy.Provider.readWinHttpProxy] Failed to read IE proxy config: %s\n", err)
} else {
defer p.freeWinHttpResource(ieProxyConfig)
if ieProxyConfig.FAutoDetect {
proxy, err := p.getProxyAutoDetect(protocol, targetUrl)
if err == nil {
return proxy
} else if !isNotFound(err) {
log.Printf("[proxy.Provider.readWinHttpProxy] No proxy discovered via AutoDetect: %s\n", err)
p.log("[proxy.Provider.readWinHttpProxy] No proxy discovered via AutoDetect: %s\n", err)
}
}
if autoConfigUrl := winhttp.LpwstrToString(ieProxyConfig.LpszAutoConfigUrl); autoConfigUrl != "" {
proxies, err := p.getProxyAutoConfigUrl(protocol, targetUrl, autoConfigUrl)
if err == nil {
return proxies
} else if !isNotFound(err) {
log.Printf("[proxy.Provider.readWinHttpProxy] No proxy discovered via AutoConfigUrl, %s: %s\n", autoConfigUrl, err)
p.log("[proxy.Provider.readWinHttpProxy] No proxy discovered via AutoConfigUrl, %s: %s\n", autoConfigUrl, err)
}
}
// LpszProxy may contain multiple proxies which needs to be parsed into a list of Proxy
proxies, err := p.parseProxyInfo(srcNamedProxy, protocol, targetUrl, ieProxyConfig.LpszProxy, ieProxyConfig.LpszProxyBypass)
if err == nil {
return proxies
} else if !isNotFound(err) {
log.Printf("[proxy.Provider.readWinHttpProxy] Failed to parse named proxy: %s\n", err)
p.log("[proxy.Provider.readWinHttpProxy] Failed to parse named proxy: %s\n", err)
}
}
// netsh winhttp
proxies, err := p.getProxyWinHttpDefault(protocol, targetUrl)
if err == nil {
return proxies
} else if !isNotFound(err) {
log.Printf("[proxy.Provider.readWinHttpProxy] Failed to parse WinHttp default proxy info: %s\n", err)
p.log("[proxy.Provider.readWinHttpProxy] Failed to parse WinHttp default proxy info: %s\n", err)
}
return nil
}
Expand Down Expand Up @@ -333,7 +332,7 @@ func (p *providerWindows) parseProxyInfo(src string, protocol string, targetUrl
for _, proxyUrlStr := range proxyUrlStrList {
proxyUrl, err := ParseURL(proxyUrlStr, "")
if err != nil {
log.Printf("Failed to parse proxy URL\"$\"", proxyUrlStr)
p.log("Failed to parse proxy URL\"$\"", proxyUrlStr)
continue
}
pr, _ := NewProxy(proxyUrl, src)
Expand Down Expand Up @@ -401,7 +400,7 @@ Params:
*/
func (p *providerWindows) closeHandle(h winhttp.HInternet) {
if err := winhttp.CloseHandle(h); err != nil {
log.Printf("[proxy.Provider.closeHandle] Failed to close handle \"%d\": %s\n", h, err)
p.log("[proxy.Provider.closeHandle] Failed to close handle \"%d\": %s\n", h, err)
}
}

Expand All @@ -415,6 +414,6 @@ func (p *providerWindows) freeWinHttpResource(r winhttp.Allocated) {
return
}
if err := r.Free(); err != nil {
log.Printf("[proxy.Provider.readWinHttp] Failed to free struct \"%s\": %s\n", reflect.TypeOf(r), err)
p.log("[proxy.Provider.readWinHttp] Failed to free struct \"%s\": %s\n", reflect.TypeOf(r), err)
}
}