Rename SettingValue to Setting. (#286)

Breaking change, but the crate is fresh and there's time to yank and
republish.
This commit is contained in:
Tony Arcieri (iqlusion)
2021-07-12 17:36:42 -07:00
committed by GitHub
parent 224d346f09
commit 42ae5fb974
3 changed files with 12 additions and 12 deletions
+2 -2
View File
@@ -153,7 +153,7 @@ pub mod piv;
mod policy; mod policy;
pub mod reader; pub mod reader;
mod serialization; mod serialization;
mod settings; mod setting;
mod transaction; mod transaction;
mod yubikey; mod yubikey;
@@ -167,7 +167,7 @@ pub use crate::{
piv::Key, piv::Key,
policy::{PinPolicy, TouchPolicy}, policy::{PinPolicy, TouchPolicy},
reader::Context, reader::Context,
settings::{SettingSource, SettingValue}, setting::{Setting, SettingSource},
yubikey::{CachedPin, Serial, Version, YubiKey}, yubikey::{CachedPin, Serial, Version, YubiKey},
}; };
+5 -5
View File
@@ -48,7 +48,7 @@ use crate::{
error::{Error, Result}, error::{Error, Result},
policy::{PinPolicy, TouchPolicy}, policy::{PinPolicy, TouchPolicy},
serialization::*, serialization::*,
settings, setting,
yubikey::YubiKey, yubikey::YubiKey,
Buffer, ObjectId, 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_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."; 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 { match algorithm {
AlgorithmId::Rsa1024 | AlgorithmId::Rsa2048 => { AlgorithmId::Rsa1024 | AlgorithmId::Rsa2048 => {
@@ -489,17 +489,17 @@ pub fn generate(
&& (yubikey.version.minor < 3 && (yubikey.version.minor < 3
|| yubikey.version.minor == 3 && (yubikey.version.patch < 5)) || 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 { let psz_msg = match setting_roca.source {
settings::SettingSource::User => { setting::SettingSource::User => {
if setting_roca.value { if setting_roca.value {
SZ_ROCA_ALLOW_USER SZ_ROCA_ALLOW_USER
} else { } else {
SZ_ROCA_BLOCK_USER SZ_ROCA_BLOCK_USER
} }
} }
settings::SettingSource::Admin => { setting::SettingSource::Admin => {
if setting_roca.value { if setting_roca.value {
SZ_ROCA_ALLOW_ADMIN SZ_ROCA_ALLOW_ADMIN
} else { } else {
+5 -5
View File
@@ -66,7 +66,7 @@ impl Default for SettingSource {
/// system administrator, or by the local user via `YUBIKEY_PIV_*` environment /// system administrator, or by the local user via `YUBIKEY_PIV_*` environment
/// variables. /// variables.
#[derive(Copy, Clone, Debug)] #[derive(Copy, Clone, Debug)]
pub struct SettingValue { pub struct Setting {
/// Boolean value /// Boolean value
pub value: bool, pub value: bool,
@@ -74,7 +74,7 @@ pub struct SettingValue {
pub source: SettingSource, pub source: SettingSource,
} }
impl SettingValue { impl Setting {
/// Get a [`SettingValue`] value by name. /// Get a [`SettingValue`] value by name.
pub fn get(key: &str, default: bool) -> Self { pub fn get(key: &str, default: bool) -> Self {
Self::from_file(key) Self::from_file(key)
@@ -109,7 +109,7 @@ impl SettingValue {
}; };
if name == key { if name == key {
return Some(SettingValue { return Some(Setting {
source: SettingSource::Admin, source: SettingSource::Admin,
value: value == "1" || value == "true", value: value == "1" || value == "true",
}); });
@@ -124,14 +124,14 @@ impl SettingValue {
fn from_env(key: &str) -> Option<Self> { fn from_env(key: &str) -> Option<Self> {
env::var(format!("YUBIKEY_PIV_{}", key)) env::var(format!("YUBIKEY_PIV_{}", key))
.ok() .ok()
.map(|value| SettingValue { .map(|value| Setting {
source: SettingSource::User, source: SettingSource::User,
value: value == "1" || value == "true", value: value == "1" || value == "true",
}) })
} }
} }
impl Default for SettingValue { impl Default for Setting {
fn default() -> Self { fn default() -> Self {
Self { Self {
value: false, value: false,