# is-canonical-base64

> test wether a base64 string will serialize the same after parsing

Latest version **1.1.1** (published 2018-10-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install is-canonical-base64
pnpm add is-canonical-base64
yarn add is-canonical-base64
bun add is-canonical-base64
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2018-10-25 |
| First published | 2018-10-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Dominic Tarr |
| Maintainers | dominictarr |

## Links

- npm: https://www.npmjs.com/package/is-canonical-base64
- Repository: https://github.com/dominictarr/is-canonical-base64
- Issues: https://github.com/dominictarr/is-canonical-base64/issues
- npm.io page: https://npm.io/package/is-canonical-base64

## Recent versions

- 1.1.1 (latest) — 2018-10-25

## README

# is-canonical-base64

a regular expression to test wether a string is a valid base64,
without ambiguity.

Base64 encodes bytes (base 256, 8 bits each) as chars each representing
6 bits. That means a one byte buffer necessarily becomes 2 chars,
except only the top 2 bits of the last char are used (and the string
is then padded with an `==` to take the spaces those chars would be)

It's _recommended_ that implementations encode zeros here, but many
implementations (including node.js's) accept non-zeros here, but just
ignore them.

This can be a problem for _signed data_, because if the signature
signs base64, you must retain exactly the encoded representation
(including any ambiguity). So, it's good to enforce that ambigious
representations are rejected.

## usage

simple

```
var isCanonicalBase64 = require('canonical-base64')() //note, returns a function
isCanonicalBase64.test(string)
```

advanced: you may pass in a prefix and suffix, which is combined into the regular expression.

```
var isCanonicalBase64 = require('canonical-base64')('@', '(?:\.ed25519)')
isCanonicalBase64.test(string)
```

## License

MIT

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