csaf-core 1.5.28

CSAF storage, validation, sidecar generation, import/export
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

// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2026 Pierre Gronau, ndaal in Cologne

//! Error types for the CSAF core crate.

use thiserror::Error;

use crate::listen_port::ListenPortError;

/// Central error type for CSAF core operations.
#[derive(Debug, Error)]
pub enum CsafError {
    /// Storage (redb) error.
    #[error("Storage error: {0}")]
    Storage(String),

    /// Database (`SQLite`) error.
    #[error("Database error: {0}")]
    Database(#[from] rusqlite::Error),

    /// Serialization/deserialization error.
    #[error("Serialization error: {0}")]
    Serialization(#[from] serde_json::Error),

    /// CSAF validation failed with one or more errors.
    #[error("Validation failed: {0}")]
    Validation(String),

    /// File I/O error.
    #[error("I/O error: {0}")]
    Io(#[from] std::io::Error),

    /// Configuration error.
    #[error("Configuration error: {0}")]
    Config(String),

    /// A configured port that the listen-port rule refuses
    /// (`skills/rust-ip-ports`). The server exits with status 64 for it and
    /// for nothing else. `or_off` adds ", or off" to the message for a port
    /// that can be switched off.
    #[error("{key}: {source}{}", if *.or_off { ", or off" } else { "" })]
    ListenPort {
        /// The config key that held the refused value.
        key: &'static str,
        /// Which part of the rule the value broke.
        source: ListenPortError,
        /// Whether `off` is also accepted for this key.
        or_off: bool,
    },

    /// Document not found.
    #[error("Document not found: {0}")]
    NotFound(String),

    /// Duplicate document.
    #[error("Document already exists: {0}")]
    Duplicate(String),

    /// Import error.
    #[error("Import error: {0}")]
    Import(String),

    /// Export error.
    #[error("Export error: {0}")]
    Export(String),
}

impl CsafError {
    /// Whether this error is a configured port the rule refuses, which is the
    /// only error the server maps to exit status 64.
    #[must_use]
    pub const fn is_refused_port(&self) -> bool {
        matches!(self, Self::ListenPort { .. })
    }
}

impl From<redb::Error> for CsafError {
    fn from(e: redb::Error) -> Self {
        Self::Storage(e.to_string())
    }
}

impl From<redb::DatabaseError> for CsafError {
    fn from(e: redb::DatabaseError) -> Self {
        Self::Storage(e.to_string())
    }
}

impl From<redb::TableError> for CsafError {
    fn from(e: redb::TableError) -> Self {
        Self::Storage(e.to_string())
    }
}

impl From<redb::TransactionError> for CsafError {
    fn from(e: redb::TransactionError) -> Self {
        Self::Storage(e.to_string())
    }
}

impl From<redb::CommitError> for CsafError {
    fn from(e: redb::CommitError) -> Self {
        Self::Storage(e.to_string())
    }
}

impl From<redb::StorageError> for CsafError {
    fn from(e: redb::StorageError) -> Self {
        Self::Storage(e.to_string())
    }
}

/// Result type alias using `CsafError`.
pub type Result<T> = std::result::Result<T, CsafError>;