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