Skip to content

Commit

Permalink
Merge pull request #41 from atomist-skills/handle-single-char-sanitiz…
Browse files Browse the repository at this point in the history
…ation

handle sanitizing fields with a single character
  • Loading branch information
chrispatrick authored Jan 15, 2024
2 parents 722ce55 + a6fd3bd commit f9d559c
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 13 deletions.
24 changes: 12 additions & 12 deletions handle.go
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,18 @@ func createHttpHandler(handlers Handlers) func(http.ResponseWriter, *http.Reques
ctx: ctx,
}

defer func() {
if err := recover(); err != nil {
sendStatus(ctx, req, Status{
State: Failed,
Reason: fmt.Sprintf("Unsuccessfully invoked handler %s/%s@%s", event.Skill.Namespace, event.Skill.Name, name),
})
w.WriteHeader(201)
logger.Errorf("Unhandled error occurred: %v", err)
return
}
}()

start := time.Now()
logger.Debugf("Skill execution started")
logger.Debugf("Incoming event message: %s", sanitizeEvent(body))
Expand All @@ -79,18 +91,6 @@ func createHttpHandler(handlers Handlers) func(http.ResponseWriter, *http.Reques
if handle, ok := handlers[name]; ok {
logger.Debugf("Invoking event handler '%s'", name)

defer func() {
if err := recover(); err != nil {
sendStatus(ctx, req, Status{
State: Failed,
Reason: fmt.Sprintf("Unsuccessfully invoked handler %s/%s@%s", event.Skill.Namespace, event.Skill.Name, name),
})
w.WriteHeader(201)
logger.Errorf("Unhandled error occurred: %v", err)
return
}
}()

err = sendStatus(ctx, req, Status{
State: running,
})
Expand Down
9 changes: 8 additions & 1 deletion log.go
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,14 @@ func sanitizeEvent(incoming string) string {
match, _ := regexp.MatchString("(?i)token|password|jwt|url|secret|authorization|key|cert|pass|user|address|email|pat", name)
if match {
value := incoming[res[i][4]:res[i][5]]
newValue := value[0:1] + strings.Repeat("*", len(value)-2) + value[len(value)-1:]
var newValue string

if len(value) < 2 {
newValue = "*"
} else {
newValue = value[0:1] + strings.Repeat("*", len(value)-2) + value[len(value)-1:]
}

incoming = incoming[0:res[i][4]] + newValue + incoming[res[i][5]:]
}
}
Expand Down
9 changes: 9 additions & 0 deletions log_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,12 @@ func TestSanitizeEvent(t *testing.T) {
t.Errorf("token not sanitized")
}
}

func TestSanitizeEventWithSingleCharacterUser(t *testing.T) {
var payload = "{:execution-id \"855f5639-8627-4bf2-86e8-51346019ddcb.iStU3P05jAeiKAJ7pnXfg\", :skill {:namespace \"atomist\", :name \"go-sample-skill\", :version \"0.1.0-100\"}, :workspace-id \"T29E48P34\", :type :subscription, :context {:subscription {:name \"on_push\", :configuration {:name \"go_sample_skill\", :parameters [{:name \"repoFilter\", :value {}} {:name \"on_webhook\", :value ({:name \"on_webhook-0\", :url \"https://webhook.atomist.com/atomist/resource/b36b6db3-7d73-442b-9809-626a9ce036d0\"})}]}, :result ([{:git.commit/repo {:git.repo/name \"go-sample-skill\", :git.repo/source-id \"490643782\", :git.repo/default-branch \"main\", :git.repo/org {:github.org/installation-token \"ghs_H9bCqKtdsdfsfsdfsfsfsfQ8BeD6iWrSGM4RfYZm\", :git.org/name \"atomist-skills\", :git.provider/url \"https://github.com\"}}, :git.commit/author {:git.user/name \"0\", :git.user/login \"atomist[bot]\", :git.user/emails [{:email.email/address \"22779605+atomist[bot]@users.noreply.github.com\"}]}, :git.commit/sha \"8969fcce08a2869affc001a05fd8471bcf92b28f\", :git.commit/message \"Auto-merge pull request #21 from atomist-skills/go-sample-skill\", :git.ref/refs [{:git.ref/name \"main\", :git.ref/type {:db/id 83562883711320, :db/ident :git.ref.type/branch}}]}]), :metadata {:after-basis-t 4354969, :tx 13194143888281}, :after-basis-t 4354969, :tx 13194143888281}}, :urls {:execution \"https://api.atomist.com/executions/855f5639-8627-4bf2-86e8-51346019ddcb.iStU3P05jAeiKAJ7pnXfg\", :logs \"https://api.atomist.com/executions/855f5639-8627-4bf2-86e8-51346019ddcb.iStU3P05jAeiKAJ7pnXfg/logs\", :transactions \"https://api.atomist.com/executions/855f5639-8627-4bf2-86e8-51346019ddcb.iStU3P05jAeiKAJ7pnXfg/transactions\", :query \"https://api.atomist.com/datalog/team/T29E48P34/queries\"}, :token \"eyJhbGciOiJSUzI1NiOGd_6YHE8ud8GsBMy4E\"}"
sanitizedEvent := sanitizeEvent(payload)

if strings.Contains(sanitizedEvent, "\"0\"") {
t.Errorf("user not sanitised")
}
}

0 comments on commit f9d559c

Please sign in to comment.