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
use super::{Descriptor, MediaType};
use crate::error::{OciSpecError, Result};
use derive_builder::Builder;
use getset::{Getters, MutGetters, Setters};
use serde::{Deserialize, Serialize};
use std::{
collections::HashMap,
io::{Read, Write},
path::Path,
};
#[derive(
Builder, Clone, Debug, Deserialize, Eq, Getters, MutGetters, Setters, PartialEq, Serialize,
)]
#[serde(rename_all = "camelCase")]
#[builder(
pattern = "owned",
setter(into, strip_option),
build_fn(error = "OciSpecError")
)]
/// The OCI Artifact manifest describes content addressable artifacts
/// in order to store them along side container images in a registry.
pub struct ArtifactManifest {
/// This property MUST be used and contain the media type
/// `application/vnd.oci.artifact.manifest.v1+json`.
#[getset(get = "pub")]
#[builder(default = "MediaType::ArtifactManifest")]
#[builder(setter(skip))]
media_type: MediaType,
/// This property SHOULD be used and contain
/// the mediaType of the referenced artifact.
/// If defined, the value MUST comply with RFC 6838,
/// including the naming requirements in its section 4.2,
/// and MAY be registered with IANA.
#[getset(get = "pub", set = "pub")]
artifact_type: MediaType,
/// This OPTIONAL property is an array of objects and each item
/// in the array MUST be a descriptor. Each descriptor represents
/// an artifact of any IANA mediaType. The list MAY be ordered
/// for certain artifact types like scan results.
#[getset(get_mut = "pub", get = "pub", set = "pub")]
#[builder(default)]
blobs: Vec<Descriptor>,
/// This OPTIONAL property specifies a descriptor of another manifest.
/// This value, used by the referrers API, indicates a relationship
/// to the specified manifest.
#[serde(skip_serializing_if = "Option::is_none")]
#[getset(get = "pub", set = "pub")]
#[builder(default)]
subject: Option<Descriptor>,
/// This OPTIONAL property contains additional metadata for the artifact
/// manifest. This OPTIONAL property MUST use the annotation rules.
/// See Pre-Defined Annotation Keys. Annotations MAY be used to filter
/// the response from the referrers API.
#[serde(skip_serializing_if = "Option::is_none")]
#[getset(get_mut = "pub", get = "pub", set = "pub")]
#[builder(default)]
annotations: Option<HashMap<String, String>>,
}
impl ArtifactManifest {
/// Attempts to load an image manifest from a file.
///
/// # Errors
///
/// - [OciSpecError::Io] if the file does not exist
/// - [OciSpecError::SerDe] if the image manifest cannot be deserialized.
///
/// # Example
///
/// ``` no_run
/// use oci_spec::image::ArtifactManifest;
///
/// let artifact_manifest = ArtifactManifest::from_file("manifest.json").unwrap();
/// ```
pub fn from_file(path: impl AsRef<Path>) -> Result<Self> {
crate::from_file(path)
}
/// Attempts to load an image manifest from a stream.
///
/// # Errors
///
/// - [OciSpecError::SerDe](crate::OciSpecError::SerDe) if the manifest cannot be deserialized.
///
/// # Example
///
/// ``` no_run
/// use oci_spec::image::ArtifactManifest;
/// use std::fs::File;
///
/// let reader = File::open("manifest.json").unwrap();
/// let artifact_manifest = ArtifactManifest::from_reader(reader).unwrap();
/// ```
pub fn from_reader<R: Read>(reader: R) -> Result<Self> {
crate::from_reader(reader)
}
/// Attempts to write an image manifest to a file as JSON. If the file already exists, it
/// will be overwritten.
///
/// # Errors
///
/// - [OciSpecError::SerDe](crate::OciSpecError::SerDe) if the image manifest cannot be serialized.
///
/// # Example
///
/// ``` no_run
/// use oci_spec::image::ArtifactManifest;
///
/// let artifact_manifest = ArtifactManifest::from_file("manifest.json").unwrap();
/// artifact_manifest.to_file("my-manifest.json").unwrap();
/// ```
pub fn to_file<P: AsRef<Path>>(&self, path: P) -> Result<()> {
crate::to_file(&self, path, false)
}
/// Attempts to write an image manifest to a file as pretty printed JSON. If the file already exists, it
/// will be overwritten.
///
/// # Errors
///
/// - [OciSpecError::SerDe](crate::OciSpecError::SerDe) if the image manifest cannot be serialized.
///
/// # Example
///
/// ``` no_run
/// use oci_spec::image::ArtifactManifest;
///
/// let artifact_manifest = ArtifactManifest::from_file("manifest.json").unwrap();
/// artifact_manifest.to_file_pretty("my-manifest.json").unwrap();
/// ```
pub fn to_file_pretty<P: AsRef<Path>>(&self, path: P) -> Result<()> {
crate::to_file(&self, path, true)
}
/// Attempts to write an image manifest to a stream as JSON.
///
/// # Errors
///
/// - [OciSpecError::SerDe](crate::OciSpecError::SerDe) if the image manifest cannot be serialized.
///
/// # Example
///
/// ``` no_run
/// use oci_spec::image::ArtifactManifest;
///
/// let artifact_manifest = ArtifactManifest::from_file("manifest.json").unwrap();
/// let mut writer = Vec::new();
/// artifact_manifest.to_writer(&mut writer);
/// ```
pub fn to_writer<W: Write>(&self, writer: &mut W) -> Result<()> {
crate::to_writer(&self, writer, false)
}
/// Attempts to write an image manifest to a stream as pretty printed JSON.
///
/// # Errors
///
/// - [OciSpecError::SerDe](crate::OciSpecError::SerDe) if the image manifest cannot be serialized.
///
/// # Example
///
/// ``` no_run
/// use oci_spec::image::ArtifactManifest;
///
/// let artifact_manifest = ArtifactManifest::from_file("manifest.json").unwrap();
/// let mut writer = Vec::new();
/// artifact_manifest.to_writer_pretty(&mut writer);
/// ```
pub fn to_writer_pretty<W: Write>(&self, writer: &mut W) -> Result<()> {
crate::to_writer(&self, writer, true)
}
/// Attempts to write an image manifest to a string as JSON.
///
/// # Errors
///
/// - [OciSpecError::SerDe](crate::OciSpecError::SerDe) if the image configuration cannot be serialized.
///
/// # Example
///
/// ``` no_run
/// use oci_spec::image::ArtifactManifest;
///
/// let artifact_manifest = ArtifactManifest::from_file("manifest.json").unwrap();
/// let json_str = artifact_manifest.to_string().unwrap();
/// ```
pub fn to_string(&self) -> Result<String> {
crate::to_string(&self, false)
}
/// Attempts to write an image manifest to a string as pretty printed JSON.
///
/// # Errors
///
/// - [OciSpecError::SerDe](crate::OciSpecError::SerDe) if the image configuration cannot be serialized.
///
/// # Example
///
/// ``` no_run
/// use oci_spec::image::ArtifactManifest;
///
/// let artifact_manifest = ArtifactManifest::from_file("manifest.json").unwrap();
/// let json_str = artifact_manifest.to_string_pretty().unwrap();
/// ```
pub fn to_string_pretty(&self) -> Result<String> {
crate::to_string(&self, true)
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::image::{DescriptorBuilder, Sha256Digest};
use std::{path::PathBuf, str::FromStr};
fn get_manifest_path() -> PathBuf {
PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("test/data/artifact_manifest.json")
}
fn create_manifest() -> ArtifactManifest {
let blob = DescriptorBuilder::default()
.media_type(MediaType::Other("application/gzip".to_string()))
.size(123u64)
.digest(
Sha256Digest::from_str(
"87923725d74f4bfb94c9e86d64170f7521aad8221a5de834851470ca142da630",
)
.unwrap(),
)
.build()
.unwrap();
let subject = DescriptorBuilder::default()
.media_type(MediaType::ImageManifest)
.size(1234u64)
.digest(
Sha256Digest::from_str(
"cc06a2839488b8bd2a2b99dcdc03d5cfd818eed72ad08ef3cc197aac64c0d0a0",
)
.unwrap(),
)
.build()
.unwrap();
let annotations = HashMap::from([
(
"org.opencontainers.artifact.created".to_string(),
"2022-01-01T14:42:55Z".to_string(),
),
("org.example.sbom.format".to_string(), "json".to_string()),
]);
ArtifactManifestBuilder::default()
.artifact_type(MediaType::Other(
"application/vnd.example.sbom.v1".to_string(),
))
.blobs(vec![blob])
.subject(subject)
.annotations(annotations)
.build()
.unwrap()
}
#[test]
fn load_manifest_from_file() {
// arrange
let manifest_path = get_manifest_path();
let expected = create_manifest();
// act
let actual = ArtifactManifest::from_file(manifest_path).expect("from file");
// assert
assert_eq!(actual, expected);
}
}