Skip to content

An easy to use python based authentication system

License

Notifications You must be signed in to change notification settings

1to5pc/python-auth

Repository files navigation

GitHub Actions Workflow Status GitHub Actions Workflow Status

forthebadge forthebadge forthebadge

User Authentication System

This Python script provides a simple user authentication system with functionalities to initialize user accounts, test authentication, and manage user data securely.

Features

  • User Initialization: Initialize user accounts with usernames, passwords, and salt for enhanced security.
  • Authentication Testing: Test user authentication by providing a username and password.
  • Quiet Mode: Enable quiet mode to suppress unnecessary output during authentication testing.
  • Configuration Options: Configure parameters such as quiet mode, hashing algorithm, and salt size through a configuration file.

Setup

  1. Clone the Repository: Clone this repository to your local machine.
git clone https://github.com/1to5pc/python-auth.git
  1. Install Dependencies: Ensure you have Python installed on your machine.

  2. Configuration: Customize the configuration parameters by editing the config.ini file.

Direct download of latest release

Download the usrcheck.py and hash.py files from the latest release below.

latest version

Usage

  1. Initialize User Accounts:

Run the script and select the option to initialize user accounts. Follow the prompts to create user accounts with usernames and passwords.

  1. Test Authentication:

Test user authentication by providing a username and password. Choose whether to enable quiet mode to suppress output during testing.

  1. Exit:

Exit the program when finished.

Configuration Options

  • Quiet Mode: Set to suppress unnecessary output during authentication testing.
  • Hashing Algorithm: Configure the hashing algorithm for password hashing (default is SHA256).
  • Salt Size: Set the size of the salt used for password hashing (default is 8).

Contributing

Contributions are welcome! If you have any suggestions, improvements, or feature requests, feel free to open an issue or submit a pull request.

Note

Ensure pull requests are directed at the development branch.

License

This project is licensed under the MIT License.

Feel free to customize and expand this documentation further based on your preferences and additional functionalities!