nxo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a4f23bfcea1b0fba1cb2cf3596faa33d82587b1059256cd06c05fadb433098f3
+  data.tar.gz: 8c78539e9f2a00b725d10881dbd41c7fe1e155d23e70f2bf4e380f19a6e3f29e
+SHA512:
+  metadata.gz: 2808d178d483b5591345862379d8a9cc464b1c45a980859761739ea7b3d6f18e1e84ec329c6b0edfd2344cc5bc4fbf0f72d18d486d516c6adda87fe645d1503f
+  data.tar.gz: f54358bbd308e65578d8441e5623e33b18a287f15cc0860aaaa7af87d7ecb5daf7dce7ea5babb56bf36f547f02bf022e94dbe085b6af6bbc3519d98f4da1dd20

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in nxo.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    nxo (0.1.0)
+      lz4-ruby
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    lz4-ruby (0.3.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  nxo!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/README.md

@@ -0,0 +1,35 @@
+# Nxo
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/nxo`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nxo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nxo
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/nxo.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nxo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/nso_info

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nxo"
+
+nso = Nxo::NsoFile.new(File.open(ARGV[0], "rb"))
+
+puts "Name: " + nso.name_heuristic
+puts "FS SDK Versions:"
+nso.fs_sdk_versions.each do |v|
+  puts "  - " + v
+end
+puts nso.rodata.contents.scan(/SDK MW[ -~]*/)

data/lib/nxo.rb

@@ -0,0 +1,6 @@
+require "nxo/version"
+require "nxo/nxo"
+require "nxo/nso"
+
+module Nxo
+end

data/lib/nxo/dynamic.rb

@@ -0,0 +1,94 @@
+module Nxo
+  module Dynamic
+    module DT
+      NULL = 0
+      NEEDED = 1
+      PLTRELSZ = 2
+      PLTGOT = 3
+      HASH = 4
+      STRTAB = 5
+      SYMTAB = 6
+      RELA = 7
+      RELASZ = 8
+      RELAENT = 9
+      STRSZ = 10
+      SYMENT = 11
+      # 12-15
+      SYMBOLIC = 16
+      REL = 17
+      RELSZ = 18
+      RELENT = 19
+      PLTREL = 20
+      # 21-22
+      JMPREL = 23
+      # 24
+      INIT_ARRAY = 25
+      FINI_ARRAY = 26
+      INIT_ARRAYSZ = 27
+      FINI_ARRAYSZ = 28
+      FLAGS = 30
+      GNU_HASH = 0x6ffffef5
+      RELACOUNT = 0x6ffffff9
+    end
+
+    class Entry
+      def initialize(nxo, tag, value)
+        @nxo = nxo
+        @tag = tag
+        @value = value
+      end
+
+      attr_reader :nxo, :tag, :value
+    end
+
+    
+    class Symbol
+      def initialize(name, info, other, shndx, value, size)
+        @name = name
+        @info = info
+        @other = other
+        @shndx = shndx
+        @value = value
+        @size = size
+      end
+
+      attr_reader :name, :info, :other, :shndx, :value, :size
+    end
+    
+    class DynamicSection
+      def initialize(nxo, offset)
+        @nxo = nxo
+        @offset = offset
+        @entries = []
+        
+        lc = offset
+        while((entry = Entry.new(self, *@nxo[lc, 0x10].unpack("Q<Q<"))).tag != DT::NULL) do
+          @entries.push(entry)
+          lc+= 0x10
+        end
+      end
+
+      def [](tag)
+        return @entries.find do |entry|
+          entry.tag == tag
+        end
+      end
+
+      def nchain
+        return @nxo[self[DT::HASH].value + 4, 4].unpack("L<")[0]
+      end
+
+      def string(i)
+        @nxo[self[DT::STRTAB].value + i, 1024].unpack("Z1024")[0]
+      end
+      
+      SYMBOL_SIZE = 0x18
+      
+      def symbol(i)
+        pack = @nxo[self[DT::SYMTAB].value + i * SYMBOL_SIZE, SYMBOL_SIZE]
+        name, info, other, shndx, value, size = pack.unpack("L<CCS<Q<Q<")
+        return Symbol.new(string(name), info, other, shndx, value, size)
+      end
+    end
+  end
+end

data/lib/nxo/error.rb

@@ -0,0 +1,52 @@
+module Nxo
+  module Error
+    class InvalidMagicError < RuntimeError
+      def initialize(actual, expected)
+        super("Invalid magic number (got \"#{actual}\", expected \"#{expected}\")")
+        @actual = actual
+        @expected = expected
+      end
+
+      attr_reader :actual, :expected
+    end
+
+    class UnknownVersionError < RuntimeError
+      def initialize(actual, expected)
+        super("Invalid version (got \"#{actual}\", expected \"#{expected}\")")
+        @actual = actual
+        @expected = expected
+      end
+
+      attr_reader :actual, :expected
+    end
+
+    class HashCheckError < RuntimeError
+      def initialize(segment)
+        super("Hash check failed while loading segment \"#{segment}\"")
+        @segment = segment
+      end
+
+      attr_reader :segment
+    end
+
+    class AddressMismatchError < RuntimeError
+      def initialize(segment, expected, actual)
+        super("Attempted to place segment \"#{segment}\" at 0x#{actual.to_s(16)}, but headers puts it at 0x#{expected.to_s(16)}")
+        @segment = segment
+        @expected = expected
+        @actual = actual
+      end
+
+      attr_reader :segment, :expected, :actual
+    end
+
+    class UnmappedAddressError < RuntimeError
+      def initialize(address)
+        super("No segment at 0x#{address.to_s(166)}")
+        @address = address
+      end
+
+      attr_reader :address
+    end
+  end
+end

data/lib/nxo/nso.rb

@@ -0,0 +1,77 @@
+require "digest"
+require "lz4-ruby"
+
+require "nxo/nxo"
+require "nxo/error"
+
+module Nxo
+  class NsoFile < NxoFile
+    NSO_MAGIC = "NSO0"
+    NSO_VERSION = 0
+    
+    def initialize(f, options = {})
+      @f = f
+
+      @f.pos = 0
+      magic, version, flags = @f.read(0x10).unpack("a4L<x4L<")
+
+      if magic != NSO_MAGIC then
+        raise Error::InvalidMagicError.new(magic, NSO_MAGIC)
+      end
+
+      if version != NSO_VERSION then
+        raise Error::UnknownVersionError.new(version, NSO_VERSION)
+      end
+
+      segment_headers = 3.times.map do
+        Hash[[:file_offset, :memory_offset, :decompressed_size, :misc].zip(@f.read(0x10).unpack("L<L<L<L<"))]
+      end
+
+      module_offset, module_file_size, bss_size = segment_headers.map do |sh| sh[:misc] end
+
+      @build_id = @f.read(0x20)
+
+      @f.read(3 * 0x4).unpack("L<L<L<").each_with_index do |size, i|
+        segment_headers[i][:compressed_size] = size
+      end
+
+      @f.pos = 0x88
+      @extents = Hash[[:api_info, :dynstr, :dynsym].zip(@f.read(0x18).unpack("Q<Q<Q<"))]
+      
+      @f.read(3 * 0x20).unpack("a32a32a32").each_with_index do |hash, i|
+        segment_headers[i][:hash] = hash
+      end
+
+      location_counter = 0
+      segments = [:text, :rodata, :data].each_with_index.map do |name, i|
+        sh = segment_headers[i]
+        @f.pos = sh[:file_offset]
+        contents = @f.read(sh[:compressed_size])
+
+        if flags[i] == 1 then # is compressed
+          contents = LZ4::Raw.decompress(contents, sh[:decompressed_size])[0]
+        end
+
+        if flags[i+3] == 1 && !options[:disable_hash_check] then # check hash
+          if Digest::SHA256.digest(contents) != sh[:hash] then
+            raise Error::HashCheckError.new(name)
+          end
+        end
+
+        if sh[:memory_offset] < location_counter then
+          raise Error::AddressMismatchError.new(name, sh[:memory_offset], location_counter)
+        end
+
+        location_counter = sh[:memory_offset] + contents.bytesize
+        
+        Segment.new(name, sh[:memory_offset], contents)
+      end + [Segment.new("bss", location_counter, 0.chr * bss_size)]
+
+      super(segments)
+    end
+
+    attr_reader :build_id
+    attr_reader :extents
+    attr_reader :segments
+  end
+end

data/lib/nxo/nxo.rb

@@ -0,0 +1,94 @@
+require "nxo/error"
+require "nxo/dynamic"
+
+module Nxo
+  class NxoFile
+    MOD_MAGIC = "MOD0"
+    
+    class Segment
+      def initialize(name, address, contents)
+        @name = name
+        @address = address
+        @contents = contents
+      end
+
+      attr_reader :name
+      attr_reader :address
+      attr_reader :contents
+
+      def size
+        @contents.bytesize
+      end
+      
+      def contains?(addr)
+        return addr >= @address && addr < @address + contents.bytesize
+      end
+      
+      def [](offset, size)
+        return @contents[offset, size]
+      end
+    end
+
+    def initialize(segments)
+      @segments = segments
+
+      module_offset = self[4, 4].unpack("L<")[0]
+      
+      magic, o_dynamic, o_bss_b, o_bss_e, o_eh_frame_hdr_b, o_eh_frame_hdr_e, o_ro_module = self[module_offset, 0x1c].unpack("a4L<L<L<L<L<L<")
+
+      if magic != MOD_MAGIC then
+        raise Error::InvalidMagicError.new(module_magic, MOD_MAGIC)
+      end
+
+      if module_offset + o_bss_b != bss.address then # sanity check
+      #  raise Error::AddressMismatchError.new(:module_bss, module_offset + o_bss_b, bss.address)
+      end
+
+      @dynamic = Dynamic::DynamicSection.new(self, module_offset + o_dynamic)
+    end
+
+    attr_reader :dynamic
+    
+    def [](address, size)
+      @segments.each do |seg|
+        if seg.contains?(address) then
+          offset = address - seg.address
+          available_size = seg.size - offset
+          safe_size = [size, available_size].min
+          str = seg[offset, safe_size]
+          if safe_size < size then
+            return str + self[address + safe_size, size - safe_size]
+          else
+            return str
+          end
+        end
+      end
+      raise Error::UnmappedAddressError.new(address)
+    end
+
+    def text
+      @segments[0]
+    end
+
+    def rodata
+      @segments[1]
+    end
+
+    def data
+      @segments[2]
+    end
+
+    def bss
+      @segments[3]
+    end
+
+    def fs_sdk_versions
+      rodata.contents.scan(/sdk_version: ([0-9.]*)/).map do |m| m[0] end
+    end
+
+    def name_heuristic
+      l = rodata[4, 4].unpack("L<")[0]
+      return rodata[8, l]
+    end
+  end
+end

data/lib/nxo/version.rb

@@ -0,0 +1,3 @@
+module Nxo
+  VERSION = "0.1.0"
+end

data/nxo.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nxo/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nxo"
+  spec.version       = Nxo::VERSION
+  spec.authors       = ["misson20000"]
+  spec.email         = ["xenotoad@xenotoad.net"]
+
+  spec.summary       = "Small gem for working with Nintendo Switch executable objects"
+  spec.homepage      = "https://github.com/misson20000/nxo-rb"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) 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_dependency "lz4-ruby"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: nxo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- misson20000
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lz4-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- xenotoad@xenotoad.net
+executables:
+- nso_info
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/nso_info
+- lib/nxo.rb
+- lib/nxo/dynamic.rb
+- lib/nxo/error.rb
+- lib/nxo/nso.rb
+- lib/nxo/nxo.rb
+- lib/nxo/version.rb
+- nxo.gemspec
+homepage: https://github.com/misson20000/nxo-rb
+licenses: []
+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: Small gem for working with Nintendo Switch executable objects
+test_files: []