yubikey v0.4.1 (#288)

Breaking change, but the crate is fresh and there's time to yank and
republish.

CHANGELOG.md

@@ -4,7 +4,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## 0.4.0 (2021-07-12)
+## 0.4.1 (2021-07-12)
+### Changed
+- Rename `SettingValue` to `Setting` ([#286])
+- Rename `Ccc` to `CccId` ([#287])
+
+[#286]: https://github.com/iqlusioninc/yubikey.rs/pull/286
+[#287]: https://github.com/iqlusioninc/yubikey.rs/pull/287
+
+## 0.4.0 (2021-07-12) [YANKED]
 ### Added
 - `Result` alias ([#271])
 

Cargo.lock

@@ -964,7 +964,7 @@ dependencies = [
 
 [[package]]
 name = "yubikey"
-version = "0.4.0"
+version = "0.4.1"
 dependencies = [
  "chrono",
  "cookie-factory",

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name    = "yubikey"
-version = "0.4.0" # Also update html_root_url in lib.rs when bumping this
+version = "0.4.1" # Also update html_root_url in lib.rs when bumping this
 description = """
 Pure Rust cross-platform host-side driver for YubiKey devices from Yubico with
 support for hardware-backed public-key decryption and digital signatures using

src/cccid.rs

@@ -78,9 +78,9 @@ impl CardId {
 
 /// Cardholder Capability Container (CCC) Identifier.
 #[derive(Copy, Clone, Debug, Eq, PartialEq)]
-pub struct Ccc(pub [u8; Self::BYTE_SIZE]);
+pub struct CccId(pub [u8; Self::BYTE_SIZE]);
 
-impl Ccc {
+impl CccId {
     /// CCC size in bytes
     pub const BYTE_SIZE: usize = 51;
 
@@ -115,7 +115,7 @@ impl Ccc {
     }
 }
 
-impl Display for Ccc {
+impl Display for CccId {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         f.write_str(str::from_utf8(&hex::encode(&self.0[..])).unwrap())
     }

src/lib.rs

@@ -131,7 +131,7 @@
 #![cfg_attr(docsrs, feature(doc_cfg))]
 #![doc(
     html_logo_url = "https://raw.githubusercontent.com/iqlusioninc/yubikey.rs/main/img/logo.png",
-    html_root_url = "https://docs.rs/yubikey/0.4.0"
+    html_root_url = "https://docs.rs/yubikey/0.4.1"
 )]
 #![forbid(unsafe_code)]
 #![warn(missing_docs, rust_2018_idioms, trivial_casts, unused_qualifications)]
@@ -153,12 +153,12 @@ pub mod piv;
 mod policy;
 pub mod reader;
 mod serialization;
-mod settings;
+mod setting;
 mod transaction;
 mod yubikey;
 
 pub use crate::{
-    cccid::{CardId, Ccc},
+    cccid::{CardId, CccId},
     certificate::Certificate,
     chuid::ChuId,
     config::Config,
@@ -167,7 +167,7 @@ pub use crate::{
     piv::Key,
     policy::{PinPolicy, TouchPolicy},
     reader::Context,
-    settings::{SettingSource, SettingValue},
+    setting::{Setting, SettingSource},
     yubikey::{CachedPin, Serial, Version, YubiKey},
 };
 

src/piv.rs

@@ -48,7 +48,7 @@ use crate::{
     error::{Error, Result},
     policy::{PinPolicy, TouchPolicy},
     serialization::*,
-    settings,
+    setting,
     yubikey::YubiKey,
     Buffer, ObjectId,
 };
@@ -481,7 +481,7 @@ pub fn generate(
     const SZ_ROCA_BLOCK_ADMIN: &str = "was blocked due to an administrator configuration setting.";
     const SZ_ROCA_DEFAULT: &str = "was permitted by default, but is not recommended.  The default behavior will change in a future Yubico release.";
 
-    let setting_roca: settings::SettingValue;
+    let setting_roca: setting::Setting;
 
     match algorithm {
         AlgorithmId::Rsa1024 | AlgorithmId::Rsa2048 => {
@@ -489,17 +489,17 @@ pub fn generate(
                 && (yubikey.version.minor < 3
                     || yubikey.version.minor == 3 && (yubikey.version.patch < 5))
             {
-                setting_roca = settings::SettingValue::get(SZ_SETTING_ROCA, true);
+                setting_roca = setting::Setting::get(SZ_SETTING_ROCA, true);
 
                 let psz_msg = match setting_roca.source {
-                    settings::SettingSource::User => {
+                    setting::SettingSource::User => {
                         if setting_roca.value {
                             SZ_ROCA_ALLOW_USER
                         } else {
                             SZ_ROCA_BLOCK_USER
                         }
                     }
-                    settings::SettingSource::Admin => {
+                    setting::SettingSource::Admin => {
                         if setting_roca.value {
                             SZ_ROCA_ALLOW_ADMIN
                         } else {

src/setting.rs

@@ -66,7 +66,7 @@ impl Default for SettingSource {
 /// system administrator, or by the local user via `YUBIKEY_PIV_*` environment
 /// variables.
 #[derive(Copy, Clone, Debug)]
-pub struct SettingValue {
+pub struct Setting {
     /// Boolean value
     pub value: bool,
 
@@ -74,8 +74,8 @@ pub struct SettingValue {
     pub source: SettingSource,
 }
 
-impl SettingValue {
-    /// Get a [`SettingValue`] value by name.
+impl Setting {
+    /// Get a setting by name.
     pub fn get(key: &str, default: bool) -> Self {
         Self::from_file(key)
             .or_else(|| Self::from_env(key))
@@ -109,7 +109,7 @@ impl SettingValue {
                 };
 
                 if name == key {
-                    return Some(SettingValue {
+                    return Some(Setting {
                         source: SettingSource::Admin,
                         value: value == "1" || value == "true",
                     });
@@ -124,14 +124,14 @@ impl SettingValue {
     fn from_env(key: &str) -> Option<Self> {
         env::var(format!("YUBIKEY_PIV_{}", key))
             .ok()
-            .map(|value| SettingValue {
+            .map(|value| Setting {
                 source: SettingSource::User,
                 value: value == "1" || value == "true",
             })
     }
 }
 
-impl Default for SettingValue {
+impl Default for Setting {
     fn default() -> Self {
         Self {
             value: false,

src/yubikey.rs

@@ -32,7 +32,7 @@
 
 use crate::{
     apdu::{Apdu, Ins},
-    cccid::Ccc,
+    cccid::CccId,
     chuid::ChuId,
     config::Config,
     error::{Error, Result},
@@ -275,8 +275,8 @@ impl YubiKey {
     }
 
     /// Get Cardholder Capability Container (CCC) Identifier.
-    pub fn cccid(&mut self) -> Result<Ccc> {
-        Ccc::get(self)
+    pub fn cccid(&mut self) -> Result<CccId> {
+        CccId::get(self)
     }
 
     /// Authenticate to the card using the provided management key (MGM).