Module algorithm 

Algorithm Value Object

This module defines the algorithm value object for the adaptive pipeline system. It provides type-safe algorithm specification with validation, categorization, and cross-language compatibility.

Overview

The algorithm value object provides:

• Type Safety: Type-safe algorithm specification and validation
• Algorithm Categories: Support for different algorithm categories
• Validation: Comprehensive validation of algorithm names and formats
• Cross-Language: Consistent representation across different languages
• Extensibility: Support for custom and user-defined algorithms

Architecture

The algorithm follows Domain-Driven Design principles:

• Value Object: Immutable value object with equality semantics
• Rich Domain Model: Encapsulates algorithm-related business logic
• Validation: Comprehensive validation of algorithm specifications
• Serialization: Support for persistence and cross-language communication

Key Features

Algorithm Categories

• Compression: Data compression algorithms (brotli, gzip, zstd, lz4)
• Encryption: Data encryption algorithms (AES-256-GCM, ChaCha20-Poly1305)
• Hashing: Cryptographic hash algorithms (SHA-256, SHA-512, Blake3)
• Custom: User-defined and application-specific algorithms

Validation and Safety

• Format Validation: Validate algorithm name format and structure
• Category Validation: Ensure algorithms belong to valid categories
• Parameter Validation: Validate algorithm-specific parameters
• Security Validation: Ensure algorithms meet security requirements

Cross-Language Support

• Consistent Representation: Same algorithm representation across languages
• JSON Serialization: Standard JSON serialization format
• Database Storage: Consistent database storage format
• API Compatibility: Compatible with REST and gRPC APIs

Usage Examples

Creating Algorithms

Algorithm Validation

Algorithm Categories

Algorithm Comparison and Sorting

Serialization and Deserialization

Supported Algorithms

Compression Algorithms

• brotli: Google’s Brotli compression algorithm
• gzip: GNU zip compression algorithm
• zstd: Facebook’s Zstandard compression algorithm
• lz4: LZ4 fast compression algorithm
• deflate: DEFLATE compression algorithm

Encryption Algorithms

• aes-256-gcm: AES-256 with Galois/Counter Mode
• aes-128-gcm: AES-128 with Galois/Counter Mode
• chacha20-poly1305: ChaCha20-Poly1305 AEAD cipher
• aes-256-cbc: AES-256 with Cipher Block Chaining

Hashing Algorithms

• sha256: SHA-256 cryptographic hash function
• sha512: SHA-512 cryptographic hash function
• blake3: BLAKE3 cryptographic hash function
• md5: MD5 hash function (legacy, not recommended)

Custom Algorithms

• custom-*: User-defined algorithms with “custom-” prefix
• Application-specific: Domain-specific algorithms
• Experimental: Experimental or research algorithms

Validation Rules

Name Format

• Length: 1-64 characters
• Characters: Lowercase letters, numbers, hyphens
• Start/End: Must start and end with alphanumeric characters
• Hyphens: Cannot have consecutive hyphens

Category Rules

• Compression: Must be a known compression algorithm
• Encryption: Must be a known encryption algorithm
• Hashing: Must be a known hashing algorithm
• Custom: Must start with “custom-” prefix

Security Requirements

• Encryption: Must use authenticated encryption (AEAD)
• Hashing: Must use cryptographically secure hash functions
• Key Length: Must meet minimum key length requirements
• Deprecation: Deprecated algorithms are rejected

Error Handling

Validation Errors

• Empty Name: Algorithm name cannot be empty
• Invalid Format: Name doesn’t match required format
• Unknown Algorithm: Algorithm is not recognized
• Deprecated Algorithm: Algorithm is deprecated or insecure

Usage Errors

• Category Mismatch: Algorithm used in wrong category context
• Parameter Errors: Invalid algorithm parameters
• Compatibility Errors: Algorithm not compatible with system

Performance Considerations

Memory Usage

• Compact Storage: Efficient string storage
• String Interning: Intern common algorithm names
• Copy Optimization: Optimize copying for frequent use

Validation Performance

• Fast Validation: Optimized validation routines
• Caching: Cache validation results
• Lazy Evaluation: Lazy evaluation of expensive checks

Cross-Language Compatibility

Language Mappings

• Rust: Algorithm newtype wrapper
• Go: Algorithm struct with validation
• Python: Algorithm class with validation
• JavaScript: Algorithm validation functions

Serialization Formats

• JSON: String representation
• Protocol Buffers: String field with validation
• MessagePack: String representation
• CBOR: String representation

Database Storage

• SQLite: TEXT column with CHECK constraint
• PostgreSQL: VARCHAR with domain validation
• MySQL: VARCHAR with validation triggers

Integration

The algorithm value object integrates with:

• Processing Pipeline: Specify algorithms for processing stages
• Configuration: Algorithm configuration and selection
• Validation: Validate algorithm compatibility and security
• Monitoring: Track algorithm usage and performance

Thread Safety

The algorithm value object is thread-safe:

• Immutable: Algorithms are immutable after creation
• Safe Sharing: Safe to share between threads
• Concurrent Access: Safe concurrent access to algorithm data

Future Enhancements

Planned enhancements include:

• Algorithm Registry: Centralized algorithm registry
• Performance Benchmarks: Built-in performance benchmarking
• Security Analysis: Automated security analysis
• Plugin System: Plugin system for custom algorithms

Modules

algorithm_utils

Utility functions for algorithm operations

Structs

Algorithm

Algorithm value object for pipeline stage processing

Enums

AlgorithmCategory

Algorithm categories for classification