feat(web): request a root authentication method after selecting a product

rust/agama-lib/share/profile.schema.json

@@ -382,11 +382,11 @@
           "examples": ["jane.doe"]
         },
         "password": {
-          "title": "User password (plain text or encrypted depending on the \"passwordEncrypted\" field)",
+          "title": "User password (plain text or encrypted depending on the \"encryptedPassword\" field)",
           "type": "string",
           "examples": ["nots3cr3t"]
         },
-        "passwordEncrypted": {
+        "encryptedPassword": {
           "title": "Flag for encrypted password (true) or plain text password (false or not defined)",
           "type": "boolean"
         }
@@ -399,10 +399,10 @@
       "additionalProperties": false,
       "properties": {
         "password": {
-          "title": "Root password (plain text or encrypted depending on the \"passwordEncrypted\" field)",
+          "title": "Root password (plain text or encrypted depending on the \"encryptedPassword\" field)",
           "type": "string"
         },
-        "passwordEncrypted": {
+        "encryptedPassword": {
           "title": "Flag for encrypted password (true) or plain text password (false or not defined)",
           "type": "boolean"
         },

rust/agama-lib/src/users/http_client.rs

@@ -66,7 +66,7 @@ impl UsersHTTPClient {
         let rps = RootPatchSettings {
             sshkey: None,
             password: Some(value.to_owned()),
-            password_encrypted: Some(encrypted),
+            encrypted_password: Some(encrypted),
         };
         let ret = self.client.patch("/users/root", &rps).await?;
         Ok(ret)
@@ -84,7 +84,7 @@ impl UsersHTTPClient {
         let rps = RootPatchSettings {
             sshkey: Some(value.to_owned()),
             password: None,
-            password_encrypted: None,
+            encrypted_password: None,
         };
         let ret = self.client.patch("/users/root", &rps).await?;
         Ok(ret)

rust/agama-lib/src/users/model.rs

@@ -36,5 +36,5 @@ pub struct RootPatchSettings {
     /// empty string here means remove password for root
     pub password: Option<String>,
     /// specify if patched password is provided in encrypted form
-    pub password_encrypted: Option<bool>,
+    pub encrypted_password: Option<bool>,
 }

rust/agama-lib/src/users/store.rs

@@ -194,14 +194,14 @@ mod test {
             when.method(PATCH)
                 .path("/api/users/root")
                 .header("content-type", "application/json")
-                .body(r#"{"sshkey":null,"password":"1234","passwordEncrypted":false}"#);
+                .body(r#"{"sshkey":null,"password":"1234","encryptedPassword":false}"#);
             then.status(200).body("0");
         });
         let root_mock2 = server.mock(|when, then| {
             when.method(PATCH)
                 .path("/api/users/root")
                 .header("content-type", "application/json")
-                .body(r#"{"sshkey":"keykeykey","password":null,"passwordEncrypted":null}"#);
+                .body(r#"{"sshkey":"keykeykey","password":null,"encryptedPassword":null}"#);
             then.status(200).body("0");
         });
         let url = server.url("/api");

rust/agama-server/src/users/web.rs

@@ -243,7 +243,7 @@ async fn patch_root(
         } else {
             state
                 .users
-                .set_root_password(&password, config.password_encrypted == Some(true))
+                .set_root_password(&password, config.encrypted_password == Some(true))
                 .await?
         }
     }

rust/package/agama.changes

@@ -1,3 +1,9 @@
+-------------------------------------------------------------------
+Sun Dec  1 21:53:21 UTC 2024 - David Diaz <[email protected]>
+
+- Rename flag to set password as encrypted
+  (gh#agama-project/agama#1787).
+
 -------------------------------------------------------------------
 Fri Nov 29 12:14:25 UTC 2024 - Imobach Gonzalez Sosa <[email protected]>
 

service/lib/agama/autoyast/root_reader.rb

@@ -41,7 +41,7 @@ def read
         return {} unless root_user
 
         hsh = { "password" => root_user.password.value.to_s }
-        hsh["passwordEncrypted"] = true if root_user.password.value.encrypted?
+        hsh["encryptedPassword"] = true if root_user.password.value.encrypted?
 
         public_key = root_user.authorized_keys.first
         hsh["sshPublicKey"] = public_key if public_key

service/lib/agama/autoyast/user_reader.rb

@@ -46,7 +46,7 @@ def read
           "password" => user.password.value.to_s
         }
 
-        hsh["passwordEncrypted"] = true if user.password.value.encrypted?
+        hsh["encryptedPassword"] = true if user.password.value.encrypted?
 
         { "user" => hsh }
       end

service/package/rubygem-agama-yast.changes

@@ -1,3 +1,9 @@
+-------------------------------------------------------------------
+Sun Dec  1 21:59:11 UTC 2024 - David Diaz <[email protected]>
+
+- Rename flag to set password as encrypted
+  (gh#agama-project/agama#1787).
+
 -------------------------------------------------------------------
 Fri Nov 15 16:48:44 UTC 2024 - Ladislav Slezák <[email protected]>
 

web/package/agama-web-ui.changes

@@ -1,3 +1,9 @@
+-------------------------------------------------------------------
+Thu Nov 28 14:34:49 UTC 2024 - David Diaz <[email protected]>
+
+- Request a root authentication method after selecting a product
+  (gh#agama-project#agama#1787).
+
 -------------------------------------------------------------------
 Tue Nov 26 09:30:09 UTC 2024 - Ladislav Slezák <[email protected]>
 

web/src/App.test.tsx

@@ -27,6 +27,7 @@ import App from "./App";
 import { InstallationPhase } from "./types/status";
 import { createClient } from "~/client";
 import { Product } from "./types/software";
+import { RootUser } from "./types/users";
 
 jest.mock("~/client");
 
@@ -45,6 +46,7 @@ const microos: Product = { id: "Leap Micro", name: "openSUSE Micro" };
 // list of available products
 let mockProducts: Product[];
 let mockSelectedProduct: Product;
+let mockRootUser: RootUser;
 
 jest.mock("~/queries/software", () => ({
   ...jest.requireActual("~/queries/software"),
@@ -65,14 +67,19 @@ jest.mock("~/queries/l10n", () => ({
 jest.mock("~/queries/issues", () => ({
   ...jest.requireActual("~/queries/issues"),
   useIssuesChanges: () => jest.fn(),
-  useAllIssues: () => ({ isEmtpy: true }),
+  useAllIssues: () => ({ isEmpty: true }),
 }));
 
 jest.mock("~/queries/storage", () => ({
   ...jest.requireActual("~/queries/storage"),
   useDeprecatedChanges: () => jest.fn(),
 }));
 
+jest.mock("~/queries/users", () => ({
+  ...jest.requireActual("~/queries/storage"),
+  useRootUser: () => mockRootUser,
+}));
+
 const mockClientStatus = {
   phase: InstallationPhase.Startup,
   isBusy: true,
@@ -104,6 +111,7 @@ describe("App", () => {
     });
 
     mockProducts = [tumbleweed, microos];
+    mockRootUser = { password: true, encryptedPassword: false, sshkey: "FAKE-SSH-KEY" };
   });
 
   afterEach(() => {
@@ -156,14 +164,47 @@ describe("App", () => {
         mockClientStatus.isBusy = false;
       });
 
-      it("renders the application content", async () => {
-        installerRender(<App />, { withL10n: true });
-        await screen.findByText(/Outlet Content/);
+      describe("when there are no authentication method for root user", () => {
+        beforeEach(() => {
+          mockRootUser = { password: false, encryptedPassword: false, sshkey: "" };
+        });
+
+        it("redirects to root user edition", async () => {
+          installerRender(<App />, { withL10n: true });
+          await screen.findByText("Navigating to /users/root/edit");
+        });
+      });
+
+      describe("when only root password is set", () => {
+        beforeEach(() => {
+          mockRootUser = { password: true, encryptedPassword: false, sshkey: "" };
+        });
+        it("renders the application content", async () => {
+          installerRender(<App />, { withL10n: true });
+          await screen.findByText(/Outlet Content/);
+        });
+      });
+
+      describe("when only root SSH public key is set", () => {
+        beforeEach(() => {
+          mockRootUser = { password: false, encryptedPassword: false, sshkey: "FAKE-SSH-KEY" };
+        });
+        it("renders the application content", async () => {
+          installerRender(<App />, { withL10n: true });
+          await screen.findByText(/Outlet Content/);
+        });
+      });
+
+      describe("when root password and SSH public key are set", () => {
+        it("renders the application content", async () => {
+          installerRender(<App />, { withL10n: true });
+          await screen.findByText(/Outlet Content/);
+        });
       });
     });
   });
 
-  describe("on the busy installaiton phase", () => {
+  describe("on the busy installation phase", () => {
     beforeEach(() => {
       mockClientStatus.phase = InstallationPhase.Install;
       mockClientStatus.isBusy = true;
@@ -176,7 +217,7 @@ describe("App", () => {
     });
   });
 
-  describe("on the idle installaiton phase", () => {
+  describe("on the idle installation phase", () => {
     beforeEach(() => {
       mockClientStatus.phase = InstallationPhase.Install;
       mockClientStatus.isBusy = false;

web/src/App.tsx

@@ -32,8 +32,10 @@ import { useL10nConfigChanges } from "~/queries/l10n";
 import { useIssuesChanges } from "~/queries/issues";
 import { useInstallerStatus, useInstallerStatusChanges } from "~/queries/status";
 import { useDeprecatedChanges } from "~/queries/storage";
-import { ROOT, PRODUCT } from "~/routes/paths";
+import { useRootUser } from "~/queries/users";
+import { ROOT, PRODUCT, USER } from "~/routes/paths";
 import { InstallationPhase } from "~/types/status";
+import { isEmpty } from "~/utils";
 
 /**
  * Main application component.
@@ -44,6 +46,7 @@ function App() {
   const { connected, error } = useInstallerClientStatus();
   const { selectedProduct, products } = useProduct();
   const { language } = useInstallerL10n();
+  const { password: isRootPasswordDefined, sshkey: rootSSHKey } = useRootUser();
   useL10nConfigChanges();
   useProductChanges();
   useIssuesChanges();
@@ -84,6 +87,16 @@ function App() {
       return <Navigate to={PRODUCT.progress} />;
     }
 
+    if (
+      phase === InstallationPhase.Config &&
+      !isBusy &&
+      !isRootPasswordDefined &&
+      isEmpty(rootSSHKey) &&
+      location.pathname !== USER.rootUser.edit
+    ) {
+      return <Navigate to={USER.rootUser.edit} state={{ from: location.pathname }} />;
+    }
+
     return <Outlet />;
   };
 

web/src/assets/styles/app.scss

@@ -97,3 +97,9 @@ button.remove-link:hover {
     --pf-v5-c-notification-drawer__list-item--before--BackgroundColor: none;
   }
 }
+
+form#rootAuthMethods {
+  .pf-v5-c-file-upload__file-select {
+    display: none;
+  }
+}

web/src/components/core/InstallButton.test.tsx

@@ -25,7 +25,7 @@ import { screen, waitFor, within } from "@testing-library/react";
 import { installerRender, mockRoutes } from "~/test-utils";
 import { InstallButton } from "~/components/core";
 import { IssuesList } from "~/types/issues";
-import { PRODUCT, ROOT } from "~/routes/paths";
+import { PRODUCT, ROOT, USER } from "~/routes/paths";
 
 const mockStartInstallationFn = jest.fn();
 let mockIssuesList: IssuesList;
@@ -116,6 +116,7 @@ describe("InstallButton", () => {
       ["product selection progress", PRODUCT.progress],
       ["installation progress", ROOT.installationProgress],
       ["installation finished", ROOT.installationFinished],
+      ["root authentication", USER.rootUser.edit],
     ])(`but the installer is rendering the %s screen`, (_, path) => {
       beforeEach(() => {
         mockRoutes(path);

web/src/components/core/InstallButton.tsx

@@ -26,23 +26,25 @@ import { Popup } from "~/components/core";
 import { startInstallation } from "~/api/manager";
 import { useAllIssues } from "~/queries/issues";
 import { useLocation } from "react-router-dom";
-import { PRODUCT, ROOT } from "~/routes/paths";
+import { PRODUCT, ROOT, USER } from "~/routes/paths";
 import { _ } from "~/i18n";
 import { Icon } from "../layout";
 
 /**
  * List of paths where the InstallButton must not be shown.
  *
  * Apart from obvious login and installation paths, it does not make sense to
- * show the button neither, when the user is about to change the product nor
- * when the installer is setting the chosen product.
+ * show the button neither, when the user is about to change the product,
+ * defining the root authentication for the fisrt time, nor when the installer
+ * is setting the chosen product.
  * */
 const EXCLUDED_FROM = [
   ROOT.login,
   PRODUCT.changeProduct,
   PRODUCT.progress,
   ROOT.installationProgress,
   ROOT.installationFinished,
+  USER.rootUser.edit,
 ];
 
 const InstallConfirmationPopup = ({ onAccept, onClose }) => {

web/src/components/core/Page.tsx

@@ -60,8 +60,8 @@ type SectionProps = {
   value?: React.ReactNode;
   /** Elements to be rendered in the section footer */
   actions?: React.ReactNode;
-  /** As short as possible yet as much as needed text for describing what the section is about, if needed */
-  description?: string;
+  /** A React node with a brief description of what the section is for */
+  description?: React.ReactNode;
   /** The heading level used for the section title */
   headerLevel?: TitleProps["headingLevel"];
   /** Props to influence PF/Card component wrapping the section */
@@ -106,7 +106,7 @@ const Header = ({ hasGutter = true, children, ...props }) => {
  *
  * @example <caption>Simple usage</caption>
  *   <Page.Section>
- *     <EncryptionSummmary
+ *     <EncryptionSummary />
  *   </Page.Section>
  *
  * @example <caption>Complex usage</caption>
@@ -137,7 +137,7 @@ const Section = ({
   const hasTitle = !isEmpty(title);
   const hasValue = !isEmpty(value);
   const hasDescription = !isEmpty(description);
-  const hasHeader = hasTitle || hasValue;
+  const hasHeader = hasTitle || hasValue || hasDescription;
   const hasAriaLabel =
     !isEmpty(ariaLabel) || (isObject(pfCardProps) && "aria-label" in pfCardProps);
   const props = { ...defaultCardProps, "aria-label": ariaLabel };
@@ -184,7 +184,7 @@ const Section = ({
  *
  * @example
  *   <Page.Actions>
- *     <Page.Action onCick={doSomething}>Let's go</Page.Action>
+ *     <Page.Action onClick={doSomething}>Let's go</Page.Action>
  *   </Page.Actions>
  *
  */
@@ -285,7 +285,7 @@ const Content = ({ children, ...pageSectionProps }: React.PropsWithChildren<Page
 );
 
 /**
- * Component for structuing an Agama page, built on top of PF/Page/PageGroup.
+ * Component for structuring an Agama page, built on top of PF/Page/PageGroup.
  *
  * @see [Patternfly Page/PageGroup](https://www.patternfly.org/components/page#pagegroup)
  *