克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

JESAI.ClamAV.NetScanner

Latest version

介绍

本项目是一个互联网云查杀方案,主要是利用TCP通信和ClamAV服务器交互,从而进行一些文件或者需要查杀的东西在云端杀毒,当然了,ClamAV也可以本地杀毒,使用本项目的前提,你要学会搭建ClamAV服务器。详情请看:https://www.clamav.net/。本类库目前是netcore3.1平台。

clamav

clamav是思科开源的一个杀毒引擎。ClamAV的®是一个开源(GPL)的各种情况,包括电子邮件扫描,Web扫描和终点的安全使用防病毒引擎。它提供了许多实用程序,包括灵活且可扩展的多线程守护程序,命令行扫描程序和用于自动数据库更新的高级工具。官网有完善的文档和工具,具体请自行研究。 输入图片说明

输入图片说明

安装教程

  1. 首先你要去官网下载ClamAV程序,并在服务器或者本地部署ClamAV服务,然后启动服务。如下是启动效果。 输入图片说明
  2. nuget 包管理器搜索 JESAI.ClamAV.NetScannerCore 或者使用命令:Install-Package JESAI.ClamAV.NetScannerCore

使用说明

  1. Starup ConfigureServices里面添加 如果服务器配置,则添加
services.AddClamAVNetScanner();

如果需要自定义配置信息,则增加如下代码

 //IClamAvScannerConfiguration不配置的话,会默认
            //Host = "127.0.0.1",
            //Port = 3310,
            //MaxChunkSize = 2014,
            //MaxStreamSize = 26214400
            IClamAvScannerConfiguration configuration = new ClamAvScannerConfiguration()
            {
                Host="127.0.0.1",
                Port=3310,
                MaxChunkSize=2014,
                MaxStreamSize= 26214400
            };
            services.AddClamAVNetScanner(configuration);
            //也可以这样用
            //services.AddClamAVNetScanner((s) => { s.AddSingleton<IClamAvScannerConfiguration>(configuration); });

然后在services.AddControllersWithViews();后面加上services.AddClamAVNetScannerDynamicWebApi();可以不加,不加的话WebApi不会生效。

services.AddControllersWithViews();
services.AddClamAVNetScannerDynamicWebApi();

输入图片说明

  1. Starup Configure里面配置,这个主要是swagger用,如果不使用WebApi,也可以不配置。
app.UseClamAVNetScanner();
  1. 注入Client服务。
 private readonly IClamAVScannerClient ClamAVScannerClient;
 public HomeController(ILogger<HomeController> logger, IClamAVScannerClient clamAVScannerClient)
 {
       _logger = logger;
      ClamAVScannerClient = clamAVScannerClient;
 }

3.1 获取ClamAV服务器版本 GetVersionAsync;

3.2 在ClamAV服务器上执行PING命令。 PingAsync;

3.3 扫描ClamAV服务器上的文件/目录。 ScanFileOnServerAsync;

3.4 使用服务器上的多个线程扫描ClamAV服务器上的文件/目录。 ScanFileOnServerMultithreadedAsync;

3.5 将数据作为流发送到ClamAV服务器(Byte)。 SendAndScanFileAsync;

3.6 将数据作为流发送到ClamAV服务器(Byte)。 SendAndScanBytesAsync;

3.6 将数据作为流发送到ClamAV服务器(Stream)。 SendAndScanFileAsync;

3.7 从路径读取文件,然后将其作为流发送到ClamAV服务器。 SendAndScanFileAsync;

using JESAI.ClamAV.NetScannerCore.Models;
using System;
using System.Collections.Generic;
using System.IO;
using System.Text;
using System.Threading;
using System.Threading.Tasks;

namespace JESAI.ClamAV.NetScannerCore
{
    public interface IClamAVScannerClient
    {      
        /// <summary>
        /// 获取ClamAV服务器版本
        /// </summary>
        Task<string> GetVersionAsync();

        /// <summary>
        /// 获取ClamAV服务器版本
        /// </summary>
        /// <param name="cancellationToken">用于请求的取消令牌</param>
        Task<string> GetVersionAsync(CancellationToken cancellationToken);

        /// <summary>
        /// 在ClamAV服务器上执行PING命令。
        /// </summary>
        /// <returns>如果服务器以PONG响应,则返回true。否则返回false。</returns>
        Task<bool> PingAsync();

        /// <summary>
        /// 在ClamAV服务器上执行PING命令。
        /// </summary>
        /// <param name="cancellationToken">用于请求的取消令牌</param>
        /// <returns>如果服务器以PONG响应,则返回true。否则返回false。</returns>
        Task<bool> PingAsync(CancellationToken cancellationToken);

        /// <summary>
        /// 扫描ClamAV服务器上的文件/目录。
        /// </summary>
        /// <param name="filePath">ClamAV服务器上文件/目录的路径。</param>
        Task<ScannerResult> ScanFileOnServerAsync(string filePath);

        /// <summary>
        /// 扫描ClamAV服务器上的文件/目录。
        /// </summary>
        /// <param name="filePath">ClamAV服务器上文件/目录的路径。</param>
        /// <param name="cancellationToken">用于请求的取消令牌</param>
        Task<ScannerResult> ScanFileOnServerAsync(string filePath, CancellationToken cancellationToken);

        /// <summary>
        /// 使用服务器上的多个线程扫描ClamAV服务器上的文件/目录。
        /// </summary>
        /// <param name="filePath">ClamAV服务器上文件/目录的路径。</param>
        Task<ScannerResult> ScanFileOnServerMultithreadedAsync(string filePath);

        /// <summary>
        /// 使用服务器上的多个线程扫描ClamAV服务器上的文件/目录。
        /// </summary>
        /// <param name="filePath">ClamAV服务器上文件/目录的路径。</param>
        /// <param name="cancellationToken">用于请求的取消令牌</param>
        Task<ScannerResult> ScanFileOnServerMultithreadedAsync(string filePath, CancellationToken cancellationToken);

        /// <summary>
        /// 将数据作为流发送到ClamAV服务器。
        /// </summary>
        /// <param name="fileData">包含文件数据的字节数组。</param>
        /// <returns></returns>
        Task<ScannerResult> SendAndScanFileAsync(byte[] fileData);
        /// <summary>
        /// 将数据作为流发送到ClamAV服务器。
        /// </summary>
        /// <param name="fileData">包含文件数据的字节数组。</param>
        /// <returns></returns>
        Task<ScannerResult> SendAndScanBytesAsync(byte[] bytes);

        /// <summary>
        /// 将数据作为流发送到ClamAV服务器。
        /// </summary>
        /// <param name="fileData">包含文件数据的字节数组。</param>
        /// <param name="cancellationToken">用于请求的取消令牌</param>
        /// <returns></returns>
        Task<ScannerResult> SendAndScanFileAsync(byte[] fileData, CancellationToken cancellationToken);

        /// <summary>
        /// 将数据作为流发送到ClamAV服务器。
        /// </summary>
        /// <param name="sourceStream">包含要扫描的数据的流。</param>
        /// <returns></returns>
        Task<ScannerResult> SendAndScanFileAsync(Stream sourceStream);

        /// <summary>
        /// 将数据作为流发送到ClamAV服务器。
        /// </summary>
        /// <param name="sourceStream">包含要扫描的数据的流。</param>
        /// <param name="cancellationToken">用于请求的取消令牌</param>
        /// <returns></returns>
        Task<ScannerResult> SendAndScanFileAsync(Stream sourceStream, CancellationToken cancellationToken);

        /// <summary>
        /// 从路径读取文件,然后将其作为流发送到ClamAV服务器。
        /// </summary>
        /// <param name="filePath">文件/目录的路径。</param>
        Task<ScannerResult> SendAndScanFileAsync(string filePath);

        /// <summary>
        /// 从路径读取文件,然后将其作为流发送到ClamAV服务器。
        /// </summary>
        /// <param name="filePath">文件/目录的路径。</param>
        /// <param name="cancellationToken">用于请求的取消令牌</param>
        Task<ScannerResult> SendAndScanFileAsync(string filePath, CancellationToken cancellationToken);
    }
}

运行效果

[Fact]
       public async Task ScanBytes_InfectedData_ReturnsExpectedResult()
       {
           var ctx = IntegrationTestContext.CreateDefaultUnitTestContext();
           const string sampleVirusSignature = @"1111111111111";
           IClamAVScannerClient ClamAVScannerClient=ctx.Resolve<IClamAVScannerClient>();
           var bytes = Encoding.UTF8.GetBytes(sampleVirusSignature);
          var result=await ClamAVScannerClient.SendAndScanFileAsync(bytes);
           Assert.Equal(ScanResponseStatus.VirusDetected, result.Status);
           Assert.NotEmpty(result.InfectedFiles);
       }

输入图片说明

[Fact]
       public async Task ScanFileStream_InfectedData_ReturnsVirusDetectedResult()
       {
           var ctx = IntegrationTestContext.CreateDefaultUnitTestContext();
           string filePath = @"C:\Users\deng\Desktop\b.zip";
 
           IClamAVScannerClient ClamAVScannerClient = ctx.Resolve<IClamAVScannerClient>();
           var result = await ClamAVScannerClient.SendAndScanFileAsync(FileToStream(filePath));
 
           Assert.Equal(ScanResponseStatus.VirusDetected, result.Status);
           //Assert.NotEmpty(result.InfectedFiles);
       }

输入图片说明 输入图片说明

输入图片说明

输入图片说明

输入图片说明

输入图片说明

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

ClamAV云查杀毒,互联网扫描文件 展开 收起
C#
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化