package envoy.extensions.wasm.v3

Get desktop application:
View/edit binary Protocol Buffers messages

Configuration for restricting Proxy-Wasm capabilities available to modules.

Used in: PluginConfig

• map<string, SanitizationConfig> allowed_capabilities = 1

  The Proxy-Wasm capabilities which will be allowed. Capabilities are mapped by name. The ``SanitizationConfig`` which each capability maps to is currently unimplemented and ignored, and so should be left empty. The capability names are given in the `Proxy-Wasm ABI <https://github.com/proxy-wasm/spec/tree/master/abi-versions/vNEXT>`_. Additionally, the following WASI capabilities from `this list <https://github.com/WebAssembly/WASI/blob/master/phases/snapshot/docs.md#modules>`_ are implemented and can be allowed: ``fd_write``, ``fd_read``, ``fd_seek``, ``fd_close``, ``fd_fdstat_get``, ``environ_get``, ``environ_sizes_get``, ``args_get``, ``args_sizes_get``, ``proc_exit``, ``clock_time_get``, ``random_get``.

Used in: VmConfig

• repeated string host_env_keys = 1

  The keys of *Envoy's* environment variables exposed to this VM. In other words, if a key exists in Envoy's environment variables, then that key-value pair will be injected. Note that if a key does not exist, it will be ignored.

• map<string, string> key_values = 2

  Explicitly given key-value pairs to be injected to this VM in the form of "KEY=VALUE".

If there is a fatal error on the VM (e.g. exception, abort()), then the policy will be applied.

Used in: PluginConfig

• UNSPECIFIED = 0

  No policy is specified. The default policy will be used. The default policy is ``FAIL_CLOSED``.

• FAIL_RELOAD = 1

  New plugin instance will be created for the new request if the VM is failed. Note this only be applied to the following failures: * ``proxy_wasm::FailState::RuntimeError`` This will fallback to the ``FAIL_CLOSED`` for all other failures.

• FAIL_CLOSED = 2

  All plugins associated with the VM will return an HTTP 503 error.

• FAIL_OPEN = 3

  All plugins associated with the VM will be ignored and the filter chain will continue. This makes sense when the plugin is optional.

Base Configuration for Wasm Plugins e.g. filters and services. [#next-free-field: 9]

Used in: access_loggers.wasm.v3.WasmAccessLog, filters.http.wasm.v3.Wasm, filters.network.wasm.v3.Wasm, stat_sinks.wasm.v3.Wasm, WasmService

• string name = 1

  A unique name for a filters/services in a VM for use in identifying the filter/service if multiple filters/services are handled by the same ``vm_id`` and ``root_id`` and for logging/debugging.

• string root_id = 2

  A unique ID for a set of filters/services in a VM which will share a RootContext and Contexts if applicable (e.g. an Wasm HttpFilter and an Wasm AccessLog). If left blank, all filters/services with a blank root_id with the same ``vm_id`` will share Context(s).

• oneof vm

  Configuration for finding or starting VM.

  • VmConfig vm_config = 3

    TODO: add referential VM configurations.

• optional google.protobuf.Any configuration = 4

  Filter/service configuration used to configure or reconfigure a plugin (``proxy_on_configure``). ``google.protobuf.Struct`` is serialized as JSON before passing it to the plugin. ``google.protobuf.BytesValue`` and ``google.protobuf.StringValue`` are passed directly without the wrapper.

• bool fail_open = 5

  If there is a fatal error on the VM (e.g. exception, abort(), on_start or on_configure return false), then all plugins associated with the VM will either fail closed (by default), e.g. by returning an HTTP 503 error, or fail open (if 'fail_open' is set to true) by bypassing the filter. Note: when on_start or on_configure return false during xDS updates the xDS configuration will be rejected and when on_start or on_configuration return false on initial startup the proxy will not start. This field is deprecated in favor of the ``failure_policy`` field.

• FailurePolicy failure_policy = 7

  The failure policy for the plugin.

• optional ReloadConfig reload_config = 8

  Reload configuration. This is only applied when ``failure_policy`` is set to ``FAIL_RELOAD``.

• optional CapabilityRestrictionConfig capability_restriction_config = 6

  Configuration for restricting Proxy-Wasm capabilities available to modules.

Used in: PluginConfig

• optional config.core.v3.BackoffStrategy backoff = 1

  Backoff strategy for the VM failure reload. If not specified, the default 1s base interval will be applied.

Configuration for sanitization of inputs to an allowed capability. NOTE: This is currently unimplemented.

Used in: CapabilityRestrictionConfig

(message has no fields)

Configuration for a Wasm VM. [#next-free-field: 8]

Used in: PluginConfig

• string vm_id = 1

  An ID which will be used along with a hash of the wasm code (or the name of the registered Null VM plugin) to determine which VM will be used for the plugin. All plugins which use the same ``vm_id`` and code will use the same VM. May be left blank. Sharing a VM between plugins can reduce memory utilization and make sharing of data easier which may have security implications. [#comment: TODO: add ref for details.]

• string runtime = 2

  The Wasm runtime type, defaults to the first available Wasm engine used at Envoy build-time. The priority to search for the available engine is: v8 -> wasmtime -> wamr. Available Wasm runtime types are registered as extensions. The following runtimes are included in Envoy code base: .. _extension_envoy.wasm.runtime.null: **envoy.wasm.runtime.null**: Null sandbox, the Wasm module must be compiled and linked into the Envoy binary. The registered name is given in the ``code`` field as ``inline_string``. .. _extension_envoy.wasm.runtime.v8: **envoy.wasm.runtime.v8**: `V8 <https://v8.dev/>`_-based WebAssembly runtime. .. _extension_envoy.wasm.runtime.wamr: **envoy.wasm.runtime.wamr**: `WAMR <https://github.com/bytecodealliance/wasm-micro-runtime/>`_-based WebAssembly runtime. This runtime is not enabled in the official build. .. _extension_envoy.wasm.runtime.wasmtime: **envoy.wasm.runtime.wasmtime**: `Wasmtime <https://wasmtime.dev/>`_-based WebAssembly runtime. This runtime is not enabled in the official build. [#extension-category: envoy.wasm.runtime]

• optional config.core.v3.AsyncDataSource code = 3

  The Wasm code that Envoy will execute.

• optional google.protobuf.Any configuration = 4

  The Wasm configuration used in initialization of a new VM (proxy_on_start). ``google.protobuf.Struct`` is serialized as JSON before passing it to the plugin. ``google.protobuf.BytesValue`` and ``google.protobuf.StringValue`` are passed directly without the wrapper.

• bool allow_precompiled = 5

  Allow the wasm file to include pre-compiled code on VMs which support it. Warning: this should only be enable for trusted sources as the precompiled code is not verified.

• bool nack_on_code_cache_miss = 6

  If true and the code needs to be remotely fetched and it is not in the cache then NACK the configuration update and do a background fetch to fill the cache, otherwise fetch the code asynchronously and enter warming state.

• optional EnvironmentVariables environment_variables = 7

  Specifies environment variables to be injected to this VM which will be available through WASI's ``environ_get`` and ``environ_get_sizes`` system calls. Note that these functions are generally called implicitly by your language's standard library. Therefore, you do not need to call them directly. You can access environment variables in the same way you would on native platforms. Warning: Envoy rejects the configuration if there's conflict of key space.

WasmService is configured as a built-in ``envoy.wasm_service`` :ref:`WasmService <config_wasm_service>` This opaque configuration will be used to create a Wasm Service.

• optional PluginConfig config = 1

  General plugin configuration.

• bool singleton = 2

  If true, create a single VM rather than creating one VM per worker. Such a singleton can not be used with filters.