rabid 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 98987fe496586fce7a2692ffa657b10bab969977ca1ff1cf4db5eac89d13ddc4
+  data.tar.gz: a3a8430704ea8b58e39a5fbe5f7b10371030261039e5f2874ce0f3104035d3d2
+SHA512:
+  metadata.gz: 5c74ef56c2317560de1f2ebc0432393ee04eacc4a40ed7d2ad02bf47496386950e75b62ecce05fb1e2f635f3c95b795deeebf45cd3d6d094566a13e6199a55be
+  data.tar.gz: 62f44f2cfc9b1789dcf2dd82c8c5a9c8db302fb5b5a171f39376ab851b3f115844262799d908254633463b8d0647417f86de7204d6e9dd8dc7d6aaf05e46903c

data/.gitignore

@@ -0,0 +1,7 @@
+.yardoc
+*.gem
+/pkg
+/doc
+/vendor
+.bundle/
+/node_modules

data/.rubocop.yml

@@ -0,0 +1,22 @@
+# Metrics
+AllCops:
+  TargetRubyVersion: 2.4
+
+Layout/AlignHash:
+  Include:
+    - 'lib/**/*.rb'
+Metrics/AbcSize:
+  Enabled: false
+Metrics/ClassLength:
+  Max: 200
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/LineLength:
+  Include:
+    - 'lib/**/*.rb'
+Metrics/MethodLength:
+  Max: 25
+Metrics/PerceivedComplexity:
+  Max: 10
+Style/RedundantReturn:
+  Enabled: false

data/.yardopts

@@ -0,0 +1,4 @@
+--output-dir docs/yard
+-
+--main README.md
+LICENSE.txt

data/.yardopts-dev

@@ -0,0 +1,6 @@
+--output-dir docs/yard
+--protected
+--private
+-
+--main README.md
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in .gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    rabid (0.0.1)
+      docopt (~> 0.6)
+      paint (~> 2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    commonmarker (0.20.1)
+      ruby-enum (~> 0.5)
+    concurrent-ruby (1.1.5)
+    docopt (0.6.1)
+    github-markup (3.0.4)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.3)
+    minitest (5.11.3)
+    paint (2.1.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    redcarpet (3.4.0)
+    rubocop (0.73.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-enum (0.7.2)
+      i18n
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
+    yard (0.9.20)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  commonmarker (~> 0.18)
+  github-markup (~> 3.0)
+  minitest (~> 5.11)
+  rabid!
+  rake (~> 12.3)
+  redcarpet (~> 3.4)
+  rubocop (~> 0.63)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Alexandre ZANNI
+
+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,15 @@
+# RABID
+
+![](https://orange-cyberdefense.github.io/rabid/_media/logo.png)
+
+> **RA**pid **B**ig **I**P **D**ecoder
+
+## What it is
+
+A CLI tool and library allowing to simply decode all kind of BigIP cookies.
+
+## Features
+
+- Support all 4 cookie formats
+- CLI tool & library
+- Hackable

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task default: :test
+

data/bigipcookie.gemspec

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bigipcookie/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'rabid'
+  s.version       = Version::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.date          = '2019-07-16'
+  s.summary       = 'RApid Big IP Decoder'
+  s.description   = 'A library and CLI tool allowing to decode all 4 types'\
+                    ' of BigIP cookies'
+  s.authors       = ['Alexandre ZANNI']
+  s.email         = 'alexandre.zanni@engineer.com'
+  s.homepage      = 'https://orange-cyberdefense.github.io/rabid/'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f|
+    File.basename(f)
+  }
+  s.test_files    = s.files.grep(%r{^(test)/})
+  s.require_paths = ['lib']
+
+  s.metadata = {
+    'yard.run'          => 'yard',
+    'bug_tracker_uri'   => 'https://github.com/Orange-Cyberdefense/rabid/issues',
+    'changelog_uri'     => 'https://github.com/Orange-Cyberdefense/rabid/blob/master/docs/CHANGELOG.md',
+    'documentation_uri' => 'https://orange-cyberdefense.github.io/rabid/',
+    'homepage_uri'      => 'https://orange-cyberdefense.github.io/rabid/',
+    'source_code_uri'   => 'https://github.com/Orange-Cyberdefense/rabid/',
+  }
+
+  s.required_ruby_version = '~> 2.4'
+
+  s.add_runtime_dependency('docopt', '~> 0.6') # for argument parsing
+  s.add_runtime_dependency('paint', '~> 2.1') # for colorized ouput
+
+  s.add_development_dependency('bundler', '~> 2.0')
+  s.add_development_dependency('commonmarker', '~> 0.18') # for GMF support in YARD
+  s.add_development_dependency('github-markup', '~> 3.0') # for GMF support in YARD
+  s.add_development_dependency('minitest', '~> 5.11')
+  s.add_development_dependency('rake', '~> 12.3')
+  s.add_development_dependency('redcarpet', '~> 3.4') # for GMF support in YARD
+  s.add_development_dependency('rubocop', '~> 0.63')
+  s.add_development_dependency('yard', '~> 0.9')
+end

data/bin/rabid

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Ruby internal
+require 'pp'
+# Project internal
+require 'bigipcookie'
+# External
+require 'docopt'
+require 'paint'
+
+doc = <<~DOCOPT
+  RABID (RApid Big IP Decoder)
+
+  Usage:
+    rabid [options] <raw_cookie>
+    rabid -h | --help
+    rabid --version
+
+  Options:
+    --ipv6-long-format  Display IPv6 address in long format
+    --no-color          Disable colorized output
+    --short             Display in a short format: display only decoded cookies
+    --debug             Display arguments
+    -h, --help          Show this screen
+    --version           Show version
+
+  Examples:
+    rabid 'BIGipServer<pool_name>=1677787402.36895.0000' --no-color --short
+    rabid 'rd5o00000000000000000000ffffc0000201o80'
+    rabid 'CustomeCookieName=vi20010112000000000000000000000030.20480' --ipv6-long-format
+    rabid 'BIGipServer~SuperPool=rd3o20010112000000000000000000000030o80' --debug
+DOCOPT
+
+begin
+  args = Docopt.docopt(doc, version: BigIPCookie::VERSION)
+  pp args if args['--debug']
+  # use case 1, using the tool
+  if args['<raw_cookie>']
+    bip = BigIPCookie::Decode.new(args['<raw_cookie>'])
+    opts = {}
+    opts[:ipv6compression] = 0 if args['--ipv6-long-format']
+    bip.auto_decode(opts)
+    # Display
+    if args['--no-color']
+      if args['--short']
+        puts bip.decoded_cookie
+      else
+        puts "Pool name: #{bip.pool_name}"
+        puts "Cookie type: #{bip.cookie_type}"
+        puts "Raw cookie: #{bip.raw_cookie}"
+        puts "Decoded cookie: #{bip.decoded_cookie}"
+      end
+    elsif args['--short']
+      puts Paint[bip.decoded_cookie, :green]
+    else
+      puts Paint['Pool name:', :white, :bold] + ' ' + bip.pool_name
+      puts Paint['Cookie type:', :white, :bold] + ' ' + bip.cookie_type
+      puts Paint['Raw cookie:', :white, :bold] + ' ' + bip.raw_cookie
+      puts Paint['Decoded cookie:', :white, :bold] + ' ' + Paint[bip.decoded_cookie, :green]
+    end
+  end
+  # use case 2, help: already handled by docopt
+  # use case 3, version: already handled by docopt
+rescue Docopt::Exit => e
+  puts e.message
+end

data/bin/rabid_console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bigipcookie'
+require 'irb'
+
+IRB.start(__FILE__)

data/bin/rabid_setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/docs/About.md

@@ -0,0 +1,11 @@
+# About
+
+# References
+
+BigIP cookie decoding is done following the official methode provided by F5: https://support.f5.com/csp/article/K6917
+
+IPv6 URL format try to respect RFC2732: https://tools.ietf.org/html/rfc2732
+
+## Logo
+
+Logo made with [DesignEvo](https://www.designevo.com).

data/docs/CHANGELOG.md

@@ -0,0 +1 @@
+# Changelog

data/docs/README.md

@@ -0,0 +1,13 @@
+# RABID
+
+> **RA**pid **B**ig **I**P **D**ecoder
+
+## What it is
+
+A CLI tool and library allowing to simply decode all kind of BigIP cookies.
+
+## Features
+
+- Support all 4 cookie formats
+- CLI tool & library
+- Hackable

data/docs/_coverpage.md

@@ -0,0 +1,14 @@
+![](_media/logo.png)
+
+# RABID
+
+> **RA**pid **B**ig **I**P **D**ecoder
+
+- Support all 4 cookie formats
+- CLI tool & library
+- Hackable
+
+[GitHub]()
+[Get Started](pages/quick-start?id=quick-start)
+
+![color](#ffffff)

data/docs/_navbar.md

@@ -0,0 +1,2 @@
+- [Home](/)
+- [Source](https://github.com/Orange-Cyberdefense/rabid/)

data/docs/_sidebar.md

@@ -0,0 +1,15 @@
+- Getting started
+
+  - [Quick start](pages/quick-start.md)
+  - [Installation](pages/install.md)
+  - [Usage](pages/usage.md)
+  - [Demo](pages/demo.md)
+
+- Guide
+
+  - [Documentation](pages/documentation.md)
+  - [Publishing](pages/publishing.md)
+
+- [Why?](why.md)
+- [About](About.md)
+- [Changelog](CHANGELOG.md)

data/docs/index.html

@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Document</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="vendor/themes/vue.css">
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: 'RABID',
+      repo: 'https://github.com/Orange-Cyberdefense/rabid/',
+      loadSidebar: true,
+      subMaxLevel: 2,
+      loadNavbar: true,
+      coverpage: true,
+      logo: '_media/logo.png',
+      themeColor: '#FF6600',
+      search: 'auto',
+    }
+  </script>
+  <script src="vendor/docsify.js"></script>
+  <script src="vendor/plugins/search.min.js"></script>
+  <script src="vendor/plugins/emoji.min.js"></script>
+  <script src="vendor/prismjs/components/prism-ruby.min.js"></script>
+</body>
+</html>

data/docs/pages/demo.md

@@ -0,0 +1,3 @@
+# Demonstration
+
+Asciinema

data/docs/pages/documentation.md

@@ -0,0 +1,34 @@
+# Documentation 
+
+## CLI doc
+
+See [Usage](pages/usage.md?id=cli).
+
+## Server locally
+
+```
+$ npm i docsify-cli -g
+$ docsify serve docs
+```
+
+## Library doc
+
+The output directory of the library documentation will be `docs/yard`.
+
+You can consult it online [here](rabid/yard/).
+
+### Building locally: for library users
+
+For developers who only want to use the RABID library.
+
+```
+$ bundle exec yard doc
+```
+
+### Building locally: for RABID developer
+
+For developers who want to participate to RABID development.
+
+```
+$ bundle exec yard doc --yardopts .yardopts-dev
+```

data/docs/pages/install.md

@@ -0,0 +1,60 @@
+# Installation
+
+## Production
+
+### Install from rubygems.org
+
+```
+$ gem install rabid
+```
+
+### Install from BlackArch
+
+```
+# pacman -S rabid
+```
+
+## Development
+
+It's better to use [rbenv](https://github.com/rbenv/rbenv) to have latests version of ruby and to avoid trashing your system ruby.
+
+### Install from rubygems.org
+
+```
+$ gem install --development rabid
+```
+
+### Build from git
+
+Just replace `x.x.x` with the gem version you see after `gem build`.
+
+```
+$ git clone https://XXX/XXX/rabid.git rabid
+$ cd rabid
+$ gem install bundler
+$ bundler install
+$ gem build rabid.gemspec
+$ gem install rabid-x.x.x.gem
+```
+
+Note: if an automatic install is needed you can get the version with `$ gem build bigipcookie.gemspec | grep Version | cut -d' ' -f4`.
+
+### Run the library in irb without installing the gem
+
+From local file:
+
+```
+$ irb -Ilib -rbigipcookie
+```
+
+From the installed gem:
+
+```
+$ rabid_console
+```
+
+Same for the CLI tool:
+
+```
+$ ruby -Ilib -rbigipcookie bin/rabid
+```

data/docs/pages/publishing.md

@@ -0,0 +1,38 @@
+# Publishing
+
+## On Rubygems.org
+
+```
+$ git tag vx.x.x
+$ gem push rabid-x.x.x.gem
+```
+
+See https://guides.rubygems.org/publishing/.
+
+On new release don't forget to rebuild the library documentation:
+
+```
+$ bundle exec yard doc
+```
+
+An to be sure all tests pass!
+
+```
+$ rake
+```
+
+## On BlackArch
+
+BA process
+
+On new release don't forget to rebuild the library documentation:
+
+```
+$ bundle exec yard doc
+```
+
+An to be sure all tests pass!
+
+```
+$ rake
+```

data/docs/pages/quick-start.md

@@ -0,0 +1,30 @@
+# Quick start
+
+## Quick install
+
+```
+$ gem install rabid
+```
+
+## Default usage: CLI
+
+```
+$ rabid 'BIGipServer<pool_name>=1677787402.36895.0000'
+Pool name: <pool_name>
+Cookie type: IPv4 pool members
+Raw cookie: BIGipServer<pool_name>=1677787402.36895.0000
+Decoded cookie: 10.1.1.100:8080
+```
+
+## Default usage: library
+
+```ruby
+require 'bigipcookie'
+
+# IPv4 pool members, with pool name
+bip = BigIPCookie::Decode.new('BIGipServer<pool_name>=1677787402.36895.0000')
+# Automatically decode
+bip.auto_decode
+# Print result
+puts "Cookie: #{bip.decoded_cookie}"
+```

data/docs/pages/usage.md

@@ -0,0 +1,53 @@
+# Usage
+
+## CLI
+
+```
+$ rabid --help
+RABID (RApid Big IP Decoder)
+
+Usage:
+  rabid [options] <raw_cookie>
+  rabid -h | --help
+  rabid --version
+
+Options:
+  --ipv6-long-format  Display IPv6 address in long format
+  --no-color          Disable colorized output
+  --short             Display in a short format: display only decoded cookies
+  --debug             Display arguments
+  -h, --help          Show this screen
+  --version           Show version
+
+Examples:
+  rabid 'BIGipServer<pool_name>=1677787402.36895.0000' --no-color --short
+  rabid 'rd5o00000000000000000000ffffc0000201o80'
+  rabid 'CustomeCookieName=vi20010112000000000000000000000030.20480' --ipv6-long-format
+  rabid 'BIGipServer~SuperPool=rd3o20010112000000000000000000000030o80' --debug
+```
+
+## Library
+
+```ruby
+require 'bigipcookie'
+
+# IPv4 pool members, with pool name
+bip = BigIPCookie::Decode.new('BIGipServer<pool_name>=1677787402.36895.0000')
+# Automatically decode
+bip.auto_decode
+# Access the decoded value
+bip.decoded_cookie
+# Access the pool name
+bip.pool_name
+# Access the cookie type
+bip.cookie_type
+```
+
+## Console
+
+Launch `irb` with the library loaded.
+
+```
+$ rabid_console 
+irb(main):001:0> 
+```