From cfba96edeea25cd952707cbeedcb9e679a6b4154 Mon Sep 17 00:00:00 2001 From: Jordan Bancino Date: Tue, 7 Mar 2023 00:44:53 +0000 Subject: [PATCH] Prepare for v0.2.0 release. --- README.txt | 6 ++- TODO.txt | 22 ----------- man/man7/telodendria-changelog.7 | 63 +++++++++++++++++++------------- 3 files changed, 42 insertions(+), 49 deletions(-) diff --git a/README.txt b/README.txt index b18e168..1c61c26 100644 --- a/README.txt +++ b/README.txt @@ -27,7 +27,7 @@ | | __/ | (_) | (_| | __/ | | | (_| | | | | (_| | |_|\___|_|\___/ \__,_|\___|_| |_|\__,_|_| |_|\__,_| ======================================================= -Copyright (C) 2022 Jordan Bancino <@jordan:bancino.net> +Copyright (C) 2023 Jordan Bancino <@jordan:bancino.net> This is the source code for Telodendria, a Matrix homeserver written in C. All of the documentation is available as man pages in the @@ -42,10 +42,12 @@ repository. Telodendria/ contrib/ - Supplemental files, such as example configs. man/ - The official documentation as man pages. + proposals/ - Proposals for new features or fixes, as man pages. site/ - The official website. src/ - The C source code for Telodendria. include/ - Header files for the source code. - Routes/ - Where Matrix API endpoints are implemented + Routes/ - Where Matrix API endpoints are implemented. + Static/ - Endpoints that just generate static HTML pages. tests/ - Unit and integration tests will eventually go here. tools/ - Development environment and tools. diff --git a/TODO.txt b/TODO.txt index 2ee645c..5654603 100644 --- a/TODO.txt +++ b/TODO.txt @@ -8,28 +8,6 @@ Key: [~] In Progress [!] Won't Fix -Milestone: v0.2.0 ------------------ - -[!] Abstract /email/requestToken and /msidsn/requestToken - - Call it RouteRequestToken - - Reference it all the places it's needed - - Finish implementing JSON parsing - -[x] User Interactive Authentication - [x] Fix UiaComplete so we can use multi-stage flows - -[x] User login - [x] Logout all - -[x] Documentation - [x] User functions - [x] Json functions - [x] Db functions - [x] Uia (move docs from Matrix) - -[x] Convert proposals to man pages - Milestone: v0.3.0 ----------------- diff --git a/man/man7/telodendria-changelog.7 b/man/man7/telodendria-changelog.7 index 0e4ba4b..bc02ad0 100644 --- a/man/man7/telodendria-changelog.7 +++ b/man/man7/telodendria-changelog.7 @@ -1,4 +1,4 @@ -.Dd $Mdocdate: January 17 2023 $ +.Dd $Mdocdate: March 7 2023 $ .Dt TELODENDRIA-CHANGELOG 7 .Os Telodendria Project .Sh NAME @@ -49,31 +49,16 @@ used to authenticate requests. .It Added the basic form of the user interactive authentication API, which can be used by any endpoints that the spec says require -it. Currently, it only implements a single dummy login flow, -so it's more of a formality than anything else, but more login -flows can easily be added in the future. +it. Currently, it only implements the dummy and password stages, +but more stages, such as the registration token stage, will be +added in future releases. .It Added a simple landing page that allows those setting up .Nm to quickly verify that it is accessible where it needs to be. .It -Added a way to safely delete objects from the database. -While the database is for persistent storage, there may -be some ephemeral data that lives there only for a short -while, so it will be necessary to remove that data when -necessary. -.It -Added a thread-safe random string generator, which will -be used extensively for generating session tokens, device -IDs, access tokens, and more. This generator is seeded by -the current timestamp and the thread ID, so it should be -fairly random. -.It -Added a SHA-256 hash function, which at present is used -to hash passwords. -.It -Added a basic job scheduler to execute periodic jobs, such -as expiring tokens and cleaning up temporary files. +Added the static login page for clients that don't support +regular login. .El .Pp Changes: @@ -125,7 +110,7 @@ Fixed a memory leak that would occur when deleting database objects. .It Fixed a few non-fatal memory warnings that would show up -as a result of passing a constant string into certain APIs. +as a result of passing a constant string into certain functions. .El .Pp Misc: @@ -157,9 +142,37 @@ as possible to allowe debugging the configuration file parsing if necessary. .El .Pp -And many more small bug fixes and feature additions. Please -test the current functionality, and report bugs to the Matrix -rooms. +\&... And many more bug fixes and feature additions! Too much +has changed to make a comprehensive change log. A lot of things +have been done under the hood to make +.Nm +easier to develop in the future. Please test the current +functionality, and report bugs to the Matrix rooms. +.Pp +The following platforms have been known to compile and run +.Nm : +.Bl -bullet +.It +OpenBSD +.It +Linux (GNU and non-GNU) +.It +Windows (via Cygwin) +.It +FreeBSD +.It +NetBSD +.It +DragonFlyBSD +.It +Haiku OS +.It +Android (via Termux) +.El +.Pp +.Nm +is about being portable; if you compile it on an obscure +operating system, do let me know about it! .Sh v0.1.0 .Pp Tuesday, December 13, 2022