OpaDotNet.Wasm 1.2.0-preview0009

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

  • Fast in-process OPA policies evaluation.
  • Full ABI support.
  • Additional OPA built-ins.
  • Compilation.

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);
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 1,352 3/11/2025
3.0.0-preview-0040 250 3/5/2025
3.0.0-preview-0027 110 2/26/2025
3.0.0-preview-0004 141 11/10/2024
3.0.0-preview-0001 131 10/25/2024
3.0.0-preview-0000 119 10/25/2024
2.5.1 1,018 11/8/2024
2.5.0 1,136 2/12/2024
2.4.1 203 1/26/2024
2.4.1-pre0004 125 1/23/2024
2.4.0 238 1/10/2024
2.3.0 279 11/21/2023
2.2.0 242 10/11/2023
2.2.0-preview0010 205 10/9/2023
2.2.0-preview0008 208 10/3/2023
2.1.1 220 9/29/2023
2.1.0 223 9/28/2023
2.0.0 381 8/18/2023
2.0.0-preview0012 188 8/18/2023
2.0.0-preview 194 8/17/2023
1.4.0 297 8/15/2023
1.3.0 237 8/9/2023
1.3.0-preview0010 205 8/7/2023
1.2.1 275 7/27/2023
1.2.0 288 7/26/2023
1.2.0-preview0033 206 7/25/2023
1.2.0-preview0028 180 7/24/2023
1.2.0-preview0012 227 7/20/2023
1.2.0-preview0009 206 7/19/2023
1.2.0-preview0007 203 7/19/2023
1.1.0 256 7/13/2023
1.1.0-preview0078 222 7/13/2023
1.1.0-preview0076 175 7/13/2023
1.1.0-preview0073 170 7/13/2023
1.1.0-preview0068 214 7/12/2023
1.1.0-preview0067 224 7/12/2023
1.1.0-preview0065 233 7/12/2023
1.1.0-preview0063 203 7/12/2023
1.1.0-preview0061 221 7/11/2023
1.1.0-preview0057 195 7/11/2023
1.1.0-preview0053 178 7/11/2023
1.1.0-preview0049 175 7/10/2023
1.1.0-preview0047 191 7/10/2023
1.1.0-preview0018 213 7/6/2023
1.1.0-preview0015 194 7/6/2023
1.1.0-preview0012 193 7/6/2023
1.1.0-preview0011 208 7/5/2023
1.1.0-preview0010 212 7/5/2023
1.1.0-preview0009 197 7/5/2023
1.1.0-preview0007 183 7/3/2023
1.0.0 245 6/27/2023
1.0.0-preview0059 209 6/27/2023
1.0.0-preview0058 203 6/27/2023
1.0.0-preview0056 199 6/27/2023
1.0.0-preview0049 195 6/23/2023
1.0.0-preview0048 192 6/23/2023
1.0.0-preview0047 189 6/23/2023
1.0.0-preview0045 206 6/23/2023
1.0.0-preview0043 198 6/23/2023
1.0.0-preview0041 155 6/22/2023
1.0.0-preview0040 203 6/22/2023
1.0.0-preview0037 181 6/22/2023
1.0.0-preview0036 198 6/22/2023
1.0.0-preview0032 201 6/22/2023
1.0.0-preview0031 203 6/22/2023
1.0.0-preview0029 188 6/21/2023
1.0.0-preview0027 203 6/21/2023
1.0.0-preview0025 196 6/21/2023
1.0.0-preview0023 214 6/21/2023
1.0.0-preview0021 164 6/20/2023
1.0.0-preview0012 166 6/20/2023
1.0.0-preview0011 204 6/20/2023