Rust implementation of the IEEE 1278.1-2012 Distributed Interactive Simulation (DIS) application protocol
Home Page: https://crates.io/crates/open-dis-rust
License: BSD 2-Clause "Simplified" License
I'm a professional software developer with experience in C++, Python, JavaScript, Lua, and Fortran. I'm currently learning Rust through personal projects.
In the previous commit to main, some of the new data types introduced for the remaining PDUs were placed into separate data_type directories within their respective PDU family directories. This would be nice for cleaning up the file structure and keeping PDUs in one place and their requisite data type definitions in another.
Move non-PDU data types to their own directory for the sake of file structure cleanliness and organization.
No response
The Minefield Family of PDUs is one of the last families not currently implemented in this library. To be completely compliant with the IEEE 1278.1 standard, this family must be fully implemented.
As with the other families, create the minefield module and implement the structs representing all of the PDUs in this PDU family.
No response
0.1.0-alpha.6
Linux 6.5.6-76060506-generic x86_64 x86_64
dat in this example is a Vec<u8>, and if I try to deserialize it, it just says Err(InvalidDISHeader), but when I deserialize without header, it deserializes as expected.
loop {
let dat = match conn.recv().await.unwrap();
let mut bytes = BytesMut::from(dat.as_slice());
let pdu_header = PduHeader::decode(&mut bytes);
let body_data = BytesMut::from(&dat[12..]);
match pdu_header.pdu_type {
PduType::Transmitter => {
// this does not work
//let xmsn = TransmitterPdu::deserialize(bytes);
// this *does* work
let xmsn = TransmitterPdu::deserialize_without_header(body_data, pdu_header);
println!("{:?}", xmsn);
println!("{:?}", pdu_header.pdu_type);
println!("{:?}", PduType::Transmitter);
println!("{:?}", pdu_header);
},
_ => continue,
}
}So with
let xmsn = TransmitterPdu::deserialize(bytes);the output is:
Err(InvalidDISHeader)
Transmitter
Transmitter
PduHeader { protocol_version: IEEE1278_1A_1998, exercise_id: 1, pdu_type: Transmitter, protocol_family: RadioCommunications, timestamp: 3066130581, length: 104, padding: 0 }
But with
let xmsn = TransmitterPdu::deserialize_without_header(body_data, pdu_header);The output is:
Ok(TransmitterPdu { pdu_header: PduHeader { protocol_version: IEEE1278_1A_1998, exercise_id: 1, pdu_type: Transmitter, protocol_family: RadioCommunications, timestamp: 3459835265, length: 104, padding: 0 }, entity_id: EntityId { simulation_address: SimulationAddress { site_id: 50, application_id: 2 }, entity_id: 5 }, radio_id: 1, radio_entity_type: RadioEntityType { entity_kind: 7, domain: 0, country: 0, category: 0, nomenclature_version: 0, nomenclature: 0 }, transmit_state: 2, input_source: 0, padding1: 0, antenna_location: Vector3Double { x: 0.0, y: 0.0, z: 0.0 }, relative_antenna_location: Vector3Float { x: 0.0, y: 0.0, z: 0.0 }, antenna_pattern_type: 0, antenna_pattern_count: 0, frequency: 100, transmit_frequency_bandwidth: 25000.0, power: 40.0, modulation_type: ModulationType { spread_spectrum: 0, major: 0, detail: 0, system: 0 }, crypto_system: 0, crypto_key_id: 0, modulation_parameter_count: 0, padding2: 0, padding3: 0, modulation_parameter_list: [], antenna_pattern_list: [] })
Transmitter
Transmitter
PduHeader { protocol_version: IEEE1278_1A_1998, exercise_id: 1, pdu_type: Transmitter, protocol_family: RadioCommunications, timestamp: 3459835265, length: 104, padding: 0 }
Transmission::deserialize should be able to take a BytesMut containing a pdu and pdu header, and deserialize it into a TranssmissionPdu
Transmission::deserialize cannot take a BytesMut containing a pdu and pdu header, and deserialize it into a TranssmissionPdu
I have also seen this exact case with SignalPdu as well. I looked at the source code and it doesn't make sense why it would fail to detect the proper pdu_type, but for some reason that is the case. Am I doing something wrong here?
The Entity Management Family of PDUs is not fully implemented at this point. To be completely compliant with the IEEE 1278.1 standard, this family must be fully implemented.
Create the entity management module and implement the structs representing all of the PDUs in this PDU family.
No response
0.1.0-alpha.6
Linux 6.5.6-76060506-generic x86_64 x86_64
let sig = SignalPdu::deserialize_without_header(body_data, pdu_header);where body_data contains a signal pdu with 16 bit pcm encoded voice audio data
The panic appears to initiate from this line:
To deserialize the signal pdu successfully, or at least return an error saying the parsing failed and that 16 bit encodings aren't supported
The library panics without possibility of recovery or error handling
No response
There is a large quantity of enumerations within this project, and at this time, their definitions are scattered throughout the various submodules. It can be confusing to the end user to know which submodule each enumeration resides in.
It would be beneficial to migrate those all into a central, dedicated module containing only those enums.
No response
When initially implementing all the PDUs, I just input a dummy value for their size in bytes (this information is stored in the PDU header). Most of the PDUs have dynamic sizes, and even the ones that are static are probably incorrect.
Go through and adjust the statically sized PDUs to be the correct size, and then find a way to set sizes for PDUs that have dynamic fields. Some PDUs, as per the standard, have a fairly complex size calculation.
None. This must be corrected.
There are nine (9) PDUs remaining to be implemented.
Define these remaining PDUs, and then cut the next release. Will push other open issues to 0.1.0-alpha.10.
No response
The RadioCommunications family of PDUs have not been implemented yet. To be fully compliant with the IEEE 1278.1 standard, these must be implemented in accordance with the standard's definitions.
Consult the IEEE 1278.1 standard to map the definitions for the RadioCommunications family of PDUs into working, tested Rust code.
No response
The Logistics Family of PDUs is not fully implemented at this point. To be completely compliant with the IEEE 1278.1 standard, this family must be fully implemented.
Create the logistics module and implement the structs representing all of the PDUs in this PDU family.
No response
Gridded Data PDU is not completely implemented due to some implicit complexities within the IEEE specification. This needs to be addressed for completeness and parity with the IEEE spec.
Implement the remaining data types and parameters necessary to completely address the specification requirements for the Gridded Data PDU.
No response
The Synthetic Environment Family of PDUs is not fully implemented at this point. To be completely compliant with the IEEE 1278.1 standard, this family must be fully implemented.
Create the synthetic environment module and implement the structs representing all of the PDUs in this PDU family.
No response
Documentation is missing
Every PDU and type defined within the IEEE 1278.1-2012 standard should have appropriate Rust documentation that provides details about the type as well as a section reference for pointing users to the definition in the official documentation.
This is a known issue. A majority of the structs' documentation is either missing or incorrect.
0.1.0-alpha.9
linux x86_64
Follow the steps as shown in the README.
The client and server should send and receive a PDU and then print the data.
I know that this does not work at the time. I did not get the PDU sending logic in before publishing 0.1.0-alpha.9. The output is currently just some dummy data that was ripped from a tokio example.
No response
The CI pipeline runs on the latest main branch version and produces a security report. This report needs to be addressed between each push or release to keep the incidents down or at zero.
Address each of the security concerns provided in the security report under the Security tab.
No response
Lots of Rust clippy issues have been flagged under security. At the time of making this issue, 208 issues have been marked by the clippy job. These should be addressed as soon as possible.
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.