number_station 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 307e4f7227c11f3a5f102d751834125e78313460b0687db0b66fc27767119412
-  data.tar.gz: fcc9d8d383ab9858bfb8b641598ccac627e8710d3486832cb96331bf9b44e6ef
+  metadata.gz: 12fbb0f21da5b3c4b4b30f59c3966b73f105b114598465657a00dde4602f2200
+  data.tar.gz: 016fe96066f8a08eae780630d2049537ebe6118af9c16cb37e0b2ea0acd3dbee
 SHA512:
-  metadata.gz: 3604feb7f2e4e0a40c68d934112a0ca59b418b8a1858613f5e94e0d3b33933d9548cb316f63d64b1cde68dd7abe3e59c9ed4f1bd474d37503622037d086dc40c
-  data.tar.gz: bee70668d29379c88b725ef7328a8a6af982b7299b888a6fbba7576f1da0f59c00451e04f0eb9e1df586bac4002274910fae7755c67290a85b650b4146d556a6
+  metadata.gz: ca0a3954b8b78bef7f6b96707ba33bf5806a760cb80db3ed6e4158952163b55afd5805991c5dff381832842dc822d0c1f1558cf85b56d5cad942b3a4d57c9276
+  data.tar.gz: f2a30d75eb9dadb26e3fdbcf277be8403ba0449e209517f4188ad10769522438852382c96103d8bb69c0991e4269a3d92676a4ccbda18458b75dba57ab9bb9a7

data/README.asciidoc

@@ -1,6 +1,8 @@
 == number_station ==
 This gem (WIP) contains a number of utilities to aid in the running of a number station.
 
+image:https://badge.fury.io/rb/number_station.svg["Gem Version", link="https://badge.fury.io/rb/number_station"]
+
 === Contributing ===
 Contributions are welcome, please fork the repo, create a branch, add your code, and make a PR
 against master on this repo.

data/config/conf.json

@@ -7,6 +7,7 @@
     "port":8080
   },
   "resources":{
+    "espeak_sentence_template":"/tmp/GLaDOS_template.xml",
     "path":"resources",
     "intro":"intro.txt",
     "message":"message.txt",

data/lib/number_station/cli.rb

@@ -25,6 +25,7 @@ require 'fileutils'
 module NumberStation
   class CLI < Thor
     
+
     # create_config
     desc "create_config [--path PATH]", "copy the sample config to current directory."
     long_desc <<-CREATE_CONFIG_LONG_DESC
@@ -59,20 +60,22 @@ module NumberStation
     end
 
 
-    # convert_message
-    desc "convert_message [MESSAGE]", "Convert a message to phonetic output."
+    # convert_to_phonetic
+    desc "convert_to_phonetic [MESSAGE]", "Convert a message to phonetic output."
     long_desc <<-CONVERT_MESSAGE_LONG_DESC
       convert_message takes a parameter which should point to a text file containing a message.
       Optional parameters:\n
+        MESSAGE\n
         --intro [INTRO] should be a text file containing intro message.\n
-        --outro [OUTRO] should be a text file containing the outro message.
+        --outro [OUTRO] should be a text file containing the outro message.\n
+        --mp3 [MP3] output message as an mp3 file.
      
       Final message will be created from intro + message + outro
     CONVERT_MESSAGE_LONG_DESC
     option :intro, :type => :string
     option :outro, :type => :string
     option :mp3, :type => :string
-    def convert_message(message)
+    def convert_to_phonetic(message)
       NumberStation::ConfigReader.read_config()
 
       intro_path = options[:intro]
@@ -82,38 +85,36 @@ module NumberStation
       NumberStation.log.debug "intro_path: #{intro_path}" if options[:intro]
       NumberStation.log.debug "message_path: #{message_path}"
       NumberStation.log.debug "outro_path: #{outro_path}" if options[:outro]
-      NumberStation.log.debug "mp3_output: " if options[:mp3]
+      NumberStation.log.debug "mp3_path: #{mp3_path}" if options[:mp3]
 
       output = ""
-      output += NumberStation.read_message(intro_path) if options[:intro]
-      output += NumberStation.read_message(message_path)
-      output += NumberStation.read_message(outro_path) if options[:outro]
-
+      output += NumberStation.to_phonetic(intro_path) if options[:intro]
+      output += NumberStation.to_phonetic(message_path)
+      output += NumberStation.to_phonetic(outro_path) if options[:outro]
       NumberStation.log.info "output: #{output}"
 
       if options[:mp3]
         NumberStation.log.debug "Generating mp3 output: #{mp3_path}"
-        NumberStation.run(output, mp3_path)
+        NumberStation.write_mp3(output, mp3_path)
       end
-
       return output
     end
 
 
-    # convert_message
-    desc "make_one_time_pad [--path PATH --num NUM --length LENGTH]", "Generate a one time pad of LENGTH containing NUM entries"
+    # make_one_time_pad
+    desc "make_one_time_pad [--path PATH --numpads NUM --length LENGTH]", "Generate a one time pad of LENGTH containing NUM entries"
     long_desc <<-MAKE_ONE_TIME_PAD_LONG_DESC
     Generate a one time pad of LENGTH containing NUM entries
-    Optional parameters:\n
+    Parameters:\n
       --path PATH\n
-      --num NUM\n
+      --numpads NUM\n
       --length LENGTH
 
-    If no parameters are passed it will generate a single one time pad in the current 
+    If no parameters are passed it will generate 5 one time pads in the current 
     directory of size 250 characters.
     MAKE_ONE_TIME_PAD_LONG_DESC
     option :length, :type => :numeric
-    option :num_pads, :type => :numeric
+    option :numpads, :type => :numeric
     option :path, :type => :string
     def make_one_time_pad()
       NumberStation::ConfigReader.read_config()
@@ -122,13 +123,71 @@ module NumberStation
       length = options[:length]
       num_pads = options[:num_pads]
       path = options[:path]
-
       NumberStation.log.debug "length: #{length}" if options[:length]
-      NumberStation.log.debug "num_pads: #{num_pads}" if options[:num_pads]
+      NumberStation.log.debug "numpads: #{numpads}" if options[:numpads]
       NumberStation.log.debug "path: #{path}" if options[:path]
 
       NumberStation.make_otp(path, length, num_pads)
     end
 
+
+    # encrypt message with a pad
+    desc "encrypt_message [MESSAGE --numpad NUMPAD --padpath PADPATH]", "Encrypt a message using the key: NUMPAD in one time pad PADPATH"
+    long_desc <<-ENCRYPT_MESSAGE_LONG_DESC
+    Encrypt a message using key NUMPAD in one-time-pad PADPATH
+    Parameters:\n
+      MESSAGE
+      --numpad NUMPAD\n
+      --padpath PADPATH
+
+    ENCRYPT_MESSAGE_LONG_DESC
+    option :numpad, :type => :string
+    option :padpath, :type => :string
+    def encrypt_message(message)
+      NumberStation::ConfigReader.read_config()
+      NumberStation.log.debug "encrypt_message"
+
+      message_data = File.read(message)
+      numpad = options[:numpad]
+      padpath = options[:padpath]
+
+      NumberStation.log.debug "message: #{message}" if options[:message]
+      NumberStation.log.debug "numpad: #{numpad}" if options[:numpad]
+      NumberStation.log.debug "padpath: #{padpath}" if options[:padpath]
+
+      enc_m = NumberStation.encrypt_message(message_data, padpath, numpad)
+      NumberStation.log.debug "encrypted_message: #{enc_m}"
+    end
+
+
+    # decrypt message with a pad
+    desc "encrypt_message [MESSAGE --numpad NUMPAD --padpath PADPATH]", "Decrypt a message using the key: NUMPAD in one time pad PADPATH"
+    long_desc <<-DECRYPT_MESSAGE_LONG_DESC
+    Encrypt a message using key NUMPAD in one-time-pad PADPATH
+    Parameters:\n
+      MESSAGE
+      --numpad NUMPAD\n
+      --padpath PADPATH
+
+    DECRYPT_MESSAGE_LONG_DESC
+    option :numpad, :type => :string
+    option :padpath, :type => :string
+    def decrypt_message(message)
+      NumberStation::ConfigReader.read_config()
+      NumberStation.log.debug "decrypt_message"
+
+      message_data = File.read(message)
+      numpad = options[:numpad]
+      padpath = options[:padpath]
+
+      NumberStation.log.debug "message: #{message}" if options[:message]
+      NumberStation.log.debug "numpad: #{numpad}" if options[:numpad]
+      NumberStation.log.debug "padpath: #{padpath}" if options[:padpath]
+
+      decrypt_m = NumberStation.decrypt_message(message_data, padpath, numpad)
+      NumberStation.log.debug "decrypted_message: #{decrypt_m}"
+    end
+
+
   end
 end

data/lib/number_station/decrypt_message.rb

@@ -0,0 +1,71 @@
+=begin
+ Ruby Number Station
+ Author: David Kirwan https://gitub.com/davidkirwan
+ Licence: GPL 3.0
+ NumberStation is a collection of utilities to aid in the running of a number station
+    Copyright (C) 2018  David Kirwan
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+=end
+require "securerandom"
+require "json"
+
+module NumberStation
+  
+  def self.decrypt_message(message, pad_path, pad_num)
+    message = message || "This is a secret message"
+    NumberStation.log.debug "message length: #{message.size}"
+    message_byte_array = message.scan(/.{1}/).each_slice(2).map { |f, l| (Integer(f,16) << 4) + Integer(l,16) } 
+    #message.unpack('U*')
+    #NumberStation.log.debug "#{message_byte_array.inspect}"
+
+    begin
+      pad_data = JSON.parse(File.read(pad_path))
+    rescue Exception => e
+      raise e
+    end
+
+    #crypto_hex_str = SecureRandom.hex(message.size)
+    crypto_hex_str = pad_data["pads"][pad_num]
+
+    NumberStation.log.debug "message length less than pad length: #{message.size <= crypto_hex_str.size}"
+
+    #puts crypto_hex_str
+    crypto_byte_array = crypto_hex_str.scan(/.{1}/).each_slice(2).map { |f, l| (Integer(f,16) << 4) + Integer(l,16) }
+    #puts crypto_byte_array.inspect
+
+    #encrypted_byte_array = []
+    #message_byte_array.each_with_index do |i, index|
+    #  encrypted_byte_array << (i ^ crypto_byte_array[index])
+    #end
+    #puts encrypted_byte_array.inspect
+
+    #encrypted_byte_str = encrypted_byte_array.each.map {|i| i.to_s(16)}.join
+    #encrypted_byte_array_two = encrypted_byte_str.scan(/.{1}/).each_slice(2).map { |f, l| (Integer(f,16) << 4) + Integer(l,16) }
+
+    decrypted_byte_array = []
+    message_byte_array.each_with_index do |i, index|
+      decrypted_byte_array << (i ^ crypto_byte_array[index])
+    end
+    #puts decrypted_byte_array.inspect
+
+    decrypted_string = decrypted_byte_array.pack('U*').force_encoding('utf-8')
+    #puts decrypted_string
+
+    #puts message == decrypted_string
+
+    return decrypted_string
+  end
+
+end

data/lib/number_station/encrypt_message.rb

@@ -0,0 +1,71 @@
+=begin
+ Ruby Number Station
+ Author: David Kirwan https://gitub.com/davidkirwan
+ Licence: GPL 3.0
+ NumberStation is a collection of utilities to aid in the running of a number station
+    Copyright (C) 2018  David Kirwan
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+=end
+require "securerandom"
+require "json"
+
+module NumberStation
+  
+  def self.encrypt_message(message, pad_path, pad_num)
+    puts message
+    message = message || "This is a secret message"
+    NumberStation.log.debug "message length: #{message.size}"
+    message_byte_array = message.unpack('U*')
+    #NumberStation.log.debug "#{message_byte_array.inspect}"
+
+    begin
+      pad_data = JSON.parse(File.read(pad_path))
+    rescue Exception => e
+      raise e
+    end
+
+    #crypto_hex_str = SecureRandom.hex(message.size)
+    crypto_hex_str = pad_data["pads"][pad_num]
+
+    NumberStation.log.debug "message length less than pad length: #{message.size <= crypto_hex_str.size}"
+
+    #puts crypto_hex_str
+    crypto_byte_array = crypto_hex_str.scan(/.{1}/).each_slice(2).map { |f, l| (Integer(f,16) << 4) + Integer(l,16) }
+    #puts crypto_byte_array.inspect
+
+    encrypted_byte_array = []
+    message_byte_array.each_with_index do |i, index|
+      encrypted_byte_array << (i ^ crypto_byte_array[index])
+    end
+    #puts encrypted_byte_array.inspect
+
+    encrypted_byte_str = encrypted_byte_array.each.map {|i| i.to_s(16)}.join
+    #encrypted_byte_array_two = encrypted_byte_str.scan(/.{1}/).each_slice(2).map { |f, l| (Integer(f,16) << 4) + Integer(l,16) }
+
+    #decrypted_byte_array = []
+    #encrypted_byte_array_two.each_with_index do |i, index|
+    #  decrypted_byte_array << (i ^ crypto_byte_array[index])
+    #end
+    #puts decrypted_byte_array.inspect
+
+    #decrypted_string = decrypted_byte_array.pack('U*').force_encoding('utf-8')
+    #puts decrypted_string
+
+    #puts message == decrypted_string
+
+    return encrypted_byte_str
+  end
+
+end

data/lib/number_station/{make_pad.rb → make_onetime_pad.rb}

@@ -24,8 +24,8 @@ require "json"
 module NumberStation
   def self.make_otp(pad_path, length, num_pads)
     path = pad_path || Dir.pwd
-    len = length.to_i || 250
-    num = num_pads.to_i || 5
+    len = length || 250
+    num = num_pads || 5
 
     NumberStation.log.debug "make_otp"
     pads = {}
@@ -33,7 +33,7 @@ module NumberStation
     file_name = File.join(path, "one_time_pad_#{id}.json")
     NumberStation.log.debug "file_name: #{file_name}"
 
-    0.upto(num - 1) {|i| pads[i] = SecureRandom.hex(len)}
+    0.upto(num.to_i - 1) {|i| pads[i] = SecureRandom.hex(len.to_i)}
     one_time_pads = {
       :id=> id,
       :pads=> pads
@@ -46,6 +46,5 @@ module NumberStation
     else
       raise Exception.new("Exception #{file_name} already exists")
     end
-
   end
 end

data/lib/number_station/{alphabet.rb → phonetic_conversion.rb}

@@ -60,7 +60,8 @@ module NumberStation
     'z' => "zulu"
   }
 
-  def self.lookup(c)
+
+  def self.lookup_phonetic(c)
     begin
       return NumberStation::ALPHABET[c] + ' ' || ' '
     rescue Exception => e
@@ -68,4 +69,65 @@ module NumberStation
     end
   end
 
+
+  def self.espeak_word_template(word)
+    return "<prosody pitch=\"#{randomsign() + rand(0..200).to_s}\">#{word}</prosody>"
+  end
+
+
+  def self.randomsign()
+    return rand(0..1) == 0 ? "-" : "+"
+  end
+
+
+  def self.generate_sentence(message)
+    sentence = ""
+    message.split(" ").each {|i| sentence += espeak_word_template(i)}
+    return "<speak version=\"1.0\" xmlns=\"\" xmlns:xsi=\"\" xsi:schemaLocation=\"\" xml:lang=\"\"><voice gender=\"female\">#{sentence}</voice></speak>"
+  end
+
+
+  def self.write_espeak_template_file(filename, sentence)
+    f = File.open(filename, "w")
+    f.write(sentence)
+    f.close
+  end
+
+
+  def self.call_espeak(input_file_path, output_file_path)
+    cmd = "espeak -ven+f3 -m -p 60 -s 180 -f #{input_file_path} --stdout | ffmpeg -i - -ar 44100 -ac 2 -ab 192k -f mp3 #{output_file_path}"
+
+    unless NumberStation.command?('espeak') || NumberStation.command?('ffmpeg')
+      NumberStation.log.error "number_station requires the espeak and ffmpeg utilities are installed in order to output an mp3 file."
+    else
+      `#{cmd}`
+    end
+  end
+
+
+  def self.write_mp3(message, output_file_path)
+    filename = NumberStation.data["resources"]["espeak_sentence_template"]
+    sentence = NumberStation.generate_sentence(message)
+    NumberStation.write_espeak_template_file(filename, sentence)
+    NumberStation.call_espeak(filename, output_file_path)
+  end
+
+
+  def self.to_phonetic(file_name)
+    message = ''
+
+    f = File.open(file_name)
+    raw_message = f.readlines()
+    f.close()
+
+    raw_message.each do |i|
+      # puts i
+      i.gsub!(/\n/, "").strip.each_char do |c|
+        message += NumberStation.lookup_phonetic(c)
+      end
+    end
+    return message + "\n"
+  end
+
+
 end

data/lib/number_station/version.rb

@@ -20,5 +20,5 @@
 =end
 
 module NumberStation
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/number_station.rb

@@ -21,10 +21,12 @@
 require 'pastel'
 require 'json'
 require 'logger'
-require 'number_station/alphabet'
 require 'number_station/cli'
 require 'number_station/config_reader'
-require 'number_station/make_pad'
+require 'number_station/encrypt_message'
+require 'number_station/decrypt_message'
+require 'number_station/make_onetime_pad'
+require 'number_station/phonetic_conversion'
 require 'number_station/version'
 
 
@@ -64,67 +66,4 @@ module NumberStation
     return @data
   end
 
-  def self.word_template(word)
-    return "<prosody pitch=\"#{randomsign + rand(0..200).to_s}\">#{word}</prosody>"
-  end
-
-
-  def self.randomsign()
-    rand(0..1) == 0 ? "-" : "+"
-  end
-
-
-  def self.generate_sentence(message)
-    sentence = ""
-    message.split(" ").each do |i|
-      sentence += word_template(i)
-    end
-
-    sentence_template = "<speak version=\"1.0\" xmlns=\"\" xmlns:xsi=\"\" xsi:schemaLocation=\"\" xml:lang=\"\"><voice gender=\"female\">#{sentence}</voice></speak>"
-    return sentence_template
-  end
-
-
-  def self.write_template_file(filename, sentence)
-    f = File.open(filename, "w")
-    f.write(sentence)
-    f.close
-  end
-
-
-  def self.call_espeak(input_file_path, output_file_path)
-    cmd = "espeak -ven+f3 -m -p 60 -s 180 -f #{input_file_path} --stdout | ffmpeg -i - -ar 44100 -ac 2 -ab 192k -f mp3 #{output_file_path}"
-
-    unless NumberStation.command?('espeak') || NumberStation.command?('ffmpeg')
-      NumberStation.log.error "number_station requires the espeak and ffmpeg utilities are installed in order to output an mp3 file."
-    else
-      `#{cmd}`
-    end
-  end
-
-
-  def self.run(message, output_file_path)
-    filename = "/tmp/GLaDOS_tmp.xml"
-    sentence = NumberStation.generate_sentence(message)
-    NumberStation.write_template_file(filename, sentence)
-    NumberStation.call_espeak(filename, output_file_path)
-  end
-
-
-  def self.read_message(file_name)
-    message = ''
-
-    f = File.open(file_name)
-    raw_message = f.readlines()
-    f.close()
-
-    raw_message.each do |i|
-      # puts i
-      i.gsub!(/\n/, "").strip.each_char do |c|
-        message += NumberStation.lookup(c)
-      end
-    end
-    return message + "\n"
-  end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: number_station
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - David Kirwan
@@ -86,10 +86,12 @@ files:
 - bin/number_station
 - config/conf.json
 - lib/number_station.rb
-- lib/number_station/alphabet.rb
 - lib/number_station/cli.rb
 - lib/number_station/config_reader.rb
-- lib/number_station/make_pad.rb
+- lib/number_station/decrypt_message.rb
+- lib/number_station/encrypt_message.rb
+- lib/number_station/make_onetime_pad.rb
+- lib/number_station/phonetic_conversion.rb
 - lib/number_station/version.rb
 - number_station.gemspec
 - resources/body_message.txt