cryptr 0.10.0

simple encrypted (streaming) values
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

// Copyright 2023 Sebastian Dobe <sebastiandobe@mailbox.org>

#![doc = include_str!("../README.md")]

use base64::DecodeError;
pub use encryption::ChunkSizeKb;
pub use keys::EncKeys;
use std::env::VarError;
use std::io::Error;

#[cfg(feature = "streaming")]
use crate::stream::{LastStreamElement, StreamChunk};

pub use bytes::Bytes;
#[cfg(feature = "s3")]
pub use stream::reader::s3_reader::S3Reader;
#[cfg(feature = "streaming")]
pub use stream::reader::{file_reader::FileReader, memory_reader::MemoryReader, StreamReader};
#[cfg(feature = "s3")]
pub use stream::writer::s3_writer::S3Writer;
#[cfg(feature = "streaming")]
pub use stream::writer::{file_writer::FileWriter, memory_writer::MemoryWriter, StreamWriter};
pub use value::{EncAlg, EncValue, EncValueHeader, EncVersion};

pub mod encryption;
pub mod kdf;
/// Encryption Keys
pub mod keys;
/// Streaming encryption / decryption
#[cfg(feature = "streaming")]
pub mod stream;
pub mod utils;
/// Encryption Value
pub mod value;

#[derive(Debug, thiserror::Error)]
pub enum CryptrError {
    #[error("CryptrError::Cli({0})")]
    Cli(String),
    #[error("CryptrError::Config({0})")]
    Config(&'static str),
    #[error("CryptrError::Decryption({0})")]
    Decryption(&'static str),
    #[error("CryptrError::Deserialization({0})")]
    Deserialization(&'static str),
    #[error("CryptrError::Encryption({0})")]
    Encryption(&'static str),
    #[error("CryptrError::File({0})")]
    File(&'static str),
    #[error("CryptrError::Generic({0})")]
    Generic(String),
    #[error("CryptrError::HeaderInvalid({0})")]
    HeaderInvalid(&'static str),
    #[error("CryptrError::Keys({0})")]
    Keys(&'static str),
    #[error("CryptrError::Password({0})")]
    Password(&'static str),
    #[error("CryptrError::S3({0})")]
    S3(String),
}

impl CryptrError {
    #[allow(dead_code)]
    pub fn as_str(&self) -> &str {
        match self {
            CryptrError::Cli(err) => err.as_str(),
            CryptrError::Config(err) => err,
            CryptrError::Decryption(err) => err,
            CryptrError::Deserialization(err) => err,
            CryptrError::Encryption(err) => err,
            CryptrError::File(err) => err,
            CryptrError::Generic(err) => err.as_str(),
            CryptrError::HeaderInvalid(err) => err,
            CryptrError::Keys(err) => err,
            CryptrError::Password(err) => err,
            CryptrError::S3(err) => err.as_str(),
        }
    }
}

impl From<CryptrError> for std::io::Error {
    fn from(value: CryptrError) -> Self {
        Self::other(value.to_string())
    }
}

impl From<std::io::Error> for CryptrError {
    fn from(value: Error) -> Self {
        Self::Generic(value.to_string())
    }
}

impl From<std::fmt::Error> for CryptrError {
    fn from(value: std::fmt::Error) -> Self {
        Self::Generic(value.to_string())
    }
}

impl From<std::env::VarError> for CryptrError {
    fn from(value: VarError) -> Self {
        Self::Generic(value.to_string())
    }
}

impl From<chacha20poly1305::Error> for CryptrError {
    fn from(value: chacha20poly1305::Error) -> Self {
        Self::Generic(value.to_string())
    }
}

impl From<dotenvy::Error> for CryptrError {
    fn from(value: dotenvy::Error) -> Self {
        Self::Generic(value.to_string())
    }
}
impl From<base64::DecodeError> for CryptrError {
    fn from(value: DecodeError) -> Self {
        Self::Generic(value.to_string())
    }
}

#[cfg(feature = "s3")]
impl From<reqwest::Error> for CryptrError {
    fn from(value: reqwest::Error) -> Self {
        Self::Generic(value.to_string())
    }
}

#[cfg(feature = "s3")]
impl From<s3_simple::S3Error> for CryptrError {
    fn from(value: s3_simple::S3Error) -> Self {
        Self::S3(value.to_string())
    }
}

#[cfg(feature = "streaming")]
impl From<tokio::task::JoinError> for CryptrError {
    fn from(value: tokio::task::JoinError) -> Self {
        Self::Generic(value.to_string())
    }
}

#[cfg(feature = "streaming")]
impl From<futures::channel::oneshot::Canceled> for CryptrError {
    fn from(value: futures::channel::oneshot::Canceled) -> Self {
        Self::Generic(value.to_string())
    }
}

#[cfg(feature = "streaming")]
impl From<flume::SendError<Result<(LastStreamElement, StreamChunk), CryptrError>>> for CryptrError {
    fn from(
        value: flume::SendError<Result<(LastStreamElement, StreamChunk), CryptrError>>,
    ) -> Self {
        Self::Generic(value.to_string())
    }
}