misc: refactored and ported the plugin system to islazy/plugin.Plugin (huge optimization)

This commit is contained in:
evilsocket 2018-10-13 14:13:06 +02:00
commit dd2e8784dc
9 changed files with 374 additions and 335 deletions

View file

@ -1,129 +1,64 @@
package modules
import (
"io/ioutil"
"net/http"
"github.com/bettercap/bettercap/log"
"github.com/bettercap/bettercap/session"
"github.com/robertkrimen/otto"
"github.com/evilsocket/islazy/plugin"
)
type HttpProxyScript struct {
*ProxyScript
onRequestScript *otto.Script
onResponseScript *otto.Script
onCommandScript *otto.Script
}
*plugin.Plugin
func LoadHttpProxyScriptSource(path, source string, sess *session.Session) (err error, s *HttpProxyScript) {
err, ps := LoadProxyScriptSource(path, source, sess)
if err != nil {
return
}
s = &HttpProxyScript{
ProxyScript: ps,
onRequestScript: nil,
onResponseScript: nil,
onCommandScript: nil,
}
if s.hasCallback("onRequest") {
s.onRequestScript, err = s.VM.Compile("", "onRequest(req, res)")
if err != nil {
log.Error("Error while compiling onRequest callback: %s", "\nTraceback:\n "+err.(*otto.Error).String())
return
}
}
if s.hasCallback("onResponse") {
s.onResponseScript, err = s.VM.Compile("", "onResponse(req, res)")
if err != nil {
log.Error("Error while compiling onResponse callback: %s", "\nTraceback:\n "+err.(*otto.Error).String())
return
}
}
if s.hasCallback("onCommand") {
s.onCommandScript, err = s.VM.Compile("", "onCommand(cmd)")
if err != nil {
log.Error("Error while compiling onCommand callback: %s", "\nTraceback:\n "+err.(*otto.Error).String())
return
}
}
return
doOnRequest bool
doOnResponse bool
doOnCommand bool
}
func LoadHttpProxyScript(path string, sess *session.Session) (err error, s *HttpProxyScript) {
log.Info("loading proxy script %s ...", path)
raw, err := ioutil.ReadFile(path)
plug, err := plugin.Load(path)
if err != nil {
return
}
return LoadHttpProxyScriptSource(path, string(raw), sess)
}
func (s *HttpProxyScript) doRequestDefines(req *http.Request) (err error, jsreq *JSRequest, jsres *JSResponse) {
jsreq = NewJSRequest(req)
if err = s.VM.Set("req", jsreq); err != nil {
log.Error("Error while defining request: %s", "\nTraceback:\n "+err.(*otto.Error).String())
// define session pointer
if err = plug.Set("env", sess.Env.Data); err != nil {
log.Error("Error while defining environment: %+v", err)
return
}
jsres = NewJSResponse(nil)
if err = s.VM.Set("res", jsres); err != nil {
log.Error("Error while defining response: %s", "\nTraceback:\n "+err.(*otto.Error).String())
return
}
return
}
func (s *HttpProxyScript) doResponseDefines(res *http.Response) (err error, jsreq *JSRequest, jsres *JSResponse) {
jsreq = NewJSRequest(res.Request)
if err = s.VM.Set("req", jsreq); err != nil {
log.Error("Error while defining request: %s", "\nTraceback:\n "+err.(*otto.Error).String())
return
// run onLoad if defined
if plug.HasFunc("onLoad") {
if _, err = plug.Call("onLoad"); err != nil {
log.Error("Error while executing onLoad callback: %s", "\nTraceback:\n "+err.(*otto.Error).String())
return
}
}
jsres = NewJSResponse(res)
if err = s.VM.Set("res", jsres); err != nil {
log.Error("Error while defining response: %s", "\nTraceback:\n "+err.(*otto.Error).String())
return
}
return
}
func (s *HttpProxyScript) doCommandDefines(cmd string) (err error) {
if err = s.VM.Set("cmd", cmd); err != nil {
log.Error("Error while defining cmd: %s", "\nTraceback:\n "+err.(*otto.Error).String())
s = &HttpProxyScript{
Plugin: plug,
doOnRequest: plug.HasFunc("onRequest"),
doOnResponse: plug.HasFunc("onResponse"),
doOnCommand: plug.HasFunc("onCommand"),
}
return
}
func (s *HttpProxyScript) OnRequest(original *http.Request) (jsreq *JSRequest, jsres *JSResponse) {
var err error
if s.doOnRequest {
jsreq := NewJSRequest(original)
jsres := NewJSResponse(nil)
if s.onRequestScript != nil {
s.Lock()
defer s.Unlock()
if err, jsreq, jsres = s.doRequestDefines(original); err != nil {
log.Error("Error while running bootstrap definitions: %s", "\nTraceback:\n "+err.(*otto.Error).String())
if _, err := s.Call("onRequest", jsreq, jsres); err != nil {
log.Error("%s", err)
return nil, nil
}
if _, err = s.VM.Run(s.onRequestScript); err != nil {
log.Error("Error while executing onRequest callback: %s", "\nTraceback:\n "+err.(*otto.Error).String())
return nil, nil
}
if jsreq.WasModified() {
} else if jsreq.WasModified() {
jsreq.UpdateHash()
return jsreq, nil
} else if jsres.WasModified() {
@ -136,23 +71,14 @@ func (s *HttpProxyScript) OnRequest(original *http.Request) (jsreq *JSRequest, j
}
func (s *HttpProxyScript) OnResponse(res *http.Response) (jsreq *JSRequest, jsres *JSResponse) {
var err error
if s.doOnResponse {
jsreq := NewJSRequest(res.Request)
jsres := NewJSResponse(res)
if s.onResponseScript != nil {
s.Lock()
defer s.Unlock()
if err, jsreq, jsres = s.doResponseDefines(res); err != nil {
log.Error("Error while running bootstrap definitions: %s", "\nTraceback:\n "+err.(*otto.Error).String())
if _, err := s.Call("onResponse", jsreq, jsres); err != nil {
log.Error("%s", err)
return nil, nil
}
if _, err = s.VM.Run(s.onResponseScript); err != nil {
log.Error("Error while executing onRequest callback: %s", "\nTraceback:\n "+err.(*otto.Error).String())
return nil, nil
}
if jsres.WasModified() {
} else if jsres.WasModified() {
jsres.UpdateHash()
return nil, jsres
}
@ -162,19 +88,11 @@ func (s *HttpProxyScript) OnResponse(res *http.Response) (jsreq *JSRequest, jsre
}
func (s *HttpProxyScript) OnCommand(cmd string) bool {
if s.onCommandScript != nil {
s.Lock()
defer s.Unlock()
if err := s.doCommandDefines(cmd); err != nil {
log.Error("Error while running bootstrap onCommand definitions: %s", "\nTraceback:\n "+err.(*otto.Error).String())
if s.doOnCommand {
if ret, err := s.Call("onCommand", cmd); err != nil {
log.Error("Error while executing onCommand callback: %+v", err)
return false
}
if ret, err := s.VM.Run(s.onCommandScript); err != nil {
log.Error("Error while executing onCommand callback: %s", "\nTraceback:\n "+err.(*otto.Error).String())
return false
} else if v, err := ret.ToBoolean(); err == nil {
} else if v, ok := ret.(bool); ok {
return v
}
}

View file

@ -1,37 +0,0 @@
package modules
import (
"net/http"
"testing"
"github.com/bettercap/bettercap/log"
"github.com/bettercap/bettercap/session"
)
func getScript(src string) *HttpProxyScript {
sess := session.Session{}
sess.Env, _ = session.NewEnvironment("")
err, script := LoadHttpProxyScriptSource("", src, &sess)
if err != nil {
log.Fatal("%s", err)
}
return script
}
func getRequest() *http.Request {
req, err := http.NewRequest("GET", "http://www.google.com/", nil)
if err != nil {
log.Fatal("%s", err)
}
return req
}
func BenchmarkOnRequest(b *testing.B) {
script := getScript("function onRequest(req,res){}")
req := getRequest()
for n := 0; n < b.N; n++ {
script.OnRequest(req)
}
}

View file

@ -3,11 +3,12 @@ package modules
import (
"encoding/base64"
"io/ioutil"
"sync"
"github.com/bettercap/bettercap/log"
"github.com/bettercap/bettercap/session"
"github.com/evilsocket/islazy/plugin"
"github.com/robertkrimen/otto"
)
@ -18,71 +19,9 @@ func errOtto(format string, args ...interface{}) otto.Value {
return nullOtto
}
type ProxyScript struct {
sync.Mutex
Path string
Source string
VM *otto.Otto
sess *session.Session
cbCacheLock *sync.Mutex
cbCache map[string]bool
}
func LoadProxyScriptSource(path, source string, sess *session.Session) (err error, s *ProxyScript) {
s = &ProxyScript{
Path: path,
Source: source,
VM: otto.New(),
sess: sess,
cbCacheLock: &sync.Mutex{},
cbCache: make(map[string]bool),
}
// this will define callbacks and global objects
_, err = s.VM.Run(s.Source)
if err != nil {
return
}
// define session pointer
err = s.VM.Set("env", sess.Env.Data)
if err != nil {
log.Error("Error while defining environment: %s", "\nTraceback:\n "+err.(*otto.Error).String())
return
}
err = s.defineBuiltins()
if err != nil {
log.Error("Error while defining builtin functions: %s", "\nTraceback:\n "+err.(*otto.Error).String())
return
}
// run onLoad if defined
if s.hasCallback("onLoad") {
_, err = s.VM.Run("onLoad()")
if err != nil {
log.Error("Error while executing onLoad callback: %s", "\nTraceback:\n "+err.(*otto.Error).String())
return
}
}
return
}
func LoadProxyScript(path string, sess *session.Session) (err error, s *ProxyScript) {
raw, err := ioutil.ReadFile(path)
if err != nil {
return
}
return LoadProxyScriptSource(path, string(raw), sess)
}
func (s *ProxyScript) defineBuiltins() error {
func init() {
// used to read a file ... doh
s.VM.Set("readFile", func(call otto.FunctionCall) otto.Value {
plugin.Defines["readFile"] = func(call otto.FunctionCall) otto.Value {
argv := call.ArgumentList
argc := len(argv)
if argc != 1 {
@ -95,14 +34,14 @@ func (s *ProxyScript) defineBuiltins() error {
return errOtto("Could not read %s: %s", filename, err)
}
v, err := s.VM.ToValue(string(raw))
v, err := otto.ToValue(string(raw))
if err != nil {
return errOtto("Could not convert to string: %s", err)
}
return v
})
}
s.VM.Set("writeFile", func(call otto.FunctionCall) otto.Value {
plugin.Defines["writeFile"] = func(call otto.FunctionCall) otto.Value {
argv := call.ArgumentList
argc := len(argv)
if argc != 2 {
@ -118,89 +57,89 @@ func (s *ProxyScript) defineBuiltins() error {
}
return otto.NullValue()
})
}
// log something
s.VM.Set("log", func(call otto.FunctionCall) otto.Value {
plugin.Defines["log"] = func(call otto.FunctionCall) otto.Value {
for _, v := range call.ArgumentList {
log.Info("%s", v.String())
}
return otto.Value{}
})
}
// log debug
s.VM.Set("log_debug", func(call otto.FunctionCall) otto.Value {
plugin.Defines["log_debug"] = func(call otto.FunctionCall) otto.Value {
for _, v := range call.ArgumentList {
log.Debug("%s", v.String())
}
return otto.Value{}
})
}
// log info
s.VM.Set("log_info", func(call otto.FunctionCall) otto.Value {
plugin.Defines["log_info"] = func(call otto.FunctionCall) otto.Value {
for _, v := range call.ArgumentList {
log.Info("%s", v.String())
}
return otto.Value{}
})
}
// log warning
s.VM.Set("log_warn", func(call otto.FunctionCall) otto.Value {
plugin.Defines["log_warn"] = func(call otto.FunctionCall) otto.Value {
for _, v := range call.ArgumentList {
log.Warning("%s", v.String())
}
return otto.Value{}
})
}
// log error
s.VM.Set("log_error", func(call otto.FunctionCall) otto.Value {
plugin.Defines["log_error"] = func(call otto.FunctionCall) otto.Value {
for _, v := range call.ArgumentList {
log.Error("%s", v.String())
}
return otto.Value{}
})
}
// log fatal
s.VM.Set("log_fatal", func(call otto.FunctionCall) otto.Value {
plugin.Defines["log_fatal"] = func(call otto.FunctionCall) otto.Value {
for _, v := range call.ArgumentList {
log.Fatal("%s", v.String())
}
return otto.Value{}
})
}
// javascript btoa function
s.VM.Set("btoa", func(call otto.FunctionCall) otto.Value {
plugin.Defines["btoa"] = func(call otto.FunctionCall) otto.Value {
varValue := base64.StdEncoding.EncodeToString([]byte(call.Argument(0).String()))
v, err := s.VM.ToValue(varValue)
v, err := otto.ToValue(varValue)
if err != nil {
return errOtto("Could not convert to string: %s", varValue)
}
return v
})
}
// javascript atob function
s.VM.Set("atob", func(call otto.FunctionCall) otto.Value {
plugin.Defines["atob"] = func(call otto.FunctionCall) otto.Value {
varValue, err := base64.StdEncoding.DecodeString(call.Argument(0).String())
if err != nil {
return errOtto("Could not decode string: %s", call.Argument(0).String())
}
v, err := s.VM.ToValue(string(varValue))
v, err := otto.ToValue(string(varValue))
if err != nil {
return errOtto("Could not convert to string: %s", varValue)
}
return v
})
}
// read or write environment variable
s.VM.Set("env", func(call otto.FunctionCall) otto.Value {
plugin.Defines["env"] = func(call otto.FunctionCall) otto.Value {
argv := call.ArgumentList
argc := len(argv)
if argc == 1 {
// get
varName := call.Argument(0).String()
if found, varValue := s.sess.Env.Get(varName); found {
v, err := s.VM.ToValue(varValue)
if found, varValue := session.I.Env.Get(varName); found {
v, err := otto.ToValue(varValue)
if err != nil {
return errOtto("Could not convert to string: %s", varValue)
}
@ -211,33 +150,11 @@ func (s *ProxyScript) defineBuiltins() error {
// set
varName := call.Argument(0).String()
varValue := call.Argument(1).String()
s.sess.Env.Set(varName, varValue)
session.I.Env.Set(varName, varValue)
} else {
return errOtto("env: expected 1 or 2 arguments, %d given instead.", argc)
}
return nullOtto
})
return nil
}
func (s *ProxyScript) hasCallback(name string) bool {
s.cbCacheLock.Lock()
defer s.cbCacheLock.Unlock()
// check the cache
has, found := s.cbCache[name]
if !found {
// check the VM
cb, err := s.VM.Get(name)
if err == nil && cb.IsFunction() {
has = true
} else {
has = false
}
s.cbCache[name] = has
}
return has
}

View file

@ -1,7 +1,6 @@
package modules
import (
"io/ioutil"
"net"
"strings"
@ -9,97 +8,62 @@ import (
"github.com/bettercap/bettercap/session"
"github.com/robertkrimen/otto"
"github.com/evilsocket/islazy/plugin"
)
type TcpProxyScript struct {
*ProxyScript
onDataScript *otto.Script
*plugin.Plugin
doOnData bool
}
func LoadTcpProxyScriptSource(path, source string, sess *session.Session) (err error, s *TcpProxyScript) {
err, ps := LoadProxyScriptSource(path, source, sess)
func LoadTcpProxyScript(path string, sess *session.Session) (err error, s *TcpProxyScript) {
log.Info("loading tcp proxy script %s ...", path)
plug, err := plugin.Load(path)
if err != nil {
return
}
s = &TcpProxyScript{
ProxyScript: ps,
onDataScript: nil,
// define session pointer
if err = plug.Set("env", sess.Env.Data); err != nil {
log.Error("Error while defining environment: %+v", err)
return
}
if s.hasCallback("onData") {
s.onDataScript, err = s.VM.Compile("", "onData(from, to, data)")
if err != nil {
log.Error("Error while compiling onData callback: %s", err)
// run onLoad if defined
if plug.HasFunc("onLoad") {
if _, err = plug.Call("onLoad"); err != nil {
log.Error("Error while executing onLoad callback: %s", "\nTraceback:\n "+err.(*otto.Error).String())
return
}
}
return
}
func LoadTcpProxyScript(path string, sess *session.Session) (err error, s *TcpProxyScript) {
log.Info("loading TCP proxy script %s ...", path)
raw, err := ioutil.ReadFile(path)
if err != nil {
return
}
return LoadTcpProxyScriptSource(path, string(raw), sess)
}
func (s *TcpProxyScript) doDefines(from, to net.Addr, data []byte) (err error) {
addrFrom := strings.Split(from.String(), ":")[0]
addrTo := strings.Split(to.String(), ":")[0]
if err = s.VM.Set("from", addrFrom); err != nil {
log.Error("Error while defining from: %s", err)
return
} else if err = s.VM.Set("to", addrTo); err != nil {
log.Error("Error while defining to: %s", err)
return
} else if err = s.VM.Set("data", data); err != nil {
log.Error("Error while defining data: %s", err)
return
s = &TcpProxyScript{
Plugin: plug,
doOnData: plug.HasFunc("onData"),
}
return
}
func (s *TcpProxyScript) OnData(from, to net.Addr, data []byte) []byte {
if s.onDataScript != nil {
if s.doOnData {
s.Lock()
defer s.Unlock()
err := s.doDefines(from, to, data)
if err != nil {
log.Error("Error while running bootstrap definitions: %s", err)
return nil
}
addrFrom := strings.Split(from.String(), ":")[0]
addrTo := strings.Split(to.String(), ":")[0]
ret, err := s.VM.Run(s.onDataScript)
if err != nil {
if ret, err := s.Call("onData", addrFrom, addrTo, data); err != nil {
log.Error("Error while executing onData callback: %s", err)
return nil
}
// do we have any return value to override the buffer with?
if !ret.IsNull() && !ret.IsUndefined() {
exported, err := ret.Export()
if err != nil {
log.Error("Error while exporting results: %s", err)
return nil
}
array, ok := exported.([]byte)
} else if ret != nil {
array, ok := ret.([]byte)
if !ok {
log.Error("Error while casting exported value to array of byte: value = %s", exported)
return nil
log.Error("Error while casting exported value to array of byte: value = %+v", ret)
}
return array
}
}
return nil
}