Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arghyadeep-k/deno-password-checker
Password checking module for Deno🦕
https://github.com/arghyadeep-k/deno-password-checker
deno password password-check password-checker
Last synced: about 2 months ago
JSON representation
Password checking module for Deno🦕
- Host: GitHub
- URL: https://github.com/arghyadeep-k/deno-password-checker
- Owner: arghyadeep-k
- License: mit
- Created: 2021-05-29T15:44:38.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-08-04T01:03:04.000Z (over 3 years ago)
- Last Synced: 2024-10-12T16:28:20.152Z (3 months ago)
- Topics: deno, password, password-check, password-checker
- Language: TypeScript
- Homepage: https://deno.land/x/password_checker
- Size: 37.1 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Password Checker
[](https://github.com/arghyadeep-k/deno-password-checker/actions/workflows/deno-ci.yml)
[](https://sonarcloud.io/dashboard?id=arghyadeep-k_deno-password-checker)
[](https://sonarcloud.io/dashboard?id=arghyadeep-k_deno-password-checker)
[](https://sonarcloud.io/dashboard?id=arghyadeep-k_deno-password-checker)
[](https://sonarcloud.io/dashboard?id=arghyadeep-k_deno-password-checker)
[](https://sonarcloud.io/dashboard?id=arghyadeep-k_deno-password-checker)
[](https://sonarcloud.io/dashboard?id=arghyadeep-k_deno-password-checker)
[](https://sonarcloud.io/dashboard?id=arghyadeep-k_deno-password-checker)
[](https://ko-fi.com/arghyadeep)
Deno🦕 module to test if a password/string fulfills all the preset criterias.
## Installation
```typescript
import { checkPassword } from "https://deno.land/x/password_checker/mod.ts";
```
or
```typescript
import { checkPasswordWithResult } from "https://deno.land/x/password_checker/mod.ts";
```
## Parameters
### Mandatory Parameters:
- `password: string`
### Optional Parameters:
- `minLen: number` - To check the password against a minimum length. Defaults to
0 which disables the check.
- `maxLen: number` - To check the password against a maximum length. Defaults to
0 which disables the check.
- `containsNum: boolean` - To check if the password contains any numbers.
Defaults to true and enables the check.
- `containsSpecialChar: boolean` - To check if the password contains any special
characters. Defaults to true and enables the check.
- `containsAlphabet: boolean` - To check if the password contains any alphabets.
Defaults to true and enables the check.
- `checkWithCommonPasswords: boolean` - To check if the password is one of the
10000 most common passwords. Need to use `--allow-net` to use this flag.
Defaults to false and disables the check for faster processing.
## Output
- If `checkPassword()` is invoked:
- Returns `true` if password passes all the checks, else `false`.
- If `checkPasswordWithResult()` is invoked:
- `isValid: boolean` - `true` if the password is valid and passes all the
checks, else `false`.
- `reason: string` - The reason why the input password was marked as invalid.
Returns undefined in case `isValid` is `true`.`
## Usage
```typescript
import { checkPassword } from "https://deno.land/x/password_checker/mod.ts";
const passwordString: string = "randomPassword123!.";
let isPasswordValid: boolean;
// Default case which checks if password is alphanumeric and contains special characters
isPasswordValid = checkPassword({ password: passWordString });
// To set minimum length of password
isPasswordValid = checkPassword({ password: passwordString, minLen: 5 });
// To set maximum length of password
isPasswordValid = checkPassword({
password: passwordString,
minLen: 5,
maxLen: 12,
});
// To disable number check on password
isPasswordValid = checkPassword({
password: passwordString,
containsNum: false,
});
// To disable alphanumeric check on password
isPasswordValid = checkPassword({
password: passwordString,
containsNum: false,
containsAlphabet: false,
});
// To disable special characters check on password
isPasswordValid = checkPassword({
password: passwordString,
containsSpecialChar: false,
});
// To run a check against 10k common passwords
isPasswordValid = checkPassword({
password: passwordString,
containsSpecialChar: false,
checkWithCommonPasswords: true,
});
```
If you want the reason of failure as well, you can use
`checkPasswordWithResult()` which returns an object of type
`VerificationResult`.
```typescript
interface VerificationResult {
isValid: boolean;
reason?: string;
}
```
## Reference
- https://github.com/danielmiessler/SecLists/blob/master/Passwords/Common-Credentials/10k-most-common.txt
## License
This package is published under the MIT license. For more information, see the
accompanying LICENSE file.
---
### PS:
If you find this package useful, please consider giving a
[star](https://github.com/arghyadeep-k/deno-password-checker) to this project on
Github.
And, if you are willing to [buy me a coffee](https://ko-fi.com/arghyadeep), that
would be awesome. :)
