blob: 20a77e9fc464b9b1aaec8fb19c3e1a69743316f6 [file] [log] [blame]
Shawn Willdend67afae2014-08-19 12:36:27 -06001/*
2 * Copyright 2014 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 SYSTEM_KEYMASTER_KEY_H_
18#define SYSTEM_KEYMASTER_KEY_H_
19
20#include "authorization_set.h"
21#include "keymaster_defs.h"
22
23namespace keymaster {
24
25class KeyBlob;
26class Operation;
27
28class Key {
29 public:
30 static Key* CreateKey(const KeyBlob& blob, keymaster_error_t* error);
31 static Key* GenerateKey(const AuthorizationSet& key_description, keymaster_error_t* error);
32
33 virtual ~Key() {}
34 virtual Operation* CreateOperation(keymaster_purpose_t purpose, keymaster_error_t* error) = 0;
35
36 /**
37 * Return a copy of raw key material, in the key's preferred binary format.
38 */
39 virtual keymaster_error_t key_material(UniquePtr<uint8_t[]>*, size_t* size) const = 0;
40
41 /**
42 * Return a copy of raw key material, in the specified format.
43 */
Shawn Willdenf268d742014-08-19 15:36:26 -060044 virtual keymaster_error_t formatted_key_material(keymaster_key_format_t format,
45 UniquePtr<uint8_t[]>* material,
Shawn Willdend67afae2014-08-19 12:36:27 -060046 size_t* size) const = 0;
47
48 const AuthorizationSet& authorizations() const { return authorizations_; }
49
50 protected:
51 Key(const KeyBlob& blob);
52 Key(const AuthorizationSet& authorizations) : authorizations_(authorizations) {}
53
54 private:
55 AuthorizationSet authorizations_;
56};
57
58} // namespace keymaster
59
60#endif // SYSTEM_KEYMASTER_KEY_H_