ferro-oci-server 0.0.1

OCI Distribution Specification v1.1 server-side primitives — manifest / blob / tag / referrers handlers, chunked uploads, in-memory metadata plane. Backed by ferro-blob-store. Extracted from the Ferro ecosystem.
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

// SPDX-License-Identifier: Apache-2.0
//! Referrers API.
//!
//! Spec: OCI Distribution Spec v1.1 §3.3 "Content Discovery".
//!
//! - `GET /v2/{name}/referrers/{digest}?artifactType=<type>`;
//! - Response is an OCI image index whose `manifests` array contains
//!   one descriptor per referrer;
//! - When `artifactType` is supplied and filtering applied, the
//!   response MUST include the `OCI-Filters-Applied: artifactType`
//!   header so the client knows the server honoured the filter.

use std::collections::BTreeMap;

use axum::Json;
use axum::http::{HeaderMap, HeaderValue, StatusCode, header};
use axum::response::{IntoResponse, Response};
use ferro_blob_store::Digest;
use serde_json::json;

use crate::error::{OciError, OciErrorCode};
use crate::media_types::OCI_IMAGE_INDEX;
use crate::reference::validate_name;
use crate::router::AppState;

/// Handle `GET /v2/{name}/referrers/{digest}`.
///
/// Spec: OCI Distribution Spec v1.1 §3.3.
pub async fn get_referrers(
    state: &AppState,
    name: &str,
    digest_str: &str,
    params: &BTreeMap<String, String>,
) -> Response {
    if let Err(e) = validate_name(name) {
        return e.into_response();
    }
    let digest = match digest_str.parse::<Digest>() {
        Ok(d) => d,
        Err(e) => {
            return OciError::new(
                OciErrorCode::DigestInvalid,
                format!("invalid digest `{digest_str}`: {e}"),
            )
            .into_response();
        }
    };

    let artifact_type = params.get("artifactType").map(String::as_str);
    let referrers = match state
        .registry
        .list_referrers(name, &digest, artifact_type)
        .await
    {
        Ok(v) => v,
        Err(e) => return OciError::from(e).into_response(),
    };

    let body = json!({
        "schemaVersion": 2,
        "mediaType": OCI_IMAGE_INDEX,
        "manifests": referrers,
    });

    let mut headers = HeaderMap::new();
    headers.insert(
        header::CONTENT_TYPE,
        HeaderValue::from_static(OCI_IMAGE_INDEX),
    );
    if artifact_type.is_some() {
        headers.insert(
            "OCI-Filters-Applied",
            HeaderValue::from_static("artifactType"),
        );
    }
    (StatusCode::OK, headers, Json(body)).into_response()
}