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
//! A module for client storage implementations.
use anyhow::{Error, Result};
use async_trait::async_trait;
use bytes::Bytes;
use futures_util::Stream;
use indexmap::IndexMap;
use reqwest::header::HeaderValue;
use serde::{Deserialize, Serialize};
use std::{path::PathBuf, pin::Pin, str::FromStr, time::SystemTime};
use warg_crypto::{
hash::{AnyHash, HashAlgorithm},
signing::{self, KeyID, PublicKey},
};
use warg_protocol::{
operator,
package::{self, PackageRecord, Permission, PACKAGE_RECORD_VERSION},
registry::{Checkpoint, PackageName, RecordId, RegistryIndex, TimestampedCheckpoint},
ProtoEnvelope, SerdeEnvelope, Version,
};
mod fs;
pub use fs::*;
/// Registry domain used for warg header values
#[derive(Clone)]
pub struct RegistryDomain(String);
// impl From<String> for RegistryDomain {
// fn from(value: String) -> Self {
// RegistryDomain(value)
// }
// }
impl FromStr for RegistryDomain {
type Err = Error;
fn from_str(s: &str) -> std::prelude::v1::Result<Self, Self::Err> {
Ok(RegistryDomain(s.to_string()))
}
}
impl ToString for RegistryDomain {
fn to_string(&self) -> String {
self.0.clone()
}
}
// impl TryFrom<HeaderValue> for RegistryName ...
// impl From<RegistryDomain> for HeaderValue {
// fn from(value: RegistryDomain) -> Self {
// HeaderValue::to_str(&value.to_string())
// }
// }
impl TryFrom<RegistryDomain> for HeaderValue {
type Error = Error;
fn try_from(value: RegistryDomain) -> std::prelude::v1::Result<Self, Self::Error> {
Ok(HeaderValue::from_str(&value.to_string())?)
}
}
// impl TryInto<RegistryDomain> for HeaderValue {
// type Error = Error;
// fn try_into(self) -> std::result::Result<RegistryDomain, anyhow::Error> {
// // Ok(HeaderValue::from_str(&value.to_string())?)
// }
// }
/// Trait for registry storage implementations.
///
/// Stores information such as package/operator logs and checkpoints
/// on a per-registry basis.
///
/// Registry storage data must be synchronized if shared between
/// multiple threads and processes.
#[async_trait]
pub trait RegistryStorage: Send + Sync {
/// Reset registry local data
async fn reset(&self, all_registries: bool) -> Result<()>;
// /// Directory where all registries are stored
// fn registries_dir(&self) -> PathBuf;
/// Loads most recent checkpoint
async fn load_checkpoint(
&self,
namespace_registry: &Option<RegistryDomain>,
) -> Result<Option<SerdeEnvelope<TimestampedCheckpoint>>>;
/// Stores most recent checkpoint
async fn store_checkpoint(
&self,
namespace_registry: &Option<RegistryDomain>,
ts_checkpoint: &SerdeEnvelope<TimestampedCheckpoint>,
) -> Result<()>;
/// Loads the operator information from the storage.
///
/// Returns `Ok(None)` if the information is not present.
async fn load_operator(
&self,
namespace_registry: &Option<RegistryDomain>,
) -> Result<Option<OperatorInfo>>;
/// Stores the operator information in the storage.
async fn store_operator(
&self,
namespace_registry: &Option<RegistryDomain>,
operator: OperatorInfo,
) -> Result<()>;
/// Loads the package information for all packages in the home registry storage .
async fn load_packages(&self) -> Result<Vec<PackageInfo>>;
/// Loads the package information for all packages in all registry storages.
async fn load_all_packages(&self) -> Result<IndexMap<String, Vec<PackageInfo>>>;
/// Loads the package information from the storage.
///
/// Returns `Ok(None)` if the information is not present.
async fn load_package(
&self,
namespace_registry: &Option<RegistryDomain>,
package: &PackageName,
) -> Result<Option<PackageInfo>>;
/// Stores the package information in the storage.
async fn store_package(
&self,
namespace_registry: &Option<RegistryDomain>,
info: &PackageInfo,
) -> Result<()>;
/// Loads information about a pending publish operation.
///
/// Returns `Ok(None)` if the information is not present.
async fn load_publish(&self) -> Result<Option<PublishInfo>>;
/// Stores information about a pending publish operation.
///
/// If the info is `None`, the any existing publish information is deleted.
async fn store_publish(&self, info: Option<&PublishInfo>) -> Result<()>;
}
/// Trait for content storage implementations.
///
/// Content storage data must be synchronized if shared between
/// multiple threads and processes.
#[async_trait]
pub trait ContentStorage: Send + Sync {
/// Clear content local data
async fn clear(&self) -> Result<()>;
/// Gets the location of the content associated with the given digest if it
/// exists as a file on disk.
///
/// Returns `None` if the content is not present on disk.
fn content_location(&self, digest: &AnyHash) -> Option<PathBuf>;
/// Loads the content associated with the given digest as a stream.
///
/// If the content is not found, `Ok(None)` is returned.
async fn load_content(
&self,
digest: &AnyHash,
) -> Result<Option<Pin<Box<dyn Stream<Item = Result<Bytes>> + Send + Sync>>>>;
/// Stores the given stream as content.
///
/// If `expected_digest` is `Some`, the storage will verify that the written
/// content matches the given digest. If the digests do not match, an
/// error is returned.
///
/// Returns the hash of the written content.
async fn store_content(
&self,
stream: Pin<Box<dyn Stream<Item = Result<Bytes>> + Send + Sync>>,
expected_digest: Option<&AnyHash>,
) -> Result<AnyHash>;
}
/// Trait for namespace map storage implementations.
///
/// Namespace Map storage data must be synchronized if shared between
/// multiple threads an
#[async_trait]
pub trait NamespaceMapStorage: Send + Sync {
/// Loads namespace map
async fn load_namespace_map(&self) -> Result<Option<IndexMap<String, String>>>;
/// Reset namespace mappings
async fn reset_namespaces(&self) -> Result<()>;
/// Store namespace mapping
async fn store_namespace(
&self,
namespace: String,
registry_domain: RegistryDomain,
) -> Result<()>;
}
/// Represents information about a registry operator.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(rename_all = "camelCase")]
pub struct OperatorInfo {
/// The current operator log state
#[serde(default)]
pub state: operator::LogState,
/// The registry log index of the most recent record
#[serde(default, skip_serializing_if = "Option::is_none")]
pub head_registry_index: Option<RegistryIndex>,
/// The fetch token for the most recent record
#[serde(default, skip_serializing_if = "Option::is_none")]
pub head_fetch_token: Option<String>,
}
/// Represents information about a registry package.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct PackageInfo {
/// The package name to publish.
pub name: PackageName,
/// The last known checkpoint of the package.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub checkpoint: Option<Checkpoint>,
/// The current package log state
#[serde(default)]
pub state: package::LogState,
/// The registry log index of the most recent record
#[serde(default, skip_serializing_if = "Option::is_none")]
pub head_registry_index: Option<RegistryIndex>,
/// The fetch token for the most recent record
#[serde(default, skip_serializing_if = "Option::is_none")]
pub head_fetch_token: Option<String>,
}
impl PackageInfo {
/// Creates a new package info for the given package name.
pub fn new(name: impl Into<PackageName>) -> Self {
Self {
name: name.into(),
checkpoint: None,
state: package::LogState::default(),
head_registry_index: None,
head_fetch_token: None,
}
}
}
/// Represents a record entry being published.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type", rename_all = "camelCase")]
pub enum PublishEntry {
/// The package is being initialized.
Init,
/// A new release entry is being published.
Release {
/// The version of the release.
version: Version,
/// The content digest of the release.
content: AnyHash,
},
/// A release is being yanked.
Yank {
/// The version of the release being yanked.
version: Version,
},
/// A key is being granted permission(s).
Grant {
/// The public key being granted to.
key: PublicKey,
/// The permission(s) being granted.
permissions: Vec<Permission>,
},
/// A key's permission(s) are being revoked.
Revoke {
/// The key ID being revoked from.
key_id: KeyID,
/// The permission(s) being revoked.
permissions: Vec<Permission>,
},
}
/// Represents information about a package publish.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct PublishInfo {
/// The package name being published.
pub name: PackageName,
/// The last known head of the package log to use.
///
/// If `None` and the package is not being initialized,
/// the latest head of the package log will be fetched prior to publishing.
pub head: Option<RecordId>,
/// The new record entries to publish.
pub entries: Vec<PublishEntry>,
}
impl PublishInfo {
/// Determines if the publish information is initializing the package.
pub fn initializing(&self) -> bool {
self.entries.iter().any(|e| matches!(e, PublishEntry::Init))
}
pub(crate) fn finalize(
self,
signing_key: &signing::PrivateKey,
) -> Result<ProtoEnvelope<PackageRecord>> {
let mut entries = Vec::with_capacity(self.entries.len());
for entry in self.entries {
match entry {
PublishEntry::Init => {
entries.push(package::PackageEntry::Init {
hash_algorithm: HashAlgorithm::Sha256,
key: signing_key.public_key(),
});
}
PublishEntry::Release { version, content } => {
entries.push(package::PackageEntry::Release { version, content });
}
PublishEntry::Yank { version } => {
entries.push(package::PackageEntry::Yank { version })
}
PublishEntry::Grant { key, permissions } => {
entries.push(package::PackageEntry::GrantFlat { key, permissions })
}
PublishEntry::Revoke {
key_id,
permissions,
} => entries.push(package::PackageEntry::RevokeFlat {
key_id,
permissions,
}),
}
}
let record = package::PackageRecord {
prev: self.head,
version: PACKAGE_RECORD_VERSION,
// TODO: this seems wrong to record the current time client-side
// How can we guarantee that the timestamps are monotonic?
// Should incrementing timestamps even be a requirement?
timestamp: SystemTime::now(),
entries,
};
Ok(ProtoEnvelope::signed_contents(signing_key, record)?)
}
}