Skip to content
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.

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

feat(auth): disable auth option #93

Merged
merged 1 commit into from
Nov 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion src/routes/list.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ impl Default for ListQuery {
#[get("/list")]
pub async fn list(
manager: Data<Arc<PulseManager>>,
auth: BasicAuth,
auth: Option<BasicAuth>,
query: web::Query<ListQuery>,
) -> Result<impl Responder> {
if !check_auth(&auth, &manager.settings) {
Expand Down
5 changes: 4 additions & 1 deletion src/routes/login.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ use serde_json::json;
use std::sync::Arc;

#[post("/login")]
pub async fn login(manager: Data<Arc<PulseManager>>, auth: BasicAuth) -> Result<impl Responder> {
pub async fn login(
manager: Data<Arc<PulseManager>>,
auth: Option<BasicAuth>,
) -> Result<impl Responder> {
if !check_auth(&auth, &manager.settings) {
return Ok(HttpResponse::Unauthorized().body("Unauthorized"));
}
Expand Down
2 changes: 1 addition & 1 deletion src/routes/status.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ use std::sync::Arc;
pub async fn status(
id: Path<String>,
manager: Data<Arc<PulseManager>>,
auth: BasicAuth,
auth: Option<BasicAuth>,
) -> Result<impl Responder> {
if !check_auth(&auth, &manager.settings) {
return Ok(HttpResponse::Unauthorized().body("Unauthorized"));
Expand Down
4 changes: 2 additions & 2 deletions src/routes/triggers.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ use tracing::debug;
pub async fn trigger_post(
trigger: Path<String>,
manager: Data<Arc<PulseManager>>,
auth: BasicAuth,
auth: Option<BasicAuth>,
body: Json<serde_json::Value>,
) -> Result<HttpResponse> {
if !check_auth(&auth, &manager.settings) {
Expand Down Expand Up @@ -115,7 +115,7 @@ pub async fn trigger_get(
req: HttpRequest,
trigger: Path<String>,
manager: Data<Arc<PulseManager>>,
auth: BasicAuth,
auth: Option<BasicAuth>,
) -> Result<HttpResponse> {
if !check_auth(&auth, &manager.settings) {
return Ok(HttpResponse::Unauthorized().body("Unauthorized"));
Expand Down
4 changes: 3 additions & 1 deletion src/service/targets/autopulse.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ impl Autopulse {
fn get_client(&self) -> anyhow::Result<reqwest::Client> {
let mut headers = header::HeaderMap::new();

headers.insert("Authorization", self.auth.to_auth_encoded().parse()?);
if self.auth.enabled {
headers.insert("Authorization", self.auth.to_auth_encoded().parse()?);
}

println!("headers: {:?}", headers);

Expand Down
9 changes: 9 additions & 0 deletions src/settings/auth.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,16 @@ fn default_password() -> String {
"password".to_string()
}

#[doc(hidden)]
const fn default_enabled() -> bool {
true
}

#[derive(Deserialize, Clone, Debug)]
pub struct Auth {
/// Whether authentication is enabled (default: true)
#[serde(default = "default_enabled")]
pub enabled: bool,
/// Username for basic auth (default: admin)
#[serde(default = "default_username")]
pub username: String,
Expand All @@ -24,6 +32,7 @@ pub struct Auth {
impl Default for Auth {
fn default() -> Self {
Self {
enabled: default_enabled(),
username: default_username(),
password: default_password(),
}
Expand Down
27 changes: 23 additions & 4 deletions src/tests/utils/check_auth.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ mod tests {
));
let settings: Settings = serde_json::from_str("{}")?;

assert!(check_auth(&auth, &settings));
assert!(check_auth(&Some(auth), &settings));

Ok(())
}
Expand All @@ -21,7 +21,7 @@ mod tests {
let auth = BasicAuth::from(Basic::new("username".to_string(), Some("".to_string())));
let settings: Settings = serde_json::from_str("{}")?;

assert!(!check_auth(&auth, &settings));
assert!(!check_auth(&Some(auth), &settings));

Ok(())
}
Expand All @@ -34,7 +34,7 @@ mod tests {
));
let settings: Settings = serde_json::from_str("{\"auth\":{\"username\":\"username\"}}")?;

assert!(check_auth(&auth, &settings));
assert!(check_auth(&Some(auth), &settings));

Ok(())
}
Expand All @@ -44,7 +44,26 @@ mod tests {
let auth = BasicAuth::from(Basic::new("admin".to_string(), Some("pass".to_string())));
let settings: Settings = serde_json::from_str("{\"auth\":{\"password\":\"pass\"}}")?;

assert!(check_auth(&auth, &settings));
assert!(check_auth(&Some(auth), &settings));

Ok(())
}

#[test]
fn test_check_disabled_auth_provided() -> anyhow::Result<()> {
let auth = BasicAuth::from(Basic::new("admin".to_string(), Some("pass".to_string())));
let settings: Settings = serde_json::from_str("{\"auth\":{\"enabled\": false}}")?;

assert!(check_auth(&Some(auth), &settings));

Ok(())
}

#[test]
fn test_check_disabled_auth_none() -> anyhow::Result<()> {
let settings: Settings = serde_json::from_str("{\"auth\":{\"enabled\": false}}")?;

assert!(check_auth(&None, &settings));

Ok(())
}
Expand Down
12 changes: 11 additions & 1 deletion src/utils/check_auth.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
use crate::settings::Settings;
use actix_web_httpauth::extractors::basic::BasicAuth;

pub fn check_auth(auth: &BasicAuth, settings: &Settings) -> bool {
pub fn check_auth(auth: &Option<BasicAuth>, settings: &Settings) -> bool {
if !settings.auth.enabled {
return true;
}

if auth.is_none() {
return false;
}

let auth = auth.as_ref().unwrap();

let username = settings.auth.username.clone();
let password = settings.auth.password.clone();

Expand Down
Loading