vein 0.4.0

A fast, intelligent RubyGems proxy/mirror server written in Rust
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

use std::time::Instant;

use anyhow::{Context, Result};
use rama::{
    http::{Body, Method, Request, Uri},
    telemetry::tracing,
};
use vein_adapter::{AssetKey, AssetKind};

/// Cache status for request tracking
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum CacheStatus {
    Pass,
    Hit,
    Miss,
    Revalidated,
    Error,
}

impl std::fmt::Display for CacheStatus {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            CacheStatus::Pass => write!(f, "pass"),
            CacheStatus::Hit => write!(f, "hit"),
            CacheStatus::Miss => write!(f, "miss"),
            CacheStatus::Revalidated => write!(f, "revalidated"),
            CacheStatus::Error => write!(f, "error"),
        }
    }
}

/// Request context for tracking request lifecycle
pub struct RequestContext {
    pub start: Instant,
    pub method: Method,
    pub path: String,
    pub cache: CacheStatus,
}

impl Default for RequestContext {
    fn default() -> Self {
        Self {
            start: Instant::now(),
            method: Method::GET,
            path: String::new(),
            cache: CacheStatus::Pass,
        }
    }
}

impl RequestContext {
    pub fn from_request(req: &Request<Body>) -> Self {
        Self {
            start: Instant::now(),
            method: req.method().clone(),
            path: req.uri().path().to_string(),
            cache: CacheStatus::Pass,
        }
    }
}

/// Represents a cacheable gem or spec request
pub struct CacheableRequest {
    pub kind: AssetKind,
    pub name: String,
    pub version: String,
    pub platform: Option<String>,
    pub file_name: String,
    pub relative_path: String,
}

impl CacheableRequest {
    pub fn from_request(req: &Request<rama::http::Body>) -> Option<Self> {
        let path = req.uri().path();
        if path.starts_with("/gems/") {
            Self::from_gem_path(path.strip_prefix("/gems/")?)
        } else if path.starts_with("/quick/Marshal.4.8/") {
            Self::from_spec_path(path.strip_prefix("/quick/Marshal.4.8/")?)
        } else {
            None
        }
    }

    pub fn from_gem_path(file: &str) -> Option<Self> {
        if !file.ends_with(".gem") {
            return None;
        }
        // Reject path traversal attempts
        if file.contains("..") || file.contains("//") || file.starts_with('/') {
            tracing::warn!(file = %file, "Rejected potential path traversal attempt");
            return None;
        }
        let file_name = file.to_string();
        let stem = file.strip_suffix(".gem")?;
        let (name, version, platform) = super::utils::split_name_version_platform(stem)?;
        // Double check the parsed name doesn't contain path traversal
        if name.contains("..") || name.contains('/') {
            tracing::warn!(name = %name, "Rejected malformed gem name");
            return None;
        }
        let relative_path = format!("gems/{name}/{file}");
        Some(Self {
            kind: AssetKind::Gem,
            name,
            version,
            platform,
            file_name,
            relative_path,
        })
    }

    pub fn from_spec_path(file: &str) -> Option<Self> {
        if !file.ends_with(".gemspec.rz") {
            return None;
        }
        // Reject path traversal attempts
        if file.contains("..") || file.contains("//") || file.starts_with('/') {
            tracing::warn!(file = %file, "Rejected potential path traversal attempt in spec");
            return None;
        }
        let file_name = file.to_string();
        let stem = file.strip_suffix(".gemspec.rz")?;
        let (name, version, platform) = super::utils::split_name_version_platform(stem)?;
        // Double check the parsed name doesn't contain path traversal
        if name.contains("..") || name.contains('/') {
            tracing::warn!(name = %name, "Rejected malformed gem name in spec");
            return None;
        }
        let relative_path = format!("quick/Marshal.4.8/{name}/{file}");
        Some(Self {
            kind: AssetKind::Spec,
            name,
            version,
            platform,
            file_name,
            relative_path,
        })
    }

    pub fn asset_key(&self) -> AssetKey<'_> {
        AssetKey {
            kind: self.kind,
            name: &self.name,
            version: &self.version,
            platform: self.platform.as_deref(),
        }
    }

    pub fn download_name(&self) -> &str {
        &self.file_name
    }

    pub fn content_type(&self) -> &'static str {
        match self.kind {
            AssetKind::Gem => "application/octet-stream",
            AssetKind::Spec => "application/x-deflate",
        }
    }
}

/// Upstream target configuration
#[derive(Clone)]
pub struct UpstreamTarget {
    pub base: Uri,
}

impl UpstreamTarget {
    pub fn from_url(url: &Uri) -> Result<Self> {
        Ok(Self { base: url.clone() })
    }

    pub fn join(&self, req: &Request<rama::http::Body>) -> Result<Uri> {
        let req_path_and_query = req
            .uri()
            .path_and_query()
            .map(|pq| pq.as_str())
            .unwrap_or("/");

        // Get base path, stripping trailing slash
        let base_path = self
            .base
            .path_and_query()
            .map(|pq| pq.path())
            .unwrap_or("/")
            .trim_end_matches('/');

        // Split request into path and query
        let (req_path, query) = match req_path_and_query.find('?') {
            Some(idx) => (&req_path_and_query[..idx], Some(&req_path_and_query[idx..])),
            None => (req_path_and_query, None),
        };

        // Build combined path
        let combined = if base_path.is_empty() || base_path == "/" {
            req_path.to_string()
        } else {
            format!("{}{}", base_path, req_path)
        };

        // Add query string if present
        let full_path = match query {
            Some(q) => format!("{}{}", combined, q),
            None => combined,
        };

        let mut parts = self.base.clone().into_parts();
        parts.path_and_query = Some(
            full_path
                .parse()
                .with_context(|| format!("parse combined path '{full_path}'"))?,
        );

        Uri::from_parts(parts)
            .with_context(|| format!("joining upstream path {req_path_and_query}"))
    }
}