suricata.yaml说明

Posted 2023-05-04

参考技术A suricata使用yaml作为配置格式。以下根据官方文档来对suricata.yaml作一些参数说明和解释。

先打开suricata.yaml。

文件1042行有：

这个参数表示suricata能够同时处理的最大的数据包数量。这个数字最小为1，最大要取决于内存(RAM)的大小。数据包越多，内存消耗也就越大；反之内存消耗越小。当用户有很多的CPU核心时，还把这个数字设置得很小，会造成空间的浪费。典型的例子就是：使用一个核心（core）去处理3个数据包。

文件1044行有：

该选项设置了suricata的运行模式，使用命令 --list-runmodes 在你的命令行，即可查看所有的运行模式。以下是一部分截图：

在介绍运行方式（Runmodes）之前首先了解一下suricata的基本组成。Suricata是由所谓的线程（threads）、线程模块 （thread-modules）和队列（queues）组成。Suricata是一个多线程的程序，因此在同一时刻会有多个线程在工作。线程模块是依据 功能来划分的，比如一个模块用于解析数据包，另一个模块用于检测数据包等。每个数据包可能会有多个不同的线程进行处理，队列就是用于将数据包从一个线程传 递到另一个线程。与此同时，一个线程可以拥有多个线程模块，但是在某一时刻只有一个模块在运行。

Suricata的运行方式就是上面介绍的线程（threads）、线程模块（thread-modules）和队列（queues）三种元素的不 同组合方式。上图中的RunMode Type并不是配置文件中的runmodes选项，而是后面的Custom Mode也就是自定义模式才可以在此处设置。比如默认的Runmodes是autofp，在线实时检测流量的模式中其结构如下，单线程模块获取数据包和解码，多线程模块检测，单模块输出：

而在pfring模式下的autofp则有所不同，可以看到它有多个模块获取及解码数据包，通过流绑定队列分配到多个检测模块中进行检测，这应该是pfring模式获取数据包效率更高的原因：

文件1058行有：

上面提到的max-pending-packets的选项是设置数据包数量的。这些要处理的数据包都放到了内存中，因此我们需要对每个数据包的大小进行限制。default-packet-size就是限制数据包大小的。设置的默认值是1514，这也是TCP数据包的最大长度（当数据超过这个长度时就会使用报文重组技术）。

996行有：

表示用于设置启动suricata的用户及其分组。

1005行有：

当suricata以daemon mode执行时，需要一个文件来记录suricata的进程ID。

官方文档上还有关于这一条的一个Note：

1088行有：

所有签名都有不同的properties，其中我们要重视的是action property。这决定了当签名匹配的时候会发生什么。以下有四种类型的action。

1、Pass

pass指的是处理的数据包匹配当前规则时直接跳过后面的所有规则，也就是说不匹配后面的规则。

2、Drop

drop只能工作在IPS模式下，当数据包匹配到drop的签名时则会被丢弃并且产生一个警告。

3、Reject

reject会给数据包的发送和接收端都发生一个拒绝的数据包，如果原本的协议是TCP，则发生reset数据包，否则发送ICMP错误的数据包，同时产生一个警告。在IPS模式下也会丢弃匹配到的数据包。

4、Alert

alert则对发送和接收者都没有影响，只会生成一个警告。

Suricata按照规则的出现顺序依次加载，但是处理的顺序则根据配置文件中设置的action重要程度来排列。默认的顺序如下，表示当一个数据包匹配多条规则时，优先处理的是pass的规则，其次是drop，然后是reject，最后是alert。

swagger2 注解说明

文章目录

• 1、swagger2 注解整体说明
• 2、`@Api`：请求类的说明
• 3、`@ApiOperation`：方法的说明

• • • 3.1、`@ApiImplicitParams`、`@ApiImplicitParam`：方法参数的说明

• 4、`@ApiResponses`、`@ApiResponse`：方法返回值的说明
• 5、`@ApiModel`、`@ApiModelProperty`：用于响应类上，表示一个返回响应数据的信息

1、swagger2 注解整体说明

用于controller类上

注解	说明
@Api	协议集描述

方法上

注解	说明
@ApiOperation	-
@ApiImplicitParams	方法上
@ApiImplicitParam	用在@ApiImplicitParams的方法里边
@ApiResponses	方法上
@ApiResponse	用在 @ApiResponses里边

返回对象类

注解	说明
@ApiModel	用在返回对象类上
@ApiModelProperty	用在出入参数对象的字段上

2、@Api：请求类的说明

@Api：放在 请求的类上，与@Controller并列，说明的请求类的用下，如用户登录类，订单类等。 tags="说明该类的作用" value="该参数没什么意义，所以不需要配置"

@Api：放在 请求的类上，与@Controller并列，说明的请求类的用下，如用户登录类，订单类等。

tags="说明该类的作用"

value="该参数没什么意义，所以不需要配置"

 

示例：

@Api(tags="APP登录授权")@ControllerpublicclassApiLoginController{}

@Api(tags="APP登录授权")

@Controller

public class ApiLoginController {

 

}

 

@Api属性配置：

与Controller注解并列使用。

属性名称	备注
value	url的路径值
tags	如果设置这个值、value的值会被覆盖
description	对api资源的描述
basePath	基本路径
position	如果配置多个Api 想改变显示的顺序位置
produces	如, “application/json, application/xml”
consumes	如, “application/json, application/xml”
protocols	协议类型，如: http, https, ws, wss.
authorizations	高级特性认证时配置
hidden	配置为true ，将在文档中隐藏

3、@ApiOperation：方法的说明

@ApiOperation："用在请求的方法上，说明方法的作用" value="说明方法的作用" notes="方法的备注说明"

@ApiOperation："用在请求的方法上，说明方法的作用"

value="说明方法的作用"

notes="方法的备注说明"

 

3.1、@ApiImplicitParams、@ApiImplicitParam：方法参数的说明

@ApiImplicitParams：用在请求的方法上，包含一组参数说明 @ApiImplicitParam：对单个参数的说明 name：参数名 value：参数的汉字说明、解释 required：参数是否必须传 paramType：参数放在哪个地方 · header --> 请求参数的获取：@RequestHeader · query --> 请求参数的获取：@RequestParam · path（用于restful接口）--> 请求参数的获取：@PathVariable · body（请求体）-->@RequestBody User user · form（不常用） dataType：参数类型，默认String，其它值dataType="Integer" defaultValue：参数的默认值

@ApiImplicitParams：用在请求的方法上，包含一组参数说明

@ApiImplicitParam：对单个参数的说明

name：参数名

value：参数的汉字说明、解释

required：参数是否必须传

paramType：参数放在哪个地方

· header --> 请求参数的获取：@RequestHeader

· query --> 请求参数的获取：@RequestParam

· path（用于restful接口）--> 请求参数的获取：@PathVariable

· body（请求体）--> @RequestBody User user

· form（不常用）

dataType：参数类型，默认String，其它值dataType="Integer"

defaultValue：参数的默认值

 

示列：

@ApiOperation(value="用户登录",notes="手机号、密码都是必输项，年龄随边填，但必须是数字")@ApiImplicitParams({@ApiImplicitParam(name="mobile",value="手机号",required=true,paramType="form"),@ApiImplicitParam(name="password",value="密码",required=true,paramType="form"),@ApiImplicitParam(name="age",value="年龄",required=true,paramType="form",dataType="Integer")})@PostMapping("/login")public JsonResult login(@RequestParam String mobile,@RequestParam String password,@RequestParam Integer age){...return JsonResult.ok(map);}

@ApiOperation(value="用户登录",notes="手机号、密码都是必输项，年龄随边填，但必须是数字")

@ApiImplicitParams({

@ApiImplicitParam(name="mobile",value="手机号",required=true,paramType="form"),

@ApiImplicitParam(name="password",value="密码",required=true,paramType="form"),

@ApiImplicitParam(name="age",value="年龄",required=true,paramType="form",dataType="Integer")

})

@PostMapping("/login")

public JsonResult login(@RequestParam String mobile, @RequestParam String password,

@RequestParam Integer age){

...

return JsonResult.ok(map);

}

 

4、@ApiResponses、@ApiResponse：方法返回值的说明

@ApiResponses：方法返回对象的说明 @ApiResponse：每个参数的说明 code：数字，例如400 message：信息，例如"请求参数没填好" response：抛出异常的类

@ApiResponses：方法返回对象的说明

@ApiResponse：每个参数的说明

code：数字，例如400

message：信息，例如"请求参数没填好"

response：抛出异常的类

 

示例：

@ApiOperation("获取用户信息")@ApiImplicitParams({@ApiImplicitParam(paramType ="query", name ="userId", dataType ="String", required =true, value ="用户Id")})@ApiResponses({@ApiResponse(code =400, message ="请求参数没填好"),@ApiResponse(code =404, message ="请求路径没有或页面跳转路径不对")})@[email protected]("/list")public JsonResult list(@RequestParam String userId){...return JsonResult.ok().put("page", pageUtil);}

@ApiOperation("获取用户信息")

@ApiImplicitParams({

@ApiImplicitParam(paramType = "query", name = "userId", dataType = "String", required = true, value = "用户Id")

})

@ApiResponses({

@ApiResponse(code = 400, message = "请求参数没填好"),

@ApiResponse(code = 404, message = "请求路径没有或页面跳转路径不对")

})

@ResponseBody

@RequestMapping("/list")

public JsonResult list(@RequestParam String userId) {

...

return JsonResult.ok().put("page", pageUtil);

}

 

5、@ApiModel、@ApiModelProperty：用于响应类上，表示一个返回响应数据的信息

@ApiModel：用于响应类上，表示一个返回响应数据的信息 （这种一般用在post创建的时候，使用@RequestBody这样的场景， 请求参数无法使用 @ApiImplicitParam 注解进行描述的时候） @ApiModelProperty：用在属性上，描述响应类的属性

@ApiModel：用于响应类上，表示一个返回响应数据的信息

（这种一般用在post创建的时候，使用@RequestBody这样的场景，

请求参数无法使用 @ApiImplicitParam 注解进行描述的时候）

@ApiModelProperty：用在属性上，描述响应类的属性

 

示例:

@ApiModel(description="返回响应数据")publicclassRestMessageimplementsSerializable{@ApiModelProperty(value ="是否成功")privateboolean success=true;@ApiModelProperty(value ="返回对象")private Object data;@ApiModelProperty(value ="错误编号")private Integer errCode;@ApiModelProperty(value ="错误信息")private String message;/* getter/setter */}

@ApiModel(description= "返回响应数据")

public class RestMessage implements Serializable{

 

@ApiModelProperty(value = "是否成功")

private boolean success=true;

@ApiModelProperty(value = "返回对象")

private Object data;

@ApiModelProperty(value = "错误编号")

private Integer errCode;

@ApiModelProperty(value = "错误信息")

private String message;

/* getter/setter */

}

 

http://localhost:5680/zxmall/swagger-ui.html

?

转载自：https://blog.csdn.net/xiaojin21cen/article/details/78654652