| /* |
| * Copyright (C) 2018 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package android.security.keystore.recovery; |
| |
| import android.annotation.NonNull; |
| import android.annotation.SystemApi; |
| import android.os.Parcel; |
| import android.os.Parcelable; |
| |
| import com.android.internal.util.Preconditions; |
| |
| /** |
| * Helper class with data necessary recover a single application key, given a recovery key. |
| * |
| * <ul> |
| * <li>Alias - Keystore alias of the key. |
| * <li>Encrypted key material. |
| * </ul> |
| * |
| * Note that Application info is not included. Recovery Agent can only make its own keys |
| * recoverable. |
| * |
| * @hide |
| */ |
| @SystemApi |
| public final class WrappedApplicationKey implements Parcelable { |
| private String mAlias; |
| // The only supported format is AES-256 symmetric key. |
| private byte[] mEncryptedKeyMaterial; |
| |
| // IMPORTANT! PLEASE READ! |
| // ----------------------- |
| // If you edit this file (e.g., to add new fields), please MAKE SURE to also do the following: |
| // - Update the #writeToParcel(Parcel) method below |
| // - Update the #(Parcel) constructor below |
| // - Update android.security.keystore.recovery.KeyChainSnapshotTest to make sure nobody |
| // accidentally breaks your fields in the Parcel in the future. |
| // - Update com.android.server.locksettings.recoverablekeystore.serialization |
| // .KeyChainSnapshotSerializer to correctly serialize your new field |
| // - Update com.android.server.locksettings.recoverablekeystore.serialization |
| // .KeyChainSnapshotSerializer to correctly deserialize your new field |
| // - Update com.android.server.locksettings.recoverablekeystore.serialization |
| // .KeychainSnapshotSerializerTest to make sure nobody breaks serialization of your field |
| // in the future. |
| |
| /** |
| * Builder for creating {@link WrappedApplicationKey}. |
| */ |
| public static class Builder { |
| private WrappedApplicationKey mInstance = new WrappedApplicationKey(); |
| |
| /** |
| * Sets Application-specific alias of the key. |
| * |
| * @param alias The alias. |
| * @return This builder. |
| */ |
| public Builder setAlias(@NonNull String alias) { |
| mInstance.mAlias = alias; |
| return this; |
| } |
| |
| /** |
| * @deprecated AOSP does not associate keys with accounts. This may be done by system app. |
| */ |
| @Deprecated |
| public Builder setAccount(@NonNull byte[] account) { |
| return this; |
| } |
| |
| /** |
| * Sets key material encrypted by recovery key. |
| * |
| * @param encryptedKeyMaterial The key material |
| * @return This builder |
| */ |
| |
| public Builder setEncryptedKeyMaterial(@NonNull byte[] encryptedKeyMaterial) { |
| mInstance.mEncryptedKeyMaterial = encryptedKeyMaterial; |
| return this; |
| } |
| |
| /** |
| * Creates a new {@link WrappedApplicationKey} instance. |
| * |
| * @return new instance |
| * @throws NullPointerException if some required fields were not set. |
| */ |
| @NonNull public WrappedApplicationKey build() { |
| Preconditions.checkNotNull(mInstance.mAlias); |
| Preconditions.checkNotNull(mInstance.mEncryptedKeyMaterial); |
| return mInstance; |
| } |
| } |
| |
| private WrappedApplicationKey() { } |
| |
| /** |
| * Deprecated - consider using Builder. |
| * @hide |
| */ |
| public WrappedApplicationKey(@NonNull String alias, @NonNull byte[] encryptedKeyMaterial) { |
| mAlias = Preconditions.checkNotNull(alias); |
| mEncryptedKeyMaterial = Preconditions.checkNotNull(encryptedKeyMaterial); |
| } |
| |
| /** |
| * Application-specific alias of the key. |
| * |
| * @see java.security.KeyStore.aliases |
| */ |
| public @NonNull String getAlias() { |
| return mAlias; |
| } |
| |
| /** Key material encrypted by recovery key. */ |
| public @NonNull byte[] getEncryptedKeyMaterial() { |
| return mEncryptedKeyMaterial; |
| } |
| |
| /** |
| * @deprecated AOSP does not associate keys with accounts. This may be done by system app. |
| */ |
| @Deprecated |
| public @NonNull byte[] getAccount() { |
| return new byte[0]; |
| } |
| |
| public static final Parcelable.Creator<WrappedApplicationKey> CREATOR = |
| new Parcelable.Creator<WrappedApplicationKey>() { |
| public WrappedApplicationKey createFromParcel(Parcel in) { |
| return new WrappedApplicationKey(in); |
| } |
| |
| public WrappedApplicationKey[] newArray(int length) { |
| return new WrappedApplicationKey[length]; |
| } |
| }; |
| |
| @Override |
| public void writeToParcel(Parcel out, int flags) { |
| out.writeString(mAlias); |
| out.writeByteArray(mEncryptedKeyMaterial); |
| } |
| |
| /** |
| * @hide |
| */ |
| protected WrappedApplicationKey(Parcel in) { |
| mAlias = in.readString(); |
| mEncryptedKeyMaterial = in.createByteArray(); |
| } |
| |
| @Override |
| public int describeContents() { |
| return 0; |
| } |
| } |