Skip to main content

CreateHackerReport

Struct CreateHackerReport 

Source
pub struct CreateHackerReport {
    pub team_handle: String,
    pub title: String,
    pub vulnerability_information: String,
    pub impact: String,
    pub severity_rating: Option<SeverityRating>,
    pub weakness_id: Option<u64>,
    pub structured_scope_id: Option<u64>,
}
Expand description

A hacker report to create (POST /v1/hackers/reports).

Build it with the chainable methods, then submit it with Client::create_report.

The JSON:API body this renders is exactly:

{
  "data": {
    "type": "report",
    "attributes": {
      "team_handle": "chia_network",
      "title": "…",
      "vulnerability_information": "…",
      "impact": "…",
      "severity_rating": "high",
      "weakness_id": 1337,
      "structured_scope_id": 57
    }
  }
}

Fields§

§team_handle: String

Program handle the report is submitted to (required), e.g. chia_network.

§title: String

Report title (required).

§vulnerability_information: String

Detailed write-up: steps to reproduce + supporting material (required).

§impact: String

The security impact an attacker could achieve (required).

§severity_rating: Option<SeverityRating>

Qualitative severity, one of the five documented ratings.

§weakness_id: Option<u64>

Weakness (CWE) object id.

§structured_scope_id: Option<u64>

Structured scope object id this report targets.

Implementations§

Source§

impl CreateHackerReport

Source

pub fn new(team_handle: impl Into<String>, title: impl Into<String>) -> Self

A report for team_handle with title.

Source

pub fn vulnerability_information(self, text: impl Into<String>) -> Self

Set the vulnerability write-up (required by the API).

Source

pub fn impact(self, text: impl Into<String>) -> Self

Set the impact statement (required by the API).

Source

pub fn severity(self, rating: SeverityRating) -> Self

Set the severity rating.

Source

pub fn weakness_id(self, id: u64) -> Self

Attach a weakness (CWE) id.

Source

pub fn structured_scope_id(self, id: u64) -> Self

Pin the structured scope id.

Source

pub fn to_json(&self) -> Result<Value, Error>

Render the JSON:API request body, validating the required fields.

Trait Implementations§

Source§

impl Clone for CreateHackerReport

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CreateHackerReport

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for CreateHackerReport

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for CreateHackerReport

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CreateHackerReport

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.