src/com/owncloud/android/operations/DetectAuthenticationMethodOperation.java

   1 /* ownCloud Android Library is available under MIT license
   2  *   Copyright (C) 2014 ownCloud Inc.
   3  *
   4  *   Permission is hereby granted, free of charge, to any person obtaining a copy
   5  *   of this software and associated documentation files (the "Software"), to deal
   6  *   in the Software without restriction, including without limitation the rights
   7  *   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8  *   copies of the Software, and to permit persons to whom the Software is
   9  *   furnished to do so, subject to the following conditions:
  10  *
  11  *   The above copyright notice and this permission notice shall be included in
  12  *   all copies or substantial portions of the Software.
  13  *
  14  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  15  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  17  *   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  18  *   BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  19  *   ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  20  *   CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21  *   THE SOFTWARE.
  22  *
  23  */
  24
  25 package com.owncloud.android.operations;
  26
  27 import java.util.ArrayList;
  28
  29 import com.owncloud.android.lib.common.OwnCloudClient;
  30 import com.owncloud.android.lib.common.operations.OnRemoteOperationListener;
  31 import com.owncloud.android.lib.common.operations.RemoteOperation;
  32 import com.owncloud.android.lib.common.operations.RemoteOperationResult;
  33 import com.owncloud.android.lib.common.operations.RemoteOperationResult.ResultCode;
  34 import com.owncloud.android.lib.common.utils.Log_OC;
  35 import com.owncloud.android.lib.resources.files.ExistenceCheckRemoteOperation;
  36
  37 import android.content.Context;
  38 import android.net.Uri;
  39
  40 /**
  41  * Operation to find out what authentication method requires
  42  * the server to access files.
  43  *
  44  * Basically, tries to access to the root folder without authorization
  45  * and analyzes the response.
  46  *
  47  * When successful, the instance of {@link RemoteOperationResult} passed
  48  * through {@link OnRemoteOperationListener#onRemoteOperationFinish(RemoteOperation,
  49  * RemoteOperationResult)} returns in {@link RemoteOperationResult#getData()}
  50  * a value of {@link AuthenticationMethod}.
  51  *
  52  * @author David A. Velasco
  53  */
  54 public class DetectAuthenticationMethodOperation extends RemoteOperation {
  55
  56     private static final String TAG = DetectAuthenticationMethodOperation.class.getSimpleName();
  57
  58     public enum AuthenticationMethod {
  59         UNKNOWN,
  60         NONE,
  61         BASIC_HTTP_AUTH,
  62         SAML_WEB_SSO,
  63         BEARER_TOKEN
  64     }
  65
  66     private Context mContext;
  67
  68     /**
  69      * Constructor
  70      *
  71      * @param context       Android context of the caller.
  72      * @param webdavUrl
  73      */
  74     public DetectAuthenticationMethodOperation(Context context) {
  75         mContext = context;
  76     }
  77
  78
  79     /**
  80      *  Performs the operation.
  81      *
  82      *  Triggers a check of existence on the root folder of the server, granting
  83      *  that the request is not authenticated.
  84      *
  85      *  Analyzes the result of check to find out what authentication method, if
  86      *  any, is requested by the server.
  87      */
  88         @Override
  89         protected RemoteOperationResult run(OwnCloudClient client) {
  90         RemoteOperationResult result = null;
  91         AuthenticationMethod authMethod = AuthenticationMethod.UNKNOWN;
  92
  93         RemoteOperation operation = new ExistenceCheckRemoteOperation("", mContext, false);
  94         client.clearCredentials();
  95         client.setFollowRedirects(false);
  96
  97         // try to access the root folder, following redirections but not SAML SSO redirections
  98         result = operation.execute(client);
  99         String redirectedLocation = result.getRedirectedLocation();
 100         while (redirectedLocation != null && redirectedLocation.length() > 0 &&
 101                 !result.isIdPRedirection()) {
 102             client.setBaseUri(Uri.parse(result.getRedirectedLocation()));
 103             result = operation.execute(client);
 104             redirectedLocation = result.getRedirectedLocation();
 105         }
 106
 107         // analyze response
 108         if (result.getCode() == ResultCode.UNAUTHORIZED) {
 109             String authRequest = ((result.getAuthenticateHeader()).trim()).toLowerCase();
 110             if (authRequest.startsWith("basic")) {
 111                 authMethod = AuthenticationMethod.BASIC_HTTP_AUTH;
 112
 113             } else if (authRequest.startsWith("bearer")) {
 114                 authMethod = AuthenticationMethod.BEARER_TOKEN;
 115             }
 116             // else - fall back to UNKNOWN
 117
 118         } else if (result.isSuccess()) {
 119             authMethod = AuthenticationMethod.NONE;
 120
 121         } else if (result.isIdPRedirection()) {
 122             authMethod = AuthenticationMethod.SAML_WEB_SSO;
 123         }
 124         // else - fall back to UNKNOWN
 125         Log_OC.d(TAG, "Authentication method found: " + authenticationMethodToString(authMethod));
 126
 127         if (!authMethod.equals(AuthenticationMethod.UNKNOWN)) {
 128             result = new RemoteOperationResult(true, result.getHttpCode(), null);
 129         }
 130         ArrayList<Object> data = new ArrayList<Object>();
 131         data.add(authMethod);
 132         result.setData(data);
 133         return result;  // same result instance, so that other errors can be handled by the caller transparently
 134         }
 135
 136
 137         private String authenticationMethodToString(AuthenticationMethod value) {
 138             switch (value){
 139             case NONE:
 140                 return "NONE";
 141             case BASIC_HTTP_AUTH:
 142                 return "BASIC_HTTP_AUTH";
 143             case BEARER_TOKEN:
 144                 return "BEARER_TOKEN";
 145             case SAML_WEB_SSO:
 146                 return "SAML_WEB_SSO";
 147             default:
 148             return "UNKNOWN";
 149             }
 150     }
 151
 152 }