@lossless.org/objectstorage 11.0.0 → 11.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/.smartconfig.json +19 -1
  2. package/dist_rust/ruststorage_linux_amd64 +0 -0
  3. package/dist_rust/ruststorage_linux_amd64.tsrust-build.json +4 -4
  4. package/dist_rust/ruststorage_linux_amd64_musl +0 -0
  5. package/dist_rust/ruststorage_linux_amd64_musl.tsrust-build.json +4 -4
  6. package/dist_rust/ruststorage_linux_arm64 +0 -0
  7. package/dist_rust/ruststorage_linux_arm64.tsrust-build.json +4 -4
  8. package/dist_rust/ruststorage_linux_arm64_musl +0 -0
  9. package/dist_rust/ruststorage_linux_arm64_musl.tsrust-build.json +4 -4
  10. package/dist_rust/ruststorage_macos_amd64 +0 -0
  11. package/dist_rust/ruststorage_macos_amd64.tsrust-build.json +4 -4
  12. package/dist_rust/ruststorage_macos_arm64 +0 -0
  13. package/dist_rust/ruststorage_macos_arm64.tsrust-build.json +4 -4
  14. package/dist_ts/00_commitinfo_data.js +1 -1
  15. package/dist_ts/classes.dashboard.d.ts +49 -0
  16. package/dist_ts/classes.dashboard.js +234 -0
  17. package/dist_ts/dashboard.bundled.d.ts +4 -0
  18. package/dist_ts/dashboard.bundled.js +20 -0
  19. package/dist_ts/dashboard.interfaces.d.ts +132 -0
  20. package/dist_ts/dashboard.interfaces.js +2 -0
  21. package/dist_ts/dashboard.plugins.d.ts +5 -0
  22. package/dist_ts/dashboard.plugins.js +10 -0
  23. package/dist_ts/index.d.ts +94 -1
  24. package/dist_ts/index.js +63 -1
  25. package/package.json +11 -7
  26. package/readme.md +192 -9
  27. package/third-party-notices.md +20 -4
  28. package/third_party_licenses/borsh-1.8.1-license.txt +23 -0
  29. package/third_party_licenses/borsh-derive-1.8.1-apache-2.0.txt +201 -0
  30. package/third_party_licenses/cargo-dependencies.html +420 -0
  31. package/third_party_licenses/dyn-clone-1.0.20-license.txt +23 -0
  32. package/third_party_licenses/equivalent-1.0.3-license.txt +25 -0
  33. package/third_party_licenses/hashbrown-0.17.1-license.txt +25 -0
  34. package/third_party_licenses/indexmap-2.14.2-license.txt +25 -0
  35. package/third_party_licenses/inventory.json +310 -8
  36. package/third_party_licenses/proc-macro-crate-3.5.0-license.txt +23 -0
  37. package/third_party_licenses/ref-cast-1.0.27-license.txt +23 -0
  38. package/third_party_licenses/ref-cast-impl-1.0.27-license.txt +23 -0
  39. package/third_party_licenses/schemars-1.2.3-license.txt +21 -0
  40. package/third_party_licenses/syn-3.0.9-license.txt +23 -0
  41. package/third_party_licenses/toml_datetime-1.1.2-license.txt +19 -0
  42. package/third_party_licenses/toml_edit-0.25.17-license.txt +19 -0
  43. package/third_party_licenses/toml_parser-1.1.5-license.txt +19 -0
  44. package/third_party_licenses/winnow-1.0.4-license.txt +18 -0
  45. package/ts/00_commitinfo_data.ts +1 -1
  46. package/ts/classes.dashboard.ts +280 -0
  47. package/ts/dashboard.bundled.ts.third-party-notices.json +1741 -0
  48. package/ts/dashboard.bundled.ts.third-party-notices.txt +5015 -0
  49. package/ts/dashboard.interfaces.ts +148 -0
  50. package/ts/dashboard.plugins.ts +13 -0
  51. package/ts/index.ts +162 -1
package/readme.md CHANGED
@@ -69,7 +69,7 @@ described below.
69
69
  ### Clustering Features
70
70
 
71
71
  - 🔗 **Erasure coding** — Reed-Solomon (configurable k data + m parity shards) for storage efficiency and fault tolerance
72
- - 🚄 **QUIC transport** — multiplexed inter-node communication via `quinn` with zero head-of-line blocking. Encrypted but not authenticated: run it only on a trusted network (see Cluster transport trust).
72
+ - 🚄 **QUIC transport** — multiplexed inter-node communication via `quinn` with zero head-of-line blocking. Mutual TLS with a cluster CA when `cluster.tls` is set; without it, encrypted but not authenticated, for trusted networks only (see Cluster transport trust).
73
73
  - 💽 **Multi-drive awareness** — each node manages multiple independent storage paths with health monitoring
74
74
  - 🩺 **Cluster health introspection** — query native node, drive, quorum, and healing status for product dashboards
75
75
  - 🤝 **Cluster membership** — static seed config + runtime join, heartbeat-based failure detection
@@ -184,8 +184,9 @@ Cluster mode requires the control root and every drive root to exist before
184
184
  startup. The process user must own them, no path component may be a symlink,
185
185
  and group/world write permission must be disabled.
186
186
 
187
- The cluster transport does not authenticate nodes: run cluster mode only on a
188
- network where every host that can reach `quicPort` is a cluster node (see
187
+ Without `cluster.tls` the cluster transport does not authenticate nodes: run
188
+ cluster mode only on a network where every host that can reach `quicPort` is a
189
+ cluster node, or set `cluster.tls` on every node (see
189
190
  [Cluster transport trust](#cluster-transport-trust)).
190
191
 
191
192
  ```typescript
@@ -286,7 +287,7 @@ const config: IObjectStorageConfig = {
286
287
  },
287
288
  cluster: { // Optional — omit for standalone mode
288
289
  enabled: true,
289
- nodeId: 'node-1', // Auto-generated UUID if omitted
290
+ nodeId: 'node-1', // Auto-generated UUID if omitted; required with tls
290
291
  quicPort: 4000, // Default: 4000
291
292
  seedNodes: [], // Addresses of existing cluster members
292
293
  erasure: {
@@ -301,6 +302,16 @@ const config: IObjectStorageConfig = {
301
302
  heartbeatIntervalMs: 5000, // Default: 5000
302
303
  heartbeatTimeoutMs: 30000, // Default: 30000
303
304
  getDeadlineMs: 21600000, // Default: 6 h; 60000 (1 min) to 604800000 (7 d)
305
+ tls: { // Optional mutual TLS; set on every node or on none
306
+ caFile: '/etc/objectstorage/tls/ca.pem',
307
+ certFile: '/etc/objectstorage/tls/node-1.pem', // its DNS SAN is nodeId
308
+ keyFile: '/etc/objectstorage/tls/node-1.key', // mode 0600 or 0400
309
+ },
310
+ },
311
+ dashboard: { // Optional read-only dashboard; off unless enabled
312
+ enabled: true,
313
+ address: '127.0.0.1', // Default: '127.0.0.1'
314
+ port: 3001, // Default: 3001; 0 allocates an ephemeral TCP port; never the S3 port
304
315
  },
305
316
  };
306
317
 
@@ -1011,6 +1022,23 @@ interface IClusterHealth {
1011
1022
  drives?: IClusterDriveHealth[];
1012
1023
  erasure?: IClusterErasureHealth;
1013
1024
  repairs?: IClusterRepairHealth;
1025
+ transport?: IClusterTransportHealth;
1026
+ }
1027
+
1028
+ interface IClusterTransportHealth {
1029
+ mode: 'mutualTls' | 'unauthenticated';
1030
+ certificate?: { sha256: string; notAfter: number }; // only with mutualTls
1031
+ caCertificates?: { sha256: string; notAfter: number }[]; // file order; only with mutualTls
1032
+ }
1033
+
1034
+ type TDriveMedia = 'rotational' | 'smr' | 'flash' | 'zoned';
1035
+
1036
+ interface IClusterDriveHealth {
1037
+ // index, path, status, capacity, error and erasure set fields, plus:
1038
+ media: {
1039
+ declared?: TDriveMedia; // not reported yet: drives cannot declare their media
1040
+ detected: TDriveMedia | 'unknown'; // detected once at startup
1041
+ };
1014
1042
  }
1015
1043
  ```
1016
1044
 
@@ -1018,10 +1046,88 @@ interface IClusterHealth {
1018
1046
  - Standalone mode returns `{ enabled: false }`.
1019
1047
  - Peer status is the local node's current view of cluster membership and heartbeats, so it is best-effort and may lag real network state.
1020
1048
  - Drive health is based on live native probe checks on the configured local drive paths. Capacity values are cheap filesystem snapshots.
1049
+ - `drives[].media.detected` is the medium the engine detected for each drive once at startup, never per health call. On Linux it follows the drive root's filesystem to the whole disk behind it (`st_dev` through `/sys/dev/block`; a partition counts as its disk) and reads the disk's `queue/zoned` and `queue/rotational`: `zoned` for host-managed or host-aware devices (SMR or ZNS), otherwise `rotational` or `flash`, as the disk's driver sets `queue/rotational`. Virtual and network block devices report the flag their driver or hypervisor sets: QEMU disks show `rotational` unless they are configured with `rotation_rate=1`, and NVMe volumes show `flash`. Declaring a drive's media, which is planned, is what will correct such a reading. It is `unknown`, never a guess, for filesystems without a block device of their own (tmpfs, overlay, network and FUSE filesystems, btrfs subvolumes), for device-mapper, md, loop and other virtual block devices (LVM, dm-crypt and software RAID included), when sysfs gives no usable answer, and on every platform but Linux. Drive-managed SMR reports itself as rotational and cannot be detected (`smr` can only ever be declared). The detected media change no behaviour today.
1021
1050
  - `quorumHealthy` means the local node currently sees majority quorum and enough available placements in every erasure set to satisfy the configured write quorum.
1051
+ - `transport.mode` is `mutualTls` when `cluster.tls` is set and `unauthenticated` otherwise. With mutual TLS, `certificate` and `caCertificates` describe the files the engine loaded at startup: the SHA-256 of each DER certificate (lowercase hex) and its `notAfter` in milliseconds since the Unix epoch. The files are read only at startup, so during a certificate or CA rotation these show what each node actually runs.
1022
1052
  - Repair fields expose the background healer's currently available runtime state. They are best-effort and limited to what the engine tracks today, such as whether a scan is active, the last completed run, and the last error.
1023
1053
  - `repairs.shardsChecked`, `shardsHealed` and `failed` count the last completed scan's placement checks, shards written and failures. `repairs.shardsPending` counts the pending shards (see [Self-Healing](#self-healing)) that scan left pending because their drive was out of reach, refused the write, or their object was busy. While a scan runs, `lastRunStartedAt` is the running scan's start and the counts are still the previous scan's; `runHealingScan()` returns one scan's start and counts together.
1024
1054
 
1055
+ ## Dashboard
1056
+
1057
+ Every node can serve a small read-only dashboard for quick visibility: the
1058
+ cluster's nodes, drives, erasure layout and quorum, object and byte totals,
1059
+ request, error and byte rates, healing state and recent engine events. It is
1060
+ off by default:
1061
+
1062
+ ```typescript
1063
+ const storage = await ObjectStorage.createAndStart({
1064
+ // ...
1065
+ dashboard: { enabled: true, address: '10.0.0.5', port: 3001 },
1066
+ });
1067
+ console.log(storage.dashboardPort); // the bound port; undefined while off
1068
+ ```
1069
+
1070
+ Open `http://<address>:<port>/` in a browser. The page is bundled into the
1071
+ package (`ts_web/`, built into `ts/dashboard.bundled.ts`), so nothing is
1072
+ fetched from elsewhere, and it updates itself over one TypedSocket connection
1073
+ to the same origin.
1074
+
1075
+ - **Configuration.** `dashboard.enabled` must be set. `address` defaults to
1076
+ `127.0.0.1` and `port` to `3001`; `port: 0` asks the OS for a port. A port
1077
+ equal to `server.port` is refused at construction. A dashboard that is
1078
+ enabled but cannot bind fails `start()`, and the engine is stopped: it never
1079
+ runs silently without it. The `dashboard` section is not sent to the engine.
1080
+ - **What it shows.** Nodes (status and last heartbeat in this node's view,
1081
+ start time); local drives of every node (status, usage, errors,
1082
+ last probe); the erasure layout and quorum; objects and bytes per node and
1083
+ summed; request, error and byte rates per node and summed, with two-minute
1084
+ sparklines kept in the browser; healing per node (last scan, checked,
1085
+ healed, pending shards, failures); and the newest events of each node (peer
1086
+ status changes, drive status changes, healing scan results, engine start).
1087
+ A standalone node shows its totals, rates and events. Rates are derived
1088
+ from counters of the S3 listener; byte counts are taken at the TCP stream
1089
+ and include HTTP headers. Nothing is stored: a reload starts the sparklines
1090
+ again.
1091
+ - **Where the data comes from.** One management command, `getClusterSnapshot`
1092
+ (also `ObjectStorage.getClusterSnapshot()`), built by the engine from memory
1093
+ only: the drive states the last heartbeat probe left, the in-memory runtime
1094
+ stats, healing state, S3 listener counters and a ring of the newest 64
1095
+ events. It never probes a drive, syncs, walks a directory or reads the
1096
+ control store. A cluster node asks each online peer for that peer's own
1097
+ snapshot over QUIC (`NodeSnapshot`), in parallel, with one second per peer;
1098
+ a peer that is not online or does not answer in time shows as unavailable in
1099
+ that sample. Any node with the dashboard on therefore shows the whole
1100
+ cluster, and the other nodes need no dashboard of their own.
1101
+ - **Cost.** With no dashboard connected there is no timer, no IPC and no QUIC
1102
+ traffic. While at least one is connected, one shared sampler takes a
1103
+ snapshot every two seconds, keeps at most one in flight and skips ticks
1104
+ while one runs, and pushes the same sample (a few KB per node) to every
1105
+ connected dashboard. At most 16 dashboard sockets are admitted at once; the
1106
+ 17th is refused with `503`. On the engine side, request and byte counting is
1107
+ a relaxed atomic add per response and per socket read or write. An enabled
1108
+ dashboard with nobody watching runs no timer and sends no traffic; on a
1109
+ three-node cluster against 11.0.0 its CPU cost per request was within 0.4 %,
1110
+ and the engine's memory was unchanged. Its server modules and bundled page
1111
+ add about 50 MiB to the Node.js process of each node once, at start, and
1112
+ that does not grow with time or stored objects. With 16 dashboards open on
1113
+ every node, large uploads ran about 1.5 % slower and the p99 latency was
1114
+ about 5 % higher.
1115
+ - **Security.** The dashboard is read-only by construction: its socket
1116
+ registers one read handler and nothing else, so it cannot start a healing
1117
+ scan, change configuration or touch S3 traffic or stored data. It has no
1118
+ authentication: protect it with the bind address and a firewall, for
1119
+ example by binding it to a private interface only. It shows node IDs,
1120
+ addresses, drive paths, counts and event messages, never credentials or
1121
+ object keys.
1122
+ - **Versions.** Run every node on the same version, as clusters already
1123
+ require. An engine that predates `NodeSnapshot` cannot decode the request,
1124
+ logs a stream error and closes the stream, and the asking node shows it as
1125
+ unavailable.
1126
+
1127
+ `getClusterHealth()` probes every local drive (a write, sync and read of a
1128
+ probe file) on each call; poll `getClusterSnapshot()` instead when you need a
1129
+ cheap periodic view.
1130
+
1025
1131
  ## Supported S3 Operations
1026
1132
 
1027
1133
  The router fails closed, in standalone and cluster mode alike. A request
@@ -1455,16 +1561,79 @@ ahead of the client.
1455
1561
  ### QUIC Transport
1456
1562
 
1457
1563
  Inter-node communication uses [QUIC](https://en.wikipedia.org/wiki/QUIC) via the `quinn` library:
1458
- - **Encrypted, not authenticated** — each node generates a self-signed certificate at startup and accepts any peer; run it only on a trusted network (see [Cluster transport trust](#cluster-transport-trust))
1564
+ - **Mutual TLS or unauthenticated** — with `cluster.tls`, every connection is TLS 1.3 with a CA-signed certificate on both ends; without it, each node generates a self-signed certificate at startup and accepts any peer (see [Cluster transport trust](#cluster-transport-trust))
1459
1565
  - 🔀 **Multiplexed streams** — concurrent shard transfers without head-of-line blocking
1460
1566
  - ⚡ **Connection pooling** — persistent connections to peer nodes
1461
1567
  - 🌊 **Natural backpressure** — QUIC flow control prevents overloading slow peers
1462
1568
 
1463
1569
  ### Cluster transport trust
1464
1570
 
1465
- The cluster transport does not authenticate nodes. Each node generates a self-signed certificate at startup and accepts any peer's certificate without verifying it. QUIC encrypts the traffic against passive eavesdropping, but not against an attacker on the path. Any host that can reach a node's `quicPort` can join the cluster, sync topology, and read, write, tombstone and purge shards. S3 credentials and bucket policies do not apply to this port.
1571
+ Without `cluster.tls` the cluster transport does not authenticate nodes. Each node generates a self-signed certificate at startup and accepts any peer's certificate without verifying it. QUIC encrypts the traffic against passive eavesdropping, but not against an attacker on the path. Any host that can reach a node's `quicPort` can join the cluster, sync topology, and read, write, tombstone and purge shards. S3 credentials and bucket policies do not apply to this port. Run such a cluster only on a network where every host that can reach `quicPort` (UDP, default 4000) is a cluster node: a private network or VPN between the nodes, with `quicPort` firewalled from everything else.
1572
+
1573
+ With `cluster.tls` set, the transport is mutual TLS (TLS 1.3, no session resumption, no early data) with a cluster CA you run:
1574
+
1575
+ - **Identity.** A node's identity is the single DNS subject alternative name (SAN) of its certificate, and it equals `cluster.nodeId`. With `cluster.tls`, `nodeId` is required and must be a lowercase DNS name such as `node-1` or `node-1.storage.internal`; it is never generated, and it must still match the node id persisted in the control root. One certificate serves as both the server and the client certificate, so it must be valid for both: an extended key usage extension listing `serverAuth` and `clientAuth`, or no extended key usage extension at all (the recipe below issues both). Use a dedicated CA per cluster: every certificate it signs with one lowercase DNS SAN is a member of the cluster.
1576
+ - **Checks.** A node connects to a known peer only if the peer's certificate names exactly that peer's node id (one DNS SAN, no wildcard), and to a seed (`seedNodes`, known only by its address) only if the seed presents a certificate from the cluster CA. A node accepts a connection only with a client certificate from the cluster CA, and a join or heartbeat only for the node id that certificate names. A peer without such a certificate fails the handshake before it can send any request. Every CA-signed node is a full member: it may sync topology and read, write, tombstone and purge any shard, so the way to remove a compromised node is to stop trusting its certificate (a new CA, see the rotation below).
1577
+ - **Startup.** A node checks its own certificate the way its peers will (chain, validity, server and client authentication, the SAN, and that `keyFile` matches `certFile`) and refuses to start if that check or any file check below fails. The error names the file and the reason. A node never falls back to the unauthenticated transport. At startup it logs one line with its certificate's `notAfter` and the SHA-256 of each CA certificate, and `getClusterHealth().transport` reports them (see [Cluster Health](#cluster-health)).
1578
+ - **Files.** `caFile` holds one CA certificate, or two during a CA rotation; anything else is refused, which keeps a system CA bundle out. `certFile` holds the node certificate, optionally followed by intermediates, and nothing but certificates. `keyFile` holds exactly one unencrypted PKCS#8, SEC1 or PKCS#1 key; ECDSA P-256 is recommended. Each path must be absolute and canonical, with no symbolic link anywhere, and lie outside the control root and every drive root (roots are backed up and replaced, and a key must not travel with them). That check compares paths, so a bind mount that makes a root reachable under another path is not detected. Each file must be a regular file of at most 64 KiB. The files and their directories must be owned by the engine's user or by root and must not be group- or world-writable, and `keyFile` must be owned by the engine's user and grant no group or world permission (mode 0600 or 0400).
1579
+ - **Reload.** The files are read once at startup; a restart is the reload. Certificates are checked at every handshake, so a connection established before a certificate's `notAfter` keeps running until it reconnects, and new handshakes after `notAfter` fail. Renew certificates and restart the nodes before they expire.
1580
+
1581
+ #### Making the CA and the node certificates
1582
+
1583
+ The engine ships no CA tooling. With OpenSSL 3 or LibreSSL 3.3 (the `openssl` of macOS), create the CA once and keep `ca.key` offline. `ec_param_enc:named_curve` is required for LibreSSL, which otherwise writes the curve as explicit parameters that the engine refuses; OpenSSL 3 writes the named curve either way:
1584
+
1585
+ ```bash
1586
+ openssl genpkey -algorithm EC -pkeyopt ec_paramgen_curve:P-256 \
1587
+ -pkeyopt ec_param_enc:named_curve -out ca.key
1588
+ openssl req -x509 -new -key ca.key -sha256 -days 3650 \
1589
+ -subj "/CN=objectstorage cluster CA" \
1590
+ -addext "basicConstraints=critical,CA:TRUE" \
1591
+ -addext "keyUsage=critical,keyCertSign,cRLSign" \
1592
+ -out ca.pem
1593
+ ```
1594
+
1595
+ Then issue one certificate per node, with the node id as its only DNS SAN:
1596
+
1597
+ ```bash
1598
+ NODE_ID=node-1
1599
+ openssl genpkey -algorithm EC -pkeyopt ec_paramgen_curve:P-256 \
1600
+ -pkeyopt ec_param_enc:named_curve -out "$NODE_ID.key"
1601
+ openssl req -new -key "$NODE_ID.key" -subj "/CN=$NODE_ID" -out "$NODE_ID.csr"
1602
+ cat > "$NODE_ID.ext" <<EXT
1603
+ basicConstraints = critical,CA:FALSE
1604
+ keyUsage = critical,digitalSignature
1605
+ extendedKeyUsage = serverAuth,clientAuth
1606
+ subjectAltName = DNS:$NODE_ID
1607
+ EXT
1608
+ openssl x509 -req -in "$NODE_ID.csr" -CA ca.pem -CAkey ca.key -CAcreateserial \
1609
+ -days 365 -sha256 -extfile "$NODE_ID.ext" -out "$NODE_ID.pem"
1610
+ ```
1611
+
1612
+ Install `ca.pem` and the node's certificate and key on the node, as the user that runs the engine and outside its control and drive roots:
1613
+
1614
+ ```bash
1615
+ install -d -m 0755 /etc/objectstorage/tls
1616
+ install -m 0644 ca.pem "$NODE_ID.pem" /etc/objectstorage/tls/
1617
+ install -m 0600 "$NODE_ID.key" /etc/objectstorage/tls/
1618
+ ```
1619
+
1620
+ Then set `cluster.tls` to the three paths (see [Configuration](#configuration)). The test suite runs exactly these commands (`test/test.cluster-tls.node.ts`).
1466
1621
 
1467
- Run cluster mode only on a network where every host that can reach `quicPort` (UDP, default 4000) is a cluster node: a private network or VPN between the nodes, with `quicPort` firewalled from everything else. This has been the case since cluster mode was introduced, and 11.0.0 does not change it. Mutual TLS with a cluster CA and certificate-checked joins are planned.
1622
+ **Docker secrets** are mounted owned by root with mode 0444 by default, which the key check refuses. Set the key secret's `uid` to the engine's user and its `mode` to `0400` in the service's long `secrets` syntax. Docker Compose ignores `uid`, `gid` and `mode` for secrets read from a file, because it bind-mounts the file; there the host file itself must be owned by the engine's uid with mode 0600 or 0400. Kubernetes secret volumes present their files through symbolic links, which the canonical-path rule refuses.
1623
+
1624
+ #### Enabling mutual TLS
1625
+
1626
+ Nodes with and without `cluster.tls` cannot talk to each other: a TLS node refuses peers without a client certificate and refuses self-signed servers. Enabling TLS is therefore not a rolling change: stop every node, configure `cluster.tls` on every node, then start every node. A node whose `nodeId` was generated keeps that id (the control root persists it, and `getClusterHealth().nodeId` reports it): configure it as `nodeId` and issue the node's certificate for it, or the node refuses to start. Disabling TLS takes the same full stop.
1627
+
1628
+ #### Rotating certificates and the CA
1629
+
1630
+ A node certificate is renewed by issuing a new one from the same CA and restarting the node; its peers need no change. A new CA takes three rolling restarts, with no cluster stop:
1631
+
1632
+ 1. Put both CAs into every node's `caFile` (two certificates) and restart the nodes one at a time.
1633
+ 2. Issue every node a certificate from the new CA and restart the nodes one at a time.
1634
+ 3. Remove the old CA from every `caFile` and restart the nodes one at a time.
1635
+
1636
+ Every pair of nodes stays connected throughout, because trust only grows before the certificates change and only shrinks after. The order matters: a node with a certificate from the new CA cannot connect to a node that trusts only the old one.
1468
1637
 
1469
1638
  ### Cluster Membership
1470
1639
 
@@ -1847,7 +2016,7 @@ Atomically replace the active runtime credential set without restarting the serv
1847
2016
 
1848
2017
  #### `getClusterHealth(): Promise<IClusterHealth>`
1849
2018
 
1850
- Read the Rust core's current cluster, drive, quorum, and repair health snapshot. Standalone mode returns `{ enabled: false }`.
2019
+ Read the Rust core's current cluster, drive, quorum, repair, and transport health snapshot. Standalone mode returns `{ enabled: false }`.
1851
2020
 
1852
2021
  In cluster mode, `quicAddress` is the local QUIC/UDP socket's actual bound
1853
2022
  address. With `cluster.quicPort: 0`, the operating system assigns its port; use
@@ -1855,6 +2024,20 @@ address. With `cluster.quicPort: 0`, the operating system assigns its port; use
1855
2024
  Membership advertisements and peer `quicAddress` values contain that same bound
1856
2025
  address, including after a restart.
1857
2026
 
2027
+ #### `getClusterSnapshot(): Promise<IObjectStorageClusterSnapshot>`
2028
+
2029
+ The [dashboard](#dashboard)'s snapshot, built by the engine from memory only:
2030
+ `local` is this node's `IObjectStorageNodeSnapshot` (counters, totals, drives
2031
+ from the last heartbeat probe, healing state, recent events) and, in cluster
2032
+ mode, `cluster` adds quorum, the erasure layout and every peer, with the peer's
2033
+ own snapshot when it answered within a second. One snapshot runs at a time; a
2034
+ call while another runs rejects. Standalone mode returns `cluster: null`.
2035
+
2036
+ #### `dashboardPort: number | undefined`
2037
+
2038
+ The dashboard's bound TCP port while it runs; `undefined` while it is off or
2039
+ stopped.
2040
+
1858
2041
  #### `runHealingScan(options?: IRunHealingScanOptions): Promise<IClusterHealingScanResult>`
1859
2042
 
1860
2043
  Run a healing scan on this cluster node (see [Self-Healing](#self-healing)) and
@@ -1913,7 +2096,7 @@ objectstorage uses a **hybrid Rust + TypeScript** architecture:
1913
2096
 
1914
2097
  **Why Rust?** The original TypeScript implementation had critical perf issues: OOM on multipart uploads (parts buffered in memory), double stream copying, file descriptor leaks on HEAD requests, full-file reads for range requests, and no backpressure. The Rust binary solves these with bounded-memory streaming I/O, backpressure, and direct `seek()` for range requests.
1915
2098
 
1916
- **IPC Protocol:** TypeScript communicates with the `ruststorage` binary over newline-delimited JSON via stdin/stdout. The current management commands are `probeStoragePool`, `findOrphanObjectLeaves`, `getStoragePoolDiagnostic`, `start`, `stop`, `createBucket`, `createBucketTenant`, `ensureBucketTenant`, `deleteBucketTenant`, `rotateBucketTenantCredentials`, `listBucketTenants`, `getBucketTenantCredential`, `getBucketRetentionCapability`, `getBucketRetentionReceipt`, `getBucketMigrationCapability`, `createSourceMigration`, `createDestinationMigration`, `transitionSourceMigration`, `transitionDestinationMigration`, `cleanupSourceMigration`, `inspectBucketMigration`, `exportBucket`, `importBucket`, `deleteBucket`, `commitResourcePublication`, `getResourceFencingCapability`, `getBucketResourceFenceState`, `getStorageStats`, `listBucketSummaries`, `listCredentials`, `replaceCredentials`, `createPrefixCredential`, `revokePrefixCredential`, `listPrefixCredentials`, `getPrefixCredentialStatus`, `getClusterHealth`, and `runHealingScan`. `getStoragePoolDiagnostic` reads a weak, cached diagnostic source and remains responsive while another management command owns the server; it does not retain the mounted root after server ownership completes. `runHealingScan` answers when its scan completes, with the request's `id`; the engine serves other commands meanwhile, and a shutdown answers a pending request with an error before the `stop` response.
2099
+ **IPC Protocol:** TypeScript communicates with the `ruststorage` binary over newline-delimited JSON via stdin/stdout. The current management commands are `probeStoragePool`, `findOrphanObjectLeaves`, `getStoragePoolDiagnostic`, `start`, `stop`, `createBucket`, `createBucketTenant`, `ensureBucketTenant`, `deleteBucketTenant`, `rotateBucketTenantCredentials`, `listBucketTenants`, `getBucketTenantCredential`, `getBucketRetentionCapability`, `getBucketRetentionReceipt`, `getBucketMigrationCapability`, `createSourceMigration`, `createDestinationMigration`, `transitionSourceMigration`, `transitionDestinationMigration`, `cleanupSourceMigration`, `inspectBucketMigration`, `exportBucket`, `importBucket`, `deleteBucket`, `commitResourcePublication`, `getResourceFencingCapability`, `getBucketResourceFenceState`, `getStorageStats`, `listBucketSummaries`, `listCredentials`, `replaceCredentials`, `createPrefixCredential`, `revokePrefixCredential`, `listPrefixCredentials`, `getPrefixCredentialStatus`, `getClusterHealth`, `getClusterSnapshot`, and `runHealingScan`. `getStoragePoolDiagnostic` reads a weak, cached diagnostic source and remains responsive while another management command owns the server; it does not retain the mounted root after server ownership completes. `runHealingScan` answers when its scan completes, with the request's `id`; the engine serves other commands meanwhile, and a shutdown answers a pending request with an error before the `stop` response. `getClusterSnapshot` is answered the same deferred way, because a cluster node waits up to a second for each peer.
1917
2100
 
1918
2101
  ### S3-Compatible Operations
1919
2102
 
@@ -55,12 +55,28 @@ Developer ID signed or notarized.
55
55
  ## Locked Cargo graph
56
56
 
57
57
  [Cargo dependency notices](./third_party_licenses/cargo-dependencies.html)
58
- contain the selected license texts and original attributions for 260 packages.
59
- The complete locked graph also contains three feature-inactive packages:
58
+ contain the selected license texts and original attributions for 279 packages.
59
+ The complete locked graph also contains 18 feature-inactive packages:
60
60
  [aho-corasick 1.1.4](./third_party_licenses/aho-corasick-1.1.4-license.txt),
61
- [valuable 0.1.1](./third_party_licenses/valuable-license.txt) and
61
+ [borsh 1.8.1](./third_party_licenses/borsh-1.8.1-license.txt),
62
+ [borsh-derive 1.8.1](./third_party_licenses/borsh-derive-1.8.1-apache-2.0.txt),
63
+ [dyn-clone 1.0.20](./third_party_licenses/dyn-clone-1.0.20-license.txt),
64
+ [equivalent 1.0.3](./third_party_licenses/equivalent-1.0.3-license.txt),
65
+ [hashbrown 0.17.1](./third_party_licenses/hashbrown-0.17.1-license.txt),
66
+ [indexmap 2.14.2](./third_party_licenses/indexmap-2.14.2-license.txt),
67
+ [proc-macro-crate 3.5.0](./third_party_licenses/proc-macro-crate-3.5.0-license.txt),
68
+ [ref-cast 1.0.27](./third_party_licenses/ref-cast-1.0.27-license.txt),
69
+ [ref-cast-impl 1.0.27](./third_party_licenses/ref-cast-impl-1.0.27-license.txt),
70
+ [schemars 1.2.3](./third_party_licenses/schemars-1.2.3-license.txt),
71
+ [syn 3.0.9](./third_party_licenses/syn-3.0.9-license.txt),
72
+ [toml_datetime 1.1.2](./third_party_licenses/toml_datetime-1.1.2-license.txt),
73
+ [toml_edit 0.25.17](./third_party_licenses/toml_edit-0.25.17-license.txt),
74
+ [toml_parser 1.1.5](./third_party_licenses/toml_parser-1.1.5-license.txt),
75
+ [valuable 0.1.1](./third_party_licenses/valuable-license.txt),
76
+ [winnow 1.0.4](./third_party_licenses/winnow-1.0.4-license.txt) and
62
77
  [zerocopy-derive 0.8.47](./third_party_licenses/zerocopy-derive-0.8.47-license.txt).
63
- Their exact MIT notices bring the inventory to all 261 locked third-party
78
+ Their exact notices (Apache-2.0 for borsh-derive, which offers no MIT
79
+ alternative, MIT for the others) bring the inventory to all 297 locked third-party
64
80
  packages, conservatively including build-only, development and inactive targets.
65
81
  Listing a package does not claim that it is linked into every distributed executable.
66
82
 
@@ -0,0 +1,23 @@
1
+ Permission is hereby granted, free of charge, to any
2
+ person obtaining a copy of this software and associated
3
+ documentation files (the "Software"), to deal in the
4
+ Software without restriction, including without
5
+ limitation the rights to use, copy, modify, merge,
6
+ publish, distribute, sublicense, and/or sell copies of
7
+ the Software, and to permit persons to whom the Software
8
+ is furnished to do so, subject to the following
9
+ conditions:
10
+
11
+ The above copyright notice and this permission notice
12
+ shall be included in all copies or substantial portions
13
+ of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
16
+ ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
17
+ TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
18
+ PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
19
+ SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20
+ CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
22
+ IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23
+ DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2019 Near
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.