Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gared/ether-scan
An etherpad scanner
https://github.com/gared/ether-scan
etherpad etherpad-lite scanner
Last synced: about 1 month ago
JSON representation
An etherpad scanner
- Host: GitHub
- URL: https://github.com/gared/ether-scan
- Owner: Gared
- License: apache-2.0
- Created: 2023-12-17T11:39:36.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-09-17T10:12:42.000Z (about 2 months ago)
- Last Synced: 2024-09-17T12:49:12.426Z (about 2 months ago)
- Topics: etherpad, etherpad-lite, scanner
- Language: PHP
- Homepage: https://scanner.etherpad.org
- Size: 169 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Etherscan (an etherpad scanner)
Use this tool to scan your [etherpad](https://etherpad.org) instance to get some insights and test if there is any misconfiguration.
What is this tool doing?
* Check the "Server" header to see if the revision of etherpad is returned
* Check the API version (pad.example.com/api)
* Check the etherpad version
* Check if the pads are publicly accessible
* Check if the server is healthy (pad.example.com/health)
* Check if the admin area is accessible with default credentials (pad.example.com/admin)
* Check if any (frontend) plugins are installed
* Check if the server is running since a long time (pad.example.com/stats)
## Try it out
You can try this tool out on the https://scanner.etherpad.org which is using this library.
## Requirements
You need PHP 8.1 or higher to run this tool.
## Usage
### Docker
Directly download and run this docker image to scan your instance
```bash
docker run --rm gared/ether-scan:main bin/console.php ether:scan http://localhost:9001
```
### Clone
Clone this repository and install dependencies
```bash
composer install
```
Next run this command to scan your instance
```bash
bin/console.php ether:scan http://localhost:9001
```
```console
Starting scan of api...
=======================
[INFO] No revision in server header
[INFO] api version: 1.3.0
Starting scan of a pad...
=========================
[INFO] Package version: 1.9.7
[OK] Pads are publicly accessible
[OK] Server is healthy
[INFO] Version is 1.9.7
[INFO] Server running since: 2024-03-08T21:38:56+00:00
Starting scan of admin area...
==============================
[OK] Admin area is not accessible with admin / admin
[OK] Admin area is not accessible with admin / changeme1
[OK] Admin area is not accessible with user / changeme1
Starting scan of plugins...
===========================
[INFO] No plugins found
```
### Composer
You can also install this tool with composer
```bash
composer require gared/ether-scan
```