Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skerwe/secrets-factory-password-generator
Secrets Factory - A Java Password Generator
https://github.com/skerwe/secrets-factory-password-generator
java-8 password-generator secrets-factory
Last synced: 2 days ago
JSON representation
Secrets Factory - A Java Password Generator
- Host: GitHub
- URL: https://github.com/skerwe/secrets-factory-password-generator
- Owner: Skerwe
- License: gpl-3.0
- Created: 2019-09-04T22:27:03.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-08-10T16:23:37.000Z (about 2 years ago)
- Last Synced: 2024-10-10T19:22:22.686Z (28 days ago)
- Topics: java-8, password-generator, secrets-factory
- Language: Java
- Homepage: https://skerwe.github.io/secrets-factory-password-generator/
- Size: 46.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Secrets Factory - Password Generator
[](https://openjdk.java.net/)
Generate configurable passwords using lowercase, uppercase, numbers and special characters.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
You will need Java 1.8 installed and [Apache Maven][maven] 3.6+ configured on your system path.
It's best to use the [OpenJDK][openjdk], Windows users can get binaries from [AdoptOpenJDK][adoptopenjdk].
### Installing
1. Clone or download the repository from GitHub:
```shell
git clone https://github.com/Skerwe/secrets-factory-password-generator.git
```
2. Compile, test and bundle the application:
```shell
mvn compile package
```
3. Execute the application:
```shell
java -cp target/secrets-factory-1.2-RELEASE-shaded.jar za.web.skerwe.factory.SecretsFactory
```
A default password of 12 lenght will be generated, consisting of 4 uppercase, 4 lowercase, 2 numbers and 2 special characters.
To configure the amount of characters:
```shell
java -cp target/secrets-factory-1.2-RELEASE-shaded.jar za.web.skerwe.factory.SecretsFactory -l 4 -u 3 -d 3 -s 2
```
Under the `target/` folder the *secrets-factory.jar* is the application without dependencies, the *secrets-factory-1.2-RELEASE-shaded.jar* is bundled with the dependencies.
## Running the Tests
The tests use [Junit][junit5] and the [Hamcrest][hamcrest] assertion library
```shell
mvn test
```
The test will run *Checkstyle*, *JaCoCo* and the *Surefire* test report plugins
Individual commands are listed below.
## Generating Reports
### Static Code Analysis
1. [PMD](https://pmd.github.io/) static code analyzer
```shell
mvn pmd:pmd
```
Results are in the `target/pmd.xml` file.
2. [Apache Maven Checkstyle Plugin](http://maven.apache.org/plugins/maven-checkstyle-plugin/)
```shell
mvn checkstyle:checkstyle
```
Results are in the `target/checkstyle-result.xml` file.
### Unit Test Report
```shell
mvn surefire:test
```
Results are in the `target/surefire-reports/` folder.
### Code Coverage
1. [JaCoCo](https://www.eclemma.org/jacoco/) Java Code Coverage Library
2. [Cobertura](https://cobertura.github.io/cobertura/)
[Cobertura Maven Plugin](https://www.mojohaus.org/cobertura-maven-plugin/)
```shell
mvn cobertura:cobertura
```
### Javadocs
```shell
mvn javadoc:javadoc
```
Results are in the `target/site/apidocs/` folder. See **mvn site:run** below.
### Project Site
Generate and run a static server to serve the site
```shell
mvn site:run
```
### Maven Dashboard
```shell
mvn site
mvn dashboard:dashboard
```
## Built With
* [Java](https://www.java.com/en/) programming language
* [Apache Maven][maven] build tool
* [Passay](https://github.com/vt-middleware/passay) - A password policy enforcement for Java
## License
This project is licensed under the GNU GPLv3 License - see the [LICENSE](LICENSE) file for details
[openjdk]: https://openjdk.java.net/
[adoptopenjdk]: https://adoptopenjdk.net/
[maven]: https://maven.apache.org/
[junit5]: https://junit.org/junit5/
[hamcrest]: http://hamcrest.org/JavaHamcrest/index