审计管理

数据库审计以安全事件为中心，以全面审计和精确审计为基础，实时记录数据库活动，对数据库操作进行细粒度审计的合规性管理。通过记录、分析和汇报用户访问数据库的行为，帮助用户事后生成合规报告、追溯事故根源。通过大数据搜索技术提供高效查询审计报告，定位事件原因，以便日后查询、分析、过滤，加强内外部数据库网络行为的监控与审计，提高数据资产安全。

KWDB 支持监控和记录包括管理员在内的用户操作，对系统级、语句级和对象级操作进行审计。其中，开启审计功能后，系统自动启动系统级审计。

下表列出 KWDB 支持的系统级审计操作。

对象	操作
NODE	- 重启（RESTART） - 退役（DECOMMISON） - 复役（RECOMMISION） - 退出（QUIT） - 加入（JOIN）
CONNECT	- 登录（LOGIN） - 登出（LOGOUT）
CLUSTER SETTING	- 设置（SET） - 重置（RESET）

用户需要通过 SQL 语句创建、启用相应的语句级和对象级审计策略。

下表列出 KWDB 支持的语句级审计操作。

下表列出 KWDB 支持的对象级审计操作。

对象	关系数据库	时序数据库
TABLE	- INSERT - SELECT - UPDATE - DELETE	- INSERT - SELECT - UPDATE - DELETE 其中，UPDATE 和 DELETE 只支持报错审计。
VIEW	SELECT	-

开启审计功能后，系统会默认将审计结果保存在审计日志文件中。更多审计日志相关的信息，参见审计日志。

开启审计功能

默认情况下，系统关闭审计功能，如需对用户操作进行审计，需要通过 SQL 语句开启审计功能。

前提条件

用户是 admin 角色的成员。默认情况下，root 用户属于 admin 角色。

参数说明

无

语法格式

SET CLUSTER SETTING audit.enabled = true;

管理审计策略

KWDB 支持使用 SQL 语句创建、启用、修改、删除语句级和对象级审计策略。用户无需设置系统级审计策略。开启审计功能后，系统自动启动系统级审计。一旦发生支持的系统级审计操作，系统会自动生成相应的审计日志。

创建审计策略

CREATE AUDIT 语句用于创建语句级、对象级审计策略。

前提条件

用户是 admin 角色的成员。默认情况下，root 用户属于 admin 角色。

语法格式

CREATE AUDIT [IF NOT EXISTS] <audit_name>
ON [ALL | <target_type> [<target_name>]]
FOR [ALL | <operations>]
TO [ALL | <operators>]
[WHENEVER [ALL]];

参数说明

参数	说明
`IF NOT EXISTS`	可选关键字。当使用 `IF NOT EXISTS` 关键字时，如果目标审计策略不存在，系统创建审计策略。如果目标审计策略存在，系统创建审计策略失败，但不会报错。当未使用 `IF NOT EXISTS` 关键字时，如果目标审计策略不存在，系统创建审计策略。如果目标审计策略存在，系统报错，提示目标审计策略已存在。
`audit_name`	审计策略的名称。审计策略名称必须唯一。
`target_type`	审计对象类型。支持 user、role、database、schema、table、view、index、sequence、privilege、audit、query、job、schedule、session、statistics。支持使用 `ALL` 作为参数值，表示对所有对象类型进行审计。
`target_name`	数据库已存在的审计对象的名称。格式为 `database_name.target_name`。如果只提供了审计对象名称，则默认对当前数据库的审计对象进行审计。如未指定对象名称，KWDB 对指定对象类型进行审计。说明如果对象类型为 database，无法指定对象名称。
`operations`	审计操作。支持指定一个或多个审计操作，审计操作之间使用逗号（`,`）隔开。支持使用 `ALL` 作为参数值，表示对所有操作进行审计。支持的审计操作取决于对象可执行的操作。
`operators`	用户或角色名称。支持指定一个或多个用户或角色，用户或角色名称之间使用逗号（`,`）隔开。支持使用 `ALL` 作为参数值，表示对所有用户和角色进行审计。
`WHENEVER`	可选关键字，指定执行审计的条件。默认为 `ALL`，且只支持设置为 `ALL`，表示总是记录审计。

语法示例

创建语句级审计策略。
以下示例创建 atest 语句级审计策略，对 root 用户执行的数据库创建操作进行审计。
```
CREATE AUDIT atest ON DATABASE FOR create TO root;
```
创建对象级审计策略。
以下示例创建 atest 对象级审计策略，对 root 用户执行的 t1 表的查询操作进行审计。
```
CREATE AUDIT atest ON TABLE t1 FOR SELECT TO root;
```

修改审计策略

ALTER AUDIT 语句用于启用、禁用、重命名审计策略。

前提条件

用户是 admin 角色的成员。默认情况下，root 用户属于 admin 角色。

语法格式

ALTER AUDIT [IF EXISTS] <audit_name> [ENABLE | DISABLE | RENAME TO <new_name>];

参数说明

参数	说明
`IF EXISTS`	可选关键字。当使用 `IF EXISTS` 关键字时，如果目标审计策略存在，系统修改目标审计策略。如果目标审计策略不存在，系统修改审计策略失败，但不会报错。当未使用 `IF EXISTS` 关键字时，如果目标审计策略存在，系统修改审计策略。如果目标审计策略不存在，系统报错，提示目标审计策略不存在。
`audit_name`	当前的审计策略名称。
`ENABLE`	启用审计策略。默认情况下，禁用审计策略。
`DISABLE`	禁用审计策略。
`new_name`	新的审计策略名称。审计策略名称必须唯一。

语法示例

启动审计策略。
以下示例启用 atest 审计策略。
```
ALTER AUDIT atest ENABLE;
```
重命名审计策略。
以下示例将 atest 审计策略重命名未 btest。
```
ALTER AUDIT atest RENAME TO btest;
```

查看审计策略

SHOW AUDITS 语句用于查看已创建的审计策略。

前提条件

无

语法格式

SHOW AUDITS [ON <target_type> [<target_name>] [FOR <operations>] [TO <operators>]];

参数说明

参数	说明
`target_type`	可选参数，审计对象类型。支持 user、role、database、schema、table、view、index、sequence、privilege、audit、query、job、schedule、session、statistics。支持使用 `ALL` 作为参数值，表示查看所有对象的审计策略。
`target_name`	可选参数，数据库已存在的审计对象的名称。格式为 `database_name.target_name`。如果只提供了审计对象名称，则默认对查看当前数据库中指定对象的审计策略。如未指定对象名称，KWDB 查看指定对象的审计策略。说明如果对象类型为 database，无法指定对象名称。
`operations`	可选参数，审计操作。支持指定一个或多个审计操作，审计操作之间使用逗号（`,`）隔开。
`operators`	可选参数，用户或角色名称。支持指定一个或多个用户或角色，用户或角色名称之间使用逗号（`,`）隔开。

语法示例

查看所有审计策略。

SHOW AUDITS;

执行成功后，控制台输出以下信息：

  audit_name | target_type | target_name | target_id | operations | operators | condition | whenever | action | level | enable
-------------+-------------+-------------+-----------+------------+-----------+-----------+----------+--------+-------+---------
  b          | ALL         |             |         0 | ALL        | rest_user |         0 | ALL      |      0 |     0 | false
  c          | DATABASE    |             |         0 | ALL        | rest_user |         0 | ALL      |      0 |     0 | false
  d          | ALL         |             |         0 | ALL        | rest_user |         0 | ALL      |      0 |     0 | false
(3 rows)

查看指定对象类型的审计策略。

SHOW AUDITS ON DATABASE;

执行成功后，控制台输出以下信息：

  audit_name | target_type | target_name | target_id | operations | operators | condition | whenever | action | level | enable
-------------+-------------+-------------+-----------+------------+-----------+-----------+----------+--------+-------+---------
  c          | DATABASE    |             |         0 | ALL        | rest_user |         0 | ALL      |      0 |     0 | false
(1 row)

删除审计策略

DROP AUDIT 语句用于删除已创建的审计策略。

前提条件

用户是 admin 角色的成员。默认情况下，root 用户属于 admin 角色。

语法格式

DROP AUDIT [IF EXISTS] <audit_name>;

参数说明

参数	说明
`IF EXISTS`	可选关键字。当使用 `IF EXISTS` 关键字时，如果目标审计策略存在，系统删除目标审计策略。如果目标审计策略不存在，系统删除审计策略失败，但不会报错。当未使用 `IF EXISTS` 关键字时，如果目标审计策略存在，系统删除审计策略。如果目标审计策略不存在，系统报错，提示目标审计策略不存在。
`audit_name`	审计策略的名称。支持同时删除多个审计策略，审计策略名称之间使用逗号（`,`）隔开。

语法示例

以下示例删除 btest 审计策略。

DROP AUDIT btest;

审计日志

默认情况下，开启审计功能后，系统将审计结果保存在审计日志文件中。如需关闭审计日志，使用以下 SQL 语句将 audit.log.enabled 设为 false。

SET CLUSTER SETTING audit.log.enabled=false;

审计日志文件包含以下信息：

字段	说明	示例
日志级别和日期	审计日志的级别和记录日期，其中日志级别为 I。	`I240415`
时间	UTC 格式的时间戳。	`06:49:34.207014`
goroutine id	记录该审计的 goroutine ID。	`538`
审计源码文件路径	打印日志的源码文件及代码行。	`security/audit/actions/record_to_log.go:45`
节点	记录审计日志的节点 ID。	`[n1]`
日志输入计数	历史累计审计消息数。	`3`
事件发生时间	审计事件的发生时间。	`"EventTime":"2024-04-15T06:49:34.206948441Z"`
事件执行时间	审计事件的执行时间间隔。	`"Elapsed":2242701`
用户信息	用户和角色信息，包括以下字段： - `UserID`：预留字段，执行事件的用户 ID，默认值为 `0`。 - `Username`：执行事件的用户名称。 - `Roles`：角色信息，其中 `ID` 是预留字段，表示执行事件的角色 ID，默认值为 `0`。`Name` 表示执行事件的角色名称。	`"User":{"UserID":0,"Username":"root","Roles":[{"ID":0,"Name":"admin"}]}`
事件类型	在对象上的操作类型，例如创建、删除等	`"Event":"CREATE"`
操作对象	操作对象的信息，包括以下字段： - `Typ`：操作对象类型。 - `Targets`：具体的操作对象信息，支持一个或多个操作对象。 - `ID`：操作对象 ID。 - `Name`：操作对象的名称。 - `Cascades`：是否级联删除对象。	`"Target":{"Typ":"DATABASE","Targets":{"78":{"ID":78,"Name":"db1","Cascades":null}}}`
审计级别	- 系统级：0 - 语句级：1 - 对象级：2	`"Level":1`
客户端信息	客户端信息，包括以下字段： - `AppName`：客户端应用名称。 - `Address`：客户端地址，包含 IP 地址和端口。	`Client":{"AppName":"$ kwbase sql","Address":"127.0.0.1:55564"}`
事件执行结果	事件执行结果，包括以下字段： - `Status`：事件执行的状态，`OK` 表示成功，`FAIL` 表示失败。 - `ErrMsg`：事件的错误信息。 - `RowsAffected`：受影响的行数。	`"Result":{"Status":"OK","ErrMsg":"","RowsAffected":0}`
执行语句	执行语句信息，包括以下字段： - `Cmd`：执行的语句。 - `Params`：执行的参数。	`"Command":{"Cmd":"CREATE DATABASE db1","Params":"{}`"}
审计事件记录节点	审计事件记录节点的信息，包括以下字段： - `ClusterID`：集群 ID。 - `NodeID`：节点 ID。 - `HostIP`：节点的 IP 地址。 - `HostPort`：节点端口。 - `HostMac`：节点的 MAC 地址。 - `LastUp`：预留字段，节点上一次启动时间，默认值为 `0`。	`"Reporter":{"ClusterID":"ae93118d-28bc-492f-bd4f-852cafab0ad9","NodeID":1,"HostIP":"localhost","HostPort":"26257","HostMac":"","LastUp":0}}`

审计日志示例：

I240415 06:49:34.207014 538 security/audit/actions/record_to_log.go:45  [n1] 3 {"EventTime":"2024-04-15T06:49:34.206948441Z","Elapsed":2242701,"User":{"UserID":0,"Username":"root","Roles":[{"ID":0,"Name":"admin"}]},"Event":"CREATE","Target":{"Typ":"DATABASE","Targets":{"78":{"ID":78,"Name":"db1","Cascades":null}}},"Level":1,"Client":{"AppName":"$ kwbase sql","Address":"127.0.0.1:55564"},"Result":{"Status":"OK","ErrMsg":"","RowsAffected":0},"Command":{"Cmd":"CREATE DATABASE db1","Params":"{}"},"Reporter":{"ClusterID":"ae93118d-28bc-492f-bd4f-852cafab0ad9","NodeID":1,"HostIP":"localhost","HostPort":"26257","HostMac":"","LastUp":0}}

对象	关系数据库	时序数据库
USER	- CREATE USER - ALTER USER - DROP USER	- CREATE USER - ALTER USER - DROP USER
ROLE	- CREATE ROLE - ALTER ROLE - GRANT ROLE - REVOKE ROLE - DROP ROLE	- CREATE ROLE - ALTER ROLE - GRANT ROLE - REVOKE ROLE - DROP ROLE
DATABASE	- CREATE DATABASE - ALTER DATABASE - DROP DATABASE - IMPORT - EXPORT	- CREATE DATABASE - ALTER DATABASE - DROP DATABASE - IMPORT - EXPORT
SCHEMA	- CREATE SCHEMA - DROP SCHEMA	-
TABLE	- CREATE TABLE - ALTER TABLE - DROP TABLE - TRUNCATE TABLE - IMPORT - EXPORT	- CREATE TABLE - ALTER TABLE - DROP TABLE - IMPORT - EXPORT
VIEW	- CREATE VIEW - ALTER VIEW - DROP VIEW	-
INDEX	- CREATE INDEX - ALTER INDEX - DROP INDEX	-
SEQUENCE	- CREATE SEQUENCE - ALTER SEQUENCE - DROP SEQUENCE	-
PRIVILEGE	- GRANT PRIVILEGE - REVOKE PRIVILEGE	- GRANT PRIVILEGE - REVOKE PRIVILEGE
AUDIT	- CREATE AUDIT - ALTER AUDIT - DROP AUDIT	- CREATE AUDIT - ALTER AUDIT - DROP AUDIT
QUERY	- CANCEL QUERY - EXPLAIN QUERY	- CANCEL QUERY - EXPLAIN QUERY
JOB	- CANCEL JOB - PAUSE JOB - RESUME JOB	- CANCEL JOB - PAUSE JOB - RESUME JOB
SCHEDULE	- ALTER SCHEDULE - PAUSE SCHEDULE - RESUME SCHEDULE	- ALTER SCHEDULE - PAUSE SCHEDULE - RESUME SCHEDULE
SESSION	- SET SESSION - RESET SESSION - CANCEL SESSION	- SET SESSION - RESET SESSION - CANCEL SESSION
STATISTICS	CREATE STATISTICS	CREATE STATISTICS

# 审计管理

# 开启审计功能

# 前提条件

# 参数说明

# 语法格式

# 管理审计策略

# 创建审计策略

# 前提条件

# 语法格式

# 参数说明

# 语法示例

# 修改审计策略

# 前提条件

# 语法格式

# 参数说明

# 语法示例

# 查看审计策略

# 前提条件

# 语法格式

# 参数说明

# 语法示例

# 删除审计策略

# 前提条件

# 语法格式

# 参数说明

# 语法示例

# 审计日志

审计管理

开启审计功能

前提条件

参数说明

语法格式

管理审计策略

创建审计策略

前提条件

语法格式

参数说明

语法示例

修改审计策略

前提条件

语法格式

参数说明

语法示例

查看审计策略

前提条件

语法格式

参数说明

语法示例

删除审计策略

前提条件

语法格式

参数说明

语法示例

审计日志