Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: redact passwords in logs #1219

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+217 −55
Open

fix: redact passwords in logs #1219

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98e4f2f
fix: redact passwords in logs
martinohmann Jun 21, 2024
bf12db5
feat: add more thorough redact implementation
martinohmann Jun 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions internal/streams/helpers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,11 @@ func ParseQuery(s string) url.Values {
}
return params
}

func RedactPassword(s string) string {
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Theoretically, this could be private since it's only used in this module so far.

if u, err := url.Parse(s); err == nil {
return u.Redacted()
}

return s
}
14 changes: 14 additions & 0 deletions internal/streams/helpers_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package streams

import (
"testing"

"github.com/stretchr/testify/require"
)

func TestRedactPassword(t *testing.T) {
require.Equal(t, "not_a_url", RedactPassword("not_a_url"))
require.Equal(t, "rtsp://localhost:8554", RedactPassword("rtsp://localhost:8554"))
require.Equal(t, "rtsp://user:xxxxx@localhost:8554", RedactPassword("rtsp://user:password@localhost:8554"))
require.Equal(t, "rtsp://:xxxxx@localhost:8554", RedactPassword("rtsp://:password@localhost:8554"))
}
10 changes: 5 additions & 5 deletions internal/streams/producer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ func (p *Producer) start() {
return
}

log.Debug().Msgf("[streams] start producer url=%s", p.url)
log.Debug().Msgf("[streams] start producer url=%s", RedactPassword(p.url))

p.state = stateStart
p.workerID++
Expand All @@ -167,7 +167,7 @@ func (p *Producer) worker(conn core.Producer, workerID int) {
return
}

log.Warn().Err(err).Str("url", p.url).Caller().Send()
log.Warn().Err(err).Str("url", RedactPassword(p.url)).Caller().Send()
}

p.reconnect(workerID, 0)
Expand All @@ -178,11 +178,11 @@ func (p *Producer) reconnect(workerID, retry int) {
defer p.mu.Unlock()

if p.workerID != workerID {
log.Trace().Msgf("[streams] stop reconnect url=%s", p.url)
log.Trace().Msgf("[streams] stop reconnect url=%s", RedactPassword(p.url))
return
}

log.Debug().Msgf("[streams] retry=%d to url=%s", retry, p.url)
log.Debug().Msgf("[streams] retry=%d to url=%s", retry, RedactPassword(p.url))

conn, err := GetProducer(p.url)
if err != nil {
Expand Down Expand Up @@ -257,7 +257,7 @@ func (p *Producer) stop() {
p.workerID++
}

log.Debug().Msgf("[streams] stop producer url=%s", p.url)
log.Debug().Msgf("[streams] stop producer url=%s", RedactPassword(p.url))

if p.conn != nil {
_ = p.conn.Stop()
Expand Down
10 changes: 6 additions & 4 deletions internal/streams/streams.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ func GetOrPatch(query url.Values) *Stream {

// check if name param provided
if name := query.Get("name"); name != "" {
log.Info().Msgf("[streams] create new stream url=%s", source)
log.Info().Msgf("[streams] create new stream url=%s", RedactPassword(source))

return Patch(name, source)
}
Expand All @@ -143,6 +143,8 @@ func Delete(id string) {
delete(streams, id)
}

var log zerolog.Logger
var streams = map[string]*Stream{}
var streamsMu sync.Mutex
var (
log zerolog.Logger
streams = map[string]*Stream{}
streamsMu sync.Mutex
)