mtproto 0.0.15 → 0.0.19

data/lib/mtproto/unencrypted_message.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module MTProto
+  # The unencrypted MTProto transport envelope (auth_key_id=0 | msg_id | len | body),
+  # used for the plaintext request/response of the DH key exchange. Its encrypted
+  # sibling is EncryptedMessage; the runtime never decrypts through this class.
+  class UnencryptedMessage
+    include Binary
+    extend Binary
+
+    attr_reader :auth_key_id, :msg_id, :body
+
+    def initialize(body, msg_id: self.class.generate_msg_id, auth_key_id: 0)
+      @auth_key_id = auth_key_id
+      @msg_id = msg_id
+      @body = body
+    end
+
+    def self.parse(packet)
+      data = packet.data
+      msg_id = b_u64(data[8, 8])
+      body_length = b_u32(data[16, 4])
+      body = data[20, body_length]
+
+      new(body, msg_id: msg_id, auth_key_id: 0)
+    end
+
+    def bytes
+      u64_b(@auth_key_id) +
+        u64_b(@msg_id) +
+        u32_b(@body.length) +
+        @body
+    end
+
+    def self.generate_msg_id
+      (Time.now.to_f * (2**32)).to_i & ~3
+    end
+  end
+end

data/lib/mtproto/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MTProto
-  VERSION = '0.0.15'
+  VERSION = '0.0.19'
 end

data/lib/mtproto.rb

@@ -9,13 +9,15 @@ require_relative 'mtproto/transport/packet'
 require_relative 'mtproto/transport/abridged_packet_codec'
 require_relative 'mtproto/transport/tcp_connection'
 require_relative 'mtproto/transport/connection'
-require_relative 'mtproto/message/message'
+require_relative 'mtproto/unencrypted_message'
 require_relative 'mtproto/tl/constructors'
 require_relative 'mtproto/tl/constructor_names'
+require_relative 'mtproto/tl/reader'
 require_relative 'mtproto/tl/object'
 require_relative 'mtproto/tl/objects/update'
 require_relative 'mtproto/tl/objects/update_short'
 require_relative 'mtproto/tl/objects/update_short_message'
+require_relative 'mtproto/tl/objects/updates'
 require_relative 'mtproto/tl/objects/message'
 require_relative 'mtproto/tl/objects/msg_container'
 require_relative 'mtproto/tl/objects/new_session_created'
@@ -33,6 +35,7 @@ require_relative 'mtproto/auth_key_generator'
 require_relative 'mtproto/session'
 require_relative 'mtproto/encrypted_message'
 require_relative 'mtproto/client'
+require_relative 'mtproto/file_downloader'
 
 module MTProto
 end

data/scripts/gen_constructor_names.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Regenerate lib/mtproto/tl/constructor_names.rb (the id -> name map used only for
+# logging and error text) from the LOCAL data/tl-schema.json (current layer),
+# preserving the stable MTProto transport-layer names the API schema lacks.
+#
+# Why not scripts/generate_constructors.rb: that one fetches
+# core.telegram.org/schema/json, which is STALE (~layer 214, no guest mode), and
+# overwrites constructors.rb. This one is offline and uses the migrated schema.
+#
+# Run: ruby scripts/gen_constructor_names.rb
+
+require 'json'
+
+root = File.expand_path('..', __dir__)
+schema = JSON.parse(File.read(File.join(root, 'data/tl-schema.json')))
+names_file = File.join(root, 'lib/mtproto/tl/constructor_names.rb')
+
+api = {}        # unsigned id => predicate/method name
+api_names = {}  # name => true
+schema.fetch('constructors').each do |c|
+  api[c['id'].to_i & 0xffffffff] = c['predicate']
+  api_names[c['predicate']] = true
+end
+schema.fetch('methods').each do |m|
+  api[m['id'].to_i & 0xffffffff] = m['method']
+  api_names[m['method']] = true
+end
+
+# Preserve MTProto transport-layer names (rpc_result, msgs_ack, dh_gen_*, ...) that
+# the API schema does not carry. An existing id absent from the API schema is
+# transport-core UNLESS its name is an API predicate/method — that marks a pre-bump
+# constructor whose id changed, so drop it (the current id is already in `api`).
+core = {}
+File.foreach(names_file) do |line|
+  next unless line =~ /0x([0-9a-fA-F]{8})\s*=>\s*'([^']+)'/
+
+  id = Regexp.last_match(1).to_i(16)
+  name = Regexp.last_match(2)
+  next if api.key?(id) || api_names.key?(name)
+
+  core[id] = name
+end
+
+entries = api.merge(core).sort.map { |id, name| format("        0x%08x => '%s'", id, name) }
+
+out = []
+out << '# frozen_string_literal: true'
+out << ''
+out << '# rubocop:disable Metrics/ModuleLength'
+out << ''
+out << '# Auto-generated id -> constructor/method name map (logging + error messages).'
+out << '# API names from data/tl-schema.json (current layer); MTProto transport-layer'
+out << '# names preserved from the prior map.'
+out << '# Run: ruby scripts/gen_constructor_names.rb'
+out << ''
+out << "require_relative 'constructors'"
+out << ''
+out << 'module MTProto'
+out << '  module TL'
+out << '    module ConstructorNames'
+out << '      NAMES = {'
+entries.each_with_index { |e, i| out << (i == entries.size - 1 ? e : "#{e},") }
+out << '      }.freeze'
+out << '    end'
+out << '  end'
+out << 'end'
+out << '# rubocop:enable Metrics/ModuleLength'
+
+File.write(names_file, "#{out.join("\n")}\n")
+puts "wrote #{api.size + core.size} entries (#{api.size} api + #{core.size} transport-core)"

data/scripts/tl_to_json.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# Convert a tdesktop-style TL schema (.tl) into mtproto-ruby's tl-schema.json
+# format ({ "constructors": [...], "methods": [...] }, each entry
+# { id (signed int32 string), predicate|method, params:[{name,type}], type }).
+#
+# Telegram's published core.telegram.org/schema JSON lags the live layer (it is
+# still ~214 with no guest constructors), so the authoritative current source is
+# tdesktop's Telegram/SourceFiles/mtproto/scheme/api.tl (layer 225).
+#
+# Usage: ruby tl_to_json.rb api.tl [mtproto.tl ...] > tl-schema.json
+
+require 'json'
+
+def signed32(hexid)
+  u = hexid.to_i(16)
+  u >= (1 << 31) ? u - (1 << 32) : u
+end
+
+# Params come straight from the .tl tokens: "name:type" where type is already in
+# the gem's native form ("#", "flags.8?Peer", "Vector<Message>", "long", "!X").
+# Skip generic declarations ("{X:Type}") and bare core noise ("#", "[", "t", "]").
+def parse_params(tokens)
+  tokens.each_with_object([]) do |tok, acc|
+    next if tok.start_with?('{')
+    next unless tok.include?(':')
+
+    name, type = tok.split(':', 2)
+    acc << { 'name' => name, 'type' => type }
+  end
+end
+
+constructors = []
+methods = []
+section = :constructors
+
+ARGV.each do |path|
+  File.foreach(path) do |raw|
+    line = raw.strip
+    next if line.empty? || line.start_with?('//')
+
+    if line == '---functions---'
+      section = :methods
+      next
+    end
+    if line == '---types---'
+      section = :constructors
+      next
+    end
+
+    next unless line.include?('=') && line.end_with?(';')
+
+    body = line[0..-2] # drop trailing ';'
+    lhs, rhs = body.split('=', 2)
+    lhs_tokens = lhs.split(/\s+/)
+    head = lhs_tokens.shift
+    next unless head&.include?('#') # skip id-less core types ("int ? = Int;")
+
+    name, hexid = head.split('#', 2)
+    entry = {
+      'id' => signed32(hexid).to_s,
+      (section == :constructors ? 'predicate' : 'method') => name,
+      'params' => parse_params(lhs_tokens),
+      'type' => rhs.strip
+    }
+    (section == :constructors ? constructors : methods) << entry
+  end
+end
+
+warn "constructors=#{constructors.size} methods=#{methods.size}"
+puts JSON.pretty_generate('constructors' => constructors, 'methods' => methods)

data/scripts/verify_ids.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+# Flag every hardcoded 0x id in the gem's lib that is NOT a valid layer-227
+# constructor/method id (api.tl). Survivors are either mtproto-layer ids (fine,
+# they live in mtproto.tl) or genuinely-changed api ids (must be updated).
+require 'set'
+
+tl     = ARGV[0]
+libdir = ARGV[1]
+
+ids = Set.new
+names = {}
+File.foreach(tl) do |l|
+  next unless l =~ /\A([\w.]+)#([0-9a-f]+)/
+  ids << Regexp.last_match(2).to_i(16)
+  names[Regexp.last_match(2).to_i(16)] = Regexp.last_match(1)
+end
+warn "api227 ids: #{ids.size}"
+
+IGNORE = %w[0xffffffff 0x7fffffff 0x80000000 0x00000000 0xfffffffe].freeze
+seen = {}
+Dir.glob("#{libdir}/**/*.rb").each do |f|
+  File.foreach(f).with_index do |line, i|
+    line.scan(/0x[0-9a-fA-F]{6,8}/).each do |tok|
+      t = tok.downcase
+      next if IGNORE.include?(t)
+      next if ids.include?(t.to_i(16))
+      (seen[t] ||= []) << "#{File.basename(f)}:#{i + 1}"
+    end
+  end
+end
+
+puts "=== gem 0x ids NOT present as a layer-227 api constructor/method ==="
+seen.sort.each { |tok, locs| puts format('%-12s  %s', tok, locs.uniq.join(', ')) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mtproto
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.19
 platform: ruby
 authors:
 - Artem Levenkov
@@ -63,6 +63,7 @@ files:
 - lib/mtproto/client.rb
 - lib/mtproto/client/api.rb
 - lib/mtproto/client/api/check_password.rb
+- lib/mtproto/client/api/export_authorization.rb
 - lib/mtproto/client/api/export_login_token.rb
 - lib/mtproto/client/api/get_contacts.rb
 - lib/mtproto/client/api/get_dialogs.rb
@@ -70,6 +71,7 @@ files:
 - lib/mtproto/client/api/get_updates_difference.rb
 - lib/mtproto/client/api/get_updates_state.rb
 - lib/mtproto/client/api/get_users.rb
+- lib/mtproto/client/api/import_authorization.rb
 - lib/mtproto/client/api/import_login_token.rb
 - lib/mtproto/client/api/send_code.rb
 - lib/mtproto/client/api/send_message.rb
@@ -88,7 +90,7 @@ files:
 - lib/mtproto/delegate_methods.rb
 - lib/mtproto/encrypted_message.rb
 - lib/mtproto/errors.rb
-- lib/mtproto/message/message.rb
+- lib/mtproto/file_downloader.rb
 - lib/mtproto/message_id.rb
 - lib/mtproto/session.rb
 - lib/mtproto/tl/constructor_names.rb
@@ -96,15 +98,18 @@ files:
 - lib/mtproto/tl/object.rb
 - lib/mtproto/tl/objects/account_password.rb
 - lib/mtproto/tl/objects/authorization.rb
+- lib/mtproto/tl/objects/bot_command_scope.rb
 - lib/mtproto/tl/objects/channels_create_channel.rb
 - lib/mtproto/tl/objects/channels_delete_messages.rb
 - lib/mtproto/tl/objects/channels_delete_participant_history.rb
+- lib/mtproto/tl/objects/channels_edit_admin.rb
 - lib/mtproto/tl/objects/channels_edit_banned.rb
 - lib/mtproto/tl/objects/channels_get_messages.rb
 - lib/mtproto/tl/objects/channels_get_participant.rb
 - lib/mtproto/tl/objects/channels_join_channel.rb
 - lib/mtproto/tl/objects/channels_leave_channel.rb
 - lib/mtproto/tl/objects/channels_report_spam.rb
+- lib/mtproto/tl/objects/channels_update_username.rb
 - lib/mtproto/tl/objects/check_password.rb
 - lib/mtproto/tl/objects/client_dh_inner_data.rb
 - lib/mtproto/tl/objects/contacts.rb
@@ -114,11 +119,15 @@ files:
 - lib/mtproto/tl/objects/dialogs.rb
 - lib/mtproto/tl/objects/edit_access_settings.rb
 - lib/mtproto/tl/objects/edit_message.rb
+- lib/mtproto/tl/objects/export_authorization.rb
 - lib/mtproto/tl/objects/export_bot_token.rb
 - lib/mtproto/tl/objects/export_login_token.rb
+- lib/mtproto/tl/objects/exported_authorization.rb
 - lib/mtproto/tl/objects/exported_bot_token.rb
 - lib/mtproto/tl/objects/forward_messages.rb
 - lib/mtproto/tl/objects/get_access_settings.rb
+- lib/mtproto/tl/objects/get_bot_callback_answer.rb
+- lib/mtproto/tl/objects/get_bot_commands.rb
 - lib/mtproto/tl/objects/get_channel_difference.rb
 - lib/mtproto/tl/objects/get_config.rb
 - lib/mtproto/tl/objects/get_contacts.rb
@@ -134,12 +143,14 @@ files:
 - lib/mtproto/tl/objects/get_users.rb
 - lib/mtproto/tl/objects/gzip_packed.rb
 - lib/mtproto/tl/objects/help_config.rb
+- lib/mtproto/tl/objects/import_authorization.rb
 - lib/mtproto/tl/objects/import_bot_authorization.rb
 - lib/mtproto/tl/objects/import_login_token.rb
 - lib/mtproto/tl/objects/init_connection.rb
 - lib/mtproto/tl/objects/input_keyboard_button_request_peer.rb
 - lib/mtproto/tl/objects/invite_to_channel.rb
 - lib/mtproto/tl/objects/invoke_with_layer.rb
+- lib/mtproto/tl/objects/keyboard_button_callback.rb
 - lib/mtproto/tl/objects/login_token.rb
 - lib/mtproto/tl/objects/message.rb
 - lib/mtproto/tl/objects/messages.rb
@@ -148,11 +159,13 @@ files:
 - lib/mtproto/tl/objects/new_session_created.rb
 - lib/mtproto/tl/objects/pq_inner_data.rb
 - lib/mtproto/tl/objects/raw_response.rb
+- lib/mtproto/tl/objects/reply_inline_markup.rb
 - lib/mtproto/tl/objects/reply_keyboard_markup.rb
 - lib/mtproto/tl/objects/req_dh_params.rb
 - lib/mtproto/tl/objects/req_pq_multi.rb
 - lib/mtproto/tl/objects/request_peer_type_create_bot.rb
 - lib/mtproto/tl/objects/res_pq.rb
+- lib/mtproto/tl/objects/reset_bot_commands.rb
 - lib/mtproto/tl/objects/resolve_username.rb
 - lib/mtproto/tl/objects/rpc_error.rb
 - lib/mtproto/tl/objects/save_file_part.rb
@@ -160,31 +173,42 @@ files:
 - lib/mtproto/tl/objects/send_code.rb
 - lib/mtproto/tl/objects/send_media.rb
 - lib/mtproto/tl/objects/send_message.rb
+- lib/mtproto/tl/objects/send_message_action.rb
 - lib/mtproto/tl/objects/send_reaction.rb
 - lib/mtproto/tl/objects/sent_code.rb
 - lib/mtproto/tl/objects/server_dh_inner_data.rb
 - lib/mtproto/tl/objects/server_dh_params.rb
+- lib/mtproto/tl/objects/set_bot_callback_answer.rb
 - lib/mtproto/tl/objects/set_bot_commands.rb
+- lib/mtproto/tl/objects/set_bot_guest_chat_result.rb
 - lib/mtproto/tl/objects/set_bot_info.rb
 - lib/mtproto/tl/objects/set_client_dh_params.rb
+- lib/mtproto/tl/objects/set_typing.rb
 - lib/mtproto/tl/objects/sign_in.rb
 - lib/mtproto/tl/objects/update.rb
 - lib/mtproto/tl/objects/update_short.rb
 - lib/mtproto/tl/objects/update_short_message.rb
 - lib/mtproto/tl/objects/update_short_sent_message.rb
+- lib/mtproto/tl/objects/update_status.rb
 - lib/mtproto/tl/objects/update_username.rb
+- lib/mtproto/tl/objects/updates.rb
 - lib/mtproto/tl/objects/updates_difference.rb
 - lib/mtproto/tl/objects/updates_state.rb
 - lib/mtproto/tl/objects/upload_profile_photo.rb
 - lib/mtproto/tl/objects/users.rb
+- lib/mtproto/tl/reader.rb
 - lib/mtproto/tl/schema.rb
 - lib/mtproto/transport/abridged_packet_codec.rb
 - lib/mtproto/transport/connection.rb
 - lib/mtproto/transport/errors.rb
 - lib/mtproto/transport/packet.rb
 - lib/mtproto/transport/tcp_connection.rb
+- lib/mtproto/unencrypted_message.rb
 - lib/mtproto/version.rb
+- scripts/gen_constructor_names.rb
 - scripts/generate_constructors.rb
+- scripts/tl_to_json.rb
+- scripts/verify_ids.rb
 - tmp/.keep
 homepage: https://github.com/alev-pro/mtproto-ruby
 licenses:

data/lib/mtproto/message/message.rb

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-
-module MTProto
-  class Message
-    include Binary
-    extend Binary
-
-    attr_reader :auth_key_id, :msg_id, :body,
-      :msg_key, :encrypted_data,
-      :server_salt, :session_id, :seq_no
-
-    def initialize(body, msg_id: self.class.generate_msg_id, auth_key_id: 0)
-      @auth_key_id = auth_key_id
-      @msg_id = msg_id
-      @body = body
-    end
-
-    def self.parse(packet)
-      data = packet.data
-      auth_key_id = b_u64(data[0, 8])
-
-      if auth_key_id.zero?
-        parse_unencrypted(data)
-      else
-        parse_encrypted(data, auth_key_id)
-      end
-    end
-
-    def encrypted?
-      !@auth_key_id.zero?
-    end
-
-    def decrypt(auth_key:, sender: :server)
-      raise 'Message is not encrypted' unless encrypted?
-
-      keys = Crypto::MessageKey.derive_aes_key_iv(auth_key, @msg_key, sender: sender)
-      plaintext = Crypto::AES_IGE.decrypt_ige(@encrypted_data, keys[:aes_key], keys[:aes_iv])
-
-      expected_msg_key = Crypto::MessageKey.generate_msg_key(auth_key, plaintext, sender: sender)
-      raise 'msg_key mismatch!' unless @msg_key == expected_msg_key
-
-      offset = 0
-      @server_salt = plaintext[offset, 8].unpack1('Q<')
-      offset += 8
-      @session_id = plaintext[offset, 8].unpack1('Q<')
-      offset += 8
-      @msg_id = plaintext[offset, 8].unpack1('Q<')
-      offset += 8
-      @seq_no = plaintext[offset, 4].unpack1('L<')
-      offset += 4
-      body_length = plaintext[offset, 4].unpack1('L<')
-      offset += 4
-      @body = plaintext[offset, body_length].bytes
-
-      self
-    end
-
-    def bytes
-      u64_b(@auth_key_id) +
-        u64_b(@msg_id) +
-        u32_b(@body.length) +
-        @body
-    end
-
-    def self.generate_msg_id
-      (Time.now.to_f * (2**32)).to_i & ~3
-    end
-
-    private_class_method def self.parse_unencrypted(data)
-      msg_id = b_u64(data[8, 8])
-      body_length = b_u32(data[16, 4])
-      body = data[20, body_length]
-
-      new(body, msg_id: msg_id, auth_key_id: 0)
-    end
-
-    private_class_method def self.parse_encrypted(data, auth_key_id)
-      msg = allocate
-      msg.instance_variable_set(:@auth_key_id, auth_key_id)
-      msg.instance_variable_set(:@msg_key, data[8, 16].pack('C*'))
-      msg.instance_variable_set(:@encrypted_data, data[24..].pack('C*'))
-      msg
-    end
-  end
-end