OpaDotNet.Wasm 1.0.0-preview0048

This is a prerelease version of OpaDotNet.Wasm.
There is a newer version of this package available.
See the version list below for details.
dotnet add package OpaDotNet.Wasm --version 1.0.0-preview0048
                    
NuGet\Install-Package OpaDotNet.Wasm -Version 1.0.0-preview0048
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="OpaDotNet.Wasm" Version="1.0.0-preview0048" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="OpaDotNet.Wasm" Version="1.0.0-preview0048" />
                    
Directory.Packages.props
<PackageReference Include="OpaDotNet.Wasm" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add OpaDotNet.Wasm --version 1.0.0-preview0048
                    
#r "nuget: OpaDotNet.Wasm, 1.0.0-preview0048"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package OpaDotNet.Wasm@1.0.0-preview0048
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=OpaDotNet.Wasm&version=1.0.0-preview0048&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=OpaDotNet.Wasm&version=1.0.0-preview0048&prerelease
                    
Install as a Cake Tool

CI NuGet Coverage Status

Open Policy Agent (OPA) WebAssembly dotnet core SDK

This is SDK for using WebAssembly (wasm) compiled Open Policy Agent Rego policies with dotnet core.

Initial implementation was based on Open Policy Agent WebAssemby NPM Module

Supported ABI

Version Status
1.0 ✔️
1.2 ✔️
1.3 ✔️

Getting Started

Install nuget package

dotnet add package OpaDotNet.Wasm

Usage

To evaluate OPA policy you need to:

Load compiled policy

using using OpaDotNet.Wasm;

var factory = new OpaEvaluatorFactory();

const string data = "{ \"world\": \"world\" }";

using var engine = factory.CreateFromWasm(
    File.OpenRead("policy.wasm")
    );

engine.SetDataFromRawJson(data);

Evaluate policy

IOpaEvaluator has several APIs for policy evaluation:

  • EvaluatePredicate - Evaluates named policy with specified input. Response interpreted as simple true/false result.
  • Evaluate - Evaluates named policy with specified input.
  • EvaluateRaw - Evaluates named policy with specified raw JSON input.
var policyResult = engine.EvaluatePredicate(inp);

Check result

if (policyResult)
{
    // We've been authorized.
}
else
{
    // Can't do that.
}

Writing policy

See writing policy

Compiling policy

You have several options to compile rego policy into wasm module:

package example

default hello = false

hello {
    x := input.message
    x == data.world
}

Manually

Either use the Compile REST API or opa build CLI tool.

For example, with OPA v0.20.5+:

opa build -t wasm -e example/hello example.rego

Which is compiling the example.rego policy file. The result will be an OPA bundle with the policy.wasm binary included. See ./samples for a more comprehensive example.

See opa build --help for more details.

With OpaDotNet.Wasm.Compilation

You can use SDK to do compilation for you.

Important. You will need opa cli tool to be in your PATH or provide full path in RegoCliCompilerOptions.

using OpaDotNet.Wasm;
using OpaDotNet.Wasm.Compilation;

var options = new OptionsWrapper<RegoCliCompilerOptions>(new RegoCliCompilerOptions());
var compiler = new RegoCliCompiler(options);
var policyStream = await compiler.CompileFile("example.rego", new[] { "example/hello" });

// Use compiled policy.
var factory = new OpaEvaluatorFactory();

using var engine = factory.CreateFromBundle(policyStream);

3rd Party Libraries and Contributions

  • OPA - An open source, general-purpose policy engine that unifies policy enforcement across the stack.
  • Moq - The most popular and friendly mocking library for .NET.
  • xUnit.net - Free, open source, community-focused unit testing tool for the .NET Framework.
  • wasmtime-dotnet - .NET embedding of Wasmtime.
Product Compatible and additional computed target framework versions.
.NET 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 was computed.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on OpaDotNet.Wasm:

Package Downloads
OpaDotNet.Extensions.AspNetCore

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
3.0.1 475 3/11/2025
3.0.0-preview-0040 221 3/5/2025
3.0.0-preview-0027 90 2/26/2025
3.0.0-preview-0004 113 11/10/2024
3.0.0-preview-0001 104 10/25/2024
3.0.0-preview-0000 94 10/25/2024
2.5.1 859 11/8/2024
2.5.0 1,100 2/12/2024
2.4.1 173 1/26/2024
2.4.1-pre0004 109 1/23/2024
2.4.0 209 1/10/2024
2.3.0 255 11/21/2023
2.2.0 223 10/11/2023
2.2.0-preview0010 174 10/9/2023
2.2.0-preview0008 176 10/3/2023
2.1.1 191 9/29/2023
2.1.0 198 9/28/2023
2.0.0 321 8/18/2023
2.0.0-preview0012 153 8/18/2023
2.0.0-preview 159 8/17/2023
1.4.0 254 8/15/2023
1.3.0 196 8/9/2023
1.3.0-preview0010 174 8/7/2023
1.2.1 231 7/27/2023
1.2.0 238 7/26/2023
1.2.0-preview0033 174 7/25/2023
1.2.0-preview0028 160 7/24/2023
1.2.0-preview0012 186 7/20/2023
1.2.0-preview0009 171 7/19/2023
1.2.0-preview0007 172 7/19/2023
1.1.0 216 7/13/2023
1.1.0-preview0078 187 7/13/2023
1.1.0-preview0076 145 7/13/2023
1.1.0-preview0073 150 7/13/2023
1.1.0-preview0068 181 7/12/2023
1.1.0-preview0067 198 7/12/2023
1.1.0-preview0065 193 7/12/2023
1.1.0-preview0063 174 7/12/2023
1.1.0-preview0061 195 7/11/2023
1.1.0-preview0057 165 7/11/2023
1.1.0-preview0053 159 7/11/2023
1.1.0-preview0049 143 7/10/2023
1.1.0-preview0047 155 7/10/2023
1.1.0-preview0018 178 7/6/2023
1.1.0-preview0015 162 7/6/2023
1.1.0-preview0012 169 7/6/2023
1.1.0-preview0011 168 7/5/2023
1.1.0-preview0010 177 7/5/2023
1.1.0-preview0009 158 7/5/2023
1.1.0-preview0007 154 7/3/2023
1.0.0 200 6/27/2023
1.0.0-preview0059 178 6/27/2023
1.0.0-preview0058 169 6/27/2023
1.0.0-preview0056 161 6/27/2023
1.0.0-preview0049 156 6/23/2023
1.0.0-preview0048 161 6/23/2023
1.0.0-preview0047 152 6/23/2023
1.0.0-preview0045 169 6/23/2023
1.0.0-preview0043 162 6/23/2023
1.0.0-preview0041 121 6/22/2023
1.0.0-preview0040 166 6/22/2023
1.0.0-preview0037 146 6/22/2023
1.0.0-preview0036 159 6/22/2023
1.0.0-preview0032 172 6/22/2023
1.0.0-preview0031 167 6/22/2023
1.0.0-preview0029 151 6/21/2023
1.0.0-preview0027 169 6/21/2023
1.0.0-preview0025 161 6/21/2023
1.0.0-preview0023 174 6/21/2023
1.0.0-preview0021 134 6/20/2023
1.0.0-preview0012 139 6/20/2023
1.0.0-preview0011 172 6/20/2023