1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749
use crate::bitfields::{
ChainAndPubkeyStatus, DsmHeader, DsmKroot, DsmPkr, DsmType, Mack, NewPublicKeyType, NmaHeader,
NmaStatus,
};
use crate::dsm::{CollectDsm, Dsm};
use crate::mack::MackStorage;
use crate::merkle_tree::MerkleTree;
use crate::navmessage::{CollectNavMessage, NavMessageData};
use crate::storage::StaticStorage;
use crate::subframe::CollectSubframe;
use crate::tesla::Key;
use crate::types::{HkrootMessage, InavBand, InavWord, MackMessage, OsnmaDataMessage};
use crate::validation::{NotValidated, Validated};
use crate::{Gst, MerkleTreeNode, PublicKey, Svn};
use core::cmp::Ordering;
/// OSNMA "black box" processing.
///
/// The [`Osnma`] struct gives a way to process OSNMA data using a "black box"
/// approach. INAV words and OSNMA data retrieved from the E1B and E5b signals
/// is fed by the user into `Osnma`, and at any point the user can request
/// `Osnma` to give the most recent authenticated navigation data (provided that
/// it is available).
///
/// # Examples
///
/// ```
/// use galileo_osnma::{Gst, InavBand, Osnma, PublicKey, Svn};
/// use galileo_osnma::storage::FullStorage;
/// use p256::ecdsa::VerifyingKey;
///
/// // Typically, the ECDSA public key should be obtained from
/// // a file. Here a statically defined dummy key is used for
/// // the sake of the example.
/// let pubkey = [3, 154, 36, 205, 5, 122, 110, 166, 187, 238, 33,
/// 117, 116, 91, 202, 57, 34, 72, 200, 202, 10, 169,
/// 253, 225, 1, 233, 82, 99, 133, 255, 241, 114, 218];
/// let pubkey = VerifyingKey::from_sec1_bytes(&pubkey).unwrap();
/// let public_key_id = 0;
/// let pubkey = PublicKey::from_p256(pubkey, public_key_id);
/// // Force the public key to be valid. Only do this if the key
/// // has been loaded from a trustworthy source.
/// let pubkey = pubkey.force_valid();
///
/// // Create OSNMA black box using full storage (36 satellites and
/// // large enough history for Slow MAC)
/// let only_slowmac = false; // process "fast" MAC as well as Slow MAC
/// let mut osnma = Osnma::<FullStorage>::from_pubkey(pubkey, only_slowmac);
///
/// // Feed some INAV and OSNMA data. Data full of zeros is used here.
/// let svn = Svn::try_from(12).unwrap(); // E12
/// let gst = Gst::new(1177, 175767); // WN 1177, TOW 175767
/// let band = InavBand::E1B;
/// let inav = [0; 16];
/// let osnma_data = [0; 5];
/// osnma.feed_inav(&inav, svn, gst, band);
/// osnma.feed_osnma(&osnma_data, svn, gst);
///
/// // Try to retrieve authenticated data
/// // ADKD=0 and 12, CED and health status for a satellite
/// let ced = osnma.get_ced_and_status(svn);
/// // ADKD=4, Galileo constellation timing parameters
/// let timing = osnma.get_timing_parameters(svn);
/// ```
///
/// # Storage size
///
/// The size of the internal storage used to hold navigation data and MACK
/// messages is defined by the [`StaticStorage`] type parameter `S`. See the
/// [storage](crate::storage) module for a description of how the storage size
/// is defined.
#[derive(Debug, Clone)]
pub struct Osnma<S: StaticStorage> {
subframe: CollectSubframe,
data: OsnmaDsm<S>,
}
// These structures exist only in order to avoid double mutable
// borrows of Osnma because we take references from CollectSubframe
// and CollectDsm
#[derive(Debug, Clone)]
struct OsnmaDsm<S: StaticStorage> {
dsm: CollectDsm,
data: OsnmaData<S>,
}
#[derive(Debug, Clone)]
struct OsnmaData<S: StaticStorage> {
navmessage: CollectNavMessage<S>,
mack: MackStorage<S>,
merkle_tree: Option<MerkleTree>,
pubkey: PubkeyStore,
key: KeyStore,
only_slowmac: bool,
}
#[derive(Debug, Clone)]
struct PubkeyStore {
current: Option<PublicKey<Validated>>,
next: Option<PublicKey<Validated>>,
}
// The KeyStore can hold up to two keys: the TESLA key for the current chain in
// force, and an additional KROOT for a chain that will become in force in the
// future.
#[derive(Debug, Clone)]
struct KeyStore {
keys: [Option<Key<Validated>>; 2],
chain_in_force: Option<ChainInForce>,
}
#[derive(Debug, Clone)]
struct ChainInForce {
cid: u8,
// This is None if the current CID has never replaced a previous different
// CID. Otherwise, it is set to the Gst in which the replacement happened.
start_applicability: Option<Gst>,
}
impl<S: StaticStorage> Osnma<S> {
fn new(
merkle_tree_root: Option<MerkleTreeNode>,
pubkey: Option<PublicKey<Validated>>,
only_slowmac: bool,
) -> Osnma<S> {
Osnma {
subframe: CollectSubframe::new(),
data: OsnmaDsm {
dsm: CollectDsm::new(),
data: OsnmaData {
navmessage: CollectNavMessage::new(),
mack: MackStorage::new(),
merkle_tree: merkle_tree_root.map(MerkleTree::new),
pubkey: pubkey
.map_or_else(PubkeyStore::empty, PubkeyStore::from_current_pubkey),
key: KeyStore::empty(),
only_slowmac,
},
},
}
}
/// Constructs a new OSNMA black box using the Merkle tree root.
///
/// An optional ECDSA public key can be passed in addition to the Merkle
/// tree root. If the ECDSA public key is not passed, the OSNMA black box
/// will need to obtain the public key from a DSM-PKR message. These
/// messages are broadcast only every 6 hours.
///
/// If `only_slowmac` is `true`, only ADKD=12 (Slow MAC) will be processed.
/// This should be used by receivers which have a larger time uncertainty.
/// (See Annex 3 in the
/// [OSNMA Receiver Guidelines](https://www.gsc-europa.eu/sites/default/files/sites/all/files/Galileo_OSNMA_Receiver_Guidelines_for_Test_Phase_v1.0.pdf)).
pub fn from_merkle_tree(
merkle_tree_root: MerkleTreeNode,
pubkey: Option<PublicKey<Validated>>,
only_slowmac: bool,
) -> Osnma<S> {
Osnma::new(Some(merkle_tree_root), pubkey, only_slowmac)
}
/// Constructs a new OSNMA black box using only an ECDSA public key.
///
/// This function is similar to [`Osnma::from_merkle_tree`], but the Merkle
/// tree root is not loaded. Therefore, DSM-PKR verification will not be
/// done, and only the provided ECDSA public key will be used.
///
/// The OSNMA black box will hold the public key `pubkey` and use it to
/// try to authenticate the TESLA root key. The public key cannot be changed
/// after construction.
///
/// If `only_slowmac` is `true`, only ADKD=12 (Slow MAC) will be processed.
/// This should be used by receivers which have a larger time uncertainty.
/// (See Annex 3 in the
/// [OSNMA Receiver Guidelines](https://www.gsc-europa.eu/sites/default/files/sites/all/files/Galileo_OSNMA_Receiver_Guidelines_for_Test_Phase_v1.0.pdf)).
pub fn from_pubkey(pubkey: PublicKey<Validated>, only_slowmac: bool) -> Osnma<S> {
Osnma::new(None, Some(pubkey), only_slowmac)
}
/// Feed an INAV word into the OSNMA black box.
///
/// The black box will store the navigation data in the INAV word for later
/// usage.
///
/// The `svn` parameter corresponds to the SVN of the satellite transmitting
/// the INAV word. This should be obtained from the PRN used for tracking.
///
/// The `gst` parameter gives the GST at the start of the INAV page transmission.
///
/// The `band` parameter indicates the band in which the INAV word was received.
pub fn feed_inav(&mut self, word: &InavWord, svn: Svn, gst: Gst, band: InavBand) {
self.data.data.navmessage.feed(word, svn, gst, band);
}
/// Feed the OSNMA data message from an INAV page into the OSNMA black box.
///
/// The black box will store the data and potentially trigger any new
/// cryptographic checks that this data makes possible.
///
/// The `svn` parameter corresponds to the SVN of the satellite transmitting
/// the INAV word. This should be obtained from the PRN used for tracking.
///
/// The `gst` parameter gives the GST at the start of the INAV page transmission.
pub fn feed_osnma(&mut self, osnma: &OsnmaDataMessage, svn: Svn, gst: Gst) {
if osnma.iter().all(|&x| x == 0) {
// No OSNMA data
return;
}
if let Some((hkroot, mack, subframe_gst)) = self.subframe.feed(osnma, svn, gst) {
self.data.process_subframe(hkroot, mack, svn, subframe_gst);
}
}
/// Try to get authenticated CED and health status data for a satellite.
///
/// This will try to retrieve the most recent authenticated CED and health
/// status data (ADKD=0 and 12) for the satellite with SVN `svn` that is
/// available in the OSNMA storage. If the storage does not contain any
/// authenticated CED and health status data for this SVN, this returns
/// `None`.
pub fn get_ced_and_status(&self, svn: Svn) -> Option<NavMessageData> {
self.data.data.navmessage.get_ced_and_status(svn)
}
/// Try to get authenticated timing parameters for a satellite.
///
/// This will try to retrieve the most recent authenticated timing
/// parameters data (ADKD=4) for the satellite with SVN `svn` that is
/// available in the OSNMA storage. If the storage does not contain any
/// authenticated timing parameters data for this SVN, this returns `None`.
pub fn get_timing_parameters(&self, svn: Svn) -> Option<NavMessageData> {
self.data.data.navmessage.get_timing_parameters(svn)
}
}
impl<S: StaticStorage> OsnmaDsm<S> {
fn process_subframe(&mut self, hkroot: &HkrootMessage, mack: &MackMessage, svn: Svn, gst: Gst) {
let nma_header = NmaHeader::new(hkroot[0]);
// Note that the NMA status obtained below is retrieved from a NMA
// header which is not validated. However, this NMA status is only
// stored and eventually used for tag validation.
self.data
.mack
.store(mack, svn, gst, nma_header.nma_status());
let dsm_header = &hkroot[1..2].try_into().unwrap();
let dsm_header = DsmHeader(dsm_header);
let dsm_block = &hkroot[2..].try_into().unwrap();
if let Some(dsm) = self.dsm.feed(dsm_header, dsm_block) {
self.data.process_dsm(dsm, nma_header, gst);
}
self.data.validate_key(mack, gst);
}
}
impl<S: StaticStorage> OsnmaData<S> {
fn process_dsm(&mut self, dsm: Dsm, nma_header: NmaHeader<NotValidated>, gst: Gst) {
match dsm.dsm_type() {
DsmType::Kroot => self.process_dsm_kroot(DsmKroot(dsm.data()), nma_header, gst),
DsmType::Pkr => self.process_dsm_pkr(DsmPkr(dsm.data())),
}
}
fn process_dsm_kroot(
&mut self,
dsm_kroot: DsmKroot,
nma_header: NmaHeader<NotValidated>,
gst: Gst,
) {
let pkid = dsm_kroot.public_key_id();
let Some(pubkey) = self.pubkey.applicable_pubkey(pkid) else {
return;
};
match Key::from_dsm_kroot(nma_header, dsm_kroot, pubkey) {
Ok((key, nma_header)) => {
log::info!("verified KROOT with public key id {pkid}");
log::info!("current NMA header: {nma_header:?}");
self.pubkey.make_pkid_current(pkid);
self.key.store_kroot(key, nma_header, gst);
self.process_nma_header(nma_header, pkid);
}
Err(e) => log::error!("could not verify KROOT: {:?}", e),
}
}
fn process_nma_header(&mut self, nma_header: NmaHeader<Validated>, pkid: u8) {
match nma_header.nma_status() {
NmaStatus::Operational => {}
NmaStatus::Test => {
log::info!("NMA status is test");
}
NmaStatus::Reserved => {
log::error!("NMA status has a reserved value; assuming don't use");
}
NmaStatus::DontUse => {
log::warn!("NMA status is don't use");
match nma_header.chain_and_pubkey_status() {
ChainAndPubkeyStatus::ChainRevoked => {
// current chain is revoked
self.key.revoke(nma_header.chain_id());
}
ChainAndPubkeyStatus::PublicKeyRevoked => {
// Current pubkey is revoked. However, according to
// Figure 13 in the OSNMA SIS ICD v1.1, when this
// happens, the PRK and KROOT already refer to the new
// valid pubkey, so pkid is a valid key, and what needs
// to be done is to revoke all the earlier keys.
self.pubkey.revoke(pkid);
// Revokation of a public key also implies a change of
// chain. See 5.4.1 in the OSNMA SIS ICD v1.1
self.key.revoke(nma_header.chain_id());
}
_ => (),
}
}
}
let this_one = !matches!(
nma_header.nma_status(),
NmaStatus::Operational | NmaStatus::Test
);
match nma_header.chain_and_pubkey_status() {
ChainAndPubkeyStatus::Reserved => {
log::error!("CPKS has a reserved value");
}
ChainAndPubkeyStatus::Nominal => (),
ChainAndPubkeyStatus::EndOfChain => {
log::info!("CPKS is end-of-chain");
}
ChainAndPubkeyStatus::ChainRevoked => {
log::warn!(
"CPKS is chain revoked: {} chain has been revoked",
if this_one { "current" } else { "previous" }
);
}
ChainAndPubkeyStatus::NewPublicKey => {
log::info!("CPKS is new public key");
}
ChainAndPubkeyStatus::PublicKeyRevoked => {
log::warn!(
"CPKS is public key revoked: {} key has been revoked",
if this_one { "current" } else { "past" }
);
}
ChainAndPubkeyStatus::NewMerkleTree => {
log::warn!("CPKS is new Merkle tree");
}
ChainAndPubkeyStatus::AlertMessage => {
log::warn!("CPKS is alert message");
self.alert_message_received();
}
}
}
fn alert_message_received(&mut self) {
log::warn!("received OSNMA Alert Message; deleting all cryptographic material");
self.merkle_tree = None;
self.pubkey = PubkeyStore::empty();
self.key = KeyStore::empty();
}
fn process_dsm_pkr(&mut self, dsm_pkr: DsmPkr) {
match dsm_pkr.new_public_key_type() {
NewPublicKeyType::EcdsaKey(_) => self.process_dsm_pkr_npk(dsm_pkr),
NewPublicKeyType::OsnmaAlertMessage => self.process_dsm_pkr_alert_message(dsm_pkr),
NewPublicKeyType::Reserved => {
log::error!("reserved NPKT in DSM-PKR: {:?}", dsm_pkr);
}
}
}
fn process_dsm_pkr_npk(&mut self, dsm_pkr: DsmPkr) {
let Some(merkle_tree) = &self.merkle_tree else {
log::error!("could not verify public key because Merkle tree is not loaded");
return;
};
match merkle_tree.validate_pkr(dsm_pkr) {
Ok(pubkey) => {
log::info!("verified public key in DSM-PKR: {dsm_pkr:?}");
self.pubkey.store_new_pubkey(pubkey);
}
Err(e) => log::error!("could not verify public key: {e:?}"),
}
}
fn process_dsm_pkr_alert_message(&mut self, dsm_pkr: DsmPkr) {
let Some(merkle_tree) = &self.merkle_tree else {
log::error!("could not verify OSNMA Alert Message because Merkle tree is not loaded");
return;
};
match merkle_tree.validate_alert_message(dsm_pkr) {
Ok(()) => {
log::warn!("received valid OSNMA Alert Message in DSM-PKR: {dsm_pkr:?}");
self.alert_message_received();
}
Err(e) => log::error!("could not verify OSNMA Alert Message: {e:?}"),
}
}
fn validate_key(&mut self, mack: &MackMessage, gst: Gst) {
let Some(current_key) = self.key.current_key() else {
log::info!("no valid TESLA key for the chain in force. unable to validate MACK key");
return;
};
let mack = Mack::new(
mack,
current_key.chain().key_size_bits(),
current_key.chain().tag_size_bits(),
);
let new_key = Key::from_bitslice(mack.key(), gst, current_key.chain());
match current_key.gst_subframe().cmp(&new_key.gst_subframe()) {
Ordering::Equal => {
// we already have this key; nothing to do
}
Ordering::Greater => {
log::warn!(
"got a key in MACK which is older than our current valid key\
MACK key = {:?}, current valid key = {:?}",
new_key,
current_key
);
}
Ordering::Less => {
// attempt to validate the new key
match current_key.validate_key(&new_key) {
Ok(new_valid_key) => {
log::info!(
"new TESLA key {:?} successfully validated by {:?}",
new_valid_key,
current_key
);
self.key.store_key(new_valid_key);
self.process_tags(&new_valid_key);
}
Err(e) => log::error!(
"could not validate TESLA key {:?} using {:?}: {:?}",
new_key,
current_key,
e
),
}
}
}
}
fn process_tags(&mut self, current_key: &Key<Validated>) {
let gst_mack = current_key.gst_subframe().add_seconds(-30);
let gst_slowmac = gst_mack.add_seconds(-300);
// Try to re-generate the key that was used for the MACSEQ of the
// Slow MAC MACK. This key might be from a previous chain.
let gst_k_slowmac = current_key.gst_subframe().add_seconds(-300);
let slowmac_chain_key = self.key.key_past_chain(gst_k_slowmac);
let slowmac_key = slowmac_chain_key.and_then(|k| {
let derivations = k.gst_subframe().subframes_difference(gst_k_slowmac);
if derivations >= 0 {
Some(k.derive(derivations.try_into().unwrap()))
} else {
None
}
});
for svn in Svn::iter() {
if !self.only_slowmac {
if let Some((mack, nma_status)) = self.mack.get(svn, gst_mack) {
let mack = Mack::new(
mack,
current_key.chain().key_size_bits(),
current_key.chain().tag_size_bits(),
);
if let Some(mack) = Self::validate_mack(mack, current_key, svn, gst_mack) {
self.navmessage
.process_mack(mack, current_key, svn, gst_mack, nma_status);
};
}
}
// Try to validate Slow MAC
// This needs fetching a tag which is 300 seconds older than for
// the other ADKDs
if let Some(slowmac_key) = &slowmac_key {
if let Some((mack, nma_status)) = self.mack.get(svn, gst_slowmac) {
let mack = Mack::new(
mack,
current_key.chain().key_size_bits(),
current_key.chain().tag_size_bits(),
);
// Note that slowmac_key is used for validation of the MACK, while
// current_key is used for validation of the Slow MAC tags it contains.
if let Some(mack) = Self::validate_mack(mack, slowmac_key, svn, gst_slowmac) {
self.navmessage.process_mack_slowmac(
mack,
current_key,
svn,
gst_slowmac,
nma_status,
);
}
}
}
}
}
fn validate_mack<'a>(
mack: Mack<'a, NotValidated>,
key: &Key<Validated>,
prna: Svn,
gst_mack: Gst,
) -> Option<Mack<'a, Validated>> {
match mack.validate(key, prna, gst_mack) {
Err(e) => {
log::error!(
"error validating {} {:?} MACK {:?}: {:?}",
prna,
gst_mack,
mack,
e
);
None
}
Ok(m) => Some(m),
}
}
}
impl PubkeyStore {
fn empty() -> PubkeyStore {
PubkeyStore {
current: None,
next: None,
}
}
fn from_current_pubkey(current_key: PublicKey<Validated>) -> PubkeyStore {
PubkeyStore {
current: Some(current_key),
next: None,
}
}
fn check_consistency(&self) {
// consistency check: if next is Some, current must also be Some
assert!(self.next.is_none() || self.current.is_some());
}
fn applicable_pubkey(&self, pkid: u8) -> Option<&PublicKey<Validated>> {
self.check_consistency();
match (&self.current, &self.next) {
(Some(k), _) if k.public_key_id() == pkid => Some(k),
(_, Some(k)) if k.public_key_id() == pkid => {
log::info!("selecting next public key to authenticate KROOT");
Some(k)
}
(Some(_), _) => {
log::error!(
"could not verify KROOT because public key with id {pkid} is not available"
);
None
}
(None, _) => {
log::error!("could not verify KROOT because no public key is available");
None
}
}
}
fn make_pkid_current(&mut self, pkid: u8) {
self.check_consistency();
if self.current.as_ref().map(|k| k.public_key_id()) == Some(pkid) {
// pkid is already current
return;
}
if self.next.as_ref().map(|k| k.public_key_id()) == Some(pkid) {
// consistency check: the PKID of self.current should be smaller
// (and self.current cannot be None)
assert!(self.current.as_ref().unwrap().public_key_id() < pkid);
self.current.replace(self.next.take().unwrap());
return;
}
// this should not be reached, because the KROOT has been authenticated
// with one of the keys in the store
panic!("inconsistent PubkeyStore state");
}
fn store_new_pubkey(&mut self, pubkey: PublicKey<Validated>) {
self.check_consistency();
let new_pkid = pubkey.public_key_id();
if let Some(current) = &self.current {
let curr_pkid = current.public_key_id();
if new_pkid < curr_pkid {
log::error!("received public key with id {new_pkid} smaller than current id {curr_pkid}; discarding");
return;
}
if new_pkid == curr_pkid {
// key is already stored in current
return;
}
if let Some(next) = &self.next {
let next_pkid = next.public_key_id();
match new_pkid.cmp(&next_pkid) {
Ordering::Less => log::error!(
"received public key with id {new_pkid} smaller than \
the next id {next_pkid}; discarding"
),
Ordering::Greater => {
log::warn!(
"received public key with id {new_pkid} greater than \
the next id {next_pkid}; overwriting"
);
self.next = Some(pubkey);
}
Ordering::Equal => {
// the same key is already stored; do nothing
}
}
} else {
self.next = Some(pubkey);
}
} else {
// no keys are stored at this moment
self.current = Some(pubkey);
}
}
fn revoke(&mut self, new_pkid: u8) {
let matches = |k: &PublicKey<Validated>| k.public_key_id() < new_pkid;
if self.current.as_ref().map_or(false, matches) {
log::warn!(
"revoking pubkeys earlier than pkid {new_pkid}: \
revoking current pubkey {:?}",
self.current
);
self.current = None;
}
if self.next.as_ref().map_or(false, matches) {
log::warn!(
"revoking pubkeys earlier than pkid {new_pkid}: \
next pubkey {:?}",
self.next
);
self.current = None;
}
}
}
impl KeyStore {
fn empty() -> KeyStore {
KeyStore {
keys: [None; 2],
chain_in_force: None,
}
}
fn store_kroot(&mut self, key: Key<Validated>, nma_header: NmaHeader<Validated>, gst: Gst) {
let kid = key.chain().chain_id();
let cid = nma_header.chain_id();
match (&self.keys[0], &self.keys[1]) {
(Some(k), _) if k.chain().chain_id() == kid => {
// do nothing; we already have a key for the same chain
}
(_, Some(k)) if k.chain().chain_id() == kid => {
// do nothing; we already have a key for the same chain
}
// there is one slot vacant to place the key
(None, _) => {
log::info!("storing KROOT {key:?} in slot 0 (vacant)");
self.keys[0] = Some(key);
}
(_, None) => {
log::info!("storing KROOT {key:?} in slot 1 (vacant)");
self.keys[1] = Some(key);
}
(Some(k0), Some(_)) => {
// both slots are occupied; do not overwrite the slot for the
// current chain
if k0.chain().chain_id() == cid {
log::info!("overwriting slot 1 with KROOT {key:?}");
self.keys[1] = Some(key);
} else {
log::info!("overwriting slot 0 with KROOT {key:?}");
self.keys[0] = Some(key);
}
}
}
// update chain in force
self.chain_in_force = Some(ChainInForce {
cid,
start_applicability: self.chain_in_force.as_ref().and_then(|cif| {
if cif.cid != cid {
Some(gst)
} else {
None
}
}),
});
}
fn store_key(&mut self, key: Key<Validated>) {
let id = key.chain().chain_id();
match (&self.keys[0], &self.keys[1]) {
(Some(k), _) if k.chain().chain_id() == id => self.keys[0] = Some(key),
(_, Some(k)) if k.chain().chain_id() == id => self.keys[1] = Some(key),
_ => {
// This should not happen, because the TESLA key 'key' was
// validated with one of the keys stored here, so it must belong
// to the same chain.
unreachable!();
}
}
}
fn current_key(&self) -> Option<&Key<Validated>> {
self.chain_in_force.as_ref().and_then(|cif| {
self.keys
.iter()
.flatten()
.find(|&&k| k.chain().chain_id() == cif.cid)
})
}
// Similar to current_key but returns a key from the other chain if the
// requested GST is before the start of applicability of the current
// chain. This is used to get the key for MACK validation for Slow MAC.
fn key_past_chain(&self, gst: Gst) -> Option<&Key<Validated>> {
self.chain_in_force
.as_ref()
.and_then(|cif| match cif.start_applicability {
Some(gst0) if gst0 > gst => {
// Requested time is before the start of the applicability.
// Get the key from the other slot (if occupied).
self.keys
.iter()
.flatten()
.find(|&&k| k.chain().chain_id() != cif.cid)
}
_ => self.current_key(),
})
}
fn revoke(&mut self, cid: u8) {
for k in &mut self.keys {
if let Some(key) = k {
if key.chain().chain_id() == cid {
log::warn!("revoking TESLA key {:?}", key);
*k = None;
}
}
}
}
}