value = response.getParcelableArrayList(E2eeContactKeys.KEY_CONTACT_KEYS,
E2eeSelfKey.class);
if (value == null) {
return new ArrayList<>();
}
return value;
}
/**
* Removes an end-to-end encryption self key entry given the deviceId and the inferred
* package name of the caller.
*
* @param deviceId an app-specified identifier for the device
* @param accountId an app-specified identifier for the account
* @return true if the entry was removed, false otherwise.
*/
@RequiresPermission(android.Manifest.permission.WRITE_CONTACTS)
public boolean removeE2eeSelfKey(@NonNull String deviceId,
@NonNull String accountId) {
Bundle extras = new Bundle();
extras.putString(E2eeContactKeys.DEVICE_ID, Objects.requireNonNull(deviceId));
extras.putString(E2eeContactKeys.ACCOUNT_ID, Objects.requireNonNull(accountId));
Bundle response = nullSafeCall(mContentResolver,
E2eeContactKeys.REMOVE_SELF_KEY_METHOD, extras);
return response != null && response.getBoolean(E2eeContactKeys.KEY_UPDATED_ROWS);
}
private Bundle nullSafeCall(@NonNull ContentResolver resolver, @NonNull String method,
@Nullable Bundle extras) {
try (ContentProviderClient client = resolver.acquireContentProviderClient(AUTHORITY_URI)) {
return client.call(method, null, extras);
} catch (RemoteException e) {
throw e.rethrowAsRuntimeException();
}
}
/**
* Possible values of verification state.
*
* @hide
*/
@IntDef(prefix = {"VERIFICATION_STATE_"}, value = {
VERIFICATION_STATE_UNVERIFIED,
VERIFICATION_STATE_VERIFICATION_FAILED,
VERIFICATION_STATE_VERIFIED
})
@Retention(RetentionPolicy.SOURCE)
public @interface VerificationState {
}
/**
* Unverified state of a contact end to end encrypted key.
*/
public static final int VERIFICATION_STATE_UNVERIFIED = 0;
/**
* Failed verification state of a contact end to end encrypted key.
*/
public static final int VERIFICATION_STATE_VERIFICATION_FAILED = 1;
/**
* Verified state of a contact end to end encrypted key.
*/
public static final int VERIFICATION_STATE_VERIFIED = 2;
/** @hide */
public static final class E2eeContactKeys {
private E2eeContactKeys() {
}
/**
*
* An opaque value that contains hints on how to find the contact if
* its row id changed as a result of a sync or aggregation.
*
*/
public static final String LOOKUP_KEY = "lookup";
/**
*
* An app-specified identifier for the device for which the end-to-end encryption
* contact key can be used.
*
*/
public static final String DEVICE_ID = "device_id";
/**
*
* An app-specified identifier for the account for which the end-to-end encryption
* contact key can be used.
* Usually a phone number.
*
*/
public static final String ACCOUNT_ID = "account_id";
/**
*
* The display name for the contact.
*
*/
public static final String DISPLAY_NAME = "display_name";
/**
*
* The phone number as the user entered it.
*
*/
public static final String PHONE_NUMBER = "number";
/**
*
* The email address.
*
*/
public static final String EMAIL_ADDRESS = "address";
/**
*
* Timestamp at which the key was updated.
*
*/
public static final String TIME_UPDATED = "time_updated";
/**
*
* The raw bytes for the key.
*
*/
public static final String KEY_VALUE = "key_value";
/**
*
* The package name of the package that created the key.
*
*/
public static final String OWNER_PACKAGE_NAME = "owner_package_name";
/**
*
* Describes the local verification state for the key, for instance QR-code based
* verification.
*
*/
public static final String LOCAL_VERIFICATION_STATE = "local_verification_state";
/**
*
* Describes the remote verification state for the key, for instance through a key
* transparency server.
*
*/
public static final String REMOTE_VERIFICATION_STATE = "remote_verification_state";
/**
* The method to invoke in order to add a new key for a contact.
*/
public static final String UPDATE_OR_INSERT_CONTACT_KEY_METHOD = "updateOrInsertContactKey";
/**
* The method to invoke in order to retrieve key for a single contact.
*/
public static final String GET_CONTACT_KEY_METHOD = "getContactKey";
/**
* The method to invoke in order to retrieve all end-to-end encryption contact keys.
*/
public static final String GET_ALL_CONTACT_KEYS_METHOD = "getAllContactKeys";
/**
* The method to invoke in order to retrieve end-to-end encryption contact keys that belong
* to the caller.
*/
public static final String GET_OWNER_CONTACT_KEYS_METHOD = "getOwnerContactKeys";
/**
* The method to invoke in order to update an end-to-end encryption contact key local
* verification state.
*/
public static final String UPDATE_CONTACT_KEY_LOCAL_VERIFICATION_STATE_METHOD =
"updateContactKeyLocalVerificationState";
/**
* The method to invoke in order to update an end-to-end encryption contact key remote
* verification state.
*/
public static final String UPDATE_CONTACT_KEY_REMOTE_VERIFICATION_STATE_METHOD =
"updateContactKeyRemoteVerificationState";
/**
* The method to invoke in order to remove a end-to-end encryption contact key.
*/
public static final String REMOVE_CONTACT_KEY_METHOD = "removeContactKey";
/**
* The method to invoke in order to add a new self key.
*/
public static final String UPDATE_OR_INSERT_SELF_KEY_METHOD = "updateOrInsertSelfKey";
/**
* The method to invoke in order to update a self key remote verification state.
*/
public static final String UPDATE_SELF_KEY_REMOTE_VERIFICATION_STATE_METHOD =
"updateSelfKeyRemoteVerificationState";
/**
* The method to invoke in order to retrieve a self key.
*/
public static final String GET_SELF_KEY_METHOD = "getSelfKey";
/**
* The method to invoke in order to retrieve all self keys.
*/
public static final String GET_ALL_SELF_KEYS_METHOD = "getAllSelfKeys";
/**
* The method to invoke in order to retrieve self keys that belong to the caller.
*/
public static final String GET_OWNER_SELF_KEYS_METHOD = "getOwnerSelfKeys";
/**
* The method to invoke in order to remove a new self key.
*/
public static final String REMOVE_SELF_KEY_METHOD = "removeSelfKey";
/**
* Key in the incoming Bundle for all the end-to-end encryption contact keys.
*/
public static final String KEY_CONTACT_KEYS = "key_contact_keys";
/**
* Key in the incoming Bundle for a single end-to-end encryption contact key.
*/
public static final String KEY_CONTACT_KEY = "key_contact_key";
/**
* Key in the incoming Bundle for a number of modified rows.
*/
public static final String KEY_UPDATED_ROWS = "key_updated_rows";
}
/**
* A parcelable class encapsulating other users' end to end encrypted contact key.
*/
public static final class E2eeContactKey extends E2eeBaseKey implements Parcelable {
/**
* Describes the local verification state for the key, for instance QR-code based
* verification.
*/
private final int mLocalVerificationState;
/**
* The display name for the contact.
*/
private final String mDisplayName;
/**
* The phone number as the user entered it.
*/
private final String mPhoneNumber;
/**
* The email address.
*/
private final String mEmailAddress;
/**
* @hide
*/
public E2eeContactKey(@Nullable String deviceId, @NonNull String accountId,
@NonNull String ownerPackageName, long timeUpdated, @Nullable byte[] keyValue,
@VerificationState int localVerificationState,
@VerificationState int remoteVerificationState,
@Nullable String displayName,
@Nullable String phoneNumber, @Nullable String emailAddress) {
super(deviceId, accountId, ownerPackageName, timeUpdated, keyValue,
remoteVerificationState);
this.mLocalVerificationState = localVerificationState;
this.mDisplayName = displayName;
this.mPhoneNumber = phoneNumber;
this.mEmailAddress = emailAddress;
}
/**
* Gets the local verification state for the key, for instance QR-code based verification.
*
* @return The local verification state for the key.
*/
public @VerificationState int getLocalVerificationState() {
return mLocalVerificationState;
}
/**
* Gets the display name for the contact.
*
* @return The display name for the contact.
*/
@Nullable
public String getDisplayName() {
return mDisplayName;
}
/**
* Gets the phone number as the user entered it.
*
* @return The phone number as the user entered it.
*/
@Nullable
public String getPhoneNumber() {
return mPhoneNumber;
}
/**
* Gets the email address.
*
* @return The email address.
*/
@Nullable
public String getEmailAddress() {
return mEmailAddress;
}
@Override
public int hashCode() {
return Objects.hash(mDeviceId, mAccountId, mOwnerPackageName, mTimeUpdated,
Arrays.hashCode(mKeyValue), mLocalVerificationState, mRemoteVerificationState,
mDisplayName, mPhoneNumber, mEmailAddress);
}
@Override
public boolean equals(Object obj) {
if (obj == null) return false;
if (obj == this) return true;
if (!(obj instanceof E2eeContactKey toCompare)) {
return false;
}
return Objects.equals(mDeviceId, toCompare.mDeviceId)
&& Objects.equals(mAccountId, toCompare.mAccountId)
&& Objects.equals(mOwnerPackageName, toCompare.mOwnerPackageName)
&& mTimeUpdated == toCompare.mTimeUpdated
&& Arrays.equals(mKeyValue, toCompare.mKeyValue)
&& mLocalVerificationState == toCompare.mLocalVerificationState
&& mRemoteVerificationState == toCompare.mRemoteVerificationState
&& Objects.equals(mDisplayName, toCompare.mDisplayName)
&& Objects.equals(mPhoneNumber, toCompare.mPhoneNumber)
&& Objects.equals(mEmailAddress, toCompare.mEmailAddress);
}
@Override
public void writeToParcel(@NonNull Parcel dest, int flags) {
dest.writeString8(mDeviceId);
dest.writeString8(mAccountId);
dest.writeString8(mOwnerPackageName);
dest.writeLong(mTimeUpdated);
dest.writeInt(mKeyValue != null ? mKeyValue.length : ARRAY_IS_NULL);
if (mKeyValue != null) {
dest.writeByteArray(mKeyValue);
}
dest.writeInt(mLocalVerificationState);
dest.writeInt(mRemoteVerificationState);
dest.writeString8(mDisplayName);
dest.writeString8(mPhoneNumber);
dest.writeString8(mEmailAddress);
}
@Override
public int describeContents() {
return 0;
}
@NonNull
public static final Creator CREATOR =
new Creator<>() {
@Override
public E2eeContactKey createFromParcel(Parcel source) {
String deviceId = source.readString8();
String accountId = source.readString8();
String ownerPackageName = source.readString8();
long timeUpdated = source.readLong();
int keyValueLength = source.readInt();
byte[] keyValue;
if (keyValueLength > 0) {
keyValue = new byte[keyValueLength];
source.readByteArray(keyValue);
} else {
keyValue = null;
}
int localVerificationState = source.readInt();
int remoteVerificationState = source.readInt();
String displayName = source.readString8();
String number = source.readString8();
String address = source.readString8();
return new E2eeContactKey(deviceId, accountId, ownerPackageName,
timeUpdated, keyValue, localVerificationState,
remoteVerificationState, displayName, number, address);
}
@Override
public E2eeContactKey[] newArray(int size) {
return new E2eeContactKey[size];
}
};
}
/**
* A parcelable class encapsulating self end to end encrypted contact key.
*/
public static final class E2eeSelfKey extends E2eeBaseKey implements Parcelable {
/**
* @hide
*/
public E2eeSelfKey(@Nullable String deviceId, @NonNull String accountId,
@NonNull String ownerPackageName, long timeUpdated, @Nullable byte[] keyValue,
@VerificationState int remoteVerificationState) {
super(deviceId, accountId, ownerPackageName, timeUpdated, keyValue,
remoteVerificationState);
}
@Override
public int hashCode() {
return Objects.hash(mDeviceId, mAccountId, mOwnerPackageName, mTimeUpdated,
Arrays.hashCode(mKeyValue), mRemoteVerificationState);
}
@Override
public boolean equals(Object obj) {
if (obj == null) return false;
if (obj == this) return true;
if (!(obj instanceof E2eeSelfKey toCompare)) {
return false;
}
return Objects.equals(mDeviceId, toCompare.mDeviceId)
&& Objects.equals(mAccountId, toCompare.mAccountId)
&& Objects.equals(mOwnerPackageName, toCompare.mOwnerPackageName)
&& mTimeUpdated == toCompare.mTimeUpdated
&& Arrays.equals(mKeyValue, toCompare.mKeyValue)
&& mRemoteVerificationState == toCompare.mRemoteVerificationState;
}
@Override
public void writeToParcel(@NonNull Parcel dest, int flags) {
dest.writeString8(mDeviceId);
dest.writeString8(mAccountId);
dest.writeString8(mOwnerPackageName);
dest.writeLong(mTimeUpdated);
dest.writeInt(mKeyValue != null ? mKeyValue.length : ARRAY_IS_NULL);
if (mKeyValue != null) {
dest.writeByteArray(mKeyValue);
}
dest.writeInt(mRemoteVerificationState);
}
@Override
public int describeContents() {
return 0;
}
@NonNull
public static final Creator CREATOR =
new Creator<>() {
@Override
public E2eeSelfKey createFromParcel(Parcel source) {
String deviceId = source.readString8();
String accountId = source.readString8();
String ownerPackageName = source.readString8();
long timeUpdated = source.readLong();
int keyValueLength = source.readInt();
byte[] keyValue;
if (keyValueLength > 0) {
keyValue = new byte[keyValueLength];
source.readByteArray(keyValue);
} else {
keyValue = null;
}
int remoteVerificationState = source.readInt();
return new E2eeSelfKey(deviceId, accountId, ownerPackageName,
timeUpdated, keyValue, remoteVerificationState);
}
@Override
public E2eeSelfKey[] newArray(int size) {
return new E2eeSelfKey[size];
}
};
}
/**
* An abstract class that's extended by self and contact key classes.
*
* @hide
*/
abstract static class E2eeBaseKey {
/**
* An app-specified identifier for the device for which the key can be used.
*/
protected final String mDeviceId;
/**
* An app-specified identifier for the account for which the key can be used.
* Usually a phone number.
*/
protected final String mAccountId;
/**
* Owner application package name.
*/
protected final String mOwnerPackageName;
/**
* Timestamp at which the key was updated.
*/
protected final long mTimeUpdated;
/**
* The raw bytes for the key.
*/
protected final byte[] mKeyValue;
/**
* Describes the remote verification state for the end-to-end encryption key, for instance
* through a key transparency server.
*/
protected final int mRemoteVerificationState;
protected E2eeBaseKey(@Nullable String deviceId, @NonNull String accountId,
@NonNull String ownerPackageName, long timeUpdated, @Nullable byte[] keyValue,
@VerificationState int remoteVerificationState) {
this.mDeviceId = deviceId;
this.mAccountId = accountId;
this.mOwnerPackageName = ownerPackageName;
this.mTimeUpdated = timeUpdated;
this.mKeyValue = keyValue == null ? null : Arrays.copyOf(keyValue, keyValue.length);
this.mRemoteVerificationState = remoteVerificationState;
}
/**
* Gets the app-specified identifier for the device for which the end-to-end encryption
* key can be used.
* Returns null if the app doesn't have the required visibility into
* the end-to-end encryption key.
*
* @return An app-specified identifier for the device.
*/
@Nullable
public String getDeviceId() {
return mDeviceId;
}
/**
* Gets the app-specified identifier for the account for which the end-to-end encryption
* key can be used.
* Usually a phone number.
*
* @return An app-specified identifier for the account.
*/
@NonNull
public String getAccountId() {
return mAccountId;
}
/**
* Gets the owner application package name.
*
* @return The owner application package name.
*/
@NonNull
public String getOwnerPackageName() {
return mOwnerPackageName;
}
/**
* Gets the timestamp at which the end-to-end encryption key was updated. Returns -1 if
* the app doesn't have the required visibility into the key.
*
* @return The timestamp at which the key was updated in the System.currentTimeMillis()
* base.
*/
public long getTimeUpdated() {
return mTimeUpdated;
}
/**
* Gets the raw bytes for the end-to-end encryption key.
* Returns null if the app doesn't have the required visibility into
* the end-to-end encryption key.
*
* @return A copy of the raw bytes for the end-to-end encryption key.
*/
@Nullable
public byte[] getKeyValue() {
return mKeyValue == null ? null : Arrays.copyOf(mKeyValue, mKeyValue.length);
}
/**
* Gets the remote verification state for the end-to-end encryption key, for instance
* through a key transparency server.
*
* @return The remote verification state for the end-to-end encryption key.
*/
public @VerificationState int getRemoteVerificationState() {
return mRemoteVerificationState;
}
}
}