View Issue Details

IDProjectCategoryView StatusLast Update
0003997Kali Linux[All Projects] New Tool Requestspublic2020-03-25 13:15
ReporterSenni Assigned To 
PrioritynormalSeverityfeatureReproducibilityN/A
Status closedResolutionsuspended 
Product Version 
Target VersionFixed in Version 
Summary0003997: rtfm.py
DescriptionAloha there, I would like to request a tool to be included within Kali, named RTFM its a simple 'cheatsheet' program which aimed to expand on man pages / inbuilt helps, acting as a simple central tool reference.

Available from github:
https://github.com/leostat/rtfm

Prebuilt Deb:
https://github.com/leostat/rtfm/raw/master/rtfm_0.96-RC1_all.deb

Documentation available on the git, and on my website here:
https://necurity.co.uk/osprog/2017-02-27-RTFM-Pythonized/

The program grabs its updates from GIT, and is wrote and maintained by myself. Currently GPL3 licence.

Is the tool useful/functional in a Penetration Testing environment?
 * Acts as a quick reference for commonly used commands. Handy for commands which you may not use all the time!

Does the tool overlap functionality of other existing tools?
 * Ish, it replicates Man Pages / Help pages. Not aware of another offline version of this, similar to the RTFM book (hence the name).

Does the licensing of the tool allow for free redistribution?
 * Should do! (To my understanding that is!)

How much resources does the tool require? Will it work in a “standard” environment?
 * Low requirements, Python2, sqlite3. Probably will port to python3 'Soon'

Main area of dev is the DB content at the moment.

(Side non related Q, Product version for the tracker doesn't have 2017.1, that expected?)
Additional InformationInstallation in a 'Basic' kali 2017.1 :

root@kali:~# dpkg -i rtfm_0.96-RC1_all.deb
Selecting previously unselected package rtfm.
(Reading database ... 326051 files and directories currently installed.)
Preparing to unpack rtfm_0.96-RC1_all.deb ...
Unpacking rtfm (0.96-RC1) ...
Setting up rtfm (0.96-RC1) ...
root@kali:~# rtfm.py -u
[WARNING]: Unable to have pretty output, Please 'pip install terminaltables' or remove these lines :)
[WARNING]: No DB, please run rtfm -u
[OK]: This may appear to hang. Its due to my bad SQL, sorry, run with debug to get more info
[OK]: Added Rows :1
[OK]: Added a new tag and a tagmap
[OK]: Added a new Ref and a refmap
[OK]: Added a new Ref and a refmap
[OK]: Added Rows :1
<Snip of other OK's>

root@kali:~# rtfm.py -c rtfm
[WARNING]: Unable to have pretty output, Please 'pip install terminaltables' or remove these lines :)
++++++++++++++++++++++++++++++
Command ID : 1
Command : rtfm.py -c [command] -t [tag],[tag] -C [comment] -p P

Comment : Helpception, search for a command with two tags and a comment
Tags : linux
Date Added : 2017-05-07
Added By : Innes
References
__________
https://github.com/leostat/rtfm
https://necurity.co.uk/osprog/2017-02-27-RTFM-Pythonized/index.html
++++++++++++++++++++++++++++++


Activities

Senni

2017-06-13 21:44

reporter   ~0006819

Updated the program and the deb to 0.98, it now has version checking and errata to fix the typos which work their way into the DB (My bad!)

g0tmi1k

2018-01-29 15:12

administrator   ~0008466

To help speed up the process of evaluating the tool, please make sure to include the following information (the more information you include, the more beneficial it will for us):

- [Name] - The name of the tool
- [Version] - What version of the tool should be added?
--- If it uses source control (such as git), please make sure there is a release to match (e.g. git tag)
- [Homepage] - Where can the tool be found online? Where to go to get more information?
- [Download] - Where to go to get the tool?
- [Author] - Who made the tool?
- [Licence] - How is the software distributed? What conditions does it come with?
- [Description] - What is the tool about? What does it do?
- [Dependencies] - What is needed for the tool to work?
- [Similar tools] - What other tools are out there?
- [How to install] - How do you compile it?
- [How to use] - What are some basic commands/functions to demonstrate it?

Senni

2018-07-17 21:17

reporter   ~0009369

Apologies for the slow response, I will try to include all the needed info!

- [Name] - The name of the tool
* RTFM.py


- [Version] - What version of the tool should be added?
*1.0.1 - I think i need to add a git Tag, i will look at this shortly


- [Homepage] - Where can the tool be found online? Where to go to get more information?
* It is currently hosted on github with a slight readme

There is also a write up online at
https://necurity.co.uk/osprog/2017-02-27-RTFM-Pythonized/


- [Download] - Where to go to get the tool?
* github.com/leostat/rtfm


- [Author] - Who made the
 * Alex Innes (Myself)
 * The content is community sourced, and i have tried to link to where i get the information from


- [Licence] - How is the software distributed? What conditions does it come

 * GNU GENERAL PUBLIC LICENSE
The idea is its just meant to be use how people want.


- [Description] - What is the tool about? What does it do?

Its a collection of useful 'Stuff', think man pages but focusing on the common uses of commands, with links to where more information can be found about it.

It uses a local sqlite database to hold tags / references / commands and allows a user to search them, think a little scratchpad of quick commands or lists of things like XSS strings.

The user is able to add to this easily, and thats kind of it!


- [Dependencies] - What is needed for the tool to work?
Python3

The user can install terminal tables for a nicer looking output


- [Similar tools] - What other tools are out there?
Man pages, aparos, tool help. This does not intend to replace these, and will not aim to document tools. Just common use


- [How to install] - How do you compile it?
Git clone, update, done


- [How to use] - What are some basic commands/functions to demonstrate it?
# Grab and mark as executable
git clone github.com/leostat/rtfm
chmod +x rtfm/rtfm.py

# Check the source to make sure im not a back door :D

# Create a database and Download updates
./rtfm/rtfm.py -u

# Look for some xss strings
./rtfm/rtfm.py -e xss -pc

# Look for commands marked as a shell
./rtfm.py -r shell

g0tmi1k

2020-03-25 13:13

administrator   ~0012524

This program looks like it hasn't recently received any updates.
If development picks up again, we will re-evaluate

Issue History

Date Modified Username Field Change
2017-05-07 01:31 Senni New Issue
2017-06-13 21:44 Senni Note Added: 0006819
2018-01-29 14:24 g0tmi1k Summary Tool Addition - rtfm.py => rtfm.py
2018-01-29 15:12 g0tmi1k Note Added: 0008466
2018-02-21 09:35 g0tmi1k Product Version 2016.2 =>
2018-07-17 21:17 Senni Note Added: 0009369
2018-07-17 22:16 elwood Status new => acknowledged
2019-12-09 13:29 g0tmi1k Priority low => normal
2019-12-09 13:30 g0tmi1k Severity minor => feature
2019-12-09 13:30 g0tmi1k Status acknowledged => new
2020-03-25 13:13 g0tmi1k Status new => closed
2020-03-25 13:13 g0tmi1k Resolution open => suspended
2020-03-25 13:13 g0tmi1k Note Added: 0012524