knowless 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

package/NOTICE

@@ -0,0 +1,13 @@
+knowless
+Copyright 2026 hamr0
+
+This product includes software developed by hamr0
+(https://github.com/hamr0/knowless).
+
+Licensed under the Apache License, Version 2.0 (the "License").
+You may obtain a copy of the License at:
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+This NOTICE file is required by Section 4(d) of the License.
+Forks and derivative works MUST preserve this attribution.

package/README.md

@@ -0,0 +1,167 @@
+# knowless
+
+Small, opinionated, full-stack passwordless auth for Node.js services
+that don't need to email their users for anything but the sign-in link.
+
+```
+npm install knowless
+```
+
+> v0.1.0 | Node.js >= 20 | 2 deps (nodemailer, better-sqlite3) | Apache-2.0
+
+## What this is
+
+Magic-link auth + session cookie + nothing else. Six lines of
+operator code:
+
+```js
+import express from 'express';
+import { knowless } from 'knowless';
+
+const app = express();
+const auth = knowless({
+  secret: process.env.KNOWLESS_SECRET,   // 64-char hex (32 bytes)
+  baseUrl: 'https://app.example.com',
+  from: 'auth@app.example.com',
+});
+
+app.use(express.urlencoded({ extended: false }));
+app.get('/login',          auth.loginForm);
+app.post('/login',         auth.login);
+app.get('/auth/callback',  auth.callback);
+app.get('/verify',         auth.verify);
+app.post('/logout',        auth.logout);
+```
+
+That's the entire integration. Users hit `/login`, type their email,
+click the magic link in their inbox, and are logged in for 30 days
+via a signed session cookie.
+
+## Why this exists
+
+Most auth libraries (Auth0, Clerk, Magic, Firebase Auth) default to
+maximum identity collection: full email stored in plaintext, profile
+fields, recovery email, federation. Even nominally privacy-focused
+options store enough that a breach is materially harmful.
+
+`knowless` is the simpler answer that always worked: magic link in,
+session cookie out, nothing else stored. The library refuses, by API
+shape, to send anything but the sign-in link or store anything
+identifying.
+
+The thesis: most services have ten layers of auth tooling where they
+need two.
+
+## What it commits to
+
+- **Stores no plaintext email, ever.** Email is salted-hashed on the
+  way in (`HMAC-SHA256(secret, normalized_email)`) and discarded.
+- **Sends no email except the magic link.** Not a welcome message,
+  not a digest, not a notification. By API shape — there is no
+  `sendNotification()` method to be tempted by.
+- **Self-hostable end to end.** No vendor relationships. No
+  telemetry. No phone-home of any kind.
+- **Walks away at v1.0.0.** Maintenance mode after that.
+
+## What it deliberately doesn't do
+
+A short list (full table in [`docs/01-product/PRD.md`](docs/01-product/PRD.md) §14):
+
+- No remote SMTP / mail vendor support — localhost Postfix is the
+  only transport
+- No HTML email, no tracking pixels, no click-rewriting
+- No OAuth / OIDC / SAML — different audience
+- No 2FA / WebAuthn / TOTP — compose with a separate library if
+  needed
+- No admin UI for handles or sessions — `sqlite3 knowless.db` is
+  the admin UI
+- No customisable login form templates — the page is hardcoded;
+  fork or live with it
+- No telemetry, analytics, or error reporting
+
+## Two deployment shapes (one codebase)
+
+| Mode | Status | When |
+|---|---|---|
+| **Library mode** | v0.1.0 | Mount handlers in your existing Node app |
+| **Standalone server** (forward-auth) | v0.2.0 | Self-hosters gating Uptime Kuma / AdGuard / Pi-hole / Sonarr / etc. via Caddy or nginx |
+
+This release ships library mode. Standalone server (`bin/knowless-server`)
+follows in 0.2.0 — see [`docs/03-tasks/TASKS.md`](docs/03-tasks/TASKS.md)
+Phase 6 for scope.
+
+## Operator commitments
+
+By choosing knowless, you commit to:
+
+- Running your own server with **Postfix installed and configured**
+  for outbound-only mail (or another localhost MTA)
+- Setting up **SPF, DKIM, and PTR records** for your sending domain
+  (one-time DNS setup)
+- Verifying **outbound port 25** is open (some clouds block it)
+- A **null-route entry** in your MTA's `transport_maps` for the
+  configured `shamRecipient` (default `null@knowless.invalid`) — so
+  silent-miss sham mail is dropped, not delivered to NXDOMAIN
+- Accepting that this is the **only email** your service ever sends
+
+These are documented in `OPS.md` (forthcoming with 0.2.0). Until
+then, see `GUIDE.md` for the high-level path and the
+[Postfix outbound-only setup guide](https://www.postfix.org/STANDARD_CONFIGURATION_README.html#stand_alone)
+upstream.
+
+## Documentation
+
+- [`README.md`](README.md) (this file) — project pitch, six-line example
+- [`GUIDE.md`](GUIDE.md) — adopter walkthrough: who it's for, who it
+  isn't, how to integrate, configuration reference, FAQ
+- [`knowless.context.md`](knowless.context.md) — dense AI-agent
+  integration guide (tables, gotchas, public API at a glance)
+- [`docs/01-product/PRD.md`](docs/01-product/PRD.md) — product
+  requirements: scope, threat model, decisions log, NO-GO table
+- [`docs/02-design/SPEC.md`](docs/02-design/SPEC.md) — wire formats,
+  byte layouts, algorithms (reimplementation-grade)
+- [`docs/03-tasks/TASKS.md`](docs/03-tasks/TASKS.md) — implementation
+  task list and phase plan
+- [`CHANGELOG.md`](CHANGELOG.md) — version history
+
+## Threat model — what this defends and what it doesn't
+
+Honest version (full detail in [`docs/01-product/PRD.md`](docs/01-product/PRD.md) §12):
+
+**Defends well:** database-only leaks, plaintext email exfiltration,
+password reuse / credential stuffing, silent email enumeration
+(timing-equivalent within 1ms locally), email-bombing a target,
+naive bot traffic, account-creation spam, replay attacks, open
+redirects.
+
+**Defends partially:** HMAC-secret-only leak (allows targeted
+existence-checks but not session forgery), phishing (no password
+to type into a fake site, but a phished mailbox can still receive
+links).
+
+**Does NOT defend against:** sophisticated bots that bypass the
+honeypot, distributed floods from many IPs, full server compromise,
+compromised email accounts, social engineering, insider threat at
+the operator. Layer-2 defences (Cloudflare, fail2ban, reverse-proxy
+rate-limits) belong above the library; OPS.md will document the
+common patterns.
+
+## Sibling projects
+
+- [`addypin`](https://github.com/hamr0/addypin) — location sharing
+  with the same hermit philosophy
+- [`gitdone`](https://github.com/hamr0/gitdone) — verified email
+  actions via DKIM/SPF inbound
+
+## Contributing
+
+Issues and PRs welcome at <https://github.com/hamr0/knowless>.
+
+Per the v1.0.0 walk-away framing in PRD §6.3: feature requests after
+v1.0.0 ships will be deflected to the §14 NO-GO table or to sibling
+projects. The library being "done" is a feature.
+
+## License
+
+[Apache 2.0](LICENSE) with [`NOTICE`](NOTICE) preservation. Forks
+must keep the NOTICE file.