Skip to content

Avoid panics in NgxListIterator, ngx_str_t::to_str #183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 28, 2025
Merged

Avoid panics in NgxListIterator, ngx_str_t::to_str #183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00e9c8f
fix: use NgxStr in NgxListIterator to prevent UTF-8 panics
pchickey Jul 28, 2025
11bdc20
fix(sys): replace panicking ngx_str_t::to_str with fallible variant
pchickey Jul 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions examples/async.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ use ngx::ffi::{
ngx_array_push, ngx_command_t, ngx_conf_t, ngx_connection_t, ngx_event_t, ngx_http_handler_pt,
ngx_http_module_t, ngx_http_phases_NGX_HTTP_ACCESS_PHASE, ngx_int_t, ngx_module_t,
ngx_post_event, ngx_posted_events, ngx_posted_next_events, ngx_str_t, ngx_uint_t,
NGX_CONF_TAKE1, NGX_HTTP_LOC_CONF, NGX_HTTP_LOC_CONF_OFFSET, NGX_HTTP_MODULE,
NGX_CONF_TAKE1, NGX_HTTP_LOC_CONF, NGX_HTTP_LOC_CONF_OFFSET, NGX_HTTP_MODULE, NGX_LOG_EMERG,
};
use ngx::http::{self, HttpModule, MergeConfigError};
use ngx::http::{HttpModuleLocationConf, HttpModuleMainConf, NgxHttpCoreModule};
use ngx::{http_request_handler, ngx_log_debug_http, ngx_string};
use ngx::{http_request_handler, ngx_conf_log_error, ngx_log_debug_http, ngx_string};
use tokio::runtime::Runtime;

struct Module;
Expand Down Expand Up @@ -205,7 +205,13 @@ extern "C" fn ngx_http_async_commands_set_enable(
unsafe {
let conf = &mut *(conf as *mut ModuleConfig);
let args: &[ngx_str_t] = (*(*cf).args).as_slice();
let val = args[1].to_str();
let val = match args[1].to_str() {
Ok(s) => s,
Err(_) => {
ngx_conf_log_error!(NGX_LOG_EMERG, cf, "`async` argument is not utf-8 encoded");
return ngx::core::NGX_CONF_ERROR;
}
};

// set default value optionally
conf.enable = false;
Expand Down
33 changes: 25 additions & 8 deletions examples/awssig.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ use ngx::ffi::{
ngx_array_push, ngx_command_t, ngx_conf_t, ngx_http_handler_pt, ngx_http_module_t,
ngx_http_phases_NGX_HTTP_PRECONTENT_PHASE, ngx_int_t, ngx_module_t, ngx_str_t, ngx_uint_t,
NGX_CONF_TAKE1, NGX_HTTP_LOC_CONF, NGX_HTTP_LOC_CONF_OFFSET, NGX_HTTP_MODULE,
NGX_HTTP_SRV_CONF,
NGX_HTTP_SRV_CONF, NGX_LOG_EMERG,
};
use ngx::http::*;
use ngx::{http_request_handler, ngx_log_debug_http, ngx_string};
use ngx::{http_request_handler, ngx_conf_log_error, ngx_log_debug_http, ngx_string};

struct Module;

Expand Down Expand Up @@ -176,7 +176,17 @@ extern "C" fn ngx_http_awssigv4_commands_set_enable(
unsafe {
let conf = &mut *(conf as *mut ModuleConfig);
let args: &[ngx_str_t] = (*(*cf).args).as_slice();
let val = args[1].to_str();
let val = match args[1].to_str() {
Ok(s) => s,
Err(_) => {
ngx_conf_log_error!(
NGX_LOG_EMERG,
cf,
"`awssigv4` argument is not utf-8 encoded"
);
return ngx::core::NGX_CONF_ERROR;
}
};

// set default value optionally
conf.enable = false;
Expand Down Expand Up @@ -286,8 +296,16 @@ http_request_handler!(awssigv4_header_handler, |request: &mut Request| {
// Copy only headers that will be used to sign the request
let mut headers = HeaderMap::new();
for (name, value) in request.headers_in_iterator() {
if name.to_lowercase() == "host" {
headers.insert(http::header::HOST, value.parse().unwrap());
if let Ok(name) = name.to_str() {
if name.to_lowercase() == "host" {
if let Ok(value) = http::HeaderValue::from_bytes(value.as_bytes()) {
headers.insert(http::header::HOST, value);
} else {
return core::Status::NGX_DECLINED;
}
}
} else {
return core::Status::NGX_DECLINED;
}
}
headers.insert("X-Amz-Date", datetime_now.parse().unwrap());
Expand All @@ -313,12 +331,11 @@ http_request_handler!(awssigv4_header_handler, |request: &mut Request| {
request.add_header_in("authorization", signature.as_str());
request.add_header_in("X-Amz-Date", datetime_now.as_str());

// done signing, let's print values we have in request.headers_out, request.headers_in
for (name, value) in request.headers_out_iterator() {
ngx_log_debug_http!(request, "headers_out {}: {}", name, value);
ngx_log_debug_http!(request, "headers_out {name}: {value}",);
}
for (name, value) in request.headers_in_iterator() {
ngx_log_debug_http!(request, "headers_in {}: {}", name, value);
ngx_log_debug_http!(request, "headers_in {name}: {value}",);
}

core::Status::NGX_OK
Expand Down
12 changes: 9 additions & 3 deletions examples/curl.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ use ngx::core;
use ngx::ffi::{
ngx_array_push, ngx_command_t, ngx_conf_t, ngx_http_handler_pt, ngx_http_module_t,
ngx_http_phases_NGX_HTTP_ACCESS_PHASE, ngx_int_t, ngx_module_t, ngx_str_t, ngx_uint_t,
NGX_CONF_TAKE1, NGX_HTTP_LOC_CONF, NGX_HTTP_LOC_CONF_OFFSET, NGX_HTTP_MODULE,
NGX_CONF_TAKE1, NGX_HTTP_LOC_CONF, NGX_HTTP_LOC_CONF_OFFSET, NGX_HTTP_MODULE, NGX_LOG_EMERG,
};
use ngx::http::{self, HttpModule, MergeConfigError};
use ngx::http::{HttpModuleLocationConf, HttpModuleMainConf, NgxHttpCoreModule};
use ngx::{http_request_handler, ngx_log_debug_http, ngx_string};
use ngx::{http_request_handler, ngx_conf_log_error, ngx_log_debug_http, ngx_string};

struct Module;

Expand Down Expand Up @@ -119,7 +119,13 @@ extern "C" fn ngx_http_curl_commands_set_enable(
let conf = &mut *(conf as *mut ModuleConfig);
let args: &[ngx_str_t] = (*(*cf).args).as_slice();

let val = args[1].to_str();
let val = match args[1].to_str() {
Ok(s) => s,
Err(_) => {
ngx_conf_log_error!(NGX_LOG_EMERG, cf, "`curl` argument is not utf-8 encoded");
return ngx::core::NGX_CONF_ERROR;
}
};

// set default value optionally
conf.enable = false;
Expand Down
13 changes: 6 additions & 7 deletions nginx-sys/src/string.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,14 @@ impl ngx_str_t {
self.len == 0
}

/// Convert the nginx string to a string slice (`&str`).
///
/// # Panics
/// This function panics if the `ngx_str_t` is not valid UTF-8.
/// Returns the contents of this `ngx_str_t` a string slice (`&str`) if
/// the contents are utf-8 encoded.
///
/// # Returns
/// A string slice (`&str`) representing the nginx string.
pub fn to_str(&self) -> &str {
str::from_utf8(self.as_bytes()).unwrap()
/// A string slice (`&str`) representing the nginx string, or else a
/// Utf8Error.
pub fn to_str(&self) -> Result<&str, str::Utf8Error> {
str::from_utf8(self.as_bytes())
}

/// Creates an empty `ngx_str_t` instance.
Expand Down
9 changes: 7 additions & 2 deletions src/http/request.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,7 @@ impl<'a> Iterator for NgxListIterator<'a> {
// something like pub struct Header(ngx_table_elt_t);
// then header would have key and value

type Item = (&'a str, &'a str);
type Item = (&'a NgxStr, &'a NgxStr);

fn next(&mut self) -> Option<Self::Item> {
let part = self.part.as_mut()?;
Expand All @@ -478,7 +478,12 @@ impl<'a> Iterator for NgxListIterator<'a> {
}
let header = &part.arr[self.i];
self.i += 1;
Some((header.key.to_str(), header.value.to_str()))
unsafe {
Some((
NgxStr::from_ngx_str(header.key),
NgxStr::from_ngx_str(header.value),
))
}
}
}

Expand Down
Loading