/password-check-strength

A simple package to check the password strength

Primary LanguageTypeScriptMIT LicenseMIT

Gitpod

NPM Version NPM Monthly Downloads

License Last Commit Language Most Used Implementations Repository Size

Forks Stars Watches

Welcome to password-check-strength 👋

🚧 password-check-strength in development... 🚧

A simple package to check the password strength

🔖 Table Of Contents


📃 About

Password Strength Algorithm

Password Length:
5 Points: Less than 4 characters
10 Points: 5 to 7 characters
25 Points: 8 or more
Letters:
0 Points: No letters
10 Points: Letters are all lower case
20 Points: Letters are upper case and lower case
Numbers:
0 Points: No numbers
10 Points: 1 number
20 Points: 3 or more numbers
Characters:
0 Points: No characters
10 Points: 1 character
25 Points: 3 or more characters
Bonus:
2 Points: Letters and numbers
3 Points: Letters, numbers, and characters
5 Points: Mixed case letters, numbers, and characters
Password Text Range:
>= 90: Very Secure
>= 80: Secure
>= 70: Very Strong
>= 60: Strong
>= 50: Average
>= 25: Weak
>= 0: Very Weak

Back To The Top


🤔 How To Use

import { checkStrength } from '@password-generator/password-check-strength';

import { generatePassword, Preferences } from '@password-generator/package';

const preferences: Preferences = {
  length: 12,
  useChars: {
    pronounceable: false,
    lowercase: true,
    uppercase: true,
    numbers: true,
    symbols: true,
  },
};

const password = generatePassword(preferences);

const result = checkStrength(password);

console.log(result);

Back To The Top


🚀 Technologies

  • Typescript
  • NodeJs

Back To The Top


🌱 Minimal Requirements

  • NodeJs
  • NPM/Yarn

Back To The Top


🎊 Features

🎇 Finished

  • Create the algorithm
  • Identify special characters automatically

Back To The Top


💡 How To Contribute

  • Make a fork of this repository
  • Clone to you machine and entry on respective paste
  • Create a branch with your resource: git checkout -b my-feature
  • Commit your changes: git commit -m 'feat: My new feature'
  • Push your branch: git push origin my-feature
  • A green button will appear at the beginning of this repository
  • Click to open and fill in the pull request information

Contributions, issues and features requests are welcome!
📮 Submit PRs to help solve issues or add features
🐛 Find and report issues
🌟 Star the project

Back To The Top


🤗 Contributors

Mikael-R mateushnsoares

Back To The Top


👤 Author

🤓 password-generator passgenerator.org@gmail.com

Back To The Top


🔏 License

Copyright © 2020 password-generator passgenerator.org@gmail.com

This project is licensed by MIT License.

Back To The Top


This README was generated with 💟 by readme-template-generator