github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/pkg/logutil/sensitive.go (about)

     1  // Copyright 2022 PingCAP, Inc.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  package logutil
    15  
    16  import (
    17  	"regexp"
    18  )
    19  
    20  var (
    21  	passwordPatterns = `(password: (\\")?)(.*?)((\\")?\\n)`
    22  	passwordRegexp   = regexp.MustCompile(passwordPatterns)
    23  
    24  	sslPatterns = `(ssl-(ca|key|cert)-bytes:)((\\n\s{4}-\s\d+)+)`
    25  	sslRegexp   = regexp.MustCompile(sslPatterns)
    26  
    27  	// to match PEM format, ref: https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail
    28  	beginPattern      = `(.*?)(-{5})BEGIN( [A-Z]+)+(-{5})`
    29  	endPattern        = `(.*?)(-{5})END( [A-Z]+)+(-{5})[\"\']?`
    30  	sslStringPatterns = `(ssl-(ca|key|cert)-bytes:)` + beginPattern + endPattern
    31  	sslStringRegexp   = regexp.MustCompile(sslStringPatterns)
    32  
    33  	// HideSensitive is used to replace sensitive information with `******` in log.
    34  	HideSensitive = func(input string) string {
    35  		output := passwordRegexp.ReplaceAllString(input, "$1******$4")
    36  		output = sslRegexp.ReplaceAllString(output, "$1 \"******\"")
    37  		output = sslStringRegexp.ReplaceAllString(output, "$1 \"******\"")
    38  		return output
    39  	}
    40  )