github-advanced-security[bot] commented on code in PR #538: URL: https://github.com/apache/syncope/pull/538#discussion_r1375971961
########## ext/opensearch/persistence-jpa/src/main/java/org/apache/syncope/core/persistence/jpa/dao/OpenSearchAuditConfDAO.java: ########## @@ -0,0 +1,209 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.syncope.core.persistence.jpa.dao; + +import com.fasterxml.jackson.databind.node.ObjectNode; +import java.io.IOException; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Objects; +import java.util.stream.Collectors; +import org.apache.commons.lang3.StringUtils; +import org.apache.syncope.common.lib.audit.AuditEntry; +import org.apache.syncope.common.lib.types.AuditElements; +import org.apache.syncope.core.persistence.api.dao.search.OrderByClause; +import org.apache.syncope.core.provisioning.api.serialization.POJOHelper; +import org.apache.syncope.core.spring.security.AuthContextUtils; +import org.apache.syncope.ext.opensearch.client.OpenSearchUtils; +import org.opensearch.client.json.JsonData; +import org.opensearch.client.opensearch.OpenSearchClient; +import org.opensearch.client.opensearch._types.FieldSort; +import org.opensearch.client.opensearch._types.FieldValue; +import org.opensearch.client.opensearch._types.SearchType; +import org.opensearch.client.opensearch._types.SortOptions; +import org.opensearch.client.opensearch._types.SortOrder; +import org.opensearch.client.opensearch._types.query_dsl.Query; +import org.opensearch.client.opensearch._types.query_dsl.QueryBuilders; +import org.opensearch.client.opensearch._types.query_dsl.TextQueryType; +import org.opensearch.client.opensearch.core.CountRequest; +import org.opensearch.client.opensearch.core.SearchRequest; +import org.opensearch.client.opensearch.core.search.Hit; +import org.springframework.util.CollectionUtils; + +public class OpenSearchAuditConfDAO extends JPAAuditConfDAO { + + protected final OpenSearchClient client; + + protected final int indexMaxResultWindow; + + public OpenSearchAuditConfDAO(final OpenSearchClient client, final int indexMaxResultWindow) { + this.client = client; + this.indexMaxResultWindow = indexMaxResultWindow; + } + + protected Query getQuery( + final String entityKey, + final AuditElements.EventCategoryType type, + final String category, + final String subcategory, + final List<String> events, + final AuditElements.Result result, + final OffsetDateTime before, + final OffsetDateTime after) { + + List<Query> queries = new ArrayList<>(); + + if (entityKey != null) { + queries.add(new Query.Builder(). + multiMatch(QueryBuilders.multiMatch(). + fields("message.before", "message.inputs", "message.output", "message.throwable"). + type(TextQueryType.Phrase). + query(entityKey).build()).build()); + } + + if (type != null) { + queries.add(new Query.Builder(). + term(QueryBuilders.term().field("message.logger.type").value(FieldValue.of(type.name())).build()). + build()); + } + + if (StringUtils.isNotBlank(category)) { + queries.add(new Query.Builder(). + term(QueryBuilders.term().field("message.logger.category").value(FieldValue.of(category)).build()). + build()); + } + + if (StringUtils.isNotBlank(subcategory)) { + queries.add(new Query.Builder(). + term(QueryBuilders.term().field("message.logger.subcategory"). + value(FieldValue.of(subcategory)).build()). + build()); + } + + List<Query> eventQueries = events.stream().map(event -> new Query.Builder(). + term(QueryBuilders.term().field("message.logger.event").value(FieldValue.of(event)).build()). + build()). + collect(Collectors.toList()); + if (!eventQueries.isEmpty()) { + queries.add(new Query.Builder().disMax(QueryBuilders.disMax().queries(eventQueries).build()).build()); + } + + if (result != null) { + queries.add(new Query.Builder(). + term(QueryBuilders.term().field("message.logger.result"). + value(FieldValue.of(result.name())).build()). + build()); + } + + if (before != null) { + queries.add(new Query.Builder(). + range(QueryBuilders.range(). + field("instant").lte(JsonData.of(before.toInstant().toEpochMilli())).build()). + build()); + } + + if (after != null) { + queries.add(new Query.Builder(). + range(QueryBuilders.range(). + field("instant").gte(JsonData.of(after.toInstant().toEpochMilli())).build()). + build()); + } + + return new Query.Builder().bool(QueryBuilders.bool().must(queries).build()).build(); + } + + @Override + public int countEntries( + final String entityKey, + final AuditElements.EventCategoryType type, + final String category, + final String subcategory, + final List<String> events, + final AuditElements.Result result, + final OffsetDateTime before, + final OffsetDateTime after) { + + CountRequest request = new CountRequest.Builder(). + index(OpenSearchUtils.getAuditIndex(AuthContextUtils.getDomain())). + query(getQuery(entityKey, type, category, subcategory, events, result, before, after)). + build(); + try { + return (int) client.count(request).count(); + } catch (IOException e) { + LOG.error("Search error", e); + return 0; + } + } + + protected List<SortOptions> sortBuilders(final List<OrderByClause> orderBy) { + return orderBy.stream().map(clause -> { + String sortField = clause.getField(); + if ("EVENT_DATE".equalsIgnoreCase(sortField)) { + sortField = "message.date"; + } + + return new SortOptions.Builder().field( + new FieldSort.Builder(). + field(sortField). + order(clause.getDirection() == OrderByClause.Direction.ASC + ? SortOrder.Asc : SortOrder.Desc). + build()). + build(); + }).collect(Collectors.toList()); + } + + @Override + public List<AuditEntry> searchEntries( + final String entityKey, + final int page, + final int itemsPerPage, + final AuditElements.EventCategoryType type, + final String category, + final String subcategory, + final List<String> events, + final AuditElements.Result result, + final OffsetDateTime before, + final OffsetDateTime after, + final List<OrderByClause> orderBy) { + + SearchRequest request = new SearchRequest.Builder(). + index(OpenSearchUtils.getAuditIndex(AuthContextUtils.getDomain())). + searchType(SearchType.QueryThenFetch). + query(getQuery(entityKey, type, category, subcategory, events, result, before, after)). + fields(f -> f.field("message")). + from(itemsPerPage * (page <= 0 ? 0 : page - 1)). + size(itemsPerPage < 0 ? indexMaxResultWindow : itemsPerPage). + sort(sortBuilders(orderBy)). + build(); + + List<Hit<ObjectNode>> esResult = null; + try { + esResult = client.search(request, ObjectNode.class).hits().hits(); + } catch (Exception e) { + LOG.error("While searching in OpenSearch", e); + } + + return CollectionUtils.isEmpty(esResult) + ? List.of() + : esResult.stream(). Review Comment: ## Dereferenced variable may be null Variable [esResult](1) may be null at this access because of [this](2) assignment. [Show more details](https://github.com/apache/syncope/security/code-scanning/1400) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: dev-unsubscr...@syncope.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
