mirror of
https://github.com/kubescape/kubescape.git
synced 2026-04-15 06:58:11 +00:00
548955fc16
* Interfaces are unchanged
* Deprecated: low-level API funcs marked for deprecation:
HttpPost, HttpGetter, HttpDelete (an augmented version of the KS Cloud
client will expose the post report API, which is currently the sole
use-case of low-level API)
* Doc: the package is now godoc-friendly
* Style & code layout:
* listed all exposed types via aliases, for clarity/less confusing
imports
* unexported private types
* factorized query param logic
* factorized type <-> JSON using generic func & io.Reader
* "utils" are now limited to a few common utility functions
* centralized hard-coded strings as (unexported) constants
* concision: use higher-level http definitions such as constants,
cookie methods, etc
* included type-safety guards to verify that interfaces are
actually implemented by the exported types
* Tests: existing test assertions are unchanged
* tests are beefed-up to assert proper authentication flow (token & cookie).
* added unit tests for utility methods
* Perf:
* unmarshalling API responses is now flowing without extraneous memory allocation via string representation
* request headers are now passed withot extraneous map allocation
* JSON operations are now fully supported by jsoniter (no longer use encoding/json)
* Changes in functionality:
* the client is now fully extensible with KSCloudOption
* use the option functor idiom to keep constructors short
* methods that used to mute errors (i.e. return nil, nil) now bubble up errors
* the captured cookie is now captured in full, not just its value
(other cookie parameters returned are stored)
* added a request/response dump option, for debugging
* added support for SubmitReport and retrieval of UI url's
* backported utm changes (reports use case)
Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
56 lines
1.6 KiB
Go
56 lines
1.6 KiB
Go
package getter
|
|
|
|
import (
|
|
"github.com/armosec/armoapi-go/armotypes"
|
|
"github.com/kubescape/opa-utils/reporthandling"
|
|
"github.com/kubescape/opa-utils/reporthandling/attacktrack/v1alpha1"
|
|
)
|
|
|
|
type (
|
|
// IPolicyGetter knows how to retrieve policies, i.e. frameworks and their controls.
|
|
IPolicyGetter interface {
|
|
GetFramework(name string) (*reporthandling.Framework, error)
|
|
GetFrameworks() ([]reporthandling.Framework, error)
|
|
GetControl(ID string) (*reporthandling.Control, error)
|
|
|
|
ListFrameworks() ([]string, error)
|
|
ListControls() ([]string, error)
|
|
}
|
|
|
|
// IExceptionsGetter knows how to retrieve exceptions.
|
|
IExceptionsGetter interface {
|
|
GetExceptions(clusterName string) ([]armotypes.PostureExceptionPolicy, error)
|
|
}
|
|
|
|
// IControlsInputsGetter knows how to retrieve controls inputs.
|
|
IControlsInputsGetter interface {
|
|
GetControlsInputs(clusterName string) (map[string][]string, error)
|
|
}
|
|
|
|
// IAttackTracksGetter knows how to retrieve attack tracks.
|
|
IAttackTracksGetter interface {
|
|
GetAttackTracks() ([]v1alpha1.AttackTrack, error)
|
|
}
|
|
|
|
// IBackend knows how to configure a KS Cloud client
|
|
IBackend interface {
|
|
GetAccountID() string
|
|
GetClientID() string
|
|
GetSecretKey() string
|
|
GetCloudReportURL() string
|
|
GetCloudAPIURL() string
|
|
GetCloudUIURL() string
|
|
GetCloudAuthURL() string
|
|
|
|
SetAccountID(accountID string)
|
|
SetClientID(clientID string)
|
|
SetSecretKey(secretKey string)
|
|
SetCloudReportURL(cloudReportURL string)
|
|
SetCloudAPIURL(cloudAPIURL string)
|
|
SetCloudUIURL(cloudUIURL string)
|
|
SetCloudAuthURL(cloudAuthURL string)
|
|
|
|
GetTenant() (*TenantResponse, error)
|
|
}
|
|
)
|