Line data Source code
1 : //! Manages the pool of connections between local_proxy and postgres.
2 : //!
3 : //! The pool is keyed by database and role_name, and can contain multiple connections
4 : //! shared between users.
5 : //!
6 : //! The pool manages the pg_session_jwt extension used for authorizing
7 : //! requests in the db.
8 : //!
9 : //! The first time a db/role pair is seen, local_proxy attempts to install the extension
10 : //! and grant usage to the role on the given schema.
11 :
12 : use std::collections::HashMap;
13 : use std::pin::pin;
14 : use std::sync::atomic::AtomicUsize;
15 : use std::sync::Arc;
16 : use std::task::{ready, Poll};
17 : use std::time::Duration;
18 :
19 : use futures::future::poll_fn;
20 : use futures::Future;
21 : use indexmap::IndexMap;
22 : use jose_jwk::jose_b64::base64ct::{Base64UrlUnpadded, Encoding};
23 : use p256::ecdsa::{Signature, SigningKey};
24 : use parking_lot::RwLock;
25 : use postgres_client::tls::NoTlsStream;
26 : use postgres_client::types::ToSql;
27 : use postgres_client::AsyncMessage;
28 : use serde_json::value::RawValue;
29 : use signature::Signer;
30 : use tokio::net::TcpStream;
31 : use tokio::time::Instant;
32 : use tokio_util::sync::CancellationToken;
33 : use tracing::{debug, error, info, info_span, warn, Instrument};
34 :
35 : use super::backend::HttpConnError;
36 : use super::conn_pool_lib::{
37 : Client, ClientDataEnum, ClientInnerCommon, ClientInnerExt, ConnInfo, DbUserConn,
38 : EndpointConnPool,
39 : };
40 : use crate::context::RequestContext;
41 : use crate::control_plane::messages::{ColdStartInfo, MetricsAuxInfo};
42 : use crate::metrics::Metrics;
43 :
44 : pub(crate) const EXT_NAME: &str = "pg_session_jwt";
45 : pub(crate) const EXT_VERSION: &str = "0.1.2";
46 : pub(crate) const EXT_SCHEMA: &str = "auth";
47 :
48 : #[derive(Clone)]
49 : pub(crate) struct ClientDataLocal {
50 : session: tokio::sync::watch::Sender<uuid::Uuid>,
51 : cancel: CancellationToken,
52 : key: SigningKey,
53 : jti: u64,
54 : }
55 :
56 : impl ClientDataLocal {
57 0 : pub fn session(&mut self) -> &mut tokio::sync::watch::Sender<uuid::Uuid> {
58 0 : &mut self.session
59 0 : }
60 :
61 0 : pub fn cancel(&mut self) {
62 0 : self.cancel.cancel();
63 0 : }
64 : }
65 :
66 : pub(crate) struct LocalConnPool<C: ClientInnerExt> {
67 : global_pool: Arc<RwLock<EndpointConnPool<C>>>,
68 :
69 : config: &'static crate::config::HttpConfig,
70 : }
71 :
72 : impl<C: ClientInnerExt> LocalConnPool<C> {
73 0 : pub(crate) fn new(config: &'static crate::config::HttpConfig) -> Arc<Self> {
74 0 : Arc::new(Self {
75 0 : global_pool: Arc::new(RwLock::new(EndpointConnPool::new(
76 0 : HashMap::new(),
77 0 : 0,
78 0 : config.pool_options.max_conns_per_endpoint,
79 0 : Arc::new(AtomicUsize::new(0)),
80 0 : config.pool_options.max_total_conns,
81 0 : String::from("local_pool"),
82 0 : ))),
83 0 : config,
84 0 : })
85 0 : }
86 :
87 0 : pub(crate) fn get_idle_timeout(&self) -> Duration {
88 0 : self.config.pool_options.idle_timeout
89 0 : }
90 :
91 0 : pub(crate) fn get(
92 0 : self: &Arc<Self>,
93 0 : ctx: &RequestContext,
94 0 : conn_info: &ConnInfo,
95 0 : ) -> Result<Option<Client<C>>, HttpConnError> {
96 0 : let client = self
97 0 : .global_pool
98 0 : .write()
99 0 : .get_conn_entry(conn_info.db_and_user())
100 0 : .map(|entry| entry.conn);
101 :
102 : // ok return cached connection if found and establish a new one otherwise
103 0 : if let Some(mut client) = client {
104 0 : if client.inner.is_closed() {
105 0 : info!("local_pool: cached connection '{conn_info}' is closed, opening a new one");
106 0 : return Ok(None);
107 0 : }
108 0 :
109 0 : tracing::Span::current()
110 0 : .record("conn_id", tracing::field::display(client.get_conn_id()));
111 0 : tracing::Span::current().record(
112 0 : "pid",
113 0 : tracing::field::display(client.inner.get_process_id()),
114 0 : );
115 0 : debug!(
116 0 : cold_start_info = ColdStartInfo::HttpPoolHit.as_str(),
117 0 : "local_pool: reusing connection '{conn_info}'"
118 : );
119 :
120 0 : match client.get_data() {
121 0 : ClientDataEnum::Local(data) => {
122 0 : data.session().send(ctx.session_id())?;
123 : }
124 :
125 0 : ClientDataEnum::Remote(data) => {
126 0 : data.session().send(ctx.session_id())?;
127 : }
128 0 : ClientDataEnum::Http(_) => (),
129 : }
130 :
131 0 : ctx.set_cold_start_info(ColdStartInfo::HttpPoolHit);
132 0 : ctx.success();
133 0 :
134 0 : return Ok(Some(Client::new(
135 0 : client,
136 0 : conn_info.clone(),
137 0 : Arc::downgrade(&self.global_pool),
138 0 : )));
139 0 : }
140 0 : Ok(None)
141 0 : }
142 :
143 0 : pub(crate) fn initialized(self: &Arc<Self>, conn_info: &ConnInfo) -> bool {
144 0 : if let Some(pool) = self.global_pool.read().get_pool(conn_info.db_and_user()) {
145 0 : return pool.is_initialized();
146 0 : }
147 0 : false
148 0 : }
149 :
150 0 : pub(crate) fn set_initialized(self: &Arc<Self>, conn_info: &ConnInfo) {
151 0 : if let Some(pool) = self
152 0 : .global_pool
153 0 : .write()
154 0 : .get_pool_mut(conn_info.db_and_user())
155 0 : {
156 0 : pool.set_initialized();
157 0 : }
158 0 : }
159 : }
160 :
161 : #[allow(clippy::too_many_arguments)]
162 0 : pub(crate) fn poll_client<C: ClientInnerExt>(
163 0 : global_pool: Arc<LocalConnPool<C>>,
164 0 : ctx: &RequestContext,
165 0 : conn_info: ConnInfo,
166 0 : client: C,
167 0 : mut connection: postgres_client::Connection<TcpStream, NoTlsStream>,
168 0 : key: SigningKey,
169 0 : conn_id: uuid::Uuid,
170 0 : aux: MetricsAuxInfo,
171 0 : ) -> Client<C> {
172 0 : let conn_gauge = Metrics::get().proxy.db_connections.guard(ctx.protocol());
173 0 : let mut session_id = ctx.session_id();
174 0 : let (tx, mut rx) = tokio::sync::watch::channel(session_id);
175 :
176 0 : let span = info_span!(parent: None, "connection", %conn_id);
177 0 : let cold_start_info = ctx.cold_start_info();
178 0 : span.in_scope(|| {
179 0 : info!(cold_start_info = cold_start_info.as_str(), %conn_info, %session_id, "new connection");
180 0 : });
181 0 : let pool = Arc::downgrade(&global_pool);
182 0 :
183 0 : let db_user = conn_info.db_and_user();
184 0 : let idle = global_pool.get_idle_timeout();
185 0 : let cancel = CancellationToken::new();
186 0 : let cancelled = cancel.clone().cancelled_owned();
187 0 :
188 0 : tokio::spawn(
189 0 : async move {
190 0 : let _conn_gauge = conn_gauge;
191 0 : let mut idle_timeout = pin!(tokio::time::sleep(idle));
192 0 : let mut cancelled = pin!(cancelled);
193 0 :
194 0 : poll_fn(move |cx| {
195 0 : if cancelled.as_mut().poll(cx).is_ready() {
196 0 : info!("connection dropped");
197 0 : return Poll::Ready(())
198 0 : }
199 0 :
200 0 : match rx.has_changed() {
201 : Ok(true) => {
202 0 : session_id = *rx.borrow_and_update();
203 0 : info!(%session_id, "changed session");
204 0 : idle_timeout.as_mut().reset(Instant::now() + idle);
205 : }
206 : Err(_) => {
207 0 : info!("connection dropped");
208 0 : return Poll::Ready(())
209 : }
210 0 : _ => {}
211 : }
212 :
213 : // 5 minute idle connection timeout
214 0 : if idle_timeout.as_mut().poll(cx).is_ready() {
215 0 : idle_timeout.as_mut().reset(Instant::now() + idle);
216 0 : info!("connection idle");
217 0 : if let Some(pool) = pool.clone().upgrade() {
218 : // remove client from pool - should close the connection if it's idle.
219 : // does nothing if the client is currently checked-out and in-use
220 0 : if pool.global_pool.write().remove_client(db_user.clone(), conn_id) {
221 0 : info!("idle connection removed");
222 0 : }
223 0 : }
224 0 : }
225 :
226 : loop {
227 0 : let message = ready!(connection.poll_message(cx));
228 :
229 0 : match message {
230 0 : Some(Ok(AsyncMessage::Notice(notice))) => {
231 0 : info!(%session_id, "notice: {}", notice);
232 : }
233 0 : Some(Ok(AsyncMessage::Notification(notif))) => {
234 0 : warn!(%session_id, pid = notif.process_id(), channel = notif.channel(), "notification received");
235 : }
236 : Some(Ok(_)) => {
237 0 : warn!(%session_id, "unknown message");
238 : }
239 0 : Some(Err(e)) => {
240 0 : error!(%session_id, "connection error: {}", e);
241 0 : break
242 : }
243 : None => {
244 0 : info!("connection closed");
245 0 : break
246 : }
247 : }
248 : }
249 :
250 : // remove from connection pool
251 0 : if let Some(pool) = pool.clone().upgrade() {
252 0 : if pool.global_pool.write().remove_client(db_user.clone(), conn_id) {
253 0 : info!("closed connection removed");
254 0 : }
255 0 : }
256 :
257 0 : Poll::Ready(())
258 0 : }).await;
259 :
260 0 : }
261 0 : .instrument(span));
262 0 :
263 0 : let inner = ClientInnerCommon {
264 0 : inner: client,
265 0 : aux,
266 0 : conn_id,
267 0 : data: ClientDataEnum::Local(ClientDataLocal {
268 0 : session: tx,
269 0 : cancel,
270 0 : key,
271 0 : jti: 0,
272 0 : }),
273 0 : };
274 0 :
275 0 : Client::new(inner, conn_info, Arc::downgrade(&global_pool.global_pool))
276 0 : }
277 :
278 : impl ClientInnerCommon<postgres_client::Client> {
279 0 : pub(crate) async fn set_jwt_session(&mut self, payload: &[u8]) -> Result<(), HttpConnError> {
280 0 : if let ClientDataEnum::Local(local_data) = &mut self.data {
281 0 : local_data.jti += 1;
282 0 : let token = resign_jwt(&local_data.key, payload, local_data.jti)?;
283 :
284 : // initiates the auth session
285 0 : self.inner.batch_execute("discard all").await?;
286 0 : self.inner
287 0 : .execute(
288 0 : "select auth.jwt_session_init($1)",
289 0 : &[&&*token as &(dyn ToSql + Sync)],
290 0 : )
291 0 : .await?;
292 :
293 0 : let pid = self.inner.get_process_id();
294 0 : info!(pid, jti = local_data.jti, "user session state init");
295 0 : Ok(())
296 : } else {
297 0 : panic!("unexpected client data type");
298 : }
299 0 : }
300 : }
301 :
302 : /// implements relatively efficient in-place json object key upserting
303 : ///
304 : /// only supports top-level keys
305 1 : fn upsert_json_object(
306 1 : payload: &[u8],
307 1 : key: &str,
308 1 : value: &RawValue,
309 1 : ) -> Result<String, serde_json::Error> {
310 1 : let mut payload = serde_json::from_slice::<IndexMap<&str, &RawValue>>(payload)?;
311 1 : payload.insert(key, value);
312 1 : serde_json::to_string(&payload)
313 1 : }
314 :
315 1 : fn resign_jwt(sk: &SigningKey, payload: &[u8], jti: u64) -> Result<String, HttpConnError> {
316 1 : let mut buffer = itoa::Buffer::new();
317 1 :
318 1 : // encode the jti integer to a json rawvalue
319 1 : let jti = serde_json::from_str::<&RawValue>(buffer.format(jti))
320 1 : .expect("itoa formatted integer should be guaranteed valid json");
321 :
322 : // update the jti in-place
323 1 : let payload =
324 1 : upsert_json_object(payload, "jti", jti).map_err(HttpConnError::JwtPayloadError)?;
325 :
326 : // sign the jwt
327 1 : let token = sign_jwt(sk, payload.as_bytes());
328 1 :
329 1 : Ok(token)
330 1 : }
331 :
332 1 : fn sign_jwt(sk: &SigningKey, payload: &[u8]) -> String {
333 1 : let header_len = 20;
334 1 : let payload_len = Base64UrlUnpadded::encoded_len(payload);
335 1 : let signature_len = Base64UrlUnpadded::encoded_len(&[0; 64]);
336 1 : let total_len = header_len + payload_len + signature_len + 2;
337 1 :
338 1 : let mut jwt = String::with_capacity(total_len);
339 1 : let cap = jwt.capacity();
340 1 :
341 1 : // we only need an empty header with the alg specified.
342 1 : // base64url(r#"{"alg":"ES256"}"#) == "eyJhbGciOiJFUzI1NiJ9"
343 1 : jwt.push_str("eyJhbGciOiJFUzI1NiJ9.");
344 1 :
345 1 : // encode the jwt payload in-place
346 1 : base64::encode_config_buf(payload, base64::URL_SAFE_NO_PAD, &mut jwt);
347 1 :
348 1 : // create the signature from the encoded header || payload
349 1 : let sig: Signature = sk.sign(jwt.as_bytes());
350 1 :
351 1 : jwt.push('.');
352 1 :
353 1 : // encode the jwt signature in-place
354 1 : base64::encode_config_buf(sig.to_bytes(), base64::URL_SAFE_NO_PAD, &mut jwt);
355 1 :
356 1 : debug_assert_eq!(
357 1 : jwt.len(),
358 : total_len,
359 0 : "the jwt len should match our expected len"
360 : );
361 1 : debug_assert_eq!(jwt.capacity(), cap, "the jwt capacity should not change");
362 :
363 1 : jwt
364 1 : }
365 :
366 : #[cfg(test)]
367 : #[expect(clippy::unwrap_used)]
368 : mod tests {
369 : use p256::ecdsa::SigningKey;
370 : use typed_json::json;
371 :
372 : use super::resign_jwt;
373 :
374 : #[test]
375 1 : fn jwt_token_snapshot() {
376 1 : let key = SigningKey::from_bytes(&[1; 32].into()).unwrap();
377 1 : let data =
378 1 : json!({"foo":"bar","jti":"foo\nbar","nested":{"jti":"tricky nesting"}}).to_string();
379 1 :
380 1 : let jwt = resign_jwt(&key, data.as_bytes(), 2).unwrap();
381 1 :
382 1 : // To validate the JWT, copy the JWT string and paste it into https://jwt.io/.
383 1 : // In the public-key box, paste the following jwk public key
384 1 : // `{"kty":"EC","crv":"P-256","x":"b_A7lJJBzh2t1DUZ5pYOCoW0GmmgXDKBA6orzhWUyhY","y":"PE91OlW_AdxT9sCwx-7ni0DG_30lqW4igrmJzvccFEo"}`
385 1 :
386 1 : // let pub_key = p256::ecdsa::VerifyingKey::from(&key);
387 1 : // let pub_key = p256::PublicKey::from(pub_key);
388 1 : // println!("{}", pub_key.to_jwk_string());
389 1 :
390 1 : assert_eq!(jwt, "eyJhbGciOiJFUzI1NiJ9.eyJmb28iOiJiYXIiLCJqdGkiOjIsIm5lc3RlZCI6eyJqdGkiOiJ0cmlja3kgbmVzdGluZyJ9fQ.pYf0LxoJ8sDgpmsYOgrbNecOSipnPBEGwnZzB-JhW2cONrKlqRsgXwK8_cOsyolGy-hTTe8GXbWTl_UdpF5RyA");
391 1 : }
392 : }
|
