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

Merge pull request #2305 from open-keychain/autocrypt-setup-message-api

Browse Source 
Add autocrypt key transfer api method
This commit is contained in:
Dominik Schürmann
2018-05-03 15:44:39 +02:00
committed by GitHub
parent 5db00cd924 8edd084212
commit 32005b94d9
9 changed files with 288 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -929,6 +929,10 @@
android:configChanges="keyboardHidden|keyboard"
android:label="@string/title_backup" />
<activity
android:name=".remote.ui.RemoteDisplayTransferCodeActivity"
android:theme="@style/Theme.Keychain.Transparent"/>
<!-- Usb interceptor activity -->
<activity
android:name=".ui.UsbEventReceiverActivity"

29
OpenKeychain/src/main/java/org/sufficientlysecure/keychain/operations/BackupOperation.java
View File

@@ -26,8 +26,10 @@ import java.io.OutputStream;
import java.text.SimpleDateFormat;
import java.util.Collections;
import java.util.Date;
import java.util.List;
import java.util.Locale;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.regex.Pattern;
import android.content.Context;
import android.database.Cursor;
@@ -84,6 +86,9 @@ public class BackupOperation extends BaseOperation<BackupKeyringParcel> {
private static final int INDEX_MASTER_KEY_ID = 0;
private static final int INDEX_HAS_ANY_SECRET = 1;
// this is a very simple matcher, we only need basic sanitization
private static final Pattern HEADER_PATTERN = Pattern.compile("[a-zA-Z0-9_-]+: [^\\n]+");
public BackupOperation(Context context, KeyRepository keyRepository, Progressable
progressable) {
super(context, keyRepository, progressable);
@@ -130,7 +135,7 @@ public class BackupOperation extends BaseOperation<BackupKeyringParcel> {
CountingOutputStream outStream = new CountingOutputStream(new BufferedOutputStream(plainOut));
boolean backupSuccess = exportKeysToStream(log, backupInput.getMasterKeyIds(),
backupInput.getExportSecret(), backupInput.getExportPublic(), outStream);
backupInput.getExportSecret(), backupInput.getExportPublic(), outStream, backupInput.getExtraHeaders());
if (!backupSuccess) {
// if there was an error, it will be in the log so we just have to return
@@ -215,7 +220,7 @@ public class BackupOperation extends BaseOperation<BackupKeyringParcel> {
}
boolean exportKeysToStream(OperationLog log, long[] masterKeyIds, boolean exportSecret, boolean exportPublic,
OutputStream outStream) {
OutputStream outStream, List<String> extraSecretKeyHeaders) {
// noinspection unused TODO use these in a log entry
int okSecret = 0, okPublic = 0;
@@ -253,9 +258,10 @@ public class BackupOperation extends BaseOperation<BackupKeyringParcel> {
boolean hasSecret = cursor.getInt(INDEX_HAS_ANY_SECRET) > 0;
if (exportSecret && hasSecret) {
log.add(LogType.MSG_BACKUP_SECRET, 2, KeyFormattingUtils.beautifyKeyId(masterKeyId));
if (writeSecretKeyToStream(masterKeyId, log, outStream)) {
if (writeSecretKeyToStream(masterKeyId, log, outStream, extraSecretKeyHeaders)) {
okSecret += 1;
}
extraSecretKeyHeaders = null;
}
}
@@ -300,12 +306,17 @@ public class BackupOperation extends BaseOperation<BackupKeyringParcel> {
return true;
}
private boolean writeSecretKeyToStream(long masterKeyId, OperationLog log, OutputStream outStream)
private boolean writeSecretKeyToStream(long masterKeyId, OperationLog log, OutputStream outStream,
List<String> extraSecretKeyHeaders)
throws IOException {
ArmoredOutputStream arOutStream = null;
try {
arOutStream = new ArmoredOutputStream(outStream);
if (extraSecretKeyHeaders != null) {
addExtraHeadersToStream(arOutStream, extraSecretKeyHeaders);
}
byte[] data = mKeyRepository.loadSecretKeyRingData(masterKeyId);
UncachedKeyRing uncachedKeyRing = UncachedKeyRing.decodeFromData(data);
CanonicalizedSecretKeyRing ring = (CanonicalizedSecretKeyRing) uncachedKeyRing.canonicalize(log, 2, true);
@@ -320,6 +331,16 @@ public class BackupOperation extends BaseOperation<BackupKeyringParcel> {
return true;
}
private void addExtraHeadersToStream(ArmoredOutputStream arOutStream, List<String> headers) {
for (String header : headers) {
if (!HEADER_PATTERN.matcher(header).matches()) {
throw new IllegalArgumentException("bad header format");
}
int sep = header.indexOf(':');
arOutStream.setHeader(header.substring(0, sep), header.substring(sep + 2));
}
}
private Cursor queryForKeys(long[] masterKeyIds) {
String selection = null, selectionArgs[] = null;

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

@@ -27,6 +27,7 @@ import android.os.Build;
import org.sufficientlysecure.keychain.pgp.DecryptVerifySecurityProblem;
import org.sufficientlysecure.keychain.provider.KeychainContract;
import org.sufficientlysecure.keychain.remote.ui.RemoteBackupActivity;
import org.sufficientlysecure.keychain.remote.ui.RemoteDisplayTransferCodeActivity;
import org.sufficientlysecure.keychain.remote.ui.RemoteErrorActivity;
import org.sufficientlysecure.keychain.remote.ui.RemoteImportKeysActivity;
import org.sufficientlysecure.keychain.remote.ui.RemotePassphraseDialogActivity;
@@ -42,6 +43,7 @@ import org.sufficientlysecure.keychain.remote.ui.dialog.RemoteSelectIdKeyActivit
import org.sufficientlysecure.keychain.service.input.CryptoInputParcel;
import org.sufficientlysecure.keychain.service.input.RequiredInputParcel;
import org.sufficientlysecure.keychain.ui.keyview.ViewKeyActivity;
import org.sufficientlysecure.keychain.util.Passphrase;
public class ApiPendingIntentFactory {
@@ -119,7 +121,7 @@ public class ApiPendingIntentFactory {
return createInternal(data, intent);
}
PendingIntent createRequestKeyPermissionPendingIntent(Intent data, String packageName, long[] masterKeyIds) {
PendingIntent createRequestKeyPermissionPendingIntent(Intent data, String packageName, long... masterKeyIds) {
Intent intent = new Intent(mContext, RequestKeyPermissionActivity.class);
intent.putExtra(RequestKeyPermissionActivity.EXTRA_PACKAGE_NAME, packageName);
intent.putExtra(RequestKeyPermissionActivity.EXTRA_REQUESTED_KEY_IDS, masterKeyIds);
@@ -193,6 +195,13 @@ public class ApiPendingIntentFactory {
}
}
public PendingIntent createDisplayTransferCodePendingIntent(Passphrase autocryptTransferCode) {
Intent intent = new Intent(mContext, RemoteDisplayTransferCodeActivity.class);
intent.putExtra(RemoteDisplayTransferCodeActivity.EXTRA_TRANSFER_CODE, autocryptTransferCode);
return createInternal(null, intent);
}
private PendingIntent createInternal(Intent data, Intent intent) {
// re-attach "data" for pass through. It will be used later to repeat pgp operation
if (data != null) {

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

@@ -80,6 +80,7 @@ import org.sufficientlysecure.keychain.service.BackupKeyringParcel;
import org.sufficientlysecure.keychain.service.input.CryptoInputParcel;
import org.sufficientlysecure.keychain.service.input.RequiredInputParcel;
import org.sufficientlysecure.keychain.util.InputData;
import org.sufficientlysecure.keychain.util.Numeric9x4PassphraseUtil;
import org.sufficientlysecure.keychain.util.Passphrase;
import timber.log.Timber;
@@ -811,6 +812,51 @@ public class OpenPgpService extends Service {
}
}
private Intent autocryptKeyTransferImpl(Intent data, OutputStream outputStream) {
try {
long[] masterKeyIds = data.getLongArrayExtra(OpenPgpApi.EXTRA_KEY_IDS);
HashSet<Long> allowedKeyIds = getAllowedKeyIds();
for (long masterKeyId : masterKeyIds) {
if (!allowedKeyIds.contains(masterKeyId)) {
Intent result = new Intent();
String packageName = mApiPermissionHelper.getCurrentCallingPackage();
result.putExtra(OpenPgpApi.RESULT_INTENT,
mApiPendingIntentFactory.createRequestKeyPermissionPendingIntent(
data, packageName, masterKeyId));
result.putExtra(OpenPgpApi.RESULT_CODE, OpenPgpApi.RESULT_CODE_USER_INTERACTION_REQUIRED);
return result;
}
}
List<String> headerLines = data.getStringArrayListExtra(OpenPgpApi.EXTRA_CUSTOM_HEADERS);
Passphrase autocryptTransferCode = Numeric9x4PassphraseUtil.generateNumeric9x4Passphrase();
CryptoInputParcel inputParcel = CryptoInputParcel.createCryptoInputParcel(autocryptTransferCode);
BackupKeyringParcel input = BackupKeyringParcel.createExportAutocryptSetupMessage(masterKeyIds, headerLines);
BackupOperation op = new BackupOperation(this, mKeyRepository, null);
ExportResult pgpResult = op.execute(input, inputParcel, outputStream);
PendingIntent displayTransferCodePendingIntent =
mApiPendingIntentFactory.createDisplayTransferCodePendingIntent(autocryptTransferCode);
if (pgpResult.success()) {
Intent result = new Intent();
result.putExtra(OpenPgpApi.RESULT_CODE, OpenPgpApi.RESULT_CODE_SUCCESS);
result.putExtra(OpenPgpApi.RESULT_INTENT, displayTransferCodePendingIntent);
return result;
} else {
// should not happen normally...
String errorMsg = getString(pgpResult.getLog().getLast().mType.getMsgId());
return createErrorResultIntent(OpenPgpError.GENERIC_ERROR, errorMsg);
}
} catch (Exception e) {
Timber.d(e);
return createErrorResultIntent(OpenPgpError.GENERIC_ERROR, e.getMessage());
}
}
private Intent updateAutocryptPeerImpl(Intent data) {
try {
AutocryptPeerDataAccessObject autocryptPeerDao = new AutocryptPeerDataAccessObject(getBaseContext(),
@@ -1030,6 +1076,9 @@ public class OpenPgpService extends Service {
case OpenPgpApi.ACTION_BACKUP: {
return backupImpl(data, outputStream);
}
case OpenPgpApi.ACTION_AUTOCRYPT_KEY_TRANSFER: {
return autocryptKeyTransferImpl(data, outputStream);
}
case OpenPgpApi.ACTION_UPDATE_AUTOCRYPT_PEER: {
return updateAutocryptPeerImpl(data);
}

114
OpenKeychain/src/main/java/org/sufficientlysecure/keychain/remote/ui/RemoteDisplayTransferCodeActivity.java Normal file
View File

@@ -0,0 +1,114 @@
/*
* 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.remote.ui;
import java.nio.CharBuffer;
import android.annotation.SuppressLint;
import android.app.Activity;
import android.app.Dialog;
import android.content.DialogInterface;
import android.os.Bundle;
import android.support.annotation.NonNull;
import android.support.v4.app.DialogFragment;
import android.support.v4.app.FragmentActivity;
import android.view.ContextThemeWrapper;
import android.view.LayoutInflater;
import android.view.View;
import android.widget.TextView;
import org.sufficientlysecure.keychain.R;
import org.sufficientlysecure.keychain.ui.dialog.CustomAlertDialogBuilder;
import org.sufficientlysecure.keychain.ui.util.ThemeChanger;
import org.sufficientlysecure.keychain.ui.widget.PrefixedEditText;
import org.sufficientlysecure.keychain.util.Numeric9x4PassphraseUtil;
import org.sufficientlysecure.keychain.util.Passphrase;
public class RemoteDisplayTransferCodeActivity extends FragmentActivity {
public static final String EXTRA_TRANSFER_CODE = "transfer_code";
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
if (savedInstanceState == null) {
DisplayTransferCodeDialogFragment frag = new DisplayTransferCodeDialogFragment();
frag.setArguments(getIntent().getExtras());
frag.show(getSupportFragmentManager(), "displayTransferCode");
}
}
public static class DisplayTransferCodeDialogFragment extends DialogFragment {
@NonNull
@Override
public Dialog onCreateDialog(Bundle savedInstanceState) {
final Activity activity = getActivity();
Passphrase transferCode = getArguments().getParcelable(EXTRA_TRANSFER_CODE);
ContextThemeWrapper theme = ThemeChanger.getDialogThemeWrapper(activity);
CustomAlertDialogBuilder alert = new CustomAlertDialogBuilder(theme);
@SuppressLint("InflateParams")
View view = LayoutInflater.from(theme).inflate(R.layout.api_display_transfer_code, null, false);
alert.setView(view);
alert.setPositiveButton(R.string.button_got_it, (dialog, which) -> dismiss());
TextView[] transferCodeTextViews = new TextView[9];
transferCodeTextViews[0] = view.findViewById(R.id.transfer_code_block_1);
transferCodeTextViews[1] = view.findViewById(R.id.transfer_code_block_2);
transferCodeTextViews[2] = view.findViewById(R.id.transfer_code_block_3);
transferCodeTextViews[3] = view.findViewById(R.id.transfer_code_block_4);
transferCodeTextViews[4] = view.findViewById(R.id.transfer_code_block_5);
transferCodeTextViews[5] = view.findViewById(R.id.transfer_code_block_6);
transferCodeTextViews[6] = view.findViewById(R.id.transfer_code_block_7);
transferCodeTextViews[7] = view.findViewById(R.id.transfer_code_block_8);
transferCodeTextViews[8] = view.findViewById(R.id.transfer_code_block_9);
setTransferCode(transferCodeTextViews, transferCode);
return alert.create();
}
private void setTransferCode(TextView[] view, Passphrase transferCode) {
CharBuffer transferCodeChars = CharBuffer.wrap(transferCode.getCharArray()).asReadOnlyBuffer();
if (!Numeric9x4PassphraseUtil.isNumeric9x4Passphrase(transferCodeChars)) {
throw new IllegalStateException("Illegal passphrase format!");
}
PrefixedEditText prefixedEditText = (PrefixedEditText) view[0];
prefixedEditText.setHint("34");
prefixedEditText.setPrefix(transferCodeChars.subSequence(0, 2));
prefixedEditText.setText(transferCodeChars.subSequence(2, 4));
for (int i = 1; i < 9; i++) {
view[i].setText(transferCodeChars.subSequence(i*5, i*5+4));
}
}
@Override
public void onDismiss(DialogInterface dialog) {
super.onDismiss(dialog);
getActivity().finish();
}
}
}

17
OpenKeychain/src/main/java/org/sufficientlysecure/keychain/service/BackupKeyringParcel.java
View File

@@ -18,6 +18,8 @@
package org.sufficientlysecure.keychain.service;
import java.util.List;
import android.net.Uri;
import android.os.Parcelable;
import android.support.annotation.Nullable;
@@ -36,15 +38,24 @@ public abstract class BackupKeyringParcel implements Parcelable {
public abstract boolean getEnableAsciiArmorOutput();
@Nullable
public abstract Uri getOutputUri();
@Nullable
public abstract List<String> getExtraHeaders();
public static BackupKeyringParcel create(long[] masterKeyIds, boolean exportSecret,
boolean isEncrypted, boolean enableAsciiArmorOutput, Uri outputUri) {
return new AutoValue_BackupKeyringParcel(
masterKeyIds, exportSecret, true, isEncrypted, enableAsciiArmorOutput, outputUri);
masterKeyIds, exportSecret, true, isEncrypted, enableAsciiArmorOutput, outputUri, null);
}
public static BackupKeyringParcel createExportAutocryptSetupMessage(long[] masterKeyIds) {
public static BackupKeyringParcel create(long[] masterKeyIds, boolean exportSecret,
boolean isEncrypted, boolean enableAsciiArmorOutput, Uri outputUri, List<String> extraHeaders) {
return new AutoValue_BackupKeyringParcel(
masterKeyIds, true, false, true, true, null);
masterKeyIds, exportSecret, true, isEncrypted, enableAsciiArmorOutput, outputUri, extraHeaders);
}
public static BackupKeyringParcel createExportAutocryptSetupMessage(long[] masterKeyIds,
List<String> extraHeaders) {
return new AutoValue_BackupKeyringParcel(
masterKeyIds, true, false, true, true, null, extraHeaders);
}
}

52
OpenKeychain/src/main/res/layout/api_display_transfer_code.xml Normal file
View File

@@ -0,0 +1,52 @@
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:orientation="vertical"
android:paddingBottom="16dp"
tools:layout_marginTop="24dp"
>
<LinearLayout
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:background="?attr/colorPrimary"
android:elevation="4dp"
android:padding="16dp"
android:gravity="center_vertical"
tools:targetApi="lollipop">
<ImageView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginLeft="8dp"
android:layout_marginStart="8dp"
android:src="@mipmap/ic_launcher"/>
<TextView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginLeft="16dp"
android:layout_marginStart="16dp"
android:maxLines="1"
android:ellipsize="end"
android:text="@string/app_name"
style="?android:textAppearanceLarge"/>
</LinearLayout>
<TextView
android:id="@+id/text_title_select_key"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginLeft="16dp"
android:layout_marginStart="16dp"
android:layout_marginTop="36dp"
android:layout_marginBottom="22dp"
android:textAppearance="?android:attr/textAppearanceMedium"
android:text="Your transfer code:" />
<include layout="@layout/transfer_code_display" />
</LinearLayout>

21
OpenKeychain/src/test/java/org/sufficientlysecure/keychain/operations/BackupOperationTest.java
View File

@@ -24,6 +24,7 @@ import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.io.PrintStream;
import java.security.Security;
import java.util.Arrays;
import java.util.Iterator;
import android.app.Application;
@@ -157,7 +158,7 @@ public class BackupOperationTest {
assertTrue("second keyring has local certification", checkForLocal(mStaticRing2));
ByteArrayOutputStream out = new ByteArrayOutputStream();
boolean result = op.exportKeysToStream(new OperationLog(), null, false, true, out);
boolean result = op.exportKeysToStream(new OperationLog(), null, false, true, out, null);
assertTrue("export must be a success", result);
@@ -194,7 +195,7 @@ public class BackupOperationTest {
}
out = new ByteArrayOutputStream();
result = op.exportKeysToStream(new OperationLog(), null, true, true, out);
result = op.exportKeysToStream(new OperationLog(), null, true, true, out, null);
assertTrue("export must be a success", result);
@@ -238,6 +239,22 @@ public class BackupOperationTest {
}
@Test
public void testExportWithExtraHeaders() throws Exception {
BackupOperation op = new BackupOperation(RuntimeEnvironment.application,
KeyWritableRepository.create(RuntimeEnvironment.application), null);
ByteArrayOutputStream out = new ByteArrayOutputStream();
boolean result = op.exportKeysToStream(
new OperationLog(), new long[] { mStaticRing1.getMasterKeyId() }, true, false,
out, Arrays.asList("header: value"));
assertTrue(result);
String resultData = new String(out.toByteArray());
assertTrue(resultData.startsWith("-----BEGIN PGP PRIVATE KEY BLOCK-----\nheader: value\n\n"));
}
@Test
public void testExportUnencrypted() throws Exception {
ContentResolver mockResolver = mock(ContentResolver.class);

2
extern/openpgp-api-lib vendored

Submodule extern/openpgp-api-lib updated: bfb355c5bf...c2ddaa76bb