commit	e58c9873caca94e104b65173e46f8c1291c192d9	[log] [tgz]
author	Miguel Aranda <miguelaranda@google.com>	Mon Sep 30 09:02:30 2024 +0000
committer	Gerrit Code Review <noreply-gerritcodereview@google.com>	Mon Sep 30 09:02:30 2024 +0000
tree	372fd2d29731aca0b8872270b595bdaf12e9d9f5
parent	c190d0cb633f470e821499912799467ccd5469b5 [diff]
parent	161f2de25b83dbb4f0d768d932597720d109dc23 [diff]

tree: 372fd2d29731aca0b8872270b595bdaf12e9d9f5

README.md

Conscrypt - A Java Security Provider

Conscrypt is a Java Security Provider (JSP) that implements parts of the Java Cryptography Extension (JCE) and Java Secure Socket Extension (JSSE). It uses BoringSSL to provide cryptographic primitives and Transport Layer Security (TLS) for Java applications on Android and OpenJDK. See the capabilities documentation for detailed information on what is provided.

The core SSL engine has borrowed liberally from the Netty project and their work on netty-tcnative, giving Conscrypt similar performance.

Download

Conscrypt supports Java 8 or later on OpenJDK and KitKat (API Level 19) or later on Android. The build artifacts are available on Maven Central.

Download JARs

You can download the JARs directly from the Maven repositories.

OpenJDK (i.e. non-Android)

Native Classifiers

The OpenJDK artifacts are platform-dependent since each embeds a native library for a particular platform. We publish artifacts to Maven Central for the following platforms:

Classifier	OS	Architecture
linux-x86_64	Linux	x86_64 (64-bit)
osx-x86_64	Mac	x86_64 (64-bit)
windows-x86	Windows	x86 (32-bit)
windows-x86_64	Windows	x86_64 (64-bit)

Maven

Use the os-maven-plugin to add the dependency:

<build>
  <extensions>
    <extension>
      <groupId>kr.motd.maven</groupId>
      <artifactId>os-maven-plugin</artifactId>
      <version>1.4.1.Final</version>
    </extension>
  </extensions>
</build>

<dependency>
  <groupId>org.conscrypt</groupId>
  <artifactId>conscrypt-openjdk</artifactId>
  <version>2.5.2</version>
  <classifier>${os.detected.classifier}</classifier>
</dependency>

Gradle

Use the osdetector-gradle-plugin (which is a wrapper around the os-maven-plugin) to add the dependency:

buildscript {
  repositories {
    mavenCentral()
  }
  dependencies {
    classpath 'com.google.gradle:osdetector-gradle-plugin:1.4.0'
  }
}

// Use the osdetector-gradle-plugin
apply plugin: "com.google.osdetector"

dependencies {
  compile 'org.conscrypt:conscrypt-openjdk:2.5.2:' + osdetector.classifier
}

Uber JAR

For convenience, we also publish an Uber JAR to Maven Central that contains the shared libraries for all of the published platforms. While the overall size of the JAR is larger than depending on a platform-specific artifact, it greatly simplifies the task of dependency management for most platforms.

To depend on the uber jar, simply use the conscrypt-openjdk-uber artifacts.

Maven

<dependency>
  <groupId>org.conscrypt</groupId>
  <artifactId>conscrypt-openjdk-uber</artifactId>
  <version>2.5.2</version>
</dependency>

Gradle

dependencies {
  compile 'org.conscrypt:conscrypt-openjdk-uber:2.5.2'
}

Android

The Android AAR file contains native libraries for x86, x86_64, armeabi-v7a, and arm64-v8a.

Gradle

dependencies {
  implementation 'org.conscrypt:conscrypt-android:2.5.2'
}

How to Build

If you are making changes to Conscrypt, see the building instructions.