Line data Source code
1 : //! User credentials used in authentication.
2 :
3 : use std::collections::HashSet;
4 : use std::net::IpAddr;
5 : use std::str::FromStr;
6 :
7 : use itertools::Itertools;
8 : use pq_proto::StartupMessageParams;
9 : use thiserror::Error;
10 : use tracing::{debug, warn};
11 :
12 : use crate::auth::password_hack::parse_endpoint_param;
13 : use crate::context::RequestContext;
14 : use crate::error::{ReportableError, UserFacingError};
15 : use crate::metrics::{Metrics, SniKind};
16 : use crate::proxy::NeonOptions;
17 : use crate::serverless::SERVERLESS_DRIVER_SNI;
18 : use crate::types::{EndpointId, RoleName};
19 :
20 : #[derive(Debug, Error, PartialEq, Eq, Clone)]
21 : pub(crate) enum ComputeUserInfoParseError {
22 : #[error("Parameter '{0}' is missing in startup packet.")]
23 : MissingKey(&'static str),
24 :
25 : #[error(
26 : "Inconsistent project name inferred from \
27 : SNI ('{}') and project option ('{}').",
28 : .domain, .option,
29 : )]
30 : InconsistentProjectNames {
31 : domain: EndpointId,
32 : option: EndpointId,
33 : },
34 :
35 : #[error(
36 : "Common name inferred from SNI ('{}') is not known",
37 : .cn,
38 : )]
39 : UnknownCommonName { cn: String },
40 :
41 : #[error("Project name ('{0}') must contain only alphanumeric characters and hyphen.")]
42 : MalformedProjectName(EndpointId),
43 : }
44 :
45 : impl UserFacingError for ComputeUserInfoParseError {}
46 :
47 : impl ReportableError for ComputeUserInfoParseError {
48 0 : fn get_error_kind(&self) -> crate::error::ErrorKind {
49 0 : crate::error::ErrorKind::User
50 0 : }
51 : }
52 :
53 : /// Various client credentials which we use for authentication.
54 : /// Note that we don't store any kind of client key or password here.
55 : #[derive(Debug, Clone, PartialEq, Eq)]
56 : pub(crate) struct ComputeUserInfoMaybeEndpoint {
57 : pub(crate) user: RoleName,
58 : pub(crate) endpoint_id: Option<EndpointId>,
59 : pub(crate) options: NeonOptions,
60 : }
61 :
62 : impl ComputeUserInfoMaybeEndpoint {
63 : #[inline]
64 0 : pub(crate) fn endpoint(&self) -> Option<&str> {
65 0 : self.endpoint_id.as_deref()
66 0 : }
67 : }
68 :
69 27 : pub(crate) fn endpoint_sni(
70 27 : sni: &str,
71 27 : common_names: &HashSet<String>,
72 27 : ) -> Result<Option<EndpointId>, ComputeUserInfoParseError> {
73 27 : let Some((subdomain, common_name)) = sni.split_once('.') else {
74 0 : return Err(ComputeUserInfoParseError::UnknownCommonName { cn: sni.into() });
75 : };
76 27 : if !common_names.contains(common_name) {
77 1 : return Err(ComputeUserInfoParseError::UnknownCommonName {
78 1 : cn: common_name.into(),
79 1 : });
80 26 : }
81 26 : if subdomain == SERVERLESS_DRIVER_SNI {
82 0 : return Ok(None);
83 26 : }
84 26 : Ok(Some(EndpointId::from(subdomain)))
85 27 : }
86 :
87 : impl ComputeUserInfoMaybeEndpoint {
88 13 : pub(crate) fn parse(
89 13 : ctx: &RequestContext,
90 13 : params: &StartupMessageParams,
91 13 : sni: Option<&str>,
92 13 : common_names: Option<&HashSet<String>>,
93 13 : ) -> Result<Self, ComputeUserInfoParseError> {
94 13 : // Some parameters are stored in the startup message.
95 13 : let get_param = |key| {
96 13 : params
97 13 : .get(key)
98 13 : .ok_or(ComputeUserInfoParseError::MissingKey(key))
99 13 : };
100 13 : let user: RoleName = get_param("user")?.into();
101 13 :
102 13 : // Project name might be passed via PG's command-line options.
103 13 : let endpoint_option = params
104 13 : .options_raw()
105 13 : .and_then(|options| {
106 7 : // We support both `project` (deprecated) and `endpoint` options for backward compatibility.
107 7 : // However, if both are present, we don't exactly know which one to use.
108 7 : // Therefore we require that only one of them is present.
109 7 : options
110 7 : .filter_map(parse_endpoint_param)
111 7 : .at_most_one()
112 7 : .ok()?
113 13 : })
114 13 : .map(|name| name.into());
115 :
116 13 : let endpoint_from_domain = if let Some(sni_str) = sni {
117 7 : if let Some(cn) = common_names {
118 7 : endpoint_sni(sni_str, cn)?
119 : } else {
120 0 : None
121 : }
122 : } else {
123 6 : None
124 : };
125 :
126 12 : let endpoint = match (endpoint_option, endpoint_from_domain) {
127 : // Invariant: if we have both project name variants, they should match.
128 2 : (Some(option), Some(domain)) if option != domain => {
129 1 : Some(Err(ComputeUserInfoParseError::InconsistentProjectNames {
130 1 : domain,
131 1 : option,
132 1 : }))
133 : }
134 : // Invariant: project name may not contain certain characters.
135 11 : (a, b) => a.or(b).map(|name| {
136 7 : if project_name_valid(name.as_ref()) {
137 7 : Ok(name)
138 : } else {
139 0 : Err(ComputeUserInfoParseError::MalformedProjectName(name))
140 : }
141 11 : }),
142 : }
143 12 : .transpose()?;
144 :
145 11 : if let Some(ep) = &endpoint {
146 7 : ctx.set_endpoint_id(ep.clone());
147 7 : }
148 :
149 11 : let metrics = Metrics::get();
150 11 : debug!(%user, "credentials");
151 11 : if sni.is_some() {
152 5 : debug!("Connection with sni");
153 5 : metrics.proxy.accepted_connections_by_sni.inc(SniKind::Sni);
154 6 : } else if endpoint.is_some() {
155 2 : metrics
156 2 : .proxy
157 2 : .accepted_connections_by_sni
158 2 : .inc(SniKind::NoSni);
159 2 : debug!("Connection without sni");
160 : } else {
161 4 : metrics
162 4 : .proxy
163 4 : .accepted_connections_by_sni
164 4 : .inc(SniKind::PasswordHack);
165 4 : debug!("Connection with password hack");
166 : }
167 :
168 11 : let options = NeonOptions::parse_params(params);
169 11 :
170 11 : Ok(Self {
171 11 : user,
172 11 : endpoint_id: endpoint,
173 11 : options,
174 11 : })
175 13 : }
176 : }
177 :
178 10 : pub(crate) fn check_peer_addr_is_in_list(peer_addr: &IpAddr, ip_list: &[IpPattern]) -> bool {
179 10 : ip_list.is_empty() || ip_list.iter().any(|pattern| check_ip(peer_addr, pattern))
180 10 : }
181 :
182 : #[derive(Debug, Clone, Eq, PartialEq)]
183 : pub(crate) enum IpPattern {
184 : Subnet(ipnet::IpNet),
185 : Range(IpAddr, IpAddr),
186 : Single(IpAddr),
187 : None,
188 : }
189 :
190 : impl<'de> serde::de::Deserialize<'de> for IpPattern {
191 9 : fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
192 9 : where
193 9 : D: serde::Deserializer<'de>,
194 9 : {
195 : struct StrVisitor;
196 : impl serde::de::Visitor<'_> for StrVisitor {
197 : type Value = IpPattern;
198 :
199 0 : fn expecting(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
200 0 : write!(formatter, "comma separated list with ip address, ip address range, or ip address subnet mask")
201 0 : }
202 :
203 9 : fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
204 9 : where
205 9 : E: serde::de::Error,
206 9 : {
207 9 : Ok(parse_ip_pattern(v).unwrap_or_else(|e| {
208 1 : warn!("Cannot parse ip pattern {v}: {e}");
209 1 : IpPattern::None
210 9 : }))
211 9 : }
212 : }
213 9 : deserializer.deserialize_str(StrVisitor)
214 9 : }
215 : }
216 :
217 : impl FromStr for IpPattern {
218 : type Err = anyhow::Error;
219 :
220 6 : fn from_str(s: &str) -> Result<Self, Self::Err> {
221 6 : parse_ip_pattern(s)
222 6 : }
223 : }
224 :
225 23 : fn parse_ip_pattern(pattern: &str) -> anyhow::Result<IpPattern> {
226 23 : if pattern.contains('/') {
227 2 : let subnet: ipnet::IpNet = pattern.parse()?;
228 1 : return Ok(IpPattern::Subnet(subnet));
229 21 : }
230 21 : if let Some((start, end)) = pattern.split_once('-') {
231 3 : let start: IpAddr = start.parse()?;
232 2 : let end: IpAddr = end.parse()?;
233 1 : return Ok(IpPattern::Range(start, end));
234 18 : }
235 18 : let addr: IpAddr = pattern.parse()?;
236 15 : Ok(IpPattern::Single(addr))
237 23 : }
238 :
239 16 : fn check_ip(ip: &IpAddr, pattern: &IpPattern) -> bool {
240 16 : match pattern {
241 3 : IpPattern::Subnet(subnet) => subnet.contains(ip),
242 5 : IpPattern::Range(start, end) => start <= ip && ip <= end,
243 7 : IpPattern::Single(addr) => addr == ip,
244 1 : IpPattern::None => false,
245 : }
246 16 : }
247 :
248 7 : fn project_name_valid(name: &str) -> bool {
249 23 : name.chars().all(|c| c.is_alphanumeric() || c == '-')
250 7 : }
251 :
252 : #[cfg(test)]
253 : #[expect(clippy::unwrap_used)]
254 : mod tests {
255 : use serde_json::json;
256 : use ComputeUserInfoParseError::*;
257 :
258 : use super::*;
259 :
260 : #[test]
261 1 : fn parse_bare_minimum() -> anyhow::Result<()> {
262 1 : // According to postgresql, only `user` should be required.
263 1 : let options = StartupMessageParams::new([("user", "john_doe")]);
264 1 : let ctx = RequestContext::test();
265 1 : let user_info = ComputeUserInfoMaybeEndpoint::parse(&ctx, &options, None, None)?;
266 1 : assert_eq!(user_info.user, "john_doe");
267 1 : assert_eq!(user_info.endpoint_id, None);
268 :
269 1 : Ok(())
270 1 : }
271 :
272 : #[test]
273 1 : fn parse_excessive() -> anyhow::Result<()> {
274 1 : let options = StartupMessageParams::new([
275 1 : ("user", "john_doe"),
276 1 : ("database", "world"), // should be ignored
277 1 : ("foo", "bar"), // should be ignored
278 1 : ]);
279 1 : let ctx = RequestContext::test();
280 1 : let user_info = ComputeUserInfoMaybeEndpoint::parse(&ctx, &options, None, None)?;
281 1 : assert_eq!(user_info.user, "john_doe");
282 1 : assert_eq!(user_info.endpoint_id, None);
283 :
284 1 : Ok(())
285 1 : }
286 :
287 : #[test]
288 1 : fn parse_project_from_sni() -> anyhow::Result<()> {
289 1 : let options = StartupMessageParams::new([("user", "john_doe")]);
290 1 :
291 1 : let sni = Some("foo.localhost");
292 1 : let common_names = Some(["localhost".into()].into());
293 1 :
294 1 : let ctx = RequestContext::test();
295 1 : let user_info =
296 1 : ComputeUserInfoMaybeEndpoint::parse(&ctx, &options, sni, common_names.as_ref())?;
297 1 : assert_eq!(user_info.user, "john_doe");
298 1 : assert_eq!(user_info.endpoint_id.as_deref(), Some("foo"));
299 1 : assert_eq!(user_info.options.get_cache_key("foo"), "foo");
300 :
301 1 : Ok(())
302 1 : }
303 :
304 : #[test]
305 1 : fn parse_project_from_options() -> anyhow::Result<()> {
306 1 : let options = StartupMessageParams::new([
307 1 : ("user", "john_doe"),
308 1 : ("options", "-ckey=1 project=bar -c geqo=off"),
309 1 : ]);
310 1 :
311 1 : let ctx = RequestContext::test();
312 1 : let user_info = ComputeUserInfoMaybeEndpoint::parse(&ctx, &options, None, None)?;
313 1 : assert_eq!(user_info.user, "john_doe");
314 1 : assert_eq!(user_info.endpoint_id.as_deref(), Some("bar"));
315 :
316 1 : Ok(())
317 1 : }
318 :
319 : #[test]
320 1 : fn parse_endpoint_from_options() -> anyhow::Result<()> {
321 1 : let options = StartupMessageParams::new([
322 1 : ("user", "john_doe"),
323 1 : ("options", "-ckey=1 endpoint=bar -c geqo=off"),
324 1 : ]);
325 1 :
326 1 : let ctx = RequestContext::test();
327 1 : let user_info = ComputeUserInfoMaybeEndpoint::parse(&ctx, &options, None, None)?;
328 1 : assert_eq!(user_info.user, "john_doe");
329 1 : assert_eq!(user_info.endpoint_id.as_deref(), Some("bar"));
330 :
331 1 : Ok(())
332 1 : }
333 :
334 : #[test]
335 1 : fn parse_three_endpoints_from_options() -> anyhow::Result<()> {
336 1 : let options = StartupMessageParams::new([
337 1 : ("user", "john_doe"),
338 1 : (
339 1 : "options",
340 1 : "-ckey=1 endpoint=one endpoint=two endpoint=three -c geqo=off",
341 1 : ),
342 1 : ]);
343 1 :
344 1 : let ctx = RequestContext::test();
345 1 : let user_info = ComputeUserInfoMaybeEndpoint::parse(&ctx, &options, None, None)?;
346 1 : assert_eq!(user_info.user, "john_doe");
347 1 : assert!(user_info.endpoint_id.is_none());
348 :
349 1 : Ok(())
350 1 : }
351 :
352 : #[test]
353 1 : fn parse_when_endpoint_and_project_are_in_options() -> anyhow::Result<()> {
354 1 : let options = StartupMessageParams::new([
355 1 : ("user", "john_doe"),
356 1 : ("options", "-ckey=1 endpoint=bar project=foo -c geqo=off"),
357 1 : ]);
358 1 :
359 1 : let ctx = RequestContext::test();
360 1 : let user_info = ComputeUserInfoMaybeEndpoint::parse(&ctx, &options, None, None)?;
361 1 : assert_eq!(user_info.user, "john_doe");
362 1 : assert!(user_info.endpoint_id.is_none());
363 :
364 1 : Ok(())
365 1 : }
366 :
367 : #[test]
368 1 : fn parse_projects_identical() -> anyhow::Result<()> {
369 1 : let options = StartupMessageParams::new([("user", "john_doe"), ("options", "project=baz")]);
370 1 :
371 1 : let sni = Some("baz.localhost");
372 1 : let common_names = Some(["localhost".into()].into());
373 1 :
374 1 : let ctx = RequestContext::test();
375 1 : let user_info =
376 1 : ComputeUserInfoMaybeEndpoint::parse(&ctx, &options, sni, common_names.as_ref())?;
377 1 : assert_eq!(user_info.user, "john_doe");
378 1 : assert_eq!(user_info.endpoint_id.as_deref(), Some("baz"));
379 :
380 1 : Ok(())
381 1 : }
382 :
383 : #[test]
384 1 : fn parse_multi_common_names() -> anyhow::Result<()> {
385 1 : let options = StartupMessageParams::new([("user", "john_doe")]);
386 1 :
387 1 : let common_names = Some(["a.com".into(), "b.com".into()].into());
388 1 : let sni = Some("p1.a.com");
389 1 : let ctx = RequestContext::test();
390 1 : let user_info =
391 1 : ComputeUserInfoMaybeEndpoint::parse(&ctx, &options, sni, common_names.as_ref())?;
392 1 : assert_eq!(user_info.endpoint_id.as_deref(), Some("p1"));
393 :
394 1 : let common_names = Some(["a.com".into(), "b.com".into()].into());
395 1 : let sni = Some("p1.b.com");
396 1 : let ctx = RequestContext::test();
397 1 : let user_info =
398 1 : ComputeUserInfoMaybeEndpoint::parse(&ctx, &options, sni, common_names.as_ref())?;
399 1 : assert_eq!(user_info.endpoint_id.as_deref(), Some("p1"));
400 :
401 1 : Ok(())
402 1 : }
403 :
404 : #[test]
405 1 : fn parse_projects_different() {
406 1 : let options =
407 1 : StartupMessageParams::new([("user", "john_doe"), ("options", "project=first")]);
408 1 :
409 1 : let sni = Some("second.localhost");
410 1 : let common_names = Some(["localhost".into()].into());
411 1 :
412 1 : let ctx = RequestContext::test();
413 1 : let err = ComputeUserInfoMaybeEndpoint::parse(&ctx, &options, sni, common_names.as_ref())
414 1 : .expect_err("should fail");
415 1 : match err {
416 1 : InconsistentProjectNames { domain, option } => {
417 1 : assert_eq!(option, "first");
418 1 : assert_eq!(domain, "second");
419 : }
420 0 : _ => panic!("bad error: {err:?}"),
421 : }
422 1 : }
423 :
424 : #[test]
425 1 : fn parse_inconsistent_sni() {
426 1 : let options = StartupMessageParams::new([("user", "john_doe")]);
427 1 :
428 1 : let sni = Some("project.localhost");
429 1 : let common_names = Some(["example.com".into()].into());
430 1 :
431 1 : let ctx = RequestContext::test();
432 1 : let err = ComputeUserInfoMaybeEndpoint::parse(&ctx, &options, sni, common_names.as_ref())
433 1 : .expect_err("should fail");
434 1 : match err {
435 1 : UnknownCommonName { cn } => {
436 1 : assert_eq!(cn, "localhost");
437 : }
438 0 : _ => panic!("bad error: {err:?}"),
439 : }
440 1 : }
441 :
442 : #[test]
443 1 : fn parse_neon_options() -> anyhow::Result<()> {
444 1 : let options = StartupMessageParams::new([
445 1 : ("user", "john_doe"),
446 1 : ("options", "neon_lsn:0/2 neon_endpoint_type:read_write"),
447 1 : ]);
448 1 :
449 1 : let sni = Some("project.localhost");
450 1 : let common_names = Some(["localhost".into()].into());
451 1 : let ctx = RequestContext::test();
452 1 : let user_info =
453 1 : ComputeUserInfoMaybeEndpoint::parse(&ctx, &options, sni, common_names.as_ref())?;
454 1 : assert_eq!(user_info.endpoint_id.as_deref(), Some("project"));
455 1 : assert_eq!(
456 1 : user_info.options.get_cache_key("project"),
457 1 : "project endpoint_type:read_write lsn:0/2"
458 1 : );
459 :
460 1 : Ok(())
461 1 : }
462 :
463 : #[test]
464 1 : fn test_check_peer_addr_is_in_list() {
465 4 : fn check(v: serde_json::Value) -> bool {
466 4 : let peer_addr = IpAddr::from([127, 0, 0, 1]);
467 4 : let ip_list: Vec<IpPattern> = serde_json::from_value(v).unwrap();
468 4 : check_peer_addr_is_in_list(&peer_addr, &ip_list)
469 4 : }
470 :
471 1 : assert!(check(json!([])));
472 1 : assert!(check(json!(["127.0.0.1"])));
473 1 : assert!(!check(json!(["8.8.8.8"])));
474 : // If there is an incorrect address, it will be skipped.
475 1 : assert!(check(json!(["88.8.8", "127.0.0.1"])));
476 1 : }
477 : #[test]
478 1 : fn test_parse_ip_v4() -> anyhow::Result<()> {
479 1 : let peer_addr = IpAddr::from([127, 0, 0, 1]);
480 : // Ok
481 1 : assert_eq!(parse_ip_pattern("127.0.0.1")?, IpPattern::Single(peer_addr));
482 1 : assert_eq!(
483 1 : parse_ip_pattern("127.0.0.1/31")?,
484 1 : IpPattern::Subnet(ipnet::IpNet::new(peer_addr, 31)?)
485 : );
486 1 : assert_eq!(
487 1 : parse_ip_pattern("0.0.0.0-200.0.1.2")?,
488 1 : IpPattern::Range(IpAddr::from([0, 0, 0, 0]), IpAddr::from([200, 0, 1, 2]))
489 : );
490 :
491 : // Error
492 1 : assert!(parse_ip_pattern("300.0.1.2").is_err());
493 1 : assert!(parse_ip_pattern("30.1.2").is_err());
494 1 : assert!(parse_ip_pattern("127.0.0.1/33").is_err());
495 1 : assert!(parse_ip_pattern("127.0.0.1-127.0.3").is_err());
496 1 : assert!(parse_ip_pattern("1234.0.0.1-127.0.3.0").is_err());
497 1 : Ok(())
498 1 : }
499 :
500 : #[test]
501 1 : fn test_check_ipv4() -> anyhow::Result<()> {
502 1 : let peer_addr = IpAddr::from([127, 0, 0, 1]);
503 1 : let peer_addr_next = IpAddr::from([127, 0, 0, 2]);
504 1 : let peer_addr_prev = IpAddr::from([127, 0, 0, 0]);
505 1 : // Success
506 1 : assert!(check_ip(&peer_addr, &IpPattern::Single(peer_addr)));
507 1 : assert!(check_ip(
508 1 : &peer_addr,
509 1 : &IpPattern::Subnet(ipnet::IpNet::new(peer_addr_prev, 31)?)
510 : ));
511 1 : assert!(check_ip(
512 1 : &peer_addr,
513 1 : &IpPattern::Subnet(ipnet::IpNet::new(peer_addr_next, 30)?)
514 : ));
515 1 : assert!(check_ip(
516 1 : &peer_addr,
517 1 : &IpPattern::Range(IpAddr::from([0, 0, 0, 0]), IpAddr::from([200, 0, 1, 2]))
518 1 : ));
519 1 : assert!(check_ip(
520 1 : &peer_addr,
521 1 : &IpPattern::Range(peer_addr, peer_addr)
522 1 : ));
523 :
524 : // Not success
525 1 : assert!(!check_ip(&peer_addr, &IpPattern::Single(peer_addr_prev)));
526 1 : assert!(!check_ip(
527 1 : &peer_addr,
528 1 : &IpPattern::Subnet(ipnet::IpNet::new(peer_addr_next, 31)?)
529 : ));
530 1 : assert!(!check_ip(
531 1 : &peer_addr,
532 1 : &IpPattern::Range(IpAddr::from([0, 0, 0, 0]), peer_addr_prev)
533 1 : ));
534 1 : assert!(!check_ip(
535 1 : &peer_addr,
536 1 : &IpPattern::Range(peer_addr_next, IpAddr::from([128, 0, 0, 0]))
537 1 : ));
538 : // There is no check that for range start <= end. But it's fine as long as for all this cases the result is false.
539 1 : assert!(!check_ip(
540 1 : &peer_addr,
541 1 : &IpPattern::Range(peer_addr, peer_addr_prev)
542 1 : ));
543 1 : Ok(())
544 1 : }
545 :
546 : #[test]
547 1 : fn test_connection_blocker() {
548 3 : fn check(v: serde_json::Value) -> bool {
549 3 : let peer_addr = IpAddr::from([127, 0, 0, 1]);
550 3 : let ip_list: Vec<IpPattern> = serde_json::from_value(v).unwrap();
551 3 : check_peer_addr_is_in_list(&peer_addr, &ip_list)
552 3 : }
553 :
554 1 : assert!(check(json!([])));
555 1 : assert!(check(json!(["127.0.0.1"])));
556 1 : assert!(!check(json!(["255.255.255.255"])));
557 1 : }
558 : }
|
