cthrace/open-keychain
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Extend documentation, proper method naming, use of deprecated method annotation

Browse Source
This commit is contained in:
Dominik Schürmann
2016-02-22 15:19:06 +01:00
parent 6379ce1faa
commit f54f12c48c
7 changed files with 53 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
OpenKeychain/src/main/AndroidManifest.xml
View File

@@ -847,6 +847,8 @@
<activity <activity
android:name=".remote.ui.RemotePassphraseDialogActivity" android:name=".remote.ui.RemotePassphraseDialogActivity"
android:theme="@style/Theme.Keychain.Transparent" /> android:theme="@style/Theme.Keychain.Transparent" />
<!-- see SecurityTokenOperationActivity for reasons why
allowTaskReparenting, singleTop, and taskAffinity is used -->
<activity <activity
android:name=".remote.ui.RemoteSecurityTokenOperationActivity" android:name=".remote.ui.RemoteSecurityTokenOperationActivity"
android:allowTaskReparenting="true" android:allowTaskReparenting="true"

50
OpenKeychain/src/main/java/org/sufficientlysecure/keychain/remote/ApiPendingIntentFactory.java
View File

@@ -55,11 +55,11 @@ public class ApiPendingIntentFactory {
case NFC_MOVE_KEY_TO_CARD: case NFC_MOVE_KEY_TO_CARD:
case NFC_DECRYPT: case NFC_DECRYPT:
case NFC_SIGN: { case NFC_SIGN: {
return nfc(requiredInput, cryptoInput); return createNfcOperationPendingIntent(requiredInput, cryptoInput);
} }
case PASSPHRASE: { case PASSPHRASE: {
return passphrase(requiredInput, cryptoInput); return createPassphrasePendingIntent(requiredInput, cryptoInput);
} }
default: default:
@@ -67,84 +67,82 @@ public class ApiPendingIntentFactory {
} }
} }
private PendingIntent nfc(RequiredInputParcel requiredInput, CryptoInputParcel cryptoInput) { private PendingIntent createNfcOperationPendingIntent(RequiredInputParcel requiredInput, CryptoInputParcel cryptoInput) {
Intent intent = new Intent(mContext, RemoteSecurityTokenOperationActivity.class); Intent intent = new Intent(mContext, RemoteSecurityTokenOperationActivity.class);
// pass params through to activity that it can be returned again later to repeat pgp operation // pass params through to activity that it can be returned again later to repeat pgp operation
intent.putExtra(RemoteSecurityTokenOperationActivity.EXTRA_REQUIRED_INPUT, requiredInput); intent.putExtra(RemoteSecurityTokenOperationActivity.EXTRA_REQUIRED_INPUT, requiredInput);
intent.putExtra(RemoteSecurityTokenOperationActivity.EXTRA_CRYPTO_INPUT, cryptoInput); intent.putExtra(RemoteSecurityTokenOperationActivity.EXTRA_CRYPTO_INPUT, cryptoInput);
return build(intent); return createInternal(intent);
} }
private PendingIntent passphrase(RequiredInputParcel requiredInput, CryptoInputParcel cryptoInput) { private PendingIntent createPassphrasePendingIntent(RequiredInputParcel requiredInput, CryptoInputParcel cryptoInput) {
Intent intent = new Intent(mContext, RemotePassphraseDialogActivity.class); Intent intent = new Intent(mContext, RemotePassphraseDialogActivity.class);
// pass params through to activity that it can be returned again later to repeat pgp operation // pass params through to activity that it can be returned again later to repeat pgp operation
intent.putExtra(RemotePassphraseDialogActivity.EXTRA_REQUIRED_INPUT, requiredInput); intent.putExtra(RemotePassphraseDialogActivity.EXTRA_REQUIRED_INPUT, requiredInput);
intent.putExtra(RemotePassphraseDialogActivity.EXTRA_CRYPTO_INPUT, cryptoInput); intent.putExtra(RemotePassphraseDialogActivity.EXTRA_CRYPTO_INPUT, cryptoInput);
return build(intent); return createInternal(intent);
} }
PendingIntent selectPublicKey(long[] keyIdsArray, ArrayList<String> missingEmails, PendingIntent createSelectPublicKeyPendingIntent(long[] keyIdsArray, ArrayList<String> missingEmails,
ArrayList<String> duplicateEmails, boolean noUserIdsCheck) { ArrayList<String> duplicateEmails, boolean noUserIdsCheck) {
Intent intent = new Intent(mContext, RemoteSelectPubKeyActivity.class); Intent intent = new Intent(mContext, RemoteSelectPubKeyActivity.class);
intent.putExtra(RemoteSelectPubKeyActivity.EXTRA_SELECTED_MASTER_KEY_IDS, keyIdsArray); intent.putExtra(RemoteSelectPubKeyActivity.EXTRA_SELECTED_MASTER_KEY_IDS, keyIdsArray);
intent.putExtra(RemoteSelectPubKeyActivity.EXTRA_NO_USER_IDS_CHECK, noUserIdsCheck); intent.putExtra(RemoteSelectPubKeyActivity.EXTRA_NO_USER_IDS_CHECK, noUserIdsCheck);
intent.putExtra(RemoteSelectPubKeyActivity.EXTRA_MISSING_EMAILS, missingEmails); intent.putExtra(RemoteSelectPubKeyActivity.EXTRA_MISSING_EMAILS, missingEmails);
intent.putExtra(RemoteSelectPubKeyActivity.EXTRA_DUPLICATE_EMAILS, duplicateEmails); intent.putExtra(RemoteSelectPubKeyActivity.EXTRA_DUPLICATE_EMAILS, duplicateEmails);
return build(intent); return createInternal(intent);
} }
PendingIntent importFromKeyserver(long masterKeyId) { PendingIntent createImportFromKeyserverPendingIntent(long masterKeyId) {
Intent intent = new Intent(mContext, RemoteImportKeysActivity.class); Intent intent = new Intent(mContext, RemoteImportKeysActivity.class);
intent.setAction(RemoteImportKeysActivity.ACTION_IMPORT_KEY_FROM_KEYSERVER_AND_RETURN_RESULT); intent.setAction(RemoteImportKeysActivity.ACTION_IMPORT_KEY_FROM_KEYSERVER_AND_RETURN_RESULT);
intent.putExtra(RemoteImportKeysActivity.EXTRA_KEY_ID, masterKeyId); intent.putExtra(RemoteImportKeysActivity.EXTRA_KEY_ID, masterKeyId);
return build(intent); return createInternal(intent);
} }
PendingIntent selectAllowedKeys(String packageName) { PendingIntent createSelectAllowedKeysPendingIntent(String packageName) {
Intent intent = new Intent(mContext, SelectAllowedKeysActivity.class); Intent intent = new Intent(mContext, SelectAllowedKeysActivity.class);
intent.setData(KeychainContract.ApiApps.buildByPackageNameUri(packageName)); intent.setData(KeychainContract.ApiApps.buildByPackageNameUri(packageName));
return build(intent); return createInternal(intent);
} }
PendingIntent showKey(long masterKeyId) { PendingIntent createShowKeyPendingIntent(long masterKeyId) {
Intent intent = new Intent(mContext, ViewKeyActivity.class); Intent intent = new Intent(mContext, ViewKeyActivity.class);
intent.setData(KeychainContract.KeyRings.buildGenericKeyRingUri(masterKeyId)); intent.setData(KeychainContract.KeyRings.buildGenericKeyRingUri(masterKeyId));
return build(intent); return createInternal(intent);
} }
PendingIntent selectSignKeyId(String packageName, String preferredUserId) { PendingIntent createSelectSignKeyIdPendingIntent(String packageName, String preferredUserId) {
Intent intent = new Intent(mContext, SelectSignKeyIdActivity.class); Intent intent = new Intent(mContext, SelectSignKeyIdActivity.class);
intent.setData(KeychainContract.ApiApps.buildByPackageNameUri(packageName)); intent.setData(KeychainContract.ApiApps.buildByPackageNameUri(packageName));
intent.putExtra(SelectSignKeyIdActivity.EXTRA_USER_ID, preferredUserId); intent.putExtra(SelectSignKeyIdActivity.EXTRA_USER_ID, preferredUserId);
return build(intent); return createInternal(intent);
} }
/** @Deprecated
* @deprecated PendingIntent createAccountCreationPendingIntent(String packageName, String accountName) {
*/
PendingIntent createAccount(String packageName, String accountName) {
Intent intent = new Intent(mContext, RemoteCreateAccountActivity.class); Intent intent = new Intent(mContext, RemoteCreateAccountActivity.class);
intent.putExtra(RemoteCreateAccountActivity.EXTRA_PACKAGE_NAME, packageName); intent.putExtra(RemoteCreateAccountActivity.EXTRA_PACKAGE_NAME, packageName);
intent.putExtra(RemoteCreateAccountActivity.EXTRA_ACC_NAME, accountName); intent.putExtra(RemoteCreateAccountActivity.EXTRA_ACC_NAME, accountName);
return build(intent); return createInternal(intent);
} }
PendingIntent error(String errorMessage) { PendingIntent createErrorPendingIntent(String errorMessage) {
Intent intent = new Intent(mContext, RemoteErrorActivity.class); Intent intent = new Intent(mContext, RemoteErrorActivity.class);
intent.putExtra(RemoteErrorActivity.EXTRA_ERROR_MESSAGE, errorMessage); intent.putExtra(RemoteErrorActivity.EXTRA_ERROR_MESSAGE, errorMessage);
return build(intent); return createInternal(intent);
} }
private PendingIntent build(Intent intent) { private PendingIntent createInternal(Intent intent) {
// re-attach "data" for pass through. It will be used later to repeat pgp operation // re-attach "data" for pass through. It will be used later to repeat pgp operation
intent.putExtra(RemoteSecurityTokenOperationActivity.EXTRA_DATA, mPendingIntentData); intent.putExtra(RemoteSecurityTokenOperationActivity.EXTRA_DATA, mPendingIntentData);
@@ -160,7 +158,7 @@ public class ApiPendingIntentFactory {
} }
} }
PendingIntent register(String packageName, byte[] packageCertificate) { PendingIntent createRegisterPendingIntent(String packageName, byte[] packageCertificate) {
Intent intent = new Intent(mContext, RemoteRegisterActivity.class); Intent intent = new Intent(mContext, RemoteRegisterActivity.class);
intent.putExtra(RemoteRegisterActivity.EXTRA_PACKAGE_NAME, packageName); intent.putExtra(RemoteRegisterActivity.EXTRA_PACKAGE_NAME, packageName);
intent.putExtra(RemoteRegisterActivity.EXTRA_PACKAGE_SIGNATURE, packageCertificate); intent.putExtra(RemoteRegisterActivity.EXTRA_PACKAGE_SIGNATURE, packageCertificate);

13
OpenKeychain/src/main/java/org/sufficientlysecure/keychain/remote/ApiPermissionHelper.java
View File

@@ -95,7 +95,7 @@ public class ApiPermissionHelper {
} }
Log.e(Constants.TAG, "Not allowed to use service! return PendingIntent for registration!"); Log.e(Constants.TAG, "Not allowed to use service! return PendingIntent for registration!");
PendingIntent pi = piFactory.register(packageName, packageCertificate); PendingIntent pi = piFactory.createRegisterPendingIntent(packageName, packageCertificate);
// return PendingIntent to be executed by client // return PendingIntent to be executed by client
Intent result = new Intent(); Intent result = new Intent();
@@ -107,7 +107,7 @@ public class ApiPermissionHelper {
} catch (WrongPackageCertificateException e) { } catch (WrongPackageCertificateException e) {
Log.e(Constants.TAG, "wrong signature!", e); Log.e(Constants.TAG, "wrong signature!", e);
PendingIntent pi = piFactory.error(mContext.getString(R.string.api_error_wrong_signature)); PendingIntent pi = piFactory.createErrorPendingIntent(mContext.getString(R.string.api_error_wrong_signature));
// return PendingIntent to be executed by client // return PendingIntent to be executed by client
Intent result = new Intent(); Intent result = new Intent();
@@ -158,10 +158,9 @@ public class ApiPermissionHelper {
} }
/** /**
* DEPRECATED API
* <p/>
* Retrieves AccountSettings from database for the application calling this remote service * Retrieves AccountSettings from database for the application calling this remote service
*/ */
@Deprecated
protected AccountSettings getAccSettings(String accountName) { protected AccountSettings getAccSettings(String accountName) {
String currentPkg = getCurrentCallingPackage(); String currentPkg = getCurrentCallingPackage();
Log.d(Constants.TAG, "getAccSettings accountName: " + accountName); Log.d(Constants.TAG, "getAccSettings accountName: " + accountName);
@@ -171,16 +170,14 @@ public class ApiPermissionHelper {
return mProviderHelper.getApiAccountSettings(uri); // can be null! return mProviderHelper.getApiAccountSettings(uri); // can be null!
} }
/** @Deprecated
* @deprecated
*/
protected Intent getCreateAccountIntent(Intent data, String accountName) { protected Intent getCreateAccountIntent(Intent data, String accountName) {
String packageName = getCurrentCallingPackage(); String packageName = getCurrentCallingPackage();
Log.d(Constants.TAG, "getCreateAccountIntent accountName: " + accountName); Log.d(Constants.TAG, "getCreateAccountIntent accountName: " + accountName);
ApiPendingIntentFactory piFactory = new ApiPendingIntentFactory(mContext, data); ApiPendingIntentFactory piFactory = new ApiPendingIntentFactory(mContext, data);
PendingIntent pi = piFactory.createAccount(packageName, accountName); PendingIntent pi = piFactory.createAccountCreationPendingIntent(packageName, accountName);
// return PendingIntent to be executed by client // return PendingIntent to be executed by client
Intent result = new Intent(); Intent result = new Intent();

18
OpenKeychain/src/main/java/org/sufficientlysecure/keychain/remote/OpenPgpService.java
View File

@@ -144,7 +144,7 @@ public class OpenPgpService extends Service {
// allow the user to verify pub key selection // allow the user to verify pub key selection
ApiPendingIntentFactory piFactory = new ApiPendingIntentFactory(getBaseContext(), data); ApiPendingIntentFactory piFactory = new ApiPendingIntentFactory(getBaseContext(), data);
PendingIntent pi = piFactory.selectPublicKey(keyIdsArray, missingEmails, PendingIntent pi = piFactory.createSelectPublicKeyPendingIntent(keyIdsArray, missingEmails,
duplicateEmails, noUserIdsCheck); duplicateEmails, noUserIdsCheck);
// return PendingIntent to be executed by client // return PendingIntent to be executed by client
@@ -459,7 +459,7 @@ public class OpenPgpService extends Service {
case OpenPgpSignatureResult.RESULT_KEY_MISSING: { case OpenPgpSignatureResult.RESULT_KEY_MISSING: {
// If signature key is missing we return a PendingIntent to retrieve the key // If signature key is missing we return a PendingIntent to retrieve the key
result.putExtra(OpenPgpApi.RESULT_INTENT, result.putExtra(OpenPgpApi.RESULT_INTENT,
piFactory.importFromKeyserver(signatureResult.getKeyId())); piFactory.createImportFromKeyserverPendingIntent(signatureResult.getKeyId()));
break; break;
} }
case OpenPgpSignatureResult.RESULT_VALID_CONFIRMED: case OpenPgpSignatureResult.RESULT_VALID_CONFIRMED:
@@ -468,7 +468,7 @@ public class OpenPgpService extends Service {
case OpenPgpSignatureResult.RESULT_INVALID_KEY_EXPIRED: case OpenPgpSignatureResult.RESULT_INVALID_KEY_EXPIRED:
case OpenPgpSignatureResult.RESULT_INVALID_INSECURE: { case OpenPgpSignatureResult.RESULT_INVALID_INSECURE: {
// If signature key is known, return PendingIntent to show key // If signature key is known, return PendingIntent to show key
result.putExtra(OpenPgpApi.RESULT_INTENT, piFactory.showKey(signatureResult.getKeyId())); result.putExtra(OpenPgpApi.RESULT_INTENT, piFactory.createShowKeyPendingIntent(signatureResult.getKeyId()));
break; break;
} }
default: default:
@@ -542,7 +542,7 @@ public class OpenPgpService extends Service {
// allow user to select allowed keys // allow user to select allowed keys
Intent result = new Intent(); Intent result = new Intent();
String packageName = mApiPermissionHelper.getCurrentCallingPackage(); String packageName = mApiPermissionHelper.getCurrentCallingPackage();
result.putExtra(OpenPgpApi.RESULT_INTENT, piFactory.selectAllowedKeys(packageName)); result.putExtra(OpenPgpApi.RESULT_INTENT, piFactory.createSelectAllowedKeysPendingIntent(packageName));
result.putExtra(OpenPgpApi.RESULT_CODE, OpenPgpApi.RESULT_CODE_USER_INTERACTION_REQUIRED); result.putExtra(OpenPgpApi.RESULT_CODE, OpenPgpApi.RESULT_CODE_USER_INTERACTION_REQUIRED);
return result; return result;
} }
@@ -597,14 +597,14 @@ public class OpenPgpService extends Service {
} }
// also return PendingIntent that opens the key view activity // also return PendingIntent that opens the key view activity
result.putExtra(OpenPgpApi.RESULT_INTENT, piFactory.showKey(masterKeyId)); result.putExtra(OpenPgpApi.RESULT_INTENT, piFactory.createShowKeyPendingIntent(masterKeyId));
return result; return result;
} catch (ProviderHelper.NotFoundException e) { } catch (ProviderHelper.NotFoundException e) {
// If keys are not in db we return an additional PendingIntent // If keys are not in db we return an additional PendingIntent
// to retrieve the missing key // to retrieve the missing key
Intent result = new Intent(); Intent result = new Intent();
result.putExtra(OpenPgpApi.RESULT_INTENT, piFactory.importFromKeyserver(masterKeyId)); result.putExtra(OpenPgpApi.RESULT_INTENT, piFactory.createImportFromKeyserverPendingIntent(masterKeyId));
result.putExtra(OpenPgpApi.RESULT_CODE, OpenPgpApi.RESULT_CODE_USER_INTERACTION_REQUIRED); result.putExtra(OpenPgpApi.RESULT_CODE, OpenPgpApi.RESULT_CODE_USER_INTERACTION_REQUIRED);
return result; return result;
} }
@@ -634,7 +634,7 @@ public class OpenPgpService extends Service {
String preferredUserId = data.getStringExtra(OpenPgpApi.EXTRA_USER_ID); String preferredUserId = data.getStringExtra(OpenPgpApi.EXTRA_USER_ID);
ApiPendingIntentFactory piFactory = new ApiPendingIntentFactory(getBaseContext(), data); ApiPendingIntentFactory piFactory = new ApiPendingIntentFactory(getBaseContext(), data);
PendingIntent pi = piFactory.selectSignKeyId(currentPkg, preferredUserId); PendingIntent pi = piFactory.createSelectSignKeyIdPendingIntent(currentPkg, preferredUserId);
// return PendingIntent to be executed by client // return PendingIntent to be executed by client
Intent result = new Intent(); Intent result = new Intent();
@@ -697,7 +697,7 @@ public class OpenPgpService extends Service {
* - has supported API version * - has supported API version
* - is allowed to call the service (access has been granted) * - is allowed to call the service (access has been granted)
* *
* @return null if everything is okay, or a Bundle with an error/PendingIntent * @return null if everything is okay, or a Bundle with an createErrorPendingIntent/PendingIntent
*/ */
private Intent checkRequirements(Intent data) { private Intent checkRequirements(Intent data) {
// params Bundle is required! // params Bundle is required!
@@ -760,7 +760,7 @@ public class OpenPgpService extends Service {
try { try {
return executeInternalWithStreams(data, inputStream, outputStream); return executeInternalWithStreams(data, inputStream, outputStream);
} finally { } finally {
// always close input and output file descriptors even in error cases // always close input and output file descriptors even in createErrorPendingIntent cases
if (inputStream != null) { if (inputStream != null) {
try { try {
inputStream.close(); inputStream.close();

4
OpenKeychain/src/main/java/org/sufficientlysecure/keychain/ui/ImportKeysActivity.java
View File

@@ -400,6 +400,10 @@ public class ImportKeysActivity extends BaseActivity
super.onActivityResult(requestCode, resultCode, data); super.onActivityResult(requestCode, resultCode, data);
} }
/**
* Defines how the result of this activity is returned.
* Is overwritten in RemoteImportKeysActivity
*/
protected void handleResult(ImportKeyResult result) { protected void handleResult(ImportKeyResult result) {
String intentAction = getIntent().getAction(); String intentAction = getIntent().getAction();

4
OpenKeychain/src/main/java/org/sufficientlysecure/keychain/ui/PassphraseDialogActivity.java
View File

@@ -514,6 +514,10 @@ public class PassphraseDialogActivity extends FragmentActivity {
} }
/**
* Defines how the result of this activity is returned.
* Is overwritten in RemotePassphraseDialogActivity
*/
protected void handleResult(CryptoInputParcel inputParcel) { protected void handleResult(CryptoInputParcel inputParcel) {
// also return passphrase back to activity // also return passphrase back to activity
Intent returnIntent = new Intent(); Intent returnIntent = new Intent();

6
OpenKeychain/src/main/java/org/sufficientlysecure/keychain/ui/SecurityTokenOperationActivity.java
View File

@@ -267,7 +267,7 @@ public class SecurityTokenOperationActivity extends BaseSecurityTokenNfcActivity
} }
@Override @Override
protected void onNfcPostExecute() { protected final void onNfcPostExecute() {
handleResult(mInputParcel); handleResult(mInputParcel);
// show finish // show finish
@@ -299,6 +299,10 @@ public class SecurityTokenOperationActivity extends BaseSecurityTokenNfcActivity
}.execute(); }.execute();
} }
/**
* Defines how the result of this activity is returned.
* Is overwritten in RemoteSecurityTokenOperationActivity
*/
protected void handleResult(CryptoInputParcel inputParcel) { protected void handleResult(CryptoInputParcel inputParcel) {
Intent result = new Intent(); Intent result = new Intent();
// send back the CryptoInputParcel we received // send back the CryptoInputParcel we received