Skip to content

Cleanup Essex_Hog, update authentication docs #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
valentijnscholten wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Cleanup Essex_Hog, update authentication docs #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,13 +236,13 @@ FLAGS:

OPTIONS:
-a, --allowlist <ALLOWLIST> Sets a custom allowlist JSON file
--authtoken <BEARERTOKEN> Confluence basic auth bearer token (instead of user & pass)
--authtoken <BEARERTOKEN> Confluence basic auth bearer token containing a PAT (instead of user & pass)

--default_entropy_threshold <DEFAULT_ENTROPY_THRESHOLD> Default entropy threshold (0.6 by default)
-o, --outputfile <OUTPUT> Sets the path to write the scanner results to (stdout by default)
--password <PASSWORD> Confluence password (crafts basic auth header)
--password <PASSWORD> Confluence password or PAT (crafts basic auth header)
--regex <REGEX> Sets a custom regex JSON file
--username <USERNAME> Confluence username (crafts basic auth header)
--username <USERNAME> Confluence username or email address (crafts basic auth header)

ARGS:
<PAGEID> The ID (e.g. 1234) of the confluence page you want to scan
Expand All @@ -266,13 +266,13 @@ FLAGS:

OPTIONS:
-a, --allowlist <ALLOWLIST> Sets a custom allowlist JSON file
--authtoken <BEARERTOKEN> Jira basic auth bearer token (instead of user & pass)
--authtoken <BEARERTOKEN> Jira basic auth bearer token containing a PAT (instead of user & pass)
--default_entropy_threshold <DEFAULT_ENTROPY_THRESHOLD> Default entropy threshold (0.6 by default)
--url <JIRAURL> Base URL of JIRA instance (e.g. https://jira.atlassian.net/)
-o, --outputfile <OUTPUT> Sets the path to write the scanner results to (stdout by default)
--password <PASSWORD> Jira password (crafts basic auth header)
--password <PASSWORD> Jira password or PAT (crafts basic auth header)
--regex <REGEX> Sets a custom regex JSON file
--username <USERNAME> Jira username (crafts basic auth header)
--username <USERNAME> Jira username or email address (crafts basic auth header)

ARGS:
<JIRAID> The ID (e.g. PROJECT-123) of the Jira issue you want to scan
Expand Down
30 changes: 15 additions & 15 deletions src/bin/essex_hog.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@
//!
//! OPTIONS:
//! --default_entropy_threshold <DEFAULT_ENTROPY_THRESHOLD> Default entropy threshold (0.6 by default)
//! --authtoken <BEARERTOKEN> Confluence basic auth bearer token (instead of user & pass)
//! --authtoken <BEARERTOKEN> Confluence PAT (instead of user & pass, crafts basic auth header)
//! -o, --outputfile <OUTPUT> Sets the path to write the scanner results to (stdout by default)
//! --password <PASSWORD> Confluence password (crafts basic auth header)
//! --password <PASSWORD> Confluence password or PAT (crafts basic auth header)
//! --regex <REGEX> Sets a custom regex JSON file
//! --username <USERNAME> Confluence username (crafts basic auth header)
//! --username <USERNAME> Confluence username or email address (crafts basic auth header)
//!
//! ARGS:
//! <PAGEID> The ID (e.g. 1234) of the confluence page you want to scan
Expand Down Expand Up @@ -73,7 +73,7 @@ pub struct ConfluencePage {
/// Main entry function that uses the [clap crate](https://docs.rs/clap/2.33.0/clap/)
#[tokio::main]
async fn main() {
let matches = clap_app!(gottingen_hog =>
let matches = clap_app!(essex_hog =>
(version: "1.0.11")
(author: "Emily Cain <ecain@newrelic.com>, Scott Cutler")
(about: "Confluence secret scanner in Rust.")
Expand All @@ -86,9 +86,9 @@ async fn main() {
(@arg CASE: --caseinsensitive "Sets the case insensitive flag for all regexes")
(@arg OUTPUT: -o --outputfile +takes_value "Sets the path to write the scanner results to (stdout by default)")
(@arg PRETTYPRINT: --prettyprint "Outputs the JSON in human readable format")
(@arg USERNAME: --username +takes_value conflicts_with[AUTHTOKEN] "Confluence username (crafts basic auth header)")
(@arg PASSWORD: --password +takes_value conflicts_with[AUTHTOKEN] "Confluence password (crafts basic auth header)")
(@arg BEARERTOKEN: --authtoken +takes_value conflicts_with[USERNAME PASSWORD] "Confluence basic auth bearer token (instead of user & pass)")
(@arg USERNAME: --username +takes_value conflicts_with[AUTHTOKEN] "Confluence username or email for cloud (crafts basic auth header)")
(@arg PASSWORD: --password +takes_value conflicts_with[AUTHTOKEN] "Confluence password or PAT for cloud (crafts basic auth header)")
(@arg BEARERTOKEN: --authtoken +takes_value conflicts_with[USERNAME PASSWORD] "Confluence PAT (instead of user & pass, crafts basic auth header)")
(@arg ALLOWLIST: -a --allowlist +takes_value "Sets a custom allowlist JSON file")
)
.get_matches();
Expand All @@ -107,9 +107,9 @@ async fn run<'b>(arg_matches: ArgMatches<'b>) -> Result<(), SimpleError> {
let ssb = SecretScannerBuilder::new().conf_argm(&arg_matches);
let secret_scanner = ssb.build();

let jirausername = arg_matches.value_of("USERNAME");
let jirapassword = arg_matches.value_of("PASSWORD");
let jiraauthtoken = arg_matches.value_of("BEARERTOKEN");
let confluenceusername = arg_matches.value_of("USERNAME");
let confluencepassword = arg_matches.value_of("PASSWORD");
let confluenceauthtoken = arg_matches.value_of("BEARERTOKEN");
let base_url_input = arg_matches
.value_of("URL")
.unwrap_or("https://confluence.atlassian.com")
Expand All @@ -125,18 +125,18 @@ async fn run<'b>(arg_matches: ArgMatches<'b>) -> Result<(), SimpleError> {
let https = hyper_rustls::HttpsConnector::with_native_roots();
let hyper_client: client::Client<_, hyper::Body> = client::Client::builder().build(https);

// TODO: Support other modes of JIRA authentication
let auth_string = match jirausername {
// craft auth header using username and password if present
// TODO: Support other modes of Confluence authentication
let auth_string = match confluenceusername {
// craft auth header using username and password (or PAT) if present
Some(u) => {
format!(
"Basic {}",
base64::encode(format!("{}:{}", u, jirapassword.unwrap()))
base64::encode(format!("{}:{}", u, confluencepassword.unwrap()))
)
}
// otherwise use AUTHTOKEN to craft the auth header
None => {
format!("Bearer {}", jiraauthtoken.unwrap())
format!("Bearer {}", confluenceauthtoken.unwrap())
}
};

Expand Down
20 changes: 10 additions & 10 deletions src/bin/gottingen_hog.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! Jira secret scanner in Rust.
//! JIRA secret scanner in Rust.
//!
//! USAGE:
//! gottingen_hog [FLAGS] [OPTIONS] <JIRAID> --password <PASSWORD> --username <USERNAME>
Expand All @@ -13,11 +13,11 @@
//!
//! OPTIONS:
//! --default_entropy_threshold <DEFAULT_ENTROPY_THRESHOLD> Default entropy threshold (0.6 by default)
//! --url <JIRAURL>
//! -o, --outputfile <OUTPUT> Sets the path to write the scanner results to (stdout by default)
//! --password <PASSWORD> Jira password (or API token)
//! --regex <REGEX> Sets a custom regex JSON file
//! --username <USERNAME> Jira username
//! --authtoken <BEARERTOKEN> JIRA PAT (instead of user & pass, crafts basic auth header)
//! -o, --outputfile <OUTPUT> Sets the path to write the scanner results to (stdout by default)
//! --password <PASSWORD> JIRA password or PAT (crafts basic auth header)
//! --regex <REGEX> Sets a custom regex JSON file
//! --username <USERNAME> JIRA username or email (crafts basic auth header)
//!
//! ARGS:
//! <JIRAID> The ID (e.g. PROJECT-123) of the Jira issue you want to scan
Expand Down Expand Up @@ -71,9 +71,9 @@ async fn main() {
(@arg CASE: --caseinsensitive "Sets the case insensitive flag for all regexes")
(@arg OUTPUT: -o --outputfile +takes_value "Sets the path to write the scanner results to (stdout by default)")
(@arg PRETTYPRINT: --prettyprint "Outputs the JSON in human readable format")
(@arg USERNAME: --username +takes_value conflicts_with[AUTHTOKEN] "Jira username (crafts basic auth header)")
(@arg PASSWORD: --password +takes_value conflicts_with[AUTHTOKEN] "Jira password (crafts basic auth header)")
(@arg BEARERTOKEN: --authtoken +takes_value conflicts_with[USERNAME PASSWORD] "Jira basic auth bearer token (instead of user & pass)")
(@arg USERNAME: --username +takes_value conflicts_with[AUTHTOKEN] "Jira username or email address (crafts basic auth header)")
(@arg PASSWORD: --password +takes_value conflicts_with[AUTHTOKEN] "Jira password or PAT (crafts basic auth header)")
(@arg BEARERTOKEN: --authtoken +takes_value conflicts_with[USERNAME PASSWORD] "Jira basic auth bearer token containing a PAT (instead of user & pass)")
(@arg JIRAURL: --url +takes_value "Base URL of JIRA instance (e.g. https://jira.atlassian.net/)")
(@arg ALLOWLIST: -a --allowlist +takes_value "Sets a custom allowlist JSON file")
)
Expand Down Expand Up @@ -112,7 +112,7 @@ async fn run<'b>(arg_matches: ArgMatches<'b>) -> Result<(), SimpleError> {

// TODO: Support other modes of JIRA authentication
let auth_string = match jirausername {
// craft auth header using username and password if present
// craft auth header using username and password (or PAT) if present
Some(u) => {
format!(
"Basic {}",
Expand Down