Record the user agent and IP in the device code grant

Author: sandhose

crates/data-model/src/oauth2/device_code_grant.rs

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+use std::net::IpAddr;
+
 use chrono::{DateTime, Utc};
 use oauth2_types::scope::Scope;
 use serde::Serialize;
@@ -193,6 +195,12 @@ pub struct DeviceCodeGrant {
 
     /// The time at which this device code grant will expire.
     pub expires_at: DateTime<Utc>,
+
+    /// The IP address of the client which requested this device code grant.
+    pub ip_address: Option<IpAddr>,
+
+    /// The user agent used to request this device code grant.
+    pub user_agent: Option<String>,
 }
 
 impl std::ops::Deref for DeviceCodeGrant {

crates/handlers/src/activity_tracker/bound.rs

@@ -33,6 +33,12 @@ impl Bound {
         Self { tracker, ip }
     }
 
+    /// Get the IP address bound to this activity tracker.
+    #[must_use]
+    pub fn ip(&self) -> Option<IpAddr> {
+        self.ip
+    }
+
     /// Record activity in an OAuth 2.0 session.
     pub async fn record_oauth2_session(&self, clock: &dyn Clock, session: &Session) {
         self.tracker

crates/handlers/src/oauth2/device/authorize.rs

@@ -14,7 +14,7 @@
 
 use axum::{extract::State, response::IntoResponse, Json, TypedHeader};
 use chrono::Duration;
-use headers::{CacheControl, Pragma};
+use headers::{CacheControl, Pragma, UserAgent};
 use hyper::StatusCode;
 use mas_axum_utils::{
     client_authorization::{ClientAuthorization, CredentialsVerificationError},
@@ -32,7 +32,7 @@ use oauth2_types::{
 use rand::distributions::{Alphanumeric, DistString};
 use thiserror::Error;
 
-use crate::impl_from_error_for_route;
+use crate::{impl_from_error_for_route, BoundActivityTracker};
 
 #[derive(Debug, Error)]
 pub(crate) enum RouteError {
@@ -84,6 +84,8 @@ pub(crate) async fn post(
     mut rng: BoxRng,
     clock: BoxClock,
     mut repo: BoxRepository,
+    user_agent: Option<TypedHeader<UserAgent>>,
+    activity_tracker: BoundActivityTracker,
     State(url_builder): State<UrlBuilder>,
     State(http_client_factory): State<HttpClientFactory>,
     State(encrypter): State<Encrypter>,
@@ -123,6 +125,9 @@ pub(crate) async fn post(
 
     let expires_in = Duration::minutes(20);
 
+    let user_agent = user_agent.map(|ua| ua.0.to_string());
+    let ip_address = activity_tracker.ip();
+
     let device_code = Alphanumeric.sample_string(&mut rng, 32);
     let user_code = Alphanumeric.sample_string(&mut rng, 6).to_uppercase();
 
@@ -137,6 +142,8 @@ pub(crate) async fn post(
                 device_code,
                 user_code,
                 expires_in,
+                user_agent,
+                ip_address,
             },
         )
         .await?;

crates/storage-pg/.sqlx/query-6a72c38cb718ac09b61e0fadd9703e4b7a984c46185cceea4eceff4655f4e81f.json renamed to crates/storage-pg/.sqlx/query-9742df9a34fe64e294cae4fc4a18e261c03b2367adeaec8fd554ca6f52c2015e.json

@@ -72,5 +72,11 @@ CREATE TABLE "oauth2_device_code_grant" (
     -- The browser session ID that the user used to authenticate
     -- This means "fulfilled_at" or "rejected_at" has also been set
     "user_session_id" UUID
-        REFERENCES "user_sessions" ("user_session_id")
+        REFERENCES "user_sessions" ("user_session_id"),
+
+    -- The IP address of the user when they authenticated
+    "ip_address" INET,
+
+    -- The user agent of the user when they authenticated
+    "user_agent" TEXT
 );

crates/storage-pg/.sqlx/query-be25896189a30862a0aa0b6d1d6ba44278b98d4b8d027036e8871853f5d175c0.json renamed to crates/storage-pg/.sqlx/query-aabefb019c9195b0588882fef562472d6117ff68f8f37d02b7609c94aefdb5d6.json

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+use std::net::IpAddr;
+
 use async_trait::async_trait;
 use chrono::{DateTime, Utc};
 use mas_data_model::{BrowserSession, DeviceCodeGrant, DeviceCodeGrantState, Session};
@@ -54,6 +56,8 @@ struct OAuth2DeviceGrantLookup {
     exchanged_at: Option<DateTime<Utc>>,
     user_session_id: Option<Uuid>,
     oauth2_session_id: Option<Uuid>,
+    ip_address: Option<IpAddr>,
+    user_agent: Option<String>,
 }
 
 impl TryFrom<OAuth2DeviceGrantLookup> for DeviceCodeGrant {
@@ -73,6 +77,8 @@ impl TryFrom<OAuth2DeviceGrantLookup> for DeviceCodeGrant {
             exchanged_at,
             user_session_id,
             oauth2_session_id,
+            ip_address,
+            user_agent,
         }: OAuth2DeviceGrantLookup,
     ) -> Result<Self, Self::Error> {
         let id = Ulid::from(oauth2_device_code_grant_id);
@@ -133,6 +139,8 @@ impl TryFrom<OAuth2DeviceGrantLookup> for DeviceCodeGrant {
             device_code,
             created_at,
             expires_at,
+            ip_address,
+            user_agent,
         })
     }
 }
@@ -176,9 +184,11 @@ impl<'c> OAuth2DeviceCodeGrantRepository for PgOAuth2DeviceCodeGrantRepository<'
                     , user_code
                     , created_at
                     , expires_at
+                    , ip_address
+                    , user_agent
                     )
                 VALUES
-                    ($1, $2, $3, $4, $5, $6, $7)
+                    ($1, $2, $3, $4, $5, $6, $7, $8, $9)
             "#,
             Uuid::from(id),
             Uuid::from(client_id),
@@ -187,6 +197,8 @@ impl<'c> OAuth2DeviceCodeGrantRepository for PgOAuth2DeviceCodeGrantRepository<'
             &params.user_code,
             created_at,
             expires_at,
+            params.ip_address as Option<IpAddr>,
+            params.user_agent.as_deref(),
         )
         .traced()
         .execute(&mut *self.conn)
@@ -201,6 +213,8 @@ impl<'c> OAuth2DeviceCodeGrantRepository for PgOAuth2DeviceCodeGrantRepository<'
             device_code: params.device_code,
             created_at,
             expires_at,
+            ip_address: params.ip_address,
+            user_agent: params.user_agent,
         })
     }
 
@@ -229,6 +243,8 @@ impl<'c> OAuth2DeviceCodeGrantRepository for PgOAuth2DeviceCodeGrantRepository<'
                      , exchanged_at
                      , user_session_id
                      , oauth2_session_id
+                     , ip_address as "ip_address: IpAddr"
+                     , user_agent
                 FROM 
                     oauth2_device_code_grant
 
@@ -273,6 +289,8 @@ impl<'c> OAuth2DeviceCodeGrantRepository for PgOAuth2DeviceCodeGrantRepository<'
                      , exchanged_at
                      , user_session_id
                      , oauth2_session_id
+                     , ip_address as "ip_address: IpAddr"
+                     , user_agent
                 FROM 
                     oauth2_device_code_grant
 
@@ -317,6 +335,8 @@ impl<'c> OAuth2DeviceCodeGrantRepository for PgOAuth2DeviceCodeGrantRepository<'
                      , exchanged_at
                      , user_session_id
                      , oauth2_session_id
+                     , ip_address as "ip_address: IpAddr"
+                     , user_agent
                 FROM 
                     oauth2_device_code_grant
 

crates/storage-pg/.sqlx/query-61dc64c1980b5d1d2e2b52c8c55c91e1953595e413bedcec27eafbf87e42f1cd.json renamed to crates/storage-pg/.sqlx/query-f0977fee9b3919707e9aa20537d836d741acd5b2426218a2f9f9dab4fb8a2ad0.json

@@ -758,6 +758,8 @@ mod tests {
                     device_code: device_code.to_owned(),
                     user_code: user_code.to_owned(),
                     expires_in: Duration::minutes(5),
+                    ip_address: None,
+                    user_agent: None,
                 },
             )
             .await
@@ -861,6 +863,8 @@ mod tests {
                     device_code: "second_devicecode".to_owned(),
                     user_code: "second_usercode".to_owned(),
                     expires_in: Duration::minutes(5),
+                    ip_address: None,
+                    user_agent: None,
                 },
             )
             .await