rapidscada-admin 1.0.0__py3-none-any.whl

rapidscada_admin-1.0.0.dist-info/METADATA

@@ -0,0 +1,187 @@
+Metadata-Version: 2.4
+Name: rapidscada-admin
+Version: 1.0.0
+Summary: Linux CLI for administering Rapid SCADA BaseDAT configuration files
+Author: rapidscada-admin contributors
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Shadow21AR/rapidscada-admin
+Project-URL: Repository, https://github.com/Shadow21AR/rapidscada-admin
+Project-URL: Issues, https://github.com/Shadow21AR/rapidscada-admin/issues
+Keywords: rapidscada,scada,basdat,industrial,admin
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# rapidscada-admin
+
+[![CI](https://github.com/Shadow21AR/rapidscada-admin/actions/workflows/ci.yml/badge.svg)](https://github.com/Shadow21AR/rapidscada-admin/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/rapidscada-admin)](https://pypi.org/project/rapidscada-admin/)
+[![Python](https://img.shields.io/pypi/pyversions/rapidscada-admin)](https://pypi.org/project/rapidscada-admin/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+A Linux command-line utility for administering [Rapid SCADA](https://rapidscada.org/) v6 BaseDAT configuration files.
+
+## What is Rapid SCADA?
+
+[Rapid SCADA](https://rapidscada.org/) is an open-source industrial automation and SCADA system. It stores configuration — users, roles, rights, and other tables — in binary BaseDAT (`.dat`) files. Editing these files normally requires the Windows Administrator application. This tool fills the gap for Linux environments.
+
+## Why this tool?
+
+- Automate user management from shell scripts and Ansible playbooks
+- Inspect and modify `user.dat` without the Windows GUI
+- Validate file integrity before and after changes
+- Export/import user data as JSON for backup and migration
+- No third-party dependencies — pure Python standard library
+
+## Supported platforms
+
+- **Linux** (primary target)
+- macOS / Windows (should work, but untested)
+
+Requires **Python 3.11+**.
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install rapidscada-admin
+```
+
+Or with [pipx](https://pypa.github.io/pipx/) (recommended for CLI tools):
+
+```bash
+pipx install rapidscada-admin
+```
+
+### From source
+
+```bash
+git clone https://github.com/Shadow21AR/rapidscada-admin.git
+cd rapidscada-admin
+pip install .
+```
+
+For development:
+
+```bash
+pip install -e ".[dev]"
+```
+
+### Verify installation
+
+```bash
+rapidscada-admin --version
+```
+
+## Usage
+
+Every command takes the `.dat` file path as a positional argument. No files are hardcoded.
+
+```bash
+rapidscada-admin <command> <subcommand> <file> [options]
+```
+
+### User management
+
+```bash
+# List all users
+rapidscada-admin users list user.dat
+
+# Show one user
+rapidscada-admin users show user.dat --user admin
+
+# Add a user
+rapidscada-admin users add user.dat \
+    --name operator \
+    --password 'S3cur3P@ss!' \
+    --role 2 \
+    --description "Shift operator"
+
+# Delete a user
+rapidscada-admin users delete user.dat --user operator
+
+# Rename a user
+rapidscada-admin users rename user.dat --old-name operator --new-name op2
+
+# Change password
+rapidscada-admin users passwd user.dat --user admin --password 'NewP@ssw0rd!'
+
+# Enable / disable account
+rapidscada-admin users enable user.dat --user admin
+rapidscada-admin users disable user.dat --user admin
+```
+
+### Export and import
+
+```bash
+# Export all users to JSON
+rapidscada-admin users export user.dat > users.json
+
+# Import users from JSON
+rapidscada-admin users import user.dat --input users.json
+```
+
+### Password hashing
+
+Compute a Rapid SCADA password hash without modifying any file:
+
+```bash
+rapidscada-admin hash --password secret
+rapidscada-admin hash --user-id 11 --password scada
+```
+
+### Validation
+
+Check a BaseDAT file for corruption, schema errors, and duplicate entries:
+
+```bash
+rapidscada-admin verify user.dat
+```
+
+Exit code `0` means valid, `1` means errors found.
+
+## Safety
+
+Every mutating command follows a 7-step safety protocol:
+
+1. **Verify schema** — required fields (`UserID`, `Enabled`, `Name`, `Password`, `RoleID`) must be present
+2. **Create backup** — timestamped `.bak` file alongside the original
+3. **Write temporary file** — changes go to a temp file first
+4. **Re-read temporary file** — parse the file we just wrote
+5. **Validate** — check schema, duplicates, integrity
+6. **Atomic replace** — `os.replace()` ensures no partial writes
+7. **Report** — print the backup location
+
+A malformed `.dat` file can prevent Rapid SCADA from starting. **Always verify before and after operations.**
+
+## Limitations
+
+- Only supports BaseDAT format version 4.x (Rapid SCADA v6)
+- Does not support editing the Windows Administrator application's in-memory state
+- Password hashing uses MD5 (matching the Rapid SCADA protocol — not a general security recommendation)
+- Does not validate RoleID values against `role.dat` (role table is not yet supported)
+
+## Contributing
+
+Contributions are welcome. Please:
+
+1. Fork the repository
+2. Create a feature branch
+3. Add tests for new functionality
+4. Run `pytest` and `ruff check` before submitting
+5. Open a pull request
+
+## License
+
+[MIT](LICENSE)

rapidscada_admin-1.0.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+rapidscada_admin-1.0.0.dist-info/licenses/LICENSE,sha256=3ZPzquMbZUuiegoHIeYq0GPaivDKVingxiEsd-lWWfI,1086
+rapidscada_admin-1.0.0.dist-info/METADATA,sha256=s98fZWUJQxpTVaWYsXksrlyRA2jF35KQM4goBMV7ISA,5548
+rapidscada_admin-1.0.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+rapidscada_admin-1.0.0.dist-info/entry_points.txt,sha256=x7pRkEEhI2cHMJg3JrnRt6zA5s9b1UoSvAFeqU2tqjc,63
+rapidscada_admin-1.0.0.dist-info/top_level.txt,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+rapidscada_admin-1.0.0.dist-info/RECORD,,

rapidscada_admin-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (83.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

rapidscada_admin-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+rapidscada-admin = rapidscada_admin.cli:main

rapidscada_admin-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 rapidscada-admin contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

rapidscada_admin-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+