Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emedvedev/enigma
Enigma cipher machine emulator (CLI + library) written in Go
https://github.com/emedvedev/enigma
cli emulator enigma enigma-cipher enigma-machine enigma-simulator
Last synced: 22 days ago
JSON representation
Enigma cipher machine emulator (CLI + library) written in Go
- Host: GitHub
- URL: https://github.com/emedvedev/enigma
- Owner: emedvedev
- Created: 2016-11-23T14:35:41.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-02-11T22:22:50.000Z (over 7 years ago)
- Last Synced: 2024-06-18T21:48:10.019Z (5 months ago)
- Topics: cli, emulator, enigma, enigma-cipher, enigma-machine, enigma-simulator
- Language: Go
- Homepage:
- Size: 39.1 KB
- Stars: 54
- Watchers: 4
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Enigma cipher machine emulator
This is a neat little emulator of various Enigma machines with a lot of
confugurable parameters. Somebody hurt your feelings by saying "my grandmother
encrypts better than you"? I've got you covered! With this port of the amazing
1940's technology you'll be just as good at encrypting things as anyone's
grandmother.
### Usage
This repository contains both the CLI tool and its underlying library written in Go.
The library is documented on [GoDoc](https://godoc.org/github.com/emedvedev/enigma).
As for the CLI tool, a simple `go get` should do it:
```
go get github.com/emedvedev/enigma/cmd/enigma
```
While the full CLI syntax is a bit verbose, it's actually possible to use the tool
without any source code modifications, config files, or Enigma knowledge:
```
enigma Never gonna give you up, never gonna let you down!
```
Using an Enigma machine with default settings is somewhat similar to
setting your password to `0000`. Let's up our security game:
```
enigma youtu.be/dQw4w9WgXcQ --rotors Beta VI I III --reflector C-Thin --plugboard AD SF ET RY HK JL QZ WX UM OP --rings 10 5 16 10
```
Much better! And of course, `enigma -h` will give you the complete description of
parameters and usage.
Importantly, since Enigma machines only have 26 keys, spaces are replaced with `X`,
and everything outside of the English alphabet is discarded. It's up to you to
come up with a suitable encoding.
Enjoy!
## Enigma models and features
Almost everything from the German Enigma machines can be configured in this
emulator:
* Rotor set: rotors from M3 and M4, the most famous Enigma machines, are
pre-loaded.
* Reflector: reflectors A, B, C (as well as thin B and C versions for M4) are
supported.
* Plugboard: any number of letter pairs is accepted. Plugboard configuration
is optional.
* Ring offsets and starting position of the rotors.
M3 and M4 can be fully emulated with the right parameters, and if it's
not enough, new rotors and reflectors can be added quite easily: just
add a new entry to the list in `rotors.go`, and that's it. Notches for
rotor turnover are optional.
Some exotic Enigma variants and implementations, as well
as devices such as Uhr, are not supported due to my chronic lack of
spare time. Your pull requests would be most welcome!
## Further reading
A bunch of material on Enigma machines, in no particular order. Explanations, specs,
other emulators.
- http://users.telenet.be/d.rijmenants/en/enigmatech.htm
- http://www.codesandciphers.org.uk/enigma/index.htm
- http://www.codesandciphers.org.uk/enigma/rotorspec.htm
- http://kerryb.github.io/enigma/
- http://enigma.louisedade.co.uk/enigma.html
- http://people.physik.hu-berlin.de/~palloks/js/enigma/enigma-u_v20_en.html