feat: Add ARMON-64

Author: TheAlexLichter

docs/ciphers/armon64.md

@@ -0,0 +1,44 @@
+# ARMON-64
+
+> A widely unknown cipher, mostly seen on "underground" sites and forums.
+  Neither the origin nor the creator are known. It has large similarities
+  to [AER-256](./aer256.md).
+
+## Cipher behavior information
+
+* Case sensitive? ✓
+* Deterministic? ✓
+* Alphabet: ```!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~¡¢£¤¥¦§¨©ª«¬­®¯°±²³´µ¶·¸¹º»¼½¾¿ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõö÷øùúûüýþÿ``` (All Unicode Characters using only 2 bytes (U+0000 - U+00FF)
+* Characters not in alphabet will: **throw an error**
+
+## Default options object
+
+```
+const options = {
+  key: '' // Must be at least 3 characters long!
+}
+```
+
+## Usage
+
+### Encoding
+
+#### Default
+
+```
+import armon64 from 'cipher-collection'
+
+
+console.log(armon64.encode('hey', { key: 'ABCDEF' })) // 1007.3509783549783
+```
+
+### Decoding
+
+#### Default
+
+```
+import armon64 from 'cipher-collection'
+
+
+console.log(armon64.decode('1007.3509783549783', { key: 'ABCDEF' })) // hey
+```

docs/index.md

@@ -19,4 +19,4 @@
 * [Multiplicative cipher](./ciphers/multiplicative.md)
 * [Affine](./ciphers/affine.md)
 * [AER-256](./ciphers/aer256.md)
-
+* [ARMON-64](./ciphers/armon64.md)

src/armon64.js

@@ -0,0 +1,21 @@
+import base from './helpers/aerArmonBase'
+
+const encode = (input, options = {}) => {
+  options = { ...DEFAULT_OPTIONS, ...options }
+  return base.encode(input, options)
+}
+
+const decode = (input, options = {}) => {
+  options = { ...DEFAULT_OPTIONS, ...options }
+  return base.decode(input, options)
+}
+
+const DEFAULT_OPTIONS = {
+  key: '',
+  failOnUnknownCharacter: true
+}
+
+export default {
+  encode,
+  decode
+}

src/index.js

@@ -9,6 +9,7 @@ import wolfenbuetteler from './wolfenbuetteler'
 import multiplicative from './multiplicative'
 import affine from './affine'
 import aer256 from './aer256'
+import armon64 from './armon64'
 
 export default {
   rot,
@@ -21,5 +22,6 @@ export default {
   wolfenbuetteler,
   multiplicative,
   affine,
-  aer256
+  aer256,
+  armon64
 }

test/armon64.test.js

@@ -0,0 +1,23 @@
+import armon64 from 'armon64'
+
+describe('encoding', () => {
+  test('default', () => {
+    expect(() => { armon64.encode('1007.3509783549783') }).toThrowError('Key is too short! It must be at least 3 characters')
+  })
+  test('with key', () => {
+    expect(armon64.encode('hey', { key: 'ABCDEF' })).toBe('1007.3509783549783')
+    expect(armon64.encode('hey!*A', { key: 'ABCDEF*' })).toBe('257752.02713419913+-40.0634632034632')
+    expect(armon64.encode('hey!*A!Ü!Ü!Ü!', { key: 'ABCDEF*' })).toBe('257752.02713419913+104300.3085800866+83571.0731861472+-41.65071861471861')
+  })
+})
+
+describe('decoding', () => {
+  test('default', () => {
+    expect(() => { armon64.decode('1432.382960035134') }).toThrowError('Key is too short! It must be at least 3 characters')
+  })
+  test('with key', () => {
+    expect(armon64.decode('1007.3509783549783', { key: 'ABCDEF' })).toBe('hey')
+    expect(armon64.decode('257752.02713419913+-40.0634632034632', { key: 'ABCDEF*' })).toBe('hey!*A')
+    expect(armon64.decode('257752.02713419913+104300.3085800866+83571.0731861472+-41.65071861471861', { key: 'ABCDEF*' })).toBe('hey!*A!Ü!Ü!Ü!')
+  })
+})