src/com/owncloud/android/network/OwnCloudClientUtils.java

   1 /* ownCloud Android client application
   2  *   Copyright (C) 2012-2013 ownCloud Inc.
   3  *
   4  *   This program is free software: you can redistribute it and/or modify
   5  *   it under the terms of the GNU General Public License as published by
   6  *   the Free Software Foundation, either version 2 of the License, or
   7  *   (at your option) any later version.
   8  *
   9  *   This program is distributed in the hope that it will be useful,
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *   GNU General Public License for more details.
  13  *
  14  *   You should have received a copy of the GNU General Public License
  15  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  *
  17  */
  18 package com.owncloud.android.network;
  19
  20 import java.io.File;
  21 import java.io.FileInputStream;
  22 import java.io.FileOutputStream;
  23 import java.io.IOException;
  24 import java.io.InputStream;
  25 import java.security.GeneralSecurityException;
  26 import java.security.KeyStore;
  27 import java.security.KeyStoreException;
  28 import java.security.NoSuchAlgorithmException;
  29 import java.security.cert.Certificate;
  30 import java.security.cert.CertificateException;
  31
  32 import javax.net.ssl.SSLContext;
  33 import javax.net.ssl.TrustManager;
  34
  35 import org.apache.commons.httpclient.MultiThreadedHttpConnectionManager;
  36 import org.apache.commons.httpclient.protocol.Protocol;
  37 import org.apache.http.conn.ssl.BrowserCompatHostnameVerifier;
  38 import org.apache.http.conn.ssl.X509HostnameVerifier;
  39
  40 import com.owncloud.android.AccountUtils;
  41 import com.owncloud.android.authentication.AccountAuthenticator;
  42
  43 import eu.alefzero.webdav.WebdavClient;
  44
  45 import android.accounts.Account;
  46 import android.accounts.AccountManager;
  47 import android.accounts.AccountManagerFuture;
  48 import android.accounts.AuthenticatorException;
  49 import android.accounts.OperationCanceledException;
  50 import android.app.Activity;
  51 import android.content.Context;
  52 import android.net.Uri;
  53 import android.os.Bundle;
  54 import android.util.Log;
  55
  56 public class OwnCloudClientUtils {
  57
  58     final private static String TAG = OwnCloudClientUtils.class.getSimpleName();
  59
  60     /** Default timeout for waiting data from the server */
  61     public static final int DEFAULT_DATA_TIMEOUT = 60000;
  62
  63     /** Default timeout for establishing a connection */
  64     public static final int DEFAULT_CONNECTION_TIMEOUT = 60000;
  65
  66     /** Connection manager for all the WebdavClients */
  67     private static MultiThreadedHttpConnectionManager mConnManager = null;
  68
  69     private static Protocol mDefaultHttpsProtocol = null;
  70
  71     private static AdvancedSslSocketFactory mAdvancedSslSocketFactory = null;
  72
  73     private static X509HostnameVerifier mHostnameVerifier = null;
  74
  75
  76     /**
  77      * Creates a WebdavClient setup for an ownCloud account
  78      *
  79      * Do not call this method from the main thread.
  80      *
  81      * @param account                       The ownCloud account
  82      * @param appContext                    Android application context
  83      * @return                              A WebdavClient object ready to be used
  84      * @throws AuthenticatorException       If the authenticator failed to get the authorization token for the account.
  85      * @throws OperationCanceledException   If the authenticator operation was cancelled while getting the authorization token for the account.
  86      * @throws IOException                  If there was some I/O error while getting the authorization token for the account.
  87      */
  88     public static WebdavClient createOwnCloudClient (Account account, Context appContext) throws OperationCanceledException, AuthenticatorException, IOException {
  89         //Log.d(TAG, "Creating WebdavClient associated to " + account.name);
  90
  91         Uri uri = Uri.parse(AccountUtils.constructFullURLForAccount(appContext, account));
  92         WebdavClient client = createOwnCloudClient(uri, appContext);
  93         AccountManager am = AccountManager.get(appContext);
  94         if (am.getUserData(account, AccountAuthenticator.KEY_SUPPORTS_OAUTH2) != null) {    // TODO avoid a call to getUserData here
  95             String accessToken = am.blockingGetAuthToken(account, AccountAuthenticator.AUTH_TOKEN_TYPE_ACCESS_TOKEN, false);
  96             client.setBearerCredentials(accessToken);   // TODO not assume that the access token is a bearer token
  97
  98         } else {
  99             String username = account.name.substring(0, account.name.lastIndexOf('@'));
 100             //String password = am.getPassword(account);
 101             String password = am.blockingGetAuthToken(account, AccountAuthenticator.AUTH_TOKEN_TYPE_PASSWORD, false);
 102             client.setBasicCredentials(username, password);
 103         }
 104
 105         return client;
 106     }
 107
 108
 109     public static WebdavClient createOwnCloudClient (Account account, Context appContext, Activity currentActivity) throws OperationCanceledException, AuthenticatorException, IOException {
 110         Uri uri = Uri.parse(AccountUtils.constructFullURLForAccount(appContext, account));
 111         WebdavClient client = createOwnCloudClient(uri, appContext);
 112         AccountManager am = AccountManager.get(appContext);
 113         if (am.getUserData(account, AccountAuthenticator.KEY_SUPPORTS_OAUTH2) != null) {    // TODO avoid a call to getUserData here
 114             AccountManagerFuture<Bundle> future =  am.getAuthToken(account, AccountAuthenticator.AUTH_TOKEN_TYPE_ACCESS_TOKEN, null, currentActivity, null, null);
 115             Bundle result = future.getResult();
 116             String accessToken = result.getString(AccountManager.KEY_AUTHTOKEN);
 117             //String accessToken = am.blockingGetAuthToken(account, AccountAuthenticator.AUTH_TOKEN_TYPE_ACCESS_TOKEN, false);
 118             if (accessToken == null) throw new AuthenticatorException("WTF!");
 119             client.setBearerCredentials(accessToken);   // TODO not assume that the access token is a bearer token
 120
 121         } else {
 122             String username = account.name.substring(0, account.name.lastIndexOf('@'));
 123             //String password = am.getPassword(account);
 124             //String password = am.blockingGetAuthToken(account, AccountAuthenticator.AUTH_TOKEN_TYPE_PASSWORD, false);
 125             AccountManagerFuture<Bundle> future =  am.getAuthToken(account, AccountAuthenticator.AUTH_TOKEN_TYPE_PASSWORD, null, currentActivity, null, null);
 126             Bundle result = future.getResult();
 127             String password = result.getString(AccountManager.KEY_AUTHTOKEN);
 128             client.setBasicCredentials(username, password);
 129         }
 130
 131         return client;
 132     }
 133
 134
 135     /**
 136      * Creates a WebdavClient to access a URL and sets the desired parameters for ownCloud client connections.
 137      *
 138      * @param uri       URL to the ownCloud server
 139      * @param context   Android context where the WebdavClient is being created.
 140      * @return          A WebdavClient object ready to be used
 141      */
 142     public static WebdavClient createOwnCloudClient(Uri uri, Context context) {
 143         //Log.d(TAG, "Creating WebdavClient for " + uri);
 144
 145         //allowSelfsignedCertificates(true);
 146         try {
 147             registerAdvancedSslContext(true, context);
 148         }  catch (GeneralSecurityException e) {
 149             Log.e(TAG, "Advanced SSL Context could not be loaded. Default SSL management in the system will be used for HTTPS connections", e);
 150
 151         } catch (IOException e) {
 152             Log.e(TAG, "The local server truststore could not be read. Default SSL management in the system will be used for HTTPS connections", e);
 153         }
 154
 155         WebdavClient client = new WebdavClient(getMultiThreadedConnManager());
 156
 157         client.setDefaultTimeouts(DEFAULT_DATA_TIMEOUT, DEFAULT_CONNECTION_TIMEOUT);
 158         client.setBaseUri(uri);
 159
 160         return client;
 161     }
 162
 163
 164     /**
 165      * Registers or unregisters the proper components for advanced SSL handling.
 166      * @throws IOException
 167      */
 168     private static void registerAdvancedSslContext(boolean register, Context context) throws GeneralSecurityException, IOException {
 169         Protocol pr = null;
 170         try {
 171             pr = Protocol.getProtocol("https");
 172             if (pr != null && mDefaultHttpsProtocol == null) {
 173                 mDefaultHttpsProtocol = pr;
 174             }
 175         } catch (IllegalStateException e) {
 176             // nothing to do here; really
 177         }
 178         boolean isRegistered = (pr != null && pr.getSocketFactory() instanceof AdvancedSslSocketFactory);
 179         if (register && !isRegistered) {
 180             Protocol.registerProtocol("https", new Protocol("https", getAdvancedSslSocketFactory(context), 443));
 181
 182         } else if (!register && isRegistered) {
 183             if (mDefaultHttpsProtocol != null) {
 184                 Protocol.registerProtocol("https", mDefaultHttpsProtocol);
 185             }
 186         }
 187     }
 188
 189     public static AdvancedSslSocketFactory getAdvancedSslSocketFactory(Context context) throws GeneralSecurityException, IOException {
 190         if (mAdvancedSslSocketFactory  == null) {
 191             KeyStore trustStore = getKnownServersStore(context);
 192             AdvancedX509TrustManager trustMgr = new AdvancedX509TrustManager(trustStore);
 193             TrustManager[] tms = new TrustManager[] { trustMgr };
 194
 195             SSLContext sslContext = SSLContext.getInstance("TLS");
 196             sslContext.init(null, tms, null);
 197
 198             mHostnameVerifier = new BrowserCompatHostnameVerifier();
 199             mAdvancedSslSocketFactory = new AdvancedSslSocketFactory(sslContext, trustMgr, mHostnameVerifier);
 200         }
 201         return mAdvancedSslSocketFactory;
 202     }
 203
 204
 205     private static String LOCAL_TRUSTSTORE_FILENAME = "knownServers.bks";
 206
 207     private static String LOCAL_TRUSTSTORE_PASSWORD = "password";
 208
 209     private static KeyStore mKnownServersStore = null;
 210
 211     /**
 212      * Returns the local store of reliable server certificates, explicitly accepted by the user.
 213      *
 214      * Returns a KeyStore instance with empty content if the local store was never created.
 215      *
 216      * Loads the store from the storage environment if needed.
 217      *
 218      * @param context                       Android context where the operation is being performed.
 219      * @return                              KeyStore instance with explicitly-accepted server certificates.
 220      * @throws KeyStoreException            When the KeyStore instance could not be created.
 221      * @throws IOException                  When an existing local trust store could not be loaded.
 222      * @throws NoSuchAlgorithmException     When the existing local trust store was saved with an unsupported algorithm.
 223      * @throws CertificateException         When an exception occurred while loading the certificates from the local trust store.
 224      */
 225     private static KeyStore getKnownServersStore(Context context) throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException {
 226         if (mKnownServersStore == null) {
 227             //mKnownServersStore = KeyStore.getInstance("BKS");
 228             mKnownServersStore = KeyStore.getInstance(KeyStore.getDefaultType());
 229             File localTrustStoreFile = new File(context.getFilesDir(), LOCAL_TRUSTSTORE_FILENAME);
 230             Log.d(TAG, "Searching known-servers store at " + localTrustStoreFile.getAbsolutePath());
 231             if (localTrustStoreFile.exists()) {
 232                 InputStream in = new FileInputStream(localTrustStoreFile);
 233                 try {
 234                     mKnownServersStore.load(in, LOCAL_TRUSTSTORE_PASSWORD.toCharArray());
 235                 } finally {
 236                     in.close();
 237                 }
 238             } else {
 239                 mKnownServersStore.load(null, LOCAL_TRUSTSTORE_PASSWORD.toCharArray()); // necessary to initialize an empty KeyStore instance
 240             }
 241         }
 242         return mKnownServersStore;
 243     }
 244
 245
 246     public static void addCertToKnownServersStore(Certificate cert, Context context) throws  KeyStoreException, NoSuchAlgorithmException,
 247                                                                                             CertificateException, IOException {
 248         KeyStore knownServers = getKnownServersStore(context);
 249         knownServers.setCertificateEntry(Integer.toString(cert.hashCode()), cert);
 250         FileOutputStream fos = null;
 251         try {
 252             fos = context.openFileOutput(LOCAL_TRUSTSTORE_FILENAME, Context.MODE_PRIVATE);
 253             knownServers.store(fos, LOCAL_TRUSTSTORE_PASSWORD.toCharArray());
 254         } finally {
 255             fos.close();
 256         }
 257     }
 258
 259
 260     static private MultiThreadedHttpConnectionManager getMultiThreadedConnManager() {
 261         if (mConnManager == null) {
 262             mConnManager = new MultiThreadedHttpConnectionManager();
 263             mConnManager.getParams().setDefaultMaxConnectionsPerHost(5);
 264             mConnManager.getParams().setMaxTotalConnections(5);
 265         }
 266         return mConnManager;
 267     }
 268
 269
 270 }