Rename AllowedSigner to AllowedSignersEntry

Author: SRv6d

benches/write_allowed_signers.rs

@@ -1,28 +1,28 @@
 use chrono::{Local, TimeZone};
 use codspeed_criterion_compat::{criterion_group, criterion_main, Criterion};
-use hanko::{AllowedSigner, AllowedSignersFile};
+use hanko::{AllowedSignersEntry, AllowedSignersFile};
 
 pub fn criterion_benchmark(c: &mut Criterion) {
     let mut file = AllowedSignersFile {
         file: tempfile::tempfile().unwrap(),
         signers: vec![
-            AllowedSigner {
+            AllowedSignersEntry {
                 principal: "j.snow@wall.com".to_string(),
                 valid_after: None,
                 valid_before: None,
                 key: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIGtQUDZWhs8k/cZcykMkaoX7ZE7DXld8TP79HyddMVTS"
                     .parse()
                     .unwrap(),
             },
-            AllowedSigner {
+            AllowedSignersEntry {
                 principal: "ian.malcom@acme.corp".to_string(),
                 valid_after: Some(Local.with_ymd_and_hms(2024, 4, 11, 22, 00, 00).unwrap()),
                 valid_before: None,
                 key: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILWtK6WxXw7NVhbn6fTQ0dECF8y98fahSIsqKMh+sSo9"
                     .parse()
                     .unwrap(),
             },
-            AllowedSigner {
+            AllowedSignersEntry {
                 principal: "cwoods@universal.exports".to_string(),
                 valid_after: None,
                 valid_before: Some(Local.with_ymd_and_hms(2030, 1, 1, 0, 0, 0).unwrap()),

src/cli/update.rs

@@ -1,11 +1,11 @@
 //! The update subcommand used to get the latest allowed signers and write them to the output file.
-use crate::{AllowedSigner, Config, Source, SshPublicKey};
+use crate::{AllowedSignersEntry, Config, Source, SshPublicKey};
 use std::collections::{HashMap, HashSet};
 
 pub(super) fn update(config: Config) {
     let sources = config.get_sources();
 
-    let mut allowed_signers: HashSet<AllowedSigner> = HashSet::new();
+    let mut allowed_signers: HashSet<AllowedSignersEntry> = HashSet::new();
     if let Some(users) = config.users {
         for user in users {
             let public_keys = get_public_keys((), &sources);

src/lib.rs

@@ -2,13 +2,13 @@
 #![warn(clippy::panic)]
 #![forbid(unsafe_code)]
 
-pub use allowed_signers::{AllowedSigner, AllowedSignersFile};
 pub use config::Config;
 pub use core::*;
+pub use signer::{AllowedSignersEntry, AllowedSignersFile};
 pub use source::Source;
 
-mod allowed_signers;
 pub mod cli;
 mod config;
 mod core;
+mod signer;
 mod source;

src/allowed_signers.rs src/signer.rs

@@ -12,26 +12,26 @@ use std::{
 
 /// A single entry in the allowed signers file.
 #[derive(Debug)]
-pub struct AllowedSigner {
+pub struct AllowedSignersEntry {
     pub principal: String,
     pub valid_after: Option<DateTime<Local>>,
     pub valid_before: Option<DateTime<Local>>,
     pub key: SshPublicKey,
 }
 
-impl AllowedSigner {
+impl AllowedSignersEntry {
     /// The format string for timestamps.
     const TIMESTAMP_FMT: &'static str = "%Y%m%d%H%M%S";
 }
 
-impl fmt::Display for AllowedSigner {
+impl fmt::Display for AllowedSignersEntry {
     /// Display the allowed signer in the format expected by the `allowed_signers` file.
     ///
     /// # Examples
     /// ```
-    /// # use hanko::AllowedSigner;
+    /// # use hanko::AllowedSignersEntry;
     /// # use chrono::{TimeZone, Local};
-    /// let signer = AllowedSigner {
+    /// let signer = AllowedSignersEntry {
     ///     principal: "cwoods@universal.exports".to_string(),
     ///     valid_after: None,
     ///     valid_before: Some(Local.with_ymd_and_hms(2030, 1, 1, 0, 0, 0).unwrap()),
@@ -67,11 +67,11 @@ impl fmt::Display for AllowedSigner {
 #[derive(Debug)]
 pub struct AllowedSignersFile {
     pub file: File,
-    pub signers: Vec<AllowedSigner>,
+    pub signers: Vec<AllowedSignersEntry>,
 }
 
 impl AllowedSignersFile {
-    pub fn new(path: &Path, signers: Vec<AllowedSigner>) -> io::Result<Self> {
+    pub fn new(path: &Path, signers: Vec<AllowedSignersEntry>) -> io::Result<Self> {
         let file = File::create(path)?;
         Ok(Self { file, signers })
     }
@@ -95,8 +95,8 @@ mod tests {
     use std::fs;
 
     #[fixture]
-    fn signer_jsnow() -> AllowedSigner {
-        AllowedSigner {
+    fn signer_jsnow() -> AllowedSignersEntry {
+        AllowedSignersEntry {
             principal: "j.snow@wall.com".to_string(),
             valid_after: None,
             valid_before: None,
@@ -107,8 +107,8 @@ mod tests {
     }
 
     #[fixture]
-    fn signer_imalcom() -> AllowedSigner {
-        AllowedSigner {
+    fn signer_imalcom() -> AllowedSignersEntry {
+        AllowedSignersEntry {
             principal: "ian.malcom@acme.corp".to_string(),
             valid_after: Some(Local.with_ymd_and_hms(2024, 4, 11, 22, 00, 00).unwrap()),
             valid_before: None,
@@ -119,8 +119,8 @@ mod tests {
     }
 
     #[fixture]
-    fn signer_cwoods() -> AllowedSigner {
-        AllowedSigner {
+    fn signer_cwoods() -> AllowedSignersEntry {
+        AllowedSignersEntry {
             principal: "cwoods@universal.exports".to_string(),
             valid_after: None,
             valid_before: Some(Local.with_ymd_and_hms(2030, 1, 1, 0, 0, 0).unwrap()),
@@ -131,7 +131,7 @@ mod tests {
     }
 
     #[fixture]
-    fn example_signers() -> Vec<AllowedSigner> {
+    fn example_signers() -> Vec<AllowedSignersEntry> {
         vec![signer_jsnow(), signer_imalcom(), signer_cwoods()]
     }
 
@@ -148,12 +148,12 @@ mod tests {
         signer_cwoods(),
         "cwoods@universal.exports valid-before=20300101000000 ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJHDGMF+tZQL3dcr1arPst+YP8v33Is0kAJVvyTKrxMw"
     )]
-    fn display_allowed_signer(#[case] signer: AllowedSigner, #[case] expected_display: &str) {
+    fn display_allowed_signer(#[case] signer: AllowedSignersEntry, #[case] expected_display: &str) {
         assert_eq!(signer.to_string(), expected_display);
     }
 
     #[rstest]
-    fn write_allowed_signers_file(example_signers: Vec<AllowedSigner>) {
+    fn write_allowed_signers_file(example_signers: Vec<AllowedSignersEntry>) {
         let path = tempfile::NamedTempFile::new().unwrap().into_temp_path();
         let mut expected_content = String::new();
         for signer in &example_signers {
@@ -171,7 +171,7 @@ mod tests {
     }
 
     #[rstest]
-    fn writing_overrides_existing_content(example_signers: Vec<AllowedSigner>) {
+    fn writing_overrides_existing_content(example_signers: Vec<AllowedSignersEntry>) {
         let existing_content = "gathered dust";
         let mut existing_file = tempfile::NamedTempFile::new().unwrap();
         writeln!(existing_file, "{existing_content}").unwrap();