Move protocol module to separate crate in workspace (#6)

Author: Zane Othman

Cargo.toml

@@ -1,21 +1,3 @@
-[package]
-name = "tacacs-plus"
-version = "0.1.0"
-edition = "2021"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
-[features]
-default = ["std"]
-std = ["byteorder/std", "num_enum/std", "md-5/std"]
-docsrs = []
-
-[dependencies]
-bitflags = { version = "2.4.2" }
-byteorder = { version = "1.5.0", default-features = false }
-num_enum = { version = "0.7.2", default-features = false }
-getset = { version = "0.1.2" }
-md-5 = { version = "0.10.6", default-features = false }
-
-[dev-dependencies]
-tinyvec = { version = "1.6.1", features = ["rustc_1_57"] }
+[workspace]
+members = ["tacacs-plus-protocol"]
+resolver = "2"

src/lib.rs

@@ -0,0 +1,20 @@
+[package]
+name = "tacacs-plus-protocol"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[features]
+default = ["std"]
+std = ["byteorder/std", "num_enum/std", "md-5/std"]
+
+[dependencies]
+bitflags = { version = "2.4.2" }
+byteorder = { version = "1.5.0", default-features = false }
+num_enum = { version = "0.7.2", default-features = false }
+getset = { version = "0.1.2" }
+md-5 = { version = "0.10.6", default-features = false }
+
+[dev-dependencies]
+tinyvec = { version = "1.6.1", features = ["rustc_1_57"] }

tacacs-plus-protocol/Cargo.toml

@@ -2,7 +2,7 @@ use std::borrow::ToOwned;
 use std::string::String;
 
 use super::{Reply, Status};
-use crate::protocol::ToOwnedBody;
+use crate::ToOwnedBody;
 
 /// An owned version of a [`Reply`](super::Reply).
 // TODO: stop ignoring dead_code lint when fields are actually used in client

src/protocol/accounting.rs renamed to tacacs-plus-protocol/src/accounting.rs

@@ -1,11 +1,11 @@
 use super::*;
-use crate::protocol::packet::xor_body_with_pad;
-use crate::protocol::{
+use crate::packet::xor_body_with_pad;
+use crate::FieldText;
+use crate::{
     Argument, AuthenticationContext, AuthenticationMethod, AuthenticationService,
     AuthenticationType, HeaderInfo, MajorVersion, MinorVersion, Packet, PacketFlags,
     PrivilegeLevel, UserInformation, Version,
 };
-use crate::FieldText;
 
 use tinyvec::array_vec;
 

src/protocol/accounting/owned.rs renamed to tacacs-plus-protocol/src/accounting/owned.rs

@@ -2,7 +2,7 @@ use std::borrow::ToOwned;
 use std::string::String;
 use std::vec::Vec;
 
-use crate::protocol::ToOwnedBody;
+use crate::ToOwnedBody;
 
 use super::Reply;
 use super::{ReplyFlags, Status};

src/protocol/accounting/tests.rs renamed to tacacs-plus-protocol/src/accounting/tests.rs

@@ -1,9 +1,9 @@
 use super::*;
-use crate::protocol::{
+use crate::FieldText;
+use crate::{
     AuthenticationContext, AuthenticationService, AuthenticationType, HeaderInfo, MajorVersion,
     MinorVersion, Packet, PacketFlags, PrivilegeLevel, UserInformation, Version,
 };
-use crate::FieldText;
 
 use tinyvec::array_vec;
 

src/protocol/arguments.rs renamed to tacacs-plus-protocol/src/arguments.rs

@@ -4,8 +4,8 @@ use std::vec::Vec;
 
 use super::Reply;
 use super::Status;
-use crate::protocol::ArgumentOwned;
-use crate::protocol::ToOwnedBody;
+use crate::ArgumentOwned;
+use crate::ToOwnedBody;
 
 /// An authorization reply packet with owned fields.
 // TODO: stop ignoring dead_code lint when fields are actually used

src/protocol/arguments/owned.rs renamed to tacacs-plus-protocol/src/arguments/owned.rs

@@ -1,11 +1,11 @@
 use super::*;
-use crate::protocol::packet::xor_body_with_pad;
-use crate::protocol::{
+use crate::packet::xor_body_with_pad;
+use crate::FieldText;
+use crate::{
     Arguments, AuthenticationContext, AuthenticationMethod, AuthenticationService,
     AuthenticationType, HeaderInfo, MajorVersion, MinorVersion, Packet, PacketFlags,
     PrivilegeLevel, Serialize, UserInformation, Version,
 };
-use crate::FieldText;
 
 use tinyvec::array_vec;
 
@@ -443,7 +443,7 @@ fn full_unobfuscated_reply_packet_to_owned() {
     use std::string::String;
     use std::vec;
 
-    use crate::protocol::ArgumentOwned;
+    use crate::ArgumentOwned;
 
     let mut raw_packet = array_vec!([u8; 60] =>
         // HEADER

src/protocol/arguments/tests.rs renamed to tacacs-plus-protocol/src/arguments/tests.rs

@@ -1,5 +1,5 @@
-use crate::protocol::MinorVersion;
 use crate::FieldText;
+use crate::MinorVersion;
 
 use super::SerializeError;
 
@@ -59,7 +59,7 @@ impl PrivilegeLevel {
     ///
     /// # Examples
     /// ```
-    /// use tacacs_plus::protocol::PrivilegeLevel;
+    /// use tacacs_plus_protocol::PrivilegeLevel;
     ///
     /// let valid_level = PrivilegeLevel::new(3);
     /// assert!(valid_level.is_some());

src/protocol/authentication.rs renamed to tacacs-plus-protocol/src/authentication.rs

@@ -1,4 +1,15 @@
-//! TACACS+ protocol packet <-> binary format conversions.
+//! # tacacs-plus-protocol
+//!
+//! Serialization & deserialization of (RFC8907) TACACS+ protocol packets.
+
+#![no_std]
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
+#![warn(missing_docs)]
+#![warn(clippy::cast_lossless)]
+#![warn(clippy::cast_possible_truncation)]
+
+#[cfg(feature = "std")]
+extern crate std;
 
 use core::{fmt, num::TryFromIntError};
 
@@ -19,6 +30,9 @@ pub use arguments::ArgumentOwned;
 mod fields;
 pub use fields::*;
 
+mod text;
+pub use text::FieldText;
+
 /// An error that occurred when serializing a packet or any of its components into their binary format.
 #[non_exhaustive]
 #[derive(Debug, PartialEq, Eq)]

src/protocol/authentication/owned.rs renamed to tacacs-plus-protocol/src/authentication/owned.rs

@@ -2,7 +2,7 @@ use byteorder::{ByteOrder, NetworkEndian};
 use getset::{CopyGetters, MutGetters};
 
 use super::{PacketFlags, PacketType};
-use crate::protocol::{DeserializeError, SerializeError, Version};
+use crate::{DeserializeError, SerializeError, Version};
 
 /// Information included in a TACACS+ packet header.
 #[derive(PartialEq, Eq, Debug, Clone, CopyGetters, MutGetters)]
@@ -26,7 +26,7 @@ pub struct HeaderInfo {
 
 impl HeaderInfo {
     /// Size of a full TACACS+ packet header.
-    pub(in crate::protocol) const HEADER_SIZE_BYTES: usize = 12;
+    pub const HEADER_SIZE_BYTES: usize = 12;
 
     /// Bundles some information to be put in the header of a TACACS+ packet.
     pub fn new(version: Version, sequence_number: u8, flags: PacketFlags, session_id: u32) -> Self {

src/protocol/authentication/tests.rs renamed to tacacs-plus-protocol/src/authentication/tests.rs

@@ -1,7 +1,7 @@
 use super::*;
 
-use crate::protocol::accounting::Reply;
-use crate::protocol::{MajorVersion, MinorVersion, Version};
+use crate::accounting::Reply;
+use crate::{MajorVersion, MinorVersion, Version};
 
 #[test]
 fn obfuscated_packet_wrong_unencrypted_flag() {

src/protocol/authorization.rs renamed to tacacs-plus-protocol/src/authorization.rs

@@ -13,7 +13,7 @@ use core::fmt;
 /// Conversions from `&str`:
 ///
 /// ```
-/// use tacacs_plus::FieldText;
+/// use tacacs_plus_protocol::FieldText;
 ///
 /// let valid_ascii = "a string";
 /// assert!(FieldText::try_from(valid_ascii).is_ok());
@@ -25,7 +25,7 @@ use core::fmt;
 /// Conversions from `&[u8]`:
 ///
 /// ```
-/// use tacacs_plus::FieldText;
+/// use tacacs_plus_protocol::FieldText;
 ///
 /// let valid_slice = b"this is (almost) a string";
 /// assert!(FieldText::try_from(valid_slice.as_slice()).is_ok());