ronin-rb/ronin-listener

# ronin-listener

[![CI](https://github.com/ronin-rb/ronin-listener/actions/workflows/ruby.yml/badge.svg)](https://github.com/ronin-rb/ronin-listener/actions/workflows/ruby.yml)
[![Code Climate](https://codeclimate.com/github/ronin-rb/ronin-listener.svg)](https://codeclimate.com/github/ronin-rb/ronin-listener)

* [Website](https://ronin-rb.dev/)
* [Source](https://github.com/ronin-rb/ronin-listener)
* [Issues](https://github.com/ronin-rb/ronin-listener/issues)
* [Documentation](https://ronin-rb.dev/docs/ronin-listener)
* [Discord](https://discord.gg/6WAb3PsVX9) |
  [Mastodon](https://infosec.exchange/@ronin_rb)

## Description

ronin-listener is a small CLI utility for receiving exfiltrated data over DNS or
HTTP.

## Features

* Supports starting a DNS server for receiving exfiltrated data via DNS queries
  for a domain.
* Supports starting a HTTP server for receiving exfiltrated data via HTTP
  requests.

## Synopsis

```
$ ronin-listener
Usage: ronin-listener [options]

Options:
    -V, --version                    Prints the version and exits
    -h, --help                       Print help information

Arguments:
    [COMMAND]                        The command name to run
    [ARGS ...]                       Additional arguments for the command

Commands:
    completion
    dns
    help
    http
```

Listen for DNS queries on `127.0.0.1` port `5553` for the domain `example.com`:

```shell
ronin-listener dns -H 127.0.0.1 -p 5553 example.com
```

Listen for HTTP requests on `127.0.0.1` port `8080`:

```shell
ronin-listener http -H 127.0.0.1 -p 8080
```

Listen specifically for HTTP requests sent to `example.com`:

```shell
ronin-listener http -H 127.0.0.1 -p 8080 --vhost example.com
```

Generate a new standalone DNS listener Ruby script:

```shell
ronin-listener new dns file.rb
```

Generate a new standalone HTTP listener Ruby script:

```shell
ronin-listener new http file.rb
```

## Requirements

* [Ruby] >= 3.0.0
* [ronin-listener-dns] ~> 0.1
* [ronin-listener-http] ~> 0.1
* [ronin-core] ~> 0.2

## Install

```shell
$ gem install ronin-listener
```

### Gemfile

```ruby
gem 'ronin-listener', '~> 0.1'
```

### gemspec

```ruby
gem.add_dependency 'ronin-listener', '~> 0.1'
```

## Development

1. [Fork It!](https://github.com/ronin-rb/ronin-listener/fork)
2. Clone It!
3. `cd ronin-listener/`
4. `./scripts/setup`
5. `git checkout -b my_feature`
6. Code It!
7. `bundle exec rake spec`
8. `git push origin my_feature`

## License

Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)

ronin-listener is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

ronin-listener 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with ronin-listener.  If not, see <https://www.gnu.org/licenses/>.

[Ruby]: https://www.ruby-lang.org
[ronin-listener-dns]: https://github.com/ronin-rb/ronin-listener-dns#readme
[ronin-listener-http]: https://github.com/ronin-rb/ronin-listener-http#readme
[ronin-core]: https://github.com/ronin-rb/ronin-core#readme