go.temporal.io/server/common/masker/masker.go

83 LOC · 45 covered · 38 uncovered · 12 ranges · 46 concepts · 4 introducers · 14 tests

File neighbourhood

The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.

Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file

In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.

  1
  
  package masker
  
  2
  
  3
  
  import (
  
  4
  
  	"reflect"
  
  5
  
  6
  
  	"gopkg.in/yaml.v3"
  
  7
  
  )
  
  8
  
  9
  
  const passwordMask = "******"
  
  10
  
  11
  
  var (
  
  12
  
  	DefaultFieldNames     = []string{"Password", "KeyData"}
  
  13
  
  	DefaultYAMLFieldNames = []string{"password", "keyData"}
  
  14
  
  )
  
  15
  
  16
  
  // MaskYaml replace password values with mask and returns copy of the string.
  
  17
  
  // Does recursive replacement for entire yamlStr.
  
  18
  >
  func MaskYaml(yamlStr string, fieldNamesToMask []string) (string, error) {
  
masker.go ×6

  19
  >
  	fns := make(map[string]struct{}, len(fieldNamesToMask))
  
  20
  >
  	for _, fieldName := range fieldNamesToMask {
  
  21
  >
  		fns[fieldName] = struct{}{}
  
  22
  >
  	}
  
  23
  
  24
  >
  	var parsedYaml map[string]any
  
masker.go ×6

  25
  >
  	err := yaml.Unmarshal([]byte(yamlStr), &parsedYaml)
  
  26
  >
  	if err != nil {
  
  27
  
  		return yamlStr, err
  
  28
  
  	}
  
  29
  
  30
  >
  	maskMap(parsedYaml, fns)
  
masker.go ×6

  31
  >
  
  32
  >
  	strBytes, err := yaml.Marshal(parsedYaml)
  
  33
  >
  	if err != nil {
  
  34
  
  		return yamlStr, err
  
  35
  
  	}
  
  36
  >
  	return string(strBytes), nil
  
masker.go ×6

  37
  
  }
  
  38
  
  39
  
  // MaskStruct replace password values with mask and returns copy of the strct.
  
  40
  
  // Original strct value is not modified. Doesn't go recursively through strct properties.
  
  41
  >
  func MaskStruct(strct any, fieldNamesToMask []string) any {
  
masker.go ×1

  42
  >
  	strctV := reflect.ValueOf(strct)
  
  43
  >
  
  44
  >
  	if strct == nil || (strctV.Kind() == reflect.Pointer && strctV.IsNil()) {
  
  45
  >
  		return strct
  
masker.go ×1

  46
  >
  	}
  
  47
  
  48
  >
  	for t := reflect.TypeOf(strct); t.Kind() == reflect.Pointer; t = t.Elem() {
  
masker.go ×4

  49
  >
  		strctV = strctV.Elem()
  
  50
  >
  	}
  
  51
  
  52
  
  	// strctV is not a pointer now. Create a copy using assignment.
  
  53
  >
  	strctCopy := strctV.Interface()
  
masker.go ×4

  54
  >
  	strctCopyPV := pointerTo(strctCopy)
  
  55
  >
  	strctCopyV := strctCopyPV.Elem()
  
  56
  >
  
  57
  >
  	for _, passwordFieldName := range fieldNamesToMask {
  
  58
  >
  		passwordF := strctCopyV.FieldByName(passwordFieldName)
  
  59
  >
  		if passwordF.CanSet() && passwordF.Kind() == reflect.String {
  
  60
  >
  			passwordF.SetString(passwordMask)
  
  61
  >
  		}
  
  62
  
  	}
  
  63
  
  64
  >
  	return strctCopyPV.Interface()
  
masker.go ×4

  65
  
  }
  
  66
  
  67
  >
  func pointerTo(val any) reflect.Value {
  
masker.go ×4

  68
  >
  	valPtr := reflect.New(reflect.TypeOf(val))
  
  69
  >
  	valPtr.Elem().Set(reflect.ValueOf(val))
  
  70
  >
  	return valPtr
  
  71
  >
  }
  
  72
  
  73
  >
  func maskMap(m map[string]any, fns map[string]struct{}) {
  
masker.go ×6

  74
  >
  	for key, value := range m {
  
  75
  >
  		if _, ok := fns[key]; ok {
  
  76
  >
  			m[key] = passwordMask
  
  77
  >
  		}
  
  78
  
  79
  >
  		if valueMap, ok := value.(map[string]any); ok {
  
masker.go ×6

  80
  >
  			maskMap(valueMap, fns)
  
  81
  >
  		}
  
  82
  
  	}
  
  83
  
  }