https://github.com/iamraphson/java-dumb-passwords
Guard your users against entering dumb passwords in your java or JavaEE apps
https://github.com/iamraphson/java-dumb-passwords
Last synced: 8 months ago
JSON representation
Guard your users against entering dumb passwords in your java or JavaEE apps
- Host: GitHub
- URL: https://github.com/iamraphson/java-dumb-passwords
- Owner: iamraphson
- License: mit
- Created: 2016-09-05T20:09:23.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-09-14T22:02:18.000Z (almost 10 years ago)
- Last Synced: 2025-07-07T22:10:54.136Z (12 months ago)
- Language: Java
- Homepage:
- Size: 55.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# java-dumb-passwords
> #### Guard your users from security problems by preventing them from having dumb passwords
### Introduction
This Artifact can be used to verify **the user provided password is not one of the top 10,000 worst passwords** as analyzed by a respectable IT security analyst. Read about all [here](https://xato.net/10-000-top-passwords-6d6380716fe0#.473dkcjfm), [here(wired)](http://www.wired.com/2013/12/web-semantics-the-ten-thousand-worst-passwords/) or [here(telegram)](http://www.telegraph.co.uk/technology/internet-security/10303159/Most-common-and-hackable-passwords-on-the-internet.html)
# Installation
## Prerequisites
- Java version Oracle JDK 7, 8 or OpenJDK 7
### Maven
Include the following in your `pom.xml` for Maven:
```xml
com.unicodelabs
java-dumb-passwords
1.0.0
```
###Jar-File
You can also download the jar file from the latest release on the [releases page](https://github.com/iamraphson/java-dumb-passwords/releases).
## Usage
A DumbPassword class provides one public method for checking dumb passwords. Instantianting the class is as given below:
```java
final DumbPassword dumbPasswords = new DumbPassword();
```
## API
#### dumbPasswords.checkPassword(string) => true or false
Check if the string provided, representing the user's proposed submitted password is not one of the
**top 10,000 worst passwords** users use. returns `true` if the password is one of them and `false` if the password is not.
```java
try {
if(dumbPasswords.checkPassword("gfdgfgghjgjghgk")){
System.out.println("This password is just too common. Please try another!");
} else {
//This password is awesome!
//This user SMART! Give them the Major key! #takeit!!
System.out.println("This password is awesome");
}
} catch (IOException ex) {
System.out.println(ex.getMessage());
} catch (IsNullException ex) {
System.out.println(ex.getMessage());
}
```
# Example
Here is an example
```java
package com.unicodelabs.jdp.core.example;
import com.unicodelabs.jdp.core.DumbPassword;
import com.unicodelabs.jdp.core.exceptions.IsNullException;
import java.io.IOException;
/**
*
* @author Raphson
*/
public class DumbPasswordClient {
public static void main(String[] args) {
DumbPassword dumbPasswords = new DumbPassword();
try {
if(dumbPasswords.checkPassword("gfdgfgghjgjghgk")){
System.out.println("This password is just too common. Please try another!");
} else {
//This password is awesome!
//This user SMART! Give them the Major key! #takeit!!
System.out.println("This password is awesome");
}
} catch (IOException ex) {
Logger.getLogger(App.class.getName()).log(Level.SEVERE, null, ex);
} catch (IsNullException ex) {
Logger.getLogger(App.class.getName()).log(Level.SEVERE, null, ex);
}
}
}
```
## Contributing
Please feel free to fork this package and contribute by submitting a pull request to enhance the functionalities.
## Security Vulnerabilities
If you discover a security vulnerability within Java-dumb-passwords java library , please send an e-mail to Ayeni Olusegun at nsegun5@gmail.com. All security vulnerabilities will be promptly addressed.
## How can I thank you?
Why not star the github repo? I'd love the attention! Why not share the link for this repository on Twitter or HackerNews? Spread the word!
Don't forget to [follow me on twitter](https://twitter.com/iamraphson)!
Thanks!
Ayeni Olusegun.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.