Skip to content

Latest commit

 

History

History
74 lines (57 loc) · 3.95 KB

README.md

File metadata and controls

74 lines (57 loc) · 3.95 KB
Raw

PasswordGenerator API

A password generator API written in Symfony 6

Use the API

https://password.markei.nl/human?count=10 to get a list of passwords, prefer a JSON output? Send a Accept: application/json header or add .json to the url (https://password.markei.nl/human.json?count=10). The following formats are available: html, json, xml, txt (plain)

Example

pw=`curl https://password.markei.nl/randomsave.txt`
echo %pw

Available endpoints

/human

Generates a password that is easy to remember for humans Available options:

  • count: number of passwords to generate (default: 1, limit: 1000)
  • source: source text to use, available: lipsum1, lipsum2, lipsum3, lipsum (default: lipsum)
  • minWordLength/maxWordLength: the number of letters in the password (default: 6)
  • removeLO: remove the letters "L" and "O" in words because people confuse them with the "I" and "0"
  • numberOfCaps: the maxium number of caps in the word
  • numberLength: the number of digits to at to the word

/randomsafe and /randomsafe2

Generates a password that is can be savely used in configuration files, passwords are long, has digits and chars, no symbols. randomsafe only includes lowercase chars, randomsafe2 also includes upercase chars. Available options:

  • count: number of passwords to generate (default: 1, limit: 1000)
  • min/max: the length of the password (default: 48)

/random

Generates a random password Available options:

  • count: number of passwords to generate (default: 1, limit: 1000)
  • min/max: the length of the password (default: 6)
  • lowercase: include lowercase chars (default: true)
  • uppercase: include uppercase chars (default: true)
  • digits: include digits chars (default: true)
  • symbols: include symbols chars (default: true)
  • onlyCommonSymbols: do not use symbols like quotes and accents (default: true)

/pincode

Generates a pincode (only digits) Available options:

  • count: number of pincodes to generate (default: 1, limit: 1000)
  • min/max: the length of the pincodes (default: 6)

/pair

Generates a password made of multiple pairs (xxxx-yyyy-zzzz) Available options:

  • count: number of pincodes to generate (default: 1, limit: 1000)
  • numberOfPairs: the number of pairs/parts (default: 6)
  • pairLength: the length of each pair/part (default: 4)
  • separator: the separator that will be placed between each pair (default -)
  • set: which type of chars are included digits only digits in each pair, chars only chars A to Z, mix mix digits and chars but not in the same pair, all mix digits and chars even in the same pair, hex only hex chars 0 to F (default: digits)
  • lowercase: set 1 to use lowercase chars instead of uppercase (default: false)

Install the API on your own domain

First install Composer

git clone git@github.com:Markei/password-generator-api.git
cd password-generator-api
composer install

Configure your webserver to serve this Symfony 6 project or use the Symfony local binary to run this project:

symfony server:start

Go to http://your-domain/human (or with the builtin server http://127.0.0.1:8000/human)

Change the limit

Override settings in the .env file in a new file named .env.local and change the value of this env variabele APP_GENERATION_LIMIT. You can also inject this env variabels via your webserver.