File: LibPQFactory.java

package info (click to toggle)
libpgjava 9.2-1002-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 4,308 kB
  • ctags: 4,503
  • sloc: java: 37,623; xml: 3,376; makefile: 22; sh: 10
file content (291 lines) | stat: -rw-r--r-- 10,774 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
package org.postgresql.ssl.jdbc4;

import java.io.Console;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.security.GeneralSecurityException;
import java.security.KeyManagementException;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.Certificate;
import java.security.cert.CertificateFactory;
import java.security.cert.X509Certificate;
import java.util.Iterator;
import java.util.Properties;

import javax.naming.InvalidNameException;
import javax.naming.ldap.LdapName;
import javax.naming.ldap.Rdn;
import javax.net.ssl.HostnameVerifier;
import javax.net.ssl.KeyManager;
import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLPeerUnverifiedException;
import javax.net.ssl.SSLSession;
import javax.net.ssl.TrustManager;
import javax.net.ssl.TrustManagerFactory;
import javax.security.auth.callback.Callback;
import javax.security.auth.callback.CallbackHandler;
import javax.security.auth.callback.PasswordCallback;
import javax.security.auth.callback.UnsupportedCallbackException;
import javax.security.auth.x500.X500Principal;

import org.postgresql.ssl.NonValidatingFactory.NonValidatingTM;
import org.postgresql.ssl.WrappedFactory;
import org.postgresql.util.GT;
import org.postgresql.util.PSQLException;
import org.postgresql.util.PSQLState;

/**
 * Provide an SSLSocketFactory that is compatible with the libpq
 * behaviour.
 */
public class LibPQFactory extends WrappedFactory implements HostnameVerifier {

    LazyKeyManager km = null;
    String sslmode; 
    /**
     * 
     * @param info the connection parameters
     * The following parameters are used:
     * sslmode,sslcert,sslkey,sslrootcert,sslhostnameverifier,sslpasswordcallback,sslpassword
     * @throws GeneralSecurityException
     * @throws IOException 
     * @throws UnsupportedCallbackException 
     */
    public LibPQFactory(Properties info) throws PSQLException {
      try
      {
        sslmode = info.getProperty("sslmode");
        SSLContext ctx = SSLContext.getInstance("TLS"); // or "SSL" ?
        
        //Determinig the default file location
        String pathsep = System.getProperty("path.separator");
        String defaultdir;
        boolean defaultfile = false;
        if (System.getProperty("os.name").toLowerCase().indexOf("windows") > -1)
        { //It is Windows
          defaultdir = System.getenv("APPDATA")+pathsep+"postgresql"+pathsep;
        } else {
          defaultdir = System.getProperty("user.home")+pathsep+".postgresql"+pathsep;
        }
        
        //Load the client's certificate and key
        String sslcertfile = info.getProperty("sslcert");
        if (sslcertfile == null)
        { //Fall back to default
          defaultfile = true;
          sslcertfile = defaultdir + "postgresql.crt";
        }
        String sslkeyfile = info.getProperty("sslkey");
        if (sslkeyfile == null)
        { //Fall back to default
          defaultfile = true;
          sslkeyfile = defaultdir + "postgresql.pk8";
        }
        
        //Determine the callback handler
        CallbackHandler cbh;
        String sslpasswordcallback = info.getProperty("sslpasswordcallback");
        if (sslpasswordcallback != null)
        {
          try
          {
            cbh = (CallbackHandler)AbstractJdbc4MakeSSL.instantiate(sslpasswordcallback, info, false, null);
          }
          catch (Exception e)
          {
              throw new PSQLException(GT.tr("The password callback class provided {0} could not be instantiated.", sslpasswordcallback), PSQLState.CONNECTION_FAILURE, e);
          }
        } else {
          cbh = new ConsoleCallbackHandler(info.getProperty("sslpassword"));
        }
         
        //If the properies are empty, give null to prevent client key selection
        km = new LazyKeyManager(("".equals(sslcertfile) ? null : sslcertfile), ("".equals(sslkeyfile) ? null : sslkeyfile), cbh, defaultfile);
        
        TrustManager[] tm;    
        if("verify-ca".equals(sslmode) || "verify-full".equals(sslmode))
        {
          //Load the server certificate
          
          TrustManagerFactory tmf = TrustManagerFactory.getInstance("PKIX");
          KeyStore ks;
          try
          {
            ks = KeyStore.getInstance("jks");
          } catch (KeyStoreException e)
          {
            throw new NoSuchAlgorithmException("jks KeyStore not available"); //this should never happen
          }
          String sslrootcertfile = info.getProperty("sslrootcert");
          if (sslrootcertfile == null)
          { //Fall back to default
            sslrootcertfile = defaultdir + "root.crt";
          }
          FileInputStream fis;
          try
          {
            fis = new FileInputStream(sslrootcertfile);
          } catch (FileNotFoundException ex)
          {
            throw new PSQLException(GT.tr("Could not open SSL root certificate file {0}.", new Object[]{sslrootcertfile}), PSQLState.CONNECTION_FAILURE, ex);
          }
          try
          {
            CertificateFactory cf = CertificateFactory.getInstance("X.509");
            //Certificate[] certs = cf.generateCertificates(fis).toArray(new Certificate[]{}); //Does not work in java 1.4
            Object[] certs = cf.generateCertificates(fis).toArray(new Certificate[]{});
            fis.close();
            ks.load(null, null);
            for(int i=0; i<certs.length; i++)
            {
              ks.setCertificateEntry("cert"+i, (Certificate)certs[i]);
            }
            tmf.init(ks);
          }
          catch (IOException ioex)
          {
            throw new PSQLException(GT.tr("Could not read SSL root certificate file {0}.", new Object[]{sslrootcertfile}), PSQLState.CONNECTION_FAILURE, ioex);
          } catch (GeneralSecurityException gsex)
          {
            throw new PSQLException(GT.tr("Loading the SSL root certificate {0} into a TrustManager failed.", new Object[]{sslrootcertfile}), PSQLState.CONNECTION_FAILURE, gsex);
          } 
          tm = tmf.getTrustManagers();
        } else { //server validation is not required
          tm = new TrustManager[] { new NonValidatingTM() };
        }

        //finally we can initialize the context
        try
        {
          ctx.init(new KeyManager[]{km}, tm, null);
        } catch (KeyManagementException ex)
        {
          throw new PSQLException(GT.tr("Could not initialize SSL context.", null), PSQLState.CONNECTION_FAILURE, ex);
        }

        _factory = ctx.getSocketFactory();
      }
      catch(NoSuchAlgorithmException ex)
      {
        throw new PSQLException(GT.tr("Could not find a java cryptographic algorithm: {0}.", new Object[]{ex.getMessage()}), PSQLState.CONNECTION_FAILURE, ex);
      }
    }

    /**
     * Propagates any exception from LazyKeyManager
     * @throws PSQLException
     */
    public void throwKeyManagerException() throws PSQLException
    {
      if (km!=null) km.throwKeyManagerException();
    }
    
    /**
     * A CallbackHandler that reads the password from the console
     * or returns the password given to it's constructor.
     *
     */
    class ConsoleCallbackHandler implements CallbackHandler {

      private char[] password = null;
      
      public ConsoleCallbackHandler(String password)
      {
        if (password != null) this.password = password.toCharArray();
      }
      
      /**
       * Handles the callbacks.
       * @param callbacks The callbacks to handle
       * @throws UnsupportedCallbackException If the console is not available
       * or other than PasswordCallback is supplied
       */
      public void handle(Callback[] callbacks) throws IOException,
          UnsupportedCallbackException {
        Console cons = System.console();
        if (cons==null && password==null) {throw new UnsupportedCallbackException(callbacks[0], "Console is not available");}
        for (int i=0; i<callbacks.length; i++)
        {
          if (callbacks[i] instanceof PasswordCallback)
          {
            if (password==null)
            {
              //It is used instead of cons.readPassword(prompt), because the prompt may contain '%' characters
              ((PasswordCallback)callbacks[i]).setPassword(cons.readPassword("%s", new Object[]{((PasswordCallback)callbacks[i]).getPrompt()}));
            } else {
              ((PasswordCallback)callbacks[i]).setPassword(password);
            }
          } else {
            throw new UnsupportedCallbackException(callbacks[i]);
          }
      }
      
    }
  }

    /**
     * Verifies the server certificate according to the libpq rules.
     * The cn attribute of the certificate is matched against the hostname.
     * If the cn  attribute starts with an asterisk (*), it will be treated as a wildcard,
     * and will match all characters except a dot (.). This means the certificate
     * will not match subdomains. If the connection is made using an IP address instead of a
     * hostname, the IP address will be matched (without doing any DNS lookups).
     * @param hostname Hostname or IP address of the server.
     * @param session The  SSL session.
     * @returns true if the certificate belongs to the server, false otherwise.
     */
    public boolean verify(String hostname, SSLSession session) {
      X509Certificate[] peerCerts;
      try
      {
        peerCerts = (X509Certificate[])session.getPeerCertificates();
      } catch (SSLPeerUnverifiedException e)
      {
        return false;
      }
      if (peerCerts == null || peerCerts.length == 0) {
        return false;
      }
      //Extract the common name
      X509Certificate serverCert = peerCerts[0];
      LdapName DN;
      try
      {
        DN = new LdapName(serverCert.getSubjectX500Principal().getName(X500Principal.RFC2253));
      } catch (InvalidNameException e)
      {
        return false; 
      }
      String CN = null;
      Iterator it = DN.getRdns().iterator();
      //for(Rdn rdn : DN.getRdns())
      while(it.hasNext())
      {
        Rdn rdn = (Rdn)it.next();
        if ("CN".equals(rdn.getType())) //Multiple AVAs are not treated
        {
          CN = (String)rdn.getValue();
          break;
        }
      }
      if (CN == null)
      {
        return false;
      } else if (CN.startsWith("*"))
      { //We have a wildcard
        if (hostname.endsWith(CN.substring(1)))
        { //Avoid IndexOutOfBoundsException because hostname already ends with CN
          return !(hostname.substring(0, hostname.length()-CN.length()+1).contains("."));
        } else {
          return false;
        }
      } else {
        return CN.equals(hostname);
      }
    }

}