DOPA 1.1.2
dotnet add package DOPA --version 1.1.2
NuGet\Install-Package DOPA -Version 1.1.2
<PackageReference Include="DOPA" Version="1.1.2" />
paket add DOPA --version 1.1.2
#r "nuget: DOPA, 1.1.2"
// Install DOPA as a Cake Addin #addin nuget:?package=DOPA&version=1.1.2 // Install DOPA as a Cake Tool #tool nuget:?package=DOPA&version=1.1.2
DOPA
A dotnet OPA client designed for applications to take advantage of its first-class WebAssembly support.
DOPA is built with Wasmtime, the same runtime used by OPA for WebAssembly.
Usage
To start, you will need to compile your OPA policy for WebAssembly to get a .wasm
. See OPA's documentation on compiling policies for more details. This document refers to example.rego.
Currently, the compiled wasm needs to be extracted from the output bundle. This can be accomplished with tar
.
$ opa build -t wasm -e example/hello example.rego
$ tar -xzf ./bundle.tar.gz /policy.wasm
With your compiled wasm available to your application, and named whatever you want, instantiate an IOpaModule
from the file.
using DOPA;
using IOpaModule module = WasmModule.FromFile("./example.wasm");
The module links the WebAssembly runtime to your application, and incurs an extra compilation cost that you don't want to repeat very often. It is also where you can configure things that don't change between your policy instances, such as a serializer.
Create an instance of IOpaPolicy
to set any data, evaluate your policy, and start getting results.
using IOpaPolicy policy = module.CreatePolicy();
policy.SetData(new { world = "hello" });
var allowed = policy.Evaluate<bool>(new { message = "hello" });
Contributing
Pull requests and issues are appreciated and encouraged.
License
DOPA is licensed under the MIT License.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net6.0
- Microsoft.Extensions.DependencyInjection (>= 8.0.0)
- Wasmtime (>= 19.0.0)
-
net7.0
- Microsoft.Extensions.DependencyInjection (>= 8.0.0)
- Wasmtime (>= 19.0.0)
-
net8.0
- Microsoft.Extensions.DependencyInjection (>= 8.0.0)
- Wasmtime (>= 19.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Target NET 8 and Wasmtime 19.0.0.