# Apache Lucene^®

Apache®, Apache Lucene®, are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries.

TuxCare's Endless Lifecycle Support (ELS) for Apache Lucene® provides security patches, and selected bug fixes, that are integral to the stable operation of applications running on Apache Lucene®.

# Supported Versions

• Apache Lucene® 5.5.5

# Connection to ELS for Apache Lucene® Repository

This guide outlines the steps needed to integrate the TuxCare ELS for Apache Lucene® repository into your Java application. The repository provides trusted Java libraries that can be easily integrated into your Maven and Gradle projects.

# Step 1: Get user credentials

You need username and password in order to use TuxCare ELS Apache Lucene® repository. Anonymous access is disabled. To receive username and password please contact sales@tuxcare.com.

# Step 2: Configure Registry

1. Navigate to the directory depending on your operating system.

   • Windows

   Maven: C:\Users\{username}\.m2
   Gradle: C:\Users\{username}\.gradle
   
   • macOS

   Maven: /Users/{username}/.m2
   Gradle: /Users/{username}/.gradle
   
   • Linux

   Maven: /home/{username}/.m2
   Gradle: /home/{username}/.gradle
   

2. Add the TuxCare repository and plugin repository to your build configuration.

   For Maven, you may choose any valid <id> value instead of tuxcare-registry, but the same value must be used in both settings.xml and pom.xml.

   Maven (~/.m2/settings.xml)Gradle (~/.gradle/gradle.properties)

   <?xml version="1.0" encoding="UTF-8"?>
   <settings xmlns="http://maven.apache.org/SETTINGS/1.1.0">
     <servers>
       <server>
         <id>tuxcare-registry</id>
         <username>USERNAME</username>
         <password>PASSWORD</password>
       </server>
     </servers>
   </settings>

   Here USERNAME and PASSWORD are your credentials mentioned in the Step 1.

# Step 3: Update Build Configuration

Add the TuxCare Apache Lucene® repository and plugins to your build configuration:

<repositories>
  <repository>
    <id>tuxcare-registry</id>
    <url>https://nexus.repo.tuxcare.com/repository/els_spring/</url>
  </repository>
</repositories>

• To fully switch from the official Apache Lucene® repository, replace it with the TuxCare repository.
• To keep both, add TuxCare after the official one.

Example Maven and Gradle projects are available on GitHub. Remember to set the required environment variables.

• Maven
• Gradle

# Step 4: Update Dependencies

Replace the Apache Lucene® dependencies in your build file with the TuxCare-maintained versions to cover both direct and transitive dependencies.

You can find a specific artifact version in your TuxCare account on Nexus (anonymous access is restricted).

<dependencies>
    <dependency>
        <groupId>org.apache.lucene</groupId>
        <artifactId>lucene-core</artifactId>
        <version>5.5.5-tuxcare.1</version>
    </dependency>
</dependencies>

# Step 5: Verify and Build

1. To confirm the TuxCare Apache Lucene® repository is set up correctly, use your build tool to list the project's dependencies. It shows both direct and transitive dependencies in the classpath.

   MavenGradle

   mvn dependency:tree -Dverbose

2. After reviewing the dependencies, include any library from the repository into your project and then run a build:

   MavenGradle

   mvn clean install

The build tool you're using should be able to identify and resolve dependencies from the TuxCare ELS for Apache Lucene® repository.

# Conclusion

You've successfully integrated the TuxCare ELS for Apache Lucene® repository into your project. You can now benefit from the secure and vetted Apache Lucene® libraries it provides.

# Vulnerability Exploitability eXchange (VEX)

VEX is a machine-readable format that tells you if a known vulnerability is actually exploitable in your product. It reduces false positives, helps prioritize real risks.

TuxCare provides VEX for Apache Lucene® ELS versions: security.tuxcare.com/vex/cyclonedx/els_lang_java/org.apache.lucene/.

# How to Upgrade to a Newer Version of TuxCare Packages

If you have already installed a package with a tuxcare.1 suffix and want to upgrade to a newer release (for example, tuxcare.3), you need to update version strings in your Maven or Gradle build file.

# Resolved CVEs in ELS for Apache Lucene®