Merge pull request #1 from smalex86/dev

2020-02-17

Author: smalex86

.gitignore

@@ -34,3 +34,6 @@
 /yarn-error.log
 yarn-debug.log*
 .yarn-integrity
+
+# docker
+/docker/postgresql/db/

Gemfile

@@ -31,11 +31,15 @@ gem 'bootsnap', '>= 1.4.2', require: false
 # grape
 gem 'grape'
 gem 'grape-entity'
+gem 'grape_on_rails_routes'
 
 # sidekiq
 gem 'sidekiq'
 gem 'sidekiq-scheduler'
 
+# postgres
+gem 'pg'
+
 group :development, :test do
   # Call 'byebug' anywhere in the code to stop execution and get a debugger console
   gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
@@ -50,7 +54,7 @@ group :development do
   gem 'spring-watcher-listen', '~> 2.0.0'
 
   gem 'solargraph'
-  
+
   # rebocop
   gem 'rubocop'
   gem 'rubocop-performance'

Gemfile.lock

@@ -119,6 +119,8 @@ GEM
     grape-entity (0.7.1)
       activesupport (>= 4.0)
       multi_json (>= 1.3.2)
+    grape_on_rails_routes (0.3.2)
+      rails (>= 3.1.1)
     i18n (1.8.2)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
@@ -153,6 +155,7 @@ GEM
     parallel (1.19.1)
     parser (2.7.0.2)
       ast (~> 2.4.0)
+    pg (1.2.2)
     public_suffix (4.0.3)
     puma (4.3.1)
       nio4r (~> 2.0)
@@ -309,8 +312,10 @@ DEPENDENCIES
   capybara (>= 2.15)
   grape
   grape-entity
+  grape_on_rails_routes
   jbuilder (~> 2.7)
   listen (>= 3.0.5, < 3.2)
+  pg
   puma (~> 4.1)
   rails (~> 6.0.2, >= 6.0.2.1)
   rubocop

Procfile

@@ -0,0 +1,2 @@
+web: bundle exec rails server -p $PORT
+worker: bundle exec sidekiq -c 5

README.md

@@ -1,24 +1,62 @@
-# README
-
-This README would normally document whatever steps are necessary to get the
-application up and running.
-
-Things you may want to cover:
-
-* Ruby version
-
-* System dependencies
-
-* Configuration
-
-* Database creation
-
-* Database initialization
-
-* How to run the test suite
-
-* Services (job queues, cache servers, search engines, etc.)
-
-* Deployment instructions
-
-* ...
+# Мониторинг сертификатов SSL
+
+## Описание функционала
+
+Приложение реализует следующий функционал:
+* В базу добавляются домены, для которых нужно отслеживать
+проблемы с SSL сертификатами
+* Нельзя дважды добавить один и тот же домен
+* У домена есть два статуса - "Всё хорошо" и "Всё плохо"
+* По результатам проверки у домена меняется статус
+* Текст ошибки сохраняется в той же модели
+* Проверки происходят в фоне, раз в 20 минут
+* Подключен веб-интерфейс sidekiq и закрыт Basic-авторизацией
+* Для проверки используется openssl, проверка происходит внутри приложения без
+использования сторонних API и сервисов
+* Интерфейс не реализовыван, только API
+
+## API
+
+Реализованы следующие методы:
+* `GET /status` - выводит все домены с их текущим состоянием
+* `POST /domain` - добавляет новый домен в список, при добавлении домена выполняется его проверка
+
+## Запуск приложения
+
+### 1. Установка гемов
+```ruby
+bundle install
+```
+
+## 2. Запуск служб
+
+Если в системе не установлены postgresql и redis, то запустить их через
+docker-compose:
+
+```bash
+cd docker
+./services-up.sh
+```
+
+Для остановки контейнеров docker использовать следующий скрипт:
+```bash
+cd docker
+./services-down.sh
+```
+
+## 3. Создание базы данных и ее структуры
+
+```bash
+rails db:create
+rails db:migrate
+```
+
+## 4. Запуск приложения
+```bash
+rails s
+```
+
+## 5. Запуск sidekiq
+```bash
+bundle exec sidekiq
+```

app/api/ssl_monitor/base.rb

@@ -0,0 +1,5 @@
+module SslMonitor
+  class Base < Grape::API
+    mount SslMonitor::Certificates
+  end
+end

app/api/ssl_monitor/certificates.rb

@@ -0,0 +1,24 @@
+module SslMonitor
+  class Certificates < Grape::API
+    format :json
+
+    desc 'Добавление нового домена' do
+      params SslMonitor::Entities::Certificate.documentation
+    end
+    post '/domain' do
+      c = Certificate.create!(domain: params[:domain])
+      c.check
+      present c, with: SslMonitor::Entities::Certificate
+    rescue StandardError => e
+      { result: 'bad', error: e.message }
+    end
+
+    desc 'Список доменов с их статусами проверки сертификатов'
+    get '/status' do
+      present(
+        Certificate.all.order(:domain),
+        with: SslMonitor::Entities::Certificate
+      )
+    end
+  end
+end

app/api/ssl_monitor/entities/certificate.rb

@@ -0,0 +1,16 @@
+module SslMonitor
+  module Entities
+    class Certificate < Grape::Entity
+      expose :domain, documentation: { type: 'string', desc: 'Домен для проверки' }
+      expose :formatted_status, as: :status
+      expose :error
+      expose :updated_at
+
+      private
+
+      def formatted_status
+        object.status.to_i.zero? ? 'Всё хорошо' : 'Всё плохо'
+      end
+    end
+  end
+end

app/jobs/monitor_job.rb

@@ -0,0 +1,5 @@
+class MonitorJob < ApplicationJob
+  def perform
+    Certificate.check
+  end
+end

app/models/certificate.rb

@@ -0,0 +1,70 @@
+class Certificate < ApplicationRecord
+  ONE_DAY = 86_400
+
+  require 'net/http'
+  require 'openssl'
+
+  # Коррекция домена перед создание записи
+  before_create do
+    self.domain = URI.parse(domain).host if domain.present?
+    self.error = '' if error.nil?
+    self.status = 0 if status.nil?
+  end
+
+  # Выполнить проверку сертификата домена
+  def check
+    set_ok
+    begin
+      check_expired(cert.not_after)
+    rescue Errno::ECONNREFUSED => e
+      self.error = "Ошибка соединения: #{e.message}"
+    rescue OpenSSL::SSL::SSLError => e
+      ssl_error(e.message)
+    rescue StandardError => e
+      self.error = "Ошибка: #{e.message}"
+    end
+    self.status = 1 if error.present?
+    save!
+    puts "Domain: #{domain}, status: #{status}, error: #{error}"
+  end
+
+  # Получить сертификат
+  # @return [OpenSSL::X509::Certificate]
+  def cert
+    uri = URI::HTTPS.build(host: domain)
+    response = Net::HTTP.start(uri.host, uri.port, use_ssl: true)
+    response.peer_cert
+  end
+
+  # Начальные значения
+  def set_ok
+    self.error = ''
+    self.status = 0
+    touch
+  end
+
+  # Текст ошибки SSL
+  # @param [String] error
+  # @return [String]
+  def ssl_error(msg)
+    pos = msg.index('error: ')
+    self.error = "Ошибка SSL: #{msg[pos + 7, msg.length - 1]}" unless pos.nil?
+  end
+
+  # Проверить когда истекает действие сертификата
+  # @param [Time] not_after
+  def check_expired(not_after)
+    if Time.now + 14 * ONE_DAY > not_after
+      self.error = 'Действие сертификата истекает менее чем через 2 недели'
+      return
+    end
+    if Time.now + 7 * ONE_DAY > not_after
+      self.error = 'Действие сертификата истекает менее чем через 1 неделю'
+    end
+  end
+
+  # Проверить все
+  def self.check
+    Certificate.all.each(&:check)
+  end
+end

config/database.yml

@@ -1,25 +1,21 @@
-# SQLite. Versions 3.8.0 and up are supported.
-#   gem install sqlite3
-#
-#   Ensure the SQLite 3 gem is defined in your Gemfile
-#   gem 'sqlite3'
-#
-default: &default
-  adapter: sqlite3
-  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
-  timeout: 5000
-
 development:
-  <<: *default
-  database: db/development.sqlite3
-
-# Warning: The database defined as "test" will be erased and
-# re-generated from your development database when you run "rake".
-# Do not set this db to the same as development or production.
-test:
-  <<: *default
-  database: db/test.sqlite3
+  adapter: postgresql
+  encoding: utf8
+  username: postgres
+  password: 12345678
+  database: sslmonitor
+  host: localhost
+  pool: 30
+  timeout: 5000
+  port: 5432
 
 production:
-  <<: *default
-  database: db/production.sqlite3
+  adapter: postgresql
+  encoding: utf8
+  username: postgres
+  password: 12345678
+  database: sslmonitor
+  host: localhost
+  pool: 30
+  timeout: 5000
+  port: 5432

config/routes.rb

@@ -1,3 +1,12 @@
 Rails.application.routes.draw do
-  # For details on the DSL available within this file, see https://guides.rubyonrails.org/routing.html
+
+  require 'sidekiq/web'
+  require 'sidekiq-scheduler/web'
+
+  mount SslMonitor::Base => '/'
+
+  Sidekiq::Web.use Rack::Auth::Basic do |username, password|
+    username == 'admin' && password == '12345678'
+  end
+  mount Sidekiq::Web => '/sidekiq'
 end

config/sidekiq.yml

@@ -0,0 +1,11 @@
+:verbose: false
+:concurrency: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+:timeout: 30
+:queues:
+  - [low_priority, 1]
+  - [high_priority, 2] # high priority
+:schedule:
+  MonitorJob:
+    cron: '*/2 * * * *'
+    queue: scheduler
+    enabled: true

db/migrate/20200215155905_create_certificates.rb

@@ -0,0 +1,14 @@
+class CreateCertificates < ActiveRecord::Migration[6.0]
+  def change
+    create_table(
+      :certificates,
+      comment: 'Таблица сертификатов'
+    ) do |t|
+      t.string :domain, comment: 'Домен, для которого выполняется проверка серта'
+      t.integer :status, comment: 'Код статуса проверки сертификата'
+      t.string :error, comment: 'Текст ошибки'
+      t.datetime :checked_at, comment: 'Дата последней проверки'
+      t.timestamps
+    end
+  end
+end

db/migrate/20200217071342_add_unique_domain_index_into_certificates.rb

@@ -0,0 +1,8 @@
+class AddUniqueDomainIndexIntoCertificates < ActiveRecord::Migration[6.0]
+  def up
+    add_index :certificates, :domain, unique: true
+  end
+  def down
+    remove_index :certificates, name: 'index_certificates_on_domain'
+  end
+end