Add RecoverableKeyStoreLoader APIs. (8eaf607f) · Commits · e / os / android_frameworks_base

core/java/android/security/recoverablekeystore/KeyDerivationParameters.aidl

0 → 100644

+20 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2017 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.recoverablekeystore;

		/* @hide */
		parcelable KeyDerivationParameters;

core/java/android/security/recoverablekeystore/KeyDerivationParameters.java

0 → 100644

+112 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2017 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.recoverablekeystore;

		import android.annotation.IntDef;
		import android.annotation.NonNull;
		import android.os.Parcel;
		import android.os.Parcelable;

		import com.android.internal.util.Preconditions;

		import java.lang.annotation.Retention;
		import java.lang.annotation.RetentionPolicy;

		/**
		* Collection of parameters which define a key derivation function.
		* Supports
		*
		* <ul>
		* <li>SHA256
		* <li>Argon2id
		* </ul>
		* @hide
		*/
		public final class KeyDerivationParameters implements Parcelable {
		private final int mAlgorithm;
		private byte[] mSalt;

		/** @hide */
		@Retention(RetentionPolicy.SOURCE)
		@IntDef({ALGORITHM_SHA256, ALGORITHM_ARGON2ID})
		public @interface KeyDerivationAlgorithm {
		}

		/**
		* Salted SHA256
		*/
		public static final int ALGORITHM_SHA256 = 1;

		/**
		* Argon2ID
		*/
		// TODO: add Argon2ID support.
		public static final int ALGORITHM_ARGON2ID = 2;

		/**
		* Creates instance of the class to to derive key using salted SHA256 hash.
		*/
		public KeyDerivationParameters createSHA256Parameters(@NonNull byte[] salt) {
		return new KeyDerivationParameters(ALGORITHM_SHA256, salt);
		}

		private KeyDerivationParameters(@KeyDerivationAlgorithm int algorithm, @NonNull byte[] salt) {
		mAlgorithm = algorithm;
		mSalt = Preconditions.checkNotNull(salt);
		}

		/**
		* Gets algorithm.
		*/
		public @KeyDerivationAlgorithm int getAlgorithm() {
		return mAlgorithm;
		}

		/**
		* Gets salt.
		*/
		public @NonNull byte[] getSalt() {
		return mSalt;
		}

		public static final Parcelable.Creator<KeyDerivationParameters> CREATOR =
		new Parcelable.Creator<KeyDerivationParameters>() {
		public KeyDerivationParameters createFromParcel(Parcel in) {
		return new KeyDerivationParameters(in);
		}

		public KeyDerivationParameters[] newArray(int length) {
		return new KeyDerivationParameters[length];
		}
		};

		@Override
		public void writeToParcel(Parcel out, int flags) {
		out.writeInt(mAlgorithm);
		out.writeByteArray(mSalt);
		}

		protected KeyDerivationParameters(Parcel in) {
		mAlgorithm = in.readInt();
		mSalt = in.createByteArray();
		}

		@Override
		public int describeContents() {
		return 0;
		}
		}

core/java/android/security/recoverablekeystore/KeyEntryRecoveryData.aidl

0 → 100644

+20 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2017 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.recoverablekeystore;

		/* @hide */
		parcelable KeyEntryRecoveryData;

core/java/android/security/recoverablekeystore/KeyEntryRecoveryData.java

0 → 100644

+90 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2017 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.recoverablekeystore;

		import android.annotation.NonNull;
		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
		*/
		public final class KeyEntryRecoveryData implements Parcelable {
		private final byte[] mAlias;
		// The only supported format is AES-256 symmetric key.
		private final byte[] mEncryptedKeyMaterial;

		public KeyEntryRecoveryData(@NonNull byte[] 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 byte[] getAlias() {
		return mAlias;
		}

		/**
		* Encrypted key material encrypted by recovery key.
		*/
		public @NonNull byte[] getEncryptedKeyMaterial() {
		return mEncryptedKeyMaterial;
		}

		public static final Parcelable.Creator<KeyEntryRecoveryData> CREATOR =
		new Parcelable.Creator<KeyEntryRecoveryData>() {
		public KeyEntryRecoveryData createFromParcel(Parcel in) {
		return new KeyEntryRecoveryData(in);
		}

		public KeyEntryRecoveryData[] newArray(int length) {
		return new KeyEntryRecoveryData[length];
		}
		};

		@Override
		public void writeToParcel(Parcel out, int flags) {
		out.writeByteArray(mAlias);
		out.writeByteArray(mEncryptedKeyMaterial);
		}

		protected KeyEntryRecoveryData(Parcel in) {
		mAlias = in.createByteArray();
		mEncryptedKeyMaterial = in.createByteArray();
		}

		@Override
		public int describeContents() {
		return 0;
		}
		}

core/java/android/security/recoverablekeystore/KeyStoreRecoveryData.aidl

0 → 100644

+20 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2017 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.recoverablekeystore;

		/* @hide */
		parcelable KeyStoreRecoveryData;