sonatype-lift[bot] commented on code in PR #1734: URL: https://github.com/apache/solr/pull/1734#discussion_r1245960039
########## solr/core/src/java/org/apache/solr/handler/admin/api/BackupCoreAPI.java: ########## @@ -0,0 +1,288 @@ +/* + * 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.solr.handler.admin.api; + +import static org.apache.solr.client.solrj.impl.BinaryResponseParser.BINARY_CONTENT_TYPE_V2; +import static org.apache.solr.security.PermissionNameProvider.Name.COLL_EDIT_PERM; + +import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.v3.oas.annotations.Parameter; +import io.swagger.v3.oas.annotations.media.Schema; +import io.swagger.v3.oas.annotations.parameters.RequestBody; +import java.net.URI; +import java.nio.file.Paths; +import java.util.Optional; +import javax.inject.Inject; +import javax.ws.rs.POST; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.QueryParam; +import org.apache.solr.common.SolrException; +import org.apache.solr.common.params.CoreAdminParams; +import org.apache.solr.common.util.NamedList; +import org.apache.solr.core.CoreContainer; +import org.apache.solr.core.SolrCore; +import org.apache.solr.core.backup.BackupFilePaths; +import org.apache.solr.core.backup.ShardBackupId; +import org.apache.solr.core.backup.repository.BackupRepository; +import org.apache.solr.handler.IncrementalShardBackup; +import org.apache.solr.handler.SnapShooter; +import org.apache.solr.handler.admin.CoreAdminHandler; +import org.apache.solr.jersey.PermissionName; +import org.apache.solr.jersey.SolrJerseyResponse; +import org.apache.solr.request.SolrQueryRequest; +import org.apache.solr.response.SolrQueryResponse; + +@Path(("/cores/{coreName}/backup/{name}")) +public class BackupCoreAPI extends CoreAdminAPIBase { + @Inject + public BackupCoreAPI( + CoreContainer coreContainer, + SolrQueryRequest solrQueryRequest, + SolrQueryResponse solrQueryResponse, + CoreAdminHandler.CoreAdminAsyncTracker coreAdminAsyncTracker) { + super(coreContainer, coreAdminAsyncTracker, solrQueryRequest, solrQueryResponse); + } + + @POST + @Produces({"application/json", "application/xml", BINARY_CONTENT_TYPE_V2}) + @PermissionName(COLL_EDIT_PERM) + public SolrJerseyResponse createBackup( + @Schema(description = "The name of the core.") @PathParam("core") String coreName, + @Schema(description = "The backup will be created in a directory called snapshot.<name>") + @PathParam("name") + String name, + @Schema(description = "The POJO for representing additional backup params.") @RequestBody + BackupCoreRequestBody backupCoreRequestBody, + @Parameter(description = "The id to associate with the async task.") @QueryParam("async") + String taskId) + throws Exception { + if (coreName == null) + throw new SolrException( + SolrException.ErrorCode.BAD_REQUEST, + "Missing required parameter: " + CoreAdminParams.CORE); + return handlePotentiallyAsynchronousTask( + null, + coreName, + taskId, + "backup", + () -> { + try (BackupRepository repository = + coreContainer.newBackupRepository(backupCoreRequestBody.repository); + SolrCore core = coreContainer.getCore(coreName)) { + String location = repository.getBackupLocation(backupCoreRequestBody.location); + if (location == null) { + throw new SolrException( + SolrException.ErrorCode.BAD_REQUEST, + "'location' is not specified as a query" + + " parameter or as a default repository property"); + } + URI locationUri = repository.createDirectoryURI(location); + repository.createDirectory(locationUri); + + if (backupCoreRequestBody.incremental) { + if ("file".equals(locationUri.getScheme())) { + core.getCoreContainer().assertPathAllowed(Paths.get(locationUri)); + } + if (backupCoreRequestBody.shardBackupId == null) { + throw new SolrException( + SolrException.ErrorCode.BAD_REQUEST, + "Missing required parameter: shardBackupId"); + } + final ShardBackupId shardBackupId = + ShardBackupId.from(backupCoreRequestBody.shardBackupId); + final ShardBackupId prevShardBackupId = + backupCoreRequestBody.prevShardBackupId != null + ? ShardBackupId.from(backupCoreRequestBody.prevShardBackupId) + : null; + BackupFilePaths incBackupFiles = new BackupFilePaths(repository, locationUri); + IncrementalShardBackup incSnapShooter = + new IncrementalShardBackup( + repository, + core, + incBackupFiles, + prevShardBackupId, + shardBackupId, + Optional.ofNullable(backupCoreRequestBody.commitName)); + NamedList<Object> rsp = incSnapShooter.backup(); + return IncrementalBackupCoreResponse.getObjectFromNamedList(rsp); + + } else { + SnapShooterBackupCoreResponse snapShooterBackupCoreResponse = + new SnapShooterBackupCoreResponse(); + SnapShooter snapShooter = + new SnapShooter( + repository, core, locationUri, name, backupCoreRequestBody.commitName); + // validateCreateSnapshot will create parent dirs instead of throw; that choice is + // dubious. + // But we want to throw. One reason is that this dir really should, in fact must, + // already + // exist here if triggered via a collection backup on a shared file system. Otherwise, + // perhaps the FS location isn't shared -- we want an error. + if (!snapShooter.getBackupRepository().exists(snapShooter.getLocation())) { + throw new SolrException( + SolrException.ErrorCode.BAD_REQUEST, + "Directory to contain snapshots doesn't exist: " + + snapShooter.getLocation() + + ". " + + "Note that Backup/Restore of a SolrCloud collection " + + "requires a shared file system mounted at the same path on all nodes!"); + } + snapShooter.validateCreateSnapshot(); + NamedList<Object> rsp = snapShooter.createSnapshot(); + return SnapShooterBackupCoreResponse.getObjectFromNamedList(rsp); + } + } catch (Exception exp) { + throw new SolrException( + SolrException.ErrorCode.SERVER_ERROR, + "Failed to backup core=" + coreName + " because " + exp, + exp); + } + }); + } + + public static class BackupCoreRequestBody extends SolrJerseyResponse { + + @Schema(description = "The name of the repository to be used for backup.") + @JsonProperty("repository") + public String repository; + + @Schema(description = "The path where the backup will be created") + @JsonProperty("location") + public String location; + + @JsonProperty("shardBackupId") + public String shardBackupId; + + @JsonProperty("prevShardBackupId") + public String prevShardBackupId; + + @Schema( + description = + "The name of the commit which was used while taking a snapshot using the CREATESNAPSHOT command.") + @JsonProperty("commitName") + public String commitName; + + @Schema(description = "To turn on incremental backup feature") + @JsonProperty("incremental") + public boolean incremental; + } + + public static class IncrementalBackupCoreResponse extends SolrJerseyResponse { + // public NamedList<Object> response; + @Schema(description = "The time at which backup snapshot started at.") + @JsonProperty("startTime") + public String startTime; + + @Schema(description = "The count of index files in the snapshot.") + @JsonProperty("indexFileCount") + public int indexFileCount; + + @Schema(description = "The count of uploaded index files.") + @JsonProperty("uploadedIndexFileCount") + public int uploadedIndexFileCount; + + @Schema(description = "The size of index in MB.") + @JsonProperty("indexSizeMB") + public double indexSizeMB; + + @Schema(description = "The size of uploaded index in MB.") + @JsonProperty("uploadedIndexFileMB") + public double uploadedIndexFileMB; + + @Schema(description = "Shard Id.") + @JsonProperty("shard") + public String shard; + + @Schema(description = "The time at which backup snapshot completed at.") + @JsonProperty("endTime") + public String endTime; + + @Schema(description = "ShardId of shard to which core belongs to.") + @JsonProperty("shardBackupId") + public String shardBackupId; + + public static IncrementalBackupCoreResponse getObjectFromNamedList(NamedList<Object> nl) { + IncrementalBackupCoreResponse incrementalBackupCoreResponse = + new IncrementalBackupCoreResponse(); + incrementalBackupCoreResponse.endTime = nl.get("endTime").toString(); + incrementalBackupCoreResponse.indexSizeMB = + Double.parseDouble(nl.get("indexSizeMB").toString()); + incrementalBackupCoreResponse.indexFileCount = + Integer.parseInt(nl.get("indexFileCount").toString()); + incrementalBackupCoreResponse.startTime = nl.get("startTime").toString(); + incrementalBackupCoreResponse.shardBackupId = nl.get("shardBackupId").toString(); Review Comment: <picture><img alt="15% of developers fix this issue" src="https://lift.sonatype.com/api/commentimage/fixrate/15/display.svg";></picture> <b>*NULL_DEREFERENCE:</b>* object returned by `nl.get("shardBackupId")` could be null and is dereferenced at line 229. ââ <b>16 similar findings have been found in this PR</b> <details><summary>đ Expand here to view all instances of this finding</summary><br/> <div align=\"center\"> | **File Path** | **Line Number** | | ------------- | ------------- | | solr/core/src/java/org/apache/solr/handler/admin/api/BackupCoreAPI.java | [231](https://github.com/apache/solr/blob/bdaddc0a1ba958a7a8d2a65a9c84faf81f382ab5/solr/core/src/java/org/apache/solr/handler/admin/api/BackupCoreAPI.java#L231) | | solr/core/src/java/org/apache/solr/handler/admin/api/BackupCoreAPI.java | [276](https://github.com/apache/solr/blob/bdaddc0a1ba958a7a8d2a65a9c84faf81f382ab5/solr/core/src/java/org/apache/solr/handler/admin/api/BackupCoreAPI.java#L276) | | solr/core/src/java/org/apache/solr/handler/admin/api/BackupCoreAPI.java | [282](https://github.com/apache/solr/blob/bdaddc0a1ba958a7a8d2a65a9c84faf81f382ab5/solr/core/src/java/org/apache/solr/handler/admin/api/BackupCoreAPI.java#L282) | | solr/core/src/java/org/apache/solr/handler/admin/api/BackupCoreAPI.java | [281](https://github.com/apache/solr/blob/bdaddc0a1ba958a7a8d2a65a9c84faf81f382ab5/solr/core/src/java/org/apache/solr/handler/admin/api/BackupCoreAPI.java#L281) | | solr/core/src/java/org/apache/solr/handler/admin/api/BackupCoreAPI.java | [233](https://github.com/apache/solr/blob/bdaddc0a1ba958a7a8d2a65a9c84faf81f382ab5/solr/core/src/java/org/apache/solr/handler/admin/api/BackupCoreAPI.java#L233) | | solr/core/src/java/org/apache/solr/handler/admin/api/BackupCoreAPI.java | [280](https://github.com/apache/solr/blob/bdaddc0a1ba958a7a8d2a65a9c84faf81f382ab5/solr/core/src/java/org/apache/solr/handler/admin/api/BackupCoreAPI.java#L280) | | solr/core/src/java/org/apache/solr/handler/admin/api/BackupCoreAPI.java | [225](https://github.com/apache/solr/blob/bdaddc0a1ba958a7a8d2a65a9c84faf81f382ab5/solr/core/src/java/org/apache/solr/handler/admin/api/BackupCoreAPI.java#L225) | | solr/core/src/java/org/apache/solr/handler/admin/api/BackupCoreAPI.java | [234](https://github.com/apache/solr/blob/bdaddc0a1ba958a7a8d2a65a9c84faf81f382ab5/solr/core/src/java/org/apache/solr/handler/admin/api/BackupCoreAPI.java#L234) | | solr/core/src/java/org/apache/solr/handler/admin/api/BackupCoreAPI.java | [223](https://github.com/apache/solr/blob/bdaddc0a1ba958a7a8d2a65a9c84faf81f382ab5/solr/core/src/java/org/apache/solr/handler/admin/api/BackupCoreAPI.java#L223) | | solr/core/src/java/org/apache/solr/handler/admin/api/BackupCoreAPI.java | [227](https://github.com/apache/solr/blob/bdaddc0a1ba958a7a8d2a65a9c84faf81f382ab5/solr/core/src/java/org/apache/solr/handler/admin/api/BackupCoreAPI.java#L227) | <p> Showing <b>10</b> of <b> 16 </b> findings. <a href="https://lift.sonatype.com/results/github.com/apache/solr/01H426JQM2VQ4TW88NA9A1XFBV?t=Infer|NULL_DEREFERENCE" target="_blank">Visit the Lift Web Console</a> to see all.</p></div></details> --- <details><summary>âšī¸ Expand to see all <b>@sonatype-lift</b> commands</summary> You can reply with the following commands. For example, reply with ***@sonatype-lift ignoreall*** to leave out all findings. | **Command** | **Usage** | | ------------- | ------------- | | `@sonatype-lift ignore` | Leave out the above finding from this PR | | `@sonatype-lift ignoreall` | Leave out all the existing findings from this PR | | `@sonatype-lift exclude <file\|issue\|path\|tool>` | Exclude specified `file\|issue\|path\|tool` from Lift findings by updating your config.toml file | **Note:** When talking to LiftBot, you need to **refresh** the page to see its response. <sub>[Click here](https://github.com/apps/sonatype-lift/installations/new) to add LiftBot to another repo.</sub></details> ########## solr/core/src/java/org/apache/solr/handler/admin/api/BackupCoreAPI.java: ########## @@ -0,0 +1,288 @@ +/* + * 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.solr.handler.admin.api; + +import static org.apache.solr.client.solrj.impl.BinaryResponseParser.BINARY_CONTENT_TYPE_V2; +import static org.apache.solr.security.PermissionNameProvider.Name.COLL_EDIT_PERM; + +import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.v3.oas.annotations.Parameter; +import io.swagger.v3.oas.annotations.media.Schema; +import io.swagger.v3.oas.annotations.parameters.RequestBody; +import java.net.URI; +import java.nio.file.Paths; +import java.util.Optional; +import javax.inject.Inject; +import javax.ws.rs.POST; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.QueryParam; +import org.apache.solr.common.SolrException; +import org.apache.solr.common.params.CoreAdminParams; +import org.apache.solr.common.util.NamedList; +import org.apache.solr.core.CoreContainer; +import org.apache.solr.core.SolrCore; +import org.apache.solr.core.backup.BackupFilePaths; +import org.apache.solr.core.backup.ShardBackupId; +import org.apache.solr.core.backup.repository.BackupRepository; +import org.apache.solr.handler.IncrementalShardBackup; +import org.apache.solr.handler.SnapShooter; +import org.apache.solr.handler.admin.CoreAdminHandler; +import org.apache.solr.jersey.PermissionName; +import org.apache.solr.jersey.SolrJerseyResponse; +import org.apache.solr.request.SolrQueryRequest; +import org.apache.solr.response.SolrQueryResponse; + +@Path(("/cores/{coreName}/backup/{name}")) +public class BackupCoreAPI extends CoreAdminAPIBase { + @Inject + public BackupCoreAPI( + CoreContainer coreContainer, + SolrQueryRequest solrQueryRequest, + SolrQueryResponse solrQueryResponse, + CoreAdminHandler.CoreAdminAsyncTracker coreAdminAsyncTracker) { + super(coreContainer, coreAdminAsyncTracker, solrQueryRequest, solrQueryResponse); + } + + @POST + @Produces({"application/json", "application/xml", BINARY_CONTENT_TYPE_V2}) + @PermissionName(COLL_EDIT_PERM) + public SolrJerseyResponse createBackup( + @Schema(description = "The name of the core.") @PathParam("core") String coreName, + @Schema(description = "The backup will be created in a directory called snapshot.<name>") + @PathParam("name") + String name, + @Schema(description = "The POJO for representing additional backup params.") @RequestBody + BackupCoreRequestBody backupCoreRequestBody, + @Parameter(description = "The id to associate with the async task.") @QueryParam("async") + String taskId) + throws Exception { + if (coreName == null) + throw new SolrException( + SolrException.ErrorCode.BAD_REQUEST, + "Missing required parameter: " + CoreAdminParams.CORE); + return handlePotentiallyAsynchronousTask( + null, + coreName, + taskId, + "backup", + () -> { + try (BackupRepository repository = + coreContainer.newBackupRepository(backupCoreRequestBody.repository); + SolrCore core = coreContainer.getCore(coreName)) { + String location = repository.getBackupLocation(backupCoreRequestBody.location); + if (location == null) { + throw new SolrException( + SolrException.ErrorCode.BAD_REQUEST, + "'location' is not specified as a query" + + " parameter or as a default repository property"); + } + URI locationUri = repository.createDirectoryURI(location); + repository.createDirectory(locationUri); + + if (backupCoreRequestBody.incremental) { + if ("file".equals(locationUri.getScheme())) { + core.getCoreContainer().assertPathAllowed(Paths.get(locationUri)); Review Comment: <picture><img alt="9% of developers fix this issue" src="https://lift.sonatype.com/api/commentimage/fixrate/9/display.svg";></picture> <b>*[PATH_TRAVERSAL_IN](https://find-sec-bugs.github.io/bugs.htm#PATH_TRAVERSAL_IN):</b>* This API (java/nio/file/Paths.get(Ljava/net/URI;)Ljava/nio/file/Path;) reads a file whose location might be specified by user input --- <details><summary>âšī¸ Expand to see all <b>@sonatype-lift</b> commands</summary> You can reply with the following commands. For example, reply with ***@sonatype-lift ignoreall*** to leave out all findings. | **Command** | **Usage** | | ------------- | ------------- | | `@sonatype-lift ignore` | Leave out the above finding from this PR | | `@sonatype-lift ignoreall` | Leave out all the existing findings from this PR | | `@sonatype-lift exclude <file\|issue\|path\|tool>` | Exclude specified `file\|issue\|path\|tool` from Lift findings by updating your config.toml file | **Note:** When talking to LiftBot, you need to **refresh** the page to see its response. <sub>[Click here](https://github.com/apps/sonatype-lift/installations/new) to add LiftBot to another repo.</sub></details> -- 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: issues-unsubscr...@solr.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org For additional commands, e-mail: issues-h...@solr.apache.org
![https://lift.sonatype.com/api/commentimage/fixrate/15/display.svg"](https://lift.sonatype.com/api/commentimage/fixrate/15/display.svg"){kind=link}
![https://lift.sonatype.com/api/commentimage/fixrate/9/display.svg"](https://lift.sonatype.com/api/commentimage/fixrate/9/display.svg"){kind=link}