Default package

Get desktop application:
View/edit binary Protocol Buffers messages

`POST /api/v1/audit:` Return a list of modules which match the outcome requirements using the provided checkfile.

• bytes checkfile = 1

  the YAML checkfile (e.g. mod.yaml) bytes

• AuditOutcome outcome = 2

• optional Pagination pagination = 3

The message returned in response to a `AuditModulesRequest`.

• map<int64, bytes> invalid_module_report = 1

  each record contains the ID of the invalid Module which failed the audit, as well as the failure report produced by the validation check (encoded in JSON)

• optional Pagination pagination = 2

• uint64 total = 3

  the full count of results in the database (not the count of this message's `modules`).

• optional Error error = 4

Represents the expected outcome of an AuditModulesRequest. If PASS is provided, then the audit returns modules which conform to the checkfile. If FAIL is provided, then the audit returns modules which do not conform to the checkfile.

Used in: AuditModulesRequest

• PASS = 0

• FAIL = 1

POST /api/v1/plugin:

• string identifier = 1

• string function_name = 2

• bytes input = 3

• optional string hash = 4

  bytes config = 5;

• bytes output = 1

• optional Error error = 2

`PUT /api/v1/module:` Insert a module, extract data from binary. Return the module ID & hash.

• bytes wasm = 1

• map<string, string> metadata = 2

• optional string location = 3

  a valid URL with a scheme prefix e.g. `s3://`, `file://`, `https://`

The message returned in response to a `CreateModuleRequest`.

• int64 module_id = 1

• string hash = 2

• optional Error error = 3

`DELETE /api/v1/module:` Remove a module from the database by its ID. Return the module IDs & hashes.

• repeated int64 module_ids = 1

The message returned in response to a `DeleteModulesRequest`.

• map<int64, string> module_id_hash = 1

• optional Error error = 2

`POST /api/v1/diff:` Return the diff of two modules

• int64 module1 = 1

• int64 module2 = 2

• bool color_terminal = 3

• bool with_context = 4

The message returned in response to `DiffRequest`, contains a text representation of the difference between the two specified modules.

• string diff = 1

• optional Error error = 2

The direction, descending or ascending, of the sort operation.

Used in: Sort

• Desc = 0

• Asc = 1

An error message indicating a problem in the API.

Used in: AuditModulesResponse, CallPluginResponse, CreateModuleResponse, DeleteModulesResponse, DiffResponse, GetModuleGraphResponse, GetModuleResponse, InstallPluginResponse, ListModulesResponse, SearchModulesResponse, UninstallPluginResponse, ValidateModuleResponse

• int32 code = 1

• string message = 2

A function that is defined inside the current module, made available to outside modules / environments.

Used in: Module, SearchModulesRequest

• optional Function func = 1

The field within the Module schema that is used as the sorting dimension.

Used in: Sort

• CreatedAt = 0

• Name = 1

• Size = 2

• Language = 3

• ImportsCount = 4

• ExportsCount = 5

• Sha256 = 6

• Complexity = 7

Contained by an import or export element within a wasm binary.

Used in: Export, Import

• repeated ValType params = 1

• repeated ValType results = 2

• string name = 3

`POST /api/v1/module_graph:` Return a single module_graph.

• int64 module_id = 1

The message returned in response to a `GetModuleGraphRequest`.

• optional ModuleGraph module_graph = 1

• optional Error error = 2

`POST /api/v1/module:` Return a single module.

• int64 module_id = 1

The message returned in response to a `GetModuleRequest`.

• optional Module module = 1

• optional Error error = 2

A function and module namespace that is defined outside of the current module, and referenced & called by the current module.

Used in: Module, SearchModulesRequest

• string module_name = 1

• optional Function func = 2

PUT /api/v1/plugin:

• string identifier = 1

• optional string name = 2

• string location = 3

• bytes wasm = 4

  bytes config = 5;

• string hash = 1

• optional Error error = 2

`POST /api/v1/modules:` Return paginated list of all modules.

• optional Pagination pagination = 1

• optional Sort sort = 2

The message returned in response to a `ListModulesRequest`.

• repeated Module modules = 1

• optional Pagination pagination = 2

• uint64 total = 3

  the full count of results in the database (not the count of this message's `modules`).

• optional Sort sort = 4

• optional Error error = 5

Details about a wasm module, either extracted directly from the binary, or inferred somehow.

Used in: GetModuleResponse, ListModulesResponse, SearchModulesResponse

• int64 id = 1

  ID for this module, generated by the database.

• string hash = 3

  sha256 hash of the modules raw bytes

• repeated Import imports = 4

  function imports called by the module (see: <https://github.com/WebAssembly/design/blob/main/Modules.md#imports)>

• repeated Export exports = 5

  function exports provided by the module (see: <https://github.com/WebAssembly/design/blob/main/Modules.md#exports)>

• uint64 size = 6

  size in bytes of the module

• string location = 7

  path or locator to the module

• SourceLanguage source_language = 8

  programming language used to produce this module

• map<string, string> metadata = 9

  arbitrary metadata provided by the operator of this module

• optional google.protobuf.Timestamp inserted_at = 10

  timestamp when this module was loaded and stored

• repeated string strings = 11

  the interned strings stored in the wasm binary (panic/abort messages, etc.)

• optional uint32 complexity = 13

  the cyclomatic complexity (<https://en.wikipedia.org/wiki/Cyclomatic_complexity>) of the instructions

• optional bytes graph = 14

  the serialized graph in json format

• map<string, string> function_hashes = 15

  function hashes

Details about a wasm module graph

Used in: GetModuleGraphResponse

• int64 id = 1

  ID for this module, generated by the database.

• bytes json_bytes = 2

  the serialized graph in json format

Control/limit the way results are paginated when working with large responses.

Used in: AuditModulesRequest, AuditModulesResponse, ListModulesRequest, ListModulesResponse, SearchModulesRequest, SearchModulesResponse

• uint32 limit = 1

• uint32 offset = 2

`POST /api/v1/search:` Search for modules based on filter params provided (which should be any dimension of the module schema, or string search in any metadata value). Return a paginated list of matching modules.

• optional int64 id = 1

  ID for this module, generated by the database.

• optional string hash = 3

  original name of the binary module file

• repeated Import imports = 4

  function imports called by the module (see: <https://github.com/WebAssembly/design/blob/main/Modules.md#imports>)

• repeated Export exports = 5

  function exports provided by the module (see: <https://github.com/WebAssembly/design/blob/main/Modules.md#exports>)

• optional uint64 min_size = 6

  minimum size in bytes of the module

• optional uint64 max_size = 7

  maximum size in bytes of the module

• optional string location = 8

  optional path or locator to the module (TODO: maybe this is better stored as metadata)

• optional SourceLanguage source_language = 9

  programming language used to produce this module

• map<string, string> metadata = 10

  arbitrary metadata provided by the operator of this module

• optional google.protobuf.Timestamp inserted_before = 11

  timestamp when this module was loaded and stored

• optional google.protobuf.Timestamp inserted_after = 12

  timestamp when this module was loaded and stored

• repeated string strings = 13

  the interned strings stored in the wasm binary (panic/abort messages, etc.)

• optional string function_name = 14

  match on any function name in an import or export.

• optional string module_name = 15

  match on the module name e.g. `env` or `wasi_snapshot_preview1`

• optional Pagination pagination = 16

• optional Sort sort = 17

The message returned in response to a `SearchModulesRequest`.

• repeated Module modules = 1

• optional Pagination pagination = 2

• uint64 total = 3

  the full count of results in the database (not the count of this message's `modules`).

• optional Sort sort = 4

• optional Error error = 5

Determine how to sort results from the API

Used in: ListModulesRequest, ListModulesResponse, SearchModulesRequest, SearchModulesResponse

• Direction direction = 1

• Field field = 2

The language (or most similar match) used to produce a wasm module.

Used in: Module, SearchModulesRequest

• Unknown = 0

• Rust = 1

• Go = 2

• C = 3

• Cpp = 4

• AssemblyScript = 5

• Swift = 6

• JavaScript = 7

• Haskell = 8

• Zig = 9

DELETE /api/v1/plugin:

• string identifier = 1

• optional Error error = 1

Used to type the arguments and return types from wasm elements such as import and export functions.

Used in: Function

• I32 = 0

• I64 = 1

• F32 = 2

• F64 = 3

• V128 = 4

• FuncRef = 5

• ExternRef = 6

`POST /api/v1/validate:` Return the failure report (if applicable) of a wasm module validation against a given checkfile.

• bytes checkfile = 1

  the YAML checkfile (e.g. mod.yaml) bytes

• oneof module_input

  module_input is either an existing `module_id` that is known to the database, or the bytes of a raw wasm module. It is used to validate against the given checkfile.

  • bytes module = 2

  • int64 module_id = 3

The failure report produced by the validation check (encoded in JSON).

• bytes invalid_module_report = 1

• optional Error error = 2