250 lines
8.8 KiB
Rust
250 lines
8.8 KiB
Rust
use garage_table::crdt::*;
|
|
use garage_table::*;
|
|
use garage_util::data::*;
|
|
use garage_util::time::*;
|
|
|
|
use crate::permission::BucketKeyPerm;
|
|
|
|
mod v08 {
|
|
use crate::permission::BucketKeyPerm;
|
|
use garage_util::crdt;
|
|
use garage_util::data::Uuid;
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
/// A bucket is a collection of objects
|
|
///
|
|
/// Its parameters are not directly accessible as:
|
|
/// - It must be possible to merge paramaters, hence the use of a LWW CRDT.
|
|
/// - A bucket has 2 states, Present or Deleted and parameters make sense only if present.
|
|
#[derive(PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
|
|
pub struct Bucket {
|
|
/// ID of the bucket
|
|
pub id: Uuid,
|
|
/// State, and configuration if not deleted, of the bucket
|
|
pub state: crdt::Deletable<BucketParams>,
|
|
}
|
|
|
|
/// Configuration for a bucket
|
|
#[derive(PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
|
|
pub struct BucketParams {
|
|
/// Bucket's creation date
|
|
pub creation_date: u64,
|
|
/// Map of key with access to the bucket, and what kind of access they give
|
|
pub authorized_keys: crdt::Map<String, BucketKeyPerm>,
|
|
|
|
/// Map of aliases that are or have been given to this bucket
|
|
/// in the global namespace
|
|
/// (not authoritative: this is just used as an indication to
|
|
/// map back to aliases when doing ListBuckets)
|
|
pub aliases: crdt::LwwMap<String, bool>,
|
|
/// Map of aliases that are or have been given to this bucket
|
|
/// in namespaces local to keys
|
|
/// key = (access key id, alias name)
|
|
pub local_aliases: crdt::LwwMap<(String, String), bool>,
|
|
|
|
/// Whether this bucket is allowed for website access
|
|
/// (under all of its global alias names),
|
|
/// and if so, the website configuration XML document
|
|
pub website_config: crdt::Lww<Option<WebsiteConfig>>,
|
|
/// CORS rules
|
|
pub cors_config: crdt::Lww<Option<Vec<CorsRule>>>,
|
|
/// Bucket quotas
|
|
#[serde(default)]
|
|
pub quotas: crdt::Lww<BucketQuotas>,
|
|
}
|
|
|
|
#[derive(PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
|
|
pub struct WebsiteConfig {
|
|
pub index_document: String,
|
|
pub error_document: Option<String>,
|
|
pub redirect_all_requests_to: Option<RedirectTarget>,
|
|
pub routing_rules: Vec<RoutingRule>,
|
|
}
|
|
|
|
#[derive(PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
|
|
pub struct RedirectTarget {
|
|
/// Name of the host where requests are redirected.
|
|
pub hostname: String,
|
|
/// Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
|
|
/// Valid Values: http | https
|
|
pub protocol: Option<String>,
|
|
}
|
|
|
|
#[derive(PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
|
|
pub struct RoutingRule {
|
|
/// A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.
|
|
pub condition: Option<RoutingCondition>,
|
|
/// Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return.
|
|
pub redirect: RedirectRule,
|
|
}
|
|
|
|
#[derive(PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
|
|
pub struct RoutingCondition {
|
|
/// The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied.
|
|
pub http_error_code_returned_equals: Option<u16>,
|
|
/// The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied.
|
|
pub key_prefix_equals: Option<String>,
|
|
}
|
|
|
|
#[derive(PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
|
|
pub struct RedirectRule {
|
|
/// The hostname to use in the redirect request.
|
|
pub hostname: Option<String>,
|
|
|
|
/// The HTTP redirect code to use on the response. Not required if one of the siblings is present.
|
|
pub http_redirect_code: Option<u16>,
|
|
|
|
/// Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
|
|
/// Valid Values: http | https
|
|
pub protocol: Option<String>,
|
|
|
|
/// The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.
|
|
pub replace_key_prefix_with: Option<String>,
|
|
|
|
/// The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the siblings is present. Can be present only if ReplaceKeyPrefixWith is not provided.
|
|
pub replace_key_with: Option<String>,
|
|
|
|
|
|
}
|
|
|
|
#[derive(PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
|
|
pub struct CorsRule {
|
|
pub id: Option<String>,
|
|
pub max_age_seconds: Option<u64>,
|
|
pub allow_origins: Vec<String>,
|
|
pub allow_methods: Vec<String>,
|
|
pub allow_headers: Vec<String>,
|
|
pub expose_headers: Vec<String>,
|
|
}
|
|
|
|
#[derive(Default, PartialEq, Eq, PartialOrd, Ord, Clone, Debug, Serialize, Deserialize)]
|
|
pub struct BucketQuotas {
|
|
/// Maximum size in bytes (bucket size = sum of sizes of objects in the bucket)
|
|
pub max_size: Option<u64>,
|
|
/// Maximum number of non-deleted objects in the bucket
|
|
pub max_objects: Option<u64>,
|
|
}
|
|
|
|
impl garage_util::migrate::InitialFormat for Bucket {}
|
|
}
|
|
|
|
pub use v08::*;
|
|
|
|
impl AutoCrdt for BucketQuotas {
|
|
const WARN_IF_DIFFERENT: bool = true;
|
|
}
|
|
|
|
impl BucketParams {
|
|
/// Create an empty BucketParams with no authorized keys and no website accesss
|
|
pub fn new() -> Self {
|
|
BucketParams {
|
|
creation_date: now_msec(),
|
|
authorized_keys: crdt::Map::new(),
|
|
aliases: crdt::LwwMap::new(),
|
|
local_aliases: crdt::LwwMap::new(),
|
|
website_config: crdt::Lww::new(None),
|
|
cors_config: crdt::Lww::new(None),
|
|
quotas: crdt::Lww::new(BucketQuotas::default()),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Crdt for BucketParams {
|
|
fn merge(&mut self, o: &Self) {
|
|
self.creation_date = std::cmp::min(self.creation_date, o.creation_date);
|
|
self.authorized_keys.merge(&o.authorized_keys);
|
|
|
|
self.aliases.merge(&o.aliases);
|
|
self.local_aliases.merge(&o.local_aliases);
|
|
|
|
self.website_config.merge(&o.website_config);
|
|
self.cors_config.merge(&o.cors_config);
|
|
self.quotas.merge(&o.quotas);
|
|
}
|
|
}
|
|
|
|
impl Default for Bucket {
|
|
fn default() -> Self {
|
|
Self::new()
|
|
}
|
|
}
|
|
|
|
impl Default for BucketParams {
|
|
fn default() -> Self {
|
|
Self::new()
|
|
}
|
|
}
|
|
|
|
impl Bucket {
|
|
/// Initializes a new instance of the Bucket struct
|
|
pub fn new() -> Self {
|
|
Bucket {
|
|
id: gen_uuid(),
|
|
state: crdt::Deletable::present(BucketParams::new()),
|
|
}
|
|
}
|
|
|
|
/// Returns true if this represents a deleted bucket
|
|
pub fn is_deleted(&self) -> bool {
|
|
self.state.is_deleted()
|
|
}
|
|
|
|
/// Returns an option representing the parameters (None if in deleted state)
|
|
pub fn params(&self) -> Option<&BucketParams> {
|
|
self.state.as_option()
|
|
}
|
|
|
|
/// Mutable version of `.params()`
|
|
pub fn params_mut(&mut self) -> Option<&mut BucketParams> {
|
|
self.state.as_option_mut()
|
|
}
|
|
|
|
/// Return the list of authorized keys, when each was updated, and the permission associated to
|
|
/// the key
|
|
pub fn authorized_keys(&self) -> &[(String, BucketKeyPerm)] {
|
|
self.params()
|
|
.map(|s| s.authorized_keys.items())
|
|
.unwrap_or(&[])
|
|
}
|
|
|
|
pub fn aliases(&self) -> &[(String, u64, bool)] {
|
|
self.params().map(|s| s.aliases.items()).unwrap_or(&[])
|
|
}
|
|
|
|
pub fn local_aliases(&self) -> &[((String, String), u64, bool)] {
|
|
self.params()
|
|
.map(|s| s.local_aliases.items())
|
|
.unwrap_or(&[])
|
|
}
|
|
}
|
|
|
|
impl Entry<EmptyKey, Uuid> for Bucket {
|
|
fn partition_key(&self) -> &EmptyKey {
|
|
&EmptyKey
|
|
}
|
|
fn sort_key(&self) -> &Uuid {
|
|
&self.id
|
|
}
|
|
}
|
|
|
|
impl Crdt for Bucket {
|
|
fn merge(&mut self, other: &Self) {
|
|
self.state.merge(&other.state);
|
|
}
|
|
}
|
|
|
|
pub struct BucketTable;
|
|
|
|
impl TableSchema for BucketTable {
|
|
const TABLE_NAME: &'static str = "bucket_v2";
|
|
|
|
type P = EmptyKey;
|
|
type S = Uuid;
|
|
type E = Bucket;
|
|
type Filter = DeletedFilter;
|
|
|
|
fn matches_filter(entry: &Self::E, filter: &Self::Filter) -> bool {
|
|
filter.apply(entry.is_deleted())
|
|
}
|
|
}
|