simple, elegant and safe
Introduction
PassAPI is a password generator in hash format and fully developed in Python, with the aim of teaching how to handle and build
-
Strong points:
- Token verification by authorization header
🎉 - Fully OpenSource
🎉 - Already comes with ratelimit
🎉 - Easy to understand
🎉 - Frequently updated
🎉
- Token verification by authorization header
-
Weak points:
- Possible lack of functions, but we will update with time
🔍
- Possible lack of functions, but we will update with time
Requirements
Recommended Python 3.6+
Developed in Python 3.10.1
Installation
$ pip install -r requirements.txt
--> 100%
Using
Starting
- Starting the
main.py, in your console it should work like this:
INFO: Started server process [2364]
INFO: Waiting for application startup.
INFO: Application startup complete.
INFO: Uvicorn running on http://127.0.0.1:8080 (Press CTRL+C to quit)
- Note: if this appears in your console, don't worry just add the hash in your .env
[!] You didn't generate a hash to protect your APIKEY, so we generated one for you!
[+] Here: "Hash"
[+] You should put it there in .env
Using the PassAPI
-
You will need some application to inject the API (REST Client), for example:
- REST Client which is an extension of Visual Studio Code
- You can use FastAPI application by accessing your server url and adding /docs
http://127.0.0.1/docs
-
and others...
Testing
- Here is an example POST (Using the REST Client):
POST http://127.0.0.1:8080/ HTTP/1.1
Content-Type: application/json
Authorization: "HASH"
{
"length": 5
}
- Output:
{
"detail": [
{
"password":"phG[P",
"timestamp":"2022-03-01 23:14:06"
}
]
}
- Note: The rate limit already configured is 50 requests in 1 minute, but you can change it in
/src/routers/routers.py
License
PassAPI is released under the MIT License. Check LICENSE file for more information.
576 Dec 29, 2022
84 Jan 4, 2023
34 Dec 23, 2022
9 Apr 29, 2022
110 Dec 27, 2022
4 Dec 14, 2021
1k Jan 1, 2023
3 Aug 24, 2022
6 May 15, 2022
4 Aug 2, 2022
6 Aug 22, 2022
11 Nov 15, 2022
75 Dec 28, 2022
79 Dec 19, 2022
1.1k Jan 7, 2023
2 Sep 26, 2022
2 Dec 8, 2021
34 Dec 31, 2022