# nzism-passgen

> Generates and validates NZISM compliant passwords.

Latest version **0.1.1** (published 2022-04-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install nzism-passgen
pnpm add nzism-passgen
yarn add nzism-passgen
bun add nzism-passgen
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2022-04-05 |
| First published | 2020-04-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Cameron Tod |
| Maintainers | cam8001 |
| Keywords | nzism, password |

## Links

- npm: https://www.npmjs.com/package/nzism-passgen
- Repository: https://github.com/cam8001/nzism-passgen
- Issues: https://github.com/cam8001/nzism-passgen/issues
- npm.io page: https://npm.io/package/nzism-passgen

## Recent versions

- 0.1.1 (latest) — 2022-04-05
- 0.1.0 — 2022-04-03
- 0.0.11 — 2020-04-22
- 0.0.10 — 2020-04-19
- 0.0.9 — 2020-04-19
- 0.0.8 — 2020-04-19
- 0.0.7 — 2020-04-19
- 0.0.6 — 2020-04-19
- 0.0.5 — 2020-04-19
- 0.0.4 — 2020-04-19
- 0.0.3 — 2020-04-17
- 0.0.2 — 2020-04-16
- 0.0.1 — 2020-04-16

## README

# NZISM Compliant Password Generator

This package attempts to provide an up-to-date library for generating and validating NZISM compliant passwords.

Example randomly generated passwords:

    Reelection34#
    Isolable68@
    Aldermanic32%
    Ratiocinate77@


[![npm version](https://badge.fury.io/js/nzism-passgen.svg)](https://www.npmjs.com/package/nzism-passgen)
[![Coverage Status](https://coveralls.io/repos/github/cam8001/nzism-passgen/badge.svg?branch=master)](https://coveralls.io/github/cam8001/nzism-passgen?branch=master)
[![codebeat badge](https://codebeat.co/badges/cfb5741c-7eef-454d-9a79-599561494374)](https://codebeat.co/projects/github-com-cam8001-nzism-passgen-master)
[![CircleCI](https://circleci.com/gh/cam8001/nzism-passgen/tree/master.svg?style=svg)](https://circleci.com/gh/cam8001/nzism-passgen/tree/master)

## Usage

```javascript
const pg = require('nzism-passgen');

// Get a compliant password
console.log(pg.generatePassword());

// Validate an existing password
const password = 'notcompliant';
const isCompliant = pg.validatePassword(password);
console.log(`Password "${password}" compliant:`, isCompliant);
```

## Installation

In your app:

`npm install nzism-passgen`

or

`yarn add nzism-passgen`

## Password Standard

This standard has been derived from the NZISM, section 16.1.

The current version of the ISM can be found here: `https://www.nzism.gcsb.govt.nz/ism-document`

As of this writing, the most recent update to the ISM was  February 2020, v3.3.

As the standard defined there is not prescriptive, the rules below have been derived from the deprecated [NZ Government Authentication Standard](https://snapshot.ict.govt.nz/guidance-and-resources/standards-compliance/authentication-standards/password-standard/index.html)

- Minimum length of 10 characters
- Maximum length of 64 characters
- Mixed case
- A special character
- A number

---
_Source: https://npm.io/package/nzism-passgen · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._