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]>
114 lines
4.2 KiB
Go
114 lines
4.2 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 frontend
|
|
|
|
import (
|
|
"go.temporal.io/server/api/adminservice/v1"
|
|
historyspb "go.temporal.io/server/api/history/v1"
|
|
tokenspb "go.temporal.io/server/api/token/v1"
|
|
"go.temporal.io/server/common/utf8validator"
|
|
)
|
|
|
|
// DEPRECATED: DO NOT MODIFY UNLESS ALSO APPLIED TO ./service/history/api/token.go
|
|
func generatePaginationToken(
|
|
request *adminservice.GetWorkflowExecutionRawHistoryV2Request,
|
|
versionHistories *historyspb.VersionHistories,
|
|
) *tokenspb.RawHistoryContinuation {
|
|
|
|
execution := request.Execution
|
|
return &tokenspb.RawHistoryContinuation{
|
|
NamespaceId: request.GetNamespaceId(),
|
|
WorkflowId: execution.GetWorkflowId(),
|
|
RunId: execution.GetRunId(),
|
|
StartEventId: request.GetStartEventId(),
|
|
StartEventVersion: request.GetStartEventVersion(),
|
|
EndEventId: request.GetEndEventId(),
|
|
EndEventVersion: request.GetEndEventVersion(),
|
|
VersionHistories: versionHistories,
|
|
PersistenceToken: nil, // this is the initialized value
|
|
}
|
|
}
|
|
|
|
// DEPRECATED: DO NOT MODIFY UNLESS ALSO APPLIED TO ./service/history/api/token.go
|
|
func validatePaginationToken(
|
|
request *adminservice.GetWorkflowExecutionRawHistoryV2Request,
|
|
token *tokenspb.RawHistoryContinuation,
|
|
) error {
|
|
|
|
execution := request.Execution
|
|
if request.GetNamespaceId() != token.GetNamespaceId() ||
|
|
execution.GetWorkflowId() != token.GetWorkflowId() ||
|
|
execution.GetRunId() != token.GetRunId() ||
|
|
request.GetStartEventId() != token.GetStartEventId() ||
|
|
request.GetStartEventVersion() != token.GetStartEventVersion() ||
|
|
request.GetEndEventId() != token.GetEndEventId() ||
|
|
request.GetEndEventVersion() != token.GetEndEventVersion() {
|
|
return errInvalidPaginationToken
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// DEPRECATED: DO NOT MODIFY UNLESS ALSO APPLIED TO ./service/history/api/token.go
|
|
func serializeRawHistoryToken(token *tokenspb.RawHistoryContinuation) ([]byte, error) {
|
|
if token == nil {
|
|
return nil, nil
|
|
}
|
|
if err := utf8validator.Validate(token, utf8validator.SourceRPCResponse); err != nil {
|
|
return nil, err
|
|
}
|
|
return token.Marshal()
|
|
}
|
|
|
|
// DEPRECATED: DO NOT MODIFY UNLESS ALSO APPLIED TO ./service/history/api/token.go
|
|
func deserializeRawHistoryToken(bytes []byte) (*tokenspb.RawHistoryContinuation, error) {
|
|
token := &tokenspb.RawHistoryContinuation{}
|
|
err := token.Unmarshal(bytes)
|
|
if err == nil {
|
|
err = utf8validator.Validate(token, utf8validator.SourceRPCRequest)
|
|
}
|
|
return token, err
|
|
}
|
|
|
|
// DEPRECATED: DO NOT MODIFY UNLESS ALSO APPLIED TO ./service/history/api/token.go
|
|
func serializeHistoryToken(token *tokenspb.HistoryContinuation) ([]byte, error) {
|
|
if token == nil {
|
|
return nil, nil
|
|
}
|
|
if err := utf8validator.Validate(token, utf8validator.SourceRPCResponse); err != nil {
|
|
return nil, err
|
|
}
|
|
return token.Marshal()
|
|
}
|
|
|
|
// DEPRECATED: DO NOT MODIFY UNLESS ALSO APPLIED TO ./service/history/api/token.go
|
|
func deserializeHistoryToken(bytes []byte) (*tokenspb.HistoryContinuation, error) {
|
|
token := &tokenspb.HistoryContinuation{}
|
|
err := token.Unmarshal(bytes)
|
|
if err == nil {
|
|
err = utf8validator.Validate(token, utf8validator.SourceRPCRequest)
|
|
}
|
|
return token, err
|
|
}
|