api

package

v0.0.9 Latest Latest Go to latest Published: Nov 13, 2023 License: MIT Imports: 28 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ghostsecurity/reaper

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type API
- func New(ctx context.Context, logger *log.Logger, settingsProvider *settings.Provider, ...) *API
type VersionInfo

Constants ¶

View Source

const (
	EventHttpRequest  = "HttpRequest"
	EventHttpResponse = "HttpResponse"

	// EventProxyStatus is emitted when the proxy status changes, also includes the proxy address and a message
	EventProxyStatus                   = "ProxyStatusChange"
	EventInterceptedRequest            = "InterceptedRequest"
	EventTreeUpdate                    = "TreeUpdate"
	EventInterceptedRequestQueueChange = "InterceptedRequestQueueChange"
	EventWorkflowStarted               = "WorkflowStarted"
	EventWorkflowFinished              = "WorkflowFinished"
	EventWorkflowUpdate                = "WorkflowUpdated"
	EventWorkflowOutput                = "WorkflowOutput"
	EventNotifyUser                    = "NotifyUser"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type API ¶

type API struct {
	// contains filtered or unexported fields
}

func New ¶

func New(ctx context.Context, logger *log.Logger, settingsProvider *settings.Provider, eventTrigger func(event string, args ...interface{}) error) *API

func (*API) BindingsOnly ¶

func (a *API) BindingsOnly(x workflow.UpdateM, y node.OutputM)

func (*API) Close ¶

func (a *API) Close()

Close can be called to shut down the api

func (*API) CreateNode ¶

func (a *API) CreateNode(nodeType int) *workflow.NodeM

func (*API) CreateWorkflow ¶

func (a *API) CreateWorkflow() *workflow.WorkflowM

func (*API) CreateWorkflowFromRequest ¶

func (a *API) CreateWorkflowFromRequest(reqU map[string]interface{}) *workflow.WorkflowM

func (*API) CreateWorkspace ¶

func (a *API) CreateWorkspace(template *workspace.Workspace) *workspace.Workspace

func (*API) DeleteWorkspace ¶

func (a *API) DeleteWorkspace(id string)

func (*API) DropInterceptedRequest ¶

func (a *API) DropInterceptedRequest(modified packaging.HttpRequest)

func (*API) FormatCode ¶

func (a *API) FormatCode(msg, contentType string) string

func (*API) GenerateID ¶

func (a *API) GenerateID() string

func (*API) GetSettings ¶

func (a *API) GetSettings() settings.Settings

func (*API) GetVersionInfo ¶

func (a *API) GetVersionInfo() VersionInfo

func (*API) GetWorkspace ¶

func (a *API) GetWorkspace() *workspace.Workspace

func (*API) GetWorkspaces ¶

func (a *API) GetWorkspaces() []*workspace.Workspace

func (*API) HighlightBody ¶

func (a *API) HighlightBody(body, contentType string) string

func (*API) HighlightHTTP ¶

func (a *API) HighlightHTTP(code string) string

func (*API) LoadWorkspace ¶

func (a *API) LoadWorkspace(id string) *workspace.Workspace

func (*API) ModifyInterceptedRequest ¶

func (a *API) ModifyInterceptedRequest(modified packaging.HttpRequest)

func (*API) RunWorkflow ¶

func (a *API) RunWorkflow(w *workflow.WorkflowM)

func (*API) SaveSettings ¶

func (a *API) SaveSettings(newSettings *settings.Settings)

func (*API) SaveWorkspace ¶

func (a *API) SaveWorkspace(ws *workspace.Workspace)

func (*API) SendRequest ¶

func (a *API) SendRequest(req packaging.HttpRequest)

func (*API) SetWorkspace ¶

func (a *API) SetWorkspace(workspace *workspace.Workspace)

func (*API) StartProxy ¶

func (a *API) StartProxy()

func (*API) StopProxy ¶

func (a *API) StopProxy() error

StopProxy stops the proxy (can be restarted later)

func (*API) StopWorkflow ¶

func (a *API) StopWorkflow()

func (*API) Test ¶

func (a *API) Test(input string) string

type VersionInfo ¶

type VersionInfo struct {
	Version string `json:"version"`
	Date    string `json:"date"`
	URL     string `json:"url"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL