1 /*
2  * Copyright (C) 2009 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 #ifndef __KEYSTORE_H__
18 #define __KEYSTORE_H__
19 
20 #include <stdint.h>
21 
22 // note state values overlap with ResponseCode for the purposes of the state() API
23 enum State {
24     STATE_NO_ERROR      = 1,
25     STATE_LOCKED        = 2,
26     STATE_UNINITIALIZED = 3,
27 };
28 
29 enum ResponseCode {
30     NO_ERROR          =  STATE_NO_ERROR, // 1
31     LOCKED            =  STATE_LOCKED, // 2
32     UNINITIALIZED     =  STATE_UNINITIALIZED, // 3
33     SYSTEM_ERROR      =  4,
34     PROTOCOL_ERROR    =  5,
35     PERMISSION_DENIED =  6,
36     KEY_NOT_FOUND     =  7,
37     VALUE_CORRUPTED   =  8,
38     UNDEFINED_ACTION  =  9,
39     WRONG_PASSWORD_0  = 10,
40     WRONG_PASSWORD_1  = 11,
41     WRONG_PASSWORD_2  = 12,
42     WRONG_PASSWORD_3  = 13, // MAX_RETRY = 4
43     SIGNATURE_INVALID = 14,
44     OP_AUTH_NEEDED    = 15, // Auth is needed for this operation before it can be used.
45 };
46 
47 /*
48  * All the flags for import and insert calls.
49  */
50 enum {
51     KEYSTORE_FLAG_NONE = 0,
52     KEYSTORE_FLAG_ENCRYPTED = 1 << 0,
53     KEYSTORE_FLAG_FALLBACK = 1 << 1,
54 };
55 
56 /**
57  * Returns the size of the softkey magic header value for measuring
58  * and allocating purposes.
59  */
60 size_t get_softkey_header_size();
61 
62 /**
63  * Adds the magic softkey header to a key blob.
64  *
65  * Returns NULL if the destination array is too small. Otherwise it
66  * returns the offset directly after the magic value.
67  */
68 uint8_t* add_softkey_header(uint8_t* key_blob, size_t key_blob_length);
69 
70 /**
71  * Returns true if the key blob has a magic softkey header at the beginning.
72  */
73 bool is_softkey(const uint8_t* key_blob, const size_t key_blob_length);
74 
75 #endif
76