tests/tests/keystore/src/android/keystore/cts/KeyChainTest.java

/*
 * Copyright 2013 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.keystore.cts;

import android.content.pm.PackageManager;
import android.os.Handler;
import android.security.KeyChain;
import android.security.KeyChainException;
import android.test.AndroidTestCase;

import java.util.concurrent.CountDownLatch;

public class KeyChainTest extends AndroidTestCase {
    public void testIsKeyAlgorithmSupported_RequiredAlgorithmsSupported() throws Exception {
        assertFalse("DSA must not be supported", KeyChain.isKeyAlgorithmSupported("DSA"));
        assertTrue("EC must be supported", KeyChain.isKeyAlgorithmSupported("EC"));
        assertTrue("RSA must be supported", KeyChain.isKeyAlgorithmSupported("RSA"));
    }

    public void testNullPrivateKeyArgumentsFail()
            throws KeyChainException, InterruptedException {
        try {
            KeyChain.getPrivateKey(null, null);
            fail("NullPointerException was expected for null arguments to "
                    + "KeyChain.getPrivateKey(Context, String)");
        } catch (NullPointerException expected) {
        }
    }

    public void testNullPrivateKeyAliasArgumentFails()
            throws KeyChainException, InterruptedException {
        try {
            KeyChain.getPrivateKey(getContext(), null);
            fail("NullPointerException was expected with null String argument to "
                        + "KeyChain.getPrivateKey(Context, String).");
        } catch (NullPointerException expected) {
        }
    }

    public void testNullPrivateKeyContextArgumentFails()
            throws KeyChainException, InterruptedException {
        try {
            KeyChain.getPrivateKey(null, "");
            fail("NullPointerException was expected with null Context argument to "
                    + "KeyChain.getPrivateKey(Context, String).");
        } catch (NullPointerException expected) {
        }
    }

    public void testGetPrivateKeyOnMainThreadFails() throws InterruptedException {
        final CountDownLatch waiter = new CountDownLatch(1);
        new Handler(getContext().getMainLooper()).post(new Runnable() {
            @Override
            public void run() {
                try {
                    KeyChain.getPrivateKey(getContext(), "");
                    fail("IllegalStateException was expected for calling "
                            + "KeyChain.getPrivateKey(Context, String) on main thread");
                } catch (IllegalStateException expected) {
                } catch (Exception invalid) {
                    fail("Expected IllegalStateException, received " + invalid);
                } finally {
                    waiter.countDown();
                }
            }
        });
        waiter.await();
    }

    /**
     * Tests whether the required algorithms are backed by a Keymaster HAL that
     * binds the key material to the specific device it was created or imported
     * to. For more information on the Keymaster HAL, look at the header file at
     * hardware/libhardware/include/hardware/keymaster.h and the associated
     * tests in hardware/libhardware/tests/keymaster/
     */
    public void testIsBoundKeyAlgorithm_RequiredAlgorithmsSupported() throws Exception {
        if (isLeanbackOnly()) {
            KeyChain.isBoundKeyAlgorithm("RSA");
        }
        else {
            assertTrue("RSA must be hardware-backed by a hardware-specific Keymaster HAL",
                       KeyChain.isBoundKeyAlgorithm("RSA"));
        }

        // These are not required, but must not throw an exception
        KeyChain.isBoundKeyAlgorithm("DSA");
        KeyChain.isBoundKeyAlgorithm("EC");
    }

    private boolean isLeanbackOnly() {
        PackageManager pm = getContext().getPackageManager();
        return (pm != null && pm.hasSystemFeature("android.software.leanback_only"));
    }
}