193 lines
7.9 KiB
Java
193 lines
7.9 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.operations;
|
|
|
|
|
|
import java.io.IOException;
|
|
import java.util.concurrent.atomic.AtomicBoolean;
|
|
|
|
import android.content.Context;
|
|
import androidx.annotation.NonNull;
|
|
|
|
import org.sufficientlysecure.keychain.R;
|
|
import org.sufficientlysecure.keychain.daos.KeyMetadataDao;
|
|
import org.sufficientlysecure.keychain.daos.KeyRepository.NotFoundException;
|
|
import org.sufficientlysecure.keychain.daos.KeyWritableRepository;
|
|
import org.sufficientlysecure.keychain.operations.results.EditKeyResult;
|
|
import org.sufficientlysecure.keychain.operations.results.OperationResult.LogType;
|
|
import org.sufficientlysecure.keychain.operations.results.OperationResult.OperationLog;
|
|
import org.sufficientlysecure.keychain.operations.results.PgpEditKeyResult;
|
|
import org.sufficientlysecure.keychain.operations.results.SaveKeyringResult;
|
|
import org.sufficientlysecure.keychain.operations.results.UploadResult;
|
|
import org.sufficientlysecure.keychain.pgp.CanonicalizedSecretKeyRing;
|
|
import org.sufficientlysecure.keychain.pgp.PgpKeyOperation;
|
|
import org.sufficientlysecure.keychain.pgp.Progressable;
|
|
import org.sufficientlysecure.keychain.pgp.UncachedKeyRing;
|
|
import org.sufficientlysecure.keychain.service.ContactSyncAdapterService;
|
|
import org.sufficientlysecure.keychain.service.SaveKeyringParcel;
|
|
import org.sufficientlysecure.keychain.service.UploadKeyringParcel;
|
|
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.ProgressScaler;
|
|
|
|
/**
|
|
* An operation which implements a high level key edit operation.
|
|
* <p/>
|
|
* This operation provides a higher level interface to the edit and
|
|
* create key operations in PgpKeyOperation. It takes care of fetching
|
|
* and saving the key before and after the operation.
|
|
*
|
|
* @see SaveKeyringParcel
|
|
*
|
|
*/
|
|
public class EditKeyOperation extends BaseReadWriteOperation<SaveKeyringParcel> {
|
|
private final KeyMetadataDao keyMetadataDao;
|
|
|
|
|
|
public EditKeyOperation(Context context, KeyWritableRepository databaseInteractor,
|
|
Progressable progressable, AtomicBoolean cancelled) {
|
|
super(context, databaseInteractor, progressable, cancelled);
|
|
|
|
this.keyMetadataDao = KeyMetadataDao.create(context);
|
|
}
|
|
|
|
/**
|
|
* Saves an edited key, and uploads it to a server atomically or otherwise as
|
|
* specified in saveParcel
|
|
*
|
|
* @param saveParcel primary input to the operation
|
|
* @param cryptoInput input that changes if user interaction is required
|
|
* @return the result of the operation
|
|
*/
|
|
@NonNull
|
|
public EditKeyResult execute(SaveKeyringParcel saveParcel, CryptoInputParcel cryptoInput) {
|
|
|
|
OperationLog log = new OperationLog();
|
|
log.add(LogType.MSG_ED, 0);
|
|
|
|
if (saveParcel == null) {
|
|
log.add(LogType.MSG_ED_ERROR_NO_PARCEL, 1);
|
|
return new EditKeyResult(EditKeyResult.RESULT_ERROR, log, null);
|
|
}
|
|
|
|
// Perform actual modification (or creation)
|
|
boolean isNewKey = saveParcel.getMasterKeyId() == null;
|
|
PgpEditKeyResult modifyResult;
|
|
{
|
|
PgpKeyOperation keyOperations =
|
|
new PgpKeyOperation(new ProgressScaler(mProgressable, 10, 60, 100), mCancelled);
|
|
|
|
// If a key id is specified, fetch and edit
|
|
if (!isNewKey) {
|
|
try {
|
|
|
|
log.add(LogType.MSG_ED_FETCHING, 1,
|
|
KeyFormattingUtils.convertKeyIdToHex(saveParcel.getMasterKeyId()));
|
|
CanonicalizedSecretKeyRing secRing =
|
|
mKeyRepository.getCanonicalizedSecretKeyRing(saveParcel.getMasterKeyId());
|
|
|
|
modifyResult = keyOperations.modifySecretKeyRing(secRing, cryptoInput, saveParcel);
|
|
if (modifyResult.isPending()) {
|
|
log.add(modifyResult, 1);
|
|
return new EditKeyResult(log, modifyResult);
|
|
}
|
|
|
|
} catch (NotFoundException e) {
|
|
log.add(LogType.MSG_ED_ERROR_KEY_NOT_FOUND, 2);
|
|
return new EditKeyResult(EditKeyResult.RESULT_ERROR, log, null);
|
|
}
|
|
} else {
|
|
// otherwise, create new one
|
|
modifyResult = keyOperations.createSecretKeyRing(saveParcel);
|
|
}
|
|
}
|
|
|
|
// Add the result to the log
|
|
log.add(modifyResult, 1);
|
|
|
|
// Check if the action was cancelled
|
|
if (checkCancelled()) {
|
|
log.add(LogType.MSG_OPERATION_CANCELLED, 0);
|
|
return new EditKeyResult(PgpEditKeyResult.RESULT_CANCELLED, log, null);
|
|
}
|
|
|
|
// If the edit operation didn't succeed, exit here
|
|
if (!modifyResult.success()) {
|
|
// error is already logged by modification
|
|
return new EditKeyResult(EditKeyResult.RESULT_ERROR, log, null);
|
|
}
|
|
|
|
// Cannot cancel from here on out!
|
|
mProgressable.setPreventCancel();
|
|
|
|
// It's a success, so this must be non-null now
|
|
UncachedKeyRing ring = modifyResult.getRing();
|
|
|
|
if (saveParcel.isShouldUpload()) {
|
|
byte[] keyringBytes;
|
|
try {
|
|
UncachedKeyRing publicKeyRing = ring.extractPublicKeyRing();
|
|
keyringBytes = publicKeyRing.getEncoded();
|
|
} catch (IOException e) {
|
|
log.add(LogType.MSG_ED_ERROR_EXTRACTING_PUBLIC_UPLOAD, 1);
|
|
return new EditKeyResult(EditKeyResult.RESULT_ERROR, log, null);
|
|
}
|
|
|
|
UploadKeyringParcel exportKeyringParcel =
|
|
UploadKeyringParcel.createWithKeyringBytes(saveParcel.getUploadKeyserver(), keyringBytes);
|
|
|
|
UploadResult uploadResult = new UploadOperation(
|
|
mContext, mKeyRepository, new ProgressScaler(mProgressable, 60, 80, 100), mCancelled)
|
|
.execute(exportKeyringParcel, cryptoInput);
|
|
|
|
log.add(uploadResult, 2);
|
|
|
|
if (uploadResult.isPending()) {
|
|
return new EditKeyResult(log, uploadResult);
|
|
} else if (!uploadResult.success() && saveParcel.isShouldUploadAtomic()) {
|
|
// if atomic, update fail implies edit operation should also fail and not save
|
|
return new EditKeyResult(log, RequiredInputParcel.createRetryUploadOperation(), cryptoInput);
|
|
}
|
|
}
|
|
|
|
// Save the new keyring.
|
|
updateProgress(R.string.progress_saving, 90, 100);
|
|
SaveKeyringResult saveResult = mKeyWritableRepository.saveSecretKeyRing(ring);
|
|
log.add(saveResult, 1);
|
|
|
|
if (isNewKey || saveParcel.isShouldUpload()) {
|
|
keyMetadataDao.renewKeyLastUpdatedTime(ring.getMasterKeyId(), saveParcel.isShouldUpload());
|
|
}
|
|
|
|
// If the save operation didn't succeed, exit here
|
|
if (!saveResult.success()) {
|
|
return new EditKeyResult(EditKeyResult.RESULT_ERROR, log, null);
|
|
}
|
|
|
|
updateProgress(R.string.progress_done, 100, 100);
|
|
|
|
// make sure new data is synced into contacts
|
|
ContactSyncAdapterService.requestContactsSync();
|
|
|
|
log.add(LogType.MSG_ED_SUCCESS, 0);
|
|
return new EditKeyResult(EditKeyResult.RESULT_OK, log, ring.getMasterKeyId());
|
|
|
|
}
|
|
}
|