garage/src/model/key_table.rs

139 lines
3.3 KiB
Rust
Raw Normal View History

use serde::{Deserialize, Serialize};
use garage_table::crdt::*;
use garage_table::*;
2021-03-26 20:53:28 +00:00
/// An api key
#[derive(PartialEq, Clone, Debug, Serialize, Deserialize)]
pub struct Key {
2021-04-06 03:25:28 +00:00
/// The id of the key (immutable), used as partition key
2020-04-23 20:25:45 +00:00
pub key_id: String,
2021-03-26 20:53:28 +00:00
/// The secret_key associated
2020-04-23 20:25:45 +00:00
pub secret_key: String,
2021-03-26 20:53:28 +00:00
/// Name for the key
pub name: crdt::LWW<String>,
2021-03-26 20:53:28 +00:00
/// Is the key deleted
pub deleted: crdt::Bool,
2021-03-26 20:53:28 +00:00
/// Buckets in which the key is authorized. Empty if `Key` is deleted
2021-04-06 03:25:28 +00:00
// CRDT interaction: deleted implies authorized_buckets is empty
pub authorized_buckets: crdt::LWWMap<String, PermissionSet>,
}
impl Key {
2021-04-08 13:13:02 +00:00
/// Initialize a new Key, generating a random identifier and associated secret key
pub fn new(name: String) -> Self {
2020-04-23 20:25:45 +00:00
let key_id = format!("GK{}", hex::encode(&rand::random::<[u8; 12]>()[..]));
let secret_key = hex::encode(&rand::random::<[u8; 32]>()[..]);
2020-11-20 22:20:20 +00:00
Self {
2020-04-23 20:25:45 +00:00
key_id,
secret_key,
name: crdt::LWW::new(name),
deleted: crdt::Bool::new(false),
authorized_buckets: crdt::LWWMap::new(),
2020-11-20 22:20:20 +00:00
}
}
2021-03-26 20:53:28 +00:00
/// Import a key from it's parts
pub fn import(key_id: &str, secret_key: &str, name: &str) -> Self {
Self {
key_id: key_id.to_string(),
secret_key: secret_key.to_string(),
name: crdt::LWW::new(name.to_string()),
deleted: crdt::Bool::new(false),
authorized_buckets: crdt::LWWMap::new(),
}
}
2021-03-26 20:53:28 +00:00
/// Create a new Key which can me merged to mark an existing key deleted
2020-04-23 20:25:45 +00:00
pub fn delete(key_id: String) -> Self {
Self {
2020-04-23 20:25:45 +00:00
key_id,
secret_key: "".into(),
name: crdt::LWW::new("".to_string()),
deleted: crdt::Bool::new(true),
authorized_buckets: crdt::LWWMap::new(),
}
}
2021-03-26 20:53:28 +00:00
/// Check if `Key` is allowed to read in bucket
2020-04-23 20:25:45 +00:00
pub fn allow_read(&self, bucket: &str) -> bool {
self.authorized_buckets
.get(&bucket.to_string())
2020-04-23 20:25:45 +00:00
.map(|x| x.allow_read)
.unwrap_or(false)
}
2021-03-26 20:53:28 +00:00
/// Check if `Key` is allowed to write in bucket
2020-04-23 20:25:45 +00:00
pub fn allow_write(&self, bucket: &str) -> bool {
self.authorized_buckets
.get(&bucket.to_string())
2020-04-23 20:25:45 +00:00
.map(|x| x.allow_write)
.unwrap_or(false)
}
}
2021-03-26 20:53:28 +00:00
/// Permission given to a key in a bucket
#[derive(PartialOrd, Ord, PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
pub struct PermissionSet {
2021-03-26 20:53:28 +00:00
/// The key can be used to read the bucket
2020-04-23 20:25:45 +00:00
pub allow_read: bool,
2021-03-26 20:53:28 +00:00
/// The key can be used to write in the bucket
2020-04-23 20:25:45 +00:00
pub allow_write: bool,
}
impl AutoCRDT for PermissionSet {
const WARN_IF_DIFFERENT: bool = true;
}
impl Entry<EmptyKey, String> for Key {
fn partition_key(&self) -> &EmptyKey {
&EmptyKey
}
fn sort_key(&self) -> &String {
2020-04-23 20:25:45 +00:00
&self.key_id
}
}
impl CRDT for Key {
fn merge(&mut self, other: &Self) {
self.name.merge(&other.name);
self.deleted.merge(&other.deleted);
2020-11-20 19:12:32 +00:00
if self.deleted.get() {
self.authorized_buckets.clear();
} else {
self.authorized_buckets.merge(&other.authorized_buckets);
}
}
}
pub struct KeyTable;
#[derive(Clone, Debug, Serialize, Deserialize)]
pub enum KeyFilter {
Deleted(DeletedFilter),
Matches(String),
}
impl TableSchema for KeyTable {
type P = EmptyKey;
type S = String;
type E = Key;
type Filter = KeyFilter;
fn matches_filter(entry: &Self::E, filter: &Self::Filter) -> bool {
match filter {
KeyFilter::Deleted(df) => df.apply(entry.deleted.get()),
KeyFilter::Matches(pat) => {
2021-03-15 18:16:42 +00:00
let pat = pat.to_lowercase();
entry.key_id.to_lowercase().starts_with(&pat)
|| entry.name.get().to_lowercase() == pat
}
}
}
}