assorted_debian_utils/
release.rs

1// Copyright 2024-2025 Sebastian Ramacher
2// SPDX-License-Identifier: LGPL-3.0-or-later
3
4//! # Helper to handle `Release` files
5
6use std::{
7    collections::HashMap,
8    fmt::Formatter,
9    io::{BufRead, Cursor},
10};
11
12use chrono::{DateTime, Utc};
13use serde::{Deserialize, Deserializer, de};
14
15use crate::{
16    architectures::{Architecture, deserialize_architectures},
17    archive::{Codename, Component, Suite},
18    utils::{DateTimeVisitor, WhitespaceListVisitor},
19};
20
21/// Deserialize a datetime string into a `DateTime<Utc>`
22fn deserialize_datetime<'de, D>(deserializer: D) -> Result<DateTime<Utc>, D::Error>
23where
24    D: Deserializer<'de>,
25{
26    deserializer.deserialize_str(DateTimeVisitor("%a, %d %b %Y %H:%M:%S %Z"))
27}
28
29/// Deserialize a datetime string into a `Option<DateTime<Utc>>`
30fn deserialize_datetime_option<'de, D>(deserializer: D) -> Result<Option<DateTime<Utc>>, D::Error>
31where
32    D: Deserializer<'de>,
33{
34    deserialize_datetime(deserializer).map(Some)
35}
36
37/// Deserialize a list of components into a `Vec<Component>`
38fn deserialize_components<'de, D>(deserializer: D) -> Result<Vec<Component>, D::Error>
39where
40    D: Deserializer<'de>,
41{
42    deserializer.deserialize_str(WhitespaceListVisitor::new("Component"))
43}
44
45struct SHA256Visitor;
46
47impl de::Visitor<'_> for SHA256Visitor {
48    type Value = HashMap<String, FileInfo>;
49
50    fn expecting(&self, formatter: &mut Formatter) -> std::fmt::Result {
51        write!(formatter, "a list of files")
52    }
53
54    fn visit_str<E>(self, s: &str) -> Result<Self::Value, E>
55    where
56        E: de::Error,
57    {
58        let cursor = Cursor::new(s);
59        let mut ret = HashMap::default();
60        for line in cursor.lines() {
61            let Ok(line) = line else {
62                break;
63            };
64
65            let fields: Vec<_> = line.split_ascii_whitespace().collect();
66            if fields.len() != 3 {
67                return Err(E::invalid_value(de::Unexpected::Str(&line), &self));
68            }
69
70            let file = fields[2];
71            let file_size = fields[1]
72                .parse()
73                .map_err(|_| E::invalid_value(de::Unexpected::Str(fields[1]), &self))?;
74            let hash = hex::decode(fields[0])
75                .map_err(|_| E::invalid_value(de::Unexpected::Str(fields[0]), &self))?;
76
77            ret.insert(
78                file.to_string(),
79                FileInfo {
80                    file_size,
81                    hash: hash
82                        .try_into()
83                        .map_err(|_| E::invalid_value(de::Unexpected::Str(fields[0]), &self))?,
84                },
85            );
86        }
87        Ok(ret)
88    }
89}
90
91/// Deserialize files listed as SHA256
92fn deserialize_sha256<'de, D>(deserializer: D) -> Result<HashMap<String, FileInfo>, D::Error>
93where
94    D: Deserializer<'de>,
95{
96    deserializer.deserialize_str(SHA256Visitor)
97}
98
99/// Representation of reference `Package` files in a `Release` file
100#[derive(Debug, Deserialize, PartialEq, Eq)]
101pub struct FileInfo {
102    file_size: u64,
103    hash: [u8; 32],
104}
105
106/// Possible values for `Acquire-By-Hash`
107#[derive(Debug, Deserialize, PartialEq, Eq, Copy, Clone, Default)]
108#[serde(rename_all = "lowercase")]
109pub enum AcquireByHash {
110    /// Acquire by hash
111    Yes,
112    /// Do not acquire by hash
113    #[default]
114    No,
115}
116
117/// Representation of a `Release` file
118#[derive(Debug, Deserialize, PartialEq, Eq)]
119#[serde(rename_all = "PascalCase")]
120pub struct Release {
121    /// Origin of the release
122    pub origin: String,
123    /// Label of the release
124    pub label: String,
125    /// Suite of the release
126    pub suite: Suite,
127    /// Suite of the release
128    pub codename: Codename,
129    /// Version of the release
130    pub version: Option<String>,
131    /// Date of the release
132    #[serde(deserialize_with = "deserialize_datetime")]
133    pub date: DateTime<Utc>,
134    #[serde(
135        default,
136        deserialize_with = "deserialize_datetime_option",
137        rename = "Valid-Until"
138    )]
139    /// Validity of the release
140    pub valid_until: Option<DateTime<Utc>>,
141    #[serde(rename = "Acquire-By-Hash")]
142    /// Whether files should be acquired by hash
143    pub acquire_by_hash: Option<AcquireByHash>,
144    /// Supported architectures of the release
145    #[serde(deserialize_with = "deserialize_architectures")]
146    pub architectures: Vec<Architecture>,
147    /// Components of the release
148    #[serde(deserialize_with = "deserialize_components")]
149    pub components: Vec<Component>,
150    /// Release description
151    pub description: String,
152    /// Referenced `Package` files and others from the release
153    #[serde(rename = "SHA256", deserialize_with = "deserialize_sha256")]
154    pub files: HashMap<String, FileInfo>,
155}
156
157impl Release {
158    /// Lookup path for a specific file honoring `Acquire-By-Hash`
159    pub fn lookup_url(&self, file: &str) -> Option<String> {
160        let info = self.files.get(file)?;
161
162        if self.acquire_by_hash == Some(AcquireByHash::Yes) {
163            file.rsplit_once('/').map(|(component, _)| {
164                format!("{}/by-hash/SHA256/{}", component, hex::encode(info.hash))
165            })
166        } else {
167            Some(file.to_string())
168        }
169    }
170}
171
172/// Read release from a reader
173pub fn from_reader(reader: impl BufRead) -> Result<Release, rfc822_like::de::Error> {
174    rfc822_like::from_reader(reader)
175}
176
177/// Read release from a string
178pub fn from_str(data: &str) -> Result<Release, rfc822_like::de::Error> {
179    rfc822_like::from_str(data)
180}
181
182#[cfg(test)]
183mod test {
184    use super::*;
185
186    #[test]
187    fn archive() {
188        let data = r"Origin: Debian-ramacher.at
189Label: Debian-ramacher.at
190Suite: unstable
191Codename: sid
192Version: 13.0
193Date: Sun, 17 Dec 2023 18:43:37 UTC
194Architectures: i386 amd64
195Components: main
196Description: Experimental and unfinished Debian packages (for unstable)
197MD5Sum:
198 628a4efab35e598c7b6debdb0ac85314 26187 main/binary-i386/Packages
199 6c849211e65839aac2682c461c82dbb3 7777 main/binary-i386/Packages.gz
200 05ee2bfa660c3acc3559928769c29730 191 main/binary-i386/Release
201 d41d8cd98f00b204e9800998ecf8427e 0 main/debian-installer/binary-i386/Packages
202 7029066c27ac6f5ef18d660d5741979a 20 main/debian-installer/binary-i386/Packages.gz
203 296265926c83b0d9d9d43fcc6c43496d 30187 main/binary-amd64/Packages
204 8dad6d33daa175a4a54b9d328e9bb491 8821 main/binary-amd64/Packages.gz
205 c0f8f3dd5202483a2b57bb348a3741a6 192 main/binary-amd64/Release
206 d41d8cd98f00b204e9800998ecf8427e 0 main/debian-installer/binary-amd64/Packages
207 7029066c27ac6f5ef18d660d5741979a 20 main/debian-installer/binary-amd64/Packages.gz
208 4b35b2727e9c1d87c775e35fd8d00cf4 15130 main/source/Sources
209 689c40d665e43a8f9a94d6e2b1dd47a4 4582 main/source/Sources.gz
210 3ce12e6e384a34e6e1850bcc192edf8c 193 main/source/Release
211SHA1:
212 da7a5b4f20e79cab9bacca996d83419d5224a709 26187 main/binary-i386/Packages
213 a0b5ae4166358c741f1c27bf457c3b31bcdb495a 7777 main/binary-i386/Packages.gz
214 046a2ee510a7ea14c8b718dd153077b0359b3509 191 main/binary-i386/Release
215 da39a3ee5e6b4b0d3255bfef95601890afd80709 0 main/debian-installer/binary-i386/Packages
216 46c6643f07aa7f6bfe7118de926b86defc5087c4 20 main/debian-installer/binary-i386/Packages.gz
217 d7fc79844dbc2702ca889a985f716374f7c8b9a5 30187 main/binary-amd64/Packages
218 21374a60ce3d47b87bac11b3b3a96795020a0d41 8821 main/binary-amd64/Packages.gz
219 01f970b6eae435dd8b6b1f8f61727db854212ce4 192 main/binary-amd64/Release
220 da39a3ee5e6b4b0d3255bfef95601890afd80709 0 main/debian-installer/binary-amd64/Packages
221 46c6643f07aa7f6bfe7118de926b86defc5087c4 20 main/debian-installer/binary-amd64/Packages.gz
222 12b46a55c05518bfcfb267908185f041a1b984ae 15130 main/source/Sources
223 5e2bfa609cbc328e07336f8e17707683fda37011 4582 main/source/Sources.gz
224 96d0688be60481ba7eb71007b609bdf1f8323725 193 main/source/Release
225SHA256:
226 efe2dafdf6a50f376af1dfc574d6bd3360558fde917555671b13832c89604d9f 26187 main/binary-i386/Packages
227 ba66d22607be572323b72ca152d6e635fab075d92a2265bbfe319337c35ccd13 7777 main/binary-i386/Packages.gz
228 e6be53e3210056ed6854cf2a362cb953eaa962ea811cfbe34cdad2807be61101 191 main/binary-i386/Release
229 e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 0 main/debian-installer/binary-i386/Packages
230 59869db34853933b239f1e2219cf7d431da006aa919635478511fabbfc8849d2 20 main/debian-installer/binary-i386/Packages.gz
231 baf930986b322ef7ff8cc04fa57762c68e7f9d8b67a0423bd5441686cbf3e751 30187 main/binary-amd64/Packages
232 0ad7ab0202ece24b57051f16010c72479b97e905c659f975eac5d69284c562f3 8821 main/binary-amd64/Packages.gz
233 97e06eefea86617e4abc8a647d0faebd0eaca7c87031423a4ae1d38e8f1c97bb 192 main/binary-amd64/Release
234 e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 0 main/debian-installer/binary-amd64/Packages
235 59869db34853933b239f1e2219cf7d431da006aa919635478511fabbfc8849d2 20 main/debian-installer/binary-amd64/Packages.gz
236 b0a524d1ba90e253c937859e3ce30bc49a291e33dbb8124706424cf5c06100a8 15130 main/source/Sources
237 2bc04b364bfc30657836faf8d1de7f6044652bcca6af6503ef404a086897267a 4582 main/source/Sources.gz
238 3637559f78ac17d0e55bce465d510ef912d539e4b810a66b32431dd76f5929d8 193 main/source/Release";
239        let release = from_str(data).unwrap();
240
241        assert_eq!(
242            release.architectures,
243            vec![Architecture::I386, Architecture::Amd64]
244        );
245        assert_eq!(release.components, vec![Component::Main]);
246        assert_eq!(release.suite, Suite::Unstable);
247        assert_eq!(release.codename, Codename::Sid);
248        assert!(release.files.contains_key("main/source/Release"));
249        assert_eq!(
250            release.files["main/source/Release"],
251            FileInfo {
252                file_size: 193,
253                hash: [
254                    0x36, 0x37, 0x55, 0x9f, 0x78, 0xac, 0x17, 0xd0, 0xe5, 0x5b, 0xce, 0x46, 0x5d,
255                    0x51, 0x0e, 0xf9, 0x12, 0xd5, 0x39, 0xe4, 0xb8, 0x10, 0xa6, 0x6b, 0x32, 0x43,
256                    0x1d, 0xd7, 0x6f, 0x59, 0x29, 0xd8
257                ]
258            }
259        );
260    }
261}
assorted_debian_utils/release.rs

assorted_debian_utils/
release.rs
