hermes-tdata 0.1.1

Pure Rust parser for Telegram Desktop's tdata storage format. Decrypts local storage and extracts auth keys without Qt/C++ dependencies.
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

//! Error types for hermes-tdata

use std::path::PathBuf;

/// Result type alias for hermes-tdata operations
pub type Result<T> = std::result::Result<T, Error>;

/// Errors that can occur during tdata parsing
#[derive(Debug, thiserror::Error)]
pub enum Error {
    /// IO error while reading tdata files
    #[error("IO error: {0}")]
    Io(#[from] std::io::Error),

    /// The tdata folder path does not exist
    #[error("tdata folder not found: {path}")]
    FolderNotFound {
        /// Path that was not found
        path: PathBuf,
    },

    /// Required file is missing from tdata folder
    #[error("required file not found: {file} in {folder}")]
    FileNotFound {
        /// Name of the missing file
        file: String,
        /// Folder where file was expected
        folder: PathBuf,
    },

    /// Key file (`key_data`, `key_datas`) not found
    #[error("key file not found in tdata folder")]
    KeyFileNotFound,

    /// Failed to decrypt tdata - wrong passcode or corrupted data
    #[error("decryption failed: wrong passcode or corrupted data")]
    DecryptionFailed,

    /// The tdata folder is password-protected but no passcode provided
    #[error("tdata is password-protected, passcode required")]
    PasscodeRequired,

    /// Invalid passcode provided
    #[error("invalid passcode")]
    InvalidPasscode,

    /// `QDataStream` parsing error
    #[error("QDataStream parse error: {message}")]
    QDataStreamError {
        /// Error message describing the parse failure
        message: String,
    },

    /// Unexpected end of data while parsing
    #[error("unexpected end of data at offset {offset}")]
    UnexpectedEof {
        /// Byte offset where EOF was encountered
        offset: u64,
    },

    /// Invalid UTF-16 string data
    #[error("invalid UTF-16 string data")]
    InvalidUtf16,

    /// Invalid data format or structure
    #[error("invalid data format: {message}")]
    InvalidFormat {
        /// Description of the format violation
        message: String,
    },

    /// No accounts found in tdata
    #[error("no accounts found in tdata")]
    NoAccounts,

    /// Account index out of range
    #[error("account index {index} out of range (max: {max})")]
    AccountIndexOutOfRange {
        /// Requested account index
        index: usize,
        /// Maximum valid index
        max: usize,
    },

    /// MD5 checksum mismatch in encrypted data
    #[error("checksum mismatch: data may be corrupted")]
    ChecksumMismatch,

    /// Unsupported tdata version
    #[error("unsupported tdata version: {version}")]
    UnsupportedVersion {
        /// The unsupported version number
        version: u32,
    },

    /// Auth key extraction failed
    #[error("failed to extract auth key: {reason}")]
    AuthKeyExtractionFailed {
        /// Reason for extraction failure
        reason: String,
    },
}

impl Error {
    /// Create a `QDataStream` error with a message
    pub fn qdatastream(msg: impl Into<String>) -> Self {
        Self::QDataStreamError { message: msg.into() }
    }

    /// Create an invalid format error with a message
    pub fn invalid_format(msg: impl Into<String>) -> Self {
        Self::InvalidFormat { message: msg.into() }
    }

    /// Create an auth key extraction error
    pub fn auth_key_failed(reason: impl Into<String>) -> Self {
        Self::AuthKeyExtractionFailed { reason: reason.into() }
    }
}