mirror.py-rsync-server 1.0.0__tar.gz

mirror_py_rsync_server-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

mirror_py_rsync_server-1.0.0/PKG-INFO

@@ -0,0 +1,200 @@
+Metadata-Version: 2.4
+Name: mirror.py-rsync-server
+Version: 1.0.0
+Summary: mirror.py event plug-in that generates rsyncd.conf and rsyncd.secrets from the package list.
+Author: SPARCS KAIST
+License-Expression: Apache-2.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mirror.py>=1.0.0
+Dynamic: license-file
+
+# mirror.py rsync-server plugin
+
+An event plugin for [mirror.py](https://github.com/sparcs-kaist/mirror.py) that generates
+`rsyncd.conf` and `rsyncd.secrets` from the live mirror package list plus a sidecar
+`rsync.json` configuration file. The plugin regenerates both files automatically when the
+mirror daemon starts (`MASTER.INIT.POST`) and whenever the package set changes via
+`mirror config reload` (`MASTER.CONFIG_RELOAD.POST`).
+
+
+## How it works
+
+The plugin listens on two mirror.py events:
+
+- `MASTER.INIT.POST` — fires once when the master daemon finishes starting up.
+- `MASTER.CONFIG_RELOAD.POST` — fires after `mirror config reload` has loaded a new
+  configuration. Until the mirror.py core ships this event, regeneration happens at
+  daemon start only; the listener signature accepts `(*args, **kwargs)` so it is
+  forward-compatible.
+
+**File generation only.** The plugin writes `rsyncd.conf` and `rsyncd.secrets`; it does
+not start, stop, or signal the rsyncd process. This is intentional: rsyncd re-reads
+`rsyncd.conf` and the secrets file on every incoming client connection, so adding or
+removing mirror modules takes effect immediately with no reload signal needed.
+
+Writes are atomic (via a temporary file in the same directory followed by `os.replace`).
+If the generated content is identical to what is already on disk, the file is not
+rewritten. Regeneration runs under a module-level lock so concurrent event firings do not
+race.
+
+Packages with `settings.hidden: true` are completely excluded — they appear in neither
+the public nor the private module list.
+
+
+## Installation
+
+Install the plugin into the same Python environment as mirror.py:
+
+```
+pip install -e .
+```
+
+Enable the plugin in mirror.py's `config.json`:
+
+```json
+"plugins": { "rsync-server": { "enabled": true } }
+```
+
+The plugin's own settings live in `rsync.json`, **not** in the `plugins` block of
+`config.json`. See the Configuration section below.
+
+
+## Configuration
+
+`rsync.json` must live in the same directory as mirror.py's `config.json` (default path:
+`/etc/mirror/rsync.json`).
+
+See [`rsync.json.example`](rsync.json.example) for a complete, realistic example.
+
+All keys are optional and fall back to the defaults listed below.
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| `rsyncd_conf` | string (absolute path) | `/etc/rsyncd.conf` | Destination path for the generated `rsyncd.conf`. |
+| `secrets_file` | string (absolute path) | `/etc/rsyncd.secrets` | Destination path for the generated secrets file. Also emitted as `secrets file` in the global section of `rsyncd.conf`. |
+| `users` | object | `{}` | Map of `username` to `password`. Written to the secrets file in insertion order. |
+| `global` | object | `{}` | Raw rsyncd parameter passthrough. Keys and values are emitted in insertion order as `key = value` lines in the global section. Values may be strings, integers, or booleans (booleans render as `true`/`false`). The key `secrets file` is managed by the plugin and is rejected if placed here. |
+| `private_modules.enabled` | boolean | `true` | When `false`, no `[.Name]` private module sections are generated. |
+| `private_modules.auth_users` | string | `*` | Value written to `auth users` in every private module section. |
+| `private_modules.list` | boolean | `false` | Value written to `list` in every private module section. |
+| `private_modules.lock_file` | string (absolute path) | `/var/run/rsyncd-private.lock` | Value written to `lock file` in every private module section. The private modules share this lock file, giving them a separate max-connections accounting pool independent of the public modules. |
+
+Unknown top-level keys and unknown `private_modules` keys are rejected with a `ValueError`
+at load time (typo protection). Any validation failure leaves previously generated files
+untouched.
+
+**SECURITY NOTE:** `rsync.json` contains plaintext passwords. Restrict its permissions:
+
+```
+chmod 600 /etc/mirror/rsync.json
+```
+
+The plugin logs a warning if `rsync.json` is group- or other-readable. The generated
+`rsyncd.secrets` file is always written with mode `0600`, as required by rsyncd's strict
+modes.
+
+
+## Generated output
+
+Given a package named `ArchLinux` with `src = rsync://rsync.archlinux.org/ftp_tier1` and
+`dst = /mirror/ftp/ArchLinux`, and the global settings from `rsync.json.example`, the
+plugin produces:
+
+```
+# WARNING: DO NOT EDIT!! Generated by the mirror.py rsync-server plugin.
+uid = rsync
+gid = nogroup
+use chroot = no
+max connections = 20
+motd file = /mirror/etc/motd
+log file = /var/log/geoul/rsyncd/all.log
+transfer logging = yes
+log format = %o %a - %u [%t] "%P/%f" - %l
+pid file = /var/run/rsyncd.pid
+exclude = .~tmp~
+
+secrets file = /mirror/etc/rsyncd.secrets
+
+[ArchLinux]
+    path = /mirror/ftp/ArchLinux
+    comment = from rsync://rsync.archlinux.org/ftp_tier1
+
+[.ArchLinux]
+    path = /mirror/ftp/ArchLinux
+    comment = private module for ArchLinux without connection limits for authorized mirrors
+    auth users = *
+    list = false
+    lock file = /var/run/rsyncd-private.lock
+```
+
+Each package produces a public/private module pair:
+
+- `[Name]` is the public module. It is visible in `rsync host::` listings and carries a
+  `comment = from <upstream src>` line. The comment line is omitted when a package has
+  no upstream `src` (for example, locally synced packages).
+- `[.Name]` is the authenticated, unlisted private twin. The leading dot hides it from
+  `rsync host::` listings. Access is gated by `auth users` and the secrets file. This
+  module has its own lock file, so its connection accounting is independent of the public
+  module's `max connections` limit.
+
+Modules are sorted by package name. The static header contains no timestamp so that
+identical content is detected and the file is not rewritten unnecessarily.
+
+The secrets file (`rsyncd.secrets`) contains one `username:password` line per entry in
+`users`, written in insertion order, with no header line.
+
+
+## Running rsyncd
+
+Point rsyncd at the generated configuration file:
+
+```
+rsync --daemon --config=/etc/rsyncd.conf
+```
+
+
+## Operational notes
+
+**Changing users or rsync settings.** Edit `rsync.json`, then run:
+
+```
+mirror config reload
+```
+
+No daemon restart is needed for module or authentication changes. rsyncd picks up the
+new `rsyncd.conf` and `rsyncd.secrets` on the next incoming client connection.
+
+**Parameters that require an rsyncd restart.** Daemon-socket parameters such as `port`,
+`address`, and `pid file` are read by rsyncd only at startup. Changing them in `rsync.json`
+and running `mirror config reload` will update the generated file, but rsyncd itself must
+be restarted for these to take effect. Module-level parameters (path, auth, comment, etc.)
+apply per connection and do not require a restart.
+
+**Private module connection accounting.** The private modules share the lock file
+specified by `private_modules.lock_file`. This gives them a separate max-connections pool
+rather than unlimited connections — the pool size is controlled by rsyncd's global
+`max connections` parameter applied against that lock file independently from the public
+modules' lock file.
+
+
+## Development
+
+Set up a virtual environment and install the plugin alongside mirror.py:
+
+```
+uv venv
+uv pip install -e /path/to/mirror.py -e . pytest
+```
+
+Run the test suite:
+
+```
+uv run pytest
+```
+
+
+## License
+
+Apache-2.0

mirror_py_rsync_server-1.0.0/README.md

@@ -0,0 +1,188 @@
+# mirror.py rsync-server plugin
+
+An event plugin for [mirror.py](https://github.com/sparcs-kaist/mirror.py) that generates
+`rsyncd.conf` and `rsyncd.secrets` from the live mirror package list plus a sidecar
+`rsync.json` configuration file. The plugin regenerates both files automatically when the
+mirror daemon starts (`MASTER.INIT.POST`) and whenever the package set changes via
+`mirror config reload` (`MASTER.CONFIG_RELOAD.POST`).
+
+
+## How it works
+
+The plugin listens on two mirror.py events:
+
+- `MASTER.INIT.POST` — fires once when the master daemon finishes starting up.
+- `MASTER.CONFIG_RELOAD.POST` — fires after `mirror config reload` has loaded a new
+  configuration. Until the mirror.py core ships this event, regeneration happens at
+  daemon start only; the listener signature accepts `(*args, **kwargs)` so it is
+  forward-compatible.
+
+**File generation only.** The plugin writes `rsyncd.conf` and `rsyncd.secrets`; it does
+not start, stop, or signal the rsyncd process. This is intentional: rsyncd re-reads
+`rsyncd.conf` and the secrets file on every incoming client connection, so adding or
+removing mirror modules takes effect immediately with no reload signal needed.
+
+Writes are atomic (via a temporary file in the same directory followed by `os.replace`).
+If the generated content is identical to what is already on disk, the file is not
+rewritten. Regeneration runs under a module-level lock so concurrent event firings do not
+race.
+
+Packages with `settings.hidden: true` are completely excluded — they appear in neither
+the public nor the private module list.
+
+
+## Installation
+
+Install the plugin into the same Python environment as mirror.py:
+
+```
+pip install -e .
+```
+
+Enable the plugin in mirror.py's `config.json`:
+
+```json
+"plugins": { "rsync-server": { "enabled": true } }
+```
+
+The plugin's own settings live in `rsync.json`, **not** in the `plugins` block of
+`config.json`. See the Configuration section below.
+
+
+## Configuration
+
+`rsync.json` must live in the same directory as mirror.py's `config.json` (default path:
+`/etc/mirror/rsync.json`).
+
+See [`rsync.json.example`](rsync.json.example) for a complete, realistic example.
+
+All keys are optional and fall back to the defaults listed below.
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| `rsyncd_conf` | string (absolute path) | `/etc/rsyncd.conf` | Destination path for the generated `rsyncd.conf`. |
+| `secrets_file` | string (absolute path) | `/etc/rsyncd.secrets` | Destination path for the generated secrets file. Also emitted as `secrets file` in the global section of `rsyncd.conf`. |
+| `users` | object | `{}` | Map of `username` to `password`. Written to the secrets file in insertion order. |
+| `global` | object | `{}` | Raw rsyncd parameter passthrough. Keys and values are emitted in insertion order as `key = value` lines in the global section. Values may be strings, integers, or booleans (booleans render as `true`/`false`). The key `secrets file` is managed by the plugin and is rejected if placed here. |
+| `private_modules.enabled` | boolean | `true` | When `false`, no `[.Name]` private module sections are generated. |
+| `private_modules.auth_users` | string | `*` | Value written to `auth users` in every private module section. |
+| `private_modules.list` | boolean | `false` | Value written to `list` in every private module section. |
+| `private_modules.lock_file` | string (absolute path) | `/var/run/rsyncd-private.lock` | Value written to `lock file` in every private module section. The private modules share this lock file, giving them a separate max-connections accounting pool independent of the public modules. |
+
+Unknown top-level keys and unknown `private_modules` keys are rejected with a `ValueError`
+at load time (typo protection). Any validation failure leaves previously generated files
+untouched.
+
+**SECURITY NOTE:** `rsync.json` contains plaintext passwords. Restrict its permissions:
+
+```
+chmod 600 /etc/mirror/rsync.json
+```
+
+The plugin logs a warning if `rsync.json` is group- or other-readable. The generated
+`rsyncd.secrets` file is always written with mode `0600`, as required by rsyncd's strict
+modes.
+
+
+## Generated output
+
+Given a package named `ArchLinux` with `src = rsync://rsync.archlinux.org/ftp_tier1` and
+`dst = /mirror/ftp/ArchLinux`, and the global settings from `rsync.json.example`, the
+plugin produces:
+
+```
+# WARNING: DO NOT EDIT!! Generated by the mirror.py rsync-server plugin.
+uid = rsync
+gid = nogroup
+use chroot = no
+max connections = 20
+motd file = /mirror/etc/motd
+log file = /var/log/geoul/rsyncd/all.log
+transfer logging = yes
+log format = %o %a - %u [%t] "%P/%f" - %l
+pid file = /var/run/rsyncd.pid
+exclude = .~tmp~
+
+secrets file = /mirror/etc/rsyncd.secrets
+
+[ArchLinux]
+    path = /mirror/ftp/ArchLinux
+    comment = from rsync://rsync.archlinux.org/ftp_tier1
+
+[.ArchLinux]
+    path = /mirror/ftp/ArchLinux
+    comment = private module for ArchLinux without connection limits for authorized mirrors
+    auth users = *
+    list = false
+    lock file = /var/run/rsyncd-private.lock
+```
+
+Each package produces a public/private module pair:
+
+- `[Name]` is the public module. It is visible in `rsync host::` listings and carries a
+  `comment = from <upstream src>` line. The comment line is omitted when a package has
+  no upstream `src` (for example, locally synced packages).
+- `[.Name]` is the authenticated, unlisted private twin. The leading dot hides it from
+  `rsync host::` listings. Access is gated by `auth users` and the secrets file. This
+  module has its own lock file, so its connection accounting is independent of the public
+  module's `max connections` limit.
+
+Modules are sorted by package name. The static header contains no timestamp so that
+identical content is detected and the file is not rewritten unnecessarily.
+
+The secrets file (`rsyncd.secrets`) contains one `username:password` line per entry in
+`users`, written in insertion order, with no header line.
+
+
+## Running rsyncd
+
+Point rsyncd at the generated configuration file:
+
+```
+rsync --daemon --config=/etc/rsyncd.conf
+```
+
+
+## Operational notes
+
+**Changing users or rsync settings.** Edit `rsync.json`, then run:
+
+```
+mirror config reload
+```
+
+No daemon restart is needed for module or authentication changes. rsyncd picks up the
+new `rsyncd.conf` and `rsyncd.secrets` on the next incoming client connection.
+
+**Parameters that require an rsyncd restart.** Daemon-socket parameters such as `port`,
+`address`, and `pid file` are read by rsyncd only at startup. Changing them in `rsync.json`
+and running `mirror config reload` will update the generated file, but rsyncd itself must
+be restarted for these to take effect. Module-level parameters (path, auth, comment, etc.)
+apply per connection and do not require a restart.
+
+**Private module connection accounting.** The private modules share the lock file
+specified by `private_modules.lock_file`. This gives them a separate max-connections pool
+rather than unlimited connections — the pool size is controlled by rsyncd's global
+`max connections` parameter applied against that lock file independently from the public
+modules' lock file.
+
+
+## Development
+
+Set up a virtual environment and install the plugin alongside mirror.py:
+
+```
+uv venv
+uv pip install -e /path/to/mirror.py -e . pytest
+```
+
+Run the test suite:
+
+```
+uv run pytest
+```
+
+
+## License
+
+Apache-2.0