binarycookies 0.1.3

A package reader for Mac os cookie file
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324

use crate::{cookie::Cookie, errno::BinaryCookieError, page::Page};
use std::{fs::File, io::Read};

pub struct BinaryCookiesReader {
    cookie_size: u32,
    bits_offset: usize,
    data: Vec<u8>,
    pages_size: Vec<u32>,
    pages_data: Vec<Page>,
    check_sum: [u8; 8],
}

impl BinaryCookiesReader {
    /// # BinaryCookiesReader - new
    ///
    /// need a .binarycookies file path to build, return a BinaryCookiesReader
    ///
    /// ## Arguments
    ///
    /// * `target` - type is String, .binarycookies file path
    ///
    /// ## Returns
    ///
    /// `Result<(), BinaryCookieError>`
    ///
    /// ## Examples
    ///
    /// ```rust
    /// let target_file_path: String = String::from("/Users/foo/Library/HTTPStorages/boo.binarycookies");
    /// let mut bc_decoder = BinaryCookiesReader::new(&target_file_path).unwrap();
    /// let _ = bc_decoder.decoder().unwrap();
    /// for page in bc_decoder.origin_pages():
    ///     for cookie in page.cookies():
    ///         println!("{} | {} | {}", cookie.name_str(), cookie.value_str(), cookie.http_only)
    /// ```

    pub fn new(target: &String) -> Result<Self, BinaryCookieError> {
        let mut target_file = File::open(target)?;
        let mut data = vec![];
        let _ = target_file.read_to_end(&mut data)?;
        Ok(Self {
            cookie_size: 0,
            bits_offset: 0,
            data,
            pages_size: vec![],
            pages_data: vec![],
            check_sum: [0; 8],
        })
    }

    /// # BinaryCookiesReader - from_vec
    ///
    /// need a Vec<u8> data to build
    ///
    /// ## Arguments
    ///
    /// * `target` - type is Vec<u8>, after read_binary...
    ///
    /// ## Returns
    ///
    /// `BinaryCookiesReader`
    ///
    /// ## Examples
    ///
    /// ```rust
    /// use std::fs::File;
    ///
    /// let target_file_path: String = String::from("/Users/foo/Library/HTTPStorages/boo.binarycookies");
    /// let mut buf = Vec::new();
    /// let mut f = File::open(&target_file_path);
    /// let _ = f.read_to_end(&mut buf);
    /// let mut bc_decoder = BinaryCookiesReader::from_vec(&buf).unwrap();
    /// let _ = bc_decoder.decoder().unwrap();
    /// for page in bc_decoder.origin_pages():
    ///     for cookie in page.cookies():
    ///         println!("{} | {} | {}", cookie.name_str(), cookie.value_str(), cookie.http_only)
    /// ```

    pub fn from_vec(target: &Vec<u8>) -> Self {
        let mut data = Vec::<u8>::with_capacity(target.len());
        data.extend(target.iter());
        Self {
            cookie_size: 0,
            bits_offset: 0,
            data,
            pages_size: vec![],
            pages_data: vec![],
            check_sum: [0; 8],
        }
    }

    fn read4bits(&mut self) -> Result<[u8; 4], BinaryCookieError> {
        let mut bits: [u8; 4] = [0; 4];
        for i in 0..4 {
            if let Some(&value) = self.data.get(self.bits_offset + i) {
                bits[i] = value;
            } else {
                return Err(BinaryCookieError::InvalidIndexOverBounds);
            };
        }
        self.bits_offset += 4;
        return Ok(bits);
    }

    fn read8bits(&mut self) -> Result<[u8; 8], BinaryCookieError> {
        let mut bits: [u8; 8] = [0; 8];
        for i in 0..8 {
            if let Some(&value) = self.data.get(self.bits_offset + i) {
                bits[i] = value;
            } else {
                return Err(BinaryCookieError::InvalidIndexOverBounds);
            }
        }
        self.bits_offset += 8;
        return Ok(bits);
    }

    fn read_bits(&mut self, size: u32) -> Result<Vec<u8>, BinaryCookieError> {
        let cap = size as usize;
        let mut bits: Vec<u8> = Vec::with_capacity(cap);
        for i in 0..cap {
            if let Some(&value) = self.data.get(self.bits_offset + i) {
                bits.push(value);
            } else {
                return Err(BinaryCookieError::InvalidIndexOverBounds);
            }
        }
        self.bits_offset += cap;
        Ok(bits)
    }

    #[deprecated(since = "0.1.4", note = "use `decode()` function instead")]
    pub fn deocde(&mut self) -> Result<(), BinaryCookieError> {
        let magic_signature = [99, 111, 111, 107];
        let next: [u8; 4] = self.read4bits()?;
        if next != magic_signature {
            return Err(BinaryCookieError::InvalidSignature);
        }
        let next: [u8; 4] = self.read4bits()?;
        self.cookie_size = u32::from_be_bytes(next);
        for _ in 0..self.cookie_size {
            let next: [u8; 4] = self.read4bits()?;
            self.pages_size.push(u32::from_be_bytes(next));
        }
        for _ in 0..self.cookie_size {
            let start_code = self.read4bits()?;
            if start_code != [0x00, 0x00, 0x01, 0x00] {
                return Err(BinaryCookieError::InvalidStartCode);
            };
            let length_info = self.read4bits()?;
            let length = u32::from_le_bytes(length_info) as usize;
            let mut offset: Vec<u32> = Vec::with_capacity(length);
            for _ in 0..length {
                let next: [u8; 4] = self.read4bits()?;
                let data = u32::from_le_bytes(next);
                offset.push(data);
            }
            let mut page = Page::new(length, offset);
            let end_code = self.read4bits()?;
            if end_code != [0x00, 0x00, 0x00, 0x00] {
                return Err(BinaryCookieError::EndCodeError);
            }
            for _ in 0..length {
                let mut cookie = Cookie::default();
                let next = self.read4bits()?;
                cookie.init_cookie_size(next);
                let next = self.read4bits()?;
                cookie.init_unknown_one(next);
                let next = self.read4bits()?;
                cookie.init_flags(next);
                let next = self.read4bits()?;
                cookie.init_unknown_two(next);
                let next = self.read4bits()?;
                cookie.init_domain_offset(next);
                let next = self.read4bits()?;
                cookie.init_name_offset(next);
                let next = self.read4bits()?;
                cookie.init_path_offset(next);
                let next = self.read4bits()?;
                cookie.init_value_offset(next);
                let next = self.read4bits()?;
                cookie.init_comment_offset(next);
                let next = self.read4bits()?;
                if !cookie.is_end_header(next) {
                    return Err(BinaryCookieError::EndHeaderCodeError);
                };
                let next = self.read8bits()?;
                cookie.init_page_expires(next);
                let next = self.read8bits()?;
                cookie.init_page_creation(next);
                if cookie.check_over_size() {
                    return Err(BinaryCookieError::DataOverSize);
                };
                let comment_size = cookie.page_comment_size();
                if comment_size > 0 {
                    let next = self.read_bits(comment_size)?;
                    cookie.init_comment(next);
                };
                let domain_size = cookie.page_domain_size();
                if domain_size > 0 {
                    let next = self.read_bits(domain_size)?;
                    cookie.init_domain(next)
                };
                let name_size = cookie.page_name_size();
                if name_size > 0 {
                    let next = self.read_bits(name_size)?;
                    cookie.init_name(next)
                };
                let path_size = cookie.page_path_size();
                if path_size > 0 {
                    let next = self.read_bits(path_size)?;
                    cookie.init_path(next);
                };
                let value_size = cookie.page_value_size();
                if value_size > 0 {
                    let next = self.read_bits(value_size)?;
                    cookie.init_value(next)
                };
                page.mut_cookies().push(cookie);
            }
            self.pages_data.push(page);
        }
        self.check_sum = self.read8bits()?;
        Ok(())
    }

    pub fn decode(&mut self) -> Result<(), BinaryCookieError> {
        let magic_signature = [99, 111, 111, 107];
        let next: [u8; 4] = self.read4bits()?;
        if next != magic_signature {
            return Err(BinaryCookieError::InvalidSignature);
        }
        let next: [u8; 4] = self.read4bits()?;
        self.cookie_size = u32::from_be_bytes(next);
        for _ in 0..self.cookie_size {
            let next: [u8; 4] = self.read4bits()?;
            self.pages_size.push(u32::from_be_bytes(next));
        }
        for _ in 0..self.cookie_size {
            let start_code = self.read4bits()?;
            if start_code != [0x00, 0x00, 0x01, 0x00] {
                return Err(BinaryCookieError::InvalidStartCode);
            };
            let length_info = self.read4bits()?;
            let length = u32::from_le_bytes(length_info) as usize;
            let mut offset: Vec<u32> = Vec::with_capacity(length);
            for _ in 0..length {
                let next: [u8; 4] = self.read4bits()?;
                let data = u32::from_le_bytes(next);
                offset.push(data);
            }
            let mut page = Page::new(length, offset);
            let end_code = self.read4bits()?;
            if end_code != [0x00, 0x00, 0x00, 0x00] {
                return Err(BinaryCookieError::EndCodeError);
            }
            for _ in 0..length {
                let mut cookie = Cookie::default();
                let next = self.read4bits()?;
                cookie.init_cookie_size(next);
                let next = self.read4bits()?;
                cookie.init_unknown_one(next);
                let next = self.read4bits()?;
                cookie.init_flags(next);
                let next = self.read4bits()?;
                cookie.init_unknown_two(next);
                let next = self.read4bits()?;
                cookie.init_domain_offset(next);
                let next = self.read4bits()?;
                cookie.init_name_offset(next);
                let next = self.read4bits()?;
                cookie.init_path_offset(next);
                let next = self.read4bits()?;
                cookie.init_value_offset(next);
                let next = self.read4bits()?;
                cookie.init_comment_offset(next);
                let next = self.read4bits()?;
                if !cookie.is_end_header(next) {
                    return Err(BinaryCookieError::EndHeaderCodeError);
                };
                let next = self.read8bits()?;
                cookie.init_page_expires(next);
                let next = self.read8bits()?;
                cookie.init_page_creation(next);
                if cookie.check_over_size() {
                    return Err(BinaryCookieError::DataOverSize);
                };
                let comment_size = cookie.page_comment_size();
                if comment_size > 0 {
                    let next = self.read_bits(comment_size)?;
                    cookie.init_comment(next);
                };
                let domain_size = cookie.page_domain_size();
                if domain_size > 0 {
                    let next = self.read_bits(domain_size)?;
                    cookie.init_domain(next)
                };
                let name_size = cookie.page_name_size();
                if name_size > 0 {
                    let next = self.read_bits(name_size)?;
                    cookie.init_name(next)
                };
                let path_size = cookie.page_path_size();
                if path_size > 0 {
                    let next = self.read_bits(path_size)?;
                    cookie.init_path(next);
                };
                let value_size = cookie.page_value_size();
                if value_size > 0 {
                    let next = self.read_bits(value_size)?;
                    cookie.init_value(next)
                };
                page.mut_cookies().push(cookie);
            }
            self.pages_data.push(page);
        }
        self.check_sum = self.read8bits()?;
        Ok(())
    }

    pub fn origin_pages(&mut self) -> &Vec<Page> {
        return &self.pages_data;
    }
}