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)]
108#[serde(rename_all = "lowercase")]
109pub enum AcquireByHash {
110    /// Acquire by hash
111    Yes,
112    /// Do not acquire by hash
113    No,
114}
115
116/// Representation of a `Release` file
117#[derive(Debug, Deserialize, PartialEq, Eq)]
118#[serde(rename_all = "PascalCase")]
119pub struct Release {
120    /// Origin of the release
121    pub origin: String,
122    /// Label of the release
123    pub label: String,
124    /// Suite of the release
125    pub suite: Suite,
126    /// Suite of the release
127    pub codename: Codename,
128    /// Version of the release
129    pub version: Option<String>,
130    /// Date of the release
131    #[serde(deserialize_with = "deserialize_datetime")]
132    pub date: DateTime<Utc>,
133    #[serde(
134        default,
135        deserialize_with = "deserialize_datetime_option",
136        rename = "Valid-Until"
137    )]
138    /// Validity of the release
139    pub valid_until: Option<DateTime<Utc>>,
140    #[serde(rename = "Acquire-By-Hash")]
141    /// Whether files should be acquired by hash
142    pub acquire_by_hash: Option<AcquireByHash>,
143    /// Supported architectures of the release
144    #[serde(deserialize_with = "deserialize_architectures")]
145    pub architectures: Vec<Architecture>,
146    /// Components of the release
147    #[serde(deserialize_with = "deserialize_components")]
148    pub components: Vec<Component>,
149    /// Release description
150    pub description: String,
151    /// Referenced `Package` files and others from the release
152    #[serde(rename = "SHA256", deserialize_with = "deserialize_sha256")]
153    pub files: HashMap<String, FileInfo>,
154}
155
156impl Release {
157    /// Lookup path for a specific file honoring `Acquire-By-Hash`
158    pub fn lookup_url(&self, file: &str) -> Option<String> {
159        let info = self.files.get(file)?;
160
161        if self
162            .acquire_by_hash
163            .is_some_and(|by_hash| by_hash == AcquireByHash::Yes)
164        {
165            file.rsplit_once('/').map(|(component, _)| {
166                format!("{}/by-hash/SHA256/{}", component, hex::encode(info.hash))
167            })
168        } else {
169            Some(file.to_string())
170        }
171    }
172}
173
174/// Read release from a reader
175pub fn from_reader(reader: impl BufRead) -> Result<Release, rfc822_like::de::Error> {
176    rfc822_like::from_reader(reader)
177}
178
179/// Read release from a string
180pub fn from_str(data: &str) -> Result<Release, rfc822_like::de::Error> {
181    rfc822_like::from_str(data)
182}
183
184#[cfg(test)]
185mod test {
186    use super::*;
187
188    #[test]
189    fn archive() {
190        let data = r"Origin: Debian-ramacher.at
191Label: Debian-ramacher.at
192Suite: unstable
193Codename: sid
194Version: 13.0
195Date: Sun, 17 Dec 2023 18:43:37 UTC
196Architectures: i386 amd64
197Components: main
198Description: Experimental and unfinished Debian packages (for unstable)
199MD5Sum:
200 628a4efab35e598c7b6debdb0ac85314 26187 main/binary-i386/Packages
201 6c849211e65839aac2682c461c82dbb3 7777 main/binary-i386/Packages.gz
202 05ee2bfa660c3acc3559928769c29730 191 main/binary-i386/Release
203 d41d8cd98f00b204e9800998ecf8427e 0 main/debian-installer/binary-i386/Packages
204 7029066c27ac6f5ef18d660d5741979a 20 main/debian-installer/binary-i386/Packages.gz
205 296265926c83b0d9d9d43fcc6c43496d 30187 main/binary-amd64/Packages
206 8dad6d33daa175a4a54b9d328e9bb491 8821 main/binary-amd64/Packages.gz
207 c0f8f3dd5202483a2b57bb348a3741a6 192 main/binary-amd64/Release
208 d41d8cd98f00b204e9800998ecf8427e 0 main/debian-installer/binary-amd64/Packages
209 7029066c27ac6f5ef18d660d5741979a 20 main/debian-installer/binary-amd64/Packages.gz
210 4b35b2727e9c1d87c775e35fd8d00cf4 15130 main/source/Sources
211 689c40d665e43a8f9a94d6e2b1dd47a4 4582 main/source/Sources.gz
212 3ce12e6e384a34e6e1850bcc192edf8c 193 main/source/Release
213SHA1:
214 da7a5b4f20e79cab9bacca996d83419d5224a709 26187 main/binary-i386/Packages
215 a0b5ae4166358c741f1c27bf457c3b31bcdb495a 7777 main/binary-i386/Packages.gz
216 046a2ee510a7ea14c8b718dd153077b0359b3509 191 main/binary-i386/Release
217 da39a3ee5e6b4b0d3255bfef95601890afd80709 0 main/debian-installer/binary-i386/Packages
218 46c6643f07aa7f6bfe7118de926b86defc5087c4 20 main/debian-installer/binary-i386/Packages.gz
219 d7fc79844dbc2702ca889a985f716374f7c8b9a5 30187 main/binary-amd64/Packages
220 21374a60ce3d47b87bac11b3b3a96795020a0d41 8821 main/binary-amd64/Packages.gz
221 01f970b6eae435dd8b6b1f8f61727db854212ce4 192 main/binary-amd64/Release
222 da39a3ee5e6b4b0d3255bfef95601890afd80709 0 main/debian-installer/binary-amd64/Packages
223 46c6643f07aa7f6bfe7118de926b86defc5087c4 20 main/debian-installer/binary-amd64/Packages.gz
224 12b46a55c05518bfcfb267908185f041a1b984ae 15130 main/source/Sources
225 5e2bfa609cbc328e07336f8e17707683fda37011 4582 main/source/Sources.gz
226 96d0688be60481ba7eb71007b609bdf1f8323725 193 main/source/Release
227SHA256:
228 efe2dafdf6a50f376af1dfc574d6bd3360558fde917555671b13832c89604d9f 26187 main/binary-i386/Packages
229 ba66d22607be572323b72ca152d6e635fab075d92a2265bbfe319337c35ccd13 7777 main/binary-i386/Packages.gz
230 e6be53e3210056ed6854cf2a362cb953eaa962ea811cfbe34cdad2807be61101 191 main/binary-i386/Release
231 e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 0 main/debian-installer/binary-i386/Packages
232 59869db34853933b239f1e2219cf7d431da006aa919635478511fabbfc8849d2 20 main/debian-installer/binary-i386/Packages.gz
233 baf930986b322ef7ff8cc04fa57762c68e7f9d8b67a0423bd5441686cbf3e751 30187 main/binary-amd64/Packages
234 0ad7ab0202ece24b57051f16010c72479b97e905c659f975eac5d69284c562f3 8821 main/binary-amd64/Packages.gz
235 97e06eefea86617e4abc8a647d0faebd0eaca7c87031423a4ae1d38e8f1c97bb 192 main/binary-amd64/Release
236 e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 0 main/debian-installer/binary-amd64/Packages
237 59869db34853933b239f1e2219cf7d431da006aa919635478511fabbfc8849d2 20 main/debian-installer/binary-amd64/Packages.gz
238 b0a524d1ba90e253c937859e3ce30bc49a291e33dbb8124706424cf5c06100a8 15130 main/source/Sources
239 2bc04b364bfc30657836faf8d1de7f6044652bcca6af6503ef404a086897267a 4582 main/source/Sources.gz
240 3637559f78ac17d0e55bce465d510ef912d539e4b810a66b32431dd76f5929d8 193 main/source/Release";
241        let release = from_str(data).unwrap();
242
243        assert_eq!(
244            release.architectures,
245            vec![Architecture::I386, Architecture::Amd64]
246        );
247        assert_eq!(release.components, vec![Component::Main]);
248        assert_eq!(release.suite, Suite::Unstable);
249        assert_eq!(release.codename, Codename::Sid);
250        assert!(release.files.contains_key("main/source/Release"));
251        assert_eq!(
252            release.files["main/source/Release"],
253            FileInfo {
254                file_size: 193,
255                hash: [
256                    0x36, 0x37, 0x55, 0x9f, 0x78, 0xac, 0x17, 0xd0, 0xe5, 0x5b, 0xce, 0x46, 0x5d,
257                    0x51, 0x0e, 0xf9, 0x12, 0xd5, 0x39, 0xe4, 0xb8, 0x10, 0xa6, 0x6b, 0x32, 0x43,
258                    0x1d, 0xd7, 0x6f, 0x59, 0x29, 0xd8
259                ]
260            }
261        );
262    }
263}
assorted_debian_utils/release.rs

assorted_debian_utils/
release.rs
