Line data Source code
1 : //! Mock console backend which relies on a user-provided postgres instance.
2 :
3 : use std::str::FromStr;
4 : use std::sync::Arc;
5 :
6 : use futures::TryFutureExt;
7 : use thiserror::Error;
8 : use tokio_postgres::Client;
9 : use tracing::{error, info, info_span, warn, Instrument};
10 :
11 : use crate::auth::backend::jwt::AuthRule;
12 : use crate::auth::backend::ComputeUserInfo;
13 : use crate::auth::IpPattern;
14 : use crate::cache::Cached;
15 : use crate::context::RequestContext;
16 : use crate::control_plane::client::{CachedAllowedIps, CachedRoleSecret};
17 : use crate::control_plane::errors::{
18 : ControlPlaneError, GetAuthInfoError, GetEndpointJwksError, WakeComputeError,
19 : };
20 : use crate::control_plane::messages::MetricsAuxInfo;
21 : use crate::control_plane::{AuthInfo, AuthSecret, CachedNodeInfo, NodeInfo};
22 : use crate::error::io_error;
23 : use crate::intern::RoleNameInt;
24 : use crate::types::{BranchId, EndpointId, ProjectId, RoleName};
25 : use crate::url::ApiUrl;
26 : use crate::{compute, scram};
27 :
28 : #[derive(Debug, Error)]
29 : enum MockApiError {
30 : #[error("Failed to read password: {0}")]
31 : PasswordNotSet(tokio_postgres::Error),
32 : }
33 :
34 : impl From<MockApiError> for ControlPlaneError {
35 0 : fn from(e: MockApiError) -> Self {
36 0 : io_error(e).into()
37 0 : }
38 : }
39 :
40 : impl From<tokio_postgres::Error> for ControlPlaneError {
41 0 : fn from(e: tokio_postgres::Error) -> Self {
42 0 : io_error(e).into()
43 0 : }
44 : }
45 :
46 : #[derive(Clone)]
47 : pub struct MockControlPlane {
48 : endpoint: ApiUrl,
49 : ip_allowlist_check_enabled: bool,
50 : }
51 :
52 : impl MockControlPlane {
53 0 : pub fn new(endpoint: ApiUrl, ip_allowlist_check_enabled: bool) -> Self {
54 0 : Self {
55 0 : endpoint,
56 0 : ip_allowlist_check_enabled,
57 0 : }
58 0 : }
59 :
60 0 : pub(crate) fn url(&self) -> &str {
61 0 : self.endpoint.as_str()
62 0 : }
63 :
64 0 : async fn do_get_auth_info(
65 0 : &self,
66 0 : user_info: &ComputeUserInfo,
67 0 : ) -> Result<AuthInfo, GetAuthInfoError> {
68 0 : let (secret, allowed_ips) = async {
69 : // Perhaps we could persist this connection, but then we'd have to
70 : // write more code for reopening it if it got closed, which doesn't
71 : // seem worth it.
72 0 : let (client, connection) =
73 0 : tokio_postgres::connect(self.endpoint.as_str(), tokio_postgres::NoTls).await?;
74 :
75 0 : tokio::spawn(connection);
76 :
77 0 : let secret = if let Some(entry) = get_execute_postgres_query(
78 0 : &client,
79 0 : "select rolpassword from pg_catalog.pg_authid where rolname = $1",
80 0 : &[&&*user_info.user],
81 0 : "rolpassword",
82 0 : )
83 0 : .await?
84 : {
85 0 : info!("got a secret: {entry}"); // safe since it's not a prod scenario
86 0 : let secret = scram::ServerSecret::parse(&entry).map(AuthSecret::Scram);
87 0 : secret.or_else(|| parse_md5(&entry).map(AuthSecret::Md5))
88 : } else {
89 0 : warn!("user '{}' does not exist", user_info.user);
90 0 : None
91 : };
92 :
93 0 : let allowed_ips = if self.ip_allowlist_check_enabled {
94 0 : match get_execute_postgres_query(
95 0 : &client,
96 0 : "select allowed_ips from neon_control_plane.endpoints where endpoint_id = $1",
97 0 : &[&user_info.endpoint.as_str()],
98 0 : "allowed_ips",
99 0 : )
100 0 : .await?
101 : {
102 0 : Some(s) => {
103 0 : info!("got allowed_ips: {s}");
104 0 : s.split(',')
105 0 : .map(|s| {
106 0 : IpPattern::from_str(s).expect("mocked ip pattern should be correct")
107 0 : })
108 0 : .collect()
109 : }
110 0 : None => vec![],
111 : }
112 : } else {
113 0 : vec![]
114 : };
115 :
116 0 : Ok((secret, allowed_ips))
117 0 : }
118 0 : .inspect_err(|e: &GetAuthInfoError| tracing::error!("{e}"))
119 0 : .instrument(info_span!("postgres", url = self.endpoint.as_str()))
120 0 : .await?;
121 0 : Ok(AuthInfo {
122 0 : secret,
123 0 : allowed_ips,
124 0 : project_id: None,
125 0 : })
126 0 : }
127 :
128 0 : async fn do_get_endpoint_jwks(
129 0 : &self,
130 0 : endpoint: EndpointId,
131 0 : ) -> Result<Vec<AuthRule>, GetEndpointJwksError> {
132 0 : let (client, connection) =
133 0 : tokio_postgres::connect(self.endpoint.as_str(), tokio_postgres::NoTls).await?;
134 :
135 0 : let connection = tokio::spawn(connection);
136 :
137 0 : let res = client.query(
138 0 : "select id, jwks_url, audience, role_names from neon_control_plane.endpoint_jwks where endpoint_id = $1",
139 0 : &[&endpoint.as_str()],
140 0 : )
141 0 : .await?;
142 :
143 0 : let mut rows = vec![];
144 0 : for row in res {
145 0 : rows.push(AuthRule {
146 0 : id: row.get("id"),
147 0 : jwks_url: url::Url::parse(row.get("jwks_url"))?,
148 0 : audience: row.get("audience"),
149 0 : role_names: row
150 0 : .get::<_, Vec<String>>("role_names")
151 0 : .into_iter()
152 0 : .map(RoleName::from)
153 0 : .map(|s| RoleNameInt::from(&s))
154 0 : .collect(),
155 0 : });
156 0 : }
157 :
158 0 : drop(client);
159 0 : connection.await??;
160 :
161 0 : Ok(rows)
162 0 : }
163 :
164 0 : async fn do_wake_compute(&self) -> Result<NodeInfo, WakeComputeError> {
165 0 : let mut config = compute::ConnCfg::new(
166 0 : self.endpoint.host_str().unwrap_or("localhost").to_owned(),
167 0 : self.endpoint.port().unwrap_or(5432),
168 0 : );
169 0 : config.ssl_mode(postgres_client::config::SslMode::Disable);
170 0 :
171 0 : let node = NodeInfo {
172 0 : config,
173 0 : aux: MetricsAuxInfo {
174 0 : endpoint_id: (&EndpointId::from("endpoint")).into(),
175 0 : project_id: (&ProjectId::from("project")).into(),
176 0 : branch_id: (&BranchId::from("branch")).into(),
177 0 : cold_start_info: crate::control_plane::messages::ColdStartInfo::Warm,
178 0 : },
179 0 : };
180 0 :
181 0 : Ok(node)
182 0 : }
183 : }
184 :
185 0 : async fn get_execute_postgres_query(
186 0 : client: &Client,
187 0 : query: &str,
188 0 : params: &[&(dyn tokio_postgres::types::ToSql + Sync)],
189 0 : idx: &str,
190 0 : ) -> Result<Option<String>, GetAuthInfoError> {
191 0 : let rows = client.query(query, params).await?;
192 :
193 : // We can get at most one row, because `rolname` is unique.
194 0 : let Some(row) = rows.first() else {
195 : // This means that the user doesn't exist, so there can be no secret.
196 : // However, this is still a *valid* outcome which is very similar
197 : // to getting `404 Not found` from the Neon console.
198 0 : return Ok(None);
199 : };
200 :
201 0 : let entry = row.try_get(idx).map_err(MockApiError::PasswordNotSet)?;
202 0 : Ok(Some(entry))
203 0 : }
204 :
205 : impl super::ControlPlaneApi for MockControlPlane {
206 0 : #[tracing::instrument(skip_all)]
207 : async fn get_role_secret(
208 : &self,
209 : _ctx: &RequestContext,
210 : user_info: &ComputeUserInfo,
211 : ) -> Result<CachedRoleSecret, GetAuthInfoError> {
212 : Ok(CachedRoleSecret::new_uncached(
213 : self.do_get_auth_info(user_info).await?.secret,
214 : ))
215 : }
216 :
217 0 : async fn get_allowed_ips_and_secret(
218 0 : &self,
219 0 : _ctx: &RequestContext,
220 0 : user_info: &ComputeUserInfo,
221 0 : ) -> Result<(CachedAllowedIps, Option<CachedRoleSecret>), GetAuthInfoError> {
222 0 : Ok((
223 0 : Cached::new_uncached(Arc::new(
224 0 : self.do_get_auth_info(user_info).await?.allowed_ips,
225 : )),
226 0 : None,
227 : ))
228 0 : }
229 :
230 0 : async fn get_endpoint_jwks(
231 0 : &self,
232 0 : _ctx: &RequestContext,
233 0 : endpoint: EndpointId,
234 0 : ) -> Result<Vec<AuthRule>, GetEndpointJwksError> {
235 0 : self.do_get_endpoint_jwks(endpoint).await
236 0 : }
237 :
238 0 : #[tracing::instrument(skip_all)]
239 : async fn wake_compute(
240 : &self,
241 : _ctx: &RequestContext,
242 : _user_info: &ComputeUserInfo,
243 : ) -> Result<CachedNodeInfo, WakeComputeError> {
244 : self.do_wake_compute().map_ok(Cached::new_uncached).await
245 : }
246 : }
247 :
248 0 : fn parse_md5(input: &str) -> Option<[u8; 16]> {
249 0 : let text = input.strip_prefix("md5")?;
250 :
251 0 : let mut bytes = [0u8; 16];
252 0 : hex::decode_to_slice(text, &mut bytes).ok()?;
253 :
254 0 : Some(bytes)
255 0 : }
|
