aboutsummaryrefslogtreecommitdiff
Commit message (Collapse)AuthorAge
* Allow missing safety documentation for unsafe functionsHEADmasterRobin Krahl2019-12-17
| | | | | | | Our main function is unsafe as it uses the entry attribute. clippy requires a Safety section in the doc comment of public unsafe functions, but as we don’t have any documentation yet, we disable the clippy::missing_safety_doc lint.
* Test both stable and MSRV Rust versionsRobin Krahl2019-12-17
| | | | | | | Previously, the CI builds only ran on the MSRV Rust version 1.37.0. This patch changes the Rust version for the archlinux build to stable and introduces a new archlinux-msrv build that tries to compile ntw with the MSRV.
* Document the MSRV in the readmeRobin Krahl2019-12-17
| | | | | Due to the static_assertions dependency, we require Rust 1.37.0 or later. This patch adds this information to the readme.
* Remove label from assert_maximum_size macroRobin Krahl2019-12-17
| | | | | | Since static_assertions 1.0.0, we no longer have to specify a label when calling an assert macro. Therefore we can also remove the label from our own assert macro assert_maximum_size.
* Update static_assertions to 1.1.0Robin Krahl2019-12-17
| | | | | | | This patch updates the static_assertions dependency to 1.1.0. This bumps the minimum supported Rust version to 1.37.0. As the labels have been removed in version 1.0.0, we can now call the assertion macros without an additional label.
* Update dependencies to newest versionsRobin Krahl2019-12-17
| | | | | | | | | | | This patch updates all dependencies to the newest versions (except static_assertions). It replaces the Git versions of stm32f103xx-usb and usb-device with crates.io versions of stm32-usbd (via stm32f1xx-hal) and usb-device. This bumps the minimum supported Rust version to 1.36.0 (for stm32-usbd). static_assertions is not updated as it would require an even newer Rust version.
* Use reuse AUR package in lint buildRobin Krahl2019-12-17
|
* Comply with version 3.0 of the REUSE specificationRobin Krahl2019-12-16
| | | | | | The REUSE specification have been updated to version 3.0. To comply with this new version, we have to add copyright information to the .gitignore file.
* Select minimal profile in CI build scriptRobin Krahl2019-12-16
| | | | | To avoid the installation of unnecessary components, we set the rustup profile to minimal in the CI build script archlinux.yml.
* Pin Rust version in CI build script to 1.34.2Robin Krahl2019-12-16
| | | | | For easier debugging and migration, we pin the Rust version in the CI build script archlinux.yml to 1.34.2.
* Split struct Crc into trait Crc and struct Stm32CrcRobin Krahl2019-02-21
| | | | | | | | | | There are different ways to implement the CRC check: For testing, we might want to calulate the CRC in the software. On STM32 MCUs, we want to use the CRC peripheral. This patch splits the struct Crc into the Crc trait and the Stm32Crc struct implementing Crc using the CRC peripheral. The Nitrokey struct can now accept any Crc implementation.
* Output binary size after compilation in build scriptRobin Krahl2019-02-20
|
* Assert maximum size for command request and response structsRobin Krahl2019-02-20
| | | | | | The request and response structs for a command should not be bigger than the buffer they are read from or written to. Therefore we add assertions that enforce this property at compile time.
* Add static assertions for Request and Response sizeRobin Krahl2019-02-20
| | | | | | | | The Request and Response types have to have a size of 64 bytes. Previously, we only verified this property by visual inspection. Accidental changes to the size could lead to runtime errors. This patch adds static assertions using the static_assertions crate to enforce this property at compile time.
* Use arrays instead of slices where possibleRobin Krahl2019-02-20
| | | | | To increase type safety, we use references to (sized) arrays instead of slices where possible.
* Rename commands::COMMAND_LEN to device::RESPONSE_DATA_LENRobin Krahl2019-02-20
| | | | | | | | | Previously, we had the device::REQUEST_DATA_LEN constant for the size of the raw data in the request, and the commands::COMMAND_LEN constant for the size of the raw data in the response. This patch renames commands::COMMAND_LEN to device::RESPONSE_DATA_LEN for consistency. It also introduces the {Request,Response}Data type aliases for [u8; {REQUEST,RESPONSE}_DATA_LEN].
* Validate CRC of incoming dataRobin Krahl2019-02-19
| | | | | | | The data sent with Set_Report requests contains a CRC which we so far ignored. This patch adds a Crc struct that uses the CRC peripheral to calculate the CRC for some data and uses it to validate the CRC of the received data.
* Use ssmarshal to deserialize the request dataRobin Krahl2019-02-19
| | | | | | Previously, we directly accessed the request data by indexing the buffer containing the data. This patch introduces the Request struct which can be deserialized from raw bytes using ssmarshal.
* Use ssmarshal to generate the response dataRobin Krahl2019-02-19
| | | | | | | | | | | Previously, we manually constructed the data to sent with a Get_Report response. This patch introduces the Response struct which can be serialized using ssmarshal. As Serialize is only implemented for arrays with a length up to 32, we have to use the serde-big-array crate for the data field. As the command ID might not be recognized by us, we use a raw u8 value instead of the CommandId enum.
* Implement serde::Serialize in enum_u8Robin Krahl2019-02-19
| | | | | | By providing a custom Serialize implementation, we make sure that enum variants are not mapped to their index, but to their discriminant. This allows us to use serde when preparing the response packet.
* Refactor Command::execute_raw into executeRobin Krahl2019-02-19
| | | | | | | The execute_raw method does not have to be part of the Command trait. In order to simplify the Command trait and to make future changes easier, we remove the execute_raw method and replace it with the execute function.
* Fix formatting in commands.rsRobin Krahl2019-02-18
|
* Use ssmarshal to convert data from and to byte slicesRobin Krahl2019-02-18
| | | | | | Previously, we manually converted the request and response data from and to byte slices. This patch adds the ssmarshal dependency that automates the serialization and deserialization in the required format.
* Refactor command execution into commands moduleRobin Krahl2019-02-18
| | | | | | | | | | | | This patch refactors the command execution. A command is represented by a struct implementing the Command trait. The enum_cmd macro is used to generate a mapping from the CommandId enum to a Command instance and to execute the command. The request and response data is manually converted from and to raw byte slices. As we do not have a standard library, we cannot create a Box<Command> from a CommandId. Instead, we directly delegate the execute method to the corresponding Command.
* Refactor Nitrokey::execute_command to write to a bufferRobin Krahl2019-02-18
| | | | | | To avoid unnecessary allocations and to simplify the code, this patch refactors Nitrokey::execute_command to write the data to a slice instead of returning it as an array.
* Simplify handling of GET_DESCRIPTOR requestsRobin Krahl2019-02-18
| | | | | | | | Previously, we used the ControlIn::accept method and copied the generated buffer returned by HidDevice::report_descriptor to the buffer provided by usb_device::UsbClass in get_report_descriptor. But it is easier to directly pass the returned buffer to ControlIn::accept_with, so we drop the get_report_descriptor method.
* Add usage example to readmeRobin Krahl2019-02-18
|
* Add simple ReadSlotName command implementationRobin Krahl2019-02-18
| | | | | | | This patch adds a simple implementation for the command ReadSlotName that provides access to the names of TOTP and HOTP slots. It returns the name test for the first TOTP slot and the SlotNotProgrammed error for all other slots.
* Add simple GetStatus command implementationRobin Krahl2019-02-18
| | | | | For debugging purposes, we add a simple GetStatus implementation that just reports the firmware version 0.1.
* Implement Nitrokey command handlingRobin Krahl2019-02-18
| | | | | | | This patch changes the Get_Report handler in Nitrokey to extract the command data from the buffer sent with the Set_Report request, to execute a command based on this data and to write appropriate return data back to the device.
* hid: Add support for {Get,Set}_Report requestsRobin Krahl2019-02-18
| | | | | | | | | This patch adds support for Get_Report and Set_Report requests to HidClass. We parse the request metadata and the delegate the request handling to the HidDevice. Our HidDevice implementation, Nitrokey, stores the data sent with Set_Report requests. The Get_Report handling is not implemented yet.
* hid: Add HID and Report descriptorsRobin Krahl2019-02-18
| | | | | | | | | | | HID implementations must provide a HID and a Report descriptor. This patch adds these descriptors. The Report descriptor is copied from the Nitrokey Pro. As the control_in implementation in usb-device only handles GET_DESCRIPTOR requests on the device level, we have to change the control_in method in HidClass to handle GET_DESCRIPTOR on interface level (required for the Report descriptor).
* Add HidDevice trait for device-specific informationRobin Krahl2019-02-18
| | | | | | | | | The HID USB class needs device-specific information – currently, the subclass and the protocol of the device, but also the report descriptors and request handlers once we support these functions. Therefore, this patch introduces the HidDevice trait that provides this data. It also adds a Nitrokey struct that implements this trait for the Nitrokey Pro device.
* hid: Add interrupt_in endpoint to HidClassRobin Krahl2019-02-18
| | | | | | | The HID standard requires an interrupt_in endpoint that can be used to send unrequested data from the device to the driver. This patch adds the interrupt_in endpoint, although there is no code that will ever write to it.
* Add enum_u8 macro to simplify enum conversionRobin Krahl2019-02-18
| | | | | | | | We need several enums that map to a u8 value. This patch adds the enum_u8 macro that automatically derives the From and TryFrom macros for an enum to make these conversions easier. As TryFrom is not stable yet, we add our own TryFrom trait.
* Add USB stack and simple HID implementationRobin Krahl2019-02-18
| | | | | | | | This patch adds the usb-device and stm32f103xx-usb crates that provide a USB stack. It introduces the HidClass struct, a basic implementation of the Human Interface Device (HID) USB class. Devices with that class are recognized as HID devices with the specified vendor and product ID, but do not provide the endpoints required for interaction.
* Initial commitRobin Krahl2019-02-18
generated by cgit v1.2.1 (git 2.18.0) at 2024-04-27 00:56:18 +0000