clambyを利用したウイルススキャン

はじめに

Railsでアップロードファイルに対してウイルススキャンを行う方法をご紹介したいと思います。

今回はgem clambyを利用して、ファイルアップロード後に非同期処理でウイルススキャンを実行。

ウイルスが検出された場合はダミーファイルを差し替えるという流れです。

clamby のGithubリポジトリ

clamavの導入

clamav のインストール

gem clambyはclamavに依存しているため、まずは clamav をインストールします。

mac OS（homebrew利用）の場合

$ brew install clamav

Dockerを利用している場合

Dockerfile

RUN apt-get -y install clamav clamav-daemon && freshclam

gem clambyの導入

gem clamby のインストール

Gemfile

gem 'clamby'

$ bundle install を実行

ウイルススキャンの処理を追加

アップローダーをマウントしているモデルにafter_saveを追加

user_image.rb

class UserImage < ApplicationRecord
  attr_accessor :skip_scan_viruses
  after_save -> { scan_viruses(:image) }, unless: :skip_scan_viruses
  ...
  mount_uploader :image, ImageUploader

  private

  def scan_viruses(attribute)
    ScanVirusesJob.perform_later(self, attribute)
  end
end

ウイルススキャンをスキップすることを可能にするためattr_accessorにskip_scan_virusesを追加

ウイルススキャンのジョブを作成

syoryukenを利用していますが非同期処理の方法についてはスキップします。
ウイルススキャンを行い、検出された場合はダミーファイルと差し替えの上メールを送信します。

scan_viruses._job.rb

class ScanVirusesJob < ApplicationJob
  def perform(record, attribute)
    return if record.send(attribute).blank? || Rails.env.test?
    return if Clamby.safe?(file_path(record, attribute))
    record.send("#{attribute}=", File.open('app/assets/images/common/no_image.png'))
    # 差し替え済みファイルなのでウイルススキャンはスキップ
    record.skip_scan_viruses = true
    record.save!(validate: false)
    Admin::ScanVirusesMailer.virus_detected_email(record).deliver_now
    if Rails.env.production?
      SlackAlertNotification.call(title: "#{notify_env}: ウイルスを検出しました", text: slack_text(record))
    end
  end

  private

  def file_path(record, attribute)
    # ファイルのpathを渡さなければいけないのでs3に保存しているproductionとそれ以外では分岐
    if Rails.env.production?
      # s3のファイルが上手く開ける状態かの確認
      # carrierwaveの挙動の問題か、s3側の準備ができておらずnot foundとなってしまうことがあった
      # sleep 2を噛ませたら上手く動いたので、200を確認してからウイルススキャンするよう修正
      5.times do
        response = Net::HTTP.get_response(URI.parse(record.send(attribute).url))
        break if response.code == '200'
        sleep 1
      end
      # URI.open(record.send(attribute).url).pathをそのままpathとして渡していた
      # が、疑似ウイルスファイルでundefined method `path' for #発生
      # 原因は10kb以下のファイルは Tempfile ではなく StringIOを返すRubyの仕様
      # なので、強制的にTempfileを作成する
      temp_file = Tempfile.new('file_')
      temp_file.binmode
      URI.open(record.send(attribute).url) { |file| temp_file.write(file.read) }
      temp_file.rewind
      temp_file.path
    else
      record.send(attribute).path
    end
  end
end

挙動確認

擬似ウイルスファイルでの挙動確認

EICARのサイトで実害のないテスト用の擬似ウイルスファイルをダウンロードできます。
ダウンロードしたファイルをアップロードしてファイルが差し替えられることを確認します。

EICARテストファイル(wikipedia)

beanstalkへのclamavの導入

ebextensionsを利用してbeanstalkにclamavをインストール

今回はAWSのbeanstalkというサービスを利用しているためebextentionsディレクトリを利用してclamavのインストールと定義ファイルの更新を行います。

.ebextensions/01_settings.config

  03_install_clamav:
    command: "sudo amazon-linux-extras install -y epel && sudo yum install -y clamav clamav-update clamd"

  04_freshcram:
    command: "sudo freshclam" # ウイルス定義ファイルの更新

ウイルス定義ファイルの更新

cronを利用して定義ファイルの更新を更新を定時実行する

gem wheneverを利用しているためschedule.rbに追記します。

config/schedule.rb

every 1.day, at: '0:30 am' do
  command "sudo freshclam"
end

まとめ

gem clamavを利用したウイルススキャンの実装をご紹介しました。
あまりウイルススキャンに関する記事は多くないので実装に少し苦労しましたが、こちらの記事が何かの助けになれば幸いです！