openc2 0.2.0

Rust types for OpenC2 commands and responses
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

//! The OpenC2 Language Specification defines a language used to compose messages that instruct
//! and coordinate the command and control of cyber defenses between and within networks and systems.
//!
//! This crate provides types for OpenC2 commands and responses.
//!
//! # Crate Purpose
//! This crate helps actuator implementers and other cybersecurity vendors interact with OpenC2 messages.

mod command;
mod data;
mod error;
pub mod header;
mod message;
mod notification;
mod profile;
mod response;
pub mod target;
mod traits;

pub use error::{Error, ErrorAt};

#[doc(inline)]
pub use profile::Profile;

#[doc(inline)]
pub use command::{Action, Args, Command, Period};

#[doc(inline)]
pub use data::*;

pub use header::Headers;

#[doc(inline)]
pub use message::{AsBody, AsContent, Body, Content, Message};

pub use notification::Notification;

#[doc(inline)]
pub use target::{Target, TargetType};

#[doc(inline)]
pub use response::{ProfileFeatures, Response, Results, StatusCode};

pub use traits::{Check, IsEmpty};

/// Type aliases for JSON-based OpenC2 messages.
#[cfg(feature = "json")]
pub mod json {
    use serde_json::Value;

    pub type Args = super::Args<Value>;
    pub type Body = super::Body<Content>;
    pub type Content = super::Content<Value>;
    pub type Headers = super::Headers<Value>;
    pub type Message = super::Message<Headers, Body>;
    pub type Command = super::Command<Value>;
    pub type Response = super::Response<Value>;
    pub type Extensions = super::Extensions<Value>;
    pub type Results = super::Results<Value>;
    pub type Target = super::Target<Value>;
}

/// Type aliases for CBOR-based OpenC2 messages.
#[cfg(feature = "cbor")]
pub mod cbor {
    use serde_cbor::Value;

    pub type Args = super::Args<Value>;
    pub type Body = super::Body<Content>;
    pub type Content = super::Content<Value>;
    pub type Headers = super::Headers<Value>;
    pub type Message = super::Message<Headers, Body>;
    pub type Command = super::Command<Value>;
    pub type Response = super::Response<Value>;
    pub type Extensions = super::Extensions<Value>;
    pub type Results = super::Results<Value>;
    pub type Target = super::Target<Value>;
}