OpaDotNet.Wasm 3.0.0-preview-0004

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 3.0.0-preview-0004
                    
NuGet\Install-Package OpaDotNet.Wasm -Version 3.0.0-preview-0004
                    
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="3.0.0-preview-0004" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="OpaDotNet.Wasm" Version="3.0.0-preview-0004" />
                    
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 3.0.0-preview-0004
                    
#r "nuget: OpaDotNet.Wasm, 3.0.0-preview-0004"
                    
#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@3.0.0-preview-0004
                    
#: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=3.0.0-preview-0004&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=OpaDotNet.Wasm&version=3.0.0-preview-0004&prerelease
                    
Install as a Cake Tool

Open Policy Agent (OPA) WebAssembly dotnet core SDK

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

Initial implementation was based on Open Policy Agent WebAssemby NPM Module

For more information check out the guide.

Key Features

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;

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

using var engine = OpaEvaluatorFactory.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.Result)
{
    // 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 if {
    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.Compilation

You can use SDK to do compilation for you. For more information see OpaDotNet.Compilation.

OpaDotNet.Compilation.Cli
dotnet add package OpaDotNet.Compilation.Cli
using OpaDotNet.Wasm;
using OpaDotNet.Compilation.Cli;

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

// Use compiled policy.
using var engine = OpaEvaluatorFactory.CreateFromBundle(policyStream);
OpaDotNet.Compilation.Interop
dotnet add package OpaDotNet.Compilation.Interop
using OpaDotNet.Wasm;
using OpaDotNet.Compilation.Interop;

var compiler = new RegoInteropCompiler();
var policyStream = await compiler.CompileFile("example.rego", new[] { "example/hello" });

// Use compiled policy.
using var engine = OpaEvaluatorFactory.CreateFromBundle(policyStream);
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 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.  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 476 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 861 11/8/2024
2.5.0 1,101 2/12/2024
2.4.1 174 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 224 10/11/2023
2.2.0-preview0010 175 10/9/2023
2.2.0-preview0008 178 10/3/2023
2.1.1 193 9/29/2023
2.1.0 198 9/28/2023
2.0.0 325 8/18/2023
2.0.0-preview0012 156 8/18/2023
2.0.0-preview 163 8/17/2023
1.4.0 257 8/15/2023
1.3.0 202 8/9/2023
1.3.0-preview0010 177 8/7/2023
1.2.1 235 7/27/2023
1.2.0 244 7/26/2023
1.2.0-preview0033 177 7/25/2023
1.2.0-preview0028 164 7/24/2023
1.2.0-preview0012 190 7/20/2023
1.2.0-preview0009 175 7/19/2023
1.2.0-preview0007 176 7/19/2023
1.1.0 221 7/13/2023
1.1.0-preview0078 191 7/13/2023
1.1.0-preview0076 150 7/13/2023
1.1.0-preview0073 154 7/13/2023
1.1.0-preview0068 186 7/12/2023
1.1.0-preview0067 202 7/12/2023
1.1.0-preview0065 197 7/12/2023
1.1.0-preview0063 178 7/12/2023
1.1.0-preview0061 199 7/11/2023
1.1.0-preview0057 169 7/11/2023
1.1.0-preview0053 163 7/11/2023
1.1.0-preview0049 149 7/10/2023
1.1.0-preview0047 161 7/10/2023
1.1.0-preview0018 182 7/6/2023
1.1.0-preview0015 166 7/6/2023
1.1.0-preview0012 173 7/6/2023
1.1.0-preview0011 172 7/5/2023
1.1.0-preview0010 181 7/5/2023
1.1.0-preview0009 162 7/5/2023
1.1.0-preview0007 158 7/3/2023
1.0.0 204 6/27/2023
1.0.0-preview0059 182 6/27/2023
1.0.0-preview0058 174 6/27/2023
1.0.0-preview0056 165 6/27/2023
1.0.0-preview0049 160 6/23/2023
1.0.0-preview0048 165 6/23/2023
1.0.0-preview0047 156 6/23/2023
1.0.0-preview0045 173 6/23/2023
1.0.0-preview0043 166 6/23/2023
1.0.0-preview0041 125 6/22/2023
1.0.0-preview0040 170 6/22/2023
1.0.0-preview0037 150 6/22/2023
1.0.0-preview0036 163 6/22/2023
1.0.0-preview0032 176 6/22/2023
1.0.0-preview0031 171 6/22/2023
1.0.0-preview0029 155 6/21/2023
1.0.0-preview0027 174 6/21/2023
1.0.0-preview0025 165 6/21/2023
1.0.0-preview0023 178 6/21/2023
1.0.0-preview0021 138 6/20/2023
1.0.0-preview0012 143 6/20/2023
1.0.0-preview0011 176 6/20/2023