|
| 1 | +// SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. |
| 2 | +// SPDX-License-Identifier: Apache-2.0 |
| 3 | + |
| 4 | +//! Dependency-light policy semantics shared by parsing, enforcement, and |
| 5 | +//! verification consumers. |
| 6 | +
|
| 7 | +/// HTTP methods allowed by the `read-only` access preset. |
| 8 | +pub const READ_ONLY_HTTP_METHODS: &[&str] = &["GET", "HEAD", "OPTIONS"]; |
| 9 | + |
| 10 | +/// HTTP methods allowed by the `read-write` access preset. |
| 11 | +pub const READ_WRITE_HTTP_METHODS: &[&str] = &["GET", "HEAD", "OPTIONS", "POST", "PUT", "PATCH"]; |
| 12 | + |
| 13 | +/// HTTP methods classified as writes by the policy risk model. |
| 14 | +pub const WRITE_HTTP_METHODS: &[&str] = &["POST", "PUT", "PATCH", "DELETE"]; |
| 15 | + |
| 16 | +/// Standard HTTP methods modeled by the policy risk prover. |
| 17 | +pub const STANDARD_HTTP_METHODS: &[&str] = |
| 18 | + &["GET", "HEAD", "OPTIONS", "POST", "PUT", "PATCH", "DELETE"]; |
| 19 | + |
| 20 | +const FULL_METHODS: &[&str] = &["*"]; |
| 21 | +const WEBSOCKET_READ_ONLY_METHODS: &[&str] = &["GET"]; |
| 22 | +const WEBSOCKET_READ_WRITE_METHODS: &[&str] = &["GET", "WEBSOCKET_TEXT"]; |
| 23 | + |
| 24 | +/// A protocol whose access presets expand into method rules. |
| 25 | +#[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| 26 | +pub enum MethodProtocol { |
| 27 | + Http, |
| 28 | + WebSocket, |
| 29 | +} |
| 30 | + |
| 31 | +/// A supported policy access preset. |
| 32 | +#[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| 33 | +pub enum AccessPreset { |
| 34 | + ReadOnly, |
| 35 | + ReadWrite, |
| 36 | + Full, |
| 37 | +} |
| 38 | + |
| 39 | +impl AccessPreset { |
| 40 | + /// Parse an access preset from its policy representation. |
| 41 | + #[must_use] |
| 42 | + pub fn parse(value: &str) -> Option<Self> { |
| 43 | + match value { |
| 44 | + "read-only" => Some(Self::ReadOnly), |
| 45 | + "read-write" => Some(Self::ReadWrite), |
| 46 | + "full" => Some(Self::Full), |
| 47 | + _ => None, |
| 48 | + } |
| 49 | + } |
| 50 | +} |
| 51 | + |
| 52 | +/// Expand an access preset into rules for a method-based protocol. |
| 53 | +/// |
| 54 | +/// Protocols such as GraphQL that authorize native operations instead of |
| 55 | +/// methods should parse [`AccessPreset`] and map it to their own rule type. |
| 56 | +#[must_use] |
| 57 | +pub const fn method_access_preset_rules( |
| 58 | + protocol: MethodProtocol, |
| 59 | + preset: AccessPreset, |
| 60 | +) -> &'static [&'static str] { |
| 61 | + match (protocol, preset) { |
| 62 | + (_, AccessPreset::Full) => FULL_METHODS, |
| 63 | + (MethodProtocol::WebSocket, AccessPreset::ReadOnly) => WEBSOCKET_READ_ONLY_METHODS, |
| 64 | + (MethodProtocol::WebSocket, AccessPreset::ReadWrite) => WEBSOCKET_READ_WRITE_METHODS, |
| 65 | + (_, AccessPreset::ReadOnly) => READ_ONLY_HTTP_METHODS, |
| 66 | + (_, AccessPreset::ReadWrite) => READ_WRITE_HTTP_METHODS, |
| 67 | + } |
| 68 | +} |
| 69 | + |
| 70 | +#[cfg(test)] |
| 71 | +mod tests { |
| 72 | + use super::*; |
| 73 | + |
| 74 | + #[test] |
| 75 | + fn expands_http_presets() { |
| 76 | + assert_eq!( |
| 77 | + method_access_preset_rules(MethodProtocol::Http, AccessPreset::ReadOnly), |
| 78 | + READ_ONLY_HTTP_METHODS |
| 79 | + ); |
| 80 | + assert_eq!( |
| 81 | + method_access_preset_rules(MethodProtocol::Http, AccessPreset::ReadWrite), |
| 82 | + READ_WRITE_HTTP_METHODS |
| 83 | + ); |
| 84 | + assert_eq!( |
| 85 | + method_access_preset_rules(MethodProtocol::Http, AccessPreset::Full), |
| 86 | + &["*"] |
| 87 | + ); |
| 88 | + } |
| 89 | + |
| 90 | + #[test] |
| 91 | + fn expands_websocket_presets() { |
| 92 | + assert_eq!( |
| 93 | + method_access_preset_rules(MethodProtocol::WebSocket, AccessPreset::ReadOnly), |
| 94 | + &["GET"] |
| 95 | + ); |
| 96 | + assert_eq!( |
| 97 | + method_access_preset_rules(MethodProtocol::WebSocket, AccessPreset::ReadWrite), |
| 98 | + &["GET", "WEBSOCKET_TEXT"] |
| 99 | + ); |
| 100 | + } |
| 101 | + |
| 102 | + #[test] |
| 103 | + fn rejects_unknown_preset() { |
| 104 | + assert_eq!(AccessPreset::parse("unknown"), None); |
| 105 | + } |
| 106 | +} |
0 commit comments