package cnquery.providers.v1

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Collect (DataRes, CollectRes)

  plugin.proto:110

  message CollectRes

  plugin.proto:63

  (message has no fields)

• rpc GetRecording (DataReq, ResourceData)

  plugin.proto:111

• rpc GetData (DataReq, DataRes)

  plugin.proto:112

• rpc Heartbeat (HeartbeatReq, HeartbeatRes)

  plugin.proto:99

  message HeartbeatReq

  plugin.proto:82

  • uint64 interval = 1

    interval in nanoseconds until the next heartbeat occurs

  message HeartbeatRes

  plugin.proto:86

  (message has no fields)

• rpc ParseCLI (ParseCLIReq, ParseCLIRes)

  plugin.proto:100

  message ParseCLIReq

  plugin.proto:13

  • string connector = 1

  • repeated string args = 2

  • map<string, llx.Primitive> flags = 3

  message ParseCLIRes

  plugin.proto:19

  • optional Asset asset = 1

    inventory after parsing of CLI; no connection, no discovery, no resolution

• rpc Connect (ConnectReq, ConnectRes)

  plugin.proto:101

• rpc Disconnect (DisconnectReq, DisconnectRes)

  plugin.proto:102

  message DisconnectReq

  plugin.proto:90

  • uint32 connection = 1

  message DisconnectRes

  plugin.proto:94

  (message has no fields)

• rpc MockConnect (ConnectReq, ConnectRes)

  plugin.proto:103

• rpc Shutdown (ShutdownReq, ShutdownRes)

  plugin.proto:104

  message ShutdownReq

  plugin.proto:42

  (message has no fields)

  message ShutdownRes

  plugin.proto:45

  (message has no fields)

• rpc GetData (DataReq, DataRes)

  plugin.proto:105

• rpc StoreData (StoreReq, StoreRes)

  plugin.proto:106

  message StoreReq

  plugin.proto:67

  • uint32 connection = 1

  • repeated ResourceData resources = 2

  message StoreRes

  plugin.proto:78

  (message has no fields)

• rpc About (Empty, VaultInfo)

  vault.proto:21

  message Empty

  vault.proto:67

  (message has no fields)

  message VaultInfo

  vault.proto:71

  • string name = 1

• rpc Get (SecretID, Secret)

  vault.proto:22

• rpc Set (Secret, SecretID)

  vault.proto:23

Used in: explorer.SynchronizeAssetsReq, ConnectReq, ConnectRes, InventorySpec, ParseCLIRes

• string id = 1

• string mrn = 2

• string name = 3

• repeated string platform_ids = 4

  3rd-party platform id eg. amazon arn, gcp resource name or ssh host key

• State state = 5

  asset state

• optional Platform platform = 6

• repeated Config connections = 17

  key is a lower case string of connection type

• map<string, string> labels = 18

  labeled assets can be searched by labels

• map<string, string> annotations = 19

  additional information that is not touched by the system

• map<string, string> options = 20

  additional options for that asset

• repeated string id_detector = 31

  platform id detection mechanisms protolint:disable:next REPEATED_FIELD_NAMES_PLURALIZED

• AssetCategory category = 32

  indicator is this is an inventory object or a CI/CD run

• repeated Asset related_assets = 33

• string managed_by = 34

• string url = 35

  optional url that can be used to access the asset via a browser

• string kind_string = 36

• string fqdn = 37

• string trace_id = 38

Used in: Asset

• CATEGORY_INVENTORY = 0

  protolint:disable:next ENUM_FIELD_NAMES_ZERO_VALUE_END_WITH protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• CATEGORY_CICD = 1

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

AssetUrlBranch defines the hierarchy into which an asset can be placed. It makes it easier to find and group assets. Typically this is a subset of all possible asset relationships used to generate an opinionated view on an asset. AssetUrlBranches are part of the overall AssetUrlSchema, to which they are attached.

• repeated string path_segments = 1

  The path to which this tree is getting attached. Only necessary for the top-most branches, not necessary for branches inside the values field.

• string key = 2

  key of this tree. Every tree must have one key only at its root. Must be [a-z0-9_-]+ up to 100 characters

• map<string, AssetUrlBranch> values = 3

  values of this tree. Other trees can attach themselves into this without overwriting existing values. Must be [A-Za-z0-9_-]+ up to 200 characters The special value '*' is used to designate arbitrary values.

• string title = 4

  title for pretty-printing this branch

• repeated string references = 5

  reference to other subtree that will be used at this position. Allows providers to re-use url parts from other definitions. For example: attaching the /technology=os subtree to cloud VMs

• uint32 depth = 20

  internal only: depth of the subtree

• optional AssetUrlBranch parent = 21

  internal only: parent relationships

• string parent_value = 22

  internal only: how this branch is connected in the parent's value field

Used in: Asset

• ProviderType backend = 28

  FIXME: DEPRECATED, remove in v10.0 (or later) vv This is replaced by type. We use a different number here so it doesn't conflict with the old "backend" while allowing us to load the field from yaml.

• DeprecatedV8_Kind kind = 24

  ^^

• string host = 2

• int32 port = 3

  Ports are not int by default, eg. docker://centos:latest parses a string as port. Therefore it is up to the provider to convert the port to what they need

• string path = 4

• uint32 id = 5

• uint32 parent_connection_id = 30

• string type = 12

• repeated Credential credentials = 11

  credentials available for this provider configuration

• bool insecure = 8

  disable ssl/tls checks

• optional Sudo sudo = 21

• bool record = 22

• map<string, string> options = 23

• optional Discovery discover = 27

  flags for additional asset discovery

• string runtime = 25

  additional platform information, passed-through

• string platform_id = 26

  configuration to uniquely identify an specific asset for multi-asset connection

• repeated string capabilities = 29

• bool delay_discovery = 31

  Determines whether to delay discovery during the connection phase. Discovery will only happen if Connect is called and this is false

Used as request type in: ProviderPlugin.Connect, ProviderPlugin.MockConnect

• bytes features = 2

• optional Asset asset = 3

  The one primary targeted asset for the connection

• bool has_recording = 20

• uint32 callback_server = 21

• optional mondoo.cnquery.upstream.v1.UpstreamConfig upstream = 22

Used as response type in: ProviderPlugin.Connect, ProviderPlugin.MockConnect

• uint32 id = 1

• string name = 2

• optional Asset asset = 3

  the connected asset with additional information from this connection

• optional Inventory inventory = 4

  inventory of other discovered assets

Credential holds authentication information

Used in: Config, InventorySpec

• string secret_id = 1

• CredentialType type = 2

• string user = 3

• bytes secret = 4

• string password = 21

  for user convenience we define password, this allows yaml/json writers

• string private_key = 22

  for user convenience we define private_key, this allows yaml/json writers to just embed the string representation, otherwise it would need to be base64 encoded

• string private_key_path = 23

  for user convenience we define private_key_path which loads a local file into the secret

• string env = 24

  for user convenience we define env_var name which loads the secret from the variable

protolint:disable:next ENUM_FIELD_NAMES_PREFIX

Used in: Credential

• undefined = 0

  protolint:disable:next ENUM_FIELD_NAMES_ZERO_VALUE_END_WITH protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

• password = 1

  protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

• private_key = 2

  protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

• ssh_agent = 3

  protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

• bearer = 4

  protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

• credentials_query = 5

  protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

• json = 6

  protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

• aws_ec2_instance_connect = 7

  protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

• aws_ec2_ssm_session = 8

  protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

• pkcs12 = 9

  protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

• env = 10

  protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

Used as request type in: ProviderCallback.GetData, ProviderCallback.GetRecording, ProviderPlugin.GetData

• uint32 connection = 1

• string resource = 3

• string resource_id = 4

• string field = 5

• map<string, llx.Primitive> args = 6

Used as request type in: ProviderCallback.Collect

Used as response type in: ProviderCallback.GetData, ProviderPlugin.GetData

• optional llx.Primitive data = 1

• string error = 2

• string id = 3

  The ID uniquely identifies this request and all associated callbacks

protolint:disable:next ENUM_FIELD_NAMES_PREFIX protolint:disable:next ENUM_NAMES_UPPER_CAMEL_CASE

Used in: Config, Platform

• KIND_UNKNOWN = 0

  protolint:disable:next ENUM_FIELD_NAMES_ZERO_VALUE_END_WITH protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• KIND_VIRTUAL_MACHINE_IMAGE = 1

  at rest protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• KIND_CONTAINER_IMAGE = 2

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• KIND_CODE = 3

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• KIND_PACKAGE = 4

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• KIND_VIRTUAL_MACHINE = 5

  in motion protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• KIND_CONTAINER = 6

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• KIND_PROCESS = 7

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• KIND_API = 8

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• KIND_BARE_METAL = 9

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• KIND_NETWORK = 10

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• KIND_K8S_OBJECT = 11

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• KIND_AWS_OBJECT = 12

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• KIND_GCP_OBJECT = 13

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• KIND_AZURE_OBJECT = 14

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

Used in: Config

• repeated string targets = 1

• map<string, string> filter = 2

Inventory declares the all assets and their credentials

Used in: explorer.scan.Job, ConnectRes, proto.RunQueryConfig

• optional ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture /api-conventions.md#metadata

• optional InventorySpec spec = 2

  Specification of the desired behavior of the Inventory.

• optional InventoryStatus status = 3

  Most recently observed status of the Inventory.

Used in: Inventory

• repeated Asset assets = 1

• map<string, Credential> credentials = 2

• optional VaultConfiguration vault = 3

• string credential_query = 4

• optional mondoo.cnquery.upstream.v1.ServiceAccountCredentials upstream_credentials = 16

  optional: the upstream credentials to use for the inventory

Used in: Inventory

(message has no fields)

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Used in: Inventory

• string name = 1

  Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional

• string namespace = 3

  Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces +optional

• map<string, string> labels = 11

  Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels +optional

• map<string, string> annotations = 12

  Annotations is an unstructured key value map stored with a resource that \ may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional

• repeated OwnerReference ownerReferences = 13

  List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. +optional +patchMergeKey=uid +patchStrategy=merge protolint:disable:next FIELD_NAMES_LOWER_SNAKE_CASE

OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field. +structType=atomic

Used in: ObjectMeta

• string apiVersion = 5

  API version of the referent. protolint:disable:next FIELD_NAMES_LOWER_SNAKE_CASE

• string kind = 1

  Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture /api-conventions.md#types-kinds

• string name = 3

  Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

• string uid = 4

  UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

Used in: Asset

• string name = 1

• string arch = 3

• string title = 4

• repeated string family = 5

  protolint:disable:next REPEATED_FIELD_NAMES_PLURALIZED

• string build = 6

• string version = 7

• string kind = 8

• repeated string technology_url_segments = 9

  technology url for this asset, raw version of an AssetUrl

• DeprecatedV8_Kind deprecated_v8_kind = 20

  FIXME: DEPRECATED, remove in v10 vv

  ^^

• string runtime = 21

• map<string, string> labels = 22

  FIXME: DEPRECATED, mark as reserved in v12 (or later) vv

  ^^

• map<string, string> metadata = 23

  Additional platform specific/operating system data

FIXME: DEPRECATED, remove in v10.0 (or later) vv

Used in: Config

• LOCAL_OS = 0

  protolint:disable:next ENUM_FIELD_NAMES_ZERO_VALUE_END_WITH protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• DOCKER_ENGINE_IMAGE = 1

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• DOCKER_ENGINE_CONTAINER = 2

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• SSH = 3

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• WINRM = 4

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• AWS_SSM_RUN_COMMAND = 5

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• CONTAINER_REGISTRY = 6

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• TAR = 7

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• MOCK = 8

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• VSPHERE = 9

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• ARISTAEOS = 10

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• AWS = 12

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• GCP = 13

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• AZURE = 14

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• MS365 = 15

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• IPMI = 16

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• VSPHERE_VM = 17

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• FS = 18

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• K8S = 19

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• EQUINIX_METAL = 20

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• DOCKER = 21

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

  unspecified if this is a container or image

• GITHUB = 22

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• VAGRANT = 23

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• AWS_EC2_EBS = 24

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• GITLAB = 25

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• TERRAFORM = 26

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• HOST = 27

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• UNKNOWN = 28

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• OKTA = 29

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• GOOGLE_WORKSPACE = 30

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• SLACK = 31

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• VCD = 32

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• OCI = 33

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• OPCUA = 34

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

• GCP_COMPUTE_INSTANCE_SNAPSHOT = 35

  protolint:disable:next ENUM_FIELD_NAMES_PREFIX

Used as response type in: ProviderCallback.GetRecording

Used as field type in: StoreReq

• string name = 3

• string id = 4

• map<string, llx.Result> fields = 5

Used as request type in: Vault.Set

Used as response type in: Vault.Get

• string key = 1

• string label = 2

• bytes data = 3

• SecretEncoding encoding = 4

protolint:disable:next ENUM_FIELD_NAMES_PREFIX protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

Used in: Secret

• encoding_undefined = 0

  protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE protolint:disable:next ENUM_FIELD_NAMES_ZERO_VALUE_END_WITH

• encoding_json = 1

  protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

• encoding_proto = 2

  protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

• encoding_binary = 3

  protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

Used as request type in: Vault.Get

Used as response type in: Vault.Set

• string key = 1

Used in: Asset

• STATE_UNKNOWN = 0

  protolint:disable:next ENUM_FIELD_NAMES_ZERO_VALUE_END_WITH

• STATE_ERROR = 1

  eg. permission or io error

• STATE_PENDING = 2

  run time states

• STATE_RUNNING = 3

• STATE_STOPPING = 4

• STATE_STOPPED = 5

• STATE_SHUTDOWN = 6

• STATE_TERMINATED = 7

• STATE_REBOOT = 8

• STATE_ONLINE = 9

  static states

• STATE_OFFLINE = 10

• STATE_DELETED = 11

  the asset is marked as deleted

Used in: Config

• bool active = 1

• string user = 2

• string shell = 3

• string executable = 4

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. +protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

• int64 seconds = 1

  Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

• int32 nanos = 2

  Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.

TypeMeta describes an individual object in an API response or request with strings representing the type of the object and its API schema version. Structures that are versioned or persisted should inline TypeMeta.

• string kind = 1

  Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture /api-conventions.md#types-kinds +optional

• string apiVersion = 2

  APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture /api-conventions.md#resources +optional protolint:disable:next FIELD_NAMES_LOWER_SNAKE_CASE

Used in: InventorySpec

• string name = 1

• VaultType type = 2

• map<string, string> options = 3

protolint:disable:next ENUM_FIELD_NAMES_PREFIX

Used in: VaultConfiguration

• None = 0

  protolint:disable:next ENUM_FIELD_NAMES_ZERO_VALUE_END_WITH protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

• KeyRing = 1

  protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

• LinuxKernelKeyring = 2

  protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

• EncryptedFile = 3

  protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

• HashiCorp = 4

  protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

• GCPSecretsManager = 5

  protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

• AWSSecretsManager = 6

  protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

• AWSParameterStore = 7

  protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

• GCPBerglas = 8

  protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE

• Memory = 9

  protolint:disable:next ENUM_FIELD_NAMES_UPPER_SNAKE_CASE