Home | History | Annotate | Download | only in conscrypt 
      1 Conscrypt - A Java Security Provider
      2 ========================================
      3 
      4 Conscrypt is a Java Security Provider (JSP) that implements parts of the
      5 Java Cryptography Extension (JCE) and Java Secure Socket Extension (JSSE).
      6 It uses BoringSSL to provide cryptographical primitives and Transport Layer
      7 Security (TLS) for Java applications on Android and OpenJDK.
      8 
      9 The core SSL engine has borrowed liberally from the [Netty](http://netty.io/) project and their
     10 work on [netty-tcnative](http://netty.io/wiki/forked-tomcat-native.html), giving `Conscrypt`
     11 similar performance.
     12 
     13 <table>
     14   <tr>
     15     <td><b>Homepage:</b></td>
     16     <td>
     17       <a href="https://conscrypt.org/">conscrypt.org</a>
     18     </td>
     19   </tr>
     20   <tr>
     21     <td><b>Mailing List:</b></td>
     22     <td>
     23       <a href="https://groups.google.com/forum/#!forum/conscrypt">conscrypt (a] googlegroups.com</a>
     24     </td>
     25   </tr>
     26 </table>
     27 
     28 Download
     29 -------------
     30 <b><u>NOTE:</u> This section is under construction! Artifacts have
     31 not yet been published to the public Maven repositories.</b>
     32 
     33 #### Download JARs
     34 You can download
     35 [the JARs](http://search.maven.org/#search%7Cga%7C1%7Cg:%22org.conscrypt%22%20AND%20v:%221.1.0%22)
     36 directly from the Maven repositories.
     37 
     38 #### OpenJDK (i.e. non-Android)
     39 
     40 ##### Native Classifiers
     41 
     42 The OpenJDK artifacts are platform-dependent since each embeds a native library for a particular
     43 platform. We publish artifacts to Maven Central for the following platforms:
     44 
     45 Classifier | Description
     46 ---------------- | -----------
     47 windows-x86_64 | Windows distribution
     48 osx-x86_64 | Mac distribution
     49 linux-x86_64 | Used for Linux
     50 
     51 ##### Maven
     52 
     53 Use the [os-maven-plugin](https://github.com/trustin/os-maven-plugin) to add the dependency:
     54 
     55 ```xml
     56 <build>
     57   <extensions>
     58     <extension>
     59       <groupId>kr.motd.maven</groupId>
     60       <artifactId>os-maven-plugin</artifactId>
     61       <version>1.4.1.Final</version>
     62     </extension>
     63   </extensions>
     64 </build>
     65 
     66 <dependency>
     67   <groupId>org.conscrypt</groupId>
     68   <artifactId>conscrypt-openjdk</artifactId>
     69   <version>1.1.0-SNAPSHOT</version>
     70   <classifier>${os.detected.classifier}</classifier>
     71 </dependency>
     72 ```
     73 
     74 ##### Gradle
     75 Use the [osdetector-gradle-plugin](https://github.com/google/osdetector-gradle-plugin)
     76 (which is a wrapper around the os-maven-plugin) to add the dependency:
     77 
     78 ```gradle
     79 buildscript {
     80   repositories {
     81     mavenCentral()
     82   }
     83   dependencies {
     84     classpath 'com.google.gradle:osdetector-gradle-plugin:1.4.0'
     85   }
     86 }
     87 
     88 // Use the osdetector-gradle-plugin
     89 apply plugin: "com.google.osdetector"
     90 
     91 dependencies {
     92   compile 'org.conscrypt:conscrypt-jdk:1.1.0-SNAPSHOT:' + osdetector.classifier
     93 }
     94 ```
     95 
     96 ##### Uber JAR
     97 
     98 For convenience, we also publish an Uber JAR to Maven Central that contains the shared
     99 libraries for all of the published platforms. While the overall size of the JAR is
    100 larger than depending on a platform-specific artifact, it greatly simplifies the task of
    101 dependency management for most platforms.
    102 
    103 To depend on the uber jar, simply use the `conscrypt-openjdk-uber` artifacts.
    104 
    105 ###### Maven
    106 ```xml
    107 <dependency>
    108   <groupId>org.conscrypt</groupId>
    109   <artifactId>conscrypt-openjdk-uber</artifactId>
    110   <version>1.1.0-SNAPSHOT</version>
    111 </dependency>
    112 ```
    113 
    114 ###### Gradle
    115 ```gradle
    116 dependencies {
    117   compile 'org.conscrypt:conscrypt-jdk-uber:1.1.0-SNAPSHOT'
    118 }
    119 ```
    120 
    121 
    122 How to Build
    123 ------------
    124 
    125 If you are making changes to Conscrypt, see the [building
    126 instructions](BUILDING.md).
    127 
    128 Source Overview
    129 ----------------------------
    130 
    131 Here's a quick readers' guide to the code to help folks get started. The high-level modules are __Common__, __Android__,
    132 __OpenJDK__, and __Platform__.
    133 
    134 ### Common
    135 
    136 This contains the bulk of the code for both Java and C. This isn't an actual module and builds no
    137 artifacts. Rather, the other modules just point to this directory as source.
    138 
    139 ### Android
    140 
    141 This module provides the `Platform` class for Android and also adds compatibility classes for
    142 supporting various versions of Android. This generates an `aar` library artifact.
    143 
    144 ### OpenJDK
    145 
    146 These modules provide the `Platform` class for non-Android (OpenJDK-based) systems. It also provides
    147 a native library loader supports bundling the shared library with the JAR.
    148 
    149 ### Platform
    150 
    151 This is not an actual module and is not part of the default build. This is used for building
    152  Conscrypt as an embedded component of the Android platform.
    153