cpw.ts
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

cpw

Calculate the password entropy, difficulty level (number of alternative combinations), and estimate time needed to crack the password.

Hosted on cpw.surge.sh

Installation

Despite the github repo and domain on surge.sh CDN of this project is cpw, the npm package is called cpw.ts because the namespace cpw is already taken by another developer for another purpose. It is a pity.

npm install cpw.ts

Usage Example

import { cpw } from 'cpw.ts'

console.log(cpw('alice and bob'))
/*
{
  tickPerSecond: 10000000000,
  setSize: 59,
  length: 13,
  difficulty: 1.0497264767613244e+23,
  entropy: 76.47435964170394,
  seconds: 10497264767613.244,
  durationText: '332.63 Thousand Years'
}

*/

Typescript Signature

export function cpw(
  text: string,
  options?: {
    tickPerSecond?: number
  },
): CPWResult

export type CPWResult = {
  /** @description number of attempt per second to estimate time to crack the password */
  tickPerSecond: number
  /** @description number of possible characters, e.g. 10 for digits, 26 for lower case alphabets */
  setSize: number
  /** @description length of password */
  length: number
  /** @description number of possible combinations, i.e. setSize^length */
  difficulty: number
  /** @description number of bits, i.e. log(difficulty) / log(2) */
  entropy: number
  /** @description estimated number of seconds to crack the password */
  seconds: number
  /** @description estimated time to crack the password in human readable format, e.g. "12 Hours" */
  durationText: string
}

License

This project is licensed with BSD-2-Clause

This is free, libre, and open-source software. It comes down to four essential freedoms [ref]:

  • The freedom to run the program as you wish, for any purpose
  • The freedom to study how the program works, and change it so it does your computing as you wish
  • The freedom to redistribute copies so you can help others
  • The freedom to distribute copies of your modified versions to others

Package Sidebar

Install

npm i cpw.ts

Weekly Downloads

9

Version

1.0.0

License

BSD-2-Clause

Unpacked Size

13.1 kB

Total Files

11

Last publish

Collaborators

  • beenotung