reconmap / rest-api Goto Github PK

View Code? Open in Web Editor NEW

47.0 6.0 22.0 13.95 MB

REST API backend for Reconmap

Home Page: https://reconmap.com

License: Apache License 2.0

Makefile 0.51% Dockerfile 0.48% PHP 97.24% Shell 0.08% HTML 0.57% Twig 0.99% JavaScript 0.12%

security secdevops vulnerability reconnaissance pentesting cve ipe nmap hacktoberfest api

rest-api's Introduction

Reconmap

Reconmap is a vulnerability assessment and penetration testing platform that helps pentesters and other infosec teams collaborate on security projects, from planning, to testing and reporting. The tool's aim is to go from recon to report in the least possible time.

Demo

Details on how to connect to the live demo server can be found here.

Documentation

Go to https://docs.reconmap.com to find the user, admin and developer manuals.

Runtime requirements

Docker
Docker compose 2+

How to run it locally with Docker compose

First you need to start your docker containers:

docker-compose up -d

After this, open your browser at http://localhost:5500

How to contribute

Here are some things you could do to become a contributor:

★ Star this project on Github ★
Read the documentation and improve it by opening a pull request against this repo.
Suggest new features or ideas to the discussion board
Improve the code of the backend, frontend or cli components
Report security issues

Before you jump to make any changes make sure you have read the contributing guidelines. This would save us all time. Thanks!

How to report bugs

If you have bugs to report please use the issues tab on Github to submit the details.

If you want to chat to somebody on the development team head to our Gitter channel.

rest-api's People

Stargazers

Watchers

rest-api's Issues

Fix "return_statements" issue in src/Services/Cvss.php

Avoid too many return statements within this method.

https://codeclimate.com/github/Reconmap/api-backend/src/Services/Cvss.php#issue_5f787993bf6317000100008a

Fix "return_statements" issue in src/Services/Cvss.php

Avoid too many return statements within this method.

https://codeclimate.com/github/Reconmap/api-backend/src/Services/Cvss.php#issue_5f5154e0b173290001000067

Fix "method_lines" issue in src/Controllers/Reports/GenerateReportController.php

Method __invoke has 62 lines of code (exceeds 25 allowed). Consider refactoring.

https://codeclimate.com/github/Reconmap/api-backend/src/Controllers/Reports/GenerateReportController.php#issue_5f762ce20cdd30000100008b

Auto generate config file during initial setup

If the config file is missing the application does not start and creates a bad onboarding experience. Auto generate config file during initial setup.

Test ticket from Code Climate

Fix "method_lines" issue in src/Controllers/Reports/GenerateReportController.php

Method __invoke has 49 lines of code (exceeds 25 allowed). Consider refactoring.

https://codeclimate.com/github/Reconmap/api-backend/src/Controllers/Reports/GenerateReportController.php#issue_5f5154e1b17329000100006b

Use different databases for testing and dev

Use different databases for testing and dev otherwise running the tests changes the data used in development and vice-versa.

Fix "method_lines" issue in src/Controllers/Users/CreateUserController.php

Method __invoke has 26 lines of code (exceeds 25 allowed). Consider refactoring.

https://codeclimate.com/github/Reconmap/api-backend/src/Controllers/Users/CreateUserController.php#issue_5f5154e1b17329000100006a

Do not add test data to blank installs

At the moment new installs come with a lot of test data that needs to be deleted afterwards. Separate test data from other data that is required for the app to function (eg vulnerability_category) so that users dont need to delete a lot of unwanted data on first use.

Run docker images as non-root user

Is your feature request related to a problem? Please describe.
Currently, there isn't a great way to use the Docker image as a non-root user (which is required in some situations).

Describe the solution you'd like
Always run the container as non-root, if possible.

Describe alternatives you've considered
Basing off the existing image and then making modifications, however, this requires maintainenance.

Additional context
N/A

Fix "method_lines" issue in src/ApiRouter.php

Method mapRoutes has 29 lines of code (exceeds 25 allowed). Consider refactoring.

https://codeclimate.com/github/Reconmap/api-backend/src/ApiRouter.php#issue_5f76d1a37cf1e60001000089

Fix "method_lines" issue in src/Controllers/Users/UsersLoginController.php

Method __invoke has 28 lines of code (exceeds 25 allowed). Consider refactoring.

https://codeclimate.com/github/Reconmap/api-backend/src/Controllers/Users/UsersLoginController.php#issue_5f762ce20cdd30000100008a

API-backend 500 Internal Server error

Describe the bug
After following instruction in readme, api-server is returning 500 Internal Server Error on wget.

To Reproduce
Steps to reproduce the behavior:

Git clone https://github.com/Reconmap/api-backend.git
cd api-backend
make
make tests
make start
wget localhost:8080 or wget localhost:8080/auditlog

user@host:/opt/github/api-backend# wget localhost:8080
--2021-02-03 15:30:22--  http://localhost:8080/
Resolving localhost (localhost)... ::1, 127.0.0.1
Connecting to localhost (localhost)|::1|:8080... connected.
HTTP request sent, awaiting response... 500 Internal Server Error
2021-02-03 15:30:22 ERROR 500: Internal Server Error.

root@kanga:/opt/github/api-backend# wget localhost:8080/auditlog
--2021-02-03 15:33:25--  http://localhost:8080/auditlog
Resolving localhost (localhost)... ::1, 127.0.0.1
Connecting to localhost (localhost)|::1|:8080... connected.
HTTP request sent, awaiting response... 500 Internal Server Error
2021-02-03 15:33:25 ERROR 500: Internal Server Error.

Expected behavior
A json response of some kind.

Desktop (please complete the following information):

OS: Unbuntu Server 18.04
Browser: N/A
Version: Git clone from today

Looking for information on how to generate logging information. No logging information.