From 665cd919337169bdcfc5fb26188f245eec0f426a Mon Sep 17 00:00:00 2001 From: Samuel Boyden Date: Wed, 17 Nov 2021 17:04:10 +0000 Subject: [PATCH 1/2] Various changes - Document Rust logger `Log` struct. - Fix an issue where the client IP address would set it's own IP address, which would result in it just setting it to 127.0.0.1/localhost. Now the *server* gets what IP address the data was received from and sets it correctly serverside. --- loggers/rust/src/lib.rs | 33 +++++++++++++++++++++++---------- server/src/lib.rs | 7 +++++-- 2 files changed, 28 insertions(+), 12 deletions(-) diff --git a/loggers/rust/src/lib.rs b/loggers/rust/src/lib.rs index 3b6730f..093deec 100644 --- a/loggers/rust/src/lib.rs +++ b/loggers/rust/src/lib.rs @@ -1,6 +1,3 @@ -#![feature(with_options, in_band_lifetimes)] -#![allow(incomplete_features)] - mod tests; #[cfg(feature = "full")] @@ -26,8 +23,6 @@ impl Message for T {} #[derive(Debug, Deserialize, Serialize, Clone, PartialEq, Eq)] /// The struct containing the formatted data received from the backtrace. pub struct BacktraceData { - /// The canonical name of the function/closure that called the `Log::log` - /// function. pub name: String, pub file_path: String, pub line_number: u32, @@ -36,13 +31,36 @@ pub struct BacktraceData { } #[derive(Debug, Deserialize, Serialize, Clone, PartialEq, Eq)] +/// The main struct that is sent to the codeCTRL log server. pub struct Log { + /// A [`VecDeque`] of the [`BacktraceData`] generated by the + /// [`log`] function. + /// + /// [`log`]: Self::log pub stack: VecDeque, + /// The line number where the [`log`] function was called. + /// + /// [`log`]: Self::log pub line_number: u32, + /// The code snippet around the line where the [`log`] function was called. + /// + /// [`log`]: Self::log pub code_snippet: BTreeMap, + /// The message that the [`log`] function supplied. + /// + /// [`log`]: Self::log pub message: String, + /// The message type that the [`log`] function supplied. + /// + /// [`log`]: Self::log pub message_type: String, + /// The file name that the [`log`] function was called in. + /// + /// [`log`]: Self::log pub file_name: String, + /// The IP address of the host that the [`log`] function was called on. + /// + /// [`log`]: Self::log pub address: String, #[serde(skip)] _t: PhantomData, @@ -105,11 +123,6 @@ impl Log { .connect(format!("127.0.0.1:{}", port).parse().unwrap()) .await?; - if let Ok(address) = stream.local_addr() { - log.address = - address.to_string().split(':').collect::>()[0].to_string(); - } - let data = serde_cbor::to_vec(log)?; stream.write_all(&data).await?; diff --git a/server/src/lib.rs b/server/src/lib.rs index b9f4f05..7ac244f 100644 --- a/server/src/lib.rs +++ b/server/src/lib.rs @@ -57,7 +57,7 @@ impl Server { let listener = socket.listen(1024)?; loop { - let (mut socket, _) = listener.accept().await?; + let (mut socket, peer_address) = listener.accept().await?; let mut buf = [0; 2048]; @@ -76,7 +76,7 @@ impl Server { break; } - let data = match serde_cbor::from_reader(&buf[..n]) { + let mut data: Log = match serde_cbor::from_reader(&buf[..n]) { Ok(data) => data, Err(e) => { eprintln!("Error: {}", e); @@ -84,6 +84,9 @@ impl Server { }, }; + data.address = peer_address.to_string().split(':').collect::>()[0] + .to_string(); + if let Err(e) = self.sender.send(data) { eprintln!("Failed to send through channel: {}", e); break; From e1b1e3d74a1d6184078abb6f5e25143699ed3c5b Mon Sep 17 00:00:00 2001 From: Samuel Boyden Date: Wed, 17 Nov 2021 17:20:05 +0000 Subject: [PATCH 2/2] Create CODE_OF_CONDUCT.md --- CODE_OF_CONDUCT.md | 128 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 128 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..5744c23 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +codectrl@pwnctrl.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations.