Module: Baseh

Defined in:
lib/baseh.rb,
lib/baseh/zero.rb,
lib/baseh/baseh.rb,
lib/baseh/basen.rb,
lib/baseh/errors.rb,
lib/baseh/feistel.rb,
lib/baseh/profile.rb,
lib/baseh/version.rb,
lib/baseh/checksum.rb,
lib/baseh/profiles.rb,
lib/baseh/profanity.rb

Overview

baseH (Human Reference Code) codec. See spec/IMPLEMENTATION_CODEC.md in the repository root for the normative specification.

Defined Under Namespace

Modules: BaseN, Checksum, Feistel, Profanity, Profile, Profiles, Zero Classes: Baseh, BasehError

Constant Summary collapse

VERSION = 
"1.1.0"

Class Method Summary collapse

Class Method Details

.baseh_heavy_p_v1(key_bytes:, key_id: "default", rounds: 8) ⇒ Object

baseh-heavy with feistel-v1 permutation. key_bytes is required.



59
60
61
 
# File 'lib/baseh.rb', line 59

def baseh_heavy_p_v1(key_bytes:, key_id: "default", rounds: 8)
  Profiles.baseh_heavy_p_v1(key_bytes: key_bytes, key_id: key_id, rounds: rounds)
end

.baseh_heavy_v1 ⇒ Object

Frozen tier baseh-heavy-v1: conservative alphabet plus spoken heavy, one checksum symbol. Permutation off.



54
55
56
 
# File 'lib/baseh.rb', line 54

def baseh_heavy_v1
  Profiles.baseh_heavy_v1
end

.baseh_light_p_v1(key_bytes:, key_id: "default", rounds: 8) ⇒ Object

baseh-light with feistel-v1 permutation. key_bytes is required.



37
38
39
 
# File 'lib/baseh.rb', line 37

def baseh_light_p_v1(key_bytes:, key_id: "default", rounds: 8)
  Profiles.baseh_light_p_v1(key_bytes: key_bytes, key_id: key_id, rounds: rounds)
end

.baseh_light_v1 ⇒ Object

Frozen tier baseh-light-v1: visual light plus spoken light, one checksum symbol. Permutation off.



32
33
34
 
# File 'lib/baseh.rb', line 32

def baseh_light_v1
  Profiles.baseh_light_v1
end

.baseh_medium_p_v1(key_bytes:, key_id: "default", rounds: 8) ⇒ Object

baseh-medium with feistel-v1 permutation. key_bytes is required.



48
49
50
 
# File 'lib/baseh.rb', line 48

def baseh_medium_p_v1(key_bytes:, key_id: "default", rounds: 8)
  Profiles.baseh_medium_p_v1(key_bytes: key_bytes, key_id: key_id, rounds: rounds)
end

.baseh_medium_v1 ⇒ Object

Frozen tier baseh-medium-v1: visual medium plus spoken medium, one checksum symbol. The default. Permutation off.



43
44
45
 
# File 'lib/baseh.rb', line 43

def baseh_medium_v1
  Profiles.baseh_medium_v1
end

.baseh_minimum_p_v1(key_bytes:, key_id: "default", rounds: 8) ⇒ Object

baseh-minimum with feistel-v1 permutation. key_bytes is required.



26
27
28
 
# File 'lib/baseh.rb', line 26

def baseh_minimum_p_v1(key_bytes:, key_id: "default", rounds: 8)
  Profiles.baseh_minimum_p_v1(key_bytes: key_bytes, key_id: key_id, rounds: rounds)
end

.baseh_minimum_v1 ⇒ Object

Frozen tier baseh-minimum-v1: alphanumeric with no strips, no checksum, hyphen-delimited XXX-XXX. Permutation off.



21
22
23
 
# File 'lib/baseh.rb', line 21

def baseh_minimum_v1
  Profiles.baseh_minimum_v1
end

.from_code(code) ⇒ Object

See Baseh::Zero.from_code.



67
68
69
 
# File 'lib/baseh/zero.rb', line 67

def from_code(code)
  Zero.from_code(code)
end

.to_code(id) ⇒ Object

See Baseh::Zero.to_code.



62
63
64
 
# File 'lib/baseh/zero.rb', line 62

def to_code(id)
  Zero.to_code(id)
end