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

Added new text field remediation_time to Finding and FindingDefinition #330

Merged
merged 6 commits into from
Feb 21, 2025
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
24 changes: 24 additions & 0 deletions kraken/migrations/0023_placeholder.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
[Migration]
Hash = "4514739181779073952"
Initial = false
Dependency = 22
Replaces = []

[[Migration.Operations]]
Type = "CreateField"
Model = "findingdefinition"

[Migration.Operations.Field]
Name = "remediation_duration"
Type = "varchar"

[[Migration.Operations.Field.Annotations]]
Type = "default_value"
Value = ""

[[Migration.Operations.Field.Annotations]]
Type = "max_length"
Value = 255

[[Migration.Operations.Field.Annotations]]
Type = "not_null"
24 changes: 24 additions & 0 deletions kraken/migrations/0024_placeholder.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
[Migration]
Hash = "16214129463165444321"
Initial = false
Dependency = 23
Replaces = []

[[Migration.Operations]]
Type = "CreateField"
Model = "finding"

[Migration.Operations.Field]
Name = "remediation_duration"
Type = "varchar"

[[Migration.Operations.Field.Annotations]]
Type = "default_value"
Value = ""

[[Migration.Operations.Field.Annotations]]
Type = "max_length"
Value = 255

[[Migration.Operations.Field.Annotations]]
Type = "not_null"
56 changes: 30 additions & 26 deletions kraken/src/api/handler/data_export/handler.rs
Original file line number Diff line number Diff line change
Expand Up @@ -323,38 +323,42 @@ pub(crate) async fn export_workspace(
Finding::F.definition.name,
Finding::F.definition.cve,
Finding::F.severity,
Finding::F.remediation_duration,
Finding::F.sorting_weight,
Finding::F.created_at,
)
)
.condition(Finding::F.workspace.equals(path.uuid))
.order_desc(Finding::F.severity)
.order_desc(Finding::F.sorting_weight)
.stream()
.and_then(|(uuid, name, cve, severity, created_at)| {
let affected = affected.remove(&uuid).unwrap_or_default();
let categories = categories.remove(&uuid).unwrap_or_default();
async move {
let (details, _) = GLOBAL
.editor_cache
.finding_export_details
.get(uuid)
.await?
.unwrap_or_default();
Ok((
uuid,
AggregatedFinding {
.and_then(
|(uuid, name, cve, severity, remediation_duration, sorting_weight, created_at)| {
let affected = affected.remove(&uuid).unwrap_or_default();
let categories = categories.remove(&uuid).unwrap_or_default();
async move {
let (details, _) = GLOBAL
.editor_cache
.finding_export_details
.get(uuid)
.await?
.unwrap_or_default();
Ok((
uuid,
name,
cve,
severity: FromDb::from_db(severity),
details,
affected,
created_at,
categories,
},
))
}
})
AggregatedFinding {
uuid,
name,
cve,
severity: FromDb::from_db(severity),
remediation_duration,
sorting_weight,
details,
affected,
created_at,
categories,
},
))
}
},
)
.try_collect()
.await?;

Expand Down
6 changes: 6 additions & 0 deletions kraken/src/api/handler/data_export/schema.rs
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,12 @@ pub struct AggregatedFinding {
/// The finding's severity
pub severity: FindingSeverity,

/// Expected time duration required for the remediation
pub remediation_duration: String,

/// A weight without semantic used to sort findings
pub sorting_weight: i32,

/// The details of this finding
pub details: String,

Expand Down
72 changes: 39 additions & 33 deletions kraken/src/api/handler/finding_affected/handler.rs
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ use crate::models::DomainGlobalTag;
use crate::models::DomainWorkspaceTag;
use crate::models::Finding;
use crate::models::FindingAffected;
use crate::models::FindingDefinition;
use crate::models::FindingDefinitionCategoryRelation;
use crate::models::FindingDetails;
use crate::models::FindingFindingCategoryRelation;
Expand Down Expand Up @@ -152,49 +153,52 @@ pub async fn get_finding_affected(
return Err(ApiError::NotFound);
}

let (finding, finding_details, domain, host, port, service, http_service, details, created_at) =
query_finding_affected(
&mut tx,
(
FindingAffected::F.finding.select_as::<Finding>(),
FindingAffected::F
.finding
.details
.select_as::<FindingDetails>(),
FindingAffected::F.domain,
FindingAffected::F.host,
FindingAffected::F.port,
FindingAffected::F.service,
FindingAffected::F.http_service,
FindingAffected::F.details,
FindingAffected::F.created_at,
),
f_uuid,
a_uuid,
)
.await?
.ok_or(ApiError::NotFound)?;

let (
finding,
finding_details,
finding_definition_uuid,
finding_definition_name,
finding_definition_cve,
finding_definition_severity,
finding_definition_summary,
finding_definition_remediation_duration,
finding_definition_created_at,
domain,
host,
port,
service,
http_service,
details,
created_at,
) = query_finding_affected(
) = query!(
&mut tx,
(
FindingAffected::F.finding.select_as::<Finding>(),
FindingAffected::F
.finding
.details
.select_as::<FindingDetails>(),
FindingAffected::F.finding.definition.uuid,
FindingAffected::F.finding.definition.name,
FindingAffected::F.finding.definition.cve,
FindingAffected::F.finding.definition.severity,
FindingAffected::F.finding.definition.summary,
FindingAffected::F.finding.definition.created_at,
FindingAffected::F.domain,
FindingAffected::F.host,
FindingAffected::F.port,
FindingAffected::F.service,
FindingAffected::F.http_service,
FindingAffected::F.details,
FindingAffected::F.created_at,
),
f_uuid,
a_uuid,
FindingDefinition::F.uuid,
FindingDefinition::F.name,
FindingDefinition::F.cve,
FindingDefinition::F.severity,
FindingDefinition::F.summary,
FindingDefinition::F.remediation_duration,
FindingDefinition::F.created_at,
)
)
.await?
.ok_or(ApiError::NotFound)?;
.condition(FindingDefinition::F.uuid.equals(*finding.definition.key()))
.one()
.await?;

let mut details = if let Some(details) = details {
Some(
Expand Down Expand Up @@ -453,10 +457,12 @@ pub async fn get_finding_affected(
cve: finding_definition_cve,
severity: FromDb::from_db(finding_definition_severity),
summary: finding_definition_summary,
remediation_duration: finding_definition_remediation_duration,
created_at: finding_definition_created_at,
categories: finding_definition_categories,
},
severity: FromDb::from_db(finding.severity),
remediation_duration: finding.remediation_duration,
sorting_weight: finding.sorting_weight,
affected: finding_affected,
#[rustfmt::skip]
Expand Down
9 changes: 9 additions & 0 deletions kraken/src/api/handler/finding_definitions/handler.rs
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ pub async fn create_finding_definition(
impact,
remediation,
references,
remediation_duration,
categories,
} = req.into_inner();

Expand All @@ -89,6 +90,7 @@ pub async fn create_finding_definition(
impact,
remediation,
references,
remediation_duration,
})
.await?;

Expand Down Expand Up @@ -177,6 +179,7 @@ pub async fn get_finding_definition(
remediation: GLOBAL.editor_cache.fd_remediation.get(uuid).await?.ok_or(ApiError::InvalidUuid)?.0,
#[rustfmt::skip]
references: GLOBAL.editor_cache.fd_references.get(uuid).await?.ok_or(ApiError::InvalidUuid)?.0,
remediation_duration: finding_definition.remediation_duration,
created_at: finding_definition.created_at,
categories,
}))
Expand Down Expand Up @@ -229,6 +232,7 @@ pub async fn get_all_finding_definitions() -> ApiResult<Json<ListFindingDefiniti
summary: fd.summary,
severity: FromDb::from_db(fd.severity),
created_at: fd.created_at,
remediation_duration: fd.remediation_duration,
categories: categories.remove(&fd.uuid).unwrap_or_default(),
})
.try_collect()
Expand Down Expand Up @@ -278,6 +282,7 @@ pub async fn update_finding_definition(
name: None,
severity: None,
cve: None,
remediation_duration: None,
categories: None,
}
) {
Expand Down Expand Up @@ -315,6 +320,10 @@ pub async fn update_finding_definition(
FindingDefinition::F.severity,
request.severity.map(IntoDb::into_db),
)
.set_if(
FindingDefinition::F.remediation_duration,
request.remediation_duration.clone(),
)
.finish_dyn_set()
{
update.exec().await?;
Expand Down
10 changes: 10 additions & 0 deletions kraken/src/api/handler/finding_definitions/schema.rs
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ pub struct CreateFindingDefinitionRequest {
///
/// Can link to resources like Mitre's Attack or CME explanations, etc.
pub references: String,
/// Expected time duration required for the remediation
pub remediation_duration: String,
/// List of categories
pub categories: Vec<Uuid>,
}
Expand All @@ -67,6 +69,8 @@ pub struct FullFindingDefinition {
pub remediation: String,
/// Any references to get more information about the definition of a finding.
pub references: String,
/// Expected time duration required for the remediation
pub remediation_duration: String,
/// The point in time this finding definition was created
pub created_at: DateTime<Utc>,
/// The list of categories this finding definition falls into
Expand All @@ -86,6 +90,8 @@ pub struct SimpleFindingDefinition {
pub severity: FindingSeverity,
/// Short summary of the finding
pub summary: String,
/// Expected time duration required for the remediation
pub remediation_duration: String,
/// The point in time this finding definition was created
pub created_at: DateTime<Utc>,
/// The list of categories this finding falls into
Expand Down Expand Up @@ -155,6 +161,10 @@ pub struct UpdateFindingDefinitionRequest {
#[serde(default, deserialize_with = "de_optional")]
pub cve: Option<Option<String>>,

/// Expected time duration required for the remediation
#[serde(skip_serializing_if = "Option::is_none")] // see above
pub remediation_duration: Option<String>,

/// List of categories
#[serde(skip_serializing_if = "Option::is_none")] // see above
pub categories: Option<Vec<Uuid>>,
Expand Down
1 change: 1 addition & 0 deletions kraken/src/api/handler/finding_factory/handler_admin.rs
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ pub async fn get_finding_factory_entries() -> ApiResult<Json<GetFindingFactoryEn
cve: finding.cve,
severity: FromDb::from_db(finding.severity),
summary: finding.summary,
remediation_duration: finding.remediation_duration,
created_at: finding.created_at,
categories,
}),
Expand Down
8 changes: 8 additions & 0 deletions kraken/src/api/handler/findings/handler.rs
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ pub async fn create_finding(
workspace_uuid,
request.definition,
request.severity.into_db(),
request.remediation_duration,
request.export_details,
request.user_details,
None,
Expand Down Expand Up @@ -295,10 +296,12 @@ pub async fn get_finding(
severity: FromDb::from_db(definition.severity),
#[rustfmt::skip]
summary: GLOBAL.editor_cache.fd_summary.get(*finding.definition.key()).await?.ok_or(ApiError::InvalidUuid)?.0,
remediation_duration: definition.remediation_duration,
created_at: definition.created_at,
categories: definition_categories,
},
severity: FromDb::from_db(finding.severity),
remediation_duration: finding.remediation_duration,
sorting_weight: finding.sorting_weight,
affected,
#[rustfmt::skip]
Expand Down Expand Up @@ -344,6 +347,7 @@ pub async fn update_finding(
UpdateFindingRequest {
definition: None,
severity: None,
remediation_duration: None,
sorting_weight: None,
screenshot: None,
log_file: None,
Expand All @@ -369,6 +373,10 @@ pub async fn update_finding(
request.definition.map(ForeignModelByField::Key),
)
.set_if(Finding::F.severity, request.severity.map(IntoDb::into_db))
.set_if(
Finding::F.remediation_duration,
request.remediation_duration.clone(),
)
.set_if(Finding::F.sorting_weight, request.sorting_weight)
.finish_dyn_set()
{
Expand Down
Loading
Loading