An API for ssh_scan (https://github.com/mozilla/ssh_scan) and the backend API service for the Mozilla SSH Observatory (https://observatory.mozilla.org/)
Перейти к файлу
Jonathan Claudius bae5217da1
Update README.md
2021-02-16 10:37:50 -05:00
bin A bunch of misc improvements and tweaks to isolate API component 2018-06-26 11:42:05 -04:00
config Tune up travis setup 2018-06-26 15:01:53 -04:00
cron Letsencrypt update script 2017-08-01 16:04:36 -04:00
data Add data stub for worker to build properly 2018-01-23 10:38:08 -05:00
database Tweaks to rakefile and init db for travis 2018-06-26 11:57:57 -04:00
db Fix indentation on migration script 2018-01-23 10:46:40 -05:00
docker Clean up API docker setup 2018-06-27 10:52:31 -04:00
examples Now have a working docker setup, w00t 2018-01-12 14:44:39 -05:00
lib Re-add status key to scan results 2018-09-17 11:27:25 -04:00
nginx Initial import of ssh_scan_api into it's own project 2017-03-01 23:27:10 -05:00
scripts Fix up batch scanning 2018-01-19 17:34:08 -05:00
spec Tune up travis setup 2018-06-26 15:01:53 -04:00
.gitignore A bunch of misc improvements and tweaks to isolate API component 2018-06-26 11:42:05 -04:00
.rspec More prep for ssh_scan_api debute 2017-03-02 00:20:31 -05:00
.travis.yml Update travis versions 2019-01-15 10:01:48 -05:00
CODE_OF_CONDUCT.md Add Mozilla Code of Conduct file 2019-03-29 23:10:53 -07:00
CONTRIBUTING.md Fix contributing 2017-03-01 23:57:55 -05:00
Dockerfile Update Dockerfile 2019-01-15 09:59:07 -05:00
Gemfile A bunch of misc improvements and tweaks to isolate API component 2018-06-26 11:42:05 -04:00
README.md Update README.md 2021-02-16 10:37:50 -05:00
Rakefile Tune up travis setup 2018-06-26 15:01:53 -04:00
build_and_deploy_to_dockerhub.sh Actually add the docker script 2018-06-27 10:44:44 -04:00
config.ru Restore config.ru for travis runs 2018-06-26 11:50:02 -04:00
docker-compose.yml Add useful context comments to docker-compose 2018-06-28 12:11:46 -04:00
ssh_scan_api.gemspec Add coveralls 2018-06-26 15:11:20 -04:00

README.md

WARNING Deprecated - please use ssh_scan from command-line

ssh_scan_api

Build Status Code Climate Gem Version Join the chat at https://gitter.im/mozilla-ssh_scan/Lobby Coverage Status

A web api to scale ssh_scan operations

Setup

To install and run from source, type:

# clone repo
git clone https://github.com/mozilla/ssh_scan_api.git
cd ssh_scan_api

# install rvm,
# you might have to provide root to install missing packages
gpg2 --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3
curl -sSL https://get.rvm.io | bash -s stable

# install Ruby 2.3.1 with rvm,
# again, you might have to install missing devel packages
rvm install 2.3.1
rvm use 2.3.1

# resolve dependencies
gem install bundler
bundle install

./bin/ssh_scan_api

ssh_scan as a command-line tool?

This project is focused on providing ssh_scan as a service/API.

If you would like to run ssh_scan from command-line, checkout the ssh_scan project.

Rubies Supported

This project is integrated with travis-ci and is regularly tested to work with multiple rubies.

To checkout the current build status for these rubies, click here.

Contributing

If you are interested in contributing to this project, please see CONTRIBUTING.md.

Credits

Sources of Inspiration for ssh_scan

  • Mozilla OpenSSH Security Guide - For providing a sane baseline policy recommendation for SSH configuration parameters (eg. Ciphers, MACs, and KexAlgos).