1 /*
2  * Copyright (C) 2017 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package android.security.keystore;
18 
19 /**
20  * @hide
21  *
22  * This is an interface to encapsulate the user authentication arguments that
23  * are passed to KeymasterUtils.addUserAuthArgs. Classes that represent
24  * authorization characteristics for new or imported keys can implement this
25  * interface to be passed to that method.
26  */
27 public interface UserAuthArgs {
28 
isUserAuthenticationRequired()29     boolean isUserAuthenticationRequired();
getUserAuthenticationValidityDurationSeconds()30     int getUserAuthenticationValidityDurationSeconds();
getUserAuthenticationType()31     @KeyProperties.AuthEnum int getUserAuthenticationType();
isUserAuthenticationValidWhileOnBody()32     boolean isUserAuthenticationValidWhileOnBody();
isInvalidatedByBiometricEnrollment()33     boolean isInvalidatedByBiometricEnrollment();
isUserConfirmationRequired()34     boolean isUserConfirmationRequired();
getBoundToSpecificSecureUserId()35     long getBoundToSpecificSecureUserId();
isUserPresenceRequired()36     boolean isUserPresenceRequired();
isUnlockedDeviceRequired()37     boolean isUnlockedDeviceRequired();
38 }
39