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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
#![warn(missing_docs)]
#![doc = include_str!("../README.md")]

use std::{
    convert::TryFrom,
    error::Error,
    fmt::Display,
    ops::{Deref, DerefMut},
};

const HTTP_ONLY: &str = "#HttpOnly_";

/// Cookie representation
#[derive(Default, Debug, Clone, PartialEq)]
pub struct Cookie {
    /// the domain the cookie is valid for
    pub domain: String,
    /// whether or not the cookie is also valid for subdomains
    pub include_subdomains: bool,
    /// a subpath the cookie is valid for
    pub path: String,
    /// should it only be valid in https contexts
    pub https_only: bool,
    /// should it only be valid in http contexts
    pub http_only: bool,
    /// unix timestamp for when the cookie expires
    pub expires: u64,
    /// the cookie name
    pub name: String,
    /// the value of the cookie
    pub value: String,
}

/// Type containing multiple cookies
#[derive(Default, Debug, Clone, PartialEq)]
pub struct Cookies(Vec<Cookie>);

impl Deref for Cookies {
    type Target = Vec<Cookie>;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl DerefMut for Cookies {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

impl From<Vec<Cookie>> for Cookies {
    fn from(value: Vec<Cookie>) -> Self {
        Cookies(value)
    }
}

impl From<Cookies> for Vec<Cookie> {
    fn from(value: Cookies) -> Self {
        value.0
    }
}

#[cfg(any(feature = "cookie", test))]
impl From<Cookies> for Vec<cookie::Cookie<'_>> {
    fn from(value: Cookies) -> Self {
        value.iter().map(cookie::Cookie::from).collect()
    }
}

/// represents an error that can occur while parsing or converting cookies
#[derive(Debug, PartialEq)]
pub enum ParseError {
    /// can occur while parsing a cookies.txt string and it being formatted wrong
    InvalidFormat(String),
    /// can occur while parsing a cookies.txt string and converting string representations to
    /// concrete types
    InvalidValue(String),
    /// can occur if the cookies.txt string is empty or only contains comments
    Empty,
    /// should ideally not occur and should be reported if it does.
    /// it will contain an error message
    InternalError(String),
    /// can occur if parsing the url for the cookie fails
    InvalidUrl,
}

impl Display for ParseError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            ParseError::InvalidFormat(m) => write!(f, "{}", m),
            ParseError::InvalidValue(m) => write!(f, "{}", m),
            ParseError::Empty => write!(f, "Input does not contain cookie"),
            ParseError::InternalError(m) => {
                write!(f, "Internal error occured, report this: \"{}\"", m)
            }
            ParseError::InvalidUrl => {
                write!(f, "The URL stored in the cookie could not be converted")
            }
        }
    }
}

impl Error for ParseError {}

#[doc(hidden)]
fn parse_bool<T>(s: T) -> Result<bool, ParseError>
where
    T: AsRef<str> + std::fmt::Debug,
{
    let input: &str = s.as_ref();
    match input.to_lowercase().as_ref() {
        "true" => Ok(true),
        "false" => Ok(false),
        _ => Err(ParseError::InvalidValue(format!(
            "Expected \"TRUE\" or \"FALSE\", got \"{:?}\"",
            s
        ))),
    }
}

#[doc(hidden)]
fn parse_u64<T>(s: T) -> Result<u64, ParseError>
where
    T: AsRef<str>,
{
    let input: &str = s.as_ref();
    match input.parse::<u64>() {
        Ok(v) => Ok(v),
        Err(_) => Err(ParseError::InvalidValue(format!(
            "Expected a value between {} and {}, got \"{}\"",
            u64::MIN,
            u64::MAX,
            input
        ))),
    }
}

impl TryFrom<&str> for Cookie {
    type Error = ParseError;

    /// tries to convert a single line in cookies.txt format to a [crate::Cookie].
    fn try_from(input: &str) -> Result<Self, Self::Error> {
        let mut input = input.trim();

        let mut domain: String = Default::default();
        let mut include_subdomains: bool = Default::default();
        let mut path: String = Default::default();
        let mut https_only: bool = Default::default();
        let mut http_only: bool = Default::default();
        let mut expires: u64 = Default::default();
        let mut name: String = Default::default();
        let mut value: String = Default::default();

        if input.starts_with('#') && !input.starts_with(HTTP_ONLY) {
            return Err(ParseError::Empty);
        }

        if input.starts_with(HTTP_ONLY) {
            http_only = true;
            input = if let Some(v) = input.strip_prefix(HTTP_ONLY) {
                v.trim()
            } else {
                return Err(ParseError::InternalError(
                    "Could not strip HTTP_ONLY prefix, even though it is present".to_string(),
                ));
            };
        }

        let splits = input.split('\t').enumerate();
        if splits.clone().count() != 7 {
            return Err(ParseError::Empty);
        }

        for (i, part) in splits {
            let part = part.trim();
            match i {
                0 => domain = part.to_string(),
                1 => include_subdomains = parse_bool(part)?,
                2 => path = part.to_string(),
                3 => https_only = parse_bool(part)?,
                4 => expires = parse_u64(part)?,
                5 => name = part.to_string(),
                6 => value = part.to_string(),
                v => {
                    return Err(ParseError::InvalidFormat(format!(
                        "Too many fields: {}, expected 7",
                        v
                    )))
                }
            }
        }

        Ok(Cookie {
            domain,
            include_subdomains,
            path,
            https_only,
            http_only,
            expires,
            name,
            value,
        })
    }
}

impl TryFrom<&str> for Cookies {
    type Error = ParseError;

    /// tries to convert a multiple lines in the cookies.txt format to [crate::Cookies].
    fn try_from(value: &str) -> Result<Self, Self::Error> {
        if value.lines().peekable().peek().is_none() {
            return Err(ParseError::Empty);
        }

        let mut cookies: Cookies = Cookies(vec![]);

        for line in value.lines() {
            let cookie = match Cookie::try_from(line) {
                Ok(c) => c,
                Err(ParseError::Empty) => continue,
                e => e?,
            };

            cookies.push(cookie);
        }

        if cookies.is_empty() {
            return Err(ParseError::Empty);
        }

        Ok(cookies)
    }
}

#[cfg(any(feature = "cookie", test))]
impl From<&Cookie> for cookie::Cookie<'_> {
    /// convert from [crate::Cookie] to [cookie::Cookie]
    fn from(value: &Cookie) -> Self {
        Self::build((value.clone().name, value.clone().value))
            .domain(value.clone().domain)
            .path(value.clone().path)
            .secure(value.https_only)
            .http_only(value.http_only)
            .expires(cookie::Expiration::from(match value.expires {
                0 => None,
                v => time::OffsetDateTime::from_unix_timestamp(v as i64).ok(),
            }))
            .build()
    }
}

#[cfg(any(feature = "thirtyfour", test))]
impl From<Cookie> for thirtyfour::Cookie<'_> {
    /// convert from [crate::Cookie] to [thirtyfour::Cookie]
    fn from(value: Cookie) -> Self {
        Self::build(value.name, value.value)
            .domain(value.domain)
            .path(value.path)
            .secure(value.https_only)
            .http_only(value.http_only)
            .expires(thirtyfour::cookie::Expiration::from(match value.expires {
                0 => None,
                v => time::OffsetDateTime::from_unix_timestamp(v as i64).ok(),
            }))
            .finish()
    }
}

#[cfg(any(feature = "cookie_store", test))]
impl Cookie {
    /// converts [crate::Cookie] to a [cookie_store::Cookie].
    /// This takes a URL, for which the cookie is valid. Parsing this URL can fail.
    pub fn into_cookie_store_cookie(
        self,
        domain: &str,
    ) -> Result<cookie_store::Cookie<'_>, ParseError> {
        cookie_store::Cookie::try_from_raw_cookie(
            &self.into(),
            &url::Url::parse(domain).map_err(|_| ParseError::InvalidUrl)?,
        )
        .map_err(|e| ParseError::InternalError(e.to_string()))
    }
}

#[cfg(any(feature = "cookie_store", test))]
impl From<Cookie> for cookie_store::RawCookie<'_> {
    /// convert from [crate::Cookie] to [cookie_store::RawCookie]
    fn from(value: Cookie) -> Self {
        Self::build((value.name, value.value))
            .domain(value.domain)
            .path(value.path)
            .secure(value.https_only)
            .http_only(value.http_only)
            .expires(cookie::Expiration::from(match value.expires {
                0 => None,
                v => time::OffsetDateTime::from_unix_timestamp(v as i64).ok(),
            }))
            .build()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    const COOKIE_TXT: &str = r#"
# Netscape HTTP Cookie File
# http://curl.haxx.se/rfc/cookie_spec.html
# This is a generated file!  Do not edit.

.example.com	TRUE	/	TRUE	0000000000	foo	bar
.example.com	TRUE	/	TRUE	1740743335	foo2	bar2
#HttpOnly_	.example.com	TRUE	/	TRUE	1740743335	foo3	bar3
"#;

    #[test]
    fn parse_cookie_line() {
        let input = r#"
.example.com	TRUE	/	TRUE	1234567890	foo	bar
"#;
        assert_eq!(
            Cookie::try_from(input),
            Ok(Cookie {
                domain: ".example.com".to_string(),
                include_subdomains: true,
                path: "/".to_string(),
                https_only: true,
                http_only: false,
                expires: 1234567890,
                name: "foo".to_string(),
                value: "bar".to_string()
            })
        );
    }

    #[test]
    fn parse_cookie_line_http_only() {
        let input = r#"
#HttpOnly_ .example.com	TRUE	/	TRUE	1234567890	foo	bar
"#;
        assert_eq!(
            Cookie::try_from(input),
            Ok(Cookie {
                domain: ".example.com".to_string(),
                include_subdomains: true,
                path: "/".to_string(),
                https_only: true,
                http_only: true,
                expires: 1234567890,
                name: "foo".to_string(),
                value: "bar".to_string()
            })
        );
    }

    #[test]
    fn parse_empty_line() {
        let input = "";
        assert_eq!(Cookie::try_from(input), Err(ParseError::Empty))
    }

    #[test]
    fn parse_comment() {
        let input = "# hello world";
        assert_eq!(Cookie::try_from(input), Err(ParseError::Empty))
    }

    #[test]
    fn parse_cookie_txt() {
        let exp = vec![
            Cookie {
                domain: ".example.com".to_string(),
                include_subdomains: true,
                path: "/".to_string(),
                https_only: true,
                http_only: false,
                expires: 0,
                name: "foo".to_string(),
                value: "bar".to_string(),
            },
            Cookie {
                domain: ".example.com".to_string(),
                include_subdomains: true,
                path: "/".to_string(),
                https_only: true,
                http_only: false,
                expires: 1740743335,
                name: "foo2".to_string(),
                value: "bar2".to_string(),
            },
            Cookie {
                domain: ".example.com".to_string(),
                include_subdomains: true,
                path: "/".to_string(),
                https_only: true,
                http_only: true,
                expires: 1740743335,
                name: "foo3".to_string(),
                value: "bar3".to_string(),
            },
        ];

        let cookies: Vec<Cookie> = Cookies::try_from(COOKIE_TXT).unwrap().to_vec();
        assert_eq!(cookies, exp);
    }

    #[cfg(any(feature = "cookie", test))]
    #[test]
    fn test_convert_to_cookie() {
        let converted: Vec<cookie::Cookie> = Cookies::try_from(COOKIE_TXT).unwrap().into();
        let exp = vec![
            cookie::Cookie::build(("foo", "bar"))
                .domain(".example.com")
                .path("/")
                .secure(true)
                .http_only(false)
                .expires(cookie::Expiration::Session)
                .build(),
            cookie::Cookie::build(("foo2", "bar2"))
                .domain(".example.com")
                .path("/")
                .secure(true)
                .http_only(false)
                .expires(time::OffsetDateTime::from_unix_timestamp(1740743335).unwrap())
                .build(),
            cookie::Cookie::build(("foo3", "bar3"))
                .domain(".example.com")
                .path("/")
                .secure(true)
                .http_only(true)
                .expires(time::OffsetDateTime::from_unix_timestamp(1740743335).unwrap())
                .build(),
        ];
        assert_eq!(converted, exp);
    }
}