rasler 0.1.0

package/LICENSE

@@ -0,0 +1,180 @@
+                                 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 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 transformations
+      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, as submitted to the 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 submitting the Work,
+      but excluding communication that is conspicuously marked or designated
+      in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      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 the combined work (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 any Works
+      constitute patent infringement, then any and all 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, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, 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 in addition 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 license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Derivative Works, and to permit persons to whom the Derivative Works
+      is furnished to do so, subject to the following conditions:
+
+   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 reproducing 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 exemplary 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 all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or 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 offer only conditions that are
+      consistent with the terms of this License, and may require that each
+      Contributor, on behalf of the Licensor, provides such warranty,
+      indemnity, or other obligations as set forth in this License.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Wes Biggs
+
+   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/README.md

@@ -0,0 +1,140 @@
+# RASLer
+
+RASLer is a HTTP server that implements [RASL](https://dasl.ing/rasl.html)'s `/.well-known/rasl/` endpoint, backed by content-addressed storage, [MASL](https://dasl.ing/masl.html) metadata support, and a full-featured operator API.
+
+## Features
+
+- **Storage** — content blobs are stored by CID on disk, backed by a SQLite database that enables capacity management and a pluggable eviction policy
+- **DASL & MASL CIDs** — content serving by simple DASL CIDs, or via MASL CIDs with path-based resolution for both single files and website bundles as per the proposed specification (see ["RASL Path Resolution via MASL"](RASL_MASL_PROPOSAL.md))
+- **Static roots** — serve files from local directories by CID without copying them into the blob store
+- **Mount points** - use human-friendly URLs with virtual hosts and MASL paths
+- **Operator API** — upload raw files or CARs, pin/unpin, and evict; manage mount points; status, etc.
+- **Server factory** — compose your own server including RASL functionality
+
+## Quick start
+
+```bash
+npm install
+cp .env.example .env
+# edit .env and set API_SECRET
+cp rasler.config.example.json rasler.config.json  # optional — configure static roots, mount points, CORS
+npm start
+# open http://localhost:3000/api-docs in a browser
+```
+
+From the API docs UI, you can:
+- Enter `API_SECRET` to authenticate
+- Upload one or more files (or CARs with MASL metadata, see [Utilities](#utilities) for help building) and record their MASL CIDs
+
+Once uploaded, you can access the files at `http://localhost:3000/.well-known/rasl/<cid>/`.
+
+## Slow start
+
+See [USE_CASES](USE_CASES.md) for an overview of common deployment patterns including virtual hosting and static roots.
+
+## Configuration
+
+### Environment variables (`.env`)
+
+| Variable | Required | Default | Description |
+|---|---|---|---|
+| `ORIGIN` | No | `http://localhost:<PORT>` | This node's public origin, protocol included (e.g. `https://node1.example.com`). Used in `Link: rel="duplicate"` headers. A bare hostname without protocol is accepted and defaults to `https://`. |
+| `API_SECRET` | Yes | — | Pre-shared secret to send as `x-rasl-operator-secret` header |
+| `PORT` | No | `3000` | HTTP listen port |
+| `DATA_DIR` | No | `./data` | Directory for the SQLite database and content blobs |
+| `TOTAL_CAPACITY` | No | `1G` | Storage budget (`200M`, `1G`, `2GB`, plain bytes) |
+| `OPERATOR_API_PATH_PREFIX` | No | — | Mount operator API under a path prefix (e.g. `/admin`) |
+| `SWAGGER_UI` | No | `true` | Set `false` to disable the interactive API docs at `<operator-api-path-prefix>/api-docs` |
+
+### `rasler.config.json`
+
+Static roots, mount points, and CORS origins are configured in an optional `rasler.config.json` file in the working directory. Copy `rasler.config.example.json` to get started.
+
+```json
+{
+  "staticRoots": [
+    { "path": "/var/www/assets", "watch": true, "ignore": ["**/*.log", ".DS_Store"] }
+  ],
+  "mountPoints": [
+    { "hostname": "example.com", "directory": "/var/www/html" },
+    { "hostname": "example.com", "prefix": "/docs", "directory": "/var/www/docs" }
+  ],
+  "operatorCorsOrigins": ["http://localhost:5173", "https://admin.example.com"]
+}
+```
+
+| Key | Description |
+|---|---|
+| `staticRoots` | Directories to serve as static RASL roots. String entries use defaults; object entries add `watch` (re-index on change) and `ignore` (glob patterns to skip). See [STATIC_ROOTS](STATIC_ROOTS.md). |
+| `staticMaxHistory` | Maximum pinned MASL versions per static root; older versions are unpinned for LRU eviction. Omit for unlimited. |
+| `mountPoints` | Virtual host mappings: `{ hostname, prefix?, directory }`. See [MOUNT_POINTS](MOUNT_POINTS.md). |
+| `operatorCorsOrigins` | Origins allowed to call the Operator API cross-origin. |
+
+**Implicit `./public` mount** — if a `./public` directory exists and no root-level mount point is configured for the origin domain, RASLer automatically serves it at the document root with `Link: rel="duplicate"` headers.
+
+## API
+
+### RASL retrieval (public)
+
+| Method | Path | Description |
+|---|---|---|
+| `GET` | `/.well-known/rasl/:cid` | Retrieve raw content by CID |
+| `HEAD` | `/.well-known/rasl/:cid` | Same as GET, no body |
+| `GET` | `/.well-known/rasl/:cid/*` | Retrieve content via MASL document CID; path suffix resolved against MASL resources |
+| `HEAD` | `/.well-known/rasl/:cid/*` | Same as GET, no body |
+
+### Operator API (requires `x-rasl-operator-secret` header)
+
+| Method | Path | Description |
+|---|---|---|
+| `GET` | `/status` | Show server status (including storage usage) |
+| `POST` | `/upload` | Upload files (multipart or CAR) |
+| `POST` | `/pin` | Pin CIDs |
+| `DELETE` | `/pin/:cid` | Unpin a CID |
+| `GET` | `/content` | List held content |
+| `GET` | `/content/:cid` | Get content metadata |
+| `DELETE` | `/content/:cid` | Evict a CID |
+| `GET` | `/static-roots` | List configured static roots and their current MASL CIDs |
+| `GET` | `/mount-points` | List all mount points (static and runtime) with their MASL CIDs |
+| `PUT` | `/mount-points/:hostname[/:prefix]` | Map a hostname (with optional path prefix) to a held bundle MASL CID (runtime, persisted) |
+| `DELETE` | `/mount-points/:hostname[/:prefix]` | Remove a runtime mount point mapping |
+
+The Operator API can be relocated via the `OPERATOR_API_PATH_PREFIX` environment option.
+
+Full request/response details are in `openapi.json` and can be viewed and used interactively if `SWAGGER_UI=true`.
+
+## Utilities
+
+The following utility script is included.
+
+```bash
+# Build a CAR file (with MASL bundle header) from a static website directory tree
+npm run get-in-the-car <input-dir> [output.car]
+```
+
+## Development
+
+Contributions are welcome! Please use GitHub Issues to discuss or propose improvements or file bugs.
+
+See [ARCHITECTURE](ARCHITECTURE.md) for a code walkthrough as well as details on using RASLer as a library.
+
+Pull requests that make changes to the API should include updated JSDoc and a freshly generated `openapi.json`.
+
+### Scripts
+
+```bash
+# Run the node
+npm start
+
+# Run tests (includes lint)
+npm test
+
+# Lint only
+npm run lint
+
+# Regenerate openapi.json from JSDoc in src/routes/operator.js
+npm run generate:openapi
+
+# Generate HTML docs from *.md files into ./public
+npm run generate:docs
+```