summaryrefslogtreecommitdiff
path: root/src/include/ckm/ckm-manager-async.h
blob: 774bb32b76d0917e0bea329c337c06ba24d40e18 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
/*
 *  Copyright (c) 2000 - 2015 Samsung Electronics Co., Ltd All Rights Reserved
 *
 *  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
 *
 *
 * @file        ckm-manager-async.h
 * @author      Bartlomiej Grzelewski (b.grzelewski@samsung.com)
 * @version     1.0
 * @brief       Async key manager API.
 */
#pragma once

#include <memory>

#include <ckm/ckm-certificate.h>
#include <ckm/ckm-error.h>
#include <ckm/ckm-key.h>
#include <ckm/ckm-type.h>
#include <ckm/ckm-pkcs12.h>

// Central Key Manager namespace
namespace CKM {

// Asynchronous interface to Central Key Manager. This implementation uses
// internal thread for connection. Key Manager is not thread safe.
class KEY_MANAGER_API ManagerAsync
{
public:
    class Impl;

    ManagerAsync();

    ManagerAsync(const ManagerAsync&) = delete;
    ManagerAsync& operator=(const ManagerAsync&) = delete;

    // Observer will observer custom operation.
    struct Observer {
        virtual void ReceivedError(int error) = 0;

        virtual void ReceivedSaveKey() {}
        virtual void ReceivedSaveCertificate() {}
        virtual void ReceivedSaveData() {}
        virtual void ReceivedSavePKCS12() {}

        virtual void ReceivedRemovedAlias() {}

        virtual void ReceivedKey(Key &&) {}
        virtual void ReceivedCertificate(Certificate &&) {}
        virtual void ReceivedData(RawBuffer &&) {}
        virtual void ReceivedPKCS12(PKCS12ShPtr &&) {}

        virtual void ReceivedKeyAliasVector(AliasVector &&) {}
        virtual void ReceivedCertificateAliasVector(AliasVector &&) {}
        virtual void ReceivedDataAliasVector(AliasVector &&) {}

        virtual void ReceivedCreateKeyAES() {}
        virtual void ReceivedCreateKeyPair() {}

        virtual void ReceivedGetCertificateChain(CertificateShPtrVector &&) {}

        virtual void ReceivedCreateSignature(RawBuffer &&) {}
        virtual void ReceivedVerifySignature() {}

        virtual void ReceivedOCSPCheck(int) {}

        virtual void ReceivedSetPermission() {}

        virtual void ReceivedEncrypted(RawBuffer &&) {}
        virtual void ReceivedDecrypted(RawBuffer &&) {}

        virtual ~Observer() {}
    };

    typedef std::shared_ptr<Observer> ObserverPtr;

    virtual ~ManagerAsync();

    void saveKey(
            const ObserverPtr& observer,
            const Alias& alias,
            const KeyShPtr& key,
            const Policy& policy);
    void saveCertificate(
            const ObserverPtr& observer,
            const Alias& alias,
            const CertificateShPtr& cert,
            const Policy& policy);
    void saveData(
            const ObserverPtr& observer,
            const Alias& alias,
            const RawBuffer& data,
            const Policy& policy);
    void savePKCS12(
            const ObserverPtr& observer,
            const Alias &alias,
            const PKCS12ShPtr &pkcs,
            const Policy &keyPolicy,
            const Policy &certPolicy);

    void removeAlias(const ObserverPtr& observer, const Alias& alias);

    void getKey(const ObserverPtr& observer, const Alias& alias, const Password& password);
    void getCertificate(const ObserverPtr& observer, const Alias& alias, const Password& password);
    void getData(const ObserverPtr& observer, const Alias& alias, const Password& password);

    void getPKCS12(
        const ObserverPtr& observer,
        const Alias &alias,
        const Password& passwordKey = Password(),
        const Password& passwordCert = Password());

    // send request for list of all keys/certificates/data that application/user may use
    void getKeyAliasVector(const ObserverPtr& observer);
    void getCertificateAliasVector(const ObserverPtr& observer);
    void getDataAliasVector(const ObserverPtr& observer);

    void createKeyPairRSA(
            const ObserverPtr& observer,
            int size,
            const Alias& privateKeyAlias,
            const Alias& publicKeyAlias,
            const Policy& policyPrivateKey = Policy(),
            const Policy& policyPublicKey = Policy());
    void createKeyPairDSA(
            const ObserverPtr& observer,
            int size,
            const Alias& privateKeyAlias,
            const Alias& publicKeyAlias,
            const Policy& policyPrivateKey = Policy(),
            const Policy& policyPublicKey = Policy());
    void createKeyPairECDSA(
            const ObserverPtr& observer,
            const ElipticCurve type,
            const Alias& privateKeyAlias,
            const Alias& publicKeyAlias,
            const Policy& policyPrivateKey = Policy(),
            const Policy& policyPublicKey = Policy());
    void createKeyAES(
            const ObserverPtr& observer,
            int sizeBits,
            const Alias &keyAlias,
            const Policy &policyKey = Policy());

    void getCertificateChain(
            const ObserverPtr& observer,
            const CertificateShPtr& certificate,
            const CertificateShPtrVector& untrustedCertificates,
            const CertificateShPtrVector& trustedCertificates,
            bool useSystemTrustedCertificates);
    void getCertificateChain(
            const ObserverPtr& observer,
            const CertificateShPtr& certificate,
            const AliasVector& untrustedCertificates,
            const AliasVector& trustedCertificates,
            bool useSystemTrustedCertificates);

    void createSignature(
            const ObserverPtr& observer,
            const Alias& privateKeyAlias,
            const Password& password,           // password for private_key
            const RawBuffer& message,
            const HashAlgorithm hash,
            const RSAPaddingAlgorithm padding);
    void verifySignature(
            const ObserverPtr& observer,
            const Alias& publicKeyOrCertAlias,
            const Password& password,           // password for public_key (optional)
            const RawBuffer& message,
            const RawBuffer& signature,
            const HashAlgorithm hash,
            const RSAPaddingAlgorithm padding);

    // This function will check all certificates in chain except Root CA.
    // This function will delegate task to service. You may use this even
    // if application does not have permission to use network.
    void ocspCheck(
            const ObserverPtr& observer,
            const CertificateShPtrVector& certificateChainVector);

    void setPermission(
            const ObserverPtr& observer,
            const Alias& alias,
            const Label& accessor,
            PermissionMask permissionMask);

    void encrypt(
            const ObserverPtr& observer,
            const CryptoAlgorithm& algo,
            const Alias& keyAlias,
            const Password& password,
            const RawBuffer& plain);

    void decrypt(
            const ObserverPtr& observer,
            const CryptoAlgorithm& algo,
            const Alias& keyAlias,
            const Password& password,
            const RawBuffer& encrypted);

private:
    std::unique_ptr<Impl> m_impl;
};

} // namespace CKM