operation.h revision 111edb3bf8c51be9ffa3bb2454085f0b300c1e7a 
1/*
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_OPERATION_H_
18#define SYSTEM_KEYMASTER_OPERATION_H_
19
20#include <assert.h>
21#include <stdint.h>
22#include <stdlib.h>
23
24#include <keymaster/google_keymaster_utils.h>
25#include <hardware/keymaster_defs.h>
26#include <keymaster/logger.h>
27
28namespace keymaster {
29
30class AuthorizationSet;
31
32/**
33 * Abstract base for all cryptographic operations.
34 */
35class Operation {
36  public:
37    Operation(keymaster_purpose_t purpose, const Logger& logger)
38        : purpose_(purpose), logger_(logger) {}
39    virtual ~Operation() {}
40
41    keymaster_purpose_t purpose() const { return purpose_; }
42
43    const Logger& logger() { return logger_; }
44
45    virtual keymaster_error_t Begin(const AuthorizationSet& input_params,
46                                    AuthorizationSet* output_params) = 0;
47    virtual keymaster_error_t Update(const Buffer& input, Buffer* output,
48                                     size_t* input_consumed) = 0;
49    virtual keymaster_error_t Finish(const Buffer& signature, Buffer* output) = 0;
50    virtual keymaster_error_t Abort() = 0;
51
52  private:
53    const keymaster_purpose_t purpose_;
54    const Logger& logger_;
55};
56
57}  // namespace keymaster
58
59#endif  // SYSTEM_KEYMASTER_OPERATION_H_
60