terrorizer1980 / security-hall

A small and easy to use bug recognition display

Security Hall

About

Ever needed a simple way to acknowledge reporters who have found issues in your software? This project does just that. It provides a clean web page that displays any security reports submitted via a easy to use REST API. The records are stored in a small on-disk database, powered by sled and the web side is handled by warp.

By default, a basic CSS stylesheet is provided, but it can be configured for whatever needs or theming desired by the user.

Admin Interface

To add, remove, or update reports inside the record store, the admin REST API is used. It can be located at http://host/admin/ and it has 4 endpoints:

• /list - Lists all the current records in JSON form
• /add - Add the provided record in the request body to the database
• /remove/{ID} - Remove the corresponding record to the ID provided
• /update - Update a record with the provided ID and body.

By default the interface is disabled, but can easily be enabled by uncommenting the bottom section of the config file. All requests to the API must include an application/json header and then a Authorization header that contains a key registered in the config. To see the structure of record addition/updating, see below (Any values with Option<> around them aren't required):

Field Specific Details

• id is only used when updating a record to select a record, it is ignored elsewhere. IDs can be found under the /admin/list endpoint.
• reference_id is purely for arbitrary internal use, maybe relating to to a writeup. It is not publically visible.
• date is optional, submitted in the form of Y-M-D. If not present, the current system date will be used.
• reporter_handle is optional when creating or updating a record. If not present, nothing will be shown next the reporter's name.

{
    "id": 92811,
    "reference_id": 1,
    "affected_service": "Some System",
    "date": "2019-08-24",
    "summary": "An issue...",
    "reporter": "Somebody",
    "reporter_handle": "@Maybe",
}

Config Layout

Explanations of what values do, and more detail on setting up the admin interface, are located in the default config.

Building and Setup

Prerequisites: Have a Rust toolchain installed.

1. Clone the repository to a directory and cd to it.
2. Copy default_config.toml to config.toml and modify values as needed.
3. Run cargo run to build and start the project, or cargo build --release if you want a production binary.
4. Use the admin API for record manipulation

License

This entire project falls under the MIT License and may be used as such