chore: merge probe-engine into probe-cli (#201)
This is how I did it: 1. `git clone https://github.com/ooni/probe-engine internal/engine` 2. ``` (cd internal/engine && git describe --tags) v0.23.0 ``` 3. `nvim go.mod` (merging `go.mod` with `internal/engine/go.mod` 4. `rm -rf internal/.git internal/engine/go.{mod,sum}` 5. `git add internal/engine` 6. `find . -type f -name \*.go -exec sed -i 's@/ooni/probe-engine@/ooni/probe-cli/v3/internal/engine@g' {} \;` 7. `go build ./...` (passes) 8. `go test -race ./...` (temporary failure on RiseupVPN) 9. `go mod tidy` 10. this commit message Once this piece of work is done, we can build a new version of `ooniprobe` that is using `internal/engine` directly. We need to do more work to ensure all the other functionality in `probe-engine` (e.g. making mobile packages) are still WAI. Part of https://github.com/ooni/probe/issues/1335
This commit is contained in:
parent
b1ce300c8d
commit
d57c78bc71
535 changed files with 66182 additions and 23 deletions
49
internal/engine/model/scrub.go
Normal file
49
internal/engine/model/scrub.go
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
package model
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"net"
|
||||
)
|
||||
|
||||
// ErrInvalidProbeIP indicates that we're dealing with a string that
|
||||
// is not the valid serialization of an IP address.
|
||||
var ErrInvalidProbeIP = errors.New("model: invalid probe IP")
|
||||
|
||||
// Scrub scrubs the probeIP out of the measurement.
|
||||
func (m *Measurement) Scrub(probeIP string) (err error) {
|
||||
// We now behave like we can share everything except the
|
||||
// probe IP, which we instead cannot ever share
|
||||
m.ProbeIP = DefaultProbeIP
|
||||
return m.MaybeRewriteTestKeys(probeIP, json.Marshal)
|
||||
}
|
||||
|
||||
// Scrubbed is the string that replaces IP addresses.
|
||||
const Scrubbed = `[scrubbed]`
|
||||
|
||||
// MaybeRewriteTestKeys is the function called by Scrub that
|
||||
// ensures that m's serialization doesn't include the IP
|
||||
func (m *Measurement) MaybeRewriteTestKeys(
|
||||
currentIP string, marshal func(interface{}) ([]byte, error)) error {
|
||||
if net.ParseIP(currentIP) == nil {
|
||||
return ErrInvalidProbeIP
|
||||
}
|
||||
data, err := marshal(m.TestKeys)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
// The check using Count is to save an unnecessary copy performed by
|
||||
// ReplaceAll when there are no matches into the body. This is what
|
||||
// we would like the common case to be, meaning that the code has done
|
||||
// its job correctly and has not leaked the IP.
|
||||
bpip := []byte(currentIP)
|
||||
if bytes.Count(data, bpip) <= 0 {
|
||||
return nil
|
||||
}
|
||||
data = bytes.ReplaceAll(data, bpip, []byte(Scrubbed))
|
||||
// We add an annotation such that hopefully later we can measure the
|
||||
// number of cases where we failed to sanitize properly.
|
||||
m.AddAnnotation("_probe_engine_sanitize_test_keys", "true")
|
||||
return json.Unmarshal(data, &m.TestKeys)
|
||||
}
|
||||
Loading…
Reference in a new issue