openrareplay 0.1.1

data/lib/openrareplay/sanitize/packet_sanitizer.rb

@@ -0,0 +1,125 @@
+#!/usr/bin/env ruby
+
+#    OpenRA Replay Sanitizer: Program/library to parse and generate
+#    OpenRA replay files
+#
+#    Copyright (C) 2018  Luke Spangler
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+require_relative '../miniyaml'
+
+module OpenRAReplay
+  module Sanitize
+    class PacketSanitizer
+      attr_reader :ping, :message, :chat, :ip, :time, :password,
+                  :player_name, :server_name, :player_map
+
+      def initialize(options = {})
+        @ping = options[:ping]
+        @message = options[:message]
+        @chat = options[:chat]
+        @ip = options[:ip]
+        @time = options[:time]
+        @password = options[:password]
+        @player_name = options[:player_name]
+        @server_name = options[:server_name]
+        @player_map = {}
+      end
+
+      def sanitize_packet(packet)
+        return sanitize_packet_metadata(packet) if packet.metadata?
+        return sanitize_packet_normal(packet) unless packet.unknown?
+        packet
+      end
+
+      private
+
+      def sanitize_packet_metadata(packet)
+        object = OpenRAReplay::MiniYaml.load(packet.data)
+        time_placeholder = sanitize_time_packet object if time
+        object.each_key do |key|
+          player = key.match(/^Player@(\d+)$/)
+          next unless player
+          sanitize_time_player object, key, time_placeholder if time
+          sanitize_name object, key if player_name
+        end
+        packet.class.new(data: OpenRAReplay::MiniYaml.dump(object))
+      end
+
+      def sanitize_packet_normal(packet)
+        packet.class.new(
+          client_id: packet.client_id,
+          frame: packet.frame,
+          orders: packet.orders.reject do |o|
+            (ping && (o.command.match('Ping') || o.command == 'Pong')) ||
+            (message && o.command == 'Message') || (chat &&
+            (o.command == 'Chat') || o.command == 'TeamChat')
+          end.map { |o| sanitize_order o }
+        )
+      end
+
+      def sanitize_order(order)
+        return order unless order.command.match('Sync') ||
+                            order.command.match('Handshake')
+        object = OpenRAReplay::MiniYaml.load order.data
+        sanitize_password object if password
+        sanitize_server_name object if server_name
+        object.each_key do |key|
+          next unless key == 'Client' || key =~ /^Client@\d+$/
+          sanitize_name object, key if player_name
+          sanitize_ip object, key if ip
+        end
+        order.class.new(
+          command: order.command,
+          data: OpenRAReplay::MiniYaml.dump(object)
+        )
+      end
+
+      def sanitize_time_packet(object)
+        start_time = OpenRAReplay::MiniYaml.load_time(object['Root']['StartTimeUtc'])
+        epoch = Time.at(0).utc
+        start_time = start_time.to_i
+        stop_time = OpenRAReplay::MiniYaml.load_time(object['Root']['EndTimeUtc']) - start_time
+        object['Root']['StartTimeUtc'] = OpenRAReplay::MiniYaml.dump_time(epoch)
+        object['Root']['EndTimeUtc'] = OpenRAReplay::MiniYaml.dump_time(stop_time)
+        start_time
+      end
+
+      def sanitize_time_player(object, key, start_time)
+        object[key]['OutcomeTimestampUtc'] = OpenRAReplay::MiniYaml.dump_time(OpenRAReplay::MiniYaml.load_time(object[key]['OutcomeTimestampUtc']) - start_time)
+      end
+
+      def sanitize_password(object)
+        object['Handshake']['Password'] = nil if object['Handshake'] && object['Handshake']['Password']
+      end
+
+      def sanitize_server_name(object)
+        object['GlobalSettings']['ServerName'] = nil if object['GlobalSettings'] && object['GlobalSettings']['ServerName']
+      end
+
+      def sanitize_ip(object, key)
+        object[key]['IpAddress'] = nil if object[key]['IpAddress']
+      end
+
+      def sanitize_name(object, key)
+        return unless !object[key]['IsBot'] && object[key]['Name']
+        unless player_map[object[key]['Name']]
+          @player_map[object[key]['Name']] = "Player #{player_map.length + 1}"
+        end
+        object[key]['Name'] = player_map[object[key]['Name']]
+      end
+    end
+  end
+end

data/lib/openrareplay/sanitize/replay_sanitizer.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+#    OpenRA Replay Sanitizer: Program/library to parse and generate
+#    OpenRA replay files
+#
+#    Copyright (C) 2018  Luke Spangler
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+require_relative 'packet_sanitizer'
+require_relative '../packet/packet_parser'
+
+module OpenRAReplay
+  module Sanitize
+    class ReplaySanitizer
+      attr_reader :in_file, :out_file, :packet_sanitizer
+
+      def initialize(in_name, out_name, opts = {})
+        @in_file = in_name
+        @out_file = out_name
+        @packet_sanitizer = OpenRAReplay::Sanitize::PacketSanitizer.new opts
+      end
+
+      def sanitize
+        File.open(out_file, 'wb') do |output_file|
+          File.open(in_file, 'rb') do |input_file|
+            packet_parser = OpenRAReplay::PacketParser.new(input_file)
+            until packet_parser.eof?
+              packet_parser.read_packet do |packet|
+                next if packet.unknown?
+                np = packet_sanitizer.sanitize_packet packet
+                output_file.write np.byte_array
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openrareplay/version.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+#    OpenRA Replay Sanitizer: Program/library to parse and generate
+#    OpenRA replay files
+#
+#    Copyright (C) 2018  Luke Spangler
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+module OpenRAReplay
+  VERSION = '0.1.1'.freeze
+end

data/openrareplay.gemspec

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+#    OpenRA Replay Sanitizer: Program/library to parse and generate
+#    OpenRA replay files
+#
+#    Copyright (C) 2018  Luke Spangler
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'openrareplay/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'openrareplay'
+  spec.version       = OpenRAReplay::VERSION
+  spec.authors       = ['Luke Spangler']
+  spec.email         = ['luke.a.spangler@gmail.com']
+
+  spec.summary       = 'Program/library to parse and generate OpenRA
+                        replays without identifying information'
+  spec.homepage      = 'https://github.com/spanglel/OpenRAReplay-Sanitizer'
+  spec.license       = 'AGPL-3.0'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: openrareplay
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Luke Spangler
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- luke.a.spangler@gmail.com
+executables:
+- openra-sanitize
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- exe/openra-sanitize
+- lib/openrareplay.rb
+- lib/openrareplay/binary.rb
+- lib/openrareplay/miniyaml.rb
+- lib/openrareplay/order.rb
+- lib/openrareplay/order/client.rb
+- lib/openrareplay/order/notanorder.rb
+- lib/openrareplay/order/order.rb
+- lib/openrareplay/order/server.rb
+- lib/openrareplay/packet.rb
+- lib/openrareplay/packet/metadata_packet.rb
+- lib/openrareplay/packet/packet.rb
+- lib/openrareplay/packet/packet_parser.rb
+- lib/openrareplay/sanitize.rb
+- lib/openrareplay/sanitize/cli.rb
+- lib/openrareplay/sanitize/packet_sanitizer.rb
+- lib/openrareplay/sanitize/replay_sanitizer.rb
+- lib/openrareplay/version.rb
+- openrareplay.gemspec
+homepage: https://github.com/spanglel/OpenRAReplay-Sanitizer
+licenses:
+- AGPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Program/library to parse and generate OpenRA replays without identifying
+  information
+test_files: []