codeout/irrc

# irrc

[![Test on Ubuntu](https://github.com/codeout/irrc/actions/workflows/test-linux.yaml/badge.svg)](https://github.com/codeout/irrc/actions/workflows/test-linux.yaml)
[![Code Climate](https://codeclimate.com/github/codeout/irrc.png)](https://codeclimate.com/github/codeout/irrc)
[![Inline docs](http://inch-ci.org/github/codeout/irrc.svg)](http://inch-ci.org/github/codeout/irrc)

irrc is a lightweight and flexible client of IRR / Whois Database to expand arbitrary as-set and route-set objects into a list of origin ASs and prefixes belonging to those ASs. It will concurrently queries multiple IRR / Whois Databases for performance.

## Features

* Fast. irrc runs multi-threaded micro clients to process simultaneous IRR / Whois queries for performance. It also uses object caches.
* Handy. irrc's CLI client provides an easy way to resolve prefixes from as-set and route-set objects. It works even when multiple objects given as arguments.
* Dual stack. irrc returns both IPv4 and IPv6 prefixes by default. There is no need to kick a command twice for dual stacked result.
* Flexible. irrc provides an extensible ruby library which allows to modify IRR / Whois queries more flexibly.
* Pretty print. irrc shows prefixes in YAML format like [this](#example).
* Pure ruby. irrc doesn't depend on any other ruby gem.
* Lightweight. irrc is designed to gather prefixes from arbitrary as-set and route-set. It's implemented as simple as possible to achieve that. In other words, domain name related features are not supported.


## Installation

For bundler:

    gem 'irrc'

And then:

    $ bundle

Otherwise:

    $ gem install irrc


## Usage

### CLI

irrc privides a peval-like CLI interface.

* Query JPIRR about AS-JPNIC and AS-OCN

    ```shell
    $ irrc -h jpirr AS-JPNIC AS-OCN
    ```

* Query JPIRR about AS-JPNIC with authoritative IRR (SOURCE:) based filter

    ```shell
    $ irrc -h jpirr -s radb -s apnic AS-JPNIC
    ```

* Query JPIRR about AS-JPNIC for IPv4 only

    ```shell
    $ irrc -h jpirr -4 AS-JPNIC
    ```

### As a Library

You can load irrc as a library and use it easily in your own code.

```ruby
require 'irrc'

client = Irrc::Client.new
client.query :jpirr, 'AS-JPNIC', source: :jpirr     # queries JPIRR about AS-JPNIC with a SOURCE: filter
client.query :ripe, 'AS-RIPENCC', protocol: :ipv4   # queries RIPE Whoisd about AS-RIPENCC for IPv4 only
client.perform                                      # returns the results in a Hash
```


## Example

```shell
$ irrc -h jpirr AS-JPNIC
```

will result in a YAML:

```yaml
---
AS-JPNIC:               # queried object
  :ipv4:
    AS2515:             # AS-JPNIC has AS2515 as a origin AS
    - 202.12.30.0/24    # 4 IPv4 prefixes belonging to AS2515
    - 192.41.192.0/24   #
    - 211.120.240.0/21  #
    - 211.120.248.0/24  #
  :ipv6:
    AS2515:
    - 2001:0fa0::/32
    - 2001:dc2::/32
    - 2001:DC2::/32
```


## Supported Ruby Versions

* Ruby >= 2.0.0

Successfully tested with 2.1.9, 2.2.6, 2.3.3 and 2.4.0.


## Threading

irrc will send queries to multiple IRR / Whois servers simultaneously in multi-threads. Single-thread processing for each server by default.

To configure the number of threads per server:

### CLI

```shell
$ irrc -h jpirr -t 2 AS-JPNIC AS-OCN  # 2 threads to query JPIRR
```

### AS a Library

```ruby
client = Irrc::Client.new(2)  # 2 threads per IRR / Whois server
```


## Debugging

irrc uses ```STDERR``` printer for a logger by default, which reports more severe messages than INFO.

### CLI

To display debug information including raw messages of IRR / Whois protocol:

```shell
$ irrc -h jpirr -d AS-JPNIC
```

### As a Library

To use modified Logger:

```ruby
client = Irrc::Client.new {|c| c.logger = Irrc::Logging::Logger.new(STDERR) }

# For Rails,

client = Irrc::Client.new {|c| c.logger = Rails.logger }
```


## Quick Benchmark

Here is a quick performance comparison with peval and irrpt.

| CLI command                                      |      user |     system |     cpu |      total |
| :----------------------------------------------- | --------: | ---------: | ------: | ---------: |
| peval -h jpirr.nic.ad.jp 'afi ipv4, ipv6 AS-OCN' |     0.15s |      0.04s |      3% |      4.959 |
| irrpt_list_prefixes AS-OCN                       |     0.21s |      0.09s |      3% |      9.693 |
| **irrc -h jpirr AS-OCN**                         | **0.42s** |  **0.12s** |  **5%** |  **9.622** |
| **irrc -h jpirr -t 4 AS-OCN**                    | **0.39s** |  **0.13s** | **19%** |  **2.754** |


## Contributing

Please fork it, fix and then send a pull request. :tada:

To run tests just type:

```shell
$ rake
```

Please report issues or enhancement requests to [GitHub issues](https://github.com/codeout/irrc/issues).
For questions or feedbacks write to my twitter @codeout.


## Copyright and License

Copyright (c) 2014-2021 Shintaro Kojima. Code released under the [MIT license](LICENSE).