dlpheader

type DetectResult struct {
	RuleID     int32  `json:"rule_id"`     // RuleID of rules in conf file
	Text       string `json:"text"`        // substring which is detected by rule
	MaskText   string `json:"mask_text"`   // maskstring which is deidentify by rule
	ResultType string `json:"result_type"` // VALUE or KV, based on Rule
	Key        string `json:"key"`         // In ResultType: KV, Key is key of map for path of json object
	// In ResultType: VALUE mode, DetectResult.Text will be inputText[ByteStart:ByteEnd]
	// In ResultType: KV, DetectResult.Text will be inputMap[DetectResult.Key][ByteStart:ByteEnd]
	ByteStart int `json:"byte_start"`
	ByteEnd   int `json:"byte_end"`
	// fields are defined in conf file
	InfoType  string            `json:"info_type"`
	EnName    string            `json:"en_name"`
	CnName    string            `json:"cn_name"`
	GroupName string            `json:"group_name"`
	Level     string            `json:"level"`
	ExtInfo   map[string]string `json:"ext_info,omitempty"`
}

type EngineAPI interface {
	// ApplyConfig by configuration content
	// 传入conf string 进行配置
	ApplyConfig(conf string) error

	// ApplyConfigFile by config file path
	// 传入filePath 进行配置
	ApplyConfigFile(filePath string) error

	// Detect string
	// 对string进行敏感信息识别
	Detect(inputText string) ([]*DetectResult, error)

	// DetectMap detects KV map
	// 对map[string]string进行敏感信息识别
	DetectMap(inputMap map[string]string) ([]*DetectResult, error)

	// DetectJSON detects json string
	// 对json string 进行敏感信息识别
	DetectJSON(jsonText string) ([]*DetectResult, error)

	// DeidentifyJSONFromDetectResults  returns masked json object in string format from the passed-in []*DetectResult.
	// You may want to call DetectJSON first to obtain the []*DetectResult.
	// 根据传入的 []*DetectResult 对 Json 进行打码，返回打码后的JSON string
	DeidentifyJSONByResult(jsonText string, detectResults []*DetectResult) (outStr string, retErr error)

	// Deidentify detects string firstly, then return masked string and results
	// 对string先识别，然后按规则进行打码
	Deidentify(inputText string) (string, []*DetectResult, error)

	// DeidentifyMap detects KV map firstly,then return masked map
	// 对map[string]string先识别，然后按规则进行打码
	DeidentifyMap(inputMap map[string]string) (map[string]string, []*DetectResult, error)

	// DeidentifyJSON detects JSON firstly, then return masked json object in string formate and results
	// 对jsonText先识别，然后按规则进行打码，返回打码后的JSON string
	DeidentifyJSON(jsonText string) (string, []*DetectResult, error)

	// ShowResults print results in console
	// 打印识别结果
	ShowResults(resultArray []*DetectResult)

	// Mask inputText following predefined method of MaskRules in config
	// 根据脱敏规则直接脱敏
	Mask(inputText string, methodName string) (string, error)

	// MaskStruct will mask a strcut object by tag mask info
	// 根据tag mask里定义的脱敏规则对struct object直接脱敏，必须传入指针
	MaskStruct(inObj interface{}) (interface{}, error)

	// NewLogProcessor create a log processer for the package logs
	// 日志脱敏处理函数，调用过之后，eng只能用于log处理，因为规则会做专门的优化，不适合其他API使用
	// 最大输入1KB, 16 items, 预计最高200QPS，超出会截断日志，CPU也会相应升高，业务需要特别关注。
	NewLogProcessor() Processor

	// Close engine object, release memory of inner object
	// 关闭，释放内部变量
	Close()

	// Get Dlp SDK version string
	// 获取版本号
	GetVersion() string

	// Register DIY Masker
	// 注册自定义打码函数
	RegisterMasker(maskName string, maskFunc func(string) (string, error)) error

	// ApplyConfigDefault will use embeded local config, only used for DLP team
	// 业务禁止使用
	ApplyConfigDefault() error

	// DisableAllRules will disable all rules, only used for benchmark baseline
	// 业务禁止使用
	DisableAllRules() error

	// NewEmptyLogProcesser will new a log processer which will do nothing
	// 业务禁止使用
	NewEmptyLogProcessor() Processor

	// ShowDlpConf will print config file
	// 打印配置文件
	ShowDlpConf() error
	// GetDefaultConf will return default config string
	// 返回默认的conf string
	GetDefaultConf() string
}

type Processor func(rawLog string, kvs ...interface{}) (string, []interface{}, bool)