MeiliSearch/meilisearch-types/src/keys.rs

372 lines
14 KiB
Rust
Raw Normal View History

2023-01-11 12:33:56 +01:00
use std::convert::Infallible;
2022-10-20 18:00:07 +02:00
use std::hash::Hash;
use std::str::FromStr;
2022-10-20 18:00:07 +02:00
2023-02-13 18:45:13 +01:00
use deserr::{DeserializeError, Deserr, MergeWithError, ValuePointerRef};
use enum_iterator::Sequence;
use milli::update::Setting;
2022-10-12 16:10:28 +02:00
use serde::{Deserialize, Serialize};
use time::format_description::well_known::Rfc3339;
use time::macros::{format_description, time};
use time::{Date, OffsetDateTime, PrimitiveDateTime};
use uuid::Uuid;
use crate::deserr::{immutable_field_error, DeserrError, DeserrJsonError};
2023-01-11 12:33:56 +01:00
use crate::error::deserr_codes::*;
use crate::error::{Code, ErrorCode, ParseOffsetDateTimeError};
use crate::index_uid_pattern::{IndexUidPattern, IndexUidPatternFormatError};
2022-10-20 18:00:07 +02:00
2022-10-12 16:10:28 +02:00
pub type KeyId = Uuid;
impl<C: Default + ErrorCode> MergeWithError<IndexUidPatternFormatError> for DeserrJsonError<C> {
2023-01-11 12:33:56 +01:00
fn merge(
_self_: Option<Self>,
other: IndexUidPatternFormatError,
2023-01-11 12:33:56 +01:00
merge_location: deserr::ValuePointerRef,
2023-02-13 18:45:13 +01:00
) -> std::ops::ControlFlow<Self, Self> {
2023-01-11 12:33:56 +01:00
DeserrError::error::<Infallible>(
None,
deserr::ErrorKind::Unexpected { msg: other.to_string() },
merge_location,
)
}
}
2023-02-13 18:45:13 +01:00
#[derive(Debug, Deserr)]
#[deserr(error = DeserrJsonError, rename_all = camelCase, deny_unknown_fields)]
2023-01-11 12:33:56 +01:00
pub struct CreateApiKey {
#[deserr(default, error = DeserrJsonError<InvalidApiKeyDescription>)]
2023-01-11 12:33:56 +01:00
pub description: Option<String>,
#[deserr(default, error = DeserrJsonError<InvalidApiKeyName>)]
2023-01-11 12:33:56 +01:00
pub name: Option<String>,
2023-02-13 18:45:13 +01:00
#[deserr(default = Uuid::new_v4(), error = DeserrJsonError<InvalidApiKeyUid>, try_from(&String) = Uuid::from_str -> uuid::Error)]
2023-01-11 12:33:56 +01:00
pub uid: KeyId,
#[deserr(error = DeserrJsonError<InvalidApiKeyActions>, missing_field_error = DeserrJsonError::missing_api_key_actions)]
2023-01-11 12:33:56 +01:00
pub actions: Vec<Action>,
#[deserr(error = DeserrJsonError<InvalidApiKeyIndexes>, missing_field_error = DeserrJsonError::missing_api_key_indexes)]
2023-01-25 17:22:32 +01:00
pub indexes: Vec<IndexUidPattern>,
2023-02-13 18:45:13 +01:00
#[deserr(error = DeserrJsonError<InvalidApiKeyExpiresAt>, try_from(Option<String>) = parse_expiration_date -> ParseOffsetDateTimeError, missing_field_error = DeserrJsonError::missing_api_key_expires_at)]
2023-01-11 12:33:56 +01:00
pub expires_at: Option<OffsetDateTime>,
}
2023-01-11 12:33:56 +01:00
impl CreateApiKey {
pub fn to_key(self) -> Key {
let CreateApiKey { description, name, uid, actions, indexes, expires_at } = self;
let now = OffsetDateTime::now_utc();
Key {
description,
name,
uid,
actions,
indexes,
expires_at,
created_at: now,
updated_at: now,
}
}
}
fn deny_immutable_fields_api_key(
field: &str,
accepted: &[&str],
location: ValuePointerRef,
) -> DeserrJsonError {
match field {
"uid" => immutable_field_error(field, accepted, Code::ImmutableApiKeyUid),
"actions" => immutable_field_error(field, accepted, Code::ImmutableApiKeyActions),
"indexes" => immutable_field_error(field, accepted, Code::ImmutableApiKeyIndexes),
"expiresAt" => immutable_field_error(field, accepted, Code::ImmutableApiKeyExpiresAt),
"createdAt" => immutable_field_error(field, accepted, Code::ImmutableApiKeyCreatedAt),
"updatedAt" => immutable_field_error(field, accepted, Code::ImmutableApiKeyUpdatedAt),
_ => deserr::take_cf_content(DeserrJsonError::<BadRequest>::error::<Infallible>(
None,
deserr::ErrorKind::UnknownKey { key: field, accepted },
location,
)),
}
2023-01-11 12:33:56 +01:00
}
2023-02-13 18:45:13 +01:00
#[derive(Debug, Deserr)]
#[deserr(error = DeserrJsonError, rename_all = camelCase, deny_unknown_fields = deny_immutable_fields_api_key)]
2023-01-11 12:33:56 +01:00
pub struct PatchApiKey {
#[deserr(default, error = DeserrJsonError<InvalidApiKeyDescription>)]
pub description: Setting<String>,
#[deserr(default, error = DeserrJsonError<InvalidApiKeyName>)]
pub name: Setting<String>,
2023-01-11 12:33:56 +01:00
}
2022-10-16 01:39:01 +02:00
#[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize)]
2022-10-12 16:10:28 +02:00
pub struct Key {
#[serde(skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
pub uid: KeyId,
pub actions: Vec<Action>,
2023-01-25 17:22:32 +01:00
pub indexes: Vec<IndexUidPattern>,
2022-10-12 16:10:28 +02:00
#[serde(with = "time::serde::rfc3339::option")]
pub expires_at: Option<OffsetDateTime>,
#[serde(with = "time::serde::rfc3339")]
pub created_at: OffsetDateTime,
#[serde(with = "time::serde::rfc3339")]
pub updated_at: OffsetDateTime,
}
impl Key {
pub fn default_admin() -> Self {
let now = OffsetDateTime::now_utc();
let uid = Uuid::new_v4();
Self {
name: Some("Default Admin API Key".to_string()),
description: Some("Use it for anything that is not a search operation. Caution! Do not expose it on a public frontend".to_string()),
uid,
actions: vec![Action::All],
2023-01-25 17:22:32 +01:00
indexes: vec![IndexUidPattern::all()],
2022-10-12 16:10:28 +02:00
expires_at: None,
created_at: now,
updated_at: now,
}
}
pub fn default_search() -> Self {
let now = OffsetDateTime::now_utc();
let uid = Uuid::new_v4();
Self {
name: Some("Default Search API Key".to_string()),
description: Some("Use it to search from the frontend".to_string()),
uid,
actions: vec![Action::Search],
2023-01-25 17:22:32 +01:00
indexes: vec![IndexUidPattern::all()],
2022-10-12 16:10:28 +02:00
expires_at: None,
created_at: now,
updated_at: now,
}
}
}
2023-01-11 12:33:56 +01:00
fn parse_expiration_date(
string: Option<String>,
) -> std::result::Result<Option<OffsetDateTime>, ParseOffsetDateTimeError> {
2023-07-03 10:20:28 +02:00
let Some(string) = string else { return Ok(None) };
let datetime = if let Ok(datetime) = OffsetDateTime::parse(&string, &Rfc3339) {
2023-01-11 12:33:56 +01:00
datetime
} else if let Ok(primitive_datetime) = PrimitiveDateTime::parse(
&string,
2023-01-11 12:33:56 +01:00
format_description!(
"[year repr:full base:calendar]-[month repr:numerical]-[day]T[hour]:[minute]:[second]"
),
) {
primitive_datetime.assume_utc()
} else if let Ok(primitive_datetime) = PrimitiveDateTime::parse(
&string,
2023-01-11 12:33:56 +01:00
format_description!(
"[year repr:full base:calendar]-[month repr:numerical]-[day] [hour]:[minute]:[second]"
),
) {
primitive_datetime.assume_utc()
} else if let Ok(date) = Date::parse(
&string,
2023-01-11 12:33:56 +01:00
format_description!("[year repr:full base:calendar]-[month repr:numerical]-[day]"),
) {
PrimitiveDateTime::new(date, time!(00:00)).assume_utc()
} else {
return Err(ParseOffsetDateTimeError(string));
2023-01-11 12:33:56 +01:00
};
if datetime > OffsetDateTime::now_utc() {
Ok(Some(datetime))
} else {
Err(ParseOffsetDateTimeError(string))
2022-10-12 16:10:28 +02:00
}
}
2023-02-13 18:45:13 +01:00
#[derive(Copy, Clone, Serialize, Deserialize, Debug, Eq, PartialEq, Hash, Sequence, Deserr)]
2022-10-12 16:10:28 +02:00
#[repr(u8)]
pub enum Action {
#[serde(rename = "*")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "*")]
2022-10-12 16:10:28 +02:00
All = 0,
#[serde(rename = "search")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "search")]
2022-10-12 16:10:28 +02:00
Search,
#[serde(rename = "documents.*")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "documents.*")]
2022-10-12 16:10:28 +02:00
DocumentsAll,
#[serde(rename = "documents.add")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "documents.add")]
2022-10-12 16:10:28 +02:00
DocumentsAdd,
#[serde(rename = "documents.get")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "documents.get")]
2022-10-12 16:10:28 +02:00
DocumentsGet,
#[serde(rename = "documents.delete")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "documents.delete")]
2022-10-12 16:10:28 +02:00
DocumentsDelete,
#[serde(rename = "indexes.*")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "indexes.*")]
2022-10-12 16:10:28 +02:00
IndexesAll,
#[serde(rename = "indexes.create")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "indexes.create")]
2022-10-12 16:10:28 +02:00
IndexesAdd,
#[serde(rename = "indexes.get")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "indexes.get")]
2022-10-12 16:10:28 +02:00
IndexesGet,
#[serde(rename = "indexes.update")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "indexes.update")]
2022-10-12 16:10:28 +02:00
IndexesUpdate,
#[serde(rename = "indexes.delete")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "indexes.delete")]
2022-10-12 16:10:28 +02:00
IndexesDelete,
2022-10-17 16:30:18 +02:00
#[serde(rename = "indexes.swap")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "indexes.swap")]
2022-10-17 16:30:18 +02:00
IndexesSwap,
2022-10-12 16:10:28 +02:00
#[serde(rename = "tasks.*")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "tasks.*")]
2022-10-12 16:10:28 +02:00
TasksAll,
#[serde(rename = "tasks.cancel")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "tasks.cancel")]
TasksCancel,
2022-10-15 11:03:24 +02:00
#[serde(rename = "tasks.delete")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "tasks.delete")]
TasksDelete,
2022-10-12 16:10:28 +02:00
#[serde(rename = "tasks.get")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "tasks.get")]
2022-10-12 16:10:28 +02:00
TasksGet,
#[serde(rename = "settings.*")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "settings.*")]
2022-10-12 16:10:28 +02:00
SettingsAll,
#[serde(rename = "settings.get")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "settings.get")]
2022-10-12 16:10:28 +02:00
SettingsGet,
#[serde(rename = "settings.update")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "settings.update")]
2022-10-12 16:10:28 +02:00
SettingsUpdate,
#[serde(rename = "stats.*")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "stats.*")]
2022-10-12 16:10:28 +02:00
StatsAll,
#[serde(rename = "stats.get")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "stats.get")]
2022-10-12 16:10:28 +02:00
StatsGet,
#[serde(rename = "metrics.*")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "metrics.*")]
2022-10-12 16:10:28 +02:00
MetricsAll,
#[serde(rename = "metrics.get")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "metrics.get")]
2022-10-12 16:10:28 +02:00
MetricsGet,
#[serde(rename = "dumps.*")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "dumps.*")]
2022-10-12 16:10:28 +02:00
DumpsAll,
#[serde(rename = "dumps.create")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "dumps.create")]
2022-10-12 16:10:28 +02:00
DumpsCreate,
2023-09-11 11:00:05 +02:00
#[serde(rename = "snapshots.*")]
#[deserr(rename = "snapshots.*")]
SnapshotsAll,
#[serde(rename = "snapshots.create")]
#[deserr(rename = "snapshots.create")]
SnapshotsCreate,
2022-10-12 16:10:28 +02:00
#[serde(rename = "version")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "version")]
2022-10-12 16:10:28 +02:00
Version,
#[serde(rename = "keys.create")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "keys.create")]
2022-10-12 16:10:28 +02:00
KeysAdd,
#[serde(rename = "keys.get")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "keys.get")]
2022-10-12 16:10:28 +02:00
KeysGet,
#[serde(rename = "keys.update")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "keys.update")]
2022-10-12 16:10:28 +02:00
KeysUpdate,
#[serde(rename = "keys.delete")]
2023-01-11 12:33:56 +01:00
#[deserr(rename = "keys.delete")]
2022-10-12 16:10:28 +02:00
KeysDelete,
#[serde(rename = "experimental.get")]
#[deserr(rename = "experimental.get")]
ExperimentalFeaturesGet,
#[serde(rename = "experimental.update")]
#[deserr(rename = "experimental.update")]
ExperimentalFeaturesUpdate,
2022-10-12 16:10:28 +02:00
}
impl Action {
pub const fn from_repr(repr: u8) -> Option<Self> {
use actions::*;
match repr {
ALL => Some(Self::All),
SEARCH => Some(Self::Search),
DOCUMENTS_ALL => Some(Self::DocumentsAll),
DOCUMENTS_ADD => Some(Self::DocumentsAdd),
DOCUMENTS_GET => Some(Self::DocumentsGet),
DOCUMENTS_DELETE => Some(Self::DocumentsDelete),
INDEXES_ALL => Some(Self::IndexesAll),
INDEXES_CREATE => Some(Self::IndexesAdd),
INDEXES_GET => Some(Self::IndexesGet),
INDEXES_UPDATE => Some(Self::IndexesUpdate),
INDEXES_DELETE => Some(Self::IndexesDelete),
INDEXES_SWAP => Some(Self::IndexesSwap),
2022-10-12 16:10:28 +02:00
TASKS_ALL => Some(Self::TasksAll),
TASKS_CANCEL => Some(Self::TasksCancel),
TASKS_DELETE => Some(Self::TasksDelete),
2022-10-12 16:10:28 +02:00
TASKS_GET => Some(Self::TasksGet),
SETTINGS_ALL => Some(Self::SettingsAll),
SETTINGS_GET => Some(Self::SettingsGet),
SETTINGS_UPDATE => Some(Self::SettingsUpdate),
STATS_ALL => Some(Self::StatsAll),
STATS_GET => Some(Self::StatsGet),
METRICS_ALL => Some(Self::MetricsAll),
METRICS_GET => Some(Self::MetricsGet),
DUMPS_ALL => Some(Self::DumpsAll),
DUMPS_CREATE => Some(Self::DumpsCreate),
2023-09-11 11:00:05 +02:00
SNAPSHOTS_CREATE => Some(Self::SnapshotsCreate),
2022-10-12 16:10:28 +02:00
VERSION => Some(Self::Version),
KEYS_CREATE => Some(Self::KeysAdd),
KEYS_GET => Some(Self::KeysGet),
KEYS_UPDATE => Some(Self::KeysUpdate),
KEYS_DELETE => Some(Self::KeysDelete),
EXPERIMENTAL_FEATURES_GET => Some(Self::ExperimentalFeaturesGet),
EXPERIMENTAL_FEATURES_UPDATE => Some(Self::ExperimentalFeaturesUpdate),
2022-10-12 16:10:28 +02:00
_otherwise => None,
}
}
pub const fn repr(&self) -> u8 {
*self as u8
}
}
pub mod actions {
use super::Action::*;
pub(crate) const ALL: u8 = All.repr();
pub const SEARCH: u8 = Search.repr();
pub const DOCUMENTS_ALL: u8 = DocumentsAll.repr();
pub const DOCUMENTS_ADD: u8 = DocumentsAdd.repr();
pub const DOCUMENTS_GET: u8 = DocumentsGet.repr();
pub const DOCUMENTS_DELETE: u8 = DocumentsDelete.repr();
pub const INDEXES_ALL: u8 = IndexesAll.repr();
pub const INDEXES_CREATE: u8 = IndexesAdd.repr();
pub const INDEXES_GET: u8 = IndexesGet.repr();
pub const INDEXES_UPDATE: u8 = IndexesUpdate.repr();
pub const INDEXES_DELETE: u8 = IndexesDelete.repr();
2022-10-17 16:30:18 +02:00
pub const INDEXES_SWAP: u8 = IndexesSwap.repr();
2022-10-12 16:10:28 +02:00
pub const TASKS_ALL: u8 = TasksAll.repr();
pub const TASKS_CANCEL: u8 = TasksCancel.repr();
pub const TASKS_DELETE: u8 = TasksDelete.repr();
2022-10-12 16:10:28 +02:00
pub const TASKS_GET: u8 = TasksGet.repr();
pub const SETTINGS_ALL: u8 = SettingsAll.repr();
pub const SETTINGS_GET: u8 = SettingsGet.repr();
pub const SETTINGS_UPDATE: u8 = SettingsUpdate.repr();
pub const STATS_ALL: u8 = StatsAll.repr();
pub const STATS_GET: u8 = StatsGet.repr();
pub const METRICS_ALL: u8 = MetricsAll.repr();
pub const METRICS_GET: u8 = MetricsGet.repr();
pub const DUMPS_ALL: u8 = DumpsAll.repr();
pub const DUMPS_CREATE: u8 = DumpsCreate.repr();
2023-09-11 11:00:05 +02:00
pub const SNAPSHOTS_CREATE: u8 = SnapshotsCreate.repr();
2022-10-12 16:10:28 +02:00
pub const VERSION: u8 = Version.repr();
pub const KEYS_CREATE: u8 = KeysAdd.repr();
pub const KEYS_GET: u8 = KeysGet.repr();
pub const KEYS_UPDATE: u8 = KeysUpdate.repr();
pub const KEYS_DELETE: u8 = KeysDelete.repr();
pub const EXPERIMENTAL_FEATURES_GET: u8 = ExperimentalFeaturesGet.repr();
pub const EXPERIMENTAL_FEATURES_UPDATE: u8 = ExperimentalFeaturesUpdate.repr();
2022-10-12 16:10:28 +02:00
}