[POC] Use WebAssembly build of package-spec for package validation by joshdover · Pull Request #128076 · elastic/kibana

joshdover · 2022-03-18T16:40:59Z

Summary

Related to #115032
Uses a WebAssembly build from elastic/package-spec#285

This imports a WebAssembly (wasm) build of the package-spec validation code and applies it to all packages installed via upload. It will fail to install these packages if they do not pass the package-spec validation.

For instance, this fails on the endpoint package today with this error (due to elastic/package-spec#23):

Failed installing package [endpoint] due to error: [found 2 validation errors:
   1. item [index_template] is not allowed in folder [endpoint-1.5.0.zip/elasticsearch]
   2. item [transform] is not allowed in folder [endpoint-1.5.0.zip/elasticsearch]
]

Maybe for now we make this a dev-only log warning to start?

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release.

When forming the risk matrix, consider some of the following examples and how they may potentially impact the change:

Risk	Probability	Severity	Mitigation/Notes
Multiple Spaces—unexpected behavior in non-default Kibana Space.	Low	High	Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces.
Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks.	High	Low	Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure.
Code should gracefully handle cases when feature X or plugin Y are disabled.	Medium	High	Unit tests will verify that any feature flag or plugin combination still results in our service operational.
See more potential risk examples

For maintainers

This was checked for breaking API changes and was labeled appropriately

joshdover · 2022-03-18T16:48:36Z

@elastic/kibana-security I noticed that we have no other usages of WASM in Kibana today. Are there any known reasons we can't or shouldn't pursue this option?

kibana-ci · 2022-03-18T17:12:46Z

💔 Build Failed

Failed CI Steps

Test Failures

[job] [logs] Docker CI Group / endpoint "before all" hook in "endpoint"
[job] [logs] Docker CI Group / endpoint "before all" hook in "endpoint"
[job] [logs] Jest Tests #8 / install registry should install from bundled package if one exists

Metrics [docs]

Unknown metric groups

ESLint disabled in files

id	before	after	diff
`fleet`	8	9	+1

Total ESLint disabled count

id	before	after	diff
`fleet`	55	56	+1

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

legrego · 2022-03-18T17:53:04Z

@elastic/kibana-security I noticed that we have no other usages of WASM in Kibana today. Are there any known reasons we can't or shouldn't pursue this option?

Thanks for asking! I'll let others on the team respond do your direct usage, which appears to be server-side. I don't know enough to have an opinion one way or another here.

For client-side WASM, we would likely need a CSP that included either script-src: unsafe-eval or script-src: wasm-unsafe-eval. We are actively working to remove unsafe-eval, and I'm not keen on adding wasm-unsafe-eval. You can probably ignore all of this since your usage is server-side, but I wanted to mention it to start to spread awareness.

azasypkin

I agree with Larry's earlier assessment. If we use WASM on the server-side and compile only the module we ship, then I don't have any significant security-related concerns. I just left few performance related questions and it'd be great if we can avoid polluting the global scope with Go wasm helper.

azasypkin · 2022-03-21T08:53:12Z

+  size: number,
+  buffer: Uint8Array
+): Promise<void> {
+  const validator = await WebAssembly.instantiate(wasmBuffer, go.importObject);


nit: if it's called multiple times then it'd probably make sense to compile module just once and reuse it for instantiation (with new WebAssembly.Module or WebAssembly.compile).

azasypkin · 2022-03-21T09:01:36Z

+// @ts-expect-error
+const go = new Go();
+
+const wasmBuffer = fs.readFileSync(path.join(__dirname, 'validator.wasm'));


question: Just curious, I see this module is about 12mb, I assume it's not optimized yet (with more aggressive build optimization flags, wasm-opt and friends)?

Yep we still need to explore making this smaller and distribute it via a proper npm module. This is currently being built with go-wasm, but I think it would make sense to look at tinygo.

azasypkin · 2022-03-21T09:05:01Z

+// Provides global.Go runtime
+import './wasm_exec';
+// @ts-expect-error
+const go = new Go();


question: I'm not familiar with wasm_exec.js\tinygo, is it possible to use its importObject without polluting the global scope with Go?

Without editing the wasm_exec.js from Go (this is not from tinygo), I don't see a way. I think it would be a small edit though and I agree we shouldn't merge this in its current state (polluting the global scope).

[POC] Use wasm build of package-spec for package validation

921353f

joshdover added release_note:skip Skip the PR/issue when compiling release notes backport:skip This PR does not require backporting Team:Fleet Team label for Observability Data Collection Fleet team labels Mar 18, 2022

This was referenced Mar 18, 2022

Make more easily compatible with Node.js jsoriano/package-spec#1

Merged

[POC] Validation of zip packages using javascript elastic/package-spec#285

Draft

joshdover changed the title ~~[POC] Use wasm build of package-spec for package validation~~ [POC] Use WebAssembly build of package-spec for package validation Mar 18, 2022

azasypkin reviewed Mar 21, 2022

View reviewed changes

legrego closed this Jul 16, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[POC] Use WebAssembly build of package-spec for package validation#128076

[POC] Use WebAssembly build of package-spec for package validation#128076
joshdover wants to merge 1 commit intoelastic:mainfrom
joshdover:fleet/package-spec-validation

joshdover commented Mar 18, 2022 •

edited

Loading

Uh oh!

joshdover commented Mar 18, 2022

Uh oh!

kibana-ci commented Mar 18, 2022 •

edited

Loading

ESLint disabled in files

Total ESLint disabled count

Uh oh!

legrego commented Mar 18, 2022

Uh oh!

azasypkin left a comment

Uh oh!

azasypkin Mar 21, 2022

Uh oh!

azasypkin Mar 21, 2022

Uh oh!

joshdover Mar 21, 2022

Uh oh!

azasypkin Mar 21, 2022

Uh oh!

joshdover Mar 21, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

joshdover commented Mar 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Risk Matrix

For maintainers

Uh oh!

joshdover commented Mar 18, 2022

Uh oh!

kibana-ci commented Mar 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💔 Build Failed

Failed CI Steps

Test Failures

Metrics [docs]

ESLint disabled in files

Total ESLint disabled count

History

Uh oh!

legrego commented Mar 18, 2022

Uh oh!

azasypkin left a comment

Choose a reason for hiding this comment

Uh oh!

azasypkin Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

azasypkin Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

joshdover Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

azasypkin Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

joshdover Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

joshdover commented Mar 18, 2022 •

edited

Loading

kibana-ci commented Mar 18, 2022 •

edited

Loading