ferron/optional_modules/
fcgi.rs

1// FastCGI handler code inspired by SVR.JS's GreenRhombus mod, translated from JavaScript to Rust.
2// Based on the "cgi" and "scgi" module
3use std::env;
4use std::error::Error;
5use std::path::{Path, PathBuf};
6use std::sync::Arc;
7use std::time::Duration;
8
9use crate::ferron_common::{
10  ErrorLogger, HyperRequest, HyperResponse, RequestData, ResponseData, ServerConfig, ServerModule,
11  ServerModuleHandlers, SocketData,
12};
13use crate::ferron_common::{HyperUpgraded, WithRuntime};
14use async_trait::async_trait;
15use futures_util::future::Either;
16use futures_util::TryStreamExt;
17use hashlink::LinkedHashMap;
18use http_body_util::{BodyExt, StreamBody};
19use httparse::EMPTY_HEADER;
20use hyper::body::{Bytes, Frame};
21use hyper::{header, Response, StatusCode};
22use hyper_tungstenite::HyperWebsocket;
23use tokio::fs;
24use tokio::io::{AsyncRead, AsyncWrite, AsyncWriteExt};
25use tokio::net::TcpStream;
26use tokio::runtime::Handle;
27use tokio::sync::RwLock;
28use tokio_util::codec::{FramedRead, FramedWrite};
29use tokio_util::io::{ReaderStream, SinkWriter, StreamReader};
30
31use crate::ferron_res::server_software::SERVER_SOFTWARE;
32use crate::ferron_util::cgi_response::CgiResponse;
33use crate::ferron_util::copy_move::Copier;
34use crate::ferron_util::fcgi_decoder::{FcgiDecodedData, FcgiDecoder};
35use crate::ferron_util::fcgi_encoder::FcgiEncoder;
36use crate::ferron_util::fcgi_name_value_pair::construct_fastcgi_name_value_pair;
37use crate::ferron_util::fcgi_record::construct_fastcgi_record;
38use crate::ferron_util::read_to_end_move::ReadToEndFuture;
39use crate::ferron_util::split_stream_by_map::SplitStreamByMapExt;
40use crate::ferron_util::ttl_cache::TtlCache;
41
42pub fn server_module_init(
43  _config: &ServerConfig,
44) -> Result<Box<dyn ServerModule + Send + Sync>, Box<dyn Error + Send + Sync>> {
45  let cache = Arc::new(RwLock::new(TtlCache::new(Duration::from_millis(100))));
46  Ok(Box::new(FcgiModule::new(cache)))
47}
48
49#[allow(clippy::type_complexity)]
50struct FcgiModule {
51  path_cache: Arc<RwLock<TtlCache<String, (Option<PathBuf>, Option<String>)>>>,
52}
53
54impl FcgiModule {
55  #[allow(clippy::type_complexity)]
56  fn new(path_cache: Arc<RwLock<TtlCache<String, (Option<PathBuf>, Option<String>)>>>) -> Self {
57    Self { path_cache }
58  }
59}
60
61impl ServerModule for FcgiModule {
62  fn get_handlers(&self, handle: Handle) -> Box<dyn ServerModuleHandlers + Send> {
63    Box::new(FcgiModuleHandlers {
64      path_cache: self.path_cache.clone(),
65      handle,
66    })
67  }
68}
69
70#[allow(clippy::type_complexity)]
71struct FcgiModuleHandlers {
72  handle: Handle,
73  path_cache: Arc<RwLock<TtlCache<String, (Option<PathBuf>, Option<String>)>>>,
74}
75
76#[async_trait]
77impl ServerModuleHandlers for FcgiModuleHandlers {
78  async fn request_handler(
79    &mut self,
80    request: RequestData,
81    config: &ServerConfig,
82    socket_data: &SocketData,
83    error_logger: &ErrorLogger,
84  ) -> Result<ResponseData, Box<dyn Error + Send + Sync>> {
85    WithRuntime::new(self.handle.clone(), async move {
86      let mut fastcgi_script_exts = Vec::new();
87
88      let fastcgi_script_exts_yaml = &config["fcgiScriptExtensions"];
89      if let Some(fastcgi_script_exts_obtained) = fastcgi_script_exts_yaml.as_vec() {
90        for fastcgi_script_ext_yaml in fastcgi_script_exts_obtained.iter() {
91          if let Some(fastcgi_script_ext) = fastcgi_script_ext_yaml.as_str() {
92            fastcgi_script_exts.push(fastcgi_script_ext);
93          }
94        }
95      }
96
97      let mut fastcgi_to = "tcp://localhost:4000/";
98      let fastcgi_to_yaml = &config["fcgiTo"];
99      if let Some(fastcgi_to_obtained) = fastcgi_to_yaml.as_str() {
100        fastcgi_to = fastcgi_to_obtained;
101      }
102
103      let mut fastcgi_path = None;
104      if let Some(fastcgi_path_obtained) = config["fcgiPath"].as_str() {
105        fastcgi_path = Some(fastcgi_path_obtained.to_string());
106      }
107
108      let hyper_request = request.get_hyper_request();
109
110      let request_path = hyper_request.uri().path();
111      let mut request_path_bytes = request_path.bytes();
112      if request_path_bytes.len() < 1 || request_path_bytes.nth(0) != Some(b'/') {
113        return Ok(
114          ResponseData::builder(request)
115            .status(StatusCode::BAD_REQUEST)
116            .build(),
117        );
118      }
119
120      let mut execute_pathbuf = None;
121      let mut execute_path_info = None;
122      let mut wwwroot_detected = None;
123
124      if let Some(fastcgi_path) = fastcgi_path {
125        let mut canonical_fastcgi_path: &str = &fastcgi_path;
126        if canonical_fastcgi_path.bytes().last() == Some(b'/') {
127          canonical_fastcgi_path = &canonical_fastcgi_path[..(canonical_fastcgi_path.len() - 1)];
128        }
129
130        let request_path_with_slashes = match request_path == canonical_fastcgi_path {
131          true => format!("{}/", request_path),
132          false => request_path.to_string(),
133        };
134        if let Some(stripped_request_path) =
135          request_path_with_slashes.strip_prefix(canonical_fastcgi_path)
136        {
137          let wwwroot_yaml = &config["wwwroot"];
138          let wwwroot = wwwroot_yaml.as_str().unwrap_or("/nonexistent");
139
140          let wwwroot_unknown = PathBuf::from(wwwroot);
141          let wwwroot_pathbuf = match wwwroot_unknown.as_path().is_absolute() {
142            true => wwwroot_unknown,
143            false => match fs::canonicalize(&wwwroot_unknown).await {
144              Ok(pathbuf) => pathbuf,
145              Err(_) => wwwroot_unknown,
146            },
147          };
148          wwwroot_detected = Some(wwwroot_pathbuf.clone());
149          let wwwroot = wwwroot_pathbuf.as_path();
150
151          let mut relative_path = &request_path[1..];
152          while relative_path.as_bytes().first().copied() == Some(b'/') {
153            relative_path = &relative_path[1..];
154          }
155
156          let decoded_relative_path = match urlencoding::decode(relative_path) {
157            Ok(path) => path.to_string(),
158            Err(_) => {
159              return Ok(
160                ResponseData::builder(request)
161                  .status(StatusCode::BAD_REQUEST)
162                  .build(),
163              );
164            }
165          };
166
167          let joined_pathbuf = wwwroot.join(decoded_relative_path);
168          execute_pathbuf = Some(joined_pathbuf);
169          execute_path_info = stripped_request_path
170            .strip_prefix("/")
171            .map(|s| s.to_string());
172        }
173      }
174
175      if execute_pathbuf.is_none() {
176        if let Some(wwwroot) = config["wwwroot"].as_str() {
177          let cache_key = format!(
178            "{}{}{}",
179            match config["ip"].as_str() {
180              Some(ip) => format!("{}-", ip),
181              None => String::from(""),
182            },
183            match config["domain"].as_str() {
184              Some(domain) => format!("{}-", domain),
185              None => String::from(""),
186            },
187            request_path
188          );
189
190          let wwwroot_unknown = PathBuf::from(wwwroot);
191          let wwwroot_pathbuf = match wwwroot_unknown.as_path().is_absolute() {
192            true => wwwroot_unknown,
193            false => match fs::canonicalize(&wwwroot_unknown).await {
194              Ok(pathbuf) => pathbuf,
195              Err(_) => wwwroot_unknown,
196            },
197          };
198          wwwroot_detected = Some(wwwroot_pathbuf.clone());
199          let wwwroot = wwwroot_pathbuf.as_path();
200
201          let read_rwlock = self.path_cache.read().await;
202          let (execute_pathbuf_got, execute_path_info_got) = match read_rwlock.get(&cache_key) {
203            Some(data) => {
204              drop(read_rwlock);
205              data
206            }
207            None => {
208              drop(read_rwlock);
209              let mut relative_path = &request_path[1..];
210              while relative_path.as_bytes().first().copied() == Some(b'/') {
211                relative_path = &relative_path[1..];
212              }
213
214              let decoded_relative_path = match urlencoding::decode(relative_path) {
215                Ok(path) => path.to_string(),
216                Err(_) => {
217                  return Ok(
218                    ResponseData::builder(request)
219                      .status(StatusCode::BAD_REQUEST)
220                      .build(),
221                  );
222                }
223              };
224
225              let joined_pathbuf = wwwroot.join(decoded_relative_path);
226              let mut execute_pathbuf: Option<PathBuf> = None;
227              let mut execute_path_info: Option<String> = None;
228
229              match fs::metadata(&joined_pathbuf).await {
230                Ok(metadata) => {
231                  if metadata.is_file() {
232                    let contained_extension = joined_pathbuf
233                      .extension()
234                      .map(|a| format!(".{}", a.to_string_lossy()));
235                    if let Some(contained_extension) = contained_extension {
236                      if fastcgi_script_exts.contains(&(&contained_extension as &str)) {
237                        execute_pathbuf = Some(joined_pathbuf);
238                      }
239                    }
240                  } else if metadata.is_dir() {
241                    let indexes = vec!["index.php", "index.cgi"];
242                    for index in indexes {
243                      let temp_joined_pathbuf = joined_pathbuf.join(index);
244                      match fs::metadata(&temp_joined_pathbuf).await {
245                        Ok(temp_metadata) => {
246                          if temp_metadata.is_file() {
247                            let contained_extension = temp_joined_pathbuf
248                              .extension()
249                              .map(|a| format!(".{}", a.to_string_lossy()));
250                            if let Some(contained_extension) = contained_extension {
251                              if fastcgi_script_exts.contains(&(&contained_extension as &str)) {
252                                execute_pathbuf = Some(temp_joined_pathbuf);
253                                break;
254                              }
255                            }
256                          }
257                        }
258                        Err(_) => continue,
259                      };
260                    }
261                  }
262                }
263                Err(err) => {
264                  if err.kind() == tokio::io::ErrorKind::NotADirectory {
265                    // TODO: find a file
266                    let mut temp_pathbuf = joined_pathbuf.clone();
267                    loop {
268                      if !temp_pathbuf.pop() {
269                        break;
270                      }
271                      match fs::metadata(&temp_pathbuf).await {
272                        Ok(metadata) => {
273                          if metadata.is_file() {
274                            let temp_path = temp_pathbuf.as_path();
275                            if !temp_path.starts_with(wwwroot) {
276                              // Traversed above the webroot, so ignore that.
277                              break;
278                            }
279                            let path_info = match joined_pathbuf.as_path().strip_prefix(temp_path) {
280                              Ok(path) => {
281                                let path = path.to_string_lossy().to_string();
282                                Some(match cfg!(windows) {
283                                  true => path.replace("\\", "/"),
284                                  false => path,
285                                })
286                              }
287                              Err(_) => None,
288                            };
289                            let mut request_path_normalized = match cfg!(windows) {
290                              true => request_path.to_lowercase(),
291                              false => request_path.to_string(),
292                            };
293                            while request_path_normalized.contains("//") {
294                              request_path_normalized = request_path_normalized.replace("//", "/");
295                            }
296                            if request_path_normalized == "/cgi-bin"
297                              || request_path_normalized.starts_with("/cgi-bin/")
298                            {
299                              execute_pathbuf = Some(temp_pathbuf);
300                              execute_path_info = path_info;
301                              break;
302                            } else {
303                              let contained_extension = temp_pathbuf
304                                .extension()
305                                .map(|a| format!(".{}", a.to_string_lossy()));
306                              if let Some(contained_extension) = contained_extension {
307                                if fastcgi_script_exts.contains(&(&contained_extension as &str)) {
308                                  execute_pathbuf = Some(temp_pathbuf);
309                                  execute_path_info = path_info;
310                                  break;
311                                }
312                              }
313                            }
314                          } else {
315                            break;
316                          }
317                        }
318                        Err(err) => match err.kind() {
319                          tokio::io::ErrorKind::NotADirectory => (),
320                          _ => break,
321                        },
322                      };
323                    }
324                  }
325                }
326              };
327              let data = (execute_pathbuf, execute_path_info);
328
329              let mut write_rwlock = self.path_cache.write().await;
330              write_rwlock.cleanup();
331              write_rwlock.insert(cache_key, data.clone());
332              drop(write_rwlock);
333              data
334            }
335          };
336
337          execute_pathbuf = execute_pathbuf_got;
338          execute_path_info = execute_path_info_got;
339        }
340      }
341
342      if let Some(execute_pathbuf) = execute_pathbuf {
343        if let Some(wwwroot_detected) = wwwroot_detected {
344          return execute_fastcgi_with_environment_variables(
345            request,
346            socket_data,
347            error_logger,
348            wwwroot_detected.as_path(),
349            execute_pathbuf,
350            execute_path_info,
351            config["serverAdministratorEmail"].as_str(),
352            fastcgi_to,
353          )
354          .await;
355        }
356      }
357
358      Ok(ResponseData::builder(request).build())
359    })
360    .await
361  }
362
363  async fn proxy_request_handler(
364    &mut self,
365    request: RequestData,
366    _config: &ServerConfig,
367    _socket_data: &SocketData,
368    _error_logger: &ErrorLogger,
369  ) -> Result<ResponseData, Box<dyn Error + Send + Sync>> {
370    Ok(ResponseData::builder(request).build())
371  }
372
373  async fn response_modifying_handler(
374    &mut self,
375    response: HyperResponse,
376  ) -> Result<HyperResponse, Box<dyn Error + Send + Sync>> {
377    Ok(response)
378  }
379
380  async fn proxy_response_modifying_handler(
381    &mut self,
382    response: HyperResponse,
383  ) -> Result<HyperResponse, Box<dyn Error + Send + Sync>> {
384    Ok(response)
385  }
386
387  async fn connect_proxy_request_handler(
388    &mut self,
389    _upgraded_request: HyperUpgraded,
390    _connect_address: &str,
391    _config: &ServerConfig,
392    _socket_data: &SocketData,
393    _error_logger: &ErrorLogger,
394  ) -> Result<(), Box<dyn Error + Send + Sync>> {
395    Ok(())
396  }
397
398  fn does_connect_proxy_requests(&mut self) -> bool {
399    false
400  }
401
402  async fn websocket_request_handler(
403    &mut self,
404    _websocket: HyperWebsocket,
405    _uri: &hyper::Uri,
406    _config: &ServerConfig,
407    _socket_data: &SocketData,
408    _error_logger: &ErrorLogger,
409  ) -> Result<(), Box<dyn Error + Send + Sync>> {
410    Ok(())
411  }
412
413  fn does_websocket_requests(&mut self, _config: &ServerConfig, _socket_data: &SocketData) -> bool {
414    false
415  }
416}
417
418#[allow(clippy::too_many_arguments)]
419async fn execute_fastcgi_with_environment_variables(
420  request: RequestData,
421  socket_data: &SocketData,
422  error_logger: &ErrorLogger,
423  wwwroot: &Path,
424  execute_pathbuf: PathBuf,
425  path_info: Option<String>,
426  server_administrator_email: Option<&str>,
427  fastcgi_to: &str,
428) -> Result<ResponseData, Box<dyn Error + Send + Sync>> {
429  let mut environment_variables: LinkedHashMap<String, String> = LinkedHashMap::new();
430
431  let hyper_request = request.get_hyper_request();
432  let original_request_uri = request.get_original_url().unwrap_or(hyper_request.uri());
433
434  if let Some(auth_user) = request.get_auth_user() {
435    if let Some(authorization) = hyper_request.headers().get(header::AUTHORIZATION) {
436      let authorization_value = String::from_utf8_lossy(authorization.as_bytes()).to_string();
437      let mut authorization_value_split = authorization_value.split(" ");
438      if let Some(authorization_type) = authorization_value_split.next() {
439        environment_variables.insert("AUTH_TYPE".to_string(), authorization_type.to_string());
440      }
441    }
442    environment_variables.insert("REMOTE_USER".to_string(), auth_user.to_string());
443  }
444
445  environment_variables.insert(
446    "QUERY_STRING".to_string(),
447    match hyper_request.uri().query() {
448      Some(query) => query.to_string(),
449      None => "".to_string(),
450    },
451  );
452
453  environment_variables.insert("SERVER_SOFTWARE".to_string(), SERVER_SOFTWARE.to_string());
454  environment_variables.insert(
455    "SERVER_PROTOCOL".to_string(),
456    match hyper_request.version() {
457      hyper::Version::HTTP_09 => "HTTP/0.9".to_string(),
458      hyper::Version::HTTP_10 => "HTTP/1.0".to_string(),
459      hyper::Version::HTTP_11 => "HTTP/1.1".to_string(),
460      hyper::Version::HTTP_2 => "HTTP/2.0".to_string(),
461      hyper::Version::HTTP_3 => "HTTP/3.0".to_string(),
462      _ => "HTTP/Unknown".to_string(),
463    },
464  );
465  environment_variables.insert(
466    "SERVER_PORT".to_string(),
467    socket_data.local_addr.port().to_string(),
468  );
469  environment_variables.insert(
470    "SERVER_ADDR".to_string(),
471    socket_data.local_addr.ip().to_canonical().to_string(),
472  );
473  if let Some(server_administrator_email) = server_administrator_email {
474    environment_variables.insert(
475      "SERVER_ADMIN".to_string(),
476      server_administrator_email.to_string(),
477    );
478  }
479  if let Some(host) = hyper_request.headers().get(header::HOST) {
480    environment_variables.insert(
481      "SERVER_NAME".to_string(),
482      String::from_utf8_lossy(host.as_bytes()).to_string(),
483    );
484  }
485
486  environment_variables.insert(
487    "DOCUMENT_ROOT".to_string(),
488    wwwroot.to_string_lossy().to_string(),
489  );
490  environment_variables.insert(
491    "PATH_INFO".to_string(),
492    match &path_info {
493      Some(path_info) => format!("/{}", path_info),
494      None => "".to_string(),
495    },
496  );
497  environment_variables.insert(
498    "PATH_TRANSLATED".to_string(),
499    match &path_info {
500      Some(path_info) => {
501        let mut path_translated = execute_pathbuf.clone();
502        path_translated.push(path_info);
503        path_translated.to_string_lossy().to_string()
504      }
505      None => "".to_string(),
506    },
507  );
508  environment_variables.insert(
509    "REQUEST_METHOD".to_string(),
510    hyper_request.method().to_string(),
511  );
512  environment_variables.insert("GATEWAY_INTERFACE".to_string(), "CGI/1.1".to_string());
513  environment_variables.insert(
514    "REQUEST_URI".to_string(),
515    format!(
516      "{}{}",
517      original_request_uri.path(),
518      match original_request_uri.query() {
519        Some(query) => format!("?{}", query),
520        None => String::from(""),
521      }
522    ),
523  );
524
525  environment_variables.insert(
526    "REMOTE_PORT".to_string(),
527    socket_data.remote_addr.port().to_string(),
528  );
529  environment_variables.insert(
530    "REMOTE_ADDR".to_string(),
531    socket_data.remote_addr.ip().to_canonical().to_string(),
532  );
533
534  environment_variables.insert(
535    "SCRIPT_FILENAME".to_string(),
536    execute_pathbuf.to_string_lossy().to_string(),
537  );
538  if let Ok(script_path) = execute_pathbuf.as_path().strip_prefix(wwwroot) {
539    environment_variables.insert(
540      "SCRIPT_NAME".to_string(),
541      format!(
542        "/{}",
543        match cfg!(windows) {
544          true => script_path.to_string_lossy().to_string().replace("\\", "/"),
545          false => script_path.to_string_lossy().to_string(),
546        }
547      ),
548    );
549  }
550
551  if socket_data.encrypted {
552    environment_variables.insert("HTTPS".to_string(), "ON".to_string());
553  }
554
555  let mut content_length_set = false;
556  for (header_name, header_value) in hyper_request.headers().iter() {
557    let env_header_name = match *header_name {
558      header::CONTENT_LENGTH => {
559        content_length_set = true;
560        "CONTENT_LENGTH".to_string()
561      }
562      header::CONTENT_TYPE => "CONTENT_TYPE".to_string(),
563      _ => {
564        let mut result = String::new();
565
566        result.push_str("HTTP_");
567
568        for c in header_name.as_str().to_uppercase().chars() {
569          if c.is_alphanumeric() {
570            result.push(c);
571          } else {
572            result.push('_');
573          }
574        }
575
576        result
577      }
578    };
579    if environment_variables.contains_key(&env_header_name) {
580      let value = environment_variables.get_mut(&env_header_name);
581      if let Some(value) = value {
582        if env_header_name == "HTTP_COOKIE" {
583          value.push_str("; ");
584        } else {
585          // See https://stackoverflow.com/a/1801191
586          value.push_str(", ");
587        }
588        value.push_str(String::from_utf8_lossy(header_value.as_bytes()).as_ref());
589      } else {
590        environment_variables.insert(
591          env_header_name,
592          String::from_utf8_lossy(header_value.as_bytes()).to_string(),
593        );
594      }
595    } else {
596      environment_variables.insert(
597        env_header_name,
598        String::from_utf8_lossy(header_value.as_bytes()).to_string(),
599      );
600    }
601  }
602
603  if !content_length_set {
604    environment_variables.insert("CONTENT_LENGTH".to_string(), "0".to_string());
605  }
606
607  let (hyper_request, _, _) = request.into_parts();
608
609  execute_fastcgi(
610    hyper_request,
611    error_logger,
612    fastcgi_to,
613    environment_variables,
614  )
615  .await
616}
617
618async fn execute_fastcgi(
619  hyper_request: HyperRequest,
620  error_logger: &ErrorLogger,
621  fastcgi_to: &str,
622  mut environment_variables: LinkedHashMap<String, String>,
623) -> Result<ResponseData, Box<dyn Error + Send + Sync>> {
624  let (_, body) = hyper_request.into_parts();
625
626  // Insert other environment variables
627  for (key, value) in env::vars_os() {
628    let key_string = key.to_string_lossy().to_string();
629    let value_string = value.to_string_lossy().to_string();
630    environment_variables
631      .entry(key_string)
632      .or_insert(value_string);
633  }
634
635  let fastcgi_to_fixed = if let Some(stripped) = fastcgi_to.strip_prefix("unix:///") {
636    // hyper::Uri fails to parse a string if there is an empty authority, so add an "ignore" authority to Unix socket URLs
637    &format!("unix://ignore/{}", stripped)
638  } else {
639    fastcgi_to
640  };
641
642  let fastcgi_to_url = fastcgi_to_fixed.parse::<hyper::Uri>()?;
643  let scheme_str = fastcgi_to_url.scheme_str();
644
645  let (socket_reader, mut socket_writer) = match scheme_str {
646    Some("tcp") => {
647      let host = match fastcgi_to_url.host() {
648        Some(host) => host,
649        None => Err(anyhow::anyhow!("The FastCGI URL doesn't include the host"))?,
650      };
651
652      let port = match fastcgi_to_url.port_u16() {
653        Some(port) => port,
654        None => Err(anyhow::anyhow!("The FastCGI URL doesn't include the port"))?,
655      };
656
657      let addr = format!("{}:{}", host, port);
658
659      match connect_tcp(&addr).await {
660        Ok(data) => data,
661        Err(err) => match err.kind() {
662          tokio::io::ErrorKind::ConnectionRefused
663          | tokio::io::ErrorKind::NotFound
664          | tokio::io::ErrorKind::HostUnreachable => {
665            error_logger
666              .log(&format!("Service unavailable: {}", err))
667              .await;
668            return Ok(
669              ResponseData::builder_without_request()
670                .status(StatusCode::SERVICE_UNAVAILABLE)
671                .build(),
672            );
673          }
674          _ => Err(err)?,
675        },
676      }
677    }
678    Some("unix") => {
679      let path = fastcgi_to_url.path();
680      match connect_unix(path).await {
681        Ok(data) => data,
682        Err(err) => match err.kind() {
683          tokio::io::ErrorKind::ConnectionRefused
684          | tokio::io::ErrorKind::NotFound
685          | tokio::io::ErrorKind::HostUnreachable => {
686            error_logger
687              .log(&format!("Service unavailable: {}", err))
688              .await;
689            return Ok(
690              ResponseData::builder_without_request()
691                .status(StatusCode::SERVICE_UNAVAILABLE)
692                .build(),
693            );
694          }
695          _ => Err(err)?,
696        },
697      }
698    }
699    _ => Err(anyhow::anyhow!(
700      "Only HTTP and HTTPS reverse proxy URLs are supported."
701    ))?,
702  };
703
704  // Construct and send BEGIN_REQUEST record
705  // Use the responder role and don't use keep-alive
706  let begin_request_packet = construct_fastcgi_record(1, 1, &[0, 1, 0, 0, 0, 0, 0, 0]);
707  socket_writer.write_all(&begin_request_packet).await?;
708
709  // Construct and send PARAMS records
710  let mut environment_variables_to_wrap = Vec::new();
711  for (key, value) in environment_variables.iter() {
712    let mut environment_variable =
713      construct_fastcgi_name_value_pair(key.as_bytes(), value.as_bytes());
714    environment_variables_to_wrap.append(&mut environment_variable);
715  }
716  if !environment_variables_to_wrap.is_empty() {
717    let mut offset = 0;
718    while offset < environment_variables_to_wrap.len() {
719      let chunk_size = std::cmp::min(65536, environment_variables_to_wrap.len() - offset);
720      let chunk = &environment_variables_to_wrap[offset..offset + chunk_size];
721
722      // Record type 4 means PARAMS
723      let params_packet = construct_fastcgi_record(4, 1, chunk);
724      socket_writer.write_all(&params_packet).await?;
725
726      offset += chunk_size;
727    }
728  }
729
730  let params_packet_terminating = construct_fastcgi_record(4, 1, &[]);
731  socket_writer.write_all(&params_packet_terminating).await?;
732
733  let cgi_stdin_reader = StreamReader::new(body.into_data_stream().map_err(std::io::Error::other));
734
735  // Emulated standard input, standard output, and standard error
736  type EitherStream = Either<Result<Bytes, std::io::Error>, Result<Bytes, std::io::Error>>;
737  let stdin = SinkWriter::new(FramedWrite::new(socket_writer, FcgiEncoder::new()));
738  let stdout_and_stderr = FramedRead::new(socket_reader, FcgiDecoder::new());
739  let (stdout_stream, stderr_stream) = stdout_and_stderr.split_by_map(|item| match item {
740    Ok(FcgiDecodedData::Stdout(bytes)) => EitherStream::Left(Ok(bytes)),
741    Ok(FcgiDecodedData::Stderr(bytes)) => EitherStream::Right(Ok(bytes)),
742    Err(err) => EitherStream::Left(Err(err)),
743  });
744  let stdout = StreamReader::new(stdout_stream);
745  let stderr = StreamReader::new(stderr_stream);
746
747  let mut cgi_response = CgiResponse::new(stdout);
748
749  let stdin_copy_future = Copier::with_zero_packet_writing(cgi_stdin_reader, stdin).copy();
750  let mut stdin_copy_future_pinned = Box::pin(stdin_copy_future);
751
752  let stderr_read_future = ReadToEndFuture::new(stderr);
753  let mut stderr_read_future_pinned = Box::pin(stderr_read_future);
754
755  let mut headers = [EMPTY_HEADER; 128];
756
757  let mut early_stdin_copied = false;
758
759  // Needed to wrap this in another scope to prevent errors with multiple mutable borrows.
760  {
761    let mut head_obtained = false;
762    let stdout_parse_future = cgi_response.get_head();
763    tokio::pin!(stdout_parse_future);
764
765    // Cannot use a loop with tokio::select, since stdin_copy_future_pinned being constantly ready will make the web server stop responding to HTTP requests
766    tokio::select! {
767      biased;
768
769      result = &mut stdin_copy_future_pinned => {
770        early_stdin_copied = true;
771        result?;
772      },
773      obtained_head = &mut stdout_parse_future => {
774        let obtained_head = obtained_head?;
775        if !obtained_head.is_empty() {
776          httparse::parse_headers(obtained_head, &mut headers)?;
777        }
778        head_obtained = true;
779      },
780      result = &mut stderr_read_future_pinned => {
781        let stderr_vec = result?;
782          let stderr_string = String::from_utf8_lossy(stderr_vec.as_slice()).to_string();
783          if !stderr_string.is_empty() {
784            error_logger
785              .log(&format!("There were CGI errors: {}", stderr_string))
786              .await;
787          }
788        return Ok(
789          ResponseData::builder_without_request()
790            .status(StatusCode::INTERNAL_SERVER_ERROR)
791            .build(),
792        );
793      },
794    }
795
796    if !head_obtained {
797      // Kept it same as in the tokio::select macro
798      tokio::select! {
799        biased;
800
801        result = &mut stderr_read_future_pinned => {
802          let stderr_vec = result?;
803            let stderr_string = String::from_utf8_lossy(stderr_vec.as_slice()).to_string();
804            if !stderr_string.is_empty() {
805              error_logger
806                .log(&format!("There were FastCGI errors: {}", stderr_string))
807                .await;
808            }
809          return Ok(
810            ResponseData::builder_without_request()
811              .status(StatusCode::INTERNAL_SERVER_ERROR)
812              .build(),
813          );
814        },
815        obtained_head = &mut stdout_parse_future => {
816          let obtained_head = obtained_head?;
817          if !obtained_head.is_empty() {
818            httparse::parse_headers(obtained_head, &mut headers)?;
819          }
820        }
821      }
822    }
823  }
824
825  let mut response_builder = Response::builder();
826  let mut status_code = 200;
827  for header in headers {
828    if header == EMPTY_HEADER {
829      break;
830    }
831    let mut is_status_header = false;
832    match &header.name.to_lowercase() as &str {
833      "location" => {
834        if !(300..=399).contains(&status_code) {
835          status_code = 302;
836        }
837      }
838      "status" => {
839        is_status_header = true;
840        let header_value_cow = String::from_utf8_lossy(header.value);
841        let mut split_status = header_value_cow.split(" ");
842        let first_part = split_status.next();
843        if let Some(first_part) = first_part {
844          if first_part.starts_with("HTTP/") {
845            let second_part = split_status.next();
846            if let Some(second_part) = second_part {
847              if let Ok(parsed_status_code) = second_part.parse::<u16>() {
848                status_code = parsed_status_code;
849              }
850            }
851          } else if let Ok(parsed_status_code) = first_part.parse::<u16>() {
852            status_code = parsed_status_code;
853          }
854        }
855      }
856      _ => (),
857    }
858    if !is_status_header {
859      response_builder = response_builder.header(header.name, header.value);
860    }
861  }
862
863  response_builder = response_builder.status(status_code);
864
865  let reader_stream = ReaderStream::new(cgi_response);
866  let stream_body = StreamBody::new(reader_stream.map_ok(Frame::data));
867  let boxed_body = stream_body.boxed();
868
869  let response = response_builder.body(boxed_body)?;
870
871  let error_logger = error_logger.clone();
872
873  Ok(
874    ResponseData::builder_without_request()
875      .response(response)
876      .parallel_fn(async move {
877        let mut stdin_copied = early_stdin_copied;
878
879        if !stdin_copied {
880          tokio::select! {
881            biased;
882
883            _ = &mut stdin_copy_future_pinned => {
884              stdin_copied = true;
885            },
886            result = &mut stderr_read_future_pinned => {
887              let stderr_vec = result.unwrap_or(vec![]);
888              let stderr_string = String::from_utf8_lossy(stderr_vec.as_slice()).to_string();
889              if !stderr_string.is_empty() {
890                error_logger
891                  .log(&format!("There were FastCGI errors: {}", stderr_string))
892                  .await;
893              }
894            },
895          }
896        }
897
898        if stdin_copied {
899          let stderr_vec = stderr_read_future_pinned.await.unwrap_or(vec![]);
900          let stderr_string = String::from_utf8_lossy(stderr_vec.as_slice()).to_string();
901          if !stderr_string.is_empty() {
902            error_logger
903              .log(&format!("There were FastCGI errors: {}", stderr_string))
904              .await;
905          }
906        } else {
907          stdin_copy_future_pinned.await.unwrap_or_default();
908        }
909      })
910      .build(),
911  )
912}
913
914async fn connect_tcp(
915  addr: &str,
916) -> Result<
917  (
918    Box<dyn AsyncRead + Send + Sync + Unpin>,
919    Box<dyn AsyncWrite + Send + Sync + Unpin>,
920  ),
921  tokio::io::Error,
922> {
923  let socket = TcpStream::connect(addr).await?;
924  socket.set_nodelay(true)?;
925
926  let (socket_reader_set, socket_writer_set) = tokio::io::split(socket);
927  Ok((Box::new(socket_reader_set), Box::new(socket_writer_set)))
928}
929
930#[allow(dead_code)]
931#[cfg(unix)]
932async fn connect_unix(
933  path: &str,
934) -> Result<
935  (
936    Box<dyn AsyncRead + Send + Sync + Unpin>,
937    Box<dyn AsyncWrite + Send + Sync + Unpin>,
938  ),
939  tokio::io::Error,
940> {
941  use tokio::net::UnixStream;
942
943  let socket = UnixStream::connect(path).await?;
944
945  let (socket_reader_set, socket_writer_set) = tokio::io::split(socket);
946  Ok((Box::new(socket_reader_set), Box::new(socket_writer_set)))
947}
948
949#[allow(dead_code)]
950#[cfg(not(unix))]
951async fn connect_unix(
952  _path: &str,
953) -> Result<
954  (
955    Box<dyn AsyncRead + Send + Sync + Unpin>,
956    Box<dyn AsyncWrite + Send + Sync + Unpin>,
957  ),
958  tokio::io::Error,
959> {
960  Err(tokio::io::Error::new(
961    tokio::io::ErrorKind::Unsupported,
962    "Unix sockets are not supports on non-Unix platforms.",
963  ))
964}