3091b5a29d
This move changes the Env trait: It removes all functionality that is used only in vendor commands (`FirmwareProtection`, `UpgradeStorage`) and adds a function to call when parsing CBOR commands. The abstraction necessary to test these commands is instead realized through compile flags. The mock upgrade storage is active when compiled for std for example.
97 lines
4.0 KiB
Rust
97 lines
4.0 KiB
Rust
// Copyright 2022-2023 Google LLC
|
|
//
|
|
// 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.
|
|
|
|
use crate::api::attestation_store::AttestationStore;
|
|
use crate::api::clock::Clock;
|
|
use crate::api::connection::HidConnection;
|
|
use crate::api::crypto::ecdh::Ecdh;
|
|
use crate::api::crypto::ecdsa::Ecdsa;
|
|
use crate::api::crypto::Crypto;
|
|
use crate::api::customization::Customization;
|
|
use crate::api::key_store::KeyStore;
|
|
use crate::api::rng::Rng;
|
|
use crate::api::user_presence::UserPresence;
|
|
use crate::ctap::Channel;
|
|
use alloc::vec::Vec;
|
|
use persistent_store::{Storage, Store};
|
|
|
|
#[cfg(feature = "std")]
|
|
pub mod test;
|
|
|
|
pub type AesKey<E> = <<E as Env>::Crypto as Crypto>::Aes256;
|
|
pub type EcdhSk<E> = <<<E as Env>::Crypto as Crypto>::Ecdh as Ecdh>::SecretKey;
|
|
pub type EcdhPk<E> = <<<E as Env>::Crypto as Crypto>::Ecdh as Ecdh>::PublicKey;
|
|
pub type EcdsaSk<E> = <<<E as Env>::Crypto as Crypto>::Ecdsa as Ecdsa>::SecretKey;
|
|
pub type EcdsaPk<E> = <<<E as Env>::Crypto as Crypto>::Ecdsa as Ecdsa>::PublicKey;
|
|
pub type EcdsaSignature<E> = <<<E as Env>::Crypto as Crypto>::Ecdsa as Ecdsa>::Signature;
|
|
pub type Sha<E> = <<E as Env>::Crypto as Crypto>::Sha256;
|
|
pub type Hmac<E> = <<E as Env>::Crypto as Crypto>::Hmac256;
|
|
pub type Hkdf<E> = <<E as Env>::Crypto as Crypto>::Hkdf256;
|
|
|
|
/// Describes what CTAP needs to function.
|
|
pub trait Env {
|
|
type Rng: Rng;
|
|
type UserPresence: UserPresence;
|
|
type Storage: Storage;
|
|
type KeyStore: KeyStore;
|
|
type Write: core::fmt::Write;
|
|
type Customization: Customization;
|
|
type HidConnection: HidConnection;
|
|
type AttestationStore: AttestationStore;
|
|
type Clock: Clock;
|
|
type Crypto: Crypto;
|
|
|
|
fn rng(&mut self) -> &mut Self::Rng;
|
|
fn user_presence(&mut self) -> &mut Self::UserPresence;
|
|
fn store(&mut self) -> &mut Store<Self::Storage>;
|
|
fn key_store(&mut self) -> &mut Self::KeyStore;
|
|
fn attestation_store(&mut self) -> &mut Self::AttestationStore;
|
|
fn clock(&mut self) -> &mut Self::Clock;
|
|
|
|
/// Creates a write instance for debugging.
|
|
///
|
|
/// This API doesn't return a reference such that drop may flush. This matches the Tock
|
|
/// environment. Non-Tock embedded environments should use the defmt feature (to be implemented
|
|
/// using the defmt crate) and ignore this API. Non-embedded environments may either use this
|
|
/// API or use the log feature (to be implemented using the log crate).
|
|
fn write(&mut self) -> Self::Write;
|
|
|
|
fn customization(&self) -> &Self::Customization;
|
|
|
|
/// I/O connection for sending packets implementing CTAP HID protocol.
|
|
fn main_hid_connection(&mut self) -> &mut Self::HidConnection;
|
|
|
|
/// I/O connection for sending packets implementing vendor extensions to CTAP HID protocol.
|
|
#[cfg(feature = "vendor_hid")]
|
|
fn vendor_hid_connection(&mut self) -> &mut Self::HidConnection;
|
|
|
|
/// Option to return a firmware version that is shown as device info.
|
|
fn firmware_version(&self) -> Option<u64> {
|
|
None
|
|
}
|
|
|
|
/// Option to process a CBOR command before standard parsing.
|
|
///
|
|
/// Responses are sent on the same channel they were received. Return `None` to continue
|
|
/// regular parsing. Parsing vendor commands may still have side effects, like dropping state
|
|
/// from other commands.
|
|
///
|
|
/// For standard commands, the format for bytes is one byte of CTAP2 command and a CBOR encoded
|
|
/// map. To be able to reliably detect your payload, consider starting your messages with a
|
|
/// vendor reserved command byte.
|
|
fn process_vendor_command(&mut self, _bytes: &[u8], _channel: Channel) -> Option<Vec<u8>> {
|
|
None
|
|
}
|
|
}
|