self_crypto 0.0.1

data/lib/self_crypto.rb

@@ -0,0 +1,14 @@
+require 'self_crypto/version'
+require 'self_crypto/self_crypto'
+require 'self_crypto/account'
+require 'self_crypto/session'
+require 'self_crypto/group_session'
+require 'self_crypto/olm_message'
+require 'self_crypto/message'
+require 'self_crypto/group_message'
+require 'self_crypto/pre_key_message'
+require 'self_crypto/sas'
+require 'self_crypto/utility'
+
+module SelfCrypto
+end

data/lib/self_crypto/account.rb

@@ -0,0 +1,30 @@
+require 'base64'
+
+module SelfCrypto
+
+  class Account
+
+    # @param pickle [String] pickled state
+    # @param password [String] password used to encrypt pickled state
+    # @return [Account]
+    def self.from_pickle(pickle, password="")
+      Account.new(pickle: pickle, password: password)
+    end
+
+    def self.from_seed(seed)
+      Account.new(seed: Base64.decode64(seed))
+    end
+
+    def gen_otk(number=1)
+      generate_one_time_keys(number)
+    end
+
+    alias_method :ik,       :identity_keys
+    alias_method :otk,      :one_time_keys
+    alias_method :mark_otk, :mark_keys_as_published
+    alias_method :max_otk,    :max_number_of_one_time_keys
+    alias_method :update_otk, :remove_one_time_keys
+
+  end
+
+end

data/lib/self_crypto/group_message.rb

@@ -0,0 +1,34 @@
+require 'base64'
+
+module SelfCrypto
+
+  class GroupMessage
+
+    # @param msg [String] base64 or bytes
+    def initialize(msg)
+      @value = msg
+      @data = JSON.parse(msg)
+    end
+
+    # @return [String] bytes
+    def to_bytes
+      Base64.decode64(value)
+    end
+
+    # @return [String] base64
+    def to_s
+      @value.dup
+    end
+
+    def get_message(identity)
+      h = @data['recipients'][identity]
+      if h['mtype'] == 0
+        PreKeyMessage.new(h['ciphertext'])
+      else
+        Message.new(h['ciphertext'])
+      end
+    end
+
+  end
+
+end

data/lib/self_crypto/group_session.rb

@@ -0,0 +1,8 @@
+require 'base64'
+
+module SelfCrypto
+
+  class GroupSession
+  end
+
+end

data/lib/self_crypto/message.rb

@@ -0,0 +1,6 @@
+module SelfCrypto
+
+  class Message < OlmMessage
+  end
+
+end

data/lib/self_crypto/olm_error.rb

@@ -0,0 +1,70 @@
+module SelfCrypto
+
+  module OlmError
+
+    class SUCCESS < StandardError
+    end
+
+    class NOT_ENOUGH_RANDOM < StandardError
+    end
+
+    class OUTPUT_BUFFER_TOO_SMALL < StandardError
+    end
+
+    class BAD_MESSAGE_VERSION < StandardError
+    end
+
+    class BAD_MESSAGE_FORMAT < StandardError
+    end
+
+    class BAD_MESSAGE_MAC < StandardError
+    end
+
+    class BAD_MESSAGE_KEY_ID < StandardError
+    end
+
+    class INVALID_BASE64 < StandardError
+    end
+
+    class BAD_ACCOUNT_KEY < StandardError
+    end
+
+    class UNKNOWN_PICKLE_VERSION < StandardError
+    end
+
+    class CORRUPTED_PICKLE < StandardError
+    end
+
+    class BAD_SESSION_KEY < StandardError
+    end
+
+    class UNKNOWN_MESSAGE_INDEX < StandardError
+    end
+
+    class BAD_LEGACY_ACCOUNT_PICKLE < StandardError
+    end
+
+    class BAD_SIGNATURE < StandardError
+    end
+
+    class OLM_INPUT_BUFFER_TOO_SMALL < StandardError
+    end
+
+    class UnknownError < StandardError
+    end
+
+    def self.from_string(str)
+      begin
+        OlmError.const_get(str)
+      rescue NameError
+        UnknownError.new str
+      end
+    end
+
+    def self.raise_from_string(str)
+      raise from_string(str)
+    end
+
+  end
+
+end

data/lib/self_crypto/olm_message.rb

@@ -0,0 +1,25 @@
+require 'base64'
+
+module SelfCrypto
+
+  class OlmMessage
+
+    # @param msg [String] base64 or bytes
+    def initialize(msg)
+      raise "abstract class" if self.class == OlmMessage
+      @value = msg
+    end
+
+    # @return [String] bytes
+    def to_bytes
+      Base64.decode64(value)
+    end
+
+    # @return [String] base64
+    def to_s
+      @value.dup
+    end
+
+  end
+
+end

data/lib/self_crypto/pre_key_message.rb

@@ -0,0 +1,6 @@
+module SelfCrypto
+
+  class PreKeyMessage < OlmMessage
+  end
+
+end

data/lib/self_crypto/sas.rb

@@ -0,0 +1,28 @@
+require_relative './sas_data'
+
+class SelfCrypto::SAS
+  METHODS = %i[decimal emoji]
+
+  def generate(method, info)
+    method = method.to_sym
+    raise ArgumentError, "Unknown SAS method: #{method}" unless METHODS.include? method
+
+    send method, info
+  end
+
+  protected
+
+  def decimal(info)
+    bytes = generate_bytes(5, info)
+    bits = bytes.unpack1('B39')
+    grouped = bits.chars.each_slice(13).map &:join
+    grouped.map {|s| s.to_i(2) + 1000}
+  end
+
+  def emoji(info)
+    bytes = generate_bytes(6, info)
+    bits = bytes.unpack1('B42')
+    grouped = bits.chars.each_slice(6).map &:join
+    grouped.map {|s| EMOJI_TABLE[s.to_i(2)]}.join
+  end
+end

data/lib/self_crypto/sas_data.rb

@@ -0,0 +1,71 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+class SelfCrypto::SAS
+  EMOJI_TABLE = {
+    0 => '🐶',
+    1 => '🐱',
+    2 => '🦁',
+    3 => '🐎',
+    4 => '🦄',
+    5 => '🐷',
+    6 => '🐘',
+    7 => '🐰',
+    8 => '🐼',
+    9 => '🐓',
+    10 => '🐧',
+    11 => '🐢',
+    12 => '🐟',
+    13 => '🐙',
+    14 => '🦋',
+    15 => '🌷',
+    16 => '🌳',
+    17 => '🌵',
+    18 => '🍄',
+    19 => '🌏',
+    20 => '🌙',
+    21 => '☁',
+    22 => '🔥',
+    23 => '🍌',
+    24 => '🍎',
+    25 => '🍓',
+    26 => '🌽',
+    27 => '🍕',
+    28 => '🎂',
+    29 => '❤',
+    30 => '😀',
+    31 => '🤖',
+    32 => '🎩',
+    33 => '👓',
+    34 => '🔧',
+    35 => '🎅',
+    36 => '👍',
+    37 => '☂',
+    38 => '⌛',
+    39 => '⏰',
+    40 => '🎁',
+    41 => '💡',
+    42 => '📕',
+    43 => '✏',
+    44 => '📎',
+    45 => '✂',
+    46 => '🔒',
+    47 => '🔑',
+    48 => '🔨',
+    49 => '☎',
+    50 => '🏁',
+    51 => '🚂',
+    52 => '🚲',
+    53 => '✈',
+    54 => '🚀',
+    55 => '🏆',
+    56 => '⚽',
+    57 => '🎸',
+    58 => '🎺',
+    59 => '🔔',
+    60 => '⚓',
+    61 => '🎧',
+    62 => '📁',
+    63 => '📌'
+  }
+end

data/lib/self_crypto/session.rb

@@ -0,0 +1,16 @@
+module SelfCrypto
+
+  class Session
+
+    # @param pickle [String] pickled state
+    # @param password [String] password used to encrypt pickled state
+    # @return [Session]
+    def self.from_pickle(pickle, password="")
+      Session.new(pickle, password)
+    end
+
+    alias_method :has_received?, :has_received_message
+
+  end
+
+end

data/lib/self_crypto/utility.rb

@@ -0,0 +1,7 @@
+module SelfCrypto
+
+  module Util
+
+  end
+
+end

data/lib/self_crypto/version.rb

@@ -0,0 +1,5 @@
+module SelfCrypto
+
+  VERSION="0.0.1"
+
+end

data/test/examples/test_bob_no_answer.rb

@@ -0,0 +1,62 @@
+require 'minitest/autorun'
+require 'self_crypto'
+
+class TestExchange < Minitest::Test
+
+  include SelfCrypto
+
+  # Alice -> Bob
+  # Alice -> Bob
+  #
+  def test_bob_no_answer
+
+    alice = Account.new
+    bob = Account.new
+
+    # Alice wants to send a message to Bob
+    alice_msg = "hi bob"
+
+    # Bob generates a one-time-key
+    bob.gen_otk
+
+    # Alice must have Bob's identity and one-time-key to make a session
+    alice_session = alice.outbound_session(bob.ik['curve25519'], bob.otk['curve25519'].values.first)
+
+    # Bob marks all one-time-keys as published
+    bob.mark_otk
+
+    # Alice can encrypt
+    encrypted = alice_session.encrypt(alice_msg)
+    assert_instance_of PreKeyMessage, encrypted
+
+    # Bob can create a session from this first message
+    bob_session = bob.inbound_session(encrypted)
+
+    # Bob can now update his list of marked otk (since he knows one has been used)
+    bob.update_otk(bob_session)
+
+    # Bob can decrypt Alice's message
+    bob_msg = bob_session.decrypt(encrypted)
+
+    assert_equal alice_msg, bob_msg
+
+    # At this point Bob has received but Alice hasn't
+    assert bob_session.has_received?
+    refute alice_session.has_received?
+
+    ###
+
+    # Alice sends another message before reply from Bob
+    alice_msg = "BOB!"
+
+    encrypted = alice_session.encrypt(alice_msg)
+    assert_instance_of PreKeyMessage, encrypted
+
+    # Bob needs to check if this is the same session or a new one
+    same_session = bob_session.will_receive? encrypted
+
+    assert same_session
+
+  end
+
+end

data/test/examples/test_exchange.rb

@@ -0,0 +1,60 @@
+require 'minitest/autorun'
+require 'self_crypto'
+
+class TestExchange < Minitest::Test
+
+  include SelfCrypto
+
+  # Alice -> Bob
+  # Alice <- Bob
+  def test_exchange
+
+    alice = Account.new
+    bob = Account.new
+
+    # Alice wants to send a message to Bob
+    alice_msg = "hi bob"
+
+    # Bob generates a one-time-key
+    bob.gen_otk
+
+    # Alice must have Bob's identity and one-time-key to make a session
+    alice_session = alice.outbound_session(bob.ik['curve25519'], bob.otk['curve25519'].values.first)
+
+    # Bob marks all one-time-keys as published
+    bob.mark_otk
+
+    # Alice can encrypt
+    encrypted = alice_session.encrypt(alice_msg)
+    assert_instance_of PreKeyMessage, encrypted
+
+    # Bob can create a session from this first message
+    bob_session = bob.inbound_session(encrypted)
+
+    # Bob can now update his list of marked otk (since he knows one has been used)
+    bob.update_otk(bob_session)
+
+    # Bob can decrypt Alice's message
+    bob_msg = bob_session.decrypt(encrypted)
+
+    assert_equal alice_msg, bob_msg
+
+    # At this point Bob has received but Alice hasn't
+    assert bob_session.has_received?
+    refute alice_session.has_received?
+
+    ####
+
+    # Bob can send messages back to Alice
+    bob_msg = "hi alice"
+
+    encrypted = bob_session.encrypt(bob_msg)
+    assert_instance_of Message, encrypted
+
+    alice_msg = alice_session.decrypt(encrypted)
+
+    assert_equal alice_msg, bob_msg
+
+  end
+
+end