Add headers Client-Name and Client-Version

bitwarden_license/bitwarden-sm/src/client_secrets.rs

@@ -138,6 +138,7 @@ mod tests {
             api_url: format!("http://{}/api", server.address()),
             user_agent: "Bitwarden Rust-SDK [TEST]".into(),
             device_type: DeviceType::SDK,
+            bitwarden_client_version: None,
         };
 
         (server, Client::new(Some(settings)))

crates/bitwarden-auth/src/send_access/client.rs

@@ -121,6 +121,7 @@ mod tests {
             api_url: format!("http://{}/api", mock_server.address()),
             user_agent: "Bitwarden Rust-SDK [TEST]".into(),
             device_type: DeviceType::SDK,
+            bitwarden_client_version: None,
         };
         let core_client = CoreClient::new(Some(settings));
         core_client.auth_new().send_access()

crates/bitwarden-core/src/client/client.rs

@@ -9,7 +9,7 @@ use super::internal::InternalClient;
 #[cfg(feature = "internal")]
 use crate::client::flags::Flags;
 use crate::client::{
-    client_settings::ClientSettings,
+    client_settings::{ClientName, ClientSettings},
     internal::{ApiConfigurations, ClientManagedTokens, SdkManagedTokens, Tokens},
 };
 
@@ -72,6 +72,22 @@ impl Client {
             HeaderValue::from_str(&(settings.device_type as u8).to_string())
                 .expect("All numbers are valid ASCII"),
         );
+
+        if let Some(client_type) = Into::<Option<ClientName>>::into(settings.device_type) {
+            headers.append(
+                "Bitwarden-Client-Name",
+                HeaderValue::from_str(&client_type.to_string())
+                    .expect("All ASCII strings are valid header values"),
+            );
+        }
+
+        if let Some(version) = &settings.bitwarden_client_version {
+            headers.append(
+                "Bitwarden-Client-Version",
+                HeaderValue::from_str(version).expect("Version should be a valid header value"),
+            );
+        }
+
         let client_builder = new_client_builder().default_headers(headers);
 
         let client = client_builder.build().expect("Build should not fail");

crates/bitwarden-core/src/client/client_settings.rs

@@ -1,3 +1,5 @@
+use std::fmt;
+
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
@@ -13,6 +15,7 @@ use serde::{Deserialize, Serialize};
 ///     api_url: "https://api.bitwarden.com".to_string(),
 ///     user_agent: "Bitwarden Rust-SDK".to_string(),
 ///     device_type: DeviceType::SDK,
+///     bitwarden_client_version: None,
 /// };
 /// let default = ClientSettings::default();
 /// ```
@@ -33,6 +36,8 @@ pub struct ClientSettings {
     pub user_agent: String,
     /// Device type to send to Bitwarden. Defaults to SDK
     pub device_type: DeviceType,
+    /// Bitwarden Client Version to send to Bitwarden.
+    pub bitwarden_client_version: Option<String>,
 }
 
 impl Default for ClientSettings {
@@ -42,6 +47,7 @@ impl Default for ClientSettings {
             api_url: "https://api.bitwarden.com".into(),
             user_agent: "Bitwarden Rust-SDK".into(),
             device_type: DeviceType::SDK,
+            bitwarden_client_version: None,
         }
     }
 }
@@ -81,4 +87,65 @@ pub enum DeviceType {
     WindowsCLI = 23,
     MacOsCLI = 24,
     LinuxCLI = 25,
+    DuckDuckGoBrowser = 26,
+}
+
+#[derive(Copy, Clone, Debug)]
+pub(crate) enum ClientName {
+    Web,
+    Browser,
+    Desktop,
+    Mobile,
+    Cli,
+}
+
+impl From<DeviceType> for Option<ClientName> {
+    fn from(device_type: DeviceType) -> Self {
+        match device_type {
+            DeviceType::Android | DeviceType::AndroidAmazon | DeviceType::iOS => {
+                Some(ClientName::Mobile)
+            }
+
+            DeviceType::ChromeBrowser
+            | DeviceType::FirefoxBrowser
+            | DeviceType::OperaBrowser
+            | DeviceType::EdgeBrowser
+            | DeviceType::IEBrowser
+            | DeviceType::SafariBrowser
+            | DeviceType::VivaldiBrowser
+            | DeviceType::DuckDuckGoBrowser
+            | DeviceType::UnknownBrowser => Some(ClientName::Web),
+
+            DeviceType::ChromeExtension
+            | DeviceType::FirefoxExtension
+            | DeviceType::OperaExtension
+            | DeviceType::EdgeExtension
+            | DeviceType::VivaldiExtension
+            | DeviceType::SafariExtension => Some(ClientName::Browser),
+
+            DeviceType::LinuxDesktop
+            | DeviceType::MacOsDesktop
+            | DeviceType::WindowsDesktop
+            | DeviceType::UWP => Some(ClientName::Desktop),
+
+            DeviceType::WindowsCLI | DeviceType::MacOsCLI | DeviceType::LinuxCLI => {
+                Some(ClientName::Cli)
+            }
+
+            DeviceType::SDK | DeviceType::Server => None,
+        }
+    }
+}
+
+impl fmt::Display for ClientName {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        let s = match self {
+            ClientName::Web => "web",
+            ClientName::Browser => "browser",
+            ClientName::Desktop => "desktop",
+            ClientName::Mobile => "mobile",
+            ClientName::Cli => "cli",
+        };
+        write!(f, "{}", s)
+    }
 }