mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
ce05d0c9b0
## What changed? Explicitly validate utf-8 in string fields in proto messages in grpc requests/responses and deserialized from persistence, sampled based on dynamic config. Optionally fail grpc requests + deserialization also. Currently the grpc interceptor is on the frontend only. Deserialization checks are on all services. ## Why? Part of migrating from gogoproto, which did not validate string fields as utf-8: before starting to fail requests and deserialization, we want to monitor for bad data first. ## How did you test it? unit test, also manual testing with bad data in grpc requests ## Potential risks This code is potentially slow and runs as a grpc interceptor, could add cpu load + latency. The sampling control should mitigate this risk. --------- Co-authored-by: Chetan Gowda <[email protected]>
55 lines
2.0 KiB
Go
55 lines
2.0 KiB
Go
// The MIT License
|
|
//
|
|
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
|
|
//
|
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
// THE SOFTWARE.
|
|
|
|
package utf8validator
|
|
|
|
import (
|
|
"go.uber.org/fx"
|
|
|
|
"go.temporal.io/server/common/dynamicconfig"
|
|
"go.temporal.io/server/common/log"
|
|
"go.temporal.io/server/common/metrics"
|
|
)
|
|
|
|
var Module = fx.Options(
|
|
fx.Provide(utf8ValidatorProvider),
|
|
)
|
|
|
|
func utf8ValidatorProvider(
|
|
logger log.Logger,
|
|
metrics metrics.Handler,
|
|
col *dynamicconfig.Collection,
|
|
) *Validator {
|
|
return newValidator(
|
|
logger,
|
|
metrics,
|
|
col.GetFloat64Property(dynamicconfig.ValidateUTF8SampleRPCRequest, 0.0),
|
|
col.GetFloat64Property(dynamicconfig.ValidateUTF8SampleRPCResponse, 0.0),
|
|
col.GetFloat64Property(dynamicconfig.ValidateUTF8SamplePersistence, 0.0),
|
|
col.GetBoolProperty(dynamicconfig.ValidateUTF8FailRPCRequest, false),
|
|
col.GetBoolProperty(dynamicconfig.ValidateUTF8FailRPCResponse, false),
|
|
col.GetBoolProperty(dynamicconfig.ValidateUTF8FailPersistence, false),
|
|
)
|
|
}
|