mirror of
https://github.com/Luzifer/wasm-openssl.git
synced 2024-11-08 23:00:11 +00:00
50 lines
2.4 KiB
Markdown
50 lines
2.4 KiB
Markdown
[](https://goreportcard.com/report/github.com/Luzifer/wasm-openssl)
|
|
|
|
|
|
|
|
|
|
# Luzifer / wasm-openssl
|
|
|
|
`wasm-openssl` is a WASM wrapper around [go-openssl](https://github.com/Luzifer/go-openssl) to be used in Javascript projects.
|
|
|
|
**A word of warning:** This relies on the **experimental** WASM implementation in Golang. It is working but most likely will not have its final state. When the Golang implementation of WASM changes this likely will change too. Following SemVer every breaking change will have an increase of the major version with an explanation in the [changelog](History.md).
|
|
|
|
## Usage
|
|
|
|
You will need to have `wasm_exec.js` installed in your project to load the binary:
|
|
|
|
```console
|
|
$ curl -sSfLo wasm_exec.js "https://raw.githubusercontent.com/golang/go/go1.11/misc/wasm/wasm_exec.js"
|
|
```
|
|
|
|
Afterwards in your HTML you can include the `wasm_exec.js` and load the binary:
|
|
|
|
```html
|
|
<!doctype html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
</head>
|
|
<body>
|
|
<script src="wasm_exec.js"></script>
|
|
<script>
|
|
function opensslLoaded() { console.log("openssl.wasm loaded") }
|
|
|
|
const go = new Go()
|
|
WebAssembly.instantiateStreaming(fetch("openssl.wasm"), go.importObject)
|
|
.then(async (obj) => {
|
|
await go.run(obj.instance)
|
|
})
|
|
</script>
|
|
</body>
|
|
</html>
|
|
```
|
|
|
|
If you have a top-level function `opensslLoaded()` defined, this will be called in the initialization of the `openssl.wasm`. This serves as a notification you do have now access to the top-level functions `opensslEncrypt` and `opensslDecrypt`:
|
|
|
|
```javascript
|
|
function opensslDecrypt(ciphertext, passphrase, callback) {}
|
|
function opensslEncrypt(plaintext, passphrase, callback) {}
|
|
```
|
|
|
|
The functions will not return anything in the moment as in the current state Go WASM support does not have return values. Instead the callback function you've provided will be called and always have two arguments: `function callback(result, error)` - The `result` will be the plaintext on `decrypt` and the ciphertext on `encrypt`. The `error` will either be `null` or a string containing details about the error. When an error occurred the `result` is `null`.
|