ctf-party 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c9bbfee898723defee53d242711a127753c3bef4f6828477d4f686e4487713e
+  data.tar.gz: 69f0e9e1e7bb5fd27dcbd37b2c86d8ce6514307f3eb413d196e89822ad8e6e6e
+SHA512:
+  metadata.gz: 58b042d0a45a771eb5889438497c15c8126039016b70362d0dcffd58b41a35442735351a14d099744603a778a3dc9684e76a1f72334adca4b2124552205e0b2f
+  data.tar.gz: 35c6e42f0c33448bba0acfd9ac126221ac557cfd47f4042edf844aed7bccf0272aaba52e38ee184959dbe0c56630f10c08575b6f0be25e9eeb3bd2a21ac02537

data/.rubocop.yml

@@ -0,0 +1,29 @@
+# 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/BlockNesting:
+  Exclude:
+    - 'bin/*'
+Metrics/MethodLength:
+  Max: 25
+Metrics/PerceivedComplexity:
+  Max: 10
+Style/ClassVars:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+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,52 @@
+PATH
+  remote: .
+  specs:
+    ctf-party (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    commonmarker (0.20.1)
+      ruby-enum (~> 0.5)
+    concurrent-ruby (1.1.5)
+    github-markup (3.0.4)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.3)
+    minitest (5.12.2)
+    parallel (1.18.0)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    redcarpet (3.5.0)
+    rubocop (0.75.1)
+      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.20)
+  ctf-party!
+  github-markup (~> 3.0)
+  minitest (~> 5.11)
+  rake (~> 12.3)
+  redcarpet (~> 3.4)
+  rubocop (~> 0.63)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.0.2

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,57 @@
+# ctf-party
+
+[![Gem Version](https://badge.fury.io/rb/ctf-party.svg)](https://badge.fury.io/rb/ctf-party)
+![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/Orange-Cyberdefense/ctf-party)
+[![GitHub forks](https://img.shields.io/github/forks/Orange-Cyberdefense/ctf-party)](https://github.com/Orange-Cyberdefense/ctf-party/network)
+[![GitHub stars](https://img.shields.io/github/stars/Orange-Cyberdefense/ctf-party)](https://github.com/Orange-Cyberdefense/ctf-party/stargazers)
+[![GitHub license](https://img.shields.io/github/license/Orange-Cyberdefense/ctf-party)](https://github.com/Orange-Cyberdefense/ctf-party/blob/master/LICENSE.txt)
+[![Rawsec's CyberSecurity Inventory](https://inventory.rawsec.ml/img/badges/Rawsec-inventoried-FF5050_flat.svg)](https://inventory.rawsec.ml/tools.html#ctf-party)
+
+[![Packaging status](https://repology.org/badge/vertical-allrepos/ctf-party.svg)](https://repology.org/project/ctf-party/versions)
+
+![](https://orange-cyberdefense.github.io/ctf-party/_media/logo.png)
+
+
+## What it is
+
+A library to enhance and speed up script/exploit writting for CTF players (or
+security researchers, bug bounty hunters, pentesters but mostly focused on CTF)
+by patching the String class to add a short syntax of usual code patterns.
+The philosophy is also to keep the library to be pure ruby (no dependencies)
+and not to re-implement what another library is already doing well
+(eg.[xorcist] for xor).
+
+[xorcist]:https://github.com/fny/xorcist
+
+For example instead of writting:
+
+```ruby
+require 'base64'
+
+myvar = 'string'
+myvar = Base64.strict_encode64(myvar)
+```
+
+Just write (shorter and easier to remember):
+
+```ruby
+require 'ctf_library'
+
+myvar = 'string'
+myvar.to_b64!
+```
+
+## Features
+
+- base64: `to_b64`, `to_b64!`, `from_b64`, `from_b64!`, `b64?`
+- digest: `md5`, `md5!`, `sha1`, `sha1!`, etc.
+- flag: `flag`, `flag!`, `flag?` (apply/check a flag format)
+- rot: `rot`, `rot!`, `rot13`, `rot13!`
+
+## References
+
+Homepage / Documentation: https://orange-cyberdefense.github.io/ctf-party/
+
+## Author
+
+Made by Alexandre ZANNI ([@noraj](https://github.com/noraj)), pentester from Orange Cyberdefense.

data/Rakefile

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

data/bin/ctf_party_console

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

data/bin/ctf_party_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,5 @@
+# About
+
+## Logo
+
+Logo made with [DesignEvo](https://www.designevo.com).

data/docs/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## [1.0.0]
+
+- Initial version

data/docs/README.md

@@ -0,0 +1,52 @@
+# ctf-party
+
+[![Gem Version](https://badge.fury.io/rb/ctf-party.svg)](https://badge.fury.io/rb/ctf-party)
+![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/Orange-Cyberdefense/ctf-party)
+[![GitHub forks](https://img.shields.io/github/forks/Orange-Cyberdefense/ctf-party)](https://github.com/Orange-Cyberdefense/ctf-party/network)
+[![GitHub stars](https://img.shields.io/github/stars/Orange-Cyberdefense/ctf-party)](https://github.com/Orange-Cyberdefense/ctf-party/stargazers)
+[![GitHub license](https://img.shields.io/github/license/Orange-Cyberdefense/ctf-party)](https://github.com/Orange-Cyberdefense/ctf-party/blob/master/LICENSE.txt)
+[![Rawsec's CyberSecurity Inventory](https://inventory.rawsec.ml/img/badges/Rawsec-inventoried-FF5050_flat.svg)](https://inventory.rawsec.ml/tools.html#ctf-party)
+
+## What it is
+
+A library to enhance and speed up script/exploit writting for CTF players (or
+security researchers, bug bounty hunters, pentesters but mostly focused on CTF)
+by patching the String class to add a short syntax of usual code patterns.
+The philosophy is also to keep the library to be pure ruby (no dependencies)
+and not to re-implement what another library is already doing well
+(eg.[xorcist] for xor).
+
+[xorcist]:https://github.com/fny/xorcist
+
+For example instead of writting:
+
+```ruby
+require 'base64'
+
+myvar = 'string'
+myvar = Base64.strict_encode64(myvar)
+```
+
+Just write (shorter and easier to remember):
+
+```ruby
+require 'ctf_party'
+
+myvar = 'string'
+myvar.to_b64!
+```
+
+## Features
+
+- base64: `to_b64`, `to_b64!`, `from_b64`, `from_b64!`, `b64?`
+- digest: `md5`, `md5!`, `sha1`, `sha1!`, etc.
+- flag: `flag`, `flag!`, `flag?` (apply/check a flag format)
+- rot: `rot`, `rot!`, `rot13`, `rot13!`
+
+## References
+
+Homepage / Documentation: https://orange-cyberdefense.github.io/ctf-party/
+
+## Author
+
+Made by Alexandre ZANNI ([@noraj](https://github.com/noraj)), pentester from Orange Cyberdefense.

data/docs/_coverpage.md

@@ -0,0 +1,10 @@
+![](_media/logo.png)
+
+# ctf-party
+
+A Ruby library to enhance and speed up script/exploit writting for CTF players.
+
+[GitHub](https://github.com/Orange-Cyberdefense/ctf-party/)
+[Get Started](pages/quick-start?id=quick-start)
+
+![color](#ffffff)

data/docs/_navbar.md

@@ -0,0 +1,3 @@
+- [Home](/)
+- [Doc](https://orange-cyberdefense.github.io/ctf-party/yard/)
+- [Source](https://github.com/Orange-Cyberdefense/ctf-rabid/)

data/docs/_sidebar.md

@@ -0,0 +1,13 @@
+- Getting started
+
+  - [Quick start](pages/quick-start.md)
+  - [Installation](pages/install.md)
+  - [Usage](pages/usage.md)
+
+- Guide
+
+  - [Documentation](pages/documentation.md)
+  - [Publishing](pages/publishing.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: 'ctf-party',
+      repo: 'https://github.com/Orange-Cyberdefense/ctf-party/',
+      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/documentation.md

@@ -0,0 +1,30 @@
+# Documentation 
+
+## 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](https://orange-cyberdefense.github.io/ctf-party/yard/).
+
+### Building locally: for library users
+
+For developers who only want to use the library.
+
+```
+$ bundle exec yard doc
+```
+
+### Building locally: for developer
+
+For developers who want to participate to the development.
+
+```
+$ bundle exec yard doc --yardopts .yardopts-dev
+```

data/docs/pages/install.md

@@ -0,0 +1,84 @@
+# Installation
+
+## Production
+
+### Install from rubygems.org
+
+```
+$ gem install ctf-party
+```
+
+Gem: [ctf-party](https://rubygems.org/gems/ctf-party)
+
+### Install from BlackArch
+
+From the repository:
+
+```
+# pacman -S ruby-ctf-party
+```
+
+From git:
+
+```
+# blackman -i ruby-ctf-party
+```
+
+PKGBUILD: [ruby-ctf-party](https://github.com/BlackArch/blackarch/blob/master/packages/ruby-ctf-party/PKGBUILD)
+
+### Install from ArchLinux
+
+Manually:
+
+```
+$ git clone https://aur.archlinux.org/ruby-ctf-party.git
+$ cd ruby-ctf-rabid
+$ makepkg -sic
+```
+
+With an AUR helper ([Pacman wrappers](https://wiki.archlinux.org/index.php/AUR_helpers#Pacman_wrappers)), eg. pikaur:
+
+```
+$ pikaur -S ruby-ctf-rabid
+```
+
+AUR: [ruby-ctf-rabid](https://aur.archlinux.org/packages/ruby-ctf-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 ctf-party
+```
+
+### Build from git
+
+Just replace `x.x.x` with the gem version you see after `gem build`.
+
+```
+$ git clone https://github.com/Orange-Cyberdefense/ctf-party.git rabid
+$ cd ctf-party
+$ gem install bundler
+$ bundler install
+$ gem build ctf_party.gemspec
+$ gem install ctf-party-x.x.x.gem
+```
+
+Note: if an automatic install is needed you can get the version with `$ gem build ctf_party.gemspec | grep Version | cut -d' ' -f4`.
+
+### Run the library in irb without installing the gem
+
+From local file:
+
+```
+$ irb -Ilib -rctf_party
+```
+
+From the installed gem:
+
+```
+$ ctf_party_console
+```