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 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
// regex
use regex::Regex;
// arc
use std::sync::Arc;
use std::sync::Mutex;
// duration
use std::time::Duration;
// log
use log::{debug, info, warn};
// proxy-wasm
use proxy_wasm::hostcalls;
use proxy_wasm::traits::*;
use proxy_wasm::types::*;
// url
use url::Url;
// crate
use crate::config::PluginConfiguration;
use crate::error::PluginError;
use crate::responses::{JWKsResponse, OidcDiscoveryResponse, SigningKey};
use crate::{ConfiguredOidc, OpenIdConfig, PauseRequests};
// This is the initial entry point of the plugin.
proxy_wasm::main! {{
proxy_wasm::set_log_level(LogLevel::Debug);
info!("Starting OIDC plugin");
// This sets the root context, which is the first context that is called on startup.
// The root context is used to initialize the plugin and load the configuration from the
// plugin config and the discovery endpoints.
// Here, we set state to uninitialized, which means that the plugin is not yet configured.
// The state will be changed to LoadingConfig when the plugin configuration is loaded.
// The token_id is used to verify that the http responses match the dispatches which are
// sent to the discovery endpoints.
proxy_wasm::set_root_context(|_| -> Box<dyn RootContext> { Box::new(OidcDiscovery {
state: OidcRootState::Uninitialized,
waiting: Mutex::new(Vec::new()),
token_id: None,
}) });
}}
/// This context is responsible for getting the OIDC configuration, jwks keys
/// and setting the http context.
pub struct OidcDiscovery {
/// The state of the root context. This is an enum which has the following variants:
/// - Uninitialized: The plugin is not yet configured
/// - LoadingConfig: The plugin configuration is being loaded
/// - LoadingJwks: The jwks configuration is being loaded
/// - Ready: The plugin is ready
pub state: OidcRootState,
/// Queue of waiting requests which are waiting for the configuration to be loaded
waiting: Mutex<Vec<u32>>,
/// token_id of the HttpCalls to verify the call is correct
token_id: Option<u32>,
}
/// The state of the root context is an enum which has the following variants:
/// - Uninitialized: The plugin is not yet configured
/// - LoadingConfig: The plugin configuration is being loaded
/// - LoadingJwks: The jwks configuration is being loaded
/// - Ready: The plugin is ready
/// Each state has a different set of fields which are needed for that specific state.
#[allow(clippy::large_enum_variant)]
pub enum OidcRootState {
/// State when the plugin needs to load the plugin configuration
Uninitialized,
/// The root context is loading the configuration from the open id discovery endpoint
LoadingConfig {
/// Plugin config loaded from the envoy configuration
plugin_config: Arc<PluginConfiguration>,
},
/// The root context is loading the jwks configuration
LoadingJwks {
/// Plugin config
plugin_config: Arc<PluginConfiguration>,
/// The authorization endpoint to start the code flow
auth_endpoint: Url,
/// The token endpoint to exchange the code for a token
token_endpoint: Url,
/// The issuer
issuer: String,
/// The url from which the public keys can be retrieved
jwks_uri: Url,
},
/// The root context is ready
Ready {
/// Plugin config loaded from the envoy configuration
plugin_config: Arc<PluginConfiguration>,
/// Open id config loaded from the open id discovery endpoint and the jwks endpoint
open_id_config: Arc<OpenIdConfig>,
},
}
/// The root context is used to create new HTTP contexts and load configuration from the
/// open id discovery endpoint and the jwks endpoint.
/// When `on_configure` is called, the plugin configuration is loaded and the state is set to
/// LoadingConfig. The filter is then ticked immediately to load the configuration.
/// When `on_http_call_response` is called, the Open ID response is parsed and the state is set to
/// LoadingJwks.
/// On the next tick, the jwks endpoint is called and the state is set to Ready once the jwks
/// response is received and successfully parsed.
impl RootContext for OidcDiscovery {
/// Called when proxy is being configured.
/// This is where the plugin configuration is loaded and the next state is set.
fn on_configure(&mut self, _plugin_configuration_size: usize) -> bool {
info!("Plugin is configuring");
// Load the configuration from the plugin configuration.
match self.get_plugin_configuration() {
Some(config_bytes) => {
debug!("got plugin configuration");
// Parse the configuration in a yaml format.
match serde_yaml::from_slice::<PluginConfiguration>(&config_bytes) {
Ok(plugin_config) => {
debug!("parsed plugin configuration: {:?}", plugin_config);
// Evaluate the plugin configuration and check if the values are valid.
// Type checking is done by serde, so we only need to check the values.
match OidcDiscovery::evaluate_config(plugin_config.clone()) {
Ok(_) => {
info!("plugin configuration is valid");
}
Err(e) => {
panic!("plugin configuration is invalid: {:?}", e);
}
}
// Advance to the next state and store the plugin configuration.
self.state = OidcRootState::LoadingConfig {
plugin_config: Arc::new(plugin_config),
};
// Tick immediately to load the configuration.
// See `on_tick` for more information.
self.set_tick_period(Duration::from_millis(1));
return true;
}
Err(e) => warn!("error parsing plugin configuration: {:?}", e),
}
}
None => warn!("no plugin configuration"),
}
false
}
/// Creates the http context with the information from the open_id_config and the plugin configuration.
/// This is called whenever a new http context is created by the proxy.
/// When the plugin is not yet ready, the http context is created in `Unconfigured` state and the
/// context id is added to the waiting queue to be processed later.
fn create_http_context(&self, context_id: u32) -> Option<Box<dyn HttpContext>> {
match &self.state {
// If the plugin is ready, create the http context in Ready state
// with the open-id config and the plugin config.
OidcRootState::Ready {
open_id_config,
plugin_config,
} => {
debug!("creating http context with root context information");
// Return the http context.
Some(Box::new(ConfiguredOidc {
open_id_config: open_id_config.clone(),
plugin_config: plugin_config.clone(),
token_id: None,
}))
}
// If the plugin is not ready, return the http context in `Unconfigured` state and add the
// context id to the waiting queue.
_ => {
warn!("root context is not ready yet, queueing http context.");
// Add the context id to the waiting queue.
self.waiting.lock().unwrap().push(context_id);
// Return the http context in `Unconfigured` state.
Some(Box::new(PauseRequests {
original_path: None,
}))
}
}
}
/// The root context is ticking every 400 millis as long as the configuration is not loaded yet.
/// On every tick, the state is checked and the corresponding action is taken.
/// 1. If the state is `Uninitialized`, the configuration is loaded from the plugin configuration.
/// 2. If the state is `LoadingConfig`, the configuration is loaded from the openid configuration endpoint.
/// 3. If the state is `LoadingJwks`, the public key is loaded from the jwks endpoint.
/// 4. If the state is `Ready`, the configuration is reloaded.
fn on_tick(&mut self) {
debug!("tick");
// See what the current state is.
match &self.state {
// This state is not possible, but is here to make the compiler happy.
OidcRootState::Uninitialized => {
warn!("plugin is not initialized");
}
// If the plugin is in Loading `LoadingConfig` state, the configuration is loaded from the
// openid configuration endpoint.
OidcRootState::LoadingConfig { plugin_config } => {
// Tick every 300ms to not overload the openid configuration endpoint.
self.set_tick_period(Duration::from_millis(300));
// Make call to openid configuration endpoint
// The response is handled in `on_http_call_response`.
match self.dispatch_http_call(
"oidc",
vec![
(":method", "GET"),
(":path", plugin_config.config_endpoint.as_str()),
(":authority", plugin_config.authority.as_str()),
],
None,
vec![],
Duration::from_secs(5),
) {
Ok(id) => {
debug!("dispatched openid config call");
self.token_id = Some(id);
}
Err(e) => warn!("error dispatching oidc call: {:?}", e),
}
}
// If the plugin is in Loading `LoadingJwks` state, the public keys are loaded from the
// jwks endpoint.
OidcRootState::LoadingJwks {
plugin_config,
jwks_uri,
..
} => {
// Make call to jwks endpoint and load public key
// The response is handled in `on_http_call_response`.
match self.dispatch_http_call(
"oidc",
vec![
(":method", "GET"),
(":path", jwks_uri.as_str()),
(":authority", plugin_config.authority.as_str()),
],
None,
vec![],
Duration::from_secs(5),
) {
Ok(id) => {
debug!("dispatched jwks call");
self.token_id = Some(id);
}
Err(e) => warn!("error dispatching jwks call: {:?}", e),
}
}
OidcRootState::Ready {
open_id_config: _,
plugin_config,
..
} => {
// If this state is reached, the plugin was ready and needs to reload the configuration.
// This is controlled by `reload_interval_in_h` in the plugin configuration.
// The state is set to `LoadingConfig` and the tick period is set to 1ms to load the configuration.
self.state = OidcRootState::LoadingConfig {
plugin_config: plugin_config.clone(),
};
self.set_tick_period(Duration::from_millis(1));
}
}
}
/// This is one of those functions that need to be there for some reason but we are
/// not sure why. It just doesn't work without it.
fn get_type(&self) -> Option<proxy_wasm::types::ContextType> {
Some(ContextType::HttpContext)
}
}
/// The context is used to process the response from the OIDC config endpoint and the jwks endpoint.
/// It also utilized the state enum to determine what to do with the response.
/// 1. If the state is `Uninitialized`, the plugin is not initialized and the response is ignored.
/// 2. If the state is `LoadingConfig`, the open id configuration is expected.
/// 3. If the state is `LoadingJwks`, the jwks endpoint is expected.
/// 4. `Ready` is not expected, as the root context doesn't dispatch any calls in that state.
impl Context for OidcDiscovery {
/// Called when the response from the http call is received.
/// It also utilised the state enum to determine what to do with the response.
/// 1. If the state is `Uninitialized`, the plugin is not initialized and the response is ignored.
/// 2. If the state is `LoadingConfig`, the open id configuration is expected.
/// 3. If the state is `LoadingJwks`, the jwks endpoint is expected.
/// 4. `Ready` is not expected, as the root context doesn't dispatch any calls in that state.
fn on_http_call_response(
&mut self,
token_id: u32,
_num_headers: usize,
_body_size: usize,
_num_trailers: usize,
) {
// Check for each state what to do with the response.
self.state = match &self.state {
// This state is not possible, but is here to make the compiler happy.
OidcRootState::Uninitialized => {
warn!("plugin is not initialized");
return;
}
// If the plugin is in Loading `LoadingConfig` state, the response is expected to be the
// openid configuration.
OidcRootState::LoadingConfig { plugin_config } => {
// If the token id is not the same as the one from the call made in
// `self.dispatch_http_call`, the response is ignored.
if self.token_id != Some(token_id) {
warn!("unexpected token id");
return;
}
debug!("received openid config response");
// Parse the response body as json.
let body = match self.get_http_call_response_body(0, _body_size) {
Some(body) => body,
None => {
warn!("no body in openid config response");
return;
}
};
// Parse body
match serde_json::from_slice::<OidcDiscoveryResponse>(&body) {
Ok(open_id_response) => {
debug!("parsed openid config response: {:?}", open_id_response);
// Set the state to loading jwks.
OidcRootState::LoadingJwks {
plugin_config: plugin_config.clone(),
auth_endpoint: open_id_response.authorization_endpoint,
token_endpoint: open_id_response.token_endpoint,
issuer: open_id_response.issuer,
jwks_uri: open_id_response.jwks_uri,
}
}
Err(e) => {
// Stay in the same state.
warn!("error parsing config response: {:?}", e);
return;
}
}
}
// If the plugin is in `LoadingJwks` state, the jwks endpoint is expected.
OidcRootState::LoadingJwks {
plugin_config,
auth_endpoint,
token_endpoint,
issuer,
..
} => {
// If the token id is not the same as the one from the call, return.
if self.token_id != Some(token_id) {
warn!("unexpected token id");
return;
}
debug!("received jwks response");
// Parse body
let body = self.get_http_call_response_body(0, _body_size).unwrap();
match serde_json::from_slice::<JWKsResponse>(&body) {
Ok(jwks_response) => {
debug!("parsed jwks body: {:?}", jwks_response);
// Check if keys are present
if jwks_response.keys.is_empty() {
warn!("no keys found in jwks response, retry in 1 minute");
self.set_tick_period(Duration::from_secs(60));
return;
}
// For all keys, create a signing key if possible
let mut keys: Vec<SigningKey> = vec![];
for key in jwks_response.keys {
// Create the signing key from the JWK
let signing_key = SigningKey::from(key);
// Add the signing key to the list of keys
keys.push(signing_key);
}
// Now that we have loaded all the configuration, we can set the tick period
// to the configured value and advance to the ready state.
self.set_tick_period(Duration::from_secs(
plugin_config.reload_interval_in_h * 3600,
));
info!("All configuration loaded. Filter is ready. Refreshing config in {} hour(s).",
plugin_config.reload_interval_in_h);
// Set the state to ready.
OidcRootState::Ready {
open_id_config: Arc::new(OpenIdConfig {
auth_endpoint: auth_endpoint.clone(),
token_endpoint: token_endpoint.clone(),
issuer: issuer.clone(),
public_keys: keys,
}),
plugin_config: plugin_config.clone(),
}
}
Err(e) => {
warn!("error parsing jwks body: {:?}", e);
// Stay in the same state as the response couldn't be parsed.
return;
}
}
}
// If the plugin is in `Ready` state, the response is ignored and the state is not changed.
OidcRootState::Ready { .. } => {
warn!("ready state is not expected here");
return;
}
};
// If the plugin is in `Ready` state, any request that was sent during the loading phase,
// is now resumed.
if matches!(self.state, OidcRootState::Ready { .. }) {
for context_id in self.waiting.lock().unwrap().drain(..) {
info!("resuming queued request with id {}", context_id);
hostcalls::set_effective_context(context_id).unwrap_or_else(|e| {
warn!("error setting effective context, most likely the tab was closed already: {:?}", e);
});
hostcalls::resume_http_request().unwrap_or_else(|e| {
warn!(
"error resuming http request, most likely the tab was closed already: {:?}",
e
);
});
}
}
}
}
impl OidcDiscovery {
/// Evaluate the plugin configuration and check if the values are valid.
/// Type checking is done by serde, so we only need to check the values.
/// * `plugin_config` - The plugin configuration to be evaluated
/// Returns `Ok` if the configuration is valid, otherwise `Err` with a message.
pub fn evaluate_config(plugin_config: PluginConfiguration) -> Result<(), PluginError> {
// Reload Interval
if plugin_config.reload_interval_in_h == 0 {
return Err(PluginError::ConfigError(
"`reload_interval` is 0".to_string(),
));
}
// Cookie Name
if plugin_config.cookie_name.len() > 32 {
return Err(PluginError::ConfigError(
"`cookie_name` is too long, max 32".to_string(),
));
}
let cookies_name_regex = Regex::new(r"[\w\d-]+").unwrap();
if plugin_config.cookie_name.is_empty()
|| !cookies_name_regex.is_match(&plugin_config.cookie_name)
{
return Err(PluginError::ConfigError("`cookie_name` is empty or not valid meaning that it contains invalid characters like ;, =, :, /, space".to_string()));
}
// Cookie Duration
if plugin_config.cookie_duration == 0 {
return Err(PluginError::ConfigError(
"`cookie_duration` is 0".to_string(),
));
}
// Authority
if plugin_config.authority.is_empty() {
return Err(PluginError::ConfigError("`authority` is empty".to_string()));
}
// Client Id
if plugin_config.client_id.is_empty() {
return Err(PluginError::ConfigError("`client_id` is empty".to_string()));
}
// Scope
if plugin_config.scope.is_empty() {
return Err(PluginError::ConfigError("`scope` is empty".to_string()));
}
// Claims
if plugin_config.claims.is_empty() {
return Err(PluginError::ConfigError("`claims` is empty".to_string()));
}
// Client Secret
if plugin_config.client_secret.reveal().is_empty() {
return Err(PluginError::ConfigError(
"client_secret is empty".to_string(),
));
}
// Audience
if plugin_config.audience.is_empty() {
return Err(PluginError::ConfigError("audience is empty".to_string()));
}
// Else return Ok
Ok(())
}
}