Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterSIEMServiceServer(s grpc.ServiceRegistrar, srv SIEMServiceServer)
- type GrpcClient
- type InitSIEMRequest
- func (*InitSIEMRequest) Descriptor() ([]byte, []int)deprecated
- func (x *InitSIEMRequest) GetConfig() *structpb.Struct
- func (x *InitSIEMRequest) GetProviderId() string
- func (x *InitSIEMRequest) GetTenantId() string
- func (*InitSIEMRequest) ProtoMessage()
- func (x *InitSIEMRequest) ProtoReflect() protoreflect.Message
- func (x *InitSIEMRequest) Reset()
- func (x *InitSIEMRequest) String() string
- type SIEMResponse
- func (*SIEMResponse) Descriptor() ([]byte, []int)deprecated
- func (x *SIEMResponse) GetError() string
- func (x *SIEMResponse) GetSuccess() bool
- func (*SIEMResponse) ProtoMessage()
- func (x *SIEMResponse) ProtoReflect() protoreflect.Message
- func (x *SIEMResponse) Reset()
- func (x *SIEMResponse) String() string
- type SIEMServiceClient
- type SIEMServiceServer
- type TerminateSIEMRequest
- func (*TerminateSIEMRequest) Descriptor() ([]byte, []int)deprecated
- func (x *TerminateSIEMRequest) GetTenantId() string
- func (*TerminateSIEMRequest) ProtoMessage()
- func (x *TerminateSIEMRequest) ProtoReflect() protoreflect.Message
- func (x *TerminateSIEMRequest) Reset()
- func (x *TerminateSIEMRequest) String() string
- type UnimplementedSIEMServiceServer
- type UnsafeSIEMServiceServer
Constants ¶
const ( SIEMService_InitSIEM_FullMethodName = "/netmaker.siem.SIEMService/InitSIEM" SIEMService_TerminateSIEM_FullMethodName = "/netmaker.siem.SIEMService/TerminateSIEM" )
Variables ¶
var File_grpc_siem_siem_proto protoreflect.FileDescriptor
var SIEMService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "netmaker.siem.SIEMService", HandlerType: (*SIEMServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "InitSIEM", Handler: _SIEMService_InitSIEM_Handler, }, { MethodName: "TerminateSIEM", Handler: _SIEMService_TerminateSIEM_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "grpc/siem/siem.proto", }
SIEMService_ServiceDesc is the grpc.ServiceDesc for SIEMService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterSIEMServiceServer ¶
func RegisterSIEMServiceServer(s grpc.ServiceRegistrar, srv SIEMServiceServer)
Types ¶
type GrpcClient ¶
type GrpcClient struct {
// contains filtered or unexported fields
}
func Client ¶
func Client() *GrpcClient
func NewSIEMGrpcClient ¶
func NewSIEMGrpcClient(serverAddr string, optFns ...func(*options.Options)) *GrpcClient
type InitSIEMRequest ¶
type InitSIEMRequest struct {
// SIEM provider identifier (e.g. "splunk", "elastic", "datadog", "sentinel")
ProviderId string `protobuf:"bytes,1,opt,name=provider_id,json=providerId,proto3" json:"provider_id,omitempty"`
// Provider-specific configuration (e.g. endpoint, token, index)
Config *structpb.Struct `protobuf:"bytes,2,opt,name=config,proto3" json:"config,omitempty"`
// Tenant identifier scoping this SIEM export.
TenantId string `protobuf:"bytes,3,opt,name=tenant_id,json=tenantId,proto3" json:"tenant_id,omitempty"`
// contains filtered or unexported fields
}
* Sent by the netmaker server to instruct the exporter to begin forwarding events to the specified SIEM provider.
func (*InitSIEMRequest) Descriptor
deprecated
func (*InitSIEMRequest) Descriptor() ([]byte, []int)
Deprecated: Use InitSIEMRequest.ProtoReflect.Descriptor instead.
func (*InitSIEMRequest) GetConfig ¶
func (x *InitSIEMRequest) GetConfig() *structpb.Struct
func (*InitSIEMRequest) GetProviderId ¶
func (x *InitSIEMRequest) GetProviderId() string
func (*InitSIEMRequest) GetTenantId ¶ added in v1.7.0
func (x *InitSIEMRequest) GetTenantId() string
func (*InitSIEMRequest) ProtoMessage ¶
func (*InitSIEMRequest) ProtoMessage()
func (*InitSIEMRequest) ProtoReflect ¶
func (x *InitSIEMRequest) ProtoReflect() protoreflect.Message
func (*InitSIEMRequest) Reset ¶
func (x *InitSIEMRequest) Reset()
func (*InitSIEMRequest) String ¶
func (x *InitSIEMRequest) String() string
type SIEMResponse ¶
type SIEMResponse struct {
Success bool `protobuf:"varint,1,opt,name=success,proto3" json:"success,omitempty"`
Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
// contains filtered or unexported fields
}
* Shared response for both Init and Terminate RPCs.
func (*SIEMResponse) Descriptor
deprecated
func (*SIEMResponse) Descriptor() ([]byte, []int)
Deprecated: Use SIEMResponse.ProtoReflect.Descriptor instead.
func (*SIEMResponse) GetError ¶
func (x *SIEMResponse) GetError() string
func (*SIEMResponse) GetSuccess ¶
func (x *SIEMResponse) GetSuccess() bool
func (*SIEMResponse) ProtoMessage ¶
func (*SIEMResponse) ProtoMessage()
func (*SIEMResponse) ProtoReflect ¶
func (x *SIEMResponse) ProtoReflect() protoreflect.Message
func (*SIEMResponse) Reset ¶
func (x *SIEMResponse) Reset()
func (*SIEMResponse) String ¶
func (x *SIEMResponse) String() string
type SIEMServiceClient ¶
type SIEMServiceClient interface {
// Instruct the exporter to start forwarding events to the given SIEM provider.
InitSIEM(ctx context.Context, in *InitSIEMRequest, opts ...grpc.CallOption) (*SIEMResponse, error)
// Instruct the exporter to stop all SIEM forwarding.
TerminateSIEM(ctx context.Context, in *TerminateSIEMRequest, opts ...grpc.CallOption) (*SIEMResponse, error)
}
SIEMServiceClient is the client API for SIEMService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
* Unary RPCs called by the netmaker server to control SIEM export on the netmaker exporter.
func NewSIEMServiceClient ¶
func NewSIEMServiceClient(cc grpc.ClientConnInterface) SIEMServiceClient
type SIEMServiceServer ¶
type SIEMServiceServer interface {
// Instruct the exporter to start forwarding events to the given SIEM provider.
InitSIEM(context.Context, *InitSIEMRequest) (*SIEMResponse, error)
// Instruct the exporter to stop all SIEM forwarding.
TerminateSIEM(context.Context, *TerminateSIEMRequest) (*SIEMResponse, error)
// contains filtered or unexported methods
}
SIEMServiceServer is the server API for SIEMService service. All implementations must embed UnimplementedSIEMServiceServer for forward compatibility.
* Unary RPCs called by the netmaker server to control SIEM export on the netmaker exporter.
type TerminateSIEMRequest ¶ added in v1.7.0
type TerminateSIEMRequest struct {
// Tenant identifier scoping which export to terminate.
TenantId string `protobuf:"bytes,1,opt,name=tenant_id,json=tenantId,proto3" json:"tenant_id,omitempty"`
// contains filtered or unexported fields
}
* Sent by the netmaker server to instruct the exporter to stop forwarding events.
func (*TerminateSIEMRequest) Descriptor
deprecated
added in
v1.7.0
func (*TerminateSIEMRequest) Descriptor() ([]byte, []int)
Deprecated: Use TerminateSIEMRequest.ProtoReflect.Descriptor instead.
func (*TerminateSIEMRequest) GetTenantId ¶ added in v1.7.0
func (x *TerminateSIEMRequest) GetTenantId() string
func (*TerminateSIEMRequest) ProtoMessage ¶ added in v1.7.0
func (*TerminateSIEMRequest) ProtoMessage()
func (*TerminateSIEMRequest) ProtoReflect ¶ added in v1.7.0
func (x *TerminateSIEMRequest) ProtoReflect() protoreflect.Message
func (*TerminateSIEMRequest) Reset ¶ added in v1.7.0
func (x *TerminateSIEMRequest) Reset()
func (*TerminateSIEMRequest) String ¶ added in v1.7.0
func (x *TerminateSIEMRequest) String() string
type UnimplementedSIEMServiceServer ¶
type UnimplementedSIEMServiceServer struct{}
UnimplementedSIEMServiceServer must be embedded to have forward compatible implementations.
NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.
func (UnimplementedSIEMServiceServer) InitSIEM ¶
func (UnimplementedSIEMServiceServer) InitSIEM(context.Context, *InitSIEMRequest) (*SIEMResponse, error)
func (UnimplementedSIEMServiceServer) TerminateSIEM ¶
func (UnimplementedSIEMServiceServer) TerminateSIEM(context.Context, *TerminateSIEMRequest) (*SIEMResponse, error)
type UnsafeSIEMServiceServer ¶
type UnsafeSIEMServiceServer interface {
// contains filtered or unexported methods
}
UnsafeSIEMServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SIEMServiceServer will result in compilation errors.