An open API service indexing awesome lists of open source software.

https://github.com/arjunrn/passgen


https://github.com/arjunrn/passgen

Last synced: 10 months ago
JSON representation

Awesome Lists containing this project

README

          

## Password Generator
This project serves a HTTP REST API for generating passwords. The server is a REST API and the _passwords_ are accessible on the `/passwords` endpoint.
The endpoint takes the following parameters:

1. `length`: The minimum length of the password __(Default: 10)__
2. `digits`: The number of digits needed in the password __(Default: 2)__
3. `special_chars`: The number special characters in the password __(Default: 2)__
4. `convert_vowels`: The number of vowels which should be converted to digits. __(Default: 1)__
5. `options`: The number of password options to generate. __(Default: 3)__

### Docker container
There is a docker image provided which can run the application server.
To build run the command:
```
docker build -t passgen .
```

To run the build container run the command:
```
docker run --net=host passgen
```
This runs the container in the host networking namespace.

### Sample Commands:

All the parameters are optional and can be omitted. Example usage is as shown below:
```
curl http://localhost:8080/password?length=40&options=10
curl http://localhost:8080/password
curl http://localhost:8080/password?special_chars=10&digits=5&options=22
```