konarr 0.5.1

Konarr
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

//! Server Information
use serde::{Deserialize, Serialize};

/// Server Information
#[derive(Debug, Default, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ServerInfo {
    /// Server Version
    pub version: String,
    /// Server Commit Hash
    pub commit: String,
    /// Server Configuration
    pub config: Option<ServerConfig>,
    /// Server User
    pub user: Option<User>,
    /// Summary of Konarr Projects
    pub projects: Option<ProjectsSummary>,
    /// Summary of Dependencies
    pub dependencies: Option<DependencySummary>,
    /// Security Summary
    pub security: Option<SecuritySummary>,
    /// Agent Settings
    pub agent: Option<AgentSettings>,
}

impl ServerInfo {
    /// Get the semver version
    pub fn version(&self) -> Result<semver::Version, crate::KonarrError> {
        Ok(semver::Version::parse(&self.version)?)
    }
}

/// Server Configuration
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ServerConfig {
    /// Is Server Initialised
    pub initialised: bool,
    /// Is Server Registration Enabled
    pub registration: bool,
}

/// User Information
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct User {
    /// Username
    pub username: String,
    /// User Role
    pub role: String,
    /// User Avatar
    pub avatar: Option<String>,
}

/// Konarr Project Summary
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ProjectsSummary {
    /// Total Projects
    pub total: u32,
    /// Servers
    pub servers: u32,
    /// Containers
    pub containers: u32,
}

/// Dependency Summary
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct DependencySummary {
    /// Total Dependencies
    pub total: u32,
    /// Libraries
    pub libraries: u32,
    /// Frameworks
    pub frameworks: u32,
    /// Operating Systems
    #[serde(rename = "operating-systems")]
    pub operating_systems: u32,
    /// Programming Languages
    pub languages: u32,
    #[serde(rename = "package-managers")]
    /// Package Managers
    pub package_managers: u32,
    /// Compression Libraries
    #[serde(rename = "compression-libraries")]
    pub compression_libraries: u32,
    /// Cryptographic Libraries
    #[serde(rename = "cryptographic-libraries")]
    pub cryptographic_libraries: u32,
    /// Database (Application or Libraries)
    pub databases: u32,
    /// Operating Environments
    #[serde(rename = "operating-environments")]
    pub operating_environments: u32,
    /// Middleware
    pub middleware: u32,
}

/// Security Summary
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct SecuritySummary {
    /// Total Security Issues
    pub total: u32,
    /// Critical Security Issues
    pub critical: u32,
    /// High Security Issues
    pub high: u32,
    /// Medium Security Issues
    pub medium: u32,
    /// Low Security Issues
    pub low: u32,
    /// Informational Security Issues
    pub informational: u32,
    /// Malware Security Issues
    pub malware: u32,
    /// Unmaintained Security Issues
    pub unmaintained: u32,
    /// Unknown Security Issues
    pub unknown: u32,
}

/// Agent Configuration
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AgentSettings {
    /// Agent tool name
    pub tool: String,
    /// Agent Auto-Install Tools
    pub auto_install: bool,
    /// Agent Auto-Update Tools
    pub auto_update: bool,
}