Move goals to a separate file.

Author: iinuwa

GOALS.md

@@ -0,0 +1,55 @@
+# Goals
+
+The goal of this repository is to define a spec for clients (apps, browsers,
+etc.) to retrieve user credentials in a uniform way across Linux desktop
+environments.
+
+Some high-level goals:
+
+- define an API to securely create and retrieve local credentials
+  (passwords, passkeys, security keys)
+- create and retrieve credentials on remote devices (e.g. via CTAP 2 BLE/hybrid
+  transports)
+- Provide a uniform interface for third-party credential providers
+  (password/passkey managers like GNOME Secrets, Bitwarden, Keepass, LastPass,
+  etc.) to hook into
+
+Some nice-to-haves:
+
+- Design a specification for a platform authenticator. I'm not sure whether this
+  needs to be specified, or whether it could be considered and implemented as a
+  first-party credential provider.
+- A security key manager (e.g., for setting security key client PIN)
+
+Some non-goals:
+
+- Fully integrate with any specific desktop environment. Each desktop
+  environment (GNOME, KDE, etc.) has its own UI and UX conventions, as well as
+  system configuration methods (e.g., GNOME Settings), which this API will need to integrate with.
+  Because of the variation, we intend to leave integration with these other
+  components to developers more familiar with each of the desktop environments.
+  For now, we are using bare GTK to build a UI for testing, but any UI
+  implementation in this repository is for reference purposes. If anyone is
+  willing to do some of this integration work, feel free to contact us!
+
+- Create a full-featured password manager. Features like Password syncing,
+  password generation, rotation, etc. is not part of this specficiation. Other
+  password manager projects should be able to use this to make their credentials
+  available to the user uniformly, though.
+
+- BSD support. While we'd love to help out all open desktop environments, we don't
+  know enough about any BSD to make it useful for them. Hopefully, the design
+  process is transparent enough that someone else could design something that
+  works for BSDs.
+
+## Current Work
+
+- April 2025: Added web extension for testing in Firefox.
+- March 2025: Integrated libwebauthn to support USB authenticators.
+- May 2024: Met with developers in GNOME and systemd to design internals for
+  securely storing device credentials.
+- Jan 2024: Defined the [scenarios](/doc/historical/scenarios.md) that we expect this
+  API to cover. We are working on extracting [API methods](/doc/api.md) required to
+  implement the interactions between the client, portal frontend, portal backend,
+  machine and mobile devices. Once that is done, I intend to convert the API into
+  a [portal spec](/doc/historical/design-doc.md), making it fit normal D-Bus/portal patterns.

README.md

@@ -68,57 +68,9 @@ There is also a demo web extension that can be used to test the service in Firef
 
 ## Goals
 
-The goal of this repository is to define a spec for clients (apps, browsers,
-etc.) to retrieve user credentials in a uniform way across Linux desktop
-environments.
-
-Some high-level goals:
-
-- define an API to securely create and retrieve local credentials
-  (passwords, passkeys, security keys)
-- create and retrieve credentials on remote devices (e.g. via CTAP 2 BLE/hybrid
-  transports)
-- Provide a uniform interface for third-party credential providers
-  (password/passkey managers like GNOME Secrets, Bitwarden, Keepass, LastPass,
-  etc.) to hook into
-
-Some nice-to-haves:
-
-- Design a specification for a platform authenticator. I'm not sure whether this
-  needs to be specified, or whether it could be considered and implemented as a
-  first-party credential provider.
-
-Some non-goals:
-
-- Fully integrate with any specific desktop environment. Each desktop
-  environment (GNOME, KDE, etc.) has its own UI and UX conventions, as well as
-  system configuration methods (e.g., GNOME Settings), which this API will need to integrate with.
-  Because of the variation, we intend to leave integration with these other
-  components to developers more familiar with each of the desktop environments.
-  For now, we are using bare GTK to build a UI for testing, but any UI
-  implementation in this repository is for reference purposes. If anyone is willing to do some of this integration work, feel free to contact us!
-
-- Create a full-featured password manager. Features like Password syncing,
-  password generation, rotation, etc. is not part of this specficiation. Other
-  password manager projects should be able to use this to make their credentials
-  available to the user uniformly, though.
-
-- BSD support. While we'd love to help out all open desktop environments, we don't
-  know enough about any BSD to make it useful for them. Hopefully, the design
-  process is transparent enough that someone else could design something that
-  works for BSDs.
-
-## Current Work
-
-- April 2025: Added web extension for testing in Firefox.
-- March 2025: Integrated libwebauthn to support USB authenticators.
-- May 2024: Met with developers in GNOME and systemd to design internals for
-  securely storing device credentials.
-- Jan 2024: Defined the [scenarios](doc/scenarios.md) that we expect this
-  API to cover. We are working on extracting [API methods](doc/api.md) required to
-  implement the interactions between the client, portal frontend, portal backend,
-  machine and mobile devices. Once that is done, I intend to convert the API into
-  a [portal spec](doc/design-doc.md), making it fit normal D-Bus/portal patterns.
+The primary goal of this project is to provide a spec and reference
+implementation of an API to mediate access to web credentials, initially local
+and remote FIDO2 authenticators. See [GOALS.md](/GOALS.md) for more information.
 
 ## Mockups