feat: kid

Author: apskhem

rust/catalyst-types/Cargo.toml

@@ -20,10 +20,16 @@ anyhow = "1.0.95"
 blake2b_simd = "1.0.2"
 coset = "0.3.8"
 ed25519-dalek = "2.1.1"
+fluent-uri = "0.3.2"
 hex = "0.4.3"
 minicbor = { version = "0.25.1", features = ["std"] }
 num-traits = "0.2.19"
 orx-concurrent-vec = "3.1.0"
 pallas-crypto = { version = "0.30.1", git = "https://github.com/input-output-hk/catalyst-pallas.git", rev = "9b5183c8b90b90fe2cc319d986e933e9518957b3" }
 serde = { version = "1.0.217", features = ["derive"] }
-uuid = { version = "1.11.0", features = ["v4", "v7", "serde"] }
+thiserror = "2.0.9"
+base64-url = "3.0.0"
+uuid = { version = "1.11.0", features = ["v4", "v7", "serde"] }
+
+[dev-dependencies]
+rand = "0.8.5"

rust/catalyst-types/README.md

@@ -1,65 +1,9 @@
-# CBOR Kit (`cbork`)
+# Catalyst Types
 
-This is a CLI tool for operating with CDDL and CBOR.
+This library is designed to streamline the organization and sharing of types across multiple crates.
+It provides a centralized location for reusable, enhanced types that are not specific to a particular domain, such as Cardano.
 
-It will grow over time to provide a number of features, and will be supported by individual `cbork-*` crates.
+## Purpose
 
-## Install
-
-To install this tool run
-
-```shell
-cargo install --git https://github.com/input-output-hk/catalyst-libs.git cbork
-```
-
-## Features
-
-### CDDL linter
-
-[CDDL](#cddl-specifications) (Concise Data Definition Language)
-linting CLI tool.
-Enables users to check their CDDL code for errors, inconsistencies, and compliance with the CDDL specification.
-
-#### Currently supports
-
-* [CDDL][1]
-* [CDDL Errata][2]
-* [CDDL Extensions][3]
-
-#### Planned support for
-
-* [CDDL Modules][4]
-* [CDDL Module Standard Library][5]
-
-## Planned Future Tools within the CLI
-
-* [ ] A tool to generate a Rust module to decode/encode/validate Data efficiently from a [CDDL](#cddl-specifications) definition.
-* [ ] A tool to simply validate [CBOR][6] binary data against a [CDDL](#cddl-specifications) definition.
-
-## Notes
-
-There are semantic rules about well-formed [CDDL](#cddl-specifications) files that are not enforced by the grammar.
-The full parser does not support these rules currently, but is planned to be extended to validate
-those rules in future
-
-The primary rule that is not currently enforced is that the very first definition in the file is the base type.
-We also cannot detect orphaned or missing definitions.
-
-Both of these are planned for a future release of the tool.
-
-There may be other checks needed to be performed on the parsed AST for validity.
-
-## CDDL Specifications
-
-* [RFC8610][1]
-* [RFC8610 Errata][2]
-* [RFC9165 CDDL Extensions][3]
-* [CDDL Modules][4]
-* [CDDL Modules Reference][5]
-
-[1]: https://www.rfc-editor.org/rfc/rfc8610 "RFC-8610"
-[2]: https://www.ietf.org/archive/id/draft-ietf-cbor-update-8610-grammar-01.html "RFC-8610 Errata"
-[3]: https://www.rfc-editor.org/rfc/rfc9165 "RFC-9165 CDDL Extensions"
-[4]: https://cbor-wg.github.io/cddl-modules/draft-ietf-cbor-cddl-modules.html "CDDL Modules Specification"
-[5]: https://github.com/cabo/cddlc "CDDL Modules Standard Library"
-[6]: https://datatracker.ietf.org/doc/html/rfc8949 "RFC-8949 CBOR Data Interchange Format"
+* To enhance types that can be utilized across different libraries or projects.
+* To provide utility functions related to types and conversion between types.

rust/catalyst-types/src/kid_uri/authority.rs

@@ -0,0 +1,37 @@
+//! COSE Signature Protected Header `kid` URI Authority.
+
+use std::{
+  fmt::{Display, Formatter},
+  str::FromStr,
+};
+
+/// URI Authority
+#[derive(Debug, Clone)]
+pub enum Authority {
+  /// Cardano Blockchain
+  Cardano,
+  /// Midnight Blockchain
+  Midnight,
+}
+
+impl FromStr for Authority {
+  type Err = anyhow::Error;
+
+  fn from_str(s: &str) -> Result<Self, Self::Err> {
+      match s {
+          "cardano" => Ok(Authority::Cardano),
+          "midnight" => Ok(Authority::Midnight),
+          _ => Err(anyhow::anyhow!("Unknown Authority: {s}")),
+      }
+  }
+}
+
+impl Display for Authority {
+  fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), std::fmt::Error> {
+      let authority = match self {
+          Self::Cardano => "cardano",
+          Self::Midnight => "midnight",
+      };
+      write!(f, "{authority}")
+  }
+}

rust/catalyst-types/src/kid_uri/errors.rs

@@ -0,0 +1,43 @@
+//! Errors returned by this type
+
+use thiserror::Error;
+
+use super::{key_rotation::KeyRotationError, role_index::RoleIndexError};
+
+/// Errors that can occur when parsing a `KidURI`
+#[derive(Error, Debug)]
+pub enum KidURIError {
+    /// Invalid KID URI
+    #[error("Invalid URI")]
+    InvalidURI(#[from] fluent_uri::error::ParseError),
+    /// Invalid Scheme, not a KID URI
+    #[error("Invalid Scheme, not a KID URI")]
+    InvalidScheme,
+    /// Network not defined in URI
+    #[error("No defined Network")]
+    NoDefinedNetwork,
+    /// Path of URI is invalid
+    #[error("Invalid Path")]
+    InvalidPath,
+    /// Role 0 Key in path is invalid
+    #[error("Invalid Role 0 Key")]
+    InvalidRole0Key,
+    /// Role 0 Key in path is not encoded correctly
+    #[error("Invalid Role 0 Key Encoding")]
+    InvalidRole0KeyEncoding(#[from] base64_url::base64::DecodeError),
+    /// Role Index is invalid
+    #[error("Invalid Role")]
+    InvalidRole,
+    /// Role Index is not encoded correctly
+    #[error("Invalid Role Index")]
+    InvalidRoleIndex(#[from] RoleIndexError),
+    /// Role Key Rotation is invalid
+    #[error("Invalid Rotation")]
+    InvalidRotation,
+    /// Role Key Rotation is not encoded correctly
+    #[error("Invalid Rotation Value")]
+    InvalidRotationValue(#[from] KeyRotationError),
+    /// Encryption key Identifier Fragment is not valid
+    #[error("Invalid Encryption Key Fragment")]
+    InvalidEncryptionKeyFragment,
+}

rust/catalyst-types/src/kid_uri/key_rotation.rs

@@ -0,0 +1,42 @@
+//! COSE Signature Protected Header `kid` Role0 Key Version.
+
+use std::{
+  fmt::{Display, Formatter},
+  num::ParseIntError,
+  str::FromStr,
+};
+
+use thiserror::Error;
+
+/// Errors from parsing the `KeyRotation`
+#[derive(Error, Debug)]
+#[allow(clippy::module_name_repetitions)]
+pub enum KeyRotationError {
+  /// Key Rotation could not be parsed from a string
+  #[error("Invalid Role Key Rotation")]
+  InvalidRole(#[from] ParseIntError),
+}
+
+/// Rotation count of the Role Key.
+#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
+pub struct KeyRotation(u16);
+
+impl From<u16> for KeyRotation {
+  fn from(value: u16) -> Self {
+      Self(value)
+  }
+}
+
+impl FromStr for KeyRotation {
+  type Err = KeyRotationError;
+
+  fn from_str(s: &str) -> Result<Self, Self::Err> {
+      Ok(Self(s.parse::<u16>()?))
+  }
+}
+
+impl Display for KeyRotation {
+  fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), std::fmt::Error> {
+      write!(f, "{}", self.0)
+  }
+}