Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add SSL factory SingleCertValidatingFactory #88

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ jars
nbproject
.idea
*.iml

build.local.properties
15 changes: 9 additions & 6 deletions build.xml
Original file line number Diff line number Diff line change
Expand Up @@ -172,9 +172,10 @@
<exclude name="${package}/jdcb4/Jdbc4*.java" unless="jdbc4any" />

<!-- ssl -->
<include name="${package}/ssl/SingleCertValidatingFactory.java" if="jdbc4any"/>
<include name="${package}/ssl/jdbc4/*.java" if="jdbc4any"/>
<include name="${package}/ssl/jdbc3/*.java" if="jdbc3any"/>

<!-- gss -->
<include name="${package}/gss/*.java" />

Expand Down Expand Up @@ -446,6 +447,7 @@
<test name="org.postgresql.test.extensions.ExtensionsSuite" outfile="${testResultsDir}/extensions"/>
<test name="org.postgresql.test.jdbc4.Jdbc4TestSuite" if="jdbc4tests" outfile="${testResultsDir}/jdbc4"/>
<test name="org.postgresql.test.ssl.SslTestSuite" if="jdbc4tests" outfile="${testResultsDir}/ssl"/>
<test name="org.postgresql.test.ssl.SingleCertValidatingFactoryTest" if="jdbc4tests" outfile="${testResultsDir}/scsf-ssl"/>
</junit>
</target>

Expand All @@ -470,11 +472,12 @@
<include name="util/PGmoney.java" />
<include name="util/PGInterval.java" />
<include name="util/ServerErrorMessage.java" />
<include name="ssl/WrappedFactory.java" />
<include name="ssl/NonValidatingFactory.java" />
<include name="ds/PG*.java" />
<include name="ds/common/BaseDataSource.java" />
<include name="xa/PGXADataSource.java" />
<include name="ssl/WrappedFactory.java" />
<include name="ssl/NonValidatingFactory.java" />
<include name="ssl/SingleCertValidatingFactory.java" />
<include name="ds/PG*.java" />
<include name="ds/common/BaseDataSource.java" />
<include name="xa/PGXADataSource.java" />
</fileset>
</javadoc>
</target>
Expand Down
190 changes: 190 additions & 0 deletions org/postgresql/ssl/SingleCertValidatingFactory.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,190 @@
/*-------------------------------------------------------------------------
*
* Copyright (c) 2004-2011, PostgreSQL Global Development Group
*
*
*-------------------------------------------------------------------------
*/
package org.postgresql.ssl;

import java.io.ByteArrayInputStream;
import java.io.BufferedInputStream;
import java.io.FileInputStream;
import java.io.InputStream;
import java.io.IOException;
import java.util.UUID;

import java.security.KeyStore;
import java.security.cert.CertificateException;
import java.security.cert.CertificateFactory;
import java.security.cert.X509Certificate;
import java.security.GeneralSecurityException;

import javax.net.ssl.SSLContext;
import javax.net.ssl.TrustManager;
import javax.net.ssl.TrustManagerFactory;
import javax.net.ssl.X509TrustManager;

import org.postgresql.util.GT;
import org.postgresql.ssl.WrappedFactory;

/**
* Provides a SSLSocketFactory that authenticates the remote server against
* an explicit pre-shared SSL certificate. This is more secure than using the
* NonValidatingFactory as it prevents "man in the middle" attacks. It is also
* more secure than relying on a central CA signing your server's certificate
* as it pins the server's certificate.
*
* <p />
*
* This class requires a single String parameter specified by setting
* the connection property <code>sslfactoryarg</code>. The value of this property
* is the PEM-encoded remote server's SSL certificate.
*
* <p />
* Where the certificate is loaded from is based upon the prefix of the
* <code>sslfactoryarg</code> property. The following table lists the valid
* set of prefixes.
* <table border="1">
* <tr>
* <th>Prefix</th>
* <th>Example</th>
* <th>Explanation</th>
* </tr>
* <tr>
* <td><code>classpath:</code></td>
* <td><code>classpath:ssl/server.crt</code></td>
* <td>Loaded from the classpath.</td>
* </tr>
* <tr>
* <td><code>file:</code></td>
* <td><code>file:/foo/bar/server.crt</code></td>
* <td>Loaded from the filesystem.</td>
* </tr>
* <tr>
* <td><code>env:</code></td>
* <td><code>env:mydb_cert<pre>
* <td>Loaded from string value of the <code>mydb_cert</code>
* environment variable.</td>
* </tr>
* <tr>
* <td><code>sys:</code></td>
* <td><code>sys:mydb_cert<pre>
* <td>Loaded from string value of the <code>mydb_cert</code>
* system property.</td>
* </tr>
* <tr>
* <td><code>-----BEGIN CERTIFICATE------</code></td>
* <td><pre>
-----BEGIN CERTIFICATE-----
MIIDQzCCAqygAwIBAgIJAOd1tlfiGoEoMA0GCSqGSIb3DQEBBQUAMHUxCzAJBgNV
[... truncated ...]
UCmmYqgiVkAGWRETVo+byOSDZ4swb10=
-----END CERTIFICATE-----
</pre></td>
* <td>Loaded from string value of the argument.</td>
* </tr>
* </table>
*/

public class SingleCertValidatingFactory extends WrappedFactory {
private static final String FILE_PREFIX = "file:";
private static final String CLASSPATH_PREFIX = "classpath:";
private static final String ENV_PREFIX = "env:";
private static final String SYS_PROP_PREFIX = "sys:";

public SingleCertValidatingFactory(String sslFactoryArg) throws GeneralSecurityException {
if( sslFactoryArg == null || sslFactoryArg.equals("")) {
throw new GeneralSecurityException(GT.tr("The sslfactoryarg property may not be empty."));
}
InputStream in = null;
try {
if( sslFactoryArg.startsWith(FILE_PREFIX) ) {
String path = sslFactoryArg.substring(FILE_PREFIX.length());
in = new BufferedInputStream(new FileInputStream(path));
} else if( sslFactoryArg.startsWith(CLASSPATH_PREFIX) ) {
String path = sslFactoryArg.substring(CLASSPATH_PREFIX.length());
in = new BufferedInputStream(Thread.currentThread().getContextClassLoader().getResourceAsStream(path));
} else if( sslFactoryArg.startsWith(ENV_PREFIX) ) {
String name = sslFactoryArg.substring(ENV_PREFIX.length());
String cert = System.getenv(name);
if( cert == null || "".equals(cert) ) {
throw new GeneralSecurityException(
GT.tr("The environment variable containing the server's SSL certificate must not be empty."));
}
in = new ByteArrayInputStream(cert.getBytes("UTF-8"));
} else if( sslFactoryArg.startsWith(SYS_PROP_PREFIX) ) {
String name = sslFactoryArg.substring(SYS_PROP_PREFIX.length());
String cert = System.getProperty(name);
if( cert == null || "".equals(cert) ) {
throw new GeneralSecurityException(
GT.tr("The system property containing the server's SSL certificate must not be empty."));
}
in = new ByteArrayInputStream(cert.getBytes("UTF-8"));
} else if( sslFactoryArg.startsWith("-----BEGIN CERTIFICATE-----") ) {
in = new ByteArrayInputStream(sslFactoryArg.getBytes("UTF-8"));
} else {
throw new GeneralSecurityException(
GT.tr("The sslfactoryarg property must start with the prefix file:, classpath:, env:, sys:, or -----BEGIN CERTIFICATE-----."));
}

SSLContext ctx = SSLContext.getInstance("TLS");
ctx.init(null, new TrustManager[] { new SingleCertTrustManager(in) }, null);
_factory = ctx.getSocketFactory();
} catch( RuntimeException e ) {
throw (RuntimeException)e;
} catch( Exception e ) {
if( e instanceof GeneralSecurityException ) {
throw (GeneralSecurityException) e;
}
throw new GeneralSecurityException(GT.tr("An error occurred reading the certificate"), e);
} finally {
if( in != null ) {
try {
in.close();
} catch( Exception e2) {
// ignore
}
}
}
}

public class SingleCertTrustManager implements X509TrustManager {
X509Certificate cert;
X509TrustManager trustManager;

public SingleCertTrustManager(InputStream in) throws IOException, GeneralSecurityException {
KeyStore ks = KeyStore.getInstance(KeyStore.getDefaultType());
try {
// Note: KeyStore requires it be loaded even if you don't load anything into it:
ks.load(null);
} catch (Exception e) {
}
CertificateFactory cf = CertificateFactory.getInstance("X509");
cert = (X509Certificate) cf.generateCertificate(in);
ks.setCertificateEntry(UUID.randomUUID().toString(), cert);
TrustManagerFactory tmf = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm());
tmf.init(ks);
for (TrustManager tm : tmf.getTrustManagers()) {
if (tm instanceof X509TrustManager) {
trustManager = (X509TrustManager) tm;
break;
}
}
if (trustManager == null) {
throw new GeneralSecurityException(GT.tr("No X509TrustManager found"));
}
}

public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException {
}

public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException {
trustManager.checkServerTrusted(chain, authType);
}

public X509Certificate[] getAcceptedIssuers() {
return new X509Certificate[] { cert };
}
}
}
Loading