voc

package
v1.3.8 Latest Latest
Warning

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

Go to latest
Published: Nov 10, 2021 License: Apache-2.0 Imports: 4 Imported by: 5

Documentation

Overview

Package voc contains the vocabulary for Cloud resources and their properties that can be discovered using Clouditor

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ToStruct added in v1.3.4

func ToStruct(r IsCloudResource) (s *structpb.Value, err error)

Types

type ABAC added in v1.3.5

type ABAC struct {
	*Authorization
}

type AccessRestriction added in v1.3.3

type AccessRestriction struct {
	*Authorization
}

type Account added in v1.3.5

type Account struct {
	*CloudResource
}

type AnomalyDetection added in v1.3.7

type AnomalyDetection struct {
	*Auditing
	Output  []ResourceID `json:"output"`
	Enabled bool         `json:"enabled"`
}

type Application added in v1.3.5

type Application struct {
	Functionalities     *[]Functionality `json:"functionalities"`
	Compute             []ResourceID     `json:"compute"`
	ProgrammingLanguage string           `json:"programmingLanguage"`
	TranslationUnits    []string         `json:"translationUnits"`
}

type AtRestEncryption

type AtRestEncryption struct {
	*Confidentiality
	Algorithm string `json:"algorithm"`
	Enabled   bool   `json:"enabled"`
}

func (AtRestEncryption) GetAtRestEncryption added in v1.3.7

func (AtRestEncryption) GetAtRestEncryption() *AtRestEncryption

TODO(all): I (lebogg) think we have to implement the interface for the case of encryption being not enabled?

type Auditing added in v1.3.5

type Auditing struct {
	*SecurityFeature
}

type Authenticity added in v1.3.5

type Authenticity struct {
	*SecurityFeature
}

type Authorization added in v1.3.5

type Authorization struct {
	*SecurityFeature
}

type AutomaticUpdates added in v1.3.7

type AutomaticUpdates struct {
	*Integrity
	Enabled      bool          `json:"enabled"`
	Interval     time.Duration `json:"interval"`
	SecurityOnly bool          `json:"securityOnly"`
}

type Availability added in v1.3.5

type Availability struct {
	*SecurityFeature
}

type Backup added in v1.3.5

type Backup struct {
	*Availability
	Activated bool   `json:"activated"`
	Policy    string `json:"policy"`
}

type BlockStorage added in v1.3.5

type BlockStorage struct {
	*Storage
}

type BootLog added in v1.3.7

type BootLog struct {
	*Log
}

type CICDService added in v1.3.5

type CICDService struct {
	*CloudResource
}

type CertificateBasedAuthentication added in v1.3.5

type CertificateBasedAuthentication struct {
	*Authenticity
}

type CloudResource added in v1.3.5

type CloudResource struct {
	ID           ResourceID `json:"id"`
	Name         string     `json:"name"`
	CreationTime int64      `json:"creationTime"` // is set to 0 if no creation time is available
	// The resource type. It is an array, because a type can be derived from another
	Type        []string          `json:"type"`
	GeoLocation GeoLocation       `json:"geoLocation"`
	Labels      map[string]string `json:"labels"`
}

CloudResource file from Ontology currently not used. How do we merge this file with the 'CloudResource Ontology file'

func (*CloudResource) GetCreationTime added in v1.3.5

func (r *CloudResource) GetCreationTime() *time.Time

func (*CloudResource) GetID added in v1.3.5

func (r *CloudResource) GetID() ResourceID

func (*CloudResource) GetName added in v1.3.5

func (r *CloudResource) GetName() string

func (*CloudResource) GetType added in v1.3.5

func (r *CloudResource) GetType() []string

func (*CloudResource) HasType added in v1.3.5

func (r *CloudResource) HasType(resourceType string) (ok bool)

HasType checks whether the resource has the particular resourceType

type CloudResourceGroup added in v1.3.5

type CloudResourceGroup struct {
	CloudResources *[]CloudResource `json:"cloudResources"`
}

type CloudSDK added in v1.3.5

type CloudSDK struct {
	*Framework
}

type Compute added in v1.3.5

type Compute struct {
	*CloudResource
}

type Confidentiality added in v1.3.5

type Confidentiality struct {
	*SecurityFeature
}

type Container added in v1.3.5

type Container struct {
	*Compute
	Image            []ResourceID `json:"image"`
	NetworkInterface []ResourceID `json:"networkInterface"`
}

type ContainerImage added in v1.3.5

type ContainerImage struct {
	*Image
}

type ContainerOrchestration added in v1.3.5

type ContainerOrchestration struct {
	*CloudResource
	ResourceLogging []ResourceID `json:"resourceLogging"`
	Containers      []ResourceID `json:"containers"`
	ManagementUrl   string       `json:"managementUrl"`
}

type ContainerRegistry added in v1.3.5

type ContainerRegistry struct {
	*CloudResource
}

type CustomerKeyEncryption added in v1.3.5

type CustomerKeyEncryption struct {
	*AtRestEncryption
	KeyUrl string `json:"keyUrl"`
}

func (CustomerKeyEncryption) GetAtRestEncryption added in v1.3.7

func (c CustomerKeyEncryption) GetAtRestEncryption() *AtRestEncryption

type DDoSProtection added in v1.3.5

type DDoSProtection struct {
	*Availability
}

type DatabaseConnect added in v1.3.5

type DatabaseConnect struct {
	*DatabaseOperation
}

type DatabaseOperation added in v1.3.5

type DatabaseOperation struct {
	*Functionality
	Storage         []ResourceID `json:"storage"`
	DatabaseService []ResourceID `json:"databaseService"`
	Calls           []string     `json:"calls"`
}

type DatabaseQuery added in v1.3.5

type DatabaseQuery struct {
	*DatabaseOperation
	Modify bool `json:"modify"`
}

type DatabaseService added in v1.3.5

type DatabaseService struct {
	*NetworkService
	DatabaseStorages []ResourceID `json:"databaseStorages"`
}

type DatabaseStorage added in v1.3.7

type DatabaseStorage struct {
	*Storage
	Parent []ResourceID `json:"parent"`
}

type DeviceProvisioningService added in v1.3.5

type DeviceProvisioningService struct {
	*IoT
}

type DocumentDatabaseService added in v1.3.5

type DocumentDatabaseService struct {
	*DatabaseService
}

type FileStorage added in v1.3.5

type FileStorage struct {
	*Storage
	HttpEndpoint *HttpEndpoint `json:"httpEndpoint"`
}

type Framework added in v1.3.5

type Framework struct {
}

type Function added in v1.3.5

type Function struct {
	*Compute
	RuntimeVersion  string `json:"runtimeVersion"`
	RuntimeLanguage string `json:"runtimeLanguage"`
}

type Functionality added in v1.3.5

type Functionality struct {
}

type GeoLocation

type GeoLocation struct {
	*Availability
	Region string `json:"region"`
}

type HasAtRestEncryption

type HasAtRestEncryption interface {
	GetAtRestEncryption() *AtRestEncryption
}

type HasHttpEndpoint

type HasHttpEndpoint interface {
	GetHttpEndpoint() *HttpEndpoint
}

type HttpClientLibrary added in v1.3.5

type HttpClientLibrary struct {
	*Framework
}

type HttpEndpoint

type HttpEndpoint struct {
	*Functionality
	Authenticity        *Authenticity        `json:"authenticity"`
	TransportEncryption *TransportEncryption `json:"transportEncryption"`
	Url                 string               `json:"url"`
	Method              string               `json:"method"`
	Handler             string               `json:"handler"`
	Path                string               `json:"path"`
}

type HttpRequest added in v1.3.5

type HttpRequest struct {
	*Functionality
	HttpEndpoint *HttpEndpoint `json:"httpEndpoint"`
	Call         string        `json:"call"`
}

type HttpRequestHandler added in v1.3.5

type HttpRequestHandler struct {
	*Functionality
	Application   *Application    `json:"application"`
	HttpEndpoints *[]HttpEndpoint `json:"httpEndpoints"`
	Path          string          `json:"path"`
}

type HttpServer added in v1.3.5

type HttpServer struct {
	*Framework
	HttpRequestHandler *HttpRequestHandler `json:"httpRequestHandler"`
}

type Identity added in v1.3.5

type Identity struct {
	*IdentityManagement
	OTPBasedAuthentication      *OTPBasedAuthentication      `json:"oTPBasedAuthentication"`
	PasswordBasedAuthentication *PasswordBasedAuthentication `json:"passwordBasedAuthentication"`
}

type IdentityManagement added in v1.3.5

type IdentityManagement struct {
	*CloudResource
	Authenticity  *Authenticity  `json:"authenticity"`
	Authorization *Authorization `json:"authorization"`
}

type Image added in v1.3.5

type Image struct {
	*CloudResource
	Application *Application `json:"application"`
}

type Immutability added in v1.3.5

type Immutability struct {
	*Integrity
}

type InfrastructureLogging added in v1.3.5

type InfrastructureLogging struct {
	*Logging
}

type Integrity added in v1.3.5

type Integrity struct {
	*SecurityFeature
}

type IoT added in v1.3.5

type IoT struct {
	*CloudResource
}

type IsCloudResource added in v1.3.5

type IsCloudResource interface {
	GetID() ResourceID
	GetName() string
	GetType() []string
	HasType(string) bool
	GetCreationTime() *time.Time
}

type IsCompute added in v1.3.3

type IsCompute interface {
	IsCloudResource
}

type IsNetwork added in v1.3.5

type IsNetwork interface {
	IsCloudResource
}

type IsStorage

type IsStorage interface {
	IsCloudResource

	HasAtRestEncryption
}

type Job added in v1.3.5

type Job struct {
	*CICDService
}

type JwtBasedAuthentication added in v1.3.7

type JwtBasedAuthentication struct {
	*Authenticity
	Enforced bool `json:"enforced"`
}

type KeyValueDB added in v1.3.5

type KeyValueDB struct {
	*KeyValueDatabaseService
}

type KeyValueDatabaseService added in v1.3.5

type KeyValueDatabaseService struct {
	*DatabaseService
}

type L3Firewall added in v1.3.7

type L3Firewall struct {
	*AccessRestriction
	Inbound         bool   `json:"inbound"`
	RestrictedPorts string `json:"restrictedPorts"`
}

type LoadBalancer added in v1.3.5

type LoadBalancer struct {
	*NetworkService
	AccessRestrictions *[]AccessRestriction `json:"accessRestrictions"`
	HttpEndpoints      *[]HttpEndpoint      `json:"httpEndpoints"`
	NetworkServices    []ResourceID         `json:"networkServices"`
	Url                string               `json:"url"`
}

type Log added in v1.3.3

type Log struct {
	*Auditing
	Output          []ResourceID  `json:"output"`
	Enabled         bool          `json:"enabled"`
	RetentionPeriod time.Duration `json:"retentionPeriod"`
}

type LogOutput added in v1.3.5

type LogOutput struct {
	*Functionality
	Logging []ResourceID `json:"logging"`
	Call    string       `json:"call"`
	Value   string       `json:"value"`
}

type Logger added in v1.3.5

type Logger struct {
	*Framework
}

type Logging added in v1.3.5

type Logging struct {
	*CloudResource
}

type MalwareProtection added in v1.3.7

type MalwareProtection struct {
	*Auditing
	Output  []ResourceID `json:"output"`
	Enabled bool         `json:"enabled"`
}

type ManagedKeyEncryption added in v1.3.5

type ManagedKeyEncryption struct {
	*AtRestEncryption
}

func (ManagedKeyEncryption) GetAtRestEncryption added in v1.3.7

func (m ManagedKeyEncryption) GetAtRestEncryption() *AtRestEncryption

type MessagingHub added in v1.3.5

type MessagingHub struct {
	*IoT
}

type NetworkInterface added in v1.3.5

type NetworkInterface struct {
	*Networking
	NetworkService    []ResourceID       `json:"networkService"`
	AccessRestriction *AccessRestriction `json:"accessRestriction"`
}

type NetworkSecurityGroup added in v1.3.5

type NetworkSecurityGroup struct {
	*Networking
}

type NetworkService added in v1.3.5

type NetworkService struct {
	*Networking
	Compute []ResourceID `json:"compute"`
	Ips     []string     `json:"ips"`
	Ports   []int16      `json:"ports"`
}

type Networking added in v1.3.5

type Networking struct {
	*CloudResource
}

type NoAuthentication added in v1.3.5

type NoAuthentication struct {
	*Authenticity
}

type OSLog added in v1.3.7

type OSLog struct {
	*Log
}

type OTPBasedAuthentication added in v1.3.5

type OTPBasedAuthentication struct {
	*Authenticity
	Activated bool `json:"activated"`
}

type ObjectStorage added in v1.3.5

type ObjectStorage struct {
	*Storage
	HttpEndpoint *HttpEndpoint `json:"httpEndpoint"`
}

type ObjectStorageRequest added in v1.3.5

type ObjectStorageRequest struct {
	*Functionality
	ObjectStorage []ResourceID `json:"objectStorage"`
	Source        string       `json:"source"`
	Type          string       `json:"type"`
}

type PasswordBasedAuthentication added in v1.3.5

type PasswordBasedAuthentication struct {
	*Authenticity
	Activated bool `json:"activated"`
}

type ProxiedEndpoint added in v1.3.5

type ProxiedEndpoint struct {
	*HttpEndpoint
}

type RBAC added in v1.3.5

type RBAC struct {
	*Authorization
	MixedDuties      float32 `json:"mixedDuties"`
	BroadAssignments float32 `json:"broadAssignments"`
}

type RelationalDB added in v1.3.5

type RelationalDB struct {
	*RelationalDatabaseService
}

type RelationalDatabaseService added in v1.3.5

type RelationalDatabaseService struct {
	*DatabaseService
}

type ResourceID added in v1.3.5

type ResourceID string

type ResourceLogging added in v1.3.5

type ResourceLogging struct {
	*Logging
}

type RiskImpact added in v1.3.5

type RiskImpact struct {
	Value float32 `json:"value"`
}

type RoleAssignment added in v1.3.5

type RoleAssignment struct {
	*IdentityManagement
}

type SecurityFeature added in v1.3.5

type SecurityFeature struct {
}

type SingleSignOn added in v1.3.5

type SingleSignOn struct {
	*Authenticity
}

type Storage added in v1.3.5

type Storage struct {
	*CloudResource

	AtRestEncryption HasAtRestEncryption `json:"atRestEncryption"`
}

func (*Storage) GetAtRestEncryption added in v1.3.5

func (s *Storage) GetAtRestEncryption() *HasAtRestEncryption

type TransportEncryption

type TransportEncryption struct {
	*Confidentiality
	Enforced   bool   `json:"enforced"`
	Enabled    bool   `json:"enabled"`
	TlsVersion string `json:"tlsVersion"`
	Algorithm  string `json:"algorithm"`
}

type VMImage added in v1.3.5

type VMImage struct {
	*Image
}

type VirtualMachine added in v1.3.5

type VirtualMachine struct {
	*Compute
	BlockStorage     []ResourceID `json:"blockStorage"`
	NetworkInterface []ResourceID `json:"networkInterface"`
	BootLog          *BootLog     `json:"bootLog"`
	OSLog            *OSLog       `json:"oSLog"`
}

type VirtualNetwork added in v1.3.5

type VirtualNetwork struct {
	*Networking
}

type VirtualSubNetwork added in v1.3.5

type VirtualSubNetwork struct {
	*Networking
}

type WebApplicationFirewall added in v1.3.7

type WebApplicationFirewall struct {
	*AccessRestriction
	Enabled bool `json:"enabled"`
}

type Workflow added in v1.3.5

type Workflow struct {
	*CICDService
}

Source Files

Jump to

Keyboard shortcuts

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