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
use runeauth::{Alternative, Check, Condition, ConditionChecker, Restriction, Rune, RuneError};
use std::fmt::Display;
use std::time::{SystemTime, UNIX_EPOCH};
/// Represents an entity that can provide restrictions.
///
/// The `Restrictor` trait should be implemented by types that are able to
/// produce a list of `Restriction`s. The `generate` method returns a `Result`
/// containing a vector of `Restriction`s or a `RuneError` in case of any error.
pub trait Restrictor {
/// Retrieves the restrictions associated with the current instance.
///
/// # Returns
/// A `Result` containing a `Vec` of `Restriction`s. In the event of
/// failure, returns a `RuneError`.
fn generate(self) -> Result<Vec<Restriction>, RuneError>;
}
/// A factory responsible for carving runes.
///
/// `RuneFactory` provides utility functions to manipulate and produce runes
/// with certain characteristics, such as additional restrictions.
pub struct RuneFactory;
impl RuneFactory {
/// Combines an original `Rune` with a list of restricters,
/// and produces a new rune in base64 format.
///
/// # Parameters
/// - `origin`: A reference to the original `Rune` that will serve as the
/// base.
/// - `append`: A `Vec` containing entities that implement the `Restrictor`
/// trait.
///
/// # Returns
/// A `Result` containing a `String` representing the carved rune in base64 format.
/// In the event of any failure during the carving process, returns a `RuneError`.
pub fn carve<T: Restrictor + Copy>(origin: &Rune, append: &[T]) -> Result<String, RuneError> {
let restrictions = append.into_iter().try_fold(Vec::new(), |mut acc, res| {
let mut r = res.generate()?;
acc.append(&mut r);
Ok(acc)
})?;
let mut originc = origin.clone();
restrictions.into_iter().for_each(|r| {
// Changes are applied in place, as well as returned, so
// this is ok.
let _ = originc.add_restriction(r);
});
Ok(originc.to_base64())
}
}
/// Predefined rule sets to generate `Restriction`s from.
#[derive(Clone, Copy)]
pub enum DefRules<'a> {
/// Represents a rule set where only read operations are allowed. This
/// translates to a `Restriction` that is "method^Get|method^List".
ReadOnly,
/// Represents a rule set where only the `pay` method is allowed. This
/// translates to a `Restriction` that is "method=pay".
Pay,
/// A special rule that adds the alternatives of the given `DefRules`
/// in a disjunctive set. Example: Add(vec![ReadOnly, Pay]) translates
/// to a `Restriction` that is "method^Get|method^List|method=pay".
Add(&'a [DefRules<'a>]),
}
impl<'a> Restrictor for DefRules<'a> {
/// Generate the actual `Restriction` entities based on the predefined rule
/// sets.
///
/// # Returns
/// A `Result` containing a vector of `Restriction` entities or a `RuneError`
/// if there's any error while generating the restrictions.
fn generate(self) -> Result<Vec<Restriction>, RuneError> {
match self {
DefRules::ReadOnly => {
let a: Vec<Restriction> = vec![Restriction::new(vec![
alternative("method", Condition::BeginsWith, "Get").unwrap(),
alternative("method", Condition::BeginsWith, "List").unwrap(),
])
.unwrap()];
Ok(a)
}
DefRules::Pay => {
let a =
vec![Restriction::new(vec![
alternative("method", Condition::Equal, "pay").unwrap()
])
.unwrap()];
Ok(a)
}
DefRules::Add(rules) => {
let alt_set =
rules
.into_iter()
.try_fold(Vec::new(), |mut acc: Vec<Alternative>, rule| {
let mut alts = rule
.generate()?
.into_iter()
.flat_map(|r| r.alternatives)
.collect();
acc.append(&mut alts);
Ok(acc)
})?;
let a = vec![Restriction::new(alt_set)?];
Ok(a)
}
}
}
}
impl<'a> Display for DefRules<'a> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
DefRules::ReadOnly => write!(f, "readonly"),
DefRules::Pay => write!(f, "pay"),
DefRules::Add(rules) => {
write!(
f,
"{}",
rules.into_iter().fold(String::new(), |acc, r| {
if acc.is_empty() {
format!("{}", r)
} else {
format!("{}|{}", acc, r)
}
})
)
}
}
}
}
/// Creates an `Alternative` based on the provided field, condition, and value.
///
/// This function is a shorthand for creating new `Alternative` entities
/// without having to manually wrap field and value into `String`.
///
/// # Parameters
/// - `field`: The field on which the alternative is based.
/// - `cond`: The condition to check against the field.
/// - `value`: The value to match with the condition against the field.
///
/// # Returns
///
/// A result containing the created `Alternative` or a `RuneError` if there's
/// any error in the creation.
fn alternative(field: &str, cond: Condition, value: &str) -> Result<Alternative, RuneError> {
Alternative::new(field.to_string(), cond, value.to_string(), false)
}
/// A context struct that holds information relevant to check a command against
/// a rune.
#[derive(Clone)]
pub struct Context {
// The rpc method associated with the request.
pub method: String,
// The public key associated with the request.
pub pubkey: String,
// The unique id.
pub unique_id: String,
// The timestamp associated with the request.
pub time: SystemTime,
// Todo (nepet): Add param field that uses enum or serde to store the params of a call.
}
/// Implementation of the `Check` trait for the `Context` struct, allowing it to
/// perform checks on rune alternatives.
impl Check for Context {
/// Performs a check on an alternative based on the context's fields.
///
/// # Arguments
///
/// * `alt` - The alternative to check against the context.
///
/// # Returns
///
/// * `Ok(())` if the check is successful, an `Err` containing a `RuneError` otherwise.
fn check_alternative(&self, alt: &Alternative) -> anyhow::Result<(), RuneError> {
let value = match alt.get_field().as_str() {
"" => self.unique_id.clone(),
"method" => self.method.clone(),
"pubkey" => self.pubkey.clone(),
"time" => self
.time
.duration_since(UNIX_EPOCH)
.map_err(|e| {
RuneError::Unknown(format!("Can not extract seconds from timestamp {:?}", e))
})?
.as_secs()
.to_string(),
_ => String::new(), // If we don't know the field we can not set it!
};
ConditionChecker { value }.check_alternative(alt)
}
}
#[cfg(test)]
mod tests {
use super::{Context, DefRules, RuneFactory};
use base64::{engine::general_purpose, Engine as _};
use runeauth::{Alternative, Condition, Restriction, Rune};
use std::time::SystemTime;
#[test]
fn test_carve_readonly_rune() {
let seed = [0; 32];
let mr = Rune::new_master_rune(&seed, vec![], None, None).unwrap();
// Carve a new rune from the master rune with given restrictions.
let carved = RuneFactory::carve(&mr, &[DefRules::ReadOnly]).unwrap();
let carved_byt = general_purpose::URL_SAFE.decode(&carved).unwrap();
let carved_restr = String::from_utf8(carved_byt[32..].to_vec()).unwrap(); // Strip off the authcode to inspect the restrictions.
assert_eq!(carved_restr, *"method^Get|method^List");
let carved_rune = Rune::from_base64(&carved).unwrap();
assert!(mr.is_authorized(&carved_rune));
}
#[test]
fn test_carve_disjunction_rune() {
let seed = [0; 32];
let mr = Rune::new_master_rune(&seed, vec![], None, None).unwrap();
// Carve a new rune from the master rune with given restrictions.
let carved =
RuneFactory::carve(&mr, &[DefRules::Add(&[DefRules::ReadOnly, DefRules::Pay])])
.unwrap();
let carved_byt = general_purpose::URL_SAFE.decode(&carved).unwrap();
let carved_restr = String::from_utf8(carved_byt[32..].to_vec()).unwrap(); // Strip off the authcode to inspect the restrictions.
assert_eq!(carved_restr, *"method^Get|method^List|method=pay");
let carved_rune = Rune::from_base64(&carved).unwrap();
assert!(mr.is_authorized(&carved_rune));
}
#[test]
fn test_defrules_display() {
let r = DefRules::Pay;
assert_eq!(format!("{}", r), "pay");
let r = DefRules::Add(&[DefRules::Pay]);
assert_eq!(format!("{}", r), "pay");
let r = DefRules::Add(&[DefRules::Pay, DefRules::ReadOnly]);
assert_eq!(format!("{}", r), "pay|readonly");
}
#[test]
fn test_context_check() {
let seedsecret = &[0; 32];
let mr = Rune::new_master_rune(seedsecret, vec![], None, None).unwrap();
// r1 restrictions: "pubkey=020000000000000000"
let r1 = Rune::new(
mr.authcode(),
vec![Restriction::new(vec![Alternative::new(
String::from("pubkey"),
Condition::Equal,
String::from("020000000000000000"),
false,
)
.unwrap()])
.unwrap()],
None,
None,
)
.unwrap();
// r2 restrictions: "method=GetInfo"
let r2 = Rune::new(
mr.authcode(),
vec![Restriction::new(vec![Alternative::new(
String::from("method"),
Condition::Equal,
String::from("GetInfo"),
false,
)
.unwrap()])
.unwrap()],
None,
None,
)
.unwrap();
// r3 restrictions: "pubkey!"
let r3 = Rune::new(
mr.authcode(),
vec![Restriction::new(vec![Alternative::new(
String::from("pubkey"),
Condition::Missing,
String::new(),
false,
)
.unwrap()])
.unwrap()],
None,
None,
)
.unwrap();
// r4 restriction: "method!"
let r4 = Rune::new(
mr.authcode(),
vec![Restriction::new(vec![Alternative::new(
String::from("method"),
Condition::Missing,
String::new(),
false,
)
.unwrap()])
.unwrap()],
None,
None,
)
.unwrap();
// These should succeed.
// Check with method="", pubkey=020000000000000000
let ctx = Context {
method: String::new(),
pubkey: String::from("020000000000000000"),
time: SystemTime::now(),
unique_id: String::new(),
};
assert!(r1.are_restrictions_met(ctx).is_ok());
// Check with method="ListFunds", pubkey=020000000000000000
let ctx = Context {
method: String::from("ListFunds"),
pubkey: String::from("020000000000000000"),
time: SystemTime::now(),
unique_id: String::new(),
};
assert!(r1.are_restrictions_met(ctx).is_ok());
// Check with method="GetInfo", pubkey=""
let ctx = Context {
method: String::from("GetInfo"),
pubkey: String::new(),
time: SystemTime::now(),
unique_id: String::new(),
};
assert!(r2.are_restrictions_met(ctx).is_ok());
// Check with method="GetInfo", pubkey="020000000000000000"
let ctx = Context {
method: String::from("GetInfo"),
pubkey: String::from("020000000000000000"),
time: SystemTime::now(),
unique_id: String::new(),
};
assert!(r2.are_restrictions_met(ctx).is_ok());
// Check with method="GetInfo", pubkey=""
let ctx = Context {
method: String::from("GetInfo"),
pubkey: String::new(),
time: SystemTime::now(),
unique_id: String::new(),
};
assert!(r3.are_restrictions_met(ctx).is_ok());
// Check with method="", pubkey="020000"
let ctx = Context {
method: String::new(),
pubkey: String::from("020000000000000000"),
time: SystemTime::now(),
unique_id: String::new(),
};
assert!(r4.are_restrictions_met(ctx).is_ok());
// These should fail.
// Check with method="ListFunds", pubkey=030000, wrong pubkey.
let ctx = Context {
method: String::from("ListFunds"),
pubkey: String::from("030000"),
time: SystemTime::now(),
unique_id: String::new(),
};
assert!(r1.are_restrictions_met(ctx).is_err());
// Check with method="ListFunds", pubkey=030000, wrong method.
let ctx = Context {
method: String::from("ListFunds"),
pubkey: String::from("030000"),
time: SystemTime::now(),
unique_id: String::new(),
};
assert!(r2.are_restrictions_met(ctx).is_err());
// Check with pubkey=030000, pubkey present.
let ctx = Context {
method: String::new(),
pubkey: String::from("030000"),
time: SystemTime::now(),
unique_id: String::new(),
};
assert!(r3.are_restrictions_met(ctx).is_err());
// Check with method="GetInfo", method present.
let ctx = Context {
method: String::from("GetInfo"),
pubkey: String::new(),
time: SystemTime::now(),
unique_id: String::new(),
};
assert!(r4.are_restrictions_met(ctx).is_err());
}
}