Skip to content

Secutils.dev is an open-source, versatile, yet simple toolbox for security-minded engineers

License

Notifications You must be signed in to change notification settings

riffus/secutils

 
 

Repository files navigation

Secutils.dev is an open-source, versatile, yet simple toolbox for security-minded engineers.

Refer to secutils-dev/secutils-webui for the web interface component of Secutils.dev.

Benefits

The main goal of this project is to provide security-minded engineers with a user-friendly, all-in-one toolbox for their day-to-day job that adheres to open security principles. You might want to consider Secutils.dev as a part of your usual development workflow for the following reasons:

  • Built by application security engineer for security-minded engineers
  • Carefully selected utilities that are commonly used in daily work
  • Guided experience for complex security concepts
  • Request bin, CSP builder, certificate generator, web scraper and more
  • Intuitive and customizable user interface

Getting started

Before running the Secutils.dev server locally, you need to provide several required parameters. The easiest way is to specify them through a local .env file:

# An authenticated session key. For example, can be generated with `openssl rand -hex 32`
SECUTILS_SESSION_KEY=a1a95f90e375d24ee4abb567c96ec3b053ceb083a4df726c76f8570230311c58

# Defines a pipe-separated (`|`) list of predefined users in the following format: `email:password:role`.
SECUTILS_BUILTIN_USERS=[email protected]:3efab73129f3d36e:admin

# Path to a local SQLite database file. Refer to https://github.com/launchbadge/sqlx for more details.
DATABASE_URL=sqlite:https:///home/user/.local/share/secutils/data.db

Once the .env file is created, you can start the Secutils.dev server with cargo run. By default, the server will be accessible via https://localhost:7070. Use curl to verify that the server is up and running:

curl -XGET https://localhost:7070/api/status
---
{"version":"1.0.0-alpha.1","level":"available"}

Usage

At this point, it is recommended to use the Secutils.dev APIs through the Web UI.

Re-initialize local database

To manage the local SQLite database, you need to install the SQLx's command-line utility:

cargo install --force sqlx-cli

# Drops, creates, and migrates the SQLite database
# referenced in the `DATABASE_URL` from the `.env` file.
sqlx database drop
sqlx database create
sqlx migrate run

Documentation

The documentation for Secutils.dev is located in github.com/secutils-dev/secutils-docs and hosted at secutils.dev/docs.

Community

About

Secutils.dev is an open-source, versatile, yet simple toolbox for security-minded engineers

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Rust 99.6%
  • Other 0.4%