Crates.io | autosar-e2e |
lib.rs | autosar-e2e |
version | 0.6.1 |
created_at | 2025-09-17 06:02:33.746199+00 |
updated_at | 2025-09-26 00:17:53.093296+00 |
description | AUTOSAR E2E (End-to-End) Protection Library implementation in Rust |
homepage | |
repository | https://github.com/handohun/autosar-e2e |
max_upload_size | |
id | 1842791 |
size | 132,370 |
A high-performance, memory-safe Rust implementation of the AUTOSAR E2E (End-to-End) Protection Protocol for safety-critical automotive communication systems.
This library implements the AUTOSAR E2E protection mechanism which provides end-to-end data protection for safety-critical automotive communication. The E2E protection helps detect:
Protection Type | Detection Method | Status |
---|---|---|
Data Corruption | CRC checksums | Implemented |
Message Loss/Duplication | Sequence counters | Implemented |
Incorrect Addressing | Data ID verification | Implemented |
Out-of-order Messages | Counter validation | Implemented |
Profile | Description | CRC | Counter | Data ID | Status |
---|---|---|---|---|---|
Profile 4 | Large packets, low overhead | 32-bit | 16-bit | 32-bit | Complete |
Profile 4M | Profile 4 + message metadata | 32-bit | 16-bit | 32-bit | Complete |
Profile 5 | Small packets, minimal overhead | 16-bit | 8-bit | 16-bit | Complete |
Profile 6 | Dynamic size data | 16-bit | 8-bit | 16-bit | Complete |
Profile 7 | High-integrity protection | 64-bit | 32-bit | 32-bit | Complete |
Profile 7M | Profile 7 + message metadata | 64-bit | 32-bit | 32-bit | Complete |
Profile 8 | Flexible protection | 32-bit | 32-bit | 32-bit | Complete |
Profile 11 | Nibble/Both variants | 8-bit | 4-bit | Variable | Complete |
Profile 22 | Enhanced protection | 8-bit | 8-bit | Variable | Complete |
Add this to your Cargo.toml
:
[dependencies]
autosar-e2e = "0.6.1"
use autosar_e2e::{E2EProfile, E2EResult, E2EStatus};
use autosar_e2e::profile4::{Profile4, Profile4Config};
fn main() -> E2EResult<()> {
// Configure Profile 4 for large data packets
let config = Profile4Config {
data_id: 0x12345678,
max_delta_counter: 1,
min_data_length: 96, // 12 bytes minimum
max_data_length: 4096, // 512 bytes maximum
..Default::default()
};
// Create sender and receiver instances
let mut sender = Profile4::new(config.clone());
let mut receiver = Profile4::new(config);
// Prepare data buffer (12 bytes minimum for Profile 4)
let mut data = vec![0u8; 16]; // [length, counter, data_id, crc, user_data...]
// Add E2E protection
sender.protect(&mut data)?;
println!("Protected data: {:02X?}", data);
// Simulate network transmission...
// Verify E2E protection at receiver
match receiver.check(&data)? {
E2EStatus::Ok => println!("Data integrity verified!"),
E2EStatus::CrcError => println!("CRC error detected!"),
E2EStatus::DataIdError => println!("Data ID mismatch!"),
E2EStatus::WrongSequence => println!("Counter sequence error!"),
E2EStatus::OkSomeLost => println!("Some messages lost but within tolerance"),
E2EStatus::Repeated => println!("Repeated message detected"),
E2EStatus::DataLengthError => println!("Data length mismatch!"),
}
Ok(())
}
use autosar_e2e::profile7::{Profile7, Profile7Config};
// High-integrity protection with 64-bit CRC
let config = Profile7Config {
data_id: 0x0a0b0c0d,
offset: 64, // Header at bit offset 64
min_data_length: 20 * 8, // 20 bytes minimum
max_data_length: 4096 * 8, // 4KB maximum
max_delta_counter: 5, // Allow up to 5 lost messages
};
let mut profile = Profile7::new(config);
src/
├── lib.rs # Main library interface
├── profiles/ # All E2E profile implementations
│ ├── profile4.rs # Large packets, 32-bit CRC
│ ├── profile5.rs # Small packets, 16-bit CRC
│ ├── profile6.rs # Dynamic size, 16-bit CRC
│ ├── profile7.rs # High integrity, 64-bit CRC
│ ├── profile7m.rs # Profile 7 + message metadata
│ ├── profile8.rs # Flexible protection, 32-bit CRC
│ ├── profile11.rs # Nibble/Both variants
│ └── profile22.rs # Enhanced protection
└── common/ # Shared helper modules
├── counter.rs # Generic counter validation
├── field_ops.rs # Binary field operations
└── validation.rs # Common validation functions
The library follows a clean trait-based design for extensibility:
pub trait E2EProfile {
type Config;
/// Create a new profile instance with configuration
fn new(config: Self::Config) -> Self;
/// Add E2E protection to data buffer (in-place)
fn protect(&mut self, data: &mut [u8]) -> E2EResult<()>;
/// Verify E2E protection on received data
fn check(&mut self, data: &[u8]) -> E2EResult<E2EStatus>;
}
The library has been refactored to eliminate code duplication:
Run the comprehensive test suite:
# Run all tests
cargo test
# Run with output
cargo test -- --nocapture
# Run specific profile tests
cargo test profile4
# Run tests in release mode for performance
cargo test --release
# Generate coverage report
cargo tarpaulin --out Html
# View coverage
open tarpaulin-report.html
Current test coverage: 96% with 26 test cases covering:
The library is optimized for automotive real-time constraints:
Operation | Profile 4 | Profile 7 | Profile 11 |
---|---|---|---|
Protect | ~2μs | ~3μs | ~1μs |
Check | ~2μs | ~3μs | ~1μs |
Memory | Zero-copy | Zero-copy | Zero-copy |
Benchmarks run on Intel i7-9750H @ 2.60GHz
Use Case | Recommended Profile | Reason |
---|---|---|
High-speed CAN | Profile 5 | Minimal 3-byte overhead |
Ethernet backbone | Profile 4 | Flexible length support |
Safety-critical | Profile 7 | 64-bit CRC protection |
Telemetry | Profile 8 | Large counter space |
Legacy systems | Profile 11 | Compact nibble format |
// Minimal overhead for CAN (Profile 5)
let can_config = Profile5Config {
data_length: 8 * 8, // 8 bytes total
data_id: 0x123,
max_delta_counter: 1,
offset: 0,
};
// High-integrity Ethernet (Profile 7)
let eth_config = Profile7Config {
min_data_length: 20 * 8,
max_data_length: 1500 * 8, // MTU size
data_id: 0xdeadbeef,
max_delta_counter: 10, // Higher tolerance
};
// Data ID should be unique per message type
let config = ProfileConfig {
data_id: 0x12345678, // Good: unique per message
// data_id: 0x00000000, // Bad: not unique
};
// Configure appropriate counter tolerance
let config = ProfileConfig {
max_delta_counter: 5, // Good: allows some loss
// max_delta_counter: 255, // Bad: too permissive
};
We welcome contributions! Please see CONTRIBUTING.md for guidelines.
# Clone the repository
git clone https://github.com/your-org/autosar-e2e
cd autosar-e2e
# Run tests
cargo test
# Check formatting
cargo fmt --check
# Run clippy
cargo clippy -- -D warnings
# Generate docs
cargo doc --open
This project is dual-licensed under either:
at your option.
This is an independent implementation and is not officially affiliated with or endorsed by AUTOSAR GbR. The implementation follows the publicly available AUTOSAR specifications but has not undergone official AUTOSAR certification.
For production safety-critical systems, please ensure appropriate validation and testing according to your functional safety requirements (ISO 26262 or similar).
Made with care for the automotive industry