surrealpatch/core/src/iam/auth.rs
Gerard Guillemas Martos e38b891e62
Consolidate authentication methods (#3988)
Co-authored-by: Micha de Vries <micha@devrie.sh>
2024-05-22 13:57:25 +00:00

102 lines
2.7 KiB
Rust

use crate::sql::statements::{DefineAccessStatement, DefineUserStatement};
use revision::revisioned;
use serde::{Deserialize, Serialize};
use super::{is_allowed, Action, Actor, Error, Level, Resource, Role};
/// Specifies the current authentication for the datastore execution context.
#[revisioned(revision = 1)]
#[derive(Clone, Default, Debug, Eq, PartialEq, PartialOrd, Hash, Serialize, Deserialize)]
#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[non_exhaustive]
pub struct Auth {
actor: Actor,
}
impl Auth {
pub fn new(actor: Actor) -> Self {
Self {
actor,
}
}
pub fn id(&self) -> &str {
self.actor.id()
}
/// Return current authentication level
pub fn level(&self) -> &Level {
self.actor.level()
}
/// Check if the current auth is anonymous
pub fn is_anon(&self) -> bool {
matches!(self.level(), Level::No)
}
/// Check if the current level is Root
pub fn is_root(&self) -> bool {
matches!(self.level(), Level::Root)
}
/// Check if the current level is Namespace
pub fn is_ns(&self) -> bool {
matches!(self.level(), Level::Namespace(_))
}
/// Check if the current level is Database
pub fn is_db(&self) -> bool {
matches!(self.level(), Level::Database(_, _))
}
/// Check if the current level is Record
pub fn is_record(&self) -> bool {
matches!(self.level(), Level::Record(_, _, _))
}
/// System Auth helpers
///
/// These are not stored in the database and are used for internal operations
/// Do not use for authentication
pub fn for_root(role: Role) -> Self {
Self::new(Actor::new("system_auth".into(), vec![role], Level::Root))
}
pub fn for_ns(role: Role, ns: &str) -> Self {
Self::new(Actor::new("system_auth".into(), vec![role], (ns,).into()))
}
pub fn for_db(role: Role, ns: &str, db: &str) -> Self {
Self::new(Actor::new("system_auth".into(), vec![role], (ns, db).into()))
}
pub fn for_record(rid: String, ns: &str, db: &str, ac: &str) -> Self {
Self::new(Actor::new(rid.to_string(), vec![], (ns, db, ac).into()))
}
//
// Permission checks
//
/// Checks if the current auth is allowed to perform an action on a given resource
pub fn is_allowed(&self, action: Action, res: &Resource) -> Result<(), Error> {
is_allowed(&self.actor, &action, res, None)
}
/// Checks if the current actor has a given role
pub fn has_role(&self, role: &Role) -> bool {
self.actor.has_role(role)
}
}
impl std::convert::From<(&DefineUserStatement, Level)> for Auth {
fn from(val: (&DefineUserStatement, Level)) -> Self {
Self::new((val.0, val.1).into())
}
}
impl std::convert::From<(&DefineAccessStatement, Level)> for Auth {
fn from(val: (&DefineAccessStatement, Level)) -> Self {
Self::new((val.0, val.1).into())
}
}