mirror of
https://github.com/microsoft/regorus.git
synced 2026-08-05 02:16:11 +00:00
* feat: Add Schema Registry and Validation Framework This commit introduces a comprehensive schema registry and validation framework, providing schema-based validation of resources and policy effects. - Thread-safe, in-memory registry for schema storage and management - Global registry patterns for effects and resources - Concurrent access with proper error handling - Unicode schema names support - JSON Schema-compliant validation for all primitive types - Advanced constraint validation (patterns, ranges, length limits) - Discriminated union support with anyOf schemas - Detailed error reporting with nested validation paths - Discriminated subobject validation for polymorphic schemas - **Registry Tests**: All registry operations - **Effect Tests**: Policy effect validation - **Resource Tests**: Resource validation - **Validation Tests**: Core validation engine - Thread-safety, error handling, integration scenarios, edge cases - **Dependencies**: dashmap, once_cell, regex - **Thread Safety**: Minimal locking with Rc<Schema> sharing - **Error Types**: TypeMismatch, OutOfRange, PatternMismatch, etc. - Complete schema registry and validation subsystem - Comprehensive test coverage - Foundation for policy validation in Regorus Benchmarks: - Criterion benchmarks for basic types, effects and Azure resources - Performance range: 3.22ns (string) to 34.74µs (Azure VM resource schema validation) - String withs patterns validation: 30.2µs. Need to explore whether regex caching helps bring this down. - Azure policy effects: 188ns-1.4µs Signed-off-by: Anand Krishnamoorthi <anakrish@microsoft.com> * feat: Complete target system with C# bindings and resource inference - Add comprehensive target system with TargetRegistry and target-aware compilation - Implement resource type inference from policy equality expressions - Create modular C# bindings with separate wrapper classes for each concept - Add thread-safe CompiledPolicy with reference counting for safe disposal - Enhance FFI with detailed error propagation and target functionality - Create TargetExampleApp demonstrating Azure Policy integration - Add CI/CD pipeline testing for all C# applications - Support target definitions with schema validation and resource selectors - Implement PolicyModule struct and target-aware compilation methods - Add comprehensive test coverage for target functionality Signed-off-by: Anand Krishnamoorthi <anakrish@microsoft.com> --------- Signed-off-by: Anand Krishnamoorthi <anakrish@microsoft.com>
186 lines
6.7 KiB
C#
186 lines
6.7 KiB
C#
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT License.
|
|
|
|
using System;
|
|
using System.Text;
|
|
|
|
#nullable enable
|
|
namespace Regorus
|
|
{
|
|
/// <summary>
|
|
/// Provides static methods for managing the global target registry.
|
|
/// Targets define resource types and their associated schemas for Azure Policy evaluation.
|
|
/// </summary>
|
|
public static unsafe class TargetRegistry
|
|
{
|
|
/// <summary>
|
|
/// Register a target from JSON definition.
|
|
/// The target JSON should follow the target schema format.
|
|
/// Once registered, the target can be referenced in Rego policies using `__target__` rules.
|
|
/// </summary>
|
|
/// <param name="targetJson">JSON encoded target definition</param>
|
|
/// <exception cref="Exception">Thrown when target registration fails</exception>
|
|
public static void RegisterFromJson(string targetJson)
|
|
{
|
|
var targetBytes = Encoding.UTF8.GetBytes(targetJson + char.MinValue);
|
|
fixed (byte* targetPtr = targetBytes)
|
|
{
|
|
CheckAndDropResult(Internal.API.regorus_register_target_from_json(targetPtr));
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Check if a target is registered.
|
|
/// </summary>
|
|
/// <param name="name">Name of the target to check</param>
|
|
/// <returns>True if the target is registered, false otherwise</returns>
|
|
/// <exception cref="Exception">Thrown when the operation fails</exception>
|
|
public static bool Contains(string name)
|
|
{
|
|
var nameBytes = Encoding.UTF8.GetBytes(name + char.MinValue);
|
|
fixed (byte* namePtr = nameBytes)
|
|
{
|
|
var result = Internal.API.regorus_target_registry_contains(namePtr);
|
|
return GetBoolResult(result);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Get a list of all registered target names.
|
|
/// </summary>
|
|
/// <returns>JSON array of target names</returns>
|
|
/// <exception cref="Exception">Thrown when the operation fails</exception>
|
|
public static string ListNames()
|
|
{
|
|
return CheckAndDropResult(Internal.API.regorus_target_registry_list_names()) ?? "[]";
|
|
}
|
|
|
|
/// <summary>
|
|
/// Remove a target from the registry by name.
|
|
/// </summary>
|
|
/// <param name="name">The target name to remove</param>
|
|
/// <returns>True if the target was removed, false if it wasn't found</returns>
|
|
/// <exception cref="Exception">Thrown when the operation fails</exception>
|
|
public static bool Remove(string name)
|
|
{
|
|
var nameBytes = Encoding.UTF8.GetBytes(name + char.MinValue);
|
|
fixed (byte* namePtr = nameBytes)
|
|
{
|
|
var result = Internal.API.regorus_target_registry_remove(namePtr);
|
|
return GetBoolResult(result);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Clear all targets from the registry.
|
|
/// </summary>
|
|
/// <exception cref="Exception">Thrown when the operation fails</exception>
|
|
public static void Clear()
|
|
{
|
|
CheckAndDropResult(Internal.API.regorus_target_registry_clear());
|
|
}
|
|
|
|
/// <summary>
|
|
/// Get the number of registered targets.
|
|
/// </summary>
|
|
/// <returns>The number of registered targets</returns>
|
|
/// <exception cref="Exception">Thrown when the operation fails</exception>
|
|
public static long Count
|
|
{
|
|
get
|
|
{
|
|
var result = Internal.API.regorus_target_registry_len();
|
|
return GetIntResult(result);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Check if the target registry is empty.
|
|
/// </summary>
|
|
/// <returns>True if the registry is empty, false otherwise</returns>
|
|
/// <exception cref="Exception">Thrown when the operation fails</exception>
|
|
public static bool IsEmpty
|
|
{
|
|
get
|
|
{
|
|
var result = Internal.API.regorus_target_registry_is_empty();
|
|
return GetBoolResult(result);
|
|
}
|
|
}
|
|
|
|
private static string? StringFromUTF8(IntPtr ptr)
|
|
{
|
|
#if NETSTANDARD2_1
|
|
return System.Runtime.InteropServices.Marshal.PtrToStringUTF8(ptr);
|
|
#else
|
|
int len = 0;
|
|
while (System.Runtime.InteropServices.Marshal.ReadByte(ptr, len) != 0) { ++len; }
|
|
byte[] buffer = new byte[len];
|
|
System.Runtime.InteropServices.Marshal.Copy(ptr, buffer, 0, buffer.Length);
|
|
return Encoding.UTF8.GetString(buffer);
|
|
#endif
|
|
}
|
|
|
|
private static string? CheckAndDropResult(Internal.RegorusResult result)
|
|
{
|
|
try
|
|
{
|
|
if (result.status != Internal.RegorusStatus.Ok)
|
|
{
|
|
var message = StringFromUTF8((IntPtr)result.error_message);
|
|
throw new Exception(message ?? "Unknown error occurred");
|
|
}
|
|
|
|
return result.data_type switch
|
|
{
|
|
Internal.RegorusDataType.String => StringFromUTF8((IntPtr)result.output),
|
|
Internal.RegorusDataType.Boolean => result.bool_value.ToString().ToLowerInvariant(),
|
|
Internal.RegorusDataType.Integer => result.int_value.ToString(),
|
|
Internal.RegorusDataType.None => null,
|
|
_ => StringFromUTF8((IntPtr)result.output)
|
|
};
|
|
}
|
|
finally
|
|
{
|
|
Internal.API.regorus_result_drop(result);
|
|
}
|
|
}
|
|
|
|
private static bool GetBoolResult(Internal.RegorusResult result)
|
|
{
|
|
try
|
|
{
|
|
if (result.status != Internal.RegorusStatus.Ok)
|
|
{
|
|
var message = StringFromUTF8((IntPtr)result.error_message);
|
|
throw new Exception(message ?? "Unknown error occurred");
|
|
}
|
|
|
|
return result.data_type == Internal.RegorusDataType.Boolean ? result.bool_value : false;
|
|
}
|
|
finally
|
|
{
|
|
Internal.API.regorus_result_drop(result);
|
|
}
|
|
}
|
|
|
|
private static long GetIntResult(Internal.RegorusResult result)
|
|
{
|
|
try
|
|
{
|
|
if (result.status != Internal.RegorusStatus.Ok)
|
|
{
|
|
var message = StringFromUTF8((IntPtr)result.error_message);
|
|
throw new Exception(message ?? "Unknown error occurred");
|
|
}
|
|
|
|
return result.data_type == Internal.RegorusDataType.Integer ? result.int_value : 0;
|
|
}
|
|
finally
|
|
{
|
|
Internal.API.regorus_result_drop(result);
|
|
}
|
|
}
|
|
}
|
|
}
|