npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

3n16m4-m4ch1n3

v0.0.2

Published

A modern interpretation of the infamous enigma machine

Downloads

7

Readme

3n16m4-m4ch1n3

A modern interpretation of the infamous enigma machine not limited by hardware and wiring.

For an accurate re-implementation of the original machine, see the amazing work by Daniel Palloks

Default state

const DEFAULT_CHARSET = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ .'.split('')

const DEFAULT_ROTORS = [
  { index: 1, id: 1 },
  { index: 1, id: 2 },
  { index: 1, id: 3 },
]

const DEFAULT_PLUGBOARD = null

cli

You can use the machine in your cli:

npm i -g 3n16m4-m4ch1n3
3n16m4-m4ch1n3 -m "HELLO WORLD"

will output: BIMSUK .VOO

if you:

3n16m4-m4ch1n3 -m "BIMSUK .VOO"

you'll get: HELLO WORLD

magic ✨

cli options

-m: required, message to be encoded

-r: rotors in format "id-index id-index"

-c: charset as quoted string "CHARSET"

-p: plugboard in format "char-char char-char"

-v: print updated rotor state

Example:

3n16m4-m4ch1n3 \
-r "1-25 2-12 3-25" \
-c "qwertyuiopasdfghjklzxcvbnm ." \
-p "e-l o-h" \
-m "hello world"

outputs: v abuitdyny

Of course then:

3n16m4-m4ch1n3 \
-r "1-25 2-12 3-25" \
-c "qwertyuiopasdfghjklzxcvbnm ." \
-p "e-l o-h" \
"v abuitdyny"

outputs: hello world

module

The package exports a single function machine, you can use it as follows:

import { machine } from '3n16m4-m4ch1n3'

const { encodedMessage, rotors } = machine({
  message: 'HELLO WORLD',
})

You can optionally pass rotors, custom charset and plugboard. See type definition for details.

Dependencies

This package requires crypto (required by seedrandom)

Implementation details

As this package offers a HUGE variety of configurations (far more than the original machines), generating all possible configuration ahead of time would have required a limitation on charset choices as well as number of rotors.

Instead it uses a seeded random via seedrandom, based on machine configuration to create the rotor mappings at runtime.

This allows for a huge variety of possible configurations.

This is not an exact replica of the inner working of any enigma machine version, rather an approximation that expands on the possible number of configurations.

Notable differences to original design

  • A letter can become itself
  • Character set is not limited to 26 latin chars
  • Lowercase and uppercase characters are not the same
  • Used rotor number is not limited to 3
  • Choice of available rotors is not limited to 7
  • Plugboard expands with character set