Rename CryptoAlgorithmParameters to CryptoAlgorithmParametersDeprecated
[WebKit-https.git] / Source / WebCore / crypto / CryptoAlgorithm.h
1 /*
2  * Copyright (C) 2013 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef CryptoAlgorithm_h
27 #define CryptoAlgorithm_h
28
29 #include "CryptoAlgorithmIdentifier.h"
30 #include "CryptoKeyUsage.h"
31 #include <functional>
32 #include <wtf/Noncopyable.h>
33 #include <wtf/RefCounted.h>
34 #include <wtf/Vector.h>
35
36 #if ENABLE(SUBTLE_CRYPTO)
37
38 namespace WebCore {
39
40 typedef int ExceptionCode;
41
42 class CryptoAlgorithmParametersDeprecated;
43 class CryptoKey;
44 class CryptoKeyPair;
45 class CryptoKeyData;
46
47 // Data is mutable, so async operations should copy it first.
48 typedef std::pair<const uint8_t*, size_t> CryptoOperationData;
49
50 class CryptoAlgorithm : public RefCounted<CryptoAlgorithm> {
51     WTF_MAKE_NONCOPYABLE(CryptoAlgorithm)
52 public:
53     virtual ~CryptoAlgorithm();
54
55     virtual CryptoAlgorithmIdentifier identifier() const = 0;
56
57     typedef std::function<void(bool)> BoolCallback;
58     typedef std::function<void(CryptoKey&)> KeyCallback;
59     typedef std::function<void(CryptoKey*, CryptoKeyPair*)> KeyOrKeyPairCallback;
60     typedef std::function<void(const Vector<uint8_t>&)> VectorCallback;
61     typedef std::function<void()> VoidCallback;
62
63     virtual void encrypt(const CryptoAlgorithmParametersDeprecated&, const CryptoKey&, const CryptoOperationData&, VectorCallback&&, VoidCallback&& failureCallback, ExceptionCode&);
64     virtual void decrypt(const CryptoAlgorithmParametersDeprecated&, const CryptoKey&, const CryptoOperationData&, VectorCallback&&, VoidCallback&& failureCallback, ExceptionCode&);
65     virtual void sign(const CryptoAlgorithmParametersDeprecated&, const CryptoKey&, const CryptoOperationData&, VectorCallback&&, VoidCallback&& failureCallback, ExceptionCode&);
66     virtual void verify(const CryptoAlgorithmParametersDeprecated&, const CryptoKey&, const CryptoOperationData& signature, const CryptoOperationData&, BoolCallback&&, VoidCallback&& failureCallback, ExceptionCode&);
67     virtual void digest(const CryptoAlgorithmParametersDeprecated&, const CryptoOperationData&, VectorCallback&&, VoidCallback&& failureCallback, ExceptionCode&);
68     virtual void generateKey(const CryptoAlgorithmParametersDeprecated&, bool extractable, CryptoKeyUsage, KeyOrKeyPairCallback&&, VoidCallback&& failureCallback, ExceptionCode&);
69     virtual void deriveKey(const CryptoAlgorithmParametersDeprecated&, const CryptoKey& baseKey, CryptoAlgorithm* derivedKeyType, bool extractable, CryptoKeyUsage, KeyCallback&&, VoidCallback&& failureCallback, ExceptionCode&);
70     virtual void deriveBits(const CryptoAlgorithmParametersDeprecated&, const CryptoKey& baseKey, unsigned long length, VectorCallback&&, VoidCallback&& failureCallback, ExceptionCode&);
71     virtual void importKey(const CryptoAlgorithmParametersDeprecated&, const CryptoKeyData&, bool extractable, CryptoKeyUsage, KeyCallback&&, VoidCallback&& failureCallback, ExceptionCode&);
72
73     // These are only different from encrypt/decrypt because some algorithms may not expose encrypt/decrypt.
74     virtual void encryptForWrapKey(const CryptoAlgorithmParametersDeprecated&, const CryptoKey&, const CryptoOperationData&, VectorCallback&&, VoidCallback&& failureCallback, ExceptionCode&);
75     virtual void decryptForUnwrapKey(const CryptoAlgorithmParametersDeprecated&, const CryptoKey&, const CryptoOperationData&, VectorCallback&&, VoidCallback&& failureCallback, ExceptionCode&);
76
77 protected:
78     CryptoAlgorithm();
79 };
80
81 }
82
83 #endif // ENABLE(SUBTLE_CRYPTO)
84 #endif // CryptoAlgorithm_h