https://github.com/linouxis9/oxirush-nas
oxirush-nas is a 5G NAS message encoder/decoder
https://github.com/linouxis9/oxirush-nas
5g 5g-core-network 5g-simulation 5gc amf gnb gnodeb nas packetrusher rust rust-library ue
Last synced: 18 days ago
JSON representation
oxirush-nas is a 5G NAS message encoder/decoder
- Host: GitHub
- URL: https://github.com/linouxis9/oxirush-nas
- Owner: linouxis9
- License: apache-2.0
- Created: 2025-02-27T23:33:07.000Z (about 2 months ago)
- Default Branch: master
- Last Pushed: 2025-03-15T19:13:16.000Z (about 1 month ago)
- Last Synced: 2025-03-15T19:34:35.744Z (about 1 month ago)
- Topics: 5g, 5g-core-network, 5g-simulation, 5gc, amf, gnb, gnodeb, nas, packetrusher, rust, rust-library, ue
- Language: Rust
- Homepage:
- Size: 37.1 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-telco - oxirush-nas - A Rust Library that allows the decoding/encoding of NAS-5G messages. From Valentin D'Emmanuele - France. (Protocols / NAS 4G/5G and Milenage)
README
# oxirush-nas
[](https://crates.io/crates/oxirush-nas)
[](https://docs.rs/oxirush-nas)
[](LICENSE)
> ⚠️ **Note**: This library is currently in active development and not all features may be available.
A fast, memory-safe library for encoding and decoding 5G Non-Access Stratum (NAS) messages, written in Rust.
Part of the future [OxiRush](https://github.com/linouxis9/oxirush) project - a comprehensive next-generation 5G Core Network testing framework.
## Overview
`oxirush-nas` provides a robust implementation for working with 5G NAS protocol messages and IEs, which are used for the communication between the User Equipment (UE) and the 5G Core Network.
## Features
- **Complete Protocol Support**: Full implementation of 5G NAS protocol as defined in 3GPP TS 24.501
- **High Performance**: Optimized for speed and minimal memory usage
- **Type Safety**: Leverages Rust's type system to prevent protocol errors at compile time
## Installation
Add the following to your `Cargo.toml`:
```toml
[dependencies]
oxirush-nas = "0.1"
```
## Usage Examples
### Basic Message Decoding and Encoding
```rust
use oxirush_nas::{decode_nas_5gs_message, encode_nas_5gs_message, Nas5gsMessage};
use anyhow::Result;
#[test]
fn test() -> Result<()> {
// Example NAS message bytes (Registration Request)
let nas_bytes = hex::decode("7e004179000d0199f9070000000000000010022e08a020000000000000")?;
// Decode the message
let parsed_message = decode_nas_5gs_message(&nas_bytes)?;
// Print message details
match &parsed_message {
Nas5gsMessage::Gmm(header, message) => {
println!("Message Type: {:?}", header.message_type);
match &message {
Nas5gmmMessage::RegistrationRequest(reg_request) =>{
println!("Registration Type Value: {}", reg_request.fgs_registration_type.value);
println!("Mobile Identity Length: {}", reg_request.fgs_mobile_identity.length);
if let Some(sec_cap) = ®_request.ue_security_capability {
println!("UE Security Capability: {:?}", sec_cap.value);
}
},
_ => println!("Not a RegistrationRequest message"),
}
},
_ => println!("Not a GMM message"),
}
// Re-encode the message
let encoded_message = encode_nas_5gs_message(&parsed_message)?;
// Verify encoding matches the original
println!("Encoding matches original: {}", nas_bytes == encoded_message);
Ok(())
}
```
## Documentation
For more detailed documentation, see:
- [oxirush-nas's API Reference](https://docs.rs/oxirush-nas)
- [3GPP TS 24.501 Specification](https://www.3gpp.org/DynaReport/24501.htm)
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
Please make sure your code passes all tests and adheres to the project's coding style.
### Developer Certificate of Origin (DCO)
By contributing to this project, you agree to the [Developer Certificate of Origin (DCO)](https://developercertificate.org/). This means that you have the right to submit your contributions and you agree to license them according to the project's license.
All commits should be signed-off with `git commit -s` to indicate your agreement to the DCO.
## License
Copyright 2025 Valentin D'Emmanuele
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
## Acknowledgements
OxiRush is inspired by the [PacketRusher](https://github.com/HewlettPackard/PacketRusher) project, reimplemented in Rust for improved performance and safety.