Skip to content

Commit

Permalink
fix SearchLogQuery behavior to conform to openapi spec (#1145) (#1191)
Browse files Browse the repository at this point in the history
  • Loading branch information
priyawadhwa authored Nov 10, 2022
1 parent 0ce56aa commit efad2ce
Show file tree
Hide file tree
Showing 7 changed files with 677 additions and 65 deletions.
6 changes: 6 additions & 0 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,8 @@ paths:
$ref: '#/definitions/LogEntry'
400:
$ref: '#/responses/BadContent'
422:
$ref: '#/responses/UnprocessableEntity'
default:
$ref: '#/responses/InternalServerError'

Expand Down Expand Up @@ -643,3 +645,7 @@ responses:
description: There was an internal error in the server while processing the request
schema:
$ref: "#/definitions/Error"
UnprocessableEntity:
description: The server understood the request but is unable to process the contained instructions
schema:
$ref: "#/definitions/Error"
71 changes: 33 additions & 38 deletions pkg/api/entries.go
Original file line number Diff line number Diff line change
Expand Up @@ -361,27 +361,29 @@ func SearchLogQueryHandler(params entries.SearchLogQueryParams) middleware.Respo
g, _ := errgroup.WithContext(httpReqCtx)

var searchHashes [][]byte
code := http.StatusBadRequest
for _, entryID := range params.Entry.EntryUUIDs {
if sharding.ValidateEntryID(entryID) == nil {
// if we got this far, then entryID is either a 64 or 80 character hex string
err := sharding.ValidateEntryID(entryID)
if err == nil {
logEntry, err := retrieveLogEntry(httpReqCtx, entryID)
if errors.Is(err, ErrNotFound) {
code = http.StatusNotFound
if err != nil && !errors.Is(err, ErrNotFound) {
return handleRekorAPIError(params, http.StatusInternalServerError, err, fmt.Sprintf("error getting log entry for %s", entryID))
} else if err == nil {
resultPayload = append(resultPayload, logEntry)
}
if err != nil {
return handleRekorAPIError(params, code, err, fmt.Sprintf("error getting log entry for %s", entryID))
}
resultPayload = append(resultPayload, logEntry)
continue
} else if len(entryID) == sharding.EntryIDHexStringLen {
// if ValidateEntryID failed and this is a full length entryID, then we can't search for it
return handleRekorAPIError(params, http.StatusBadRequest, err, fmt.Sprintf("invalid entryID %s", entryID))
}
// At this point, check if we got a uuid instead of an EntryID, so search for the hash later
uuid := entryID
if err := sharding.ValidateUUID(uuid); err != nil {
return handleRekorAPIError(params, code, err, fmt.Sprintf("validating uuid %s", uuid))
return handleRekorAPIError(params, http.StatusBadRequest, err, fmt.Sprintf("invalid uuid %s", uuid))
}
hash, err := hex.DecodeString(uuid)
if err != nil {
return handleRekorAPIError(params, code, err, malformedUUID)
return handleRekorAPIError(params, http.StatusBadRequest, err, malformedUUID)
}
searchHashes = append(searchHashes, hash)
}
Expand All @@ -408,7 +410,7 @@ func SearchLogQueryHandler(params entries.SearchLogQueryParams) middleware.Respo
}

if err := g.Wait(); err != nil {
return handleRekorAPIError(params, code, err, err.Error())
return handleRekorAPIError(params, http.StatusBadRequest, err, err.Error())
}
close(searchHashesChan)
for hash := range searchHashesChan {
Expand All @@ -424,31 +426,30 @@ func SearchLogQueryHandler(params entries.SearchLogQueryParams) middleware.Respo
for _, shard := range api.logRanges.AllShards() {
tcs := NewTrillianClientFromTreeID(httpReqCtx, shard)
resp := tcs.getLeafAndProofByHash(hash)
if resp.status != codes.OK {
continue
}
if resp.err != nil {
continue
}
leafResult := resp.getLeafAndProofResult
if leafResult != nil && leafResult.Leaf != nil {
if results == nil {
results = map[int64]*trillian.GetEntryAndProofResponse{}
switch resp.status {
case codes.OK:
leafResult := resp.getLeafAndProofResult
if leafResult != nil && leafResult.Leaf != nil {
if results == nil {
results = map[int64]*trillian.GetEntryAndProofResponse{}
}
results[shard] = resp.getLeafAndProofResult
}
results[shard] = resp.getLeafAndProofResult
case codes.NotFound:
// do nothing here, do not throw 404 error
continue
default:
log.ContextLogger(httpReqCtx).Errorf("error getLeafAndProofByHash(%s): code: %v, msg %v", hex.EncodeToString(hash), resp.status, resp.err)
return fmt.Errorf(trillianCommunicationError)
}
}
if results == nil {
code = http.StatusNotFound
return fmt.Errorf("no responses found")
}
searchByHashResults[i] = results
return nil
})
}

if err := g.Wait(); err != nil {
return handleRekorAPIError(params, code, err, err.Error())
return handleRekorAPIError(params, http.StatusInternalServerError, err, err.Error())
}

for _, hashMap := range searchByHashResults {
Expand All @@ -459,8 +460,7 @@ func SearchLogQueryHandler(params entries.SearchLogQueryParams) middleware.Respo
tcs := NewTrillianClientFromTreeID(httpReqCtx, shard)
logEntry, err := logEntryFromLeaf(httpReqCtx, api.signer, tcs, leafResp.Leaf, leafResp.SignedLogRoot, leafResp.Proof, shard, api.logRanges)
if err != nil {
code = http.StatusInternalServerError
return handleRekorAPIError(params, code, err, err.Error())
return handleRekorAPIError(params, http.StatusInternalServerError, err, err.Error())
}
resultPayload = append(resultPayload, logEntry)
}
Expand All @@ -471,26 +471,21 @@ func SearchLogQueryHandler(params entries.SearchLogQueryParams) middleware.Respo
g, _ := errgroup.WithContext(httpReqCtx)
resultPayloadChan := make(chan models.LogEntry, len(params.Entry.LogIndexes))

code := http.StatusInternalServerError
for _, logIndex := range params.Entry.LogIndexes {
logIndex := logIndex // https://golang.org/doc/faq#closures_and_goroutines
g.Go(func() error {
logEntry, err := retrieveLogEntryByIndex(httpReqCtx, int(swag.Int64Value(logIndex)))
if err != nil {
switch {
case errors.Is(err, ErrNotFound):
code = http.StatusNotFound
default:
}
if err != nil && !errors.Is(err, ErrNotFound) {
return err
} else if err == nil {
resultPayloadChan <- logEntry
}
resultPayloadChan <- logEntry
return nil
})
}

if err := g.Wait(); err != nil {
return handleRekorAPIError(params, code, err, err.Error())
return handleRekorAPIError(params, http.StatusInternalServerError, err, err.Error())
}
close(resultPayloadChan)
for result := range resultPayloadChan {
Expand Down
28 changes: 15 additions & 13 deletions pkg/api/error.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,21 +33,21 @@ import (
)

const (
trillianCommunicationError = "Unexpected error communicating with transparency log"
trillianUnexpectedResult = "Unexpected result from transparency log"
validationError = "Error processing entry: %v"
failedToGenerateCanonicalEntry = "Error generating canonicalized entry"
entryAlreadyExists = "An equivalent entry already exists in the transparency log with UUID %v"
trillianCommunicationError = "unexpected error communicating with transparency log"
trillianUnexpectedResult = "unexpected result from transparency log"
validationError = "error processing entry: %v"
failedToGenerateCanonicalEntry = "error generating canonicalized entry"
entryAlreadyExists = "an equivalent entry already exists in the transparency log with UUID %v"
firstSizeLessThanLastSize = "firstSize(%d) must be less than lastSize(%d)"
malformedUUID = "UUID must be a 64-character hexadecimal string"
malformedPublicKey = "Public key provided could not be parsed"
failedToGenerateCanonicalKey = "Error generating canonicalized public key"
redisUnexpectedResult = "Unexpected result from searching index"
lastSizeGreaterThanKnown = "The tree size requested(%d) was greater than what is currently observable(%d)"
signingError = "Error signing"
sthGenerateError = "Error generating signed tree head"
unsupportedPKIFormat = "The PKI format requested is not supported by this server"
unexpectedInactiveShardError = "Unexpected error communicating with inactive shard"
malformedPublicKey = "public key provided could not be parsed"
failedToGenerateCanonicalKey = "error generating canonicalized public key"
redisUnexpectedResult = "unexpected result from searching index"
lastSizeGreaterThanKnown = "the tree size requested(%d) was greater than what is currently observable(%d)"
signingError = "error signing"
sthGenerateError = "error generating signed tree head"
unsupportedPKIFormat = "the PKI format requested is not supported by this server"
unexpectedInactiveShardError = "unexpected error communicating with inactive shard"
maxSearchQueryLimit = "more than max allowed %d entries in request"
)

Expand Down Expand Up @@ -122,6 +122,8 @@ func handleRekorAPIError(params interface{}, code int, err error, message string
switch code {
case http.StatusBadRequest:
return entries.NewSearchLogQueryBadRequest().WithPayload(errorMsg(message, code))
case http.StatusUnprocessableEntity:
return entries.NewSearchLogQueryUnprocessableEntity().WithPayload(errorMsg(message, code))
default:
return entries.NewSearchLogQueryDefault(code).WithPayload(errorMsg(message, code))
}
Expand Down
69 changes: 69 additions & 0 deletions pkg/generated/client/entries/search_log_query_responses.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

21 changes: 21 additions & 0 deletions pkg/generated/restapi/embedded_spec.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit efad2ce

Please sign in to comment.