open-keychain/OpenKeychain/src/main/java/org/sufficientlysecure/keychain/keyimport/processing/ImportKeysListCloudLoader.java
2020-05-30 15:47:09 +02:00

199 lines
8.5 KiB
Java

/*
* Copyright (C) 2017 Schürmann & Breitmoser GbR
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.sufficientlysecure.keychain.keyimport.processing;
import android.content.Context;
import androidx.annotation.Nullable;
import androidx.loader.content.AsyncTaskLoader;
import org.sufficientlysecure.keychain.keyimport.CloudSearch;
import org.sufficientlysecure.keychain.keyimport.ImportKeysListEntry;
import org.sufficientlysecure.keychain.keyimport.KeyserverClient;
import org.sufficientlysecure.keychain.keyimport.ParcelableKeyRing;
import org.sufficientlysecure.keychain.network.orbot.OrbotHelper;
import org.sufficientlysecure.keychain.operations.results.GetKeyResult;
import org.sufficientlysecure.keychain.operations.results.OperationResult;
import org.sufficientlysecure.keychain.service.input.CryptoInputParcel;
import org.sufficientlysecure.keychain.service.input.RequiredInputParcel;
import org.sufficientlysecure.keychain.ui.util.KeyFormattingUtils;
import org.sufficientlysecure.keychain.util.ParcelableProxy;
import org.sufficientlysecure.keychain.util.Preferences;
import timber.log.Timber;
import java.util.ArrayList;
public class ImportKeysListCloudLoader
extends AsyncTaskLoader<AsyncTaskResultWrapper<ArrayList<ImportKeysListEntry>>> {
private Context mContext;
private CloudLoaderState mState;
private ParcelableProxy mParcelableProxy;
private ArrayList<ImportKeysListEntry> mEntryList = new ArrayList<>();
private AsyncTaskResultWrapper<ArrayList<ImportKeysListEntry>> mEntryListWrapper;
/**
* Searches a keyserver as specified in cloudPrefs, using an explicit proxy if passed
*
* @param loaderState state containing the string to search on servers for (if it is a
* fingerprint, will enforce fingerprint check) and the keyserver to
* search on (whether to search on the keyserver)
* @param parcelableProxy explicit proxy to use. If null, will retrieve from preferences
*/
public ImportKeysListCloudLoader(Context context, CloudLoaderState loaderState,
@Nullable ParcelableProxy parcelableProxy) {
super(context);
mContext = context;
mState = loaderState;
mParcelableProxy = parcelableProxy;
}
@Override
public AsyncTaskResultWrapper<ArrayList<ImportKeysListEntry>> loadInBackground() {
mEntryListWrapper = new AsyncTaskResultWrapper<>(mEntryList, null);
if (mState.mServerQuery == null) {
Timber.e("mServerQuery is null!");
return mEntryListWrapper;
}
if (mState.mServerQuery.startsWith("0x") && mState.mServerQuery.length() == 42) {
Timber.d("This search is based on a unique fingerprint. Enforce a fingerprint check!");
queryServer(true);
} else {
queryServer(false);
}
// Now we have all the data needed to build the parcelable key ring for this key
for (ImportKeysListEntry e : mEntryList) {
if (e.getParcelableKeyRing() == null) {
e.setParcelableKeyRing(ParcelableKeyRing.createFromReference(e.getFingerprint(), e.getKeyIdHex(),
e.getFbUsername()));
}
}
return mEntryListWrapper;
}
@Override
protected void onReset() {
super.onReset();
// Ensure the loader is stopped
onStopLoading();
}
@Override
protected void onStartLoading() {
forceLoad();
}
@Override
protected void onStopLoading() {
cancelLoad();
}
@Override
public void deliverResult(AsyncTaskResultWrapper<ArrayList<ImportKeysListEntry>> data) {
super.deliverResult(data);
}
/**
* Query keyserver
*/
private void queryServer(boolean enforceFingerprint) {
ParcelableProxy proxy;
if (mParcelableProxy == null) {
// no explicit proxy specified, fetch from preferences
if (OrbotHelper.isOrbotInRequiredState(mContext)) {
proxy = Preferences.getPreferences(mContext).getParcelableProxy();
} else {
// user needs to enable/install orbot
mEntryList.clear();
GetKeyResult pendingResult = new GetKeyResult(null,
RequiredInputParcel.createOrbotRequiredOperation(),
CryptoInputParcel.createCryptoInputParcel());
mEntryListWrapper = new AsyncTaskResultWrapper<>(mEntryList, pendingResult);
return;
}
} else {
proxy = mParcelableProxy;
}
try {
ArrayList<ImportKeysListEntry> searchResult = CloudSearch.search(
mState.mServerQuery,
mState.mCloudPrefs,
proxy
);
mEntryList.clear();
// add result to data
if (enforceFingerprint) {
String fingerprintHex = mState.mServerQuery.substring(2);
Timber.d("fingerprint: " + fingerprintHex);
// query must return only one result!
if (searchResult.size() == 1) {
if (fingerprintHex.length() != 40) {
throw new IllegalArgumentException("Bad format!");
}
ImportKeysListEntry uniqueEntry = searchResult.get(0);
/*
* set fingerprint explicitly after query
* to enforce a check when the key is imported by KeychainService
*/
uniqueEntry.setFingerprint(KeyFormattingUtils.convertFingerprintHexFingerprint(fingerprintHex));
mEntryList.add(uniqueEntry);
}
} else {
mEntryList.addAll(searchResult);
}
GetKeyResult getKeyResult = new GetKeyResult(GetKeyResult.RESULT_OK, null);
mEntryListWrapper = new AsyncTaskResultWrapper<>(mEntryList, getKeyResult);
} catch (KeyserverClient.CloudSearchFailureException e) {
// convert exception to result parcel
int error = GetKeyResult.RESULT_ERROR;
OperationResult.LogType logType = null;
if (e instanceof KeyserverClient.QueryNotImplementedException){
error = GetKeyResult.RESULT_ERROR_QUERY_NOT_IMPLEMENTED;
logType = OperationResult.LogType.MSG_GET_QUERY_NOT_IMPLEMENTED;
} else if (e instanceof KeyserverClient.QueryFailedException) {
error = GetKeyResult.RESULT_ERROR_QUERY_FAILED;
logType = OperationResult.LogType.MSG_GET_QUERY_FAILED;
} else if (e instanceof KeyserverClient.TooManyResponsesException) {
error = GetKeyResult.RESULT_ERROR_TOO_MANY_RESPONSES;
logType = OperationResult.LogType.MSG_GET_TOO_MANY_RESPONSES;
} else if (e instanceof KeyserverClient.QueryTooShortException) {
error = GetKeyResult.RESULT_ERROR_QUERY_TOO_SHORT;
logType = OperationResult.LogType.MSG_GET_QUERY_TOO_SHORT;
} else if (e instanceof KeyserverClient.QueryTooShortOrTooManyResponsesException) {
error = GetKeyResult.RESULT_ERROR_TOO_SHORT_OR_TOO_MANY_RESPONSES;
logType = OperationResult.LogType.MSG_GET_QUERY_TOO_SHORT_OR_TOO_MANY_RESPONSES;
} else if (e instanceof KeyserverClient.QueryNoEnabledSourceException) {
error = GetKeyResult.RESULT_ERROR_NO_ENABLED_SOURCE;
logType = OperationResult.LogType.MSG_GET_NO_ENABLED_SOURCE;
}
OperationResult.OperationLog log = new OperationResult.OperationLog();
log.add(logType, 0);
GetKeyResult getKeyResult = new GetKeyResult(error, log);
mEntryListWrapper = new AsyncTaskResultWrapper<>(mEntryList, getKeyResult);
}
}
}