Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/StyraInc/opa-csharp

Styra's C# OPA Client SDK
https://github.com/StyraInc/opa-csharp

Last synced: about 2 months ago
JSON representation

Styra's C# OPA Client SDK

Awesome Lists containing this project

README 

        
# OPA C# SDK



[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

[![NuGet Version](https://img.shields.io/nuget/v/Styra.Opa?style=flat&color=%2324b6e0)](https://www.nuget.org/packages/Styra.Opa/)



> [!IMPORTANT]

> The documentation for this SDK lives at https://docs.styra.com/sdk, with reference documentation available at https://styrainc.github.io/opa-csharp



You can use the Styra OPA SDK to connect to [Open Policy Agent](https://www.openpolicyagent.org/) and [Enterprise OPA](https://www.styra.com/enterprise-opa/) deployments.



## SDK Installation



### Nuget



```bash

dotnet add package Styra.Opa

```



## SDK Example Usage (high-level)



All the code examples that follow assume that the high-level SDK module has been imported, and that an `OpaClient` instance was created:



```csharp

using Styra.Opa;



private string serverURL = "http://opa-host:8181";

private string path = "authz/allow";

private OpaClient opa;



opa = new OPAClient(serverURL);



var input = new Dictionary() {

    { "user", "alice" },

    { "action", "read" },

    {"resource", "/finance/reports/fy2038_budget.csv"},

};



// (local variable) bool allowed

var allowed = await opa.check("authz/allow", input);

// (local variable) violations List?

var violations = await opa.evaluate>("authz/violations", input);



// Normal true/false cases...

if (allowed) {

    // ...

} else {

    Console.WriteLine("Violations: " + violations);

}

```



### Input types



The `check` and `evaluate` methods are overloaded for most standard JSON types, which include the following variants for the `input` parameter:



| C# type | JSON equivalent type |

| ------- | -------------------- |

| `bool` | Boolean |

| `double` | Number |

| `string` | String |

| `List` | Array |

| `Dictionary` | Object |



### Result Types



#### `OpaClient.check`

For the `check` method, the output type is always `bool`.



#### `OpaClient.evaluate`

For the `evaluate` method, the output type is configurable using generics, as shown in the example below.



```csharp

string path = "authz/accounts/max_limit";



double maxLimit

try {

    maxLimit = opa.evaluate(path, "example");

}

catch (OpaException) {

    maxLimit = 0.0f;

}

```



Nullable types are also allowed for output types, and if an error occurs during evaluation, a null result will be returned to the caller.



```csharp

string path = "authz/accounts/max_limit";



double? maxLimit = opa.evaluate(path, "example");

```



If the selected return type `` is possible to deserialize from the returned JSON, `evaluate` will attempt to populate the variable with the value(s) present.



```csharp

public struct AuthzStatus

{

    public AuthzStatus(bool allowed)

    {

        Allowed = allowed;

    }



    public double Allowed { get; }



    public override string ToString() => $"Application authorized: {Allowed}";

}



var input = new Dictionary() {

    { "user", "alice" },

    { "action", "read" },

};



AuthzStatus status;

try {

    status = opa.evaluate(path, input);

}

catch (OpaException) {

    status = new AuthzStatus(false);

}

```



> [!NOTE]

> For low-level SDK usage, see the sections below.



---



# OPA OpenAPI SDK (low-level)



## Summary



For more information about the API: [Enterprise OPA documentation](https://docs.styra.com/enterprise-opa)



## Table of Contents



* [SDK Installation](#sdk-installation)

* [SDK Example Usage](#sdk-example-usage)

* [Available Resources and Operations](#available-resources-and-operations)

* [Error Handling](#error-handling)

* [Server Selection](#server-selection)

* [Authentication](#authentication)



## SDK Example Usage



### Example 1



```csharp

using Styra.Opa.OpenApi;

using Styra.Opa.OpenApi.Models.Requests;

using Styra.Opa.OpenApi.Models.Components;

using System.Collections.Generic;



var sdk = new OpaApiClient(bearerAuth: "");



var res = await sdk.ExecuteDefaultPolicyWithInputAsync(

    input: Input.CreateNumber(

        8203.11D

    ),

    pretty: false,

    acceptEncoding: Styra.Opa.OpenApi.Models.Components.GzipAcceptEncoding.Gzip

);



// handle response

```



### Example 2



```csharp

using Styra.Opa.OpenApi;

using Styra.Opa.OpenApi.Models.Requests;

using Styra.Opa.OpenApi.Models.Components;

using System.Collections.Generic;



var sdk = new OpaApiClient(bearerAuth: "");



ExecutePolicyWithInputRequest req = new ExecutePolicyWithInputRequest() {

    Path = "app/rbac",

    RequestBody = new ExecutePolicyWithInputRequestBody() {

        Input = Input.CreateBoolean(

            false

        ),

    },

};



var res = await sdk.ExecutePolicyWithInputAsync(req);



// handle response

```



### Example 3



```csharp

using Styra.Opa.OpenApi;

using Styra.Opa.OpenApi.Models.Requests;

using Styra.Opa.OpenApi.Models.Components;

using System.Collections.Generic;



var sdk = new OpaApiClient(bearerAuth: "");



ExecuteBatchPolicyWithInputRequest req = new ExecuteBatchPolicyWithInputRequest() {

    Path = "app/rbac",

    RequestBody = new ExecuteBatchPolicyWithInputRequestBody() {

        Inputs = new Dictionary() {

            { "key", Input.CreateStr(

                ""

            ) },

        },

    },

};



var res = await sdk.ExecuteBatchPolicyWithInputAsync(req);



// handle response

```



## Available Resources and Operations



Available methods



### [OpaApiClient SDK](docs/sdks/opaapiclient/README.md)



* [ExecuteDefaultPolicyWithInput](docs/sdks/opaapiclient/README.md#executedefaultpolicywithinput) - Execute the default decision  given an input

* [ExecutePolicy](docs/sdks/opaapiclient/README.md#executepolicy) - Execute a policy

* [ExecutePolicyWithInput](docs/sdks/opaapiclient/README.md#executepolicywithinput) - Execute a policy given an input

* [ExecuteBatchPolicyWithInput](docs/sdks/opaapiclient/README.md#executebatchpolicywithinput) - Execute a policy given a batch of inputs

* [Health](docs/sdks/opaapiclient/README.md#health) - Verify the server is operational



## Server Selection



### Select Server by Index



You can override the default server globally by passing a server index to the `serverIndex: number` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:



| # | Server | Variables |

| - | ------ | --------- |

| 0 | `http://localhost:8181` | None |



### Override Server URL Per-Client



The default server can also be overridden globally by passing a URL to the `serverUrl: str` optional parameter when initializing the SDK client instance. For example:



## Error Handling



Handling errors in this SDK should largely match your expectations.  All operations return a response object or thow an exception.  If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate type.



| Error Object                                 | Status Code                                  | Content Type                                 |

| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |

| Styra.Opa.OpenApi.Models.Errors.ClientError  | 400,404                                      | application/json                             |

| Styra.Opa.OpenApi.Models.Errors.ServerError  | 500                                          | application/json                             |

| Styra.Opa.OpenApi.Models.Errors.SDKException | 4xx-5xx                                      | */*                                          |



### Example



```csharp

using Styra.Opa.OpenApi;

using Styra.Opa.OpenApi.Models.Requests;

using Styra.Opa.OpenApi.Models.Components;

using System.Collections.Generic;

using System;

using Styra.Opa.OpenApi.Models.Errors;



var sdk = new OpaApiClient(bearerAuth: "");



try

{

    var res = await sdk.ExecuteDefaultPolicyWithInputAsync(

        input: Input.CreateNumber(

            8203.11D

        ),

        pretty: false,

        acceptEncoding: Styra.Opa.OpenApi.Models.Components.GzipAcceptEncoding.Gzip

    );



    // handle response

}

catch (Exception ex)

{

    if (ex is ClientError)

    {

        // handle exception

    }

    else if (ex is ServerError)

    {

        // handle exception

    }

    else if (ex is Styra.Opa.OpenApi.Models.Errors.SDKException)

    {

        // handle exception

    }

}

```



## Authentication



### Per-Client Security Schemes



This SDK supports the following security scheme globally:



| Name         | Type         | Scheme       |

| ------------ | ------------ | ------------ |

| `BearerAuth` | http         | HTTP Bearer  |



To authenticate with the API the `BearerAuth` parameter must be set when initializing the SDK client instance. For example:

```csharp

using Styra.Opa.OpenApi;

using Styra.Opa.OpenApi.Models.Requests;

using Styra.Opa.OpenApi.Models.Components;

using System.Collections.Generic;



var sdk = new OpaApiClient(bearerAuth: "");



var res = await sdk.ExecuteDefaultPolicyWithInputAsync(

    input: Input.CreateNumber(

        8203.11D

    ),

    pretty: false,

    acceptEncoding: Styra.Opa.OpenApi.Models.Components.GzipAcceptEncoding.Gzip

);



// handle response

```



## Community



For questions, discussions and announcements related to Styra products, services and open source projects, please join

the Styra community on [Slack](https://communityinviter.com/apps/styracommunity/signup)!