pinner 0.0.6

Secure CI/CD workflows by pinning mutable tags to immutable SHA-1 hashes. A high-performance Rust CLI that preserves YAML formatting and comments. Supports GitHub, GitLab, Bitbucket, Forgejo, and Docker image pinning.
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
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
use crate::error::PinnerError;
use async_trait::async_trait;
use reqwest::header::{HeaderMap, HeaderValue, ACCEPT};
use serde::Deserialize;

#[cfg(test)]
use mockall::automock;

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

    #[tokio::test]
    async fn test_resolve_digest_docker_hub() {
        let mut server = Server::new_async().await;
        let token_resp = r#"{"token":"test-token"}"#;
        let auth_path = "/token";
        let _m1 = server
            .mock("GET", mockito::Matcher::Any)
            .with_status(200)
            .with_header("content-type", "application/json")
            .with_body(token_resp)
            .create_async()
            .await;

        let manifest_path = "/v2/library/alpine/manifests/latest";
        let _m2 = server
            .mock("GET", manifest_path)
            .match_header("Authorization", "Bearer test-token")
            .with_status(200)
            .with_header("Docker-Content-Digest", "sha256:123")
            .create_async()
            .await;

        let provider = OciRegistryProvider::with_base_urls(
            format!("{}{}", server.url(), auth_path),
            format!("{}{}", server.url(), "/v2/{repository}/manifests/{tag}"),
        );

        let digest = provider.resolve_digest("alpine", "latest").await.unwrap();
        assert_eq!(digest, "sha256:123");
    }

    #[tokio::test]
    async fn test_resolve_digest_ghcr() {
        let mut server = Server::new_async().await;
        let manifest_path = "/v2/owner/repo/manifests/v1";
        let _m1 = server
            .mock("GET", manifest_path)
            .with_status(200)
            .with_header("Digest", "sha256:ghcr123")
            .create_async()
            .await;

        let provider = OciRegistryProvider::with_base_urls(
            "http://auth".to_string(),
            format!("{}{}", server.url(), "/v2/{repository}/manifests/{tag}"),
        );

        let digest = provider
            .resolve_digest("ghcr.io/owner/repo", "v1")
            .await
            .unwrap();
        assert_eq!(digest, "sha256:ghcr123");
    }

    #[tokio::test]
    async fn test_resolve_digest_invalid_token_json() {
        let mut server = Server::new_async().await;
        let _m1 = server
            .mock("GET", mockito::Matcher::Any)
            .with_status(200)
            .with_body("invalid json")
            .create_async()
            .await;

        let provider = OciRegistryProvider::with_base_urls(
            server.url(),
            format!("{}/v2/{{repository}}/manifests/{{tag}}", server.url()),
        );

        let res = provider.resolve_digest("alpine", "latest").await;
        assert!(res.is_err());
    }

    #[tokio::test]
    async fn test_get_token_non_docker_hub() {
        let provider = OciRegistryProvider::new(None, None);
        let token = provider.get_token("ghcr.io", "owner/repo").await.unwrap();
        assert!(token.is_empty());
    }

    #[tokio::test]
    async fn test_oci_registry_parsing() {
        let provider = OciRegistryProvider::new(None, None);

        // Docker Hub library image
        // We don't assert error here because if get_token returns empty/ok it might proceed
        // to a real network call if not mocked.
        // Instead, just call it to cover the parsing code paths.
        let _ = provider.resolve_digest("nginx", "latest").await;

        // Custom registry
        let _ = provider.resolve_digest("ghcr.io/owner/repo", "v1").await;
    }

    #[tokio::test]
    async fn test_oci_auth_headers() {
        let mut server = mockito::Server::new_async().await;
        let provider = OciRegistryProvider::with_base_urls(
            format!("{}/auth", server.url()),
            format!("{}/v2/{{repository}}/manifests/{{tag}}", server.url()),
        );

        let _m_token = server
            .mock("GET", mockito::Matcher::Regex("^/auth".to_string()))
            .with_status(200)
            .with_header("content-type", "application/json")
            .with_body(r#"{"token":"abc"}"#)
            .create_async()
            .await;

        let _m_manifest = server
            .mock("GET", "/v2/library/nginx/manifests/latest")
            .match_header("Authorization", "Bearer abc")
            .with_status(200)
            .with_header("docker-content-digest", "sha256:12345")
            .create_async()
            .await;

        let res = provider.resolve_digest("nginx", "latest").await.unwrap();
        assert_eq!(res, "sha256:12345");
    }

    #[tokio::test]
    async fn test_oci_auth_with_credentials() {
        let mut server = mockito::Server::new_async().await;
        let provider = OciRegistryProvider {
            client: reqwest::Client::new(),
            auth_url: format!("{}/auth", server.url()),
            base_url_template: format!("{}/v2/{{repository}}/manifests/{{tag}}", server.url()),
            username: Some("user".into()),
            password: Some("pass".into()),
        };

        let _m_token = server
            .mock("GET", mockito::Matcher::Regex("^/auth".to_string()))
            .match_header("Authorization", "Basic dXNlcjpwYXNz") // user:pass
            .with_status(200)
            .with_header("content-type", "application/json")
            .with_body(r#"{"token":"token123"}"#)
            .create_async()
            .await;

        let _m_manifest = server
            .mock("GET", "/v2/library/nginx/manifests/latest")
            .match_header("Authorization", "Bearer token123")
            .with_status(200)
            .with_header("docker-content-digest", "sha256:54321")
            .create_async()
            .await;

        let res = provider.resolve_digest("nginx", "latest").await.unwrap();
        assert_eq!(res, "sha256:54321");
    }

    #[tokio::test]
    async fn test_oci_registry_fallback() {
        let mut server = mockito::Server::new_async().await;
        let provider = OciRegistryProvider::with_base_urls(
            format!("{}/auth", server.url()),
            format!("{}/v2/{{repository}}/manifests/{{tag}}", server.url()),
        );

        let _m_token = server
            .mock("GET", mockito::Matcher::Regex("^/auth".to_string()))
            .with_status(200)
            .with_header("content-type", "application/json")
            .with_body(r#"{"token":"abc"}"#)
            .create_async()
            .await;

        let _m_manifest = server
            .mock("GET", "/v2/owner/repo/manifests/v1")
            .with_status(200)
            .with_header("Digest", "sha256:fallback")
            .create_async()
            .await;

        // Image without dot in first part should fallback to registry-1.docker.io
        let res = provider.resolve_digest("owner/repo", "v1").await.unwrap();
        assert_eq!(res, "sha256:fallback");
    }

    #[tokio::test]
    async fn test_oci_auth_basic_non_docker_hub() {
        let mut server = mockito::Server::new_async().await;
        let provider = OciRegistryProvider {
            client: reqwest::Client::new(),
            auth_url: "http://auth".into(),
            base_url_template: format!("{}/v2/{{repository}}/manifests/{{tag}}", server.url()),
            username: Some("user".into()),
            password: Some("pass".into()),
        };

        let _m = server
            .mock("GET", "/v2/owner/repo/manifests/v1")
            .match_header("Authorization", "Basic dXNlcjpwYXNz") // user:pass
            .with_status(200)
            .with_header("Digest", "sha256:basic")
            .create_async()
            .await;

        let res = provider
            .resolve_digest("ghcr.io/owner/repo", "v1")
            .await
            .unwrap();
        assert_eq!(res, "sha256:basic");
    }

    #[test]
    fn test_oci_provider_default() {
        let p = OciRegistryProvider::default();
        assert!(p.username.is_none());
    }

    #[tokio::test]
    async fn test_resolve_digest_error() {
        let mut server = Server::new_async().await;
        let _m1 = server
            .mock("GET", "/v2/library/alpine/manifests/latest")
            .with_status(404)
            .create_async()
            .await;

        let provider = OciRegistryProvider::with_base_urls(
            format!("{}/auth", server.url()),
            format!("{}/v2/{{repository}}/manifests/{{tag}}", server.url()),
        );

        let res = provider.resolve_digest("alpine", "latest").await;
        assert!(res.is_err());
    }
}

/// Trait for interacting with OCI registries.
#[cfg_attr(test, automock)]
#[async_trait]
pub trait RegistryProvider: Send + Sync {
    /// Resolves a docker image tag to its digest.
    async fn resolve_digest(&self, image: &str, tag: &str) -> Result<String, PinnerError>;
}

/// Implementation of [`RegistryProvider`] for OCI-compliant registries.
#[derive(Clone)]
pub struct OciRegistryProvider {
    client: reqwest::Client,
    auth_url: String,
    base_url_template: String,
    username: Option<String>,
    password: Option<String>,
}

impl Default for OciRegistryProvider {
    fn default() -> Self {
        Self::new(None, None)
    }
}

impl OciRegistryProvider {
    pub fn new(username: Option<String>, password: Option<String>) -> Self {
        Self {
            client: reqwest::Client::new(),
            auth_url: "https://auth.docker.io/token".to_string(),
            base_url_template: "https://{registry}/v2/{repository}/manifests/{tag}".to_string(),
            username,
            password,
        }
    }

    #[cfg(test)]
    pub fn with_base_urls(auth_url: String, base_url_template: String) -> Self {
        Self {
            client: reqwest::Client::new(),
            auth_url,
            base_url_template,
            username: None,
            password: None,
        }
    }

    async fn get_token(&self, registry: &str, repository: &str) -> Result<String, PinnerError> {
        let url = if registry == "docker.io" || registry == "registry-1.docker.io" {
            format!(
                "{}?service=registry.docker.io&scope=repository:{}:pull",
                self.auth_url, repository
            )
        } else {
            return Ok("".to_string());
        };

        let mut rb = self.client.get(&url);
        if let (Some(u), Some(p)) = (&self.username, &self.password) {
            rb = rb.basic_auth(u, Some(p));
        }

        let resp = rb
            .send()
            .await
            .map_err(|e| PinnerError::Api(e.to_string()))?;

        #[derive(Deserialize)]
        struct TokenResponse {
            token: String,
        }

        let res: TokenResponse = resp
            .json()
            .await
            .map_err(|e| PinnerError::Api(e.to_string()))?;
        Ok(res.token)
    }
}

#[async_trait]
impl RegistryProvider for OciRegistryProvider {
    async fn resolve_digest(&self, image: &str, tag: &str) -> Result<String, PinnerError> {
        let (registry, repository) = if let Some(pos) = image.find('/') {
            let first_part = &image[..pos];
            if first_part.contains('.') || first_part.contains(':') || first_part == "localhost" {
                (first_part, &image[pos + 1..])
            } else {
                ("registry-1.docker.io", image)
            }
        } else {
            ("registry-1.docker.io", image)
        };

        // Standard Docker Hub library images
        let full_repo = if registry == "registry-1.docker.io" && !repository.contains('/') {
            format!("library/{}", repository)
        } else {
            repository.to_string()
        };

        let token = self.get_token(registry, &full_repo).await?;

        let url = self
            .base_url_template
            .replace("{registry}", registry)
            .replace("{repository}", &full_repo)
            .replace("{tag}", tag);

        let mut headers = HeaderMap::new();
        headers.insert(
            ACCEPT,
            HeaderValue::from_static("application/vnd.oci.image.manifest.v1+json"),
        );
        headers.append(
            ACCEPT,
            HeaderValue::from_static("application/vnd.docker.distribution.manifest.v2+json"),
        );

        if !token.is_empty() {
            headers.insert(
                "Authorization",
                HeaderValue::from_str(&format!("Bearer {}", token))
                    .map_err(|e| PinnerError::Api(e.to_string()))?,
            );
        } else if let (Some(u), Some(p)) = (&self.username, &self.password) {
            let auth = format!("{}:{}", u, p);
            headers.insert(
                "Authorization",
                HeaderValue::from_str(&format!("Basic {}", b64_encode(&auth)))
                    .map_err(|e| PinnerError::Api(e.to_string()))?,
            );
        }

        let resp = self
            .client
            .get(&url)
            .headers(headers)
            .send()
            .await
            .map_err(|e| PinnerError::Api(e.to_string()))?;

        if resp.status().is_success() {
            let digest = resp
                .headers()
                .get("Docker-Content-Digest")
                .or_else(|| resp.headers().get("Digest"))
                .and_then(|h| h.to_str().ok())
                .ok_or_else(|| PinnerError::Api("Digest not found in response headers".into()))?;
            Ok(digest.to_string())
        } else {
            Err(PinnerError::Api(format!(
                "Failed to fetch manifest: HTTP {}",
                resp.status()
            )))
        }
    }
}

fn b64_encode(s: &str) -> String {
    use base64::{engine::general_purpose, Engine as _};
    general_purpose::STANDARD.encode(s)
}