profiles

package
v0.0.0-...-7e02c4e Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 12, 2024 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Overview

Package profiles is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source 
var (
	Query_OrderType_name = map[int32]string{
		0: "ASC",
		1: "DESC",
	}
	Query_OrderType_value = map[string]int32{
		"ASC":  0,
		"DESC": 1,
	}
)

Enum value maps for Query_OrderType.

View Source 
var File_external_compliance_profiles_profiles_proto protoreflect.FileDescriptor

Functions

func RegisterProfilesServiceHandler 

func RegisterProfilesServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterProfilesServiceHandler registers the http handlers for service ProfilesService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterProfilesServiceHandlerClient 

func RegisterProfilesServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ProfilesServiceClient) error

RegisterProfilesServiceHandlerClient registers the http handlers for service ProfilesService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "ProfilesServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "ProfilesServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "ProfilesServiceClient" to call the correct interceptors.

func RegisterProfilesServiceHandlerFromEndpoint 

func RegisterProfilesServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterProfilesServiceHandlerFromEndpoint is same as RegisterProfilesServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterProfilesServiceHandlerServer 

func RegisterProfilesServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ProfilesServiceServer) error

RegisterProfilesServiceHandlerServer registers the http handlers for service ProfilesService to "mux". UnaryRPC :call ProfilesServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906.

func RegisterProfilesServiceServer 

func RegisterProfilesServiceServer(s *grpc.Server, srv ProfilesServiceServer)

Types

type Attribute 

type Attribute struct {
	Name    string  `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Options *Option `protobuf:"bytes,2,opt,name=options,proto3" json:"options,omitempty"`
	// contains filtered or unexported fields
}

func (*Attribute) Descriptor deprecated 

func (*Attribute) Descriptor() ([]byte, []int)

Deprecated: Use Attribute.ProtoReflect.Descriptor instead.

func (*Attribute) GetName 

func (x *Attribute) GetName() string

func (*Attribute) GetOptions 

func (x *Attribute) GetOptions() *Option

func (*Attribute) ProtoMessage 

func (*Attribute) ProtoMessage()

func (*Attribute) ProtoReflect 

func (x *Attribute) ProtoReflect() protoreflect.Message

func (*Attribute) Reset 

func (x *Attribute) Reset()

func (*Attribute) String 

func (x *Attribute) String() string

type CheckMessage 

type CheckMessage struct {

	// Profile file where the error or warning exists.
	File string `protobuf:"bytes,1,opt,name=file,proto3" json:"file,omitempty"`
	// Profile line where the error or warning exists.
	Line int32 `protobuf:"varint,2,opt,name=line,proto3" json:"line,omitempty"`
	// Column where the error or warning exists.
	Column int32 `protobuf:"varint,3,opt,name=column,proto3" json:"column,omitempty"`
	// Control ID associated with the error or warning.
	ControlId string `protobuf:"bytes,4,opt,name=control_id,json=controlId,proto3" json:"control_id,omitempty"`
	// Message associated with the error or warning.
	Msg string `protobuf:"bytes,5,opt,name=msg,proto3" json:"msg,omitempty"`
	// contains filtered or unexported fields
}

func (*CheckMessage) Descriptor deprecated 

func (*CheckMessage) Descriptor() ([]byte, []int)

Deprecated: Use CheckMessage.ProtoReflect.Descriptor instead.

func (*CheckMessage) GetColumn 

func (x *CheckMessage) GetColumn() int32

func (*CheckMessage) GetControlId 

func (x *CheckMessage) GetControlId() string

func (*CheckMessage) GetFile 

func (x *CheckMessage) GetFile() string

func (*CheckMessage) GetLine 

func (x *CheckMessage) GetLine() int32

func (*CheckMessage) GetMsg 

func (x *CheckMessage) GetMsg() string

func (*CheckMessage) ProtoMessage 

func (*CheckMessage) ProtoMessage()

func (*CheckMessage) ProtoReflect 

func (x *CheckMessage) ProtoReflect() protoreflect.Message

func (*CheckMessage) Reset 

func (x *CheckMessage) Reset()

func (*CheckMessage) String 

func (x *CheckMessage) String() string

type CheckResult 

type CheckResult struct {

	// Intentionally blank.
	Summary *ResultSummary `protobuf:"bytes,1,opt,name=summary,proto3" json:"summary,omitempty"`
	// Errors returned by the `inspec check` command.
	Errors []*CheckMessage `protobuf:"bytes,2,rep,name=errors,proto3" json:"errors,omitempty"`
	// Warnings returned by the `inspec check` command.
	Warnings []*CheckMessage `protobuf:"bytes,3,rep,name=warnings,proto3" json:"warnings,omitempty"`
	// contains filtered or unexported fields
}

func (*CheckResult) Descriptor deprecated 

func (*CheckResult) Descriptor() ([]byte, []int)

Deprecated: Use CheckResult.ProtoReflect.Descriptor instead.

func (*CheckResult) GetErrors 

func (x *CheckResult) GetErrors() []*CheckMessage

func (*CheckResult) GetSummary 

func (x *CheckResult) GetSummary() *ResultSummary

func (*CheckResult) GetWarnings 

func (x *CheckResult) GetWarnings() []*CheckMessage

func (*CheckResult) ProtoMessage 

func (*CheckResult) ProtoMessage()

func (*CheckResult) ProtoReflect 

func (x *CheckResult) ProtoReflect() protoreflect.Message

func (*CheckResult) Reset 

func (x *CheckResult) Reset()

func (*CheckResult) String 

func (x *CheckResult) String() string

type Chunk 

type Chunk struct {
	Data     []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	Position int64  `protobuf:"varint,2,opt,name=position,proto3" json:"position,omitempty"`
	// contains filtered or unexported fields
}

Profile contents in byte form.

func (*Chunk) Descriptor deprecated 

func (*Chunk) Descriptor() ([]byte, []int)

Deprecated: Use Chunk.ProtoReflect.Descriptor instead.

func (*Chunk) GetData 

func (x *Chunk) GetData() []byte

func (*Chunk) GetPosition 

func (x *Chunk) GetPosition() int64

func (*Chunk) ProtoMessage 

func (*Chunk) ProtoMessage()

func (*Chunk) ProtoReflect 

func (x *Chunk) ProtoReflect() protoreflect.Message

func (*Chunk) Reset 

func (x *Chunk) Reset()

func (*Chunk) String 

func (x *Chunk) String() string

type Control 

type Control struct {

	// The ID of the control.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The code (test) for the control.
	Code string `protobuf:"bytes,2,opt,name=code,proto3" json:"code,omitempty"`
	// The description of the control.
	Desc string `protobuf:"bytes,3,opt,name=desc,proto3" json:"desc,omitempty"`
	// The impact of the control.
	Impact float32 `protobuf:"fixed32,4,opt,name=impact,proto3" json:"impact,omitempty"`
	// The title of the control.
	Title string `protobuf:"bytes,5,opt,name=title,proto3" json:"title,omitempty"`
	// Intentionally blank.
	SourceLocation *SourceLocation `protobuf:"bytes,6,opt,name=source_location,json=sourceLocation,proto3" json:"source_location,omitempty"`
	// The results of the control tests.
	Results []*Result `protobuf:"bytes,7,rep,name=results,proto3" json:"results,omitempty"`
	// The refs associated with the control.
	Refs []*Ref `protobuf:"bytes,8,rep,name=refs,proto3" json:"refs,omitempty"`
	// The tags associated with the control.
	Tags map[string]string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*Control) Descriptor deprecated 

func (*Control) Descriptor() ([]byte, []int)

Deprecated: Use Control.ProtoReflect.Descriptor instead.

func (*Control) GetCode 

func (x *Control) GetCode() string

func (*Control) GetDesc 

func (x *Control) GetDesc() string

func (*Control) GetId 

func (x *Control) GetId() string

func (*Control) GetImpact 

func (x *Control) GetImpact() float32

func (*Control) GetRefs 

func (x *Control) GetRefs() []*Ref

func (*Control) GetResults 

func (x *Control) GetResults() []*Result

func (*Control) GetSourceLocation 

func (x *Control) GetSourceLocation() *SourceLocation

func (*Control) GetTags 

func (x *Control) GetTags() map[string]string

func (*Control) GetTitle 

func (x *Control) GetTitle() string

func (*Control) ProtoMessage 

func (*Control) ProtoMessage()

func (*Control) ProtoReflect 

func (x *Control) ProtoReflect() protoreflect.Message

func (*Control) Reset 

func (x *Control) Reset()

func (*Control) String 

func (x *Control) String() string

type Dependency 

type Dependency struct {

	// Name of the profile.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// URL of the profile.
	Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// Path of the profile.
	Path string `protobuf:"bytes,3,opt,name=path,proto3" json:"path,omitempty"`
	// Git location of the profile.
	Git string `protobuf:"bytes,4,opt,name=git,proto3" json:"git,omitempty"`
	// Branch of the profile.
	Branch string `protobuf:"bytes,5,opt,name=branch,proto3" json:"branch,omitempty"`
	// Tag associated with the profile.
	Tag string `protobuf:"bytes,6,opt,name=tag,proto3" json:"tag,omitempty"`
	// Commit sha for the profile.
	Commit string `protobuf:"bytes,7,opt,name=commit,proto3" json:"commit,omitempty"`
	// Version of the profile.
	Version string `protobuf:"bytes,8,opt,name=version,proto3" json:"version,omitempty"`
	// Supermarket address of the profile.
	Supermarket string `protobuf:"bytes,9,opt,name=supermarket,proto3" json:"supermarket,omitempty"`
	// Github address of the profile.
	Github string `protobuf:"bytes,10,opt,name=github,proto3" json:"github,omitempty"`
	// Automate address of the profile.
	Compliance string `protobuf:"bytes,11,opt,name=compliance,proto3" json:"compliance,omitempty"`
	// contains filtered or unexported fields
}

func (*Dependency) Descriptor deprecated 

func (*Dependency) Descriptor() ([]byte, []int)

Deprecated: Use Dependency.ProtoReflect.Descriptor instead.

func (*Dependency) GetBranch 

func (x *Dependency) GetBranch() string

func (*Dependency) GetCommit 

func (x *Dependency) GetCommit() string

func (*Dependency) GetCompliance 

func (x *Dependency) GetCompliance() string

func (*Dependency) GetGit 

func (x *Dependency) GetGit() string

func (*Dependency) GetGithub 

func (x *Dependency) GetGithub() string

func (*Dependency) GetName 

func (x *Dependency) GetName() string

func (*Dependency) GetPath 

func (x *Dependency) GetPath() string

func (*Dependency) GetSupermarket 

func (x *Dependency) GetSupermarket() string

func (*Dependency) GetTag 

func (x *Dependency) GetTag() string

func (*Dependency) GetUrl 

func (x *Dependency) GetUrl() string

func (*Dependency) GetVersion 

func (x *Dependency) GetVersion() string

func (*Dependency) ProtoMessage 

func (*Dependency) ProtoMessage()

func (*Dependency) ProtoReflect 

func (x *Dependency) ProtoReflect() protoreflect.Message

func (*Dependency) Reset 

func (x *Dependency) Reset()

func (*Dependency) String 

func (x *Dependency) String() string

type Group 

type Group struct {
	Id       string   `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Title    string   `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	Controls []string `protobuf:"bytes,3,rep,name=controls,proto3" json:"controls,omitempty"`
	// contains filtered or unexported fields
}

func (*Group) Descriptor deprecated 

func (*Group) Descriptor() ([]byte, []int)

Deprecated: Use Group.ProtoReflect.Descriptor instead.

func (*Group) GetControls 

func (x *Group) GetControls() []string

func (*Group) GetId 

func (x *Group) GetId() string

func (*Group) GetTitle 

func (x *Group) GetTitle() string

func (*Group) ProtoMessage 

func (*Group) ProtoMessage()

func (*Group) ProtoReflect 

func (x *Group) ProtoReflect() protoreflect.Message

func (*Group) Reset 

func (x *Group) Reset()

func (*Group) String 

func (x *Group) String() string

type ListFilter 

type ListFilter struct {

	// List of values to filter on.
	Values []string `protobuf:"bytes,20,rep,name=values,proto3" json:"values,omitempty"`
	// The field to filter on.
	Type string `protobuf:"bytes,21,opt,name=type,proto3" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*ListFilter) Descriptor deprecated 

func (*ListFilter) Descriptor() ([]byte, []int)

Deprecated: Use ListFilter.ProtoReflect.Descriptor instead.

func (*ListFilter) GetType 

func (x *ListFilter) GetType() string

func (*ListFilter) GetValues 

func (x *ListFilter) GetValues() []string

func (*ListFilter) ProtoMessage 

func (*ListFilter) ProtoMessage()

func (*ListFilter) ProtoReflect 

func (x *ListFilter) ProtoReflect() protoreflect.Message

func (*ListFilter) Reset 

func (x *ListFilter) Reset()

func (*ListFilter) String 

func (x *ListFilter) String() string

type Metadata 

type Metadata struct {

	// Name of the profile (as specified in the inspec.yml)
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Version of the profile.
	Version string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`
	// Content type of the profile (e.g. application/json, application/x-gtar, application/gzip)
	ContentType string `protobuf:"bytes,4,opt,name=content_type,json=contentType,proto3" json:"content_type,omitempty"`
	// contains filtered or unexported fields
}

Metadata about the profile.

func (*Metadata) Descriptor deprecated 

func (*Metadata) Descriptor() ([]byte, []int)

Deprecated: Use Metadata.ProtoReflect.Descriptor instead.

func (*Metadata) GetContentType 

func (x *Metadata) GetContentType() string

func (*Metadata) GetName 

func (x *Metadata) GetName() string

func (*Metadata) GetVersion 

func (x *Metadata) GetVersion() string

func (*Metadata) ProtoMessage 

func (*Metadata) ProtoMessage()

func (*Metadata) ProtoReflect 

func (x *Metadata) ProtoReflect() protoreflect.Message

func (*Metadata) Reset 

func (x *Metadata) Reset()

func (*Metadata) String 

func (x *Metadata) String() string

type Missing 

type Missing struct {

	// An array of profile sha256 IDs that are missing from the backend metadata store.
	MissingSha256 []string `protobuf:"bytes,1,rep,name=missing_sha256,json=missingSha256,proto3" json:"missing_sha256,omitempty"`
	// contains filtered or unexported fields
}

func (*Missing) Descriptor deprecated 

func (*Missing) Descriptor() ([]byte, []int)

Deprecated: Use Missing.ProtoReflect.Descriptor instead.

func (*Missing) GetMissingSha256 

func (x *Missing) GetMissingSha256() []string

func (*Missing) ProtoMessage 

func (*Missing) ProtoMessage()

func (*Missing) ProtoReflect 

func (x *Missing) ProtoReflect() protoreflect.Message

func (*Missing) Reset 

func (x *Missing) Reset()

func (*Missing) String 

func (x *Missing) String() string

type Option 

type Option struct {
	Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
	Default     string `protobuf:"bytes,2,opt,name=default,proto3" json:"default,omitempty"`
	// contains filtered or unexported fields
}

func (*Option) Descriptor deprecated 

func (*Option) Descriptor() ([]byte, []int)

Deprecated: Use Option.ProtoReflect.Descriptor instead.

func (*Option) GetDefault 

func (x *Option) GetDefault() string

func (*Option) GetDescription 

func (x *Option) GetDescription() string

func (*Option) ProtoMessage 

func (*Option) ProtoMessage()

func (*Option) ProtoReflect 

func (x *Option) ProtoReflect() protoreflect.Message

func (*Option) Reset 

func (x *Option) Reset()

func (*Option) String 

func (x *Option) String() string

type Profile 

type Profile struct {

	// The profile name, as specified in the inspec.yml
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The profile title, as specified in the inspec.yml
	Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	// The profile maintainer, as specified in the inspec.yml
	Maintainer string `protobuf:"bytes,3,opt,name=maintainer,proto3" json:"maintainer,omitempty"`
	// The profile copyright, as specified in the inspec.yml
	Copyright string `protobuf:"bytes,4,opt,name=copyright,proto3" json:"copyright,omitempty"`
	// The profile copyright email, as specified in the inspec.yml
	CopyrightEmail string `protobuf:"bytes,5,opt,name=copyright_email,json=copyrightEmail,proto3" json:"copyright_email,omitempty"`
	// The profile license, as specified in the inspec.yml
	License string `protobuf:"bytes,6,opt,name=license,proto3" json:"license,omitempty"`
	// The profile summary, as specified in the inspec.yml
	Summary string `protobuf:"bytes,7,opt,name=summary,proto3" json:"summary,omitempty"`
	// The profile version, as specified in the inspec.yml
	Version string `protobuf:"bytes,8,opt,name=version,proto3" json:"version,omitempty"`
	// The Automate user associated with the profile.
	Owner string `protobuf:"bytes,9,opt,name=owner,proto3" json:"owner,omitempty"`
	// The list of operating systems compatible with the profile, as specified in the inspec.yml
	Supports []*Support `protobuf:"bytes,16,rep,name=supports,proto3" json:"supports,omitempty"`
	// The list of dependencies the profile has, as specified in the inspec.yml
	Depends []*Dependency `protobuf:"bytes,17,rep,name=depends,proto3" json:"depends,omitempty"`
	// The SHA256 of the profile.
	Sha256 string   `protobuf:"bytes,18,opt,name=sha256,proto3" json:"sha256,omitempty"`
	Groups []*Group `protobuf:"bytes,19,rep,name=groups,proto3" json:"groups,omitempty"`
	// The list of controls in the profile.
	Controls []*Control `protobuf:"bytes,20,rep,name=controls,proto3" json:"controls,omitempty"`
	// The list of attributes in the profile.
	Attributes []*Attribute `protobuf:"bytes,21,rep,name=attributes,proto3" json:"attributes,omitempty"`
	// The latest version of the profile.
	LatestVersion string `protobuf:"bytes,22,opt,name=latest_version,json=latestVersion,proto3" json:"latest_version,omitempty"`
	// contains filtered or unexported fields
}

func (*Profile) Descriptor deprecated 

func (*Profile) Descriptor() ([]byte, []int)

Deprecated: Use Profile.ProtoReflect.Descriptor instead.

func (*Profile) GetAttributes 

func (x *Profile) GetAttributes() []*Attribute

func (*Profile) GetControls 

func (x *Profile) GetControls() []*Control

func (*Profile) GetCopyright 

func (x *Profile) GetCopyright() string

func (*Profile) GetCopyrightEmail 

func (x *Profile) GetCopyrightEmail() string

func (*Profile) GetDepends 

func (x *Profile) GetDepends() []*Dependency

func (*Profile) GetGroups 

func (x *Profile) GetGroups() []*Group

func (*Profile) GetLatestVersion 

func (x *Profile) GetLatestVersion() string

func (*Profile) GetLicense 

func (x *Profile) GetLicense() string

func (*Profile) GetMaintainer 

func (x *Profile) GetMaintainer() string

func (*Profile) GetName 

func (x *Profile) GetName() string

func (*Profile) GetOwner 

func (x *Profile) GetOwner() string

func (*Profile) GetSha256 

func (x *Profile) GetSha256() string

func (*Profile) GetSummary 

func (x *Profile) GetSummary() string

func (*Profile) GetSupports 

func (x *Profile) GetSupports() []*Support

func (*Profile) GetTitle 

func (x *Profile) GetTitle() string

func (*Profile) GetVersion 

func (x *Profile) GetVersion() string

func (*Profile) ProtoMessage 

func (*Profile) ProtoMessage()

func (*Profile) ProtoReflect 

func (x *Profile) ProtoReflect() protoreflect.Message

func (*Profile) Reset 

func (x *Profile) Reset()

func (*Profile) String 

func (x *Profile) String() string

type ProfileData 

type ProfileData struct {

	// Automate user associated with the profile.
	Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner,omitempty"`
	// Name of the profile.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Version of the profile.
	Version string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`
	// Profile contents in byte form.
	Data []byte `protobuf:"bytes,4,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ProfileData) Descriptor deprecated 

func (*ProfileData) Descriptor() ([]byte, []int)

Deprecated: Use ProfileData.ProtoReflect.Descriptor instead.

func (*ProfileData) GetData 

func (x *ProfileData) GetData() []byte

func (*ProfileData) GetName 

func (x *ProfileData) GetName() string

func (*ProfileData) GetOwner 

func (x *ProfileData) GetOwner() string

func (*ProfileData) GetVersion 

func (x *ProfileData) GetVersion() string

func (*ProfileData) ProtoMessage 

func (*ProfileData) ProtoMessage()

func (*ProfileData) ProtoReflect 

func (x *ProfileData) ProtoReflect() protoreflect.Message

func (*ProfileData) Reset 

func (x *ProfileData) Reset()

func (*ProfileData) String 

func (x *ProfileData) String() string

type ProfileDetails 

type ProfileDetails struct {

	// Automate user associated with the profile.
	Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner,omitempty"`
	// Name of the profile.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Version of the profile.
	Version string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

func (*ProfileDetails) Descriptor deprecated 

func (*ProfileDetails) Descriptor() ([]byte, []int)

Deprecated: Use ProfileDetails.ProtoReflect.Descriptor instead.

func (*ProfileDetails) GetName 

func (x *ProfileDetails) GetName() string

func (*ProfileDetails) GetOwner 

func (x *ProfileDetails) GetOwner() string

func (*ProfileDetails) GetVersion 

func (x *ProfileDetails) GetVersion() string

func (*ProfileDetails) ProtoMessage 

func (*ProfileDetails) ProtoMessage()

func (*ProfileDetails) ProtoReflect 

func (x *ProfileDetails) ProtoReflect() protoreflect.Message

func (*ProfileDetails) Reset 

func (x *ProfileDetails) Reset()

func (*ProfileDetails) String 

func (x *ProfileDetails) String() string

type ProfilePostRequest 

type ProfilePostRequest struct {

	// Associate an automate user with a profile. A profile is visible only to its associated user.
	Owner string `protobuf:"bytes,5,opt,name=owner,proto3" json:"owner,omitempty"`
	// Intentionally blank.
	Chunk *Chunk `protobuf:"bytes,2,opt,name=chunk,proto3" json:"chunk,omitempty"`
	// Intentionally blank.
	Meta *Metadata `protobuf:"bytes,3,opt,name=meta,proto3" json:"meta,omitempty"`
	// contains filtered or unexported fields
}

func (*ProfilePostRequest) Descriptor deprecated 

func (*ProfilePostRequest) Descriptor() ([]byte, []int)

Deprecated: Use ProfilePostRequest.ProtoReflect.Descriptor instead.

func (*ProfilePostRequest) GetChunk 

func (x *ProfilePostRequest) GetChunk() *Chunk

func (*ProfilePostRequest) GetMeta 

func (x *ProfilePostRequest) GetMeta() *Metadata

func (*ProfilePostRequest) GetOwner 

func (x *ProfilePostRequest) GetOwner() string

func (*ProfilePostRequest) ProtoMessage 

func (*ProfilePostRequest) ProtoMessage()

func (*ProfilePostRequest) ProtoReflect 

func (x *ProfilePostRequest) ProtoReflect() protoreflect.Message

func (*ProfilePostRequest) Reset 

func (x *ProfilePostRequest) Reset()

func (*ProfilePostRequest) String 

func (x *ProfilePostRequest) String() string

type Profiles 

type Profiles struct {

	// List of profiles matching the query.
	Profiles []*Profile `protobuf:"bytes,1,rep,name=profiles,proto3" json:"profiles,omitempty"`
	// Total count of profiles matching the query.
	Total int32 `protobuf:"varint,20,opt,name=total,proto3" json:"total,omitempty"`
	// contains filtered or unexported fields
}

func (*Profiles) Descriptor deprecated 

func (*Profiles) Descriptor() ([]byte, []int)

Deprecated: Use Profiles.ProtoReflect.Descriptor instead.

func (*Profiles) GetProfiles 

func (x *Profiles) GetProfiles() []*Profile

func (*Profiles) GetTotal 

func (x *Profiles) GetTotal() int32

func (*Profiles) ProtoMessage 

func (*Profiles) ProtoMessage()

func (*Profiles) ProtoReflect 

func (x *Profiles) ProtoReflect() protoreflect.Message

func (*Profiles) Reset 

func (x *Profiles) Reset()

func (*Profiles) String 

func (x *Profiles) String() string

type ProfilesServiceClient 

type ProfilesServiceClient interface {
	// grpc gateway is not able to handle multi-part upload; https://github.com/grpc-ecosystem/grpc-gateway/issues/410
	// so we do not auto-generate the route for profile upload; we instead custom handle with mux
	Create(ctx context.Context, opts ...grpc.CallOption) (ProfilesService_CreateClient, error)
	// Show an installed profile
	//
	// Show the details of an installed profile given the profile name, owner (Automate user associated with the profile), and version.
	//
	// Authorization Action:
	// “`
	// “`
	//
	//compliance:profiles:get
	Read(ctx context.Context, in *ProfileDetails, opts ...grpc.CallOption) (*Profile, error)
	// Show an available profile
	//
	// Show the details of an un-installed profile using the profile name and version.
	// in the UI, these are the profiles under the "Available" tab.
	// These profiles are created and maintained by Chef, shipped with Chef Automate.
	//
	// Authorization Action:
	// “`
	// “`
	//
	//compliance:marketProfiles:get
	ReadFromMarket(ctx context.Context, in *ProfileDetails, opts ...grpc.CallOption) (*Profile, error)
	// grpc gateway is not able to handle streaming; https://github.com/grpc-ecosystem/grpc-gateway/issues/435
	// so we do not auto-generate the route for profile download; we instead custom handle with mux
	ReadTar(ctx context.Context, in *ProfileDetails, opts ...grpc.CallOption) (ProfilesService_ReadTarClient, error)
	// Delete an installed profile
	//
	// Delete an installed profile given the profile name, owner (Automate user associated with the profile), and version.
	// Note: this action "uninstalls" the profile. This has no impact on the market profiles.
	//
	// Authorization Action:
	// “`
	// “`
	//
	//compliance:profiles:delete
	Delete(ctx context.Context, in *ProfileDetails, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// List all available profiles
	//
	// Lists all profiles available for the Automate instance.
	// Empty params return all "market" profiles.
	// Specifying the `owner` field returns all profiles installed for the specified user.
	//
	// Supports pagination, sorting, and filtering (wildcard supported).
	//
	// Supported sort fields: title, name (default: title)
	// Supported filter fields: name, version, title
	//
	// Example:
	// “`
	// {
	// "filters":[
	// {"type": "title", "values": [ "Dev*"]}
	// ],
	// "page": 1,
	// "per_page": 3,
	// "owner": "admin"
	// }
	// “`
	//
	// Authorization Action:
	// “`
	// “`
	//
	//compliance:profiles:list
	List(ctx context.Context, in *Query, opts ...grpc.CallOption) (*Profiles, error)
	// Check if one or multiple profiles exist in the metadata database.
	//
	// The endpoint takes an array of compliance profile sha256 IDs and returns the ones that the backend
	// doesn't have metadata (profile title, copyright, controls title, code, tags, etc) for.
	// This is useful when deciding if a compliance report can be sent for ingestion without the associated profile metadata.
	//
	// Authorization Action:
	// “`
	// “`
	//
	//compliance:profiles:list
	MetaSearch(ctx context.Context, in *Sha256, opts ...grpc.CallOption) (*Missing, error)
}

ProfilesServiceClient is the client API for ProfilesService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewProfilesServiceClient 

func NewProfilesServiceClient(cc grpc.ClientConnInterface) ProfilesServiceClient

type ProfilesServiceServer 

type ProfilesServiceServer interface {
	// grpc gateway is not able to handle multi-part upload; https://github.com/grpc-ecosystem/grpc-gateway/issues/410
	// so we do not auto-generate the route for profile upload; we instead custom handle with mux
	Create(ProfilesService_CreateServer) error
	// Show an installed profile
	//
	// Show the details of an installed profile given the profile name, owner (Automate user associated with the profile), and version.
	//
	// Authorization Action:
	// “`
	// “`
	//
	//compliance:profiles:get
	Read(context.Context, *ProfileDetails) (*Profile, error)
	// Show an available profile
	//
	// Show the details of an un-installed profile using the profile name and version.
	// in the UI, these are the profiles under the "Available" tab.
	// These profiles are created and maintained by Chef, shipped with Chef Automate.
	//
	// Authorization Action:
	// “`
	// “`
	//
	//compliance:marketProfiles:get
	ReadFromMarket(context.Context, *ProfileDetails) (*Profile, error)
	// grpc gateway is not able to handle streaming; https://github.com/grpc-ecosystem/grpc-gateway/issues/435
	// so we do not auto-generate the route for profile download; we instead custom handle with mux
	ReadTar(*ProfileDetails, ProfilesService_ReadTarServer) error
	// Delete an installed profile
	//
	// Delete an installed profile given the profile name, owner (Automate user associated with the profile), and version.
	// Note: this action "uninstalls" the profile. This has no impact on the market profiles.
	//
	// Authorization Action:
	// “`
	// “`
	//
	//compliance:profiles:delete
	Delete(context.Context, *ProfileDetails) (*emptypb.Empty, error)
	// List all available profiles
	//
	// Lists all profiles available for the Automate instance.
	// Empty params return all "market" profiles.
	// Specifying the `owner` field returns all profiles installed for the specified user.
	//
	// Supports pagination, sorting, and filtering (wildcard supported).
	//
	// Supported sort fields: title, name (default: title)
	// Supported filter fields: name, version, title
	//
	// Example:
	// “`
	// {
	// "filters":[
	// {"type": "title", "values": [ "Dev*"]}
	// ],
	// "page": 1,
	// "per_page": 3,
	// "owner": "admin"
	// }
	// “`
	//
	// Authorization Action:
	// “`
	// “`
	//
	//compliance:profiles:list
	List(context.Context, *Query) (*Profiles, error)
	// Check if one or multiple profiles exist in the metadata database.
	//
	// The endpoint takes an array of compliance profile sha256 IDs and returns the ones that the backend
	// doesn't have metadata (profile title, copyright, controls title, code, tags, etc) for.
	// This is useful when deciding if a compliance report can be sent for ingestion without the associated profile metadata.
	//
	// Authorization Action:
	// “`
	// “`
	//
	//compliance:profiles:list
	MetaSearch(context.Context, *Sha256) (*Missing, error)
}

ProfilesServiceServer is the server API for ProfilesService service.

type ProfilesService_CreateClient 

type ProfilesService_CreateClient interface {
	Send(*ProfilePostRequest) error
	CloseAndRecv() (*CheckResult, error)
	grpc.ClientStream
}

type ProfilesService_CreateServer 

type ProfilesService_CreateServer interface {
	SendAndClose(*CheckResult) error
	Recv() (*ProfilePostRequest, error)
	grpc.ServerStream
}

type ProfilesService_ReadTarClient 

type ProfilesService_ReadTarClient interface {
	Recv() (*ProfileData, error)
	grpc.ClientStream
}

type ProfilesService_ReadTarServer 

type ProfilesService_ReadTarServer interface {
	Send(*ProfileData) error
	grpc.ServerStream
}

type Query 

type Query struct {

	// Filters to apply to the query
	Filters []*ListFilter `protobuf:"bytes,20,rep,name=filters,proto3" json:"filters,omitempty"`
	// Order in which to sort. Defaults to ASC.
	Order Query_OrderType `` /* 127-byte string literal not displayed */
	// Field on which to sort.
	Sort string `protobuf:"bytes,22,opt,name=sort,proto3" json:"sort,omitempty"`
	// Page of results requested.
	Page int32 `protobuf:"varint,23,opt,name=page,proto3" json:"page,omitempty"`
	// Number of results to return per page.
	PerPage int32 `protobuf:"varint,24,opt,name=per_page,json=perPage,proto3" json:"per_page,omitempty"`
	// Automate user associated with the profile.
	Owner string `protobuf:"bytes,25,opt,name=owner,proto3" json:"owner,omitempty"`
	// Name of the profile (as defined in `inspec.yml`).
	Name string `protobuf:"bytes,26,opt,name=name,proto3" json:"name,omitempty"`
	// Version of the profile (as defined in `inspec.yml`).
	Version string `protobuf:"bytes,27,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

func (*Query) Descriptor deprecated 

func (*Query) Descriptor() ([]byte, []int)

Deprecated: Use Query.ProtoReflect.Descriptor instead.

func (*Query) GetFilters 

func (x *Query) GetFilters() []*ListFilter

func (*Query) GetName 

func (x *Query) GetName() string

func (*Query) GetOrder 

func (x *Query) GetOrder() Query_OrderType

func (*Query) GetOwner 

func (x *Query) GetOwner() string

func (*Query) GetPage 

func (x *Query) GetPage() int32

func (*Query) GetPerPage 

func (x *Query) GetPerPage() int32

func (*Query) GetSort 

func (x *Query) GetSort() string

func (*Query) GetVersion 

func (x *Query) GetVersion() string

func (*Query) ProtoMessage 

func (*Query) ProtoMessage()

func (*Query) ProtoReflect 

func (x *Query) ProtoReflect() protoreflect.Message

func (*Query) Reset 

func (x *Query) Reset()

func (*Query) String 

func (x *Query) String() string

type Query_OrderType 

type Query_OrderType int32
const (
	Query_ASC  Query_OrderType = 0
	Query_DESC Query_OrderType = 1
)

func (Query_OrderType) Descriptor 

func (Query_OrderType) Descriptor() protoreflect.EnumDescriptor

func (Query_OrderType) Enum 

func (x Query_OrderType) Enum() *Query_OrderType

func (Query_OrderType) EnumDescriptor deprecated 

func (Query_OrderType) EnumDescriptor() ([]byte, []int)

Deprecated: Use Query_OrderType.Descriptor instead.

func (Query_OrderType) Number 

func (x Query_OrderType) Number() protoreflect.EnumNumber

func (Query_OrderType) String 

func (x Query_OrderType) String() string

func (Query_OrderType) Type 

func (Query_OrderType) Type() protoreflect.EnumType

type Ref 

type Ref struct {

	// URL of the ref.
	Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	// Ref for the control.
	Ref string `protobuf:"bytes,2,opt,name=ref,proto3" json:"ref,omitempty"`
	// contains filtered or unexported fields
}

func (*Ref) Descriptor deprecated 

func (*Ref) Descriptor() ([]byte, []int)

Deprecated: Use Ref.ProtoReflect.Descriptor instead.

func (*Ref) GetRef 

func (x *Ref) GetRef() string

func (*Ref) GetUrl 

func (x *Ref) GetUrl() string

func (*Ref) ProtoMessage 

func (*Ref) ProtoMessage()

func (*Ref) ProtoReflect 

func (x *Ref) ProtoReflect() protoreflect.Message

func (*Ref) Reset 

func (x *Ref) Reset()

func (*Ref) String 

func (x *Ref) String() string

type Result 

type Result struct {

	// Status of the test results (passed, failed, skipped).
	Status string `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// The code (test) executed.
	CodeDesc string `protobuf:"bytes,2,opt,name=code_desc,json=codeDesc,proto3" json:"code_desc,omitempty"`
	// The amount of time it took to execute the test.
	RunTime float32 `protobuf:"fixed32,3,opt,name=run_time,json=runTime,proto3" json:"run_time,omitempty"`
	// The time the test started.
	StartTime string `protobuf:"bytes,4,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// The failure message.
	Message string `protobuf:"bytes,5,opt,name=message,proto3" json:"message,omitempty"`
	// Reason for skipping the test.
	SkipMessage string `protobuf:"bytes,6,opt,name=skip_message,json=skipMessage,proto3" json:"skip_message,omitempty"`
	// contains filtered or unexported fields
}

func (*Result) Descriptor deprecated 

func (*Result) Descriptor() ([]byte, []int)

Deprecated: Use Result.ProtoReflect.Descriptor instead.

func (*Result) GetCodeDesc 

func (x *Result) GetCodeDesc() string

func (*Result) GetMessage 

func (x *Result) GetMessage() string

func (*Result) GetRunTime 

func (x *Result) GetRunTime() float32

func (*Result) GetSkipMessage 

func (x *Result) GetSkipMessage() string

func (*Result) GetStartTime 

func (x *Result) GetStartTime() string

func (*Result) GetStatus 

func (x *Result) GetStatus() string

func (*Result) ProtoMessage 

func (*Result) ProtoMessage()

func (*Result) ProtoReflect 

func (x *Result) ProtoReflect() protoreflect.Message

func (*Result) Reset 

func (x *Result) Reset()

func (*Result) String 

func (x *Result) String() string

type ResultSummary 

type ResultSummary struct {

	// Boolean that denotes if the profile is valid or not (as reported by `inspec check`).
	Valid bool `protobuf:"varint,1,opt,name=valid,proto3" json:"valid,omitempty"`
	// Timestamp of when the `inspec check` command was executed.
	Timestamp string `protobuf:"bytes,2,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// Path of the checked profile.
	Location string `protobuf:"bytes,3,opt,name=location,proto3" json:"location,omitempty"`
	// Count of controls in the profile.
	Controls int32 `protobuf:"varint,4,opt,name=controls,proto3" json:"controls,omitempty"`
	// contains filtered or unexported fields
}

func (*ResultSummary) Descriptor deprecated 

func (*ResultSummary) Descriptor() ([]byte, []int)

Deprecated: Use ResultSummary.ProtoReflect.Descriptor instead.

func (*ResultSummary) GetControls 

func (x *ResultSummary) GetControls() int32

func (*ResultSummary) GetLocation 

func (x *ResultSummary) GetLocation() string

func (*ResultSummary) GetTimestamp 

func (x *ResultSummary) GetTimestamp() string

func (*ResultSummary) GetValid 

func (x *ResultSummary) GetValid() bool

func (*ResultSummary) ProtoMessage 

func (*ResultSummary) ProtoMessage()

func (*ResultSummary) ProtoReflect 

func (x *ResultSummary) ProtoReflect() protoreflect.Message

func (*ResultSummary) Reset 

func (x *ResultSummary) Reset()

func (*ResultSummary) String 

func (x *ResultSummary) String() string

type Sha256 

type Sha256 struct {

	// An array of profile sha256 IDs.
	Sha256 []string `protobuf:"bytes,1,rep,name=sha256,proto3" json:"sha256,omitempty"`
	// contains filtered or unexported fields
}

func (*Sha256) Descriptor deprecated 

func (*Sha256) Descriptor() ([]byte, []int)

Deprecated: Use Sha256.ProtoReflect.Descriptor instead.

func (*Sha256) GetSha256 

func (x *Sha256) GetSha256() []string

func (*Sha256) ProtoMessage 

func (*Sha256) ProtoMessage()

func (*Sha256) ProtoReflect 

func (x *Sha256) ProtoReflect() protoreflect.Message

func (*Sha256) Reset 

func (x *Sha256) Reset()

func (*Sha256) String 

func (x *Sha256) String() string

type SourceLocation 

type SourceLocation struct {
	Ref  string `protobuf:"bytes,1,opt,name=ref,proto3" json:"ref,omitempty"`
	Line int32  `protobuf:"varint,2,opt,name=line,proto3" json:"line,omitempty"`
	// contains filtered or unexported fields
}

func (*SourceLocation) Descriptor deprecated 

func (*SourceLocation) Descriptor() ([]byte, []int)

Deprecated: Use SourceLocation.ProtoReflect.Descriptor instead.

func (*SourceLocation) GetLine 

func (x *SourceLocation) GetLine() int32

func (*SourceLocation) GetRef 

func (x *SourceLocation) GetRef() string

func (*SourceLocation) ProtoMessage 

func (*SourceLocation) ProtoMessage()

func (*SourceLocation) ProtoReflect 

func (x *SourceLocation) ProtoReflect() protoreflect.Message

func (*SourceLocation) Reset 

func (x *SourceLocation) Reset()

func (*SourceLocation) String 

func (x *SourceLocation) String() string

type Support 

type Support struct {

	// OS name supported by the profile.
	OsName string `protobuf:"bytes,1,opt,name=os_name,json=osName,proto3" json:"os_name,omitempty"`
	// OS family supported by the profile.
	OsFamily string `protobuf:"bytes,2,opt,name=os_family,json=osFamily,proto3" json:"os_family,omitempty"`
	// OS release supported by the profile.
	Release string `protobuf:"bytes,3,opt,name=release,proto3" json:"release,omitempty"`
	// Minimum InSpec version required for the profile.
	InspecVersion string `protobuf:"bytes,4,opt,name=inspec_version,json=inspecVersion,proto3" json:"inspec_version,omitempty"`
	// Platform supported by the profile.
	Platform string `protobuf:"bytes,5,opt,name=platform,proto3" json:"platform,omitempty"`
	// contains filtered or unexported fields
}

func (*Support) Descriptor deprecated 

func (*Support) Descriptor() ([]byte, []int)

Deprecated: Use Support.ProtoReflect.Descriptor instead.

func (*Support) GetInspecVersion 

func (x *Support) GetInspecVersion() string

func (*Support) GetOsFamily 

func (x *Support) GetOsFamily() string

func (*Support) GetOsName 

func (x *Support) GetOsName() string

func (*Support) GetPlatform 

func (x *Support) GetPlatform() string

func (*Support) GetRelease 

func (x *Support) GetRelease() string

func (*Support) ProtoMessage 

func (*Support) ProtoMessage()

func (*Support) ProtoReflect 

func (x *Support) ProtoReflect() protoreflect.Message

func (*Support) Reset 

func (x *Support) Reset()

func (*Support) String 

func (x *Support) String() string

type UnimplementedProfilesServiceServer 

type UnimplementedProfilesServiceServer struct {
}

UnimplementedProfilesServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedProfilesServiceServer) Create 

func (*UnimplementedProfilesServiceServer) Create(ProfilesService_CreateServer) error

func (*UnimplementedProfilesServiceServer) Delete 

func (*UnimplementedProfilesServiceServer) Delete(context.Context, *ProfileDetails) (*emptypb.Empty, error)

func (*UnimplementedProfilesServiceServer) List 

func (*UnimplementedProfilesServiceServer) List(context.Context, *Query) (*Profiles, error)

func (*UnimplementedProfilesServiceServer) MetaSearch 

func (*UnimplementedProfilesServiceServer) MetaSearch(context.Context, *Sha256) (*Missing, error)

func (*UnimplementedProfilesServiceServer) Read 

func (*UnimplementedProfilesServiceServer) Read(context.Context, *ProfileDetails) (*Profile, error)

func (*UnimplementedProfilesServiceServer) ReadFromMarket 

func (*UnimplementedProfilesServiceServer) ReadFromMarket(context.Context, *ProfileDetails) (*Profile, error)

func (*UnimplementedProfilesServiceServer) ReadTar 

func (*UnimplementedProfilesServiceServer) ReadTar(*ProfileDetails, ProfilesService_ReadTarServer) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.