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 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
/*
* Copyright 2022-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use smol_str::SmolStr;
use crate::ast::*;
use crate::entities::SchemaType;
use crate::evaluator;
use std::any::Any;
use std::collections::HashMap;
use std::fmt::{Debug, Display};
use std::sync::Arc;
/// Cedar extension.
///
/// An extension can define new types and functions on those types. (Currently,
/// there's nothing preventing an extension from defining new functions on
/// built-in types, either, although we haven't discussed whether we want to
/// allow this long-term.)
pub struct Extension {
/// Name of the extension
name: Name,
/// Extension functions. These are legal to call in Cedar expressions.
functions: HashMap<Name, ExtensionFunction>,
}
impl Extension {
/// Create a new `Extension` with the given name and extension functions
pub fn new(name: Name, functions: impl IntoIterator<Item = ExtensionFunction>) -> Self {
Self {
name,
functions: functions.into_iter().map(|f| (f.name.clone(), f)).collect(),
}
}
/// Get the name of the extension
pub fn name(&self) -> &Name {
&self.name
}
/// Look up a function by name, or return `None` if the extension doesn't
/// provide a function with that name
pub fn get_func(&self, name: &Name) -> Option<&ExtensionFunction> {
self.functions.get(name)
}
/// Get an iterator over the function names
pub fn funcs(&self) -> impl Iterator<Item = &ExtensionFunction> {
self.functions.values()
}
}
impl std::fmt::Debug for Extension {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "<extension {}>", self.name())
}
}
/// The output of an extension call, either a value or an unknown
#[derive(Debug, Clone)]
pub enum ExtensionOutputValue {
/// A concrete value from an extension call
Concrete(Value),
/// An unknown returned from an extension call
Unknown(SmolStr),
}
impl<T> From<T> for ExtensionOutputValue
where
T: Into<Value>,
{
fn from(v: T) -> Self {
ExtensionOutputValue::Concrete(v.into())
}
}
/// Which "style" is a function call
#[derive(Debug, PartialEq, Eq, Clone, Copy, Hash)]
#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
pub enum CallStyle {
/// Function-style, eg foo(a, b)
FunctionStyle,
/// Method-style, eg a.foo(b)
MethodStyle,
}
// Note: we could use currying to make this a little nicer
/// Trait object that implements the extension function call.
pub type ExtensionFunctionObject =
Box<dyn Fn(&[Value]) -> evaluator::Result<ExtensionOutputValue> + Sync + Send + 'static>;
/// Extension function. These can be called by the given `name` in Ceder
/// expressions.
pub struct ExtensionFunction {
/// Name of the function
name: Name,
/// Which `CallStyle` should be used when calling this function
style: CallStyle,
/// The actual function, which takes an `&[Value]` and returns a `Value`,
/// or an evaluation error
func: ExtensionFunctionObject,
/// The return type of this function, as a `SchemaType`. We require that
/// this be constant -- any given extension function must always return a
/// value of this `SchemaType`.
/// If `return_type` is `None`, the function may never return a value.
/// (ie: it functions as the `Never` type)
return_type: Option<SchemaType>,
/// The argument types that this function expects, as `SchemaType`s. If any
/// given argument type is not constant (function works with multiple
/// `SchemaType`s) then this will be `None` for that argument.
arg_types: Vec<Option<SchemaType>>,
}
impl ExtensionFunction {
/// Create a new `ExtensionFunction` taking any number of arguments
fn new(
name: Name,
style: CallStyle,
func: ExtensionFunctionObject,
return_type: Option<SchemaType>,
arg_types: Vec<Option<SchemaType>>,
) -> Self {
Self {
name,
func,
style,
return_type,
arg_types,
}
}
/// Create a new `ExtensionFunction` taking no arguments
pub fn nullary(
name: Name,
style: CallStyle,
func: Box<dyn Fn() -> evaluator::Result<ExtensionOutputValue> + Sync + Send + 'static>,
return_type: SchemaType,
) -> Self {
Self::new(
name.clone(),
style,
Box::new(move |args: &[Value]| {
if args.is_empty() {
func()
} else {
Err(evaluator::EvaluationError::WrongNumArguments {
function_name: name.clone(),
expected: 0,
actual: args.len(),
})
}
}),
Some(return_type),
vec![],
)
}
/// Create a new `ExtensionFunction` taking one argument, that never returns a value
pub fn unary_never(
name: Name,
style: CallStyle,
func: Box<dyn Fn(Value) -> evaluator::Result<ExtensionOutputValue> + Sync + Send + 'static>,
arg_type: Option<SchemaType>,
) -> Self {
Self::new(
name.clone(),
style,
Box::new(move |args: &[Value]| match args.first() {
Some(arg) => func(arg.clone()),
None => Err(evaluator::EvaluationError::WrongNumArguments {
function_name: name.clone(),
expected: 1,
actual: args.len(),
}),
}),
None,
vec![arg_type],
)
}
/// Create a new `ExtensionFunction` taking one argument
pub fn unary(
name: Name,
style: CallStyle,
func: Box<dyn Fn(Value) -> evaluator::Result<ExtensionOutputValue> + Sync + Send + 'static>,
return_type: SchemaType,
arg_type: Option<SchemaType>,
) -> Self {
Self::new(
name.clone(),
style,
Box::new(move |args: &[Value]| match &args {
&[arg] => func(arg.clone()),
_ => Err(evaluator::EvaluationError::WrongNumArguments {
function_name: name.clone(),
expected: 1,
actual: args.len(),
}),
}),
Some(return_type),
vec![arg_type],
)
}
/// Create a new `ExtensionFunction` taking two arguments
pub fn binary(
name: Name,
style: CallStyle,
func: Box<
dyn Fn(Value, Value) -> evaluator::Result<ExtensionOutputValue> + Sync + Send + 'static,
>,
return_type: SchemaType,
arg_types: (Option<SchemaType>, Option<SchemaType>),
) -> Self {
Self::new(
name.clone(),
style,
Box::new(move |args: &[Value]| match &args {
&[first, second] => func(first.clone(), second.clone()),
_ => Err(evaluator::EvaluationError::WrongNumArguments {
function_name: name.clone(),
expected: 2,
actual: args.len(),
}),
}),
Some(return_type),
vec![arg_types.0, arg_types.1],
)
}
/// Create a new `ExtensionFunction` taking three arguments
pub fn ternary(
name: Name,
style: CallStyle,
func: Box<
dyn Fn(Value, Value, Value) -> evaluator::Result<ExtensionOutputValue>
+ Sync
+ Send
+ 'static,
>,
return_type: SchemaType,
arg_types: (Option<SchemaType>, Option<SchemaType>, Option<SchemaType>),
) -> Self {
Self::new(
name.clone(),
style,
Box::new(move |args: &[Value]| match &args {
&[first, second, third] => func(first.clone(), second.clone(), third.clone()),
_ => Err(evaluator::EvaluationError::WrongNumArguments {
function_name: name.clone(),
expected: 3,
actual: args.len(),
}),
}),
Some(return_type),
vec![arg_types.0, arg_types.1, arg_types.2],
)
}
/// Get the `Name` of the `ExtensionFunction`
pub fn name(&self) -> &Name {
&self.name
}
/// Get the `CallStyle` of the `ExtensionFunction`
pub fn style(&self) -> CallStyle {
self.style
}
/// Get the return type of the `ExtensionFunction`
/// `None` represents the `Never` type.
pub fn return_type(&self) -> Option<&SchemaType> {
self.return_type.as_ref()
}
/// Get the argument types of the `ExtensionFunction`.
///
/// If any given argument type is not constant (function works with multiple
/// `SchemaType`s) then this will be `None` for that argument.
pub fn arg_types(&self) -> &[Option<SchemaType>] {
&self.arg_types
}
/// Returns `true` if this function is considered a "constructor".
///
/// Currently, the only impact of this is that non-constructors are not
/// accessible in the JSON format (entities/json.rs).
pub fn is_constructor(&self) -> bool {
// return type is an extension type
matches!(self.return_type(), Some(SchemaType::Extension { .. }))
// all arg types are `Some()`
&& self.arg_types().iter().all(Option::is_some)
// no argument is an extension type
&& !self.arg_types().iter().any(|ty| matches!(ty, Some(SchemaType::Extension { .. })))
}
/// Call the `ExtensionFunction` with the given args
pub fn call(&self, args: &[Value]) -> evaluator::Result<PartialValue> {
match (self.func)(args)? {
ExtensionOutputValue::Concrete(v) => Ok(PartialValue::Value(v)),
ExtensionOutputValue::Unknown(name) => Ok(PartialValue::Residual(Expr::unknown(name))),
}
}
}
impl std::fmt::Debug for ExtensionFunction {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "<extension function {}>", self.name())
}
}
/// Extension value.
///
/// Anything implementing this trait can be used as a first-class value in
/// Cedar. For instance, the `ipaddr` extension uses this mechanism
/// to implement IPAddr as a Cedar first-class value.
pub trait ExtensionValue: Debug + Display {
/// Get the name of the type of this value.
///
/// Cedar has nominal typing, so two values have the same type iff they
/// return the same typename here.
fn typename(&self) -> Name;
}
impl<V: ExtensionValue> StaticallyTyped for V {
fn type_of(&self) -> Type {
Type::Extension {
name: self.typename(),
}
}
}
#[derive(Debug, Clone)]
/// Object container for extension values, also stores the fully reduced AST
/// for the arguments
pub struct ExtensionValueWithArgs {
value: Arc<dyn InternalExtensionValue>,
args: Vec<Expr>,
constructor: Name,
}
impl ExtensionValueWithArgs {
/// Get the internal value
pub fn value(&self) -> &dyn InternalExtensionValue {
self.value.as_ref()
}
/// Get the typename of this extension value
pub fn typename(&self) -> Name {
self.value.typename()
}
/// Constructor
pub fn new(value: Arc<dyn InternalExtensionValue>, args: Vec<Expr>, constructor: Name) -> Self {
Self {
value,
args,
constructor,
}
}
}
impl From<ExtensionValueWithArgs> for Expr {
fn from(val: ExtensionValueWithArgs) -> Self {
ExprBuilder::new().call_extension_fn(val.constructor, val.args)
}
}
impl StaticallyTyped for ExtensionValueWithArgs {
fn type_of(&self) -> Type {
self.value.type_of()
}
}
impl Display for ExtensionValueWithArgs {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.value)
}
}
impl PartialEq for ExtensionValueWithArgs {
fn eq(&self, other: &Self) -> bool {
// Values that are equal are equal regardless of which arguments made them
self.value.as_ref() == other.value.as_ref()
}
}
impl Eq for ExtensionValueWithArgs {}
impl PartialOrd for ExtensionValueWithArgs {
fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
Some(self.cmp(other))
}
}
impl Ord for ExtensionValueWithArgs {
fn cmp(&self, other: &Self) -> std::cmp::Ordering {
self.value.cmp(&other.value)
}
}
/// Extensions provide a type implementing `ExtensionValue`, `Eq`, and `Ord`.
/// We automatically implement `InternalExtensionValue` for that type (with the
/// impl below). Internally, we use `dyn InternalExtensionValue` instead of
/// `dyn ExtensionValue`.
///
/// You might wonder why we don't just have `ExtensionValue: Eq + Ord` and use
/// `dyn ExtensionValue` everywhere. The answer is that the Rust compiler
/// doesn't let you because of
/// [object safety](https://doc.rust-lang.org/reference/items/traits.html#object-safety).
/// So instead we have this workaround where we define our own `equals_extvalue`
/// method that compares not against `&Self` but against `&dyn InternalExtensionValue`,
/// and likewise for `cmp_extvalue`.
pub trait InternalExtensionValue: ExtensionValue {
/// convert to an `Any`
fn as_any(&self) -> &dyn Any;
/// this will be the basis for `PartialEq` on `InternalExtensionValue`; but
/// note the `&dyn` (normal `PartialEq` doesn't have the `dyn`)
fn equals_extvalue(&self, other: &dyn InternalExtensionValue) -> bool;
/// this will be the basis for `Ord` on `InternalExtensionValue`; but note
/// the `&dyn` (normal `Ord` doesn't have the `dyn`)
fn cmp_extvalue(&self, other: &dyn InternalExtensionValue) -> std::cmp::Ordering;
}
impl<V: 'static + Eq + Ord + ExtensionValue> InternalExtensionValue for V {
fn as_any(&self) -> &dyn Any {
self
}
fn equals_extvalue(&self, other: &dyn InternalExtensionValue) -> bool {
other
.as_any()
.downcast_ref::<V>()
.map(|v| self == v)
.unwrap_or(false) // if the downcast failed, values are different types, so equality is false
}
fn cmp_extvalue(&self, other: &dyn InternalExtensionValue) -> std::cmp::Ordering {
other
.as_any()
.downcast_ref::<V>()
.map(|v| self.cmp(v))
.unwrap_or_else(|| {
// downcast failed, so values are different types.
// we fall back on the total ordering on typenames.
self.typename().cmp(&other.typename())
})
}
}
impl PartialEq for dyn InternalExtensionValue {
fn eq(&self, other: &Self) -> bool {
self.equals_extvalue(other)
}
}
impl Eq for dyn InternalExtensionValue {}
impl PartialOrd for dyn InternalExtensionValue {
fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
Some(self.cmp(other))
}
}
impl Ord for dyn InternalExtensionValue {
fn cmp(&self, other: &Self) -> std::cmp::Ordering {
self.cmp_extvalue(other)
}
}
impl StaticallyTyped for dyn InternalExtensionValue {
fn type_of(&self) -> Type {
Type::Extension {
name: self.typename(),
}
}
}